]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/PeiHobLib/HobLib.c
Partial checkin fixing Beagle references
[mirror_edk2.git] / MdePkg / Library / PeiHobLib / HobLib.c
index a06f1690bfec0c2608bdf1ac1775fdf383b78f2e..1815ddf530ff429ac7aeb209023109ab312a3192 100644 (file)
@@ -1,27 +1,40 @@
 /** @file\r
-  HOB Library.\r
+  Provide Hob Library functions for Pei phase.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\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
+Copyright (c) 2007 - 2009, Intel Corporation<BR>\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.c\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
+#include <PiPei.h>\r
+\r
+#include <Guid/MemoryAllocationHob.h>\r
 \r
+#include <Library/HobLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PeiServicesLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
 \r
 /**\r
   Returns the pointer to the HOB list.\r
 \r
-  None.\r
-\r
-  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
@@ -33,7 +46,7 @@ GetHobList (
   EFI_STATUS            Status;\r
   VOID                  *HobList;\r
 \r
-  Status = PeiCoreGetHobList (&HobList);\r
+  Status = PeiServicesGetHobList (&HobList);\r
   ASSERT_EFI_ERROR (Status);\r
   ASSERT (HobList != NULL);\r
 \r
@@ -41,11 +54,18 @@ GetHobList (
 }\r
 \r
 /**\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
+  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
 \r
@@ -63,7 +83,7 @@ GetNextHob (
    \r
   Hob.Raw = (UINT8 *) HobStart;\r
   //\r
-  // Parse the HOB list, stop if end of list or matching type found.\r
+  // Parse the HOB list until end of list or matching type is found.\r
   //\r
   while (!END_OF_HOB_LIST (Hob)) {\r
     if (Hob.Header->HobType == Type) {\r
@@ -75,10 +95,14 @@ GetNextHob (
 }\r
 \r
 /**\r
+  Returns the first instance of a HOB type among the whole HOB list.\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
+  If the pointer to the HOB list is NULL, then ASSERT().\r
 \r
-  @param  Type The HOB type to return.\r
+  @param  Type          The HOB type to return.\r
 \r
   @return The next instance of a HOB type from the starting HOB.\r
 \r
@@ -96,13 +120,23 @@ GetFirstHob (
 }\r
 \r
 /**\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
-\r
-  @param  Guid The GUID to match with in the HOB list.\r
-  @param  HobStart A pointer to a Guid.\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
+  If Guid is NULL, then ASSERT().\r
+  If HobStart is NULL, then ASSERT().\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
@@ -127,12 +161,19 @@ GetNextGuidHob (
 }\r
 \r
 /**\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
 \r
@@ -150,15 +191,46 @@ GetFirstGuidHob (
 }\r
 \r
 /**\r
-  Add a new HOB to the HOB List.\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
+  EFI_STATUS             Status;\r
+  EFI_BOOT_MODE          BootMode;\r
+\r
+  Status = PeiServicesGetBootMode (&BootMode);\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
+  return BootMode;\r
+}\r
+\r
+/**\r
+  Adds a new HOB to the HOB List.\r
+\r
+  This internal function enables PEIMs to create various types of HOBs.\r
 \r
-  @param  Type Type of the new HOB.\r
-  @param  Length Length of the new HOB to allocate.\r
+  @param  Type          Type of the new HOB.\r
+  @param  Length        Length of the new HOB to allocate.\r
 \r
   @return The address of new HOB.\r
 \r
 **/\r
 VOID *\r
+EFIAPI\r
 InternalPeiCreateHob (\r
   IN UINT16                      Type,\r
   IN UINT16                      Length\r
@@ -167,7 +239,7 @@ InternalPeiCreateHob (
   EFI_STATUS        Status;\r
   VOID              *Hob;\r
 \r
-  Status = PeiCoreCreateHob (Type, Length, &Hob);\r
+  Status = PeiServicesCreateHob (Type, Length, &Hob);\r
   //\r
   // Assume the process of HOB building is always successful.\r
   //\r
@@ -176,12 +248,19 @@ InternalPeiCreateHob (
 }\r
 \r
 /**\r
+  Builds a HOB for a loaded PE32 module.\r
+\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\92s entry point.\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
@@ -195,6 +274,9 @@ BuildModuleHob (
 {\r
   EFI_HOB_MEMORY_ALLOCATION_MODULE  *Hob;\r
 \r
+  ASSERT (((MemoryAllocationModule & (EFI_PAGE_SIZE - 1)) == 0) &&\r
+          ((ModuleLength & (EFI_PAGE_SIZE - 1)) == 0));\r
+\r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE));\r
 \r
   CopyGuid (&(Hob->MemoryAllocationHeader.Name), &gEfiHobMemoryAllocModuleGuid);\r
@@ -202,6 +284,11 @@ BuildModuleHob (
   Hob->MemoryAllocationHeader.MemoryLength      = ModuleLength;\r
   Hob->MemoryAllocationHeader.MemoryType        = EfiBootServicesCode;\r
 \r
+  //\r
+  // Zero the reserved space to match HOB spec\r
+  //\r
+  ZeroMem (Hob->MemoryAllocationHeader.Reserved, sizeof (Hob->MemoryAllocationHeader.Reserved));\r
+  \r
   CopyGuid (&Hob->ModuleName, ModuleName);\r
   Hob->EntryPoint = EntryPoint;\r
 }\r
@@ -209,10 +296,16 @@ BuildModuleHob (
 /**\r
   Builds a HOB that describes a chunk of system memory.\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
+  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
@@ -235,11 +328,21 @@ BuildResourceDescriptorHob (
 }\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
-\r
-  @param  Guid The GUID to tag the customized HOB.\r
-  @param  DataLength The size of the data payload for the GUID HOB.\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
+  If Guid is NULL, then ASSERT().\r
+  If there is no additional space for HOB creation, then ASSERT().\r
+  If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\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
 \r
   @return The start address of GUID HOB data.\r
 \r
@@ -264,12 +367,24 @@ BuildGuidHob (
 }\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
-\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
+  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 >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().\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
 \r
   @return The start address of GUID HOB data.\r
 \r
@@ -284,6 +399,8 @@ BuildGuidDataHob (
 {\r
   VOID  *HobData;\r
 \r
+  ASSERT (Data != NULL || DataLength == 0);\r
+\r
   HobData = BuildGuidHob (Guid, DataLength);\r
 \r
   return CopyMem (HobData, Data, DataLength);\r
@@ -292,8 +409,14 @@ BuildGuidDataHob (
 /**\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
@@ -311,11 +434,52 @@ BuildFvHob (
   Hob->Length      = Length;\r
 }\r
 \r
+/**\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
+  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
+  EFI_HOB_FIRMWARE_VOLUME2  *Hob;\r
+\r
+  Hob = InternalPeiCreateHob (EFI_HOB_TYPE_FV2, sizeof (EFI_HOB_FIRMWARE_VOLUME2));\r
+\r
+  Hob->BaseAddress = BaseAddress;\r
+  Hob->Length      = Length;\r
+  CopyGuid (&Hob->FvName, FvName);\r
+  CopyGuid (&Hob->FileName, FileName);\r
+}\r
+\r
 /**\r
   Builds a Capsule Volume HOB.\r
 \r
-  @param  BaseAddress The base address of the Capsule Volume.\r
-  @param  Length The size of the Capsule Volume in bytes.\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
@@ -325,9 +489,9 @@ BuildCvHob (
   IN UINT64                      Length\r
   )\r
 {\r
-  EFI_HOB_CAPSULE_VOLUME  *Hob;\r
+  EFI_HOB_UEFI_CAPSULE  *Hob;\r
 \r
-  Hob = InternalPeiCreateHob (EFI_HOB_TYPE_CV, sizeof (EFI_HOB_CAPSULE_VOLUME));\r
+  Hob = InternalPeiCreateHob (EFI_HOB_TYPE_UEFI_CAPSULE, sizeof (EFI_HOB_UEFI_CAPSULE));\r
 \r
   Hob->BaseAddress  = BaseAddress;\r
   Hob->Length       = Length;\r
@@ -336,8 +500,14 @@ BuildCvHob (
 /**\r
   Builds a HOB for the CPU.\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
+  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
+  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
@@ -353,13 +523,24 @@ BuildCpuHob (
 \r
   Hob->SizeOfMemorySpace = SizeOfMemorySpace;\r
   Hob->SizeOfIoSpace     = SizeOfIoSpace;\r
+\r
+  //\r
+  // Zero the reserved space to match HOB spec\r
+  //\r
+  ZeroMem (Hob->Reserved, sizeof (Hob->Reserved)); \r
 }\r
 \r
 /**\r
   Builds a HOB for the Stack.\r
 \r
-  @param  BaseAddress The 64 bit physical address of the Stack.\r
-  @param  Length The length of the stack in bytes.\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
+  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
@@ -371,20 +552,34 @@ BuildStackHob (
 {\r
   EFI_HOB_MEMORY_ALLOCATION_STACK  *Hob;\r
 \r
+  ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
+          ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
+\r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK));\r
 \r
   CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocStackGuid);\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
   Hob->AllocDescriptor.MemoryLength      = Length;\r
-  Hob->AllocDescriptor.MemoryType        = EfiConventionalMemory;\r
+  Hob->AllocDescriptor.MemoryType        = EfiBootServicesData;\r
+\r
+  //\r
+  // Zero the reserved space to match HOB spec\r
+  //\r
+  ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
 }\r
 \r
 /**\r
   Builds a HOB for the BSP store.\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
+  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
 \r
 **/\r
 VOID\r
@@ -397,20 +592,34 @@ BuildBspStoreHob (
 {\r
   EFI_HOB_MEMORY_ALLOCATION_BSP_STORE  *Hob;\r
 \r
+  ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
+          ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
+\r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE));\r
 \r
   CopyGuid (&(Hob->AllocDescriptor.Name), &gEfiHobMemoryAllocBspStoreGuid);\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
   Hob->AllocDescriptor.MemoryLength      = Length;\r
   Hob->AllocDescriptor.MemoryType        = MemoryType;\r
+\r
+  //\r
+  // Zero the reserved space to match HOB spec\r
+  //\r
+  ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
 }\r
 \r
 /**\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
@@ -423,10 +632,17 @@ BuildMemoryAllocationHob (
 {\r
   EFI_HOB_MEMORY_ALLOCATION  *Hob;\r
 \r
+  ASSERT (((BaseAddress & (EFI_PAGE_SIZE - 1)) == 0) &&\r
+          ((Length & (EFI_PAGE_SIZE - 1)) == 0));\r
+  \r
   Hob = InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION, sizeof (EFI_HOB_MEMORY_ALLOCATION));\r
-\r
+  \r
   ZeroMem (&(Hob->AllocDescriptor.Name), sizeof (EFI_GUID));\r
   Hob->AllocDescriptor.MemoryBaseAddress = BaseAddress;\r
   Hob->AllocDescriptor.MemoryLength      = Length;\r
   Hob->AllocDescriptor.MemoryType        = MemoryType;\r
+  //\r
+  // Zero the reserved space to match HOB spec\r
+  //\r
+  ZeroMem (Hob->AllocDescriptor.Reserved, sizeof (Hob->AllocDescriptor.Reserved));\r
 }\r