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
154 UINT8 ReferenceCount
; // How many form set storage refrence this storage.
157 #define BROWSER_STORAGE_FROM_LINK(a) CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)
159 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
167 BROWSER_STORAGE
*BrowserStorage
;
169 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
170 CHAR16
*ConfigElements
;// Elements need to load initial data.
171 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
172 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
175 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
178 EFI_STRING_ID VarName
;
182 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
190 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
191 UINT8 Flags
; // For EFI_IFR_SPAN
192 UINT8 RuleId
; // For EFI_IFR_RULE_REF
194 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
196 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
197 EFI_QUESTION_ID QuestionId2
;
199 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
202 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
205 BROWSER_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
206 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
207 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
208 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
209 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
210 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
213 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
215 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
221 UINT8 Type
; // Type for this expression
223 UINT8 RuleId
; // For EFI_IFR_RULE only
224 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
226 EFI_HII_VALUE Result
; // Expression evaluation result
228 UINT8 TimeOut
; // For EFI_IFR_WARNING_IF
230 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
233 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
235 #define FORM_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')
240 FORM_EXPRESSION
*Expression
[1]; // Array[Count] of expressions
241 } FORM_EXPRESSION_LIST
;
243 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
250 EFI_HII_VALUE Value
; // Default value
252 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
255 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
257 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
263 EFI_IFR_ONE_OF_OPTION
*OpCode
; // OneOfOption Data
268 EFI_IMAGE_ID ImageId
;
270 FORM_EXPRESSION_LIST
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
273 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
289 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
295 UINT8 Operand
; // The operand (first byte) of this Statement or Question
296 EFI_IFR_OP_HEADER
*OpCode
;
301 EFI_STRING_ID Prompt
;
303 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
306 // Fake Question Id, used for statement not has true QuestionId.
308 EFI_QUESTION_ID FakeQuestionId
;
313 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
314 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
315 BROWSER_STORAGE
*Storage
;
316 VAR_STORE_INFO VarStoreInfo
;
319 CHAR16
*VariableName
; // Name/Value or EFI Variable name
320 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
322 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
323 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
324 UINT8 ValueType
; // Data type for orderedlist value array
327 // OpCode specific members
329 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
330 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
331 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
333 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
334 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
336 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
337 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
340 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
341 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
342 BOOLEAN Locked
; // Whether this statement is locked.
343 BOOLEAN ValueChanged
; // Whether this statement's value is changed.
345 // Get from IFR parsing
347 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
348 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
349 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
351 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
352 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
353 BOOLEAN InSubtitle
; // nesting inside of EFI_IFR_SUBTITLE
355 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
356 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
357 LIST_ENTRY WarningListHead
; // nested warning expression list (FORM_EXPRESSION)
358 FORM_EXPRESSION_LIST
*Expression
; // nesting inside of GrayOutIf/DisableIf/SuppressIf
360 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
361 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
362 } FORM_BROWSER_STATEMENT
;
364 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
366 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
371 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
372 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
375 BROWSER_STORAGE
*Storage
;
376 } FORM_BROWSER_CONFIG_REQUEST
;
377 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
379 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
380 #define STANDARD_MAP_FORM_TYPE 0x01
386 UINT16 FormId
; // FormId of normal form or formmap form.
387 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
388 UINT16 FormType
; // Specific form type for the different form.
390 EFI_IMAGE_ID ImageId
;
392 BOOLEAN ModalForm
; // Whether this is a modal form.
393 BOOLEAN Locked
; // Whether this form is locked.
395 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
396 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
397 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
398 FORM_EXPRESSION_LIST
*SuppressExpression
; // nesting inside of SuppressIf
401 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
403 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
410 EFI_STRING_ID DefaultName
;
411 } FORMSET_DEFAULTSTORE
;
413 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
415 #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
420 EFI_HII_HANDLE HiiHandle
; // unique id for formset.
421 EFI_HANDLE DriverHandle
;
422 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
423 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
425 UINTN IfrBinaryLength
;
426 UINT8
*IfrBinaryData
;
428 BOOLEAN QuestionInited
; // Have finished question initilization?
430 EFI_STRING_ID FormSetTitle
;
432 UINT8 NumberOfClassGuid
;
433 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
434 UINT16 Class
; // Tiano extended Class code
435 UINT16 SubClass
; // Tiano extended Subclass code
436 EFI_IMAGE_ID ImageId
;
438 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
439 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
441 LIST_ENTRY StatementListOSF
; // Statement list out side of the form.
442 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
443 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
444 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
445 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
446 } FORM_BROWSER_FORMSET
;
447 #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
451 EFI_EVENT RefreshEvent
;
452 } FORM_BROWSER_REFRESH_EVENT_NODE
;
454 #define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a) BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)
458 EFI_HII_HANDLE Handle
;
461 // Target formset/form/Question information
463 EFI_GUID FormSetGuid
;
466 UINTN Sequence
; // used for time/date only.
475 // Ation for Browser to taken:
476 // UI_ACTION_NONE - navigation inside a form
477 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
478 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
483 // Current selected fomset/form/Question
485 FORM_BROWSER_FORMSET
*FormSet
;
486 FORM_BROWSER_FORM
*Form
;
487 FORM_BROWSER_STATEMENT
*Statement
;
490 // Whether the Form is editable
492 BOOLEAN FormEditable
;
494 FORM_ENTRY_INFO
*CurrentMenu
;
497 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
504 // Globals defined in Setup.c
506 BOOLEAN ResetRequired
;
507 BOOLEAN ExitRequired
;
508 EFI_HII_HANDLE HiiHandle
;
509 EFI_GUID FormSetGuid
;
511 UI_MENU_SELECTION
*Selection
;
513 LIST_ENTRY FormHistoryList
;
516 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
519 // Scope for get defaut value. It may be GetDefaultForNoStorage, GetDefaultForStorage or GetDefaultForAll.
522 GetDefaultForNoStorage
, // Get default value for question which not has storage.
523 GetDefaultForStorage
, // Get default value for question which has storage.
524 GetDefaultForAll
, // Get default value for all questions.
525 GetDefaultForMax
// Invalid value.
526 } BROWSER_GET_DEFAULT_VALUE
;
529 // Get/set question value from/to.
532 GetSetValueWithEditBuffer
, // Get/Set question value from/to editbuffer in the storage.
533 GetSetValueWithBuffer
, // Get/Set question value from/to buffer in the storage.
534 GetSetValueWithHiiDriver
, // Get/Set question value from/to hii driver.
535 GetSetValueWithMax
// Invalid value.
536 } GET_SET_QUESTION_VALUE_WITH
;
538 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
539 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
540 extern EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*mPathFromText
;
541 extern EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
*mFormDisplay
;
543 extern BOOLEAN gResetRequired
;
544 extern BOOLEAN gExitRequired
;
546 extern LIST_ENTRY gBrowserFormSetList
;
547 extern LIST_ENTRY gBrowserHotKeyList
;
548 extern BROWSER_SETTING_SCOPE gBrowserSettingScope
;
549 extern EXIT_HANDLER ExitHandlerFunction
;
550 extern EFI_HII_HANDLE mCurrentHiiHandle
;
551 extern SETUP_DRIVER_PRIVATE_DATA mPrivateData
;
553 // Browser Global Strings
555 extern CHAR16
*gEmptyString
;
557 extern EFI_GUID gZeroGuid
;
559 extern UI_MENU_SELECTION
*gCurrentSelection
;
562 // Global Procedure Defines
564 #include "Expression.h"
567 Initialize the HII String Token to the correct values.
571 InitializeBrowserStrings (
576 Parse opcodes in the formset IFR binary.
578 @param FormSet Pointer of the FormSet data structure.
580 @retval EFI_SUCCESS Opcode parse success.
581 @retval Other Opcode parse fail.
586 IN FORM_BROWSER_FORMSET
*FormSet
590 Free resources allocated for a FormSet.
592 @param FormSet Pointer of the FormSet
597 IN OUT FORM_BROWSER_FORMSET
*FormSet
602 Create a new string in HII Package List.
604 @param String The String to be added
605 @param HiiHandle The package list in the HII database to insert the
608 @return The output string.
614 IN EFI_HII_HANDLE HiiHandle
618 Delete a string from HII Package List.
620 @param StringId Id of the string in HII database.
621 @param HiiHandle The HII package list handle.
623 @retval EFI_SUCCESS The string was deleted successfully.
628 IN EFI_STRING_ID StringId
,
629 IN EFI_HII_HANDLE HiiHandle
633 Get the string based on the StringId and HII Package List Handle.
635 @param Token The String's ID.
636 @param HiiHandle The package list in the HII database to search for
637 the specified string.
639 @return The output string.
644 IN EFI_STRING_ID Token
,
645 IN EFI_HII_HANDLE HiiHandle
649 Get Value for given Name from a NameValue Storage.
651 @param Storage The NameValue Storage.
652 @param Name The Name.
653 @param Value The retured Value.
654 @param GetValueFrom Where to get source value, from EditValue or Value.
656 @retval EFI_SUCCESS Value found for given Name.
657 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
662 IN BROWSER_STORAGE
*Storage
,
664 IN OUT CHAR16
**Value
,
665 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
669 Set Value of given Name in a NameValue Storage.
671 @param Storage The NameValue Storage.
672 @param Name The Name.
673 @param Value The Value to set.
674 @param SetValueTo Whether update editValue or Value.
675 @param ReturnNode The node use the input name.
677 @retval EFI_SUCCESS Value found for given Name.
678 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
683 IN BROWSER_STORAGE
*Storage
,
686 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
,
687 OUT NAME_VALUE_NODE
**ReturnNode
691 Validate whether this question's value has changed.
693 @param FormSet FormSet data structure.
694 @param Form Form data structure.
695 @param Question Question to be initialized.
696 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
698 @retval TRUE Question's value has changed.
699 @retval FALSE Question's value has not changed
703 IsQuestionValueChanged (
704 IN FORM_BROWSER_FORMSET
*FormSet
,
705 IN FORM_BROWSER_FORM
*Form
,
706 IN OUT FORM_BROWSER_STATEMENT
*Question
,
707 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
711 Get Question's current Value.
713 @param FormSet FormSet data structure.
714 @param Form Form data structure.
715 @param Question Question to be initialized.
716 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
718 @retval EFI_SUCCESS The function completed successfully.
723 IN FORM_BROWSER_FORMSET
*FormSet
,
724 IN FORM_BROWSER_FORM
*Form
,
725 IN OUT FORM_BROWSER_STATEMENT
*Question
,
726 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
730 Save Question Value to edit copy(cached) or Storage(uncached).
732 @param FormSet FormSet data structure.
733 @param Form Form data structure.
734 @param Question Pointer to the Question.
735 @param SetValueTo Update the question value to editbuffer , buffer or hii driver.
737 @retval EFI_SUCCESS The function completed successfully.
742 IN FORM_BROWSER_FORMSET
*FormSet
,
743 IN FORM_BROWSER_FORM
*Form
,
744 IN OUT FORM_BROWSER_STATEMENT
*Question
,
745 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
749 Perform inconsistent check for a Form.
751 @param FormSet FormSet data structure.
752 @param Form Form data structure.
753 @param Question The Question to be validated.
754 @param Type Validation type: InConsistent or NoSubmit
756 @retval EFI_SUCCESS Form validation pass.
757 @retval other Form validation failed.
762 IN FORM_BROWSER_FORMSET
*FormSet
,
763 IN FORM_BROWSER_FORM
*Form
,
764 IN FORM_BROWSER_STATEMENT
*Question
,
770 Discard data based on the input setting scope (Form, FormSet or System).
772 @param FormSet FormSet data structure.
773 @param Form Form data structure.
774 @param SettingScope Setting Scope for Discard action.
776 @retval EFI_SUCCESS The function completed successfully.
777 @retval EFI_UNSUPPORTED Unsupport SettingScope.
782 IN FORM_BROWSER_FORMSET
*FormSet
,
783 IN FORM_BROWSER_FORM
*Form
,
784 IN BROWSER_SETTING_SCOPE SettingScope
788 Submit data based on the input Setting level (Form, FormSet or System).
790 @param FormSet FormSet data structure.
791 @param Form Form data structure.
792 @param SettingScope Setting Scope for Submit action.
794 @retval EFI_SUCCESS The function completed successfully.
795 @retval EFI_UNSUPPORTED Unsupport SettingScope.
800 IN FORM_BROWSER_FORMSET
*FormSet
,
801 IN FORM_BROWSER_FORM
*Form
,
802 IN BROWSER_SETTING_SCOPE SettingScope
806 Reset Question to its default value.
808 @param FormSet The form set.
809 @param Form The form.
810 @param Question The question.
811 @param DefaultId The Class of the default.
813 @retval EFI_SUCCESS Question is reset to default value.
818 IN FORM_BROWSER_FORMSET
*FormSet
,
819 IN FORM_BROWSER_FORM
*Form
,
820 IN FORM_BROWSER_STATEMENT
*Question
,
825 Get current setting of Questions.
827 @param FormSet FormSet data structure.
831 InitializeCurrentSetting (
832 IN OUT FORM_BROWSER_FORMSET
*FormSet
836 Initialize the internal data structure of a FormSet.
838 @param Handle PackageList Handle
839 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
840 GUID), take the first FormSet found in package
842 @param FormSet FormSet data structure.
844 @retval EFI_SUCCESS The function completed successfully.
845 @retval EFI_NOT_FOUND The specified FormSet could not be found.
850 IN EFI_HII_HANDLE Handle
,
851 IN OUT EFI_GUID
*FormSetGuid
,
852 OUT FORM_BROWSER_FORMSET
*FormSet
856 Reset Questions to their initial value or default value in a Form, Formset or System.
858 GetDefaultValueScope parameter decides which questions will reset
859 to its default value.
861 @param FormSet FormSet data structure.
862 @param Form Form data structure.
863 @param DefaultId The Class of the default.
864 @param SettingScope Setting Scope for Default action.
865 @param GetDefaultValueScope Get default value scope.
866 @param Storage Get default value only for this storage.
867 @param RetrieveValueFirst Whether call the retrieve call back to
868 get the initial value before get default
871 @retval EFI_SUCCESS The function completed successfully.
872 @retval EFI_UNSUPPORTED Unsupport SettingScope.
877 IN FORM_BROWSER_FORMSET
*FormSet
,
878 IN FORM_BROWSER_FORM
*Form
,
880 IN BROWSER_SETTING_SCOPE SettingScope
,
881 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope
,
882 IN BROWSER_STORAGE
*Storage
,
883 IN BOOLEAN RetrieveValueFirst
887 Initialize Question's Edit copy from Storage.
889 @param Selection Selection contains the information about
890 the Selection, form and formset to be displayed.
891 Selection action may be updated in retrieve callback.
892 If Selection is NULL, only initialize Question value.
893 @param FormSet FormSet data structure.
894 @param Form Form data structure.
896 @retval EFI_SUCCESS The function completed successfully.
901 IN OUT UI_MENU_SELECTION
*Selection
,
902 IN FORM_BROWSER_FORMSET
*FormSet
,
903 IN FORM_BROWSER_FORM
*Form
907 Initialize Question's Edit copy from Storage for the whole Formset.
909 @param Selection Selection contains the information about
910 the Selection, form and formset to be displayed.
911 Selection action may be updated in retrieve callback.
912 If Selection is NULL, only initialize Question value.
913 @param FormSet FormSet data structure.
915 @retval EFI_SUCCESS The function completed successfully.
920 IN OUT UI_MENU_SELECTION
*Selection
,
921 IN FORM_BROWSER_FORMSET
*FormSet
925 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
927 @param Storage The Storage to be conveted.
928 @param ConfigResp The returned <ConfigResp>.
929 @param ConfigRequest The ConfigRequest string.
930 @param GetEditBuf Get the data from editbuffer or buffer.
932 @retval EFI_SUCCESS Convert success.
933 @retval EFI_INVALID_PARAMETER Incorrect storage type.
937 StorageToConfigResp (
938 IN BROWSER_STORAGE
*Storage
,
939 IN CHAR16
**ConfigResp
,
940 IN CHAR16
*ConfigRequest
,
941 IN BOOLEAN GetEditBuf
945 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
947 @param Storage The Storage to receive the settings.
948 @param ConfigResp The <ConfigResp> to be converted.
950 @retval EFI_SUCCESS Convert success.
951 @retval EFI_INVALID_PARAMETER Incorrect storage type.
955 ConfigRespToStorage (
956 IN BROWSER_STORAGE
*Storage
,
957 IN CHAR16
*ConfigResp
961 Fill storage's edit copy with settings requested from Configuration Driver.
963 @param FormSet FormSet data structure.
964 @param Storage Buffer Storage.
969 IN FORM_BROWSER_FORMSET
*FormSet
,
970 IN FORMSET_STORAGE
*Storage
974 Fetch the Ifr binary data of a FormSet.
976 @param Handle PackageList Handle
977 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
978 GUID), take the first FormSet found in package
980 @param BinaryLength The length of the FormSet IFR binary.
981 @param BinaryData The buffer designed to receive the FormSet.
983 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
984 BufferLength was updated.
985 @retval EFI_INVALID_PARAMETER The handle is unknown.
986 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
987 be found with the requested FormId.
992 IN EFI_HII_HANDLE Handle
,
993 IN OUT EFI_GUID
*FormSetGuid
,
994 OUT UINTN
*BinaryLength
,
995 OUT UINT8
**BinaryData
999 Save globals used by previous call to SendForm(). SendForm() may be called from
1000 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1001 So, save globals of previous call to SendForm() and restore them upon exit.
1005 SaveBrowserContext (
1010 Restore globals used by previous call to SendForm().
1014 RestoreBrowserContext (
1019 This is the routine which an external caller uses to direct the browser
1020 where to obtain it's information.
1023 @param This The Form Browser protocol instanse.
1024 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1025 display a list of the formsets for the handles specified.
1026 @param HandleCount The number of Handles specified in Handle.
1027 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1028 field in the EFI_IFR_FORM_SET op-code for the specified
1029 forms-based package. If FormSetGuid is NULL, then this
1030 function will display the first found forms package.
1031 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1032 displayable page. If this field has a value of 0x0000, then
1033 the forms browser will render the specified forms in their encoded order.
1034 ScreenDimenions - This allows the browser to be called so that it occupies a
1035 portion of the physical screen instead of dynamically determining the screen dimensions.
1036 ActionRequest - Points to the action recommended by the form.
1037 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1039 @param ActionRequest Points to the action recommended by the form.
1041 @retval EFI_SUCCESS The function completed successfully.
1042 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1043 @retval EFI_NOT_FOUND No valid forms could be found to display.
1049 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1050 IN EFI_HII_HANDLE
*Handles
,
1051 IN UINTN HandleCount
,
1052 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1053 IN UINT16 FormId
, OPTIONAL
1054 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1055 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1059 This function is called by a callback handler to retrieve uncommitted state
1060 data from the browser.
1062 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1064 @param ResultsDataSize A pointer to the size of the buffer associated
1066 @param ResultsData A string returned from an IFR browser or
1067 equivalent. The results string will have no
1068 routing information in them.
1069 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1070 (if RetrieveData = TRUE) data from the uncommitted
1071 browser state information or set (if RetrieveData
1072 = FALSE) data in the uncommitted browser state
1074 @param VariableGuid An optional field to indicate the target variable
1076 @param VariableName An optional field to indicate the target
1077 human-readable variable name.
1079 @retval EFI_SUCCESS The results have been distributed or are awaiting
1081 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1082 contain the results data.
1088 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1089 IN OUT UINTN
*ResultsDataSize
,
1090 IN OUT EFI_STRING ResultsData
,
1091 IN BOOLEAN RetrieveData
,
1092 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1093 IN CONST CHAR16
*VariableName OPTIONAL
1097 Find menu which will show next time.
1099 @param Selection On input, Selection tell setup browser the information
1100 about the Selection, form and formset to be displayed.
1101 On output, Selection return the screen item that is selected
1103 @param SettingLevel Input Settting level, if it is FormLevel, just exit current form.
1104 else, we need to exit current formset.
1106 @retval TRUE Exit current form.
1107 @retval FALSE User press ESC and keep in current form.
1111 IN OUT UI_MENU_SELECTION
*Selection
,
1112 IN BROWSER_SETTING_SCOPE SettingLevel
1116 check whether the form need to update the NV.
1118 @param Form Form data structure.
1120 @retval TRUE Need to update the NV.
1121 @retval FALSE No need to update the NV.
1124 IsNvUpdateRequiredForForm (
1125 IN FORM_BROWSER_FORM
*Form
1129 check whether the formset need to update the NV.
1131 @param FormSet FormSet data structure.
1133 @retval TRUE Need to update the NV.
1134 @retval FALSE No need to update the NV.
1137 IsNvUpdateRequiredForFormSet (
1138 IN FORM_BROWSER_FORMSET
*FormSet
1142 Check whether the storage data for current form set is changed.
1144 @param FormSet FormSet data structure.
1146 @retval TRUE Data is changed.
1147 @retval FALSE Data is not changed.
1150 IsStorageDataChangedForFormSet (
1151 IN FORM_BROWSER_FORMSET
*FormSet
1155 Call the call back function for the question and process the return action.
1157 @param Selection On input, Selection tell setup browser the information
1158 about the Selection, form and formset to be displayed.
1159 On output, Selection return the screen item that is selected
1161 @param Statement The Question which need to call.
1162 @param Action The action request.
1163 @param SkipSaveOrDiscard Whether skip save or discard action.
1165 @retval EFI_SUCCESS The call back function excutes successfully.
1166 @return Other value if the call back function failed to excute.
1169 ProcessCallBackFunction (
1170 IN OUT UI_MENU_SELECTION
*Selection
,
1171 IN FORM_BROWSER_STATEMENT
*Question
,
1172 IN EFI_BROWSER_ACTION Action
,
1173 IN BOOLEAN SkipSaveOrDiscard
1177 Call the retrieve type call back function for one question to get the initialize data.
1179 This function only used when in the initialize stage, because in this stage, the
1180 Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.
1182 @param ConfigAccess The config access protocol produced by the hii driver.
1183 @param Statement The Question which need to call.
1185 @retval EFI_SUCCESS The call back function excutes successfully.
1186 @return Other value if the call back function failed to excute.
1189 ProcessRetrieveForQuestion (
1190 IN EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
,
1191 IN FORM_BROWSER_STATEMENT
*Statement
1195 Find the matched FormSet context in the backup maintain list based on HiiHandle.
1197 @param Handle The Hii Handle.
1199 @return the found FormSet context. If no found, NULL will return.
1202 FORM_BROWSER_FORMSET
*
1203 GetFormSetFromHiiHandle (
1204 EFI_HII_HANDLE Handle
1208 Check whether the input HII handle is the FormSet that is being used.
1210 @param Handle The Hii Handle.
1212 @retval TRUE HII handle is being used.
1213 @retval FALSE HII handle is not being used.
1217 IsHiiHandleInBrowserContext (
1218 EFI_HII_HANDLE Handle
1222 Configure what scope the hot key will impact.
1223 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1224 If no scope is set, the default scope will be FormSet level.
1225 After all registered hot keys are removed, previous Scope can reset to another level.
1227 @param[in] Scope Scope level to be set.
1229 @retval EFI_SUCCESS Scope is set correctly.
1230 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1231 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1237 IN BROWSER_SETTING_SCOPE Scope
1241 Register the hot key with its browser action, or unregistered the hot key.
1242 Only support hot key that is not printable character (control key, function key, etc.).
1243 If the action value is zero, the hot key will be unregistered if it has been registered.
1244 If the same hot key has been registered, the new action and help string will override the previous ones.
1246 @param[in] KeyData A pointer to a buffer that describes the keystroke
1247 information for the hot key. Its type is EFI_INPUT_KEY to
1248 be supported by all ConsoleIn devices.
1249 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1250 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1251 @param[in] HelpString Help string that describes the hot key information.
1252 Its value may be NULL for the unregistered hot key.
1254 @retval EFI_SUCCESS Hot key is registered or unregistered.
1255 @retval EFI_INVALID_PARAMETER KeyData is NULL.
1256 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1257 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1262 IN EFI_INPUT_KEY
*KeyData
,
1264 IN UINT16 DefaultId
,
1265 IN EFI_STRING HelpString OPTIONAL
1269 Register Exit handler function.
1270 When more than one handler function is registered, the latter one will override the previous one.
1271 When NULL handler is specified, the previous Exit handler will be unregistered.
1273 @param[in] Handler Pointer to handler function.
1278 RegiserExitHandler (
1279 IN EXIT_HANDLER Handler
1284 Check whether the browser data has been modified.
1286 @retval TRUE Browser data is changed.
1287 @retval FALSE No browser data is changed.
1292 IsBrowserDataModified (
1298 Execute the action requested by the Action parameter.
1300 @param[in] Action Execute the request action.
1301 @param[in] DefaultId The default Id info when need to load default value.
1303 @retval EFI_SUCCESS Execute the request action succss.
1304 @retval EFI_INVALID_PARAMETER The input action value is invalid.
1315 Create reminder to let user to choose save or discard the changed browser data.
1316 Caller can use it to actively check the changed browser data.
1318 @retval BROWSER_NO_CHANGES No browser data is changed.
1319 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1320 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1330 Find the registered HotKey based on KeyData.
1332 @param[in] KeyData A pointer to a buffer that describes the keystroke
1333 information for the hot key.
1335 @return The registered HotKey context. If no found, NULL will return.
1338 GetHotKeyFromRegisterList (
1339 IN EFI_INPUT_KEY
*KeyData
1344 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1346 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1348 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1351 FORM_BROWSER_STATEMENT
*
1352 GetBrowserStatement (
1353 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1357 Password may be stored as encrypted by Configuration Driver. When change a
1358 password, user will be challenged with old password. To validate user input old
1359 password, we will send the clear text to Configuration Driver via Callback().
1360 Configuration driver is responsible to check the passed in password and return
1361 the validation result. If validation pass, state machine in password Callback()
1362 will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD.
1363 After user type in new password twice, Callback() will be invoked to send the
1364 new password to Configuration Driver.
1366 @param Selection Pointer to UI_MENU_SELECTION.
1367 @param MenuOption The MenuOption for this password Question.
1368 @param String The clear text of password.
1370 @retval EFI_NOT_AVAILABLE_YET Callback() request to terminate password input.
1371 @return In state of BROWSER_STATE_VALIDATE_PASSWORD:
1372 @retval EFI_SUCCESS Password correct, Browser will prompt for new
1374 @retval EFI_NOT_READY Password incorrect, Browser will show error
1376 @retval Other Browser will do nothing.
1377 @return In state of BROWSER_STATE_SET_PASSWORD:
1378 @retval EFI_SUCCESS Set password success.
1379 @retval Other Set password failed.
1384 IN UI_MENU_SELECTION
*Selection
,
1385 IN FORM_BROWSER_STATEMENT
*Question
,
1390 Display error message for invalid password.
1399 The worker function that send the displays to the screen. On output,
1400 the selection made by user is returned.
1402 @param Selection On input, Selection tell setup browser the information
1403 about the Selection, form and formset to be displayed.
1404 On output, Selection return the screen item that is selected
1407 @retval EFI_SUCCESS The page is displayed successfully.
1408 @return Other value if the page failed to be diplayed.
1413 IN OUT UI_MENU_SELECTION
*Selection
1417 Free up the resource allocated for all strings required
1422 FreeBrowserStrings (
1427 Create a menu with specified formset GUID and form ID, and add it as a child
1428 of the given parent menu.
1430 @param HiiHandle Hii handle related to this formset.
1431 @param FormSetGuid The Formset Guid of menu to be added.
1432 @param FormId The Form ID of menu to be added.
1433 @param QuestionId The question id of this menu to be added.
1435 @return A pointer to the newly added menu or NULL if memory is insufficient.
1440 IN EFI_HII_HANDLE HiiHandle
,
1441 IN EFI_GUID
*FormSetGuid
,
1443 IN UINT16 QuestionId
1447 Search Menu with given FormSetGuid and FormId in all cached menu list.
1449 @param HiiHandle HiiHandle for FormSet.
1450 @param FormSetGuid The Formset GUID of the menu to search.
1451 @param FormId The Form ID of menu to search.
1453 @return A pointer to menu found or NULL if not found.
1458 IN EFI_HII_HANDLE HiiHandle
,
1459 IN EFI_GUID
*FormSetGuid
,
1464 Free Menu list linked list.
1466 @param MenuListHead One Menu list point in the menu list.
1471 LIST_ENTRY
*MenuListHead
1475 Find parent menu for current menu.
1477 @param CurrentMenu Current Menu
1479 @retval The parent menu for current menu.
1483 IN FORM_ENTRY_INFO
*CurrentMenu
1487 Search an Option of a Question by its value.
1489 @param Question The Question
1490 @param OptionValue Value for Option to be searched.
1492 @retval Pointer Pointer to the found Option.
1493 @retval NULL Option not found.
1498 IN FORM_BROWSER_STATEMENT
*Question
,
1499 IN EFI_HII_VALUE
*OptionValue
1502 Return data element in an Array by its Index.
1504 @param Array The data array.
1505 @param Type Type of the data in this array.
1506 @param Index Zero based index for data in this array.
1508 @retval Value The data to be returned
1519 Set value of a data element in an Array by its Index.
1521 @param Array The data array.
1522 @param Type Type of the data in this array.
1523 @param Index Zero based index for data in this array.
1524 @param Value The value to be set.
1536 Compare two Hii value.
1538 @param Value1 Expression value to compare on left-hand.
1539 @param Value2 Expression value to compare on right-hand.
1540 @param Result Return value after compare.
1541 retval 0 Two operators equal.
1542 return Positive value if Value1 is greater than Value2.
1543 retval Negative value if Value1 is less than Value2.
1544 @param HiiHandle Only required for string compare.
1546 @retval other Could not perform compare on two values.
1547 @retval EFI_SUCCESS Compare the value success.
1552 IN EFI_HII_VALUE
*Value1
,
1553 IN EFI_HII_VALUE
*Value2
,
1555 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1559 Perform Password check.
1560 Passwork may be encrypted by driver that requires the specific check.
1562 @param Form Form where Password Statement is in.
1563 @param Statement Password statement
1564 @param PasswordString Password string to be checked. It may be NULL.
1565 NULL means to restore password.
1566 "" string can be used to checked whether old password does exist.
1568 @return Status Status of Password check.
1573 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
1574 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
1575 IN EFI_STRING PasswordString OPTIONAL
1580 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1582 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1584 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1587 FORM_BROWSER_STATEMENT
*
1588 GetBrowserStatement (
1589 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1594 Initialize the Display form structure data.
1598 InitializeDisplayFormData (
1604 Base on the current formset info, clean the ConfigRequest string in browser storage.
1606 @param FormSet Pointer of the FormSet
1610 CleanBrowserStorage (
1611 IN OUT FORM_BROWSER_FORMSET
*FormSet