]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/C/Include/Common/UefiInternalFormRepresentation.h
BaseTools: Add reconnect request flag for question.
[mirror_edk2.git] / BaseTools / Source / C / Include / Common / UefiInternalFormRepresentation.h
CommitLineData
30fdf114
LG
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
97fa0ee9
YL
6 @par Revision Reference:\r
7 These definitions are from UEFI2.1.\r
8\r
366430c7 9 Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
30fdf114
LG
10\r
11 This program and the accompanying materials are licensed and made available\r
12 under the terms and conditions of the BSD License which accompanies this\r
97fa0ee9 13 distribution. The full text of the license may be found at\r
30fdf114
LG
14 http://opensource.org/licenses/bsd-license.php\r
15\r
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
18\r
30fdf114
LG
19**/\r
20\r
21#ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__\r
22#define __UEFI_INTERNAL_FORMREPRESENTATION_H__\r
23\r
24\r
25#define EFI_HII_PLATFORM_SETUP_FORMSET_GUID \\r
26 { 0x93039971, 0x8545, 0x4b04, { 0xb4, 0x5e, 0x32, 0xeb, 0x83, 0x26, 0x4, 0xe } }\r
27\r
28//\r
29// The following types are currently defined:\r
30//\r
31typedef UINT32 RELOFST;\r
32\r
33typedef VOID* EFI_HII_HANDLE;\r
34typedef CHAR16* EFI_STRING;\r
35typedef UINT16 EFI_IMAGE_ID;\r
36typedef UINT16 EFI_QUESTION_ID;\r
37typedef UINT16 EFI_STRING_ID;\r
38typedef UINT16 EFI_FORM_ID;\r
39typedef UINT16 EFI_VARSTORE_ID;\r
40typedef UINT16 EFI_DEFAULT_ID;\r
41typedef UINT32 EFI_HII_FONT_STYLE;\r
42\r
43\r
44\r
45#pragma pack(1)\r
46\r
47\r
48//\r
49// HII package list\r
50//\r
51typedef struct {\r
52 EFI_GUID PackageListGuid;\r
53 UINT32 PackageLength;\r
54} EFI_HII_PACKAGE_LIST_HEADER;\r
55\r
56/**\r
57 \r
58 Each package starts with a header, as defined above, which \r
59 indicates the size and type of the package. When added to a \r
60 pointer pointing to the start of the header, Length points at \r
61 the next package. The package lists form a package list when \r
62 concatenated together and terminated with an \r
63 EFI_HII_PACKAGE_HEADER with a Type of EFI_HII_PACKAGE_END. The \r
64 type EFI_HII_PACKAGE_TYPE_GUID is used for vendor-defined HII \r
65 packages, whose contents are determined by the Guid. The range \r
66 of package types starting with EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN \r
67 through EFI_HII_PACKAGE_TYPE_SYSTEM_END are reserved for system \r
68 firmware implementers. \r
69 \r
70 @param Length The size of the package in bytes.\r
71 \r
72 @param Type The package type. See EFI_HII_PACKAGE_TYPE_x,\r
73 below.\r
74 \r
75 @param Data The package data, the format of which is\r
76 determined by Type.\r
77 \r
78**/\r
79typedef struct {\r
80 UINT32 Length:24;\r
81 UINT32 Type:8;\r
82 // UINT8 Data[...];\r
83} EFI_HII_PACKAGE_HEADER;\r
84\r
85//\r
86// EFI_HII_PACKAGE_TYPE_x.\r
87// \r
88#define EFI_HII_PACKAGE_TYPE_ALL 0x00\r
89#define EFI_HII_PACKAGE_TYPE_GUID 0x01\r
90#define EFI_HII_PACKAGE_FORM 0x02\r
91#define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x03\r
92#define EFI_HII_PACKAGE_STRINGS 0x04\r
93#define EFI_HII_PACKAGE_FONTS 0x05\r
94#define EFI_HII_PACKAGE_IMAGES 0x06\r
95#define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07\r
96#define EFI_HII_PACKAGE_DEVICE_PATH 0x08\r
97#define EFI_HII_PACKAGE_END 0xDF\r
98#define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0\r
99#define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF\r
100\r
101//\r
102// Simplified Font Package\r
103//\r
104\r
105#define EFI_GLYPH_HEIGHT 19\r
106#define EFI_GLYPH_WIDTH 8\r
107//\r
108// Contents of EFI_NARROW_GLYPH.Attributes\r
109//\r
110#define EFI_GLYPH_NON_SPACING 0x01\r
111#define EFI_GLYPH_WIDE 0x02\r
112\r
113typedef struct {\r
114 CHAR16 UnicodeWeight;\r
115 UINT8 Attributes;\r
116 UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r
117} EFI_NARROW_GLYPH;\r
118\r
119typedef struct {\r
120 CHAR16 UnicodeWeight;\r
121 UINT8 Attributes;\r
122 UINT8 GlyphCol1[EFI_GLYPH_HEIGHT];\r
123 UINT8 GlyphCol2[EFI_GLYPH_HEIGHT];\r
124 UINT8 Pad[3];\r
125} EFI_WIDE_GLYPH;\r
126\r
127\r
128typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {\r
129 EFI_HII_PACKAGE_HEADER Header;\r
130 UINT16 NumberOfNarrowGlyphs;\r
131 UINT16 NumberOfWideGlyphs;\r
132 // EFI_NARROW_GLYPH NarrowGlyphs[];\r
133 // EFI_WIDE_GLYPH WideGlyphs[];\r
134} EFI_HII_SIMPLE_FONT_PACKAGE_HDR;\r
135\r
136//\r
137// Font Package\r
138//\r
139\r
140#define EFI_HII_FONT_STYLE_BOLD 0x00000001\r
141#define EFI_HII_FONT_STYLE_ITALIC 0x00000002\r
142#define EFI_HII_FONT_STYLE_EMBOSS 0x00010000\r
143#define EFI_HII_FONT_STYLE_OUTLINE 0x00020000\r
144#define EFI_HII_FONT_STYLE_SHADOW 0x00040000\r
145#define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000\r
146#define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000\r
147\r
148typedef struct _EFI_HII_GLYPH_INFO {\r
149 UINT16 Width;\r
150 UINT16 Height;\r
151 INT16 OffsetX;\r
152 INT16 OffsetY;\r
153 INT16 AdvanceX;\r
154} EFI_HII_GLYPH_INFO;\r
155\r
156typedef struct _EFI_HII_FONT_PACKAGE_HDR {\r
157 EFI_HII_PACKAGE_HEADER Header;\r
158 UINT32 HdrSize;\r
159 UINT32 GlyphBlockOffset;\r
160 EFI_HII_GLYPH_INFO Cell;\r
161 EFI_HII_FONT_STYLE FontStyle;\r
162 CHAR16 FontFamily[1];\r
163} EFI_HII_FONT_PACKAGE_HDR;\r
164\r
165#define EFI_HII_GIBT_END 0x00\r
166#define EFI_HII_GIBT_GLYPH 0x10\r
167#define EFI_HII_GIBT_GLYPHS 0x11\r
168#define EFI_HII_GIBT_GLYPH_DEFAULT 0x12\r
169#define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13\r
170#define EFI_HII_GIBT_DUPLICATE 0x20\r
171#define EFI_HII_GIBT_SKIP2 0x21\r
172#define EFI_HII_GIBT_SKIP1 0x22\r
173#define EFI_HII_GIBT_DEFAULTS 0x23\r
174#define EFI_HII_GIBT_EXT1 0x30\r
175#define EFI_HII_GIBT_EXT2 0x31\r
176#define EFI_HII_GIBT_EXT4 0x32\r
177\r
178typedef struct _EFI_HII_GLYPH_BLOCK {\r
179 UINT8 BlockType;\r
180} EFI_HII_GLYPH_BLOCK;\r
181\r
182typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK {\r
183 EFI_HII_GLYPH_BLOCK Header;\r
184 EFI_HII_GLYPH_INFO Cell;\r
185} EFI_HII_GIBT_DEFAULTS_BLOCK;\r
186\r
187typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK {\r
188 EFI_HII_GLYPH_BLOCK Header;\r
189 CHAR16 CharValue;\r
190} EFI_HII_GIBT_DUPLICATE_BLOCK;\r
191\r
192typedef struct _EFI_GLYPH_GIBT_END_BLOCK {\r
193 EFI_HII_GLYPH_BLOCK Header;\r
194} EFI_GLYPH_GIBT_END_BLOCK;\r
195\r
196typedef struct _EFI_HII_GIBT_EXT1_BLOCK {\r
197 EFI_HII_GLYPH_BLOCK Header;\r
198 UINT8 BlockType2;\r
199 UINT8 Length;\r
200} EFI_HII_GIBT_EXT1_BLOCK;\r
201\r
202typedef struct _EFI_HII_GIBT_EXT2_BLOCK {\r
203 EFI_HII_GLYPH_BLOCK Header;\r
204 UINT8 BlockType2;\r
205 UINT16 Length;\r
206} EFI_HII_GIBT_EXT2_BLOCK;\r
207\r
208typedef struct _EFI_HII_GIBT_EXT4_BLOCK {\r
209 EFI_HII_GLYPH_BLOCK Header;\r
210 UINT8 BlockType2;\r
211 UINT32 Length;\r
212} EFI_HII_GIBT_EXT4_BLOCK;\r
213\r
214typedef struct _EFI_HII_GIBT_GLYPH_BLOCK {\r
215 EFI_HII_GLYPH_BLOCK Header;\r
216 EFI_HII_GLYPH_INFO Cell;\r
217 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
218} EFI_HII_GIBT_GLYPH_BLOCK;\r
219\r
220typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK {\r
221 EFI_HII_GLYPH_BLOCK Header;\r
222 EFI_HII_GLYPH_INFO Cell;\r
223 UINT16 Count; \r
224 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height\r
225} EFI_HII_GIBT_GLYPHS_BLOCK;\r
226\r
227typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK {\r
228 EFI_HII_GLYPH_BLOCK Header;\r
229 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
230} EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK;\r
231\r
232typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK {\r
233 EFI_HII_GLYPH_BLOCK Header;\r
234 UINT16 Count;\r
235 UINT8 BitmapData[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height\r
236} EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK;\r
237\r
238typedef struct _EFI_HII_GIBT_SKIP1_BLOCK {\r
239 EFI_HII_GLYPH_BLOCK Header;\r
240 UINT8 SkipCount;\r
241} EFI_HII_GIBT_SKIP1_BLOCK;\r
242\r
243typedef struct _EFI_HII_GIBT_SKIP2_BLOCK {\r
244 EFI_HII_GLYPH_BLOCK Header;\r
245 UINT16 SkipCount;\r
246} EFI_HII_GIBT_SKIP2_BLOCK;\r
247\r
248//\r
249// Device Path Package\r
250//\r
251typedef struct _EFI_HII_DEVICE_PATH_PACKAGE {\r
252 EFI_HII_PACKAGE_HEADER Header;\r
253 // EFI_DEVICE_PATH_PROTOCOL DevicePath[];\r
254} EFI_HII_DEVICE_PATH_PACKAGE;\r
255\r
256//\r
257// GUID Package\r
258//\r
259typedef struct _EFI_HII_GUID_PACKAGE_HDR {\r
260 EFI_HII_PACKAGE_HEADER Header;\r
261 EFI_GUID Guid;\r
262 // Data per GUID definition may follow\r
263} EFI_HII_GUID_PACKAGE_HDR;\r
264\r
265//\r
266// String Package\r
267//\r
268\r
b303ea72
LG
269#define UEFI_CONFIG_LANG "x-UEFI"\r
270#define UEFI_CONFIG_LANG2 "x-i-UEFI"\r
30fdf114
LG
271\r
272typedef struct _EFI_HII_STRING_PACKAGE_HDR {\r
273 EFI_HII_PACKAGE_HEADER Header;\r
274 UINT32 HdrSize;\r
275 UINT32 StringInfoOffset;\r
276 CHAR16 LanguageWindow[16];\r
277 EFI_STRING_ID LanguageName;\r
278 CHAR8 Language[1];\r
279} EFI_HII_STRING_PACKAGE_HDR;\r
280\r
281typedef struct {\r
282 UINT8 BlockType;\r
283} EFI_HII_STRING_BLOCK;\r
284\r
285#define EFI_HII_SIBT_END 0x00\r
286#define EFI_HII_SIBT_STRING_SCSU 0x10\r
287#define EFI_HII_SIBT_STRING_SCSU_FONT 0x11\r
288#define EFI_HII_SIBT_STRINGS_SCSU 0x12\r
289#define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13\r
290#define EFI_HII_SIBT_STRING_UCS2 0x14\r
291#define EFI_HII_SIBT_STRING_UCS2_FONT 0x15\r
292#define EFI_HII_SIBT_STRINGS_UCS2 0x16\r
293#define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17\r
294#define EFI_HII_SIBT_DUPLICATE 0x20\r
295#define EFI_HII_SIBT_SKIP2 0x21\r
296#define EFI_HII_SIBT_SKIP1 0x22\r
297#define EFI_HII_SIBT_EXT1 0x30\r
298#define EFI_HII_SIBT_EXT2 0x31\r
299#define EFI_HII_SIBT_EXT4 0x32\r
300#define EFI_HII_SIBT_FONT 0x40\r
301\r
302typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK {\r
303 EFI_HII_STRING_BLOCK Header;\r
304 EFI_STRING_ID StringId;\r
305} EFI_HII_SIBT_DUPLICATE_BLOCK;\r
306\r
307typedef struct _EFI_HII_SIBT_END_BLOCK {\r
308 EFI_HII_STRING_BLOCK Header;\r
309} EFI_HII_SIBT_END_BLOCK;\r
310\r
311typedef struct _EFI_HII_SIBT_EXT1_BLOCK {\r
312 EFI_HII_STRING_BLOCK Header;\r
313 UINT8 BlockType2;\r
314 UINT8 Length;\r
315} EFI_HII_SIBT_EXT1_BLOCK;\r
316\r
317typedef struct _EFI_HII_SIBT_EXT2_BLOCK {\r
318 EFI_HII_STRING_BLOCK Header;\r
319 UINT8 BlockType2;\r
320 UINT16 Length;\r
321} EFI_HII_SIBT_EXT2_BLOCK;\r
322\r
323typedef struct _EFI_HII_SIBT_EXT4_BLOCK {\r
324 EFI_HII_STRING_BLOCK Header;\r
325 UINT8 BlockType2;\r
326 UINT32 Length;\r
327} EFI_HII_SIBT_EXT4_BLOCK;\r
328\r
329typedef struct _EFI_HII_SIBT_FONT_BLOCK {\r
330 EFI_HII_SIBT_EXT2_BLOCK Header;\r
331 UINT8 FontId;\r
332 UINT16 FontSize;\r
333 EFI_HII_FONT_STYLE FontStyle;\r
334 CHAR16 FontName[1];\r
335} EFI_HII_SIBT_FONT_BLOCK;\r
336\r
337typedef struct _EFI_HII_SIBT_SKIP1_BLOCK {\r
338 EFI_HII_STRING_BLOCK Header;\r
339 UINT8 SkipCount;\r
340} EFI_HII_SIBT_SKIP1_BLOCK;\r
341\r
342typedef struct _EFI_HII_SIBT_SKIP2_BLOCK {\r
343 EFI_HII_STRING_BLOCK Header;\r
344 UINT16 SkipCount;\r
345} EFI_HII_SIBT_SKIP2_BLOCK;\r
346\r
347typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK {\r
348 EFI_HII_STRING_BLOCK Header;\r
349 UINT8 StringText[1];\r
350} EFI_HII_SIBT_STRING_SCSU_BLOCK;\r
351\r
352typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK {\r
353 EFI_HII_STRING_BLOCK Header;\r
354 UINT8 FontIdentifier;\r
355 UINT8 StringText[1];\r
356} EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK;\r
357\r
358typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK {\r
359 EFI_HII_STRING_BLOCK Header;\r
360 UINT16 StringCount;\r
361 UINT8 StringText[1];\r
362} EFI_HII_SIBT_STRINGS_SCSU_BLOCK;\r
363\r
364typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK {\r
365 EFI_HII_STRING_BLOCK Header;\r
366 UINT8 FontIdentifier;\r
367 UINT16 StringCount;\r
368 UINT8 StringText[1];\r
369} EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK;\r
370\r
371typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK {\r
372 EFI_HII_STRING_BLOCK Header;\r
373 CHAR16 StringText[1];\r
374} EFI_HII_SIBT_STRING_UCS2_BLOCK;\r
375\r
376typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK {\r
377 EFI_HII_STRING_BLOCK Header;\r
378 UINT8 FontIdentifier;\r
379 CHAR16 StringText[1];\r
380} EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK;\r
381\r
382typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK {\r
383 EFI_HII_STRING_BLOCK Header;\r
384 UINT16 StringCount;\r
385 CHAR16 StringText[1];\r
386} EFI_HII_SIBT_STRINGS_UCS2_BLOCK;\r
387\r
388typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK {\r
389 EFI_HII_STRING_BLOCK Header;\r
390 UINT8 FontIdentifier;\r
391 UINT16 StringCount;\r
392 CHAR16 StringText[1];\r
393} EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK;\r
394\r
395//\r
396// Image Packages\r
397//\r
398\r
399typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
400 EFI_HII_PACKAGE_HEADER Header;\r
401 UINT32 ImageInfoOffset;\r
402 UINT32 PaletteInfoOffset;\r
403} EFI_HII_IMAGE_PACKAGE_HDR;\r
404\r
405typedef struct _EFI_HII_IMAGE_BLOCK {\r
406 UINT8 BlockType;\r
407} EFI_HII_IMAGE_BLOCK;\r
408\r
409#define EFI_HII_IIBT_END 0x00\r
410#define EFI_HII_IIBT_IMAGE_1BIT 0x10\r
411#define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11\r
412#define EFI_HII_IIBT_IMAGE_4BIT 0x12\r
413#define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13\r
414#define EFI_HII_IIBT_IMAGE_8BIT 0x14\r
415#define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15\r
416#define EFI_HII_IIBT_IMAGE_24BIT 0x16\r
417#define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17\r
418#define EFI_HII_IIBT_IMAGE_JPEG 0x18\r
419#define EFI_HII_IIBT_DUPLICATE 0x20\r
420#define EFI_HII_IIBT_SKIP2 0x21\r
421#define EFI_HII_IIBT_SKIP1 0x22\r
422#define EFI_HII_IIBT_EXT1 0x30\r
423#define EFI_HII_IIBT_EXT2 0x31\r
424#define EFI_HII_IIBT_EXT4 0x32\r
425\r
426typedef struct _EFI_HII_IIBT_END_BLOCK {\r
427 EFI_HII_IMAGE_BLOCK Header;\r
428} EFI_HII_IIBT_END_BLOCK;\r
429\r
430typedef struct _EFI_HII_IIBT_EXT1_BLOCK {\r
431 EFI_HII_IMAGE_BLOCK Header;\r
432 UINT8 BlockType2;\r
433 UINT8 Length;\r
434} EFI_HII_IIBT_EXT1_BLOCK;\r
435\r
436typedef struct _EFI_HII_IIBT_EXT2_BLOCK {\r
437 EFI_HII_IMAGE_BLOCK Header;\r
438 UINT8 BlockType2;\r
439 UINT16 Length;\r
440} EFI_HII_IIBT_EXT2_BLOCK;\r
441\r
442typedef struct _EFI_HII_IIBT_EXT4_BLOCK {\r
443 EFI_HII_IMAGE_BLOCK Header;\r
444 UINT8 BlockType2;\r
445 UINT32 Length;\r
446} EFI_HII_IIBT_EXT4_BLOCK;\r
447\r
448typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE {\r
449 UINT16 Width;\r
450 UINT16 Height;\r
451 UINT8 Data[1];\r
452} EFI_HII_IIBT_IMAGE_1BIT_BASE;\r
453\r
454typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK {\r
455 EFI_HII_IMAGE_BLOCK Header;\r
456 UINT8 PaletteIndex;\r
457 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r
458} EFI_HII_IIBT_IMAGE_1BIT_BLOCK;\r
459\r
460typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK {\r
461 EFI_HII_IMAGE_BLOCK Header;\r
462 UINT8 PaletteIndex;\r
463 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap;\r
464} EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK;\r
465\r
466typedef struct _EFI_HII_RGB_PIXEL {\r
467 UINT8 b;\r
468 UINT8 g;\r
469 UINT8 r;\r
470} EFI_HII_RGB_PIXEL;\r
471\r
472typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE {\r
473 UINT16 Width;\r
474 UINT16 Height;\r
475 EFI_HII_RGB_PIXEL Bitmap[1];\r
476} EFI_HII_IIBT_IMAGE_24BIT_BASE;\r
477\r
478typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK {\r
479 EFI_HII_IMAGE_BLOCK Header;\r
480 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r
481} EFI_HII_IIBT_IMAGE_24BIT_BLOCK;\r
482\r
483typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK {\r
484 EFI_HII_IMAGE_BLOCK Header;\r
485 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap;\r
486} EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK;\r
487\r
488typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE {\r
489 UINT16 Width;\r
490 UINT16 Height;\r
491 UINT8 Data[1];\r
492} EFI_HII_IIBT_IMAGE_4BIT_BASE;\r
493\r
494typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK {\r
495 EFI_HII_IMAGE_BLOCK Header;\r
496 UINT8 PaletteIndex;\r
497 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r
498} EFI_HII_IIBT_IMAGE_4BIT_BLOCK;\r
499\r
500typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK {\r
501 EFI_HII_IMAGE_BLOCK Header;\r
502 UINT8 PaletteIndex;\r
503 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap;\r
504} EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK;\r
505\r
506typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE {\r
507 UINT16 Width;\r
508 UINT16 Height;\r
509 UINT8 Data[1];\r
510} EFI_HII_IIBT_IMAGE_8BIT_BASE;\r
511\r
512typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK {\r
513 EFI_HII_IMAGE_BLOCK Header;\r
514 UINT8 PaletteIndex;\r
515 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r
516} EFI_HII_IIBT_IMAGE_8BIT_BLOCK;\r
517\r
518typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK {\r
519 EFI_HII_IMAGE_BLOCK Header;\r
520 UINT8 PaletteIndex;\r
521 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap;\r
522} EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK;\r
523\r
524typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK {\r
525 EFI_HII_IMAGE_BLOCK Header;\r
526 EFI_IMAGE_ID ImageId;\r
527} EFI_HII_IIBT_DUPLICATE_BLOCK;\r
528\r
529typedef struct _EFI_HII_IIBT_JPEG_BLOCK {\r
530 EFI_HII_IMAGE_BLOCK Header;\r
531 UINT32 Size;\r
532 UINT8 Data[1];\r
533} EFI_HII_IIBT_JPEG_BLOCK;\r
534\r
535typedef struct _EFI_HII_IIBT_SKIP1_BLOCK {\r
536 EFI_HII_IMAGE_BLOCK Header;\r
537 UINT8 SkipCount;\r
538} EFI_HII_IIBT_SKIP1_BLOCK;\r
539\r
540typedef struct _EFI_HII_IIBT_SKIP2_BLOCK {\r
541 EFI_HII_IMAGE_BLOCK Header;\r
542 UINT16 SkipCount;\r
543} EFI_HII_IIBT_SKIP2_BLOCK;\r
544\r
545typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER {\r
546 UINT16 PaletteCount;\r
547} EFI_HII_IMAGE_PALETTE_INFO_HEADER;\r
548\r
549typedef struct _EFI_HII_IMAGE_PALETTE_INFO {\r
550 UINT16 PaletteSize;\r
551 EFI_HII_RGB_PIXEL PaletteValue[1];\r
552} EFI_HII_IMAGE_PALETTE_INFO;\r
553\r
554//\r
555// Forms Package\r
556//\r
557\r
558typedef struct _EFI_HII_FORM_PACKAGE {\r
559 EFI_HII_PACKAGE_HEADER Header;\r
560 // EFI_IFR_OP_HEADER OpCodeHeader;\r
561 // More op-codes follow\r
562} EFI_HII_FORM_PACKAGE;\r
563\r
564typedef struct {\r
565 UINT8 Hour;\r
566 UINT8 Minute;\r
567 UINT8 Second;\r
568} EFI_HII_TIME;\r
569\r
570typedef struct {\r
571 UINT16 Year;\r
572 UINT8 Month;\r
573 UINT8 Day;\r
574} EFI_HII_DATE;\r
575\r
4234283c
LG
576typedef struct {\r
577 EFI_QUESTION_ID QuestionId;\r
578 EFI_FORM_ID FormId;\r
579 EFI_GUID FormSetGuid;\r
580 EFI_STRING_ID DevicePath;\r
581} EFI_HII_REF;\r
582\r
30fdf114
LG
583typedef union {\r
584 UINT8 u8;\r
585 UINT16 u16;\r
586 UINT32 u32;\r
587 UINT64 u64;\r
588 BOOLEAN b;\r
589 EFI_HII_TIME time;\r
590 EFI_HII_DATE date;\r
591 EFI_STRING_ID string;\r
4234283c 592 EFI_HII_REF ref;\r
30fdf114
LG
593} EFI_IFR_TYPE_VALUE;\r
594\r
595#define EFI_IFR_FORM_OP 0x01\r
596#define EFI_IFR_SUBTITLE_OP 0x02\r
597#define EFI_IFR_TEXT_OP 0x03\r
598#define EFI_IFR_IMAGE_OP 0x04\r
599#define EFI_IFR_ONE_OF_OP 0x05\r
600#define EFI_IFR_CHECKBOX_OP 0x06\r
601#define EFI_IFR_NUMERIC_OP 0x07\r
602#define EFI_IFR_PASSWORD_OP 0x08\r
603#define EFI_IFR_ONE_OF_OPTION_OP 0x09\r
604#define EFI_IFR_SUPPRESS_IF_OP 0x0A\r
605#define EFI_IFR_LOCKED_OP 0x0B\r
606#define EFI_IFR_ACTION_OP 0x0C\r
607#define EFI_IFR_RESET_BUTTON_OP 0x0D\r
608#define EFI_IFR_FORM_SET_OP 0x0E\r
609#define EFI_IFR_REF_OP 0x0F\r
610#define EFI_IFR_NO_SUBMIT_IF_OP 0x10\r
611#define EFI_IFR_INCONSISTENT_IF_OP 0x11\r
612#define EFI_IFR_EQ_ID_VAL_OP 0x12\r
613#define EFI_IFR_EQ_ID_ID_OP 0x13\r
64b2609f 614#define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14\r
30fdf114
LG
615#define EFI_IFR_AND_OP 0x15\r
616#define EFI_IFR_OR_OP 0x16\r
617#define EFI_IFR_NOT_OP 0x17\r
618#define EFI_IFR_RULE_OP 0x18\r
619#define EFI_IFR_GRAY_OUT_IF_OP 0x19\r
620#define EFI_IFR_DATE_OP 0x1A\r
621#define EFI_IFR_TIME_OP 0x1B\r
622#define EFI_IFR_STRING_OP 0x1C\r
623#define EFI_IFR_REFRESH_OP 0x1D\r
624#define EFI_IFR_DISABLE_IF_OP 0x1E\r
625#define EFI_IFR_TO_LOWER_OP 0x20\r
626#define EFI_IFR_TO_UPPER_OP 0x21\r
52302d4d 627#define EFI_IFR_MAP_OP 0x22\r
30fdf114
LG
628#define EFI_IFR_ORDERED_LIST_OP 0x23\r
629#define EFI_IFR_VARSTORE_OP 0x24\r
630#define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25\r
631#define EFI_IFR_VARSTORE_EFI_OP 0x26\r
632#define EFI_IFR_VARSTORE_DEVICE_OP 0x27\r
633#define EFI_IFR_VERSION_OP 0x28\r
634#define EFI_IFR_END_OP 0x29\r
635#define EFI_IFR_MATCH_OP 0x2A\r
52302d4d
LG
636#define EFI_IFR_GET_OP 0x2B\r
637#define EFI_IFR_SET_OP 0x2C\r
638#define EFI_IFR_READ_OP 0x2D\r
639#define EFI_IFR_WRITE_OP 0x2E\r
30fdf114
LG
640#define EFI_IFR_EQUAL_OP 0x2F\r
641#define EFI_IFR_NOT_EQUAL_OP 0x30\r
642#define EFI_IFR_GREATER_THAN_OP 0x31\r
643#define EFI_IFR_GREATER_EQUAL_OP 0x32\r
644#define EFI_IFR_LESS_THAN_OP 0x33\r
645#define EFI_IFR_LESS_EQUAL_OP 0x34\r
646#define EFI_IFR_BITWISE_AND_OP 0x35\r
647#define EFI_IFR_BITWISE_OR_OP 0x36\r
648#define EFI_IFR_BITWISE_NOT_OP 0x37\r
649#define EFI_IFR_SHIFT_LEFT_OP 0x38\r
650#define EFI_IFR_SHIFT_RIGHT_OP 0x39\r
651#define EFI_IFR_ADD_OP 0x3A\r
652#define EFI_IFR_SUBTRACT_OP 0x3B\r
653#define EFI_IFR_MULTIPLY_OP 0x3C\r
654#define EFI_IFR_DIVIDE_OP 0x3D\r
655#define EFI_IFR_MODULO_OP 0x3E\r
656#define EFI_IFR_RULE_REF_OP 0x3F\r
657#define EFI_IFR_QUESTION_REF1_OP 0x40\r
658#define EFI_IFR_QUESTION_REF2_OP 0x41\r
659#define EFI_IFR_UINT8_OP 0x42\r
660#define EFI_IFR_UINT16_OP 0x43\r
661#define EFI_IFR_UINT32_OP 0x44\r
662#define EFI_IFR_UINT64_OP 0x45\r
663#define EFI_IFR_TRUE_OP 0x46\r
664#define EFI_IFR_FALSE_OP 0x47\r
665#define EFI_IFR_TO_UINT_OP 0x48\r
666#define EFI_IFR_TO_STRING_OP 0x49\r
667#define EFI_IFR_TO_BOOLEAN_OP 0x4A\r
668#define EFI_IFR_MID_OP 0x4B\r
669#define EFI_IFR_FIND_OP 0x4C\r
670#define EFI_IFR_TOKEN_OP 0x4D\r
671#define EFI_IFR_STRING_REF1_OP 0x4E\r
672#define EFI_IFR_STRING_REF2_OP 0x4F\r
673#define EFI_IFR_CONDITIONAL_OP 0x50\r
674#define EFI_IFR_QUESTION_REF3_OP 0x51\r
675#define EFI_IFR_ZERO_OP 0x52\r
676#define EFI_IFR_ONE_OP 0x53\r
677#define EFI_IFR_ONES_OP 0x54\r
678#define EFI_IFR_UNDEFINED_OP 0x55\r
679#define EFI_IFR_LENGTH_OP 0x56\r
680#define EFI_IFR_DUP_OP 0x57\r
681#define EFI_IFR_THIS_OP 0x58\r
682#define EFI_IFR_SPAN_OP 0x59\r
683#define EFI_IFR_VALUE_OP 0x5A\r
684#define EFI_IFR_DEFAULT_OP 0x5B\r
685#define EFI_IFR_DEFAULTSTORE_OP 0x5C\r
52302d4d 686#define EFI_IFR_FORM_MAP_OP 0x5D\r
30fdf114
LG
687#define EFI_IFR_CATENATE_OP 0x5E\r
688#define EFI_IFR_GUID_OP 0x5F\r
a709adfa 689#define EFI_IFR_SECURITY_OP 0x60\r
4234283c
LG
690#define EFI_IFR_MODAL_TAG_OP 0x61\r
691#define EFI_IFR_REFRESH_ID_OP 0x62\r
ea0f6464 692#define EFI_IFR_WARNING_IF_OP 0x63\r
5d377616 693#define EFI_IFR_MATCH2_OP 0x64\r
30fdf114
LG
694\r
695\r
696typedef struct _EFI_IFR_OP_HEADER {\r
697 UINT8 OpCode;\r
698 UINT8 Length:7;\r
699 UINT8 Scope:1;\r
700} EFI_IFR_OP_HEADER;\r
701\r
702typedef struct _EFI_IFR_STATEMENT_HEADER {\r
703 EFI_STRING_ID Prompt;\r
704 EFI_STRING_ID Help;\r
705} EFI_IFR_STATEMENT_HEADER;\r
706\r
707typedef struct _EFI_IFR_QUESTION_HEADER {\r
708 EFI_IFR_STATEMENT_HEADER Header;\r
709 EFI_QUESTION_ID QuestionId;\r
710 EFI_VARSTORE_ID VarStoreId;\r
711 union {\r
712 EFI_STRING_ID VarName;\r
713 UINT16 VarOffset;\r
714 } VarStoreInfo;\r
715 UINT8 Flags;\r
716} EFI_IFR_QUESTION_HEADER;\r
717\r
366430c7
ED
718#define EFI_IFR_FLAG_READ_ONLY 0x01\r
719#define EFI_IFR_FLAG_CALLBACK 0x04\r
720#define EFI_IFR_FLAG_RESET_REQUIRED 0x10\r
721#define EFI_IFR_FLAG_RECONNECT_REQUIRED 0x40\r
722#define EFI_IFR_FLAG_OPTIONS_ONLY 0x80\r
30fdf114
LG
723\r
724typedef struct _EFI_IFR_DEFAULTSTORE {\r
725 EFI_IFR_OP_HEADER Header;\r
726 EFI_STRING_ID DefaultName;\r
727 UINT16 DefaultId;\r
728} EFI_IFR_DEFAULTSTORE;\r
729\r
730#define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000\r
731#define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001\r
732#define EFI_HII_DEFAULT_CLASS_SAFE 0x0002\r
733#define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000\r
734#define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff\r
735#define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000\r
736#define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff\r
737#define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000\r
738#define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff\r
739\r
740typedef struct _EFI_IFR_VARSTORE {\r
741 EFI_IFR_OP_HEADER Header;\r
742 EFI_GUID Guid;\r
743 EFI_VARSTORE_ID VarStoreId;\r
744 UINT16 Size;\r
745 UINT8 Name[1];\r
746} EFI_IFR_VARSTORE;\r
747\r
748typedef struct _EFI_IFR_VARSTORE_EFI {\r
749 EFI_IFR_OP_HEADER Header;\r
52302d4d 750 EFI_VARSTORE_ID VarStoreId;\r
30fdf114
LG
751 EFI_GUID Guid;\r
752 UINT32 Attributes;\r
4234283c
LG
753 UINT16 Size;\r
754 UINT8 Name[1];\r
30fdf114
LG
755} EFI_IFR_VARSTORE_EFI;\r
756\r
757typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {\r
758 EFI_IFR_OP_HEADER Header;\r
52302d4d 759 EFI_VARSTORE_ID VarStoreId;\r
30fdf114
LG
760 EFI_GUID Guid;\r
761} EFI_IFR_VARSTORE_NAME_VALUE;\r
762\r
763typedef struct _EFI_IFR_FORM_SET {\r
764 EFI_IFR_OP_HEADER Header;\r
765 EFI_GUID Guid;\r
766 EFI_STRING_ID FormSetTitle;\r
767 EFI_STRING_ID Help;\r
768 UINT8 Flags;\r
52302d4d 769 // EFI_GUID ClassGuid[];\r
30fdf114
LG
770} EFI_IFR_FORM_SET;\r
771\r
772typedef struct _EFI_IFR_END {\r
773 EFI_IFR_OP_HEADER Header;\r
774} EFI_IFR_END;\r
775\r
776typedef struct _EFI_IFR_FORM {\r
777 EFI_IFR_OP_HEADER Header;\r
778 UINT16 FormId;\r
779 EFI_STRING_ID FormTitle;\r
780} EFI_IFR_FORM;\r
781\r
782typedef struct _EFI_IFR_IMAGE {\r
783 EFI_IFR_OP_HEADER Header;\r
784 EFI_IMAGE_ID Id;\r
785} EFI_IFR_IMAGE;\r
786\r
4afd3d04 787typedef struct _EFI_IFR_MODAL_TAG {\r
4234283c 788 EFI_IFR_OP_HEADER Header;\r
4afd3d04 789} EFI_IFR_MODAL_TAG;\r
4234283c 790\r
30fdf114
LG
791typedef struct _EFI_IFR_LOCKED {\r
792 EFI_IFR_OP_HEADER Header;\r
793} EFI_IFR_LOCKED;\r
794\r
795typedef struct _EFI_IFR_RULE {\r
796 EFI_IFR_OP_HEADER Header;\r
797 UINT8 RuleId;\r
798} EFI_IFR_RULE;\r
799\r
800typedef struct _EFI_IFR_DEFAULT {\r
801 EFI_IFR_OP_HEADER Header;\r
802 UINT16 DefaultId;\r
803 UINT8 Type;\r
804 EFI_IFR_TYPE_VALUE Value;\r
805} EFI_IFR_DEFAULT;\r
4afd3d04
LG
806\r
807typedef struct _EFI_IFR_DEFAULT_2 {\r
808 EFI_IFR_OP_HEADER Header;\r
809 UINT16 DefaultId;\r
810 UINT8 Type;\r
811} EFI_IFR_DEFAULT_2;\r
30fdf114
LG
812\r
813typedef struct _EFI_IFR_VALUE {\r
814 EFI_IFR_OP_HEADER Header;\r
815} EFI_IFR_VALUE;\r
816\r
817typedef struct _EFI_IFR_SUBTITLE {\r
818 EFI_IFR_OP_HEADER Header;\r
819 EFI_IFR_STATEMENT_HEADER Statement;\r
820 UINT8 Flags;\r
821} EFI_IFR_SUBTITLE;\r
822\r
823#define EFI_IFR_FLAGS_HORIZONTAL 0x01\r
824\r
825typedef struct _EFI_IFR_CHECKBOX {\r
826 EFI_IFR_OP_HEADER Header;\r
827 EFI_IFR_QUESTION_HEADER Question;\r
828 UINT8 Flags;\r
829} EFI_IFR_CHECKBOX;\r
830\r
831#define EFI_IFR_CHECKBOX_DEFAULT 0x01\r
832#define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02\r
833\r
834typedef struct _EFI_IFR_TEXT {\r
835 EFI_IFR_OP_HEADER Header;\r
836 EFI_IFR_STATEMENT_HEADER Statement;\r
837 EFI_STRING_ID TextTwo;\r
838} EFI_IFR_TEXT;\r
839\r
840typedef struct _EFI_IFR_REF {\r
841 EFI_IFR_OP_HEADER Header;\r
842 EFI_IFR_QUESTION_HEADER Question;\r
843 EFI_FORM_ID FormId;\r
844} EFI_IFR_REF;\r
845\r
846typedef struct _EFI_IFR_REF2 {\r
847 EFI_IFR_OP_HEADER Header;\r
848 EFI_IFR_QUESTION_HEADER Question;\r
849 EFI_FORM_ID FormId;\r
850 EFI_QUESTION_ID QuestionId;\r
851} EFI_IFR_REF2;\r
852\r
853typedef struct _EFI_IFR_REF3 {\r
854 EFI_IFR_OP_HEADER Header;\r
855 EFI_IFR_QUESTION_HEADER Question;\r
856 EFI_FORM_ID FormId;\r
857 EFI_QUESTION_ID QuestionId;\r
858 EFI_GUID FormSetId;\r
859} EFI_IFR_REF3;\r
860\r
861typedef struct _EFI_IFR_REF4 {\r
862 EFI_IFR_OP_HEADER Header;\r
863 EFI_IFR_QUESTION_HEADER Question;\r
864 EFI_FORM_ID FormId;\r
865 EFI_QUESTION_ID QuestionId;\r
866 EFI_GUID FormSetId;\r
867 EFI_STRING_ID DevicePath;\r
868} EFI_IFR_REF4;\r
869\r
4234283c
LG
870typedef struct _EFI_IFR_REF5 {\r
871 EFI_IFR_OP_HEADER Header;\r
872 EFI_IFR_QUESTION_HEADER Question;\r
873} EFI_IFR_REF5;\r
874\r
30fdf114
LG
875typedef struct _EFI_IFR_RESET_BUTTON {\r
876 EFI_IFR_OP_HEADER Header;\r
fd171542 877 EFI_IFR_STATEMENT_HEADER Statement;\r
30fdf114
LG
878 EFI_DEFAULT_ID DefaultId;\r
879} EFI_IFR_RESET_BUTTON;\r
880\r
881typedef struct _EFI_IFR_ACTION {\r
882 EFI_IFR_OP_HEADER Header;\r
883 EFI_IFR_QUESTION_HEADER Question;\r
884 EFI_STRING_ID QuestionConfig;\r
885} EFI_IFR_ACTION;\r
886\r
887typedef struct _EFI_IFR_ACTION_1 {\r
888 EFI_IFR_OP_HEADER Header;\r
889 EFI_IFR_QUESTION_HEADER Question;\r
890} EFI_IFR_ACTION_1;\r
891\r
892typedef struct _EFI_IFR_DATE {\r
893 EFI_IFR_OP_HEADER Header;\r
894 EFI_IFR_QUESTION_HEADER Question;\r
895 UINT8 Flags;\r
896} EFI_IFR_DATE;\r
897\r
898#define EFI_QF_DATE_YEAR_SUPPRESS 0x01\r
899#define EFI_QF_DATE_MONTH_SUPPRESS 0x02\r
900#define EFI_QF_DATE_DAY_SUPPRESS 0x04\r
901\r
902#define EFI_QF_DATE_STORAGE 0x30\r
903#define QF_DATE_STORAGE_NORMAL 0x00\r
904#define QF_DATE_STORAGE_TIME 0x10\r
905#define QF_DATE_STORAGE_WAKEUP 0x20\r
906\r
907typedef union {\r
908 struct {\r
909 UINT8 MinValue;\r
910 UINT8 MaxValue;\r
911 UINT8 Step;\r
912 } u8;\r
913 struct {\r
914 UINT16 MinValue;\r
915 UINT16 MaxValue;\r
916 UINT16 Step;\r
917 } u16;\r
918 struct {\r
919 UINT32 MinValue;\r
920 UINT32 MaxValue;\r
921 UINT32 Step;\r
922 } u32;\r
923 struct {\r
924 UINT64 MinValue;\r
925 UINT64 MaxValue;\r
926 UINT64 Step;\r
927 } u64;\r
928} MINMAXSTEP_DATA;\r
929\r
930typedef struct _EFI_IFR_NUMERIC {\r
931 EFI_IFR_OP_HEADER Header;\r
932 EFI_IFR_QUESTION_HEADER Question;\r
933 UINT8 Flags;\r
934 MINMAXSTEP_DATA data;\r
935} EFI_IFR_NUMERIC;\r
936\r
937#define EFI_IFR_NUMERIC_SIZE 0x03\r
938#define EFI_IFR_NUMERIC_SIZE_1 0x00\r
939#define EFI_IFR_NUMERIC_SIZE_2 0x01\r
940#define EFI_IFR_NUMERIC_SIZE_4 0x02\r
941#define EFI_IFR_NUMERIC_SIZE_8 0x03\r
942\r
943#define EFI_IFR_DISPLAY 0x30\r
944#define EFI_IFR_DISPLAY_INT_DEC 0x00\r
945#define EFI_IFR_DISPLAY_UINT_DEC 0x10\r
946#define EFI_IFR_DISPLAY_UINT_HEX 0x20\r
947\r
948typedef struct _EFI_IFR_ONE_OF {\r
949 EFI_IFR_OP_HEADER Header;\r
950 EFI_IFR_QUESTION_HEADER Question;\r
951 UINT8 Flags;\r
952 MINMAXSTEP_DATA data;\r
953} EFI_IFR_ONE_OF;\r
954\r
955typedef struct _EFI_IFR_STRING {\r
956 EFI_IFR_OP_HEADER Header;\r
957 EFI_IFR_QUESTION_HEADER Question;\r
958 UINT8 MinSize;\r
959 UINT8 MaxSize;\r
960 UINT8 Flags;\r
961} EFI_IFR_STRING;\r
962\r
963#define EFI_IFR_STRING_MULTI_LINE 0x01\r
964\r
965typedef struct _EFI_IFR_PASSWORD {\r
966 EFI_IFR_OP_HEADER Header;\r
967 EFI_IFR_QUESTION_HEADER Question;\r
968 UINT16 MinSize;\r
969 UINT16 MaxSize;\r
970} EFI_IFR_PASSWORD;\r
971\r
972typedef struct _EFI_IFR_ORDERED_LIST {\r
973 EFI_IFR_OP_HEADER Header;\r
974 EFI_IFR_QUESTION_HEADER Question;\r
975 UINT8 MaxContainers;\r
976 UINT8 Flags;\r
977} EFI_IFR_ORDERED_LIST;\r
978\r
979#define EFI_IFR_UNIQUE_SET 0x01\r
980#define EFI_IFR_NO_EMPTY_SET 0x02\r
981\r
982typedef struct _EFI_IFR_TIME {\r
983 EFI_IFR_OP_HEADER Header;\r
984 EFI_IFR_QUESTION_HEADER Question;\r
985 UINT8 Flags;\r
986} EFI_IFR_TIME;\r
987\r
988#define QF_TIME_HOUR_SUPPRESS 0x01\r
989#define QF_TIME_MINUTE_SUPPRESS 0x02\r
990#define QF_TIME_SECOND_SUPPRESS 0x04\r
991\r
992#define QF_TIME_STORAGE 0x30\r
993#define QF_TIME_STORAGE_NORMAL 0x00\r
994#define QF_TIME_STORAGE_TIME 0x10\r
995#define QF_TIME_STORAGE_WAKEUP 0x20\r
996\r
997typedef struct _EFI_IFR_DISABLE_IF {\r
998 EFI_IFR_OP_HEADER Header;\r
999} EFI_IFR_DISABLE_IF;\r
1000\r
1001typedef struct _EFI_IFR_SUPPRESS_IF {\r
1002 EFI_IFR_OP_HEADER Header;\r
1003} EFI_IFR_SUPPRESS_IF;\r
1004\r
1005typedef struct _EFI_IFR_GRAY_OUT_IF {\r
1006 EFI_IFR_OP_HEADER Header;\r
1007} EFI_IFR_GRAY_OUT_IF;\r
1008\r
1009typedef struct _EFI_IFR_INCONSISTENT_IF {\r
1010 EFI_IFR_OP_HEADER Header;\r
1011 EFI_STRING_ID Error;\r
1012} EFI_IFR_INCONSISTENT_IF;\r
1013\r
1014typedef struct _EFI_IFR_NO_SUBMIT_IF {\r
1015 EFI_IFR_OP_HEADER Header;\r
1016 EFI_STRING_ID Error;\r
1017} EFI_IFR_NO_SUBMIT_IF;\r
1018\r
ea0f6464
LG
1019typedef struct _EFI_IFR_WARNING_IF {\r
1020 EFI_IFR_OP_HEADER Header;\r
1021 EFI_STRING_ID Warning;\r
1022 UINT8 TimeOut;\r
1023} EFI_IFR_WARNING_IF;\r
1024\r
30fdf114
LG
1025typedef struct _EFI_IFR_REFRESH {\r
1026 EFI_IFR_OP_HEADER Header;\r
1027 UINT8 RefreshInterval;\r
1028} EFI_IFR_REFRESH;\r
1029\r
4234283c
LG
1030typedef struct _EFI_IFR_REFRESH_ID {\r
1031 EFI_IFR_OP_HEADER Header;\r
1032 EFI_GUID RefreshEventGroupId;\r
1033} EFI_IFR_REFRESH_ID;\r
1034\r
30fdf114
LG
1035typedef struct _EFI_IFR_VARSTORE_DEVICE {\r
1036 EFI_IFR_OP_HEADER Header;\r
1037 EFI_STRING_ID DevicePath;\r
1038} EFI_IFR_VARSTORE_DEVICE;\r
1039\r
1040typedef struct _EFI_IFR_ONE_OF_OPTION {\r
1041 EFI_IFR_OP_HEADER Header;\r
1042 EFI_STRING_ID Option;\r
1043 UINT8 Flags;\r
1044 UINT8 Type;\r
1045 EFI_IFR_TYPE_VALUE Value;\r
1046} EFI_IFR_ONE_OF_OPTION;\r
1047\r
1048#define EFI_IFR_TYPE_NUM_SIZE_8 0x00\r
1049#define EFI_IFR_TYPE_NUM_SIZE_16 0x01\r
1050#define EFI_IFR_TYPE_NUM_SIZE_32 0x02\r
1051#define EFI_IFR_TYPE_NUM_SIZE_64 0x03\r
1052#define EFI_IFR_TYPE_BOOLEAN 0x04\r
1053#define EFI_IFR_TYPE_TIME 0x05\r
1054#define EFI_IFR_TYPE_DATE 0x06\r
1055#define EFI_IFR_TYPE_STRING 0x07\r
1056#define EFI_IFR_TYPE_OTHER 0x08\r
52302d4d
LG
1057#define EFI_IFR_TYPE_UNDEFINED 0x09\r
1058#define EFI_IFR_TYPE_ACTION 0x0A\r
1059#define EFI_IFR_TYPE_BUFFER 0x0B\r
4234283c 1060#define EFI_IFR_TYPE_REF 0x0C\r
30fdf114
LG
1061\r
1062#define EFI_IFR_OPTION_DEFAULT 0x10\r
1063#define EFI_IFR_OPTION_DEFAULT_MFG 0x20\r
1064\r
1065typedef struct _EFI_IFR_GUID {\r
1066 EFI_IFR_OP_HEADER Header;\r
1067 EFI_GUID Guid;\r
1068 //Optional Data Follows\r
1069} EFI_IFR_GUID;\r
1070\r
1071typedef struct _EFI_IFR_DUP {\r
1072 EFI_IFR_OP_HEADER Header;\r
1073} EFI_IFR_DUP;\r
1074\r
1075typedef struct _EFI_IFR_EQ_ID_ID {\r
1076 EFI_IFR_OP_HEADER Header;\r
1077 EFI_QUESTION_ID QuestionId1;\r
1078 EFI_QUESTION_ID QuestionId2;\r
1079} EFI_IFR_EQ_ID_ID;\r
1080\r
1081typedef struct _EFI_IFR_EQ_ID_VAL {\r
1082 EFI_IFR_OP_HEADER Header;\r
1083 EFI_QUESTION_ID QuestionId;\r
1084 UINT16 Value;\r
1085} EFI_IFR_EQ_ID_VAL;\r
1086\r
b303ea72 1087typedef struct _EFI_IFR_EQ_ID_VAL_LIST {\r
30fdf114
LG
1088 EFI_IFR_OP_HEADER Header;\r
1089 EFI_QUESTION_ID QuestionId;\r
1090 UINT16 ListLength;\r
1091 UINT16 ValueList[1];\r
b303ea72 1092} EFI_IFR_EQ_ID_VAL_LIST;\r
30fdf114
LG
1093\r
1094typedef struct _EFI_IFR_QUESTION_REF1 {\r
1095 EFI_IFR_OP_HEADER Header;\r
1096 EFI_QUESTION_ID QuestionId;\r
1097} EFI_IFR_QUESTION_REF1;\r
1098\r
1099typedef struct _EFI_IFR_UINT8 {\r
1100 EFI_IFR_OP_HEADER Header;\r
1101 UINT8 Value;\r
1102} EFI_IFR_UINT8;\r
1103\r
1104typedef struct _EFI_IFR_UINT16 {\r
1105 EFI_IFR_OP_HEADER Header;\r
1106 UINT16 Value;\r
1107} EFI_IFR_UINT16;\r
1108\r
1109typedef struct _EFI_IFR_QUESTION_REF2 {\r
1110 EFI_IFR_OP_HEADER Header;\r
1111} EFI_IFR_QUESTION_REF2;\r
1112\r
1113typedef struct _EFI_IFR_UINT32 {\r
1114 EFI_IFR_OP_HEADER Header;\r
1115 UINT32 Value;\r
1116} EFI_IFR_UINT32;\r
1117\r
1118typedef struct _EFI_IFR_UINT64 {\r
1119 EFI_IFR_OP_HEADER Header;\r
1120 UINT64 Value;\r
1121} EFI_IFR_UINT64;\r
1122\r
1123typedef struct _EFI_IFR_QUESTION_REF3 {\r
1124 EFI_IFR_OP_HEADER Header;\r
1125} EFI_IFR_QUESTION_REF3;\r
1126\r
1127typedef struct _EFI_IFR_QUESTION_REF3_2 {\r
1128 EFI_IFR_OP_HEADER Header;\r
1129 EFI_STRING_ID DevicePath;\r
1130} EFI_IFR_QUESTION_REF3_2;\r
1131\r
1132typedef struct _EFI_IFR_QUESTION_REF3_3 {\r
1133 EFI_IFR_OP_HEADER Header;\r
1134 EFI_STRING_ID DevicePath;\r
1135 EFI_GUID Guid;\r
1136} EFI_IFR_QUESTION_REF3_3;\r
1137\r
1138typedef struct _EFI_IFR_RULE_REF {\r
1139 EFI_IFR_OP_HEADER Header;\r
1140 UINT8 RuleId;\r
1141} EFI_IFR_RULE_REF;\r
1142\r
1143typedef struct _EFI_IFR_STRING_REF1 {\r
1144 EFI_IFR_OP_HEADER Header;\r
1145 EFI_STRING_ID StringId;\r
1146} EFI_IFR_STRING_REF1;\r
1147\r
1148typedef struct _EFI_IFR_STRING_REF2 {\r
1149 EFI_IFR_OP_HEADER Header;\r
1150} EFI_IFR_STRING_REF2;\r
1151\r
1152typedef struct _EFI_IFR_THIS {\r
1153 EFI_IFR_OP_HEADER Header;\r
1154} EFI_IFR_THIS;\r
1155\r
1156typedef struct _EFI_IFR_TRUE {\r
1157 EFI_IFR_OP_HEADER Header;\r
1158} EFI_IFR_TRUE;\r
1159\r
1160typedef struct _EFI_IFR_FALSE {\r
1161 EFI_IFR_OP_HEADER Header;\r
1162} EFI_IFR_FALSE;\r
1163\r
1164typedef struct _EFI_IFR_ONE {\r
1165 EFI_IFR_OP_HEADER Header;\r
1166} EFI_IFR_ONE;\r
1167\r
1168typedef struct _EFI_IFR_ONES {\r
1169 EFI_IFR_OP_HEADER Header;\r
1170} EFI_IFR_ONES;\r
1171\r
1172typedef struct _EFI_IFR_ZERO {\r
1173 EFI_IFR_OP_HEADER Header;\r
1174} EFI_IFR_ZERO;\r
1175\r
1176typedef struct _EFI_IFR_UNDEFINED {\r
1177 EFI_IFR_OP_HEADER Header;\r
1178} EFI_IFR_UNDEFINED;\r
1179\r
1180typedef struct _EFI_IFR_VERSION {\r
1181 EFI_IFR_OP_HEADER Header;\r
1182} EFI_IFR_VERSION;\r
1183\r
1184typedef struct _EFI_IFR_LENGTH {\r
1185 EFI_IFR_OP_HEADER Header;\r
1186} EFI_IFR_LENGTH;\r
1187\r
1188typedef struct _EFI_IFR_NOT {\r
1189 EFI_IFR_OP_HEADER Header;\r
1190} EFI_IFR_NOT;\r
1191\r
1192typedef struct _EFI_IFR_BITWISE_NOT {\r
1193 EFI_IFR_OP_HEADER Header;\r
1194} EFI_IFR_BITWISE_NOT;\r
1195\r
1196typedef struct _EFI_IFR_TO_BOOLEAN {\r
1197 EFI_IFR_OP_HEADER Header;\r
1198} EFI_IFR_TO_BOOLEAN;\r
1199\r
1200#define EFI_IFR_STRING_UNSIGNED_DEC 0\r
1201#define EFI_IFR_STRING_SIGNED_DEC 1\r
1202#define EFI_IFR_STRING_LOWERCASE_HEX 2\r
1203#define EFI_IFR_STRING_UPPERCASE_HEX 3\r
1204\r
1205#define EFI_IFR_STRING_ASCII 0\r
1206#define EFI_IFR_STRING_UNICODE 8\r
1207\r
1208typedef struct _EFI_IFR_TO_STRING {\r
1209 EFI_IFR_OP_HEADER Header;\r
1210 UINT8 Format;\r
1211} EFI_IFR_TO_STRING;\r
1212\r
1213typedef struct _EFI_IFR_TO_UINT {\r
1214 EFI_IFR_OP_HEADER Header;\r
1215} EFI_IFR_TO_UINT;\r
1216\r
1217typedef struct _EFI_IFR_TO_UPPER {\r
1218 EFI_IFR_OP_HEADER Header;\r
1219} EFI_IFR_TO_UPPER;\r
1220\r
1221typedef struct _EFI_IFR_TO_LOWER {\r
1222 EFI_IFR_OP_HEADER Header;\r
1223} EFI_IFR_TO_LOWER;\r
1224\r
1225typedef struct _EFI_IFR_ADD {\r
1226 EFI_IFR_OP_HEADER Header;\r
1227} EFI_IFR_ADD;\r
1228\r
1229typedef struct _EFI_IFR_AND {\r
1230 EFI_IFR_OP_HEADER Header;\r
1231} EFI_IFR_AND;\r
1232\r
1233typedef struct _EFI_IFR_BITWISE_AND {\r
1234 EFI_IFR_OP_HEADER Header;\r
1235} EFI_IFR_BITWISE_AND;\r
1236\r
1237typedef struct _EFI_IFR_BITWISE_OR {\r
1238 EFI_IFR_OP_HEADER Header;\r
1239} EFI_IFR_BITWISE_OR;\r
1240\r
1241typedef struct _EFI_IFR_CATENATE {\r
1242 EFI_IFR_OP_HEADER Header;\r
1243} EFI_IFR_CATENATE;\r
1244\r
1245typedef struct _EFI_IFR_DIVIDE {\r
1246 EFI_IFR_OP_HEADER Header;\r
1247} EFI_IFR_DIVIDE;\r
1248\r
1249typedef struct _EFI_IFR_EQUAL {\r
1250 EFI_IFR_OP_HEADER Header;\r
1251} EFI_IFR_EQUAL;\r
1252\r
1253typedef struct _EFI_IFR_GREATER_EQUAL {\r
1254 EFI_IFR_OP_HEADER Header;\r
1255} EFI_IFR_GREATER_EQUAL;\r
1256\r
1257typedef struct _EFI_IFR_GREATER_THAN {\r
1258 EFI_IFR_OP_HEADER Header;\r
1259} EFI_IFR_GREATER_THAN;\r
1260\r
1261typedef struct _EFI_IFR_LESS_EQUAL {\r
1262 EFI_IFR_OP_HEADER Header;\r
1263} EFI_IFR_LESS_EQUAL;\r
1264\r
1265typedef struct _EFI_IFR_LESS_THAN {\r
1266 EFI_IFR_OP_HEADER Header;\r
1267} EFI_IFR_LESS_THAN;\r
1268\r
1269typedef struct _EFI_IFR_MATCH {\r
1270 EFI_IFR_OP_HEADER Header;\r
1271} EFI_IFR_MATCH;\r
1272\r
5d377616
ED
1273typedef struct _EFI_IFR_MATCH2 {\r
1274 EFI_IFR_OP_HEADER Header;\r
1275 EFI_GUID SyntaxType;\r
1276} EFI_IFR_MATCH2;\r
1277\r
30fdf114
LG
1278typedef struct _EFI_IFR_MULTIPLY {\r
1279 EFI_IFR_OP_HEADER Header;\r
1280} EFI_IFR_MULTIPLY;\r
1281\r
1282typedef struct _EFI_IFR_MODULO {\r
1283 EFI_IFR_OP_HEADER Header;\r
1284} EFI_IFR_MODULO;\r
1285\r
1286typedef struct _EFI_IFR_NOT_EQUAL {\r
1287 EFI_IFR_OP_HEADER Header;\r
1288} EFI_IFR_NOT_EQUAL;\r
1289\r
1290typedef struct _EFI_IFR_OR {\r
1291 EFI_IFR_OP_HEADER Header;\r
1292} EFI_IFR_OR;\r
1293\r
1294typedef struct _EFI_IFR_SHIFT_LEFT {\r
1295 EFI_IFR_OP_HEADER Header;\r
1296} EFI_IFR_SHIFT_LEFT;\r
1297\r
1298typedef struct _EFI_IFR_SHIFT_RIGHT {\r
1299 EFI_IFR_OP_HEADER Header;\r
1300} EFI_IFR_SHIFT_RIGHT;\r
1301\r
1302typedef struct _EFI_IFR_SUBTRACT {\r
1303 EFI_IFR_OP_HEADER Header;\r
1304} EFI_IFR_SUBTRACT;\r
1305\r
1306typedef struct _EFI_IFR_CONDITIONAL {\r
1307 EFI_IFR_OP_HEADER Header;\r
1308} EFI_IFR_CONDITIONAL;\r
1309\r
1310#define EFI_IFR_FF_CASE_SENSITIVE 0x00\r
1311#define EFI_IFR_FF_CASE_INSENSITIVE 0x01\r
1312\r
1313typedef struct _EFI_IFR_FIND {\r
1314 EFI_IFR_OP_HEADER Header;\r
1315 UINT8 Format;\r
1316} EFI_IFR_FIND;\r
1317\r
1318typedef struct _EFI_IFR_MID {\r
1319 EFI_IFR_OP_HEADER Header;\r
1320} EFI_IFR_MID;\r
1321\r
1322typedef struct _EFI_IFR_TOKEN {\r
1323 EFI_IFR_OP_HEADER Header;\r
1324} EFI_IFR_TOKEN;\r
1325\r
1326#define EFI_IFR_FLAGS_FIRST_MATCHING 0x00\r
1327#define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01\r
1328\r
1329typedef struct _EFI_IFR_SPAN {\r
1330 EFI_IFR_OP_HEADER Header;\r
1331 UINT8 Flags;\r
1332} EFI_IFR_SPAN;\r
1333\r
a709adfa
LG
1334typedef struct _EFI_IFR_SECURITY {\r
1335 ///\r
1336 /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.\r
1337 ///\r
1338 EFI_IFR_OP_HEADER Header;\r
1339 ///\r
1340 /// Security permission level.\r
1341 ///\r
1342 EFI_GUID Permissions;\r
1343} EFI_IFR_SECURITY;\r
1344\r
52302d4d
LG
1345typedef struct _EFI_IFR_FORM_MAP_METHOD {\r
1346 ///\r
1347 /// The string identifier which provides the human-readable name of \r
1348 /// the configuration method for this standards map form.\r
1349 ///\r
1350 EFI_STRING_ID MethodTitle;\r
1351 ///\r
1352 /// Identifier which uniquely specifies the configuration methods \r
1353 /// associated with this standards map form.\r
1354 ///\r
1355 EFI_GUID MethodIdentifier;\r
1356} EFI_IFR_FORM_MAP_METHOD;\r
1357\r
1358typedef struct _EFI_IFR_FORM_MAP {\r
1359 ///\r
1360 /// The sequence that defines the type of opcode as well as the length \r
1361 /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP. \r
1362 ///\r
1363 EFI_IFR_OP_HEADER Header;\r
1364 ///\r
1365 /// The unique identifier for this particular form.\r
1366 ///\r
1367 EFI_FORM_ID FormId;\r
1368 ///\r
1369 /// One or more configuration method's name and unique identifier.\r
1370 ///\r
1371 // EFI_IFR_FORM_MAP_METHOD Methods[];\r
1372} EFI_IFR_FORM_MAP;\r
1373\r
1374typedef struct _EFI_IFR_SET {\r
1375 ///\r
1376 /// The sequence that defines the type of opcode as well as the length \r
1377 /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP. \r
1378 ///\r
1379 EFI_IFR_OP_HEADER Header;\r
1380 ///\r
1381 /// Specifies the identifier of a previously declared variable store to \r
1382 /// use when storing the question's value. \r
1383 ///\r
1384 EFI_VARSTORE_ID VarStoreId;\r
1385 union {\r
1386 ///\r
1387 /// A 16-bit Buffer Storage offset.\r
1388 ///\r
1389 EFI_STRING_ID VarName;\r
1390 ///\r
1391 /// A Name Value or EFI Variable name (VarName).\r
1392 ///\r
1393 UINT16 VarOffset;\r
1394 } VarStoreInfo;\r
1395 ///\r
1396 /// Specifies the type used for storage. \r
1397 ///\r
1398 UINT8 VarStoreType;\r
1399} EFI_IFR_SET;\r
1400\r
1401typedef struct _EFI_IFR_GET {\r
1402 ///\r
1403 /// The sequence that defines the type of opcode as well as the length \r
1404 /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP. \r
1405 ///\r
1406 EFI_IFR_OP_HEADER Header;\r
1407 ///\r
1408 /// Specifies the identifier of a previously declared variable store to \r
1409 /// use when retrieving the value. \r
1410 ///\r
1411 EFI_VARSTORE_ID VarStoreId;\r
1412 union {\r
1413 ///\r
1414 /// A 16-bit Buffer Storage offset.\r
1415 ///\r
1416 EFI_STRING_ID VarName;\r
1417 ///\r
1418 /// A Name Value or EFI Variable name (VarName).\r
1419 ///\r
1420 UINT16 VarOffset;\r
1421 } VarStoreInfo;\r
1422 ///\r
1423 /// Specifies the type used for storage. \r
1424 ///\r
1425 UINT8 VarStoreType;\r
1426} EFI_IFR_GET;\r
1427\r
1428typedef struct _EFI_IFR_READ {\r
1429 EFI_IFR_OP_HEADER Header;\r
1430} EFI_IFR_READ;\r
1431\r
1432typedef struct _EFI_IFR_WRITE {\r
1433 EFI_IFR_OP_HEADER Header;\r
1434} EFI_IFR_WRITE;\r
1435\r
1436typedef struct _EFI_IFR_MAP {\r
1437 EFI_IFR_OP_HEADER Header;\r
1438} EFI_IFR_MAP;\r
30fdf114
LG
1439//\r
1440// Keyboard Package\r
1441//\r
1442\r
1443typedef enum { \r
1444 EfiKeyLCtrl,\r
1445 EfiKeyA0, \r
1446 EfiKeyLAlt,\r
1447 EfiKeySpaceBar,\r
1448 EfiKeyA2,\r
1449 EfiKeyA3,\r
1450 EfiKeyA4,\r
1451 EfiKeyRCtrl,\r
1452 EfiKeyLeftArrow,\r
1453 EfiKeyDownArrow,\r
1454 EfiKeyRightArrow,\r
1455 EfiKeyZero,\r
1456 EfiKeyPeriod,\r
1457 EfiKeyEnter,\r
1458 EfiKeyLShift,\r
1459 EfiKeyB0,\r
1460 EfiKeyB1,\r
1461 EfiKeyB2,\r
1462 EfiKeyB3,\r
1463 EfiKeyB4,\r
1464 EfiKeyB5,\r
1465 EfiKeyB6,\r
1466 EfiKeyB7,\r
1467 EfiKeyB8,\r
1468 EfiKeyB9,\r
1469 EfiKeyB10,\r
1470 EfiKeyRshift,\r
1471 EfiKeyUpArrow,\r
1472 EfiKeyOne,\r
1473 EfiKeyTwo,\r
1474 EfiKeyThree,\r
1475 EfiKeyCapsLock,\r
1476 EfiKeyC1,\r
1477 EfiKeyC2,\r
1478 EfiKeyC3,\r
1479 EfiKeyC4,\r
1480 EfiKeyC5,\r
1481 EfiKeyC6,\r
1482 EfiKeyC7,\r
1483 EfiKeyC8,\r
1484 EfiKeyC9,\r
1485 EfiKeyC10,\r
1486 EfiKeyC11,\r
1487 EfiKeyC12,\r
1488 EfiKeyFour,\r
1489 EfiKeyFive,\r
1490 EfiKeySix,\r
1491 EfiKeyPlus,\r
1492 EfiKeyTab,\r
1493 EfiKeyD1,\r
1494 EfiKeyD2,\r
1495 EfiKeyD3,\r
1496 EfiKeyD4,\r
1497 EfiKeyD5,\r
1498 EfiKeyD6,\r
1499 EfiKeyD7,\r
1500 EfiKeyD8,\r
1501 EfiKeyD9,\r
1502 EfiKeyD10,\r
1503 EfiKeyD11,\r
1504 EfiKeyD12,\r
1505 EfiKeyD13,\r
1506 EfiKeyDel,\r
1507 EfiKeyEnd,\r
1508 EfiKeyPgDn,\r
1509 EfiKeySeven,\r
1510 EfiKeyEight,\r
1511 EfiKeyNine,\r
1512 EfiKeyE0,\r
1513 EfiKeyE1,\r
1514 EfiKeyE2,\r
1515 EfiKeyE3,\r
1516 EfiKeyE4,\r
1517 EfiKeyE5,\r
1518 EfiKeyE6,\r
1519 EfiKeyE7,\r
1520 EfiKeyE8,\r
1521 EfiKeyE9,\r
1522 EfiKeyE10,\r
1523 EfiKeyE11,\r
1524 EfiKeyE12,\r
1525 EfiKeyBackSpace,\r
1526 EfiKeyIns,\r
1527 EfiKeyHome,\r
1528 EfiKeyPgUp,\r
1529 EfiKeyNLck,\r
1530 EfiKeySlash,\r
1531 EfiKeyAsterisk,\r
1532 EfiKeyMinus,\r
1533 EfiKeyEsc,\r
1534 EfiKeyF1,\r
1535 EfiKeyF2,\r
1536 EfiKeyF3,\r
1537 EfiKeyF4,\r
1538 EfiKeyF5,\r
1539 EfiKeyF6,\r
1540 EfiKeyF7,\r
1541 EfiKeyF8,\r
1542 EfiKeyF9,\r
1543 EfiKeyF10,\r
1544 EfiKeyF11,\r
1545 EfiKeyF12,\r
1546 EfiKeyPrint,\r
1547 EfiKeySLck,\r
1548 EfiKeyPause\r
1549} EFI_KEY;\r
1550\r
1551typedef struct {\r
1552 EFI_KEY Key;\r
1553 CHAR16 Unicode;\r
1554 CHAR16 ShiftedUnicode;\r
1555 CHAR16 AltGrUnicode;\r
1556 CHAR16 ShiftedAltGrUnicode;\r
1557 UINT16 Modifier;\r
1558 UINT16 AffectedAttribute;\r
1559} EFI_KEY_DESCRIPTOR;\r
1560\r
1561//\r
1562// A key which is affected by all the standard shift modifiers. \r
1563// Most keys would be expected to have this bit active.\r
1564//\r
1565#define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001\r
1566//\r
1567// This key is affected by the caps lock so that if a keyboard driver\r
1568// would need to disambiguate between a key which had a "1" defined\r
1569// versus a "a" character. Having this bit turned on would tell\r
1570// the keyboard driver to use the appropriate shifted state or not.\r
1571//\r
1572#define EFI_AFFECTED_BY_CAPS_LOCK 0x0002\r
1573//\r
1574// Similar to the case of CAPS lock, if this bit is active, the key\r
1575// is affected by the num lock being turned on.\r
1576//\r
1577#define EFI_AFFECTED_BY_NUM_LOCK 0x0004\r
1578\r
1579typedef struct {\r
1580 UINT16 LayoutLength;\r
1581 EFI_GUID Guid;\r
1582 UINT32 LayoutDescriptorStringOffset;\r
1583 UINT8 DescriptorCount;\r
1584 // EFI_KEY_DESCRIPTOR Descriptors[];\r
1585} EFI_HII_KEYBOARD_LAYOUT;\r
1586\r
1587typedef struct {\r
1588 EFI_HII_PACKAGE_HEADER Header;\r
1589 UINT16 LayoutCount;\r
1590 // EFI_HII_KEYBOARD_LAYOUT Layout[];\r
1591} EFI_HII_KEYBOARD_PACKAGE_HDR;\r
1592\r
1593typedef struct {\r
1594 CHAR16 Language[3];\r
1595 CHAR16 Space;\r
1596 CHAR16 DescriptionString[1];\r
1597} EFI_DESCRIPTION_STRING;\r
1598\r
1599typedef struct {\r
1600 UINT16 DescriptionCount;\r
1601 EFI_DESCRIPTION_STRING DescriptionString[1];\r
1602} EFI_DESCRIPTION_STRING_BUNDLE;\r
1603\r
1604//\r
1605// Modifier values\r
1606//\r
1607#define EFI_NULL_MODIFIER 0x0000\r
1608#define EFI_LEFT_CONTROL_MODIFIER 0x0001\r
1609#define EFI_RIGHT_CONTROL_MODIFIER 0x0002\r
1610#define EFI_LEFT_ALT_MODIFIER 0x0003\r
1611#define EFI_RIGHT_ALT_MODIFIER 0x0004\r
1612#define EFI_ALT_GR_MODIFIER 0x0005\r
1613#define EFI_INSERT_MODIFIER 0x0006\r
1614#define EFI_DELETE_MODIFIER 0x0007\r
1615#define EFI_PAGE_DOWN_MODIFIER 0x0008\r
1616#define EFI_PAGE_UP_MODIFIER 0x0009\r
1617#define EFI_HOME_MODIFIER 0x000A\r
1618#define EFI_END_MODIFIER 0x000B\r
1619#define EFI_LEFT_SHIFT_MODIFIER 0x000C\r
1620#define EFI_RIGHT_SHIFT_MODIFIER 0x000D\r
1621#define EFI_CAPS_LOCK_MODIFIER 0x000E\r
1622#define EFI_NUM_LOCK _MODIFIER 0x000F\r
1623#define EFI_LEFT_ARROW_MODIFIER 0x0010\r
1624#define EFI_RIGHT_ARROW_MODIFIER 0x0011\r
1625#define EFI_DOWN_ARROW_MODIFIER 0x0012\r
1626#define EFI_UP_ARROW_MODIFIER 0x0013\r
1627#define EFI_NS_KEY_MODIFIER 0x0014\r
1628#define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015\r
1629#define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016\r
1630#define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017\r
1631#define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018\r
1632#define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019\r
1633#define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A\r
1634#define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B\r
1635#define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C\r
1636#define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D\r
1637#define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E\r
1638#define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F\r
1639#define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020\r
1640#define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021\r
1641\r
1642//\r
1643// Keys that have multiple control functions based on modifier\r
1644// settings are handled in the keyboard driver implementation.\r
1645// For instance PRINT_KEY might have a modifier held down and\r
1646// is still a nonprinting character, but might have an alternate\r
1647// control function like SYSREQUEST\r
1648//\r
1649#define EFI_PRINT_MODIFIER 0x0022\r
1650#define EFI_SYS_REQUEST_MODIFIER 0x0023\r
1651#define EFI_SCROLL_LOCK_MODIFIER 0x0024\r
1652#define EFI_PAUSE_MODIFIER 0x0025\r
1653#define EFI_BREAK_MODIFIER 0x0026\r
1654\r
1655#pragma pack()\r
1656\r
1657\r
1658\r
1659//\r
1660// References to string tokens must use this macro to enable scanning for\r
1661// token usages.\r
1662//\r
1663//\r
1664// STRING_TOKEN is not defined in UEFI specification. But it is placed \r
1665// here for the easy access by C files and VFR source files.\r
1666//\r
1667#define STRING_TOKEN(t) t\r
1668\r
1669#endif\r