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.
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
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.
16 #ifndef _HII_THUNK_UEFI_IFR_PARSER_
17 #define _HII_THUNK_UEFI_IFR_PARSER_
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>
32 // IFR relative definition
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
42 #define EFI_HII_VARSTORE_BUFFER 0
43 #define EFI_HII_VARSTORE_NAME_VALUE 1
44 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
46 #define FORM_INCONSISTENT_VALIDATION 0
47 #define FORM_NO_SUBMIT_VALIDATION 1
52 EFI_IFR_TYPE_VALUE Value
;
55 #define NAME_VALUE_NODE_SIGNATURE EFI_SIGNATURE_32 ('N', 'V', 'S', 'T')
65 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
67 #define FORMSET_STORAGE_SIGNATURE EFI_SIGNATURE_32 ('F', 'S', 'T', 'G')
73 UINT8 Type
; // Storage type
78 CHAR16
*Name
; // For EFI_IFR_VARSTORE
81 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
83 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
85 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
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
93 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
95 #define EXPRESSION_OPCODE_SIGNATURE EFI_SIGNATURE_32 ('E', 'X', 'O', 'P')
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
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
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
;
112 UINT16 ListLength
; // For EFI_IFR_EQ_ID_LIST
115 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
119 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
121 #define FORM_EXPRESSION_SIGNATURE EFI_SIGNATURE_32 ('F', 'E', 'X', 'P')
127 UINT8 Type
; // Type for this expression
129 UINT8 RuleId
; // For EFI_IFR_RULE only
130 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
132 EFI_HII_VALUE Result
; // Expression evaluation result
134 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
137 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
139 #define QUESTION_DEFAULT_SIGNATURE EFI_SIGNATURE_32 ('Q', 'D', 'F', 'T')
146 EFI_HII_VALUE Value
; // Default value
148 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
151 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
153 #define QUESTION_OPTION_SIGNATURE EFI_SIGNATURE_32 ('Q', 'O', 'P', 'T')
162 EFI_IMAGE_ID ImageId
;
164 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
167 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
169 #define FORM_BROWSER_STATEMENT_SIGNATURE EFI_SIGNATURE_32 ('F', 'S', 'T', 'A')
174 UINT8 Operand
; // The operand (first byte) of this Statement or Question
179 EFI_STRING_ID Prompt
;
181 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
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
;
190 EFI_STRING_ID VarName
;
195 CHAR16
*VariableName
; // Name/Value or EFI Variable name
196 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
198 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
199 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
202 // OpCode specific members
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
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
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
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
222 // Get from IFR parsing
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)
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
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
237 } FORM_BROWSER_STATEMENT
;
239 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
241 #define FORM_BROWSER_FORM_SIGNATURE EFI_SIGNATURE_32 ('F', 'F', 'R', 'M')
248 EFI_STRING_ID FormTitle
;
250 EFI_IMAGE_ID ImageId
;
252 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
253 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
256 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
258 #define FORMSET_DEFAULTSTORE_SIGNATURE EFI_SIGNATURE_32 ('F', 'D', 'F', 'S')
265 EFI_STRING_ID DefaultName
;
266 } FORMSET_DEFAULTSTORE
;
268 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
271 EFI_HII_HANDLE HiiHandle
;
272 EFI_HANDLE DriverHandle
;
273 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
274 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
276 UINTN IfrBinaryLength
;
277 UINT8
*IfrBinaryData
;
280 EFI_STRING_ID FormSetTitle
;
284 EFI_IMAGE_ID ImageId
;
286 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
287 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
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
;
297 IN FORM_BROWSER_FORMSET
*FormSet
,
298 IN FORM_BROWSER_FORM
*Form
,
299 IN OUT FORM_EXPRESSION
*Expression
305 IN FORM_BROWSER_FORMSET
*FormSet
311 IN OUT FORM_BROWSER_FORMSET
*FormSet