MdePkg/Include/Uefi/UefiInternalFormRepresentation.h

   1
   2 /** @file
   3   This file defines the encoding for the VFR (Visual Form Representation) language.
   4   IFR is primarily consumed by the EFI presentation engine, and produced by EFI
   5   internal application and drivers as well as all add-in card option-ROM drivers
   6
   7   Copyright (c) 2006 - 2007, Intel Corporation
   8   All rights reserved. This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16   @par Revision Reference:
  17   These definitions are from UEFI2.1.
  18
  19 **/
  20
  21 #ifndef __UEFI_INTERNAL_FORMREPRESENTATION_H__
  22 #define __UEFI_INTERNAL_FORMREPRESENTATION_H__
  23
  24 //
  25 // The following types are currently defined:
  26 //
  27 typedef UINT32  RELOFST;
  28
  29 typedef VOID*   EFI_HII_HANDLE;
  30 typedef CHAR16* EFI_STRING;
  31 typedef UINT16  EFI_IMAGE_ID;
  32 typedef UINT16  EFI_QUESTION_ID;
  33 typedef UINT16  EFI_STRING_ID;
  34 typedef UINT16  EFI_FORM_ID;
  35 typedef UINT16  EFI_VARSTORE_ID;
  36 typedef UINT16  EFI_DEFAULT_ID;
  37 typedef UINT32  EFI_HII_FONT_STYLE;
  38
  39
  40
  41 #pragma pack(1)
  42
  43
  44 //
  45 // HII package list
  46 //
  47 typedef struct {
  48   EFI_GUID               PackageListGuid;
  49   UINT32                 PackageLength;
  50 } EFI_HII_PACKAGE_LIST_HEADER;
  51
  52 /**
  53
  54   Each package starts with a header, as defined above, which
  55   indicates the size and type of the package. When added to a
  56   pointer pointing to the start of the header, Length points at
  57   the next package. The package lists form a package list when
  58   concatenated together and terminated with an
  59   EFI_HII_PACKAGE_HEADER with a Type of EFI_HII_PACKAGE_END. The
  60   type EFI_HII_PACKAGE_TYPE_GUID is used for vendor-defined HII
  61   packages, whose contents are determined by the Guid. The range
  62   of package types starting with EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN
  63   through EFI_HII_PACKAGE_TYPE_SYSTEM_END are reserved for system
  64   firmware implementers.
  65
  66   @param Length The size of the package in bytes.
  67
  68   @param Type   The package type. See EFI_HII_PACKAGE_TYPE_x,
  69                 below.
  70
  71   @param Data   The package data, the format of which is
  72                 determined by Type.
  73
  74 **/
  75 typedef struct {
  76   UINT32  Length:24;
  77   UINT32  Type:8;
  78   // UINT8  Data[...];
  79 } EFI_HII_PACKAGE_HEADER;
  80
  81 //
  82 // EFI_HII_PACKAGE_TYPE_x.
  83 //
  84 #define EFI_HII_PACKAGE_TYPE_ALL             0x00
  85 #define EFI_HII_PACKAGE_TYPE_GUID            0x01
  86 #define EFI_HII_PACKAGE_FORM                 0x02
  87 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT      0x03
  88 #define EFI_HII_PACKAGE_STRINGS              0x04
  89 #define EFI_HII_PACKAGE_FONTS                0x05
  90 #define EFI_HII_PACKAGE_IMAGES               0x06
  91 #define EFI_HII_PACKAGE_SIMPLE_FONTS         0x07
  92 #define EFI_HII_PACKAGE_DEVICE_PATH          0x08
  93 #define EFI_HII_PACKAGE_END                  0xDF
  94 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN    0xE0
  95 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END      0xFF
  96
  97 //
  98 // Simplified Font Package
  99 //
 100
 101 #define EFI_GLYPH_HEIGHT                     19
 102 #define EFI_GLYPH_WIDTH                      8
 103 //
 104 // Contents of EFI_NARROW_GLYPH.Attributes
 105 //
 106 #define EFI_GLYPH_NON_SPACING                0x01
 107 #define EFI_GLYPH_WIDE                       0x02
 108
 109 typedef struct {
 110   CHAR16                 UnicodeWeight;
 111   UINT8                  Attributes;
 112   UINT8                  GlyphCol1[EFI_GLYPH_HEIGHT];
 113 } EFI_NARROW_GLYPH;
 114
 115 typedef struct {
 116   CHAR16                 UnicodeWeight;
 117   UINT8                  Attributes;
 118   UINT8                  GlyphCol1[EFI_GLYPH_HEIGHT];
 119   UINT8                  GlyphCol2[EFI_GLYPH_HEIGHT];
 120   UINT8                  Pad[3];
 121 } EFI_WIDE_GLYPH;
 122
 123
 124 typedef struct _EFI_HII_SIMPLE_FONT_PACKAGE_HDR {
 125   EFI_HII_PACKAGE_HEADER Header;
 126   UINT16                 NumberOfNarrowGlyphs;
 127   UINT16                 NumberOfWideGlyphs;
 128   // EFI_NARROW_GLYPH       NarrowGlyphs[];
 129   // EFI_WIDE_GLYPH         WideGlyphs[];
 130 } EFI_HII_SIMPLE_FONT_PACKAGE_HDR;
 131
 132 //
 133 // Font Package
 134 //
 135
 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 #define EFI_IFR_FORM_OP                0x01
 584 #define EFI_IFR_SUBTITLE_OP            0x02
 585 #define EFI_IFR_TEXT_OP                0x03
 586 #define EFI_IFR_IMAGE_OP               0x04
 587 #define EFI_IFR_ONE_OF_OP              0x05
 588 #define EFI_IFR_CHECKBOX_OP            0x06
 589 #define EFI_IFR_NUMERIC_OP             0x07
 590 #define EFI_IFR_PASSWORD_OP            0x08
 591 #define EFI_IFR_ONE_OF_OPTION_OP       0x09
 592 #define EFI_IFR_SUPPRESS_IF_OP         0x0A
 593 #define EFI_IFR_LOCKED_OP              0x0B
 594 #define EFI_IFR_ACTION_OP              0x0C
 595 #define EFI_IFR_RESET_BUTTON_OP        0x0D
 596 #define EFI_IFR_FORM_SET_OP            0x0E
 597 #define EFI_IFR_REF_OP                 0x0F
 598 #define EFI_IFR_NO_SUBMIT_IF_OP        0x10
 599 #define EFI_IFR_INCONSISTENT_IF_OP     0x11
 600 #define EFI_IFR_EQ_ID_VAL_OP           0x12
 601 #define EFI_IFR_EQ_ID_ID_OP            0x13
 602 #define EFI_IFR_EQ_ID_LIST_OP          0x14
 603 #define EFI_IFR_AND_OP                 0x15
 604 #define EFI_IFR_OR_OP                  0x16
 605 #define EFI_IFR_NOT_OP                 0x17
 606 #define EFI_IFR_RULE_OP                0x18
 607 #define EFI_IFR_GRAY_OUT_IF_OP         0x19
 608 #define EFI_IFR_DATE_OP                0x1A
 609 #define EFI_IFR_TIME_OP                0x1B
 610 #define EFI_IFR_STRING_OP              0x1C
 611 #define EFI_IFR_REFRESH_OP             0x1D
 612 #define EFI_IFR_DISABLE_IF_OP          0x1E
 613 #define EFI_IFR_TO_LOWER_OP            0x20
 614 #define EFI_IFR_TO_UPPER_OP            0x21
 615 #define EFI_IFR_ORDERED_LIST_OP        0x23
 616 #define EFI_IFR_VARSTORE_OP            0x24
 617 #define EFI_IFR_VARSTORE_NAME_VALUE_OP 0x25
 618 #define EFI_IFR_VARSTORE_EFI_OP        0x26
 619 #define EFI_IFR_VARSTORE_DEVICE_OP     0x27
 620 #define EFI_IFR_VERSION_OP             0x28
 621 #define EFI_IFR_END_OP                 0x29
 622 #define EFI_IFR_MATCH_OP               0x2A
 623 #define EFI_IFR_EQUAL_OP               0x2F
 624 #define EFI_IFR_NOT_EQUAL_OP           0x30
 625 #define EFI_IFR_GREATER_THAN_OP        0x31
 626 #define EFI_IFR_GREATER_EQUAL_OP       0x32
 627 #define EFI_IFR_LESS_THAN_OP           0x33
 628 #define EFI_IFR_LESS_EQUAL_OP          0x34
 629 #define EFI_IFR_BITWISE_AND_OP         0x35
 630 #define EFI_IFR_BITWISE_OR_OP          0x36
 631 #define EFI_IFR_BITWISE_NOT_OP         0x37
 632 #define EFI_IFR_SHIFT_LEFT_OP          0x38
 633 #define EFI_IFR_SHIFT_RIGHT_OP         0x39
 634 #define EFI_IFR_ADD_OP                 0x3A
 635 #define EFI_IFR_SUBTRACT_OP            0x3B
 636 #define EFI_IFR_MULTIPLY_OP            0x3C
 637 #define EFI_IFR_DIVIDE_OP              0x3D
 638 #define EFI_IFR_MODULO_OP              0x3E
 639 #define EFI_IFR_RULE_REF_OP            0x3F
 640 #define EFI_IFR_QUESTION_REF1_OP       0x40
 641 #define EFI_IFR_QUESTION_REF2_OP       0x41
 642 #define EFI_IFR_UINT8_OP               0x42
 643 #define EFI_IFR_UINT16_OP              0x43
 644 #define EFI_IFR_UINT32_OP              0x44
 645 #define EFI_IFR_UINT64_OP              0x45
 646 #define EFI_IFR_TRUE_OP                0x46
 647 #define EFI_IFR_FALSE_OP               0x47
 648 #define EFI_IFR_TO_UINT_OP             0x48
 649 #define EFI_IFR_TO_STRING_OP           0x49
 650 #define EFI_IFR_TO_BOOLEAN_OP          0x4A
 651 #define EFI_IFR_MID_OP                 0x4B
 652 #define EFI_IFR_FIND_OP                0x4C
 653 #define EFI_IFR_TOKEN_OP               0x4D
 654 #define EFI_IFR_STRING_REF1_OP         0x4E
 655 #define EFI_IFR_STRING_REF2_OP         0x4F
 656 #define EFI_IFR_CONDITIONAL_OP         0x50
 657 #define EFI_IFR_QUESTION_REF3_OP       0x51
 658 #define EFI_IFR_ZERO_OP                0x52
 659 #define EFI_IFR_ONE_OP                 0x53
 660 #define EFI_IFR_ONES_OP                0x54
 661 #define EFI_IFR_UNDEFINED_OP           0x55
 662 #define EFI_IFR_LENGTH_OP              0x56
 663 #define EFI_IFR_DUP_OP                 0x57
 664 #define EFI_IFR_THIS_OP                0x58
 665 #define EFI_IFR_SPAN_OP                0x59
 666 #define EFI_IFR_VALUE_OP               0x5A
 667 #define EFI_IFR_DEFAULT_OP             0x5B
 668 #define EFI_IFR_DEFAULTSTORE_OP        0x5C
 669 #define EFI_IFR_CATENATE_OP            0x5E
 670 #define EFI_IFR_GUID_OP                0x5F
 671
 672
 673 typedef struct _EFI_IFR_OP_HEADER {
 674   UINT8                    OpCode;
 675   UINT8                    Length:7;
 676   UINT8                    Scope:1;
 677 } EFI_IFR_OP_HEADER;
 678
 679 typedef struct _EFI_IFR_STATEMENT_HEADER {
 680   EFI_STRING_ID            Prompt;
 681   EFI_STRING_ID            Help;
 682 } EFI_IFR_STATEMENT_HEADER;
 683
 684 typedef struct _EFI_IFR_QUESTION_HEADER {
 685   EFI_IFR_STATEMENT_HEADER Header;
 686   EFI_QUESTION_ID          QuestionId;
 687   EFI_VARSTORE_ID          VarStoreId;
 688   union {
 689     EFI_STRING_ID          VarName;
 690     UINT16                 VarOffset;
 691   }                        VarStoreInfo;
 692   UINT8                    Flags;
 693 } EFI_IFR_QUESTION_HEADER;
 694
 695 #define EFI_IFR_FLAG_READ_ONLY         0x01
 696 #define EFI_IFR_FLAG_CALLBACK          0x04
 697 #define EFI_IFR_FLAG_RESET_REQUIRED    0x10
 698 #define EFI_IFR_FLAG_OPTIONS_ONLY      0x80
 699
 700 typedef struct _EFI_IFR_DEFAULTSTORE {
 701   EFI_IFR_OP_HEADER        Header;
 702   EFI_STRING_ID            DefaultName;
 703   UINT16                   DefaultId;
 704 } EFI_IFR_DEFAULTSTORE;
 705
 706 #define EFI_HII_DEFAULT_CLASS_STANDARD       0x0000
 707 #define EFI_HII_DEFAULT_CLASS_MANUFACTURING  0x0001
 708 #define EFI_HII_DEFAULT_CLASS_SAFE           0x0002
 709 #define EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN 0x4000
 710 #define EFI_HII_DEFAULT_CLASS_PLATFORM_END   0x7fff
 711 #define EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN 0x8000
 712 #define EFI_HII_DEFAULT_CLASS_HARDWARE_END   0xbfff
 713 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN 0xc000
 714 #define EFI_HII_DEFAULT_CLASS_FIRMWARE_END   0xffff
 715
 716 typedef struct _EFI_IFR_VARSTORE {
 717   EFI_IFR_OP_HEADER        Header;
 718   EFI_GUID                 Guid;
 719   EFI_VARSTORE_ID          VarStoreId;
 720   UINT16                   Size;
 721   UINT8                    Name[1];
 722 } EFI_IFR_VARSTORE;
 723
 724 typedef struct _EFI_IFR_VARSTORE_EFI {
 725   EFI_IFR_OP_HEADER        Header;
 726   UINT16                   VarStoreId;
 727   EFI_GUID                 Guid;
 728   UINT32                   Attributes;
 729 } EFI_IFR_VARSTORE_EFI;
 730
 731 typedef struct _EFI_IFR_VARSTORE_NAME_VALUE {
 732   EFI_IFR_OP_HEADER        Header;
 733   UINT16                   VarStoreId;
 734   EFI_GUID                 Guid;
 735 } EFI_IFR_VARSTORE_NAME_VALUE;
 736
 737 typedef struct _EFI_IFR_FORM_SET {
 738   EFI_IFR_OP_HEADER        Header;
 739   EFI_GUID                 Guid;
 740   EFI_STRING_ID            FormSetTitle;
 741   EFI_STRING_ID            Help;
 742 } EFI_IFR_FORM_SET;
 743
 744 typedef struct _EFI_IFR_END {
 745   EFI_IFR_OP_HEADER        Header;
 746 } EFI_IFR_END;
 747
 748 typedef struct _EFI_IFR_FORM {
 749   EFI_IFR_OP_HEADER        Header;
 750   UINT16                   FormId;
 751   EFI_STRING_ID            FormTitle;
 752 } EFI_IFR_FORM;
 753
 754 typedef struct _EFI_IFR_IMAGE {
 755   EFI_IFR_OP_HEADER        Header;
 756   EFI_IMAGE_ID             Id;
 757 } EFI_IFR_IMAGE;
 758
 759 typedef struct _EFI_IFR_LOCKED {
 760   EFI_IFR_OP_HEADER        Header;
 761 } EFI_IFR_LOCKED;
 762
 763 typedef struct _EFI_IFR_RULE {
 764   EFI_IFR_OP_HEADER        Header;
 765   UINT8                    RuleId;
 766 } EFI_IFR_RULE;
 767
 768 typedef struct _EFI_IFR_DEFAULT {
 769   EFI_IFR_OP_HEADER        Header;
 770   UINT16                   DefaultId;
 771   UINT8                    Type;
 772   EFI_IFR_TYPE_VALUE       Value;
 773 } EFI_IFR_DEFAULT;
 774
 775 typedef struct _EFI_IFR_VALUE {
 776   EFI_IFR_OP_HEADER        Header;
 777 } EFI_IFR_VALUE;
 778
 779 typedef struct _EFI_IFR_SUBTITLE {
 780   EFI_IFR_OP_HEADER        Header;
 781   EFI_IFR_STATEMENT_HEADER Statement;
 782   UINT8                    Flags;
 783 } EFI_IFR_SUBTITLE;
 784
 785 #define EFI_IFR_FLAGS_HORIZONTAL       0x01
 786
 787 typedef struct _EFI_IFR_CHECKBOX {
 788   EFI_IFR_OP_HEADER        Header;
 789   EFI_IFR_QUESTION_HEADER  Question;
 790   UINT8                    Flags;
 791 } EFI_IFR_CHECKBOX;
 792
 793 #define EFI_IFR_CHECKBOX_DEFAULT       0x01
 794 #define EFI_IFR_CHECKBOX_DEFAULT_MFG   0x02
 795
 796 typedef struct _EFI_IFR_TEXT {
 797   EFI_IFR_OP_HEADER        Header;
 798   EFI_IFR_STATEMENT_HEADER Statement;
 799   EFI_STRING_ID            TextTwo;
 800 } EFI_IFR_TEXT;
 801
 802 typedef struct _EFI_IFR_REF {
 803   EFI_IFR_OP_HEADER        Header;
 804   EFI_IFR_QUESTION_HEADER  Question;
 805   EFI_FORM_ID              FormId;
 806 } EFI_IFR_REF;
 807
 808 typedef struct _EFI_IFR_REF2 {
 809   EFI_IFR_OP_HEADER        Header;
 810   EFI_IFR_QUESTION_HEADER  Question;
 811   EFI_FORM_ID              FormId;
 812   EFI_QUESTION_ID          QuestionId;
 813 } EFI_IFR_REF2;
 814
 815 typedef struct _EFI_IFR_REF3 {
 816   EFI_IFR_OP_HEADER        Header;
 817   EFI_IFR_QUESTION_HEADER  Question;
 818   EFI_FORM_ID              FormId;
 819   EFI_QUESTION_ID          QuestionId;
 820   EFI_GUID                 FormSetId;
 821 } EFI_IFR_REF3;
 822
 823 typedef struct _EFI_IFR_REF4 {
 824   EFI_IFR_OP_HEADER        Header;
 825   EFI_IFR_QUESTION_HEADER  Question;
 826   EFI_FORM_ID              FormId;
 827   EFI_QUESTION_ID          QuestionId;
 828   EFI_GUID                 FormSetId;
 829   EFI_STRING_ID            DevicePath;
 830 } EFI_IFR_REF4;
 831
 832 typedef struct _EFI_IFR_RESET_BUTTON {
 833   EFI_IFR_OP_HEADER        Header;
 834   EFI_IFR_QUESTION_HEADER  Question;
 835   EFI_DEFAULT_ID           DefaultId;
 836 } EFI_IFR_RESET_BUTTON;
 837
 838 typedef struct _EFI_IFR_ACTION {
 839   EFI_IFR_OP_HEADER        Header;
 840   EFI_IFR_QUESTION_HEADER  Question;
 841   EFI_STRING_ID            QuestionConfig;
 842 } EFI_IFR_ACTION;
 843
 844 typedef struct _EFI_IFR_ACTION_1 {
 845   EFI_IFR_OP_HEADER        Header;
 846   EFI_IFR_QUESTION_HEADER  Question;
 847 } EFI_IFR_ACTION_1;
 848
 849 typedef struct _EFI_IFR_DATE {
 850   EFI_IFR_OP_HEADER        Header;
 851   EFI_IFR_QUESTION_HEADER  Question;
 852   UINT8                    Flags;
 853 } EFI_IFR_DATE;
 854
 855 #define EFI_QF_DATE_YEAR_SUPPRESS      0x01
 856 #define EFI_QF_DATE_MONTH_SUPPRESS     0x02
 857 #define EFI_QF_DATE_DAY_SUPPRESS       0x04
 858
 859 #define EFI_QF_DATE_STORAGE            0x30
 860 #define     QF_DATE_STORAGE_NORMAL     0x00
 861 #define     QF_DATE_STORAGE_TIME       0x10
 862 #define     QF_DATE_STORAGE_WAKEUP     0x20
 863
 864 typedef union {
 865   struct {
 866     UINT8 MinValue;
 867     UINT8 MaxValue;
 868     UINT8 Step;
 869   } u8;
 870   struct {
 871     UINT16 MinValue;
 872     UINT16 MaxValue;
 873     UINT16 Step;
 874   } u16;
 875   struct {
 876     UINT32 MinValue;
 877     UINT32 MaxValue;
 878     UINT32 Step;
 879   } u32;
 880   struct {
 881     UINT64 MinValue;
 882     UINT64 MaxValue;
 883     UINT64 Step;
 884   } u64;
 885 } MINMAXSTEP_DATA;
 886
 887 typedef struct _EFI_IFR_NUMERIC {
 888   EFI_IFR_OP_HEADER        Header;
 889   EFI_IFR_QUESTION_HEADER  Question;
 890   UINT8                    Flags;
 891   MINMAXSTEP_DATA          data;
 892 } EFI_IFR_NUMERIC;
 893
 894 #define EFI_IFR_NUMERIC_SIZE           0x03
 895 #define EFI_IFR_NUMERIC_SIZE_1         0x00
 896 #define EFI_IFR_NUMERIC_SIZE_2         0x01
 897 #define EFI_IFR_NUMERIC_SIZE_4         0x02
 898 #define EFI_IFR_NUMERIC_SIZE_8         0x03
 899
 900 #define EFI_IFR_DISPLAY                0x30
 901 #define EFI_IFR_DISPLAY_INT_DEC        0x00
 902 #define EFI_IFR_DISPLAY_UINT_DEC       0x10
 903 #define EFI_IFR_DISPLAY_UINT_HEX       0x20
 904
 905 typedef struct _EFI_IFR_ONE_OF {
 906   EFI_IFR_OP_HEADER        Header;
 907   EFI_IFR_QUESTION_HEADER  Question;
 908   UINT8                    Flags;
 909   MINMAXSTEP_DATA          data;
 910 } EFI_IFR_ONE_OF;
 911
 912 typedef struct _EFI_IFR_STRING {
 913   EFI_IFR_OP_HEADER        Header;
 914   EFI_IFR_QUESTION_HEADER  Question;
 915   UINT8                    MinSize;
 916   UINT8                    MaxSize;
 917   UINT8                    Flags;
 918 } EFI_IFR_STRING;
 919
 920 #define EFI_IFR_STRING_MULTI_LINE      0x01
 921
 922 typedef struct _EFI_IFR_PASSWORD {
 923   EFI_IFR_OP_HEADER        Header;
 924   EFI_IFR_QUESTION_HEADER  Question;
 925   UINT16                   MinSize;
 926   UINT16                   MaxSize;
 927 } EFI_IFR_PASSWORD;
 928
 929 typedef struct _EFI_IFR_ORDERED_LIST {
 930   EFI_IFR_OP_HEADER        Header;
 931   EFI_IFR_QUESTION_HEADER  Question;
 932   UINT8                    MaxContainers;
 933   UINT8                    Flags;
 934 } EFI_IFR_ORDERED_LIST;
 935
 936 #define EFI_IFR_UNIQUE_SET             0x01
 937 #define EFI_IFR_NO_EMPTY_SET           0x02
 938
 939 typedef struct _EFI_IFR_TIME {
 940   EFI_IFR_OP_HEADER        Header;
 941   EFI_IFR_QUESTION_HEADER  Question;
 942   UINT8                    Flags;
 943 } EFI_IFR_TIME;
 944
 945 #define QF_TIME_HOUR_SUPPRESS          0x01
 946 #define QF_TIME_MINUTE_SUPPRESS        0x02
 947 #define QF_TIME_SECOND_SUPPRESS        0x04
 948
 949 #define QF_TIME_STORAGE                0x30
 950 #define QF_TIME_STORAGE_NORMAL         0x00
 951 #define QF_TIME_STORAGE_TIME           0x10
 952 #define QF_TIME_STORAGE_WAKEUP         0x20
 953
 954 typedef struct _EFI_IFR_DISABLE_IF {
 955   EFI_IFR_OP_HEADER        Header;
 956 } EFI_IFR_DISABLE_IF;
 957
 958 typedef struct _EFI_IFR_SUPPRESS_IF {
 959   EFI_IFR_OP_HEADER        Header;
 960 } EFI_IFR_SUPPRESS_IF;
 961
 962 typedef struct _EFI_IFR_GRAY_OUT_IF {
 963   EFI_IFR_OP_HEADER        Header;
 964 } EFI_IFR_GRAY_OUT_IF;
 965
 966 typedef struct _EFI_IFR_INCONSISTENT_IF {
 967   EFI_IFR_OP_HEADER        Header;
 968   EFI_STRING_ID            Error;
 969 } EFI_IFR_INCONSISTENT_IF;
 970
 971 typedef struct _EFI_IFR_NO_SUBMIT_IF {
 972   EFI_IFR_OP_HEADER        Header;
 973   EFI_STRING_ID            Error;
 974 } EFI_IFR_NO_SUBMIT_IF;
 975
 976 typedef struct _EFI_IFR_REFRESH {
 977   EFI_IFR_OP_HEADER        Header;
 978   UINT8                    RefreshInterval;
 979 } EFI_IFR_REFRESH;
 980
 981 typedef struct _EFI_IFR_VARSTORE_DEVICE {
 982   EFI_IFR_OP_HEADER        Header;
 983   EFI_STRING_ID            DevicePath;
 984 } EFI_IFR_VARSTORE_DEVICE;
 985
 986 typedef struct _EFI_IFR_ONE_OF_OPTION {
 987   EFI_IFR_OP_HEADER        Header;
 988   EFI_STRING_ID            Option;
 989   UINT8                    Flags;
 990   UINT8                    Type;
 991   EFI_IFR_TYPE_VALUE       Value;
 992 } EFI_IFR_ONE_OF_OPTION;
 993
 994 #define EFI_IFR_TYPE_NUM_SIZE_8        0x00
 995 #define EFI_IFR_TYPE_NUM_SIZE_16       0x01
 996 #define EFI_IFR_TYPE_NUM_SIZE_32       0x02
 997 #define EFI_IFR_TYPE_NUM_SIZE_64       0x03
 998 #define EFI_IFR_TYPE_BOOLEAN           0x04
 999 #define EFI_IFR_TYPE_TIME              0x05
1000 #define EFI_IFR_TYPE_DATE              0x06
1001 #define EFI_IFR_TYPE_STRING            0x07
1002 #define EFI_IFR_TYPE_OTHER             0x08
1003
1004 #define EFI_IFR_OPTION_DEFAULT         0x10
1005 #define EFI_IFR_OPTION_DEFAULT_MFG     0x20
1006
1007 typedef struct _EFI_IFR_GUID {
1008   EFI_IFR_OP_HEADER        Header;
1009   EFI_GUID                 Guid;
1010   //Optional Data Follows
1011 } EFI_IFR_GUID;
1012
1013 typedef struct _EFI_IFR_DUP {
1014   EFI_IFR_OP_HEADER        Header;
1015 } EFI_IFR_DUP;
1016
1017 typedef struct _EFI_IFR_EQ_ID_ID {
1018   EFI_IFR_OP_HEADER        Header;
1019   EFI_QUESTION_ID          QuestionId1;
1020   EFI_QUESTION_ID          QuestionId2;
1021 } EFI_IFR_EQ_ID_ID;
1022
1023 typedef struct _EFI_IFR_EQ_ID_VAL {
1024   EFI_IFR_OP_HEADER        Header;
1025   EFI_QUESTION_ID          QuestionId;
1026   UINT16                   Value;
1027 } EFI_IFR_EQ_ID_VAL;
1028
1029 typedef struct _EFI_IFR_EQ_ID_LIST {
1030   EFI_IFR_OP_HEADER        Header;
1031   EFI_QUESTION_ID          QuestionId;
1032   UINT16                   ListLength;
1033   UINT16                   ValueList[1];
1034 } EFI_IFR_EQ_ID_LIST;
1035
1036 typedef struct _EFI_IFR_QUESTION_REF1 {
1037   EFI_IFR_OP_HEADER        Header;
1038   EFI_QUESTION_ID          QuestionId;
1039 } EFI_IFR_QUESTION_REF1;
1040
1041 typedef struct _EFI_IFR_UINT8 {
1042   EFI_IFR_OP_HEADER        Header;
1043   UINT8 Value;
1044 } EFI_IFR_UINT8;
1045
1046 typedef struct _EFI_IFR_UINT16 {
1047   EFI_IFR_OP_HEADER        Header;
1048   UINT16                   Value;
1049 } EFI_IFR_UINT16;
1050
1051 typedef struct _EFI_IFR_QUESTION_REF2 {
1052   EFI_IFR_OP_HEADER        Header;
1053 } EFI_IFR_QUESTION_REF2;
1054
1055 typedef struct _EFI_IFR_UINT32 {
1056   EFI_IFR_OP_HEADER        Header;
1057   UINT32                   Value;
1058 } EFI_IFR_UINT32;
1059
1060 typedef struct _EFI_IFR_UINT64 {
1061   EFI_IFR_OP_HEADER        Header;
1062   UINT64 Value;
1063 } EFI_IFR_UINT64;
1064
1065 typedef struct _EFI_IFR_QUESTION_REF3 {
1066   EFI_IFR_OP_HEADER        Header;
1067 } EFI_IFR_QUESTION_REF3;
1068
1069 typedef struct _EFI_IFR_QUESTION_REF3_2 {
1070   EFI_IFR_OP_HEADER        Header;
1071   EFI_STRING_ID            DevicePath;
1072 } EFI_IFR_QUESTION_REF3_2;
1073
1074 typedef struct _EFI_IFR_QUESTION_REF3_3 {
1075   EFI_IFR_OP_HEADER        Header;
1076   EFI_STRING_ID            DevicePath;
1077   EFI_GUID                 Guid;
1078 } EFI_IFR_QUESTION_REF3_3;
1079
1080 typedef struct _EFI_IFR_RULE_REF {
1081   EFI_IFR_OP_HEADER        Header;
1082   UINT8                    RuleId;
1083 } EFI_IFR_RULE_REF;
1084
1085 typedef struct _EFI_IFR_STRING_REF1 {
1086   EFI_IFR_OP_HEADER        Header;
1087   EFI_STRING_ID            StringId;
1088 } EFI_IFR_STRING_REF1;
1089
1090 typedef struct _EFI_IFR_STRING_REF2 {
1091   EFI_IFR_OP_HEADER        Header;
1092 } EFI_IFR_STRING_REF2;
1093
1094 typedef struct _EFI_IFR_THIS {
1095   EFI_IFR_OP_HEADER        Header;
1096 } EFI_IFR_THIS;
1097
1098 typedef struct _EFI_IFR_TRUE {
1099   EFI_IFR_OP_HEADER        Header;
1100 } EFI_IFR_TRUE;
1101
1102 typedef struct _EFI_IFR_FALSE {
1103   EFI_IFR_OP_HEADER        Header;
1104 } EFI_IFR_FALSE;
1105
1106 typedef struct _EFI_IFR_ONE {
1107   EFI_IFR_OP_HEADER        Header;
1108 } EFI_IFR_ONE;
1109
1110 typedef struct _EFI_IFR_ONES {
1111   EFI_IFR_OP_HEADER        Header;
1112 } EFI_IFR_ONES;
1113
1114 typedef struct _EFI_IFR_ZERO {
1115   EFI_IFR_OP_HEADER        Header;
1116 } EFI_IFR_ZERO;
1117
1118 typedef struct _EFI_IFR_UNDEFINED {
1119   EFI_IFR_OP_HEADER        Header;
1120 } EFI_IFR_UNDEFINED;
1121
1122 typedef struct _EFI_IFR_VERSION {
1123   EFI_IFR_OP_HEADER        Header;
1124 } EFI_IFR_VERSION;
1125
1126 typedef struct _EFI_IFR_LENGTH {
1127   EFI_IFR_OP_HEADER        Header;
1128 } EFI_IFR_LENGTH;
1129
1130 typedef struct _EFI_IFR_NOT {
1131   EFI_IFR_OP_HEADER        Header;
1132 } EFI_IFR_NOT;
1133
1134 typedef struct _EFI_IFR_BITWISE_NOT {
1135   EFI_IFR_OP_HEADER        Header;
1136 } EFI_IFR_BITWISE_NOT;
1137
1138 typedef struct _EFI_IFR_TO_BOOLEAN {
1139   EFI_IFR_OP_HEADER        Header;
1140 } EFI_IFR_TO_BOOLEAN;
1141
1142 #define EFI_IFR_STRING_UNSIGNED_DEC      0
1143 #define EFI_IFR_STRING_SIGNED_DEC        1
1144 #define EFI_IFR_STRING_LOWERCASE_HEX     2
1145 #define EFI_IFR_STRING_UPPERCASE_HEX     3
1146
1147 #define EFI_IFR_STRING_ASCII             0
1148 #define EFI_IFR_STRING_UNICODE           8
1149
1150 typedef struct _EFI_IFR_TO_STRING {
1151   EFI_IFR_OP_HEADER        Header;
1152   UINT8                    Format;
1153 } EFI_IFR_TO_STRING;
1154
1155 typedef struct _EFI_IFR_TO_UINT {
1156   EFI_IFR_OP_HEADER        Header;
1157 } EFI_IFR_TO_UINT;
1158
1159 typedef struct _EFI_IFR_TO_UPPER {
1160   EFI_IFR_OP_HEADER        Header;
1161 } EFI_IFR_TO_UPPER;
1162
1163 typedef struct _EFI_IFR_TO_LOWER {
1164   EFI_IFR_OP_HEADER        Header;
1165 } EFI_IFR_TO_LOWER;
1166
1167 typedef struct _EFI_IFR_ADD {
1168   EFI_IFR_OP_HEADER        Header;
1169 } EFI_IFR_ADD;
1170
1171 typedef struct _EFI_IFR_AND {
1172   EFI_IFR_OP_HEADER        Header;
1173 } EFI_IFR_AND;
1174
1175 typedef struct _EFI_IFR_BITWISE_AND {
1176   EFI_IFR_OP_HEADER        Header;
1177 } EFI_IFR_BITWISE_AND;
1178
1179 typedef struct _EFI_IFR_BITWISE_OR {
1180   EFI_IFR_OP_HEADER        Header;
1181 } EFI_IFR_BITWISE_OR;
1182
1183 typedef struct _EFI_IFR_CATENATE {
1184   EFI_IFR_OP_HEADER        Header;
1185 } EFI_IFR_CATENATE;
1186
1187 typedef struct _EFI_IFR_DIVIDE {
1188   EFI_IFR_OP_HEADER        Header;
1189 } EFI_IFR_DIVIDE;
1190
1191 typedef struct _EFI_IFR_EQUAL {
1192   EFI_IFR_OP_HEADER        Header;
1193 } EFI_IFR_EQUAL;
1194
1195 typedef struct _EFI_IFR_GREATER_EQUAL {
1196   EFI_IFR_OP_HEADER        Header;
1197 } EFI_IFR_GREATER_EQUAL;
1198
1199 typedef struct _EFI_IFR_GREATER_THAN {
1200   EFI_IFR_OP_HEADER        Header;
1201 } EFI_IFR_GREATER_THAN;
1202
1203 typedef struct _EFI_IFR_LESS_EQUAL {
1204   EFI_IFR_OP_HEADER        Header;
1205 } EFI_IFR_LESS_EQUAL;
1206
1207 typedef struct _EFI_IFR_LESS_THAN {
1208   EFI_IFR_OP_HEADER        Header;
1209 } EFI_IFR_LESS_THAN;
1210
1211 typedef struct _EFI_IFR_MATCH {
1212   EFI_IFR_OP_HEADER        Header;
1213 } EFI_IFR_MATCH;
1214
1215 typedef struct _EFI_IFR_MULTIPLY {
1216   EFI_IFR_OP_HEADER        Header;
1217 } EFI_IFR_MULTIPLY;
1218
1219 typedef struct _EFI_IFR_MODULO {
1220   EFI_IFR_OP_HEADER        Header;
1221 } EFI_IFR_MODULO;
1222
1223 typedef struct _EFI_IFR_NOT_EQUAL {
1224   EFI_IFR_OP_HEADER        Header;
1225 } EFI_IFR_NOT_EQUAL;
1226
1227 typedef struct _EFI_IFR_OR {
1228   EFI_IFR_OP_HEADER        Header;
1229 } EFI_IFR_OR;
1230
1231 typedef struct _EFI_IFR_SHIFT_LEFT {
1232   EFI_IFR_OP_HEADER        Header;
1233 } EFI_IFR_SHIFT_LEFT;
1234
1235 typedef struct _EFI_IFR_SHIFT_RIGHT {
1236   EFI_IFR_OP_HEADER        Header;
1237 } EFI_IFR_SHIFT_RIGHT;
1238
1239 typedef struct _EFI_IFR_SUBTRACT {
1240   EFI_IFR_OP_HEADER        Header;
1241 } EFI_IFR_SUBTRACT;
1242
1243 typedef struct _EFI_IFR_CONDITIONAL {
1244   EFI_IFR_OP_HEADER        Header;
1245 } EFI_IFR_CONDITIONAL;
1246
1247 #define EFI_IFR_FF_CASE_SENSITIVE    0x00
1248 #define EFI_IFR_FF_CASE_INSENSITIVE  0x01
1249
1250 typedef struct _EFI_IFR_FIND {
1251   EFI_IFR_OP_HEADER        Header;
1252   UINT8                    Format;
1253 } EFI_IFR_FIND;
1254
1255 typedef struct _EFI_IFR_MID {
1256   EFI_IFR_OP_HEADER        Header;
1257 } EFI_IFR_MID;
1258
1259 typedef struct _EFI_IFR_TOKEN {
1260   EFI_IFR_OP_HEADER        Header;
1261 } EFI_IFR_TOKEN;
1262
1263 #define EFI_IFR_FLAGS_FIRST_MATCHING     0x00
1264 #define EFI_IFR_FLAGS_FIRST_NON_MATCHING 0x01
1265
1266 typedef struct _EFI_IFR_SPAN {
1267   EFI_IFR_OP_HEADER        Header;
1268   UINT8                    Flags;
1269 } EFI_IFR_SPAN;
1270
1271 //
1272 // Keyboard Package
1273 //
1274
1275 typedef enum {
1276   EfiKeyLCtrl,
1277   EfiKeyA0,
1278   EfiKeyLAlt,
1279   EfiKeySpaceBar,
1280   EfiKeyA2,
1281   EfiKeyA3,
1282   EfiKeyA4,
1283   EfiKeyRCtrl,
1284   EfiKeyLeftArrow,
1285   EfiKeyDownArrow,
1286   EfiKeyRightArrow,
1287   EfiKeyZero,
1288   EfiKeyPeriod,
1289   EfiKeyEnter,
1290   EfiKeyLShift,
1291   EfiKeyB0,
1292   EfiKeyB1,
1293   EfiKeyB2,
1294   EfiKeyB3,
1295   EfiKeyB4,
1296   EfiKeyB5,
1297   EfiKeyB6,
1298   EfiKeyB7,
1299   EfiKeyB8,
1300   EfiKeyB9,
1301   EfiKeyB10,
1302   EfiKeyRshift,
1303   EfiKeyUpArrow,
1304   EfiKeyOne,
1305   EfiKeyTwo,
1306   EfiKeyThree,
1307   EfiKeyCapsLock,
1308   EfiKeyC1,
1309   EfiKeyC2,
1310   EfiKeyC3,
1311   EfiKeyC4,
1312   EfiKeyC5,
1313   EfiKeyC6,
1314   EfiKeyC7,
1315   EfiKeyC8,
1316   EfiKeyC9,
1317   EfiKeyC10,
1318   EfiKeyC11,
1319   EfiKeyC12,
1320   EfiKeyFour,
1321   EfiKeyFive,
1322   EfiKeySix,
1323   EfiKeyPlus,
1324   EfiKeyTab,
1325   EfiKeyD1,
1326   EfiKeyD2,
1327   EfiKeyD3,
1328   EfiKeyD4,
1329   EfiKeyD5,
1330   EfiKeyD6,
1331   EfiKeyD7,
1332   EfiKeyD8,
1333   EfiKeyD9,
1334   EfiKeyD10,
1335   EfiKeyD11,
1336   EfiKeyD12,
1337   EfiKeyD13,
1338   EfiKeyDel,
1339   EfiKeyEnd,
1340   EfiKeyPgDn,
1341   EfiKeySeven,
1342   EfiKeyEight,
1343   EfiKeyNine,
1344   EfiKeyE0,
1345   EfiKeyE1,
1346   EfiKeyE2,
1347   EfiKeyE3,
1348   EfiKeyE4,
1349   EfiKeyE5,
1350   EfiKeyE6,
1351   EfiKeyE7,
1352   EfiKeyE8,
1353   EfiKeyE9,
1354   EfiKeyE10,
1355   EfiKeyE11,
1356   EfiKeyE12,
1357   EfiKeyBackSpace,
1358   EfiKeyIns,
1359   EfiKeyHome,
1360   EfiKeyPgUp,
1361   EfiKeyNLck,
1362   EfiKeySlash,
1363   EfiKeyAsterisk,
1364   EfiKeyMinus,
1365   EfiKeyEsc,
1366   EfiKeyF1,
1367   EfiKeyF2,
1368   EfiKeyF3,
1369   EfiKeyF4,
1370   EfiKeyF5,
1371   EfiKeyF6,
1372   EfiKeyF7,
1373   EfiKeyF8,
1374   EfiKeyF9,
1375   EfiKeyF10,
1376   EfiKeyF11,
1377   EfiKeyF12,
1378   EfiKeyPrint,
1379   EfiKeySLck,
1380   EfiKeyPause
1381 } EFI_KEY;
1382
1383 typedef struct {
1384   EFI_KEY                 Key;
1385   CHAR16                  Unicode;
1386   CHAR16                  ShiftedUnicode;
1387   CHAR16                  AltGrUnicode;
1388   CHAR16                  ShiftedAltGrUnicode;
1389   UINT16                  Modifier;
1390   UINT16                  AffectedAttribute;
1391 } EFI_KEY_DESCRIPTOR;
1392
1393 //
1394 // A key which is affected by all the standard shift modifiers.
1395 // Most keys would be expected to have this bit active.
1396 //
1397 #define EFI_AFFECTED_BY_STANDARD_SHIFT       0x0001
1398 //
1399 // This key is affected by the caps lock so that if a keyboard driver
1400 // would need to disambiguate between a key which had a ¡°1¡± defined
1401 // versus a ¡°a¡± character.  Having this bit turned on would tell
1402 // the keyboard driver to use the appropriate shifted state or not.
1403 //
1404 #define EFI_AFFECTED_BY_CAPS_LOCK            0x0002
1405 //
1406 // Similar to the case of CAPS lock, if this bit is active, the key
1407 // is affected by the num lock being turned on.
1408 //
1409 #define EFI_AFFECTED_BY_NUM_LOCK             0x0004
1410
1411 typedef struct {
1412   UINT16                  LayoutLength;
1413   EFI_GUID                Guid;
1414   UINT32                  LayoutDescriptorStringOffset;
1415   UINT8                   DescriptorCount;
1416   // EFI_KEY_DESCRIPTOR    Descriptors[];
1417 } EFI_HII_KEYBOARD_LAYOUT;
1418
1419 typedef struct {
1420   EFI_HII_PACKAGE_HEADER  Header;
1421   UINT16                  LayoutCount;
1422   // EFI_HII_KEYBOARD_LAYOUT Layout[];
1423 } EFI_HII_KEYBOARD_PACKAGE_HDR;
1424
1425 typedef struct {
1426   CHAR16                  Language[3];
1427   CHAR16                  Space;
1428   CHAR16                  DescriptionString[1];
1429 } EFI_DESCRIPTION_STRING;
1430
1431 typedef struct {
1432   UINT16                  DescriptionCount;
1433   EFI_DESCRIPTION_STRING  DescriptionString[1];
1434 } EFI_DESCRIPTION_STRING_BUNDLE;
1435
1436 //
1437 // Modifier values
1438 //
1439 #define EFI_NULL_MODIFIER                0x0000
1440 #define EFI_LEFT_CONTROL_MODIFIER        0x0001
1441 #define EFI_RIGHT_CONTROL_MODIFIER       0x0002
1442 #define EFI_LEFT_ALT_MODIFIER            0x0003
1443 #define EFI_RIGHT_ALT_MODIFIER           0x0004
1444 #define EFI_ALT_GR_MODIFIER              0x0005
1445 #define EFI_INSERT_MODIFIER              0x0006
1446 #define EFI_DELETE_MODIFIER              0x0007
1447 #define EFI_PAGE_DOWN_MODIFIER           0x0008
1448 #define EFI_PAGE_UP_MODIFIER             0x0009
1449 #define EFI_HOME_MODIFIER                0x000A
1450 #define EFI_END_MODIFIER                 0x000B
1451 #define EFI_LEFT_SHIFT_MODIFIER          0x000C
1452 #define EFI_RIGHT_SHIFT_MODIFIER         0x000D
1453 #define EFI_CAPS_LOCK_MODIFIER           0x000E
1454 #define EFI_NUM_LOCK _MODIFIER           0x000F
1455 #define EFI_LEFT_ARROW_MODIFIER          0x0010
1456 #define EFI_RIGHT_ARROW_MODIFIER         0x0011
1457 #define EFI_DOWN_ARROW_MODIFIER          0x0012
1458 #define EFI_UP_ARROW_MODIFIER            0x0013
1459 #define EFI_NS_KEY_MODIFIER              0x0014
1460 #define EFI_NS_KEY_DEPENDENCY_MODIFIER   0x0015
1461 #define EFI_FUNCTION_KEY_ONE_MODIFIER    0x0016
1462 #define EFI_FUNCTION_KEY_TWO_MODIFIER    0x0017
1463 #define EFI_FUNCTION_KEY_THREE_MODIFIER  0x0018
1464 #define EFI_FUNCTION_KEY_FOUR_MODIFIER   0x0019
1465 #define EFI_FUNCTION_KEY_FIVE_MODIFIER   0x001A
1466 #define EFI_FUNCTION_KEY_SIX_MODIFIER    0x001B
1467 #define EFI_FUNCTION_KEY_SEVEN_MODIFIER  0x001C
1468 #define EFI_FUNCTION_KEY_EIGHT_MODIFIER  0x001D
1469 #define EFI_FUNCTION_KEY_NINE_MODIFIER   0x001E
1470 #define EFI_FUNCTION_KEY_TEN_MODIFIER    0x001F
1471 #define EFI_FUNCTION_KEY_ELEVEN_MODIFIER 0x0020
1472 #define EFI_FUNCTION_KEY_TWELVE_MODIFIER 0x0021
1473
1474 //
1475 // Keys that have multiple control functions based on modifier
1476 // settings are handled in the keyboard driver implementation.
1477 // For instance PRINT_KEY might have a modifier held down and
1478 // is still a nonprinting character, but might have an alternate
1479 // control function like SYSREQUEST
1480 //
1481 #define EFI_PRINT_MODIFIER               0x0022
1482 #define EFI_SYS_REQUEST_MODIFIER         0x0023
1483 #define EFI_SCROLL_LOCK_MODIFIER         0x0024
1484 #define EFI_PAUSE_MODIFIER               0x0025
1485 #define EFI_BREAK_MODIFIER               0x0026
1486
1487 #pragma pack()
1488
1489
1490
1491 #endif