Add function doxygen header for PciBus module.

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

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c
index bf087821c50966ae9982fe1b4726cef28b0979d5..980282f63d4081528e7af8a52106738b9cddbda0 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.c
@@ -30,22 +30,16 @@ MEMMAP_DEVICE_PATH  mPciOptionRomImageDevicePathNodeTemplate = {
   0\r
 };\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
-Arguments:\r
-\r
-Returns:\r
-\r
-**/\r
-// TODO:    PciIoDevice - add argument and description to function comment\r
-// TODO:    EFI_NOT_FOUND - add return value to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
 {\r
   UINT8                           RomBarIndex;\r
   UINT32                          AllOnes;\r
@@ -125,27 +119,20 @@ Returns:
   return EFI_SUCCESS;\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
-    Load option rom image for specified PCI device\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-**/\r
-// TODO:    PciDevice - add argument and description to function comment\r
-// TODO:    RomBase - add argument and description to function comment\r
-// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
-// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
-// TODO:    EFI_OUT_OF_RESOURCES - add return value to function comment\r
 {\r
   UINT8                     RomBarIndex;\r
   UINT8                     Indicator;\r
@@ -307,6 +294,17 @@ Returns:
   return retStatus;\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
@@ -314,20 +312,6 @@ RomDecode (
   IN UINT32          RomBar,\r
   IN BOOLEAN         Enable\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-**/\r
-// TODO:    PciDevice - add argument and description to function comment\r
-// TODO:    RomBarIndex - add argument and description to function comment\r
-// TODO:    RomBar - add argument and description to function comment\r
-// TODO:    Enable - add argument and description to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
 {\r
   UINT32              Value32;\r
   UINT32              Offset;\r
@@ -395,24 +379,15 @@ Returns:
 \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
-  Process the oprom image.\r
-\r
-Arguments:\r
-  PciDevice       A pointer to a pci device.\r
-\r
-Returns:\r
-\r
-  EFI Status.\r
-\r
-**/\r
 {\r
   UINT8                         Indicator;\r
   UINT32                        ImageSize;\r
@@ -580,3 +555,4 @@ Returns:
   return retStatus;\r
 \r
 }\r
+\r