2 Private MACRO, structure and function definitions for Setup Browser module.
4 Copyright (c) 2007 - 2014, 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
139 BOOLEAN Initialized
; // Whether this varstore is initialized, efi varstore not used.
141 EFI_HII_HANDLE HiiHandle
; // HiiHandle for this varstore, efi varstore not used.
144 CHAR16
*Name
; // For EFI_IFR_VARSTORE
147 UINT8
*EditBuffer
; // Edit copy for Buffer Storage
149 LIST_ENTRY NameValueListHead
; // List of NAME_VALUE_NODE
151 UINT32 Attributes
; // For EFI_IFR_VARSTORE_EFI: EFI Variable attribute
153 CHAR16
*ConfigHdr
; // <ConfigHdr>
154 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
155 // <RequestElement> includes all fields which is used by current form sets.
156 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
159 #define BROWSER_STORAGE_FROM_LINK(a) CR (a, BROWSER_STORAGE, Link, BROWSER_STORAGE_SIGNATURE)
161 #define FORMSET_STORAGE_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'G')
167 LIST_ENTRY SaveFailLink
;
171 BROWSER_STORAGE
*BrowserStorage
;
173 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
174 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
175 UINTN SpareStrLen
; // Spare length of ConfigRequest string buffer
178 #define FORMSET_STORAGE_FROM_LINK(a) CR (a, FORMSET_STORAGE, Link, FORMSET_STORAGE_SIGNATURE)
179 #define FORMSET_STORAGE_FROM_SAVE_FAIL_LINK(a) CR (a, FORMSET_STORAGE, SaveFailLink, FORMSET_STORAGE_SIGNATURE)
182 EFI_STRING_ID VarName
;
186 #define EXPRESSION_OPCODE_SIGNATURE SIGNATURE_32 ('E', 'X', 'O', 'P')
194 UINT8 Format
; // For EFI_IFR_TO_STRING, EFI_IFR_FIND
195 UINT8 Flags
; // For EFI_IFR_SPAN
196 UINT8 RuleId
; // For EFI_IFR_RULE_REF
198 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
200 EFI_QUESTION_ID QuestionId
; // For EFI_IFR_EQ_ID_ID, EFI_IFR_EQ_ID_VAL_LIST, EFI_IFR_QUESTION_REF1
201 EFI_QUESTION_ID QuestionId2
;
203 UINT16 ListLength
; // For EFI_IFR_EQ_ID_VAL_LIST
206 EFI_STRING_ID DevicePath
; // For EFI_IFR_QUESTION_REF3_2, EFI_IFR_QUESTION_REF3_3
209 BROWSER_STORAGE
*VarStorage
; // For EFI_IFR_SET, EFI_IFR_GET
210 VAR_STORE_INFO VarStoreInfo
;// For EFI_IFR_SET, EFI_IFR_GET
211 UINT8 ValueType
; // For EFI_IFR_SET, EFI_IFR_GET
212 UINT8 ValueWidth
; // For EFI_IFR_SET, EFI_IFR_GET
213 CHAR16
*ValueName
; // For EFI_IFR_SET, EFI_IFR_GET
214 LIST_ENTRY MapExpressionList
; // nested expressions inside of Map opcode.
217 #define EXPRESSION_OPCODE_FROM_LINK(a) CR (a, EXPRESSION_OPCODE, Link, EXPRESSION_OPCODE_SIGNATURE)
219 #define FORM_EXPRESSION_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'P')
225 UINT8 Type
; // Type for this expression
227 UINT8 RuleId
; // For EFI_IFR_RULE only
228 EFI_STRING_ID Error
; // For EFI_IFR_NO_SUBMIT_IF, EFI_IFR_INCONSISTENT_IF only
230 EFI_HII_VALUE Result
; // Expression evaluation result
232 UINT8 TimeOut
; // For EFI_IFR_WARNING_IF
233 EFI_IFR_OP_HEADER
*OpCode
; // Save the opcode buffer.
235 LIST_ENTRY OpCodeListHead
; // OpCodes consist of this expression (EXPRESSION_OPCODE)
238 #define FORM_EXPRESSION_FROM_LINK(a) CR (a, FORM_EXPRESSION, Link, FORM_EXPRESSION_SIGNATURE)
240 #define FORM_EXPRESSION_LIST_SIGNATURE SIGNATURE_32 ('F', 'E', 'X', 'R')
245 FORM_EXPRESSION
*Expression
[1]; // Array[Count] of expressions
246 } FORM_EXPRESSION_LIST
;
248 #define QUESTION_DEFAULT_SIGNATURE SIGNATURE_32 ('Q', 'D', 'F', 'T')
255 EFI_HII_VALUE Value
; // Default value
257 FORM_EXPRESSION
*ValueExpression
; // Not-NULL indicates default value is provided by EFI_IFR_VALUE
260 #define QUESTION_DEFAULT_FROM_LINK(a) CR (a, QUESTION_DEFAULT, Link, QUESTION_DEFAULT_SIGNATURE)
262 #define QUESTION_OPTION_SIGNATURE SIGNATURE_32 ('Q', 'O', 'P', 'T')
268 EFI_IFR_ONE_OF_OPTION
*OpCode
; // OneOfOption Data
273 EFI_IMAGE_ID ImageId
;
275 FORM_EXPRESSION_LIST
*SuppressExpression
; // Non-NULL indicates nested inside of SuppressIf
278 #define QUESTION_OPTION_FROM_LINK(a) CR (a, QUESTION_OPTION, Link, QUESTION_OPTION_SIGNATURE)
294 typedef struct _FORM_BROWSER_STATEMENT FORM_BROWSER_STATEMENT
;
296 #define FORM_BROWSER_STATEMENT_SIGNATURE SIGNATURE_32 ('F', 'S', 'T', 'A')
298 struct _FORM_BROWSER_STATEMENT
{
302 UINT8 Operand
; // The operand (first byte) of this Statement or Question
303 EFI_IFR_OP_HEADER
*OpCode
;
308 EFI_STRING_ID Prompt
;
310 EFI_STRING_ID TextTwo
; // For EFI_IFR_TEXT
313 // Fake Question Id, used for statement not has true QuestionId.
315 EFI_QUESTION_ID FakeQuestionId
;
320 EFI_QUESTION_ID QuestionId
; // The value of zero is reserved
321 EFI_VARSTORE_ID VarStoreId
; // A value of zero indicates no variable storage
322 BROWSER_STORAGE
*Storage
;
323 VAR_STORE_INFO VarStoreInfo
;
326 CHAR16
*VariableName
; // Name/Value or EFI Variable name
327 CHAR16
*BlockName
; // Buffer storage block name: "OFFSET=...WIDTH=..."
329 EFI_HII_VALUE HiiValue
; // Edit copy for checkbox, numberic, oneof
330 UINT8
*BufferValue
; // Edit copy for string, password, orderedlist
331 UINT8 ValueType
; // Data type for orderedlist value array
334 // OpCode specific members
336 UINT8 Flags
; // for EFI_IFR_CHECKBOX, EFI_IFR_DATE, EFI_IFR_NUMERIC, EFI_IFR_ONE_OF,
337 // EFI_IFR_ORDERED_LIST, EFI_IFR_STRING,EFI_IFR_SUBTITLE,EFI_IFR_TIME, EFI_IFR_BANNER
338 UINT8 MaxContainers
; // for EFI_IFR_ORDERED_LIST
340 UINT16 BannerLineNumber
; // for EFI_IFR_BANNER, 1-based line number
341 EFI_STRING_ID QuestionConfig
; // for EFI_IFR_ACTION, if 0 then no configuration string will be processed
343 UINT64 Minimum
; // for EFI_IFR_ONE_OF/EFI_IFR_NUMERIC, it's Min/Max value
344 UINT64 Maximum
; // for EFI_IFR_STRING/EFI_IFR_PASSWORD, it's Min/Max length
347 EFI_DEFAULT_ID DefaultId
; // for EFI_IFR_RESET_BUTTON
348 EFI_GUID RefreshGuid
; // for EFI_IFR_REFRESH_ID
349 BOOLEAN Locked
; // Whether this statement is locked.
350 BOOLEAN ValueChanged
; // Whether this statement's value is changed.
352 // Get from IFR parsing
354 FORM_EXPRESSION
*ValueExpression
; // nested EFI_IFR_VALUE, provide Question value and indicate Question is ReadOnly
355 LIST_ENTRY DefaultListHead
; // nested EFI_IFR_DEFAULT list (QUESTION_DEFAULT), provide default values
356 LIST_ENTRY OptionListHead
; // nested EFI_IFR_ONE_OF_OPTION list (QUESTION_OPTION)
358 EFI_IMAGE_ID ImageId
; // nested EFI_IFR_IMAGE
359 UINT8 RefreshInterval
; // nested EFI_IFR_REFRESH, refresh interval(in seconds) for Question value, 0 means no refresh
361 FORM_BROWSER_STATEMENT
*ParentStatement
;
363 LIST_ENTRY InconsistentListHead
;// nested inconsistent expression list (FORM_EXPRESSION)
364 LIST_ENTRY NoSubmitListHead
; // nested nosubmit expression list (FORM_EXPRESSION)
365 LIST_ENTRY WarningListHead
; // nested warning expression list (FORM_EXPRESSION)
366 FORM_EXPRESSION_LIST
*Expression
; // nesting inside of GrayOutIf/DisableIf/SuppressIf
368 FORM_EXPRESSION
*ReadExpression
; // nested EFI_IFR_READ, provide this question value by read expression.
369 FORM_EXPRESSION
*WriteExpression
; // nested EFI_IFR_WRITE, evaluate write expression after this question value is set.
372 #define FORM_BROWSER_STATEMENT_FROM_LINK(a) CR (a, FORM_BROWSER_STATEMENT, Link, FORM_BROWSER_STATEMENT_SIGNATURE)
374 #define FORM_BROWSER_CONFIG_REQUEST_SIGNATURE SIGNATURE_32 ('F', 'C', 'R', 'S')
379 LIST_ENTRY SaveFailLink
;
381 CHAR16
*ConfigRequest
; // <ConfigRequest> = <ConfigHdr> + <RequestElement>
382 UINTN ElementCount
; // Number of <RequestElement> in the <ConfigRequest>
385 BROWSER_STORAGE
*Storage
;
386 } FORM_BROWSER_CONFIG_REQUEST
;
387 #define FORM_BROWSER_CONFIG_REQUEST_FROM_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, Link, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
388 #define FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK(a) CR (a, FORM_BROWSER_CONFIG_REQUEST, SaveFailLink, FORM_BROWSER_CONFIG_REQUEST_SIGNATURE)
390 #define FORM_BROWSER_FORM_SIGNATURE SIGNATURE_32 ('F', 'F', 'R', 'M')
391 #define STANDARD_MAP_FORM_TYPE 0x01
397 UINT16 FormId
; // FormId of normal form or formmap form.
398 EFI_STRING_ID FormTitle
; // FormTile of normal form, or FormMapMethod title of formmap form.
399 UINT16 FormType
; // Specific form type for the different form.
401 EFI_IMAGE_ID ImageId
;
403 BOOLEAN ModalForm
; // Whether this is a modal form.
404 BOOLEAN Locked
; // Whether this form is locked.
406 LIST_ENTRY FormViewListHead
; // List of type FORMID_INFO is Browser View Form History List.
407 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
408 LIST_ENTRY StatementListHead
; // List of Statements and Questions (FORM_BROWSER_STATEMENT)
409 LIST_ENTRY ConfigRequestHead
; // List of configreques for all storage.
410 FORM_EXPRESSION_LIST
*SuppressExpression
; // nesting inside of SuppressIf
413 #define FORM_BROWSER_FORM_FROM_LINK(a) CR (a, FORM_BROWSER_FORM, Link, FORM_BROWSER_FORM_SIGNATURE)
415 #define FORMSET_DEFAULTSTORE_SIGNATURE SIGNATURE_32 ('F', 'D', 'F', 'S')
422 EFI_STRING_ID DefaultName
;
423 } FORMSET_DEFAULTSTORE
;
425 #define FORMSET_DEFAULTSTORE_FROM_LINK(a) CR (a, FORMSET_DEFAULTSTORE, Link, FORMSET_DEFAULTSTORE_SIGNATURE)
427 #define FORM_BROWSER_FORMSET_SIGNATURE SIGNATURE_32 ('F', 'B', 'F', 'S')
432 LIST_ENTRY SaveFailLink
;
434 EFI_HII_HANDLE HiiHandle
; // unique id for formset.
435 EFI_HANDLE DriverHandle
;
436 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
437 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
439 UINTN IfrBinaryLength
;
440 UINT8
*IfrBinaryData
;
442 BOOLEAN QuestionInited
; // Have finished question initilization?
444 EFI_STRING_ID FormSetTitle
;
446 UINT8 NumberOfClassGuid
;
447 EFI_GUID ClassGuid
[3]; // Up to three ClassGuid
448 UINT16 Class
; // Tiano extended Class code
449 UINT16 SubClass
; // Tiano extended Subclass code
450 EFI_IMAGE_ID ImageId
;
452 FORM_BROWSER_STATEMENT
*StatementBuffer
; // Buffer for all Statements and Questions
453 EXPRESSION_OPCODE
*ExpressionBuffer
; // Buffer for all Expression OpCode
454 FORM_BROWSER_FORM
*SaveFailForm
; // The form which failed to save.
455 FORM_BROWSER_STATEMENT
*SaveFailStatement
; // The Statement which failed to save.
457 LIST_ENTRY StatementListOSF
; // Statement list out side of the form.
458 LIST_ENTRY StorageListHead
; // Storage list (FORMSET_STORAGE)
459 LIST_ENTRY SaveFailStorageListHead
; // Storage list for the save fail storage.
460 LIST_ENTRY DefaultStoreListHead
; // DefaultStore list (FORMSET_DEFAULTSTORE)
461 LIST_ENTRY FormListHead
; // Form list (FORM_BROWSER_FORM)
462 LIST_ENTRY ExpressionListHead
; // List of Expressions (FORM_EXPRESSION)
463 } FORM_BROWSER_FORMSET
;
464 #define FORM_BROWSER_FORMSET_FROM_LINK(a) CR (a, FORM_BROWSER_FORMSET, Link, FORM_BROWSER_FORMSET_SIGNATURE)
466 #define FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK(a) CR (a, FORM_BROWSER_FORMSET, SaveFailLink, FORM_BROWSER_FORMSET_SIGNATURE)
470 EFI_EVENT RefreshEvent
;
471 } FORM_BROWSER_REFRESH_EVENT_NODE
;
473 #define FORM_BROWSER_REFRESH_EVENT_FROM_LINK(a) BASE_CR (a, FORM_BROWSER_REFRESH_EVENT_NODE, Link)
477 EFI_HII_HANDLE Handle
;
480 // Target formset/form/Question information
482 EFI_GUID FormSetGuid
;
485 UINTN Sequence
; // used for time/date only.
494 // Ation for Browser to taken:
495 // UI_ACTION_NONE - navigation inside a form
496 // UI_ACTION_REFRESH_FORM - re-evaluate expressions and repaint form
497 // UI_ACTION_REFRESH_FORMSET - re-parse formset IFR binary
502 // Current selected fomset/form/Question
504 FORM_BROWSER_FORMSET
*FormSet
;
505 FORM_BROWSER_FORM
*Form
;
506 FORM_BROWSER_STATEMENT
*Statement
;
509 // Whether the Form is editable
511 BOOLEAN FormEditable
;
513 FORM_ENTRY_INFO
*CurrentMenu
;
516 #define BROWSER_CONTEXT_SIGNATURE SIGNATURE_32 ('B', 'C', 'T', 'X')
523 // Globals defined in Setup.c
525 BOOLEAN ResetRequired
;
526 BOOLEAN ExitRequired
;
527 EFI_HII_HANDLE HiiHandle
;
528 EFI_GUID FormSetGuid
;
530 UI_MENU_SELECTION
*Selection
;
532 LIST_ENTRY FormHistoryList
;
535 #define BROWSER_CONTEXT_FROM_LINK(a) CR (a, BROWSER_CONTEXT, Link, BROWSER_CONTEXT_SIGNATURE)
538 // Scope for get defaut value. It may be GetDefaultForNoStorage, GetDefaultForStorage or GetDefaultForAll.
541 GetDefaultForNoStorage
, // Get default value for question which not has storage.
542 GetDefaultForStorage
, // Get default value for question which has storage.
543 GetDefaultForAll
, // Get default value for all questions.
544 GetDefaultForMax
// Invalid value.
545 } BROWSER_GET_DEFAULT_VALUE
;
548 // Get/set question value from/to.
551 GetSetValueWithEditBuffer
= 0, // Get/Set question value from/to editbuffer in the storage.
552 GetSetValueWithBuffer
, // Get/Set question value from/to buffer in the storage.
553 GetSetValueWithHiiDriver
, // Get/Set question value from/to hii driver.
554 GetSetValueWithBothBuffer
, // Compare the editbuffer with buffer for this question, not use the question value.
555 GetSetValueWithMax
// Invalid value.
556 } GET_SET_QUESTION_VALUE_WITH
;
558 extern EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
559 extern EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
560 extern EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*mPathFromText
;
561 extern EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
*mFormDisplay
;
563 extern BOOLEAN gResetRequired
;
564 extern BOOLEAN gExitRequired
;
565 extern LIST_ENTRY gBrowserFormSetList
;
566 extern LIST_ENTRY gBrowserHotKeyList
;
567 extern BROWSER_SETTING_SCOPE gBrowserSettingScope
;
568 extern EXIT_HANDLER ExitHandlerFunction
;
569 extern EFI_HII_HANDLE mCurrentHiiHandle
;
570 extern SETUP_DRIVER_PRIVATE_DATA mPrivateData
;
572 // Browser Global Strings
574 extern CHAR16
*gEmptyString
;
576 extern EFI_GUID gZeroGuid
;
578 extern UI_MENU_SELECTION
*gCurrentSelection
;
581 // Global Procedure Defines
583 #include "Expression.h"
586 Initialize the HII String Token to the correct values.
590 InitializeBrowserStrings (
595 Parse opcodes in the formset IFR binary.
597 @param FormSet Pointer of the FormSet data structure.
599 @retval EFI_SUCCESS Opcode parse success.
600 @retval Other Opcode parse fail.
605 IN FORM_BROWSER_FORMSET
*FormSet
609 Free resources allocated for a FormSet.
611 @param FormSet Pointer of the FormSet
616 IN OUT FORM_BROWSER_FORMSET
*FormSet
621 Create a new string in HII Package List.
623 @param String The String to be added
624 @param HiiHandle The package list in the HII database to insert the
627 @return The output string.
633 IN EFI_HII_HANDLE HiiHandle
637 Delete a string from HII Package List.
639 @param StringId Id of the string in HII database.
640 @param HiiHandle The HII package list handle.
642 @retval EFI_SUCCESS The string was deleted successfully.
647 IN EFI_STRING_ID StringId
,
648 IN EFI_HII_HANDLE HiiHandle
652 Get the string based on the StringId and HII Package List Handle.
654 @param Token The String's ID.
655 @param HiiHandle The package list in the HII database to search for
656 the specified string.
658 @return The output string.
663 IN EFI_STRING_ID Token
,
664 IN EFI_HII_HANDLE HiiHandle
668 Get Value for given Name from a NameValue Storage.
670 @param Storage The NameValue Storage.
671 @param Name The Name.
672 @param Value The retured Value.
673 @param GetValueFrom Where to get source value, from EditValue or Value.
675 @retval EFI_SUCCESS Value found for given Name.
676 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
681 IN BROWSER_STORAGE
*Storage
,
683 IN OUT CHAR16
**Value
,
684 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
688 Set Value of given Name in a NameValue Storage.
690 @param Storage The NameValue Storage.
691 @param Name The Name.
692 @param Value The Value to set.
693 @param SetValueTo Whether update editValue or Value.
694 @param ReturnNode The node use the input name.
696 @retval EFI_SUCCESS Value found for given Name.
697 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
702 IN BROWSER_STORAGE
*Storage
,
705 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
,
706 OUT NAME_VALUE_NODE
**ReturnNode
710 Validate whether this question's value has changed.
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 TRUE Question's value has changed.
718 @retval FALSE Question's value has not changed
722 IsQuestionValueChanged (
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 Validate the FormSet. If the formset is not validate, remove it from the list.
732 @param FormSet The input FormSet which need to validate.
734 @retval TRUE The handle is validate.
735 @retval FALSE The handle is invalidate.
740 FORM_BROWSER_FORMSET
*FormSet
744 Update the ValueChanged status for questions.
746 @param FormSet FormSet data structure.
747 @param Form Form data structure.
748 @param SettingScope Setting Scope for Default action.
752 UpdateStatementStatus (
753 IN FORM_BROWSER_FORMSET
*FormSet
,
754 IN FORM_BROWSER_FORM
*Form
,
755 IN BROWSER_SETTING_SCOPE SettingScope
759 Get Question's current Value.
761 @param FormSet FormSet data structure.
762 @param Form Form data structure.
763 @param Question Question to be initialized.
764 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
766 @retval EFI_SUCCESS The function completed successfully.
771 IN FORM_BROWSER_FORMSET
*FormSet
,
772 IN FORM_BROWSER_FORM
*Form
,
773 IN OUT FORM_BROWSER_STATEMENT
*Question
,
774 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
778 Save Question Value to edit copy(cached) or Storage(uncached).
780 @param FormSet FormSet data structure.
781 @param Form Form data structure.
782 @param Question Pointer to the Question.
783 @param SetValueTo Update the question value to editbuffer , buffer or hii driver.
785 @retval EFI_SUCCESS The function completed successfully.
790 IN FORM_BROWSER_FORMSET
*FormSet
,
791 IN FORM_BROWSER_FORM
*Form
,
792 IN OUT FORM_BROWSER_STATEMENT
*Question
,
793 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
797 Perform inconsistent check for a Form.
799 @param FormSet FormSet data structure.
800 @param Form Form data structure.
801 @param Question The Question to be validated.
802 @param Type Validation type: InConsistent or NoSubmit
804 @retval EFI_SUCCESS Form validation pass.
805 @retval other Form validation failed.
810 IN FORM_BROWSER_FORMSET
*FormSet
,
811 IN FORM_BROWSER_FORM
*Form
,
812 IN FORM_BROWSER_STATEMENT
*Question
,
818 Discard data based on the input setting scope (Form, FormSet or System).
820 @param FormSet FormSet data structure.
821 @param Form Form data structure.
822 @param SettingScope Setting Scope for Discard action.
824 @retval EFI_SUCCESS The function completed successfully.
825 @retval EFI_UNSUPPORTED Unsupport SettingScope.
830 IN FORM_BROWSER_FORMSET
*FormSet
,
831 IN FORM_BROWSER_FORM
*Form
,
832 IN BROWSER_SETTING_SCOPE SettingScope
836 Submit data based on the input Setting level (Form, FormSet or System).
838 @param FormSet FormSet data structure.
839 @param Form Form data structure.
840 @param SettingScope Setting Scope for Submit action.
842 @retval EFI_SUCCESS The function completed successfully.
843 @retval EFI_UNSUPPORTED Unsupport SettingScope.
848 IN FORM_BROWSER_FORMSET
*FormSet
,
849 IN FORM_BROWSER_FORM
*Form
,
850 IN BROWSER_SETTING_SCOPE SettingScope
854 Reset Question to its default value.
856 @param FormSet The form set.
857 @param Form The form.
858 @param Question The question.
859 @param DefaultId The Class of the default.
861 @retval EFI_SUCCESS Question is reset to default value.
866 IN FORM_BROWSER_FORMSET
*FormSet
,
867 IN FORM_BROWSER_FORM
*Form
,
868 IN FORM_BROWSER_STATEMENT
*Question
,
873 Get current setting of Questions.
875 @param FormSet FormSet data structure.
879 InitializeCurrentSetting (
880 IN OUT FORM_BROWSER_FORMSET
*FormSet
884 Initialize the internal data structure of a FormSet.
886 @param Handle PackageList Handle
887 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
888 GUID), take the first FormSet found in package
890 @param FormSet FormSet data structure.
892 @retval EFI_SUCCESS The function completed successfully.
893 @retval EFI_NOT_FOUND The specified FormSet could not be found.
898 IN EFI_HII_HANDLE Handle
,
899 IN OUT EFI_GUID
*FormSetGuid
,
900 OUT FORM_BROWSER_FORMSET
*FormSet
904 Reset Questions to their initial value or default value in a Form, Formset or System.
906 GetDefaultValueScope parameter decides which questions will reset
907 to its default value.
909 @param FormSet FormSet data structure.
910 @param Form Form data structure.
911 @param DefaultId The Class of the default.
912 @param SettingScope Setting Scope for Default action.
913 @param GetDefaultValueScope Get default value scope.
914 @param Storage Get default value only for this storage.
915 @param RetrieveValueFirst Whether call the retrieve call back to
916 get the initial value before get default
919 @retval EFI_SUCCESS The function completed successfully.
920 @retval EFI_UNSUPPORTED Unsupport SettingScope.
925 IN FORM_BROWSER_FORMSET
*FormSet
,
926 IN FORM_BROWSER_FORM
*Form
,
928 IN BROWSER_SETTING_SCOPE SettingScope
,
929 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope
,
930 IN BROWSER_STORAGE
*Storage
,
931 IN BOOLEAN RetrieveValueFirst
935 Initialize Question's Edit copy from Storage.
937 @param Selection Selection contains the information about
938 the Selection, form and formset to be displayed.
939 Selection action may be updated in retrieve callback.
940 If Selection is NULL, only initialize Question value.
941 @param FormSet FormSet data structure.
942 @param Form Form data structure.
944 @retval EFI_SUCCESS The function completed successfully.
949 IN OUT UI_MENU_SELECTION
*Selection
,
950 IN FORM_BROWSER_FORMSET
*FormSet
,
951 IN FORM_BROWSER_FORM
*Form
955 Initialize Question's Edit copy from Storage for the whole Formset.
957 @param Selection Selection contains the information about
958 the Selection, form and formset to be displayed.
959 Selection action may be updated in retrieve callback.
960 If Selection is NULL, only initialize Question value.
961 @param FormSet FormSet data structure.
963 @retval EFI_SUCCESS The function completed successfully.
968 IN OUT UI_MENU_SELECTION
*Selection
,
969 IN FORM_BROWSER_FORMSET
*FormSet
973 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
975 @param Storage The Storage to be conveted.
976 @param ConfigResp The returned <ConfigResp>.
977 @param ConfigRequest The ConfigRequest string.
978 @param GetEditBuf Get the data from editbuffer or buffer.
980 @retval EFI_SUCCESS Convert success.
981 @retval EFI_INVALID_PARAMETER Incorrect storage type.
985 StorageToConfigResp (
986 IN BROWSER_STORAGE
*Storage
,
987 IN CHAR16
**ConfigResp
,
988 IN CHAR16
*ConfigRequest
,
989 IN BOOLEAN GetEditBuf
993 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
995 @param Storage The Storage to receive the settings.
996 @param ConfigResp The <ConfigResp> to be converted.
998 @retval EFI_SUCCESS Convert success.
999 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1003 ConfigRespToStorage (
1004 IN BROWSER_STORAGE
*Storage
,
1005 IN CHAR16
*ConfigResp
1009 Fill storage's edit copy with settings requested from Configuration Driver.
1011 @param FormSet FormSet data structure.
1012 @param Storage Buffer Storage.
1017 IN FORM_BROWSER_FORMSET
*FormSet
,
1018 IN FORMSET_STORAGE
*Storage
1022 Fetch the Ifr binary data of a FormSet.
1024 @param Handle PackageList Handle
1025 @param FormSetGuid GUID of a formset. If not specified (NULL or zero
1026 GUID), take the first FormSet found in package
1028 @param BinaryLength The length of the FormSet IFR binary.
1029 @param BinaryData The buffer designed to receive the FormSet.
1031 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
1032 BufferLength was updated.
1033 @retval EFI_INVALID_PARAMETER The handle is unknown.
1034 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
1035 be found with the requested FormId.
1040 IN EFI_HII_HANDLE Handle
,
1041 IN OUT EFI_GUID
*FormSetGuid
,
1042 OUT UINTN
*BinaryLength
,
1043 OUT UINT8
**BinaryData
1047 Save globals used by previous call to SendForm(). SendForm() may be called from
1048 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
1049 So, save globals of previous call to SendForm() and restore them upon exit.
1053 SaveBrowserContext (
1058 Restore globals used by previous call to SendForm().
1062 RestoreBrowserContext (
1067 This is the routine which an external caller uses to direct the browser
1068 where to obtain it's information.
1071 @param This The Form Browser protocol instanse.
1072 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
1073 display a list of the formsets for the handles specified.
1074 @param HandleCount The number of Handles specified in Handle.
1075 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
1076 field in the EFI_IFR_FORM_SET op-code for the specified
1077 forms-based package. If FormSetGuid is NULL, then this
1078 function will display the first found forms package.
1079 @param FormId This field specifies which EFI_IFR_FORM to render as the first
1080 displayable page. If this field has a value of 0x0000, then
1081 the forms browser will render the specified forms in their encoded order.
1082 ScreenDimenions - This allows the browser to be called so that it occupies a
1083 portion of the physical screen instead of dynamically determining the screen dimensions.
1084 ActionRequest - Points to the action recommended by the form.
1085 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
1087 @param ActionRequest Points to the action recommended by the form.
1089 @retval EFI_SUCCESS The function completed successfully.
1090 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
1091 @retval EFI_NOT_FOUND No valid forms could be found to display.
1097 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1098 IN EFI_HII_HANDLE
*Handles
,
1099 IN UINTN HandleCount
,
1100 IN EFI_GUID
*FormSetGuid
, OPTIONAL
1101 IN UINT16 FormId
, OPTIONAL
1102 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
1103 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
1107 This function is called by a callback handler to retrieve uncommitted state
1108 data from the browser.
1110 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
1112 @param ResultsDataSize A pointer to the size of the buffer associated
1114 @param ResultsData A string returned from an IFR browser or
1115 equivalent. The results string will have no
1116 routing information in them.
1117 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
1118 (if RetrieveData = TRUE) data from the uncommitted
1119 browser state information or set (if RetrieveData
1120 = FALSE) data in the uncommitted browser state
1122 @param VariableGuid An optional field to indicate the target variable
1124 @param VariableName An optional field to indicate the target
1125 human-readable variable name.
1127 @retval EFI_SUCCESS The results have been distributed or are awaiting
1129 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
1130 contain the results data.
1136 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
1137 IN OUT UINTN
*ResultsDataSize
,
1138 IN OUT EFI_STRING ResultsData
,
1139 IN BOOLEAN RetrieveData
,
1140 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
1141 IN CONST CHAR16
*VariableName OPTIONAL
1145 Find menu which will show next time.
1147 @param Selection On input, Selection tell setup browser the information
1148 about the Selection, form and formset to be displayed.
1149 On output, Selection return the screen item that is selected
1151 @param SettingLevel Input Settting level, if it is FormLevel, just exit current form.
1152 else, we need to exit current formset.
1154 @retval TRUE Exit current form.
1155 @retval FALSE User press ESC and keep in current form.
1159 IN OUT UI_MENU_SELECTION
*Selection
,
1160 IN BROWSER_SETTING_SCOPE SettingLevel
1164 check whether the form need to update the NV.
1166 @param Form Form data structure.
1168 @retval TRUE Need to update the NV.
1169 @retval FALSE No need to update the NV.
1172 IsNvUpdateRequiredForForm (
1173 IN FORM_BROWSER_FORM
*Form
1177 check whether the formset need to update the NV.
1179 @param FormSet FormSet data structure.
1181 @retval TRUE Need to update the NV.
1182 @retval FALSE No need to update the NV.
1185 IsNvUpdateRequiredForFormSet (
1186 IN FORM_BROWSER_FORMSET
*FormSet
1190 Call the call back function for the question and process the return action.
1192 @param Selection On input, Selection tell setup browser the information
1193 about the Selection, form and formset to be displayed.
1194 On output, Selection return the screen item that is selected
1196 @param FormSet The formset this question belong to.
1197 @param Form The form this question belong to.
1198 @param Question The Question which need to call.
1199 @param Action The action request.
1200 @param SkipSaveOrDiscard Whether skip save or discard action.
1202 @retval EFI_SUCCESS The call back function excutes successfully.
1203 @return Other value if the call back function failed to excute.
1206 ProcessCallBackFunction (
1207 IN OUT UI_MENU_SELECTION
*Selection
,
1208 IN FORM_BROWSER_FORMSET
*FormSet
,
1209 IN FORM_BROWSER_FORM
*Form
,
1210 IN FORM_BROWSER_STATEMENT
*Question
,
1211 IN EFI_BROWSER_ACTION Action
,
1212 IN BOOLEAN SkipSaveOrDiscard
1216 Call the retrieve type call back function for one question to get the initialize data.
1218 This function only used when in the initialize stage, because in this stage, the
1219 Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.
1221 @param ConfigAccess The config access protocol produced by the hii driver.
1222 @param Statement The Question which need to call.
1223 @param FormSet The formset this question belong to.
1225 @retval EFI_SUCCESS The call back function excutes successfully.
1226 @return Other value if the call back function failed to excute.
1229 ProcessRetrieveForQuestion (
1230 IN EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
,
1231 IN FORM_BROWSER_STATEMENT
*Statement
,
1232 IN FORM_BROWSER_FORMSET
*FormSet
1236 Find the matched FormSet context in the backup maintain list based on HiiHandle.
1238 @param Handle The Hii Handle.
1240 @return the found FormSet context. If no found, NULL will return.
1243 FORM_BROWSER_FORMSET
*
1244 GetFormSetFromHiiHandle (
1245 EFI_HII_HANDLE Handle
1249 Check whether the input HII handle is the FormSet that is being used.
1251 @param Handle The Hii Handle.
1253 @retval TRUE HII handle is being used.
1254 @retval FALSE HII handle is not being used.
1258 IsHiiHandleInBrowserContext (
1259 EFI_HII_HANDLE Handle
1263 Configure what scope the hot key will impact.
1264 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
1265 If no scope is set, the default scope will be FormSet level.
1266 After all registered hot keys are removed, previous Scope can reset to another level.
1268 @param[in] Scope Scope level to be set.
1270 @retval EFI_SUCCESS Scope is set correctly.
1271 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
1272 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
1278 IN BROWSER_SETTING_SCOPE Scope
1282 Register the hot key with its browser action, or unregistered the hot key.
1283 Only support hot key that is not printable character (control key, function key, etc.).
1284 If the action value is zero, the hot key will be unregistered if it has been registered.
1285 If the same hot key has been registered, the new action and help string will override the previous ones.
1287 @param[in] KeyData A pointer to a buffer that describes the keystroke
1288 information for the hot key. Its type is EFI_INPUT_KEY to
1289 be supported by all ConsoleIn devices.
1290 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
1291 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
1292 @param[in] HelpString Help string that describes the hot key information.
1293 Its value may be NULL for the unregistered hot key.
1295 @retval EFI_SUCCESS Hot key is registered or unregistered.
1296 @retval EFI_INVALID_PARAMETER KeyData is NULL.
1297 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
1298 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
1303 IN EFI_INPUT_KEY
*KeyData
,
1305 IN UINT16 DefaultId
,
1306 IN EFI_STRING HelpString OPTIONAL
1310 Register Exit handler function.
1311 When more than one handler function is registered, the latter one will override the previous one.
1312 When NULL handler is specified, the previous Exit handler will be unregistered.
1314 @param[in] Handler Pointer to handler function.
1319 RegiserExitHandler (
1320 IN EXIT_HANDLER Handler
1325 Check whether the browser data has been modified.
1327 @retval TRUE Browser data is changed.
1328 @retval FALSE No browser data is changed.
1333 IsBrowserDataModified (
1339 Execute the action requested by the Action parameter.
1341 @param[in] Action Execute the request action.
1342 @param[in] DefaultId The default Id info when need to load default value.
1344 @retval EFI_SUCCESS Execute the request action succss.
1345 @retval EFI_INVALID_PARAMETER The input action value is invalid.
1356 Create reminder to let user to choose save or discard the changed browser data.
1357 Caller can use it to actively check the changed browser data.
1359 @retval BROWSER_NO_CHANGES No browser data is changed.
1360 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
1361 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
1362 @retval BROWSER_KEEP_CURRENT Browser keep current changes.
1372 Check whether the Reset Required for the browser
1374 @retval TRUE Browser required to reset after exit.
1375 @retval FALSE Browser not need to reset after exit.
1385 Find the registered HotKey based on KeyData.
1387 @param[in] KeyData A pointer to a buffer that describes the keystroke
1388 information for the hot key.
1390 @return The registered HotKey context. If no found, NULL will return.
1393 GetHotKeyFromRegisterList (
1394 IN EFI_INPUT_KEY
*KeyData
1399 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1401 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1403 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1406 FORM_BROWSER_STATEMENT
*
1407 GetBrowserStatement (
1408 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1412 Password may be stored as encrypted by Configuration Driver. When change a
1413 password, user will be challenged with old password. To validate user input old
1414 password, we will send the clear text to Configuration Driver via Callback().
1415 Configuration driver is responsible to check the passed in password and return
1416 the validation result. If validation pass, state machine in password Callback()
1417 will transit from BROWSER_STATE_VALIDATE_PASSWORD to BROWSER_STATE_SET_PASSWORD.
1418 After user type in new password twice, Callback() will be invoked to send the
1419 new password to Configuration Driver.
1421 @param Selection Pointer to UI_MENU_SELECTION.
1422 @param MenuOption The MenuOption for this password Question.
1423 @param String The clear text of password.
1425 @retval EFI_NOT_AVAILABLE_YET Callback() request to terminate password input.
1426 @return In state of BROWSER_STATE_VALIDATE_PASSWORD:
1427 @retval EFI_SUCCESS Password correct, Browser will prompt for new
1429 @retval EFI_NOT_READY Password incorrect, Browser will show error
1431 @retval Other Browser will do nothing.
1432 @return In state of BROWSER_STATE_SET_PASSWORD:
1433 @retval EFI_SUCCESS Set password success.
1434 @retval Other Set password failed.
1439 IN UI_MENU_SELECTION
*Selection
,
1440 IN FORM_BROWSER_STATEMENT
*Question
,
1445 Display error message for invalid password.
1454 The worker function that send the displays to the screen. On output,
1455 the selection made by user is returned.
1457 @param Selection On input, Selection tell setup browser the information
1458 about the Selection, form and formset to be displayed.
1459 On output, Selection return the screen item that is selected
1462 @retval EFI_SUCCESS The page is displayed successfully.
1463 @return Other value if the page failed to be diplayed.
1468 IN OUT UI_MENU_SELECTION
*Selection
1472 Free up the resource allocated for all strings required
1477 FreeBrowserStrings (
1482 Create a menu with specified formset GUID and form ID, and add it as a child
1483 of the given parent menu.
1485 @param HiiHandle Hii handle related to this formset.
1486 @param FormSetGuid The Formset Guid of menu to be added.
1487 @param FormId The Form ID of menu to be added.
1488 @param QuestionId The question id of this menu to be added.
1490 @return A pointer to the newly added menu or NULL if memory is insufficient.
1495 IN EFI_HII_HANDLE HiiHandle
,
1496 IN EFI_GUID
*FormSetGuid
,
1498 IN UINT16 QuestionId
1502 Search Menu with given FormSetGuid and FormId in all cached menu list.
1504 @param HiiHandle HiiHandle for FormSet.
1505 @param FormSetGuid The Formset GUID of the menu to search.
1506 @param FormId The Form ID of menu to search.
1508 @return A pointer to menu found or NULL if not found.
1513 IN EFI_HII_HANDLE HiiHandle
,
1514 IN EFI_GUID
*FormSetGuid
,
1519 Free Menu list linked list.
1521 @param MenuListHead One Menu list point in the menu list.
1526 LIST_ENTRY
*MenuListHead
1530 Find parent menu for current menu.
1532 @param CurrentMenu Current Menu
1533 @param SettingLevel Whether find parent menu in Form Level or Formset level.
1534 In form level, just find the parent menu;
1535 In formset level, find the parent menu which has different
1538 @retval The parent menu for current menu.
1542 IN FORM_ENTRY_INFO
*CurrentMenu
,
1543 IN BROWSER_SETTING_SCOPE SettingLevel
1547 Validate the HiiHandle.
1549 @param HiiHandle The input HiiHandle which need to validate.
1551 @retval TRUE The handle is validate.
1552 @retval FALSE The handle is invalidate.
1557 EFI_HII_HANDLE HiiHandle
1561 Copy current Menu list to the new menu list.
1563 @param NewMenuListHead New create Menu list.
1564 @param CurrentMenuListHead Current Menu list.
1569 OUT LIST_ENTRY
*NewMenuListHead
,
1570 IN LIST_ENTRY
*CurrentMenuListHead
1574 Search an Option of a Question by its value.
1576 @param Question The Question
1577 @param OptionValue Value for Option to be searched.
1579 @retval Pointer Pointer to the found Option.
1580 @retval NULL Option not found.
1585 IN FORM_BROWSER_STATEMENT
*Question
,
1586 IN EFI_HII_VALUE
*OptionValue
1589 Return data element in an Array by its Index.
1591 @param Array The data array.
1592 @param Type Type of the data in this array.
1593 @param Index Zero based index for data in this array.
1595 @retval Value The data to be returned
1606 Set value of a data element in an Array by its Index.
1608 @param Array The data array.
1609 @param Type Type of the data in this array.
1610 @param Index Zero based index for data in this array.
1611 @param Value The value to be set.
1623 Compare two Hii value.
1625 @param Value1 Expression value to compare on left-hand.
1626 @param Value2 Expression value to compare on right-hand.
1627 @param Result Return value after compare.
1628 retval 0 Two operators equal.
1629 return Positive value if Value1 is greater than Value2.
1630 retval Negative value if Value1 is less than Value2.
1631 @param HiiHandle Only required for string compare.
1633 @retval other Could not perform compare on two values.
1634 @retval EFI_SUCCESS Compare the value success.
1639 IN EFI_HII_VALUE
*Value1
,
1640 IN EFI_HII_VALUE
*Value2
,
1642 IN EFI_HII_HANDLE HiiHandle OPTIONAL
1646 Perform Password check.
1647 Passwork may be encrypted by driver that requires the specific check.
1649 @param Form Form where Password Statement is in.
1650 @param Statement Password statement
1651 @param PasswordString Password string to be checked. It may be NULL.
1652 NULL means to restore password.
1653 "" string can be used to checked whether old password does exist.
1655 @return Status Status of Password check.
1660 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
1661 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
1662 IN EFI_STRING PasswordString OPTIONAL
1667 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
1669 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
1671 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
1674 FORM_BROWSER_STATEMENT
*
1675 GetBrowserStatement (
1676 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
1681 Initialize the Display form structure data.
1685 InitializeDisplayFormData (
1691 Base on the current formset info, clean the ConfigRequest string in browser storage.
1693 @param FormSet Pointer of the FormSet
1697 CleanBrowserStorage (
1698 IN OUT FORM_BROWSER_FORMSET
*FormSet
1702 Find HII Handle in the HII database associated with given Device Path.
1704 If DevicePath is NULL, then ASSERT.
1706 @param DevicePath Device Path associated with the HII package list
1708 @param FormsetGuid The formset guid for this formset.
1710 @retval Handle HII package list Handle associated with the Device
1712 @retval NULL Hii Package list handle is not found.
1716 DevicePathToHiiHandle (
1717 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1718 IN EFI_GUID
*FormsetGuid
1722 Adjust the config request info, remove the request elements which already in AllConfigRequest string.
1724 @param Storage Form set Storage.
1725 @param Request The input request string.
1726 @param RespString Whether the input is ConfigRequest or ConfigResp format.
1728 @retval TRUE Has element not covered by current used elements, need to continue to call ExtractConfig
1729 @retval FALSE All elements covered by current used elements.
1733 ConfigRequestAdjust (
1734 IN BROWSER_STORAGE
*Storage
,
1736 IN BOOLEAN RespString
1740 Perform question check.
1742 If one question has more than one check, process form high priority to low.
1744 @param FormSet FormSet data structure.
1745 @param Form Form data structure.
1746 @param Question The Question to be validated.
1748 @retval EFI_SUCCESS Form validation pass.
1749 @retval other Form validation failed.
1753 ValueChangedValidation (
1754 IN FORM_BROWSER_FORMSET
*FormSet
,
1755 IN FORM_BROWSER_FORM
*Form
,
1756 IN FORM_BROWSER_STATEMENT
*Question
1760 Pop up the error info.
1762 @param BrowserStatus The input browser status.
1763 @param HiiHandle The HiiHandle for this error opcode.
1764 @param OpCode The opcode use to get the erro info and timeout value.
1765 @param ErrorString Error string used by BROWSER_NO_SUBMIT_IF.
1770 IN UINT32 BrowserStatus
,
1771 IN EFI_HII_HANDLE HiiHandle
,
1772 IN EFI_IFR_OP_HEADER
*OpCode
, OPTIONAL
1773 IN CHAR16
*ErrorString
1777 Check whether the result is TRUE or FALSE.
1779 For the EFI_HII_VALUE value type is numeric, return TRUE if the
1782 @param Result Input the result data.
1784 @retval TRUE The result is TRUE.
1785 @retval FALSE The result is FALSE.
1790 IN EFI_HII_VALUE
*Result