2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2011, 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_UNUSED 0xFFFE
35 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
38 /// Describes the format and size of the data inside the HOB.
39 /// All HOBs must contain this generic HOB header.
43 /// Identifies the HOB data structure type.
47 /// The length in bytes of the HOB.
51 /// This field must always be set to zero.
54 } EFI_HOB_GENERIC_HEADER
;
58 /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
60 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
63 /// Contains general state information used by the HOB producer phase.
64 /// This HOB must be the first one in the HOB list.
68 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
70 EFI_HOB_GENERIC_HEADER Header
;
72 /// The version number pertaining to the PHIT HOB definition.
73 /// This value is four bytes in length to provide an 8-byte aligned entry
74 /// when it is combined with the 4-byte BootMode.
78 /// The system boot mode as determined during the HOB producer phase.
80 EFI_BOOT_MODE BootMode
;
82 /// The highest address location of memory that is allocated for use by the HOB producer
83 /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
85 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
87 /// The lowest address location of memory that is allocated for use by the HOB producer phase.
89 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
91 /// The highest address location of free memory that is currently available
92 /// for use by the HOB producer phase.
94 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
96 /// The lowest address location of free memory that is available for use by the HOB producer phase.
98 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
100 /// The end of the HOB list.
102 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
103 } EFI_HOB_HANDOFF_INFO_TABLE
;
106 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
107 /// various attributes of the logical memory allocation. The type field will be used for
108 /// subsequent inclusion in the UEFI memory map.
112 /// A GUID that defines the memory allocation region's type and purpose, as well as
113 /// other fields within the memory allocation HOB. This GUID is used to define the
114 /// additional data within the HOB that may be present for the memory allocation HOB.
115 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
121 /// The base address of memory allocated by this HOB. Type
122 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
125 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
128 /// The length in bytes of memory allocated by this HOB.
133 /// Defines the type of memory allocated by this HOB. The memory type definition
134 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
135 /// in AllocatePages() in the UEFI 2.0 specification.
137 EFI_MEMORY_TYPE MemoryType
;
140 /// Padding for Itanium processor family
143 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
146 /// Describes all memory ranges used during the HOB producer
147 /// phase that exist outside the HOB list. This HOB type
148 /// describes how memory is used, not the physical attributes of memory.
152 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
154 EFI_HOB_GENERIC_HEADER Header
;
156 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
157 /// various attributes of the logical memory allocation.
159 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
161 // Additional data pertaining to the "Name" Guid memory
164 } EFI_HOB_MEMORY_ALLOCATION
;
168 /// Describes the memory stack that is produced by the HOB producer
169 /// phase and upon which all post-memory-installed executable
170 /// content in the HOB producer phase is executing.
174 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
176 EFI_HOB_GENERIC_HEADER Header
;
178 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
179 /// various attributes of the logical memory allocation.
181 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
182 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
185 /// Defines the location of the boot-strap
186 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
187 /// This HOB is valid for the Itanium processor family only
188 /// register overflow store.
192 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
194 EFI_HOB_GENERIC_HEADER Header
;
196 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
197 /// various attributes of the logical memory allocation.
199 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
200 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
203 /// Defines the location and entry point of the HOB consumer phase.
207 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
209 EFI_HOB_GENERIC_HEADER Header
;
211 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
212 /// various attributes of the logical memory allocation.
214 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
216 /// The GUID specifying the values of the firmware file system name
217 /// that contains the HOB consumer phase component.
221 /// The address of the memory-mapped firmware volume
222 /// that contains the HOB consumer phase firmware file.
224 EFI_PHYSICAL_ADDRESS EntryPoint
;
225 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
228 /// The resource type.
230 typedef UINT32 EFI_RESOURCE_TYPE
;
233 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
235 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
236 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
237 #define EFI_RESOURCE_IO 0x00000002
238 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
239 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
240 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
241 #define EFI_RESOURCE_IO_RESERVED 0x00000006
242 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
245 /// A type of recount attribute type.
247 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
250 // These types can be ORed together as needed.
252 // The following attributes are used to describe settings
254 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
255 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
256 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
257 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
258 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
259 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
261 // The rest of the attributes are used to describe capabilities
263 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
264 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
265 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
266 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
267 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
268 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
269 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
270 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
271 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
272 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
273 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
274 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
275 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000
276 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000
277 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000
280 /// Describes the resource properties of all fixed,
281 /// nonrelocatable resource ranges found on the processor
282 /// host bus during the HOB producer phase.
286 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
288 EFI_HOB_GENERIC_HEADER Header
;
290 /// A GUID representing the owner of the resource. This GUID is used by HOB
291 /// consumer phase components to correlate device ownership of a resource.
295 /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
297 EFI_RESOURCE_TYPE ResourceType
;
299 /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
301 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
303 /// The physical start address of the resource region.
305 EFI_PHYSICAL_ADDRESS PhysicalStart
;
307 /// The number of bytes of the resource region.
309 UINT64 ResourceLength
;
310 } EFI_HOB_RESOURCE_DESCRIPTOR
;
313 /// Allows writers of executable content in the HOB producer phase to
314 /// maintain and manage HOBs with specific GUID.
318 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
320 EFI_HOB_GENERIC_HEADER Header
;
322 /// A GUID that defines the contents of this HOB.
326 // Guid specific data goes here
331 /// Details the location of firmware volumes that contain firmware files.
335 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
337 EFI_HOB_GENERIC_HEADER Header
;
339 /// The physical memory-mapped base address of the firmware volume.
341 EFI_PHYSICAL_ADDRESS BaseAddress
;
343 /// The length in bytes of the firmware volume.
346 } EFI_HOB_FIRMWARE_VOLUME
;
349 /// Details the location of a firmware volume that was extracted
350 /// from a file within another firmware volume.
354 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
356 EFI_HOB_GENERIC_HEADER Header
;
358 /// The physical memory-mapped base address of the firmware volume.
360 EFI_PHYSICAL_ADDRESS BaseAddress
;
362 /// The length in bytes of the firmware volume.
366 /// The name of the firmware volume.
370 /// The name of the firmware file that contained this firmware volume.
373 } EFI_HOB_FIRMWARE_VOLUME2
;
377 /// Describes processor information, such as address space and I/O space capabilities.
381 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
383 EFI_HOB_GENERIC_HEADER Header
;
385 /// Identifies the maximum physical memory addressability of the processor.
387 UINT8 SizeOfMemorySpace
;
389 /// Identifies the maximum physical I/O addressability of the processor.
393 /// This field will always be set to zero.
400 /// Describes pool memory allocations.
404 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
406 EFI_HOB_GENERIC_HEADER Header
;
407 } EFI_HOB_MEMORY_POOL
;
410 /// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length
411 /// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated
412 /// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware
413 /// sometime after the UEFI UpdateCapsule service invocation with the
414 /// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.
418 /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.
420 EFI_HOB_GENERIC_HEADER Header
;
423 /// The physical memory-mapped base address of an UEFI capsule. This value is set to
424 /// point to the base of the contiguous memory of the UEFI capsule.
425 /// The length of the contiguous memory in bytes.
427 EFI_PHYSICAL_ADDRESS BaseAddress
;
429 } EFI_HOB_UEFI_CAPSULE
;
432 /// Union of all the possible HOB Types.
435 EFI_HOB_GENERIC_HEADER
*Header
;
436 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
437 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
438 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
439 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
440 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
441 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
442 EFI_HOB_GUID_TYPE
*Guid
;
443 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
444 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
446 EFI_HOB_MEMORY_POOL
*Pool
;
447 EFI_HOB_UEFI_CAPSULE
*Capsule
;
449 } EFI_PEI_HOB_POINTERS
;