4 Copyright (c) 2006 - 2007, Intel Corporation<BR>
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
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.
20 Returns the pointer to the HOB list.
22 This function returns the pointer to first HOB in the list.
24 @return The pointer to the HOB list.
36 Status
= PeiServicesGetHobList (&HobList
);
37 ASSERT_EFI_ERROR (Status
);
38 ASSERT (HobList
!= NULL
);
44 Returns the next instance of a HOB type from the starting HOB.
46 This function searches the first instance of a HOB type from the starting HOB pointer.
47 If there does not exist such HOB type from the starting HOB pointer, it will return NULL.
48 In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
49 unconditionally: it returns HobStart back if HobStart itself meets the requirement;
50 caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
51 If HobStart is NULL, then ASSERT().
53 @param Type The HOB type to return.
54 @param HobStart The starting HOB pointer to search from.
56 @return The next instance of a HOB type from the starting HOB.
63 IN CONST VOID
*HobStart
66 EFI_PEI_HOB_POINTERS Hob
;
68 ASSERT (HobStart
!= NULL
);
70 Hob
.Raw
= (UINT8
*) HobStart
;
72 // Parse the HOB list until end of list or matching type is found.
74 while (!END_OF_HOB_LIST (Hob
)) {
75 if (Hob
.Header
->HobType
== Type
) {
78 Hob
.Raw
= GET_NEXT_HOB (Hob
);
84 Returns the first instance of a HOB type among the whole HOB list.
86 This function searches the first instance of a HOB type among the whole HOB list.
87 If there does not exist such HOB type in the HOB list, it will return NULL.
89 @param Type The HOB type to return.
91 @return The next instance of a HOB type from the starting HOB.
102 HobList
= GetHobList ();
103 return GetNextHob (Type
, HobList
);
107 This function searches the first instance of a HOB from the starting HOB pointer.
108 Such HOB should satisfy two conditions:
109 its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
110 If there does not exist such HOB from the starting HOB pointer, it will return NULL.
111 Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
112 to extract the data section and its size info respectively.
113 In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
114 unconditionally: it returns HobStart back if HobStart itself meets the requirement;
115 caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
116 If Guid is NULL, then ASSERT().
117 If HobStart is NULL, then ASSERT().
119 @param Guid The GUID to match with in the HOB list.
120 @param HobStart A pointer to a Guid.
122 @return The next instance of the matched GUID HOB from the starting HOB.
128 IN CONST EFI_GUID
*Guid
,
129 IN CONST VOID
*HobStart
132 EFI_PEI_HOB_POINTERS GuidHob
;
134 GuidHob
.Raw
= (UINT8
*) HobStart
;
135 while ((GuidHob
.Raw
= GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION
, GuidHob
.Raw
)) != NULL
) {
136 if (CompareGuid (Guid
, &GuidHob
.Guid
->Name
)) {
139 GuidHob
.Raw
= GET_NEXT_HOB (GuidHob
);
145 This function searches the first instance of a HOB among the whole HOB list.
146 Such HOB should satisfy two conditions:
147 its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
148 If there does not exist such HOB from the starting HOB pointer, it will return NULL.
149 Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
150 to extract the data section and its size info respectively.
151 If Guid is NULL, then ASSERT().
153 @param Guid The GUID to match with in the HOB list.
155 @return The first instance of the matched GUID HOB among the whole HOB list.
161 IN CONST EFI_GUID
*Guid
166 HobList
= GetHobList ();
167 return GetNextGuidHob (Guid
, HobList
);
171 Get the Boot Mode from the HOB list.
173 This function returns the system boot mode information from the
174 PHIT HOB in HOB list.
178 @return The Boot Mode.
188 EFI_BOOT_MODE BootMode
;
190 Status
= PeiServicesGetBootMode (&BootMode
);
191 ASSERT_EFI_ERROR (Status
);
197 Adds a new HOB to the HOB List.
199 This internal function enables PEIMs to create various types of HOBs.
201 @param Type Type of the new HOB.
202 @param Length Length of the new HOB to allocate.
204 @return The address of new HOB.
209 InternalPeiCreateHob (
217 Status
= PeiServicesCreateHob (Type
, Length
, &Hob
);
219 // Assume the process of HOB building is always successful.
221 ASSERT_EFI_ERROR (Status
);
226 Builds a HOB for a loaded PE32 module.
228 This function builds a HOB for a loaded PE32 module.
229 It can only be invoked during PEI phase;
230 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
231 If ModuleName is NULL, then ASSERT().
232 If there is no additional space for HOB creation, then ASSERT().
234 @param ModuleName The GUID File Name of the module.
235 @param MemoryAllocationModule The 64 bit physical address of the module.
236 @param ModuleLength The length of the module in bytes.
237 @param EntryPoint The 64 bit physical address of the module's entry point.
243 IN CONST EFI_GUID
*ModuleName
,
244 IN EFI_PHYSICAL_ADDRESS MemoryAllocationModule
,
245 IN UINT64 ModuleLength
,
246 IN EFI_PHYSICAL_ADDRESS EntryPoint
249 EFI_HOB_MEMORY_ALLOCATION_MODULE
*Hob
;
251 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, sizeof (EFI_HOB_MEMORY_ALLOCATION_MODULE
));
253 CopyGuid (&(Hob
->MemoryAllocationHeader
.Name
), &gEfiHobMemoryAllocModuleGuid
);
254 Hob
->MemoryAllocationHeader
.MemoryBaseAddress
= MemoryAllocationModule
;
255 Hob
->MemoryAllocationHeader
.MemoryLength
= ModuleLength
;
256 Hob
->MemoryAllocationHeader
.MemoryType
= EfiBootServicesCode
;
259 // Zero the reserved space to match HOB spec
261 ZeroMem (Hob
->MemoryAllocationHeader
.Reserved
, sizeof (Hob
->MemoryAllocationHeader
.Reserved
));
263 CopyGuid (&Hob
->ModuleName
, ModuleName
);
264 Hob
->EntryPoint
= EntryPoint
;
268 Builds a HOB that describes a chunk of system memory.
270 This function builds a HOB that describes a chunk of system memory.
271 It can only be invoked during PEI phase;
272 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
273 If there is no additional space for HOB creation, then ASSERT().
275 @param ResourceType The type of resource described by this HOB.
276 @param ResourceAttribute The resource attributes of the memory described by this HOB.
277 @param PhysicalStart The 64 bit physical address of memory described by this HOB.
278 @param NumberOfBytes The length of the memory described by this HOB in bytes.
283 BuildResourceDescriptorHob (
284 IN EFI_RESOURCE_TYPE ResourceType
,
285 IN EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
,
286 IN EFI_PHYSICAL_ADDRESS PhysicalStart
,
287 IN UINT64 NumberOfBytes
290 EFI_HOB_RESOURCE_DESCRIPTOR
*Hob
;
292 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_RESOURCE_DESCRIPTOR
, sizeof (EFI_HOB_RESOURCE_DESCRIPTOR
));
294 Hob
->ResourceType
= ResourceType
;
295 Hob
->ResourceAttribute
= ResourceAttribute
;
296 Hob
->PhysicalStart
= PhysicalStart
;
297 Hob
->ResourceLength
= NumberOfBytes
;
301 Builds a GUID HOB with a certain data length.
303 This function builds a customized HOB tagged with a GUID for identification
304 and returns the start address of GUID HOB data so that caller can fill the customized data.
305 The HOB Header and Name field is already stripped.
306 It can only be invoked during PEI phase;
307 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
308 If Guid is NULL, then ASSERT().
309 If there is no additional space for HOB creation, then ASSERT().
310 If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
312 @param Guid The GUID to tag the customized HOB.
313 @param DataLength The size of the data payload for the GUID HOB.
315 @return The start address of GUID HOB data.
321 IN CONST EFI_GUID
*Guid
,
325 EFI_HOB_GUID_TYPE
*Hob
;
328 // Make sure that data length is not too long.
330 ASSERT (DataLength
<= (0xffff - sizeof (EFI_HOB_GUID_TYPE
)));
332 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_GUID_EXTENSION
, (UINT16
) (sizeof (EFI_HOB_GUID_TYPE
) + DataLength
));
333 CopyGuid (&Hob
->Name
, Guid
);
338 Copies a data buffer to a newly-built HOB.
340 This function builds a customized HOB tagged with a GUID for identification,
341 copies the input data to the HOB data field and returns the start address of the GUID HOB data.
342 The HOB Header and Name field is already stripped.
343 It can only be invoked during PEI phase;
344 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
345 If Guid is NULL, then ASSERT().
346 If Data is NULL and DataLength > 0, then ASSERT().
347 If there is no additional space for HOB creation, then ASSERT().
348 If DataLength >= (0x10000 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT().
350 @param Guid The GUID to tag the customized HOB.
351 @param Data The data to be copied into the data field of the GUID HOB.
352 @param DataLength The size of the data payload for the GUID HOB.
354 @return The start address of GUID HOB data.
360 IN CONST EFI_GUID
*Guid
,
367 ASSERT (Data
!= NULL
|| DataLength
== 0);
369 HobData
= BuildGuidHob (Guid
, DataLength
);
371 return CopyMem (HobData
, Data
, DataLength
);
375 Builds a Firmware Volume HOB.
377 This function builds a Firmware Volume HOB.
378 It can only be invoked during PEI phase;
379 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
380 If there is no additional space for HOB creation, then ASSERT().
382 @param BaseAddress The base address of the Firmware Volume.
383 @param Length The size of the Firmware Volume in bytes.
389 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
393 EFI_HOB_FIRMWARE_VOLUME
*Hob
;
395 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_FV
, sizeof (EFI_HOB_FIRMWARE_VOLUME
));
397 Hob
->BaseAddress
= BaseAddress
;
398 Hob
->Length
= Length
;
402 Builds a Capsule Volume HOB.
404 This function builds a Capsule Volume HOB.
405 It can only be invoked during PEI phase;
406 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
407 If there is no additional space for HOB creation, then ASSERT().
409 @param BaseAddress The base address of the Capsule Volume.
410 @param Length The size of the Capsule Volume in bytes.
416 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
420 EFI_HOB_CAPSULE_VOLUME
*Hob
;
422 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_CV
, sizeof (EFI_HOB_CAPSULE_VOLUME
));
424 Hob
->BaseAddress
= BaseAddress
;
425 Hob
->Length
= Length
;
429 Builds a HOB for the CPU.
431 This function builds a HOB for the CPU.
432 It can only be invoked during PEI phase;
433 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
434 If there is no additional space for HOB creation, then ASSERT().
436 @param SizeOfMemorySpace The maximum physical memory addressability of the processor.
437 @param SizeOfIoSpace The maximum physical I/O addressability of the processor.
443 IN UINT8 SizeOfMemorySpace
,
444 IN UINT8 SizeOfIoSpace
449 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_CPU
, sizeof (EFI_HOB_CPU
));
451 Hob
->SizeOfMemorySpace
= SizeOfMemorySpace
;
452 Hob
->SizeOfIoSpace
= SizeOfIoSpace
;
455 // Zero the reserved space to match HOB spec
457 ZeroMem (Hob
->Reserved
, sizeof (Hob
->Reserved
));
461 Builds a HOB for the Stack.
463 This function builds a HOB for the stack.
464 It can only be invoked during PEI phase;
465 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
466 If there is no additional space for HOB creation, then ASSERT().
468 @param BaseAddress The 64 bit physical address of the Stack.
469 @param Length The length of the stack in bytes.
475 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
479 EFI_HOB_MEMORY_ALLOCATION_STACK
*Hob
;
481 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, sizeof (EFI_HOB_MEMORY_ALLOCATION_STACK
));
483 CopyGuid (&(Hob
->AllocDescriptor
.Name
), &gEfiHobMemoryAllocStackGuid
);
484 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
485 Hob
->AllocDescriptor
.MemoryLength
= Length
;
486 Hob
->AllocDescriptor
.MemoryType
= EfiConventionalMemory
;
489 // Zero the reserved space to match HOB spec
491 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));
495 Builds a HOB for the BSP store.
497 This function builds a HOB for BSP store.
498 It can only be invoked during PEI phase;
499 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
500 If there is no additional space for HOB creation, then ASSERT().
502 @param BaseAddress The 64 bit physical address of the BSP.
503 @param Length The length of the BSP store in bytes.
504 @param MemoryType Type of memory allocated by this HOB.
510 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
512 IN EFI_MEMORY_TYPE MemoryType
515 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*Hob
;
517 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, sizeof (EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
));
519 CopyGuid (&(Hob
->AllocDescriptor
.Name
), &gEfiHobMemoryAllocBspStoreGuid
);
520 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
521 Hob
->AllocDescriptor
.MemoryLength
= Length
;
522 Hob
->AllocDescriptor
.MemoryType
= MemoryType
;
525 // Zero the reserved space to match HOB spec
527 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));
531 Builds a HOB for the memory allocation.
533 This function builds a HOB for the memory allocation.
534 It can only be invoked during PEI phase;
535 for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
536 If there is no additional space for HOB creation, then ASSERT().
538 @param BaseAddress The 64 bit physical address of the memory.
539 @param Length The length of the memory allocation in bytes.
540 @param MemoryType Type of memory allocated by this HOB.
545 BuildMemoryAllocationHob (
546 IN EFI_PHYSICAL_ADDRESS BaseAddress
,
548 IN EFI_MEMORY_TYPE MemoryType
551 EFI_HOB_MEMORY_ALLOCATION
*Hob
;
553 Hob
= InternalPeiCreateHob (EFI_HOB_TYPE_MEMORY_ALLOCATION
, sizeof (EFI_HOB_MEMORY_ALLOCATION
));
555 ZeroMem (&(Hob
->AllocDescriptor
.Name
), sizeof (EFI_GUID
));
556 Hob
->AllocDescriptor
.MemoryBaseAddress
= BaseAddress
;
557 Hob
->AllocDescriptor
.MemoryLength
= Length
;
558 Hob
->AllocDescriptor
.MemoryType
= MemoryType
;
560 // Zero the reserved space to match HOB spec
562 ZeroMem (Hob
->AllocDescriptor
.Reserved
, sizeof (Hob
->AllocDescriptor
.Reserved
));