2 Provide Hob Library functions for Pei phase.
4 Copyright (c) 2007 - 2012, 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.
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.
17 #include <Guid/MemoryAllocationHob.h>
19 #include <Library/HobLib.h>
20 #include <Library/DebugLib.h>
21 #include <Library/PeiServicesLib.h>
22 #include <Library/BaseMemoryLib.h>
25 Returns the pointer to the HOB list.
27 This function returns the pointer to first HOB in the list.
28 For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer
29 to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through
30 the EFI System Table by looking up theHOB list GUID in the System Configuration Table.
31 Since the System Configuration Table does not exist that the time the DXE Core is
32 launched, the DXE Core uses a global variable from the DXE Core Entry Point Library
33 to manage the pointer to the HOB list.
35 If the pointer to the HOB list is NULL, then ASSERT().
37 @return The pointer to the HOB list.
49 Status
= PeiServicesGetHobList (&HobList
);
50 ASSERT_EFI_ERROR (Status
);
51 ASSERT (HobList
!= NULL
);
57 Returns the next instance of a HOB type from the starting HOB.
59 This function searches the first instance of a HOB type from the starting HOB pointer.
60 If there does not exist such HOB type from the starting HOB pointer, it will return NULL.
61 In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
62 unconditionally: it returns HobStart back if HobStart itself meets the requirement;
63 caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
65 If HobStart is NULL, then ASSERT().
67 @param Type The HOB type to return.
68 @param HobStart The starting HOB pointer to search from.
70 @return The next instance of a HOB type from the starting HOB.
77 IN CONST VOID
*HobStart
80 EFI_PEI_HOB_POINTERS Hob
;
82 ASSERT (HobStart
!= NULL
);
84 Hob
.Raw
= (UINT8
*) HobStart
;
86 // Parse the HOB list until end of list or matching type is found.
88 while (!END_OF_HOB_LIST (Hob
)) {
89 if (Hob
.Header
->HobType
== Type
) {
92 Hob
.Raw
= GET_NEXT_HOB (Hob
);
98 Returns the first instance of a HOB type among the whole HOB list.
100 This function searches the first instance of a HOB type among the whole HOB list.
101 If there does not exist such HOB type in the HOB list, it will return NULL.
103 If the pointer to the HOB list is NULL, then ASSERT().
105 @param Type The HOB type to return.
107 @return The next instance of a HOB type from the starting HOB.
118 HobList
= GetHobList ();
119 return GetNextHob (Type
, HobList
);
123 Returns the next instance of the matched GUID HOB from the starting HOB.
125 This function searches the first instance of a HOB from the starting HOB pointer.
126 Such HOB should satisfy two conditions:
127 its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
128 If there does not exist such HOB from the starting HOB pointer, it will return NULL.
129 Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
130 to extract the data section and its size information, respectively.
131 In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
132 unconditionally: it returns HobStart back if HobStart itself meets the requirement;
133 caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
135 If Guid is NULL, then ASSERT().
136 If HobStart is NULL, then ASSERT().
138 @param Guid The GUID to match with in the HOB list.
139 @param HobStart A pointer to a Guid.
141 @return The next instance of the matched GUID HOB from the starting HOB.
147 IN CONST EFI_GUID
*Guid
,
148 IN CONST VOID
*HobStart
151 EFI_PEI_HOB_POINTERS GuidHob
;
153 GuidHob
.Raw
= (UINT8
*) HobStart
;
154 while ((GuidHob
.Raw
= GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION
, GuidHob
.Raw
)) != NULL
) {
155 if (CompareGuid (Guid
, &GuidHob
.Guid
->Name
)) {
158 GuidHob
.Raw
= GET_NEXT_HOB (GuidHob
);
164 Returns the first instance of the matched GUID HOB among the whole HOB list.
166 This function searches the first instance of a HOB among the whole HOB list.
167 Such HOB should satisfy two conditions:
168 its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
169 If there does not exist such HOB from the starting HOB pointer, it will return NULL.
170 Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
171 to extract the data section and its size information, respectively.
173 If the pointer to the HOB list is NULL, then ASSERT().
174 If Guid is NULL, then ASSERT().
176 @param Guid The GUID to match with in the HOB list.
178 @return The first instance of the matched GUID HOB among the whole HOB list.
184 IN CONST EFI_GUID
*Guid
189 HobList
= GetHobList ();
190 return GetNextGuidHob (Guid
, HobList
);
194 Get the system boot mode from the HOB list.
196 This function returns the system boot mode information from the
197 PHIT HOB in HOB list.
199 If the pointer to the HOB list is NULL, then ASSERT().
203 @return The Boot Mode.
213 EFI_BOOT_MODE BootMode
;
215 Status
= PeiServicesGetBootMode (&BootMode
);
216 ASSERT_EFI_ERROR (Status
);
222 Adds a new HOB to the HOB List.
224 This internal function enables PEIMs to create various types of HOBs.
226 @param Type Type of the new HOB.
227 @param Length Length of the new HOB to allocate.
229 @retval NULL The HOB could not be allocated.
230 @retval others The address of new HOB.
235 InternalPeiCreateHob (
243 Status
= PeiServicesCreateHob (Type
, Length
, &Hob
);
244 if (EFI_ERROR (Status
)) {
248 // Assume the process of HOB building is always successful.
250 ASSERT (Hob
!= NULL
);
255 Builds a HOB for a loaded PE32 module.
257 This function builds a HOB for a loaded PE32 module.
258 It can only be invoked during PEI phase;
259 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
261 If ModuleName is NULL, then ASSERT().
262 If there is no additional space for HOB creation, then ASSERT().
264 @param ModuleName The GUID File Name of the module.
265 @param MemoryAllocationModule The 64 bit physical address of the module.
266 @param ModuleLength The length of the module in bytes.
267 @param EntryPoint The 64 bit physical address of the module entry point.
273 IN CONST EFI_GUID
*ModuleName
,
274 IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule
,
275 IN UINT64 ModuleLength
,
276 IN EFI_PHYSICAL_ADDRESS EntryPoint
279 EFI_HOB_MEMORY_ALLOCATION_MODULE
*Hob
;
281 ASSERT (((MemoryAllocationModule
& (EFI_PAGE_SIZE
- 1)) == 0) &&
282 ((ModuleLength
& (EFI_PAGE_SIZE
- 1)) == 0));
284 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, (UINT16
) sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE
));
289 CopyGuid (&(Hob
->MemoryAllocationHeader
.Name
), &gEfiHobMemoryAllocModuleGuid
);
290 Hob
->MemoryAllocationHeader
.MemoryBaseAddress
= MemoryAllocationModule
;
291 Hob
->MemoryAllocationHeader
.MemoryLength
= ModuleLength
;
292 Hob
->MemoryAllocationHeader
.MemoryType
= EfiBootServicesCode
;
295 // Zero the reserved space to match HOB spec
297 ZeroMem (Hob
->MemoryAllocationHeader
.Reserved
, sizeof (Hob
->MemoryAllocationHeader
.Reserved
));
299 CopyGuid (&Hob
->ModuleName
, ModuleName
);
300 Hob
->EntryPoint
= EntryPoint
;
304 Builds a HOB that describes a chunk of system memory.
306 This function builds a HOB that describes a chunk of system memory.
307 It can only be invoked during PEI phase;
308 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
310 If there is no additional space for HOB creation, then ASSERT().
312 @param ResourceType The type of resource described by this HOB.
313 @param ResourceAttribute The resource attributes of the memory described by this HOB.
314 @param PhysicalStart The 64 bit physical address of memory described by this HOB.
315 @param NumberOfBytes The length of the memory described by this HOB in bytes.
320 BuildResourceDescriptorHob (
321 IN EFI_RESOURCE_TYPE ResourceType
,
322 IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
,
323 IN EFI_PHYSICAL_ADDRESS PhysicalStart
,
324 IN UINT64 NumberOfBytes
327 EFI_HOB_RESOURCE_DESCRIPTOR
*Hob
;
329 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR
, (UINT16
) sizeof (EFI_HOB_RESOURCE_DESCRIPTOR
));
334 Hob
->ResourceType
= ResourceType
;
335 Hob
->ResourceAttribute
= ResourceAttribute
;
336 Hob
->PhysicalStart
= PhysicalStart
;
337 Hob
->ResourceLength
= NumberOfBytes
;
341 Builds a customized HOB tagged with a GUID for identification and returns
342 the start address of GUID HOB data.
344 This function builds a customized HOB tagged with a GUID for identification
345 and returns the start address of GUID HOB data so that caller can fill the customized data.
346 The HOB Header and Name field is already stripped.
347 It can only be invoked during PEI phase;
348 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
350 If Guid is NULL, then ASSERT().
351 If there is no additional space for HOB creation, then ASSERT().
352 If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
353 HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.
355 @param Guid The GUID to tag the customized HOB.
356 @param DataLength The size of the data payload for the GUID HOB.
358 @retval NULL The GUID HOB could not be allocated.
359 @retval others The start address of GUID HOB data.
365 IN CONST EFI_GUID
*Guid
,
369 EFI_HOB_GUID_TYPE
*Hob
;
372 // Make sure Guid is valid
374 ASSERT (Guid
!= NULL
);
377 // Make sure that data length is not too long.
379 ASSERT (DataLength
<= (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE
)));
381 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_GUID_EXTENSION
, (UINT16
) (sizeof (EFI_HOB_GUID_TYPE
) + DataLength
));
385 CopyGuid (&Hob
->Name
, Guid
);
390 Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB
391 data field, and returns the start address of the GUID HOB data.
393 This function builds a customized HOB tagged with a GUID for identification and copies the input
394 data to the HOB data field and returns the start address of the GUID HOB data. It can only be
395 invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
396 The HOB Header and Name field is already stripped.
397 It can only be invoked during PEI phase;
398 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
400 If Guid is NULL, then ASSERT().
401 If Data is NULL and DataLength > 0, then ASSERT().
402 If there is no additional space for HOB creation, then ASSERT().
403 If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
404 HobLength is UINT16 and multiples of 8 bytes, so the max HobLength is 0xFFF8.
406 @param Guid The GUID to tag the customized HOB.
407 @param Data The data to be copied into the data field of the GUID HOB.
408 @param DataLength The size of the data payload for the GUID HOB.
410 @retval NULL The GUID HOB could not be allocated.
411 @retval others The start address of GUID HOB data.
417 IN CONST EFI_GUID
*Guid
,
424 ASSERT (Data
!= NULL
|| DataLength
== 0);
426 HobData
= BuildGuidHob (Guid
, DataLength
);
427 if (HobData
== NULL
) {
431 return CopyMem (HobData
, Data
, DataLength
);
435 Builds a Firmware Volume HOB.
437 This function builds a Firmware Volume HOB.
438 It can only be invoked during PEI phase;
439 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
441 If there is no additional space for HOB creation, then ASSERT().
443 @param BaseAddress The base address of the Firmware Volume.
444 @param Length The size of the Firmware Volume in bytes.
450 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
454 EFI_HOB_FIRMWARE_VOLUME
*Hob
;
456 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_FV
, (UINT16
) sizeof (EFI_HOB_FIRMWARE_VOLUME
));
461 Hob
->BaseAddress
= BaseAddress
;
462 Hob
->Length
= Length
;
466 Builds a EFI_HOB_TYPE_FV2 HOB.
468 This function builds a EFI_HOB_TYPE_FV2 HOB.
469 It can only be invoked during PEI phase;
470 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
472 If there is no additional space for HOB creation, then ASSERT().
474 @param BaseAddress The base address of the Firmware Volume.
475 @param Length The size of the Firmware Volume in bytes.
476 @param FvName The name of the Firmware Volume.
477 @param FileName The name of the file.
483 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
485 IN CONST EFI_GUID
*FvName
,
486 IN CONST EFI_GUID
*FileName
489 EFI_HOB_FIRMWARE_VOLUME2
*Hob
;
491 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_FV2
, (UINT16
) sizeof (EFI_HOB_FIRMWARE_VOLUME2
));
496 Hob
->BaseAddress
= BaseAddress
;
497 Hob
->Length
= Length
;
498 CopyGuid (&Hob
->FvName
, FvName
);
499 CopyGuid (&Hob
->FileName
, FileName
);
503 Builds a Capsule Volume HOB.
505 This function builds a Capsule Volume HOB.
506 It can only be invoked during PEI phase;
507 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
509 If the platform does not support Capsule Volume HOBs, then ASSERT().
510 If there is no additional space for HOB creation, then ASSERT().
512 @param BaseAddress The base address of the Capsule Volume.
513 @param Length The size of the Capsule Volume in bytes.
519 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
523 EFI_HOB_UEFI_CAPSULE
*Hob
;
525 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_UEFI_CAPSULE
, (UINT16
) sizeof (EFI_HOB_UEFI_CAPSULE
));
530 Hob
->BaseAddress
= BaseAddress
;
531 Hob
->Length
= Length
;
535 Builds a HOB for the CPU.
537 This function builds a HOB for the CPU.
538 It can only be invoked during PEI phase;
539 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
541 If there is no additional space for HOB creation, then ASSERT().
543 @param SizeOfMemorySpace The maximum physical memory addressability of the processor.
544 @param SizeOfIoSpace The maximum physical I/O addressability of the processor.
550 IN UINT8 SizeOfMemorySpace
,
551 IN UINT8 SizeOfIoSpace
556 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_CPU
, (UINT16
) sizeof (EFI_HOB_CPU
));
561 Hob
->SizeOfMemorySpace
= SizeOfMemorySpace
;
562 Hob
->SizeOfIoSpace
= SizeOfIoSpace
;
565 // Zero the reserved space to match HOB spec
567 ZeroMem (Hob
->Reserved
, sizeof (Hob
->Reserved
));
571 Builds a HOB for the Stack.
573 This function builds a HOB for the stack.
574 It can only be invoked during PEI phase;
575 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
577 If there is no additional space for HOB creation, then ASSERT().
579 @param BaseAddress The 64 bit physical address of the Stack.
580 @param Length The length of the stack in bytes.
586 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
590 EFI_HOB_MEMORY_ALLOCATION_STACK
*Hob
;
592 ASSERT (((BaseAddress
& (EFI_PAGE_SIZE
- 1)) == 0) &&
593 ((Length
& (EFI_PAGE_SIZE
- 1)) == 0));
595 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, (UINT16
) sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK
));
600 CopyGuid (&(Hob
->AllocDescriptor
.Name
), &gEfiHobMemoryAllocStackGuid
);
601 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
602 Hob
->AllocDescriptor
.MemoryLength
= Length
;
603 Hob
->AllocDescriptor
.MemoryType
= EfiBootServicesData
;
606 // Zero the reserved space to match HOB spec
608 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));
612 Builds a HOB for the BSP store.
614 This function builds a HOB for BSP store.
615 It can only be invoked during PEI phase;
616 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
618 If there is no additional space for HOB creation, then ASSERT().
620 @param BaseAddress The 64 bit physical address of the BSP.
621 @param Length The length of the BSP store in bytes.
622 @param MemoryType The type of memory allocated by this HOB.
628 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
630 IN EFI_MEMORY_TYPE MemoryType
633 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*Hob
;
635 ASSERT (((BaseAddress
& (EFI_PAGE_SIZE
- 1)) == 0) &&
636 ((Length
& (EFI_PAGE_SIZE
- 1)) == 0));
638 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, (UINT16
) sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
));
643 CopyGuid (&(Hob
->AllocDescriptor
.Name
), &gEfiHobMemoryAllocBspStoreGuid
);
644 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
645 Hob
->AllocDescriptor
.MemoryLength
= Length
;
646 Hob
->AllocDescriptor
.MemoryType
= MemoryType
;
649 // Zero the reserved space to match HOB spec
651 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));
655 Builds a HOB for the memory allocation.
657 This function builds a HOB for the memory allocation.
658 It can only be invoked during PEI phase;
659 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
661 If there is no additional space for HOB creation, then ASSERT().
663 @param BaseAddress The 64 bit physical address of the memory.
664 @param Length The length of the memory allocation in bytes.
665 @param MemoryType The type of memory allocated by this HOB.
670 BuildMemoryAllocationHob (
671 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
673 IN EFI_MEMORY_TYPE MemoryType
676 EFI_HOB_MEMORY_ALLOCATION
*Hob
;
678 ASSERT (((BaseAddress
& (EFI_PAGE_SIZE
- 1)) == 0) &&
679 ((Length
& (EFI_PAGE_SIZE
- 1)) == 0));
681 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, (UINT16
) sizeof (EFI_HOB_MEMORY_ALLOCATION
));
686 ZeroMem (&(Hob
->AllocDescriptor
.Name
), sizeof (EFI_GUID
));
687 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
688 Hob
->AllocDescriptor
.MemoryLength
= Length
;
689 Hob
->AllocDescriptor
.MemoryType
= MemoryType
;
691 // Zero the reserved space to match HOB spec
693 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));