878ddf1f |
1 | /** @file\r |
2 | This file defines the data structures that are architecturally defined for file\r |
3 | images loaded via the FirmwareVolume protocol. The Firmware Volume specification\r |
4 | is the basis for these definitions.\r |
5 | \r |
6 | Copyright (c) 2006, Intel Corporation \r |
7 | All rights reserved. This program and the accompanying materials \r |
8 | are licensed and made available under the terms and conditions of the BSD License \r |
9 | which accompanies this distribution. The full text of the license may be found at \r |
10 | http://opensource.org/licenses/bsd-license.php \r |
11 | \r |
12 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
13 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
14 | \r |
15 | Module Name: FimrwareVolumeImageFormat.h\r |
16 | \r |
17 | @par Revision Reference:\r |
18 | These definitions are from Firmware Volume Spec 0.9.\r |
19 | \r |
20 | **/\r |
21 | \r |
22 | #ifndef __FIRMWARE_VOLUME_IMAGE_FORMAT_H__\r |
23 | #define __FIRMWARE_VOLUME_IMAGE_FORMAT_H__\r |
24 | \r |
25 | //\r |
26 | // pack all data structures since this is actually a binary format and we cannot\r |
27 | // allow internal padding in the data structures because of some compilerism..\r |
28 | //\r |
29 | #pragma pack(1)\r |
30 | //\r |
31 | // ////////////////////////////////////////////////////////////////////////////\r |
32 | //\r |
33 | // Architectural file types\r |
34 | //\r |
35 | typedef UINT8 EFI_FV_FILETYPE;\r |
36 | \r |
37 | #define EFI_FV_FILETYPE_ALL 0x00\r |
38 | #define EFI_FV_FILETYPE_RAW 0x01\r |
39 | #define EFI_FV_FILETYPE_FREEFORM 0x02\r |
40 | #define EFI_FV_FILETYPE_SECURITY_CORE 0x03\r |
41 | #define EFI_FV_FILETYPE_PEI_CORE 0x04\r |
42 | #define EFI_FV_FILETYPE_DXE_CORE 0x05\r |
43 | #define EFI_FV_FILETYPE_PEIM 0x06\r |
44 | #define EFI_FV_FILETYPE_DRIVER 0x07\r |
45 | #define EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER 0x08\r |
46 | #define EFI_FV_FILETYPE_APPLICATION 0x09\r |
47 | //\r |
48 | // File type 0x0A is reserved and should not be used\r |
49 | //\r |
50 | #define EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE 0x0B\r |
51 | \r |
52 | //\r |
53 | // ////////////////////////////////////////////////////////////////////////////\r |
54 | //\r |
55 | // Section types\r |
56 | //\r |
57 | typedef UINT8 EFI_SECTION_TYPE;\r |
58 | \r |
59 | //\r |
60 | // ************************************************************\r |
61 | // The section type EFI_SECTION_ALL is a psuedo type. It is\r |
62 | // used as a wildcard when retrieving sections. The section\r |
63 | // type EFI_SECTION_ALL matches all section types.\r |
64 | // ************************************************************\r |
65 | //\r |
66 | #define EFI_SECTION_ALL 0x00\r |
67 | \r |
68 | //\r |
69 | // ************************************************************\r |
70 | // Encapsulation section Type values\r |
71 | // ************************************************************\r |
72 | //\r |
73 | #define EFI_SECTION_COMPRESSION 0x01\r |
74 | #define EFI_SECTION_GUID_DEFINED 0x02\r |
75 | \r |
76 | //\r |
77 | // ************************************************************\r |
78 | // Leaf section Type values\r |
79 | // ************************************************************\r |
80 | //\r |
81 | #define EFI_SECTION_FIRST_LEAF_SECTION_TYPE 0x10\r |
82 | \r |
83 | #define EFI_SECTION_PE32 0x10\r |
84 | #define EFI_SECTION_PIC 0x11\r |
85 | #define EFI_SECTION_TE 0x12\r |
86 | #define EFI_SECTION_DXE_DEPEX 0x13\r |
87 | #define EFI_SECTION_VERSION 0x14\r |
88 | #define EFI_SECTION_USER_INTERFACE 0x15\r |
89 | #define EFI_SECTION_COMPATIBILITY16 0x16\r |
90 | #define EFI_SECTION_FIRMWARE_VOLUME_IMAGE 0x17\r |
91 | #define EFI_SECTION_FREEFORM_SUBTYPE_GUID 0x18\r |
92 | #define EFI_SECTION_RAW 0x19\r |
93 | #define EFI_SECTION_PEI_DEPEX 0x1B\r |
94 | \r |
95 | #define EFI_SECTION_LAST_LEAF_SECTION_TYPE 0x1B\r |
96 | #define EFI_SECTION_LAST_SECTION_TYPE 0x1B\r |
97 | \r |
98 | //\r |
99 | // ////////////////////////////////////////////////////////////////////////////\r |
100 | //\r |
101 | // Common section header\r |
102 | //\r |
103 | typedef struct {\r |
104 | UINT8 Size[3];\r |
105 | UINT8 Type;\r |
106 | } EFI_COMMON_SECTION_HEADER;\r |
107 | \r |
108 | #define SECTION_SIZE(SectionHeaderPtr) \\r |
109 | ((UINT32) (*((UINT32 *) ((EFI_COMMON_SECTION_HEADER *) SectionHeaderPtr)->Size) & 0x00ffffff))\r |
110 | \r |
111 | //\r |
112 | // ////////////////////////////////////////////////////////////////////////////\r |
113 | //\r |
114 | // Compression section\r |
115 | //\r |
116 | //\r |
117 | // CompressionType values\r |
118 | //\r |
119 | #define EFI_NOT_COMPRESSED 0x00\r |
120 | #define EFI_STANDARD_COMPRESSION 0x01\r |
121 | #define EFI_CUSTOMIZED_COMPRESSION 0x02\r |
122 | \r |
123 | typedef struct {\r |
124 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
125 | UINT32 UncompressedLength;\r |
126 | UINT8 CompressionType;\r |
127 | } EFI_COMPRESSION_SECTION;\r |
128 | \r |
129 | //\r |
130 | // ////////////////////////////////////////////////////////////////////////////\r |
131 | //\r |
132 | // GUID defined section\r |
133 | //\r |
134 | typedef struct {\r |
135 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
136 | EFI_GUID SectionDefinitionGuid;\r |
137 | UINT16 DataOffset;\r |
138 | UINT16 Attributes;\r |
139 | } EFI_GUID_DEFINED_SECTION;\r |
140 | \r |
141 | //\r |
142 | // Bit values for Attributes\r |
143 | //\r |
144 | #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01\r |
145 | #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02\r |
146 | \r |
147 | //\r |
148 | // Bit values for AuthenticationStatus\r |
149 | //\r |
150 | #define EFI_AGGREGATE_AUTH_STATUS_PLATFORM_OVERRIDE 0x000001\r |
151 | #define EFI_AGGREGATE_AUTH_STATUS_IMAGE_SIGNED 0x000002\r |
152 | #define EFI_AGGREGATE_AUTH_STATUS_NOT_TESTED 0x000004\r |
153 | #define EFI_AGGREGATE_AUTH_STATUS_TEST_FAILED 0x000008\r |
154 | #define EFI_AGGREGATE_AUTH_STATUS_ALL 0x00000f\r |
155 | \r |
156 | #define EFI_LOCAL_AUTH_STATUS_PLATFORM_OVERRIDE 0x010000\r |
157 | #define EFI_LOCAL_AUTH_STATUS_IMAGE_SIGNED 0x020000\r |
158 | #define EFI_LOCAL_AUTH_STATUS_NOT_TESTED 0x040000\r |
159 | #define EFI_LOCAL_AUTH_STATUS_TEST_FAILED 0x080000\r |
160 | #define EFI_LOCAL_AUTH_STATUS_ALL 0x0f0000\r |
161 | \r |
162 | //\r |
163 | // ////////////////////////////////////////////////////////////////////////////\r |
164 | //\r |
165 | // PE32+ section\r |
166 | //\r |
167 | typedef struct {\r |
168 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
169 | } EFI_PE32_SECTION;\r |
170 | \r |
171 | //\r |
172 | // ////////////////////////////////////////////////////////////////////////////\r |
173 | //\r |
174 | // PIC section\r |
175 | //\r |
176 | typedef struct {\r |
177 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
178 | } EFI_PIC_SECTION;\r |
179 | \r |
180 | //\r |
181 | // ////////////////////////////////////////////////////////////////////////////\r |
182 | //\r |
183 | // PEIM header section\r |
184 | //\r |
185 | typedef struct {\r |
186 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
187 | } EFI_PEIM_HEADER_SECTION;\r |
188 | \r |
189 | //\r |
190 | // ////////////////////////////////////////////////////////////////////////////\r |
191 | //\r |
192 | // DEPEX section\r |
193 | //\r |
194 | typedef struct {\r |
195 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
196 | } EFI_DEPEX_SECTION;\r |
197 | \r |
198 | //\r |
199 | // ////////////////////////////////////////////////////////////////////////////\r |
200 | //\r |
201 | // Version section\r |
202 | //\r |
203 | typedef struct {\r |
204 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
205 | UINT16 BuildNumber;\r |
206 | INT16 VersionString[1];\r |
207 | } EFI_VERSION_SECTION;\r |
208 | \r |
209 | //\r |
210 | // ////////////////////////////////////////////////////////////////////////////\r |
211 | //\r |
212 | // User interface section\r |
213 | //\r |
214 | typedef struct {\r |
215 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
216 | INT16 FileNameString[1];\r |
217 | } EFI_USER_INTERFACE_SECTION;\r |
218 | \r |
219 | //\r |
220 | // ////////////////////////////////////////////////////////////////////////////\r |
221 | //\r |
222 | // Code16 section\r |
223 | //\r |
224 | typedef struct {\r |
225 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
226 | } EFI_CODE16_SECTION;\r |
227 | \r |
228 | //\r |
229 | // ////////////////////////////////////////////////////////////////////////////\r |
230 | //\r |
231 | // Firmware Volume Image section\r |
232 | //\r |
233 | typedef struct {\r |
234 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
235 | } EFI_FIRMWARE_VOLUME_IMAGE_SECTION;\r |
236 | \r |
237 | //\r |
238 | // ////////////////////////////////////////////////////////////////////////////\r |
239 | //\r |
240 | // Freeform subtype GUID section\r |
241 | //\r |
242 | typedef struct {\r |
243 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
244 | EFI_GUID SubTypeGuid;\r |
245 | } EFI_FREEFORM_SUBTYPE_GUID_SECTION;\r |
246 | \r |
247 | //\r |
248 | // ////////////////////////////////////////////////////////////////////////////\r |
249 | //\r |
250 | // Raw section\r |
251 | //\r |
252 | typedef struct {\r |
253 | EFI_COMMON_SECTION_HEADER CommonHeader;\r |
254 | } EFI_RAW_SECTION;\r |
255 | \r |
256 | //\r |
257 | // undo the pragma from the beginning...\r |
258 | //\r |
259 | #pragma pack()\r |
260 | \r |
261 | typedef union {\r |
262 | EFI_COMMON_SECTION_HEADER *CommonHeader;\r |
263 | EFI_COMPRESSION_SECTION *CompressionSection;\r |
264 | EFI_GUID_DEFINED_SECTION *GuidDefinedSection;\r |
265 | EFI_PE32_SECTION *Pe32Section;\r |
266 | EFI_PIC_SECTION *PicSection;\r |
267 | EFI_PEIM_HEADER_SECTION *PeimHeaderSection;\r |
268 | EFI_DEPEX_SECTION *DependencySection;\r |
269 | EFI_VERSION_SECTION *VersionSection;\r |
270 | EFI_USER_INTERFACE_SECTION *UISection;\r |
271 | EFI_CODE16_SECTION *Code16Section;\r |
272 | EFI_FIRMWARE_VOLUME_IMAGE_SECTION *FVImageSection;\r |
273 | EFI_FREEFORM_SUBTYPE_GUID_SECTION *FreeformSubtypeSection;\r |
274 | EFI_RAW_SECTION *RawSection;\r |
275 | } EFI_FILE_SECTION_POINTER;\r |
276 | \r |
277 | #endif\r |