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" // foreachpci
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_TIMEOUT 32000 //32 seconds max for IDE ops
23 struct ata_channel_s ATA_channels[CONFIG_MAX_ATA_INTERFACES] VAR16VISIBLE;
26 /****************************************************************
28 ****************************************************************/
30 // Wait for the specified ide state
32 await_ide(u8 mask, u8 flags, u16 base, u16 timeout)
34 u64 end = calc_future_tsc(timeout);
36 u8 status = inb(base+ATA_CB_STAT);
37 if ((status & mask) == flags)
39 if (check_time(end)) {
40 dprintf(1, "IDE time out\n");
47 // Wait for the device to be not-busy.
49 await_not_bsy(u16 base)
51 return await_ide(ATA_CB_STAT_BSY, 0, base, IDE_TIMEOUT);
54 // Wait for the device to be ready.
58 return await_ide(ATA_CB_STAT_RDY, ATA_CB_STAT_RDY, base, IDE_TIMEOUT);
61 // Wait for ide state - pauses for one ata cycle first.
63 pause_await_not_bsy(u16 iobase1, u16 iobase2)
65 // Wait one PIO transfer cycle.
66 inb(iobase2 + ATA_CB_ASTAT);
68 return await_not_bsy(iobase1);
71 // Wait for ide state - pause for 400ns first.
73 ndelay_await_not_bsy(u16 iobase1)
76 return await_not_bsy(iobase1);
81 ata_reset(struct drive_s *drive_g)
83 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
84 u8 channel = ataid / 2;
86 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
87 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
89 dprintf(6, "ata_reset drive=%p\n", drive_g);
91 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN | ATA_CB_DC_SRST, iobase2+ATA_CB_DC);
93 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
96 // wait for device to become not busy.
97 int status = await_not_bsy(iobase1);
102 u64 end = calc_future_tsc(IDE_TIMEOUT);
104 outb(ATA_CB_DH_DEV1, iobase1 + ATA_CB_DH);
105 status = ndelay_await_not_bsy(iobase1);
108 if (inb(iobase1 + ATA_CB_DH) == ATA_CB_DH_DEV1)
110 // Change drive request failed to take effect - retry.
111 if (check_time(end)) {
112 dprintf(1, "ata_reset slave time out\n");
117 // QEMU doesn't reset dh on reset, so set it explicitly.
118 outb(ATA_CB_DH_DEV0, iobase1 + ATA_CB_DH);
121 // On a user-reset request, wait for RDY if it is an ATA device.
122 u8 type=GET_GLOBAL(drive_g->type);
123 if (type == DTYPE_ATA)
124 status = await_rdy(iobase1);
128 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
130 dprintf(6, "ata_reset exit status=%x\n", status);
134 isready(struct drive_s *drive_g)
136 // Read the status from controller
137 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
138 u8 channel = ataid / 2;
139 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
140 u8 status = inb(iobase1 + ATA_CB_STAT);
141 if ((status & (ATA_CB_STAT_BSY|ATA_CB_STAT_RDY)) == ATA_CB_STAT_RDY)
142 return DISK_RET_SUCCESS;
143 return DISK_RET_ENOTREADY;
147 process_ata_misc_op(struct disk_op_s *op)
152 switch (op->command) {
154 ata_reset(op->drive_g);
155 return DISK_RET_SUCCESS;
157 return isready(op->drive_g);
161 return DISK_RET_SUCCESS;
164 return DISK_RET_EPARAM;
169 /****************************************************************
171 ****************************************************************/
173 struct ata_pio_command {
188 // Send an ata command to the drive.
190 send_cmd(struct drive_s *drive_g, struct ata_pio_command *cmd)
192 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
193 u8 channel = ataid / 2;
194 u8 slave = ataid % 2;
195 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
198 int status = await_not_bsy(iobase1);
201 u8 newdh = ((cmd->device & ~ATA_CB_DH_DEV1)
202 | (slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0));
203 u8 olddh = inb(iobase1 + ATA_CB_DH);
204 outb(newdh, iobase1 + ATA_CB_DH);
205 if ((olddh ^ newdh) & (1<<4)) {
206 // Was a device change - wait for device to become not busy.
207 status = ndelay_await_not_bsy(iobase1);
212 if (cmd->command & 0x04) {
213 outb(0x00, iobase1 + ATA_CB_FR);
214 outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
215 outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
216 outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
217 outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
219 outb(cmd->feature, iobase1 + ATA_CB_FR);
220 outb(cmd->sector_count, iobase1 + ATA_CB_SC);
221 outb(cmd->lba_low, iobase1 + ATA_CB_SN);
222 outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
223 outb(cmd->lba_high, iobase1 + ATA_CB_CH);
224 outb(cmd->command, iobase1 + ATA_CB_CMD);
226 status = ndelay_await_not_bsy(iobase1);
230 if (status & ATA_CB_STAT_ERR) {
231 dprintf(6, "send_cmd : read error (status=%02x err=%02x)\n"
232 , status, inb(iobase1 + ATA_CB_ERR));
235 if (!(status & ATA_CB_STAT_DRQ)) {
236 dprintf(6, "send_cmd : DRQ not set (status %02x)\n", status);
244 /****************************************************************
246 ****************************************************************/
248 // Transfer 'op->count' blocks (of 'blocksize' bytes) to/from drive
251 ata_transfer(struct disk_op_s *op, int iswrite, int blocksize)
253 dprintf(16, "ata_transfer id=%p write=%d count=%d bs=%d buf=%p\n"
254 , op->drive_g, iswrite, op->count, blocksize, op->buf_fl);
256 u8 ataid = GET_GLOBAL(op->drive_g->cntl_id);
257 u8 channel = ataid / 2;
258 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
259 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
260 int count = op->count;
261 void *buf_fl = op->buf_fl;
265 // Write data to controller
266 dprintf(16, "Write sector id=%p dest=%p\n", op->drive_g, buf_fl);
267 if (CONFIG_ATA_PIO32)
268 outsl_fl(iobase1, buf_fl, blocksize / 4);
270 outsw_fl(iobase1, buf_fl, blocksize / 2);
272 // Read data from controller
273 dprintf(16, "Read sector id=%p dest=%p\n", op->drive_g, buf_fl);
274 if (CONFIG_ATA_PIO32)
275 insl_fl(iobase1, buf_fl, blocksize / 4);
277 insw_fl(iobase1, buf_fl, blocksize / 2);
281 status = pause_await_not_bsy(iobase1, iobase2);
291 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
292 if (status != ATA_CB_STAT_DRQ) {
293 dprintf(6, "ata_transfer : more sectors left (status %02x)\n"
300 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DF | ATA_CB_STAT_DRQ
303 status &= ~ATA_CB_STAT_DF;
305 dprintf(6, "ata_transfer : no sectors left (status %02x)\n", status);
313 /****************************************************************
314 * ATA hard drive functions
315 ****************************************************************/
317 // Read/write count blocks from a harddrive.
319 ata_cmd_data(struct disk_op_s *op, int iswrite, int command)
321 u8 ataid = GET_GLOBAL(op->drive_g->cntl_id);
322 u8 channel = ataid / 2;
323 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
326 struct ata_pio_command cmd;
327 memset(&cmd, 0, sizeof(cmd));
329 cmd.command = command;
330 if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
331 cmd.sector_count2 = op->count >> 8;
332 cmd.lba_low2 = lba >> 24;
333 cmd.lba_mid2 = lba >> 32;
334 cmd.lba_high2 = lba >> 40;
341 cmd.sector_count = op->count;
343 cmd.lba_mid = lba >> 8;
344 cmd.lba_high = lba >> 16;
345 cmd.device = ((lba >> 24) & 0xf) | ATA_CB_DH_LBA;
347 // Disable interrupts
348 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
350 int ret = send_cmd(op->drive_g, &cmd);
353 ret = ata_transfer(op, iswrite, DISK_SECTOR_SIZE);
357 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
362 process_ata_op(struct disk_op_s *op)
368 switch (op->command) {
370 ret = ata_cmd_data(op, 0, ATA_CMD_READ_SECTORS);
373 ret = ata_cmd_data(op, 1, ATA_CMD_WRITE_SECTORS);
376 return process_ata_misc_op(op);
379 return DISK_RET_EBADTRACK;
380 return DISK_RET_SUCCESS;
384 /****************************************************************
386 ****************************************************************/
388 // Low-level atapi command transmit function.
390 atapi_cmd_data(struct disk_op_s *op, u8 *cmdbuf, u8 cmdlen, u16 blocksize)
392 u8 ataid = GET_GLOBAL(op->drive_g->cntl_id);
393 u8 channel = ataid / 2;
394 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
395 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
397 struct ata_pio_command cmd;
398 cmd.sector_count = 0;
401 cmd.lba_mid = blocksize;
402 cmd.lba_high = blocksize >> 8;
404 cmd.command = ATA_CMD_PACKET;
406 // Disable interrupts
407 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
409 int ret = send_cmd(op->drive_g, &cmd);
413 // Send command to device
414 outsw_fl(iobase1, MAKE_FLATPTR(GET_SEG(SS), cmdbuf), cmdlen / 2);
416 int status = pause_await_not_bsy(iobase1, iobase2);
422 if (status & ATA_CB_STAT_ERR) {
423 u8 err = inb(iobase1 + ATA_CB_ERR);
426 dprintf(6, "send_atapi_cmd : read error (status=%02x err=%02x)\n"
431 if (!(status & ATA_CB_STAT_DRQ)) {
432 dprintf(6, "send_atapi_cmd : DRQ not set (status %02x)\n", status);
437 ret = ata_transfer(op, 0, blocksize);
441 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
445 // Read sectors from the cdrom.
447 cdrom_read(struct disk_op_s *op)
450 memset(atacmd, 0, sizeof(atacmd));
451 atacmd[0]=0x28; // READ command
452 atacmd[7]=(op->count & 0xff00) >> 8; // Sectors
453 atacmd[8]=(op->count & 0x00ff);
454 atacmd[2]=(op->lba & 0xff000000) >> 24; // LBA
455 atacmd[3]=(op->lba & 0x00ff0000) >> 16;
456 atacmd[4]=(op->lba & 0x0000ff00) >> 8;
457 atacmd[5]=(op->lba & 0x000000ff);
459 return atapi_cmd_data(op, atacmd, sizeof(atacmd), CDROM_SECTOR_SIZE);
463 process_atapi_op(struct disk_op_s *op)
466 switch (op->command) {
468 ret = cdrom_read(op);
472 return DISK_RET_EWRITEPROTECT;
474 return process_ata_misc_op(op);
477 return DISK_RET_EBADTRACK;
478 return DISK_RET_SUCCESS;
481 // Send a simple atapi command to a drive.
483 ata_cmd_packet(struct drive_s *drive_g, u8 *cmdbuf, u8 cmdlen
484 , u32 length, void *buf_fl)
486 struct disk_op_s dop;
487 memset(&dop, 0, sizeof(dop));
488 dop.drive_g = drive_g;
492 return atapi_cmd_data(&dop, cmdbuf, cmdlen, length);
496 /****************************************************************
497 * ATA detect and init
498 ****************************************************************/
500 // Extract the ATA/ATAPI version info.
502 extract_version(u16 *buffer)
504 // Extract ATA/ATAPI version.
505 u16 ataversion = buffer[80];
507 for (version=15; version>0; version--)
508 if (ataversion & (1<<version))
513 // Extract common information from IDENTIFY commands.
515 extract_identify(struct drive_s *drive_g, u16 *buffer)
517 dprintf(3, "Identify w0=%x w2=%x\n", buffer[0], buffer[2]);
520 char *model = drive_g->model;
521 int maxsize = ARRAY_SIZE(drive_g->model);
523 for (i=0; i<maxsize/2; i++) {
524 u16 v = buffer[27+i];
526 model[i*2+1] = v & 0xff;
528 model[maxsize-1] = 0x00;
530 // Trim trailing spaces from model name.
531 for (i=maxsize-2; i>0 && model[i] == 0x20; i--)
535 SET_GLOBAL(drive_g->removable, (buffer[0] & 0x80) ? 1 : 0);
536 SET_GLOBAL(drive_g->cntl_info, extract_version(buffer));
540 describe_atapi(struct drive_s *drive_g)
542 u8 ataid = drive_g->cntl_id;
543 u8 channel = ataid / 2;
544 u8 slave = ataid % 2;
545 u8 version = drive_g->cntl_info;
546 int iscd = drive_g->floppy_type;
547 printf("ata%d-%d: %s ATAPI-%d %s", channel, slave
548 , drive_g->model, version
549 , (iscd ? "CD-Rom/DVD-Rom" : "Device"));
552 static struct drive_s *
553 init_drive_atapi(struct drive_s *dummy, u16 *buffer)
555 // Send an IDENTIFY_DEVICE_PACKET command to device
556 memset(buffer, 0, DISK_SECTOR_SIZE);
557 struct disk_op_s dop;
558 memset(&dop, 0, sizeof(dop));
562 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
563 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE_PACKET);
567 // Success - setup as ATAPI.
568 struct drive_s *drive_g = allocDrive();
571 SET_GLOBAL(drive_g->cntl_id, dummy->cntl_id);
572 extract_identify(drive_g, buffer);
573 SET_GLOBAL(drive_g->type, DTYPE_ATAPI);
574 SET_GLOBAL(drive_g->blksize, CDROM_SECTOR_SIZE);
575 SET_GLOBAL(drive_g->sectors, (u64)-1);
576 u8 iscd = ((buffer[0] >> 8) & 0x1f) == 0x05;
577 SET_GLOBAL(drive_g->floppy_type, iscd);
581 map_cd_drive(drive_g);
587 describe_ata(struct drive_s *drive_g)
589 u8 ataid = drive_g->cntl_id;
590 u8 channel = ataid / 2;
591 u8 slave = ataid % 2;
592 u64 sectors = drive_g->sectors;
593 u8 version = drive_g->cntl_info;
594 char *model = drive_g->model;
595 printf("ata%d-%d: %s ATA-%d Hard-Disk", channel, slave, model, version);
596 u64 sizeinmb = sectors >> 11;
597 if (sizeinmb < (1 << 16))
598 printf(" (%u MiBytes)", (u32)sizeinmb);
600 printf(" (%u GiBytes)", (u32)(sizeinmb >> 10));
603 static struct drive_s *
604 init_drive_ata(struct drive_s *dummy, u16 *buffer)
606 // Send an IDENTIFY_DEVICE command to device
607 memset(buffer, 0, DISK_SECTOR_SIZE);
608 struct disk_op_s dop;
609 memset(&dop, 0, sizeof(dop));
613 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
614 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE);
618 // Success - setup as ATA.
619 struct drive_s *drive_g = allocDrive();
622 SET_GLOBAL(drive_g->cntl_id, dummy->cntl_id);
623 extract_identify(drive_g, buffer);
624 SET_GLOBAL(drive_g->type, DTYPE_ATA);
625 SET_GLOBAL(drive_g->blksize, DISK_SECTOR_SIZE);
627 SET_GLOBAL(drive_g->pchs.cylinders, buffer[1]);
628 SET_GLOBAL(drive_g->pchs.heads, buffer[3]);
629 SET_GLOBAL(drive_g->pchs.spt, buffer[6]);
632 if (buffer[83] & (1 << 10)) // word 83 - lba48 support
633 sectors = *(u64*)&buffer[100]; // word 100-103
635 sectors = *(u32*)&buffer[60]; // word 60 and word 61
636 SET_GLOBAL(drive_g->sectors, sectors);
638 // Setup disk geometry translation.
639 setup_translation(drive_g);
641 // Register with bcv system.
642 add_bcv_internal(drive_g);
647 static u64 SpinupEnd;
650 powerup_await_non_bsy(u16 base)
655 status = inb(base+ATA_CB_STAT);
656 if (!(status & ATA_CB_STAT_BSY))
659 if (orstatus == 0xff) {
660 dprintf(1, "powerup IDE floating\n");
663 if (check_time(SpinupEnd)) {
664 dprintf(1, "powerup IDE time out\n");
669 dprintf(6, "powerup iobase=%x st=%x\n", base, status);
674 ata_detect(void *data)
676 struct ata_channel_s *atachannel = data;
677 int startid = (atachannel - ATA_channels) * 2;
678 struct drive_s dummy;
679 memset(&dummy, 0, sizeof(dummy));
681 int ataid, last_reset_ataid=-1;
682 for (ataid=startid; ataid<startid+2; ataid++) {
683 u8 channel = ataid / 2;
684 u8 slave = ataid % 2;
686 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
691 int status = powerup_await_non_bsy(iobase1);
694 u8 newdh = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
695 outb(newdh, iobase1+ATA_CB_DH);
697 status = powerup_await_non_bsy(iobase1);
701 // Check if ioport registers look valid.
702 outb(newdh, iobase1+ATA_CB_DH);
703 u8 dh = inb(iobase1+ATA_CB_DH);
704 outb(0x55, iobase1+ATA_CB_SC);
705 outb(0xaa, iobase1+ATA_CB_SN);
706 u8 sc = inb(iobase1+ATA_CB_SC);
707 u8 sn = inb(iobase1+ATA_CB_SN);
708 dprintf(6, "ata_detect ataid=%d sc=%x sn=%x dh=%x\n"
709 , ataid, sc, sn, dh);
710 if (sc != 0x55 || sn != 0xaa || dh != newdh)
713 // Prepare new drive.
714 dummy.cntl_id = ataid;
717 if (slave && ataid == last_reset_ataid + 1) {
718 // The drive was just reset - no need to reset it again.
721 last_reset_ataid = ataid;
726 struct drive_s *drive_g = init_drive_atapi(&dummy, buffer);
728 // Didn't find an ATAPI drive - look for ATA drive.
729 u8 st = inb(iobase1+ATA_CB_STAT);
731 // Status not set - can't be a valid drive.
735 int ret = await_rdy(iobase1);
740 drive_g = init_drive_ata(&dummy, buffer);
742 // No ATA drive found
746 u16 resetresult = buffer[93];
747 dprintf(6, "ata_detect resetresult=%04x\n", resetresult);
748 if (!slave && (resetresult & 0xdf61) == 0x4041)
749 // resetresult looks valid and device 0 is responding to
750 // device 1 requests - device 1 must not be present - skip
757 init_controller(struct ata_channel_s *atachannel
758 , int bdf, int irq, u32 port1, u32 port2)
760 SET_GLOBAL(atachannel->irq, irq);
761 SET_GLOBAL(atachannel->pci_bdf, bdf);
762 SET_GLOBAL(atachannel->iobase1, port1);
763 SET_GLOBAL(atachannel->iobase2, port2);
764 dprintf(1, "ATA controller %d at %x/%x (irq %d dev %x)\n"
765 , atachannel - ATA_channels, port1, port2, irq, bdf);
766 run_thread(ata_detect, atachannel);
772 // Scan PCI bus for ATA adapters
773 int count=0, pcicount=0;
775 foreachpci(bdf, max) {
777 if (pci_config_readw(bdf, PCI_CLASS_DEVICE) != PCI_CLASS_STORAGE_IDE)
779 if (count >= ARRAY_SIZE(ATA_channels))
782 u8 irq = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
783 u8 prog_if = pci_config_readb(bdf, PCI_CLASS_PROG);
786 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_0) & ~3;
787 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_1) & ~3;
789 port1 = PORT_ATA1_CMD_BASE;
790 port2 = PORT_ATA1_CTRL_BASE;
792 init_controller(&ATA_channels[count], bdf, irq, port1, port2);
796 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_2) & ~3;
797 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_3) & ~3;
799 port1 = PORT_ATA2_CMD_BASE;
800 port2 = PORT_ATA2_CTRL_BASE;
802 init_controller(&ATA_channels[count], bdf, irq, port1, port2);
806 if (!CONFIG_COREBOOT && !pcicount && ARRAY_SIZE(ATA_channels) >= 2) {
807 // No PCI devices found - probably a QEMU "-M isapc" machine.
808 // Try using ISA ports for ATA controllers.
809 init_controller(&ATA_channels[0]
810 , -1, 14, PORT_ATA1_CMD_BASE, PORT_ATA1_CTRL_BASE);
811 init_controller(&ATA_channels[1]
812 , -1, 15, PORT_ATA2_CMD_BASE, PORT_ATA2_CTRL_BASE);
822 dprintf(3, "init hard drives\n");
824 SpinupEnd = calc_future_tsc(IDE_TIMEOUT);
827 SET_BDA(disk_control_byte, 0xc0);
829 enable_hwirq(14, entry_76);