[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyBios.h

/** @file\r
  The EFI Legacy BIOS Protocol is used to abstract legacy Option ROM usage\r
  under EFI and Legacy OS boot.\r
\r
  Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow\r
  well known naming conventions.\r
\r
  Thunk - A thunk is a transition from one processor mode to another. A Thunk\r
  is a transition from native EFI mode to 16-bit mode. A reverse thunk\r
  would be a transition from 16-bit mode to native EFI mode.\r
\r
  You most likely should not use this protocol! Find the EFI way to solve the\r
  problem to make your code portable\r
\r
  Copyright (c) 2007 - 2009, Intel Corporation\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
  Module Name:  LegacyBios.h\r
\r
  @par Revision Reference:\r
  This protocol is defined in Framework for EFI Compatibility Support Module spec\r
  Version 0.97.\r
\r
**/\r
\r
#ifndef _EFI_LEGACY_BIOS_H_\r
#define _EFI_LEGACY_BIOS_H_\r
\r
#include <Framework/Legacy16.h>\r
\r
#define EFI_LEGACY_BIOS_PROTOCOL_GUID \\r
  { \\r
    0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d } \\r
  }\r
\r
typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r
\r
//\r
// Flags returned by CheckPciRom()\r
//\r
#define NO_ROM            0x00\r
#define ROM_FOUND         0x01\r
#define VALID_LEGACY_ROM  0x02\r
#define ROM_WITH_CONFIG   0x04     // Not defined in CSM Specification0.96\r
\r
//\r
/// @bug These macros appear in no specifications and are kept for backward\r
//        compatibility only.\r
// Convert from 32-bit address (_Adr) to Segment:Offset 16-bit form\r
//\r
#define EFI_SEGMENT(_Adr)     (UINT16) ((UINT16) (((UINTN) (_Adr)) >> 4) & 0xf000)\r
#define EFI_OFFSET(_Adr)      (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xffff)\r
#define BYTE_GRANULARITY      0x01\r
#define WORD_GRANULARITY      0x02\r
#define DWORD_GRANULARITY     0x04\r
#define QWORD_GRANULARITY     0x08\r
#define PARAGRAPH_GRANULARITY 0x10\r
\r
#define CARRY_FLAG            0x01\r
\r
//*********************************************************\r
// EFI_EFLAGS_REG\r
//*********************************************************\r
typedef struct {\r
  UINT32 CF:1;\r
  UINT32 Reserved1:1;\r
  UINT32 PF:1;\r
  UINT32 Reserved2:1;\r
  UINT32 AF:1;\r
  UINT32 Reserved3:1;\r
  UINT32 ZF:1;\r
  UINT32 SF:1;\r
  UINT32 TF:1;\r
  UINT32 IF:1;\r
  UINT32 DF:1;\r
  UINT32 OF:1;\r
  UINT32 IOPL:2;\r
  UINT32 NT:1;\r
  UINT32 Reserved4:2;\r
  UINT32 VM:1;\r
  UINT32 Reserved5:14;\r
} EFI_EFLAGS_REG;\r
\r
//*********************************************************\r
// EFI_DWORD_REGS\r
//*********************************************************\r
\r
typedef struct {\r
    UINT32           EAX;\r
    UINT32           EBX;\r
    UINT32           ECX;\r
    UINT32           EDX;\r
    UINT32           ESI;\r
    UINT32           EDI;\r
    EFI_EFLAGS_REG   EFlags;\r
    UINT16           ES;\r
    UINT16           CS;\r
    UINT16           SS;\r
    UINT16           DS;\r
    UINT16           FS;\r
    UINT16           GS;\r
    UINT32           EBP;\r
    UINT32           ESP;\r
} EFI_DWORD_REGS;\r
\r
//*******************************************\r
// EFI_FLAGS_REG\r
//*******************************************\r
typedef struct {\r
  UINT16     CF:1;\r
  UINT16     Reserved1:1;\r
  UINT16     PF:1;\r
  UINT16     Reserved2:1;\r
  UINT16     AF:1;\r
  UINT16     Reserved3:1;\r
  UINT16     ZF:1;\r
  UINT16     SF:1;\r
  UINT16     TF:1;\r
  UINT16     IF:1;\r
  UINT16     DF:1;\r
  UINT16     OF:1;\r
  UINT16     IOPL:2;\r
  UINT16     NT:1;\r
  UINT16     Reserved4:1;\r
} EFI_FLAGS_REG;\r
\r
\r
//*********************************************************\r
// EFI_WORD_REGS\r
//*********************************************************\r
\r
typedef struct {\r
    UINT16           AX;\r
    UINT16           ReservedAX;\r
    UINT16           BX;\r
    UINT16           ReservedBX;\r
    UINT16           CX;\r
    UINT16           ReservedCX;\r
    UINT16           DX;\r
    UINT16           ReservedDX;\r
    UINT16           SI;\r
    UINT16           ReservedSI;\r
    UINT16           DI;\r
    UINT16           ReservedDI;\r
    EFI_FLAGS_REG    Flags;\r
    UINT16           ReservedFlags;\r
    UINT16           ES;\r
    UINT16           CS;\r
    UINT16           SS;\r
    UINT16           DS;\r
    UINT16           FS;\r
    UINT16           GS;\r
    UINT16           BP;\r
    UINT16           ReservedBP;\r
    UINT16           SP;\r
    UINT16           ReservedSP;\r
} EFI_WORD_REGS;\r
\r
//*********************************************************\r
// EFI_BYTE_REGS\r
//*********************************************************\r
\r
typedef struct {\r
    UINT8   AL, AH;\r
    UINT16  ReservedAX;\r
    UINT8   BL, BH;\r
    UINT16  ReservedBX;\r
    UINT8   CL, CH;\r
    UINT16  ReservedCX;\r
    UINT8   DL, DH;\r
    UINT16  ReservedDX;\r
} EFI_BYTE_REGS;\r
\r
typedef union {\r
  EFI_DWORD_REGS  E;\r
  EFI_WORD_REGS   X;\r
  EFI_BYTE_REGS   H;\r
} EFI_IA32_REGISTER_SET;\r
\r
/**\r
  Thunk to 16-bit real mode and execute a software interrupt with a vector\r
  of BiosInt. Regs will contain the 16-bit register context on entry and\r
  exit.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  BiosInt               Processor interrupt vector to invoke\r
  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
                                16-bit mode\r
\r
  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
                                See Regs for status.\r
  @retval TRUE                  There was a BIOS erro in the target code.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *EFI_LEGACY_BIOS_INT86)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  UINT8                           BiosInt,\r
  IN OUT  EFI_IA32_REGISTER_SET       *Regs\r
  );\r
\r
/**\r
  Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
  16-bit register context on entry and exit. Arguments can be passed on\r
  the Stack argument\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  Segment               Segemnt of 16-bit mode call\r
  @param  Offset                Offset of 16-bit mdoe call\r
  @param  Reg                   Register contexted passed into (and returned) from thunk to\r
                                16-bit mode\r
  @param  Stack                 Caller allocated stack used to pass arguments\r
  @param  StackSize             Size of Stack in bytes\r
\r
  @retval FALSE                 Thunk completed, and there were no BIOS errors in the target code.\r
                                See Regs for status.\r
  @retval TRUE                  There was a BIOS erro in the target code.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *EFI_LEGACY_BIOS_FARCALL86)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  UINT16                          Segment,\r
  IN  UINT16                          Offset,\r
  IN  EFI_IA32_REGISTER_SET           *Regs,\r
  IN  VOID                            *Stack,\r
  IN  UINTN                           StackSize\r
  );\r
\r
/**\r
  Test to see if a legacy PCI ROM exists for this device. Optionally return\r
  the Legacy ROM instance for this PCI device.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
  @param  RomImage              Return the legacy PCI ROM for this device\r
  @param  RomSize               Size of ROM Image\r
  @param  Flags                 Indicates if ROM found and if PC-AT. Multiple bits can be set as follows:\r
                                00 = No ROM\r
                                01 = ROM Found\r
                                02 = ROM is a valid legacy ROM\r
\r
  @retval EFI_SUCCESS           Legacy Option ROM availible for this device\r
  @retval EFI_UNSUPPORTED       Legacy Option ROM not supported.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_CHECK_ROM)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  EFI_HANDLE                      PciHandle,\r
  OUT VOID                            **RomImage, OPTIONAL\r
  OUT UINTN                           *RomSize, OPTIONAL\r
  OUT UINTN                           *Flags\r
  );\r
\r
/**\r
  Load a legacy PC-AT OPROM on the PciHandle device. Return information\r
  about how many disks were added by the OPROM and the shadow address and\r
  size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  PciHandle             The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
                                This value is NULL if RomImage is non-NULL. This is the normal\r
                                case.\r
  @param  RomImage              A PCI PC-AT ROM image. This argument is non-NULL if there is\r
                                no hardware associated with the ROM and thus no PciHandle,\r
                                otherwise is must be NULL.\r
                                Example is PXE base code.\r
  @param  Flags                 The type of ROM discovered. Multiple bits can be set, as follows:\r
                                00 = No ROM.\r
                                01 = ROM found.\r
                                02 = ROM is a valid legacy ROM.\r
  @param  DiskStart             Disk number of first device hooked by the ROM. If DiskStart\r
                                is the same as DiskEnd no disked were hooked.\r
  @param  DiskEnd               Disk number of the last device hooked by the ROM.\r
  @param  RomShadowAddress      Shadow address of PC-AT ROM\r
  @param  RomShadowSize         Size of RomShadowAddress in bytes\r
\r
  @retval EFI_SUCCESS           Thunk completed, see Regs for status.\r
  @retval EFI_INVALID_PARAMETER PciHandle not found\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_INSTALL_ROM)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  EFI_HANDLE                      PciHandle,\r
  IN  VOID                            **RomImage,\r
  OUT UINTN                           *Flags,\r
  OUT UINT8                           *DiskStart, OPTIONAL\r
  OUT UINT8                           *DiskEnd, OPTIONAL\r
  OUT VOID                            **RomShadowAddress, OPTIONAL\r
  OUT UINT32                          *ShadowedRomSize OPTIONAL\r
  );\r
\r
/**\r
  This function attempts to traditionally boot the specified BootOption. If the EFI context has\r
  been compromised, this function will not return. This procedure is not used for loading an EFIaware\r
  OS off a traditional device. The following actions occur:\r
  - Get EFI SMBIOS data structures, convert them to a traditional format, and copy to\r
    Compatibility16.\r
  - Get a pointer to ACPI data structures and copy the Compatibility16 RSD PTR to F0000 block.\r
  - Find the traditional SMI handler from a firmware volume and register the traditional SMI\r
    handler with the EFI SMI handler.\r
  - Build onboard IDE information and pass this information to the Compatibility16 code.\r
  - Make sure all PCI Interrupt Line registers are programmed to match 8259.\r
  - Reconfigure SIO devices from EFI mode (polled) into traditional mode (interrupt driven).\r
  - Shadow all PCI ROMs.\r
  - Set up BDA and EBDA standard areas before the legacy boot.\r
  - Construct the Compatibility16 boot memory map and pass it to the Compatibility16 code.\r
  - Invoke the Compatibility16 table function Compatibility16PrepareToBoot(). This\r
    invocation causes a thunk into the Compatibility16 code, which sets all appropriate internal\r
    data structures. The boot device list is a parameter.\r
  - Invoke the Compatibility16 Table function Compatibility16Boot(). This invocation\r
    causes a thunk into the Compatibility16 code, which does an INT19.\r
  - If the Compatibility16Boot() function returns, then the boot failed in a graceful\r
    manner—i.e., EFI code is still valid. An ungraceful boot failure causes a reset because the state\r
    of EFI code is unknown.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  BootOption            EFI Device Path from BootXXXX variable.\r
  @param  LoadOptionSize        Size of LoadOption in size.\r
  @param  LoadOption            LoadOption from BootXXXX variable\r
\r
  @retval EFI_DEVICE_ERROR      Failed to boot from any boot device and memory is uncorrupted.\r
                                Note: This function normally never returns. It will either boot the\r
                                OS or reset the system if memory has been "corrupted" by loading\r
                                a boot sector and passing control to it.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_BOOT)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  BBS_BBS_DEVICE_PATH             *BootOption,\r
  IN  UINT32                          LoadOptionsSize,\r
  IN  VOID                            *LoadOptions\r
  );\r
\r
/**\r
  This function takes the Leds input parameter and sets/resets the BDA accordingly. \r
  Leds is also passed to Compatibility16 code, in case any special processing is required. \r
  This function is normally called from EFI Setup drivers that handle userselectable\r
  keyboard options such as boot with NUM LOCK on/off. This function does not\r
  touch the keyboard or keyboard LEDs but only the BDA.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  Leds                  Status of current Scroll, Num & Cap lock LEDS\r
                                Bit 0 is Scroll Lock 0 = Not locked\r
                                Bit 1 is Num Lock\r
                                Bit 2 is Caps Lock\r
\r
  @retval EFI_SUCCESS           The BDA was updated successfully.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN  UINT8                           Leds\r
  );\r
\r
/**\r
  Retrieve legacy BBS info and assign boot priority.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  HddCount              Number of HDD_INFO structures\r
  @param  HddInfo               Onboard IDE controller information\r
  @param  BbsCount              Number of BBS_TABLE structures\r
  @param  BbsTable              Point to List of BBS_TABLE\r
\r
  @retval EFI_SUCCESS           Tables returned\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_GET_BBS_INFO)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  OUT UINT16                          *HddCount,\r
  OUT HDD_INFO                        **HddInfo,\r
  OUT UINT16                          *BbsCount,\r
  IN OUT BBS_TABLE                    **BbsTable\r
  );\r
\r
/**\r
  Assign drive number to legacy HDD drives prior to booting an EFI\r
  aware OS so the OS can access drives without an EFI driver.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  BbsCount              Number of BBS_TABLE structures\r
  @param  BbsTable              List BBS entries\r
\r
  @retval EFI_SUCCESS           Drive numbers assigned\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  OUT UINT16                          *BbsCount,\r
  OUT BBS_TABLE                       **BbsTable\r
  );\r
\r
/**\r
  To boot from an unconventional device like parties and/or execute\r
  HDD diagnostics.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  Attributes            How to interpret the other input parameters\r
  @param  BbsEntry              The 0-based index into the BbsTable for the parent\r
                                device.\r
  @param  BeerData              Pointer to the 128 bytes of ram BEER data.\r
  @param  ServiceAreaData       Pointer to the 64 bytes of raw Service Area data. The\r
                                caller must provide a pointer to the specific Service\r
                                Area and not the start all Service Areas.\r
\r
  @retval EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL         *This,\r
  IN UDC_ATTRIBUTES                   Attributes,\r
  IN UINTN                            BbsEntry,\r
  IN VOID                             *BeerData,\r
  IN VOID                             *ServiceAreaData\r
  );\r
\r
/**\r
  Shadow all legacy16 OPROMs that haven't been shadowed.\r
  Warning: Use this with caution. This routine disconnects all EFI\r
  drivers. If used externally then caller must re-connect EFI\r
  drivers.\r
\r
  @retval EFI_SUCCESS           OPROMs shadowed\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL *This\r
  );\r
\r
/**\r
  Get a region from the LegacyBios for S3 usage.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  LegacyMemorySize      Size of required region\r
  @param  Region                Region to use.\r
                                00 = Either 0xE0000 or 0xF0000 block\r
                                Bit0 = 1 0xF0000 block\r
                                Bit1 = 1 0xE0000 block\r
  @param  Alignment             Address alignment. Bit mapped. First non-zero\r
                                bit from right is alignment.\r
  @param  LegacyMemoryAddress   Region Assigned\r
\r
  @retval EFI_SUCCESS           Region assigned\r
  @retval EFI_ACCESS_DENIED     The function was previously invoked.\r
  @retval Other                 Region not assigned\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_GET_LEGACY_REGION)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
  IN    UINTN                 LegacyMemorySize,\r
  IN    UINTN                 Region,\r
  IN    UINTN                 Alignment,\r
  OUT   VOID                  **LegacyMemoryAddress\r
  );\r
\r
/**\r
  Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
\r
  @param  This                  Protocol instance pointer.\r
  @param  LegacyMemorySize      Size of data to copy\r
  @param  LegacyMemoryAddress   Legacy Region destination address\r
                                Note: must be in region assigned by\r
                                LegacyBiosGetLegacyRegion\r
  @param  LegacyMemorySourceAddress\r
                                Source of the data to copy.\r
\r
  @retval EFI_SUCCESS           Region assigned\r
  @retval EFI_ACCESS_DENIED     Destination outside assigned region\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_LEGACY_BIOS_COPY_LEGACY_REGION)(\r
  IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
  IN    UINTN                 LegacyMemorySize,\r
  IN    VOID                  *LegacyMemoryAddress,\r
  IN    VOID                  *LegacyMemorySourceAddress\r
  );\r
\r
/**\r
  Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()\r
  member function allows the BDS to support booting a traditional OS.\r
  EFI thunks drivers that make EFI bindings for BIOS INT services use\r
  all the other member functions.\r
**/\r
struct _EFI_LEGACY_BIOS_PROTOCOL {\r
  ///\r
  /// Performs traditional software INT. See the Int86() function description.\r
  ///\r
  EFI_LEGACY_BIOS_INT86                       Int86;\r
  \r
  ///\r
  /// Performs a far call into Compatibility16 or traditional OpROM code.\r
  ///\r
  EFI_LEGACY_BIOS_FARCALL86                   FarCall86;\r
  \r
  ///\r
  /// Checks if a traditional OpROM exists for this device.\r
  ///\r
  EFI_LEGACY_BIOS_CHECK_ROM                   CheckPciRom;\r
  \r
  ///\r
  /// Loads a traditional OpROM in traditional OpROM address space.\r
  ///\r
  EFI_LEGACY_BIOS_INSTALL_ROM                 InstallPciRom;\r
  \r
  ///\r
  /// Boots a traditional OS.\r
  ///\r
  EFI_LEGACY_BIOS_BOOT                        LegacyBoot;\r
  \r
  ///\r
  /// Updates BDA to reflect the current EFI keyboard LED status.\r
  ///\r
  EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS  UpdateKeyboardLedStatus;\r
  \r
  ///\r
  /// Allows an external agent, such as BIOS Setup, to get the BBS data.\r
  ///\r
  EFI_LEGACY_BIOS_GET_BBS_INFO                GetBbsInfo;\r
  \r
  ///\r
  /// Causes all legacy OpROMs to be shadowed.\r
  ///\r
  EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS    ShadowAllLegacyOproms;\r
  \r
  ///\r
  /// Performs all actions prior to boot. Used when booting an EFI-aware OS\r
  /// rather than a legacy OS.  \r
  ///\r
  EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI         PrepareToBootEfi;\r
  \r
  ///\r
  /// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
  ///\r
  EFI_LEGACY_BIOS_GET_LEGACY_REGION           GetLegacyRegion;\r
  \r
  ///\r
  /// Allows EFI to copy data to the area specified by GetLegacyRegion.\r
  ///\r
  EFI_LEGACY_BIOS_COPY_LEGACY_REGION          CopyLegacyRegion;\r
  \r
  ///\r
  /// Allows the user to boot off an unconventional device such as a PARTIES partition.\r
  ///\r
  EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE  BootUnconventionalDevice;\r
};\r
\r
extern EFI_GUID gEfiLegacyBiosProtocolGuid;\r
\r
#endif\r
Commit	Line	Data
79964ac8	1	/** @file\r
	2	The EFI Legacy BIOS Protocol is used to abstract legacy Option ROM usage\r
	3	under EFI and Legacy OS boot.\r
	4	\r
	5	Note: The names for EFI_IA32_REGISTER_SET elements were picked to follow\r
	6	well known naming conventions.\r
	7	\r
	8	Thunk - A thunk is a transition from one processor mode to another. A Thunk\r
	9	is a transition from native EFI mode to 16-bit mode. A reverse thunk\r
	10	would be a transition from 16-bit mode to native EFI mode.\r
	11	\r
	12	You most likely should not use this protocol! Find the EFI way to solve the\r
	13	problem to make your code portable\r
	14	\r
2bbaeb0d	15	Copyright (c) 2007 - 2009, Intel Corporation\r
79964ac8	16	All rights reserved. This program and the accompanying materials\r
	17	are licensed and made available under the terms and conditions of the BSD License\r
	18	which accompanies this distribution. The full text of the license may be found at\r
	19	http://opensource.org/licenses/bsd-license.php\r
	20	\r
	21	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	22	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	23	\r
	24	Module Name: LegacyBios.h\r
	25	\r
	26	@par Revision Reference:\r
	27	This protocol is defined in Framework for EFI Compatibility Support Module spec\r
0f899407	28	Version 0.97.\r
79964ac8	29	\r
	30	**/\r
	31	\r
	32	#ifndef _EFI_LEGACY_BIOS_H_\r
	33	#define _EFI_LEGACY_BIOS_H_\r
	34	\r
0e0eeeca	35	#include <Framework/Legacy16.h>\r
b80fbe85	36	\r
79964ac8	37	#define EFI_LEGACY_BIOS_PROTOCOL_GUID \\r
	38	{ \\r
	39	0xdb9a1e3d, 0x45cb, 0x4abb, {0x85, 0x3b, 0xe5, 0x38, 0x7f, 0xdb, 0x2e, 0x2d } \\r
	40	}\r
	41	\r
	42	typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r
	43	\r
9226e4ee	44	//\r
	45	// Flags returned by CheckPciRom()\r
	46	//\r
	47	#define NO_ROM 0x00\r
	48	#define ROM_FOUND 0x01\r
	49	#define VALID_LEGACY_ROM 0x02\r
	50	#define ROM_WITH_CONFIG 0x04 // Not defined in CSM Specification0.96\r
	51	\r
79964ac8	52	//\r
4ebb0d9e	53	/// @bug These macros appear in no specifications and are kept for backward\r
79964ac8	54	// compatibility only.\r
	55	// Convert from 32-bit address (_Adr) to Segment:Offset 16-bit form\r
	56	//\r
	57	#define EFI_SEGMENT(_Adr) (UINT16) ((UINT16) (((UINTN) (_Adr)) >> 4) & 0xf000)\r
	58	#define EFI_OFFSET(_Adr) (UINT16) (((UINT16) ((UINTN) (_Adr))) & 0xffff)\r
	59	#define BYTE_GRANULARITY 0x01\r
	60	#define WORD_GRANULARITY 0x02\r
	61	#define DWORD_GRANULARITY 0x04\r
	62	#define QWORD_GRANULARITY 0x08\r
	63	#define PARAGRAPH_GRANULARITY 0x10\r
	64	\r
	65	#define CARRY_FLAG 0x01\r
	66	\r
	67	//*********************************************************\r
	68	// EFI_EFLAGS_REG\r
	69	//*********************************************************\r
	70	typedef struct {\r
	71	UINT32 CF:1;\r
	72	UINT32 Reserved1:1;\r
	73	UINT32 PF:1;\r
	74	UINT32 Reserved2:1;\r
	75	UINT32 AF:1;\r
	76	UINT32 Reserved3:1;\r
	77	UINT32 ZF:1;\r
	78	UINT32 SF:1;\r
	79	UINT32 TF:1;\r
	80	UINT32 IF:1;\r
	81	UINT32 DF:1;\r
	82	UINT32 OF:1;\r
	83	UINT32 IOPL:2;\r
	84	UINT32 NT:1;\r
	85	UINT32 Reserved4:2;\r
	86	UINT32 VM:1;\r
	87	UINT32 Reserved5:14;\r
	88	} EFI_EFLAGS_REG;\r
	89	\r
	90	//*********************************************************\r
	91	// EFI_DWORD_REGS\r
	92	//*********************************************************\r
	93	\r
	94	typedef struct {\r
	95	UINT32 EAX;\r
	96	UINT32 EBX;\r
	97	UINT32 ECX;\r
	98	UINT32 EDX;\r
	99	UINT32 ESI;\r
	100	UINT32 EDI;\r
	101	EFI_EFLAGS_REG EFlags;\r
	102	UINT16 ES;\r
	103	UINT16 CS;\r
	104	UINT16 SS;\r
	105	UINT16 DS;\r
	106	UINT16 FS;\r
	107	UINT16 GS;\r
	108	UINT32 EBP;\r
	109	UINT32 ESP;\r
	110	} EFI_DWORD_REGS;\r
	111	\r
	112	//*******************************************\r
	113	// EFI_FLAGS_REG\r
	114	//*******************************************\r
	115	typedef struct {\r
	116	UINT16 CF:1;\r
	117	UINT16 Reserved1:1;\r
118	UINT16 PF:1;\r
119	UINT16 Reserved2:1;\r
120	UINT16 AF:1;\r
121	UINT16 Reserved3:1;\r
122	UINT16 ZF:1;\r
123	UINT16 SF:1;\r
124	UINT16 TF:1;\r
125	UINT16 IF:1;\r
126	UINT16 DF:1;\r
127	UINT16 OF:1;\r
128	UINT16 IOPL:2;\r
129	UINT16 NT:1;\r
130	UINT16 Reserved4:1;\r
131	} EFI_FLAGS_REG;\r
132	\r
133	\r
134	//*********************************************************\r
135	// EFI_WORD_REGS\r
136	//*********************************************************\r
137	\r
138	typedef struct {\r
139	UINT16 AX;\r
140	UINT16 ReservedAX;\r
141	UINT16 BX;\r
142	UINT16 ReservedBX;\r
143	UINT16 CX;\r
144	UINT16 ReservedCX;\r
145	UINT16 DX;\r
146	UINT16 ReservedDX;\r
147	UINT16 SI;\r
148	UINT16 ReservedSI;\r
149	UINT16 DI;\r
150	UINT16 ReservedDI;\r
151	EFI_FLAGS_REG Flags;\r
152	UINT16 ReservedFlags;\r
153	UINT16 ES;\r
154	UINT16 CS;\r
155	UINT16 SS;\r
156	UINT16 DS;\r
157	UINT16 FS;\r
158	UINT16 GS;\r
159	UINT16 BP;\r
160	UINT16 ReservedBP;\r
161	UINT16 SP;\r
162	UINT16 ReservedSP;\r
163	} EFI_WORD_REGS;\r
164	\r
165	//*********************************************************\r
166	// EFI_BYTE_REGS\r
167	//*********************************************************\r
168	\r
169	typedef struct {\r
170	UINT8 AL, AH;\r
171	UINT16 ReservedAX;\r
172	UINT8 BL, BH;\r
173	UINT16 ReservedBX;\r
174	UINT8 CL, CH;\r
175	UINT16 ReservedCX;\r
176	UINT8 DL, DH;\r
177	UINT16 ReservedDX;\r
178	} EFI_BYTE_REGS;\r
179	\r
180	typedef union {\r
181	EFI_DWORD_REGS E;\r
182	EFI_WORD_REGS X;\r
183	EFI_BYTE_REGS H;\r
184	} EFI_IA32_REGISTER_SET;\r
185	\r
186	/**\r
187	Thunk to 16-bit real mode and execute a software interrupt with a vector\r
188	of BiosInt. Regs will contain the 16-bit register context on entry and\r
189	exit.\r
190	\r
191	@param This Protocol instance pointer.\r
192	@param BiosInt Processor interrupt vector to invoke\r
193	@param Reg Register contexted passed into (and returned) from thunk to\r
194	16-bit mode\r
195	\r
196	@retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
197	See Regs for status.\r
198	@retval TRUE There was a BIOS erro in the target code.\r
199	\r
200	**/\r
201	typedef\r
202	BOOLEAN\r
69686d56	203	(EFIAPI *EFI_LEGACY_BIOS_INT86)(\r
79964ac8	204	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	205	IN UINT8 BiosInt,\r
	206	IN OUT EFI_IA32_REGISTER_SET *Regs\r
	207	);\r
	208	\r
	209	/**\r
	210	Thunk to 16-bit real mode and call Segment:Offset. Regs will contain the\r
	211	16-bit register context on entry and exit. Arguments can be passed on\r
	212	the Stack argument\r
	213	\r
	214	@param This Protocol instance pointer.\r
	215	@param Segment Segemnt of 16-bit mode call\r
	216	@param Offset Offset of 16-bit mdoe call\r
	217	@param Reg Register contexted passed into (and returned) from thunk to\r
	218	16-bit mode\r
	219	@param Stack Caller allocated stack used to pass arguments\r
	220	@param StackSize Size of Stack in bytes\r
	221	\r
	222	@retval FALSE Thunk completed, and there were no BIOS errors in the target code.\r
	223	See Regs for status.\r
	224	@retval TRUE There was a BIOS erro in the target code.\r
	225	\r
	226	**/\r
	227	typedef\r
	228	BOOLEAN\r
69686d56	229	(EFIAPI *EFI_LEGACY_BIOS_FARCALL86)(\r
79964ac8	230	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	231	IN UINT16 Segment,\r
	232	IN UINT16 Offset,\r
	233	IN EFI_IA32_REGISTER_SET *Regs,\r
	234	IN VOID *Stack,\r
	235	IN UINTN StackSize\r
	236	);\r
	237	\r
	238	/**\r
	239	Test to see if a legacy PCI ROM exists for this device. Optionally return\r
	240	the Legacy ROM instance for this PCI device.\r
	241	\r
	242	@param This Protocol instance pointer.\r
	243	@param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
	244	@param RomImage Return the legacy PCI ROM for this device\r
	245	@param RomSize Size of ROM Image\r
ef1ac015	246	@param Flags Indicates if ROM found and if PC-AT. Multiple bits can be set as follows:\r
	247	00 = No ROM\r
	248	01 = ROM Found\r
	249	02 = ROM is a valid legacy ROM\r
79964ac8	250	\r
	251	@retval EFI_SUCCESS Legacy Option ROM availible for this device\r
	252	@retval EFI_UNSUPPORTED Legacy Option ROM not supported.\r
	253	\r
	254	**/\r
	255	typedef\r
	256	EFI_STATUS\r
69686d56	257	(EFIAPI *EFI_LEGACY_BIOS_CHECK_ROM)(\r
79964ac8	258	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	259	IN EFI_HANDLE PciHandle,\r
	260	OUT VOID **RomImage, OPTIONAL\r
	261	OUT UINTN *RomSize, OPTIONAL\r
	262	OUT UINTN *Flags\r
	263	);\r
	264	\r
	265	/**\r
	266	Load a legacy PC-AT OPROM on the PciHandle device. Return information\r
	267	about how many disks were added by the OPROM and the shadow address and\r
	268	size. DiskStart & DiskEnd are INT 13h drive letters. Thus 0x80 is C:\r
	269	\r
	270	@param This Protocol instance pointer.\r
	271	@param PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded.\r
	272	This value is NULL if RomImage is non-NULL. This is the normal\r
	273	case.\r
	274	@param RomImage A PCI PC-AT ROM image. This argument is non-NULL if there is\r
	275	no hardware associated with the ROM and thus no PciHandle,\r
	276	otherwise is must be NULL.\r
	277	Example is PXE base code.\r
ef1ac015	278	@param Flags The type of ROM discovered. Multiple bits can be set, as follows:\r
	279	00 = No ROM.\r
	280	01 = ROM found.\r
	281	02 = ROM is a valid legacy ROM.\r
79964ac8	282	@param DiskStart Disk number of first device hooked by the ROM. If DiskStart\r
	283	is the same as DiskEnd no disked were hooked.\r
	284	@param DiskEnd Disk number of the last device hooked by the ROM.\r
	285	@param RomShadowAddress Shadow address of PC-AT ROM\r
	286	@param RomShadowSize Size of RomShadowAddress in bytes\r
	287	\r
	288	@retval EFI_SUCCESS Thunk completed, see Regs for status.\r
	289	@retval EFI_INVALID_PARAMETER PciHandle not found\r
	290	\r
	291	**/\r
	292	typedef\r
	293	EFI_STATUS\r
69686d56	294	(EFIAPI *EFI_LEGACY_BIOS_INSTALL_ROM)(\r
79964ac8	295	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	296	IN EFI_HANDLE PciHandle,\r
	297	IN VOID **RomImage,\r
	298	OUT UINTN *Flags,\r
	299	OUT UINT8 *DiskStart, OPTIONAL\r
	300	OUT UINT8 *DiskEnd, OPTIONAL\r
	301	OUT VOID **RomShadowAddress, OPTIONAL\r
	302	OUT UINT32 *ShadowedRomSize OPTIONAL\r
	303	);\r
	304	\r
	305	/**\r
ef1ac015	306	This function attempts to traditionally boot the specified BootOption. If the EFI context has\r
	307	been compromised, this function will not return. This procedure is not used for loading an EFIaware\r
	308	OS off a traditional device. The following actions occur:\r
	309	- Get EFI SMBIOS data structures, convert them to a traditional format, and copy to\r
	310	Compatibility16.\r
	311	- Get a pointer to ACPI data structures and copy the Compatibility16 RSD PTR to F0000 block.\r
	312	- Find the traditional SMI handler from a firmware volume and register the traditional SMI\r
	313	handler with the EFI SMI handler.\r
	314	- Build onboard IDE information and pass this information to the Compatibility16 code.\r
	315	- Make sure all PCI Interrupt Line registers are programmed to match 8259.\r
	316	- Reconfigure SIO devices from EFI mode (polled) into traditional mode (interrupt driven).\r
	317	- Shadow all PCI ROMs.\r
	318	- Set up BDA and EBDA standard areas before the legacy boot.\r
	319	- Construct the Compatibility16 boot memory map and pass it to the Compatibility16 code.\r
	320	- Invoke the Compatibility16 table function Compatibility16PrepareToBoot(). This\r
	321	invocation causes a thunk into the Compatibility16 code, which sets all appropriate internal\r
	322	data structures. The boot device list is a parameter.\r
	323	- Invoke the Compatibility16 Table function Compatibility16Boot(). This invocation\r
	324	causes a thunk into the Compatibility16 code, which does an INT19.\r
	325	- If the Compatibility16Boot() function returns, then the boot failed in a graceful\r
	326	manner—i.e., EFI code is still valid. An ungraceful boot failure causes a reset because the state\r
	327	of EFI code is unknown.\r
79964ac8	328	\r
	329	@param This Protocol instance pointer.\r
	330	@param BootOption EFI Device Path from BootXXXX variable.\r
	331	@param LoadOptionSize Size of LoadOption in size.\r
	332	@param LoadOption LoadOption from BootXXXX variable\r
	333	\r
ef1ac015	334	@retval EFI_DEVICE_ERROR Failed to boot from any boot device and memory is uncorrupted.\r
	335	Note: This function normally never returns. It will either boot the\r
	336	OS or reset the system if memory has been "corrupted" by loading\r
	337	a boot sector and passing control to it.\r
79964ac8	338	\r
	339	**/\r
	340	typedef\r
	341	EFI_STATUS\r
69686d56	342	(EFIAPI *EFI_LEGACY_BIOS_BOOT)(\r
79964ac8	343	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	344	IN BBS_BBS_DEVICE_PATH *BootOption,\r
	345	IN UINT32 LoadOptionsSize,\r
	346	IN VOID *LoadOptions\r
	347	);\r
	348	\r
	349	/**\r
ef1ac015	350	This function takes the Leds input parameter and sets/resets the BDA accordingly. \r
	351	Leds is also passed to Compatibility16 code, in case any special processing is required. \r
	352	This function is normally called from EFI Setup drivers that handle userselectable\r
	353	keyboard options such as boot with NUM LOCK on/off. This function does not\r
	354	touch the keyboard or keyboard LEDs but only the BDA.\r
79964ac8	355	\r
	356	@param This Protocol instance pointer.\r
	357	@param Leds Status of current Scroll, Num & Cap lock LEDS\r
	358	Bit 0 is Scroll Lock 0 = Not locked\r
	359	Bit 1 is Num Lock\r
	360	Bit 2 is Caps Lock\r
	361	\r
ef1ac015	362	@retval EFI_SUCCESS The BDA was updated successfully.\r
79964ac8	363	\r
	364	**/\r
	365	typedef\r
	366	EFI_STATUS\r
69686d56	367	(EFIAPI *EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS)(\r
79964ac8	368	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	369	IN UINT8 Leds\r
	370	);\r
	371	\r
	372	/**\r
	373	Retrieve legacy BBS info and assign boot priority.\r
	374	\r
	375	@param This Protocol instance pointer.\r
	376	@param HddCount Number of HDD_INFO structures\r
	377	@param HddInfo Onboard IDE controller information\r
	378	@param BbsCount Number of BBS_TABLE structures\r
ef1ac015	379	@param BbsTable Point to List of BBS_TABLE\r
79964ac8	380	\r
	381	@retval EFI_SUCCESS Tables returned\r
	382	\r
	383	**/\r
	384	typedef\r
	385	EFI_STATUS\r
69686d56	386	(EFIAPI *EFI_LEGACY_BIOS_GET_BBS_INFO)(\r
79964ac8	387	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	388	OUT UINT16 *HddCount,\r
	389	OUT HDD_INFO **HddInfo,\r
	390	OUT UINT16 *BbsCount,\r
	391	IN OUT BBS_TABLE **BbsTable\r
	392	);\r
	393	\r
	394	/**\r
	395	Assign drive number to legacy HDD drives prior to booting an EFI\r
	396	aware OS so the OS can access drives without an EFI driver.\r
	397	\r
	398	@param This Protocol instance pointer.\r
	399	@param BbsCount Number of BBS_TABLE structures\r
	400	@param BbsTable List BBS entries\r
	401	\r
	402	@retval EFI_SUCCESS Drive numbers assigned\r
	403	\r
	404	**/\r
	405	typedef\r
	406	EFI_STATUS\r
69686d56	407	(EFIAPI *EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI)(\r
79964ac8	408	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	409	OUT UINT16 *BbsCount,\r
	410	OUT BBS_TABLE **BbsTable\r
	411	);\r
	412	\r
	413	/**\r
	414	To boot from an unconventional device like parties and/or execute\r
	415	HDD diagnostics.\r
	416	\r
	417	@param This Protocol instance pointer.\r
	418	@param Attributes How to interpret the other input parameters\r
	419	@param BbsEntry The 0-based index into the BbsTable for the parent\r
	420	device.\r
	421	@param BeerData Pointer to the 128 bytes of ram BEER data.\r
	422	@param ServiceAreaData Pointer to the 64 bytes of raw Service Area data. The\r
	423	caller must provide a pointer to the specific Service\r
	424	Area and not the start all Service Areas.\r
	425	\r
ef1ac015	426	@retval EFI_INVALID_PARAMETER if error. Does NOT return if no error.\r
79964ac8	427	\r
	428	**/\r
	429	typedef\r
	430	EFI_STATUS\r
69686d56	431	(EFIAPI *EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE)(\r
79964ac8	432	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	433	IN UDC_ATTRIBUTES Attributes,\r
	434	IN UINTN BbsEntry,\r
	435	IN VOID *BeerData,\r
	436	IN VOID *ServiceAreaData\r
	437	);\r
	438	\r
	439	/**\r
	440	Shadow all legacy16 OPROMs that haven't been shadowed.\r
	441	Warning: Use this with caution. This routine disconnects all EFI\r
	442	drivers. If used externally then caller must re-connect EFI\r
	443	drivers.\r
	444	\r
	445	@retval EFI_SUCCESS OPROMs shadowed\r
	446	\r
	447	**/\r
	448	typedef\r
	449	EFI_STATUS\r
69686d56	450	(EFIAPI *EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS)(\r
79964ac8	451	IN EFI_LEGACY_BIOS_PROTOCOL *This\r
	452	);\r
	453	\r
	454	/**\r
	455	Get a region from the LegacyBios for S3 usage.\r
	456	\r
	457	@param This Protocol instance pointer.\r
	458	@param LegacyMemorySize Size of required region\r
	459	@param Region Region to use.\r
	460	00 = Either 0xE0000 or 0xF0000 block\r
	461	Bit0 = 1 0xF0000 block\r
	462	Bit1 = 1 0xE0000 block\r
	463	@param Alignment Address alignment. Bit mapped. First non-zero\r
	464	bit from right is alignment.\r
	465	@param LegacyMemoryAddress Region Assigned\r
	466	\r
	467	@retval EFI_SUCCESS Region assigned\r
ef1ac015	468	@retval EFI_ACCESS_DENIED The function was previously invoked.\r
79964ac8	469	@retval Other Region not assigned\r
	470	\r
	471	**/\r
	472	typedef\r
	473	EFI_STATUS\r
69686d56	474	(EFIAPI *EFI_LEGACY_BIOS_GET_LEGACY_REGION)(\r
79964ac8	475	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	476	IN UINTN LegacyMemorySize,\r
	477	IN UINTN Region,\r
	478	IN UINTN Alignment,\r
	479	OUT VOID **LegacyMemoryAddress\r
	480	);\r
	481	\r
	482	/**\r
	483	Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
	484	\r
	485	@param This Protocol instance pointer.\r
	486	@param LegacyMemorySize Size of data to copy\r
	487	@param LegacyMemoryAddress Legacy Region destination address\r
	488	Note: must be in region assigned by\r
	489	LegacyBiosGetLegacyRegion\r
	490	@param LegacyMemorySourceAddress\r
ef1ac015	491	Source of the data to copy.\r
79964ac8	492	\r
	493	@retval EFI_SUCCESS Region assigned\r
	494	@retval EFI_ACCESS_DENIED Destination outside assigned region\r
	495	\r
	496	**/\r
	497	typedef\r
	498	EFI_STATUS\r
69686d56	499	(EFIAPI *EFI_LEGACY_BIOS_COPY_LEGACY_REGION)(\r
79964ac8	500	IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
	501	IN UINTN LegacyMemorySize,\r
	502	IN VOID *LegacyMemoryAddress,\r
	503	IN VOID *LegacyMemorySourceAddress\r
	504	);\r
	505	\r
	506	/**\r
79964ac8	507	Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()\r
	508	member function allows the BDS to support booting a traditional OS.\r
	509	EFI thunks drivers that make EFI bindings for BIOS INT services use\r
	510	all the other member functions.\r
79964ac8	511	**/\r
79964ac8	512	struct _EFI_LEGACY_BIOS_PROTOCOL {\r
2bbaeb0d	513	///\r
	514	/// Performs traditional software INT. See the Int86() function description.\r
	515	///\r
79964ac8	516	EFI_LEGACY_BIOS_INT86 Int86;\r
2bbaeb0d	517	\r
	518	///\r
	519	/// Performs a far call into Compatibility16 or traditional OpROM code.\r
	520	///\r
79964ac8	521	EFI_LEGACY_BIOS_FARCALL86 FarCall86;\r
2bbaeb0d	522	\r
	523	///\r
	524	/// Checks if a traditional OpROM exists for this device.\r
	525	///\r
79964ac8	526	EFI_LEGACY_BIOS_CHECK_ROM CheckPciRom;\r
2bbaeb0d	527	\r
	528	///\r
	529	/// Loads a traditional OpROM in traditional OpROM address space.\r
	530	///\r
79964ac8	531	EFI_LEGACY_BIOS_INSTALL_ROM InstallPciRom;\r
2bbaeb0d	532	\r
	533	///\r
	534	/// Boots a traditional OS.\r
	535	///\r
79964ac8	536	EFI_LEGACY_BIOS_BOOT LegacyBoot;\r
2bbaeb0d	537	\r
	538	///\r
	539	/// Updates BDA to reflect the current EFI keyboard LED status.\r
	540	///\r
79964ac8	541	EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS UpdateKeyboardLedStatus;\r
2bbaeb0d	542	\r
	543	///\r
	544	/// Allows an external agent, such as BIOS Setup, to get the BBS data.\r
	545	///\r
79964ac8	546	EFI_LEGACY_BIOS_GET_BBS_INFO GetBbsInfo;\r
2bbaeb0d	547	\r
	548	///\r
	549	/// Causes all legacy OpROMs to be shadowed.\r
	550	///\r
79964ac8	551	EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS ShadowAllLegacyOproms;\r
2bbaeb0d	552	\r
	553	///\r
	554	/// Performs all actions prior to boot. Used when booting an EFI-aware OS\r
	555	/// rather than a legacy OS. \r
	556	///\r
79964ac8	557	EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI PrepareToBootEfi;\r
2bbaeb0d	558	\r
	559	///\r
	560	/// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
	561	///\r
79964ac8	562	EFI_LEGACY_BIOS_GET_LEGACY_REGION GetLegacyRegion;\r
2bbaeb0d	563	\r
	564	///\r
	565	/// Allows EFI to copy data to the area specified by GetLegacyRegion.\r
	566	///\r
79964ac8	567	EFI_LEGACY_BIOS_COPY_LEGACY_REGION CopyLegacyRegion;\r
2bbaeb0d	568	\r
	569	///\r
	570	/// Allows the user to boot off an unconventional device such as a PARTIES partition.\r
	571	///\r
79964ac8	572	EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE BootUnconventionalDevice;\r
	573	};\r
	574	\r
	575	extern EFI_GUID gEfiLegacyBiosProtocolGuid;\r
	576	\r
	577	#endif\r