]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/HobLib.h
MdePkg: fix mixed dos and linux EOL format issue
[mirror_edk2.git] / MdePkg / Include / Library / HobLib.h
index cac9c4fa0907df37cadade58bd7073a426db4bc3..c6b15961714d5b71441f4a849197e0a6ef189936 100644 (file)
@@ -1,16 +1,21 @@
 /** @file\r
-       Public include file for the HOB Library\r
+  Provides services to create and parse HOBs. Only available for PEI\r
+  and DXE module types.\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
+  The HOB Library supports the efficient creation and searching of HOBs\r
+  defined in the PI Specification.\r
+  A HOB is a Hand-Off Block, defined in the Framework architecture, that\r
+  allows the PEI phase to pass information to the DXE phase. HOBs are position\r
+  independent and can be relocated easily to different memory memory locations.\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 - 2014, 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
-       Module Name:    HobLib.h\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
 **/\r
 \r
 #define __HOB_LIB_H__\r
 \r
 /**\r
-       Returns the pointer to the HOB list.\r
+  Returns the pointer to the HOB list.\r
 \r
-       @return The pointer to the HOB list.\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
+  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
+  to manage the pointer to the HOB list.\r
+\r
+  If the pointer to the HOB list is NULL, then ASSERT().\r
+\r
+  @return The pointer to the HOB list.\r
 \r
 **/\r
 VOID *\r
 EFIAPI\r
 GetHobList (\r
   VOID\r
-  )\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
+  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
+  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
+  If HobStart is NULL, then ASSERT().\r
 \r
-       @param  Type The HOB type to return.\r
-       @param  HobStart The starting HOB pointer to search from.\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
+  @return The next instance of a HOB type from the starting HOB.\r
 \r
 **/\r
 VOID *\r
@@ -45,35 +66,47 @@ EFIAPI
 GetNextHob (\r
   IN UINT16                 Type,\r
   IN CONST VOID             *HobStart\r
-  )\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
+  Returns the first instance of a HOB type among the whole HOB list.\r
 \r
-       @param  Type The HOB type to return.\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
-       @return The next instance of a HOB type from the starting HOB.\r
+  If the pointer to the HOB list is NULL, then ASSERT().\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
 /**\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
+  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 there does not exist such HOB from the starting HOB pointer, 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 info 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
-       @param  Guid The GUID to match with in the HOB list.\r
-       @param  HobStart A pointer to a Guid.\r
+  If Guid is NULL, then ASSERT().\r
+  If HobStart is NULL, then ASSERT().\r
 \r
-       @return The next instance of the matched GUID HOB from the starting HOB.\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
@@ -81,34 +114,65 @@ EFIAPI
 GetNextGuidHob (\r
   IN CONST EFI_GUID         *Guid,\r
   IN CONST VOID             *HobStart\r
-  )\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
+  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
+  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
+  Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()\r
+  to extract the data section and its size info respectively.\r
+\r
+  If the pointer to the HOB list is NULL, then ASSERT().\r
+  If Guid is NULL, then ASSERT().\r
 \r
-       @param  Guid The GUID to match with in the HOB list.\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
+  @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
+/**\r
+  Get the system boot mode from the HOB list.\r
+\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
+  @param  VOID\r
+\r
+  @return The Boot Mode.\r
+\r
+**/\r
+EFI_BOOT_MODE\r
+EFIAPI\r
+GetBootModeHob (\r
+  VOID\r
+  );\r
 \r
 /**\r
-       This function builds a HOB for a loaded PE32 module.\r
+  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
-       @param  EntryPoint The 64 bit physical address of the module\92s entry point.\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() since PEI HOB is read-only for DXE phase.\r
+\r
+  If ModuleName is NULL, then ASSERT().\r
+  If there is no additional space for HOB creation, then ASSERT().\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
+  @param  EntryPoint              The 64 bit physical address of the module entry point.\r
 \r
 **/\r
 VOID\r
@@ -118,16 +182,47 @@ BuildModuleHob (
   IN EFI_PHYSICAL_ADDRESS   MemoryAllocationModule,\r
   IN UINT64                 ModuleLength,\r
   IN EFI_PHYSICAL_ADDRESS   EntryPoint\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a HOB that describes a chunk of system memory.\r
+  Builds a HOB that describes a chunk of system memory with Owner GUID.\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
+  If there is no additional space for HOB creation, then ASSERT().\r
 \r
-       @param  ResourceType The type of resource described by this HOB.\r
-       @param  ResourceAttribute The resource attributes of the memory described by this HOB.\r
-       @param  PhysicalStart The 64 bit physical address of memory described by this HOB.\r
-       @param  NumberOfBytes The length of the memory described by this HOB in bytes.\r
+  @param  ResourceType        The type of resource described by this HOB.\r
+  @param  ResourceAttribute   The resource attributes of the memory described by this HOB.\r
+  @param  PhysicalStart       The 64 bit physical address of memory described by this HOB.\r
+  @param  NumberOfBytes       The length of the memory described by this HOB in bytes.\r
+  @param  OwnerGUID           GUID for the owner of this resource.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+BuildResourceDescriptorWithOwnerHob (\r
+  IN EFI_RESOURCE_TYPE            ResourceType,\r
+  IN EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute,\r
+  IN EFI_PHYSICAL_ADDRESS         PhysicalStart,\r
+  IN UINT64                       NumberOfBytes,\r
+  IN EFI_GUID                     *OwnerGUID\r
+  );\r
+\r
+/**\r
+  Builds a HOB that describes a chunk of system memory.\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
+  If there is no additional space for HOB creation, then ASSERT().\r
+\r
+  @param  ResourceType        The type of resource described by this HOB.\r
+  @param  ResourceAttribute   The resource attributes of the memory described by this HOB.\r
+  @param  PhysicalStart       The 64 bit physical address of memory described by this HOB.\r
+  @param  NumberOfBytes       The length of the memory described by this HOB in bytes.\r
 \r
 **/\r
 VOID\r
@@ -137,17 +232,28 @@ BuildResourceDescriptorHob (
   IN EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute,\r
   IN EFI_PHYSICAL_ADDRESS         PhysicalStart,\r
   IN UINT64                       NumberOfBytes\r
-  )\r
-;\r
+  );\r
 \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
+  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
+  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() since PEI HOB is read-only for DXE phase.\r
 \r
-       @param  Guid The GUID to tag the customized HOB.\r
-       @param  DataLength The size of the data payload for the GUID HOB.\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
+  HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
 \r
-       @return The start address of GUID HOB data.\r
+  @param  Guid          The GUID to tag the customized HOB.\r
+  @param  DataLength    The size of the data payload for the GUID HOB.\r
+\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -155,18 +261,31 @@ EFIAPI
 BuildGuidHob (\r
   IN CONST EFI_GUID              *Guid,\r
   IN UINTN                       DataLength\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       This function builds a customized HOB tagged with a GUID for identification, \r
-       copies the input data to the HOB data field, and returns the start address of GUID HOB data.\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() since 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() since PEI HOB is read-only for DXE phase.\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
+  If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\r
+  HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.\r
 \r
-       @param  Guid The GUID to tag the customized HOB.\r
-       @param  Data The data to be copied into the data field of the GUID HOB.\r
-       @param  DataLength The size of the data payload for the GUID HOB.\r
+  @param  Guid          The GUID to tag the customized HOB.\r
+  @param  Data          The data to be copied into the data field of the GUID HOB.\r
+  @param  DataLength    The size of the data payload for the GUID HOB.\r
 \r
-       @return The start address of GUID HOB data.\r
+  @retval  NULL         The GUID HOB could not be allocated.\r
+  @retval  others       The start address of GUID HOB data.\r
 \r
 **/\r
 VOID *\r
@@ -175,14 +294,19 @@ BuildGuidDataHob (
   IN CONST EFI_GUID              *Guid,\r
   IN VOID                        *Data,\r
   IN UINTN                       DataLength\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a Firmware Volume HOB.\r
+  Builds a Firmware Volume HOB.\r
 \r
-       @param  BaseAddress The base address of the Firmware Volume.\r
-       @param  Length The size of the Firmware Volume in bytes.\r
+  This function builds a Firmware Volume 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
+\r
+  @param  BaseAddress   The base address of the Firmware Volume.\r
+  @param  Length        The size of the Firmware Volume in bytes.\r
 \r
 **/\r
 VOID\r
@@ -190,14 +314,44 @@ EFIAPI
 BuildFvHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a Capsule Volume HOB.\r
+  Builds a EFI_HOB_TYPE_FV2 HOB.\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() since PEI HOB is read-only for DXE phase.\r
 \r
-       @param  BaseAddress The base address of the Capsule Volume.\r
-       @param  Length The size of the Capsule Volume in bytes.\r
+  If there is no additional space for HOB creation, 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  FvName        The name of the Firmware Volume.\r
+  @param  FileName      The name of the file.\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
+  );\r
+\r
+/**\r
+  Builds a Capsule Volume HOB.\r
+\r
+  This function builds a Capsule Volume 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 the platform does not support Capsule Volume HOBs, then ASSERT().\r
+  If there is no additional space for HOB creation, then ASSERT().\r
+\r
+  @param  BaseAddress   The base address of the Capsule Volume.\r
+  @param  Length        The size of the Capsule Volume in bytes.\r
 \r
 **/\r
 VOID\r
@@ -205,14 +359,19 @@ EFIAPI
 BuildCvHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a HOB for the CPU.\r
+  Builds a HOB for the CPU.\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() since PEI HOB is read-only for DXE phase.\r
 \r
-       @param  SizeOfMemorySpace The maximum physical memory addressability of the processor.\r
-       @param  SizeOfIoSpace The maximum physical I/O addressability of the processor.\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
+  @param  SizeOfIoSpace       The maximum physical I/O addressability of the processor.\r
 \r
 **/\r
 VOID\r
@@ -220,14 +379,19 @@ EFIAPI
 BuildCpuHob (\r
   IN UINT8                       SizeOfMemorySpace,\r
   IN UINT8                       SizeOfIoSpace\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a HOB for the Stack.\r
+  Builds a HOB for the Stack.\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() since PEI HOB is read-only for DXE phase.\r
 \r
-       @param  BaseAddress The 64 bit physical address of the Stack.\r
-       @param  Length The length of the stack in bytes.\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
+  @param  Length        The length of the stack in bytes.\r
 \r
 **/\r
 VOID\r
@@ -235,15 +399,20 @@ EFIAPI
 BuildStackHob (\r
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a HOB for the BSP store.\r
+  Builds a HOB for the BSP store.\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() since PEI HOB is read-only for DXE phase.\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
-       @param  Length The length of the BSP store in bytes.\r
-       @param  MemoryType Type of memory allocated by this HOB.\r
+  @param  BaseAddress   The 64 bit physical address of the BSP.\r
+  @param  Length        The length of the BSP store in bytes.\r
+  @param  MemoryType    Type of memory allocated by this HOB.\r
 \r
 **/\r
 VOID\r
@@ -252,15 +421,20 @@ BuildBspStoreHob (
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length,\r
   IN EFI_MEMORY_TYPE             MemoryType\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-       Builds a HOB for the memory allocation.\r
+  Builds a HOB for the memory allocation.\r
 \r
-       @param  BaseAddress The 64 bit physical address of the memory.\r
-       @param  Length The length of the memory allocation in bytes.\r
-       @param  MemoryType Type of memory allocated by this HOB.\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() since PEI HOB is read-only for DXE phase.\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
+  @param  Length        The length of the memory allocation in bytes.\r
+  @param  MemoryType    Type of memory allocated by this HOB.\r
 \r
 **/\r
 VOID\r
@@ -269,7 +443,90 @@ BuildMemoryAllocationHob (
   IN EFI_PHYSICAL_ADDRESS        BaseAddress,\r
   IN UINT64                      Length,\r
   IN EFI_MEMORY_TYPE             MemoryType\r
-  )\r
-;\r
+  );\r
+\r
+/**\r
+  Returns the type of a HOB.\r
+\r
+  This macro returns the HobType field from the HOB header for the\r
+  HOB specified by HobStart.\r
+\r
+  @param  HobStart   A pointer to a HOB.\r
+\r
+  @return HobType.\r
+\r
+**/\r
+#define GET_HOB_TYPE(HobStart) \\r
+  ((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobType)\r
+\r
+/**\r
+  Returns the length, in bytes, of a HOB.\r
+\r
+  This macro returns the HobLength field from the HOB header for the\r
+  HOB specified by HobStart.\r
+\r
+  @param  HobStart   A pointer to a HOB.\r
+\r
+  @return HobLength.\r
+\r
+**/\r
+#define GET_HOB_LENGTH(HobStart) \\r
+  ((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobLength)\r
+\r
+/**\r
+  Returns a pointer to the next HOB in the HOB list.\r
+\r
+  This macro returns a pointer to HOB that follows the\r
+  HOB specified by HobStart in the HOB List.\r
+\r
+  @param  HobStart   A pointer to a HOB.\r
+\r
+  @return A pointer to the next HOB in the HOB list.\r
+\r
+**/\r
+#define GET_NEXT_HOB(HobStart) \\r
+  (VOID *)(*(UINT8 **)&(HobStart) + GET_HOB_LENGTH (HobStart))\r
+\r
+/**\r
+  Determines if a HOB is the last HOB in the HOB list.\r
+\r
+  This macro determine if the HOB specified by HobStart is the\r
+  last HOB in the HOB list.  If HobStart is last HOB in the HOB list,\r
+  then TRUE is returned.  Otherwise, FALSE is returned.\r
+\r
+  @param  HobStart   A pointer to a HOB.\r
+\r
+  @retval TRUE       The HOB specified by HobStart is the last HOB in the HOB list.\r
+  @retval FALSE      The HOB specified by HobStart is not the last HOB in the HOB list.\r
+\r
+**/\r
+#define END_OF_HOB_LIST(HobStart)  (GET_HOB_TYPE (HobStart) == (UINT16)EFI_HOB_TYPE_END_OF_HOB_LIST)\r
+\r
+/**\r
+  Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+\r
+  This macro returns a pointer to the data buffer in a HOB specified by HobStart.\r
+  HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+\r
+  @param   GuidHob   A pointer to a HOB.\r
+\r
+  @return  A pointer to the data buffer in a HOB.\r
+\r
+**/\r
+#define GET_GUID_HOB_DATA(HobStart) \\r
+  (VOID *)(*(UINT8 **)&(HobStart) + sizeof (EFI_HOB_GUID_TYPE))\r
+\r
+/**\r
+  Returns the size of the data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+\r
+  This macro returns the size, in bytes, of the data buffer in a HOB specified by HobStart.\r
+  HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION.\r
+\r
+  @param   GuidHob   A pointer to a HOB.\r
+\r
+  @return  The size of the data buffer.\r
+**/\r
+#define GET_GUID_HOB_DATA_SIZE(HobStart) \\r
+  (UINT16)(GET_HOB_LENGTH (HobStart) - sizeof (EFI_HOB_GUID_TYPE))\r
 \r
 #endif\r