/** @file | |
HOB Library implementation for Standalone MM Core. | |
Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR> | |
Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.<BR> | |
SPDX-License-Identifier: BSD-2-Clause-Patent | |
**/ | |
#include <PiMm.h> | |
#include <Library/HobLib.h> | |
#include <Library/DebugLib.h> | |
#include <Library/BaseMemoryLib.h> | |
#include <Library/StandaloneMmCoreEntryPoint.h> | |
#include <Guid/MemoryAllocationHob.h> | |
/** | |
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(). | |
@return The pointer to the HOB list. | |
**/ | |
VOID * | |
EFIAPI | |
GetHobList ( | |
VOID | |
) | |
{ | |
ASSERT (gHobList != NULL); | |
return gHobList; | |
} | |
/** | |
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(). | |
@param Type The HOB type to return. | |
@param HobStart The starting HOB pointer to search from. | |
@return The next instance of a HOB type from the starting HOB. | |
**/ | |
VOID * | |
EFIAPI | |
GetNextHob ( | |
IN UINT16 Type, | |
IN CONST VOID *HobStart | |
) | |
{ | |
EFI_PEI_HOB_POINTERS Hob; | |
ASSERT (HobStart != NULL); | |
Hob.Raw = (UINT8 *)HobStart; | |
// | |
// Parse the HOB list until end of list or matching type is found. | |
// | |
while (!END_OF_HOB_LIST (Hob)) { | |
if (Hob.Header->HobType == Type) { | |
return Hob.Raw; | |
} | |
Hob.Raw = GET_NEXT_HOB (Hob); | |
} | |
return NULL; | |
} | |
/** | |
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(). | |
@param Type The HOB type to return. | |
@return The next instance of a HOB type from the starting HOB. | |
**/ | |
VOID * | |
EFIAPI | |
GetFirstHob ( | |
IN UINT16 Type | |
) | |
{ | |
VOID *HobList; | |
HobList = GetHobList (); | |
return GetNextHob (Type, HobList); | |
} | |
/** | |
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(). | |
@param Guid The GUID to match with in the HOB list. | |
@param HobStart A pointer to a Guid. | |
@return The next instance of the matched GUID HOB from the starting HOB. | |
**/ | |
VOID * | |
EFIAPI | |
GetNextGuidHob ( | |
IN CONST EFI_GUID *Guid, | |
IN CONST VOID *HobStart | |
) | |
{ | |
EFI_PEI_HOB_POINTERS GuidHob; | |
GuidHob.Raw = (UINT8 *)HobStart; | |
while ((GuidHob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GuidHob.Raw)) != NULL) { | |
if (CompareGuid (Guid, &GuidHob.Guid->Name)) { | |
break; | |
} | |
GuidHob.Raw = GET_NEXT_HOB (GuidHob); | |
} | |
return GuidHob.Raw; | |
} | |
/** | |
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(). | |
@param Guid The GUID to match with in the HOB list. | |
@return The first instance of the matched GUID HOB among the whole HOB list. | |
**/ | |
VOID * | |
EFIAPI | |
GetFirstGuidHob ( | |
IN CONST EFI_GUID *Guid | |
) | |
{ | |
VOID *HobList; | |
HobList = GetHobList (); | |
return GetNextGuidHob (Guid, HobList); | |
} | |
/** | |
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(). | |
@param VOID | |
@return The Boot Mode. | |
**/ | |
EFI_BOOT_MODE | |
EFIAPI | |
GetBootModeHob ( | |
VOID | |
) | |
{ | |
EFI_HOB_HANDOFF_INFO_TABLE *HandOffHob; | |
HandOffHob = (EFI_HOB_HANDOFF_INFO_TABLE *)GetHobList (); | |
return HandOffHob->BootMode; | |
} | |
/** | |
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(). | |
@param ResourceType The type of resource described by this HOB. | |
@param ResourceAttribute The resource attributes of the memory described by this HOB. | |
@param PhysicalStart The 64 bit physical address of memory described by this HOB. | |
@param NumberOfBytes The length of the memory described by this HOB in bytes. | |
@param OwnerGUID GUID for the owner of this resource. | |
**/ | |
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 | |
) | |
{ | |
ASSERT (FALSE); | |
} | |
/** | |
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(). | |
@param BaseAddress The base address of the Capsule Volume. | |
@param Length The size of the Capsule Volume in bytes. | |
**/ | |
VOID | |
EFIAPI | |
BuildCvHob ( | |
IN EFI_PHYSICAL_ADDRESS BaseAddress, | |
IN UINT64 Length | |
) | |
{ | |
ASSERT (FALSE); | |
} | |
/** | |
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(). | |
@param BaseAddress The 64 bit physical address of the BSP. | |
@param Length The length of the BSP store in bytes. | |
@param MemoryType Type of memory allocated by this HOB. | |
**/ | |
VOID | |
EFIAPI | |
BuildBspStoreHob ( | |
IN EFI_PHYSICAL_ADDRESS BaseAddress, | |
IN UINT64 Length, | |
IN EFI_MEMORY_TYPE MemoryType | |
) | |
{ | |
ASSERT (FALSE); | |
} | |
/** | |
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(). | |
@param BaseAddress The 64 bit physical address of the Stack. | |
@param Length The length of the stack in bytes. | |
**/ | |
VOID | |
EFIAPI | |
BuildStackHob ( | |
IN EFI_PHYSICAL_ADDRESS BaseAddress, | |
IN UINT64 Length | |
) | |
{ | |
ASSERT (FALSE); | |
} |