]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Setup.c
projects / mirror_edk2.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
MdeModulePkg: Restore question base on the fail info when submit fail
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Setup.c
1 /** @file
2 Entry and initialization module for the browser.
3
4 Copyright (c) 2007 - 2016, 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
9
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.
12
13 **/
14
15 #include "Setup.h"
16
17 SETUP_DRIVER_PRIVATE_DATA mPrivateData = {
18 SETUP_DRIVER_SIGNATURE,
19 NULL,
20 {
21 SendForm,
22 BrowserCallback
23 },
24 {
25 SetScope,
26 RegisterHotKey,
27 RegiserExitHandler,
28 SaveReminder
29 },
30 {
31 BROWSER_EXTENSION2_VERSION_1_1,
32 SetScope,
33 RegisterHotKey,
34 RegiserExitHandler,
35 IsBrowserDataModified,
36 ExecuteAction,
37 {NULL,NULL},
38 {NULL,NULL},
39 IsResetRequired
40 }
41 };
42
43 EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;
44 EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;
45 EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL *mPathFromText;
46 EDKII_FORM_DISPLAY_ENGINE_PROTOCOL *mFormDisplay;
47
48 UINTN gBrowserContextCount = 0;
49 LIST_ENTRY gBrowserContextList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserContextList);
50 LIST_ENTRY gBrowserFormSetList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserFormSetList);
51 LIST_ENTRY gBrowserHotKeyList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserHotKeyList);
52 LIST_ENTRY gBrowserStorageList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserStorageList);
53 LIST_ENTRY gBrowserSaveFailFormSetList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserSaveFailFormSetList);
54
55 BOOLEAN mSystemSubmit = FALSE;
56 BOOLEAN gResetRequired;
57 BOOLEAN gExitRequired;
58 BOOLEAN gFlagReconnect;
59 BOOLEAN gCallbackReconnect;
60 BROWSER_SETTING_SCOPE gBrowserSettingScope = FormSetLevel;
61 BOOLEAN mBrowserScopeFirstSet = TRUE;
62 EXIT_HANDLER ExitHandlerFunction = NULL;
63 FORM_BROWSER_FORMSET *mSystemLevelFormSet;
64
65 //
66 // Browser Global Strings
67 //
68 CHAR16 *gEmptyString;
69 CHAR16 *mUnknownString = L"!";
70
71 extern EFI_GUID mCurrentFormSetGuid;
72 extern EFI_HII_HANDLE mCurrentHiiHandle;
73 extern UINT16 mCurrentFormId;
74 extern FORM_DISPLAY_ENGINE_FORM gDisplayFormData;
75
76 /**
77 Create a menu with specified formset GUID and form ID, and add it as a child
78 of the given parent menu.
79
80 @param HiiHandle Hii handle related to this formset.
81 @param FormSetGuid The Formset Guid of menu to be added.
82 @param FormId The Form ID of menu to be added.
83 @param QuestionId The question id of this menu to be added.
84
85 @return A pointer to the newly added menu or NULL if memory is insufficient.
86
87 **/
88 FORM_ENTRY_INFO *
89 UiAddMenuList (
90 IN EFI_HII_HANDLE HiiHandle,
91 IN EFI_GUID *FormSetGuid,
92 IN UINT16 FormId,
93 IN UINT16 QuestionId
94 )
95 {
96 FORM_ENTRY_INFO *MenuList;
97
98 MenuList = AllocateZeroPool (sizeof (FORM_ENTRY_INFO));
99 if (MenuList == NULL) {
100 return NULL;
101 }
102
103 MenuList->Signature = FORM_ENTRY_INFO_SIGNATURE;
104
105 MenuList->HiiHandle = HiiHandle;
106 CopyMem (&MenuList->FormSetGuid, FormSetGuid, sizeof (EFI_GUID));
107 MenuList->FormId = FormId;
108 MenuList->QuestionId = QuestionId;
109
110 //
111 // If parent is not specified, it is the root Form of a Formset
112 //
113 InsertTailList (&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &MenuList->Link);
114
115 return MenuList;
116 }
117
118 /**
119 Return the form id for the input hiihandle and formset.
120
121 @param HiiHandle HiiHandle for FormSet.
122 @param FormSetGuid The Formset GUID of the menu to search.
123
124 @return First form's id for this form set.
125
126 **/
127 EFI_FORM_ID
128 GetFirstFormId (
129 IN EFI_HII_HANDLE HiiHandle,
130 IN EFI_GUID *FormSetGuid
131 )
132 {
133 LIST_ENTRY *Link;
134 FORM_BROWSER_FORM *Form;
135
136 Link = GetFirstNode (&gCurrentSelection->FormSet->FormListHead);
137 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
138
139 return Form->FormId;
140 }
141
142 /**
143 Search Menu with given FormSetGuid and FormId in all cached menu list.
144
145 @param HiiHandle HiiHandle for FormSet.
146 @param FormSetGuid The Formset GUID of the menu to search.
147 @param FormId The Form ID of menu to search.
148
149 @return A pointer to menu found or NULL if not found.
150
151 **/
152 FORM_ENTRY_INFO *
153 UiFindMenuList (
154 IN EFI_HII_HANDLE HiiHandle,
155 IN EFI_GUID *FormSetGuid,
156 IN UINT16 FormId
157 )
158 {
159 LIST_ENTRY *Link;
160 FORM_ENTRY_INFO *MenuList;
161 FORM_ENTRY_INFO *RetMenu;
162 EFI_FORM_ID FirstFormId;
163
164 RetMenu = NULL;
165
166 Link = GetFirstNode (&mPrivateData.FormBrowserEx2.FormViewHistoryHead);
167 while (!IsNull (&mPrivateData.FormBrowserEx2.FormViewHistoryHead, Link)) {
168 MenuList = FORM_ENTRY_INFO_FROM_LINK (Link);
169 Link = GetNextNode (&mPrivateData.FormBrowserEx2.FormViewHistoryHead, Link);
170
171 //
172 // If already find the menu, free the menus behind it.
173 //
174 if (RetMenu != NULL) {
175 RemoveEntryList (&MenuList->Link);
176 FreePool (MenuList);
177 continue;
178 }
179
180 //
181 // Find the same FromSet.
182 //
183 if (MenuList->HiiHandle == HiiHandle) {
184 if (CompareGuid (&MenuList->FormSetGuid, &gZeroGuid)) {
185 //
186 // FormSetGuid is not specified.
187 //
188 RetMenu = MenuList;
189 } else if (CompareGuid (&MenuList->FormSetGuid, FormSetGuid)) {
190 if (MenuList->FormId == FormId) {
191 RetMenu = MenuList;
192 } else if (FormId == 0 || MenuList->FormId == 0 ) {
193 FirstFormId = GetFirstFormId (HiiHandle, FormSetGuid);
194 if ((FormId == 0 && FirstFormId == MenuList->FormId) || (MenuList->FormId ==0 && FirstFormId == FormId)) {
195 RetMenu = MenuList;
196 }
197 }
198 }
199 }
200 }
201
202 return RetMenu;
203 }
204
205 /**
206 Find parent menu for current menu.
207
208 @param CurrentMenu Current Menu
209 @param SettingLevel Whether find parent menu in Form Level or Formset level.
210 In form level, just find the parent menu;
211 In formset level, find the parent menu which has different
212 formset guid value.
213
214 @retval The parent menu for current menu.
215 **/
216 FORM_ENTRY_INFO *
217 UiFindParentMenu (
218 IN FORM_ENTRY_INFO *CurrentMenu,
219 IN BROWSER_SETTING_SCOPE SettingLevel
220 )
221 {
222 FORM_ENTRY_INFO *ParentMenu;
223 LIST_ENTRY *Link;
224
225 ASSERT (SettingLevel == FormLevel || SettingLevel == FormSetLevel);
226
227 if (CurrentMenu == NULL) {
228 return NULL;
229 }
230
231 ParentMenu = NULL;
232 Link = &CurrentMenu->Link;
233
234 while (Link->BackLink != &mPrivateData.FormBrowserEx2.FormViewHistoryHead) {
235 ParentMenu = FORM_ENTRY_INFO_FROM_LINK (Link->BackLink);
236
237 if (SettingLevel == FormLevel) {
238 //
239 // For FormLevel, just find the parent menu, return.
240 //
241 break;
242 }
243
244 if (!CompareGuid (&CurrentMenu->FormSetGuid, &ParentMenu->FormSetGuid)) {
245 //
246 // For SystemLevel, must find the menu which has different formset.
247 //
248 break;
249 }
250
251 Link = Link->BackLink;
252 }
253
254 //
255 // Not find the parent menu, just return NULL.
256 //
257 if (Link->BackLink == &mPrivateData.FormBrowserEx2.FormViewHistoryHead) {
258 return NULL;
259 }
260
261 return ParentMenu;
262 }
263
264 /**
265 Free Menu list linked list.
266
267 @param MenuListHead One Menu list point in the menu list.
268
269 **/
270 VOID
271 UiFreeMenuList (
272 LIST_ENTRY *MenuListHead
273 )
274 {
275 FORM_ENTRY_INFO *MenuList;
276
277 while (!IsListEmpty (MenuListHead)) {
278 MenuList = FORM_ENTRY_INFO_FROM_LINK (MenuListHead->ForwardLink);
279 RemoveEntryList (&MenuList->Link);
280
281 FreePool (MenuList);
282 }
283 }
284
285 /**
286 Copy current Menu list to the new menu list.
287
288 @param NewMenuListHead New create Menu list.
289 @param CurrentMenuListHead Current Menu list.
290
291 **/
292 VOID
293 UiCopyMenuList (
294 OUT LIST_ENTRY *NewMenuListHead,
295 IN LIST_ENTRY *CurrentMenuListHead
296 )
297 {
298 LIST_ENTRY *Link;
299 FORM_ENTRY_INFO *MenuList;
300 FORM_ENTRY_INFO *NewMenuEntry;
301
302 //
303 // If new menu list not empty, free it first.
304 //
305 UiFreeMenuList (NewMenuListHead);
306
307 Link = GetFirstNode (CurrentMenuListHead);
308 while (!IsNull (CurrentMenuListHead, Link)) {
309 MenuList = FORM_ENTRY_INFO_FROM_LINK (Link);
310 Link = GetNextNode (CurrentMenuListHead, Link);
311
312 NewMenuEntry = AllocateZeroPool (sizeof (FORM_ENTRY_INFO));
313 ASSERT (NewMenuEntry != NULL);
314 NewMenuEntry->Signature = FORM_ENTRY_INFO_SIGNATURE;
315 NewMenuEntry->HiiHandle = MenuList->HiiHandle;
316 CopyMem (&NewMenuEntry->FormSetGuid, &MenuList->FormSetGuid, sizeof (EFI_GUID));
317 NewMenuEntry->FormId = MenuList->FormId;
318 NewMenuEntry->QuestionId = MenuList->QuestionId;
319
320 InsertTailList (NewMenuListHead, &NewMenuEntry->Link);
321 }
322 }
323
324 /**
325 Load all hii formset to the browser.
326
327 **/
328 VOID
329 LoadAllHiiFormset (
330 VOID
331 )
332 {
333 FORM_BROWSER_FORMSET *LocalFormSet;
334 EFI_HII_HANDLE *HiiHandles;
335 UINTN Index;
336 EFI_GUID ZeroGuid;
337 EFI_STATUS Status;
338 FORM_BROWSER_FORMSET *OldFormset;
339
340 OldFormset = mSystemLevelFormSet;
341
342 //
343 // Get all the Hii handles
344 //
345 HiiHandles = HiiGetHiiHandles (NULL);
346 ASSERT (HiiHandles != NULL);
347
348 //
349 // Search for formset of each class type
350 //
351 for (Index = 0; HiiHandles[Index] != NULL; Index++) {
352 //
353 // Check HiiHandles[Index] does exist in global maintain list.
354 //
355 if (GetFormSetFromHiiHandle (HiiHandles[Index]) != NULL) {
356 continue;
357 }
358
359 //
360 // Initilize FormSet Setting
361 //
362 LocalFormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
363 ASSERT (LocalFormSet != NULL);
364 mSystemLevelFormSet = LocalFormSet;
365
366 ZeroMem (&ZeroGuid, sizeof (ZeroGuid));
367 Status = InitializeFormSet (HiiHandles[Index], &ZeroGuid, LocalFormSet);
368 if (EFI_ERROR (Status) || IsListEmpty (&LocalFormSet->FormListHead)) {
369 DestroyFormSet (LocalFormSet);
370 continue;
371 }
372 InitializeCurrentSetting (LocalFormSet);
373
374 //
375 // Initilize Questions' Value
376 //
377 Status = LoadFormSetConfig (NULL, LocalFormSet);
378 if (EFI_ERROR (Status)) {
379 DestroyFormSet (LocalFormSet);
380 continue;
381 }
382 }
383
384 //
385 // Free resources, and restore gOldFormSet and gClassOfVfr
386 //
387 FreePool (HiiHandles);
388
389 mSystemLevelFormSet = OldFormset;
390 }
391
392 /**
393 Pop up the error info.
394
395 @param BrowserStatus The input browser status.
396 @param HiiHandle The Hiihandle for this opcode.
397 @param OpCode The opcode use to get the erro info and timeout value.
398 @param ErrorString Error string used by BROWSER_NO_SUBMIT_IF.
399
400 **/
401 UINT32
402 PopupErrorMessage (
403 IN UINT32 BrowserStatus,
404 IN EFI_HII_HANDLE HiiHandle,
405 IN EFI_IFR_OP_HEADER *OpCode, OPTIONAL
406 IN CHAR16 *ErrorString
407 )
408 {
409 FORM_DISPLAY_ENGINE_STATEMENT *Statement;
410 USER_INPUT UserInputData;
411
412 Statement = NULL;
413
414 if (OpCode != NULL) {
415 Statement = AllocateZeroPool (sizeof(FORM_DISPLAY_ENGINE_STATEMENT));
416 ASSERT (Statement != NULL);
417 Statement->OpCode = OpCode;
418 gDisplayFormData.HighLightedStatement = Statement;
419 }
420
421 //
422 // Used to compatible with old display engine.
423 // New display engine not use this field.
424 //
425 gDisplayFormData.ErrorString = ErrorString;
426 gDisplayFormData.BrowserStatus = BrowserStatus;
427
428 if (HiiHandle != NULL) {
429 gDisplayFormData.HiiHandle = HiiHandle;
430 }
431
432 mFormDisplay->FormDisplay (&gDisplayFormData, &UserInputData);
433
434 gDisplayFormData.BrowserStatus = BROWSER_SUCCESS;
435 gDisplayFormData.ErrorString = NULL;
436
437 if (OpCode != NULL) {
438 FreePool (Statement);
439 }
440
441 return UserInputData.Action;
442 }
443
444 /**
445 This is the routine which an external caller uses to direct the browser
446 where to obtain it's information.
447
448
449 @param This The Form Browser protocol instanse.
450 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
451 display a list of the formsets for the handles specified.
452 @param HandleCount The number of Handles specified in Handle.
453 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
454 field in the EFI_IFR_FORM_SET op-code for the specified
455 forms-based package. If FormSetGuid is NULL, then this
456 function will display the first found forms package.
457 @param FormId This field specifies which EFI_IFR_FORM to render as the first
458 displayable page. If this field has a value of 0x0000, then
459 the forms browser will render the specified forms in their encoded order.
460 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
461 characters.
462 @param ActionRequest Points to the action recommended by the form.
463
464 @retval EFI_SUCCESS The function completed successfully.
465 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
466 @retval EFI_NOT_FOUND No valid forms could be found to display.
467
468 **/
469 EFI_STATUS
470 EFIAPI
471 SendForm (
472 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
473 IN EFI_HII_HANDLE *Handles,
474 IN UINTN HandleCount,
475 IN EFI_GUID *FormSetGuid, OPTIONAL
476 IN UINT16 FormId, OPTIONAL
477 IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
478 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL
479 )
480 {
481 EFI_STATUS Status;
482 UI_MENU_SELECTION *Selection;
483 UINTN Index;
484 FORM_BROWSER_FORMSET *FormSet;
485 FORM_ENTRY_INFO *MenuList;
486 BOOLEAN RetVal;
487
488 //
489 // If EDKII_FORM_DISPLAY_ENGINE_PROTOCOL not found, return EFI_UNSUPPORTED.
490 //
491 if (mFormDisplay == NULL) {
492 DEBUG ((DEBUG_ERROR, "Fatal Error! EDKII_FORM_DISPLAY_ENGINE_PROTOCOL not found!"));
493 return EFI_UNSUPPORTED;
494 }
495
496 //
497 // Save globals used by SendForm()
498 //
499 SaveBrowserContext ();
500
501 gFlagReconnect = FALSE;
502 gResetRequired = FALSE;
503 gExitRequired = FALSE;
504 gCallbackReconnect = FALSE;
505 Status = EFI_SUCCESS;
506 gEmptyString = L"";
507 gDisplayFormData.ScreenDimensions = (EFI_SCREEN_DESCRIPTOR *) ScreenDimensions;
508
509 for (Index = 0; Index < HandleCount; Index++) {
510 Selection = AllocateZeroPool (sizeof (UI_MENU_SELECTION));
511 ASSERT (Selection != NULL);
512
513 Selection->Handle = Handles[Index];
514 if (FormSetGuid != NULL) {
515 CopyMem (&Selection->FormSetGuid, FormSetGuid, sizeof (EFI_GUID));
516 Selection->FormId = FormId;
517 } else {
518 CopyMem (&Selection->FormSetGuid, &gEfiHiiPlatformSetupFormsetGuid, sizeof (EFI_GUID));
519 }
520
521 do {
522 FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
523 ASSERT (FormSet != NULL);
524
525 //
526 // Validate the HiiHandle
527 // if validate failed, find the first validate parent HiiHandle.
528 //
529 if (!ValidateHiiHandle(Selection->Handle)) {
530 FindNextMenu (Selection, FormSetLevel);
531 }
532
533 //
534 // Initialize internal data structures of FormSet
535 //
536 Status = InitializeFormSet (Selection->Handle, &Selection->FormSetGuid, FormSet);
537 if (EFI_ERROR (Status) || IsListEmpty (&FormSet->FormListHead)) {
538 DestroyFormSet (FormSet);
539 break;
540 }
541 Selection->FormSet = FormSet;
542 mSystemLevelFormSet = FormSet;
543
544 //
545 // Display this formset
546 //
547 gCurrentSelection = Selection;
548
549 Status = SetupBrowser (Selection);
550
551 gCurrentSelection = NULL;
552 mSystemLevelFormSet = NULL;
553
554 if (gFlagReconnect || gCallbackReconnect) {
555 RetVal = ReconnectController (FormSet->DriverHandle);
556 if (!RetVal) {
557 PopupErrorMessage(BROWSER_RECONNECT_FAIL, NULL, NULL, NULL);
558 }
559 gFlagReconnect = FALSE;
560 gCallbackReconnect = FALSE;
561 }
562
563 //
564 // If no data is changed, don't need to save current FormSet into the maintain list.
565 //
566 if (!IsNvUpdateRequiredForFormSet (FormSet)) {
567 CleanBrowserStorage(FormSet);
568 RemoveEntryList (&FormSet->Link);
569 DestroyFormSet (FormSet);
570 }
571
572 if (EFI_ERROR (Status)) {
573 break;
574 }
575 } while (Selection->Action == UI_ACTION_REFRESH_FORMSET);
576
577 FreePool (Selection);
578 }
579
580 if (ActionRequest != NULL) {
581 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
582 if (gResetRequired) {
583 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_RESET;
584 }
585 }
586
587 mFormDisplay->ExitDisplay();
588
589 //
590 // Clear the menu history data.
591 //
592 while (!IsListEmpty (&mPrivateData.FormBrowserEx2.FormViewHistoryHead)) {
593 MenuList = FORM_ENTRY_INFO_FROM_LINK (mPrivateData.FormBrowserEx2.FormViewHistoryHead.ForwardLink);
594 RemoveEntryList (&MenuList->Link);
595 FreePool (MenuList);
596 }
597
598 //
599 // Restore globals used by SendForm()
600 //
601 RestoreBrowserContext ();
602
603 return Status;
604 }
605
606 /**
607 Get or set data to the storage.
608
609 @param ResultsDataSize The size of the buffer associatedwith ResultsData.
610 @param ResultsData A string returned from an IFR browser or
611 equivalent. The results string will have no
612 routing information in them.
613 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
614 (if RetrieveData = TRUE) data from the uncommitted
615 browser state information or set (if RetrieveData
616 = FALSE) data in the uncommitted browser state
617 information.
618 @param Storage The pointer to the storage.
619
620 @retval EFI_SUCCESS The results have been distributed or are awaiting
621 distribution.
622
623 **/
624 EFI_STATUS
625 ProcessStorage (
626 IN OUT UINTN *ResultsDataSize,
627 IN OUT EFI_STRING *ResultsData,
628 IN BOOLEAN RetrieveData,
629 IN BROWSER_STORAGE *Storage
630 )
631 {
632 CHAR16 *ConfigResp;
633 EFI_STATUS Status;
634 CHAR16 *StrPtr;
635 UINTN BufferSize;
636 UINTN TmpSize;
637 UINTN MaxLen;
638 FORMSET_STORAGE *BrowserStorage;
639
640 if (RetrieveData) {
641 //
642 // Generate <ConfigResp>
643 //
644 Status = StorageToConfigResp (Storage, &ConfigResp, Storage->ConfigRequest, TRUE);
645 if (EFI_ERROR (Status)) {
646 return Status;
647 }
648
649 //
650 // Skip <ConfigHdr> and '&' to point to <ConfigBody> when first copy the configbody.
651 // Also need to consider add "\0" at first time.
652 //
653 StrPtr = StrStr (ConfigResp, L"PATH");
654 ASSERT (StrPtr != NULL);
655 StrPtr = StrStr (StrPtr, L"&");
656 StrPtr += 1;
657 BufferSize = StrSize (StrPtr);
658
659 //
660 // Copy the data if the input buffer is bigger enough.
661 //
662 if (*ResultsDataSize >= BufferSize) {
663 StrCpyS (*ResultsData, *ResultsDataSize / sizeof (CHAR16), StrPtr);
664 }
665
666 *ResultsDataSize = BufferSize;
667 FreePool (ConfigResp);
668 } else {
669 //
670 // Prepare <ConfigResp>
671 //
672 BrowserStorage = GetFstStgFromBrsStg (Storage);
673 ASSERT (BrowserStorage != NULL);
674 TmpSize = StrLen (*ResultsData);
675 BufferSize = (TmpSize + StrLen (BrowserStorage->ConfigHdr) + 2) * sizeof (CHAR16);
676 MaxLen = BufferSize / sizeof (CHAR16);
677 ConfigResp = AllocateZeroPool (BufferSize);
678 ASSERT (ConfigResp != NULL);
679
680 StrCpyS (ConfigResp, MaxLen, BrowserStorage->ConfigHdr);
681 StrCatS (ConfigResp, MaxLen, L"&");
682 StrCatS (ConfigResp, MaxLen, *ResultsData);
683
684 //
685 // Update Browser uncommited data
686 //
687 Status = ConfigRespToStorage (Storage, ConfigResp);
688 FreePool (ConfigResp);
689 if (EFI_ERROR (Status)) {
690 return Status;
691 }
692 }
693
694 return EFI_SUCCESS;
695 }
696
697 /**
698 This routine called this service in the browser to retrieve or set certain uncommitted
699 state information that resides in the open formsets.
700
701 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
702 instance.
703 @param ResultsDataSize A pointer to the size of the buffer associated
704 with ResultsData.
705 @param ResultsData A string returned from an IFR browser or
706 equivalent. The results string will have no
707 routing information in them.
708 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
709 (if RetrieveData = TRUE) data from the uncommitted
710 browser state information or set (if RetrieveData
711 = FALSE) data in the uncommitted browser state
712 information.
713 @param VariableGuid An optional field to indicate the target variable
714 GUID name to use.
715 @param VariableName An optional field to indicate the target
716 human-readable variable name.
717
718 @retval EFI_SUCCESS The results have been distributed or are awaiting
719 distribution.
720 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
721 contain the results data.
722
723 **/
724 EFI_STATUS
725 EFIAPI
726 BrowserCallback (
727 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
728 IN OUT UINTN *ResultsDataSize,
729 IN OUT EFI_STRING ResultsData,
730 IN BOOLEAN RetrieveData,
731 IN CONST EFI_GUID *VariableGuid, OPTIONAL
732 IN CONST CHAR16 *VariableName OPTIONAL
733 )
734 {
735 EFI_STATUS Status;
736 LIST_ENTRY *Link;
737 BROWSER_STORAGE *Storage;
738 FORMSET_STORAGE *FormsetStorage;
739 UINTN TotalSize;
740 BOOLEAN Found;
741
742 if (ResultsDataSize == NULL || ResultsData == NULL) {
743 return EFI_INVALID_PARAMETER;
744 }
745
746 TotalSize = *ResultsDataSize;
747 Storage = NULL;
748 Found = FALSE;
749 Status = EFI_SUCCESS;
750
751 if (VariableGuid != NULL) {
752 //
753 // Try to find target storage in the current formset.
754 //
755 Link = GetFirstNode (&gBrowserStorageList);
756 while (!IsNull (&gBrowserStorageList, Link)) {
757 Storage = BROWSER_STORAGE_FROM_LINK (Link);
758 Link = GetNextNode (&gBrowserStorageList, Link);
759 //
760 // Check the current storage.
761 //
762 if (!CompareGuid (&Storage->Guid, (EFI_GUID *) VariableGuid)) {
763 continue;
764 }
765
766 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
767 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
768 //
769 // Buffer storage require both GUID and Name
770 //
771 if (VariableName == NULL) {
772 return EFI_NOT_FOUND;
773 }
774
775 if (StrCmp (Storage->Name, (CHAR16 *) VariableName) != 0) {
776 continue;
777 }
778 }
779
780 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE ||
781 Storage->Type == EFI_HII_VARSTORE_BUFFER) {
782 if (mSystemLevelFormSet == NULL || mSystemLevelFormSet->HiiHandle == NULL) {
783 return EFI_NOT_FOUND;
784 }
785
786 if (Storage->HiiHandle != mSystemLevelFormSet->HiiHandle) {
787 continue;
788 }
789 }
790
791 Status = ProcessStorage (&TotalSize, &ResultsData, RetrieveData, Storage);
792 if (EFI_ERROR (Status)) {
793 return Status;
794 }
795
796 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
797 ConfigRequestAdjust (Storage, ResultsData, TRUE);
798 }
799
800 //
801 // Different formsets may have same varstore, so here just set the flag
802 // not exit the circle.
803 //
804 Found = TRUE;
805 break;
806 }
807
808 if (!Found) {
809 return EFI_NOT_FOUND;
810 }
811 } else {
812 //
813 // GUID/Name is not specified, take the first storage in FormSet
814 //
815 if (mSystemLevelFormSet == NULL) {
816 return EFI_NOT_READY;
817 }
818
819 //
820 // Generate <ConfigResp>
821 //
822 Link = GetFirstNode (&mSystemLevelFormSet->StorageListHead);
823 if (IsNull (&mSystemLevelFormSet->StorageListHead, Link)) {
824 return EFI_UNSUPPORTED;
825 }
826
827 FormsetStorage = FORMSET_STORAGE_FROM_LINK (Link);
828
829 Status = ProcessStorage (&TotalSize, &ResultsData, RetrieveData, FormsetStorage->BrowserStorage);
830 if (EFI_ERROR (Status)) {
831 return Status;
832 }
833 }
834
835 if (RetrieveData) {
836 Status = TotalSize <= *ResultsDataSize ? EFI_SUCCESS : EFI_BUFFER_TOO_SMALL;
837 *ResultsDataSize = TotalSize;
838 }
839
840 return Status;
841
842 }
843
844
845 /**
846 Callback function for SimpleTextInEx protocol install events
847
848 @param Event the event that is signaled.
849 @param Context not used here.
850
851 **/
852 VOID
853 EFIAPI
854 FormDisplayCallback (
855 IN EFI_EVENT Event,
856 IN VOID *Context
857 )
858 {
859 if (mFormDisplay != NULL) {
860 return;
861 }
862
863 gBS->LocateProtocol (
864 &gEdkiiFormDisplayEngineProtocolGuid,
865 NULL,
866 (VOID **) &mFormDisplay
867 );
868 }
869
870 /**
871 Initialize Setup Browser driver.
872
873 @param ImageHandle The image handle.
874 @param SystemTable The system table.
875
876 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
877 @return Other value if failed to initialize the Setup Browser module.
878
879 **/
880 EFI_STATUS
881 EFIAPI
882 InitializeSetup (
883 IN EFI_HANDLE ImageHandle,
884 IN EFI_SYSTEM_TABLE *SystemTable
885 )
886 {
887 EFI_STATUS Status;
888 VOID *Registration;
889
890 //
891 // Locate required Hii relative protocols
892 //
893 Status = gBS->LocateProtocol (
894 &gEfiHiiDatabaseProtocolGuid,
895 NULL,
896 (VOID **) &mHiiDatabase
897 );
898 ASSERT_EFI_ERROR (Status);
899
900 Status = gBS->LocateProtocol (
901 &gEfiHiiConfigRoutingProtocolGuid,
902 NULL,
903 (VOID **) &mHiiConfigRouting
904 );
905 ASSERT_EFI_ERROR (Status);
906
907 Status = gBS->LocateProtocol (
908 &gEfiDevicePathFromTextProtocolGuid,
909 NULL,
910 (VOID **) &mPathFromText
911 );
912
913 //
914 // Install FormBrowser2 protocol
915 //
916 mPrivateData.Handle = NULL;
917 Status = gBS->InstallProtocolInterface (
918 &mPrivateData.Handle,
919 &gEfiFormBrowser2ProtocolGuid,
920 EFI_NATIVE_INTERFACE,
921 &mPrivateData.FormBrowser2
922 );
923 ASSERT_EFI_ERROR (Status);
924
925 //
926 // Install FormBrowserEx2 protocol
927 //
928 InitializeListHead (&mPrivateData.FormBrowserEx2.FormViewHistoryHead);
929 InitializeListHead (&mPrivateData.FormBrowserEx2.OverrideQestListHead);
930 mPrivateData.Handle = NULL;
931 Status = gBS->InstallProtocolInterface (
932 &mPrivateData.Handle,
933 &gEdkiiFormBrowserEx2ProtocolGuid,
934 EFI_NATIVE_INTERFACE,
935 &mPrivateData.FormBrowserEx2
936 );
937 ASSERT_EFI_ERROR (Status);
938
939 Status = gBS->InstallProtocolInterface (
940 &mPrivateData.Handle,
941 &gEfiFormBrowserExProtocolGuid,
942 EFI_NATIVE_INTERFACE,
943 &mPrivateData.FormBrowserEx
944 );
945 ASSERT_EFI_ERROR (Status);
946
947 InitializeDisplayFormData ();
948
949 Status = gBS->LocateProtocol (
950 &gEdkiiFormDisplayEngineProtocolGuid,
951 NULL,
952 (VOID **) &mFormDisplay
953 );
954
955 if (EFI_ERROR (Status)) {
956 EfiCreateProtocolNotifyEvent (
957 &gEdkiiFormDisplayEngineProtocolGuid,
958 TPL_CALLBACK,
959 FormDisplayCallback,
960 NULL,
961 &Registration
962 );
963 }
964
965 return EFI_SUCCESS;
966 }
967
968
969 /**
970 Create a new string in HII Package List.
971
972 @param String The String to be added
973 @param HiiHandle The package list in the HII database to insert the
974 specified string.
975
976 @return The output string.
977
978 **/
979 EFI_STRING_ID
980 NewString (
981 IN CHAR16 *String,
982 IN EFI_HII_HANDLE HiiHandle
983 )
984 {
985 EFI_STRING_ID StringId;
986
987 StringId = HiiSetString (HiiHandle, 0, String, NULL);
988 ASSERT (StringId != 0);
989
990 return StringId;
991 }
992
993
994 /**
995 Delete a string from HII Package List.
996
997 @param StringId Id of the string in HII database.
998 @param HiiHandle The HII package list handle.
999
1000 @retval EFI_SUCCESS The string was deleted successfully.
1001
1002 **/
1003 EFI_STATUS
1004 DeleteString (
1005 IN EFI_STRING_ID StringId,
1006 IN EFI_HII_HANDLE HiiHandle
1007 )
1008 {
1009 CHAR16 NullChar;
1010
1011 NullChar = CHAR_NULL;
1012 HiiSetString (HiiHandle, StringId, &NullChar, NULL);
1013 return EFI_SUCCESS;
1014 }
1015
1016
1017 /**
1018 Get the string based on the StringId and HII Package List Handle.
1019
1020 @param Token The String's ID.
1021 @param HiiHandle The package list in the HII database to search for
1022 the specified string.
1023
1024 @return The output string.
1025
1026 **/
1027 CHAR16 *
1028 GetToken (
1029 IN EFI_STRING_ID Token,
1030 IN EFI_HII_HANDLE HiiHandle
1031 )
1032 {
1033 EFI_STRING String;
1034
1035 if (HiiHandle == NULL) {
1036 return NULL;
1037 }
1038
1039 String = HiiGetString (HiiHandle, Token, NULL);
1040 if (String == NULL) {
1041 String = AllocateCopyPool (StrSize (mUnknownString), mUnknownString);
1042 ASSERT (String != NULL);
1043 }
1044 return (CHAR16 *) String;
1045 }
1046
1047
1048 /**
1049 Allocate new memory and then copy the Unicode string Source to Destination.
1050
1051 @param Dest Location to copy string
1052 @param Src String to copy
1053
1054 **/
1055 VOID
1056 NewStringCpy (
1057 IN OUT CHAR16 **Dest,
1058 IN CHAR16 *Src
1059 )
1060 {
1061 if (*Dest != NULL) {
1062 FreePool (*Dest);
1063 }
1064 *Dest = AllocateCopyPool (StrSize (Src), Src);
1065 ASSERT (*Dest != NULL);
1066 }
1067
1068
1069 /**
1070 Allocate new memory and concatinate Source on the end of Destination.
1071
1072 @param Dest String to added to the end of.
1073 @param Src String to concatinate.
1074
1075 **/
1076 VOID
1077 NewStringCat (
1078 IN OUT CHAR16 **Dest,
1079 IN CHAR16 *Src
1080 )
1081 {
1082 CHAR16 *NewString;
1083 UINTN MaxLen;
1084
1085 if (*Dest == NULL) {
1086 NewStringCpy (Dest, Src);
1087 return;
1088 }
1089
1090 MaxLen = ( StrSize (*Dest) + StrSize (Src) - 1) / sizeof (CHAR16);
1091 NewString = AllocateZeroPool (MaxLen * sizeof (CHAR16));
1092 ASSERT (NewString != NULL);
1093
1094 StrCpyS (NewString, MaxLen, *Dest);
1095 StrCatS (NewString, MaxLen, Src);
1096
1097 FreePool (*Dest);
1098 *Dest = NewString;
1099 }
1100
1101 /**
1102 Get Value for given Name from a NameValue Storage.
1103
1104 @param Storage The NameValue Storage.
1105 @param Name The Name.
1106 @param Value The retured Value.
1107 @param GetValueFrom Where to get source value, from EditValue or Value.
1108
1109 @retval EFI_SUCCESS Value found for given Name.
1110 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
1111
1112 **/
1113 EFI_STATUS
1114 GetValueByName (
1115 IN BROWSER_STORAGE *Storage,
1116 IN CHAR16 *Name,
1117 IN OUT CHAR16 **Value,
1118 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
1119 )
1120 {
1121 LIST_ENTRY *Link;
1122 NAME_VALUE_NODE *Node;
1123
1124 if (GetValueFrom != GetSetValueWithEditBuffer && GetValueFrom != GetSetValueWithBuffer) {
1125 return EFI_INVALID_PARAMETER;
1126 }
1127
1128 *Value = NULL;
1129
1130 Link = GetFirstNode (&Storage->NameValueListHead);
1131 while (!IsNull (&Storage->NameValueListHead, Link)) {
1132 Node = NAME_VALUE_NODE_FROM_LINK (Link);
1133
1134 if (StrCmp (Name, Node->Name) == 0) {
1135 if (GetValueFrom == GetSetValueWithEditBuffer) {
1136 NewStringCpy (Value, Node->EditValue);
1137 } else {
1138 NewStringCpy (Value, Node->Value);
1139 }
1140 return EFI_SUCCESS;
1141 }
1142
1143 Link = GetNextNode (&Storage->NameValueListHead, Link);
1144 }
1145
1146 return EFI_NOT_FOUND;
1147 }
1148
1149
1150 /**
1151 Set Value of given Name in a NameValue Storage.
1152
1153 @param Storage The NameValue Storage.
1154 @param Name The Name.
1155 @param Value The Value to set.
1156 @param SetValueTo Whether update editValue or Value.
1157 @param ReturnNode The node use the input name.
1158
1159 @retval EFI_SUCCESS Value found for given Name.
1160 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
1161
1162 **/
1163 EFI_STATUS
1164 SetValueByName (
1165 IN BROWSER_STORAGE *Storage,
1166 IN CHAR16 *Name,
1167 IN CHAR16 *Value,
1168 IN GET_SET_QUESTION_VALUE_WITH SetValueTo,
1169 OUT NAME_VALUE_NODE **ReturnNode
1170 )
1171 {
1172 LIST_ENTRY *Link;
1173 NAME_VALUE_NODE *Node;
1174 CHAR16 *Buffer;
1175
1176 if (SetValueTo != GetSetValueWithEditBuffer && SetValueTo != GetSetValueWithBuffer) {
1177 return EFI_INVALID_PARAMETER;
1178 }
1179
1180 Link = GetFirstNode (&Storage->NameValueListHead);
1181 while (!IsNull (&Storage->NameValueListHead, Link)) {
1182 Node = NAME_VALUE_NODE_FROM_LINK (Link);
1183
1184 if (StrCmp (Name, Node->Name) == 0) {
1185 if (SetValueTo == GetSetValueWithEditBuffer) {
1186 Buffer = Node->EditValue;
1187 } else {
1188 Buffer = Node->Value;
1189 }
1190 if (Buffer != NULL) {
1191 FreePool (Buffer);
1192 }
1193 Buffer = AllocateCopyPool (StrSize (Value), Value);
1194 ASSERT (Buffer != NULL);
1195 if (SetValueTo == GetSetValueWithEditBuffer) {
1196 Node->EditValue = Buffer;
1197 } else {
1198 Node->Value = Buffer;
1199 }
1200
1201 if (ReturnNode != NULL) {
1202 *ReturnNode = Node;
1203 }
1204
1205 return EFI_SUCCESS;
1206 }
1207
1208 Link = GetNextNode (&Storage->NameValueListHead, Link);
1209 }
1210
1211 return EFI_NOT_FOUND;
1212 }
1213
1214
1215 /**
1216 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1217
1218 @param Storage The Storage to be conveted.
1219 @param ConfigResp The returned <ConfigResp>.
1220 @param ConfigRequest The ConfigRequest string.
1221 @param GetEditBuf Get the data from editbuffer or buffer.
1222
1223 @retval EFI_SUCCESS Convert success.
1224 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1225
1226 **/
1227 EFI_STATUS
1228 StorageToConfigResp (
1229 IN BROWSER_STORAGE *Storage,
1230 IN CHAR16 **ConfigResp,
1231 IN CHAR16 *ConfigRequest,
1232 IN BOOLEAN GetEditBuf
1233 )
1234 {
1235 EFI_STATUS Status;
1236 EFI_STRING Progress;
1237 LIST_ENTRY *Link;
1238 NAME_VALUE_NODE *Node;
1239 UINT8 *SourceBuf;
1240 FORMSET_STORAGE *FormsetStorage;
1241
1242 Status = EFI_SUCCESS;
1243
1244 switch (Storage->Type) {
1245 case EFI_HII_VARSTORE_BUFFER:
1246 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
1247 SourceBuf = GetEditBuf ? Storage->EditBuffer : Storage->Buffer;
1248 Status = mHiiConfigRouting->BlockToConfig (
1249 mHiiConfigRouting,
1250 ConfigRequest,
1251 SourceBuf,
1252 Storage->Size,
1253 ConfigResp,
1254 &Progress
1255 );
1256 break;
1257
1258 case EFI_HII_VARSTORE_NAME_VALUE:
1259 *ConfigResp = NULL;
1260 FormsetStorage = GetFstStgFromBrsStg(Storage);
1261 ASSERT (FormsetStorage != NULL);
1262 NewStringCat (ConfigResp, FormsetStorage->ConfigHdr);
1263
1264 Link = GetFirstNode (&Storage->NameValueListHead);
1265 while (!IsNull (&Storage->NameValueListHead, Link)) {
1266 Node = NAME_VALUE_NODE_FROM_LINK (Link);
1267
1268 if (StrStr (ConfigRequest, Node->Name) != NULL) {
1269 NewStringCat (ConfigResp, L"&");
1270 NewStringCat (ConfigResp, Node->Name);
1271 NewStringCat (ConfigResp, L"=");
1272 if (GetEditBuf) {
1273 NewStringCat (ConfigResp, Node->EditValue);
1274 } else {
1275 NewStringCat (ConfigResp, Node->Value);
1276 }
1277 }
1278 Link = GetNextNode (&Storage->NameValueListHead, Link);
1279 }
1280 break;
1281
1282 case EFI_HII_VARSTORE_EFI_VARIABLE:
1283 default:
1284 Status = EFI_INVALID_PARAMETER;
1285 break;
1286 }
1287
1288 return Status;
1289 }
1290
1291
1292 /**
1293 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1294
1295 @param Storage The Storage to receive the settings.
1296 @param ConfigResp The <ConfigResp> to be converted.
1297
1298 @retval EFI_SUCCESS Convert success.
1299 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1300
1301 **/
1302 EFI_STATUS
1303 ConfigRespToStorage (
1304 IN BROWSER_STORAGE *Storage,
1305 IN CHAR16 *ConfigResp
1306 )
1307 {
1308 EFI_STATUS Status;
1309 EFI_STRING Progress;
1310 UINTN BufferSize;
1311 CHAR16 *StrPtr;
1312 CHAR16 *Name;
1313 CHAR16 *Value;
1314
1315 Status = EFI_SUCCESS;
1316
1317 switch (Storage->Type) {
1318 case EFI_HII_VARSTORE_BUFFER:
1319 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
1320 BufferSize = Storage->Size;
1321 Status = mHiiConfigRouting->ConfigToBlock (
1322 mHiiConfigRouting,
1323 ConfigResp,
1324 Storage->EditBuffer,
1325 &BufferSize,
1326 &Progress
1327 );
1328 break;
1329
1330 case EFI_HII_VARSTORE_NAME_VALUE:
1331 StrPtr = StrStr (ConfigResp, L"PATH");
1332 if (StrPtr == NULL) {
1333 break;
1334 }
1335 StrPtr = StrStr (ConfigResp, L"&");
1336 while (StrPtr != NULL) {
1337 //
1338 // Skip '&'
1339 //
1340 StrPtr = StrPtr + 1;
1341 Name = StrPtr;
1342 StrPtr = StrStr (StrPtr, L"=");
1343 if (StrPtr == NULL) {
1344 break;
1345 }
1346 *StrPtr = 0;
1347
1348 //
1349 // Skip '='
1350 //
1351 StrPtr = StrPtr + 1;
1352 Value = StrPtr;
1353 StrPtr = StrStr (StrPtr, L"&");
1354 if (StrPtr != NULL) {
1355 *StrPtr = 0;
1356 }
1357 SetValueByName (Storage, Name, Value, GetSetValueWithEditBuffer, NULL);
1358 }
1359 break;
1360
1361 case EFI_HII_VARSTORE_EFI_VARIABLE:
1362 default:
1363 Status = EFI_INVALID_PARAMETER;
1364 break;
1365 }
1366
1367 return Status;
1368 }
1369
1370 /**
1371 Convert the buffer value to HiiValue.
1372
1373 @param Question The question.
1374 @param Value Unicode buffer save the question value.
1375
1376 @retval Status whether convert the value success.
1377
1378 **/
1379 EFI_STATUS
1380 BufferToValue (
1381 IN OUT FORM_BROWSER_STATEMENT *Question,
1382 IN CHAR16 *Value
1383 )
1384 {
1385 CHAR16 *StringPtr;
1386 BOOLEAN IsBufferStorage;
1387 CHAR16 *DstBuf;
1388 CHAR16 TempChar;
1389 UINTN LengthStr;
1390 UINT8 *Dst;
1391 CHAR16 TemStr[5];
1392 UINTN Index;
1393 UINT8 DigitUint8;
1394 BOOLEAN IsString;
1395 UINTN Length;
1396 EFI_STATUS Status;
1397
1398 IsString = (BOOLEAN) ((Question->HiiValue.Type == EFI_IFR_TYPE_STRING) ? TRUE : FALSE);
1399 if (Question->Storage->Type == EFI_HII_VARSTORE_BUFFER ||
1400 Question->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1401 IsBufferStorage = TRUE;
1402 } else {
1403 IsBufferStorage = FALSE;
1404 }
1405
1406 //
1407 // Question Value is provided by Buffer Storage or NameValue Storage
1408 //
1409 if (Question->BufferValue != NULL) {
1410 //
1411 // This Question is password or orderedlist
1412 //
1413 Dst = Question->BufferValue;
1414 } else {
1415 //
1416 // Other type of Questions
1417 //
1418 Dst = (UINT8 *) &Question->HiiValue.Value;
1419 }
1420
1421 //
1422 // Temp cut at the end of this section, end with '\0' or '&'.
1423 //
1424 StringPtr = Value;
1425 while (*StringPtr != L'\0' && *StringPtr != L'&') {
1426 StringPtr++;
1427 }
1428 TempChar = *StringPtr;
1429 *StringPtr = L'\0';
1430
1431 LengthStr = StrLen (Value);
1432 Status = EFI_SUCCESS;
1433 if (!IsBufferStorage && IsString) {
1434 //
1435 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1436 // Add string tail char L'\0' into Length
1437 //
1438 Length = Question->StorageWidth + sizeof (CHAR16);
1439 if (Length < ((LengthStr / 4 + 1) * 2)) {
1440 Status = EFI_BUFFER_TOO_SMALL;
1441 } else {
1442 DstBuf = (CHAR16 *) Dst;
1443 ZeroMem (TemStr, sizeof (TemStr));
1444 for (Index = 0; Index < LengthStr; Index += 4) {
1445 StrnCpyS (TemStr, sizeof (TemStr) / sizeof (CHAR16), Value + Index, 4);
1446 DstBuf[Index/4] = (CHAR16) StrHexToUint64 (TemStr);
1447 }
1448 //
1449 // Add tailing L'\0' character
1450 //
1451 DstBuf[Index/4] = L'\0';
1452 }
1453 } else {
1454 if (Question->StorageWidth < ((LengthStr + 1) / 2)) {
1455 Status = EFI_BUFFER_TOO_SMALL;
1456 } else {
1457 ZeroMem (TemStr, sizeof (TemStr));
1458 for (Index = 0; Index < LengthStr; Index ++) {
1459 TemStr[0] = Value[LengthStr - Index - 1];
1460 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
1461 if ((Index & 1) == 0) {
1462 Dst [Index/2] = DigitUint8;
1463 } else {
1464 Dst [Index/2] = (UINT8) ((DigitUint8 << 4) + Dst [Index/2]);
1465 }
1466 }
1467 }
1468 }
1469
1470 *StringPtr = TempChar;
1471
1472 return Status;
1473 }
1474
1475 /**
1476 Get Question's current Value.
1477
1478 @param FormSet FormSet data structure.
1479 @param Form Form data structure.
1480 @param Question Question to be initialized.
1481 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
1482
1483 @retval EFI_SUCCESS The function completed successfully.
1484
1485 **/
1486 EFI_STATUS
1487 GetQuestionValue (
1488 IN FORM_BROWSER_FORMSET *FormSet,
1489 IN FORM_BROWSER_FORM *Form,
1490 IN OUT FORM_BROWSER_STATEMENT *Question,
1491 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
1492 )
1493 {
1494 EFI_STATUS Status;
1495 BOOLEAN Enabled;
1496 BOOLEAN Pending;
1497 UINT8 *Dst;
1498 UINTN StorageWidth;
1499 EFI_TIME EfiTime;
1500 BROWSER_STORAGE *Storage;
1501 FORMSET_STORAGE *FormsetStorage;
1502 EFI_IFR_TYPE_VALUE *QuestionValue;
1503 CHAR16 *ConfigRequest;
1504 CHAR16 *Progress;
1505 CHAR16 *Result;
1506 CHAR16 *Value;
1507 UINTN Length;
1508 BOOLEAN IsBufferStorage;
1509 UINTN MaxLen;
1510
1511 Status = EFI_SUCCESS;
1512 Value = NULL;
1513 Result = NULL;
1514
1515 if (GetValueFrom >= GetSetValueWithMax) {
1516 return EFI_INVALID_PARAMETER;
1517 }
1518
1519 //
1520 // Question value is provided by an Expression, evaluate it
1521 //
1522 if (Question->ValueExpression != NULL) {
1523 Status = EvaluateExpression (FormSet, Form, Question->ValueExpression);
1524 if (!EFI_ERROR (Status)) {
1525 if (Question->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
1526 ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);
1527 if (Question->StorageWidth > Question->ValueExpression->Result.BufferLen) {
1528 CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->ValueExpression->Result.BufferLen);
1529 Question->HiiValue.BufferLen = Question->ValueExpression->Result.BufferLen;
1530 } else {
1531 CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->StorageWidth);
1532 Question->HiiValue.BufferLen = Question->StorageWidth;
1533 }
1534 FreePool (Question->ValueExpression->Result.Buffer);
1535 }
1536 Question->HiiValue.Type = Question->ValueExpression->Result.Type;
1537 CopyMem (&Question->HiiValue.Value, &Question->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
1538 }
1539 return Status;
1540 }
1541
1542 //
1543 // Get question value by read expression.
1544 //
1545 if (Question->ReadExpression != NULL && Form->FormType == STANDARD_MAP_FORM_TYPE) {
1546 Status = EvaluateExpression (FormSet, Form, Question->ReadExpression);
1547 if (!EFI_ERROR (Status) &&
1548 ((Question->ReadExpression->Result.Type < EFI_IFR_TYPE_OTHER) || (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER))) {
1549 //
1550 // Only update question value to the valid result.
1551 //
1552 if (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
1553 ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);
1554 if (Question->StorageWidth > Question->ReadExpression->Result.BufferLen) {
1555 CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->ReadExpression->Result.BufferLen);
1556 Question->HiiValue.BufferLen = Question->ReadExpression->Result.BufferLen;
1557 } else {
1558 CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->StorageWidth);
1559 Question->HiiValue.BufferLen = Question->StorageWidth;
1560 }
1561 FreePool (Question->ReadExpression->Result.Buffer);
1562 }
1563 Question->HiiValue.Type = Question->ReadExpression->Result.Type;
1564 CopyMem (&Question->HiiValue.Value, &Question->ReadExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
1565 return EFI_SUCCESS;
1566 }
1567 }
1568
1569 //
1570 // Question value is provided by RTC
1571 //
1572 Storage = Question->Storage;
1573 QuestionValue = &Question->HiiValue.Value;
1574 if (Storage == NULL) {
1575 //
1576 // It's a Question without storage, or RTC date/time
1577 //
1578 if (Question->Operand == EFI_IFR_DATE_OP || Question->Operand == EFI_IFR_TIME_OP) {
1579 //
1580 // Date and time define the same Flags bit
1581 //
1582 switch (Question->Flags & EFI_QF_DATE_STORAGE) {
1583 case QF_DATE_STORAGE_TIME:
1584 Status = gRT->GetTime (&EfiTime, NULL);
1585 break;
1586
1587 case QF_DATE_STORAGE_WAKEUP:
1588 Status = gRT->GetWakeupTime (&Enabled, &Pending, &EfiTime);
1589 break;
1590
1591 case QF_DATE_STORAGE_NORMAL:
1592 default:
1593 //
1594 // For date/time without storage
1595 //
1596 return EFI_SUCCESS;
1597 }
1598
1599 if (EFI_ERROR (Status)) {
1600 if (Question->Operand == EFI_IFR_DATE_OP){
1601 QuestionValue->date.Year = 0xff;
1602 QuestionValue->date.Month = 0xff;
1603 QuestionValue->date.Day = 0xff;
1604 } else {
1605 QuestionValue->time.Hour = 0xff;
1606 QuestionValue->time.Minute = 0xff;
1607 QuestionValue->time.Second = 0xff;
1608 }
1609 return EFI_SUCCESS;
1610 }
1611
1612 if (Question->Operand == EFI_IFR_DATE_OP) {
1613 QuestionValue->date.Year = EfiTime.Year;
1614 QuestionValue->date.Month = EfiTime.Month;
1615 QuestionValue->date.Day = EfiTime.Day;
1616 } else {
1617 QuestionValue->time.Hour = EfiTime.Hour;
1618 QuestionValue->time.Minute = EfiTime.Minute;
1619 QuestionValue->time.Second = EfiTime.Second;
1620 }
1621 }
1622
1623 return EFI_SUCCESS;
1624 }
1625
1626 //
1627 // Question value is provided by EFI variable
1628 //
1629 StorageWidth = Question->StorageWidth;
1630 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
1631 if (Question->BufferValue != NULL) {
1632 Dst = Question->BufferValue;
1633 } else {
1634 Dst = (UINT8 *) QuestionValue;
1635 }
1636
1637 Status = gRT->GetVariable (
1638 Question->VariableName,
1639 &Storage->Guid,
1640 NULL,
1641 &StorageWidth,
1642 Dst
1643 );
1644 //
1645 // Always return success, even this EFI variable doesn't exist
1646 //
1647 return EFI_SUCCESS;
1648 }
1649
1650 //
1651 // Question Value is provided by Buffer Storage or NameValue Storage
1652 //
1653 if (Question->BufferValue != NULL) {
1654 //
1655 // This Question is password or orderedlist
1656 //
1657 Dst = Question->BufferValue;
1658 } else {
1659 //
1660 // Other type of Questions
1661 //
1662 Dst = (UINT8 *) &Question->HiiValue.Value;
1663 }
1664
1665 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
1666 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1667 IsBufferStorage = TRUE;
1668 } else {
1669 IsBufferStorage = FALSE;
1670 }
1671 if (GetValueFrom == GetSetValueWithEditBuffer || GetValueFrom == GetSetValueWithBuffer ) {
1672 if (IsBufferStorage) {
1673 if (GetValueFrom == GetSetValueWithEditBuffer) {
1674 //
1675 // Copy from storage Edit buffer
1676 //
1677 CopyMem (Dst, Storage->EditBuffer + Question->VarStoreInfo.VarOffset, StorageWidth);
1678 } else {
1679 //
1680 // Copy from storage Edit buffer
1681 //
1682 CopyMem (Dst, Storage->Buffer + Question->VarStoreInfo.VarOffset, StorageWidth);
1683 }
1684 } else {
1685 Value = NULL;
1686 Status = GetValueByName (Storage, Question->VariableName, &Value, GetValueFrom);
1687 if (EFI_ERROR (Status)) {
1688 return Status;
1689 }
1690
1691 ASSERT (Value != NULL);
1692 Status = BufferToValue (Question, Value);
1693 FreePool (Value);
1694 }
1695 } else {
1696 FormsetStorage = GetFstStgFromVarId(FormSet, Question->VarStoreId);
1697 ASSERT (FormsetStorage != NULL);
1698 //
1699 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
1700 // <ConfigHdr> + "&" + <VariableName>
1701 //
1702 if (IsBufferStorage) {
1703 Length = StrLen (FormsetStorage->ConfigHdr);
1704 Length += StrLen (Question->BlockName);
1705 } else {
1706 Length = StrLen (FormsetStorage->ConfigHdr);
1707 Length += StrLen (Question->VariableName) + 1;
1708 }
1709 // Allocate buffer include '\0'
1710 MaxLen = Length + 1;
1711 ConfigRequest = AllocateZeroPool (MaxLen * sizeof (CHAR16));
1712 ASSERT (ConfigRequest != NULL);
1713
1714 StrCpyS (ConfigRequest, MaxLen, FormsetStorage->ConfigHdr);
1715 if (IsBufferStorage) {
1716 StrCatS (ConfigRequest, MaxLen, Question->BlockName);
1717 } else {
1718 StrCatS (ConfigRequest, MaxLen, L"&");
1719 StrCatS (ConfigRequest, MaxLen, Question->VariableName);
1720 }
1721
1722 //
1723 // Request current settings from Configuration Driver
1724 //
1725 Status = mHiiConfigRouting->ExtractConfig (
1726 mHiiConfigRouting,
1727 ConfigRequest,
1728 &Progress,
1729 &Result
1730 );
1731 FreePool (ConfigRequest);
1732 if (EFI_ERROR (Status)) {
1733 return Status;
1734 }
1735
1736 //
1737 // Skip <ConfigRequest>
1738 //
1739 if (IsBufferStorage) {
1740 Value = StrStr (Result, L"&VALUE");
1741 if (Value == NULL) {
1742 FreePool (Result);
1743 return EFI_NOT_FOUND;
1744 }
1745 //
1746 // Skip "&VALUE"
1747 //
1748 Value = Value + 6;
1749 } else {
1750 Value = Result + Length;
1751 }
1752 if (*Value != '=') {
1753 FreePool (Result);
1754 return EFI_NOT_FOUND;
1755 }
1756 //
1757 // Skip '=', point to value
1758 //
1759 Value = Value + 1;
1760
1761 Status = BufferToValue (Question, Value);
1762 if (EFI_ERROR (Status)) {
1763 FreePool (Result);
1764 return Status;
1765 }
1766
1767 //
1768 // Synchronize Edit Buffer
1769 //
1770 if (IsBufferStorage) {
1771 CopyMem (Storage->EditBuffer + Question->VarStoreInfo.VarOffset, Dst, StorageWidth);
1772 } else {
1773 SetValueByName (Storage, Question->VariableName, Value, GetSetValueWithEditBuffer, NULL);
1774 }
1775
1776 if (Result != NULL) {
1777 FreePool (Result);
1778 }
1779 }
1780
1781 return Status;
1782 }
1783
1784
1785 /**
1786 Save Question Value to edit copy(cached) or Storage(uncached).
1787
1788 @param FormSet FormSet data structure.
1789 @param Form Form data structure.
1790 @param Question Pointer to the Question.
1791 @param SetValueTo Update the question value to editbuffer , buffer or hii driver.
1792
1793 @retval EFI_SUCCESS The function completed successfully.
1794
1795 **/
1796 EFI_STATUS
1797 SetQuestionValue (
1798 IN FORM_BROWSER_FORMSET *FormSet,
1799 IN FORM_BROWSER_FORM *Form,
1800 IN OUT FORM_BROWSER_STATEMENT *Question,
1801 IN GET_SET_QUESTION_VALUE_WITH SetValueTo
1802 )
1803 {
1804 EFI_STATUS Status;
1805 BOOLEAN Enabled;
1806 BOOLEAN Pending;
1807 UINT8 *Src;
1808 EFI_TIME EfiTime;
1809 UINTN BufferLen;
1810 UINTN StorageWidth;
1811 BROWSER_STORAGE *Storage;
1812 FORMSET_STORAGE *FormsetStorage;
1813 EFI_IFR_TYPE_VALUE *QuestionValue;
1814 CHAR16 *ConfigResp;
1815 CHAR16 *Progress;
1816 CHAR16 *Value;
1817 UINTN Length;
1818 BOOLEAN IsBufferStorage;
1819 BOOLEAN IsString;
1820 UINT8 *TemBuffer;
1821 CHAR16 *TemName;
1822 CHAR16 *TemString;
1823 UINTN Index;
1824 NAME_VALUE_NODE *Node;
1825 UINTN MaxLen;
1826
1827 Status = EFI_SUCCESS;
1828 Node = NULL;
1829
1830 if (SetValueTo >= GetSetValueWithMax) {
1831 return EFI_INVALID_PARAMETER;
1832 }
1833
1834 //
1835 // If Question value is provided by an Expression, then it is read only
1836 //
1837 if (Question->ValueExpression != NULL) {
1838 return Status;
1839 }
1840
1841 //
1842 // Before set question value, evaluate its write expression.
1843 //
1844 if (Question->WriteExpression != NULL && Form->FormType == STANDARD_MAP_FORM_TYPE) {
1845 Status = EvaluateExpression (FormSet, Form, Question->WriteExpression);
1846 if (EFI_ERROR (Status)) {
1847 return Status;
1848 }
1849 }
1850
1851 //
1852 // Question value is provided by RTC
1853 //
1854 Storage = Question->Storage;
1855 QuestionValue = &Question->HiiValue.Value;
1856 if (Storage == NULL) {
1857 //
1858 // It's a Question without storage, or RTC date/time
1859 //
1860 if (Question->Operand == EFI_IFR_DATE_OP || Question->Operand == EFI_IFR_TIME_OP) {
1861 //
1862 // Date and time define the same Flags bit
1863 //
1864 switch (Question->Flags & EFI_QF_DATE_STORAGE) {
1865 case QF_DATE_STORAGE_TIME:
1866 Status = gRT->GetTime (&EfiTime, NULL);
1867 break;
1868
1869 case QF_DATE_STORAGE_WAKEUP:
1870 Status = gRT->GetWakeupTime (&Enabled, &Pending, &EfiTime);
1871 break;
1872
1873 case QF_DATE_STORAGE_NORMAL:
1874 default:
1875 //
1876 // For date/time without storage
1877 //
1878 return EFI_SUCCESS;
1879 }
1880
1881 if (EFI_ERROR (Status)) {
1882 return Status;
1883 }
1884
1885 if (Question->Operand == EFI_IFR_DATE_OP) {
1886 EfiTime.Year = QuestionValue->date.Year;
1887 EfiTime.Month = QuestionValue->date.Month;
1888 EfiTime.Day = QuestionValue->date.Day;
1889 } else {
1890 EfiTime.Hour = QuestionValue->time.Hour;
1891 EfiTime.Minute = QuestionValue->time.Minute;
1892 EfiTime.Second = QuestionValue->time.Second;
1893 }
1894
1895 if ((Question->Flags & EFI_QF_DATE_STORAGE) == QF_DATE_STORAGE_TIME) {
1896 Status = gRT->SetTime (&EfiTime);
1897 } else {
1898 Status = gRT->SetWakeupTime (TRUE, &EfiTime);
1899 }
1900 }
1901
1902 return Status;
1903 }
1904
1905 //
1906 // Question value is provided by EFI variable
1907 //
1908 StorageWidth = Question->StorageWidth;
1909 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
1910 if (Question->BufferValue != NULL) {
1911 Src = Question->BufferValue;
1912 } else {
1913 Src = (UINT8 *) QuestionValue;
1914 }
1915
1916 Status = gRT->SetVariable (
1917 Question->VariableName,
1918 &Storage->Guid,
1919 Storage->Attributes,
1920 StorageWidth,
1921 Src
1922 );
1923 return Status;
1924 }
1925
1926 //
1927 // Question Value is provided by Buffer Storage or NameValue Storage
1928 //
1929 if (Question->BufferValue != NULL) {
1930 Src = Question->BufferValue;
1931 } else {
1932 Src = (UINT8 *) &Question->HiiValue.Value;
1933 }
1934
1935 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
1936 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1937 IsBufferStorage = TRUE;
1938 } else {
1939 IsBufferStorage = FALSE;
1940 }
1941 IsString = (BOOLEAN) ((Question->HiiValue.Type == EFI_IFR_TYPE_STRING) ? TRUE : FALSE);
1942
1943 if (SetValueTo == GetSetValueWithEditBuffer || SetValueTo == GetSetValueWithBuffer) {
1944 if (IsBufferStorage) {
1945 if (SetValueTo == GetSetValueWithEditBuffer) {
1946 //
1947 // Copy to storage edit buffer
1948 //
1949 CopyMem (Storage->EditBuffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
1950 } else if (SetValueTo == GetSetValueWithBuffer) {
1951 //
1952 // Copy to storage edit buffer
1953 //
1954 CopyMem (Storage->Buffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
1955 }
1956 } else {
1957 if (IsString) {
1958 //
1959 // Allocate enough string buffer.
1960 //
1961 Value = NULL;
1962 BufferLen = ((StrLen ((CHAR16 *) Src) * 4) + 1) * sizeof (CHAR16);
1963 Value = AllocateZeroPool (BufferLen);
1964 ASSERT (Value != NULL);
1965 //
1966 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1967 //
1968 TemName = (CHAR16 *) Src;
1969 TemString = Value;
1970 for (; *TemName != L'\0'; TemName++) {
1971 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemName, 4);
1972 }
1973 } else {
1974 BufferLen = StorageWidth * 2 + 1;
1975 Value = AllocateZeroPool (BufferLen * sizeof (CHAR16));
1976 ASSERT (Value != NULL);
1977 //
1978 // Convert Buffer to Hex String
1979 //
1980 TemBuffer = Src + StorageWidth - 1;
1981 TemString = Value;
1982 for (Index = 0; Index < StorageWidth; Index ++, TemBuffer --) {
1983 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
1984 }
1985 }
1986
1987 Status = SetValueByName (Storage, Question->VariableName, Value, SetValueTo, &Node);
1988 FreePool (Value);
1989 if (EFI_ERROR (Status)) {
1990 return Status;
1991 }
1992 }
1993 } else if (SetValueTo == GetSetValueWithHiiDriver) {
1994 //
1995 // <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||
1996 // <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"
1997 //
1998 if (IsBufferStorage) {
1999 Length = StrLen (Question->BlockName) + 7;
2000 } else {
2001 Length = StrLen (Question->VariableName) + 2;
2002 }
2003 if (!IsBufferStorage && IsString) {
2004 Length += (StrLen ((CHAR16 *) Src) * 4);
2005 } else {
2006 Length += (StorageWidth * 2);
2007 }
2008 FormsetStorage = GetFstStgFromVarId(FormSet, Question->VarStoreId);
2009 ASSERT (FormsetStorage != NULL);
2010 MaxLen = StrLen (FormsetStorage->ConfigHdr) + Length + 1;
2011 ConfigResp = AllocateZeroPool (MaxLen * sizeof (CHAR16));
2012 ASSERT (ConfigResp != NULL);
2013
2014 StrCpyS (ConfigResp, MaxLen, FormsetStorage->ConfigHdr);
2015 if (IsBufferStorage) {
2016 StrCatS (ConfigResp, MaxLen, Question->BlockName);
2017 StrCatS (ConfigResp, MaxLen, L"&VALUE=");
2018 } else {
2019 StrCatS (ConfigResp, MaxLen, L"&");
2020 StrCatS (ConfigResp, MaxLen, Question->VariableName);
2021 StrCatS (ConfigResp, MaxLen, L"=");
2022 }
2023
2024 Value = ConfigResp + StrLen (ConfigResp);
2025
2026 if (!IsBufferStorage && IsString) {
2027 //
2028 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
2029 //
2030 TemName = (CHAR16 *) Src;
2031 TemString = Value;
2032 for (; *TemName != L'\0'; TemName++) {
2033 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemName, 4);
2034 }
2035 } else {
2036 //
2037 // Convert Buffer to Hex String
2038 //
2039 TemBuffer = Src + StorageWidth - 1;
2040 TemString = Value;
2041 for (Index = 0; Index < StorageWidth; Index ++, TemBuffer --) {
2042 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
2043 }
2044 }
2045
2046 //
2047 // Convert to lower char.
2048 //
2049 for (TemString = Value; *Value != L'\0'; Value++) {
2050 if (*Value >= L'A' && *Value <= L'Z') {
2051 *Value = (CHAR16) (*Value - L'A' + L'a');
2052 }
2053 }
2054
2055 //
2056 // Submit Question Value to Configuration Driver
2057 //
2058 Status = mHiiConfigRouting->RouteConfig (
2059 mHiiConfigRouting,
2060 ConfigResp,
2061 &Progress
2062 );
2063 if (EFI_ERROR (Status)) {
2064 FreePool (ConfigResp);
2065 return Status;
2066 }
2067 FreePool (ConfigResp);
2068
2069 //
2070 // Sync storage, from editbuffer to buffer.
2071 //
2072 CopyMem (Storage->Buffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
2073 }
2074
2075 return Status;
2076 }
2077
2078
2079 /**
2080 Perform nosubmitif check for a Form.
2081
2082 @param FormSet FormSet data structure.
2083 @param Form Form data structure.
2084 @param Question The Question to be validated.
2085 @param Type Validation type: NoSubmit
2086
2087 @retval EFI_SUCCESS Form validation pass.
2088 @retval other Form validation failed.
2089
2090 **/
2091 EFI_STATUS
2092 ValidateQuestion (
2093 IN FORM_BROWSER_FORMSET *FormSet,
2094 IN FORM_BROWSER_FORM *Form,
2095 IN FORM_BROWSER_STATEMENT *Question,
2096 IN UINTN Type
2097 )
2098 {
2099 EFI_STATUS Status;
2100 LIST_ENTRY *Link;
2101 LIST_ENTRY *ListHead;
2102 FORM_EXPRESSION *Expression;
2103 UINT32 BrowserStatus;
2104 CHAR16 *ErrorStr;
2105
2106 BrowserStatus = BROWSER_SUCCESS;
2107 ErrorStr = NULL;
2108
2109 switch (Type) {
2110 case EFI_HII_EXPRESSION_INCONSISTENT_IF:
2111 ListHead = &Question->InconsistentListHead;
2112 break;
2113
2114 case EFI_HII_EXPRESSION_WARNING_IF:
2115 ListHead = &Question->WarningListHead;
2116 break;
2117
2118 case EFI_HII_EXPRESSION_NO_SUBMIT_IF:
2119 ListHead = &Question->NoSubmitListHead;
2120 break;
2121
2122 default:
2123 ASSERT (FALSE);
2124 return EFI_UNSUPPORTED;
2125 }
2126
2127 Link = GetFirstNode (ListHead);
2128 while (!IsNull (ListHead, Link)) {
2129 Expression = FORM_EXPRESSION_FROM_LINK (Link);
2130
2131 //
2132 // Evaluate the expression
2133 //
2134 Status = EvaluateExpression (FormSet, Form, Expression);
2135 if (EFI_ERROR (Status)) {
2136 return Status;
2137 }
2138
2139 if (IsTrue (&Expression->Result)) {
2140 switch (Type) {
2141 case EFI_HII_EXPRESSION_INCONSISTENT_IF:
2142 BrowserStatus = BROWSER_INCONSISTENT_IF;
2143 break;
2144
2145 case EFI_HII_EXPRESSION_WARNING_IF:
2146 BrowserStatus = BROWSER_WARNING_IF;
2147 break;
2148
2149 case EFI_HII_EXPRESSION_NO_SUBMIT_IF:
2150 BrowserStatus = BROWSER_NO_SUBMIT_IF;
2151 //
2152 // This code only used to compatible with old display engine,
2153 // New display engine will not use this field.
2154 //
2155 if (Expression->Error != 0) {
2156 ErrorStr = GetToken (Expression->Error, FormSet->HiiHandle);
2157 }
2158 break;
2159
2160 default:
2161 ASSERT (FALSE);
2162 break;
2163 }
2164
2165 if (!((Type == EFI_HII_EXPRESSION_NO_SUBMIT_IF) && mSystemSubmit)) {
2166 //
2167 // If in system submit process and for no_submit_if check, not popup this error message.
2168 // Will process this fail again later in not system submit process.
2169 //
2170 PopupErrorMessage(BrowserStatus, FormSet->HiiHandle, Expression->OpCode, ErrorStr);
2171 }
2172
2173 if (ErrorStr != NULL) {
2174 FreePool (ErrorStr);
2175 }
2176
2177 if (Type == EFI_HII_EXPRESSION_WARNING_IF) {
2178 return EFI_SUCCESS;
2179 } else {
2180 return EFI_NOT_READY;
2181 }
2182 }
2183
2184 Link = GetNextNode (ListHead, Link);
2185 }
2186
2187 return EFI_SUCCESS;
2188 }
2189
2190 /**
2191 Perform question check.
2192
2193 If one question has more than one check, process form high priority to low.
2194 Only one error info will be popup.
2195
2196 @param FormSet FormSet data structure.
2197 @param Form Form data structure.
2198 @param Question The Question to be validated.
2199
2200 @retval EFI_SUCCESS Form validation pass.
2201 @retval other Form validation failed.
2202
2203 **/
2204 EFI_STATUS
2205 ValueChangedValidation (
2206 IN FORM_BROWSER_FORMSET *FormSet,
2207 IN FORM_BROWSER_FORM *Form,
2208 IN FORM_BROWSER_STATEMENT *Question
2209 )
2210 {
2211 EFI_STATUS Status;
2212
2213 Status = EFI_SUCCESS;
2214
2215 //
2216 // Do the inconsistentif check.
2217 //
2218 if (!IsListEmpty (&Question->InconsistentListHead)) {
2219 Status = ValidateQuestion (FormSet, Form, Question, EFI_HII_EXPRESSION_INCONSISTENT_IF);
2220 if (EFI_ERROR (Status)) {
2221 return Status;
2222 }
2223 }
2224
2225 //
2226 // Do the warningif check.
2227 //
2228 if (!IsListEmpty (&Question->WarningListHead)) {
2229 Status = ValidateQuestion (FormSet, Form, Question, EFI_HII_EXPRESSION_WARNING_IF);
2230 }
2231
2232 return Status;
2233 }
2234
2235 /**
2236 Perform NoSubmit check for each Form in FormSet.
2237
2238 @param FormSet FormSet data structure.
2239 @param CurrentForm Current input form data structure.
2240 @param Statement The statement for this check.
2241
2242 @retval EFI_SUCCESS Form validation pass.
2243 @retval other Form validation failed.
2244
2245 **/
2246 EFI_STATUS
2247 NoSubmitCheck (
2248 IN FORM_BROWSER_FORMSET *FormSet,
2249 IN OUT FORM_BROWSER_FORM **CurrentForm,
2250 OUT FORM_BROWSER_STATEMENT **Statement
2251 )
2252 {
2253 EFI_STATUS Status;
2254 LIST_ENTRY *Link;
2255 FORM_BROWSER_STATEMENT *Question;
2256 FORM_BROWSER_FORM *Form;
2257 LIST_ENTRY *LinkForm;
2258
2259 LinkForm = GetFirstNode (&FormSet->FormListHead);
2260 while (!IsNull (&FormSet->FormListHead, LinkForm)) {
2261 Form = FORM_BROWSER_FORM_FROM_LINK (LinkForm);
2262 LinkForm = GetNextNode (&FormSet->FormListHead, LinkForm);
2263
2264 if (*CurrentForm != NULL && *CurrentForm != Form) {
2265 continue;
2266 }
2267
2268 Link = GetFirstNode (&Form->StatementListHead);
2269 while (!IsNull (&Form->StatementListHead, Link)) {
2270 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
2271 Status = ValidateQuestion (FormSet, Form, Question, EFI_HII_EXPRESSION_NO_SUBMIT_IF);
2272 if (EFI_ERROR (Status)) {
2273 if (*CurrentForm == NULL) {
2274 *CurrentForm = Form;
2275 }
2276 if (Statement != NULL) {
2277 *Statement = Question;
2278 }
2279 return Status;
2280 }
2281
2282 Link = GetNextNode (&Form->StatementListHead, Link);
2283 }
2284 }
2285
2286 return EFI_SUCCESS;
2287 }
2288
2289 /**
2290 Fill storage's edit copy with settings requested from Configuration Driver.
2291
2292 @param Storage The storage which need to sync.
2293 @param ConfigRequest The config request string which used to sync storage.
2294 @param SyncOrRestore Sync the buffer to editbuffer or Restore the
2295 editbuffer to buffer
2296 if TRUE, copy the editbuffer to the buffer.
2297 if FALSE, copy the buffer to the editbuffer.
2298
2299 @retval EFI_SUCCESS The function completed successfully.
2300
2301 **/
2302 EFI_STATUS
2303 SynchronizeStorage (
2304 OUT BROWSER_STORAGE *Storage,
2305 IN CHAR16 *ConfigRequest,
2306 IN BOOLEAN SyncOrRestore
2307 )
2308 {
2309 EFI_STATUS Status;
2310 EFI_STRING Progress;
2311 EFI_STRING Result;
2312 UINTN BufferSize;
2313 LIST_ENTRY *Link;
2314 NAME_VALUE_NODE *Node;
2315 UINT8 *Src;
2316 UINT8 *Dst;
2317
2318 Status = EFI_SUCCESS;
2319 Result = NULL;
2320
2321 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
2322 (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
2323 BufferSize = Storage->Size;
2324
2325 if (SyncOrRestore) {
2326 Src = Storage->EditBuffer;
2327 Dst = Storage->Buffer;
2328 } else {
2329 Src = Storage->Buffer;
2330 Dst = Storage->EditBuffer;
2331 }
2332
2333 if (ConfigRequest != NULL) {
2334 Status = mHiiConfigRouting->BlockToConfig(
2335 mHiiConfigRouting,
2336 ConfigRequest,
2337 Src,
2338 BufferSize,
2339 &Result,
2340 &Progress
2341 );
2342 if (EFI_ERROR (Status)) {
2343 return Status;
2344 }
2345
2346 Status = mHiiConfigRouting->ConfigToBlock (
2347 mHiiConfigRouting,
2348 Result,
2349 Dst,
2350 &BufferSize,
2351 &Progress
2352 );
2353 if (Result != NULL) {
2354 FreePool (Result);
2355 }
2356 } else {
2357 CopyMem (Dst, Src, BufferSize);
2358 }
2359 } else if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2360 Link = GetFirstNode (&Storage->NameValueListHead);
2361 while (!IsNull (&Storage->NameValueListHead, Link)) {
2362 Node = NAME_VALUE_NODE_FROM_LINK (Link);
2363
2364 if ((ConfigRequest != NULL && StrStr (ConfigRequest, Node->Name) != NULL) ||
2365 (ConfigRequest == NULL)) {
2366 if (SyncOrRestore) {
2367 NewStringCpy (&Node->Value, Node->EditValue);
2368 } else {
2369 NewStringCpy (&Node->EditValue, Node->Value);
2370 }
2371 }
2372
2373 Link = GetNextNode (&Storage->NameValueListHead, Link);
2374 }
2375 }
2376
2377 return Status;
2378 }
2379
2380 /**
2381 When discard the question value, call the callback function with Changed type
2382 to inform the hii driver.
2383
2384 @param FormSet FormSet data structure.
2385 @param Form Form data structure.
2386
2387 **/
2388 VOID
2389 SendDiscardInfoToDriver (
2390 IN FORM_BROWSER_FORMSET *FormSet,
2391 IN FORM_BROWSER_FORM *Form
2392 )
2393 {
2394 LIST_ENTRY *Link;
2395 FORM_BROWSER_STATEMENT *Question;
2396 EFI_IFR_TYPE_VALUE *TypeValue;
2397 EFI_BROWSER_ACTION_REQUEST ActionRequest;
2398
2399 if (FormSet->ConfigAccess == NULL) {
2400 return;
2401 }
2402
2403 Link = GetFirstNode (&Form->StatementListHead);
2404 while (!IsNull (&Form->StatementListHead, Link)) {
2405 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
2406 Link = GetNextNode (&Form->StatementListHead, Link);
2407
2408 if (Question->Storage == NULL || Question->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2409 continue;
2410 }
2411
2412 if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {
2413 continue;
2414 }
2415
2416 if (Question->Operand == EFI_IFR_PASSWORD_OP) {
2417 continue;
2418 }
2419
2420 if (!Question->ValueChanged) {
2421 continue;
2422 }
2423
2424 //
2425 // Restore the question value before call the CHANGED callback type.
2426 //
2427 GetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
2428
2429 if (Question->Operand == EFI_IFR_STRING_OP){
2430 HiiSetString (FormSet->HiiHandle, Question->HiiValue.Value.string, (CHAR16*)Question->BufferValue, NULL);
2431 }
2432
2433 if (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER) {
2434 TypeValue = (EFI_IFR_TYPE_VALUE *) Question->BufferValue;
2435 } else {
2436 TypeValue = &Question->HiiValue.Value;
2437 }
2438
2439 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
2440 FormSet->ConfigAccess->Callback (
2441 FormSet->ConfigAccess,
2442 EFI_BROWSER_ACTION_CHANGED,
2443 Question->QuestionId,
2444 Question->HiiValue.Type,
2445 TypeValue,
2446 &ActionRequest
2447 );
2448 }
2449 }
2450
2451 /**
2452 When submit the question value, call the callback function with Submitted type
2453 to inform the hii driver.
2454
2455 @param FormSet FormSet data structure.
2456 @param Form Form data structure.
2457
2458 **/
2459 VOID
2460 SubmitCallbackForForm (
2461 IN FORM_BROWSER_FORMSET *FormSet,
2462 IN FORM_BROWSER_FORM *Form
2463 )
2464 {
2465 LIST_ENTRY *Link;
2466 FORM_BROWSER_STATEMENT *Question;
2467 EFI_IFR_TYPE_VALUE *TypeValue;
2468 EFI_BROWSER_ACTION_REQUEST ActionRequest;
2469
2470 if (FormSet->ConfigAccess == NULL) {
2471 return;
2472 }
2473
2474 Link = GetFirstNode (&Form->StatementListHead);
2475 while (!IsNull (&Form->StatementListHead, Link)) {
2476 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
2477 Link = GetNextNode (&Form->StatementListHead, Link);
2478
2479 if (Question->Storage == NULL || Question->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2480 continue;
2481 }
2482
2483 if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != EFI_IFR_FLAG_CALLBACK) {
2484 continue;
2485 }
2486
2487 if (Question->Operand == EFI_IFR_PASSWORD_OP) {
2488 continue;
2489 }
2490
2491 if (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER) {
2492 TypeValue = (EFI_IFR_TYPE_VALUE *) Question->BufferValue;
2493 } else {
2494 TypeValue = &Question->HiiValue.Value;
2495 }
2496
2497 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
2498 FormSet->ConfigAccess->Callback (
2499 FormSet->ConfigAccess,
2500 EFI_BROWSER_ACTION_SUBMITTED,
2501 Question->QuestionId,
2502 Question->HiiValue.Type,
2503 TypeValue,
2504 &ActionRequest
2505 );
2506 }
2507 }
2508
2509 /**
2510 When value set Success, call the submit callback function.
2511
2512 @param FormSet FormSet data structure.
2513 @param Form Form data structure.
2514
2515 **/
2516 VOID
2517 SubmitCallback (
2518 IN FORM_BROWSER_FORMSET *FormSet,
2519 IN FORM_BROWSER_FORM *Form
2520 )
2521 {
2522 FORM_BROWSER_FORM *CurrentForm;
2523 LIST_ENTRY *Link;
2524
2525 if (Form != NULL) {
2526 SubmitCallbackForForm(FormSet, Form);
2527 return;
2528 }
2529
2530 Link = GetFirstNode (&FormSet->FormListHead);
2531 while (!IsNull (&FormSet->FormListHead, Link)) {
2532 CurrentForm = FORM_BROWSER_FORM_FROM_LINK (Link);
2533 Link = GetNextNode (&FormSet->FormListHead, Link);
2534
2535 SubmitCallbackForForm(FormSet, CurrentForm);
2536 }
2537 }
2538
2539 /**
2540 Validate the HiiHandle.
2541
2542 @param HiiHandle The input HiiHandle which need to validate.
2543
2544 @retval TRUE The handle is validate.
2545 @retval FALSE The handle is invalidate.
2546
2547 **/
2548 BOOLEAN
2549 ValidateHiiHandle (
2550 EFI_HII_HANDLE HiiHandle
2551 )
2552 {
2553 EFI_HII_HANDLE *HiiHandles;
2554 UINTN Index;
2555 BOOLEAN Find;
2556
2557 if (HiiHandle == NULL) {
2558 return FALSE;
2559 }
2560
2561 Find = FALSE;
2562
2563 HiiHandles = HiiGetHiiHandles (NULL);
2564 ASSERT (HiiHandles != NULL);
2565
2566 for (Index = 0; HiiHandles[Index] != NULL; Index++) {
2567 if (HiiHandles[Index] == HiiHandle) {
2568 Find = TRUE;
2569 break;
2570 }
2571 }
2572
2573 FreePool (HiiHandles);
2574
2575 return Find;
2576 }
2577
2578 /**
2579 Validate the FormSet. If the formset is not validate, remove it from the list.
2580
2581 @param FormSet The input FormSet which need to validate.
2582
2583 @retval TRUE The handle is validate.
2584 @retval FALSE The handle is invalidate.
2585
2586 **/
2587 BOOLEAN
2588 ValidateFormSet (
2589 FORM_BROWSER_FORMSET *FormSet
2590 )
2591 {
2592 BOOLEAN Find;
2593
2594 ASSERT (FormSet != NULL);
2595
2596 Find = ValidateHiiHandle(FormSet->HiiHandle);
2597 //
2598 // Should not remove the formset which is being used.
2599 //
2600 if (!Find && (FormSet != gCurrentSelection->FormSet)) {
2601 CleanBrowserStorage(FormSet);
2602 RemoveEntryList (&FormSet->Link);
2603 DestroyFormSet (FormSet);
2604 }
2605
2606 return Find;
2607 }
2608 /**
2609 Check whether need to enable the reset flag in form level.
2610 Also clean all ValueChanged flag in question.
2611
2612 @param SetFlag Whether need to set the Reset Flag.
2613 @param FormSet FormSet data structure.
2614 @param Form Form data structure.
2615
2616 **/
2617 VOID
2618 UpdateFlagForForm (
2619 IN BOOLEAN SetFlag,
2620 IN FORM_BROWSER_FORMSET *FormSet,
2621 IN FORM_BROWSER_FORM *Form
2622 )
2623 {
2624 LIST_ENTRY *Link;
2625 FORM_BROWSER_STATEMENT *Question;
2626 BOOLEAN OldValue;
2627
2628 Link = GetFirstNode (&Form->StatementListHead);
2629 while (!IsNull (&Form->StatementListHead, Link)) {
2630 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
2631 Link = GetNextNode (&Form->StatementListHead, Link);
2632
2633 if (!Question->ValueChanged) {
2634 continue;
2635 }
2636
2637 OldValue = Question->ValueChanged;
2638
2639 //
2640 // Compare the buffer and editbuffer data to see whether the data has been saved.
2641 //
2642 Question->ValueChanged = IsQuestionValueChanged(FormSet, Form, Question, GetSetValueWithBothBuffer);
2643
2644 //
2645 // Only the changed data has been saved, then need to set the reset flag.
2646 //
2647 if (SetFlag && OldValue && !Question->ValueChanged) {
2648 if ((Question->QuestionFlags & EFI_IFR_FLAG_RESET_REQUIRED) != 0) {
2649 gResetRequired = TRUE;
2650 }
2651
2652 if ((Question->QuestionFlags & EFI_IFR_FLAG_RECONNECT_REQUIRED) != 0) {
2653 gFlagReconnect = TRUE;
2654 }
2655 }
2656 }
2657 }
2658
2659 /**
2660 Check whether need to enable the reset flag.
2661 Also clean ValueChanged flag for all statements.
2662
2663 Form level or formset level, only one.
2664
2665 @param SetFlag Whether need to set the Reset Flag.
2666 @param FormSet FormSet data structure.
2667 @param Form Form data structure.
2668
2669 **/
2670 VOID
2671 ValueChangeResetFlagUpdate (
2672 IN BOOLEAN SetFlag,
2673 IN FORM_BROWSER_FORMSET *FormSet,
2674 IN FORM_BROWSER_FORM *Form
2675 )
2676 {
2677 FORM_BROWSER_FORM *CurrentForm;
2678 LIST_ENTRY *Link;
2679
2680 if (Form != NULL) {
2681 UpdateFlagForForm(SetFlag, FormSet, Form);
2682 return;
2683 }
2684
2685 Link = GetFirstNode (&FormSet->FormListHead);
2686 while (!IsNull (&FormSet->FormListHead, Link)) {
2687 CurrentForm = FORM_BROWSER_FORM_FROM_LINK (Link);
2688 Link = GetNextNode (&FormSet->FormListHead, Link);
2689
2690 UpdateFlagForForm(SetFlag, FormSet, CurrentForm);
2691 }
2692 }
2693
2694 /**
2695 Base on the return Progress string to find the form.
2696
2697 Base on the first return Offset/Width (Name) string to find the form
2698 which keep this string.
2699
2700 @param FormSet FormSet data structure.
2701 @param Storage Storage which has this Progress string.
2702 @param Progress The Progress string which has the first fail string.
2703 @param RetForm The return form for this progress string.
2704 @param RetQuestion The return question for the error progress string.
2705
2706 @retval TRUE Find the error form and statement for this error progress string.
2707 @retval FALSE Not find the error form.
2708
2709 **/
2710 BOOLEAN
2711 FindQuestionFromProgress (
2712 IN FORM_BROWSER_FORMSET *FormSet,
2713 IN BROWSER_STORAGE *Storage,
2714 IN EFI_STRING Progress,
2715 OUT FORM_BROWSER_FORM **RetForm,
2716 OUT FORM_BROWSER_STATEMENT **RetQuestion
2717 )
2718 {
2719 LIST_ENTRY *Link;
2720 LIST_ENTRY *LinkStorage;
2721 LIST_ENTRY *LinkStatement;
2722 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
2723 FORM_BROWSER_FORM *Form;
2724 EFI_STRING EndStr;
2725 FORM_BROWSER_STATEMENT *Statement;
2726
2727 ASSERT ((*Progress == '&') || (*Progress == 'G'));
2728
2729 ConfigInfo = NULL;
2730 *RetForm = NULL;
2731 *RetQuestion = NULL;
2732
2733 //
2734 // Skip the first "&" or the ConfigHdr part.
2735 //
2736 if (*Progress == '&') {
2737 Progress++;
2738 } else {
2739 //
2740 // Prepare the "NAME" or "OFFSET=0x####&WIDTH=0x####" string.
2741 //
2742 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2743 //
2744 // For Name/Value type, Skip the ConfigHdr part.
2745 //
2746 EndStr = StrStr (Progress, L"PATH=");
2747 ASSERT (EndStr != NULL);
2748 while (*EndStr != '&') {
2749 EndStr++;
2750 }
2751
2752 *EndStr = '\0';
2753 } else {
2754 //
2755 // For Buffer type, Skip the ConfigHdr part.
2756 //
2757 EndStr = StrStr (Progress, L"&OFFSET=");
2758 ASSERT (EndStr != NULL);
2759 *EndStr = '\0';
2760 }
2761
2762 Progress = EndStr + 1;
2763 }
2764
2765 //
2766 // Prepare the "NAME" or "OFFSET=0x####&WIDTH=0x####" string.
2767 //
2768 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2769 //
2770 // For Name/Value type, the data is "&Fred=16&George=16&Ron=12" formset,
2771 // here, just keep the "Fred" string.
2772 //
2773 EndStr = StrStr (Progress, L"=");
2774 ASSERT (EndStr != NULL);
2775 *EndStr = '\0';
2776 } else {
2777 //
2778 // For Buffer type, the data is "OFFSET=0x####&WIDTH=0x####&VALUE=0x####",
2779 // here, just keep the "OFFSET=0x####&WIDTH=0x####" string.
2780 //
2781 EndStr = StrStr (Progress, L"&VALUE=");
2782 ASSERT (EndStr != NULL);
2783 *EndStr = '\0';
2784 }
2785
2786 //
2787 // Search in the form list.
2788 //
2789 Link = GetFirstNode (&FormSet->FormListHead);
2790 while (!IsNull (&FormSet->FormListHead, Link)) {
2791 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
2792 Link = GetNextNode (&FormSet->FormListHead, Link);
2793
2794 //
2795 // Search in the ConfigReqeust list in this form.
2796 //
2797 LinkStorage = GetFirstNode (&Form->ConfigRequestHead);
2798 while (!IsNull (&Form->ConfigRequestHead, LinkStorage)) {
2799 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (LinkStorage);
2800 LinkStorage = GetNextNode (&Form->ConfigRequestHead, LinkStorage);
2801
2802 if (Storage != ConfigInfo->Storage) {
2803 continue;
2804 }
2805
2806 if (StrStr (ConfigInfo->ConfigRequest, Progress) != NULL) {
2807 //
2808 // Find the OffsetWidth string in this form.
2809 //
2810 *RetForm = Form;
2811 break;
2812 }
2813 }
2814
2815 if (*RetForm != NULL) {
2816 LinkStatement = GetFirstNode (&Form->StatementListHead);
2817 while (!IsNull (&Form->StatementListHead, LinkStatement)) {
2818 Statement = FORM_BROWSER_STATEMENT_FROM_LINK (LinkStatement);
2819 LinkStatement = GetNextNode (&Form->StatementListHead, LinkStatement);
2820
2821 if (Statement->BlockName != NULL && StrStr (Statement->BlockName, Progress) != NULL) {
2822 *RetQuestion = Statement;
2823 break;
2824 }
2825
2826 if (Statement->VariableName != NULL && StrStr (Statement->VariableName, Progress) != NULL) {
2827 *RetQuestion = Statement;
2828 break;
2829 }
2830 }
2831 }
2832
2833 if (*RetForm != NULL) {
2834 break;
2835 }
2836 }
2837
2838 //
2839 // restore the OffsetWidth string to the original format.
2840 //
2841 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2842 *EndStr = '=';
2843 } else {
2844 *EndStr = '&';
2845 }
2846
2847 return (BOOLEAN) (*RetForm != NULL);
2848 }
2849
2850 /**
2851 Base on the return Progress string to get the SyncConfigRequest and RestoreConfigRequest
2852 for form and formset.
2853
2854 @param Storage Storage which has this Progress string.
2855 @param ConfigRequest The ConfigRequest string.
2856 @param Progress The Progress string which has the first fail string.
2857 @param RestoreConfigRequest Return the RestoreConfigRequest string.
2858 @param SyncConfigRequest Return the SyncConfigRequest string.
2859
2860 **/
2861 VOID
2862 GetSyncRestoreConfigRequest(
2863 IN BROWSER_STORAGE *Storage,
2864 IN EFI_STRING ConfigRequest,
2865 IN EFI_STRING Progress,
2866 OUT EFI_STRING *RestoreConfigRequest,
2867 OUT EFI_STRING *SyncConfigRequest
2868 )
2869 {
2870 EFI_STRING EndStr;
2871 EFI_STRING ConfigHdrEndStr;
2872 EFI_STRING ElementStr;
2873 UINTN TotalSize;
2874 UINTN RestoreEleSize;
2875 UINTN SyncSize;
2876
2877 ASSERT ((*Progress == L'&') || (*Progress == L'G'));
2878 //
2879 // If the Progress starts with ConfigHdr, means the failure is in the first name / value pair.
2880 // Need to restore all the fields in the ConfigRequest.
2881 //
2882 if (*Progress == L'G') {
2883 *RestoreConfigRequest = AllocateCopyPool (StrSize (ConfigRequest), ConfigRequest);
2884 ASSERT (*RestoreConfigRequest != NULL);
2885 return;
2886 }
2887
2888 //
2889 // Find the first fail "NAME" or "OFFSET=0x####&WIDTH=0x####" string.
2890 //
2891 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2892 //
2893 // For Name/Value type, the data is "&Fred=16&George=16&Ron=12" formset,
2894 // here, just keep the "Fred" string.
2895 //
2896 EndStr = StrStr (Progress, L"=");
2897 ASSERT (EndStr != NULL);
2898 *EndStr = L'\0';
2899 //
2900 // Find the ConfigHdr in ConfigRequest.
2901 //
2902 ConfigHdrEndStr = StrStr (ConfigRequest, L"PATH=");
2903 ASSERT (ConfigHdrEndStr != NULL);
2904 while (*ConfigHdrEndStr != L'&') {
2905 ConfigHdrEndStr++;
2906 }
2907 } else {
2908 //
2909 // For Buffer type, the data is "OFFSET=0x####&WIDTH=0x####&VALUE=0x####",
2910 // here, just keep the "OFFSET=0x####&WIDTH=0x####" string.
2911 //
2912 EndStr = StrStr (Progress, L"&VALUE=");
2913 ASSERT (EndStr != NULL);
2914 *EndStr = L'\0';
2915 //
2916 // Find the ConfigHdr in ConfigRequest.
2917 //
2918 ConfigHdrEndStr = StrStr (ConfigRequest, L"&OFFSET=");
2919 }
2920 //
2921 // Find the first fail pair in the ConfigRequest.
2922 //
2923 ElementStr = StrStr (ConfigRequest, Progress);
2924 ASSERT (ElementStr != NULL);
2925 //
2926 // To get the RestoreConfigRequest.
2927 //
2928 RestoreEleSize = StrSize (ElementStr);
2929 TotalSize = (ConfigHdrEndStr - ConfigRequest) * sizeof (CHAR16) + RestoreEleSize + sizeof (CHAR16);
2930 *RestoreConfigRequest = AllocateZeroPool (TotalSize);
2931 ASSERT (*RestoreConfigRequest != NULL);
2932 StrnCpyS (*RestoreConfigRequest, TotalSize / sizeof (CHAR16), ConfigRequest, ConfigHdrEndStr - ConfigRequest);
2933 StrCatS (*RestoreConfigRequest, TotalSize / sizeof (CHAR16), ElementStr);
2934 //
2935 // To get the SyncConfigRequest.
2936 //
2937 SyncSize = StrSize (ConfigRequest) - RestoreEleSize + sizeof (CHAR16);
2938 *SyncConfigRequest = AllocateZeroPool (SyncSize);
2939 ASSERT (*SyncConfigRequest != NULL);
2940 StrnCpyS (*SyncConfigRequest, SyncSize / sizeof (CHAR16), ConfigRequest, SyncSize / sizeof (CHAR16) - 1);
2941
2942 //
2943 // restore the Progress string to the original format.
2944 //
2945 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2946 *EndStr = L'=';
2947 } else {
2948 *EndStr = L'&';
2949 }
2950 }
2951
2952 /**
2953 Popup an save error info and get user input.
2954
2955 @param TitleId The form title id.
2956 @param HiiHandle The hii handle for this package.
2957
2958 @retval UINT32 The user select option for the save fail.
2959 BROWSER_ACTION_DISCARD or BROWSER_ACTION_JUMP_TO_FORMSET
2960 **/
2961 UINT32
2962 ConfirmSaveFail (
2963 IN EFI_STRING_ID TitleId,
2964 IN EFI_HII_HANDLE HiiHandle
2965 )
2966 {
2967 CHAR16 *FormTitle;
2968 CHAR16 *StringBuffer;
2969 UINT32 RetVal;
2970
2971 FormTitle = GetToken (TitleId, HiiHandle);
2972
2973 StringBuffer = AllocateZeroPool (256 * sizeof (CHAR16));
2974 ASSERT (StringBuffer != NULL);
2975
2976 UnicodeSPrint (
2977 StringBuffer,
2978 24 * sizeof (CHAR16) + StrSize (FormTitle),
2979 L"Submit Fail For Form: %s.",
2980 FormTitle
2981 );
2982
2983 RetVal = PopupErrorMessage(BROWSER_SUBMIT_FAIL, NULL, NULL, StringBuffer);
2984
2985 FreePool (StringBuffer);
2986 FreePool (FormTitle);
2987
2988 return RetVal;
2989 }
2990
2991 /**
2992 Popup an NO_SUBMIT_IF error info and get user input.
2993
2994 @param TitleId The form title id.
2995 @param HiiHandle The hii handle for this package.
2996
2997 @retval UINT32 The user select option for the save fail.
2998 BROWSER_ACTION_DISCARD or BROWSER_ACTION_JUMP_TO_FORMSET
2999 **/
3000 UINT32
3001 ConfirmNoSubmitFail (
3002 IN EFI_STRING_ID TitleId,
3003 IN EFI_HII_HANDLE HiiHandle
3004 )
3005 {
3006 CHAR16 *FormTitle;
3007 CHAR16 *StringBuffer;
3008 UINT32 RetVal;
3009
3010 FormTitle = GetToken (TitleId, HiiHandle);
3011
3012 StringBuffer = AllocateZeroPool (256 * sizeof (CHAR16));
3013 ASSERT (StringBuffer != NULL);
3014
3015 UnicodeSPrint (
3016 StringBuffer,
3017 24 * sizeof (CHAR16) + StrSize (FormTitle),
3018 L"NO_SUBMIT_IF error For Form: %s.",
3019 FormTitle
3020 );
3021
3022 RetVal = PopupErrorMessage(BROWSER_SUBMIT_FAIL_NO_SUBMIT_IF, NULL, NULL, StringBuffer);
3023
3024 FreePool (StringBuffer);
3025 FreePool (FormTitle);
3026
3027 return RetVal;
3028 }
3029
3030 /**
3031 Discard data based on the input setting scope (Form, FormSet or System).
3032
3033 @param FormSet FormSet data structure.
3034 @param Form Form data structure.
3035 @param SettingScope Setting Scope for Discard action.
3036
3037 @retval EFI_SUCCESS The function completed successfully.
3038 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3039
3040 **/
3041 EFI_STATUS
3042 DiscardForm (
3043 IN FORM_BROWSER_FORMSET *FormSet,
3044 IN FORM_BROWSER_FORM *Form,
3045 IN BROWSER_SETTING_SCOPE SettingScope
3046 )
3047 {
3048 LIST_ENTRY *Link;
3049 FORMSET_STORAGE *Storage;
3050 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
3051 FORM_BROWSER_FORMSET *LocalFormSet;
3052 FORM_BROWSER_FORMSET *OldFormSet;
3053
3054 //
3055 // Check the supported setting level.
3056 //
3057 if (SettingScope >= MaxLevel) {
3058 return EFI_UNSUPPORTED;
3059 }
3060
3061 if (SettingScope == FormLevel && IsNvUpdateRequiredForForm (Form)) {
3062 ConfigInfo = NULL;
3063 Link = GetFirstNode (&Form->ConfigRequestHead);
3064 while (!IsNull (&Form->ConfigRequestHead, Link)) {
3065 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
3066 Link = GetNextNode (&Form->ConfigRequestHead, Link);
3067
3068 if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3069 continue;
3070 }
3071
3072 //
3073 // Skip if there is no RequestElement
3074 //
3075 if (ConfigInfo->ElementCount == 0) {
3076 continue;
3077 }
3078
3079 //
3080 // Prepare <ConfigResp>
3081 //
3082 SynchronizeStorage(ConfigInfo->Storage, ConfigInfo->ConfigRequest, FALSE);
3083
3084 //
3085 // Call callback with Changed type to inform the driver.
3086 //
3087 SendDiscardInfoToDriver (FormSet, Form);
3088 }
3089
3090 ValueChangeResetFlagUpdate (FALSE, FormSet, Form);
3091 } else if (SettingScope == FormSetLevel && IsNvUpdateRequiredForFormSet (FormSet)) {
3092
3093 //
3094 // Discard Buffer storage or Name/Value storage
3095 //
3096 Link = GetFirstNode (&FormSet->StorageListHead);
3097 while (!IsNull (&FormSet->StorageListHead, Link)) {
3098 Storage = FORMSET_STORAGE_FROM_LINK (Link);
3099 Link = GetNextNode (&FormSet->StorageListHead, Link);
3100
3101 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3102 continue;
3103 }
3104
3105 //
3106 // Skip if there is no RequestElement
3107 //
3108 if (Storage->ElementCount == 0) {
3109 continue;
3110 }
3111
3112 SynchronizeStorage(Storage->BrowserStorage, Storage->ConfigRequest, FALSE);
3113 }
3114
3115 Link = GetFirstNode (&FormSet->FormListHead);
3116 while (!IsNull (&FormSet->FormListHead, Link)) {
3117 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
3118 Link = GetNextNode (&FormSet->FormListHead, Link);
3119
3120 //
3121 // Call callback with Changed type to inform the driver.
3122 //
3123 SendDiscardInfoToDriver (FormSet, Form);
3124 }
3125
3126 ValueChangeResetFlagUpdate(FALSE, FormSet, NULL);
3127 } else if (SettingScope == SystemLevel) {
3128 //
3129 // System Level Discard.
3130 //
3131 OldFormSet = mSystemLevelFormSet;
3132
3133 //
3134 // Discard changed value for each FormSet in the maintain list.
3135 //
3136 Link = GetFirstNode (&gBrowserFormSetList);
3137 while (!IsNull (&gBrowserFormSetList, Link)) {
3138 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
3139 Link = GetNextNode (&gBrowserFormSetList, Link);
3140 if (!ValidateFormSet(LocalFormSet)) {
3141 continue;
3142 }
3143
3144 mSystemLevelFormSet = LocalFormSet;
3145
3146 DiscardForm (LocalFormSet, NULL, FormSetLevel);
3147 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
3148 //
3149 // Remove maintain backup list after discard except for the current using FormSet.
3150 //
3151 CleanBrowserStorage(LocalFormSet);
3152 RemoveEntryList (&LocalFormSet->Link);
3153 DestroyFormSet (LocalFormSet);
3154 }
3155 }
3156
3157 mSystemLevelFormSet = OldFormSet;
3158 }
3159
3160 return EFI_SUCCESS;
3161 }
3162
3163 /**
3164 Submit data for a form.
3165
3166 @param FormSet FormSet data structure.
3167 @param Form Form data structure.
3168
3169 @retval EFI_SUCCESS The function completed successfully.
3170 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3171
3172 **/
3173 EFI_STATUS
3174 SubmitForForm (
3175 IN FORM_BROWSER_FORMSET *FormSet,
3176 IN FORM_BROWSER_FORM *Form
3177 )
3178 {
3179 EFI_STATUS Status;
3180 LIST_ENTRY *Link;
3181 EFI_STRING ConfigResp;
3182 EFI_STRING Progress;
3183 BROWSER_STORAGE *Storage;
3184 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
3185
3186 if (!IsNvUpdateRequiredForForm (Form)) {
3187 return EFI_SUCCESS;
3188 }
3189
3190 Status = NoSubmitCheck (FormSet, &Form, NULL);
3191 if (EFI_ERROR (Status)) {
3192 return Status;
3193 }
3194
3195 Link = GetFirstNode (&Form->ConfigRequestHead);
3196 while (!IsNull (&Form->ConfigRequestHead, Link)) {
3197 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
3198 Link = GetNextNode (&Form->ConfigRequestHead, Link);
3199
3200 Storage = ConfigInfo->Storage;
3201 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3202 continue;
3203 }
3204
3205 //
3206 // Skip if there is no RequestElement
3207 //
3208 if (ConfigInfo->ElementCount == 0) {
3209 continue;
3210 }
3211
3212 //
3213 // 1. Prepare <ConfigResp>
3214 //
3215 Status = StorageToConfigResp (ConfigInfo->Storage, &ConfigResp, ConfigInfo->ConfigRequest, TRUE);
3216 if (EFI_ERROR (Status)) {
3217 return Status;
3218 }
3219
3220 //
3221 // 2. Set value to hii config routine protocol.
3222 //
3223 Status = mHiiConfigRouting->RouteConfig (
3224 mHiiConfigRouting,
3225 ConfigResp,
3226 &Progress
3227 );
3228 FreePool (ConfigResp);
3229
3230 if (EFI_ERROR (Status)) {
3231 //
3232 // Submit fail, to get the RestoreConfigRequest and SyncConfigRequest.
3233 //
3234 GetSyncRestoreConfigRequest (ConfigInfo->Storage, ConfigInfo->ConfigRequest, Progress, &ConfigInfo->RestoreConfigRequest, &ConfigInfo->SyncConfigRequest);
3235 InsertTailList (&gBrowserSaveFailFormSetList, &ConfigInfo->SaveFailLink);
3236 continue;
3237 }
3238
3239 //
3240 // 3. Config success, update storage shadow Buffer, only update the data belong to this form.
3241 //
3242 SynchronizeStorage (ConfigInfo->Storage, ConfigInfo->ConfigRequest, TRUE);
3243 }
3244
3245 //
3246 // 4. Process the save failed storage.
3247 //
3248 if (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3249 if (ConfirmSaveFail (Form->FormTitle, FormSet->HiiHandle) == BROWSER_ACTION_DISCARD) {
3250 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3251 while (!IsNull (&gBrowserSaveFailFormSetList, Link)) {
3252 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK (Link);
3253 Link = GetNextNode (&gBrowserSaveFailFormSetList, Link);
3254 //
3255 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3256 // base on the SyncConfigRequest to Sync the buffer.
3257 //
3258 SynchronizeStorage (ConfigInfo->Storage, ConfigInfo->RestoreConfigRequest, FALSE);
3259 FreePool (ConfigInfo->RestoreConfigRequest);
3260 ConfigInfo->RestoreConfigRequest = NULL;
3261 if (ConfigInfo->SyncConfigRequest != NULL) {
3262 SynchronizeStorage(ConfigInfo->Storage, ConfigInfo->SyncConfigRequest, TRUE);
3263 FreePool (ConfigInfo->SyncConfigRequest);
3264 ConfigInfo->SyncConfigRequest = NULL;
3265 }
3266
3267 Status = EFI_SUCCESS;
3268 }
3269 } else {
3270 Status = EFI_UNSUPPORTED;
3271 }
3272
3273 //
3274 // Free Form save fail list.
3275 //
3276 while (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3277 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3278 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK (Link);
3279 RemoveEntryList (&ConfigInfo->SaveFailLink);
3280 }
3281 }
3282
3283 //
3284 // 5. Update the NV flag.
3285 //
3286 ValueChangeResetFlagUpdate(TRUE, FormSet, Form);
3287
3288 //
3289 // 6 Call callback with Submitted type to inform the driver.
3290 //
3291 SubmitCallback (FormSet, Form);
3292
3293 return Status;
3294 }
3295
3296 /**
3297 Submit data for a formset.
3298
3299 @param FormSet FormSet data structure.
3300 @param SkipProcessFail Whether skip to process the save failed storage.
3301 If submit formset is called when do system level save,
3302 set this value to true and process the failed formset
3303 together.
3304 if submit formset is called when do formset level save,
3305 set the value to false and process the failed storage
3306 right after process all storages for this formset.
3307
3308 @retval EFI_SUCCESS The function completed successfully.
3309 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3310
3311 **/
3312 EFI_STATUS
3313 SubmitForFormSet (
3314 IN FORM_BROWSER_FORMSET *FormSet,
3315 IN BOOLEAN SkipProcessFail
3316 )
3317 {
3318 EFI_STATUS Status;
3319 LIST_ENTRY *Link;
3320 EFI_STRING ConfigResp;
3321 EFI_STRING Progress;
3322 BROWSER_STORAGE *Storage;
3323 FORMSET_STORAGE *FormSetStorage;
3324 FORM_BROWSER_FORM *Form;
3325 BOOLEAN HasInserted;
3326 FORM_BROWSER_STATEMENT *Question;
3327
3328 HasInserted = FALSE;
3329
3330 if (!IsNvUpdateRequiredForFormSet (FormSet)) {
3331 return EFI_SUCCESS;
3332 }
3333
3334 Form = NULL;
3335 Status = NoSubmitCheck (FormSet, &Form, &Question);
3336 if (EFI_ERROR (Status)) {
3337 if (SkipProcessFail) {
3338 //
3339 // Process NO_SUBMIT check first, so insert it at head.
3340 //
3341 FormSet->SaveFailForm = Form;
3342 FormSet->SaveFailStatement = Question;
3343 InsertHeadList (&gBrowserSaveFailFormSetList, &FormSet->SaveFailLink);
3344 }
3345
3346 return Status;
3347 }
3348
3349 Form = NULL;
3350 Question = NULL;
3351 //
3352 // Submit Buffer storage or Name/Value storage
3353 //
3354 Link = GetFirstNode (&FormSet->StorageListHead);
3355 while (!IsNull (&FormSet->StorageListHead, Link)) {
3356 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
3357 Storage = FormSetStorage->BrowserStorage;
3358 Link = GetNextNode (&FormSet->StorageListHead, Link);
3359
3360 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3361 continue;
3362 }
3363
3364 //
3365 // Skip if there is no RequestElement
3366 //
3367 if (FormSetStorage->ElementCount == 0) {
3368 continue;
3369 }
3370
3371 //
3372 // 1. Prepare <ConfigResp>
3373 //
3374 Status = StorageToConfigResp (Storage, &ConfigResp, FormSetStorage->ConfigRequest, TRUE);
3375 if (EFI_ERROR (Status)) {
3376 return Status;
3377 }
3378
3379 //
3380 // 2. Send <ConfigResp> to Routine config Protocol.
3381 //
3382 Status = mHiiConfigRouting->RouteConfig (
3383 mHiiConfigRouting,
3384 ConfigResp,
3385 &Progress
3386 );
3387 if (EFI_ERROR (Status)) {
3388 //
3389 // Submit fail, to get the RestoreConfigRequest and SyncConfigRequest.
3390 //
3391 GetSyncRestoreConfigRequest (FormSetStorage->BrowserStorage, FormSetStorage->ConfigRequest, Progress, &FormSetStorage->RestoreConfigRequest, &FormSetStorage->SyncConfigRequest);
3392 InsertTailList (&FormSet->SaveFailStorageListHead, &FormSetStorage->SaveFailLink);
3393 if (!HasInserted) {
3394 //
3395 // Call submit formset for system level, save the formset info
3396 // and process later.
3397 //
3398 FindQuestionFromProgress(FormSet, Storage, Progress, &Form, &Question);
3399 ASSERT (Form != NULL && Question != NULL);
3400 FormSet->SaveFailForm = Form;
3401 FormSet->SaveFailStatement = Question;
3402 if (SkipProcessFail) {
3403 InsertTailList (&gBrowserSaveFailFormSetList, &FormSet->SaveFailLink);
3404 }
3405 HasInserted = TRUE;
3406 }
3407
3408 FreePool (ConfigResp);
3409 continue;
3410 }
3411
3412 FreePool (ConfigResp);
3413 //
3414 // 3. Config success, update storage shadow Buffer
3415 //
3416 SynchronizeStorage (Storage, FormSetStorage->ConfigRequest, TRUE);
3417 }
3418
3419 //
3420 // 4. Has save fail storage need to handle.
3421 //
3422 if (Form != NULL) {
3423 if (!SkipProcessFail) {
3424 //
3425 // If not in system level, just handl the save failed storage here.
3426 //
3427 if (ConfirmSaveFail (Form->FormTitle, FormSet->HiiHandle) == BROWSER_ACTION_DISCARD) {
3428 Link = GetFirstNode (&FormSet->SaveFailStorageListHead);
3429 while (!IsNull (&FormSet->SaveFailStorageListHead, Link)) {
3430 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (Link);
3431 Storage = FormSetStorage->BrowserStorage;
3432 Link = GetNextNode (&FormSet->SaveFailStorageListHead, Link);
3433 //
3434 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3435 // base on the SyncConfigRequest to Sync the buffer.
3436 //
3437 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->RestoreConfigRequest, FALSE);
3438 FreePool (FormSetStorage->RestoreConfigRequest);
3439 FormSetStorage->RestoreConfigRequest = NULL;
3440 if (FormSetStorage->SyncConfigRequest != NULL) {
3441 SynchronizeStorage(FormSetStorage->BrowserStorage, FormSetStorage->SyncConfigRequest, TRUE);
3442 FreePool (FormSetStorage->SyncConfigRequest);
3443 FormSetStorage->SyncConfigRequest = NULL;
3444 }
3445
3446 Status = EFI_SUCCESS;
3447 }
3448 } else {
3449 UiCopyMenuList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &Form->FormViewListHead);
3450
3451 gCurrentSelection->Action = UI_ACTION_REFRESH_FORMSET;
3452 gCurrentSelection->Handle = FormSet->HiiHandle;
3453 CopyGuid (&gCurrentSelection->FormSetGuid, &FormSet->Guid);
3454 gCurrentSelection->FormId = Form->FormId;
3455 gCurrentSelection->QuestionId = Question->QuestionId;
3456
3457 Status = EFI_UNSUPPORTED;
3458 }
3459
3460 //
3461 // Free FormSet save fail list.
3462 //
3463 while (!IsListEmpty (&FormSet->SaveFailStorageListHead)) {
3464 Link = GetFirstNode (&FormSet->SaveFailStorageListHead);
3465 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (Link);
3466 RemoveEntryList (&FormSetStorage->SaveFailLink);
3467 }
3468 } else {
3469 //
3470 // If in system level, just return error and handle the failed formset later.
3471 //
3472 Status = EFI_UNSUPPORTED;
3473 }
3474 }
3475
3476 //
3477 // 5. Update the NV flag.
3478 //
3479 ValueChangeResetFlagUpdate(TRUE, FormSet, NULL);
3480
3481 //
3482 // 6. Call callback with Submitted type to inform the driver.
3483 //
3484 SubmitCallback (FormSet, NULL);
3485
3486 return Status;
3487 }
3488
3489 /**
3490 Submit data for all formsets.
3491
3492 @retval EFI_SUCCESS The function completed successfully.
3493 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3494
3495 **/
3496 EFI_STATUS
3497 SubmitForSystem (
3498 VOID
3499 )
3500 {
3501 EFI_STATUS Status;
3502 LIST_ENTRY *Link;
3503 LIST_ENTRY *StorageLink;
3504 FORMSET_STORAGE *FormSetStorage;
3505 FORM_BROWSER_FORM *Form;
3506 FORM_BROWSER_FORMSET *LocalFormSet;
3507 UINT32 UserSelection;
3508 FORM_BROWSER_STATEMENT *Question;
3509
3510 mSystemSubmit = TRUE;
3511 Link = GetFirstNode (&gBrowserFormSetList);
3512 while (!IsNull (&gBrowserFormSetList, Link)) {
3513 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
3514 Link = GetNextNode (&gBrowserFormSetList, Link);
3515 if (!ValidateFormSet(LocalFormSet)) {
3516 continue;
3517 }
3518
3519 Status = SubmitForFormSet (LocalFormSet, TRUE);
3520 if (EFI_ERROR (Status)) {
3521 continue;
3522 }
3523
3524 //
3525 // Remove maintain backup list after save except for the current using FormSet.
3526 //
3527 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
3528 CleanBrowserStorage(LocalFormSet);
3529 RemoveEntryList (&LocalFormSet->Link);
3530 DestroyFormSet (LocalFormSet);
3531 }
3532 }
3533 mSystemSubmit = FALSE;
3534
3535 Status = EFI_SUCCESS;
3536
3537 //
3538 // Process the save failed formsets.
3539 //
3540 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3541 while (!IsNull (&gBrowserSaveFailFormSetList, Link)) {
3542 LocalFormSet = FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK (Link);
3543 Link = GetNextNode (&gBrowserSaveFailFormSetList, Link);
3544
3545 if (!ValidateFormSet(LocalFormSet)) {
3546 continue;
3547 }
3548
3549 Form = LocalFormSet->SaveFailForm;
3550 Question= LocalFormSet->SaveFailStatement;
3551
3552 //
3553 // Confirm with user, get user input.
3554 //
3555 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3556 //
3557 // NULL for SaveFailStorageListHead means error caused by NO_SUBMIT_IF check.
3558 //
3559 UserSelection = ConfirmNoSubmitFail (Form->FormTitle, LocalFormSet->HiiHandle);
3560 } else {
3561 UserSelection = ConfirmSaveFail (Form->FormTitle, LocalFormSet->HiiHandle);
3562 }
3563
3564 if (UserSelection == BROWSER_ACTION_DISCARD) {
3565 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3566 StorageLink = GetFirstNode (&LocalFormSet->StorageListHead);
3567 while (!IsNull (&LocalFormSet->StorageListHead, StorageLink)) {
3568 FormSetStorage = FORMSET_STORAGE_FROM_LINK (StorageLink);
3569 StorageLink = GetNextNode (&LocalFormSet->StorageListHead, StorageLink);
3570
3571 SynchronizeStorage(FormSetStorage->BrowserStorage, FormSetStorage->ConfigRequest, FALSE);
3572 }
3573 } else {
3574 StorageLink = GetFirstNode (&LocalFormSet->SaveFailStorageListHead);
3575 while (!IsNull (&LocalFormSet->SaveFailStorageListHead, StorageLink)) {
3576 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (StorageLink);
3577 StorageLink = GetNextNode (&LocalFormSet->SaveFailStorageListHead, StorageLink);
3578 //
3579 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3580 // base on the SyncConfigRequest to Sync the buffer.
3581 //
3582 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->RestoreConfigRequest, FALSE);
3583 FreePool (FormSetStorage->RestoreConfigRequest);
3584 FormSetStorage->RestoreConfigRequest = NULL;
3585 if ( FormSetStorage->SyncConfigRequest != NULL) {
3586 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->SyncConfigRequest, TRUE);
3587 FreePool (FormSetStorage->SyncConfigRequest);
3588 FormSetStorage->SyncConfigRequest = NULL;
3589 }
3590 }
3591 }
3592
3593 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
3594 CleanBrowserStorage(LocalFormSet);
3595 RemoveEntryList (&LocalFormSet->Link);
3596 RemoveEntryList (&LocalFormSet->SaveFailLink);
3597 DestroyFormSet (LocalFormSet);
3598 } else {
3599 ValueChangeResetFlagUpdate(FALSE, LocalFormSet, NULL);
3600 }
3601 } else {
3602 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3603 NoSubmitCheck (LocalFormSet, &Form, &Question);
3604 }
3605
3606 UiCopyMenuList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &Form->FormViewListHead);
3607
3608 gCurrentSelection->Action = UI_ACTION_REFRESH_FORMSET;
3609 gCurrentSelection->Handle = LocalFormSet->HiiHandle;
3610 CopyGuid (&gCurrentSelection->FormSetGuid, &LocalFormSet->Guid);
3611 gCurrentSelection->FormId = Form->FormId;
3612 gCurrentSelection->QuestionId = Question->QuestionId;
3613
3614 Status = EFI_UNSUPPORTED;
3615 break;
3616 }
3617 }
3618
3619 //
3620 // Clean the list which will not process.
3621 //
3622 while (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3623 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3624 LocalFormSet = FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK (Link);
3625 RemoveEntryList (&LocalFormSet->SaveFailLink);
3626
3627 while (!IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3628 StorageLink = GetFirstNode (&LocalFormSet->SaveFailStorageListHead);
3629 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (StorageLink);
3630 RemoveEntryList (&FormSetStorage->SaveFailLink);
3631 }
3632 }
3633
3634 return Status;
3635 }
3636
3637 /**
3638 Submit data based on the input Setting level (Form, FormSet or System).
3639
3640 @param FormSet FormSet data structure.
3641 @param Form Form data structure.
3642 @param SettingScope Setting Scope for Submit action.
3643
3644 @retval EFI_SUCCESS The function completed successfully.
3645 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3646
3647 **/
3648 EFI_STATUS
3649 SubmitForm (
3650 IN FORM_BROWSER_FORMSET *FormSet,
3651 IN FORM_BROWSER_FORM *Form,
3652 IN BROWSER_SETTING_SCOPE SettingScope
3653 )
3654 {
3655 EFI_STATUS Status;
3656
3657 switch (SettingScope) {
3658 case FormLevel:
3659 Status = SubmitForForm(FormSet, Form);
3660 break;
3661
3662 case FormSetLevel:
3663 Status = SubmitForFormSet (FormSet, FALSE);
3664 break;
3665
3666 case SystemLevel:
3667 Status = SubmitForSystem ();
3668 break;
3669
3670 default:
3671 Status = EFI_UNSUPPORTED;
3672 break;
3673 }
3674
3675 return Status;
3676 }
3677
3678 /**
3679 Converts the unicode character of the string from uppercase to lowercase.
3680 This is a internal function.
3681
3682 @param ConfigString String to be converted
3683
3684 **/
3685 VOID
3686 EFIAPI
3687 HiiToLower (
3688 IN EFI_STRING ConfigString
3689 )
3690 {
3691 EFI_STRING String;
3692 BOOLEAN Lower;
3693
3694 ASSERT (ConfigString != NULL);
3695
3696 //
3697 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
3698 //
3699 for (String = ConfigString, Lower = FALSE; *String != L'\0'; String++) {
3700 if (*String == L'=') {
3701 Lower = TRUE;
3702 } else if (*String == L'&') {
3703 Lower = FALSE;
3704 } else if (Lower && *String >= L'A' && *String <= L'F') {
3705 *String = (CHAR16) (*String - L'A' + L'a');
3706 }
3707 }
3708 }
3709
3710 /**
3711 Find the point in the ConfigResp string for this question.
3712
3713 @param Question The question.
3714 @param ConfigResp Get ConfigResp string.
3715
3716 @retval point to the offset where is for this question.
3717
3718 **/
3719 CHAR16 *
3720 GetOffsetFromConfigResp (
3721 IN FORM_BROWSER_STATEMENT *Question,
3722 IN CHAR16 *ConfigResp
3723 )
3724 {
3725 CHAR16 *RequestElement;
3726 CHAR16 *BlockData;
3727
3728 //
3729 // Type is EFI_HII_VARSTORE_NAME_VALUE.
3730 //
3731 if (Question->Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
3732 RequestElement = StrStr (ConfigResp, Question->VariableName);
3733 if (RequestElement != NULL) {
3734 //
3735 // Skip the "VariableName=" field.
3736 //
3737 RequestElement += StrLen (Question->VariableName) + 1;
3738 }
3739
3740 return RequestElement;
3741 }
3742
3743 //
3744 // Type is EFI_HII_VARSTORE_EFI_VARIABLE or EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
3745 //
3746
3747 //
3748 // 1. Directly use Question->BlockName to find.
3749 //
3750 RequestElement = StrStr (ConfigResp, Question->BlockName);
3751 if (RequestElement != NULL) {
3752 //
3753 // Skip the "Question->BlockName&VALUE=" field.
3754 //
3755 RequestElement += StrLen (Question->BlockName) + StrLen (L"&VALUE=");
3756 return RequestElement;
3757 }
3758
3759 //
3760 // 2. Change all hex digits in Question->BlockName to lower and compare again.
3761 //
3762 BlockData = AllocateCopyPool (StrSize(Question->BlockName), Question->BlockName);
3763 ASSERT (BlockData != NULL);
3764 HiiToLower (BlockData);
3765 RequestElement = StrStr (ConfigResp, BlockData);
3766 FreePool (BlockData);
3767
3768 if (RequestElement != NULL) {
3769 //
3770 // Skip the "Question->BlockName&VALUE=" field.
3771 //
3772 RequestElement += StrLen (Question->BlockName) + StrLen (L"&VALUE=");
3773 }
3774
3775 return RequestElement;
3776 }
3777
3778 /**
3779 Get Question default value from AltCfg string.
3780
3781 @param FormSet The form set.
3782 @param Form The form
3783 @param Question The question.
3784
3785 @retval EFI_SUCCESS Question is reset to default value.
3786
3787 **/
3788 EFI_STATUS
3789 GetDefaultValueFromAltCfg (
3790 IN FORM_BROWSER_FORMSET *FormSet,
3791 IN FORM_BROWSER_FORM *Form,
3792 IN OUT FORM_BROWSER_STATEMENT *Question
3793 )
3794 {
3795 BROWSER_STORAGE *Storage;
3796 FORMSET_STORAGE *FormSetStorage;
3797 CHAR16 *ConfigResp;
3798 CHAR16 *Value;
3799 LIST_ENTRY *Link;
3800 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
3801
3802 Storage = Question->Storage;
3803 if ((Storage == NULL) || (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE)) {
3804 return EFI_NOT_FOUND;
3805 }
3806
3807 //
3808 // Try to get AltCfg string from form. If not found it, then
3809 // try to get it from formset.
3810 //
3811 ConfigResp = NULL;
3812 Link = GetFirstNode (&Form->ConfigRequestHead);
3813 while (!IsNull (&Form->ConfigRequestHead, Link)) {
3814 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
3815 Link = GetNextNode (&Form->ConfigRequestHead, Link);
3816
3817 if (Storage == ConfigInfo->Storage) {
3818 ConfigResp = ConfigInfo->ConfigAltResp;
3819 break;
3820 }
3821 }
3822
3823 if (ConfigResp == NULL) {
3824 Link = GetFirstNode (&FormSet->StorageListHead);
3825 while (!IsNull (&FormSet->StorageListHead, Link)) {
3826 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
3827 Link = GetNextNode (&FormSet->StorageListHead, Link);
3828
3829 if (Storage == FormSetStorage->BrowserStorage) {
3830 ConfigResp = FormSetStorage->ConfigAltResp;
3831 break;
3832 }
3833 }
3834 }
3835
3836 if (ConfigResp == NULL) {
3837 return EFI_NOT_FOUND;
3838 }
3839
3840 Value = GetOffsetFromConfigResp (Question, ConfigResp);
3841 if (Value == NULL) {
3842 return EFI_NOT_FOUND;
3843 }
3844
3845 return BufferToValue (Question, Value);
3846 }
3847
3848 /**
3849 Get default Id value used for browser.
3850
3851 @param DefaultId The default id value used by hii.
3852
3853 @retval Browser used default value.
3854
3855 **/
3856 INTN
3857 GetDefaultIdForCallBack (
3858 UINTN DefaultId
3859 )
3860 {
3861 if (DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) {
3862 return EFI_BROWSER_ACTION_DEFAULT_STANDARD;
3863 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
3864 return EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING;
3865 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_SAFE) {
3866 return EFI_BROWSER_ACTION_DEFAULT_SAFE;
3867 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN + 0x1000) {
3868 return EFI_BROWSER_ACTION_DEFAULT_PLATFORM + DefaultId - EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN;
3869 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN + 0x1000) {
3870 return EFI_BROWSER_ACTION_DEFAULT_HARDWARE + DefaultId - EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN;
3871 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN + 0x1000) {
3872 return EFI_BROWSER_ACTION_DEFAULT_FIRMWARE + DefaultId - EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN;
3873 } else {
3874 return -1;
3875 }
3876 }
3877
3878
3879
3880 /**
3881 Return data element in an Array by its Index.
3882
3883 @param Array The data array.
3884 @param Type Type of the data in this array.
3885 @param Index Zero based index for data in this array.
3886
3887 @retval Value The data to be returned
3888
3889 **/
3890 UINT64
3891 GetArrayData (
3892 IN VOID *Array,
3893 IN UINT8 Type,
3894 IN UINTN Index
3895 )
3896 {
3897 UINT64 Data;
3898
3899 ASSERT (Array != NULL);
3900
3901 Data = 0;
3902 switch (Type) {
3903 case EFI_IFR_TYPE_NUM_SIZE_8:
3904 Data = (UINT64) *(((UINT8 *) Array) + Index);
3905 break;
3906
3907 case EFI_IFR_TYPE_NUM_SIZE_16:
3908 Data = (UINT64) *(((UINT16 *) Array) + Index);
3909 break;
3910
3911 case EFI_IFR_TYPE_NUM_SIZE_32:
3912 Data = (UINT64) *(((UINT32 *) Array) + Index);
3913 break;
3914
3915 case EFI_IFR_TYPE_NUM_SIZE_64:
3916 Data = (UINT64) *(((UINT64 *) Array) + Index);
3917 break;
3918
3919 default:
3920 break;
3921 }
3922
3923 return Data;
3924 }
3925
3926
3927 /**
3928 Set value of a data element in an Array by its Index.
3929
3930 @param Array The data array.
3931 @param Type Type of the data in this array.
3932 @param Index Zero based index for data in this array.
3933 @param Value The value to be set.
3934
3935 **/
3936 VOID
3937 SetArrayData (
3938 IN VOID *Array,
3939 IN UINT8 Type,
3940 IN UINTN Index,
3941 IN UINT64 Value
3942 )
3943 {
3944
3945 ASSERT (Array != NULL);
3946
3947 switch (Type) {
3948 case EFI_IFR_TYPE_NUM_SIZE_8:
3949 *(((UINT8 *) Array) + Index) = (UINT8) Value;
3950 break;
3951
3952 case EFI_IFR_TYPE_NUM_SIZE_16:
3953 *(((UINT16 *) Array) + Index) = (UINT16) Value;
3954 break;
3955
3956 case EFI_IFR_TYPE_NUM_SIZE_32:
3957 *(((UINT32 *) Array) + Index) = (UINT32) Value;
3958 break;
3959
3960 case EFI_IFR_TYPE_NUM_SIZE_64:
3961 *(((UINT64 *) Array) + Index) = (UINT64) Value;
3962 break;
3963
3964 default:
3965 break;
3966 }
3967 }
3968
3969 /**
3970 Search an Option of a Question by its value.
3971
3972 @param Question The Question
3973 @param OptionValue Value for Option to be searched.
3974
3975 @retval Pointer Pointer to the found Option.
3976 @retval NULL Option not found.
3977
3978 **/
3979 QUESTION_OPTION *
3980 ValueToOption (
3981 IN FORM_BROWSER_STATEMENT *Question,
3982 IN EFI_HII_VALUE *OptionValue
3983 )
3984 {
3985 LIST_ENTRY *Link;
3986 QUESTION_OPTION *Option;
3987 INTN Result;
3988
3989 Link = GetFirstNode (&Question->OptionListHead);
3990 while (!IsNull (&Question->OptionListHead, Link)) {
3991 Option = QUESTION_OPTION_FROM_LINK (Link);
3992
3993 if ((CompareHiiValue (&Option->Value, OptionValue, &Result, NULL) == EFI_SUCCESS) && (Result == 0)) {
3994 //
3995 // Check the suppressif condition, only a valid option can be return.
3996 //
3997 if ((Option->SuppressExpression == NULL) ||
3998 ((EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) == ExpressFalse))) {
3999 return Option;
4000 }
4001 }
4002
4003 Link = GetNextNode (&Question->OptionListHead, Link);
4004 }
4005
4006 return NULL;
4007 }
4008
4009
4010 /**
4011 Reset Question to its default value.
4012
4013 @param FormSet The form set.
4014 @param Form The form.
4015 @param Question The question.
4016 @param DefaultId The Class of the default.
4017
4018 @retval EFI_SUCCESS Question is reset to default value.
4019
4020 **/
4021 EFI_STATUS
4022 GetQuestionDefault (
4023 IN FORM_BROWSER_FORMSET *FormSet,
4024 IN FORM_BROWSER_FORM *Form,
4025 IN FORM_BROWSER_STATEMENT *Question,
4026 IN UINT16 DefaultId
4027 )
4028 {
4029 EFI_STATUS Status;
4030 LIST_ENTRY *Link;
4031 QUESTION_DEFAULT *Default;
4032 QUESTION_OPTION *Option;
4033 EFI_HII_VALUE *HiiValue;
4034 UINT8 Index;
4035 EFI_STRING StrValue;
4036 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
4037 EFI_BROWSER_ACTION_REQUEST ActionRequest;
4038 INTN Action;
4039 CHAR16 *NewString;
4040 EFI_IFR_TYPE_VALUE *TypeValue;
4041
4042 Status = EFI_NOT_FOUND;
4043 StrValue = NULL;
4044
4045 //
4046 // Statement don't have storage, skip them
4047 //
4048 if (Question->QuestionId == 0) {
4049 return Status;
4050 }
4051
4052 //
4053 // There are Five ways to specify default value for a Question:
4054 // 1, use call back function (highest priority)
4055 // 2, use ExtractConfig function
4056 // 3, use nested EFI_IFR_DEFAULT
4057 // 4, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
4058 // 5, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
4059 //
4060 HiiValue = &Question->HiiValue;
4061 TypeValue = &HiiValue->Value;
4062 if (HiiValue->Type == EFI_IFR_TYPE_BUFFER) {
4063 //
4064 // For orderedlist, need to pass the BufferValue to Callback function.
4065 //
4066 TypeValue = (EFI_IFR_TYPE_VALUE *) Question->BufferValue;
4067 }
4068
4069 //
4070 // Get Question defaut value from call back function.
4071 //
4072 ConfigAccess = FormSet->ConfigAccess;
4073 Action = GetDefaultIdForCallBack (DefaultId);
4074 if ((Action > 0) && ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) && (ConfigAccess != NULL)) {
4075 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
4076 Status = ConfigAccess->Callback (
4077 ConfigAccess,
4078 Action,
4079 Question->QuestionId,
4080 HiiValue->Type,
4081 TypeValue,
4082 &ActionRequest
4083 );
4084 if (!EFI_ERROR (Status)) {
4085 if (HiiValue->Type == EFI_IFR_TYPE_STRING) {
4086 NewString = GetToken (Question->HiiValue.Value.string, FormSet->HiiHandle);
4087 ASSERT (NewString != NULL);
4088
4089 ASSERT (StrLen (NewString) * sizeof (CHAR16) <= Question->StorageWidth);
4090 if (StrLen (NewString) * sizeof (CHAR16) <= Question->StorageWidth) {
4091 CopyMem (Question->BufferValue, NewString, StrSize (NewString));
4092 } else {
4093 CopyMem (Question->BufferValue, NewString, Question->StorageWidth);
4094 }
4095
4096 FreePool (NewString);
4097 }
4098 return Status;
4099 }
4100 }
4101
4102 //
4103 // Get default value from altcfg string.
4104 //
4105 if (ConfigAccess != NULL) {
4106 Status = GetDefaultValueFromAltCfg(FormSet, Form, Question);
4107 if (!EFI_ERROR (Status)) {
4108 return Status;
4109 }
4110 }
4111
4112 //
4113 // EFI_IFR_DEFAULT has highest priority
4114 //
4115 if (!IsListEmpty (&Question->DefaultListHead)) {
4116 Link = GetFirstNode (&Question->DefaultListHead);
4117 while (!IsNull (&Question->DefaultListHead, Link)) {
4118 Default = QUESTION_DEFAULT_FROM_LINK (Link);
4119
4120 if (Default->DefaultId == DefaultId) {
4121 if (Default->ValueExpression != NULL) {
4122 //
4123 // Default is provided by an Expression, evaluate it
4124 //
4125 Status = EvaluateExpression (FormSet, Form, Default->ValueExpression);
4126 if (EFI_ERROR (Status)) {
4127 return Status;
4128 }
4129
4130 if (Default->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
4131 ASSERT (HiiValue->Type == EFI_IFR_TYPE_BUFFER && Question->BufferValue != NULL);
4132 if (Question->StorageWidth > Default->ValueExpression->Result.BufferLen) {
4133 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Default->ValueExpression->Result.BufferLen);
4134 Question->HiiValue.BufferLen = Default->ValueExpression->Result.BufferLen;
4135 } else {
4136 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Question->StorageWidth);
4137 Question->HiiValue.BufferLen = Question->StorageWidth;
4138 }
4139 FreePool (Default->ValueExpression->Result.Buffer);
4140 }
4141 HiiValue->Type = Default->ValueExpression->Result.Type;
4142 CopyMem (&HiiValue->Value, &Default->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
4143 } else {
4144 //
4145 // Default value is embedded in EFI_IFR_DEFAULT
4146 //
4147 if (Default->Value.Type == EFI_IFR_TYPE_BUFFER) {
4148 ASSERT (HiiValue->Buffer != NULL);
4149 CopyMem (HiiValue->Buffer, Default->Value.Buffer, Default->Value.BufferLen);
4150 } else {
4151 CopyMem (HiiValue, &Default->Value, sizeof (EFI_HII_VALUE));
4152 }
4153 }
4154
4155 if (HiiValue->Type == EFI_IFR_TYPE_STRING) {
4156 StrValue = HiiGetString (FormSet->HiiHandle, HiiValue->Value.string, NULL);
4157 if (StrValue == NULL) {
4158 return EFI_NOT_FOUND;
4159 }
4160 if (Question->StorageWidth > StrSize (StrValue)) {
4161 CopyMem (Question->BufferValue, StrValue, StrSize (StrValue));
4162 } else {
4163 CopyMem (Question->BufferValue, StrValue, Question->StorageWidth);
4164 }
4165 }
4166
4167 return EFI_SUCCESS;
4168 }
4169
4170 Link = GetNextNode (&Question->DefaultListHead, Link);
4171 }
4172 }
4173
4174 //
4175 // EFI_ONE_OF_OPTION
4176 //
4177 if ((Question->Operand == EFI_IFR_ONE_OF_OP) && !IsListEmpty (&Question->OptionListHead)) {
4178 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
4179 //
4180 // OneOfOption could only provide Standard and Manufacturing default
4181 //
4182 Link = GetFirstNode (&Question->OptionListHead);
4183 while (!IsNull (&Question->OptionListHead, Link)) {
4184 Option = QUESTION_OPTION_FROM_LINK (Link);
4185 Link = GetNextNode (&Question->OptionListHead, Link);
4186
4187 if ((Option->SuppressExpression != NULL) &&
4188 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4189 continue;
4190 }
4191
4192 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT) != 0)) ||
4193 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT_MFG) != 0))
4194 ) {
4195 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
4196
4197 return EFI_SUCCESS;
4198 }
4199 }
4200 }
4201 }
4202
4203 //
4204 // EFI_IFR_CHECKBOX - lowest priority
4205 //
4206 if (Question->Operand == EFI_IFR_CHECKBOX_OP) {
4207 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
4208 //
4209 // Checkbox could only provide Standard and Manufacturing default
4210 //
4211 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT) != 0)) ||
4212 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT_MFG) != 0))
4213 ) {
4214 HiiValue->Value.b = TRUE;
4215 } else {
4216 HiiValue->Value.b = FALSE;
4217 }
4218
4219 return EFI_SUCCESS;
4220 }
4221 }
4222
4223 //
4224 // For Questions without default
4225 //
4226 Status = EFI_NOT_FOUND;
4227 switch (Question->Operand) {
4228 case EFI_IFR_NUMERIC_OP:
4229 //
4230 // Take minimum value as numeric default value
4231 //
4232 if ((Question->Flags & EFI_IFR_DISPLAY) == 0) {
4233 //
4234 // In EFI_IFR_DISPLAY_INT_DEC type, should check value with int* type.
4235 //
4236 switch (Question->Flags & EFI_IFR_NUMERIC_SIZE) {
4237 case EFI_IFR_NUMERIC_SIZE_1:
4238 if (((INT8) HiiValue->Value.u8 < (INT8) Question->Minimum) || ((INT8) HiiValue->Value.u8 > (INT8) Question->Maximum)) {
4239 HiiValue->Value.u8 = (UINT8) Question->Minimum;
4240 Status = EFI_SUCCESS;
4241 }
4242 break;
4243 case EFI_IFR_NUMERIC_SIZE_2:
4244 if (((INT16) HiiValue->Value.u16 < (INT16) Question->Minimum) || ((INT16) HiiValue->Value.u16 > (INT16) Question->Maximum)) {
4245 HiiValue->Value.u16 = (UINT16) Question->Minimum;
4246 Status = EFI_SUCCESS;
4247 }
4248 break;
4249 case EFI_IFR_NUMERIC_SIZE_4:
4250 if (((INT32) HiiValue->Value.u32 < (INT32) Question->Minimum) || ((INT32) HiiValue->Value.u32 > (INT32) Question->Maximum)) {
4251 HiiValue->Value.u32 = (UINT32) Question->Minimum;
4252 Status = EFI_SUCCESS;
4253 }
4254 break;
4255 case EFI_IFR_NUMERIC_SIZE_8:
4256 if (((INT64) HiiValue->Value.u64 < (INT64) Question->Minimum) || ((INT64) HiiValue->Value.u64 > (INT64) Question->Maximum)) {
4257 HiiValue->Value.u64 = Question->Minimum;
4258 Status = EFI_SUCCESS;
4259 }
4260 break;
4261 default:
4262 break;
4263 }
4264 } else {
4265 if ((HiiValue->Value.u64 < Question->Minimum) || (HiiValue->Value.u64 > Question->Maximum)) {
4266 HiiValue->Value.u64 = Question->Minimum;
4267 Status = EFI_SUCCESS;
4268 }
4269 }
4270 break;
4271
4272 case EFI_IFR_ONE_OF_OP:
4273 //
4274 // Take first oneof option as oneof's default value
4275 //
4276 if (ValueToOption (Question, HiiValue) == NULL) {
4277 Link = GetFirstNode (&Question->OptionListHead);
4278 while (!IsNull (&Question->OptionListHead, Link)) {
4279 Option = QUESTION_OPTION_FROM_LINK (Link);
4280 Link = GetNextNode (&Question->OptionListHead, Link);
4281
4282 if ((Option->SuppressExpression != NULL) &&
4283 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4284 continue;
4285 }
4286
4287 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
4288 Status = EFI_SUCCESS;
4289 break;
4290 }
4291 }
4292 break;
4293
4294 case EFI_IFR_ORDERED_LIST_OP:
4295 //
4296 // Take option sequence in IFR as ordered list's default value
4297 //
4298 Index = 0;
4299 Link = GetFirstNode (&Question->OptionListHead);
4300 while (!IsNull (&Question->OptionListHead, Link)) {
4301 Status = EFI_SUCCESS;
4302 Option = QUESTION_OPTION_FROM_LINK (Link);
4303 Link = GetNextNode (&Question->OptionListHead, Link);
4304
4305 if ((Option->SuppressExpression != NULL) &&
4306 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4307 continue;
4308 }
4309
4310 SetArrayData (Question->BufferValue, Question->ValueType, Index, Option->Value.Value.u64);
4311
4312 Index++;
4313 if (Index >= Question->MaxContainers) {
4314 break;
4315 }
4316 }
4317 break;
4318
4319 default:
4320 break;
4321 }
4322
4323 return Status;
4324 }
4325
4326 /**
4327 Get AltCfg string for current form.
4328
4329 @param FormSet Form data structure.
4330 @param Form Form data structure.
4331 @param DefaultId The Class of the default.
4332 @param BrowserStorage The input request storage for the questions.
4333
4334 **/
4335 VOID
4336 ExtractAltCfgForForm (
4337 IN FORM_BROWSER_FORMSET *FormSet,
4338 IN FORM_BROWSER_FORM *Form,
4339 IN UINT16 DefaultId,
4340 IN BROWSER_STORAGE *BrowserStorage
4341 )
4342 {
4343 EFI_STATUS Status;
4344 LIST_ENTRY *Link;
4345 CHAR16 *ConfigResp;
4346 CHAR16 *Progress;
4347 CHAR16 *Result;
4348 BROWSER_STORAGE *Storage;
4349 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
4350 FORMSET_STORAGE *FormSetStorage;
4351
4352 //
4353 // Check whether has get AltCfg string for this formset.
4354 // If yes, no need to get AltCfg for form.
4355 //
4356 Link = GetFirstNode (&FormSet->StorageListHead);
4357 while (!IsNull (&FormSet->StorageListHead, Link)) {
4358 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4359 Storage = FormSetStorage->BrowserStorage;
4360 Link = GetNextNode (&FormSet->StorageListHead, Link);
4361 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4362 continue;
4363 }
4364
4365 if (Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE &&
4366 FormSetStorage->ElementCount != 0 &&
4367 FormSetStorage->HasCallAltCfg) {
4368 return;
4369 }
4370 }
4371
4372 //
4373 // Get AltCfg string for each form.
4374 //
4375 Link = GetFirstNode (&Form->ConfigRequestHead);
4376 while (!IsNull (&Form->ConfigRequestHead, Link)) {
4377 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
4378 Link = GetNextNode (&Form->ConfigRequestHead, Link);
4379
4380 Storage = ConfigInfo->Storage;
4381 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4382 continue;
4383 }
4384
4385 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
4386 continue;
4387 }
4388
4389 //
4390 // 1. Skip if there is no RequestElement
4391 //
4392 if (ConfigInfo->ElementCount == 0) {
4393 continue;
4394 }
4395
4396 //
4397 // 2. Get value through hii config routine protocol.
4398 //
4399 Status = mHiiConfigRouting->ExtractConfig (
4400 mHiiConfigRouting,
4401 ConfigInfo->ConfigRequest,
4402 &Progress,
4403 &Result
4404 );
4405 if (EFI_ERROR (Status)) {
4406 continue;
4407 }
4408
4409 //
4410 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
4411 // Get the default configuration string according to the default ID.
4412 //
4413 Status = mHiiConfigRouting->GetAltConfig (
4414 mHiiConfigRouting,
4415 Result,
4416 &Storage->Guid,
4417 Storage->Name,
4418 NULL,
4419 &DefaultId, // it can be NULL to get the current setting.
4420 &ConfigResp
4421 );
4422 FreePool (Result);
4423 if (EFI_ERROR (Status)) {
4424 continue;
4425 }
4426
4427 ConfigInfo->ConfigAltResp = ConfigResp;
4428 }
4429 }
4430
4431 /**
4432 Clean AltCfg string for current form.
4433
4434 @param Form Form data structure.
4435
4436 **/
4437 VOID
4438 CleanAltCfgForForm (
4439 IN FORM_BROWSER_FORM *Form
4440 )
4441 {
4442 LIST_ENTRY *Link;
4443 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
4444
4445 Link = GetFirstNode (&Form->ConfigRequestHead);
4446 while (!IsNull (&Form->ConfigRequestHead, Link)) {
4447 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
4448 Link = GetNextNode (&Form->ConfigRequestHead, Link);
4449
4450 if (ConfigInfo->ConfigAltResp != NULL) {
4451 FreePool (ConfigInfo->ConfigAltResp);
4452 ConfigInfo->ConfigAltResp = NULL;
4453 }
4454 }
4455 }
4456
4457 /**
4458 Get AltCfg string for current formset.
4459
4460 @param FormSet Form data structure.
4461 @param DefaultId The Class of the default.
4462 @param BrowserStorage The input request storage for the questions.
4463
4464 **/
4465 VOID
4466 ExtractAltCfgForFormSet (
4467 IN FORM_BROWSER_FORMSET *FormSet,
4468 IN UINT16 DefaultId,
4469 IN BROWSER_STORAGE *BrowserStorage
4470 )
4471 {
4472 EFI_STATUS Status;
4473 LIST_ENTRY *Link;
4474 CHAR16 *ConfigResp;
4475 CHAR16 *Progress;
4476 CHAR16 *Result;
4477 BROWSER_STORAGE *Storage;
4478 FORMSET_STORAGE *FormSetStorage;
4479
4480 Link = GetFirstNode (&FormSet->StorageListHead);
4481 while (!IsNull (&FormSet->StorageListHead, Link)) {
4482 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4483 Storage = FormSetStorage->BrowserStorage;
4484 Link = GetNextNode (&FormSet->StorageListHead, Link);
4485
4486 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4487 continue;
4488 }
4489
4490 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
4491 continue;
4492 }
4493
4494 //
4495 // 1. Skip if there is no RequestElement
4496 //
4497 if (FormSetStorage->ElementCount == 0) {
4498 continue;
4499 }
4500
4501 FormSetStorage->HasCallAltCfg = TRUE;
4502
4503 //
4504 // 2. Get value through hii config routine protocol.
4505 //
4506 Status = mHiiConfigRouting->ExtractConfig (
4507 mHiiConfigRouting,
4508 FormSetStorage->ConfigRequest,
4509 &Progress,
4510 &Result
4511 );
4512 if (EFI_ERROR (Status)) {
4513 continue;
4514 }
4515
4516 //
4517 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
4518 // Get the default configuration string according to the default ID.
4519 //
4520 Status = mHiiConfigRouting->GetAltConfig (
4521 mHiiConfigRouting,
4522 Result,
4523 &Storage->Guid,
4524 Storage->Name,
4525 NULL,
4526 &DefaultId, // it can be NULL to get the current setting.
4527 &ConfigResp
4528 );
4529
4530 FreePool (Result);
4531 if (EFI_ERROR (Status)) {
4532 continue;
4533 }
4534
4535 FormSetStorage->ConfigAltResp = ConfigResp;
4536 }
4537
4538 }
4539
4540 /**
4541 Clean AltCfg string for current formset.
4542
4543 @param FormSet Form data structure.
4544
4545 **/
4546 VOID
4547 CleanAltCfgForFormSet (
4548 IN FORM_BROWSER_FORMSET *FormSet
4549 )
4550 {
4551 LIST_ENTRY *Link;
4552 FORMSET_STORAGE *FormSetStorage;
4553
4554 Link = GetFirstNode (&FormSet->StorageListHead);
4555 while (!IsNull (&FormSet->StorageListHead, Link)) {
4556 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4557 Link = GetNextNode (&FormSet->StorageListHead, Link);
4558
4559 if (FormSetStorage->ConfigAltResp != NULL) {
4560 FreePool (FormSetStorage->ConfigAltResp);
4561 FormSetStorage->ConfigAltResp = NULL;
4562 }
4563
4564 FormSetStorage->HasCallAltCfg = FALSE;
4565 }
4566 }
4567
4568 /**
4569 Reset Questions to their initial value or default value in a Form, Formset or System.
4570
4571 GetDefaultValueScope parameter decides which questions will reset
4572 to its default value.
4573
4574 @param FormSet FormSet data structure.
4575 @param Form Form data structure.
4576 @param DefaultId The Class of the default.
4577 @param SettingScope Setting Scope for Default action.
4578 @param GetDefaultValueScope Get default value scope.
4579 @param Storage Get default value only for this storage.
4580 @param RetrieveValueFirst Whether call the retrieve call back to
4581 get the initial value before get default
4582 value.
4583 @param SkipGetAltCfg Whether skip the get altcfg string process.
4584
4585 @retval EFI_SUCCESS The function completed successfully.
4586 @retval EFI_UNSUPPORTED Unsupport SettingScope.
4587
4588 **/
4589 EFI_STATUS
4590 ExtractDefault (
4591 IN FORM_BROWSER_FORMSET *FormSet,
4592 IN FORM_BROWSER_FORM *Form,
4593 IN UINT16 DefaultId,
4594 IN BROWSER_SETTING_SCOPE SettingScope,
4595 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope,
4596 IN BROWSER_STORAGE *Storage OPTIONAL,
4597 IN BOOLEAN RetrieveValueFirst,
4598 IN BOOLEAN SkipGetAltCfg
4599 )
4600 {
4601 EFI_STATUS Status;
4602 LIST_ENTRY *FormLink;
4603 LIST_ENTRY *Link;
4604 FORM_BROWSER_STATEMENT *Question;
4605 FORM_BROWSER_FORMSET *LocalFormSet;
4606 FORM_BROWSER_FORMSET *OldFormSet;
4607
4608 Status = EFI_SUCCESS;
4609
4610 //
4611 // Check the supported setting level.
4612 //
4613 if (SettingScope >= MaxLevel || GetDefaultValueScope >= GetDefaultForMax) {
4614 return EFI_UNSUPPORTED;
4615 }
4616
4617 if (GetDefaultValueScope == GetDefaultForStorage && Storage == NULL) {
4618 return EFI_UNSUPPORTED;
4619 }
4620
4621 if (SettingScope == FormLevel) {
4622 //
4623 // Prepare the AltCfg String for form.
4624 //
4625 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4626 ExtractAltCfgForForm (FormSet, Form, DefaultId, Storage);
4627 }
4628
4629 //
4630 // Extract Form default
4631 //
4632 Link = GetFirstNode (&Form->StatementListHead);
4633 while (!IsNull (&Form->StatementListHead, Link)) {
4634 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
4635 Link = GetNextNode (&Form->StatementListHead, Link);
4636
4637 //
4638 // If get default value only for this storage, check the storage first.
4639 //
4640 if ((GetDefaultValueScope == GetDefaultForStorage) && (Question->Storage != Storage)) {
4641 continue;
4642 }
4643
4644 //
4645 // If get default value only for no storage question, just skip the question which has storage.
4646 //
4647 if ((GetDefaultValueScope == GetDefaultForNoStorage) && (Question->Storage != NULL)) {
4648 continue;
4649 }
4650
4651 //
4652 // If Question is disabled, don't reset it to default
4653 //
4654 if (Question->Expression != NULL) {
4655 if (EvaluateExpressionList(Question->Expression, TRUE, FormSet, Form) == ExpressDisable) {
4656 continue;
4657 }
4658 }
4659
4660 if (RetrieveValueFirst) {
4661 //
4662 // Call the Retrieve call back to get the initial question value.
4663 //
4664 Status = ProcessRetrieveForQuestion(FormSet->ConfigAccess, Question, FormSet);
4665 }
4666
4667 //
4668 // If not request to get the initial value or get initial value fail, then get default value.
4669 //
4670 if (!RetrieveValueFirst || EFI_ERROR (Status)) {
4671 Status = GetQuestionDefault (FormSet, Form, Question, DefaultId);
4672 if (EFI_ERROR (Status)) {
4673 continue;
4674 }
4675 }
4676
4677 //
4678 // Synchronize Buffer storage's Edit buffer
4679 //
4680 if ((Question->Storage != NULL) &&
4681 (Question->Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE)) {
4682 SetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4683 }
4684 }
4685
4686 //
4687 // Clean the AltCfg String.
4688 //
4689 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4690 CleanAltCfgForForm(Form);
4691 }
4692 } else if (SettingScope == FormSetLevel) {
4693 //
4694 // Prepare the AltCfg String for formset.
4695 //
4696 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4697 ExtractAltCfgForFormSet (FormSet, DefaultId, Storage);
4698 }
4699
4700 FormLink = GetFirstNode (&FormSet->FormListHead);
4701 while (!IsNull (&FormSet->FormListHead, FormLink)) {
4702 Form = FORM_BROWSER_FORM_FROM_LINK (FormLink);
4703 ExtractDefault (FormSet, Form, DefaultId, FormLevel, GetDefaultValueScope, Storage, RetrieveValueFirst, SkipGetAltCfg);
4704 FormLink = GetNextNode (&FormSet->FormListHead, FormLink);
4705 }
4706
4707 //
4708 // Clean the AltCfg String.
4709 //
4710 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4711 CleanAltCfgForFormSet (FormSet);
4712 }
4713 } else if (SettingScope == SystemLevel) {
4714 //
4715 // Preload all Hii formset.
4716 //
4717 LoadAllHiiFormset();
4718
4719 OldFormSet = mSystemLevelFormSet;
4720
4721 //
4722 // Set Default Value for each FormSet in the maintain list.
4723 //
4724 Link = GetFirstNode (&gBrowserFormSetList);
4725 while (!IsNull (&gBrowserFormSetList, Link)) {
4726 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
4727 Link = GetNextNode (&gBrowserFormSetList, Link);
4728 if (!ValidateFormSet(LocalFormSet)) {
4729 continue;
4730 }
4731
4732 mSystemLevelFormSet = LocalFormSet;
4733
4734 ExtractDefault (LocalFormSet, NULL, DefaultId, FormSetLevel, GetDefaultValueScope, Storage, RetrieveValueFirst, SkipGetAltCfg);
4735 }
4736
4737 mSystemLevelFormSet = OldFormSet;
4738 }
4739
4740 return EFI_SUCCESS;
4741 }
4742
4743
4744 /**
4745 Validate whether this question's value has changed.
4746
4747 @param FormSet FormSet data structure.
4748 @param Form Form data structure.
4749 @param Question Question to be initialized.
4750 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
4751
4752 @retval TRUE Question's value has changed.
4753 @retval FALSE Question's value has not changed
4754
4755 **/
4756 BOOLEAN
4757 IsQuestionValueChanged (
4758 IN FORM_BROWSER_FORMSET *FormSet,
4759 IN FORM_BROWSER_FORM *Form,
4760 IN OUT FORM_BROWSER_STATEMENT *Question,
4761 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
4762 )
4763 {
4764 EFI_HII_VALUE BackUpValue;
4765 CHAR8 *BackUpBuffer;
4766 EFI_HII_VALUE BackUpValue2;
4767 CHAR8 *BackUpBuffer2;
4768 EFI_STATUS Status;
4769 BOOLEAN ValueChanged;
4770 UINTN BufferWidth;
4771
4772 //
4773 // For quetion without storage, always mark it as data not changed.
4774 //
4775 if (Question->Storage == NULL && Question->Operand != EFI_IFR_TIME_OP && Question->Operand != EFI_IFR_DATE_OP) {
4776 return FALSE;
4777 }
4778
4779 BackUpBuffer = NULL;
4780 BackUpBuffer2 = NULL;
4781 ValueChanged = FALSE;
4782
4783 switch (Question->Operand) {
4784 case EFI_IFR_ORDERED_LIST_OP:
4785 BufferWidth = Question->StorageWidth;
4786 BackUpBuffer = AllocateCopyPool (BufferWidth, Question->BufferValue);
4787 ASSERT (BackUpBuffer != NULL);
4788 break;
4789
4790 case EFI_IFR_STRING_OP:
4791 case EFI_IFR_PASSWORD_OP:
4792 BufferWidth = (UINTN) Question->Maximum * sizeof (CHAR16);
4793 BackUpBuffer = AllocateCopyPool (BufferWidth, Question->BufferValue);
4794 ASSERT (BackUpBuffer != NULL);
4795 break;
4796
4797 default:
4798 BufferWidth = 0;
4799 break;
4800 }
4801 CopyMem (&BackUpValue, &Question->HiiValue, sizeof (EFI_HII_VALUE));
4802
4803 if (GetValueFrom == GetSetValueWithBothBuffer) {
4804 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4805 ASSERT_EFI_ERROR(Status);
4806
4807 switch (Question->Operand) {
4808 case EFI_IFR_ORDERED_LIST_OP:
4809 BufferWidth = Question->StorageWidth;
4810 BackUpBuffer2 = AllocateCopyPool (BufferWidth, Question->BufferValue);
4811 ASSERT (BackUpBuffer2 != NULL);
4812 break;
4813
4814 case EFI_IFR_STRING_OP:
4815 case EFI_IFR_PASSWORD_OP:
4816 BufferWidth = (UINTN) Question->Maximum * sizeof (CHAR16);
4817 BackUpBuffer2 = AllocateCopyPool (BufferWidth, Question->BufferValue);
4818 ASSERT (BackUpBuffer2 != NULL);
4819 break;
4820
4821 default:
4822 BufferWidth = 0;
4823 break;
4824 }
4825 CopyMem (&BackUpValue2, &Question->HiiValue, sizeof (EFI_HII_VALUE));
4826
4827 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithBuffer);
4828 ASSERT_EFI_ERROR(Status);
4829
4830 if (CompareMem (&BackUpValue2, &Question->HiiValue, sizeof (EFI_HII_VALUE)) != 0 ||
4831 CompareMem (BackUpBuffer2, Question->BufferValue, BufferWidth) != 0) {
4832 ValueChanged = TRUE;
4833 }
4834 } else {
4835 Status = GetQuestionValue (FormSet, Form, Question, GetValueFrom);
4836 ASSERT_EFI_ERROR(Status);
4837
4838 if (CompareMem (&BackUpValue, &Question->HiiValue, sizeof (EFI_HII_VALUE)) != 0 ||
4839 CompareMem (BackUpBuffer, Question->BufferValue, BufferWidth) != 0) {
4840 ValueChanged = TRUE;
4841 }
4842 }
4843
4844 CopyMem (&Question->HiiValue, &BackUpValue, sizeof (EFI_HII_VALUE));
4845 if (BackUpBuffer != NULL) {
4846 CopyMem (Question->BufferValue, BackUpBuffer, BufferWidth);
4847 FreePool (BackUpBuffer);
4848 }
4849
4850 if (BackUpBuffer2 != NULL) {
4851 FreePool (BackUpBuffer2);
4852 }
4853
4854 Question->ValueChanged = ValueChanged;
4855
4856 return ValueChanged;
4857 }
4858
4859 /**
4860 Initialize Question's Edit copy from Storage.
4861
4862 @param Selection Selection contains the information about
4863 the Selection, form and formset to be displayed.
4864 Selection action may be updated in retrieve callback.
4865 If Selection is NULL, only initialize Question value.
4866 @param FormSet FormSet data structure.
4867 @param Form Form data structure.
4868
4869 @retval EFI_SUCCESS The function completed successfully.
4870
4871 **/
4872 EFI_STATUS
4873 LoadFormConfig (
4874 IN OUT UI_MENU_SELECTION *Selection,
4875 IN FORM_BROWSER_FORMSET *FormSet,
4876 IN FORM_BROWSER_FORM *Form
4877 )
4878 {
4879 EFI_STATUS Status;
4880 LIST_ENTRY *Link;
4881 FORM_BROWSER_STATEMENT *Question;
4882
4883 Link = GetFirstNode (&Form->StatementListHead);
4884 while (!IsNull (&Form->StatementListHead, Link)) {
4885 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
4886
4887 //
4888 // Initialize local copy of Value for each Question
4889 //
4890 if (Question->Operand == EFI_IFR_PASSWORD_OP && (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK)== 0) {
4891 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithHiiDriver);
4892 } else {
4893 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4894 }
4895 if (EFI_ERROR (Status)) {
4896 return Status;
4897 }
4898
4899 if ((Question->Operand == EFI_IFR_STRING_OP) || (Question->Operand == EFI_IFR_PASSWORD_OP)) {
4900 HiiSetString (FormSet->HiiHandle, Question->HiiValue.Value.string, (CHAR16*)Question->BufferValue, NULL);
4901 }
4902
4903 Link = GetNextNode (&Form->StatementListHead, Link);
4904 }
4905
4906 return EFI_SUCCESS;
4907 }
4908
4909 /**
4910 Initialize Question's Edit copy from Storage for the whole Formset.
4911
4912 @param Selection Selection contains the information about
4913 the Selection, form and formset to be displayed.
4914 Selection action may be updated in retrieve callback.
4915 If Selection is NULL, only initialize Question value.
4916 @param FormSet FormSet data structure.
4917
4918 @retval EFI_SUCCESS The function completed successfully.
4919
4920 **/
4921 EFI_STATUS
4922 LoadFormSetConfig (
4923 IN OUT UI_MENU_SELECTION *Selection,
4924 IN FORM_BROWSER_FORMSET *FormSet
4925 )
4926 {
4927 EFI_STATUS Status;
4928 LIST_ENTRY *Link;
4929 FORM_BROWSER_FORM *Form;
4930
4931 Link = GetFirstNode (&FormSet->FormListHead);
4932 while (!IsNull (&FormSet->FormListHead, Link)) {
4933 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
4934
4935 //
4936 // Initialize local copy of Value for each Form
4937 //
4938 Status = LoadFormConfig (Selection, FormSet, Form);
4939 if (EFI_ERROR (Status)) {
4940 return Status;
4941 }
4942
4943 Link = GetNextNode (&FormSet->FormListHead, Link);
4944 }
4945
4946 //
4947 // Finished question initialization.
4948 //
4949 FormSet->QuestionInited = TRUE;
4950
4951 return EFI_SUCCESS;
4952 }
4953
4954 /**
4955 Remove the Request element from the Config Request.
4956
4957 @param Storage Pointer to the browser storage.
4958 @param RequestElement The pointer to the Request element.
4959
4960 **/
4961 VOID
4962 RemoveElement (
4963 IN OUT BROWSER_STORAGE *Storage,
4964 IN CHAR16 *RequestElement
4965 )
4966 {
4967 CHAR16 *NewStr;
4968 CHAR16 *DestStr;
4969
4970 ASSERT (Storage->ConfigRequest != NULL && RequestElement != NULL);
4971
4972 NewStr = StrStr (Storage->ConfigRequest, RequestElement);
4973
4974 if (NewStr == NULL) {
4975 return;
4976 }
4977
4978 //
4979 // Remove this element from this ConfigRequest.
4980 //
4981 DestStr = NewStr;
4982 NewStr += StrLen (RequestElement);
4983 CopyMem (DestStr, NewStr, StrSize (NewStr));
4984
4985 Storage->SpareStrLen += StrLen (RequestElement);
4986 }
4987
4988 /**
4989 Adjust config request in storage, remove the request elements existed in the input ConfigRequest.
4990
4991 @param Storage Pointer to the formset storage.
4992 @param ConfigRequest The pointer to the Request element.
4993
4994 **/
4995 VOID
4996 RemoveConfigRequest (
4997 FORMSET_STORAGE *Storage,
4998 CHAR16 *ConfigRequest
4999 )
5000 {
5001 CHAR16 *RequestElement;
5002 CHAR16 *NextRequestElement;
5003 CHAR16 *SearchKey;
5004
5005 //
5006 // No request element in it, just return.
5007 //
5008 if (ConfigRequest == NULL) {
5009 return;
5010 }
5011
5012 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5013 //
5014 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
5015 //
5016 SearchKey = L"&";
5017 } else {
5018 //
5019 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
5020 //
5021 SearchKey = L"&OFFSET";
5022 }
5023
5024 //
5025 // Find SearchKey storage
5026 //
5027 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5028 RequestElement = StrStr (ConfigRequest, L"PATH");
5029 ASSERT (RequestElement != NULL);
5030 RequestElement = StrStr (RequestElement, SearchKey);
5031 } else {
5032 RequestElement = StrStr (ConfigRequest, SearchKey);
5033 }
5034
5035 while (RequestElement != NULL) {
5036 //
5037 // +1 to avoid find header itself.
5038 //
5039 NextRequestElement = StrStr (RequestElement + 1, SearchKey);
5040
5041 //
5042 // The last Request element in configRequest string.
5043 //
5044 if (NextRequestElement != NULL) {
5045 //
5046 // Replace "&" with '\0'.
5047 //
5048 *NextRequestElement = L'\0';
5049 }
5050
5051 RemoveElement (Storage->BrowserStorage, RequestElement);
5052
5053 if (NextRequestElement != NULL) {
5054 //
5055 // Restore '&' with '\0' for later used.
5056 //
5057 *NextRequestElement = L'&';
5058 }
5059
5060 RequestElement = NextRequestElement;
5061 }
5062
5063 //
5064 // If no request element remain, just remove the ConfigRequest string.
5065 //
5066 if (StrCmp (Storage->BrowserStorage->ConfigRequest, Storage->ConfigHdr) == 0) {
5067 FreePool (Storage->BrowserStorage->ConfigRequest);
5068 Storage->BrowserStorage->ConfigRequest = NULL;
5069 Storage->BrowserStorage->SpareStrLen = 0;
5070 }
5071 }
5072
5073 /**
5074 Base on the current formset info, clean the ConfigRequest string in browser storage.
5075
5076 @param FormSet Pointer of the FormSet
5077
5078 **/
5079 VOID
5080 CleanBrowserStorage (
5081 IN OUT FORM_BROWSER_FORMSET *FormSet
5082 )
5083 {
5084 LIST_ENTRY *Link;
5085 FORMSET_STORAGE *Storage;
5086
5087 Link = GetFirstNode (&FormSet->StorageListHead);
5088 while (!IsNull (&FormSet->StorageListHead, Link)) {
5089 Storage = FORMSET_STORAGE_FROM_LINK (Link);
5090 Link = GetNextNode (&FormSet->StorageListHead, Link);
5091
5092 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
5093 if (Storage->ConfigRequest == NULL || Storage->BrowserStorage->ConfigRequest == NULL) {
5094 continue;
5095 }
5096
5097 RemoveConfigRequest (Storage, Storage->ConfigRequest);
5098 } else if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_BUFFER ||
5099 Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5100 if (Storage->BrowserStorage->ConfigRequest != NULL) {
5101 FreePool (Storage->BrowserStorage->ConfigRequest);
5102 Storage->BrowserStorage->ConfigRequest = NULL;
5103 }
5104 Storage->BrowserStorage->Initialized = FALSE;
5105 }
5106 }
5107 }
5108
5109 /**
5110 Check whether current element in the ConfigReqeust string.
5111
5112 @param BrowserStorage Storage which includes ConfigReqeust.
5113 @param RequestElement New element need to check.
5114
5115 @retval TRUE The Element is in the ConfigReqeust string.
5116 @retval FALSE The Element not in the configReqeust String.
5117
5118 **/
5119 BOOLEAN
5120 ElementValidation (
5121 BROWSER_STORAGE *BrowserStorage,
5122 CHAR16 *RequestElement
5123 )
5124 {
5125 return StrStr (BrowserStorage->ConfigRequest, RequestElement) != NULL ? TRUE : FALSE;
5126 }
5127
5128 /**
5129 Append the Request element to the Config Request.
5130
5131 @param ConfigRequest Current ConfigRequest info.
5132 @param SpareStrLen Current remain free buffer for config reqeust.
5133 @param RequestElement New Request element.
5134
5135 **/
5136 VOID
5137 AppendConfigRequest (
5138 IN OUT CHAR16 **ConfigRequest,
5139 IN OUT UINTN *SpareStrLen,
5140 IN CHAR16 *RequestElement
5141 )
5142 {
5143 CHAR16 *NewStr;
5144 UINTN StringSize;
5145 UINTN StrLength;
5146 UINTN MaxLen;
5147
5148 StrLength = StrLen (RequestElement);
5149 StringSize = (*ConfigRequest != NULL) ? StrSize (*ConfigRequest) : sizeof (CHAR16);
5150 MaxLen = StringSize / sizeof (CHAR16) + *SpareStrLen;
5151
5152 //
5153 // Append <RequestElement> to <ConfigRequest>
5154 //
5155 if (StrLength > *SpareStrLen) {
5156 //
5157 // Old String buffer is not sufficient for RequestElement, allocate a new one
5158 //
5159 MaxLen = StringSize / sizeof (CHAR16) + CONFIG_REQUEST_STRING_INCREMENTAL;
5160 NewStr = AllocateZeroPool (MaxLen * sizeof (CHAR16));
5161 ASSERT (NewStr != NULL);
5162
5163 if (*ConfigRequest != NULL) {
5164 CopyMem (NewStr, *ConfigRequest, StringSize);
5165 FreePool (*ConfigRequest);
5166 }
5167 *ConfigRequest = NewStr;
5168 *SpareStrLen = CONFIG_REQUEST_STRING_INCREMENTAL;
5169 }
5170
5171 StrCatS (*ConfigRequest, MaxLen, RequestElement);
5172 *SpareStrLen -= StrLength;
5173 }
5174
5175 /**
5176 Adjust the config request info, remove the request elements which already in AllConfigRequest string.
5177
5178 @param Storage Form set Storage.
5179 @param Request The input request string.
5180 @param RespString Whether the input is ConfigRequest or ConfigResp format.
5181
5182 @retval TRUE Has element not covered by current used elements, need to continue to call ExtractConfig
5183 @retval FALSE All elements covered by current used elements.
5184
5185 **/
5186 BOOLEAN
5187 ConfigRequestAdjust (
5188 IN BROWSER_STORAGE *Storage,
5189 IN CHAR16 *Request,
5190 IN BOOLEAN RespString
5191 )
5192 {
5193 CHAR16 *RequestElement;
5194 CHAR16 *NextRequestElement;
5195 CHAR16 *NextElementBakup;
5196 CHAR16 *SearchKey;
5197 CHAR16 *ValueKey;
5198 BOOLEAN RetVal;
5199 CHAR16 *ConfigRequest;
5200
5201 RetVal = FALSE;
5202 NextElementBakup = NULL;
5203 ValueKey = NULL;
5204
5205 if (Request != NULL) {
5206 ConfigRequest = Request;
5207 } else {
5208 ConfigRequest = Storage->ConfigRequest;
5209 }
5210
5211 if (Storage->ConfigRequest == NULL) {
5212 Storage->ConfigRequest = AllocateCopyPool (StrSize (ConfigRequest), ConfigRequest);
5213 return TRUE;
5214 }
5215
5216 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5217 //
5218 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
5219 //
5220 SearchKey = L"&";
5221 } else {
5222 //
5223 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
5224 //
5225 SearchKey = L"&OFFSET";
5226 ValueKey = L"&VALUE";
5227 }
5228
5229 //
5230 // Find SearchKey storage
5231 //
5232 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5233 RequestElement = StrStr (ConfigRequest, L"PATH");
5234 ASSERT (RequestElement != NULL);
5235 RequestElement = StrStr (RequestElement, SearchKey);
5236 } else {
5237 RequestElement = StrStr (ConfigRequest, SearchKey);
5238 }
5239
5240 while (RequestElement != NULL) {
5241
5242 //
5243 // +1 to avoid find header itself.
5244 //
5245 NextRequestElement = StrStr (RequestElement + 1, SearchKey);
5246
5247 //
5248 // The last Request element in configRequest string.
5249 //
5250 if (NextRequestElement != NULL) {
5251 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5252 NextElementBakup = NextRequestElement;
5253 NextRequestElement = StrStr (RequestElement, ValueKey);
5254 ASSERT (NextRequestElement != NULL);
5255 }
5256 //
5257 // Replace "&" with '\0'.
5258 //
5259 *NextRequestElement = L'\0';
5260 } else {
5261 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5262 NextElementBakup = NextRequestElement;
5263 NextRequestElement = StrStr (RequestElement, ValueKey);
5264 ASSERT (NextRequestElement != NULL);
5265 //
5266 // Replace "&" with '\0'.
5267 //
5268 *NextRequestElement = L'\0';
5269 }
5270 }
5271
5272 if (!ElementValidation (Storage, RequestElement)) {
5273 //
5274 // Add this element to the Storage->BrowserStorage->AllRequestElement.
5275 //
5276 AppendConfigRequest(&Storage->ConfigRequest, &Storage->SpareStrLen, RequestElement);
5277 RetVal = TRUE;
5278 }
5279
5280 if (NextRequestElement != NULL) {
5281 //
5282 // Restore '&' with '\0' for later used.
5283 //
5284 *NextRequestElement = L'&';
5285 }
5286
5287 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5288 RequestElement = NextElementBakup;
5289 } else {
5290 RequestElement = NextRequestElement;
5291 }
5292 }
5293
5294 return RetVal;
5295 }
5296
5297 /**
5298 Fill storage's edit copy with settings requested from Configuration Driver.
5299
5300 @param FormSet FormSet data structure.
5301 @param Storage Buffer Storage.
5302
5303 **/
5304 VOID
5305 LoadStorage (
5306 IN FORM_BROWSER_FORMSET *FormSet,
5307 IN FORMSET_STORAGE *Storage
5308 )
5309 {
5310 EFI_STATUS Status;
5311 EFI_STRING Progress;
5312 EFI_STRING Result;
5313 CHAR16 *StrPtr;
5314 EFI_STRING ConfigRequest;
5315 UINTN StrLen;
5316
5317 ConfigRequest = NULL;
5318
5319 switch (Storage->BrowserStorage->Type) {
5320 case EFI_HII_VARSTORE_EFI_VARIABLE:
5321 return;
5322
5323 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
5324 if (Storage->BrowserStorage->ConfigRequest != NULL) {
5325 ConfigRequestAdjust(Storage->BrowserStorage, Storage->ConfigRequest, FALSE);
5326 return;
5327 }
5328 break;
5329
5330 case EFI_HII_VARSTORE_BUFFER:
5331 case EFI_HII_VARSTORE_NAME_VALUE:
5332 //
5333 // Skip if there is no RequestElement.
5334 //
5335 if (Storage->ElementCount == 0) {
5336 return;
5337 }
5338
5339 //
5340 // Just update the ConfigRequest, if storage already initialized.
5341 //
5342 if (Storage->BrowserStorage->Initialized) {
5343 ConfigRequestAdjust(Storage->BrowserStorage, Storage->ConfigRequest, FALSE);
5344 return;
5345 }
5346
5347 Storage->BrowserStorage->Initialized = TRUE;
5348 break;
5349
5350 default:
5351 return;
5352 }
5353
5354 if (Storage->BrowserStorage->Type != EFI_HII_VARSTORE_NAME_VALUE) {
5355 //
5356 // Create the config request string to get all fields for this storage.
5357 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
5358 // followed by "&OFFSET=0&WIDTH=WWWW"followed by a Null-terminator
5359 //
5360 StrLen = StrSize (Storage->ConfigHdr) + 20 * sizeof (CHAR16);
5361 ConfigRequest = AllocateZeroPool (StrLen);
5362 ASSERT (ConfigRequest != NULL);
5363 UnicodeSPrint (
5364 ConfigRequest,
5365 StrLen,
5366 L"%s&OFFSET=0&WIDTH=%04x",
5367 Storage->ConfigHdr,
5368 Storage->BrowserStorage->Size);
5369 } else {
5370 ConfigRequest = Storage->ConfigRequest;
5371 }
5372
5373 //
5374 // Request current settings from Configuration Driver
5375 //
5376 Status = mHiiConfigRouting->ExtractConfig (
5377 mHiiConfigRouting,
5378 ConfigRequest,
5379 &Progress,
5380 &Result
5381 );
5382
5383 //
5384 // If get value fail, extract default from IFR binary
5385 //
5386 if (EFI_ERROR (Status)) {
5387 ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel, GetDefaultForStorage, Storage->BrowserStorage, TRUE, TRUE);
5388 } else {
5389 //
5390 // Convert Result from <ConfigAltResp> to <ConfigResp>
5391 //
5392 StrPtr = StrStr (Result, L"&GUID=");
5393 if (StrPtr != NULL) {
5394 *StrPtr = L'\0';
5395 }
5396
5397 Status = ConfigRespToStorage (Storage->BrowserStorage, Result);
5398 FreePool (Result);
5399 }
5400
5401 Storage->BrowserStorage->ConfigRequest = AllocateCopyPool (StrSize (Storage->ConfigRequest), Storage->ConfigRequest);
5402
5403 //
5404 // Input NULL for ConfigRequest field means sync all fields from editbuffer to buffer.
5405 //
5406 SynchronizeStorage(Storage->BrowserStorage, NULL, TRUE);
5407
5408 if (Storage->BrowserStorage->Type != EFI_HII_VARSTORE_NAME_VALUE) {
5409 if (ConfigRequest != NULL) {
5410 FreePool (ConfigRequest);
5411 }
5412 }
5413 }
5414
5415 /**
5416 Get Value changed status from old question.
5417
5418 @param NewFormSet FormSet data structure.
5419 @param OldQuestion Old question which has value changed.
5420
5421 **/
5422 VOID
5423 SyncStatusForQuestion (
5424 IN OUT FORM_BROWSER_FORMSET *NewFormSet,
5425 IN FORM_BROWSER_STATEMENT *OldQuestion
5426 )
5427 {
5428 LIST_ENTRY *Link;
5429 LIST_ENTRY *QuestionLink;
5430 FORM_BROWSER_FORM *Form;
5431 FORM_BROWSER_STATEMENT *Question;
5432
5433 //
5434 // For each form in one formset.
5435 //
5436 Link = GetFirstNode (&NewFormSet->FormListHead);
5437 while (!IsNull (&NewFormSet->FormListHead, Link)) {
5438 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
5439 Link = GetNextNode (&NewFormSet->FormListHead, Link);
5440
5441 //
5442 // for each question in one form.
5443 //
5444 QuestionLink = GetFirstNode (&Form->StatementListHead);
5445 while (!IsNull (&Form->StatementListHead, QuestionLink)) {
5446 Question = FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink);
5447 QuestionLink = GetNextNode (&Form->StatementListHead, QuestionLink);
5448
5449 if (Question->QuestionId == OldQuestion->QuestionId) {
5450 Question->ValueChanged = TRUE;
5451 return;
5452 }
5453 }
5454 }
5455 }
5456
5457 /**
5458 Get Value changed status from old formset.
5459
5460 @param NewFormSet FormSet data structure.
5461 @param OldFormSet FormSet data structure.
5462
5463 **/
5464 VOID
5465 SyncStatusForFormSet (
5466 IN OUT FORM_BROWSER_FORMSET *NewFormSet,
5467 IN FORM_BROWSER_FORMSET *OldFormSet
5468 )
5469 {
5470 LIST_ENTRY *Link;
5471 LIST_ENTRY *QuestionLink;
5472 FORM_BROWSER_FORM *Form;
5473 FORM_BROWSER_STATEMENT *Question;
5474
5475 //
5476 // For each form in one formset.
5477 //
5478 Link = GetFirstNode (&OldFormSet->FormListHead);
5479 while (!IsNull (&OldFormSet->FormListHead, Link)) {
5480 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
5481 Link = GetNextNode (&OldFormSet->FormListHead, Link);
5482
5483 //
5484 // for each question in one form.
5485 //
5486 QuestionLink = GetFirstNode (&Form->StatementListHead);
5487 while (!IsNull (&Form->StatementListHead, QuestionLink)) {
5488 Question = FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink);
5489 QuestionLink = GetNextNode (&Form->StatementListHead, QuestionLink);
5490
5491 if (!Question->ValueChanged) {
5492 continue;
5493 }
5494
5495 //
5496 // Find the same question in new formset and update the value changed flag.
5497 //
5498 SyncStatusForQuestion (NewFormSet, Question);
5499 }
5500 }
5501 }
5502
5503 /**
5504 Get current setting of Questions.
5505
5506 @param FormSet FormSet data structure.
5507
5508 **/
5509 VOID
5510 InitializeCurrentSetting (
5511 IN OUT FORM_BROWSER_FORMSET *FormSet
5512 )
5513 {
5514 LIST_ENTRY *Link;
5515 FORMSET_STORAGE *Storage;
5516 FORM_BROWSER_FORMSET *OldFormSet;
5517
5518 //
5519 // Try to find pre FormSet in the maintain backup list.
5520 // If old formset != NULL, destroy this formset. Add new formset to gBrowserFormSetList.
5521 //
5522 OldFormSet = GetFormSetFromHiiHandle (FormSet->HiiHandle);
5523 if (OldFormSet != NULL) {
5524 SyncStatusForFormSet (FormSet, OldFormSet);
5525 RemoveEntryList (&OldFormSet->Link);
5526 DestroyFormSet (OldFormSet);
5527 }
5528 InsertTailList (&gBrowserFormSetList, &FormSet->Link);
5529
5530 //
5531 // Extract default from IFR binary for no storage questions.
5532 //
5533 ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel, GetDefaultForNoStorage, NULL, TRUE, FALSE);
5534
5535 //
5536 // Request current settings from Configuration Driver
5537 //
5538 Link = GetFirstNode (&FormSet->StorageListHead);
5539 while (!IsNull (&FormSet->StorageListHead, Link)) {
5540 Storage = FORMSET_STORAGE_FROM_LINK (Link);
5541
5542 LoadStorage (FormSet, Storage);
5543
5544 Link = GetNextNode (&FormSet->StorageListHead, Link);
5545 }
5546 }
5547
5548
5549 /**
5550 Fetch the Ifr binary data of a FormSet.
5551
5552 @param Handle PackageList Handle
5553 @param FormSetGuid On input, GUID or class GUID of a formset. If not
5554 specified (NULL or zero GUID), take the first
5555 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
5556 found in package list.
5557 On output, GUID of the formset found(if not NULL).
5558 @param BinaryLength The length of the FormSet IFR binary.
5559 @param BinaryData The buffer designed to receive the FormSet.
5560
5561 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
5562 BufferLength was updated.
5563 @retval EFI_INVALID_PARAMETER The handle is unknown.
5564 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
5565 be found with the requested FormId.
5566
5567 **/
5568 EFI_STATUS
5569 GetIfrBinaryData (
5570 IN EFI_HII_HANDLE Handle,
5571 IN OUT EFI_GUID *FormSetGuid,
5572 OUT UINTN *BinaryLength,
5573 OUT UINT8 **BinaryData
5574 )
5575 {
5576 EFI_STATUS Status;
5577 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;
5578 UINTN BufferSize;
5579 UINT8 *Package;
5580 UINT8 *OpCodeData;
5581 UINT32 Offset;
5582 UINT32 Offset2;
5583 UINT32 PackageListLength;
5584 EFI_HII_PACKAGE_HEADER PackageHeader;
5585 UINT8 Index;
5586 UINT8 NumberOfClassGuid;
5587 BOOLEAN ClassGuidMatch;
5588 EFI_GUID *ClassGuid;
5589 EFI_GUID *ComparingGuid;
5590
5591 OpCodeData = NULL;
5592 Package = NULL;
5593 ZeroMem (&PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));
5594
5595 //
5596 // if FormSetGuid is NULL or zero GUID, return first Setup FormSet in the package list
5597 //
5598 if (FormSetGuid == NULL) {
5599 ComparingGuid = &gZeroGuid;
5600 } else {
5601 ComparingGuid = FormSetGuid;
5602 }
5603
5604 //
5605 // Get HII PackageList
5606 //
5607 BufferSize = 0;
5608 HiiPackageList = NULL;
5609 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
5610 if (Status == EFI_BUFFER_TOO_SMALL) {
5611 HiiPackageList = AllocatePool (BufferSize);
5612 ASSERT (HiiPackageList != NULL);
5613
5614 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
5615 }
5616 if (EFI_ERROR (Status)) {
5617 return Status;
5618 }
5619 ASSERT (HiiPackageList != NULL);
5620
5621 //
5622 // Get Form package from this HII package List
5623 //
5624 Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);
5625 Offset2 = 0;
5626 CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));
5627
5628 ClassGuidMatch = FALSE;
5629 while (Offset < PackageListLength) {
5630 Package = ((UINT8 *) HiiPackageList) + Offset;
5631 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));
5632
5633 if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {
5634 //
5635 // Search FormSet in this Form Package
5636 //
5637 Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);
5638 while (Offset2 < PackageHeader.Length) {
5639 OpCodeData = Package + Offset2;
5640
5641 if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {
5642 //
5643 // Try to compare against formset GUID
5644 //
5645 if (CompareGuid (FormSetGuid, &gZeroGuid) ||
5646 CompareGuid (ComparingGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
5647 break;
5648 }
5649
5650 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
5651 //
5652 // Try to compare against formset class GUID
5653 //
5654 NumberOfClassGuid = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
5655 ClassGuid = (EFI_GUID *) (OpCodeData + sizeof (EFI_IFR_FORM_SET));
5656 for (Index = 0; Index < NumberOfClassGuid; Index++) {
5657 if (CompareGuid (ComparingGuid, ClassGuid + Index)) {
5658 ClassGuidMatch = TRUE;
5659 break;
5660 }
5661 }
5662 if (ClassGuidMatch) {
5663 break;
5664 }
5665 } else if (ComparingGuid == &gEfiHiiPlatformSetupFormsetGuid) {
5666 ClassGuidMatch = TRUE;
5667 break;
5668 }
5669 }
5670
5671 Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
5672 }
5673
5674 if (Offset2 < PackageHeader.Length) {
5675 //
5676 // Target formset found
5677 //
5678 break;
5679 }
5680 }
5681
5682 Offset += PackageHeader.Length;
5683 }
5684
5685 if (Offset >= PackageListLength) {
5686 //
5687 // Form package not found in this Package List
5688 //
5689 FreePool (HiiPackageList);
5690 return EFI_NOT_FOUND;
5691 }
5692
5693 if (FormSetGuid != NULL) {
5694 //
5695 // Return the FormSet GUID
5696 //
5697 CopyMem (FormSetGuid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID));
5698 }
5699
5700 //
5701 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
5702 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
5703 // of the Form Package.
5704 //
5705 *BinaryLength = PackageHeader.Length - Offset2;
5706 *BinaryData = AllocateCopyPool (*BinaryLength, OpCodeData);
5707
5708 FreePool (HiiPackageList);
5709
5710 if (*BinaryData == NULL) {
5711 return EFI_OUT_OF_RESOURCES;
5712 }
5713
5714 return EFI_SUCCESS;
5715 }
5716
5717
5718 /**
5719 Initialize the internal data structure of a FormSet.
5720
5721 @param Handle PackageList Handle
5722 @param FormSetGuid On input, GUID or class GUID of a formset. If not
5723 specified (NULL or zero GUID), take the first
5724 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
5725 found in package list.
5726 On output, GUID of the formset found(if not NULL).
5727 @param FormSet FormSet data structure.
5728
5729 @retval EFI_SUCCESS The function completed successfully.
5730 @retval EFI_NOT_FOUND The specified FormSet could not be found.
5731
5732 **/
5733 EFI_STATUS
5734 InitializeFormSet (
5735 IN EFI_HII_HANDLE Handle,
5736 IN OUT EFI_GUID *FormSetGuid,
5737 OUT FORM_BROWSER_FORMSET *FormSet
5738 )
5739 {
5740 EFI_STATUS Status;
5741 EFI_HANDLE DriverHandle;
5742
5743 Status = GetIfrBinaryData (Handle, FormSetGuid, &FormSet->IfrBinaryLength, &FormSet->IfrBinaryData);
5744 if (EFI_ERROR (Status)) {
5745 return Status;
5746 }
5747
5748 FormSet->Signature = FORM_BROWSER_FORMSET_SIGNATURE;
5749 FormSet->HiiHandle = Handle;
5750 CopyMem (&FormSet->Guid, FormSetGuid, sizeof (EFI_GUID));
5751 FormSet->QuestionInited = FALSE;
5752
5753 //
5754 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
5755 //
5756 Status = mHiiDatabase->GetPackageListHandle (mHiiDatabase, Handle, &DriverHandle);
5757 if (EFI_ERROR (Status)) {
5758 return Status;
5759 }
5760 FormSet->DriverHandle = DriverHandle;
5761 Status = gBS->HandleProtocol (
5762 DriverHandle,
5763 &gEfiHiiConfigAccessProtocolGuid,
5764 (VOID **) &FormSet->ConfigAccess
5765 );
5766 if (EFI_ERROR (Status)) {
5767 //
5768 // Configuration Driver don't attach ConfigAccess protocol to its HII package
5769 // list, then there will be no configuration action required
5770 //
5771 FormSet->ConfigAccess = NULL;
5772 }
5773
5774 //
5775 // Parse the IFR binary OpCodes
5776 //
5777 Status = ParseOpCodes (FormSet);
5778
5779 return Status;
5780 }
5781
5782
5783 /**
5784 Save globals used by previous call to SendForm(). SendForm() may be called from
5785 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
5786 So, save globals of previous call to SendForm() and restore them upon exit.
5787
5788 **/
5789 VOID
5790 SaveBrowserContext (
5791 VOID
5792 )
5793 {
5794 BROWSER_CONTEXT *Context;
5795 FORM_ENTRY_INFO *MenuList;
5796 FORM_BROWSER_FORMSET *FormSet;
5797
5798 gBrowserContextCount++;
5799 if (gBrowserContextCount == 1) {
5800 //
5801 // This is not reentry of SendForm(), no context to save
5802 //
5803 return;
5804 }
5805
5806 Context = AllocatePool (sizeof (BROWSER_CONTEXT));
5807 ASSERT (Context != NULL);
5808
5809 Context->Signature = BROWSER_CONTEXT_SIGNATURE;
5810
5811 //
5812 // Save FormBrowser context
5813 //
5814 Context->Selection = gCurrentSelection;
5815 Context->ResetRequired = gResetRequired;
5816 Context->FlagReconnect = gFlagReconnect;
5817 Context->CallbackReconnect = gCallbackReconnect;
5818 Context->ExitRequired = gExitRequired;
5819 Context->HiiHandle = mCurrentHiiHandle;
5820 Context->FormId = mCurrentFormId;
5821 CopyGuid (&Context->FormSetGuid, &mCurrentFormSetGuid);
5822 Context->SystemLevelFormSet = mSystemLevelFormSet;
5823 Context->CurFakeQestId = mCurFakeQestId;
5824 Context->HiiPackageListUpdated = mHiiPackageListUpdated;
5825 Context->FinishRetrieveCall = mFinishRetrieveCall;
5826
5827 //
5828 // Save the menu history data.
5829 //
5830 InitializeListHead(&Context->FormHistoryList);
5831 while (!IsListEmpty (&mPrivateData.FormBrowserEx2.FormViewHistoryHead)) {
5832 MenuList = FORM_ENTRY_INFO_FROM_LINK (mPrivateData.FormBrowserEx2.FormViewHistoryHead.ForwardLink);
5833 RemoveEntryList (&MenuList->Link);
5834
5835 InsertTailList(&Context->FormHistoryList, &MenuList->Link);
5836 }
5837
5838 //
5839 // Save formset list.
5840 //
5841 InitializeListHead(&Context->FormSetList);
5842 while (!IsListEmpty (&gBrowserFormSetList)) {
5843 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (gBrowserFormSetList.ForwardLink);
5844 RemoveEntryList (&FormSet->Link);
5845
5846 InsertTailList(&Context->FormSetList, &FormSet->Link);
5847 }
5848
5849 //
5850 // Insert to FormBrowser context list
5851 //
5852 InsertHeadList (&gBrowserContextList, &Context->Link);
5853 }
5854
5855
5856 /**
5857 Restore globals used by previous call to SendForm().
5858
5859 **/
5860 VOID
5861 RestoreBrowserContext (
5862 VOID
5863 )
5864 {
5865 LIST_ENTRY *Link;
5866 BROWSER_CONTEXT *Context;
5867 FORM_ENTRY_INFO *MenuList;
5868 FORM_BROWSER_FORMSET *FormSet;
5869
5870 ASSERT (gBrowserContextCount != 0);
5871 gBrowserContextCount--;
5872 if (gBrowserContextCount == 0) {
5873 //
5874 // This is not reentry of SendForm(), no context to restore
5875 //
5876 return;
5877 }
5878
5879 ASSERT (!IsListEmpty (&gBrowserContextList));
5880
5881 Link = GetFirstNode (&gBrowserContextList);
5882 Context = BROWSER_CONTEXT_FROM_LINK (Link);
5883
5884 //
5885 // Restore FormBrowser context
5886 //
5887 gCurrentSelection = Context->Selection;
5888 gResetRequired = Context->ResetRequired;
5889 gFlagReconnect = Context->FlagReconnect;
5890 gCallbackReconnect = Context->CallbackReconnect;
5891 gExitRequired = Context->ExitRequired;
5892 mCurrentHiiHandle = Context->HiiHandle;
5893 mCurrentFormId = Context->FormId;
5894 CopyGuid (&mCurrentFormSetGuid, &Context->FormSetGuid);
5895 mSystemLevelFormSet = Context->SystemLevelFormSet;
5896 mCurFakeQestId = Context->CurFakeQestId;
5897 mHiiPackageListUpdated = Context->HiiPackageListUpdated;
5898 mFinishRetrieveCall = Context->FinishRetrieveCall;
5899
5900 //
5901 // Restore the menu history data.
5902 //
5903 while (!IsListEmpty (&Context->FormHistoryList)) {
5904 MenuList = FORM_ENTRY_INFO_FROM_LINK (Context->FormHistoryList.ForwardLink);
5905 RemoveEntryList (&MenuList->Link);
5906
5907 InsertTailList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &MenuList->Link);
5908 }
5909
5910 //
5911 // Restore the Formset data.
5912 //
5913 while (!IsListEmpty (&Context->FormSetList)) {
5914 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Context->FormSetList.ForwardLink);
5915 RemoveEntryList (&FormSet->Link);
5916
5917 InsertTailList(&gBrowserFormSetList, &FormSet->Link);
5918 }
5919
5920 //
5921 // Remove from FormBrowser context list
5922 //
5923 RemoveEntryList (&Context->Link);
5924 gBS->FreePool (Context);
5925 }
5926
5927 /**
5928 Find the matched FormSet context in the backup maintain list based on HiiHandle.
5929
5930 @param Handle The Hii Handle.
5931
5932 @return the found FormSet context. If no found, NULL will return.
5933
5934 **/
5935 FORM_BROWSER_FORMSET *
5936 GetFormSetFromHiiHandle (
5937 EFI_HII_HANDLE Handle
5938 )
5939 {
5940 LIST_ENTRY *Link;
5941 FORM_BROWSER_FORMSET *FormSet;
5942
5943 Link = GetFirstNode (&gBrowserFormSetList);
5944 while (!IsNull (&gBrowserFormSetList, Link)) {
5945 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
5946 Link = GetNextNode (&gBrowserFormSetList, Link);
5947 if (!ValidateFormSet(FormSet)) {
5948 continue;
5949 }
5950 if (FormSet->HiiHandle == Handle) {
5951 return FormSet;
5952 }
5953 }
5954
5955 return NULL;
5956 }
5957
5958 /**
5959 Check whether the input HII handle is the FormSet that is being used.
5960
5961 @param Handle The Hii Handle.
5962
5963 @retval TRUE HII handle is being used.
5964 @retval FALSE HII handle is not being used.
5965
5966 **/
5967 BOOLEAN
5968 IsHiiHandleInBrowserContext (
5969 EFI_HII_HANDLE Handle
5970 )
5971 {
5972 LIST_ENTRY *Link;
5973 BROWSER_CONTEXT *Context;
5974
5975 //
5976 // HiiHandle is Current FormSet.
5977 //
5978 if (mCurrentHiiHandle == Handle) {
5979 return TRUE;
5980 }
5981
5982 //
5983 // Check whether HiiHandle is in BrowserContext.
5984 //
5985 Link = GetFirstNode (&gBrowserContextList);
5986 while (!IsNull (&gBrowserContextList, Link)) {
5987 Context = BROWSER_CONTEXT_FROM_LINK (Link);
5988 if (Context->HiiHandle == Handle) {
5989 //
5990 // HiiHandle is in BrowserContext
5991 //
5992 return TRUE;
5993 }
5994 Link = GetNextNode (&gBrowserContextList, Link);
5995 }
5996
5997 return FALSE;
5998 }
5999
6000 /**
6001 Perform Password check.
6002 Passwork may be encrypted by driver that requires the specific check.
6003
6004 @param Form Form where Password Statement is in.
6005 @param Statement Password statement
6006 @param PasswordString Password string to be checked. It may be NULL.
6007 NULL means to restore password.
6008 "" string can be used to checked whether old password does exist.
6009
6010 @return Status Status of Password check.
6011 **/
6012 EFI_STATUS
6013 EFIAPI
6014 PasswordCheck (
6015 IN FORM_DISPLAY_ENGINE_FORM *Form,
6016 IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,
6017 IN EFI_STRING PasswordString OPTIONAL
6018 )
6019 {
6020 EFI_STATUS Status;
6021 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
6022 EFI_BROWSER_ACTION_REQUEST ActionRequest;
6023 EFI_IFR_TYPE_VALUE IfrTypeValue;
6024 FORM_BROWSER_STATEMENT *Question;
6025
6026 ConfigAccess = gCurrentSelection->FormSet->ConfigAccess;
6027 Question = GetBrowserStatement(Statement);
6028 ASSERT (Question != NULL);
6029
6030 if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK) {
6031 if (ConfigAccess == NULL) {
6032 return EFI_UNSUPPORTED;
6033 }
6034 } else {
6035 if (PasswordString == NULL) {
6036 return EFI_SUCCESS;
6037 }
6038
6039 //
6040 // Check whether has preexisted password.
6041 //
6042 if (PasswordString[0] == 0) {
6043 if (*((CHAR16 *) Question->BufferValue) == 0) {
6044 return EFI_SUCCESS;
6045 } else {
6046 return EFI_NOT_READY;
6047 }
6048 }
6049
6050 //
6051 // Check whether the input password is same as preexisted password.
6052 //
6053 if (StrnCmp (PasswordString, (CHAR16 *) Question->BufferValue, Question->StorageWidth/sizeof (CHAR16)) == 0) {
6054 return EFI_SUCCESS;
6055 } else {
6056 return EFI_NOT_READY;
6057 }
6058 }
6059
6060 //
6061 // Prepare password string in HII database
6062 //
6063 if (PasswordString != NULL) {
6064 IfrTypeValue.string = NewString (PasswordString, gCurrentSelection->FormSet->HiiHandle);
6065 } else {
6066 IfrTypeValue.string = 0;
6067 }
6068
6069 //
6070 // Send password to Configuration Driver for validation
6071 //
6072 Status = ConfigAccess->Callback (
6073 ConfigAccess,
6074 EFI_BROWSER_ACTION_CHANGING,
6075 Question->QuestionId,
6076 Question->HiiValue.Type,
6077 &IfrTypeValue,
6078 &ActionRequest
6079 );
6080
6081 //
6082 // Remove password string from HII database
6083 //
6084 if (PasswordString != NULL) {
6085 DeleteString (IfrTypeValue.string, gCurrentSelection->FormSet->HiiHandle);
6086 }
6087
6088 return Status;
6089 }
6090
6091 /**
6092 Find the registered HotKey based on KeyData.
6093
6094 @param[in] KeyData A pointer to a buffer that describes the keystroke
6095 information for the hot key.
6096
6097 @return The registered HotKey context. If no found, NULL will return.
6098 **/
6099 BROWSER_HOT_KEY *
6100 GetHotKeyFromRegisterList (
6101 IN EFI_INPUT_KEY *KeyData
6102 )
6103 {
6104 LIST_ENTRY *Link;
6105 BROWSER_HOT_KEY *HotKey;
6106
6107 Link = GetFirstNode (&gBrowserHotKeyList);
6108 while (!IsNull (&gBrowserHotKeyList, Link)) {
6109 HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);
6110 if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {
6111 return HotKey;
6112 }
6113 Link = GetNextNode (&gBrowserHotKeyList, Link);
6114 }
6115
6116 return NULL;
6117 }
6118
6119 /**
6120 Configure what scope the hot key will impact.
6121 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
6122 If no scope is set, the default scope will be FormSet level.
6123 After all registered hot keys are removed, previous Scope can reset to another level.
6124
6125 @param[in] Scope Scope level to be set.
6126
6127 @retval EFI_SUCCESS Scope is set correctly.
6128 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
6129 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
6130
6131 **/
6132 EFI_STATUS
6133 EFIAPI
6134 SetScope (
6135 IN BROWSER_SETTING_SCOPE Scope
6136 )
6137 {
6138 if (Scope >= MaxLevel) {
6139 return EFI_INVALID_PARAMETER;
6140 }
6141
6142 //
6143 // When no hot key registered in system or on the first setting,
6144 // Scope can be set.
6145 //
6146 if (mBrowserScopeFirstSet || IsListEmpty (&gBrowserHotKeyList)) {
6147 gBrowserSettingScope = Scope;
6148 mBrowserScopeFirstSet = FALSE;
6149 } else if (Scope != gBrowserSettingScope) {
6150 return EFI_UNSUPPORTED;
6151 }
6152
6153 return EFI_SUCCESS;
6154 }
6155
6156 /**
6157 Register the hot key with its browser action, or unregistered the hot key.
6158 Only support hot key that is not printable character (control key, function key, etc.).
6159 If the action value is zero, the hot key will be unregistered if it has been registered.
6160 If the same hot key has been registered, the new action and help string will override the previous ones.
6161
6162 @param[in] KeyData A pointer to a buffer that describes the keystroke
6163 information for the hot key. Its type is EFI_INPUT_KEY to
6164 be supported by all ConsoleIn devices.
6165 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
6166 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
6167 @param[in] HelpString Help string that describes the hot key information.
6168 Its value may be NULL for the unregistered hot key.
6169
6170 @retval EFI_SUCCESS Hot key is registered or unregistered.
6171 @retval EFI_INVALID_PARAMETER KeyData is NULL or HelpString is NULL on register.
6172 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
6173 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
6174 @retval EFI_ALREADY_STARTED Key already been registered for one hot key.
6175 **/
6176 EFI_STATUS
6177 EFIAPI
6178 RegisterHotKey (
6179 IN EFI_INPUT_KEY *KeyData,
6180 IN UINT32 Action,
6181 IN UINT16 DefaultId,
6182 IN EFI_STRING HelpString OPTIONAL
6183 )
6184 {
6185 BROWSER_HOT_KEY *HotKey;
6186
6187 //
6188 // Check input parameters.
6189 //
6190 if (KeyData == NULL || KeyData->UnicodeChar != CHAR_NULL ||
6191 (Action != BROWSER_ACTION_UNREGISTER && HelpString == NULL)) {
6192 return EFI_INVALID_PARAMETER;
6193 }
6194
6195 //
6196 // Check whether the input KeyData is in BrowserHotKeyList.
6197 //
6198 HotKey = GetHotKeyFromRegisterList (KeyData);
6199
6200 //
6201 // Unregister HotKey
6202 //
6203 if (Action == BROWSER_ACTION_UNREGISTER) {
6204 if (HotKey != NULL) {
6205 //
6206 // The registered HotKey is found.
6207 // Remove it from List, and free its resource.
6208 //
6209 RemoveEntryList (&HotKey->Link);
6210 FreePool (HotKey->KeyData);
6211 FreePool (HotKey->HelpString);
6212 return EFI_SUCCESS;
6213 } else {
6214 //
6215 // The registered HotKey is not found.
6216 //
6217 return EFI_NOT_FOUND;
6218 }
6219 }
6220
6221 if (HotKey != NULL) {
6222 return EFI_ALREADY_STARTED;
6223 }
6224
6225 //
6226 // Create new Key, and add it into List.
6227 //
6228 HotKey = AllocateZeroPool (sizeof (BROWSER_HOT_KEY));
6229 ASSERT (HotKey != NULL);
6230 HotKey->Signature = BROWSER_HOT_KEY_SIGNATURE;
6231 HotKey->KeyData = AllocateCopyPool (sizeof (EFI_INPUT_KEY), KeyData);
6232 InsertTailList (&gBrowserHotKeyList, &HotKey->Link);
6233
6234 //
6235 // Fill HotKey information.
6236 //
6237 HotKey->Action = Action;
6238 HotKey->DefaultId = DefaultId;
6239 if (HotKey->HelpString != NULL) {
6240 FreePool (HotKey->HelpString);
6241 }
6242 HotKey->HelpString = AllocateCopyPool (StrSize (HelpString), HelpString);
6243
6244 return EFI_SUCCESS;
6245 }
6246
6247 /**
6248 Register Exit handler function.
6249 When more than one handler function is registered, the latter one will override the previous one.
6250 When NULL handler is specified, the previous Exit handler will be unregistered.
6251
6252 @param[in] Handler Pointer to handler function.
6253
6254 **/
6255 VOID
6256 EFIAPI
6257 RegiserExitHandler (
6258 IN EXIT_HANDLER Handler
6259 )
6260 {
6261 ExitHandlerFunction = Handler;
6262 return;
6263 }
6264
6265 /**
6266 Check whether the browser data has been modified.
6267
6268 @retval TRUE Browser data is modified.
6269 @retval FALSE No browser data is modified.
6270
6271 **/
6272 BOOLEAN
6273 EFIAPI
6274 IsBrowserDataModified (
6275 VOID
6276 )
6277 {
6278 LIST_ENTRY *Link;
6279 FORM_BROWSER_FORMSET *FormSet;
6280
6281 switch (gBrowserSettingScope) {
6282 case FormLevel:
6283 if (gCurrentSelection == NULL) {
6284 return FALSE;
6285 }
6286 return IsNvUpdateRequiredForForm (gCurrentSelection->Form);
6287
6288 case FormSetLevel:
6289 if (gCurrentSelection == NULL) {
6290 return FALSE;
6291 }
6292 return IsNvUpdateRequiredForFormSet (gCurrentSelection->FormSet);
6293
6294 case SystemLevel:
6295 Link = GetFirstNode (&gBrowserFormSetList);
6296 while (!IsNull (&gBrowserFormSetList, Link)) {
6297 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
6298 if (!ValidateFormSet(FormSet)) {
6299 continue;
6300 }
6301
6302 if (IsNvUpdateRequiredForFormSet (FormSet)) {
6303 return TRUE;
6304 }
6305 Link = GetNextNode (&gBrowserFormSetList, Link);
6306 }
6307 return FALSE;
6308
6309 default:
6310 return FALSE;
6311 }
6312 }
6313
6314 /**
6315 Execute the action requested by the Action parameter.
6316
6317 @param[in] Action Execute the request action.
6318 @param[in] DefaultId The default Id info when need to load default value. Only used when Action is BROWSER_ACTION_DEFAULT.
6319
6320 @retval EFI_SUCCESS Execute the request action succss.
6321 @retval EFI_INVALID_PARAMETER The input action value is invalid.
6322
6323 **/
6324 EFI_STATUS
6325 EFIAPI
6326 ExecuteAction (
6327 IN UINT32 Action,
6328 IN UINT16 DefaultId
6329 )
6330 {
6331 EFI_STATUS Status;
6332 FORM_BROWSER_FORMSET *FormSet;
6333 FORM_BROWSER_FORM *Form;
6334
6335 if (gBrowserSettingScope < SystemLevel && gCurrentSelection == NULL) {
6336 return EFI_NOT_READY;
6337 }
6338
6339 Status = EFI_SUCCESS;
6340 FormSet = NULL;
6341 Form = NULL;
6342 if (gBrowserSettingScope < SystemLevel) {
6343 FormSet = gCurrentSelection->FormSet;
6344 Form = gCurrentSelection->Form;
6345 }
6346
6347 //
6348 // Executet the discard action.
6349 //
6350 if ((Action & BROWSER_ACTION_DISCARD) != 0) {
6351 Status = DiscardForm (FormSet, Form, gBrowserSettingScope);
6352 if (EFI_ERROR (Status)) {
6353 return Status;
6354 }
6355 }
6356
6357 //
6358 // Executet the difault action.
6359 //
6360 if ((Action & BROWSER_ACTION_DEFAULT) != 0) {
6361 Status = ExtractDefault (FormSet, Form, DefaultId, gBrowserSettingScope, GetDefaultForAll, NULL, FALSE, FALSE);
6362 if (EFI_ERROR (Status)) {
6363 return Status;
6364 }
6365 UpdateStatementStatus (FormSet, Form, gBrowserSettingScope);
6366 }
6367
6368 //
6369 // Executet the submit action.
6370 //
6371 if ((Action & BROWSER_ACTION_SUBMIT) != 0) {
6372 Status = SubmitForm (FormSet, Form, gBrowserSettingScope);
6373 if (EFI_ERROR (Status)) {
6374 return Status;
6375 }
6376 }
6377
6378 //
6379 // Executet the reset action.
6380 //
6381 if ((Action & BROWSER_ACTION_RESET) != 0) {
6382 gResetRequired = TRUE;
6383 }
6384
6385 //
6386 // Executet the exit action.
6387 //
6388 if ((Action & BROWSER_ACTION_EXIT) != 0) {
6389 DiscardForm (FormSet, Form, gBrowserSettingScope);
6390 if (gBrowserSettingScope == SystemLevel) {
6391 if (ExitHandlerFunction != NULL) {
6392 ExitHandlerFunction ();
6393 }
6394 }
6395
6396 gExitRequired = TRUE;
6397 }
6398
6399 return Status;
6400 }
6401
6402 /**
6403 Create reminder to let user to choose save or discard the changed browser data.
6404 Caller can use it to actively check the changed browser data.
6405
6406 @retval BROWSER_NO_CHANGES No browser data is changed.
6407 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
6408 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
6409 @retval BROWSER_KEEP_CURRENT Browser keep current changes.
6410
6411 **/
6412 UINT32
6413 EFIAPI
6414 SaveReminder (
6415 VOID
6416 )
6417 {
6418 LIST_ENTRY *Link;
6419 FORM_BROWSER_FORMSET *FormSet;
6420 BOOLEAN IsDataChanged;
6421 UINT32 DataSavedAction;
6422 UINT32 ConfirmRet;
6423
6424 DataSavedAction = BROWSER_NO_CHANGES;
6425 IsDataChanged = FALSE;
6426 Link = GetFirstNode (&gBrowserFormSetList);
6427 while (!IsNull (&gBrowserFormSetList, Link)) {
6428 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
6429 Link = GetNextNode (&gBrowserFormSetList, Link);
6430 if (!ValidateFormSet(FormSet)) {
6431 continue;
6432 }
6433 if (IsNvUpdateRequiredForFormSet (FormSet)) {
6434 IsDataChanged = TRUE;
6435 break;
6436 }
6437 }
6438
6439 //
6440 // No data is changed. No save is required.
6441 //
6442 if (!IsDataChanged) {
6443 return DataSavedAction;
6444 }
6445
6446 //
6447 // If data is changed, prompt user to save or discard it.
6448 //
6449 do {
6450 ConfirmRet = (UINT32) mFormDisplay->ConfirmDataChange();
6451
6452 if (ConfirmRet == BROWSER_ACTION_SUBMIT) {
6453 SubmitForm (NULL, NULL, SystemLevel);
6454 DataSavedAction = BROWSER_SAVE_CHANGES;
6455 break;
6456 } else if (ConfirmRet == BROWSER_ACTION_DISCARD) {
6457 DiscardForm (NULL, NULL, SystemLevel);
6458 DataSavedAction = BROWSER_DISCARD_CHANGES;
6459 break;
6460 } else if (ConfirmRet == BROWSER_ACTION_NONE) {
6461 DataSavedAction = BROWSER_KEEP_CURRENT;
6462 break;
6463 }
6464 } while (1);
6465
6466 return DataSavedAction;
6467 }
6468
6469 /**
6470 Check whether the Reset Required for the browser
6471
6472 @retval TRUE Browser required to reset after exit.
6473 @retval FALSE Browser not need to reset after exit.
6474
6475 **/
6476 BOOLEAN
6477 EFIAPI
6478 IsResetRequired (
6479 VOID
6480 )
6481 {
6482 return gResetRequired;
6483 }
6484
EFI Development Kit II mirror for PVE