MdePkg/Library/DxeCoreHobLib/HobLib.c

   1 /** @file
   2   HOB Library implementation for DxeCore driver.
   3
   4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   5 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 <PiDxe.h>
  16
  17 #include <Library/HobLib.h>
  18 #include <Library/DebugLib.h>
  19 #include <Library/BaseMemoryLib.h>
  20 #include <Library/DxeCoreEntryPoint.h>
  21
  22 /**
  23   Returns the pointer to the HOB list.
  24
  25   This function returns the pointer to first HOB in the list.
  26   For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer
  27   to the HOB list.  For the DXE phase, the HOB list pointer can be retrieved through
  28   the EFI System Table by looking up theHOB list GUID in the System Configuration Table.
  29   Since the System Configuration Table does not exist that the time the DXE Core is
  30   launched, the DXE Core uses a global variable from the DXE Core Entry Point Library
  31   to manage the pointer to the HOB list.
  32
  33   If the pointer to the HOB list is NULL, then ASSERT().
  34
  35   @return The pointer to the HOB list.
  36
  37 **/
  38 VOID *
  39 EFIAPI
  40 GetHobList (
  41   VOID
  42   )
  43 {
  44   ASSERT (gHobList != NULL);
  45   return gHobList;
  46 }
  47
  48 /**
  49   Returns the next instance of a HOB type from the starting HOB.
  50
  51   This function searches the first instance of a HOB type from the starting HOB pointer.
  52   If there does not exist such HOB type from the starting HOB pointer, it will return NULL.
  53   In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
  54   unconditionally: it returns HobStart back if HobStart itself meets the requirement;
  55   caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
  56
  57   If HobStart is NULL, then ASSERT().
  58
  59   @param  Type          The HOB type to return.
  60   @param  HobStart      The starting HOB pointer to search from.
  61
  62   @return The next instance of a HOB type from the starting HOB.
  63
  64 **/
  65 VOID *
  66 EFIAPI
  67 GetNextHob (
  68   IN UINT16                 Type,
  69   IN CONST VOID             *HobStart
  70   )
  71 {
  72   EFI_PEI_HOB_POINTERS  Hob;
  73
  74   ASSERT (HobStart != NULL);
  75
  76   Hob.Raw = (UINT8 *) HobStart;
  77   //
  78   // Parse the HOB list until end of list or matching type is found.
  79   //
  80   while (!END_OF_HOB_LIST (Hob)) {
  81     if (Hob.Header->HobType == Type) {
  82       return Hob.Raw;
  83     }
  84     Hob.Raw = GET_NEXT_HOB (Hob);
  85   }
  86   return NULL;
  87 }
  88
  89 /**
  90   Returns the first instance of a HOB type among the whole HOB list.
  91
  92   This function searches the first instance of a HOB type among the whole HOB list.
  93   If there does not exist such HOB type in the HOB list, it will return NULL.
  94
  95   If the pointer to the HOB list is NULL, then ASSERT().
  96
  97   @param  Type          The HOB type to return.
  98
  99   @return The next instance of a HOB type from the starting HOB.
 100
 101 **/
 102 VOID *
 103 EFIAPI
 104 GetFirstHob (
 105   IN UINT16                 Type
 106   )
 107 {
 108   VOID      *HobList;
 109
 110   HobList = GetHobList ();
 111   return GetNextHob (Type, HobList);
 112 }
 113
 114 /**
 115   Returns the next instance of the matched GUID HOB from the starting HOB.
 116
 117   This function searches the first instance of a HOB from the starting HOB pointer.
 118   Such HOB should satisfy two conditions:
 119   its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
 120   If there does not exist such HOB from the starting HOB pointer, it will return NULL.
 121   Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
 122   to extract the data section and its size info respectively.
 123   In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
 124   unconditionally: it returns HobStart back if HobStart itself meets the requirement;
 125   caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
 126
 127   If Guid is NULL, then ASSERT().
 128   If HobStart is NULL, then ASSERT().
 129
 130   @param  Guid          The GUID to match with in the HOB list.
 131   @param  HobStart      A pointer to a Guid.
 132
 133   @return The next instance of the matched GUID HOB from the starting HOB.
 134
 135 **/
 136 VOID *
 137 EFIAPI
 138 GetNextGuidHob (
 139   IN CONST EFI_GUID         *Guid,
 140   IN CONST VOID             *HobStart
 141   )
 142 {
 143   EFI_PEI_HOB_POINTERS  GuidHob;
 144
 145   GuidHob.Raw = (UINT8 *) HobStart;
 146   while ((GuidHob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GuidHob.Raw)) != NULL) {
 147     if (CompareGuid (Guid, &GuidHob.Guid->Name)) {
 148       break;
 149     }
 150     GuidHob.Raw = GET_NEXT_HOB (GuidHob);
 151   }
 152   return GuidHob.Raw;
 153 }
 154
 155 /**
 156   Returns the first instance of the matched GUID HOB among the whole HOB list.
 157
 158   This function searches the first instance of a HOB among the whole HOB list.
 159   Such HOB should satisfy two conditions:
 160   its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
 161   If there does not exist such HOB from the starting HOB pointer, it will return NULL.
 162   Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
 163   to extract the data section and its size info respectively.
 164
 165   If the pointer to the HOB list is NULL, then ASSERT().
 166   If Guid is NULL, then ASSERT().
 167
 168   @param  Guid          The GUID to match with in the HOB list.
 169
 170   @return The first instance of the matched GUID HOB among the whole HOB list.
 171
 172 **/
 173 VOID *
 174 EFIAPI
 175 GetFirstGuidHob (
 176   IN CONST EFI_GUID         *Guid
 177   )
 178 {
 179   VOID      *HobList;
 180
 181   HobList = GetHobList ();
 182   return GetNextGuidHob (Guid, HobList);
 183 }
 184
 185 /**
 186   Get the system boot mode from the HOB list.
 187
 188   This function returns the system boot mode information from the
 189   PHIT HOB in HOB list.
 190
 191   If the pointer to the HOB list is NULL, then ASSERT().
 192
 193   @param  VOID
 194
 195   @return The Boot Mode.
 196
 197 **/
 198 EFI_BOOT_MODE
 199 EFIAPI
 200 GetBootModeHob (
 201   VOID
 202   )
 203 {
 204   EFI_HOB_HANDOFF_INFO_TABLE    *HandOffHob;
 205
 206   HandOffHob = (EFI_HOB_HANDOFF_INFO_TABLE *) GetHobList ();
 207
 208   return  HandOffHob->BootMode;
 209 }
 210
 211 /**
 212   Builds a HOB for a loaded PE32 module.
 213
 214   This function builds a HOB for a loaded PE32 module.
 215   It can only be invoked during PEI phase;
 216   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 217
 218   If ModuleName is NULL, then ASSERT().
 219   If there is no additional space for HOB creation, then ASSERT().
 220
 221   @param  ModuleName              The GUID File Name of the module.
 222   @param  MemoryAllocationModule  The 64 bit physical address of the module.
 223   @param  ModuleLength            The length of the module in bytes.
 224   @param  EntryPoint              The 64 bit physical address of the module entry point.
 225
 226 **/
 227 VOID
 228 EFIAPI
 229 BuildModuleHob (
 230   IN CONST EFI_GUID         *ModuleName,
 231   IN EFI_PHYSICAL_ADDRESS   MemoryAllocationModule,
 232   IN UINT64                 ModuleLength,
 233   IN EFI_PHYSICAL_ADDRESS   EntryPoint
 234   )
 235 {
 236   //
 237   // PEI HOB is read only for DXE phase
 238   //
 239   ASSERT (FALSE);
 240 }
 241
 242 /**
 243   Builds a HOB that describes a chunk of system memory.
 244
 245   This function builds a HOB that describes a chunk of system memory.
 246   It can only be invoked during PEI phase;
 247   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 248
 249   If there is no additional space for HOB creation, then ASSERT().
 250
 251   @param  ResourceType        The type of resource described by this HOB.
 252   @param  ResourceAttribute   The resource attributes of the memory described by this HOB.
 253   @param  PhysicalStart       The 64 bit physical address of memory described by this HOB.
 254   @param  NumberOfBytes       The length of the memory described by this HOB in bytes.
 255
 256 **/
 257 VOID
 258 EFIAPI
 259 BuildResourceDescriptorHob (
 260   IN EFI_RESOURCE_TYPE            ResourceType,
 261   IN EFI_RESOURCE_ATTRIBUTE_TYPE  ResourceAttribute,
 262   IN EFI_PHYSICAL_ADDRESS         PhysicalStart,
 263   IN UINT64                       NumberOfBytes
 264   )
 265 {
 266   //
 267   // PEI HOB is read only for DXE phase
 268   //
 269   ASSERT (FALSE);
 270 }
 271
 272 /**
 273   Builds a customized HOB tagged with a GUID for identification and returns
 274   the start address of GUID HOB data.
 275
 276   This function builds a customized HOB tagged with a GUID for identification
 277   and returns the start address of GUID HOB data so that caller can fill the customized data.
 278   The HOB Header and Name field is already stripped.
 279   It can only be invoked during PEI phase;
 280   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 281
 282   If Guid is NULL, then ASSERT().
 283   If there is no additional space for HOB creation, then ASSERT().
 284   If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
 285
 286   @param  Guid          The GUID to tag the customized HOB.
 287   @param  DataLength    The size of the data payload for the GUID HOB.
 288
 289   @return The start address of GUID HOB data.
 290
 291 **/
 292 VOID *
 293 EFIAPI
 294 BuildGuidHob (
 295   IN CONST EFI_GUID              *Guid,
 296   IN UINTN                       DataLength
 297   )
 298 {
 299   //
 300   // PEI HOB is read only for DXE phase
 301   //
 302   ASSERT (FALSE);
 303   return NULL;
 304 }
 305
 306 /**
 307   Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB
 308   data field, and returns the start address of the GUID HOB data.
 309
 310   This function builds a customized HOB tagged with a GUID for identification and copies the input
 311   data to the HOB data field and returns the start address of the GUID HOB data.  It can only be
 312   invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 313   The HOB Header and Name field is already stripped.
 314   It can only be invoked during PEI phase;
 315   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 316
 317   If Guid is NULL, then ASSERT().
 318   If Data is NULL and DataLength > 0, then ASSERT().
 319   If there is no additional space for HOB creation, then ASSERT().
 320   If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
 321
 322   @param  Guid          The GUID to tag the customized HOB.
 323   @param  Data          The data to be copied into the data field of the GUID HOB.
 324   @param  DataLength    The size of the data payload for the GUID HOB.
 325
 326   @return The start address of GUID HOB data.
 327
 328 **/
 329 VOID *
 330 EFIAPI
 331 BuildGuidDataHob (
 332   IN CONST EFI_GUID              *Guid,
 333   IN VOID                        *Data,
 334   IN UINTN                       DataLength
 335   )
 336 {
 337   //
 338   // PEI HOB is read only for DXE phase
 339   //
 340   ASSERT (FALSE);
 341   return NULL;
 342 }
 343
 344 /**
 345   Builds a Firmware Volume HOB.
 346
 347   This function builds a Firmware Volume HOB.
 348   It can only be invoked during PEI phase;
 349   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 350
 351   If there is no additional space for HOB creation, then ASSERT().
 352
 353   @param  BaseAddress   The base address of the Firmware Volume.
 354   @param  Length        The size of the Firmware Volume in bytes.
 355
 356 **/
 357 VOID
 358 EFIAPI
 359 BuildFvHob (
 360   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 361   IN UINT64                      Length
 362   )
 363 {
 364   //
 365   // PEI HOB is read only for DXE phase
 366   //
 367   ASSERT (FALSE);
 368 }
 369
 370 /**
 371   Builds a EFI_HOB_TYPE_FV2 HOB.
 372
 373   This function builds a EFI_HOB_TYPE_FV2 HOB.
 374   It can only be invoked during PEI phase;
 375   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 376
 377   If there is no additional space for HOB creation, then ASSERT().
 378
 379   @param  BaseAddress   The base address of the Firmware Volume.
 380   @param  Length        The size of the Firmware Volume in bytes.
 381   @param  FvName        The name of the Firmware Volume.
 382   @param  FileName      The name of the file.
 383
 384 **/
 385 VOID
 386 EFIAPI
 387 BuildFv2Hob (
 388   IN          EFI_PHYSICAL_ADDRESS        BaseAddress,
 389   IN          UINT64                      Length,
 390   IN CONST    EFI_GUID                    *FvName,
 391   IN CONST    EFI_GUID                    *FileName
 392   )
 393 {
 394   ASSERT (FALSE);
 395 }
 396
 397 /**
 398   Builds a Capsule Volume HOB.
 399
 400   This function builds a Capsule Volume HOB.
 401   It can only be invoked during PEI phase;
 402   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 403
 404   If the platform does not support Capsule Volume HOBs, then ASSERT().
 405   If there is no additional space for HOB creation, then ASSERT().
 406
 407   @param  BaseAddress   The base address of the Capsule Volume.
 408   @param  Length        The size of the Capsule Volume in bytes.
 409
 410 **/
 411 VOID
 412 EFIAPI
 413 BuildCvHob (
 414   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 415   IN UINT64                      Length
 416   )
 417 {
 418   //
 419   // PEI HOB is read only for DXE phase
 420   //
 421   ASSERT (FALSE);
 422 }
 423
 424 /**
 425   Builds a HOB for the CPU.
 426
 427   This function builds a HOB for the CPU.
 428   It can only be invoked during PEI phase;
 429   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 430
 431   If there is no additional space for HOB creation, then ASSERT().
 432
 433   @param  SizeOfMemorySpace   The maximum physical memory addressability of the processor.
 434   @param  SizeOfIoSpace       The maximum physical I/O addressability of the processor.
 435
 436 **/
 437 VOID
 438 EFIAPI
 439 BuildCpuHob (
 440   IN UINT8                       SizeOfMemorySpace,
 441   IN UINT8                       SizeOfIoSpace
 442   )
 443 {
 444   //
 445   // PEI HOB is read only for DXE phase
 446   //
 447   ASSERT (FALSE);
 448 }
 449
 450 /**
 451   Builds a HOB for the Stack.
 452
 453   This function builds a HOB for the stack.
 454   It can only be invoked during PEI phase;
 455   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 456
 457   If there is no additional space for HOB creation, then ASSERT().
 458
 459   @param  BaseAddress   The 64 bit physical address of the Stack.
 460   @param  Length        The length of the stack in bytes.
 461
 462 **/
 463 VOID
 464 EFIAPI
 465 BuildStackHob (
 466   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 467   IN UINT64                      Length
 468   )
 469 {
 470   //
 471   // PEI HOB is read only for DXE phase
 472   //
 473   ASSERT (FALSE);
 474 }
 475
 476 /**
 477   Builds a HOB for the BSP store.
 478
 479   This function builds a HOB for BSP store.
 480   It can only be invoked during PEI phase;
 481   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 482
 483   If there is no additional space for HOB creation, then ASSERT().
 484
 485   @param  BaseAddress   The 64 bit physical address of the BSP.
 486   @param  Length        The length of the BSP store in bytes.
 487   @param  MemoryType    Type of memory allocated by this HOB.
 488
 489 **/
 490 VOID
 491 EFIAPI
 492 BuildBspStoreHob (
 493   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 494   IN UINT64                      Length,
 495   IN EFI_MEMORY_TYPE             MemoryType
 496   )
 497 {
 498   //
 499   // PEI HOB is read only for DXE phase
 500   //
 501   ASSERT (FALSE);
 502 }
 503
 504 /**
 505   Builds a HOB for the memory allocation.
 506
 507   This function builds a HOB for the memory allocation.
 508   It can only be invoked during PEI phase;
 509   for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
 510
 511   If there is no additional space for HOB creation, then ASSERT().
 512
 513   @param  BaseAddress   The 64 bit physical address of the memory.
 514   @param  Length        The length of the memory allocation in bytes.
 515   @param  MemoryType    Type of memory allocated by this HOB.
 516
 517 **/
 518 VOID
 519 EFIAPI
 520 BuildMemoryAllocationHob (
 521   IN EFI_PHYSICAL_ADDRESS        BaseAddress,
 522   IN UINT64                      Length,
 523   IN EFI_MEMORY_TYPE             MemoryType
 524   )
 525 {
 526   //
 527   // PEI HOB is read only for DXE phase
 528   //
 529   ASSERT (FALSE);
 530 }