EdkCompatibilityPkg/Foundation/Framework/Protocol/LegacyBios/LegacyBios.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   LegacyBios.h
  15
  16 Abstract:
  17
  18   The EFI Legacy BIOS Protocol is used to abstract legacy Option ROM usage
  19   under EFI and Legacy OS boot.
  20
  21   Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow
  22   well known naming conventions.
  23
  24   Thunk - A thunk is a transition from one processor mode to another. A Thunk
  25           is a transition from native EFI mode to 16-bit mode. A reverse thunk
  26           would be a transition from 16-bit mode to native EFI mode.
  27
  28
  29   Note: Note: Note: Note: Note: Note: Note:
  30
  31   You most likely should not use this protocol! Find the EFI way to solve the
  32   problem to make your code portable
  33
  34   Note: Note: Note: Note: Note: Note: Note:
  35
  36 Revision History
  37
  38   The EFI Legacy BIOS Protocol is compliant with CSM spec 0.96.
  39
  40 --*/
  41
  42 #ifndef _EFI_LEGACY_BIOS_H
  43 #define _EFI_LEGACY_BIOS_H
  44
  45 #define EFI_LEGACY_BIOS_PROTOCOL_GUID \
  46   { \
  47     0xdb9a1e3d, 0x45cb, 0x4abb, 0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d \
  48   }
  49
  50 EFI_FORWARD_DECLARATION (EFI_LEGACY_BIOS_PROTOCOL);
  51
  52 //
  53 // Convert from 32-bit address (_Adr) to Segment:Offset 16-bit form
  54 //
  55 #define EFI_SEGMENT(_Adr)     (UINT16) ((UINT16) (((UINTN) (_Adr)) >> 4) & 0xf000)
  56 #define EFI_OFFSET(_Adr)      (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xffff)
  57 #define BYTE_GRANULARITY      0x01
  58 #define WORD_GRANULARITY      0x02
  59 #define DWORD_GRANULARITY     0x04
  60 #define QWORD_GRANULARITY     0x08
  61 #define PARAGRAPH_GRANULARITY 0x10
  62
  63 #define CARRY_FLAG            0x01
  64
  65 typedef struct {
  66   UINT32 CF:1;
  67   UINT32 Reserved1:1;
  68   UINT32 PF:1;
  69   UINT32 Reserved2:1;
  70   UINT32 AF:1;
  71   UINT32 Reserved3:1;
  72   UINT32 ZF:1;
  73   UINT32 SF:1;
  74   UINT32 TF:1;
  75   UINT32 IF:1;
  76   UINT32 DF:1;
  77   UINT32 OF:1;
  78   UINT32 IOPL:2;
  79   UINT32 NT:1;
  80   UINT32 Reserved4:2;
  81   UINT32 VM:1;
  82   UINT32 Reserved5:14;
  83 } EFI_EFLAGS_REG;
  84
  85 typedef struct {
  86   UINT16  CF : 1;
  87   UINT16  Reserved1 : 1;
  88   UINT16  PF : 1;
  89   UINT16  Reserved2 : 1;
  90   UINT16  AF : 1;
  91   UINT16  Reserved3 : 1;
  92   UINT16  ZF : 1;
  93   UINT16  SF : 1;
  94   UINT16  TF : 1;
  95   UINT16  IF : 1;
  96   UINT16  DF : 1;
  97   UINT16  OF : 1;
  98   UINT16  IOPL : 2;
  99   UINT16  NT : 1;
 100   UINT16  Reserved4 : 1;
 101 } EFI_FLAGS_REG;
 102
 103 typedef struct {
 104   UINT32         EAX;
 105   UINT32         EBX;
 106   UINT32         ECX;
 107   UINT32         EDX;
 108   UINT32         ESI;
 109   UINT32         EDI;
 110   EFI_EFLAGS_REG EFlags;
 111   UINT16         ES;
 112   UINT16         CS;
 113   UINT16         SS;
 114   UINT16         DS;
 115   UINT16         FS;
 116   UINT16         GS;
 117   UINT32         EBP;
 118   UINT32         ESP;
 119 } EFI_DWORD_REGS;
 120
 121 typedef struct {
 122   UINT16        AX;
 123   UINT16        ReservedAX;
 124   UINT16        BX;
 125   UINT16        ReservedBX;
 126   UINT16        CX;
 127   UINT16        ReservedCX;
 128   UINT16        DX;
 129   UINT16        ReservedDX;
 130   UINT16        SI;
 131   UINT16        ReservedSI;
 132   UINT16        DI;
 133   UINT16        ReservedDI;
 134   EFI_FLAGS_REG Flags;
 135   UINT16        ReservedFlags;
 136   UINT16        ES;
 137   UINT16        CS;
 138   UINT16        SS;
 139   UINT16        DS;
 140   UINT16        FS;
 141   UINT16        GS;
 142   UINT16        BP;
 143   UINT16        ReservedBP;
 144   UINT16        SP;
 145   UINT16        ReservedSP;
 146 } EFI_WORD_REGS;
 147
 148 typedef struct {
 149   UINT8   AL;
 150   UINT8   AH;
 151   UINT16  ReservedAX;
 152   UINT8   BL;
 153   UINT8   BH;
 154   UINT16  ReservedBX;
 155   UINT8   CL;
 156   UINT8   CH;
 157   UINT16  ReservedCX;
 158   UINT8   DL;
 159   UINT8   DH;
 160   UINT16  ReservedDX;
 161 } EFI_BYTE_REGS;
 162
 163 typedef union {
 164   EFI_DWORD_REGS E;
 165   EFI_WORD_REGS  X;
 166   EFI_BYTE_REGS  H;
 167 } EFI_IA32_REGISTER_SET;
 168
 169 #pragma pack(1)
 170 //
 171 // $EFI table created by Legacy16 code and consumed by EFI Legacy driver
 172 //
 173 typedef struct {
 174   UINT32  Signature;      // "$EFI"
 175   UINT8   TableChecksum;
 176   UINT8   TableLength;
 177   UINT8   EfiMajorRevision;
 178   UINT8   EfiMinorRevision;
 179   UINT8   TableMajorRevision;
 180   UINT8   TableMinorRevision;
 181   UINT16  Reserved;
 182   UINT16  Compatibility16CallSegment;
 183   UINT16  Compatibility16CallOffset;
 184
 185   UINT16  PnPInstallationCheckSegment;
 186   UINT16  PnPInstallationCheckOffset;
 187
 188   UINT32  EfiSystemTable; // IPF - CSM Integration
 189   UINT32  OemIdStringPointer;
 190   UINT32  AcpiRsdPtrPointer;
 191   UINT16  OemRevision;
 192   UINT32  E820Pointer;
 193   UINT32  E820Length;
 194   UINT32  IrqRoutingTablePointer;
 195   UINT32  IrqRoutingTableLength;
 196   UINT32  MpTablePtr;
 197   UINT32  MpTableLength;
 198   UINT16  OemIntSegment;
 199   UINT16  OemIntOffset;
 200   UINT16  Oem32Segment;
 201   UINT16  Oem32Offset;
 202   UINT16  Oem16Segment;
 203   UINT16  Oem16Offset;
 204   UINT16  TpmSegment;
 205   UINT16  TpmOffset;
 206   UINT32  IbvPointer;
 207   UINT32  PciExpressBase;
 208   UINT8   LastPciBus;
 209
 210 } EFI_COMPATIBILITY16_TABLE;
 211 //
 212 // define maximum number of HDD system supports
 213 //
 214 #define MAX_HDD_ENTRIES 0x30
 215
 216 typedef struct {
 217   UINT16  Raw[256];
 218 } ATAPI_IDENTIFY;
 219
 220 //
 221 // HDD_INFO status
 222 //
 223 #define HDD_PRIMARY               0x01
 224 #define HDD_SECONDARY             0x02
 225 #define HDD_MASTER_ATAPI_CDROM    0x04
 226 #define HDD_SLAVE_ATAPI_CDROM     0x08
 227 #define HDD_MASTER_IDE            0x20
 228 #define HDD_SLAVE_IDE             0x40
 229 #define HDD_MASTER_ATAPI_ZIPDISK  0x10
 230 #define HDD_SLAVE_ATAPI_ZIPDISK   0x80
 231
 232 typedef struct {
 233   UINT16          Status;
 234   UINT32          Bus;
 235   UINT32          Device;
 236   UINT32          Function;
 237   UINT16          CommandBaseAddress;
 238   UINT16          ControlBaseAddress;
 239   UINT16          BusMasterAddress;
 240   UINT8           HddIrq;
 241   ATAPI_IDENTIFY  IdentifyDrive[2];
 242 } HDD_INFO;
 243
 244 //
 245 // Parties data structures
 246 //
 247 typedef struct {
 248   UINT8 DirectoryServiceValidity : 1;
 249   UINT8 RabcaUsedFlag : 1;
 250   UINT8 ExecuteHddDiagnosticsFlag : 1;
 251   UINT8 Reserved : 5;
 252 } UDC_ATTRIBUTES;
 253
 254 typedef struct {
 255   UDC_ATTRIBUTES  Attributes;
 256   UINT8           DeviceNumber;
 257   UINT8           BbsTableEntryNumberForParentDevice;
 258   UINT8           BbsTableEntryNumberForBoot;
 259   UINT8           BbsTableEntryNumberForHddDiag;
 260   UINT8           BeerData[128];
 261   UINT8           ServiceAreaData[64];
 262 } UD_TABLE;
 263
 264 //
 265 // define BBS Device Types
 266 //
 267 #define BBS_FLOPPY        0x01
 268 #define BBS_HARDDISK      0x02
 269 #define BBS_CDROM         0x03
 270 #define BBS_PCMCIA        0x04
 271 #define BBS_USB           0x05
 272 #define BBS_EMBED_NETWORK 0x06
 273 #define BBS_BEV_DEVICE    0x80
 274 #define BBS_UNKNOWN       0xff
 275
 276 typedef struct {
 277   UINT16  OldPosition : 4;
 278   UINT16  Reserved1 : 4;
 279   UINT16  Enabled : 1;
 280   UINT16  Failed : 1;
 281   UINT16  MediaPresent : 2;
 282   UINT16  Reserved2 : 4;
 283 } BBS_STATUS_FLAGS;
 284
 285 #define MAX_BBS_ENTRIES 0x100
 286 //
 287 // BBS_IGNORE_ENTRY is placed in the BootPriority field if the entry is to
 288 // be skipped.
 289 // BBS_UNPRIORITIZED_ENTRY is placed in the BootPriority field before
 290 // priority has been assigned but indicates valid entry.
 291 // BBS_LOWEST_PRIORITY is normally used for removable media with no media
 292 //   inserted. This allows the 16-bit CSM to allocate a drive letter to
 293 //   the device.
 294 // BBS_DO_NOT_BOOT_FROM is used for devices that the 16-bit CSM is to assign
 295 //   a drive letter to but never boot from.
 296 //
 297 // AdditionalIrq??Handler usage is IBV specific. The fields have been added
 298 // for:
 299 //   1. Saving non-BBS card info about IRQs taken by card.
 300 //   2. For BBS compliant cards that hook IRQs in order to have their SETUP
 301 //      executed.
 302 //
 303 #define BBS_DO_NOT_BOOT_FROM    0xFFFC
 304 #define BBS_LOWEST_PRIORITY     0xFFFD
 305 #define BBS_UNPRIORITIZED_ENTRY 0xFFFE
 306 #define BBS_IGNORE_ENTRY        0xFFFF
 307
 308 typedef struct {
 309   UINT16            BootPriority;
 310   UINT32            Bus;
 311   UINT32            Device;
 312   UINT32            Function;
 313   UINT8             Class;
 314   UINT8             SubClass;
 315   UINT16            MfgStringOffset;
 316   UINT16            MfgStringSegment;
 317   UINT16            DeviceType;
 318   BBS_STATUS_FLAGS  StatusFlags;
 319   UINT16            BootHandlerOffset;
 320   UINT16            BootHandlerSegment;
 321   UINT16            DescStringOffset;
 322   UINT16            DescStringSegment;
 323   UINT32            InitPerReserved;
 324   UINT32            AdditionalIrq13Handler;
 325   UINT32            AdditionalIrq18Handler;
 326   UINT32            AdditionalIrq19Handler;
 327   UINT32            AdditionalIrq40Handler;
 328   UINT8             AssignedDriveNumber;
 329   UINT32            AdditionalIrq41Handler;
 330   UINT32            AdditionalIrq46Handler;
 331   UINT32            IBV1;
 332   UINT32            IBV2;
 333 } BBS_TABLE;
 334
 335 #pragma pack()
 336
 337 typedef
 338 BOOLEAN
 339 (EFIAPI *EFI_LEGACY_BIOS_INT86) (
 340   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 341   IN  UINT8                           BiosInt,
 342   IN OUT  EFI_IA32_REGISTER_SET       * Regs
 343   )
 344 /*++
 345
 346   Routine Description:
 347     Thunk to 16-bit real mode and execute a software interrupt with a vector
 348     of BiosInt. Regs will contain the 16-bit register context on entry and
 349     exit.
 350
 351   Arguments:
 352     This    - Protocol instance pointer.
 353     BiosInt - Processor interrupt vector to invoke
 354     Reg     - Register contexted passed into (and returned) from thunk to
 355               16-bit mode
 356
 357   Returns:
 358     FALSE   - Thunk completed, and there were no BIOS errors in the target code.
 359               See Regs for status.
 360     TRUE    - There was a BIOS erro in the target code.
 361
 362 --*/
 363 ;
 364
 365 typedef
 366 BOOLEAN
 367 (EFIAPI *EFI_LEGACY_BIOS_FARCALL86) (
 368   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 369   IN  UINT16                          Segment,
 370   IN  UINT16                          Offset,
 371   IN  EFI_IA32_REGISTER_SET           * Regs,
 372   IN  VOID                            *Stack,
 373   IN  UINTN                           StackSize
 374   )
 375 /*++
 376
 377   Routine Description:
 378     Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the
 379     16-bit register context on entry and exit. Arguments can be passed on
 380     the Stack argument
 381
 382   Arguments:
 383     This      - Protocol instance pointer.
 384     Segment   - Segemnt of 16-bit mode call
 385     Offset    - Offset of 16-bit mdoe call
 386     Reg       - Register contexted passed into (and returned) from thunk to
 387                 16-bit mode
 388     Stack     - Caller allocated stack used to pass arguments
 389     StackSize - Size of Stack in bytes
 390
 391   Returns:
 392     FALSE     - Thunk completed, and there were no BIOS errors in the target code.
 393                 See Regs for status.
 394     TRUE      - There was a BIOS erro in the target code.
 395
 396 --*/
 397 ;
 398
 399 typedef
 400 EFI_STATUS
 401 (EFIAPI *EFI_LEGACY_BIOS_CHECK_ROM) (
 402   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 403   IN  EFI_HANDLE                      PciHandle,
 404   OUT VOID                            **RomImage, OPTIONAL
 405   OUT UINTN                           *RomSize, OPTIONAL
 406   OUT UINTN                           *Flags
 407
 408   )
 409 /*++
 410
 411   Routine Description:
 412     Test to see if a legacy PCI ROM exists for this device. Optionally return
 413     the Legacy ROM instance for this PCI device.
 414
 415   Arguments:
 416     This      - Protocol instance pointer.
 417     PciHandle - The PCI PC-AT OPROM from this devices ROM BAR will be loaded
 418     RomImage  - Return the legacy PCI ROM for this device
 419     RomSize   - Size of ROM Image
 420     Flags     - Indicates if ROM found and if PC-AT.
 421
 422   Returns:
 423     EFI_SUCCESS  - Legacy Option ROM availible for this device
 424     EFI_UNSUPPORTED  - Legacy Option ROM not supported.
 425
 426 --*/
 427 ;
 428
 429 typedef
 430 EFI_STATUS
 431 (EFIAPI *EFI_LEGACY_BIOS_INSTALL_ROM) (
 432   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 433   IN  EFI_HANDLE                      PciHandle,
 434   IN  VOID                            **RomImage,
 435   OUT UINTN                           *Flags,
 436   OUT UINT8                           *DiskStart, OPTIONAL
 437   OUT UINT8                           *DiskEnd, OPTIONAL
 438   OUT VOID                            **RomShadowAddress, OPTIONAL
 439   OUT UINT32                          *ShadowedRomSize OPTIONAL
 440   )
 441 /*++
 442
 443   Routine Description:
 444     Load a legacy PC-AT OPROM on the PciHandle device. Return information
 445     about how many disks were added by the OPROM and the shadow address and
 446     size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:
 447
 448   Arguments:
 449     This      - Protocol instance pointer.
 450     PciHandle - The PCI PC-AT OPROM from this devices ROM BAR will be loaded.
 451                 This value is NULL if RomImage is non-NULL. This is the normal
 452                 case.
 453     RomImage  - A PCI PC-AT ROM image. This argument is non-NULL if there is
 454                 no hardware associated with the ROM and thus no PciHandle,
 455                 otherwise is must be NULL.
 456                 Example is PXE base code.
 457     Flags     - Return Status if ROM was found and if was Legacy OPROM.
 458     DiskStart - Disk number of first device hooked by the ROM. If DiskStart
 459                 is the same as DiskEnd no disked were hooked.
 460     DiskEnd   - Disk number of the last device hooked by the ROM.
 461     RomShadowAddress  - Shadow address of PC-AT ROM
 462     RomShadowSize     - Size of RomShadowAddress in bytes
 463
 464   Returns:
 465     EFI_SUCCESS  - Thunk completed, see Regs for status.
 466     EFI_INVALID_PARAMETER  - PciHandle not found
 467
 468 --*/
 469 ;
 470
 471 typedef
 472 EFI_STATUS
 473 (EFIAPI *EFI_LEGACY_BIOS_BOOT) (
 474   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 475   IN  BBS_BBS_DEVICE_PATH             * BootOption,
 476   IN  UINT32                          LoadOptionsSize,
 477   IN  VOID                            *LoadOptions
 478   )
 479 /*++
 480
 481   Routine Description:
 482     Attempt to legacy boot the BootOption. If the EFI contexted has been
 483     compromised this function will not return.
 484
 485   Arguments:
 486     This       - Protocol instance pointer.
 487     BootOption - EFI Device Path from BootXXXX variable.
 488     LoadOptionSize  - Size of LoadOption in size.
 489     LoadOption      - LoadOption from BootXXXX variable
 490
 491   Returns:
 492     EFI_SUCCESS  - Removable media not present
 493
 494 --*/
 495 ;
 496 typedef
 497 EFI_STATUS
 498 (EFIAPI *EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS) (
 499   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 500   IN  UINT8                           Leds
 501   )
 502 /*++
 503
 504   Routine Description:
 505     Update BDA with current Scroll, Num & Cap lock LEDS
 506
 507   Arguments:
 508     This       - Protocol instance pointer.
 509     Leds       - Status of current Scroll, Num & Cap lock LEDS
 510                  Bit 0 is Scroll Lock  0 = Not locked
 511                  Bit 1 is Num Lock
 512                  Bit 2 is Caps Lock
 513
 514   Returns:
 515     EFI_SUCCESS  - Removable media not present
 516
 517 --*/
 518 ;
 519
 520 typedef
 521 EFI_STATUS
 522 (EFIAPI *EFI_LEGACY_BIOS_GET_BBS_INFO) (
 523   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 524   OUT UINT16                          *HddCount,
 525   OUT HDD_INFO                        **HddInfo,
 526   OUT UINT16                          *BbsCount,
 527   IN OUT BBS_TABLE                    **BbsTable
 528   )
 529 /*++
 530
 531   Routine Description:
 532     Retrieve legacy BBS info and assign boot priority.
 533
 534   Arguments:
 535     This       - Protocol instance pointer.
 536     HddCount   - Number of HDD_INFO structures
 537     HddInfo    - Onboard IDE controller information
 538     BbsCount   - Number of BBS_TABLE structures
 539     BbsTable   - List BBS entries
 540
 541   Returns:
 542     EFI_SUCCESS  - Tables returned
 543
 544 --*/
 545 ;
 546
 547 typedef
 548 EFI_STATUS
 549 (EFIAPI *EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI) (
 550   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 551   OUT UINT16                          *BbsCount,
 552   OUT BBS_TABLE                       **BbsTable
 553   )
 554 /*++
 555
 556   Routine Description:
 557     Assign drive number to legacy HDD drives prior to booting an EFI
 558     aware OS so the OS can access drives without an EFI driver.
 559
 560   Arguments:
 561     This       - Protocol instance pointer.
 562     BbsCount   - Number of BBS_TABLE structures
 563     BbsTable   - List BBS entries
 564
 565   Returns:
 566     EFI_SUCCESS  - Drive numbers assigned
 567
 568 --*/
 569 ;
 570
 571 typedef
 572 EFI_STATUS
 573 (EFIAPI *EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE) (
 574   IN EFI_LEGACY_BIOS_PROTOCOL         * This,
 575   IN UDC_ATTRIBUTES                   Attributes,
 576   IN UINTN                            BbsEntry,
 577   IN VOID                             *BeerData,
 578   IN VOID                             *ServiceAreaData
 579   )
 580 /*++
 581
 582   Routine Description:
 583     To boot from an unconventional device like parties and/or execute
 584     HDD diagnostics.
 585
 586   Arguments:
 587     This            - Protocol instance pointer.
 588     Attributes      - How to interpret the other input parameters
 589     BbsEntry        - The 0-based index into the BbsTable for the parent
 590                       device.
 591     BeerData        - Pointer to the 128 bytes of ram BEER data.
 592     ServiceAreaData - Pointer to the 64 bytes of raw Service Area data. The
 593                       caller must provide a pointer to the specific Service
 594                       Area and not the start all Service Areas.
 595   Returns:
 596     EFI_INVALID_PARAMETER if error. Does NOT return if no error.
 597
 598 --*/
 599 ;
 600
 601 typedef
 602 EFI_STATUS
 603 (EFIAPI *EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS) (
 604   IN EFI_LEGACY_BIOS_PROTOCOL * This
 605   )
 606 /*++
 607
 608   Routine Description:
 609     Shadow all legacy16 OPROMs that haven't been shadowed.
 610     Warning: Use this with caution. This routine disconnects all EFI
 611              drivers. If used externally then caller must re-connect EFI
 612              drivers.
 613   Arguments:
 614
 615   Returns:
 616     EFI_SUCCESS  - OPROMs shadowed
 617
 618 --*/
 619 ;
 620
 621 typedef
 622 EFI_STATUS
 623 (EFIAPI *EFI_LEGACY_BIOS_GET_LEGACY_REGION) (
 624   IN EFI_LEGACY_BIOS_PROTOCOL * This,
 625   IN    UINTN                 LegacyMemorySize,
 626   IN    UINTN                 Region,
 627   IN    UINTN                 Alignment,
 628   OUT   VOID                  **LegacyMemoryAddress
 629   )
 630 /*++
 631
 632 Routine Description:
 633   Get a region from the LegacyBios for S3 usage.
 634
 635 Arguments:
 636     This                   - Protocol instance pointer.
 637     LegacyMemorySize     - Size of required region
 638     Region                 - Region to use.
 639                                  00 = Either 0xE0000 or 0xF0000 block
 640                                  Bit0 = 1 0xF0000 block
 641                                  Bit1 = 1 0xE0000 block
 642     Alignment             - Address alignment. Bit mapped. First non-zero
 643                             bit from right is alignment.
 644     LegacyMemoryAddress  - Region Assigned
 645
 646 Returns:
 647
 648   EFI_SUCCESS - Region assigned
 649
 650   Other       - Region not assigned
 651
 652 --*/
 653 ;
 654
 655 typedef
 656 EFI_STATUS
 657 (EFIAPI *EFI_LEGACY_BIOS_COPY_LEGACY_REGION) (
 658   IN EFI_LEGACY_BIOS_PROTOCOL * This,
 659   IN    UINTN                 LegacyMemorySize,
 660   IN    VOID                  *LegacyMemoryAddress,
 661   IN    VOID                  *LegacyMemorySourceAddress
 662   )
 663 /*++
 664
 665 Routine Description:
 666   Get a region from the LegacyBios for Tiano usage. Can only be invoked once.
 667
 668 Arguments:
 669     This                         - Protocol instance pointer.
 670     LegacyMemorySize             - Size of data to copy
 671     LegacyMemoryAddress          - Legacy Region destination address
 672                                    Note: must be in region assigned by
 673                                          LegacyBiosGetLegacyRegion
 674     LegacyMemorySourceAddress    - Source of data
 675
 676 Returns:
 677
 678   EFI_SUCCESS        - Region assigned
 679   EFI_ACCESS_DENIED  - Destination outside assigned region
 680
 681 --*/
 682 ;
 683
 684 typedef struct _EFI_LEGACY_BIOS_PROTOCOL {
 685   EFI_LEGACY_BIOS_INT86                       Int86;
 686   EFI_LEGACY_BIOS_FARCALL86                   FarCall86;
 687   EFI_LEGACY_BIOS_CHECK_ROM                   CheckPciRom;
 688   EFI_LEGACY_BIOS_INSTALL_ROM                 InstallPciRom;
 689   EFI_LEGACY_BIOS_BOOT                        LegacyBoot;
 690   EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS  UpdateKeyboardLedStatus;
 691   EFI_LEGACY_BIOS_GET_BBS_INFO                GetBbsInfo;
 692   EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS    ShadowAllLegacyOproms;
 693   EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI         PrepareToBootEfi;
 694   EFI_LEGACY_BIOS_GET_LEGACY_REGION           GetLegacyRegion;
 695   EFI_LEGACY_BIOS_COPY_LEGACY_REGION          CopyLegacyRegion;
 696   EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE  BootUnconventionalDevice;
 697 } EFI_LEGACY_BIOS_PROTOCOL;
 698
 699 extern EFI_GUID gEfiLegacyBiosProtocolGuid;
 700
 701 #endif