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 - 2013, Intel Corporation. All rights reserved.<BR>
   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 struct {
 579   EFI_QUESTION_ID QuestionId;
 580   EFI_FORM_ID     FormId;
 581   EFI_GUID        FormSetGuid;
 582   EFI_STRING_ID   DevicePath;
 583 } EFI_HII_REF;
 584
 585 typedef union {
 586   UINT8           u8;
 587   UINT16          u16;
 588   UINT32          u32;
 589   UINT64          u64;
 590   BOOLEAN         b;
 591   EFI_HII_TIME    time;
 592   EFI_HII_DATE    date;
 593   EFI_STRING_ID   string;
 594   EFI_HII_REF     ref;
 595 } EFI_IFR_TYPE_VALUE;
 596
 597 #define EFI_IFR_FORM_OP                0x01
 598 #define EFI_IFR_SUBTITLE_OP            0x02
 599 #define EFI_IFR_TEXT_OP                0x03
 600 #define EFI_IFR_IMAGE_OP               0x04
 601 #define EFI_IFR_ONE_OF_OP              0x05
 602 #define EFI_IFR_CHECKBOX_OP            0x06
 603 #define EFI_IFR_NUMERIC_OP             0x07
 604 #define EFI_IFR_PASSWORD_OP            0x08
 605 #define EFI_IFR_ONE_OF_OPTION_OP       0x09
 606 #define EFI_IFR_SUPPRESS_IF_OP         0x0A
 607 #define EFI_IFR_LOCKED_OP              0x0B
 608 #define EFI_IFR_ACTION_OP              0x0C
 609 #define EFI_IFR_RESET_BUTTON_OP        0x0D
 610 #define EFI_IFR_FORM_SET_OP            0x0E
 611 #define EFI_IFR_REF_OP                 0x0F
 612 #define EFI_IFR_NO_SUBMIT_IF_OP        0x10
 613 #define EFI_IFR_INCONSISTENT_IF_OP     0x11
 614 #define EFI_IFR_EQ_ID_VAL_OP           0x12
 615 #define EFI_IFR_EQ_ID_ID_OP            0x13
 616 #define EFI_IFR_EQ_ID_VAL_LIST_OP      0x14
 617 #define EFI_IFR_AND_OP                 0x15
 618 #define EFI_IFR_OR_OP                  0x16
 619 #define EFI_IFR_NOT_OP                 0x17
 620 #define EFI_IFR_RULE_OP                0x18
 621 #define EFI_IFR_GRAY_OUT_IF_OP         0x19
 622 #define EFI_IFR_DATE_OP                0x1A
 623 #define EFI_IFR_TIME_OP                0x1B
 624 #define EFI_IFR_STRING_OP              0x1C
 625 #define EFI_IFR_REFRESH_OP             0x1D
 626 #define EFI_IFR_DISABLE_IF_OP          0x1E
 627 #define EFI_IFR_TO_LOWER_OP            0x20
 628 #define EFI_IFR_TO_UPPER_OP            0x21
 629 #define EFI_IFR_MAP_OP                 0x22
 630 #define EFI_IFR_ORDERED_LIST_OP        0x23
 631 #define EFI_IFR_VARSTORE_OP            0x24
 632 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
 633 #define EFI_IFR_VARSTORE_EFI_OP        0x26
 634 #define EFI_IFR_VARSTORE_DEVICE_OP     0x27
 635 #define EFI_IFR_VERSION_OP             0x28
 636 #define EFI_IFR_END_OP                 0x29
 637 #define EFI_IFR_MATCH_OP               0x2A
 638 #define EFI_IFR_GET_OP                 0x2B
 639 #define EFI_IFR_SET_OP                 0x2C
 640 #define EFI_IFR_READ_OP                0x2D
 641 #define EFI_IFR_WRITE_OP               0x2E
 642 #define EFI_IFR_EQUAL_OP               0x2F
 643 #define EFI_IFR_NOT_EQUAL_OP           0x30
 644 #define EFI_IFR_GREATER_THAN_OP        0x31
 645 #define EFI_IFR_GREATER_EQUAL_OP       0x32
 646 #define EFI_IFR_LESS_THAN_OP           0x33
 647 #define EFI_IFR_LESS_EQUAL_OP          0x34
 648 #define EFI_IFR_BITWISE_AND_OP         0x35
 649 #define EFI_IFR_BITWISE_OR_OP          0x36
 650 #define EFI_IFR_BITWISE_NOT_OP         0x37
 651 #define EFI_IFR_SHIFT_LEFT_OP          0x38
 652 #define EFI_IFR_SHIFT_RIGHT_OP         0x39
 653 #define EFI_IFR_ADD_OP                 0x3A
 654 #define EFI_IFR_SUBTRACT_OP            0x3B
 655 #define EFI_IFR_MULTIPLY_OP            0x3C
 656 #define EFI_IFR_DIVIDE_OP              0x3D
 657 #define EFI_IFR_MODULO_OP              0x3E
 658 #define EFI_IFR_RULE_REF_OP            0x3F
 659 #define EFI_IFR_QUESTION_REF1_OP       0x40
 660 #define EFI_IFR_QUESTION_REF2_OP       0x41
 661 #define EFI_IFR_UINT8_OP               0x42
 662 #define EFI_IFR_UINT16_OP              0x43
 663 #define EFI_IFR_UINT32_OP              0x44
 664 #define EFI_IFR_UINT64_OP              0x45
 665 #define EFI_IFR_TRUE_OP                0x46
 666 #define EFI_IFR_FALSE_OP               0x47
 667 #define EFI_IFR_TO_UINT_OP             0x48
 668 #define EFI_IFR_TO_STRING_OP           0x49
 669 #define EFI_IFR_TO_BOOLEAN_OP          0x4A
 670 #define EFI_IFR_MID_OP                 0x4B
 671 #define EFI_IFR_FIND_OP                0x4C
 672 #define EFI_IFR_TOKEN_OP               0x4D
 673 #define EFI_IFR_STRING_REF1_OP         0x4E
 674 #define EFI_IFR_STRING_REF2_OP         0x4F
 675 #define EFI_IFR_CONDITIONAL_OP         0x50
 676 #define EFI_IFR_QUESTION_REF3_OP       0x51
 677 #define EFI_IFR_ZERO_OP                0x52
 678 #define EFI_IFR_ONE_OP                 0x53
 679 #define EFI_IFR_ONES_OP                0x54
 680 #define EFI_IFR_UNDEFINED_OP           0x55
 681 #define EFI_IFR_LENGTH_OP              0x56
 682 #define EFI_IFR_DUP_OP                 0x57
 683 #define EFI_IFR_THIS_OP                0x58
 684 #define EFI_IFR_SPAN_OP                0x59
 685 #define EFI_IFR_VALUE_OP               0x5A
 686 #define EFI_IFR_DEFAULT_OP             0x5B
 687 #define EFI_IFR_DEFAULTSTORE_OP        0x5C
 688 #define EFI_IFR_FORM_MAP_OP            0x5D
 689 #define EFI_IFR_CATENATE_OP            0x5E
 690 #define EFI_IFR_GUID_OP                0x5F
 691 #define EFI_IFR_SECURITY_OP            0x60
 692 #define EFI_IFR_MODAL_TAG_OP           0x61
 693 #define EFI_IFR_REFRESH_ID_OP          0x62
 694 #define EFI_IFR_WARNING_IF_OP          0x63
 695
 696
 697 typedef struct _EFI_IFR_OP_HEADER {
 698   UINT8                    OpCode;
 699   UINT8                    Length:7;
 700   UINT8                    Scope:1;
 701 } EFI_IFR_OP_HEADER;
 702
 703 typedef struct _EFI_IFR_STATEMENT_HEADER {
 704   EFI_STRING_ID            Prompt;
 705   EFI_STRING_ID            Help;
 706 } EFI_IFR_STATEMENT_HEADER;
 707
 708 typedef struct _EFI_IFR_QUESTION_HEADER {
 709   EFI_IFR_STATEMENT_HEADER Header;
 710   EFI_QUESTION_ID          QuestionId;
 711   EFI_VARSTORE_ID          VarStoreId;
 712   union {
 713     EFI_STRING_ID          VarName;
 714     UINT16                 VarOffset;
 715   }                        VarStoreInfo;
 716   UINT8                    Flags;
 717 } EFI_IFR_QUESTION_HEADER;
 718
 719 #define EFI_IFR_FLAG_READ_ONLY         0x01
 720 #define EFI_IFR_FLAG_CALLBACK          0x04
 721 #define EFI_IFR_FLAG_RESET_REQUIRED    0x10
 722 #define EFI_IFR_FLAG_OPTIONS_ONLY      0x80
 723
 724 typedef struct _EFI_IFR_DEFAULTSTORE {
 725   EFI_IFR_OP_HEADER        Header;
 726   EFI_STRING_ID            DefaultName;
 727   UINT16                   DefaultId;
 728 } EFI_IFR_DEFAULTSTORE;
 729
 730 #define EFI_HII_DEFAULT_CLASS_STANDARD       0x0000
 731 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING  0x0001
 732 #define EFI_HII_DEFAULT_CLASS_SAFE           0x0002
 733 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
 734 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END   0x7fff
 735 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
 736 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END   0xbfff
 737 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
 738 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END   0xffff
 739
 740 typedef struct _EFI_IFR_VARSTORE {
 741   EFI_IFR_OP_HEADER        Header;
 742   EFI_GUID                 Guid;
 743   EFI_VARSTORE_ID          VarStoreId;
 744   UINT16                   Size;
 745   UINT8                    Name[1];
 746 } EFI_IFR_VARSTORE;
 747
 748 typedef struct _EFI_IFR_VARSTORE_EFI {
 749   EFI_IFR_OP_HEADER        Header;
 750   EFI_VARSTORE_ID          VarStoreId;
 751   EFI_GUID                 Guid;
 752   UINT32                   Attributes;
 753   UINT16                   Size;
 754   UINT8                    Name[1];
 755 } EFI_IFR_VARSTORE_EFI;
 756
 757 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {
 758   EFI_IFR_OP_HEADER        Header;
 759   EFI_VARSTORE_ID          VarStoreId;
 760   EFI_GUID                 Guid;
 761 } EFI_IFR_VARSTORE_NAME_VALUE;
 762
 763 typedef struct _EFI_IFR_FORM_SET {
 764   EFI_IFR_OP_HEADER        Header;
 765   EFI_GUID                 Guid;
 766   EFI_STRING_ID            FormSetTitle;
 767   EFI_STRING_ID            Help;
 768   UINT8                    Flags;
 769   // EFI_GUID              ClassGuid[];
 770 } EFI_IFR_FORM_SET;
 771
 772 typedef struct _EFI_IFR_END {
 773   EFI_IFR_OP_HEADER        Header;
 774 } EFI_IFR_END;
 775
 776 typedef struct _EFI_IFR_FORM {
 777   EFI_IFR_OP_HEADER        Header;
 778   UINT16                   FormId;
 779   EFI_STRING_ID            FormTitle;
 780 } EFI_IFR_FORM;
 781
 782 typedef struct _EFI_IFR_IMAGE {
 783   EFI_IFR_OP_HEADER        Header;
 784   EFI_IMAGE_ID             Id;
 785 } EFI_IFR_IMAGE;
 786
 787 typedef struct _EFI_IFR_MODAL_TAG {
 788   EFI_IFR_OP_HEADER        Header;
 789 } EFI_IFR_MODAL_TAG;
 790
 791 typedef struct _EFI_IFR_LOCKED {
 792   EFI_IFR_OP_HEADER        Header;
 793 } EFI_IFR_LOCKED;
 794
 795 typedef struct _EFI_IFR_RULE {
 796   EFI_IFR_OP_HEADER        Header;
 797   UINT8                    RuleId;
 798 } EFI_IFR_RULE;
 799
 800 typedef struct _EFI_IFR_DEFAULT {
 801   EFI_IFR_OP_HEADER        Header;
 802   UINT16                   DefaultId;
 803   UINT8                    Type;
 804   EFI_IFR_TYPE_VALUE       Value;
 805 } EFI_IFR_DEFAULT;
 806
 807 typedef struct _EFI_IFR_DEFAULT_2 {
 808   EFI_IFR_OP_HEADER        Header;
 809   UINT16                   DefaultId;
 810   UINT8                    Type;
 811 } EFI_IFR_DEFAULT_2;
 812
 813 typedef struct _EFI_IFR_VALUE {
 814   EFI_IFR_OP_HEADER        Header;
 815 } EFI_IFR_VALUE;
 816
 817 typedef struct _EFI_IFR_SUBTITLE {
 818   EFI_IFR_OP_HEADER        Header;
 819   EFI_IFR_STATEMENT_HEADER Statement;
 820   UINT8                    Flags;
 821 } EFI_IFR_SUBTITLE;
 822
 823 #define EFI_IFR_FLAGS_HORIZONTAL       0x01
 824
 825 typedef struct _EFI_IFR_CHECKBOX {
 826   EFI_IFR_OP_HEADER        Header;
 827   EFI_IFR_QUESTION_HEADER  Question;
 828   UINT8                    Flags;
 829 } EFI_IFR_CHECKBOX;
 830
 831 #define EFI_IFR_CHECKBOX_DEFAULT       0x01
 832 #define EFI_IFR_CHECKBOX_DEFAULT_MFG   0x02
 833
 834 typedef struct _EFI_IFR_TEXT {
 835   EFI_IFR_OP_HEADER        Header;
 836   EFI_IFR_STATEMENT_HEADER Statement;
 837   EFI_STRING_ID            TextTwo;
 838 } EFI_IFR_TEXT;
 839
 840 typedef struct _EFI_IFR_REF {
 841   EFI_IFR_OP_HEADER        Header;
 842   EFI_IFR_QUESTION_HEADER  Question;
 843   EFI_FORM_ID              FormId;
 844 } EFI_IFR_REF;
 845
 846 typedef struct _EFI_IFR_REF2 {
 847   EFI_IFR_OP_HEADER        Header;
 848   EFI_IFR_QUESTION_HEADER  Question;
 849   EFI_FORM_ID              FormId;
 850   EFI_QUESTION_ID          QuestionId;
 851 } EFI_IFR_REF2;
 852
 853 typedef struct _EFI_IFR_REF3 {
 854   EFI_IFR_OP_HEADER        Header;
 855   EFI_IFR_QUESTION_HEADER  Question;
 856   EFI_FORM_ID              FormId;
 857   EFI_QUESTION_ID          QuestionId;
 858   EFI_GUID                 FormSetId;
 859 } EFI_IFR_REF3;
 860
 861 typedef struct _EFI_IFR_REF4 {
 862   EFI_IFR_OP_HEADER        Header;
 863   EFI_IFR_QUESTION_HEADER  Question;
 864   EFI_FORM_ID              FormId;
 865   EFI_QUESTION_ID          QuestionId;
 866   EFI_GUID                 FormSetId;
 867   EFI_STRING_ID            DevicePath;
 868 } EFI_IFR_REF4;
 869
 870 typedef struct _EFI_IFR_REF5 {
 871   EFI_IFR_OP_HEADER        Header;
 872   EFI_IFR_QUESTION_HEADER  Question;
 873 } EFI_IFR_REF5;
 874
 875 typedef struct _EFI_IFR_RESET_BUTTON {
 876   EFI_IFR_OP_HEADER        Header;
 877   EFI_IFR_STATEMENT_HEADER Statement;
 878   EFI_DEFAULT_ID           DefaultId;
 879 } EFI_IFR_RESET_BUTTON;
 880
 881 typedef struct _EFI_IFR_ACTION {
 882   EFI_IFR_OP_HEADER        Header;
 883   EFI_IFR_QUESTION_HEADER  Question;
 884   EFI_STRING_ID            QuestionConfig;
 885 } EFI_IFR_ACTION;
 886
 887 typedef struct _EFI_IFR_ACTION_1 {
 888   EFI_IFR_OP_HEADER        Header;
 889   EFI_IFR_QUESTION_HEADER  Question;
 890 } EFI_IFR_ACTION_1;
 891
 892 typedef struct _EFI_IFR_DATE {
 893   EFI_IFR_OP_HEADER        Header;
 894   EFI_IFR_QUESTION_HEADER  Question;
 895   UINT8                    Flags;
 896 } EFI_IFR_DATE;
 897
 898 #define EFI_QF_DATE_YEAR_SUPPRESS      0x01
 899 #define EFI_QF_DATE_MONTH_SUPPRESS     0x02
 900 #define EFI_QF_DATE_DAY_SUPPRESS       0x04
 901
 902 #define EFI_QF_DATE_STORAGE            0x30
 903 #define     QF_DATE_STORAGE_NORMAL     0x00
 904 #define     QF_DATE_STORAGE_TIME       0x10
 905 #define     QF_DATE_STORAGE_WAKEUP     0x20
 906
 907 typedef union {
 908   struct {
 909     UINT8 MinValue;
 910     UINT8 MaxValue;
 911     UINT8 Step;
 912   } u8;
 913   struct {
 914     UINT16 MinValue;
 915     UINT16 MaxValue;
 916     UINT16 Step;
 917   } u16;
 918   struct {
 919     UINT32 MinValue;
 920     UINT32 MaxValue;
 921     UINT32 Step;
 922   } u32;
 923   struct {
 924     UINT64 MinValue;
 925     UINT64 MaxValue;
 926     UINT64 Step;
 927   } u64;
 928 } MINMAXSTEP_DATA;
 929
 930 typedef struct _EFI_IFR_NUMERIC {
 931   EFI_IFR_OP_HEADER        Header;
 932   EFI_IFR_QUESTION_HEADER  Question;
 933   UINT8                    Flags;
 934   MINMAXSTEP_DATA          data;
 935 } EFI_IFR_NUMERIC;
 936
 937 #define EFI_IFR_NUMERIC_SIZE           0x03
 938 #define EFI_IFR_NUMERIC_SIZE_1         0x00
 939 #define EFI_IFR_NUMERIC_SIZE_2         0x01
 940 #define EFI_IFR_NUMERIC_SIZE_4         0x02
 941 #define EFI_IFR_NUMERIC_SIZE_8         0x03
 942
 943 #define EFI_IFR_DISPLAY                0x30
 944 #define EFI_IFR_DISPLAY_INT_DEC        0x00
 945 #define EFI_IFR_DISPLAY_UINT_DEC       0x10
 946 #define EFI_IFR_DISPLAY_UINT_HEX       0x20
 947
 948 typedef struct _EFI_IFR_ONE_OF {
 949   EFI_IFR_OP_HEADER        Header;
 950   EFI_IFR_QUESTION_HEADER  Question;
 951   UINT8                    Flags;
 952   MINMAXSTEP_DATA          data;
 953 } EFI_IFR_ONE_OF;
 954
 955 typedef struct _EFI_IFR_STRING {
 956   EFI_IFR_OP_HEADER        Header;
 957   EFI_IFR_QUESTION_HEADER  Question;
 958   UINT8                    MinSize;
 959   UINT8                    MaxSize;
 960   UINT8                    Flags;
 961 } EFI_IFR_STRING;
 962
 963 #define EFI_IFR_STRING_MULTI_LINE      0x01
 964
 965 typedef struct _EFI_IFR_PASSWORD {
 966   EFI_IFR_OP_HEADER        Header;
 967   EFI_IFR_QUESTION_HEADER  Question;
 968   UINT16                   MinSize;
 969   UINT16                   MaxSize;
 970 } EFI_IFR_PASSWORD;
 971
 972 typedef struct _EFI_IFR_ORDERED_LIST {
 973   EFI_IFR_OP_HEADER        Header;
 974   EFI_IFR_QUESTION_HEADER  Question;
 975   UINT8                    MaxContainers;
 976   UINT8                    Flags;
 977 } EFI_IFR_ORDERED_LIST;
 978
 979 #define EFI_IFR_UNIQUE_SET             0x01
 980 #define EFI_IFR_NO_EMPTY_SET           0x02
 981
 982 typedef struct _EFI_IFR_TIME {
 983   EFI_IFR_OP_HEADER        Header;
 984   EFI_IFR_QUESTION_HEADER  Question;
 985   UINT8                    Flags;
 986 } EFI_IFR_TIME;
 987
 988 #define QF_TIME_HOUR_SUPPRESS          0x01
 989 #define QF_TIME_MINUTE_SUPPRESS        0x02
 990 #define QF_TIME_SECOND_SUPPRESS        0x04
 991
 992 #define QF_TIME_STORAGE                0x30
 993 #define QF_TIME_STORAGE_NORMAL         0x00
 994 #define QF_TIME_STORAGE_TIME           0x10
 995 #define QF_TIME_STORAGE_WAKEUP         0x20
 996
 997 typedef struct _EFI_IFR_DISABLE_IF {
 998   EFI_IFR_OP_HEADER        Header;
 999 } EFI_IFR_DISABLE_IF;
1000
1001 typedef struct _EFI_IFR_SUPPRESS_IF {
1002   EFI_IFR_OP_HEADER        Header;
1003 } EFI_IFR_SUPPRESS_IF;
1004
1005 typedef struct _EFI_IFR_GRAY_OUT_IF {
1006   EFI_IFR_OP_HEADER        Header;
1007 } EFI_IFR_GRAY_OUT_IF;
1008
1009 typedef struct _EFI_IFR_INCONSISTENT_IF {
1010   EFI_IFR_OP_HEADER        Header;
1011   EFI_STRING_ID            Error;
1012 } EFI_IFR_INCONSISTENT_IF;
1013
1014 typedef struct _EFI_IFR_NO_SUBMIT_IF {
1015   EFI_IFR_OP_HEADER        Header;
1016   EFI_STRING_ID            Error;
1017 } EFI_IFR_NO_SUBMIT_IF;
1018
1019 typedef struct _EFI_IFR_WARNING_IF {
1020   EFI_IFR_OP_HEADER        Header;
1021   EFI_STRING_ID            Warning;
1022   UINT8                    TimeOut;
1023 } EFI_IFR_WARNING_IF;
1024
1025 typedef struct _EFI_IFR_REFRESH {
1026   EFI_IFR_OP_HEADER        Header;
1027   UINT8                    RefreshInterval;
1028 } EFI_IFR_REFRESH;
1029
1030 typedef struct _EFI_IFR_REFRESH_ID {
1031   EFI_IFR_OP_HEADER Header;
1032   EFI_GUID          RefreshEventGroupId;
1033 } EFI_IFR_REFRESH_ID;
1034
1035 typedef struct _EFI_IFR_VARSTORE_DEVICE {
1036   EFI_IFR_OP_HEADER        Header;
1037   EFI_STRING_ID            DevicePath;
1038 } EFI_IFR_VARSTORE_DEVICE;
1039
1040 typedef struct _EFI_IFR_ONE_OF_OPTION {
1041   EFI_IFR_OP_HEADER        Header;
1042   EFI_STRING_ID            Option;
1043   UINT8                    Flags;
1044   UINT8                    Type;
1045   EFI_IFR_TYPE_VALUE       Value;
1046 } EFI_IFR_ONE_OF_OPTION;
1047
1048 #define EFI_IFR_TYPE_NUM_SIZE_8        0x00
1049 #define EFI_IFR_TYPE_NUM_SIZE_16       0x01
1050 #define EFI_IFR_TYPE_NUM_SIZE_32       0x02
1051 #define EFI_IFR_TYPE_NUM_SIZE_64       0x03
1052 #define EFI_IFR_TYPE_BOOLEAN           0x04
1053 #define EFI_IFR_TYPE_TIME              0x05
1054 #define EFI_IFR_TYPE_DATE              0x06
1055 #define EFI_IFR_TYPE_STRING            0x07
1056 #define EFI_IFR_TYPE_OTHER             0x08
1057 #define EFI_IFR_TYPE_UNDEFINED         0x09
1058 #define EFI_IFR_TYPE_ACTION            0x0A
1059 #define EFI_IFR_TYPE_BUFFER            0x0B
1060 #define EFI_IFR_TYPE_REF               0x0C
1061
1062 #define EFI_IFR_OPTION_DEFAULT         0x10
1063 #define EFI_IFR_OPTION_DEFAULT_MFG     0x20
1064
1065 typedef struct _EFI_IFR_GUID {
1066   EFI_IFR_OP_HEADER        Header;
1067   EFI_GUID                 Guid;
1068   //Optional Data Follows
1069 } EFI_IFR_GUID;
1070
1071 typedef struct _EFI_IFR_DUP {
1072   EFI_IFR_OP_HEADER        Header;
1073 } EFI_IFR_DUP;
1074
1075 typedef struct _EFI_IFR_EQ_ID_ID {
1076   EFI_IFR_OP_HEADER        Header;
1077   EFI_QUESTION_ID          QuestionId1;
1078   EFI_QUESTION_ID          QuestionId2;
1079 } EFI_IFR_EQ_ID_ID;
1080
1081 typedef struct _EFI_IFR_EQ_ID_VAL {
1082   EFI_IFR_OP_HEADER        Header;
1083   EFI_QUESTION_ID          QuestionId;
1084   UINT16                   Value;
1085 } EFI_IFR_EQ_ID_VAL;
1086
1087 typedef struct _EFI_IFR_EQ_ID_VAL_LIST {
1088   EFI_IFR_OP_HEADER        Header;
1089   EFI_QUESTION_ID          QuestionId;
1090   UINT16                   ListLength;
1091   UINT16                   ValueList[1];
1092 } EFI_IFR_EQ_ID_VAL_LIST;
1093
1094 typedef struct _EFI_IFR_QUESTION_REF1 {
1095   EFI_IFR_OP_HEADER        Header;
1096   EFI_QUESTION_ID          QuestionId;
1097 } EFI_IFR_QUESTION_REF1;
1098
1099 typedef struct _EFI_IFR_UINT8 {
1100   EFI_IFR_OP_HEADER        Header;
1101   UINT8 Value;
1102 } EFI_IFR_UINT8;
1103
1104 typedef struct _EFI_IFR_UINT16 {
1105   EFI_IFR_OP_HEADER        Header;
1106   UINT16                   Value;
1107 } EFI_IFR_UINT16;
1108
1109 typedef struct _EFI_IFR_QUESTION_REF2 {
1110   EFI_IFR_OP_HEADER        Header;
1111 } EFI_IFR_QUESTION_REF2;
1112
1113 typedef struct _EFI_IFR_UINT32 {
1114   EFI_IFR_OP_HEADER        Header;
1115   UINT32                   Value;
1116 } EFI_IFR_UINT32;
1117
1118 typedef struct _EFI_IFR_UINT64 {
1119   EFI_IFR_OP_HEADER        Header;
1120   UINT64 Value;
1121 } EFI_IFR_UINT64;
1122
1123 typedef struct _EFI_IFR_QUESTION_REF3 {
1124   EFI_IFR_OP_HEADER        Header;
1125 } EFI_IFR_QUESTION_REF3;
1126
1127 typedef struct _EFI_IFR_QUESTION_REF3_2 {
1128   EFI_IFR_OP_HEADER        Header;
1129   EFI_STRING_ID            DevicePath;
1130 } EFI_IFR_QUESTION_REF3_2;
1131
1132 typedef struct _EFI_IFR_QUESTION_REF3_3 {
1133   EFI_IFR_OP_HEADER        Header;
1134   EFI_STRING_ID            DevicePath;
1135   EFI_GUID                 Guid;
1136 } EFI_IFR_QUESTION_REF3_3;
1137
1138 typedef struct _EFI_IFR_RULE_REF {
1139   EFI_IFR_OP_HEADER        Header;
1140   UINT8                    RuleId;
1141 } EFI_IFR_RULE_REF;
1142
1143 typedef struct _EFI_IFR_STRING_REF1 {
1144   EFI_IFR_OP_HEADER        Header;
1145   EFI_STRING_ID            StringId;
1146 } EFI_IFR_STRING_REF1;
1147
1148 typedef struct _EFI_IFR_STRING_REF2 {
1149   EFI_IFR_OP_HEADER        Header;
1150 } EFI_IFR_STRING_REF2;
1151
1152 typedef struct _EFI_IFR_THIS {
1153   EFI_IFR_OP_HEADER        Header;
1154 } EFI_IFR_THIS;
1155
1156 typedef struct _EFI_IFR_TRUE {
1157   EFI_IFR_OP_HEADER        Header;
1158 } EFI_IFR_TRUE;
1159
1160 typedef struct _EFI_IFR_FALSE {
1161   EFI_IFR_OP_HEADER        Header;
1162 } EFI_IFR_FALSE;
1163
1164 typedef struct _EFI_IFR_ONE {
1165   EFI_IFR_OP_HEADER        Header;
1166 } EFI_IFR_ONE;
1167
1168 typedef struct _EFI_IFR_ONES {
1169   EFI_IFR_OP_HEADER        Header;
1170 } EFI_IFR_ONES;
1171
1172 typedef struct _EFI_IFR_ZERO {
1173   EFI_IFR_OP_HEADER        Header;
1174 } EFI_IFR_ZERO;
1175
1176 typedef struct _EFI_IFR_UNDEFINED {
1177   EFI_IFR_OP_HEADER        Header;
1178 } EFI_IFR_UNDEFINED;
1179
1180 typedef struct _EFI_IFR_VERSION {
1181   EFI_IFR_OP_HEADER        Header;
1182 } EFI_IFR_VERSION;
1183
1184 typedef struct _EFI_IFR_LENGTH {
1185   EFI_IFR_OP_HEADER        Header;
1186 } EFI_IFR_LENGTH;
1187
1188 typedef struct _EFI_IFR_NOT {
1189   EFI_IFR_OP_HEADER        Header;
1190 } EFI_IFR_NOT;
1191
1192 typedef struct _EFI_IFR_BITWISE_NOT {
1193   EFI_IFR_OP_HEADER        Header;
1194 } EFI_IFR_BITWISE_NOT;
1195
1196 typedef struct _EFI_IFR_TO_BOOLEAN {
1197   EFI_IFR_OP_HEADER        Header;
1198 } EFI_IFR_TO_BOOLEAN;
1199
1200 #define EFI_IFR_STRING_UNSIGNED_DEC      0
1201 #define EFI_IFR_STRING_SIGNED_DEC        1
1202 #define EFI_IFR_STRING_LOWERCASE_HEX     2
1203 #define EFI_IFR_STRING_UPPERCASE_HEX     3
1204
1205 #define EFI_IFR_STRING_ASCII             0
1206 #define EFI_IFR_STRING_UNICODE           8
1207
1208 typedef struct _EFI_IFR_TO_STRING {
1209   EFI_IFR_OP_HEADER        Header;
1210   UINT8                    Format;
1211 } EFI_IFR_TO_STRING;
1212
1213 typedef struct _EFI_IFR_TO_UINT {
1214   EFI_IFR_OP_HEADER        Header;
1215 } EFI_IFR_TO_UINT;
1216
1217 typedef struct _EFI_IFR_TO_UPPER {
1218   EFI_IFR_OP_HEADER        Header;
1219 } EFI_IFR_TO_UPPER;
1220
1221 typedef struct _EFI_IFR_TO_LOWER {
1222   EFI_IFR_OP_HEADER        Header;
1223 } EFI_IFR_TO_LOWER;
1224
1225 typedef struct _EFI_IFR_ADD {
1226   EFI_IFR_OP_HEADER        Header;
1227 } EFI_IFR_ADD;
1228
1229 typedef struct _EFI_IFR_AND {
1230   EFI_IFR_OP_HEADER        Header;
1231 } EFI_IFR_AND;
1232
1233 typedef struct _EFI_IFR_BITWISE_AND {
1234   EFI_IFR_OP_HEADER        Header;
1235 } EFI_IFR_BITWISE_AND;
1236
1237 typedef struct _EFI_IFR_BITWISE_OR {
1238   EFI_IFR_OP_HEADER        Header;
1239 } EFI_IFR_BITWISE_OR;
1240
1241 typedef struct _EFI_IFR_CATENATE {
1242   EFI_IFR_OP_HEADER        Header;
1243 } EFI_IFR_CATENATE;
1244
1245 typedef struct _EFI_IFR_DIVIDE {
1246   EFI_IFR_OP_HEADER        Header;
1247 } EFI_IFR_DIVIDE;
1248
1249 typedef struct _EFI_IFR_EQUAL {
1250   EFI_IFR_OP_HEADER        Header;
1251 } EFI_IFR_EQUAL;
1252
1253 typedef struct _EFI_IFR_GREATER_EQUAL {
1254   EFI_IFR_OP_HEADER        Header;
1255 } EFI_IFR_GREATER_EQUAL;
1256
1257 typedef struct _EFI_IFR_GREATER_THAN {
1258   EFI_IFR_OP_HEADER        Header;
1259 } EFI_IFR_GREATER_THAN;
1260
1261 typedef struct _EFI_IFR_LESS_EQUAL {
1262   EFI_IFR_OP_HEADER        Header;
1263 } EFI_IFR_LESS_EQUAL;
1264
1265 typedef struct _EFI_IFR_LESS_THAN {
1266   EFI_IFR_OP_HEADER        Header;
1267 } EFI_IFR_LESS_THAN;
1268
1269 typedef struct _EFI_IFR_MATCH {
1270   EFI_IFR_OP_HEADER        Header;
1271 } EFI_IFR_MATCH;
1272
1273 typedef struct _EFI_IFR_MULTIPLY {
1274   EFI_IFR_OP_HEADER        Header;
1275 } EFI_IFR_MULTIPLY;
1276
1277 typedef struct _EFI_IFR_MODULO {
1278   EFI_IFR_OP_HEADER        Header;
1279 } EFI_IFR_MODULO;
1280
1281 typedef struct _EFI_IFR_NOT_EQUAL {
1282   EFI_IFR_OP_HEADER        Header;
1283 } EFI_IFR_NOT_EQUAL;
1284
1285 typedef struct _EFI_IFR_OR {
1286   EFI_IFR_OP_HEADER        Header;
1287 } EFI_IFR_OR;
1288
1289 typedef struct _EFI_IFR_SHIFT_LEFT {
1290   EFI_IFR_OP_HEADER        Header;
1291 } EFI_IFR_SHIFT_LEFT;
1292
1293 typedef struct _EFI_IFR_SHIFT_RIGHT {
1294   EFI_IFR_OP_HEADER        Header;
1295 } EFI_IFR_SHIFT_RIGHT;
1296
1297 typedef struct _EFI_IFR_SUBTRACT {
1298   EFI_IFR_OP_HEADER        Header;
1299 } EFI_IFR_SUBTRACT;
1300
1301 typedef struct _EFI_IFR_CONDITIONAL {
1302   EFI_IFR_OP_HEADER        Header;
1303 } EFI_IFR_CONDITIONAL;
1304
1305 #define EFI_IFR_FF_CASE_SENSITIVE    0x00
1306 #define EFI_IFR_FF_CASE_INSENSITIVE  0x01
1307
1308 typedef struct _EFI_IFR_FIND {
1309   EFI_IFR_OP_HEADER        Header;
1310   UINT8                    Format;
1311 } EFI_IFR_FIND;
1312
1313 typedef struct _EFI_IFR_MID {
1314   EFI_IFR_OP_HEADER        Header;
1315 } EFI_IFR_MID;
1316
1317 typedef struct _EFI_IFR_TOKEN {
1318   EFI_IFR_OP_HEADER        Header;
1319 } EFI_IFR_TOKEN;
1320
1321 #define EFI_IFR_FLAGS_FIRST_MATCHING     0x00
1322 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1323
1324 typedef struct _EFI_IFR_SPAN {
1325   EFI_IFR_OP_HEADER        Header;
1326   UINT8                    Flags;
1327 } EFI_IFR_SPAN;
1328
1329 typedef struct _EFI_IFR_SECURITY {
1330   ///
1331   /// Standard opcode header, where Header.Op = EFI_IFR_SECURITY_OP.
1332   ///
1333   EFI_IFR_OP_HEADER        Header;
1334   ///
1335   /// Security permission level.
1336   ///
1337   EFI_GUID                 Permissions;
1338 } EFI_IFR_SECURITY;
1339
1340 typedef struct _EFI_IFR_FORM_MAP_METHOD {
1341   ///
1342   /// The string identifier which provides the human-readable name of
1343   /// the configuration method for this standards map form.
1344   ///
1345   EFI_STRING_ID            MethodTitle;
1346   ///
1347   /// Identifier which uniquely specifies the configuration methods
1348   /// associated with this standards map form.
1349   ///
1350   EFI_GUID                 MethodIdentifier;
1351 } EFI_IFR_FORM_MAP_METHOD;
1352
1353 typedef struct _EFI_IFR_FORM_MAP {
1354   ///
1355   /// The sequence that defines the type of opcode as well as the length
1356   /// of the opcode being defined. Header.OpCode = EFI_IFR_FORM_MAP_OP.
1357   ///
1358   EFI_IFR_OP_HEADER        Header;
1359   ///
1360   /// The unique identifier for this particular form.
1361   ///
1362   EFI_FORM_ID              FormId;
1363   ///
1364   /// One or more configuration method's name and unique identifier.
1365   ///
1366   // EFI_IFR_FORM_MAP_METHOD  Methods[];
1367 } EFI_IFR_FORM_MAP;
1368
1369 typedef struct _EFI_IFR_SET {
1370   ///
1371   /// The sequence that defines the type of opcode as well as the length
1372   /// of the opcode being defined. Header.OpCode = EFI_IFR_SET_OP.
1373   ///
1374   EFI_IFR_OP_HEADER  Header;
1375   ///
1376   /// Specifies the identifier of a previously declared variable store to
1377   /// use when storing the question's value.
1378   ///
1379   EFI_VARSTORE_ID    VarStoreId;
1380   union {
1381     ///
1382     /// A 16-bit Buffer Storage offset.
1383     ///
1384     EFI_STRING_ID    VarName;
1385     ///
1386     /// A Name Value or EFI Variable name (VarName).
1387     ///
1388     UINT16           VarOffset;
1389   }                  VarStoreInfo;
1390   ///
1391   /// Specifies the type used for storage.
1392   ///
1393   UINT8              VarStoreType;
1394 } EFI_IFR_SET;
1395
1396 typedef struct _EFI_IFR_GET {
1397   ///
1398   /// The sequence that defines the type of opcode as well as the length
1399   /// of the opcode being defined. Header.OpCode = EFI_IFR_GET_OP.
1400   ///
1401   EFI_IFR_OP_HEADER  Header;
1402   ///
1403   /// Specifies the identifier of a previously declared variable store to
1404   /// use when retrieving the value.
1405   ///
1406   EFI_VARSTORE_ID    VarStoreId;
1407   union {
1408     ///
1409     /// A 16-bit Buffer Storage offset.
1410     ///
1411     EFI_STRING_ID    VarName;
1412     ///
1413     /// A Name Value or EFI Variable name (VarName).
1414     ///
1415     UINT16           VarOffset;
1416   }                  VarStoreInfo;
1417   ///
1418   /// Specifies the type used for storage.
1419   ///
1420   UINT8              VarStoreType;
1421 } EFI_IFR_GET;
1422
1423 typedef struct _EFI_IFR_READ {
1424   EFI_IFR_OP_HEADER       Header;
1425 } EFI_IFR_READ;
1426
1427 typedef struct _EFI_IFR_WRITE {
1428   EFI_IFR_OP_HEADER      Header;
1429 } EFI_IFR_WRITE;
1430
1431 typedef struct _EFI_IFR_MAP {
1432   EFI_IFR_OP_HEADER      Header;
1433 } EFI_IFR_MAP;
1434 //
1435 // Keyboard Package
1436 //
1437
1438 typedef enum {
1439   EfiKeyLCtrl,
1440   EfiKeyA0,
1441   EfiKeyLAlt,
1442   EfiKeySpaceBar,
1443   EfiKeyA2,
1444   EfiKeyA3,
1445   EfiKeyA4,
1446   EfiKeyRCtrl,
1447   EfiKeyLeftArrow,
1448   EfiKeyDownArrow,
1449   EfiKeyRightArrow,
1450   EfiKeyZero,
1451   EfiKeyPeriod,
1452   EfiKeyEnter,
1453   EfiKeyLShift,
1454   EfiKeyB0,
1455   EfiKeyB1,
1456   EfiKeyB2,
1457   EfiKeyB3,
1458   EfiKeyB4,
1459   EfiKeyB5,
1460   EfiKeyB6,
1461   EfiKeyB7,
1462   EfiKeyB8,
1463   EfiKeyB9,
1464   EfiKeyB10,
1465   EfiKeyRshift,
1466   EfiKeyUpArrow,
1467   EfiKeyOne,
1468   EfiKeyTwo,
1469   EfiKeyThree,
1470   EfiKeyCapsLock,
1471   EfiKeyC1,
1472   EfiKeyC2,
1473   EfiKeyC3,
1474   EfiKeyC4,
1475   EfiKeyC5,
1476   EfiKeyC6,
1477   EfiKeyC7,
1478   EfiKeyC8,
1479   EfiKeyC9,
1480   EfiKeyC10,
1481   EfiKeyC11,
1482   EfiKeyC12,
1483   EfiKeyFour,
1484   EfiKeyFive,
1485   EfiKeySix,
1486   EfiKeyPlus,
1487   EfiKeyTab,
1488   EfiKeyD1,
1489   EfiKeyD2,
1490   EfiKeyD3,
1491   EfiKeyD4,
1492   EfiKeyD5,
1493   EfiKeyD6,
1494   EfiKeyD7,
1495   EfiKeyD8,
1496   EfiKeyD9,
1497   EfiKeyD10,
1498   EfiKeyD11,
1499   EfiKeyD12,
1500   EfiKeyD13,
1501   EfiKeyDel,
1502   EfiKeyEnd,
1503   EfiKeyPgDn,
1504   EfiKeySeven,
1505   EfiKeyEight,
1506   EfiKeyNine,
1507   EfiKeyE0,
1508   EfiKeyE1,
1509   EfiKeyE2,
1510   EfiKeyE3,
1511   EfiKeyE4,
1512   EfiKeyE5,
1513   EfiKeyE6,
1514   EfiKeyE7,
1515   EfiKeyE8,
1516   EfiKeyE9,
1517   EfiKeyE10,
1518   EfiKeyE11,
1519   EfiKeyE12,
1520   EfiKeyBackSpace,
1521   EfiKeyIns,
1522   EfiKeyHome,
1523   EfiKeyPgUp,
1524   EfiKeyNLck,
1525   EfiKeySlash,
1526   EfiKeyAsterisk,
1527   EfiKeyMinus,
1528   EfiKeyEsc,
1529   EfiKeyF1,
1530   EfiKeyF2,
1531   EfiKeyF3,
1532   EfiKeyF4,
1533   EfiKeyF5,
1534   EfiKeyF6,
1535   EfiKeyF7,
1536   EfiKeyF8,
1537   EfiKeyF9,
1538   EfiKeyF10,
1539   EfiKeyF11,
1540   EfiKeyF12,
1541   EfiKeyPrint,
1542   EfiKeySLck,
1543   EfiKeyPause
1544 } EFI_KEY;
1545
1546 typedef struct {
1547   EFI_KEY                 Key;
1548   CHAR16                  Unicode;
1549   CHAR16                  ShiftedUnicode;
1550   CHAR16                  AltGrUnicode;
1551   CHAR16                  ShiftedAltGrUnicode;
1552   UINT16                  Modifier;
1553   UINT16                  AffectedAttribute;
1554 } EFI_KEY_DESCRIPTOR;
1555
1556 //
1557 // A key which is affected by all the standard shift modifiers.
1558 // Most keys would be expected to have this bit active.
1559 //
1560 #define EFI_AFFECTED_BY_STANDARD_SHIFT       0x0001
1561 //
1562 // This key is affected by the caps lock so that if a keyboard driver
1563 // would need to disambiguate between a key which had a "1" defined
1564 // versus a "a" character.  Having this bit turned on would tell
1565 // the keyboard driver to use the appropriate shifted state or not.
1566 //
1567 #define EFI_AFFECTED_BY_CAPS_LOCK            0x0002
1568 //
1569 // Similar to the case of CAPS lock, if this bit is active, the key
1570 // is affected by the num lock being turned on.
1571 //
1572 #define EFI_AFFECTED_BY_NUM_LOCK             0x0004
1573
1574 typedef struct {
1575   UINT16                  LayoutLength;
1576   EFI_GUID                Guid;
1577   UINT32                  LayoutDescriptorStringOffset;
1578   UINT8                   DescriptorCount;
1579   // EFI_KEY_DESCRIPTOR    Descriptors[];
1580 } EFI_HII_KEYBOARD_LAYOUT;
1581
1582 typedef struct {
1583   EFI_HII_PACKAGE_HEADER  Header;
1584   UINT16                  LayoutCount;
1585   // EFI_HII_KEYBOARD_LAYOUT Layout[];
1586 } EFI_HII_KEYBOARD_PACKAGE_HDR;
1587
1588 typedef struct {
1589   CHAR16                  Language[3];
1590   CHAR16                  Space;
1591   CHAR16                  DescriptionString[1];
1592 } EFI_DESCRIPTION_STRING;
1593
1594 typedef struct {
1595   UINT16                  DescriptionCount;
1596   EFI_DESCRIPTION_STRING  DescriptionString[1];
1597 } EFI_DESCRIPTION_STRING_BUNDLE;
1598
1599 //
1600 // Modifier values
1601 //
1602 #define EFI_NULL_MODIFIER                0x0000
1603 #define EFI_LEFT_CONTROL_MODIFIER        0x0001
1604 #define EFI_RIGHT_CONTROL_MODIFIER       0x0002
1605 #define EFI_LEFT_ALT_MODIFIER            0x0003
1606 #define EFI_RIGHT_ALT_MODIFIER           0x0004
1607 #define EFI_ALT_GR_MODIFIER              0x0005
1608 #define EFI_INSERT_MODIFIER              0x0006
1609 #define EFI_DELETE_MODIFIER              0x0007
1610 #define EFI_PAGE_DOWN_MODIFIER           0x0008
1611 #define EFI_PAGE_UP_MODIFIER             0x0009
1612 #define EFI_HOME_MODIFIER                0x000A
1613 #define EFI_END_MODIFIER                 0x000B
1614 #define EFI_LEFT_SHIFT_MODIFIER          0x000C
1615 #define EFI_RIGHT_SHIFT_MODIFIER         0x000D
1616 #define EFI_CAPS_LOCK_MODIFIER           0x000E
1617 #define EFI_NUM_LOCK _MODIFIER           0x000F
1618 #define EFI_LEFT_ARROW_MODIFIER          0x0010
1619 #define EFI_RIGHT_ARROW_MODIFIER         0x0011
1620 #define EFI_DOWN_ARROW_MODIFIER          0x0012
1621 #define EFI_UP_ARROW_MODIFIER            0x0013
1622 #define EFI_NS_KEY_MODIFIER              0x0014
1623 #define EFI_NS_KEY_DEPENDENCY_MODIFIER   0x0015
1624 #define EFI_FUNCTION_KEY_ONE_MODIFIER    0x0016
1625 #define EFI_FUNCTION_KEY_TWO_MODIFIER    0x0017
1626 #define EFI_FUNCTION_KEY_THREE_MODIFIER  0x0018
1627 #define EFI_FUNCTION_KEY_FOUR_MODIFIER   0x0019
1628 #define EFI_FUNCTION_KEY_FIVE_MODIFIER   0x001A
1629 #define EFI_FUNCTION_KEY_SIX_MODIFIER    0x001B
1630 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER  0x001C
1631 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER  0x001D
1632 #define EFI_FUNCTION_KEY_NINE_MODIFIER   0x001E
1633 #define EFI_FUNCTION_KEY_TEN_MODIFIER    0x001F
1634 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1635 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1636
1637 //
1638 // Keys that have multiple control functions based on modifier
1639 // settings are handled in the keyboard driver implementation.
1640 // For instance PRINT_KEY might have a modifier held down and
1641 // is still a nonprinting character, but might have an alternate
1642 // control function like SYSREQUEST
1643 //
1644 #define EFI_PRINT_MODIFIER               0x0022
1645 #define EFI_SYS_REQUEST_MODIFIER         0x0023
1646 #define EFI_SCROLL_LOCK_MODIFIER         0x0024
1647 #define EFI_PAUSE_MODIFIER               0x0025
1648 #define EFI_BREAK_MODIFIER               0x0026
1649
1650 #pragma pack()
1651
1652
1653
1654 //
1655 // References to string tokens must use this macro to enable scanning for
1656 // token usages.
1657 //
1658 //
1659 // STRING_TOKEN is not defined in UEFI specification. But it is placed
1660 // here for the easy access by C files and VFR source files.
1661 //
1662 #define STRING_TOKEN(t) t
1663
1664 #endif