]> 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. Code clean up: add IN/OUT modifier for parameters.
[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
404} FORM_BROWSER_FORM;\r
405\r
406#define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)\r
407\r
f3f2e05d 408#define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')\r
7936fb6a 409\r
410typedef struct {\r
411 UINTN Signature;\r
412 LIST_ENTRY Link;\r
413\r
414 UINT16 DefaultId;\r
415 EFI_STRING_ID DefaultName;\r
416} FORMSET_DEFAULTSTORE;\r
417\r
418#define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)\r
419\r
420typedef struct {\r
421 EFI_HII_HANDLE HiiHandle;\r
422 EFI_HANDLE DriverHandle;\r
423 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;\r
424 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
425\r
426 UINTN IfrBinaryLength;\r
427 UINT8 *IfrBinaryData;\r
428\r
429 EFI_GUID Guid;\r
430 EFI_STRING_ID FormSetTitle;\r
431 EFI_STRING_ID Help;\r
0a1147ed
LG		 432 UINT8 NumberOfClassGuid;\r
433 EFI_GUID ClassGuid[3]; // Up to three ClassGuid\r
434 UINT16 Class; // Tiano extended Class code\r
435 UINT16 SubClass; // Tiano extended Subclass code\r
7936fb6a 436 EFI_IMAGE_ID ImageId;\r
437\r
438 FORM_BROWSER_STATEMENT *StatementBuffer; // Buffer for all Statements and Questions\r
439 EXPRESSION_OPCODE *ExpressionBuffer; // Buffer for all Expression OpCode\r
440\r
441 LIST_ENTRY StorageListHead; // Storage list (FORMSET_STORAGE)\r
442 LIST_ENTRY DefaultStoreListHead; // DefaultStore list (FORMSET_DEFAULTSTORE)\r
443 LIST_ENTRY FormListHead; // Form list (FORM_BROWSER_FORM)\r
444} FORM_BROWSER_FORMSET;\r
445\r
446\r
447extern EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;\r
448extern EFI_HII_STRING_PROTOCOL *mHiiString;\r
449extern EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;\r
450\r
0a1147ed
LG		 451extern BANNER_DATA *gBannerData;\r
452extern EFI_HII_HANDLE gFrontPageHandle;\r
7936fb6a 453extern UINTN gClassOfVfr;\r
454extern UINTN gFunctionKeySetting;\r
455extern BOOLEAN gResetRequired;\r
456extern BOOLEAN gNvUpdateRequired;\r
457extern EFI_HII_HANDLE gHiiHandle;\r
7936fb6a 458extern UINT16 gDirection;\r
459extern EFI_SCREEN_DESCRIPTOR gScreenDimensions;\r
460extern BOOLEAN gUpArrow;\r
461extern BOOLEAN gDownArrow;\r
462\r
d66e6c16 463extern FORM_BROWSER_FORMSET *gOldFormSet;\r
464\r
7936fb6a 465//\r
466// Browser Global Strings\r
467//\r
7936fb6a 468extern CHAR16 *gFunctionNineString;\r
469extern CHAR16 *gFunctionTenString;\r
470extern CHAR16 *gEnterString;\r
471extern CHAR16 *gEnterCommitString;\r
8d00a0f1 472extern CHAR16 *gEnterEscapeString;\r
7936fb6a 473extern CHAR16 *gEscapeString;\r
474extern CHAR16 *gSaveFailed;\r
475extern CHAR16 *gMoveHighlight;\r
476extern CHAR16 *gMakeSelection;\r
477extern CHAR16 *gDecNumericInput;\r
478extern CHAR16 *gHexNumericInput;\r
479extern CHAR16 *gToggleCheckBox;\r
480extern CHAR16 *gPromptForData;\r
481extern CHAR16 *gPromptForPassword;\r
482extern CHAR16 *gPromptForNewPassword;\r
483extern CHAR16 *gConfirmPassword;\r
484extern CHAR16 *gConfirmError;\r
485extern CHAR16 *gPassowordInvalid;\r
486extern CHAR16 *gPressEnter;\r
487extern CHAR16 *gEmptyString;\r
488extern CHAR16 *gAreYouSure;\r
489extern CHAR16 *gYesResponse;\r
490extern CHAR16 *gNoResponse;\r
491extern CHAR16 *gMiniString;\r
492extern CHAR16 *gPlusString;\r
493extern CHAR16 *gMinusString;\r
494extern CHAR16 *gAdjustNumber;\r
ebe43565 495extern CHAR16 *gSaveChanges;\r
8d00a0f1 496extern CHAR16 *gOptionMismatch;\r
7936fb6a 497\r
498extern CHAR16 gPromptBlockWidth;\r
499extern CHAR16 gOptionBlockWidth;\r
500extern CHAR16 gHelpBlockWidth;\r
501\r
502extern EFI_GUID gZeroGuid;\r
503extern EFI_GUID gTianoHiiIfrGuid;\r
504\r
505//\r
506// Global Procedure Defines\r
507//\r
508\r
509/**\r
510 Initialize the HII String Token to the correct values.\r
511\r
512**/\r
513VOID\r
514InitializeBrowserStrings (\r
515 VOID\r
ed66e1bc 516 );\r
7936fb6a 517\r
518/**\r
519 Prints a unicode string to the default console,\r
520 using L"%s" format.\r
521\r
522 @param String String pointer.\r
523\r
524 @return Length of string printed to the console\r
525\r
526**/\r
527UINTN\r
528PrintString (\r
529 IN CHAR16 *String\r
ed66e1bc 530 );\r
7936fb6a 531\r
532/**\r
533 Prints a chracter to the default console,\r
534 using L"%c" format.\r
535\r
536 @param Character Character to print.\r
537\r
538 @return Length of string printed to the console.\r
539\r
540**/\r
541UINTN\r
542PrintChar (\r
543 CHAR16 Character\r
ed66e1bc 544 );\r
7936fb6a 545\r
546/**\r
547 Prints a formatted unicode string to the default console, at\r
548 the supplied cursor position.\r
549\r
550 @param Column The cursor position to print the string at.\r
551 @param Row The cursor position to print the string at\r
552 @param Fmt Format string\r
553 @param ... Variable argument list for formating string.\r
554\r
555 @return Length of string printed to the console\r
556\r
557**/\r
558UINTN\r
559PrintAt (\r
560 IN UINTN Column,\r
561 IN UINTN Row,\r
562 IN CHAR16 *Fmt,\r
563 ...\r
ed66e1bc 564 );\r
7936fb6a 565\r
566/**\r
567 Prints a unicode string to the default console, at\r
568 the supplied cursor position, using L"%s" format.\r
569\r
570 @param Column The cursor position to print the string at.\r
571 @param Row The cursor position to print the string at\r
572 @param String String pointer.\r
573\r
574 @return Length of string printed to the console\r
575\r
576**/\r
577UINTN\r
578PrintStringAt (\r
579 IN UINTN Column,\r
580 IN UINTN Row,\r
581 IN CHAR16 *String\r
ed66e1bc 582 );\r
7936fb6a 583\r
584/**\r
585 Prints a chracter to the default console, at\r
586 the supplied cursor position, using L"%c" format.\r
587\r
588 @param Column The cursor position to print the string at.\r
589 @param Row The cursor position to print the string at.\r
590 @param Character Character to print.\r
591\r
592 @return Length of string printed to the console.\r
593\r
594**/\r
595UINTN\r
596PrintCharAt (\r
597 IN UINTN Column,\r
598 IN UINTN Row,\r
599 CHAR16 Character\r
ed66e1bc 600 );\r
7936fb6a 601\r
602/**\r
603 Parse opcodes in the formset IFR binary.\r
604\r
605 @param FormSet Pointer of the FormSet data structure.\r
606\r
607 @retval EFI_SUCCESS Opcode parse success.\r
608 @retval Other Opcode parse fail.\r
609\r
610**/\r
611EFI_STATUS\r
612ParseOpCodes (\r
613 IN FORM_BROWSER_FORMSET *FormSet\r
ed66e1bc 614 );\r
7936fb6a 615\r
616/**\r
617 Free resources allocated for a FormSet.\r
618\r
619 @param FormSet Pointer of the FormSet\r
620\r
621**/\r
622VOID\r
623DestroyFormSet (\r
624 IN OUT FORM_BROWSER_FORMSET *FormSet\r
ed66e1bc 625 );\r
7936fb6a 626\r
627/**\r
628 This function displays the page frame.\r
629\r
630**/\r
631VOID\r
632DisplayPageFrame (\r
633 VOID\r
ed66e1bc 634 );\r
7936fb6a 635\r
636/**\r
637 Create a new string in HII Package List.\r
638\r
639 @param String The String to be added\r
640 @param HiiHandle The package list in the HII database to insert the\r
641 specified string.\r
642\r
643 @return The output string.\r
644\r
645**/\r
646EFI_STRING_ID\r
647NewString (\r
648 IN CHAR16 *String,\r
649 IN EFI_HII_HANDLE HiiHandle\r
ed66e1bc 650 );\r
7936fb6a 651\r
652/**\r
653 Delete a string from HII Package List.\r
654\r
655 @param StringId Id of the string in HII database.\r
656 @param HiiHandle The HII package list handle.\r
657\r
658 @retval EFI_SUCCESS The string was deleted successfully.\r
659\r
660**/\r
661EFI_STATUS\r
662DeleteString (\r
663 IN EFI_STRING_ID StringId,\r
664 IN EFI_HII_HANDLE HiiHandle\r
ed66e1bc 665 );\r
7936fb6a 666\r
667/**\r
668 Get the string based on the StringId and HII Package List Handle.\r
669\r
670 @param Token The String's ID.\r
671 @param HiiHandle The package list in the HII database to search for\r
672 the specified string.\r
673\r
674 @return The output string.\r
675\r
676**/\r
677CHAR16 *\r
678GetToken (\r
679 IN EFI_STRING_ID Token,\r
680 IN EFI_HII_HANDLE HiiHandle\r
ed66e1bc 681 );\r
7936fb6a 682\r
683/**\r
684 Draw a pop up windows based on the dimension, number of lines and\r
685 strings specified.\r
686\r
687 @param RequestedWidth The width of the pop-up.\r
688 @param NumberOfLines The number of lines.\r
f4bcc90f 689 @param Marker The variable argument list for the list of string to be printed.\r
7936fb6a 690\r
691**/\r
692VOID\r
693CreateSharedPopUp (\r
694 IN UINTN RequestedWidth,\r
695 IN UINTN NumberOfLines,\r
f4bcc90f 696 IN VA_LIST Marker\r
ed66e1bc 697 );\r
7936fb6a 698\r
699/**\r
700 Routine used to abstract a generic dialog interface and return the selected key or string\r
701\r
702 @param NumberOfLines The number of lines for the dialog box\r
703 @param HotKey Defines whether a single character is parsed\r
704 (TRUE) and returned in KeyValue or a string is\r
705 returned in StringBuffer. Two special characters\r
706 are considered when entering a string, a SCAN_ESC\r
707 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates\r
708 string input and returns\r
709 @param MaximumStringSize The maximum size in bytes of a typed in string\r
710 (each character is a CHAR16) and the minimum\r
711 string returned is two bytes\r
712 @param StringBuffer The passed in pointer to the buffer which will\r
713 hold the typed in string if HotKey is FALSE\r
714 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..\r
7936fb6a 715 @param ... A series of (quantity == NumberOfLines) text\r
716 strings which will be used to construct the dialog\r
717 box\r
718\r
719 @retval EFI_SUCCESS Displayed dialog and received user interaction\r
720 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.\r
721 (StringBuffer == NULL) && (HotKey == FALSE))\r
722 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine\r
723\r
724**/\r
725EFI_STATUS\r
726CreateDialog (\r
727 IN UINTN NumberOfLines,\r
728 IN BOOLEAN HotKey,\r
729 IN UINTN MaximumStringSize,\r
730 OUT CHAR16 *StringBuffer,\r
731 OUT EFI_INPUT_KEY *KeyValue,\r
7936fb6a 732 ...\r
ed66e1bc 733 );\r
7936fb6a 734\r
735/**\r
736 Get Question's current Value.\r
737\r
738 @param FormSet FormSet data structure.\r
739 @param Form Form data structure.\r
740 @param Question Question to be initialized.\r
741 @param Cached TRUE: get from Edit copy FALSE: get from original\r
742 Storage\r
743\r
744 @retval EFI_SUCCESS The function completed successfully.\r
745\r
746**/\r
747EFI_STATUS\r
748GetQuestionValue (\r
749 IN FORM_BROWSER_FORMSET *FormSet,\r
750 IN FORM_BROWSER_FORM *Form,\r
751 IN OUT FORM_BROWSER_STATEMENT *Question,\r
752 IN BOOLEAN Cached\r
ed66e1bc 753 );\r
7936fb6a 754\r
755/**\r
756 Save Question Value to edit copy(cached) or Storage(uncached).\r
757\r
758 @param FormSet FormSet data structure.\r
759 @param Form Form data structure.\r
760 @param Question Pointer to the Question.\r
761 @param Cached TRUE: set to Edit copy FALSE: set to original\r
762 Storage\r
763\r
764 @retval EFI_SUCCESS The function completed successfully.\r
765\r
766**/\r
767EFI_STATUS\r
768SetQuestionValue (\r
769 IN FORM_BROWSER_FORMSET *FormSet,\r
770 IN FORM_BROWSER_FORM *Form,\r
771 IN OUT FORM_BROWSER_STATEMENT *Question,\r
772 IN BOOLEAN Cached\r
ed66e1bc 773 );\r
7936fb6a 774\r
775/**\r
776 Perform inconsistent check for a Form.\r
777\r
778 @param FormSet FormSet data structure.\r
779 @param Form Form data structure.\r
780 @param Question The Question to be validated.\r
781 @param Type Validation type: InConsistent or NoSubmit\r
782\r
783 @retval EFI_SUCCESS Form validation pass.\r
784 @retval other Form validation failed.\r
785\r
786**/\r
787EFI_STATUS\r
788ValidateQuestion (\r
789 IN FORM_BROWSER_FORMSET *FormSet,\r
790 IN FORM_BROWSER_FORM *Form,\r
791 IN FORM_BROWSER_STATEMENT *Question,\r
792 IN UINTN Type\r
ed66e1bc 793 );\r
7936fb6a 794\r
795/**\r
796 Submit a Form.\r
797\r
798 @param FormSet FormSet data structure.\r
799 @param Form Form data structure.\r
800\r
801 @retval EFI_SUCCESS The function completed successfully.\r
802\r
803**/\r
804EFI_STATUS\r
805SubmitForm (\r
806 IN FORM_BROWSER_FORMSET *FormSet,\r
807 IN FORM_BROWSER_FORM *Form\r
ed66e1bc 808 );\r
7936fb6a 809\r
810/**\r
811 Reset Question to its default value.\r
812\r
813 @param FormSet The form set.\r
814 @param Form The form.\r
815 @param Question The question.\r
816 @param DefaultId The Class of the default.\r
817\r
818 @retval EFI_SUCCESS Question is reset to default value.\r
819\r
820**/\r
821EFI_STATUS\r
822GetQuestionDefault (\r
823 IN FORM_BROWSER_FORMSET *FormSet,\r
824 IN FORM_BROWSER_FORM *Form,\r
825 IN FORM_BROWSER_STATEMENT *Question,\r
826 IN UINT16 DefaultId\r
ed66e1bc 827 );\r
7936fb6a 828\r
829/**\r
830 Get current setting of Questions.\r
831\r
832 @param FormSet FormSet data structure.\r
833\r
834 @retval EFI_SUCCESS The function completed successfully.\r
835\r
836**/\r
837EFI_STATUS\r
838InitializeCurrentSetting (\r
839 IN OUT FORM_BROWSER_FORMSET *FormSet\r
ed66e1bc 840 );\r
7936fb6a 841\r
842/**\r
843 Initialize the internal data structure of a FormSet.\r
844\r
845 @param Handle PackageList Handle\r
846 @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r
847 GUID), take the first FormSet found in package\r
848 list.\r
849 @param FormSet FormSet data structure.\r
850\r
851 @retval EFI_SUCCESS The function completed successfully.\r
852 @retval EFI_NOT_FOUND The specified FormSet could not be found.\r
853\r
854**/\r
855EFI_STATUS\r
856InitializeFormSet (\r
857 IN EFI_HII_HANDLE Handle,\r
858 IN OUT EFI_GUID *FormSetGuid,\r
859 OUT FORM_BROWSER_FORMSET *FormSet\r
ed66e1bc 860 );\r
7936fb6a 861\r
862/**\r
863 Reset Questions in a Form to their default value.\r
864\r
865 @param FormSet FormSet data structure.\r
866 @param Form The Form which to be reset.\r
867 @param DefaultId The Class of the default.\r
868\r
869 @retval EFI_SUCCESS The function completed successfully.\r
870\r
871**/\r
872EFI_STATUS\r
873ExtractFormDefault (\r
874 IN FORM_BROWSER_FORMSET *FormSet,\r
875 IN FORM_BROWSER_FORM *Form,\r
876 IN UINT16 DefaultId\r
ed66e1bc 877 );\r
7936fb6a 878\r
879/**\r
880 Initialize Question's Edit copy from Storage.\r
881\r
882 @param FormSet FormSet data structure.\r
883 @param Form Form data structure.\r
884\r
885 @retval EFI_SUCCESS The function completed successfully.\r
886\r
887**/\r
888EFI_STATUS\r
889LoadFormConfig (\r
890 IN FORM_BROWSER_FORMSET *FormSet,\r
891 IN FORM_BROWSER_FORM *Form\r
ed66e1bc 892 );\r
7936fb6a 893\r
d66e6c16 894/**\r
895 Initialize Question's Edit copy from Storage for the whole Formset.\r
896\r
897 @param FormSet FormSet data structure.\r
898\r
899 @retval EFI_SUCCESS The function completed successfully.\r
900\r
901**/\r
902EFI_STATUS\r
903LoadFormSetConfig (\r
904 IN FORM_BROWSER_FORMSET *FormSet\r
905 );\r
906\r
7936fb6a 907/**\r
908 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.\r
909\r
910 @param Storage The Storage to be conveted.\r
911 @param ConfigResp The returned <ConfigResp>.\r
912\r
913 @retval EFI_SUCCESS Convert success.\r
914 @retval EFI_INVALID_PARAMETER Incorrect storage type.\r
915\r
916**/\r
917EFI_STATUS\r
918StorageToConfigResp (\r
919 IN FORMSET_STORAGE *Storage,\r
920 IN CHAR16 **ConfigResp\r
ed66e1bc 921 );\r
7936fb6a 922\r
923/**\r
924 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.\r
925\r
926 @param Storage The Storage to receive the settings.\r
927 @param ConfigResp The <ConfigResp> to be converted.\r
928\r
929 @retval EFI_SUCCESS Convert success.\r
930 @retval EFI_INVALID_PARAMETER Incorrect storage type.\r
931\r
932**/\r
933EFI_STATUS\r
934ConfigRespToStorage (\r
935 IN FORMSET_STORAGE *Storage,\r
936 IN CHAR16 *ConfigResp\r
ed66e1bc 937 );\r
7936fb6a 938\r
939/**\r
940 Fill storage's edit copy with settings requested from Configuration Driver.\r
941\r
942 @param FormSet FormSet data structure.\r
943 @param Storage Buffer Storage.\r
944\r
945 @retval EFI_SUCCESS The function completed successfully.\r
946\r
947**/\r
948EFI_STATUS\r
949LoadStorage (\r
950 IN FORM_BROWSER_FORMSET *FormSet,\r
951 IN FORMSET_STORAGE *Storage\r
ed66e1bc 952 );\r
7936fb6a 953\r
954/**\r
955 Fetch the Ifr binary data of a FormSet.\r
956\r
957 @param Handle PackageList Handle\r
958 @param FormSetGuid GUID of a formset. If not specified (NULL or zero\r
959 GUID), take the first FormSet found in package\r
960 list.\r
961 @param BinaryLength The length of the FormSet IFR binary.\r
962 @param BinaryData The buffer designed to receive the FormSet.\r
963\r
964 @retval EFI_SUCCESS Buffer filled with the requested FormSet.\r
965 BufferLength was updated.\r
966 @retval EFI_INVALID_PARAMETER The handle is unknown.\r
967 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot\r
968 be found with the requested FormId.\r
969\r
970**/\r
971EFI_STATUS\r
972GetIfrBinaryData (\r
973 IN EFI_HII_HANDLE Handle,\r
974 IN OUT EFI_GUID *FormSetGuid,\r
975 OUT UINTN *BinaryLength,\r
976 OUT UINT8 **BinaryData\r
ed66e1bc 977 );\r
7936fb6a 978\r
979/**\r
980 This is the routine which an external caller uses to direct the browser\r
981 where to obtain it's information.\r
982\r
983\r
984 @param This The Form Browser protocol instanse.\r
985 @param Handles A pointer to an array of Handles. If HandleCount > 1 we\r
986 display a list of the formsets for the handles specified.\r
987 @param HandleCount The number of Handles specified in Handle.\r
988 @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r
989 field in the EFI_IFR_FORM_SET op-code for the specified\r
990 forms-based package. If FormSetGuid is NULL, then this\r
991 function will display the first found forms package.\r
992 @param FormId This field specifies which EFI_IFR_FORM to render as the first\r
993 displayable page. If this field has a value of 0x0000, then\r
994 the forms browser will render the specified forms in their encoded order.\r
995 ScreenDimenions - This allows the browser to be called so that it occupies a\r
996 portion of the physical screen instead of dynamically determining the screen dimensions.\r
997 ActionRequest - Points to the action recommended by the form.\r
d66e6c16 998 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r
7936fb6a 999 characters.\r
1000 @param ActionRequest Points to the action recommended by the form.\r
1001\r
1002 @retval EFI_SUCCESS The function completed successfully.\r
1003 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
1004 @retval EFI_NOT_FOUND No valid forms could be found to display.\r
1005\r
1006**/\r
1007EFI_STATUS\r
1008EFIAPI\r
1009SendForm (\r
1010 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r
1011 IN EFI_HII_HANDLE *Handles,\r
1012 IN UINTN HandleCount,\r
1013 IN EFI_GUID *FormSetGuid, OPTIONAL\r
1014 IN UINT16 FormId, OPTIONAL\r
1015 IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r
1016 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r
ed66e1bc 1017 );\r
7936fb6a 1018\r
1019/**\r
1020 This function is called by a callback handler to retrieve uncommitted state\r
1021 data from the browser.\r
1022\r
1023 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL\r
1024 instance.\r
1025 @param ResultsDataSize A pointer to the size of the buffer associated\r
1026 with ResultsData.\r
1027 @param ResultsData A string returned from an IFR browser or\r
1028 equivalent. The results string will have no\r
1029 routing information in them.\r
1030 @param RetrieveData A BOOLEAN field which allows an agent to retrieve\r
1031 (if RetrieveData = TRUE) data from the uncommitted\r
1032 browser state information or set (if RetrieveData\r
1033 = FALSE) data in the uncommitted browser state\r
1034 information.\r
1035 @param VariableGuid An optional field to indicate the target variable\r
1036 GUID name to use.\r
1037 @param VariableName An optional field to indicate the target\r
1038 human-readable variable name.\r
1039\r
1040 @retval EFI_SUCCESS The results have been distributed or are awaiting\r
1041 distribution.\r
1042 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to\r
1043 contain the results data.\r
1044\r
1045**/\r
1046EFI_STATUS\r
1047EFIAPI\r
1048BrowserCallback (\r
1049 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r
1050 IN OUT UINTN *ResultsDataSize,\r
1051 IN OUT EFI_STRING ResultsData,\r
1052 IN BOOLEAN RetrieveData,\r
1053 IN CONST EFI_GUID *VariableGuid, OPTIONAL\r
1054 IN CONST CHAR16 *VariableName OPTIONAL\r
ed66e1bc 1055 );\r
7936fb6a 1056\r
1057#endif\r
EFI Development Kit II mirror for PVE