123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611 |
- /** @file
- HOB Library implementation for Dxe Phase with DebugLib dependency removed
- Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
- Copyright (c) 2014, Linaro Ltd. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #define ASSERT(Expression) \
- do { \
- if (!(Expression)) { \
- CpuDeadLoop (); \
- } \
- } while (FALSE)
- #include <PiDxe.h>
- #include <Guid/HobList.h>
- #include <Library/HobLib.h>
- #include <Library/UefiLib.h>
- #include <Library/BaseMemoryLib.h>
- VOID *mHobList = NULL;
- /**
- The constructor function caches the pointer to HOB list.
- The constructor function gets the start address of HOB list from system configuration table.
- @param ImageHandle The firmware allocated handle for the EFI image.
- @param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The constructor successfully gets HobList.
- @retval Other value The constructor can't get HobList.
- **/
- EFI_STATUS
- EFIAPI
- HobLibConstructor (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
- {
- UINTN Index;
- for (Index = 0; Index < SystemTable->NumberOfTableEntries; Index++) {
- if (CompareGuid (&gEfiHobListGuid, &(SystemTable->ConfigurationTable[Index].VendorGuid))) {
- mHobList = SystemTable->ConfigurationTable[Index].VendorTable;
- return EFI_SUCCESS;
- }
- }
- return EFI_NOT_FOUND;
- }
- /**
- 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().
- @return The pointer to the HOB list.
- **/
- VOID *
- EFIAPI
- GetHobList (
- VOID
- )
- {
- ASSERT (mHobList != NULL);
- return mHobList;
- }
- /**
- 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 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().
- @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 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().
- @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 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().
- @param ModuleName The GUID File Name of the module.
- @param MemoryAllocationModule The 64 bit physical address of the module.
- @param ModuleLength The length of the module in bytes.
- @param EntryPoint The 64 bit physical address of the module entry point.
- **/
- VOID
- EFIAPI
- BuildModuleHob (
- IN CONST EFI_GUID *ModuleName,
- IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule,
- IN UINT64 ModuleLength,
- IN EFI_PHYSICAL_ADDRESS EntryPoint
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @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.
- **/
- VOID
- EFIAPI
- BuildResourceDescriptorHob (
- IN EFI_RESOURCE_TYPE ResourceType,
- IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,
- IN EFI_PHYSICAL_ADDRESS PhysicalStart,
- IN UINT64 NumberOfBytes
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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.
- @param Guid The GUID to tag the customized HOB.
- @param DataLength The size of the data payload for the GUID HOB.
- @retval NULL The GUID HOB could not be allocated.
- @retval others The start address of GUID HOB data.
- **/
- VOID *
- EFIAPI
- BuildGuidHob (
- IN CONST EFI_GUID *Guid,
- IN UINTN DataLength
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- return NULL;
- }
- /**
- 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.
- @param Guid The GUID to tag the customized HOB.
- @param Data The data to be copied into the data field of the GUID HOB.
- @param DataLength The size of the data payload for the GUID HOB.
- @retval NULL The GUID HOB could not be allocated.
- @retval others The start address of GUID HOB data.
- **/
- VOID *
- EFIAPI
- BuildGuidDataHob (
- IN CONST EFI_GUID *Guid,
- IN VOID *Data,
- IN UINTN DataLength
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- return NULL;
- }
- /**
- 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().
- @param BaseAddress The base address of the Firmware Volume.
- @param Length The size of the Firmware Volume in bytes.
- **/
- VOID
- EFIAPI
- BuildFvHob (
- IN EFI_PHYSICAL_ADDRESS BaseAddress,
- IN UINT64 Length
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @param BaseAddress The base address of the Firmware Volume.
- @param Length The size of the Firmware Volume in bytes.
- @param FvName The name of the Firmware Volume.
- @param FileName The name of the file.
- **/
- VOID
- EFIAPI
- BuildFv2Hob (
- IN EFI_PHYSICAL_ADDRESS BaseAddress,
- IN UINT64 Length,
- IN CONST EFI_GUID *FvName,
- IN CONST EFI_GUID *FileName
- )
- {
- ASSERT (FALSE);
- }
- /**
- Builds a EFI_HOB_TYPE_FV3 HOB.
- This function builds a EFI_HOB_TYPE_FV3 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().
- @param BaseAddress The base address of the Firmware Volume.
- @param Length The size of the Firmware Volume in bytes.
- @param AuthenticationStatus The authentication status.
- @param ExtractedFv TRUE if the FV was extracted as a file within
- another firmware volume. FALSE otherwise.
- @param FvName The name of the Firmware Volume.
- Valid only if IsExtractedFv is TRUE.
- @param FileName The name of the file.
- Valid only if IsExtractedFv is TRUE.
- **/
- VOID
- EFIAPI
- BuildFv3Hob (
- IN EFI_PHYSICAL_ADDRESS BaseAddress,
- IN UINT64 Length,
- IN UINT32 AuthenticationStatus,
- IN BOOLEAN ExtractedFv,
- IN CONST EFI_GUID *FvName OPTIONAL,
- IN CONST EFI_GUID *FileName OPTIONAL
- )
- {
- ASSERT (FALSE);
- }
- /**
- 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().
- @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
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @param SizeOfMemorySpace The maximum physical memory addressability of the processor.
- @param SizeOfIoSpace The maximum physical I/O addressability of the processor.
- **/
- VOID
- EFIAPI
- BuildCpuHob (
- IN UINT8 SizeOfMemorySpace,
- IN UINT8 SizeOfIoSpace
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @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
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @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
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
- /**
- 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().
- @param BaseAddress The 64 bit physical address of the memory.
- @param Length The length of the memory allocation in bytes.
- @param MemoryType Type of memory allocated by this HOB.
- **/
- VOID
- EFIAPI
- BuildMemoryAllocationHob (
- IN EFI_PHYSICAL_ADDRESS BaseAddress,
- IN UINT64 Length,
- IN EFI_MEMORY_TYPE MemoryType
- )
- {
- //
- // PEI HOB is read only for DXE phase
- //
- ASSERT (FALSE);
- }
|