Functions
EFI_STATUS EFIAPI	PeiServicesInstallPpi (IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList)

EFI_STATUS EFIAPI	PeiServicesReInstallPpi (IN CONST EFI_PEI_PPI_DESCRIPTOR OldPpi, IN CONST EFI_PEI_PPI_DESCRIPTOR NewPpi)

EFI_STATUS EFIAPI	PeiServicesLocatePpi (IN CONST EFI_GUID Guid, IN UINTN Instance, IN OUT EFI_PEI_PPI_DESCRIPTOR PpiDescriptor OPTIONAL, IN OUT VOID *Ppi)

EFI_STATUS EFIAPI	PeiServicesNotifyPpi (IN CONST EFI_PEI_NOTIFY_DESCRIPTOR *NotifyList)

EFI_STATUS EFIAPI	PeiServicesGetBootMode (OUT EFI_BOOT_MODE *BootMode)

EFI_STATUS EFIAPI	PeiServicesSetBootMode (IN EFI_BOOT_MODE BootMode)

EFI_STATUS EFIAPI	PeiServicesGetHobList (OUT VOID **HobList)

EFI_STATUS EFIAPI	PeiServicesCreateHob (IN UINT16 Type, IN UINT16 Length, OUT VOID **Hob)

EFI_STATUS EFIAPI	PeiServicesFfsFindNextVolume (IN UINTN Instance, IN OUT EFI_PEI_FV_HANDLE *VolumeHandle)

EFI_STATUS EFIAPI	PeiServicesFfsFindNextFile (IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE VolumeHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle)

EFI_STATUS EFIAPI	PeiServicesFfsFindSectionData (IN EFI_SECTION_TYPE SectionType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)

EFI_STATUS EFIAPI	PeiServicesFfsFindSectionData3 (IN EFI_SECTION_TYPE SectionType, IN UINTN SectionInstance, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID *SectionData, OUT UINT32 AuthenticationStatus)

EFI_STATUS EFIAPI	PeiServicesInstallPeiMemory (IN EFI_PHYSICAL_ADDRESS MemoryBegin, IN UINT64 MemoryLength)

EFI_STATUS EFIAPI	PeiServicesAllocatePages (IN EFI_MEMORY_TYPE MemoryType, IN UINTN Pages, OUT EFI_PHYSICAL_ADDRESS *Memory)

EFI_STATUS EFIAPI	PeiServicesFreePages (IN EFI_PHYSICAL_ADDRESS Memory, IN UINTN Pages)

EFI_STATUS EFIAPI	PeiServicesAllocatePool (IN UINTN Size, OUT VOID **Buffer)

EFI_STATUS EFIAPI	PeiServicesResetSystem (VOID)

EFI_STATUS EFIAPI	PeiServicesFfsFindFileByName (IN CONST EFI_GUID FileName, IN CONST EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_PEI_FILE_HANDLE FileHandle)

EFI_STATUS EFIAPI	PeiServicesFfsGetFileInfo (IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo)

EFI_STATUS EFIAPI	PeiServicesFfsGetFileInfo2 (IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO2 *FileInfo)

EFI_STATUS EFIAPI	PeiServicesFfsGetVolumeInfo (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo)

EFI_STATUS EFIAPI	PeiServicesRegisterForShadow (IN EFI_PEI_FILE_HANDLE FileHandle)

VOID EFIAPI	PeiServicesInstallFvInfoPpi (IN CONST EFI_GUID FvFormat OPTIONAL, IN CONST VOID FvInfo, IN UINT32 FvInfoSize, IN CONST EFI_GUID ParentFvName OPTIONAL, IN CONST EFI_GUID ParentFileName OPTIONAL)

VOID EFIAPI	PeiServicesInstallFvInfo2Ppi (IN CONST EFI_GUID FvFormat OPTIONAL, IN CONST VOID FvInfo, IN UINT32 FvInfoSize, IN CONST EFI_GUID ParentFvName OPTIONAL, IN CONST EFI_GUID ParentFileName OPTIONAL, IN UINT32 AuthenticationStatus)

VOID EFIAPI	PeiServicesResetSystem2 (IN EFI_RESET_TYPE ResetType, IN EFI_STATUS ResetStatus, IN UINTN DataSize, IN VOID *ResetData OPTIONAL)

Detailed Description

Provides library functions for all PEI Services.

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

Definition in file PeiServicesLib.h.

Function Documentation

◆ PeiServicesAllocatePages()

EFI_STATUS EFIAPI PeiServicesAllocatePages	(	IN EFI_MEMORY_TYPE	MemoryType,
		IN UINTN	Pages,
		OUT EFI_PHYSICAL_ADDRESS *	Memory
	)

This service enables PEIMs to allocate memory.

Parameters

MemoryType	Type of memory to allocate.
Pages	The number of pages to allocate.
Memory	Pointer of memory allocated.

Return values

EFI_SUCCESS	The memory range was successfully allocated.
EFI_INVALID_PARAMETER	Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode, EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData, EfiACPIReclaimMemory, EfiReservedMemoryType, or EfiACPIMemoryNVS.
EFI_OUT_OF_RESOURCES	The pages could not be allocated.

This service enables PEIMs to allocate memory after the permanent memory has been installed by a PEIM.

Parameters

MemoryType	Type of memory to allocate.
Pages	The number of pages to allocate.
Memory	Pointer of memory allocated.

Return values

EFI_SUCCESS	The memory range was successfully allocated.
EFI_INVALID_PARAMETER	Type is not equal to AllocateAnyPages.
EFI_NOT_AVAILABLE_YET	Called with permanent memory not available.
EFI_OUT_OF_RESOURCES	The pages could not be allocated.

Definition at line 346 of file PeiServicesLib.c.

◆ PeiServicesAllocatePool()

EFI_STATUS EFIAPI PeiServicesAllocatePool	(	IN UINTN	Size,
		OUT VOID **	Buffer
	)

This service allocates memory from the Hand-Off Block (HOB) heap.

Parameters

Size	The number of bytes to allocate from the pool.
Buffer	If the call succeeds, a pointer to a pointer to the allocate buffer; undefined otherwise.

Return values

EFI_SUCCESS	The allocation was successful
EFI_OUT_OF_RESOURCES	There is not enough heap to allocate the requested size.

This service allocates memory from the Hand-Off Block (HOB) heap.

Parameters

Size	The number of bytes to allocate from the pool.
Buffer	If the call succeeds, a pointer to a pointer to the allocate buffer; otherwise, undefined.

Return values

EFI_SUCCESS	The allocation was successful
EFI_OUT_OF_RESOURCES	There is not enough heap to allocate the requested size.

Definition at line 369 of file PeiServicesLib.c.

◆ PeiServicesCreateHob()

EFI_STATUS EFIAPI PeiServicesCreateHob	(	IN UINT16	Type,
		IN UINT16	Length,
		OUT VOID **	Hob
	)

This service enables PEIMs to create various types of HOBs.

Parameters

Type	The type of HOB to be installed.
Length	The length of the HOB to be added.
Hob	The address of a pointer that will contain the HOB header.

Return values

EFI_SUCCESS	The HOB was successfully created.
EFI_OUT_OF_RESOURCES	There is no additional space for HOB creation.

Definition at line 225 of file PeiServicesLib.c.

◆ PeiServicesFfsFindFileByName()

EFI_STATUS EFIAPI PeiServicesFfsFindFileByName	(	IN CONST EFI_GUID *	FileName,
		IN CONST EFI_PEI_FV_HANDLE	VolumeHandle,
		OUT EFI_PEI_FILE_HANDLE *	FileHandle
	)

This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileName	A pointer to the name of the file to find within the firmware volume.
VolumeHandle	The firmware volume to search FileHandle Upon exit, points to the found file's handle or NULL if it could not be found.
FileHandle	Pointer to found file handle

Return values

EFI_SUCCESS	File was found.
EFI_NOT_FOUND	File was not found.
EFI_INVALID_PARAMETER	VolumeHandle or FileHandle or FileName was NULL.

This service is a wrapper for the PEI Service FfsFindByName(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileName	A pointer to the name of the file to find within the firmware volume.
VolumeHandle	The firmware volume to search FileHandle Upon exit, points to the found file's handle or NULL if it could not be found.
FileHandle	The pointer to found file handle

Return values

EFI_SUCCESS	File was found.
EFI_NOT_FOUND	File was not found.
EFI_INVALID_PARAMETER	VolumeHandle or FileHandle or FileName was NULL.

Definition at line 474 of file PeiServicesLib.c.

◆ PeiServicesFfsFindNextFile()

EFI_STATUS EFIAPI PeiServicesFfsFindNextFile	(	IN EFI_FV_FILETYPE	SearchType,
		IN EFI_PEI_FV_HANDLE	VolumeHandle,
		IN OUT EFI_PEI_FILE_HANDLE *	FileHandle
	)

This service enables PEIMs to discover additional firmware files.

Parameters

SearchType	A filter to find files only of this type.
VolumeHandle	Pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHandle	Handle of the current file from which to begin searching.

Return values

EFI_SUCCESS	The file was found.
EFI_NOT_FOUND	The file was not found.
EFI_NOT_FOUND	The header checksum was not zero.

This service enables PEIMs to discover additional firmware files.

Parameters

SearchType	A filter to find files only of this type.
VolumeHandle	The pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHandle	Handle of the current file from which to begin searching.

Return values

EFI_SUCCESS	The file was found.
EFI_NOT_FOUND	The file was not found.
EFI_NOT_FOUND	The header checksum was not zero.

Definition at line 275 of file PeiServicesLib.c.

◆ PeiServicesFfsFindNextVolume()

EFI_STATUS EFIAPI PeiServicesFfsFindNextVolume	(	IN UINTN	Instance,
		IN OUT EFI_PEI_FV_HANDLE *	VolumeHandle
	)

This service enables PEIMs to discover additional firmware volumes.

Parameters

Instance	This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
VolumeHandle	Handle of the firmware volume header of the volume to return.

Return values

EFI_SUCCESS	The volume was found.
EFI_NOT_FOUND	The volume was not found.
EFI_INVALID_PARAMETER	FwVolHeader is NULL.

Definition at line 250 of file PeiServicesLib.c.

◆ PeiServicesFfsFindSectionData()

EFI_STATUS EFIAPI PeiServicesFfsFindSectionData	(	IN EFI_SECTION_TYPE	SectionType,
		IN EFI_PEI_FILE_HANDLE	FileHandle,
		OUT VOID **	SectionData
	)

This service enables PEIMs to discover sections of a given type within a valid FFS file.

Parameters

SectionType	The value of the section type to find.
FileHandle	A pointer to the file header that contains the set of sections to be searched.
SectionData	A pointer to the discovered section, if successful.

Return values

EFI_SUCCESS	The section was found.
EFI_NOT_FOUND	The section was not found.

Definition at line 298 of file PeiServicesLib.c.

◆ PeiServicesFfsFindSectionData3()

EFI_STATUS EFIAPI PeiServicesFfsFindSectionData3	(	IN EFI_SECTION_TYPE	SectionType,
		IN UINTN	SectionInstance,
		IN EFI_PEI_FILE_HANDLE	FileHandle,
		OUT VOID **	SectionData,
		OUT UINT32 *	AuthenticationStatus
	)

This service enables PEIMs to discover sections of a given instance and type within a valid FFS file.

Parameters

SectionType	The value of the section type to find.
SectionInstance	Section instance to find.
FileHandle	A pointer to the file header that contains the set of sections to be searched.
SectionData	A pointer to the discovered section, if successful.
AuthenticationStatus	A pointer to the authentication status for this section.

Return values

EFI_SUCCESS	The section was found.
EFI_NOT_FOUND	The section was not found.

Definition at line 313 of file PeiServicesLib.c.

◆ PeiServicesFfsGetFileInfo()

EFI_STATUS EFIAPI PeiServicesFfsGetFileInfo	(	IN CONST EFI_PEI_FILE_HANDLE	FileHandle,
		OUT EFI_FV_FILE_INFO *	FileInfo
	)

This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileHandle	Handle of the file.
FileInfo	Upon exit, points to the file's information.

Return values

EFI_SUCCESS	File information returned.
EFI_INVALID_PARAMETER	If FileHandle does not represent a valid file.
EFI_INVALID_PARAMETER	If FileInfo is NULL.

This service is a wrapper for the PEI Service FfsGetFileInfo(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileHandle	The handle of the file.
FileInfo	Upon exit, points to the file's information.

Return values

EFI_SUCCESS	File information returned.
EFI_INVALID_PARAMETER	If FileHandle does not represent a valid file.
EFI_INVALID_PARAMETER	FileInfo is NULL.

Definition at line 442 of file PeiServicesLib.c.

◆ PeiServicesFfsGetFileInfo2()

EFI_STATUS EFIAPI PeiServicesFfsGetFileInfo2	(	IN CONST EFI_PEI_FILE_HANDLE	FileHandle,
		OUT EFI_FV_FILE_INFO2 *	FileInfo
	)

This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileHandle	Handle of the file.
FileInfo	Upon exit, points to the file's information.

Return values

EFI_SUCCESS	File information returned.
EFI_INVALID_PARAMETER	If FileHandle does not represent a valid file.
EFI_INVALID_PARAMETER	If FileInfo is NULL.

This service is a wrapper for the PEI Service FfsGetFileInfo2(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileHandle	The handle of the file.
FileInfo	Upon exit, points to the file's information.

Return values

EFI_SUCCESS	File information returned.
EFI_INVALID_PARAMETER	If FileHandle does not represent a valid file.
EFI_INVALID_PARAMETER	FileInfo is NULL.

Definition at line 519 of file PeiServicesLib.c.

◆ PeiServicesFfsGetVolumeInfo()

EFI_STATUS EFIAPI PeiServicesFfsGetVolumeInfo	(	IN EFI_PEI_FV_HANDLE	VolumeHandle,
		OUT EFI_FV_INFO *	VolumeInfo
	)

This service is a wrapper for the PEI Service FfsGetVolumeInfo(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

VolumeHandle	Handle of the volume.
VolumeInfo	Upon exit, points to the volume's information.

Return values

EFI_SUCCESS	File information returned.
EFI_INVALID_PARAMETER	If FileHandle does not represent a valid file.
EFI_INVALID_PARAMETER	If FileInfo is NULL.

Definition at line 504 of file PeiServicesLib.c.

◆ PeiServicesFreePages()

EFI_STATUS EFIAPI PeiServicesFreePages	(	IN EFI_PHYSICAL_ADDRESS	Memory,
		IN UINTN	Pages
	)

This service enables PEIMs to free memory.

Parameters

Memory	Memory to be freed.
Pages	The number of pages to free.

Return values

EFI_SUCCESS	The requested pages were freed.
EFI_INVALID_PARAMETER	Memory is not a page-aligned address or Pages is invalid.
EFI_NOT_FOUND	The requested memory pages were not allocated with AllocatePages().

Definition at line 394 of file PeiServicesLib.c.

◆ PeiServicesGetBootMode()

EFI_STATUS EFIAPI PeiServicesGetBootMode ( OUT EFI_BOOT_MODE * BootMode )

This service enables PEIMs to ascertain the present value of the boot mode.

Parameters

BootMode A pointer to contain the value of the boot mode.

Return values

EFI_SUCCESS	The boot mode was returned successfully.
EFI_INVALID_PARAMETER	BootMode is NULL.

Definition at line 165 of file PeiServicesLib.c.

◆ PeiServicesGetHobList()

EFI_STATUS EFIAPI PeiServicesGetHobList ( OUT VOID ** HobList )

This service enables a PEIM to ascertain the address of the list of HOBs in memory.

Parameters

HobList A pointer to the list of HOBs that the PEI Foundation will initialize.

Return values

EFI_SUCCESS	The list was successfully returned.
EFI_NOT_AVAILABLE_YET	The HOB list is not yet published.

Definition at line 203 of file PeiServicesLib.c.

◆ PeiServicesInstallFvInfo2Ppi()

VOID EFIAPI PeiServicesInstallFvInfo2Ppi	(	IN CONST EFI_GUID *FvFormat	OPTIONAL,
		IN CONST VOID *	FvInfo,
		IN UINT32	FvInfoSize,
		IN CONST EFI_GUID *ParentFvName	OPTIONAL,
		IN CONST EFI_GUID *ParentFileName	OPTIONAL,
		IN UINT32	AuthenticationStatus
	)

Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.

This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT().

Parameters

FvFormat	Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
FvInfo	Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume.
FvInfoSize	The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume.
ParentFvName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL.
ParentFileName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL.
AuthenticationStatus	Authentication Status

Install a EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance so the PEI Core will be notified about a new firmware volume.

This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO2_PPI can not be installed, then ASSERT(). If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT.

Parameters

FvFormat	Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
FvInfo	Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume.
FvInfoSize	The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume.
ParentFvName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL.
ParentFileName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL.
AuthenticationStatus	Authentication Status

Definition at line 777 of file PeiServicesLib.c.

◆ PeiServicesInstallFvInfoPpi()

VOID EFIAPI PeiServicesInstallFvInfoPpi	(	IN CONST EFI_GUID *FvFormat	OPTIONAL,
		IN CONST VOID *	FvInfo,
		IN UINT32	FvInfoSize,
		IN CONST EFI_GUID *ParentFvName	OPTIONAL,
		IN CONST EFI_GUID *ParentFileName	OPTIONAL
	)

Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.

This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().

Parameters

FvFormat	Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
FvInfo	Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume.
FvInfoSize	The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume.
ParentFvName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL.
ParentFileName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL.

Install a EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance so the PEI Core will be notified about a new firmware volume.

This function allocates, initializes, and installs a new EFI_PEI_FIRMWARE_VOLUME_INFO_PPI using the parameters passed in to initialize the fields of the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI instance. If the resources can not be allocated for EFI_PEI_FIRMWARE_VOLUME_INFO_PPI, then ASSERT(). If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT(). If NULL is specified for FvFormat, but FvInfo does not have the firmware file system 2 format, then ASSERT.

Parameters

FvFormat	Unique identifier of the format of the memory-mapped firmware volume. This parameter is optional and may be NULL. If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
FvInfo	Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume. The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes, this typically points to the first byte of the firmware volume.
FvInfoSize	The size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume.
ParentFvName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID name of the originating firmware volume. Otherwise, this parameter must be NULL.
ParentFileName	If the new firmware volume originated from a file in a different firmware volume, then this parameter specifies the GUID file name of the originating firmware file. Otherwise, this parameter must be NULL.

Definition at line 545 of file PeiServicesLib.c.

◆ PeiServicesInstallPeiMemory()

EFI_STATUS EFIAPI PeiServicesInstallPeiMemory	(	IN EFI_PHYSICAL_ADDRESS	MemoryBegin,
		IN UINT64	MemoryLength
	)

This service enables PEIMs to register the permanent memory configuration that has been initialized with the PEI Foundation.

Parameters

MemoryBegin	The value of a region of installed memory.
MemoryLength	The corresponding length of a region of installed memory.

Return values

EFI_SUCCESS	The region was successfully installed in a HOB.
EFI_INVALID_PARAMETER	MemoryBegin and MemoryLength are illegal for this system.
EFI_OUT_OF_RESOURCES	There is no additional space for HOB creation.

Definition at line 321 of file PeiServicesLib.c.

◆ PeiServicesInstallPpi()

EFI_STATUS EFIAPI PeiServicesInstallPpi ( IN CONST EFI_PEI_PPI_DESCRIPTOR * PpiList )

This service enables a given PEIM to register an interface into the PEI Foundation.

Parameters

PpiList A pointer to the list of interfaces that the caller shall install.

Return values

EFI_SUCCESS	The interface was successfully installed.
EFI_INVALID_PARAMETER	The PpiList pointer is NULL.
EFI_INVALID_PARAMETER	Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
EFI_OUT_OF_RESOURCES	There is no additional space in the PPI database.

Definition at line 43 of file PeiServicesLib.c.

◆ PeiServicesLocatePpi()

EFI_STATUS EFIAPI PeiServicesLocatePpi	(	IN CONST EFI_GUID *	Guid,
		IN UINTN	Instance,
		IN OUT EFI_PEI_PPI_DESCRIPTOR **PpiDescriptor	OPTIONAL,
		IN OUT VOID **	Ppi
	)

This service enables PEIMs to discover a given instance of an interface.

Parameters

Guid	A pointer to the GUID whose corresponding interface needs to be found.
Instance	The N-th instance of the interface that is required.
PpiDescriptor	A pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
Ppi	A pointer to the instance of the interface.

Return values

EFI_SUCCESS	The interface was successfully returned.
EFI_NOT_FOUND	The PPI descriptor is not found in the database.

Definition at line 88 of file PeiServicesLib.c.

◆ PeiServicesNotifyPpi()

EFI_STATUS EFIAPI PeiServicesNotifyPpi ( IN CONST EFI_PEI_NOTIFY_DESCRIPTOR * NotifyList )

This service enables PEIMs to register a given service to be invoked when another service is installed or reinstalled.

Parameters

NotifyList A pointer to the list of notification interfaces that the caller shall install.

Return values

EFI_SUCCESS	The interface was successfully installed.
EFI_INVALID_PARAMETER	The NotifyList pointer is NULL.
EFI_INVALID_PARAMETER	Any of the PEI notify descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.
EFI_OUT_OF_RESOURCES	There is no additional space in the PPI database.

Definition at line 146 of file PeiServicesLib.c.

◆ PeiServicesRegisterForShadow()

EFI_STATUS EFIAPI PeiServicesRegisterForShadow ( IN EFI_PEI_FILE_HANDLE FileHandle )

This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface Specification for details.

Parameters

FileHandle PEIM's file handle. Must be the currently executing PEIM.

Return values

EFI_SUCCESS	The PEIM was successfully registered for shadowing.
EFI_ALREADY_STARTED	The PEIM was previously registered for shadowing.
EFI_NOT_FOUND	The FileHandle does not refer to a valid file handle.

Definition at line 414 of file PeiServicesLib.c.

◆ PeiServicesReInstallPpi()

EFI_STATUS EFIAPI PeiServicesReInstallPpi	(	IN CONST EFI_PEI_PPI_DESCRIPTOR *	OldPpi,
		IN CONST EFI_PEI_PPI_DESCRIPTOR *	NewPpi
	)

This service enables PEIMs to replace an entry in the PPI database with an alternate entry.

Parameters

OldPpi	Pointer to the old PEI PPI Descriptors.
NewPpi	Pointer to the new PEI PPI Descriptors.

Return values

EFI_SUCCESS	The interface was successfully installed.
EFI_INVALID_PARAMETER	The OldPpi or NewPpi is NULL.
EFI_INVALID_PARAMETER	Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
EFI_OUT_OF_RESOURCES	There is no additional space in the PPI database.
EFI_NOT_FOUND	The PPI for which the reinstallation was requested has not been installed.

This service enables PEIMs to replace an entry in the PPI database with an alternate entry.

Parameters

OldPpi	The pointer to the old PEI PPI Descriptors.
NewPpi	The pointer to the new PEI PPI Descriptors.

Return values

EFI_SUCCESS	The interface was successfully installed.
EFI_INVALID_PARAMETER	The OldPpi or NewPpi is NULL.
EFI_INVALID_PARAMETER	Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
EFI_OUT_OF_RESOURCES	There is no additional space in the PPI database.
EFI_NOT_FOUND	The PPI for which the reinstallation was requested has not been installed.

Definition at line 68 of file PeiServicesLib.c.

◆ PeiServicesResetSystem()

EFI_STATUS EFIAPI PeiServicesResetSystem ( VOID )

Resets the entire platform.

Return values

EFI_SUCCESS	The function completed successfully.
EFI_NOT_AVAILABLE_YET	The service has not been installed yet.

Definition at line 387 of file PeiServicesLib.c.

◆ PeiServicesResetSystem2()

VOID EFIAPI PeiServicesResetSystem2	(	IN EFI_RESET_TYPE	ResetType,
		IN EFI_STATUS	ResetStatus,
		IN UINTN	DataSize,
		IN VOID *ResetData	OPTIONAL
	)

Resets the entire platform.

Parameters

[in]	ResetType	The type of reset to perform.
[in]	ResetStatus	The status code for the reset.
[in]	DataSize	The size, in bytes, of ResetData.
[in]	ResetData	For a ResetType of EfiResetCold, EfiResetWarm, or EfiResetShutdown the data buffer starts with a Null-terminated string, optionally followed by additional binary data. The string is a description that the caller may use to further indicate the reason for the system reset.

Definition at line 804 of file PeiServicesLib.c.

◆ PeiServicesSetBootMode()

EFI_STATUS EFIAPI PeiServicesSetBootMode ( IN EFI_BOOT_MODE BootMode )

This service enables PEIMs to update the boot mode variable.

Parameters

BootMode The value of the boot mode to set.

Return values

EFI_SUCCESS The value was successfully updated

Definition at line 183 of file PeiServicesLib.c.

Functions

Detailed Description

Function Documentation

◆ PeiServicesAllocatePages()

◆ PeiServicesAllocatePool()

◆ PeiServicesCreateHob()

◆ PeiServicesFfsFindFileByName()

◆ PeiServicesFfsFindNextFile()

◆ PeiServicesFfsFindNextVolume()

◆ PeiServicesFfsFindSectionData()

◆ PeiServicesFfsFindSectionData3()

◆ PeiServicesFfsGetFileInfo()

◆ PeiServicesFfsGetFileInfo2()

◆ PeiServicesFfsGetVolumeInfo()

◆ PeiServicesFreePages()

◆ PeiServicesGetBootMode()

◆ PeiServicesGetHobList()

◆ PeiServicesInstallFvInfo2Ppi()

◆ PeiServicesInstallFvInfoPpi()

◆ PeiServicesInstallPeiMemory()

◆ PeiServicesInstallPpi()

◆ PeiServicesLocatePpi()

◆ PeiServicesNotifyPpi()

◆ PeiServicesRegisterForShadow()

◆ PeiServicesReInstallPpi()

◆ PeiServicesResetSystem()

◆ PeiServicesResetSystem2()

◆ PeiServicesSetBootMode()