2 HOB related definitions in PI.
4 Copyright (c) 2006 - 2009, Intel Corporation
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.
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 0x000A
33 #define EFI_HOB_TYPE_UNUSED 0xFFFE
34 #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF
37 /// Describes the format and size of the data inside the HOB.
38 /// All HOBs must contain this generic HOB header.
42 /// Identifies the HOB data structure type.
46 /// The length in bytes of the HOB.
50 /// This field must always be set to zero.
53 } EFI_HOB_GENERIC_HEADER
;
57 /// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
59 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
62 /// Contains general state information used by the HOB producer phase.
63 /// This HOB must be the first one in the HOB list.
67 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.
69 EFI_HOB_GENERIC_HEADER Header
;
71 /// The version number pertaining to the PHIT HOB definition.
72 /// This value is 4 bytes in length to provide an 8-byte aligned entry
73 /// when it is combined with the 4-byte BootMode.
77 /// The system boot mode as determined during the HOB producer phase.
79 EFI_BOOT_MODE BootMode
;
81 /// The highest address location of memory that is allocated for use by the HOB producer
82 /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.
84 EFI_PHYSICAL_ADDRESS EfiMemoryTop
;
86 /// The lowest address location of memory that is allocated for use by the HOB producer phase.
88 EFI_PHYSICAL_ADDRESS EfiMemoryBottom
;
90 /// The highest address location of free memory that is currently available
91 /// for use by the HOB producer phase.
93 EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop
;
95 /// The lowest address location of free memory that is available for use by the HOB producer phase.
97 EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom
;
99 /// The end of the HOB list.
101 EFI_PHYSICAL_ADDRESS EfiEndOfHobList
;
102 } EFI_HOB_HANDOFF_INFO_TABLE
;
105 /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the
106 /// various attributes of the logical memory allocation. The type field will be used for
107 /// subsequent inclusion in the UEFI memory map.
111 /// A GUID that defines the memory allocation region's type and purpose, as well as
112 /// other fields within the memory allocation HOB. This GUID is used to define the
113 /// additional data within the HOB that may be present for the memory allocation HOB.
114 /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0
120 /// The base address of memory allocated by this HOB. Type
121 /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
124 EFI_PHYSICAL_ADDRESS MemoryBaseAddress
;
127 /// The length in bytes of memory allocated by this HOB.
132 /// Defines the type of memory allocated by this HOB. The memory type definition
133 /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined
134 /// in AllocatePages() in the UEFI 2.0 specification.
136 EFI_MEMORY_TYPE MemoryType
;
139 /// Padding for Itanium processor family
142 } EFI_HOB_MEMORY_ALLOCATION_HEADER
;
145 /// Describes all memory ranges used during the HOB producer
146 /// phase that exist outside the HOB list. This HOB type
147 /// describes how memory is used, not the physical attributes of memory.
151 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
153 EFI_HOB_GENERIC_HEADER Header
;
155 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
156 /// various attributes of the logical memory allocation.
158 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
160 // Additional data pertaining to the "Name" Guid memory
163 } EFI_HOB_MEMORY_ALLOCATION
;
167 /// Describes the memory stack that is produced by the HOB producer
168 /// phase and upon which all postmemory-installed executable
169 /// content in the HOB producer phase is executing.
173 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
175 EFI_HOB_GENERIC_HEADER Header
;
177 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
178 /// various attributes of the logical memory allocation.
180 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
181 } EFI_HOB_MEMORY_ALLOCATION_STACK
;
184 /// Defines the location of the boot-strap
185 /// processor (BSP) BSPStore ("Backing Store Pointer Store").
186 /// This HOB is valid for the Itanium processor family only
187 /// register overflow store.
191 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
193 EFI_HOB_GENERIC_HEADER Header
;
195 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
196 /// various attributes of the logical memory allocation.
198 EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor
;
199 } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
;
202 /// Defines the location and entry point of the HOB consumer phase.
206 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.
208 EFI_HOB_GENERIC_HEADER Header
;
210 /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the
211 /// various attributes of the logical memory allocation.
213 EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader
;
215 /// The GUID specifying the values of the firmware file system name
216 /// that contains the HOB consumer phase component.
220 /// The address of the memory-mapped firmware volume
221 /// that contains the HOB consumer phase firmware file.
223 EFI_PHYSICAL_ADDRESS EntryPoint
;
224 } EFI_HOB_MEMORY_ALLOCATION_MODULE
;
229 typedef UINT32 EFI_RESOURCE_TYPE
;
232 // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.
234 #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000
235 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001
236 #define EFI_RESOURCE_IO 0x00000002
237 #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003
238 #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004
239 #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005
240 #define EFI_RESOURCE_IO_RESERVED 0x00000006
241 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
244 /// type of recount attribute type
246 typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE
;
249 // These types can be ORed together as needed.
251 // The first three enumerations describe settings
253 #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001
254 #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002
255 #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004
257 // The rest of the settings describe capabilities
259 #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008
260 #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010
261 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020
262 #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040
263 #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080
264 #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100
265 #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200
266 #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400
267 #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800
268 #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000
269 #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000
270 #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000
271 #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000
272 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
273 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
276 /// Describes the resource properties of all fixed,
277 /// nonrelocatable resource ranges found on the processor
278 /// host bus during the HOB producer phase.
282 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.
284 EFI_HOB_GENERIC_HEADER Header
;
286 /// A GUID representing the owner of the resource. This GUID is used by HOB
287 /// consumer phase components to correlate device ownership of a resource.
291 /// Resource type enumeration as defined by EFI_RESOURCE_TYPE.
293 EFI_RESOURCE_TYPE ResourceType
;
295 /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.
297 EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute
;
299 /// Physical start address of the resource region.
301 EFI_PHYSICAL_ADDRESS PhysicalStart
;
303 /// Number of bytes of the resource region.
305 UINT64 ResourceLength
;
306 } EFI_HOB_RESOURCE_DESCRIPTOR
;
309 /// Allows writers of executable content in the HOB producer phase to
310 /// maintain and manage HOBs with specific GUID.
314 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.
316 EFI_HOB_GENERIC_HEADER Header
;
318 /// A GUID that defines the contents of this HOB.
322 // Guid specific data goes here
327 /// Details the location of firmware volumes that contain firmware files.
331 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.
333 EFI_HOB_GENERIC_HEADER Header
;
335 /// The physical memory-mapped base address of the firmware volume.
337 EFI_PHYSICAL_ADDRESS BaseAddress
;
339 /// The length in bytes of the firmware volume.
342 } EFI_HOB_FIRMWARE_VOLUME
;
345 /// Details the location of a firmware volume which was extracted
346 /// from a file within another firmware volume.
350 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.
352 EFI_HOB_GENERIC_HEADER Header
;
354 /// The physical memory-mapped base address of the firmware volume.
356 EFI_PHYSICAL_ADDRESS BaseAddress
;
358 /// The length in bytes of the firmware volume.
362 /// The name of the firmware volume.
366 /// The name of the firmware file which contained this firmware volume.
369 } EFI_HOB_FIRMWARE_VOLUME2
;
373 /// Describes processor information, such as address space and I/O space capabilities.
377 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.
379 EFI_HOB_GENERIC_HEADER Header
;
381 /// Identifies the maximum physical memory addressability of the processor.
383 UINT8 SizeOfMemorySpace
;
385 /// Identifies the maximum physical I/O addressability of the processor.
389 /// This field will always be set to zero.
396 /// Describes pool memory allocations.
400 /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.
402 EFI_HOB_GENERIC_HEADER Header
;
403 } EFI_HOB_MEMORY_POOL
;
406 /// Union of all the possible HOB Types
409 EFI_HOB_GENERIC_HEADER
*Header
;
410 EFI_HOB_HANDOFF_INFO_TABLE
*HandoffInformationTable
;
411 EFI_HOB_MEMORY_ALLOCATION
*MemoryAllocation
;
412 EFI_HOB_MEMORY_ALLOCATION_BSP_STORE
*MemoryAllocationBspStore
;
413 EFI_HOB_MEMORY_ALLOCATION_STACK
*MemoryAllocationStack
;
414 EFI_HOB_MEMORY_ALLOCATION_MODULE
*MemoryAllocationModule
;
415 EFI_HOB_RESOURCE_DESCRIPTOR
*ResourceDescriptor
;
416 EFI_HOB_GUID_TYPE
*Guid
;
417 EFI_HOB_FIRMWARE_VOLUME
*FirmwareVolume
;
418 EFI_HOB_FIRMWARE_VOLUME2
*FirmwareVolume2
;
420 EFI_HOB_MEMORY_POOL
*Pool
;
422 } EFI_PEI_HOB_POINTERS
;