Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Protocol / PciPlatform.h

diff --git a/MdePkg/Include/Protocol/PciPlatform.h b/MdePkg/Include/Protocol/PciPlatform.h
index 5b0add1ea7051c8b1f76c3e8f9e68ca2550eacd3..c9491097e3c17b8474ad5e295396198b8e6753ef 100644 (file)
--- a/MdePkg/Include/Protocol/PciPlatform.h
+++ b/MdePkg/Include/Protocol/PciPlatform.h
@@ -60,12 +60,12 @@ typedef enum {
   it needs to handle those errors on its own because there is no way to surface any \r
   errors to the caller.\r
 \r
   it needs to handle those errors on its own because there is no way to surface any \r
   errors to the caller.\r
 \r

-  @param  This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
-  @param  HostBridge The handle of the host bridge controller.\r
-  @param  Phase The phase of the PCI bus enumeration.\r
-  @param  ChipsetPhase Defines the execution phase of the PCI chipset driver.\r
+  @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+  @param  HostBridge            The handle of the host bridge controller.\r
+  @param  Phase                 The phase of the PCI bus enumeration.\r
+  @param  ChipsetPhase          Defines the execution phase of the PCI chipset driver.\r

 \r
 \r

-  @retval  EFI_SUCCESS The function completed successfully.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r

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


@@ -92,14 +92,14 @@ EFI_STATUS
   needs to handle those errors on its own because there is no way to surface any errors to \r
   the caller.  \r
 \r
   needs to handle those errors on its own because there is no way to surface any errors to \r
   the caller.  \r
 \r

-  @param  This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
-  @param  HostBridge The associated PCI host bridge handle.\r
-  @param  RootBridge The associated PCI root bridge handle.\r
-  @param  PciAddress The address of the PCI device on the PCI bus.\r
-  @param  Phase The phase of the PCI controller enumeration.\r
-  @param  ChipsetPhase Defines the execution phase of the PCI chipset driver.\r
+  @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+  @param  HostBridge            The associated PCI host bridge handle.\r
+  @param  RootBridge            The associated PCI root bridge handle.\r
+  @param  PciAddress            The address of the PCI device on the PCI bus.\r
+  @param  Phase                 The phase of the PCI controller enumeration.\r
+  @param  ChipsetPhase          Defines the execution phase of the PCI chipset driver.\r

 \r
 \r

-  @retval  EFI_SUCCESS The function completed successfully.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r

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


@@ -120,11 +120,11 @@ EFI_STATUS
   enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol \r
   driver can call this member function to retrieve the policy.\r
 \r
   enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol \r
   driver can call this member function to retrieve the policy.\r
 \r

-  @param  This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
-  @param  PciPolicy The platform policy with respect to VGA and ISA aliasing.\r
+  @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+  @param  PciPolicy             The platform policy with respect to VGA and ISA aliasing.\r

 \r
 \r

-  @retval  EFI_SUCCESS The function completed successfully.\r
-  @retval  EFI_INVALID_PARAMETER PciPolicy is NULL.\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_INVALID_PARAMETER PciPolicy is NULL.\r

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


@@ -147,20 +147,20 @@ EFI_STATUS
   scanning the ROM that is attached to any controller, which allows a platform to specify a ROM \r
   image that is different from the ROM image on a PCI card.\r
 \r
   scanning the ROM that is attached to any controller, which allows a platform to specify a ROM \r
   image that is different from the ROM image on a PCI card.\r
 \r

-  @param  This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
-  @param  PciHandle The handle of the PCI device.\r
-  @param  RomImage If the call succeeds, the pointer to the pointer to the option ROM image.\r
-  Otherwise, this field is undefined. The memory for RomImage is allocated\r
-  by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().\r
-  It is the caller's responsibility to free the memory using the EFI Boot Service\r
-  FreePool(), when the caller is done with the option ROM.\r
-  @param  RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,\r
-  this field is undefined.\r
-\r
-  @retval  EFI_SUCCESS The option ROM was available for this device and loaded into memory.\r
-  @retval  EFI_NOT_FOUND No option ROM was available for this device.\r
-  @retval  EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.\r
-  @retval  EFI_DEVICE_ERROR An error occurred in getting the option ROM.\r
+  @param  This                  Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r
+  @param  PciHandle             The handle of the PCI device.\r
+  @param  RomImage              If the call succeeds, the pointer to the pointer to the option ROM image.\r
+                                Otherwise, this field is undefined. The memory for RomImage is allocated\r
+                                by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().\r
+                                It is the caller's responsibility to free the memory using the EFI Boot Service\r
+                                FreePool(), when the caller is done with the option ROM.\r
+  @param  RomSize               If the call succeeds, a pointer to the size of the option ROM size. Otherwise,\r
+                                this field is undefined.\r
+\r
+  @retval EFI_SUCCESS           The option ROM was available for this device and loaded into memory.\r
+  @retval EFI_NOT_FOUND         No option ROM was available for this device.\r
+  @retval EFI_OUT_OF_RESOURCES  No memory was available to load the option ROM.\r
+  @retval EFI_DEVICE_ERROR      An error occurred in getting the option ROM.\r

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