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 - 2015, Intel Corporation. All rights reserved.<BR>
7 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
9 This program and the accompanying materials are licensed and made available
10 under the terms and conditions of the BSD License which accompanies this
11 distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 @par Revision Reference:
18 These definitions are from UEFI 2.6
22 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__
23 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__
26 #define EFI_HII_PLATFORM_SETUP_FORMSET_GUID \
27 { 0x93039971, 0x8545, 0x4b04, { 0xb4, 0x5e, 0x32, 0xeb, 0x83, 0x26, 0x4, 0xe } }
30 // The following types are currently defined:
32 typedef UINT32 RELOFST
;
34 typedef VOID
* EFI_HII_HANDLE
;
35 typedef CHAR16
* EFI_STRING
;
36 typedef UINT16 EFI_IMAGE_ID
;
37 typedef UINT16 EFI_QUESTION_ID
;
38 typedef UINT16 EFI_STRING_ID
;
39 typedef UINT16 EFI_FORM_ID
;
40 typedef UINT16 EFI_VARSTORE_ID
;
41 typedef UINT16 EFI_DEFAULT_ID
;
42 typedef UINT32 EFI_HII_FONT_STYLE
;
53 EFI_GUID PackageListGuid
;
55 } EFI_HII_PACKAGE_LIST_HEADER
;
59 Each package starts with a header, as defined above, which
60 indicates the size and type of the package. When added to a
61 pointer pointing to the start of the header, Length points at
62 the next package. The package lists form a package list when
63 concatenated together and terminated with an
64 EFI_HII_PACKAGE_HEADER with a Type of EFI_HII_PACKAGE_END. The
65 type EFI_HII_PACKAGE_TYPE_GUID is used for vendor-defined HII
66 packages, whose contents are determined by the Guid. The range
67 of package types starting with EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN
68 through EFI_HII_PACKAGE_TYPE_SYSTEM_END are reserved for system
69 firmware implementers.
71 @param Length The size of the package in bytes.
73 @param Type The package type. See EFI_HII_PACKAGE_TYPE_x,
76 @param Data The package data, the format of which is
84 } EFI_HII_PACKAGE_HEADER
;
87 // EFI_HII_PACKAGE_TYPE_x.
89 #define EFI_HII_PACKAGE_TYPE_ALL 0x00
90 #define EFI_HII_PACKAGE_TYPE_GUID 0x01
91 #define EFI_HII_PACKAGE_FORM 0x02
92 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x03
93 #define EFI_HII_PACKAGE_STRINGS 0x04
94 #define EFI_HII_PACKAGE_FONTS 0x05
95 #define EFI_HII_PACKAGE_IMAGES 0x06
96 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
97 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
98 #define EFI_HII_PACKAGE_END 0xDF
99 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
100 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
103 // Simplified Font Package
106 #define EFI_GLYPH_HEIGHT 19
107 #define EFI_GLYPH_WIDTH 8
109 // Contents of EFI_NARROW_GLYPH.Attributes
111 #define EFI_GLYPH_NON_SPACING 0x01
112 #define EFI_GLYPH_WIDE 0x02
115 CHAR16 UnicodeWeight
;
117 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
121 CHAR16 UnicodeWeight
;
123 UINT8 GlyphCol1
[EFI_GLYPH_HEIGHT
];
124 UINT8 GlyphCol2
[EFI_GLYPH_HEIGHT
];
129 typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR
{
130 EFI_HII_PACKAGE_HEADER Header
;
131 UINT16 NumberOfNarrowGlyphs
;
132 UINT16 NumberOfWideGlyphs
;
133 // EFI_NARROW_GLYPH NarrowGlyphs[];
134 // EFI_WIDE_GLYPH WideGlyphs[];
135 } EFI_HII_SIMPLE_FONT_PACKAGE_HDR
;
141 #define EFI_HII_FONT_STYLE_BOLD 0x00000001
142 #define EFI_HII_FONT_STYLE_ITALIC 0x00000002
143 #define EFI_HII_FONT_STYLE_EMBOSS 0x00010000
144 #define EFI_HII_FONT_STYLE_OUTLINE 0x00020000
145 #define EFI_HII_FONT_STYLE_SHADOW 0x00040000
146 #define EFI_HII_FONT_STYLE_UNDERLINE 0x00080000
147 #define EFI_HII_FONT_STYLE_DBL_UNDER 0x00100000
149 typedef struct _EFI_HII_GLYPH_INFO
{
155 } EFI_HII_GLYPH_INFO
;
157 typedef struct _EFI_HII_FONT_PACKAGE_HDR
{
158 EFI_HII_PACKAGE_HEADER Header
;
160 UINT32 GlyphBlockOffset
;
161 EFI_HII_GLYPH_INFO Cell
;
162 EFI_HII_FONT_STYLE FontStyle
;
163 CHAR16 FontFamily
[1];
164 } EFI_HII_FONT_PACKAGE_HDR
;
166 #define EFI_HII_GIBT_END 0x00
167 #define EFI_HII_GIBT_GLYPH 0x10
168 #define EFI_HII_GIBT_GLYPHS 0x11
169 #define EFI_HII_GIBT_GLYPH_DEFAULT 0x12
170 #define EFI_HII_GIBT_GLYPHS_DEFAULT 0x13
171 #define EFI_HII_GIBT_GLYPH_VARIABILITY 0x14
172 #define EFI_HII_GIBT_DUPLICATE 0x20
173 #define EFI_HII_GIBT_SKIP2 0x21
174 #define EFI_HII_GIBT_SKIP1 0x22
175 #define EFI_HII_GIBT_DEFAULTS 0x23
176 #define EFI_HII_GIBT_EXT1 0x30
177 #define EFI_HII_GIBT_EXT2 0x31
178 #define EFI_HII_GIBT_EXT4 0x32
180 typedef struct _EFI_HII_GLYPH_BLOCK
{
182 } EFI_HII_GLYPH_BLOCK
;
184 typedef struct _EFI_HII_GIBT_DEFAULTS_BLOCK
{
185 EFI_HII_GLYPH_BLOCK Header
;
186 EFI_HII_GLYPH_INFO Cell
;
187 } EFI_HII_GIBT_DEFAULTS_BLOCK
;
189 typedef struct _EFI_HII_GIBT_DUPLICATE_BLOCK
{
190 EFI_HII_GLYPH_BLOCK Header
;
192 } EFI_HII_GIBT_DUPLICATE_BLOCK
;
194 typedef struct _EFI_GLYPH_GIBT_END_BLOCK
{
195 EFI_HII_GLYPH_BLOCK Header
;
196 } EFI_GLYPH_GIBT_END_BLOCK
;
198 typedef struct _EFI_HII_GIBT_EXT1_BLOCK
{
199 EFI_HII_GLYPH_BLOCK Header
;
202 } EFI_HII_GIBT_EXT1_BLOCK
;
204 typedef struct _EFI_HII_GIBT_EXT2_BLOCK
{
205 EFI_HII_GLYPH_BLOCK Header
;
208 } EFI_HII_GIBT_EXT2_BLOCK
;
210 typedef struct _EFI_HII_GIBT_EXT4_BLOCK
{
211 EFI_HII_GLYPH_BLOCK Header
;
214 } EFI_HII_GIBT_EXT4_BLOCK
;
216 typedef struct _EFI_HII_GIBT_GLYPH_BLOCK
{
217 EFI_HII_GLYPH_BLOCK Header
;
218 EFI_HII_GLYPH_INFO Cell
;
219 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height
220 } EFI_HII_GIBT_GLYPH_BLOCK
;
222 typedef struct _EFI_HII_GIBT_GLYPHS_BLOCK
{
223 EFI_HII_GLYPH_BLOCK Header
;
224 EFI_HII_GLYPH_INFO Cell
;
226 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Cell.Width+7)/8)*Cell.Height
227 } EFI_HII_GIBT_GLYPHS_BLOCK
;
229 typedef struct _EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
{
230 EFI_HII_GLYPH_BLOCK Header
;
231 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height
232 } EFI_HII_GIBT_GLYPH_DEFAULT_BLOCK
;
234 typedef struct _EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
{
235 EFI_HII_GLYPH_BLOCK Header
;
237 UINT8 BitmapData
[1]; // the number of bytes per bitmap can be calculated by ((Global.Cell.Width+7)/8)*Global.Cell.Height
238 } EFI_HII_GIBT_GLYPHS_DEFAULT_BLOCK
;
240 typedef struct _EFI_HII_GIBT_VARIABILITY_BLOCK
{
241 EFI_HII_GLYPH_BLOCK Header
;
242 EFI_HII_GLYPH_INFO Cell
;
243 UINT8 GlyphPackInBits
;
244 UINT8 BitmapData
[1];
245 } EFI_HII_GIBT_VARIABILITY_BLOCK
;
247 typedef struct _EFI_HII_GIBT_SKIP1_BLOCK
{
248 EFI_HII_GLYPH_BLOCK Header
;
250 } EFI_HII_GIBT_SKIP1_BLOCK
;
252 typedef struct _EFI_HII_GIBT_SKIP2_BLOCK
{
253 EFI_HII_GLYPH_BLOCK Header
;
255 } EFI_HII_GIBT_SKIP2_BLOCK
;
258 // Device Path Package
260 typedef struct _EFI_HII_DEVICE_PATH_PACKAGE
{
261 EFI_HII_PACKAGE_HEADER Header
;
262 // EFI_DEVICE_PATH_PROTOCOL DevicePath[];
263 } EFI_HII_DEVICE_PATH_PACKAGE
;
268 typedef struct _EFI_HII_GUID_PACKAGE_HDR
{
269 EFI_HII_PACKAGE_HEADER Header
;
271 // Data per GUID definition may follow
272 } EFI_HII_GUID_PACKAGE_HDR
;
278 #define UEFI_CONFIG_LANG "x-UEFI"
279 #define UEFI_CONFIG_LANG2 "x-i-UEFI"
281 typedef struct _EFI_HII_STRING_PACKAGE_HDR
{
282 EFI_HII_PACKAGE_HEADER Header
;
284 UINT32 StringInfoOffset
;
285 CHAR16 LanguageWindow
[16];
286 EFI_STRING_ID LanguageName
;
288 } EFI_HII_STRING_PACKAGE_HDR
;
292 } EFI_HII_STRING_BLOCK
;
294 #define EFI_HII_SIBT_END 0x00
295 #define EFI_HII_SIBT_STRING_SCSU 0x10
296 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
297 #define EFI_HII_SIBT_STRINGS_SCSU 0x12
298 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
299 #define EFI_HII_SIBT_STRING_UCS2 0x14
300 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
301 #define EFI_HII_SIBT_STRINGS_UCS2 0x16
302 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
303 #define EFI_HII_SIBT_DUPLICATE 0x20
304 #define EFI_HII_SIBT_SKIP2 0x21
305 #define EFI_HII_SIBT_SKIP1 0x22
306 #define EFI_HII_SIBT_EXT1 0x30
307 #define EFI_HII_SIBT_EXT2 0x31
308 #define EFI_HII_SIBT_EXT4 0x32
309 #define EFI_HII_SIBT_FONT 0x40
311 typedef struct _EFI_HII_SIBT_DUPLICATE_BLOCK
{
312 EFI_HII_STRING_BLOCK Header
;
313 EFI_STRING_ID StringId
;
314 } EFI_HII_SIBT_DUPLICATE_BLOCK
;
316 typedef struct _EFI_HII_SIBT_END_BLOCK
{
317 EFI_HII_STRING_BLOCK Header
;
318 } EFI_HII_SIBT_END_BLOCK
;
320 typedef struct _EFI_HII_SIBT_EXT1_BLOCK
{
321 EFI_HII_STRING_BLOCK Header
;
324 } EFI_HII_SIBT_EXT1_BLOCK
;
326 typedef struct _EFI_HII_SIBT_EXT2_BLOCK
{
327 EFI_HII_STRING_BLOCK Header
;
330 } EFI_HII_SIBT_EXT2_BLOCK
;
332 typedef struct _EFI_HII_SIBT_EXT4_BLOCK
{
333 EFI_HII_STRING_BLOCK Header
;
336 } EFI_HII_SIBT_EXT4_BLOCK
;
338 typedef struct _EFI_HII_SIBT_FONT_BLOCK
{
339 EFI_HII_SIBT_EXT2_BLOCK Header
;
342 EFI_HII_FONT_STYLE FontStyle
;
344 } EFI_HII_SIBT_FONT_BLOCK
;
346 typedef struct _EFI_HII_SIBT_SKIP1_BLOCK
{
347 EFI_HII_STRING_BLOCK Header
;
349 } EFI_HII_SIBT_SKIP1_BLOCK
;
351 typedef struct _EFI_HII_SIBT_SKIP2_BLOCK
{
352 EFI_HII_STRING_BLOCK Header
;
354 } EFI_HII_SIBT_SKIP2_BLOCK
;
356 typedef struct _EFI_HII_SIBT_STRING_SCSU_BLOCK
{
357 EFI_HII_STRING_BLOCK Header
;
359 } EFI_HII_SIBT_STRING_SCSU_BLOCK
;
361 typedef struct _EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
{
362 EFI_HII_STRING_BLOCK Header
;
363 UINT8 FontIdentifier
;
365 } EFI_HII_SIBT_STRING_SCSU_FONT_BLOCK
;
367 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_BLOCK
{
368 EFI_HII_STRING_BLOCK Header
;
371 } EFI_HII_SIBT_STRINGS_SCSU_BLOCK
;
373 typedef struct _EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
{
374 EFI_HII_STRING_BLOCK Header
;
375 UINT8 FontIdentifier
;
378 } EFI_HII_SIBT_STRINGS_SCSU_FONT_BLOCK
;
380 typedef struct _EFI_HII_SIBT_STRING_UCS2_BLOCK
{
381 EFI_HII_STRING_BLOCK Header
;
382 CHAR16 StringText
[1];
383 } EFI_HII_SIBT_STRING_UCS2_BLOCK
;
385 typedef struct _EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
{
386 EFI_HII_STRING_BLOCK Header
;
387 UINT8 FontIdentifier
;
388 CHAR16 StringText
[1];
389 } EFI_HII_SIBT_STRING_UCS2_FONT_BLOCK
;
391 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_BLOCK
{
392 EFI_HII_STRING_BLOCK Header
;
394 CHAR16 StringText
[1];
395 } EFI_HII_SIBT_STRINGS_UCS2_BLOCK
;
397 typedef struct _EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
{
398 EFI_HII_STRING_BLOCK Header
;
399 UINT8 FontIdentifier
;
401 CHAR16 StringText
[1];
402 } EFI_HII_SIBT_STRINGS_UCS2_FONT_BLOCK
;
408 typedef struct _EFI_HII_IMAGE_PACKAGE_HDR
{
409 EFI_HII_PACKAGE_HEADER Header
;
410 UINT32 ImageInfoOffset
;
411 UINT32 PaletteInfoOffset
;
412 } EFI_HII_IMAGE_PACKAGE_HDR
;
414 typedef struct _EFI_HII_IMAGE_BLOCK
{
416 } EFI_HII_IMAGE_BLOCK
;
418 #define EFI_HII_IIBT_END 0x00
419 #define EFI_HII_IIBT_IMAGE_1BIT 0x10
420 #define EFI_HII_IIBT_IMAGE_1BIT_TRANS 0x11
421 #define EFI_HII_IIBT_IMAGE_4BIT 0x12
422 #define EFI_HII_IIBT_IMAGE_4BIT_TRANS 0x13
423 #define EFI_HII_IIBT_IMAGE_8BIT 0x14
424 #define EFI_HII_IIBT_IMAGE_8BIT_TRANS 0x15
425 #define EFI_HII_IIBT_IMAGE_24BIT 0x16
426 #define EFI_HII_IIBT_IMAGE_24BIT_TRANS 0x17
427 #define EFI_HII_IIBT_IMAGE_JPEG 0x18
428 #define EFI_HII_IIBT_IMAGE_PNG 0x19
429 #define EFI_HII_IIBT_DUPLICATE 0x20
430 #define EFI_HII_IIBT_SKIP2 0x21
431 #define EFI_HII_IIBT_SKIP1 0x22
432 #define EFI_HII_IIBT_EXT1 0x30
433 #define EFI_HII_IIBT_EXT2 0x31
434 #define EFI_HII_IIBT_EXT4 0x32
436 typedef struct _EFI_HII_IIBT_END_BLOCK
{
437 EFI_HII_IMAGE_BLOCK Header
;
438 } EFI_HII_IIBT_END_BLOCK
;
440 typedef struct _EFI_HII_IIBT_EXT1_BLOCK
{
441 EFI_HII_IMAGE_BLOCK Header
;
444 } EFI_HII_IIBT_EXT1_BLOCK
;
446 typedef struct _EFI_HII_IIBT_EXT2_BLOCK
{
447 EFI_HII_IMAGE_BLOCK Header
;
450 } EFI_HII_IIBT_EXT2_BLOCK
;
452 typedef struct _EFI_HII_IIBT_EXT4_BLOCK
{
453 EFI_HII_IMAGE_BLOCK Header
;
456 } EFI_HII_IIBT_EXT4_BLOCK
;
458 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BASE
{
462 } EFI_HII_IIBT_IMAGE_1BIT_BASE
;
464 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_BLOCK
{
465 EFI_HII_IMAGE_BLOCK Header
;
467 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
468 } EFI_HII_IIBT_IMAGE_1BIT_BLOCK
;
470 typedef struct _EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
{
471 EFI_HII_IMAGE_BLOCK Header
;
473 EFI_HII_IIBT_IMAGE_1BIT_BASE Bitmap
;
474 } EFI_HII_IIBT_IMAGE_1BIT_TRANS_BLOCK
;
476 typedef struct _EFI_HII_RGB_PIXEL
{
482 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BASE
{
485 EFI_HII_RGB_PIXEL Bitmap
[1];
486 } EFI_HII_IIBT_IMAGE_24BIT_BASE
;
488 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_BLOCK
{
489 EFI_HII_IMAGE_BLOCK Header
;
490 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
491 } EFI_HII_IIBT_IMAGE_24BIT_BLOCK
;
493 typedef struct _EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
{
494 EFI_HII_IMAGE_BLOCK Header
;
495 EFI_HII_IIBT_IMAGE_24BIT_BASE Bitmap
;
496 } EFI_HII_IIBT_IMAGE_24BIT_TRANS_BLOCK
;
498 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BASE
{
502 } EFI_HII_IIBT_IMAGE_4BIT_BASE
;
504 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_BLOCK
{
505 EFI_HII_IMAGE_BLOCK Header
;
507 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
508 } EFI_HII_IIBT_IMAGE_4BIT_BLOCK
;
510 typedef struct _EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
{
511 EFI_HII_IMAGE_BLOCK Header
;
513 EFI_HII_IIBT_IMAGE_4BIT_BASE Bitmap
;
514 } EFI_HII_IIBT_IMAGE_4BIT_TRANS_BLOCK
;
516 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_BASE
{
520 } EFI_HII_IIBT_IMAGE_8BIT_BASE
;
522 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_PALETTE_BLOCK
{
523 EFI_HII_IMAGE_BLOCK Header
;
525 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
526 } EFI_HII_IIBT_IMAGE_8BIT_BLOCK
;
528 typedef struct _EFI_HII_IIBT_IMAGE_8BIT_TRANS_BLOCK
{
529 EFI_HII_IMAGE_BLOCK Header
;
531 EFI_HII_IIBT_IMAGE_8BIT_BASE Bitmap
;
532 } EFI_HII_IIBT_IMAGE_8BIT_TRAN_BLOCK
;
534 typedef struct _EFI_HII_IIBT_DUPLICATE_BLOCK
{
535 EFI_HII_IMAGE_BLOCK Header
;
536 EFI_IMAGE_ID ImageId
;
537 } EFI_HII_IIBT_DUPLICATE_BLOCK
;
539 typedef struct _EFI_HII_IIBT_JPEG_BLOCK
{
540 EFI_HII_IMAGE_BLOCK Header
;
543 } EFI_HII_IIBT_JPEG_BLOCK
;
545 typedef struct _EFI_HII_IIBT_PNG_BLOCK
{
546 EFI_HII_IMAGE_BLOCK Header
;
549 } EFI_HII_IIBT_PNG_BLOCK
;
551 typedef struct _EFI_HII_IIBT_SKIP1_BLOCK
{
552 EFI_HII_IMAGE_BLOCK Header
;
554 } EFI_HII_IIBT_SKIP1_BLOCK
;
556 typedef struct _EFI_HII_IIBT_SKIP2_BLOCK
{
557 EFI_HII_IMAGE_BLOCK Header
;
559 } EFI_HII_IIBT_SKIP2_BLOCK
;
561 typedef struct _EFI_HII_IMAGE_PALETTE_INFO_HEADER
{
563 } EFI_HII_IMAGE_PALETTE_INFO_HEADER
;
565 typedef struct _EFI_HII_IMAGE_PALETTE_INFO
{
567 EFI_HII_RGB_PIXEL PaletteValue
[1];
568 } EFI_HII_IMAGE_PALETTE_INFO
;
574 typedef struct _EFI_HII_FORM_PACKAGE
{
575 EFI_HII_PACKAGE_HEADER Header
;
576 // EFI_IFR_OP_HEADER OpCodeHeader;
577 // More op-codes follow
578 } EFI_HII_FORM_PACKAGE
;
593 EFI_QUESTION_ID QuestionId
;
595 EFI_GUID FormSetGuid
;
596 EFI_STRING_ID DevicePath
;
607 EFI_STRING_ID string
;
609 } EFI_IFR_TYPE_VALUE
;
611 #define EFI_IFR_FORM_OP 0x01
612 #define EFI_IFR_SUBTITLE_OP 0x02
613 #define EFI_IFR_TEXT_OP 0x03
614 #define EFI_IFR_IMAGE_OP 0x04
615 #define EFI_IFR_ONE_OF_OP 0x05
616 #define EFI_IFR_CHECKBOX_OP 0x06
617 #define EFI_IFR_NUMERIC_OP 0x07
618 #define EFI_IFR_PASSWORD_OP 0x08
619 #define EFI_IFR_ONE_OF_OPTION_OP 0x09
620 #define EFI_IFR_SUPPRESS_IF_OP 0x0A
621 #define EFI_IFR_LOCKED_OP 0x0B
622 #define EFI_IFR_ACTION_OP 0x0C
623 #define EFI_IFR_RESET_BUTTON_OP 0x0D
624 #define EFI_IFR_FORM_SET_OP 0x0E
625 #define EFI_IFR_REF_OP 0x0F
626 #define EFI_IFR_NO_SUBMIT_IF_OP 0x10
627 #define EFI_IFR_INCONSISTENT_IF_OP 0x11
628 #define EFI_IFR_EQ_ID_VAL_OP 0x12
629 #define EFI_IFR_EQ_ID_ID_OP 0x13
630 #define EFI_IFR_EQ_ID_VAL_LIST_OP 0x14
631 #define EFI_IFR_AND_OP 0x15
632 #define EFI_IFR_OR_OP 0x16
633 #define EFI_IFR_NOT_OP 0x17
634 #define EFI_IFR_RULE_OP 0x18
635 #define EFI_IFR_GRAY_OUT_IF_OP 0x19
636 #define EFI_IFR_DATE_OP 0x1A
637 #define EFI_IFR_TIME_OP 0x1B
638 #define EFI_IFR_STRING_OP 0x1C
639 #define EFI_IFR_REFRESH_OP 0x1D
640 #define EFI_IFR_DISABLE_IF_OP 0x1E
641 #define EFI_IFR_TO_LOWER_OP 0x20
642 #define EFI_IFR_TO_UPPER_OP 0x21
643 #define EFI_IFR_MAP_OP 0x22
644 #define EFI_IFR_ORDERED_LIST_OP 0x23
645 #define EFI_IFR_VARSTORE_OP 0x24
646 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
647 #define EFI_IFR_VARSTORE_EFI_OP 0x26
648 #define EFI_IFR_VARSTORE_DEVICE_OP 0x27
649 #define EFI_IFR_VERSION_OP 0x28
650 #define EFI_IFR_END_OP 0x29
651 #define EFI_IFR_MATCH_OP 0x2A
652 #define EFI_IFR_GET_OP 0x2B
653 #define EFI_IFR_SET_OP 0x2C
654 #define EFI_IFR_READ_OP 0x2D
655 #define EFI_IFR_WRITE_OP 0x2E
656 #define EFI_IFR_EQUAL_OP 0x2F
657 #define EFI_IFR_NOT_EQUAL_OP 0x30
658 #define EFI_IFR_GREATER_THAN_OP 0x31
659 #define EFI_IFR_GREATER_EQUAL_OP 0x32
660 #define EFI_IFR_LESS_THAN_OP 0x33
661 #define EFI_IFR_LESS_EQUAL_OP 0x34
662 #define EFI_IFR_BITWISE_AND_OP 0x35
663 #define EFI_IFR_BITWISE_OR_OP 0x36
664 #define EFI_IFR_BITWISE_NOT_OP 0x37
665 #define EFI_IFR_SHIFT_LEFT_OP 0x38
666 #define EFI_IFR_SHIFT_RIGHT_OP 0x39
667 #define EFI_IFR_ADD_OP 0x3A
668 #define EFI_IFR_SUBTRACT_OP 0x3B
669 #define EFI_IFR_MULTIPLY_OP 0x3C
670 #define EFI_IFR_DIVIDE_OP 0x3D
671 #define EFI_IFR_MODULO_OP 0x3E
672 #define EFI_IFR_RULE_REF_OP 0x3F
673 #define EFI_IFR_QUESTION_REF1_OP 0x40
674 #define EFI_IFR_QUESTION_REF2_OP 0x41
675 #define EFI_IFR_UINT8_OP 0x42
676 #define EFI_IFR_UINT16_OP 0x43
677 #define EFI_IFR_UINT32_OP 0x44
678 #define EFI_IFR_UINT64_OP 0x45
679 #define EFI_IFR_TRUE_OP 0x46
680 #define EFI_IFR_FALSE_OP 0x47
681 #define EFI_IFR_TO_UINT_OP 0x48
682 #define EFI_IFR_TO_STRING_OP 0x49
683 #define EFI_IFR_TO_BOOLEAN_OP 0x4A
684 #define EFI_IFR_MID_OP 0x4B
685 #define EFI_IFR_FIND_OP 0x4C
686 #define EFI_IFR_TOKEN_OP 0x4D
687 #define EFI_IFR_STRING_REF1_OP 0x4E
688 #define EFI_IFR_STRING_REF2_OP 0x4F
689 #define EFI_IFR_CONDITIONAL_OP 0x50
690 #define EFI_IFR_QUESTION_REF3_OP 0x51
691 #define EFI_IFR_ZERO_OP 0x52
692 #define EFI_IFR_ONE_OP 0x53
693 #define EFI_IFR_ONES_OP 0x54
694 #define EFI_IFR_UNDEFINED_OP 0x55
695 #define EFI_IFR_LENGTH_OP 0x56
696 #define EFI_IFR_DUP_OP 0x57
697 #define EFI_IFR_THIS_OP 0x58
698 #define EFI_IFR_SPAN_OP 0x59
699 #define EFI_IFR_VALUE_OP 0x5A
700 #define EFI_IFR_DEFAULT_OP 0x5B
701 #define EFI_IFR_DEFAULTSTORE_OP 0x5C
702 #define EFI_IFR_FORM_MAP_OP 0x5D
703 #define EFI_IFR_CATENATE_OP 0x5E
704 #define EFI_IFR_GUID_OP 0x5F
705 #define EFI_IFR_SECURITY_OP 0x60
706 #define EFI_IFR_MODAL_TAG_OP 0x61
707 #define EFI_IFR_REFRESH_ID_OP 0x62
708 #define EFI_IFR_WARNING_IF_OP 0x63
709 #define EFI_IFR_MATCH2_OP 0x64
712 typedef struct _EFI_IFR_OP_HEADER
{
718 typedef struct _EFI_IFR_STATEMENT_HEADER
{
719 EFI_STRING_ID Prompt
;
721 } EFI_IFR_STATEMENT_HEADER
;
723 typedef struct _EFI_IFR_QUESTION_HEADER
{
724 EFI_IFR_STATEMENT_HEADER Header
;
725 EFI_QUESTION_ID QuestionId
;
726 EFI_VARSTORE_ID VarStoreId
;
728 EFI_STRING_ID VarName
;
732 } EFI_IFR_QUESTION_HEADER
;
734 #define EFI_IFR_FLAG_READ_ONLY 0x01
735 #define EFI_IFR_FLAG_CALLBACK 0x04
736 #define EFI_IFR_FLAG_RESET_REQUIRED 0x10
737 #define EFI_IFR_FLAG_RECONNECT_REQUIRED 0x40
738 #define EFI_IFR_FLAG_OPTIONS_ONLY 0x80
740 typedef struct _EFI_IFR_DEFAULTSTORE
{
741 EFI_IFR_OP_HEADER Header
;
742 EFI_STRING_ID DefaultName
;
744 } EFI_IFR_DEFAULTSTORE
;
746 #define EFI_HII_DEFAULT_CLASS_STANDARD 0x0000
747 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING 0x0001
748 #define EFI_HII_DEFAULT_CLASS_SAFE 0x0002
749 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
750 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END 0x7fff
751 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
752 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END 0xbfff
753 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
754 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END 0xffff
756 typedef struct _EFI_IFR_VARSTORE
{
757 EFI_IFR_OP_HEADER Header
;
759 EFI_VARSTORE_ID VarStoreId
;
764 typedef struct _EFI_IFR_VARSTORE_EFI
{
765 EFI_IFR_OP_HEADER Header
;
766 EFI_VARSTORE_ID VarStoreId
;
771 } EFI_IFR_VARSTORE_EFI
;
773 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE
{
774 EFI_IFR_OP_HEADER Header
;
775 EFI_VARSTORE_ID VarStoreId
;
777 } EFI_IFR_VARSTORE_NAME_VALUE
;
779 typedef struct _EFI_IFR_FORM_SET
{
780 EFI_IFR_OP_HEADER Header
;
782 EFI_STRING_ID FormSetTitle
;
785 // EFI_GUID ClassGuid[];
788 typedef struct _EFI_IFR_END
{
789 EFI_IFR_OP_HEADER Header
;
792 typedef struct _EFI_IFR_FORM
{
793 EFI_IFR_OP_HEADER Header
;
795 EFI_STRING_ID FormTitle
;
798 typedef struct _EFI_IFR_IMAGE
{
799 EFI_IFR_OP_HEADER Header
;
803 typedef struct _EFI_IFR_MODAL_TAG
{
804 EFI_IFR_OP_HEADER Header
;
807 typedef struct _EFI_IFR_LOCKED
{
808 EFI_IFR_OP_HEADER Header
;
811 typedef struct _EFI_IFR_RULE
{
812 EFI_IFR_OP_HEADER Header
;
816 typedef struct _EFI_IFR_DEFAULT
{
817 EFI_IFR_OP_HEADER Header
;
820 EFI_IFR_TYPE_VALUE Value
;
823 typedef struct _EFI_IFR_DEFAULT_2
{
824 EFI_IFR_OP_HEADER Header
;
829 typedef struct _EFI_IFR_VALUE
{
830 EFI_IFR_OP_HEADER Header
;
833 typedef struct _EFI_IFR_SUBTITLE
{
834 EFI_IFR_OP_HEADER Header
;
835 EFI_IFR_STATEMENT_HEADER Statement
;
839 #define EFI_IFR_FLAGS_HORIZONTAL 0x01
841 typedef struct _EFI_IFR_CHECKBOX
{
842 EFI_IFR_OP_HEADER Header
;
843 EFI_IFR_QUESTION_HEADER Question
;
847 #define EFI_IFR_CHECKBOX_DEFAULT 0x01
848 #define EFI_IFR_CHECKBOX_DEFAULT_MFG 0x02
850 typedef struct _EFI_IFR_TEXT
{
851 EFI_IFR_OP_HEADER Header
;
852 EFI_IFR_STATEMENT_HEADER Statement
;
853 EFI_STRING_ID TextTwo
;
856 typedef struct _EFI_IFR_REF
{
857 EFI_IFR_OP_HEADER Header
;
858 EFI_IFR_QUESTION_HEADER Question
;
862 typedef struct _EFI_IFR_REF2
{
863 EFI_IFR_OP_HEADER Header
;
864 EFI_IFR_QUESTION_HEADER Question
;
866 EFI_QUESTION_ID QuestionId
;
869 typedef struct _EFI_IFR_REF3
{
870 EFI_IFR_OP_HEADER Header
;
871 EFI_IFR_QUESTION_HEADER Question
;
873 EFI_QUESTION_ID QuestionId
;
877 typedef struct _EFI_IFR_REF4
{
878 EFI_IFR_OP_HEADER Header
;
879 EFI_IFR_QUESTION_HEADER Question
;
881 EFI_QUESTION_ID QuestionId
;
883 EFI_STRING_ID DevicePath
;
886 typedef struct _EFI_IFR_REF5
{
887 EFI_IFR_OP_HEADER Header
;
888 EFI_IFR_QUESTION_HEADER Question
;
891 typedef struct _EFI_IFR_RESET_BUTTON
{
892 EFI_IFR_OP_HEADER Header
;
893 EFI_IFR_STATEMENT_HEADER Statement
;
894 EFI_DEFAULT_ID DefaultId
;
895 } EFI_IFR_RESET_BUTTON
;
897 typedef struct _EFI_IFR_ACTION
{
898 EFI_IFR_OP_HEADER Header
;
899 EFI_IFR_QUESTION_HEADER Question
;
900 EFI_STRING_ID QuestionConfig
;
903 typedef struct _EFI_IFR_ACTION_1
{
904 EFI_IFR_OP_HEADER Header
;
905 EFI_IFR_QUESTION_HEADER Question
;
908 typedef struct _EFI_IFR_DATE
{
909 EFI_IFR_OP_HEADER Header
;
910 EFI_IFR_QUESTION_HEADER Question
;
914 #define EFI_QF_DATE_YEAR_SUPPRESS 0x01
915 #define EFI_QF_DATE_MONTH_SUPPRESS 0x02
916 #define EFI_QF_DATE_DAY_SUPPRESS 0x04
918 #define EFI_QF_DATE_STORAGE 0x30
919 #define QF_DATE_STORAGE_NORMAL 0x00
920 #define QF_DATE_STORAGE_TIME 0x10
921 #define QF_DATE_STORAGE_WAKEUP 0x20
946 typedef struct _EFI_IFR_NUMERIC
{
947 EFI_IFR_OP_HEADER Header
;
948 EFI_IFR_QUESTION_HEADER Question
;
950 MINMAXSTEP_DATA data
;
953 #define EFI_IFR_NUMERIC_SIZE 0x03
954 #define EFI_IFR_NUMERIC_SIZE_1 0x00
955 #define EFI_IFR_NUMERIC_SIZE_2 0x01
956 #define EFI_IFR_NUMERIC_SIZE_4 0x02
957 #define EFI_IFR_NUMERIC_SIZE_8 0x03
959 #define EFI_IFR_DISPLAY 0x30
960 #define EFI_IFR_DISPLAY_INT_DEC 0x00
961 #define EFI_IFR_DISPLAY_UINT_DEC 0x10
962 #define EFI_IFR_DISPLAY_UINT_HEX 0x20
964 typedef struct _EFI_IFR_ONE_OF
{
965 EFI_IFR_OP_HEADER Header
;
966 EFI_IFR_QUESTION_HEADER Question
;
968 MINMAXSTEP_DATA data
;
971 typedef struct _EFI_IFR_STRING
{
972 EFI_IFR_OP_HEADER Header
;
973 EFI_IFR_QUESTION_HEADER Question
;
979 #define EFI_IFR_STRING_MULTI_LINE 0x01
981 typedef struct _EFI_IFR_PASSWORD
{
982 EFI_IFR_OP_HEADER Header
;
983 EFI_IFR_QUESTION_HEADER Question
;
988 typedef struct _EFI_IFR_ORDERED_LIST
{
989 EFI_IFR_OP_HEADER Header
;
990 EFI_IFR_QUESTION_HEADER Question
;
993 } EFI_IFR_ORDERED_LIST
;
995 #define EFI_IFR_UNIQUE_SET 0x01
996 #define EFI_IFR_NO_EMPTY_SET 0x02
998 typedef struct _EFI_IFR_TIME
{
999 EFI_IFR_OP_HEADER Header
;
1000 EFI_IFR_QUESTION_HEADER Question
;
1004 #define QF_TIME_HOUR_SUPPRESS 0x01
1005 #define QF_TIME_MINUTE_SUPPRESS 0x02
1006 #define QF_TIME_SECOND_SUPPRESS 0x04
1008 #define QF_TIME_STORAGE 0x30
1009 #define QF_TIME_STORAGE_NORMAL 0x00
1010 #define QF_TIME_STORAGE_TIME 0x10
1011 #define QF_TIME_STORAGE_WAKEUP 0x20
1013 typedef struct _EFI_IFR_DISABLE_IF
{
1014 EFI_IFR_OP_HEADER Header
;
1015 } EFI_IFR_DISABLE_IF
;
1017 typedef struct _EFI_IFR_SUPPRESS_IF
{
1018 EFI_IFR_OP_HEADER Header
;
1019 } EFI_IFR_SUPPRESS_IF
;
1021 typedef struct _EFI_IFR_GRAY_OUT_IF
{
1022 EFI_IFR_OP_HEADER Header
;
1023 } EFI_IFR_GRAY_OUT_IF
;
1025 typedef struct _EFI_IFR_INCONSISTENT_IF
{
1026 EFI_IFR_OP_HEADER Header
;
1027 EFI_STRING_ID Error
;
1028 } EFI_IFR_INCONSISTENT_IF
;
1030 typedef struct _EFI_IFR_NO_SUBMIT_IF
{
1031 EFI_IFR_OP_HEADER Header
;
1032 EFI_STRING_ID Error
;
1033 } EFI_IFR_NO_SUBMIT_IF
;
1035 typedef struct _EFI_IFR_WARNING_IF
{
1036 EFI_IFR_OP_HEADER Header
;
1037 EFI_STRING_ID Warning
;
1039 } EFI_IFR_WARNING_IF
;
1041 typedef struct _EFI_IFR_REFRESH
{
1042 EFI_IFR_OP_HEADER Header
;
1043 UINT8 RefreshInterval
;
1046 typedef struct _EFI_IFR_REFRESH_ID
{
1047 EFI_IFR_OP_HEADER Header
;
1048 EFI_GUID RefreshEventGroupId
;
1049 } EFI_IFR_REFRESH_ID
;
1051 typedef struct _EFI_IFR_VARSTORE_DEVICE
{
1052 EFI_IFR_OP_HEADER Header
;
1053 EFI_STRING_ID DevicePath
;
1054 } EFI_IFR_VARSTORE_DEVICE
;
1056 typedef struct _EFI_IFR_ONE_OF_OPTION
{
1057 EFI_IFR_OP_HEADER Header
;
1058 EFI_STRING_ID Option
;
1061 EFI_IFR_TYPE_VALUE Value
;
1062 } EFI_IFR_ONE_OF_OPTION
;
1064 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
1065 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
1066 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
1067 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
1068 #define EFI_IFR_TYPE_BOOLEAN 0x04
1069 #define EFI_IFR_TYPE_TIME 0x05
1070 #define EFI_IFR_TYPE_DATE 0x06
1071 #define EFI_IFR_TYPE_STRING 0x07
1072 #define EFI_IFR_TYPE_OTHER 0x08
1073 #define EFI_IFR_TYPE_UNDEFINED 0x09
1074 #define EFI_IFR_TYPE_ACTION 0x0A
1075 #define EFI_IFR_TYPE_BUFFER 0x0B
1076 #define EFI_IFR_TYPE_REF 0x0C
1078 #define EFI_IFR_OPTION_DEFAULT 0x10
1079 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
1081 typedef struct _EFI_IFR_GUID
{
1082 EFI_IFR_OP_HEADER Header
;
1084 //Optional Data Follows
1087 typedef struct _EFI_IFR_DUP
{
1088 EFI_IFR_OP_HEADER Header
;
1091 typedef struct _EFI_IFR_EQ_ID_ID
{
1092 EFI_IFR_OP_HEADER Header
;
1093 EFI_QUESTION_ID QuestionId1
;
1094 EFI_QUESTION_ID QuestionId2
;
1097 typedef struct _EFI_IFR_EQ_ID_VAL
{
1098 EFI_IFR_OP_HEADER Header
;
1099 EFI_QUESTION_ID QuestionId
;
1101 } EFI_IFR_EQ_ID_VAL
;
1103 typedef struct _EFI_IFR_EQ_ID_VAL_LIST
{
1104 EFI_IFR_OP_HEADER Header
;
1105 EFI_QUESTION_ID QuestionId
;
1107 UINT16 ValueList
[1];
1108 } EFI_IFR_EQ_ID_VAL_LIST
;
1110 typedef struct _EFI_IFR_QUESTION_REF1
{
1111 EFI_IFR_OP_HEADER Header
;
1112 EFI_QUESTION_ID QuestionId
;
1113 } EFI_IFR_QUESTION_REF1
;
1115 typedef struct _EFI_IFR_UINT8
{
1116 EFI_IFR_OP_HEADER Header
;
1120 typedef struct _EFI_IFR_UINT16
{
1121 EFI_IFR_OP_HEADER Header
;
1125 typedef struct _EFI_IFR_QUESTION_REF2
{
1126 EFI_IFR_OP_HEADER Header
;
1127 } EFI_IFR_QUESTION_REF2
;
1129 typedef struct _EFI_IFR_UINT32
{
1130 EFI_IFR_OP_HEADER Header
;
1134 typedef struct _EFI_IFR_UINT64
{
1135 EFI_IFR_OP_HEADER Header
;
1139 typedef struct _EFI_IFR_QUESTION_REF3
{
1140 EFI_IFR_OP_HEADER Header
;
1141 } EFI_IFR_QUESTION_REF3
;
1143 typedef struct _EFI_IFR_QUESTION_REF3_2
{
1144 EFI_IFR_OP_HEADER Header
;
1145 EFI_STRING_ID DevicePath
;
1146 } EFI_IFR_QUESTION_REF3_2
;
1148 typedef struct _EFI_IFR_QUESTION_REF3_3
{
1149 EFI_IFR_OP_HEADER Header
;
1150 EFI_STRING_ID DevicePath
;
1152 } EFI_IFR_QUESTION_REF3_3
;
1154 typedef struct _EFI_IFR_RULE_REF
{
1155 EFI_IFR_OP_HEADER Header
;
1159 typedef struct _EFI_IFR_STRING_REF1
{
1160 EFI_IFR_OP_HEADER Header
;
1161 EFI_STRING_ID StringId
;
1162 } EFI_IFR_STRING_REF1
;
1164 typedef struct _EFI_IFR_STRING_REF2
{
1165 EFI_IFR_OP_HEADER Header
;
1166 } EFI_IFR_STRING_REF2
;
1168 typedef struct _EFI_IFR_THIS
{
1169 EFI_IFR_OP_HEADER Header
;
1172 typedef struct _EFI_IFR_TRUE
{
1173 EFI_IFR_OP_HEADER Header
;
1176 typedef struct _EFI_IFR_FALSE
{
1177 EFI_IFR_OP_HEADER Header
;
1180 typedef struct _EFI_IFR_ONE
{
1181 EFI_IFR_OP_HEADER Header
;
1184 typedef struct _EFI_IFR_ONES
{
1185 EFI_IFR_OP_HEADER Header
;
1188 typedef struct _EFI_IFR_ZERO
{
1189 EFI_IFR_OP_HEADER Header
;
1192 typedef struct _EFI_IFR_UNDEFINED
{
1193 EFI_IFR_OP_HEADER Header
;
1194 } EFI_IFR_UNDEFINED
;
1196 typedef struct _EFI_IFR_VERSION
{
1197 EFI_IFR_OP_HEADER Header
;
1200 typedef struct _EFI_IFR_LENGTH
{
1201 EFI_IFR_OP_HEADER Header
;
1204 typedef struct _EFI_IFR_NOT
{
1205 EFI_IFR_OP_HEADER Header
;
1208 typedef struct _EFI_IFR_BITWISE_NOT
{
1209 EFI_IFR_OP_HEADER Header
;
1210 } EFI_IFR_BITWISE_NOT
;
1212 typedef struct _EFI_IFR_TO_BOOLEAN
{
1213 EFI_IFR_OP_HEADER Header
;
1214 } EFI_IFR_TO_BOOLEAN
;
1216 #define EFI_IFR_STRING_UNSIGNED_DEC 0
1217 #define EFI_IFR_STRING_SIGNED_DEC 1
1218 #define EFI_IFR_STRING_LOWERCASE_HEX 2
1219 #define EFI_IFR_STRING_UPPERCASE_HEX 3
1221 #define EFI_IFR_STRING_ASCII 0
1222 #define EFI_IFR_STRING_UNICODE 8
1224 typedef struct _EFI_IFR_TO_STRING
{
1225 EFI_IFR_OP_HEADER Header
;
1227 } EFI_IFR_TO_STRING
;
1229 typedef struct _EFI_IFR_TO_UINT
{
1230 EFI_IFR_OP_HEADER Header
;
1233 typedef struct _EFI_IFR_TO_UPPER
{
1234 EFI_IFR_OP_HEADER Header
;
1237 typedef struct _EFI_IFR_TO_LOWER
{
1238 EFI_IFR_OP_HEADER Header
;
1241 typedef struct _EFI_IFR_ADD
{
1242 EFI_IFR_OP_HEADER Header
;
1245 typedef struct _EFI_IFR_AND
{
1246 EFI_IFR_OP_HEADER Header
;
1249 typedef struct _EFI_IFR_BITWISE_AND
{
1250 EFI_IFR_OP_HEADER Header
;
1251 } EFI_IFR_BITWISE_AND
;
1253 typedef struct _EFI_IFR_BITWISE_OR
{
1254 EFI_IFR_OP_HEADER Header
;
1255 } EFI_IFR_BITWISE_OR
;
1257 typedef struct _EFI_IFR_CATENATE
{
1258 EFI_IFR_OP_HEADER Header
;
1261 typedef struct _EFI_IFR_DIVIDE
{
1262 EFI_IFR_OP_HEADER Header
;
1265 typedef struct _EFI_IFR_EQUAL
{
1266 EFI_IFR_OP_HEADER Header
;
1269 typedef struct _EFI_IFR_GREATER_EQUAL
{
1270 EFI_IFR_OP_HEADER Header
;
1271 } EFI_IFR_GREATER_EQUAL
;
1273 typedef struct _EFI_IFR_GREATER_THAN
{
1274 EFI_IFR_OP_HEADER Header
;
1275 } EFI_IFR_GREATER_THAN
;
1277 typedef struct _EFI_IFR_LESS_EQUAL
{
1278 EFI_IFR_OP_HEADER Header
;
1279 } EFI_IFR_LESS_EQUAL
;
1281 typedef struct _EFI_IFR_LESS_THAN
{
1282 EFI_IFR_OP_HEADER Header
;
1283 } EFI_IFR_LESS_THAN
;
1285 typedef struct _EFI_IFR_MATCH
{
1286 EFI_IFR_OP_HEADER Header
;
1289 typedef struct _EFI_IFR_MATCH2
{
1290 EFI_IFR_OP_HEADER Header
;
1291 EFI_GUID SyntaxType
;
1294 typedef struct _EFI_IFR_MULTIPLY
{
1295 EFI_IFR_OP_HEADER Header
;
1298 typedef struct _EFI_IFR_MODULO
{
1299 EFI_IFR_OP_HEADER Header
;
1302 typedef struct _EFI_IFR_NOT_EQUAL
{
1303 EFI_IFR_OP_HEADER Header
;
1304 } EFI_IFR_NOT_EQUAL
;
1306 typedef struct _EFI_IFR_OR
{
1307 EFI_IFR_OP_HEADER Header
;
1310 typedef struct _EFI_IFR_SHIFT_LEFT
{
1311 EFI_IFR_OP_HEADER Header
;
1312 } EFI_IFR_SHIFT_LEFT
;
1314 typedef struct _EFI_IFR_SHIFT_RIGHT
{
1315 EFI_IFR_OP_HEADER Header
;
1316 } EFI_IFR_SHIFT_RIGHT
;
1318 typedef struct _EFI_IFR_SUBTRACT
{
1319 EFI_IFR_OP_HEADER Header
;
1322 typedef struct _EFI_IFR_CONDITIONAL
{
1323 EFI_IFR_OP_HEADER Header
;
1324 } EFI_IFR_CONDITIONAL
;
1326 #define EFI_IFR_FF_CASE_SENSITIVE 0x00
1327 #define EFI_IFR_FF_CASE_INSENSITIVE 0x01
1329 typedef struct _EFI_IFR_FIND
{
1330 EFI_IFR_OP_HEADER Header
;
1334 typedef struct _EFI_IFR_MID
{
1335 EFI_IFR_OP_HEADER Header
;
1338 typedef struct _EFI_IFR_TOKEN
{
1339 EFI_IFR_OP_HEADER Header
;
1342 #define EFI_IFR_FLAGS_FIRST_MATCHING 0x00
1343 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1345 typedef struct _EFI_IFR_SPAN
{
1346 EFI_IFR_OP_HEADER Header
;
1350 typedef struct _EFI_IFR_SECURITY
{
1352 /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
1354 EFI_IFR_OP_HEADER Header
;
1356 /// Security permission level.
1358 EFI_GUID Permissions
;
1361 typedef struct _EFI_IFR_FORM_MAP_METHOD
{
1363 /// The string identifier which provides the human-readable name of
1364 /// the configuration method for this standards map form.
1366 EFI_STRING_ID MethodTitle
;
1368 /// Identifier which uniquely specifies the configuration methods
1369 /// associated with this standards map form.
1371 EFI_GUID MethodIdentifier
;
1372 } EFI_IFR_FORM_MAP_METHOD
;
1374 typedef struct _EFI_IFR_FORM_MAP
{
1376 /// The sequence that defines the type of opcode as well as the length
1377 /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
1379 EFI_IFR_OP_HEADER Header
;
1381 /// The unique identifier for this particular form.
1385 /// One or more configuration method's name and unique identifier.
1387 // EFI_IFR_FORM_MAP_METHOD Methods[];
1390 typedef struct _EFI_IFR_SET
{
1392 /// The sequence that defines the type of opcode as well as the length
1393 /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
1395 EFI_IFR_OP_HEADER Header
;
1397 /// Specifies the identifier of a previously declared variable store to
1398 /// use when storing the question's value.
1400 EFI_VARSTORE_ID VarStoreId
;
1403 /// A 16-bit Buffer Storage offset.
1405 EFI_STRING_ID VarName
;
1407 /// A Name Value or EFI Variable name (VarName).
1412 /// Specifies the type used for storage.
1417 typedef struct _EFI_IFR_GET
{
1419 /// The sequence that defines the type of opcode as well as the length
1420 /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
1422 EFI_IFR_OP_HEADER Header
;
1424 /// Specifies the identifier of a previously declared variable store to
1425 /// use when retrieving the value.
1427 EFI_VARSTORE_ID VarStoreId
;
1430 /// A 16-bit Buffer Storage offset.
1432 EFI_STRING_ID VarName
;
1434 /// A Name Value or EFI Variable name (VarName).
1439 /// Specifies the type used for storage.
1444 typedef struct _EFI_IFR_READ
{
1445 EFI_IFR_OP_HEADER Header
;
1448 typedef struct _EFI_IFR_WRITE
{
1449 EFI_IFR_OP_HEADER Header
;
1452 typedef struct _EFI_IFR_MAP
{
1453 EFI_IFR_OP_HEADER Header
;
1570 CHAR16 ShiftedUnicode
;
1571 CHAR16 AltGrUnicode
;
1572 CHAR16 ShiftedAltGrUnicode
;
1574 UINT16 AffectedAttribute
;
1575 } EFI_KEY_DESCRIPTOR
;
1578 // A key which is affected by all the standard shift modifiers.
1579 // Most keys would be expected to have this bit active.
1581 #define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
1583 // This key is affected by the caps lock so that if a keyboard driver
1584 // would need to disambiguate between a key which had a "1" defined
1585 // versus a "a" character. Having this bit turned on would tell
1586 // the keyboard driver to use the appropriate shifted state or not.
1588 #define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
1590 // Similar to the case of CAPS lock, if this bit is active, the key
1591 // is affected by the num lock being turned on.
1593 #define EFI_AFFECTED_BY_NUM_LOCK 0x0004
1596 UINT16 LayoutLength
;
1598 UINT32 LayoutDescriptorStringOffset
;
1599 UINT8 DescriptorCount
;
1600 // EFI_KEY_DESCRIPTOR Descriptors[];
1601 } EFI_HII_KEYBOARD_LAYOUT
;
1604 EFI_HII_PACKAGE_HEADER Header
;
1606 // EFI_HII_KEYBOARD_LAYOUT Layout[];
1607 } EFI_HII_KEYBOARD_PACKAGE_HDR
;
1612 CHAR16 DescriptionString
[1];
1613 } EFI_DESCRIPTION_STRING
;
1616 UINT16 DescriptionCount
;
1617 EFI_DESCRIPTION_STRING DescriptionString
[1];
1618 } EFI_DESCRIPTION_STRING_BUNDLE
;
1623 #define EFI_NULL_MODIFIER 0x0000
1624 #define EFI_LEFT_CONTROL_MODIFIER 0x0001
1625 #define EFI_RIGHT_CONTROL_MODIFIER 0x0002
1626 #define EFI_LEFT_ALT_MODIFIER 0x0003
1627 #define EFI_RIGHT_ALT_MODIFIER 0x0004
1628 #define EFI_ALT_GR_MODIFIER 0x0005
1629 #define EFI_INSERT_MODIFIER 0x0006
1630 #define EFI_DELETE_MODIFIER 0x0007
1631 #define EFI_PAGE_DOWN_MODIFIER 0x0008
1632 #define EFI_PAGE_UP_MODIFIER 0x0009
1633 #define EFI_HOME_MODIFIER 0x000A
1634 #define EFI_END_MODIFIER 0x000B
1635 #define EFI_LEFT_SHIFT_MODIFIER 0x000C
1636 #define EFI_RIGHT_SHIFT_MODIFIER 0x000D
1637 #define EFI_CAPS_LOCK_MODIFIER 0x000E
1638 #define EFI_NUM_LOCK _MODIFIER 0x000F
1639 #define EFI_LEFT_ARROW_MODIFIER 0x0010
1640 #define EFI_RIGHT_ARROW_MODIFIER 0x0011
1641 #define EFI_DOWN_ARROW_MODIFIER 0x0012
1642 #define EFI_UP_ARROW_MODIFIER 0x0013
1643 #define EFI_NS_KEY_MODIFIER 0x0014
1644 #define EFI_NS_KEY_DEPENDENCY_MODIFIER 0x0015
1645 #define EFI_FUNCTION_KEY_ONE_MODIFIER 0x0016
1646 #define EFI_FUNCTION_KEY_TWO_MODIFIER 0x0017
1647 #define EFI_FUNCTION_KEY_THREE_MODIFIER 0x0018
1648 #define EFI_FUNCTION_KEY_FOUR_MODIFIER 0x0019
1649 #define EFI_FUNCTION_KEY_FIVE_MODIFIER 0x001A
1650 #define EFI_FUNCTION_KEY_SIX_MODIFIER 0x001B
1651 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER 0x001C
1652 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER 0x001D
1653 #define EFI_FUNCTION_KEY_NINE_MODIFIER 0x001E
1654 #define EFI_FUNCTION_KEY_TEN_MODIFIER 0x001F
1655 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1656 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1659 // Keys that have multiple control functions based on modifier
1660 // settings are handled in the keyboard driver implementation.
1661 // For instance PRINT_KEY might have a modifier held down and
1662 // is still a nonprinting character, but might have an alternate
1663 // control function like SYSREQUEST
1665 #define EFI_PRINT_MODIFIER 0x0022
1666 #define EFI_SYS_REQUEST_MODIFIER 0x0023
1667 #define EFI_SCROLL_LOCK_MODIFIER 0x0024
1668 #define EFI_PAUSE_MODIFIER 0x0025
1669 #define EFI_BREAK_MODIFIER 0x0026
1676 // References to string tokens must use this macro to enable scanning for
1680 // STRING_TOKEN is not defined in UEFI specification. But it is placed
1681 // here for the easy access by C files and VFR source files.
1683 #define STRING_TOKEN(t) t