3 * Copyright (C) 1998-2003 Brian Palmer <brianp@sginet.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 // #if defined(__i386__) || defined(_M_AMD64)
25 DBG_DEFAULT_CHANNEL(DISK
);
31 UCHAR PacketSize
; // 00h - Size of packet (10h or 18h)
32 UCHAR Reserved
; // 01h - Reserved (0)
33 USHORT LBABlockCount
; // 02h - Number of blocks to transfer (max 007Fh for Phoenix EDD)
34 USHORT TransferBufferOffset
; // 04h - Transfer buffer offset (seg:off)
35 USHORT TransferBufferSegment
; // Transfer buffer segment (seg:off)
36 ULONGLONG LBAStartBlock
; // 08h - Starting absolute block number
37 // ULONGLONG TransferBuffer64; // 10h - (EDD-3.0, optional) 64-bit flat address of transfer buffer
38 // used if DWORD at 04h is FFFFh:FFFFh
39 // Commented since some earlier BIOSes refuse to work with
40 // such extended structure
41 } I386_DISK_ADDRESS_PACKET
, *PI386_DISK_ADDRESS_PACKET
;
45 UCHAR PacketSize
; // 00h - Size of packet in bytes (13h)
46 UCHAR MediaType
; // 01h - Boot media type (see #00282)
47 UCHAR DriveNumber
; /* 02h - Drive number:
49 * 80h Bootable hard disk
50 * 81h-FFh Nonbootable or no emulation
52 UCHAR Controller
; // 03h - CD-ROM controller number
53 ULONG LBAImage
; // 04h - Logical Block Address of disk image to emulate
54 USHORT DeviceSpec
; /* 08h - Device specification (see also #00282)
56 * Drive is slave instead of master
62 USHORT Buffer
; // 0Ah - Segment of 3K buffer for caching CD-ROM reads
63 USHORT LoadSeg
; // 0Ch - Load segment for initial boot image.
64 // If 0000h, load at segment 07C0h.
65 USHORT SectorCount
; // 0Eh - Number of 512-byte virtual sectors to load
66 // (only valid for AH=4Ch).
67 UCHAR CHSGeometry
[3]; /* 10h - Low byte of cylinder count (for INT 13/AH=08h)
68 * 11h - Sector count, high bits of cylinder count (for INT 13/AH=08h)
69 * 12h - Head count (for INT 13/AH=08h)
72 } I386_CDROM_SPEC_PACKET
, *PI386_CDROM_SPEC_PACKET
;
76 /* DISK IO ERROR SUPPORT *****************************************************/
78 static BOOLEAN bReportError
= TRUE
;
80 VOID
DiskReportError(BOOLEAN bError
)
82 bReportError
= bError
;
85 static PCSTR
DiskGetErrorCodeString(ULONG ErrorCode
)
89 case 0x00: return "no error";
90 case 0x01: return "bad command passed to driver";
91 case 0x02: return "address mark not found or bad sector";
92 case 0x03: return "diskette write protect error";
93 case 0x04: return "sector not found";
94 case 0x05: return "fixed disk reset failed";
95 case 0x06: return "diskette changed or removed";
96 case 0x07: return "bad fixed disk parameter table";
97 case 0x08: return "DMA overrun";
98 case 0x09: return "DMA access across 64k boundary";
99 case 0x0A: return "bad fixed disk sector flag";
100 case 0x0B: return "bad fixed disk cylinder";
101 case 0x0C: return "unsupported track/invalid media";
102 case 0x0D: return "invalid number of sectors on fixed disk format";
103 case 0x0E: return "fixed disk controlled data address mark detected";
104 case 0x0F: return "fixed disk DMA arbitration level out of range";
105 case 0x10: return "ECC/CRC error on disk read";
106 case 0x11: return "recoverable fixed disk data error, data fixed by ECC";
107 case 0x20: return "controller error (NEC for floppies)";
108 case 0x40: return "seek failure";
109 case 0x80: return "time out, drive not ready";
110 case 0xAA: return "fixed disk drive not ready";
111 case 0xBB: return "fixed disk undefined error";
112 case 0xCC: return "fixed disk write fault on selected drive";
113 case 0xE0: return "fixed disk status error/Error reg = 0";
114 case 0xFF: return "sense operation failed";
116 default: return "unknown error code";
120 static VOID
DiskError(PCSTR ErrorString
, ULONG ErrorCode
)
122 CHAR ErrorCodeString
[200];
124 if (bReportError
== FALSE
)
127 sprintf(ErrorCodeString
, "%s\n\nError Code: 0x%lx\nError: %s",
128 ErrorString
, ErrorCode
, DiskGetErrorCodeString(ErrorCode
));
130 TRACE("%s\n", ErrorCodeString
);
132 UiMessageBox(ErrorCodeString
);
135 /* FUNCTIONS *****************************************************************/
137 BOOLEAN
DiskResetController(UCHAR DriveNumber
)
139 REGS RegsIn
, RegsOut
;
141 WARN("DiskResetController(0x%x) DISK OPERATION FAILED -- RESETTING CONTROLLER\n", DriveNumber
);
144 * BIOS Int 13h, function 0 - Reset disk system
146 * DL = drive (if bit 7 is set both hard disks and floppy disks reset)
149 * CF clear if successful
153 RegsIn
.b
.dl
= DriveNumber
;
155 /* Reset the disk controller */
156 Int386(0x13, &RegsIn
, &RegsOut
);
158 return INT386_SUCCESS(RegsOut
);
161 static BOOLEAN
PcDiskReadLogicalSectorsLBA(UCHAR DriveNumber
, ULONGLONG SectorNumber
, ULONG SectorCount
, PVOID Buffer
)
163 REGS RegsIn
, RegsOut
;
165 PI386_DISK_ADDRESS_PACKET Packet
= (PI386_DISK_ADDRESS_PACKET
)(BIOSCALLBUFFER
);
167 TRACE("PcDiskReadLogicalSectorsLBA() DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d Buffer: 0x%x\n", DriveNumber
, SectorNumber
, SectorCount
, Buffer
);
168 ASSERT(((ULONG_PTR
)Buffer
) <= 0xFFFFF);
170 /* Setup disk address packet */
171 RtlZeroMemory(Packet
, sizeof(*Packet
));
172 Packet
->PacketSize
= sizeof(*Packet
);
173 Packet
->Reserved
= 0;
174 Packet
->LBABlockCount
= (USHORT
)SectorCount
;
175 ASSERT(Packet
->LBABlockCount
== SectorCount
);
176 Packet
->TransferBufferOffset
= ((ULONG_PTR
)Buffer
) & 0x0F;
177 Packet
->TransferBufferSegment
= (USHORT
)(((ULONG_PTR
)Buffer
) >> 4);
178 Packet
->LBAStartBlock
= SectorNumber
;
181 * BIOS int 0x13, function 42h - IBM/MS INT 13 Extensions - EXTENDED READ
183 * CF clear if successful
187 * Disk address packet's block count field set to the
188 * number of blocks successfully transferred.
190 RegsIn
.b
.ah
= 0x42; // Subfunction 42h
191 RegsIn
.b
.dl
= DriveNumber
; // Drive number in DL (0 - floppy, 0x80 - harddisk)
192 RegsIn
.x
.ds
= BIOSCALLBUFSEGMENT
; // DS:SI -> disk address packet
193 RegsIn
.w
.si
= BIOSCALLBUFOFFSET
;
196 for (RetryCount
=0; RetryCount
<3; RetryCount
++)
198 Int386(0x13, &RegsIn
, &RegsOut
);
200 /* If it worked return TRUE */
201 if (INT386_SUCCESS(RegsOut
))
205 /* If it was a corrected ECC error then the data is still good */
206 else if (RegsOut
.b
.ah
== 0x11)
210 /* If it failed then do the next retry */
213 DiskResetController(DriveNumber
);
218 /* If we get here then the read failed */
219 DiskError("Disk Read Failed in LBA mode", RegsOut
.b
.ah
);
220 ERR("Disk Read Failed in LBA mode: %x (%s) (DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d)\n",
221 RegsOut
.b
.ah
, DiskGetErrorCodeString(RegsOut
.b
.ah
),
222 DriveNumber
, SectorNumber
, SectorCount
);
227 static BOOLEAN
PcDiskReadLogicalSectorsCHS(UCHAR DriveNumber
, ULONGLONG SectorNumber
, ULONG SectorCount
, PVOID Buffer
)
229 UCHAR PhysicalSector
;
232 GEOMETRY DriveGeometry
;
233 ULONG NumberOfSectorsToRead
;
234 REGS RegsIn
, RegsOut
;
237 TRACE("PcDiskReadLogicalSectorsCHS()\n");
239 /* Get the drive geometry */
240 if (!MachDiskGetDriveGeometry(DriveNumber
, &DriveGeometry
) ||
241 DriveGeometry
.Sectors
== 0 ||
242 DriveGeometry
.Heads
== 0)
250 * Calculate the physical disk offsets.
251 * Note: DriveGeometry.Sectors < 64
253 PhysicalSector
= 1 + (UCHAR
)(SectorNumber
% DriveGeometry
.Sectors
);
254 PhysicalHead
= (UCHAR
)((SectorNumber
/ DriveGeometry
.Sectors
) % DriveGeometry
.Heads
);
255 PhysicalTrack
= (ULONG
)((SectorNumber
/ DriveGeometry
.Sectors
) / DriveGeometry
.Heads
);
257 /* Calculate how many sectors we need to read this round */
258 if (PhysicalSector
> 1)
260 if (SectorCount
>= (DriveGeometry
.Sectors
- (PhysicalSector
- 1)))
261 NumberOfSectorsToRead
= (DriveGeometry
.Sectors
- (PhysicalSector
- 1));
263 NumberOfSectorsToRead
= SectorCount
;
267 if (SectorCount
>= DriveGeometry
.Sectors
)
268 NumberOfSectorsToRead
= DriveGeometry
.Sectors
;
270 NumberOfSectorsToRead
= SectorCount
;
273 /* Make sure the read is within the geometry boundaries */
274 if ((PhysicalHead
>= DriveGeometry
.Heads
) ||
275 (PhysicalTrack
>= DriveGeometry
.Cylinders
) ||
276 ((NumberOfSectorsToRead
+ PhysicalSector
) > (DriveGeometry
.Sectors
+ 1)) ||
277 (PhysicalSector
> DriveGeometry
.Sectors
))
279 DiskError("Disk read exceeds drive geometry limits.", 0);
284 * BIOS Int 13h, function 2 - Read Disk Sectors
286 * AL = number of sectors to read (must be nonzero)
287 * CH = low eight bits of cylinder number
288 * CL = sector number 1-63 (bits 0-5)
289 * high two bits of cylinder (bits 6-7, hard disk only)
291 * DL = drive number (bit 7 set for hard disk)
292 * ES:BX -> data buffer
295 * if AH = 11h (corrected ECC error), AL = burst length
296 * CF clear if successful
298 * AL = number of sectors transferred
299 * (only valid if CF set for some BIOSes)
302 RegsIn
.b
.al
= (UCHAR
)NumberOfSectorsToRead
;
303 RegsIn
.b
.ch
= (PhysicalTrack
& 0xFF);
304 RegsIn
.b
.cl
= (UCHAR
)(PhysicalSector
+ ((PhysicalTrack
& 0x300) >> 2));
305 RegsIn
.b
.dh
= PhysicalHead
;
306 RegsIn
.b
.dl
= DriveNumber
;
307 RegsIn
.w
.es
= (USHORT
)(((ULONG_PTR
)Buffer
) >> 4);
308 RegsIn
.w
.bx
= ((ULONG_PTR
)Buffer
) & 0x0F;
310 /* Perform the read. Retry 3 times. */
311 for (RetryCount
=0; RetryCount
<3; RetryCount
++)
313 Int386(0x13, &RegsIn
, &RegsOut
);
315 /* If it worked break out */
316 if (INT386_SUCCESS(RegsOut
))
320 /* If it was a corrected ECC error then the data is still good */
321 else if (RegsOut
.b
.ah
== 0x11)
325 /* If it failed the do the next retry */
328 DiskResetController(DriveNumber
);
333 /* If we retried 3 times then fail */
336 DiskError("Disk Read Failed in CHS mode, after retrying 3 times", RegsOut
.b
.ah
);
337 ERR("Disk Read Failed in CHS mode, after retrying 3 times: %x (%s) (DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d)\n",
338 RegsOut
.b
.ah
, DiskGetErrorCodeString(RegsOut
.b
.ah
),
339 DriveNumber
, SectorNumber
, SectorCount
);
343 // I have learned that not all BIOSes return
344 // the sector read count in the AL register (at least mine doesn't)
345 // even if the sectors were read correctly. So instead
346 // of checking the sector read count we will rely solely
347 // on the carry flag being set on error
349 Buffer
= (PVOID
)((ULONG_PTR
)Buffer
+ (NumberOfSectorsToRead
* DriveGeometry
.BytesPerSector
));
350 SectorCount
-= NumberOfSectorsToRead
;
351 SectorNumber
+= NumberOfSectorsToRead
;
357 static BOOLEAN
DiskInt13ExtensionsSupported(UCHAR DriveNumber
)
359 static UCHAR LastDriveNumber
= 0xff;
360 static BOOLEAN LastSupported
;
361 REGS RegsIn
, RegsOut
;
363 TRACE("DiskInt13ExtensionsSupported()\n");
365 if (DriveNumber
== LastDriveNumber
)
367 TRACE("Using cached value %s for drive 0x%x\n",
368 LastSupported
? "TRUE" : "FALSE", DriveNumber
);
369 return LastSupported
;
373 * Some BIOSes report that extended disk access functions are not supported
374 * when booting from a CD (e.g. Phoenix BIOS v6.00PG and Insyde BIOS shipping
375 * with Intel Macs). Therefore we just return TRUE if we're booting from a CD -
376 * we can assume that all El Torito capable BIOSes support INT 13 extensions.
377 * We simply detect whether we're booting from CD by checking whether the drive
378 * number is >= 0x8A. It's 0x90 on the Insyde BIOS, and 0x9F on most other BIOSes.
380 if (DriveNumber
>= 0x8A)
382 LastSupported
= TRUE
;
386 LastDriveNumber
= DriveNumber
;
389 * IBM/MS INT 13 Extensions - INSTALLATION CHECK
392 * DL = drive (80h-FFh)
394 * CF set on error (extensions not supported)
395 * AH = 01h (invalid function)
396 * CF clear if successful
397 * BX = AA55h if installed
398 * AH = major version of extensions
400 * 20h = 2.0 / EDD-1.0
401 * 21h = 2.1 / EDD-1.1
404 * CX = API subset support bitmap
405 * DH = extension version (v2.0+ ??? -- not present in 1.x)
407 * Bitfields for IBM/MS INT 13 Extensions API support bitmap
408 * Bit 0, extended disk access functions (AH=42h-44h,47h,48h) supported
409 * Bit 1, removable drive controller functions (AH=45h,46h,48h,49h,INT 15/AH=52h) supported
410 * Bit 2, enhanced disk drive (EDD) functions (AH=48h,AH=4Eh) supported
411 * extended drive parameter table is valid
415 RegsIn
.w
.bx
= 0x55AA;
416 RegsIn
.b
.dl
= DriveNumber
;
418 /* Reset the disk controller */
419 Int386(0x13, &RegsIn
, &RegsOut
);
421 if (!INT386_SUCCESS(RegsOut
))
423 /* CF set on error (extensions not supported) */
424 LastSupported
= FALSE
;
428 if (RegsOut
.w
.bx
!= 0xAA55)
430 /* BX = AA55h if installed */
431 LastSupported
= FALSE
;
435 if (!(RegsOut
.w
.cx
& 0x0001))
438 * CX = API subset support bitmap.
439 * Bit 0, extended disk access functions (AH=42h-44h,47h,48h) supported.
441 DbgPrint("Suspicious API subset support bitmap 0x%x on device 0x%lx\n",
442 RegsOut
.w
.cx
, DriveNumber
);
443 LastSupported
= FALSE
;
447 LastSupported
= TRUE
;
451 BOOLEAN
PcDiskReadLogicalSectors(UCHAR DriveNumber
, ULONGLONG SectorNumber
, ULONG SectorCount
, PVOID Buffer
)
453 BOOLEAN ExtensionsSupported
;
455 TRACE("PcDiskReadLogicalSectors() DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d Buffer: 0x%x\n",
456 DriveNumber
, SectorNumber
, SectorCount
, Buffer
);
459 * Check to see if it is a fixed disk drive.
460 * If so then check to see if Int13 extensions work.
461 * If they do then use them, otherwise default back to BIOS calls.
463 ExtensionsSupported
= DiskInt13ExtensionsSupported(DriveNumber
);
465 if ((DriveNumber
>= 0x80) && ExtensionsSupported
)
467 TRACE("Using Int 13 Extensions for read. DiskInt13ExtensionsSupported(%d) = %s\n", DriveNumber
, ExtensionsSupported
? "TRUE" : "FALSE");
469 /* LBA is easy, nothing to calculate. Just do the read. */
470 return PcDiskReadLogicalSectorsLBA(DriveNumber
, SectorNumber
, SectorCount
, Buffer
);
474 /* LBA is not supported default to the CHS calls */
475 return PcDiskReadLogicalSectorsCHS(DriveNumber
, SectorNumber
, SectorCount
, Buffer
);
481 VOID
DiskStopFloppyMotor(VOID
)
483 WRITE_PORT_UCHAR((PUCHAR
)0x3F2, 0);
486 BOOLEAN
DiskGetExtendedDriveParameters(UCHAR DriveNumber
, PVOID Buffer
, USHORT BufferSize
)
488 REGS RegsIn
, RegsOut
;
489 PUSHORT Ptr
= (PUSHORT
)(BIOSCALLBUFFER
);
491 TRACE("DiskGetExtendedDriveParameters()\n");
493 if (!DiskInt13ExtensionsSupported(DriveNumber
))
496 /* Initialize transfer buffer */
500 * BIOS Int 13h, function 48h - Get drive parameters
502 * DL = drive (bit 7 set for hard disk)
503 * DS:SI = result buffer
507 * CF clear if successful
509 * DS:SI -> result buffer
512 RegsIn
.b
.dl
= DriveNumber
;
513 RegsIn
.x
.ds
= BIOSCALLBUFSEGMENT
; // DS:SI -> result buffer
514 RegsIn
.w
.si
= BIOSCALLBUFOFFSET
;
516 /* Get drive parameters */
517 Int386(0x13, &RegsIn
, &RegsOut
);
518 if (!INT386_SUCCESS(RegsOut
))
521 memcpy(Buffer
, Ptr
, BufferSize
);
524 TRACE("size of buffer: %x\n", Ptr
[0]);
525 TRACE("information flags: %x\n", Ptr
[1]);
526 TRACE("number of physical cylinders on drive: %u\n", *(PULONG
)&Ptr
[2]);
527 TRACE("number of physical heads on drive: %u\n", *(PULONG
)&Ptr
[4]);
528 TRACE("number of physical sectors per track: %u\n", *(PULONG
)&Ptr
[6]);
529 TRACE("total number of sectors on drive: %I64u\n", *(unsigned long long*)&Ptr
[8]);
530 TRACE("bytes per sector: %u\n", Ptr
[12]);
533 TRACE("EED configuration parameters: %x:%x\n", Ptr
[13], Ptr
[14]);
534 if (Ptr
[13] != 0xffff && Ptr
[14] != 0xffff)
536 PUCHAR SpecPtr
= (PUCHAR
)(ULONG_PTR
)((Ptr
[13] << 4) + Ptr
[14]);
537 TRACE("SpecPtr: %x\n", SpecPtr
);
538 TRACE("physical I/O port base address: %x\n", *(PUSHORT
)&SpecPtr
[0]);
539 TRACE("disk-drive control port address: %x\n", *(PUSHORT
)&SpecPtr
[2]);
540 TRACE("drive flags: %x\n", SpecPtr
[4]);
541 TRACE("proprietary information: %x\n", SpecPtr
[5]);
542 TRACE("IRQ for drive: %u\n", SpecPtr
[6]);
543 TRACE("sector count for multi-sector transfers: %u\n", SpecPtr
[7]);
544 TRACE("DMA control: %x\n", SpecPtr
[8]);
545 TRACE("programmed I/O control: %x\n", SpecPtr
[9]);
546 TRACE("drive options: %x\n", *(PUSHORT
)&SpecPtr
[10]);
551 TRACE("signature: %x\n", Ptr
[15]);
559 PcDiskGetDriveGeometry(UCHAR DriveNumber
, PGEOMETRY Geometry
)
561 EXTENDED_GEOMETRY ExtGeometry
;
562 REGS RegsIn
, RegsOut
;
565 TRACE("DiskGetDriveGeometry()\n");
567 /* Try to get the extended geometry first */
568 ExtGeometry
.Size
= sizeof(ExtGeometry
);
569 if (DiskGetExtendedDriveParameters(DriveNumber
, &ExtGeometry
, ExtGeometry
.Size
))
571 Geometry
->Cylinders
= ExtGeometry
.Cylinders
;
572 Geometry
->Heads
= ExtGeometry
.Heads
;
573 Geometry
->Sectors
= ExtGeometry
.SectorsPerTrack
;
574 Geometry
->BytesPerSector
= ExtGeometry
.BytesPerSector
;
579 * BIOS Int 13h, function 08h - Get drive parameters
581 * DL = drive (bit 7 set for hard disk)
582 * ES:DI = 0000h:0000h to guard against BIOS bugs
586 * CF clear if successful
588 * AL = 00h on at least some BIOSes
589 * BL = drive type (AT/PS2 floppies only)
590 * CH = low eight bits of maximum cylinder number
591 * CL = maximum sector number (bits 5-0)
592 * high two bits of maximum cylinder number (bits 7-6)
593 * DH = maximum head number
594 * DL = number of drives
595 * ES:DI -> drive parameter table (floppies only)
598 RegsIn
.b
.dl
= DriveNumber
;
599 RegsIn
.w
.es
= 0x0000;
600 RegsIn
.w
.di
= 0x0000;
602 /* Get drive parameters */
603 Int386(0x13, &RegsIn
, &RegsOut
);
604 if (!INT386_SUCCESS(RegsOut
))
607 Cylinders
= (RegsOut
.b
.cl
& 0xC0) << 2;
608 Cylinders
+= RegsOut
.b
.ch
;
610 Geometry
->Cylinders
= Cylinders
;
611 Geometry
->Heads
= RegsOut
.b
.dh
+ 1;
612 Geometry
->Sectors
= RegsOut
.b
.cl
& 0x3F;
613 Geometry
->BytesPerSector
= 512; /* Just assume 512 bytes per sector */
619 PcDiskGetCacheableBlockCount(UCHAR DriveNumber
)
623 /* If LBA is supported then the block size will be 64 sectors (32k)
624 * If not then the block size is the size of one track. */
625 if (DiskInt13ExtensionsSupported(DriveNumber
))
629 /* Get the disk geometry. If this fails then we will
630 * just return 1 sector to be safe. */
631 else if (!PcDiskGetDriveGeometry(DriveNumber
, &Geometry
))
637 return Geometry
.Sectors
;