MdePkg: introduce MM communicate 2 protocol

[mirror_edk2.git] / MdePkg / Include / Ppi / LoadFile.h

/** @file\r
  Load image file from fv to memory.\r
\r
  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is introduced in PI Version 1.0.\r
\r
**/\r
\r
#ifndef __LOAD_FILE_PPI_H__\r
#define __LOAD_FILE_PPI_H__\r
\r
#define EFI_PEI_LOAD_FILE_PPI_GUID \\r
  { 0xb9e0abfe, 0x5979, 0x4914, { 0x97, 0x7f, 0x6d, 0xee, 0x78, 0xc2, 0x78, 0xa6 } }\r
\r
\r
typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI;\r
\r
/**\r
  Loads a PEIM into memory for subsequent execution.\r
\r
  This service is the single member function of EFI_LOAD_FILE_PPI.\r
  This service separates image loading and relocating from the PEI Foundation.\r
\r
  @param This                   Interface pointer that implements\r
                                the Load File PPI instance.\r
  @param FileHandle             File handle of the file to load.\r
  @param ImageAddress           Pointer to the address of the loaded image.\r
  @param ImageSize              Pointer to the size of the loaded image.\r
  @param EntryPoint             Pointer to the entry point of the image.\r
  @param AuthenticationState    On exit, points to the attestation\r
                                authentication state of the image\r
                                or 0 if no attestation was performed.\r
\r
  @retval EFI_SUCCESS           The image was loaded successfully.\r
  @retval EFI_OUT_OF_RESOURCES  There was not enough memory.\r
  @retval EFI_LOAD_ERROR        There was no supported image in the file.\r
  @retval EFI_INVALID_PARAMETER FileHandle was not a valid firmware file handle.\r
  @retval EFI_INVALID_PARAMETER EntryPoint was NULL.\r
  @retval EFI_UNSUPPORTED       An image requires relocations or is not\r
                                memory mapped.\r
  @retval EFI_WARN_BUFFER_TOO_SMALL\r
                                There is not enough heap to allocate the requested size.\r
                                This will not prevent the XIP image from being invoked.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_LOAD_FILE)(\r
  IN  CONST  EFI_PEI_LOAD_FILE_PPI   *This,\r
  IN  EFI_PEI_FILE_HANDLE            FileHandle,\r
  OUT EFI_PHYSICAL_ADDRESS           *ImageAddress,\r
  OUT UINT64                         *ImageSize,\r
  OUT EFI_PHYSICAL_ADDRESS           *EntryPoint,\r
  OUT UINT32                         *AuthenticationState\r
);\r
\r
///\r
/// This PPI is a pointer to the Load File service.\r
/// This service will be published by a PEIM. The PEI Foundation\r
/// will use this service to launch the known PEI module images.\r
///\r
struct _EFI_PEI_LOAD_FILE_PPI {\r
  EFI_PEI_LOAD_FILE LoadFile;\r
};\r
\r
extern EFI_GUID gEfiPeiLoadFilePpiGuid;\r
\r
#endif\r