projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
BaseTools: Clear build versions to sync with buildtools/BaseTools
[mirror_edk2.git] / BaseTools / Source / C / Include / Common / PiFirmwareFile.h
CommitLineData
30fdf114
LG		 1/** @file\r
2 The firmware file related definitions in PI.\r
3\r
e8a47801 4 Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
30fdf114
LG		 5\r
6 This program and the accompanying materials are licensed and made available\r
7 under the terms and conditions of the BSD License which accompanies this\r
8 distribution. The full text of the license may be found at:\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14 File Name: PiFirmwareFile.h\r
15\r
16 @par Revision Reference:\r
17 Version 1.0.\r
18\r
19**/\r
20\r
21#ifndef __PI_FIRMWARE_FILE_H__\r
22#define __PI_FIRMWARE_FILE_H__\r
23\r
24#pragma pack(1)\r
25//\r
26// Used to verify the integrity of the file.\r
27// \r
28typedef union {\r
29 struct {\r
30 UINT8 Header;\r
31 UINT8 File;\r
32 } Checksum;\r
33 UINT16 Checksum16;\r
34} EFI_FFS_INTEGRITY_CHECK;\r
35\r
36typedef UINT8 EFI_FV_FILETYPE;\r
37typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
38typedef UINT8 EFI_FFS_FILE_STATE;\r
39\r
40//\r
41// File Types Definitions\r
42// \r
43#define EFI_FV_FILETYPE_ALL 0x00\r
44#define EFI_FV_FILETYPE_RAW 0x01\r
45#define EFI_FV_FILETYPE_FREEFORM 0x02\r
46#define EFI_FV_FILETYPE_SECURITY_CORE 0x03\r
47#define EFI_FV_FILETYPE_PEI_CORE 0x04\r
48#define EFI_FV_FILETYPE_DXE_CORE 0x05\r
49#define EFI_FV_FILETYPE_PEIM 0x06\r
50#define EFI_FV_FILETYPE_DRIVER 0x07\r
51#define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08\r
52#define EFI_FV_FILETYPE_APPLICATION 0x09\r
b303ea72 53#define EFI_FV_FILETYPE_SMM 0x0A\r
30fdf114 54#define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r
b303ea72
LG		 55#define EFI_FV_FILETYPE_COMBINED_SMM_DXE 0x0C\r
56#define EFI_FV_FILETYPE_SMM_CORE 0x0D\r
30fdf114
LG		 57#define EFI_FV_FILETYPE_OEM_MIN 0xc0\r
58#define EFI_FV_FILETYPE_OEM_MAX 0xdf\r
59#define EFI_FV_FILETYPE_DEBUG_MIN 0xe0\r
60#define EFI_FV_FILETYPE_DEBUG_MAX 0xef\r
61#define EFI_FV_FILETYPE_FFS_MIN 0xf0\r
62#define EFI_FV_FILETYPE_FFS_MAX 0xff\r
63#define EFI_FV_FILETYPE_FFS_PAD 0xf0\r
64// \r
65// FFS File Attributes.\r
66// \r
e8a47801 67#define FFS_ATTRIB_LARGE_FILE 0x01\r
30fdf114
LG		 68#define FFS_ATTRIB_FIXED 0x04\r
69#define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r
70#define FFS_ATTRIB_CHECKSUM 0x40\r
71//\r
52302d4d 72// FFS_FIXED_CHECKSUM is the checksum value used when the\r
30fdf114 73// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
30fdf114 74//\r
52302d4d 75#define FFS_FIXED_CHECKSUM 0xAA\r
30fdf114
LG		 76\r
77// \r
78// FFS File State Bits.\r
79// \r
80#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
81#define EFI_FILE_HEADER_VALID 0x02\r
82#define EFI_FILE_DATA_VALID 0x04\r
83#define EFI_FILE_MARKED_FOR_UPDATE 0x08\r
84#define EFI_FILE_DELETED 0x10\r
85#define EFI_FILE_HEADER_INVALID 0x20\r
86\r
87#define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION | \\r
88 EFI_FILE_HEADER_VALID | \\r
89 EFI_FILE_DATA_VALID | \\r
90 EFI_FILE_MARKED_FOR_UPDATE | \\r
91 EFI_FILE_DELETED | \\r
92 EFI_FILE_HEADER_INVALID \\r
93 )\r
94\r
95//\r
96// Each file begins with the header that describe the \r
97// contents and state of the files.\r
98// \r
99typedef struct {\r
100 EFI_GUID Name;\r
101 EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
102 EFI_FV_FILETYPE Type;\r
103 EFI_FFS_FILE_ATTRIBUTES Attributes;\r
104 UINT8 Size[3];\r
105 EFI_FFS_FILE_STATE State;\r
106} EFI_FFS_FILE_HEADER;\r
107\r
e8a47801
LG		 108typedef struct {\r
109 EFI_GUID Name;\r
110 EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
111 EFI_FV_FILETYPE Type;\r
112 EFI_FFS_FILE_ATTRIBUTES Attributes;\r
113 UINT8 Size[3];\r
114 EFI_FFS_FILE_STATE State;\r
115 UINT32 ExtendedSize;\r
116} EFI_FFS_FILE_HEADER2;\r
117\r
118#define MAX_FFS_SIZE 0x1000000\r
30fdf114
LG		 119\r
120typedef UINT8 EFI_SECTION_TYPE;\r
121\r
122//\r
123// Pseudo type. It is\r
124// used as a wild card when retrieving sections. The section\r
125// type EFI_SECTION_ALL matches all section types.\r
126//\r
127#define EFI_SECTION_ALL 0x00\r
128\r
129//\r
130// Encapsulation section Type values\r
131//\r
132#define EFI_SECTION_COMPRESSION 0x01\r
133\r
134#define EFI_SECTION_GUID_DEFINED 0x02\r
135\r
136//\r
137// Leaf section Type values\r
138//\r
139#define EFI_SECTION_PE32 0x10\r
140#define EFI_SECTION_PIC 0x11\r
141#define EFI_SECTION_TE 0x12\r
142#define EFI_SECTION_DXE_DEPEX 0x13\r
143#define EFI_SECTION_VERSION 0x14\r
144#define EFI_SECTION_USER_INTERFACE 0x15\r
145#define EFI_SECTION_COMPATIBILITY16 0x16\r
146#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
147#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
148#define EFI_SECTION_RAW 0x19\r
149#define EFI_SECTION_PEI_DEPEX 0x1B\r
fd171542 150#define EFI_SECTION_SMM_DEPEX 0x1C\r
30fdf114
LG		 151\r
152typedef struct {\r
153 UINT8 Size[3];\r
154 EFI_SECTION_TYPE Type;\r
155} EFI_COMMON_SECTION_HEADER;\r
156\r
e8a47801
LG		 157typedef struct {\r
158 UINT8 Size[3];\r
159 EFI_SECTION_TYPE Type;\r
160 UINT32 ExtendedSize;\r
161} EFI_COMMON_SECTION_HEADER2;\r
162\r
163#define MAX_SECTION_SIZE 0x1000000\r
164\r
30fdf114
LG		 165//\r
166// Leaf section type that contains an \r
167// IA-32 16-bit executable image.\r
168// \r
169typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
e8a47801 170typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2;\r
30fdf114
LG		 171\r
172//\r
173// CompressionType of EFI_COMPRESSION_SECTION.\r
174// \r
175#define EFI_NOT_COMPRESSED 0x00\r
176#define EFI_STANDARD_COMPRESSION 0x01\r
177//\r
178// An encapsulation section type in which the \r
179// section data is compressed.\r
180// \r
181typedef struct {\r
182 EFI_COMMON_SECTION_HEADER CommonHeader;\r
183 UINT32 UncompressedLength;\r
184 UINT8 CompressionType;\r
185} EFI_COMPRESSION_SECTION;\r
186\r
e8a47801
LG		 187typedef struct {\r
188 EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
189 UINT32 UncompressedLength;\r
190 UINT8 CompressionType;\r
191} EFI_COMPRESSION_SECTION2;\r
192\r
30fdf114
LG		 193//\r
194// Leaf section which could be used to determine the dispatch order of DXEs.\r
195// \r
196typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
e8a47801 197typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2;\r
30fdf114
LG		 198\r
199//\r
200// Leaf section witch contains a PI FV.\r
201// \r
202typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
e8a47801 203typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2;\r
30fdf114
LG		 204\r
205//\r
206// Leaf section which contains a single GUID.\r
207// \r
208typedef struct {\r
209 EFI_COMMON_SECTION_HEADER CommonHeader;\r
210 EFI_GUID SubTypeGuid;\r
211} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
212\r
e8a47801
LG		 213typedef struct {\r
214 EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
215 EFI_GUID SubTypeGuid;\r
216} EFI_FREEFORM_SUBTYPE_GUID_SECTION2;\r
217\r
30fdf114
LG		 218//\r
219// Attributes of EFI_GUID_DEFINED_SECTION\r
220// \r
221#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
222#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
223//\r
224// Leaf section which is encapsulation defined by specific GUID\r
225// \r
226typedef struct {\r
227 EFI_COMMON_SECTION_HEADER CommonHeader;\r
228 EFI_GUID SectionDefinitionGuid;\r
229 UINT16 DataOffset;\r
230 UINT16 Attributes;\r
231} EFI_GUID_DEFINED_SECTION;\r
232\r
e8a47801
LG		 233typedef struct {\r
234 EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
235 EFI_GUID SectionDefinitionGuid;\r
236 UINT16 DataOffset;\r
237 UINT16 Attributes;\r
238} EFI_GUID_DEFINED_SECTION2;\r
239\r
30fdf114
LG		 240//\r
241// Leaf section which contains PE32+ image.\r
242// \r
243typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
e8a47801 244typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;\r
30fdf114
LG		 245\r
246//\r
247// Leaf section which contains PIC image.\r
248// \r
249typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
e8a47801 250typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;\r
30fdf114
LG		 251\r
252//\r
253// Leaf section which used to determine the dispatch order of PEIMs.\r
254// \r
255typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
e8a47801 256typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2;\r
30fdf114
LG		 257\r
258//\r
259// Leaf section which constains the position-independent-code image.\r
260// \r
261typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
e8a47801 262typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2;\r
30fdf114
LG		 263\r
264//\r
265// Leaf section which contains an array of zero or more bytes.\r
266// \r
267typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
e8a47801 268typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2;\r
30fdf114
LG		 269\r
270//\r
271// Leaf section which contains a unicode string that \r
272// is human readable file name.\r
273// \r
274typedef struct {\r
275 EFI_COMMON_SECTION_HEADER CommonHeader;\r
276\r
277 //\r
278 // Array of unicode string.\r
279 // \r
280 CHAR16 FileNameString[1];\r
281} EFI_USER_INTERFACE_SECTION;\r
282\r
e8a47801
LG		 283typedef struct {\r
284 EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
285\r
286 //\r
287 // Array of unicode string.\r
288 // \r
289 CHAR16 FileNameString[1];\r
290} EFI_USER_INTERFACE_SECTION2;\r
30fdf114
LG		 291\r
292//\r
293// Leaf section which contains a numeric build number and\r
294// an optional unicode string that represent the file revision. \r
295// \r
296typedef struct {\r
297 EFI_COMMON_SECTION_HEADER CommonHeader;\r
298 UINT16 BuildNumber;\r
299 CHAR16 VersionString[1];\r
300} EFI_VERSION_SECTION;\r
301\r
e8a47801
LG		 302typedef struct {\r
303 EFI_COMMON_SECTION_HEADER2 CommonHeader;\r
304 UINT16 BuildNumber;\r
305 CHAR16 VersionString[1];\r
306} EFI_VERSION_SECTION2;\r
30fdf114
LG		 307\r
308#define SECTION_SIZE(SectionHeaderPtr) \\r
309 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
310\r
311#pragma pack()\r
312\r
313typedef union {\r
314 EFI_COMMON_SECTION_HEADER *CommonHeader;\r
315 EFI_COMPRESSION_SECTION *CompressionSection;\r
316 EFI_GUID_DEFINED_SECTION *GuidDefinedSection;\r
317 EFI_PE32_SECTION *Pe32Section;\r
318 EFI_PIC_SECTION *PicSection;\r
319 EFI_TE_SECTION *TeSection;\r
320 EFI_PEI_DEPEX_SECTION *PeimHeaderSection;\r
321 EFI_DXE_DEPEX_SECTION *DependencySection;\r
322 EFI_VERSION_SECTION *VersionSection;\r
323 EFI_USER_INTERFACE_SECTION *UISection;\r
324 EFI_COMPATIBILITY16_SECTION *Code16Section;\r
325 EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
326 EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
327 EFI_RAW_SECTION *RawSection;\r
e8a47801
LG		 328 //\r
329 // For section whose size is equal or greater than 0x1000000\r
330 //\r
331 EFI_COMMON_SECTION_HEADER2 *CommonHeader2;\r
332 EFI_COMPRESSION_SECTION2 *CompressionSection2;\r
333 EFI_GUID_DEFINED_SECTION2 *GuidDefinedSection2;\r
334 EFI_PE32_SECTION2 *Pe32Section2;\r
335 EFI_PIC_SECTION2 *PicSection2;\r
336 EFI_TE_SECTION2 *TeSection2;\r
337 EFI_PEI_DEPEX_SECTION2 *PeimHeaderSection2;\r
338 EFI_DXE_DEPEX_SECTION2 *DependencySection2;\r
339 EFI_VERSION_SECTION2 *VersionSection2;\r
340 EFI_USER_INTERFACE_SECTION2 *UISection2;\r
341 EFI_COMPATIBILITY16_SECTION2 *Code16Section2;\r
342 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2 *FVImageSection2;\r
343 EFI_FREEFORM_SUBTYPE_GUID_SECTION2 *FreeformSubtypeSection2;\r
344 EFI_RAW_SECTION2 *RawSection2;\r
30fdf114
LG		 345} EFI_FILE_SECTION_POINTER;\r
346\r
347#endif\r
348\r
EFI Development Kit II mirror for PVE