Update For R9 Review.

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

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h
index ab46b5ac8a48f7a74d7714561e8938659547c4ca..1900990a15f8eeb5421796a4cff8d59fb64afa0d 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciEnumeratorSupport.h
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 **/\r
 \r
 \r
-#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H\r
-#define _EFI_PCI_ENUMERATOR_SUPPORT_H\r
+#ifndef _EFI_PCI_ENUMERATOR_SUPPORT_H_\r
+#define _EFI_PCI_ENUMERATOR_SUPPORT_H_\r
 \r
 /**\r
   This routine is used to check whether the pci device is present.\r
@@ -42,7 +42,7 @@ PciDevicePresent (
   root bridge will then be created.\r
     \r
   @param Bridge         Parent bridge instance\r
-  @param StartBusNumer  Bus number of begining \r
+  @param StartBusNumber Bus number of begining \r
 **/\r
 EFI_STATUS\r
 PciPciDeviceInfoCollector (\r
@@ -62,12 +62,12 @@ PciPciDeviceInfoCollector (
 **/\r
 EFI_STATUS\r
 PciSearchDevice (\r
-  IN PCI_IO_DEVICE                      *Bridge,\r
-  PCI_TYPE00                            *Pci,\r
-  UINT8                                 Bus,\r
-  UINT8                                 Device,\r
-  UINT8                                 Func,\r
-  PCI_IO_DEVICE                         **PciDevice\r
+  IN  PCI_IO_DEVICE                         *Bridge,\r
+  IN  PCI_TYPE00                            *Pci,\r
+  IN  UINT8                                 Bus,\r
+  IN  UINT8                                 Device,\r
+  IN  UINT8                                 Func,\r
+  OUT PCI_IO_DEVICE                         **PciDevice\r
   );\r
 \r
 /**\r
@@ -99,7 +99,7 @@ GatherDeviceInfo (
   @param Device     Bridge device's device NO.\r
   @param Func       Bridge device's func NO.\r
   \r
-  @return bridge device instance\r
+  @return bridge device instance.\r
 **/\r
 PCI_IO_DEVICE             *\r
 GatherPpbInfo (\r
@@ -133,8 +133,8 @@ GatherP2CInfo (
 /**\r
   Create device path for pci deivce\r
   \r
-  @param ParentDevicePath  Parent bridge's path\r
-  @param PciIoDevice       Pci device instance\r
+  @param ParentDevicePath  Parent bridge's path.\r
+  @param PciIoDevice       Pci device instance.\r
   \r
   @return device path protocol instance for specific pci device.\r
 **/\r
@@ -173,7 +173,7 @@ BarExisted (
   @param OldCommand    Old command register offset\r
   @param OldBridgeControl Old Bridge control value for PPB or P2C.\r
   \r
-  @return EFI_SUCCESS\r
+  @return EFI_SUCCESS.\r
 **/\r
 EFI_STATUS\r
 PciTestSupportedAttribute (\r
@@ -204,8 +204,8 @@ PciSetDeviceAttribute (
 /**\r
   Determine if the device can support Fast Back to Back attribute\r
   \r
-  @param PciIoDevice  Pci device instance\r
-  @param StatusIndex  Status register value\r
+  @param PciIoDevice  Pci device instance.\r
+  @param StatusIndex  Status register value.\r
 **/\r
 EFI_STATUS\r
 GetFastBackToBackSupport (\r
@@ -216,7 +216,7 @@ GetFastBackToBackSupport (
 /**\r
  Determine the related attributes of all devices under a Root Bridge\r
  \r
- @param PciIoDevice   PCI device instance\r
+ @param PciIoDevice   PCI device instance.\r
  \r
 **/\r
 EFI_STATUS\r
@@ -227,8 +227,8 @@ DetermineDeviceAttribute (
 /**\r
   This routine is used to update the bar information for those incompatible PCI device\r
   \r
-  @param PciIoDevice      Pci device instance\r
-  @return EFI_UNSUPPORTED failed to update Pci Info\r
+  @param PciIoDevice      Pci device instance.\r
+  @return EFI_UNSUPPORTED failed to update Pci Info.\r
 **/\r
 EFI_STATUS\r
 UpdatePciInfo (\r
@@ -238,8 +238,8 @@ UpdatePciInfo (
 /**\r
   This routine will update the alignment with the new alignment\r
   \r
-  @param Alignment old alignment\r
-  @param NewAlignment new alignment\r
+  @param Alignment old alignment.\r
+  @param NewAlignment new alignment.\r
   \r
 **/\r
 VOID\r
@@ -251,9 +251,9 @@ SetNewAlign (
 /**\r
   Parse PCI bar bit.\r
   \r
-  @param PciIoDevice  Pci device instance\r
-  @param Offset       bar offset\r
-  @param BarIndex     bar index\r
+  @param PciIoDevice  Pci device instance.\r
+  @param Offset       bar offset.\r
+  @param BarIndex     bar index.\r
   \r
   @return next bar offset.\r
 **/\r
@@ -266,9 +266,9 @@ PciParseBar (
 \r
 /**\r
   This routine is used to initialize the bar of a PCI device\r
-  It can be called typically when a device is going to be rejected\r
+  It can be called typically when a device is going to be rejected.\r
 \r
-  @param PciIoDevice Pci device instance\r
+  @param PciIoDevice Pci device instance.\r
 **/\r
 EFI_STATUS\r
 InitializePciDevice (\r
@@ -278,7 +278,7 @@ InitializePciDevice (
 /**\r
   Init PPB for bridge device\r
   \r
-  @param  PciIoDevice Pci device instance\r
+  @param  PciIoDevice Pci device instance.\r
 **/\r
 EFI_STATUS\r
 InitializePpb (\r
@@ -288,7 +288,7 @@ InitializePpb (
 /**\r
   Init private data for Hotplug bridge device\r
   \r
-  @param PciIoDevice hotplug bridge device\r
+  @param PciIoDevice hotplug bridge device.\r
 **/\r
 EFI_STATUS\r
 InitializeP2C (\r
@@ -299,13 +299,13 @@ InitializeP2C (
   Create and initiliaze general PCI I/O device instance for\r
   PCI device/bridge device/hotplug bridge device.\r
   \r
-  @param PciRootBridgeIo   Pointer to instance of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL\r
+  @param PciRootBridgeIo   Pointer to instance of EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL.\r
   @param Pci               Pci bar block\r
   @param Bus               device Bus NO.\r
   @param Device            device device NO.\r
   @param Func              device func NO.\r
   \r
-  @return instance of PCI device\r
+  @return instance of PCI device.\r
 **/\r
 PCI_IO_DEVICE             *\r
 CreatePciIoDevice (\r
@@ -321,7 +321,7 @@ CreatePciIoDevice (
   in a given platform\r
   It is only called on the second start on the same Root Bridge.\r
 \r
-  @param Controller  Parent bridge handler\r
+  @param Controller  Parent bridge handler.\r
   \r
   @return status of operation.\r
 **/\r
@@ -349,6 +349,14 @@ PciGetBusRange (
   OUT    UINT16                             *BusRange\r
   );\r
 \r
+/**\r
+  This routine can be used to start the root bridge.\r
+\r
+  @param RootBridgeDev     Pci device instance.\r
+\r
+  @retval EFI_SUCCESS      This device started.\r
+  \r
+**/\r
 EFI_STATUS\r
 StartManagingRootBridge (\r
   IN PCI_IO_DEVICE *RootBridgeDev\r
@@ -357,10 +365,10 @@ StartManagingRootBridge (
 /**\r
   This routine can be used to check whether a PCI device should be rejected when light enumeration\r
 \r
-  @param PciIoDevice  Pci device instance\r
+  @param PciIoDevice  Pci device instance.\r
 \r
-  @retval TRUE      This device should be rejected\r
-  @retval FALSE     This device shouldn't be rejected\r
+  @retval TRUE      This device should be rejected.\r
+  @retval FALSE     This device shouldn't be rejected.\r
   \r
 **/\r
 BOOLEAN\r