Initial import.

[mirror_edk2.git] / MdePkg / Include / Library / HobLib.h

/** @file\r
	Public include file for the HOB Library\r
\r
	Copyright (c) 2006, Intel Corporation                                                         \r
	All rights reserved. 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
\r
	Module Name:	HobLib.h\r
\r
**/\r
\r
#ifndef __HOB_LIB_H__\r
#define __HOB_LIB_H__\r
\r
/**\r
	Returns the pointer to the HOB list.\r
\r
	@return The pointer to the HOB list.\r
\r
**/\r
VOID *\r
EFIAPI\r
GetHobList (\r
  VOID\r
  )\r
;\r
\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
\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
\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
	@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
\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
\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
\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
\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
\r
/**\r
	This function builds a HOB for a loaded PE32 module.\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