MdePkg/Library/PeiHobLib/HobLib.c File Reference


Functions

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 InternalPeiCreateHob (IN UINT16 Type, IN UINT16 Length)
VOID EFIAPI BuildModuleHob (IN CONST EFI_GUID *ModuleName, IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule, IN UINT64 ModuleLength, IN EFI_PHYSICAL_ADDRESS EntryPoint)
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 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 BuildCvHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length)
VOID EFIAPI BuildCpuHob (IN UINT8 SizeOfMemorySpace, IN UINT8 SizeOfIoSpace)
VOID EFIAPI BuildStackHob (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 BuildMemoryAllocationHob (IN EFI_PHYSICAL_ADDRESS BaseAddress, IN UINT64 Length, IN EFI_MEMORY_TYPE MemoryType)

Detailed Description

Provide Hob Library functions for Pei phase.

Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

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. 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().

Parameters:
BaseAddress The 64 bit physical address of the BSP.
Length The length of the BSP store in bytes.
MemoryType The type of memory allocated by this HOB.

References EFI_HOB_MEMORY_ALLOCATION_BSP_STORE::AllocDescriptor, ASSERT, CopyGuid(), EFI_HOB_TYPE_MEMORY_ALLOCATION, EFI_PAGE_SIZE, gEfiHobMemoryAllocBspStoreGuid, InternalPeiCreateHob(), EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryBaseAddress, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryLength, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryType, EFI_HOB_MEMORY_ALLOCATION_HEADER::Name, NULL, EFI_HOB_MEMORY_ALLOCATION_HEADER::Reserved, and ZeroMem().

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 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().

Parameters:
SizeOfMemorySpace The maximum physical memory addressability of the processor.
SizeOfIoSpace The maximum physical I/O addressability of the processor.

References EFI_HOB_TYPE_CPU, InternalPeiCreateHob(), NULL, EFI_HOB_CPU::Reserved, EFI_HOB_CPU::SizeOfIoSpace, EFI_HOB_CPU::SizeOfMemorySpace, and ZeroMem().

VOID EFIAPI BuildCvHob ( IN EFI_PHYSICAL_ADDRESS  BaseAddress,
IN UINT64  Length 
)

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().

Parameters:
BaseAddress The base address of the Capsule Volume.
Length The size of the Capsule Volume in bytes.

References EFI_HOB_UEFI_CAPSULE::BaseAddress, EFI_HOB_TYPE_UEFI_CAPSULE, InternalPeiCreateHob(), EFI_HOB_UEFI_CAPSULE::Length, and NULL.

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 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().

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.

References EFI_HOB_FIRMWARE_VOLUME2::BaseAddress, CopyGuid(), EFI_HOB_TYPE_FV2, EFI_HOB_FIRMWARE_VOLUME2::FileName, EFI_HOB_FIRMWARE_VOLUME2::FvName, InternalPeiCreateHob(), EFI_HOB_FIRMWARE_VOLUME2::Length, and NULL.

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 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().

Parameters:
BaseAddress The base address of the Firmware Volume.
Length The size of the Firmware Volume in bytes.

References EFI_HOB_FIRMWARE_VOLUME::BaseAddress, EFI_HOB_TYPE_FV, InternalPeiCreateHob(), EFI_HOB_FIRMWARE_VOLUME::Length, and NULL.

VOID* EFIAPI BuildGuidDataHob ( IN CONST EFI_GUID Guid,
IN VOID *  Data,
IN UINTN  DataLength 
)

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.

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.
Return values:
NULL The GUID HOB could not be allocated.
others The start address of GUID HOB data.

References ASSERT, BuildGuidHob(), CopyMem(), NULL, and VOID.

Referenced by ExtractGuidedSectionRegisterHandlers().

VOID* EFIAPI BuildGuidHob ( IN CONST EFI_GUID Guid,
IN UINTN  DataLength 
)

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.

Parameters:
Guid The GUID to tag the customized HOB.
DataLength The size of the data payload for the GUID HOB.
Return values:
NULL The GUID HOB could not be allocated.
others The start address of GUID HOB data.

References ASSERT, CopyGuid(), EFI_HOB_TYPE_GUID_EXTENSION, InternalPeiCreateHob(), EFI_HOB_GUID_TYPE::Name, and NULL.

Referenced by BuildGuidDataHob(), and PeiGetExtractGuidedSectionHandlerInfo().

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 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().

Parameters:
BaseAddress The 64 bit physical address of the memory.
Length The length of the memory allocation in bytes.
MemoryType The type of memory allocated by this HOB.

References EFI_HOB_MEMORY_ALLOCATION::AllocDescriptor, ASSERT, EFI_HOB_TYPE_MEMORY_ALLOCATION, EFI_PAGE_SIZE, InternalPeiCreateHob(), EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryBaseAddress, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryLength, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryType, EFI_HOB_MEMORY_ALLOCATION_HEADER::Name, NULL, EFI_HOB_MEMORY_ALLOCATION_HEADER::Reserved, and ZeroMem().

Referenced by InternalAllocateAlignedPages().

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 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().

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.

References ASSERT, CopyGuid(), EFI_HOB_TYPE_MEMORY_ALLOCATION, EFI_PAGE_SIZE, EfiBootServicesCode, EFI_HOB_MEMORY_ALLOCATION_MODULE::EntryPoint, gEfiHobMemoryAllocModuleGuid, InternalPeiCreateHob(), EFI_HOB_MEMORY_ALLOCATION_MODULE::MemoryAllocationHeader, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryBaseAddress, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryLength, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryType, EFI_HOB_MEMORY_ALLOCATION_MODULE::ModuleName, EFI_HOB_MEMORY_ALLOCATION_HEADER::Name, NULL, EFI_HOB_MEMORY_ALLOCATION_HEADER::Reserved, and ZeroMem().

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 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().

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.

References EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, InternalPeiCreateHob(), NULL, EFI_HOB_RESOURCE_DESCRIPTOR::Owner, EFI_HOB_RESOURCE_DESCRIPTOR::PhysicalStart, EFI_HOB_RESOURCE_DESCRIPTOR::ResourceAttribute, EFI_HOB_RESOURCE_DESCRIPTOR::ResourceLength, EFI_HOB_RESOURCE_DESCRIPTOR::ResourceType, and ZeroMem().

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. 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().

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.

References CopyGuid(), EFI_HOB_TYPE_RESOURCE_DESCRIPTOR, InternalPeiCreateHob(), NULL, EFI_HOB_RESOURCE_DESCRIPTOR::Owner, EFI_HOB_RESOURCE_DESCRIPTOR::PhysicalStart, EFI_HOB_RESOURCE_DESCRIPTOR::ResourceAttribute, EFI_HOB_RESOURCE_DESCRIPTOR::ResourceLength, and EFI_HOB_RESOURCE_DESCRIPTOR::ResourceType.

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. 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().

Parameters:
BaseAddress The 64 bit physical address of the Stack.
Length The length of the stack in bytes.

References EFI_HOB_MEMORY_ALLOCATION_STACK::AllocDescriptor, ASSERT, CopyGuid(), EFI_HOB_TYPE_MEMORY_ALLOCATION, EFI_PAGE_SIZE, EfiBootServicesData, gEfiHobMemoryAllocStackGuid, InternalPeiCreateHob(), EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryBaseAddress, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryLength, EFI_HOB_MEMORY_ALLOCATION_HEADER::MemoryType, EFI_HOB_MEMORY_ALLOCATION_HEADER::Name, NULL, EFI_HOB_MEMORY_ALLOCATION_HEADER::Reserved, and ZeroMem().

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.

References ASSERT_EFI_ERROR, and PeiServicesGetBootMode().

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 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().

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.

References GetHobList(), GetNextGuidHob(), and VOID.

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.

References GetHobList(), GetNextHob(), and VOID.

Referenced by InternalAllocateAlignedPages(), and SmmMemLibInternalCalculateMaximumSupportAddress().

VOID* EFIAPI GetHobList ( VOID   ) 

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().

Returns:
The pointer to the HOB list.

References ASSERT, ASSERT_EFI_ERROR, NULL, PeiServicesGetHobList(), and VOID.

Referenced by GetBootModeHob(), GetFirstGuidHob(), GetFirstHob(), and PeiGetExtractGuidedSectionHandlerInfo().

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 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().

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.

References CompareGuid(), EFI_HOB_TYPE_GUID_EXTENSION, GET_NEXT_HOB, GetNextHob(), EFI_PEI_HOB_POINTERS::Guid, EFI_HOB_GUID_TYPE::Name, NULL, and EFI_PEI_HOB_POINTERS::Raw.

Referenced by GetFirstGuidHob().

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.

References ASSERT, END_OF_HOB_LIST, GET_NEXT_HOB, EFI_PEI_HOB_POINTERS::Header, EFI_HOB_GENERIC_HEADER::HobType, NULL, and EFI_PEI_HOB_POINTERS::Raw.

Referenced by GetFirstHob(), GetNextGuidHob(), InternalAllocateAlignedPages(), and PeiGetExtractGuidedSectionHandlerInfo().

VOID* EFIAPI InternalPeiCreateHob ( IN UINT16  Type,
IN UINT16  Length 
)

Adds a new HOB to the HOB List.

This internal function enables PEIMs to create various types of HOBs.

Parameters:
Type Type of the new HOB.
Length Length of the new HOB to allocate.
Return values:
NULL The HOB could not be allocated.
others The address of new HOB.

References ASSERT, EFI_ERROR, NULL, PeiServicesCreateHob(), and VOID.

Referenced by BuildBspStoreHob(), BuildCpuHob(), BuildCvHob(), BuildFv2Hob(), BuildFvHob(), BuildGuidHob(), BuildMemoryAllocationHob(), BuildModuleHob(), BuildResourceDescriptorHob(), BuildResourceDescriptorWithOwnerHob(), and BuildStackHob().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1