1 // Low level ATA disk access
3 // Copyright (C) 2008 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 GPLv3 license.
8 #include "ata.h" // ATA_*
9 #include "types.h" // u8
10 #include "ioport.h" // inb
11 #include "util.h" // BX_INFO
12 #include "cmos.h" // inb_cmos
18 #define NOT_BSY_NOT_DRQ 4
21 #define IDE_TIMEOUT 32000u //32 seconds max for IDE ops
23 #define DEBUGF1(fmt, args...) bprintf(0, fmt , ##args)
24 #define DEBUGF(fmt, args...)
26 // XXX - lots of redundancy in this file.
29 await_ide(u8 when_done, u16 base, u16 timeout)
32 // for the times you're supposed to throw one away
33 u16 status = inb(base + ATA_CB_STAT);
35 status = inb(base+ATA_CB_STAT);
39 result = status & ATA_CB_STAT_BSY;
40 else if (when_done == NOT_BSY)
41 result = !(status & ATA_CB_STAT_BSY);
42 else if (when_done == NOT_BSY_DRQ)
43 result = !(status & ATA_CB_STAT_BSY) && (status & ATA_CB_STAT_DRQ);
44 else if (when_done == NOT_BSY_NOT_DRQ)
45 result = !(status & ATA_CB_STAT_BSY) && !(status & ATA_CB_STAT_DRQ);
46 else if (when_done == NOT_BSY_RDY)
47 result = !(status & ATA_CB_STAT_BSY) && (status & ATA_CB_STAT_RDY);
48 else if (when_done == TIMEOUT)
53 // mod 2048 each 16 ms
54 if (time>>16 != last) {
56 DEBUGF("await_ide: (TIMEOUT,BSY,!BSY,!BSY_DRQ,!BSY_!DRQ,!BSY_RDY)"
57 " %d time= %d timeout= %d\n"
58 , when_done, time>>11, timeout);
60 if (status & ATA_CB_STAT_ERR) {
61 DEBUGF("await_ide: ERROR (TIMEOUT,BSY,!BSY,!BSY_DRQ"
62 ",!BSY_!DRQ,!BSY_RDY) %d time= %d timeout= %d\n"
63 , when_done, time>>11, timeout);
66 if ((timeout == 0) || ((time>>11) > timeout))
69 BX_INFO("IDE time out\n");
74 // ---------------------------------------------------------------------------
75 // ATA/ATAPI driver : software reset
76 // ---------------------------------------------------------------------------
78 // 8.2.1 Software reset - Device 0
84 u8 channel, slave, sn, sc;
90 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
91 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
95 // 8.2.1 (a) -- set SRST in DC
96 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN | ATA_CB_DC_SRST, iobase2+ATA_CB_DC);
98 // 8.2.1 (b) -- wait for BSY
99 await_ide(BSY, iobase1, 20);
101 // 8.2.1 (f) -- clear SRST
102 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
104 type=GET_EBDA(ata.devices[device].type);
105 if (type != ATA_TYPE_NONE) {
107 // 8.2.1 (g) -- check for sc==sn==0x01
109 outb(slave?ATA_CB_DH_DEV1:ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
110 sc = inb(iobase1+ATA_CB_SC);
111 sn = inb(iobase1+ATA_CB_SN);
113 if ( (sc==0x01) && (sn==0x01) ) {
114 if (type == ATA_TYPE_ATA) //ATA
115 await_ide(NOT_BSY_RDY, iobase1, IDE_TIMEOUT);
117 await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
120 // 8.2.1 (h) -- wait for not BSY
121 await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
125 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
129 // ---------------------------------------------------------------------------
130 // ATA/ATAPI driver : execute a data command
131 // ---------------------------------------------------------------------------
136 // 3 : expected DRQ=1
137 // 4 : no sectors left to read/verify
138 // 5 : more sectors to read/verify
139 // 6 : no sectors left to write
140 // 7 : more sectors to write
143 send_cmd(struct ata_pio_command *cmd)
145 u16 biosid = cmd->biosid;
146 u8 channel = biosid / 2;
147 u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
148 u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
150 u8 status = inb(iobase1 + ATA_CB_STAT);
151 if (status & ATA_CB_STAT_BSY)
154 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
155 if (cmd->command & 0x04) {
156 outb(0x00, iobase1 + ATA_CB_FR);
157 outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
158 outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
159 outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
160 outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
162 outb(cmd->feature, iobase1 + ATA_CB_FR);
163 outb(cmd->sector_count, iobase1 + ATA_CB_SC);
164 outb(cmd->lba_low, iobase1 + ATA_CB_SN);
165 outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
166 outb(cmd->lba_high, iobase1 + ATA_CB_CH);
167 outb(cmd->device, iobase1 + ATA_CB_DH);
168 outb(cmd->command, iobase1 + ATA_CB_CMD);
170 await_ide(NOT_BSY_DRQ, iobase1, IDE_TIMEOUT);
172 status = inb(iobase1 + ATA_CB_STAT);
173 if (status & ATA_CB_STAT_ERR) {
174 DEBUGF("send_cmd : read error\n");
177 if (!(status & ATA_CB_STAT_DRQ)) {
178 DEBUGF("send_cmd : DRQ not set (status %02x)\n"
179 , (unsigned) status);
187 ata_transfer(struct ata_pio_command *cmd)
189 DEBUGF("ata_transfer id=%d cmd=%d lba=%d count=%d seg=%x off=%x\n"
190 , cmd->biosid, cmd->command
191 , (cmd->lba_high << 16) | (cmd->lba_mid << 8) | cmd->lba_low
192 , cmd->sector_count, cmd->segment, cmd->offset);
194 // Reset count of transferred data
195 SET_EBDA(ata.trsfsectors,0);
196 SET_EBDA(ata.trsfbytes,0L);
198 int ret = send_cmd(cmd);
202 u16 biosid = cmd->biosid;
203 u8 channel = biosid / 2;
204 u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
205 u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
206 u8 mode = GET_EBDA(ata.devices[biosid].mode);
207 int iswrite = (cmd->command & ~0x40) == ATA_CMD_WRITE_SECTORS;
211 u16 segment = cmd->segment;
212 u16 offset = cmd->offset;
214 u16 count = cmd->sector_count;
217 if (offset >= 0xf800) {
223 // Write data to controller
224 DEBUGF("Write sector id=%d dest=%x:%x\n", biosid, segment, offset);
225 if (mode == ATA_MODE_PIO32)
226 outsl_seg(iobase1, segment, offset, 512 / 4);
228 outsw_seg(iobase1, segment, offset, 512 / 2);
230 // Read data from controller
231 DEBUGF("Read sector id=%d dest=%x:%x\n", biosid, segment, offset);
232 if (mode == ATA_MODE_PIO32)
233 insl_seg(iobase1, segment, offset, 512 / 4);
235 insw_seg(iobase1, segment, offset, 512 / 2);
236 await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
241 SET_EBDA(ata.trsfsectors,current);
243 status = inb(iobase1 + ATA_CB_STAT);
246 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_RDY | ATA_CB_STAT_DRQ
248 if (status != (ATA_CB_STAT_RDY | ATA_CB_STAT_DRQ)) {
249 DEBUGF("ata_transfer : more sectors left (status %02x)\n"
250 , (unsigned) status);
255 status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_RDY | ATA_CB_STAT_DF
256 | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
258 status &= ~ATA_CB_STAT_DF;
259 if (status != ATA_CB_STAT_RDY ) {
260 DEBUGF("ata_transfer : no sectors left (status %02x)\n"
261 , (unsigned) status);
268 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
272 // ---------------------------------------------------------------------------
273 // ATA/ATAPI driver : execute a packet command
274 // ---------------------------------------------------------------------------
277 // 1 : error in parameters
282 ata_cmd_packet(u16 biosid, u8 *cmdbuf, u8 cmdlen
283 , u16 header, u32 length, u16 bufseg, u16 bufoff)
285 DEBUGF("ata_cmd_packet d=%d cmdlen=%d h=%d l=%d"
287 , biosid, cmdlen, header, length
290 u8 channel = biosid / 2;
291 u8 slave = biosid % 2;
293 // The header length must be even
295 DEBUGF("ata_cmd_packet : header must be even (%04x)\n", header);
299 u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
300 u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
301 u8 mode = GET_EBDA(ata.devices[biosid].mode);
303 struct ata_pio_command cmd;
304 cmd.sector_count = 0;
309 cmd.device = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
310 cmd.command = ATA_CMD_PACKET;
313 int ret = send_cmd(&cmd);
317 // Reset count of transferred data
318 SET_EBDA(ata.trsfsectors,0);
319 SET_EBDA(ata.trsfbytes,0L);
323 // Send command to device
324 outsw_seg(iobase1, GET_SEG(SS), (u32)cmdbuf, cmdlen / 2);
329 if (loops == 0) {//first time through
330 status = inb(iobase2 + ATA_CB_ASTAT);
331 await_ide(NOT_BSY_DRQ, iobase1, IDE_TIMEOUT);
333 await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
336 status = inb(iobase1 + ATA_CB_STAT);
337 inb(iobase1 + ATA_CB_SC);
339 // Check if command completed
340 if(((inb(iobase1 + ATA_CB_SC)&0x7)==0x3) &&
341 ((status & (ATA_CB_STAT_RDY | ATA_CB_STAT_ERR)) == ATA_CB_STAT_RDY))
344 if (status & ATA_CB_STAT_ERR) {
345 DEBUGF("ata_cmd_packet : error (status %02x)\n", status);
350 bufseg += (bufoff / 16);
353 // Get the byte count
354 u16 lcount = (((u16)(inb(iobase1 + ATA_CB_CH))<<8)
355 + inb(iobase1 + ATA_CB_CL));
357 // adjust to read what we want
359 if (header > lcount) {
369 if (lcount > length) {
370 lafter=lcount-length;
381 DEBUGF("Trying to read %04x bytes (%04x %04x %04x) "
382 , lbefore+lcount+lafter, lbefore, lcount, lafter);
383 DEBUGF("to 0x%04x:0x%04x\n", bufseg, bufoff);
385 // If counts not dividable by 4, use 16bits mode
387 if (lbefore & 0x03) lmode=ATA_MODE_PIO16;
388 if (lcount & 0x03) lmode=ATA_MODE_PIO16;
389 if (lafter & 0x03) lmode=ATA_MODE_PIO16;
391 // adds an extra byte if count are odd. before is always even
394 if ((lafter > 0) && (lafter & 0x01)) {
399 if (lmode == ATA_MODE_PIO32) {
400 lcount>>=2; lbefore>>=2; lafter>>=2;
402 lcount>>=1; lbefore>>=1; lafter>>=1;
406 for (i=0; i<lbefore; i++)
407 if (lmode == ATA_MODE_PIO32)
412 if (lmode == ATA_MODE_PIO32)
413 insl_seg(iobase1, bufseg, bufoff, lcount);
415 insw_seg(iobase1, bufseg, bufoff, lcount);
417 for (i=0; i<lafter; i++)
418 if (lmode == ATA_MODE_PIO32)
423 // Compute new buffer address
426 // Save transferred bytes count
427 SET_EBDA(ata.trsfsectors, loops);
430 // Final check, device must be ready
431 if ( (status & (ATA_CB_STAT_BSY | ATA_CB_STAT_RDY | ATA_CB_STAT_DF
432 | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR) )
433 != ATA_CB_STAT_RDY ) {
434 DEBUGF("ata_cmd_packet : not ready (status %02x)\n"
435 , (unsigned) status);
440 outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
445 cdrom_read(u16 biosid, u32 lba, u32 count, u16 segment, u16 offset, u16 skip)
447 u16 sectors = (count + 2048 - 1) / 2048;
450 memset(atacmd, 0, sizeof(atacmd));
451 atacmd[0]=0x28; // READ command
452 atacmd[7]=(sectors & 0xff00) >> 8; // Sectors
453 atacmd[8]=(sectors & 0x00ff); // Sectors
454 atacmd[2]=(lba & 0xff000000) >> 24; // LBA
455 atacmd[3]=(lba & 0x00ff0000) >> 16;
456 atacmd[4]=(lba & 0x0000ff00) >> 8;
457 atacmd[5]=(lba & 0x000000ff);
459 return ata_cmd_packet(biosid, atacmd, sizeof(atacmd)
460 , skip, count, segment, offset);
463 // ---------------------------------------------------------------------------
464 // ATA/ATAPI driver : device detection
465 // ---------------------------------------------------------------------------
470 u8 hdcount, cdcount, device, type;
472 memset(buffer, 0, sizeof(buffer));
474 #if CONFIG_MAX_ATA_INTERFACES > 0
475 SET_EBDA(ata.channels[0].iface,ATA_IFACE_ISA);
476 SET_EBDA(ata.channels[0].iobase1,0x1f0);
477 SET_EBDA(ata.channels[0].iobase2,0x3f0);
478 SET_EBDA(ata.channels[0].irq,14);
480 #if CONFIG_MAX_ATA_INTERFACES > 1
481 SET_EBDA(ata.channels[1].iface,ATA_IFACE_ISA);
482 SET_EBDA(ata.channels[1].iobase1,0x170);
483 SET_EBDA(ata.channels[1].iobase2,0x370);
484 SET_EBDA(ata.channels[1].irq,15);
486 #if CONFIG_MAX_ATA_INTERFACES > 2
487 SET_EBDA(ata.channels[2].iface,ATA_IFACE_ISA);
488 SET_EBDA(ata.channels[2].iobase1,0x1e8);
489 SET_EBDA(ata.channels[2].iobase2,0x3e0);
490 SET_EBDA(ata.channels[2].irq,12);
492 #if CONFIG_MAX_ATA_INTERFACES > 3
493 SET_EBDA(ata.channels[3].iface,ATA_IFACE_ISA);
494 SET_EBDA(ata.channels[3].iobase1,0x168);
495 SET_EBDA(ata.channels[3].iobase2,0x360);
496 SET_EBDA(ata.channels[3].irq,11);
498 #if CONFIG_MAX_ATA_INTERFACES > 4
499 #error Please fill the ATA interface informations
505 for(device=0; device<CONFIG_MAX_ATA_DEVICES; device++) {
506 u16 iobase1, iobase2;
507 u8 channel, slave, shift;
508 u8 sc, sn, cl, ch, st;
510 channel = device / 2;
513 iobase1 =GET_EBDA(ata.channels[channel].iobase1);
514 iobase2 =GET_EBDA(ata.channels[channel].iobase2);
516 // Disable interrupts
517 outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
520 outb(slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
521 outb(0x55, iobase1+ATA_CB_SC);
522 outb(0xaa, iobase1+ATA_CB_SN);
523 outb(0xaa, iobase1+ATA_CB_SC);
524 outb(0x55, iobase1+ATA_CB_SN);
525 outb(0x55, iobase1+ATA_CB_SC);
526 outb(0xaa, iobase1+ATA_CB_SN);
528 // If we found something
529 sc = inb(iobase1+ATA_CB_SC);
530 sn = inb(iobase1+ATA_CB_SN);
532 if ( (sc == 0x55) && (sn == 0xaa) ) {
533 SET_EBDA(ata.devices[device].type,ATA_TYPE_UNKNOWN);
538 // check for ATA or ATAPI
539 outb(slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
540 sc = inb(iobase1+ATA_CB_SC);
541 sn = inb(iobase1+ATA_CB_SN);
542 if ((sc==0x01) && (sn==0x01)) {
543 cl = inb(iobase1+ATA_CB_CL);
544 ch = inb(iobase1+ATA_CB_CH);
545 st = inb(iobase1+ATA_CB_STAT);
547 if ((cl==0x14) && (ch==0xeb)) {
548 SET_EBDA(ata.devices[device].type,ATA_TYPE_ATAPI);
549 } else if ((cl==0x00) && (ch==0x00) && (st!=0x00)) {
550 SET_EBDA(ata.devices[device].type,ATA_TYPE_ATA);
551 } else if ((cl==0xff) && (ch==0xff)) {
552 SET_EBDA(ata.devices[device].type,ATA_TYPE_NONE);
557 type=GET_EBDA(ata.devices[device].type);
559 // Now we send a IDENTIFY command to ATA device
560 if(type == ATA_TYPE_ATA) {
562 u16 cylinders, heads, spt, blksize;
563 u8 translation, removable, mode;
565 //Temporary values to do the transfer
566 SET_EBDA(ata.devices[device].device,ATA_DEVICE_HD);
567 SET_EBDA(ata.devices[device].mode, ATA_MODE_PIO16);
569 u16 ret = ata_cmd_data_chs(device, ATA_CMD_IDENTIFY_DEVICE
571 , GET_SEG(SS), (u32)buffer);
573 BX_PANIC("ata-detect: Failed to detect ATA device\n");
575 removable = (buffer[0] & 0x80) ? 1 : 0;
576 mode = buffer[96] ? ATA_MODE_PIO32 : ATA_MODE_PIO16;
577 blksize = *(u16*)&buffer[10];
579 cylinders = *(u16*)&buffer[1*2]; // word 1
580 heads = *(u16*)&buffer[3*2]; // word 3
581 spt = *(u16*)&buffer[6*2]; // word 6
583 sectors = *(u32*)&buffer[60*2]; // word 60 and word 61
585 SET_EBDA(ata.devices[device].device,ATA_DEVICE_HD);
586 SET_EBDA(ata.devices[device].removable, removable);
587 SET_EBDA(ata.devices[device].mode, mode);
588 SET_EBDA(ata.devices[device].blksize, blksize);
589 SET_EBDA(ata.devices[device].pchs.heads, heads);
590 SET_EBDA(ata.devices[device].pchs.cylinders, cylinders);
591 SET_EBDA(ata.devices[device].pchs.spt, spt);
592 SET_EBDA(ata.devices[device].sectors, sectors);
593 BX_INFO("ata%d-%d: PCHS=%u/%d/%d translation="
594 , channel, slave,cylinders, heads, spt);
596 translation = inb_cmos(CMOS_BIOS_DISKTRANSFLAG + channel/2);
597 for (shift=device%4; shift>0; shift--)
601 SET_EBDA(ata.devices[device].translation, translation);
603 switch (translation) {
604 case ATA_TRANSLATION_NONE:
607 case ATA_TRANSLATION_LBA:
610 case ATA_TRANSLATION_LARGE:
613 case ATA_TRANSLATION_RECHS:
617 switch (translation) {
618 case ATA_TRANSLATION_NONE:
620 case ATA_TRANSLATION_LBA:
623 heads = sectors / 1024;
624 if (heads>128) heads = 255;
625 else if (heads>64) heads = 128;
626 else if (heads>32) heads = 64;
627 else if (heads>16) heads = 32;
629 cylinders = sectors / heads;
631 case ATA_TRANSLATION_RECHS:
632 // Take care not to overflow
634 if(cylinders>61439) cylinders=61439;
636 cylinders = (u16)((u32)(cylinders)*16/15);
638 // then go through the large bitshift process
639 case ATA_TRANSLATION_LARGE:
640 while(cylinders > 1024) {
644 // If we max out the head count
645 if (heads > 127) break;
649 // clip to 1024 cylinders in lchs
650 if (cylinders > 1024)
652 BX_INFO(" LCHS=%d/%d/%d\n", cylinders, heads, spt);
654 SET_EBDA(ata.devices[device].lchs.heads, heads);
655 SET_EBDA(ata.devices[device].lchs.cylinders, cylinders);
656 SET_EBDA(ata.devices[device].lchs.spt, spt);
659 SET_EBDA(ata.idmap[0][hdcount], device);
663 // Now we send a IDENTIFY command to ATAPI device
664 if(type == ATA_TYPE_ATAPI) {
666 u8 type, removable, mode;
669 //Temporary values to do the transfer
670 SET_EBDA(ata.devices[device].device,ATA_DEVICE_CDROM);
671 SET_EBDA(ata.devices[device].mode, ATA_MODE_PIO16);
673 u16 ret = ata_cmd_data_chs(device, ATA_CMD_IDENTIFY_DEVICE_PACKET
675 , GET_SEG(SS), (u32)buffer);
677 BX_PANIC("ata-detect: Failed to detect ATAPI device\n");
679 type = buffer[1] & 0x1f;
680 removable = (buffer[0] & 0x80) ? 1 : 0;
681 mode = buffer[96] ? ATA_MODE_PIO32 : ATA_MODE_PIO16;
684 SET_EBDA(ata.devices[device].device, type);
685 SET_EBDA(ata.devices[device].removable, removable);
686 SET_EBDA(ata.devices[device].mode, mode);
687 SET_EBDA(ata.devices[device].blksize, blksize);
690 SET_EBDA(ata.idmap[1][cdcount], device);
696 u8 c, i, version=0, model[41];
700 sizeinmb = GET_EBDA(ata.devices[device].sectors);
703 // Read ATA/ATAPI version
704 ataversion=((u16)(buffer[161])<<8) | buffer[160];
705 for(version=15;version>0;version--) {
706 if ((ataversion&(1<<version))!=0)
712 model[i*2] = buffer[(i*2)+54+1];
713 model[(i*2)+1] = buffer[(i*2)+54];
729 printf("ata%d %s: ",channel,slave?" slave":"master");
731 while ((c=model[i++]))
733 if (sizeinmb < (1UL<<16))
734 printf(" ATA-%d Hard-Disk (%u MBytes)\n", version, (u16)sizeinmb);
736 printf(" ATA-%d Hard-Disk (%u GBytes)\n", version, (u16)(sizeinmb>>10));
739 printf("ata%d %s: ",channel,slave?" slave":"master");
741 while ((c=model[i++]))
743 if (GET_EBDA(ata.devices[device].device)==ATA_DEVICE_CDROM)
744 printf(" ATAPI-%d CD-Rom/DVD-Rom\n",version);
746 printf(" ATAPI-%d Device\n",version);
748 case ATA_TYPE_UNKNOWN:
749 printf("ata%d %s: Unknown device\n",channel,slave?" slave":"master");
754 // Store the devices counts
755 SET_EBDA(ata.hdcount, hdcount);
756 SET_EBDA(ata.cdcount, cdcount);
757 SET_BDA(disk_count, hdcount);
761 // FIXME : should use bios=cmos|auto|disable bits
762 // FIXME : should know about translation bits
763 // FIXME : move hard_drive_post here