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