MdeModulePkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  PCI Rom supporting functions declaration for PCI Bus module.\r
\r
Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _EFI_PCI_OPTION_ROM_SUPPORT_H_\r
#define _EFI_PCI_OPTION_ROM_SUPPORT_H_\r
\r
\r
/**\r
  Initialize a PCI LoadFile2 instance.\r
\r
  @param PciIoDevice   PCI IO Device.\r
\r
**/\r
VOID\r
InitializePciLoadFile2 (\r
  IN PCI_IO_DEVICE       *PciIoDevice\r
  );\r
\r
/**\r
  Causes the driver to load a specified file.\r
\r
  @param This        Indicates a pointer to the calling context.\r
  @param FilePath    The device specific path of the file to load.\r
  @param BootPolicy  Should always be FALSE.\r
  @param BufferSize  On input the size of Buffer in bytes. On output with a return\r
                     code of EFI_SUCCESS, the amount of data transferred to Buffer.\r
                     On output with a return code of EFI_BUFFER_TOO_SMALL,\r
                     the size of Buffer required to retrieve the requested file.\r
  @param Buffer      The memory buffer to transfer the file to. If Buffer is NULL,\r
                     then no the size of the requested file is returned in BufferSize.\r
\r
  @retval EFI_SUCCESS           The file was loaded.\r
  @retval EFI_UNSUPPORTED       BootPolicy is TRUE.\r
  @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or\r
                                BufferSize is NULL.\r
  @retval EFI_NOT_FOUND         Not found PCI Option Rom on PCI device.\r
  @retval EFI_DEVICE_ERROR      Failed to decompress PCI Option Rom image.\r
  @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small to read the current directory entry.\r
                                BufferSize has been updated with the size needed to complete the request.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
LoadFile2 (\r
  IN EFI_LOAD_FILE2_PROTOCOL  *This,\r
  IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r
  IN BOOLEAN                  BootPolicy,\r
  IN OUT UINTN                *BufferSize,\r
  IN VOID                     *Buffer      OPTIONAL\r
  );\r
\r
/**\r
  Check if the RomImage contains EFI Images.\r
\r
  @param  RomImage  The ROM address of Image for check.\r
  @param  RomSize   Size of ROM for check.\r
\r
  @retval TRUE     ROM contain EFI Image.\r
  @retval FALSE    ROM not contain EFI Image.\r
\r
**/\r
BOOLEAN\r
ContainEfiImage (\r
  IN VOID            *RomImage,\r
  IN UINT64          RomSize\r
  );\r
\r
/**\r
  Get Pci device's oprom information.\r
\r
  @param PciIoDevice    Input Pci device instance.\r
                        Output Pci device instance with updated OptionRom size.\r
\r
  @retval EFI_NOT_FOUND Pci device has not Option Rom.\r
  @retval EFI_SUCCESS   Pci device has Option Rom.\r
\r
**/\r
EFI_STATUS\r
GetOpRomInfo (\r
  IN OUT 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 Option Rom.\r
\r
  @retval EFI_OUT_OF_RESOURCES No enough memory to hold image.\r
  @retval EFI_SUCESS           Successfully loaded Option Rom.\r
\r
**/\r
EFI_STATUS\r
LoadOpRomImage (\r
  IN PCI_IO_DEVICE   *PciDevice,\r
  IN UINT64          RomBase\r
  );\r
\r
/**\r
  Enable/Disable Option Rom 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 Option Rom.\r
  @param Enable       Flag for enable/disable decode.\r
\r
**/\r
VOID\r
RomDecode (\r
  IN PCI_IO_DEVICE   *PciDevice,\r
  IN UINT8           RomBarIndex,\r
  IN UINT32          RomBar,\r
  IN BOOLEAN         Enable\r
  );\r
\r
/**\r
  Load and start the Option Rom image.\r
\r
  @param PciDevice       Pci device instance.\r
\r
  @retval EFI_SUCCESS    Successfully loaded and started PCI Option Rom image.\r
  @retval EFI_NOT_FOUND  Failed to process PCI Option Rom image.\r
\r
**/\r
EFI_STATUS\r
ProcessOpRomImage (\r
  IN PCI_IO_DEVICE   *PciDevice\r
  );\r
\r
#endif\r