EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions | Variables

MdePkg/Library/DxeHobLib/HobLib.c File Reference

#include <PiDxe.h>
#include <Guid/HobList.h>
#include <Library/HobLib.h>
#include <Library/UefiLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>

Go to the source code of this file.

Functions

EFI_STATUS EFIAPI HobLibConstructor (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
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 BuildModuleHob (IN CONST EFI_GUID *ModuleName, IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule, IN UINT64 ModuleLength, IN EFI_PHYSICAL_ADDRESS EntryPoint)
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)

Variables

VOID * mHobList = NULL

Detailed Description

HOB Library implemenation for Dxe Phase.

Copyright (c) 2006 - 2011, 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.

Definition in file HobLib.c.


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:
BaseAddressThe 64 bit physical address of the BSP.
LengthThe length of the BSP store in bytes.
MemoryTypeType of memory allocated by this HOB.

Definition at line 528 of file HobLib.c.

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:
SizeOfMemorySpaceThe maximum physical memory addressability of the processor.
SizeOfIoSpaceThe maximum physical I/O addressability of the processor.

Definition at line 475 of file HobLib.c.

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:
BaseAddressThe base address of the Capsule Volume.
LengthThe size of the Capsule Volume in bytes.

Definition at line 449 of file HobLib.c.

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:
BaseAddressThe base address of the Firmware Volume.
LengthThe size of the Firmware Volume in bytes.
FvNameThe name of the Firmware Volume.
FileNameThe name of the file.

Definition at line 422 of file HobLib.c.

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:
BaseAddressThe base address of the Firmware Volume.
LengthThe size of the Firmware Volume in bytes.

Definition at line 394 of file HobLib.c.

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 >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().

Parameters:
GuidThe GUID to tag the customized HOB.
DataThe data to be copied into the data field of the GUID HOB.
DataLengthThe size of the data payload for the GUID HOB.
Return values:
NULLThe GUID HOB could not be allocated.
othersThe start address of GUID HOB data.

Definition at line 366 of file HobLib.c.

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 >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().

Parameters:
GuidThe GUID to tag the customized HOB.
DataLengthThe size of the data payload for the GUID HOB.
Return values:
NULLThe GUID HOB could not be allocated.
othersThe start address of GUID HOB data.

Definition at line 328 of file HobLib.c.

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:
BaseAddressThe 64 bit physical address of the memory.
LengthThe length of the memory allocation in bytes.
MemoryTypeType of memory allocated by this HOB.

Definition at line 556 of file HobLib.c.

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:
ModuleNameThe GUID File Name of the module.
MemoryAllocationModuleThe 64 bit physical address of the module.
ModuleLengthThe length of the module in bytes.
EntryPointThe 64 bit physical address of the module entry point.

Definition at line 262 of file HobLib.c.

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:
ResourceTypeThe type of resource described by this HOB.
ResourceAttributeThe resource attributes of the memory described by this HOB.
PhysicalStartThe 64 bit physical address of memory described by this HOB.
NumberOfBytesThe length of the memory described by this HOB in bytes.

Definition at line 292 of file HobLib.c.

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:
BaseAddressThe 64 bit physical address of the Stack.
LengthThe length of the stack in bytes.

Definition at line 501 of file HobLib.c.

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.

Definition at line 233 of file HobLib.c.

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:
GuidThe GUID to match with in the HOB list.
Returns:
The first instance of the matched GUID HOB among the whole HOB list.

Definition at line 208 of file HobLib.c.

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:
TypeThe HOB type to return.
Returns:
The next instance of a HOB type from the starting HOB.

Definition at line 137 of file HobLib.c.

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.

Definition at line 73 of file HobLib.c.

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:
GuidThe GUID to match with in the HOB list.
HobStartA pointer to a Guid.
Returns:
The next instance of the matched GUID HOB from the starting HOB.

Definition at line 171 of file HobLib.c.

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:
TypeThe HOB type to return.
HobStartThe starting HOB pointer to search from.
Returns:
The next instance of a HOB type from the starting HOB.

Definition at line 100 of file HobLib.c.

EFI_STATUS EFIAPI HobLibConstructor ( IN EFI_HANDLE  ImageHandle,
IN EFI_SYSTEM_TABLE SystemTable 
)

The constructor function caches the pointer to HOB list.

The constructor function gets the start address of HOB list from system configuration table. It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.

Parameters:
ImageHandleThe firmware allocated handle for the EFI image.
SystemTableA pointer to the EFI System Table.
Return values:
EFI_SUCCESSThe constructor successfully gets HobList.
Othervalue The constructor can't get HobList.

Definition at line 41 of file HobLib.c.


Variable Documentation

VOID* mHobList = NULL

Definition at line 24 of file HobLib.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines