EdkCompatibilityPkg/Compatibility/FrameworkHiiToUefiHiiThunk/UefiIfrParser.h

   1 /** @file
   2   Function and Macro defintions for IFR parsing. To get the default value from IFR package, the IFR
   3   opcode needs to be parsed. Most of code is taken from MdeModulePkg\Universal\SetupBrowserDxe\IfrParse.c.
   4
   5   Copyright (c) 2008, Intel Corporation
   6   All rights reserved. This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _HII_THUNK_UEFI_IFR_PARSER_
  17 #define _HII_THUNK_UEFI_IFR_PARSER_
  18
  19 #include <PiDxe.h>
  20
  21 #include <Protocol/Print.h>
  22 #include <Protocol/HiiConfigAccess.h>
  23 #include <Protocol/HiiConfigRouting.h>
  24 #include <Protocol/HiiDatabase.h>
  25 #include <Protocol/HiiString.h>
  26
  27 //
  28 // IFR relative definition
  29 //
  30 #define EFI_HII_EXPRESSION_INCONSISTENT_IF   0
  31 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF      1
  32 #define EFI_HII_EXPRESSION_GRAY_OUT_IF       2
  33 #define EFI_HII_EXPRESSION_SUPPRESS_IF       3
  34 #define EFI_HII_EXPRESSION_DISABLE_IF        4
  35 #define EFI_HII_EXPRESSION_VALUE             5
  36 #define EFI_HII_EXPRESSION_RULE              6
  37
  38 #define EFI_HII_VARSTORE_BUFFER              0
  39 #define EFI_HII_VARSTORE_NAME_VALUE          1
  40 #define EFI_HII_VARSTORE_EFI_VARIABLE        2
  41
  42 #define FORM_INCONSISTENT_VALIDATION         0
  43 #define FORM_NO_SUBMIT_VALIDATION            1
  44
  45 extern EFI_GUID  gTianoHiiIfrGuid;
  46
  47
  48 typedef struct {
  49   UINT8               Type;
  50   EFI_IFR_TYPE_VALUE  Value;
  51 } EFI_HII_VALUE;
  52
  53 #define NAME_VALUE_NODE_SIGNATURE  EFI_SIGNATURE_32 ('N', 'V', 'S', 'T')
  54
  55 typedef struct {
  56   UINTN            Signature;
  57   LIST_ENTRY       Link;
  58   CHAR16           *Name;
  59   CHAR16           *Value;
  60   CHAR16           *EditValue;
  61 } NAME_VALUE_NODE;
  62
  63 #define NAME_VALUE_NODE_FROM_LINK(a)  CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
  64
  65 #define FORMSET_STORAGE_SIGNATURE  EFI_SIGNATURE_32 ('F', 'S', 'T', 'G')
  66
  67 typedef struct {
  68   UINTN            Signature;
  69   LIST_ENTRY       Link;
  70
  71   UINT8            Type;           // Storage type
  72
  73   UINT16           VarStoreId;
  74   EFI_GUID         Guid;
  75
  76   CHAR16           *Name;          // For EFI_IFR_VARSTORE
  77   UINT16           Size;
  78   UINT8            *Buffer;
  79   UINT8            *EditBuffer;    // Edit copy for Buffer Storage
  80
  81   LIST_ENTRY       NameValueListHead; // List of NAME_VALUE_NODE
  82
  83   UINT32           Attributes;     // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
  84
  85   CHAR16           *ConfigHdr;     // <ConfigHdr>
  86   CHAR16           *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
  87   UINTN            ElementCount;   // Number of <RequestElement> in the <ConfigRequest>
  88   UINTN            SpareStrLen;    // Spare length of ConfigRequest string buffer
  89 } FORMSET_STORAGE;
  90
  91 #define FORMSET_STORAGE_FROM_LINK(a)  CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
  92
  93 #define EXPRESSION_OPCODE_SIGNATURE  EFI_SIGNATURE_32 ('E', 'X', 'O', 'P')
  94
  95 typedef struct {
  96   UINTN             Signature;
  97   LIST_ENTRY        Link;
  98
  99   UINT8             Operand;
 100
 101   UINT8             Format;      // For EFI_IFR_TO_STRING, EFI_IFR_FIND
 102   UINT8             Flags;       // For EFI_IFR_SPAN
 103   UINT8             RuleId;      // For EFI_IFR_RULE_REF
 104
 105   EFI_HII_VALUE     Value;       // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1
 106
 107   EFI_QUESTION_ID   QuestionId;  // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_LIST, EFI_IFR_QUESTION_REF1
 108   EFI_QUESTION_ID   QuestionId2;
 109
 110   UINT16            ListLength;  // For EFI_IFR_EQ_ID_LIST
 111   UINT16            *ValueList;
 112
 113   EFI_STRING_ID     DevicePath;  // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
 114   EFI_GUID          Guid;
 115 } EXPRESSION_OPCODE;
 116
 117 #define EXPRESSION_OPCODE_FROM_LINK(a)  CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
 118
 119 #define FORM_EXPRESSION_SIGNATURE  EFI_SIGNATURE_32 ('F', 'E', 'X', 'P')
 120
 121 typedef struct {
 122   UINTN             Signature;
 123   LIST_ENTRY        Link;
 124
 125   UINT8             Type;            // Type for this expression
 126
 127   UINT8             RuleId;          // For EFI_IFR_RULE only
 128   EFI_STRING_ID     Error;           // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
 129
 130   EFI_HII_VALUE     Result;          // Expression evaluation result
 131
 132   LIST_ENTRY        OpCodeListHead;  // OpCodes consist of this expression (EXPRESSION_OPCODE)
 133 } FORM_EXPRESSION;
 134
 135 #define FORM_EXPRESSION_FROM_LINK(a)  CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
 136
 137 #define QUESTION_DEFAULT_SIGNATURE  EFI_SIGNATURE_32 ('Q', 'D', 'F', 'T')
 138
 139 typedef struct {
 140   UINTN               Signature;
 141   LIST_ENTRY          Link;
 142
 143   UINT16              DefaultId;
 144   EFI_HII_VALUE       Value;              // Default value
 145
 146   FORM_EXPRESSION     *ValueExpression;   // Not-NULL indicates default value is provided by EFI_IFR_VALUE
 147 } QUESTION_DEFAULT;
 148
 149 #define QUESTION_DEFAULT_FROM_LINK(a)  CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
 150
 151 #define QUESTION_OPTION_SIGNATURE  EFI_SIGNATURE_32 ('Q', 'O', 'P', 'T')
 152
 153 typedef struct {
 154   UINTN               Signature;
 155   LIST_ENTRY          Link;
 156
 157   EFI_STRING_ID       Text;
 158   UINT8               Flags;
 159   EFI_HII_VALUE       Value;
 160   EFI_IMAGE_ID        ImageId;
 161
 162   FORM_EXPRESSION     *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf
 163 } QUESTION_OPTION;
 164
 165 #define QUESTION_OPTION_FROM_LINK(a)  CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
 166
 167 #define FORM_BROWSER_STATEMENT_SIGNATURE  EFI_SIGNATURE_32 ('F', 'S', 'T', 'A')
 168 typedef struct {
 169   UINTN                 Signature;
 170   LIST_ENTRY            Link;
 171
 172   UINT8                 Operand;          // The operand (first byte) of this Statement or Question
 173
 174   //
 175   // Statement Header
 176   //
 177   EFI_STRING_ID         Prompt;
 178   EFI_STRING_ID         Help;
 179   EFI_STRING_ID         TextTwo;          // For EFI_IFR_TEXT
 180
 181   //
 182   // Question Header
 183   //
 184   EFI_QUESTION_ID       QuestionId;       // The value of zero is reserved
 185   EFI_VARSTORE_ID       VarStoreId;       // A value of zero indicates no variable storage
 186   FORMSET_STORAGE       *Storage;
 187   union {
 188     EFI_STRING_ID       VarName;
 189     UINT16              VarOffset;
 190   }  VarStoreInfo;
 191   UINT16                StorageWidth;
 192   UINT8                 QuestionFlags;
 193   CHAR16                *VariableName;    // Name/Value or EFI Variable name
 194   CHAR16                *BlockName;       // Buffer storage block name: "OFFSET=...WIDTH=..."
 195
 196   EFI_HII_VALUE         HiiValue;         // Edit copy for checkbox, numberic, oneof
 197   UINT8                 *BufferValue;     // Edit copy for string, password, orderedlist
 198
 199   //
 200   // OpCode specific members
 201   //
 202   UINT8                 Flags;            // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
 203                                           // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
 204   UINT8                 MaxContainers;    // for EFI_IFR_ORDERED_LIST
 205
 206   UINT16                BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number
 207   EFI_STRING_ID         QuestionConfig;   // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
 208
 209   UINT64                Minimum;          // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
 210   UINT64                Maximum;          // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
 211   UINT64                Step;
 212
 213   EFI_DEFAULT_ID        DefaultId;        // for EFI_IFR_RESET_BUTTON
 214   EFI_FORM_ID           RefFormId;        // for EFI_IFR_REF
 215   EFI_QUESTION_ID       RefQuestionId;    // for EFI_IFR_REF2
 216   EFI_GUID              RefFormSetId;     // for EFI_IFR_REF3
 217   EFI_STRING_ID         RefDevicePath;    // for EFI_IFR_REF4
 218
 219   //
 220   // Get from IFR parsing
 221   //
 222   FORM_EXPRESSION       *ValueExpression;    // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
 223   LIST_ENTRY            DefaultListHead;     // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
 224   LIST_ENTRY            OptionListHead;      // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
 225
 226   EFI_IMAGE_ID          ImageId;             // nested EFI_IFR_IMAGE
 227   UINT8                 RefreshInterval;     // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
 228   BOOLEAN               InSubtitle;          // nesting inside of EFI_IFR_SUBTITLE
 229
 230   LIST_ENTRY            InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)
 231   LIST_ENTRY            NoSubmitListHead;    // nested nosubmit expression list (FORM_EXPRESSION)
 232   FORM_EXPRESSION       *GrayOutExpression;  // nesting inside of GrayOutIf
 233   FORM_EXPRESSION       *SuppressExpression; // nesting inside of SuppressIf
 234
 235 } FORM_BROWSER_STATEMENT;
 236
 237 #define FORM_BROWSER_STATEMENT_FROM_LINK(a)  CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
 238
 239 #define FORM_BROWSER_FORM_SIGNATURE  EFI_SIGNATURE_32 ('F', 'F', 'R', 'M')
 240
 241 typedef struct {
 242   UINTN             Signature;
 243   LIST_ENTRY        Link;
 244
 245   UINT16            FormId;
 246   EFI_STRING_ID     FormTitle;
 247
 248   EFI_IMAGE_ID      ImageId;
 249
 250   LIST_ENTRY        ExpressionListHead;   // List of Expressions (FORM_EXPRESSION)
 251   LIST_ENTRY        StatementListHead;    // List of Statements and Questions (FORM_BROWSER_STATEMENT)
 252 } FORM_BROWSER_FORM;
 253
 254 #define FORM_BROWSER_FORM_FROM_LINK(a)  CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
 255
 256 #define FORMSET_DEFAULTSTORE_SIGNATURE  EFI_SIGNATURE_32 ('F', 'D', 'F', 'S')
 257
 258 typedef struct {
 259   UINTN            Signature;
 260   LIST_ENTRY       Link;
 261
 262   UINT16           DefaultId;
 263   EFI_STRING_ID    DefaultName;
 264 } FORMSET_DEFAULTSTORE;
 265
 266 #define FORMSET_DEFAULTSTORE_FROM_LINK(a)  CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
 267
 268 typedef struct {
 269   EFI_HII_HANDLE                  HiiHandle;
 270   EFI_HANDLE                      DriverHandle;
 271   EFI_HII_CONFIG_ACCESS_PROTOCOL  *ConfigAccess;
 272   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 273
 274   UINTN                           IfrBinaryLength;
 275   UINT8                           *IfrBinaryData;
 276
 277   EFI_GUID                        Guid;
 278   EFI_STRING_ID                   FormSetTitle;
 279   EFI_STRING_ID                   Help;
 280   UINT16                          Class;
 281   UINT16                          SubClass;
 282   EFI_IMAGE_ID                    ImageId;
 283
 284   FORM_BROWSER_STATEMENT          *StatementBuffer;     // Buffer for all Statements and Questions
 285   EXPRESSION_OPCODE               *ExpressionBuffer;    // Buffer for all Expression OpCode
 286
 287   LIST_ENTRY                      StorageListHead;      // Storage list (FORMSET_STORAGE)
 288   LIST_ENTRY                      DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)
 289   LIST_ENTRY                      FormListHead;         // Form list (FORM_BROWSER_FORM)
 290 } FORM_BROWSER_FORMSET;
 291
 292
 293 EFI_STATUS
 294 EvaluateExpression (
 295   IN FORM_BROWSER_FORMSET  *FormSet,
 296   IN FORM_BROWSER_FORM     *Form,
 297   IN OUT FORM_EXPRESSION   *Expression
 298   )
 299 ;
 300
 301 EFI_STATUS
 302 ParseOpCodes (
 303   IN FORM_BROWSER_FORMSET              *FormSet
 304   )
 305 ;
 306
 307 VOID
 308 DestroyFormSet (
 309   IN OUT FORM_BROWSER_FORMSET  *FormSet
 310   )
 311 ;
 312
 313 #endif
 314