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

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

diff --git a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
index 9d83c5aedb933205bb1bcaa3b392b0f0b3274136..147d07c8f77948cbedcb43ae672040bc7ee93869 100644 (file)
--- a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
+++ b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
@@ -128,13 +128,13 @@ typedef enum {
 /**\r
   Enter a certain phase of the PCI enumeration process\r
 \r
 /**\r
   Enter a certain phase of the PCI enumeration process\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance\r
-  @param  Phase The phase during enumeration\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance\r
+  @param  Phase                 The phase during enumeration\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_OUT_OF_RESOURCES If SubmitResources ( ) could not allocate resources\r
-  @retval  EFI_NOT_READY This phase cannot be entered at this time\r
-  @retval  EFI_DEVICE_ERROR SetResources failed due to HW error.\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_OUT_OF_RESOURCES  If SubmitResources ( ) could not allocate resources\r
+  @retval EFI_NOT_READY         This phase cannot be entered at this time\r
+  @retval EFI_DEVICE_ERROR      SetResources failed due to HW error.\r

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


@@ -149,14 +149,14 @@ EFI_STATUS
   Return the device handle of the next PCI root bridge that is associated with \r
   this Host Bridge\r
 \r
   Return the device handle of the next PCI root bridge that is associated with \r
   this Host Bridge\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle Returns the device handle of the next PCI Root Bridge.\r
-  On input, it holds the RootBridgeHandle returned by the most\r
-  recent call to GetNextRootBridge().The handle for the first\r
-  PCI Root Bridge is returned if RootBridgeHandle is NULL on input\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      Returns the device handle of the next PCI Root Bridge.\r
+                                On input, it holds the RootBridgeHandle returned by the most\r
+                                recent call to GetNextRootBridge().The handle for the first\r
+                                PCI Root Bridge is returned if RootBridgeHandle is NULL on input\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r

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


@@ -170,14 +170,14 @@ EFI_STATUS
 /**\r
   Returns the attributes of a PCI Root Bridge.\r
 \r
 /**\r
   Returns the attributes of a PCI Root Bridge.\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The device handle of the PCI Root Bridge\r
-  that the caller is interested in\r
-  @param  Attribute The pointer to attributes of the PCI Root Bridge\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The device handle of the PCI Root Bridge\r
+                                that the caller is interested in\r
+  @param  Attribute             The pointer to attributes of the PCI Root Bridge\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_INVALID_PARAMETER Attributes is NULL\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_INVALID_PARAMETER Attributes is NULL\r

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


@@ -193,14 +193,14 @@ EFI_STATUS
   This is the request from the PCI enumerator to set up \r
   the specified PCI Root Bridge for bus enumeration process. \r
 \r
   This is the request from the PCI enumerator to set up \r
   the specified PCI Root Bridge for bus enumeration process. \r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The PCI Root Bridge to be set up\r
-  @param  Configuration Pointer to the pointer to the PCI bus resource descriptor\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The PCI Root Bridge to be set up\r
+  @param  Configuration         Pointer to the pointer to the PCI bus resource descriptor\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error\r
-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error\r
+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources\r

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


@@ -216,20 +216,20 @@ EFI_STATUS
   This function programs the PCI Root Bridge hardware so that \r
   it decodes the specified PCI bus range\r
 \r
   This function programs the PCI Root Bridge hardware so that \r
   it decodes the specified PCI bus range\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The PCI Root Bridge whose bus range is to be programmed\r
-  @param  Configuration The pointer to the PCI bus resource descriptor\r
-\r
-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_INVALID_PARAMETER Configuration is NULL\r
-  @retval  EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor\r
-  @retval  EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor\r
-  @retval  EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration\r
-  are invalid for this Root Bridge.\r
-  @retval  EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor\r
-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error\r
-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The PCI Root Bridge whose bus range is to be programmed\r
+  @param  Configuration         The pointer to the PCI bus resource descriptor\r
+\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_INVALID_PARAMETER Configuration is NULL\r
+  @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor\r
+  @retval EFI_INVALID_PARAMETER Configuration contains one or more memory or IO ACPI resource descriptor\r
+  @retval EFI_INVALID_PARAMETER Address Range Minimum or Address Range Length fields in Configuration\r
+                                are invalid for this Root Bridge.\r
+  @retval EFI_INVALID_PARAMETER Configuration contains one or more invalid ACPI resource descriptor\r
+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error\r
+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources\r

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


@@ -244,16 +244,16 @@ EFI_STATUS
 /**\r
   Submits the I/O and memory resource requirements for the specified PCI Root Bridge\r
 \r
 /**\r
   Submits the I/O and memory resource requirements for the specified PCI Root Bridge\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The PCI Root Bridge whose I/O and memory resource requirements\r
-  are being submitted\r
-  @param  Configuration The pointer to the PCI I/O and PCI memory resource descriptor\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The PCI Root Bridge whose I/O and memory resource requirements\r
+                                are being submitted\r
+  @param  Configuration         The pointer to the PCI I/O and PCI memory resource descriptor\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_INVALID_PARAMETER Configuration is NULL\r
-  @retval  EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor\r
-  @retval  EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_INVALID_PARAMETER Configuration is NULL\r
+  @retval EFI_INVALID_PARAMETER Configuration does not point to a valid ACPI resource descriptor\r
+  @retval EFI_INVALID_PARAMETER Configuration includes a resource descriptor of unsupported type\r

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


@@ -269,15 +269,15 @@ EFI_STATUS
   This function returns the proposed resource settings for the specified \r
   PCI Root Bridge\r
 \r
   This function returns the proposed resource settings for the specified \r
   PCI Root Bridge\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The PCI Root Bridge handle\r
-  @param  Configuration The pointer to the pointer to the PCI I/O\r
-  and memory resource descriptor\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The PCI Root Bridge handle\r
+  @param  Configuration         The pointer to the pointer to the PCI I/O\r
+                                and memory resource descriptor\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_DEVICE_ERROR Request failed due to hardware error\r
-  @retval  EFI_OUT_OF_RESOURCES Request failed due to lack of resources\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_DEVICE_ERROR      Request failed due to hardware error\r
+  @retval EFI_OUT_OF_RESOURCES  Request failed due to lack of resources\r

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


@@ -294,14 +294,14 @@ EFI_STATUS
   This function is called for all the PCI controllers that the PCI \r
   bus driver finds. Can be used to Preprogram the controller.\r
 \r
   This function is called for all the PCI controllers that the PCI \r
   bus driver finds. Can be used to Preprogram the controller.\r
 \r

-  @param  This The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
-  @param  RootBridgeHandle The PCI Root Bridge handle\r
-  @param  PciBusAddress Address of the controller on the PCI bus\r
-  @param Phase The Phase during resource allocation\r
+  @param  This                  The EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_ PROTOCOL instance\r
+  @param  RootBridgeHandle      The PCI Root Bridge handle\r
+  @param  PciBusAddress         Address of the controller on the PCI bus\r
+  @param  Phase                 The Phase during resource allocation\r

 \r
 \r

-  @retval  EFI_SUCCESS Success\r
-  @retval  EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
-  @retval  EFI_DEVICE_ERROR Device pre-initialization failed due to hardware error.\r
+  @retval EFI_SUCCESS           Success\r
+  @retval EFI_INVALID_PARAMETER RootBridgeHandle is invalid\r
+  @retval EFI_DEVICE_ERROR      Device pre-initialization failed due to hardware error.\r

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