2 The firmware file related definitions in PI.
4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available
7 under the terms and conditions of the BSD License which accompanies this
8 distribution. The full text of the license may be found at:
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 File Name: PiFirmwareFile.h
16 @par Revision Reference:
21 #ifndef __PI_FIRMWARE_FILE_H__
22 #define __PI_FIRMWARE_FILE_H__
26 // Used to verify the integrity of the file.
34 } EFI_FFS_INTEGRITY_CHECK
;
36 typedef UINT8 EFI_FV_FILETYPE
;
37 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES
;
38 typedef UINT8 EFI_FFS_FILE_STATE
;
41 // File Types Definitions
43 #define EFI_FV_FILETYPE_ALL 0x00
44 #define EFI_FV_FILETYPE_RAW 0x01
45 #define EFI_FV_FILETYPE_FREEFORM 0x02
46 #define EFI_FV_FILETYPE_SECURITY_CORE 0x03
47 #define EFI_FV_FILETYPE_PEI_CORE 0x04
48 #define EFI_FV_FILETYPE_DXE_CORE 0x05
49 #define EFI_FV_FILETYPE_PEIM 0x06
50 #define EFI_FV_FILETYPE_DRIVER 0x07
51 #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08
52 #define EFI_FV_FILETYPE_APPLICATION 0x09
53 #define EFI_FV_FILETYPE_SMM 0x0A
54 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B
55 #define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C
56 #define EFI_FV_FILETYPE_SMM_CORE 0x0D
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_FIXED 0x04
69 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
70 #define FFS_ATTRIB_CHECKSUM 0x40
72 // FFS_FIXED_CHECKSUM is the checksum value used when the
73 // FFS_ATTRIB_CHECKSUM attribute bit is clear
75 #define FFS_FIXED_CHECKSUM 0xAA
78 // FFS File State Bits.
80 #define EFI_FILE_HEADER_CONSTRUCTION 0x01
81 #define EFI_FILE_HEADER_VALID 0x02
82 #define EFI_FILE_DATA_VALID 0x04
83 #define EFI_FILE_MARKED_FOR_UPDATE 0x08
84 #define EFI_FILE_DELETED 0x10
85 #define EFI_FILE_HEADER_INVALID 0x20
87 #define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION | \
88 EFI_FILE_HEADER_VALID | \
89 EFI_FILE_DATA_VALID | \
90 EFI_FILE_MARKED_FOR_UPDATE | \
92 EFI_FILE_HEADER_INVALID \
96 // Each file begins with the header that describe the
97 // contents and state of the files.
101 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
102 EFI_FV_FILETYPE Type
;
103 EFI_FFS_FILE_ATTRIBUTES Attributes
;
105 EFI_FFS_FILE_STATE State
;
106 } EFI_FFS_FILE_HEADER
;
110 EFI_FFS_INTEGRITY_CHECK IntegrityCheck
;
111 EFI_FV_FILETYPE Type
;
112 EFI_FFS_FILE_ATTRIBUTES Attributes
;
114 EFI_FFS_FILE_STATE State
;
116 } EFI_FFS_FILE_HEADER2
;
118 #define MAX_FFS_SIZE 0x1000000
120 typedef UINT8 EFI_SECTION_TYPE
;
123 // Pseudo type. It is
124 // used as a wild card when retrieving sections. The section
125 // type EFI_SECTION_ALL matches all section types.
127 #define EFI_SECTION_ALL 0x00
130 // Encapsulation section Type values
132 #define EFI_SECTION_COMPRESSION 0x01
134 #define EFI_SECTION_GUID_DEFINED 0x02
137 // Leaf section Type values
139 #define EFI_SECTION_PE32 0x10
140 #define EFI_SECTION_PIC 0x11
141 #define EFI_SECTION_TE 0x12
142 #define EFI_SECTION_DXE_DEPEX 0x13
143 #define EFI_SECTION_VERSION 0x14
144 #define EFI_SECTION_USER_INTERFACE 0x15
145 #define EFI_SECTION_COMPATIBILITY16 0x16
146 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
147 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
148 #define EFI_SECTION_RAW 0x19
149 #define EFI_SECTION_PEI_DEPEX 0x1B
150 #define EFI_SECTION_SMM_DEPEX 0x1C
154 EFI_SECTION_TYPE Type
;
155 } EFI_COMMON_SECTION_HEADER
;
159 EFI_SECTION_TYPE Type
;
161 } EFI_COMMON_SECTION_HEADER2
;
163 #define MAX_SECTION_SIZE 0x1000000
166 // Leaf section type that contains an
167 // IA-32 16-bit executable image.
169 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION
;
170 typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2
;
173 // CompressionType of EFI_COMPRESSION_SECTION.
175 #define EFI_NOT_COMPRESSED 0x00
176 #define EFI_STANDARD_COMPRESSION 0x01
178 // An encapsulation section type in which the
179 // section data is compressed.
182 EFI_COMMON_SECTION_HEADER CommonHeader
;
183 UINT32 UncompressedLength
;
184 UINT8 CompressionType
;
185 } EFI_COMPRESSION_SECTION
;
188 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
189 UINT32 UncompressedLength
;
190 UINT8 CompressionType
;
191 } EFI_COMPRESSION_SECTION2
;
194 // Leaf section which could be used to determine the dispatch order of DXEs.
196 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION
;
197 typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2
;
200 // Leaf section witch contains a PI FV.
202 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
;
203 typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
;
206 // Leaf section which contains a single GUID.
209 EFI_COMMON_SECTION_HEADER CommonHeader
;
210 EFI_GUID SubTypeGuid
;
211 } EFI_FREEFORM_SUBTYPE_GUID_SECTION
;
214 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
215 EFI_GUID SubTypeGuid
;
216 } EFI_FREEFORM_SUBTYPE_GUID_SECTION2
;
219 // Attributes of EFI_GUID_DEFINED_SECTION
221 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
222 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
224 // Leaf section which is encapsulation defined by specific GUID
227 EFI_COMMON_SECTION_HEADER CommonHeader
;
228 EFI_GUID SectionDefinitionGuid
;
231 } EFI_GUID_DEFINED_SECTION
;
234 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
235 EFI_GUID SectionDefinitionGuid
;
238 } EFI_GUID_DEFINED_SECTION2
;
241 // Leaf section which contains PE32+ image.
243 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
;
244 typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2
;
247 // Leaf section which contains PIC image.
249 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION
;
250 typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2
;
253 // Leaf section which used to determine the dispatch order of PEIMs.
255 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
;
256 typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2
;
259 // Leaf section which constains the position-independent-code image.
261 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
;
262 typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2
;
265 // Leaf section which contains an array of zero or more bytes.
267 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
;
268 typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2
;
271 // Leaf section which contains a unicode string that
272 // is human readable file name.
275 EFI_COMMON_SECTION_HEADER CommonHeader
;
278 // Array of unicode string.
280 CHAR16 FileNameString
[1];
281 } EFI_USER_INTERFACE_SECTION
;
284 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
287 // Array of unicode string.
289 CHAR16 FileNameString
[1];
290 } EFI_USER_INTERFACE_SECTION2
;
293 // Leaf section which contains a numeric build number and
294 // an optional unicode string that represent the file revision.
297 EFI_COMMON_SECTION_HEADER CommonHeader
;
299 CHAR16 VersionString
[1];
300 } EFI_VERSION_SECTION
;
303 EFI_COMMON_SECTION_HEADER2 CommonHeader
;
305 CHAR16 VersionString
[1];
306 } EFI_VERSION_SECTION2
;
308 #define SECTION_SIZE(SectionHeaderPtr) \
309 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
314 EFI_COMMON_SECTION_HEADER
*CommonHeader
;
315 EFI_COMPRESSION_SECTION
*CompressionSection
;
316 EFI_GUID_DEFINED_SECTION
*GuidDefinedSection
;
317 EFI_PE32_SECTION
*Pe32Section
;
318 EFI_PIC_SECTION
*PicSection
;
319 EFI_TE_SECTION
*TeSection
;
320 EFI_PEI_DEPEX_SECTION
*PeimHeaderSection
;
321 EFI_DXE_DEPEX_SECTION
*DependencySection
;
322 EFI_VERSION_SECTION
*VersionSection
;
323 EFI_USER_INTERFACE_SECTION
*UISection
;
324 EFI_COMPATIBILITY16_SECTION
*Code16Section
;
325 EFI_FIRMWARE_VOLUME_IMAGE_SECTION
*FVImageSection
;
326 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*FreeformSubtypeSection
;
327 EFI_RAW_SECTION
*RawSection
;
329 // For section whose size is equal or greater than 0x1000000
331 EFI_COMMON_SECTION_HEADER2
*CommonHeader2
;
332 EFI_COMPRESSION_SECTION2
*CompressionSection2
;
333 EFI_GUID_DEFINED_SECTION2
*GuidDefinedSection2
;
334 EFI_PE32_SECTION2
*Pe32Section2
;
335 EFI_PIC_SECTION2
*PicSection2
;
336 EFI_TE_SECTION2
*TeSection2
;
337 EFI_PEI_DEPEX_SECTION2
*PeimHeaderSection2
;
338 EFI_DXE_DEPEX_SECTION2
*DependencySection2
;
339 EFI_VERSION_SECTION2
*VersionSection2
;
340 EFI_USER_INTERFACE_SECTION2
*UISection2
;
341 EFI_COMPATIBILITY16_SECTION2
*Code16Section2
;
342 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2
*FVImageSection2
;
343 EFI_FREEFORM_SUBTYPE_GUID_SECTION2
*FreeformSubtypeSection2
;
344 EFI_RAW_SECTION2
*RawSection2
;
345 } EFI_FILE_SECTION_POINTER
;