]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/LegacyBiosPlatform.h
1. Add the fix for the following Bugs:
[mirror_edk2.git] / MdePkg / Include / Protocol / LegacyBiosPlatform.h
index 56d67241809c36f85b9aec1812deb129e277f2ec..8c394f2ea59eb5bcd468fe150ffdd1aa14a92e9a 100644 (file)
@@ -79,24 +79,24 @@ typedef enum {
 /**\r
   Finds the binary data or other platform information.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Specifies what data to return\r
-  @param  Table Pointer to MP table.\r
-  @param  TableSize Size in bytes of table.\r
-  @param  Location Legacy region requested\r
-  0x00 = Any location\r
-  Bit 0 = 0xF0000 region\r
-  Bit 1 = 0xE0000 region\r
-  Multiple bits can be set\r
-  @param  Alignment Address alignment for allocation.\r
-  Bit mapped. First non-zero bit from right\r
-  is alignment.\r
-  @param  LegacySegment Segment in LegacyBios where Table is stored\r
-  @param  LegacyOffset Offset in LegacyBios where Table is stored\r
-\r
-  @retval  EFI_SUCCESS Data was 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
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Specifies what data to return\r
+  @param  Table                 Pointer to MP table.\r
+  @param  TableSize             Size in bytes of table.\r
+  @param  Location              Legacy region requested\r
+                                0x00 = Any location\r
+                                Bit 0 = 0xF0000 region\r
+                                Bit 1 = 0xE0000 region\r
+                                Multiple bits can be set\r
+  @param  Alignment             Address alignment for allocation.\r
+                                Bit mapped. First non-zero bit from right\r
+                                is alignment.\r
+  @param  LegacySegment         Segment in LegacyBios where Table is stored\r
+  @param  LegacyOffset          Offset in LegacyBios where Table is stored\r
+\r
+  @retval EFI_SUCCESS           Data was 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
 typedef\r
@@ -116,17 +116,17 @@ EFI_STATUS
 /**\r
   Returns a buffer of handles for the requested sub-function.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Specifies what handle to return.\r
-  @param  Type Type from Device Path for Handle to represent.\r
-  @param  HandleBuffer Handles of the device/controller in priority order\r
-  with HandleBuffer[0] highest priority.\r
-  @param  HandleCount Number of handles in the buffer.\r
-  @param  AdditionalData Mode specific.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Specifies what handle to return.\r
+  @param  Type                  Type from Device Path for Handle to represent.\r
+  @param  HandleBuffer          Handles of the device/controller in priority order\r
+                                with HandleBuffer[0] highest priority.\r
+  @param  HandleCount           Number of handles in the buffer.\r
+  @param  AdditionalData        Mode specific.\r
 \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_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
 \r
 **/\r
 typedef\r
@@ -144,11 +144,11 @@ EFI_STATUS
 /**\r
   Load and initialize the Legacy BIOS SMM handler.\r
 \r
-  @param  This Protocol instance pointer.\r
+  @param  This                   Protocol instance pointer.\r
   @param  EfiToLegacy16BootTable Pointer to Legacy16 boot table.\r
 \r
-  @retval  EFI_SUCCESS SMM code loaded.\r
-  @retval  EFI_DEVICE_ERROR SMM code failed to load\r
+  @retval EFI_SUCCESS           SMM code loaded.\r
+  @retval EFI_DEVICE_ERROR      SMM code failed to load\r
 \r
 **/\r
 typedef\r
@@ -162,16 +162,16 @@ EFI_STATUS
 /**\r
   Allows platform to perform any required action after a LegacyBios operation.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  Mode Specifies what handle to return.\r
-  @param  Type Mode specific.\r
-  @param  DeviceHandle List of PCI devices in the system.\r
-  @param  ShadowAddress First free OpROM area, after other OpROMs have been dispatched.\r
-  @param  Compatibility16Table Pointer to Compatibility16Table.\r
-  @param  AdditionalData Mode specific Pointer to additional data returned ¨C mode specific.\r
+  @param  This                  Protocol instance pointer.\r
+  @param  Mode                  Specifies what handle to return.\r
+  @param  Type                  Mode specific.\r
+  @param  DeviceHandle          List of PCI devices in the system.\r
+  @param  ShadowAddress         First free OpROM area, after other OpROMs have been dispatched.\r
+  @param  Compatibility16Table  Pointer to Compatibility16Table.\r
+  @param  AdditionalData        Mode specific Pointer to additional data returned - mode specific.\r
 \r
-  @retval  EFI_SUCCESS RomImage is valid\r
-  @retval  EFI_UNSUPPORTED Mode is not supported on the platform.\r
+  @retval EFI_SUCCESS           RomImage is valid\r
+  @retval EFI_UNSUPPORTED       Mode is not supported on the platform.\r
 \r
 **/\r
 typedef\r
@@ -190,15 +190,15 @@ EFI_STATUS
 /**\r
   Returns information associated with PCI IRQ routing.\r
 \r
-  @param  This Protocol instance pointer.\r
-  @param  RoutingTable Pointer to PCI IRQ Routing table.\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  This                    Protocol instance pointer.\r
+  @param  RoutingTable            Pointer to PCI IRQ Routing table.\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
 \r
-  @retval  EFI_SUCCESS Data was successfully returned.\r
+  @retval EFI_SUCCESS           Data was successfully returned.\r
 \r
 **/\r
 typedef\r
@@ -217,15 +217,15 @@ EFI_STATUS
 /**\r
   Translates the given PIRQ accounting for bridge\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
-  assigned to the PIRQ.\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
+                                assigned to the PIRQ.\r
 \r
-  @retval  EFI_SUCCESS The PIRQ was translated.\r
+  @retval EFI_SUCCESS           The PIRQ was translated.\r
 \r
 **/\r
 typedef\r
@@ -244,14 +244,14 @@ 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  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
 \r
-  @retval  EFI_SUCCESS Ready to boot.\r
+  @retval EFI_SUCCESS           Ready to boot.\r
 \r
 **/\r
 typedef\r