MdePkg/Include/Ppi/LoadFile.h File Reference


Data Structures

struct  _EFI_PEI_LOAD_FILE_PPI

Defines

#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 - 2013, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This PPI is introduced in PI Version 1.0.

Define Documentation

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


Typedef Documentation

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.


Variable Documentation


Generated on Wed Sep 23 16:24:22 2015 for MdePkg[ALL] by  doxygen 1.5.7.1