]>
Commit | Line | Data |
---|---|---|
c311f86b | 1 | /** @file\r |
00edb218 | 2 | HOB related definitions in PI.\r |
959ccb23 | 3 | \r |
4e6fed27 | 4 | Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
959ccb23 | 6 | \r |
00edb218 | 7 | @par Revision Reference:\r |
4e6fed27 | 8 | PI Version 1.6\r |
959ccb23 | 9 | \r |
10 | **/\r | |
11 | \r | |
12 | #ifndef __PI_HOB_H__\r | |
13 | #define __PI_HOB_H__\r | |
14 | \r | |
15 | //\r | |
16 | // HobType of EFI_HOB_GENERIC_HEADER.\r | |
fbb393ab | 17 | //\r |
00edb218 A |
18 | #define EFI_HOB_TYPE_HANDOFF 0x0001\r |
19 | #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002\r | |
20 | #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003\r | |
21 | #define EFI_HOB_TYPE_GUID_EXTENSION 0x0004\r | |
22 | #define EFI_HOB_TYPE_FV 0x0005\r | |
23 | #define EFI_HOB_TYPE_CPU 0x0006\r | |
24 | #define EFI_HOB_TYPE_MEMORY_POOL 0x0007\r | |
25 | #define EFI_HOB_TYPE_FV2 0x0009\r | |
e8ade0ef | 26 | #define EFI_HOB_TYPE_LOAD_PEIM_UNUSED 0x000A\r |
2f54e77d | 27 | #define EFI_HOB_TYPE_UEFI_CAPSULE 0x000B\r |
4e6fed27 | 28 | #define EFI_HOB_TYPE_FV3 0x000C\r |
00edb218 A |
29 | #define EFI_HOB_TYPE_UNUSED 0xFFFE\r |
30 | #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF\r | |
959ccb23 | 31 | \r |
dc53faa3 | 32 | ///\r |
fbb393ab | 33 | /// Describes the format and size of the data inside the HOB.\r |
dc53faa3 | 34 | /// All HOBs must contain this generic HOB header.\r |
fbb393ab | 35 | ///\r |
00edb218 | 36 | typedef struct {\r |
1bf79370 LG |
37 | ///\r |
38 | /// Identifies the HOB data structure type.\r | |
39 | ///\r | |
00edb218 | 40 | UINT16 HobType;\r |
1bf79370 LG |
41 | ///\r |
42 | /// The length in bytes of the HOB.\r | |
43 | ///\r | |
00edb218 | 44 | UINT16 HobLength;\r |
1bf79370 LG |
45 | ///\r |
46 | /// This field must always be set to zero.\r | |
47 | ///\r | |
00edb218 | 48 | UINT32 Reserved;\r |
959ccb23 | 49 | } EFI_HOB_GENERIC_HEADER;\r |
50 | \r | |
dc53faa3 | 51 | ///\r |
af2dc6a7 | 52 | /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.\r |
fbb393ab | 53 | ///\r |
2f88bd3a | 54 | #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009\r |
dc53faa3 | 55 | \r |
56 | ///\r | |
fbb393ab | 57 | /// Contains general state information used by the HOB producer phase.\r |
dc53faa3 | 58 | /// This HOB must be the first one in the HOB list.\r |
fbb393ab | 59 | ///\r |
00edb218 | 60 | typedef struct {\r |
1bf79370 LG |
61 | ///\r |
62 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF.\r | |
63 | ///\r | |
2f88bd3a | 64 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
65 | ///\r |
66 | /// The version number pertaining to the PHIT HOB definition.\r | |
fbb393ab | 67 | /// This value is four bytes in length to provide an 8-byte aligned entry\r |
1bf79370 LG |
68 | /// when it is combined with the 4-byte BootMode.\r |
69 | ///\r | |
2f88bd3a | 70 | UINT32 Version;\r |
1bf79370 LG |
71 | ///\r |
72 | /// The system boot mode as determined during the HOB producer phase.\r | |
73 | ///\r | |
2f88bd3a | 74 | EFI_BOOT_MODE BootMode;\r |
1bf79370 LG |
75 | ///\r |
76 | /// The highest address location of memory that is allocated for use by the HOB producer\r | |
77 | /// phase. This address must be 4-KB aligned to meet page restrictions of UEFI.\r | |
78 | ///\r | |
2f88bd3a | 79 | EFI_PHYSICAL_ADDRESS EfiMemoryTop;\r |
1bf79370 LG |
80 | ///\r |
81 | /// The lowest address location of memory that is allocated for use by the HOB producer phase.\r | |
82 | ///\r | |
2f88bd3a | 83 | EFI_PHYSICAL_ADDRESS EfiMemoryBottom;\r |
1bf79370 | 84 | ///\r |
fbb393ab | 85 | /// The highest address location of free memory that is currently available\r |
1bf79370 LG |
86 | /// for use by the HOB producer phase.\r |
87 | ///\r | |
2f88bd3a | 88 | EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop;\r |
1bf79370 LG |
89 | ///\r |
90 | /// The lowest address location of free memory that is available for use by the HOB producer phase.\r | |
91 | ///\r | |
2f88bd3a | 92 | EFI_PHYSICAL_ADDRESS EfiFreeMemoryBottom;\r |
1bf79370 LG |
93 | ///\r |
94 | /// The end of the HOB list.\r | |
95 | ///\r | |
2f88bd3a | 96 | EFI_PHYSICAL_ADDRESS EfiEndOfHobList;\r |
959ccb23 | 97 | } EFI_HOB_HANDOFF_INFO_TABLE;\r |
98 | \r | |
fbb393ab | 99 | ///\r |
dc53faa3 | 100 | /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the\r |
101 | /// various attributes of the logical memory allocation. The type field will be used for\r | |
102 | /// subsequent inclusion in the UEFI memory map.\r | |
fbb393ab | 103 | ///\r |
00edb218 | 104 | typedef struct {\r |
dc53faa3 | 105 | ///\r |
242942b2 | 106 | /// A GUID that defines the memory allocation region's type and purpose, as well as\r |
dc53faa3 | 107 | /// other fields within the memory allocation HOB. This GUID is used to define the\r |
108 | /// additional data within the HOB that may be present for the memory allocation HOB.\r | |
109 | /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0\r | |
fbb393ab LL |
110 | /// specification.\r |
111 | ///\r | |
2f88bd3a | 112 | EFI_GUID Name;\r |
dc53faa3 | 113 | \r |
e31c47b9 | 114 | ///\r |
dc53faa3 | 115 | /// The base address of memory allocated by this HOB. Type\r |
116 | /// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0\r | |
117 | /// specification.\r | |
e31c47b9 | 118 | ///\r |
2f88bd3a | 119 | EFI_PHYSICAL_ADDRESS MemoryBaseAddress;\r |
dc53faa3 | 120 | \r |
fbb393ab | 121 | ///\r |
dc53faa3 | 122 | /// The length in bytes of memory allocated by this HOB.\r |
fbb393ab | 123 | ///\r |
2f88bd3a | 124 | UINT64 MemoryLength;\r |
dc53faa3 | 125 | \r |
126 | ///\r | |
127 | /// Defines the type of memory allocated by this HOB. The memory type definition\r | |
128 | /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined\r | |
129 | /// in AllocatePages() in the UEFI 2.0 specification.\r | |
fbb393ab | 130 | ///\r |
2f88bd3a | 131 | EFI_MEMORY_TYPE MemoryType;\r |
00edb218 | 132 | \r |
dc53faa3 | 133 | ///\r |
134 | /// Padding for Itanium processor family\r | |
135 | ///\r | |
2f88bd3a | 136 | UINT8 Reserved[4];\r |
959ccb23 | 137 | } EFI_HOB_MEMORY_ALLOCATION_HEADER;\r |
138 | \r | |
dc53faa3 | 139 | ///\r |
fbb393ab LL |
140 | /// Describes all memory ranges used during the HOB producer\r |
141 | /// phase that exist outside the HOB list. This HOB type\r | |
1bf79370 LG |
142 | /// describes how memory is used, not the physical attributes of memory.\r |
143 | ///\r | |
00edb218 | 144 | typedef struct {\r |
1bf79370 LG |
145 | ///\r |
146 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r | |
147 | ///\r | |
2f88bd3a | 148 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
149 | ///\r |
150 | /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r | |
151 | /// various attributes of the logical memory allocation.\r | |
152 | ///\r | |
2f88bd3a | 153 | EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r |
00edb218 | 154 | //\r |
ac644614 | 155 | // Additional data pertaining to the "Name" Guid memory\r |
00edb218 A |
156 | // may go here.\r |
157 | //\r | |
959ccb23 | 158 | } EFI_HOB_MEMORY_ALLOCATION;\r |
159 | \r | |
dc53faa3 | 160 | ///\r |
fbb393ab | 161 | /// Describes the memory stack that is produced by the HOB producer\r |
af2dc6a7 | 162 | /// phase and upon which all post-memory-installed executable\r |
dc53faa3 | 163 | /// content in the HOB producer phase is executing.\r |
fbb393ab | 164 | ///\r |
00edb218 | 165 | typedef struct {\r |
1bf79370 LG |
166 | ///\r |
167 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r | |
168 | ///\r | |
2f88bd3a | 169 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
170 | ///\r |
171 | /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r | |
172 | /// various attributes of the logical memory allocation.\r | |
173 | ///\r | |
2f88bd3a | 174 | EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r |
959ccb23 | 175 | } EFI_HOB_MEMORY_ALLOCATION_STACK;\r |
176 | \r | |
dc53faa3 | 177 | ///\r |
fbb393ab | 178 | /// Defines the location of the boot-strap\r |
dc53faa3 | 179 | /// processor (BSP) BSPStore ("Backing Store Pointer Store").\r |
fbb393ab | 180 | /// This HOB is valid for the Itanium processor family only\r |
dc53faa3 | 181 | /// register overflow store.\r |
fbb393ab | 182 | ///\r |
00edb218 | 183 | typedef struct {\r |
1bf79370 LG |
184 | ///\r |
185 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r | |
186 | ///\r | |
2f88bd3a | 187 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
188 | ///\r |
189 | /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r | |
190 | /// various attributes of the logical memory allocation.\r | |
191 | ///\r | |
2f88bd3a | 192 | EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;\r |
959ccb23 | 193 | } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;\r |
194 | \r | |
dc53faa3 | 195 | ///\r |
196 | /// Defines the location and entry point of the HOB consumer phase.\r | |
197 | ///\r | |
959ccb23 | 198 | typedef struct {\r |
1bf79370 LG |
199 | ///\r |
200 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION.\r | |
201 | ///\r | |
2f88bd3a | 202 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
203 | ///\r |
204 | /// An instance of the EFI_HOB_MEMORY_ALLOCATION_HEADER that describes the\r | |
205 | /// various attributes of the logical memory allocation.\r | |
206 | ///\r | |
2f88bd3a | 207 | EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;\r |
1bf79370 | 208 | ///\r |
fbb393ab | 209 | /// The GUID specifying the values of the firmware file system name\r |
1bf79370 LG |
210 | /// that contains the HOB consumer phase component.\r |
211 | ///\r | |
2f88bd3a | 212 | EFI_GUID ModuleName;\r |
1bf79370 | 213 | ///\r |
fbb393ab | 214 | /// The address of the memory-mapped firmware volume\r |
1bf79370 LG |
215 | /// that contains the HOB consumer phase firmware file.\r |
216 | ///\r | |
2f88bd3a | 217 | EFI_PHYSICAL_ADDRESS EntryPoint;\r |
959ccb23 | 218 | } EFI_HOB_MEMORY_ALLOCATION_MODULE;\r |
219 | \r | |
dc53faa3 | 220 | ///\r |
af2dc6a7 | 221 | /// The resource type.\r |
fbb393ab | 222 | ///\r |
959ccb23 | 223 | typedef UINT32 EFI_RESOURCE_TYPE;\r |
224 | \r | |
225 | //\r | |
226 | // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR.\r | |
fbb393ab | 227 | //\r |
00edb218 A |
228 | #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000\r |
229 | #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001\r | |
230 | #define EFI_RESOURCE_IO 0x00000002\r | |
231 | #define EFI_RESOURCE_FIRMWARE_DEVICE 0x00000003\r | |
232 | #define EFI_RESOURCE_MEMORY_MAPPED_IO_PORT 0x00000004\r | |
233 | #define EFI_RESOURCE_MEMORY_RESERVED 0x00000005\r | |
234 | #define EFI_RESOURCE_IO_RESERVED 0x00000006\r | |
235 | #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007\r | |
959ccb23 | 236 | \r |
dc53faa3 | 237 | ///\r |
af2dc6a7 | 238 | /// A type of recount attribute type.\r |
fbb393ab | 239 | ///\r |
959ccb23 | 240 | typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;\r |
241 | \r | |
242 | //\r | |
243 | // These types can be ORed together as needed.\r | |
244 | //\r | |
b6ed1075 | 245 | // The following attributes are used to describe settings\r |
959ccb23 | 246 | //\r |
2f88bd3a MK |
247 | #define EFI_RESOURCE_ATTRIBUTE_PRESENT 0x00000001\r |
248 | #define EFI_RESOURCE_ATTRIBUTE_INITIALIZED 0x00000002\r | |
249 | #define EFI_RESOURCE_ATTRIBUTE_TESTED 0x00000004\r | |
250 | #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTED 0x00000080\r | |
ecde59b2 SZ |
251 | //\r |
252 | // This is typically used as memory cacheability attribute today.\r | |
253 | // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED\r | |
254 | // as Physical write protected attribute, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED\r | |
255 | // means Memory cacheability attribute: The memory supports being programmed with\r | |
256 | // a writeprotected cacheable attribute.\r | |
257 | //\r | |
2f88bd3a MK |
258 | #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTED 0x00000100\r |
259 | #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTED 0x00000200\r | |
260 | #define EFI_RESOURCE_ATTRIBUTE_PERSISTENT 0x00800000\r | |
959ccb23 | 261 | //\r |
b6ed1075 | 262 | // The rest of the attributes are used to describe capabilities\r |
959ccb23 | 263 | //\r |
7b1bf9f6 | 264 | #define EFI_RESOURCE_ATTRIBUTE_SINGLE_BIT_ECC 0x00000008\r |
265 | #define EFI_RESOURCE_ATTRIBUTE_MULTIPLE_BIT_ECC 0x00000010\r | |
266 | #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_1 0x00000020\r | |
267 | #define EFI_RESOURCE_ATTRIBUTE_ECC_RESERVED_2 0x00000040\r | |
7b1bf9f6 | 268 | #define EFI_RESOURCE_ATTRIBUTE_UNCACHEABLE 0x00000400\r |
269 | #define EFI_RESOURCE_ATTRIBUTE_WRITE_COMBINEABLE 0x00000800\r | |
00edb218 | 270 | #define EFI_RESOURCE_ATTRIBUTE_WRITE_THROUGH_CACHEABLE 0x00001000\r |
7b1bf9f6 | 271 | #define EFI_RESOURCE_ATTRIBUTE_WRITE_BACK_CACHEABLE 0x00002000\r |
272 | #define EFI_RESOURCE_ATTRIBUTE_16_BIT_IO 0x00004000\r | |
273 | #define EFI_RESOURCE_ATTRIBUTE_32_BIT_IO 0x00008000\r | |
274 | #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000\r | |
275 | #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000\r | |
b6ed1075 | 276 | #define EFI_RESOURCE_ATTRIBUTE_READ_PROTECTABLE 0x00100000\r |
ecde59b2 SZ |
277 | //\r |
278 | // This is typically used as memory cacheability attribute today.\r | |
279 | // NOTE: Since PI spec 1.4, please use EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE\r | |
280 | // as Memory capability attribute: The memory supports being protected from processor\r | |
281 | // writes, and EFI_RESOURCE_ATTRIBUTE_WRITE_PROTEC TABLE means Memory cacheability attribute:\r | |
282 | // The memory supports being programmed with a writeprotected cacheable attribute.\r | |
283 | //\r | |
2f88bd3a MK |
284 | #define EFI_RESOURCE_ATTRIBUTE_WRITE_PROTECTABLE 0x00200000\r |
285 | #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000\r | |
286 | #define EFI_RESOURCE_ATTRIBUTE_PERSISTABLE 0x01000000\r | |
959ccb23 | 287 | \r |
2f88bd3a MK |
288 | #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTED 0x00040000\r |
289 | #define EFI_RESOURCE_ATTRIBUTE_READ_ONLY_PROTECTABLE 0x00080000\r | |
ecde59b2 | 290 | \r |
e919c766 SZ |
291 | //\r |
292 | // Physical memory relative reliability attribute. This\r | |
293 | // memory provides higher reliability relative to other\r | |
294 | // memory in the system. If all memory has the same\r | |
295 | // reliability, then this bit is not used.\r | |
296 | //\r | |
2f88bd3a | 297 | #define EFI_RESOURCE_ATTRIBUTE_MORE_RELIABLE 0x02000000\r |
e919c766 | 298 | \r |
dc53faa3 | 299 | ///\r |
fbb393ab | 300 | /// Describes the resource properties of all fixed,\r |
dc53faa3 | 301 | /// nonrelocatable resource ranges found on the processor\r |
302 | /// host bus during the HOB producer phase.\r | |
fbb393ab | 303 | ///\r |
00edb218 | 304 | typedef struct {\r |
1bf79370 LG |
305 | ///\r |
306 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR.\r | |
307 | ///\r | |
2f88bd3a | 308 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
309 | ///\r |
310 | /// A GUID representing the owner of the resource. This GUID is used by HOB\r | |
311 | /// consumer phase components to correlate device ownership of a resource.\r | |
312 | ///\r | |
2f88bd3a | 313 | EFI_GUID Owner;\r |
1bf79370 | 314 | ///\r |
af2dc6a7 | 315 | /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.\r |
1bf79370 | 316 | ///\r |
2f88bd3a | 317 | EFI_RESOURCE_TYPE ResourceType;\r |
1bf79370 LG |
318 | ///\r |
319 | /// Resource attributes as defined by EFI_RESOURCE_ATTRIBUTE_TYPE.\r | |
320 | ///\r | |
2f88bd3a | 321 | EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;\r |
1bf79370 | 322 | ///\r |
fbb393ab | 323 | /// The physical start address of the resource region.\r |
1bf79370 | 324 | ///\r |
2f88bd3a | 325 | EFI_PHYSICAL_ADDRESS PhysicalStart;\r |
1bf79370 | 326 | ///\r |
af2dc6a7 | 327 | /// The number of bytes of the resource region.\r |
1bf79370 | 328 | ///\r |
2f88bd3a | 329 | UINT64 ResourceLength;\r |
959ccb23 | 330 | } EFI_HOB_RESOURCE_DESCRIPTOR;\r |
331 | \r | |
dc53faa3 | 332 | ///\r |
fbb393ab | 333 | /// Allows writers of executable content in the HOB producer phase to\r |
dc53faa3 | 334 | /// maintain and manage HOBs with specific GUID.\r |
fbb393ab | 335 | ///\r |
00edb218 | 336 | typedef struct {\r |
1bf79370 LG |
337 | ///\r |
338 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION.\r | |
339 | ///\r | |
2f88bd3a | 340 | EFI_HOB_GENERIC_HEADER Header;\r |
dc53faa3 | 341 | ///\r |
1bf79370 | 342 | /// A GUID that defines the contents of this HOB.\r |
dc53faa3 | 343 | ///\r |
2f88bd3a | 344 | EFI_GUID Name;\r |
1bf79370 LG |
345 | //\r |
346 | // Guid specific data goes here\r | |
347 | //\r | |
959ccb23 | 348 | } EFI_HOB_GUID_TYPE;\r |
349 | \r | |
dc53faa3 | 350 | ///\r |
351 | /// Details the location of firmware volumes that contain firmware files.\r | |
fbb393ab | 352 | ///\r |
959ccb23 | 353 | typedef struct {\r |
1bf79370 LG |
354 | ///\r |
355 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV.\r | |
356 | ///\r | |
2f88bd3a | 357 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
358 | ///\r |
359 | /// The physical memory-mapped base address of the firmware volume.\r | |
360 | ///\r | |
2f88bd3a | 361 | EFI_PHYSICAL_ADDRESS BaseAddress;\r |
1bf79370 LG |
362 | ///\r |
363 | /// The length in bytes of the firmware volume.\r | |
364 | ///\r | |
2f88bd3a | 365 | UINT64 Length;\r |
959ccb23 | 366 | } EFI_HOB_FIRMWARE_VOLUME;\r |
367 | \r | |
dc53faa3 | 368 | ///\r |
fbb393ab | 369 | /// Details the location of a firmware volume that was extracted\r |
dc53faa3 | 370 | /// from a file within another firmware volume.\r |
fbb393ab | 371 | ///\r |
959ccb23 | 372 | typedef struct {\r |
1bf79370 LG |
373 | ///\r |
374 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2.\r | |
375 | ///\r | |
2f88bd3a | 376 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
377 | ///\r |
378 | /// The physical memory-mapped base address of the firmware volume.\r | |
379 | ///\r | |
2f88bd3a | 380 | EFI_PHYSICAL_ADDRESS BaseAddress;\r |
1bf79370 LG |
381 | ///\r |
382 | /// The length in bytes of the firmware volume.\r | |
383 | ///\r | |
2f88bd3a | 384 | UINT64 Length;\r |
1bf79370 LG |
385 | ///\r |
386 | /// The name of the firmware volume.\r | |
387 | ///\r | |
2f88bd3a | 388 | EFI_GUID FvName;\r |
1bf79370 | 389 | ///\r |
af2dc6a7 | 390 | /// The name of the firmware file that contained this firmware volume.\r |
1bf79370 | 391 | ///\r |
2f88bd3a | 392 | EFI_GUID FileName;\r |
959ccb23 | 393 | } EFI_HOB_FIRMWARE_VOLUME2;\r |
394 | \r | |
4e6fed27 SZ |
395 | ///\r |
396 | /// Details the location of a firmware volume that was extracted\r | |
397 | /// from a file within another firmware volume.\r | |
398 | ///\r | |
399 | typedef struct {\r | |
400 | ///\r | |
401 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV3.\r | |
402 | ///\r | |
2f88bd3a | 403 | EFI_HOB_GENERIC_HEADER Header;\r |
4e6fed27 SZ |
404 | ///\r |
405 | /// The physical memory-mapped base address of the firmware volume.\r | |
406 | ///\r | |
2f88bd3a | 407 | EFI_PHYSICAL_ADDRESS BaseAddress;\r |
4e6fed27 SZ |
408 | ///\r |
409 | /// The length in bytes of the firmware volume.\r | |
410 | ///\r | |
2f88bd3a | 411 | UINT64 Length;\r |
4e6fed27 SZ |
412 | ///\r |
413 | /// The authentication status.\r | |
414 | ///\r | |
2f88bd3a | 415 | UINT32 AuthenticationStatus;\r |
4e6fed27 SZ |
416 | ///\r |
417 | /// TRUE if the FV was extracted as a file within another firmware volume.\r | |
418 | /// FALSE otherwise.\r | |
419 | ///\r | |
2f88bd3a | 420 | BOOLEAN ExtractedFv;\r |
4e6fed27 SZ |
421 | ///\r |
422 | /// The name of the firmware volume.\r | |
423 | /// Valid only if IsExtractedFv is TRUE.\r | |
424 | ///\r | |
2f88bd3a | 425 | EFI_GUID FvName;\r |
4e6fed27 SZ |
426 | ///\r |
427 | /// The name of the firmware file that contained this firmware volume.\r | |
428 | /// Valid only if IsExtractedFv is TRUE.\r | |
429 | ///\r | |
2f88bd3a | 430 | EFI_GUID FileName;\r |
4e6fed27 | 431 | } EFI_HOB_FIRMWARE_VOLUME3;\r |
959ccb23 | 432 | \r |
dc53faa3 | 433 | ///\r |
434 | /// Describes processor information, such as address space and I/O space capabilities.\r | |
435 | ///\r | |
00edb218 | 436 | typedef struct {\r |
1bf79370 LG |
437 | ///\r |
438 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_CPU.\r | |
439 | ///\r | |
2f88bd3a | 440 | EFI_HOB_GENERIC_HEADER Header;\r |
1bf79370 LG |
441 | ///\r |
442 | /// Identifies the maximum physical memory addressability of the processor.\r | |
443 | ///\r | |
2f88bd3a | 444 | UINT8 SizeOfMemorySpace;\r |
1bf79370 LG |
445 | ///\r |
446 | /// Identifies the maximum physical I/O addressability of the processor.\r | |
447 | ///\r | |
2f88bd3a | 448 | UINT8 SizeOfIoSpace;\r |
1bf79370 LG |
449 | ///\r |
450 | /// This field will always be set to zero.\r | |
451 | ///\r | |
2f88bd3a | 452 | UINT8 Reserved[6];\r |
959ccb23 | 453 | } EFI_HOB_CPU;\r |
454 | \r | |
dc53faa3 | 455 | ///\r |
456 | /// Describes pool memory allocations.\r | |
fbb393ab | 457 | ///\r |
00edb218 | 458 | typedef struct {\r |
1bf79370 LG |
459 | ///\r |
460 | /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL.\r | |
461 | ///\r | |
2f88bd3a | 462 | EFI_HOB_GENERIC_HEADER Header;\r |
959ccb23 | 463 | } EFI_HOB_MEMORY_POOL;\r |
464 | \r | |
9e8485c5 | 465 | ///\r |
466 | /// Each UEFI capsule HOB details the location of a UEFI capsule. It includes a base address and length\r | |
467 | /// which is based upon memory blocks with a EFI_CAPSULE_HEADER and the associated\r | |
17664848 | 468 | /// CapsuleImageSize-based payloads. These HOB's shall be created by the PEI PI firmware\r |
9e8485c5 | 469 | /// sometime after the UEFI UpdateCapsule service invocation with the\r |
470 | /// CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag set in the EFI_CAPSULE_HEADER.\r | |
471 | ///\r | |
472 | typedef struct {\r | |
473 | ///\r | |
474 | /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE.\r | |
475 | ///\r | |
2f88bd3a | 476 | EFI_HOB_GENERIC_HEADER Header;\r |
fbb393ab | 477 | \r |
9e8485c5 | 478 | ///\r |
479 | /// The physical memory-mapped base address of an UEFI capsule. This value is set to\r | |
480 | /// point to the base of the contiguous memory of the UEFI capsule.\r | |
af2dc6a7 | 481 | /// The length of the contiguous memory in bytes.\r |
9e8485c5 | 482 | ///\r |
2f88bd3a MK |
483 | EFI_PHYSICAL_ADDRESS BaseAddress;\r |
484 | UINT64 Length;\r | |
9e8485c5 | 485 | } EFI_HOB_UEFI_CAPSULE;\r |
486 | \r | |
dc53faa3 | 487 | ///\r |
af2dc6a7 | 488 | /// Union of all the possible HOB Types.\r |
dc53faa3 | 489 | ///\r |
959ccb23 | 490 | typedef union {\r |
2f88bd3a MK |
491 | EFI_HOB_GENERIC_HEADER *Header;\r |
492 | EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;\r | |
493 | EFI_HOB_MEMORY_ALLOCATION *MemoryAllocation;\r | |
494 | EFI_HOB_MEMORY_ALLOCATION_BSP_STORE *MemoryAllocationBspStore;\r | |
495 | EFI_HOB_MEMORY_ALLOCATION_STACK *MemoryAllocationStack;\r | |
496 | EFI_HOB_MEMORY_ALLOCATION_MODULE *MemoryAllocationModule;\r | |
497 | EFI_HOB_RESOURCE_DESCRIPTOR *ResourceDescriptor;\r | |
498 | EFI_HOB_GUID_TYPE *Guid;\r | |
499 | EFI_HOB_FIRMWARE_VOLUME *FirmwareVolume;\r | |
500 | EFI_HOB_FIRMWARE_VOLUME2 *FirmwareVolume2;\r | |
501 | EFI_HOB_FIRMWARE_VOLUME3 *FirmwareVolume3;\r | |
502 | EFI_HOB_CPU *Cpu;\r | |
503 | EFI_HOB_MEMORY_POOL *Pool;\r | |
504 | EFI_HOB_UEFI_CAPSULE *Capsule;\r | |
505 | UINT8 *Raw;\r | |
959ccb23 | 506 | } EFI_PEI_HOB_POINTERS;\r |
507 | \r | |
fbb393ab | 508 | #endif\r |