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