2 Utility functions for UI presentation.
4 Copyright (c) 2004 - 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.
17 BOOLEAN mHiiPackageListUpdated
;
18 UI_MENU_SELECTION
*gCurrentSelection
;
19 EFI_HII_HANDLE mCurrentHiiHandle
= NULL
;
20 EFI_GUID mCurrentFormSetGuid
= {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
21 UINT16 mCurrentFormId
= 0;
22 EFI_EVENT mValueChangedEvent
= NULL
;
23 LIST_ENTRY mRefreshEventList
= INITIALIZE_LIST_HEAD_VARIABLE (mRefreshEventList
);
24 UINT32 gBrowserStatus
= BROWSER_SUCCESS
;
26 UINT16 mCurFakeQestId
;
27 FORM_DISPLAY_ENGINE_FORM gDisplayFormData
;
30 Evaluate all expressions in a Form.
32 @param FormSet FormSet this Form belongs to.
35 @retval EFI_SUCCESS The expression evaluated successfuly
39 EvaluateFormExpressions (
40 IN FORM_BROWSER_FORMSET
*FormSet
,
41 IN FORM_BROWSER_FORM
*Form
46 FORM_EXPRESSION
*Expression
;
48 Link
= GetFirstNode (&Form
->ExpressionListHead
);
49 while (!IsNull (&Form
->ExpressionListHead
, Link
)) {
50 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
51 Link
= GetNextNode (&Form
->ExpressionListHead
, Link
);
53 if (Expression
->Type
== EFI_HII_EXPRESSION_INCONSISTENT_IF
||
54 Expression
->Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
||
55 Expression
->Type
== EFI_HII_EXPRESSION_WARNING_IF
||
56 Expression
->Type
== EFI_HII_EXPRESSION_WRITE
||
57 (Expression
->Type
== EFI_HII_EXPRESSION_READ
&& Form
->FormType
!= STANDARD_MAP_FORM_TYPE
)) {
59 // Postpone Form validation to Question editing or Form submitting or Question Write or Question Read for nonstandard form.
64 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
65 if (EFI_ERROR (Status
)) {
74 Add empty function for event process function.
76 @param Event The Event need to be process
77 @param Context The context of the event.
82 SetupBrowserEmptyFunction (
90 Base on the opcode buffer info to get the display statement.
92 @param OpCode The input opcode buffer for this statement.
94 @retval Statement The statement use this opcode buffer.
97 FORM_DISPLAY_ENGINE_STATEMENT
*
99 IN EFI_IFR_OP_HEADER
*OpCode
102 FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
;
105 Link
= GetFirstNode (&gDisplayFormData
.StatementListHead
);
106 while (!IsNull (&gDisplayFormData
.StatementListHead
, Link
)) {
107 DisplayStatement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link
);
109 if (DisplayStatement
->OpCode
== OpCode
) {
110 return DisplayStatement
;
112 Link
= GetNextNode (&gDisplayFormData
.StatementListHead
, Link
);
119 Free the refresh event list.
128 FORM_BROWSER_REFRESH_EVENT_NODE
*EventNode
;
130 while (!IsListEmpty (&mRefreshEventList
)) {
131 Link
= GetFirstNode (&mRefreshEventList
);
132 EventNode
= FORM_BROWSER_REFRESH_EVENT_FROM_LINK (Link
);
133 RemoveEntryList (&EventNode
->Link
);
135 gBS
->CloseEvent (EventNode
->RefreshEvent
);
137 FreePool (EventNode
);
142 Check whether this statement value is changed. If yes, update the statement value and return TRUE;
145 @param Statement The statement need to check.
150 IN OUT FORM_BROWSER_STATEMENT
*Statement
153 GetQuestionValue (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Statement
, GetSetValueWithHiiDriver
);
156 // Reset FormPackage update flag
158 mHiiPackageListUpdated
= FALSE
;
161 // Question value may be changed, need invoke its Callback()
163 ProcessCallBackFunction (gCurrentSelection
, gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Statement
, EFI_BROWSER_ACTION_RETRIEVE
, FALSE
);
165 if (mHiiPackageListUpdated
) {
167 // Package list is updated, force to reparse IFR binary of target Formset
169 mHiiPackageListUpdated
= FALSE
;
170 gCurrentSelection
->Action
= UI_ACTION_REFRESH_FORMSET
;
175 Refresh the question which has refresh guid event attribute.
177 @param Event The event which has this function related.
178 @param Context The input context info related to this event or the status code return to the caller.
187 FORM_BROWSER_STATEMENT
*Statement
;
189 Statement
= (FORM_BROWSER_STATEMENT
*)Context
;
190 UpdateStatement(Statement
);
191 gBS
->SignalEvent (mValueChangedEvent
);
196 Create refresh hook event for statement which has refresh event or interval.
198 @param Statement The statement need to check.
203 IN FORM_BROWSER_STATEMENT
*Statement
207 EFI_EVENT RefreshEvent
;
208 FORM_BROWSER_REFRESH_EVENT_NODE
*EventNode
;
211 // If question has refresh guid, create the notify function.
213 Status
= gBS
->CreateEventEx (
218 &Statement
->RefreshGuid
,
220 ASSERT_EFI_ERROR (Status
);
222 EventNode
= AllocateZeroPool (sizeof (FORM_BROWSER_REFRESH_EVENT_NODE
));
223 ASSERT (EventNode
!= NULL
);
224 EventNode
->RefreshEvent
= RefreshEvent
;
225 InsertTailList(&mRefreshEventList
, &EventNode
->Link
);
229 Perform value check for a question.
231 @param Question The question need to do check.
232 @param Type Condition type need to check.
233 @param ErrorInfo Return info about the error.
235 @retval The check result.
239 IN FORM_BROWSER_STATEMENT
*Question
,
241 OUT STATEMENT_ERROR_INFO
*ErrorInfo
246 FORM_EXPRESSION
*Expression
;
247 LIST_ENTRY
*ListHead
;
250 RetVal
= STATEMENT_VALID
;
254 case EFI_HII_EXPRESSION_INCONSISTENT_IF
:
255 ListHead
= &Question
->InconsistentListHead
;
258 case EFI_HII_EXPRESSION_WARNING_IF
:
259 ListHead
= &Question
->WarningListHead
;
267 ASSERT (ListHead
!= NULL
);
268 Link
= GetFirstNode (ListHead
);
269 while (!IsNull (ListHead
, Link
)) {
270 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
271 Link
= GetNextNode (ListHead
, Link
);
274 // Evaluate the expression
276 Status
= EvaluateExpression (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Expression
);
277 if (EFI_ERROR (Status
)) {
281 if ((Expression
->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
) && Expression
->Result
.Value
.b
) {
282 ErrorInfo
->StringId
= Expression
->Error
;
284 case EFI_HII_EXPRESSION_INCONSISTENT_IF
:
285 ErrorInfo
->TimeOut
= 0;
286 RetVal
= INCOSISTENT_IF_TRUE
;
289 case EFI_HII_EXPRESSION_WARNING_IF
:
290 ErrorInfo
->TimeOut
= Expression
->TimeOut
;
291 RetVal
= WARNING_IF_TRUE
;
306 Perform value check for a question.
308 @param Form Form where Statement is in.
309 @param Statement Value will check for it.
310 @param InputValue New value will be checked.
311 @param ErrorInfo Return the error info for this check.
313 @retval TRUE Input Value is valid.
314 @retval FALSE Input Value is invalid.
319 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
320 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
321 IN EFI_HII_VALUE
*InputValue
,
322 OUT STATEMENT_ERROR_INFO
*ErrorInfo
325 FORM_BROWSER_STATEMENT
*Question
;
326 EFI_HII_VALUE BackUpValue
;
331 RetVal
= STATEMENT_VALID
;
333 ASSERT (Form
!= NULL
&& Statement
!= NULL
&& InputValue
!= NULL
&& ErrorInfo
!= NULL
);
335 Question
= GetBrowserStatement(Statement
);
336 ASSERT (Question
!= NULL
);
339 // Back up the quesion value.
341 switch (Question
->Operand
) {
342 case EFI_IFR_ORDERED_LIST_OP
:
343 BackUpBuffer
= AllocateCopyPool (Question
->StorageWidth
, Question
->BufferValue
);
344 ASSERT (BackUpBuffer
!= NULL
);
345 CopyMem (Question
->BufferValue
, InputValue
->Buffer
, Question
->StorageWidth
);
349 CopyMem (&BackUpValue
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
350 CopyMem (&Question
->HiiValue
, InputValue
, sizeof (EFI_HII_VALUE
));
355 // Do the inconsistentif check.
357 if (!IsListEmpty (&Question
->InconsistentListHead
)) {
358 RetVal
= ConditionCheck(Question
, EFI_HII_EXPRESSION_INCONSISTENT_IF
, ErrorInfo
);
362 // Do the warningif check.
364 if (RetVal
== STATEMENT_VALID
&& !IsListEmpty (&Question
->WarningListHead
)) {
365 RetVal
= ConditionCheck(Question
, EFI_HII_EXPRESSION_WARNING_IF
, ErrorInfo
);
369 // Restore the quesion value.
371 switch (Question
->Operand
) {
372 case EFI_IFR_ORDERED_LIST_OP
:
373 CopyMem (Question
->BufferValue
, BackUpBuffer
, Question
->StorageWidth
);
377 CopyMem (&Question
->HiiValue
, &BackUpValue
, sizeof (EFI_HII_VALUE
));
386 Initialize the Display statement structure data.
388 @param DisplayStatement Pointer to the display Statement data strucure.
389 @param Statement The statement need to check.
390 @param HostDisplayStatement Pointer to the display Statement data strucure which is an host statement.
393 InitializeDisplayStatement (
394 IN OUT FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
,
395 IN FORM_BROWSER_STATEMENT
*Statement
,
396 IN FORM_DISPLAY_ENGINE_STATEMENT
*HostDisplayStatement
400 QUESTION_OPTION
*Option
;
401 DISPLAY_QUESTION_OPTION
*DisplayOption
;
403 DisplayStatement
->Signature
= FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE
;
404 DisplayStatement
->Version
= FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1
;
405 DisplayStatement
->OpCode
= Statement
->OpCode
;
406 InitializeListHead (&DisplayStatement
->NestStatementList
);
407 InitializeListHead (&DisplayStatement
->OptionListHead
);
409 if ((EvaluateExpressionList(Statement
->Expression
, FALSE
, NULL
, NULL
) == ExpressGrayOut
) || Statement
->Locked
) {
410 DisplayStatement
->Attribute
|= HII_DISPLAY_GRAYOUT
;
412 if ((Statement
->ValueExpression
!= NULL
) || ((Statement
->QuestionFlags
& EFI_IFR_FLAG_READ_ONLY
) != 0)) {
413 DisplayStatement
->Attribute
|= HII_DISPLAY_READONLY
;
417 // Initilize the option list in statement.
419 Link
= GetFirstNode (&Statement
->OptionListHead
);
420 while (!IsNull (&Statement
->OptionListHead
, Link
)) {
421 Option
= QUESTION_OPTION_FROM_LINK (Link
);
422 Link
= GetNextNode (&Statement
->OptionListHead
, Link
);
423 if ((Option
->SuppressExpression
!= NULL
) &&
424 ((EvaluateExpressionList(Option
->SuppressExpression
, FALSE
, NULL
, NULL
) == ExpressSuppress
))) {
428 DisplayOption
= AllocateZeroPool (sizeof (DISPLAY_QUESTION_OPTION
));
429 ASSERT (DisplayOption
!= NULL
);
431 DisplayOption
->ImageId
= Option
->ImageId
;
432 DisplayOption
->Signature
= DISPLAY_QUESTION_OPTION_SIGNATURE
;
433 DisplayOption
->OptionOpCode
= Option
->OpCode
;
434 InsertTailList(&DisplayStatement
->OptionListHead
, &DisplayOption
->Link
);
437 CopyMem (&DisplayStatement
->CurrentValue
, &Statement
->HiiValue
, sizeof (EFI_HII_VALUE
));
440 // Some special op code need an extra buffer to save the data.
441 // Such as string, password, orderedlist...
443 if (Statement
->BufferValue
!= NULL
) {
445 // Ordered list opcode may not initilized, get default value here.
447 if (Statement
->OpCode
->OpCode
== EFI_IFR_ORDERED_LIST_OP
&& GetArrayData (Statement
->BufferValue
, Statement
->ValueType
, 0) == 0) {
448 GetQuestionDefault (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Statement
, 0);
451 DisplayStatement
->CurrentValue
.Buffer
= AllocateCopyPool(Statement
->StorageWidth
,Statement
->BufferValue
);
452 DisplayStatement
->CurrentValue
.BufferLen
= Statement
->StorageWidth
;
455 DisplayStatement
->SettingChangedFlag
= Statement
->ValueChanged
;
458 // Get the highlight statement for current form.
460 if (((gCurrentSelection
->QuestionId
!= 0) && (Statement
->QuestionId
== gCurrentSelection
->QuestionId
)) ||
461 ((mCurFakeQestId
!= 0) && (Statement
->FakeQuestionId
== mCurFakeQestId
))) {
462 gDisplayFormData
.HighLightedStatement
= DisplayStatement
;
466 // Create the refresh event process function.
468 if (!CompareGuid (&Statement
->RefreshGuid
, &gZeroGuid
)) {
469 CreateRefreshEvent (Statement
);
473 // For RTC type of date/time, set default refresh interval to be 1 second.
475 if ((Statement
->Operand
== EFI_IFR_DATE_OP
|| Statement
->Operand
== EFI_IFR_TIME_OP
) && Statement
->Storage
== NULL
) {
476 Statement
->RefreshInterval
= 1;
480 // Create the refresh guid hook event.
481 // If the statement in this form has refresh event or refresh interval, browser will create this event for display engine.
483 if ((!CompareGuid (&Statement
->RefreshGuid
, &gZeroGuid
)) || (Statement
->RefreshInterval
!= 0)) {
484 gDisplayFormData
.FormRefreshEvent
= mValueChangedEvent
;
488 // Save the password check function for later use.
490 if (Statement
->Operand
== EFI_IFR_PASSWORD_OP
) {
491 DisplayStatement
->PasswordCheck
= PasswordCheck
;
495 // Save the validate check question for later use.
497 if (!IsListEmpty (&Statement
->InconsistentListHead
) || !IsListEmpty (&Statement
->WarningListHead
)) {
498 DisplayStatement
->ValidateQuestion
= QuestionCheck
;
502 // If this statement is nest in the subtitle, insert to the host statement.
503 // else insert to the form it belongs to.
505 if (Statement
->InSubtitle
) {
506 InsertTailList(&HostDisplayStatement
->NestStatementList
, &DisplayStatement
->DisplayLink
);
508 InsertTailList(&gDisplayFormData
.StatementListHead
, &DisplayStatement
->DisplayLink
);
513 Process for the refresh interval statement.
515 @param Event The Event need to be process
516 @param Context The context of the event.
521 RefreshIntervalProcess (
526 FORM_BROWSER_STATEMENT
*Statement
;
529 Link
= GetFirstNode (&gCurrentSelection
->Form
->StatementListHead
);
530 while (!IsNull (&gCurrentSelection
->Form
->StatementListHead
, Link
)) {
531 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
532 Link
= GetNextNode (&gCurrentSelection
->Form
->StatementListHead
, Link
);
534 if (Statement
->RefreshInterval
== 0) {
538 UpdateStatement(Statement
);
541 gBS
->SignalEvent (mValueChangedEvent
);
546 Make a copy of the global hotkey info.
554 BROWSER_HOT_KEY
*HotKey
;
555 BROWSER_HOT_KEY
*CopyKey
;
558 Link
= GetFirstNode (&gBrowserHotKeyList
);
559 while (!IsNull (&gBrowserHotKeyList
, Link
)) {
560 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
562 CopyKey
= AllocateCopyPool(sizeof (BROWSER_HOT_KEY
), HotKey
);
563 CopyKey
->KeyData
= AllocateCopyPool(sizeof (EFI_INPUT_KEY
), HotKey
->KeyData
);
564 CopyKey
->HelpString
= AllocateCopyPool(StrSize (HotKey
->HelpString
), HotKey
->HelpString
);
566 InsertTailList(&gDisplayFormData
.HotKeyListHead
, &CopyKey
->Link
);
568 Link
= GetNextNode (&gBrowserHotKeyList
, Link
);
574 Get the extra question attribute from override question list.
576 @param QuestionId The question id for this request question.
578 @retval The attribute for this question or NULL if not found this
579 question in the list.
583 ProcessQuestionExtraAttr (
584 IN EFI_QUESTION_ID QuestionId
588 QUESTION_ATTRIBUTE_OVERRIDE
*QuestionDesc
;
591 // Return HII_DISPLAY_NONE if input a invalid question id.
593 if (QuestionId
== 0) {
594 return HII_DISPLAY_NONE
;
597 Link
= GetFirstNode (&mPrivateData
.FormBrowserEx2
.OverrideQestListHead
);
598 while (!IsNull (&mPrivateData
.FormBrowserEx2
.OverrideQestListHead
, Link
)) {
599 QuestionDesc
= FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK (Link
);
600 Link
= GetNextNode (&mPrivateData
.FormBrowserEx2
.OverrideQestListHead
, Link
);
602 if ((QuestionDesc
->QuestionId
== QuestionId
) &&
603 (QuestionDesc
->FormId
== gCurrentSelection
->FormId
) &&
604 (QuestionDesc
->HiiHandle
== gCurrentSelection
->Handle
) &&
605 CompareGuid (&QuestionDesc
->FormSetGuid
, &gCurrentSelection
->FormSetGuid
)) {
606 return QuestionDesc
->Attribute
;
610 return HII_DISPLAY_NONE
;
615 Enum all statement in current form, find all the statement can be display and
616 add to the display form.
620 AddStatementToDisplayForm (
626 FORM_BROWSER_STATEMENT
*Statement
;
627 FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
;
628 FORM_DISPLAY_ENGINE_STATEMENT
*HostDisplayStatement
;
629 UINT8 MinRefreshInterval
;
630 EFI_EVENT RefreshIntervalEvent
;
631 FORM_BROWSER_REFRESH_EVENT_NODE
*EventNode
;
632 BOOLEAN FormEditable
;
633 UINT32 ExtraAttribute
;
635 HostDisplayStatement
= NULL
;
636 MinRefreshInterval
= 0;
637 FormEditable
= FALSE
;
640 // Process the statement outside the form, these statements are not recognized
643 Link
= GetFirstNode (&gCurrentSelection
->FormSet
->StatementListOSF
);
644 while (!IsNull (&gCurrentSelection
->FormSet
->StatementListOSF
, Link
)) {
645 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
646 Link
= GetNextNode (&gCurrentSelection
->FormSet
->StatementListOSF
, Link
);
648 DisplayStatement
= AllocateZeroPool (sizeof (FORM_DISPLAY_ENGINE_STATEMENT
));
649 ASSERT (DisplayStatement
!= NULL
);
650 DisplayStatement
->Signature
= FORM_DISPLAY_ENGINE_STATEMENT_SIGNATURE
;
651 DisplayStatement
->Version
= FORM_DISPLAY_ENGINE_STATEMENT_VERSION_1
;
652 DisplayStatement
->OpCode
= Statement
->OpCode
;
654 InitializeListHead (&DisplayStatement
->NestStatementList
);
655 InitializeListHead (&DisplayStatement
->OptionListHead
);
657 InsertTailList(&gDisplayFormData
.StatementListOSF
, &DisplayStatement
->DisplayLink
);
661 // Process the statement in this form.
663 Link
= GetFirstNode (&gCurrentSelection
->Form
->StatementListHead
);
664 while (!IsNull (&gCurrentSelection
->Form
->StatementListHead
, Link
)) {
665 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
666 Link
= GetNextNode (&gCurrentSelection
->Form
->StatementListHead
, Link
);
669 // This statement can't be show, skip it.
671 if (EvaluateExpressionList(Statement
->Expression
, FALSE
, NULL
, NULL
) > ExpressGrayOut
) {
676 // Check the extra attribute.
678 ExtraAttribute
= ProcessQuestionExtraAttr (Statement
->QuestionId
);
679 if ((ExtraAttribute
& HII_DISPLAY_SUPPRESS
) != 0) {
683 DisplayStatement
= AllocateZeroPool (sizeof (FORM_DISPLAY_ENGINE_STATEMENT
));
684 ASSERT (DisplayStatement
!= NULL
);
687 // Initialize this statement and add it to the display form.
689 InitializeDisplayStatement(DisplayStatement
, Statement
, HostDisplayStatement
);
692 // Set the extra attribute.
694 DisplayStatement
->Attribute
|= ExtraAttribute
;
697 // Save the Host statement info.
698 // Host statement may has nest statement follow it.
700 if (!Statement
->InSubtitle
) {
701 HostDisplayStatement
= DisplayStatement
;
704 if (Statement
->Storage
!= NULL
) {
709 // Get the minimal refresh interval value for later use.
711 if ((Statement
->RefreshInterval
!= 0) &&
712 (MinRefreshInterval
== 0 || Statement
->RefreshInterval
< MinRefreshInterval
)) {
713 MinRefreshInterval
= Statement
->RefreshInterval
;
718 // Create the periodic timer for refresh interval statement.
720 if (MinRefreshInterval
!= 0) {
721 Status
= gBS
->CreateEvent (EVT_TIMER
| EVT_NOTIFY_SIGNAL
, TPL_CALLBACK
, RefreshIntervalProcess
, NULL
, &RefreshIntervalEvent
);
722 ASSERT_EFI_ERROR (Status
);
723 Status
= gBS
->SetTimer (RefreshIntervalEvent
, TimerPeriodic
, MinRefreshInterval
* ONE_SECOND
);
724 ASSERT_EFI_ERROR (Status
);
726 EventNode
= AllocateZeroPool (sizeof (FORM_BROWSER_REFRESH_EVENT_NODE
));
727 ASSERT (EventNode
!= NULL
);
728 EventNode
->RefreshEvent
= RefreshIntervalEvent
;
729 InsertTailList(&mRefreshEventList
, &EventNode
->Link
);
733 // Update hotkey list field.
735 if (gBrowserSettingScope
== SystemLevel
|| FormEditable
) {
742 Initialize the SettingChangedFlag variable in the display form.
746 UpdateDataChangedFlag (
751 FORM_BROWSER_FORMSET
*LocalFormSet
;
753 gDisplayFormData
.SettingChangedFlag
= FALSE
;
755 if (IsNvUpdateRequiredForForm (gCurrentSelection
->Form
)) {
756 gDisplayFormData
.SettingChangedFlag
= TRUE
;
761 // Base on the system level to check whether need to show the NV flag.
763 switch (gBrowserSettingScope
) {
766 // Check the maintain list to see whether there is any change.
768 Link
= GetFirstNode (&gBrowserFormSetList
);
769 while (!IsNull (&gBrowserFormSetList
, Link
)) {
770 LocalFormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
771 if (IsNvUpdateRequiredForFormSet(LocalFormSet
)) {
772 gDisplayFormData
.SettingChangedFlag
= TRUE
;
775 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
780 if (IsNvUpdateRequiredForFormSet(gCurrentSelection
->FormSet
)) {
781 gDisplayFormData
.SettingChangedFlag
= TRUE
;
793 Initialize the Display form structure data.
797 InitializeDisplayFormData (
803 gDisplayFormData
.Signature
= FORM_DISPLAY_ENGINE_FORM_SIGNATURE
;
804 gDisplayFormData
.Version
= FORM_DISPLAY_ENGINE_VERSION_1
;
805 gDisplayFormData
.ImageId
= 0;
806 gDisplayFormData
.AnimationId
= 0;
808 InitializeListHead (&gDisplayFormData
.StatementListHead
);
809 InitializeListHead (&gDisplayFormData
.StatementListOSF
);
810 InitializeListHead (&gDisplayFormData
.HotKeyListHead
);
812 Status
= gBS
->CreateEvent (
815 SetupBrowserEmptyFunction
,
819 ASSERT_EFI_ERROR (Status
);
824 Free the kotkey info saved in form data.
832 BROWSER_HOT_KEY
*HotKey
;
835 while (!IsListEmpty (&gDisplayFormData
.HotKeyListHead
)) {
836 Link
= GetFirstNode (&gDisplayFormData
.HotKeyListHead
);
837 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
839 RemoveEntryList (&HotKey
->Link
);
841 FreePool (HotKey
->KeyData
);
842 FreePool (HotKey
->HelpString
);
849 Update the Display form structure data.
853 UpdateDisplayFormData (
857 gDisplayFormData
.FormTitle
= gCurrentSelection
->Form
->FormTitle
;
858 gDisplayFormData
.FormId
= gCurrentSelection
->FormId
;
859 gDisplayFormData
.HiiHandle
= gCurrentSelection
->Handle
;
860 CopyGuid (&gDisplayFormData
.FormSetGuid
, &gCurrentSelection
->FormSetGuid
);
862 gDisplayFormData
.Attribute
= 0;
863 gDisplayFormData
.Attribute
|= gCurrentSelection
->Form
->ModalForm
? HII_DISPLAY_MODAL
: 0;
864 gDisplayFormData
.Attribute
|= gCurrentSelection
->Form
->Locked
? HII_DISPLAY_LOCK
: 0;
866 gDisplayFormData
.FormRefreshEvent
= NULL
;
867 gDisplayFormData
.HighLightedStatement
= NULL
;
869 gDisplayFormData
.BrowserStatus
= gBrowserStatus
;
870 gDisplayFormData
.ErrorString
= gErrorInfo
;
872 gBrowserStatus
= BROWSER_SUCCESS
;
875 UpdateDataChangedFlag ();
877 AddStatementToDisplayForm ();
882 Free the Display Statement structure data.
884 @param StatementList Point to the statement list which need to be free.
889 LIST_ENTRY
*StatementList
893 LIST_ENTRY
*OptionLink
;
894 FORM_DISPLAY_ENGINE_STATEMENT
*Statement
;
895 DISPLAY_QUESTION_OPTION
*Option
;
898 // Free Statements/Questions
900 while (!IsListEmpty (StatementList
)) {
901 Link
= GetFirstNode (StatementList
);
902 Statement
= FORM_DISPLAY_ENGINE_STATEMENT_FROM_LINK (Link
);
907 while (!IsListEmpty (&Statement
->OptionListHead
)) {
908 OptionLink
= GetFirstNode (&Statement
->OptionListHead
);
909 Option
= DISPLAY_QUESTION_OPTION_FROM_LINK (OptionLink
);
910 RemoveEntryList (&Option
->Link
);
915 // Free nest statement List
917 if (!IsListEmpty (&Statement
->NestStatementList
)) {
918 FreeStatementData(&Statement
->NestStatementList
);
921 RemoveEntryList (&Statement
->DisplayLink
);
922 FreePool (Statement
);
928 Free the Display form structure data.
932 FreeDisplayFormData (
936 FreeStatementData (&gDisplayFormData
.StatementListHead
);
937 FreeStatementData (&gDisplayFormData
.StatementListOSF
);
946 Get FORM_BROWSER_STATEMENT from FORM_DISPLAY_ENGINE_STATEMENT based on the OpCode info.
948 @param DisplayStatement The input FORM_DISPLAY_ENGINE_STATEMENT.
950 @retval FORM_BROWSER_STATEMENT The return FORM_BROWSER_STATEMENT info.
953 FORM_BROWSER_STATEMENT
*
954 GetBrowserStatement (
955 IN FORM_DISPLAY_ENGINE_STATEMENT
*DisplayStatement
958 FORM_BROWSER_STATEMENT
*Statement
;
961 Link
= GetFirstNode (&gCurrentSelection
->Form
->StatementListHead
);
962 while (!IsNull (&gCurrentSelection
->Form
->StatementListHead
, Link
)) {
963 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
965 if (Statement
->OpCode
== DisplayStatement
->OpCode
) {
969 Link
= GetNextNode (&gCurrentSelection
->Form
->StatementListHead
, Link
);
977 Process the action request in user input.
979 @param Action The user input action request info.
980 @param DefaultId The user input default Id info.
982 @retval EFI_SUCESSS This function always return successfully for now.
994 // This is caused by use press ESC, and it should not combine with other action type.
996 if ((Action
& BROWSER_ACTION_FORM_EXIT
) == BROWSER_ACTION_FORM_EXIT
) {
997 FindNextMenu (gCurrentSelection
, FormLevel
);
1002 // Below is normal hotkey trigged action, these action maybe combine with each other.
1004 if ((Action
& BROWSER_ACTION_DISCARD
) == BROWSER_ACTION_DISCARD
) {
1005 DiscardForm (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, gBrowserSettingScope
);
1008 if ((Action
& BROWSER_ACTION_DEFAULT
) == BROWSER_ACTION_DEFAULT
) {
1009 ExtractDefault (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, DefaultId
, gBrowserSettingScope
, GetDefaultForAll
, NULL
, FALSE
);
1012 if ((Action
& BROWSER_ACTION_SUBMIT
) == BROWSER_ACTION_SUBMIT
) {
1013 Status
= SubmitForm (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, gBrowserSettingScope
);
1014 if (EFI_ERROR (Status
)) {
1015 gBrowserStatus
= BROWSER_SUBMIT_FAIL
;
1019 if ((Action
& BROWSER_ACTION_RESET
) == BROWSER_ACTION_RESET
) {
1020 gResetRequired
= TRUE
;
1023 if ((Action
& BROWSER_ACTION_EXIT
) == BROWSER_ACTION_EXIT
) {
1025 // Form Exit without saving, Similar to ESC Key.
1026 // FormSet Exit without saving, Exit SendForm.
1027 // System Exit without saving, CallExitHandler and Exit SendForm.
1029 DiscardForm (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, gBrowserSettingScope
);
1030 if (gBrowserSettingScope
== FormLevel
|| gBrowserSettingScope
== FormSetLevel
) {
1031 FindNextMenu (gCurrentSelection
, gBrowserSettingScope
);
1032 } else if (gBrowserSettingScope
== SystemLevel
) {
1033 if (ExitHandlerFunction
!= NULL
) {
1034 ExitHandlerFunction ();
1036 gCurrentSelection
->Action
= UI_ACTION_EXIT
;
1044 Check whether the formset guid is in this Hii package list.
1046 @param HiiHandle The HiiHandle for this HII package list.
1047 @param FormSetGuid The formset guid for the request formset.
1049 @retval TRUE Find the formset guid.
1050 @retval FALSE Not found the formset guid.
1054 GetFormsetGuidFromHiiHandle (
1055 IN EFI_HII_HANDLE HiiHandle
,
1056 IN EFI_GUID
*FormSetGuid
1059 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
1063 UINT32 PackageListLength
;
1064 EFI_HII_PACKAGE_HEADER PackageHeader
;
1071 HiiPackageList
= NULL
;
1074 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, HiiHandle
, &BufferSize
, HiiPackageList
);
1075 if (Status
== EFI_BUFFER_TOO_SMALL
) {
1076 HiiPackageList
= AllocatePool (BufferSize
);
1077 ASSERT (HiiPackageList
!= NULL
);
1079 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, HiiHandle
, &BufferSize
, HiiPackageList
);
1081 if (EFI_ERROR (Status
) || HiiPackageList
== NULL
) {
1086 // Get Form package from this HII package List
1088 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
1090 CopyMem (&PackageListLength
, &HiiPackageList
->PackageLength
, sizeof (UINT32
));
1092 while (Offset
< PackageListLength
) {
1093 Package
= ((UINT8
*) HiiPackageList
) + Offset
;
1094 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
1095 Offset
+= PackageHeader
.Length
;
1097 if (PackageHeader
.Type
== EFI_HII_PACKAGE_FORMS
) {
1099 // Search FormSet in this Form Package
1101 Offset2
= sizeof (EFI_HII_PACKAGE_HEADER
);
1102 while (Offset2
< PackageHeader
.Length
) {
1103 OpCodeData
= Package
+ Offset2
;
1105 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
== EFI_IFR_FORM_SET_OP
) {
1106 if (CompareGuid (FormSetGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))){
1112 Offset2
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
1120 FreePool (HiiPackageList
);
1126 Find HII Handle in the HII database associated with given Device Path.
1128 If DevicePath is NULL, then ASSERT.
1130 @param DevicePath Device Path associated with the HII package list
1132 @param FormsetGuid The formset guid for this formset.
1134 @retval Handle HII package list Handle associated with the Device
1136 @retval NULL Hii Package list handle is not found.
1140 DevicePathToHiiHandle (
1141 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
1142 IN EFI_GUID
*FormsetGuid
1146 EFI_DEVICE_PATH_PROTOCOL
*TmpDevicePath
;
1149 EFI_HANDLE DriverHandle
;
1150 EFI_HII_HANDLE
*HiiHandles
;
1151 EFI_HII_HANDLE HiiHandle
;
1153 ASSERT (DevicePath
!= NULL
);
1155 TmpDevicePath
= DevicePath
;
1157 // Locate Device Path Protocol handle buffer
1159 Status
= gBS
->LocateDevicePath (
1160 &gEfiDevicePathProtocolGuid
,
1164 if (EFI_ERROR (Status
) || !IsDevicePathEnd (TmpDevicePath
)) {
1169 // Retrieve all HII Handles from HII database
1171 HiiHandles
= HiiGetHiiHandles (NULL
);
1172 if (HiiHandles
== NULL
) {
1177 // Search Hii Handle by Driver Handle
1180 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
1181 Status
= mHiiDatabase
->GetPackageListHandle (
1186 if (!EFI_ERROR (Status
) && (Handle
== DriverHandle
)) {
1187 if (GetFormsetGuidFromHiiHandle(HiiHandles
[Index
], FormsetGuid
)) {
1188 HiiHandle
= HiiHandles
[Index
];
1192 if (HiiHandle
!= NULL
) {
1198 FreePool (HiiHandles
);
1203 Find HII Handle in the HII database associated with given form set guid.
1205 If FormSetGuid is NULL, then ASSERT.
1207 @param ComparingGuid FormSet Guid associated with the HII package list
1210 @retval Handle HII package list Handle associated with the Device
1212 @retval NULL Hii Package list handle is not found.
1216 FormSetGuidToHiiHandle (
1217 EFI_GUID
*ComparingGuid
1220 EFI_HII_HANDLE
*HiiHandles
;
1221 EFI_HII_HANDLE HiiHandle
;
1224 ASSERT (ComparingGuid
!= NULL
);
1228 // Get all the Hii handles
1230 HiiHandles
= HiiGetHiiHandles (NULL
);
1231 ASSERT (HiiHandles
!= NULL
);
1234 // Search for formset of each class type
1236 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
1237 if (GetFormsetGuidFromHiiHandle(HiiHandles
[Index
], ComparingGuid
)) {
1238 HiiHandle
= HiiHandles
[Index
];
1242 if (HiiHandle
!= NULL
) {
1247 FreePool (HiiHandles
);
1253 check how to process the changed data in current form or form set.
1255 @param Selection On input, Selection tell setup browser the information
1256 about the Selection, form and formset to be displayed.
1257 On output, Selection return the screen item that is selected
1260 @param Scope Data save or discard scope, form or formset.
1262 @retval TRUE Success process the changed data, will return to the parent form.
1263 @retval FALSE Reject to process the changed data, will stay at current form.
1266 ProcessChangedData (
1267 IN OUT UI_MENU_SELECTION
*Selection
,
1268 IN BROWSER_SETTING_SCOPE Scope
1274 switch (mFormDisplay
->ConfirmDataChange()) {
1275 case BROWSER_ACTION_DISCARD
:
1276 DiscardForm (Selection
->FormSet
, Selection
->Form
, Scope
);
1279 case BROWSER_ACTION_SUBMIT
:
1280 SubmitForm (Selection
->FormSet
, Selection
->Form
, Scope
);
1283 case BROWSER_ACTION_NONE
:
1289 // if Invalid value return, process same as BROWSER_ACTION_NONE.
1299 Find parent formset menu(the first menu which has different formset) for current menu.
1300 If not find, just return to the first menu.
1302 @param Selection The selection info.
1307 IN OUT UI_MENU_SELECTION
*Selection
1310 FORM_ENTRY_INFO
*CurrentMenu
;
1311 FORM_ENTRY_INFO
*ParentMenu
;
1313 CurrentMenu
= Selection
->CurrentMenu
;
1314 ParentMenu
= UiFindParentMenu(CurrentMenu
);
1317 // Find a menu which has different formset guid with current.
1319 while (ParentMenu
!= NULL
&& CompareGuid (&CurrentMenu
->FormSetGuid
, &ParentMenu
->FormSetGuid
)) {
1320 CurrentMenu
= ParentMenu
;
1321 ParentMenu
= UiFindParentMenu(CurrentMenu
);
1324 if (ParentMenu
!= NULL
) {
1325 CopyMem (&Selection
->FormSetGuid
, &ParentMenu
->FormSetGuid
, sizeof (EFI_GUID
));
1326 Selection
->Handle
= ParentMenu
->HiiHandle
;
1327 Selection
->FormId
= ParentMenu
->FormId
;
1328 Selection
->QuestionId
= ParentMenu
->QuestionId
;
1330 Selection
->FormId
= CurrentMenu
->FormId
;
1331 Selection
->QuestionId
= CurrentMenu
->QuestionId
;
1334 Selection
->Statement
= NULL
;
1338 Process the goto op code, update the info in the selection structure.
1340 @param Statement The statement belong to goto op code.
1341 @param Selection The selection info.
1343 @retval EFI_SUCCESS The menu process successfully.
1344 @return Other value if the process failed.
1348 IN OUT FORM_BROWSER_STATEMENT
*Statement
,
1349 IN OUT UI_MENU_SELECTION
*Selection
1353 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
1354 FORM_BROWSER_FORM
*RefForm
;
1356 EFI_HII_HANDLE HiiHandle
;
1358 Status
= EFI_SUCCESS
;
1363 // Prepare the device path check, get the device path info first.
1365 if (Statement
->HiiValue
.Value
.ref
.DevicePath
!= 0) {
1366 StringPtr
= GetToken (Statement
->HiiValue
.Value
.ref
.DevicePath
, Selection
->FormSet
->HiiHandle
);
1370 // Check whether the device path string is a valid string.
1372 if (Statement
->HiiValue
.Value
.ref
.DevicePath
!= 0 && StringPtr
!= NULL
&& StringPtr
[0] != L
'\0') {
1373 if (Selection
->Form
->ModalForm
) {
1378 // Goto another Hii Package list
1380 if (mPathFromText
!= NULL
) {
1381 DevicePath
= mPathFromText
->ConvertTextToDevicePath(StringPtr
);
1382 if (DevicePath
!= NULL
) {
1383 HiiHandle
= DevicePathToHiiHandle (DevicePath
, &Statement
->HiiValue
.Value
.ref
.FormSetGuid
);
1384 FreePool (DevicePath
);
1386 FreePool (StringPtr
);
1389 // Not found the EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL protocol.
1391 gBrowserStatus
= BROWSER_PROTOCOL_NOT_FOUND
;
1392 FreePool (StringPtr
);
1396 if (HiiHandle
!= Selection
->Handle
) {
1398 // Goto another Formset, check for uncommitted data
1400 if ((gBrowserSettingScope
== FormLevel
|| gBrowserSettingScope
== FormSetLevel
) &&
1401 IsNvUpdateRequiredForFormSet(Selection
->FormSet
)) {
1402 if (!ProcessChangedData(Selection
, FormSetLevel
)) {
1408 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1409 Selection
->Handle
= HiiHandle
;
1410 if (Selection
->Handle
== NULL
) {
1412 // If target Hii Handle not found, exit current formset.
1414 FindParentFormSet(Selection
);
1418 CopyMem (&Selection
->FormSetGuid
,&Statement
->HiiValue
.Value
.ref
.FormSetGuid
, sizeof (EFI_GUID
));
1419 Selection
->FormId
= Statement
->HiiValue
.Value
.ref
.FormId
;
1420 Selection
->QuestionId
= Statement
->HiiValue
.Value
.ref
.QuestionId
;
1421 } else if (!CompareGuid (&Statement
->HiiValue
.Value
.ref
.FormSetGuid
, &gZeroGuid
)) {
1422 if (Selection
->Form
->ModalForm
) {
1425 if (!CompareGuid (&Statement
->HiiValue
.Value
.ref
.FormSetGuid
, &Selection
->FormSetGuid
)) {
1427 // Goto another Formset, check for uncommitted data
1429 if ((gBrowserSettingScope
== FormLevel
|| gBrowserSettingScope
== FormSetLevel
) &&
1430 IsNvUpdateRequiredForFormSet(Selection
->FormSet
)) {
1431 if (!ProcessChangedData(Selection
, FormSetLevel
)) {
1437 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
1438 Selection
->Handle
= FormSetGuidToHiiHandle(&Statement
->HiiValue
.Value
.ref
.FormSetGuid
);
1439 if (Selection
->Handle
== NULL
) {
1441 // If target Hii Handle not found, exit current formset.
1443 FindParentFormSet(Selection
);
1447 CopyMem (&Selection
->FormSetGuid
, &Statement
->HiiValue
.Value
.ref
.FormSetGuid
, sizeof (EFI_GUID
));
1448 Selection
->FormId
= Statement
->HiiValue
.Value
.ref
.FormId
;
1449 Selection
->QuestionId
= Statement
->HiiValue
.Value
.ref
.QuestionId
;
1450 } else if (Statement
->HiiValue
.Value
.ref
.FormId
!= 0) {
1452 // Goto another Form, check for uncommitted data
1454 if (Statement
->HiiValue
.Value
.ref
.FormId
!= Selection
->FormId
) {
1455 if ((gBrowserSettingScope
== FormLevel
&& IsNvUpdateRequiredForForm(Selection
->Form
))) {
1456 if (!ProcessChangedData (Selection
, FormLevel
)) {
1462 RefForm
= IdToForm (Selection
->FormSet
, Statement
->HiiValue
.Value
.ref
.FormId
);
1463 if ((RefForm
!= NULL
) && (RefForm
->SuppressExpression
!= NULL
)) {
1464 if (EvaluateExpressionList(RefForm
->SuppressExpression
, TRUE
, Selection
->FormSet
, RefForm
) != ExpressFalse
) {
1466 // Form is suppressed.
1468 gBrowserStatus
= BROWSER_FORM_SUPPRESS
;
1473 Selection
->FormId
= Statement
->HiiValue
.Value
.ref
.FormId
;
1474 Selection
->QuestionId
= Statement
->HiiValue
.Value
.ref
.QuestionId
;
1475 } else if (Statement
->HiiValue
.Value
.ref
.QuestionId
!= 0) {
1476 Selection
->QuestionId
= Statement
->HiiValue
.Value
.ref
.QuestionId
;
1484 Process Question Config.
1486 @param Selection The UI menu selection.
1487 @param Question The Question to be peocessed.
1489 @retval EFI_SUCCESS Question Config process success.
1490 @retval Other Question Config process fail.
1494 ProcessQuestionConfig (
1495 IN UI_MENU_SELECTION
*Selection
,
1496 IN FORM_BROWSER_STATEMENT
*Question
1502 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
1504 if (Question
->QuestionConfig
== 0) {
1511 ConfigResp
= GetToken (Question
->QuestionConfig
, Selection
->FormSet
->HiiHandle
);
1512 if (ConfigResp
== NULL
) {
1513 return EFI_NOT_FOUND
;
1517 // Send config to Configuration Driver
1519 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
1520 if (ConfigAccess
== NULL
) {
1521 return EFI_UNSUPPORTED
;
1523 Status
= ConfigAccess
->RouteConfig (
1534 Process the user input data.
1536 @param UserInput The user input data.
1537 @param ChangeHighlight Whether need to change the highlight statement.
1539 @retval EFI_SUCESSS This function always return successfully for now.
1544 IN USER_INPUT
*UserInput
,
1545 IN BOOLEAN ChangeHighlight
1549 FORM_BROWSER_STATEMENT
*Statement
;
1551 Status
= EFI_SUCCESS
;
1554 // When Exit from FormDisplay function, one of the below two cases must be true.
1556 ASSERT (UserInput
->Action
!= 0 || UserInput
->SelectedStatement
!= NULL
);
1559 // Remove the last highligh question id, this id will update when show next form.
1561 gCurrentSelection
->QuestionId
= 0;
1564 // First process the Action field in USER_INPUT.
1566 if (UserInput
->Action
!= 0) {
1567 Status
= ProcessAction (UserInput
->Action
, UserInput
->DefaultId
);
1568 if (EFI_ERROR (Status
)) {
1573 // Clear the highlight info.
1575 gCurrentSelection
->Statement
= NULL
;
1577 if (UserInput
->SelectedStatement
!= NULL
) {
1578 Statement
= GetBrowserStatement(UserInput
->SelectedStatement
);
1579 ASSERT (Statement
!= NULL
);
1581 // Save the current highlight menu in the menu history data.
1582 // which will be used when later browse back to this form.
1584 gCurrentSelection
->CurrentMenu
->QuestionId
= Statement
->QuestionId
;
1586 // For statement like text, actio, it not has question id.
1587 // So use FakeQuestionId to save the question.
1589 if (gCurrentSelection
->CurrentMenu
->QuestionId
== 0) {
1590 mCurFakeQestId
= Statement
->FakeQuestionId
;
1596 Statement
= GetBrowserStatement(UserInput
->SelectedStatement
);
1597 ASSERT (Statement
!= NULL
);
1599 gCurrentSelection
->Statement
= Statement
;
1601 if (ChangeHighlight
) {
1603 // This question is the current user select one,record it and later
1604 // show it as the highlight question.
1606 gCurrentSelection
->CurrentMenu
->QuestionId
= Statement
->QuestionId
;
1608 // For statement like text, actio, it not has question id.
1609 // So use FakeQuestionId to save the question.
1611 if (gCurrentSelection
->CurrentMenu
->QuestionId
== 0) {
1612 mCurFakeQestId
= Statement
->FakeQuestionId
;
1618 switch (Statement
->Operand
) {
1619 case EFI_IFR_REF_OP
:
1620 Status
= ProcessGotoOpCode(Statement
, gCurrentSelection
);
1623 case EFI_IFR_ACTION_OP
:
1625 // Process the Config string <ConfigResp>
1627 Status
= ProcessQuestionConfig (gCurrentSelection
, Statement
);
1630 case EFI_IFR_RESET_BUTTON_OP
:
1632 // Reset Question to default value specified by DefaultId
1634 Status
= ExtractDefault (gCurrentSelection
->FormSet
, NULL
, Statement
->DefaultId
, FormSetLevel
, GetDefaultForAll
, NULL
, FALSE
);
1638 switch (Statement
->Operand
) {
1639 case EFI_IFR_STRING_OP
:
1640 DeleteString(Statement
->HiiValue
.Value
.string
, gCurrentSelection
->FormSet
->HiiHandle
);
1641 Statement
->HiiValue
.Value
.string
= UserInput
->InputValue
.Value
.string
;
1642 CopyMem (Statement
->BufferValue
, UserInput
->InputValue
.Buffer
, (UINTN
) UserInput
->InputValue
.BufferLen
);
1643 FreePool (UserInput
->InputValue
.Buffer
);
1646 case EFI_IFR_PASSWORD_OP
:
1647 if (UserInput
->InputValue
.Buffer
== NULL
) {
1649 // User not input new password, just return.
1654 DeleteString(Statement
->HiiValue
.Value
.string
, gCurrentSelection
->FormSet
->HiiHandle
);
1655 Statement
->HiiValue
.Value
.string
= UserInput
->InputValue
.Value
.string
;
1656 CopyMem (Statement
->BufferValue
, UserInput
->InputValue
.Buffer
, (UINTN
) UserInput
->InputValue
.BufferLen
);
1657 FreePool (UserInput
->InputValue
.Buffer
);
1659 // Two password match, send it to Configuration Driver
1661 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) {
1662 PasswordCheck (NULL
, UserInput
->SelectedStatement
, (CHAR16
*) Statement
->BufferValue
);
1664 // Clean the value after saved it.
1666 ZeroMem (Statement
->BufferValue
, (UINTN
) UserInput
->InputValue
.BufferLen
);
1667 HiiSetString (gCurrentSelection
->FormSet
->HiiHandle
, Statement
->HiiValue
.Value
.string
, (CHAR16
*)Statement
->BufferValue
, NULL
);
1669 SetQuestionValue (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Statement
, GetSetValueWithHiiDriver
);
1673 case EFI_IFR_ORDERED_LIST_OP
:
1674 CopyMem (Statement
->BufferValue
, UserInput
->InputValue
.Buffer
, UserInput
->InputValue
.BufferLen
);
1678 CopyMem (&Statement
->HiiValue
, &UserInput
->InputValue
, sizeof (EFI_HII_VALUE
));
1690 Display form and wait for user to select one menu option, then return it.
1692 @retval EFI_SUCESSS This function always return successfully for now.
1701 USER_INPUT UserInput
;
1702 FORM_ENTRY_INFO
*CurrentMenu
;
1703 BOOLEAN ChangeHighlight
;
1705 ZeroMem (&UserInput
, sizeof (USER_INPUT
));
1708 // Update the menu history data.
1710 CurrentMenu
= UiFindMenuList (gCurrentSelection
->Handle
, &gCurrentSelection
->FormSetGuid
, gCurrentSelection
->FormId
);
1711 if (CurrentMenu
== NULL
) {
1713 // Current menu not found, add it to the menu tree
1715 CurrentMenu
= UiAddMenuList (gCurrentSelection
->Handle
, &gCurrentSelection
->FormSetGuid
,
1716 gCurrentSelection
->FormId
, gCurrentSelection
->QuestionId
);
1717 ASSERT (CurrentMenu
!= NULL
);
1719 gCurrentSelection
->CurrentMenu
= CurrentMenu
;
1722 // Find currrent highlight statement.
1724 if (gCurrentSelection
->QuestionId
== 0) {
1726 // Highlight not specified, fetch it from cached menu
1728 gCurrentSelection
->QuestionId
= CurrentMenu
->QuestionId
;
1732 // Evaluate all the Expressions in this Form
1734 Status
= EvaluateFormExpressions (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
);
1735 if (EFI_ERROR (Status
)) {
1739 UpdateDisplayFormData ();
1742 // Three possible status maybe return.
1744 // EFI_INVALID_PARAMETER: The input dimension info is not valid.
1745 // EFI_NOT_FOUND: The input value for oneof/orderedlist opcode is not valid
1746 // and an valid value has return.
1747 // EFI_SUCCESS: Success shows form and get user input in UserInput paramenter.
1749 Status
= mFormDisplay
->FormDisplay (&gDisplayFormData
, &UserInput
);
1750 if (EFI_ERROR (Status
) && Status
!= EFI_NOT_FOUND
) {
1751 FreeDisplayFormData();
1756 // If status is EFI_SUCCESS, means user has change the highlight menu and new user input return.
1757 // in this case, browser need to change the highlight menu.
1758 // If status is EFI_NOT_FOUND, means the input DisplayFormData has error for oneof/orderedlist
1759 // opcode and new valid value has return, browser core need to adjust
1760 // value for this opcode and shows this form again.
1762 ChangeHighlight
= (Status
== EFI_SUCCESS
? TRUE
:FALSE
);
1764 Status
= ProcessUserInput (&UserInput
, ChangeHighlight
);
1766 FreeDisplayFormData();
1772 Functions which are registered to receive notification of
1773 database events have this prototype. The actual event is encoded
1774 in NotifyType. The following table describes how PackageType,
1775 PackageGuid, Handle, and Package are used for each of the
1778 @param PackageType Package type of the notification.
1780 @param PackageGuid If PackageType is
1781 EFI_HII_PACKAGE_TYPE_GUID, then this is
1782 the pointer to the GUID from the Guid
1783 field of EFI_HII_PACKAGE_GUID_HEADER.
1784 Otherwise, it must be NULL.
1786 @param Package Points to the package referred to by the
1787 notification Handle The handle of the package
1788 list which contains the specified package.
1790 @param Handle The HII handle.
1792 @param NotifyType The type of change concerning the
1794 EFI_HII_DATABASE_NOTIFY_TYPE.
1800 IN UINT8 PackageType
,
1801 IN CONST EFI_GUID
*PackageGuid
,
1802 IN CONST EFI_HII_PACKAGE_HEADER
*Package
,
1803 IN EFI_HII_HANDLE Handle
,
1804 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
1807 mHiiPackageListUpdated
= TRUE
;
1813 Update the NV flag info for this form set.
1815 @param FormSet FormSet data structure.
1819 IsNvUpdateRequiredForFormSet (
1820 IN FORM_BROWSER_FORMSET
*FormSet
1824 FORM_BROWSER_FORM
*Form
;
1828 // Not finished question initialization, return FALSE.
1830 if (!FormSet
->QuestionInited
) {
1836 Link
= GetFirstNode (&FormSet
->FormListHead
);
1837 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
1838 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
1840 RetVal
= IsNvUpdateRequiredForForm(Form
);
1845 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
1852 Update the NvUpdateRequired flag for a form.
1854 @param Form Form data structure.
1858 IsNvUpdateRequiredForForm (
1859 IN FORM_BROWSER_FORM
*Form
1863 FORM_BROWSER_STATEMENT
*Statement
;
1865 Link
= GetFirstNode (&Form
->StatementListHead
);
1866 while (!IsNull (&Form
->StatementListHead
, Link
)) {
1867 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
1869 if (Statement
->ValueChanged
) {
1873 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
1880 Check whether the storage data for current form set is changed.
1882 @param FormSet FormSet data structure.
1884 @retval TRUE Data is changed.
1885 @retval FALSE Data is not changed.
1888 IsStorageDataChangedForFormSet (
1889 IN FORM_BROWSER_FORMSET
*FormSet
1893 FORMSET_STORAGE
*Storage
;
1894 BROWSER_STORAGE
*BrowserStorage
;
1895 CHAR16
*ConfigRespNew
;
1896 CHAR16
*ConfigRespOld
;
1900 ConfigRespNew
= NULL
;
1901 ConfigRespOld
= NULL
;
1904 // Request current settings from Configuration Driver
1906 Link
= GetFirstNode (&FormSet
->StorageListHead
);
1907 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
1908 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
1909 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
1911 BrowserStorage
= Storage
->BrowserStorage
;
1913 if (BrowserStorage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1917 if (Storage
->ElementCount
== 0) {
1921 StorageToConfigResp (BrowserStorage
, &ConfigRespNew
, Storage
->ConfigRequest
, TRUE
);
1922 StorageToConfigResp (BrowserStorage
, &ConfigRespOld
, Storage
->ConfigRequest
, FALSE
);
1923 ASSERT (ConfigRespNew
!= NULL
&& ConfigRespOld
!= NULL
);
1925 if (StrCmp (ConfigRespNew
, ConfigRespOld
) != 0) {
1929 FreePool (ConfigRespNew
);
1930 ConfigRespNew
= NULL
;
1932 FreePool (ConfigRespOld
);
1933 ConfigRespOld
= NULL
;
1944 Find menu which will show next time.
1946 @param Selection On input, Selection tell setup browser the information
1947 about the Selection, form and formset to be displayed.
1948 On output, Selection return the screen item that is selected
1950 @param SettingLevel Input Settting level, if it is FormLevel, just exit current form.
1951 else, we need to exit current formset.
1953 @retval TRUE Exit current form.
1954 @retval FALSE User press ESC and keep in current form.
1958 IN OUT UI_MENU_SELECTION
*Selection
,
1959 IN BROWSER_SETTING_SCOPE SettingLevel
1962 FORM_ENTRY_INFO
*CurrentMenu
;
1963 FORM_ENTRY_INFO
*ParentMenu
;
1964 BROWSER_SETTING_SCOPE Scope
;
1966 CurrentMenu
= Selection
->CurrentMenu
;
1968 Scope
= FormSetLevel
;
1970 if (CurrentMenu
!= NULL
&& (ParentMenu
= UiFindParentMenu(CurrentMenu
)) != NULL
) {
1972 // we have a parent, so go to the parent menu
1974 if (CompareGuid (&CurrentMenu
->FormSetGuid
, &ParentMenu
->FormSetGuid
)) {
1975 if (SettingLevel
== FormSetLevel
) {
1977 // Find a menu which has different formset guid with current.
1979 while (CompareGuid (&CurrentMenu
->FormSetGuid
, &ParentMenu
->FormSetGuid
)) {
1980 CurrentMenu
= ParentMenu
;
1981 if ((ParentMenu
= UiFindParentMenu(CurrentMenu
)) == NULL
) {
1986 if (ParentMenu
!= NULL
) {
1987 Scope
= FormSetLevel
;
1993 Scope
= FormSetLevel
;
1998 // Form Level Check whether the data is changed.
2000 if ((gBrowserSettingScope
== FormLevel
&& IsNvUpdateRequiredForForm (Selection
->Form
)) ||
2001 (gBrowserSettingScope
== FormSetLevel
&& IsNvUpdateRequiredForFormSet(Selection
->FormSet
) && Scope
== FormSetLevel
)) {
2002 if (!ProcessChangedData(Selection
, Scope
)) {
2007 if (ParentMenu
!= NULL
) {
2009 // ParentMenu is found. Then, go to it.
2011 if (Scope
== FormLevel
) {
2012 Selection
->Action
= UI_ACTION_REFRESH_FORM
;
2014 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
2015 CopyMem (&Selection
->FormSetGuid
, &ParentMenu
->FormSetGuid
, sizeof (EFI_GUID
));
2016 Selection
->Handle
= ParentMenu
->HiiHandle
;
2019 Selection
->Statement
= NULL
;
2021 Selection
->FormId
= ParentMenu
->FormId
;
2022 Selection
->QuestionId
= ParentMenu
->QuestionId
;
2025 // Clear highlight record for this menu
2027 CurrentMenu
->QuestionId
= 0;
2032 // Current in root page, exit the SendForm
2034 Selection
->Action
= UI_ACTION_EXIT
;
2040 Call the call back function for the question and process the return action.
2042 @param Selection On input, Selection tell setup browser the information
2043 about the Selection, form and formset to be displayed.
2044 On output, Selection return the screen item that is selected
2046 @param FormSet The formset this question belong to.
2047 @param Form The form this question belong to.
2048 @param Question The Question which need to call.
2049 @param Action The action request.
2050 @param SkipSaveOrDiscard Whether skip save or discard action.
2052 @retval EFI_SUCCESS The call back function excutes successfully.
2053 @return Other value if the call back function failed to excute.
2056 ProcessCallBackFunction (
2057 IN OUT UI_MENU_SELECTION
*Selection
,
2058 IN FORM_BROWSER_FORMSET
*FormSet
,
2059 IN FORM_BROWSER_FORM
*Form
,
2060 IN FORM_BROWSER_STATEMENT
*Question
,
2061 IN EFI_BROWSER_ACTION Action
,
2062 IN BOOLEAN SkipSaveOrDiscard
2066 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
2067 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2068 EFI_HII_VALUE
*HiiValue
;
2069 EFI_IFR_TYPE_VALUE
*TypeValue
;
2070 FORM_BROWSER_STATEMENT
*Statement
;
2071 BOOLEAN SubmitFormIsRequired
;
2072 BOOLEAN DiscardFormIsRequired
;
2075 BROWSER_SETTING_SCOPE SettingLevel
;
2076 EFI_IFR_TYPE_VALUE BackUpValue
;
2077 UINT8
*BackUpBuffer
;
2079 ConfigAccess
= FormSet
->ConfigAccess
;
2080 SubmitFormIsRequired
= FALSE
;
2081 SettingLevel
= FormSetLevel
;
2082 DiscardFormIsRequired
= FALSE
;
2084 Status
= EFI_SUCCESS
;
2085 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
2086 BackUpBuffer
= NULL
;
2088 if (ConfigAccess
== NULL
) {
2092 Link
= GetFirstNode (&Form
->StatementListHead
);
2093 while (!IsNull (&Form
->StatementListHead
, Link
)) {
2094 Statement
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
2095 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
2098 // if Question != NULL, only process the question. Else, process all question in this form.
2100 if ((Question
!= NULL
) && (Statement
!= Question
)) {
2104 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
2109 // Check whether Statement is disabled.
2111 if (Statement
->Expression
!= NULL
) {
2112 if (EvaluateExpressionList(Statement
->Expression
, TRUE
, FormSet
, Form
) == ExpressDisable
) {
2117 HiiValue
= &Statement
->HiiValue
;
2118 TypeValue
= &HiiValue
->Value
;
2119 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
2121 // For OrderedList, passing in the value buffer to Callback()
2123 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
2127 // If EFI_BROWSER_ACTION_CHANGING type, back up the new question value.
2129 if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
2130 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
2131 BackUpBuffer
= AllocateCopyPool(Statement
->StorageWidth
+ sizeof(CHAR16
), Statement
->BufferValue
);
2133 CopyMem (&BackUpValue
, &HiiValue
->Value
, sizeof (EFI_IFR_TYPE_VALUE
));
2137 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
2138 Status
= ConfigAccess
->Callback (
2141 Statement
->QuestionId
,
2146 if (!EFI_ERROR (Status
)) {
2148 // Only for EFI_BROWSER_ACTION_CHANGED need to handle this ActionRequest.
2150 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
2151 switch (ActionRequest
) {
2152 case EFI_BROWSER_ACTION_REQUEST_RESET
:
2153 DiscardFormIsRequired
= TRUE
;
2154 gResetRequired
= TRUE
;
2158 case EFI_BROWSER_ACTION_REQUEST_SUBMIT
:
2159 SubmitFormIsRequired
= TRUE
;
2163 case EFI_BROWSER_ACTION_REQUEST_EXIT
:
2164 DiscardFormIsRequired
= TRUE
;
2168 case EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT
:
2169 SubmitFormIsRequired
= TRUE
;
2170 SettingLevel
= FormLevel
;
2174 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT
:
2175 DiscardFormIsRequired
= TRUE
;
2176 SettingLevel
= FormLevel
;
2180 case EFI_BROWSER_ACTION_REQUEST_FORM_APPLY
:
2181 SubmitFormIsRequired
= TRUE
;
2182 SettingLevel
= FormLevel
;
2185 case EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD
:
2186 DiscardFormIsRequired
= TRUE
;
2187 SettingLevel
= FormLevel
;
2196 // According the spec, return value from call back of "changing" and
2197 // "retrieve" should update to the question's temp buffer.
2199 if (Action
== EFI_BROWSER_ACTION_CHANGING
|| Action
== EFI_BROWSER_ACTION_RETRIEVE
) {
2200 SetQuestionValue(FormSet
, Form
, Statement
, GetSetValueWithEditBuffer
);
2204 // If the callback returns EFI_UNSUPPORTED for EFI_BROWSER_ACTION_CHANGING,
2205 // then the browser will use the value passed to Callback() and ignore the
2206 // value returned by Callback().
2208 if (Action
== EFI_BROWSER_ACTION_CHANGING
&& Status
== EFI_UNSUPPORTED
) {
2209 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
2210 CopyMem (Statement
->BufferValue
, BackUpBuffer
, Statement
->StorageWidth
+ sizeof(CHAR16
));
2212 CopyMem (&HiiValue
->Value
, &BackUpValue
, sizeof (EFI_IFR_TYPE_VALUE
));
2215 SetQuestionValue(FormSet
, Form
, Statement
, GetSetValueWithEditBuffer
);
2219 // According the spec, return fail from call back of "changing" and
2220 // "retrieve", should restore the question's value.
2222 if ((Action
== EFI_BROWSER_ACTION_CHANGING
&& Status
!= EFI_UNSUPPORTED
) ||
2223 Action
== EFI_BROWSER_ACTION_RETRIEVE
) {
2224 GetQuestionValue(FormSet
, Form
, Statement
, GetSetValueWithEditBuffer
);
2227 if (Status
== EFI_UNSUPPORTED
) {
2229 // If return EFI_UNSUPPORTED, also consider Hii driver suceess deal with it.
2231 Status
= EFI_SUCCESS
;
2235 if (BackUpBuffer
!= NULL
) {
2236 FreePool (BackUpBuffer
);
2240 if (SubmitFormIsRequired
&& !SkipSaveOrDiscard
) {
2241 SubmitForm (FormSet
, Form
, SettingLevel
);
2244 if (DiscardFormIsRequired
&& !SkipSaveOrDiscard
) {
2245 DiscardForm (FormSet
, Form
, SettingLevel
);
2249 FindNextMenu (Selection
, SettingLevel
);
2256 Call the retrieve type call back function for one question to get the initialize data.
2258 This function only used when in the initialize stage, because in this stage, the
2259 Selection->Form is not ready. For other case, use the ProcessCallBackFunction instead.
2261 @param ConfigAccess The config access protocol produced by the hii driver.
2262 @param Statement The Question which need to call.
2264 @retval EFI_SUCCESS The call back function excutes successfully.
2265 @return Other value if the call back function failed to excute.
2268 ProcessRetrieveForQuestion (
2269 IN EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
,
2270 IN FORM_BROWSER_STATEMENT
*Statement
2274 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
2275 EFI_HII_VALUE
*HiiValue
;
2276 EFI_IFR_TYPE_VALUE
*TypeValue
;
2278 Status
= EFI_SUCCESS
;
2279 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
2281 if ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != EFI_IFR_FLAG_CALLBACK
) {
2282 return EFI_UNSUPPORTED
;
2285 HiiValue
= &Statement
->HiiValue
;
2286 TypeValue
= &HiiValue
->Value
;
2287 if (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
) {
2289 // For OrderedList, passing in the value buffer to Callback()
2291 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Statement
->BufferValue
;
2294 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
2295 Status
= ConfigAccess
->Callback (
2297 EFI_BROWSER_ACTION_RETRIEVE
,
2298 Statement
->QuestionId
,
2307 The worker function that send the displays to the screen. On output,
2308 the selection made by user is returned.
2310 @param Selection On input, Selection tell setup browser the information
2311 about the Selection, form and formset to be displayed.
2312 On output, Selection return the screen item that is selected
2315 @retval EFI_SUCCESS The page is displayed successfully.
2316 @return Other value if the page failed to be diplayed.
2321 IN OUT UI_MENU_SELECTION
*Selection
2326 EFI_HANDLE NotifyHandle
;
2327 FORM_BROWSER_STATEMENT
*Statement
;
2328 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2330 ConfigAccess
= Selection
->FormSet
->ConfigAccess
;
2333 // Register notify for Form package update
2335 Status
= mHiiDatabase
->RegisterPackageNotify (
2337 EFI_HII_PACKAGE_FORMS
,
2340 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK
,
2343 if (EFI_ERROR (Status
)) {
2347 if ((Selection
->Handle
!= mCurrentHiiHandle
) ||
2348 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
))) {
2349 gFinishRetrieveCall
= FALSE
;
2353 // Initialize current settings of Questions in this FormSet
2355 InitializeCurrentSetting (Selection
->FormSet
);
2358 // Initilize Action field.
2360 Selection
->Action
= UI_ACTION_REFRESH_FORM
;
2363 // Clean the mCurFakeQestId value is formset refreshed.
2369 // IFR is updated, force to reparse the IFR binary
2371 if (mHiiPackageListUpdated
) {
2372 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
2373 mHiiPackageListUpdated
= FALSE
;
2378 // Initialize Selection->Form
2380 if (Selection
->FormId
== 0) {
2382 // Zero FormId indicates display the first Form in a FormSet
2384 Link
= GetFirstNode (&Selection
->FormSet
->FormListHead
);
2386 Selection
->Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2387 Selection
->FormId
= Selection
->Form
->FormId
;
2389 Selection
->Form
= IdToForm (Selection
->FormSet
, Selection
->FormId
);
2392 if (Selection
->Form
== NULL
) {
2394 // No Form to display
2396 Status
= EFI_NOT_FOUND
;
2401 // Check Form is suppressed.
2403 if (Selection
->Form
->SuppressExpression
!= NULL
) {
2404 if (EvaluateExpressionList(Selection
->Form
->SuppressExpression
, TRUE
, Selection
->FormSet
, Selection
->Form
) == ExpressSuppress
) {
2406 // Form is suppressed.
2408 gBrowserStatus
= BROWSER_FORM_SUPPRESS
;
2409 Status
= EFI_NOT_FOUND
;
2415 // Before display new form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_OPEN
2416 // for each question with callback flag.
2417 // New form may be the first form, or the different form after another form close.
2419 if ((ConfigAccess
!= NULL
) &&
2420 ((Selection
->Handle
!= mCurrentHiiHandle
) ||
2421 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
2422 (Selection
->FormId
!= mCurrentFormId
))) {
2424 // Keep current form information
2426 mCurrentHiiHandle
= Selection
->Handle
;
2427 CopyGuid (&mCurrentFormSetGuid
, &Selection
->FormSetGuid
);
2428 mCurrentFormId
= Selection
->FormId
;
2430 Status
= ProcessCallBackFunction (Selection
, gCurrentSelection
->FormSet
, Selection
->Form
, NULL
, EFI_BROWSER_ACTION_FORM_OPEN
, FALSE
);
2431 if (EFI_ERROR (Status
)) {
2436 // IFR is updated during callback of open form, force to reparse the IFR binary
2438 if (mHiiPackageListUpdated
) {
2439 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
2440 mHiiPackageListUpdated
= FALSE
;
2446 // Load Questions' Value for display
2448 Status
= LoadFormSetConfig (Selection
, Selection
->FormSet
);
2449 if (EFI_ERROR (Status
)) {
2454 // Finish call RETRIEVE callback for this formset.
2456 gFinishRetrieveCall
= TRUE
;
2459 // IFR is updated during callback of read value, force to reparse the IFR binary
2461 if (mHiiPackageListUpdated
) {
2462 Selection
->Action
= UI_ACTION_REFRESH_FORMSET
;
2463 mHiiPackageListUpdated
= FALSE
;
2470 Status
= DisplayForm ();
2471 if (EFI_ERROR (Status
)) {
2476 // Check Selected Statement (if press ESC, Selection->Statement will be NULL)
2478 Statement
= Selection
->Statement
;
2479 if (Statement
!= NULL
) {
2480 if ((ConfigAccess
!= NULL
) &&
2481 ((Statement
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) &&
2482 (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
)) {
2483 Status
= ProcessCallBackFunction(Selection
, Selection
->FormSet
, Selection
->Form
, Statement
, EFI_BROWSER_ACTION_CHANGING
, FALSE
);
2484 if (Statement
->Operand
== EFI_IFR_REF_OP
) {
2486 // Process dynamic update ref opcode.
2488 if (!EFI_ERROR (Status
)) {
2489 Status
= ProcessGotoOpCode(Statement
, Selection
);
2493 // Callback return error status or status return from process goto opcode.
2495 if (EFI_ERROR (Status
)) {
2497 // Cross reference will not be taken
2499 Selection
->FormId
= Selection
->Form
->FormId
;
2500 Selection
->QuestionId
= 0;
2504 if (!EFI_ERROR (Status
) && Statement
->Operand
!= EFI_IFR_REF_OP
) {
2505 ProcessCallBackFunction(Selection
, Selection
->FormSet
, Selection
->Form
, Statement
, EFI_BROWSER_ACTION_CHANGED
, FALSE
);
2507 } else if (Statement
->Operand
!= EFI_IFR_PASSWORD_OP
) {
2508 SetQuestionValue (gCurrentSelection
->FormSet
, gCurrentSelection
->Form
, Statement
, GetSetValueWithEditBuffer
);
2513 // Check whether Exit flag is TRUE.
2515 if (gExitRequired
) {
2516 switch (gBrowserSettingScope
) {
2518 Selection
->Action
= UI_ACTION_EXIT
;
2523 FindNextMenu (Selection
, gBrowserSettingScope
);
2530 gExitRequired
= FALSE
;
2534 // Before exit the form, invoke ConfigAccess.Callback() with EFI_BROWSER_ACTION_FORM_CLOSE
2535 // for each question with callback flag.
2537 if ((ConfigAccess
!= NULL
) &&
2538 ((Selection
->Action
== UI_ACTION_EXIT
) ||
2539 (Selection
->Handle
!= mCurrentHiiHandle
) ||
2540 (!CompareGuid (&Selection
->FormSetGuid
, &mCurrentFormSetGuid
)) ||
2541 (Selection
->FormId
!= mCurrentFormId
))) {
2543 Status
= ProcessCallBackFunction (Selection
, Selection
->FormSet
, Selection
->Form
, NULL
, EFI_BROWSER_ACTION_FORM_CLOSE
, FALSE
);
2544 if (EFI_ERROR (Status
)) {
2548 } while (Selection
->Action
== UI_ACTION_REFRESH_FORM
);
2552 // Reset current form information to the initial setting when error happens or form exit.
2554 if (EFI_ERROR (Status
) || Selection
->Action
== UI_ACTION_EXIT
) {
2555 mCurrentHiiHandle
= NULL
;
2556 CopyGuid (&mCurrentFormSetGuid
, &gZeroGuid
);
2561 // Unregister notify for Form package update
2563 mHiiDatabase
->UnregisterPackageNotify (