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