]> git.proxmox.com Git - mirror_edk2.git/blobdiff - IntelFrameworkPkg/Include/Protocol/LegacyBiosPlatform.h
Remove IntelFrameworkModulePkg
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyBiosPlatform.h
index 83bc5172ed03e3d2677d07539034cfd677546609..0a164dad3bde9ca53f1d3d931d32f436857bc4af 100644 (file)
@@ -4,16 +4,8 @@
   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
-\r
-  Module Name:  LegacyBiosPlatform.h\r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
   @par Revision Reference:\r
   This protocol is defined in Framework for EFI Compatibility Support Module spec\r
 #ifndef _EFI_LEGACY_BIOS_PLATFORM_H_\r
 #define _EFI_LEGACY_BIOS_PLATFORM_H_\r
 \r
-#include <Framework/Legacy16.h>\r
+///\r
+/// Legacy BIOS Platform depends on HDD_INFO and EFI_COMPATIBILITY16_TABLE that\r
+/// are defined with the Legacy BIOS Protocol\r
+///\r
+#include <Protocol/LegacyBios.h>\r
 \r
 #define EFI_LEGACY_BIOS_PLATFORM_PROTOCOL_GUID \\r
   { \\r
@@ -39,10 +35,10 @@ typedef struct _EFI_LEGACY_BIOS_PLATFORM_PROTOCOL EFI_LEGACY_BIOS_PLATFORM_PROTO
 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
@@ -57,12 +53,12 @@ typedef enum {
   ///     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
@@ -72,15 +68,15 @@ typedef enum {
   ///\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
@@ -95,12 +91,12 @@ typedef enum {
   ///       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 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
@@ -110,17 +106,19 @@ typedef enum {
   ///\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
@@ -135,12 +133,12 @@ typedef enum {
   ///      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 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
@@ -150,15 +148,17 @@ typedef enum {
   ///\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
+///\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
@@ -185,12 +185,12 @@ typedef enum {
 ///       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 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
@@ -211,12 +211,12 @@ EfiGetPlatformBinaryOem32Data    = 3,
   ///      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 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
@@ -232,22 +232,22 @@ EfiGetPlatformBinaryOem32Data    = 3,
   ///\r
   /// The function parameters associated with this mode are:\r
   ///\r
-  ///    System ROM image for the platform\r
-  ///    \r
-  ///    TableSize Size of Table in bytes\r
-  ///    \r
-  ///    Location Ignored\r
-  ///    \r
-  ///    Alignment Ignored\r
-  ///    \r
-  ///    LegacySegment Ignored\r
-  ///    \r
-  ///    LegacyOffset Ignored\r
+  ///    System ROM image for the platform.\r
+  ///\r
+  ///    TableSize Size of Table in bytes.\r
+  ///\r
+  ///    Location Ignored.\r
+  ///\r
+  ///    Alignment Ignored.\r
+  ///\r
+  ///    LegacySegment Ignored.\r
+  ///\r
+  ///    LegacyOffset Ignored.\r
   ///\r
   /// The return values associated with this mode are:\r
   ///\r
   ///    EFI_SUCCESS ROM image found.\r
-  ///    \r
+  ///\r
   ///    EFI_NOT_FOUND ROM not found.\r
   ///\r
   EfiGetPlatformBinarySystemRom    = 5,\r
@@ -257,17 +257,17 @@ EfiGetPlatformBinaryOem32Data    = 3,
   ///\r
   /// The function parameters associated with this mode are:\r
   ///\r
-  ///    Table System ROM image for the platform\r
-  ///    \r
-  ///    TableSize Size of Table in bytes\r
-  ///    \r
-  ///    Location Ignored\r
-  ///    \r
-  ///    Alignment Ignored\r
-  ///    \r
-  ///    LegacySegment Ignored\r
-  ///    \r
-  ///    LegacyOffset Ignored\r
+  ///    Table System ROM image for the platform.\r
+  ///\r
+  ///    TableSize Size of Table in bytes.\r
+  ///\r
+  ///    Location Ignored.\r
+  ///\r
+  ///    Alignment Ignored.\r
+  ///\r
+  ///    LegacySegment Ignored.\r
+  ///\r
+  ///    LegacyOffset Ignored.\r
   ///\r
   /// The return values associated with this mode are:\r
   ///\r
@@ -284,7 +284,7 @@ EfiGetPlatformBinaryOem32Data    = 3,
 } 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
@@ -293,14 +293,14 @@ typedef enum {
   ///\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
-  /// \r
+  ///   AdditionalData NULL.\r
+  ///\r
   EfiGetPlatformVgaHandle       = 0,\r
   ///\r
   /// This mode returns the Compatibility16 policy for the device that should be the IDE\r
@@ -308,11 +308,11 @@ typedef enum {
   ///\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
@@ -324,13 +324,13 @@ typedef enum {
   ///\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
@@ -339,20 +339,20 @@ typedef enum {
   ///\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
@@ -360,15 +360,15 @@ typedef enum {
   ///\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
+  ///     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
@@ -377,15 +377,15 @@ typedef enum {
   ///\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
@@ -394,16 +394,16 @@ typedef enum {
   ///\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
+  ///       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
   ///\r
-  ///       AdditionalData NULL\r
-  /// \r
   EfiPlatformHookAfterRomInit     = 2\r
 } EFI_GET_PLATFORM_HOOK_MODE;\r
 \r
@@ -413,7 +413,7 @@ typedef enum {
 #define PCI_UNUSED        0x00\r
 ///\r
 /// This IRQ has been assigned to PCI.\r
-/// \r
+///\r
 #define PCI_USED          0xFF\r
 ///\r
 /// This IRQ has been used by an SIO legacy device and cannot be used by PCI.\r
@@ -437,7 +437,7 @@ typedef struct {
   /// LEGACY_USED 0xFE. This IRQ has been used by an SIO legacy\r
   /// device and cannot be used by PCI.\r
   ///\r
-UINT8 Used;\r
+  UINT8 Used;\r
 } EFI_LEGACY_IRQ_PRIORITY_TABLE_ENTRY;\r
 \r
 //\r
@@ -483,7 +483,7 @@ typedef struct {
   ///\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
@@ -499,20 +499,13 @@ typedef struct {
 \r
 typedef struct {\r
   ///\r
-  /// IRQ for this entry.\r
+  /// If nonzero, a value assigned by the IBV.\r
   ///\r
   UINT8   Pirq;\r
   ///\r
-  /// Status of this IRQ.\r
-  ///\r
-  ///     PCI_UNUSED 0x00. This IRQ has not been assigned to PCI.\r
+  /// If nonzero, the IRQs that can be assigned to this device.\r
   ///\r
-  ///     PCI_USED 0xFF. This IRQ has been assigned to PCI.\r
-  ///\r
-  ///     LEGACY_USED 0xFE. This IRQ has been used by an SIO legacy\r
-  ///       device and cannot be used by PCI.\r
-  ///\r
-UINT16  IrqMask;\r
+  UINT16  IrqMask;\r
 } EFI_LEGACY_PIRQ_ENTRY;\r
 \r
 typedef struct {\r
@@ -544,16 +537,16 @@ typedef struct {
 /**\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  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_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
@@ -574,16 +567,16 @@ EFI_STATUS
 /**\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
@@ -600,8 +593,8 @@ EFI_STATUS
 /**\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
@@ -618,7 +611,7 @@ EFI_STATUS
   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
@@ -626,7 +619,7 @@ EFI_STATUS
   @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
@@ -645,18 +638,18 @@ EFI_STATUS
 /**\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
@@ -674,16 +667,16 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Translates the given PIRQ accounting for bridge\r
-  This function translates the given PIRQ back through all buses, if required, \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
@@ -704,12 +697,12 @@ EFI_STATUS
   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
@@ -747,7 +740,7 @@ struct _EFI_LEGACY_BIOS_PLATFORM_PROTOCOL {
   ///\r
   ///  Gets $PIR table.\r
   EFI_LEGACY_BIOS_PLATFORM_GET_ROUTING_TABLE    GetRoutingTable;\r
-  /// \r
+  ///\r
   ///  Translates the given PIRQ to the final value after traversing any PCI bridges.\r
   ///\r
   EFI_LEGACY_BIOS_PLATFORM_TRANSLATE_PIRQ       TranslatePirq;\r