Correct all header files for doxygen format and correct the license issue for VgaClas...

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

/**@file\r
  Option Rom Support for PCI Bus Driver\r
\r
Copyright (c) 2006, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#ifndef _EFI_PCI_ROM_TABLE_H\r
#define _EFI_PCI_ROM_TABLE_H\r
\r
VOID\r
PciRomAddImageMapping (\r
  IN EFI_HANDLE  ImageHandle,\r
  IN UINTN       Seg,\r
  IN UINT8       Bus,\r
  IN UINT8       Dev,\r
  IN UINT8       Func,\r
  IN UINT64      RomAddress,\r
  IN UINT64      RomLength\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
--*/\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
  TODO: add return values\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