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