HobParserLib.h File Reference

Go to the source code of this file.

Functions
VOID	AddNewHob (IN EFI_PEI_HOB_POINTERS *Hob)
EFI_HOB_RESOURCE_DESCRIPTOR *	FindResourceDescriptorByRange (IN VOID *HobList, IN EFI_PHYSICAL_ADDRESS Base, IN EFI_PHYSICAL_ADDRESS Top)
EFI_HOB_RESOURCE_DESCRIPTOR *	FindAnotherHighestBelow4GResourceDescriptor (IN VOID *HobList, IN UINTN MinimalNeededSize, IN EFI_HOB_RESOURCE_DESCRIPTOR *ExceptResourceHob)
BOOLEAN	IsHobNeed (EFI_PEI_HOB_POINTERS Hob)

Detailed Description

This library will provide services for handling HOB data.

Copyright (c) 2024, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file HobParserLib.h.

Function Documentation

AddNewHob()

VOID AddNewHob

(

IN EFI_PEI_HOB_POINTERS *

Hob

)

Add HOB into HOB list

Parameters

[in]

Hob

The HOB to be added into the HOB list.

Definition at line 101 of file HobParseLib.c.

FindAnotherHighestBelow4GResourceDescriptor()

EFI_HOB_RESOURCE_DESCRIPTOR * FindAnotherHighestBelow4GResourceDescriptor	(	IN VOID *	HobList,
		IN UINTN	MinimalNeededSize,
		IN EFI_HOB_RESOURCE_DESCRIPTOR *	ExceptResourceHob
	)

Find the highest below 4G memory resource descriptor, except the input Resource Descriptor.

Parameters

[in]	HobList	Hob start address
[in]	MinimalNeededSize	Minimal needed size.
[in]	ExceptResourceHob	Ignore this Resource Descriptor.

Return values

The	pointer to the Resource Descriptor HOB.

Definition at line 184 of file HobParseLib.c.

FindResourceDescriptorByRange()

EFI_HOB_RESOURCE_DESCRIPTOR * FindResourceDescriptorByRange	(	IN VOID *	HobList,
		IN EFI_PHYSICAL_ADDRESS	Base,
		IN EFI_PHYSICAL_ADDRESS	Top
	)

Found the Resource Descriptor HOB that contains a range (Base, Top)

Parameters

[in]	HobList	Hob start address
[in]	Base	Memory start address
[in]	Top	Memory end address.

Return values

The	pointer to the Resource Descriptor HOB.

Definition at line 128 of file HobParseLib.c.

IsHobNeed()

BOOLEAN IsHobNeed

(

EFI_PEI_HOB_POINTERS

Hob

)

Check the HOB and decide if it is need inside Payload

Payload maintainer may make decision which HOB is need or needn't Then add the check logic in the function.

Parameters

[in]

Hob

The HOB to check

Return values

TRUE	If HOB is need inside Payload
FALSE	If HOB is needn't inside Payload

Definition at line 264 of file HobParseLib.c.