Add function doxygen header for PciBus module.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5071 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-04-16 09:24:58 +00:00
parent 0915f6dce4
commit 57076f4585
14 changed files with 1800 additions and 2755 deletions

View File

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