MdeModulePkg/PciHostBridge: Refine function header comments.

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / PciHostBridgeDxe / PciHostBridge.c

diff --git a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciHostBridge.c b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciHostBridge.c
index 08285d84d501239b0bc6136bb2f937b3986369a7..edf042cc254790a931f8e0130c4b5a6fea92f9ac 100644 (file)
--- a/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciHostBridge.c
+++ b/MdeModulePkg/Bus/Pci/PciHostBridgeDxe/PciHostBridge.c
@@ -258,6 +258,19 @@ ResourceConflict (
   FreePool (Resources);\r
 }\r
 \r
+/**\r
+  Allocate Length of MMIO or IO resource with alignment BitsOfAlignment\r
+  from GCD range [BaseAddress, Limit).\r
+\r
+  @param Mmio            TRUE for MMIO and FALSE for IO.\r
+  @param Length          Length of the resource to allocate.\r
+  @param BitsOfAlignment Alignment of the resource to allocate.\r
+  @param BaseAddress     The starting address the allocation is from.\r
+  @param Limit           The ending address the allocation is to.\r
+\r
+  @retval  The base address of the allocated resource or MAX_UINT64 if allocation\r
+           fails.\r
+**/\r
 UINT64\r
 AllocateResource (\r
   BOOLEAN Mmio,\r
@@ -306,6 +319,7 @@ AllocateResource (
   }\r
   return MAX_UINT64;\r
 }\r
+\r
 /**\r
 \r
   Enter a certain phase of the PCI enumeration process.\r