MdePkg/Include/Uefi/UefiInternalFormRepresentation.h

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