reactos/boot/freeldr/freeldr/arch/i386/pcdisk.c

   1 /*
   2  *  FreeLoader
   3  *  Copyright (C) 1998-2003  Brian Palmer  <brianp@sginet.com>
   4  *
   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.
   9  *
  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.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 #include "freeldr.h"
  21 #include "disk.h"
  22 #include "rtl.h"
  23 #include "arch.h"
  24 #include "debug.h"
  25 #include "portio.h"
  26 #include "machine.h"
  27 #include "machpc.h"
  28
  29
  30 typedef struct
  31 {
  32         U8              PacketSize;                             // 00h - Size of packet (10h or 18h)
  33         U8              Reserved;                               // 01h - Reserved (0)
  34         U16             LBABlockCount;                  // 02h - Number of blocks to transfer (max 007Fh for Phoenix EDD)
  35         U16             TransferBufferOffset;   // 04h - Transfer buffer offset (seg:off)
  36         U16             TransferBufferSegment;  //       Transfer buffer segment (seg:off)
  37         U64             LBAStartBlock;                  // 08h - Starting absolute block number
  38         U64             TransferBuffer64;               // 10h - (EDD-3.0, optional) 64-bit flat address of transfer buffer
  39                                                                         //       used if DWORD at 04h is FFFFh:FFFFh
  40 } PACKED I386_DISK_ADDRESS_PACKET, *PI386_DISK_ADDRESS_PACKET;
  41
  42 /////////////////////////////////////////////////////////////////////////////////////////////
  43 // FUNCTIONS
  44 /////////////////////////////////////////////////////////////////////////////////////////////
  45
  46 static BOOL PcDiskResetController(U32 DriveNumber)
  47 {
  48         REGS    RegsIn;
  49         REGS    RegsOut;
  50
  51         DbgPrint((DPRINT_DISK, "PcDiskResetController(0x%x) DISK OPERATION FAILED -- RESETTING CONTROLLER\n", DriveNumber));
  52
  53         // BIOS Int 13h, function 0 - Reset disk system
  54         // AH = 00h
  55         // DL = drive (if bit 7 is set both hard disks and floppy disks reset)
  56         // Return:
  57         // AH = status
  58         // CF clear if successful
  59         // CF set on error
  60         RegsIn.b.ah = 0x00;
  61         RegsIn.b.dl = DriveNumber;
  62
  63         // Reset the disk controller
  64         Int386(0x13, &RegsIn, &RegsOut);
  65
  66         return INT386_SUCCESS(RegsOut);
  67 }
  68
  69 static BOOL PcDiskReadLogicalSectorsLBA(U32 DriveNumber, U64 SectorNumber, U32 SectorCount, PVOID Buffer)
  70 {
  71         REGS                                            RegsIn;
  72         REGS                                            RegsOut;
  73         U32                                                     RetryCount;
  74         PI386_DISK_ADDRESS_PACKET       Packet = (PI386_DISK_ADDRESS_PACKET)(BIOSCALLBUFFER);
  75
  76         DbgPrint((DPRINT_DISK, "PcDiskReadLogicalSectorsLBA() DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d Buffer: 0x%x\n", DriveNumber, SectorNumber, SectorCount, Buffer));
  77
  78         // BIOS int 0x13, function 42h - IBM/MS INT 13 Extensions - EXTENDED READ
  79         RegsIn.b.ah = 0x42;                                     // Subfunction 42h
  80         RegsIn.b.dl = DriveNumber;                      // Drive number in DL (0 - floppy, 0x80 - harddisk)
  81         RegsIn.x.ds = BIOSCALLBUFSEGMENT;       // DS:SI -> disk address packet
  82         RegsIn.w.si = BIOSCALLBUFOFFSET;
  83
  84         // Setup disk address packet
  85         RtlZeroMemory(Packet, sizeof(I386_DISK_ADDRESS_PACKET));
  86         Packet->PacketSize = sizeof(I386_DISK_ADDRESS_PACKET);
  87         Packet->Reserved = 0;
  88         Packet->LBABlockCount = SectorCount;
  89         Packet->TransferBufferOffset = ((U32)Buffer) & 0x0F;
  90         Packet->TransferBufferSegment = ((U32)Buffer) >> 4;
  91         Packet->LBAStartBlock = SectorNumber;
  92         Packet->TransferBuffer64 = 0;
  93
  94         // BIOS int 0x13, function 42h - IBM/MS INT 13 Extensions - EXTENDED READ
  95         // Return:
  96         // CF clear if successful
  97         // AH = 00h
  98         // CF set on error
  99         // AH = error code
 100         // disk address packet's block count field set to the
 101         // number of blocks successfully transferred
 102
 103         // Retry 3 times
 104         for (RetryCount=0; RetryCount<3; RetryCount++)
 105         {
 106                 Int386(0x13, &RegsIn, &RegsOut);
 107
 108                 // If it worked return TRUE
 109                 if (INT386_SUCCESS(RegsOut))
 110                 {
 111                         return TRUE;
 112                 }
 113                 // If it was a corrected ECC error then the data is still good
 114                 else if (RegsOut.b.ah == 0x11)
 115                 {
 116                         return TRUE;
 117                 }
 118                 // If it failed the do the next retry
 119                 else
 120                 {
 121                         PcDiskResetController(DriveNumber);
 122
 123                         continue;
 124                 }
 125         }
 126
 127         // If we get here then the read failed
 128         DiskError("Disk Read Failed", RegsOut.b.ah);
 129
 130         return FALSE;
 131 }
 132
 133 static BOOL PcDiskReadLogicalSectorsCHS(U32 DriveNumber, U64 SectorNumber, U32 SectorCount, PVOID Buffer)
 134 {
 135         U32                     PhysicalSector;
 136         U32                     PhysicalHead;
 137         U32                     PhysicalTrack;
 138         GEOMETRY        DriveGeometry;
 139         U32                     NumberOfSectorsToRead;
 140         REGS            RegsIn;
 141         REGS            RegsOut;
 142         U32                     RetryCount;
 143
 144         DbgPrint((DPRINT_DISK, "PcDiskReadLogicalSectorsCHS()\n"));
 145
 146         //
 147         // Get the drive geometry
 148         //
 149         if (!MachDiskGetDriveGeometry(DriveNumber, &DriveGeometry))
 150         {
 151                 return FALSE;
 152         }
 153
 154         while (SectorCount)
 155         {
 156
 157                 //
 158                 // Calculate the physical disk offsets
 159                 //
 160                 PhysicalSector = 1 + (SectorNumber % DriveGeometry.Sectors);
 161                 PhysicalHead = (SectorNumber / DriveGeometry.Sectors) % DriveGeometry.Heads;
 162                 PhysicalTrack = (SectorNumber / DriveGeometry.Sectors) / DriveGeometry.Heads;
 163
 164                 //
 165                 // Calculate how many sectors we need to read this round
 166                 //
 167                 if (PhysicalSector > 1)
 168                 {
 169                         if (SectorCount >= (DriveGeometry.Sectors - (PhysicalSector - 1)))
 170                                 NumberOfSectorsToRead = (DriveGeometry.Sectors - (PhysicalSector - 1));
 171                         else
 172                                 NumberOfSectorsToRead = SectorCount;
 173                 }
 174                 else
 175                 {
 176                         if (SectorCount >= DriveGeometry.Sectors)
 177                                 NumberOfSectorsToRead = DriveGeometry.Sectors;
 178                         else
 179                                 NumberOfSectorsToRead = SectorCount;
 180                 }
 181
 182                 //
 183                 // Make sure the read is within the geometry boundaries
 184                 //
 185                 if ((PhysicalHead >= DriveGeometry.Heads) ||
 186                         (PhysicalTrack >= DriveGeometry.Cylinders) ||
 187                         ((NumberOfSectorsToRead + PhysicalSector) > (DriveGeometry.Sectors + 1)) ||
 188                         (PhysicalSector > DriveGeometry.Sectors))
 189                 {
 190                         DiskError("Disk read exceeds drive geometry limits.", 0);
 191                         return FALSE;
 192                 }
 193
 194                 // BIOS Int 13h, function 2 - Read Disk Sectors
 195                 // AH = 02h
 196                 // AL = number of sectors to read (must be nonzero)
 197                 // CH = low eight bits of cylinder number
 198                 // CL = sector number 1-63 (bits 0-5)
 199                 //      high two bits of cylinder (bits 6-7, hard disk only)
 200                 // DH = head number
 201                 // DL = drive number (bit 7 set for hard disk)
 202                 // ES:BX -> data buffer
 203                 // Return:
 204                 // CF set on error
 205                 // if AH = 11h (corrected ECC error), AL = burst length
 206                 // CF clear if successful
 207                 // AH = status
 208                 // AL = number of sectors transferred
 209                 //  (only valid if CF set for some BIOSes)
 210                 RegsIn.b.ah = 0x02;
 211                 RegsIn.b.al = NumberOfSectorsToRead;
 212                 RegsIn.b.ch = (PhysicalTrack & 0xFF);
 213                 RegsIn.b.cl = (PhysicalSector + ((PhysicalTrack & 0x300) >> 2));
 214                 RegsIn.b.dh = PhysicalHead;
 215                 RegsIn.b.dl = DriveNumber;
 216                 RegsIn.w.es = ((U32)Buffer) >> 4;
 217                 RegsIn.w.bx = ((U32)Buffer) & 0x0F;
 218
 219                 //
 220                 // Perform the read
 221                 // Retry 3 times
 222                 //
 223                 for (RetryCount=0; RetryCount<3; RetryCount++)
 224                 {
 225                         Int386(0x13, &RegsIn, &RegsOut);
 226
 227                         // If it worked break out
 228                         if (INT386_SUCCESS(RegsOut))
 229                         {
 230                                 break;
 231                         }
 232                         // If it was a corrected ECC error then the data is still good
 233                         else if (RegsOut.b.ah == 0x11)
 234                         {
 235                                 break;
 236                         }
 237                         // If it failed the do the next retry
 238                         else
 239                         {
 240                                 PcDiskResetController(DriveNumber);
 241
 242                                 continue;
 243                         }
 244                 }
 245
 246                 // If we retried 3 times then fail
 247                 if (RetryCount >= 3)
 248                 {
 249                         DiskError("Disk Read Failed", RegsOut.b.ah);
 250                         return FALSE;
 251                 }
 252
 253                 // I have learned that not all bioses return
 254                 // the sector read count in the AL register (at least mine doesn't)
 255                 // even if the sectors were read correctly. So instead
 256                 // of checking the sector read count we will rely solely
 257                 // on the carry flag being set on error
 258
 259                 Buffer += (NumberOfSectorsToRead * DriveGeometry.BytesPerSector);
 260                 SectorCount -= NumberOfSectorsToRead;
 261                 SectorNumber += NumberOfSectorsToRead;
 262         }
 263
 264         return TRUE;
 265 }
 266
 267 static BOOL PcDiskInt13ExtensionsSupported(U32 DriveNumber)
 268 {
 269         static U32      LastDriveNumber = 0xffffffff;
 270         static BOOL     LastSupported;
 271         REGS    RegsIn;
 272         REGS    RegsOut;
 273
 274         DbgPrint((DPRINT_DISK, "PcDiskInt13ExtensionsSupported()\n"));
 275
 276         if (DriveNumber == LastDriveNumber)
 277         {
 278                 DbgPrint((DPRINT_DISK, "Using cached value %s for drive 0x%x\n", LastSupported ? "TRUE" : "FALSE", DriveNumber));
 279                 return LastSupported;
 280         }
 281
 282         LastDriveNumber = DriveNumber;
 283
 284         // IBM/MS INT 13 Extensions - INSTALLATION CHECK
 285         // AH = 41h
 286         // BX = 55AAh
 287         // DL = drive (80h-FFh)
 288         // Return:
 289         // CF set on error (extensions not supported)
 290         // AH = 01h (invalid function)
 291         // CF clear if successful
 292         // BX = AA55h if installed
 293         // AH = major version of extensions
 294         // 01h = 1.x
 295         // 20h = 2.0 / EDD-1.0
 296         // 21h = 2.1 / EDD-1.1
 297         // 30h = EDD-3.0
 298         // AL = internal use
 299         // CX = API subset support bitmap
 300         // DH = extension version (v2.0+ ??? -- not present in 1.x)
 301         //
 302         // Bitfields for IBM/MS INT 13 Extensions API support bitmap
 303         // Bit 0, extended disk access functions (AH=42h-44h,47h,48h) supported
 304         // Bit 1, removable drive controller functions (AH=45h,46h,48h,49h,INT 15/AH=52h) supported
 305         // Bit 2, enhanced disk drive (EDD) functions (AH=48h,AH=4Eh) supported
 306         //        extended drive parameter table is valid
 307         // Bits 3-15 reserved
 308         RegsIn.b.ah = 0x41;
 309         RegsIn.w.bx = 0x55AA;
 310         RegsIn.b.dl = DriveNumber;
 311
 312         // Reset the disk controller
 313         Int386(0x13, &RegsIn, &RegsOut);
 314
 315         if (!INT386_SUCCESS(RegsOut))
 316         {
 317                 // CF set on error (extensions not supported)
 318                 LastSupported = FALSE;
 319                 return FALSE;
 320         }
 321
 322         if (RegsOut.w.bx != 0xAA55)
 323         {
 324                 // BX = AA55h if installed
 325                 LastSupported = FALSE;
 326                 return FALSE;
 327         }
 328
 329         // Note:
 330         // The original check is too strict because some BIOSes report that
 331         // extended disk access functions are not suported when booting
 332         // from a CD (e.g. Phoenix BIOS v6.00PG). Argh!
 333 #if 0
 334         if (!(RegsOut.w.cx & 0x0001))
 335         {
 336                 // CX = API subset support bitmap
 337                 // Bit 0, extended disk access functions (AH=42h-44h,47h,48h) supported
 338                 LastSupported = FALSE;
 339                 return FALSE;
 340         }
 341 #endif
 342
 343         // Use this relaxed check instead (most BIOSes seem to use 0x9f as CD-Rom)
 344         if (RegsOut.w.cx == 0x0000 && DriveNumber != 0x9f)
 345         {
 346                 // CX = API subset support bitmap
 347                 printf("Suspicious API subset support bitmap 0x%x on device 0x%x\n", RegsOut.w.cx, DriveNumber);
 348                 LastSupported = FALSE;
 349                 return LastSupported;
 350         }
 351
 352         LastSupported = TRUE;
 353         return TRUE;
 354 }
 355
 356 BOOL PcDiskReadLogicalSectors(U32 DriveNumber, U64 SectorNumber, U32 SectorCount, PVOID Buffer)
 357 {
 358
 359         DbgPrint((DPRINT_DISK, "PcDiskReadLogicalSectors() DriveNumber: 0x%x SectorNumber: %I64d SectorCount: %d Buffer: 0x%x\n", DriveNumber, SectorNumber, SectorCount, Buffer));
 360
 361         //
 362         // Check to see if it is a fixed disk drive
 363         // If so then check to see if Int13 extensions work
 364         // If they do then use them, otherwise default back to BIOS calls
 365         //
 366         if ((DriveNumber >= 0x80) && PcDiskInt13ExtensionsSupported(DriveNumber))
 367         {
 368                 DbgPrint((DPRINT_DISK, "Using Int 13 Extensions for read. PcDiskInt13ExtensionsSupported(%d) = %s\n", DriveNumber, PcDiskInt13ExtensionsSupported(DriveNumber) ? "TRUE" : "FALSE"));
 369
 370                 //
 371                 // LBA is easy, nothing to calculate
 372                 // Just do the read
 373                 //
 374                 return PcDiskReadLogicalSectorsLBA(DriveNumber, SectorNumber, SectorCount, Buffer);
 375         }
 376         else
 377         {
 378                 // LBA is not supported default to the CHS calls
 379                 return PcDiskReadLogicalSectorsCHS(DriveNumber, SectorNumber, SectorCount, Buffer);
 380         }
 381
 382         return TRUE;
 383 }
 384
 385 BOOL
 386 PcDiskGetPartitionEntry(U32 DriveNumber, U32 PartitionNumber, PPARTITION_TABLE_ENTRY PartitionTableEntry)
 387 {
 388   /* Just use the standard routine */
 389   return DiskGetPartitionEntry(DriveNumber, PartitionNumber, PartitionTableEntry);
 390 }
 391
 392 BOOL
 393 PcDiskGetDriveGeometry(U32 DriveNumber, PGEOMETRY Geometry)
 394 {
 395   REGS RegsIn;
 396   REGS RegsOut;
 397   U32 Cylinders;
 398
 399   DbgPrint((DPRINT_DISK, "DiskGetDriveGeometry()\n"));
 400
 401   /* BIOS Int 13h, function 08h - Get drive parameters
 402    * AH = 08h
 403    * DL = drive (bit 7 set for hard disk)
 404    * ES:DI = 0000h:0000h to guard against BIOS bugs
 405    * Return:
 406    * CF set on error
 407    * AH = status (07h)
 408    * CF clear if successful
 409    * AH = 00h
 410    * AL = 00h on at least some BIOSes
 411    * BL = drive type (AT/PS2 floppies only)
 412    * CH = low eight bits of maximum cylinder number
 413    * CL = maximum sector number (bits 5-0)
 414    *      high two bits of maximum cylinder number (bits 7-6)
 415    * DH = maximum head number
 416    * DL = number of drives
 417    * ES:DI -> drive parameter table (floppies only)
 418    */
 419   RegsIn.b.ah = 0x08;
 420   RegsIn.b.dl = DriveNumber;
 421   RegsIn.w.es = 0x0000;
 422   RegsIn.w.di = 0x0000;
 423
 424   /* Get drive parameters */
 425   Int386(0x13, &RegsIn, &RegsOut);
 426
 427   if (! INT386_SUCCESS(RegsOut))
 428     {
 429       return FALSE;
 430     }
 431
 432   Cylinders = (RegsOut.b.cl & 0xC0) << 2;
 433   Cylinders += RegsOut.b.ch;
 434   Cylinders++;
 435   Geometry->Cylinders = Cylinders;
 436   Geometry->Heads = RegsOut.b.dh + 1;
 437   Geometry->Sectors = RegsOut.b.cl & 0x3F;
 438   Geometry->BytesPerSector = 512;            /* Just assume 512 bytes per sector */
 439
 440   return TRUE;
 441 }
 442
 443 U32
 444 PcDiskGetCacheableBlockCount(U32 DriveNumber)
 445 {
 446   GEOMETRY      Geometry;
 447
 448   /* If LBA is supported then the block size will be 64 sectors (32k)
 449    * If not then the block size is the size of one track */
 450   if (DiskInt13ExtensionsSupported(DriveNumber))
 451     {
 452       return 64;
 453     }
 454   /* Get the disk geometry
 455    * If this fails then we will just return 1 sector to be safe */
 456   else if (! PcDiskGetDriveGeometry(DriveNumber, &Geometry))
 457     {
 458       return 1;
 459     }
 460   else
 461     {
 462       return Geometry.Sectors;
 463     }
 464 }
 465
 466 /* EOF */