2 Private MACRO, structure and function definitions for Setup Browser module.
4 Copyright (c) 2007 - 2010, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include <Protocol/SimpleTextOut.h>
23 #include <Protocol/SimpleTextIn.h>
24 #include <Protocol/FormBrowser2.h>
25 #include <Protocol/DevicePath.h>
26 #include <Protocol/UnicodeCollation.h>
27 #include <Protocol/HiiConfigAccess.h>
28 #include <Protocol/HiiConfigRouting.h>
29 #include <Protocol/HiiDatabase.h>
30 #include <Protocol/HiiString.h>
31 #include <Protocol/UserManager.h>
33 #include <Guid/MdeModuleHii.h>
34 #include <Guid/HiiPlatformSetupFormset.h>
36 #include <Library/PrintLib.h>
37 #include <Library/DebugLib.h>
38 #include <Library/BaseMemoryLib.h>
39 #include <Library/UefiRuntimeServicesTableLib.h>
40 #include <Library/UefiDriverEntryPoint.h>
41 #include <Library/UefiBootServicesTableLib.h>
42 #include <Library/BaseLib.h>
43 #include <Library/MemoryAllocationLib.h>
44 #include <Library/HiiLib.h>
45 #include <Library/PcdLib.h>
46 #include <Library/DevicePathLib.h>
51 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
54 extern UINT8 SetupBrowserStrings
[];
59 #define BANNER_HEIGHT 6
60 #define BANNER_COLUMNS 3
62 #define FRONT_PAGE_HEADER_HEIGHT 6
63 #define NONE_FRONT_PAGE_HEADER_HEIGHT 3
64 #define LEFT_SKIPPED_COLUMNS 4
65 #define FOOTER_HEIGHT 4
66 #define STATUS_BAR_HEIGHT 1
67 #define SCROLL_ARROW_HEIGHT 1
68 #define POPUP_PAD_SPACE_COUNT 5
69 #define POPUP_FRAME_WIDTH 2
72 // Definition for function key setting
74 #define NONE_FUNCTION_KEY_SETTING 0
75 #define DEFAULT_FUNCTION_KEY_SETTING (FUNCTION_NINE | FUNCTION_TEN)
77 #define FUNCTION_NINE (1 << 2)
78 #define FUNCTION_TEN (1 << 3)
83 } FUNCTIION_KEY_SETTING
;
86 // Character definitions
88 #define CHAR_SPACE 0x0020
89 #define UPPER_LOWER_CASE_OFFSET 0x20
94 #define ONE_SECOND 10000000
97 // Display definitions
99 #define LEFT_HYPER_DELIMITER L'<'
100 #define RIGHT_HYPER_DELIMITER L'>'
102 #define LEFT_ONEOF_DELIMITER L'<'
103 #define RIGHT_ONEOF_DELIMITER L'>'
105 #define LEFT_NUMERIC_DELIMITER L'['
106 #define RIGHT_NUMERIC_DELIMITER L']'
108 #define LEFT_CHECKBOX_DELIMITER L'['
109 #define RIGHT_CHECKBOX_DELIMITER L']'
111 #define CHECK_ON L'X'
112 #define CHECK_OFF L' '
114 #define TIME_SEPARATOR L':'
115 #define DATE_SEPARATOR L'/'
117 #define YES_ANSWER L'Y'
118 #define NO_ANSWER L'N'
121 // This is the Input Error Message
123 #define INPUT_ERROR 1
126 // This is the NV RAM update required Message
128 #define NV_UPDATE_REQUIRED 2
131 // Refresh the Status Bar with flags
133 #define REFRESH_STATUS_BAR 0xff
136 // Incremental string lenght of ConfigRequest
138 #define CONFIG_REQUEST_STRING_INCREMENTAL 1024
141 // HII value compare result
143 #define HII_VALUE_UNDEFINED 0
144 #define HII_VALUE_EQUAL 1
145 #define HII_VALUE_LESS_THAN 2
146 #define HII_VALUE_GREATER_THAN 3
149 // Incremental size of stack for expression
151 #define EXPRESSION_STACK_SIZE_INCREMENT 0x100
154 #define EFI_SPECIFICATION_ERRATA_VERSION 0
156 #define EFI_IFR_SPECIFICATION_VERSION \
157 ((((EFI_SPECIFICATION_VERSION) >> 8) & 0xff00) | \
158 (((EFI_SPECIFICATION_VERSION) & 0xf) << 4) | \
159 ((EFI_SPECIFICATION_ERRATA_VERSION) & 0xf))
161 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
170 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
172 } SETUP_DRIVER_PRIVATE_DATA
;
175 EFI_STRING_ID Banner
[BANNER_HEIGHT
][BANNER_COLUMNS
];
179 // IFR relative definition
181 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
182 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
183 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
184 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
185 #define EFI_HII_EXPRESSION_DISABLE_IF 4
186 #define EFI_HII_EXPRESSION_VALUE 5
187 #define EFI_HII_EXPRESSION_RULE 6
189 #define EFI_HII_VARSTORE_BUFFER 0
190 #define EFI_HII_VARSTORE_NAME_VALUE 1
191 #define EFI_HII_VARSTORE_EFI_VARIABLE 2
193 #define FORM_INCONSISTENT_VALIDATION 0
194 #define FORM_NO_SUBMIT_VALIDATION 1
196 #define FORMSET_CLASS_PLATFORM_SETUP 0x0001
197 #define FORMSET_CLASS_FRONT_PAGE 0x0002
201 EFI_IFR_TYPE_VALUE Value
;
204 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
214 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
216 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
222 UINT8 Type
; // Storage type
227 CHAR16
*Name
; // For EFI_IFR_VARSTORE
230 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
232 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
234 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
236 CHAR16
*ConfigHdr
; // <ConfigHdr>
237 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
238 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
239 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
242 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
244 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
252 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
253 UINT8 Flags
; // For EFI_IFR_SPAN
254 UINT8 RuleId
; // For EFI_IFR_RULE_REF
256 EFI_HII_VALUE Value
; // For EFI_IFR_EQ_ID_VAL, EFI_IFR_UINT64, EFI_IFR_UINT32, EFI_IFR_UINT16, EFI_IFR_UINT8, EFI_IFR_STRING_REF1
258 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
259 EFI_QUESTION_ID QuestionId2
;
261 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
264 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
268 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
270 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
276 UINT8 Type
; // Type for this expression
278 UINT8 RuleId
; // For EFI_IFR_RULE only
279 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
281 EFI_HII_VALUE Result
; // Expression evaluation result
283 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
286 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
288 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
295 EFI_HII_VALUE Value
; // Default value
297 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
300 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
302 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
311 EFI_IMAGE_ID ImageId
;
313 FORM_EXPRESSION
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
316 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
318 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
323 UINT8 Operand
; // The operand (first byte) of this Statement or Question
328 EFI_STRING_ID Prompt
;
330 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
335 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
336 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
337 FORMSET_STORAGE
*Storage
;
339 EFI_STRING_ID VarName
;
344 CHAR16
*VariableName
; // Name/Value or EFI Variable name
345 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
347 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
348 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
349 UINT8 ValueType
; // Data type for orderedlist value array
352 // OpCode specific members
354 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
355 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
356 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
358 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
359 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
361 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
362 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
365 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
366 EFI_FORM_ID RefFormId
; // for EFI_IFR_REF
367 EFI_QUESTION_ID RefQuestionId
; // for EFI_IFR_REF2
368 EFI_GUID RefFormSetId
; // for EFI_IFR_REF3
369 EFI_STRING_ID RefDevicePath
; // for EFI_IFR_REF4
372 // Get from IFR parsing
374 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
375 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
376 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
378 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
379 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
380 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
382 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
383 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
384 FORM_EXPRESSION
*GrayOutExpression
; // nesting inside of GrayOutIf
385 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
386 FORM_EXPRESSION
*DisableExpression
; // nesting inside of DisableIf
388 } FORM_BROWSER_STATEMENT
;
390 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
392 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
399 EFI_STRING_ID FormTitle
;
401 EFI_IMAGE_ID ImageId
;
403 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
404 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
405 FORM_EXPRESSION
*SuppressExpression
; // nesting inside of SuppressIf
408 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
410 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
417 EFI_STRING_ID DefaultName
;
418 } FORMSET_DEFAULTSTORE
;
420 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
423 EFI_HII_HANDLE HiiHandle
;
424 EFI_HANDLE DriverHandle
;
425 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
426 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
428 UINTN IfrBinaryLength
;
429 UINT8
*IfrBinaryData
;
432 EFI_STRING_ID FormSetTitle
;
434 UINT8 NumberOfClassGuid
;
435 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
436 UINT16 Class
; // Tiano extended Class code
437 UINT16 SubClass
; // Tiano extended Subclass code
438 EFI_IMAGE_ID ImageId
;
440 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
441 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
443 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
444 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
445 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
446 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
447 } FORM_BROWSER_FORMSET
;
449 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
456 // Globals defined in Setup.c
458 BANNER_DATA
*BannerData
;
460 UINTN FunctionKeySetting
;
461 BOOLEAN ResetRequired
;
462 BOOLEAN NvUpdateRequired
;
464 EFI_SCREEN_DESCRIPTOR ScreenDimensions
;
465 CHAR16
*FunctionNineString
;
466 CHAR16
*FunctionTenString
;
468 CHAR16
*EnterCommitString
;
469 CHAR16
*EnterEscapeString
;
470 CHAR16
*EscapeString
;
472 CHAR16
*MoveHighlight
;
473 CHAR16
*MakeSelection
;
474 CHAR16
*DecNumericInput
;
475 CHAR16
*HexNumericInput
;
476 CHAR16
*ToggleCheckBox
;
477 CHAR16
*PromptForData
;
478 CHAR16
*PromptForPassword
;
479 CHAR16
*PromptForNewPassword
;
480 CHAR16
*ConfirmPassword
;
481 CHAR16
*ConfirmError
;
482 CHAR16
*PassowordInvalid
;
491 CHAR16
*AdjustNumber
;
493 CHAR16
*OptionMismatch
;
494 CHAR16
*FormSuppress
;
495 CHAR16 PromptBlockWidth
;
496 CHAR16 OptionBlockWidth
;
497 CHAR16 HelpBlockWidth
;
498 FORM_BROWSER_FORMSET
*OldFormSet
;
501 // Globals defined in Ui.c
503 LIST_ENTRY MenuOption
;
504 VOID
*MenuRefreshHead
;
507 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
509 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
510 extern EFI_HII_STRING_PROTOCOL
*mHiiString
;
511 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
513 extern BANNER_DATA
*gBannerData
;
514 extern EFI_HII_HANDLE gFrontPageHandle
;
515 extern UINTN gClassOfVfr
;
516 extern UINTN gFunctionKeySetting
;
517 extern BOOLEAN gResetRequired
;
518 extern BOOLEAN gNvUpdateRequired
;
519 extern EFI_HII_HANDLE gHiiHandle
;
520 extern UINT16 gDirection
;
521 extern EFI_SCREEN_DESCRIPTOR gScreenDimensions
;
523 extern FORM_BROWSER_FORMSET
*gOldFormSet
;
526 // Browser Global Strings
528 extern CHAR16
*gFunctionNineString
;
529 extern CHAR16
*gFunctionTenString
;
530 extern CHAR16
*gEnterString
;
531 extern CHAR16
*gEnterCommitString
;
532 extern CHAR16
*gEnterEscapeString
;
533 extern CHAR16
*gEscapeString
;
534 extern CHAR16
*gSaveFailed
;
535 extern CHAR16
*gMoveHighlight
;
536 extern CHAR16
*gMakeSelection
;
537 extern CHAR16
*gDecNumericInput
;
538 extern CHAR16
*gHexNumericInput
;
539 extern CHAR16
*gToggleCheckBox
;
540 extern CHAR16
*gPromptForData
;
541 extern CHAR16
*gPromptForPassword
;
542 extern CHAR16
*gPromptForNewPassword
;
543 extern CHAR16
*gConfirmPassword
;
544 extern CHAR16
*gConfirmError
;
545 extern CHAR16
*gPassowordInvalid
;
546 extern CHAR16
*gPressEnter
;
547 extern CHAR16
*gEmptyString
;
548 extern CHAR16
*gAreYouSure
;
549 extern CHAR16
*gYesResponse
;
550 extern CHAR16
*gNoResponse
;
551 extern CHAR16
*gMiniString
;
552 extern CHAR16
*gPlusString
;
553 extern CHAR16
*gMinusString
;
554 extern CHAR16
*gAdjustNumber
;
555 extern CHAR16
*gSaveChanges
;
556 extern CHAR16
*gOptionMismatch
;
557 extern CHAR16
*gFormSuppress
;
559 extern CHAR16 gPromptBlockWidth
;
560 extern CHAR16 gOptionBlockWidth
;
561 extern CHAR16 gHelpBlockWidth
;
563 extern EFI_GUID gZeroGuid
;
564 extern EFI_GUID gTianoHiiIfrGuid
;
568 // Global Procedure Defines
572 Initialize the HII String Token to the correct values.
576 InitializeBrowserStrings (
581 Prints a unicode string to the default console,
584 @param String String pointer.
586 @return Length of string printed to the console
595 Prints a chracter to the default console,
598 @param Character Character to print.
600 @return Length of string printed to the console.
609 Prints a formatted unicode string to the default console, at
610 the supplied cursor position.
612 @param Column The cursor position to print the string at.
613 @param Row The cursor position to print the string at
614 @param Fmt Format string
615 @param ... Variable argument list for formating string.
617 @return Length of string printed to the console
629 Prints a unicode string to the default console, at
630 the supplied cursor position, using L"%s" format.
632 @param Column The cursor position to print the string at.
633 @param Row The cursor position to print the string at
634 @param String String pointer.
636 @return Length of string printed to the console
647 Prints a chracter to the default console, at
648 the supplied cursor position, using L"%c" format.
650 @param Column The cursor position to print the string at.
651 @param Row The cursor position to print the string at.
652 @param Character Character to print.
654 @return Length of string printed to the console.
665 Parse opcodes in the formset IFR binary.
667 @param FormSet Pointer of the FormSet data structure.
669 @retval EFI_SUCCESS Opcode parse success.
670 @retval Other Opcode parse fail.
675 IN FORM_BROWSER_FORMSET
*FormSet
679 Free resources allocated for a FormSet.
681 @param FormSet Pointer of the FormSet
686 IN OUT FORM_BROWSER_FORMSET
*FormSet
690 This function displays the page frame.
699 Create a new string in HII Package List.
701 @param String The String to be added
702 @param HiiHandle The package list in the HII database to insert the
705 @return The output string.
711 IN EFI_HII_HANDLE HiiHandle
715 Delete a string from HII Package List.
717 @param StringId Id of the string in HII database.
718 @param HiiHandle The HII package list handle.
720 @retval EFI_SUCCESS The string was deleted successfully.
725 IN EFI_STRING_ID StringId
,
726 IN EFI_HII_HANDLE HiiHandle
730 Get the string based on the StringId and HII Package List Handle.
732 @param Token The String's ID.
733 @param HiiHandle The package list in the HII database to search for
734 the specified string.
736 @return The output string.
741 IN EFI_STRING_ID Token
,
742 IN EFI_HII_HANDLE HiiHandle
746 Draw a pop up windows based on the dimension, number of lines and
749 @param RequestedWidth The width of the pop-up.
750 @param NumberOfLines The number of lines.
751 @param Marker The variable argument list for the list of string to be printed.
756 IN UINTN RequestedWidth
,
757 IN UINTN NumberOfLines
,
762 Routine used to abstract a generic dialog interface and return the selected key or string
764 @param NumberOfLines The number of lines for the dialog box
765 @param HotKey Defines whether a single character is parsed
766 (TRUE) and returned in KeyValue or a string is
767 returned in StringBuffer. Two special characters
768 are considered when entering a string, a SCAN_ESC
769 and an CHAR_CARRIAGE_RETURN. SCAN_ESC terminates
770 string input and returns
771 @param MaximumStringSize The maximum size in bytes of a typed in string
772 (each character is a CHAR16) and the minimum
773 string returned is two bytes
774 @param StringBuffer The passed in pointer to the buffer which will
775 hold the typed in string if HotKey is FALSE
776 @param KeyValue The EFI_KEY value returned if HotKey is TRUE..
777 @param ... A series of (quantity == NumberOfLines) text
778 strings which will be used to construct the dialog
781 @retval EFI_SUCCESS Displayed dialog and received user interaction
782 @retval EFI_INVALID_PARAMETER One of the parameters was invalid (e.g.
783 (StringBuffer == NULL) && (HotKey == FALSE))
784 @retval EFI_DEVICE_ERROR User typed in an ESC character to exit the routine
789 IN UINTN NumberOfLines
,
791 IN UINTN MaximumStringSize
,
792 OUT CHAR16
*StringBuffer
,
793 OUT EFI_INPUT_KEY
*KeyValue
,
798 Get Question's current Value.
800 @param FormSet FormSet data structure.
801 @param Form Form data structure.
802 @param Question Question to be initialized.
803 @param Cached TRUE: get from Edit copy FALSE: get from original
806 @retval EFI_SUCCESS The function completed successfully.
811 IN FORM_BROWSER_FORMSET
*FormSet
,
812 IN FORM_BROWSER_FORM
*Form
,
813 IN OUT FORM_BROWSER_STATEMENT
*Question
,
818 Save Question Value to edit copy(cached) or Storage(uncached).
820 @param FormSet FormSet data structure.
821 @param Form Form data structure.
822 @param Question Pointer to the Question.
823 @param Cached TRUE: set to Edit copy FALSE: set to original
826 @retval EFI_SUCCESS The function completed successfully.
831 IN FORM_BROWSER_FORMSET
*FormSet
,
832 IN FORM_BROWSER_FORM
*Form
,
833 IN OUT FORM_BROWSER_STATEMENT
*Question
,
838 Perform inconsistent check for a Form.
840 @param FormSet FormSet data structure.
841 @param Form Form data structure.
842 @param Question The Question to be validated.
843 @param Type Validation type: InConsistent or NoSubmit
845 @retval EFI_SUCCESS Form validation pass.
846 @retval other Form validation failed.
851 IN FORM_BROWSER_FORMSET
*FormSet
,
852 IN FORM_BROWSER_FORM
*Form
,
853 IN FORM_BROWSER_STATEMENT
*Question
,
860 @param FormSet FormSet data structure.
861 @param Form Form data structure.
863 @retval EFI_SUCCESS The function completed successfully.
868 IN FORM_BROWSER_FORMSET
*FormSet
,
869 IN FORM_BROWSER_FORM
*Form
873 Reset Question to its default value.
875 @param FormSet The form set.
876 @param Form The form.
877 @param Question The question.
878 @param DefaultId The Class of the default.
880 @retval EFI_SUCCESS Question is reset to default value.
885 IN FORM_BROWSER_FORMSET
*FormSet
,
886 IN FORM_BROWSER_FORM
*Form
,
887 IN FORM_BROWSER_STATEMENT
*Question
,
892 Get current setting of Questions.
894 @param FormSet FormSet data structure.
896 @retval EFI_SUCCESS The function completed successfully.
900 InitializeCurrentSetting (
901 IN OUT FORM_BROWSER_FORMSET
*FormSet
905 Initialize the internal data structure of a FormSet.
907 @param Handle PackageList Handle
908 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
909 GUID), take the first FormSet found in package
911 @param FormSet FormSet data structure.
913 @retval EFI_SUCCESS The function completed successfully.
914 @retval EFI_NOT_FOUND The specified FormSet could not be found.
919 IN EFI_HII_HANDLE Handle
,
920 IN OUT EFI_GUID
*FormSetGuid
,
921 OUT FORM_BROWSER_FORMSET
*FormSet
925 Reset Questions in a Form to their default value.
927 @param FormSet FormSet data structure.
928 @param Form The Form which to be reset.
929 @param DefaultId The Class of the default.
931 @retval EFI_SUCCESS The function completed successfully.
936 IN FORM_BROWSER_FORMSET
*FormSet
,
937 IN FORM_BROWSER_FORM
*Form
,
942 Initialize Question's Edit copy from Storage.
944 @param Selection Selection contains the information about
945 the Selection, form and formset to be displayed.
946 Selection action may be updated in retrieve callback.
947 @param FormSet FormSet data structure.
948 @param Form Form data structure.
950 @retval EFI_SUCCESS The function completed successfully.
955 IN OUT UI_MENU_SELECTION
*Selection
,
956 IN FORM_BROWSER_FORMSET
*FormSet
,
957 IN FORM_BROWSER_FORM
*Form
961 Initialize Question's Edit copy from Storage for the whole Formset.
963 @param Selection Selection contains the information about
964 the Selection, form and formset to be displayed.
965 Selection action may be updated in retrieve callback.
966 @param FormSet FormSet data structure.
968 @retval EFI_SUCCESS The function completed successfully.
973 IN OUT UI_MENU_SELECTION
*Selection
,
974 IN FORM_BROWSER_FORMSET
*FormSet
978 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
980 @param Storage The Storage to be conveted.
981 @param ConfigResp The returned <ConfigResp>.
983 @retval EFI_SUCCESS Convert success.
984 @retval EFI_INVALID_PARAMETER Incorrect storage type.
988 StorageToConfigResp (
989 IN FORMSET_STORAGE
*Storage
,
990 IN CHAR16
**ConfigResp
994 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
996 @param Storage The Storage to receive the settings.
997 @param ConfigResp The <ConfigResp> to be converted.
999 @retval EFI_SUCCESS Convert success.
1000 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1004 ConfigRespToStorage (
1005 IN FORMSET_STORAGE
*Storage
,
1006 IN CHAR16
*ConfigResp
1010 Fill storage's edit copy with settings requested from Configuration Driver.
1012 @param FormSet FormSet data structure.
1013 @param Storage Buffer Storage.
1015 @retval EFI_SUCCESS The function completed successfully.
1020 IN FORM_BROWSER_FORMSET
*FormSet
,
1021 IN FORMSET_STORAGE
*Storage
1025 Fetch the Ifr binary data of a FormSet.
1027 @param Handle PackageList Handle
1028 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1029 GUID), take the first FormSet found in package
1031 @param BinaryLength The length of the FormSet IFR binary.
1032 @param BinaryData The buffer designed to receive the FormSet.
1034 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
1035 BufferLength was updated.
1036 @retval EFI_INVALID_PARAMETER The handle is unknown.
1037 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1038 be found with the requested FormId.
1043 IN EFI_HII_HANDLE Handle
,
1044 IN OUT EFI_GUID
*FormSetGuid
,
1045 OUT UINTN
*BinaryLength
,
1046 OUT UINT8
**BinaryData
1050 Save globals used by previous call to SendForm(). SendForm() may be called from
1051 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1052 So, save globals of previous call to SendForm() and restore them upon exit.
1056 SaveBrowserContext (
1061 Restore globals used by previous call to SendForm().
1065 RestoreBrowserContext (
1070 This is the routine which an external caller uses to direct the browser
1071 where to obtain it's information.
1074 @param This The Form Browser protocol instanse.
1075 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1076 display a list of the formsets for the handles specified.
1077 @param HandleCount The number of Handles specified in Handle.
1078 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1079 field in the EFI_IFR_FORM_SET op-code for the specified
1080 forms-based package. If FormSetGuid is NULL, then this
1081 function will display the first found forms package.
1082 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1083 displayable page. If this field has a value of 0x0000, then
1084 the forms browser will render the specified forms in their encoded order.
1085 ScreenDimenions - This allows the browser to be called so that it occupies a
1086 portion of the physical screen instead of dynamically determining the screen dimensions.
1087 ActionRequest - Points to the action recommended by the form.
1088 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1090 @param ActionRequest Points to the action recommended by the form.
1092 @retval EFI_SUCCESS The function completed successfully.
1093 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1094 @retval EFI_NOT_FOUND No valid forms could be found to display.
1100 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1101 IN EFI_HII_HANDLE
*Handles
,
1102 IN UINTN HandleCount
,
1103 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1104 IN UINT16 FormId
, OPTIONAL
1105 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1106 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1110 This function is called by a callback handler to retrieve uncommitted state
1111 data from the browser.
1113 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1115 @param ResultsDataSize A pointer to the size of the buffer associated
1117 @param ResultsData A string returned from an IFR browser or
1118 equivalent. The results string will have no
1119 routing information in them.
1120 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1121 (if RetrieveData = TRUE) data from the uncommitted
1122 browser state information or set (if RetrieveData
1123 = FALSE) data in the uncommitted browser state
1125 @param VariableGuid An optional field to indicate the target variable
1127 @param VariableName An optional field to indicate the target
1128 human-readable variable name.
1130 @retval EFI_SUCCESS The results have been distributed or are awaiting
1132 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1133 contain the results data.
1139 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1140 IN OUT UINTN
*ResultsDataSize
,
1141 IN OUT EFI_STRING ResultsData
,
1142 IN BOOLEAN RetrieveData
,
1143 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1144 IN CONST CHAR16
*VariableName OPTIONAL