2 Private MACRO, structure and function definitions for Setup Browser module.
4 Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>
5 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/FormBrowserEx2.h>
26 #include <Protocol/DisplayProtocol.h>
27 #include <Protocol/DevicePath.h>
28 #include <Protocol/UnicodeCollation.h>
29 #include <Protocol/HiiConfigAccess.h>
30 #include <Protocol/HiiConfigRouting.h>
31 #include <Protocol/HiiDatabase.h>
32 #include <Protocol/HiiString.h>
33 #include <Protocol/UserManager.h>
34 #include <Protocol/DevicePathFromText.h>
36 #include <Guid/MdeModuleHii.h>
37 #include <Guid/HiiPlatformSetupFormset.h>
38 #include <Guid/HiiFormMapMethodGuid.h>
40 #include <Library/PrintLib.h>
41 #include <Library/DebugLib.h>
42 #include <Library/BaseMemoryLib.h>
43 #include <Library/UefiRuntimeServicesTableLib.h>
44 #include <Library/UefiDriverEntryPoint.h>
45 #include <Library/UefiBootServicesTableLib.h>
46 #include <Library/BaseLib.h>
47 #include <Library/MemoryAllocationLib.h>
48 #include <Library/HiiLib.h>
49 #include <Library/PcdLib.h>
50 #include <Library/DevicePathLib.h>
51 #include <Library/UefiLib.h>
55 // This is the generated header file which includes whatever needs to be exported (strings + IFR)
58 #define UI_ACTION_NONE 0
59 #define UI_ACTION_REFRESH_FORM 1
60 #define UI_ACTION_REFRESH_FORMSET 2
61 #define UI_ACTION_EXIT 3
67 #define ONE_SECOND 10000000
69 // Incremental string lenght of ConfigRequest
71 #define CONFIG_REQUEST_STRING_INCREMENTAL 1024
74 // Incremental size of stack for expression
76 #define EXPRESSION_STACK_SIZE_INCREMENT 0x100
78 #define EFI_IFR_SPECIFICATION_VERSION (UINT16) (((EFI_SYSTEM_TABLE_REVISION >> 16) << 8) | (((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) / 10) << 4) | ((EFI_SYSTEM_TABLE_REVISION & 0xFFFF) % 10))
81 #define SETUP_DRIVER_SIGNATURE SIGNATURE_32 ('F', 'B', 'D', 'V')
90 EFI_FORM_BROWSER2_PROTOCOL FormBrowser2
;
91 EFI_FORM_BROWSER_EXTENSION_PROTOCOL FormBrowserEx
;
93 EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL FormBrowserEx2
;
95 } SETUP_DRIVER_PRIVATE_DATA
;
98 // IFR relative definition
100 #define EFI_HII_EXPRESSION_INCONSISTENT_IF 0
101 #define EFI_HII_EXPRESSION_NO_SUBMIT_IF 1
102 #define EFI_HII_EXPRESSION_GRAY_OUT_IF 2
103 #define EFI_HII_EXPRESSION_SUPPRESS_IF 3
104 #define EFI_HII_EXPRESSION_DISABLE_IF 4
105 #define EFI_HII_EXPRESSION_VALUE 5
106 #define EFI_HII_EXPRESSION_RULE 6
107 #define EFI_HII_EXPRESSION_READ 7
108 #define EFI_HII_EXPRESSION_WRITE 8
109 #define EFI_HII_EXPRESSION_WARNING_IF 9
111 #define EFI_HII_VARSTORE_BUFFER 0
112 #define EFI_HII_VARSTORE_NAME_VALUE 1
113 #define EFI_HII_VARSTORE_EFI_VARIABLE 2 // EFI Varstore type follow UEFI spec before 2.3.1.
114 #define EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER 3 // EFI varstore type follow UEFI spec 2.3.1 and later.
116 #define FORM_INCONSISTENT_VALIDATION 0
117 #define FORM_NO_SUBMIT_VALIDATION 1
119 #define NAME_VALUE_NODE_SIGNATURE SIGNATURE_32 ('N', 'V', 'S', 'T')
129 #define NAME_VALUE_NODE_FROM_LINK(a) CR (a, NAME_VALUE_NODE, Link, NAME_VALUE_NODE_SIGNATURE)
131 #define BROWSER_STORAGE_SIGNATURE SIGNATURE_32 ('B', 'S', 'T', 'G')
137 UINT8 Type
; // Storage type
141 CHAR16
*Name
; // For EFI_IFR_VARSTORE
144 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
146 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
148 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
150 CHAR16
*ConfigHdr
; // <ConfigHdr>
151 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
152 // <RequestElement> includes all fields which is used by current form sets.
153 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
156 #define BROWSER_STORAGE_FROM_LINK(a) CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)
158 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
166 BROWSER_STORAGE
*BrowserStorage
;
168 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
169 CHAR16
*ConfigElements
;// Elements need to load initial data.
170 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
171 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
174 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
177 EFI_STRING_ID VarName
;
181 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
189 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
190 UINT8 Flags
; // For EFI_IFR_SPAN
191 UINT8 RuleId
; // For EFI_IFR_RULE_REF
193 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
195 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
196 EFI_QUESTION_ID QuestionId2
;
198 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
201 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
204 BROWSER_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
205 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
206 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
207 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
208 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
209 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
212 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
214 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
220 UINT8 Type
; // Type for this expression
222 UINT8 RuleId
; // For EFI_IFR_RULE only
223 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
225 EFI_HII_VALUE Result
; // Expression evaluation result
227 UINT8 TimeOut
; // For EFI_IFR_WARNING_IF
229 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
232 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
234 #define FORM_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')
239 FORM_EXPRESSION
*Expression
[1]; // Array[Count] of expressions
240 } FORM_EXPRESSION_LIST
;
242 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
249 EFI_HII_VALUE Value
; // Default value
251 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
254 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
256 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
262 EFI_IFR_ONE_OF_OPTION
*OpCode
; // OneOfOption Data
267 EFI_IMAGE_ID ImageId
;
269 FORM_EXPRESSION_LIST
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
272 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
288 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
294 UINT8 Operand
; // The operand (first byte) of this Statement or Question
295 EFI_IFR_OP_HEADER
*OpCode
;
300 EFI_STRING_ID Prompt
;
302 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
305 // Fake Question Id, used for statement not has true QuestionId.
307 EFI_QUESTION_ID FakeQuestionId
;
312 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
313 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
314 BROWSER_STORAGE
*Storage
;
315 VAR_STORE_INFO VarStoreInfo
;
318 CHAR16
*VariableName
; // Name/Value or EFI Variable name
319 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
321 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
322 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
323 UINT8 ValueType
; // Data type for orderedlist value array
326 // OpCode specific members
328 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
329 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
330 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
332 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
333 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
335 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
336 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
339 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
340 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
341 BOOLEAN Locked
; // Whether this statement is locked.
342 BOOLEAN ValueChanged
; // Whether this statement's value is changed.
344 // Get from IFR parsing
346 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
347 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
348 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
350 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
351 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
352 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
354 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
355 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
356 LIST_ENTRY WarningListHead
; // nested warning expression list (FORM_EXPRESSION)
357 FORM_EXPRESSION_LIST
*Expression
; // nesting inside of GrayOutIf/DisableIf/SuppressIf
359 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
360 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
361 } FORM_BROWSER_STATEMENT
;
363 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
365 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
370 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
371 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
374 BROWSER_STORAGE
*Storage
;
375 } FORM_BROWSER_CONFIG_REQUEST
;
376 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
378 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
379 #define STANDARD_MAP_FORM_TYPE 0x01
385 UINT16 FormId
; // FormId of normal form or formmap form.
386 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
387 UINT16 FormType
; // Specific form type for the different form.
389 EFI_IMAGE_ID ImageId
;
391 BOOLEAN ModalForm
; // Whether this is a modal form.
392 BOOLEAN Locked
; // Whether this form is locked.
394 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
395 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
396 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
397 FORM_EXPRESSION_LIST
*SuppressExpression
; // nesting inside of SuppressIf
400 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
402 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
409 EFI_STRING_ID DefaultName
;
410 } FORMSET_DEFAULTSTORE
;
412 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
414 #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
419 EFI_HII_HANDLE HiiHandle
; // unique id for formset.
420 EFI_HANDLE DriverHandle
;
421 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
422 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
424 UINTN IfrBinaryLength
;
425 UINT8
*IfrBinaryData
;
427 BOOLEAN QuestionInited
; // Have finished question initilization?
429 EFI_STRING_ID FormSetTitle
;
431 UINT8 NumberOfClassGuid
;
432 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
433 UINT16 Class
; // Tiano extended Class code
434 UINT16 SubClass
; // Tiano extended Subclass code
435 EFI_IMAGE_ID ImageId
;
437 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
438 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
440 LIST_ENTRY StatementListOSF
; // Statement list out side of the form.
441 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
442 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
443 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
444 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
445 } FORM_BROWSER_FORMSET
;
446 #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
450 EFI_EVENT RefreshEvent
;
451 } FORM_BROWSER_REFRESH_EVENT_NODE
;
453 #define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a) BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)
457 EFI_HII_HANDLE Handle
;
460 // Target formset/form/Question information
462 EFI_GUID FormSetGuid
;
465 UINTN Sequence
; // used for time/date only.
474 // Ation for Browser to taken:
475 // UI_ACTION_NONE - navigation inside a form
476 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
477 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
482 // Current selected fomset/form/Question
484 FORM_BROWSER_FORMSET
*FormSet
;
485 FORM_BROWSER_FORM
*Form
;
486 FORM_BROWSER_STATEMENT
*Statement
;
489 // Whether the Form is editable
491 BOOLEAN FormEditable
;
493 FORM_ENTRY_INFO
*CurrentMenu
;
496 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
503 // Globals defined in Setup.c
505 BOOLEAN ResetRequired
;
506 BOOLEAN ExitRequired
;
507 EFI_HII_HANDLE HiiHandle
;
508 EFI_GUID FormSetGuid
;
510 UI_MENU_SELECTION
*Selection
;
512 LIST_ENTRY FormHistoryList
;
515 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
518 // Scope for get defaut value. It may be GetDefaultForNoStorage, GetDefaultForStorage or GetDefaultForAll.
521 GetDefaultForNoStorage
, // Get default value for question which not has storage.
522 GetDefaultForStorage
, // Get default value for question which has storage.
523 GetDefaultForAll
, // Get default value for all questions.
524 GetDefaultForMax
// Invalid value.
525 } BROWSER_GET_DEFAULT_VALUE
;
528 // Get/set question value from/to.
531 GetSetValueWithEditBuffer
, // Get/Set question value from/to editbuffer in the storage.
532 GetSetValueWithBuffer
, // Get/Set question value from/to buffer in the storage.
533 GetSetValueWithHiiDriver
, // Get/Set question value from/to hii driver.
534 GetSetValueWithMax
// Invalid value.
535 } GET_SET_QUESTION_VALUE_WITH
;
537 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
538 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
539 extern EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*mPathFromText
;
540 extern EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
*mFormDisplay
;
542 extern BOOLEAN gResetRequired
;
543 extern BOOLEAN gExitRequired
;
545 extern LIST_ENTRY gBrowserFormSetList
;
546 extern LIST_ENTRY gBrowserHotKeyList
;
547 extern BROWSER_SETTING_SCOPE gBrowserSettingScope
;
548 extern EXIT_HANDLER ExitHandlerFunction
;
549 extern EFI_HII_HANDLE mCurrentHiiHandle
;
550 extern SETUP_DRIVER_PRIVATE_DATA mPrivateData
;
552 // Browser Global Strings
554 extern CHAR16
*gEmptyString
;
556 extern EFI_GUID gZeroGuid
;
558 extern UI_MENU_SELECTION
*gCurrentSelection
;
561 // Global Procedure Defines
563 #include "Expression.h"
566 Initialize the HII String Token to the correct values.
570 InitializeBrowserStrings (
575 Parse opcodes in the formset IFR binary.
577 @param FormSet Pointer of the FormSet data structure.
579 @retval EFI_SUCCESS Opcode parse success.
580 @retval Other Opcode parse fail.
585 IN FORM_BROWSER_FORMSET
*FormSet
589 Free resources allocated for a FormSet.
591 @param FormSet Pointer of the FormSet
596 IN OUT FORM_BROWSER_FORMSET
*FormSet
601 Create a new string in HII Package List.
603 @param String The String to be added
604 @param HiiHandle The package list in the HII database to insert the
607 @return The output string.
613 IN EFI_HII_HANDLE HiiHandle
617 Delete a string from HII Package List.
619 @param StringId Id of the string in HII database.
620 @param HiiHandle The HII package list handle.
622 @retval EFI_SUCCESS The string was deleted successfully.
627 IN EFI_STRING_ID StringId
,
628 IN EFI_HII_HANDLE HiiHandle
632 Get the string based on the StringId and HII Package List Handle.
634 @param Token The String's ID.
635 @param HiiHandle The package list in the HII database to search for
636 the specified string.
638 @return The output string.
643 IN EFI_STRING_ID Token
,
644 IN EFI_HII_HANDLE HiiHandle
648 Get Value for given Name from a NameValue Storage.
650 @param Storage The NameValue Storage.
651 @param Name The Name.
652 @param Value The retured Value.
653 @param GetValueFrom Where to get source value, from EditValue or Value.
655 @retval EFI_SUCCESS Value found for given Name.
656 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
661 IN BROWSER_STORAGE
*Storage
,
663 IN OUT CHAR16
**Value
,
664 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
668 Set Value of given Name in a NameValue Storage.
670 @param Storage The NameValue Storage.
671 @param Name The Name.
672 @param Value The Value to set.
673 @param SetValueTo Whether update editValue or Value.
674 @param ReturnNode The node use the input name.
676 @retval EFI_SUCCESS Value found for given Name.
677 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
682 IN BROWSER_STORAGE
*Storage
,
685 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
,
686 OUT NAME_VALUE_NODE
**ReturnNode
690 Validate whether this question's value has changed.
692 @param FormSet FormSet data structure.
693 @param Form Form data structure.
694 @param Question Question to be initialized.
695 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
697 @retval TRUE Question's value has changed.
698 @retval FALSE Question's value has not changed
702 IsQuestionValueChanged (
703 IN FORM_BROWSER_FORMSET
*FormSet
,
704 IN FORM_BROWSER_FORM
*Form
,
705 IN OUT FORM_BROWSER_STATEMENT
*Question
,
706 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
710 Get Question's current Value.
712 @param FormSet FormSet data structure.
713 @param Form Form data structure.
714 @param Question Question to be initialized.
715 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
717 @retval EFI_SUCCESS The function completed successfully.
722 IN FORM_BROWSER_FORMSET
*FormSet
,
723 IN FORM_BROWSER_FORM
*Form
,
724 IN OUT FORM_BROWSER_STATEMENT
*Question
,
725 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
729 Save Question Value to edit copy(cached) or Storage(uncached).
731 @param FormSet FormSet data structure.
732 @param Form Form data structure.
733 @param Question Pointer to the Question.
734 @param SetValueTo Update the question value to editbuffer , buffer or hii driver.
736 @retval EFI_SUCCESS The function completed successfully.
741 IN FORM_BROWSER_FORMSET
*FormSet
,
742 IN FORM_BROWSER_FORM
*Form
,
743 IN OUT FORM_BROWSER_STATEMENT
*Question
,
744 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
748 Perform inconsistent check for a Form.
750 @param FormSet FormSet data structure.
751 @param Form Form data structure.
752 @param Question The Question to be validated.
753 @param Type Validation type: InConsistent or NoSubmit
755 @retval EFI_SUCCESS Form validation pass.
756 @retval other Form validation failed.
761 IN FORM_BROWSER_FORMSET
*FormSet
,
762 IN FORM_BROWSER_FORM
*Form
,
763 IN FORM_BROWSER_STATEMENT
*Question
,
769 Discard data based on the input setting scope (Form, FormSet or System).
771 @param FormSet FormSet data structure.
772 @param Form Form data structure.
773 @param SettingScope Setting Scope for Discard action.
775 @retval EFI_SUCCESS The function completed successfully.
776 @retval EFI_UNSUPPORTED Unsupport SettingScope.
781 IN FORM_BROWSER_FORMSET
*FormSet
,
782 IN FORM_BROWSER_FORM
*Form
,
783 IN BROWSER_SETTING_SCOPE SettingScope
787 Submit data based on the input Setting level (Form, FormSet or System).
789 @param FormSet FormSet data structure.
790 @param Form Form data structure.
791 @param SettingScope Setting Scope for Submit action.
793 @retval EFI_SUCCESS The function completed successfully.
794 @retval EFI_UNSUPPORTED Unsupport SettingScope.
799 IN FORM_BROWSER_FORMSET
*FormSet
,
800 IN FORM_BROWSER_FORM
*Form
,
801 IN BROWSER_SETTING_SCOPE SettingScope
805 Reset Question to its default value.
807 @param FormSet The form set.
808 @param Form The form.
809 @param Question The question.
810 @param DefaultId The Class of the default.
812 @retval EFI_SUCCESS Question is reset to default value.
817 IN FORM_BROWSER_FORMSET
*FormSet
,
818 IN FORM_BROWSER_FORM
*Form
,
819 IN FORM_BROWSER_STATEMENT
*Question
,
824 Get current setting of Questions.
826 @param FormSet FormSet data structure.
830 InitializeCurrentSetting (
831 IN OUT FORM_BROWSER_FORMSET
*FormSet
835 Initialize the internal data structure of a FormSet.
837 @param Handle PackageList Handle
838 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
839 GUID), take the first FormSet found in package
841 @param FormSet FormSet data structure.
843 @retval EFI_SUCCESS The function completed successfully.
844 @retval EFI_NOT_FOUND The specified FormSet could not be found.
849 IN EFI_HII_HANDLE Handle
,
850 IN OUT EFI_GUID
*FormSetGuid
,
851 OUT FORM_BROWSER_FORMSET
*FormSet
855 Reset Questions to their initial value or default value in a Form, Formset or System.
857 GetDefaultValueScope parameter decides which questions will reset
858 to its default value.
860 @param FormSet FormSet data structure.
861 @param Form Form data structure.
862 @param DefaultId The Class of the default.
863 @param SettingScope Setting Scope for Default action.
864 @param GetDefaultValueScope Get default value scope.
865 @param Storage Get default value only for this storage.
866 @param RetrieveValueFirst Whether call the retrieve call back to
867 get the initial value before get default
870 @retval EFI_SUCCESS The function completed successfully.
871 @retval EFI_UNSUPPORTED Unsupport SettingScope.
876 IN FORM_BROWSER_FORMSET
*FormSet
,
877 IN FORM_BROWSER_FORM
*Form
,
879 IN BROWSER_SETTING_SCOPE SettingScope
,
880 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope
,
881 IN BROWSER_STORAGE
*Storage
,
882 IN BOOLEAN RetrieveValueFirst
886 Initialize Question's Edit copy from Storage.
888 @param Selection Selection contains the information about
889 the Selection, form and formset to be displayed.
890 Selection action may be updated in retrieve callback.
891 If Selection is NULL, only initialize Question value.
892 @param FormSet FormSet data structure.
893 @param Form Form data structure.
895 @retval EFI_SUCCESS The function completed successfully.
900 IN OUT UI_MENU_SELECTION
*Selection
,
901 IN FORM_BROWSER_FORMSET
*FormSet
,
902 IN FORM_BROWSER_FORM
*Form
906 Initialize Question's Edit copy from Storage for the whole Formset.
908 @param Selection Selection contains the information about
909 the Selection, form and formset to be displayed.
910 Selection action may be updated in retrieve callback.
911 If Selection is NULL, only initialize Question value.
912 @param FormSet FormSet data structure.
914 @retval EFI_SUCCESS The function completed successfully.
919 IN OUT UI_MENU_SELECTION
*Selection
,
920 IN FORM_BROWSER_FORMSET
*FormSet
924 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
926 @param Storage The Storage to be conveted.
927 @param ConfigResp The returned <ConfigResp>.
928 @param ConfigRequest The ConfigRequest string.
929 @param GetEditBuf Get the data from editbuffer or buffer.
931 @retval EFI_SUCCESS Convert success.
932 @retval EFI_INVALID_PARAMETER Incorrect storage type.
936 StorageToConfigResp (
937 IN BROWSER_STORAGE
*Storage
,
938 IN CHAR16
**ConfigResp
,
939 IN CHAR16
*ConfigRequest
,
940 IN BOOLEAN GetEditBuf
944 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
946 @param Storage The Storage to receive the settings.
947 @param ConfigResp The <ConfigResp> to be converted.
949 @retval EFI_SUCCESS Convert success.
950 @retval EFI_INVALID_PARAMETER Incorrect storage type.
954 ConfigRespToStorage (
955 IN BROWSER_STORAGE
*Storage
,
956 IN CHAR16
*ConfigResp
960 Fill storage's edit copy with settings requested from Configuration Driver.
962 @param FormSet FormSet data structure.
963 @param Storage Buffer Storage.
968 IN FORM_BROWSER_FORMSET
*FormSet
,
969 IN FORMSET_STORAGE
*Storage
973 Fetch the Ifr binary data of a FormSet.
975 @param Handle PackageList Handle
976 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
977 GUID), take the first FormSet found in package
979 @param BinaryLength The length of the FormSet IFR binary.
980 @param BinaryData The buffer designed to receive the FormSet.
982 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
983 BufferLength was updated.
984 @retval EFI_INVALID_PARAMETER The handle is unknown.
985 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
986 be found with the requested FormId.
991 IN EFI_HII_HANDLE Handle
,
992 IN OUT EFI_GUID
*FormSetGuid
,
993 OUT UINTN
*BinaryLength
,
994 OUT UINT8
**BinaryData
998 Save globals used by previous call to SendForm(). SendForm() may be called from
999 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1000 So, save globals of previous call to SendForm() and restore them upon exit.
1004 SaveBrowserContext (
1009 Restore globals used by previous call to SendForm().
1013 RestoreBrowserContext (
1018 This is the routine which an external caller uses to direct the browser
1019 where to obtain it's information.
1022 @param This The Form Browser protocol instanse.
1023 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1024 display a list of the formsets for the handles specified.
1025 @param HandleCount The number of Handles specified in Handle.
1026 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1027 field in the EFI_IFR_FORM_SET op-code for the specified
1028 forms-based package. If FormSetGuid is NULL, then this
1029 function will display the first found forms package.
1030 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1031 displayable page. If this field has a value of 0x0000, then
1032 the forms browser will render the specified forms in their encoded order.
1033 ScreenDimenions - This allows the browser to be called so that it occupies a
1034 portion of the physical screen instead of dynamically determining the screen dimensions.
1035 ActionRequest - Points to the action recommended by the form.
1036 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1038 @param ActionRequest Points to the action recommended by the form.
1040 @retval EFI_SUCCESS The function completed successfully.
1041 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1042 @retval EFI_NOT_FOUND No valid forms could be found to display.
1048 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1049 IN EFI_HII_HANDLE
*Handles
,
1050 IN UINTN HandleCount
,
1051 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1052 IN UINT16 FormId
, OPTIONAL
1053 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1054 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1058 This function is called by a callback handler to retrieve uncommitted state
1059 data from the browser.
1061 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1063 @param ResultsDataSize A pointer to the size of the buffer associated
1065 @param ResultsData A string returned from an IFR browser or
1066 equivalent. The results string will have no
1067 routing information in them.
1068 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1069 (if RetrieveData = TRUE) data from the uncommitted
1070 browser state information or set (if RetrieveData
1071 = FALSE) data in the uncommitted browser state
1073 @param VariableGuid An optional field to indicate the target variable
1075 @param VariableName An optional field to indicate the target
1076 human-readable variable name.
1078 @retval EFI_SUCCESS The results have been distributed or are awaiting
1080 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1081 contain the results data.
1087 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1088 IN OUT UINTN
*ResultsDataSize
,
1089 IN OUT EFI_STRING ResultsData
,
1090 IN BOOLEAN RetrieveData
,
1091 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1092 IN CONST CHAR16
*VariableName OPTIONAL
1096 Find menu which will show next time.
1098 @param Selection On input, Selection tell setup browser the information
1099 about the Selection, form and formset to be displayed.
1100 On output, Selection return the screen item that is selected
1102 @param SettingLevel Input Settting level, if it is FormLevel, just exit current form.
1103 else, we need to exit current formset.
1105 @retval TRUE Exit current form.
1106 @retval FALSE User press ESC and keep in current form.
1110 IN OUT UI_MENU_SELECTION
*Selection
,
1111 IN BROWSER_SETTING_SCOPE SettingLevel
1115 check whether the form need to update the NV.
1117 @param Form Form data structure.
1119 @retval TRUE Need to update the NV.
1120 @retval FALSE No need to update the NV.
1123 IsNvUpdateRequiredForForm (
1124 IN FORM_BROWSER_FORM
*Form
1128 check whether the formset need to update the NV.
1130 @param FormSet FormSet data structure.
1132 @retval TRUE Need to update the NV.
1133 @retval FALSE No need to update the NV.
1136 IsNvUpdateRequiredForFormSet (
1137 IN FORM_BROWSER_FORMSET
*FormSet
1141 Check whether the storage data for current form set is changed.
1143 @param FormSet FormSet data structure.
1145 @retval TRUE Data is changed.
1146 @retval FALSE Data is not changed.
1149 IsStorageDataChangedForFormSet (
1150 IN FORM_BROWSER_FORMSET
*FormSet
1154 Call the call back function for the question and process the return action.
1156 @param Selection On input, Selection tell setup browser the information
1157 about the Selection, form and formset to be displayed.
1158 On output, Selection return the screen item that is selected
1160 @param Statement The Question which need to call.
1161 @param Action The action request.
1162 @param SkipSaveOrDiscard Whether skip save or discard action.
1164 @retval EFI_SUCCESS The call back function excutes successfully.
1165 @return Other value if the call back function failed to excute.
1168 ProcessCallBackFunction (
1169 IN OUT UI_MENU_SELECTION
*Selection
,
1170 IN FORM_BROWSER_STATEMENT
*Question
,
1171 IN EFI_BROWSER_ACTION Action
,
1172 IN BOOLEAN SkipSaveOrDiscard
1176 Call the retrieve type call back function for one question to get the initialize data.
1178 This function only used when in the initialize stage, because in this stage, the
1179 Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.
1181 @param ConfigAccess The config access protocol produced by the hii driver.
1182 @param Statement The Question which need to call.
1184 @retval EFI_SUCCESS The call back function excutes successfully.
1185 @return Other value if the call back function failed to excute.
1188 ProcessRetrieveForQuestion (
1189 IN EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
,
1190 IN FORM_BROWSER_STATEMENT
*Statement
1194 Find the matched FormSet context in the backup maintain list based on HiiHandle.
1196 @param Handle The Hii Handle.
1198 @return the found FormSet context. If no found, NULL will return.
1201 FORM_BROWSER_FORMSET
*
1202 GetFormSetFromHiiHandle (
1203 EFI_HII_HANDLE Handle
1207 Check whether the input HII handle is the FormSet that is being used.
1209 @param Handle The Hii Handle.
1211 @retval TRUE HII handle is being used.
1212 @retval FALSE HII handle is not being used.
1216 IsHiiHandleInBrowserContext (
1217 EFI_HII_HANDLE Handle
1221 Configure what scope the hot key will impact.
1222 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1223 If no scope is set, the default scope will be FormSet level.
1224 After all registered hot keys are removed, previous Scope can reset to another level.
1226 @param[in] Scope Scope level to be set.
1228 @retval EFI_SUCCESS Scope is set correctly.
1229 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1230 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1236 IN BROWSER_SETTING_SCOPE Scope
1240 Register the hot key with its browser action, or unregistered the hot key.
1241 Only support hot key that is not printable character (control key, function key, etc.).
1242 If the action value is zero, the hot key will be unregistered if it has been registered.
1243 If the same hot key has been registered, the new action and help string will override the previous ones.
1245 @param[in] KeyData A pointer to a buffer that describes the keystroke
1246 information for the hot key. Its type is EFI_INPUT_KEY to
1247 be supported by all ConsoleIn devices.
1248 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1249 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1250 @param[in] HelpString Help string that describes the hot key information.
1251 Its value may be NULL for the unregistered hot key.
1253 @retval EFI_SUCCESS Hot key is registered or unregistered.
1254 @retval EFI_INVALID_PARAMETER KeyData is NULL.
1255 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1256 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1261 IN EFI_INPUT_KEY
*KeyData
,
1263 IN UINT16 DefaultId
,
1264 IN EFI_STRING HelpString OPTIONAL
1268 Register Exit handler function.
1269 When more than one handler function is registered, the latter one will override the previous one.
1270 When NULL handler is specified, the previous Exit handler will be unregistered.
1272 @param[in] Handler Pointer to handler function.
1277 RegiserExitHandler (
1278 IN EXIT_HANDLER Handler
1283 Check whether the browser data has been modified.
1285 @retval TRUE Browser data is changed.
1286 @retval FALSE No browser data is changed.
1291 IsBrowserDataModified (
1297 Execute the action requested by the Action parameter.
1299 @param[in] Action Execute the request action.
1300 @param[in] DefaultId The default Id info when need to load default value.
1302 @retval EFI_SUCCESS Execute the request action succss.
1303 @retval EFI_INVALID_PARAMETER The input action value is invalid.
1314 Create reminder to let user to choose save or discard the changed browser data.
1315 Caller can use it to actively check the changed browser data.
1317 @retval BROWSER_NO_CHANGES No browser data is changed.
1318 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1319 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1329 Find the registered HotKey based on KeyData.
1331 @param[in] KeyData A pointer to a buffer that describes the keystroke
1332 information for the hot key.
1334 @return The registered HotKey context. If no found, NULL will return.
1337 GetHotKeyFromRegisterList (
1338 IN EFI_INPUT_KEY
*KeyData
1343 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1345 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1347 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1350 FORM_BROWSER_STATEMENT
*
1351 GetBrowserStatement (
1352 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1356 Password may be stored as encrypted by Configuration Driver. When change a
1357 password, user will be challenged with old password. To validate user input old
1358 password, we will send the clear text to Configuration Driver via Callback().
1359 Configuration driver is responsible to check the passed in password and return
1360 the validation result. If validation pass, state machine in password Callback()
1361 will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD.
1362 After user type in new password twice, Callback() will be invoked to send the
1363 new password to Configuration Driver.
1365 @param Selection Pointer to UI_MENU_SELECTION.
1366 @param MenuOption The MenuOption for this password Question.
1367 @param String The clear text of password.
1369 @retval EFI_NOT_AVAILABLE_YET Callback() request to terminate password input.
1370 @return In state of BROWSER_STATE_VALIDATE_PASSWORD:
1371 @retval EFI_SUCCESS Password correct, Browser will prompt for new
1373 @retval EFI_NOT_READY Password incorrect, Browser will show error
1375 @retval Other Browser will do nothing.
1376 @return In state of BROWSER_STATE_SET_PASSWORD:
1377 @retval EFI_SUCCESS Set password success.
1378 @retval Other Set password failed.
1383 IN UI_MENU_SELECTION
*Selection
,
1384 IN FORM_BROWSER_STATEMENT
*Question
,
1389 Display error message for invalid password.
1398 The worker function that send the displays to the screen. On output,
1399 the selection made by user is returned.
1401 @param Selection On input, Selection tell setup browser the information
1402 about the Selection, form and formset to be displayed.
1403 On output, Selection return the screen item that is selected
1406 @retval EFI_SUCCESS The page is displayed successfully.
1407 @return Other value if the page failed to be diplayed.
1412 IN OUT UI_MENU_SELECTION
*Selection
1416 Free up the resource allocated for all strings required
1421 FreeBrowserStrings (
1426 Create a menu with specified formset GUID and form ID, and add it as a child
1427 of the given parent menu.
1429 @param HiiHandle Hii handle related to this formset.
1430 @param FormSetGuid The Formset Guid of menu to be added.
1431 @param FormId The Form ID of menu to be added.
1432 @param QuestionId The question id of this menu to be added.
1434 @return A pointer to the newly added menu or NULL if memory is insufficient.
1439 IN EFI_HII_HANDLE HiiHandle
,
1440 IN EFI_GUID
*FormSetGuid
,
1442 IN UINT16 QuestionId
1446 Search Menu with given FormSetGuid and FormId in all cached menu list.
1448 @param HiiHandle HiiHandle for FormSet.
1449 @param FormSetGuid The Formset GUID of the menu to search.
1450 @param FormId The Form ID of menu to search.
1452 @return A pointer to menu found or NULL if not found.
1457 IN EFI_HII_HANDLE HiiHandle
,
1458 IN EFI_GUID
*FormSetGuid
,
1463 Free Menu list linked list.
1465 @param MenuListHead One Menu list point in the menu list.
1470 LIST_ENTRY
*MenuListHead
1474 Find parent menu for current menu.
1476 @param CurrentMenu Current Menu
1478 @retval The parent menu for current menu.
1482 IN FORM_ENTRY_INFO
*CurrentMenu
1486 Search an Option of a Question by its value.
1488 @param Question The Question
1489 @param OptionValue Value for Option to be searched.
1491 @retval Pointer Pointer to the found Option.
1492 @retval NULL Option not found.
1497 IN FORM_BROWSER_STATEMENT
*Question
,
1498 IN EFI_HII_VALUE
*OptionValue
1501 Return data element in an Array by its Index.
1503 @param Array The data array.
1504 @param Type Type of the data in this array.
1505 @param Index Zero based index for data in this array.
1507 @retval Value The data to be returned
1518 Set value of a data element in an Array by its Index.
1520 @param Array The data array.
1521 @param Type Type of the data in this array.
1522 @param Index Zero based index for data in this array.
1523 @param Value The value to be set.
1535 Compare two Hii value.
1537 @param Value1 Expression value to compare on left-hand.
1538 @param Value2 Expression value to compare on right-hand.
1539 @param Result Return value after compare.
1540 retval 0 Two operators equal.
1541 return Positive value if Value1 is greater than Value2.
1542 retval Negative value if Value1 is less than Value2.
1543 @param HiiHandle Only required for string compare.
1545 @retval other Could not perform compare on two values.
1546 @retval EFI_SUCCESS Compare the value success.
1551 IN EFI_HII_VALUE
*Value1
,
1552 IN EFI_HII_VALUE
*Value2
,
1554 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1558 Perform Password check.
1559 Passwork may be encrypted by driver that requires the specific check.
1561 @param Form Form where Password Statement is in.
1562 @param Statement Password statement
1563 @param PasswordString Password string to be checked. It may be NULL.
1564 NULL means to restore password.
1565 "" string can be used to checked whether old password does exist.
1567 @return Status Status of Password check.
1572 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
1573 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
1574 IN EFI_STRING PasswordString OPTIONAL
1579 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1581 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1583 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1586 FORM_BROWSER_STATEMENT
*
1587 GetBrowserStatement (
1588 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1593 Initialize the Display form structure data.
1597 InitializeDisplayFormData (
1603 Base on the current formset info, clean the ConfigRequest string in browser storage.
1605 @param FormSet Pointer of the FormSet
1609 CleanBrowserStorage (
1610 IN OUT FORM_BROWSER_FORMSET
*FormSet