IntelFrameworkPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / FvLoadFile.h

/** @file\r
  Load image file from fv to memory.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is defined in PEI CIS spec Version 0.91.\r
\r
**/\r
\r
#ifndef _FV_FILE_LOADER_PPI_H_\r
#define _FV_FILE_LOADER_PPI_H_\r
\r
#define EFI_PEI_FV_FILE_LOADER_GUID \\r
  { \\r
    0x7e1f0d85, 0x4ff, 0x4bb2, {0x86, 0x6a, 0x31, 0xa2, 0x99, 0x6a, 0x48, 0xa8 } \\r
  }\r
\r
typedef struct _EFI_PEI_FV_FILE_LOADER_PPI  EFI_PEI_FV_FILE_LOADER_PPI;\r
\r
/**\r
  Loads a PEIM into memory for subsequent execution.\r
\r
  @param  This           Interface pointer that implements the Load File PPI instance.\r
  @param  FfsHeader      The pointer to the FFS header of the file to load.\r
  @param  ImageAddress   The pointer to the address of the loaded Image\r
  @param  ImageSize      The pointer to the size of the loaded image.\r
  @param  EntryPoint     The pointer to the entry point of the image.\r
\r
  @retval EFI_SUCCESS           The image was loaded successfully.\r
  @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
  @retval EFI_INVALID_PARAMETER The contents of the FFS file did not\r
                                contain a valid PE/COFF image that could be loaded.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_FV_LOAD_FILE)(\r
  IN  EFI_PEI_FV_FILE_LOADER_PPI                *This,\r
  IN  EFI_FFS_FILE_HEADER                       *FfsHeader,\r
  OUT EFI_PHYSICAL_ADDRESS                      *ImageAddress,\r
  OUT UINT64                                    *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS                      *EntryPoint\r
  );\r
\r
/**\r
  This PPI is a pointer to the Load File service. This service will be\r
  published by a PEIM. The PEI Foundation will use this service to\r
  launch the known non-XIP PE/COFF PEIM images. This service may\r
  depend upon the presence of the EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI.\r
**/\r
struct _EFI_PEI_FV_FILE_LOADER_PPI {\r
  ///\r
  /// Loads a PEIM into memory for subsequent execution.\r
  ///\r
  EFI_PEI_FV_LOAD_FILE  FvLoadFile;\r
};\r
\r
extern EFI_GUID gEfiPeiFvFileLoaderPpiGuid;\r
\r
#endif\r