Setup.h@ 54985

Last change on this file since 54985 was 48674, checked in by vboxsync, 11 years ago
EFI: Export newly imported tinaocore UEFI sources to OSE.
Property svn:eol-style set to `native`
File size: 48.2 KB

Line
1	/** @file
2	Private MACRO, structure and function definitions for Setup Browser module.
3
4	Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.<BR>
5	This program and the accompanying materials
6	are licensed and made available under the terms and conditions of the BSD License
7	which accompanies this distribution. The full text of the license may be found at
8	http://opensource.org/licenses/bsd-license.php
9
10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13
14	**/
15
16	#ifndef _SETUP_H_
17	#define _SETUP_H_
18
19
20	#include <PiDxe.h>
21
22	#include <Protocol/SimpleTextOut.h>
23	#include <Protocol/SimpleTextIn.h>
24	#include <Protocol/FormBrowser2.h>
25	#include <Protocol/FormBrowserEx.h>
26	#include <Protocol/DevicePath.h>
27	#include <Protocol/UnicodeCollation.h>
28	#include <Protocol/HiiConfigAccess.h>
29	#include <Protocol/HiiConfigRouting.h>
30	#include <Protocol/HiiDatabase.h>
31	#include <Protocol/HiiString.h>
32	#include <Protocol/UserManager.h>
33
34	#include <Guid/MdeModuleHii.h>
35	#include <Guid/HiiPlatformSetupFormset.h>
36	#include <Guid/HiiFormMapMethodGuid.h>
37
38	#include <Library/PrintLib.h>
39	#include <Library/DebugLib.h>
40	#include <Library/BaseMemoryLib.h>
41	#include <Library/UefiRuntimeServicesTableLib.h>
42	#include <Library/UefiDriverEntryPoint.h>
43	#include <Library/UefiBootServicesTableLib.h>
44	#include <Library/BaseLib.h>
45	#include <Library/MemoryAllocationLib.h>
46	#include <Library/HiiLib.h>
47	#include <Library/PcdLib.h>
48	#include <Library/DevicePathLib.h>
49
50	#include "Colors.h"
51
52	//
53	// This is the generated header file which includes whatever needs to be exported (strings + IFR)
54	//
55
56	extern UINT8 SetupBrowserStrings[];
57
58	//
59	// Screen definitions
60	//
61	#define BANNER_HEIGHT 6
62	#define BANNER_COLUMNS 3
63	#define BANNER_LEFT_COLUMN_INDENT 1
64
65	#define FRONT_PAGE_HEADER_HEIGHT 6
66	#define NONE_FRONT_PAGE_HEADER_HEIGHT 3
67	#define LEFT_SKIPPED_COLUMNS 3
68	#define FOOTER_HEIGHT 4
69	#define STATUS_BAR_HEIGHT 1
70	#define SCROLL_ARROW_HEIGHT 1
71	#define POPUP_PAD_SPACE_COUNT 5
72	#define POPUP_FRAME_WIDTH 2
73
74	//
75	// Definition for function key setting
76	//
77	#define NONE_FUNCTION_KEY_SETTING 0
78	#define ENABLE_FUNCTION_KEY_SETTING 1
79
80	typedef struct {
81	EFI_GUID FormSetGuid;
82	UINTN KeySetting;
83	} FUNCTIION_KEY_SETTING;
84
85	//
86	// Character definitions
87	//
88	#define CHAR_SPACE 0x0020
89	#define UPPER_LOWER_CASE_OFFSET 0x20
90
91	//
92	// Time definitions
93	//
94	#define ONE_SECOND 10000000
95
96	//
97	// Display definitions
98	//
99	#define LEFT_HYPER_DELIMITER L'<'
100	#define RIGHT_HYPER_DELIMITER L'>'
101
102	#define LEFT_ONEOF_DELIMITER L'<'
103	#define RIGHT_ONEOF_DELIMITER L'>'
104
105	#define LEFT_NUMERIC_DELIMITER L'['
106	#define RIGHT_NUMERIC_DELIMITER L']'
107
108	#define LEFT_CHECKBOX_DELIMITER L'['
109	#define RIGHT_CHECKBOX_DELIMITER L']'
110
111	#define CHECK_ON L'X'
112	#define CHECK_OFF L' '
113
114	#define TIME_SEPARATOR L':'
115	#define DATE_SEPARATOR L'/'
116
117	#define YES_ANSWER L'Y'
118	#define NO_ANSWER L'N'
119
120	//
121	// This is the Input Error Message
122	//
123	#define INPUT_ERROR 1
124
125	//
126	// This is the NV RAM update required Message
127	//
128	#define NV_UPDATE_REQUIRED 2
129
130	//
131	// Refresh the Status Bar with flags
132	//
133	#define REFRESH_STATUS_BAR 0xff
134
135	//
136	// Incremental string lenght of ConfigRequest
137	//
138	#define CONFIG_REQUEST_STRING_INCREMENTAL 1024
139
140	//
141	// HII value compare result
142	//
143	#define HII_VALUE_UNDEFINED 0
144	#define HII_VALUE_EQUAL 1
145	#define HII_VALUE_LESS_THAN 2
146	#define HII_VALUE_GREATER_THAN 3
147
148	//
149	// Incremental size of stack for expression
150	//
151	#define EXPRESSION_STACK_SIZE_INCREMENT 0x100
152
153	#define EFI_IFR_SPECIFICATION_VERSION (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) \| (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) \| ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))
154
155
156	#define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
157	typedef struct {
158	UINT32 Signature;
159
160	EFI_HANDLE Handle;
161
162	//
163	// Produced protocol
164	//
165	EFI_FORM_BROWSER2_PROTOCOL FormBrowser2;
166
167	EFI_FORM_BROWSER_EXTENSION_PROTOCOL FormBrowserEx;
168
169	} SETUP_DRIVER_PRIVATE_DATA;
170
171	typedef struct {
172	EFI_STRING_ID Banner[BANNER_HEIGHT][BANNER_COLUMNS];
173	} BANNER_DATA;
174
175	//
176	// IFR relative definition
177	//
178	#define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
179	#define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
180	#define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
181	#define EFI_HII_EXPRESSION_SUPPRESS_IF 3
182	#define EFI_HII_EXPRESSION_DISABLE_IF 4
183	#define EFI_HII_EXPRESSION_VALUE 5
184	#define EFI_HII_EXPRESSION_RULE 6
185	#define EFI_HII_EXPRESSION_READ 7
186	#define EFI_HII_EXPRESSION_WRITE 8
187
188	#define EFI_HII_VARSTORE_BUFFER 0
189	#define EFI_HII_VARSTORE_NAME_VALUE 1
190	#define EFI_HII_VARSTORE_EFI_VARIABLE 2
191	#define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3
192
193	#define FORM_INCONSISTENT_VALIDATION 0
194	#define FORM_NO_SUBMIT_VALIDATION 1
195
196	#define FORMSET_CLASS_PLATFORM_SETUP 0x0001
197	#define FORMSET_CLASS_FRONT_PAGE 0x0002
198
199	typedef struct {
200	UINT8 Type;
201	UINT8 *Buffer;
202	UINT16 BufferLen;
203	EFI_IFR_TYPE_VALUE Value;
204	} EFI_HII_VALUE;
205
206	#define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
207
208	typedef struct {
209	UINTN Signature;
210	LIST_ENTRY Link;
211	CHAR16 *Name;
212	CHAR16 *Value;
213	CHAR16 *EditValue;
214	} NAME_VALUE_NODE;
215
216	#define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
217
218	#define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
219
220	typedef struct {
221	UINTN Signature;
222	LIST_ENTRY Link;
223
224	UINT8 Type; // Storage type
225
226	UINT16 VarStoreId;
227	EFI_GUID Guid;
228
229	CHAR16 *Name; // For EFI_IFR_VARSTORE
230	UINT16 Size;
231	UINT8 *Buffer;
232	UINT8 *EditBuffer; // Edit copy for Buffer Storage
233
234	LIST_ENTRY NameValueListHead; // List of NAME_VALUE_NODE
235
236	UINT32 Attributes; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
237
238	CHAR16 *ConfigHdr; // <ConfigHdr>
239	CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
240	UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>
241	UINTN SpareStrLen; // Spare length of ConfigRequest string buffer
242	} FORMSET_STORAGE;
243
244	#define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
245
246	typedef union {
247	EFI_STRING_ID VarName;
248	UINT16 VarOffset;
249	} VAR_STORE_INFO;
250
251	#define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
252
253	typedef struct {
254	UINTN Signature;
255	LIST_ENTRY Link;
256
257	UINT8 Operand;
258
259	UINT8 Format; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
260	UINT8 Flags; // For EFI_IFR_SPAN
261	UINT8 RuleId; // For EFI_IFR_RULE_REF
262
263	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
264
265	EFI_QUESTION_ID QuestionId; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
266	EFI_QUESTION_ID QuestionId2;
267
268	UINT16 ListLength; // For EFI_IFR_EQ_ID_VAL_LIST
269	UINT16 *ValueList;
270
271	EFI_STRING_ID DevicePath; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
272	EFI_GUID Guid;
273
274	FORMSET_STORAGE *VarStorage; // For EFI_IFR_SET, EFI_IFR_GET
275	VAR_STORE_INFO VarStoreInfo;// For EFI_IFR_SET, EFI_IFR_GET
276	UINT8 ValueType; // For EFI_IFR_SET, EFI_IFR_GET
277	UINT8 ValueWidth; // For EFI_IFR_SET, EFI_IFR_GET
278	CHAR16 *ValueName; // For EFI_IFR_SET, EFI_IFR_GET
279	LIST_ENTRY MapExpressionList; // nested expressions inside of Map opcode.
280	} EXPRESSION_OPCODE;
281
282	#define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
283
284	#define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
285
286	typedef struct {
287	UINTN Signature;
288	LIST_ENTRY Link;
289
290	UINT8 Type; // Type for this expression
291
292	UINT8 RuleId; // For EFI_IFR_RULE only
293	EFI_STRING_ID Error; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
294
295	EFI_HII_VALUE Result; // Expression evaluation result
296
297	LIST_ENTRY OpCodeListHead; // OpCodes consist of this expression (EXPRESSION_OPCODE)
298	} FORM_EXPRESSION;
299
300	#define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
301
302	#define FORM_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')
303
304	typedef struct {
305	UINTN Signature;
306	UINTN Count;
307	FORM_EXPRESSION *Expression[1]; // Array[Count] of expressions
308	} FORM_EXPRESSION_LIST;
309
310	#define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
311
312	typedef struct {
313	UINTN Signature;
314	LIST_ENTRY Link;
315
316	UINT16 DefaultId;
317	EFI_HII_VALUE Value; // Default value
318
319	FORM_EXPRESSION *ValueExpression; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
320	} QUESTION_DEFAULT;
321
322	#define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
323
324	#define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
325
326	typedef struct {
327	UINTN Signature;
328	LIST_ENTRY Link;
329
330	EFI_STRING_ID Text;
331	UINT8 Flags;
332	EFI_HII_VALUE Value;
333	EFI_IMAGE_ID ImageId;
334
335	FORM_EXPRESSION_LIST *SuppressExpression; // Non-NULL indicates nested inside of SuppressIf
336	} QUESTION_OPTION;
337
338	#define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
339
340	typedef enum {
341	ExpressFalse = 0,
342	ExpressGrayOut,
343	ExpressSuppress,
344	ExpressDisable
345	} EXPRESS_RESULT;
346
347	typedef enum {
348	ExpressNone = 0,
349	ExpressForm,
350	ExpressStatement,
351	ExpressOption
352	} EXPRESS_LEVEL;
353
354	#define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
355
356	typedef struct {
357	UINTN Signature;
358	LIST_ENTRY Link;
359
360	UINT8 Operand; // The operand (first byte) of this Statement or Question
361
362	//
363	// Statement Header
364	//
365	EFI_STRING_ID Prompt;
366	EFI_STRING_ID Help;
367	EFI_STRING_ID TextTwo; // For EFI_IFR_TEXT
368
369	//
370	// Question Header
371	//
372	EFI_QUESTION_ID QuestionId; // The value of zero is reserved
373	EFI_VARSTORE_ID VarStoreId; // A value of zero indicates no variable storage
374	FORMSET_STORAGE *Storage;
375	VAR_STORE_INFO VarStoreInfo;
376	UINT16 StorageWidth;
377	UINT8 QuestionFlags;
378	CHAR16 *VariableName; // Name/Value or EFI Variable name
379	CHAR16 *BlockName; // Buffer storage block name: "OFFSET=...WIDTH=..."
380
381	EFI_HII_VALUE HiiValue; // Edit copy for checkbox, numberic, oneof
382	UINT8 *BufferValue; // Edit copy for string, password, orderedlist
383	UINT8 ValueType; // Data type for orderedlist value array
384
385	//
386	// OpCode specific members
387	//
388	UINT8 Flags; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
389	// EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
390	UINT8 MaxContainers; // for EFI_IFR_ORDERED_LIST
391
392	UINT16 BannerLineNumber; // for EFI_IFR_BANNER, 1-based line number
393	EFI_STRING_ID QuestionConfig; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
394
395	UINT64 Minimum; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
396	UINT64 Maximum; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
397	UINT64 Step;
398
399	EFI_DEFAULT_ID DefaultId; // for EFI_IFR_RESET_BUTTON
400	EFI_GUID RefreshGuid; // for EFI_IFR_REFRESH_ID
401	BOOLEAN Locked; // Whether this statement is locked.
402	//
403	// Get from IFR parsing
404	//
405	FORM_EXPRESSION *ValueExpression; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
406	LIST_ENTRY DefaultListHead; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
407	LIST_ENTRY OptionListHead; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
408
409	EFI_IMAGE_ID ImageId; // nested EFI_IFR_IMAGE
410	UINT8 RefreshInterval; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
411	BOOLEAN InSubtitle; // nesting inside of EFI_IFR_SUBTITLE
412
413	LIST_ENTRY InconsistentListHead;// nested inconsistent expression list (FORM_EXPRESSION)
414	LIST_ENTRY NoSubmitListHead; // nested nosubmit expression list (FORM_EXPRESSION)
415	FORM_EXPRESSION_LIST *Expression; // nesting inside of GrayOutIf/DisableIf/SuppressIf
416
417	FORM_EXPRESSION *ReadExpression; // nested EFI_IFR_READ, provide this question value by read expression.
418	FORM_EXPRESSION *WriteExpression; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
419	} FORM_BROWSER_STATEMENT;
420
421	#define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
422
423	#define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
424	typedef struct {
425	UINTN Signature;
426	LIST_ENTRY Link;
427
428	CHAR16 *ConfigRequest; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
429	UINTN ElementCount; // Number of <RequestElement> in the <ConfigRequest>
430	UINTN SpareStrLen;
431
432	FORMSET_STORAGE *Storage;
433	} FORM_BROWSER_CONFIG_REQUEST;
434	#define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
435
436	#define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
437	#define STANDARD_MAP_FORM_TYPE 0x01
438
439	typedef struct {
440	UINTN Signature;
441	LIST_ENTRY Link;
442
443	UINT16 FormId; // FormId of normal form or formmap form.
444	EFI_STRING_ID FormTitle; // FormTile of normal form, or FormMapMethod title of formmap form.
445	UINT16 FormType; // Specific form type for the different form.
446
447	EFI_IMAGE_ID ImageId;
448
449	BOOLEAN ModalForm; // Whether this is a modal form.
450	BOOLEAN Locked; // Whether this form is locked.
451
452	BOOLEAN NvUpdateRequired; // Whether this form has NV update request.
453
454	LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)
455	LIST_ENTRY StatementListHead; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
456	LIST_ENTRY ConfigRequestHead; // List of configreques for all storage.
457	FORM_EXPRESSION_LIST *SuppressExpression; // nesting inside of SuppressIf
458	} FORM_BROWSER_FORM;
459
460	#define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
461
462	#define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
463
464	typedef struct {
465	UINTN Signature;
466	LIST_ENTRY Link;
467
468	UINT16 DefaultId;
469	EFI_STRING_ID DefaultName;
470	} FORMSET_DEFAULTSTORE;
471
472	#define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
473
474	#define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
475
476	typedef struct {
477	UINTN Signature;
478	LIST_ENTRY Link;
479	EFI_HII_HANDLE HiiHandle; // unique id for formset.
480	EFI_HANDLE DriverHandle;
481	EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
482	EFI_DEVICE_PATH_PROTOCOL *DevicePath;
483
484	UINTN IfrBinaryLength;
485	UINT8 *IfrBinaryData;
486
487	EFI_GUID Guid;
488	EFI_STRING_ID FormSetTitle;
489	EFI_STRING_ID Help;
490	UINT8 NumberOfClassGuid;
491	EFI_GUID ClassGuid[3]; // Up to three ClassGuid
492	UINT16 Class; // Tiano extended Class code
493	UINT16 SubClass; // Tiano extended Subclass code
494	EFI_IMAGE_ID ImageId;
495
496	FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions
497	EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode
498
499	LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)
500	LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)
501	LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)
502	LIST_ENTRY ExpressionListHead; // List of Expressions (FORM_EXPRESSION)
503	} FORM_BROWSER_FORMSET;
504
505	#define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
506
507	#define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
508
509	typedef struct {
510	UINTN Signature;
511	LIST_ENTRY Link;
512
513	//
514	// Globals defined in Setup.c
515	//
516	BANNER_DATA *BannerData;
517	UINTN ClassOfVfr;
518	UINTN FunctionKeySetting;
519	BOOLEAN ResetRequired;
520	UINT16 Direction;
521	EFI_SCREEN_DESCRIPTOR ScreenDimensions;
522	CHAR16 *EnterString;
523	CHAR16 *EnterCommitString;
524	CHAR16 *EnterEscapeString;
525	CHAR16 *EscapeString;
526	CHAR16 *MoveHighlight;
527	CHAR16 *MakeSelection;
528	CHAR16 *DecNumericInput;
529	CHAR16 *HexNumericInput;
530	CHAR16 *ToggleCheckBox;
531	CHAR16 *PromptForData;
532	CHAR16 *PromptForPassword;
533	CHAR16 *PromptForNewPassword;
534	CHAR16 *ConfirmPassword;
535	CHAR16 *ConfirmError;
536	CHAR16 *PassowordInvalid;
537	CHAR16 *PressEnter;
538	CHAR16 *EmptyString;
539	CHAR16 *AreYouSure;
540	CHAR16 *YesResponse;
541	CHAR16 *NoResponse;
542	CHAR16 *MiniString;
543	CHAR16 *PlusString;
544	CHAR16 *MinusString;
545	CHAR16 *AdjustNumber;
546	CHAR16 *SaveChanges;
547	CHAR16 *OptionMismatch;
548	CHAR16 *FormSuppress;
549	CHAR16 PromptBlockWidth;
550	CHAR16 OptionBlockWidth;
551	CHAR16 HelpBlockWidth;
552	FORM_BROWSER_FORMSET *OldFormSet;
553
554	//
555	// Globals defined in Ui.c
556	//
557	LIST_ENTRY MenuOption;
558	VOID *MenuRefreshHead;
559	} BROWSER_CONTEXT;
560
561	#define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
562
563	#define BROWSER_HOT_KEY_SIGNATURE SIGNATURE_32 ('B', 'H', 'K', 'S')
564
565	typedef struct {
566	UINTN Signature;
567	LIST_ENTRY Link;
568
569	EFI_INPUT_KEY *KeyData;
570	IN UINT32 Action;
571	IN UINT16 DefaultId;
572	IN EFI_STRING HelpString;
573	} BROWSER_HOT_KEY;
574
575	#define BROWSER_HOT_KEY_FROM_LINK(a) CR (a, BROWSER_HOT_KEY, Link, BROWSER_HOT_KEY_SIGNATURE)
576
577	extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;
578	extern EFI_HII_STRING_PROTOCOL *mHiiString;
579	extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;
580
581	extern BANNER_DATA *gBannerData;
582	extern EFI_HII_HANDLE gFrontPageHandle;
583	extern UINTN gClassOfVfr;
584	extern UINTN gFunctionKeySetting;
585	extern BOOLEAN gResetRequired;
586	extern EFI_HII_HANDLE gHiiHandle;
587	extern UINT16 gDirection;
588	extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;
589
590	extern FORM_BROWSER_FORMSET *gOldFormSet;
591	extern LIST_ENTRY gBrowserFormSetList;
592	extern LIST_ENTRY gBrowserHotKeyList;
593	extern BROWSER_SETTING_SCOPE gBrowserSettingScope;
594	extern EXIT_HANDLER ExitHandlerFunction;
595	extern UINTN gFooterHeight;
596
597	//
598	// Browser Global Strings
599	//
600	extern CHAR16 *gDiscardFailed;
601	extern CHAR16 *gDefaultFailed;
602	extern CHAR16 *gEnterString;
603	extern CHAR16 *gEnterCommitString;
604	extern CHAR16 *gEnterEscapeString;
605	extern CHAR16 *gEscapeString;
606	extern CHAR16 *gSaveFailed;
607	extern CHAR16 *gMoveHighlight;
608	extern CHAR16 *gMakeSelection;
609	extern CHAR16 *gDecNumericInput;
610	extern CHAR16 *gHexNumericInput;
611	extern CHAR16 *gToggleCheckBox;
612	extern CHAR16 *gPromptForData;
613	extern CHAR16 *gPromptForPassword;
614	extern CHAR16 *gPromptForNewPassword;
615	extern CHAR16 *gConfirmPassword;
616	extern CHAR16 *gConfirmError;
617	extern CHAR16 *gPassowordInvalid;
618	extern CHAR16 *gPressEnter;
619	extern CHAR16 *gEmptyString;
620	extern CHAR16 *gAreYouSure;
621	extern CHAR16 *gYesResponse;
622	extern CHAR16 *gNoResponse;
623	extern CHAR16 *gMiniString;
624	extern CHAR16 *gPlusString;
625	extern CHAR16 *gMinusString;
626	extern CHAR16 *gAdjustNumber;
627	extern CHAR16 *gSaveChanges;
628	extern CHAR16 *gOptionMismatch;
629	extern CHAR16 *gFormSuppress;
630
631	extern CHAR16 gPromptBlockWidth;
632	extern CHAR16 gOptionBlockWidth;
633	extern CHAR16 gHelpBlockWidth;
634
635	extern EFI_GUID gZeroGuid;
636	extern EFI_GUID gTianoHiiIfrGuid;
637
638	#include "Ui.h"
639	//
640	// Global Procedure Defines
641	//
642
643	/**
644	Initialize the HII String Token to the correct values.
645
646	**/
647	VOID
648	InitializeBrowserStrings (
649	VOID
650	);
651
652	/**
653	Prints a unicode string to the default console,
654	using L"%s" format.
655
656	@param String String pointer.
657
658	@return Length of string printed to the console
659
660	**/
661	UINTN
662	PrintString (
663	IN CHAR16 *String
664	);
665
666	/**
667	Prints a chracter to the default console,
668	using L"%c" format.
669
670	@param Character Character to print.
671
672	@return Length of string printed to the console.
673
674	**/
675	UINTN
676	PrintChar (
677	CHAR16 Character
678	);
679
680	/**
681	Prints a formatted unicode string to the default console, at
682	the supplied cursor position.
683
684	@param Column The cursor position to print the string at.
685	@param Row The cursor position to print the string at
686	@param Fmt Format string
687	@param ... Variable argument list for formating string.
688
689	@return Length of string printed to the console
690
691	**/
692	UINTN
693	EFIAPI
694	PrintAt (
695	IN UINTN Column,
696	IN UINTN Row,
697	IN CHAR16 *Fmt,
698	...
699	);
700
701	/**
702	Prints a unicode string to the default console, at
703	the supplied cursor position, using L"%s" format.
704
705	@param Column The cursor position to print the string at.
706	@param Row The cursor position to print the string at
707	@param String String pointer.
708
709	@return Length of string printed to the console
710
711	**/
712	UINTN
713	PrintStringAt (
714	IN UINTN Column,
715	IN UINTN Row,
716	IN CHAR16 *String
717	);
718
719	/**
720	Prints a chracter to the default console, at
721	the supplied cursor position, using L"%c" format.
722
723	@param Column The cursor position to print the string at.
724	@param Row The cursor position to print the string at.
725	@param Character Character to print.
726
727	@return Length of string printed to the console.
728
729	**/
730	UINTN
731	PrintCharAt (
732	IN UINTN Column,
733	IN UINTN Row,
734	CHAR16 Character
735	);
736
737	/**
738	Parse opcodes in the formset IFR binary.
739
740	@param FormSet Pointer of the FormSet data structure.
741
742	@retval EFI_SUCCESS Opcode parse success.
743	@retval Other Opcode parse fail.
744
745	**/
746	EFI_STATUS
747	ParseOpCodes (
748	IN FORM_BROWSER_FORMSET *FormSet
749	);
750
751	/**
752	Free resources allocated for a FormSet.
753
754	@param FormSet Pointer of the FormSet
755
756	**/
757	VOID
758	DestroyFormSet (
759	IN OUT FORM_BROWSER_FORMSET *FormSet
760	);
761
762	/**
763	This function displays the page frame.
764
765	@param Selection Selection contains the information about
766	the Selection, form and formset to be displayed.
767	Selection action may be updated in retrieve callback.
768	**/
769	VOID
770	DisplayPageFrame (
771	IN UI_MENU_SELECTION *Selection
772	);
773
774	/**
775	Create a new string in HII Package List.
776
777	@param String The String to be added
778	@param HiiHandle The package list in the HII database to insert the
779	specified string.
780
781	@return The output string.
782
783	**/
784	EFI_STRING_ID
785	NewString (
786	IN CHAR16 *String,
787	IN EFI_HII_HANDLE HiiHandle
788	);
789
790	/**
791	Delete a string from HII Package List.
792
793	@param StringId Id of the string in HII database.
794	@param HiiHandle The HII package list handle.
795
796	@retval EFI_SUCCESS The string was deleted successfully.
797
798	**/
799	EFI_STATUS
800	DeleteString (
801	IN EFI_STRING_ID StringId,
802	IN EFI_HII_HANDLE HiiHandle
803	);
804
805	/**
806	Get the string based on the StringId and HII Package List Handle.
807
808	@param Token The String's ID.
809	@param HiiHandle The package list in the HII database to search for
810	the specified string.
811
812	@return The output string.
813
814	**/
815	CHAR16 *
816	GetToken (
817	IN EFI_STRING_ID Token,
818	IN EFI_HII_HANDLE HiiHandle
819	);
820
821	/**
822	Draw a pop up windows based on the dimension, number of lines and
823	strings specified.
824
825	@param RequestedWidth The width of the pop-up.
826	@param NumberOfLines The number of lines.
827	@param Marker The variable argument list for the list of string to be printed.
828
829	**/
830	VOID
831	CreateSharedPopUp (
832	IN UINTN RequestedWidth,
833	IN UINTN NumberOfLines,
834	IN VA_LIST Marker
835	);
836
837	/**
838	Routine used to abstract a generic dialog interface and return the selected key or string
839
840	@param NumberOfLines The number of lines for the dialog box
841	@param HotKey Defines whether a single character is parsed
842	(TRUE) and returned in KeyValue or a string is
843	returned in StringBuffer. Two special characters
844	are considered when entering a string, a SCAN_ESC
845	and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
846	string input and returns
847	@param MaximumStringSize The maximum size in bytes of a typed in string
848	(each character is a CHAR16) and the minimum
849	string returned is two bytes
850	@param StringBuffer The passed in pointer to the buffer which will
851	hold the typed in string if HotKey is FALSE
852	@param KeyValue The EFI_KEY value returned if HotKey is TRUE..
853	@param ... A series of (quantity == NumberOfLines) text
854	strings which will be used to construct the dialog
855	box
856
857	@retval EFI_SUCCESS Displayed dialog and received user interaction
858	@retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
859	(StringBuffer == NULL) && (HotKey == FALSE))
860	@retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
861
862	**/
863	EFI_STATUS
864	EFIAPI
865	CreateDialog (
866	IN UINTN NumberOfLines,
867	IN BOOLEAN HotKey,
868	IN UINTN MaximumStringSize,
869	OUT CHAR16 *StringBuffer,
870	OUT EFI_INPUT_KEY *KeyValue,
871	...
872	);
873
874	/**
875	Get Value for given Name from a NameValue Storage.
876
877	@param Storage The NameValue Storage.
878	@param Name The Name.
879	@param Value The retured Value.
880
881	@retval EFI_SUCCESS Value found for given Name.
882	@retval EFI_NOT_FOUND No such Name found in NameValue storage.
883
884	**/
885	EFI_STATUS
886	GetValueByName (
887	IN FORMSET_STORAGE *Storage,
888	IN CHAR16 *Name,
889	IN OUT CHAR16 **Value
890	);
891
892	/**
893	Set Value of given Name in a NameValue Storage.
894
895	@param Storage The NameValue Storage.
896	@param Name The Name.
897	@param Value The Value to set.
898	@param Edit Whether update editValue or Value.
899
900	@retval EFI_SUCCESS Value found for given Name.
901	@retval EFI_NOT_FOUND No such Name found in NameValue storage.
902
903	**/
904	EFI_STATUS
905	SetValueByName (
906	IN FORMSET_STORAGE *Storage,
907	IN CHAR16 *Name,
908	IN CHAR16 *Value,
909	IN BOOLEAN Edit
910	);
911
912	/**
913	Get Question's current Value.
914
915	@param FormSet FormSet data structure.
916	@param Form Form data structure.
917	@param Question Question to be initialized.
918	@param Cached TRUE: get from Edit copy FALSE: get from original
919	Storage
920
921	@retval EFI_SUCCESS The function completed successfully.
922
923	**/
924	EFI_STATUS
925	GetQuestionValue (
926	IN FORM_BROWSER_FORMSET *FormSet,
927	IN FORM_BROWSER_FORM *Form,
928	IN OUT FORM_BROWSER_STATEMENT *Question,
929	IN BOOLEAN Cached
930	);
931
932	/**
933	Save Question Value to edit copy(cached) or Storage(uncached).
934
935	@param FormSet FormSet data structure.
936	@param Form Form data structure.
937	@param Question Pointer to the Question.
938	@param Cached TRUE: set to Edit copy FALSE: set to original
939	Storage
940
941	@retval EFI_SUCCESS The function completed successfully.
942
943	**/
944	EFI_STATUS
945	SetQuestionValue (
946	IN FORM_BROWSER_FORMSET *FormSet,
947	IN FORM_BROWSER_FORM *Form,
948	IN OUT FORM_BROWSER_STATEMENT *Question,
949	IN BOOLEAN Cached
950	);
951
952	/**
953	Perform inconsistent check for a Form.
954
955	@param FormSet FormSet data structure.
956	@param Form Form data structure.
957	@param Question The Question to be validated.
958	@param Type Validation type: InConsistent or NoSubmit
959
960	@retval EFI_SUCCESS Form validation pass.
961	@retval other Form validation failed.
962
963	**/
964	EFI_STATUS
965	ValidateQuestion (
966	IN FORM_BROWSER_FORMSET *FormSet,
967	IN FORM_BROWSER_FORM *Form,
968	IN FORM_BROWSER_STATEMENT *Question,
969	IN UINTN Type
970	);
971
972
973	/**
974	Discard data based on the input setting scope (Form, FormSet or System).
975
976	@param FormSet FormSet data structure.
977	@param Form Form data structure.
978	@param SettingScope Setting Scope for Discard action.
979
980	@retval EFI_SUCCESS The function completed successfully.
981	@retval EFI_UNSUPPORTED Unsupport SettingScope.
982
983	**/
984	EFI_STATUS
985	DiscardForm (
986	IN FORM_BROWSER_FORMSET *FormSet,
987	IN FORM_BROWSER_FORM *Form,
988	IN BROWSER_SETTING_SCOPE SettingScope
989	);
990
991	/**
992	Submit data based on the input Setting level (Form, FormSet or System).
993
994	@param FormSet FormSet data structure.
995	@param Form Form data structure.
996	@param SettingScope Setting Scope for Submit action.
997
998	@retval EFI_SUCCESS The function completed successfully.
999	@retval EFI_UNSUPPORTED Unsupport SettingScope.
1000
1001	**/
1002	EFI_STATUS
1003	SubmitForm (
1004	IN FORM_BROWSER_FORMSET *FormSet,
1005	IN FORM_BROWSER_FORM *Form,
1006	IN BROWSER_SETTING_SCOPE SettingScope
1007	);
1008
1009	/**
1010	Reset Question to its default value.
1011
1012	@param FormSet The form set.
1013	@param Form The form.
1014	@param Question The question.
1015	@param DefaultId The Class of the default.
1016
1017	@retval EFI_SUCCESS Question is reset to default value.
1018
1019	**/
1020	EFI_STATUS
1021	GetQuestionDefault (
1022	IN FORM_BROWSER_FORMSET *FormSet,
1023	IN FORM_BROWSER_FORM *Form,
1024	IN FORM_BROWSER_STATEMENT *Question,
1025	IN UINT16 DefaultId
1026	);
1027
1028	/**
1029	Get current setting of Questions.
1030
1031	@param FormSet FormSet data structure.
1032
1033	@retval EFI_SUCCESS The function completed successfully.
1034
1035	**/
1036	EFI_STATUS
1037	InitializeCurrentSetting (
1038	IN OUT FORM_BROWSER_FORMSET *FormSet
1039	);
1040
1041	/**
1042	Initialize the internal data structure of a FormSet.
1043
1044	@param Handle PackageList Handle
1045	@param FormSetGuid GUID of a formset. If not specified (NULL or zero
1046	GUID), take the first FormSet found in package
1047	list.
1048	@param FormSet FormSet data structure.
1049	@param UpdateGlobalVar Whether need to update the global variable.
1050
1051	@retval EFI_SUCCESS The function completed successfully.
1052	@retval EFI_NOT_FOUND The specified FormSet could not be found.
1053
1054	**/
1055	EFI_STATUS
1056	InitializeFormSet (
1057	IN EFI_HII_HANDLE Handle,
1058	IN OUT EFI_GUID *FormSetGuid,
1059	OUT FORM_BROWSER_FORMSET *FormSet,
1060	IN BOOLEAN UpdateGlobalVar
1061	);
1062
1063	/**
1064	Reset Questions to their default value in a Form, Formset or System.
1065
1066	@param FormSet FormSet data structure.
1067	@param Form Form data structure.
1068	@param DefaultId The Class of the default.
1069	@param SettingScope Setting Scope for Default action.
1070
1071	@retval EFI_SUCCESS The function completed successfully.
1072	@retval EFI_UNSUPPORTED Unsupport SettingScope.
1073
1074	**/
1075	EFI_STATUS
1076	ExtractDefault (
1077	IN FORM_BROWSER_FORMSET *FormSet,
1078	IN FORM_BROWSER_FORM *Form,
1079	IN UINT16 DefaultId,
1080	IN BROWSER_SETTING_SCOPE SettingScope
1081	);
1082
1083	/**
1084	Initialize Question's Edit copy from Storage.
1085
1086	@param Selection Selection contains the information about
1087	the Selection, form and formset to be displayed.
1088	Selection action may be updated in retrieve callback.
1089	If Selection is NULL, only initialize Question value.
1090	@param FormSet FormSet data structure.
1091	@param Form Form data structure.
1092
1093	@retval EFI_SUCCESS The function completed successfully.
1094
1095	**/
1096	EFI_STATUS
1097	LoadFormConfig (
1098	IN OUT UI_MENU_SELECTION *Selection,
1099	IN FORM_BROWSER_FORMSET *FormSet,
1100	IN FORM_BROWSER_FORM *Form
1101	);
1102
1103	/**
1104	Initialize Question's Edit copy from Storage for the whole Formset.
1105
1106	@param Selection Selection contains the information about
1107	the Selection, form and formset to be displayed.
1108	Selection action may be updated in retrieve callback.
1109	If Selection is NULL, only initialize Question value.
1110	@param FormSet FormSet data structure.
1111
1112	@retval EFI_SUCCESS The function completed successfully.
1113
1114	**/
1115	EFI_STATUS
1116	LoadFormSetConfig (
1117	IN OUT UI_MENU_SELECTION *Selection,
1118	IN FORM_BROWSER_FORMSET *FormSet
1119	);
1120
1121	/**
1122	Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1123
1124	@param Buffer The Storage to be conveted.
1125	@param ConfigResp The returned <ConfigResp>.
1126	@param SingleForm Whether update data for single form or formset level.
1127
1128	@retval EFI_SUCCESS Convert success.
1129	@retval EFI_INVALID_PARAMETER Incorrect storage type.
1130
1131	**/
1132	EFI_STATUS
1133	StorageToConfigResp (
1134	IN VOID *Buffer,
1135	IN CHAR16 **ConfigResp,
1136	IN BOOLEAN SingleForm
1137	);
1138
1139	/**
1140	Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1141
1142	@param Storage The Storage to receive the settings.
1143	@param ConfigResp The <ConfigResp> to be converted.
1144
1145	@retval EFI_SUCCESS Convert success.
1146	@retval EFI_INVALID_PARAMETER Incorrect storage type.
1147
1148	**/
1149	EFI_STATUS
1150	ConfigRespToStorage (
1151	IN FORMSET_STORAGE *Storage,
1152	IN CHAR16 *ConfigResp
1153	);
1154
1155	/**
1156	Fill storage's edit copy with settings requested from Configuration Driver.
1157
1158	@param FormSet FormSet data structure.
1159	@param Storage Buffer Storage.
1160
1161	@retval EFI_SUCCESS The function completed successfully.
1162
1163	**/
1164	EFI_STATUS
1165	LoadStorage (
1166	IN FORM_BROWSER_FORMSET *FormSet,
1167	IN FORMSET_STORAGE *Storage
1168	);
1169
1170	/**
1171	Fetch the Ifr binary data of a FormSet.
1172
1173	@param Handle PackageList Handle
1174	@param FormSetGuid GUID of a formset. If not specified (NULL or zero
1175	GUID), take the first FormSet found in package
1176	list.
1177	@param BinaryLength The length of the FormSet IFR binary.
1178	@param BinaryData The buffer designed to receive the FormSet.
1179
1180	@retval EFI_SUCCESS Buffer filled with the requested FormSet.
1181	BufferLength was updated.
1182	@retval EFI_INVALID_PARAMETER The handle is unknown.
1183	@retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1184	be found with the requested FormId.
1185
1186	**/
1187	EFI_STATUS
1188	GetIfrBinaryData (
1189	IN EFI_HII_HANDLE Handle,
1190	IN OUT EFI_GUID *FormSetGuid,
1191	OUT UINTN *BinaryLength,
1192	OUT UINT8 **BinaryData
1193	);
1194
1195	/**
1196	Save globals used by previous call to SendForm(). SendForm() may be called from
1197	HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1198	So, save globals of previous call to SendForm() and restore them upon exit.
1199
1200	**/
1201	VOID
1202	SaveBrowserContext (
1203	VOID
1204	);
1205
1206	/**
1207	Restore globals used by previous call to SendForm().
1208
1209	**/
1210	VOID
1211	RestoreBrowserContext (
1212	VOID
1213	);
1214
1215	/**
1216	This is the routine which an external caller uses to direct the browser
1217	where to obtain it's information.
1218
1219
1220	@param This The Form Browser protocol instanse.
1221	@param Handles A pointer to an array of Handles. If HandleCount > 1 we
1222	display a list of the formsets for the handles specified.
1223	@param HandleCount The number of Handles specified in Handle.
1224	@param FormSetGuid This field points to the EFI_GUID which must match the Guid
1225	field in the EFI_IFR_FORM_SET op-code for the specified
1226	forms-based package. If FormSetGuid is NULL, then this
1227	function will display the first found forms package.
1228	@param FormId This field specifies which EFI_IFR_FORM to render as the first
1229	displayable page. If this field has a value of 0x0000, then
1230	the forms browser will render the specified forms in their encoded order.
1231	ScreenDimenions - This allows the browser to be called so that it occupies a
1232	portion of the physical screen instead of dynamically determining the screen dimensions.
1233	ActionRequest - Points to the action recommended by the form.
1234	@param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1235	characters.
1236	@param ActionRequest Points to the action recommended by the form.
1237
1238	@retval EFI_SUCCESS The function completed successfully.
1239	@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1240	@retval EFI_NOT_FOUND No valid forms could be found to display.
1241
1242	**/
1243	EFI_STATUS
1244	EFIAPI
1245	SendForm (
1246	IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
1247	IN EFI_HII_HANDLE *Handles,
1248	IN UINTN HandleCount,
1249	IN EFI_GUID *FormSetGuid, OPTIONAL
1250	IN UINT16 FormId, OPTIONAL
1251	IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
1252	OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL
1253	);
1254
1255	/**
1256	This function is called by a callback handler to retrieve uncommitted state
1257	data from the browser.
1258
1259	@param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1260	instance.
1261	@param ResultsDataSize A pointer to the size of the buffer associated
1262	with ResultsData.
1263	@param ResultsData A string returned from an IFR browser or
1264	equivalent. The results string will have no
1265	routing information in them.
1266	@param RetrieveData A BOOLEAN field which allows an agent to retrieve
1267	(if RetrieveData = TRUE) data from the uncommitted
1268	browser state information or set (if RetrieveData
1269	= FALSE) data in the uncommitted browser state
1270	information.
1271	@param VariableGuid An optional field to indicate the target variable
1272	GUID name to use.
1273	@param VariableName An optional field to indicate the target
1274	human-readable variable name.
1275
1276	@retval EFI_SUCCESS The results have been distributed or are awaiting
1277	distribution.
1278	@retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1279	contain the results data.
1280
1281	**/
1282	EFI_STATUS
1283	EFIAPI
1284	BrowserCallback (
1285	IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
1286	IN OUT UINTN *ResultsDataSize,
1287	IN OUT EFI_STRING ResultsData,
1288	IN BOOLEAN RetrieveData,
1289	IN CONST EFI_GUID *VariableGuid, OPTIONAL
1290	IN CONST CHAR16 *VariableName OPTIONAL
1291	);
1292
1293	/**
1294	Find menu which will show next time.
1295
1296	@param Selection On input, Selection tell setup browser the information
1297	about the Selection, form and formset to be displayed.
1298	On output, Selection return the screen item that is selected
1299	by user.
1300	@param Repaint Whether need to repaint the menu.
1301	@param NewLine Whether need to show at new line.
1302
1303	@retval TRUE Need return.
1304	@retval FALSE No need to return.
1305	**/
1306	BOOLEAN
1307	FindNextMenu (
1308	IN OUT UI_MENU_SELECTION *Selection,
1309	IN BOOLEAN *Repaint,
1310	IN BOOLEAN *NewLine
1311	);
1312
1313	/**
1314	check whether the formset need to update the NV.
1315
1316	@param FormSet FormSet data structure.
1317	@param SetValue Whether set new value or clear old value.
1318
1319	**/
1320	VOID
1321	UpdateNvInfoInForm (
1322	IN FORM_BROWSER_FORMSET *FormSet,
1323	IN BOOLEAN SetValue
1324	);
1325
1326	/**
1327	check whether the formset need to update the NV.
1328
1329	@param FormSet FormSet data structure.
1330
1331	@retval TRUE Need to update the NV.
1332	@retval FALSE No need to update the NV.
1333	**/
1334	BOOLEAN
1335	IsNvUpdateRequired (
1336	IN FORM_BROWSER_FORMSET *FormSet
1337	);
1338
1339	/**
1340	Call the call back function for the question and process the return action.
1341
1342	@param Selection On input, Selection tell setup browser the information
1343	about the Selection, form and formset to be displayed.
1344	On output, Selection return the screen item that is selected
1345	by user.
1346	@param Statement The Question which need to call.
1347	@param Action The action request.
1348	@param SkipSaveOrDiscard Whether skip save or discard action.
1349
1350	@retval EFI_SUCCESS The call back function excutes successfully.
1351	@return Other value if the call back function failed to excute.
1352	**/
1353	EFI_STATUS
1354	ProcessCallBackFunction (
1355	IN OUT UI_MENU_SELECTION *Selection,
1356	IN FORM_BROWSER_STATEMENT *Question,
1357	IN EFI_BROWSER_ACTION Action,
1358	IN BOOLEAN SkipSaveOrDiscard
1359	);
1360
1361	/**
1362	Find the matched FormSet context in the backup maintain list based on HiiHandle.
1363
1364	@param Handle The Hii Handle.
1365
1366	@return the found FormSet context. If no found, NULL will return.
1367
1368	**/
1369	FORM_BROWSER_FORMSET *
1370	GetFormSetFromHiiHandle (
1371	EFI_HII_HANDLE Handle
1372	);
1373
1374	/**
1375	Check whether the input HII handle is the FormSet that is being used.
1376
1377	@param Handle The Hii Handle.
1378
1379	@retval TRUE HII handle is being used.
1380	@retval FALSE HII handle is not being used.
1381
1382	**/
1383	BOOLEAN
1384	IsHiiHandleInBrowserContext (
1385	EFI_HII_HANDLE Handle
1386	);
1387
1388	/**
1389	Configure what scope the hot key will impact.
1390	All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1391	If no scope is set, the default scope will be FormSet level.
1392	After all registered hot keys are removed, previous Scope can reset to another level.
1393
1394	@param[in] Scope Scope level to be set.
1395
1396	@retval EFI_SUCCESS Scope is set correctly.
1397	@retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1398	@retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1399
1400	**/
1401	EFI_STATUS
1402	EFIAPI
1403	SetScope (
1404	IN BROWSER_SETTING_SCOPE Scope
1405	);
1406
1407	/**
1408	Register the hot key with its browser action, or unregistered the hot key.
1409	Only support hot key that is not printable character (control key, function key, etc.).
1410	If the action value is zero, the hot key will be unregistered if it has been registered.
1411	If the same hot key has been registered, the new action and help string will override the previous ones.
1412
1413	@param[in] KeyData A pointer to a buffer that describes the keystroke
1414	information for the hot key. Its type is EFI_INPUT_KEY to
1415	be supported by all ConsoleIn devices.
1416	@param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1417	@param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1418	@param[in] HelpString Help string that describes the hot key information.
1419	Its value may be NULL for the unregistered hot key.
1420
1421	@retval EFI_SUCCESS Hot key is registered or unregistered.
1422	@retval EFI_INVALID_PARAMETER KeyData is NULL.
1423	@retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1424	@retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1425	**/
1426	EFI_STATUS
1427	EFIAPI
1428	RegisterHotKey (
1429	IN EFI_INPUT_KEY *KeyData,
1430	IN UINT32 Action,
1431	IN UINT16 DefaultId,
1432	IN EFI_STRING HelpString OPTIONAL
1433	);
1434
1435	/**
1436	Register Exit handler function.
1437	When more than one handler function is registered, the latter one will override the previous one.
1438	When NULL handler is specified, the previous Exit handler will be unregistered.
1439
1440	@param[in] Handler Pointer to handler function.
1441
1442	**/
1443	VOID
1444	EFIAPI
1445	RegiserExitHandler (
1446	IN EXIT_HANDLER Handler
1447	);
1448
1449	/**
1450	Create reminder to let user to choose save or discard the changed browser data.
1451	Caller can use it to actively check the changed browser data.
1452
1453	@retval BROWSER_NO_CHANGES No browser data is changed.
1454	@retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1455	@retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1456
1457	**/
1458	UINT32
1459	EFIAPI
1460	SaveReminder (
1461	VOID
1462	);
1463
1464	/**
1465	Find the registered HotKey based on KeyData.
1466
1467	@param[in] KeyData A pointer to a buffer that describes the keystroke
1468	information for the hot key.
1469
1470	@return The registered HotKey context. If no found, NULL will return.
1471	**/
1472	BROWSER_HOT_KEY *
1473	GetHotKeyFromRegisterList (
1474	IN EFI_INPUT_KEY *KeyData
1475	);
1476
1477	#endif

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Devices/EFI/Firmware/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h@ 54985

Download in other formats: