Add function doxygen header for PciBus module.

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

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.h
index b8dc2a61f3ba148489da8e3c64e97666a7679086..639da70be8253d3439445ac7936adf987c8b2ce2 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciLib.h
@@ -49,132 +49,79 @@ typedef struct {
   UINT8                              *AllocRes;\r
 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA_PAYLOAD;\r
 \r
+/**\r
+  Install protocol gEfiPciHotPlugRequestProtocolGuid\r
+  @param Status    return status of protocol installation.\r
+**/\r
 void\r
 InstallHotPlugRequestProtocol (\r
   IN  EFI_STATUS                    *Status\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Status  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  Install protocol gEfiPciHotplugDeviceGuid into hotplug device\r
+  instance\r
+  \r
+  @param PciIoDevice  hotplug device instance\r
+  \r
+**/\r
 VOID\r
 InstallPciHotplugGuid (\r
   IN  PCI_IO_DEVICE                  *PciIoDevice\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  UnInstall protocol gEfiPciHotplugDeviceGuid into hotplug device\r
+  instance\r
+  \r
+  @param PciIoDevice  hotplug device instance\r
+  \r
+**/\r
 VOID\r
 UninstallPciHotplugGuid (\r
   IN  PCI_IO_DEVICE                  *PciIoDevice\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  Retrieve the BAR information via PciIo interface\r
+  \r
+  @param PciIoDevice Pci device instance\r
+**/\r
 VOID\r
 GetBackPcCardBar (\r
   IN  PCI_IO_DEVICE                  *PciIoDevice\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  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
+  \r
+  @retval EFI_SUCCESS  Success operation.\r
+**/\r
 EFI_STATUS\r
 RemoveRejectedPciDevices (\r
   EFI_HANDLE        RootBridgeHandle,\r
   IN PCI_IO_DEVICE  *Bridge\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  RootBridgeHandle  - TODO: add argument description\r
-  Bridge            - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\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
+  \r
+**/\r
 EFI_STATUS\r
 PciHostBridgeResourceAllocator (\r
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciResAlloc - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
 EFI_STATUS\r
@@ -189,6 +136,18 @@ PciHostBridgeResourceAllocator_WithHotPlugDeviceSupport (
   )\r
 ;\r
 \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
+  \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
+**/\r
 EFI_STATUS\r
 PciScanBus (\r
   IN PCI_IO_DEVICE                      *Bridge,\r
@@ -196,24 +155,6 @@ PciScanBus (
   OUT UINT8                             *SubBusNumber,\r
   OUT UINT8                             *PaddedBusRange\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Bridge          - TODO: add argument description\r
-  StartBusNumber  - TODO: add argument description\r
-  SubBusNumber    - TODO: add argument description\r
-  PaddedBusRange  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
 EFI_STATUS\r
@@ -234,67 +175,49 @@ PciScanBus_WithoutHotPlugDeviceSupport (
   )\r
 ;\r
 \r
+/**\r
+  Process Option Rom on this host bridge\r
+  \r
+  @param Bridge  Pci bridge device instance\r
+  \r
+  @retval EFI_SUCCESS Success\r
+**/\r
+\r
 EFI_STATUS\r
 PciRootBridgeP2CProcess (\r
   IN PCI_IO_DEVICE *Bridge\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Bridge  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  Process Option Rom on this host bridge\r
+  \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
+**/\r
 EFI_STATUS\r
 PciHostBridgeP2CProcess (\r
   IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL *PciResAlloc\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
+;\r
 \r
-  PciResAlloc - TODO: add argument description\r
+/**\r
+  This function is used to enumerate the entire host bridge\r
+  in a given platform\r
 \r
-Returns:\r
+  @param PciResAlloc   A pointer to the resource allocate protocol.\r
 \r
-  TODO: add return values\r
+  @retval EFI_OUT_OF_RESOURCES no enough resource\r
+  @retval EFI_SUCCESS Success\r
 \r
 **/\r
-;\r
 \r
 EFI_STATUS\r
 PciHostBridgeEnumerator (\r
   EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PROTOCOL  *PciResAlloc\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciResAlloc - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
 /**\r