1 // Low level ATA disk access
3 // Copyright (C) 2008,2009 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU LGPLv3 license.
8 #include "types.h" // u8
9 #include "ioport.h" // inb
10 #include "util.h" // dprintf
11 #include "cmos.h" // inb_cmos
12 #include "pic.h" // enable_hwirq
13 #include "biosvar.h" // GET_EBDA
14 #include "pci.h" // pci_find_class
15 #include "pci_ids.h" // PCI_CLASS_STORAGE_OTHER
16 #include "pci_regs.h" // PCI_INTERRUPT_LINE
17 #include "boot.h" // add_bcv_hd
18 #include "disk.h" // struct ata_s
19 #include "ata.h" // ATA_CB_STAT
21 #define IDE_SECTOR_SIZE 512
22 #define CDROM_SECTOR_SIZE 2048
24 #define IDE_TIMEOUT 32000 //32 seconds max for IDE ops
26 struct ata_channel_s ATA_channels[CONFIG_MAX_ATA_INTERFACES] VAR16_32;
29 /****************************************************************
31 ****************************************************************/
33 // Wait for the specified ide state
35 await_ide(u8 mask, u8 flags, u16 base, u16 timeout)
37 u64 end = calc_future_tsc(timeout);
39 u8 status = inb(base+ATA_CB_STAT);
40 if ((status & mask) == flags)
42 if (rdtscll() > end) {
43 dprintf(1, "IDE time out\n");
49 // Wait for the device to be not-busy.
51 await_not_bsy(u16 base)
53 return await_ide(ATA_CB_STAT_BSY, 0, base, IDE_TIMEOUT);
56 // Wait for the device to be ready.
60 return await_ide(ATA_CB_STAT_RDY, ATA_CB_STAT_RDY, base, IDE_TIMEOUT);
63 // Wait for ide state - pauses for one ata cycle first.
65 pause_await_not_bsy(u16 iobase1, u16 iobase2)
67 // Wait one PIO transfer cycle.
68 inb(iobase2 + ATA_CB_ASTAT);
70 return await_not_bsy(iobase1);
73 // Wait for ide state - pause for 400ns first.
75 ndelay_await_not_bsy(u16 iobase1)
78 return await_not_bsy(iobase1);
83 ata_reset(int driveid)
85 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
86 u8 channel = ataid / 2;
88 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
89 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
91 dprintf(6, "ata_reset driveid=%d\n", driveid);
93 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN | ATA_CB_DC_SRST, iobase2+ATA_CB_DC);
95 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
98 // wait for device to become not busy.
99 int status = await_not_bsy(iobase1);
104 u64 end = calc_future_tsc(IDE_TIMEOUT);
106 outb(ATA_CB_DH_DEV1, iobase1 + ATA_CB_DH);
107 status = ndelay_await_not_bsy(iobase1);
110 if (inb(iobase1 + ATA_CB_DH) == ATA_CB_DH_DEV1)
112 // Change drive request failed to take effect - retry.
113 if (rdtscll() > end) {
114 dprintf(1, "ata_reset slave time out\n");
120 // On a user-reset request, wait for RDY if it is an ATA device.
121 u8 type=GET_GLOBAL(Drives.drives[driveid].type);
122 if (type == DTYPE_ATA)
123 status = await_rdy(iobase1);
127 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
129 dprintf(6, "ata_reset exit status=%x\n", status);
135 // Read the status from controller
136 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
137 u8 channel = ataid / 2;
138 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
139 u8 status = inb(iobase1 + ATA_CB_STAT);
140 return (status & ( ATA_CB_STAT_BSY | ATA_CB_STAT_RDY )) == ATA_CB_STAT_RDY;
144 process_ata_misc_op(struct disk_op_s *op)
149 switch (op->command) {
153 ata_reset(op->driveid);
156 return isready(op->driveid);
161 /****************************************************************
163 ****************************************************************/
165 struct ata_pio_command {
180 // Send an ata command to the drive.
182 send_cmd(int driveid, struct ata_pio_command *cmd)
184 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
185 u8 channel = ataid / 2;
186 u8 slave = ataid % 2;
187 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
188 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
190 // Disable interrupts
191 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
194 int status = await_not_bsy(iobase1);
197 u8 newdh = ((cmd->device & ~ATA_CB_DH_DEV1)
198 | (slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0));
199 u8 olddh = inb(iobase1 + ATA_CB_DH);
200 outb(newdh, iobase1 + ATA_CB_DH);
201 if ((olddh ^ newdh) & (1<<4)) {
202 // Was a device change - wait for device to become not busy.
203 status = ndelay_await_not_bsy(iobase1);
208 if (cmd->command & 0x04) {
209 outb(0x00, iobase1 + ATA_CB_FR);
210 outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
211 outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
212 outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
213 outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
215 outb(cmd->feature, iobase1 + ATA_CB_FR);
216 outb(cmd->sector_count, iobase1 + ATA_CB_SC);
217 outb(cmd->lba_low, iobase1 + ATA_CB_SN);
218 outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
219 outb(cmd->lba_high, iobase1 + ATA_CB_CH);
220 outb(cmd->command, iobase1 + ATA_CB_CMD);
222 status = ndelay_await_not_bsy(iobase1);
226 if (status & ATA_CB_STAT_ERR) {
227 dprintf(6, "send_cmd : read error (status=%02x err=%02x)\n"
228 , status, inb(iobase1 + ATA_CB_ERR));
231 if (!(status & ATA_CB_STAT_DRQ)) {
232 dprintf(6, "send_cmd : DRQ not set (status %02x)\n", status);
240 /****************************************************************
242 ****************************************************************/
244 // Transfer 'op->count' blocks (of 'blocksize' bytes) to/from drive
247 ata_transfer(struct disk_op_s *op, int iswrite, int blocksize)
249 dprintf(16, "ata_transfer id=%d write=%d count=%d bs=%d buf=%p\n"
250 , op->driveid, iswrite, op->count, blocksize, op->buf_fl);
252 u8 ataid = GET_GLOBAL(Drives.drives[op->driveid].cntl_id);
253 u8 channel = ataid / 2;
254 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
255 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
256 int count = op->count;
257 void *buf_fl = op->buf_fl;
261 // Write data to controller
262 dprintf(16, "Write sector id=%d dest=%p\n", op->driveid, buf_fl);
263 if (CONFIG_ATA_PIO32)
264 outsl_fl(iobase1, buf_fl, blocksize / 4);
266 outsw_fl(iobase1, buf_fl, blocksize / 2);
268 // Read data from controller
269 dprintf(16, "Read sector id=%d dest=%p\n", op->driveid, buf_fl);
270 if (CONFIG_ATA_PIO32)
271 insl_fl(iobase1, buf_fl, blocksize / 4);
273 insw_fl(iobase1, buf_fl, blocksize / 2);
277 status = pause_await_not_bsy(iobase1, iobase2);
287 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
288 if (status != ATA_CB_STAT_DRQ) {
289 dprintf(6, "ata_transfer : more sectors left (status %02x)\n"
296 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DF | ATA_CB_STAT_DRQ
299 status &= ~ATA_CB_STAT_DF;
301 dprintf(6, "ata_transfer : no sectors left (status %02x)\n", status);
306 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
311 /****************************************************************
312 * ATA hard drive functions
313 ****************************************************************/
315 // Read/write count blocks from a harddrive.
317 ata_cmd_data(struct disk_op_s *op, int iswrite, int command)
321 struct ata_pio_command cmd;
322 memset(&cmd, 0, sizeof(cmd));
324 cmd.command = command;
325 if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
326 cmd.sector_count2 = op->count >> 8;
327 cmd.lba_low2 = lba >> 24;
328 cmd.lba_mid2 = lba >> 32;
329 cmd.lba_high2 = lba >> 40;
336 cmd.sector_count = op->count;
338 cmd.lba_mid = lba >> 8;
339 cmd.lba_high = lba >> 16;
340 cmd.device = ((lba >> 24) & 0xf) | ATA_CB_DH_LBA;
342 int ret = send_cmd(op->driveid, &cmd);
345 return ata_transfer(op, iswrite, IDE_SECTOR_SIZE);
349 process_ata_op(struct disk_op_s *op)
354 switch (op->command) {
356 return ata_cmd_data(op, 0, ATA_CMD_READ_SECTORS);
358 return ata_cmd_data(op, 1, ATA_CMD_WRITE_SECTORS);
360 return process_ata_misc_op(op);
365 /****************************************************************
367 ****************************************************************/
369 // Low-level atapi command transmit function.
371 send_atapi_cmd(int driveid, u8 *cmdbuf, u8 cmdlen, u16 blocksize)
373 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
374 u8 channel = ataid / 2;
375 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
376 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
378 struct ata_pio_command cmd;
379 cmd.sector_count = 0;
382 cmd.lba_mid = blocksize;
383 cmd.lba_high = blocksize >> 8;
385 cmd.command = ATA_CMD_PACKET;
387 int ret = send_cmd(driveid, &cmd);
391 // Send command to device
392 outsw_fl(iobase1, MAKE_FLATPTR(GET_SEG(SS), cmdbuf), cmdlen / 2);
394 int status = pause_await_not_bsy(iobase1, iobase2);
398 if (status & ATA_CB_STAT_ERR) {
399 u8 err = inb(iobase1 + ATA_CB_ERR);
402 dprintf(6, "send_atapi_cmd : read error (status=%02x err=%02x)\n"
406 if (!(status & ATA_CB_STAT_DRQ)) {
407 dprintf(6, "send_atapi_cmd : DRQ not set (status %02x)\n", status);
414 // Read sectors from the cdrom.
416 cdrom_read(struct disk_op_s *op)
419 memset(atacmd, 0, sizeof(atacmd));
420 atacmd[0]=0x28; // READ command
421 atacmd[7]=(op->count & 0xff00) >> 8; // Sectors
422 atacmd[8]=(op->count & 0x00ff);
423 atacmd[2]=(op->lba & 0xff000000) >> 24; // LBA
424 atacmd[3]=(op->lba & 0x00ff0000) >> 16;
425 atacmd[4]=(op->lba & 0x0000ff00) >> 8;
426 atacmd[5]=(op->lba & 0x000000ff);
428 int ret = send_atapi_cmd(op->driveid, atacmd, sizeof(atacmd)
429 , CDROM_SECTOR_SIZE);
433 return ata_transfer(op, 0, CDROM_SECTOR_SIZE);
437 process_atapi_op(struct disk_op_s *op)
439 switch (op->command) {
441 return cdrom_read(op);
443 return process_ata_misc_op(op);
447 // Send a simple atapi command to a drive.
449 ata_cmd_packet(int driveid, u8 *cmdbuf, u8 cmdlen
450 , u32 length, void *buf_fl)
452 int ret = send_atapi_cmd(driveid, cmdbuf, cmdlen, length);
456 struct disk_op_s dop;
457 memset(&dop, 0, sizeof(dop));
458 dop.driveid = driveid;
462 return ata_transfer(&dop, 0, length);
466 /****************************************************************
467 * ATA detect and init
468 ****************************************************************/
470 // Extract the ATA/ATAPI version info.
472 extract_version(u16 *buffer)
474 // Extract ATA/ATAPI version.
475 u16 ataversion = buffer[80];
477 for (version=15; version>0; version--)
478 if (ataversion & (1<<version))
483 // Extract common information from IDENTIFY commands.
485 extract_identify(int driveid, u16 *buffer)
487 dprintf(3, "Identify w0=%x w2=%x\n", buffer[0], buffer[2]);
490 char *model = Drives.drives[driveid].model;
491 int maxsize = ARRAY_SIZE(Drives.drives[driveid].model);
493 for (i=0; i<maxsize/2; i++) {
494 u16 v = buffer[27+i];
496 model[i*2+1] = v & 0xff;
498 model[maxsize-1] = 0x00;
500 // Trim trailing spaces from model name.
501 for (i=maxsize-2; i>0 && model[i] == 0x20; i--)
505 SET_GLOBAL(Drives.drives[driveid].removable, (buffer[0] & 0x80) ? 1 : 0);
509 init_drive_atapi(int driveid, u16 *buffer)
511 // Send an IDENTIFY_DEVICE_PACKET command to device
512 memset(buffer, 0, IDE_SECTOR_SIZE);
513 struct disk_op_s dop;
514 memset(&dop, 0, sizeof(dop));
515 dop.driveid = driveid;
518 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
519 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE_PACKET);
523 // Success - setup as ATAPI.
524 extract_identify(driveid, buffer);
525 SET_GLOBAL(Drives.drives[driveid].type, DTYPE_ATAPI);
526 SET_GLOBAL(Drives.drives[driveid].blksize, CDROM_SECTOR_SIZE);
527 SET_GLOBAL(Drives.drives[driveid].sectors, (u64)-1);
528 u8 iscd = ((buffer[0] >> 8) & 0x1f) == 0x05;
530 // Report drive info to user.
531 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
532 u8 channel = ataid / 2;
533 u8 slave = ataid % 2;
534 printf("ata%d-%d: %s ATAPI-%d %s\n", channel, slave
535 , Drives.drives[driveid].model, extract_version(buffer)
536 , (iscd ? "CD-Rom/DVD-Rom" : "Device"));
540 map_cd_drive(driveid);
546 init_drive_ata(int driveid, u16 *buffer)
548 // Send an IDENTIFY_DEVICE command to device
549 memset(buffer, 0, IDE_SECTOR_SIZE);
550 struct disk_op_s dop;
551 memset(&dop, 0, sizeof(dop));
552 dop.driveid = driveid;
555 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
556 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE);
560 // Success - setup as ATA.
561 extract_identify(driveid, buffer);
562 SET_GLOBAL(Drives.drives[driveid].type, DTYPE_ATA);
563 SET_GLOBAL(Drives.drives[driveid].blksize, IDE_SECTOR_SIZE);
565 SET_GLOBAL(Drives.drives[driveid].pchs.cylinders, buffer[1]);
566 SET_GLOBAL(Drives.drives[driveid].pchs.heads, buffer[3]);
567 SET_GLOBAL(Drives.drives[driveid].pchs.spt, buffer[6]);
570 if (buffer[83] & (1 << 10)) // word 83 - lba48 support
571 sectors = *(u64*)&buffer[100]; // word 100-103
573 sectors = *(u32*)&buffer[60]; // word 60 and word 61
574 SET_GLOBAL(Drives.drives[driveid].sectors, sectors);
576 // Setup disk geometry translation.
577 setup_translation(driveid);
579 // Report drive info to user.
580 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
581 u8 channel = ataid / 2;
582 u8 slave = ataid % 2;
583 char *model = Drives.drives[driveid].model;
584 printf("ata%d-%d: %s ATA-%d Hard-Disk ", channel, slave, model
585 , extract_version(buffer));
586 u64 sizeinmb = sectors >> 11;
587 if (sizeinmb < (1 << 16))
588 printf("(%u MiBytes)\n", (u32)sizeinmb);
590 printf("(%u GiBytes)\n", (u32)(sizeinmb >> 10));
592 // Register with bcv system.
593 add_bcv_hd(driveid, model);
599 powerup_await_non_bsy(u16 base, u64 end)
604 status = inb(base+ATA_CB_STAT);
605 if (!(status & ATA_CB_STAT_BSY))
608 if (orstatus == 0xff) {
609 dprintf(1, "powerup IDE floating\n");
612 if (rdtscll() > end) {
613 dprintf(1, "powerup IDE time out\n");
617 dprintf(6, "powerup iobase=%x st=%x\n", base, status);
625 u64 end = calc_future_tsc(IDE_TIMEOUT);
626 int ataid, last_reset_ataid=-1, driveid=0;
627 for (ataid=0; ataid<CONFIG_MAX_ATA_INTERFACES*2; ataid++) {
628 u8 channel = ataid / 2;
629 u8 slave = ataid % 2;
631 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
636 int status = powerup_await_non_bsy(iobase1, end);
639 u8 newdh = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
640 outb(newdh, iobase1+ATA_CB_DH);
642 status = powerup_await_non_bsy(iobase1, end);
646 // Check if ioport registers look valid.
647 outb(newdh, iobase1+ATA_CB_DH);
648 u8 dh = inb(iobase1+ATA_CB_DH);
649 outb(0x55, iobase1+ATA_CB_SC);
650 outb(0xaa, iobase1+ATA_CB_SN);
651 u8 sc = inb(iobase1+ATA_CB_SC);
652 u8 sn = inb(iobase1+ATA_CB_SN);
653 dprintf(6, "ata_detect ataid=%d sc=%x sn=%x dh=%x\n"
654 , ataid, sc, sn, dh);
655 if (sc != 0x55 || sn != 0xaa || dh != newdh)
658 // Prepare new driveid.
659 if (driveid >= ARRAY_SIZE(Drives.drives))
661 memset(&Drives.drives[driveid], 0, sizeof(Drives.drives[0]));
662 Drives.drives[driveid].cntl_id = ataid;
665 if (slave && ataid == last_reset_ataid + 1) {
666 // The drive was just reset - no need to reset it again.
669 last_reset_ataid = ataid;
674 int ret = init_drive_atapi(driveid, buffer);
676 // Found an ATAPI drive.
678 u8 st = inb(iobase1+ATA_CB_STAT);
680 // Status not set - can't be a valid drive.
684 ret = await_rdy(iobase1);
689 ret = init_drive_ata(driveid, buffer);
691 // No ATA drive found
696 u16 resetresult = buffer[93];
697 dprintf(6, "ata_detect resetresult=%04x\n", resetresult);
698 if (!slave && (resetresult & 0xdf61) == 0x4041)
699 // resetresult looks valid and device 0 is responding to
700 // device 1 requests - device 1 must not be present - skip
711 // Scan PCI bus for ATA adapters
714 foreachpci(bdf, max) {
715 if (pci_config_readw(bdf, PCI_CLASS_DEVICE) != PCI_CLASS_STORAGE_IDE)
717 if (count >= ARRAY_SIZE(ATA_channels))
720 u8 irq = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
721 SET_GLOBAL(ATA_channels[count].irq, irq);
722 SET_GLOBAL(ATA_channels[count].pci_bdf, bdf);
724 u8 prog_if = pci_config_readb(bdf, PCI_CLASS_PROG);
728 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_0) & ~3;
729 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_1) & ~3;
734 SET_GLOBAL(ATA_channels[count].iobase1, port1);
735 SET_GLOBAL(ATA_channels[count].iobase2, port2);
736 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
737 , count, port1, port2, bdf, prog_if);
741 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_2) & ~3;
742 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_3) & ~3;
747 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
748 , count, port1, port2, bdf, prog_if);
749 SET_GLOBAL(ATA_channels[count].iobase1, port1);
750 SET_GLOBAL(ATA_channels[count].iobase2, port2);
761 dprintf(3, "init hard drives\n");
765 SET_BDA(disk_control_byte, 0xc0);
767 enable_hwirq(14, entry_76);