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