MdeModulePkg/Include/Guid/MdeModuleHii.h

   1 /** @file
   2   EDKII extented HII IFR guid opcodes.
   3
   4 Copyright (c) 2006 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __MDEMODULE_HII_H__
  16 #define __MDEMODULE_HII_H__
  17
  18 #define NARROW_CHAR         0xFFF0
  19 #define WIDE_CHAR           0xFFF1
  20 #define NON_BREAKING_CHAR   0xFFF2
  21
  22 ///
  23 /// State defined for password statemachine
  24 ///
  25 #define BROWSER_STATE_VALIDATE_PASSWORD  0
  26 #define BROWSER_STATE_SET_PASSWORD       1
  27
  28
  29 ///
  30 /// HII specific Vendor Device Path Node definition.
  31 ///
  32 #pragma pack(1)
  33 typedef struct {
  34   VENDOR_DEVICE_PATH             VendorDevicePath;
  35   UINT32                         Reserved;
  36   UINT64                         UniqueId;
  37 } HII_VENDOR_DEVICE_PATH_NODE;
  38 #pragma pack()
  39
  40 ///
  41 /// HII specific Vendor Device Path definition.
  42 ///
  43 typedef struct {
  44   HII_VENDOR_DEVICE_PATH_NODE    Node;
  45   EFI_DEVICE_PATH_PROTOCOL       End;
  46 } HII_VENDOR_DEVICE_PATH;
  47
  48 ///
  49 /// GUIDed opcodes defined for EDKII implementation
  50 ///
  51 #define EFI_IFR_TIANO_GUID \
  52   { 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
  53
  54 #pragma pack(1)
  55
  56 ///
  57 /// EDKII implementation extension opcodes, new extension can be added here later.
  58 ///
  59 #define EFI_IFR_EXTEND_OP_LABEL       0x0
  60 #define EFI_IFR_EXTEND_OP_BANNER      0x1
  61 #define EFI_IFR_EXTEND_OP_TIMEOUT     0x2
  62 #define EFI_IFR_EXTEND_OP_CLASS       0x3
  63 #define EFI_IFR_EXTEND_OP_SUBCLASS    0x4
  64
  65 ///
  66 /// Label opcode
  67 ///
  68 typedef struct _EFI_IFR_GUID_LABEL {
  69   EFI_IFR_OP_HEADER   Header;
  70   ///
  71   /// EFI_IFR_TIANO_GUID
  72   ///
  73   EFI_GUID            Guid;
  74   ///
  75   /// EFI_IFR_EXTEND_OP_LABEL
  76   ///
  77   UINT8               ExtendOpCode;
  78   ///
  79   /// Label Number
  80   ///
  81   UINT16              Number;
  82 } EFI_IFR_GUID_LABEL;
  83
  84 #define EFI_IFR_BANNER_ALIGN_LEFT     0
  85 #define EFI_IFR_BANNER_ALIGN_CENTER   1
  86 #define EFI_IFR_BANNER_ALIGN_RIGHT    2
  87
  88 ///
  89 /// Banner opcode
  90 ///
  91 typedef struct _EFI_IFR_GUID_BANNER {
  92   EFI_IFR_OP_HEADER   Header;
  93   ///
  94   /// EFI_IFR_TIANO_GUID
  95   ///
  96   EFI_GUID            Guid;
  97   ///
  98   /// EFI_IFR_EXTEND_OP_BANNER
  99   ///
 100   UINT8               ExtendOpCode;
 101   EFI_STRING_ID       Title;        ///< The string token for the banner title
 102   UINT16              LineNumber;   ///< 1-based line number
 103   UINT8               Alignment;    ///< left, center, or right-aligned
 104 } EFI_IFR_GUID_BANNER;
 105
 106 ///
 107 /// Timeout opcode
 108 ///
 109 typedef struct _EFI_IFR_GUID_TIMEOUT {
 110   EFI_IFR_OP_HEADER   Header;
 111   ///
 112   /// EFI_IFR_TIANO_GUID
 113   ///
 114   EFI_GUID            Guid;
 115   ///
 116   /// EFI_IFR_EXTEND_OP_TIMEOUT
 117   ///
 118   UINT8               ExtendOpCode;
 119   UINT16              TimeOut;       ///< TimeOut Value
 120 } EFI_IFR_GUID_TIMEOUT;
 121
 122 #define EFI_NON_DEVICE_CLASS              0x00
 123 #define EFI_DISK_DEVICE_CLASS             0x01
 124 #define EFI_VIDEO_DEVICE_CLASS            0x02
 125 #define EFI_NETWORK_DEVICE_CLASS          0x04
 126 #define EFI_INPUT_DEVICE_CLASS            0x08
 127 #define EFI_ON_BOARD_DEVICE_CLASS         0x10
 128 #define EFI_OTHER_DEVICE_CLASS            0x20
 129
 130 ///
 131 /// Device Class opcode
 132 ///
 133 typedef struct _EFI_IFR_GUID_CLASS {
 134   EFI_IFR_OP_HEADER   Header;
 135   ///
 136   /// EFI_IFR_TIANO_GUID
 137   ///
 138   EFI_GUID            Guid;
 139   ///
 140   /// EFI_IFR_EXTEND_OP_CLASS
 141   ///
 142   UINT8               ExtendOpCode;
 143   UINT16              Class;           ///< Device Class from the above
 144 } EFI_IFR_GUID_CLASS;
 145
 146 #define EFI_SETUP_APPLICATION_SUBCLASS    0x00
 147 #define EFI_GENERAL_APPLICATION_SUBCLASS  0x01
 148 #define EFI_FRONT_PAGE_SUBCLASS           0x02
 149 #define EFI_SINGLE_USE_SUBCLASS           0x03
 150
 151 ///
 152 /// SubClass opcode
 153 ///
 154 typedef struct _EFI_IFR_GUID_SUBCLASS {
 155   EFI_IFR_OP_HEADER   Header;
 156   ///
 157   /// EFI_IFR_TIANO_GUID
 158   ///
 159   EFI_GUID            Guid;
 160   ///
 161   /// EFI_IFR_EXTEND_OP_SUBCLASS
 162   ///
 163   UINT8               ExtendOpCode;
 164   UINT16              SubClass;      ///< Sub Class type from the above
 165 } EFI_IFR_GUID_SUBCLASS;
 166
 167 ///
 168 /// GUIDed opcodes support for framework vfr.
 169 ///
 170 #define EFI_IFR_FRAMEWORK_GUID \
 171   { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }
 172
 173 ///
 174 /// Two extended opcode are added, new extension can be added here later.
 175 /// One is for framework OneOf question Option Key value,
 176 /// Another is for framework vareqval.
 177 ///
 178 #define EFI_IFR_EXTEND_OP_OPTIONKEY   0x0
 179 #define EFI_IFR_EXTEND_OP_VAREQNAME   0x1
 180
 181 ///
 182 /// Store the framework vfr option key value
 183 ///
 184 typedef struct _EFI_IFR_GUID_OPTIONKEY {
 185   EFI_IFR_OP_HEADER   Header;
 186   ///
 187   /// EFI_IFR_FRAMEWORK_GUID
 188   ///
 189   EFI_GUID            Guid;
 190   ///
 191   /// EFI_IFR_EXTEND_OP_OPTIONKEY
 192   ///
 193   UINT8               ExtendOpCode;
 194   ///
 195   /// OneOf Questiond ID binded by OneOf Option
 196   ///
 197   EFI_QUESTION_ID     QuestionId;
 198   ///
 199   /// The OneOf Option Value.
 200   ///
 201   EFI_IFR_TYPE_VALUE  OptionValue;
 202   ///
 203   /// The Framework OneOf Option Key Value.
 204   ///
 205   UINT16              KeyValue;
 206 } EFI_IFR_GUID_OPTIONKEY;
 207
 208 ///
 209 /// Store the framework vfr vareqval name number
 210 ///
 211 typedef struct _EFI_IFR_GUID_VAREQNAME {
 212   EFI_IFR_OP_HEADER   Header;
 213   ///
 214   /// EFI_IFR_FRAMEWORK_GUID
 215   ///
 216   EFI_GUID            Guid;
 217   ///
 218   /// EFI_IFR_EXTEND_OP_VAREQNAME
 219   ///
 220   UINT8               ExtendOpCode;
 221   ///
 222   /// Question ID of the Numeric Opcode created.
 223   ///
 224   EFI_QUESTION_ID     QuestionId;
 225   ///
 226   /// For vareqval (0x100), NameId is 0x100.
 227   /// This value will converte to a Unicode String following this rule.
 228   ///            sprintf(StringBuffer, "%d", NameId)
 229   /// The the Unicode String will be used as a EFI Variable Name.
 230   ///
 231   UINT16              NameId;
 232 } EFI_IFR_GUID_VAREQNAME;
 233
 234 #pragma pack()
 235
 236 extern EFI_GUID gEfiIfrTianoGuid;
 237 extern EFI_GUID gEfiIfrFrameworkGuid;
 238
 239 #endif
 240