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