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