PayloadLoaderPeim.c File Reference

#include <PiPei.h>
#include <UniversalPayload/UniversalPayload.h>
#include <UniversalPayload/ExtraData.h>
#include <Ppi/LoadFile.h>
#include <Library/DebugLib.h>
#include <Library/HobLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/BaseMemoryLib.h>
#include <Guid/UniversalPayloadBase.h>
#include "ElfLib.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	EndOfPeiPpiNotifyCallback (IN EFI_PEI_SERVICES **PeiServices, IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor, IN VOID *Ppi)
EFI_STATUS EFIAPI	PeiLoadFileLoadPayload (IN CONST EFI_PEI_LOAD_FILE_PPI *This, IN EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_PHYSICAL_ADDRESS *ImageAddressArg OPTIONAL, OUT UINT64 *ImageSizeArg OPTIONAL, OUT EFI_PHYSICAL_ADDRESS *EntryPoint, OUT UINT32 *AuthenticationState)
EFI_STATUS EFIAPI	InitializePayloadLoaderPeim (IN EFI_PEI_FILE_HANDLE FileHandle, IN CONST EFI_PEI_SERVICES **PeiServices)

Variables
CONST EFI_PEI_PPI_DESCRIPTOR	gReadyToPayloadSignalPpi
EFI_PEI_NOTIFY_DESCRIPTOR	mEndOfPeiNotifyList []
EFI_PEI_LOAD_FILE_PPI	mPeiLoadFilePpi
EFI_PEI_PPI_DESCRIPTOR	gPpiLoadFilePpiList

Detailed Description

ELF Load Image Support

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

Definition in file PayloadLoaderPeim.c.

Function Documentation

EndOfPeiPpiNotifyCallback()

EFI_STATUS EFIAPI EndOfPeiPpiNotifyCallback	(	IN EFI_PEI_SERVICES **	PeiServices,
		IN EFI_PEI_NOTIFY_DESCRIPTOR *	NotifyDescriptor,
		IN VOID *	Ppi
	)

Notify ReadyToPayLoad signal.

Parameters

[in]	PeiServices	An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
[in]	NotifyDescriptor	Address of the notification descriptor data structure.
[in]	Ppi	Address of the PPI that was installed.

Return values

EFI_SUCCESS

Hobs data is discovered.

Returns

Others No Hobs data is discovered.

Definition at line 39 of file PayloadLoaderPeim.c.

InitializePayloadLoaderPeim()

EFI_STATUS EFIAPI InitializePayloadLoaderPeim	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN CONST EFI_PEI_SERVICES **	PeiServices
	)

Install Pei Load File PPI.

Parameters

FileHandle	Handle of the file being invoked.
PeiServices	Describes the list of possible PEI Services.

Return values

EFI_SUCCESS	The entry point executes successfully.
Others	Some error occurs during the execution of this function.

Definition at line 237 of file PayloadLoaderPeim.c.

PeiLoadFileLoadPayload()

EFI_STATUS EFIAPI PeiLoadFileLoadPayload	(	IN CONST EFI_PEI_LOAD_FILE_PPI *	This,
		IN EFI_PEI_FILE_HANDLE	FileHandle,
		OUT EFI_PHYSICAL_ADDRESS *ImageAddressArg	OPTIONAL,
		OUT UINT64 *ImageSizeArg	OPTIONAL,
		OUT EFI_PHYSICAL_ADDRESS *	EntryPoint,
		OUT UINT32 *	AuthenticationState
	)

The wrapper function of PeiLoadImageLoadImage().

Parameters

This	- Pointer to EFI_PEI_LOAD_FILE_PPI.
FileHandle	- Pointer to the FFS file header of the image.
ImageAddressArg	- Pointer to PE/TE image.
ImageSizeArg	- Size of PE/TE image.
EntryPoint	- Pointer to entry point of specified image file for output.
AuthenticationState	- Pointer to attestation authentication state of image.

Returns

Status of PeiLoadImageLoadImage().

Definition at line 78 of file PayloadLoaderPeim.c.

Variable Documentation

gPpiLoadFilePpiList

EFI_PEI_PPI_DESCRIPTOR gPpiLoadFilePpiList

Initial value:

= {
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  &gEfiPeiLoadFilePpiGuid,
  &mPeiLoadFilePpi
}

Definition at line 218 of file PayloadLoaderPeim.c.

gReadyToPayloadSignalPpi

CONST EFI_PEI_PPI_DESCRIPTOR gReadyToPayloadSignalPpi

Initial value:

= {
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
  &gUplReadyToPayloadPpiGuid,
  NULL
}

Definition at line 23 of file PayloadLoaderPeim.c.

mEndOfPeiNotifyList

EFI_PEI_NOTIFY_DESCRIPTOR mEndOfPeiNotifyList[]

Initial value:

= {
  {
    (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),
    &gEfiEndOfPeiSignalPpiGuid,
    EndOfPeiPpiNotifyCallback
  }
}

Definition at line 55 of file PayloadLoaderPeim.c.

mPeiLoadFilePpi

EFI_PEI_LOAD_FILE_PPI mPeiLoadFilePpi

Initial value:

= {
  PeiLoadFileLoadPayload
}

Definition at line 214 of file PayloadLoaderPeim.c.