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