2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 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.
13 @par Revision Reference:
22 // HobType of EFI_HOB_GENERIC_HEADER.
24 #define EFI_HOB_TYPE_HANDOFF 0x0001
25 #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002
26 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003
27 #define EFI_HOB_TYPE_GUID_EXTENSION 0x0004
28 #define EFI_HOB_TYPE_FV 0x0005
29 #define EFI_HOB_TYPE_CPU 0x0006
30 #define EFI_HOB_TYPE_MEMORY_POOL 0x0007
31 #define EFI_HOB_TYPE_FV2 0x0009
32 #define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A
33 #define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B
34 #define EFI_HOB_TYPE_FV3 0x000C
35 #define EFI_HOB_TYPE_UNUSED 0xFFFE
36 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
39 /// Describes the format and size of the data inside the HOB.
40 /// All HOBs must contain this generic HOB header.
44 /// Identifies the HOB data structure type.
48 /// The length in bytes of the HOB.
52 /// This field must always be set to zero.
55 } EFI_HOB_GENERIC_HEADER
;
59 /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
61 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
64 /// Contains general state information used by the HOB producer phase.
65 /// This HOB must be the first one in the HOB list.
69 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
71 EFI_HOB_GENERIC_HEADER Header
;
73 /// The version number pertaining to the PHIT HOB definition.
74 /// This value is four bytes in length to provide an 8-byte aligned entry
75 /// when it is combined with the 4-byte BootMode.
79 /// The system boot mode as determined during the HOB producer phase.
81 EFI_BOOT_MODE BootMode
;
83 /// The highest address location of memory that is allocated for use by the HOB producer
84 /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
86 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
88 /// The lowest address location of memory that is allocated for use by the HOB producer phase.
90 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
92 /// The highest address location of free memory that is currently available
93 /// for use by the HOB producer phase.
95 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
97 /// The lowest address location of free memory that is available for use by the HOB producer phase.
99 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
101 /// The end of the HOB list.
103 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
104 } EFI_HOB_HANDOFF_INFO_TABLE
;
107 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
108 /// various attributes of the logical memory allocation. The type field will be used for
109 /// subsequent inclusion in the UEFI memory map.
113 /// A GUID that defines the memory allocation region's type and purpose, as well as
114 /// other fields within the memory allocation HOB. This GUID is used to define the
115 /// additional data within the HOB that may be present for the memory allocation HOB.
116 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
122 /// The base address of memory allocated by this HOB. Type
123 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
126 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
129 /// The length in bytes of memory allocated by this HOB.
134 /// Defines the type of memory allocated by this HOB. The memory type definition
135 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
136 /// in AllocatePages() in the UEFI 2.0 specification.
138 EFI_MEMORY_TYPE MemoryType
;
141 /// Padding for Itanium processor family
144 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
147 /// Describes all memory ranges used during the HOB producer
148 /// phase that exist outside the HOB list. This HOB type
149 /// describes how memory is used, not the physical attributes of memory.
153 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
155 EFI_HOB_GENERIC_HEADER Header
;
157 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
158 /// various attributes of the logical memory allocation.
160 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
162 // Additional data pertaining to the "Name" Guid memory
165 } EFI_HOB_MEMORY_ALLOCATION
;
169 /// Describes the memory stack that is produced by the HOB producer
170 /// phase and upon which all post-memory-installed executable
171 /// content in the HOB producer phase is executing.
175 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
177 EFI_HOB_GENERIC_HEADER Header
;
179 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
180 /// various attributes of the logical memory allocation.
182 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
183 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
186 /// Defines the location of the boot-strap
187 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
188 /// This HOB is valid for the Itanium processor family only
189 /// register overflow store.
193 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
195 EFI_HOB_GENERIC_HEADER Header
;
197 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
198 /// various attributes of the logical memory allocation.
200 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
201 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
204 /// Defines the location and entry point of the HOB consumer phase.
208 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
210 EFI_HOB_GENERIC_HEADER Header
;
212 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
213 /// various attributes of the logical memory allocation.
215 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
217 /// The GUID specifying the values of the firmware file system name
218 /// that contains the HOB consumer phase component.
222 /// The address of the memory-mapped firmware volume
223 /// that contains the HOB consumer phase firmware file.
225 EFI_PHYSICAL_ADDRESS EntryPoint
;
226 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
229 /// The resource type.
231 typedef UINT32 EFI_RESOURCE_TYPE
;
234 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
236 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
237 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
238 #define EFI_RESOURCE_IO 0x00000002
239 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
240 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
241 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
242 #define EFI_RESOURCE_IO_RESERVED 0x00000006
243 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
246 /// A type of recount attribute type.
248 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
251 // These types can be ORed together as needed.
253 // The following attributes are used to describe settings
255 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
256 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
257 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
258 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
260 // This is typically used as memory cacheability attribute today.
261 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED
262 // as Physical write protected attribute, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED
263 // means Memory cacheability attribute: The memory supports being programmed with
264 // a writeprotected cacheable attribute.
266 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
267 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
268 #define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000
270 // The rest of the attributes are used to describe capabilities
272 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
273 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
274 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
275 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
276 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
277 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
278 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
279 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
280 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
281 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
282 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
283 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
284 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
286 // This is typically used as memory cacheability attribute today.
287 // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE
288 // as Memory capability attribute: The memory supports being protected from processor
289 // writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:
290 // The memory supports being programmed with a writeprotected cacheable attribute.
292 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
293 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
294 #define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000
296 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000
297 #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000
300 // Physical memory relative reliability attribute. This
301 // memory provides higher reliability relative to other
302 // memory in the system. If all memory has the same
303 // reliability, then this bit is not used.
305 #define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000
308 /// Describes the resource properties of all fixed,
309 /// nonrelocatable resource ranges found on the processor
310 /// host bus during the HOB producer phase.
314 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
316 EFI_HOB_GENERIC_HEADER Header
;
318 /// A GUID representing the owner of the resource. This GUID is used by HOB
319 /// consumer phase components to correlate device ownership of a resource.
323 /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
325 EFI_RESOURCE_TYPE ResourceType
;
327 /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
329 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
331 /// The physical start address of the resource region.
333 EFI_PHYSICAL_ADDRESS PhysicalStart
;
335 /// The number of bytes of the resource region.
337 UINT64 ResourceLength
;
338 } EFI_HOB_RESOURCE_DESCRIPTOR
;
341 /// Allows writers of executable content in the HOB producer phase to
342 /// maintain and manage HOBs with specific GUID.
346 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
348 EFI_HOB_GENERIC_HEADER Header
;
350 /// A GUID that defines the contents of this HOB.
354 // Guid specific data goes here
359 /// Details the location of firmware volumes that contain firmware files.
363 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
365 EFI_HOB_GENERIC_HEADER Header
;
367 /// The physical memory-mapped base address of the firmware volume.
369 EFI_PHYSICAL_ADDRESS BaseAddress
;
371 /// The length in bytes of the firmware volume.
374 } EFI_HOB_FIRMWARE_VOLUME
;
377 /// Details the location of a firmware volume that was extracted
378 /// from a file within another firmware volume.
382 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
384 EFI_HOB_GENERIC_HEADER Header
;
386 /// The physical memory-mapped base address of the firmware volume.
388 EFI_PHYSICAL_ADDRESS BaseAddress
;
390 /// The length in bytes of the firmware volume.
394 /// The name of the firmware volume.
398 /// The name of the firmware file that contained this firmware volume.
401 } EFI_HOB_FIRMWARE_VOLUME2
;
404 /// Details the location of a firmware volume that was extracted
405 /// from a file within another firmware volume.
409 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.
411 EFI_HOB_GENERIC_HEADER Header
;
413 /// The physical memory-mapped base address of the firmware volume.
415 EFI_PHYSICAL_ADDRESS BaseAddress
;
417 /// The length in bytes of the firmware volume.
421 /// The authentication status.
423 UINT32 AuthenticationStatus
;
425 /// TRUE if the FV was extracted as a file within another firmware volume.
430 /// The name of the firmware volume.
431 /// Valid only if IsExtractedFv is TRUE.
435 /// The name of the firmware file that contained this firmware volume.
436 /// Valid only if IsExtractedFv is TRUE.
439 } EFI_HOB_FIRMWARE_VOLUME3
;
442 /// Describes processor information, such as address space and I/O space capabilities.
446 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
448 EFI_HOB_GENERIC_HEADER Header
;
450 /// Identifies the maximum physical memory addressability of the processor.
452 UINT8 SizeOfMemorySpace
;
454 /// Identifies the maximum physical I/O addressability of the processor.
458 /// 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
;