2 The firmware file related definitions in PI.
4 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 @par Revision Reference:
19 #ifndef __PI_FIRMWARE_FILE_H__
20 #define __PI_FIRMWARE_FILE_H__
24 /// Used to verify the integrity of the file.
29 /// The IntegrityCheck.Checksum.Header field is an 8-bit checksum of the file
30 /// header. The State and IntegrityCheck.Checksum.File fields are assumed
31 /// to be zero and the checksum is calculated such that the entire header sums to zero.
35 /// If the FFS_ATTRIB_CHECKSUM (see definition below) bit of the Attributes
36 /// field is set to one, the IntegrityCheck.Checksum.File field is an 8-bit
37 /// checksum of the file data.
38 /// If the FFS_ATTRIB_CHECKSUM bit of the Attributes field is cleared to zero,
39 /// the IntegrityCheck.Checksum.File field must be initialized with a value of
40 /// 0xAA. The IntegrityCheck.Checksum.File field is valid any time the
41 /// EFI_FILE_DATA_VALID bit is set in the State field.
46 /// This is the full 16 bits of the IntegrityCheck field.
49 } EFI_FFS_INTEGRITY_CHECK
;
52 /// FFS_FIXED_CHECKSUM is the checksum value used when the
53 /// FFS_ATTRIB_CHECKSUM attribute bit is clear.
55 #define FFS_FIXED_CHECKSUM 0xAA
57 typedef UINT8 EFI_FV_FILETYPE
;
58 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES
;
59 typedef UINT8 EFI_FFS_FILE_STATE
;
62 /// File Types Definitions
64 #define EFI_FV_FILETYPE_ALL 0x00
65 #define EFI_FV_FILETYPE_RAW 0x01
66 #define EFI_FV_FILETYPE_FREEFORM 0x02
67 #define EFI_FV_FILETYPE_SECURITY_CORE 0x03
68 #define EFI_FV_FILETYPE_PEI_CORE 0x04
69 #define EFI_FV_FILETYPE_DXE_CORE 0x05
70 #define EFI_FV_FILETYPE_PEIM 0x06
71 #define EFI_FV_FILETYPE_DRIVER 0x07
72 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08
73 #define EFI_FV_FILETYPE_APPLICATION 0x09
74 #define EFI_FV_FILETYPE_SMM 0x0A
75 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
76 #define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C
77 #define EFI_FV_FILETYPE_SMM_CORE 0x0D
78 #define EFI_FV_FILETYPE_OEM_MIN 0xc0
79 #define EFI_FV_FILETYPE_OEM_MAX 0xdf
80 #define EFI_FV_FILETYPE_DEBUG_MIN 0xe0
81 #define EFI_FV_FILETYPE_DEBUG_MAX 0xef
82 #define EFI_FV_FILETYPE_FFS_MIN 0xf0
83 #define EFI_FV_FILETYPE_FFS_MAX 0xff
84 #define EFI_FV_FILETYPE_FFS_PAD 0xf0
86 /// FFS File Attributes.
88 #define FFS_ATTRIB_LARGE_FILE 0x01
89 #define FFS_ATTRIB_FIXED 0x04
90 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
91 #define FFS_ATTRIB_CHECKSUM 0x40
94 /// FFS File State Bits.
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
105 /// Each file begins with the header that describe the
106 /// contents and state of the files.
110 /// This GUID is the file name. It is used to uniquely identify the file.
114 /// Used to verify the integrity of the file.
116 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
118 /// Identifies the type of file.
120 EFI_FV_FILETYPE Type
;
122 /// Declares various file attribute bits.
124 EFI_FFS_FILE_ATTRIBUTES Attributes
;
126 /// The length of the file in bytes, including the FFS header.
130 /// Used to track the state of the file throughout the life of the file from creation to deletion.
132 EFI_FFS_FILE_STATE State
;
133 } EFI_FFS_FILE_HEADER
;
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.
144 /// Used to verify the integrity of the file.
146 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
149 /// Identifies the type of file.
151 EFI_FV_FILETYPE Type
;
154 /// Declares various file attribute bits.
156 EFI_FFS_FILE_ATTRIBUTES Attributes
;
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.
168 /// Used to track the state of the file throughout the life of the file from creation to deletion.
170 EFI_FFS_FILE_STATE State
;
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.
176 EFI_FFS_FILE_STATE ExtendedSize
;
177 } EFI_FFS_FILE_HEADER2
;
179 typedef UINT8 EFI_SECTION_TYPE
;
182 /// Pseudo type. It is used as a wild card when retrieving sections.
183 /// The section type EFI_SECTION_ALL matches all section types.
185 #define EFI_SECTION_ALL 0x00
188 /// Encapsulation section Type values.
190 #define EFI_SECTION_COMPRESSION 0x01
192 #define EFI_SECTION_GUID_DEFINED 0x02
194 #define EFI_SECTION_DISPOSABLE 0x03
197 /// Leaf section Type values.
199 #define EFI_SECTION_PE32 0x10
200 #define EFI_SECTION_PIC 0x11
201 #define EFI_SECTION_TE 0x12
202 #define EFI_SECTION_DXE_DEPEX 0x13
203 #define EFI_SECTION_VERSION 0x14
204 #define EFI_SECTION_USER_INTERFACE 0x15
205 #define EFI_SECTION_COMPATIBILITY16 0x16
206 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
207 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
208 #define EFI_SECTION_RAW 0x19
209 #define EFI_SECTION_PEI_DEPEX 0x1B
210 #define EFI_SECTION_SMM_DEPEX 0x1C
213 /// Common section header.
217 /// A 24-bit unsigned integer that contains the total size of the section in bytes,
218 /// including the EFI_COMMON_SECTION_HEADER.
221 EFI_SECTION_TYPE Type
;
223 /// Declares the section type.
225 } EFI_COMMON_SECTION_HEADER
;
229 /// A 24-bit unsigned integer that contains the total size of the section in bytes,
230 /// including the EFI_COMMON_SECTION_HEADER.
234 EFI_SECTION_TYPE Type
;
237 /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If
238 /// Size is not equal to 0xFFFFFF, then this field does not exist.
241 } EFI_COMMON_SECTION_HEADER2
;
244 /// Leaf section type that contains an
245 /// IA-32 16-bit executable image.
247 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION
;
248 typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2
;
251 /// CompressionType of EFI_COMPRESSION_SECTION.
253 #define EFI_NOT_COMPRESSED 0x00
254 #define EFI_STANDARD_COMPRESSION 0x01
256 /// An encapsulation section type in which the
257 /// section data is compressed.
261 /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
263 EFI_COMMON_SECTION_HEADER CommonHeader
;
265 /// The UINT32 that indicates the size of the section data after decompression.
267 UINT32 UncompressedLength
;
269 /// Indicates which compression algorithm is used.
271 UINT8 CompressionType
;
272 } EFI_COMPRESSION_SECTION
;
276 /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION.
278 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
280 /// UINT32 that indicates the size of the section data after decompression.
282 UINT32 UncompressedLength
;
284 /// Indicates which compression algorithm is used.
286 UINT8 CompressionType
;
287 } EFI_COMPRESSION_SECTION2
;
290 /// An encapsulation section type in which the section data is disposable.
291 /// A disposable section is an encapsulation section in which the section data may be disposed of during
292 /// the process of creating or updating a firmware image without significant impact on the usefulness of
293 /// the file. The Type field in the section header is set to EFI_SECTION_DISPOSABLE. This
294 /// allows optional or descriptive data to be included with the firmware file which can be removed in
295 /// order to conserve space. The contents of this section are implementation specific, but might contain
296 /// debug data or detailed integration instructions.
298 typedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION
;
299 typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2
;
302 /// The leaf section which could be used to determine the dispatch order of DXEs.
304 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION
;
305 typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2
;
308 /// The leaf section which contains a PI FV.
310 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
;
311 typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
;
314 /// The leaf section which contains a single GUID.
318 /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
320 EFI_COMMON_SECTION_HEADER CommonHeader
;
322 /// This GUID is defined by the creator of the file. It is a vendor-defined file type.
324 EFI_GUID SubTypeGuid
;
325 } EFI_FREEFORM_SUBTYPE_GUID_SECTION
;
329 /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
331 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
333 /// This GUID is defined by the creator of the file. It is a vendor-defined file type.
335 EFI_GUID SubTypeGuid
;
336 } EFI_FREEFORM_SUBTYPE_GUID_SECTION2
;
339 /// Attributes of EFI_GUID_DEFINED_SECTION.
341 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
342 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
344 /// The leaf section which is encapsulation defined by specific GUID.
348 /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
350 EFI_COMMON_SECTION_HEADER CommonHeader
;
352 /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
354 EFI_GUID SectionDefinitionGuid
;
356 /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
360 /// The bit field that declares some specific characteristics of the section contents.
363 } EFI_GUID_DEFINED_SECTION
;
367 /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
369 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
371 /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
373 EFI_GUID SectionDefinitionGuid
;
375 /// Contains the offset in bytes from the beginning of the common header to the first byte of the data.
379 /// The bit field that declares some specific characteristics of the section contents.
382 } EFI_GUID_DEFINED_SECTION2
;
385 /// The leaf section which contains PE32+ image.
387 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
;
388 typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2
;
391 /// The leaf section used to determine the dispatch order of PEIMs.
393 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
;
394 typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2
;
397 /// A leaf section type that contains a position-independent-code (PIC) image.
398 /// A PIC image section is a leaf section that contains a position-independent-code (PIC) image.
399 /// In addition to normal PE32+ images that contain relocation information, PEIM executables may be
400 /// PIC and are referred to as PIC images. A PIC image is the same as a PE32+ image except that all
401 /// relocation information has been stripped from the image and the image can be moved and will
402 /// execute correctly without performing any relocation or other fix-ups. EFI_PIC_SECTION2 must
403 /// be used if the section is 16MB or larger.
405 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION
;
406 typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2
;
409 /// The leaf section which constains the position-independent-code image.
411 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
;
412 typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2
;
415 /// The leaf section which contains an array of zero or more bytes.
417 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
;
418 typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2
;
421 /// The SMM dependency expression section is a leaf section that contains a dependency expression that
422 /// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the
423 /// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform
424 /// Initialization Specification, Volume 2, for details regarding the format of the dependency expression.
425 /// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol
426 /// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger.
428 typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION
;
429 typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2
;
432 /// The leaf section which contains a unicode string that
433 /// is human readable file name.
436 EFI_COMMON_SECTION_HEADER CommonHeader
;
439 /// Array of unicode string.
441 CHAR16 FileNameString
[1];
442 } EFI_USER_INTERFACE_SECTION
;
445 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
446 CHAR16 FileNameString
[1];
447 } EFI_USER_INTERFACE_SECTION2
;
450 /// The leaf section which contains a numeric build number and
451 /// an optional unicode string that represents the file revision.
454 EFI_COMMON_SECTION_HEADER CommonHeader
;
458 /// Array of unicode string.
460 CHAR16 VersionString
[1];
461 } EFI_VERSION_SECTION
;
464 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
466 /// A UINT16 that represents a particular build. Subsequent builds have monotonically
467 /// increasing build numbers relative to earlier builds.
470 CHAR16 VersionString
[1];
471 } EFI_VERSION_SECTION2
;
473 #define SECTION_SIZE(SectionHeaderPtr) \
474 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))