EmbeddedPkg[all]  0.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
PrePiLib.h File Reference

Functions

EFI_STATUS EFIAPI FfsFindNextVolume (IN UINTN Instance, IN OUT EFI_PEI_FV_HANDLE *VolumeHandle)
 
EFI_STATUS EFIAPI FfsFindNextFile (IN EFI_FV_FILETYPE SearchType, IN EFI_PEI_FV_HANDLE VolumeHandle, IN OUT EFI_PEI_FILE_HANDLE *FileHandle)
 
EFI_STATUS EFIAPI FfsFindSectionData (IN EFI_SECTION_TYPE SectionType, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)
 
EFI_STATUS EFIAPI FfsFindFileByName (IN CONST EFI_GUID *FileName, IN CONST EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle)
 
EFI_STATUS EFIAPI FfsGetFileInfo (IN CONST EFI_PEI_FILE_HANDLE FileHandle, OUT EFI_FV_FILE_INFO *FileInfo)
 
EFI_STATUS EFIAPI FfsGetVolumeInfo (IN EFI_PEI_FV_HANDLE VolumeHandle, OUT EFI_FV_INFO *VolumeInfo)
 
EFI_STATUS EFIAPI FfsProcessFvFile (IN EFI_PEI_FILE_HANDLE FvFileHandle)
 
EFI_STATUS EFIAPI FfsAnyFvFindFirstFile (IN EFI_FV_FILETYPE FileType, OUT EFI_PEI_FV_HANDLE *VolumeHandle, OUT EFI_PEI_FILE_HANDLE *FileHandle)
 
EFI_BOOT_MODE EFIAPI GetBootMode (VOID)
 
EFI_STATUS EFIAPI SetBootMode (IN EFI_BOOT_MODE BootMode)
 
VOID *EFIAPI GetHobList (VOID)
 
EFI_STATUS EFIAPI SetHobList (IN VOID *HobList)
 
EFI_HOB_HANDOFF_INFO_TABLE * HobConstructor (IN VOID *EfiMemoryBegin, IN UINTN EfiMemoryLength, IN VOID *EfiFreeMemoryBottom, IN VOID *EfiFreeMemoryTop)
 
VOIDCreateHob (IN UINT16 HobType, IN UINT16 HobLenght)
 
VOID *EFIAPI GetNextHob (IN UINT16 Type, IN CONST VOID *HobStart)
 
VOID *EFIAPI GetFirstHob (IN UINT16 Type)
 
VOID *EFIAPI GetNextGuidHob (IN CONST EFI_GUID *Guid, IN CONST VOID *HobStart)
 
VOID *EFIAPI GetFirstGuidHob (IN CONST EFI_GUID *Guid)
 
VOID EFIAPI BuildModuleHob (IN CONST EFI_GUID *ModuleName, IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule, IN UINT64 ModuleLength, IN EFI_PHYSICAL_ADDRESS EntryPoint)
 
VOID EFIAPI BuildResourceDescriptorHob (IN EFI_RESOURCE_TYPE ResourceType, IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute, IN EFI_PHYSICAL_ADDRESS PhysicalStart, IN UINT64 NumberOfBytes)
 
VOID *EFIAPI BuildGuidHob (IN CONST EFI_GUID *Guid, IN UINTN DataLength)
 
VOID *EFIAPI BuildGuidDataHob (IN CONST EFI_GUID *Guid, IN VOID *Data, IN UINTN DataLength)
 
VOID EFIAPI BuildFvHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
 
VOID EFIAPI BuildFvHobs (IN EFI_PHYSICAL_ADDRESS PhysicalStart, IN UINT64 NumberOfBytes, IN EFI_RESOURCE_ATTRIBUTE_TYPE *ResourceAttribute)
 
VOID EFIAPI BuildFv2Hob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN CONST EFI_GUID *FvName, IN CONST EFI_GUID *FileName)
 
VOID EFIAPI BuildCvHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
 
VOID EFIAPI BuildCpuHob (IN UINT8 SizeOfMemorySpace, IN UINT8 SizeOfIoSpace)
 
VOID EFIAPI BuildStackHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
 
VOID UpdateStackHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
 
VOID EFIAPI BuildBspStoreHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN EFI_MEMORY_TYPE MemoryType)
 
VOID EFIAPI BuildMemoryAllocationHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN EFI_MEMORY_TYPE MemoryType)
 
VOID EFIAPI BuildExtractSectionHob (IN EFI_GUID *Guid, IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER SectionGetInfo, IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER SectionExtraction)
 
VOID EFIAPI BuildPeCoffLoaderHob (VOID)
 
VOID *EFIAPI AllocatePages (IN UINTN Pages)
 
VOID *EFIAPI AllocatePool (IN UINTN AllocationSize)
 
VOID *EFIAPI AllocateAlignedPages (IN UINTN Pages, IN UINTN Alignment)
 
EFI_STATUS EFIAPI LoadPeCoffImage (IN VOID *PeCoffImage, OUT EFI_PHYSICAL_ADDRESS *ImageAddress, OUT UINT64 *ImageSize, OUT EFI_PHYSICAL_ADDRESS *EntryPoint)
 
EFI_STATUS EFIAPI LoadDxeCoreFromFfsFile (IN EFI_PEI_FILE_HANDLE FileHandle, IN UINTN StackSize)
 
EFI_STATUS EFIAPI LoadDxeCoreFromFv (IN UINTN *FvInstance, IN UINTN StackSize)
 
EFI_STATUS EFIAPI DecompressFirstFv (VOID)
 

Detailed Description

Library that helps implement monolithic PEI. (SEC goes to DXE)

Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

VOID* EFIAPI AllocateAlignedPages ( IN UINTN  Pages,
IN UINTN  Alignment 
)

Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.

Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned. If there is not enough memory at the specified alignment remaining to satisfy the request, then NULL is returned. If Alignment is not a power of two and Alignment is not zero, then ASSERT().

Parameters
PagesThe number of 4 KB pages to allocate.
AlignmentThe requested alignment of the allocation. Must be a power of two. If Alignment is zero, then byte alignment is used.
Returns
A pointer to the allocated buffer or NULL if allocation fails.
VOID* EFIAPI AllocatePages ( IN UINTN  Pages)

Allocates one or more 4KB pages of type EfiBootServicesData.

Allocates the number of 4KB pages of MemoryType and returns a pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters
PagesThe number of 4 KB pages to allocate.
Returns
A pointer to the allocated buffer or NULL if allocation fails.
VOID* EFIAPI AllocatePool ( IN UINTN  AllocationSize)

Allocates a buffer of type EfiBootServicesData.

Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.

Parameters
AllocationSizeThe number of bytes to allocate.
Returns
A pointer to the allocated buffer or NULL if allocation fails.
VOID EFIAPI BuildBspStoreHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length,
IN EFI_MEMORY_TYPE  MemoryType 
)

Builds a HOB for the BSP store.

This function builds a HOB for BSP store. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe 64 bit physical address of the BSP.
LengthThe length of the BSP store in bytes.
MemoryTypeType of memory allocated by this HOB.
VOID EFIAPI BuildCpuHob ( IN UINT8  SizeOfMemorySpace,
IN UINT8  SizeOfIoSpace 
)

Builds a HOB for the CPU.

This function builds a HOB for the CPU. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
SizeOfMemorySpaceThe maximum physical memory addressability of the processor.
SizeOfIoSpaceThe maximum physical I/O addressability of the processor.
VOID EFIAPI BuildCvHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length 
)

Builds a Capsule Volume HOB.

This function builds a Capsule Volume HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe base address of the Capsule Volume.
LengthThe size of the Capsule Volume in bytes.
VOID EFIAPI BuildExtractSectionHob ( IN EFI_GUID *  Guid,
IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER  SectionGetInfo,
IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER  SectionExtraction 
)
VOID EFIAPI BuildFv2Hob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length,
IN CONST EFI_GUID *  FvName,
IN CONST EFI_GUID *  FileName 
)

Builds a EFI_HOB_TYPE_FV2 HOB.

This function builds a EFI_HOB_TYPE_FV2 HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe base address of the Firmware Volume.
LengthThe size of the Firmware Volume in bytes.
FvNameThe name of the Firmware Volume.
FileNameThe name of the file.
VOID EFIAPI BuildFvHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length 
)

Builds a Firmware Volume HOB.

This function builds a Firmware Volume HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe base address of the Firmware Volume.
LengthThe size of the Firmware Volume in bytes.
VOID EFIAPI BuildFvHobs ( IN EFI_PHYSICAL_ADDRESS  PhysicalStart,
IN UINT64  NumberOfBytes,
IN EFI_RESOURCE_ATTRIBUTE_TYPE *  ResourceAttribute 
)

Builds a Firmware Volume HOB and a resource descriptor hob

This function builds a Firmware Volume HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe base address of the Firmware Volume.
LengthThe size of the Firmware Volume in bytes.
VOID* EFIAPI BuildGuidDataHob ( IN CONST EFI_GUID *  Guid,
IN VOID Data,
IN UINTN  DataLength 
)

Copies a data buffer to a newly-built HOB.

This function builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB data field and returns the start address of the GUID HOB data. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If Guid is NULL, then ASSERT(). If Data is NULL and DataLength > 0, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().

Parameters
GuidThe GUID to tag the customized HOB.
DataThe data to be copied into the data field of the GUID HOB.
DataLengthThe size of the data payload for the GUID HOB.
Returns
The start address of GUID HOB data.
VOID* EFIAPI BuildGuidHob ( IN CONST EFI_GUID *  Guid,
IN UINTN  DataLength 
)

Builds a GUID HOB with a certain data length.

This function builds a customized HOB tagged with a GUID for identification and returns the start address of GUID HOB data so that caller can fill the customized data. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If Guid is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().

Parameters
GuidThe GUID to tag the customized HOB.
DataLengthThe size of the data payload for the GUID HOB.
Returns
The start address of GUID HOB data.
VOID EFIAPI BuildMemoryAllocationHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length,
IN EFI_MEMORY_TYPE  MemoryType 
)

Builds a HOB for the memory allocation.

This function builds a HOB for the memory allocation. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe 64 bit physical address of the memory.
LengthThe length of the memory allocation in bytes.
MemoryTypeType of memory allocated by this HOB.
VOID EFIAPI BuildModuleHob ( IN CONST EFI_GUID *  ModuleName,
IN EFI_PHYSICAL_ADDRESS  MemoryAllocationModule,
IN UINT64  ModuleLength,
IN EFI_PHYSICAL_ADDRESS  EntryPoint 
)

Builds a HOB for a loaded PE32 module.

This function builds a HOB for a loaded PE32 module. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If ModuleName is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters
ModuleNameThe GUID File Name of the module.
MemoryAllocationModuleThe 64 bit physical address of the module.
ModuleLengthThe length of the module in bytes.
EntryPointThe 64 bit physical address of the module entry point.
VOID EFIAPI BuildPeCoffLoaderHob ( VOID  )
VOID EFIAPI BuildResourceDescriptorHob ( IN EFI_RESOURCE_TYPE  ResourceType,
IN EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute,
IN EFI_PHYSICAL_ADDRESS  PhysicalStart,
IN UINT64  NumberOfBytes 
)

Builds a HOB that describes a chunk of system memory.

This function builds a HOB that describes a chunk of system memory. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
ResourceTypeThe type of resource described by this HOB.
ResourceAttributeThe resource attributes of the memory described by this HOB.
PhysicalStartThe 64 bit physical address of memory described by this HOB.
NumberOfBytesThe length of the memory described by this HOB in bytes.
VOID EFIAPI BuildStackHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length 
)

Builds a HOB for the Stack.

This function builds a HOB for the stack. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. If there is no additional space for HOB creation, then ASSERT().

Parameters
BaseAddressThe 64 bit physical address of the Stack.
LengthThe length of the stack in bytes.
VOID* CreateHob ( IN UINT16  HobType,
IN UINT16  HobLenght 
)

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.
Return values
!NULLThe HOB was successfully created.
NULLThere is no additional space for HOB creation.
EFI_STATUS EFIAPI DecompressFirstFv ( VOID  )
EFI_STATUS EFIAPI FfsAnyFvFindFirstFile ( IN EFI_FV_FILETYPE  FileType,
OUT EFI_PEI_FV_HANDLE *  VolumeHandle,
OUT EFI_PEI_FILE_HANDLE *  FileHandle 
)

Search through every FV until you find a file of type FileType

Parameters
FileTypeFile handle of a Fv type file.
VolumehandleOn success Volume Handle of the match
FileHandleOn success File Handle of the match
Return values
EFI_NOT_FOUNDFV image can't be found.
EFI_SUCCESSSuccessfully found FileType
EFI_STATUS EFIAPI FfsFindFileByName ( IN CONST EFI_GUID *  FileName,
IN CONST EFI_PEI_FV_HANDLE  VolumeHandle,
OUT EFI_PEI_FILE_HANDLE *  FileHandle 
)

Find a file in the volume by name

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.
Return values
EFI_SUCCESSFile was found.
EFI_NOT_FOUNDFile was not found.
EFI_INVALID_PARAMETERVolumeHandle or FileHandle or FileName was NULL.
EFI_STATUS EFIAPI FfsFindNextFile ( IN EFI_FV_FILETYPE  SearchType,
IN EFI_PEI_FV_HANDLE  VolumeHandle,
IN OUT EFI_PEI_FILE_HANDLE *  FileHandle 
)

This service enables discovery of additional firmware files.

Parameters
SearchTypeA filter to find files only of this type.
FwVolHeaderPointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHeaderPointer to 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.
EFI_STATUS EFIAPI FfsFindNextVolume ( IN UINTN  Instance,
IN OUT EFI_PEI_FV_HANDLE *  VolumeHandle 
)

This service enables discovery of additional firmware volumes.

Parameters
InstanceThis instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
FwVolHeaderPointer to 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.
EFI_STATUS EFIAPI FfsFindSectionData ( IN EFI_SECTION_TYPE  SectionType,
IN EFI_PEI_FILE_HANDLE  FileHandle,
OUT VOID **  SectionData 
)

This service enables discovery sections of a given type within a valid FFS file.

Parameters
SearchTypeThe value of the section type to find.
FfsFileHeaderA 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.
EFI_STATUS EFIAPI FfsGetFileInfo ( IN CONST EFI_PEI_FILE_HANDLE  FileHandle,
OUT EFI_FV_FILE_INFO *  FileInfo 
)

Get information about the file by name.

Parameters
FileHandleHandle 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_PARAMETERIf FileInfo is NULL.
EFI_STATUS EFIAPI FfsGetVolumeInfo ( IN EFI_PEI_FV_HANDLE  VolumeHandle,
OUT EFI_FV_INFO *  VolumeInfo 
)

Get Information about the volume by name

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.
EFI_STATUS EFIAPI FfsProcessFvFile ( IN EFI_PEI_FILE_HANDLE  FvFileHandle)

Get Fv image from the FV type file, then add FV & FV2 Hob.

Parameters
FileHandleFile handle of a Fv type file.
Return values
EFI_NOT_FOUNDFV image can't be found.
EFI_SUCCESSSuccessfully to process it.
EFI_BOOT_MODE EFIAPI GetBootMode ( VOID  )

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

Return values
BootMode
VOID* EFIAPI GetFirstGuidHob ( IN CONST EFI_GUID *  Guid)

This function searches the first instance of a HOB among the whole HOB list. Such HOB should satisfy two conditions: its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. If there does not exist such HOB from the starting HOB pointer, it will return NULL. Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE () to extract the data section and its size info respectively. If Guid is NULL, then ASSERT().

Parameters
GuidThe GUID to match with in the HOB list.
Returns
The first instance of the matched GUID HOB among the whole HOB list.
VOID* EFIAPI GetFirstHob ( IN UINT16  Type)

Returns the first instance of a HOB type among the whole HOB list.

This function searches the first instance of a HOB type among the whole HOB list. If there does not exist such HOB type in the HOB list, it will return NULL.

Parameters
TypeThe HOB type to return.
Returns
The next instance of a HOB type from the starting HOB.
VOID* EFIAPI GetHobList ( VOID  )

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.
VOID* EFIAPI GetNextGuidHob ( IN CONST EFI_GUID *  Guid,
IN CONST VOID HobStart 
)

This function searches the first instance of a HOB from the starting HOB pointer. Such HOB should satisfy two conditions: its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. If there does not exist such HOB from the starting HOB pointer, it will return NULL. Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE () to extract the data section and its size info respectively. In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer unconditionally: it returns HobStart back if HobStart itself meets the requirement; caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart. If Guid is NULL, then ASSERT(). If HobStart is NULL, then ASSERT().

Parameters
GuidThe GUID to match with in the HOB list.
HobStartA pointer to a Guid.
Returns
The next instance of the matched GUID HOB from the starting HOB.
VOID* EFIAPI GetNextHob ( IN UINT16  Type,
IN CONST VOID HobStart 
)

Returns the next instance of a HOB type from the starting HOB.

This function searches the first instance of a HOB type from the starting HOB pointer. If there does not exist such HOB type from the starting HOB pointer, it will return NULL. In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer unconditionally: it returns HobStart back if HobStart itself meets the requirement; caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart. If HobStart is NULL, then ASSERT().

Parameters
TypeThe HOB type to return.
HobStartThe starting HOB pointer to search from.
Returns
The next instance of a HOB type from the starting HOB.
EFI_HOB_HANDOFF_INFO_TABLE* HobConstructor ( IN VOID EfiMemoryBegin,
IN UINTN  EfiMemoryLength,
IN VOID EfiFreeMemoryBottom,
IN VOID EfiFreeMemoryTop 
)
EFI_STATUS EFIAPI LoadDxeCoreFromFfsFile ( IN EFI_PEI_FILE_HANDLE  FileHandle,
IN UINTN  StackSize 
)
EFI_STATUS EFIAPI LoadDxeCoreFromFv ( IN UINTN *  FvInstance,
IN UINTN  StackSize 
)
EFI_STATUS EFIAPI LoadPeCoffImage ( IN VOID PeCoffImage,
OUT EFI_PHYSICAL_ADDRESS *  ImageAddress,
OUT UINT64 *  ImageSize,
OUT EFI_PHYSICAL_ADDRESS *  EntryPoint 
)
EFI_STATUS EFIAPI SetBootMode ( 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
EFI_STATUS EFIAPI SetHobList ( IN VOID HobList)

Updates the pointer to the HOB list.

Parameters
HobListHob list pointer to store
VOID UpdateStackHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length 
)

Update the Stack Hob if the stack has been moved

Parameters
BaseAddressThe 64 bit physical address of the Stack.
LengthThe length of the stack in bytes.