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