2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
7 @par Revision Reference:
16 // HobType of EFI_HOB_GENERIC_HEADER.
18 #define EFI_HOB_TYPE_HANDOFF 0x0001
19 #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
20 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
21 #define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
22 #define EFI_HOB_TYPE_FV 0x0005
23 #define EFI_HOB_TYPE_CPU 0x0006
24 #define EFI_HOB_TYPE_MEMORY_POOL 0x0007
25 #define EFI_HOB_TYPE_FV2 0x0009
26 #define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A
27 #define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B
28 #define EFI_HOB_TYPE_FV3 0x000C
29 #define EFI_HOB_TYPE_UNUSED 0xFFFE
30 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
33 /// Describes the format and size of the data inside the HOB.
34 /// All HOBs must contain this generic HOB header.
38 /// Identifies the HOB data structure type.
42 /// The length in bytes of the HOB.
46 /// This field must always be set to zero.
49 } EFI_HOB_GENERIC_HEADER
;
53 /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
55 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
58 /// Contains general state information used by the HOB producer phase.
59 /// This HOB must be the first one in the HOB list.
63 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
65 EFI_HOB_GENERIC_HEADER Header
;
67 /// The version number pertaining to the PHIT HOB definition.
68 /// This value is four bytes in length to provide an 8-byte aligned entry
69 /// when it is combined with the 4-byte BootMode.
73 /// The system boot mode as determined during the HOB producer phase.
75 EFI_BOOT_MODE BootMode
;
77 /// The highest address location of memory that is allocated for use by the HOB producer
78 /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
80 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
82 /// The lowest address location of memory that is allocated for use by the HOB producer phase.
84 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
86 /// The highest address location of free memory that is currently available
87 /// for use by the HOB producer phase.
89 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
91 /// The lowest address location of free memory that is available for use by the HOB producer phase.
93 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
95 /// The end of the HOB list.
97 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
98 } EFI_HOB_HANDOFF_INFO_TABLE
;
101 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
102 /// various attributes of the logical memory allocation. The type field will be used for
103 /// subsequent inclusion in the UEFI memory map.
107 /// A GUID that defines the memory allocation region's type and purpose, as well as
108 /// other fields within the memory allocation HOB. This GUID is used to define the
109 /// additional data within the HOB that may be present for the memory allocation HOB.
110 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
116 /// The base address of memory allocated by this HOB. Type
117 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
120 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
123 /// The length in bytes of memory allocated by this HOB.
128 /// Defines the type of memory allocated by this HOB. The memory type definition
129 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
130 /// in AllocatePages() in the UEFI 2.0 specification.
132 EFI_MEMORY_TYPE MemoryType
;
135 /// Padding for Itanium processor family
138 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
141 /// Describes all memory ranges used during the HOB producer
142 /// phase that exist outside the HOB list. This HOB type
143 /// describes how memory is used, not the physical attributes of memory.
147 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
149 EFI_HOB_GENERIC_HEADER Header
;
151 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
152 /// various attributes of the logical memory allocation.
154 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
156 // Additional data pertaining to the "Name" Guid memory
159 } EFI_HOB_MEMORY_ALLOCATION
;
163 /// Describes the memory stack that is produced by the HOB producer
164 /// phase and upon which all post-memory-installed executable
165 /// content in the HOB producer phase is executing.
169 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
171 EFI_HOB_GENERIC_HEADER Header
;
173 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
174 /// various attributes of the logical memory allocation.
176 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
177 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
180 /// Defines the location of the boot-strap
181 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
182 /// This HOB is valid for the Itanium processor family only
183 /// register overflow store.
187 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
189 EFI_HOB_GENERIC_HEADER Header
;
191 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
192 /// various attributes of the logical memory allocation.
194 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
195 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
198 /// Defines the location and entry point of the HOB consumer phase.
202 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
204 EFI_HOB_GENERIC_HEADER Header
;
206 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
207 /// various attributes of the logical memory allocation.
209 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
211 /// The GUID specifying the values of the firmware file system name
212 /// that contains the HOB consumer phase component.
216 /// The address of the memory-mapped firmware volume
217 /// that contains the HOB consumer phase firmware file.
219 EFI_PHYSICAL_ADDRESS EntryPoint
;
220 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
223 /// The resource type.
225 typedef UINT32 EFI_RESOURCE_TYPE
;
228 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
230 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
231 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
232 #define EFI_RESOURCE_IO 0x00000002
233 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
234 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
235 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
236 #define EFI_RESOURCE_IO_RESERVED 0x00000006
237 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
240 /// A type of recount attribute type.
242 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
245 // These types can be ORed together as needed.
247 // The following attributes are used to describe settings
249 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
250 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
251 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
252 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
254 // This is typically used as memory cacheability attribute today.
255 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED
256 // as Physical write protected attribute, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED
257 // means Memory cacheability attribute: The memory supports being programmed with
258 // a writeprotected cacheable attribute.
260 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
261 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
262 #define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000
264 // The rest of the attributes are used to describe capabilities
266 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
267 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
268 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
269 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
270 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
271 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
272 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
273 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
274 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
275 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
276 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
277 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
278 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
280 // This is typically used as memory cacheability attribute today.
281 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE
282 // as Memory capability attribute: The memory supports being protected from processor
283 // writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:
284 // The memory supports being programmed with a writeprotected cacheable attribute.
286 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
287 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
288 #define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000
290 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000
291 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000
294 // Physical memory relative reliability attribute. This
295 // memory provides higher reliability relative to other
296 // memory in the system. If all memory has the same
297 // reliability, then this bit is not used.
299 #define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000
302 /// Describes the resource properties of all fixed,
303 /// nonrelocatable resource ranges found on the processor
304 /// host bus during the HOB producer phase.
308 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
310 EFI_HOB_GENERIC_HEADER Header
;
312 /// A GUID representing the owner of the resource. This GUID is used by HOB
313 /// consumer phase components to correlate device ownership of a resource.
317 /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
319 EFI_RESOURCE_TYPE ResourceType
;
321 /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
323 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
325 /// The physical start address of the resource region.
327 EFI_PHYSICAL_ADDRESS PhysicalStart
;
329 /// The number of bytes of the resource region.
331 UINT64 ResourceLength
;
332 } EFI_HOB_RESOURCE_DESCRIPTOR
;
335 /// Allows writers of executable content in the HOB producer phase to
336 /// maintain and manage HOBs with specific GUID.
340 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
342 EFI_HOB_GENERIC_HEADER Header
;
344 /// A GUID that defines the contents of this HOB.
348 // Guid specific data goes here
353 /// Details the location of firmware volumes that contain firmware files.
357 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
359 EFI_HOB_GENERIC_HEADER Header
;
361 /// The physical memory-mapped base address of the firmware volume.
363 EFI_PHYSICAL_ADDRESS BaseAddress
;
365 /// The length in bytes of the firmware volume.
368 } EFI_HOB_FIRMWARE_VOLUME
;
371 /// Details the location of a firmware volume that was extracted
372 /// from a file within another firmware volume.
376 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
378 EFI_HOB_GENERIC_HEADER Header
;
380 /// The physical memory-mapped base address of the firmware volume.
382 EFI_PHYSICAL_ADDRESS BaseAddress
;
384 /// The length in bytes of the firmware volume.
388 /// The name of the firmware volume.
392 /// The name of the firmware file that contained this firmware volume.
395 } EFI_HOB_FIRMWARE_VOLUME2
;
398 /// Details the location of a firmware volume that was extracted
399 /// from a file within another firmware volume.
403 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.
405 EFI_HOB_GENERIC_HEADER Header
;
407 /// The physical memory-mapped base address of the firmware volume.
409 EFI_PHYSICAL_ADDRESS BaseAddress
;
411 /// The length in bytes of the firmware volume.
415 /// The authentication status.
417 UINT32 AuthenticationStatus
;
419 /// TRUE if the FV was extracted as a file within another firmware volume.
424 /// The name of the firmware volume.
425 /// Valid only if IsExtractedFv is TRUE.
429 /// The name of the firmware file that contained this firmware volume.
430 /// Valid only if IsExtractedFv is TRUE.
433 } EFI_HOB_FIRMWARE_VOLUME3
;
436 /// Describes processor information, such as address space and I/O space capabilities.
440 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
442 EFI_HOB_GENERIC_HEADER Header
;
444 /// Identifies the maximum physical memory addressability of the processor.
446 UINT8 SizeOfMemorySpace
;
448 /// Identifies the maximum physical I/O addressability of the processor.
452 /// This field will always be set to zero.
459 /// Describes pool memory allocations.
463 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
465 EFI_HOB_GENERIC_HEADER Header
;
466 } EFI_HOB_MEMORY_POOL
;
469 /// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
470 /// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
471 /// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
472 /// sometime after the UEFI UpdateCapsule service invocation with the
473 /// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
477 /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
479 EFI_HOB_GENERIC_HEADER Header
;
482 /// The physical memory-mapped base address of an UEFI capsule. This value is set to
483 /// point to the base of the contiguous memory of the UEFI capsule.
484 /// The length of the contiguous memory in bytes.
486 EFI_PHYSICAL_ADDRESS BaseAddress
;
488 } EFI_HOB_UEFI_CAPSULE
;
491 /// Union of all the possible HOB Types.
494 EFI_HOB_GENERIC_HEADER
*Header
;
495 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
496 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
497 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
498 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
499 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
500 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
501 EFI_HOB_GUID_TYPE
*Guid
;
502 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
503 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
504 EFI_HOB_FIRMWARE_VOLUME3
*FirmwareVolume3
;
506 EFI_HOB_MEMORY_POOL
*Pool
;
507 EFI_HOB_UEFI_CAPSULE
*Capsule
;
509 } EFI_PEI_HOB_POINTERS
;