+++ /dev/null
-/** @file\r
- Instance of HOB Library using PEI Services.\r
-\r
- HOB Library implementation that uses PEI Services to retrieve the HOB List.\r
- This library instance uses EFI_HOB_TYPE_CV defined in Intel framework HOB specification v0.9\r
- to implement HobLib BuildCvHob() API.\r
-\r
-Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
-SPDX-License-Identifier: BSD-2-Clause-Patent\r
-\r
-**/\r
-\r
-#include <FrameworkPei.h>\r
-\r
-#include <Guid/MemoryAllocationHob.h>\r
-\r
-#include <Library/HobLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/PeiServicesLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-\r
-/**\r
- Returns the pointer to the HOB list.\r
-\r
- This function returns the pointer to first HOB in the list.\r
- For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer\r
- to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through\r
- the EFI System Table by looking up theHOB list GUID in the System Configuration Table.\r
- Since the System Configuration Table does not exist that the time the DXE Core is\r
- launched, the DXE Core uses a global variable from the DXE Core Entry Point Library\r
- to manage the pointer to the HOB list.\r
-\r
- If the pointer to the HOB list is NULL, then ASSERT().\r
-\r
- @return The pointer to the HOB list.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetHobList (\r
- VOID\r
- )\r
-{\r
- EFI_STATUS Status;\r
- VOID *HobList;\r
-\r
- Status = PeiServicesGetHobList (&HobList);\r
- ASSERT_EFI_ERROR (Status);\r
- ASSERT (HobList != NULL);\r
-\r
- return HobList;\r
-}\r
-\r
-/**\r
- Returns the next instance of a HOB type from the starting HOB.\r
-\r
- This function searches the first instance of a HOB type from the starting HOB pointer.\r
- If there does not exist such HOB type from the starting HOB pointer, it will return NULL.\r
- In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer\r
- unconditionally: it returns HobStart back if HobStart itself meets the requirement;\r
- caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.\r
-\r
- If HobStart is NULL, then ASSERT().\r
-\r
- @param Type The HOB type to return.\r
- @param HobStart The starting HOB pointer to search from.\r
-\r
- @return The next instance of a HOB type from the starting HOB.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetNextHob (\r
- IN UINT16 Type,\r
- IN CONST VOID *HobStart\r
- )\r
-{\r
- EFI_PEI_HOB_POINTERS Hob;\r
-\r
- ASSERT (HobStart != NULL);\r
-\r
- Hob.Raw = (UINT8 *) HobStart;\r
- //\r
- // Parse the HOB list until end of list or matching type is found.\r
- //\r
- while (!END_OF_HOB_LIST (Hob)) {\r
- if (Hob.Header->HobType == Type) {\r
- return Hob.Raw;\r
- }\r
- Hob.Raw = GET_NEXT_HOB (Hob);\r
- }\r
- return NULL;\r
-}\r
-\r
-/**\r
- Returns the first instance of a HOB type among the whole HOB list.\r
-\r
- This function searches the first instance of a HOB type among the whole HOB list.\r
- If there does not exist such HOB type in the HOB list, it will return NULL.\r
-\r
- If the pointer to the HOB list is NULL, then ASSERT().\r
-\r
- @param Type The HOB type to return.\r
-\r
- @return The next instance of a HOB type from the starting HOB.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetFirstHob (\r
- IN UINT16 Type\r
- )\r
-{\r
- VOID *HobList;\r
-\r
- HobList = GetHobList ();\r
- return GetNextHob (Type, HobList);\r
-}\r
-\r
-/**\r
- Returns the next instance of the matched GUID HOB from the starting HOB.\r
-\r
- This function searches the first instance of a HOB from the starting HOB pointer.\r
- Such HOB should satisfy two conditions:\r
- its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r
- If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r
- Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
- to extract the data section and its size info respectively.\r
- In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer\r
- unconditionally: it returns HobStart back if HobStart itself meets the requirement;\r
- caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.\r
-\r
- If Guid is NULL, then ASSERT().\r
- If HobStart is NULL, then ASSERT().\r
-\r
- @param Guid The GUID to match with in the HOB list.\r
- @param HobStart A pointer to a Guid.\r
-\r
- @return The next instance of the matched GUID HOB from the starting HOB.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetNextGuidHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN CONST VOID *HobStart\r
- )\r
-{\r
- EFI_PEI_HOB_POINTERS GuidHob;\r
-\r
- GuidHob.Raw = (UINT8 *) HobStart;\r
- while ((GuidHob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GuidHob.Raw)) != NULL) {\r
- if (CompareGuid (Guid, &GuidHob.Guid->Name)) {\r
- break;\r
- }\r
- GuidHob.Raw = GET_NEXT_HOB (GuidHob);\r
- }\r
- return GuidHob.Raw;\r
-}\r
-\r
-/**\r
- Returns the first instance of the matched GUID HOB among the whole HOB list.\r
-\r
- This function searches the first instance of a HOB among the whole HOB list.\r
- Such HOB should satisfy two conditions:\r
- its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.\r
- If there does not exist such HOB from the starting HOB pointer, it will return NULL.\r
- Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
- to extract the data section and its size info respectively.\r
-\r
- If the pointer to the HOB list is NULL, then ASSERT().\r
- If Guid is NULL, then ASSERT().\r
-\r
- @param Guid The GUID to match with in the HOB list.\r
-\r
- @return The first instance of the matched GUID HOB among the whole HOB list.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-GetFirstGuidHob (\r
- IN CONST EFI_GUID *Guid\r
- )\r
-{\r
- VOID *HobList;\r
-\r
- HobList = GetHobList ();\r
- return GetNextGuidHob (Guid, HobList);\r
-}\r
-\r
-/**\r
- Get the system boot mode from the HOB list.\r
-\r
- This function returns the system boot mode information from the\r
- PHIT HOB in HOB list.\r
-\r
- If the pointer to the HOB list is NULL, then ASSERT().\r
-\r
- @param VOID\r
-\r
- @return The Boot Mode.\r
-\r
-**/\r
-EFI_BOOT_MODE\r
-EFIAPI\r
-GetBootModeHob (\r
- VOID\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EFI_BOOT_MODE BootMode;\r
-\r
- Status = PeiServicesGetBootMode (&BootMode);\r
- ASSERT_EFI_ERROR (Status);\r
-\r
- return BootMode;\r
-}\r
-\r
-/**\r
- Adds a new HOB to the HOB List.\r
-\r
- This internal function enables PEIMs to create various types of HOBs.\r
-\r
- @param Type Type of the new HOB.\r
- @param Length Length of the new HOB to allocate.\r
-\r
- @retval NULL The HOB could not be allocated.\r
- @retval others The address of new HOB.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-InternalPeiCreateHob (\r
- IN UINT16 Type,\r
- IN UINT16 Length\r
- )\r
-{\r
- EFI_STATUS Status;\r
- VOID *Hob;\r
-\r
- Status = PeiServicesCreateHob (Type, Length, &Hob);\r
- if (EFI_ERROR (Status)) {\r
- Hob = NULL;\r
- }\r
- //\r
- // Assume the process of HOB building is always successful.\r
- //\r
- ASSERT (Hob != NULL);\r
- return Hob;\r
-}\r
-\r
-/**\r
- Builds a HOB for a loaded PE32 module.\r
-\r
- This function builds a HOB for a loaded PE32 module.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If ModuleName is NULL, then ASSERT().\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param ModuleName The GUID File Name of the module.\r
- @param MemoryAllocationModule The 64 bit physical address of the module.\r
- @param ModuleLength The length of the module in bytes.\r
- @param EntryPoint The 64 bit physical address of the module entry point.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildModuleHob (\r
- IN CONST EFI_GUID *ModuleName,\r
- IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule,\r
- IN UINT64 ModuleLength,\r
- IN EFI_PHYSICAL_ADDRESS EntryPoint\r
- )\r
-{\r
- EFI_HOB_MEMORY_ALLOCATION_MODULE *Hob;\r
-\r
- ASSERT (((MemoryAllocationModule & (EFI_PAGE_SIZE - 1)) == 0) &&\r
- ((ModuleLength & (EFI_PAGE_SIZE - 1)) == 0));\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- CopyGuid (&(Hob->MemoryAllocationHeader.Name), &gEfiHobMemoryAllocModuleGuid);\r
- Hob->MemoryAllocationHeader.MemoryBaseAddress = MemoryAllocationModule;\r
- Hob->MemoryAllocationHeader.MemoryLength = ModuleLength;\r
- Hob->MemoryAllocationHeader.MemoryType = EfiBootServicesCode;\r
-\r
- //\r
- // Zero the reserved space to match HOB spec\r
- //\r
- ZeroMem (Hob->MemoryAllocationHeader.Reserved, sizeof (Hob->MemoryAllocationHeader.Reserved));\r
-\r
- CopyGuid (&Hob->ModuleName, ModuleName);\r
- Hob->EntryPoint = EntryPoint;\r
-}\r
-\r
-/**\r
- Builds a HOB that describes a chunk of system memory with Owner GUID.\r
-\r
- This function builds a HOB that describes a chunk of system memory.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param ResourceType The type of resource described by this HOB.\r
- @param ResourceAttribute The resource attributes of the memory described by this HOB.\r
- @param PhysicalStart The 64 bit physical address of memory described by this HOB.\r
- @param NumberOfBytes The length of the memory described by this HOB in bytes.\r
- @param OwnerGUID GUID for the owner of this resource.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildResourceDescriptorWithOwnerHob (\r
- IN EFI_RESOURCE_TYPE ResourceType,\r
- IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,\r
- IN EFI_PHYSICAL_ADDRESS PhysicalStart,\r
- IN UINT64 NumberOfBytes,\r
- IN EFI_GUID *OwnerGUID\r
- )\r
-{\r
- EFI_HOB_RESOURCE_DESCRIPTOR *Hob;\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, (UINT16) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->ResourceType = ResourceType;\r
- Hob->ResourceAttribute = ResourceAttribute;\r
- Hob->PhysicalStart = PhysicalStart;\r
- Hob->ResourceLength = NumberOfBytes;\r
-\r
- CopyGuid (&Hob->Owner, OwnerGUID);\r
-}\r
-\r
-/**\r
- Builds a HOB that describes a chunk of system memory.\r
-\r
- This function builds a HOB that describes a chunk of system memory.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param ResourceType The type of resource described by this HOB.\r
- @param ResourceAttribute The resource attributes of the memory described by this HOB.\r
- @param PhysicalStart The 64 bit physical address of memory described by this HOB.\r
- @param NumberOfBytes The length of the memory described by this HOB in bytes.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildResourceDescriptorHob (\r
- IN EFI_RESOURCE_TYPE ResourceType,\r
- IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute,\r
- IN EFI_PHYSICAL_ADDRESS PhysicalStart,\r
- IN UINT64 NumberOfBytes\r
- )\r
-{\r
- EFI_HOB_RESOURCE_DESCRIPTOR *Hob;\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, (UINT16) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->ResourceType = ResourceType;\r
- Hob->ResourceAttribute = ResourceAttribute;\r
- Hob->PhysicalStart = PhysicalStart;\r
- Hob->ResourceLength = NumberOfBytes;\r
- ZeroMem (&(Hob->Owner), sizeof (EFI_GUID));\r
-}\r
-\r
-/**\r
- Builds a customized HOB tagged with a GUID for identification and returns\r
- the start address of GUID HOB data.\r
-\r
- This function builds a customized HOB tagged with a GUID for identification\r
- and returns the start address of GUID HOB data so that caller can fill the customized data.\r
- The HOB Header and Name field is already stripped.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If Guid is NULL, then ASSERT().\r
- If there is no additional space for HOB creation, then ASSERT().\r
- If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
-\r
- @param Guid The GUID to tag the customized HOB.\r
- @param DataLength The size of the data payload for the GUID HOB.\r
-\r
- @retval NULL The GUID HOB could not be allocated.\r
- @retval others The start address of GUID HOB data.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-BuildGuidHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN DataLength\r
- )\r
-{\r
- EFI_HOB_GUID_TYPE *Hob;\r
-\r
- //\r
- // Make sure Guid is valid\r
- //\r
- ASSERT (Guid != NULL);\r
-\r
- //\r
- // Make sure that data length is not too long.\r
- //\r
- ASSERT (DataLength <= (0xffff - sizeof (EFI_HOB_GUID_TYPE)));\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_GUID_EXTENSION, (UINT16) (sizeof (EFI_HOB_GUID_TYPE) + DataLength));\r
- if (Hob == NULL) {\r
- return Hob;\r
- }\r
- CopyGuid (&Hob->Name, Guid);\r
- return Hob + 1;\r
-}\r
-\r
-/**\r
- Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB\r
- data field, and returns the start address of the GUID HOB data.\r
-\r
- This function builds a customized HOB tagged with a GUID for identification and copies the input\r
- data to the HOB data field and returns the start address of the GUID HOB data. It can only be\r
- invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
- The HOB Header and Name field is already stripped.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If Guid is NULL, then ASSERT().\r
- If Data is NULL and DataLength > 0, then ASSERT().\r
- If there is no additional space for HOB creation, then ASSERT().\r
- If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
-\r
- @param Guid The GUID to tag the customized HOB.\r
- @param Data The data to be copied into the data field of the GUID HOB.\r
- @param DataLength The size of the data payload for the GUID HOB.\r
-\r
- @retval NULL The GUID HOB could not be allocated.\r
- @retval others The start address of GUID HOB data.\r
-\r
-**/\r
-VOID *\r
-EFIAPI\r
-BuildGuidDataHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN VOID *Data,\r
- IN UINTN DataLength\r
- )\r
-{\r
- VOID *HobData;\r
-\r
- ASSERT (Data != NULL || DataLength == 0);\r
-\r
- HobData = BuildGuidHob (Guid, DataLength);\r
- if (HobData == NULL) {\r
- return HobData;\r
- }\r
-\r
- return CopyMem (HobData, Data, DataLength);\r
-}\r
-\r
-/**\r
- Check FV alignment.\r
-\r
- @param BaseAddress The base address of the Firmware Volume.\r
- @param Length The size of the Firmware Volume in bytes.\r
-\r
- @retval TRUE FvImage buffer is at its required alignment.\r
- @retval FALSE FvImage buffer is not at its required alignment.\r
-\r
-**/\r
-BOOLEAN\r
-InternalCheckFvAlignment (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
- )\r
-{\r
- EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r
- UINT32 FvAlignment;\r
-\r
- FvAlignment = 0;\r
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) (UINTN) BaseAddress;\r
-\r
- //\r
- // If EFI_FVB2_WEAK_ALIGNMENT is set in the volume header then the first byte of the volume\r
- // can be aligned on any power-of-two boundary. A weakly aligned volume can not be moved from\r
- // its initial linked location and maintain its alignment.\r
- //\r
- if ((FwVolHeader->Attributes & EFI_FVB2_WEAK_ALIGNMENT) != EFI_FVB2_WEAK_ALIGNMENT) {\r
- //\r
- // Get FvHeader alignment\r
- //\r
- FvAlignment = 1 << ((FwVolHeader->Attributes & EFI_FVB2_ALIGNMENT) >> 16);\r
- //\r
- // FvAlignment must be greater than or equal to 8 bytes of the minimum FFS alignment value.\r
- //\r
- if (FvAlignment < 8) {\r
- FvAlignment = 8;\r
- }\r
- if ((UINTN)BaseAddress % FvAlignment != 0) {\r
- //\r
- // FvImage buffer is not at its required alignment.\r
- //\r
- DEBUG ((\r
- DEBUG_ERROR,\r
- "Unaligned FvImage found at 0x%lx:0x%lx, the required alignment is 0x%x\n",\r
- BaseAddress,\r
- Length,\r
- FvAlignment\r
- ));\r
- return FALSE;\r
- }\r
- }\r
-\r
- return TRUE;\r
-}\r
-\r
-/**\r
- Builds a Firmware Volume HOB.\r
-\r
- This function builds a Firmware Volume HOB.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
- If the FvImage buffer is not at its required alignment, then ASSERT().\r
-\r
- @param BaseAddress The base address of the Firmware Volume.\r
- @param Length The size of the Firmware Volume in bytes.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildFvHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
- )\r
-{\r
- EFI_HOB_FIRMWARE_VOLUME *Hob;\r
-\r
- if (!InternalCheckFvAlignment (BaseAddress, Length)) {\r
- ASSERT (FALSE);\r
- return;\r
- }\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->BaseAddress = BaseAddress;\r
- Hob->Length = Length;\r
-}\r
-\r
-/**\r
- Builds a EFI_HOB_TYPE_FV2 HOB.\r
-\r
- This function builds a EFI_HOB_TYPE_FV2 HOB.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
- If the FvImage buffer is not at its required alignment, then ASSERT().\r
-\r
- @param BaseAddress The base address of the Firmware Volume.\r
- @param Length The size of the Firmware Volume in bytes.\r
- @param FvName The name of the Firmware Volume.\r
- @param FileName The name of the file.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildFv2Hob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN CONST EFI_GUID *FvName,\r
- IN CONST EFI_GUID *FileName\r
- )\r
-{\r
- EFI_HOB_FIRMWARE_VOLUME2 *Hob;\r
-\r
- if (!InternalCheckFvAlignment (BaseAddress, Length)) {\r
- ASSERT (FALSE);\r
- return;\r
- }\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV2, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME2));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->BaseAddress = BaseAddress;\r
- Hob->Length = Length;\r
- CopyGuid (&Hob->FvName, FvName);\r
- CopyGuid (&Hob->FileName, FileName);\r
-}\r
-\r
-/**\r
- Builds a EFI_HOB_TYPE_FV3 HOB.\r
-\r
- This function builds a EFI_HOB_TYPE_FV3 HOB.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
- If the FvImage buffer is not at its required alignment, then ASSERT().\r
-\r
- @param BaseAddress The base address of the Firmware Volume.\r
- @param Length The size of the Firmware Volume in bytes.\r
- @param AuthenticationStatus The authentication status.\r
- @param ExtractedFv TRUE if the FV was extracted as a file within\r
- another firmware volume. FALSE otherwise.\r
- @param FvName The name of the Firmware Volume.\r
- Valid only if IsExtractedFv is TRUE.\r
- @param FileName The name of the file.\r
- Valid only if IsExtractedFv is TRUE.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildFv3Hob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN UINT32 AuthenticationStatus,\r
- IN BOOLEAN ExtractedFv,\r
- IN CONST EFI_GUID *FvName, OPTIONAL\r
- IN CONST EFI_GUID *FileName OPTIONAL\r
- )\r
-{\r
- EFI_HOB_FIRMWARE_VOLUME3 *Hob;\r
-\r
- if (!InternalCheckFvAlignment (BaseAddress, Length)) {\r
- ASSERT (FALSE);\r
- return;\r
- }\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV3, (UINT16) sizeof (EFI_HOB_FIRMWARE_VOLUME3));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->BaseAddress = BaseAddress;\r
- Hob->Length = Length;\r
- Hob->AuthenticationStatus = AuthenticationStatus;\r
- Hob->ExtractedFv = ExtractedFv;\r
- if (ExtractedFv) {\r
- CopyGuid (&Hob->FvName, FvName);\r
- CopyGuid (&Hob->FileName, FileName);\r
- }\r
-}\r
-\r
-/**\r
- Builds a Capsule Volume HOB.\r
-\r
- This function builds a Capsule Volume HOB.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If the platform does not support Capsule Volume HOBs, then ASSERT().\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param BaseAddress The base address of the Capsule Volume.\r
- @param Length The size of the Capsule Volume in bytes.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildCvHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
- )\r
-{\r
- EFI_HOB_CAPSULE_VOLUME *Hob;\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CV, (UINT16) sizeof (EFI_HOB_CAPSULE_VOLUME));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->BaseAddress = BaseAddress;\r
- Hob->Length = Length;\r
-}\r
-\r
-/**\r
- Builds a HOB for the CPU.\r
-\r
- This function builds a HOB for the CPU.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param SizeOfMemorySpace The maximum physical memory addressability of the processor.\r
- @param SizeOfIoSpace The maximum physical I/O addressability of the processor.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildCpuHob (\r
- IN UINT8 SizeOfMemorySpace,\r
- IN UINT8 SizeOfIoSpace\r
- )\r
-{\r
- EFI_HOB_CPU *Hob;\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CPU, (UINT16) sizeof (EFI_HOB_CPU));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- Hob->SizeOfMemorySpace = SizeOfMemorySpace;\r
- Hob->SizeOfIoSpace = SizeOfIoSpace;\r
-\r
- //\r
- // Zero the reserved space to match HOB spec\r
- //\r
- ZeroMem (Hob->Reserved, sizeof (Hob->Reserved));\r
-}\r
-\r
-/**\r
- Builds a HOB for the Stack.\r
-\r
- This function builds a HOB for the stack.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param BaseAddress The 64 bit physical address of the Stack.\r
- @param Length The length of the stack in bytes.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildStackHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
- )\r
-{\r
- EFI_HOB_MEMORY_ALLOCATION_STACK *Hob;\r
-\r
- ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
- ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocStackGuid);\r
- Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
- Hob->AllocDescriptor.MemoryLength = Length;\r
- Hob->AllocDescriptor.MemoryType = EfiBootServicesData;\r
-\r
- //\r
- // Zero the reserved space to match HOB spec\r
- //\r
- ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
-}\r
-\r
-/**\r
- Builds a HOB for the BSP store.\r
-\r
- This function builds a HOB for BSP store.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param BaseAddress The 64 bit physical address of the BSP.\r
- @param Length The length of the BSP store in bytes.\r
- @param MemoryType Type of memory allocated by this HOB.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildBspStoreHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN EFI_MEMORY_TYPE MemoryType\r
- )\r
-{\r
- EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *Hob;\r
-\r
- ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
- ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocBspStoreGuid);\r
- Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
- Hob->AllocDescriptor.MemoryLength = Length;\r
- Hob->AllocDescriptor.MemoryType = MemoryType;\r
-\r
- //\r
- // Zero the reserved space to match HOB spec\r
- //\r
- ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
-}\r
-\r
-/**\r
- Builds a HOB for the memory allocation.\r
-\r
- This function builds a HOB for the memory allocation.\r
- It can only be invoked during PEI phase;\r
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.\r
-\r
- If there is no additional space for HOB creation, then ASSERT().\r
-\r
- @param BaseAddress The 64 bit physical address of the memory.\r
- @param Length The length of the memory allocation in bytes.\r
- @param MemoryType Type of memory allocated by this HOB.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-BuildMemoryAllocationHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN EFI_MEMORY_TYPE MemoryType\r
- )\r
-{\r
- EFI_HOB_MEMORY_ALLOCATION *Hob;\r
-\r
- ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
- ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
-\r
- Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, (UINT16) sizeof (EFI_HOB_MEMORY_ALLOCATION));\r
- if (Hob == NULL) {\r
- return;\r
- }\r
-\r
- ZeroMem (&(Hob->AllocDescriptor.Name), sizeof (EFI_GUID));\r
- Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
- Hob->AllocDescriptor.MemoryLength = Length;\r
- Hob->AllocDescriptor.MemoryType = MemoryType;\r
- //\r
- // Zero the reserved space to match HOB spec\r
- //\r
- ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
-}\r