2 Entry and initialization module for the browser.
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.
17 SETUP_DRIVER_PRIVATE_DATA mPrivateData
= {
18 SETUP_DRIVER_SIGNATURE
,
31 BROWSER_EXTENSION2_VERSION_1
,
35 IsBrowserDataModified
,
40 EFI_HII_DATABASE_PROTOCOL
*mHiiDatabase
;
41 EFI_HII_CONFIG_ROUTING_PROTOCOL
*mHiiConfigRouting
;
42 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL
*mPathFromText
;
43 EDKII_FORM_DISPLAY_ENGINE_PROTOCOL
*mFormDisplay
;
45 UINTN gBrowserContextCount
= 0;
46 LIST_ENTRY gBrowserContextList
= INITIALIZE_LIST_HEAD_VARIABLE (gBrowserContextList
);
47 LIST_ENTRY gBrowserFormSetList
= INITIALIZE_LIST_HEAD_VARIABLE (gBrowserFormSetList
);
48 LIST_ENTRY gBrowserHotKeyList
= INITIALIZE_LIST_HEAD_VARIABLE (gBrowserHotKeyList
);
49 LIST_ENTRY gBrowserStorageList
= INITIALIZE_LIST_HEAD_VARIABLE (gBrowserStorageList
);
51 BOOLEAN gFinishRetrieveCall
;
52 BOOLEAN gResetRequired
;
53 BOOLEAN gExitRequired
;
54 BROWSER_SETTING_SCOPE gBrowserSettingScope
= FormSetLevel
;
55 BOOLEAN mBrowserScopeFirstSet
= TRUE
;
56 EXIT_HANDLER ExitHandlerFunction
= NULL
;
57 FORM_BROWSER_FORMSET
*mSystemLevelFormSet
;
60 // Browser Global Strings
63 CHAR16
*mUnknownString
= L
"!";
65 EFI_GUID gZeroGuid
= {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
67 extern UINT32 gBrowserStatus
;
68 extern CHAR16
*gErrorInfo
;
69 extern EFI_GUID mCurrentFormSetGuid
;
70 extern EFI_HII_HANDLE mCurrentHiiHandle
;
71 extern UINT16 mCurrentFormId
;
72 extern FORM_DISPLAY_ENGINE_FORM gDisplayFormData
;
75 Create a menu with specified formset GUID and form ID, and add it as a child
76 of the given parent menu.
78 @param HiiHandle Hii handle related to this formset.
79 @param FormSetGuid The Formset Guid of menu to be added.
80 @param FormId The Form ID of menu to be added.
81 @param QuestionId The question id of this menu to be added.
83 @return A pointer to the newly added menu or NULL if memory is insufficient.
88 IN EFI_HII_HANDLE HiiHandle
,
89 IN EFI_GUID
*FormSetGuid
,
94 FORM_ENTRY_INFO
*MenuList
;
96 MenuList
= AllocateZeroPool (sizeof (FORM_ENTRY_INFO
));
97 if (MenuList
== NULL
) {
101 MenuList
->Signature
= FORM_ENTRY_INFO_SIGNATURE
;
103 MenuList
->HiiHandle
= HiiHandle
;
104 CopyMem (&MenuList
->FormSetGuid
, FormSetGuid
, sizeof (EFI_GUID
));
105 MenuList
->FormId
= FormId
;
106 MenuList
->QuestionId
= QuestionId
;
109 // If parent is not specified, it is the root Form of a Formset
111 InsertTailList (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
, &MenuList
->Link
);
117 Return the form id for the input hiihandle and formset.
119 @param HiiHandle HiiHandle for FormSet.
120 @param FormSetGuid The Formset GUID of the menu to search.
122 @return First form's id for this form set.
127 IN EFI_HII_HANDLE HiiHandle
,
128 IN EFI_GUID
*FormSetGuid
132 FORM_BROWSER_FORM
*Form
;
134 Link
= GetFirstNode (&gCurrentSelection
->FormSet
->FormListHead
);
135 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
141 Search Menu with given FormSetGuid and FormId in all cached menu list.
143 @param HiiHandle HiiHandle for FormSet.
144 @param FormSetGuid The Formset GUID of the menu to search.
145 @param FormId The Form ID of menu to search.
147 @return A pointer to menu found or NULL if not found.
152 IN EFI_HII_HANDLE HiiHandle
,
153 IN EFI_GUID
*FormSetGuid
,
158 FORM_ENTRY_INFO
*MenuList
;
159 FORM_ENTRY_INFO
*RetMenu
;
160 EFI_FORM_ID FirstFormId
;
164 Link
= GetFirstNode (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
);
165 while (!IsNull (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
, Link
)) {
166 MenuList
= FORM_ENTRY_INFO_FROM_LINK (Link
);
167 Link
= GetNextNode (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
, Link
);
170 // If already find the menu, free the menus behind it.
172 if (RetMenu
!= NULL
) {
173 RemoveEntryList (&MenuList
->Link
);
179 // Find the same FromSet.
181 if (MenuList
->HiiHandle
== HiiHandle
) {
182 if (CompareGuid (&MenuList
->FormSetGuid
, &gZeroGuid
)) {
184 // FormSetGuid is not specified.
187 } else if (CompareGuid (&MenuList
->FormSetGuid
, FormSetGuid
)) {
188 if (MenuList
->FormId
== FormId
) {
190 } else if (FormId
== 0 || MenuList
->FormId
== 0 ) {
191 FirstFormId
= GetFirstFormId (HiiHandle
, FormSetGuid
);
192 if ((FormId
== 0 && FirstFormId
== MenuList
->FormId
) || (MenuList
->FormId
==0 && FirstFormId
== FormId
)) {
204 Find parent menu for current menu.
206 @param CurrentMenu Current Menu
208 @retval The parent menu for current menu.
212 IN FORM_ENTRY_INFO
*CurrentMenu
215 FORM_ENTRY_INFO
*ParentMenu
;
218 if (CurrentMenu
->Link
.BackLink
!= &mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
) {
219 ParentMenu
= FORM_ENTRY_INFO_FROM_LINK (CurrentMenu
->Link
.BackLink
);
226 Free Menu list linked list.
228 @param MenuListHead One Menu list point in the menu list.
233 LIST_ENTRY
*MenuListHead
236 FORM_ENTRY_INFO
*MenuList
;
238 while (!IsListEmpty (MenuListHead
)) {
239 MenuList
= FORM_ENTRY_INFO_FROM_LINK (MenuListHead
->ForwardLink
);
240 RemoveEntryList (&MenuList
->Link
);
247 Load all hii formset to the browser.
255 FORM_BROWSER_FORMSET
*LocalFormSet
;
256 EFI_HII_HANDLE
*HiiHandles
;
260 FORM_BROWSER_FORMSET
*OldFormset
;
261 BOOLEAN OldRetrieveValue
;
263 OldFormset
= mSystemLevelFormSet
;
264 OldRetrieveValue
= gFinishRetrieveCall
;
265 gFinishRetrieveCall
= FALSE
;
268 // Get all the Hii handles
270 HiiHandles
= HiiGetHiiHandles (NULL
);
271 ASSERT (HiiHandles
!= NULL
);
274 // Search for formset of each class type
276 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
278 // Check HiiHandles[Index] does exist in global maintain list.
280 if (GetFormSetFromHiiHandle (HiiHandles
[Index
]) != NULL
) {
285 // Initilize FormSet Setting
287 LocalFormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
288 ASSERT (LocalFormSet
!= NULL
);
289 mSystemLevelFormSet
= LocalFormSet
;
291 ZeroMem (&ZeroGuid
, sizeof (ZeroGuid
));
292 Status
= InitializeFormSet (HiiHandles
[Index
], &ZeroGuid
, LocalFormSet
);
293 if (EFI_ERROR (Status
) || IsListEmpty (&LocalFormSet
->FormListHead
)) {
294 DestroyFormSet (LocalFormSet
);
297 InitializeCurrentSetting (LocalFormSet
);
300 // Initilize Questions' Value
302 Status
= LoadFormSetConfig (NULL
, LocalFormSet
);
303 if (EFI_ERROR (Status
)) {
304 DestroyFormSet (LocalFormSet
);
310 // Free resources, and restore gOldFormSet and gClassOfVfr
312 FreePool (HiiHandles
);
314 gFinishRetrieveCall
= OldRetrieveValue
;
315 mSystemLevelFormSet
= OldFormset
;
319 This is the routine which an external caller uses to direct the browser
320 where to obtain it's information.
323 @param This The Form Browser protocol instanse.
324 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
325 display a list of the formsets for the handles specified.
326 @param HandleCount The number of Handles specified in Handle.
327 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
328 field in the EFI_IFR_FORM_SET op-code for the specified
329 forms-based package. If FormSetGuid is NULL, then this
330 function will display the first found forms package.
331 @param FormId This field specifies which EFI_IFR_FORM to render as the first
332 displayable page. If this field has a value of 0x0000, then
333 the forms browser will render the specified forms in their encoded order.
334 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
336 @param ActionRequest Points to the action recommended by the form.
338 @retval EFI_SUCCESS The function completed successfully.
339 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
340 @retval EFI_NOT_FOUND No valid forms could be found to display.
346 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
347 IN EFI_HII_HANDLE
*Handles
,
348 IN UINTN HandleCount
,
349 IN EFI_GUID
*FormSetGuid
, OPTIONAL
350 IN UINT16 FormId
, OPTIONAL
351 IN CONST EFI_SCREEN_DESCRIPTOR
*ScreenDimensions
, OPTIONAL
352 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest OPTIONAL
356 UI_MENU_SELECTION
*Selection
;
358 FORM_BROWSER_FORMSET
*FormSet
;
359 FORM_ENTRY_INFO
*MenuList
;
362 // If EDKII_FORM_DISPLAY_ENGINE_PROTOCOL not found, return EFI_UNSUPPORTED.
364 if (mFormDisplay
== NULL
) {
365 return EFI_UNSUPPORTED
;
369 // Save globals used by SendForm()
371 SaveBrowserContext ();
373 gFinishRetrieveCall
= FALSE
;
374 gResetRequired
= FALSE
;
375 gExitRequired
= FALSE
;
376 Status
= EFI_SUCCESS
;
378 gDisplayFormData
.ScreenDimensions
= (EFI_SCREEN_DESCRIPTOR
*) ScreenDimensions
;
380 for (Index
= 0; Index
< HandleCount
; Index
++) {
381 Selection
= AllocateZeroPool (sizeof (UI_MENU_SELECTION
));
382 ASSERT (Selection
!= NULL
);
384 Selection
->Handle
= Handles
[Index
];
385 if (FormSetGuid
!= NULL
) {
386 CopyMem (&Selection
->FormSetGuid
, FormSetGuid
, sizeof (EFI_GUID
));
387 Selection
->FormId
= FormId
;
389 CopyMem (&Selection
->FormSetGuid
, &gEfiHiiPlatformSetupFormsetGuid
, sizeof (EFI_GUID
));
393 FormSet
= AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET
));
394 ASSERT (FormSet
!= NULL
);
397 // Initialize internal data structures of FormSet
399 Status
= InitializeFormSet (Selection
->Handle
, &Selection
->FormSetGuid
, FormSet
);
400 if (EFI_ERROR (Status
) || IsListEmpty (&FormSet
->FormListHead
)) {
401 DestroyFormSet (FormSet
);
404 Selection
->FormSet
= FormSet
;
405 mSystemLevelFormSet
= FormSet
;
408 // Display this formset
410 gCurrentSelection
= Selection
;
412 Status
= SetupBrowser (Selection
);
414 gCurrentSelection
= NULL
;
415 mSystemLevelFormSet
= NULL
;
418 // If no data is changed, don't need to save current FormSet into the maintain list.
420 if (!IsNvUpdateRequiredForFormSet (FormSet
)) {
421 CleanBrowserStorage(FormSet
);
422 RemoveEntryList (&FormSet
->Link
);
423 DestroyFormSet (FormSet
);
426 if (EFI_ERROR (Status
)) {
429 } while (Selection
->Action
== UI_ACTION_REFRESH_FORMSET
);
431 FreePool (Selection
);
435 // Still has error info, pop up a message.
437 if (gBrowserStatus
!= BROWSER_SUCCESS
) {
438 gDisplayFormData
.BrowserStatus
= gBrowserStatus
;
439 gDisplayFormData
.ErrorString
= gErrorInfo
;
441 gBrowserStatus
= BROWSER_SUCCESS
;
444 mFormDisplay
->FormDisplay (&gDisplayFormData
, NULL
);
447 if (ActionRequest
!= NULL
) {
448 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
449 if (gResetRequired
) {
450 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_RESET
;
454 mFormDisplay
->ExitDisplay();
457 // Clear the menu history data.
459 while (!IsListEmpty (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
)) {
460 MenuList
= FORM_ENTRY_INFO_FROM_LINK (mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
.ForwardLink
);
461 RemoveEntryList (&MenuList
->Link
);
466 // Restore globals used by SendForm()
468 RestoreBrowserContext ();
474 Get or set data to the storage.
476 @param ResultsDataSize The size of the buffer associatedwith ResultsData.
477 @param ResultsData A string returned from an IFR browser or
478 equivalent. The results string will have no
479 routing information in them.
480 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
481 (if RetrieveData = TRUE) data from the uncommitted
482 browser state information or set (if RetrieveData
483 = FALSE) data in the uncommitted browser state
485 @param Storage The pointer to the storage.
487 @retval EFI_SUCCESS The results have been distributed or are awaiting
493 IN OUT UINTN
*ResultsDataSize
,
494 IN OUT EFI_STRING
*ResultsData
,
495 IN BOOLEAN RetrieveData
,
496 IN BROWSER_STORAGE
*Storage
507 // Generate <ConfigResp>
509 Status
= StorageToConfigResp (Storage
, &ConfigResp
, Storage
->ConfigRequest
, TRUE
);
510 if (EFI_ERROR (Status
)) {
515 // Skip <ConfigHdr> and '&' to point to <ConfigBody> when first copy the configbody.
516 // Also need to consider add "\0" at first time.
518 StrPtr
= ConfigResp
+ StrLen (Storage
->ConfigHdr
) + 1;
519 BufferSize
= StrSize (StrPtr
);
523 // Copy the data if the input buffer is bigger enough.
525 if (*ResultsDataSize
>= BufferSize
) {
526 StrCpy (*ResultsData
, StrPtr
);
529 *ResultsDataSize
= BufferSize
;
530 FreePool (ConfigResp
);
533 // Prepare <ConfigResp>
535 TmpSize
= StrLen (*ResultsData
);
536 BufferSize
= (TmpSize
+ StrLen (Storage
->ConfigHdr
) + 2) * sizeof (CHAR16
);
537 ConfigResp
= AllocateZeroPool (BufferSize
);
538 ASSERT (ConfigResp
!= NULL
);
540 StrCpy (ConfigResp
, Storage
->ConfigHdr
);
541 StrCat (ConfigResp
, L
"&");
542 StrCat (ConfigResp
, *ResultsData
);
545 // Update Browser uncommited data
547 Status
= ConfigRespToStorage (Storage
, ConfigResp
);
548 FreePool (ConfigResp
);
549 if (EFI_ERROR (Status
)) {
558 This routine called this service in the browser to retrieve or set certain uncommitted
559 state information that resides in the open formsets.
561 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
563 @param ResultsDataSize A pointer to the size of the buffer associated
565 @param ResultsData A string returned from an IFR browser or
566 equivalent. The results string will have no
567 routing information in them.
568 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
569 (if RetrieveData = TRUE) data from the uncommitted
570 browser state information or set (if RetrieveData
571 = FALSE) data in the uncommitted browser state
573 @param VariableGuid An optional field to indicate the target variable
575 @param VariableName An optional field to indicate the target
576 human-readable variable name.
578 @retval EFI_SUCCESS The results have been distributed or are awaiting
580 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
581 contain the results data.
587 IN CONST EFI_FORM_BROWSER2_PROTOCOL
*This
,
588 IN OUT UINTN
*ResultsDataSize
,
589 IN OUT EFI_STRING ResultsData
,
590 IN BOOLEAN RetrieveData
,
591 IN CONST EFI_GUID
*VariableGuid
, OPTIONAL
592 IN CONST CHAR16
*VariableName OPTIONAL
597 BROWSER_STORAGE
*Storage
;
598 FORMSET_STORAGE
*FormsetStorage
;
602 if (ResultsDataSize
== NULL
|| ResultsData
== NULL
) {
603 return EFI_INVALID_PARAMETER
;
606 TotalSize
= *ResultsDataSize
;
609 Status
= EFI_SUCCESS
;
611 if (VariableGuid
!= NULL
) {
613 // Try to find target storage in the current formset.
615 Link
= GetFirstNode (&gBrowserStorageList
);
616 while (!IsNull (&gBrowserStorageList
, Link
)) {
617 Storage
= BROWSER_STORAGE_FROM_LINK (Link
);
618 Link
= GetNextNode (&gBrowserStorageList
, Link
);
620 // Check the current storage.
622 if (!CompareGuid (&Storage
->Guid
, (EFI_GUID
*) VariableGuid
)) {
626 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
627 Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
629 // Buffer storage require both GUID and Name
631 if (VariableName
== NULL
) {
632 return EFI_NOT_FOUND
;
635 if (StrCmp (Storage
->Name
, (CHAR16
*) VariableName
) != 0) {
640 if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
||
641 Storage
->Type
== EFI_HII_VARSTORE_BUFFER
) {
642 if (mSystemLevelFormSet
== NULL
|| mSystemLevelFormSet
->HiiHandle
== NULL
) {
643 return EFI_NOT_FOUND
;
646 if (Storage
->HiiHandle
!= mSystemLevelFormSet
->HiiHandle
) {
651 Status
= ProcessStorage (&TotalSize
, &ResultsData
, RetrieveData
, Storage
);
652 if (EFI_ERROR (Status
)) {
656 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
657 ConfigRequestAdjust (Storage
, ResultsData
, TRUE
);
661 // Different formsets may have same varstore, so here just set the flag
662 // not exit the circle.
669 return EFI_NOT_FOUND
;
673 // GUID/Name is not specified, take the first storage in FormSet
675 if (mSystemLevelFormSet
== NULL
) {
676 return EFI_NOT_READY
;
680 // Generate <ConfigResp>
682 Link
= GetFirstNode (&mSystemLevelFormSet
->StorageListHead
);
683 if (IsNull (&mSystemLevelFormSet
->StorageListHead
, Link
)) {
684 return EFI_UNSUPPORTED
;
687 FormsetStorage
= FORMSET_STORAGE_FROM_LINK (Link
);
689 Status
= ProcessStorage (&TotalSize
, &ResultsData
, RetrieveData
, FormsetStorage
->BrowserStorage
);
690 if (EFI_ERROR (Status
)) {
696 Status
= TotalSize
<= *ResultsDataSize
? EFI_SUCCESS
: EFI_BUFFER_TOO_SMALL
;
697 *ResultsDataSize
= TotalSize
;
706 Callback function for SimpleTextInEx protocol install events
708 @param Event the event that is signaled.
709 @param Context not used here.
714 FormDisplayCallback (
721 if (mFormDisplay
!= NULL
) {
725 Status
= gBS
->LocateProtocol (
726 &gEdkiiFormDisplayEngineProtocolGuid
,
728 (VOID
**) &mFormDisplay
733 Initialize Setup Browser driver.
735 @param ImageHandle The image handle.
736 @param SystemTable The system table.
738 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
739 @return Other value if failed to initialize the Setup Browser module.
745 IN EFI_HANDLE ImageHandle
,
746 IN EFI_SYSTEM_TABLE
*SystemTable
753 // Locate required Hii relative protocols
755 Status
= gBS
->LocateProtocol (
756 &gEfiHiiDatabaseProtocolGuid
,
758 (VOID
**) &mHiiDatabase
760 ASSERT_EFI_ERROR (Status
);
762 Status
= gBS
->LocateProtocol (
763 &gEfiHiiConfigRoutingProtocolGuid
,
765 (VOID
**) &mHiiConfigRouting
767 ASSERT_EFI_ERROR (Status
);
769 Status
= gBS
->LocateProtocol (
770 &gEfiDevicePathFromTextProtocolGuid
,
772 (VOID
**) &mPathFromText
776 // Install FormBrowser2 protocol
778 mPrivateData
.Handle
= NULL
;
779 Status
= gBS
->InstallProtocolInterface (
780 &mPrivateData
.Handle
,
781 &gEfiFormBrowser2ProtocolGuid
,
782 EFI_NATIVE_INTERFACE
,
783 &mPrivateData
.FormBrowser2
785 ASSERT_EFI_ERROR (Status
);
788 // Install FormBrowserEx2 protocol
790 InitializeListHead (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
);
791 InitializeListHead (&mPrivateData
.FormBrowserEx2
.OverrideQestListHead
);
792 mPrivateData
.Handle
= NULL
;
793 Status
= gBS
->InstallProtocolInterface (
794 &mPrivateData
.Handle
,
795 &gEdkiiFormBrowserEx2ProtocolGuid
,
796 EFI_NATIVE_INTERFACE
,
797 &mPrivateData
.FormBrowserEx2
799 ASSERT_EFI_ERROR (Status
);
801 Status
= gBS
->InstallProtocolInterface (
802 &mPrivateData
.Handle
,
803 &gEfiFormBrowserExProtocolGuid
,
804 EFI_NATIVE_INTERFACE
,
805 &mPrivateData
.FormBrowserEx
807 ASSERT_EFI_ERROR (Status
);
809 InitializeDisplayFormData ();
811 Status
= gBS
->LocateProtocol (
812 &gEdkiiFormDisplayEngineProtocolGuid
,
814 (VOID
**) &mFormDisplay
817 if (EFI_ERROR (Status
)) {
818 EfiCreateProtocolNotifyEvent (
819 &gEdkiiFormDisplayEngineProtocolGuid
,
832 Create a new string in HII Package List.
834 @param String The String to be added
835 @param HiiHandle The package list in the HII database to insert the
838 @return The output string.
844 IN EFI_HII_HANDLE HiiHandle
847 EFI_STRING_ID StringId
;
849 StringId
= HiiSetString (HiiHandle
, 0, String
, NULL
);
850 ASSERT (StringId
!= 0);
857 Delete a string from HII Package List.
859 @param StringId Id of the string in HII database.
860 @param HiiHandle The HII package list handle.
862 @retval EFI_SUCCESS The string was deleted successfully.
867 IN EFI_STRING_ID StringId
,
868 IN EFI_HII_HANDLE HiiHandle
873 NullChar
= CHAR_NULL
;
874 HiiSetString (HiiHandle
, StringId
, &NullChar
, NULL
);
880 Get the string based on the StringId and HII Package List Handle.
882 @param Token The String's ID.
883 @param HiiHandle The package list in the HII database to search for
884 the specified string.
886 @return The output string.
891 IN EFI_STRING_ID Token
,
892 IN EFI_HII_HANDLE HiiHandle
897 if (HiiHandle
== NULL
) {
901 String
= HiiGetString (HiiHandle
, Token
, NULL
);
902 if (String
== NULL
) {
903 String
= AllocateCopyPool (StrSize (mUnknownString
), mUnknownString
);
904 ASSERT (String
!= NULL
);
906 return (CHAR16
*) String
;
911 Allocate new memory and then copy the Unicode string Source to Destination.
913 @param Dest Location to copy string
914 @param Src String to copy
919 IN OUT CHAR16
**Dest
,
926 *Dest
= AllocateCopyPool (StrSize (Src
), Src
);
927 ASSERT (*Dest
!= NULL
);
932 Allocate new memory and concatinate Source on the end of Destination.
934 @param Dest String to added to the end of.
935 @param Src String to concatinate.
940 IN OUT CHAR16
**Dest
,
948 NewStringCpy (Dest
, Src
);
952 TmpSize
= StrSize (*Dest
);
953 NewString
= AllocateZeroPool (TmpSize
+ StrSize (Src
) - 1);
954 ASSERT (NewString
!= NULL
);
956 StrCpy (NewString
, *Dest
);
957 StrCat (NewString
, Src
);
964 Get Value for given Name from a NameValue Storage.
966 @param Storage The NameValue Storage.
967 @param Name The Name.
968 @param Value The retured Value.
969 @param GetValueFrom Where to get source value, from EditValue or Value.
971 @retval EFI_SUCCESS Value found for given Name.
972 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
977 IN BROWSER_STORAGE
*Storage
,
979 IN OUT CHAR16
**Value
,
980 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
984 NAME_VALUE_NODE
*Node
;
986 if (GetValueFrom
!= GetSetValueWithEditBuffer
&& GetValueFrom
!= GetSetValueWithBuffer
) {
987 return EFI_INVALID_PARAMETER
;
992 Link
= GetFirstNode (&Storage
->NameValueListHead
);
993 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
994 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
996 if (StrCmp (Name
, Node
->Name
) == 0) {
997 if (GetValueFrom
== GetSetValueWithEditBuffer
) {
998 NewStringCpy (Value
, Node
->EditValue
);
1000 NewStringCpy (Value
, Node
->Value
);
1005 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
1008 return EFI_NOT_FOUND
;
1013 Set Value of given Name in a NameValue Storage.
1015 @param Storage The NameValue Storage.
1016 @param Name The Name.
1017 @param Value The Value to set.
1018 @param SetValueTo Whether update editValue or Value.
1019 @param ReturnNode The node use the input name.
1021 @retval EFI_SUCCESS Value found for given Name.
1022 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
1027 IN BROWSER_STORAGE
*Storage
,
1030 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
,
1031 OUT NAME_VALUE_NODE
**ReturnNode
1035 NAME_VALUE_NODE
*Node
;
1038 if (SetValueTo
!= GetSetValueWithEditBuffer
&& SetValueTo
!= GetSetValueWithBuffer
) {
1039 return EFI_INVALID_PARAMETER
;
1042 Link
= GetFirstNode (&Storage
->NameValueListHead
);
1043 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
1044 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
1046 if (StrCmp (Name
, Node
->Name
) == 0) {
1047 if (SetValueTo
== GetSetValueWithEditBuffer
) {
1048 Buffer
= Node
->EditValue
;
1050 Buffer
= Node
->Value
;
1052 if (Buffer
!= NULL
) {
1055 Buffer
= AllocateCopyPool (StrSize (Value
), Value
);
1056 ASSERT (Buffer
!= NULL
);
1057 if (SetValueTo
== GetSetValueWithEditBuffer
) {
1058 Node
->EditValue
= Buffer
;
1060 Node
->Value
= Buffer
;
1063 if (ReturnNode
!= NULL
) {
1070 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
1073 return EFI_NOT_FOUND
;
1078 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1080 @param Storage The Storage to be conveted.
1081 @param ConfigResp The returned <ConfigResp>.
1082 @param ConfigRequest The ConfigRequest string.
1083 @param GetEditBuf Get the data from editbuffer or buffer.
1085 @retval EFI_SUCCESS Convert success.
1086 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1090 StorageToConfigResp (
1091 IN BROWSER_STORAGE
*Storage
,
1092 IN CHAR16
**ConfigResp
,
1093 IN CHAR16
*ConfigRequest
,
1094 IN BOOLEAN GetEditBuf
1098 EFI_STRING Progress
;
1100 NAME_VALUE_NODE
*Node
;
1103 Status
= EFI_SUCCESS
;
1105 switch (Storage
->Type
) {
1106 case EFI_HII_VARSTORE_BUFFER
:
1107 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
1108 SourceBuf
= GetEditBuf
? Storage
->EditBuffer
: Storage
->Buffer
;
1109 Status
= mHiiConfigRouting
->BlockToConfig (
1119 case EFI_HII_VARSTORE_NAME_VALUE
:
1121 NewStringCat (ConfigResp
, Storage
->ConfigHdr
);
1123 Link
= GetFirstNode (&Storage
->NameValueListHead
);
1124 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
1125 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
1127 if (StrStr (ConfigRequest
, Node
->Name
) != NULL
) {
1128 NewStringCat (ConfigResp
, L
"&");
1129 NewStringCat (ConfigResp
, Node
->Name
);
1130 NewStringCat (ConfigResp
, L
"=");
1132 NewStringCat (ConfigResp
, Node
->EditValue
);
1134 NewStringCat (ConfigResp
, Node
->Value
);
1137 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
1141 case EFI_HII_VARSTORE_EFI_VARIABLE
:
1143 Status
= EFI_INVALID_PARAMETER
;
1152 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1154 @param Storage The Storage to receive the settings.
1155 @param ConfigResp The <ConfigResp> to be converted.
1157 @retval EFI_SUCCESS Convert success.
1158 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1162 ConfigRespToStorage (
1163 IN BROWSER_STORAGE
*Storage
,
1164 IN CHAR16
*ConfigResp
1168 EFI_STRING Progress
;
1174 Status
= EFI_SUCCESS
;
1176 switch (Storage
->Type
) {
1177 case EFI_HII_VARSTORE_BUFFER
:
1178 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
1179 BufferSize
= Storage
->Size
;
1180 Status
= mHiiConfigRouting
->ConfigToBlock (
1183 Storage
->EditBuffer
,
1189 case EFI_HII_VARSTORE_NAME_VALUE
:
1190 StrPtr
= StrStr (ConfigResp
, L
"PATH");
1191 if (StrPtr
== NULL
) {
1194 StrPtr
= StrStr (ConfigResp
, L
"&");
1195 while (StrPtr
!= NULL
) {
1199 StrPtr
= StrPtr
+ 1;
1201 StrPtr
= StrStr (StrPtr
, L
"=");
1202 if (StrPtr
== NULL
) {
1210 StrPtr
= StrPtr
+ 1;
1212 StrPtr
= StrStr (StrPtr
, L
"&");
1213 if (StrPtr
!= NULL
) {
1216 SetValueByName (Storage
, Name
, Value
, GetSetValueWithEditBuffer
, NULL
);
1220 case EFI_HII_VARSTORE_EFI_VARIABLE
:
1222 Status
= EFI_INVALID_PARAMETER
;
1231 Get Question's current Value.
1233 @param FormSet FormSet data structure.
1234 @param Form Form data structure.
1235 @param Question Question to be initialized.
1236 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
1238 @retval EFI_SUCCESS The function completed successfully.
1243 IN FORM_BROWSER_FORMSET
*FormSet
,
1244 IN FORM_BROWSER_FORM
*Form
,
1245 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1246 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
1255 BROWSER_STORAGE
*Storage
;
1256 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1257 CHAR16
*ConfigRequest
;
1265 BOOLEAN IsBufferStorage
;
1270 Status
= EFI_SUCCESS
;
1274 if (GetValueFrom
>= GetSetValueWithMax
) {
1275 return EFI_INVALID_PARAMETER
;
1279 // Question value is provided by an Expression, evaluate it
1281 if (Question
->ValueExpression
!= NULL
) {
1282 Status
= EvaluateExpression (FormSet
, Form
, Question
->ValueExpression
);
1283 if (!EFI_ERROR (Status
)) {
1284 if (Question
->ValueExpression
->Result
.Type
== EFI_IFR_TYPE_BUFFER
) {
1285 ASSERT (Question
->HiiValue
.Type
== EFI_IFR_TYPE_BUFFER
&& Question
->HiiValue
.Buffer
!= NULL
);
1286 if (Question
->StorageWidth
> Question
->ValueExpression
->Result
.BufferLen
) {
1287 CopyMem (Question
->HiiValue
.Buffer
, Question
->ValueExpression
->Result
.Buffer
, Question
->ValueExpression
->Result
.BufferLen
);
1288 Question
->HiiValue
.BufferLen
= Question
->ValueExpression
->Result
.BufferLen
;
1290 CopyMem (Question
->HiiValue
.Buffer
, Question
->ValueExpression
->Result
.Buffer
, Question
->StorageWidth
);
1291 Question
->HiiValue
.BufferLen
= Question
->StorageWidth
;
1293 FreePool (Question
->ValueExpression
->Result
.Buffer
);
1295 Question
->HiiValue
.Type
= Question
->ValueExpression
->Result
.Type
;
1296 CopyMem (&Question
->HiiValue
.Value
, &Question
->ValueExpression
->Result
.Value
, sizeof (EFI_IFR_TYPE_VALUE
));
1302 // Get question value by read expression.
1304 if (Question
->ReadExpression
!= NULL
&& Form
->FormType
== STANDARD_MAP_FORM_TYPE
) {
1305 Status
= EvaluateExpression (FormSet
, Form
, Question
->ReadExpression
);
1306 if (!EFI_ERROR (Status
) &&
1307 ((Question
->ReadExpression
->Result
.Type
< EFI_IFR_TYPE_OTHER
) || (Question
->ReadExpression
->Result
.Type
== EFI_IFR_TYPE_BUFFER
))) {
1309 // Only update question value to the valid result.
1311 if (Question
->ReadExpression
->Result
.Type
== EFI_IFR_TYPE_BUFFER
) {
1312 ASSERT (Question
->HiiValue
.Type
== EFI_IFR_TYPE_BUFFER
&& Question
->HiiValue
.Buffer
!= NULL
);
1313 if (Question
->StorageWidth
> Question
->ReadExpression
->Result
.BufferLen
) {
1314 CopyMem (Question
->HiiValue
.Buffer
, Question
->ReadExpression
->Result
.Buffer
, Question
->ReadExpression
->Result
.BufferLen
);
1315 Question
->HiiValue
.BufferLen
= Question
->ReadExpression
->Result
.BufferLen
;
1317 CopyMem (Question
->HiiValue
.Buffer
, Question
->ReadExpression
->Result
.Buffer
, Question
->StorageWidth
);
1318 Question
->HiiValue
.BufferLen
= Question
->StorageWidth
;
1320 FreePool (Question
->ReadExpression
->Result
.Buffer
);
1322 Question
->HiiValue
.Type
= Question
->ReadExpression
->Result
.Type
;
1323 CopyMem (&Question
->HiiValue
.Value
, &Question
->ReadExpression
->Result
.Value
, sizeof (EFI_IFR_TYPE_VALUE
));
1329 // Question value is provided by RTC
1331 Storage
= Question
->Storage
;
1332 QuestionValue
= &Question
->HiiValue
.Value
;
1333 if (Storage
== NULL
) {
1335 // It's a Question without storage, or RTC date/time
1337 if (Question
->Operand
== EFI_IFR_DATE_OP
|| Question
->Operand
== EFI_IFR_TIME_OP
) {
1339 // Date and time define the same Flags bit
1341 switch (Question
->Flags
& EFI_QF_DATE_STORAGE
) {
1342 case QF_DATE_STORAGE_TIME
:
1343 Status
= gRT
->GetTime (&EfiTime
, NULL
);
1346 case QF_DATE_STORAGE_WAKEUP
:
1347 Status
= gRT
->GetWakeupTime (&Enabled
, &Pending
, &EfiTime
);
1350 case QF_DATE_STORAGE_NORMAL
:
1353 // For date/time without storage
1358 if (EFI_ERROR (Status
)) {
1362 if (Question
->Operand
== EFI_IFR_DATE_OP
) {
1363 QuestionValue
->date
.Year
= EfiTime
.Year
;
1364 QuestionValue
->date
.Month
= EfiTime
.Month
;
1365 QuestionValue
->date
.Day
= EfiTime
.Day
;
1367 QuestionValue
->time
.Hour
= EfiTime
.Hour
;
1368 QuestionValue
->time
.Minute
= EfiTime
.Minute
;
1369 QuestionValue
->time
.Second
= EfiTime
.Second
;
1377 // Question value is provided by EFI variable
1379 StorageWidth
= Question
->StorageWidth
;
1380 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1381 if (Question
->BufferValue
!= NULL
) {
1382 Dst
= Question
->BufferValue
;
1384 Dst
= (UINT8
*) QuestionValue
;
1387 Status
= gRT
->GetVariable (
1388 Question
->VariableName
,
1395 // Always return success, even this EFI variable doesn't exist
1401 // Question Value is provided by Buffer Storage or NameValue Storage
1403 if (Question
->BufferValue
!= NULL
) {
1405 // This Question is password or orderedlist
1407 Dst
= Question
->BufferValue
;
1410 // Other type of Questions
1412 Dst
= (UINT8
*) &Question
->HiiValue
.Value
;
1415 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
1416 Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
1417 IsBufferStorage
= TRUE
;
1419 IsBufferStorage
= FALSE
;
1421 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
1422 if (GetValueFrom
== GetSetValueWithEditBuffer
|| GetValueFrom
== GetSetValueWithBuffer
) {
1423 if (IsBufferStorage
) {
1424 if (GetValueFrom
== GetSetValueWithEditBuffer
) {
1426 // Copy from storage Edit buffer
1428 CopyMem (Dst
, Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, StorageWidth
);
1431 // Copy from storage Edit buffer
1433 CopyMem (Dst
, Storage
->Buffer
+ Question
->VarStoreInfo
.VarOffset
, StorageWidth
);
1437 Status
= GetValueByName (Storage
, Question
->VariableName
, &Value
, GetValueFrom
);
1438 if (EFI_ERROR (Status
)) {
1442 ASSERT (Value
!= NULL
);
1443 LengthStr
= StrLen (Value
);
1444 Status
= EFI_SUCCESS
;
1447 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1448 // Add string tail char L'\0' into Length
1450 Length
= StorageWidth
+ sizeof (CHAR16
);
1451 if (Length
< ((LengthStr
/ 4 + 1) * 2)) {
1452 Status
= EFI_BUFFER_TOO_SMALL
;
1454 StringPtr
= (CHAR16
*) Dst
;
1455 ZeroMem (TemStr
, sizeof (TemStr
));
1456 for (Index
= 0; Index
< LengthStr
; Index
+= 4) {
1457 StrnCpy (TemStr
, Value
+ Index
, 4);
1458 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
1461 // Add tailing L'\0' character
1463 StringPtr
[Index
/4] = L
'\0';
1466 if (StorageWidth
< ((LengthStr
+ 1) / 2)) {
1467 Status
= EFI_BUFFER_TOO_SMALL
;
1469 ZeroMem (TemStr
, sizeof (TemStr
));
1470 for (Index
= 0; Index
< LengthStr
; Index
++) {
1471 TemStr
[0] = Value
[LengthStr
- Index
- 1];
1472 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1473 if ((Index
& 1) == 0) {
1474 Dst
[Index
/2] = DigitUint8
;
1476 Dst
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Dst
[Index
/2]);
1486 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
1487 // <ConfigHdr> + "&" + <VariableName>
1489 if (IsBufferStorage
) {
1490 Length
= StrLen (Storage
->ConfigHdr
);
1491 Length
+= StrLen (Question
->BlockName
);
1493 Length
= StrLen (Storage
->ConfigHdr
);
1494 Length
+= StrLen (Question
->VariableName
) + 1;
1496 ConfigRequest
= AllocateZeroPool ((Length
+ 1) * sizeof (CHAR16
));
1497 ASSERT (ConfigRequest
!= NULL
);
1499 StrCpy (ConfigRequest
, Storage
->ConfigHdr
);
1500 if (IsBufferStorage
) {
1501 StrCat (ConfigRequest
, Question
->BlockName
);
1503 StrCat (ConfigRequest
, L
"&");
1504 StrCat (ConfigRequest
, Question
->VariableName
);
1508 // Request current settings from Configuration Driver
1510 Status
= mHiiConfigRouting
->ExtractConfig (
1516 FreePool (ConfigRequest
);
1517 if (EFI_ERROR (Status
)) {
1522 // Skip <ConfigRequest>
1524 if (IsBufferStorage
) {
1525 Value
= StrStr (Result
, L
"&VALUE");
1526 if (Value
== NULL
) {
1528 return EFI_NOT_FOUND
;
1535 Value
= Result
+ Length
;
1537 if (*Value
!= '=') {
1539 return EFI_NOT_FOUND
;
1542 // Skip '=', point to value
1547 // Suppress <AltResp> if any
1550 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
1555 LengthStr
= StrLen (Value
);
1556 Status
= EFI_SUCCESS
;
1557 if (!IsBufferStorage
&& IsString
) {
1559 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1560 // Add string tail char L'\0' into Length
1562 Length
= StorageWidth
+ sizeof (CHAR16
);
1563 if (Length
< ((LengthStr
/ 4 + 1) * 2)) {
1564 Status
= EFI_BUFFER_TOO_SMALL
;
1566 StringPtr
= (CHAR16
*) Dst
;
1567 ZeroMem (TemStr
, sizeof (TemStr
));
1568 for (Index
= 0; Index
< LengthStr
; Index
+= 4) {
1569 StrnCpy (TemStr
, Value
+ Index
, 4);
1570 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
1573 // Add tailing L'\0' character
1575 StringPtr
[Index
/4] = L
'\0';
1578 if (StorageWidth
< ((LengthStr
+ 1) / 2)) {
1579 Status
= EFI_BUFFER_TOO_SMALL
;
1581 ZeroMem (TemStr
, sizeof (TemStr
));
1582 for (Index
= 0; Index
< LengthStr
; Index
++) {
1583 TemStr
[0] = Value
[LengthStr
- Index
- 1];
1584 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
1585 if ((Index
& 1) == 0) {
1586 Dst
[Index
/2] = DigitUint8
;
1588 Dst
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Dst
[Index
/2]);
1594 if (EFI_ERROR (Status
)) {
1600 // Synchronize Edit Buffer
1602 if (IsBufferStorage
) {
1603 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Dst
, StorageWidth
);
1605 SetValueByName (Storage
, Question
->VariableName
, Value
, GetSetValueWithEditBuffer
, NULL
);
1608 if (Result
!= NULL
) {
1618 Save Question Value to edit copy(cached) or Storage(uncached).
1620 @param FormSet FormSet data structure.
1621 @param Form Form data structure.
1622 @param Question Pointer to the Question.
1623 @param SetValueTo Update the question value to editbuffer , buffer or hii driver.
1625 @retval EFI_SUCCESS The function completed successfully.
1630 IN FORM_BROWSER_FORMSET
*FormSet
,
1631 IN FORM_BROWSER_FORM
*Form
,
1632 IN OUT FORM_BROWSER_STATEMENT
*Question
,
1633 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
1643 BROWSER_STORAGE
*Storage
;
1644 EFI_IFR_TYPE_VALUE
*QuestionValue
;
1649 BOOLEAN IsBufferStorage
;
1655 NAME_VALUE_NODE
*Node
;
1657 Status
= EFI_SUCCESS
;
1660 if (SetValueTo
>= GetSetValueWithMax
) {
1661 return EFI_INVALID_PARAMETER
;
1665 // If Question value is provided by an Expression, then it is read only
1667 if (Question
->ValueExpression
!= NULL
) {
1672 // Before set question value, evaluate its write expression.
1674 if (Question
->WriteExpression
!= NULL
&& Form
->FormType
== STANDARD_MAP_FORM_TYPE
) {
1675 Status
= EvaluateExpression (FormSet
, Form
, Question
->WriteExpression
);
1676 if (EFI_ERROR (Status
)) {
1682 // Question value is provided by RTC
1684 Storage
= Question
->Storage
;
1685 QuestionValue
= &Question
->HiiValue
.Value
;
1686 if (Storage
== NULL
) {
1688 // It's a Question without storage, or RTC date/time
1690 if (Question
->Operand
== EFI_IFR_DATE_OP
|| Question
->Operand
== EFI_IFR_TIME_OP
) {
1692 // Date and time define the same Flags bit
1694 switch (Question
->Flags
& EFI_QF_DATE_STORAGE
) {
1695 case QF_DATE_STORAGE_TIME
:
1696 Status
= gRT
->GetTime (&EfiTime
, NULL
);
1699 case QF_DATE_STORAGE_WAKEUP
:
1700 Status
= gRT
->GetWakeupTime (&Enabled
, &Pending
, &EfiTime
);
1703 case QF_DATE_STORAGE_NORMAL
:
1706 // For date/time without storage
1711 if (EFI_ERROR (Status
)) {
1715 if (Question
->Operand
== EFI_IFR_DATE_OP
) {
1716 EfiTime
.Year
= QuestionValue
->date
.Year
;
1717 EfiTime
.Month
= QuestionValue
->date
.Month
;
1718 EfiTime
.Day
= QuestionValue
->date
.Day
;
1720 EfiTime
.Hour
= QuestionValue
->time
.Hour
;
1721 EfiTime
.Minute
= QuestionValue
->time
.Minute
;
1722 EfiTime
.Second
= QuestionValue
->time
.Second
;
1725 if ((Question
->Flags
& EFI_QF_DATE_STORAGE
) == QF_DATE_STORAGE_TIME
) {
1726 Status
= gRT
->SetTime (&EfiTime
);
1728 Status
= gRT
->SetWakeupTime (TRUE
, &EfiTime
);
1736 // Question value is provided by EFI variable
1738 StorageWidth
= Question
->StorageWidth
;
1739 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
1740 if (Question
->BufferValue
!= NULL
) {
1741 Src
= Question
->BufferValue
;
1743 Src
= (UINT8
*) QuestionValue
;
1746 Status
= gRT
->SetVariable (
1747 Question
->VariableName
,
1749 Storage
->Attributes
,
1757 // Question Value is provided by Buffer Storage or NameValue Storage
1759 if (Question
->BufferValue
!= NULL
) {
1760 Src
= Question
->BufferValue
;
1762 Src
= (UINT8
*) &Question
->HiiValue
.Value
;
1765 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
1766 Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
1767 IsBufferStorage
= TRUE
;
1769 IsBufferStorage
= FALSE
;
1771 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
1773 if (SetValueTo
== GetSetValueWithEditBuffer
|| SetValueTo
== GetSetValueWithBuffer
) {
1774 if (IsBufferStorage
) {
1775 if (SetValueTo
== GetSetValueWithEditBuffer
) {
1777 // Copy to storage edit buffer
1779 CopyMem (Storage
->EditBuffer
+ Question
->VarStoreInfo
.VarOffset
, Src
, StorageWidth
);
1780 } else if (SetValueTo
== GetSetValueWithBuffer
) {
1782 // Copy to storage edit buffer
1784 CopyMem (Storage
->Buffer
+ Question
->VarStoreInfo
.VarOffset
, Src
, StorageWidth
);
1789 // Allocate enough string buffer.
1792 BufferLen
= ((StrLen ((CHAR16
*) Src
) * 4) + 1) * sizeof (CHAR16
);
1793 Value
= AllocateZeroPool (BufferLen
);
1794 ASSERT (Value
!= NULL
);
1796 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1798 TemName
= (CHAR16
*) Src
;
1800 for (; *TemName
!= L
'\0'; TemName
++) {
1801 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
1804 BufferLen
= StorageWidth
* 2 + 1;
1805 Value
= AllocateZeroPool (BufferLen
* sizeof (CHAR16
));
1806 ASSERT (Value
!= NULL
);
1808 // Convert Buffer to Hex String
1810 TemBuffer
= Src
+ StorageWidth
- 1;
1812 for (Index
= 0; Index
< StorageWidth
; Index
++, TemBuffer
--) {
1813 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
1817 Status
= SetValueByName (Storage
, Question
->VariableName
, Value
, SetValueTo
, &Node
);
1819 if (EFI_ERROR (Status
)) {
1823 } else if (SetValueTo
== GetSetValueWithHiiDriver
) {
1825 // <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||
1826 // <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"
1828 if (IsBufferStorage
) {
1829 Length
= StrLen (Question
->BlockName
) + 7;
1831 Length
= StrLen (Question
->VariableName
) + 2;
1833 if (!IsBufferStorage
&& IsString
) {
1834 Length
+= (StrLen ((CHAR16
*) Src
) * 4);
1836 Length
+= (StorageWidth
* 2);
1838 ConfigResp
= AllocateZeroPool ((StrLen (Storage
->ConfigHdr
) + Length
+ 1) * sizeof (CHAR16
));
1839 ASSERT (ConfigResp
!= NULL
);
1841 StrCpy (ConfigResp
, Storage
->ConfigHdr
);
1842 if (IsBufferStorage
) {
1843 StrCat (ConfigResp
, Question
->BlockName
);
1844 StrCat (ConfigResp
, L
"&VALUE=");
1846 StrCat (ConfigResp
, L
"&");
1847 StrCat (ConfigResp
, Question
->VariableName
);
1848 StrCat (ConfigResp
, L
"=");
1851 Value
= ConfigResp
+ StrLen (ConfigResp
);
1853 if (!IsBufferStorage
&& IsString
) {
1855 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1857 TemName
= (CHAR16
*) Src
;
1859 for (; *TemName
!= L
'\0'; TemName
++) {
1860 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemName
, 4);
1864 // Convert Buffer to Hex String
1866 TemBuffer
= Src
+ StorageWidth
- 1;
1868 for (Index
= 0; Index
< StorageWidth
; Index
++, TemBuffer
--) {
1869 TemString
+= UnicodeValueToString (TemString
, PREFIX_ZERO
| RADIX_HEX
, *TemBuffer
, 2);
1874 // Convert to lower char.
1876 for (TemString
= Value
; *Value
!= L
'\0'; Value
++) {
1877 if (*Value
>= L
'A' && *Value
<= L
'Z') {
1878 *Value
= (CHAR16
) (*Value
- L
'A' + L
'a');
1883 // Submit Question Value to Configuration Driver
1885 Status
= mHiiConfigRouting
->RouteConfig (
1890 if (EFI_ERROR (Status
)) {
1891 FreePool (ConfigResp
);
1894 FreePool (ConfigResp
);
1897 // Sync storage, from editbuffer to buffer.
1899 CopyMem (Storage
->Buffer
+ Question
->VarStoreInfo
.VarOffset
, Src
, StorageWidth
);
1907 Perform nosubmitif check for a Form.
1909 @param FormSet FormSet data structure.
1910 @param Form Form data structure.
1911 @param Question The Question to be validated.
1912 @param Type Validation type: NoSubmit
1914 @retval EFI_SUCCESS Form validation pass.
1915 @retval other Form validation failed.
1920 IN FORM_BROWSER_FORMSET
*FormSet
,
1921 IN FORM_BROWSER_FORM
*Form
,
1922 IN FORM_BROWSER_STATEMENT
*Question
,
1928 LIST_ENTRY
*ListHead
;
1930 FORM_EXPRESSION
*Expression
;
1932 if (Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
) {
1933 ListHead
= &Question
->NoSubmitListHead
;
1935 return EFI_UNSUPPORTED
;
1938 Link
= GetFirstNode (ListHead
);
1939 while (!IsNull (ListHead
, Link
)) {
1940 Expression
= FORM_EXPRESSION_FROM_LINK (Link
);
1943 // Evaluate the expression
1945 Status
= EvaluateExpression (FormSet
, Form
, Expression
);
1946 if (EFI_ERROR (Status
)) {
1950 if ((Expression
->Result
.Type
== EFI_IFR_TYPE_BOOLEAN
) && Expression
->Result
.Value
.b
) {
1952 // Condition meet, show up error message
1954 if (Expression
->Error
!= 0) {
1955 PopUp
= GetToken (Expression
->Error
, FormSet
->HiiHandle
);
1956 if (Type
== EFI_HII_EXPRESSION_NO_SUBMIT_IF
) {
1957 gBrowserStatus
= BROWSER_NO_SUBMIT_IF
;
1962 return EFI_NOT_READY
;
1965 Link
= GetNextNode (ListHead
, Link
);
1973 Perform NoSubmit check for each Form in FormSet.
1975 @param FormSet FormSet data structure.
1976 @param CurrentForm Current input form data structure.
1978 @retval EFI_SUCCESS Form validation pass.
1979 @retval other Form validation failed.
1984 IN FORM_BROWSER_FORMSET
*FormSet
,
1985 IN FORM_BROWSER_FORM
*CurrentForm
1990 FORM_BROWSER_STATEMENT
*Question
;
1991 FORM_BROWSER_FORM
*Form
;
1992 LIST_ENTRY
*LinkForm
;
1994 LinkForm
= GetFirstNode (&FormSet
->FormListHead
);
1995 while (!IsNull (&FormSet
->FormListHead
, LinkForm
)) {
1996 Form
= FORM_BROWSER_FORM_FROM_LINK (LinkForm
);
1997 LinkForm
= GetNextNode (&FormSet
->FormListHead
, LinkForm
);
1999 if (CurrentForm
!= NULL
&& CurrentForm
!= Form
) {
2003 Link
= GetFirstNode (&Form
->StatementListHead
);
2004 while (!IsNull (&Form
->StatementListHead
, Link
)) {
2005 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
2007 Status
= ValidateQuestion (FormSet
, Form
, Question
, EFI_HII_EXPRESSION_NO_SUBMIT_IF
);
2008 if (EFI_ERROR (Status
)) {
2012 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
2020 Fill storage's edit copy with settings requested from Configuration Driver.
2022 @param FormSet FormSet data structure.
2023 @param Storage The storage which need to sync.
2024 @param ConfigRequest The config request string which used to sync storage.
2025 @param SyncOrRestore Sync the buffer to editbuffer or Restore the
2026 editbuffer to buffer
2027 if TRUE, copy the editbuffer to the buffer.
2028 if FALSE, copy the buffer to the editbuffer.
2030 @retval EFI_SUCCESS The function completed successfully.
2034 SynchronizeStorage (
2035 IN FORM_BROWSER_FORMSET
*FormSet
,
2036 OUT BROWSER_STORAGE
*Storage
,
2037 IN CHAR16
*ConfigRequest
,
2038 IN BOOLEAN SyncOrRestore
2042 EFI_STRING Progress
;
2046 NAME_VALUE_NODE
*Node
;
2050 Status
= EFI_SUCCESS
;
2053 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
2054 (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
2055 BufferSize
= Storage
->Size
;
2057 if (SyncOrRestore
) {
2058 Src
= Storage
->EditBuffer
;
2059 Dst
= Storage
->Buffer
;
2061 Src
= Storage
->Buffer
;
2062 Dst
= Storage
->EditBuffer
;
2065 if (ConfigRequest
!= NULL
) {
2066 Status
= mHiiConfigRouting
->BlockToConfig(
2074 if (EFI_ERROR (Status
)) {
2078 Status
= mHiiConfigRouting
->ConfigToBlock (
2085 if (Result
!= NULL
) {
2089 CopyMem (Dst
, Src
, BufferSize
);
2091 } else if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
2092 Link
= GetFirstNode (&Storage
->NameValueListHead
);
2093 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
2094 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
2096 if ((ConfigRequest
!= NULL
&& StrStr (ConfigRequest
, Node
->Name
) != NULL
) ||
2097 (ConfigRequest
== NULL
)) {
2098 if (SyncOrRestore
) {
2099 NewStringCpy (&Node
->Value
, Node
->EditValue
);
2101 NewStringCpy (&Node
->EditValue
, Node
->Value
);
2105 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
2113 When discard the question value, call the callback function with Changed type
2114 to inform the hii driver.
2116 @param FormSet FormSet data structure.
2117 @param Form Form data structure.
2121 SendDiscardInfoToDriver (
2122 IN FORM_BROWSER_FORMSET
*FormSet
,
2123 IN FORM_BROWSER_FORM
*Form
2127 FORM_BROWSER_STATEMENT
*Question
;
2128 EFI_IFR_TYPE_VALUE
*TypeValue
;
2129 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
2131 if (FormSet
->ConfigAccess
== NULL
) {
2135 Link
= GetFirstNode (&Form
->StatementListHead
);
2136 while (!IsNull (&Form
->StatementListHead
, Link
)) {
2137 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
2138 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
2140 if (Question
->Storage
== NULL
|| Question
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2144 if (Question
->Operand
== EFI_IFR_PASSWORD_OP
) {
2148 if (!Question
->ValueChanged
) {
2152 if (Question
->HiiValue
.Type
== EFI_IFR_TYPE_BUFFER
) {
2153 TypeValue
= (EFI_IFR_TYPE_VALUE
*) Question
->BufferValue
;
2155 TypeValue
= &Question
->HiiValue
.Value
;
2158 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
2159 FormSet
->ConfigAccess
->Callback (
2160 FormSet
->ConfigAccess
,
2161 EFI_BROWSER_ACTION_CHANGED
,
2162 Question
->QuestionId
,
2163 Question
->HiiValue
.Type
,
2171 Validate the FormSet. If the formset is not validate, remove it from the list.
2173 @param FormSet The input FormSet which need to validate.
2175 @retval TRUE The handle is validate.
2176 @retval FALSE The handle is invalidate.
2181 FORM_BROWSER_FORMSET
*FormSet
2184 EFI_HII_HANDLE
*HiiHandles
;
2188 ASSERT (FormSet
!= NULL
);
2191 // Get all the Hii handles
2193 HiiHandles
= HiiGetHiiHandles (NULL
);
2194 ASSERT (HiiHandles
!= NULL
);
2197 // Search for formset of each class type
2199 for (Index
= 0; HiiHandles
[Index
] != NULL
; Index
++) {
2200 if (HiiHandles
[Index
] == FormSet
->HiiHandle
) {
2207 CleanBrowserStorage(FormSet
);
2208 RemoveEntryList (&FormSet
->Link
);
2209 DestroyFormSet (FormSet
);
2212 FreePool (HiiHandles
);
2217 Check whether need to enable the reset flag in form level.
2218 Also clean all ValueChanged flag in question.
2220 @param SetFlag Whether need to set the Reset Flag.
2221 @param Form Form data structure.
2227 IN FORM_BROWSER_FORM
*Form
2231 FORM_BROWSER_STATEMENT
*Question
;
2235 Link
= GetFirstNode (&Form
->StatementListHead
);
2236 while (!IsNull (&Form
->StatementListHead
, Link
)) {
2237 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
2239 if (SetFlag
&& Question
->ValueChanged
&& ((Question
->QuestionFlags
& EFI_IFR_FLAG_RESET_REQUIRED
) != 0)) {
2240 gResetRequired
= TRUE
;
2243 if (Question
->ValueChanged
) {
2244 Question
->ValueChanged
= FALSE
;
2247 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
2252 Check whether need to enable the reset flag.
2253 Also clean ValueChanged flag for all statements.
2255 Form level or formset level, only one.
2257 @param SetFlag Whether need to set the Reset Flag.
2258 @param FormSet FormSet data structure.
2259 @param Form Form data structure.
2263 ValueChangeResetFlagUpdate (
2265 IN FORM_BROWSER_FORMSET
*FormSet
,
2266 IN FORM_BROWSER_FORM
*Form
2269 FORM_BROWSER_FORM
*CurrentForm
;
2273 // Form != NULL means only check form level.
2276 UpdateFlagForForm(SetFlag
, Form
);
2280 Link
= GetFirstNode (&FormSet
->FormListHead
);
2281 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2282 CurrentForm
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2283 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2285 UpdateFlagForForm(SetFlag
, CurrentForm
);
2290 Discard data based on the input setting scope (Form, FormSet or System).
2292 @param FormSet FormSet data structure.
2293 @param Form Form data structure.
2294 @param SettingScope Setting Scope for Discard action.
2296 @retval EFI_SUCCESS The function completed successfully.
2297 @retval EFI_UNSUPPORTED Unsupport SettingScope.
2302 IN FORM_BROWSER_FORMSET
*FormSet
,
2303 IN FORM_BROWSER_FORM
*Form
,
2304 IN BROWSER_SETTING_SCOPE SettingScope
2308 FORMSET_STORAGE
*Storage
;
2309 FORM_BROWSER_CONFIG_REQUEST
*ConfigInfo
;
2310 FORM_BROWSER_FORMSET
*LocalFormSet
;
2311 FORM_BROWSER_FORMSET
*OldFormSet
;
2314 // Check the supported setting level.
2316 if (SettingScope
>= MaxLevel
) {
2317 return EFI_UNSUPPORTED
;
2320 if (SettingScope
== FormLevel
&& IsNvUpdateRequiredForForm (Form
)) {
2322 Link
= GetFirstNode (&Form
->ConfigRequestHead
);
2323 while (!IsNull (&Form
->ConfigRequestHead
, Link
)) {
2324 ConfigInfo
= FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link
);
2325 Link
= GetNextNode (&Form
->ConfigRequestHead
, Link
);
2327 if (ConfigInfo
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2332 // Skip if there is no RequestElement
2334 if (ConfigInfo
->ElementCount
== 0) {
2339 // Prepare <ConfigResp>
2341 SynchronizeStorage(FormSet
, ConfigInfo
->Storage
, ConfigInfo
->ConfigRequest
, FALSE
);
2344 // Call callback with Changed type to inform the driver.
2346 SendDiscardInfoToDriver (FormSet
, Form
);
2349 ValueChangeResetFlagUpdate (FALSE
, NULL
, Form
);
2350 } else if (SettingScope
== FormSetLevel
&& IsNvUpdateRequiredForFormSet (FormSet
)) {
2353 // Discard Buffer storage or Name/Value storage
2355 Link
= GetFirstNode (&FormSet
->StorageListHead
);
2356 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
2357 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
2358 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
2360 if (Storage
->BrowserStorage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2365 // Skip if there is no RequestElement
2367 if (Storage
->ElementCount
== 0) {
2371 SynchronizeStorage(FormSet
, Storage
->BrowserStorage
, Storage
->ConfigRequest
, FALSE
);
2374 Link
= GetFirstNode (&FormSet
->FormListHead
);
2375 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
2376 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
2377 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
2380 // Call callback with Changed type to inform the driver.
2382 SendDiscardInfoToDriver (FormSet
, Form
);
2385 ValueChangeResetFlagUpdate(FALSE
, FormSet
, NULL
);
2386 } else if (SettingScope
== SystemLevel
) {
2388 // System Level Discard.
2390 OldFormSet
= mSystemLevelFormSet
;
2393 // Discard changed value for each FormSet in the maintain list.
2395 Link
= GetFirstNode (&gBrowserFormSetList
);
2396 while (!IsNull (&gBrowserFormSetList
, Link
)) {
2397 LocalFormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
2398 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
2399 if (!ValidateFormSet(LocalFormSet
)) {
2403 mSystemLevelFormSet
= LocalFormSet
;
2405 DiscardForm (LocalFormSet
, NULL
, FormSetLevel
);
2406 if (!IsHiiHandleInBrowserContext (LocalFormSet
->HiiHandle
)) {
2408 // Remove maintain backup list after discard except for the current using FormSet.
2410 CleanBrowserStorage(LocalFormSet
);
2411 RemoveEntryList (&LocalFormSet
->Link
);
2412 DestroyFormSet (LocalFormSet
);
2416 mSystemLevelFormSet
= OldFormSet
;
2423 Submit data based on the input Setting level (Form, FormSet or System).
2425 @param FormSet FormSet data structure.
2426 @param Form Form data structure.
2427 @param SettingScope Setting Scope for Submit action.
2429 @retval EFI_SUCCESS The function completed successfully.
2430 @retval EFI_UNSUPPORTED Unsupport SettingScope.
2435 IN FORM_BROWSER_FORMSET
*FormSet
,
2436 IN FORM_BROWSER_FORM
*Form
,
2437 IN BROWSER_SETTING_SCOPE SettingScope
2442 EFI_STRING ConfigResp
;
2443 EFI_STRING Progress
;
2444 BROWSER_STORAGE
*Storage
;
2445 FORMSET_STORAGE
*FormSetStorage
;
2446 FORM_BROWSER_FORMSET
*LocalFormSet
;
2447 FORM_BROWSER_CONFIG_REQUEST
*ConfigInfo
;
2450 // Check the supported setting level.
2452 if (SettingScope
>= MaxLevel
) {
2453 return EFI_UNSUPPORTED
;
2457 // Validate the Form by NoSubmit check
2459 Status
= EFI_SUCCESS
;
2460 if (SettingScope
== FormLevel
) {
2461 Status
= NoSubmitCheck (FormSet
, Form
);
2462 } else if (SettingScope
== FormSetLevel
) {
2463 Status
= NoSubmitCheck (FormSet
, NULL
);
2465 if (EFI_ERROR (Status
)) {
2469 if (SettingScope
== FormLevel
&& IsNvUpdateRequiredForForm (Form
)) {
2471 Link
= GetFirstNode (&Form
->ConfigRequestHead
);
2472 while (!IsNull (&Form
->ConfigRequestHead
, Link
)) {
2473 ConfigInfo
= FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link
);
2474 Link
= GetNextNode (&Form
->ConfigRequestHead
, Link
);
2476 Storage
= ConfigInfo
->Storage
;
2477 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2482 // Skip if there is no RequestElement
2484 if (ConfigInfo
->ElementCount
== 0) {
2489 // 1. Prepare <ConfigResp>
2491 Status
= StorageToConfigResp (ConfigInfo
->Storage
, &ConfigResp
, ConfigInfo
->ConfigRequest
, TRUE
);
2492 if (EFI_ERROR (Status
)) {
2497 // 2. Set value to hii config routine protocol.
2499 Status
= mHiiConfigRouting
->RouteConfig (
2504 if (EFI_ERROR (Status
)) {
2505 FreePool (ConfigResp
);
2509 FreePool (ConfigResp
);
2511 // 3. Config success, update storage shadow Buffer, only update the data belong to this form.
2513 SynchronizeStorage (FormSet
, ConfigInfo
->Storage
, ConfigInfo
->ConfigRequest
, TRUE
);
2517 // 4. Update the NV flag.
2519 ValueChangeResetFlagUpdate(TRUE
, NULL
, Form
);
2520 } else if (SettingScope
== FormSetLevel
&& IsNvUpdateRequiredForFormSet (FormSet
)) {
2522 // Submit Buffer storage or Name/Value storage
2524 Link
= GetFirstNode (&FormSet
->StorageListHead
);
2525 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
2526 FormSetStorage
= (FORMSET_STORAGE_FROM_LINK (Link
));
2527 Storage
= FormSetStorage
->BrowserStorage
;
2528 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
2530 if (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
) {
2535 // Skip if there is no RequestElement
2537 if (FormSetStorage
->ElementCount
== 0) {
2542 // 1. Prepare <ConfigResp>
2544 Status
= StorageToConfigResp (Storage
, &ConfigResp
, FormSetStorage
->ConfigRequest
, TRUE
);
2545 if (EFI_ERROR (Status
)) {
2550 // 2. Send <ConfigResp> to Routine config Protocol.
2552 Status
= mHiiConfigRouting
->RouteConfig (
2557 if (EFI_ERROR (Status
)) {
2558 FreePool (ConfigResp
);
2562 FreePool (ConfigResp
);
2564 // 3. Config success, update storage shadow Buffer
2566 SynchronizeStorage (FormSet
, Storage
, FormSetStorage
->ConfigRequest
, TRUE
);
2570 // 4. Update the NV flag.
2572 ValueChangeResetFlagUpdate(TRUE
, FormSet
, NULL
);
2573 } else if (SettingScope
== SystemLevel
) {
2575 // System Level Save.
2579 // Save changed value for each FormSet in the maintain list.
2581 Link
= GetFirstNode (&gBrowserFormSetList
);
2582 while (!IsNull (&gBrowserFormSetList
, Link
)) {
2583 LocalFormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
2584 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
2585 if (!ValidateFormSet(LocalFormSet
)) {
2588 SubmitForm (LocalFormSet
, NULL
, FormSetLevel
);
2589 if (!IsHiiHandleInBrowserContext (LocalFormSet
->HiiHandle
)) {
2591 // Remove maintain backup list after save except for the current using FormSet.
2593 CleanBrowserStorage(LocalFormSet
);
2594 RemoveEntryList (&LocalFormSet
->Link
);
2595 DestroyFormSet (LocalFormSet
);
2604 Get Question default value from AltCfg string.
2606 @param FormSet The form set.
2607 @param Question The question.
2608 @param DefaultId The default Id.
2610 @retval EFI_SUCCESS Question is reset to default value.
2614 GetDefaultValueFromAltCfg (
2615 IN FORM_BROWSER_FORMSET
*FormSet
,
2616 IN OUT FORM_BROWSER_STATEMENT
*Question
,
2620 BOOLEAN IsBufferStorage
;
2623 BROWSER_STORAGE
*Storage
;
2624 CHAR16
*ConfigRequest
;
2637 Status
= EFI_NOT_FOUND
;
2640 ConfigRequest
= NULL
;
2644 Storage
= Question
->Storage
;
2646 if ((Storage
== NULL
) || (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
)) {
2651 // Question Value is provided by Buffer Storage or NameValue Storage
2653 if (Question
->BufferValue
!= NULL
) {
2655 // This Question is password or orderedlist
2657 Dst
= Question
->BufferValue
;
2660 // Other type of Questions
2662 Dst
= (UINT8
*) &Question
->HiiValue
.Value
;
2665 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
|| Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
2666 IsBufferStorage
= TRUE
;
2668 IsBufferStorage
= FALSE
;
2670 IsString
= (BOOLEAN
) ((Question
->HiiValue
.Type
== EFI_IFR_TYPE_STRING
) ? TRUE
: FALSE
);
2673 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
2674 // <ConfigHdr> + "&" + <VariableName>
2676 if (IsBufferStorage
) {
2677 Length
= StrLen (Storage
->ConfigHdr
);
2678 Length
+= StrLen (Question
->BlockName
);
2680 Length
= StrLen (Storage
->ConfigHdr
);
2681 Length
+= StrLen (Question
->VariableName
) + 1;
2683 ConfigRequest
= AllocateZeroPool ((Length
+ 1) * sizeof (CHAR16
));
2684 ASSERT (ConfigRequest
!= NULL
);
2686 StrCpy (ConfigRequest
, Storage
->ConfigHdr
);
2687 if (IsBufferStorage
) {
2688 StrCat (ConfigRequest
, Question
->BlockName
);
2690 StrCat (ConfigRequest
, L
"&");
2691 StrCat (ConfigRequest
, Question
->VariableName
);
2694 Status
= mHiiConfigRouting
->ExtractConfig (
2700 if (EFI_ERROR (Status
)) {
2705 // Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
2706 // Get the default configuration string according to the default ID.
2708 Status
= mHiiConfigRouting
->GetAltConfig (
2714 &DefaultId
, // it can be NULL to get the current setting.
2719 // The required setting can't be found. So, it is not required to be validated and set.
2721 if (EFI_ERROR (Status
)) {
2725 if (ConfigResp
== NULL
) {
2726 Status
= EFI_NOT_FOUND
;
2731 // Skip <ConfigRequest>
2733 if (IsBufferStorage
) {
2734 Value
= StrStr (ConfigResp
, L
"&VALUE");
2735 ASSERT (Value
!= NULL
);
2741 Value
= StrStr (ConfigResp
, Question
->VariableName
);
2742 ASSERT (Value
!= NULL
);
2744 Value
= Value
+ StrLen (Question
->VariableName
);
2746 if (*Value
!= '=') {
2747 Status
= EFI_NOT_FOUND
;
2751 // Skip '=', point to value
2756 // Suppress <AltResp> if any
2759 while (*StringPtr
!= L
'\0' && *StringPtr
!= L
'&') {
2764 LengthStr
= StrLen (Value
);
2765 if (!IsBufferStorage
&& IsString
) {
2766 StringPtr
= (CHAR16
*) Dst
;
2767 ZeroMem (TemStr
, sizeof (TemStr
));
2768 for (Index
= 0; Index
< LengthStr
; Index
+= 4) {
2769 StrnCpy (TemStr
, Value
+ Index
, 4);
2770 StringPtr
[Index
/4] = (CHAR16
) StrHexToUint64 (TemStr
);
2773 // Add tailing L'\0' character
2775 StringPtr
[Index
/4] = L
'\0';
2777 ZeroMem (TemStr
, sizeof (TemStr
));
2778 for (Index
= 0; Index
< LengthStr
; Index
++) {
2779 TemStr
[0] = Value
[LengthStr
- Index
- 1];
2780 DigitUint8
= (UINT8
) StrHexToUint64 (TemStr
);
2781 if ((Index
& 1) == 0) {
2782 Dst
[Index
/2] = DigitUint8
;
2784 Dst
[Index
/2] = (UINT8
) ((DigitUint8
<< 4) + Dst
[Index
/2]);
2790 if (ConfigRequest
!= NULL
){
2791 FreePool (ConfigRequest
);
2794 if (ConfigResp
!= NULL
) {
2795 FreePool (ConfigResp
);
2798 if (Result
!= NULL
) {
2806 Get default Id value used for browser.
2808 @param DefaultId The default id value used by hii.
2810 @retval Browser used default value.
2814 GetDefaultIdForCallBack (
2818 if (DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) {
2819 return EFI_BROWSER_ACTION_DEFAULT_STANDARD
;
2820 } else if (DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
2821 return EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING
;
2822 } else if (DefaultId
== EFI_HII_DEFAULT_CLASS_SAFE
) {
2823 return EFI_BROWSER_ACTION_DEFAULT_SAFE
;
2824 } else if (DefaultId
>= EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN
&& DefaultId
< EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN
+ 0x1000) {
2825 return EFI_BROWSER_ACTION_DEFAULT_PLATFORM
+ DefaultId
- EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN
;
2826 } else if (DefaultId
>= EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN
&& DefaultId
< EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN
+ 0x1000) {
2827 return EFI_BROWSER_ACTION_DEFAULT_HARDWARE
+ DefaultId
- EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN
;
2828 } else if (DefaultId
>= EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN
&& DefaultId
< EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN
+ 0x1000) {
2829 return EFI_BROWSER_ACTION_DEFAULT_FIRMWARE
+ DefaultId
- EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN
;
2838 Return data element in an Array by its Index.
2840 @param Array The data array.
2841 @param Type Type of the data in this array.
2842 @param Index Zero based index for data in this array.
2844 @retval Value The data to be returned
2856 ASSERT (Array
!= NULL
);
2860 case EFI_IFR_TYPE_NUM_SIZE_8
:
2861 Data
= (UINT64
) *(((UINT8
*) Array
) + Index
);
2864 case EFI_IFR_TYPE_NUM_SIZE_16
:
2865 Data
= (UINT64
) *(((UINT16
*) Array
) + Index
);
2868 case EFI_IFR_TYPE_NUM_SIZE_32
:
2869 Data
= (UINT64
) *(((UINT32
*) Array
) + Index
);
2872 case EFI_IFR_TYPE_NUM_SIZE_64
:
2873 Data
= (UINT64
) *(((UINT64
*) Array
) + Index
);
2885 Set value of a data element in an Array by its Index.
2887 @param Array The data array.
2888 @param Type Type of the data in this array.
2889 @param Index Zero based index for data in this array.
2890 @param Value The value to be set.
2902 ASSERT (Array
!= NULL
);
2905 case EFI_IFR_TYPE_NUM_SIZE_8
:
2906 *(((UINT8
*) Array
) + Index
) = (UINT8
) Value
;
2909 case EFI_IFR_TYPE_NUM_SIZE_16
:
2910 *(((UINT16
*) Array
) + Index
) = (UINT16
) Value
;
2913 case EFI_IFR_TYPE_NUM_SIZE_32
:
2914 *(((UINT32
*) Array
) + Index
) = (UINT32
) Value
;
2917 case EFI_IFR_TYPE_NUM_SIZE_64
:
2918 *(((UINT64
*) Array
) + Index
) = (UINT64
) Value
;
2927 Search an Option of a Question by its value.
2929 @param Question The Question
2930 @param OptionValue Value for Option to be searched.
2932 @retval Pointer Pointer to the found Option.
2933 @retval NULL Option not found.
2938 IN FORM_BROWSER_STATEMENT
*Question
,
2939 IN EFI_HII_VALUE
*OptionValue
2943 QUESTION_OPTION
*Option
;
2946 Link
= GetFirstNode (&Question
->OptionListHead
);
2947 while (!IsNull (&Question
->OptionListHead
, Link
)) {
2948 Option
= QUESTION_OPTION_FROM_LINK (Link
);
2950 if ((CompareHiiValue (&Option
->Value
, OptionValue
, &Result
, NULL
) == EFI_SUCCESS
) && (Result
== 0)) {
2952 // Check the suppressif condition, only a valid option can be return.
2954 if ((Option
->SuppressExpression
== NULL
) ||
2955 ((EvaluateExpressionList(Option
->SuppressExpression
, FALSE
, NULL
, NULL
) == ExpressFalse
))) {
2960 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
2968 Reset Question to its default value.
2970 @param FormSet The form set.
2971 @param Form The form.
2972 @param Question The question.
2973 @param DefaultId The Class of the default.
2975 @retval EFI_SUCCESS Question is reset to default value.
2979 GetQuestionDefault (
2980 IN FORM_BROWSER_FORMSET
*FormSet
,
2981 IN FORM_BROWSER_FORM
*Form
,
2982 IN FORM_BROWSER_STATEMENT
*Question
,
2988 QUESTION_DEFAULT
*Default
;
2989 QUESTION_OPTION
*Option
;
2990 EFI_HII_VALUE
*HiiValue
;
2992 EFI_STRING StrValue
;
2993 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
2994 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
2997 Status
= EFI_NOT_FOUND
;
3001 // Statement don't have storage, skip them
3003 if (Question
->QuestionId
== 0) {
3008 // There are Five ways to specify default value for a Question:
3009 // 1, use call back function (highest priority)
3010 // 2, use ExtractConfig function
3011 // 3, use nested EFI_IFR_DEFAULT
3012 // 4, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
3013 // 5, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
3015 HiiValue
= &Question
->HiiValue
;
3018 // Get Question defaut value from call back function.
3020 ConfigAccess
= FormSet
->ConfigAccess
;
3021 Action
= GetDefaultIdForCallBack (DefaultId
);
3022 if ((Action
> 0) && ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) != 0) && (ConfigAccess
!= NULL
)) {
3023 ActionRequest
= EFI_BROWSER_ACTION_REQUEST_NONE
;
3024 Status
= ConfigAccess
->Callback (
3027 Question
->QuestionId
,
3032 if (!EFI_ERROR (Status
)) {
3038 // Get default value from altcfg string.
3040 if (ConfigAccess
!= NULL
) {
3041 Status
= GetDefaultValueFromAltCfg(FormSet
, Question
, DefaultId
);
3042 if (!EFI_ERROR (Status
)) {
3048 // EFI_IFR_DEFAULT has highest priority
3050 if (!IsListEmpty (&Question
->DefaultListHead
)) {
3051 Link
= GetFirstNode (&Question
->DefaultListHead
);
3052 while (!IsNull (&Question
->DefaultListHead
, Link
)) {
3053 Default
= QUESTION_DEFAULT_FROM_LINK (Link
);
3055 if (Default
->DefaultId
== DefaultId
) {
3056 if (Default
->ValueExpression
!= NULL
) {
3058 // Default is provided by an Expression, evaluate it
3060 Status
= EvaluateExpression (FormSet
, Form
, Default
->ValueExpression
);
3061 if (EFI_ERROR (Status
)) {
3065 if (Default
->ValueExpression
->Result
.Type
== EFI_IFR_TYPE_BUFFER
) {
3066 ASSERT (HiiValue
->Type
== EFI_IFR_TYPE_BUFFER
&& Question
->BufferValue
!= NULL
);
3067 if (Question
->StorageWidth
> Default
->ValueExpression
->Result
.BufferLen
) {
3068 CopyMem (Question
->HiiValue
.Buffer
, Default
->ValueExpression
->Result
.Buffer
, Default
->ValueExpression
->Result
.BufferLen
);
3069 Question
->HiiValue
.BufferLen
= Default
->ValueExpression
->Result
.BufferLen
;
3071 CopyMem (Question
->HiiValue
.Buffer
, Default
->ValueExpression
->Result
.Buffer
, Question
->StorageWidth
);
3072 Question
->HiiValue
.BufferLen
= Question
->StorageWidth
;
3074 FreePool (Default
->ValueExpression
->Result
.Buffer
);
3076 HiiValue
->Type
= Default
->ValueExpression
->Result
.Type
;
3077 CopyMem (&HiiValue
->Value
, &Default
->ValueExpression
->Result
.Value
, sizeof (EFI_IFR_TYPE_VALUE
));
3080 // Default value is embedded in EFI_IFR_DEFAULT
3082 CopyMem (HiiValue
, &Default
->Value
, sizeof (EFI_HII_VALUE
));
3085 if (HiiValue
->Type
== EFI_IFR_TYPE_STRING
) {
3086 StrValue
= HiiGetString (FormSet
->HiiHandle
, HiiValue
->Value
.string
, NULL
);
3087 if (StrValue
== NULL
) {
3088 return EFI_NOT_FOUND
;
3090 if (Question
->StorageWidth
> StrSize (StrValue
)) {
3091 CopyMem (Question
->BufferValue
, StrValue
, StrSize (StrValue
));
3093 CopyMem (Question
->BufferValue
, StrValue
, Question
->StorageWidth
);
3100 Link
= GetNextNode (&Question
->DefaultListHead
, Link
);
3105 // EFI_ONE_OF_OPTION
3107 if ((Question
->Operand
== EFI_IFR_ONE_OF_OP
) && !IsListEmpty (&Question
->OptionListHead
)) {
3108 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
3110 // OneOfOption could only provide Standard and Manufacturing default
3112 Link
= GetFirstNode (&Question
->OptionListHead
);
3113 while (!IsNull (&Question
->OptionListHead
, Link
)) {
3114 Option
= QUESTION_OPTION_FROM_LINK (Link
);
3115 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
3117 if ((Option
->SuppressExpression
!= NULL
) &&
3118 EvaluateExpressionList(Option
->SuppressExpression
, FALSE
, NULL
, NULL
) != ExpressFalse
) {
3122 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT
) != 0)) ||
3123 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Option
->Flags
& EFI_IFR_OPTION_DEFAULT_MFG
) != 0))
3125 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
3134 // EFI_IFR_CHECKBOX - lowest priority
3136 if (Question
->Operand
== EFI_IFR_CHECKBOX_OP
) {
3137 if (DefaultId
<= EFI_HII_DEFAULT_CLASS_MANUFACTURING
) {
3139 // Checkbox could only provide Standard and Manufacturing default
3141 if (((DefaultId
== EFI_HII_DEFAULT_CLASS_STANDARD
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT
) != 0)) ||
3142 ((DefaultId
== EFI_HII_DEFAULT_CLASS_MANUFACTURING
) && ((Question
->Flags
& EFI_IFR_CHECKBOX_DEFAULT_MFG
) != 0))
3144 HiiValue
->Value
.b
= TRUE
;
3146 HiiValue
->Value
.b
= FALSE
;
3154 // For Questions without default
3156 Status
= EFI_NOT_FOUND
;
3157 switch (Question
->Operand
) {
3158 case EFI_IFR_NUMERIC_OP
:
3160 // Take minimum value as numeric default value
3162 if ((HiiValue
->Value
.u64
< Question
->Minimum
) || (HiiValue
->Value
.u64
> Question
->Maximum
)) {
3163 HiiValue
->Value
.u64
= Question
->Minimum
;
3164 Status
= EFI_SUCCESS
;
3168 case EFI_IFR_ONE_OF_OP
:
3170 // Take first oneof option as oneof's default value
3172 if (ValueToOption (Question
, HiiValue
) == NULL
) {
3173 Link
= GetFirstNode (&Question
->OptionListHead
);
3174 while (!IsNull (&Question
->OptionListHead
, Link
)) {
3175 Option
= QUESTION_OPTION_FROM_LINK (Link
);
3176 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
3178 if ((Option
->SuppressExpression
!= NULL
) &&
3179 EvaluateExpressionList(Option
->SuppressExpression
, FALSE
, NULL
, NULL
) != ExpressFalse
) {
3183 CopyMem (HiiValue
, &Option
->Value
, sizeof (EFI_HII_VALUE
));
3184 Status
= EFI_SUCCESS
;
3190 case EFI_IFR_ORDERED_LIST_OP
:
3192 // Take option sequence in IFR as ordered list's default value
3195 Link
= GetFirstNode (&Question
->OptionListHead
);
3196 while (!IsNull (&Question
->OptionListHead
, Link
)) {
3197 Status
= EFI_SUCCESS
;
3198 Option
= QUESTION_OPTION_FROM_LINK (Link
);
3199 Link
= GetNextNode (&Question
->OptionListHead
, Link
);
3201 if ((Option
->SuppressExpression
!= NULL
) &&
3202 EvaluateExpressionList(Option
->SuppressExpression
, FALSE
, NULL
, NULL
) != ExpressFalse
) {
3206 SetArrayData (Question
->BufferValue
, Question
->ValueType
, Index
, Option
->Value
.Value
.u64
);
3209 if (Index
>= Question
->MaxContainers
) {
3224 Reset Questions to their initial value or default value in a Form, Formset or System.
3226 GetDefaultValueScope parameter decides which questions will reset
3227 to its default value.
3229 @param FormSet FormSet data structure.
3230 @param Form Form data structure.
3231 @param DefaultId The Class of the default.
3232 @param SettingScope Setting Scope for Default action.
3233 @param GetDefaultValueScope Get default value scope.
3234 @param Storage Get default value only for this storage.
3235 @param RetrieveValueFirst Whether call the retrieve call back to
3236 get the initial value before get default
3239 @retval EFI_SUCCESS The function completed successfully.
3240 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3245 IN FORM_BROWSER_FORMSET
*FormSet
,
3246 IN FORM_BROWSER_FORM
*Form
,
3247 IN UINT16 DefaultId
,
3248 IN BROWSER_SETTING_SCOPE SettingScope
,
3249 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope
,
3250 IN BROWSER_STORAGE
*Storage OPTIONAL
,
3251 IN BOOLEAN RetrieveValueFirst
3255 LIST_ENTRY
*FormLink
;
3257 FORM_BROWSER_STATEMENT
*Question
;
3258 FORM_BROWSER_FORMSET
*LocalFormSet
;
3259 FORM_BROWSER_FORMSET
*OldFormSet
;
3261 Status
= EFI_SUCCESS
;
3264 // Check the supported setting level.
3266 if (SettingScope
>= MaxLevel
|| GetDefaultValueScope
>= GetDefaultForMax
) {
3267 return EFI_UNSUPPORTED
;
3270 if (GetDefaultValueScope
== GetDefaultForStorage
&& Storage
== NULL
) {
3271 return EFI_UNSUPPORTED
;
3274 if (SettingScope
== FormLevel
) {
3276 // Extract Form default
3278 Link
= GetFirstNode (&Form
->StatementListHead
);
3279 while (!IsNull (&Form
->StatementListHead
, Link
)) {
3280 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
3281 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
3284 // If get default value only for this storage, check the storage first.
3286 if ((GetDefaultValueScope
== GetDefaultForStorage
) && (Question
->Storage
!= Storage
)) {
3291 // If get default value only for no storage question, just skip the question which has storage.
3293 if ((GetDefaultValueScope
== GetDefaultForNoStorage
) && (Question
->Storage
!= NULL
)) {
3298 // If Question is disabled, don't reset it to default
3300 if (Question
->Expression
!= NULL
) {
3301 if (EvaluateExpressionList(Question
->Expression
, TRUE
, FormSet
, Form
) == ExpressDisable
) {
3306 if (RetrieveValueFirst
) {
3308 // Call the Retrieve call back to get the initial question value.
3310 Status
= ProcessRetrieveForQuestion(FormSet
->ConfigAccess
, Question
);
3314 // If not request to get the initial value or get initial value fail, then get default value.
3316 if (!RetrieveValueFirst
|| EFI_ERROR (Status
)) {
3317 Status
= GetQuestionDefault (FormSet
, Form
, Question
, DefaultId
);
3318 if (EFI_ERROR (Status
)) {
3324 // Synchronize Buffer storage's Edit buffer
3326 if ((Question
->Storage
!= NULL
) &&
3327 (Question
->Storage
->Type
!= EFI_HII_VARSTORE_EFI_VARIABLE
)) {
3328 SetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithEditBuffer
);
3331 } else if (SettingScope
== FormSetLevel
) {
3332 FormLink
= GetFirstNode (&FormSet
->FormListHead
);
3333 while (!IsNull (&FormSet
->FormListHead
, FormLink
)) {
3334 Form
= FORM_BROWSER_FORM_FROM_LINK (FormLink
);
3335 ExtractDefault (FormSet
, Form
, DefaultId
, FormLevel
, GetDefaultValueScope
, Storage
, RetrieveValueFirst
);
3336 FormLink
= GetNextNode (&FormSet
->FormListHead
, FormLink
);
3338 } else if (SettingScope
== SystemLevel
) {
3340 // Preload all Hii formset.
3342 LoadAllHiiFormset();
3344 OldFormSet
= mSystemLevelFormSet
;
3347 // Set Default Value for each FormSet in the maintain list.
3349 Link
= GetFirstNode (&gBrowserFormSetList
);
3350 while (!IsNull (&gBrowserFormSetList
, Link
)) {
3351 LocalFormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
3352 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
3353 if (!ValidateFormSet(LocalFormSet
)) {
3357 mSystemLevelFormSet
= LocalFormSet
;
3359 ExtractDefault (LocalFormSet
, NULL
, DefaultId
, FormSetLevel
, GetDefaultValueScope
, Storage
, RetrieveValueFirst
);
3362 mSystemLevelFormSet
= OldFormSet
;
3370 Validate whether this question's value has changed.
3372 @param FormSet FormSet data structure.
3373 @param Form Form data structure.
3374 @param Question Question to be initialized.
3375 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
3377 @retval TRUE Question's value has changed.
3378 @retval FALSE Question's value has not changed
3382 IsQuestionValueChanged (
3383 IN FORM_BROWSER_FORMSET
*FormSet
,
3384 IN FORM_BROWSER_FORM
*Form
,
3385 IN OUT FORM_BROWSER_STATEMENT
*Question
,
3386 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
3389 EFI_HII_VALUE BackUpValue
;
3390 CHAR8
*BackUpBuffer
;
3392 BOOLEAN ValueChanged
;
3396 // For quetion without storage, always mark it as data not changed.
3398 if (Question
->Storage
== NULL
&& Question
->Operand
!= EFI_IFR_TIME_OP
&& Question
->Operand
!= EFI_IFR_DATE_OP
) {
3402 BackUpBuffer
= NULL
;
3403 ValueChanged
= FALSE
;
3405 switch (Question
->Operand
) {
3406 case EFI_IFR_ORDERED_LIST_OP
:
3407 BufferWidth
= Question
->StorageWidth
;
3408 BackUpBuffer
= AllocateCopyPool (BufferWidth
, Question
->BufferValue
);
3409 ASSERT (BackUpBuffer
!= NULL
);
3412 case EFI_IFR_STRING_OP
:
3413 case EFI_IFR_PASSWORD_OP
:
3414 BufferWidth
= (UINTN
) Question
->Maximum
* sizeof (CHAR16
);
3415 BackUpBuffer
= AllocateCopyPool (BufferWidth
, Question
->BufferValue
);
3416 ASSERT (BackUpBuffer
!= NULL
);
3423 CopyMem (&BackUpValue
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
));
3425 Status
= GetQuestionValue (FormSet
, Form
, Question
, GetValueFrom
);
3426 ASSERT_EFI_ERROR(Status
);
3428 if (CompareMem (&BackUpValue
, &Question
->HiiValue
, sizeof (EFI_HII_VALUE
)) != 0 ||
3429 CompareMem (BackUpBuffer
, Question
->BufferValue
, BufferWidth
) != 0) {
3430 ValueChanged
= TRUE
;
3433 CopyMem (&Question
->HiiValue
, &BackUpValue
, sizeof (EFI_HII_VALUE
));
3434 CopyMem (Question
->BufferValue
, BackUpBuffer
, BufferWidth
);
3436 if (BackUpBuffer
!= NULL
) {
3437 FreePool (BackUpBuffer
);
3440 Question
->ValueChanged
= ValueChanged
;
3442 return ValueChanged
;
3446 Initialize Question's Edit copy from Storage.
3448 @param Selection Selection contains the information about
3449 the Selection, form and formset to be displayed.
3450 Selection action may be updated in retrieve callback.
3451 If Selection is NULL, only initialize Question value.
3452 @param FormSet FormSet data structure.
3453 @param Form Form data structure.
3455 @retval EFI_SUCCESS The function completed successfully.
3460 IN OUT UI_MENU_SELECTION
*Selection
,
3461 IN FORM_BROWSER_FORMSET
*FormSet
,
3462 IN FORM_BROWSER_FORM
*Form
3467 FORM_BROWSER_STATEMENT
*Question
;
3471 Link
= GetFirstNode (&Form
->StatementListHead
);
3472 while (!IsNull (&Form
->StatementListHead
, Link
)) {
3473 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (Link
);
3476 // Initialize local copy of Value for each Question
3478 if (Question
->Operand
== EFI_IFR_PASSWORD_OP
&& (Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
)== 0) {
3479 Status
= GetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithHiiDriver
);
3481 Status
= GetQuestionValue (FormSet
, Form
, Question
, GetSetValueWithEditBuffer
);
3483 if (EFI_ERROR (Status
)) {
3487 if ((Question
->Operand
== EFI_IFR_STRING_OP
) || (Question
->Operand
== EFI_IFR_PASSWORD_OP
)) {
3488 HiiSetString (FormSet
->HiiHandle
, Question
->HiiValue
.Value
.string
, (CHAR16
*)Question
->BufferValue
, NULL
);
3492 // Call the Retrieve call back function for all questions.
3494 if ((FormSet
->ConfigAccess
!= NULL
) && (Selection
!= NULL
) &&
3495 ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) &&
3496 !gFinishRetrieveCall
) {
3498 // Check QuestionValue does exist.
3500 StorageWidth
= Question
->StorageWidth
;
3501 if (Question
->BufferValue
!= NULL
) {
3502 BufferValue
= Question
->BufferValue
;
3504 BufferValue
= (UINT8
*) &Question
->HiiValue
.Value
;
3508 // For efivarstore storage, initial question value first.
3510 if ((Question
->Storage
!= NULL
) && (Question
->Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE
)) {
3511 Status
= gRT
->GetVariable (
3512 Question
->VariableName
,
3513 &Question
->Storage
->Guid
,
3520 Status
= ProcessCallBackFunction(Selection
, FormSet
, Form
, Question
, EFI_BROWSER_ACTION_RETRIEVE
, TRUE
);
3523 Link
= GetNextNode (&Form
->StatementListHead
, Link
);
3530 Initialize Question's Edit copy from Storage for the whole Formset.
3532 @param Selection Selection contains the information about
3533 the Selection, form and formset to be displayed.
3534 Selection action may be updated in retrieve callback.
3535 If Selection is NULL, only initialize Question value.
3536 @param FormSet FormSet data structure.
3538 @retval EFI_SUCCESS The function completed successfully.
3543 IN OUT UI_MENU_SELECTION
*Selection
,
3544 IN FORM_BROWSER_FORMSET
*FormSet
3549 FORM_BROWSER_FORM
*Form
;
3551 Link
= GetFirstNode (&FormSet
->FormListHead
);
3552 while (!IsNull (&FormSet
->FormListHead
, Link
)) {
3553 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
3556 // Initialize local copy of Value for each Form
3558 Status
= LoadFormConfig (Selection
, FormSet
, Form
);
3559 if (EFI_ERROR (Status
)) {
3563 Link
= GetNextNode (&FormSet
->FormListHead
, Link
);
3567 // Finished question initialization.
3569 FormSet
->QuestionInited
= TRUE
;
3575 Remove the Request element from the Config Request.
3577 @param Storage Pointer to the browser storage.
3578 @param RequestElement The pointer to the Request element.
3583 IN OUT BROWSER_STORAGE
*Storage
,
3584 IN CHAR16
*RequestElement
3590 ASSERT (Storage
->ConfigRequest
!= NULL
&& RequestElement
!= NULL
);
3592 NewStr
= StrStr (Storage
->ConfigRequest
, RequestElement
);
3594 if (NewStr
== NULL
) {
3599 // Remove this element from this ConfigRequest.
3602 NewStr
+= StrLen (RequestElement
);
3603 CopyMem (DestStr
, NewStr
, StrSize (NewStr
));
3605 Storage
->SpareStrLen
+= StrLen (RequestElement
);
3609 Adjust config request in storage, remove the request elements existed in the input ConfigRequest.
3611 @param Storage Pointer to the browser storage.
3612 @param ConfigRequest The pointer to the Request element.
3616 RemoveConfigRequest (
3617 BROWSER_STORAGE
*Storage
,
3618 CHAR16
*ConfigRequest
3621 CHAR16
*RequestElement
;
3622 CHAR16
*NextRequestElement
;
3626 // No request element in it, just return.
3628 if (ConfigRequest
== NULL
) {
3632 if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3634 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
3639 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
3641 SearchKey
= L
"&OFFSET";
3645 // Find SearchKey storage
3647 if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3648 RequestElement
= StrStr (ConfigRequest
, L
"PATH");
3649 ASSERT (RequestElement
!= NULL
);
3650 RequestElement
= StrStr (RequestElement
, SearchKey
);
3652 RequestElement
= StrStr (ConfigRequest
, SearchKey
);
3655 while (RequestElement
!= NULL
) {
3657 // +1 to avoid find header itself.
3659 NextRequestElement
= StrStr (RequestElement
+ 1, SearchKey
);
3662 // The last Request element in configRequest string.
3664 if (NextRequestElement
!= NULL
) {
3666 // Replace "&" with '\0'.
3668 *NextRequestElement
= L
'\0';
3671 RemoveElement (Storage
, RequestElement
);
3673 if (NextRequestElement
!= NULL
) {
3675 // Restore '&' with '\0' for later used.
3677 *NextRequestElement
= L
'&';
3680 RequestElement
= NextRequestElement
;
3684 // If no request element remain, just remove the ConfigRequest string.
3686 if (StrCmp (Storage
->ConfigRequest
, Storage
->ConfigHdr
) == 0) {
3687 FreePool (Storage
->ConfigRequest
);
3688 Storage
->ConfigRequest
= NULL
;
3689 Storage
->SpareStrLen
= 0;
3694 Base on the current formset info, clean the ConfigRequest string in browser storage.
3696 @param FormSet Pointer of the FormSet
3700 CleanBrowserStorage (
3701 IN OUT FORM_BROWSER_FORMSET
*FormSet
3705 FORMSET_STORAGE
*Storage
;
3707 Link
= GetFirstNode (&FormSet
->StorageListHead
);
3708 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
3709 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
3710 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
3712 if (Storage
->BrowserStorage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
) {
3713 if (Storage
->ConfigRequest
== NULL
|| Storage
->BrowserStorage
->ConfigRequest
== NULL
) {
3717 RemoveConfigRequest (Storage
->BrowserStorage
, Storage
->ConfigRequest
);
3718 } else if (Storage
->BrowserStorage
->Type
== EFI_HII_VARSTORE_BUFFER
||
3719 Storage
->BrowserStorage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3720 if (Storage
->BrowserStorage
->ConfigRequest
!= NULL
) {
3721 FreePool (Storage
->BrowserStorage
->ConfigRequest
);
3722 Storage
->BrowserStorage
->ConfigRequest
= NULL
;
3724 Storage
->BrowserStorage
->Initialized
= FALSE
;
3730 Check whether current element in the ConfigReqeust string.
3732 @param BrowserStorage Storage which includes ConfigReqeust.
3733 @param RequestElement New element need to check.
3735 @retval TRUE The Element is in the ConfigReqeust string.
3736 @retval FALSE The Element not in the configReqeust String.
3741 BROWSER_STORAGE
*BrowserStorage
,
3742 CHAR16
*RequestElement
3745 return StrStr (BrowserStorage
->ConfigRequest
, RequestElement
) != NULL
? TRUE
: FALSE
;
3749 Append the Request element to the Config Request.
3751 @param ConfigRequest Current ConfigRequest info.
3752 @param SpareStrLen Current remain free buffer for config reqeust.
3753 @param RequestElement New Request element.
3757 AppendConfigRequest (
3758 IN OUT CHAR16
**ConfigRequest
,
3759 IN OUT UINTN
*SpareStrLen
,
3760 IN CHAR16
*RequestElement
3767 StrLength
= StrLen (RequestElement
);
3770 // Append <RequestElement> to <ConfigRequest>
3772 if (StrLength
> *SpareStrLen
) {
3774 // Old String buffer is not sufficient for RequestElement, allocate a new one
3776 StringSize
= (*ConfigRequest
!= NULL
) ? StrSize (*ConfigRequest
) : sizeof (CHAR16
);
3777 NewStr
= AllocateZeroPool (StringSize
+ CONFIG_REQUEST_STRING_INCREMENTAL
* sizeof (CHAR16
));
3778 ASSERT (NewStr
!= NULL
);
3780 if (*ConfigRequest
!= NULL
) {
3781 CopyMem (NewStr
, *ConfigRequest
, StringSize
);
3782 FreePool (*ConfigRequest
);
3784 *ConfigRequest
= NewStr
;
3785 *SpareStrLen
= CONFIG_REQUEST_STRING_INCREMENTAL
;
3788 StrCat (*ConfigRequest
, RequestElement
);
3789 *SpareStrLen
-= StrLength
;
3793 Adjust the config request info, remove the request elements which already in AllConfigRequest string.
3795 @param Storage Form set Storage.
3796 @param Request The input request string.
3797 @param RespString Whether the input is ConfigRequest or ConfigResp format.
3799 @retval TRUE Has element not covered by current used elements, need to continue to call ExtractConfig
3800 @retval FALSE All elements covered by current used elements.
3804 ConfigRequestAdjust (
3805 IN BROWSER_STORAGE
*Storage
,
3807 IN BOOLEAN RespString
3810 CHAR16
*RequestElement
;
3811 CHAR16
*NextRequestElement
;
3812 CHAR16
*NextElementBakup
;
3817 CHAR16
*ConfigRequest
;
3821 NextElementBakup
= NULL
;
3824 if (Request
!= NULL
) {
3825 ConfigRequest
= Request
;
3827 ConfigRequest
= Storage
->ConfigRequest
;
3830 if (Storage
->ConfigRequest
== NULL
) {
3831 Storage
->ConfigRequest
= AllocateCopyPool (StrSize (ConfigRequest
), ConfigRequest
);
3835 if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3837 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
3842 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
3844 SearchKey
= L
"&OFFSET";
3845 ValueKey
= L
"&VALUE";
3849 // Find SearchKey storage
3851 if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3852 RequestElement
= StrStr (ConfigRequest
, L
"PATH");
3853 ASSERT (RequestElement
!= NULL
);
3854 RequestElement
= StrStr (RequestElement
, SearchKey
);
3856 RequestElement
= StrStr (ConfigRequest
, SearchKey
);
3859 while (RequestElement
!= NULL
) {
3862 // +1 to avoid find header itself.
3864 NextRequestElement
= StrStr (RequestElement
+ 1, SearchKey
);
3867 // The last Request element in configRequest string.
3869 if (NextRequestElement
!= NULL
) {
3870 if (RespString
&& (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
3871 NextElementBakup
= NextRequestElement
;
3872 NextRequestElement
= StrStr (RequestElement
, ValueKey
);
3873 ASSERT (NextRequestElement
!= NULL
);
3876 // Replace "&" with '\0'.
3878 *NextRequestElement
= L
'\0';
3880 if (RespString
&& (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
3881 NextElementBakup
= NextRequestElement
;
3882 NextRequestElement
= StrStr (RequestElement
, ValueKey
);
3883 ASSERT (NextRequestElement
!= NULL
);
3885 // Replace "&" with '\0'.
3887 *NextRequestElement
= L
'\0';
3891 if (!ElementValidation (Storage
, RequestElement
)) {
3893 // Add this element to the Storage->BrowserStorage->AllRequestElement.
3895 AppendConfigRequest(&Storage
->ConfigRequest
, &Storage
->SpareStrLen
, RequestElement
);
3899 if (NextRequestElement
!= NULL
) {
3901 // Restore '&' with '\0' for later used.
3903 *NextRequestElement
= L
'&';
3906 if (RespString
&& (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
3907 RequestElement
= NextElementBakup
;
3909 RequestElement
= NextRequestElement
;
3918 Base on ConfigRequest info to get default value for current formset.
3920 ConfigRequest info include the info about which questions in current formset need to
3921 get default value. This function only get these questions default value.
3923 @param FormSet FormSet data structure.
3924 @param Storage Storage need to update value.
3925 @param ConfigRequest The config request string.
3929 GetDefaultForFormset (
3930 IN FORM_BROWSER_FORMSET
*FormSet
,
3931 IN BROWSER_STORAGE
*Storage
,
3932 IN CHAR16
*ConfigRequest
3937 LIST_ENTRY BackUpList
;
3938 NAME_VALUE_NODE
*Node
;
3940 LIST_ENTRY
*NodeLink
;
3941 NAME_VALUE_NODE
*TmpNode
;
3943 EFI_STRING Progress
;
3947 InitializeListHead(&BackUpList
);
3950 // Back update the edit buffer.
3952 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
3953 (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
3954 BackUpBuf
= AllocateCopyPool (Storage
->Size
, Storage
->EditBuffer
);
3955 ASSERT (BackUpBuf
!= NULL
);
3956 } else if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
3957 Link
= GetFirstNode (&Storage
->NameValueListHead
);
3958 while (!IsNull (&Storage
->NameValueListHead
, Link
)) {
3959 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
3960 Link
= GetNextNode (&Storage
->NameValueListHead
, Link
);
3963 // Only back Node belong to this formset.
3965 if (StrStr (Storage
->ConfigRequest
, Node
->Name
) == NULL
) {
3969 TmpNode
= AllocateCopyPool (sizeof (NAME_VALUE_NODE
), Node
);
3970 TmpNode
->Name
= AllocateCopyPool (StrSize(Node
->Name
) * sizeof (CHAR16
), Node
->Name
);
3971 TmpNode
->EditValue
= AllocateCopyPool (StrSize(Node
->EditValue
) * sizeof (CHAR16
), Node
->EditValue
);
3973 InsertTailList(&BackUpList
, &TmpNode
->Link
);
3978 // Get default value.
3980 ExtractDefault (FormSet
, NULL
, EFI_HII_DEFAULT_CLASS_STANDARD
, FormSetLevel
, GetDefaultForStorage
, Storage
, TRUE
);
3983 // Update the question value based on the input ConfigRequest.
3985 if (Storage
->Type
== EFI_HII_VARSTORE_BUFFER
||
3986 (Storage
->Type
== EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
)) {
3987 ASSERT (BackUpBuf
!= NULL
);
3988 BufferSize
= Storage
->Size
;
3989 Status
= mHiiConfigRouting
->BlockToConfig(
3992 Storage
->EditBuffer
,
3997 ASSERT_EFI_ERROR (Status
);
3999 Status
= mHiiConfigRouting
->ConfigToBlock (
4006 ASSERT_EFI_ERROR (Status
);
4008 if (Result
!= NULL
) {
4012 CopyMem (Storage
->EditBuffer
, BackUpBuf
, Storage
->Size
);
4013 FreePool (BackUpBuf
);
4014 } else if (Storage
->Type
== EFI_HII_VARSTORE_NAME_VALUE
) {
4016 // Update question value, only element in ConfigReqeust will be update.
4018 Link
= GetFirstNode (&BackUpList
);
4019 while (!IsNull (&BackUpList
, Link
)) {
4020 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
4021 Link
= GetNextNode (&BackUpList
, Link
);
4023 if (StrStr (ConfigRequest
, Node
->Name
) != NULL
) {
4027 NodeLink
= GetFirstNode (&Storage
->NameValueListHead
);
4028 while (!IsNull (&Storage
->NameValueListHead
, NodeLink
)) {
4029 TmpNode
= NAME_VALUE_NODE_FROM_LINK (NodeLink
);
4030 NodeLink
= GetNextNode (&Storage
->NameValueListHead
, NodeLink
);
4032 if (StrCmp (Node
->Name
, TmpNode
->Name
) != 0) {
4036 FreePool (TmpNode
->EditValue
);
4037 TmpNode
->EditValue
= AllocateCopyPool (StrSize(Node
->EditValue
) * sizeof (CHAR16
), Node
->EditValue
);
4039 RemoveEntryList (&Node
->Link
);
4040 FreePool (Node
->EditValue
);
4041 FreePool (Node
->Name
);
4047 // Restore the Name/Value node.
4049 Link
= GetFirstNode (&BackUpList
);
4050 while (!IsNull (&BackUpList
, Link
)) {
4051 Node
= NAME_VALUE_NODE_FROM_LINK (Link
);
4052 Link
= GetNextNode (&BackUpList
, Link
);
4057 RemoveEntryList (&Node
->Link
);
4058 FreePool (Node
->EditValue
);
4059 FreePool (Node
->Name
);
4066 Fill storage's edit copy with settings requested from Configuration Driver.
4068 @param FormSet FormSet data structure.
4069 @param Storage Buffer Storage.
4074 IN FORM_BROWSER_FORMSET
*FormSet
,
4075 IN FORMSET_STORAGE
*Storage
4079 EFI_STRING Progress
;
4082 EFI_STRING ConfigRequest
;
4085 ConfigRequest
= NULL
;
4087 switch (Storage
->BrowserStorage
->Type
) {
4088 case EFI_HII_VARSTORE_EFI_VARIABLE
:
4091 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
:
4092 if (Storage
->BrowserStorage
->ConfigRequest
!= NULL
) {
4093 ConfigRequestAdjust(Storage
->BrowserStorage
, Storage
->ConfigRequest
, FALSE
);
4098 case EFI_HII_VARSTORE_BUFFER
:
4099 case EFI_HII_VARSTORE_NAME_VALUE
:
4101 // Skip if there is no RequestElement.
4103 if (Storage
->ElementCount
== 0) {
4108 // Just update the ConfigRequest, if storage already initialized.
4110 if (Storage
->BrowserStorage
->Initialized
) {
4111 ConfigRequestAdjust(Storage
->BrowserStorage
, Storage
->ConfigRequest
, FALSE
);
4115 Storage
->BrowserStorage
->Initialized
= TRUE
;
4122 if (Storage
->BrowserStorage
->Type
!= EFI_HII_VARSTORE_NAME_VALUE
) {
4124 // Create the config request string to get all fields for this storage.
4125 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
4126 // followed by "&OFFSET=0&WIDTH=WWWW"followed by a Null-terminator
4128 StrLen
= StrSize (Storage
->BrowserStorage
->ConfigHdr
) + 20 * sizeof (CHAR16
);
4129 ConfigRequest
= AllocateZeroPool (StrLen
);
4130 ASSERT (ConfigRequest
!= NULL
);
4134 L
"%s&OFFSET=0&WIDTH=%04x",
4135 Storage
->BrowserStorage
->ConfigHdr
,
4136 Storage
->BrowserStorage
->Size
);
4138 ConfigRequest
= Storage
->ConfigRequest
;
4142 // Request current settings from Configuration Driver
4144 Status
= mHiiConfigRouting
->ExtractConfig (
4152 // If get value fail, extract default from IFR binary
4154 if (EFI_ERROR (Status
)) {
4155 ExtractDefault (FormSet
, NULL
, EFI_HII_DEFAULT_CLASS_STANDARD
, FormSetLevel
, GetDefaultForStorage
, Storage
->BrowserStorage
, TRUE
);
4158 // Convert Result from <ConfigAltResp> to <ConfigResp>
4160 StrPtr
= StrStr (Result
, L
"&GUID=");
4161 if (StrPtr
!= NULL
) {
4165 Status
= ConfigRespToStorage (Storage
->BrowserStorage
, Result
);
4169 Storage
->BrowserStorage
->ConfigRequest
= AllocateCopyPool (StrSize (Storage
->ConfigRequest
), Storage
->ConfigRequest
);
4172 // Input NULL for ConfigRequest field means sync all fields from editbuffer to buffer.
4174 SynchronizeStorage(FormSet
, Storage
->BrowserStorage
, NULL
, TRUE
);
4176 if (Storage
->BrowserStorage
->Type
!= EFI_HII_VARSTORE_NAME_VALUE
) {
4177 if (ConfigRequest
!= NULL
) {
4178 FreePool (ConfigRequest
);
4184 Get Value changed status from old question.
4186 @param NewFormSet FormSet data structure.
4187 @param OldQuestion Old question which has value changed.
4191 SyncStatusForQuestion (
4192 IN OUT FORM_BROWSER_FORMSET
*NewFormSet
,
4193 IN FORM_BROWSER_STATEMENT
*OldQuestion
4197 LIST_ENTRY
*QuestionLink
;
4198 FORM_BROWSER_FORM
*Form
;
4199 FORM_BROWSER_STATEMENT
*Question
;
4202 // For each form in one formset.
4204 Link
= GetFirstNode (&NewFormSet
->FormListHead
);
4205 while (!IsNull (&NewFormSet
->FormListHead
, Link
)) {
4206 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
4207 Link
= GetNextNode (&NewFormSet
->FormListHead
, Link
);
4210 // for each question in one form.
4212 QuestionLink
= GetFirstNode (&Form
->StatementListHead
);
4213 while (!IsNull (&Form
->StatementListHead
, QuestionLink
)) {
4214 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink
);
4215 QuestionLink
= GetNextNode (&Form
->StatementListHead
, QuestionLink
);
4217 if (Question
->QuestionId
== OldQuestion
->QuestionId
) {
4218 Question
->ValueChanged
= TRUE
;
4226 Get Value changed status from old formset.
4228 @param NewFormSet FormSet data structure.
4229 @param OldFormSet FormSet data structure.
4233 SyncStatusForFormSet (
4234 IN OUT FORM_BROWSER_FORMSET
*NewFormSet
,
4235 IN FORM_BROWSER_FORMSET
*OldFormSet
4239 LIST_ENTRY
*QuestionLink
;
4240 FORM_BROWSER_FORM
*Form
;
4241 FORM_BROWSER_STATEMENT
*Question
;
4244 // For each form in one formset.
4246 Link
= GetFirstNode (&OldFormSet
->FormListHead
);
4247 while (!IsNull (&OldFormSet
->FormListHead
, Link
)) {
4248 Form
= FORM_BROWSER_FORM_FROM_LINK (Link
);
4249 Link
= GetNextNode (&OldFormSet
->FormListHead
, Link
);
4252 // for each question in one form.
4254 QuestionLink
= GetFirstNode (&Form
->StatementListHead
);
4255 while (!IsNull (&Form
->StatementListHead
, QuestionLink
)) {
4256 Question
= FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink
);
4257 QuestionLink
= GetNextNode (&Form
->StatementListHead
, QuestionLink
);
4259 if (!Question
->ValueChanged
) {
4264 // Find the same question in new formset and update the value changed flag.
4266 SyncStatusForQuestion (NewFormSet
, Question
);
4272 Get current setting of Questions.
4274 @param FormSet FormSet data structure.
4278 InitializeCurrentSetting (
4279 IN OUT FORM_BROWSER_FORMSET
*FormSet
4283 FORMSET_STORAGE
*Storage
;
4284 FORM_BROWSER_FORMSET
*OldFormSet
;
4287 // Try to find pre FormSet in the maintain backup list.
4288 // If old formset != NULL, destroy this formset. Add new formset to gBrowserFormSetList.
4290 OldFormSet
= GetFormSetFromHiiHandle (FormSet
->HiiHandle
);
4291 if (OldFormSet
!= NULL
) {
4292 SyncStatusForFormSet (FormSet
, OldFormSet
);
4293 RemoveEntryList (&OldFormSet
->Link
);
4294 DestroyFormSet (OldFormSet
);
4296 InsertTailList (&gBrowserFormSetList
, &FormSet
->Link
);
4299 // Extract default from IFR binary for no storage questions.
4301 ExtractDefault (FormSet
, NULL
, EFI_HII_DEFAULT_CLASS_STANDARD
, FormSetLevel
, GetDefaultForNoStorage
, NULL
, TRUE
);
4304 // Request current settings from Configuration Driver
4306 Link
= GetFirstNode (&FormSet
->StorageListHead
);
4307 while (!IsNull (&FormSet
->StorageListHead
, Link
)) {
4308 Storage
= FORMSET_STORAGE_FROM_LINK (Link
);
4310 LoadStorage (FormSet
, Storage
);
4312 Link
= GetNextNode (&FormSet
->StorageListHead
, Link
);
4318 Fetch the Ifr binary data of a FormSet.
4320 @param Handle PackageList Handle
4321 @param FormSetGuid On input, GUID or class GUID of a formset. If not
4322 specified (NULL or zero GUID), take the first
4323 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
4324 found in package list.
4325 On output, GUID of the formset found(if not NULL).
4326 @param BinaryLength The length of the FormSet IFR binary.
4327 @param BinaryData The buffer designed to receive the FormSet.
4329 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
4330 BufferLength was updated.
4331 @retval EFI_INVALID_PARAMETER The handle is unknown.
4332 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
4333 be found with the requested FormId.
4338 IN EFI_HII_HANDLE Handle
,
4339 IN OUT EFI_GUID
*FormSetGuid
,
4340 OUT UINTN
*BinaryLength
,
4341 OUT UINT8
**BinaryData
4345 EFI_HII_PACKAGE_LIST_HEADER
*HiiPackageList
;
4351 UINT32 PackageListLength
;
4352 EFI_HII_PACKAGE_HEADER PackageHeader
;
4354 UINT8 NumberOfClassGuid
;
4355 BOOLEAN ClassGuidMatch
;
4356 EFI_GUID
*ClassGuid
;
4357 EFI_GUID
*ComparingGuid
;
4361 ZeroMem (&PackageHeader
, sizeof (EFI_HII_PACKAGE_HEADER
));
4364 // if FormSetGuid is NULL or zero GUID, return first Setup FormSet in the package list
4366 if (FormSetGuid
== NULL
) {
4367 ComparingGuid
= &gZeroGuid
;
4369 ComparingGuid
= FormSetGuid
;
4373 // Get HII PackageList
4376 HiiPackageList
= NULL
;
4377 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
4378 if (Status
== EFI_BUFFER_TOO_SMALL
) {
4379 HiiPackageList
= AllocatePool (BufferSize
);
4380 ASSERT (HiiPackageList
!= NULL
);
4382 Status
= mHiiDatabase
->ExportPackageLists (mHiiDatabase
, Handle
, &BufferSize
, HiiPackageList
);
4384 if (EFI_ERROR (Status
)) {
4387 ASSERT (HiiPackageList
!= NULL
);
4390 // Get Form package from this HII package List
4392 Offset
= sizeof (EFI_HII_PACKAGE_LIST_HEADER
);
4394 CopyMem (&PackageListLength
, &HiiPackageList
->PackageLength
, sizeof (UINT32
));
4396 ClassGuidMatch
= FALSE
;
4397 while (Offset
< PackageListLength
) {
4398 Package
= ((UINT8
*) HiiPackageList
) + Offset
;
4399 CopyMem (&PackageHeader
, Package
, sizeof (EFI_HII_PACKAGE_HEADER
));
4401 if (PackageHeader
.Type
== EFI_HII_PACKAGE_FORMS
) {
4403 // Search FormSet in this Form Package
4405 Offset2
= sizeof (EFI_HII_PACKAGE_HEADER
);
4406 while (Offset2
< PackageHeader
.Length
) {
4407 OpCodeData
= Package
+ Offset2
;
4409 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->OpCode
== EFI_IFR_FORM_SET_OP
) {
4411 // Try to compare against formset GUID
4413 if (CompareGuid (FormSetGuid
, &gZeroGuid
) ||
4414 CompareGuid (ComparingGuid
, (EFI_GUID
*)(OpCodeData
+ sizeof (EFI_IFR_OP_HEADER
)))) {
4418 if (((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
> OFFSET_OF (EFI_IFR_FORM_SET
, Flags
)) {
4420 // Try to compare against formset class GUID
4422 NumberOfClassGuid
= (UINT8
) (((EFI_IFR_FORM_SET
*) OpCodeData
)->Flags
& 0x3);
4423 ClassGuid
= (EFI_GUID
*) (OpCodeData
+ sizeof (EFI_IFR_FORM_SET
));
4424 for (Index
= 0; Index
< NumberOfClassGuid
; Index
++) {
4425 if (CompareGuid (ComparingGuid
, ClassGuid
+ Index
)) {
4426 ClassGuidMatch
= TRUE
;
4430 if (ClassGuidMatch
) {
4433 } else if (ComparingGuid
== &gEfiHiiPlatformSetupFormsetGuid
) {
4434 ClassGuidMatch
= TRUE
;
4439 Offset2
+= ((EFI_IFR_OP_HEADER
*) OpCodeData
)->Length
;
4442 if (Offset2
< PackageHeader
.Length
) {
4444 // Target formset found
4450 Offset
+= PackageHeader
.Length
;
4453 if (Offset
>= PackageListLength
) {
4455 // Form package not found in this Package List
4457 FreePool (HiiPackageList
);
4458 return EFI_NOT_FOUND
;
4461 if (FormSetGuid
!= NULL
) {
4463 // Return the FormSet GUID
4465 CopyMem (FormSetGuid
, &((EFI_IFR_FORM_SET
*) OpCodeData
)->Guid
, sizeof (EFI_GUID
));
4469 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
4470 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
4471 // of the Form Package.
4473 *BinaryLength
= PackageHeader
.Length
- Offset2
;
4474 *BinaryData
= AllocateCopyPool (*BinaryLength
, OpCodeData
);
4476 FreePool (HiiPackageList
);
4478 if (*BinaryData
== NULL
) {
4479 return EFI_OUT_OF_RESOURCES
;
4487 Initialize the internal data structure of a FormSet.
4489 @param Handle PackageList Handle
4490 @param FormSetGuid On input, GUID or class GUID of a formset. If not
4491 specified (NULL or zero GUID), take the first
4492 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
4493 found in package list.
4494 On output, GUID of the formset found(if not NULL).
4495 @param FormSet FormSet data structure.
4497 @retval EFI_SUCCESS The function completed successfully.
4498 @retval EFI_NOT_FOUND The specified FormSet could not be found.
4503 IN EFI_HII_HANDLE Handle
,
4504 IN OUT EFI_GUID
*FormSetGuid
,
4505 OUT FORM_BROWSER_FORMSET
*FormSet
4509 EFI_HANDLE DriverHandle
;
4511 Status
= GetIfrBinaryData (Handle
, FormSetGuid
, &FormSet
->IfrBinaryLength
, &FormSet
->IfrBinaryData
);
4512 if (EFI_ERROR (Status
)) {
4516 FormSet
->Signature
= FORM_BROWSER_FORMSET_SIGNATURE
;
4517 FormSet
->HiiHandle
= Handle
;
4518 CopyMem (&FormSet
->Guid
, FormSetGuid
, sizeof (EFI_GUID
));
4519 FormSet
->QuestionInited
= FALSE
;
4522 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
4524 Status
= mHiiDatabase
->GetPackageListHandle (mHiiDatabase
, Handle
, &DriverHandle
);
4525 if (EFI_ERROR (Status
)) {
4528 FormSet
->DriverHandle
= DriverHandle
;
4529 Status
= gBS
->HandleProtocol (
4531 &gEfiHiiConfigAccessProtocolGuid
,
4532 (VOID
**) &FormSet
->ConfigAccess
4534 if (EFI_ERROR (Status
)) {
4536 // Configuration Driver don't attach ConfigAccess protocol to its HII package
4537 // list, then there will be no configuration action required
4539 FormSet
->ConfigAccess
= NULL
;
4543 // Parse the IFR binary OpCodes
4545 Status
= ParseOpCodes (FormSet
);
4552 Save globals used by previous call to SendForm(). SendForm() may be called from
4553 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
4554 So, save globals of previous call to SendForm() and restore them upon exit.
4558 SaveBrowserContext (
4562 BROWSER_CONTEXT
*Context
;
4563 FORM_ENTRY_INFO
*MenuList
;
4565 gBrowserContextCount
++;
4566 if (gBrowserContextCount
== 1) {
4568 // This is not reentry of SendForm(), no context to save
4573 Context
= AllocatePool (sizeof (BROWSER_CONTEXT
));
4574 ASSERT (Context
!= NULL
);
4576 Context
->Signature
= BROWSER_CONTEXT_SIGNATURE
;
4579 // Save FormBrowser context
4581 Context
->Selection
= gCurrentSelection
;
4582 Context
->ResetRequired
= gResetRequired
;
4583 Context
->ExitRequired
= gExitRequired
;
4584 Context
->HiiHandle
= mCurrentHiiHandle
;
4585 Context
->FormId
= mCurrentFormId
;
4586 CopyGuid (&Context
->FormSetGuid
, &mCurrentFormSetGuid
);
4589 // Save the menu history data.
4591 InitializeListHead(&Context
->FormHistoryList
);
4592 while (!IsListEmpty (&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
)) {
4593 MenuList
= FORM_ENTRY_INFO_FROM_LINK (mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
.ForwardLink
);
4594 RemoveEntryList (&MenuList
->Link
);
4596 InsertTailList(&Context
->FormHistoryList
, &MenuList
->Link
);
4600 // Insert to FormBrowser context list
4602 InsertHeadList (&gBrowserContextList
, &Context
->Link
);
4607 Restore globals used by previous call to SendForm().
4611 RestoreBrowserContext (
4616 BROWSER_CONTEXT
*Context
;
4617 FORM_ENTRY_INFO
*MenuList
;
4619 ASSERT (gBrowserContextCount
!= 0);
4620 gBrowserContextCount
--;
4621 if (gBrowserContextCount
== 0) {
4623 // This is not reentry of SendForm(), no context to restore
4628 ASSERT (!IsListEmpty (&gBrowserContextList
));
4630 Link
= GetFirstNode (&gBrowserContextList
);
4631 Context
= BROWSER_CONTEXT_FROM_LINK (Link
);
4634 // Restore FormBrowser context
4636 gCurrentSelection
= Context
->Selection
;
4637 gResetRequired
= Context
->ResetRequired
;
4638 gExitRequired
= Context
->ExitRequired
;
4639 mCurrentHiiHandle
= Context
->HiiHandle
;
4640 mCurrentFormId
= Context
->FormId
;
4641 CopyGuid (&mCurrentFormSetGuid
, &Context
->FormSetGuid
);
4644 // Restore the menu history data.
4646 while (!IsListEmpty (&Context
->FormHistoryList
)) {
4647 MenuList
= FORM_ENTRY_INFO_FROM_LINK (Context
->FormHistoryList
.ForwardLink
);
4648 RemoveEntryList (&MenuList
->Link
);
4650 InsertTailList(&mPrivateData
.FormBrowserEx2
.FormViewHistoryHead
, &MenuList
->Link
);
4654 // Remove from FormBrowser context list
4656 RemoveEntryList (&Context
->Link
);
4657 gBS
->FreePool (Context
);
4661 Find the matched FormSet context in the backup maintain list based on HiiHandle.
4663 @param Handle The Hii Handle.
4665 @return the found FormSet context. If no found, NULL will return.
4668 FORM_BROWSER_FORMSET
*
4669 GetFormSetFromHiiHandle (
4670 EFI_HII_HANDLE Handle
4674 FORM_BROWSER_FORMSET
*FormSet
;
4676 Link
= GetFirstNode (&gBrowserFormSetList
);
4677 while (!IsNull (&gBrowserFormSetList
, Link
)) {
4678 FormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
4679 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
4680 if (!ValidateFormSet(FormSet
)) {
4683 if (FormSet
->HiiHandle
== Handle
) {
4692 Check whether the input HII handle is the FormSet that is being used.
4694 @param Handle The Hii Handle.
4696 @retval TRUE HII handle is being used.
4697 @retval FALSE HII handle is not being used.
4701 IsHiiHandleInBrowserContext (
4702 EFI_HII_HANDLE Handle
4706 BROWSER_CONTEXT
*Context
;
4709 // HiiHandle is Current FormSet.
4711 if (mCurrentHiiHandle
== Handle
) {
4716 // Check whether HiiHandle is in BrowserContext.
4718 Link
= GetFirstNode (&gBrowserContextList
);
4719 while (!IsNull (&gBrowserContextList
, Link
)) {
4720 Context
= BROWSER_CONTEXT_FROM_LINK (Link
);
4721 if (Context
->HiiHandle
== Handle
) {
4723 // HiiHandle is in BrowserContext
4727 Link
= GetNextNode (&gBrowserContextList
, Link
);
4734 Perform Password check.
4735 Passwork may be encrypted by driver that requires the specific check.
4737 @param Form Form where Password Statement is in.
4738 @param Statement Password statement
4739 @param PasswordString Password string to be checked. It may be NULL.
4740 NULL means to restore password.
4741 "" string can be used to checked whether old password does exist.
4743 @return Status Status of Password check.
4748 IN FORM_DISPLAY_ENGINE_FORM
*Form
,
4749 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
4750 IN EFI_STRING PasswordString OPTIONAL
4754 EFI_HII_CONFIG_ACCESS_PROTOCOL
*ConfigAccess
;
4755 EFI_BROWSER_ACTION_REQUEST ActionRequest
;
4756 EFI_IFR_TYPE_VALUE IfrTypeValue
;
4757 FORM_BROWSER_STATEMENT
*Question
;
4759 ConfigAccess
= gCurrentSelection
->FormSet
->ConfigAccess
;
4760 Question
= GetBrowserStatement(Statement
);
4761 ASSERT (Question
!= NULL
);
4763 if ((Question
->QuestionFlags
& EFI_IFR_FLAG_CALLBACK
) == EFI_IFR_FLAG_CALLBACK
) {
4764 if (ConfigAccess
== NULL
) {
4765 return EFI_UNSUPPORTED
;
4768 if (PasswordString
== NULL
) {
4773 // Check whether has preexisted password.
4775 if (PasswordString
[0] == 0) {
4776 if (*((CHAR16
*) Question
->BufferValue
) == 0) {
4779 return EFI_NOT_READY
;
4784 // Check whether the input password is same as preexisted password.
4786 if (StrnCmp (PasswordString
, (CHAR16
*) Question
->BufferValue
, Question
->StorageWidth
/sizeof (CHAR16
)) == 0) {
4789 return EFI_NOT_READY
;
4794 // Prepare password string in HII database
4796 if (PasswordString
!= NULL
) {
4797 IfrTypeValue
.string
= NewString (PasswordString
, gCurrentSelection
->FormSet
->HiiHandle
);
4799 IfrTypeValue
.string
= 0;
4803 // Send password to Configuration Driver for validation
4805 Status
= ConfigAccess
->Callback (
4807 EFI_BROWSER_ACTION_CHANGING
,
4808 Question
->QuestionId
,
4809 Question
->HiiValue
.Type
,
4815 // Remove password string from HII database
4817 if (PasswordString
!= NULL
) {
4818 DeleteString (IfrTypeValue
.string
, gCurrentSelection
->FormSet
->HiiHandle
);
4825 Find the registered HotKey based on KeyData.
4827 @param[in] KeyData A pointer to a buffer that describes the keystroke
4828 information for the hot key.
4830 @return The registered HotKey context. If no found, NULL will return.
4833 GetHotKeyFromRegisterList (
4834 IN EFI_INPUT_KEY
*KeyData
4838 BROWSER_HOT_KEY
*HotKey
;
4840 Link
= GetFirstNode (&gBrowserHotKeyList
);
4841 while (!IsNull (&gBrowserHotKeyList
, Link
)) {
4842 HotKey
= BROWSER_HOT_KEY_FROM_LINK (Link
);
4843 if (HotKey
->KeyData
->ScanCode
== KeyData
->ScanCode
) {
4846 Link
= GetNextNode (&gBrowserHotKeyList
, Link
);
4853 Configure what scope the hot key will impact.
4854 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
4855 If no scope is set, the default scope will be FormSet level.
4856 After all registered hot keys are removed, previous Scope can reset to another level.
4858 @param[in] Scope Scope level to be set.
4860 @retval EFI_SUCCESS Scope is set correctly.
4861 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
4862 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
4868 IN BROWSER_SETTING_SCOPE Scope
4871 if (Scope
>= MaxLevel
) {
4872 return EFI_INVALID_PARAMETER
;
4876 // When no hot key registered in system or on the first setting,
4877 // Scope can be set.
4879 if (mBrowserScopeFirstSet
|| IsListEmpty (&gBrowserHotKeyList
)) {
4880 gBrowserSettingScope
= Scope
;
4881 mBrowserScopeFirstSet
= FALSE
;
4882 } else if (Scope
!= gBrowserSettingScope
) {
4883 return EFI_UNSUPPORTED
;
4890 Register the hot key with its browser action, or unregistered the hot key.
4891 Only support hot key that is not printable character (control key, function key, etc.).
4892 If the action value is zero, the hot key will be unregistered if it has been registered.
4893 If the same hot key has been registered, the new action and help string will override the previous ones.
4895 @param[in] KeyData A pointer to a buffer that describes the keystroke
4896 information for the hot key. Its type is EFI_INPUT_KEY to
4897 be supported by all ConsoleIn devices.
4898 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
4899 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
4900 @param[in] HelpString Help string that describes the hot key information.
4901 Its value may be NULL for the unregistered hot key.
4903 @retval EFI_SUCCESS Hot key is registered or unregistered.
4904 @retval EFI_INVALID_PARAMETER KeyData is NULL or HelpString is NULL on register.
4905 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
4906 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
4911 IN EFI_INPUT_KEY
*KeyData
,
4913 IN UINT16 DefaultId
,
4914 IN EFI_STRING HelpString OPTIONAL
4917 BROWSER_HOT_KEY
*HotKey
;
4920 // Check input parameters.
4922 if (KeyData
== NULL
|| KeyData
->UnicodeChar
!= CHAR_NULL
||
4923 (Action
!= BROWSER_ACTION_UNREGISTER
&& HelpString
== NULL
)) {
4924 return EFI_INVALID_PARAMETER
;
4928 // Check whether the input KeyData is in BrowserHotKeyList.
4930 HotKey
= GetHotKeyFromRegisterList (KeyData
);
4933 // Unregister HotKey
4935 if (Action
== BROWSER_ACTION_UNREGISTER
) {
4936 if (HotKey
!= NULL
) {
4938 // The registered HotKey is found.
4939 // Remove it from List, and free its resource.
4941 RemoveEntryList (&HotKey
->Link
);
4942 FreePool (HotKey
->KeyData
);
4943 FreePool (HotKey
->HelpString
);
4947 // The registered HotKey is not found.
4949 return EFI_NOT_FOUND
;
4954 // Register HotKey into List.
4956 if (HotKey
== NULL
) {
4958 // Create new Key, and add it into List.
4960 HotKey
= AllocateZeroPool (sizeof (BROWSER_HOT_KEY
));
4961 ASSERT (HotKey
!= NULL
);
4962 HotKey
->Signature
= BROWSER_HOT_KEY_SIGNATURE
;
4963 HotKey
->KeyData
= AllocateCopyPool (sizeof (EFI_INPUT_KEY
), KeyData
);
4964 InsertTailList (&gBrowserHotKeyList
, &HotKey
->Link
);
4968 // Fill HotKey information.
4970 HotKey
->Action
= Action
;
4971 HotKey
->DefaultId
= DefaultId
;
4972 if (HotKey
->HelpString
!= NULL
) {
4973 FreePool (HotKey
->HelpString
);
4975 HotKey
->HelpString
= AllocateCopyPool (StrSize (HelpString
), HelpString
);
4981 Register Exit handler function.
4982 When more than one handler function is registered, the latter one will override the previous one.
4983 When NULL handler is specified, the previous Exit handler will be unregistered.
4985 @param[in] Handler Pointer to handler function.
4990 RegiserExitHandler (
4991 IN EXIT_HANDLER Handler
4994 ExitHandlerFunction
= Handler
;
4999 Check whether the browser data has been modified.
5001 @retval TRUE Browser data is modified.
5002 @retval FALSE No browser data is modified.
5007 IsBrowserDataModified (
5012 FORM_BROWSER_FORMSET
*FormSet
;
5014 switch (gBrowserSettingScope
) {
5016 if (gCurrentSelection
== NULL
) {
5019 return IsNvUpdateRequiredForForm (gCurrentSelection
->Form
);
5022 if (gCurrentSelection
== NULL
) {
5025 return IsNvUpdateRequiredForFormSet (gCurrentSelection
->FormSet
);
5028 Link
= GetFirstNode (&gBrowserFormSetList
);
5029 while (!IsNull (&gBrowserFormSetList
, Link
)) {
5030 FormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
5031 if (!ValidateFormSet(FormSet
)) {
5035 if (IsNvUpdateRequiredForFormSet (FormSet
)) {
5038 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
5048 Execute the action requested by the Action parameter.
5050 @param[in] Action Execute the request action.
5051 @param[in] DefaultId The default Id info when need to load default value. Only used when Action is BROWSER_ACTION_DEFAULT.
5053 @retval EFI_SUCCESS Execute the request action succss.
5054 @retval EFI_INVALID_PARAMETER The input action value is invalid.
5065 FORM_BROWSER_FORMSET
*FormSet
;
5066 FORM_BROWSER_FORM
*Form
;
5068 if (gBrowserSettingScope
< SystemLevel
&& gCurrentSelection
== NULL
) {
5069 return EFI_NOT_READY
;
5072 Status
= EFI_SUCCESS
;
5075 if (gBrowserSettingScope
< SystemLevel
) {
5076 FormSet
= gCurrentSelection
->FormSet
;
5077 Form
= gCurrentSelection
->Form
;
5081 // Executet the discard action.
5083 if ((Action
& BROWSER_ACTION_DISCARD
) != 0) {
5084 Status
= DiscardForm (FormSet
, Form
, gBrowserSettingScope
);
5085 if (EFI_ERROR (Status
)) {
5091 // Executet the difault action.
5093 if ((Action
& BROWSER_ACTION_DEFAULT
) != 0) {
5094 Status
= ExtractDefault (FormSet
, Form
, DefaultId
, gBrowserSettingScope
, GetDefaultForAll
, NULL
, FALSE
);
5095 if (EFI_ERROR (Status
)) {
5098 UpdateStatementStatus (FormSet
, Form
, gBrowserSettingScope
);
5102 // Executet the submit action.
5104 if ((Action
& BROWSER_ACTION_SUBMIT
) != 0) {
5105 Status
= SubmitForm (FormSet
, Form
, gBrowserSettingScope
);
5106 if (EFI_ERROR (Status
)) {
5112 // Executet the reset action.
5114 if ((Action
& BROWSER_ACTION_RESET
) != 0) {
5115 gResetRequired
= TRUE
;
5119 // Executet the exit action.
5121 if ((Action
& BROWSER_ACTION_EXIT
) != 0) {
5122 DiscardForm (FormSet
, Form
, gBrowserSettingScope
);
5123 if (gBrowserSettingScope
== SystemLevel
) {
5124 if (ExitHandlerFunction
!= NULL
) {
5125 ExitHandlerFunction ();
5129 gExitRequired
= TRUE
;
5136 Create reminder to let user to choose save or discard the changed browser data.
5137 Caller can use it to actively check the changed browser data.
5139 @retval BROWSER_NO_CHANGES No browser data is changed.
5140 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
5141 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
5142 @retval BROWSER_KEEP_CURRENT Browser keep current changes.
5152 FORM_BROWSER_FORMSET
*FormSet
;
5153 BOOLEAN IsDataChanged
;
5154 UINT32 DataSavedAction
;
5157 DataSavedAction
= BROWSER_NO_CHANGES
;
5158 IsDataChanged
= FALSE
;
5159 Link
= GetFirstNode (&gBrowserFormSetList
);
5160 while (!IsNull (&gBrowserFormSetList
, Link
)) {
5161 FormSet
= FORM_BROWSER_FORMSET_FROM_LINK (Link
);
5162 Link
= GetNextNode (&gBrowserFormSetList
, Link
);
5163 if (!ValidateFormSet(FormSet
)) {
5166 if (IsNvUpdateRequiredForFormSet (FormSet
)) {
5167 IsDataChanged
= TRUE
;
5173 // No data is changed. No save is required.
5175 if (!IsDataChanged
) {
5176 return DataSavedAction
;
5180 // If data is changed, prompt user to save or discard it.
5183 ConfirmRet
= (UINT32
) mFormDisplay
->ConfirmDataChange();
5185 if (ConfirmRet
== BROWSER_ACTION_SUBMIT
) {
5186 SubmitForm (NULL
, NULL
, SystemLevel
);
5187 DataSavedAction
= BROWSER_SAVE_CHANGES
;
5189 } else if (ConfirmRet
== BROWSER_ACTION_DISCARD
) {
5190 DiscardForm (NULL
, NULL
, SystemLevel
);
5191 DataSavedAction
= BROWSER_DISCARD_CHANGES
;
5193 } else if (ConfirmRet
== BROWSER_ACTION_NONE
) {
5194 DataSavedAction
= BROWSER_KEEP_CURRENT
;
5199 return DataSavedAction
;