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