]>
Commit | Line | Data |
---|---|---|
959ccb23 | 1 | /** @file\r |
2 | This file defines the encoding for the VFR (Visual Form Representation) language.\r | |
3 | IFR is primarily consumed by the EFI presentation engine, and produced by EFI\r | |
4 | internal application and drivers as well as all add-in card option-ROM drivers\r | |
5 | \r | |
9095d37b | 6 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
6ef3ae6c | 7 | (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r |
9344f092 | 8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
959ccb23 | 9 | \r |
959ccb23 | 10 | @par Revision Reference:\r |
f6051525 | 11 | These definitions are from UEFI 2.1 and 2.2.\r |
959ccb23 | 12 | \r |
13 | **/\r | |
14 | \r | |
15 | #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__\r | |
16 | #define __UEFI_INTERNAL_FORMREPRESENTATION_H__\r | |
17 | \r | |
0cd118f7 LG |
18 | #include <Guid/HiiFormMapMethodGuid.h>\r |
19 | \r | |
fb5148a0 | 20 | ///\r |
21 | /// The following types are currently defined:\r | |
22 | ///\r | |
2f88bd3a MK |
23 | typedef VOID *EFI_HII_HANDLE;\r |
24 | typedef CHAR16 *EFI_STRING;\r | |
d1f95000 | 25 | typedef UINT16 EFI_IMAGE_ID;\r |
26 | typedef UINT16 EFI_QUESTION_ID;\r | |
27 | typedef UINT16 EFI_STRING_ID;\r | |
28 | typedef UINT16 EFI_FORM_ID;\r | |
29 | typedef UINT16 EFI_VARSTORE_ID;\r | |
f6051525 | 30 | typedef UINT16 EFI_ANIMATION_ID;\r |
e0c047a0 | 31 | \r |
2f88bd3a | 32 | typedef UINT16 EFI_DEFAULT_ID;\r |
959ccb23 | 33 | \r |
2f88bd3a | 34 | typedef UINT32 EFI_HII_FONT_STYLE;\r |
959ccb23 | 35 | \r |
36 | #pragma pack(1)\r | |
7d582d6b | 37 | \r |
e0c047a0 | 38 | //\r |
39 | // Definitions for Package Lists and Package Headers\r | |
40 | // Section 27.3.1\r | |
41 | //\r | |
7d582d6b | 42 | \r |
8b13229b | 43 | ///\r |
e0c047a0 | 44 | /// The header found at the start of each package list.\r |
8b13229b | 45 | ///\r |
959ccb23 | 46 | typedef struct {\r |
2f88bd3a MK |
47 | EFI_GUID PackageListGuid;\r |
48 | UINT32 PackageLength;\r | |
7d582d6b | 49 | } EFI_HII_PACKAGE_LIST_HEADER;\r |
959ccb23 | 50 | \r |
e0c047a0 | 51 | ///\r |
52 | /// The header found at the start of each package.\r | |
53 | ///\r | |
959ccb23 | 54 | typedef struct {\r |
2f88bd3a MK |
55 | UINT32 Length : 24;\r |
56 | UINT32 Type : 8;\r | |
7d582d6b | 57 | // UINT8 Data[...];\r |
58 | } EFI_HII_PACKAGE_HEADER;\r | |
959ccb23 | 59 | \r |
7d582d6b | 60 | //\r |
e0c047a0 | 61 | // Value of HII package type\r |
9095d37b | 62 | //\r |
2f88bd3a MK |
63 | #define EFI_HII_PACKAGE_TYPE_ALL 0x00\r |
64 | #define EFI_HII_PACKAGE_TYPE_GUID 0x01\r | |
65 | #define EFI_HII_PACKAGE_FORMS 0x02\r | |
66 | #define EFI_HII_PACKAGE_STRINGS 0x04\r | |
67 | #define EFI_HII_PACKAGE_FONTS 0x05\r | |
68 | #define EFI_HII_PACKAGE_IMAGES 0x06\r | |
69 | #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07\r | |
70 | #define EFI_HII_PACKAGE_DEVICE_PATH 0x08\r | |
71 | #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09\r | |
72 | #define EFI_HII_PACKAGE_ANIMATIONS 0x0A\r | |
73 | #define EFI_HII_PACKAGE_END 0xDF\r | |
74 | #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0\r | |
75 | #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF\r | |
959ccb23 | 76 | \r |
7d582d6b | 77 | //\r |
e0c047a0 | 78 | // Definitions for Simplified Font Package\r |
7d582d6b | 79 | //\r |
80 | \r | |
fbf926ad | 81 | ///\r |
af2dc6a7 | 82 | /// Contents of EFI_NARROW_GLYPH.Attributes.\r |
fbf926ad | 83 | ///@{\r |
2f88bd3a MK |
84 | #define EFI_GLYPH_NON_SPACING 0x01\r |
85 | #define EFI_GLYPH_WIDE 0x02\r | |
86 | #define EFI_GLYPH_HEIGHT 19\r | |
87 | #define EFI_GLYPH_WIDTH 8\r | |
fbf926ad | 88 | ///@}\r |
959ccb23 | 89 | \r |
fbf926ad | 90 | ///\r |
91 | /// The EFI_NARROW_GLYPH has a preferred dimension (w x h) of 8 x 19 pixels.\r | |
92 | ///\r | |
959ccb23 | 93 | typedef struct {\r |
fbf926ad | 94 | ///\r |
9095d37b | 95 | /// The Unicode representation of the glyph. The term weight is the\r |
fbf926ad | 96 | /// technical term for a character code.\r |
97 | ///\r | |
2f88bd3a | 98 | CHAR16 UnicodeWeight;\r |
fbf926ad | 99 | ///\r |
100 | /// The data element containing the glyph definitions.\r | |
101 | ///\r | |
2f88bd3a | 102 | UINT8 Attributes;\r |
fbf926ad | 103 | ///\r |
9095d37b | 104 | /// The column major glyph representation of the character. Bits\r |
fbf926ad | 105 | /// with values of one indicate that the corresponding pixel is to be\r |
106 | /// on when normally displayed; those with zero are off.\r | |
107 | ///\r | |
2f88bd3a | 108 | UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r |
7d582d6b | 109 | } EFI_NARROW_GLYPH;\r |
959ccb23 | 110 | \r |
fbf926ad | 111 | ///\r |
9095d37b | 112 | /// The EFI_WIDE_GLYPH has a preferred dimension (w x h) of 16 x 19 pixels, which is large enough\r |
fbf926ad | 113 | /// to accommodate logographic characters.\r |
114 | ///\r | |
959ccb23 | 115 | typedef struct {\r |
fbf926ad | 116 | ///\r |
9095d37b | 117 | /// The Unicode representation of the glyph. The term weight is the\r |
fbf926ad | 118 | /// technical term for a character code.\r |
119 | ///\r | |
2f88bd3a | 120 | CHAR16 UnicodeWeight;\r |
fbf926ad | 121 | ///\r |
122 | /// The data element containing the glyph definitions.\r | |
123 | ///\r | |
2f88bd3a | 124 | UINT8 Attributes;\r |
fbf926ad | 125 | ///\r |
9095d37b LG |
126 | /// The column major glyph representation of the character. Bits\r |
127 | /// with values of one indicate that the corresponding pixel is to be\r | |
fbf926ad | 128 | /// on when normally displayed; those with zero are off.\r |
129 | ///\r | |
2f88bd3a | 130 | UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r |
fbf926ad | 131 | ///\r |
9095d37b LG |
132 | /// The column major glyph representation of the character. Bits\r |
133 | /// with values of one indicate that the corresponding pixel is to be\r | |
fbf926ad | 134 | /// on when normally displayed; those with zero are off.\r |
135 | ///\r | |
2f88bd3a | 136 | UINT8 GlyphCol2[EFI_GLYPH_HEIGHT];\r |
fbf926ad | 137 | ///\r |
9095d37b LG |
138 | /// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the\r |
139 | /// sizeof (EFI_NARROW_GLYPH). The contents of Pad must\r | |
fbf926ad | 140 | /// be zero.\r |
141 | ///\r | |
2f88bd3a | 142 | UINT8 Pad[3];\r |
7d582d6b | 143 | } EFI_WIDE_GLYPH;\r |
144 | \r | |
e0c047a0 | 145 | ///\r |
146 | /// A simplified font package consists of a font header\r | |
147 | /// followed by a series of glyph structures.\r | |
148 | ///\r | |
7d582d6b | 149 | typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {\r |
2f88bd3a MK |
150 | EFI_HII_PACKAGE_HEADER Header;\r |
151 | UINT16 NumberOfNarrowGlyphs;\r | |
152 | UINT16 NumberOfWideGlyphs;\r | |
7d582d6b | 153 | // EFI_NARROW_GLYPH NarrowGlyphs[];\r |
154 | // EFI_WIDE_GLYPH WideGlyphs[];\r | |
155 | } EFI_HII_SIMPLE_FONT_PACKAGE_HDR;\r | |
959ccb23 | 156 | \r |
157 | //\r | |
e0c047a0 | 158 | // Definitions for Font Package\r |
159 | // Section 27.3.3\r | |
959ccb23 | 160 | //\r |
959ccb23 | 161 | \r |
e0c047a0 | 162 | //\r |
163 | // Value for font style\r | |
164 | //\r | |
2f88bd3a MK |
165 | #define EFI_HII_FONT_STYLE_NORMAL 0x00000000\r |
166 | #define EFI_HII_FONT_STYLE_BOLD 0x00000001\r | |
167 | #define EFI_HII_FONT_STYLE_ITALIC 0x00000002\r | |
168 | #define EFI_HII_FONT_STYLE_EMBOSS 0x00010000\r | |
169 | #define EFI_HII_FONT_STYLE_OUTLINE 0x00020000\r | |
170 | #define EFI_HII_FONT_STYLE_SHADOW 0x00040000\r | |
171 | #define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000\r | |
172 | #define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000\r | |
959ccb23 | 173 | \r |
7d582d6b | 174 | typedef struct _EFI_HII_GLYPH_INFO {\r |
2f88bd3a MK |
175 | UINT16 Width;\r |
176 | UINT16 Height;\r | |
177 | INT16 OffsetX;\r | |
178 | INT16 OffsetY;\r | |
179 | INT16 AdvanceX;\r | |
7d582d6b | 180 | } EFI_HII_GLYPH_INFO;\r |
181 | \r | |
e0c047a0 | 182 | ///\r |
af2dc6a7 | 183 | /// The fixed header consists of a standard record header,\r |
e0c047a0 | 184 | /// then the character values in this section, the flags\r |
185 | /// (including the encoding method) and the offsets of the glyph\r | |
186 | /// information, the glyph bitmaps and the character map.\r | |
187 | ///\r | |
7d582d6b | 188 | typedef struct _EFI_HII_FONT_PACKAGE_HDR {\r |
2f88bd3a MK |
189 | EFI_HII_PACKAGE_HEADER Header;\r |
190 | UINT32 HdrSize;\r | |
191 | UINT32 GlyphBlockOffset;\r | |
192 | EFI_HII_GLYPH_INFO Cell;\r | |
193 | EFI_HII_FONT_STYLE FontStyle;\r | |
194 | CHAR16 FontFamily[1];\r | |
7d582d6b | 195 | } EFI_HII_FONT_PACKAGE_HDR;\r |
196 | \r | |
e0c047a0 | 197 | //\r |
198 | // Value of different glyph info block types\r | |
199 | //\r | |
2f88bd3a MK |
200 | #define EFI_HII_GIBT_END 0x00\r |
201 | #define EFI_HII_GIBT_GLYPH 0x10\r | |
202 | #define EFI_HII_GIBT_GLYPHS 0x11\r | |
203 | #define EFI_HII_GIBT_GLYPH_DEFAULT 0x12\r | |
204 | #define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13\r | |
205 | #define EFI_HII_GIBT_GLYPH_VARIABILITY 0x14\r | |
206 | #define EFI_HII_GIBT_DUPLICATE 0x20\r | |
207 | #define EFI_HII_GIBT_SKIP2 0x21\r | |
208 | #define EFI_HII_GIBT_SKIP1 0x22\r | |
209 | #define EFI_HII_GIBT_DEFAULTS 0x23\r | |
210 | #define EFI_HII_GIBT_EXT1 0x30\r | |
211 | #define EFI_HII_GIBT_EXT2 0x31\r | |
212 | #define EFI_HII_GIBT_EXT4 0x32\r | |
7d582d6b | 213 | \r |
214 | typedef struct _EFI_HII_GLYPH_BLOCK {\r | |
2f88bd3a | 215 | UINT8 BlockType;\r |
7d582d6b | 216 | } EFI_HII_GLYPH_BLOCK;\r |
217 | \r | |
e0c047a0 | 218 | //\r |
219 | // Definition of different glyph info block types\r | |
220 | //\r | |
221 | \r | |
7d582d6b | 222 | typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK {\r |
223 | EFI_HII_GLYPH_BLOCK Header;\r | |
224 | EFI_HII_GLYPH_INFO Cell;\r | |
225 | } EFI_HII_GIBT_DEFAULTS_BLOCK;\r | |
226 | \r | |
227 | typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK {\r | |
228 | EFI_HII_GLYPH_BLOCK Header;\r | |
229 | CHAR16 CharValue;\r | |
230 | } EFI_HII_GIBT_DUPLICATE_BLOCK;\r | |
231 | \r | |
232 | typedef struct _EFI_GLYPH_GIBT_END_BLOCK {\r | |
233 | EFI_HII_GLYPH_BLOCK Header;\r | |
234 | } EFI_GLYPH_GIBT_END_BLOCK;\r | |
235 | \r | |
236 | typedef struct _EFI_HII_GIBT_EXT1_BLOCK {\r | |
237 | EFI_HII_GLYPH_BLOCK Header;\r | |
238 | UINT8 BlockType2;\r | |
239 | UINT8 Length;\r | |
240 | } EFI_HII_GIBT_EXT1_BLOCK;\r | |
241 | \r | |
242 | typedef struct _EFI_HII_GIBT_EXT2_BLOCK {\r | |
243 | EFI_HII_GLYPH_BLOCK Header;\r | |
244 | UINT8 BlockType2;\r | |
245 | UINT16 Length;\r | |
246 | } EFI_HII_GIBT_EXT2_BLOCK;\r | |
247 | \r | |
248 | typedef struct _EFI_HII_GIBT_EXT4_BLOCK {\r | |
249 | EFI_HII_GLYPH_BLOCK Header;\r | |
250 | UINT8 BlockType2;\r | |
251 | UINT32 Length;\r | |
252 | } EFI_HII_GIBT_EXT4_BLOCK;\r | |
253 | \r | |
254 | typedef struct _EFI_HII_GIBT_GLYPH_BLOCK {\r | |
255 | EFI_HII_GLYPH_BLOCK Header;\r | |
256 | EFI_HII_GLYPH_INFO Cell;\r | |
e0c047a0 | 257 | UINT8 BitmapData[1];\r |
7d582d6b | 258 | } EFI_HII_GIBT_GLYPH_BLOCK;\r |
259 | \r | |
260 | typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK {\r | |
261 | EFI_HII_GLYPH_BLOCK Header;\r | |
262 | EFI_HII_GLYPH_INFO Cell;\r | |
9095d37b | 263 | UINT16 Count;\r |
e0c047a0 | 264 | UINT8 BitmapData[1];\r |
7d582d6b | 265 | } EFI_HII_GIBT_GLYPHS_BLOCK;\r |
266 | \r | |
267 | typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK {\r | |
268 | EFI_HII_GLYPH_BLOCK Header;\r | |
e0c047a0 | 269 | UINT8 BitmapData[1];\r |
7d582d6b | 270 | } EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK;\r |
271 | \r | |
272 | typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK {\r | |
273 | EFI_HII_GLYPH_BLOCK Header;\r | |
274 | UINT16 Count;\r | |
e0c047a0 | 275 | UINT8 BitmapData[1];\r |
7d582d6b | 276 | } EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK;\r |
277 | \r | |
6ef3ae6c SEHM |
278 | typedef struct _EFI_HII_GIBT_VARIABILITY_BLOCK {\r |
279 | EFI_HII_GLYPH_BLOCK Header;\r | |
280 | EFI_HII_GLYPH_INFO Cell;\r | |
281 | UINT8 GlyphPackInBits;\r | |
2f88bd3a | 282 | UINT8 BitmapData[1];\r |
6ef3ae6c SEHM |
283 | } EFI_HII_GIBT_VARIABILITY_BLOCK;\r |
284 | \r | |
7d582d6b | 285 | typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {\r |
286 | EFI_HII_GLYPH_BLOCK Header;\r | |
287 | UINT8 SkipCount;\r | |
288 | } EFI_HII_GIBT_SKIP1_BLOCK;\r | |
289 | \r | |
290 | typedef struct _EFI_HII_GIBT_SKIP2_BLOCK {\r | |
291 | EFI_HII_GLYPH_BLOCK Header;\r | |
292 | UINT16 SkipCount;\r | |
293 | } EFI_HII_GIBT_SKIP2_BLOCK;\r | |
959ccb23 | 294 | \r |
295 | //\r | |
e0c047a0 | 296 | // Definitions for Device Path Package\r |
297 | // Section 27.3.4\r | |
959ccb23 | 298 | //\r |
e0c047a0 | 299 | \r |
300 | ///\r | |
301 | /// The device path package is used to carry a device path\r | |
302 | /// associated with the package list.\r | |
303 | ///\r | |
f620c889 | 304 | typedef struct _EFI_HII_DEVICE_PATH_PACKAGE_HDR {\r |
2f88bd3a | 305 | EFI_HII_PACKAGE_HEADER Header;\r |
7d582d6b | 306 | // EFI_DEVICE_PATH_PROTOCOL DevicePath[];\r |
f620c889 | 307 | } EFI_HII_DEVICE_PATH_PACKAGE_HDR;\r |
959ccb23 | 308 | \r |
7d582d6b | 309 | //\r |
e0c047a0 | 310 | // Definitions for GUID Package\r |
311 | // Section 27.3.5\r | |
7d582d6b | 312 | //\r |
e0c047a0 | 313 | \r |
314 | ///\r | |
315 | /// The GUID package is used to carry data where the format is defined by a GUID.\r | |
316 | ///\r | |
7d582d6b | 317 | typedef struct _EFI_HII_GUID_PACKAGE_HDR {\r |
2f88bd3a MK |
318 | EFI_HII_PACKAGE_HEADER Header;\r |
319 | EFI_GUID Guid;\r | |
7d582d6b | 320 | // Data per GUID definition may follow\r |
321 | } EFI_HII_GUID_PACKAGE_HDR;\r | |
959ccb23 | 322 | \r |
7d582d6b | 323 | //\r |
e0c047a0 | 324 | // Definitions for String Package\r |
325 | // Section 27.3.6\r | |
7d582d6b | 326 | //\r |
959ccb23 | 327 | \r |
2f88bd3a MK |
328 | #define UEFI_CONFIG_LANG "x-UEFI"\r |
329 | #define UEFI_CONFIG_LANG_2 "x-i-UEFI"\r | |
7d582d6b | 330 | \r |
e0c047a0 | 331 | ///\r |
332 | /// The fixed header consists of a standard record header and then the string identifiers\r | |
333 | /// contained in this section and the offsets of the string and language information.\r | |
334 | ///\r | |
7d582d6b | 335 | typedef struct _EFI_HII_STRING_PACKAGE_HDR {\r |
2f88bd3a MK |
336 | EFI_HII_PACKAGE_HEADER Header;\r |
337 | UINT32 HdrSize;\r | |
338 | UINT32 StringInfoOffset;\r | |
339 | CHAR16 LanguageWindow[16];\r | |
340 | EFI_STRING_ID LanguageName;\r | |
341 | CHAR8 Language[1];\r | |
7d582d6b | 342 | } EFI_HII_STRING_PACKAGE_HDR;\r |
959ccb23 | 343 | \r |
344 | typedef struct {\r | |
2f88bd3a | 345 | UINT8 BlockType;\r |
7d582d6b | 346 | } EFI_HII_STRING_BLOCK;\r |
347 | \r | |
e0c047a0 | 348 | //\r |
349 | // Value of different string information block types\r | |
350 | //\r | |
2f88bd3a MK |
351 | #define EFI_HII_SIBT_END 0x00\r |
352 | #define EFI_HII_SIBT_STRING_SCSU 0x10\r | |
353 | #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11\r | |
354 | #define EFI_HII_SIBT_STRINGS_SCSU 0x12\r | |
355 | #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13\r | |
356 | #define EFI_HII_SIBT_STRING_UCS2 0x14\r | |
357 | #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15\r | |
358 | #define EFI_HII_SIBT_STRINGS_UCS2 0x16\r | |
359 | #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17\r | |
360 | #define EFI_HII_SIBT_DUPLICATE 0x20\r | |
361 | #define EFI_HII_SIBT_SKIP2 0x21\r | |
362 | #define EFI_HII_SIBT_SKIP1 0x22\r | |
363 | #define EFI_HII_SIBT_EXT1 0x30\r | |
364 | #define EFI_HII_SIBT_EXT2 0x31\r | |
365 | #define EFI_HII_SIBT_EXT4 0x32\r | |
366 | #define EFI_HII_SIBT_FONT 0x40\r | |
7d582d6b | 367 | \r |
e0c047a0 | 368 | //\r |
369 | // Definition of different string information block types\r | |
370 | //\r | |
371 | \r | |
7d582d6b | 372 | typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK {\r |
373 | EFI_HII_STRING_BLOCK Header;\r | |
374 | EFI_STRING_ID StringId;\r | |
375 | } EFI_HII_SIBT_DUPLICATE_BLOCK;\r | |
376 | \r | |
377 | typedef struct _EFI_HII_SIBT_END_BLOCK {\r | |
378 | EFI_HII_STRING_BLOCK Header;\r | |
379 | } EFI_HII_SIBT_END_BLOCK;\r | |
380 | \r | |
381 | typedef struct _EFI_HII_SIBT_EXT1_BLOCK {\r | |
382 | EFI_HII_STRING_BLOCK Header;\r | |
383 | UINT8 BlockType2;\r | |
384 | UINT8 Length;\r | |
385 | } EFI_HII_SIBT_EXT1_BLOCK;\r | |
386 | \r | |
387 | typedef struct _EFI_HII_SIBT_EXT2_BLOCK {\r | |
388 | EFI_HII_STRING_BLOCK Header;\r | |
389 | UINT8 BlockType2;\r | |
390 | UINT16 Length;\r | |
391 | } EFI_HII_SIBT_EXT2_BLOCK;\r | |
392 | \r | |
393 | typedef struct _EFI_HII_SIBT_EXT4_BLOCK {\r | |
394 | EFI_HII_STRING_BLOCK Header;\r | |
395 | UINT8 BlockType2;\r | |
396 | UINT32 Length;\r | |
397 | } EFI_HII_SIBT_EXT4_BLOCK;\r | |
398 | \r | |
399 | typedef struct _EFI_HII_SIBT_FONT_BLOCK {\r | |
2f88bd3a MK |
400 | EFI_HII_SIBT_EXT2_BLOCK Header;\r |
401 | UINT8 FontId;\r | |
402 | UINT16 FontSize;\r | |
403 | EFI_HII_FONT_STYLE FontStyle;\r | |
404 | CHAR16 FontName[1];\r | |
7d582d6b | 405 | } EFI_HII_SIBT_FONT_BLOCK;\r |
406 | \r | |
407 | typedef struct _EFI_HII_SIBT_SKIP1_BLOCK {\r | |
408 | EFI_HII_STRING_BLOCK Header;\r | |
409 | UINT8 SkipCount;\r | |
410 | } EFI_HII_SIBT_SKIP1_BLOCK;\r | |
411 | \r | |
412 | typedef struct _EFI_HII_SIBT_SKIP2_BLOCK {\r | |
413 | EFI_HII_STRING_BLOCK Header;\r | |
414 | UINT16 SkipCount;\r | |
415 | } EFI_HII_SIBT_SKIP2_BLOCK;\r | |
416 | \r | |
417 | typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK {\r | |
418 | EFI_HII_STRING_BLOCK Header;\r | |
419 | UINT8 StringText[1];\r | |
420 | } EFI_HII_SIBT_STRING_SCSU_BLOCK;\r | |
421 | \r | |
422 | typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK {\r | |
423 | EFI_HII_STRING_BLOCK Header;\r | |
424 | UINT8 FontIdentifier;\r | |
425 | UINT8 StringText[1];\r | |
426 | } EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK;\r | |
427 | \r | |
428 | typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK {\r | |
429 | EFI_HII_STRING_BLOCK Header;\r | |
430 | UINT16 StringCount;\r | |
431 | UINT8 StringText[1];\r | |
432 | } EFI_HII_SIBT_STRINGS_SCSU_BLOCK;\r | |
433 | \r | |
434 | typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK {\r | |
435 | EFI_HII_STRING_BLOCK Header;\r | |
436 | UINT8 FontIdentifier;\r | |
437 | UINT16 StringCount;\r | |
438 | UINT8 StringText[1];\r | |
439 | } EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK;\r | |
440 | \r | |
441 | typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK {\r | |
442 | EFI_HII_STRING_BLOCK Header;\r | |
443 | CHAR16 StringText[1];\r | |
444 | } EFI_HII_SIBT_STRING_UCS2_BLOCK;\r | |
445 | \r | |
446 | typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK {\r | |
447 | EFI_HII_STRING_BLOCK Header;\r | |
448 | UINT8 FontIdentifier;\r | |
449 | CHAR16 StringText[1];\r | |
450 | } EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK;\r | |
451 | \r | |
452 | typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK {\r | |
453 | EFI_HII_STRING_BLOCK Header;\r | |
454 | UINT16 StringCount;\r | |
455 | CHAR16 StringText[1];\r | |
456 | } EFI_HII_SIBT_STRINGS_UCS2_BLOCK;\r | |
457 | \r | |
458 | typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK {\r | |
459 | EFI_HII_STRING_BLOCK Header;\r | |
460 | UINT8 FontIdentifier;\r | |
461 | UINT16 StringCount;\r | |
462 | CHAR16 StringText[1];\r | |
463 | } EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK;\r | |
959ccb23 | 464 | \r |
465 | //\r | |
e0c047a0 | 466 | // Definitions for Image Package\r |
467 | // Section 27.3.7\r | |
7d582d6b | 468 | //\r |
469 | \r | |
470 | typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r | |
2f88bd3a MK |
471 | EFI_HII_PACKAGE_HEADER Header;\r |
472 | UINT32 ImageInfoOffset;\r | |
473 | UINT32 PaletteInfoOffset;\r | |
7d582d6b | 474 | } EFI_HII_IMAGE_PACKAGE_HDR;\r |
475 | \r | |
476 | typedef struct _EFI_HII_IMAGE_BLOCK {\r | |
2f88bd3a | 477 | UINT8 BlockType;\r |
7d582d6b | 478 | } EFI_HII_IMAGE_BLOCK;\r |
479 | \r | |
e0c047a0 | 480 | //\r |
481 | // Value of different image information block types\r | |
482 | //\r | |
2f88bd3a MK |
483 | #define EFI_HII_IIBT_END 0x00\r |
484 | #define EFI_HII_IIBT_IMAGE_1BIT 0x10\r | |
485 | #define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11\r | |
486 | #define EFI_HII_IIBT_IMAGE_4BIT 0x12\r | |
487 | #define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13\r | |
488 | #define EFI_HII_IIBT_IMAGE_8BIT 0x14\r | |
489 | #define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15\r | |
490 | #define EFI_HII_IIBT_IMAGE_24BIT 0x16\r | |
491 | #define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17\r | |
492 | #define EFI_HII_IIBT_IMAGE_JPEG 0x18\r | |
493 | #define EFI_HII_IIBT_IMAGE_PNG 0x19\r | |
494 | #define EFI_HII_IIBT_DUPLICATE 0x20\r | |
495 | #define EFI_HII_IIBT_SKIP2 0x21\r | |
496 | #define EFI_HII_IIBT_SKIP1 0x22\r | |
497 | #define EFI_HII_IIBT_EXT1 0x30\r | |
498 | #define EFI_HII_IIBT_EXT2 0x31\r | |
499 | #define EFI_HII_IIBT_EXT4 0x32\r | |
7d582d6b | 500 | \r |
e0c047a0 | 501 | //\r |
502 | // Definition of different image information block types\r | |
503 | //\r | |
504 | \r | |
7d582d6b | 505 | typedef struct _EFI_HII_IIBT_END_BLOCK {\r |
2f88bd3a | 506 | EFI_HII_IMAGE_BLOCK Header;\r |
7d582d6b | 507 | } EFI_HII_IIBT_END_BLOCK;\r |
508 | \r | |
509 | typedef struct _EFI_HII_IIBT_EXT1_BLOCK {\r | |
2f88bd3a MK |
510 | EFI_HII_IMAGE_BLOCK Header;\r |
511 | UINT8 BlockType2;\r | |
512 | UINT8 Length;\r | |
7d582d6b | 513 | } EFI_HII_IIBT_EXT1_BLOCK;\r |
514 | \r | |
515 | typedef struct _EFI_HII_IIBT_EXT2_BLOCK {\r | |
2f88bd3a MK |
516 | EFI_HII_IMAGE_BLOCK Header;\r |
517 | UINT8 BlockType2;\r | |
518 | UINT16 Length;\r | |
7d582d6b | 519 | } EFI_HII_IIBT_EXT2_BLOCK;\r |
520 | \r | |
521 | typedef struct _EFI_HII_IIBT_EXT4_BLOCK {\r | |
2f88bd3a MK |
522 | EFI_HII_IMAGE_BLOCK Header;\r |
523 | UINT8 BlockType2;\r | |
524 | UINT32 Length;\r | |
7d582d6b | 525 | } EFI_HII_IIBT_EXT4_BLOCK;\r |
526 | \r | |
527 | typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE {\r | |
2f88bd3a MK |
528 | UINT16 Width;\r |
529 | UINT16 Height;\r | |
530 | UINT8 Data[1];\r | |
7d582d6b | 531 | } EFI_HII_IIBT_IMAGE_1BIT_BASE;\r |
532 | \r | |
533 | typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK {\r | |
2f88bd3a MK |
534 | EFI_HII_IMAGE_BLOCK Header;\r |
535 | UINT8 PaletteIndex;\r | |
536 | EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r | |
7d582d6b | 537 | } EFI_HII_IIBT_IMAGE_1BIT_BLOCK;\r |
538 | \r | |
539 | typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK {\r | |
2f88bd3a MK |
540 | EFI_HII_IMAGE_BLOCK Header;\r |
541 | UINT8 PaletteIndex;\r | |
542 | EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r | |
7d582d6b | 543 | } EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK;\r |
544 | \r | |
545 | typedef struct _EFI_HII_RGB_PIXEL {\r | |
2f88bd3a MK |
546 | UINT8 b;\r |
547 | UINT8 g;\r | |
548 | UINT8 r;\r | |
7d582d6b | 549 | } EFI_HII_RGB_PIXEL;\r |
550 | \r | |
551 | typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE {\r | |
2f88bd3a MK |
552 | UINT16 Width;\r |
553 | UINT16 Height;\r | |
554 | EFI_HII_RGB_PIXEL Bitmap[1];\r | |
7d582d6b | 555 | } EFI_HII_IIBT_IMAGE_24BIT_BASE;\r |
556 | \r | |
557 | typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK {\r | |
2f88bd3a MK |
558 | EFI_HII_IMAGE_BLOCK Header;\r |
559 | EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r | |
7d582d6b | 560 | } EFI_HII_IIBT_IMAGE_24BIT_BLOCK;\r |
561 | \r | |
562 | typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK {\r | |
2f88bd3a MK |
563 | EFI_HII_IMAGE_BLOCK Header;\r |
564 | EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r | |
7d582d6b | 565 | } EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK;\r |
566 | \r | |
567 | typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE {\r | |
2f88bd3a MK |
568 | UINT16 Width;\r |
569 | UINT16 Height;\r | |
570 | UINT8 Data[1];\r | |
7d582d6b | 571 | } EFI_HII_IIBT_IMAGE_4BIT_BASE;\r |
572 | \r | |
573 | typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK {\r | |
2f88bd3a MK |
574 | EFI_HII_IMAGE_BLOCK Header;\r |
575 | UINT8 PaletteIndex;\r | |
576 | EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r | |
7d582d6b | 577 | } EFI_HII_IIBT_IMAGE_4BIT_BLOCK;\r |
578 | \r | |
579 | typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK {\r | |
2f88bd3a MK |
580 | EFI_HII_IMAGE_BLOCK Header;\r |
581 | UINT8 PaletteIndex;\r | |
582 | EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r | |
7d582d6b | 583 | } EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK;\r |
584 | \r | |
585 | typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE {\r | |
2f88bd3a MK |
586 | UINT16 Width;\r |
587 | UINT16 Height;\r | |
588 | UINT8 Data[1];\r | |
7d582d6b | 589 | } EFI_HII_IIBT_IMAGE_8BIT_BASE;\r |
590 | \r | |
591 | typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK {\r | |
2f88bd3a MK |
592 | EFI_HII_IMAGE_BLOCK Header;\r |
593 | UINT8 PaletteIndex;\r | |
594 | EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r | |
7d582d6b | 595 | } EFI_HII_IIBT_IMAGE_8BIT_BLOCK;\r |
596 | \r | |
597 | typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK {\r | |
2f88bd3a MK |
598 | EFI_HII_IMAGE_BLOCK Header;\r |
599 | UINT8 PaletteIndex;\r | |
600 | EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r | |
7d582d6b | 601 | } EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK;\r |
602 | \r | |
603 | typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK {\r | |
2f88bd3a MK |
604 | EFI_HII_IMAGE_BLOCK Header;\r |
605 | EFI_IMAGE_ID ImageId;\r | |
7d582d6b | 606 | } EFI_HII_IIBT_DUPLICATE_BLOCK;\r |
607 | \r | |
608 | typedef struct _EFI_HII_IIBT_JPEG_BLOCK {\r | |
2f88bd3a MK |
609 | EFI_HII_IMAGE_BLOCK Header;\r |
610 | UINT32 Size;\r | |
611 | UINT8 Data[1];\r | |
7d582d6b | 612 | } EFI_HII_IIBT_JPEG_BLOCK;\r |
613 | \r | |
6ef3ae6c | 614 | typedef struct _EFI_HII_IIBT_PNG_BLOCK {\r |
2f88bd3a MK |
615 | EFI_HII_IMAGE_BLOCK Header;\r |
616 | UINT32 Size;\r | |
617 | UINT8 Data[1];\r | |
6ef3ae6c SEHM |
618 | } EFI_HII_IIBT_PNG_BLOCK;\r |
619 | \r | |
7d582d6b | 620 | typedef struct _EFI_HII_IIBT_SKIP1_BLOCK {\r |
2f88bd3a MK |
621 | EFI_HII_IMAGE_BLOCK Header;\r |
622 | UINT8 SkipCount;\r | |
7d582d6b | 623 | } EFI_HII_IIBT_SKIP1_BLOCK;\r |
624 | \r | |
625 | typedef struct _EFI_HII_IIBT_SKIP2_BLOCK {\r | |
2f88bd3a MK |
626 | EFI_HII_IMAGE_BLOCK Header;\r |
627 | UINT16 SkipCount;\r | |
7d582d6b | 628 | } EFI_HII_IIBT_SKIP2_BLOCK;\r |
629 | \r | |
e0c047a0 | 630 | //\r |
631 | // Definitions for Palette Information\r | |
632 | //\r | |
633 | \r | |
7d582d6b | 634 | typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER {\r |
2f88bd3a | 635 | UINT16 PaletteCount;\r |
7d582d6b | 636 | } EFI_HII_IMAGE_PALETTE_INFO_HEADER;\r |
637 | \r | |
638 | typedef struct _EFI_HII_IMAGE_PALETTE_INFO {\r | |
2f88bd3a MK |
639 | UINT16 PaletteSize;\r |
640 | EFI_HII_RGB_PIXEL PaletteValue[1];\r | |
7d582d6b | 641 | } EFI_HII_IMAGE_PALETTE_INFO;\r |
642 | \r | |
959ccb23 | 643 | //\r |
e0c047a0 | 644 | // Definitions for Forms Package\r |
645 | // Section 27.3.8\r | |
7d582d6b | 646 | //\r |
647 | \r | |
e0c047a0 | 648 | ///\r |
f620c889 | 649 | /// The Form package is used to carry form-based encoding data.\r |
e0c047a0 | 650 | ///\r |
f620c889 | 651 | typedef struct _EFI_HII_FORM_PACKAGE_HDR {\r |
2f88bd3a | 652 | EFI_HII_PACKAGE_HEADER Header;\r |
7d582d6b | 653 | // EFI_IFR_OP_HEADER OpCodeHeader;\r |
654 | // More op-codes follow\r | |
f620c889 | 655 | } EFI_HII_FORM_PACKAGE_HDR;\r |
7d582d6b | 656 | \r |
959ccb23 | 657 | typedef struct {\r |
2f88bd3a MK |
658 | UINT8 Hour;\r |
659 | UINT8 Minute;\r | |
660 | UINT8 Second;\r | |
7d582d6b | 661 | } EFI_HII_TIME;\r |
959ccb23 | 662 | \r |
663 | typedef struct {\r | |
2f88bd3a MK |
664 | UINT16 Year;\r |
665 | UINT8 Month;\r | |
666 | UINT8 Day;\r | |
7d582d6b | 667 | } EFI_HII_DATE;\r |
668 | \r | |
2ed77d0d | 669 | typedef struct {\r |
2f88bd3a MK |
670 | EFI_QUESTION_ID QuestionId;\r |
671 | EFI_FORM_ID FormId;\r | |
672 | EFI_GUID FormSetGuid;\r | |
673 | EFI_STRING_ID DevicePath;\r | |
2ed77d0d ED |
674 | } EFI_HII_REF;\r |
675 | \r | |
7d582d6b | 676 | typedef union {\r |
2f88bd3a MK |
677 | UINT8 u8;\r |
678 | UINT16 u16;\r | |
679 | UINT32 u32;\r | |
680 | UINT64 u64;\r | |
681 | BOOLEAN b;\r | |
682 | EFI_HII_TIME time;\r | |
683 | EFI_HII_DATE date;\r | |
684 | EFI_STRING_ID string; ///< EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION\r | |
685 | EFI_HII_REF ref; ///< EFI_IFR_TYPE_REF\r | |
4e7d855f | 686 | // UINT8 buffer[]; ///< EFI_IFR_TYPE_BUFFER\r |
7d582d6b | 687 | } EFI_IFR_TYPE_VALUE;\r |
688 | \r | |
d7132512 LG |
689 | //\r |
690 | // IFR Opcodes\r | |
691 | //\r | |
2f88bd3a MK |
692 | #define EFI_IFR_FORM_OP 0x01\r |
693 | #define EFI_IFR_SUBTITLE_OP 0x02\r | |
694 | #define EFI_IFR_TEXT_OP 0x03\r | |
695 | #define EFI_IFR_IMAGE_OP 0x04\r | |
696 | #define EFI_IFR_ONE_OF_OP 0x05\r | |
697 | #define EFI_IFR_CHECKBOX_OP 0x06\r | |
698 | #define EFI_IFR_NUMERIC_OP 0x07\r | |
699 | #define EFI_IFR_PASSWORD_OP 0x08\r | |
700 | #define EFI_IFR_ONE_OF_OPTION_OP 0x09\r | |
701 | #define EFI_IFR_SUPPRESS_IF_OP 0x0A\r | |
702 | #define EFI_IFR_LOCKED_OP 0x0B\r | |
703 | #define EFI_IFR_ACTION_OP 0x0C\r | |
704 | #define EFI_IFR_RESET_BUTTON_OP 0x0D\r | |
705 | #define EFI_IFR_FORM_SET_OP 0x0E\r | |
706 | #define EFI_IFR_REF_OP 0x0F\r | |
707 | #define EFI_IFR_NO_SUBMIT_IF_OP 0x10\r | |
708 | #define EFI_IFR_INCONSISTENT_IF_OP 0x11\r | |
709 | #define EFI_IFR_EQ_ID_VAL_OP 0x12\r | |
710 | #define EFI_IFR_EQ_ID_ID_OP 0x13\r | |
711 | #define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14\r | |
712 | #define EFI_IFR_AND_OP 0x15\r | |
713 | #define EFI_IFR_OR_OP 0x16\r | |
714 | #define EFI_IFR_NOT_OP 0x17\r | |
715 | #define EFI_IFR_RULE_OP 0x18\r | |
716 | #define EFI_IFR_GRAY_OUT_IF_OP 0x19\r | |
717 | #define EFI_IFR_DATE_OP 0x1A\r | |
718 | #define EFI_IFR_TIME_OP 0x1B\r | |
719 | #define EFI_IFR_STRING_OP 0x1C\r | |
720 | #define EFI_IFR_REFRESH_OP 0x1D\r | |
721 | #define EFI_IFR_DISABLE_IF_OP 0x1E\r | |
722 | #define EFI_IFR_ANIMATION_OP 0x1F\r | |
723 | #define EFI_IFR_TO_LOWER_OP 0x20\r | |
724 | #define EFI_IFR_TO_UPPER_OP 0x21\r | |
725 | #define EFI_IFR_MAP_OP 0x22\r | |
726 | #define EFI_IFR_ORDERED_LIST_OP 0x23\r | |
727 | #define EFI_IFR_VARSTORE_OP 0x24\r | |
728 | #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25\r | |
729 | #define EFI_IFR_VARSTORE_EFI_OP 0x26\r | |
730 | #define EFI_IFR_VARSTORE_DEVICE_OP 0x27\r | |
731 | #define EFI_IFR_VERSION_OP 0x28\r | |
732 | #define EFI_IFR_END_OP 0x29\r | |
733 | #define EFI_IFR_MATCH_OP 0x2A\r | |
734 | #define EFI_IFR_GET_OP 0x2B\r | |
735 | #define EFI_IFR_SET_OP 0x2C\r | |
736 | #define EFI_IFR_READ_OP 0x2D\r | |
737 | #define EFI_IFR_WRITE_OP 0x2E\r | |
738 | #define EFI_IFR_EQUAL_OP 0x2F\r | |
739 | #define EFI_IFR_NOT_EQUAL_OP 0x30\r | |
740 | #define EFI_IFR_GREATER_THAN_OP 0x31\r | |
741 | #define EFI_IFR_GREATER_EQUAL_OP 0x32\r | |
742 | #define EFI_IFR_LESS_THAN_OP 0x33\r | |
743 | #define EFI_IFR_LESS_EQUAL_OP 0x34\r | |
744 | #define EFI_IFR_BITWISE_AND_OP 0x35\r | |
745 | #define EFI_IFR_BITWISE_OR_OP 0x36\r | |
746 | #define EFI_IFR_BITWISE_NOT_OP 0x37\r | |
747 | #define EFI_IFR_SHIFT_LEFT_OP 0x38\r | |
748 | #define EFI_IFR_SHIFT_RIGHT_OP 0x39\r | |
749 | #define EFI_IFR_ADD_OP 0x3A\r | |
750 | #define EFI_IFR_SUBTRACT_OP 0x3B\r | |
751 | #define EFI_IFR_MULTIPLY_OP 0x3C\r | |
752 | #define EFI_IFR_DIVIDE_OP 0x3D\r | |
753 | #define EFI_IFR_MODULO_OP 0x3E\r | |
754 | #define EFI_IFR_RULE_REF_OP 0x3F\r | |
755 | #define EFI_IFR_QUESTION_REF1_OP 0x40\r | |
756 | #define EFI_IFR_QUESTION_REF2_OP 0x41\r | |
757 | #define EFI_IFR_UINT8_OP 0x42\r | |
758 | #define EFI_IFR_UINT16_OP 0x43\r | |
759 | #define EFI_IFR_UINT32_OP 0x44\r | |
760 | #define EFI_IFR_UINT64_OP 0x45\r | |
761 | #define EFI_IFR_TRUE_OP 0x46\r | |
762 | #define EFI_IFR_FALSE_OP 0x47\r | |
763 | #define EFI_IFR_TO_UINT_OP 0x48\r | |
764 | #define EFI_IFR_TO_STRING_OP 0x49\r | |
765 | #define EFI_IFR_TO_BOOLEAN_OP 0x4A\r | |
766 | #define EFI_IFR_MID_OP 0x4B\r | |
767 | #define EFI_IFR_FIND_OP 0x4C\r | |
768 | #define EFI_IFR_TOKEN_OP 0x4D\r | |
769 | #define EFI_IFR_STRING_REF1_OP 0x4E\r | |
770 | #define EFI_IFR_STRING_REF2_OP 0x4F\r | |
771 | #define EFI_IFR_CONDITIONAL_OP 0x50\r | |
772 | #define EFI_IFR_QUESTION_REF3_OP 0x51\r | |
773 | #define EFI_IFR_ZERO_OP 0x52\r | |
774 | #define EFI_IFR_ONE_OP 0x53\r | |
775 | #define EFI_IFR_ONES_OP 0x54\r | |
776 | #define EFI_IFR_UNDEFINED_OP 0x55\r | |
777 | #define EFI_IFR_LENGTH_OP 0x56\r | |
778 | #define EFI_IFR_DUP_OP 0x57\r | |
779 | #define EFI_IFR_THIS_OP 0x58\r | |
780 | #define EFI_IFR_SPAN_OP 0x59\r | |
781 | #define EFI_IFR_VALUE_OP 0x5A\r | |
782 | #define EFI_IFR_DEFAULT_OP 0x5B\r | |
783 | #define EFI_IFR_DEFAULTSTORE_OP 0x5C\r | |
784 | #define EFI_IFR_FORM_MAP_OP 0x5D\r | |
785 | #define EFI_IFR_CATENATE_OP 0x5E\r | |
786 | #define EFI_IFR_GUID_OP 0x5F\r | |
787 | #define EFI_IFR_SECURITY_OP 0x60\r | |
788 | #define EFI_IFR_MODAL_TAG_OP 0x61\r | |
789 | #define EFI_IFR_REFRESH_ID_OP 0x62\r | |
790 | #define EFI_IFR_WARNING_IF_OP 0x63\r | |
791 | #define EFI_IFR_MATCH2_OP 0x64\r | |
7d582d6b | 792 | \r |
e0c047a0 | 793 | //\r |
794 | // Definitions of IFR Standard Headers\r | |
795 | // Section 27.3.8.2\r | |
796 | //\r | |
7d582d6b | 797 | \r |
798 | typedef struct _EFI_IFR_OP_HEADER {\r | |
2f88bd3a MK |
799 | UINT8 OpCode;\r |
800 | UINT8 Length : 7;\r | |
801 | UINT8 Scope : 1;\r | |
7d582d6b | 802 | } EFI_IFR_OP_HEADER;\r |
803 | \r | |
804 | typedef struct _EFI_IFR_STATEMENT_HEADER {\r | |
2f88bd3a MK |
805 | EFI_STRING_ID Prompt;\r |
806 | EFI_STRING_ID Help;\r | |
7d582d6b | 807 | } EFI_IFR_STATEMENT_HEADER;\r |
808 | \r | |
809 | typedef struct _EFI_IFR_QUESTION_HEADER {\r | |
2f88bd3a MK |
810 | EFI_IFR_STATEMENT_HEADER Header;\r |
811 | EFI_QUESTION_ID QuestionId;\r | |
812 | EFI_VARSTORE_ID VarStoreId;\r | |
7d582d6b | 813 | union {\r |
2f88bd3a MK |
814 | EFI_STRING_ID VarName;\r |
815 | UINT16 VarOffset;\r | |
7d582d6b | 816 | } VarStoreInfo;\r |
2f88bd3a | 817 | UINT8 Flags;\r |
7d582d6b | 818 | } EFI_IFR_QUESTION_HEADER;\r |
819 | \r | |
e0c047a0 | 820 | //\r |
821 | // Flag values of EFI_IFR_QUESTION_HEADER\r | |
822 | //\r | |
2f88bd3a MK |
823 | #define EFI_IFR_FLAG_READ_ONLY 0x01\r |
824 | #define EFI_IFR_FLAG_CALLBACK 0x04\r | |
825 | #define EFI_IFR_FLAG_RESET_REQUIRED 0x10\r | |
826 | #define EFI_IFR_FLAG_REST_STYLE 0x20\r | |
827 | #define EFI_IFR_FLAG_RECONNECT_REQUIRED 0x40\r | |
828 | #define EFI_IFR_FLAG_OPTIONS_ONLY 0x80\r | |
7d582d6b | 829 | \r |
e0c047a0 | 830 | //\r |
831 | // Definition for Opcode Reference\r | |
832 | // Section 27.3.8.3\r | |
833 | //\r | |
7d582d6b | 834 | typedef struct _EFI_IFR_DEFAULTSTORE {\r |
2f88bd3a MK |
835 | EFI_IFR_OP_HEADER Header;\r |
836 | EFI_STRING_ID DefaultName;\r | |
837 | UINT16 DefaultId;\r | |
7d582d6b | 838 | } EFI_IFR_DEFAULTSTORE;\r |
839 | \r | |
e0c047a0 | 840 | //\r |
9095d37b | 841 | // Default Identifier of default store\r |
e0c047a0 | 842 | //\r |
2f88bd3a MK |
843 | #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000\r |
844 | #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001\r | |
845 | #define EFI_HII_DEFAULT_CLASS_SAFE 0x0002\r | |
846 | #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000\r | |
847 | #define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff\r | |
848 | #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000\r | |
849 | #define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff\r | |
850 | #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000\r | |
851 | #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff\r | |
7d582d6b | 852 | \r |
853 | typedef struct _EFI_IFR_VARSTORE {\r | |
2f88bd3a MK |
854 | EFI_IFR_OP_HEADER Header;\r |
855 | EFI_GUID Guid;\r | |
856 | EFI_VARSTORE_ID VarStoreId;\r | |
857 | UINT16 Size;\r | |
858 | UINT8 Name[1];\r | |
7d582d6b | 859 | } EFI_IFR_VARSTORE;\r |
860 | \r | |
861 | typedef struct _EFI_IFR_VARSTORE_EFI {\r | |
2f88bd3a MK |
862 | EFI_IFR_OP_HEADER Header;\r |
863 | EFI_VARSTORE_ID VarStoreId;\r | |
864 | EFI_GUID Guid;\r | |
865 | UINT32 Attributes;\r | |
866 | UINT16 Size;\r | |
867 | UINT8 Name[1];\r | |
7d582d6b | 868 | } EFI_IFR_VARSTORE_EFI;\r |
869 | \r | |
870 | typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {\r | |
2f88bd3a MK |
871 | EFI_IFR_OP_HEADER Header;\r |
872 | EFI_VARSTORE_ID VarStoreId;\r | |
873 | EFI_GUID Guid;\r | |
7d582d6b | 874 | } EFI_IFR_VARSTORE_NAME_VALUE;\r |
875 | \r | |
876 | typedef struct _EFI_IFR_FORM_SET {\r | |
2f88bd3a MK |
877 | EFI_IFR_OP_HEADER Header;\r |
878 | EFI_GUID Guid;\r | |
879 | EFI_STRING_ID FormSetTitle;\r | |
880 | EFI_STRING_ID Help;\r | |
881 | UINT8 Flags;\r | |
c2ace45e | 882 | // EFI_GUID ClassGuid[];\r |
7d582d6b | 883 | } EFI_IFR_FORM_SET;\r |
884 | \r | |
885 | typedef struct _EFI_IFR_END {\r | |
2f88bd3a | 886 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 887 | } EFI_IFR_END;\r |
888 | \r | |
889 | typedef struct _EFI_IFR_FORM {\r | |
2f88bd3a MK |
890 | EFI_IFR_OP_HEADER Header;\r |
891 | UINT16 FormId;\r | |
892 | EFI_STRING_ID FormTitle;\r | |
7d582d6b | 893 | } EFI_IFR_FORM;\r |
894 | \r | |
895 | typedef struct _EFI_IFR_IMAGE {\r | |
2f88bd3a MK |
896 | EFI_IFR_OP_HEADER Header;\r |
897 | EFI_IMAGE_ID Id;\r | |
7d582d6b | 898 | } EFI_IFR_IMAGE;\r |
899 | \r | |
cadf8790 | 900 | typedef struct _EFI_IFR_MODAL_TAG {\r |
2f88bd3a | 901 | EFI_IFR_OP_HEADER Header;\r |
cadf8790 | 902 | } EFI_IFR_MODAL_TAG;\r |
26a65e5c | 903 | \r |
7d582d6b | 904 | typedef struct _EFI_IFR_LOCKED {\r |
2f88bd3a | 905 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 906 | } EFI_IFR_LOCKED;\r |
907 | \r | |
908 | typedef struct _EFI_IFR_RULE {\r | |
2f88bd3a MK |
909 | EFI_IFR_OP_HEADER Header;\r |
910 | UINT8 RuleId;\r | |
7d582d6b | 911 | } EFI_IFR_RULE;\r |
912 | \r | |
913 | typedef struct _EFI_IFR_DEFAULT {\r | |
2f88bd3a MK |
914 | EFI_IFR_OP_HEADER Header;\r |
915 | UINT16 DefaultId;\r | |
916 | UINT8 Type;\r | |
917 | EFI_IFR_TYPE_VALUE Value;\r | |
7d582d6b | 918 | } EFI_IFR_DEFAULT;\r |
919 | \r | |
4706ff4f | 920 | typedef struct _EFI_IFR_DEFAULT_2 {\r |
2f88bd3a MK |
921 | EFI_IFR_OP_HEADER Header;\r |
922 | UINT16 DefaultId;\r | |
923 | UINT8 Type;\r | |
4706ff4f ED |
924 | } EFI_IFR_DEFAULT_2;\r |
925 | \r | |
7d582d6b | 926 | typedef struct _EFI_IFR_VALUE {\r |
2f88bd3a | 927 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 928 | } EFI_IFR_VALUE;\r |
929 | \r | |
930 | typedef struct _EFI_IFR_SUBTITLE {\r | |
2f88bd3a MK |
931 | EFI_IFR_OP_HEADER Header;\r |
932 | EFI_IFR_STATEMENT_HEADER Statement;\r | |
933 | UINT8 Flags;\r | |
7d582d6b | 934 | } EFI_IFR_SUBTITLE;\r |
935 | \r | |
2f88bd3a | 936 | #define EFI_IFR_FLAGS_HORIZONTAL 0x01\r |
7d582d6b | 937 | \r |
938 | typedef struct _EFI_IFR_CHECKBOX {\r | |
2f88bd3a MK |
939 | EFI_IFR_OP_HEADER Header;\r |
940 | EFI_IFR_QUESTION_HEADER Question;\r | |
941 | UINT8 Flags;\r | |
7d582d6b | 942 | } EFI_IFR_CHECKBOX;\r |
943 | \r | |
2f88bd3a MK |
944 | #define EFI_IFR_CHECKBOX_DEFAULT 0x01\r |
945 | #define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02\r | |
7d582d6b | 946 | \r |
947 | typedef struct _EFI_IFR_TEXT {\r | |
2f88bd3a MK |
948 | EFI_IFR_OP_HEADER Header;\r |
949 | EFI_IFR_STATEMENT_HEADER Statement;\r | |
950 | EFI_STRING_ID TextTwo;\r | |
7d582d6b | 951 | } EFI_IFR_TEXT;\r |
952 | \r | |
953 | typedef struct _EFI_IFR_REF {\r | |
2f88bd3a MK |
954 | EFI_IFR_OP_HEADER Header;\r |
955 | EFI_IFR_QUESTION_HEADER Question;\r | |
956 | EFI_FORM_ID FormId;\r | |
7d582d6b | 957 | } EFI_IFR_REF;\r |
958 | \r | |
959 | typedef struct _EFI_IFR_REF2 {\r | |
2f88bd3a MK |
960 | EFI_IFR_OP_HEADER Header;\r |
961 | EFI_IFR_QUESTION_HEADER Question;\r | |
962 | EFI_FORM_ID FormId;\r | |
963 | EFI_QUESTION_ID QuestionId;\r | |
7d582d6b | 964 | } EFI_IFR_REF2;\r |
965 | \r | |
966 | typedef struct _EFI_IFR_REF3 {\r | |
2f88bd3a MK |
967 | EFI_IFR_OP_HEADER Header;\r |
968 | EFI_IFR_QUESTION_HEADER Question;\r | |
969 | EFI_FORM_ID FormId;\r | |
970 | EFI_QUESTION_ID QuestionId;\r | |
971 | EFI_GUID FormSetId;\r | |
7d582d6b | 972 | } EFI_IFR_REF3;\r |
973 | \r | |
974 | typedef struct _EFI_IFR_REF4 {\r | |
2f88bd3a MK |
975 | EFI_IFR_OP_HEADER Header;\r |
976 | EFI_IFR_QUESTION_HEADER Question;\r | |
977 | EFI_FORM_ID FormId;\r | |
978 | EFI_QUESTION_ID QuestionId;\r | |
979 | EFI_GUID FormSetId;\r | |
980 | EFI_STRING_ID DevicePath;\r | |
7d582d6b | 981 | } EFI_IFR_REF4;\r |
982 | \r | |
2ed77d0d | 983 | typedef struct _EFI_IFR_REF5 {\r |
2f88bd3a MK |
984 | EFI_IFR_OP_HEADER Header;\r |
985 | EFI_IFR_QUESTION_HEADER Question;\r | |
2ed77d0d ED |
986 | } EFI_IFR_REF5;\r |
987 | \r | |
7d582d6b | 988 | typedef struct _EFI_IFR_RESET_BUTTON {\r |
2f88bd3a MK |
989 | EFI_IFR_OP_HEADER Header;\r |
990 | EFI_IFR_STATEMENT_HEADER Statement;\r | |
991 | EFI_DEFAULT_ID DefaultId;\r | |
7d582d6b | 992 | } EFI_IFR_RESET_BUTTON;\r |
993 | \r | |
994 | typedef struct _EFI_IFR_ACTION {\r | |
2f88bd3a MK |
995 | EFI_IFR_OP_HEADER Header;\r |
996 | EFI_IFR_QUESTION_HEADER Question;\r | |
997 | EFI_STRING_ID QuestionConfig;\r | |
7d582d6b | 998 | } EFI_IFR_ACTION;\r |
999 | \r | |
1000 | typedef struct _EFI_IFR_ACTION_1 {\r | |
2f88bd3a MK |
1001 | EFI_IFR_OP_HEADER Header;\r |
1002 | EFI_IFR_QUESTION_HEADER Question;\r | |
7d582d6b | 1003 | } EFI_IFR_ACTION_1;\r |
1004 | \r | |
1005 | typedef struct _EFI_IFR_DATE {\r | |
2f88bd3a MK |
1006 | EFI_IFR_OP_HEADER Header;\r |
1007 | EFI_IFR_QUESTION_HEADER Question;\r | |
1008 | UINT8 Flags;\r | |
959ccb23 | 1009 | } EFI_IFR_DATE;\r |
1010 | \r | |
e0c047a0 | 1011 | //\r |
1012 | // Flags that describe the behavior of the question.\r | |
1013 | //\r | |
2f88bd3a MK |
1014 | #define EFI_QF_DATE_YEAR_SUPPRESS 0x01\r |
1015 | #define EFI_QF_DATE_MONTH_SUPPRESS 0x02\r | |
1016 | #define EFI_QF_DATE_DAY_SUPPRESS 0x04\r | |
959ccb23 | 1017 | \r |
2f88bd3a MK |
1018 | #define EFI_QF_DATE_STORAGE 0x30\r |
1019 | #define QF_DATE_STORAGE_NORMAL 0x00\r | |
1020 | #define QF_DATE_STORAGE_TIME 0x10\r | |
1021 | #define QF_DATE_STORAGE_WAKEUP 0x20\r | |
7d582d6b | 1022 | \r |
1023 | typedef union {\r | |
1024 | struct {\r | |
2f88bd3a MK |
1025 | UINT8 MinValue;\r |
1026 | UINT8 MaxValue;\r | |
1027 | UINT8 Step;\r | |
7d582d6b | 1028 | } u8;\r |
1029 | struct {\r | |
2f88bd3a MK |
1030 | UINT16 MinValue;\r |
1031 | UINT16 MaxValue;\r | |
1032 | UINT16 Step;\r | |
7d582d6b | 1033 | } u16;\r |
1034 | struct {\r | |
2f88bd3a MK |
1035 | UINT32 MinValue;\r |
1036 | UINT32 MaxValue;\r | |
1037 | UINT32 Step;\r | |
7d582d6b | 1038 | } u32;\r |
1039 | struct {\r | |
2f88bd3a MK |
1040 | UINT64 MinValue;\r |
1041 | UINT64 MaxValue;\r | |
1042 | UINT64 Step;\r | |
7d582d6b | 1043 | } u64;\r |
1044 | } MINMAXSTEP_DATA;\r | |
1045 | \r | |
1046 | typedef struct _EFI_IFR_NUMERIC {\r | |
2f88bd3a MK |
1047 | EFI_IFR_OP_HEADER Header;\r |
1048 | EFI_IFR_QUESTION_HEADER Question;\r | |
1049 | UINT8 Flags;\r | |
1050 | MINMAXSTEP_DATA data;\r | |
7d582d6b | 1051 | } EFI_IFR_NUMERIC;\r |
1052 | \r | |
e0c047a0 | 1053 | //\r |
1054 | // Flags related to the numeric question\r | |
1055 | //\r | |
2f88bd3a MK |
1056 | #define EFI_IFR_NUMERIC_SIZE 0x03\r |
1057 | #define EFI_IFR_NUMERIC_SIZE_1 0x00\r | |
1058 | #define EFI_IFR_NUMERIC_SIZE_2 0x01\r | |
1059 | #define EFI_IFR_NUMERIC_SIZE_4 0x02\r | |
1060 | #define EFI_IFR_NUMERIC_SIZE_8 0x03\r | |
7d582d6b | 1061 | \r |
2f88bd3a MK |
1062 | #define EFI_IFR_DISPLAY 0x30\r |
1063 | #define EFI_IFR_DISPLAY_INT_DEC 0x00\r | |
1064 | #define EFI_IFR_DISPLAY_UINT_DEC 0x10\r | |
1065 | #define EFI_IFR_DISPLAY_UINT_HEX 0x20\r | |
7d582d6b | 1066 | \r |
1067 | typedef struct _EFI_IFR_ONE_OF {\r | |
2f88bd3a MK |
1068 | EFI_IFR_OP_HEADER Header;\r |
1069 | EFI_IFR_QUESTION_HEADER Question;\r | |
1070 | UINT8 Flags;\r | |
1071 | MINMAXSTEP_DATA data;\r | |
7d582d6b | 1072 | } EFI_IFR_ONE_OF;\r |
1073 | \r | |
1074 | typedef struct _EFI_IFR_STRING {\r | |
2f88bd3a MK |
1075 | EFI_IFR_OP_HEADER Header;\r |
1076 | EFI_IFR_QUESTION_HEADER Question;\r | |
1077 | UINT8 MinSize;\r | |
1078 | UINT8 MaxSize;\r | |
1079 | UINT8 Flags;\r | |
959ccb23 | 1080 | } EFI_IFR_STRING;\r |
1081 | \r | |
2f88bd3a | 1082 | #define EFI_IFR_STRING_MULTI_LINE 0x01\r |
959ccb23 | 1083 | \r |
7d582d6b | 1084 | typedef struct _EFI_IFR_PASSWORD {\r |
2f88bd3a MK |
1085 | EFI_IFR_OP_HEADER Header;\r |
1086 | EFI_IFR_QUESTION_HEADER Question;\r | |
1087 | UINT16 MinSize;\r | |
1088 | UINT16 MaxSize;\r | |
7d582d6b | 1089 | } EFI_IFR_PASSWORD;\r |
959ccb23 | 1090 | \r |
7d582d6b | 1091 | typedef struct _EFI_IFR_ORDERED_LIST {\r |
2f88bd3a MK |
1092 | EFI_IFR_OP_HEADER Header;\r |
1093 | EFI_IFR_QUESTION_HEADER Question;\r | |
1094 | UINT8 MaxContainers;\r | |
1095 | UINT8 Flags;\r | |
7d582d6b | 1096 | } EFI_IFR_ORDERED_LIST;\r |
959ccb23 | 1097 | \r |
2f88bd3a MK |
1098 | #define EFI_IFR_UNIQUE_SET 0x01\r |
1099 | #define EFI_IFR_NO_EMPTY_SET 0x02\r | |
959ccb23 | 1100 | \r |
7d582d6b | 1101 | typedef struct _EFI_IFR_TIME {\r |
2f88bd3a MK |
1102 | EFI_IFR_OP_HEADER Header;\r |
1103 | EFI_IFR_QUESTION_HEADER Question;\r | |
1104 | UINT8 Flags;\r | |
7d582d6b | 1105 | } EFI_IFR_TIME;\r |
959ccb23 | 1106 | \r |
e0c047a0 | 1107 | //\r |
1108 | // A bit-mask that determines which unique settings are active for this opcode.\r | |
1109 | //\r | |
2f88bd3a MK |
1110 | #define QF_TIME_HOUR_SUPPRESS 0x01\r |
1111 | #define QF_TIME_MINUTE_SUPPRESS 0x02\r | |
1112 | #define QF_TIME_SECOND_SUPPRESS 0x04\r | |
7d582d6b | 1113 | \r |
2f88bd3a MK |
1114 | #define QF_TIME_STORAGE 0x30\r |
1115 | #define QF_TIME_STORAGE_NORMAL 0x00\r | |
1116 | #define QF_TIME_STORAGE_TIME 0x10\r | |
1117 | #define QF_TIME_STORAGE_WAKEUP 0x20\r | |
7d582d6b | 1118 | \r |
1119 | typedef struct _EFI_IFR_DISABLE_IF {\r | |
2f88bd3a | 1120 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1121 | } EFI_IFR_DISABLE_IF;\r |
1122 | \r | |
1123 | typedef struct _EFI_IFR_SUPPRESS_IF {\r | |
2f88bd3a | 1124 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1125 | } EFI_IFR_SUPPRESS_IF;\r |
1126 | \r | |
1127 | typedef struct _EFI_IFR_GRAY_OUT_IF {\r | |
2f88bd3a | 1128 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1129 | } EFI_IFR_GRAY_OUT_IF;\r |
1130 | \r | |
1131 | typedef struct _EFI_IFR_INCONSISTENT_IF {\r | |
2f88bd3a MK |
1132 | EFI_IFR_OP_HEADER Header;\r |
1133 | EFI_STRING_ID Error;\r | |
7d582d6b | 1134 | } EFI_IFR_INCONSISTENT_IF;\r |
1135 | \r | |
1136 | typedef struct _EFI_IFR_NO_SUBMIT_IF {\r | |
2f88bd3a MK |
1137 | EFI_IFR_OP_HEADER Header;\r |
1138 | EFI_STRING_ID Error;\r | |
7d582d6b | 1139 | } EFI_IFR_NO_SUBMIT_IF;\r |
1140 | \r | |
774b5736 | 1141 | typedef struct _EFI_IFR_WARNING_IF {\r |
2f88bd3a MK |
1142 | EFI_IFR_OP_HEADER Header;\r |
1143 | EFI_STRING_ID Warning;\r | |
1144 | UINT8 TimeOut;\r | |
774b5736 ED |
1145 | } EFI_IFR_WARNING_IF;\r |
1146 | \r | |
7d582d6b | 1147 | typedef struct _EFI_IFR_REFRESH {\r |
2f88bd3a MK |
1148 | EFI_IFR_OP_HEADER Header;\r |
1149 | UINT8 RefreshInterval;\r | |
7d582d6b | 1150 | } EFI_IFR_REFRESH;\r |
1151 | \r | |
1152 | typedef struct _EFI_IFR_VARSTORE_DEVICE {\r | |
2f88bd3a MK |
1153 | EFI_IFR_OP_HEADER Header;\r |
1154 | EFI_STRING_ID DevicePath;\r | |
7d582d6b | 1155 | } EFI_IFR_VARSTORE_DEVICE;\r |
1156 | \r | |
1157 | typedef struct _EFI_IFR_ONE_OF_OPTION {\r | |
2f88bd3a MK |
1158 | EFI_IFR_OP_HEADER Header;\r |
1159 | EFI_STRING_ID Option;\r | |
1160 | UINT8 Flags;\r | |
1161 | UINT8 Type;\r | |
1162 | EFI_IFR_TYPE_VALUE Value;\r | |
7d582d6b | 1163 | } EFI_IFR_ONE_OF_OPTION;\r |
1164 | \r | |
e0c047a0 | 1165 | //\r |
1166 | // Types of the option's value.\r | |
1167 | //\r | |
2f88bd3a MK |
1168 | #define EFI_IFR_TYPE_NUM_SIZE_8 0x00\r |
1169 | #define EFI_IFR_TYPE_NUM_SIZE_16 0x01\r | |
1170 | #define EFI_IFR_TYPE_NUM_SIZE_32 0x02\r | |
1171 | #define EFI_IFR_TYPE_NUM_SIZE_64 0x03\r | |
1172 | #define EFI_IFR_TYPE_BOOLEAN 0x04\r | |
1173 | #define EFI_IFR_TYPE_TIME 0x05\r | |
1174 | #define EFI_IFR_TYPE_DATE 0x06\r | |
1175 | #define EFI_IFR_TYPE_STRING 0x07\r | |
1176 | #define EFI_IFR_TYPE_OTHER 0x08\r | |
1177 | #define EFI_IFR_TYPE_UNDEFINED 0x09\r | |
1178 | #define EFI_IFR_TYPE_ACTION 0x0A\r | |
1179 | #define EFI_IFR_TYPE_BUFFER 0x0B\r | |
1180 | #define EFI_IFR_TYPE_REF 0x0C\r | |
1181 | \r | |
1182 | #define EFI_IFR_OPTION_DEFAULT 0x10\r | |
1183 | #define EFI_IFR_OPTION_DEFAULT_MFG 0x20\r | |
7d582d6b | 1184 | \r |
1185 | typedef struct _EFI_IFR_GUID {\r | |
2f88bd3a MK |
1186 | EFI_IFR_OP_HEADER Header;\r |
1187 | EFI_GUID Guid;\r | |
1188 | // Optional Data Follows\r | |
7d582d6b | 1189 | } EFI_IFR_GUID;\r |
1190 | \r | |
dfc66bb9 | 1191 | typedef struct _EFI_IFR_REFRESH_ID {\r |
2f88bd3a MK |
1192 | EFI_IFR_OP_HEADER Header;\r |
1193 | EFI_GUID RefreshEventGroupId;\r | |
dfc66bb9 ED |
1194 | } EFI_IFR_REFRESH_ID;\r |
1195 | \r | |
7d582d6b | 1196 | typedef struct _EFI_IFR_DUP {\r |
2f88bd3a | 1197 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1198 | } EFI_IFR_DUP;\r |
1199 | \r | |
1200 | typedef struct _EFI_IFR_EQ_ID_ID {\r | |
2f88bd3a MK |
1201 | EFI_IFR_OP_HEADER Header;\r |
1202 | EFI_QUESTION_ID QuestionId1;\r | |
1203 | EFI_QUESTION_ID QuestionId2;\r | |
7d582d6b | 1204 | } EFI_IFR_EQ_ID_ID;\r |
1205 | \r | |
1206 | typedef struct _EFI_IFR_EQ_ID_VAL {\r | |
2f88bd3a MK |
1207 | EFI_IFR_OP_HEADER Header;\r |
1208 | EFI_QUESTION_ID QuestionId;\r | |
1209 | UINT16 Value;\r | |
959ccb23 | 1210 | } EFI_IFR_EQ_ID_VAL;\r |
1211 | \r | |
66d550f9 | 1212 | typedef struct _EFI_IFR_EQ_ID_VAL_LIST {\r |
2f88bd3a MK |
1213 | EFI_IFR_OP_HEADER Header;\r |
1214 | EFI_QUESTION_ID QuestionId;\r | |
1215 | UINT16 ListLength;\r | |
1216 | UINT16 ValueList[1];\r | |
66d550f9 | 1217 | } EFI_IFR_EQ_ID_VAL_LIST;\r |
959ccb23 | 1218 | \r |
7d582d6b | 1219 | typedef struct _EFI_IFR_UINT8 {\r |
2f88bd3a MK |
1220 | EFI_IFR_OP_HEADER Header;\r |
1221 | UINT8 Value;\r | |
7d582d6b | 1222 | } EFI_IFR_UINT8;\r |
959ccb23 | 1223 | \r |
7d582d6b | 1224 | typedef struct _EFI_IFR_UINT16 {\r |
2f88bd3a MK |
1225 | EFI_IFR_OP_HEADER Header;\r |
1226 | UINT16 Value;\r | |
7d582d6b | 1227 | } EFI_IFR_UINT16;\r |
1228 | \r | |
7d582d6b | 1229 | typedef struct _EFI_IFR_UINT32 {\r |
2f88bd3a MK |
1230 | EFI_IFR_OP_HEADER Header;\r |
1231 | UINT32 Value;\r | |
7d582d6b | 1232 | } EFI_IFR_UINT32;\r |
1233 | \r | |
1234 | typedef struct _EFI_IFR_UINT64 {\r | |
2f88bd3a MK |
1235 | EFI_IFR_OP_HEADER Header;\r |
1236 | UINT64 Value;\r | |
7d582d6b | 1237 | } EFI_IFR_UINT64;\r |
1238 | \r | |
e0c047a0 | 1239 | typedef struct _EFI_IFR_QUESTION_REF1 {\r |
2f88bd3a MK |
1240 | EFI_IFR_OP_HEADER Header;\r |
1241 | EFI_QUESTION_ID QuestionId;\r | |
e0c047a0 | 1242 | } EFI_IFR_QUESTION_REF1;\r |
1243 | \r | |
1244 | typedef struct _EFI_IFR_QUESTION_REF2 {\r | |
2f88bd3a | 1245 | EFI_IFR_OP_HEADER Header;\r |
e0c047a0 | 1246 | } EFI_IFR_QUESTION_REF2;\r |
1247 | \r | |
7d582d6b | 1248 | typedef struct _EFI_IFR_QUESTION_REF3 {\r |
2f88bd3a | 1249 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1250 | } EFI_IFR_QUESTION_REF3;\r |
1251 | \r | |
1252 | typedef struct _EFI_IFR_QUESTION_REF3_2 {\r | |
2f88bd3a MK |
1253 | EFI_IFR_OP_HEADER Header;\r |
1254 | EFI_STRING_ID DevicePath;\r | |
7d582d6b | 1255 | } EFI_IFR_QUESTION_REF3_2;\r |
1256 | \r | |
1257 | typedef struct _EFI_IFR_QUESTION_REF3_3 {\r | |
2f88bd3a MK |
1258 | EFI_IFR_OP_HEADER Header;\r |
1259 | EFI_STRING_ID DevicePath;\r | |
1260 | EFI_GUID Guid;\r | |
7d582d6b | 1261 | } EFI_IFR_QUESTION_REF3_3;\r |
1262 | \r | |
1263 | typedef struct _EFI_IFR_RULE_REF {\r | |
2f88bd3a MK |
1264 | EFI_IFR_OP_HEADER Header;\r |
1265 | UINT8 RuleId;\r | |
7d582d6b | 1266 | } EFI_IFR_RULE_REF;\r |
1267 | \r | |
1268 | typedef struct _EFI_IFR_STRING_REF1 {\r | |
2f88bd3a MK |
1269 | EFI_IFR_OP_HEADER Header;\r |
1270 | EFI_STRING_ID StringId;\r | |
7d582d6b | 1271 | } EFI_IFR_STRING_REF1;\r |
1272 | \r | |
1273 | typedef struct _EFI_IFR_STRING_REF2 {\r | |
2f88bd3a | 1274 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1275 | } EFI_IFR_STRING_REF2;\r |
1276 | \r | |
1277 | typedef struct _EFI_IFR_THIS {\r | |
2f88bd3a | 1278 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1279 | } EFI_IFR_THIS;\r |
1280 | \r | |
1281 | typedef struct _EFI_IFR_TRUE {\r | |
2f88bd3a | 1282 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1283 | } EFI_IFR_TRUE;\r |
1284 | \r | |
1285 | typedef struct _EFI_IFR_FALSE {\r | |
2f88bd3a | 1286 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1287 | } EFI_IFR_FALSE;\r |
1288 | \r | |
1289 | typedef struct _EFI_IFR_ONE {\r | |
2f88bd3a | 1290 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1291 | } EFI_IFR_ONE;\r |
1292 | \r | |
1293 | typedef struct _EFI_IFR_ONES {\r | |
2f88bd3a | 1294 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1295 | } EFI_IFR_ONES;\r |
1296 | \r | |
1297 | typedef struct _EFI_IFR_ZERO {\r | |
2f88bd3a | 1298 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1299 | } EFI_IFR_ZERO;\r |
1300 | \r | |
1301 | typedef struct _EFI_IFR_UNDEFINED {\r | |
2f88bd3a | 1302 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1303 | } EFI_IFR_UNDEFINED;\r |
1304 | \r | |
1305 | typedef struct _EFI_IFR_VERSION {\r | |
2f88bd3a | 1306 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1307 | } EFI_IFR_VERSION;\r |
1308 | \r | |
1309 | typedef struct _EFI_IFR_LENGTH {\r | |
2f88bd3a | 1310 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1311 | } EFI_IFR_LENGTH;\r |
1312 | \r | |
1313 | typedef struct _EFI_IFR_NOT {\r | |
2f88bd3a | 1314 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1315 | } EFI_IFR_NOT;\r |
1316 | \r | |
1317 | typedef struct _EFI_IFR_BITWISE_NOT {\r | |
2f88bd3a | 1318 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1319 | } EFI_IFR_BITWISE_NOT;\r |
1320 | \r | |
1321 | typedef struct _EFI_IFR_TO_BOOLEAN {\r | |
2f88bd3a | 1322 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1323 | } EFI_IFR_TO_BOOLEAN;\r |
1324 | \r | |
fbf926ad | 1325 | ///\r |
1326 | /// For EFI_IFR_TO_STRING, when converting from\r | |
1327 | /// unsigned integers, these flags control the format:\r | |
af2dc6a7 | 1328 | /// 0 = unsigned decimal.\r |
1329 | /// 1 = signed decimal.\r | |
1330 | /// 2 = hexadecimal (lower-case alpha).\r | |
1331 | /// 3 = hexadecimal (upper-case alpha).\r | |
fbf926ad | 1332 | ///@{\r |
2f88bd3a MK |
1333 | #define EFI_IFR_STRING_UNSIGNED_DEC 0\r |
1334 | #define EFI_IFR_STRING_SIGNED_DEC 1\r | |
1335 | #define EFI_IFR_STRING_LOWERCASE_HEX 2\r | |
1336 | #define EFI_IFR_STRING_UPPERCASE_HEX 3\r | |
fbf926ad | 1337 | ///@}\r |
1338 | \r | |
1339 | ///\r | |
1340 | /// When converting from a buffer, these flags control the format:\r | |
af2dc6a7 | 1341 | /// 0 = ASCII.\r |
1342 | /// 8 = Unicode.\r | |
fbf926ad | 1343 | ///@{\r |
2f88bd3a MK |
1344 | #define EFI_IFR_STRING_ASCII 0\r |
1345 | #define EFI_IFR_STRING_UNICODE 8\r | |
fbf926ad | 1346 | ///@}\r |
7d582d6b | 1347 | \r |
1348 | typedef struct _EFI_IFR_TO_STRING {\r | |
2f88bd3a MK |
1349 | EFI_IFR_OP_HEADER Header;\r |
1350 | UINT8 Format;\r | |
7d582d6b | 1351 | } EFI_IFR_TO_STRING;\r |
1352 | \r | |
1353 | typedef struct _EFI_IFR_TO_UINT {\r | |
2f88bd3a | 1354 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1355 | } EFI_IFR_TO_UINT;\r |
1356 | \r | |
1357 | typedef struct _EFI_IFR_TO_UPPER {\r | |
2f88bd3a | 1358 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1359 | } EFI_IFR_TO_UPPER;\r |
1360 | \r | |
1361 | typedef struct _EFI_IFR_TO_LOWER {\r | |
2f88bd3a | 1362 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1363 | } EFI_IFR_TO_LOWER;\r |
1364 | \r | |
1365 | typedef struct _EFI_IFR_ADD {\r | |
2f88bd3a | 1366 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1367 | } EFI_IFR_ADD;\r |
1368 | \r | |
1369 | typedef struct _EFI_IFR_AND {\r | |
2f88bd3a | 1370 | EFI_IFR_OP_HEADER Header;\r |
959ccb23 | 1371 | } EFI_IFR_AND;\r |
1372 | \r | |
7d582d6b | 1373 | typedef struct _EFI_IFR_BITWISE_AND {\r |
2f88bd3a | 1374 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1375 | } EFI_IFR_BITWISE_AND;\r |
1376 | \r | |
1377 | typedef struct _EFI_IFR_BITWISE_OR {\r | |
2f88bd3a | 1378 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1379 | } EFI_IFR_BITWISE_OR;\r |
1380 | \r | |
1381 | typedef struct _EFI_IFR_CATENATE {\r | |
2f88bd3a | 1382 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1383 | } EFI_IFR_CATENATE;\r |
1384 | \r | |
1385 | typedef struct _EFI_IFR_DIVIDE {\r | |
2f88bd3a | 1386 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1387 | } EFI_IFR_DIVIDE;\r |
1388 | \r | |
1389 | typedef struct _EFI_IFR_EQUAL {\r | |
2f88bd3a | 1390 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1391 | } EFI_IFR_EQUAL;\r |
1392 | \r | |
1393 | typedef struct _EFI_IFR_GREATER_EQUAL {\r | |
2f88bd3a | 1394 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1395 | } EFI_IFR_GREATER_EQUAL;\r |
1396 | \r | |
1397 | typedef struct _EFI_IFR_GREATER_THAN {\r | |
2f88bd3a | 1398 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1399 | } EFI_IFR_GREATER_THAN;\r |
1400 | \r | |
1401 | typedef struct _EFI_IFR_LESS_EQUAL {\r | |
2f88bd3a | 1402 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1403 | } EFI_IFR_LESS_EQUAL;\r |
1404 | \r | |
1405 | typedef struct _EFI_IFR_LESS_THAN {\r | |
2f88bd3a | 1406 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1407 | } EFI_IFR_LESS_THAN;\r |
1408 | \r | |
1409 | typedef struct _EFI_IFR_MATCH {\r | |
2f88bd3a | 1410 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1411 | } EFI_IFR_MATCH;\r |
1412 | \r | |
7cc80bfd | 1413 | typedef struct _EFI_IFR_MATCH2 {\r |
2f88bd3a MK |
1414 | EFI_IFR_OP_HEADER Header;\r |
1415 | EFI_GUID SyntaxType;\r | |
7cc80bfd ED |
1416 | } EFI_IFR_MATCH2;\r |
1417 | \r | |
7d582d6b | 1418 | typedef struct _EFI_IFR_MULTIPLY {\r |
2f88bd3a | 1419 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1420 | } EFI_IFR_MULTIPLY;\r |
1421 | \r | |
1422 | typedef struct _EFI_IFR_MODULO {\r | |
2f88bd3a | 1423 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1424 | } EFI_IFR_MODULO;\r |
1425 | \r | |
1426 | typedef struct _EFI_IFR_NOT_EQUAL {\r | |
2f88bd3a | 1427 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1428 | } EFI_IFR_NOT_EQUAL;\r |
1429 | \r | |
1430 | typedef struct _EFI_IFR_OR {\r | |
2f88bd3a | 1431 | EFI_IFR_OP_HEADER Header;\r |
959ccb23 | 1432 | } EFI_IFR_OR;\r |
1433 | \r | |
7d582d6b | 1434 | typedef struct _EFI_IFR_SHIFT_LEFT {\r |
2f88bd3a | 1435 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1436 | } EFI_IFR_SHIFT_LEFT;\r |
959ccb23 | 1437 | \r |
7d582d6b | 1438 | typedef struct _EFI_IFR_SHIFT_RIGHT {\r |
2f88bd3a | 1439 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1440 | } EFI_IFR_SHIFT_RIGHT;\r |
959ccb23 | 1441 | \r |
7d582d6b | 1442 | typedef struct _EFI_IFR_SUBTRACT {\r |
2f88bd3a | 1443 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1444 | } EFI_IFR_SUBTRACT;\r |
959ccb23 | 1445 | \r |
7d582d6b | 1446 | typedef struct _EFI_IFR_CONDITIONAL {\r |
2f88bd3a | 1447 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1448 | } EFI_IFR_CONDITIONAL;\r |
959ccb23 | 1449 | \r |
e0c047a0 | 1450 | //\r |
1451 | // Flags governing the matching criteria of EFI_IFR_FIND\r | |
1452 | //\r | |
7d582d6b | 1453 | #define EFI_IFR_FF_CASE_SENSITIVE 0x00\r |
1454 | #define EFI_IFR_FF_CASE_INSENSITIVE 0x01\r | |
959ccb23 | 1455 | \r |
7d582d6b | 1456 | typedef struct _EFI_IFR_FIND {\r |
2f88bd3a MK |
1457 | EFI_IFR_OP_HEADER Header;\r |
1458 | UINT8 Format;\r | |
7d582d6b | 1459 | } EFI_IFR_FIND;\r |
1460 | \r | |
1461 | typedef struct _EFI_IFR_MID {\r | |
2f88bd3a | 1462 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1463 | } EFI_IFR_MID;\r |
1464 | \r | |
1465 | typedef struct _EFI_IFR_TOKEN {\r | |
2f88bd3a | 1466 | EFI_IFR_OP_HEADER Header;\r |
7d582d6b | 1467 | } EFI_IFR_TOKEN;\r |
1468 | \r | |
e0c047a0 | 1469 | //\r |
1470 | // Flags specifying whether to find the first matching string\r | |
1471 | // or the first non-matching string.\r | |
1472 | //\r | |
2f88bd3a MK |
1473 | #define EFI_IFR_FLAGS_FIRST_MATCHING 0x00\r |
1474 | #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01\r | |
7d582d6b | 1475 | \r |
1476 | typedef struct _EFI_IFR_SPAN {\r | |
2f88bd3a MK |
1477 | EFI_IFR_OP_HEADER Header;\r |
1478 | UINT8 Flags;\r | |
7d582d6b | 1479 | } EFI_IFR_SPAN;\r |
959ccb23 | 1480 | \r |
0cd118f7 LG |
1481 | typedef struct _EFI_IFR_SECURITY {\r |
1482 | ///\r | |
1483 | /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.\r | |
1484 | ///\r | |
2f88bd3a | 1485 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 LG |
1486 | ///\r |
1487 | /// Security permission level.\r | |
1488 | ///\r | |
2f88bd3a | 1489 | EFI_GUID Permissions;\r |
0cd118f7 LG |
1490 | } EFI_IFR_SECURITY;\r |
1491 | \r | |
1492 | typedef struct _EFI_IFR_FORM_MAP_METHOD {\r | |
1493 | ///\r | |
9095d37b | 1494 | /// The string identifier which provides the human-readable name of\r |
0cd118f7 LG |
1495 | /// the configuration method for this standards map form.\r |
1496 | ///\r | |
2f88bd3a | 1497 | EFI_STRING_ID MethodTitle;\r |
0cd118f7 | 1498 | ///\r |
9095d37b | 1499 | /// Identifier which uniquely specifies the configuration methods\r |
0cd118f7 LG |
1500 | /// associated with this standards map form.\r |
1501 | ///\r | |
2f88bd3a | 1502 | EFI_GUID MethodIdentifier;\r |
0cd118f7 LG |
1503 | } EFI_IFR_FORM_MAP_METHOD;\r |
1504 | \r | |
1505 | typedef struct _EFI_IFR_FORM_MAP {\r | |
1506 | ///\r | |
9095d37b LG |
1507 | /// The sequence that defines the type of opcode as well as the length\r |
1508 | /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.\r | |
0cd118f7 | 1509 | ///\r |
2f88bd3a | 1510 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 LG |
1511 | ///\r |
1512 | /// The unique identifier for this particular form.\r | |
1513 | ///\r | |
2f88bd3a | 1514 | EFI_FORM_ID FormId;\r |
0cd118f7 LG |
1515 | ///\r |
1516 | /// One or more configuration method's name and unique identifier.\r | |
1517 | ///\r | |
2573712e | 1518 | // EFI_IFR_FORM_MAP_METHOD Methods[];\r |
0cd118f7 LG |
1519 | } EFI_IFR_FORM_MAP;\r |
1520 | \r | |
1521 | typedef struct _EFI_IFR_SET {\r | |
1522 | ///\r | |
9095d37b LG |
1523 | /// The sequence that defines the type of opcode as well as the length\r |
1524 | /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.\r | |
0cd118f7 | 1525 | ///\r |
2f88bd3a | 1526 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 | 1527 | ///\r |
9095d37b LG |
1528 | /// Specifies the identifier of a previously declared variable store to\r |
1529 | /// use when storing the question's value.\r | |
0cd118f7 | 1530 | ///\r |
2f88bd3a | 1531 | EFI_VARSTORE_ID VarStoreId;\r |
0cd118f7 LG |
1532 | union {\r |
1533 | ///\r | |
1534 | /// A 16-bit Buffer Storage offset.\r | |
1535 | ///\r | |
1536 | EFI_STRING_ID VarName;\r | |
1537 | ///\r | |
1538 | /// A Name Value or EFI Variable name (VarName).\r | |
1539 | ///\r | |
1540 | UINT16 VarOffset;\r | |
1541 | } VarStoreInfo;\r | |
2573712e | 1542 | ///\r |
9095d37b | 1543 | /// Specifies the type used for storage.\r |
2573712e | 1544 | ///\r |
2f88bd3a | 1545 | UINT8 VarStoreType;\r |
0cd118f7 LG |
1546 | } EFI_IFR_SET;\r |
1547 | \r | |
1548 | typedef struct _EFI_IFR_GET {\r | |
1549 | ///\r | |
9095d37b LG |
1550 | /// The sequence that defines the type of opcode as well as the length\r |
1551 | /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.\r | |
0cd118f7 | 1552 | ///\r |
2f88bd3a | 1553 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 | 1554 | ///\r |
9095d37b LG |
1555 | /// Specifies the identifier of a previously declared variable store to\r |
1556 | /// use when retrieving the value.\r | |
0cd118f7 | 1557 | ///\r |
2f88bd3a | 1558 | EFI_VARSTORE_ID VarStoreId;\r |
0cd118f7 LG |
1559 | union {\r |
1560 | ///\r | |
1561 | /// A 16-bit Buffer Storage offset.\r | |
1562 | ///\r | |
1563 | EFI_STRING_ID VarName;\r | |
1564 | ///\r | |
1565 | /// A Name Value or EFI Variable name (VarName).\r | |
1566 | ///\r | |
1567 | UINT16 VarOffset;\r | |
1568 | } VarStoreInfo;\r | |
1569 | ///\r | |
9095d37b | 1570 | /// Specifies the type used for storage.\r |
0cd118f7 | 1571 | ///\r |
2f88bd3a | 1572 | UINT8 VarStoreType;\r |
0cd118f7 LG |
1573 | } EFI_IFR_GET;\r |
1574 | \r | |
1575 | typedef struct _EFI_IFR_READ {\r | |
2f88bd3a | 1576 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 LG |
1577 | } EFI_IFR_READ;\r |
1578 | \r | |
1579 | typedef struct _EFI_IFR_WRITE {\r | |
2f88bd3a | 1580 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 LG |
1581 | } EFI_IFR_WRITE;\r |
1582 | \r | |
1583 | typedef struct _EFI_IFR_MAP {\r | |
2f88bd3a | 1584 | EFI_IFR_OP_HEADER Header;\r |
0cd118f7 | 1585 | } EFI_IFR_MAP;\r |
959ccb23 | 1586 | //\r |
e0c047a0 | 1587 | // Definitions for Keyboard Package\r |
e0c047a0 | 1588 | // Releated definitions are in Section of EFI_HII_DATABASE_PROTOCOL\r |
959ccb23 | 1589 | //\r |
7d582d6b | 1590 | \r |
9319d2c2 LG |
1591 | ///\r |
1592 | /// Each enumeration values maps a physical key on a keyboard.\r | |
1593 | ///\r | |
9095d37b | 1594 | typedef enum {\r |
7d582d6b | 1595 | EfiKeyLCtrl,\r |
9095d37b | 1596 | EfiKeyA0,\r |
7d582d6b | 1597 | EfiKeyLAlt,\r |
1598 | EfiKeySpaceBar,\r | |
1599 | EfiKeyA2,\r | |
1600 | EfiKeyA3,\r | |
1601 | EfiKeyA4,\r | |
1602 | EfiKeyRCtrl,\r | |
1603 | EfiKeyLeftArrow,\r | |
1604 | EfiKeyDownArrow,\r | |
1605 | EfiKeyRightArrow,\r | |
1606 | EfiKeyZero,\r | |
1607 | EfiKeyPeriod,\r | |
1608 | EfiKeyEnter,\r | |
1609 | EfiKeyLShift,\r | |
1610 | EfiKeyB0,\r | |
1611 | EfiKeyB1,\r | |
1612 | EfiKeyB2,\r | |
1613 | EfiKeyB3,\r | |
1614 | EfiKeyB4,\r | |
1615 | EfiKeyB5,\r | |
1616 | EfiKeyB6,\r | |
1617 | EfiKeyB7,\r | |
1618 | EfiKeyB8,\r | |
1619 | EfiKeyB9,\r | |
1620 | EfiKeyB10,\r | |
54cf8780 | 1621 | EfiKeyRShift,\r |
7d582d6b | 1622 | EfiKeyUpArrow,\r |
1623 | EfiKeyOne,\r | |
1624 | EfiKeyTwo,\r | |
1625 | EfiKeyThree,\r | |
1626 | EfiKeyCapsLock,\r | |
1627 | EfiKeyC1,\r | |
1628 | EfiKeyC2,\r | |
1629 | EfiKeyC3,\r | |
1630 | EfiKeyC4,\r | |
1631 | EfiKeyC5,\r | |
1632 | EfiKeyC6,\r | |
1633 | EfiKeyC7,\r | |
1634 | EfiKeyC8,\r | |
1635 | EfiKeyC9,\r | |
1636 | EfiKeyC10,\r | |
1637 | EfiKeyC11,\r | |
1638 | EfiKeyC12,\r | |
1639 | EfiKeyFour,\r | |
1640 | EfiKeyFive,\r | |
1641 | EfiKeySix,\r | |
1642 | EfiKeyPlus,\r | |
1643 | EfiKeyTab,\r | |
1644 | EfiKeyD1,\r | |
1645 | EfiKeyD2,\r | |
1646 | EfiKeyD3,\r | |
1647 | EfiKeyD4,\r | |
1648 | EfiKeyD5,\r | |
1649 | EfiKeyD6,\r | |
1650 | EfiKeyD7,\r | |
1651 | EfiKeyD8,\r | |
1652 | EfiKeyD9,\r | |
1653 | EfiKeyD10,\r | |
1654 | EfiKeyD11,\r | |
1655 | EfiKeyD12,\r | |
1656 | EfiKeyD13,\r | |
1657 | EfiKeyDel,\r | |
1658 | EfiKeyEnd,\r | |
1659 | EfiKeyPgDn,\r | |
1660 | EfiKeySeven,\r | |
1661 | EfiKeyEight,\r | |
1662 | EfiKeyNine,\r | |
1663 | EfiKeyE0,\r | |
1664 | EfiKeyE1,\r | |
1665 | EfiKeyE2,\r | |
1666 | EfiKeyE3,\r | |
1667 | EfiKeyE4,\r | |
1668 | EfiKeyE5,\r | |
1669 | EfiKeyE6,\r | |
1670 | EfiKeyE7,\r | |
1671 | EfiKeyE8,\r | |
1672 | EfiKeyE9,\r | |
1673 | EfiKeyE10,\r | |
1674 | EfiKeyE11,\r | |
1675 | EfiKeyE12,\r | |
1676 | EfiKeyBackSpace,\r | |
1677 | EfiKeyIns,\r | |
1678 | EfiKeyHome,\r | |
1679 | EfiKeyPgUp,\r | |
1680 | EfiKeyNLck,\r | |
1681 | EfiKeySlash,\r | |
1682 | EfiKeyAsterisk,\r | |
1683 | EfiKeyMinus,\r | |
1684 | EfiKeyEsc,\r | |
1685 | EfiKeyF1,\r | |
1686 | EfiKeyF2,\r | |
1687 | EfiKeyF3,\r | |
1688 | EfiKeyF4,\r | |
1689 | EfiKeyF5,\r | |
1690 | EfiKeyF6,\r | |
1691 | EfiKeyF7,\r | |
1692 | EfiKeyF8,\r | |
1693 | EfiKeyF9,\r | |
1694 | EfiKeyF10,\r | |
1695 | EfiKeyF11,\r | |
1696 | EfiKeyF12,\r | |
1697 | EfiKeyPrint,\r | |
1698 | EfiKeySLck,\r | |
1699 | EfiKeyPause\r | |
1700 | } EFI_KEY;\r | |
1701 | \r | |
959ccb23 | 1702 | typedef struct {\r |
fbf926ad | 1703 | ///\r |
1704 | /// Used to describe a physical key on a keyboard.\r | |
1705 | ///\r | |
2f88bd3a | 1706 | EFI_KEY Key;\r |
fbf926ad | 1707 | ///\r |
1708 | /// Unicode character code for the Key.\r | |
1709 | ///\r | |
2f88bd3a | 1710 | CHAR16 Unicode;\r |
fbf926ad | 1711 | ///\r |
1712 | /// Unicode character code for the key with the shift key being held down.\r | |
1713 | ///\r | |
2f88bd3a | 1714 | CHAR16 ShiftedUnicode;\r |
fbf926ad | 1715 | ///\r |
1716 | /// Unicode character code for the key with the Alt-GR being held down.\r | |
1717 | ///\r | |
2f88bd3a | 1718 | CHAR16 AltGrUnicode;\r |
fbf926ad | 1719 | ///\r |
1720 | /// Unicode character code for the key with the Alt-GR and shift keys being held down.\r | |
1721 | ///\r | |
2f88bd3a | 1722 | CHAR16 ShiftedAltGrUnicode;\r |
fbf926ad | 1723 | ///\r |
9095d37b LG |
1724 | /// Modifier keys are defined to allow for special functionality that is not necessarily\r |
1725 | /// accomplished by a printable character. Many of these modifier keys are flags to toggle\r | |
fbf926ad | 1726 | /// certain state bits on and off inside of a keyboard driver.\r |
1727 | ///\r | |
2f88bd3a MK |
1728 | UINT16 Modifier;\r |
1729 | UINT16 AffectedAttribute;\r | |
7d582d6b | 1730 | } EFI_KEY_DESCRIPTOR;\r |
1731 | \r | |
8b13229b | 1732 | ///\r |
9095d37b | 1733 | /// A key which is affected by all the standard shift modifiers.\r |
8b13229b | 1734 | /// Most keys would be expected to have this bit active.\r |
1735 | ///\r | |
2f88bd3a | 1736 | #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001\r |
8b13229b | 1737 | \r |
1738 | ///\r | |
1739 | /// This key is affected by the caps lock so that if a keyboard driver\r | |
1740 | /// would need to disambiguate between a key which had a "1" defined\r | |
1a2f870c | 1741 | /// versus an "a" character. Having this bit turned on would tell\r |
8b13229b | 1742 | /// the keyboard driver to use the appropriate shifted state or not.\r |
1743 | ///\r | |
2f88bd3a | 1744 | #define EFI_AFFECTED_BY_CAPS_LOCK 0x0002\r |
8b13229b | 1745 | \r |
1746 | ///\r | |
1747 | /// Similar to the case of CAPS lock, if this bit is active, the key\r | |
1748 | /// is affected by the num lock being turned on.\r | |
1749 | ///\r | |
2f88bd3a | 1750 | #define EFI_AFFECTED_BY_NUM_LOCK 0x0004\r |
959ccb23 | 1751 | \r |
1752 | typedef struct {\r | |
2f88bd3a MK |
1753 | UINT16 LayoutLength;\r |
1754 | EFI_GUID Guid;\r | |
1755 | UINT32 LayoutDescriptorStringOffset;\r | |
1756 | UINT8 DescriptorCount;\r | |
7d582d6b | 1757 | // EFI_KEY_DESCRIPTOR Descriptors[];\r |
1758 | } EFI_HII_KEYBOARD_LAYOUT;\r | |
959ccb23 | 1759 | \r |
1760 | typedef struct {\r | |
2f88bd3a MK |
1761 | EFI_HII_PACKAGE_HEADER Header;\r |
1762 | UINT16 LayoutCount;\r | |
7d582d6b | 1763 | // EFI_HII_KEYBOARD_LAYOUT Layout[];\r |
1764 | } EFI_HII_KEYBOARD_PACKAGE_HDR;\r | |
959ccb23 | 1765 | \r |
959ccb23 | 1766 | //\r |
7d582d6b | 1767 | // Modifier values\r |
959ccb23 | 1768 | //\r |
2f88bd3a MK |
1769 | #define EFI_NULL_MODIFIER 0x0000\r |
1770 | #define EFI_LEFT_CONTROL_MODIFIER 0x0001\r | |
1771 | #define EFI_RIGHT_CONTROL_MODIFIER 0x0002\r | |
1772 | #define EFI_LEFT_ALT_MODIFIER 0x0003\r | |
1773 | #define EFI_RIGHT_ALT_MODIFIER 0x0004\r | |
1774 | #define EFI_ALT_GR_MODIFIER 0x0005\r | |
1775 | #define EFI_INSERT_MODIFIER 0x0006\r | |
1776 | #define EFI_DELETE_MODIFIER 0x0007\r | |
1777 | #define EFI_PAGE_DOWN_MODIFIER 0x0008\r | |
1778 | #define EFI_PAGE_UP_MODIFIER 0x0009\r | |
1779 | #define EFI_HOME_MODIFIER 0x000A\r | |
1780 | #define EFI_END_MODIFIER 0x000B\r | |
1781 | #define EFI_LEFT_SHIFT_MODIFIER 0x000C\r | |
1782 | #define EFI_RIGHT_SHIFT_MODIFIER 0x000D\r | |
1783 | #define EFI_CAPS_LOCK_MODIFIER 0x000E\r | |
1784 | #define EFI_NUM_LOCK_MODIFIER 0x000F\r | |
1785 | #define EFI_LEFT_ARROW_MODIFIER 0x0010\r | |
1786 | #define EFI_RIGHT_ARROW_MODIFIER 0x0011\r | |
1787 | #define EFI_DOWN_ARROW_MODIFIER 0x0012\r | |
1788 | #define EFI_UP_ARROW_MODIFIER 0x0013\r | |
1789 | #define EFI_NS_KEY_MODIFIER 0x0014\r | |
1790 | #define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015\r | |
1791 | #define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016\r | |
1792 | #define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017\r | |
1793 | #define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018\r | |
1794 | #define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019\r | |
1795 | #define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A\r | |
1796 | #define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B\r | |
1797 | #define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C\r | |
1798 | #define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D\r | |
1799 | #define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E\r | |
1800 | #define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F\r | |
1801 | #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020\r | |
1802 | #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021\r | |
959ccb23 | 1803 | \r |
7d582d6b | 1804 | //\r |
1805 | // Keys that have multiple control functions based on modifier\r | |
1806 | // settings are handled in the keyboard driver implementation.\r | |
1a2f870c | 1807 | // For instance, PRINT_KEY might have a modifier held down and\r |
7d582d6b | 1808 | // is still a nonprinting character, but might have an alternate\r |
1809 | // control function like SYSREQUEST\r | |
1810 | //\r | |
2f88bd3a MK |
1811 | #define EFI_PRINT_MODIFIER 0x0022\r |
1812 | #define EFI_SYS_REQUEST_MODIFIER 0x0023\r | |
1813 | #define EFI_SCROLL_LOCK_MODIFIER 0x0024\r | |
1814 | #define EFI_PAUSE_MODIFIER 0x0025\r | |
1815 | #define EFI_BREAK_MODIFIER 0x0026\r | |
959ccb23 | 1816 | \r |
2f88bd3a MK |
1817 | #define EFI_LEFT_LOGO_MODIFIER 0x0027\r |
1818 | #define EFI_RIGHT_LOGO_MODIFIER 0x0028\r | |
1819 | #define EFI_MENU_MODIFIER 0x0029\r | |
54cf8780 | 1820 | \r |
f6051525 | 1821 | ///\r |
1822 | /// Animation IFR opcode\r | |
1823 | ///\r | |
1824 | typedef struct _EFI_IFR_ANIMATION {\r | |
1825 | ///\r | |
9095d37b | 1826 | /// Standard opcode header, where Header.OpCode is\r |
f6051525 | 1827 | /// EFI_IFR_ANIMATION_OP.\r |
1828 | ///\r | |
2f88bd3a | 1829 | EFI_IFR_OP_HEADER Header;\r |
f6051525 | 1830 | ///\r |
1831 | /// Animation identifier in the HII database.\r | |
1832 | ///\r | |
2f88bd3a | 1833 | EFI_ANIMATION_ID Id;\r |
f6051525 | 1834 | } EFI_IFR_ANIMATION;\r |
1835 | \r | |
1836 | ///\r | |
af2dc6a7 | 1837 | /// HII animation package header.\r |
f6051525 | 1838 | ///\r |
1839 | typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR {\r | |
1840 | ///\r | |
1841 | /// Standard package header, where Header.Type = EFI_HII_PACKAGE_ANIMATIONS.\r | |
1842 | ///\r | |
2f88bd3a | 1843 | EFI_HII_PACKAGE_HEADER Header;\r |
f6051525 | 1844 | ///\r |
9095d37b | 1845 | /// Offset, relative to this header, of the animation information. If\r |
f6051525 | 1846 | /// this is zero, then there are no animation sequences in the package.\r |
1847 | ///\r | |
2f88bd3a | 1848 | UINT32 AnimationInfoOffset;\r |
f6051525 | 1849 | } EFI_HII_ANIMATION_PACKAGE_HDR;\r |
1850 | \r | |
1851 | ///\r | |
1852 | /// Animation information is encoded as a series of blocks,\r | |
af2dc6a7 | 1853 | /// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.\r |
f6051525 | 1854 | ///\r |
1855 | typedef struct _EFI_HII_ANIMATION_BLOCK {\r | |
2f88bd3a MK |
1856 | UINT8 BlockType;\r |
1857 | // UINT8 BlockBody[];\r | |
f6051525 | 1858 | } EFI_HII_ANIMATION_BLOCK;\r |
1859 | \r | |
1860 | ///\r | |
af2dc6a7 | 1861 | /// Animation block types.\r |
f6051525 | 1862 | ///\r |
2f88bd3a MK |
1863 | #define EFI_HII_AIBT_END 0x00\r |
1864 | #define EFI_HII_AIBT_OVERLAY_IMAGES 0x10\r | |
1865 | #define EFI_HII_AIBT_CLEAR_IMAGES 0x11\r | |
1866 | #define EFI_HII_AIBT_RESTORE_SCRN 0x12\r | |
1867 | #define EFI_HII_AIBT_OVERLAY_IMAGES_LOOP 0x18\r | |
1868 | #define EFI_HII_AIBT_CLEAR_IMAGES_LOOP 0x19\r | |
1869 | #define EFI_HII_AIBT_RESTORE_SCRN_LOOP 0x1A\r | |
1870 | #define EFI_HII_AIBT_DUPLICATE 0x20\r | |
1871 | #define EFI_HII_AIBT_SKIP2 0x21\r | |
1872 | #define EFI_HII_AIBT_SKIP1 0x22\r | |
1873 | #define EFI_HII_AIBT_EXT1 0x30\r | |
1874 | #define EFI_HII_AIBT_EXT2 0x31\r | |
1875 | #define EFI_HII_AIBT_EXT4 0x32\r | |
f6051525 | 1876 | \r |
1877 | ///\r | |
1878 | /// Extended block headers used for variable sized animation records\r | |
1879 | /// which need an explicit length.\r | |
1880 | ///\r | |
1881 | \r | |
1882 | typedef struct _EFI_HII_AIBT_EXT1_BLOCK {\r | |
1883 | ///\r | |
af2dc6a7 | 1884 | /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.\r |
f6051525 | 1885 | ///\r |
2f88bd3a | 1886 | EFI_HII_ANIMATION_BLOCK Header;\r |
f6051525 | 1887 | ///\r |
af2dc6a7 | 1888 | /// The block type.\r |
f6051525 | 1889 | ///\r |
2f88bd3a | 1890 | UINT8 BlockType2;\r |
f6051525 | 1891 | ///\r |
1892 | /// Size of the animation block, in bytes, including the animation block header.\r | |
1893 | ///\r | |
2f88bd3a | 1894 | UINT8 Length;\r |
f6051525 | 1895 | } EFI_HII_AIBT_EXT1_BLOCK;\r |
1896 | \r | |
1897 | typedef struct _EFI_HII_AIBT_EXT2_BLOCK {\r | |
1898 | ///\r | |
af2dc6a7 | 1899 | /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.\r |
f6051525 | 1900 | ///\r |
2f88bd3a | 1901 | EFI_HII_ANIMATION_BLOCK Header;\r |
f6051525 | 1902 | ///\r |
1903 | /// The block type\r | |
1904 | ///\r | |
2f88bd3a | 1905 | UINT8 BlockType2;\r |
f6051525 | 1906 | ///\r |
1907 | /// Size of the animation block, in bytes, including the animation block header.\r | |
1908 | ///\r | |
2f88bd3a | 1909 | UINT16 Length;\r |
f6051525 | 1910 | } EFI_HII_AIBT_EXT2_BLOCK;\r |
1911 | \r | |
1912 | typedef struct _EFI_HII_AIBT_EXT4_BLOCK {\r | |
1913 | ///\r | |
af2dc6a7 | 1914 | /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.\r |
f6051525 | 1915 | ///\r |
2f88bd3a | 1916 | EFI_HII_ANIMATION_BLOCK Header;\r |
f6051525 | 1917 | ///\r |
1918 | /// The block type\r | |
1919 | ///\r | |
2f88bd3a | 1920 | UINT8 BlockType2;\r |
f6051525 | 1921 | ///\r |
1922 | /// Size of the animation block, in bytes, including the animation block header.\r | |
1923 | ///\r | |
2f88bd3a | 1924 | UINT32 Length;\r |
f6051525 | 1925 | } EFI_HII_AIBT_EXT4_BLOCK;\r |
1926 | \r | |
1927 | typedef struct _EFI_HII_ANIMATION_CELL {\r | |
1928 | ///\r | |
9095d37b | 1929 | /// The X offset from the upper left hand corner of the logical\r |
f6051525 | 1930 | /// window to position the indexed image.\r |
1931 | ///\r | |
2f88bd3a | 1932 | UINT16 OffsetX;\r |
f6051525 | 1933 | ///\r |
9095d37b | 1934 | /// The Y offset from the upper left hand corner of the logical\r |
f6051525 | 1935 | /// window to position the indexed image.\r |
1936 | ///\r | |
2f88bd3a | 1937 | UINT16 OffsetY;\r |
f6051525 | 1938 | ///\r |
9095d37b | 1939 | /// The image to display at the specified offset from the upper left\r |
f6051525 | 1940 | /// hand corner of the logical window.\r |
1941 | ///\r | |
2f88bd3a | 1942 | EFI_IMAGE_ID ImageId;\r |
f6051525 | 1943 | ///\r |
9095d37b LG |
1944 | /// The number of milliseconds to delay after displaying the indexed\r |
1945 | /// image and before continuing on to the next linked image. If value\r | |
f6051525 | 1946 | /// is zero, no delay.\r |
1947 | ///\r | |
2f88bd3a | 1948 | UINT16 Delay;\r |
f6051525 | 1949 | } EFI_HII_ANIMATION_CELL;\r |
1950 | \r | |
1951 | ///\r | |
1952 | /// An animation block to describe an animation sequence that does not cycle, and\r | |
1953 | /// where one image is simply displayed over the previous image.\r | |
1954 | ///\r | |
8c6d73fb | 1955 | typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK {\r |
f6051525 | 1956 | ///\r |
9095d37b LG |
1957 | /// This is image that is to be reference by the image protocols, if the\r |
1958 | /// animation function is not supported or disabled. This image can\r | |
1959 | /// be one particular image from the animation sequence (if any one\r | |
1960 | /// of the animation frames has a complete image) or an alternate\r | |
1961 | /// image that can be displayed alone. If the value is zero, no image\r | |
f6051525 | 1962 | /// is displayed.\r |
1963 | ///\r | |
2f88bd3a | 1964 | EFI_IMAGE_ID DftImageId;\r |
f6051525 | 1965 | ///\r |
1966 | /// The overall width of the set of images (logical window width).\r | |
1967 | ///\r | |
2f88bd3a | 1968 | UINT16 Width;\r |
f6051525 | 1969 | ///\r |
1970 | /// The overall height of the set of images (logical window height).\r | |
1971 | ///\r | |
2f88bd3a | 1972 | UINT16 Height;\r |
f6051525 | 1973 | ///\r |
9095d37b | 1974 | /// The number of EFI_HII_ANIMATION_CELL contained in the\r |
f6051525 | 1975 | /// animation sequence.\r |
1976 | ///\r | |
2f88bd3a | 1977 | UINT16 CellCount;\r |
f6051525 | 1978 | ///\r |
1979 | /// An array of CellCount animation cells.\r | |
1980 | ///\r | |
2f88bd3a | 1981 | EFI_HII_ANIMATION_CELL AnimationCell[1];\r |
f6051525 | 1982 | } EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK;\r |
1983 | \r | |
1984 | ///\r | |
1985 | /// An animation block to describe an animation sequence that does not cycle,\r | |
9095d37b | 1986 | /// and where the logical window is cleared to the specified color before\r |
f6051525 | 1987 | /// the next image is displayed.\r |
1988 | ///\r | |
1989 | typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK {\r | |
1990 | ///\r | |
9095d37b LG |
1991 | /// This is image that is to be reference by the image protocols, if the\r |
1992 | /// animation function is not supported or disabled. This image can\r | |
1993 | /// be one particular image from the animation sequence (if any one\r | |
1994 | /// of the animation frames has a complete image) or an alternate\r | |
1995 | /// image that can be displayed alone. If the value is zero, no image\r | |
f6051525 | 1996 | /// is displayed.\r |
1997 | ///\r | |
2f88bd3a | 1998 | EFI_IMAGE_ID DftImageId;\r |
f6051525 | 1999 | ///\r |
2000 | /// The overall width of the set of images (logical window width).\r | |
2001 | ///\r | |
2f88bd3a | 2002 | UINT16 Width;\r |
f6051525 | 2003 | ///\r |
2004 | /// The overall height of the set of images (logical window height).\r | |
2005 | ///\r | |
2f88bd3a | 2006 | UINT16 Height;\r |
f6051525 | 2007 | ///\r |
9095d37b | 2008 | /// The number of EFI_HII_ANIMATION_CELL contained in the\r |
f6051525 | 2009 | /// animation sequence.\r |
2010 | ///\r | |
2f88bd3a | 2011 | UINT16 CellCount;\r |
f6051525 | 2012 | ///\r |
9095d37b | 2013 | /// The color to clear the logical window to before displaying the\r |
f6051525 | 2014 | /// indexed image.\r |
2015 | ///\r | |
2f88bd3a | 2016 | EFI_HII_RGB_PIXEL BackgndColor;\r |
f6051525 | 2017 | ///\r |
2018 | /// An array of CellCount animation cells.\r | |
2019 | ///\r | |
2f88bd3a | 2020 | EFI_HII_ANIMATION_CELL AnimationCell[1];\r |
f6051525 | 2021 | } EFI_HII_AIBT_CLEAR_IMAGES_BLOCK;\r |
2022 | \r | |
2023 | ///\r | |
2024 | /// An animation block to describe an animation sequence that does not cycle,\r | |
9095d37b | 2025 | /// and where the screen is restored to the original state before the next\r |
f6051525 | 2026 | /// image is displayed.\r |
2027 | ///\r | |
2028 | typedef struct _EFI_HII_AIBT_RESTORE_SCRN_BLOCK {\r | |
2029 | ///\r | |
9095d37b LG |
2030 | /// This is image that is to be reference by the image protocols, if the\r |
2031 | /// animation function is not supported or disabled. This image can\r | |
2032 | /// be one particular image from the animation sequence (if any one\r | |
2033 | /// of the animation frames has a complete image) or an alternate\r | |
2034 | /// image that can be displayed alone. If the value is zero, no image\r | |
f6051525 | 2035 | /// is displayed.\r |
2036 | ///\r | |
2f88bd3a | 2037 | EFI_IMAGE_ID DftImageId;\r |
f6051525 | 2038 | ///\r |
2039 | /// The overall width of the set of images (logical window width).\r | |
2040 | ///\r | |
2f88bd3a | 2041 | UINT16 Width;\r |
f6051525 | 2042 | ///\r |
2043 | /// The overall height of the set of images (logical window height).\r | |
2044 | ///\r | |
2f88bd3a | 2045 | UINT16 Height;\r |
f6051525 | 2046 | ///\r |
9095d37b | 2047 | /// The number of EFI_HII_ANIMATION_CELL contained in the\r |
f6051525 | 2048 | /// animation sequence.\r |
2049 | ///\r | |
2f88bd3a | 2050 | UINT16 CellCount;\r |
f6051525 | 2051 | ///\r |
2052 | /// An array of CellCount animation cells.\r | |
2053 | ///\r | |
2f88bd3a | 2054 | EFI_HII_ANIMATION_CELL AnimationCell[1];\r |
f6051525 | 2055 | } EFI_HII_AIBT_RESTORE_SCRN_BLOCK;\r |
2056 | \r | |
2057 | ///\r | |
2058 | /// An animation block to describe an animation sequence that continuously cycles,\r | |
2059 | /// and where one image is simply displayed over the previous image.\r | |
2060 | ///\r | |
2f88bd3a | 2061 | typedef EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK EFI_HII_AIBT_OVERLAY_IMAGES_LOOP_BLOCK;\r |
f6051525 | 2062 | \r |
2063 | ///\r | |
2064 | /// An animation block to describe an animation sequence that continuously cycles,\r | |
9095d37b | 2065 | /// and where the logical window is cleared to the specified color before\r |
f6051525 | 2066 | /// the next image is displayed.\r |
2067 | ///\r | |
2f88bd3a | 2068 | typedef EFI_HII_AIBT_CLEAR_IMAGES_BLOCK EFI_HII_AIBT_CLEAR_IMAGES_LOOP_BLOCK;\r |
f6051525 | 2069 | \r |
2070 | ///\r | |
2071 | /// An animation block to describe an animation sequence that continuously cycles,\r | |
9095d37b | 2072 | /// and where the screen is restored to the original state before\r |
f6051525 | 2073 | /// the next image is displayed.\r |
2074 | ///\r | |
2f88bd3a | 2075 | typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK;\r |
f6051525 | 2076 | \r |
2077 | ///\r | |
2078 | /// Assigns a new character value to a previously defined animation sequence.\r | |
2079 | ///\r | |
2080 | typedef struct _EFI_HII_AIBT_DUPLICATE_BLOCK {\r | |
2081 | ///\r | |
9095d37b | 2082 | /// The previously defined animation ID with the exact same\r |
f6051525 | 2083 | /// animation information.\r |
2084 | ///\r | |
2f88bd3a | 2085 | EFI_ANIMATION_ID AnimationId;\r |
f6051525 | 2086 | } EFI_HII_AIBT_DUPLICATE_BLOCK;\r |
2087 | \r | |
2088 | ///\r | |
2089 | /// Skips animation IDs.\r | |
2090 | ///\r | |
2091 | typedef struct _EFI_HII_AIBT_SKIP1_BLOCK {\r | |
2092 | ///\r | |
2093 | /// The unsigned 8-bit value to add to AnimationIdCurrent.\r | |
2094 | ///\r | |
2f88bd3a | 2095 | UINT8 SkipCount;\r |
f6051525 | 2096 | } EFI_HII_AIBT_SKIP1_BLOCK;\r |
2097 | \r | |
2098 | ///\r | |
2099 | /// Skips animation IDs.\r | |
2100 | ///\r | |
2101 | typedef struct _EFI_HII_AIBT_SKIP2_BLOCK {\r | |
2102 | ///\r | |
2103 | /// The unsigned 16-bit value to add to AnimationIdCurrent.\r | |
2104 | ///\r | |
2f88bd3a | 2105 | UINT16 SkipCount;\r |
f6051525 | 2106 | } EFI_HII_AIBT_SKIP2_BLOCK;\r |
2107 | \r | |
959ccb23 | 2108 | #pragma pack()\r |
2109 | \r | |
8b13229b | 2110 | ///\r |
2111 | /// References to string tokens must use this macro to enable scanning for\r | |
2112 | /// token usages.\r | |
2113 | ///\r | |
2114 | ///\r | |
9095d37b | 2115 | /// STRING_TOKEN is not defined in UEFI specification. But it is placed\r |
8b13229b | 2116 | /// here for the easy access by C files and VFR source files.\r |
2117 | ///\r | |
2f88bd3a | 2118 | #define STRING_TOKEN(t) t\r |
e52c5a9f | 2119 | \r |
4f0ae88c LG |
2120 | ///\r |
2121 | /// IMAGE_TOKEN is not defined in UEFI specification. But it is placed\r | |
2122 | /// here for the easy access by C files and VFR source files.\r | |
2123 | ///\r | |
2f88bd3a | 2124 | #define IMAGE_TOKEN(t) t\r |
4f0ae88c | 2125 | \r |
959ccb23 | 2126 | #endif\r |