/** @file\r
HOB Library implementation for DxeCore driver.\r
\r
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\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
+ 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
+ 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
+\r
If the pointer to the HOB list is NULL, then ASSERT().\r
- \r
+\r
@return The pointer to the HOB list.\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
+ 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
+\r
If HobStart is NULL, then ASSERT().\r
\r
@param Type The HOB type to return.\r
VOID *\r
EFIAPI\r
GetNextHob (\r
- IN UINT16 Type,\r
- IN CONST VOID *HobStart\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
+ Hob.Raw = (UINT8 *)HobStart;\r
//\r
// Parse the HOB list until end of list or matching type is found.\r
//\r
if (Hob.Header->HobType == Type) {\r
return Hob.Raw;\r
}\r
+\r
Hob.Raw = GET_NEXT_HOB (Hob);\r
}\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
+ 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
VOID *\r
EFIAPI\r
GetFirstHob (\r
- IN UINT16 Type\r
+ IN UINT16 Type\r
)\r
{\r
- VOID *HobList;\r
+ VOID *HobList;\r
\r
HobList = GetHobList ();\r
return GetNextHob (Type, HobList);\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 such a HOB from the starting HOB pointer does not exist, it will return NULL. \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 such a HOB from the starting HOB pointer does not exist, 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 information, 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
+\r
If Guid is NULL, then ASSERT().\r
If HobStart is NULL, then ASSERT().\r
\r
VOID *\r
EFIAPI\r
GetNextGuidHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN CONST VOID *HobStart\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
+ 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
+\r
GuidHob.Raw = GET_NEXT_HOB (GuidHob);\r
}\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
+\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 such a HOB from the starting HOB pointer does not exist, 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 information, respectively.\r
- \r
+\r
If the pointer to the HOB list is NULL, then ASSERT().\r
If Guid is NULL, then ASSERT().\r
\r
VOID *\r
EFIAPI\r
GetFirstGuidHob (\r
- IN CONST EFI_GUID *Guid\r
+ IN CONST EFI_GUID *Guid\r
)\r
{\r
- VOID *HobList;\r
+ VOID *HobList;\r
\r
HobList = GetHobList ();\r
return GetNextGuidHob (Guid, HobList);\r
/**\r
Get the system boot mode from the HOB list.\r
\r
- This function returns the system boot mode information from the \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
+\r
@param VOID\r
\r
@return The Boot Mode.\r
VOID\r
)\r
{\r
- EFI_HOB_HANDOFF_INFO_TABLE *HandOffHob;\r
+ EFI_HOB_HANDOFF_INFO_TABLE *HandOffHob;\r
\r
- HandOffHob = (EFI_HOB_HANDOFF_INFO_TABLE *) GetHobList ();\r
+ HandOffHob = (EFI_HOB_HANDOFF_INFO_TABLE *)GetHobList ();\r
\r
- return HandOffHob->BootMode;\r
+ return HandOffHob->BootMode;\r
}\r
\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() because PEI HOB is read-only for DXE phase.\r
- \r
+\r
If ModuleName is NULL, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\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
+ IN CONST EFI_GUID *ModuleName,\r
+ IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule,\r
+ IN UINT64 ModuleLength,\r
+ IN EFI_PHYSICAL_ADDRESS EntryPoint\r
)\r
{\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
+\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
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() because PEI HOB is read-only for DXE phase.\r
- \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
}\r
\r
/**\r
- Builds a customized HOB tagged with a GUID for identification and returns \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
+ 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() because PEI HOB is read-only for DXE phase.\r
- \r
+\r
If Guid is NULL, then ASSERT().\r
If there is no additional space for HOB creation, then ASSERT().\r
If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
VOID *\r
EFIAPI\r
BuildGuidHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN UINTN DataLength\r
+ IN CONST EFI_GUID *Guid,\r
+ IN UINTN DataLength\r
)\r
{\r
//\r
}\r
\r
/**\r
- Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB \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() because PEI HOB is read-only for DXE phase. \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() because 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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID *\r
EFIAPI\r
BuildGuidDataHob (\r
- IN CONST EFI_GUID *Guid,\r
- IN VOID *Data,\r
- IN UINTN DataLength\r
+ IN CONST EFI_GUID *Guid,\r
+ IN VOID *Data,\r
+ IN UINTN DataLength\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildFvHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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 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
**/\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
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length,\r
+ IN CONST EFI_GUID *FvName,\r
+ IN CONST EFI_GUID *FileName\r
+ )\r
+{\r
+ ASSERT (FALSE);\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
ASSERT (FALSE);\r
This function builds a Capsule Volume HOB.\r
It can only be invoked during PEI phase;\r
for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildCvHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildCpuHob (\r
- IN UINT8 SizeOfMemorySpace,\r
- IN UINT8 SizeOfIoSpace\r
+ IN UINT8 SizeOfMemorySpace,\r
+ IN UINT8 SizeOfIoSpace\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildStackHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildBspStoreHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN EFI_MEMORY_TYPE MemoryType\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length,\r
+ IN EFI_MEMORY_TYPE MemoryType\r
)\r
{\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() because PEI HOB is read-only for DXE phase.\r
- \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
VOID\r
EFIAPI\r
BuildMemoryAllocationHob (\r
- IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
- IN UINT64 Length,\r
- IN EFI_MEMORY_TYPE MemoryType\r
+ IN EFI_PHYSICAL_ADDRESS BaseAddress,\r
+ IN UINT64 Length,\r
+ IN EFI_MEMORY_TYPE MemoryType\r
)\r
{\r
//\r
projects / mirror_edk2.git / blobdiff