TianoCore EDK2 master
Loading...
Searching...
No Matches
PeiServicesLib.c File Reference
#include <PiPei.h>
#include <Library/EmuMagicPageLib.h>
#include <Library/PeiServicesLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>

Go to the source code of this file.

Functions

EFI_STATUS SecFfsFindNextFile (IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE VolumeHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle)
 
EFI_STATUS SecFfsFindSectionData (IN EFI_SECTION_TYPE SectionType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)
 
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, 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 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 PeiServicesAllocatePool (IN UINTN Size, OUT VOID **Buffer)
 
EFI_STATUS EFIAPI PeiServicesResetSystem (VOID)
 
EFI_STATUS EFIAPI PeiServicesRegisterForShadow (IN 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 PeiServicesFfsFindFileByName (IN CONST EFI_GUID *FileName, IN CONST EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle)
 
EFI_STATUS EFIAPI PeiServicesFfsGetVolumeInfo (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo)
 
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)
 

Detailed Description

Implementation for PEI Services Library.

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

Definition in file PeiServicesLib.c.

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 after the permanent memory has been installed by a PEIM.

Parameters
MemoryTypeType of memory to allocate.
PagesThe number of pages to allocate.
MemoryPointer of memory allocated.
Return values
EFI_SUCCESSThe memory range was successfully allocated.
EFI_INVALID_PARAMETERType is not equal to AllocateAnyPages.
EFI_NOT_AVAILABLE_YETCalled with permanent memory not available.
EFI_OUT_OF_RESOURCESThe 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
SizeThe number of bytes to allocate from the pool.
BufferIf the call succeeds, a pointer to a pointer to the allocate buffer; otherwise, undefined.
Return values
EFI_SUCCESSThe allocation was successful
EFI_OUT_OF_RESOURCESThere 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
TypeThe type of HOB to be installed.
LengthThe length of the HOB to be added.
HobThe address of a pointer that will contain the HOB header.
Return values
EFI_SUCCESSThe HOB was successfully created.
EFI_OUT_OF_RESOURCESThere 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
FileNameA pointer to the name of the file to find within the firmware volume.
VolumeHandleThe firmware volume to search FileHandle Upon exit, points to the found file's handle or NULL if it could not be found.
FileHandleThe pointer to found file handle
Return values
EFI_SUCCESSFile was found.
EFI_NOT_FOUNDFile was not found.
EFI_INVALID_PARAMETERVolumeHandle 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
SearchTypeA filter to find files only of this type.
VolumeHandleThe pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHandleHandle of the current file from which to begin searching.
Return values
EFI_SUCCESSThe file was found.
EFI_NOT_FOUNDThe file was not found.
EFI_NOT_FOUNDThe 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
InstanceThis instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
VolumeHandleHandle of the firmware volume header of the volume to return.
Return values
EFI_SUCCESSThe volume was found.
EFI_NOT_FOUNDThe volume was not found.
EFI_INVALID_PARAMETERFwVolHeader 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
SectionTypeThe value of the section type to find.
FileHandleA pointer to the file header that contains the set of sections to be searched.
SectionDataA pointer to the discovered section, if successful.
Return values
EFI_SUCCESSThe section was found.
EFI_NOT_FOUNDThe section was not found.

Definition at line 298 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
FileHandleThe handle of the file.
FileInfoUpon exit, points to the file's information.
Return values
EFI_SUCCESSFile information returned.
EFI_INVALID_PARAMETERIf FileHandle does not represent a valid file.
EFI_INVALID_PARAMETERFileInfo is NULL.

Definition at line 442 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
VolumeHandleHandle of the volume.
VolumeInfoUpon exit, points to the volume's information.
Return values
EFI_SUCCESSFile information returned.
EFI_INVALID_PARAMETERIf FileHandle does not represent a valid file.
EFI_INVALID_PARAMETERIf FileInfo is NULL.

Definition at line 504 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
BootModeA pointer to contain the value of the boot mode.
Return values
EFI_SUCCESSThe boot mode was returned successfully.
EFI_INVALID_PARAMETERBootMode 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
HobListA pointer to the list of HOBs that the PEI Foundation will initialize.
Return values
EFI_SUCCESSThe list was successfully returned.
EFI_NOT_AVAILABLE_YETThe HOB list is not yet published.

Definition at line 203 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
FvFormatUnique 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.
FvInfoPoints 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.
FvInfoSizeThe size, in bytes, of FvInfo. For memory-mapped firmware volumes, this is typically the size of the firmware volume.
ParentFvNameIf 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.
ParentFileNameIf 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
MemoryBeginThe value of a region of installed memory.
MemoryLengthThe corresponding length of a region of installed memory.
Return values
EFI_SUCCESSThe region was successfully installed in a HOB.
EFI_INVALID_PARAMETERMemoryBegin and MemoryLength are illegal for this system.
EFI_OUT_OF_RESOURCESThere 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
PpiListA pointer to the list of interfaces that the caller shall install.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe PpiList pointer is NULL.
EFI_INVALID_PARAMETERAny 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_RESOURCESThere 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,
IN OUT VOID **  Ppi 
)

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

So this is, well a hack, so we can reuse the same libraries as the PEI Core for XIP modules....

Parameters
GuidA pointer to the GUID whose corresponding interface needs to be found.
InstanceThe N-th instance of the interface that is required.
PpiDescriptorA pointer to instance of the EFI_PEI_PPI_DESCRIPTOR.
PpiA pointer to the instance of the interface.
Return values
EFI_SUCCESSThe interface was successfully returned.
EFI_NOT_FOUNDThe PPI descriptor is not found in the database.

Definition at line 95 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
NotifyListA pointer to the list of notification interfaces that the caller shall install.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe NotifyList pointer is NULL.
EFI_INVALID_PARAMETERAny 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_RESOURCESThere 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
FileHandlePEIM's file handle. Must be the currently executing PEIM.
Return values
EFI_SUCCESSThe PEIM was successfully registered for shadowing.
EFI_ALREADY_STARTEDThe PEIM was previously registered for shadowing.
EFI_NOT_FOUNDThe 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
OldPpiThe pointer to the old PEI PPI Descriptors.
NewPpiThe pointer to the new PEI PPI Descriptors.
Return values
EFI_SUCCESSThe interface was successfully installed.
EFI_INVALID_PARAMETERThe OldPpi or NewPpi is NULL.
EFI_INVALID_PARAMETERAny 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_RESOURCESThere is no additional space in the PPI database.
EFI_NOT_FOUNDThe 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_SUCCESSThe function completed successfully.
EFI_NOT_AVAILABLE_YETThe service has not been installed yet.

Definition at line 387 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
BootModeThe value of the boot mode to set.
Return values
EFI_SUCCESSThe value was successfully updated

Definition at line 183 of file PeiServicesLib.c.

◆ SecFfsFindNextFile()

EFI_STATUS SecFfsFindNextFile ( IN EFI_FV_FILETYPE  SearchType,
IN EFI_PEI_FV_HANDLE  VolumeHandle,
IN OUT EFI_PEI_FILE_HANDLE FileHandle 
)

Definition at line 102 of file FwVol.c.