MdePkg/Include/Uefi/UefiInternalFormRepresentation.h

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