Update For R9 Review.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciLib.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c
index d7f7cc77eaac98ac492dfa66c982ef269d0e6509..fd8eaf43257c705d5e08e8eaa24e50d5a7482c4e 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.c
@@ -47,9 +47,9 @@ InstallHotPlugRequestProtocol (
 \r
 /**\r
   Install protocol gEfiPciHotplugDeviceGuid into hotplug device\r
-  instance\r
+  instance.\r
   \r
-  @param PciIoDevice  hotplug device instance\r
+  @param PciIoDevice  hotplug device instance.\r
   \r
 **/\r
 VOID\r
@@ -77,9 +77,9 @@ InstallPciHotplugGuid (
 \r
 /**\r
   UnInstall protocol gEfiPciHotplugDeviceGuid into hotplug device\r
-  instance\r
+  instance.\r
   \r
-  @param PciIoDevice  hotplug device instance\r
+  @param PciIoDevice  hotplug device instance.\r
   \r
 **/\r
 VOID\r
@@ -116,9 +116,9 @@ UninstallPciHotplugGuid (
 }\r
 \r
 /**\r
-  Retrieve the BAR information via PciIo interface\r
+  Retrieve the BAR information via PciIo interface.\r
   \r
-  @param PciIoDevice Pci device instance\r
+  @param PciIoDevice Pci device instance.\r
 **/\r
 VOID\r
 GetBackPcCardBar (\r
@@ -196,8 +196,8 @@ GetBackPcCardBar (
   Remove rejected pci device from specific root bridge\r
   handle.\r
   \r
-  @param RootBridgeHandle  specific parent root bridge handle\r
-  @param Bridge            Bridge device instance\r
+  @param RootBridgeHandle  specific parent root bridge handle.\r
+  @param Bridge            Bridge device instance.\r
   \r
   @retval EFI_SUCCESS  Success operation.\r
 **/\r
@@ -261,7 +261,7 @@ RemoveRejectedPciDevices (
 /**\r
   Wrapper function for allocating resource for pci host bridge.\r
   \r
-  @param PciResAlloc Point to protocol instance EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  @param PciResAlloc Point to protocol instance EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
   \r
 **/\r
 EFI_STATUS\r
@@ -281,11 +281,11 @@ PciHostBridgeResourceAllocator (
 }\r
 \r
 /**\r
-  Submits the I/O and memory resource requirements for the specified PCI Root Bridge\r
+  Submits the I/O and memory resource requirements for the specified PCI Root Bridge.\r
 \r
-  @param PciResAlloc  Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  @param PciResAlloc  Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
 \r
-  @retval EFI_SUCCESS           Success\r
+  @retval EFI_SUCCESS           Success.\r
 **/\r
 EFI_STATUS\r
 PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (\r
@@ -644,11 +644,11 @@ PciHostBridgeResourceAllocator_WithoutHotPlugDeviceSupport (
 }\r
 \r
 /**\r
-  Submits the I/O and memory resource requirements for the specified PCI Root Bridge\r
+  Submits the I/O and memory resource requirements for the specified PCI Root Bridge.\r
 \r
-  @param PciResAlloc  Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  @param PciResAlloc  Point to protocol instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
 \r
-  @retval EFI_SUCCESS           Success\r
+  @retval EFI_SUCCESS           Success.\r
 **/\r
 EFI_STATUS\r
 PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (\r
@@ -1138,15 +1138,15 @@ PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
 \r
 /**\r
   Wapper function of scanning pci bus and assign bus number to the given PCI bus system\r
-  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug  \r
+  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.\r
   \r
-  @param  Bridge          Bridge device instance\r
-  @param  StartBusNumber  start point\r
-  @param  SubBusNumber    Point to sub bus number\r
-  @param  PaddedBusRange  Customized bus number\r
+  @param  Bridge          Bridge device instance.\r
+  @param  StartBusNumber  start point.\r
+  @param  SubBusNumber    Point to sub bus number.\r
+  @param  PaddedBusRange  Customized bus number.\r
   \r
-  @retval EFI_SUCCESS     Success\r
-  @retval EFI_DEVICE_ERROR Fail to scan bus\r
+  @retval EFI_SUCCESS     Success.\r
+  @retval EFI_DEVICE_ERROR Fail to scan bus.\r
 **/\r
 EFI_STATUS\r
 PciScanBus (\r
@@ -1175,15 +1175,15 @@ PciScanBus (
 \r
 /**\r
   Wapper function of scanning pci bus and assign bus number to the given PCI bus system\r
-  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug  \r
+  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.  \r
   \r
-  @param  Bridge          Bridge device instance\r
-  @param  StartBusNumber  start point\r
-  @param  SubBusNumber    Point to sub bus number\r
-  @param  PaddedBusRange  Customized bus number\r
+  @param  Bridge          Bridge device instance.\r
+  @param  StartBusNumber  start point.\r
+  @param  SubBusNumber    Point to sub bus number.\r
+  @param  PaddedBusRange  Customized bus number.\r
   \r
-  @retval EFI_SUCCESS     Success\r
-  @retval EFI_DEVICE_ERROR Fail to scan bus\r
+  @retval EFI_SUCCESS     Success.\r
+  @retval EFI_DEVICE_ERROR Fail to scan bus.\r
 **/\r
 EFI_STATUS\r
 PciScanBus_WithoutHotPlugDeviceSupport (\r
@@ -1353,15 +1353,15 @@ PciScanBus_WithoutHotPlugDeviceSupport (
 \r
 /**\r
   Wapper function of scanning pci bus and assign bus number to the given PCI bus system\r
-  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug  \r
+  Feature flag PcdPciBusHotplugDeviceSupport determine whether need support hotplug.  \r
   \r
-  @param  Bridge          Bridge device instance\r
-  @param  StartBusNumber  start point\r
-  @param  SubBusNumber    Point to sub bus number\r
-  @param  PaddedBusRange  Customized bus number\r
+  @param  Bridge          Bridge device instance.\r
+  @param  StartBusNumber  start point.\r
+  @param  SubBusNumber    Point to sub bus number.\r
+  @param  PaddedBusRange  Customized bus number.\r
   \r
-  @retval EFI_SUCCESS     Success\r
-  @retval EFI_DEVICE_ERROR Fail to scan bus\r
+  @retval EFI_SUCCESS     Success.\r
+  @retval EFI_DEVICE_ERROR Fail to scan bus.\r
 **/\r
 EFI_STATUS\r
 PciScanBus_WithHotPlugDeviceSupport (\r
@@ -1642,11 +1642,11 @@ PciScanBus_WithHotPlugDeviceSupport (
 }\r
 \r
 /**\r
-  Process Option Rom on this host bridge\r
+  Process Option Rom on this host bridge.\r
   \r
-  @param Bridge  Pci bridge device instance\r
+  @param Bridge  Pci bridge device instance.\r
   \r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_SUCCESS Success.\r
 **/\r
 EFI_STATUS\r
 PciRootBridgeP2CProcess (\r
@@ -1712,12 +1712,12 @@ PciRootBridgeP2CProcess (
 }\r
 \r
 /**\r
-  Process Option Rom on this host bridge\r
+  Process Option Rom on this host bridge.\r
   \r
-  @param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL\r
+  @param PciResAlloc Pointer to instance of EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL.\r
   \r
-  @retval EFI_NOT_FOUND Can not find the root bridge instance\r
-  @retval EFI_SUCCESS   Success process\r
+  @retval EFI_NOT_FOUND Can not find the root bridge instance.\r
+  @retval EFI_SUCCESS   Success process.\r
 **/\r
 EFI_STATUS\r
 PciHostBridgeP2CProcess (\r
@@ -1758,12 +1758,12 @@ PciHostBridgeP2CProcess (
 \r
 /**\r
   This function is used to enumerate the entire host bridge\r
-  in a given platform\r
+  in a given platform.\r
 \r
   @param PciResAlloc   A pointer to the resource allocate protocol.\r
 \r
-  @retval EFI_OUT_OF_RESOURCES no enough resource\r
-  @retval EFI_SUCCESS Success\r
+  @retval EFI_OUT_OF_RESOURCES no enough resource.\r
+  @retval EFI_SUCCESS Success.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1998,7 +1998,7 @@ PciHostBridgeEnumerator (
   @param  PciIo               A pointer to EFI_PCI_PROTOCOL.\r
   @param  PciDeviceInfo       A pointer to EFI_PCI_DEVICE_INFO.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2158,7 +2158,8 @@ ReadConfigData (
 \r
   @param  PciDeviceInfo       A pointer to EFI_PCI_DEVICE_INFO.\r
   @param  AccessType          Access type, READ or WRITE.\r
-  @Param  Address             The address within the PCI configuration space.\r
+  @param  Width               Signifies the width of the memory operations.\r
+  @param  Address             The address within the PCI configuration space.\r
   @param  Buffer              Store the register data.\r
 \r
   @retval EFI_SUCCESS         The data has been updated.\r
@@ -2229,7 +2230,7 @@ UpdateConfigData (
   @param  PciIo               A pointer to EFI_PCI_PROTOCOL.\r
   @param  PciDeviceInfo       A pointer to EFI_PCI_DEVICE_INFO.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2407,7 +2408,7 @@ WriteConfigData (
   @param  PciRootBridgeIo     A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
   @param  PciIo               A pointer to EFI_PCI_PROTOCOL.\r
   @param  Pci                 A pointer to PCI_TYPE00.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
   @param  PciDeviceInfo       A pointer to EFI_PCI_DEVICE_INFO.\r
 \r
   @retval EFI_SUCCESS         Pci device device information has been abstracted.\r
@@ -2508,7 +2509,8 @@ GetPciDeviceDeviceInfo (
   @param  PciIo               A pointer to the EFI_PCI_IO_PROTOCOL.\r
   @param  Pci                 A pointer to PCI_TYPE00.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be read.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2574,7 +2576,8 @@ PciIncompatibilityCheckRead (
   @param  PciIo               A pointer to the EFI_PCI_IO_PROTOCOL.\r
   @param  Pci                 A pointer to PCI_TYPE00.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be write.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2658,7 +2661,8 @@ PciIncompatibilityCheckWrite (
   @param  PciRootBridgeIo     A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
   @param  Pci                 A pointer to PCI_TYPE00.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be read.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2708,7 +2712,8 @@ PciRootBridgeIoRead (
   @param  PciRootBridgeIo     A pointer to the EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
   @param  Pci                 A pointer to PCI_TYPE00.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be read.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2758,7 +2763,8 @@ PciRootBridgeIoWrite (
 \r
   @param  PciIo               A pointer to the EFI_PCI_O_PROTOCOL.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be read.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r
@@ -2806,7 +2812,8 @@ PciIoRead (
 \r
   @param  PciIo               A pointer to the EFI_PCI_O_PROTOCOL.\r
   @param  Width               Signifies the width of the memory operations.\r
-  @Param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Address             The address within the PCI configuration space for the PCI controller.\r
+  @param  Count               The number of unit to be read.\r
   @param  Buffer              For read operations, the destination buffer to store the results. For\r
                               write operations, the source buffer to write data from.\r
 \r