MdeModulePkg/Core/Pei/Hob/Hob.c

   1 /** @file
   2   This module provide Hand-Off Block manupulation.
   3
   4 Copyright (c) 2006, Intel Corporation
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #include <PeiMain.h>
  16
  17 /**
  18
  19   Gets the pointer to the HOB List.
  20
  21   @param PeiServices                   The PEI core services table.
  22   @param HobList                       Pointer to the HOB List.
  23
  24   @retval EFI_SUCCESS                  Get the pointer of HOB List
  25   @retval EFI_NOT_AVAILABLE_YET        the HOB List is not yet published
  26   @retval EFI_INVALID_PARAMETER        HobList is NULL (in debug mode)
  27
  28 **/
  29 EFI_STATUS
  30 EFIAPI
  31 PeiGetHobList (
  32   IN CONST EFI_PEI_SERVICES  **PeiServices,
  33   IN OUT VOID          **HobList
  34   )
  35 {
  36   PEI_CORE_INSTANCE *PrivateData;
  37
  38   //
  39   // Only check this parameter in debug mode
  40   //
  41
  42   DEBUG_CODE_BEGIN ();
  43     if (HobList == NULL) {
  44       return EFI_INVALID_PARAMETER;
  45     }
  46   DEBUG_CODE_END ();
  47
  48   PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS(PeiServices);
  49
  50   *HobList    = PrivateData->HobList.Raw;
  51
  52   return EFI_SUCCESS;
  53 }
  54
  55
  56 /**
  57   Add a new HOB to the HOB List.
  58
  59   @param PeiServices      The PEI core services table.
  60   @param Type             Type of the new HOB.
  61   @param Length           Length of the new HOB to allocate.
  62   @param Hob              Pointer to the new HOB.
  63
  64   @return  EFI_SUCCESS           Success to create hob.
  65   @retval  EFI_INVALID_PARAMETER if Hob is NULL
  66   @retval  EFI_NOT_AVAILABLE_YET if HobList is still not available.
  67   @retval  EFI_OUT_OF_RESOURCES  if there is no more memory to grow the Hoblist.
  68
  69 **/
  70 EFI_STATUS
  71 EFIAPI
  72 PeiCreateHob (
  73   IN CONST EFI_PEI_SERVICES  **PeiServices,
  74   IN UINT16            Type,
  75   IN UINT16            Length,
  76   IN OUT VOID          **Hob
  77   )
  78 {
  79   EFI_STATUS                           Status;
  80   EFI_HOB_HANDOFF_INFO_TABLE           *HandOffHob;
  81   EFI_HOB_GENERIC_HEADER               *HobEnd;
  82   EFI_PHYSICAL_ADDRESS                 FreeMemory;
  83
  84
  85   Status = PeiGetHobList (PeiServices, Hob);
  86   if (EFI_ERROR(Status)) {
  87     return Status;
  88   }
  89
  90   HandOffHob = *Hob;
  91
  92   Length     = (UINT16)((Length + 0x7) & (~0x7));
  93
  94   FreeMemory = HandOffHob->EfiFreeMemoryTop -
  95                HandOffHob->EfiFreeMemoryBottom;
  96
  97   if (FreeMemory < Length) {
  98     DEBUG ((EFI_D_ERROR, "PeiCreateHob fail: Length - 0x%08x\n", (UINTN)Length));
  99     DEBUG ((EFI_D_ERROR, "  FreeMemoryTop    - 0x%08x\n", (UINTN)HandOffHob->EfiFreeMemoryTop));
 100     DEBUG ((EFI_D_ERROR, "  FreeMemoryBottom - 0x%08x\n", (UINTN)HandOffHob->EfiFreeMemoryBottom));
 101     return EFI_OUT_OF_RESOURCES;
 102   }
 103
 104   *Hob = (VOID*) (UINTN) HandOffHob->EfiEndOfHobList;
 105   ((EFI_HOB_GENERIC_HEADER*) *Hob)->HobType   = Type;
 106   ((EFI_HOB_GENERIC_HEADER*) *Hob)->HobLength = Length;
 107   ((EFI_HOB_GENERIC_HEADER*) *Hob)->Reserved  = 0;
 108
 109   HobEnd = (EFI_HOB_GENERIC_HEADER*) ((UINTN) *Hob + Length);
 110   HandOffHob->EfiEndOfHobList = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;
 111
 112   HobEnd->HobType   = EFI_HOB_TYPE_END_OF_HOB_LIST;
 113   HobEnd->HobLength = sizeof(EFI_HOB_GENERIC_HEADER);
 114   HobEnd->Reserved  = 0;
 115   HobEnd++;
 116   HandOffHob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;
 117
 118   return EFI_SUCCESS;
 119 }
 120
 121 /**
 122
 123   Builds a Handoff Information Table HOB
 124
 125   @param BootMode        - Current Bootmode
 126   @param MemoryBegin     - Start Memory Address.
 127   @param MemoryLength    - Length of Memory.
 128
 129   @return EFI_SUCCESS Always success to initialize HOB.
 130
 131 **/
 132 EFI_STATUS
 133 PeiCoreBuildHobHandoffInfoTable (
 134   IN EFI_BOOT_MODE         BootMode,
 135   IN EFI_PHYSICAL_ADDRESS  MemoryBegin,
 136   IN UINT64                MemoryLength
 137   )
 138 {
 139   EFI_HOB_HANDOFF_INFO_TABLE   *Hob;
 140   EFI_HOB_GENERIC_HEADER       *HobEnd;
 141
 142   Hob                      = (VOID *)(UINTN)MemoryBegin;
 143   HobEnd                   = (EFI_HOB_GENERIC_HEADER*) (Hob+1);
 144   Hob->Header.HobType      = EFI_HOB_TYPE_HANDOFF;
 145   Hob->Header.HobLength    = sizeof(EFI_HOB_HANDOFF_INFO_TABLE);
 146   Hob->Header.Reserved     = 0;
 147
 148   HobEnd->HobType          = EFI_HOB_TYPE_END_OF_HOB_LIST;
 149   HobEnd->HobLength        = sizeof(EFI_HOB_GENERIC_HEADER);
 150   HobEnd->Reserved         = 0;
 151
 152   Hob->Version             = EFI_HOB_HANDOFF_TABLE_VERSION;
 153   Hob->BootMode            = BootMode;
 154
 155   Hob->EfiMemoryTop        = MemoryBegin + MemoryLength;
 156   Hob->EfiMemoryBottom     = MemoryBegin;
 157   Hob->EfiFreeMemoryTop    = MemoryBegin + MemoryLength;
 158   Hob->EfiFreeMemoryBottom = (EFI_PHYSICAL_ADDRESS) (UINTN) (HobEnd + 1);
 159   Hob->EfiEndOfHobList     = (EFI_PHYSICAL_ADDRESS) (UINTN) HobEnd;
 160
 161   return EFI_SUCCESS;
 162 }