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 This parser is simplified from the origianl IfrParser.c in the following way:
6 1) All data structure definition that have nothing to do with IFR Default value scanning (
7 required to implement Framework HII's GetDefaultImage ()) is removed.
8 2) Ignore the IFR opcode which is invalid for Form Package
9 generated using Framework VFR file.
11 Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
12 This program and the accompanying materials
13 are licensed and made available under the terms and conditions of the BSD License
14 which accompanies this distribution. The full text of the license may be found at
15 http://opensource.org/licenses/bsd-license.php
17 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
18 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #ifndef _HII_THUNK_UEFI_IFR_PARSER_
23 #define _HII_THUNK_UEFI_IFR_PARSER_
27 // IFR relative definition
29 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
30 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
31 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
32 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
33 #define EFI_HII_EXPRESSION_DISABLE_IF 4
34 #define EFI_HII_EXPRESSION_VALUE 5
35 #define EFI_HII_EXPRESSION_RULE 6
37 #define EFI_HII_VARSTORE_BUFFER 0
38 #define EFI_HII_VARSTORE_NAME_VALUE 1
39 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
41 #define FORM_INCONSISTENT_VALIDATION 0
42 #define FORM_NO_SUBMIT_VALIDATION 1
44 extern EFI_GUID gTianoHiiIfrGuid
;
46 #define ONE_OF_OPTION_MAP_ENTRY_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP_ENTRY, Link, ONE_OF_OPTION_MAP_ENTRY_SIGNATURE)
47 #define ONE_OF_OPTION_MAP_ENTRY_SIGNATURE SIGNATURE_32 ('O', 'O', 'M', 'E')
53 EFI_IFR_TYPE_VALUE Value
;
55 } ONE_OF_OPTION_MAP_ENTRY
;
59 #define ONE_OF_OPTION_MAP_FROM_LINK(Record) CR(Record, ONE_OF_OPTION_MAP, Link, ONE_OF_OPTION_MAP_SIGNATURE)
60 #define ONE_OF_OPTION_MAP_SIGNATURE SIGNATURE_32 ('O', 'O', 'O', 'M')
67 UINT8 ValueType
; //EFI_IFR_TYPE_NUM_*
69 EFI_QUESTION_ID QuestionId
;
71 LIST_ENTRY OneOfOptionMapEntryListHead
; //ONE_OF_OPTION_MAP_ENTRY
77 EFI_IFR_TYPE_VALUE Value
;
80 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
82 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
88 UINT8 Type
; // Storage type
93 CHAR16
*Name
; // For EFI_IFR_VARSTORE
96 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
100 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
104 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
112 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
113 UINT8 Flags
; // For EFI_IFR_SPAN
114 UINT8 RuleId
; // For EFI_IFR_RULE_REF
116 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
118 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
119 EFI_QUESTION_ID QuestionId2
;
121 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
124 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
128 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
130 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
136 UINT8 Type
; // Type for this expression
138 UINT8 RuleId
; // For EFI_IFR_RULE only
139 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
141 EFI_HII_VALUE Result
; // Expression evaluation result
143 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
146 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
149 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
156 EFI_HII_VALUE Value
; // Default value
160 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
162 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
171 EFI_IMAGE_ID ImageId
;
175 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
178 EFI_STRING_ID VarName
;
182 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
187 UINT8 Operand
; // The operand (first byte) of this Statement or Question
192 EFI_STRING_ID Prompt
;
194 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
199 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
200 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
201 FORMSET_STORAGE
*Storage
;
202 VAR_STORE_INFO VarStoreInfo
;
207 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
208 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
211 // OpCode specific members
213 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
214 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
215 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
217 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
218 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
220 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
221 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
224 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
225 EFI_FORM_ID RefFormId
; // for EFI_IFR_REF
226 EFI_QUESTION_ID RefQuestionId
; // for EFI_IFR_REF2
227 EFI_GUID RefFormSetId
; // for EFI_IFR_REF3
228 EFI_STRING_ID RefDevicePath
; // for EFI_IFR_REF4
231 // Get from IFR parsing
233 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
234 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
236 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
237 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
238 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
240 } FORM_BROWSER_STATEMENT
;
242 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
244 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
251 EFI_STRING_ID FormTitle
;
253 EFI_IMAGE_ID ImageId
;
256 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
258 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
261 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
263 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
270 EFI_STRING_ID DefaultName
;
271 } FORMSET_DEFAULTSTORE
;
273 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
276 EFI_HII_HANDLE HiiHandle
;
278 UINTN IfrBinaryLength
;
279 UINT8
*IfrBinaryData
;
282 EFI_STRING_ID FormSetTitle
;
286 EFI_IMAGE_ID ImageId
;
288 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
290 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
293 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
294 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
295 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
297 LIST_ENTRY OneOfOptionMapListHead
; //ONE_OF_OPTION_MAP
299 UINT16 MaxQuestionId
;
302 // Added for Framework HII Thunk.
303 // Default Variable Storage built from a Framework VFR file using UEFI VFR Compiler in Compatibility mode is determined
304 // by priority rules defined in GetFormsetDefaultVarstoreId (). See the function description for details.
306 EFI_VARSTORE_ID DefaultVarStoreId
;
307 CHAR16
*OriginalDefaultVarStoreName
;
309 UINTN NumberOfStatement
;
311 } FORM_BROWSER_FORMSET
;
315 Parse opcodes in the formset IFR binary.
317 @param FormSet Pointer of the FormSet data structure.
319 @retval EFI_SUCCESS Opcode parse success.
320 @retval Other Opcode parse fail.
325 IN FORM_BROWSER_FORMSET
*FormSet
329 Free resources allocated for a FormSet
331 @param FormSet Pointer of the FormSet
338 IN OUT FORM_BROWSER_FORMSET
*FormSet