Support PI EFI_SECTION_SMM_DEPEX section.
[efi/basetools/.git] / Source / C / Include / Common / PiFirmwareFile.h
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
28 typedef 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
36 typedef UINT8 EFI_FV_FILETYPE;\r
37 typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;\r
38 typedef 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
53 #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r
54 #define EFI_FV_FILETYPE_OEM_MIN               0xc0\r
55 #define EFI_FV_FILETYPE_OEM_MAX               0xdf\r
56 #define EFI_FV_FILETYPE_DEBUG_MIN             0xe0\r
57 #define EFI_FV_FILETYPE_DEBUG_MAX             0xef\r
58 #define EFI_FV_FILETYPE_FFS_MIN               0xf0\r
59 #define EFI_FV_FILETYPE_FFS_MAX               0xff\r
60 #define EFI_FV_FILETYPE_FFS_PAD               0xf0\r
61 // \r
62 // FFS File Attributes.\r
63 // \r
64 #define FFS_ATTRIB_FIXED              0x04\r
65 #define FFS_ATTRIB_DATA_ALIGNMENT     0x38\r
66 #define FFS_ATTRIB_CHECKSUM           0x40\r
67 //\r
68 // FFS_FIXED_CHECKSUM is the default checksum value used when the\r
69 // FFS_ATTRIB_CHECKSUM attribute bit is clear\r
70 // note this is NOT an architecturally defined value, but is in this file for\r
71 // implementation convenience\r
72 //\r
73 #define FFS_FIXED_CHECKSUM  0x5A\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
97 typedef 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
106 \r
107 typedef UINT8 EFI_SECTION_TYPE;\r
108 \r
109 //\r
110 // Pseudo type. It is\r
111 // used as a wild card when retrieving sections. The section\r
112 // type EFI_SECTION_ALL matches all section types.\r
113 //\r
114 #define EFI_SECTION_ALL                   0x00\r
115 \r
116 //\r
117 // Encapsulation section Type values\r
118 //\r
119 #define EFI_SECTION_COMPRESSION           0x01\r
120 \r
121 #define EFI_SECTION_GUID_DEFINED          0x02\r
122 \r
123 //\r
124 // Leaf section Type values\r
125 //\r
126 #define EFI_SECTION_PE32                  0x10\r
127 #define EFI_SECTION_PIC                   0x11\r
128 #define EFI_SECTION_TE                    0x12\r
129 #define EFI_SECTION_DXE_DEPEX             0x13\r
130 #define EFI_SECTION_VERSION               0x14\r
131 #define EFI_SECTION_USER_INTERFACE        0x15\r
132 #define EFI_SECTION_COMPATIBILITY16       0x16\r
133 #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r
134 #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r
135 #define EFI_SECTION_RAW                   0x19\r
136 #define EFI_SECTION_PEI_DEPEX             0x1B\r
137 #define EFI_SECTION_SMM_DEPEX             0x1C\r
138 \r
139 typedef struct {\r
140   UINT8             Size[3];\r
141   EFI_SECTION_TYPE  Type;\r
142 } EFI_COMMON_SECTION_HEADER;\r
143 \r
144 //\r
145 // Leaf section type that contains an \r
146 // IA-32 16-bit executable image.\r
147 // \r
148 typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;\r
149 \r
150 //\r
151 // CompressionType of EFI_COMPRESSION_SECTION.\r
152 // \r
153 #define EFI_NOT_COMPRESSED        0x00\r
154 #define EFI_STANDARD_COMPRESSION  0x01\r
155 //\r
156 // An encapsulation section type in which the \r
157 // section data is compressed.\r
158 // \r
159 typedef struct {\r
160   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
161   UINT32                      UncompressedLength;\r
162   UINT8                       CompressionType;\r
163 } EFI_COMPRESSION_SECTION;\r
164 \r
165 //\r
166 // Leaf section which could be used to determine the dispatch order of DXEs.\r
167 // \r
168 typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION;\r
169 \r
170 //\r
171 // Leaf section witch contains a PI FV.\r
172 // \r
173 typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r
174 \r
175 //\r
176 // Leaf section which contains a single GUID.\r
177 // \r
178 typedef struct {\r
179   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
180   EFI_GUID                    SubTypeGuid;\r
181 } EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r
182 \r
183 //\r
184 // Attributes of EFI_GUID_DEFINED_SECTION\r
185 // \r
186 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED  0x01\r
187 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID    0x02\r
188 //\r
189 // Leaf section which is encapsulation defined by specific GUID\r
190 // \r
191 typedef struct {\r
192   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
193   EFI_GUID                    SectionDefinitionGuid;\r
194   UINT16                      DataOffset;\r
195   UINT16                      Attributes;\r
196 } EFI_GUID_DEFINED_SECTION;\r
197 \r
198 //\r
199 // Leaf section which contains PE32+ image.\r
200 // \r
201 typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;\r
202 \r
203 //\r
204 // Leaf section which contains PIC image.\r
205 // \r
206 typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION;\r
207 \r
208 //\r
209 // Leaf section which used to determine the dispatch order of PEIMs.\r
210 // \r
211 typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;\r
212 \r
213 //\r
214 // Leaf section which constains the position-independent-code image.\r
215 // \r
216 typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;\r
217 \r
218 //\r
219 // Leaf section which contains an array of zero or more bytes.\r
220 // \r
221 typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;\r
222 \r
223 //\r
224 // Leaf section which contains a unicode string that \r
225 // is human readable file name.\r
226 // \r
227 typedef struct {\r
228   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
229 \r
230   //\r
231   // Array of unicode string.\r
232   // \r
233   CHAR16                      FileNameString[1];\r
234 } EFI_USER_INTERFACE_SECTION;\r
235 \r
236 \r
237 //\r
238 // Leaf section which contains a numeric build number and\r
239 // an optional unicode string that represent the file revision. \r
240 // \r
241 typedef struct {\r
242   EFI_COMMON_SECTION_HEADER   CommonHeader;\r
243   UINT16                      BuildNumber;\r
244   CHAR16                      VersionString[1];\r
245 } EFI_VERSION_SECTION;\r
246 \r
247 \r
248 #define SECTION_SIZE(SectionHeaderPtr) \\r
249     ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r
250 \r
251 #pragma pack()\r
252 \r
253 typedef union {\r
254   EFI_COMMON_SECTION_HEADER         *CommonHeader;\r
255   EFI_COMPRESSION_SECTION           *CompressionSection;\r
256   EFI_GUID_DEFINED_SECTION          *GuidDefinedSection;\r
257   EFI_PE32_SECTION                  *Pe32Section;\r
258   EFI_PIC_SECTION                   *PicSection;\r
259   EFI_TE_SECTION                    *TeSection;\r
260   EFI_PEI_DEPEX_SECTION             *PeimHeaderSection;\r
261   EFI_DXE_DEPEX_SECTION             *DependencySection;\r
262   EFI_VERSION_SECTION               *VersionSection;\r
263   EFI_USER_INTERFACE_SECTION        *UISection;\r
264   EFI_COMPATIBILITY16_SECTION       *Code16Section;\r
265   EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r
266   EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r
267   EFI_RAW_SECTION                   *RawSection;\r
268 } EFI_FILE_SECTION_POINTER;\r
269 \r
270 #endif\r
271 \r