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