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

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

diff --git a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
index 792ac0b78ad2ab4172186d47e3f02bf7ceb4145a..96b45a9900d031c944ee9702f5d54015956c9120 100644 (file)
--- a/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
+++ b/MdePkg/Include/Protocol/PciHostBridgeResourceAllocation.h
@@ -3,18 +3,18 @@
   provides the basic interfaces to abstract a PCI host bridge resource allocation. \r
   This protocol is mandatory if the system includes PCI devices.\r
   \r
   provides the basic interfaces to abstract a PCI host bridge resource allocation. \r
   This protocol is mandatory if the system includes PCI devices.\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
+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 UEFI Platform Initialization Specification 1.2 \r
 \r
   @par Revision Reference:\r
   This Protocol is defined in UEFI Platform Initialization Specification 1.2 \r

-  Volume 5: Standards\r
+  Volume 5: Standards.\r

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


@@ -28,7 +28,7 @@
 #include <Protocol/PciRootBridgeIo.h>\r
 \r
 ///\r
 #include <Protocol/PciRootBridgeIo.h>\r
 \r
 ///\r

-/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+/// Global ID for the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r

 ///\r
 #define EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GUID \\r
   { \\r
 ///\r
 #define EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL_GUID \\r
   { \\r


@@ -36,7 +36,7 @@
   }\r
 \r
 ///\r
   }\r
 \r
 ///\r

-/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+/// Forward declaration for EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r

 ///\r
 typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL;\r
 \r
 ///\r
 typedef struct _EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL;\r
 \r


@@ -78,7 +78,7 @@ typedef UINT64 EFI_RESOURCE_ALLOCATION_STATUS;
 #define EFI_RESOURCE_NOT_SATISFIED  0xFFFFFFFFFFFFFFFFULL\r
 \r
 ///\r
 #define EFI_RESOURCE_NOT_SATISFIED  0xFFFFFFFFFFFFFFFFULL\r
 \r
 ///\r

-/// This  enum is used to specify the phase of the PCI enumaeration process\r
+/// This  enum is used to specify the phase of the PCI enumaeration process.\r

 ///\r
 typedef enum {\r
   ///\r
 ///\r
 typedef enum {\r
   ///\r


@@ -132,7 +132,14 @@ typedef enum {
   /// The resource allocation phase is completed.  No specific action is required\r
   /// here. This notification can be used to perform any chipset specific programming.  \r
   ///\r
   /// The resource allocation phase is completed.  No specific action is required\r
   /// here. This notification can be used to perform any chipset specific programming.  \r
   ///\r

-  EfiPciHostBridgeEndResourceAllocation\r
+  EfiPciHostBridgeEndResourceAllocation,\r
+\r
+  ///\r
+  /// The Host Bridge Enumeration is completed. No specific action is required here.\r
+  /// This notification can be used to perform any chipset specific programming.\r
+  ///\r
+  EfiPciHostBridgeEndEnumeration,\r
+  EfiMaxPciHostBridgeEnumerationPhase\r

 } EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE;\r
 \r
 ///\r
 } EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE;\r
 \r
 ///\r


@@ -160,9 +167,9 @@ typedef enum {
   These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI \r
   enumeration process.\r
 \r
   These are the notifications from the PCI bus driver that it is about to enter a certain phase of the PCI \r
   enumeration process.\r
 \r

-  @param[in] This    Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in] This    The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                      instance.\r
                      instance.\r

-  @param[in] Phase   The phase during enumeration\r
+  @param[in] Phase   The phase during enumeration.\r

 \r
   @retval EFI_SUCCESS             The notification was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER   The Phase is invalid.\r
 \r
   @retval EFI_SUCCESS             The notification was accepted without any errors.\r
   @retval EFI_INVALID_PARAMETER   The Phase is invalid.\r


@@ -188,7 +195,7 @@ EFI_STATUS
 /**\r
   Returns the device handle of the next PCI root bridge that is associated with this host bridge.\r
 \r
 /**\r
   Returns the device handle of the next PCI root bridge that is associated with this host bridge.\r
 \r

-  @param[in]     This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in]     This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                                     instance.\r
   @param[in,out] RootBridgeHandle   Returns the device handle of the next PCI root bridge. On input, it holds the \r
                                     RootBridgeHandle that was returned by the most recent call to \r
                                     instance.\r
   @param[in,out] RootBridgeHandle   Returns the device handle of the next PCI root bridge. On input, it holds the \r
                                     RootBridgeHandle that was returned by the most recent call to \r


@@ -211,7 +218,7 @@ EFI_STATUS
 /**\r
   Returns the allocation attributes of a PCI root bridge.\r
 \r
 /**\r
   Returns the allocation attributes of a PCI root bridge.\r
 \r

-  @param[in]  This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in]  This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                                  instance.\r
   @param[in]  RootBridgeHandle   The device handle of the PCI root bridge in which the caller is interested.\r
   @param[out] Attribute          The pointer to attributes of the PCI root bridge.\r
                                  instance.\r
   @param[in]  RootBridgeHandle   The device handle of the PCI root bridge in which the caller is interested.\r
   @param[out] Attribute          The pointer to attributes of the PCI root bridge.\r


@@ -232,10 +239,10 @@ EFI_STATUS
 /**\r
   Sets up the specified PCI root bridge for the bus enumeration process.\r
 \r
 /**\r
   Sets up the specified PCI root bridge for the bus enumeration process.\r
 \r

-  @param[in]  This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in]  This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                                  instance.\r
   @param[in]  RootBridgeHandle   The PCI root bridge to be set up.\r
                                  instance.\r
   @param[in]  RootBridgeHandle   The PCI root bridge to be set up.\r

-  @param[out] Configuration      Pointer to the pointer to the PCI bus resource descriptor.\r
+  @param[out] Configuration      The pointer to the pointer to the PCI bus resource descriptor.\r

 \r
   @retval EFI_SUCCESS             The PCI root bridge was set up and the bus range was returned in \r
                                   Configuration.\r
 \r
   @retval EFI_SUCCESS             The PCI root bridge was set up and the bus range was returned in \r
                                   Configuration.\r


@@ -255,10 +262,10 @@ EFI_STATUS
 /**\r
   Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.\r
 \r
 /**\r
   Programs the PCI root bridge hardware so that it decodes the specified PCI bus range.\r
 \r

-  @param[in] This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  @param[in] This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r

                                 instance.  \r
   @param[in] RootBridgeHandle   The PCI root bridge whose bus range is to be programmed.\r
                                 instance.  \r
   @param[in] RootBridgeHandle   The PCI root bridge whose bus range is to be programmed.\r

-  @param[in] Configuration      The pointer to the PCI bus resource descriptor..\r
+  @param[in] Configuration      The pointer to the PCI bus resource descriptor.\r

 \r
   @retval EFI_SUCCESS             The bus range for the PCI root bridge was programmed.\r
   @retval EFI_INVALID_PARAMETER   RootBridgeHandle is not a valid root bridge handle.\r
 \r
   @retval EFI_SUCCESS             The bus range for the PCI root bridge was programmed.\r
   @retval EFI_INVALID_PARAMETER   RootBridgeHandle is not a valid root bridge handle.\r


@@ -287,7 +294,7 @@ 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[in] This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in] This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                                 instance.\r
   @param[in] RootBridgeHandle   The PCI root bridge whose I/O and memory resource requirements are being \r
                                 submitted.\r
                                 instance.\r
   @param[in] RootBridgeHandle   The PCI root bridge whose I/O and memory resource requirements are being \r
                                 submitted.\r


@@ -319,7 +326,7 @@ EFI_STATUS
 /**\r
   Returns the proposed resource settings for the specified PCI root bridge.\r
 \r
 /**\r
   Returns the proposed resource settings for the specified PCI root bridge.\r
 \r

-  @param[in]  This               Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r
+  @param[in]  This               The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL \r

                                  instance.\r
   @param[in]  RootBridgeHandle   The PCI root bridge handle.\r
   @param[out] Configuration      The pointer to the pointer to the PCI I/O and memory resource descriptor.\r
                                  instance.\r
   @param[in]  RootBridgeHandle   The PCI root bridge handle.\r
   @param[out] Configuration      The pointer to the pointer to the PCI I/O and memory resource descriptor.\r


@@ -343,7 +350,7 @@ EFI_STATUS
   stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual \r
   PCI controllers before enumeration.\r
 \r
   stages of the PCI enumeration process that allow the host bridge driver to preinitialize individual \r
   PCI controllers before enumeration.\r
 \r

-  @param[in]  This                  Pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r
+  @param[in]  This                  The pointer to the EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL instance.\r

   @param[in]  RootBridgeHandle      The associated PCI root bridge handle.\r
   @param[in]  PciAddress            The address of the PCI device on the PCI bus.\r
   @param[in]  Phase                 The phase of the PCI device enumeration.\r
   @param[in]  RootBridgeHandle      The associated PCI root bridge handle.\r
   @param[in]  PciAddress            The address of the PCI device on the PCI bus.\r
   @param[in]  Phase                 The phase of the PCI device enumeration.\r