LoadFile.h File Reference

Go to the source code of this file.

Data Structures
struct	_EFI_PEI_LOAD_FILE_PPI

Macros
#define	EFI_PEI_LOAD_FILE_PPI_GUID    { 0xb9e0abfe, 0x5979, 0x4914, { 0x97, 0x7f, 0x6d, 0xee, 0x78, 0xc2, 0x78, 0xa6 } }

Typedefs
typedef struct _EFI_PEI_LOAD_FILE_PPI	EFI_PEI_LOAD_FILE_PPI
typedef EFI_STATUS(EFIAPI *	EFI_PEI_LOAD_FILE) (IN CONST EFI_PEI_LOAD_FILE_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_PHYSICAL_ADDRESS *ImageAddress, OUT UINT64 *ImageSize, OUT EFI_PHYSICAL_ADDRESS *EntryPoint, OUT UINT32 *AuthenticationState)

Variables
EFI_GUID	gEfiPeiLoadFilePpiGuid

Detailed Description

Load image file from fv to memory.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This PPI is introduced in PI Version 1.0.

Definition in file LoadFile.h.

Macro Definition Documentation

EFI_PEI_LOAD_FILE_PPI_GUID

#define EFI_PEI_LOAD_FILE_PPI_GUID    { 0xb9e0abfe, 0x5979, 0x4914, { 0x97, 0x7f, 0x6d, 0xee, 0x78, 0xc2, 0x78, 0xa6 } }

Definition at line 15 of file LoadFile.h.

Typedef Documentation

EFI_PEI_LOAD_FILE

typedef EFI_STATUS(EFIAPI * EFI_PEI_LOAD_FILE) (IN CONST EFI_PEI_LOAD_FILE_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_PHYSICAL_ADDRESS *ImageAddress, OUT UINT64 *ImageSize, OUT EFI_PHYSICAL_ADDRESS *EntryPoint, OUT UINT32 *AuthenticationState)

Loads a PEIM into memory for subsequent execution.

This service is the single member function of EFI_LOAD_FILE_PPI. This service separates image loading and relocating from the PEI Foundation.

Parameters

This	Interface pointer that implements the Load File PPI instance.
FileHandle	File handle of the file to load.
ImageAddress	Pointer to the address of the loaded image.
ImageSize	Pointer to the size of the loaded image.
EntryPoint	Pointer to the entry point of the image.
AuthenticationState	On exit, points to the attestation authentication state of the image or 0 if no attestation was performed.

Return values

EFI_SUCCESS	The image was loaded successfully.
EFI_OUT_OF_RESOURCES	There was not enough memory.
EFI_LOAD_ERROR	There was no supported image in the file.
EFI_INVALID_PARAMETER	FileHandle was not a valid firmware file handle.
EFI_INVALID_PARAMETER	EntryPoint was NULL.
EFI_UNSUPPORTED	An image requires relocations or is not memory mapped.
EFI_WARN_BUFFER_TOO_SMALL	There is not enough heap to allocate the requested size. This will not prevent the XIP image from being invoked.

Definition at line 49 of file LoadFile.h.

EFI_PEI_LOAD_FILE_PPI

typedef struct _EFI_PEI_LOAD_FILE_PPI EFI_PEI_LOAD_FILE_PPI

Definition at line 18 of file LoadFile.h.