EdkCompatibilityPkg/Foundation/Efi/Include/EfiHii.h

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