Improve control of debug messages.
[seabios.git] / src / ata.c
1 // Low level ATA disk access
2 //
3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002  MandrakeSoft S.A.
5 //
6 // This file may be distributed under the terms of the GNU GPLv3 license.
7
8 #include "ata.h" // ATA_*
9 #include "types.h" // u8
10 #include "ioport.h" // inb
11 #include "util.h" // dprintf
12 #include "cmos.h" // inb_cmos
13
14 #define TIMEOUT 0
15 #define BSY 1
16 #define NOT_BSY 2
17 #define NOT_BSY_DRQ 3
18 #define NOT_BSY_NOT_DRQ 4
19 #define NOT_BSY_RDY 5
20
21 #define IDE_SECTOR_SIZE 512
22 #define CDROM_SECTOR_SIZE 2048
23
24 #define IDE_TIMEOUT 32000u //32 seconds max for IDE ops
25
26 #define DEBUGF1(fmt, args...) bprintf(0, fmt , ##args)
27 #define DEBUGF(fmt, args...)
28
29
30 /****************************************************************
31  * Helper functions
32  ****************************************************************/
33
34 // Wait for the specified ide state
35 static int
36 await_ide(u8 when_done, u16 base, u16 timeout)
37 {
38     u32 time=0, last=0;
39     for (;;) {
40         u8 status = inb(base+ATA_CB_STAT);
41         time++;
42         u8 result = 0;
43         if (when_done == BSY)
44             result = status & ATA_CB_STAT_BSY;
45         else if (when_done == NOT_BSY)
46             result = !(status & ATA_CB_STAT_BSY);
47         else if (when_done == NOT_BSY_DRQ)
48             result = !(status & ATA_CB_STAT_BSY) && (status & ATA_CB_STAT_DRQ);
49         else if (when_done == NOT_BSY_NOT_DRQ)
50             result = !(status & ATA_CB_STAT_BSY) && !(status & ATA_CB_STAT_DRQ);
51         else if (when_done == NOT_BSY_RDY)
52             result = !(status & ATA_CB_STAT_BSY) && (status & ATA_CB_STAT_RDY);
53
54         if (result)
55             return status;
56         // mod 2048 each 16 ms
57         if (time>>16 != last) {
58             last = time >>16;
59             DEBUGF("await_ide: (TIMEOUT,BSY,!BSY,!BSY_DRQ,!BSY_!DRQ,!BSY_RDY)"
60                    " %d time= %d timeout= %d\n"
61                    , when_done, time>>11, timeout);
62         }
63         if (status & ATA_CB_STAT_ERR) {
64             DEBUGF("await_ide: ERROR (TIMEOUT,BSY,!BSY,!BSY_DRQ"
65                    ",!BSY_!DRQ,!BSY_RDY) %d time= %d timeout= %d\n"
66                    , when_done, time>>11, timeout);
67             return -1;
68         }
69         if (timeout == 0 || (time>>11) > timeout)
70             break;
71     }
72     dprintf(1, "IDE time out\n");
73     return -1;
74 }
75
76 // Wait for ide state - pauses for one ata cycle first.
77 static __always_inline int
78 pause_await_ide(u8 when_done, u16 iobase1, u16 iobase2, u16 timeout)
79 {
80     // Wait one PIO transfer cycle.
81     inb(iobase2 + ATA_CB_ASTAT);
82
83     return await_ide(when_done, iobase1, timeout);
84 }
85
86 // Delay for x nanoseconds
87 static void
88 nsleep(u32 delay)
89 {
90     // XXX - how to implement ndelay?
91     while (delay--)
92         nop();
93 }
94
95 // Reset a drive
96 void
97 ata_reset(int driveid)
98 {
99     u16 iobase1, iobase2;
100     u8  channel, slave, sn, sc;
101     u8  type;
102
103     channel = driveid / 2;
104     slave = driveid % 2;
105
106     iobase1 = GET_EBDA(ata.channels[channel].iobase1);
107     iobase2 = GET_EBDA(ata.channels[channel].iobase2);
108
109     // Reset
110
111     // 8.2.1 (a) -- set SRST in DC
112     outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN | ATA_CB_DC_SRST, iobase2+ATA_CB_DC);
113
114     // 8.2.1 (b) -- wait for BSY
115     await_ide(BSY, iobase1, 20);
116
117     // 8.2.1 (f) -- clear SRST
118     outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
119
120     type=GET_EBDA(ata.devices[driveid].type);
121     if (type != ATA_TYPE_NONE) {
122
123         // 8.2.1 (g) -- check for sc==sn==0x01
124         // select device
125         outb(slave?ATA_CB_DH_DEV1:ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
126         sc = inb(iobase1+ATA_CB_SC);
127         sn = inb(iobase1+ATA_CB_SN);
128
129         if ( (sc==0x01) && (sn==0x01) ) {
130             if (type == ATA_TYPE_ATA) //ATA
131                 await_ide(NOT_BSY_RDY, iobase1, IDE_TIMEOUT);
132             else //ATAPI
133                 await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
134         }
135
136         // 8.2.1 (h) -- wait for not BSY
137         await_ide(NOT_BSY, iobase1, IDE_TIMEOUT);
138     }
139
140     // Enable interrupts
141     outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
142 }
143
144
145 /****************************************************************
146  * ATA send command
147  ****************************************************************/
148
149 struct ata_op_s {
150     u64 lba;
151     void *far_buffer;
152     u16 driveid;
153     u16 count;
154 };
155
156 struct ata_pio_command {
157     u8 feature;
158     u8 sector_count;
159     u8 lba_low;
160     u8 lba_mid;
161     u8 lba_high;
162     u8 device;
163     u8 command;
164
165     u8 sector_count2;
166     u8 lba_low2;
167     u8 lba_mid2;
168     u8 lba_high2;
169 };
170
171 // Send an ata command to the drive.
172 static int
173 send_cmd(int driveid, struct ata_pio_command *cmd)
174 {
175     u8 channel = driveid / 2;
176     u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
177     u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
178
179     int status = inb(iobase1 + ATA_CB_STAT);
180     if (status & ATA_CB_STAT_BSY)
181         return 1;
182
183     outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2 + ATA_CB_DC);
184     if (cmd->command & 0x04) {
185         outb(0x00, iobase1 + ATA_CB_FR);
186         outb(cmd->sector_count2, iobase1 + ATA_CB_SC);
187         outb(cmd->lba_low2, iobase1 + ATA_CB_SN);
188         outb(cmd->lba_mid2, iobase1 + ATA_CB_CL);
189         outb(cmd->lba_high2, iobase1 + ATA_CB_CH);
190     }
191     outb(cmd->feature, iobase1 + ATA_CB_FR);
192     outb(cmd->sector_count, iobase1 + ATA_CB_SC);
193     outb(cmd->lba_low, iobase1 + ATA_CB_SN);
194     outb(cmd->lba_mid, iobase1 + ATA_CB_CL);
195     outb(cmd->lba_high, iobase1 + ATA_CB_CH);
196     outb(cmd->device, iobase1 + ATA_CB_DH);
197     outb(cmd->command, iobase1 + ATA_CB_CMD);
198
199     nsleep(400);
200
201     status = await_ide(NOT_BSY_DRQ, iobase1, IDE_TIMEOUT);
202     if (status < 0)
203         return status;
204
205     if (status & ATA_CB_STAT_ERR) {
206         DEBUGF("send_cmd : read error\n");
207         return 2;
208     }
209     if (!(status & ATA_CB_STAT_DRQ)) {
210         DEBUGF("send_cmd : DRQ not set (status %02x)\n"
211                , (unsigned) status);
212         return 3;
213     }
214
215     return 0;
216 }
217
218
219 /****************************************************************
220  * ATA transfers
221  ****************************************************************/
222
223 // Read and discard x number of bytes from an io channel.
224 static void
225 insx_discard(int mode, int iobase1, int bytes)
226 {
227     int count, i;
228     if (mode == ATA_MODE_PIO32) {
229         count = bytes / 4;
230         for (i=0; i<count; i++)
231             inl(iobase1);
232     } else {
233         count = bytes / 2;
234         for (i=0; i<count; i++)
235             inw(iobase1);
236     }
237 }
238
239 // Transfer 'count' blocks (of 'blocksize' bytes) to/from drive
240 // 'driveid'.  If 'skipfirst' or 'skiplast' is set then the first
241 // and/or last block may be partially transferred.  This function is
242 // inlined because all the callers use different forms and because the
243 // large number of parameters would consume a lot of stack space.
244 static __always_inline int
245 ata_transfer(int driveid, int iswrite, int count, int blocksize
246              , int skipfirst, int skiplast, void *far_buffer)
247 {
248     DEBUGF("ata_transfer id=%d write=%d count=%d bs=%d"
249            " skipf=%d skipl=%d buf=%p\n"
250            , driveid, iswrite, count, blocksize
251            , skipfirst, skiplast, far_buffer);
252
253     // Reset count of transferred data
254     SET_EBDA(ata.trsfsectors, 0);
255
256     u8 channel  = driveid / 2;
257     u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
258     u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
259     u8 mode     = GET_EBDA(ata.devices[driveid].mode);
260     int current = 0;
261     int status;
262     for (;;) {
263         int bsize = blocksize;
264         if (skipfirst && current == 0) {
265             insx_discard(mode, iobase1, skipfirst);
266             bsize -= skipfirst;
267         }
268         if (skiplast && current == count-1)
269             bsize -= skiplast;
270
271         if (iswrite) {
272             // Write data to controller
273             DEBUGF("Write sector id=%d dest=%p\n", driveid, far_buffer);
274             if (mode == ATA_MODE_PIO32)
275                 outsl_far(iobase1, far_buffer, bsize / 4);
276             else
277                 outsw_far(iobase1, far_buffer, bsize / 2);
278         } else {
279             // Read data from controller
280             DEBUGF("Read sector id=%d dest=%p\n", driveid, far_buffer);
281             if (mode == ATA_MODE_PIO32)
282                 insl_far(iobase1, far_buffer, bsize / 4);
283             else
284                 insw_far(iobase1, far_buffer, bsize / 2);
285         }
286         far_buffer += bsize;
287
288         if (skiplast && current == count-1)
289             insx_discard(mode, iobase1, skiplast);
290
291         status = pause_await_ide(NOT_BSY, iobase1, iobase2, IDE_TIMEOUT);
292         if (status < 0)
293             // Error
294             return status;
295
296         current++;
297         SET_EBDA(ata.trsfsectors, current);
298         if (current == count)
299             break;
300         status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_RDY | ATA_CB_STAT_DRQ
301                    | ATA_CB_STAT_ERR);
302         if (status != (ATA_CB_STAT_RDY | ATA_CB_STAT_DRQ)) {
303             DEBUGF("ata_transfer : more sectors left (status %02x)\n"
304                    , (unsigned) status);
305             return 5;
306         }
307     }
308
309     status &= (ATA_CB_STAT_BSY | ATA_CB_STAT_RDY | ATA_CB_STAT_DF
310                | ATA_CB_STAT_DRQ | ATA_CB_STAT_ERR);
311     if (!iswrite)
312         status &= ~ATA_CB_STAT_DF;
313     if (status != ATA_CB_STAT_RDY ) {
314         DEBUGF("ata_transfer : no sectors left (status %02x)\n"
315                , (unsigned) status);
316         return 4;
317     }
318
319     // Enable interrupts
320     outb(ATA_CB_DC_HD15, iobase2+ATA_CB_DC);
321     return 0;
322 }
323
324 static noinline int
325 ata_transfer_disk(const struct ata_op_s *op, int iswrite)
326 {
327     return ata_transfer(op->driveid, iswrite, op->count, IDE_SECTOR_SIZE
328                         , 0, 0, op->far_buffer);
329 }
330
331 static noinline int
332 ata_transfer_cdrom(const struct ata_op_s *op)
333 {
334     return ata_transfer(op->driveid, 0, op->count, CDROM_SECTOR_SIZE
335                         , 0, 0, op->far_buffer);
336 }
337
338 static noinline int
339 ata_transfer_emu(const struct ata_op_s *op, int before, int after)
340 {
341     int vcount = op->count * 4 - before - after;
342     int ret = ata_transfer(op->driveid, 0, op->count, CDROM_SECTOR_SIZE
343                            , before*512, after*512, op->far_buffer);
344     if (ret) {
345         SET_EBDA(ata.trsfsectors, 0);
346         return ret;
347     }
348     SET_EBDA(ata.trsfsectors, vcount);
349     return 0;
350 }
351
352
353 /****************************************************************
354  * ATA hard drive functions
355  ****************************************************************/
356
357 static noinline int
358 send_cmd_disk(const struct ata_op_s *op, u16 command)
359 {
360     u8 slave = op->driveid % 2;
361     u64 lba = op->lba;
362
363     struct ata_pio_command cmd;
364     memset(&cmd, 0, sizeof(cmd));
365
366     cmd.command = command;
367     if (op->count >= (1<<8) || lba + op->count >= (1<<28)) {
368         cmd.sector_count2 = op->count >> 8;
369         cmd.lba_low2 = lba >> 24;
370         cmd.lba_mid2 = lba >> 32;
371         cmd.lba_high2 = lba >> 40;
372
373         cmd.command |= 0x04;
374         lba &= 0xffffff;
375     }
376
377     cmd.feature = 0;
378     cmd.sector_count = op->count;
379     cmd.lba_low = lba;
380     cmd.lba_mid = lba >> 8;
381     cmd.lba_high = lba >> 16;
382     cmd.device = ((slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0)
383                   | ((lba >> 24) & 0xf) | ATA_CB_DH_LBA);
384
385     return send_cmd(op->driveid, &cmd);
386 }
387
388 // Read/write count blocks from a harddrive.
389 __always_inline int
390 ata_cmd_data(int driveid, u16 command, u64 lba, u16 count, void *far_buffer)
391 {
392     struct ata_op_s op;
393     op.driveid = driveid;
394     op.lba = lba;
395     op.count = count;
396     op.far_buffer = far_buffer;
397
398     int ret = send_cmd_disk(&op, command);
399     if (ret)
400         return ret;
401
402     int iswrite = command == ATA_CMD_WRITE_SECTORS;
403     return ata_transfer_disk(&op, iswrite);
404 }
405
406
407 /****************************************************************
408  * ATAPI functions
409  ****************************************************************/
410
411 // Low-level atapi command transmit function.
412 static __always_inline int
413 send_atapi_cmd(int driveid, u8 *cmdbuf, u8 cmdlen, u16 blocksize)
414 {
415     u8 channel = driveid / 2;
416     u8 slave = driveid % 2;
417     u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
418     u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
419
420     struct ata_pio_command cmd;
421     cmd.sector_count = 0;
422     cmd.feature = 0;
423     cmd.lba_low = 0;
424     cmd.lba_mid = blocksize;
425     cmd.lba_high = blocksize >> 8;
426     cmd.device = slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0;
427     cmd.command = ATA_CMD_PACKET;
428
429     int ret = send_cmd(driveid, &cmd);
430     if (ret)
431         return ret;
432
433     // Send command to device
434     outsw_far(iobase1, MAKE_FARPTR(GET_SEG(SS), (u32)cmdbuf), cmdlen / 2);
435
436     int status = pause_await_ide(NOT_BSY_DRQ, iobase1, iobase2, IDE_TIMEOUT);
437     if (status < 0)
438         return status;
439
440     return 0;
441 }
442
443 // Low-level cdrom read atapi command transmit function.
444 static int
445 send_cmd_cdrom(const struct ata_op_s *op)
446 {
447     u8 atacmd[12];
448     memset(atacmd, 0, sizeof(atacmd));
449
450     atacmd[0]=0x28;                         // READ command
451     atacmd[7]=(op->count & 0xff00) >> 8;    // Sectors
452     atacmd[8]=(op->count & 0x00ff);
453     atacmd[2]=(op->lba & 0xff000000) >> 24; // LBA
454     atacmd[3]=(op->lba & 0x00ff0000) >> 16;
455     atacmd[4]=(op->lba & 0x0000ff00) >> 8;
456     atacmd[5]=(op->lba & 0x000000ff);
457
458     return send_atapi_cmd(op->driveid, atacmd, sizeof(atacmd)
459                           , CDROM_SECTOR_SIZE);
460 }
461
462 // Read sectors from the cdrom.
463 __always_inline int
464 cdrom_read(int driveid, u32 lba, u32 count, void *far_buffer)
465 {
466     struct ata_op_s op;
467     op.driveid = driveid;
468     op.lba = lba;
469     op.count = count;
470     op.far_buffer = far_buffer;
471
472     int ret = send_cmd_cdrom(&op);
473     if (ret)
474         return ret;
475
476     return ata_transfer_cdrom(&op);
477 }
478
479 // Pretend the cdrom has 512 byte sectors (instead of 2048) and read
480 // sectors.
481 __always_inline int
482 cdrom_read_512(int driveid, u32 vlba, u32 vcount, void *far_buffer)
483 {
484     u32 velba = vlba + vcount - 1;
485     u32 lba = vlba / 4;
486     u32 elba = velba / 4;
487     int count = elba - lba + 1;
488     int before = vlba % 4;
489     int after = 3 - (velba % 4);
490
491     struct ata_op_s op;
492     op.driveid = driveid;
493     op.lba = lba;
494     op.count = count;
495     op.far_buffer = far_buffer;
496
497     DEBUGF("cdrom_read_512: id=%d vlba=%d vcount=%d buf=%p lba=%d elba=%d"
498            " count=%d before=%d after=%d\n"
499            , driveid, vlba, vcount, far_buffer, lba, elba
500            , count, before, after);
501
502     int ret = send_cmd_cdrom(&op);
503     if (ret)
504         return ret;
505
506     return ata_transfer_emu(&op, before, after);
507 }
508
509 // Send a simple atapi command to a drive.
510 int
511 ata_cmd_packet(int driveid, u8 *cmdbuf, u8 cmdlen
512                , u32 length, void *far_buffer)
513 {
514     int ret = send_atapi_cmd(driveid, cmdbuf, cmdlen, length);
515     if (ret)
516         return ret;
517
518     return ata_transfer(driveid, 0, 1, length, 0, 0, far_buffer);
519 }
520
521
522 /****************************************************************
523  * ATA detect and init
524  ****************************************************************/
525
526 static void
527 report_model(int driveid, u8 *buffer)
528 {
529     u8 model[41];
530
531     // Read model name
532     int i;
533     for (i=0; i<40; i+=2) {
534         model[i] = buffer[i+54+1];
535         model[i+1] = buffer[i+54];
536     }
537
538     // Reformat
539     model[40] = 0x00;
540     for (i=39; i>0; i--) {
541         if (model[i] != 0x20)
542             break;
543         model[i] = 0x00;
544     }
545
546     u8 channel = driveid / 2;
547     u8 slave = driveid % 2;
548     // XXX - model on stack not %cs
549     printf("ata%d %s: %s", channel, slave ? " slave" : "master", model);
550 }
551
552 static u8
553 get_ata_version(u8 *buffer)
554 {
555     u16 ataversion = *(u16*)&buffer[160];
556     u8 version;
557     for (version=15; version>0; version--)
558         if (ataversion & (1<<version))
559             break;
560     return version;
561 }
562
563 static void
564 init_drive_atapi(int driveid)
565 {
566     SET_EBDA(ata.devices[driveid].type,ATA_TYPE_ATAPI);
567
568     // Temporary values to do the transfer
569     SET_EBDA(ata.devices[driveid].device,ATA_DEVICE_CDROM);
570     SET_EBDA(ata.devices[driveid].mode, ATA_MODE_PIO16);
571
572     // Now we send a IDENTIFY command to ATAPI device
573     u8 buffer[0x0200];
574     memset(buffer, 0, sizeof(buffer));
575     u16 ret = ata_cmd_data(driveid, ATA_CMD_IDENTIFY_DEVICE_PACKET
576                            , 1, 1
577                            , MAKE_FARPTR(GET_SEG(SS), (u32)buffer));
578     if (ret != 0)
579         BX_PANIC("ata-detect: Failed to detect ATAPI device\n");
580
581     u8 type      = buffer[1] & 0x1f;
582     u8 removable = (buffer[0] & 0x80) ? 1 : 0;
583     u8 mode      = buffer[96] ? ATA_MODE_PIO32 : ATA_MODE_PIO16;
584     u16 blksize  = CDROM_SECTOR_SIZE;
585
586     SET_EBDA(ata.devices[driveid].device, type);
587     SET_EBDA(ata.devices[driveid].removable, removable);
588     SET_EBDA(ata.devices[driveid].mode, mode);
589     SET_EBDA(ata.devices[driveid].blksize, blksize);
590
591     // fill cdidmap
592     u8 cdcount = GET_EBDA(ata.cdcount);
593     SET_EBDA(ata.idmap[1][cdcount], driveid);
594     SET_EBDA(ata.cdcount, ++cdcount);
595
596     report_model(driveid, buffer);
597     u8 version = get_ata_version(buffer);
598     if (GET_EBDA(ata.devices[driveid].device)==ATA_DEVICE_CDROM)
599         printf(" ATAPI-%d CD-Rom/DVD-Rom\n", version);
600     else
601         printf(" ATAPI-%d Device\n", version);
602 }
603
604 static void
605 fill_fdpt(int driveid)
606 {
607     if (driveid > 1)
608         return;
609
610     u16 nlc   = GET_EBDA(ata.devices[driveid].lchs.cylinders);
611     u16 nlh   = GET_EBDA(ata.devices[driveid].lchs.heads);
612     u16 nlspt = GET_EBDA(ata.devices[driveid].lchs.spt);
613
614     u16 npc   = GET_EBDA(ata.devices[driveid].pchs.cylinders);
615     u16 nph   = GET_EBDA(ata.devices[driveid].pchs.heads);
616     u16 npspt = GET_EBDA(ata.devices[driveid].pchs.spt);
617
618     SET_EBDA(fdpt[driveid].precompensation, 0xffff);
619     SET_EBDA(fdpt[driveid].drive_control_byte, 0xc0 | ((nph > 8) << 3));
620     SET_EBDA(fdpt[driveid].landing_zone, npc);
621     SET_EBDA(fdpt[driveid].cylinders, nlc);
622     SET_EBDA(fdpt[driveid].heads, nlh);
623     SET_EBDA(fdpt[driveid].sectors, nlspt);
624
625     if (nlc == npc && nlh == nph && nlspt == npspt)
626         // no logical CHS mapping used, just physical CHS
627         // use Standard Fixed Disk Parameter Table (FDPT)
628         return;
629
630     // complies with Phoenix style Translated Fixed Disk Parameter
631     // Table (FDPT)
632     SET_EBDA(fdpt[driveid].phys_cylinders, npc);
633     SET_EBDA(fdpt[driveid].phys_heads, nph);
634     SET_EBDA(fdpt[driveid].phys_sectors, npspt);
635     SET_EBDA(fdpt[driveid].a0h_signature, 0xa0);
636
637     // Checksum structure.
638     u8 *p = MAKE_FARPTR(SEG_EBDA, offsetof(struct extended_bios_data_area_s
639                                            , fdpt[driveid]));
640     u8 sum = checksum(p, FIELD_SIZEOF(struct extended_bios_data_area_s
641                                       , fdpt[driveid]) - 1);
642     SET_EBDA(fdpt[driveid].checksum, -sum);
643 }
644
645 static u8
646 get_translation(int driveid)
647 {
648     if (! CONFIG_COREBOOT) {
649         // Emulators pass in the translation info via nvram.
650         u8 channel = driveid / 2;
651         u8 translation = inb_cmos(CMOS_BIOS_DISKTRANSFLAG + channel/2);
652         translation >>= 2 * (driveid % 4);
653         translation &= 0x03;
654         return translation;
655     }
656
657     // On COREBOOT, use a heuristic to determine translation type.
658     u16 heads = GET_EBDA(ata.devices[driveid].pchs.heads);
659     u16 cylinders = GET_EBDA(ata.devices[driveid].pchs.cylinders);
660     u16 spt = GET_EBDA(ata.devices[driveid].pchs.spt);
661
662     if (cylinders <= 1024 && heads <= 16 && spt <= 63)
663         return ATA_TRANSLATION_NONE;
664     if (cylinders * heads <= 131072)
665         return ATA_TRANSLATION_LARGE;
666     return ATA_TRANSLATION_LBA;
667 }
668
669 static void
670 setup_translation(int driveid)
671 {
672     u8 translation = get_translation(driveid);
673     SET_EBDA(ata.devices[driveid].translation, translation);
674
675     u8 channel = driveid / 2;
676     u8 slave = driveid % 2;
677     u16 heads = GET_EBDA(ata.devices[driveid].pchs.heads);
678     u16 cylinders = GET_EBDA(ata.devices[driveid].pchs.cylinders);
679     u16 spt = GET_EBDA(ata.devices[driveid].pchs.spt);
680     u64 sectors = GET_EBDA(ata.devices[driveid].sectors);
681
682     dprintf(1, "ata%d-%d: PCHS=%u/%d/%d translation="
683             , channel, slave, cylinders, heads, spt);
684     switch (translation) {
685     case ATA_TRANSLATION_NONE:
686         dprintf(1, "none");
687         break;
688     case ATA_TRANSLATION_LBA:
689         dprintf(1, "lba");
690         spt = 63;
691         if (sectors > 63*255*1024) {
692             heads = 255;
693             cylinders = 1024;
694             break;
695         }
696         u32 sect = (u32)sectors / 63;
697         heads = sect / 1024;
698         if (heads>128)
699             heads = 255;
700         else if (heads>64)
701             heads = 128;
702         else if (heads>32)
703             heads = 64;
704         else if (heads>16)
705             heads = 32;
706         else
707             heads = 16;
708         cylinders = sect / heads;
709         break;
710     case ATA_TRANSLATION_RECHS:
711         dprintf(1, "r-echs");
712         // Take care not to overflow
713         if (heads==16) {
714             if (cylinders>61439)
715                 cylinders=61439;
716             heads=15;
717             cylinders = (u16)((u32)(cylinders)*16/15);
718         }
719         // then go through the large bitshift process
720     case ATA_TRANSLATION_LARGE:
721         if (translation == ATA_TRANSLATION_LARGE)
722             dprintf(1, "large");
723         while (cylinders > 1024) {
724             cylinders >>= 1;
725             heads <<= 1;
726
727             // If we max out the head count
728             if (heads > 127)
729                 break;
730         }
731         break;
732     }
733     // clip to 1024 cylinders in lchs
734     if (cylinders > 1024)
735         cylinders = 1024;
736     dprintf(1, " LCHS=%d/%d/%d\n", cylinders, heads, spt);
737
738     SET_EBDA(ata.devices[driveid].lchs.heads, heads);
739     SET_EBDA(ata.devices[driveid].lchs.cylinders, cylinders);
740     SET_EBDA(ata.devices[driveid].lchs.spt, spt);
741 }
742
743 static void
744 init_drive_ata(int driveid)
745 {
746     SET_EBDA(ata.devices[driveid].type, ATA_TYPE_ATA);
747
748     // Temporary values to do the transfer
749     SET_EBDA(ata.devices[driveid].device, ATA_DEVICE_HD);
750     SET_EBDA(ata.devices[driveid].mode, ATA_MODE_PIO16);
751
752     // Now we send a IDENTIFY command to ATA device
753     u8 buffer[0x0200];
754     memset(buffer, 0, sizeof(buffer));
755     u16 ret = ata_cmd_data(driveid, ATA_CMD_IDENTIFY_DEVICE
756                            , 1, 1
757                            , MAKE_FARPTR(GET_SEG(SS), (u32)buffer));
758     if (ret)
759         BX_PANIC("ata-detect: Failed to detect ATA device\n");
760
761     u8 removable  = (buffer[0] & 0x80) ? 1 : 0;
762     u8 mode       = buffer[96] ? ATA_MODE_PIO32 : ATA_MODE_PIO16;
763     u16 blksize   = *(u16*)&buffer[10];
764
765     u16 cylinders = *(u16*)&buffer[1*2]; // word 1
766     u16 heads     = *(u16*)&buffer[3*2]; // word 3
767     u16 spt       = *(u16*)&buffer[6*2]; // word 6
768
769     u64 sectors;
770     if (*(u16*)&buffer[83*2] & (1 << 10)) // word 83 - lba48 support
771         sectors = *(u64*)&buffer[100*2]; // word 100-103
772     else
773         sectors = *(u32*)&buffer[60*2]; // word 60 and word 61
774
775     SET_EBDA(ata.devices[driveid].device, ATA_DEVICE_HD);
776     SET_EBDA(ata.devices[driveid].removable, removable);
777     SET_EBDA(ata.devices[driveid].mode, mode);
778     SET_EBDA(ata.devices[driveid].blksize, blksize);
779     SET_EBDA(ata.devices[driveid].pchs.heads, heads);
780     SET_EBDA(ata.devices[driveid].pchs.cylinders, cylinders);
781     SET_EBDA(ata.devices[driveid].pchs.spt, spt);
782     SET_EBDA(ata.devices[driveid].sectors, sectors);
783
784     // Setup disk geometry translation.
785     setup_translation(driveid);
786
787     // fill hdidmap
788     u8 hdcount = GET_EBDA(ata.hdcount);
789     SET_EBDA(ata.idmap[0][hdcount], driveid);
790     SET_EBDA(ata.hdcount, ++hdcount);
791
792     // Fill "fdpt" structure.
793     fill_fdpt(driveid);
794
795     // Report drive info to user.
796     u64 sizeinmb = GET_EBDA(ata.devices[driveid].sectors) >> 11;
797     report_model(driveid, buffer);
798     u8 version = get_ata_version(buffer);
799     if (sizeinmb < (1 << 16))
800         printf(" ATA-%d Hard-Disk (%u MBytes)\n", version, (u32)sizeinmb);
801     else
802         printf(" ATA-%d Hard-Disk (%u GBytes)\n", version
803                , (u32)(sizeinmb >> 10));
804 }
805
806 static void
807 init_drive_unknown(int driveid)
808 {
809     SET_EBDA(ata.devices[driveid].type,ATA_TYPE_UNKNOWN);
810
811     u8 channel = driveid / 2;
812     u8 slave = driveid % 2;
813     printf("ata%d %s: Unknown device\n", channel, slave ? " slave" : "master");
814 }
815
816 static void
817 ata_detect()
818 {
819     // Device detection
820     int driveid;
821     for(driveid=0; driveid<CONFIG_MAX_ATA_DEVICES; driveid++) {
822         u8 channel = driveid / 2;
823         u8 slave = driveid % 2;
824
825         u16 iobase1 = GET_EBDA(ata.channels[channel].iobase1);
826         u16 iobase2 = GET_EBDA(ata.channels[channel].iobase2);
827
828         // Disable interrupts
829         outb(ATA_CB_DC_HD15 | ATA_CB_DC_NIEN, iobase2+ATA_CB_DC);
830
831         // Look for device
832         outb(slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
833         outb(0x55, iobase1+ATA_CB_SC);
834         outb(0xaa, iobase1+ATA_CB_SN);
835         outb(0xaa, iobase1+ATA_CB_SC);
836         outb(0x55, iobase1+ATA_CB_SN);
837         outb(0x55, iobase1+ATA_CB_SC);
838         outb(0xaa, iobase1+ATA_CB_SN);
839
840         // If we found something
841         u8 sc = inb(iobase1+ATA_CB_SC);
842         u8 sn = inb(iobase1+ATA_CB_SN);
843
844         if (sc != 0x55 || sn != 0xaa)
845             continue;
846
847         // reset the channel
848         ata_reset(driveid);
849
850         // check for ATA or ATAPI
851         outb(slave ? ATA_CB_DH_DEV1 : ATA_CB_DH_DEV0, iobase1+ATA_CB_DH);
852         sc = inb(iobase1+ATA_CB_SC);
853         sn = inb(iobase1+ATA_CB_SN);
854         if (sc!=0x01 || sn!=0x01) {
855             init_drive_unknown(driveid);
856             continue;
857         }
858         u8 cl = inb(iobase1+ATA_CB_CL);
859         u8 ch = inb(iobase1+ATA_CB_CH);
860         u8 st = inb(iobase1+ATA_CB_STAT);
861
862         if (cl==0x14 && ch==0xeb)
863             init_drive_atapi(driveid);
864         else if (cl==0x00 && ch==0x00 && st!=0x00)
865             init_drive_ata(driveid);
866         else if (cl==0xff && ch==0xff)
867             // None
868             continue;
869         else
870             init_drive_unknown(driveid);
871     }
872
873     printf("\n");
874 }
875
876 static void
877 ata_init()
878 {
879     // hdidmap and cdidmap init.
880     u8 device;
881     for (device=0; device < CONFIG_MAX_ATA_DEVICES; device++) {
882         SET_EBDA(ata.idmap[0][device], CONFIG_MAX_ATA_DEVICES);
883         SET_EBDA(ata.idmap[1][device], CONFIG_MAX_ATA_DEVICES);
884     }
885
886 #if CONFIG_MAX_ATA_INTERFACES > 0
887     SET_EBDA(ata.channels[0].iface, ATA_IFACE_ISA);
888     SET_EBDA(ata.channels[0].iobase1, 0x1f0);
889     SET_EBDA(ata.channels[0].iobase2, 0x3f0);
890     SET_EBDA(ata.channels[0].irq, 14);
891 #endif
892 #if CONFIG_MAX_ATA_INTERFACES > 1
893     SET_EBDA(ata.channels[1].iface, ATA_IFACE_ISA);
894     SET_EBDA(ata.channels[1].iobase1, 0x170);
895     SET_EBDA(ata.channels[1].iobase2, 0x370);
896     SET_EBDA(ata.channels[1].irq, 15);
897 #endif
898 #if CONFIG_MAX_ATA_INTERFACES > 2
899     SET_EBDA(ata.channels[2].iface, ATA_IFACE_ISA);
900     SET_EBDA(ata.channels[2].iobase1, 0x1e8);
901     SET_EBDA(ata.channels[2].iobase2, 0x3e0);
902     SET_EBDA(ata.channels[2].irq, 12);
903 #endif
904 #if CONFIG_MAX_ATA_INTERFACES > 3
905     SET_EBDA(ata.channels[3].iface, ATA_IFACE_ISA);
906     SET_EBDA(ata.channels[3].iobase1, 0x168);
907     SET_EBDA(ata.channels[3].iobase2, 0x360);
908     SET_EBDA(ata.channels[3].irq, 11);
909 #endif
910 #if CONFIG_MAX_ATA_INTERFACES > 4
911 #error Please fill the ATA interface informations
912 #endif
913 }
914
915 void
916 hard_drive_setup()
917 {
918     if (!CONFIG_ATA)
919         return;
920
921     ata_init();
922     ata_detect();
923
924     // Store the device count
925     SET_BDA(disk_count, GET_EBDA(ata.hdcount));
926
927     SET_BDA(disk_control_byte, 0xc0);
928 }