]>
Commit | Line | Data |
---|---|---|
7936fb6a | 1 | /** @file\r |
d66e6c16 | 2 | Private MACRO, structure and function definitions for Setup Browser module.\r |
7936fb6a | 3 | \r |
d1102dba | 4 | Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
7936fb6a | 6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef _SETUP_H_\r | |
17 | #define _SETUP_H_\r | |
18 | \r | |
19 | \r | |
39099938 | 20 | #include <PiDxe.h>\r |
7936fb6a | 21 | \r |
7936fb6a | 22 | #include <Protocol/SimpleTextOut.h>\r |
23 | #include <Protocol/SimpleTextIn.h>\r | |
24 | #include <Protocol/FormBrowser2.h>\r | |
7c6c064c ED |
25 | #include <Protocol/FormBrowserEx2.h>\r |
26 | #include <Protocol/DisplayProtocol.h>\r | |
7936fb6a | 27 | #include <Protocol/DevicePath.h>\r |
28 | #include <Protocol/UnicodeCollation.h>\r | |
29 | #include <Protocol/HiiConfigAccess.h>\r | |
30 | #include <Protocol/HiiConfigRouting.h>\r | |
31 | #include <Protocol/HiiDatabase.h>\r | |
32 | #include <Protocol/HiiString.h>\r | |
cbf73e50 | 33 | #include <Protocol/UserManager.h>\r |
80a047f0 | 34 | #include <Protocol/DevicePathFromText.h>\r |
9bd22b08 | 35 | #include <Protocol/RegularExpressionProtocol.h>\r |
7936fb6a | 36 | \r |
5c526736 | 37 | #include <Guid/MdeModuleHii.h>\r |
0a1147ed | 38 | #include <Guid/HiiPlatformSetupFormset.h>\r |
2573712e | 39 | #include <Guid/HiiFormMapMethodGuid.h>\r |
32eabfd5 | 40 | #include <Guid/ZeroGuid.h>\r |
7936fb6a | 41 | \r |
7936fb6a | 42 | #include <Library/PrintLib.h>\r |
43 | #include <Library/DebugLib.h>\r | |
44 | #include <Library/BaseMemoryLib.h>\r | |
45 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
46 | #include <Library/UefiDriverEntryPoint.h>\r | |
47 | #include <Library/UefiBootServicesTableLib.h>\r | |
48 | #include <Library/BaseLib.h>\r | |
49 | #include <Library/MemoryAllocationLib.h>\r | |
7936fb6a | 50 | #include <Library/HiiLib.h>\r |
f511d656 | 51 | #include <Library/PcdLib.h>\r |
cb7d01c0 | 52 | #include <Library/DevicePathLib.h>\r |
7c6c064c | 53 | #include <Library/UefiLib.h>\r |
7936fb6a | 54 | \r |
7936fb6a | 55 | \r |
56 | //\r | |
57 | // This is the generated header file which includes whatever needs to be exported (strings + IFR)\r | |
58 | //\r | |
59 | \r | |
7c6c064c ED |
60 | #define UI_ACTION_NONE 0\r |
61 | #define UI_ACTION_REFRESH_FORM 1\r | |
62 | #define UI_ACTION_REFRESH_FORMSET 2\r | |
63 | #define UI_ACTION_EXIT 3\r | |
7936fb6a | 64 | \r |
65 | //\r | |
7936fb6a | 66 | //\r |
67 | // Time definitions\r | |
68 | //\r | |
69 | #define ONE_SECOND 10000000\r | |
70 | \r | |
7936fb6a | 71 | // Incremental string lenght of ConfigRequest\r |
72 | //\r | |
73 | #define CONFIG_REQUEST_STRING_INCREMENTAL 1024\r | |
74 | \r | |
7936fb6a | 75 | //\r |
76 | // Incremental size of stack for expression\r | |
77 | //\r | |
78 | #define EXPRESSION_STACK_SIZE_INCREMENT 0x100\r | |
79 | \r | |
0269d14b | 80 | #define EFI_IFR_SPECIFICATION_VERSION (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) | (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) | ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))\r |
7936fb6a | 81 | \r |
7936fb6a | 82 | \r |
f3f2e05d | 83 | #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')\r |
7936fb6a | 84 | typedef struct {\r |
85 | UINT32 Signature;\r | |
86 | \r | |
87 | EFI_HANDLE Handle;\r | |
88 | \r | |
89 | //\r | |
90 | // Produced protocol\r | |
91 | //\r | |
7c6c064c | 92 | EFI_FORM_BROWSER2_PROTOCOL FormBrowser2;\r |
2fa0e11d | 93 | EDKII_FORM_BROWSER_EXTENSION_PROTOCOL FormBrowserEx;\r |
7936fb6a | 94 | \r |
7c6c064c | 95 | EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL FormBrowserEx2;\r |
7936fb6a | 96 | \r |
7c6c064c | 97 | } SETUP_DRIVER_PRIVATE_DATA;\r |
25361615 | 98 | \r |
7936fb6a | 99 | //\r |
100 | // IFR relative definition\r | |
101 | //\r | |
102 | #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r | |
103 | #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r | |
104 | #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r | |
105 | #define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r | |
106 | #define EFI_HII_EXPRESSION_DISABLE_IF 4\r | |
107 | #define EFI_HII_EXPRESSION_VALUE 5\r | |
108 | #define EFI_HII_EXPRESSION_RULE 6\r | |
2573712e LG |
109 | #define EFI_HII_EXPRESSION_READ 7\r |
110 | #define EFI_HII_EXPRESSION_WRITE 8\r | |
1c0d306f | 111 | #define EFI_HII_EXPRESSION_WARNING_IF 9\r |
7936fb6a | 112 | \r |
113 | #define EFI_HII_VARSTORE_BUFFER 0\r | |
114 | #define EFI_HII_VARSTORE_NAME_VALUE 1\r | |
c0462ea7 ED |
115 | #define EFI_HII_VARSTORE_EFI_VARIABLE 2 // EFI Varstore type follow UEFI spec before 2.3.1.\r |
116 | #define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3 // EFI varstore type follow UEFI spec 2.3.1 and later.\r | |
7936fb6a | 117 | \r |
118 | #define FORM_INCONSISTENT_VALIDATION 0\r | |
119 | #define FORM_NO_SUBMIT_VALIDATION 1\r | |
120 | \r | |
f3f2e05d | 121 | #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')\r |
7936fb6a | 122 | \r |
123 | typedef struct {\r | |
124 | UINTN Signature;\r | |
125 | LIST_ENTRY Link;\r | |
126 | CHAR16 *Name;\r | |
127 | CHAR16 *Value;\r | |
128 | CHAR16 *EditValue;\r | |
129 | } NAME_VALUE_NODE;\r | |
130 | \r | |
131 | #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r | |
132 | \r | |
94f3aae7 | 133 | #define BROWSER_STORAGE_SIGNATURE SIGNATURE_32 ('B', 'S', 'T', 'G')\r |
7936fb6a | 134 | \r |
135 | typedef struct {\r | |
136 | UINTN Signature;\r | |
137 | LIST_ENTRY Link;\r | |
138 | \r | |
139 | UINT8 Type; // Storage type\r | |
140 | \r | |
fae73624 ED |
141 | BOOLEAN Initialized; // Whether this varstore is initialized, efi varstore not used.\r |
142 | \r | |
143 | EFI_HII_HANDLE HiiHandle; // HiiHandle for this varstore, efi varstore not used.\r | |
7936fb6a | 144 | EFI_GUID Guid;\r |
145 | \r | |
146 | CHAR16 *Name; // For EFI_IFR_VARSTORE\r | |
147 | UINT16 Size;\r | |
148 | UINT8 *Buffer;\r | |
149 | UINT8 *EditBuffer; // Edit copy for Buffer Storage\r | |
150 | \r | |
151 | LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE\r | |
152 | \r | |
153 | UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r | |
154 | \r | |
efffd9c1 ED |
155 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r |
156 | // <RequestElement> includes all fields which is used by current form sets.\r | |
157 | UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r | |
94f3aae7 ED |
158 | } BROWSER_STORAGE;\r |
159 | \r | |
160 | #define BROWSER_STORAGE_FROM_LINK(a) CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)\r | |
161 | \r | |
162 | #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')\r | |
163 | \r | |
164 | typedef struct {\r | |
165 | UINTN Signature;\r | |
166 | LIST_ENTRY Link;\r | |
167 | \r | |
4d4deaac ED |
168 | LIST_ENTRY SaveFailLink;\r |
169 | \r | |
94f3aae7 ED |
170 | UINT16 VarStoreId;\r |
171 | \r | |
172 | BROWSER_STORAGE *BrowserStorage;\r | |
173 | \r | |
a35ecb75 ED |
174 | CHAR16 *ConfigHdr; // <ConfigHdr>\r |
175 | \r | |
7936fb6a | 176 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r |
7a9612ce | 177 | CHAR16 *ConfigAltResp; // Alt config response string for this ConfigRequest.\r |
787fc2a6 | 178 | BOOLEAN HasCallAltCfg; // Flag to show whether browser has call ExtractConfig to get Altcfg string.\r |
7936fb6a | 179 | UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r |
180 | UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r | |
8066b27e DB |
181 | CHAR16 *RestoreConfigRequest; // When submit formset fail, the element need to be restored\r |
182 | CHAR16 *SyncConfigRequest; // When submit formset fail, the element need to be synced\r | |
7936fb6a | 183 | } FORMSET_STORAGE;\r |
184 | \r | |
185 | #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r | |
4d4deaac | 186 | #define FORMSET_STORAGE_FROM_SAVE_FAIL_LINK(a) CR (a, FORMSET_STORAGE, SaveFailLink, FORMSET_STORAGE_SIGNATURE)\r |
7936fb6a | 187 | \r |
2573712e LG |
188 | typedef union {\r |
189 | EFI_STRING_ID VarName;\r | |
190 | UINT16 VarOffset;\r | |
191 | } VAR_STORE_INFO;\r | |
192 | \r | |
f3f2e05d | 193 | #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')\r |
7936fb6a | 194 | \r |
195 | typedef struct {\r | |
196 | UINTN Signature;\r | |
197 | LIST_ENTRY Link;\r | |
198 | \r | |
199 | UINT8 Operand;\r | |
200 | \r | |
201 | UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r | |
202 | UINT8 Flags; // For EFI_IFR_SPAN\r | |
203 | UINT8 RuleId; // For EFI_IFR_RULE_REF\r | |
204 | \r | |
205 | 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\r | |
206 | \r | |
2654f642 | 207 | EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1\r |
7936fb6a | 208 | EFI_QUESTION_ID QuestionId2;\r |
209 | \r | |
2654f642 | 210 | UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_LIST\r |
7936fb6a | 211 | UINT16 *ValueList;\r |
212 | \r | |
213 | EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r | |
214 | EFI_GUID Guid;\r | |
2573712e | 215 | \r |
94f3aae7 | 216 | BROWSER_STORAGE *VarStorage; // For EFI_IFR_SET, EFI_IFR_GET\r |
2573712e LG |
217 | VAR_STORE_INFO VarStoreInfo;// For EFI_IFR_SET, EFI_IFR_GET\r |
218 | UINT8 ValueType; // For EFI_IFR_SET, EFI_IFR_GET\r | |
219 | UINT8 ValueWidth; // For EFI_IFR_SET, EFI_IFR_GET\r | |
220 | CHAR16 *ValueName; // For EFI_IFR_SET, EFI_IFR_GET\r | |
221 | LIST_ENTRY MapExpressionList; // nested expressions inside of Map opcode.\r | |
7936fb6a | 222 | } EXPRESSION_OPCODE;\r |
223 | \r | |
224 | #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r | |
225 | \r | |
f3f2e05d | 226 | #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')\r |
7936fb6a | 227 | \r |
228 | typedef struct {\r | |
229 | UINTN Signature;\r | |
230 | LIST_ENTRY Link;\r | |
231 | \r | |
232 | UINT8 Type; // Type for this expression\r | |
233 | \r | |
234 | UINT8 RuleId; // For EFI_IFR_RULE only\r | |
235 | EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r | |
236 | \r | |
237 | EFI_HII_VALUE Result; // Expression evaluation result\r | |
238 | \r | |
1c0d306f | 239 | UINT8 TimeOut; // For EFI_IFR_WARNING_IF\r |
bfae1330 | 240 | EFI_IFR_OP_HEADER *OpCode; // Save the opcode buffer.\r |
1c0d306f | 241 | \r |
7936fb6a | 242 | LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)\r |
243 | } FORM_EXPRESSION;\r | |
244 | \r | |
245 | #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r | |
246 | \r | |
31585af4 ED |
247 | #define FORM_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')\r |
248 | \r | |
249 | typedef struct {\r | |
250 | UINTN Signature;\r | |
251 | UINTN Count;\r | |
252 | FORM_EXPRESSION *Expression[1]; // Array[Count] of expressions\r | |
253 | } FORM_EXPRESSION_LIST;\r | |
254 | \r | |
f3f2e05d | 255 | #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')\r |
7936fb6a | 256 | \r |
257 | typedef struct {\r | |
258 | UINTN Signature;\r | |
259 | LIST_ENTRY Link;\r | |
260 | \r | |
261 | UINT16 DefaultId;\r | |
262 | EFI_HII_VALUE Value; // Default value\r | |
263 | \r | |
264 | FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r | |
265 | } QUESTION_DEFAULT;\r | |
266 | \r | |
267 | #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r | |
268 | \r | |
f3f2e05d | 269 | #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')\r |
7936fb6a | 270 | \r |
271 | typedef struct {\r | |
31585af4 ED |
272 | UINTN Signature;\r |
273 | LIST_ENTRY Link;\r | |
d1102dba | 274 | \r |
7c6c064c | 275 | EFI_IFR_ONE_OF_OPTION *OpCode; // OneOfOption Data\r |
7936fb6a | 276 | \r |
31585af4 ED |
277 | EFI_STRING_ID Text;\r |
278 | UINT8 Flags;\r | |
279 | EFI_HII_VALUE Value;\r | |
280 | EFI_IMAGE_ID ImageId;\r | |
7936fb6a | 281 | \r |
31585af4 | 282 | FORM_EXPRESSION_LIST *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r |
7936fb6a | 283 | } QUESTION_OPTION;\r |
284 | \r | |
285 | #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r | |
286 | \r | |
31585af4 ED |
287 | typedef enum {\r |
288 | ExpressFalse = 0,\r | |
d1102dba | 289 | ExpressGrayOut,\r |
31585af4 ED |
290 | ExpressSuppress,\r |
291 | ExpressDisable\r | |
292 | } EXPRESS_RESULT;\r | |
293 | \r | |
294 | typedef enum {\r | |
295 | ExpressNone = 0,\r | |
d1102dba | 296 | ExpressForm,\r |
31585af4 ED |
297 | ExpressStatement,\r |
298 | ExpressOption\r | |
299 | } EXPRESS_LEVEL;\r | |
300 | \r | |
077c7aee ED |
301 | typedef struct _FORM_BROWSER_STATEMENT FORM_BROWSER_STATEMENT;\r |
302 | \r | |
f3f2e05d | 303 | #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')\r |
1ccdbf2a | 304 | \r |
077c7aee | 305 | struct _FORM_BROWSER_STATEMENT{\r |
7936fb6a | 306 | UINTN Signature;\r |
307 | LIST_ENTRY Link;\r | |
308 | \r | |
309 | UINT8 Operand; // The operand (first byte) of this Statement or Question\r | |
7c6c064c | 310 | EFI_IFR_OP_HEADER *OpCode;\r |
7936fb6a | 311 | \r |
312 | //\r | |
313 | // Statement Header\r | |
314 | //\r | |
315 | EFI_STRING_ID Prompt;\r | |
316 | EFI_STRING_ID Help;\r | |
317 | EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT\r | |
318 | \r | |
7c6c064c ED |
319 | //\r |
320 | // Fake Question Id, used for statement not has true QuestionId.\r | |
321 | //\r | |
322 | EFI_QUESTION_ID FakeQuestionId;\r | |
323 | \r | |
7936fb6a | 324 | //\r |
325 | // Question Header\r | |
326 | //\r | |
327 | EFI_QUESTION_ID QuestionId; // The value of zero is reserved\r | |
328 | EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage\r | |
94f3aae7 | 329 | BROWSER_STORAGE *Storage;\r |
1ccdbf2a | 330 | VAR_STORE_INFO VarStoreInfo;\r |
7936fb6a | 331 | UINT16 StorageWidth;\r |
560a435d DB |
332 | UINT16 BitStorageWidth;\r |
333 | UINT16 BitVarOffset;\r | |
7936fb6a | 334 | UINT8 QuestionFlags;\r |
560a435d | 335 | BOOLEAN QuestionReferToBitField;// Whether the question is stored in a bit field.\r |
7936fb6a | 336 | CHAR16 *VariableName; // Name/Value or EFI Variable name\r |
337 | CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."\r | |
338 | \r | |
339 | EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof\r | |
340 | UINT8 *BufferValue; // Edit copy for string, password, orderedlist\r | |
d02847d3 | 341 | UINT8 ValueType; // Data type for orderedlist value array\r |
7936fb6a | 342 | \r |
343 | //\r | |
344 | // OpCode specific members\r | |
345 | //\r | |
346 | UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r | |
347 | // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r | |
348 | UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST\r | |
349 | \r | |
350 | UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r | |
351 | EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r | |
352 | \r | |
353 | UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r | |
354 | UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r | |
355 | UINT64 Step;\r | |
356 | \r | |
357 | EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON\r | |
211cc6e5 | 358 | EFI_GUID RefreshGuid; // for EFI_IFR_REFRESH_ID\r |
f67c4382 | 359 | BOOLEAN Locked; // Whether this statement is locked.\r |
7c6c064c | 360 | BOOLEAN ValueChanged; // Whether this statement's value is changed.\r |
7936fb6a | 361 | //\r |
362 | // Get from IFR parsing\r | |
363 | //\r | |
364 | FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r | |
365 | LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r | |
366 | LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r | |
367 | \r | |
368 | EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE\r | |
369 | UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r | |
077c7aee ED |
370 | \r |
371 | FORM_BROWSER_STATEMENT *ParentStatement;\r | |
7936fb6a | 372 | \r |
373 | LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r | |
374 | LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)\r | |
1c0d306f | 375 | LIST_ENTRY WarningListHead; // nested warning expression list (FORM_EXPRESSION)\r |
31585af4 | 376 | FORM_EXPRESSION_LIST *Expression; // nesting inside of GrayOutIf/DisableIf/SuppressIf\r |
7936fb6a | 377 | \r |
2573712e LG |
378 | FORM_EXPRESSION *ReadExpression; // nested EFI_IFR_READ, provide this question value by read expression.\r |
379 | FORM_EXPRESSION *WriteExpression; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.\r | |
077c7aee | 380 | };\r |
7936fb6a | 381 | \r |
382 | #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r | |
383 | \r | |
b18e7050 ED |
384 | #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')\r |
385 | typedef struct {\r | |
386 | UINTN Signature;\r | |
387 | LIST_ENTRY Link;\r | |
388 | \r | |
4d4deaac ED |
389 | LIST_ENTRY SaveFailLink;\r |
390 | \r | |
b18e7050 | 391 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r |
7a9612ce | 392 | CHAR16 *ConfigAltResp; // Alt config response string for this ConfigRequest.\r |
d1102dba | 393 | UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r |
b18e7050 | 394 | UINTN SpareStrLen;\r |
8066b27e DB |
395 | CHAR16 *RestoreConfigRequest; // When submit form fail, the element need to be restored\r |
396 | CHAR16 *SyncConfigRequest; // When submit form fail, the element need to be synced\r | |
b18e7050 | 397 | \r |
94f3aae7 | 398 | BROWSER_STORAGE *Storage;\r |
b18e7050 ED |
399 | } FORM_BROWSER_CONFIG_REQUEST;\r |
400 | #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)\r | |
4d4deaac | 401 | #define FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, SaveFailLink, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)\r |
b18e7050 | 402 | \r |
f3f2e05d | 403 | #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')\r |
2573712e | 404 | #define STANDARD_MAP_FORM_TYPE 0x01\r |
7936fb6a | 405 | \r |
406 | typedef struct {\r | |
31585af4 ED |
407 | UINTN Signature;\r |
408 | LIST_ENTRY Link;\r | |
7936fb6a | 409 | \r |
31585af4 ED |
410 | UINT16 FormId; // FormId of normal form or formmap form.\r |
411 | EFI_STRING_ID FormTitle; // FormTile of normal form, or FormMapMethod title of formmap form.\r | |
412 | UINT16 FormType; // Specific form type for the different form.\r | |
7936fb6a | 413 | \r |
31585af4 | 414 | EFI_IMAGE_ID ImageId;\r |
7936fb6a | 415 | \r |
31585af4 ED |
416 | BOOLEAN ModalForm; // Whether this is a modal form.\r |
417 | BOOLEAN Locked; // Whether this form is locked.\r | |
790447b2 | 418 | EFI_GUID RefreshGuid; // Form refresh event guid.\r |
b00964a9 | 419 | \r |
4d4deaac | 420 | LIST_ENTRY FormViewListHead; // List of type FORMID_INFO is Browser View Form History List.\r |
31585af4 ED |
421 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r |
422 | LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r | |
423 | LIST_ENTRY ConfigRequestHead; // List of configreques for all storage.\r | |
424 | FORM_EXPRESSION_LIST *SuppressExpression; // nesting inside of SuppressIf\r | |
7936fb6a | 425 | } FORM_BROWSER_FORM;\r |
426 | \r | |
427 | #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r | |
428 | \r | |
f3f2e05d | 429 | #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')\r |
7936fb6a | 430 | \r |
431 | typedef struct {\r | |
432 | UINTN Signature;\r | |
433 | LIST_ENTRY Link;\r | |
434 | \r | |
435 | UINT16 DefaultId;\r | |
436 | EFI_STRING_ID DefaultName;\r | |
437 | } FORMSET_DEFAULTSTORE;\r | |
438 | \r | |
439 | #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r | |
440 | \r | |
48a9d5f7 LG |
441 | #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')\r |
442 | \r | |
7936fb6a | 443 | typedef struct {\r |
48a9d5f7 LG |
444 | UINTN Signature;\r |
445 | LIST_ENTRY Link;\r | |
4d4deaac ED |
446 | LIST_ENTRY SaveFailLink;\r |
447 | \r | |
48a9d5f7 | 448 | EFI_HII_HANDLE HiiHandle; // unique id for formset.\r |
7936fb6a | 449 | EFI_HANDLE DriverHandle;\r |
450 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
451 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
452 | \r | |
453 | UINTN IfrBinaryLength;\r | |
454 | UINT8 *IfrBinaryData;\r | |
455 | \r | |
7c6c064c | 456 | BOOLEAN QuestionInited; // Have finished question initilization?\r |
7936fb6a | 457 | EFI_GUID Guid;\r |
458 | EFI_STRING_ID FormSetTitle;\r | |
459 | EFI_STRING_ID Help;\r | |
0a1147ed LG |
460 | UINT8 NumberOfClassGuid;\r |
461 | EFI_GUID ClassGuid[3]; // Up to three ClassGuid\r | |
462 | UINT16 Class; // Tiano extended Class code\r | |
463 | UINT16 SubClass; // Tiano extended Subclass code\r | |
7936fb6a | 464 | EFI_IMAGE_ID ImageId;\r |
5e30b69e | 465 | EFI_IFR_OP_HEADER *OpCode; //mainly for formset op to get ClassGuid\r |
7936fb6a | 466 | \r |
467 | FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r | |
468 | EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r | |
4d4deaac ED |
469 | FORM_BROWSER_FORM *SaveFailForm; // The form which failed to save.\r |
470 | FORM_BROWSER_STATEMENT *SaveFailStatement; // The Statement which failed to save.\r | |
7936fb6a | 471 | \r |
7c6c064c | 472 | LIST_ENTRY StatementListOSF; // Statement list out side of the form.\r |
7936fb6a | 473 | LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r |
4d4deaac | 474 | LIST_ENTRY SaveFailStorageListHead; // Storage list for the save fail storage.\r |
7936fb6a | 475 | LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r |
476 | LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r | |
0c66bc76 | 477 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r |
7936fb6a | 478 | } FORM_BROWSER_FORMSET;\r |
25361615 | 479 | #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)\r |
b9feb4bd | 480 | \r |
4d4deaac ED |
481 | #define FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK(a) CR (a, FORM_BROWSER_FORMSET, SaveFailLink, FORM_BROWSER_FORMSET_SIGNATURE)\r |
482 | \r | |
7c6c064c ED |
483 | typedef struct {\r |
484 | LIST_ENTRY Link;\r | |
485 | EFI_EVENT RefreshEvent;\r | |
486 | } FORM_BROWSER_REFRESH_EVENT_NODE;\r | |
487 | \r | |
488 | #define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a) BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)\r | |
489 | \r | |
b9feb4bd | 490 | \r |
48a9d5f7 | 491 | typedef struct {\r |
7c6c064c | 492 | EFI_HII_HANDLE Handle;\r |
48a9d5f7 | 493 | \r |
7c6c064c ED |
494 | //\r |
495 | // Target formset/form/Question information\r | |
496 | //\r | |
497 | EFI_GUID FormSetGuid;\r | |
498 | UINT16 FormId;\r | |
499 | UINT16 QuestionId;\r | |
500 | UINTN Sequence; // used for time/date only.\r | |
501 | \r | |
502 | UINTN TopRow;\r | |
503 | UINTN BottomRow;\r | |
504 | UINTN PromptCol;\r | |
505 | UINTN OptionCol;\r | |
506 | UINTN CurrentRow;\r | |
507 | \r | |
508 | //\r | |
509 | // Ation for Browser to taken:\r | |
510 | // UI_ACTION_NONE - navigation inside a form\r | |
511 | // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form\r | |
512 | // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary\r | |
513 | //\r | |
514 | UINTN Action;\r | |
515 | \r | |
516 | //\r | |
517 | // Current selected fomset/form/Question\r | |
518 | //\r | |
519 | FORM_BROWSER_FORMSET *FormSet;\r | |
520 | FORM_BROWSER_FORM *Form;\r | |
521 | FORM_BROWSER_STATEMENT *Statement;\r | |
522 | \r | |
523 | //\r | |
524 | // Whether the Form is editable\r | |
525 | //\r | |
526 | BOOLEAN FormEditable;\r | |
527 | \r | |
528 | FORM_ENTRY_INFO *CurrentMenu;\r | |
529 | } UI_MENU_SELECTION;\r | |
48a9d5f7 | 530 | \r |
5a9f73bf ED |
531 | #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')\r |
532 | \r | |
533 | typedef struct {\r | |
534 | UINTN Signature;\r | |
535 | LIST_ENTRY Link;\r | |
536 | \r | |
537 | //\r | |
538 | // Globals defined in Setup.c\r | |
539 | //\r | |
f2e7732e ED |
540 | BOOLEAN FlagReconnect;\r |
541 | BOOLEAN CallbackReconnect;\r | |
5a9f73bf ED |
542 | BOOLEAN ResetRequired;\r |
543 | BOOLEAN ExitRequired;\r | |
544 | EFI_HII_HANDLE HiiHandle;\r | |
545 | EFI_GUID FormSetGuid;\r | |
546 | EFI_FORM_ID FormId;\r | |
547 | UI_MENU_SELECTION *Selection;\r | |
f4c3c923 ED |
548 | FORM_BROWSER_FORMSET *SystemLevelFormSet;\r |
549 | EFI_QUESTION_ID CurFakeQestId;\r | |
550 | BOOLEAN HiiPackageListUpdated;\r | |
551 | BOOLEAN FinishRetrieveCall;\r | |
b6f61255 ED |
552 | LIST_ENTRY FormHistoryList;\r |
553 | LIST_ENTRY FormSetList;\r | |
5a9f73bf ED |
554 | } BROWSER_CONTEXT;\r |
555 | \r | |
556 | #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)\r | |
557 | \r | |
09cdd7d2 ED |
558 | //\r |
559 | // Scope for get defaut value. It may be GetDefaultForNoStorage, GetDefaultForStorage or GetDefaultForAll.\r | |
560 | //\r | |
561 | typedef enum {\r | |
562 | GetDefaultForNoStorage, // Get default value for question which not has storage.\r | |
563 | GetDefaultForStorage, // Get default value for question which has storage.\r | |
564 | GetDefaultForAll, // Get default value for all questions.\r | |
565 | GetDefaultForMax // Invalid value.\r | |
566 | } BROWSER_GET_DEFAULT_VALUE;\r | |
567 | \r | |
816a7110 ED |
568 | //\r |
569 | // Get/set question value from/to.\r | |
570 | //\r | |
571 | typedef enum {\r | |
4d4deaac | 572 | GetSetValueWithEditBuffer = 0, // Get/Set question value from/to editbuffer in the storage.\r |
816a7110 ED |
573 | GetSetValueWithBuffer, // Get/Set question value from/to buffer in the storage.\r |
574 | GetSetValueWithHiiDriver, // Get/Set question value from/to hii driver.\r | |
4d4deaac | 575 | GetSetValueWithBothBuffer, // Compare the editbuffer with buffer for this question, not use the question value.\r |
816a7110 ED |
576 | GetSetValueWithMax // Invalid value.\r |
577 | } GET_SET_QUESTION_VALUE_WITH;\r | |
578 | \r | |
7936fb6a | 579 | extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r |
7936fb6a | 580 | extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;\r |
80a047f0 | 581 | extern EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *mPathFromText;\r |
7c6c064c | 582 | extern EDKII_FORM_DISPLAY_ENGINE_PROTOCOL *mFormDisplay;\r |
7936fb6a | 583 | \r |
f2e7732e ED |
584 | extern BOOLEAN gCallbackReconnect;\r |
585 | extern BOOLEAN gFlagReconnect;\r | |
b2dcae4c BD |
586 | extern BOOLEAN gResetRequiredFormLevel;\r |
587 | extern BOOLEAN gResetRequiredSystemLevel;\r | |
7c6c064c | 588 | extern BOOLEAN gExitRequired;\r |
48a9d5f7 LG |
589 | extern LIST_ENTRY gBrowserFormSetList;\r |
590 | extern LIST_ENTRY gBrowserHotKeyList;\r | |
591 | extern BROWSER_SETTING_SCOPE gBrowserSettingScope;\r | |
592 | extern EXIT_HANDLER ExitHandlerFunction;\r | |
7c6c064c | 593 | extern EFI_HII_HANDLE mCurrentHiiHandle;\r |
184f3a02 | 594 | extern SETUP_DRIVER_PRIVATE_DATA mPrivateData;\r |
7936fb6a | 595 | //\r |
596 | // Browser Global Strings\r | |
597 | //\r | |
7936fb6a | 598 | extern CHAR16 *gEmptyString;\r |
7936fb6a | 599 | \r |
7c6c064c | 600 | extern UI_MENU_SELECTION *gCurrentSelection;\r |
f4c3c923 ED |
601 | extern BOOLEAN mHiiPackageListUpdated;\r |
602 | extern UINT16 mCurFakeQestId;\r | |
603 | extern BOOLEAN mFinishRetrieveCall;\r | |
7c6c064c | 604 | \r |
7936fb6a | 605 | //\r |
606 | // Global Procedure Defines\r | |
607 | //\r | |
7c6c064c | 608 | #include "Expression.h"\r |
7936fb6a | 609 | \r |
610 | /**\r | |
611 | Initialize the HII String Token to the correct values.\r | |
612 | \r | |
613 | **/\r | |
614 | VOID\r | |
615 | InitializeBrowserStrings (\r | |
616 | VOID\r | |
ed66e1bc | 617 | );\r |
7936fb6a | 618 | \r |
7936fb6a | 619 | /**\r |
620 | Parse opcodes in the formset IFR binary.\r | |
621 | \r | |
622 | @param FormSet Pointer of the FormSet data structure.\r | |
623 | \r | |
624 | @retval EFI_SUCCESS Opcode parse success.\r | |
625 | @retval Other Opcode parse fail.\r | |
626 | \r | |
627 | **/\r | |
628 | EFI_STATUS\r | |
629 | ParseOpCodes (\r | |
630 | IN FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 631 | );\r |
7936fb6a | 632 | \r |
633 | /**\r | |
634 | Free resources allocated for a FormSet.\r | |
635 | \r | |
636 | @param FormSet Pointer of the FormSet\r | |
637 | \r | |
638 | **/\r | |
639 | VOID\r | |
640 | DestroyFormSet (\r | |
641 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 642 | );\r |
7936fb6a | 643 | \r |
7936fb6a | 644 | \r |
645 | /**\r | |
646 | Create a new string in HII Package List.\r | |
647 | \r | |
648 | @param String The String to be added\r | |
649 | @param HiiHandle The package list in the HII database to insert the\r | |
650 | specified string.\r | |
651 | \r | |
652 | @return The output string.\r | |
653 | \r | |
654 | **/\r | |
655 | EFI_STRING_ID\r | |
656 | NewString (\r | |
657 | IN CHAR16 *String,\r | |
658 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 659 | );\r |
7936fb6a | 660 | \r |
661 | /**\r | |
662 | Delete a string from HII Package List.\r | |
663 | \r | |
664 | @param StringId Id of the string in HII database.\r | |
665 | @param HiiHandle The HII package list handle.\r | |
666 | \r | |
667 | @retval EFI_SUCCESS The string was deleted successfully.\r | |
668 | \r | |
669 | **/\r | |
670 | EFI_STATUS\r | |
671 | DeleteString (\r | |
672 | IN EFI_STRING_ID StringId,\r | |
673 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 674 | );\r |
7936fb6a | 675 | \r |
676 | /**\r | |
677 | Get the string based on the StringId and HII Package List Handle.\r | |
678 | \r | |
679 | @param Token The String's ID.\r | |
680 | @param HiiHandle The package list in the HII database to search for\r | |
681 | the specified string.\r | |
682 | \r | |
683 | @return The output string.\r | |
684 | \r | |
685 | **/\r | |
686 | CHAR16 *\r | |
687 | GetToken (\r | |
688 | IN EFI_STRING_ID Token,\r | |
689 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 690 | );\r |
7936fb6a | 691 | \r |
2573712e LG |
692 | /**\r |
693 | Get Value for given Name from a NameValue Storage.\r | |
694 | \r | |
695 | @param Storage The NameValue Storage.\r | |
696 | @param Name The Name.\r | |
697 | @param Value The retured Value.\r | |
816a7110 | 698 | @param GetValueFrom Where to get source value, from EditValue or Value.\r |
2573712e LG |
699 | \r |
700 | @retval EFI_SUCCESS Value found for given Name.\r | |
701 | @retval EFI_NOT_FOUND No such Name found in NameValue storage.\r | |
702 | \r | |
703 | **/\r | |
704 | EFI_STATUS\r | |
705 | GetValueByName (\r | |
94f3aae7 | 706 | IN BROWSER_STORAGE *Storage,\r |
816a7110 ED |
707 | IN CHAR16 *Name,\r |
708 | IN OUT CHAR16 **Value,\r | |
709 | IN GET_SET_QUESTION_VALUE_WITH GetValueFrom\r | |
2573712e LG |
710 | );\r |
711 | \r | |
712 | /**\r | |
713 | Set Value of given Name in a NameValue Storage.\r | |
714 | \r | |
715 | @param Storage The NameValue Storage.\r | |
716 | @param Name The Name.\r | |
717 | @param Value The Value to set.\r | |
816a7110 | 718 | @param SetValueTo Whether update editValue or Value.\r |
7c6c064c | 719 | @param ReturnNode The node use the input name.\r |
2573712e LG |
720 | \r |
721 | @retval EFI_SUCCESS Value found for given Name.\r | |
722 | @retval EFI_NOT_FOUND No such Name found in NameValue storage.\r | |
723 | \r | |
724 | **/\r | |
725 | EFI_STATUS\r | |
726 | SetValueByName (\r | |
7c6c064c ED |
727 | IN BROWSER_STORAGE *Storage,\r |
728 | IN CHAR16 *Name,\r | |
729 | IN CHAR16 *Value,\r | |
730 | IN GET_SET_QUESTION_VALUE_WITH SetValueTo,\r | |
731 | OUT NAME_VALUE_NODE **ReturnNode\r | |
732 | );\r | |
733 | \r | |
734 | /**\r | |
735 | Validate whether this question's value has changed.\r | |
736 | \r | |
737 | @param FormSet FormSet data structure.\r | |
738 | @param Form Form data structure.\r | |
739 | @param Question Question to be initialized.\r | |
740 | @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.\r | |
741 | \r | |
742 | @retval TRUE Question's value has changed.\r | |
743 | @retval FALSE Question's value has not changed\r | |
744 | \r | |
745 | **/\r | |
746 | BOOLEAN\r | |
747 | IsQuestionValueChanged (\r | |
748 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
749 | IN FORM_BROWSER_FORM *Form,\r | |
750 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
751 | IN GET_SET_QUESTION_VALUE_WITH GetValueFrom\r | |
2573712e LG |
752 | );\r |
753 | \r | |
892eccc8 ED |
754 | /**\r |
755 | Validate the FormSet. If the formset is not validate, remove it from the list.\r | |
756 | \r | |
757 | @param FormSet The input FormSet which need to validate.\r | |
758 | \r | |
759 | @retval TRUE The handle is validate.\r | |
760 | @retval FALSE The handle is invalidate.\r | |
761 | \r | |
762 | **/\r | |
763 | BOOLEAN\r | |
764 | ValidateFormSet (\r | |
765 | FORM_BROWSER_FORMSET *FormSet\r | |
766 | );\r | |
767 | \r | |
768 | /**\r | |
769 | Update the ValueChanged status for questions.\r | |
770 | \r | |
771 | @param FormSet FormSet data structure.\r | |
772 | @param Form Form data structure.\r | |
773 | @param SettingScope Setting Scope for Default action.\r | |
774 | \r | |
775 | **/\r | |
d1102dba | 776 | VOID\r |
892eccc8 ED |
777 | UpdateStatementStatus (\r |
778 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
d1102dba | 779 | IN FORM_BROWSER_FORM *Form,\r |
892eccc8 ED |
780 | IN BROWSER_SETTING_SCOPE SettingScope\r |
781 | );\r | |
782 | \r | |
7936fb6a | 783 | /**\r |
784 | Get Question's current Value.\r | |
785 | \r | |
786 | @param FormSet FormSet data structure.\r | |
787 | @param Form Form data structure.\r | |
788 | @param Question Question to be initialized.\r | |
816a7110 | 789 | @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.\r |
7936fb6a | 790 | \r |
791 | @retval EFI_SUCCESS The function completed successfully.\r | |
792 | \r | |
793 | **/\r | |
794 | EFI_STATUS\r | |
795 | GetQuestionValue (\r | |
796 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
797 | IN FORM_BROWSER_FORM *Form,\r | |
798 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
816a7110 | 799 | IN GET_SET_QUESTION_VALUE_WITH GetValueFrom\r |
ed66e1bc | 800 | );\r |
7936fb6a | 801 | \r |
802 | /**\r | |
803 | Save Question Value to edit copy(cached) or Storage(uncached).\r | |
804 | \r | |
805 | @param FormSet FormSet data structure.\r | |
806 | @param Form Form data structure.\r | |
807 | @param Question Pointer to the Question.\r | |
816a7110 | 808 | @param SetValueTo Update the question value to editbuffer , buffer or hii driver.\r |
7936fb6a | 809 | \r |
810 | @retval EFI_SUCCESS The function completed successfully.\r | |
811 | \r | |
812 | **/\r | |
813 | EFI_STATUS\r | |
814 | SetQuestionValue (\r | |
815 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
816 | IN FORM_BROWSER_FORM *Form,\r | |
817 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
816a7110 | 818 | IN GET_SET_QUESTION_VALUE_WITH SetValueTo\r |
ed66e1bc | 819 | );\r |
7936fb6a | 820 | \r |
821 | /**\r | |
822 | Perform inconsistent check for a Form.\r | |
823 | \r | |
824 | @param FormSet FormSet data structure.\r | |
825 | @param Form Form data structure.\r | |
826 | @param Question The Question to be validated.\r | |
827 | @param Type Validation type: InConsistent or NoSubmit\r | |
828 | \r | |
829 | @retval EFI_SUCCESS Form validation pass.\r | |
830 | @retval other Form validation failed.\r | |
831 | \r | |
832 | **/\r | |
833 | EFI_STATUS\r | |
834 | ValidateQuestion (\r | |
835 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
836 | IN FORM_BROWSER_FORM *Form,\r | |
837 | IN FORM_BROWSER_STATEMENT *Question,\r | |
838 | IN UINTN Type\r | |
ed66e1bc | 839 | );\r |
7936fb6a | 840 | \r |
48a9d5f7 | 841 | \r |
7936fb6a | 842 | /**\r |
48a9d5f7 | 843 | Discard data based on the input setting scope (Form, FormSet or System).\r |
7936fb6a | 844 | \r |
845 | @param FormSet FormSet data structure.\r | |
846 | @param Form Form data structure.\r | |
48a9d5f7 | 847 | @param SettingScope Setting Scope for Discard action.\r |
b18e7050 ED |
848 | \r |
849 | @retval EFI_SUCCESS The function completed successfully.\r | |
48a9d5f7 | 850 | @retval EFI_UNSUPPORTED Unsupport SettingScope.\r |
b18e7050 ED |
851 | \r |
852 | **/\r | |
853 | EFI_STATUS\r | |
854 | DiscardForm (\r | |
855 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
856 | IN FORM_BROWSER_FORM *Form,\r | |
48a9d5f7 | 857 | IN BROWSER_SETTING_SCOPE SettingScope\r |
b18e7050 ED |
858 | );\r |
859 | \r | |
860 | /**\r | |
48a9d5f7 | 861 | Submit data based on the input Setting level (Form, FormSet or System).\r |
b18e7050 ED |
862 | \r |
863 | @param FormSet FormSet data structure.\r | |
864 | @param Form Form data structure.\r | |
48a9d5f7 | 865 | @param SettingScope Setting Scope for Submit action.\r |
7936fb6a | 866 | \r |
867 | @retval EFI_SUCCESS The function completed successfully.\r | |
48a9d5f7 | 868 | @retval EFI_UNSUPPORTED Unsupport SettingScope.\r |
7936fb6a | 869 | \r |
870 | **/\r | |
871 | EFI_STATUS\r | |
872 | SubmitForm (\r | |
873 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
b18e7050 | 874 | IN FORM_BROWSER_FORM *Form,\r |
48a9d5f7 | 875 | IN BROWSER_SETTING_SCOPE SettingScope\r |
ed66e1bc | 876 | );\r |
7936fb6a | 877 | \r |
878 | /**\r | |
879 | Reset Question to its default value.\r | |
880 | \r | |
881 | @param FormSet The form set.\r | |
882 | @param Form The form.\r | |
883 | @param Question The question.\r | |
884 | @param DefaultId The Class of the default.\r | |
885 | \r | |
886 | @retval EFI_SUCCESS Question is reset to default value.\r | |
887 | \r | |
888 | **/\r | |
889 | EFI_STATUS\r | |
890 | GetQuestionDefault (\r | |
891 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
892 | IN FORM_BROWSER_FORM *Form,\r | |
893 | IN FORM_BROWSER_STATEMENT *Question,\r | |
894 | IN UINT16 DefaultId\r | |
ed66e1bc | 895 | );\r |
7936fb6a | 896 | \r |
897 | /**\r | |
898 | Get current setting of Questions.\r | |
899 | \r | |
900 | @param FormSet FormSet data structure.\r | |
901 | \r | |
7936fb6a | 902 | **/\r |
7c6c064c | 903 | VOID\r |
7936fb6a | 904 | InitializeCurrentSetting (\r |
905 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 906 | );\r |
7936fb6a | 907 | \r |
908 | /**\r | |
909 | Initialize the internal data structure of a FormSet.\r | |
910 | \r | |
911 | @param Handle PackageList Handle\r | |
912 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
913 | GUID), take the first FormSet found in package\r | |
914 | list.\r | |
915 | @param FormSet FormSet data structure.\r | |
916 | \r | |
917 | @retval EFI_SUCCESS The function completed successfully.\r | |
918 | @retval EFI_NOT_FOUND The specified FormSet could not be found.\r | |
919 | \r | |
920 | **/\r | |
921 | EFI_STATUS\r | |
922 | InitializeFormSet (\r | |
923 | IN EFI_HII_HANDLE Handle,\r | |
924 | IN OUT EFI_GUID *FormSetGuid,\r | |
d1102dba | 925 | OUT FORM_BROWSER_FORMSET *FormSet\r |
ed66e1bc | 926 | );\r |
7936fb6a | 927 | \r |
928 | /**\r | |
9776099f | 929 | Reset Questions to their initial value or default value in a Form, Formset or System.\r |
7936fb6a | 930 | \r |
d1102dba | 931 | GetDefaultValueScope parameter decides which questions will reset\r |
09cdd7d2 ED |
932 | to its default value.\r |
933 | \r | |
7936fb6a | 934 | @param FormSet FormSet data structure.\r |
48a9d5f7 | 935 | @param Form Form data structure.\r |
7936fb6a | 936 | @param DefaultId The Class of the default.\r |
48a9d5f7 | 937 | @param SettingScope Setting Scope for Default action.\r |
09cdd7d2 | 938 | @param GetDefaultValueScope Get default value scope.\r |
3347d410 | 939 | @param Storage Get default value only for this storage.\r |
9776099f ED |
940 | @param RetrieveValueFirst Whether call the retrieve call back to\r |
941 | get the initial value before get default\r | |
942 | value.\r | |
787fc2a6 | 943 | @param SkipGetAltCfg Whether skip the get altcfg string process.\r |
7936fb6a | 944 | \r |
945 | @retval EFI_SUCCESS The function completed successfully.\r | |
48a9d5f7 | 946 | @retval EFI_UNSUPPORTED Unsupport SettingScope.\r |
7936fb6a | 947 | \r |
948 | **/\r | |
949 | EFI_STATUS\r | |
48a9d5f7 | 950 | ExtractDefault (\r |
7936fb6a | 951 | IN FORM_BROWSER_FORMSET *FormSet,\r |
48a9d5f7 LG |
952 | IN FORM_BROWSER_FORM *Form,\r |
953 | IN UINT16 DefaultId,\r | |
3347d410 | 954 | IN BROWSER_SETTING_SCOPE SettingScope,\r |
09cdd7d2 | 955 | IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope,\r |
94f3aae7 | 956 | IN BROWSER_STORAGE *Storage,\r |
787fc2a6 ED |
957 | IN BOOLEAN RetrieveValueFirst,\r |
958 | IN BOOLEAN SkipGetAltCfg\r | |
ed66e1bc | 959 | );\r |
7936fb6a | 960 | \r |
961 | /**\r | |
962 | Initialize Question's Edit copy from Storage.\r | |
963 | \r | |
d1102dba | 964 | @param Selection Selection contains the information about\r |
eccfeab1 LG |
965 | the Selection, form and formset to be displayed.\r |
966 | Selection action may be updated in retrieve callback.\r | |
7d1b202d | 967 | If Selection is NULL, only initialize Question value.\r |
7936fb6a | 968 | @param FormSet FormSet data structure.\r |
969 | @param Form Form data structure.\r | |
970 | \r | |
971 | @retval EFI_SUCCESS The function completed successfully.\r | |
972 | \r | |
973 | **/\r | |
974 | EFI_STATUS\r | |
975 | LoadFormConfig (\r | |
eccfeab1 LG |
976 | IN OUT UI_MENU_SELECTION *Selection,\r |
977 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
978 | IN FORM_BROWSER_FORM *Form\r | |
ed66e1bc | 979 | );\r |
7936fb6a | 980 | \r |
d66e6c16 | 981 | /**\r |
982 | Initialize Question's Edit copy from Storage for the whole Formset.\r | |
983 | \r | |
d1102dba | 984 | @param Selection Selection contains the information about\r |
eccfeab1 LG |
985 | the Selection, form and formset to be displayed.\r |
986 | Selection action may be updated in retrieve callback.\r | |
7d1b202d | 987 | If Selection is NULL, only initialize Question value.\r |
d66e6c16 | 988 | @param FormSet FormSet data structure.\r |
989 | \r | |
990 | @retval EFI_SUCCESS The function completed successfully.\r | |
991 | \r | |
992 | **/\r | |
993 | EFI_STATUS\r | |
994 | LoadFormSetConfig (\r | |
eccfeab1 LG |
995 | IN OUT UI_MENU_SELECTION *Selection,\r |
996 | IN FORM_BROWSER_FORMSET *FormSet\r | |
d66e6c16 | 997 | );\r |
998 | \r | |
7936fb6a | 999 | /**\r |
1000 | Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.\r | |
1001 | \r | |
94f3aae7 | 1002 | @param Storage The Storage to be conveted.\r |
7936fb6a | 1003 | @param ConfigResp The returned <ConfigResp>.\r |
94f3aae7 | 1004 | @param ConfigRequest The ConfigRequest string.\r |
7c6c064c | 1005 | @param GetEditBuf Get the data from editbuffer or buffer.\r |
7936fb6a | 1006 | \r |
1007 | @retval EFI_SUCCESS Convert success.\r | |
1008 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
1009 | \r | |
1010 | **/\r | |
1011 | EFI_STATUS\r | |
1012 | StorageToConfigResp (\r | |
94f3aae7 | 1013 | IN BROWSER_STORAGE *Storage,\r |
b18e7050 | 1014 | IN CHAR16 **ConfigResp,\r |
7c6c064c ED |
1015 | IN CHAR16 *ConfigRequest,\r |
1016 | IN BOOLEAN GetEditBuf\r | |
ed66e1bc | 1017 | );\r |
7936fb6a | 1018 | \r |
1019 | /**\r | |
1020 | Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.\r | |
1021 | \r | |
1022 | @param Storage The Storage to receive the settings.\r | |
1023 | @param ConfigResp The <ConfigResp> to be converted.\r | |
1024 | \r | |
1025 | @retval EFI_SUCCESS Convert success.\r | |
1026 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
1027 | \r | |
1028 | **/\r | |
1029 | EFI_STATUS\r | |
1030 | ConfigRespToStorage (\r | |
94f3aae7 | 1031 | IN BROWSER_STORAGE *Storage,\r |
7936fb6a | 1032 | IN CHAR16 *ConfigResp\r |
ed66e1bc | 1033 | );\r |
7936fb6a | 1034 | \r |
1035 | /**\r | |
1036 | Fill storage's edit copy with settings requested from Configuration Driver.\r | |
1037 | \r | |
1038 | @param FormSet FormSet data structure.\r | |
1039 | @param Storage Buffer Storage.\r | |
1040 | \r | |
7936fb6a | 1041 | **/\r |
7c6c064c | 1042 | VOID\r |
7936fb6a | 1043 | LoadStorage (\r |
1044 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
1045 | IN FORMSET_STORAGE *Storage\r | |
ed66e1bc | 1046 | );\r |
7936fb6a | 1047 | \r |
1048 | /**\r | |
1049 | Fetch the Ifr binary data of a FormSet.\r | |
1050 | \r | |
1051 | @param Handle PackageList Handle\r | |
1052 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
1053 | GUID), take the first FormSet found in package\r | |
1054 | list.\r | |
1055 | @param BinaryLength The length of the FormSet IFR binary.\r | |
1056 | @param BinaryData The buffer designed to receive the FormSet.\r | |
1057 | \r | |
1058 | @retval EFI_SUCCESS Buffer filled with the requested FormSet.\r | |
1059 | BufferLength was updated.\r | |
1060 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
1061 | @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot\r | |
1062 | be found with the requested FormId.\r | |
1063 | \r | |
1064 | **/\r | |
1065 | EFI_STATUS\r | |
1066 | GetIfrBinaryData (\r | |
1067 | IN EFI_HII_HANDLE Handle,\r | |
1068 | IN OUT EFI_GUID *FormSetGuid,\r | |
1069 | OUT UINTN *BinaryLength,\r | |
1070 | OUT UINT8 **BinaryData\r | |
ed66e1bc | 1071 | );\r |
7936fb6a | 1072 | \r |
ce6d12cc | 1073 | /**\r |
d1102dba | 1074 | Save globals used by previous call to SendForm(). SendForm() may be called from\r |
ce6d12cc | 1075 | HiiConfigAccess.Callback(), this will cause SendForm() be reentried.\r |
1076 | So, save globals of previous call to SendForm() and restore them upon exit.\r | |
1077 | \r | |
1078 | **/\r | |
1079 | VOID\r | |
1080 | SaveBrowserContext (\r | |
1081 | VOID\r | |
1082 | );\r | |
1083 | \r | |
1084 | /**\r | |
1085 | Restore globals used by previous call to SendForm().\r | |
1086 | \r | |
1087 | **/\r | |
1088 | VOID\r | |
1089 | RestoreBrowserContext (\r | |
1090 | VOID\r | |
1091 | );\r | |
1092 | \r | |
7936fb6a | 1093 | /**\r |
1094 | This is the routine which an external caller uses to direct the browser\r | |
1095 | where to obtain it's information.\r | |
1096 | \r | |
1097 | \r | |
1098 | @param This The Form Browser protocol instanse.\r | |
1099 | @param Handles A pointer to an array of Handles. If HandleCount > 1 we\r | |
1100 | display a list of the formsets for the handles specified.\r | |
1101 | @param HandleCount The number of Handles specified in Handle.\r | |
1102 | @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r | |
1103 | field in the EFI_IFR_FORM_SET op-code for the specified\r | |
1104 | forms-based package. If FormSetGuid is NULL, then this\r | |
1105 | function will display the first found forms package.\r | |
1106 | @param FormId This field specifies which EFI_IFR_FORM to render as the first\r | |
1107 | displayable page. If this field has a value of 0x0000, then\r | |
1108 | the forms browser will render the specified forms in their encoded order.\r | |
1109 | ScreenDimenions - This allows the browser to be called so that it occupies a\r | |
1110 | portion of the physical screen instead of dynamically determining the screen dimensions.\r | |
1111 | ActionRequest - Points to the action recommended by the form.\r | |
d66e6c16 | 1112 | @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r |
7936fb6a | 1113 | characters.\r |
1114 | @param ActionRequest Points to the action recommended by the form.\r | |
1115 | \r | |
1116 | @retval EFI_SUCCESS The function completed successfully.\r | |
1117 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
1118 | @retval EFI_NOT_FOUND No valid forms could be found to display.\r | |
1119 | \r | |
1120 | **/\r | |
1121 | EFI_STATUS\r | |
1122 | EFIAPI\r | |
1123 | SendForm (\r | |
1124 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
1125 | IN EFI_HII_HANDLE *Handles,\r | |
1126 | IN UINTN HandleCount,\r | |
1127 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
1128 | IN UINT16 FormId, OPTIONAL\r | |
1129 | IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r | |
1130 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r | |
ed66e1bc | 1131 | );\r |
7936fb6a | 1132 | \r |
1133 | /**\r | |
1134 | This function is called by a callback handler to retrieve uncommitted state\r | |
1135 | data from the browser.\r | |
1136 | \r | |
1137 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL\r | |
1138 | instance.\r | |
1139 | @param ResultsDataSize A pointer to the size of the buffer associated\r | |
1140 | with ResultsData.\r | |
1141 | @param ResultsData A string returned from an IFR browser or\r | |
1142 | equivalent. The results string will have no\r | |
1143 | routing information in them.\r | |
1144 | @param RetrieveData A BOOLEAN field which allows an agent to retrieve\r | |
1145 | (if RetrieveData = TRUE) data from the uncommitted\r | |
1146 | browser state information or set (if RetrieveData\r | |
1147 | = FALSE) data in the uncommitted browser state\r | |
1148 | information.\r | |
1149 | @param VariableGuid An optional field to indicate the target variable\r | |
1150 | GUID name to use.\r | |
1151 | @param VariableName An optional field to indicate the target\r | |
1152 | human-readable variable name.\r | |
1153 | \r | |
1154 | @retval EFI_SUCCESS The results have been distributed or are awaiting\r | |
1155 | distribution.\r | |
1156 | @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to\r | |
1157 | contain the results data.\r | |
1158 | \r | |
1159 | **/\r | |
1160 | EFI_STATUS\r | |
1161 | EFIAPI\r | |
1162 | BrowserCallback (\r | |
1163 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
1164 | IN OUT UINTN *ResultsDataSize,\r | |
1165 | IN OUT EFI_STRING ResultsData,\r | |
1166 | IN BOOLEAN RetrieveData,\r | |
1167 | IN CONST EFI_GUID *VariableGuid, OPTIONAL\r | |
1168 | IN CONST CHAR16 *VariableName OPTIONAL\r | |
ed66e1bc | 1169 | );\r |
7936fb6a | 1170 | \r |
b18e7050 ED |
1171 | /**\r |
1172 | Find menu which will show next time.\r | |
1173 | \r | |
1174 | @param Selection On input, Selection tell setup browser the information\r | |
1175 | about the Selection, form and formset to be displayed.\r | |
1176 | On output, Selection return the screen item that is selected\r | |
1177 | by user.\r | |
d1102dba | 1178 | @param SettingLevel Input Settting level, if it is FormLevel, just exit current form.\r |
7c6c064c | 1179 | else, we need to exit current formset.\r |
d1102dba | 1180 | \r |
7c6c064c ED |
1181 | @retval TRUE Exit current form.\r |
1182 | @retval FALSE User press ESC and keep in current form.\r | |
b18e7050 ED |
1183 | **/\r |
1184 | BOOLEAN\r | |
1185 | FindNextMenu (\r | |
7c6c064c ED |
1186 | IN OUT UI_MENU_SELECTION *Selection,\r |
1187 | IN BROWSER_SETTING_SCOPE SettingLevel\r | |
b18e7050 ED |
1188 | );\r |
1189 | \r | |
1190 | /**\r | |
7c6c064c | 1191 | check whether the form need to update the NV.\r |
b18e7050 | 1192 | \r |
7c6c064c | 1193 | @param Form Form data structure.\r |
b18e7050 | 1194 | \r |
7c6c064c ED |
1195 | @retval TRUE Need to update the NV.\r |
1196 | @retval FALSE No need to update the NV.\r | |
b18e7050 | 1197 | **/\r |
7c6c064c ED |
1198 | BOOLEAN\r |
1199 | IsNvUpdateRequiredForForm (\r | |
1200 | IN FORM_BROWSER_FORM *Form\r | |
b18e7050 ED |
1201 | );\r |
1202 | \r | |
1203 | /**\r | |
1204 | check whether the formset need to update the NV.\r | |
1205 | \r | |
1206 | @param FormSet FormSet data structure.\r | |
1207 | \r | |
1208 | @retval TRUE Need to update the NV.\r | |
1209 | @retval FALSE No need to update the NV.\r | |
1210 | **/\r | |
7c6c064c ED |
1211 | BOOLEAN\r |
1212 | IsNvUpdateRequiredForFormSet (\r | |
25361615 | 1213 | IN FORM_BROWSER_FORMSET *FormSet\r |
b9feb4bd ED |
1214 | );\r |
1215 | \r | |
b18e7050 ED |
1216 | /**\r |
1217 | Call the call back function for the question and process the return action.\r | |
1218 | \r | |
1219 | @param Selection On input, Selection tell setup browser the information\r | |
1220 | about the Selection, form and formset to be displayed.\r | |
1221 | On output, Selection return the screen item that is selected\r | |
1222 | by user.\r | |
798e4d22 ED |
1223 | @param FormSet The formset this question belong to.\r |
1224 | @param Form The form this question belong to.\r | |
1225 | @param Question The Question which need to call.\r | |
b18e7050 ED |
1226 | @param Action The action request.\r |
1227 | @param SkipSaveOrDiscard Whether skip save or discard action.\r | |
1228 | \r | |
0a18956d GL |
1229 | @retval EFI_SUCCESS The call back function executes successfully.\r |
1230 | @return Other value if the call back function failed to execute.\r | |
b18e7050 | 1231 | **/\r |
d1102dba | 1232 | EFI_STATUS\r |
b18e7050 ED |
1233 | ProcessCallBackFunction (\r |
1234 | IN OUT UI_MENU_SELECTION *Selection,\r | |
798e4d22 ED |
1235 | IN FORM_BROWSER_FORMSET *FormSet,\r |
1236 | IN FORM_BROWSER_FORM *Form,\r | |
b18e7050 ED |
1237 | IN FORM_BROWSER_STATEMENT *Question,\r |
1238 | IN EFI_BROWSER_ACTION Action,\r | |
1239 | IN BOOLEAN SkipSaveOrDiscard\r | |
1240 | );\r | |
d1102dba | 1241 | \r |
9776099f ED |
1242 | /**\r |
1243 | Call the retrieve type call back function for one question to get the initialize data.\r | |
d1102dba LG |
1244 | \r |
1245 | This function only used when in the initialize stage, because in this stage, the\r | |
9776099f ED |
1246 | Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.\r |
1247 | \r | |
1248 | @param ConfigAccess The config access protocol produced by the hii driver.\r | |
1249 | @param Statement The Question which need to call.\r | |
061d5462 | 1250 | @param FormSet The formset this question belong to.\r |
9776099f | 1251 | \r |
0a18956d GL |
1252 | @retval EFI_SUCCESS The call back function executes successfully.\r |
1253 | @return Other value if the call back function failed to execute.\r | |
9776099f | 1254 | **/\r |
d1102dba | 1255 | EFI_STATUS\r |
9776099f ED |
1256 | ProcessRetrieveForQuestion (\r |
1257 | IN EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess,\r | |
061d5462 ED |
1258 | IN FORM_BROWSER_STATEMENT *Statement,\r |
1259 | IN FORM_BROWSER_FORMSET *FormSet\r | |
9776099f | 1260 | );\r |
48a9d5f7 LG |
1261 | \r |
1262 | /**\r | |
1263 | Find the matched FormSet context in the backup maintain list based on HiiHandle.\r | |
d1102dba | 1264 | \r |
48a9d5f7 | 1265 | @param Handle The Hii Handle.\r |
d1102dba | 1266 | \r |
48a9d5f7 LG |
1267 | @return the found FormSet context. If no found, NULL will return.\r |
1268 | \r | |
1269 | **/\r | |
d1102dba | 1270 | FORM_BROWSER_FORMSET *\r |
48a9d5f7 LG |
1271 | GetFormSetFromHiiHandle (\r |
1272 | EFI_HII_HANDLE Handle\r | |
1273 | );\r | |
1274 | \r | |
1275 | /**\r | |
1276 | Check whether the input HII handle is the FormSet that is being used.\r | |
d1102dba | 1277 | \r |
48a9d5f7 | 1278 | @param Handle The Hii Handle.\r |
d1102dba | 1279 | \r |
48a9d5f7 LG |
1280 | @retval TRUE HII handle is being used.\r |
1281 | @retval FALSE HII handle is not being used.\r | |
1282 | \r | |
1283 | **/\r | |
1284 | BOOLEAN\r | |
1285 | IsHiiHandleInBrowserContext (\r | |
1286 | EFI_HII_HANDLE Handle\r | |
1287 | );\r | |
1288 | \r | |
1289 | /**\r | |
1290 | Configure what scope the hot key will impact.\r | |
1291 | All hot keys have the same scope. The mixed hot keys with the different level are not supported.\r | |
1292 | If no scope is set, the default scope will be FormSet level.\r | |
1293 | After all registered hot keys are removed, previous Scope can reset to another level.\r | |
d1102dba LG |
1294 | \r |
1295 | @param[in] Scope Scope level to be set.\r | |
1296 | \r | |
48a9d5f7 | 1297 | @retval EFI_SUCCESS Scope is set correctly.\r |
d1102dba | 1298 | @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.\r |
48a9d5f7 LG |
1299 | @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.\r |
1300 | \r | |
1301 | **/\r | |
1302 | EFI_STATUS\r | |
1303 | EFIAPI\r | |
1304 | SetScope (\r | |
1305 | IN BROWSER_SETTING_SCOPE Scope\r | |
1306 | );\r | |
1307 | \r | |
1308 | /**\r | |
1309 | Register the hot key with its browser action, or unregistered the hot key.\r | |
1310 | Only support hot key that is not printable character (control key, function key, etc.).\r | |
1311 | If the action value is zero, the hot key will be unregistered if it has been registered.\r | |
1312 | If the same hot key has been registered, the new action and help string will override the previous ones.\r | |
d1102dba | 1313 | \r |
48a9d5f7 | 1314 | @param[in] KeyData A pointer to a buffer that describes the keystroke\r |
d1102dba | 1315 | information for the hot key. Its type is EFI_INPUT_KEY to\r |
48a9d5f7 | 1316 | be supported by all ConsoleIn devices.\r |
d1102dba | 1317 | @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.\r |
48a9d5f7 LG |
1318 | @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.\r |
1319 | @param[in] HelpString Help string that describes the hot key information.\r | |
1320 | Its value may be NULL for the unregistered hot key.\r | |
d1102dba | 1321 | \r |
48a9d5f7 LG |
1322 | @retval EFI_SUCCESS Hot key is registered or unregistered.\r |
1323 | @retval EFI_INVALID_PARAMETER KeyData is NULL.\r | |
1324 | @retval EFI_NOT_FOUND KeyData is not found to be unregistered.\r | |
1325 | @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.\r | |
291422d7 | 1326 | @retval EFI_ALREADY_STARTED Key already been registered for one hot key.\r |
48a9d5f7 LG |
1327 | **/\r |
1328 | EFI_STATUS\r | |
1329 | EFIAPI\r | |
1330 | RegisterHotKey (\r | |
1331 | IN EFI_INPUT_KEY *KeyData,\r | |
1332 | IN UINT32 Action,\r | |
1333 | IN UINT16 DefaultId,\r | |
1334 | IN EFI_STRING HelpString OPTIONAL\r | |
1335 | );\r | |
1336 | \r | |
1337 | /**\r | |
d1102dba LG |
1338 | Register Exit handler function.\r |
1339 | When more than one handler function is registered, the latter one will override the previous one.\r | |
1340 | When NULL handler is specified, the previous Exit handler will be unregistered.\r | |
1341 | \r | |
1342 | @param[in] Handler Pointer to handler function.\r | |
48a9d5f7 LG |
1343 | \r |
1344 | **/\r | |
1345 | VOID\r | |
1346 | EFIAPI\r | |
1347 | RegiserExitHandler (\r | |
1348 | IN EXIT_HANDLER Handler\r | |
1349 | );\r | |
1350 | \r | |
7c6c064c | 1351 | /**\r |
d1102dba LG |
1352 | \r |
1353 | Check whether the browser data has been modified.\r | |
7c6c064c ED |
1354 | \r |
1355 | @retval TRUE Browser data is changed.\r | |
1356 | @retval FALSE No browser data is changed.\r | |
1357 | \r | |
1358 | **/\r | |
d1102dba | 1359 | BOOLEAN\r |
7c6c064c ED |
1360 | EFIAPI\r |
1361 | IsBrowserDataModified (\r | |
1362 | VOID\r | |
1363 | );\r | |
1364 | \r | |
1365 | /**\r | |
d1102dba LG |
1366 | \r |
1367 | Execute the action requested by the Action parameter.\r | |
7c6c064c ED |
1368 | \r |
1369 | @param[in] Action Execute the request action.\r | |
1370 | @param[in] DefaultId The default Id info when need to load default value.\r | |
1371 | \r | |
1372 | @retval EFI_SUCCESS Execute the request action succss.\r | |
1373 | @retval EFI_INVALID_PARAMETER The input action value is invalid.\r | |
1374 | \r | |
1375 | **/\r | |
d1102dba | 1376 | EFI_STATUS\r |
7c6c064c ED |
1377 | EFIAPI\r |
1378 | ExecuteAction (\r | |
1379 | IN UINT32 Action,\r | |
1380 | IN UINT16 DefaultId\r | |
1381 | );\r | |
1382 | \r | |
48a9d5f7 LG |
1383 | /**\r |
1384 | Create reminder to let user to choose save or discard the changed browser data.\r | |
1385 | Caller can use it to actively check the changed browser data.\r | |
1386 | \r | |
1387 | @retval BROWSER_NO_CHANGES No browser data is changed.\r | |
1388 | @retval BROWSER_SAVE_CHANGES The changed browser data is saved.\r | |
1389 | @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.\r | |
27bace9b | 1390 | @retval BROWSER_KEEP_CURRENT Browser keep current changes.\r |
48a9d5f7 LG |
1391 | \r |
1392 | **/\r | |
1393 | UINT32\r | |
1394 | EFIAPI\r | |
1395 | SaveReminder (\r | |
1396 | VOID\r | |
1397 | );\r | |
7da62bc0 ED |
1398 | \r |
1399 | /**\r | |
1400 | Check whether the Reset Required for the browser\r | |
1401 | \r | |
1402 | @retval TRUE Browser required to reset after exit.\r | |
1403 | @retval FALSE Browser not need to reset after exit.\r | |
1404 | \r | |
1405 | **/\r | |
1406 | BOOLEAN\r | |
1407 | EFIAPI\r | |
1408 | IsResetRequired (\r | |
1409 | VOID\r | |
1410 | );\r | |
48a9d5f7 LG |
1411 | \r |
1412 | /**\r | |
1413 | Find the registered HotKey based on KeyData.\r | |
d1102dba | 1414 | \r |
48a9d5f7 LG |
1415 | @param[in] KeyData A pointer to a buffer that describes the keystroke\r |
1416 | information for the hot key.\r | |
1417 | \r | |
1418 | @return The registered HotKey context. If no found, NULL will return.\r | |
1419 | **/\r | |
1420 | BROWSER_HOT_KEY *\r | |
1421 | GetHotKeyFromRegisterList (\r | |
1422 | IN EFI_INPUT_KEY *KeyData\r | |
1423 | );\r | |
1424 | \r | |
7c6c064c ED |
1425 | /**\r |
1426 | \r | |
1427 | Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.\r | |
1428 | \r | |
1429 | @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.\r | |
1430 | \r | |
1431 | @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.\r | |
1432 | \r | |
1433 | **/\r | |
1434 | FORM_BROWSER_STATEMENT *\r | |
1435 | GetBrowserStatement (\r | |
1436 | IN FORM_DISPLAY_ENGINE_STATEMENT *DisplayStatement\r | |
1437 | );\r | |
d1102dba | 1438 | \r |
7c6c064c ED |
1439 | /**\r |
1440 | Password may be stored as encrypted by Configuration Driver. When change a\r | |
1441 | password, user will be challenged with old password. To validate user input old\r | |
1442 | password, we will send the clear text to Configuration Driver via Callback().\r | |
1443 | Configuration driver is responsible to check the passed in password and return\r | |
1444 | the validation result. If validation pass, state machine in password Callback()\r | |
1445 | will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD.\r | |
1446 | After user type in new password twice, Callback() will be invoked to send the\r | |
1447 | new password to Configuration Driver.\r | |
1448 | \r | |
1449 | @param Selection Pointer to UI_MENU_SELECTION.\r | |
1450 | @param MenuOption The MenuOption for this password Question.\r | |
1451 | @param String The clear text of password.\r | |
1452 | \r | |
1453 | @retval EFI_NOT_AVAILABLE_YET Callback() request to terminate password input.\r | |
1454 | @return In state of BROWSER_STATE_VALIDATE_PASSWORD:\r | |
1455 | @retval EFI_SUCCESS Password correct, Browser will prompt for new\r | |
1456 | password.\r | |
1457 | @retval EFI_NOT_READY Password incorrect, Browser will show error\r | |
1458 | message.\r | |
1459 | @retval Other Browser will do nothing.\r | |
1460 | @return In state of BROWSER_STATE_SET_PASSWORD:\r | |
1461 | @retval EFI_SUCCESS Set password success.\r | |
1462 | @retval Other Set password failed.\r | |
1463 | \r | |
1464 | **/\r | |
1465 | EFI_STATUS\r | |
1466 | PasswordCallback (\r | |
1467 | IN UI_MENU_SELECTION *Selection,\r | |
1468 | IN FORM_BROWSER_STATEMENT *Question,\r | |
1469 | IN CHAR16 *String\r | |
1470 | );\r | |
1471 | \r | |
1472 | /**\r | |
1473 | Display error message for invalid password.\r | |
1474 | \r | |
1475 | **/\r | |
1476 | VOID\r | |
1477 | PasswordInvalid (\r | |
1478 | VOID\r | |
1479 | );\r | |
1480 | \r | |
1481 | /**\r | |
1482 | The worker function that send the displays to the screen. On output,\r | |
1483 | the selection made by user is returned.\r | |
1484 | \r | |
1485 | @param Selection On input, Selection tell setup browser the information\r | |
1486 | about the Selection, form and formset to be displayed.\r | |
1487 | On output, Selection return the screen item that is selected\r | |
1488 | by user.\r | |
1489 | \r | |
1490 | @retval EFI_SUCCESS The page is displayed successfully.\r | |
1491 | @return Other value if the page failed to be diplayed.\r | |
1492 | \r | |
1493 | **/\r | |
1494 | EFI_STATUS\r | |
1495 | SetupBrowser (\r | |
1496 | IN OUT UI_MENU_SELECTION *Selection\r | |
1497 | );\r | |
d1102dba | 1498 | \r |
7c6c064c ED |
1499 | /**\r |
1500 | Free up the resource allocated for all strings required\r | |
1501 | by Setup Browser.\r | |
1502 | \r | |
1503 | **/\r | |
1504 | VOID\r | |
1505 | FreeBrowserStrings (\r | |
1506 | VOID\r | |
1507 | );\r | |
1508 | \r | |
1509 | /**\r | |
1510 | Create a menu with specified formset GUID and form ID, and add it as a child\r | |
1511 | of the given parent menu.\r | |
1512 | \r | |
1513 | @param HiiHandle Hii handle related to this formset.\r | |
1514 | @param FormSetGuid The Formset Guid of menu to be added.\r | |
1515 | @param FormId The Form ID of menu to be added.\r | |
1516 | @param QuestionId The question id of this menu to be added.\r | |
1517 | \r | |
1518 | @return A pointer to the newly added menu or NULL if memory is insufficient.\r | |
1519 | \r | |
1520 | **/\r | |
1521 | FORM_ENTRY_INFO *\r | |
1522 | UiAddMenuList (\r | |
1523 | IN EFI_HII_HANDLE HiiHandle,\r | |
1524 | IN EFI_GUID *FormSetGuid,\r | |
1525 | IN UINT16 FormId,\r | |
1526 | IN UINT16 QuestionId\r | |
1527 | );\r | |
1528 | \r | |
1529 | /**\r | |
1530 | Search Menu with given FormSetGuid and FormId in all cached menu list.\r | |
1531 | \r | |
1532 | @param HiiHandle HiiHandle for FormSet.\r | |
1533 | @param FormSetGuid The Formset GUID of the menu to search.\r | |
1534 | @param FormId The Form ID of menu to search.\r | |
1535 | \r | |
1536 | @return A pointer to menu found or NULL if not found.\r | |
1537 | \r | |
1538 | **/\r | |
1539 | FORM_ENTRY_INFO *\r | |
1540 | UiFindMenuList (\r | |
d1102dba | 1541 | IN EFI_HII_HANDLE HiiHandle,\r |
7c6c064c ED |
1542 | IN EFI_GUID *FormSetGuid,\r |
1543 | IN UINT16 FormId\r | |
1544 | );\r | |
1545 | \r | |
1546 | /**\r | |
1547 | Free Menu list linked list.\r | |
1548 | \r | |
1549 | @param MenuListHead One Menu list point in the menu list.\r | |
1550 | \r | |
1551 | **/\r | |
1552 | VOID\r | |
1553 | UiFreeMenuList (\r | |
1554 | LIST_ENTRY *MenuListHead\r | |
1555 | );\r | |
1556 | \r | |
1557 | /**\r | |
1558 | Find parent menu for current menu.\r | |
1559 | \r | |
1560 | @param CurrentMenu Current Menu\r | |
93551a01 | 1561 | @param SettingLevel Whether find parent menu in Form Level or Formset level.\r |
d1102dba | 1562 | In form level, just find the parent menu;\r |
93551a01 ED |
1563 | In formset level, find the parent menu which has different\r |
1564 | formset guid value.\r | |
7c6c064c ED |
1565 | \r |
1566 | @retval The parent menu for current menu.\r | |
1567 | **/\r | |
1568 | FORM_ENTRY_INFO *\r | |
1569 | UiFindParentMenu (\r | |
93551a01 ED |
1570 | IN FORM_ENTRY_INFO *CurrentMenu,\r |
1571 | IN BROWSER_SETTING_SCOPE SettingLevel\r | |
1572 | );\r | |
d1102dba | 1573 | \r |
93551a01 | 1574 | /**\r |
dcca25d1 | 1575 | Validate the HiiHandle.\r |
93551a01 | 1576 | \r |
dcca25d1 | 1577 | @param HiiHandle The input HiiHandle which need to validate.\r |
93551a01 ED |
1578 | \r |
1579 | @retval TRUE The handle is validate.\r | |
1580 | @retval FALSE The handle is invalidate.\r | |
1581 | \r | |
1582 | **/\r | |
1583 | BOOLEAN\r | |
1584 | ValidateHiiHandle (\r | |
1585 | EFI_HII_HANDLE HiiHandle\r | |
7c6c064c ED |
1586 | );\r |
1587 | \r | |
4d4deaac ED |
1588 | /**\r |
1589 | Copy current Menu list to the new menu list.\r | |
d1102dba | 1590 | \r |
4d4deaac ED |
1591 | @param NewMenuListHead New create Menu list.\r |
1592 | @param CurrentMenuListHead Current Menu list.\r | |
1593 | \r | |
1594 | **/\r | |
1595 | VOID\r | |
1596 | UiCopyMenuList (\r | |
1597 | OUT LIST_ENTRY *NewMenuListHead,\r | |
1598 | IN LIST_ENTRY *CurrentMenuListHead\r | |
1599 | );\r | |
1600 | \r | |
7c6c064c ED |
1601 | /**\r |
1602 | Search an Option of a Question by its value.\r | |
1603 | \r | |
1604 | @param Question The Question\r | |
1605 | @param OptionValue Value for Option to be searched.\r | |
1606 | \r | |
1607 | @retval Pointer Pointer to the found Option.\r | |
1608 | @retval NULL Option not found.\r | |
1609 | \r | |
1610 | **/\r | |
1611 | QUESTION_OPTION *\r | |
1612 | ValueToOption (\r | |
1613 | IN FORM_BROWSER_STATEMENT *Question,\r | |
1614 | IN EFI_HII_VALUE *OptionValue\r | |
1615 | );\r | |
1616 | /**\r | |
1617 | Return data element in an Array by its Index.\r | |
1618 | \r | |
1619 | @param Array The data array.\r | |
1620 | @param Type Type of the data in this array.\r | |
1621 | @param Index Zero based index for data in this array.\r | |
1622 | \r | |
1623 | @retval Value The data to be returned\r | |
1624 | \r | |
1625 | **/\r | |
1626 | UINT64\r | |
1627 | GetArrayData (\r | |
1628 | IN VOID *Array,\r | |
1629 | IN UINT8 Type,\r | |
1630 | IN UINTN Index\r | |
1631 | );\r | |
1632 | \r | |
1633 | /**\r | |
1634 | Set value of a data element in an Array by its Index.\r | |
1635 | \r | |
1636 | @param Array The data array.\r | |
1637 | @param Type Type of the data in this array.\r | |
1638 | @param Index Zero based index for data in this array.\r | |
1639 | @param Value The value to be set.\r | |
1640 | \r | |
1641 | **/\r | |
1642 | VOID\r | |
1643 | SetArrayData (\r | |
1644 | IN VOID *Array,\r | |
1645 | IN UINT8 Type,\r | |
1646 | IN UINTN Index,\r | |
1647 | IN UINT64 Value\r | |
1648 | );\r | |
1649 | \r | |
1650 | /**\r | |
1651 | Compare two Hii value.\r | |
d1102dba | 1652 | \r |
7c6c064c ED |
1653 | @param Value1 Expression value to compare on left-hand.\r |
1654 | @param Value2 Expression value to compare on right-hand.\r | |
1655 | @param Result Return value after compare.\r | |
1656 | retval 0 Two operators equal.\r | |
1657 | return Positive value if Value1 is greater than Value2.\r | |
1658 | retval Negative value if Value1 is less than Value2.\r | |
1659 | @param HiiHandle Only required for string compare.\r | |
d1102dba | 1660 | \r |
7c6c064c ED |
1661 | @retval other Could not perform compare on two values.\r |
1662 | @retval EFI_SUCCESS Compare the value success.\r | |
d1102dba | 1663 | \r |
7c6c064c ED |
1664 | **/\r |
1665 | EFI_STATUS\r | |
1666 | CompareHiiValue (\r | |
1667 | IN EFI_HII_VALUE *Value1,\r | |
1668 | IN EFI_HII_VALUE *Value2,\r | |
1669 | OUT INTN *Result,\r | |
1670 | IN EFI_HII_HANDLE HiiHandle OPTIONAL\r | |
1671 | );\r | |
1672 | \r | |
1673 | /**\r | |
d1102dba | 1674 | Perform Password check.\r |
7c6c064c | 1675 | Passwork may be encrypted by driver that requires the specific check.\r |
d1102dba | 1676 | \r |
7c6c064c ED |
1677 | @param Form Form where Password Statement is in.\r |
1678 | @param Statement Password statement\r | |
1679 | @param PasswordString Password string to be checked. It may be NULL.\r | |
1680 | NULL means to restore password.\r | |
1681 | "" string can be used to checked whether old password does exist.\r | |
d1102dba | 1682 | \r |
7c6c064c ED |
1683 | @return Status Status of Password check.\r |
1684 | **/\r | |
1685 | EFI_STATUS\r | |
1686 | EFIAPI\r | |
1687 | PasswordCheck (\r | |
1688 | IN FORM_DISPLAY_ENGINE_FORM *Form,\r | |
1689 | IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,\r | |
1690 | IN EFI_STRING PasswordString OPTIONAL\r | |
1691 | );\r | |
1692 | \r | |
1693 | /**\r | |
1694 | \r | |
1695 | Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.\r | |
1696 | \r | |
1697 | @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.\r | |
1698 | \r | |
1699 | @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.\r | |
1700 | \r | |
1701 | **/\r | |
1702 | FORM_BROWSER_STATEMENT *\r | |
1703 | GetBrowserStatement (\r | |
1704 | IN FORM_DISPLAY_ENGINE_STATEMENT *DisplayStatement\r | |
1705 | );\r | |
d1102dba | 1706 | \r |
7c6c064c ED |
1707 | /**\r |
1708 | \r | |
1709 | Initialize the Display form structure data.\r | |
1710 | \r | |
1711 | **/\r | |
1712 | VOID\r | |
1713 | InitializeDisplayFormData (\r | |
1714 | VOID\r | |
1715 | );\r | |
1716 | \r | |
1717 | \r | |
0a6f8af5 ED |
1718 | /**\r |
1719 | Base on the current formset info, clean the ConfigRequest string in browser storage.\r | |
1720 | \r | |
1721 | @param FormSet Pointer of the FormSet\r | |
1722 | \r | |
1723 | **/\r | |
1724 | VOID\r | |
1725 | CleanBrowserStorage (\r | |
1726 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
1727 | );\r | |
07d7dbae ED |
1728 | \r |
1729 | /**\r | |
1730 | Find HII Handle in the HII database associated with given Device Path.\r | |
1731 | \r | |
1732 | If DevicePath is NULL, then ASSERT.\r | |
1733 | \r | |
1734 | @param DevicePath Device Path associated with the HII package list\r | |
1735 | handle.\r | |
1736 | @param FormsetGuid The formset guid for this formset.\r | |
1737 | \r | |
1738 | @retval Handle HII package list Handle associated with the Device\r | |
1739 | Path.\r | |
1740 | @retval NULL Hii Package list handle is not found.\r | |
1741 | \r | |
1742 | **/\r | |
1743 | EFI_HII_HANDLE\r | |
1744 | DevicePathToHiiHandle (\r | |
1745 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
1746 | IN EFI_GUID *FormsetGuid\r | |
1747 | );\r | |
1748 | \r | |
9d34cac8 ED |
1749 | /**\r |
1750 | Adjust the config request info, remove the request elements which already in AllConfigRequest string.\r | |
1751 | \r | |
1752 | @param Storage Form set Storage.\r | |
1753 | @param Request The input request string.\r | |
1754 | @param RespString Whether the input is ConfigRequest or ConfigResp format.\r | |
1755 | \r | |
1756 | @retval TRUE Has element not covered by current used elements, need to continue to call ExtractConfig\r | |
1757 | @retval FALSE All elements covered by current used elements.\r | |
1758 | \r | |
1759 | **/\r | |
d1102dba | 1760 | BOOLEAN\r |
9d34cac8 ED |
1761 | ConfigRequestAdjust (\r |
1762 | IN BROWSER_STORAGE *Storage,\r | |
1763 | IN CHAR16 *Request,\r | |
1764 | IN BOOLEAN RespString\r | |
1765 | );\r | |
1766 | \r | |
bfae1330 | 1767 | /**\r |
d1102dba LG |
1768 | Perform question check.\r |
1769 | \r | |
bfae1330 ED |
1770 | If one question has more than one check, process form high priority to low.\r |
1771 | \r | |
1772 | @param FormSet FormSet data structure.\r | |
1773 | @param Form Form data structure.\r | |
1774 | @param Question The Question to be validated.\r | |
1775 | \r | |
1776 | @retval EFI_SUCCESS Form validation pass.\r | |
1777 | @retval other Form validation failed.\r | |
1778 | \r | |
1779 | **/\r | |
1780 | EFI_STATUS\r | |
1781 | ValueChangedValidation (\r | |
1782 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
1783 | IN FORM_BROWSER_FORM *Form,\r | |
1784 | IN FORM_BROWSER_STATEMENT *Question\r | |
1785 | );\r | |
1786 | \r | |
1787 | /**\r | |
1788 | Pop up the error info.\r | |
1789 | \r | |
1790 | @param BrowserStatus The input browser status.\r | |
4d4deaac | 1791 | @param HiiHandle The HiiHandle for this error opcode.\r |
bfae1330 ED |
1792 | @param OpCode The opcode use to get the erro info and timeout value.\r |
1793 | @param ErrorString Error string used by BROWSER_NO_SUBMIT_IF.\r | |
1794 | \r | |
1795 | **/\r | |
4d4deaac | 1796 | UINT32\r |
bfae1330 ED |
1797 | PopupErrorMessage (\r |
1798 | IN UINT32 BrowserStatus,\r | |
4d4deaac | 1799 | IN EFI_HII_HANDLE HiiHandle,\r |
bfae1330 ED |
1800 | IN EFI_IFR_OP_HEADER *OpCode, OPTIONAL\r |
1801 | IN CHAR16 *ErrorString\r | |
1802 | );\r | |
1803 | \r | |
e6106e89 ED |
1804 | /**\r |
1805 | Check whether the result is TRUE or FALSE.\r | |
1806 | \r | |
1807 | For the EFI_HII_VALUE value type is numeric, return TRUE if the\r | |
1808 | value is not 0.\r | |
1809 | \r | |
1810 | @param Result Input the result data.\r | |
1811 | \r | |
1812 | @retval TRUE The result is TRUE.\r | |
1813 | @retval FALSE The result is FALSE.\r | |
1814 | \r | |
1815 | **/\r | |
1816 | BOOLEAN\r | |
1817 | IsTrue (\r | |
1818 | IN EFI_HII_VALUE *Result\r | |
1819 | );\r | |
1820 | \r | |
a35ecb75 ED |
1821 | /**\r |
1822 | Get Formset_storage base on the input varstoreid info.\r | |
1823 | \r | |
1824 | @param FormSet Pointer of the current FormSet.\r | |
1825 | @param VarStoreId Varstore ID info.\r | |
1826 | \r | |
1827 | @return Pointer to a FORMSET_STORAGE data structure.\r | |
1828 | \r | |
1829 | **/\r | |
1830 | FORMSET_STORAGE *\r | |
1831 | GetFstStgFromVarId (\r | |
1832 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
1833 | IN EFI_VARSTORE_ID VarStoreId\r | |
1834 | );\r | |
1835 | \r | |
1836 | /**\r | |
1837 | Get Formset_storage base on the input browser storage.\r | |
1838 | \r | |
1839 | More than one formsets may share the same browser storage,\r | |
1840 | this function just get the first formset storage which\r | |
1841 | share the browser storage.\r | |
1842 | \r | |
1843 | @param Storage browser storage info.\r | |
1844 | \r | |
1845 | @return Pointer to a FORMSET_STORAGE data structure.\r | |
d1102dba | 1846 | \r |
a35ecb75 ED |
1847 | \r |
1848 | **/\r | |
1849 | FORMSET_STORAGE *\r | |
1850 | GetFstStgFromBrsStg (\r | |
1851 | IN BROWSER_STORAGE *Storage\r | |
1852 | );\r | |
1853 | \r | |
f2e7732e ED |
1854 | /**\r |
1855 | Reconnect the controller.\r | |
1856 | \r | |
1857 | @param DriverHandle The controller handle which need to be reconnect.\r | |
1858 | \r | |
1859 | @retval TRUE do the reconnect behavior success.\r | |
1860 | @retval FALSE do the reconnect behavior failed.\r | |
d1102dba | 1861 | \r |
f2e7732e ED |
1862 | **/\r |
1863 | BOOLEAN\r | |
1864 | ReconnectController (\r | |
1865 | IN EFI_HANDLE DriverHandle\r | |
1866 | );\r | |
1867 | \r | |
a0973dcb DB |
1868 | /**\r |
1869 | Converts the unicode character of the string from uppercase to lowercase.\r | |
1870 | This is a internal function.\r | |
1871 | \r | |
1872 | @param ConfigString String to be converted\r | |
1873 | \r | |
1874 | **/\r | |
1875 | VOID\r | |
1876 | EFIAPI\r | |
1877 | HiiToLower (\r | |
1878 | IN EFI_STRING ConfigString\r | |
1879 | );\r | |
1880 | \r | |
7936fb6a | 1881 | #endif\r |