typedef enum {\r
///\r
/// This mode is invoked twice. The first invocation has LegacySegment and\r
- /// LegacyOffset set to 0. The mode returns the MP table address in EFI memory and its size.\r
+ /// LegacyOffset set to 0. The mode returns the MP table address in EFI memory, along with its size.\r
/// The second invocation has LegacySegment and LegacyOffset set to the location\r
/// in the 0xF0000 or 0xE0000 block to which the MP table is to be copied. The second\r
- /// invocation allows any MP table address fix ups to occur in the EFI memory copy of the\r
+ /// invocation allows any MP table address fixes to occur in the EFI memory copy of the\r
/// MP table. The caller, not EfiGetPlatformBinaryMpTable, copies the modified MP\r
/// table to the allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r
///\r
/// Bit 1 = 1 0xE0000 64 KB block.\r
/// Multiple bits can be set.\r
///\r
- /// Alignment Bit mapped address alignment granularity. \r
+ /// Alignment Bit-mapped address alignment granularity. \r
/// The first nonzero bit from the right is the address granularity.\r
///\r
- // LegacySegment Segment where EfiCompatibility code will place the MP table.\r
+ // LegacySegment Segment in which EfiCompatibility code will place the MP table.\r
///\r
- /// LegacyOffset Offset where EfiCompatibility code will place the MP table.\r
+ /// LegacyOffset Offset in which EfiCompatibility code will place the MP table.\r
///\r
/// The return values associated with this mode are:\r
///\r
///\r
EfiGetPlatformBinaryMpTable = 0,\r
///\r
- /// This mode returns a block of data. The contents and usage is IBV or OEM defined.\r
+ /// This mode returns a block of data. The content and usage is IBV or OEM defined.\r
/// OEMs or IBVs normally use this function for nonstandard Compatibility16 runtime soft\r
/// INTs. It is the responsibility of this routine to coalesce multiple OEM 16 bit functions, if\r
/// they exist, into one coherent package that is understandable by the Compatibility16 code.\r
/// This function is invoked twice. The first invocation has LegacySegment and\r
- /// LegacyOffset set to 0. The function returns the table address in EFI memory and its size.\r
+ /// LegacyOffset set to 0. The function returns the table address in EFI memory, as well as its size.\r
/// The second invocation has LegacySegment and LegacyOffset set to the location\r
/// in the 0xF0000 or 0xE0000 block to which the data (table) is to be copied. The second\r
- /// invocation allows any data (table) address fix ups to occur in the EFI memory copy of\r
+ /// invocation allows any data (table) address fixes to occur in the EFI memory copy of\r
/// the table. The caller, not GetOemIntData(), copies the modified data (table) to the\r
/// allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r
///\r
/// Alignment Bit mapped address alignment granularity. \r
/// The first nonzero bit from the right is the address granularity.\r
///\r
- /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r
+ /// LegacySegment Segment in which EfiCompatibility code will place the table or data.\r
///\r
- /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r
+ /// LegacyOffset Offset in which EfiCompatibility code will place the table or data.\r
///\r
/// The return values associated with this mode are:\r
///\r
///\r
EfiGetPlatformBinaryOemIntData = 1,\r
///\r
- /// This mode returns a block of data. The contents and usage is IBV defined. OEMs or\r
+ /// This mode returns a block of data. The content and usage is IBV defined. OEMs or\r
/// IBVs normally use this mode for nonstandard Compatibility16 runtime 16 bit routines. It\r
/// is the responsibility of this routine to coalesce multiple OEM 16 bit functions, if they\r
/// exist, into one coherent package that is understandable by the Compatibility16 code.\r
- /// An example usage might be a legacy mobile BIOS that has a pre existing runtime\r
+ /// \r
+ /// Example usage: A legacy mobile BIOS that has a pre-existing runtime\r
/// interface to return the battery status to calling applications.\r
+ ///\r
/// This mode is invoked twice. The first invocation has LegacySegment and\r
/// LegacyOffset set to 0. The mode returns the table address in EFI memory and its size.\r
/// The second invocation has LegacySegment and LegacyOffset set to the location\r
/// in the 0xF0000 or 0xE0000 block to which the table is to be copied. The second\r
- /// invocation allows any table address fix ups to occur in the EFI memory copy of the table.\r
+ /// invocation allows any table address fixes to occur in the EFI memory copy of the table.\r
/// The caller, not EfiGetPlatformBinaryOem16Data, copies the modified table to\r
/// the allocated region in 0xF0000 or 0xE0000 block after the second invocation.\r
///\r
/// Alignment Bit mapped address alignment granularity. \r
/// The first nonzero bit from the right is the address granularity.\r
///\r
- /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r
+ /// LegacySegment Segment in which EfiCompatibility code will place the table or data.\r
///\r
- /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r
+ /// LegacyOffset Offset in which EfiCompatibility code will place the table or data.\r
///\r
/// The return values associated with this mode are:\r
///\r
///\r
EfiGetPlatformBinaryOem16Data = 2,\r
///\r
-/// This mode returns a block of data. The contents and usage is IBV defined. OEMs or\r
+/// This mode returns a block of data. The content and usage are IBV defined. OEMs or\r
/// IBVs normally use this mode for nonstandard Compatibility16 runtime 32 bit routines. It\r
/// is the responsibility of this routine to coalesce multiple OEM 32 bit functions, if they\r
/// exist, into one coherent package that is understandable by the Compatibility16 code.\r
-/// An example usage might be a legacy mobile BIOS that has a pre existing runtime\r
+/// \r
+/// Example usage: A legacy mobile BIOS that has a pre existing runtime\r
/// interface to return the battery status to calling applications.\r
+///\r
/// This mode is invoked twice. The first invocation has LegacySegment and\r
/// LegacyOffset set to 0. The mode returns the table address in EFI memory and its size.\r
/// \r
/// Alignment Bit mapped address alignment granularity. \r
/// The first nonzero bit from the right is the address granularity.\r
///\r
-/// LegacySegment Segment where EfiCompatibility code will place the table or data.\r
+/// LegacySegment Segment in which EfiCompatibility code will place the table or data.\r
///\r
-/// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r
+/// LegacyOffset Offset in which EfiCompatibility code will place the table or data.\r
///\r
/// The return values associated with this mode are:\r
/// EFI_SUCCESS The data was returned successfully.\r
/// Alignment Bit mapped address alignment granularity. \r
/// The first nonzero bit from the right is the address granularity.\r
///\r
- /// LegacySegment Segment where EfiCompatibility code will place the table or data.\r
+ /// LegacySegment Segment in which EfiCompatibility code will place the table or data.\r
///\r
- /// LegacyOffset Offset where EfiCompatibility code will place the table or data.\r
+ /// LegacyOffset Offset in which EfiCompatibility code will place the table or data.\r
///\r
/// The return values associated with this mode are:\r
///\r
///\r
UINT16 CompatibleDid;\r
///\r
- /// If nonzero, a value passed directly to the IRQ miniport\92s Initialize function.\r
+ /// If nonzero, a value passed directly to the IRQ miniport's Initialize function.\r
///\r
UINT32 Miniport;\r
///\r
@param This 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 Location Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
+ @param TableSize Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
+ @param Location Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
@param Alignment 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
+ @param LegacyOffset Mode specific. See EFI_GET_PLATFORM_INFO_MODE enum.\r
\r
@retval EFI_SUCCESS Data was returned successfully.\r
@retval EFI_UNSUPPORTED Mode is not supported on the platform.\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
projects / mirror_edk2.git / blobdiff