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
;
52 /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
54 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
57 /// Contains general state information used by the HOB producer phase.
58 /// This HOB must be the first one in the HOB list.
62 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
64 EFI_HOB_GENERIC_HEADER Header
;
66 /// The version number pertaining to the PHIT HOB definition.
67 /// This value is four bytes in length to provide an 8-byte aligned entry
68 /// when it is combined with the 4-byte BootMode.
72 /// The system boot mode as determined during the HOB producer phase.
74 EFI_BOOT_MODE BootMode
;
76 /// The highest address location of memory that is allocated for use by the HOB producer
77 /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
79 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
81 /// The lowest address location of memory that is allocated for use by the HOB producer phase.
83 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
85 /// The highest address location of free memory that is currently available
86 /// for use by the HOB producer phase.
88 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
90 /// The lowest address location of free memory that is available for use by the HOB producer phase.
92 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
94 /// The end of the HOB list.
96 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
97 } EFI_HOB_HANDOFF_INFO_TABLE
;
100 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
101 /// various attributes of the logical memory allocation. The type field will be used for
102 /// subsequent inclusion in the UEFI memory map.
106 /// A GUID that defines the memory allocation region's type and purpose, as well as
107 /// other fields within the memory allocation HOB. This GUID is used to define the
108 /// additional data within the HOB that may be present for the memory allocation HOB.
109 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
115 /// The base address of memory allocated by this HOB. Type
116 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
119 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
122 /// The length in bytes of memory allocated by this HOB.
127 /// Defines the type of memory allocated by this HOB. The memory type definition
128 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
129 /// in AllocatePages() in the UEFI 2.0 specification.
131 EFI_MEMORY_TYPE MemoryType
;
134 /// Padding for Itanium processor family
137 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
140 /// Describes all memory ranges used during the HOB producer
141 /// phase that exist outside the HOB list. This HOB type
142 /// describes how memory is used, not the physical attributes of memory.
146 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
148 EFI_HOB_GENERIC_HEADER Header
;
150 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
151 /// various attributes of the logical memory allocation.
153 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
155 // Additional data pertaining to the "Name" Guid memory
158 } EFI_HOB_MEMORY_ALLOCATION
;
161 /// Describes the memory stack that is produced by the HOB producer
162 /// phase and upon which all post-memory-installed executable
163 /// content in the HOB producer phase is executing.
167 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
169 EFI_HOB_GENERIC_HEADER Header
;
171 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
172 /// various attributes of the logical memory allocation.
174 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
175 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
178 /// Defines the location of the boot-strap
179 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
180 /// This HOB is valid for the Itanium processor family only
181 /// register overflow store.
185 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
187 EFI_HOB_GENERIC_HEADER Header
;
189 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
190 /// various attributes of the logical memory allocation.
192 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
193 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
196 /// Defines the location and entry point of the HOB consumer phase.
200 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
202 EFI_HOB_GENERIC_HEADER Header
;
204 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
205 /// various attributes of the logical memory allocation.
207 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
209 /// The GUID specifying the values of the firmware file system name
210 /// that contains the HOB consumer phase component.
214 /// The address of the memory-mapped firmware volume
215 /// that contains the HOB consumer phase firmware file.
217 EFI_PHYSICAL_ADDRESS EntryPoint
;
218 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
221 /// The resource type.
223 typedef UINT32 EFI_RESOURCE_TYPE
;
226 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
228 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
229 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
230 #define EFI_RESOURCE_IO 0x00000002
231 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
232 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
233 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
234 #define EFI_RESOURCE_IO_RESERVED 0x00000006
236 // BZ3937_EFI_RESOURCE_MEMORY_UNACCEPTED is defined for unaccepted memory.
237 // But this defitinion has not been officially in the PI spec. Base
238 // on the code-first we define BZ3937_EFI_RESOURCE_MEMORY_UNACCEPTED at
239 // MdeModulePkg/Include/Pi/PrePiHob.h and update EFI_RESOURCE_MAX_MEMORY_TYPE
240 // to 8. After BZ3937_EFI_RESOURCE_MEMORY_UNACCEPTED is officially published
241 // in PI spec, we will re-visit here.
243 // #define BZ3937_EFI_RESOURCE_MEMORY_UNACCEPTED 0x00000007
244 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000008
247 /// A type of recount attribute type.
249 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
252 // These types can be ORed together as needed.
254 // The following attributes are used to describe settings
256 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
257 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
258 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
259 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
261 // This is typically used as memory cacheability attribute today.
262 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED
263 // as Physical write protected attribute, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED
264 // means Memory cacheability attribute: The memory supports being programmed with
265 // a writeprotected cacheable attribute.
267 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
268 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
269 #define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000
271 // The rest of the attributes are used to describe capabilities
273 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
274 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
275 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
276 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
277 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
278 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
279 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
280 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
281 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
282 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
283 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
284 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
285 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
287 // This is typically used as memory cacheability attribute today.
288 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE
289 // as Memory capability attribute: The memory supports being protected from processor
290 // writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:
291 // The memory supports being programmed with a writeprotected cacheable attribute.
293 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
294 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
295 #define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000
297 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000
298 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000
301 // Physical memory relative reliability attribute. This
302 // memory provides higher reliability relative to other
303 // memory in the system. If all memory has the same
304 // reliability, then this bit is not used.
306 #define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000
309 /// Describes the resource properties of all fixed,
310 /// nonrelocatable resource ranges found on the processor
311 /// host bus during the HOB producer phase.
315 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
317 EFI_HOB_GENERIC_HEADER Header
;
319 /// A GUID representing the owner of the resource. This GUID is used by HOB
320 /// consumer phase components to correlate device ownership of a resource.
324 /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
326 EFI_RESOURCE_TYPE ResourceType
;
328 /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
330 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
332 /// The physical start address of the resource region.
334 EFI_PHYSICAL_ADDRESS PhysicalStart
;
336 /// The number of bytes of the resource region.
338 UINT64 ResourceLength
;
339 } EFI_HOB_RESOURCE_DESCRIPTOR
;
342 /// Allows writers of executable content in the HOB producer phase to
343 /// maintain and manage HOBs with specific GUID.
347 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
349 EFI_HOB_GENERIC_HEADER Header
;
351 /// A GUID that defines the contents of this HOB.
355 // Guid specific data goes here
360 /// Details the location of firmware volumes that contain firmware files.
364 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
366 EFI_HOB_GENERIC_HEADER Header
;
368 /// The physical memory-mapped base address of the firmware volume.
370 EFI_PHYSICAL_ADDRESS BaseAddress
;
372 /// The length in bytes of the firmware volume.
375 } EFI_HOB_FIRMWARE_VOLUME
;
378 /// Details the location of a firmware volume that was extracted
379 /// from a file within another firmware volume.
383 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
385 EFI_HOB_GENERIC_HEADER Header
;
387 /// The physical memory-mapped base address of the firmware volume.
389 EFI_PHYSICAL_ADDRESS BaseAddress
;
391 /// The length in bytes of the firmware volume.
395 /// The name of the firmware volume.
399 /// The name of the firmware file that contained this firmware volume.
402 } EFI_HOB_FIRMWARE_VOLUME2
;
405 /// Details the location of a firmware volume that was extracted
406 /// from a file within another firmware volume.
410 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.
412 EFI_HOB_GENERIC_HEADER Header
;
414 /// The physical memory-mapped base address of the firmware volume.
416 EFI_PHYSICAL_ADDRESS BaseAddress
;
418 /// The length in bytes of the firmware volume.
422 /// The authentication status.
424 UINT32 AuthenticationStatus
;
426 /// TRUE if the FV was extracted as a file within another firmware volume.
431 /// The name of the firmware volume.
432 /// Valid only if IsExtractedFv is TRUE.
436 /// The name of the firmware file that contained this firmware volume.
437 /// Valid only if IsExtractedFv is TRUE.
440 } EFI_HOB_FIRMWARE_VOLUME3
;
443 /// Describes processor information, such as address space and I/O space capabilities.
447 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
449 EFI_HOB_GENERIC_HEADER Header
;
451 /// Identifies the maximum physical memory addressability of the processor.
453 UINT8 SizeOfMemorySpace
;
455 /// Identifies the maximum physical I/O addressability of the processor.
459 /// This field will always be set to zero.
465 /// Describes pool memory allocations.
469 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
471 EFI_HOB_GENERIC_HEADER Header
;
472 } EFI_HOB_MEMORY_POOL
;
475 /// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
476 /// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
477 /// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
478 /// sometime after the UEFI UpdateCapsule service invocation with the
479 /// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
483 /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
485 EFI_HOB_GENERIC_HEADER Header
;
488 /// The physical memory-mapped base address of an UEFI capsule. This value is set to
489 /// point to the base of the contiguous memory of the UEFI capsule.
490 /// The length of the contiguous memory in bytes.
492 EFI_PHYSICAL_ADDRESS BaseAddress
;
494 } EFI_HOB_UEFI_CAPSULE
;
497 /// Union of all the possible HOB Types.
500 EFI_HOB_GENERIC_HEADER
*Header
;
501 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
502 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
503 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
504 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
505 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
506 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
507 EFI_HOB_GUID_TYPE
*Guid
;
508 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
509 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
510 EFI_HOB_FIRMWARE_VOLUME3
*FirmwareVolume3
;
512 EFI_HOB_MEMORY_POOL
*Pool
;
513 EFI_HOB_UEFI_CAPSULE
*Capsule
;
515 } EFI_PEI_HOB_POINTERS
;