| 79964ac8 |
1 | /** @file\r |
| 2 | The EFI Legacy BIOS Protocol is used to abstract legacy Option ROM usage\r |
| 87d63447 |
3 | under EFI and Legacy OS boot. This file also includes all the related\r |
| 4 | COMPATIBILIY16 structures and defintions.\r |
| 79964ac8 |
5 | \r |
| 6 | Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow\r |
| 7 | well known naming conventions.\r |
| 8 | \r |
| 5259c97d |
9 | Thunk is the code that switches from 32-bit protected environment into the 16-bit real-mode\r |
| 10 | environment. Reverse thunk is the code that does the opposite.\r |
| 79964ac8 |
11 | \r |
| 2b3687db |
12 | Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r |
| f22f941e |
13 | This program and the accompanying materials are licensed and made available under \r |
| 14 | the terms and conditions of the BSD License that accompanies this distribution. \r |
| 15 | The full text of the license may be found at\r |
| 16 | http://opensource.org/licenses/bsd-license.php. \r |
| 17 | \r |
| 18 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 19 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
| 79964ac8 |
20 | \r |
| 79964ac8 |
21 | @par Revision Reference:\r |
| 22 | This protocol is defined in Framework for EFI Compatibility Support Module spec\r |
| 0f899407 |
23 | Version 0.97.\r |
| 79964ac8 |
24 | \r |
| 25 | **/\r |
| 26 | \r |
| 27 | #ifndef _EFI_LEGACY_BIOS_H_\r |
| 28 | #define _EFI_LEGACY_BIOS_H_\r |
| 29 | \r |
| 87d63447 |
30 | ///\r |
| 31 | /// \r |
| 32 | ///\r |
| 33 | #pragma pack(1)\r |
| 34 | \r |
| 35 | typedef UINT8 SERIAL_MODE;\r |
| 36 | typedef UINT8 PARALLEL_MODE;\r |
| 37 | \r |
| 38 | #define EFI_COMPATIBILITY16_TABLE_SIGNATURE SIGNATURE_32 ('I', 'F', 'E', '$')\r |
| 39 | \r |
| 40 | ///\r |
| 41 | /// There is a table located within the traditional BIOS in either the 0xF000:xxxx or 0xE000:xxxx\r |
| 42 | /// physical address range. It is located on a 16-byte boundary and provides the physical address of the\r |
| 43 | /// entry point for the Compatibility16 functions. These functions provide the platform-specific\r |
| 44 | /// information that is required by the generic EfiCompatibility code. The functions are invoked via\r |
| 45 | /// thunking by using EFI_LEGACY_BIOS_PROTOCOL.FarCall86() with the 32-bit physical\r |
| 46 | /// entry point.\r |
| 47 | ///\r |
| 48 | typedef struct {\r |
| 49 | ///\r |
| 50 | /// The string "$EFI" denotes the start of the EfiCompatibility table. Byte 0 is "I," byte\r |
| 51 | /// 1 is "F," byte 2 is "E," and byte 3 is "$" and is normally accessed as a DWORD or UINT32.\r |
| 52 | ///\r |
| 53 | UINT32 Signature;\r |
| 54 | \r |
| 55 | ///\r |
| 56 | /// The value required such that byte checksum of TableLength equals zero.\r |
| 57 | ///\r |
| 58 | UINT8 TableChecksum;\r |
| 59 | \r |
| 60 | ///\r |
| 61 | /// The length of this table.\r |
| 62 | ///\r |
| 63 | UINT8 TableLength;\r |
| 64 | \r |
| 65 | ///\r |
| 66 | /// The major EFI revision for which this table was generated.\r |
| 67 | /// \r |
| 68 | UINT8 EfiMajorRevision;\r |
| 69 | \r |
| 70 | ///\r |
| 71 | /// The minor EFI revision for which this table was generated.\r |
| 72 | ///\r |
| 73 | UINT8 EfiMinorRevision;\r |
| 74 | \r |
| 75 | ///\r |
| 76 | /// The major revision of this table.\r |
| 77 | ///\r |
| 78 | UINT8 TableMajorRevision;\r |
| 79 | \r |
| 80 | ///\r |
| 81 | /// The minor revision of this table.\r |
| 82 | ///\r |
| 83 | UINT8 TableMinorRevision;\r |
| 84 | \r |
| 85 | ///\r |
| 86 | /// Reserved for future usage.\r |
| 87 | ///\r |
| 88 | UINT16 Reserved;\r |
| 89 | \r |
| 90 | ///\r |
| 91 | /// The segment of the entry point within the traditional BIOS for Compatibility16 functions.\r |
| 92 | ///\r |
| 93 | UINT16 Compatibility16CallSegment;\r |
| 94 | \r |
| 95 | ///\r |
| 96 | /// The offset of the entry point within the traditional BIOS for Compatibility16 functions.\r |
| 97 | ///\r |
| 98 | UINT16 Compatibility16CallOffset;\r |
| 99 | \r |
| 100 | ///\r |
| f22f941e |
101 | /// The segment of the entry point within the traditional BIOS for EfiCompatibility \r |
| 102 | /// to invoke the PnP installation check.\r |
| 87d63447 |
103 | ///\r |
| 104 | UINT16 PnPInstallationCheckSegment;\r |
| 105 | \r |
| 106 | ///\r |
| f22f941e |
107 | /// The Offset of the entry point within the traditional BIOS for EfiCompatibility \r |
| 108 | /// to invoke the PnP installation check.\r |
| 87d63447 |
109 | ///\r |
| 110 | UINT16 PnPInstallationCheckOffset;\r |
| 111 | \r |
| 112 | ///\r |
| f22f941e |
113 | /// EFI system resources table. Type EFI_SYSTEM_TABLE is defined in the IntelPlatform \r |
| 114 | ///Innovation Framework for EFI Driver Execution Environment Core Interface Specification (DXE CIS).\r |
| 87d63447 |
115 | ///\r |
| 116 | UINT32 EfiSystemTable; \r |
| 117 | \r |
| 118 | ///\r |
| 119 | /// The address of an OEM-provided identifier string. The string is null terminated.\r |
| 120 | ///\r |
| 121 | UINT32 OemIdStringPointer;\r |
| 122 | \r |
| 123 | ///\r |
| 124 | /// The 32-bit physical address where ACPI RSD PTR is stored within the traditional\r |
| 125 | /// BIOS. The remained of the ACPI tables are located at their EFI addresses. The size\r |
| 126 | /// reserved is the maximum for ACPI 2.0. The EfiCompatibility will fill in the ACPI\r |
| 127 | /// RSD PTR with either the ACPI 1.0b or 2.0 values.\r |
| 128 | ///\r |
| 129 | UINT32 AcpiRsdPtrPointer;\r |
| 130 | \r |
| 131 | ///\r |
| 132 | /// The OEM revision number. Usage is undefined but provided for OEM module usage.\r |
| 133 | ///\r |
| 134 | UINT16 OemRevision;\r |
| 135 | \r |
| 136 | ///\r |
| 137 | /// The 32-bit physical address where INT15 E820 data is stored within the traditional\r |
| 138 | /// BIOS. The EfiCompatibility code will fill in the E820Pointer value and copy the\r |
| 139 | /// data to the indicated area.\r |
| 140 | ///\r |
| 141 | UINT32 E820Pointer;\r |
| 142 | \r |
| 143 | ///\r |
| 144 | /// The length of the E820 data and is filled in by the EfiCompatibility code.\r |
| 145 | ///\r |
| 146 | UINT32 E820Length;\r |
| 147 | \r |
| 148 | ///\r |
| 149 | /// The 32-bit physical address where the $PIR table is stored in the traditional BIOS.\r |
| 150 | /// The EfiCompatibility code will fill in the IrqRoutingTablePointer value and\r |
| 151 | /// copy the data to the indicated area.\r |
| 152 | ///\r |
| 153 | UINT32 IrqRoutingTablePointer;\r |
| 154 | \r |
| 155 | ///\r |
| 156 | /// The length of the $PIR table and is filled in by the EfiCompatibility code.\r |
| 157 | ///\r |
| 158 | UINT32 IrqRoutingTableLength;\r |
| 159 | \r |
| 160 | ///\r |
| 161 | /// The 32-bit physical address where the MP table is stored in the traditional BIOS.\r |
| f22f941e |
162 | /// The EfiCompatibility code will fill in the MpTablePtr value and copy the data \r |
| 163 | /// to the indicated area.\r |
| 87d63447 |
164 | ///\r |
| 165 | UINT32 MpTablePtr;\r |
| 166 | \r |
| 167 | ///\r |
| 168 | /// The length of the MP table and is filled in by the EfiCompatibility code.\r |
| 169 | ///\r |
| 170 | UINT32 MpTableLength;\r |
| 171 | \r |
| 172 | ///\r |
| 173 | /// The segment of the OEM-specific INT table/code.\r |
| 174 | /// \r |
| 175 | UINT16 OemIntSegment;\r |
| 176 | \r |
| 177 | ///\r |
| 178 | /// The offset of the OEM-specific INT table/code.\r |
| 179 | ///\r |
| 180 | UINT16 OemIntOffset;\r |
| 181 | \r |
| 182 | ///\r |
| 183 | /// The segment of the OEM-specific 32-bit table/code.\r |
| 184 | ///\r |
| 185 | UINT16 Oem32Segment;\r |
| 186 | \r |
| 187 | ///\r |
| 188 | /// The offset of the OEM-specific 32-bit table/code.\r |
| 189 | ///\r |
| 190 | UINT16 Oem32Offset;\r |
| 191 | \r |
| 192 | ///\r |
| 193 | /// The segment of the OEM-specific 16-bit table/code.\r |
| 194 | ///\r |
| 195 | UINT16 Oem16Segment;\r |
| 196 | \r |
| 197 | ///\r |
| 198 | /// The offset of the OEM-specific 16-bit table/code.\r |
| 199 | ///\r |
| 200 | UINT16 Oem16Offset;\r |
| 201 | \r |
| 202 | ///\r |
| 203 | /// The segment of the TPM binary passed to 16-bit CSM.\r |
| 204 | ///\r |
| 205 | UINT16 TpmSegment;\r |
| 206 | \r |
| 207 | ///\r |
| 208 | /// The offset of the TPM binary passed to 16-bit CSM.\r |
| 209 | ///\r |
| 210 | UINT16 TpmOffset;\r |
| 211 | \r |
| 212 | ///\r |
| 213 | /// A pointer to a string identifying the independent BIOS vendor.\r |
| 214 | ///\r |
| 215 | UINT32 IbvPointer;\r |
| 216 | \r |
| 217 | ///\r |
| 218 | /// This field is NULL for all systems not supporting PCI Express. This field is the base\r |
| 219 | /// value of the start of the PCI Express memory-mapped configuration registers and\r |
| 220 | /// must be filled in prior to EfiCompatibility code issuing the Compatibility16 function\r |
| 221 | /// Compatibility16InitializeYourself().\r |
| 222 | /// Compatibility16InitializeYourself() is defined in Compatability16\r |
| 223 | /// Functions.\r |
| 224 | ///\r |
| 225 | UINT32 PciExpressBase;\r |
| 226 | \r |
| 227 | ///\r |
| 228 | /// Maximum PCI bus number assigned.\r |
| 229 | ///\r |
| 230 | UINT8 LastPciBus;\r |
| 231 | } EFI_COMPATIBILITY16_TABLE;\r |
| 232 | \r |
| 233 | ///\r |
| 234 | /// Functions provided by the CSM binary which communicate between the EfiCompatibility \r |
| 235 | /// and Compatability16 code.\r |
| 236 | ///\r |
| f22f941e |
237 | /// Inconsistent with the specification here: \r |
| 238 | /// The member's name started with "Compatibility16" [defined in Intel Framework \r |
| 239 | /// Compatibility Support Module Specification / 0.97 version] \r |
| 87d63447 |
240 | /// has been changed to "Legacy16" since keeping backward compatible.\r |
| 241 | ///\r |
| 242 | typedef enum {\r |
| 243 | ///\r |
| 244 | /// Causes the Compatibility16 code to do any internal initialization required.\r |
| 245 | /// Input:\r |
| 246 | /// AX = Compatibility16InitializeYourself\r |
| 247 | /// ES:BX = Pointer to EFI_TO_COMPATIBILITY16_INIT_TABLE\r |
| 248 | /// Return:\r |
| 249 | /// AX = Return Status codes\r |
| 250 | ///\r |
| 251 | Legacy16InitializeYourself = 0x0000,\r |
| 252 | \r |
| 253 | ///\r |
| 254 | /// Causes the Compatibility16 BIOS to perform any drive number translations to match the boot sequence.\r |
| 255 | /// Input:\r |
| 256 | /// AX = Compatibility16UpdateBbs\r |
| 257 | /// ES:BX = Pointer to EFI_TO_COMPATIBILITY16_BOOT_TABLE\r |
| 258 | /// Return:\r |
| 259 | /// AX = Returned status codes\r |
| 260 | ///\r |
| 261 | Legacy16UpdateBbs = 0x0001,\r |
| 262 | \r |
| 263 | ///\r |
| 264 | /// Allows the Compatibility16 code to perform any final actions before booting. The Compatibility16\r |
| 265 | /// code is read/write.\r |
| 266 | /// Input:\r |
| 267 | /// AX = Compatibility16PrepareToBoot\r |
| 268 | /// ES:BX = Pointer to EFI_TO_COMPATIBILITY16_BOOT_TABLE structure \r |
| 269 | /// Return:\r |
| 270 | /// AX = Returned status codes\r |
| 271 | ///\r |
| 272 | Legacy16PrepareToBoot = 0x0002,\r |
| 273 | \r |
| 274 | ///\r |
| 275 | /// Causes the Compatibility16 BIOS to boot. The Compatibility16 code is Read/Only.\r |
| 276 | /// Input:\r |
| 277 | /// AX = Compatibility16Boot\r |
| 278 | /// Output:\r |
| 279 | /// AX = Returned status codes\r |
| 280 | ///\r |
| 281 | Legacy16Boot = 0x0003,\r |
| 282 | \r |
| 283 | ///\r |
| 284 | /// Allows the Compatibility16 code to get the last device from which a boot was attempted. This is\r |
| 285 | /// stored in CMOS and is the priority number of the last attempted boot device.\r |
| 286 | /// Input:\r |
| 287 | /// AX = Compatibility16RetrieveLastBootDevice\r |
| 288 | /// Output:\r |
| 289 | /// AX = Returned status codes\r |
| 290 | /// BX = Priority number of the boot device.\r |
| 291 | ///\r |
| 292 | Legacy16RetrieveLastBootDevice = 0x0004,\r |
| 293 | \r |
| 294 | ///\r |
| 295 | /// Allows the Compatibility16 code rehook INT13, INT18, and/or INT19 after dispatching a legacy OpROM.\r |
| 296 | /// Input:\r |
| 297 | /// AX = Compatibility16DispatchOprom\r |
| 298 | /// ES:BX = Pointer to EFI_DISPATCH_OPROM_TABLE\r |
| 299 | /// Output:\r |
| 300 | /// AX = Returned status codes\r |
| 301 | /// BX = Number of non-BBS-compliant devices found. Equals 0 if BBS compliant.\r |
| 302 | ///\r |
| 303 | Legacy16DispatchOprom = 0x0005,\r |
| 304 | \r |
| 305 | ///\r |
| 306 | /// Finds a free area in the 0xFxxxx or 0xExxxx region of the specified length and returns the address\r |
| 307 | /// of that region.\r |
| 308 | /// Input:\r |
| 309 | /// AX = Compatibility16GetTableAddress\r |
| 310 | /// BX = Allocation region\r |
| 311 | /// 00 = Allocate from either 0xE0000 or 0xF0000 64 KB blocks.\r |
| 312 | /// Bit 0 = 1 Allocate from 0xF0000 64 KB block\r |
| 313 | /// Bit 1 = 1 Allocate from 0xE0000 64 KB block\r |
| 314 | /// CX = Requested length in bytes.\r |
| 315 | /// DX = Required address alignment. Bit mapped. First non-zero bit from the right is the alignment.\r |
| 316 | /// Output:\r |
| 317 | /// AX = Returned status codes\r |
| 318 | /// DS:BX = Address of the region\r |
| 319 | ///\r |
| 320 | Legacy16GetTableAddress = 0x0006,\r |
| 321 | \r |
| 322 | ///\r |
| 323 | /// Enables the EfiCompatibility module to do any nonstandard processing of keyboard LEDs or state.\r |
| 324 | /// Input:\r |
| 325 | /// AX = Compatibility16SetKeyboardLeds\r |
| 326 | /// CL = LED status.\r |
| 327 | /// Bit 0 Scroll Lock 0 = Off\r |
| 328 | /// Bit 1 NumLock\r |
| 329 | /// Bit 2 Caps Lock\r |
| 330 | /// Output:\r |
| 331 | /// AX = Returned status codes\r |
| 332 | ///\r |
| 333 | Legacy16SetKeyboardLeds = 0x0007,\r |
| 334 | \r |
| 335 | ///\r |
| 336 | /// Enables the EfiCompatibility module to install an interrupt handler for PCI mass media devices that\r |
| 337 | /// do not have an OpROM associated with them. An example is SATA.\r |
| 338 | /// Input:\r |
| 339 | /// AX = Compatibility16InstallPciHandler\r |
| 340 | /// ES:BX = Pointer to EFI_LEGACY_INSTALL_PCI_HANDLER structure\r |
| 341 | /// Output:\r |
| 342 | /// AX = Returned status codes\r |
| 343 | ///\r |
| 344 | Legacy16InstallPciHandler = 0x0008\r |
| 345 | } EFI_COMPATIBILITY_FUNCTIONS;\r |
| 346 | \r |
| 347 | \r |
| 348 | ///\r |
| 349 | /// EFI_DISPATCH_OPROM_TABLE\r |
| 350 | ///\r |
| 351 | typedef struct {\r |
| f22f941e |
352 | UINT16 PnPInstallationCheckSegment; ///< A pointer to the PnpInstallationCheck data structure.\r |
| 353 | UINT16 PnPInstallationCheckOffset; ///< A pointer to the PnpInstallationCheck data structure.\r |
| 87d63447 |
354 | UINT16 OpromSegment; ///< The segment where the OpROM was placed. Offset is assumed to be 3.\r |
| 355 | UINT8 PciBus; ///< The PCI bus.\r |
| 356 | UINT8 PciDeviceFunction; ///< The PCI device * 0x08 | PCI function.\r |
| 357 | UINT8 NumberBbsEntries; ///< The number of valid BBS table entries upon entry and exit. The IBV code may\r |
| 358 | ///< increase this number, if BBS-compliant devices also hook INTs in order to force the\r |
| 359 | ///< OpROM BIOS Setup to be executed.\r |
| c5b900be |
360 | UINT32 BbsTablePointer; ///< A pointer to the BBS table.\r |
| 87d63447 |
361 | UINT16 RuntimeSegment; ///< The segment where the OpROM can be relocated to. If this value is 0x0000, this\r |
| 362 | ///< means that the relocation of this run time code is not supported.\r |
| 363 | ///< Inconsistent with specification here: \r |
| 364 | ///< The member's name "OpromDestinationSegment" [defined in Intel Framework Compatibility Support Module Specification / 0.97 version] \r |
| 365 | ///< has been changed to "RuntimeSegment" since keeping backward compatible.\r |
| 366 | \r |
| 367 | } EFI_DISPATCH_OPROM_TABLE;\r |
| 368 | \r |
| 369 | ///\r |
| 370 | /// EFI_TO_COMPATIBILITY16_INIT_TABLE\r |
| 371 | ///\r |
| 372 | typedef struct {\r |
| 373 | ///\r |
| 374 | /// Starting address of memory under 1 MB. The ending address is assumed to be 640 KB or 0x9FFFF.\r |
| 375 | ///\r |
| 376 | UINT32 BiosLessThan1MB;\r |
| 377 | \r |
| 378 | ///\r |
| f22f941e |
379 | /// The starting address of the high memory block.\r |
| 87d63447 |
380 | ///\r |
| 381 | UINT32 HiPmmMemory;\r |
| 382 | \r |
| 383 | ///\r |
| f22f941e |
384 | /// The length of high memory block.\r |
| 87d63447 |
385 | ///\r |
| 386 | UINT32 HiPmmMemorySizeInBytes;\r |
| 387 | \r |
| 388 | ///\r |
| 389 | /// The segment of the reverse thunk call code.\r |
| 390 | ///\r |
| 391 | UINT16 ReverseThunkCallSegment;\r |
| 392 | \r |
| 393 | ///\r |
| 394 | /// The offset of the reverse thunk call code.\r |
| 395 | ///\r |
| 396 | UINT16 ReverseThunkCallOffset;\r |
| 397 | \r |
| 398 | ///\r |
| 399 | /// The number of E820 entries copied to the Compatibility16 BIOS.\r |
| 400 | ///\r |
| 401 | UINT32 NumberE820Entries;\r |
| 402 | \r |
| 403 | ///\r |
| 404 | /// The amount of usable memory above 1 MB, e.g., E820 type 1 memory.\r |
| 405 | ///\r |
| 406 | UINT32 OsMemoryAbove1Mb;\r |
| 407 | \r |
| 408 | ///\r |
| 409 | /// The start of thunk code in main memory. Memory cannot be used by BIOS or PMM.\r |
| 410 | ///\r |
| 411 | UINT32 ThunkStart;\r |
| 412 | \r |
| 413 | ///\r |
| 414 | /// The size of the thunk code.\r |
| 415 | ///\r |
| 416 | UINT32 ThunkSizeInBytes;\r |
| 417 | \r |
| 418 | ///\r |
| 419 | /// Starting address of memory under 1 MB.\r |
| 420 | ///\r |
| 421 | UINT32 LowPmmMemory;\r |
| 422 | \r |
| 423 | ///\r |
| f22f941e |
424 | /// The length of low Memory block.\r |
| 87d63447 |
425 | ///\r |
| 426 | UINT32 LowPmmMemorySizeInBytes;\r |
| 427 | } EFI_TO_COMPATIBILITY16_INIT_TABLE;\r |
| 428 | \r |
| 429 | ///\r |
| f22f941e |
430 | /// DEVICE_PRODUCER_SERIAL.\r |
| 87d63447 |
431 | ///\r |
| 432 | typedef struct {\r |
| f22f941e |
433 | UINT16 Address; ///< I/O address assigned to the serial port.\r |
| 87d63447 |
434 | UINT8 Irq; ///< IRQ assigned to the serial port.\r |
| 435 | SERIAL_MODE Mode; ///< Mode of serial port. Values are defined below.\r |
| 436 | } DEVICE_PRODUCER_SERIAL;\r |
| 437 | \r |
| 438 | ///\r |
| f22f941e |
439 | /// DEVICE_PRODUCER_SERIAL's modes.\r |
| 87d63447 |
440 | ///@{\r |
| 441 | #define DEVICE_SERIAL_MODE_NORMAL 0x00\r |
| 442 | #define DEVICE_SERIAL_MODE_IRDA 0x01\r |
| 443 | #define DEVICE_SERIAL_MODE_ASK_IR 0x02\r |
| 444 | #define DEVICE_SERIAL_MODE_DUPLEX_HALF 0x00\r |
| 445 | #define DEVICE_SERIAL_MODE_DUPLEX_FULL 0x10\r |
| 446 | ///@)\r |
| 447 | \r |
| 448 | ///\r |
| f22f941e |
449 | /// DEVICE_PRODUCER_PARALLEL.\r |
| 87d63447 |
450 | ///\r |
| 451 | typedef struct {\r |
| f22f941e |
452 | UINT16 Address; ///< I/O address assigned to the parallel port.\r |
| 87d63447 |
453 | UINT8 Irq; ///< IRQ assigned to the parallel port.\r |
| 454 | UINT8 Dma; ///< DMA assigned to the parallel port.\r |
| 455 | PARALLEL_MODE Mode; ///< Mode of the parallel port. Values are defined below.\r |
| 456 | } DEVICE_PRODUCER_PARALLEL;\r |
| 457 | \r |
| 458 | ///\r |
| f22f941e |
459 | /// DEVICE_PRODUCER_PARALLEL's modes.\r |
| 87d63447 |
460 | ///@{\r |
| 461 | #define DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY 0x00\r |
| 462 | #define DEVICE_PARALLEL_MODE_MODE_BIDIRECTIONAL 0x01\r |
| 463 | #define DEVICE_PARALLEL_MODE_MODE_EPP 0x02\r |
| 464 | #define DEVICE_PARALLEL_MODE_MODE_ECP 0x03\r |
| 465 | ///@}\r |
| 466 | \r |
| 467 | ///\r |
| 468 | /// DEVICE_PRODUCER_FLOPPY\r |
| 469 | ///\r |
| 470 | typedef struct {\r |
| f22f941e |
471 | UINT16 Address; ///< I/O address assigned to the floppy.\r |
| 87d63447 |
472 | UINT8 Irq; ///< IRQ assigned to the floppy.\r |
| 473 | UINT8 Dma; ///< DMA assigned to the floppy.\r |
| 474 | UINT8 NumberOfFloppy; ///< Number of floppies in the system.\r |
| 475 | } DEVICE_PRODUCER_FLOPPY;\r |
| 476 | \r |
| 477 | ///\r |
| 478 | /// LEGACY_DEVICE_FLAGS\r |
| 479 | ///\r |
| 480 | typedef struct {\r |
| 481 | UINT32 A20Kybd : 1; ///< A20 controller by keyboard controller.\r |
| 482 | UINT32 A20Port90 : 1; ///< A20 controlled by port 0x92.\r |
| 483 | UINT32 Reserved : 30; ///< Reserved for future usage.\r |
| 484 | } LEGACY_DEVICE_FLAGS;\r |
| 485 | \r |
| 486 | ///\r |
| 487 | /// DEVICE_PRODUCER_DATA_HEADER\r |
| 488 | ///\r |
| 489 | typedef struct {\r |
| 490 | DEVICE_PRODUCER_SERIAL Serial[4]; ///< Data for serial port x. Type DEVICE_PRODUCER_SERIAL is defined below.\r |
| 491 | DEVICE_PRODUCER_PARALLEL Parallel[3]; ///< Data for parallel port x. Type DEVICE_PRODUCER_PARALLEL is defined below.\r |
| 492 | DEVICE_PRODUCER_FLOPPY Floppy; ///< Data for floppy. Type DEVICE_PRODUCER_FLOPPY is defined below.\r |
| 493 | UINT8 MousePresent; ///< Flag to indicate if mouse is present.\r |
| 494 | LEGACY_DEVICE_FLAGS Flags; ///< Miscellaneous Boolean state information passed to CSM.\r |
| 495 | } DEVICE_PRODUCER_DATA_HEADER;\r |
| 496 | \r |
| 497 | ///\r |
| 498 | /// ATAPI_IDENTIFY\r |
| 499 | ///\r |
| 500 | typedef struct {\r |
| 501 | UINT16 Raw[256]; ///< Raw data from the IDE IdentifyDrive command.\r |
| 502 | } ATAPI_IDENTIFY;\r |
| 503 | \r |
| 504 | ///\r |
| 505 | /// HDD_INFO\r |
| 506 | ///\r |
| 507 | typedef struct {\r |
| 508 | ///\r |
| 509 | /// Status of IDE device. Values are defined below. There is one HDD_INFO structure\r |
| 510 | /// per IDE controller. The IdentifyDrive is per drive. Index 0 is master and index\r |
| 511 | /// 1 is slave.\r |
| 512 | ///\r |
| 513 | UINT16 Status; \r |
| 514 | \r |
| 515 | ///\r |
| 516 | /// PCI bus of IDE controller.\r |
| 517 | ///\r |
| 518 | UINT32 Bus;\r |
| 519 | \r |
| 520 | ///\r |
| 521 | /// PCI device of IDE controller.\r |
| 522 | ///\r |
| 523 | UINT32 Device;\r |
| 524 | \r |
| 525 | ///\r |
| 526 | /// PCI function of IDE controller.\r |
| 527 | ///\r |
| 528 | UINT32 Function;\r |
| 529 | \r |
| 530 | ///\r |
| 531 | /// Command ports base address.\r |
| 532 | ///\r |
| 533 | UINT16 CommandBaseAddress;\r |
| 534 | \r |
| 535 | ///\r |
| 536 | /// Control ports base address.\r |
| 537 | ///\r |
| 538 | UINT16 ControlBaseAddress;\r |
| 539 | \r |
| 540 | ///\r |
| f22f941e |
541 | /// Bus master address.\r |
| 87d63447 |
542 | ///\r |
| 543 | UINT16 BusMasterAddress;\r |
| 544 | \r |
| 545 | UINT8 HddIrq;\r |
| 546 | \r |
| 547 | ///\r |
| f22f941e |
548 | /// Data that identifies the drive data; one per possible attached drive.\r |
| 87d63447 |
549 | ///\r |
| 550 | ATAPI_IDENTIFY IdentifyDrive[2];\r |
| 551 | } HDD_INFO;\r |
| 552 | \r |
| 553 | ///\r |
| 554 | /// HDD_INFO status bits\r |
| 555 | ///\r |
| 556 | #define HDD_PRIMARY 0x01\r |
| 557 | #define HDD_SECONDARY 0x02\r |
| 558 | #define HDD_MASTER_ATAPI_CDROM 0x04\r |
| 559 | #define HDD_SLAVE_ATAPI_CDROM 0x08\r |
| 560 | #define HDD_MASTER_IDE 0x20\r |
| 561 | #define HDD_SLAVE_IDE 0x40\r |
| 562 | #define HDD_MASTER_ATAPI_ZIPDISK 0x10\r |
| 563 | #define HDD_SLAVE_ATAPI_ZIPDISK 0x80\r |
| 564 | \r |
| 565 | ///\r |
| f22f941e |
566 | /// BBS_STATUS_FLAGS;\.\r |
| 87d63447 |
567 | ///\r |
| 568 | typedef struct {\r |
| 569 | UINT16 OldPosition : 4; ///< Prior priority.\r |
| 570 | UINT16 Reserved1 : 4; ///< Reserved for future use.\r |
| 571 | UINT16 Enabled : 1; ///< If 0, ignore this entry.\r |
| 572 | UINT16 Failed : 1; ///< 0 = Not known if boot failure occurred.\r |
| 573 | ///< 1 = Boot attempted failed.\r |
| 574 | \r |
| 575 | ///\r |
| 576 | /// State of media present.\r |
| 577 | /// 00 = No bootable media is present in the device.\r |
| 578 | /// 01 = Unknown if a bootable media present.\r |
| 579 | /// 10 = Media is present and appears bootable.\r |
| 580 | /// 11 = Reserved.\r |
| 581 | ///\r |
| 582 | UINT16 MediaPresent : 2;\r |
| 583 | UINT16 Reserved2 : 4; ///< Reserved for future use.\r |
| 584 | } BBS_STATUS_FLAGS;\r |
| 585 | \r |
| 586 | ///\r |
| f22f941e |
587 | /// BBS_TABLE, device type values & boot priority values.\r |
| 87d63447 |
588 | ///\r |
| 589 | typedef struct {\r |
| 590 | ///\r |
| 591 | /// The boot priority for this boot device. Values are defined below.\r |
| 592 | ///\r |
| 593 | UINT16 BootPriority;\r |
| 594 | \r |
| 595 | ///\r |
| 596 | /// The PCI bus for this boot device.\r |
| 597 | ///\r |
| 598 | UINT32 Bus;\r |
| 599 | \r |
| 600 | ///\r |
| 601 | /// The PCI device for this boot device.\r |
| 602 | ///\r |
| 603 | UINT32 Device;\r |
| 604 | \r |
| 605 | ///\r |
| 606 | /// The PCI function for the boot device.\r |
| 607 | ///\r |
| 608 | UINT32 Function;\r |
| 609 | \r |
| 610 | ///\r |
| 611 | /// The PCI class for this boot device.\r |
| 612 | ///\r |
| 613 | UINT8 Class;\r |
| 614 | \r |
| 615 | ///\r |
| 616 | /// The PCI Subclass for this boot device.\r |
| 617 | ///\r |
| 618 | UINT8 SubClass;\r |
| 619 | \r |
| 620 | ///\r |
| 621 | /// Segment:offset address of an ASCIIZ description string describing the manufacturer.\r |
| 622 | ///\r |
| 623 | UINT16 MfgStringOffset;\r |
| 624 | \r |
| 625 | ///\r |
| 626 | /// Segment:offset address of an ASCIIZ description string describing the manufacturer.\r |
| 627 | /// \r |
| 628 | UINT16 MfgStringSegment;\r |
| 629 | \r |
| 630 | ///\r |
| 631 | /// BBS device type. BBS device types are defined below.\r |
| 632 | ///\r |
| 633 | UINT16 DeviceType;\r |
| 634 | \r |
| 635 | ///\r |
| 636 | /// Status of this boot device. Type BBS_STATUS_FLAGS is defined below.\r |
| 637 | ///\r |
| 638 | BBS_STATUS_FLAGS StatusFlags;\r |
| 639 | \r |
| 640 | ///\r |
| 641 | /// Segment:Offset address of boot loader for IPL devices or install INT13 handler for\r |
| 642 | /// BCV devices.\r |
| 643 | ///\r |
| 644 | UINT16 BootHandlerOffset;\r |
| 645 | \r |
| 646 | ///\r |
| 647 | /// Segment:Offset address of boot loader for IPL devices or install INT13 handler for\r |
| 648 | /// BCV devices.\r |
| 649 | /// \r |
| 650 | UINT16 BootHandlerSegment;\r |
| 651 | \r |
| 652 | ///\r |
| 653 | /// Segment:offset address of an ASCIIZ description string describing this device.\r |
| 654 | ///\r |
| 655 | UINT16 DescStringOffset;\r |
| 656 | \r |
| 657 | ///\r |
| 658 | /// Segment:offset address of an ASCIIZ description string describing this device.\r |
| 659 | ///\r |
| 660 | UINT16 DescStringSegment;\r |
| 661 | \r |
| 662 | ///\r |
| 663 | /// Reserved.\r |
| 664 | ///\r |
| 665 | UINT32 InitPerReserved;\r |
| 666 | \r |
| 667 | ///\r |
| 668 | /// The use of these fields is IBV dependent. They can be used to flag that an OpROM\r |
| 669 | /// has hooked the specified IRQ. The OpROM may be BBS compliant as some SCSI\r |
| 670 | /// BBS-compliant OpROMs also hook IRQ vectors in order to run their BIOS Setup\r |
| 671 | ///\r |
| 672 | UINT32 AdditionalIrq13Handler;\r |
| 673 | \r |
| 674 | ///\r |
| 675 | /// The use of these fields is IBV dependent. They can be used to flag that an OpROM\r |
| 676 | /// has hooked the specified IRQ. The OpROM may be BBS compliant as some SCSI\r |
| 677 | /// BBS-compliant OpROMs also hook IRQ vectors in order to run their BIOS Setup\r |
| 678 | /// \r |
| 679 | UINT32 AdditionalIrq18Handler;\r |
| 680 | \r |
| 681 | ///\r |
| 682 | /// The use of these fields is IBV dependent. They can be used to flag that an OpROM\r |
| 683 | /// has hooked the specified IRQ. The OpROM may be BBS compliant as some SCSI\r |
| 684 | /// BBS-compliant OpROMs also hook IRQ vectors in order to run their BIOS Setup\r |
| 685 | /// \r |
| 686 | UINT32 AdditionalIrq19Handler;\r |
| 687 | \r |
| 688 | ///\r |
| 689 | /// The use of these fields is IBV dependent. They can be used to flag that an OpROM\r |
| 690 | /// has hooked the specified IRQ. The OpROM may be BBS compliant as some SCSI\r |
| 691 | /// BBS-compliant OpROMs also hook IRQ vectors in order to run their BIOS Setup\r |
| 692 | /// \r |
| 693 | UINT32 AdditionalIrq40Handler;\r |
| 694 | UINT8 AssignedDriveNumber;\r |
| 695 | UINT32 AdditionalIrq41Handler;\r |
| 696 | UINT32 AdditionalIrq46Handler;\r |
| 697 | UINT32 IBV1;\r |
| 698 | UINT32 IBV2;\r |
| 699 | } BBS_TABLE;\r |
| 700 | \r |
| 701 | ///\r |
| 702 | /// BBS device type values\r |
| 703 | ///@{\r |
| 704 | #define BBS_FLOPPY 0x01\r |
| 705 | #define BBS_HARDDISK 0x02\r |
| 706 | #define BBS_CDROM 0x03\r |
| 707 | #define BBS_PCMCIA 0x04\r |
| 708 | #define BBS_USB 0x05\r |
| 709 | #define BBS_EMBED_NETWORK 0x06\r |
| 710 | #define BBS_BEV_DEVICE 0x80\r |
| 711 | #define BBS_UNKNOWN 0xff\r |
| 712 | ///@}\r |
| 713 | \r |
| 714 | ///\r |
| 715 | /// BBS boot priority values\r |
| 716 | ///@{\r |
| 717 | #define BBS_DO_NOT_BOOT_FROM 0xFFFC\r |
| 718 | #define BBS_LOWEST_PRIORITY 0xFFFD\r |
| 719 | #define BBS_UNPRIORITIZED_ENTRY 0xFFFE\r |
| 720 | #define BBS_IGNORE_ENTRY 0xFFFF\r |
| 721 | ///@}\r |
| 722 | \r |
| 723 | ///\r |
| 724 | /// SMM_ATTRIBUTES\r |
| 725 | ///\r |
| 726 | typedef struct {\r |
| 727 | ///\r |
| 728 | /// Access mechanism used to generate the soft SMI. Defined types are below. The other\r |
| 729 | /// values are reserved for future usage.\r |
| 730 | ///\r |
| 731 | UINT16 Type : 3;\r |
| 732 | \r |
| 733 | ///\r |
| f22f941e |
734 | /// The size of "port" in bits. Defined values are below.\r |
| 87d63447 |
735 | ///\r |
| 736 | UINT16 PortGranularity : 3;\r |
| 737 | \r |
| 738 | ///\r |
| f22f941e |
739 | /// The size of data in bits. Defined values are below.\r |
| 87d63447 |
740 | ///\r |
| 741 | UINT16 DataGranularity : 3;\r |
| 742 | \r |
| 743 | ///\r |
| 744 | /// Reserved for future use.\r |
| 745 | ///\r |
| 746 | UINT16 Reserved : 7;\r |
| 747 | } SMM_ATTRIBUTES;\r |
| 748 | \r |
| 749 | ///\r |
| f22f941e |
750 | /// SMM_ATTRIBUTES type values.\r |
| 87d63447 |
751 | ///@{\r |
| 752 | #define STANDARD_IO 0x00\r |
| 753 | #define STANDARD_MEMORY 0x01\r |
| 754 | ///@}\r |
| 755 | \r |
| 756 | ///\r |
| f22f941e |
757 | /// SMM_ATTRIBUTES port size constants.\r |
| 87d63447 |
758 | ///@{\r |
| 759 | #define PORT_SIZE_8 0x00\r |
| 760 | #define PORT_SIZE_16 0x01\r |
| 761 | #define PORT_SIZE_32 0x02\r |
| 762 | #define PORT_SIZE_64 0x03\r |
| 763 | ///@}\r |
| 764 | \r |
| 765 | ///\r |
| f22f941e |
766 | /// SMM_ATTRIBUTES data size constants.\r |
| 87d63447 |
767 | ///@{\r |
| 768 | #define DATA_SIZE_8 0x00\r |
| 769 | #define DATA_SIZE_16 0x01\r |
| 770 | #define DATA_SIZE_32 0x02\r |
| 771 | #define DATA_SIZE_64 0x03\r |
| 772 | ///@}\r |
| 773 | \r |
| 774 | ///\r |
| f22f941e |
775 | /// SMM_FUNCTION & relating constants.\r |
| 87d63447 |
776 | ///\r |
| 777 | typedef struct {\r |
| 778 | UINT16 Function : 15;\r |
| 779 | UINT16 Owner : 1;\r |
| 780 | } SMM_FUNCTION;\r |
| 781 | \r |
| 782 | ///\r |
| f22f941e |
783 | /// SMM_FUNCTION Function constants.\r |
| 87d63447 |
784 | ///@{\r |
| 785 | #define INT15_D042 0x0000\r |
| 786 | #define GET_USB_BOOT_INFO 0x0001\r |
| 787 | #define DMI_PNP_50_57 0x0002\r |
| 788 | ///@}\r |
| 789 | \r |
| 790 | ///\r |
| f22f941e |
791 | /// SMM_FUNCTION Owner constants.\r |
| 87d63447 |
792 | ///@{\r |
| 793 | #define STANDARD_OWNER 0x0\r |
| 794 | #define OEM_OWNER 0x1\r |
| 795 | ///@}\r |
| 796 | \r |
| 050b79eb |
797 | ///\r |
| 798 | /// This structure assumes both port and data sizes are 1. SmmAttribute must be\r |
| 799 | /// properly to reflect that assumption.\r |
| 800 | ///\r |
| 87d63447 |
801 | typedef struct {\r |
| 802 | ///\r |
| 803 | /// Describes the access mechanism, SmmPort, and SmmData sizes. Type\r |
| 804 | /// SMM_ATTRIBUTES is defined below.\r |
| 805 | ///\r |
| 806 | SMM_ATTRIBUTES SmmAttributes;\r |
| 807 | \r |
| 808 | ///\r |
| 809 | /// Function Soft SMI is to perform. Type SMM_FUNCTION is defined below.\r |
| 810 | ///\r |
| 811 | SMM_FUNCTION SmmFunction;\r |
| 812 | \r |
| 813 | ///\r |
| f22f941e |
814 | /// SmmPort size depends upon SmmAttributes and ranges from2 bytes to 16 bytes.\r |
| 87d63447 |
815 | ///\r |
| 816 | UINT8 SmmPort;\r |
| 817 | \r |
| 818 | ///\r |
| f22f941e |
819 | /// SmmData size depends upon SmmAttributes and ranges from2 bytes to 16 bytes.\r |
| 87d63447 |
820 | ///\r |
| 821 | UINT8 SmmData;\r |
| 822 | } SMM_ENTRY;\r |
| 823 | \r |
| 824 | ///\r |
| 825 | /// SMM_TABLE\r |
| 826 | ///\r |
| 827 | typedef struct {\r |
| 828 | UINT16 NumSmmEntries; ///< Number of entries represented by SmmEntry.\r |
| 829 | SMM_ENTRY SmmEntry; ///< One entry per function. Type SMM_ENTRY is defined below.\r |
| 830 | } SMM_TABLE;\r |
| 831 | \r |
| 832 | ///\r |
| 833 | /// UDC_ATTRIBUTES\r |
| 834 | ///\r |
| 835 | typedef struct {\r |
| 836 | ///\r |
| 837 | /// This bit set indicates that the ServiceAreaData is valid.\r |
| 838 | ///\r |
| 839 | UINT8 DirectoryServiceValidity : 1;\r |
| 840 | \r |
| 841 | ///\r |
| 842 | /// This bit set indicates to use the Reserve Area Boot Code Address (RACBA) only if\r |
| 843 | /// DirectoryServiceValidity is 0.\r |
| 844 | ///\r |
| 845 | UINT8 RabcaUsedFlag : 1;\r |
| 846 | \r |
| 847 | ///\r |
| 848 | /// This bit set indicates to execute hard disk diagnostics.\r |
| 849 | ///\r |
| 850 | UINT8 ExecuteHddDiagnosticsFlag : 1;\r |
| 851 | \r |
| 852 | ///\r |
| 853 | /// Reserved for future use. Set to 0.\r |
| 854 | ///\r |
| 855 | UINT8 Reserved : 5;\r |
| 856 | } UDC_ATTRIBUTES;\r |
| 857 | \r |
| 858 | ///\r |
| 859 | /// UD_TABLE\r |
| 860 | ///\r |
| 861 | typedef struct {\r |
| 862 | ///\r |
| 863 | /// This field contains the bit-mapped attributes of the PARTIES information. Type\r |
| 864 | /// UDC_ATTRIBUTES is defined below.\r |
| 865 | ///\r |
| 866 | UDC_ATTRIBUTES Attributes;\r |
| 867 | \r |
| 868 | ///\r |
| 869 | /// This field contains the zero-based device on which the selected\r |
| 870 | /// ServiceDataArea is present. It is 0 for master and 1 for the slave device. \r |
| 871 | ///\r |
| 872 | UINT8 DeviceNumber;\r |
| 873 | \r |
| 874 | ///\r |
| 875 | /// This field contains the zero-based index into the BbsTable for the parent device.\r |
| 876 | /// This index allows the user to reference the parent device information such as PCI\r |
| 877 | /// bus, device function.\r |
| 878 | ///\r |
| 879 | UINT8 BbsTableEntryNumberForParentDevice;\r |
| 880 | \r |
| 881 | ///\r |
| 882 | /// This field contains the zero-based index into the BbsTable for the boot entry.\r |
| 883 | ///\r |
| 884 | UINT8 BbsTableEntryNumberForBoot;\r |
| 885 | \r |
| 886 | ///\r |
| 887 | /// This field contains the zero-based index into the BbsTable for the HDD diagnostics entry.\r |
| 888 | ///\r |
| 889 | UINT8 BbsTableEntryNumberForHddDiag;\r |
| 890 | \r |
| 891 | ///\r |
| 892 | /// The raw Beer data.\r |
| 893 | ///\r |
| 894 | UINT8 BeerData[128];\r |
| 895 | \r |
| 896 | ///\r |
| 897 | /// The raw data of selected service area.\r |
| 898 | ///\r |
| 899 | UINT8 ServiceAreaData[64];\r |
| 900 | } UD_TABLE;\r |
| 901 | \r |
| 902 | #define EFI_TO_LEGACY_MAJOR_VERSION 0x02\r |
| 903 | #define EFI_TO_LEGACY_MINOR_VERSION 0x00\r |
| 904 | #define MAX_IDE_CONTROLLER 8\r |
| 905 | \r |
| 906 | ///\r |
| 907 | /// EFI_TO_COMPATIBILITY16_BOOT_TABLE\r |
| 908 | ///\r |
| 909 | typedef struct {\r |
| 910 | UINT16 MajorVersion; ///< The EfiCompatibility major version number.\r |
| 911 | UINT16 MinorVersion; ///< The EfiCompatibility minor version number.\r |
| f22f941e |
912 | UINT32 AcpiTable; ///< The location of the RSDT ACPI table. < 4G range.\r |
| 913 | UINT32 SmbiosTable; ///< The location of the SMBIOS table in EFI memory. < 4G range.\r |
| 87d63447 |
914 | UINT32 SmbiosTableLength;\r |
| 915 | //\r |
| 916 | // Legacy SIO state\r |
| 917 | //\r |
| 918 | DEVICE_PRODUCER_DATA_HEADER SioData; ///< Standard traditional device information.\r |
| 919 | UINT16 DevicePathType; ///< The default boot type.\r |
| 920 | UINT16 PciIrqMask; ///< Mask of which IRQs have been assigned to PCI.\r |
| 921 | UINT32 NumberE820Entries; ///< Number of E820 entries. The number can change from the\r |
| 922 | ///< Compatibility16InitializeYourself() function.\r |
| 923 | //\r |
| 924 | // Controller & Drive Identify[2] per controller information\r |
| 925 | //\r |
| 926 | HDD_INFO HddInfo[MAX_IDE_CONTROLLER]; ///< Hard disk drive information, including raw Identify Drive data.\r |
| 927 | UINT32 NumberBbsEntries; ///< Number of entries in the BBS table\r |
| f22f941e |
928 | UINT32 BbsTable; ///< A pointer to the BBS table. Type BBS_TABLE is defined below.\r |
| 929 | UINT32 SmmTable; ///< A pointer to the SMM table. Type SMM_TABLE is defined below.\r |
| 87d63447 |
930 | UINT32 OsMemoryAbove1Mb; ///< The amount of usable memory above 1 MB, i.e. E820 type 1 memory. This value can\r |
| 931 | ///< differ from the value in EFI_TO_COMPATIBILITY16_INIT_TABLE as more\r |
| 932 | ///< memory may have been discovered.\r |
| 933 | UINT32 UnconventionalDeviceTable; ///< Information to boot off an unconventional device like a PARTIES partition. Type\r |
| 934 | ///< UD_TABLE is defined below.\r |
| 935 | } EFI_TO_COMPATIBILITY16_BOOT_TABLE;\r |
| 936 | \r |
| 937 | ///\r |
| 938 | /// EFI_LEGACY_INSTALL_PCI_HANDLER\r |
| 939 | ///\r |
| 940 | typedef struct {\r |
| 941 | UINT8 PciBus; ///< The PCI bus of the device.\r |
| 942 | UINT8 PciDeviceFun; ///< The PCI device in bits 7:3 and function in bits 2:0.\r |
| 943 | UINT8 PciSegment; ///< The PCI segment of the device.\r |
| 944 | UINT8 PciClass; ///< The PCI class code of the device.\r |
| 945 | UINT8 PciSubclass; ///< The PCI subclass code of the device.\r |
| 946 | UINT8 PciInterface; ///< The PCI interface code of the device.\r |
| 947 | //\r |
| 948 | // Primary section\r |
| 949 | //\r |
| 950 | UINT8 PrimaryIrq; ///< The primary device IRQ.\r |
| 951 | UINT8 PrimaryReserved; ///< Reserved.\r |
| 952 | UINT16 PrimaryControl; ///< The primary device control I/O base.\r |
| 953 | UINT16 PrimaryBase; ///< The primary device I/O base.\r |
| 954 | UINT16 PrimaryBusMaster; ///< The primary device bus master I/O base.\r |
| 955 | //\r |
| 956 | // Secondary Section\r |
| 957 | //\r |
| 958 | UINT8 SecondaryIrq; ///< The secondary device IRQ.\r |
| 959 | UINT8 SecondaryReserved; ///< Reserved.\r |
| 960 | UINT16 SecondaryControl; ///< The secondary device control I/O base.\r |
| 961 | UINT16 SecondaryBase; ///< The secondary device I/O base.\r |
| 962 | UINT16 SecondaryBusMaster; ///< The secondary device bus master I/O base.\r |
| 963 | } EFI_LEGACY_INSTALL_PCI_HANDLER;\r |
| 964 | \r |
| 965 | //\r |
| 966 | // Restore default pack value\r |
| 967 | //\r |
| 968 | #pragma pack()\r |
| b80fbe85 |
969 | \r |
| 79964ac8 |
970 | #define EFI_LEGACY_BIOS_PROTOCOL_GUID \\r |
| 971 | { \\r |
| 972 | 0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d } \\r |
| 973 | }\r |
| 974 | \r |
| 975 | typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r |
| 976 | \r |
| 050b79eb |
977 | ///\r |
| f22f941e |
978 | /// Flags returned by CheckPciRom().\r |
| 050b79eb |
979 | ///\r |
| 9226e4ee |
980 | #define NO_ROM 0x00\r |
| 981 | #define ROM_FOUND 0x01\r |
| 982 | #define VALID_LEGACY_ROM 0x02\r |
| f22f941e |
983 | #define ROM_WITH_CONFIG 0x04 ///< Not defined in the Framework CSM Specification.\r |
| 9226e4ee |
984 | \r |
| 050b79eb |
985 | ///\r |
| 986 | /// The following macros do not appear in the Framework CSM Specification and \r |
| 987 | /// are kept for backward compatibility only. They convert 32-bit address (_Adr) \r |
| 988 | /// to Segment:Offset 16-bit form.\r |
| 989 | ///\r |
| ce9b1e3a |
990 | ///@{\r |
| 79964ac8 |
991 | #define EFI_SEGMENT(_Adr) (UINT16) ((UINT16) (((UINTN) (_Adr)) >> 4) & 0xf000)\r |
| 992 | #define EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xffff)\r |
| ce9b1e3a |
993 | ///@}\r |
| 79964ac8 |
994 | \r |
| 995 | #define CARRY_FLAG 0x01\r |
| 996 | \r |
| 050b79eb |
997 | ///\r |
| 998 | /// EFI_EFLAGS_REG\r |
| 999 | ///\r |
| 79964ac8 |
1000 | typedef struct {\r |
| 1001 | UINT32 CF:1;\r |
| 1002 | UINT32 Reserved1:1;\r |
| 1003 | UINT32 PF:1;\r |
| 1004 | UINT32 Reserved2:1;\r |
| 1005 | UINT32 AF:1;\r |
| 1006 | UINT32 Reserved3:1;\r |
| 1007 | UINT32 ZF:1;\r |
| 1008 | UINT32 SF:1;\r |
| 1009 | UINT32 TF:1;\r |
| 1010 | UINT32 IF:1;\r |
| 1011 | UINT32 DF:1;\r |
| 1012 | UINT32 OF:1;\r |
| 1013 | UINT32 IOPL:2;\r |
| 1014 | UINT32 NT:1;\r |
| 1015 | UINT32 Reserved4:2;\r |
| 1016 | UINT32 VM:1;\r |
| 1017 | UINT32 Reserved5:14;\r |
| 1018 | } EFI_EFLAGS_REG;\r |
| 1019 | \r |
| 050b79eb |
1020 | ///\r |
| 1021 | /// EFI_DWORD_REGS\r |
| 1022 | ///\r |
| 79964ac8 |
1023 | typedef struct {\r |
| 1024 | UINT32 EAX;\r |
| 1025 | UINT32 EBX;\r |
| 1026 | UINT32 ECX;\r |
| 1027 | UINT32 EDX;\r |
| 1028 | UINT32 ESI;\r |
| 1029 | UINT32 EDI;\r |
| 1030 | EFI_EFLAGS_REG EFlags;\r |
| 1031 | UINT16 ES;\r |
| 1032 | UINT16 CS;\r |
| 1033 | UINT16 SS;\r |
| 1034 | UINT16 DS;\r |
| 1035 | UINT16 FS;\r |
| 1036 | UINT16 GS;\r |
| 1037 | UINT32 EBP;\r |
| 1038 | UINT32 ESP;\r |
| 1039 | } EFI_DWORD_REGS;\r |
| 1040 | \r |
| 050b79eb |
1041 | ///\r |
| 1042 | /// EFI_FLAGS_REG\r |
| 1043 | ///\r |
| 79964ac8 |
1044 | typedef struct {\r |
| 1045 | UINT16 CF:1;\r |
| 1046 | UINT16 Reserved1:1;\r |
| 1047 | UINT16 PF:1;\r |
| 1048 | UINT16 Reserved2:1;\r |
| 1049 | UINT16 AF:1;\r |
| 1050 | UINT16 Reserved3:1;\r |
| 1051 | UINT16 ZF:1;\r |
| 1052 | UINT16 SF:1;\r |
| 1053 | UINT16 TF:1;\r |
| 1054 | UINT16 IF:1;\r |
| 1055 | UINT16 DF:1;\r |
| 1056 | UINT16 OF:1;\r |
| 1057 | UINT16 IOPL:2;\r |
| 1058 | UINT16 NT:1;\r |
| 1059 | UINT16 Reserved4:1;\r |
| 1060 | } EFI_FLAGS_REG;\r |
| 1061 | \r |
| 050b79eb |
1062 | ///\r |
| 1063 | /// EFI_WORD_REGS\r |
| 1064 | ///\r |
| 79964ac8 |
1065 | typedef struct {\r |
| 1066 | UINT16 AX;\r |
| 1067 | UINT16 ReservedAX;\r |
| 1068 | UINT16 BX;\r |
| 1069 | UINT16 ReservedBX;\r |
| 1070 | UINT16 CX;\r |
| 1071 | UINT16 ReservedCX;\r |
| 1072 | UINT16 DX;\r |
| 1073 | UINT16 ReservedDX;\r |
| 1074 | UINT16 SI;\r |
| 1075 | UINT16 ReservedSI;\r |
| 1076 | UINT16 DI;\r |
| 1077 | UINT16 ReservedDI;\r |
| 1078 | EFI_FLAGS_REG Flags;\r |
| 1079 | UINT16 ReservedFlags;\r |
| 1080 | UINT16 ES;\r |
| 1081 | UINT16 CS;\r |
| 1082 | UINT16 SS;\r |
| 1083 | UINT16 DS;\r |
| 1084 | UINT16 FS;\r |
| 1085 | UINT16 GS;\r |
| 1086 | UINT16 BP;\r |
| 1087 | UINT16 ReservedBP;\r |
| 1088 | UINT16 SP;\r |
| 1089 | UINT16 ReservedSP;\r |
| 1090 | } EFI_WORD_REGS;\r |
| 1091 | \r |
| 050b79eb |
1092 | ///\r |
| 1093 | /// EFI_BYTE_REGS\r |
| 1094 | ///\r |
| 79964ac8 |
1095 | typedef struct {\r |
| 1096 | UINT8 AL, AH;\r |
| 1097 | UINT16 ReservedAX;\r |
| 1098 | UINT8 BL, BH;\r |
| 1099 | UINT16 ReservedBX;\r |
| 1100 | UINT8 CL, CH;\r |
| 1101 | UINT16 ReservedCX;\r |
| 1102 | UINT8 DL, DH;\r |
| 1103 | UINT16 ReservedDX;\r |
| 1104 | } EFI_BYTE_REGS;\r |
| 1105 | \r |
| 050b79eb |
1106 | ///\r |
| 1107 | /// EFI_IA32_REGISTER_SET\r |
| 1108 | ///\r |
| 79964ac8 |
1109 | typedef union {\r |
| 1110 | EFI_DWORD_REGS E;\r |
| 1111 | EFI_WORD_REGS X;\r |
| 1112 | EFI_BYTE_REGS H;\r |
| 1113 | } EFI_IA32_REGISTER_SET;\r |
| 1114 | \r |
| 1115 | /**\r |
| 1116 | Thunk to 16-bit real mode and execute a software interrupt with a vector\r |
| 1117 | of BiosInt. Regs will contain the 16-bit register context on entry and\r |
| 1118 | exit.\r |
| 1119 | \r |
| f22f941e |
1120 | @param[in] This The protocol instance pointer.\r |
| 1121 | @param[in] BiosInt The processor interrupt vector to invoke.\r |
| 050b79eb |
1122 | @param[in,out] Reg Register contexted passed into (and returned) from thunk to\r |
| f22f941e |
1123 | 16-bit mode.\r |
| 79964ac8 |
1124 | \r |
| 5259c97d |
1125 | @retval TRUE Thunk completed with no BIOS errors in the target code. See Regs for status. \r |
| 1126 | @retval FALSE There was a BIOS error in the target code.\r |
| 79964ac8 |
1127 | **/\r |
| 1128 | typedef\r |
| 1129 | BOOLEAN\r |
| 69686d56 |
1130 | (EFIAPI *EFI_LEGACY_BIOS_INT86)(\r |
| 050b79eb |
1131 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1132 | IN UINT8 BiosInt,\r |
| 1133 | IN OUT EFI_IA32_REGISTER_SET *Regs\r |
| 79964ac8 |
1134 | );\r |
| 1135 | \r |
| 1136 | /**\r |
| 1137 | Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r |
| 1138 | 16-bit register context on entry and exit. Arguments can be passed on\r |
| 1139 | the Stack argument\r |
| 1140 | \r |
| f22f941e |
1141 | @param[in] This The protocol instance pointer.\r |
| 1142 | @param[in] Segment The segemnt of 16-bit mode call.\r |
| 1143 | @param[in] Offset The offset of 16-bit mdoe call.\r |
| 050b79eb |
1144 | @param[in] Reg Register contexted passed into (and returned) from thunk to\r |
| f22f941e |
1145 | 16-bit mode.\r |
| 1146 | @param[in] Stack The caller allocated stack used to pass arguments.\r |
| 1147 | @param[in] StackSize The size of Stack in bytes.\r |
| 79964ac8 |
1148 | \r |
| 5259c97d |
1149 | @retval FALSE Thunk completed with no BIOS errors in the target code. See Regs for status. @retval TRUE There was a BIOS error in the target code.\r |
| 79964ac8 |
1150 | **/\r |
| 1151 | typedef\r |
| 1152 | BOOLEAN\r |
| 69686d56 |
1153 | (EFIAPI *EFI_LEGACY_BIOS_FARCALL86)(\r |
| 050b79eb |
1154 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1155 | IN UINT16 Segment,\r |
| 1156 | IN UINT16 Offset,\r |
| 1157 | IN EFI_IA32_REGISTER_SET *Regs,\r |
| 1158 | IN VOID *Stack,\r |
| 1159 | IN UINTN StackSize\r |
| 79964ac8 |
1160 | );\r |
| 1161 | \r |
| 1162 | /**\r |
| 1163 | Test to see if a legacy PCI ROM exists for this device. Optionally return\r |
| 1164 | the Legacy ROM instance for this PCI device.\r |
| 1165 | \r |
| f22f941e |
1166 | @param[in] This The protocol instance pointer.\r |
| 050b79eb |
1167 | @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r |
| f22f941e |
1168 | @param[out] RomImage Return the legacy PCI ROM for this device.\r |
| 1169 | @param[out] RomSize The size of ROM Image.\r |
| 050b79eb |
1170 | @param[out] Flags Indicates if ROM found and if PC-AT. Multiple bits can be set as follows:\r |
| f22f941e |
1171 | - 00 = No ROM.\r |
| 1172 | - 01 = ROM Found.\r |
| 1173 | - 02 = ROM is a valid legacy ROM.\r |
| 79964ac8 |
1174 | \r |
| f22f941e |
1175 | @retval EFI_SUCCESS The Legacy Option ROM availible for this device\r |
| 1176 | @retval EFI_UNSUPPORTED The Legacy Option ROM is not supported.\r |
| 79964ac8 |
1177 | \r |
| 1178 | **/\r |
| 1179 | typedef\r |
| 1180 | EFI_STATUS\r |
| 69686d56 |
1181 | (EFIAPI *EFI_LEGACY_BIOS_CHECK_ROM)(\r |
| 050b79eb |
1182 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1183 | IN EFI_HANDLE PciHandle,\r |
| 1184 | OUT VOID **RomImage, OPTIONAL\r |
| 1185 | OUT UINTN *RomSize, OPTIONAL\r |
| 1186 | OUT UINTN *Flags\r |
| 79964ac8 |
1187 | );\r |
| 1188 | \r |
| 1189 | /**\r |
| 1190 | Load a legacy PC-AT OPROM on the PciHandle device. Return information\r |
| 1191 | about how many disks were added by the OPROM and the shadow address and\r |
| 1192 | size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r |
| 1193 | \r |
| f22f941e |
1194 | @param[in] This The protocol instance pointer.\r |
| 050b79eb |
1195 | @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r |
| 1196 | This value is NULL if RomImage is non-NULL. This is the normal\r |
| 1197 | case.\r |
| 1198 | @param[in] RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is\r |
| 1199 | no hardware associated with the ROM and thus no PciHandle,\r |
| 1200 | otherwise is must be NULL.\r |
| 1201 | Example is PXE base code.\r |
| 1202 | @param[out] Flags The type of ROM discovered. Multiple bits can be set, as follows:\r |
| 1203 | - 00 = No ROM.\r |
| 1204 | - 01 = ROM found.\r |
| 1205 | - 02 = ROM is a valid legacy ROM.\r |
| f22f941e |
1206 | @param[out] DiskStart The disk number of first device hooked by the ROM. If DiskStart\r |
| 050b79eb |
1207 | is the same as DiskEnd no disked were hooked.\r |
| 1208 | @param[out] DiskEnd disk number of the last device hooked by the ROM.\r |
| f22f941e |
1209 | @param[out] RomShadowAddress Shadow address of PC-AT ROM.\r |
| 1210 | @param[out] RomShadowSize Size of RomShadowAddress in bytes.\r |
| 050b79eb |
1211 | \r |
| 1212 | @retval EFI_SUCCESS Thunk completed, see Regs for status.\r |
| 1213 | @retval EFI_INVALID_PARAMETER PciHandle not found\r |
| 79964ac8 |
1214 | \r |
| 1215 | **/\r |
| 1216 | typedef\r |
| 1217 | EFI_STATUS\r |
| 69686d56 |
1218 | (EFIAPI *EFI_LEGACY_BIOS_INSTALL_ROM)(\r |
| 050b79eb |
1219 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1220 | IN EFI_HANDLE PciHandle,\r |
| 1221 | IN VOID **RomImage,\r |
| 1222 | OUT UINTN *Flags,\r |
| 1223 | OUT UINT8 *DiskStart, OPTIONAL\r |
| 1224 | OUT UINT8 *DiskEnd, OPTIONAL\r |
| 1225 | OUT VOID **RomShadowAddress, OPTIONAL\r |
| 1226 | OUT UINT32 *ShadowedRomSize OPTIONAL\r |
| 79964ac8 |
1227 | );\r |
| 1228 | \r |
| 1229 | /**\r |
| ef1ac015 |
1230 | This function attempts to traditionally boot the specified BootOption. If the EFI context has\r |
| 5259c97d |
1231 | been compromised, this function will not return. This procedure is not used for loading an EFI-aware\r |
| ef1ac015 |
1232 | OS off a traditional device. The following actions occur:\r |
| 1233 | - Get EFI SMBIOS data structures, convert them to a traditional format, and copy to\r |
| 1234 | Compatibility16.\r |
| 1235 | - Get a pointer to ACPI data structures and copy the Compatibility16 RSD PTR to F0000 block.\r |
| 1236 | - Find the traditional SMI handler from a firmware volume and register the traditional SMI\r |
| 1237 | handler with the EFI SMI handler.\r |
| 1238 | - Build onboard IDE information and pass this information to the Compatibility16 code.\r |
| 1239 | - Make sure all PCI Interrupt Line registers are programmed to match 8259.\r |
| 1240 | - Reconfigure SIO devices from EFI mode (polled) into traditional mode (interrupt driven).\r |
| 1241 | - Shadow all PCI ROMs.\r |
| 1242 | - Set up BDA and EBDA standard areas before the legacy boot.\r |
| 1243 | - Construct the Compatibility16 boot memory map and pass it to the Compatibility16 code.\r |
| 1244 | - Invoke the Compatibility16 table function Compatibility16PrepareToBoot(). This\r |
| 1245 | invocation causes a thunk into the Compatibility16 code, which sets all appropriate internal\r |
| 1246 | data structures. The boot device list is a parameter.\r |
| 1247 | - Invoke the Compatibility16 Table function Compatibility16Boot(). This invocation\r |
| 1248 | causes a thunk into the Compatibility16 code, which does an INT19.\r |
| 1249 | - If the Compatibility16Boot() function returns, then the boot failed in a graceful\r |
| 5259c97d |
1250 | manner--meaning that the EFI code is still valid. An ungraceful boot failure causes a reset because the state\r |
| ef1ac015 |
1251 | of EFI code is unknown.\r |
| 79964ac8 |
1252 | \r |
| f22f941e |
1253 | @param[in] This The protocol instance pointer.\r |
| 1254 | @param[in] BootOption The EFI Device Path from BootXXXX variable.\r |
| 1255 | @param[in] LoadOptionSize The size of LoadOption in size.\r |
| 1256 | @param[in] LoadOption LThe oadOption from BootXXXX variable.\r |
| 79964ac8 |
1257 | \r |
| 5259c97d |
1258 | @retval EFI_DEVICE_ERROR Failed to boot from any boot device and memory is uncorrupted. Note: This function normally does not returns. It will either boot the OS or reset the system if memory has been "corrupted" by loading a boot sector and passing control to it.\r |
| 79964ac8 |
1259 | **/\r |
| 1260 | typedef\r |
| 1261 | EFI_STATUS\r |
| 69686d56 |
1262 | (EFIAPI *EFI_LEGACY_BIOS_BOOT)(\r |
| 050b79eb |
1263 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1264 | IN BBS_BBS_DEVICE_PATH *BootOption,\r |
| 1265 | IN UINT32 LoadOptionsSize,\r |
| 1266 | IN VOID *LoadOptions\r |
| 79964ac8 |
1267 | );\r |
| 1268 | \r |
| 1269 | /**\r |
| ef1ac015 |
1270 | This function takes the Leds input parameter and sets/resets the BDA accordingly. \r |
| 1271 | Leds is also passed to Compatibility16 code, in case any special processing is required. \r |
| 5259c97d |
1272 | This function is normally called from EFI Setup drivers that handle user-selectable\r |
| ef1ac015 |
1273 | keyboard options such as boot with NUM LOCK on/off. This function does not\r |
| 1274 | touch the keyboard or keyboard LEDs but only the BDA.\r |
| 79964ac8 |
1275 | \r |
| f22f941e |
1276 | @param[in] This The protocol instance pointer.\r |
| 1277 | @param[in] Leds The status of current Scroll, Num & Cap lock LEDS:\r |
| 1278 | - Bit 0 is Scroll Lock 0 = Not locked.\r |
| 1279 | - Bit 1 is Num Lock.\r |
| 1280 | - Bit 2 is Caps Lock.\r |
| 79964ac8 |
1281 | \r |
| 050b79eb |
1282 | @retval EFI_SUCCESS The BDA was updated successfully.\r |
| 79964ac8 |
1283 | \r |
| 1284 | **/\r |
| 1285 | typedef\r |
| 1286 | EFI_STATUS\r |
| 69686d56 |
1287 | (EFIAPI *EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS)(\r |
| 050b79eb |
1288 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1289 | IN UINT8 Leds\r |
| 79964ac8 |
1290 | );\r |
| 1291 | \r |
| 1292 | /**\r |
| 1293 | Retrieve legacy BBS info and assign boot priority.\r |
| 1294 | \r |
| f22f941e |
1295 | @param[in] This The protocol instance pointer.\r |
| 1296 | @param[out] HddCount The number of HDD_INFO structures.\r |
| 1297 | @param[out] HddInfo Onboard IDE controller information.\r |
| 1298 | @param[out] BbsCount The number of BBS_TABLE structures.\r |
| 1299 | @param[in,out] BbsTable Points to List of BBS_TABLE.\r |
| 79964ac8 |
1300 | \r |
| f22f941e |
1301 | @retval EFI_SUCCESS Tables were returned.\r |
| 79964ac8 |
1302 | \r |
| 1303 | **/\r |
| 1304 | typedef\r |
| 1305 | EFI_STATUS\r |
| 69686d56 |
1306 | (EFIAPI *EFI_LEGACY_BIOS_GET_BBS_INFO)(\r |
| 050b79eb |
1307 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1308 | OUT UINT16 *HddCount,\r |
| 1309 | OUT HDD_INFO **HddInfo,\r |
| 1310 | OUT UINT16 *BbsCount,\r |
| 1311 | IN OUT BBS_TABLE **BbsTable\r |
| 79964ac8 |
1312 | );\r |
| 1313 | \r |
| 1314 | /**\r |
| 1315 | Assign drive number to legacy HDD drives prior to booting an EFI\r |
| 1316 | aware OS so the OS can access drives without an EFI driver.\r |
| 1317 | \r |
| f22f941e |
1318 | @param[in] This The protocol instance pointer.\r |
| 1319 | @param[out] BbsCount The number of BBS_TABLE structures\r |
| 1320 | @param[out] BbsTable List of BBS entries\r |
| 79964ac8 |
1321 | \r |
| f22f941e |
1322 | @retval EFI_SUCCESS Drive numbers assigned.\r |
| 79964ac8 |
1323 | \r |
| 1324 | **/\r |
| 1325 | typedef\r |
| 1326 | EFI_STATUS\r |
| 69686d56 |
1327 | (EFIAPI *EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI)(\r |
| 050b79eb |
1328 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1329 | OUT UINT16 *BbsCount,\r |
| 1330 | OUT BBS_TABLE **BbsTable\r |
| 79964ac8 |
1331 | );\r |
| 1332 | \r |
| 1333 | /**\r |
| 1334 | To boot from an unconventional device like parties and/or execute\r |
| 1335 | HDD diagnostics.\r |
| 1336 | \r |
| f22f941e |
1337 | @param[in] This The protocol instance pointer.\r |
| 1338 | @param[in] Attributes How to interpret the other input parameters.\r |
| 050b79eb |
1339 | @param[in] BbsEntry The 0-based index into the BbsTable for the parent\r |
| 79964ac8 |
1340 | device.\r |
| f22f941e |
1341 | @param[in] BeerData A pointer to the 128 bytes of ram BEER data.\r |
| 1342 | @param[in] ServiceAreaData A pointer to the 64 bytes of raw Service Area data. The\r |
| 79964ac8 |
1343 | caller must provide a pointer to the specific Service\r |
| 1344 | Area and not the start all Service Areas.\r |
| 1345 | \r |
| 050b79eb |
1346 | @retval EFI_INVALID_PARAMETER If error. Does NOT return if no error.\r |
| 79964ac8 |
1347 | \r |
| 1348 | **/\r |
| 1349 | typedef\r |
| 1350 | EFI_STATUS\r |
| 69686d56 |
1351 | (EFIAPI *EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE)(\r |
| 050b79eb |
1352 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1353 | IN UDC_ATTRIBUTES Attributes,\r |
| 1354 | IN UINTN BbsEntry,\r |
| 1355 | IN VOID *BeerData,\r |
| 1356 | IN VOID *ServiceAreaData\r |
| 79964ac8 |
1357 | );\r |
| 1358 | \r |
| 1359 | /**\r |
| 1360 | Shadow all legacy16 OPROMs that haven't been shadowed.\r |
| 1361 | Warning: Use this with caution. This routine disconnects all EFI\r |
| f22f941e |
1362 | drivers. If used externally, then the caller must re-connect EFI\r |
| 79964ac8 |
1363 | drivers.\r |
| 050b79eb |
1364 | \r |
| f22f941e |
1365 | @param[in] This The protocol instance pointer.\r |
| 050b79eb |
1366 | \r |
| f22f941e |
1367 | @retval EFI_SUCCESS OPROMs were shadowed.\r |
| 79964ac8 |
1368 | \r |
| 1369 | **/\r |
| 1370 | typedef\r |
| 1371 | EFI_STATUS\r |
| 69686d56 |
1372 | (EFIAPI *EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS)(\r |
| 050b79eb |
1373 | IN EFI_LEGACY_BIOS_PROTOCOL *This\r |
| 79964ac8 |
1374 | );\r |
| 1375 | \r |
| 1376 | /**\r |
| 1377 | Get a region from the LegacyBios for S3 usage.\r |
| 1378 | \r |
| f22f941e |
1379 | @param[in] This The protocol instance pointer.\r |
| 1380 | @param[in] LegacyMemorySize The size of required region.\r |
| 1381 | @param[in] Region The region to use.\r |
| 1382 | 00 = Either 0xE0000 or 0xF0000 block.\r |
| 1383 | - Bit0 = 1 0xF0000 block.\r |
| 1384 | - Bit1 = 1 0xE0000 block.\r |
| 1385 | @param[in] Alignment Address alignment. Bit mapped. The first non-zero\r |
| 050b79eb |
1386 | bit from right is alignment.\r |
| f22f941e |
1387 | @param[out] LegacyMemoryAddress The Region Assigned\r |
| 79964ac8 |
1388 | \r |
| f22f941e |
1389 | @retval EFI_SUCCESS The Region was assigned.\r |
| ef1ac015 |
1390 | @retval EFI_ACCESS_DENIED The function was previously invoked.\r |
| f22f941e |
1391 | @retval Other The Region was not assigned.\r |
| 79964ac8 |
1392 | \r |
| 1393 | **/\r |
| 1394 | typedef\r |
| 1395 | EFI_STATUS\r |
| 69686d56 |
1396 | (EFIAPI *EFI_LEGACY_BIOS_GET_LEGACY_REGION)(\r |
| 050b79eb |
1397 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1398 | IN UINTN LegacyMemorySize,\r |
| 1399 | IN UINTN Region,\r |
| 1400 | IN UINTN Alignment,\r |
| 1401 | OUT VOID **LegacyMemoryAddress\r |
| 79964ac8 |
1402 | );\r |
| 1403 | \r |
| 1404 | /**\r |
| 1405 | Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r |
| 1406 | \r |
| f22f941e |
1407 | @param[in] This The protocol instance pointer.\r |
| 1408 | @param[in] LegacyMemorySize The size of data to copy.\r |
| 1409 | @param[in] LegacyMemoryAddress The Legacy Region destination address.\r |
| 050b79eb |
1410 | Note: must be in region assigned by\r |
| f22f941e |
1411 | LegacyBiosGetLegacyRegion.\r |
| 1412 | @param[in] LegacyMemorySourceAddress The source of the data to copy.\r |
| 79964ac8 |
1413 | \r |
| f22f941e |
1414 | @retval EFI_SUCCESS The Region assigned.\r |
| 1415 | @retval EFI_ACCESS_DENIED Destination was outside an assigned region.\r |
| 79964ac8 |
1416 | \r |
| 1417 | **/\r |
| 1418 | typedef\r |
| 1419 | EFI_STATUS\r |
| 69686d56 |
1420 | (EFIAPI *EFI_LEGACY_BIOS_COPY_LEGACY_REGION)(\r |
| 050b79eb |
1421 | IN EFI_LEGACY_BIOS_PROTOCOL *This,\r |
| 1422 | IN UINTN LegacyMemorySize,\r |
| 1423 | IN VOID *LegacyMemoryAddress,\r |
| 1424 | IN VOID *LegacyMemorySourceAddress\r |
| 79964ac8 |
1425 | );\r |
| 1426 | \r |
| 050b79eb |
1427 | ///\r |
| 1428 | /// Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()\r |
| 1429 | /// member function allows the BDS to support booting a traditional OS.\r |
| 1430 | /// EFI thunks drivers that make EFI bindings for BIOS INT services use\r |
| 1431 | /// all the other member functions.\r |
| 1432 | ///\r |
| 79964ac8 |
1433 | struct _EFI_LEGACY_BIOS_PROTOCOL {\r |
| 2bbaeb0d |
1434 | ///\r |
| 1435 | /// Performs traditional software INT. See the Int86() function description.\r |
| 1436 | ///\r |
| 79964ac8 |
1437 | EFI_LEGACY_BIOS_INT86 Int86;\r |
| 2bbaeb0d |
1438 | \r |
| 1439 | ///\r |
| 1440 | /// Performs a far call into Compatibility16 or traditional OpROM code.\r |
| 1441 | ///\r |
| 79964ac8 |
1442 | EFI_LEGACY_BIOS_FARCALL86 FarCall86;\r |
| 2bbaeb0d |
1443 | \r |
| 1444 | ///\r |
| 1445 | /// Checks if a traditional OpROM exists for this device.\r |
| 1446 | ///\r |
| 79964ac8 |
1447 | EFI_LEGACY_BIOS_CHECK_ROM CheckPciRom;\r |
| 2bbaeb0d |
1448 | \r |
| 1449 | ///\r |
| 1450 | /// Loads a traditional OpROM in traditional OpROM address space.\r |
| 1451 | ///\r |
| 79964ac8 |
1452 | EFI_LEGACY_BIOS_INSTALL_ROM InstallPciRom;\r |
| 2bbaeb0d |
1453 | \r |
| 1454 | ///\r |
| 1455 | /// Boots a traditional OS.\r |
| 1456 | ///\r |
| 79964ac8 |
1457 | EFI_LEGACY_BIOS_BOOT LegacyBoot;\r |
| 2bbaeb0d |
1458 | \r |
| 1459 | ///\r |
| 1460 | /// Updates BDA to reflect the current EFI keyboard LED status.\r |
| 1461 | ///\r |
| 79964ac8 |
1462 | EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS UpdateKeyboardLedStatus;\r |
| 2bbaeb0d |
1463 | \r |
| 1464 | ///\r |
| 1465 | /// Allows an external agent, such as BIOS Setup, to get the BBS data.\r |
| 1466 | ///\r |
| 79964ac8 |
1467 | EFI_LEGACY_BIOS_GET_BBS_INFO GetBbsInfo;\r |
| 2bbaeb0d |
1468 | \r |
| 1469 | ///\r |
| 1470 | /// Causes all legacy OpROMs to be shadowed.\r |
| 1471 | ///\r |
| 79964ac8 |
1472 | EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS ShadowAllLegacyOproms;\r |
| 2bbaeb0d |
1473 | \r |
| 1474 | ///\r |
| 1475 | /// Performs all actions prior to boot. Used when booting an EFI-aware OS\r |
| 1476 | /// rather than a legacy OS. \r |
| 1477 | ///\r |
| 79964ac8 |
1478 | EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI PrepareToBootEfi;\r |
| 2bbaeb0d |
1479 | \r |
| 1480 | ///\r |
| 1481 | /// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r |
| 1482 | ///\r |
| 79964ac8 |
1483 | EFI_LEGACY_BIOS_GET_LEGACY_REGION GetLegacyRegion;\r |
| 2bbaeb0d |
1484 | \r |
| 1485 | ///\r |
| 1486 | /// Allows EFI to copy data to the area specified by GetLegacyRegion.\r |
| 1487 | ///\r |
| 79964ac8 |
1488 | EFI_LEGACY_BIOS_COPY_LEGACY_REGION CopyLegacyRegion;\r |
| 2bbaeb0d |
1489 | \r |
| 1490 | ///\r |
| 1491 | /// Allows the user to boot off an unconventional device such as a PARTIES partition.\r |
| 1492 | ///\r |
| 79964ac8 |
1493 | EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE BootUnconventionalDevice;\r |
| 1494 | };\r |
| 1495 | \r |
| 1496 | extern EFI_GUID gEfiLegacyBiosProtocolGuid;\r |
| 1497 | \r |
| 1498 | #endif\r |
projects / mirror_edk2.git / blame