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 - 2010, 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
;
669 EFI_STRING_ID string
; ///< EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
670 // UINT8 buffer[]; ///< EFI_IFR_TYPE_ORDERED_LIST
671 } EFI_IFR_TYPE_VALUE
;
676 #define EFI_IFR_FORM_OP 0x01
677 #define EFI_IFR_SUBTITLE_OP 0x02
678 #define EFI_IFR_TEXT_OP 0x03
679 #define EFI_IFR_IMAGE_OP 0x04
680 #define EFI_IFR_ONE_OF_OP 0x05
681 #define EFI_IFR_CHECKBOX_OP 0x06
682 #define EFI_IFR_NUMERIC_OP 0x07
683 #define EFI_IFR_PASSWORD_OP 0x08
684 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
685 #define EFI_IFR_SUPPRESS_IF_OP 0x0A
686 #define EFI_IFR_LOCKED_OP 0x0B
687 #define EFI_IFR_ACTION_OP 0x0C
688 #define EFI_IFR_RESET_BUTTON_OP 0x0D
689 #define EFI_IFR_FORM_SET_OP 0x0E
690 #define EFI_IFR_REF_OP 0x0F
691 #define EFI_IFR_NO_SUBMIT_IF_OP 0x10
692 #define EFI_IFR_INCONSISTENT_IF_OP 0x11
693 #define EFI_IFR_EQ_ID_VAL_OP 0x12
694 #define EFI_IFR_EQ_ID_ID_OP 0x13
695 #define EFI_IFR_EQ_ID_LIST_OP 0x14
696 #define EFI_IFR_AND_OP 0x15
697 #define EFI_IFR_OR_OP 0x16
698 #define EFI_IFR_NOT_OP 0x17
699 #define EFI_IFR_RULE_OP 0x18
700 #define EFI_IFR_GRAY_OUT_IF_OP 0x19
701 #define EFI_IFR_DATE_OP 0x1A
702 #define EFI_IFR_TIME_OP 0x1B
703 #define EFI_IFR_STRING_OP 0x1C
704 #define EFI_IFR_REFRESH_OP 0x1D
705 #define EFI_IFR_DISABLE_IF_OP 0x1E
706 #define EFI_IFR_ANIMATION_OP 0x1F
707 #define EFI_IFR_TO_LOWER_OP 0x20
708 #define EFI_IFR_TO_UPPER_OP 0x21
709 #define EFI_IFR_MAP_OP 0x22
710 #define EFI_IFR_ORDERED_LIST_OP 0x23
711 #define EFI_IFR_VARSTORE_OP 0x24
712 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
713 #define EFI_IFR_VARSTORE_EFI_OP 0x26
714 #define EFI_IFR_VARSTORE_DEVICE_OP 0x27
715 #define EFI_IFR_VERSION_OP 0x28
716 #define EFI_IFR_END_OP 0x29
717 #define EFI_IFR_MATCH_OP 0x2A
718 #define EFI_IFR_GET_OP 0x2B
719 #define EFI_IFR_SET_OP 0x2C
720 #define EFI_IFR_READ_OP 0x2D
721 #define EFI_IFR_WRITE_OP 0x2E
722 #define EFI_IFR_EQUAL_OP 0x2F
723 #define EFI_IFR_NOT_EQUAL_OP 0x30
724 #define EFI_IFR_GREATER_THAN_OP 0x31
725 #define EFI_IFR_GREATER_EQUAL_OP 0x32
726 #define EFI_IFR_LESS_THAN_OP 0x33
727 #define EFI_IFR_LESS_EQUAL_OP 0x34
728 #define EFI_IFR_BITWISE_AND_OP 0x35
729 #define EFI_IFR_BITWISE_OR_OP 0x36
730 #define EFI_IFR_BITWISE_NOT_OP 0x37
731 #define EFI_IFR_SHIFT_LEFT_OP 0x38
732 #define EFI_IFR_SHIFT_RIGHT_OP 0x39
733 #define EFI_IFR_ADD_OP 0x3A
734 #define EFI_IFR_SUBTRACT_OP 0x3B
735 #define EFI_IFR_MULTIPLY_OP 0x3C
736 #define EFI_IFR_DIVIDE_OP 0x3D
737 #define EFI_IFR_MODULO_OP 0x3E
738 #define EFI_IFR_RULE_REF_OP 0x3F
739 #define EFI_IFR_QUESTION_REF1_OP 0x40
740 #define EFI_IFR_QUESTION_REF2_OP 0x41
741 #define EFI_IFR_UINT8_OP 0x42
742 #define EFI_IFR_UINT16_OP 0x43
743 #define EFI_IFR_UINT32_OP 0x44
744 #define EFI_IFR_UINT64_OP 0x45
745 #define EFI_IFR_TRUE_OP 0x46
746 #define EFI_IFR_FALSE_OP 0x47
747 #define EFI_IFR_TO_UINT_OP 0x48
748 #define EFI_IFR_TO_STRING_OP 0x49
749 #define EFI_IFR_TO_BOOLEAN_OP 0x4A
750 #define EFI_IFR_MID_OP 0x4B
751 #define EFI_IFR_FIND_OP 0x4C
752 #define EFI_IFR_TOKEN_OP 0x4D
753 #define EFI_IFR_STRING_REF1_OP 0x4E
754 #define EFI_IFR_STRING_REF2_OP 0x4F
755 #define EFI_IFR_CONDITIONAL_OP 0x50
756 #define EFI_IFR_QUESTION_REF3_OP 0x51
757 #define EFI_IFR_ZERO_OP 0x52
758 #define EFI_IFR_ONE_OP 0x53
759 #define EFI_IFR_ONES_OP 0x54
760 #define EFI_IFR_UNDEFINED_OP 0x55
761 #define EFI_IFR_LENGTH_OP 0x56
762 #define EFI_IFR_DUP_OP 0x57
763 #define EFI_IFR_THIS_OP 0x58
764 #define EFI_IFR_SPAN_OP 0x59
765 #define EFI_IFR_VALUE_OP 0x5A
766 #define EFI_IFR_DEFAULT_OP 0x5B
767 #define EFI_IFR_DEFAULTSTORE_OP 0x5C
768 #define EFI_IFR_FORM_MAP_OP 0x5D
769 #define EFI_IFR_CATENATE_OP 0x5E
770 #define EFI_IFR_GUID_OP 0x5F
771 #define EFI_IFR_SECURITY_OP 0x60
772 #define EFI_IFR_MODAL_TAG_OP 0x61
773 #define EFI_IFR_REFRESH_ID_OP 0x62
776 // Definitions of IFR Standard Headers
780 typedef struct _EFI_IFR_OP_HEADER
{
786 typedef struct _EFI_IFR_STATEMENT_HEADER
{
787 EFI_STRING_ID Prompt
;
789 } EFI_IFR_STATEMENT_HEADER
;
791 typedef struct _EFI_IFR_QUESTION_HEADER
{
792 EFI_IFR_STATEMENT_HEADER Header
;
793 EFI_QUESTION_ID QuestionId
;
794 EFI_VARSTORE_ID VarStoreId
;
796 EFI_STRING_ID VarName
;
800 } EFI_IFR_QUESTION_HEADER
;
803 // Flag values of EFI_IFR_QUESTION_HEADER
805 #define EFI_IFR_FLAG_READ_ONLY 0x01
806 #define EFI_IFR_FLAG_CALLBACK 0x04
807 #define EFI_IFR_FLAG_RESET_REQUIRED 0x10
808 #define EFI_IFR_FLAG_OPTIONS_ONLY 0x80
811 // Definition for Opcode Reference
814 typedef struct _EFI_IFR_DEFAULTSTORE
{
815 EFI_IFR_OP_HEADER Header
;
816 EFI_STRING_ID DefaultName
;
818 } EFI_IFR_DEFAULTSTORE
;
821 // Default Identifier of default store
823 #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000
824 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001
825 #define EFI_HII_DEFAULT_CLASS_SAFE 0x0002
826 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
827 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff
828 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
829 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff
830 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
831 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff
833 typedef struct _EFI_IFR_VARSTORE
{
834 EFI_IFR_OP_HEADER Header
;
836 EFI_VARSTORE_ID VarStoreId
;
841 typedef struct _EFI_IFR_VARSTORE_EFI
{
842 EFI_IFR_OP_HEADER Header
;
843 EFI_VARSTORE_ID VarStoreId
;
846 } EFI_IFR_VARSTORE_EFI
;
848 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE
{
849 EFI_IFR_OP_HEADER Header
;
850 EFI_VARSTORE_ID VarStoreId
;
852 } EFI_IFR_VARSTORE_NAME_VALUE
;
854 typedef struct _EFI_IFR_FORM_SET
{
855 EFI_IFR_OP_HEADER Header
;
857 EFI_STRING_ID FormSetTitle
;
860 // EFI_GUID ClassGuid[];
863 typedef struct _EFI_IFR_END
{
864 EFI_IFR_OP_HEADER Header
;
867 typedef struct _EFI_IFR_FORM
{
868 EFI_IFR_OP_HEADER Header
;
870 EFI_STRING_ID FormTitle
;
873 typedef struct _EFI_IFR_IMAGE
{
874 EFI_IFR_OP_HEADER Header
;
878 typedef struct _EFI_IFR_MODAL
{
879 EFI_IFR_OP_HEADER Header
;
882 typedef struct _EFI_IFR_LOCKED
{
883 EFI_IFR_OP_HEADER Header
;
886 typedef struct _EFI_IFR_RULE
{
887 EFI_IFR_OP_HEADER Header
;
891 typedef struct _EFI_IFR_DEFAULT
{
892 EFI_IFR_OP_HEADER Header
;
895 EFI_IFR_TYPE_VALUE Value
;
898 typedef struct _EFI_IFR_VALUE
{
899 EFI_IFR_OP_HEADER Header
;
902 typedef struct _EFI_IFR_SUBTITLE
{
903 EFI_IFR_OP_HEADER Header
;
904 EFI_IFR_STATEMENT_HEADER Statement
;
908 #define EFI_IFR_FLAGS_HORIZONTAL 0x01
910 typedef struct _EFI_IFR_CHECKBOX
{
911 EFI_IFR_OP_HEADER Header
;
912 EFI_IFR_QUESTION_HEADER Question
;
916 #define EFI_IFR_CHECKBOX_DEFAULT 0x01
917 #define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02
919 typedef struct _EFI_IFR_TEXT
{
920 EFI_IFR_OP_HEADER Header
;
921 EFI_IFR_STATEMENT_HEADER Statement
;
922 EFI_STRING_ID TextTwo
;
925 typedef struct _EFI_IFR_REF
{
926 EFI_IFR_OP_HEADER Header
;
927 EFI_IFR_QUESTION_HEADER Question
;
931 typedef struct _EFI_IFR_REF2
{
932 EFI_IFR_OP_HEADER Header
;
933 EFI_IFR_QUESTION_HEADER Question
;
935 EFI_QUESTION_ID QuestionId
;
938 typedef struct _EFI_IFR_REF3
{
939 EFI_IFR_OP_HEADER Header
;
940 EFI_IFR_QUESTION_HEADER Question
;
942 EFI_QUESTION_ID QuestionId
;
946 typedef struct _EFI_IFR_REF4
{
947 EFI_IFR_OP_HEADER Header
;
948 EFI_IFR_QUESTION_HEADER Question
;
950 EFI_QUESTION_ID QuestionId
;
952 EFI_STRING_ID DevicePath
;
955 typedef struct _EFI_IFR_RESET_BUTTON
{
956 EFI_IFR_OP_HEADER Header
;
957 EFI_IFR_STATEMENT_HEADER Statement
;
958 EFI_DEFAULT_ID DefaultId
;
959 } EFI_IFR_RESET_BUTTON
;
961 typedef struct _EFI_IFR_ACTION
{
962 EFI_IFR_OP_HEADER Header
;
963 EFI_IFR_QUESTION_HEADER Question
;
964 EFI_STRING_ID QuestionConfig
;
967 typedef struct _EFI_IFR_ACTION_1
{
968 EFI_IFR_OP_HEADER Header
;
969 EFI_IFR_QUESTION_HEADER Question
;
972 typedef struct _EFI_IFR_DATE
{
973 EFI_IFR_OP_HEADER Header
;
974 EFI_IFR_QUESTION_HEADER Question
;
979 // Flags that describe the behavior of the question.
981 #define EFI_QF_DATE_YEAR_SUPPRESS 0x01
982 #define EFI_QF_DATE_MONTH_SUPPRESS 0x02
983 #define EFI_QF_DATE_DAY_SUPPRESS 0x04
985 #define EFI_QF_DATE_STORAGE 0x30
986 #define QF_DATE_STORAGE_NORMAL 0x00
987 #define QF_DATE_STORAGE_TIME 0x10
988 #define QF_DATE_STORAGE_WAKEUP 0x20
1013 typedef struct _EFI_IFR_NUMERIC
{
1014 EFI_IFR_OP_HEADER Header
;
1015 EFI_IFR_QUESTION_HEADER Question
;
1017 MINMAXSTEP_DATA data
;
1021 // Flags related to the numeric question
1023 #define EFI_IFR_NUMERIC_SIZE 0x03
1024 #define EFI_IFR_NUMERIC_SIZE_1 0x00
1025 #define EFI_IFR_NUMERIC_SIZE_2 0x01
1026 #define EFI_IFR_NUMERIC_SIZE_4 0x02
1027 #define EFI_IFR_NUMERIC_SIZE_8 0x03
1029 #define EFI_IFR_DISPLAY 0x30
1030 #define EFI_IFR_DISPLAY_INT_DEC 0x00
1031 #define EFI_IFR_DISPLAY_UINT_DEC 0x10
1032 #define EFI_IFR_DISPLAY_UINT_HEX 0x20
1034 typedef struct _EFI_IFR_ONE_OF
{
1035 EFI_IFR_OP_HEADER Header
;
1036 EFI_IFR_QUESTION_HEADER Question
;
1038 MINMAXSTEP_DATA data
;
1041 typedef struct _EFI_IFR_STRING
{
1042 EFI_IFR_OP_HEADER Header
;
1043 EFI_IFR_QUESTION_HEADER Question
;
1049 #define EFI_IFR_STRING_MULTI_LINE 0x01
1051 typedef struct _EFI_IFR_PASSWORD
{
1052 EFI_IFR_OP_HEADER Header
;
1053 EFI_IFR_QUESTION_HEADER Question
;
1058 typedef struct _EFI_IFR_ORDERED_LIST
{
1059 EFI_IFR_OP_HEADER Header
;
1060 EFI_IFR_QUESTION_HEADER Question
;
1061 UINT8 MaxContainers
;
1063 } EFI_IFR_ORDERED_LIST
;
1065 #define EFI_IFR_UNIQUE_SET 0x01
1066 #define EFI_IFR_NO_EMPTY_SET 0x02
1068 typedef struct _EFI_IFR_TIME
{
1069 EFI_IFR_OP_HEADER Header
;
1070 EFI_IFR_QUESTION_HEADER Question
;
1075 // A bit-mask that determines which unique settings are active for this opcode.
1077 #define QF_TIME_HOUR_SUPPRESS 0x01
1078 #define QF_TIME_MINUTE_SUPPRESS 0x02
1079 #define QF_TIME_SECOND_SUPPRESS 0x04
1081 #define QF_TIME_STORAGE 0x30
1082 #define QF_TIME_STORAGE_NORMAL 0x00
1083 #define QF_TIME_STORAGE_TIME 0x10
1084 #define QF_TIME_STORAGE_WAKEUP 0x20
1086 typedef struct _EFI_IFR_DISABLE_IF
{
1087 EFI_IFR_OP_HEADER Header
;
1088 } EFI_IFR_DISABLE_IF
;
1090 typedef struct _EFI_IFR_SUPPRESS_IF
{
1091 EFI_IFR_OP_HEADER Header
;
1092 } EFI_IFR_SUPPRESS_IF
;
1094 typedef struct _EFI_IFR_GRAY_OUT_IF
{
1095 EFI_IFR_OP_HEADER Header
;
1096 } EFI_IFR_GRAY_OUT_IF
;
1098 typedef struct _EFI_IFR_INCONSISTENT_IF
{
1099 EFI_IFR_OP_HEADER Header
;
1100 EFI_STRING_ID Error
;
1101 } EFI_IFR_INCONSISTENT_IF
;
1103 typedef struct _EFI_IFR_NO_SUBMIT_IF
{
1104 EFI_IFR_OP_HEADER Header
;
1105 EFI_STRING_ID Error
;
1106 } EFI_IFR_NO_SUBMIT_IF
;
1108 typedef struct _EFI_IFR_REFRESH
{
1109 EFI_IFR_OP_HEADER Header
;
1110 UINT8 RefreshInterval
;
1113 typedef struct _EFI_IFR_VARSTORE_DEVICE
{
1114 EFI_IFR_OP_HEADER Header
;
1115 EFI_STRING_ID DevicePath
;
1116 } EFI_IFR_VARSTORE_DEVICE
;
1118 typedef struct _EFI_IFR_ONE_OF_OPTION
{
1119 EFI_IFR_OP_HEADER Header
;
1120 EFI_STRING_ID Option
;
1123 EFI_IFR_TYPE_VALUE Value
;
1124 } EFI_IFR_ONE_OF_OPTION
;
1127 // Types of the option's value.
1129 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1130 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1131 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1132 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1133 #define EFI_IFR_TYPE_BOOLEAN 0x04
1134 #define EFI_IFR_TYPE_TIME 0x05
1135 #define EFI_IFR_TYPE_DATE 0x06
1136 #define EFI_IFR_TYPE_STRING 0x07
1137 #define EFI_IFR_TYPE_OTHER 0x08
1138 #define EFI_IFR_TYPE_UNDEFINED 0x09
1139 #define EFI_IFR_TYPE_ACTION 0x0A
1140 #define EFI_IFR_TYPE_BUFFER 0x0B
1142 #define EFI_IFR_OPTION_DEFAULT 0x10
1143 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1145 typedef struct _EFI_IFR_GUID
{
1146 EFI_IFR_OP_HEADER Header
;
1148 //Optional Data Follows
1151 typedef struct _EFI_IFR_REFRESH_ID
{
1152 EFI_IFR_OP_HEADER Header
;
1153 EFI_GUID RefreshEventGroupId
;
1154 } EFI_IFR_REFRESH_ID
;
1156 typedef struct _EFI_IFR_DUP
{
1157 EFI_IFR_OP_HEADER Header
;
1160 typedef struct _EFI_IFR_EQ_ID_ID
{
1161 EFI_IFR_OP_HEADER Header
;
1162 EFI_QUESTION_ID QuestionId1
;
1163 EFI_QUESTION_ID QuestionId2
;
1166 typedef struct _EFI_IFR_EQ_ID_VAL
{
1167 EFI_IFR_OP_HEADER Header
;
1168 EFI_QUESTION_ID QuestionId
;
1170 } EFI_IFR_EQ_ID_VAL
;
1172 typedef struct _EFI_IFR_EQ_ID_VAL_LIST
{
1173 EFI_IFR_OP_HEADER Header
;
1174 EFI_QUESTION_ID QuestionId
;
1176 UINT16 ValueList
[1];
1177 } EFI_IFR_EQ_ID_VAL_LIST
;
1179 typedef struct _EFI_IFR_UINT8
{
1180 EFI_IFR_OP_HEADER Header
;
1184 typedef struct _EFI_IFR_UINT16
{
1185 EFI_IFR_OP_HEADER Header
;
1189 typedef struct _EFI_IFR_UINT32
{
1190 EFI_IFR_OP_HEADER Header
;
1194 typedef struct _EFI_IFR_UINT64
{
1195 EFI_IFR_OP_HEADER Header
;
1199 typedef struct _EFI_IFR_QUESTION_REF1
{
1200 EFI_IFR_OP_HEADER Header
;
1201 EFI_QUESTION_ID QuestionId
;
1202 } EFI_IFR_QUESTION_REF1
;
1204 typedef struct _EFI_IFR_QUESTION_REF2
{
1205 EFI_IFR_OP_HEADER Header
;
1206 } EFI_IFR_QUESTION_REF2
;
1208 typedef struct _EFI_IFR_QUESTION_REF3
{
1209 EFI_IFR_OP_HEADER Header
;
1210 } EFI_IFR_QUESTION_REF3
;
1212 typedef struct _EFI_IFR_QUESTION_REF3_2
{
1213 EFI_IFR_OP_HEADER Header
;
1214 EFI_STRING_ID DevicePath
;
1215 } EFI_IFR_QUESTION_REF3_2
;
1217 typedef struct _EFI_IFR_QUESTION_REF3_3
{
1218 EFI_IFR_OP_HEADER Header
;
1219 EFI_STRING_ID DevicePath
;
1221 } EFI_IFR_QUESTION_REF3_3
;
1223 typedef struct _EFI_IFR_RULE_REF
{
1224 EFI_IFR_OP_HEADER Header
;
1228 typedef struct _EFI_IFR_STRING_REF1
{
1229 EFI_IFR_OP_HEADER Header
;
1230 EFI_STRING_ID StringId
;
1231 } EFI_IFR_STRING_REF1
;
1233 typedef struct _EFI_IFR_STRING_REF2
{
1234 EFI_IFR_OP_HEADER Header
;
1235 } EFI_IFR_STRING_REF2
;
1237 typedef struct _EFI_IFR_THIS
{
1238 EFI_IFR_OP_HEADER Header
;
1241 typedef struct _EFI_IFR_TRUE
{
1242 EFI_IFR_OP_HEADER Header
;
1245 typedef struct _EFI_IFR_FALSE
{
1246 EFI_IFR_OP_HEADER Header
;
1249 typedef struct _EFI_IFR_ONE
{
1250 EFI_IFR_OP_HEADER Header
;
1253 typedef struct _EFI_IFR_ONES
{
1254 EFI_IFR_OP_HEADER Header
;
1257 typedef struct _EFI_IFR_ZERO
{
1258 EFI_IFR_OP_HEADER Header
;
1261 typedef struct _EFI_IFR_UNDEFINED
{
1262 EFI_IFR_OP_HEADER Header
;
1263 } EFI_IFR_UNDEFINED
;
1265 typedef struct _EFI_IFR_VERSION
{
1266 EFI_IFR_OP_HEADER Header
;
1269 typedef struct _EFI_IFR_LENGTH
{
1270 EFI_IFR_OP_HEADER Header
;
1273 typedef struct _EFI_IFR_NOT
{
1274 EFI_IFR_OP_HEADER Header
;
1277 typedef struct _EFI_IFR_BITWISE_NOT
{
1278 EFI_IFR_OP_HEADER Header
;
1279 } EFI_IFR_BITWISE_NOT
;
1281 typedef struct _EFI_IFR_TO_BOOLEAN
{
1282 EFI_IFR_OP_HEADER Header
;
1283 } EFI_IFR_TO_BOOLEAN
;
1286 /// For EFI_IFR_TO_STRING, when converting from
1287 /// unsigned integers, these flags control the format:
1288 /// 0 = unsigned decimal.
1289 /// 1 = signed decimal.
1290 /// 2 = hexadecimal (lower-case alpha).
1291 /// 3 = hexadecimal (upper-case alpha).
1293 #define EFI_IFR_STRING_UNSIGNED_DEC 0
1294 #define EFI_IFR_STRING_SIGNED_DEC 1
1295 #define EFI_IFR_STRING_LOWERCASE_HEX 2
1296 #define EFI_IFR_STRING_UPPERCASE_HEX 3
1300 /// When converting from a buffer, these flags control the format:
1304 #define EFI_IFR_STRING_ASCII 0
1305 #define EFI_IFR_STRING_UNICODE 8
1308 typedef struct _EFI_IFR_TO_STRING
{
1309 EFI_IFR_OP_HEADER Header
;
1311 } EFI_IFR_TO_STRING
;
1313 typedef struct _EFI_IFR_TO_UINT
{
1314 EFI_IFR_OP_HEADER Header
;
1317 typedef struct _EFI_IFR_TO_UPPER
{
1318 EFI_IFR_OP_HEADER Header
;
1321 typedef struct _EFI_IFR_TO_LOWER
{
1322 EFI_IFR_OP_HEADER Header
;
1325 typedef struct _EFI_IFR_ADD
{
1326 EFI_IFR_OP_HEADER Header
;
1329 typedef struct _EFI_IFR_AND
{
1330 EFI_IFR_OP_HEADER Header
;
1333 typedef struct _EFI_IFR_BITWISE_AND
{
1334 EFI_IFR_OP_HEADER Header
;
1335 } EFI_IFR_BITWISE_AND
;
1337 typedef struct _EFI_IFR_BITWISE_OR
{
1338 EFI_IFR_OP_HEADER Header
;
1339 } EFI_IFR_BITWISE_OR
;
1341 typedef struct _EFI_IFR_CATENATE
{
1342 EFI_IFR_OP_HEADER Header
;
1345 typedef struct _EFI_IFR_DIVIDE
{
1346 EFI_IFR_OP_HEADER Header
;
1349 typedef struct _EFI_IFR_EQUAL
{
1350 EFI_IFR_OP_HEADER Header
;
1353 typedef struct _EFI_IFR_GREATER_EQUAL
{
1354 EFI_IFR_OP_HEADER Header
;
1355 } EFI_IFR_GREATER_EQUAL
;
1357 typedef struct _EFI_IFR_GREATER_THAN
{
1358 EFI_IFR_OP_HEADER Header
;
1359 } EFI_IFR_GREATER_THAN
;
1361 typedef struct _EFI_IFR_LESS_EQUAL
{
1362 EFI_IFR_OP_HEADER Header
;
1363 } EFI_IFR_LESS_EQUAL
;
1365 typedef struct _EFI_IFR_LESS_THAN
{
1366 EFI_IFR_OP_HEADER Header
;
1367 } EFI_IFR_LESS_THAN
;
1369 typedef struct _EFI_IFR_MATCH
{
1370 EFI_IFR_OP_HEADER Header
;
1373 typedef struct _EFI_IFR_MULTIPLY
{
1374 EFI_IFR_OP_HEADER Header
;
1377 typedef struct _EFI_IFR_MODULO
{
1378 EFI_IFR_OP_HEADER Header
;
1381 typedef struct _EFI_IFR_NOT_EQUAL
{
1382 EFI_IFR_OP_HEADER Header
;
1383 } EFI_IFR_NOT_EQUAL
;
1385 typedef struct _EFI_IFR_OR
{
1386 EFI_IFR_OP_HEADER Header
;
1389 typedef struct _EFI_IFR_SHIFT_LEFT
{
1390 EFI_IFR_OP_HEADER Header
;
1391 } EFI_IFR_SHIFT_LEFT
;
1393 typedef struct _EFI_IFR_SHIFT_RIGHT
{
1394 EFI_IFR_OP_HEADER Header
;
1395 } EFI_IFR_SHIFT_RIGHT
;
1397 typedef struct _EFI_IFR_SUBTRACT
{
1398 EFI_IFR_OP_HEADER Header
;
1401 typedef struct _EFI_IFR_CONDITIONAL
{
1402 EFI_IFR_OP_HEADER Header
;
1403 } EFI_IFR_CONDITIONAL
;
1406 // Flags governing the matching criteria of EFI_IFR_FIND
1408 #define EFI_IFR_FF_CASE_SENSITIVE 0x00
1409 #define EFI_IFR_FF_CASE_INSENSITIVE 0x01
1411 typedef struct _EFI_IFR_FIND
{
1412 EFI_IFR_OP_HEADER Header
;
1416 typedef struct _EFI_IFR_MID
{
1417 EFI_IFR_OP_HEADER Header
;
1420 typedef struct _EFI_IFR_TOKEN
{
1421 EFI_IFR_OP_HEADER Header
;
1425 // Flags specifying whether to find the first matching string
1426 // or the first non-matching string.
1428 #define EFI_IFR_FLAGS_FIRST_MATCHING 0x00
1429 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1431 typedef struct _EFI_IFR_SPAN
{
1432 EFI_IFR_OP_HEADER Header
;
1436 typedef struct _EFI_IFR_SECURITY
{
1438 /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
1440 EFI_IFR_OP_HEADER Header
;
1442 /// Security permission level.
1444 EFI_GUID Permissions
;
1447 typedef struct _EFI_IFR_FORM_MAP_METHOD
{
1449 /// The string identifier which provides the human-readable name of
1450 /// the configuration method for this standards map form.
1452 EFI_STRING_ID MethodTitle
;
1454 /// Identifier which uniquely specifies the configuration methods
1455 /// associated with this standards map form.
1457 EFI_GUID MethodIdentifier
;
1458 } EFI_IFR_FORM_MAP_METHOD
;
1460 typedef struct _EFI_IFR_FORM_MAP
{
1462 /// The sequence that defines the type of opcode as well as the length
1463 /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
1465 EFI_IFR_OP_HEADER Header
;
1467 /// The unique identifier for this particular form.
1471 /// One or more configuration method's name and unique identifier.
1473 // EFI_IFR_FORM_MAP_METHOD Methods[];
1476 typedef struct _EFI_IFR_SET
{
1478 /// The sequence that defines the type of opcode as well as the length
1479 /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
1481 EFI_IFR_OP_HEADER Header
;
1483 /// Specifies the identifier of a previously declared variable store to
1484 /// use when storing the question's value.
1486 EFI_VARSTORE_ID VarStoreId
;
1489 /// A 16-bit Buffer Storage offset.
1491 EFI_STRING_ID VarName
;
1493 /// A Name Value or EFI Variable name (VarName).
1498 /// Specifies the type used for storage.
1503 typedef struct _EFI_IFR_GET
{
1505 /// The sequence that defines the type of opcode as well as the length
1506 /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
1508 EFI_IFR_OP_HEADER Header
;
1510 /// Specifies the identifier of a previously declared variable store to
1511 /// use when retrieving the value.
1513 EFI_VARSTORE_ID VarStoreId
;
1516 /// A 16-bit Buffer Storage offset.
1518 EFI_STRING_ID VarName
;
1520 /// A Name Value or EFI Variable name (VarName).
1525 /// Specifies the type used for storage.
1530 typedef struct _EFI_IFR_READ
{
1531 EFI_IFR_OP_HEADER Header
;
1534 typedef struct _EFI_IFR_WRITE
{
1535 EFI_IFR_OP_HEADER Header
;
1538 typedef struct _EFI_IFR_MAP
{
1539 EFI_IFR_OP_HEADER Header
;
1542 // Definitions for Keyboard Package
1543 // Releated definitions are in Section of EFI_HII_DATABASE_PROTOCOL
1547 /// Each enumeration values maps a physical key on a keyboard.
1659 /// Used to describe a physical key on a keyboard.
1663 /// Unicode character code for the Key.
1667 /// Unicode character code for the key with the shift key being held down.
1669 CHAR16 ShiftedUnicode
;
1671 /// Unicode character code for the key with the Alt-GR being held down.
1673 CHAR16 AltGrUnicode
;
1675 /// Unicode character code for the key with the Alt-GR and shift keys being held down.
1677 CHAR16 ShiftedAltGrUnicode
;
1679 /// Modifier keys are defined to allow for special functionality that is not necessarily
1680 /// accomplished by a printable character. Many of these modifier keys are flags to toggle
1681 /// certain state bits on and off inside of a keyboard driver.
1684 UINT16 AffectedAttribute
;
1685 } EFI_KEY_DESCRIPTOR
;
1688 /// A key which is affected by all the standard shift modifiers.
1689 /// Most keys would be expected to have this bit active.
1691 #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
1694 /// This key is affected by the caps lock so that if a keyboard driver
1695 /// would need to disambiguate between a key which had a "1" defined
1696 /// versus an "a" character. Having this bit turned on would tell
1697 /// the keyboard driver to use the appropriate shifted state or not.
1699 #define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
1702 /// Similar to the case of CAPS lock, if this bit is active, the key
1703 /// is affected by the num lock being turned on.
1705 #define EFI_AFFECTED_BY_NUM_LOCK 0x0004
1708 UINT16 LayoutLength
;
1710 UINT32 LayoutDescriptorStringOffset
;
1711 UINT8 DescriptorCount
;
1712 // EFI_KEY_DESCRIPTOR Descriptors[];
1713 } EFI_HII_KEYBOARD_LAYOUT
;
1716 EFI_HII_PACKAGE_HEADER Header
;
1718 // EFI_HII_KEYBOARD_LAYOUT Layout[];
1719 } EFI_HII_KEYBOARD_PACKAGE_HDR
;
1724 #define EFI_NULL_MODIFIER 0x0000
1725 #define EFI_LEFT_CONTROL_MODIFIER 0x0001
1726 #define EFI_RIGHT_CONTROL_MODIFIER 0x0002
1727 #define EFI_LEFT_ALT_MODIFIER 0x0003
1728 #define EFI_RIGHT_ALT_MODIFIER 0x0004
1729 #define EFI_ALT_GR_MODIFIER 0x0005
1730 #define EFI_INSERT_MODIFIER 0x0006
1731 #define EFI_DELETE_MODIFIER 0x0007
1732 #define EFI_PAGE_DOWN_MODIFIER 0x0008
1733 #define EFI_PAGE_UP_MODIFIER 0x0009
1734 #define EFI_HOME_MODIFIER 0x000A
1735 #define EFI_END_MODIFIER 0x000B
1736 #define EFI_LEFT_SHIFT_MODIFIER 0x000C
1737 #define EFI_RIGHT_SHIFT_MODIFIER 0x000D
1738 #define EFI_CAPS_LOCK_MODIFIER 0x000E
1739 #define EFI_NUM_LOCK_MODIFIER 0x000F
1740 #define EFI_LEFT_ARROW_MODIFIER 0x0010
1741 #define EFI_RIGHT_ARROW_MODIFIER 0x0011
1742 #define EFI_DOWN_ARROW_MODIFIER 0x0012
1743 #define EFI_UP_ARROW_MODIFIER 0x0013
1744 #define EFI_NS_KEY_MODIFIER 0x0014
1745 #define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015
1746 #define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016
1747 #define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017
1748 #define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018
1749 #define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019
1750 #define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A
1751 #define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B
1752 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C
1753 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D
1754 #define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E
1755 #define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F
1756 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1757 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1760 // Keys that have multiple control functions based on modifier
1761 // settings are handled in the keyboard driver implementation.
1762 // For instance, PRINT_KEY might have a modifier held down and
1763 // is still a nonprinting character, but might have an alternate
1764 // control function like SYSREQUEST
1766 #define EFI_PRINT_MODIFIER 0x0022
1767 #define EFI_SYS_REQUEST_MODIFIER 0x0023
1768 #define EFI_SCROLL_LOCK_MODIFIER 0x0024
1769 #define EFI_PAUSE_MODIFIER 0x0025
1770 #define EFI_BREAK_MODIFIER 0x0026
1772 #define EFI_LEFT_LOGO_MODIFIER 0x0027
1773 #define EFI_RIGHT_LOGO_MODIFIER 0x0028
1774 #define EFI_MENU_MODIFIER 0x0029
1777 /// Animation IFR opcode
1779 typedef struct _EFI_IFR_ANIMATION
{
1781 /// Standard opcode header, where Header.OpCode is
1782 /// EFI_IFR_ANIMATION_OP.
1784 EFI_IFR_OP_HEADER Header
;
1786 /// Animation identifier in the HII database.
1788 EFI_ANIMATION_ID Id
;
1789 } EFI_IFR_ANIMATION
;
1792 /// HII animation package header.
1794 typedef struct _EFI_HII_ANIMATION_PACKAGE_HDR
{
1796 /// Standard package header, where Header.Type = EFI_HII_PACKAGE_ANIMATIONS.
1798 EFI_HII_PACKAGE_HEADER Header
;
1800 /// Offset, relative to this header, of the animation information. If
1801 /// this is zero, then there are no animation sequences in the package.
1803 UINT32 AnimationInfoOffset
;
1804 } EFI_HII_ANIMATION_PACKAGE_HDR
;
1807 /// Animation information is encoded as a series of blocks,
1808 /// with each block prefixed by a single byte header EFI_HII_ANIMATION_BLOCK.
1810 typedef struct _EFI_HII_ANIMATION_BLOCK
{
1812 //UINT8 BlockBody[];
1813 } EFI_HII_ANIMATION_BLOCK
;
1816 /// Animation block types.
1818 #define EFI_HII_AIBT_END 0x00
1819 #define EFI_HII_AIBT_OVERLAY_IMAGES 0x10
1820 #define EFI_HII_AIBT_CLEAR_IMAGES 0x11
1821 #define EFI_HII_AIBT_RESTORE_SCRN 0x12
1822 #define EFI_HII_AIBT_OVERLAY_IMAGES_LOOP 0x18
1823 #define EFI_HII_AIBT_CLEAR_IMAGES_LOOP 0x19
1824 #define EFI_HII_AIBT_RESTORE_SCRN_LOOP 0x1A
1825 #define EFI_HII_AIBT_DUPLICATE 0x20
1826 #define EFI_HII_AIBT_SKIP2 0x21
1827 #define EFI_HII_AIBT_SKIP1 0x22
1828 #define EFI_HII_AIBT_EXT1 0x30
1829 #define EFI_HII_AIBT_EXT2 0x31
1830 #define EFI_HII_AIBT_EXT4 0x32
1833 /// Extended block headers used for variable sized animation records
1834 /// which need an explicit length.
1837 typedef struct _EFI_HII_AIBT_EXT1_BLOCK
{
1839 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT1.
1841 EFI_HII_ANIMATION_BLOCK Header
;
1847 /// Size of the animation block, in bytes, including the animation block header.
1850 } EFI_HII_AIBT_EXT1_BLOCK
;
1852 typedef struct _EFI_HII_AIBT_EXT2_BLOCK
{
1854 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT2.
1856 EFI_HII_ANIMATION_BLOCK Header
;
1862 /// Size of the animation block, in bytes, including the animation block header.
1865 } EFI_HII_AIBT_EXT2_BLOCK
;
1867 typedef struct _EFI_HII_AIBT_EXT4_BLOCK
{
1869 /// Standard animation header, where Header.BlockType = EFI_HII_AIBT_EXT4.
1871 EFI_HII_ANIMATION_BLOCK Header
;
1877 /// Size of the animation block, in bytes, including the animation block header.
1880 } EFI_HII_AIBT_EXT4_BLOCK
;
1882 typedef struct _EFI_HII_ANIMATION_CELL
{
1884 /// The X offset from the upper left hand corner of the logical
1885 /// window to position the indexed image.
1889 /// The Y offset from the upper left hand corner of the logical
1890 /// window to position the indexed image.
1894 /// The image to display at the specified offset from the upper left
1895 /// hand corner of the logical window.
1897 EFI_IMAGE_ID ImageId
;
1899 /// The number of milliseconds to delay after displaying the indexed
1900 /// image and before continuing on to the next linked image. If value
1901 /// is zero, no delay.
1904 } EFI_HII_ANIMATION_CELL
;
1907 /// An animation block to describe an animation sequence that does not cycle, and
1908 /// where one image is simply displayed over the previous image.
1910 typedef struct _EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK
{
1912 /// This is image that is to be reference by the image protocols, if the
1913 /// animation function is not supported or disabled. This image can
1914 /// be one particular image from the animation sequence (if any one
1915 /// of the animation frames has a complete image) or an alternate
1916 /// image that can be displayed alone. If the value is zero, no image
1919 EFI_IMAGE_ID DftImageId
;
1921 /// The overall width of the set of images (logical window width).
1925 /// The overall height of the set of images (logical window height).
1929 /// The number of EFI_HII_ANIMATION_CELL contained in the
1930 /// animation sequence.
1934 /// An array of CellCount animation cells.
1936 EFI_HII_ANIMATION_CELL AnimationCell
[1];
1937 } EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK
;
1940 /// An animation block to describe an animation sequence that does not cycle,
1941 /// and where the logical window is cleared to the specified color before
1942 /// the next image is displayed.
1944 typedef struct _EFI_HII_AIBT_CLEAR_IMAGES_BLOCK
{
1946 /// This is image that is to be reference by the image protocols, if the
1947 /// animation function is not supported or disabled. This image can
1948 /// be one particular image from the animation sequence (if any one
1949 /// of the animation frames has a complete image) or an alternate
1950 /// image that can be displayed alone. If the value is zero, no image
1953 EFI_IMAGE_ID DftImageId
;
1955 /// The overall width of the set of images (logical window width).
1959 /// The overall height of the set of images (logical window height).
1963 /// The number of EFI_HII_ANIMATION_CELL contained in the
1964 /// animation sequence.
1968 /// The color to clear the logical window to before displaying the
1971 EFI_HII_RGB_PIXEL BackgndColor
;
1973 /// An array of CellCount animation cells.
1975 EFI_HII_ANIMATION_CELL AnimationCell
[1];
1976 } EFI_HII_AIBT_CLEAR_IMAGES_BLOCK
;
1979 /// An animation block to describe an animation sequence that does not cycle,
1980 /// and where the screen is restored to the original state before the next
1981 /// image is displayed.
1983 typedef struct _EFI_HII_AIBT_RESTORE_SCRN_BLOCK
{
1985 /// This is image that is to be reference by the image protocols, if the
1986 /// animation function is not supported or disabled. This image can
1987 /// be one particular image from the animation sequence (if any one
1988 /// of the animation frames has a complete image) or an alternate
1989 /// image that can be displayed alone. If the value is zero, no image
1992 EFI_IMAGE_ID DftImageId
;
1994 /// The overall width of the set of images (logical window width).
1998 /// The overall height of the set of images (logical window height).
2002 /// The number of EFI_HII_ANIMATION_CELL contained in the
2003 /// animation sequence.
2007 /// An array of CellCount animation cells.
2009 EFI_HII_ANIMATION_CELL AnimationCell
[1];
2010 } EFI_HII_AIBT_RESTORE_SCRN_BLOCK
;
2013 /// An animation block to describe an animation sequence that continuously cycles,
2014 /// and where one image is simply displayed over the previous image.
2016 typedef EFI_HII_AIBT_OVERLAY_IMAGES_BLOCK EFI_HII_AIBT_OVERLAY_IMAGES_LOOP_BLOCK
;
2019 /// An animation block to describe an animation sequence that continuously cycles,
2020 /// and where the logical window is cleared to the specified color before
2021 /// the next image is displayed.
2023 typedef EFI_HII_AIBT_CLEAR_IMAGES_BLOCK EFI_HII_AIBT_CLEAR_IMAGES_LOOP_BLOCK
;
2026 /// An animation block to describe an animation sequence that continuously cycles,
2027 /// and where the screen is restored to the original state before
2028 /// the next image is displayed.
2030 typedef EFI_HII_AIBT_RESTORE_SCRN_BLOCK EFI_HII_AIBT_RESTORE_SCRN_LOOP_BLOCK
;
2033 /// Assigns a new character value to a previously defined animation sequence.
2035 typedef struct _EFI_HII_AIBT_DUPLICATE_BLOCK
{
2037 /// The previously defined animation ID with the exact same
2038 /// animation information.
2040 EFI_ANIMATION_ID AnimationId
;
2041 } EFI_HII_AIBT_DUPLICATE_BLOCK
;
2044 /// Skips animation IDs.
2046 typedef struct _EFI_HII_AIBT_SKIP1_BLOCK
{
2048 /// The unsigned 8-bit value to add to AnimationIdCurrent.
2051 } EFI_HII_AIBT_SKIP1_BLOCK
;
2054 /// Skips animation IDs.
2056 typedef struct _EFI_HII_AIBT_SKIP2_BLOCK
{
2058 /// The unsigned 16-bit value to add to AnimationIdCurrent.
2061 } EFI_HII_AIBT_SKIP2_BLOCK
;
2068 /// References to string tokens must use this macro to enable scanning for
2072 /// STRING_TOKEN is not defined in UEFI specification. But it is placed
2073 /// here for the easy access by C files and VFR source files.
2075 #define STRING_TOKEN(t) t