2 This file defines the encoding for the VFR (Visual Form Representation) language.
3 IFR is primarily consumed by the EFI presentation engine, and produced by EFI
4 internal application and drivers as well as all add-in card option-ROM drivers
6 @par Revision Reference:
7 These definitions are from UEFI2.1.
9 Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
11 This program and the accompanying materials are licensed and made available
12 under the terms and conditions of the BSD License which accompanies this
13 distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
21 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__
22 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__
25 #define EFI_HII_PLATFORM_SETUP_FORMSET_GUID \
26 { 0x93039971, 0x8545, 0x4b04, { 0xb4, 0x5e, 0x32, 0xeb, 0x83, 0x26, 0x4, 0xe } }
29 // The following types are currently defined:
31 typedef UINT32 RELOFST
;
33 typedef VOID
* EFI_HII_HANDLE
;
34 typedef CHAR16
* EFI_STRING
;
35 typedef UINT16 EFI_IMAGE_ID
;
36 typedef UINT16 EFI_QUESTION_ID
;
37 typedef UINT16 EFI_STRING_ID
;
38 typedef UINT16 EFI_FORM_ID
;
39 typedef UINT16 EFI_VARSTORE_ID
;
40 typedef UINT16 EFI_DEFAULT_ID
;
41 typedef UINT32 EFI_HII_FONT_STYLE
;
52 EFI_GUID PackageListGuid
;
54 } EFI_HII_PACKAGE_LIST_HEADER
;
58 Each package starts with a header, as defined above, which
59 indicates the size and type of the package. When added to a
60 pointer pointing to the start of the header, Length points at
61 the next package. The package lists form a package list when
62 concatenated together and terminated with an
63 EFI_HII_PACKAGE_HEADER with a Type of EFI_HII_PACKAGE_END. The
64 type EFI_HII_PACKAGE_TYPE_GUID is used for vendor-defined HII
65 packages, whose contents are determined by the Guid. The range
66 of package types starting with EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN
67 through EFI_HII_PACKAGE_TYPE_SYSTEM_END are reserved for system
68 firmware implementers.
70 @param Length The size of the package in bytes.
72 @param Type The package type. See EFI_HII_PACKAGE_TYPE_x,
75 @param Data The package data, the format of which is
83 } EFI_HII_PACKAGE_HEADER
;
86 // EFI_HII_PACKAGE_TYPE_x.
88 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
89 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
90 #define EFI_HII_PACKAGE_FORM 0x02
91 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x03
92 #define EFI_HII_PACKAGE_STRINGS 0x04
93 #define EFI_HII_PACKAGE_FONTS 0x05
94 #define EFI_HII_PACKAGE_IMAGES 0x06
95 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
96 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
97 #define EFI_HII_PACKAGE_END 0xDF
98 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
99 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
102 // Simplified Font Package
105 #define EFI_GLYPH_HEIGHT 19
106 #define EFI_GLYPH_WIDTH 8
108 // Contents of EFI_NARROW_GLYPH.Attributes
110 #define EFI_GLYPH_NON_SPACING 0x01
111 #define EFI_GLYPH_WIDE 0x02
114 CHAR16 UnicodeWeight
;
116 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
120 CHAR16 UnicodeWeight
;
122 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
123 UINT8 GlyphCol2
[EFI_GLYPH_HEIGHT
];
128 typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR
{
129 EFI_HII_PACKAGE_HEADER Header
;
130 UINT16 NumberOfNarrowGlyphs
;
131 UINT16 NumberOfWideGlyphs
;
132 // EFI_NARROW_GLYPH NarrowGlyphs[];
133 // EFI_WIDE_GLYPH WideGlyphs[];
134 } EFI_HII_SIMPLE_FONT_PACKAGE_HDR
;
140 #define EFI_HII_FONT_STYLE_BOLD 0x00000001
141 #define EFI_HII_FONT_STYLE_ITALIC 0x00000002
142 #define EFI_HII_FONT_STYLE_EMBOSS 0x00010000
143 #define EFI_HII_FONT_STYLE_OUTLINE 0x00020000
144 #define EFI_HII_FONT_STYLE_SHADOW 0x00040000
145 #define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000
146 #define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000
148 typedef struct _EFI_HII_GLYPH_INFO
{
154 } EFI_HII_GLYPH_INFO
;
156 typedef struct _EFI_HII_FONT_PACKAGE_HDR
{
157 EFI_HII_PACKAGE_HEADER Header
;
159 UINT32 GlyphBlockOffset
;
160 EFI_HII_GLYPH_INFO Cell
;
161 EFI_HII_FONT_STYLE FontStyle
;
162 CHAR16 FontFamily
[1];
163 } EFI_HII_FONT_PACKAGE_HDR
;
165 #define EFI_HII_GIBT_END 0x00
166 #define EFI_HII_GIBT_GLYPH 0x10
167 #define EFI_HII_GIBT_GLYPHS 0x11
168 #define EFI_HII_GIBT_GLYPH_DEFAULT 0x12
169 #define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13
170 #define EFI_HII_GIBT_DUPLICATE 0x20
171 #define EFI_HII_GIBT_SKIP2 0x21
172 #define EFI_HII_GIBT_SKIP1 0x22
173 #define EFI_HII_GIBT_DEFAULTS 0x23
174 #define EFI_HII_GIBT_EXT1 0x30
175 #define EFI_HII_GIBT_EXT2 0x31
176 #define EFI_HII_GIBT_EXT4 0x32
178 typedef struct _EFI_HII_GLYPH_BLOCK
{
180 } EFI_HII_GLYPH_BLOCK
;
182 typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK
{
183 EFI_HII_GLYPH_BLOCK Header
;
184 EFI_HII_GLYPH_INFO Cell
;
185 } EFI_HII_GIBT_DEFAULTS_BLOCK
;
187 typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK
{
188 EFI_HII_GLYPH_BLOCK Header
;
190 } EFI_HII_GIBT_DUPLICATE_BLOCK
;
192 typedef struct _EFI_GLYPH_GIBT_END_BLOCK
{
193 EFI_HII_GLYPH_BLOCK Header
;
194 } EFI_GLYPH_GIBT_END_BLOCK
;
196 typedef struct _EFI_HII_GIBT_EXT1_BLOCK
{
197 EFI_HII_GLYPH_BLOCK Header
;
200 } EFI_HII_GIBT_EXT1_BLOCK
;
202 typedef struct _EFI_HII_GIBT_EXT2_BLOCK
{
203 EFI_HII_GLYPH_BLOCK Header
;
206 } EFI_HII_GIBT_EXT2_BLOCK
;
208 typedef struct _EFI_HII_GIBT_EXT4_BLOCK
{
209 EFI_HII_GLYPH_BLOCK Header
;
212 } EFI_HII_GIBT_EXT4_BLOCK
;
214 typedef struct _EFI_HII_GIBT_GLYPH_BLOCK
{
215 EFI_HII_GLYPH_BLOCK Header
;
216 EFI_HII_GLYPH_INFO Cell
;
217 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height
218 } EFI_HII_GIBT_GLYPH_BLOCK
;
220 typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK
{
221 EFI_HII_GLYPH_BLOCK Header
;
222 EFI_HII_GLYPH_INFO Cell
;
224 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height
225 } EFI_HII_GIBT_GLYPHS_BLOCK
;
227 typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
{
228 EFI_HII_GLYPH_BLOCK Header
;
229 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height
230 } EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
;
232 typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
{
233 EFI_HII_GLYPH_BLOCK Header
;
235 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height
236 } EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
;
238 typedef struct _EFI_HII_GIBT_SKIP1_BLOCK
{
239 EFI_HII_GLYPH_BLOCK Header
;
241 } EFI_HII_GIBT_SKIP1_BLOCK
;
243 typedef struct _EFI_HII_GIBT_SKIP2_BLOCK
{
244 EFI_HII_GLYPH_BLOCK Header
;
246 } EFI_HII_GIBT_SKIP2_BLOCK
;
249 // Device Path Package
251 typedef struct _EFI_HII_DEVICE_PATH_PACKAGE
{
252 EFI_HII_PACKAGE_HEADER Header
;
253 // EFI_DEVICE_PATH_PROTOCOL DevicePath[];
254 } EFI_HII_DEVICE_PATH_PACKAGE
;
259 typedef struct _EFI_HII_GUID_PACKAGE_HDR
{
260 EFI_HII_PACKAGE_HEADER Header
;
262 // Data per GUID definition may follow
263 } EFI_HII_GUID_PACKAGE_HDR
;
269 #define UEFI_CONFIG_LANG "x-UEFI"
270 #define UEFI_CONFIG_LANG2 "x-i-UEFI"
272 typedef struct _EFI_HII_STRING_PACKAGE_HDR
{
273 EFI_HII_PACKAGE_HEADER Header
;
275 UINT32 StringInfoOffset
;
276 CHAR16 LanguageWindow
[16];
277 EFI_STRING_ID LanguageName
;
279 } EFI_HII_STRING_PACKAGE_HDR
;
283 } EFI_HII_STRING_BLOCK
;
285 #define EFI_HII_SIBT_END 0x00
286 #define EFI_HII_SIBT_STRING_SCSU 0x10
287 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
288 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
289 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
290 #define EFI_HII_SIBT_STRING_UCS2 0x14
291 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
292 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
293 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
294 #define EFI_HII_SIBT_DUPLICATE 0x20
295 #define EFI_HII_SIBT_SKIP2 0x21
296 #define EFI_HII_SIBT_SKIP1 0x22
297 #define EFI_HII_SIBT_EXT1 0x30
298 #define EFI_HII_SIBT_EXT2 0x31
299 #define EFI_HII_SIBT_EXT4 0x32
300 #define EFI_HII_SIBT_FONT 0x40
302 typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK
{
303 EFI_HII_STRING_BLOCK Header
;
304 EFI_STRING_ID StringId
;
305 } EFI_HII_SIBT_DUPLICATE_BLOCK
;
307 typedef struct _EFI_HII_SIBT_END_BLOCK
{
308 EFI_HII_STRING_BLOCK Header
;
309 } EFI_HII_SIBT_END_BLOCK
;
311 typedef struct _EFI_HII_SIBT_EXT1_BLOCK
{
312 EFI_HII_STRING_BLOCK Header
;
315 } EFI_HII_SIBT_EXT1_BLOCK
;
317 typedef struct _EFI_HII_SIBT_EXT2_BLOCK
{
318 EFI_HII_STRING_BLOCK Header
;
321 } EFI_HII_SIBT_EXT2_BLOCK
;
323 typedef struct _EFI_HII_SIBT_EXT4_BLOCK
{
324 EFI_HII_STRING_BLOCK Header
;
327 } EFI_HII_SIBT_EXT4_BLOCK
;
329 typedef struct _EFI_HII_SIBT_FONT_BLOCK
{
330 EFI_HII_SIBT_EXT2_BLOCK Header
;
333 EFI_HII_FONT_STYLE FontStyle
;
335 } EFI_HII_SIBT_FONT_BLOCK
;
337 typedef struct _EFI_HII_SIBT_SKIP1_BLOCK
{
338 EFI_HII_STRING_BLOCK Header
;
340 } EFI_HII_SIBT_SKIP1_BLOCK
;
342 typedef struct _EFI_HII_SIBT_SKIP2_BLOCK
{
343 EFI_HII_STRING_BLOCK Header
;
345 } EFI_HII_SIBT_SKIP2_BLOCK
;
347 typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK
{
348 EFI_HII_STRING_BLOCK Header
;
350 } EFI_HII_SIBT_STRING_SCSU_BLOCK
;
352 typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
{
353 EFI_HII_STRING_BLOCK Header
;
354 UINT8 FontIdentifier
;
356 } EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
;
358 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK
{
359 EFI_HII_STRING_BLOCK Header
;
362 } EFI_HII_SIBT_STRINGS_SCSU_BLOCK
;
364 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
{
365 EFI_HII_STRING_BLOCK Header
;
366 UINT8 FontIdentifier
;
369 } EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
;
371 typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK
{
372 EFI_HII_STRING_BLOCK Header
;
373 CHAR16 StringText
[1];
374 } EFI_HII_SIBT_STRING_UCS2_BLOCK
;
376 typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
{
377 EFI_HII_STRING_BLOCK Header
;
378 UINT8 FontIdentifier
;
379 CHAR16 StringText
[1];
380 } EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
;
382 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK
{
383 EFI_HII_STRING_BLOCK Header
;
385 CHAR16 StringText
[1];
386 } EFI_HII_SIBT_STRINGS_UCS2_BLOCK
;
388 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
{
389 EFI_HII_STRING_BLOCK Header
;
390 UINT8 FontIdentifier
;
392 CHAR16 StringText
[1];
393 } EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
;
399 typedef struct _EFI_HII_IMAGE_PACKAGE_HDR
{
400 EFI_HII_PACKAGE_HEADER Header
;
401 UINT32 ImageInfoOffset
;
402 UINT32 PaletteInfoOffset
;
403 } EFI_HII_IMAGE_PACKAGE_HDR
;
405 typedef struct _EFI_HII_IMAGE_BLOCK
{
407 } EFI_HII_IMAGE_BLOCK
;
409 #define EFI_HII_IIBT_END 0x00
410 #define EFI_HII_IIBT_IMAGE_1BIT 0x10
411 #define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11
412 #define EFI_HII_IIBT_IMAGE_4BIT 0x12
413 #define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13
414 #define EFI_HII_IIBT_IMAGE_8BIT 0x14
415 #define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15
416 #define EFI_HII_IIBT_IMAGE_24BIT 0x16
417 #define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17
418 #define EFI_HII_IIBT_IMAGE_JPEG 0x18
419 #define EFI_HII_IIBT_DUPLICATE 0x20
420 #define EFI_HII_IIBT_SKIP2 0x21
421 #define EFI_HII_IIBT_SKIP1 0x22
422 #define EFI_HII_IIBT_EXT1 0x30
423 #define EFI_HII_IIBT_EXT2 0x31
424 #define EFI_HII_IIBT_EXT4 0x32
426 typedef struct _EFI_HII_IIBT_END_BLOCK
{
427 EFI_HII_IMAGE_BLOCK Header
;
428 } EFI_HII_IIBT_END_BLOCK
;
430 typedef struct _EFI_HII_IIBT_EXT1_BLOCK
{
431 EFI_HII_IMAGE_BLOCK Header
;
434 } EFI_HII_IIBT_EXT1_BLOCK
;
436 typedef struct _EFI_HII_IIBT_EXT2_BLOCK
{
437 EFI_HII_IMAGE_BLOCK Header
;
440 } EFI_HII_IIBT_EXT2_BLOCK
;
442 typedef struct _EFI_HII_IIBT_EXT4_BLOCK
{
443 EFI_HII_IMAGE_BLOCK Header
;
446 } EFI_HII_IIBT_EXT4_BLOCK
;
448 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE
{
452 } EFI_HII_IIBT_IMAGE_1BIT_BASE
;
454 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK
{
455 EFI_HII_IMAGE_BLOCK Header
;
457 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
458 } EFI_HII_IIBT_IMAGE_1BIT_BLOCK
;
460 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
{
461 EFI_HII_IMAGE_BLOCK Header
;
463 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
464 } EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
;
466 typedef struct _EFI_HII_RGB_PIXEL
{
472 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE
{
475 EFI_HII_RGB_PIXEL Bitmap
[1];
476 } EFI_HII_IIBT_IMAGE_24BIT_BASE
;
478 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK
{
479 EFI_HII_IMAGE_BLOCK Header
;
480 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
481 } EFI_HII_IIBT_IMAGE_24BIT_BLOCK
;
483 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
{
484 EFI_HII_IMAGE_BLOCK Header
;
485 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
486 } EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
;
488 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE
{
492 } EFI_HII_IIBT_IMAGE_4BIT_BASE
;
494 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK
{
495 EFI_HII_IMAGE_BLOCK Header
;
497 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
498 } EFI_HII_IIBT_IMAGE_4BIT_BLOCK
;
500 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
{
501 EFI_HII_IMAGE_BLOCK Header
;
503 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
504 } EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
;
506 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE
{
510 } EFI_HII_IIBT_IMAGE_8BIT_BASE
;
512 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK
{
513 EFI_HII_IMAGE_BLOCK Header
;
515 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
516 } EFI_HII_IIBT_IMAGE_8BIT_BLOCK
;
518 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK
{
519 EFI_HII_IMAGE_BLOCK Header
;
521 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
522 } EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK
;
524 typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK
{
525 EFI_HII_IMAGE_BLOCK Header
;
526 EFI_IMAGE_ID ImageId
;
527 } EFI_HII_IIBT_DUPLICATE_BLOCK
;
529 typedef struct _EFI_HII_IIBT_JPEG_BLOCK
{
530 EFI_HII_IMAGE_BLOCK Header
;
533 } EFI_HII_IIBT_JPEG_BLOCK
;
535 typedef struct _EFI_HII_IIBT_SKIP1_BLOCK
{
536 EFI_HII_IMAGE_BLOCK Header
;
538 } EFI_HII_IIBT_SKIP1_BLOCK
;
540 typedef struct _EFI_HII_IIBT_SKIP2_BLOCK
{
541 EFI_HII_IMAGE_BLOCK Header
;
543 } EFI_HII_IIBT_SKIP2_BLOCK
;
545 typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER
{
547 } EFI_HII_IMAGE_PALETTE_INFO_HEADER
;
549 typedef struct _EFI_HII_IMAGE_PALETTE_INFO
{
551 EFI_HII_RGB_PIXEL PaletteValue
[1];
552 } EFI_HII_IMAGE_PALETTE_INFO
;
558 typedef struct _EFI_HII_FORM_PACKAGE
{
559 EFI_HII_PACKAGE_HEADER Header
;
560 // EFI_IFR_OP_HEADER OpCodeHeader;
561 // More op-codes follow
562 } EFI_HII_FORM_PACKAGE
;
577 EFI_QUESTION_ID QuestionId
;
579 EFI_GUID FormSetGuid
;
580 EFI_STRING_ID DevicePath
;
591 EFI_STRING_ID string
;
593 } EFI_IFR_TYPE_VALUE
;
595 #define EFI_IFR_FORM_OP 0x01
596 #define EFI_IFR_SUBTITLE_OP 0x02
597 #define EFI_IFR_TEXT_OP 0x03
598 #define EFI_IFR_IMAGE_OP 0x04
599 #define EFI_IFR_ONE_OF_OP 0x05
600 #define EFI_IFR_CHECKBOX_OP 0x06
601 #define EFI_IFR_NUMERIC_OP 0x07
602 #define EFI_IFR_PASSWORD_OP 0x08
603 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
604 #define EFI_IFR_SUPPRESS_IF_OP 0x0A
605 #define EFI_IFR_LOCKED_OP 0x0B
606 #define EFI_IFR_ACTION_OP 0x0C
607 #define EFI_IFR_RESET_BUTTON_OP 0x0D
608 #define EFI_IFR_FORM_SET_OP 0x0E
609 #define EFI_IFR_REF_OP 0x0F
610 #define EFI_IFR_NO_SUBMIT_IF_OP 0x10
611 #define EFI_IFR_INCONSISTENT_IF_OP 0x11
612 #define EFI_IFR_EQ_ID_VAL_OP 0x12
613 #define EFI_IFR_EQ_ID_ID_OP 0x13
614 #define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14
615 #define EFI_IFR_AND_OP 0x15
616 #define EFI_IFR_OR_OP 0x16
617 #define EFI_IFR_NOT_OP 0x17
618 #define EFI_IFR_RULE_OP 0x18
619 #define EFI_IFR_GRAY_OUT_IF_OP 0x19
620 #define EFI_IFR_DATE_OP 0x1A
621 #define EFI_IFR_TIME_OP 0x1B
622 #define EFI_IFR_STRING_OP 0x1C
623 #define EFI_IFR_REFRESH_OP 0x1D
624 #define EFI_IFR_DISABLE_IF_OP 0x1E
625 #define EFI_IFR_TO_LOWER_OP 0x20
626 #define EFI_IFR_TO_UPPER_OP 0x21
627 #define EFI_IFR_MAP_OP 0x22
628 #define EFI_IFR_ORDERED_LIST_OP 0x23
629 #define EFI_IFR_VARSTORE_OP 0x24
630 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
631 #define EFI_IFR_VARSTORE_EFI_OP 0x26
632 #define EFI_IFR_VARSTORE_DEVICE_OP 0x27
633 #define EFI_IFR_VERSION_OP 0x28
634 #define EFI_IFR_END_OP 0x29
635 #define EFI_IFR_MATCH_OP 0x2A
636 #define EFI_IFR_GET_OP 0x2B
637 #define EFI_IFR_SET_OP 0x2C
638 #define EFI_IFR_READ_OP 0x2D
639 #define EFI_IFR_WRITE_OP 0x2E
640 #define EFI_IFR_EQUAL_OP 0x2F
641 #define EFI_IFR_NOT_EQUAL_OP 0x30
642 #define EFI_IFR_GREATER_THAN_OP 0x31
643 #define EFI_IFR_GREATER_EQUAL_OP 0x32
644 #define EFI_IFR_LESS_THAN_OP 0x33
645 #define EFI_IFR_LESS_EQUAL_OP 0x34
646 #define EFI_IFR_BITWISE_AND_OP 0x35
647 #define EFI_IFR_BITWISE_OR_OP 0x36
648 #define EFI_IFR_BITWISE_NOT_OP 0x37
649 #define EFI_IFR_SHIFT_LEFT_OP 0x38
650 #define EFI_IFR_SHIFT_RIGHT_OP 0x39
651 #define EFI_IFR_ADD_OP 0x3A
652 #define EFI_IFR_SUBTRACT_OP 0x3B
653 #define EFI_IFR_MULTIPLY_OP 0x3C
654 #define EFI_IFR_DIVIDE_OP 0x3D
655 #define EFI_IFR_MODULO_OP 0x3E
656 #define EFI_IFR_RULE_REF_OP 0x3F
657 #define EFI_IFR_QUESTION_REF1_OP 0x40
658 #define EFI_IFR_QUESTION_REF2_OP 0x41
659 #define EFI_IFR_UINT8_OP 0x42
660 #define EFI_IFR_UINT16_OP 0x43
661 #define EFI_IFR_UINT32_OP 0x44
662 #define EFI_IFR_UINT64_OP 0x45
663 #define EFI_IFR_TRUE_OP 0x46
664 #define EFI_IFR_FALSE_OP 0x47
665 #define EFI_IFR_TO_UINT_OP 0x48
666 #define EFI_IFR_TO_STRING_OP 0x49
667 #define EFI_IFR_TO_BOOLEAN_OP 0x4A
668 #define EFI_IFR_MID_OP 0x4B
669 #define EFI_IFR_FIND_OP 0x4C
670 #define EFI_IFR_TOKEN_OP 0x4D
671 #define EFI_IFR_STRING_REF1_OP 0x4E
672 #define EFI_IFR_STRING_REF2_OP 0x4F
673 #define EFI_IFR_CONDITIONAL_OP 0x50
674 #define EFI_IFR_QUESTION_REF3_OP 0x51
675 #define EFI_IFR_ZERO_OP 0x52
676 #define EFI_IFR_ONE_OP 0x53
677 #define EFI_IFR_ONES_OP 0x54
678 #define EFI_IFR_UNDEFINED_OP 0x55
679 #define EFI_IFR_LENGTH_OP 0x56
680 #define EFI_IFR_DUP_OP 0x57
681 #define EFI_IFR_THIS_OP 0x58
682 #define EFI_IFR_SPAN_OP 0x59
683 #define EFI_IFR_VALUE_OP 0x5A
684 #define EFI_IFR_DEFAULT_OP 0x5B
685 #define EFI_IFR_DEFAULTSTORE_OP 0x5C
686 #define EFI_IFR_FORM_MAP_OP 0x5D
687 #define EFI_IFR_CATENATE_OP 0x5E
688 #define EFI_IFR_GUID_OP 0x5F
689 #define EFI_IFR_SECURITY_OP 0x60
690 #define EFI_IFR_MODAL_TAG_OP 0x61
691 #define EFI_IFR_REFRESH_ID_OP 0x62
692 #define EFI_IFR_WARNING_IF_OP 0x63
695 typedef struct _EFI_IFR_OP_HEADER
{
701 typedef struct _EFI_IFR_STATEMENT_HEADER
{
702 EFI_STRING_ID Prompt
;
704 } EFI_IFR_STATEMENT_HEADER
;
706 typedef struct _EFI_IFR_QUESTION_HEADER
{
707 EFI_IFR_STATEMENT_HEADER Header
;
708 EFI_QUESTION_ID QuestionId
;
709 EFI_VARSTORE_ID VarStoreId
;
711 EFI_STRING_ID VarName
;
715 } EFI_IFR_QUESTION_HEADER
;
717 #define EFI_IFR_FLAG_READ_ONLY 0x01
718 #define EFI_IFR_FLAG_CALLBACK 0x04
719 #define EFI_IFR_FLAG_RESET_REQUIRED 0x10
720 #define EFI_IFR_FLAG_OPTIONS_ONLY 0x80
722 typedef struct _EFI_IFR_DEFAULTSTORE
{
723 EFI_IFR_OP_HEADER Header
;
724 EFI_STRING_ID DefaultName
;
726 } EFI_IFR_DEFAULTSTORE
;
728 #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000
729 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001
730 #define EFI_HII_DEFAULT_CLASS_SAFE 0x0002
731 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
732 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff
733 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
734 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff
735 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
736 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff
738 typedef struct _EFI_IFR_VARSTORE
{
739 EFI_IFR_OP_HEADER Header
;
741 EFI_VARSTORE_ID VarStoreId
;
746 typedef struct _EFI_IFR_VARSTORE_EFI
{
747 EFI_IFR_OP_HEADER Header
;
748 EFI_VARSTORE_ID VarStoreId
;
753 } EFI_IFR_VARSTORE_EFI
;
755 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE
{
756 EFI_IFR_OP_HEADER Header
;
757 EFI_VARSTORE_ID VarStoreId
;
759 } EFI_IFR_VARSTORE_NAME_VALUE
;
761 typedef struct _EFI_IFR_FORM_SET
{
762 EFI_IFR_OP_HEADER Header
;
764 EFI_STRING_ID FormSetTitle
;
767 // EFI_GUID ClassGuid[];
770 typedef struct _EFI_IFR_END
{
771 EFI_IFR_OP_HEADER Header
;
774 typedef struct _EFI_IFR_FORM
{
775 EFI_IFR_OP_HEADER Header
;
777 EFI_STRING_ID FormTitle
;
780 typedef struct _EFI_IFR_IMAGE
{
781 EFI_IFR_OP_HEADER Header
;
785 typedef struct _EFI_IFR_MODAL_TAG
{
786 EFI_IFR_OP_HEADER Header
;
789 typedef struct _EFI_IFR_LOCKED
{
790 EFI_IFR_OP_HEADER Header
;
793 typedef struct _EFI_IFR_RULE
{
794 EFI_IFR_OP_HEADER Header
;
798 typedef struct _EFI_IFR_DEFAULT
{
799 EFI_IFR_OP_HEADER Header
;
802 EFI_IFR_TYPE_VALUE Value
;
805 typedef struct _EFI_IFR_DEFAULT_2
{
806 EFI_IFR_OP_HEADER Header
;
811 typedef struct _EFI_IFR_VALUE
{
812 EFI_IFR_OP_HEADER Header
;
815 typedef struct _EFI_IFR_SUBTITLE
{
816 EFI_IFR_OP_HEADER Header
;
817 EFI_IFR_STATEMENT_HEADER Statement
;
821 #define EFI_IFR_FLAGS_HORIZONTAL 0x01
823 typedef struct _EFI_IFR_CHECKBOX
{
824 EFI_IFR_OP_HEADER Header
;
825 EFI_IFR_QUESTION_HEADER Question
;
829 #define EFI_IFR_CHECKBOX_DEFAULT 0x01
830 #define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02
832 typedef struct _EFI_IFR_TEXT
{
833 EFI_IFR_OP_HEADER Header
;
834 EFI_IFR_STATEMENT_HEADER Statement
;
835 EFI_STRING_ID TextTwo
;
838 typedef struct _EFI_IFR_REF
{
839 EFI_IFR_OP_HEADER Header
;
840 EFI_IFR_QUESTION_HEADER Question
;
844 typedef struct _EFI_IFR_REF2
{
845 EFI_IFR_OP_HEADER Header
;
846 EFI_IFR_QUESTION_HEADER Question
;
848 EFI_QUESTION_ID QuestionId
;
851 typedef struct _EFI_IFR_REF3
{
852 EFI_IFR_OP_HEADER Header
;
853 EFI_IFR_QUESTION_HEADER Question
;
855 EFI_QUESTION_ID QuestionId
;
859 typedef struct _EFI_IFR_REF4
{
860 EFI_IFR_OP_HEADER Header
;
861 EFI_IFR_QUESTION_HEADER Question
;
863 EFI_QUESTION_ID QuestionId
;
865 EFI_STRING_ID DevicePath
;
868 typedef struct _EFI_IFR_REF5
{
869 EFI_IFR_OP_HEADER Header
;
870 EFI_IFR_QUESTION_HEADER Question
;
873 typedef struct _EFI_IFR_RESET_BUTTON
{
874 EFI_IFR_OP_HEADER Header
;
875 EFI_IFR_STATEMENT_HEADER Statement
;
876 EFI_DEFAULT_ID DefaultId
;
877 } EFI_IFR_RESET_BUTTON
;
879 typedef struct _EFI_IFR_ACTION
{
880 EFI_IFR_OP_HEADER Header
;
881 EFI_IFR_QUESTION_HEADER Question
;
882 EFI_STRING_ID QuestionConfig
;
885 typedef struct _EFI_IFR_ACTION_1
{
886 EFI_IFR_OP_HEADER Header
;
887 EFI_IFR_QUESTION_HEADER Question
;
890 typedef struct _EFI_IFR_DATE
{
891 EFI_IFR_OP_HEADER Header
;
892 EFI_IFR_QUESTION_HEADER Question
;
896 #define EFI_QF_DATE_YEAR_SUPPRESS 0x01
897 #define EFI_QF_DATE_MONTH_SUPPRESS 0x02
898 #define EFI_QF_DATE_DAY_SUPPRESS 0x04
900 #define EFI_QF_DATE_STORAGE 0x30
901 #define QF_DATE_STORAGE_NORMAL 0x00
902 #define QF_DATE_STORAGE_TIME 0x10
903 #define QF_DATE_STORAGE_WAKEUP 0x20
928 typedef struct _EFI_IFR_NUMERIC
{
929 EFI_IFR_OP_HEADER Header
;
930 EFI_IFR_QUESTION_HEADER Question
;
932 MINMAXSTEP_DATA data
;
935 #define EFI_IFR_NUMERIC_SIZE 0x03
936 #define EFI_IFR_NUMERIC_SIZE_1 0x00
937 #define EFI_IFR_NUMERIC_SIZE_2 0x01
938 #define EFI_IFR_NUMERIC_SIZE_4 0x02
939 #define EFI_IFR_NUMERIC_SIZE_8 0x03
941 #define EFI_IFR_DISPLAY 0x30
942 #define EFI_IFR_DISPLAY_INT_DEC 0x00
943 #define EFI_IFR_DISPLAY_UINT_DEC 0x10
944 #define EFI_IFR_DISPLAY_UINT_HEX 0x20
946 typedef struct _EFI_IFR_ONE_OF
{
947 EFI_IFR_OP_HEADER Header
;
948 EFI_IFR_QUESTION_HEADER Question
;
950 MINMAXSTEP_DATA data
;
953 typedef struct _EFI_IFR_STRING
{
954 EFI_IFR_OP_HEADER Header
;
955 EFI_IFR_QUESTION_HEADER Question
;
961 #define EFI_IFR_STRING_MULTI_LINE 0x01
963 typedef struct _EFI_IFR_PASSWORD
{
964 EFI_IFR_OP_HEADER Header
;
965 EFI_IFR_QUESTION_HEADER Question
;
970 typedef struct _EFI_IFR_ORDERED_LIST
{
971 EFI_IFR_OP_HEADER Header
;
972 EFI_IFR_QUESTION_HEADER Question
;
975 } EFI_IFR_ORDERED_LIST
;
977 #define EFI_IFR_UNIQUE_SET 0x01
978 #define EFI_IFR_NO_EMPTY_SET 0x02
980 typedef struct _EFI_IFR_TIME
{
981 EFI_IFR_OP_HEADER Header
;
982 EFI_IFR_QUESTION_HEADER Question
;
986 #define QF_TIME_HOUR_SUPPRESS 0x01
987 #define QF_TIME_MINUTE_SUPPRESS 0x02
988 #define QF_TIME_SECOND_SUPPRESS 0x04
990 #define QF_TIME_STORAGE 0x30
991 #define QF_TIME_STORAGE_NORMAL 0x00
992 #define QF_TIME_STORAGE_TIME 0x10
993 #define QF_TIME_STORAGE_WAKEUP 0x20
995 typedef struct _EFI_IFR_DISABLE_IF
{
996 EFI_IFR_OP_HEADER Header
;
997 } EFI_IFR_DISABLE_IF
;
999 typedef struct _EFI_IFR_SUPPRESS_IF
{
1000 EFI_IFR_OP_HEADER Header
;
1001 } EFI_IFR_SUPPRESS_IF
;
1003 typedef struct _EFI_IFR_GRAY_OUT_IF
{
1004 EFI_IFR_OP_HEADER Header
;
1005 } EFI_IFR_GRAY_OUT_IF
;
1007 typedef struct _EFI_IFR_INCONSISTENT_IF
{
1008 EFI_IFR_OP_HEADER Header
;
1009 EFI_STRING_ID Error
;
1010 } EFI_IFR_INCONSISTENT_IF
;
1012 typedef struct _EFI_IFR_NO_SUBMIT_IF
{
1013 EFI_IFR_OP_HEADER Header
;
1014 EFI_STRING_ID Error
;
1015 } EFI_IFR_NO_SUBMIT_IF
;
1017 typedef struct _EFI_IFR_WARNING_IF
{
1018 EFI_IFR_OP_HEADER Header
;
1019 EFI_STRING_ID Warning
;
1021 } EFI_IFR_WARNING_IF
;
1023 typedef struct _EFI_IFR_REFRESH
{
1024 EFI_IFR_OP_HEADER Header
;
1025 UINT8 RefreshInterval
;
1028 typedef struct _EFI_IFR_REFRESH_ID
{
1029 EFI_IFR_OP_HEADER Header
;
1030 EFI_GUID RefreshEventGroupId
;
1031 } EFI_IFR_REFRESH_ID
;
1033 typedef struct _EFI_IFR_VARSTORE_DEVICE
{
1034 EFI_IFR_OP_HEADER Header
;
1035 EFI_STRING_ID DevicePath
;
1036 } EFI_IFR_VARSTORE_DEVICE
;
1038 typedef struct _EFI_IFR_ONE_OF_OPTION
{
1039 EFI_IFR_OP_HEADER Header
;
1040 EFI_STRING_ID Option
;
1043 EFI_IFR_TYPE_VALUE Value
;
1044 } EFI_IFR_ONE_OF_OPTION
;
1046 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1047 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1048 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1049 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1050 #define EFI_IFR_TYPE_BOOLEAN 0x04
1051 #define EFI_IFR_TYPE_TIME 0x05
1052 #define EFI_IFR_TYPE_DATE 0x06
1053 #define EFI_IFR_TYPE_STRING 0x07
1054 #define EFI_IFR_TYPE_OTHER 0x08
1055 #define EFI_IFR_TYPE_UNDEFINED 0x09
1056 #define EFI_IFR_TYPE_ACTION 0x0A
1057 #define EFI_IFR_TYPE_BUFFER 0x0B
1058 #define EFI_IFR_TYPE_REF 0x0C
1060 #define EFI_IFR_OPTION_DEFAULT 0x10
1061 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1063 typedef struct _EFI_IFR_GUID
{
1064 EFI_IFR_OP_HEADER Header
;
1066 //Optional Data Follows
1069 typedef struct _EFI_IFR_DUP
{
1070 EFI_IFR_OP_HEADER Header
;
1073 typedef struct _EFI_IFR_EQ_ID_ID
{
1074 EFI_IFR_OP_HEADER Header
;
1075 EFI_QUESTION_ID QuestionId1
;
1076 EFI_QUESTION_ID QuestionId2
;
1079 typedef struct _EFI_IFR_EQ_ID_VAL
{
1080 EFI_IFR_OP_HEADER Header
;
1081 EFI_QUESTION_ID QuestionId
;
1083 } EFI_IFR_EQ_ID_VAL
;
1085 typedef struct _EFI_IFR_EQ_ID_VAL_LIST
{
1086 EFI_IFR_OP_HEADER Header
;
1087 EFI_QUESTION_ID QuestionId
;
1089 UINT16 ValueList
[1];
1090 } EFI_IFR_EQ_ID_VAL_LIST
;
1092 typedef struct _EFI_IFR_QUESTION_REF1
{
1093 EFI_IFR_OP_HEADER Header
;
1094 EFI_QUESTION_ID QuestionId
;
1095 } EFI_IFR_QUESTION_REF1
;
1097 typedef struct _EFI_IFR_UINT8
{
1098 EFI_IFR_OP_HEADER Header
;
1102 typedef struct _EFI_IFR_UINT16
{
1103 EFI_IFR_OP_HEADER Header
;
1107 typedef struct _EFI_IFR_QUESTION_REF2
{
1108 EFI_IFR_OP_HEADER Header
;
1109 } EFI_IFR_QUESTION_REF2
;
1111 typedef struct _EFI_IFR_UINT32
{
1112 EFI_IFR_OP_HEADER Header
;
1116 typedef struct _EFI_IFR_UINT64
{
1117 EFI_IFR_OP_HEADER Header
;
1121 typedef struct _EFI_IFR_QUESTION_REF3
{
1122 EFI_IFR_OP_HEADER Header
;
1123 } EFI_IFR_QUESTION_REF3
;
1125 typedef struct _EFI_IFR_QUESTION_REF3_2
{
1126 EFI_IFR_OP_HEADER Header
;
1127 EFI_STRING_ID DevicePath
;
1128 } EFI_IFR_QUESTION_REF3_2
;
1130 typedef struct _EFI_IFR_QUESTION_REF3_3
{
1131 EFI_IFR_OP_HEADER Header
;
1132 EFI_STRING_ID DevicePath
;
1134 } EFI_IFR_QUESTION_REF3_3
;
1136 typedef struct _EFI_IFR_RULE_REF
{
1137 EFI_IFR_OP_HEADER Header
;
1141 typedef struct _EFI_IFR_STRING_REF1
{
1142 EFI_IFR_OP_HEADER Header
;
1143 EFI_STRING_ID StringId
;
1144 } EFI_IFR_STRING_REF1
;
1146 typedef struct _EFI_IFR_STRING_REF2
{
1147 EFI_IFR_OP_HEADER Header
;
1148 } EFI_IFR_STRING_REF2
;
1150 typedef struct _EFI_IFR_THIS
{
1151 EFI_IFR_OP_HEADER Header
;
1154 typedef struct _EFI_IFR_TRUE
{
1155 EFI_IFR_OP_HEADER Header
;
1158 typedef struct _EFI_IFR_FALSE
{
1159 EFI_IFR_OP_HEADER Header
;
1162 typedef struct _EFI_IFR_ONE
{
1163 EFI_IFR_OP_HEADER Header
;
1166 typedef struct _EFI_IFR_ONES
{
1167 EFI_IFR_OP_HEADER Header
;
1170 typedef struct _EFI_IFR_ZERO
{
1171 EFI_IFR_OP_HEADER Header
;
1174 typedef struct _EFI_IFR_UNDEFINED
{
1175 EFI_IFR_OP_HEADER Header
;
1176 } EFI_IFR_UNDEFINED
;
1178 typedef struct _EFI_IFR_VERSION
{
1179 EFI_IFR_OP_HEADER Header
;
1182 typedef struct _EFI_IFR_LENGTH
{
1183 EFI_IFR_OP_HEADER Header
;
1186 typedef struct _EFI_IFR_NOT
{
1187 EFI_IFR_OP_HEADER Header
;
1190 typedef struct _EFI_IFR_BITWISE_NOT
{
1191 EFI_IFR_OP_HEADER Header
;
1192 } EFI_IFR_BITWISE_NOT
;
1194 typedef struct _EFI_IFR_TO_BOOLEAN
{
1195 EFI_IFR_OP_HEADER Header
;
1196 } EFI_IFR_TO_BOOLEAN
;
1198 #define EFI_IFR_STRING_UNSIGNED_DEC 0
1199 #define EFI_IFR_STRING_SIGNED_DEC 1
1200 #define EFI_IFR_STRING_LOWERCASE_HEX 2
1201 #define EFI_IFR_STRING_UPPERCASE_HEX 3
1203 #define EFI_IFR_STRING_ASCII 0
1204 #define EFI_IFR_STRING_UNICODE 8
1206 typedef struct _EFI_IFR_TO_STRING
{
1207 EFI_IFR_OP_HEADER Header
;
1209 } EFI_IFR_TO_STRING
;
1211 typedef struct _EFI_IFR_TO_UINT
{
1212 EFI_IFR_OP_HEADER Header
;
1215 typedef struct _EFI_IFR_TO_UPPER
{
1216 EFI_IFR_OP_HEADER Header
;
1219 typedef struct _EFI_IFR_TO_LOWER
{
1220 EFI_IFR_OP_HEADER Header
;
1223 typedef struct _EFI_IFR_ADD
{
1224 EFI_IFR_OP_HEADER Header
;
1227 typedef struct _EFI_IFR_AND
{
1228 EFI_IFR_OP_HEADER Header
;
1231 typedef struct _EFI_IFR_BITWISE_AND
{
1232 EFI_IFR_OP_HEADER Header
;
1233 } EFI_IFR_BITWISE_AND
;
1235 typedef struct _EFI_IFR_BITWISE_OR
{
1236 EFI_IFR_OP_HEADER Header
;
1237 } EFI_IFR_BITWISE_OR
;
1239 typedef struct _EFI_IFR_CATENATE
{
1240 EFI_IFR_OP_HEADER Header
;
1243 typedef struct _EFI_IFR_DIVIDE
{
1244 EFI_IFR_OP_HEADER Header
;
1247 typedef struct _EFI_IFR_EQUAL
{
1248 EFI_IFR_OP_HEADER Header
;
1251 typedef struct _EFI_IFR_GREATER_EQUAL
{
1252 EFI_IFR_OP_HEADER Header
;
1253 } EFI_IFR_GREATER_EQUAL
;
1255 typedef struct _EFI_IFR_GREATER_THAN
{
1256 EFI_IFR_OP_HEADER Header
;
1257 } EFI_IFR_GREATER_THAN
;
1259 typedef struct _EFI_IFR_LESS_EQUAL
{
1260 EFI_IFR_OP_HEADER Header
;
1261 } EFI_IFR_LESS_EQUAL
;
1263 typedef struct _EFI_IFR_LESS_THAN
{
1264 EFI_IFR_OP_HEADER Header
;
1265 } EFI_IFR_LESS_THAN
;
1267 typedef struct _EFI_IFR_MATCH
{
1268 EFI_IFR_OP_HEADER Header
;
1271 typedef struct _EFI_IFR_MULTIPLY
{
1272 EFI_IFR_OP_HEADER Header
;
1275 typedef struct _EFI_IFR_MODULO
{
1276 EFI_IFR_OP_HEADER Header
;
1279 typedef struct _EFI_IFR_NOT_EQUAL
{
1280 EFI_IFR_OP_HEADER Header
;
1281 } EFI_IFR_NOT_EQUAL
;
1283 typedef struct _EFI_IFR_OR
{
1284 EFI_IFR_OP_HEADER Header
;
1287 typedef struct _EFI_IFR_SHIFT_LEFT
{
1288 EFI_IFR_OP_HEADER Header
;
1289 } EFI_IFR_SHIFT_LEFT
;
1291 typedef struct _EFI_IFR_SHIFT_RIGHT
{
1292 EFI_IFR_OP_HEADER Header
;
1293 } EFI_IFR_SHIFT_RIGHT
;
1295 typedef struct _EFI_IFR_SUBTRACT
{
1296 EFI_IFR_OP_HEADER Header
;
1299 typedef struct _EFI_IFR_CONDITIONAL
{
1300 EFI_IFR_OP_HEADER Header
;
1301 } EFI_IFR_CONDITIONAL
;
1303 #define EFI_IFR_FF_CASE_SENSITIVE 0x00
1304 #define EFI_IFR_FF_CASE_INSENSITIVE 0x01
1306 typedef struct _EFI_IFR_FIND
{
1307 EFI_IFR_OP_HEADER Header
;
1311 typedef struct _EFI_IFR_MID
{
1312 EFI_IFR_OP_HEADER Header
;
1315 typedef struct _EFI_IFR_TOKEN
{
1316 EFI_IFR_OP_HEADER Header
;
1319 #define EFI_IFR_FLAGS_FIRST_MATCHING 0x00
1320 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1322 typedef struct _EFI_IFR_SPAN
{
1323 EFI_IFR_OP_HEADER Header
;
1327 typedef struct _EFI_IFR_SECURITY
{
1329 /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
1331 EFI_IFR_OP_HEADER Header
;
1333 /// Security permission level.
1335 EFI_GUID Permissions
;
1338 typedef struct _EFI_IFR_FORM_MAP_METHOD
{
1340 /// The string identifier which provides the human-readable name of
1341 /// the configuration method for this standards map form.
1343 EFI_STRING_ID MethodTitle
;
1345 /// Identifier which uniquely specifies the configuration methods
1346 /// associated with this standards map form.
1348 EFI_GUID MethodIdentifier
;
1349 } EFI_IFR_FORM_MAP_METHOD
;
1351 typedef struct _EFI_IFR_FORM_MAP
{
1353 /// The sequence that defines the type of opcode as well as the length
1354 /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
1356 EFI_IFR_OP_HEADER Header
;
1358 /// The unique identifier for this particular form.
1362 /// One or more configuration method's name and unique identifier.
1364 // EFI_IFR_FORM_MAP_METHOD Methods[];
1367 typedef struct _EFI_IFR_SET
{
1369 /// The sequence that defines the type of opcode as well as the length
1370 /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
1372 EFI_IFR_OP_HEADER Header
;
1374 /// Specifies the identifier of a previously declared variable store to
1375 /// use when storing the question's value.
1377 EFI_VARSTORE_ID VarStoreId
;
1380 /// A 16-bit Buffer Storage offset.
1382 EFI_STRING_ID VarName
;
1384 /// A Name Value or EFI Variable name (VarName).
1389 /// Specifies the type used for storage.
1394 typedef struct _EFI_IFR_GET
{
1396 /// The sequence that defines the type of opcode as well as the length
1397 /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
1399 EFI_IFR_OP_HEADER Header
;
1401 /// Specifies the identifier of a previously declared variable store to
1402 /// use when retrieving the value.
1404 EFI_VARSTORE_ID VarStoreId
;
1407 /// A 16-bit Buffer Storage offset.
1409 EFI_STRING_ID VarName
;
1411 /// A Name Value or EFI Variable name (VarName).
1416 /// Specifies the type used for storage.
1421 typedef struct _EFI_IFR_READ
{
1422 EFI_IFR_OP_HEADER Header
;
1425 typedef struct _EFI_IFR_WRITE
{
1426 EFI_IFR_OP_HEADER Header
;
1429 typedef struct _EFI_IFR_MAP
{
1430 EFI_IFR_OP_HEADER Header
;
1547 CHAR16 ShiftedUnicode
;
1548 CHAR16 AltGrUnicode
;
1549 CHAR16 ShiftedAltGrUnicode
;
1551 UINT16 AffectedAttribute
;
1552 } EFI_KEY_DESCRIPTOR
;
1555 // A key which is affected by all the standard shift modifiers.
1556 // Most keys would be expected to have this bit active.
1558 #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
1560 // This key is affected by the caps lock so that if a keyboard driver
1561 // would need to disambiguate between a key which had a "1" defined
1562 // versus a "a" character. Having this bit turned on would tell
1563 // the keyboard driver to use the appropriate shifted state or not.
1565 #define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
1567 // Similar to the case of CAPS lock, if this bit is active, the key
1568 // is affected by the num lock being turned on.
1570 #define EFI_AFFECTED_BY_NUM_LOCK 0x0004
1573 UINT16 LayoutLength
;
1575 UINT32 LayoutDescriptorStringOffset
;
1576 UINT8 DescriptorCount
;
1577 // EFI_KEY_DESCRIPTOR Descriptors[];
1578 } EFI_HII_KEYBOARD_LAYOUT
;
1581 EFI_HII_PACKAGE_HEADER Header
;
1583 // EFI_HII_KEYBOARD_LAYOUT Layout[];
1584 } EFI_HII_KEYBOARD_PACKAGE_HDR
;
1589 CHAR16 DescriptionString
[1];
1590 } EFI_DESCRIPTION_STRING
;
1593 UINT16 DescriptionCount
;
1594 EFI_DESCRIPTION_STRING DescriptionString
[1];
1595 } EFI_DESCRIPTION_STRING_BUNDLE
;
1600 #define EFI_NULL_MODIFIER 0x0000
1601 #define EFI_LEFT_CONTROL_MODIFIER 0x0001
1602 #define EFI_RIGHT_CONTROL_MODIFIER 0x0002
1603 #define EFI_LEFT_ALT_MODIFIER 0x0003
1604 #define EFI_RIGHT_ALT_MODIFIER 0x0004
1605 #define EFI_ALT_GR_MODIFIER 0x0005
1606 #define EFI_INSERT_MODIFIER 0x0006
1607 #define EFI_DELETE_MODIFIER 0x0007
1608 #define EFI_PAGE_DOWN_MODIFIER 0x0008
1609 #define EFI_PAGE_UP_MODIFIER 0x0009
1610 #define EFI_HOME_MODIFIER 0x000A
1611 #define EFI_END_MODIFIER 0x000B
1612 #define EFI_LEFT_SHIFT_MODIFIER 0x000C
1613 #define EFI_RIGHT_SHIFT_MODIFIER 0x000D
1614 #define EFI_CAPS_LOCK_MODIFIER 0x000E
1615 #define EFI_NUM_LOCK _MODIFIER 0x000F
1616 #define EFI_LEFT_ARROW_MODIFIER 0x0010
1617 #define EFI_RIGHT_ARROW_MODIFIER 0x0011
1618 #define EFI_DOWN_ARROW_MODIFIER 0x0012
1619 #define EFI_UP_ARROW_MODIFIER 0x0013
1620 #define EFI_NS_KEY_MODIFIER 0x0014
1621 #define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015
1622 #define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016
1623 #define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017
1624 #define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018
1625 #define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019
1626 #define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A
1627 #define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B
1628 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C
1629 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D
1630 #define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E
1631 #define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F
1632 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1633 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1636 // Keys that have multiple control functions based on modifier
1637 // settings are handled in the keyboard driver implementation.
1638 // For instance PRINT_KEY might have a modifier held down and
1639 // is still a nonprinting character, but might have an alternate
1640 // control function like SYSREQUEST
1642 #define EFI_PRINT_MODIFIER 0x0022
1643 #define EFI_SYS_REQUEST_MODIFIER 0x0023
1644 #define EFI_SCROLL_LOCK_MODIFIER 0x0024
1645 #define EFI_PAUSE_MODIFIER 0x0025
1646 #define EFI_BREAK_MODIFIER 0x0026
1653 // References to string tokens must use this macro to enable scanning for
1657 // STRING_TOKEN is not defined in UEFI specification. But it is placed
1658 // here for the easy access by C files and VFR source files.
1660 #define STRING_TOKEN(t) t