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