MdePkg/Include/Uefi/UefiInternalFormRepresentation.h

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