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