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