MdePkg/Include/Library/HobLib.h

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