2 The firmware file related definitions in PI.
4 Copyright (c) 2006 - 2008, Intel Corporation All rights reserved.
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_FIXED 0x04
68 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
69 #define FFS_ATTRIB_CHECKSUM 0x40
71 // FFS_FIXED_CHECKSUM is the default checksum value used when the
72 // FFS_ATTRIB_CHECKSUM attribute bit is clear
73 // note this is NOT an architecturally defined value, but is in this file for
74 // implementation convenience
76 #define FFS_FIXED_CHECKSUM 0x5A
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
;
110 typedef UINT8 EFI_SECTION_TYPE
;
113 // Pseudo type. It is
114 // used as a wild card when retrieving sections. The section
115 // type EFI_SECTION_ALL matches all section types.
117 #define EFI_SECTION_ALL 0x00
120 // Encapsulation section Type values
122 #define EFI_SECTION_COMPRESSION 0x01
124 #define EFI_SECTION_GUID_DEFINED 0x02
127 // Leaf section Type values
129 #define EFI_SECTION_PE32 0x10
130 #define EFI_SECTION_PIC 0x11
131 #define EFI_SECTION_TE 0x12
132 #define EFI_SECTION_DXE_DEPEX 0x13
133 #define EFI_SECTION_VERSION 0x14
134 #define EFI_SECTION_USER_INTERFACE 0x15
135 #define EFI_SECTION_COMPATIBILITY16 0x16
136 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17
137 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18
138 #define EFI_SECTION_RAW 0x19
139 #define EFI_SECTION_PEI_DEPEX 0x1B
140 #define EFI_SECTION_SMM_DEPEX 0x1C
144 EFI_SECTION_TYPE Type
;
145 } EFI_COMMON_SECTION_HEADER
;
148 // Leaf section type that contains an
149 // IA-32 16-bit executable image.
151 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION
;
154 // CompressionType of EFI_COMPRESSION_SECTION.
156 #define EFI_NOT_COMPRESSED 0x00
157 #define EFI_STANDARD_COMPRESSION 0x01
159 // An encapsulation section type in which the
160 // section data is compressed.
163 EFI_COMMON_SECTION_HEADER CommonHeader
;
164 UINT32 UncompressedLength
;
165 UINT8 CompressionType
;
166 } EFI_COMPRESSION_SECTION
;
169 // Leaf section which could be used to determine the dispatch order of DXEs.
171 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION
;
174 // Leaf section witch contains a PI FV.
176 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION
;
179 // Leaf section which contains a single GUID.
182 EFI_COMMON_SECTION_HEADER CommonHeader
;
183 EFI_GUID SubTypeGuid
;
184 } EFI_FREEFORM_SUBTYPE_GUID_SECTION
;
187 // Attributes of EFI_GUID_DEFINED_SECTION
189 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
190 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
192 // Leaf section which is encapsulation defined by specific GUID
195 EFI_COMMON_SECTION_HEADER CommonHeader
;
196 EFI_GUID SectionDefinitionGuid
;
199 } EFI_GUID_DEFINED_SECTION
;
202 // Leaf section which contains PE32+ image.
204 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION
;
207 // Leaf section which contains PIC image.
209 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION
;
212 // Leaf section which used to determine the dispatch order of PEIMs.
214 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION
;
217 // Leaf section which constains the position-independent-code image.
219 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION
;
222 // Leaf section which contains an array of zero or more bytes.
224 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION
;
227 // Leaf section which contains a unicode string that
228 // is human readable file name.
231 EFI_COMMON_SECTION_HEADER CommonHeader
;
234 // Array of unicode string.
236 CHAR16 FileNameString
[1];
237 } EFI_USER_INTERFACE_SECTION
;
241 // Leaf section which contains a numeric build number and
242 // an optional unicode string that represent the file revision.
245 EFI_COMMON_SECTION_HEADER CommonHeader
;
247 CHAR16 VersionString
[1];
248 } EFI_VERSION_SECTION
;
251 #define SECTION_SIZE(SectionHeaderPtr) \
252 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))
257 EFI_COMMON_SECTION_HEADER
*CommonHeader
;
258 EFI_COMPRESSION_SECTION
*CompressionSection
;
259 EFI_GUID_DEFINED_SECTION
*GuidDefinedSection
;
260 EFI_PE32_SECTION
*Pe32Section
;
261 EFI_PIC_SECTION
*PicSection
;
262 EFI_TE_SECTION
*TeSection
;
263 EFI_PEI_DEPEX_SECTION
*PeimHeaderSection
;
264 EFI_DXE_DEPEX_SECTION
*DependencySection
;
265 EFI_VERSION_SECTION
*VersionSection
;
266 EFI_USER_INTERFACE_SECTION
*UISection
;
267 EFI_COMPATIBILITY16_SECTION
*Code16Section
;
268 EFI_FIRMWARE_VOLUME_IMAGE_SECTION
*FVImageSection
;
269 EFI_FREEFORM_SUBTYPE_GUID_SECTION
*FreeformSubtypeSection
;
270 EFI_RAW_SECTION
*RawSection
;
271 } EFI_FILE_SECTION_POINTER
;