Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
index c582cbc1dbd5b911505d114070eb7f1ac91532a1..cc5eced4db32e30bf49f745a3fc6804fdfadd403 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
@@ -9,14 +9,14 @@
   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
   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

-  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
-  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
   @par Revision Reference:\r
   This protocol is defined in Framework for EFI Compatibility Support Module spec\r


@@ -98,18 +98,20 @@ typedef struct {
   UINT16                            Compatibility16CallOffset;\r
   \r
   ///\r
   UINT16                            Compatibility16CallOffset;\r
   \r
   ///\r

-  /// The segment of the entry point within the traditional BIOS for EfiCompatibility to invoke the PnP installation check.\r
+  /// The segment of the entry point within the traditional BIOS for EfiCompatibility \r
+  /// to invoke the PnP installation check.\r

   ///\r
   UINT16                            PnPInstallationCheckSegment;\r
   \r
   ///\r
   ///\r
   UINT16                            PnPInstallationCheckSegment;\r
   \r
   ///\r

-  /// The Offset of the entry point within the traditional BIOS for EfiCompatibility to invoke the PnP installation check.\r
+  /// The Offset of the entry point within the traditional BIOS for EfiCompatibility \r
+  /// to invoke the PnP installation check.\r

   ///\r
   UINT16                            PnPInstallationCheckOffset;\r
   \r
   ///\r
   ///\r
   UINT16                            PnPInstallationCheckOffset;\r
   \r
   ///\r

-  /// EFI system resources table. Type EFI_SYSTEM_TABLE is defined in the IntelPlatform Innovation Framework for EFI \r
-  /// Driver Execution Environment Core Interface Specification (DXE CIS).\r
+  /// EFI system resources table. Type EFI_SYSTEM_TABLE is defined in the IntelPlatform \r
+  ///Innovation Framework for EFI Driver Execution Environment Core Interface Specification (DXE CIS).\r

   ///\r
   UINT32                            EfiSystemTable; \r
   \r
   ///\r
   UINT32                            EfiSystemTable; \r
   \r


@@ -157,7 +159,8 @@ typedef struct {
   \r
   ///\r
   /// The 32-bit physical address where the MP table is stored in the traditional BIOS.\r
   \r
   ///\r
   /// The 32-bit physical address where the MP table is stored in the traditional BIOS.\r

-  /// The EfiCompatibility code will fill in the MpTablePtr value and copy the data to the indicated area.\r
+  /// The EfiCompatibility code will fill in the MpTablePtr value and copy the data \r
+  /// to the indicated area.\r

   ///\r
   UINT32                            MpTablePtr;\r
   \r
   ///\r
   UINT32                            MpTablePtr;\r
   \r


@@ -231,8 +234,9 @@ typedef struct {
 /// Functions provided by the CSM binary which communicate between the EfiCompatibility \r
 /// and Compatability16 code.\r
 ///\r
 /// Functions provided by the CSM binary which communicate between the EfiCompatibility \r
 /// and Compatability16 code.\r
 ///\r

-/// Inconsistent with specification here: \r
-/// The member's name started with "Compatibility16" [defined in Intel Framework Compatibility Support Module Specification / 0.97 version] \r
+/// Inconsistent with the specification here: \r
+/// The member's name started with "Compatibility16" [defined in Intel Framework \r
+/// Compatibility Support Module Specification / 0.97 version] \r

 /// has been changed to "Legacy16" since keeping backward compatible.\r
 ///\r
 typedef enum {\r
 /// has been changed to "Legacy16" since keeping backward compatible.\r
 ///\r
 typedef enum {\r


@@ -345,15 +349,15 @@ typedef enum {
 /// EFI_DISPATCH_OPROM_TABLE\r
 ///\r
 typedef struct {\r
 /// EFI_DISPATCH_OPROM_TABLE\r
 ///\r
 typedef struct {\r

-  UINT16  PnPInstallationCheckSegment;  ///< Pointer to the PnpInstallationCheck data structure.\r
-  UINT16  PnPInstallationCheckOffset;   ///< Pointer to the PnpInstallationCheck data structure.\r
+  UINT16  PnPInstallationCheckSegment;  ///< A pointer to the PnpInstallationCheck data structure.\r
+  UINT16  PnPInstallationCheckOffset;   ///< A pointer to the PnpInstallationCheck data structure.\r

   UINT16  OpromSegment;                 ///< The segment where the OpROM was placed. Offset is assumed to be 3.\r
   UINT8   PciBus;                       ///< The PCI bus.\r
   UINT8   PciDeviceFunction;            ///< The PCI device * 0x08 | PCI function.\r
   UINT8   NumberBbsEntries;             ///< The number of valid BBS table entries upon entry and exit. The IBV code may\r
                                         ///< increase this number, if BBS-compliant devices also hook INTs in order to force the\r
                                         ///< OpROM BIOS Setup to be executed.\r
   UINT16  OpromSegment;                 ///< The segment where the OpROM was placed. Offset is assumed to be 3.\r
   UINT8   PciBus;                       ///< The PCI bus.\r
   UINT8   PciDeviceFunction;            ///< The PCI device * 0x08 | PCI function.\r
   UINT8   NumberBbsEntries;             ///< The number of valid BBS table entries upon entry and exit. The IBV code may\r
                                         ///< increase this number, if BBS-compliant devices also hook INTs in order to force the\r
                                         ///< OpROM BIOS Setup to be executed.\r

-  VOID    *BbsTablePointer;             ///< Pointer to the BBS table.\r
+  VOID    *BbsTablePointer;             ///< A pointer to the BBS table.\r

   UINT16  RuntimeSegment;               ///< The segment where the OpROM can be relocated to. If this value is 0x0000, this\r
                                         ///< means that the relocation of this run time code is not supported.\r
                                         ///< Inconsistent with specification here: \r
   UINT16  RuntimeSegment;               ///< The segment where the OpROM can be relocated to. If this value is 0x0000, this\r
                                         ///< means that the relocation of this run time code is not supported.\r
                                         ///< Inconsistent with specification here: \r


@@ -372,12 +376,12 @@ typedef struct {
   UINT32                            BiosLessThan1MB;\r
   \r
   ///\r
   UINT32                            BiosLessThan1MB;\r
   \r
   ///\r

-  /// Starting address of the high memory block.\r
+  /// The starting address of the high memory block.\r

   ///\r
   UINT32                            HiPmmMemory;\r
   \r
   ///\r
   ///\r
   UINT32                            HiPmmMemory;\r
   \r
   ///\r

-  /// Length of high memory block.\r
+  /// The length of high memory block.\r

   ///\r
   UINT32                            HiPmmMemorySizeInBytes;\r
   \r
   ///\r
   UINT32                            HiPmmMemorySizeInBytes;\r
   \r


@@ -417,22 +421,22 @@ typedef struct {
   UINT32                            LowPmmMemory;\r
   \r
   ///\r
   UINT32                            LowPmmMemory;\r
   \r
   ///\r

-  /// Length of low Memory block.\r
+  /// The length of low Memory block.\r

   ///\r
   UINT32                            LowPmmMemorySizeInBytes;\r
 } EFI_TO_COMPATIBILITY16_INIT_TABLE;\r
 \r
 ///\r
   ///\r
   UINT32                            LowPmmMemorySizeInBytes;\r
 } EFI_TO_COMPATIBILITY16_INIT_TABLE;\r
 \r
 ///\r

-/// DEVICE_PRODUCER_SERIAL\r
+/// DEVICE_PRODUCER_SERIAL.\r

 ///\r
 typedef struct {\r
 ///\r
 typedef struct {\r

-  UINT16                            Address;    ///< I/O address assigned to the serial port\r
+  UINT16                            Address;    ///< I/O address assigned to the serial port.\r

   UINT8                             Irq;        ///< IRQ assigned to the serial port.\r
   SERIAL_MODE                       Mode;       ///< Mode of serial port. Values are defined below.\r
 } DEVICE_PRODUCER_SERIAL;\r
 \r
 ///\r
   UINT8                             Irq;        ///< IRQ assigned to the serial port.\r
   SERIAL_MODE                       Mode;       ///< Mode of serial port. Values are defined below.\r
 } DEVICE_PRODUCER_SERIAL;\r
 \r
 ///\r

-/// DEVICE_PRODUCER_SERIAL's modes\r
+/// DEVICE_PRODUCER_SERIAL's modes.\r

 ///@{\r
 #define DEVICE_SERIAL_MODE_NORMAL               0x00\r
 #define DEVICE_SERIAL_MODE_IRDA                 0x01\r
 ///@{\r
 #define DEVICE_SERIAL_MODE_NORMAL               0x00\r
 #define DEVICE_SERIAL_MODE_IRDA                 0x01\r


@@ -442,17 +446,17 @@ typedef struct {
 ///@)\r
 \r
 ///\r
 ///@)\r
 \r
 ///\r

-/// DEVICE_PRODUCER_PARALLEL\r
+/// DEVICE_PRODUCER_PARALLEL.\r

 ///\r
 typedef struct {\r
 ///\r
 typedef struct {\r

-  UINT16                            Address;  ///< I/O address assigned to the parallel port\r
+  UINT16                            Address;  ///< I/O address assigned to the parallel port.\r

   UINT8                             Irq;      ///< IRQ assigned to the parallel port.\r
   UINT8                             Dma;      ///< DMA assigned to the parallel port.\r
   PARALLEL_MODE                     Mode;     ///< Mode of the parallel port. Values are defined below.\r
 } DEVICE_PRODUCER_PARALLEL;\r
 \r
 ///\r
   UINT8                             Irq;      ///< IRQ assigned to the parallel port.\r
   UINT8                             Dma;      ///< DMA assigned to the parallel port.\r
   PARALLEL_MODE                     Mode;     ///< Mode of the parallel port. Values are defined below.\r
 } DEVICE_PRODUCER_PARALLEL;\r
 \r
 ///\r

-/// DEVICE_PRODUCER_PARALLEL's modes\r
+/// DEVICE_PRODUCER_PARALLEL's modes.\r

 ///@{\r
 #define DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY   0x00\r
 #define DEVICE_PARALLEL_MODE_MODE_BIDIRECTIONAL 0x01\r
 ///@{\r
 #define DEVICE_PARALLEL_MODE_MODE_OUTPUT_ONLY   0x00\r
 #define DEVICE_PARALLEL_MODE_MODE_BIDIRECTIONAL 0x01\r


@@ -464,7 +468,7 @@ typedef struct {
 /// DEVICE_PRODUCER_FLOPPY\r
 ///\r
 typedef struct {\r
 /// DEVICE_PRODUCER_FLOPPY\r
 ///\r
 typedef struct {\r

-  UINT16                            Address;          ///< I/O address assigned to the floppy\r
+  UINT16                            Address;          ///< I/O address assigned to the floppy.\r

   UINT8                             Irq;              ///< IRQ assigned to the floppy.\r
   UINT8                             Dma;              ///< DMA assigned to the floppy.\r
   UINT8                             NumberOfFloppy;   ///< Number of floppies in the system.\r
   UINT8                             Irq;              ///< IRQ assigned to the floppy.\r
   UINT8                             Dma;              ///< DMA assigned to the floppy.\r
   UINT8                             NumberOfFloppy;   ///< Number of floppies in the system.\r


@@ -534,14 +538,14 @@ typedef struct {
   UINT16                            ControlBaseAddress;\r
   \r
   ///\r
   UINT16                            ControlBaseAddress;\r
   \r
   ///\r

-  /// Bus master address\r
+  /// Bus master address.\r

   ///\r
   UINT16                            BusMasterAddress;\r
   \r
   UINT8                             HddIrq;\r
   \r
   ///\r
   ///\r
   UINT16                            BusMasterAddress;\r
   \r
   UINT8                             HddIrq;\r
   \r
   ///\r

-  /// Data that identifies the drive data, one per possible attached drive\r
+  /// Data that identifies the drive data; one per possible attached drive.\r

   ///\r
   ATAPI_IDENTIFY                    IdentifyDrive[2];\r
 } HDD_INFO;\r
   ///\r
   ATAPI_IDENTIFY                    IdentifyDrive[2];\r
 } HDD_INFO;\r


@@ -559,7 +563,7 @@ typedef struct {
 #define HDD_SLAVE_ATAPI_ZIPDISK   0x80\r
 \r
 ///\r
 #define HDD_SLAVE_ATAPI_ZIPDISK   0x80\r
 \r
 ///\r

-/// BBS_STATUS_FLAGS\r
+/// BBS_STATUS_FLAGS;\.\r

 ///\r
 typedef struct {\r
   UINT16                            OldPosition : 4;    ///< Prior priority.\r
 ///\r
 typedef struct {\r
   UINT16                            OldPosition : 4;    ///< Prior priority.\r


@@ -580,7 +584,7 @@ typedef struct {
 } BBS_STATUS_FLAGS;\r
 \r
 ///\r
 } BBS_STATUS_FLAGS;\r
 \r
 ///\r

-/// BBS_TABLE, device type values & boot priority values\r
+/// BBS_TABLE, device type values & boot priority values.\r

 ///\r
 typedef struct {\r
   ///\r
 ///\r
 typedef struct {\r
   ///\r


@@ -727,12 +731,12 @@ typedef struct {
   UINT16                            Type : 3;\r
   \r
   ///\r
   UINT16                            Type : 3;\r
   \r
   ///\r

-  /// Size of "port" in bits. Defined values are below.\r
+  /// The size of "port" in bits. Defined values are below.\r

   ///\r
   UINT16                            PortGranularity : 3;\r
   \r
   ///\r
   ///\r
   UINT16                            PortGranularity : 3;\r
   \r
   ///\r

-  /// Size of data in bits. Defined values are below.\r
+  /// The size of data in bits. Defined values are below.\r

   ///\r
   UINT16                            DataGranularity : 3;\r
   \r
   ///\r
   UINT16                            DataGranularity : 3;\r
   \r


@@ -743,14 +747,14 @@ typedef struct {
 } SMM_ATTRIBUTES;\r
 \r
 ///\r
 } SMM_ATTRIBUTES;\r
 \r
 ///\r

-/// SMM_ATTRIBUTES type values\r
+/// SMM_ATTRIBUTES type values.\r

 ///@{\r
 #define STANDARD_IO       0x00\r
 #define STANDARD_MEMORY   0x01\r
 ///@}\r
 \r
 ///\r
 ///@{\r
 #define STANDARD_IO       0x00\r
 #define STANDARD_MEMORY   0x01\r
 ///@}\r
 \r
 ///\r

-/// SMM_ATTRIBUTES port size constants\r
+/// SMM_ATTRIBUTES port size constants.\r

 ///@{\r
 #define PORT_SIZE_8       0x00\r
 #define PORT_SIZE_16      0x01\r
 ///@{\r
 #define PORT_SIZE_8       0x00\r
 #define PORT_SIZE_16      0x01\r


@@ -759,7 +763,7 @@ typedef struct {
 ///@}\r
 \r
 ///\r
 ///@}\r
 \r
 ///\r

-/// SMM_ATTRIBUTES data size constants\r
+/// SMM_ATTRIBUTES data size constants.\r

 ///@{\r
 #define DATA_SIZE_8       0x00\r
 #define DATA_SIZE_16      0x01\r
 ///@{\r
 #define DATA_SIZE_8       0x00\r
 #define DATA_SIZE_16      0x01\r


@@ -768,7 +772,7 @@ typedef struct {
 ///@}\r
 \r
 ///\r
 ///@}\r
 \r
 ///\r

-/// SMM_FUNCTION & relating constants\r
+/// SMM_FUNCTION & relating constants.\r

 ///\r
 typedef struct {\r
   UINT16                            Function : 15;\r
 ///\r
 typedef struct {\r
   UINT16                            Function : 15;\r


@@ -776,7 +780,7 @@ typedef struct {
 } SMM_FUNCTION;\r
 \r
 ///\r
 } SMM_FUNCTION;\r
 \r
 ///\r

-/// SMM_FUNCTION Function constants\r
+/// SMM_FUNCTION Function constants.\r

 ///@{\r
 #define INT15_D042        0x0000\r
 #define GET_USB_BOOT_INFO 0x0001\r
 ///@{\r
 #define INT15_D042        0x0000\r
 #define GET_USB_BOOT_INFO 0x0001\r


@@ -784,7 +788,7 @@ typedef struct {
 ///@}\r
 \r
 ///\r
 ///@}\r
 \r
 ///\r

-/// SMM_FUNCTION Owner constants\r
+/// SMM_FUNCTION Owner constants.\r

 ///@{\r
 #define STANDARD_OWNER    0x0\r
 #define OEM_OWNER         0x1\r
 ///@{\r
 #define STANDARD_OWNER    0x0\r
 #define OEM_OWNER         0x1\r


@@ -807,12 +811,12 @@ typedef struct {
   SMM_FUNCTION                      SmmFunction;\r
   \r
   ///\r
   SMM_FUNCTION                      SmmFunction;\r
   \r
   ///\r

-  /// SmmPort size depends upon SmmAttributes and ranges from2 bytes to 16 bytes\r
+  /// SmmPort size depends upon SmmAttributes and ranges from2 bytes to 16 bytes.\r

   ///\r
   UINT8                             SmmPort;\r
   \r
   ///\r
   ///\r
   UINT8                             SmmPort;\r
   \r
   ///\r

-  /// SmmData size depends upon SmmAttributes and ranges from2 bytes to 16 bytes\r
+  /// SmmData size depends upon SmmAttributes and ranges from2 bytes to 16 bytes.\r

   ///\r
   UINT8                             SmmData;\r
 } SMM_ENTRY;\r
   ///\r
   UINT8                             SmmData;\r
 } SMM_ENTRY;\r


@@ -905,8 +909,8 @@ typedef struct {
 typedef struct {\r
   UINT16                            MajorVersion;                 ///< The EfiCompatibility major version number.\r
   UINT16                            MinorVersion;                 ///< The EfiCompatibility minor version number.\r
 typedef struct {\r
   UINT16                            MajorVersion;                 ///< The EfiCompatibility major version number.\r
   UINT16                            MinorVersion;                 ///< The EfiCompatibility minor version number.\r

-  UINT32                            AcpiTable;                    ///< Location of the RSDT ACPI table. < 4G range\r
-  UINT32                            SmbiosTable;                  ///< Location of the SMBIOS table in EFI memory. < 4G range\r
+  UINT32                            AcpiTable;                    ///< The location of the RSDT ACPI table. < 4G range.\r
+  UINT32                            SmbiosTable;                  ///< The location of the SMBIOS table in EFI memory. < 4G range.\r

   UINT32                            SmbiosTableLength;\r
   //\r
   // Legacy SIO state\r
   UINT32                            SmbiosTableLength;\r
   //\r
   // Legacy SIO state\r


@@ -921,8 +925,8 @@ typedef struct {
   //\r
   HDD_INFO                          HddInfo[MAX_IDE_CONTROLLER];  ///< Hard disk drive information, including raw Identify Drive data.\r
   UINT32                            NumberBbsEntries;             ///< Number of entries in the BBS table\r
   //\r
   HDD_INFO                          HddInfo[MAX_IDE_CONTROLLER];  ///< Hard disk drive information, including raw Identify Drive data.\r
   UINT32                            NumberBbsEntries;             ///< Number of entries in the BBS table\r

-  UINT32                            BbsTable;                     ///< Pointer to the BBS table. Type BBS_TABLE is defined below.\r
-  UINT32                            SmmTable;                     ///< Pointer to the SMM table. Type SMM_TABLE is defined below.\r
+  UINT32                            BbsTable;                     ///< A pointer to the BBS table. Type BBS_TABLE is defined below.\r
+  UINT32                            SmmTable;                     ///< A pointer to the SMM table. Type SMM_TABLE is defined below.\r

   UINT32                            OsMemoryAbove1Mb;             ///< The amount of usable memory above 1 MB, i.e. E820 type 1 memory. This value can\r
                                                                   ///< differ from the value in EFI_TO_COMPATIBILITY16_INIT_TABLE as more\r
                                                                   ///< memory may have been discovered.\r
   UINT32                            OsMemoryAbove1Mb;             ///< The amount of usable memory above 1 MB, i.e. E820 type 1 memory. This value can\r
                                                                   ///< differ from the value in EFI_TO_COMPATIBILITY16_INIT_TABLE as more\r
                                                                   ///< memory may have been discovered.\r


@@ -971,12 +975,12 @@ typedef struct {
 typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r
 \r
 ///\r
 typedef struct _EFI_LEGACY_BIOS_PROTOCOL EFI_LEGACY_BIOS_PROTOCOL;\r
 \r
 ///\r

-/// Flags returned by CheckPciRom()\r
+/// Flags returned by CheckPciRom().\r

 ///\r
 #define NO_ROM            0x00\r
 #define ROM_FOUND         0x01\r
 #define VALID_LEGACY_ROM  0x02\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 the Framework CSM Specification\r
+#define ROM_WITH_CONFIG   0x04     ///< Not defined in the Framework CSM Specification.\r

 \r
 ///\r
 /// The following macros do not appear in the Framework CSM Specification and \r
 \r
 ///\r
 /// The following macros do not appear in the Framework CSM Specification and \r


@@ -1113,10 +1117,10 @@ typedef union {
   of BiosInt. Regs will contain the 16-bit register context on entry and\r
   exit.\r
 \r
   of BiosInt. Regs will contain the 16-bit register context on entry and\r
   exit.\r
 \r

-  @param[in]     This      Protocol instance pointer.\r
-  @param[in]     BiosInt   Processor interrupt vector to invoke\r
+  @param[in]     This      The protocol instance pointer.\r
+  @param[in]     BiosInt   The processor interrupt vector to invoke.\r

   @param[in,out] Reg       Register contexted passed into (and returned) from thunk to\r
   @param[in,out] Reg       Register contexted passed into (and returned) from thunk to\r

-                           16-bit mode\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
   @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


@@ -1134,13 +1138,13 @@ BOOLEAN
   16-bit register context on entry and exit. Arguments can be passed on\r
   the Stack argument\r
 \r
   16-bit register context on entry and exit. Arguments can be passed on\r
   the Stack argument\r
 \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] This        The protocol instance pointer.\r
+  @param[in] Segment     The segemnt of 16-bit mode call.\r
+  @param[in] Offset      The offset of 16-bit mdoe call.\r

   @param[in] Reg         Register contexted passed into (and returned) from thunk to\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
+                         16-bit mode.\r
+  @param[in] Stack       The caller allocated stack used to pass arguments.\r
+  @param[in] StackSize   The 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
 \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


@@ -1159,17 +1163,17 @@ BOOLEAN
   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
   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[in]  This        Protocol instance pointer.\r
+  @param[in]  This        The protocol instance pointer.\r

   @param[in]  PciHandle   The PCI PC-AT OPROM from this devices ROM BAR will be loaded\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] RomImage    Return the legacy PCI ROM for this device.\r
+  @param[out] RomSize     The size of ROM Image.\r

   @param[out] Flags       Indicates if ROM found and if PC-AT. Multiple bits can be set as follows:\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
+                            - 00 = No ROM.\r
+                            - 01 = ROM Found.\r
+                            - 02 = ROM is a valid legacy ROM.\r

 \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       The Legacy Option ROM availible for this device\r
+  @retval EFI_UNSUPPORTED   The Legacy Option ROM is not supported.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -1187,7 +1191,7 @@ EFI_STATUS
   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
   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[in]  This               Protocol instance pointer.\r
+  @param[in]  This               The 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]  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


@@ -1199,11 +1203,11 @@ EFI_STATUS
                                    - 00 = No ROM.\r
                                    - 01 = ROM found.\r
                                    - 02 = ROM is a valid legacy ROM.\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
+  @param[out] DiskStart          The 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
                                  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
+  @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
   @retval EFI_SUCCESS             Thunk completed, see Regs for status.\r
   @retval EFI_INVALID_PARAMETER   PciHandle not found\r


@@ -1246,10 +1250,10 @@ EFI_STATUS
     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
     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[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
+  @param[in] This             The protocol instance pointer.\r
+  @param[in] BootOption       The EFI Device Path from BootXXXX variable.\r
+  @param[in] LoadOptionSize   The size of LoadOption in size.\r
+  @param[in] LoadOption       LThe oadOption 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
 \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


@@ -1269,11 +1273,11 @@ EFI_STATUS
   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
   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[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
+  @param[in] This   The protocol instance pointer.\r
+  @param[in] Leds   The 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
   @retval EFI_SUCCESS   The BDA was updated successfully.\r
 \r


@@ -1288,13 +1292,13 @@ EFI_STATUS
 /**\r
   Retrieve legacy BBS info and assign boot priority.\r
 \r
 /**\r
   Retrieve legacy BBS info and assign boot priority.\r
 \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
+  @param[in]     This       The protocol instance pointer.\r
+  @param[out]    HddCount   The number of HDD_INFO structures.\r
+  @param[out]    HddInfo    Onboard IDE controller information.\r
+  @param[out]    BbsCount   The number of BBS_TABLE structures.\r
+  @param[in,out] BbsTable   Points to List of BBS_TABLE.\r

 \r
 \r

-  @retval EFI_SUCCESS   Tables returned\r
+  @retval EFI_SUCCESS   Tables were returned.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -1311,11 +1315,11 @@ EFI_STATUS
   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
   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[in]  This       Protocol instance pointer.\r
-  @param[out] BbsCount   Number of BBS_TABLE structures\r
-  @param[out] BbsTable   List BBS entries\r
+  @param[in]  This       The protocol instance pointer.\r
+  @param[out] BbsCount   The number of BBS_TABLE structures\r
+  @param[out] BbsTable   List of BBS entries\r

 \r
 \r

-  @retval EFI_SUCCESS   Drive numbers assigned\r
+  @retval EFI_SUCCESS   Drive numbers assigned.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -1330,12 +1334,12 @@ EFI_STATUS
   To boot from an unconventional device like parties and/or execute\r
   HDD diagnostics.\r
 \r
   To boot from an unconventional device like parties and/or execute\r
   HDD diagnostics.\r
 \r

-  @param[in]  This              Protocol instance pointer.\r
-  @param[in]  Attributes        How to interpret the other input parameters\r
+  @param[in]  This              The 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[in]  BbsEntry          The 0-based index into the BbsTable for the parent\r
                                 device.\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
+  @param[in]  BeerData          A pointer to the 128 bytes of ram BEER data.\r
+  @param[in]  ServiceAreaData   A 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
                                 caller must provide a pointer to the specific Service\r
                                 Area and not the start all Service Areas.\r
 \r


@@ -1355,12 +1359,12 @@ EFI_STATUS
 /**\r
   Shadow all legacy16 OPROMs that haven't been shadowed.\r
   Warning: Use this with caution. This routine disconnects all EFI\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. If used externally, then  the caller must re-connect EFI\r

   drivers.\r
   \r
   drivers.\r
   \r

-  @param[in]  This   Protocol instance pointer.\r
+  @param[in]  This   The protocol instance pointer.\r

   \r
   \r

-  @retval EFI_SUCCESS   OPROMs shadowed\r
+  @retval EFI_SUCCESS   OPROMs were shadowed.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -1372,19 +1376,19 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for S3 usage.\r
 \r
 /**\r
   Get a region from the LegacyBios for S3 usage.\r
 \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
+  @param[in]  This                  The protocol instance pointer.\r
+  @param[in]  LegacyMemorySize      The size of required region.\r
+  @param[in]  Region                The 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. The first non-zero\r

                                     bit from right is alignment.\r
                                     bit from right is alignment.\r

-  @param[out] LegacyMemoryAddress   Region Assigned\r
+  @param[out] LegacyMemoryAddress   The Region Assigned\r

 \r
 \r

-  @retval EFI_SUCCESS           Region assigned\r
+  @retval EFI_SUCCESS           The Region was assigned.\r

   @retval EFI_ACCESS_DENIED     The function was previously invoked.\r
   @retval EFI_ACCESS_DENIED     The function was previously invoked.\r

-  @retval Other                 Region not assigned\r
+  @retval Other                 The Region was not assigned.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r


@@ -1400,15 +1404,15 @@ EFI_STATUS
 /**\r
   Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
 \r
 /**\r
   Get a region from the LegacyBios for Tiano usage. Can only be invoked once.\r
 \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
+  @param[in]  This                        The protocol instance pointer.\r
+  @param[in]  LegacyMemorySize            The size of data to copy.\r
+  @param[in]  LegacyMemoryAddress         The Legacy Region destination address.\r

                                           Note: must be in region assigned by\r
                                           Note: must be in region assigned by\r

-                                          LegacyBiosGetLegacyRegion\r
-  @param[in]  LegacyMemorySourceAddress   Source of the data to copy.\r
+                                          LegacyBiosGetLegacyRegion.\r
+  @param[in]  LegacyMemorySourceAddress   The source of the data to copy.\r

 \r
 \r

-  @retval EFI_SUCCESS           Region assigned\r
-  @retval EFI_ACCESS_DENIED     Destination outside assigned region\r
+  @retval EFI_SUCCESS           The Region assigned.\r
+  @retval EFI_ACCESS_DENIED     Destination was outside an assigned region.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r