the Legacy BIOS protocol is generic and consumes this protocol.\r
A driver that matches the Legacy16 produces this protocol\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
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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
@par Revision Reference:\r
This protocol is defined in Framework for EFI Compatibility Support Module spec\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// System ROM image for the platform\r
+ /// System ROM image for the platform.\r
/// \r
- /// TableSize Size of Table in bytes\r
+ /// TableSize Size of Table in bytes.\r
/// \r
- /// Location Ignored\r
+ /// Location Ignored.\r
/// \r
- /// Alignment Ignored\r
+ /// Alignment Ignored.\r
/// \r
- /// LegacySegment Ignored\r
+ /// LegacySegment Ignored.\r
/// \r
- /// LegacyOffset Ignored\r
+ /// LegacyOffset Ignored.\r
///\r
/// The return values associated with this mode are:\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Table System ROM image for the platform\r
+ /// Table System ROM image for the platform.\r
/// \r
- /// TableSize Size of Table in bytes\r
+ /// TableSize Size of Table in bytes.\r
/// \r
- /// Location Ignored\r
+ /// Location Ignored.\r
/// \r
- /// Alignment Ignored\r
+ /// Alignment Ignored.\r
/// \r
- /// LegacySegment Ignored\r
+ /// LegacySegment Ignored.\r
/// \r
- /// LegacyOffset Ignored\r
+ /// LegacyOffset Ignored.\r
///\r
/// The return values associated with this mode are:\r
///\r
} EFI_GET_PLATFORM_INFO_MODE;\r
\r
/**\r
- This enum specifies the Mode param values for GetPlatformHandle()\r
+ This enum specifies the Mode param values for GetPlatformHandle().\r
**/\r
typedef enum {\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0x00\r
+ /// Type 0x00.\r
///\r
/// HandleBuffer Buffer of all VGA handles found.\r
///\r
/// HandleCount Number of VGA handles found.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
/// \r
EfiGetPlatformVgaHandle = 0,\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0x00\r
+ /// Type 0x00.\r
///\r
/// HandleBuffer Buffer of all IDE handles found.\r
///\r
- /// HandleCount Number of IDE handles found\r
+ /// HandleCount Number of IDE handles found.\r
///\r
/// AdditionalData Pointer to HddInfo.\r
/// Information about all onboard IDE controllers.\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0x00\r
+ /// Type 0x00.\r
///\r
/// HandleBuffer Buffer of all ISA bus handles found.\r
///\r
/// HandleCount Number of ISA bus handles found.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
///\r
EfiGetPlatformIsaBusHandle = 2,\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0x00\r
+ /// Type 0x00.\r
///\r
/// HandleBuffer Buffer of all USB handles found.\r
///\r
/// HandleCount Number of USB bus handles found.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
///\r
EfiGetPlatformUsbHandle = 3\r
} EFI_GET_PLATFORM_HANDLE_MODE;\r
\r
/**\r
- This enum specifies the Mode param values for PlatformHooks()\r
- Note: Any OEM defined hooks start with 0x8000\r
+ This enum specifies the Mode param values for PlatformHooks().\r
+ Note: Any OEM defined hooks start with 0x8000.\r
**/\r
typedef enum {\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0\r
+ /// Type 0.\r
///\r
/// DeviceHandle Handle of device OpROM is associated with. \r
///\r
/// ShadowAddress Address where OpROM is shadowed.\r
///\r
- /// Compatibility16Table NULL\r
+ /// Compatibility16Table NULL.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
///\r
EfiPlatformHookPrepareToScanRom = 0,\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0\r
+ /// Type 0.\r
///\r
- /// DeviceHandle 0\r
+ /// DeviceHandle 0.\r
///\r
/// ShadowAddress First free OpROM area, after other OpROMs have been dispatched..\r
///\r
/// Compatibility16Table Pointer to the Compatability16 Table.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
///\r
EfiPlatformHookShadowServiceRoms= 1,\r
///\r
///\r
/// The function parameters associated with this mode are:\r
///\r
- /// Type 0\r
+ /// Type 0.\r
///\r
/// DeviceHandle Handle of device OpROM is associated with. \r
///\r
/// ShadowAddress Address where OpROM is shadowed.\r
///\r
- /// Compatibility16Table NULL\r
+ /// Compatibility16Table NULL.\r
///\r
- /// AdditionalData NULL\r
+ /// AdditionalData NULL.\r
/// \r
EfiPlatformHookAfterRomInit = 2\r
} EFI_GET_PLATFORM_HOOK_MODE;\r
/**\r
Finds the binary data or other platform information.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Mode Specifies what data to return. See See EFI_GET_PLATFORM_INFO_MODE enum.\r
@param Table Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
@param TableSize Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
@param LegacySegment Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
@param LegacyOffset Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
\r
- @retval EFI_SUCCESS Data was returned successfully.\r
+ @retval EFI_SUCCESS Data returned successfully.\r
@retval EFI_UNSUPPORTED Mode is not supported on the platform.\r
@retval EFI_NOT_FOUND Binary image or table not found.\r
\r
/**\r
Returns a buffer of handles for the requested subfunction.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Mode Specifies what handle to return. See EFI_GET_PLATFORM_HANDLE_MODE enum.\r
@param Type Mode specific. See EFI_GET_PLATFORM_HANDLE_MODE enum.\r
@param HandleBuffer Mode specific. See EFI_GET_PLATFORM_HANDLE_MODE enum.\r
@param HandleCount Mode specific. See EFI_GET_PLATFORM_HANDLE_MODE enum.\r
@param AdditionalData Mode specific. See EFI_GET_PLATFORM_HANDLE_MODE enum.\r
\r
- @retval EFI_SUCCESS Handle is valid\r
+ @retval EFI_SUCCESS Handle is valid.\r
@retval EFI_UNSUPPORTED Mode is not supported on the platform.\r
- @retval EFI_NOT_FOUND Handle is not known\r
+ @retval EFI_NOT_FOUND Handle is not known.\r
\r
**/\r
typedef\r
/**\r
Load and initialize the Legacy BIOS SMM handler.\r
\r
- @param This Protocol instance pointer.\r
- @param EfiToLegacy16BootTable Pointer to Legacy16 boot table.\r
+ @param This The protocol instance pointer.\r
+ @param EfiToLegacy16BootTable A pointer to Legacy16 boot table.\r
\r
@retval EFI_SUCCESS SMM code loaded.\r
@retval EFI_DEVICE_ERROR SMM code failed to load\r
Allows platform to perform any required action after a LegacyBios operation.\r
Invokes the specific sub function specified by Mode.\r
\r
- @param This Protocol instance pointer.\r
+ @param This The protocol instance pointer.\r
@param Mode Specifies what handle to return. See EFI_GET_PLATFORM_HOOK_MODE enum.\r
@param Type Mode specific. See EFI_GET_PLATFORM_HOOK_MODE enum.\r
@param DeviceHandle Mode specific. See EFI_GET_PLATFORM_HOOK_MODE enum.\r
@param Compatibility16Table Mode specific. See EFI_GET_PLATFORM_HOOK_MODE enum.\r
@param AdditionalData Mode specific. See EFI_GET_PLATFORM_HOOK_MODE enum.\r
\r
- @retval EFI_SUCCESS The operation performed successfully, Mode specific.\r
+ @retval EFI_SUCCESS The operation performed successfully. Mode specific.\r
@retval EFI_UNSUPPORTED Mode is not supported on the platform.\r
\r
**/\r
/**\r
Returns information associated with PCI IRQ routing.\r
This function returns the following information associated with PCI IRQ routing:\r
- * An IRQ routing table and number of entries in the table\r
- * The $PIR table and its size\r
- * A list of PCI IRQs and the priority order to assign them\r
+ * An IRQ routing table and number of entries in the table.\r
+ * The $PIR table and its size.\r
+ * A list of PCI IRQs and the priority order to assign them.\r
\r
- @param This Protocol instance pointer.\r
- @param RoutingTable Pointer to PCI IRQ Routing table. \r
+ @param This The protocol instance pointer.\r
+ @param RoutingTable The pointer to PCI IRQ Routing table. \r
This location is the $PIR table minus the header.\r
- @param RoutingTableEntries Number of entries in table.\r
- @param LocalPirqTable $PIR table\r
- @param PirqTableSize $PIR table size\r
- @param LocalIrqPriorityTable List of interrupts in priority order to assign\r
- @param IrqPriorityTableEntries Number of entries in priority table\r
+ @param RoutingTableEntries The number of entries in table.\r
+ @param LocalPirqTable $PIR table.\r
+ @param PirqTableSize $PIR table size.\r
+ @param LocalIrqPriorityTable A list of interrupts in priority order to assign.\r
+ @param IrqPriorityTableEntries The number of entries in the priority table.\r
\r
@retval EFI_SUCCESS Data was successfully returned.\r
\r
);\r
\r
/**\r
- Translates the given PIRQ accounting for bridge\r
+ Translates the given PIRQ accounting for bridge.\r
This function translates the given PIRQ back through all buses, if required, \r
and returns the true PIRQ and associated IRQ.\r
\r
- @param This Protocol instance pointer.\r
- @param PciBus PCI bus number for this device.\r
- @param PciDevice PCI device number for this device.\r
- @param PciFunction PCI function number for this device.\r
- @param Pirq Input is PIRQ reported by device, output is true PIRQ.\r
- @param PciIrq The IRQ already assigned to the PIRQ or the IRQ to be\r
+ @param This The protocol instance pointer.\r
+ @param PciBus The PCI bus number for this device.\r
+ @param PciDevice The PCI device number for this device.\r
+ @param PciFunction The PCI function number for this device.\r
+ @param Pirq Input is PIRQ reported by device, and output is true PIRQ.\r
+ @param PciIrq The IRQ already assigned to the PIRQ, or the IRQ to be\r
assigned to the PIRQ.\r
\r
@retval EFI_SUCCESS The PIRQ was translated.\r
Attempt to legacy boot the BootOption. If the EFI contexted has been\r
compromised this function will not return.\r
\r
- @param This Protocol instance pointer.\r
- @param BbsDevicePath EFI Device Path from BootXXXX variable.\r
- @param BbsTable Internal BBS table.\r
- @param LoadOptionSize Size of LoadOption in size.\r
- @param LoadOption LoadOption from BootXXXX variable\r
- @param EfiToLegacy16BootTable Pointer to BootTable structure\r
+ @param This The protocol instance pointer.\r
+ @param BbsDevicePath The EFI Device Path from BootXXXX variable.\r
+ @param BbsTable The Internal BBS table.\r
+ @param LoadOptionSize The size of LoadOption in size.\r
+ @param LoadOption The LoadOption from BootXXXX variable\r
+ @param EfiToLegacy16BootTable A pointer to BootTable structure\r
\r
@retval EFI_SUCCESS Ready to boot.\r
\r
projects / mirror_edk2.git / blobdiff