#include <Guid/ExtractSection.h>

Typedefs
typedef EFI_STATUS(EFIAPI *	FFS_CHECK_SECTION_HOOK) (IN EFI_COMMON_SECTION_HEADER *Section)

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	FfsFindSectionDataWithHook (IN EFI_SECTION_TYPE SectionType, IN FFS_CHECK_SECTION_HOOK SectionCheckHook, IN EFI_PEI_FILE_HANDLE FileHandle, OUT VOID **SectionData)

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)

VOID *	CreateHob (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 OPTIONAL)

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	AllocateRuntimePages (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 OPTIONAL, IN UINTN StackSize)

EFI_STATUS EFIAPI	DecompressFirstFv (VOID)

Detailed Description

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

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

Definition in file PrePiLib.h.

Typedef Documentation

◆ FFS_CHECK_SECTION_HOOK

typedef EFI_STATUS(EFIAPI * FFS_CHECK_SECTION_HOOK) (IN EFI_COMMON_SECTION_HEADER *Section)

This is a hook which is used to check if the section is the target one.

Definition at line 60 of file PrePiLib.h.

Function Documentation

◆ AllocateAlignedPages()

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

Pages	The number of 4 KB pages to allocate.
Alignment	The 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.

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(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters

Pages	The number of 4 KB pages to allocate.
Alignment	The 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.

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

Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData 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(). If Pages plus EFI_SIZE_TO_PAGES (Alignment) overflows, then ASSERT().

Parameters

Pages	The number of 4 KB pages to allocate.
Alignment	The 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.

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

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

Parameters

Pages	The number of 4 KB pages to allocate.
Alignment	The requested alignment of the allocation.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Definition at line 119 of file MemoryAllocationLib.c.

◆ AllocatePages()

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

Pages The number of 4 KB pages to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Allocates one or more 4KB pages of type EfiBootServicesData.

Allocates the number of 4KB pages of type EfiBootServicesData 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

Pages The number of 4 KB pages to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Allocates one or more 4KB pages of type EfiRuntimeServicesData.

Allocates the number of 4KB pages of type EfiRuntimeServicesData 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

Pages The number of 4 KB pages to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Allocates one or more pages of type EfiBootServicesData.

Allocates the number of 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 availble to satisfy the request, then NULL is returned.

Parameters

Pages The number of 4 KB pages to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Definition at line 72 of file MemoryAllocationLib.c.

◆ AllocatePool()

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

AllocationSize The number of bytes to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Allocates a buffer of type EfiRuntimeServicesData.

Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData 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

AllocationSize The number of bytes to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Definition at line 195 of file MemoryAllocationLib.c.

◆ AllocateRuntimePages()

VOID *EFIAPI AllocateRuntimePages ( IN UINTN Pages )

Allocates one or more 4KB pages of type EfiRuntimeServicesData.

Allocates the number of 4KB pages of type EfiRuntimeServicesData 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

Pages The number of 4 KB pages to allocate.

Returns: A pointer to the allocated buffer or NULL if allocation fails.

Definition at line 94 of file MemoryAllocationLib.c.

◆ BuildBspStoreHob()

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

BaseAddress	The 64 bit physical address of the BSP.
Length	The length of the BSP store in bytes.
MemoryType	Type of memory allocated by this HOB.

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

BaseAddress	The 64 bit physical address of the BSP.
Length	The length of the BSP store in bytes.
MemoryType	The type of memory allocated by this HOB.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the BSP.
Length	The length of the BSP store in bytes.
MemoryType	Type of memory allocated by this HOB.

Builds a HOB for the BSP store.

This function builds a HOB for BSP store. If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the BSP.
Length	The length of the BSP store in bytes.
MemoryType	Type of memory allocated by this HOB.

Definition at line 573 of file HobLib.c.

◆ BuildCpuHob()

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

SizeOfMemorySpace	The maximum physical memory addressability of the processor.
SizeOfIoSpace	The maximum physical I/O addressability of the processor.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

SizeOfMemorySpace	The maximum physical memory addressability of the processor.
SizeOfIoSpace	The maximum physical I/O addressability of the processor.

Builds a HOB for the CPU.

This function builds a HOB for the CPU. If there is no additional space for HOB creation, then ASSERT().

Parameters

SizeOfMemorySpace	The maximum physical memory addressability of the processor.
SizeOfIoSpace	The maximum physical I/O addressability of the processor.

Builds a HOB for the CPU.

This function builds a HOB for the CPU. It can only be invoked during PEI phase; for MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

SizeOfMemorySpace	The maximum physical memory addressability of the processor.
SizeOfIoSpace	The maximum physical I/O addressability of the processor.

Builds a HOB for the CPU.

This function builds a HOB for the CPU. It can only be invoked by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If there is no additional space for HOB creation, then ASSERT().

Parameters

SizeOfMemorySpace	The maximum physical memory addressability of the processor.
SizeOfIoSpace	The maximum physical I/O addressability of the processor.

Definition at line 520 of file HobLib.c.

◆ BuildCvHob()

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

BaseAddress	The base address of the Capsule Volume.
Length	The size of the Capsule Volume in bytes.

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 the platform does not support Capsule Volume HOBs, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Capsule Volume.
Length	The size of the Capsule Volume in bytes.

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() because PEI HOB is read-only for DXE phase.

If the platform does not support Capsule Volume HOBs, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Capsule Volume.
Length	The size of the Capsule Volume in bytes.

Builds a Capsule Volume HOB.

This function builds a Capsule Volume HOB. If the platform does not support Capsule Volume HOBs, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Capsule Volume.
Length	The size of the Capsule Volume in bytes.

Definition at line 494 of file HobLib.c.

◆ BuildExtractSectionHob()

VOID EFIAPI BuildExtractSectionHob	(	IN EFI_GUID *	Guid,
		IN EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER	SectionGetInfo,
		IN EXTRACT_GUIDED_SECTION_DECODE_HANDLER	SectionExtraction
	)

Definition at line 808 of file Hob.c.

◆ BuildFv2Hob()

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

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

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(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

Builds a EFI_HOB_TYPE_FV2 HOB.

This function builds a EFI_HOB_TYPE_FV2 HOB. If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

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 MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If there is no additional space for HOB creation, then ASSERT(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

Builds a EFI_HOB_TYPE_FV2 HOB.

This function builds a EFI_HOB_TYPE_FV2 HOB. It can only be invoked by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.
FvName	The name of the Firmware Volume.
FileName	The name of the file.

Definition at line 433 of file HobLib.c.

◆ BuildFvHob()

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

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

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(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

Builds a Firmware Volume HOB.

This function builds a Firmware Volume HOB. If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

Builds a Firmware Volume HOB.

This function builds a Firmware Volume HOB. It can only be invoked during PEI phase; for MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If there is no additional space for HOB creation, then ASSERT(). If the FvImage buffer is not at its required alignment, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

Builds a Firmware Volume HOB.

This function builds a Firmware Volume HOB. It can only be invoked by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

Definition at line 404 of file HobLib.c.

◆ BuildFvHobs()

VOID EFIAPI BuildFvHobs	(	IN EFI_PHYSICAL_ADDRESS	PhysicalStart,
		IN UINT64	NumberOfBytes,
		IN EFI_RESOURCE_ATTRIBUTE_TYPE *ResourceAttribute	OPTIONAL
	)

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

BaseAddress	The base address of the Firmware Volume.
Length	The size of the Firmware Volume in bytes.

◆ BuildGuidDataHob()

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

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

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.

This function builds a customized HOB tagged with a GUID for identification and copies the input data to the HOB data field and returns the start address of the GUID HOB data. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. 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 > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

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.

This function builds a customized HOB tagged with a GUID for identification and copies the input data to the HOB data field and returns the start address of the GUID HOB data. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase. For DXE phase, it will ASSERT() because 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 > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

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. 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

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

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.

This function builds a customized HOB tagged with a GUID for identification and copies the input data to the HOB data field and returns the start address of the GUID HOB data. It can only be invoked during PEI phase; for MM phase, it will ASSERT() because PEI HOB is read-only for MM phase. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase. For MM phase, it will ASSERT() because PEI HOB is read-only for MM 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 > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

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 by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

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

Guid	The GUID to tag the customized HOB.
Data	The data to be copied into the data field of the GUID HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

Definition at line 375 of file HobLib.c.

◆ BuildGuidHob()

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

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

Builds a customized HOB tagged with a GUID for identification and returns the start address of GUID HOB data.

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 > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

Builds a customized HOB tagged with a GUID for identification and returns the start address of GUID HOB data.

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() because 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 > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

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. 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

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

Builds a customized HOB tagged with a GUID for identification and returns the start address of GUID HOB data.

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 MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If Guid is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.

Parameters

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Return values

NULL	The GUID HOB could not be allocated.
others	The start address of GUID HOB data.

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 by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

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

Guid	The GUID to tag the customized HOB.
DataLength	The size of the data payload for the GUID HOB.

Returns: The start address of GUID HOB data.

Definition at line 336 of file HobLib.c.

◆ BuildMemoryAllocationHob()

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

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	Type of memory allocated by this HOB.

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

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	The type of memory allocated by this HOB.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	Type of memory allocated by this HOB.

Builds a HOB for the memory allocation.

This function builds a HOB for the memory allocation. If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	Type of memory allocated by this HOB.

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 MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	Type of memory allocated by this HOB.

Builds a HOB for the memory allocation.

This function builds a HOB for the memory allocation. It can only be invoked by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the memory.
Length	The length of the memory allocation in bytes.
MemoryType	Type of memory allocated by this HOB.

Definition at line 601 of file HobLib.c.

◆ BuildModuleHob()

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

ModuleName	The GUID File Name of the module.
MemoryAllocationModule	The 64 bit physical address of the module.
ModuleLength	The length of the module in bytes.
EntryPoint	The 64 bit physical address of the module entry point.

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() because 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

ModuleName	The GUID File Name of the module.
MemoryAllocationModule	The 64 bit physical address of the module.
ModuleLength	The length of the module in bytes.
EntryPoint	The 64 bit physical address of the module entry point.

Builds a HOB for a loaded PE32 module.

This function builds a HOB for a loaded PE32 module. If ModuleName is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

ModuleName	The GUID File Name of the module.
MemoryAllocationModule	The 64 bit physical address of the module.
ModuleLength	The length of the module in bytes.
EntryPoint	The 64 bit physical address of the module entry point.

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 MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If ModuleName is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

ModuleName	The GUID File Name of the module.
MemoryAllocationModule	The 64 bit physical address of the module.
ModuleLength	The length of the module in bytes.
EntryPoint	The 64 bit physical address of the module entry point.

Builds a HOB for a loaded PE32 module.

This function builds a HOB for a loaded PE32 module. It can only be invoked by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If ModuleName is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT().

Parameters

ModuleName	The GUID File Name of the module.
MemoryAllocationModule	The 64 bit physical address of the module.
ModuleLength	The length of the module in bytes.
EntryPoint	The 64 bit physical address of the module entry point.

Definition at line 269 of file HobLib.c.

◆ BuildPeCoffLoaderHob()

VOID EFIAPI BuildPeCoffLoaderHob ( VOID )

Definition at line 832 of file Hob.c.

◆ BuildResourceDescriptorHob()

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

ResourceType	The type of resource described by this HOB.
ResourceAttribute	The resource attributes of the memory described by this HOB.
PhysicalStart	The 64 bit physical address of memory described by this HOB.
NumberOfBytes	The length of the memory described by this HOB in bytes.

Builds a HOB that describes a chunk of system memory.

This function builds a HOB that describes a chunk of system memory. If there is no additional space for HOB creation, then ASSERT().

Parameters

ResourceType	The type of resource described by this HOB.
ResourceAttribute	The resource attributes of the memory described by this HOB.
PhysicalStart	The 64 bit physical address of memory described by this HOB.
NumberOfBytes	The length of the memory described by this HOB in bytes.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

ResourceType	The type of resource described by this HOB.
ResourceAttribute	The resource attributes of the memory described by this HOB.
PhysicalStart	The 64 bit physical address of memory described by this HOB.
NumberOfBytes	The length of the memory described by this HOB in bytes.

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 MM phase, it will ASSERT() because PEI HOB is read-only for MM phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

ResourceType	The type of resource described by this HOB.
ResourceAttribute	The resource attributes of the memory described by this HOB.
PhysicalStart	The 64 bit physical address of memory described by this HOB.
NumberOfBytes	The length of the memory described by this HOB in bytes.

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 by Standalone MM Core. For Standalone MM drivers, it will ASSERT() since HOB is read only for Standalone MM drivers.

If there is no additional space for HOB creation, then ASSERT().

Parameters

ResourceType	The type of resource described by this HOB.
ResourceAttribute	The resource attributes of the memory described by this HOB.
PhysicalStart	The 64 bit physical address of memory described by this HOB.
NumberOfBytes	The length of the memory described by this HOB in bytes.

Definition at line 299 of file HobLib.c.

◆ BuildStackHob()

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

BaseAddress	The 64 bit physical address of the Stack.
Length	The length of the stack in bytes.

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() because PEI HOB is read-only for DXE phase.

If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the Stack.
Length	The length of the stack in bytes.

Builds a HOB for the Stack.

This function builds a HOB for the stack. If there is no additional space for HOB creation, then ASSERT().

Parameters

BaseAddress	The 64 bit physical address of the Stack.
Length	The length of the stack in bytes.

Definition at line 546 of file HobLib.c.

◆ CreateHob()

VOID * CreateHob	(	IN UINT16	HobType,
		IN UINT16	HobLength
	)

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.

Return values

!NULL	The HOB was successfully created.
NULL	There is no additional space for HOB creation.

Add a new HOB to the HOB List.

Parameters

HobType	Type of the new HOB.
HobLength	Length of the new HOB to allocate.

Returns: NULL if there is no space to create a hob.; The address point to the new created hob.

Definition at line 101 of file Hob.c.

◆ DecompressFirstFv()

EFI_STATUS EFIAPI DecompressFirstFv ( VOID )

Definition at line 224 of file PrePiLib.c.

◆ FfsAnyFvFindFirstFile()

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

FileType	File handle of a Fv type file.
Volumehandle	On success Volume Handle of the match
FileHandle	On success File Handle of the match

Return values

EFI_NOT_FOUND	FV image can't be found.
EFI_SUCCESS	Successfully found FileType

Definition at line 771 of file FwVol.c.

◆ FfsFindFileByName()

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

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.

Return values

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

◆ FfsFindNextFile()

EFI_STATUS EFIAPI FfsFindNextFile	(	IN UINT8	SearchType,
		IN EFI_PEI_FV_HANDLE	VolumeHandle,
		IN OUT EFI_PEI_FILE_HANDLE *	FileHandle
	)

This service enables discovery of additional firmware files.

Parameters

SearchType	A filter to find files only of this type.
FwVolHeader	Pointer to the firmware volume header of the volume to search. This parameter must point to a valid FFS volume.
FileHeader	Pointer to 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 545 of file FwVol.c.

◆ FfsFindNextVolume()

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

This service enables discovery of additional firmware volumes.

Parameters

Instance	This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
FwVolHeader	Pointer to 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.

This service enables discovery of additional firmware volumes.

Parameters

Instance	This instance of the firmware volume to find. The value 0 is the Boot Firmware Volume (BFV).
FwVolHeader	Pointer to 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.

Definition at line 567 of file FwVol.c.

◆ FfsFindSectionData()

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

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 521 of file FwVol.c.

◆ FfsFindSectionDataWithHook()

EFI_STATUS EFIAPI FfsFindSectionDataWithHook	(	IN EFI_SECTION_TYPE	SectionType,
		IN FFS_CHECK_SECTION_HOOK	SectionCheckHook,
		IN EFI_PEI_FILE_HANDLE	FileHandle,
		OUT VOID **	SectionData
	)

This service enables discovery sections of a given type within a valid FFS file. Caller also can provide a SectionCheckHook to do additional checking.

Parameters

SectionType	The value of the section type to find.
SectionCheckHook	A hook which can check if the section is the target one.
FileHeader	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.

This service enables discovery sections of a given type within a valid FFS file. Caller also can provide a SectionCheckHook to do additional checking.

Parameters

SectionType	The value of the section type to find.
SectionCheckHook	A hook which can check if the section is the target one.
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 476 of file FwVol.c.

◆ FfsGetFileInfo()

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

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.

◆ FfsGetVolumeInfo()

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

Get Information about the volume by name

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 720 of file FwVol.c.

◆ FfsProcessFvFile()

EFI_STATUS EFIAPI FfsProcessFvFile ( IN EFI_PEI_FILE_HANDLE FvFileHandle )

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

Parameters

FileHandle File handle of a Fv type file.

Return values

EFI_NOT_FOUND	FV image can't be found.
EFI_SUCCESS	Successfully to process it.

Definition at line 813 of file FwVol.c.

◆ GetBootMode()

EFI_BOOT_MODE EFIAPI GetBootMode ( VOID )

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

Return values

BootMode

Definition at line 344 of file Hob.c.

◆ GetFirstGuidHob()

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

Guid	The GUID to match with in the HOB list.

Returns: The first instance of the matched GUID HOB among the whole HOB list.

Returns the first instance of the matched GUID HOB among the whole HOB list.

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 information, respectively.

If the pointer to the HOB list is NULL, then ASSERT(). If Guid is NULL, then ASSERT().

Parameters

Guid	The GUID to match with in the HOB list.

Returns: The first instance of the matched GUID HOB among the whole HOB list.

Returns the first instance of the matched GUID HOB among the whole HOB list.

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 such a HOB from the starting HOB pointer does not exist, 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 information, respectively.

If the pointer to the HOB list is NULL, then ASSERT(). If Guid is NULL, then ASSERT().

Parameters

Guid	The GUID to match with in the HOB list.

Returns: The first instance of the matched GUID HOB among the whole HOB list.

Definition at line 215 of file HobLib.c.

◆ GetFirstHob()

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

Type	The HOB type to return.

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

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.

If the pointer to the HOB list is NULL, then ASSERT().

Parameters

Type	The HOB type to return.

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

Definition at line 142 of file HobLib.c.

◆ GetHobList()

VOID *EFIAPI GetHobList ( VOID )

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.

Returns the pointer to the HOB list.

This function returns the pointer to first HOB in the list. For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through the EFI System Table by looking up theHOB list GUID in the System Configuration Table. Since the System Configuration Table does not exist that the time the DXE Core is launched, the DXE Core uses a global variable from the DXE Core Entry Point Library to manage the pointer to the HOB list.

If the pointer to the HOB list is NULL, then ASSERT().

Returns: The pointer to the HOB list.

Returns the pointer to the HOB list.

This function returns the pointer to first HOB in the list.

Returns: The pointer to the HOB list.

Returns the pointer to the HOB list.

This function returns the pointer to first HOB in the list. For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through the EFI System Table by looking up theHOB list GUID in the System Configuration Table. Since the System Configuration Table does not exist that the time the DXE Core is launched, the DXE Core uses a global variable from the DXE Core Entry Point Library to manage the pointer to the HOB list.

If the pointer to the HOB list is NULL, then ASSERT().

This function also caches the pointer to the HOB list retrieved.

Returns: The pointer to the HOB list.

Returns the pointer to the HOB list.

This function returns the pointer to first HOB in the list. If the pointer to the HOB list is NULL, then ASSERT().

Returns: The pointer to the HOB list.

Definition at line 76 of file HobLib.c.

◆ GetNextGuidHob()

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

Guid	The GUID to match with in the HOB list.
HobStart	A pointer to a Guid.

Returns: The next instance of the matched GUID HOB from the starting HOB.

Returns the next instance of the matched GUID HOB from the starting HOB.

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 information, 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

Guid	The GUID to match with in the HOB list.
HobStart	A pointer to a Guid.

Returns: The next instance of the matched GUID HOB from the starting HOB.

Returns the next instance of the matched GUID HOB from the starting HOB.

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 such a HOB from the starting HOB pointer does not exist, 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 information, 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

Guid	The GUID to match with in the HOB list.
HobStart	A pointer to a Guid.

Returns: The next instance of the matched GUID HOB from the starting HOB.

Definition at line 176 of file HobLib.c.

◆ GetNextHob()

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

Type	The HOB type to return.
HobStart	The starting HOB pointer to search from.

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

Definition at line 103 of file HobLib.c.

◆ HobConstructor()

EFI_HOB_HANDOFF_INFO_TABLE * HobConstructor	(	IN VOID *	EfiMemoryBegin,
		IN UINTN	EfiMemoryLength,
		IN VOID *	EfiFreeMemoryBottom,
		IN VOID *	EfiFreeMemoryTop
	)

Definition at line 67 of file Hob.c.

◆ LoadDxeCoreFromFfsFile()

EFI_STATUS EFIAPI LoadDxeCoreFromFfsFile	(	IN EFI_PEI_FILE_HANDLE	FileHandle,
		IN UINTN	StackSize
	)

Definition at line 119 of file PrePiLib.c.

◆ LoadDxeCoreFromFv()

EFI_STATUS EFIAPI LoadDxeCoreFromFv	(	IN UINTN *FvInstance	OPTIONAL,
		IN UINTN	StackSize
	)

Definition at line 194 of file PrePiLib.c.

◆ LoadPeCoffImage()

EFI_STATUS EFIAPI LoadPeCoffImage	(	IN VOID *	PeCoffImage,
		OUT EFI_PHYSICAL_ADDRESS *	ImageAddress,
		OUT UINT64 *	ImageSize,
		OUT EFI_PHYSICAL_ADDRESS *	EntryPoint
	)

Loads and relocates a PE/COFF image

Parameters

[in]	PeCoffImage	Point to a Pe/Coff image.
[out]	ImageAddress	The image memory address after relocation.
[out]	ImageSize	The image size.
[out]	EntryPoint	The image entry point.

Returns: EFI_SUCCESS If the image is loaded and relocated successfully.; Others If the image failed to load or relocate.

Definition at line 59 of file PrePiLib.c.

◆ SetBootMode()

EFI_STATUS EFIAPI SetBootMode ( 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 364 of file Hob.c.

◆ SetHobList()

EFI_STATUS EFIAPI SetHobList ( IN VOID * HobList )

Updates the pointer to the HOB list.

Parameters

HobList Hob list pointer to store

Definition at line 55 of file Hob.c.

◆ UpdateStackHob()

VOID UpdateStackHob	(	IN EFI_PHYSICAL_ADDRESS	BaseAddress,
		IN UINT64	Length
	)

Update the Stack Hob if the stack has been moved

Parameters

BaseAddress	The 64 bit physical address of the Stack.
Length	The length of the stack in bytes.

Updates the Stack HOB passed to DXE phase.

This function traverses the whole HOB list and update the stack HOB to reflect the real stack that is used by DXE core.

Parameters

BaseAddress	The lower address of stack used by DxeCore.
Length	The length of stack used by DxeCore.

Definition at line 731 of file Hob.c.

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ FFS_CHECK_SECTION_HOOK

Function Documentation

◆ AllocateAlignedPages()

◆ AllocatePages()

◆ AllocatePool()

◆ AllocateRuntimePages()

◆ BuildBspStoreHob()

◆ BuildCpuHob()

◆ BuildCvHob()

◆ BuildExtractSectionHob()

◆ BuildFv2Hob()

◆ BuildFvHob()

◆ BuildFvHobs()

◆ BuildGuidDataHob()

◆ BuildGuidHob()

◆ BuildMemoryAllocationHob()

◆ BuildModuleHob()

◆ BuildPeCoffLoaderHob()

◆ BuildResourceDescriptorHob()

◆ BuildStackHob()

◆ CreateHob()

◆ DecompressFirstFv()

◆ FfsAnyFvFindFirstFile()

◆ FfsFindFileByName()

◆ FfsFindNextFile()

◆ FfsFindNextVolume()

◆ FfsFindSectionData()

◆ FfsFindSectionDataWithHook()

◆ FfsGetFileInfo()

◆ FfsGetVolumeInfo()

◆ FfsProcessFvFile()

◆ GetBootMode()

◆ GetFirstGuidHob()

◆ GetFirstHob()

◆ GetHobList()

◆ GetNextGuidHob()

◆ GetNextHob()

◆ HobConstructor()

◆ LoadDxeCoreFromFfsFile()

◆ LoadDxeCoreFromFv()

◆ LoadPeCoffImage()

◆ SetBootMode()

◆ SetHobList()

◆ UpdateStackHob()