#include <PiMm.h>
#include <Library/HobLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MmServicesTableLib.h>

Functions
EFI_STATUS EFIAPI	HobLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_MM_SYSTEM_TABLE *MmSystemTable)

VOID *EFIAPI	GetHobList (VOID)

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)

EFI_BOOT_MODE EFIAPI	GetBootModeHob (VOID)

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	BuildFv2Hob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN CONST EFI_GUID FvName, IN CONST EFI_GUID FileName)

VOID EFIAPI	BuildCpuHob (IN UINT8 SizeOfMemorySpace, IN UINT8 SizeOfIoSpace)

VOID EFIAPI	BuildMemoryAllocationHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN EFI_MEMORY_TYPE MemoryType)

VOID EFIAPI	BuildResourceDescriptorWithOwnerHob (IN EFI_RESOURCE_TYPE ResourceType, IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute, IN EFI_PHYSICAL_ADDRESS PhysicalStart, IN UINT64 NumberOfBytes, IN EFI_GUID *OwnerGUID)

VOID EFIAPI	BuildCvHob (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	BuildStackHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)

Variables
STATIC VOID *	gHobList = NULL

Detailed Description

HOB Library implementation for Standalone MM modules.

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

Definition in file StandaloneMmHobLib.c.

Function Documentation

◆ 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. 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 553 of file StandaloneMmHobLib.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 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 454 of file StandaloneMmHobLib.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. 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 532 of file StandaloneMmHobLib.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 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 426 of file StandaloneMmHobLib.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 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 398 of file StandaloneMmHobLib.c.

◆ 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 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 370 of file StandaloneMmHobLib.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 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 335 of file StandaloneMmHobLib.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 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 481 of file StandaloneMmHobLib.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 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 271 of file StandaloneMmHobLib.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 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 301 of file StandaloneMmHobLib.c.

◆ BuildResourceDescriptorWithOwnerHob()

VOID EFIAPI BuildResourceDescriptorWithOwnerHob	(	IN EFI_RESOURCE_TYPE	ResourceType,
		IN EFI_RESOURCE_ATTRIBUTE_TYPE	ResourceAttribute,
		IN EFI_PHYSICAL_ADDRESS	PhysicalStart,
		IN UINT64	NumberOfBytes,
		IN EFI_GUID *	OwnerGUID
	)

Builds a HOB that describes a chunk of system memory with Owner GUID.

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.
OwnerGUID	GUID for the owner of this resource.

Definition at line 508 of file StandaloneMmHobLib.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. 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 574 of file StandaloneMmHobLib.c.

◆ GetBootModeHob()

EFI_BOOT_MODE EFIAPI GetBootModeHob ( VOID )

Get the system boot mode from the HOB list.

This function returns the system boot mode information from the PHIT HOB in HOB list.

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

Parameters

VOID

Returns: The Boot Mode.

Definition at line 242 of file StandaloneMmHobLib.c.

◆ GetFirstGuidHob()

VOID *EFIAPI GetFirstGuidHob ( IN CONST EFI_GUID * Guid )

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 217 of file StandaloneMmHobLib.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.

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 144 of file StandaloneMmHobLib.c.

◆ GetHobList()

VOID *EFIAPI GetHobList ( VOID )

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 67 of file StandaloneMmHobLib.c.

◆ GetNextGuidHob()

VOID *EFIAPI GetNextGuidHob	(	IN CONST EFI_GUID *	Guid,
		IN CONST VOID *	HobStart
	)

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 178 of file StandaloneMmHobLib.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 105 of file StandaloneMmHobLib.c.

◆ HobLibConstructor()

EFI_STATUS EFIAPI HobLibConstructor	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_MM_SYSTEM_TABLE *	MmSystemTable
	)

The constructor function caches the pointer to HOB list.

The constructor function gets the start address of HOB list from system configuration table. It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

Parameters

ImageHandle	The firmware allocated handle for the image.
MmSystemTable	A pointer to the MM System Table.

Return values

EFI_SUCCESS	The constructor successfully gets HobList.
Other	value The constructor can't get HobList.

Definition at line 39 of file StandaloneMmHobLib.c.

Variable Documentation

◆ gHobList

STATIC VOID* gHobList = NULL

Global variable that contains a pointer to the Hob List passed into the DXE Core entry point.

Definition at line 22 of file StandaloneMmHobLib.c.

Functions

Variables

Detailed Description

Function Documentation

◆ BuildBspStoreHob()

◆ BuildCpuHob()

◆ BuildCvHob()

◆ BuildFv2Hob()

◆ BuildFvHob()

◆ BuildGuidDataHob()

◆ BuildGuidHob()

◆ BuildMemoryAllocationHob()

◆ BuildModuleHob()

◆ BuildResourceDescriptorHob()

◆ BuildResourceDescriptorWithOwnerHob()

◆ BuildStackHob()

◆ GetBootModeHob()

◆ GetFirstGuidHob()

◆ GetFirstHob()

◆ GetHobList()

◆ GetNextGuidHob()

◆ GetNextHob()

◆ HobLibConstructor()

Variable Documentation

◆ gHobList