Update For R9 Review.

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

/** @file\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_OP_ROM_SUPPORT_H_\r
#define _EFI_PCI_OP_ROM_SUPPORT_H_\r
\r
/**\r
  Get Pci device's oprom infor bits.\r
  \r
  @param PciIoDevice Pci device instance\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
  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
  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
  IN UINT8           RomBarIndex,\r
  IN UINT32          RomBar,\r
  IN BOOLEAN         Enable\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
#endif\r