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