IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciOptionRomSupport.h

   1 /** @file
   2
   3 Copyright (c) 2006, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 **/
  13
  14 #ifndef _EFI_PCI_OP_ROM_SUPPORT_H_
  15 #define _EFI_PCI_OP_ROM_SUPPORT_H_
  16
  17 /**
  18   Get Pci device's oprom infor bits.
  19
  20   @param PciIoDevice Pci device instance
  21
  22   @retval EFI_NOT_FOUND Pci device has not oprom
  23   @retval EFI_SUCCESS   Pci device has oprom
  24 **/
  25 EFI_STATUS
  26 GetOpRomInfo (
  27   IN PCI_IO_DEVICE    *PciIoDevice
  28   );
  29
  30 /**
  31   Load option rom image for specified PCI device
  32
  33   @param PciDevice Pci device instance
  34   @param RomBase   Base address of oprom.
  35
  36   @retval EFI_OUT_OF_RESOURCES not enough memory to hold image
  37   @retval EFI_SUCESS           Success
  38 **/
  39 EFI_STATUS
  40 LoadOpRomImage (
  41   IN PCI_IO_DEVICE   *PciDevice,
  42   IN UINT64          RomBase
  43   );
  44
  45 /**
  46   enable/disable oprom decode
  47
  48   @param PciDevice    pci device instance
  49   @param RomBarIndex  The BAR index of the standard PCI Configuration header to use as the
  50                       base address for resource range. The legal range for this field is 0..5.
  51   @param RomBar       Base address of rom
  52   @param Enable       Flag for enable/disable decode.
  53
  54   @retval EFI_SUCCESS Success
  55 **/
  56 EFI_STATUS
  57 RomDecode (
  58   IN PCI_IO_DEVICE   *PciDevice,
  59   IN UINT8           RomBarIndex,
  60   IN UINT32          RomBar,
  61   IN BOOLEAN         Enable
  62   );
  63
  64 /**
  65   Process the oprom image.
  66
  67   @param PciDevice Pci device instance
  68 **/
  69 EFI_STATUS
  70 ProcessOpRomImage (
  71   PCI_IO_DEVICE   *PciDevice
  72   );
  73
  74 #endif