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