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
+ Thunk is the code that switches from 32-bit protected environment into the 16-bit real-mode\r
+ environment. Reverse thunk is the code that does the opposite.\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
+ Copyright (c) 2007 - 2010, 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
#define OEM_OWNER 0x1\r
///@}\r
\r
-/**\r
- * SMM_ENTRY\r
- *\r
- * This structure assumes both port and data sizes are 1. SmmAttribute must be\r
- * properly to reflect that assumption.\r
-**/\r
+///\r
+/// This structure assumes both port and data sizes are 1. SmmAttribute must be\r
+/// properly to reflect that assumption.\r
+///\r
typedef struct {\r
///\r
/// Describes the access mechanism, SmmPort, and SmmData sizes. Type\r
\r
typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r
\r
-//\r
-// Flags returned by CheckPciRom()\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
+#define ROM_WITH_CONFIG 0x04 ///< Not defined in the Framework CSM Specification\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
+///\r
+/// The following macros do not appear in the Framework CSM Specification and \r
+/// are kept for backward compatibility only. They convert 32-bit address (_Adr) \r
+/// to Segment:Offset 16-bit form.\r
+///\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
\r
#define CARRY_FLAG 0x01\r
\r
-//*********************************************************\r
-// EFI_EFLAGS_REG\r
-//*********************************************************\r
+///\r
+/// EFI_EFLAGS_REG\r
+///\r
typedef struct {\r
UINT32 CF:1;\r
UINT32 Reserved1:1;\r
UINT32 Reserved5:14;\r
} EFI_EFLAGS_REG;\r
\r
-//*********************************************************\r
-// EFI_DWORD_REGS\r
-//*********************************************************\r
-\r
+///\r
+/// EFI_DWORD_REGS\r
+///\r
typedef struct {\r
UINT32 EAX;\r
UINT32 EBX;\r
UINT32 ESP;\r
} EFI_DWORD_REGS;\r
\r
-//*******************************************\r
-// EFI_FLAGS_REG\r
-//*******************************************\r
+///\r
+/// EFI_FLAGS_REG\r
+///\r
typedef struct {\r
UINT16 CF:1;\r
UINT16 Reserved1:1;\r
UINT16 Reserved4:1;\r
} EFI_FLAGS_REG;\r
\r
-\r
-//*********************************************************\r
-// EFI_WORD_REGS\r
-//*********************************************************\r
-\r
+///\r
+/// EFI_WORD_REGS\r
+///\r
typedef struct {\r
UINT16 AX;\r
UINT16 ReservedAX;\r
UINT16 ReservedSP;\r
} EFI_WORD_REGS;\r
\r
-//*********************************************************\r
-// EFI_BYTE_REGS\r
-//*********************************************************\r
-\r
+///\r
+/// EFI_BYTE_REGS\r
+///\r
typedef struct {\r
UINT8 AL, AH;\r
UINT16 ReservedAX;\r
UINT16 ReservedDX;\r
} EFI_BYTE_REGS;\r
\r
+///\r
+/// EFI_IA32_REGISTER_SET\r
+///\r
typedef union {\r
EFI_DWORD_REGS E;\r
EFI_WORD_REGS X;\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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] BiosInt Processor interrupt vector to invoke\r
+ @param[in,out] Reg Register contexted passed into (and returned) from thunk to\r
+ 16-bit mode\r
\r
+ @retval TRUE Thunk completed with no BIOS errors in the target code. See Regs for status. \r
+ @retval FALSE There was a BIOS error in the target code.\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
+ IN EFI_LEGACY_BIOS_PROTOCOL *This,\r
+ IN UINT8 BiosInt,\r
+ IN OUT EFI_IA32_REGISTER_SET *Regs\r
);\r
\r
/**\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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] Segment Segemnt of 16-bit mode call\r
+ @param[in] Offset Offset of 16-bit mdoe call\r
+ @param[in] Reg Register contexted passed into (and returned) from thunk to\r
+ 16-bit mode\r
+ @param[in] Stack Caller allocated stack used to pass arguments\r
+ @param[in] StackSize Size of Stack in bytes\r
\r
+ @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
**/\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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] PciHandle The PCI PC-AT OPROM from this devices ROM BAR will be loaded\r
+ @param[out] RomImage Return the legacy PCI ROM for this device\r
+ @param[out] RomSize Size of ROM Image\r
+ @param[out] 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
+ @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
+ 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
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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] 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[in] 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[out] 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[out] DiskStart Disk number of first device hooked by the ROM. If DiskStart\r
+ is the same as DiskEnd no disked were hooked.\r
+ @param[out] DiskEnd disk number of the last device hooked by the ROM.\r
+ @param[out] RomShadowAddress Shadow address of PC-AT ROM\r
+ @param[out] 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
+ 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
+ been compromised, this function will not return. This procedure is not used for loading an EFI-aware\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
- 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
+ manner--meaning that the 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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] BootOption EFI Device Path from BootXXXX variable.\r
+ @param[in] LoadOptionSize Size of LoadOption in size.\r
+ @param[in] LoadOption LoadOption from BootXXXX variable\r
\r
+ @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
**/\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
+ 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
+ This function is normally called from EFI Setup drivers that handle user-selectable\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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] 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
+ @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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[out] HddCount Number of HDD_INFO structures\r
+ @param[out] HddInfo Onboard IDE controller information\r
+ @param[out] BbsCount Number of BBS_TABLE structures\r
+ @param[in,out] BbsTable Point to List of BBS_TABLE\r
\r
- @retval EFI_SUCCESS Tables returned\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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[out] BbsCount Number of BBS_TABLE structures\r
+ @param[out] BbsTable List BBS entries\r
\r
- @retval EFI_SUCCESS Drive numbers assigned\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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] Attributes How to interpret the other input parameters\r
+ @param[in] 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
+ @param[in] BeerData Pointer to the 128 bytes of ram BEER data.\r
+ @param[in] 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
+ @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
+ 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
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
+ @param[in] This Protocol instance pointer.\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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] LegacyMemorySize Size of required region\r
+ @param[in] Region Region to use.\r
+ 00 = Either 0xE0000 or 0xF0000 block\r
+ - Bit0 = 1 0xF0000 block\r
+ - Bit1 = 1 0xE0000 block\r
+ @param[in] Alignment Address alignment. Bit mapped. First non-zero\r
+ bit from right is alignment.\r
+ @param[out] LegacyMemoryAddress Region Assigned\r
\r
@retval EFI_SUCCESS Region assigned\r
@retval EFI_ACCESS_DENIED The function was previously invoked.\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
+ 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
+ @param[in] This Protocol instance pointer.\r
+ @param[in] LegacyMemorySize Size of data to copy\r
+ @param[in] LegacyMemoryAddress Legacy Region destination address\r
+ Note: must be in region assigned by\r
+ LegacyBiosGetLegacyRegion\r
+ @param[in] LegacyMemorySourceAddress Source of the data to copy.\r
\r
@retval EFI_SUCCESS Region assigned\r
@retval EFI_ACCESS_DENIED Destination outside assigned region\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
+ 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
+///\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
projects / mirror_edk2.git / blobdiff