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 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) {
155 ata_reset(op->driveid);
156 return DISK_RET_SUCCESS;
158 return isready(op->driveid);
163 /****************************************************************
165 ****************************************************************/
167 struct ata_pio_command {
182 // Send an ata command to the drive.
184 send_cmd(int driveid, struct ata_pio_command *cmd)
186 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
187 u8 channel = ataid / 2;
188 u8 slave = ataid % 2;
189 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
190 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
192 // Disable interrupts
193 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
196 int status = await_not_bsy(iobase1);
199 u8 newdh = ((cmd->device & ~ATA_CB_DH_DEV1)
200 | (slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0));
201 u8 olddh = inb(iobase1 + ATA_CB_DH);
202 outb(newdh, iobase1 + ATA_CB_DH);
203 if ((olddh ^ newdh) & (1<<4)) {
204 // Was a device change - wait for device to become not busy.
205 status = ndelay_await_not_bsy(iobase1);
210 if (cmd->command & 0x04) {
211 outb(0x00, iobase1 + ATA_CB_FR);
212 outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
213 outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
214 outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
215 outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
217 outb(cmd->feature, iobase1 + ATA_CB_FR);
218 outb(cmd->sector_count, iobase1 + ATA_CB_SC);
219 outb(cmd->lba_low, iobase1 + ATA_CB_SN);
220 outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
221 outb(cmd->lba_high, iobase1 + ATA_CB_CH);
222 outb(cmd->command, iobase1 + ATA_CB_CMD);
224 status = ndelay_await_not_bsy(iobase1);
228 if (status & ATA_CB_STAT_ERR) {
229 dprintf(6, "send_cmd : read error (status=%02x err=%02x)\n"
230 , status, inb(iobase1 + ATA_CB_ERR));
233 if (!(status & ATA_CB_STAT_DRQ)) {
234 dprintf(6, "send_cmd : DRQ not set (status %02x)\n", status);
242 /****************************************************************
244 ****************************************************************/
246 // Transfer 'op->count' blocks (of 'blocksize' bytes) to/from drive
249 ata_transfer(struct disk_op_s *op, int iswrite, int blocksize)
251 dprintf(16, "ata_transfer id=%d write=%d count=%d bs=%d buf=%p\n"
252 , op->driveid, iswrite, op->count, blocksize, op->buf_fl);
254 u8 ataid = GET_GLOBAL(Drives.drives[op->driveid].cntl_id);
255 u8 channel = ataid / 2;
256 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
257 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
258 int count = op->count;
259 void *buf_fl = op->buf_fl;
263 // Write data to controller
264 dprintf(16, "Write sector id=%d dest=%p\n", op->driveid, buf_fl);
265 if (CONFIG_ATA_PIO32)
266 outsl_fl(iobase1, buf_fl, blocksize / 4);
268 outsw_fl(iobase1, buf_fl, blocksize / 2);
270 // Read data from controller
271 dprintf(16, "Read sector id=%d dest=%p\n", op->driveid, buf_fl);
272 if (CONFIG_ATA_PIO32)
273 insl_fl(iobase1, buf_fl, blocksize / 4);
275 insw_fl(iobase1, buf_fl, blocksize / 2);
279 status = pause_await_not_bsy(iobase1, iobase2);
289 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
290 if (status != ATA_CB_STAT_DRQ) {
291 dprintf(6, "ata_transfer : more sectors left (status %02x)\n"
298 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_DF | ATA_CB_STAT_DRQ
301 status &= ~ATA_CB_STAT_DF;
303 dprintf(6, "ata_transfer : no sectors left (status %02x)\n", status);
308 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
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)
323 struct ata_pio_command cmd;
324 memset(&cmd, 0, sizeof(cmd));
326 cmd.command = command;
327 if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
328 cmd.sector_count2 = op->count >> 8;
329 cmd.lba_low2 = lba >> 24;
330 cmd.lba_mid2 = lba >> 32;
331 cmd.lba_high2 = lba >> 40;
338 cmd.sector_count = op->count;
340 cmd.lba_mid = lba >> 8;
341 cmd.lba_high = lba >> 16;
342 cmd.device = ((lba >> 24) & 0xf) | ATA_CB_DH_LBA;
344 int ret = send_cmd(op->driveid, &cmd);
347 return ata_transfer(op, iswrite, IDE_SECTOR_SIZE);
351 process_ata_op(struct disk_op_s *op)
357 switch (op->command) {
359 ret = ata_cmd_data(op, 0, ATA_CMD_READ_SECTORS);
362 ret = ata_cmd_data(op, 1, ATA_CMD_WRITE_SECTORS);
365 return process_ata_misc_op(op);
368 return DISK_RET_EBADTRACK;
369 return DISK_RET_SUCCESS;
373 /****************************************************************
375 ****************************************************************/
377 // Low-level atapi command transmit function.
379 send_atapi_cmd(int driveid, u8 *cmdbuf, u8 cmdlen, u16 blocksize)
381 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
382 u8 channel = ataid / 2;
383 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
384 u16 iobase2 = GET_GLOBAL(ATA_channels[channel].iobase2);
386 struct ata_pio_command cmd;
387 cmd.sector_count = 0;
390 cmd.lba_mid = blocksize;
391 cmd.lba_high = blocksize >> 8;
393 cmd.command = ATA_CMD_PACKET;
395 int ret = send_cmd(driveid, &cmd);
399 // Send command to device
400 outsw_fl(iobase1, MAKE_FLATPTR(GET_SEG(SS), cmdbuf), cmdlen / 2);
402 int status = pause_await_not_bsy(iobase1, iobase2);
406 if (status & ATA_CB_STAT_ERR) {
407 u8 err = inb(iobase1 + ATA_CB_ERR);
410 dprintf(6, "send_atapi_cmd : read error (status=%02x err=%02x)\n"
414 if (!(status & ATA_CB_STAT_DRQ)) {
415 dprintf(6, "send_atapi_cmd : DRQ not set (status %02x)\n", status);
422 // Read sectors from the cdrom.
424 cdrom_read(struct disk_op_s *op)
427 memset(atacmd, 0, sizeof(atacmd));
428 atacmd[0]=0x28; // READ command
429 atacmd[7]=(op->count & 0xff00) >> 8; // Sectors
430 atacmd[8]=(op->count & 0x00ff);
431 atacmd[2]=(op->lba & 0xff000000) >> 24; // LBA
432 atacmd[3]=(op->lba & 0x00ff0000) >> 16;
433 atacmd[4]=(op->lba & 0x0000ff00) >> 8;
434 atacmd[5]=(op->lba & 0x000000ff);
436 int ret = send_atapi_cmd(op->driveid, atacmd, sizeof(atacmd)
437 , CDROM_SECTOR_SIZE);
441 return ata_transfer(op, 0, CDROM_SECTOR_SIZE);
445 process_atapi_op(struct disk_op_s *op)
448 switch (op->command) {
450 ret = cdrom_read(op);
453 return process_ata_misc_op(op);
456 return DISK_RET_EBADTRACK;
457 return DISK_RET_SUCCESS;
460 // Send a simple atapi command to a drive.
462 ata_cmd_packet(int driveid, u8 *cmdbuf, u8 cmdlen
463 , u32 length, void *buf_fl)
465 int ret = send_atapi_cmd(driveid, cmdbuf, cmdlen, length);
469 struct disk_op_s dop;
470 memset(&dop, 0, sizeof(dop));
471 dop.driveid = driveid;
475 return ata_transfer(&dop, 0, length);
479 /****************************************************************
480 * ATA detect and init
481 ****************************************************************/
483 // Extract the ATA/ATAPI version info.
485 extract_version(u16 *buffer)
487 // Extract ATA/ATAPI version.
488 u16 ataversion = buffer[80];
490 for (version=15; version>0; version--)
491 if (ataversion & (1<<version))
496 // Extract common information from IDENTIFY commands.
498 extract_identify(int driveid, u16 *buffer)
500 dprintf(3, "Identify w0=%x w2=%x\n", buffer[0], buffer[2]);
503 char *model = Drives.drives[driveid].model;
504 int maxsize = ARRAY_SIZE(Drives.drives[driveid].model);
506 for (i=0; i<maxsize/2; i++) {
507 u16 v = buffer[27+i];
509 model[i*2+1] = v & 0xff;
511 model[maxsize-1] = 0x00;
513 // Trim trailing spaces from model name.
514 for (i=maxsize-2; i>0 && model[i] == 0x20; i--)
518 SET_GLOBAL(Drives.drives[driveid].removable, (buffer[0] & 0x80) ? 1 : 0);
522 init_drive_atapi(int driveid, u16 *buffer)
524 // Send an IDENTIFY_DEVICE_PACKET command to device
525 memset(buffer, 0, IDE_SECTOR_SIZE);
526 struct disk_op_s dop;
527 memset(&dop, 0, sizeof(dop));
528 dop.driveid = driveid;
531 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
532 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE_PACKET);
536 // Success - setup as ATAPI.
537 extract_identify(driveid, buffer);
538 SET_GLOBAL(Drives.drives[driveid].type, DTYPE_ATAPI);
539 SET_GLOBAL(Drives.drives[driveid].blksize, CDROM_SECTOR_SIZE);
540 SET_GLOBAL(Drives.drives[driveid].sectors, (u64)-1);
541 u8 iscd = ((buffer[0] >> 8) & 0x1f) == 0x05;
543 // Report drive info to user.
544 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
545 u8 channel = ataid / 2;
546 u8 slave = ataid % 2;
547 printf("ata%d-%d: %s ATAPI-%d %s\n", channel, slave
548 , Drives.drives[driveid].model, extract_version(buffer)
549 , (iscd ? "CD-Rom/DVD-Rom" : "Device"));
553 map_cd_drive(driveid);
559 init_drive_ata(int driveid, u16 *buffer)
561 // Send an IDENTIFY_DEVICE command to device
562 memset(buffer, 0, IDE_SECTOR_SIZE);
563 struct disk_op_s dop;
564 memset(&dop, 0, sizeof(dop));
565 dop.driveid = driveid;
568 dop.buf_fl = MAKE_FLATPTR(GET_SEG(SS), buffer);
569 int ret = ata_cmd_data(&dop, 0, ATA_CMD_IDENTIFY_DEVICE);
573 // Success - setup as ATA.
574 extract_identify(driveid, buffer);
575 SET_GLOBAL(Drives.drives[driveid].type, DTYPE_ATA);
576 SET_GLOBAL(Drives.drives[driveid].blksize, IDE_SECTOR_SIZE);
578 SET_GLOBAL(Drives.drives[driveid].pchs.cylinders, buffer[1]);
579 SET_GLOBAL(Drives.drives[driveid].pchs.heads, buffer[3]);
580 SET_GLOBAL(Drives.drives[driveid].pchs.spt, buffer[6]);
583 if (buffer[83] & (1 << 10)) // word 83 - lba48 support
584 sectors = *(u64*)&buffer[100]; // word 100-103
586 sectors = *(u32*)&buffer[60]; // word 60 and word 61
587 SET_GLOBAL(Drives.drives[driveid].sectors, sectors);
589 // Setup disk geometry translation.
590 setup_translation(driveid);
592 // Report drive info to user.
593 u8 ataid = GET_GLOBAL(Drives.drives[driveid].cntl_id);
594 u8 channel = ataid / 2;
595 u8 slave = ataid % 2;
596 char *model = Drives.drives[driveid].model;
597 printf("ata%d-%d: %s ATA-%d Hard-Disk ", channel, slave, model
598 , extract_version(buffer));
599 u64 sizeinmb = sectors >> 11;
600 if (sizeinmb < (1 << 16))
601 printf("(%u MiBytes)\n", (u32)sizeinmb);
603 printf("(%u GiBytes)\n", (u32)(sizeinmb >> 10));
605 // Register with bcv system.
606 add_bcv_hd(driveid, model);
612 powerup_await_non_bsy(u16 base, u64 end)
617 status = inb(base+ATA_CB_STAT);
618 if (!(status & ATA_CB_STAT_BSY))
621 if (orstatus == 0xff) {
622 dprintf(1, "powerup IDE floating\n");
625 if (rdtscll() > end) {
626 dprintf(1, "powerup IDE time out\n");
630 dprintf(6, "powerup iobase=%x st=%x\n", base, status);
638 u64 end = calc_future_tsc(IDE_TIMEOUT);
639 int ataid, last_reset_ataid=-1;
640 for (ataid=0; ataid<CONFIG_MAX_ATA_INTERFACES*2; ataid++) {
641 u8 channel = ataid / 2;
642 u8 slave = ataid % 2;
644 u16 iobase1 = GET_GLOBAL(ATA_channels[channel].iobase1);
649 int status = powerup_await_non_bsy(iobase1, end);
652 u8 newdh = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
653 outb(newdh, iobase1+ATA_CB_DH);
655 status = powerup_await_non_bsy(iobase1, end);
659 // Check if ioport registers look valid.
660 outb(newdh, iobase1+ATA_CB_DH);
661 u8 dh = inb(iobase1+ATA_CB_DH);
662 outb(0x55, iobase1+ATA_CB_SC);
663 outb(0xaa, iobase1+ATA_CB_SN);
664 u8 sc = inb(iobase1+ATA_CB_SC);
665 u8 sn = inb(iobase1+ATA_CB_SN);
666 dprintf(6, "ata_detect ataid=%d sc=%x sn=%x dh=%x\n"
667 , ataid, sc, sn, dh);
668 if (sc != 0x55 || sn != 0xaa || dh != newdh)
671 // Prepare new driveid.
672 u8 driveid = GET_GLOBAL(Drives.drivecount);
673 if (driveid >= ARRAY_SIZE(Drives.drives))
675 memset(&Drives.drives[driveid], 0, sizeof(Drives.drives[0]));
676 Drives.drives[driveid].cntl_id = ataid;
679 if (slave && ataid == last_reset_ataid + 1) {
680 // The drive was just reset - no need to reset it again.
683 last_reset_ataid = ataid;
688 int ret = init_drive_atapi(driveid, buffer);
690 // Found an ATAPI drive.
692 u8 st = inb(iobase1+ATA_CB_STAT);
694 // Status not set - can't be a valid drive.
698 ret = await_rdy(iobase1);
703 ret = init_drive_ata(driveid, buffer);
705 // No ATA drive found
708 SET_GLOBAL(Drives.drivecount, driveid+1);
710 u16 resetresult = buffer[93];
711 dprintf(6, "ata_detect resetresult=%04x\n", resetresult);
712 if (!slave && (resetresult & 0xdf61) == 0x4041)
713 // resetresult looks valid and device 0 is responding to
714 // device 1 requests - device 1 must not be present - skip
725 // Scan PCI bus for ATA adapters
728 foreachpci(bdf, max) {
729 if (pci_config_readw(bdf, PCI_CLASS_DEVICE) != PCI_CLASS_STORAGE_IDE)
731 if (count >= ARRAY_SIZE(ATA_channels))
734 u8 irq = pci_config_readb(bdf, PCI_INTERRUPT_LINE);
735 SET_GLOBAL(ATA_channels[count].irq, irq);
736 SET_GLOBAL(ATA_channels[count].pci_bdf, bdf);
738 u8 prog_if = pci_config_readb(bdf, PCI_CLASS_PROG);
742 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_0) & ~3;
743 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_1) & ~3;
748 SET_GLOBAL(ATA_channels[count].iobase1, port1);
749 SET_GLOBAL(ATA_channels[count].iobase2, port2);
750 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
751 , count, port1, port2, bdf, prog_if);
755 port1 = pci_config_readl(bdf, PCI_BASE_ADDRESS_2) & ~3;
756 port2 = pci_config_readl(bdf, PCI_BASE_ADDRESS_3) & ~3;
761 dprintf(1, "ATA controller %d at %x/%x (dev %x prog_if %x)\n"
762 , count, port1, port2, bdf, prog_if);
763 SET_GLOBAL(ATA_channels[count].iobase1, port1);
764 SET_GLOBAL(ATA_channels[count].iobase2, port2);
775 dprintf(3, "init hard drives\n");
779 SET_BDA(disk_control_byte, 0xc0);
781 enable_hwirq(14, entry_76);