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