Add function doxygen header for PciBus module.

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

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h
index e06edd4c17bded7c31b238e67116a7bee46aad32..c2ed590b670db56320fbbe87701d1cd2b87a8fa9 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h
@@ -14,50 +14,45 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _EFI_PCI_OP_ROM_SUPPORT_H\r
 #define _EFI_PCI_OP_ROM_SUPPORT_H\r
 \r
+/**\r
+  Get Pci device's oprom infor bits.\r
+  \r
+  @retval EFI_NOT_FOUND Pci device has not oprom\r
+  @retval EFI_SUCCESS   Pci device has oprom\r
+**/\r
 EFI_STATUS\r
 GetOpRomInfo (\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
+  Load option rom image for specified PCI device\r
+  \r
+  @param PciDevice Pci device instance\r
+  @param RomBase   Base address of oprom.\r
+  \r
+  @retval EFI_OUT_OF_RESOURCES not enough memory to hold image\r
+  @retval EFI_SUCESS           Success\r
+**/\r
 EFI_STATUS\r
 LoadOpRomImage (\r
   IN PCI_IO_DEVICE   *PciDevice,\r
   IN UINT64          RomBase\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciDevice - TODO: add argument description\r
-  RomBase   - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  enable/disable oprom decode\r
+  \r
+  @param PciDevice    pci device instance\r
+  @param RomBarIndex  The BAR index of the standard PCI Configuration header to use as the\r
+                      base address for resource range. The legal range for this field is 0..5.\r
+  @param RomBar       Base address of rom\r
+  @param Enable       Flag for enable/disable decode.\r
+  \r
+  @retval EFI_SUCCESS Success\r
+**/\r
 EFI_STATUS\r
 RomDecode (\r
   IN PCI_IO_DEVICE   *PciDevice,\r
@@ -65,45 +60,17 @@ RomDecode (
   IN UINT32          RomBar,\r
   IN BOOLEAN         Enable\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciDevice   - TODO: add argument description\r
-  RomBarIndex - TODO: add argument description\r
-  RomBar      - TODO: add argument description\r
-  Enable      - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
+/**\r
+  Process the oprom image.\r
+  \r
+  @param PciDevice Pci device instance\r
+**/\r
 EFI_STATUS\r
 ProcessOpRomImage (\r
   PCI_IO_DEVICE   *PciDevice\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
 ;\r
 \r
 #endif\r