]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/C/Include/Common/PiFirmwareFile.h
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Sync tool code to BuildTools project r1739.
[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
4 Copyright (c) 2006 - 2008, Intel Corporation All rights reserved.\r
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
67#define FFS_ATTRIB_FIXED 0x04\r
68#define FFS_ATTRIB_DATA_ALIGNMENT 0x38\r
69#define FFS_ATTRIB_CHECKSUM 0x40\r
70//\r
71// FFS_FIXED_CHECKSUM is the default checksum value used when the\r
72// FFS_ATTRIB_CHECKSUM attribute bit is clear\r
73// note this is NOT an architecturally defined value, but is in this file for\r
74// implementation convenience\r
75//\r
76#define FFS_FIXED_CHECKSUM 0x5A\r
77\r
78// \r
79// FFS File State Bits.\r
80// \r
81#define EFI_FILE_HEADER_CONSTRUCTION 0x01\r
82#define EFI_FILE_HEADER_VALID 0x02\r
83#define EFI_FILE_DATA_VALID 0x04\r
84#define EFI_FILE_MARKED_FOR_UPDATE 0x08\r
85#define EFI_FILE_DELETED 0x10\r
86#define EFI_FILE_HEADER_INVALID 0x20\r
87\r
88#define EFI_FILE_ALL_STATE_BITS (EFI_FILE_HEADER_CONSTRUCTION | \\r
89 EFI_FILE_HEADER_VALID | \\r
90 EFI_FILE_DATA_VALID | \\r
91 EFI_FILE_MARKED_FOR_UPDATE | \\r
92 EFI_FILE_DELETED | \\r
93 EFI_FILE_HEADER_INVALID \\r
94 )\r
95\r
96//\r
97// Each file begins with the header that describe the \r
98// contents and state of the files.\r
99// \r
100typedef struct {\r
101 EFI_GUID Name;\r
102 EFI_FFS_INTEGRITY_CHECK IntegrityCheck;\r
103 EFI_FV_FILETYPE Type;\r
104 EFI_FFS_FILE_ATTRIBUTES Attributes;\r
105 UINT8 Size[3];\r
106 EFI_FFS_FILE_STATE State;\r
107} EFI_FFS_FILE_HEADER;\r
108\r
109\r
110typedef UINT8 EFI_SECTION_TYPE;\r
111\r
112//\r
113// Pseudo type. It is\r
114// used as a wild card when retrieving sections. The section\r
115// type EFI_SECTION_ALL matches all section types.\r
116//\r
117#define EFI_SECTION_ALL 0x00\r
118\r
119//\r
120// Encapsulation section Type values\r
121//\r
122#define EFI_SECTION_COMPRESSION 0x01\r
123\r
124#define EFI_SECTION_GUID_DEFINED 0x02\r
125\r
126//\r
127// Leaf section Type values\r
128//\r
129#define EFI_SECTION_PE32 0x10\r
130#define EFI_SECTION_PIC 0x11\r
131#define EFI_SECTION_TE 0x12\r
132#define EFI_SECTION_DXE_DEPEX 0x13\r
133#define EFI_SECTION_VERSION 0x14\r
134#define EFI_SECTION_USER_INTERFACE 0x15\r
135#define EFI_SECTION_COMPATIBILITY16 0x16\r
136#define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
137#define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
138#define EFI_SECTION_RAW 0x19\r
139#define EFI_SECTION_PEI_DEPEX 0x1B\r
fd171542 140#define EFI_SECTION_SMM_DEPEX 0x1C\r
30fdf114
LG		 141\r
142typedef struct {\r
143 UINT8 Size[3];\r
144 EFI_SECTION_TYPE Type;\r
145} EFI_COMMON_SECTION_HEADER;\r
146\r
147//\r
148// Leaf section type that contains an \r
149// IA-32 16-bit executable image.\r
150// \r
151typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
152\r
153//\r
154// CompressionType of EFI_COMPRESSION_SECTION.\r
155// \r
156#define EFI_NOT_COMPRESSED 0x00\r
157#define EFI_STANDARD_COMPRESSION 0x01\r
158//\r
159// An encapsulation section type in which the \r
160// section data is compressed.\r
161// \r
162typedef struct {\r
163 EFI_COMMON_SECTION_HEADER CommonHeader;\r
164 UINT32 UncompressedLength;\r
165 UINT8 CompressionType;\r
166} EFI_COMPRESSION_SECTION;\r
167\r
168//\r
169// Leaf section which could be used to determine the dispatch order of DXEs.\r
170// \r
171typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
172\r
173//\r
174// Leaf section witch contains a PI FV.\r
175// \r
176typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
177\r
178//\r
179// Leaf section which contains a single GUID.\r
180// \r
181typedef struct {\r
182 EFI_COMMON_SECTION_HEADER CommonHeader;\r
183 EFI_GUID SubTypeGuid;\r
184} EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
185\r
186//\r
187// Attributes of EFI_GUID_DEFINED_SECTION\r
188// \r
189#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r
190#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r
191//\r
192// Leaf section which is encapsulation defined by specific GUID\r
193// \r
194typedef struct {\r
195 EFI_COMMON_SECTION_HEADER CommonHeader;\r
196 EFI_GUID SectionDefinitionGuid;\r
197 UINT16 DataOffset;\r
198 UINT16 Attributes;\r
199} EFI_GUID_DEFINED_SECTION;\r
200\r
201//\r
202// Leaf section which contains PE32+ image.\r
203// \r
204typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
205\r
206//\r
207// Leaf section which contains PIC image.\r
208// \r
209typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
210\r
211//\r
212// Leaf section which used to determine the dispatch order of PEIMs.\r
213// \r
214typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
215\r
216//\r
217// Leaf section which constains the position-independent-code image.\r
218// \r
219typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
220\r
221//\r
222// Leaf section which contains an array of zero or more bytes.\r
223// \r
224typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
225\r
226//\r
227// Leaf section which contains a unicode string that \r
228// is human readable file name.\r
229// \r
230typedef struct {\r
231 EFI_COMMON_SECTION_HEADER CommonHeader;\r
232\r
233 //\r
234 // Array of unicode string.\r
235 // \r
236 CHAR16 FileNameString[1];\r
237} EFI_USER_INTERFACE_SECTION;\r
238\r
239\r
240//\r
241// Leaf section which contains a numeric build number and\r
242// an optional unicode string that represent the file revision. \r
243// \r
244typedef struct {\r
245 EFI_COMMON_SECTION_HEADER CommonHeader;\r
246 UINT16 BuildNumber;\r
247 CHAR16 VersionString[1];\r
248} EFI_VERSION_SECTION;\r
249\r
250\r
251#define SECTION_SIZE(SectionHeaderPtr) \\r
252 ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
253\r
254#pragma pack()\r
255\r
256typedef union {\r
257 EFI_COMMON_SECTION_HEADER *CommonHeader;\r
258 EFI_COMPRESSION_SECTION *CompressionSection;\r
259 EFI_GUID_DEFINED_SECTION *GuidDefinedSection;\r
260 EFI_PE32_SECTION *Pe32Section;\r
261 EFI_PIC_SECTION *PicSection;\r
262 EFI_TE_SECTION *TeSection;\r
263 EFI_PEI_DEPEX_SECTION *PeimHeaderSection;\r
264 EFI_DXE_DEPEX_SECTION *DependencySection;\r
265 EFI_VERSION_SECTION *VersionSection;\r
266 EFI_USER_INTERFACE_SECTION *UISection;\r
267 EFI_COMPATIBILITY16_SECTION *Code16Section;\r
268 EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
269 EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
270 EFI_RAW_SECTION *RawSection;\r
271} EFI_FILE_SECTION_POINTER;\r
272\r
273#endif\r
274\r
EFI Development Kit II mirror for PVE