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