Add function doxygen header for PciBus module.

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

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.h
index 9cb9966c851b91dc8f131376ae1e74e9db8aa42b..59bff9279f6c5e8a8e3cb20732d8ec633b0ffeaf 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciRomTable.h
@@ -15,6 +15,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _EFI_PCI_ROM_TABLE_H\r
 #define _EFI_PCI_ROM_TABLE_H\r
 \r
+/**\r
+  Add the Rom Image to internal database for later PCI light enumeration\r
+  \r
+  @param ImageHandle    Option Rom image handle\r
+  @param Seg            Segment of PCI space\r
+  @param Bus            Bus NO of PCI space\r
+  @param Dev            Dev NO of PCI space\r
+  @param Func           Func NO of PCI space\r
+  @param RomAddress     Base address of OptionRom\r
+  @param RomLength      Length of rom image.\r
+**/\r
 VOID\r
 PciRomAddImageMapping (\r
   IN EFI_HANDLE  ImageHandle,\r
@@ -25,74 +36,32 @@ PciRomAddImageMapping (
   IN UINT64      RomAddress,\r
   IN UINT64      RomLength\r
   )\r
+;\r
 /**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ImageHandle - TODO: add argument description\r
-  Seg         - TODO: add argument description\r
-  Bus         - TODO: add argument description\r
-  Dev         - TODO: add argument description\r
-  Func        - TODO: add argument description\r
-  RomAddress  - TODO: add argument description\r
-  RomLength   - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
+  Load all option rom image to PCI driver list.\r
+  \r
+  @param This             Pointer to protocol instance EFI_DRIVER_BINDING_PROTOCOL\r
+  @param PciRootBridgeIo  Root bridge Io instance\r
+  @param PciIoDevice      device instance\r
 **/\r
-;\r
-\r
-\r
 EFI_STATUS\r
 PciRomGetRomResourceFromPciOptionRomTable (\r
   IN EFI_DRIVER_BINDING_PROTOCOL      *This,\r
   IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL  *PciRootBridgeIo,\r
   PCI_IO_DEVICE                       *PciIoDevice\r
   )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This            - TODO: add argument description\r
-  PciRootBridgeIo - TODO: add argument description\r
-  PciIoDevice     - TODO: add argument description\r
-\r
-Returns:\r
+;\r
 \r
-  TODO: add return values\r
+/**\r
+  Get Option rom driver's mapping for PCI device.\r
+  \r
+  @param PciIoDevice Device instance.\r
 \r
 **/\r
-;\r
-\r
 EFI_STATUS\r
 PciRomGetImageMapping (\r
   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
 #endif\r