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 (rdtscll() > end) {
40 dprintf(1, "IDE time out\n");
46 // Wait for the device to be not-busy.
48 await_not_bsy(u16 base)
50 return await_ide(ATA_CB_STAT_BSY, 0, base, IDE_TIMEOUT);
53 // Wait for the device to be ready.
57 return await_ide(ATA_CB_STAT_RDY, ATA_CB_STAT_RDY, base, IDE_TIMEOUT);
60 // Wait for ide state - pauses for one ata cycle first.
62 pause_await_not_bsy(u16 iobase1, u16 iobase2)
64 // Wait one PIO transfer cycle.
65 inb(iobase2 + ATA_CB_ASTAT);
67 return await_not_bsy(iobase1);
70 // Wait for ide state - pause for 400ns first.
72 ndelay_await_not_bsy(u16 iobase1)
75 return await_not_bsy(iobase1);
80 ata_reset(struct drive_s *drive_g)
82 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
83 u8 channel = ataid / 2;
85 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
86 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
88 dprintf(6, "ata_reset drive=%p\n", drive_g);
90 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN | ATA_CB_DC_SRST, iobase2+ATA_CB_DC);
92 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
95 // wait for device to become not busy.
96 int status = await_not_bsy(iobase1);
101 u64 end = calc_future_tsc(IDE_TIMEOUT);
103 outb(ATA_CB_DH_DEV1, iobase1 + ATA_CB_DH);
104 status = ndelay_await_not_bsy(iobase1);
107 if (inb(iobase1 + ATA_CB_DH) == ATA_CB_DH_DEV1)
109 // Change drive request failed to take effect - retry.
110 if (rdtscll() > end) {
111 dprintf(1, "ata_reset slave time out\n");
116 // QEMU doesn't reset dh on reset, so set it explicitly.
117 outb(ATA_CB_DH_DEV0, iobase1 + ATA_CB_DH);
120 // On a user-reset request, wait for RDY if it is an ATA device.
121 u8 type=GET_GLOBAL(drive_g->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);
133 isready(struct drive_s *drive_g)
135 // Read the status from controller
136 u8 ataid = GET_GLOBAL(drive_g->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 if ((status & (ATA_CB_STAT_BSY|ATA_CB_STAT_RDY)) == ATA_CB_STAT_RDY)
141 return DISK_RET_SUCCESS;
142 return DISK_RET_ENOTREADY;
146 process_ata_misc_op(struct disk_op_s *op)
151 switch (op->command) {
153 ata_reset(op->drive_g);
154 return DISK_RET_SUCCESS;
156 return isready(op->drive_g);
160 return DISK_RET_SUCCESS;
163 return DISK_RET_EPARAM;
168 /****************************************************************
170 ****************************************************************/
172 struct ata_pio_command {
187 // Send an ata command to the drive.
189 send_cmd(struct drive_s *drive_g, struct ata_pio_command *cmd)
191 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
192 u8 channel = ataid / 2;
193 u8 slave = ataid % 2;
194 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
195 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
197 // Disable interrupts
198 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
201 int status = await_not_bsy(iobase1);
204 u8 newdh = ((cmd->device & ~ATA_CB_DH_DEV1)
205 | (slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0));
206 u8 olddh = inb(iobase1 + ATA_CB_DH);
207 outb(newdh, iobase1 + ATA_CB_DH);
208 if ((olddh ^ newdh) & (1<<4)) {
209 // Was a device change - wait for device to become not busy.
210 status = ndelay_await_not_bsy(iobase1);
215 if (cmd->command & 0x04) {
216 outb(0x00, iobase1 + ATA_CB_FR);
217 outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
218 outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
219 outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
220 outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
222 outb(cmd->feature, iobase1 + ATA_CB_FR);
223 outb(cmd->sector_count, iobase1 + ATA_CB_SC);
224 outb(cmd->lba_low, iobase1 + ATA_CB_SN);
225 outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
226 outb(cmd->lba_high, iobase1 + ATA_CB_CH);
227 outb(cmd->command, iobase1 + ATA_CB_CMD);
229 status = ndelay_await_not_bsy(iobase1);
233 if (status & ATA_CB_STAT_ERR) {
234 dprintf(6, "send_cmd : read error (status=%02x err=%02x)\n"
235 , status, inb(iobase1 + ATA_CB_ERR));
238 if (!(status & ATA_CB_STAT_DRQ)) {
239 dprintf(6, "send_cmd : DRQ not set (status %02x)\n", status);
247 /****************************************************************
249 ****************************************************************/
251 // Transfer 'op->count' blocks (of 'blocksize' bytes) to/from drive
254 ata_transfer(struct disk_op_s *op, int iswrite, int blocksize)
256 dprintf(16, "ata_transfer id=%p write=%d count=%d bs=%d buf=%p\n"
257 , op->drive_g, iswrite, op->count, blocksize, op->buf_fl);
259 u8 ataid = GET_GLOBAL(op->drive_g->cntl_id);
260 u8 channel = ataid / 2;
261 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
262 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
263 int count = op->count;
264 void *buf_fl = op->buf_fl;
268 // Write data to controller
269 dprintf(16, "Write sector id=%p dest=%p\n", op->drive_g, buf_fl);
270 if (CONFIG_ATA_PIO32)
271 outsl_fl(iobase1, buf_fl, blocksize / 4);
273 outsw_fl(iobase1, buf_fl, blocksize / 2);
275 // Read data from controller
276 dprintf(16, "Read sector id=%p dest=%p\n", op->drive_g, buf_fl);
277 if (CONFIG_ATA_PIO32)
278 insl_fl(iobase1, buf_fl, blocksize / 4);
280 insw_fl(iobase1, buf_fl, blocksize / 2);
284 status = pause_await_not_bsy(iobase1, iobase2);
294 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
295 if (status != ATA_CB_STAT_DRQ) {
296 dprintf(6, "ata_transfer : more sectors left (status %02x)\n"
303 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DF | ATA_CB_STAT_DRQ
306 status &= ~ATA_CB_STAT_DF;
308 dprintf(6, "ata_transfer : no sectors left (status %02x)\n", status);
313 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
318 /****************************************************************
319 * ATA hard drive functions
320 ****************************************************************/
322 // Read/write count blocks from a harddrive.
324 ata_cmd_data(struct disk_op_s *op, int iswrite, int command)
328 struct ata_pio_command cmd;
329 memset(&cmd, 0, sizeof(cmd));
331 cmd.command = command;
332 if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
333 cmd.sector_count2 = op->count >> 8;
334 cmd.lba_low2 = lba >> 24;
335 cmd.lba_mid2 = lba >> 32;
336 cmd.lba_high2 = lba >> 40;
343 cmd.sector_count = op->count;
345 cmd.lba_mid = lba >> 8;
346 cmd.lba_high = lba >> 16;
347 cmd.device = ((lba >> 24) & 0xf) | ATA_CB_DH_LBA;
349 int ret = send_cmd(op->drive_g, &cmd);
352 return ata_transfer(op, iswrite, DISK_SECTOR_SIZE);
356 process_ata_op(struct disk_op_s *op)
362 switch (op->command) {
364 ret = ata_cmd_data(op, 0, ATA_CMD_READ_SECTORS);
367 ret = ata_cmd_data(op, 1, ATA_CMD_WRITE_SECTORS);
370 return process_ata_misc_op(op);
373 return DISK_RET_EBADTRACK;
374 return DISK_RET_SUCCESS;
378 /****************************************************************
380 ****************************************************************/
382 // Low-level atapi command transmit function.
384 send_atapi_cmd(struct drive_s *drive_g, u8 *cmdbuf, u8 cmdlen, u16 blocksize)
386 u8 ataid = GET_GLOBAL(drive_g->cntl_id);
387 u8 channel = ataid / 2;
388 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
389 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
391 struct ata_pio_command cmd;
392 cmd.sector_count = 0;
395 cmd.lba_mid = blocksize;
396 cmd.lba_high = blocksize >> 8;
398 cmd.command = ATA_CMD_PACKET;
400 int ret = send_cmd(drive_g, &cmd);
404 // Send command to device
405 outsw_fl(iobase1, MAKE_FLATPTR(GET_SEG(SS), cmdbuf), cmdlen / 2);
407 int status = pause_await_not_bsy(iobase1, iobase2);
411 if (status & ATA_CB_STAT_ERR) {
412 u8 err = inb(iobase1 + ATA_CB_ERR);
415 dprintf(6, "send_atapi_cmd : read error (status=%02x err=%02x)\n"
419 if (!(status & ATA_CB_STAT_DRQ)) {
420 dprintf(6, "send_atapi_cmd : DRQ not set (status %02x)\n", status);
427 // Read sectors from the cdrom.
429 cdrom_read(struct disk_op_s *op)
432 memset(atacmd, 0, sizeof(atacmd));
433 atacmd[0]=0x28; // READ command
434 atacmd[7]=(op->count & 0xff00) >> 8; // Sectors
435 atacmd[8]=(op->count & 0x00ff);
436 atacmd[2]=(op->lba & 0xff000000) >> 24; // LBA
437 atacmd[3]=(op->lba & 0x00ff0000) >> 16;
438 atacmd[4]=(op->lba & 0x0000ff00) >> 8;
439 atacmd[5]=(op->lba & 0x000000ff);
441 int ret = send_atapi_cmd(op->drive_g, atacmd, sizeof(atacmd)
442 , CDROM_SECTOR_SIZE);
446 return ata_transfer(op, 0, CDROM_SECTOR_SIZE);
450 process_atapi_op(struct disk_op_s *op)
453 switch (op->command) {
455 ret = cdrom_read(op);
459 return DISK_RET_EWRITEPROTECT;
461 return process_ata_misc_op(op);
464 return DISK_RET_EBADTRACK;
465 return DISK_RET_SUCCESS;
468 // Send a simple atapi command to a drive.
470 ata_cmd_packet(struct drive_s *drive_g, u8 *cmdbuf, u8 cmdlen
471 , u32 length, void *buf_fl)
473 int ret = send_atapi_cmd(drive_g, cmdbuf, cmdlen, length);
477 struct disk_op_s dop;
478 memset(&dop, 0, sizeof(dop));
479 dop.drive_g = drive_g;
483 return ata_transfer(&dop, 0, length);
487 /****************************************************************
488 * ATA detect and init
489 ****************************************************************/
491 // Extract the ATA/ATAPI version info.
493 extract_version(u16 *buffer)
495 // Extract ATA/ATAPI version.
496 u16 ataversion = buffer[80];
498 for (version=15; version>0; version--)
499 if (ataversion & (1<<version))
504 // Extract common information from IDENTIFY commands.
506 extract_identify(struct drive_s *drive_g, u16 *buffer)
508 dprintf(3, "Identify w0=%x w2=%x\n", buffer[0], buffer[2]);
511 char *model = drive_g->model;
512 int maxsize = ARRAY_SIZE(drive_g->model);
514 for (i=0; i<maxsize/2; i++) {
515 u16 v = buffer[27+i];
517 model[i*2+1] = v & 0xff;
519 model[maxsize-1] = 0x00;
521 // Trim trailing spaces from model name.
522 for (i=maxsize-2; i>0 && model[i] == 0x20; i--)
526 SET_GLOBAL(drive_g->removable, (buffer[0] & 0x80) ? 1 : 0);
527 SET_GLOBAL(drive_g->cntl_info, extract_version(buffer));
531 describe_atapi(struct drive_s *drive_g)
533 u8 ataid = drive_g->cntl_id;
534 u8 channel = ataid / 2;
535 u8 slave = ataid % 2;
536 u8 version = drive_g->cntl_info;
537 int iscd = drive_g->floppy_type;
538 printf("ata%d-%d: %s ATAPI-%d %s", channel, slave
539 , drive_g->model, version
540 , (iscd ? "CD-Rom/DVD-Rom" : "Device"));
543 static struct drive_s *
544 init_drive_atapi(struct drive_s *dummy, u16 *buffer)
546 // Send an IDENTIFY_DEVICE_PACKET command to device
547 memset(buffer, 0, DISK_SECTOR_SIZE);
548 struct disk_op_s dop;
549 memset(&dop, 0, sizeof(dop));
553 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
554 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE_PACKET);
558 // Success - setup as ATAPI.
559 struct drive_s *drive_g = allocDrive();
562 SET_GLOBAL(drive_g->cntl_id, dummy->cntl_id);
563 extract_identify(drive_g, buffer);
564 SET_GLOBAL(drive_g->type, DTYPE_ATAPI);
565 SET_GLOBAL(drive_g->blksize, CDROM_SECTOR_SIZE);
566 SET_GLOBAL(drive_g->sectors, (u64)-1);
567 u8 iscd = ((buffer[0] >> 8) & 0x1f) == 0x05;
568 SET_GLOBAL(drive_g->floppy_type, iscd);
572 map_cd_drive(drive_g);
578 describe_ata(struct drive_s *drive_g)
580 u8 ataid = drive_g->cntl_id;
581 u8 channel = ataid / 2;
582 u8 slave = ataid % 2;
583 u64 sectors = drive_g->sectors;
584 u8 version = drive_g->cntl_info;
585 char *model = drive_g->model;
586 printf("ata%d-%d: %s ATA-%d Hard-Disk", channel, slave, model, version);
587 u64 sizeinmb = sectors >> 11;
588 if (sizeinmb < (1 << 16))
589 printf(" (%u MiBytes)", (u32)sizeinmb);
591 printf(" (%u GiBytes)", (u32)(sizeinmb >> 10));
594 static struct drive_s *
595 init_drive_ata(struct drive_s *dummy, u16 *buffer)
597 // Send an IDENTIFY_DEVICE command to device
598 memset(buffer, 0, DISK_SECTOR_SIZE);
599 struct disk_op_s dop;
600 memset(&dop, 0, sizeof(dop));
604 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
605 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE);
609 // Success - setup as ATA.
610 struct drive_s *drive_g = allocDrive();
613 SET_GLOBAL(drive_g->cntl_id, dummy->cntl_id);
614 extract_identify(drive_g, buffer);
615 SET_GLOBAL(drive_g->type, DTYPE_ATA);
616 SET_GLOBAL(drive_g->blksize, DISK_SECTOR_SIZE);
618 SET_GLOBAL(drive_g->pchs.cylinders, buffer[1]);
619 SET_GLOBAL(drive_g->pchs.heads, buffer[3]);
620 SET_GLOBAL(drive_g->pchs.spt, buffer[6]);
623 if (buffer[83] & (1 << 10)) // word 83 - lba48 support
624 sectors = *(u64*)&buffer[100]; // word 100-103
626 sectors = *(u32*)&buffer[60]; // word 60 and word 61
627 SET_GLOBAL(drive_g->sectors, sectors);
629 // Setup disk geometry translation.
630 setup_translation(drive_g);
632 // Register with bcv system.
633 add_bcv_internal(drive_g);
639 powerup_await_non_bsy(u16 base, u64 end)
644 status = inb(base+ATA_CB_STAT);
645 if (!(status & ATA_CB_STAT_BSY))
648 if (orstatus == 0xff) {
649 dprintf(1, "powerup IDE floating\n");
652 if (rdtscll() > end) {
653 dprintf(1, "powerup IDE time out\n");
657 dprintf(6, "powerup iobase=%x st=%x\n", base, status);
664 struct drive_s dummy;
665 memset(&dummy, 0, sizeof(dummy));
667 u64 end = calc_future_tsc(IDE_TIMEOUT);
668 int ataid, last_reset_ataid=-1;
669 for (ataid=0; ataid<CONFIG_MAX_ATA_INTERFACES*2; ataid++) {
670 u8 channel = ataid / 2;
671 u8 slave = ataid % 2;
673 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
678 int status = powerup_await_non_bsy(iobase1, end);
681 u8 newdh = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
682 outb(newdh, iobase1+ATA_CB_DH);
684 status = powerup_await_non_bsy(iobase1, end);
688 // Check if ioport registers look valid.
689 outb(newdh, iobase1+ATA_CB_DH);
690 u8 dh = inb(iobase1+ATA_CB_DH);
691 outb(0x55, iobase1+ATA_CB_SC);
692 outb(0xaa, iobase1+ATA_CB_SN);
693 u8 sc = inb(iobase1+ATA_CB_SC);
694 u8 sn = inb(iobase1+ATA_CB_SN);
695 dprintf(6, "ata_detect ataid=%d sc=%x sn=%x dh=%x\n"
696 , ataid, sc, sn, dh);
697 if (sc != 0x55 || sn != 0xaa || dh != newdh)
700 // Prepare new drive.
701 dummy.cntl_id = ataid;
704 if (slave && ataid == last_reset_ataid + 1) {
705 // The drive was just reset - no need to reset it again.
708 last_reset_ataid = ataid;
713 struct drive_s *drive_g = init_drive_atapi(&dummy, buffer);
715 // Didn't find an ATAPI drive - look for ATA drive.
716 u8 st = inb(iobase1+ATA_CB_STAT);
718 // Status not set - can't be a valid drive.
722 int ret = await_rdy(iobase1);
727 drive_g = init_drive_ata(&dummy, buffer);
729 // No ATA drive found
733 // Report drive info to user.
734 describe_drive(drive_g);
737 u16 resetresult = buffer[93];
738 dprintf(6, "ata_detect resetresult=%04x\n", resetresult);
739 if (!slave && (resetresult & 0xdf61) == 0x4041)
740 // resetresult looks valid and device 0 is responding to
741 // device 1 requests - device 1 must not be present - skip
752 // Scan PCI bus for ATA adapters
755 foreachpci(bdf, max) {
756 if (pci_config_readw(bdf, PCI_CLASS_DEVICE) != PCI_CLASS_STORAGE_IDE)
758 if (count >= ARRAY_SIZE(ATA_channels))
761 u8 irq = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
762 SET_GLOBAL(ATA_channels[count].irq, irq);
763 SET_GLOBAL(ATA_channels[count].pci_bdf, bdf);
765 u8 prog_if = pci_config_readb(bdf, PCI_CLASS_PROG);
769 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_0) & ~3;
770 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_1) & ~3;
775 SET_GLOBAL(ATA_channels[count].iobase1, port1);
776 SET_GLOBAL(ATA_channels[count].iobase2, port2);
777 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
778 , count, port1, port2, bdf, prog_if);
782 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_2) & ~3;
783 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_3) & ~3;
788 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
789 , count, port1, port2, bdf, prog_if);
790 SET_GLOBAL(ATA_channels[count].iobase1, port1);
791 SET_GLOBAL(ATA_channels[count].iobase2, port2);
802 dprintf(3, "init hard drives\n");
806 SET_BDA(disk_control_byte, 0xc0);
808 enable_hwirq(14, entry_76);