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