2 The firmware file related definitions in PI.
4 @par Revision Reference:
7 Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
9 This program and the accompanying materials are licensed and made available
10 under the terms and conditions of the BSD License which accompanies this
11 distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #ifndef __PI_FIRMWARE_FILE_H__
20 #define __PI_FIRMWARE_FILE_H__
24 // Used to verify the integrity of the file.
32 } EFI_FFS_INTEGRITY_CHECK
;
34 typedef UINT8 EFI_FV_FILETYPE
;
35 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES
;
36 typedef UINT8 EFI_FFS_FILE_STATE
;
39 // File Types Definitions
41 #define EFI_FV_FILETYPE_ALL 0x00
42 #define EFI_FV_FILETYPE_RAW 0x01
43 #define EFI_FV_FILETYPE_FREEFORM 0x02
44 #define EFI_FV_FILETYPE_SECURITY_CORE 0x03
45 #define EFI_FV_FILETYPE_PEI_CORE 0x04
46 #define EFI_FV_FILETYPE_DXE_CORE 0x05
47 #define EFI_FV_FILETYPE_PEIM 0x06
48 #define EFI_FV_FILETYPE_DRIVER 0x07
49 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08
50 #define EFI_FV_FILETYPE_APPLICATION 0x09
51 #define EFI_FV_FILETYPE_SMM 0x0A
52 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
53 #define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C
54 #define EFI_FV_FILETYPE_SMM_CORE 0x0D
55 #define EFI_FV_FILETYPE_MM_STANDALONE 0x0E
56 #define EFI_FV_FILETYPE_MM_CORE_STANDALONE 0x0F
57 #define EFI_FV_FILETYPE_OEM_MIN 0xc0
58 #define EFI_FV_FILETYPE_OEM_MAX 0xdf
59 #define EFI_FV_FILETYPE_DEBUG_MIN 0xe0
60 #define EFI_FV_FILETYPE_DEBUG_MAX 0xef
61 #define EFI_FV_FILETYPE_FFS_MIN 0xf0
62 #define EFI_FV_FILETYPE_FFS_MAX 0xff
63 #define EFI_FV_FILETYPE_FFS_PAD 0xf0
65 // FFS File Attributes.
67 #define FFS_ATTRIB_LARGE_FILE 0x01
68 #define FFS_ATTRIB_DATA_ALIGNMENT2 0x02
69 #define FFS_ATTRIB_FIXED 0x04
70 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
71 #define FFS_ATTRIB_CHECKSUM 0x40
73 // FFS_FIXED_CHECKSUM is the checksum value used when the
74 // FFS_ATTRIB_CHECKSUM attribute bit is clear
76 #define FFS_FIXED_CHECKSUM 0xAA
79 // FFS File State Bits.
81 #define EFI_FILE_HEADER_CONSTRUCTION 0x01
82 #define EFI_FILE_HEADER_VALID 0x02
83 #define EFI_FILE_DATA_VALID 0x04
84 #define EFI_FILE_MARKED_FOR_UPDATE 0x08
85 #define EFI_FILE_DELETED 0x10
86 #define EFI_FILE_HEADER_INVALID 0x20
88 #define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION | \
89 EFI_FILE_HEADER_VALID | \
90 EFI_FILE_DATA_VALID | \
91 EFI_FILE_MARKED_FOR_UPDATE | \
93 EFI_FILE_HEADER_INVALID \
97 // Each file begins with the header that describe the
98 // contents and state of the files.
102 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
103 EFI_FV_FILETYPE Type
;
104 EFI_FFS_FILE_ATTRIBUTES Attributes
;
106 EFI_FFS_FILE_STATE State
;
107 } EFI_FFS_FILE_HEADER
;
111 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
112 EFI_FV_FILETYPE Type
;
113 EFI_FFS_FILE_ATTRIBUTES Attributes
;
115 EFI_FFS_FILE_STATE State
;
117 } EFI_FFS_FILE_HEADER2
;
119 #define MAX_FFS_SIZE 0x1000000
121 typedef UINT8 EFI_SECTION_TYPE
;
124 // Pseudo type. It is
125 // used as a wild card when retrieving sections. The section
126 // type EFI_SECTION_ALL matches all section types.
128 #define EFI_SECTION_ALL 0x00
131 // Encapsulation section Type values
133 #define EFI_SECTION_COMPRESSION 0x01
135 #define EFI_SECTION_GUID_DEFINED 0x02
138 // Leaf section Type values
140 #define EFI_SECTION_PE32 0x10
141 #define EFI_SECTION_PIC 0x11
142 #define EFI_SECTION_TE 0x12
143 #define EFI_SECTION_DXE_DEPEX 0x13
144 #define EFI_SECTION_VERSION 0x14
145 #define EFI_SECTION_USER_INTERFACE 0x15
146 #define EFI_SECTION_COMPATIBILITY16 0x16
147 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
148 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
149 #define EFI_SECTION_RAW 0x19
150 #define EFI_SECTION_PEI_DEPEX 0x1B
151 #define EFI_SECTION_SMM_DEPEX 0x1C
155 EFI_SECTION_TYPE Type
;
156 } EFI_COMMON_SECTION_HEADER
;
160 EFI_SECTION_TYPE Type
;
162 } EFI_COMMON_SECTION_HEADER2
;
164 #define MAX_SECTION_SIZE 0x1000000
167 // Leaf section type that contains an
168 // IA-32 16-bit executable image.
170 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION
;
171 typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2
;
174 // CompressionType of EFI_COMPRESSION_SECTION.
176 #define EFI_NOT_COMPRESSED 0x00
177 #define EFI_STANDARD_COMPRESSION 0x01
179 // An encapsulation section type in which the
180 // section data is compressed.
183 EFI_COMMON_SECTION_HEADER CommonHeader
;
184 UINT32 UncompressedLength
;
185 UINT8 CompressionType
;
186 } EFI_COMPRESSION_SECTION
;
189 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
190 UINT32 UncompressedLength
;
191 UINT8 CompressionType
;
192 } EFI_COMPRESSION_SECTION2
;
195 // Leaf section which could be used to determine the dispatch order of DXEs.
197 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION
;
198 typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2
;
201 // Leaf section witch contains a PI FV.
203 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
;
204 typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
;
207 // Leaf section which contains a single GUID.
210 EFI_COMMON_SECTION_HEADER CommonHeader
;
211 EFI_GUID SubTypeGuid
;
212 } EFI_FREEFORM_SUBTYPE_GUID_SECTION
;
215 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
216 EFI_GUID SubTypeGuid
;
217 } EFI_FREEFORM_SUBTYPE_GUID_SECTION2
;
220 // Attributes of EFI_GUID_DEFINED_SECTION
222 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
223 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
225 // Leaf section which is encapsulation defined by specific GUID
228 EFI_COMMON_SECTION_HEADER CommonHeader
;
229 EFI_GUID SectionDefinitionGuid
;
232 } EFI_GUID_DEFINED_SECTION
;
235 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
236 EFI_GUID SectionDefinitionGuid
;
239 } EFI_GUID_DEFINED_SECTION2
;
242 // Leaf section which contains PE32+ image.
244 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
;
245 typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2
;
248 // Leaf section which contains PIC image.
250 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION
;
251 typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2
;
254 // Leaf section which used to determine the dispatch order of PEIMs.
256 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
;
257 typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2
;
260 // Leaf section which constains the position-independent-code image.
262 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
;
263 typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2
;
266 // Leaf section which contains an array of zero or more bytes.
268 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
;
269 typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2
;
272 // Leaf section which contains a unicode string that
273 // is human readable file name.
276 EFI_COMMON_SECTION_HEADER CommonHeader
;
279 // Array of unicode string.
281 CHAR16 FileNameString
[1];
282 } EFI_USER_INTERFACE_SECTION
;
285 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
288 // Array of unicode string.
290 CHAR16 FileNameString
[1];
291 } EFI_USER_INTERFACE_SECTION2
;
294 // Leaf section which contains a numeric build number and
295 // an optional unicode string that represent the file revision.
298 EFI_COMMON_SECTION_HEADER CommonHeader
;
300 CHAR16 VersionString
[1];
301 } EFI_VERSION_SECTION
;
304 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
306 CHAR16 VersionString
[1];
307 } EFI_VERSION_SECTION2
;
309 #define SECTION_SIZE(SectionHeaderPtr) \
310 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
315 EFI_COMMON_SECTION_HEADER
*CommonHeader
;
316 EFI_COMPRESSION_SECTION
*CompressionSection
;
317 EFI_GUID_DEFINED_SECTION
*GuidDefinedSection
;
318 EFI_PE32_SECTION
*Pe32Section
;
319 EFI_PIC_SECTION
*PicSection
;
320 EFI_TE_SECTION
*TeSection
;
321 EFI_PEI_DEPEX_SECTION
*PeimHeaderSection
;
322 EFI_DXE_DEPEX_SECTION
*DependencySection
;
323 EFI_VERSION_SECTION
*VersionSection
;
324 EFI_USER_INTERFACE_SECTION
*UISection
;
325 EFI_COMPATIBILITY16_SECTION
*Code16Section
;
326 EFI_FIRMWARE_VOLUME_IMAGE_SECTION
*FVImageSection
;
327 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*FreeformSubtypeSection
;
328 EFI_RAW_SECTION
*RawSection
;
330 // For section whose size is equal or greater than 0x1000000
332 EFI_COMMON_SECTION_HEADER2
*CommonHeader2
;
333 EFI_COMPRESSION_SECTION2
*CompressionSection2
;
334 EFI_GUID_DEFINED_SECTION2
*GuidDefinedSection2
;
335 EFI_PE32_SECTION2
*Pe32Section2
;
336 EFI_PIC_SECTION2
*PicSection2
;
337 EFI_TE_SECTION2
*TeSection2
;
338 EFI_PEI_DEPEX_SECTION2
*PeimHeaderSection2
;
339 EFI_DXE_DEPEX_SECTION2
*DependencySection2
;
340 EFI_VERSION_SECTION2
*VersionSection2
;
341 EFI_USER_INTERFACE_SECTION2
*UISection2
;
342 EFI_COMPATIBILITY16_SECTION2
*Code16Section2
;
343 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
*FVImageSection2
;
344 EFI_FREEFORM_SUBTYPE_GUID_SECTION2
*FreeformSubtypeSection2
;
345 EFI_RAW_SECTION2
*RawSection2
;
346 } EFI_FILE_SECTION_POINTER
;