]>
Commit | Line | Data |
---|---|---|
7936fb6a | 1 | /** @file\r |
d66e6c16 | 2 | Private MACRO, structure and function definitions for Setup Browser module.\r |
7936fb6a | 3 | \r |
2654f642 | 4 | Copyright (c) 2007 - 2009, Intel Corporation\r |
7936fb6a | 5 | All rights reserved. This program and the accompanying materials\r |
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 | |
25 | #include <Protocol/DevicePath.h>\r | |
26 | #include <Protocol/UnicodeCollation.h>\r | |
27 | #include <Protocol/HiiConfigAccess.h>\r | |
28 | #include <Protocol/HiiConfigRouting.h>\r | |
29 | #include <Protocol/HiiDatabase.h>\r | |
30 | #include <Protocol/HiiString.h>\r | |
cbf73e50 | 31 | #include <Protocol/UserManager.h>\r |
7936fb6a | 32 | \r |
5c526736 | 33 | #include <Guid/MdeModuleHii.h>\r |
0a1147ed | 34 | #include <Guid/HiiPlatformSetupFormset.h>\r |
7936fb6a | 35 | \r |
7936fb6a | 36 | #include <Library/PrintLib.h>\r |
37 | #include <Library/DebugLib.h>\r | |
38 | #include <Library/BaseMemoryLib.h>\r | |
39 | #include <Library/UefiRuntimeServicesTableLib.h>\r | |
40 | #include <Library/UefiDriverEntryPoint.h>\r | |
41 | #include <Library/UefiBootServicesTableLib.h>\r | |
42 | #include <Library/BaseLib.h>\r | |
43 | #include <Library/MemoryAllocationLib.h>\r | |
7936fb6a | 44 | #include <Library/HiiLib.h>\r |
f511d656 | 45 | #include <Library/PcdLib.h>\r |
cb7d01c0 | 46 | #include <Library/DevicePathLib.h>\r |
7936fb6a | 47 | \r |
48 | #include "Colors.h"\r | |
49 | \r | |
50 | //\r | |
51 | // This is the generated header file which includes whatever needs to be exported (strings + IFR)\r | |
52 | //\r | |
53 | \r | |
54 | extern UINT8 SetupBrowserStrings[];\r | |
55 | \r | |
56 | //\r | |
57 | // Screen definitions\r | |
58 | //\r | |
59 | #define BANNER_HEIGHT 6\r | |
60 | #define BANNER_COLUMNS 3\r | |
61 | \r | |
62 | #define FRONT_PAGE_HEADER_HEIGHT 6\r | |
63 | #define NONE_FRONT_PAGE_HEADER_HEIGHT 3\r | |
64 | #define LEFT_SKIPPED_COLUMNS 4\r | |
65 | #define FOOTER_HEIGHT 4\r | |
66 | #define STATUS_BAR_HEIGHT 1\r | |
67 | #define SCROLL_ARROW_HEIGHT 1\r | |
68 | #define POPUP_PAD_SPACE_COUNT 5\r | |
69 | #define POPUP_FRAME_WIDTH 2\r | |
70 | \r | |
71 | //\r | |
72 | // Definition for function key setting\r | |
73 | //\r | |
74 | #define NONE_FUNCTION_KEY_SETTING 0\r | |
8b0fc5c1 | 75 | #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)\r |
7936fb6a | 76 | \r |
7936fb6a | 77 | #define FUNCTION_NINE (1 << 2)\r |
78 | #define FUNCTION_TEN (1 << 3)\r | |
79 | \r | |
80 | typedef struct {\r | |
81 | EFI_GUID FormSetGuid;\r | |
82 | UINTN KeySetting;\r | |
83 | } FUNCTIION_KEY_SETTING;\r | |
84 | \r | |
85 | //\r | |
86 | // Character definitions\r | |
87 | //\r | |
88 | #define CHAR_SPACE 0x0020\r | |
89 | #define UPPER_LOWER_CASE_OFFSET 0x20\r | |
90 | \r | |
91 | //\r | |
92 | // Time definitions\r | |
93 | //\r | |
94 | #define ONE_SECOND 10000000\r | |
95 | \r | |
96 | //\r | |
97 | // Display definitions\r | |
98 | //\r | |
99 | #define LEFT_HYPER_DELIMITER L'<'\r | |
100 | #define RIGHT_HYPER_DELIMITER L'>'\r | |
101 | \r | |
102 | #define LEFT_ONEOF_DELIMITER L'<'\r | |
103 | #define RIGHT_ONEOF_DELIMITER L'>'\r | |
104 | \r | |
105 | #define LEFT_NUMERIC_DELIMITER L'['\r | |
106 | #define RIGHT_NUMERIC_DELIMITER L']'\r | |
107 | \r | |
108 | #define LEFT_CHECKBOX_DELIMITER L'['\r | |
109 | #define RIGHT_CHECKBOX_DELIMITER L']'\r | |
110 | \r | |
111 | #define CHECK_ON L'X'\r | |
112 | #define CHECK_OFF L' '\r | |
113 | \r | |
114 | #define TIME_SEPARATOR L':'\r | |
115 | #define DATE_SEPARATOR L'/'\r | |
116 | \r | |
117 | #define YES_ANSWER L'Y'\r | |
118 | #define NO_ANSWER L'N'\r | |
119 | \r | |
120 | //\r | |
121 | // This is the Input Error Message\r | |
122 | //\r | |
123 | #define INPUT_ERROR 1\r | |
124 | \r | |
125 | //\r | |
126 | // This is the NV RAM update required Message\r | |
127 | //\r | |
128 | #define NV_UPDATE_REQUIRED 2\r | |
129 | \r | |
130 | //\r | |
131 | // Refresh the Status Bar with flags\r | |
132 | //\r | |
133 | #define REFRESH_STATUS_BAR 0xff\r | |
134 | \r | |
135 | //\r | |
136 | // Incremental string lenght of ConfigRequest\r | |
137 | //\r | |
138 | #define CONFIG_REQUEST_STRING_INCREMENTAL 1024\r | |
139 | \r | |
140 | //\r | |
141 | // HII value compare result\r | |
142 | //\r | |
143 | #define HII_VALUE_UNDEFINED 0\r | |
144 | #define HII_VALUE_EQUAL 1\r | |
145 | #define HII_VALUE_LESS_THAN 2\r | |
146 | #define HII_VALUE_GREATER_THAN 3\r | |
147 | \r | |
148 | //\r | |
149 | // Incremental size of stack for expression\r | |
150 | //\r | |
151 | #define EXPRESSION_STACK_SIZE_INCREMENT 0x100\r | |
152 | \r | |
153 | \r | |
154 | #define EFI_SPECIFICATION_ERRATA_VERSION 0\r | |
155 | \r | |
156 | #define EFI_IFR_SPECIFICATION_VERSION \\r | |
157 | ((((EFI_SPECIFICATION_VERSION) >> 8) & 0xff00) | \\r | |
158 | (((EFI_SPECIFICATION_VERSION) & 0xf) << 4) | \\r | |
159 | ((EFI_SPECIFICATION_ERRATA_VERSION) & 0xf))\r | |
160 | \r | |
f3f2e05d | 161 | #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')\r |
7936fb6a | 162 | typedef struct {\r |
163 | UINT32 Signature;\r | |
164 | \r | |
165 | EFI_HANDLE Handle;\r | |
166 | \r | |
167 | //\r | |
168 | // Produced protocol\r | |
169 | //\r | |
170 | EFI_FORM_BROWSER2_PROTOCOL FormBrowser2;\r | |
7936fb6a | 171 | \r |
172 | } SETUP_DRIVER_PRIVATE_DATA;\r | |
173 | \r | |
174 | typedef struct {\r | |
175 | EFI_STRING_ID Banner[BANNER_HEIGHT][BANNER_COLUMNS];\r | |
176 | } BANNER_DATA;\r | |
177 | \r | |
178 | //\r | |
179 | // IFR relative definition\r | |
180 | //\r | |
181 | #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0\r | |
182 | #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1\r | |
183 | #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2\r | |
184 | #define EFI_HII_EXPRESSION_SUPPRESS_IF 3\r | |
185 | #define EFI_HII_EXPRESSION_DISABLE_IF 4\r | |
186 | #define EFI_HII_EXPRESSION_VALUE 5\r | |
187 | #define EFI_HII_EXPRESSION_RULE 6\r | |
188 | \r | |
189 | #define EFI_HII_VARSTORE_BUFFER 0\r | |
190 | #define EFI_HII_VARSTORE_NAME_VALUE 1\r | |
191 | #define EFI_HII_VARSTORE_EFI_VARIABLE 2\r | |
192 | \r | |
193 | #define FORM_INCONSISTENT_VALIDATION 0\r | |
194 | #define FORM_NO_SUBMIT_VALIDATION 1\r | |
195 | \r | |
0a1147ed LG |
196 | #define FORMSET_CLASS_PLATFORM_SETUP 0\r |
197 | #define FORMSET_CLASS_FRONT_PAGE 1\r | |
198 | \r | |
7936fb6a | 199 | typedef struct {\r |
200 | UINT8 Type;\r | |
201 | EFI_IFR_TYPE_VALUE Value;\r | |
202 | } EFI_HII_VALUE;\r | |
203 | \r | |
f3f2e05d | 204 | #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')\r |
7936fb6a | 205 | \r |
206 | typedef struct {\r | |
207 | UINTN Signature;\r | |
208 | LIST_ENTRY Link;\r | |
209 | CHAR16 *Name;\r | |
210 | CHAR16 *Value;\r | |
211 | CHAR16 *EditValue;\r | |
212 | } NAME_VALUE_NODE;\r | |
213 | \r | |
214 | #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)\r | |
215 | \r | |
f3f2e05d | 216 | #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')\r |
7936fb6a | 217 | \r |
218 | typedef struct {\r | |
219 | UINTN Signature;\r | |
220 | LIST_ENTRY Link;\r | |
221 | \r | |
222 | UINT8 Type; // Storage type\r | |
223 | \r | |
224 | UINT16 VarStoreId;\r | |
225 | EFI_GUID Guid;\r | |
226 | \r | |
227 | CHAR16 *Name; // For EFI_IFR_VARSTORE\r | |
228 | UINT16 Size;\r | |
229 | UINT8 *Buffer;\r | |
230 | UINT8 *EditBuffer; // Edit copy for Buffer Storage\r | |
231 | \r | |
232 | LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE\r | |
233 | \r | |
234 | UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute\r | |
235 | \r | |
236 | CHAR16 *ConfigHdr; // <ConfigHdr>\r | |
237 | CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>\r | |
238 | UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>\r | |
239 | UINTN SpareStrLen; // Spare length of ConfigRequest string buffer\r | |
240 | } FORMSET_STORAGE;\r | |
241 | \r | |
242 | #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)\r | |
243 | \r | |
f3f2e05d | 244 | #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')\r |
7936fb6a | 245 | \r |
246 | typedef struct {\r | |
247 | UINTN Signature;\r | |
248 | LIST_ENTRY Link;\r | |
249 | \r | |
250 | UINT8 Operand;\r | |
251 | \r | |
252 | UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND\r | |
253 | UINT8 Flags; // For EFI_IFR_SPAN\r | |
254 | UINT8 RuleId; // For EFI_IFR_RULE_REF\r | |
255 | \r | |
256 | 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 | |
257 | \r | |
2654f642 | 258 | EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1\r |
7936fb6a | 259 | EFI_QUESTION_ID QuestionId2;\r |
260 | \r | |
2654f642 | 261 | UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_LIST\r |
7936fb6a | 262 | UINT16 *ValueList;\r |
263 | \r | |
264 | EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3\r | |
265 | EFI_GUID Guid;\r | |
266 | } EXPRESSION_OPCODE;\r | |
267 | \r | |
268 | #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)\r | |
269 | \r | |
f3f2e05d | 270 | #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')\r |
7936fb6a | 271 | \r |
272 | typedef struct {\r | |
273 | UINTN Signature;\r | |
274 | LIST_ENTRY Link;\r | |
275 | \r | |
276 | UINT8 Type; // Type for this expression\r | |
277 | \r | |
278 | UINT8 RuleId; // For EFI_IFR_RULE only\r | |
279 | EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only\r | |
280 | \r | |
281 | EFI_HII_VALUE Result; // Expression evaluation result\r | |
282 | \r | |
283 | LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)\r | |
284 | } FORM_EXPRESSION;\r | |
285 | \r | |
286 | #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)\r | |
287 | \r | |
f3f2e05d | 288 | #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')\r |
7936fb6a | 289 | \r |
290 | typedef struct {\r | |
291 | UINTN Signature;\r | |
292 | LIST_ENTRY Link;\r | |
293 | \r | |
294 | UINT16 DefaultId;\r | |
295 | EFI_HII_VALUE Value; // Default value\r | |
296 | \r | |
297 | FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE\r | |
298 | } QUESTION_DEFAULT;\r | |
299 | \r | |
300 | #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)\r | |
301 | \r | |
f3f2e05d | 302 | #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')\r |
7936fb6a | 303 | \r |
304 | typedef struct {\r | |
305 | UINTN Signature;\r | |
306 | LIST_ENTRY Link;\r | |
307 | \r | |
308 | EFI_STRING_ID Text;\r | |
309 | UINT8 Flags;\r | |
310 | EFI_HII_VALUE Value;\r | |
311 | EFI_IMAGE_ID ImageId;\r | |
312 | \r | |
313 | FORM_EXPRESSION *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf\r | |
314 | } QUESTION_OPTION;\r | |
315 | \r | |
316 | #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)\r | |
317 | \r | |
f3f2e05d | 318 | #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')\r |
7936fb6a | 319 | typedef struct {\r |
320 | UINTN Signature;\r | |
321 | LIST_ENTRY Link;\r | |
322 | \r | |
323 | UINT8 Operand; // The operand (first byte) of this Statement or Question\r | |
324 | \r | |
325 | //\r | |
326 | // Statement Header\r | |
327 | //\r | |
328 | EFI_STRING_ID Prompt;\r | |
329 | EFI_STRING_ID Help;\r | |
330 | EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT\r | |
331 | \r | |
332 | //\r | |
333 | // Question Header\r | |
334 | //\r | |
335 | EFI_QUESTION_ID QuestionId; // The value of zero is reserved\r | |
336 | EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage\r | |
337 | FORMSET_STORAGE *Storage;\r | |
338 | union {\r | |
339 | EFI_STRING_ID VarName;\r | |
340 | UINT16 VarOffset;\r | |
341 | } VarStoreInfo;\r | |
342 | UINT16 StorageWidth;\r | |
343 | UINT8 QuestionFlags;\r | |
344 | CHAR16 *VariableName; // Name/Value or EFI Variable name\r | |
345 | CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."\r | |
346 | \r | |
347 | EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof\r | |
348 | UINT8 *BufferValue; // Edit copy for string, password, orderedlist\r | |
d02847d3 | 349 | UINT8 ValueType; // Data type for orderedlist value array\r |
7936fb6a | 350 | \r |
351 | //\r | |
352 | // OpCode specific members\r | |
353 | //\r | |
354 | UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,\r | |
355 | // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER\r | |
356 | UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST\r | |
357 | \r | |
358 | UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number\r | |
359 | EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed\r | |
360 | \r | |
361 | UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value\r | |
362 | UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length\r | |
363 | UINT64 Step;\r | |
364 | \r | |
365 | EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON\r | |
366 | EFI_FORM_ID RefFormId; // for EFI_IFR_REF\r | |
367 | EFI_QUESTION_ID RefQuestionId; // for EFI_IFR_REF2\r | |
368 | EFI_GUID RefFormSetId; // for EFI_IFR_REF3\r | |
369 | EFI_STRING_ID RefDevicePath; // for EFI_IFR_REF4\r | |
370 | \r | |
371 | //\r | |
372 | // Get from IFR parsing\r | |
373 | //\r | |
374 | FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly\r | |
375 | LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values\r | |
376 | LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)\r | |
377 | \r | |
378 | EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE\r | |
379 | UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh\r | |
380 | BOOLEAN InSubtitle; // nesting inside of EFI_IFR_SUBTITLE\r | |
381 | \r | |
382 | LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)\r | |
383 | LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)\r | |
384 | FORM_EXPRESSION *GrayOutExpression; // nesting inside of GrayOutIf\r | |
385 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r | |
0a1147ed | 386 | FORM_EXPRESSION *DisableExpression; // nesting inside of DisableIf\r |
7936fb6a | 387 | \r |
388 | } FORM_BROWSER_STATEMENT;\r | |
389 | \r | |
390 | #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)\r | |
391 | \r | |
f3f2e05d | 392 | #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')\r |
7936fb6a | 393 | \r |
394 | typedef struct {\r | |
395 | UINTN Signature;\r | |
396 | LIST_ENTRY Link;\r | |
397 | \r | |
398 | UINT16 FormId;\r | |
399 | EFI_STRING_ID FormTitle;\r | |
400 | \r | |
401 | EFI_IMAGE_ID ImageId;\r | |
402 | \r | |
403 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r | |
404 | LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)\r | |
0c66bc76 | 405 | FORM_EXPRESSION *SuppressExpression; // nesting inside of SuppressIf\r |
7936fb6a | 406 | } FORM_BROWSER_FORM;\r |
407 | \r | |
408 | #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r | |
409 | \r | |
f3f2e05d | 410 | #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')\r |
7936fb6a | 411 | \r |
412 | typedef struct {\r | |
413 | UINTN Signature;\r | |
414 | LIST_ENTRY Link;\r | |
415 | \r | |
416 | UINT16 DefaultId;\r | |
417 | EFI_STRING_ID DefaultName;\r | |
418 | } FORMSET_DEFAULTSTORE;\r | |
419 | \r | |
420 | #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r | |
421 | \r | |
422 | typedef struct {\r | |
423 | EFI_HII_HANDLE HiiHandle;\r | |
424 | EFI_HANDLE DriverHandle;\r | |
425 | EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r | |
426 | EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r | |
427 | \r | |
428 | UINTN IfrBinaryLength;\r | |
429 | UINT8 *IfrBinaryData;\r | |
430 | \r | |
431 | EFI_GUID Guid;\r | |
432 | EFI_STRING_ID FormSetTitle;\r | |
433 | EFI_STRING_ID Help;\r | |
0a1147ed LG |
434 | UINT8 NumberOfClassGuid;\r |
435 | EFI_GUID ClassGuid[3]; // Up to three ClassGuid\r | |
436 | UINT16 Class; // Tiano extended Class code\r | |
437 | UINT16 SubClass; // Tiano extended Subclass code\r | |
7936fb6a | 438 | EFI_IMAGE_ID ImageId;\r |
439 | \r | |
440 | FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r | |
441 | EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r | |
442 | \r | |
443 | LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r | |
444 | LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r | |
445 | LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r | |
0c66bc76 | 446 | LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)\r |
7936fb6a | 447 | } FORM_BROWSER_FORMSET;\r |
448 | \r | |
ce6d12cc | 449 | #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')\r |
450 | \r | |
451 | typedef struct {\r | |
452 | UINTN Signature;\r | |
453 | LIST_ENTRY Link;\r | |
454 | \r | |
455 | //\r | |
456 | // Globals defined in Setup.c\r | |
457 | //\r | |
458 | BANNER_DATA *BannerData;\r | |
459 | UINTN ClassOfVfr;\r | |
460 | UINTN FunctionKeySetting;\r | |
461 | BOOLEAN ResetRequired;\r | |
462 | BOOLEAN NvUpdateRequired;\r | |
463 | UINT16 Direction;\r | |
464 | EFI_SCREEN_DESCRIPTOR ScreenDimensions;\r | |
465 | CHAR16 *FunctionNineString;\r | |
466 | CHAR16 *FunctionTenString;\r | |
467 | CHAR16 *EnterString;\r | |
468 | CHAR16 *EnterCommitString;\r | |
469 | CHAR16 *EnterEscapeString;\r | |
470 | CHAR16 *EscapeString;\r | |
471 | CHAR16 *SaveFailed;\r | |
472 | CHAR16 *MoveHighlight;\r | |
473 | CHAR16 *MakeSelection;\r | |
474 | CHAR16 *DecNumericInput;\r | |
475 | CHAR16 *HexNumericInput;\r | |
476 | CHAR16 *ToggleCheckBox;\r | |
477 | CHAR16 *PromptForData;\r | |
478 | CHAR16 *PromptForPassword;\r | |
479 | CHAR16 *PromptForNewPassword;\r | |
480 | CHAR16 *ConfirmPassword;\r | |
481 | CHAR16 *ConfirmError;\r | |
482 | CHAR16 *PassowordInvalid;\r | |
483 | CHAR16 *PressEnter;\r | |
484 | CHAR16 *EmptyString;\r | |
485 | CHAR16 *AreYouSure;\r | |
486 | CHAR16 *YesResponse;\r | |
487 | CHAR16 *NoResponse;\r | |
488 | CHAR16 *MiniString;\r | |
489 | CHAR16 *PlusString;\r | |
490 | CHAR16 *MinusString;\r | |
491 | CHAR16 *AdjustNumber;\r | |
492 | CHAR16 *SaveChanges;\r | |
493 | CHAR16 *OptionMismatch;\r | |
2bb526f3 | 494 | CHAR16 *FormSuppress;\r |
ce6d12cc | 495 | CHAR16 PromptBlockWidth;\r |
496 | CHAR16 OptionBlockWidth;\r | |
497 | CHAR16 HelpBlockWidth;\r | |
498 | FORM_BROWSER_FORMSET *OldFormSet;\r | |
499 | \r | |
500 | //\r | |
501 | // Globals defined in Ui.c\r | |
502 | //\r | |
503 | LIST_ENTRY MenuOption;\r | |
504 | VOID *MenuRefreshHead;\r | |
505 | } BROWSER_CONTEXT;\r | |
506 | \r | |
507 | #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)\r | |
7936fb6a | 508 | \r |
509 | extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r | |
510 | extern EFI_HII_STRING_PROTOCOL *mHiiString;\r | |
511 | extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;\r | |
512 | \r | |
0a1147ed LG |
513 | extern BANNER_DATA *gBannerData;\r |
514 | extern EFI_HII_HANDLE gFrontPageHandle;\r | |
7936fb6a | 515 | extern UINTN gClassOfVfr;\r |
516 | extern UINTN gFunctionKeySetting;\r | |
517 | extern BOOLEAN gResetRequired;\r | |
518 | extern BOOLEAN gNvUpdateRequired;\r | |
519 | extern EFI_HII_HANDLE gHiiHandle;\r | |
7936fb6a | 520 | extern UINT16 gDirection;\r |
521 | extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;\r | |
7936fb6a | 522 | \r |
d66e6c16 | 523 | extern FORM_BROWSER_FORMSET *gOldFormSet;\r |
524 | \r | |
7936fb6a | 525 | //\r |
526 | // Browser Global Strings\r | |
527 | //\r | |
7936fb6a | 528 | extern CHAR16 *gFunctionNineString;\r |
529 | extern CHAR16 *gFunctionTenString;\r | |
530 | extern CHAR16 *gEnterString;\r | |
531 | extern CHAR16 *gEnterCommitString;\r | |
8d00a0f1 | 532 | extern CHAR16 *gEnterEscapeString;\r |
7936fb6a | 533 | extern CHAR16 *gEscapeString;\r |
534 | extern CHAR16 *gSaveFailed;\r | |
535 | extern CHAR16 *gMoveHighlight;\r | |
536 | extern CHAR16 *gMakeSelection;\r | |
537 | extern CHAR16 *gDecNumericInput;\r | |
538 | extern CHAR16 *gHexNumericInput;\r | |
539 | extern CHAR16 *gToggleCheckBox;\r | |
540 | extern CHAR16 *gPromptForData;\r | |
541 | extern CHAR16 *gPromptForPassword;\r | |
542 | extern CHAR16 *gPromptForNewPassword;\r | |
543 | extern CHAR16 *gConfirmPassword;\r | |
544 | extern CHAR16 *gConfirmError;\r | |
545 | extern CHAR16 *gPassowordInvalid;\r | |
546 | extern CHAR16 *gPressEnter;\r | |
547 | extern CHAR16 *gEmptyString;\r | |
548 | extern CHAR16 *gAreYouSure;\r | |
549 | extern CHAR16 *gYesResponse;\r | |
550 | extern CHAR16 *gNoResponse;\r | |
551 | extern CHAR16 *gMiniString;\r | |
552 | extern CHAR16 *gPlusString;\r | |
553 | extern CHAR16 *gMinusString;\r | |
554 | extern CHAR16 *gAdjustNumber;\r | |
ebe43565 | 555 | extern CHAR16 *gSaveChanges;\r |
8d00a0f1 | 556 | extern CHAR16 *gOptionMismatch;\r |
0c66bc76 | 557 | extern CHAR16 *gFormSuppress;\r |
7936fb6a | 558 | \r |
559 | extern CHAR16 gPromptBlockWidth;\r | |
560 | extern CHAR16 gOptionBlockWidth;\r | |
561 | extern CHAR16 gHelpBlockWidth;\r | |
562 | \r | |
563 | extern EFI_GUID gZeroGuid;\r | |
564 | extern EFI_GUID gTianoHiiIfrGuid;\r | |
565 | \r | |
eccfeab1 | 566 | #include "Ui.h"\r |
7936fb6a | 567 | //\r |
568 | // Global Procedure Defines\r | |
569 | //\r | |
570 | \r | |
571 | /**\r | |
572 | Initialize the HII String Token to the correct values.\r | |
573 | \r | |
574 | **/\r | |
575 | VOID\r | |
576 | InitializeBrowserStrings (\r | |
577 | VOID\r | |
ed66e1bc | 578 | );\r |
7936fb6a | 579 | \r |
580 | /**\r | |
581 | Prints a unicode string to the default console,\r | |
582 | using L"%s" format.\r | |
583 | \r | |
584 | @param String String pointer.\r | |
585 | \r | |
586 | @return Length of string printed to the console\r | |
587 | \r | |
588 | **/\r | |
589 | UINTN\r | |
590 | PrintString (\r | |
591 | IN CHAR16 *String\r | |
ed66e1bc | 592 | );\r |
7936fb6a | 593 | \r |
594 | /**\r | |
595 | Prints a chracter to the default console,\r | |
596 | using L"%c" format.\r | |
597 | \r | |
598 | @param Character Character to print.\r | |
599 | \r | |
600 | @return Length of string printed to the console.\r | |
601 | \r | |
602 | **/\r | |
603 | UINTN\r | |
604 | PrintChar (\r | |
605 | CHAR16 Character\r | |
ed66e1bc | 606 | );\r |
7936fb6a | 607 | \r |
608 | /**\r | |
609 | Prints a formatted unicode string to the default console, at\r | |
610 | the supplied cursor position.\r | |
611 | \r | |
612 | @param Column The cursor position to print the string at.\r | |
613 | @param Row The cursor position to print the string at\r | |
614 | @param Fmt Format string\r | |
615 | @param ... Variable argument list for formating string.\r | |
616 | \r | |
617 | @return Length of string printed to the console\r | |
618 | \r | |
619 | **/\r | |
620 | UINTN\r | |
621 | PrintAt (\r | |
622 | IN UINTN Column,\r | |
623 | IN UINTN Row,\r | |
624 | IN CHAR16 *Fmt,\r | |
625 | ...\r | |
ed66e1bc | 626 | );\r |
7936fb6a | 627 | \r |
628 | /**\r | |
629 | Prints a unicode string to the default console, at\r | |
630 | the supplied cursor position, using L"%s" format.\r | |
631 | \r | |
632 | @param Column The cursor position to print the string at.\r | |
633 | @param Row The cursor position to print the string at\r | |
634 | @param String String pointer.\r | |
635 | \r | |
636 | @return Length of string printed to the console\r | |
637 | \r | |
638 | **/\r | |
639 | UINTN\r | |
640 | PrintStringAt (\r | |
641 | IN UINTN Column,\r | |
642 | IN UINTN Row,\r | |
643 | IN CHAR16 *String\r | |
ed66e1bc | 644 | );\r |
7936fb6a | 645 | \r |
646 | /**\r | |
647 | Prints a chracter to the default console, at\r | |
648 | the supplied cursor position, using L"%c" format.\r | |
649 | \r | |
650 | @param Column The cursor position to print the string at.\r | |
651 | @param Row The cursor position to print the string at.\r | |
652 | @param Character Character to print.\r | |
653 | \r | |
654 | @return Length of string printed to the console.\r | |
655 | \r | |
656 | **/\r | |
657 | UINTN\r | |
658 | PrintCharAt (\r | |
659 | IN UINTN Column,\r | |
660 | IN UINTN Row,\r | |
661 | CHAR16 Character\r | |
ed66e1bc | 662 | );\r |
7936fb6a | 663 | \r |
664 | /**\r | |
665 | Parse opcodes in the formset IFR binary.\r | |
666 | \r | |
667 | @param FormSet Pointer of the FormSet data structure.\r | |
668 | \r | |
669 | @retval EFI_SUCCESS Opcode parse success.\r | |
670 | @retval Other Opcode parse fail.\r | |
671 | \r | |
672 | **/\r | |
673 | EFI_STATUS\r | |
674 | ParseOpCodes (\r | |
675 | IN FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 676 | );\r |
7936fb6a | 677 | \r |
678 | /**\r | |
679 | Free resources allocated for a FormSet.\r | |
680 | \r | |
681 | @param FormSet Pointer of the FormSet\r | |
682 | \r | |
683 | **/\r | |
684 | VOID\r | |
685 | DestroyFormSet (\r | |
686 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 687 | );\r |
7936fb6a | 688 | \r |
689 | /**\r | |
690 | This function displays the page frame.\r | |
691 | \r | |
692 | **/\r | |
693 | VOID\r | |
694 | DisplayPageFrame (\r | |
695 | VOID\r | |
ed66e1bc | 696 | );\r |
7936fb6a | 697 | \r |
698 | /**\r | |
699 | Create a new string in HII Package List.\r | |
700 | \r | |
701 | @param String The String to be added\r | |
702 | @param HiiHandle The package list in the HII database to insert the\r | |
703 | specified string.\r | |
704 | \r | |
705 | @return The output string.\r | |
706 | \r | |
707 | **/\r | |
708 | EFI_STRING_ID\r | |
709 | NewString (\r | |
710 | IN CHAR16 *String,\r | |
711 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 712 | );\r |
7936fb6a | 713 | \r |
714 | /**\r | |
715 | Delete a string from HII Package List.\r | |
716 | \r | |
717 | @param StringId Id of the string in HII database.\r | |
718 | @param HiiHandle The HII package list handle.\r | |
719 | \r | |
720 | @retval EFI_SUCCESS The string was deleted successfully.\r | |
721 | \r | |
722 | **/\r | |
723 | EFI_STATUS\r | |
724 | DeleteString (\r | |
725 | IN EFI_STRING_ID StringId,\r | |
726 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 727 | );\r |
7936fb6a | 728 | \r |
729 | /**\r | |
730 | Get the string based on the StringId and HII Package List Handle.\r | |
731 | \r | |
732 | @param Token The String's ID.\r | |
733 | @param HiiHandle The package list in the HII database to search for\r | |
734 | the specified string.\r | |
735 | \r | |
736 | @return The output string.\r | |
737 | \r | |
738 | **/\r | |
739 | CHAR16 *\r | |
740 | GetToken (\r | |
741 | IN EFI_STRING_ID Token,\r | |
742 | IN EFI_HII_HANDLE HiiHandle\r | |
ed66e1bc | 743 | );\r |
7936fb6a | 744 | \r |
745 | /**\r | |
746 | Draw a pop up windows based on the dimension, number of lines and\r | |
747 | strings specified.\r | |
748 | \r | |
749 | @param RequestedWidth The width of the pop-up.\r | |
750 | @param NumberOfLines The number of lines.\r | |
f4bcc90f | 751 | @param Marker The variable argument list for the list of string to be printed.\r |
7936fb6a | 752 | \r |
753 | **/\r | |
754 | VOID\r | |
755 | CreateSharedPopUp (\r | |
756 | IN UINTN RequestedWidth,\r | |
757 | IN UINTN NumberOfLines,\r | |
f4bcc90f | 758 | IN VA_LIST Marker\r |
ed66e1bc | 759 | );\r |
7936fb6a | 760 | \r |
761 | /**\r | |
762 | Routine used to abstract a generic dialog interface and return the selected key or string\r | |
763 | \r | |
764 | @param NumberOfLines The number of lines for the dialog box\r | |
765 | @param HotKey Defines whether a single character is parsed\r | |
766 | (TRUE) and returned in KeyValue or a string is\r | |
767 | returned in StringBuffer. Two special characters\r | |
768 | are considered when entering a string, a SCAN_ESC\r | |
769 | and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates\r | |
770 | string input and returns\r | |
771 | @param MaximumStringSize The maximum size in bytes of a typed in string\r | |
772 | (each character is a CHAR16) and the minimum\r | |
773 | string returned is two bytes\r | |
774 | @param StringBuffer The passed in pointer to the buffer which will\r | |
775 | hold the typed in string if HotKey is FALSE\r | |
776 | @param KeyValue The EFI_KEY value returned if HotKey is TRUE..\r | |
7936fb6a | 777 | @param ... A series of (quantity == NumberOfLines) text\r |
778 | strings which will be used to construct the dialog\r | |
779 | box\r | |
780 | \r | |
781 | @retval EFI_SUCCESS Displayed dialog and received user interaction\r | |
782 | @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.\r | |
783 | (StringBuffer == NULL) && (HotKey == FALSE))\r | |
784 | @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine\r | |
785 | \r | |
786 | **/\r | |
787 | EFI_STATUS\r | |
788 | CreateDialog (\r | |
789 | IN UINTN NumberOfLines,\r | |
790 | IN BOOLEAN HotKey,\r | |
791 | IN UINTN MaximumStringSize,\r | |
792 | OUT CHAR16 *StringBuffer,\r | |
793 | OUT EFI_INPUT_KEY *KeyValue,\r | |
7936fb6a | 794 | ...\r |
ed66e1bc | 795 | );\r |
7936fb6a | 796 | \r |
797 | /**\r | |
798 | Get Question's current Value.\r | |
799 | \r | |
800 | @param FormSet FormSet data structure.\r | |
801 | @param Form Form data structure.\r | |
802 | @param Question Question to be initialized.\r | |
803 | @param Cached TRUE: get from Edit copy FALSE: get from original\r | |
804 | Storage\r | |
805 | \r | |
806 | @retval EFI_SUCCESS The function completed successfully.\r | |
807 | \r | |
808 | **/\r | |
809 | EFI_STATUS\r | |
810 | GetQuestionValue (\r | |
811 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
812 | IN FORM_BROWSER_FORM *Form,\r | |
813 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
814 | IN BOOLEAN Cached\r | |
ed66e1bc | 815 | );\r |
7936fb6a | 816 | \r |
817 | /**\r | |
818 | Save Question Value to edit copy(cached) or Storage(uncached).\r | |
819 | \r | |
820 | @param FormSet FormSet data structure.\r | |
821 | @param Form Form data structure.\r | |
822 | @param Question Pointer to the Question.\r | |
823 | @param Cached TRUE: set to Edit copy FALSE: set to original\r | |
824 | Storage\r | |
825 | \r | |
826 | @retval EFI_SUCCESS The function completed successfully.\r | |
827 | \r | |
828 | **/\r | |
829 | EFI_STATUS\r | |
830 | SetQuestionValue (\r | |
831 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
832 | IN FORM_BROWSER_FORM *Form,\r | |
833 | IN OUT FORM_BROWSER_STATEMENT *Question,\r | |
834 | IN BOOLEAN Cached\r | |
ed66e1bc | 835 | );\r |
7936fb6a | 836 | \r |
837 | /**\r | |
838 | Perform inconsistent check for a Form.\r | |
839 | \r | |
840 | @param FormSet FormSet data structure.\r | |
841 | @param Form Form data structure.\r | |
842 | @param Question The Question to be validated.\r | |
843 | @param Type Validation type: InConsistent or NoSubmit\r | |
844 | \r | |
845 | @retval EFI_SUCCESS Form validation pass.\r | |
846 | @retval other Form validation failed.\r | |
847 | \r | |
848 | **/\r | |
849 | EFI_STATUS\r | |
850 | ValidateQuestion (\r | |
851 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
852 | IN FORM_BROWSER_FORM *Form,\r | |
853 | IN FORM_BROWSER_STATEMENT *Question,\r | |
854 | IN UINTN Type\r | |
ed66e1bc | 855 | );\r |
7936fb6a | 856 | \r |
857 | /**\r | |
858 | Submit a Form.\r | |
859 | \r | |
860 | @param FormSet FormSet data structure.\r | |
861 | @param Form Form data structure.\r | |
862 | \r | |
863 | @retval EFI_SUCCESS The function completed successfully.\r | |
864 | \r | |
865 | **/\r | |
866 | EFI_STATUS\r | |
867 | SubmitForm (\r | |
868 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
869 | IN FORM_BROWSER_FORM *Form\r | |
ed66e1bc | 870 | );\r |
7936fb6a | 871 | \r |
872 | /**\r | |
873 | Reset Question to its default value.\r | |
874 | \r | |
875 | @param FormSet The form set.\r | |
876 | @param Form The form.\r | |
877 | @param Question The question.\r | |
878 | @param DefaultId The Class of the default.\r | |
879 | \r | |
880 | @retval EFI_SUCCESS Question is reset to default value.\r | |
881 | \r | |
882 | **/\r | |
883 | EFI_STATUS\r | |
884 | GetQuestionDefault (\r | |
885 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
886 | IN FORM_BROWSER_FORM *Form,\r | |
887 | IN FORM_BROWSER_STATEMENT *Question,\r | |
888 | IN UINT16 DefaultId\r | |
ed66e1bc | 889 | );\r |
7936fb6a | 890 | \r |
891 | /**\r | |
892 | Get current setting of Questions.\r | |
893 | \r | |
894 | @param FormSet FormSet data structure.\r | |
895 | \r | |
896 | @retval EFI_SUCCESS The function completed successfully.\r | |
897 | \r | |
898 | **/\r | |
899 | EFI_STATUS\r | |
900 | InitializeCurrentSetting (\r | |
901 | IN OUT FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 902 | );\r |
7936fb6a | 903 | \r |
904 | /**\r | |
905 | Initialize the internal data structure of a FormSet.\r | |
906 | \r | |
907 | @param Handle PackageList Handle\r | |
908 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
909 | GUID), take the first FormSet found in package\r | |
910 | list.\r | |
911 | @param FormSet FormSet data structure.\r | |
912 | \r | |
913 | @retval EFI_SUCCESS The function completed successfully.\r | |
914 | @retval EFI_NOT_FOUND The specified FormSet could not be found.\r | |
915 | \r | |
916 | **/\r | |
917 | EFI_STATUS\r | |
918 | InitializeFormSet (\r | |
919 | IN EFI_HII_HANDLE Handle,\r | |
920 | IN OUT EFI_GUID *FormSetGuid,\r | |
921 | OUT FORM_BROWSER_FORMSET *FormSet\r | |
ed66e1bc | 922 | );\r |
7936fb6a | 923 | \r |
924 | /**\r | |
925 | Reset Questions in a Form to their default value.\r | |
926 | \r | |
927 | @param FormSet FormSet data structure.\r | |
928 | @param Form The Form which to be reset.\r | |
929 | @param DefaultId The Class of the default.\r | |
930 | \r | |
931 | @retval EFI_SUCCESS The function completed successfully.\r | |
932 | \r | |
933 | **/\r | |
934 | EFI_STATUS\r | |
935 | ExtractFormDefault (\r | |
936 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
937 | IN FORM_BROWSER_FORM *Form,\r | |
938 | IN UINT16 DefaultId\r | |
ed66e1bc | 939 | );\r |
7936fb6a | 940 | \r |
941 | /**\r | |
942 | Initialize Question's Edit copy from Storage.\r | |
943 | \r | |
eccfeab1 LG |
944 | @param Selection Selection contains the information about \r |
945 | the Selection, form and formset to be displayed.\r | |
946 | Selection action may be updated in retrieve callback.\r | |
7936fb6a | 947 | @param FormSet FormSet data structure.\r |
948 | @param Form Form data structure.\r | |
949 | \r | |
950 | @retval EFI_SUCCESS The function completed successfully.\r | |
951 | \r | |
952 | **/\r | |
953 | EFI_STATUS\r | |
954 | LoadFormConfig (\r | |
eccfeab1 LG |
955 | IN OUT UI_MENU_SELECTION *Selection,\r |
956 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
957 | IN FORM_BROWSER_FORM *Form\r | |
ed66e1bc | 958 | );\r |
7936fb6a | 959 | \r |
d66e6c16 | 960 | /**\r |
961 | Initialize Question's Edit copy from Storage for the whole Formset.\r | |
962 | \r | |
eccfeab1 LG |
963 | @param Selection Selection contains the information about \r |
964 | the Selection, form and formset to be displayed.\r | |
965 | Selection action may be updated in retrieve callback.\r | |
d66e6c16 | 966 | @param FormSet FormSet data structure.\r |
967 | \r | |
968 | @retval EFI_SUCCESS The function completed successfully.\r | |
969 | \r | |
970 | **/\r | |
971 | EFI_STATUS\r | |
972 | LoadFormSetConfig (\r | |
eccfeab1 LG |
973 | IN OUT UI_MENU_SELECTION *Selection,\r |
974 | IN FORM_BROWSER_FORMSET *FormSet\r | |
d66e6c16 | 975 | );\r |
976 | \r | |
7936fb6a | 977 | /**\r |
978 | Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.\r | |
979 | \r | |
980 | @param Storage The Storage to be conveted.\r | |
981 | @param ConfigResp The returned <ConfigResp>.\r | |
982 | \r | |
983 | @retval EFI_SUCCESS Convert success.\r | |
984 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
985 | \r | |
986 | **/\r | |
987 | EFI_STATUS\r | |
988 | StorageToConfigResp (\r | |
989 | IN FORMSET_STORAGE *Storage,\r | |
990 | IN CHAR16 **ConfigResp\r | |
ed66e1bc | 991 | );\r |
7936fb6a | 992 | \r |
993 | /**\r | |
994 | Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.\r | |
995 | \r | |
996 | @param Storage The Storage to receive the settings.\r | |
997 | @param ConfigResp The <ConfigResp> to be converted.\r | |
998 | \r | |
999 | @retval EFI_SUCCESS Convert success.\r | |
1000 | @retval EFI_INVALID_PARAMETER Incorrect storage type.\r | |
1001 | \r | |
1002 | **/\r | |
1003 | EFI_STATUS\r | |
1004 | ConfigRespToStorage (\r | |
1005 | IN FORMSET_STORAGE *Storage,\r | |
1006 | IN CHAR16 *ConfigResp\r | |
ed66e1bc | 1007 | );\r |
7936fb6a | 1008 | \r |
1009 | /**\r | |
1010 | Fill storage's edit copy with settings requested from Configuration Driver.\r | |
1011 | \r | |
1012 | @param FormSet FormSet data structure.\r | |
1013 | @param Storage Buffer Storage.\r | |
1014 | \r | |
1015 | @retval EFI_SUCCESS The function completed successfully.\r | |
1016 | \r | |
1017 | **/\r | |
1018 | EFI_STATUS\r | |
1019 | LoadStorage (\r | |
1020 | IN FORM_BROWSER_FORMSET *FormSet,\r | |
1021 | IN FORMSET_STORAGE *Storage\r | |
ed66e1bc | 1022 | );\r |
7936fb6a | 1023 | \r |
1024 | /**\r | |
1025 | Fetch the Ifr binary data of a FormSet.\r | |
1026 | \r | |
1027 | @param Handle PackageList Handle\r | |
1028 | @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r | |
1029 | GUID), take the first FormSet found in package\r | |
1030 | list.\r | |
1031 | @param BinaryLength The length of the FormSet IFR binary.\r | |
1032 | @param BinaryData The buffer designed to receive the FormSet.\r | |
1033 | \r | |
1034 | @retval EFI_SUCCESS Buffer filled with the requested FormSet.\r | |
1035 | BufferLength was updated.\r | |
1036 | @retval EFI_INVALID_PARAMETER The handle is unknown.\r | |
1037 | @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot\r | |
1038 | be found with the requested FormId.\r | |
1039 | \r | |
1040 | **/\r | |
1041 | EFI_STATUS\r | |
1042 | GetIfrBinaryData (\r | |
1043 | IN EFI_HII_HANDLE Handle,\r | |
1044 | IN OUT EFI_GUID *FormSetGuid,\r | |
1045 | OUT UINTN *BinaryLength,\r | |
1046 | OUT UINT8 **BinaryData\r | |
ed66e1bc | 1047 | );\r |
7936fb6a | 1048 | \r |
ce6d12cc | 1049 | /**\r |
1050 | Save globals used by previous call to SendForm(). SendForm() may be called from \r | |
1051 | HiiConfigAccess.Callback(), this will cause SendForm() be reentried.\r | |
1052 | So, save globals of previous call to SendForm() and restore them upon exit.\r | |
1053 | \r | |
1054 | **/\r | |
1055 | VOID\r | |
1056 | SaveBrowserContext (\r | |
1057 | VOID\r | |
1058 | );\r | |
1059 | \r | |
1060 | /**\r | |
1061 | Restore globals used by previous call to SendForm().\r | |
1062 | \r | |
1063 | **/\r | |
1064 | VOID\r | |
1065 | RestoreBrowserContext (\r | |
1066 | VOID\r | |
1067 | );\r | |
1068 | \r | |
7936fb6a | 1069 | /**\r |
1070 | This is the routine which an external caller uses to direct the browser\r | |
1071 | where to obtain it's information.\r | |
1072 | \r | |
1073 | \r | |
1074 | @param This The Form Browser protocol instanse.\r | |
1075 | @param Handles A pointer to an array of Handles. If HandleCount > 1 we\r | |
1076 | display a list of the formsets for the handles specified.\r | |
1077 | @param HandleCount The number of Handles specified in Handle.\r | |
1078 | @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r | |
1079 | field in the EFI_IFR_FORM_SET op-code for the specified\r | |
1080 | forms-based package. If FormSetGuid is NULL, then this\r | |
1081 | function will display the first found forms package.\r | |
1082 | @param FormId This field specifies which EFI_IFR_FORM to render as the first\r | |
1083 | displayable page. If this field has a value of 0x0000, then\r | |
1084 | the forms browser will render the specified forms in their encoded order.\r | |
1085 | ScreenDimenions - This allows the browser to be called so that it occupies a\r | |
1086 | portion of the physical screen instead of dynamically determining the screen dimensions.\r | |
1087 | ActionRequest - Points to the action recommended by the form.\r | |
d66e6c16 | 1088 | @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r |
7936fb6a | 1089 | characters.\r |
1090 | @param ActionRequest Points to the action recommended by the form.\r | |
1091 | \r | |
1092 | @retval EFI_SUCCESS The function completed successfully.\r | |
1093 | @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r | |
1094 | @retval EFI_NOT_FOUND No valid forms could be found to display.\r | |
1095 | \r | |
1096 | **/\r | |
1097 | EFI_STATUS\r | |
1098 | EFIAPI\r | |
1099 | SendForm (\r | |
1100 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
1101 | IN EFI_HII_HANDLE *Handles,\r | |
1102 | IN UINTN HandleCount,\r | |
1103 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
1104 | IN UINT16 FormId, OPTIONAL\r | |
1105 | IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r | |
1106 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r | |
ed66e1bc | 1107 | );\r |
7936fb6a | 1108 | \r |
1109 | /**\r | |
1110 | This function is called by a callback handler to retrieve uncommitted state\r | |
1111 | data from the browser.\r | |
1112 | \r | |
1113 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL\r | |
1114 | instance.\r | |
1115 | @param ResultsDataSize A pointer to the size of the buffer associated\r | |
1116 | with ResultsData.\r | |
1117 | @param ResultsData A string returned from an IFR browser or\r | |
1118 | equivalent. The results string will have no\r | |
1119 | routing information in them.\r | |
1120 | @param RetrieveData A BOOLEAN field which allows an agent to retrieve\r | |
1121 | (if RetrieveData = TRUE) data from the uncommitted\r | |
1122 | browser state information or set (if RetrieveData\r | |
1123 | = FALSE) data in the uncommitted browser state\r | |
1124 | information.\r | |
1125 | @param VariableGuid An optional field to indicate the target variable\r | |
1126 | GUID name to use.\r | |
1127 | @param VariableName An optional field to indicate the target\r | |
1128 | human-readable variable name.\r | |
1129 | \r | |
1130 | @retval EFI_SUCCESS The results have been distributed or are awaiting\r | |
1131 | distribution.\r | |
1132 | @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to\r | |
1133 | contain the results data.\r | |
1134 | \r | |
1135 | **/\r | |
1136 | EFI_STATUS\r | |
1137 | EFIAPI\r | |
1138 | BrowserCallback (\r | |
1139 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r | |
1140 | IN OUT UINTN *ResultsDataSize,\r | |
1141 | IN OUT EFI_STRING ResultsData,\r | |
1142 | IN BOOLEAN RetrieveData,\r | |
1143 | IN CONST EFI_GUID *VariableGuid, OPTIONAL\r | |
1144 | IN CONST CHAR16 *VariableName OPTIONAL\r | |
ed66e1bc | 1145 | );\r |
7936fb6a | 1146 | \r |
1147 | #endif\r |