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