]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
2 | The firmware file related definitions in PI.\r | |
3 | \r | |
9df063a0 | 4 | Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r |
af2dc6a7 | 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 | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php. \r | |
959ccb23 | 9 | \r |
af2dc6a7 | 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 |
959ccb23 | 13 | @par Revision Reference:\r |
af2dc6a7 | 14 | PI Version 1.2.\r |
959ccb23 | 15 | \r |
16 | **/\r | |
17 | \r | |
0b3cac32 | 18 | \r |
959ccb23 | 19 | #ifndef __PI_FIRMWARE_FILE_H__\r |
20 | #define __PI_FIRMWARE_FILE_H__\r | |
21 | \r | |
62d1e08b | 22 | #pragma pack(1)\r |
dc53faa3 | 23 | ///\r |
24 | /// Used to verify the integrity of the file.\r | |
25 | /// \r | |
959ccb23 | 26 | typedef union {\r |
27 | struct {\r | |
1bf79370 LG |
28 | ///\r |
29 | /// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file\r | |
30 | /// header. The State and IntegrityCheck.Checksum.File fields are assumed\r | |
31 | /// to be zero and the checksum is calculated such that the entire header sums to zero.\r | |
32 | ///\r | |
959ccb23 | 33 | UINT8 Header;\r |
1bf79370 LG |
34 | ///\r |
35 | /// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes\r | |
36 | /// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit\r | |
37 | /// checksum of the entire file The State field and the file tail are assumed to be zero\r | |
38 | /// and the checksum is calculated such that the entire file sums to zero.\r | |
39 | /// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero,\r | |
40 | /// the IntegrityCheck.Checksum.File field must be initialized with a value of\r | |
2bf0d835 | 41 | /// 0xAA. The IntegrityCheck.Checksum.File field is valid any time the\r |
1bf79370 LG |
42 | /// EFI_FILE_DATA_VALID bit is set in the State field.\r |
43 | ///\r | |
959ccb23 | 44 | UINT8 File;\r |
45 | } Checksum;\r | |
1bf79370 LG |
46 | ///\r |
47 | /// This is the full 16 bits of the IntegrityCheck field.\r | |
48 | ///\r | |
959ccb23 | 49 | UINT16 Checksum16;\r |
50 | } EFI_FFS_INTEGRITY_CHECK;\r | |
51 | \r | |
2bf0d835 LG |
52 | ///\r |
53 | /// FFS_FIXED_CHECKSUM is the checksum value used when the\r | |
af2dc6a7 | 54 | /// FFS_ATTRIB_CHECKSUM attribute bit is clear.\r |
2bf0d835 LG |
55 | ///\r |
56 | #define FFS_FIXED_CHECKSUM 0xAA\r | |
57 | \r | |
959ccb23 | 58 | typedef UINT8 EFI_FV_FILETYPE;\r |
59 | typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r | |
60 | typedef UINT8 EFI_FFS_FILE_STATE;\r | |
61 | \r | |
dc53faa3 | 62 | ///\r |
63 | /// File Types Definitions\r | |
64 | /// \r | |
d44d2087 | 65 | #define EFI_FV_FILETYPE_ALL 0x00\r |
8fb30482 | 66 | #define EFI_FV_FILETYPE_RAW 0x01\r |
67 | #define EFI_FV_FILETYPE_FREEFORM 0x02\r | |
68 | #define EFI_FV_FILETYPE_SECURITY_CORE 0x03\r | |
69 | #define EFI_FV_FILETYPE_PEI_CORE 0x04\r | |
70 | #define EFI_FV_FILETYPE_DXE_CORE 0x05\r | |
71 | #define EFI_FV_FILETYPE_PEIM 0x06\r | |
72 | #define EFI_FV_FILETYPE_DRIVER 0x07\r | |
73 | #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08\r | |
74 | #define EFI_FV_FILETYPE_APPLICATION 0x09\r | |
95ba3c41 | 75 | #define EFI_FV_FILETYPE_SMM 0x0A\r |
8fb30482 | 76 | #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r |
95ba3c41 | 77 | #define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C\r |
78 | #define EFI_FV_FILETYPE_SMM_CORE 0x0D\r | |
8fb30482 | 79 | #define EFI_FV_FILETYPE_OEM_MIN 0xc0\r |
80 | #define EFI_FV_FILETYPE_OEM_MAX 0xdf\r | |
81 | #define EFI_FV_FILETYPE_DEBUG_MIN 0xe0\r | |
82 | #define EFI_FV_FILETYPE_DEBUG_MAX 0xef\r | |
83 | #define EFI_FV_FILETYPE_FFS_MIN 0xf0\r | |
84 | #define EFI_FV_FILETYPE_FFS_MAX 0xff\r | |
85 | #define EFI_FV_FILETYPE_FFS_PAD 0xf0\r | |
dc53faa3 | 86 | /// \r |
87 | /// FFS File Attributes.\r | |
88 | /// \r | |
3d4d4cfa | 89 | #define FFS_ATTRIB_LARGE_FILE 0x01\r |
959ccb23 | 90 | #define FFS_ATTRIB_FIXED 0x04\r |
91 | #define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r | |
92 | #define FFS_ATTRIB_CHECKSUM 0x40\r | |
93 | \r | |
dc53faa3 | 94 | /// \r |
95 | /// FFS File State Bits.\r | |
96 | /// \r | |
959ccb23 | 97 | #define EFI_FILE_HEADER_CONSTRUCTION 0x01\r |
98 | #define EFI_FILE_HEADER_VALID 0x02\r | |
99 | #define EFI_FILE_DATA_VALID 0x04\r | |
100 | #define EFI_FILE_MARKED_FOR_UPDATE 0x08\r | |
101 | #define EFI_FILE_DELETED 0x10\r | |
102 | #define EFI_FILE_HEADER_INVALID 0x20\r | |
103 | \r | |
104 | \r | |
dc53faa3 | 105 | ///\r |
106 | /// Each file begins with the header that describe the \r | |
107 | /// contents and state of the files.\r | |
108 | /// \r | |
959ccb23 | 109 | typedef struct {\r |
1bf79370 LG |
110 | ///\r |
111 | /// This GUID is the file name. It is used to uniquely identify the file.\r | |
112 | ///\r | |
959ccb23 | 113 | EFI_GUID Name;\r |
1bf79370 LG |
114 | ///\r |
115 | /// Used to verify the integrity of the file.\r | |
116 | ///\r | |
959ccb23 | 117 | EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r |
1bf79370 LG |
118 | ///\r |
119 | /// Identifies the type of file.\r | |
120 | ///\r | |
959ccb23 | 121 | EFI_FV_FILETYPE Type;\r |
1bf79370 LG |
122 | ///\r |
123 | /// Declares various file attribute bits.\r | |
124 | ///\r | |
959ccb23 | 125 | EFI_FFS_FILE_ATTRIBUTES Attributes;\r |
1bf79370 LG |
126 | ///\r |
127 | /// The length of the file in bytes, including the FFS header.\r | |
128 | ///\r | |
959ccb23 | 129 | UINT8 Size[3];\r |
1bf79370 LG |
130 | ///\r |
131 | /// Used to track the state of the file throughout the life of the file from creation to deletion.\r | |
132 | ///\r | |
959ccb23 | 133 | EFI_FFS_FILE_STATE State;\r |
134 | } EFI_FFS_FILE_HEADER;\r | |
135 | \r | |
3d4d4cfa | 136 | typedef struct {\r |
137 | ///\r | |
138 | /// This GUID is the file name. It is used to uniquely identify the file. There may be only\r | |
139 | /// one instance of a file with the file name GUID of Name in any given firmware\r | |
140 | /// volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD.\r | |
141 | ///\r | |
142 | EFI_GUID Name;\r | |
143 | \r | |
144 | ///\r | |
145 | /// Used to verify the integrity of the file.\r | |
146 | /// \r | |
147 | EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r | |
148 | \r | |
149 | ///\r | |
150 | /// Identifies the type of file.\r | |
151 | /// \r | |
152 | EFI_FV_FILETYPE Type;\r | |
153 | \r | |
154 | ///\r | |
155 | /// Declares various file attribute bits.\r | |
156 | /// \r | |
157 | EFI_FFS_FILE_ATTRIBUTES Attributes;\r | |
158 | \r | |
159 | ///\r | |
160 | /// The length of the file in bytes, including the FFS header.\r | |
161 | /// The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a\r | |
162 | /// zero-length file has a Size of 24 bytes, which is sizeof(EFI_FFS_FILE_HEADER).\r | |
163 | /// Size is not required to be a multiple of 8 bytes. Given a file F, the next file header is\r | |
164 | /// located at the next 8-byte aligned firmware volume offset following the last byte of the file F.\r | |
165 | ///\r | |
166 | UINT8 Size[3];\r | |
167 | \r | |
168 | ///\r | |
169 | /// Used to track the state of the file throughout the life of the file from creation to deletion.\r | |
170 | ///\r | |
171 | EFI_FFS_FILE_STATE State;\r | |
172 | \r | |
173 | ///\r | |
af2dc6a7 | 174 | /// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero.\r |
3d4d4cfa | 175 | /// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used.\r |
176 | ///\r | |
177 | EFI_FFS_FILE_STATE ExtendedSize;\r | |
178 | } EFI_FFS_FILE_HEADER2;\r | |
959ccb23 | 179 | \r |
180 | typedef UINT8 EFI_SECTION_TYPE;\r | |
181 | \r | |
dc53faa3 | 182 | ///\r |
af2dc6a7 | 183 | /// Pseudo type. It is used as a wild card when retrieving sections.\r |
184 | /// The section type EFI_SECTION_ALL matches all section types.\r | |
dc53faa3 | 185 | ///\r |
959ccb23 | 186 | #define EFI_SECTION_ALL 0x00\r |
187 | \r | |
dc53faa3 | 188 | ///\r |
af2dc6a7 | 189 | /// Encapsulation section Type values.\r |
dc53faa3 | 190 | ///\r |
959ccb23 | 191 | #define EFI_SECTION_COMPRESSION 0x01\r |
192 | \r | |
193 | #define EFI_SECTION_GUID_DEFINED 0x02\r | |
194 | \r | |
3d4d4cfa | 195 | #define EFI_SECTION_DISPOSABLE 0x03\r |
196 | \r | |
dc53faa3 | 197 | ///\r |
af2dc6a7 | 198 | /// Leaf section Type values.\r |
dc53faa3 | 199 | ///\r |
959ccb23 | 200 | #define EFI_SECTION_PE32 0x10\r |
201 | #define EFI_SECTION_PIC 0x11\r | |
202 | #define EFI_SECTION_TE 0x12\r | |
203 | #define EFI_SECTION_DXE_DEPEX 0x13\r | |
204 | #define EFI_SECTION_VERSION 0x14\r | |
205 | #define EFI_SECTION_USER_INTERFACE 0x15\r | |
206 | #define EFI_SECTION_COMPATIBILITY16 0x16\r | |
207 | #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r | |
208 | #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r | |
209 | #define EFI_SECTION_RAW 0x19\r | |
210 | #define EFI_SECTION_PEI_DEPEX 0x1B\r | |
3d4d4cfa | 211 | #define EFI_SECTION_SMM_DEPEX 0x1C\r |
959ccb23 | 212 | \r |
dc53faa3 | 213 | ///\r |
af2dc6a7 | 214 | /// Common section header.\r |
dc53faa3 | 215 | /// \r |
959ccb23 | 216 | typedef struct {\r |
1bf79370 LG |
217 | ///\r |
218 | /// A 24-bit unsigned integer that contains the total size of the section in bytes, \r | |
219 | /// including the EFI_COMMON_SECTION_HEADER.\r | |
220 | ///\r | |
959ccb23 | 221 | UINT8 Size[3];\r |
222 | EFI_SECTION_TYPE Type;\r | |
1bf79370 LG |
223 | ///\r |
224 | /// Declares the section type.\r | |
225 | ///\r | |
959ccb23 | 226 | } EFI_COMMON_SECTION_HEADER;\r |
227 | \r | |
3d4d4cfa | 228 | typedef struct {\r |
229 | ///\r | |
230 | /// A 24-bit unsigned integer that contains the total size of the section in bytes, \r | |
231 | /// including the EFI_COMMON_SECTION_HEADER.\r | |
232 | ///\r | |
233 | UINT8 Size[3];\r | |
234 | \r | |
235 | EFI_SECTION_TYPE Type;\r | |
236 | \r | |
237 | ///\r | |
af2dc6a7 | 238 | /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If\r |
239 | /// Size is not equal to 0xFFFFFF, then this field does not exist. \r | |
3d4d4cfa | 240 | ///\r |
241 | UINT32 ExtendedSize;\r | |
242 | } EFI_COMMON_SECTION_HEADER2;\r | |
243 | \r | |
dc53faa3 | 244 | ///\r |
245 | /// Leaf section type that contains an \r | |
246 | /// IA-32 16-bit executable image.\r | |
247 | /// \r | |
3d4d4cfa | 248 | typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r |
249 | typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r | |
959ccb23 | 250 | \r |
dc53faa3 | 251 | ///\r |
252 | /// CompressionType of EFI_COMPRESSION_SECTION.\r | |
253 | /// \r | |
959ccb23 | 254 | #define EFI_NOT_COMPRESSED 0x00\r |
255 | #define EFI_STANDARD_COMPRESSION 0x01\r | |
dc53faa3 | 256 | ///\r |
257 | /// An encapsulation section type in which the \r | |
258 | /// section data is compressed.\r | |
259 | /// \r | |
959ccb23 | 260 | typedef struct {\r |
1bf79370 LG |
261 | ///\r |
262 | /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.\r | |
263 | ///\r | |
00edb218 | 264 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
1bf79370 | 265 | ///\r |
af2dc6a7 | 266 | /// The UINT32 that indicates the size of the section data after decompression.\r |
1bf79370 | 267 | ///\r |
00edb218 | 268 | UINT32 UncompressedLength;\r |
1bf79370 LG |
269 | ///\r |
270 | /// Indicates which compression algorithm is used.\r | |
271 | ///\r | |
00edb218 | 272 | UINT8 CompressionType;\r |
959ccb23 | 273 | } EFI_COMPRESSION_SECTION;\r |
274 | \r | |
3d4d4cfa | 275 | typedef struct {\r |
276 | ///\r | |
277 | /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.\r | |
278 | ///\r | |
279 | EFI_COMMON_SECTION_HEADER2 CommonHeader;\r | |
280 | ///\r | |
281 | /// UINT32 that indicates the size of the section data after decompression.\r | |
282 | ///\r | |
283 | UINT32 UncompressedLength;\r | |
284 | ///\r | |
285 | /// Indicates which compression algorithm is used.\r | |
286 | ///\r | |
287 | UINT8 CompressionType;\r | |
288 | } EFI_COMPRESSION_SECTION2;\r | |
289 | \r | |
73d622ed | 290 | ///\r |
291 | /// An encapsulation section type in which the section data is disposable.\r | |
292 | /// A disposable section is an encapsulation section in which the section data may be disposed of during\r | |
293 | /// the process of creating or updating a firmware image without significant impact on the usefulness of\r | |
294 | /// the file. The Type field in the section header is set to EFI_SECTION_DISPOSABLE. This\r | |
295 | /// allows optional or descriptive data to be included with the firmware file which can be removed in\r | |
296 | /// order to conserve space. The contents of this section are implementation specific, but might contain\r | |
297 | /// debug data or detailed integration instructions.\r | |
298 | ///\r | |
3d4d4cfa | 299 | typedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION;\r |
300 | typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2;\r | |
73d622ed | 301 | \r |
dc53faa3 | 302 | ///\r |
af2dc6a7 | 303 | /// The leaf section which could be used to determine the dispatch order of DXEs.\r |
dc53faa3 | 304 | /// \r |
3d4d4cfa | 305 | typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r |
306 | typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r | |
959ccb23 | 307 | \r |
dc53faa3 | 308 | ///\r |
af2dc6a7 | 309 | /// The leaf section which contains a PI FV.\r |
dc53faa3 | 310 | /// \r |
3d4d4cfa | 311 | typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r |
312 | typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r | |
959ccb23 | 313 | \r |
dc53faa3 | 314 | ///\r |
af2dc6a7 | 315 | /// The leaf section which contains a single GUID.\r |
dc53faa3 | 316 | /// \r |
959ccb23 | 317 | typedef struct {\r |
1bf79370 LG |
318 | ///\r |
319 | /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r | |
320 | ///\r | |
00edb218 | 321 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
1bf79370 LG |
322 | ///\r |
323 | /// This GUID is defined by the creator of the file. It is a vendor-defined file type.\r | |
324 | ///\r | |
00edb218 | 325 | EFI_GUID SubTypeGuid;\r |
959ccb23 | 326 | } EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r |
327 | \r | |
3d4d4cfa | 328 | typedef struct {\r |
329 | ///\r | |
af2dc6a7 | 330 | /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.\r |
3d4d4cfa | 331 | ///\r |
332 | EFI_COMMON_SECTION_HEADER2 CommonHeader;\r | |
333 | ///\r | |
334 | /// This GUID is defined by the creator of the file. It is a vendor-defined file type.\r | |
335 | /// \r | |
336 | EFI_GUID SubTypeGuid;\r | |
337 | } EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r | |
338 | \r | |
dc53faa3 | 339 | ///\r |
af2dc6a7 | 340 | /// Attributes of EFI_GUID_DEFINED_SECTION.\r |
dc53faa3 | 341 | /// \r |
959ccb23 | 342 | #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r |
343 | #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r | |
dc53faa3 | 344 | ///\r |
af2dc6a7 | 345 | /// The leaf section which is encapsulation defined by specific GUID.\r |
dc53faa3 | 346 | /// \r |
959ccb23 | 347 | typedef struct {\r |
1bf79370 | 348 | ///\r |
af2dc6a7 | 349 | /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r |
1bf79370 | 350 | ///\r |
00edb218 | 351 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
1bf79370 | 352 | ///\r |
af2dc6a7 | 353 | /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r |
1bf79370 | 354 | ///\r |
00edb218 | 355 | EFI_GUID SectionDefinitionGuid;\r |
1bf79370 LG |
356 | ///\r |
357 | /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.\r | |
358 | ///\r | |
00edb218 | 359 | UINT16 DataOffset;\r |
1bf79370 | 360 | ///\r |
af2dc6a7 | 361 | /// The bit field that declares some specific characteristics of the section contents.\r |
1bf79370 | 362 | ///\r |
00edb218 | 363 | UINT16 Attributes;\r |
959ccb23 | 364 | } EFI_GUID_DEFINED_SECTION;\r |
365 | \r | |
3d4d4cfa | 366 | typedef struct {\r |
367 | ///\r | |
af2dc6a7 | 368 | /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.\r |
3d4d4cfa | 369 | ///\r |
370 | EFI_COMMON_SECTION_HEADER2 CommonHeader;\r | |
371 | ///\r | |
af2dc6a7 | 372 | /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.\r |
3d4d4cfa | 373 | /// \r |
374 | EFI_GUID SectionDefinitionGuid;\r | |
375 | ///\r | |
376 | /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.\r | |
377 | /// \r | |
378 | UINT16 DataOffset;\r | |
379 | ///\r | |
af2dc6a7 | 380 | /// The bit field that declares some specific characteristics of the section contents.\r |
3d4d4cfa | 381 | /// \r |
382 | UINT16 Attributes;\r | |
383 | } EFI_GUID_DEFINED_SECTION2;\r | |
384 | \r | |
dc53faa3 | 385 | ///\r |
af2dc6a7 | 386 | /// The leaf section which contains PE32+ image.\r |
dc53faa3 | 387 | /// \r |
3d4d4cfa | 388 | typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r |
389 | typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r | |
959ccb23 | 390 | \r |
dc53faa3 | 391 | ///\r |
af2dc6a7 | 392 | /// The leaf section used to determine the dispatch order of PEIMs.\r |
dc53faa3 | 393 | /// \r |
3d4d4cfa | 394 | typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r |
395 | typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r | |
396 | \r | |
397 | ///\r | |
398 | /// A leaf section type that contains a position-independent-code (PIC) image.\r | |
399 | /// A PIC image section is a leaf section that contains a position-independent-code (PIC) image.\r | |
400 | /// In addition to normal PE32+ images that contain relocation information, PEIM executables may be\r | |
401 | /// PIC and are referred to as PIC images. A PIC image is the same as a PE32+ image except that all\r | |
402 | /// relocation information has been stripped from the image and the image can be moved and will\r | |
403 | /// execute correctly without performing any relocation or other fix-ups. EFI_PIC_SECTION2 must\r | |
404 | /// be used if the section is 16MB or larger.\r | |
405 | ///\r | |
406 | typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r | |
407 | typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r | |
959ccb23 | 408 | \r |
dc53faa3 | 409 | ///\r |
af2dc6a7 | 410 | /// The leaf section which constains the position-independent-code image.\r |
dc53faa3 | 411 | /// \r |
3d4d4cfa | 412 | typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r |
413 | typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r | |
959ccb23 | 414 | \r |
dc53faa3 | 415 | ///\r |
af2dc6a7 | 416 | /// The leaf section which contains an array of zero or more bytes.\r |
dc53faa3 | 417 | /// \r |
3d4d4cfa | 418 | typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r |
419 | typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r | |
420 | \r | |
421 | /// \r | |
422 | /// The SMM dependency expression section is a leaf section that contains a dependency expression that\r | |
423 | /// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the\r | |
424 | /// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform\r | |
af2dc6a7 | 425 | /// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.\r |
3d4d4cfa | 426 | /// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol\r |
427 | /// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.\r | |
428 | /// \r | |
429 | typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION;\r | |
430 | typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;\r | |
959ccb23 | 431 | \r |
dc53faa3 | 432 | ///\r |
af2dc6a7 | 433 | /// The leaf section which contains a unicode string that \r |
dc53faa3 | 434 | /// is human readable file name.\r |
435 | /// \r | |
959ccb23 | 436 | typedef struct {\r |
00edb218 | 437 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
959ccb23 | 438 | \r |
dc53faa3 | 439 | ///\r |
440 | /// Array of unicode string.\r | |
441 | /// \r | |
00edb218 | 442 | CHAR16 FileNameString[1];\r |
959ccb23 | 443 | } EFI_USER_INTERFACE_SECTION;\r |
444 | \r | |
3d4d4cfa | 445 | typedef struct {\r |
446 | EFI_COMMON_SECTION_HEADER2 CommonHeader;\r | |
447 | CHAR16 FileNameString[1];\r | |
448 | } EFI_USER_INTERFACE_SECTION2;\r | |
959ccb23 | 449 | \r |
dc53faa3 | 450 | ///\r |
af2dc6a7 | 451 | /// The leaf section which contains a numeric build number and\r |
4b503a77 | 452 | /// an optional unicode string that represents the file revision. \r |
dc53faa3 | 453 | /// \r |
959ccb23 | 454 | typedef struct {\r |
00edb218 A |
455 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
456 | UINT16 BuildNumber;\r | |
7b1bf9f6 | 457 | \r |
458 | ///\r | |
459 | /// Array of unicode string.\r | |
460 | /// \r | |
00edb218 | 461 | CHAR16 VersionString[1];\r |
959ccb23 | 462 | } EFI_VERSION_SECTION;\r |
463 | \r | |
3d4d4cfa | 464 | typedef struct {\r |
465 | EFI_COMMON_SECTION_HEADER2 CommonHeader;\r | |
466 | ///\r | |
467 | /// A UINT16 that represents a particular build. Subsequent builds have monotonically\r | |
468 | /// increasing build numbers relative to earlier builds.\r | |
469 | ///\r | |
470 | UINT16 BuildNumber;\r | |
471 | CHAR16 VersionString[1];\r | |
472 | } EFI_VERSION_SECTION2;\r | |
ddd3f471 | 473 | \r |
474 | #define SECTION_SIZE(SectionHeaderPtr) \\r | |
475 | ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r | |
476 | \r | |
62d1e08b | 477 | #pragma pack()\r |
ddd3f471 | 478 | \r |
959ccb23 | 479 | #endif\r |
480 | \r |