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 Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials are licensed and made available under
8 the terms and conditions of the BSD License that accompanies this distribution.
9 The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php.
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 @par Revision Reference:
16 These definitions are from UEFI 2.1 and 2.2.
20 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__
21 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__
23 #include <Guid/HiiFormMapMethodGuid.h>
26 /// The following types are currently defined:
28 typedef VOID
* EFI_HII_HANDLE
;
29 typedef CHAR16
* EFI_STRING
;
30 typedef UINT16 EFI_IMAGE_ID
;
31 typedef UINT16 EFI_QUESTION_ID
;
32 typedef UINT16 EFI_STRING_ID
;
33 typedef UINT16 EFI_FORM_ID
;
34 typedef UINT16 EFI_VARSTORE_ID
;
35 typedef UINT16 EFI_ANIMATION_ID
;
37 typedef UINT16 EFI_DEFAULT_ID
;
39 typedef UINT32 EFI_HII_FONT_STYLE
;
46 // Definitions for Package Lists and Package Headers
51 /// The header found at the start of each package list.
54 EFI_GUID PackageListGuid
;
56 } EFI_HII_PACKAGE_LIST_HEADER
;
59 /// The header found at the start of each package.
65 } EFI_HII_PACKAGE_HEADER
;
68 // Value of HII package type
70 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
71 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
72 #define EFI_HII_PACKAGE_FORMS 0x02
73 #define EFI_HII_PACKAGE_STRINGS 0x04
74 #define EFI_HII_PACKAGE_FONTS 0x05
75 #define EFI_HII_PACKAGE_IMAGES 0x06
76 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
77 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
78 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
79 #define EFI_HII_PACKAGE_ANIMATIONS 0x0A
80 #define EFI_HII_PACKAGE_END 0xDF
81 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
82 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
85 // Definitions for Simplified Font Package
89 /// Contents of EFI_NARROW_GLYPH.Attributes.
91 #define EFI_GLYPH_NON_SPACING 0x01
92 #define EFI_GLYPH_WIDE 0x02
93 #define EFI_GLYPH_HEIGHT 19
94 #define EFI_GLYPH_WIDTH 8
98 /// The EFI_NARROW_GLYPH has a preferred dimension (w x h) of 8 x 19 pixels.
102 /// The Unicode representation of the glyph. The term weight is the
103 /// technical term for a character code.
105 CHAR16 UnicodeWeight
;
107 /// The data element containing the glyph definitions.
111 /// The column major glyph representation of the character. Bits
112 /// with values of one indicate that the corresponding pixel is to be
113 /// on when normally displayed; those with zero are off.
115 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
119 /// The EFI_WIDE_GLYPH has a preferred dimension (w x h) of 16 x 19 pixels, which is large enough
120 /// to accommodate logographic characters.
124 /// The Unicode representation of the glyph. The term weight is the
125 /// technical term for a character code.
127 CHAR16 UnicodeWeight
;
129 /// The data element containing the glyph definitions.
133 /// The column major glyph representation of the character. Bits
134 /// with values of one indicate that the corresponding pixel is to be
135 /// on when normally displayed; those with zero are off.
137 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
139 /// The column major glyph representation of the character. Bits
140 /// with values of one indicate that the corresponding pixel is to be
141 /// on when normally displayed; those with zero are off.
143 UINT8 GlyphCol2
[EFI_GLYPH_HEIGHT
];
145 /// Ensures that sizeof (EFI_WIDE_GLYPH) is twice the
146 /// sizeof (EFI_NARROW_GLYPH). The contents of Pad must
153 /// A simplified font package consists of a font header
154 /// followed by a series of glyph structures.
156 typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR
{
157 EFI_HII_PACKAGE_HEADER Header
;
158 UINT16 NumberOfNarrowGlyphs
;
159 UINT16 NumberOfWideGlyphs
;
160 // EFI_NARROW_GLYPH NarrowGlyphs[];
161 // EFI_WIDE_GLYPH WideGlyphs[];
162 } EFI_HII_SIMPLE_FONT_PACKAGE_HDR
;
165 // Definitions for Font Package
170 // Value for font style
172 #define EFI_HII_FONT_STYLE_NORMAL 0x00000000
173 #define EFI_HII_FONT_STYLE_BOLD 0x00000001
174 #define EFI_HII_FONT_STYLE_ITALIC 0x00000002
175 #define EFI_HII_FONT_STYLE_EMBOSS 0x00010000
176 #define EFI_HII_FONT_STYLE_OUTLINE 0x00020000
177 #define EFI_HII_FONT_STYLE_SHADOW 0x00040000
178 #define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000
179 #define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000
181 typedef struct _EFI_HII_GLYPH_INFO
{
187 } EFI_HII_GLYPH_INFO
;
190 /// The fixed header consists of a standard record header,
191 /// then the character values in this section, the flags
192 /// (including the encoding method) and the offsets of the glyph
193 /// information, the glyph bitmaps and the character map.
195 typedef struct _EFI_HII_FONT_PACKAGE_HDR
{
196 EFI_HII_PACKAGE_HEADER Header
;
198 UINT32 GlyphBlockOffset
;
199 EFI_HII_GLYPH_INFO Cell
;
200 EFI_HII_FONT_STYLE FontStyle
;
201 CHAR16 FontFamily
[1];
202 } EFI_HII_FONT_PACKAGE_HDR
;
205 // Value of different glyph info block types
207 #define EFI_HII_GIBT_END 0x00
208 #define EFI_HII_GIBT_GLYPH 0x10
209 #define EFI_HII_GIBT_GLYPHS 0x11
210 #define EFI_HII_GIBT_GLYPH_DEFAULT 0x12
211 #define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13
212 #define EFI_HII_GIBT_DUPLICATE 0x20
213 #define EFI_HII_GIBT_SKIP2 0x21
214 #define EFI_HII_GIBT_SKIP1 0x22
215 #define EFI_HII_GIBT_DEFAULTS 0x23
216 #define EFI_HII_GIBT_EXT1 0x30
217 #define EFI_HII_GIBT_EXT2 0x31
218 #define EFI_HII_GIBT_EXT4 0x32
220 typedef struct _EFI_HII_GLYPH_BLOCK
{
222 } EFI_HII_GLYPH_BLOCK
;
225 // Definition of different glyph info block types
228 typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK
{
229 EFI_HII_GLYPH_BLOCK Header
;
230 EFI_HII_GLYPH_INFO Cell
;
231 } EFI_HII_GIBT_DEFAULTS_BLOCK
;
233 typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK
{
234 EFI_HII_GLYPH_BLOCK Header
;
236 } EFI_HII_GIBT_DUPLICATE_BLOCK
;
238 typedef struct _EFI_GLYPH_GIBT_END_BLOCK
{
239 EFI_HII_GLYPH_BLOCK Header
;
240 } EFI_GLYPH_GIBT_END_BLOCK
;
242 typedef struct _EFI_HII_GIBT_EXT1_BLOCK
{
243 EFI_HII_GLYPH_BLOCK Header
;
246 } EFI_HII_GIBT_EXT1_BLOCK
;
248 typedef struct _EFI_HII_GIBT_EXT2_BLOCK
{
249 EFI_HII_GLYPH_BLOCK Header
;
252 } EFI_HII_GIBT_EXT2_BLOCK
;
254 typedef struct _EFI_HII_GIBT_EXT4_BLOCK
{
255 EFI_HII_GLYPH_BLOCK Header
;
258 } EFI_HII_GIBT_EXT4_BLOCK
;
260 typedef struct _EFI_HII_GIBT_GLYPH_BLOCK
{
261 EFI_HII_GLYPH_BLOCK Header
;
262 EFI_HII_GLYPH_INFO Cell
;
264 } EFI_HII_GIBT_GLYPH_BLOCK
;
266 typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK
{
267 EFI_HII_GLYPH_BLOCK Header
;
268 EFI_HII_GLYPH_INFO Cell
;
271 } EFI_HII_GIBT_GLYPHS_BLOCK
;
273 typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
{
274 EFI_HII_GLYPH_BLOCK Header
;
276 } EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
;
278 typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
{
279 EFI_HII_GLYPH_BLOCK Header
;
282 } EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
;
284 typedef struct _EFI_HII_GIBT_SKIP1_BLOCK
{
285 EFI_HII_GLYPH_BLOCK Header
;
287 } EFI_HII_GIBT_SKIP1_BLOCK
;
289 typedef struct _EFI_HII_GIBT_SKIP2_BLOCK
{
290 EFI_HII_GLYPH_BLOCK Header
;
292 } EFI_HII_GIBT_SKIP2_BLOCK
;
295 // Definitions for Device Path Package
300 /// The device path package is used to carry a device path
301 /// associated with the package list.
303 typedef struct _EFI_HII_DEVICE_PATH_PACKAGE_HDR
{
304 EFI_HII_PACKAGE_HEADER Header
;
305 // EFI_DEVICE_PATH_PROTOCOL DevicePath[];
306 } EFI_HII_DEVICE_PATH_PACKAGE_HDR
;
309 // Definitions for GUID Package
314 /// The GUID package is used to carry data where the format is defined by a GUID.
316 typedef struct _EFI_HII_GUID_PACKAGE_HDR
{
317 EFI_HII_PACKAGE_HEADER Header
;
319 // Data per GUID definition may follow
320 } EFI_HII_GUID_PACKAGE_HDR
;
323 // Definitions for String Package
327 #define UEFI_CONFIG_LANG "x-UEFI"
328 #define UEFI_CONFIG_LANG_2 "x-i-UEFI"
331 /// The fixed header consists of a standard record header and then the string identifiers
332 /// contained in this section and the offsets of the string and language information.
334 typedef struct _EFI_HII_STRING_PACKAGE_HDR
{
335 EFI_HII_PACKAGE_HEADER Header
;
337 UINT32 StringInfoOffset
;
338 CHAR16 LanguageWindow
[16];
339 EFI_STRING_ID LanguageName
;
341 } EFI_HII_STRING_PACKAGE_HDR
;
345 } EFI_HII_STRING_BLOCK
;
348 // Value of different string information block types
350 #define EFI_HII_SIBT_END 0x00
351 #define EFI_HII_SIBT_STRING_SCSU 0x10
352 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
353 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
354 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
355 #define EFI_HII_SIBT_STRING_UCS2 0x14
356 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
357 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
358 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
359 #define EFI_HII_SIBT_DUPLICATE 0x20
360 #define EFI_HII_SIBT_SKIP2 0x21
361 #define EFI_HII_SIBT_SKIP1 0x22
362 #define EFI_HII_SIBT_EXT1 0x30
363 #define EFI_HII_SIBT_EXT2 0x31
364 #define EFI_HII_SIBT_EXT4 0x32
365 #define EFI_HII_SIBT_FONT 0x40
368 // Definition of different string information block types
371 typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK
{
372 EFI_HII_STRING_BLOCK Header
;
373 EFI_STRING_ID StringId
;
374 } EFI_HII_SIBT_DUPLICATE_BLOCK
;
376 typedef struct _EFI_HII_SIBT_END_BLOCK
{
377 EFI_HII_STRING_BLOCK Header
;
378 } EFI_HII_SIBT_END_BLOCK
;
380 typedef struct _EFI_HII_SIBT_EXT1_BLOCK
{
381 EFI_HII_STRING_BLOCK Header
;
384 } EFI_HII_SIBT_EXT1_BLOCK
;
386 typedef struct _EFI_HII_SIBT_EXT2_BLOCK
{
387 EFI_HII_STRING_BLOCK Header
;
390 } EFI_HII_SIBT_EXT2_BLOCK
;
392 typedef struct _EFI_HII_SIBT_EXT4_BLOCK
{
393 EFI_HII_STRING_BLOCK Header
;
396 } EFI_HII_SIBT_EXT4_BLOCK
;
398 typedef struct _EFI_HII_SIBT_FONT_BLOCK
{
399 EFI_HII_SIBT_EXT2_BLOCK Header
;
402 EFI_HII_FONT_STYLE FontStyle
;
404 } EFI_HII_SIBT_FONT_BLOCK
;
406 typedef struct _EFI_HII_SIBT_SKIP1_BLOCK
{
407 EFI_HII_STRING_BLOCK Header
;
409 } EFI_HII_SIBT_SKIP1_BLOCK
;
411 typedef struct _EFI_HII_SIBT_SKIP2_BLOCK
{
412 EFI_HII_STRING_BLOCK Header
;
414 } EFI_HII_SIBT_SKIP2_BLOCK
;
416 typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK
{
417 EFI_HII_STRING_BLOCK Header
;
419 } EFI_HII_SIBT_STRING_SCSU_BLOCK
;
421 typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
{
422 EFI_HII_STRING_BLOCK Header
;
423 UINT8 FontIdentifier
;
425 } EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
;
427 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK
{
428 EFI_HII_STRING_BLOCK Header
;
431 } EFI_HII_SIBT_STRINGS_SCSU_BLOCK
;
433 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
{
434 EFI_HII_STRING_BLOCK Header
;
435 UINT8 FontIdentifier
;
438 } EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
;
440 typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK
{
441 EFI_HII_STRING_BLOCK Header
;
442 CHAR16 StringText
[1];
443 } EFI_HII_SIBT_STRING_UCS2_BLOCK
;
445 typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
{
446 EFI_HII_STRING_BLOCK Header
;
447 UINT8 FontIdentifier
;
448 CHAR16 StringText
[1];
449 } EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
;
451 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK
{
452 EFI_HII_STRING_BLOCK Header
;
454 CHAR16 StringText
[1];
455 } EFI_HII_SIBT_STRINGS_UCS2_BLOCK
;
457 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
{
458 EFI_HII_STRING_BLOCK Header
;
459 UINT8 FontIdentifier
;
461 CHAR16 StringText
[1];
462 } EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
;
465 // Definitions for Image Package
469 typedef struct _EFI_HII_IMAGE_PACKAGE_HDR
{
470 EFI_HII_PACKAGE_HEADER Header
;
471 UINT32 ImageInfoOffset
;
472 UINT32 PaletteInfoOffset
;
473 } EFI_HII_IMAGE_PACKAGE_HDR
;
475 typedef struct _EFI_HII_IMAGE_BLOCK
{
477 } EFI_HII_IMAGE_BLOCK
;
480 // Value of different image information block types
482 #define EFI_HII_IIBT_END 0x00
483 #define EFI_HII_IIBT_IMAGE_1BIT 0x10
484 #define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11
485 #define EFI_HII_IIBT_IMAGE_4BIT 0x12
486 #define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13
487 #define EFI_HII_IIBT_IMAGE_8BIT 0x14
488 #define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15
489 #define EFI_HII_IIBT_IMAGE_24BIT 0x16
490 #define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17
491 #define EFI_HII_IIBT_IMAGE_JPEG 0x18
492 #define EFI_HII_IIBT_DUPLICATE 0x20
493 #define EFI_HII_IIBT_SKIP2 0x21
494 #define EFI_HII_IIBT_SKIP1 0x22
495 #define EFI_HII_IIBT_EXT1 0x30
496 #define EFI_HII_IIBT_EXT2 0x31
497 #define EFI_HII_IIBT_EXT4 0x32
500 // Definition of different image information block types
503 typedef struct _EFI_HII_IIBT_END_BLOCK
{
504 EFI_HII_IMAGE_BLOCK Header
;
505 } EFI_HII_IIBT_END_BLOCK
;
507 typedef struct _EFI_HII_IIBT_EXT1_BLOCK
{
508 EFI_HII_IMAGE_BLOCK Header
;
511 } EFI_HII_IIBT_EXT1_BLOCK
;
513 typedef struct _EFI_HII_IIBT_EXT2_BLOCK
{
514 EFI_HII_IMAGE_BLOCK Header
;
517 } EFI_HII_IIBT_EXT2_BLOCK
;
519 typedef struct _EFI_HII_IIBT_EXT4_BLOCK
{
520 EFI_HII_IMAGE_BLOCK Header
;
523 } EFI_HII_IIBT_EXT4_BLOCK
;
525 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE
{
529 } EFI_HII_IIBT_IMAGE_1BIT_BASE
;
531 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK
{
532 EFI_HII_IMAGE_BLOCK Header
;
534 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
535 } EFI_HII_IIBT_IMAGE_1BIT_BLOCK
;
537 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
{
538 EFI_HII_IMAGE_BLOCK Header
;
540 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
541 } EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
;
543 typedef struct _EFI_HII_RGB_PIXEL
{
549 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE
{
552 EFI_HII_RGB_PIXEL Bitmap
[1];
553 } EFI_HII_IIBT_IMAGE_24BIT_BASE
;
555 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK
{
556 EFI_HII_IMAGE_BLOCK Header
;
557 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
558 } EFI_HII_IIBT_IMAGE_24BIT_BLOCK
;
560 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
{
561 EFI_HII_IMAGE_BLOCK Header
;
562 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
563 } EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
;
565 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE
{
569 } EFI_HII_IIBT_IMAGE_4BIT_BASE
;
571 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK
{
572 EFI_HII_IMAGE_BLOCK Header
;
574 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
575 } EFI_HII_IIBT_IMAGE_4BIT_BLOCK
;
577 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
{
578 EFI_HII_IMAGE_BLOCK Header
;
580 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
581 } EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
;
583 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE
{
587 } EFI_HII_IIBT_IMAGE_8BIT_BASE
;
589 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK
{
590 EFI_HII_IMAGE_BLOCK Header
;
592 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
593 } EFI_HII_IIBT_IMAGE_8BIT_BLOCK
;
595 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK
{
596 EFI_HII_IMAGE_BLOCK Header
;
598 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
599 } EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK
;
601 typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK
{
602 EFI_HII_IMAGE_BLOCK Header
;
603 EFI_IMAGE_ID ImageId
;
604 } EFI_HII_IIBT_DUPLICATE_BLOCK
;
606 typedef struct _EFI_HII_IIBT_JPEG_BLOCK
{
607 EFI_HII_IMAGE_BLOCK Header
;
610 } EFI_HII_IIBT_JPEG_BLOCK
;
612 typedef struct _EFI_HII_IIBT_SKIP1_BLOCK
{
613 EFI_HII_IMAGE_BLOCK Header
;
615 } EFI_HII_IIBT_SKIP1_BLOCK
;
617 typedef struct _EFI_HII_IIBT_SKIP2_BLOCK
{
618 EFI_HII_IMAGE_BLOCK Header
;
620 } EFI_HII_IIBT_SKIP2_BLOCK
;
623 // Definitions for Palette Information
626 typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER
{
628 } EFI_HII_IMAGE_PALETTE_INFO_HEADER
;
630 typedef struct _EFI_HII_IMAGE_PALETTE_INFO
{
632 EFI_HII_RGB_PIXEL PaletteValue
[1];
633 } EFI_HII_IMAGE_PALETTE_INFO
;
636 // Definitions for Forms Package
641 /// The Form package is used to carry form-based encoding data.
643 typedef struct _EFI_HII_FORM_PACKAGE_HDR
{
644 EFI_HII_PACKAGE_HEADER Header
;
645 // EFI_IFR_OP_HEADER OpCodeHeader;
646 // More op-codes follow
647 } EFI_HII_FORM_PACKAGE_HDR
;
662 EFI_QUESTION_ID QuestionId
;
664 EFI_GUID FormSetGuid
;
665 EFI_STRING_ID DevicePath
;
676 EFI_STRING_ID string
; ///< EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
677 EFI_HII_REF ref
; ///< EFI_IFR_TYPE_REF
678 // UINT8 buffer[]; ///< EFI_IFR_TYPE_BUFFER
679 } EFI_IFR_TYPE_VALUE
;
684 #define EFI_IFR_FORM_OP 0x01
685 #define EFI_IFR_SUBTITLE_OP 0x02
686 #define EFI_IFR_TEXT_OP 0x03
687 #define EFI_IFR_IMAGE_OP 0x04
688 #define EFI_IFR_ONE_OF_OP 0x05
689 #define EFI_IFR_CHECKBOX_OP 0x06
690 #define EFI_IFR_NUMERIC_OP 0x07
691 #define EFI_IFR_PASSWORD_OP 0x08
692 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
693 #define EFI_IFR_SUPPRESS_IF_OP 0x0A
694 #define EFI_IFR_LOCKED_OP 0x0B
695 #define EFI_IFR_ACTION_OP 0x0C
696 #define EFI_IFR_RESET_BUTTON_OP 0x0D
697 #define EFI_IFR_FORM_SET_OP 0x0E
698 #define EFI_IFR_REF_OP 0x0F
699 #define EFI_IFR_NO_SUBMIT_IF_OP 0x10
700 #define EFI_IFR_INCONSISTENT_IF_OP 0x11
701 #define EFI_IFR_EQ_ID_VAL_OP 0x12
702 #define EFI_IFR_EQ_ID_ID_OP 0x13
703 #define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14
704 #define EFI_IFR_AND_OP 0x15
705 #define EFI_IFR_OR_OP 0x16
706 #define EFI_IFR_NOT_OP 0x17
707 #define EFI_IFR_RULE_OP 0x18
708 #define EFI_IFR_GRAY_OUT_IF_OP 0x19
709 #define EFI_IFR_DATE_OP 0x1A
710 #define EFI_IFR_TIME_OP 0x1B
711 #define EFI_IFR_STRING_OP 0x1C
712 #define EFI_IFR_REFRESH_OP 0x1D
713 #define EFI_IFR_DISABLE_IF_OP 0x1E
714 #define EFI_IFR_ANIMATION_OP 0x1F
715 #define EFI_IFR_TO_LOWER_OP 0x20
716 #define EFI_IFR_TO_UPPER_OP 0x21
717 #define EFI_IFR_MAP_OP 0x22
718 #define EFI_IFR_ORDERED_LIST_OP 0x23
719 #define EFI_IFR_VARSTORE_OP 0x24
720 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
721 #define EFI_IFR_VARSTORE_EFI_OP 0x26
722 #define EFI_IFR_VARSTORE_DEVICE_OP 0x27
723 #define EFI_IFR_VERSION_OP 0x28
724 #define EFI_IFR_END_OP 0x29
725 #define EFI_IFR_MATCH_OP 0x2A
726 #define EFI_IFR_GET_OP 0x2B
727 #define EFI_IFR_SET_OP 0x2C
728 #define EFI_IFR_READ_OP 0x2D
729 #define EFI_IFR_WRITE_OP 0x2E
730 #define EFI_IFR_EQUAL_OP 0x2F
731 #define EFI_IFR_NOT_EQUAL_OP 0x30
732 #define EFI_IFR_GREATER_THAN_OP 0x31
733 #define EFI_IFR_GREATER_EQUAL_OP 0x32
734 #define EFI_IFR_LESS_THAN_OP 0x33
735 #define EFI_IFR_LESS_EQUAL_OP 0x34
736 #define EFI_IFR_BITWISE_AND_OP 0x35
737 #define EFI_IFR_BITWISE_OR_OP 0x36
738 #define EFI_IFR_BITWISE_NOT_OP 0x37
739 #define EFI_IFR_SHIFT_LEFT_OP 0x38
740 #define EFI_IFR_SHIFT_RIGHT_OP 0x39
741 #define EFI_IFR_ADD_OP 0x3A
742 #define EFI_IFR_SUBTRACT_OP 0x3B
743 #define EFI_IFR_MULTIPLY_OP 0x3C
744 #define EFI_IFR_DIVIDE_OP 0x3D
745 #define EFI_IFR_MODULO_OP 0x3E
746 #define EFI_IFR_RULE_REF_OP 0x3F
747 #define EFI_IFR_QUESTION_REF1_OP 0x40
748 #define EFI_IFR_QUESTION_REF2_OP 0x41
749 #define EFI_IFR_UINT8_OP 0x42
750 #define EFI_IFR_UINT16_OP 0x43
751 #define EFI_IFR_UINT32_OP 0x44
752 #define EFI_IFR_UINT64_OP 0x45
753 #define EFI_IFR_TRUE_OP 0x46
754 #define EFI_IFR_FALSE_OP 0x47
755 #define EFI_IFR_TO_UINT_OP 0x48
756 #define EFI_IFR_TO_STRING_OP 0x49
757 #define EFI_IFR_TO_BOOLEAN_OP 0x4A
758 #define EFI_IFR_MID_OP 0x4B
759 #define EFI_IFR_FIND_OP 0x4C
760 #define EFI_IFR_TOKEN_OP 0x4D
761 #define EFI_IFR_STRING_REF1_OP 0x4E
762 #define EFI_IFR_STRING_REF2_OP 0x4F
763 #define EFI_IFR_CONDITIONAL_OP 0x50
764 #define EFI_IFR_QUESTION_REF3_OP 0x51
765 #define EFI_IFR_ZERO_OP 0x52
766 #define EFI_IFR_ONE_OP 0x53
767 #define EFI_IFR_ONES_OP 0x54
768 #define EFI_IFR_UNDEFINED_OP 0x55
769 #define EFI_IFR_LENGTH_OP 0x56
770 #define EFI_IFR_DUP_OP 0x57
771 #define EFI_IFR_THIS_OP 0x58
772 #define EFI_IFR_SPAN_OP 0x59
773 #define EFI_IFR_VALUE_OP 0x5A
774 #define EFI_IFR_DEFAULT_OP 0x5B
775 #define EFI_IFR_DEFAULTSTORE_OP 0x5C
776 #define EFI_IFR_FORM_MAP_OP 0x5D
777 #define EFI_IFR_CATENATE_OP 0x5E
778 #define EFI_IFR_GUID_OP 0x5F
779 #define EFI_IFR_SECURITY_OP 0x60
780 #define EFI_IFR_MODAL_TAG_OP 0x61
781 #define EFI_IFR_REFRESH_ID_OP 0x62
784 // Definitions of IFR Standard Headers
788 typedef struct _EFI_IFR_OP_HEADER
{
794 typedef struct _EFI_IFR_STATEMENT_HEADER
{
795 EFI_STRING_ID Prompt
;
797 } EFI_IFR_STATEMENT_HEADER
;
799 typedef struct _EFI_IFR_QUESTION_HEADER
{
800 EFI_IFR_STATEMENT_HEADER Header
;
801 EFI_QUESTION_ID QuestionId
;
802 EFI_VARSTORE_ID VarStoreId
;
804 EFI_STRING_ID VarName
;
808 } EFI_IFR_QUESTION_HEADER
;
811 // Flag values of EFI_IFR_QUESTION_HEADER
813 #define EFI_IFR_FLAG_READ_ONLY 0x01
814 #define EFI_IFR_FLAG_CALLBACK 0x04
815 #define EFI_IFR_FLAG_RESET_REQUIRED 0x10
816 #define EFI_IFR_FLAG_OPTIONS_ONLY 0x80
819 // Definition for Opcode Reference
822 typedef struct _EFI_IFR_DEFAULTSTORE
{
823 EFI_IFR_OP_HEADER Header
;
824 EFI_STRING_ID DefaultName
;
826 } EFI_IFR_DEFAULTSTORE
;
829 // Default Identifier of default store
831 #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000
832 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001
833 #define EFI_HII_DEFAULT_CLASS_SAFE 0x0002
834 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
835 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff
836 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
837 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff
838 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
839 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff
841 typedef struct _EFI_IFR_VARSTORE
{
842 EFI_IFR_OP_HEADER Header
;
844 EFI_VARSTORE_ID VarStoreId
;
849 typedef struct _EFI_IFR_VARSTORE_EFI
{
850 EFI_IFR_OP_HEADER Header
;
851 EFI_VARSTORE_ID VarStoreId
;
856 } EFI_IFR_VARSTORE_EFI
;
858 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE
{
859 EFI_IFR_OP_HEADER Header
;
860 EFI_VARSTORE_ID VarStoreId
;
862 } EFI_IFR_VARSTORE_NAME_VALUE
;
864 typedef struct _EFI_IFR_FORM_SET
{
865 EFI_IFR_OP_HEADER Header
;
867 EFI_STRING_ID FormSetTitle
;
870 // EFI_GUID ClassGuid[];
873 typedef struct _EFI_IFR_END
{
874 EFI_IFR_OP_HEADER Header
;
877 typedef struct _EFI_IFR_FORM
{
878 EFI_IFR_OP_HEADER Header
;
880 EFI_STRING_ID FormTitle
;
883 typedef struct _EFI_IFR_IMAGE
{
884 EFI_IFR_OP_HEADER Header
;
888 typedef struct _EFI_IFR_MODAL
{
889 EFI_IFR_OP_HEADER Header
;
892 typedef struct _EFI_IFR_LOCKED
{
893 EFI_IFR_OP_HEADER Header
;
896 typedef struct _EFI_IFR_RULE
{
897 EFI_IFR_OP_HEADER Header
;
901 typedef struct _EFI_IFR_DEFAULT
{
902 EFI_IFR_OP_HEADER Header
;
905 EFI_IFR_TYPE_VALUE Value
;
908 typedef struct _EFI_IFR_DEFAULT_2
{
909 EFI_IFR_OP_HEADER Header
;
914 typedef struct _EFI_IFR_VALUE
{
915 EFI_IFR_OP_HEADER Header
;
918 typedef struct _EFI_IFR_SUBTITLE
{
919 EFI_IFR_OP_HEADER Header
;
920 EFI_IFR_STATEMENT_HEADER Statement
;
924 #define EFI_IFR_FLAGS_HORIZONTAL 0x01
926 typedef struct _EFI_IFR_CHECKBOX
{
927 EFI_IFR_OP_HEADER Header
;
928 EFI_IFR_QUESTION_HEADER Question
;
932 #define EFI_IFR_CHECKBOX_DEFAULT 0x01
933 #define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02
935 typedef struct _EFI_IFR_TEXT
{
936 EFI_IFR_OP_HEADER Header
;
937 EFI_IFR_STATEMENT_HEADER Statement
;
938 EFI_STRING_ID TextTwo
;
941 typedef struct _EFI_IFR_REF
{
942 EFI_IFR_OP_HEADER Header
;
943 EFI_IFR_QUESTION_HEADER Question
;
947 typedef struct _EFI_IFR_REF2
{
948 EFI_IFR_OP_HEADER Header
;
949 EFI_IFR_QUESTION_HEADER Question
;
951 EFI_QUESTION_ID QuestionId
;
954 typedef struct _EFI_IFR_REF3
{
955 EFI_IFR_OP_HEADER Header
;
956 EFI_IFR_QUESTION_HEADER Question
;
958 EFI_QUESTION_ID QuestionId
;
962 typedef struct _EFI_IFR_REF4
{
963 EFI_IFR_OP_HEADER Header
;
964 EFI_IFR_QUESTION_HEADER Question
;
966 EFI_QUESTION_ID QuestionId
;
968 EFI_STRING_ID DevicePath
;
971 typedef struct _EFI_IFR_REF5
{
972 EFI_IFR_OP_HEADER Header
;
973 EFI_IFR_QUESTION_HEADER Question
;
976 typedef struct _EFI_IFR_RESET_BUTTON
{
977 EFI_IFR_OP_HEADER Header
;
978 EFI_IFR_STATEMENT_HEADER Statement
;
979 EFI_DEFAULT_ID DefaultId
;
980 } EFI_IFR_RESET_BUTTON
;
982 typedef struct _EFI_IFR_ACTION
{
983 EFI_IFR_OP_HEADER Header
;
984 EFI_IFR_QUESTION_HEADER Question
;
985 EFI_STRING_ID QuestionConfig
;
988 typedef struct _EFI_IFR_ACTION_1
{
989 EFI_IFR_OP_HEADER Header
;
990 EFI_IFR_QUESTION_HEADER Question
;
993 typedef struct _EFI_IFR_DATE
{
994 EFI_IFR_OP_HEADER Header
;
995 EFI_IFR_QUESTION_HEADER Question
;
1000 // Flags that describe the behavior of the question.
1002 #define EFI_QF_DATE_YEAR_SUPPRESS 0x01
1003 #define EFI_QF_DATE_MONTH_SUPPRESS 0x02
1004 #define EFI_QF_DATE_DAY_SUPPRESS 0x04
1006 #define EFI_QF_DATE_STORAGE 0x30
1007 #define QF_DATE_STORAGE_NORMAL 0x00
1008 #define QF_DATE_STORAGE_TIME 0x10
1009 #define QF_DATE_STORAGE_WAKEUP 0x20
1034 typedef struct _EFI_IFR_NUMERIC
{
1035 EFI_IFR_OP_HEADER Header
;
1036 EFI_IFR_QUESTION_HEADER Question
;
1038 MINMAXSTEP_DATA data
;
1042 // Flags related to the numeric question
1044 #define EFI_IFR_NUMERIC_SIZE 0x03
1045 #define EFI_IFR_NUMERIC_SIZE_1 0x00
1046 #define EFI_IFR_NUMERIC_SIZE_2 0x01
1047 #define EFI_IFR_NUMERIC_SIZE_4 0x02
1048 #define EFI_IFR_NUMERIC_SIZE_8 0x03
1050 #define EFI_IFR_DISPLAY 0x30
1051 #define EFI_IFR_DISPLAY_INT_DEC 0x00
1052 #define EFI_IFR_DISPLAY_UINT_DEC 0x10
1053 #define EFI_IFR_DISPLAY_UINT_HEX 0x20
1055 typedef struct _EFI_IFR_ONE_OF
{
1056 EFI_IFR_OP_HEADER Header
;
1057 EFI_IFR_QUESTION_HEADER Question
;
1059 MINMAXSTEP_DATA data
;
1062 typedef struct _EFI_IFR_STRING
{
1063 EFI_IFR_OP_HEADER Header
;
1064 EFI_IFR_QUESTION_HEADER Question
;
1070 #define EFI_IFR_STRING_MULTI_LINE 0x01
1072 typedef struct _EFI_IFR_PASSWORD
{
1073 EFI_IFR_OP_HEADER Header
;
1074 EFI_IFR_QUESTION_HEADER Question
;
1079 typedef struct _EFI_IFR_ORDERED_LIST
{
1080 EFI_IFR_OP_HEADER Header
;
1081 EFI_IFR_QUESTION_HEADER Question
;
1082 UINT8 MaxContainers
;
1084 } EFI_IFR_ORDERED_LIST
;
1086 #define EFI_IFR_UNIQUE_SET 0x01
1087 #define EFI_IFR_NO_EMPTY_SET 0x02
1089 typedef struct _EFI_IFR_TIME
{
1090 EFI_IFR_OP_HEADER Header
;
1091 EFI_IFR_QUESTION_HEADER Question
;
1096 // A bit-mask that determines which unique settings are active for this opcode.
1098 #define QF_TIME_HOUR_SUPPRESS 0x01
1099 #define QF_TIME_MINUTE_SUPPRESS 0x02
1100 #define QF_TIME_SECOND_SUPPRESS 0x04
1102 #define QF_TIME_STORAGE 0x30
1103 #define QF_TIME_STORAGE_NORMAL 0x00
1104 #define QF_TIME_STORAGE_TIME 0x10
1105 #define QF_TIME_STORAGE_WAKEUP 0x20
1107 typedef struct _EFI_IFR_DISABLE_IF
{
1108 EFI_IFR_OP_HEADER Header
;
1109 } EFI_IFR_DISABLE_IF
;
1111 typedef struct _EFI_IFR_SUPPRESS_IF
{
1112 EFI_IFR_OP_HEADER Header
;
1113 } EFI_IFR_SUPPRESS_IF
;
1115 typedef struct _EFI_IFR_GRAY_OUT_IF
{
1116 EFI_IFR_OP_HEADER Header
;
1117 } EFI_IFR_GRAY_OUT_IF
;
1119 typedef struct _EFI_IFR_INCONSISTENT_IF
{
1120 EFI_IFR_OP_HEADER Header
;
1121 EFI_STRING_ID Error
;
1122 } EFI_IFR_INCONSISTENT_IF
;
1124 typedef struct _EFI_IFR_NO_SUBMIT_IF
{
1125 EFI_IFR_OP_HEADER Header
;
1126 EFI_STRING_ID Error
;
1127 } EFI_IFR_NO_SUBMIT_IF
;
1129 typedef struct _EFI_IFR_REFRESH
{
1130 EFI_IFR_OP_HEADER Header
;
1131 UINT8 RefreshInterval
;
1134 typedef struct _EFI_IFR_VARSTORE_DEVICE
{
1135 EFI_IFR_OP_HEADER Header
;
1136 EFI_STRING_ID DevicePath
;
1137 } EFI_IFR_VARSTORE_DEVICE
;
1139 typedef struct _EFI_IFR_ONE_OF_OPTION
{
1140 EFI_IFR_OP_HEADER Header
;
1141 EFI_STRING_ID Option
;
1144 EFI_IFR_TYPE_VALUE Value
;
1145 } EFI_IFR_ONE_OF_OPTION
;
1148 // Types of the option's value.
1150 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1151 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1152 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1153 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1154 #define EFI_IFR_TYPE_BOOLEAN 0x04
1155 #define EFI_IFR_TYPE_TIME 0x05
1156 #define EFI_IFR_TYPE_DATE 0x06
1157 #define EFI_IFR_TYPE_STRING 0x07
1158 #define EFI_IFR_TYPE_OTHER 0x08
1159 #define EFI_IFR_TYPE_UNDEFINED 0x09
1160 #define EFI_IFR_TYPE_ACTION 0x0A
1161 #define EFI_IFR_TYPE_BUFFER 0x0B
1162 #define EFI_IFR_TYPE_REF 0x0C
1164 #define EFI_IFR_OPTION_DEFAULT 0x10
1165 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1167 typedef struct _EFI_IFR_GUID
{
1168 EFI_IFR_OP_HEADER Header
;
1170 //Optional Data Follows
1173 typedef struct _EFI_IFR_REFRESH_ID
{
1174 EFI_IFR_OP_HEADER Header
;
1175 EFI_GUID RefreshEventGroupId
;
1176 } EFI_IFR_REFRESH_ID
;
1178 typedef struct _EFI_IFR_DUP
{
1179 EFI_IFR_OP_HEADER Header
;
1182 typedef struct _EFI_IFR_EQ_ID_ID
{
1183 EFI_IFR_OP_HEADER Header
;
1184 EFI_QUESTION_ID QuestionId1
;
1185 EFI_QUESTION_ID QuestionId2
;
1188 typedef struct _EFI_IFR_EQ_ID_VAL
{
1189 EFI_IFR_OP_HEADER Header
;
1190 EFI_QUESTION_ID QuestionId
;
1192 } EFI_IFR_EQ_ID_VAL
;
1194 typedef struct _EFI_IFR_EQ_ID_VAL_LIST
{
1195 EFI_IFR_OP_HEADER Header
;
1196 EFI_QUESTION_ID QuestionId
;
1198 UINT16 ValueList
[1];
1199 } EFI_IFR_EQ_ID_VAL_LIST
;
1201 typedef struct _EFI_IFR_UINT8
{
1202 EFI_IFR_OP_HEADER Header
;
1206 typedef struct _EFI_IFR_UINT16
{
1207 EFI_IFR_OP_HEADER Header
;
1211 typedef struct _EFI_IFR_UINT32
{
1212 EFI_IFR_OP_HEADER Header
;
1216 typedef struct _EFI_IFR_UINT64
{
1217 EFI_IFR_OP_HEADER Header
;
1221 typedef struct _EFI_IFR_QUESTION_REF1
{
1222 EFI_IFR_OP_HEADER Header
;
1223 EFI_QUESTION_ID QuestionId
;
1224 } EFI_IFR_QUESTION_REF1
;
1226 typedef struct _EFI_IFR_QUESTION_REF2
{
1227 EFI_IFR_OP_HEADER Header
;
1228 } EFI_IFR_QUESTION_REF2
;
1230 typedef struct _EFI_IFR_QUESTION_REF3
{
1231 EFI_IFR_OP_HEADER Header
;
1232 } EFI_IFR_QUESTION_REF3
;
1234 typedef struct _EFI_IFR_QUESTION_REF3_2
{
1235 EFI_IFR_OP_HEADER Header
;
1236 EFI_STRING_ID DevicePath
;
1237 } EFI_IFR_QUESTION_REF3_2
;
1239 typedef struct _EFI_IFR_QUESTION_REF3_3
{
1240 EFI_IFR_OP_HEADER Header
;
1241 EFI_STRING_ID DevicePath
;
1243 } EFI_IFR_QUESTION_REF3_3
;
1245 typedef struct _EFI_IFR_RULE_REF
{
1246 EFI_IFR_OP_HEADER Header
;
1250 typedef struct _EFI_IFR_STRING_REF1
{
1251 EFI_IFR_OP_HEADER Header
;
1252 EFI_STRING_ID StringId
;
1253 } EFI_IFR_STRING_REF1
;
1255 typedef struct _EFI_IFR_STRING_REF2
{
1256 EFI_IFR_OP_HEADER Header
;
1257 } EFI_IFR_STRING_REF2
;
1259 typedef struct _EFI_IFR_THIS
{
1260 EFI_IFR_OP_HEADER Header
;
1263 typedef struct _EFI_IFR_TRUE
{
1264 EFI_IFR_OP_HEADER Header
;
1267 typedef struct _EFI_IFR_FALSE
{
1268 EFI_IFR_OP_HEADER Header
;
1271 typedef struct _EFI_IFR_ONE
{
1272 EFI_IFR_OP_HEADER Header
;
1275 typedef struct _EFI_IFR_ONES
{
1276 EFI_IFR_OP_HEADER Header
;
1279 typedef struct _EFI_IFR_ZERO
{
1280 EFI_IFR_OP_HEADER Header
;
1283 typedef struct _EFI_IFR_UNDEFINED
{
1284 EFI_IFR_OP_HEADER Header
;
1285 } EFI_IFR_UNDEFINED
;
1287 typedef struct _EFI_IFR_VERSION
{
1288 EFI_IFR_OP_HEADER Header
;
1291 typedef struct _EFI_IFR_LENGTH
{
1292 EFI_IFR_OP_HEADER Header
;
1295 typedef struct _EFI_IFR_NOT
{
1296 EFI_IFR_OP_HEADER Header
;
1299 typedef struct _EFI_IFR_BITWISE_NOT
{
1300 EFI_IFR_OP_HEADER Header
;
1301 } EFI_IFR_BITWISE_NOT
;
1303 typedef struct _EFI_IFR_TO_BOOLEAN
{
1304 EFI_IFR_OP_HEADER Header
;
1305 } EFI_IFR_TO_BOOLEAN
;
1308 /// For EFI_IFR_TO_STRING, when converting from
1309 /// unsigned integers, these flags control the format:
1310 /// 0 = unsigned decimal.
1311 /// 1 = signed decimal.
1312 /// 2 = hexadecimal (lower-case alpha).
1313 /// 3 = hexadecimal (upper-case alpha).
1315 #define EFI_IFR_STRING_UNSIGNED_DEC 0
1316 #define EFI_IFR_STRING_SIGNED_DEC 1
1317 #define EFI_IFR_STRING_LOWERCASE_HEX 2
1318 #define EFI_IFR_STRING_UPPERCASE_HEX 3
1322 /// When converting from a buffer, these flags control the format:
1326 #define EFI_IFR_STRING_ASCII 0
1327 #define EFI_IFR_STRING_UNICODE 8
1330 typedef struct _EFI_IFR_TO_STRING
{
1331 EFI_IFR_OP_HEADER Header
;
1333 } EFI_IFR_TO_STRING
;
1335 typedef struct _EFI_IFR_TO_UINT
{
1336 EFI_IFR_OP_HEADER Header
;
1339 typedef struct _EFI_IFR_TO_UPPER
{
1340 EFI_IFR_OP_HEADER Header
;
1343 typedef struct _EFI_IFR_TO_LOWER
{
1344 EFI_IFR_OP_HEADER Header
;
1347 typedef struct _EFI_IFR_ADD
{
1348 EFI_IFR_OP_HEADER Header
;
1351 typedef struct _EFI_IFR_AND
{
1352 EFI_IFR_OP_HEADER Header
;
1355 typedef struct _EFI_IFR_BITWISE_AND
{
1356 EFI_IFR_OP_HEADER Header
;
1357 } EFI_IFR_BITWISE_AND
;
1359 typedef struct _EFI_IFR_BITWISE_OR
{
1360 EFI_IFR_OP_HEADER Header
;
1361 } EFI_IFR_BITWISE_OR
;
1363 typedef struct _EFI_IFR_CATENATE
{
1364 EFI_IFR_OP_HEADER Header
;
1367 typedef struct _EFI_IFR_DIVIDE
{
1368 EFI_IFR_OP_HEADER Header
;
1371 typedef struct _EFI_IFR_EQUAL
{
1372 EFI_IFR_OP_HEADER Header
;
1375 typedef struct _EFI_IFR_GREATER_EQUAL
{
1376 EFI_IFR_OP_HEADER Header
;
1377 } EFI_IFR_GREATER_EQUAL
;
1379 typedef struct _EFI_IFR_GREATER_THAN
{
1380 EFI_IFR_OP_HEADER Header
;
1381 } EFI_IFR_GREATER_THAN
;
1383 typedef struct _EFI_IFR_LESS_EQUAL
{
1384 EFI_IFR_OP_HEADER Header
;
1385 } EFI_IFR_LESS_EQUAL
;
1387 typedef struct _EFI_IFR_LESS_THAN
{
1388 EFI_IFR_OP_HEADER Header
;
1389 } EFI_IFR_LESS_THAN
;
1391 typedef struct _EFI_IFR_MATCH
{
1392 EFI_IFR_OP_HEADER Header
;
1395 typedef struct _EFI_IFR_MULTIPLY
{
1396 EFI_IFR_OP_HEADER Header
;
1399 typedef struct _EFI_IFR_MODULO
{
1400 EFI_IFR_OP_HEADER Header
;
1403 typedef struct _EFI_IFR_NOT_EQUAL
{
1404 EFI_IFR_OP_HEADER Header
;
1405 } EFI_IFR_NOT_EQUAL
;
1407 typedef struct _EFI_IFR_OR
{
1408 EFI_IFR_OP_HEADER Header
;
1411 typedef struct _EFI_IFR_SHIFT_LEFT
{
1412 EFI_IFR_OP_HEADER Header
;
1413 } EFI_IFR_SHIFT_LEFT
;
1415 typedef struct _EFI_IFR_SHIFT_RIGHT
{
1416 EFI_IFR_OP_HEADER Header
;
1417 } EFI_IFR_SHIFT_RIGHT
;
1419 typedef struct _EFI_IFR_SUBTRACT
{
1420 EFI_IFR_OP_HEADER Header
;
1423 typedef struct _EFI_IFR_CONDITIONAL
{
1424 EFI_IFR_OP_HEADER Header
;
1425 } EFI_IFR_CONDITIONAL
;
1428 // Flags governing the matching criteria of EFI_IFR_FIND
1430 #define EFI_IFR_FF_CASE_SENSITIVE 0x00
1431 #define EFI_IFR_FF_CASE_INSENSITIVE 0x01
1433 typedef struct _EFI_IFR_FIND
{
1434 EFI_IFR_OP_HEADER Header
;
1438 typedef struct _EFI_IFR_MID
{
1439 EFI_IFR_OP_HEADER Header
;
1442 typedef struct _EFI_IFR_TOKEN
{
1443 EFI_IFR_OP_HEADER Header
;
1447 // Flags specifying whether to find the first matching string
1448 // or the first non-matching string.
1450 #define EFI_IFR_FLAGS_FIRST_MATCHING 0x00
1451 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1453 typedef struct _EFI_IFR_SPAN
{
1454 EFI_IFR_OP_HEADER Header
;
1458 typedef struct _EFI_IFR_SECURITY
{
1460 /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
1462 EFI_IFR_OP_HEADER Header
;
1464 /// Security permission level.
1466 EFI_GUID Permissions
;
1469 typedef struct _EFI_IFR_FORM_MAP_METHOD
{
1471 /// The string identifier which provides the human-readable name of
1472 /// the configuration method for this standards map form.
1474 EFI_STRING_ID MethodTitle
;
1476 /// Identifier which uniquely specifies the configuration methods
1477 /// associated with this standards map form.
1479 EFI_GUID MethodIdentifier
;
1480 } EFI_IFR_FORM_MAP_METHOD
;
1482 typedef struct _EFI_IFR_FORM_MAP
{
1484 /// The sequence that defines the type of opcode as well as the length
1485 /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
1487 EFI_IFR_OP_HEADER Header
;
1489 /// The unique identifier for this particular form.
1493 /// One or more configuration method's name and unique identifier.
1495 // EFI_IFR_FORM_MAP_METHOD Methods[];
1498 typedef struct _EFI_IFR_SET
{
1500 /// The sequence that defines the type of opcode as well as the length
1501 /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
1503 EFI_IFR_OP_HEADER Header
;
1505 /// Specifies the identifier of a previously declared variable store to
1506 /// use when storing the question's value.
1508 EFI_VARSTORE_ID VarStoreId
;
1511 /// A 16-bit Buffer Storage offset.
1513 EFI_STRING_ID VarName
;
1515 /// A Name Value or EFI Variable name (VarName).
1520 /// Specifies the type used for storage.
1525 typedef struct _EFI_IFR_GET
{
1527 /// The sequence that defines the type of opcode as well as the length
1528 /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
1530 EFI_IFR_OP_HEADER Header
;
1532 /// Specifies the identifier of a previously declared variable store to
1533 /// use when retrieving the value.
1535 EFI_VARSTORE_ID VarStoreId
;
1538 /// A 16-bit Buffer Storage offset.
1540 EFI_STRING_ID VarName
;
1542 /// A Name Value or EFI Variable name (VarName).
1547 /// Specifies the type used for storage.
1552 typedef struct _EFI_IFR_READ
{
1553 EFI_IFR_OP_HEADER Header
;
1556 typedef struct _EFI_IFR_WRITE
{
1557 EFI_IFR_OP_HEADER Header
;
1560 typedef struct _EFI_IFR_MAP
{
1561 EFI_IFR_OP_HEADER Header
;
1564 // Definitions for Keyboard Package
1565 // Releated definitions are in Section of EFI_HII_DATABASE_PROTOCOL
1569 /// Each enumeration values maps a physical key on a keyboard.
1681 /// Used to describe a physical key on a keyboard.
1685 /// Unicode character code for the Key.
1689 /// Unicode character code for the key with the shift key being held down.
1691 CHAR16 ShiftedUnicode
;
1693 /// Unicode character code for the key with the Alt-GR being held down.
1695 CHAR16 AltGrUnicode
;
1697 /// Unicode character code for the key with the Alt-GR and shift keys being held down.
1699 CHAR16 ShiftedAltGrUnicode
;
1701 /// Modifier keys are defined to allow for special functionality that is not necessarily
1702 /// accomplished by a printable character. Many of these modifier keys are flags to toggle
1703 /// certain state bits on and off inside of a keyboard driver.
1706 UINT16 AffectedAttribute
;
1707 } EFI_KEY_DESCRIPTOR
;
1710 /// A key which is affected by all the standard shift modifiers.
1711 /// Most keys would be expected to have this bit active.
1713 #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
1716 /// This key is affected by the caps lock so that if a keyboard driver
1717 /// would need to disambiguate between a key which had a "1" defined
1718 /// versus an "a" character. Having this bit turned on would tell
1719 /// the keyboard driver to use the appropriate shifted state or not.
1721 #define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
1724 /// Similar to the case of CAPS lock, if this bit is active, the key
1725 /// is affected by the num lock being turned on.
1727 #define EFI_AFFECTED_BY_NUM_LOCK 0x0004
1730 UINT16 LayoutLength
;
1732 UINT32 LayoutDescriptorStringOffset
;
1733 UINT8 DescriptorCount
;
1734 // EFI_KEY_DESCRIPTOR Descriptors[];
1735 } EFI_HII_KEYBOARD_LAYOUT
;
1738 EFI_HII_PACKAGE_HEADER Header
;
1740 // EFI_HII_KEYBOARD_LAYOUT Layout[];
1741 } EFI_HII_KEYBOARD_PACKAGE_HDR
;
1746 #define EFI_NULL_MODIFIER 0x0000
1747 #define EFI_LEFT_CONTROL_MODIFIER 0x0001
1748 #define EFI_RIGHT_CONTROL_MODIFIER 0x0002
1749 #define EFI_LEFT_ALT_MODIFIER 0x0003
1750 #define EFI_RIGHT_ALT_MODIFIER 0x0004
1751 #define EFI_ALT_GR_MODIFIER 0x0005
1752 #define EFI_INSERT_MODIFIER 0x0006
1753 #define EFI_DELETE_MODIFIER 0x0007
1754 #define EFI_PAGE_DOWN_MODIFIER 0x0008
1755 #define EFI_PAGE_UP_MODIFIER 0x0009
1756 #define EFI_HOME_MODIFIER 0x000A
1757 #define EFI_END_MODIFIER 0x000B
1758 #define EFI_LEFT_SHIFT_MODIFIER 0x000C
1759 #define EFI_RIGHT_SHIFT_MODIFIER 0x000D
1760 #define EFI_CAPS_LOCK_MODIFIER 0x000E
1761 #define EFI_NUM_LOCK_MODIFIER 0x000F
1762 #define EFI_LEFT_ARROW_MODIFIER 0x0010
1763 #define EFI_RIGHT_ARROW_MODIFIER 0x0011
1764 #define EFI_DOWN_ARROW_MODIFIER 0x0012
1765 #define EFI_UP_ARROW_MODIFIER 0x0013
1766 #define EFI_NS_KEY_MODIFIER 0x0014
1767 #define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015
1768 #define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016
1769 #define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017
1770 #define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018
1771 #define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019
1772 #define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A
1773 #define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B
1774 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C
1775 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D
1776 #define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E
1777 #define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F
1778 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1779 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1782 // Keys that have multiple control functions based on modifier
1783 // settings are handled in the keyboard driver implementation.
1784 // For instance, PRINT_KEY might have a modifier held down and
1785 // is still a nonprinting character, but might have an alternate
1786 // control function like SYSREQUEST
1788 #define EFI_PRINT_MODIFIER 0x0022
1789 #define EFI_SYS_REQUEST_MODIFIER 0x0023
1790 #define EFI_SCROLL_LOCK_MODIFIER 0x0024
1791 #define EFI_PAUSE_MODIFIER 0x0025
1792 #define EFI_BREAK_MODIFIER 0x0026
1794 #define EFI_LEFT_LOGO_MODIFIER 0x0027
1795 #define EFI_RIGHT_LOGO_MODIFIER 0x0028
1796 #define EFI_MENU_MODIFIER 0x0029
1799 /// Animation IFR opcode
1801 typedef struct _EFI_IFR_ANIMATION
{
1803 /// Standard opcode header, where Header.OpCode is
1804 /// EFI_IFR_ANIMATION_OP.
1806 EFI_IFR_OP_HEADER Header
;
1808 /// Animation identifier in the HII database.
1810 EFI_ANIMATION_ID Id
;
1811 } EFI_IFR_ANIMATION
;
1814 /// HII animation package header.
1816 typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR
{
1818 /// Standard package header, where Header.Type = EFI_HII_PACKAGE_ANIMATIONS.
1820 EFI_HII_PACKAGE_HEADER Header
;
1822 /// Offset, relative to this header, of the animation information. If
1823 /// this is zero, then there are no animation sequences in the package.
1825 UINT32 AnimationInfoOffset
;
1826 } EFI_HII_ANIMATION_PACKAGE_HDR
;
1829 /// Animation information is encoded as a series of blocks,
1830 /// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.
1832 typedef struct _EFI_HII_ANIMATION_BLOCK
{
1834 //UINT8 BlockBody[];
1835 } EFI_HII_ANIMATION_BLOCK
;
1838 /// Animation block types.
1840 #define EFI_HII_AIBT_END 0x00
1841 #define EFI_HII_AIBT_OVERLAY_IMAGES 0x10
1842 #define EFI_HII_AIBT_CLEAR_IMAGES 0x11
1843 #define EFI_HII_AIBT_RESTORE_SCRN 0x12
1844 #define EFI_HII_AIBT_OVERLAY_IMAGES_LOOP 0x18
1845 #define EFI_HII_AIBT_CLEAR_IMAGES_LOOP 0x19
1846 #define EFI_HII_AIBT_RESTORE_SCRN_LOOP 0x1A
1847 #define EFI_HII_AIBT_DUPLICATE 0x20
1848 #define EFI_HII_AIBT_SKIP2 0x21
1849 #define EFI_HII_AIBT_SKIP1 0x22
1850 #define EFI_HII_AIBT_EXT1 0x30
1851 #define EFI_HII_AIBT_EXT2 0x31
1852 #define EFI_HII_AIBT_EXT4 0x32
1855 /// Extended block headers used for variable sized animation records
1856 /// which need an explicit length.
1859 typedef struct _EFI_HII_AIBT_EXT1_BLOCK
{
1861 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.
1863 EFI_HII_ANIMATION_BLOCK Header
;
1869 /// Size of the animation block, in bytes, including the animation block header.
1872 } EFI_HII_AIBT_EXT1_BLOCK
;
1874 typedef struct _EFI_HII_AIBT_EXT2_BLOCK
{
1876 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.
1878 EFI_HII_ANIMATION_BLOCK Header
;
1884 /// Size of the animation block, in bytes, including the animation block header.
1887 } EFI_HII_AIBT_EXT2_BLOCK
;
1889 typedef struct _EFI_HII_AIBT_EXT4_BLOCK
{
1891 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.
1893 EFI_HII_ANIMATION_BLOCK Header
;
1899 /// Size of the animation block, in bytes, including the animation block header.
1902 } EFI_HII_AIBT_EXT4_BLOCK
;
1904 typedef struct _EFI_HII_ANIMATION_CELL
{
1906 /// The X offset from the upper left hand corner of the logical
1907 /// window to position the indexed image.
1911 /// The Y offset from the upper left hand corner of the logical
1912 /// window to position the indexed image.
1916 /// The image to display at the specified offset from the upper left
1917 /// hand corner of the logical window.
1919 EFI_IMAGE_ID ImageId
;
1921 /// The number of milliseconds to delay after displaying the indexed
1922 /// image and before continuing on to the next linked image. If value
1923 /// is zero, no delay.
1926 } EFI_HII_ANIMATION_CELL
;
1929 /// An animation block to describe an animation sequence that does not cycle, and
1930 /// where one image is simply displayed over the previous image.
1932 typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK
{
1934 /// This is image that is to be reference by the image protocols, if the
1935 /// animation function is not supported or disabled. This image can
1936 /// be one particular image from the animation sequence (if any one
1937 /// of the animation frames has a complete image) or an alternate
1938 /// image that can be displayed alone. If the value is zero, no image
1941 EFI_IMAGE_ID DftImageId
;
1943 /// The overall width of the set of images (logical window width).
1947 /// The overall height of the set of images (logical window height).
1951 /// The number of EFI_HII_ANIMATION_CELL contained in the
1952 /// animation sequence.
1956 /// An array of CellCount animation cells.
1958 EFI_HII_ANIMATION_CELL AnimationCell
[1];
1959 } EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK
;
1962 /// An animation block to describe an animation sequence that does not cycle,
1963 /// and where the logical window is cleared to the specified color before
1964 /// the next image is displayed.
1966 typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK
{
1968 /// This is image that is to be reference by the image protocols, if the
1969 /// animation function is not supported or disabled. This image can
1970 /// be one particular image from the animation sequence (if any one
1971 /// of the animation frames has a complete image) or an alternate
1972 /// image that can be displayed alone. If the value is zero, no image
1975 EFI_IMAGE_ID DftImageId
;
1977 /// The overall width of the set of images (logical window width).
1981 /// The overall height of the set of images (logical window height).
1985 /// The number of EFI_HII_ANIMATION_CELL contained in the
1986 /// animation sequence.
1990 /// The color to clear the logical window to before displaying the
1993 EFI_HII_RGB_PIXEL BackgndColor
;
1995 /// An array of CellCount animation cells.
1997 EFI_HII_ANIMATION_CELL AnimationCell
[1];
1998 } EFI_HII_AIBT_CLEAR_IMAGES_BLOCK
;
2001 /// An animation block to describe an animation sequence that does not cycle,
2002 /// and where the screen is restored to the original state before the next
2003 /// image is displayed.
2005 typedef struct _EFI_HII_AIBT_RESTORE_SCRN_BLOCK
{
2007 /// This is image that is to be reference by the image protocols, if the
2008 /// animation function is not supported or disabled. This image can
2009 /// be one particular image from the animation sequence (if any one
2010 /// of the animation frames has a complete image) or an alternate
2011 /// image that can be displayed alone. If the value is zero, no image
2014 EFI_IMAGE_ID DftImageId
;
2016 /// The overall width of the set of images (logical window width).
2020 /// The overall height of the set of images (logical window height).
2024 /// The number of EFI_HII_ANIMATION_CELL contained in the
2025 /// animation sequence.
2029 /// An array of CellCount animation cells.
2031 EFI_HII_ANIMATION_CELL AnimationCell
[1];
2032 } EFI_HII_AIBT_RESTORE_SCRN_BLOCK
;
2035 /// An animation block to describe an animation sequence that continuously cycles,
2036 /// and where one image is simply displayed over the previous image.
2038 typedef EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK EFI_HII_AIBT_OVERLAY_IMAGES_LOOP_BLOCK
;
2041 /// An animation block to describe an animation sequence that continuously cycles,
2042 /// and where the logical window is cleared to the specified color before
2043 /// the next image is displayed.
2045 typedef EFI_HII_AIBT_CLEAR_IMAGES_BLOCK EFI_HII_AIBT_CLEAR_IMAGES_LOOP_BLOCK
;
2048 /// An animation block to describe an animation sequence that continuously cycles,
2049 /// and where the screen is restored to the original state before
2050 /// the next image is displayed.
2052 typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK
;
2055 /// Assigns a new character value to a previously defined animation sequence.
2057 typedef struct _EFI_HII_AIBT_DUPLICATE_BLOCK
{
2059 /// The previously defined animation ID with the exact same
2060 /// animation information.
2062 EFI_ANIMATION_ID AnimationId
;
2063 } EFI_HII_AIBT_DUPLICATE_BLOCK
;
2066 /// Skips animation IDs.
2068 typedef struct _EFI_HII_AIBT_SKIP1_BLOCK
{
2070 /// The unsigned 8-bit value to add to AnimationIdCurrent.
2073 } EFI_HII_AIBT_SKIP1_BLOCK
;
2076 /// Skips animation IDs.
2078 typedef struct _EFI_HII_AIBT_SKIP2_BLOCK
{
2080 /// The unsigned 16-bit value to add to AnimationIdCurrent.
2083 } EFI_HII_AIBT_SKIP2_BLOCK
;
2090 /// References to string tokens must use this macro to enable scanning for
2094 /// STRING_TOKEN is not defined in UEFI specification. But it is placed
2095 /// here for the easy access by C files and VFR source files.
2097 #define STRING_TOKEN(t) t