Code scrub for PCI Bus module and PciIncompatibleDeviceSupportLib module.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciDeviceSupport.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
index afe1edddc62641c88097f6340b658b09e146e93b..d80088a246b44784498fd9f75cf18f4e2c061f5d 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDeviceSupport.h
@@ -1,14 +1,14 @@
 /** @file\r
   Supporting functions declaration for PCI devices management.\r
 \r
-Copyright (c) 2006 - 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) 2006 - 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
 \r
 **/\r
 \r
@@ -51,9 +51,9 @@ InsertPciDevice (
 \r
 /**\r
   Destroy root bridge and remove it from deivce tree.\r
-  \r
+\r
   @param RootBridge     The bridge want to be removed.\r
-  \r
+\r
 **/\r
 VOID\r
 DestroyRootBridge (\r
@@ -91,10 +91,10 @@ DestroyRootBridgeByHandle (
   );\r
 \r
 /**\r
-  This function registers the PCI IO device. \r
+  This function registers the PCI IO device.\r
 \r
-  It creates a handle for this PCI IO device (if the handle does not exist), attaches \r
-  appropriate protocols onto the handle, does necessary initialization, and sets up \r
+  It creates a handle for this PCI IO device (if the handle does not exist), attaches\r
+  appropriate protocols onto the handle, does necessary initialization, and sets up\r
   parent/child relationship with its bus controller.\r
 \r
   @param Controller     An EFI handle for the PCI bus controller.\r
@@ -102,7 +102,7 @@ DestroyRootBridgeByHandle (
   @param Handle         A pointer to hold the returned EFI handle for the PCI IO device.\r
 \r
   @retval EFI_SUCCESS   The PCI device is successfully registered.\r
-  @retval Others        An error occurred when registering the PCI device.\r
+  @retval other         An error occurred when registering the PCI device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -136,7 +136,7 @@ RemoveAllPciDeviceOnBridge (
   @param Handle        PCI device handle.\r
 \r
   @retval EFI_SUCCESS  The PCI device is successfully de-registered.\r
-  @retval Others       An error occurred when de-registering the PCI device.\r
+  @retval other        An error occurred when de-registering the PCI device.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -148,7 +148,7 @@ DeRegisterPciDevice (
 /**\r
   Start to manage the PCI device on specified the root bridge or PCI-PCI Bridge\r
 \r
-  @param Controller          An efi handle.\r
+  @param Controller          The root bridge handle.\r
   @param RootBridge          A pointer to the PCI_IO_DEVICE.\r
   @param RemainingDevicePath A pointer to the EFI_DEVICE_PATH_PROTOCOL.\r
   @param NumberOfChildren    Children number.\r
@@ -156,8 +156,8 @@ DeRegisterPciDevice (
 \r
   @retval EFI_NOT_READY   Device is not allocated.\r
   @retval EFI_UNSUPPORTED Device only support PCI-PCI bridge.\r
-  @retval EFI_NOT_FOUND   Can not find the specific device\r
-  @retval EFI_SUCCESS     Success to start Pci device on bridge\r
+  @retval EFI_NOT_FOUND   Can not find the specific device.\r
+  @retval EFI_SUCCESS     Success to start Pci device on bridge.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -170,10 +170,13 @@ StartPciDevicesOnBridge (
   );\r
 \r
 /**\r
-  Start to manage all the PCI devices it found previously under \r
+  Start to manage all the PCI devices it found previously under\r
   the entire host bridge.\r
 \r
-  @param Controller          - root bridge handle.\r
+  @param Controller          The root bridge handle.\r
+\r
+  @retval EFI_NOT_READY   Device is not allocated.\r
+  @retval EFI_SUCCESS     Success to start Pci device on host bridge.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -212,10 +215,10 @@ GetRootBridgeByHandle (
 \r
 /**\r
   Judege whether Pci device existed.\r
-  \r
+\r
   @param Bridge       Parent bridege instance.\r
   @param PciIoDevice  Device instance.\r
-  \r
+\r
   @retval TRUE        Pci device existed.\r
   @retval FALSE       Pci device did not exist.\r
 \r
@@ -228,9 +231,9 @@ PciDeviceExisted (
 \r
 /**\r
   Get the active VGA device on the same segment.\r
-  \r
+\r
   @param VgaDevice    PCI IO instance for the VGA device.\r
-  \r
+\r
   @return The active VGA device on the same segment.\r
 \r
 **/\r
@@ -241,9 +244,9 @@ ActiveVGADeviceOnTheSameSegment (
 \r
 /**\r
   Get the active VGA device on the root bridge.\r
-  \r
+\r
   @param RootBridge  PCI IO instance for the root bridge.\r
-  \r
+\r
   @return The active VGA device.\r
 \r
 **/\r
@@ -258,10 +261,10 @@ ActiveVGADeviceOnTheRootBridge (
   @param RootBridge           Root bridege Io instance.\r
   @param RemainingDevicePath  Given searching device path.\r
   @param PciAddress           Buffer holding searched result.\r
-  \r
+\r
   @retval EFI_SUCCESS         PCI address was stored in PciAddress.\r
   @retval EFI_NOT_FOUND       Can not find the specific device path.\r
-  \r
+\r
 **/\r
 EFI_STATUS\r
 GetHpcPciAddressFromRootBridge (\r