]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/SetupBrowserDxe/Setup.c
projects / mirror_edk2.git / blob
? search:


23094f8145fa371558ed30d477aa93f4f5a36de4
[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 BOOLEAN SubmitFormFail;
3186
3187 SubmitFormFail = FALSE;
3188
3189 if (!IsNvUpdateRequiredForForm (Form)) {
3190 return EFI_SUCCESS;
3191 }
3192
3193 Status = NoSubmitCheck (FormSet, &Form, NULL);
3194 if (EFI_ERROR (Status)) {
3195 return Status;
3196 }
3197
3198 Link = GetFirstNode (&Form->ConfigRequestHead);
3199 while (!IsNull (&Form->ConfigRequestHead, Link)) {
3200 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
3201 Link = GetNextNode (&Form->ConfigRequestHead, Link);
3202
3203 Storage = ConfigInfo->Storage;
3204 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3205 continue;
3206 }
3207
3208 //
3209 // Skip if there is no RequestElement
3210 //
3211 if (ConfigInfo->ElementCount == 0) {
3212 continue;
3213 }
3214
3215 //
3216 // 1. Prepare <ConfigResp>
3217 //
3218 Status = StorageToConfigResp (ConfigInfo->Storage, &ConfigResp, ConfigInfo->ConfigRequest, TRUE);
3219 if (EFI_ERROR (Status)) {
3220 return Status;
3221 }
3222
3223 //
3224 // 2. Set value to hii config routine protocol.
3225 //
3226 Status = mHiiConfigRouting->RouteConfig (
3227 mHiiConfigRouting,
3228 ConfigResp,
3229 &Progress
3230 );
3231 FreePool (ConfigResp);
3232
3233 if (EFI_ERROR (Status)) {
3234 //
3235 // Submit fail, to get the RestoreConfigRequest and SyncConfigRequest.
3236 //
3237 SubmitFormFail = TRUE;
3238 GetSyncRestoreConfigRequest (ConfigInfo->Storage, ConfigInfo->ConfigRequest, Progress, &ConfigInfo->RestoreConfigRequest, &ConfigInfo->SyncConfigRequest);
3239 InsertTailList (&gBrowserSaveFailFormSetList, &ConfigInfo->SaveFailLink);
3240 continue;
3241 }
3242
3243 //
3244 // 3. Config success, update storage shadow Buffer, only update the data belong to this form.
3245 //
3246 SynchronizeStorage (ConfigInfo->Storage, ConfigInfo->ConfigRequest, TRUE);
3247 }
3248
3249 //
3250 // 4. Process the save failed storage.
3251 //
3252 if (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3253 if (ConfirmSaveFail (Form->FormTitle, FormSet->HiiHandle) == BROWSER_ACTION_DISCARD) {
3254 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3255 while (!IsNull (&gBrowserSaveFailFormSetList, Link)) {
3256 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK (Link);
3257 Link = GetNextNode (&gBrowserSaveFailFormSetList, Link);
3258 //
3259 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3260 // base on the SyncConfigRequest to Sync the buffer.
3261 //
3262 SynchronizeStorage (ConfigInfo->Storage, ConfigInfo->RestoreConfigRequest, FALSE);
3263 FreePool (ConfigInfo->RestoreConfigRequest);
3264 ConfigInfo->RestoreConfigRequest = NULL;
3265 if (ConfigInfo->SyncConfigRequest != NULL) {
3266 SynchronizeStorage(ConfigInfo->Storage, ConfigInfo->SyncConfigRequest, TRUE);
3267 FreePool (ConfigInfo->SyncConfigRequest);
3268 ConfigInfo->SyncConfigRequest = NULL;
3269 }
3270
3271 Status = EFI_SUCCESS;
3272 }
3273 } else {
3274 Status = EFI_UNSUPPORTED;
3275 }
3276
3277 //
3278 // Free Form save fail list.
3279 //
3280 while (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3281 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3282 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_SAVE_FAIL_LINK (Link);
3283 RemoveEntryList (&ConfigInfo->SaveFailLink);
3284 }
3285 }
3286
3287 //
3288 // 5. Update the NV flag.
3289 //
3290 ValueChangeResetFlagUpdate(TRUE, FormSet, Form);
3291
3292 //
3293 // 6 Call callback with Submitted type to inform the driver.
3294 //
3295 if (!SubmitFormFail) {
3296 SubmitCallback (FormSet, Form);
3297 }
3298
3299 return Status;
3300 }
3301
3302 /**
3303 Submit data for a formset.
3304
3305 @param FormSet FormSet data structure.
3306 @param SkipProcessFail Whether skip to process the save failed storage.
3307 If submit formset is called when do system level save,
3308 set this value to true and process the failed formset
3309 together.
3310 if submit formset is called when do formset level save,
3311 set the value to false and process the failed storage
3312 right after process all storages for this formset.
3313
3314 @retval EFI_SUCCESS The function completed successfully.
3315 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3316
3317 **/
3318 EFI_STATUS
3319 SubmitForFormSet (
3320 IN FORM_BROWSER_FORMSET *FormSet,
3321 IN BOOLEAN SkipProcessFail
3322 )
3323 {
3324 EFI_STATUS Status;
3325 LIST_ENTRY *Link;
3326 EFI_STRING ConfigResp;
3327 EFI_STRING Progress;
3328 BROWSER_STORAGE *Storage;
3329 FORMSET_STORAGE *FormSetStorage;
3330 FORM_BROWSER_FORM *Form;
3331 BOOLEAN HasInserted;
3332 FORM_BROWSER_STATEMENT *Question;
3333 BOOLEAN SubmitFormSetFail;
3334
3335 HasInserted = FALSE;
3336 SubmitFormSetFail = FALSE;
3337
3338 if (!IsNvUpdateRequiredForFormSet (FormSet)) {
3339 return EFI_SUCCESS;
3340 }
3341
3342 Form = NULL;
3343 Status = NoSubmitCheck (FormSet, &Form, &Question);
3344 if (EFI_ERROR (Status)) {
3345 if (SkipProcessFail) {
3346 //
3347 // Process NO_SUBMIT check first, so insert it at head.
3348 //
3349 FormSet->SaveFailForm = Form;
3350 FormSet->SaveFailStatement = Question;
3351 InsertHeadList (&gBrowserSaveFailFormSetList, &FormSet->SaveFailLink);
3352 }
3353
3354 return Status;
3355 }
3356
3357 Form = NULL;
3358 Question = NULL;
3359 //
3360 // Submit Buffer storage or Name/Value storage
3361 //
3362 Link = GetFirstNode (&FormSet->StorageListHead);
3363 while (!IsNull (&FormSet->StorageListHead, Link)) {
3364 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
3365 Storage = FormSetStorage->BrowserStorage;
3366 Link = GetNextNode (&FormSet->StorageListHead, Link);
3367
3368 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3369 continue;
3370 }
3371
3372 //
3373 // Skip if there is no RequestElement
3374 //
3375 if (FormSetStorage->ElementCount == 0) {
3376 continue;
3377 }
3378
3379 //
3380 // 1. Prepare <ConfigResp>
3381 //
3382 Status = StorageToConfigResp (Storage, &ConfigResp, FormSetStorage->ConfigRequest, TRUE);
3383 if (EFI_ERROR (Status)) {
3384 return Status;
3385 }
3386
3387 //
3388 // 2. Send <ConfigResp> to Routine config Protocol.
3389 //
3390 Status = mHiiConfigRouting->RouteConfig (
3391 mHiiConfigRouting,
3392 ConfigResp,
3393 &Progress
3394 );
3395 if (EFI_ERROR (Status)) {
3396 //
3397 // Submit fail, to get the RestoreConfigRequest and SyncConfigRequest.
3398 //
3399 SubmitFormSetFail = TRUE;
3400 GetSyncRestoreConfigRequest (FormSetStorage->BrowserStorage, FormSetStorage->ConfigRequest, Progress, &FormSetStorage->RestoreConfigRequest, &FormSetStorage->SyncConfigRequest);
3401 InsertTailList (&FormSet->SaveFailStorageListHead, &FormSetStorage->SaveFailLink);
3402 if (!HasInserted) {
3403 //
3404 // Call submit formset for system level, save the formset info
3405 // and process later.
3406 //
3407 FindQuestionFromProgress(FormSet, Storage, Progress, &Form, &Question);
3408 ASSERT (Form != NULL && Question != NULL);
3409 FormSet->SaveFailForm = Form;
3410 FormSet->SaveFailStatement = Question;
3411 if (SkipProcessFail) {
3412 InsertTailList (&gBrowserSaveFailFormSetList, &FormSet->SaveFailLink);
3413 }
3414 HasInserted = TRUE;
3415 }
3416
3417 FreePool (ConfigResp);
3418 continue;
3419 }
3420
3421 FreePool (ConfigResp);
3422 //
3423 // 3. Config success, update storage shadow Buffer
3424 //
3425 SynchronizeStorage (Storage, FormSetStorage->ConfigRequest, TRUE);
3426 }
3427
3428 //
3429 // 4. Has save fail storage need to handle.
3430 //
3431 if (Form != NULL) {
3432 if (!SkipProcessFail) {
3433 //
3434 // If not in system level, just handl the save failed storage here.
3435 //
3436 if (ConfirmSaveFail (Form->FormTitle, FormSet->HiiHandle) == BROWSER_ACTION_DISCARD) {
3437 Link = GetFirstNode (&FormSet->SaveFailStorageListHead);
3438 while (!IsNull (&FormSet->SaveFailStorageListHead, Link)) {
3439 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (Link);
3440 Storage = FormSetStorage->BrowserStorage;
3441 Link = GetNextNode (&FormSet->SaveFailStorageListHead, Link);
3442 //
3443 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3444 // base on the SyncConfigRequest to Sync the buffer.
3445 //
3446 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->RestoreConfigRequest, FALSE);
3447 FreePool (FormSetStorage->RestoreConfigRequest);
3448 FormSetStorage->RestoreConfigRequest = NULL;
3449 if (FormSetStorage->SyncConfigRequest != NULL) {
3450 SynchronizeStorage(FormSetStorage->BrowserStorage, FormSetStorage->SyncConfigRequest, TRUE);
3451 FreePool (FormSetStorage->SyncConfigRequest);
3452 FormSetStorage->SyncConfigRequest = NULL;
3453 }
3454
3455 Status = EFI_SUCCESS;
3456 }
3457 } else {
3458 UiCopyMenuList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &Form->FormViewListHead);
3459
3460 gCurrentSelection->Action = UI_ACTION_REFRESH_FORMSET;
3461 gCurrentSelection->Handle = FormSet->HiiHandle;
3462 CopyGuid (&gCurrentSelection->FormSetGuid, &FormSet->Guid);
3463 gCurrentSelection->FormId = Form->FormId;
3464 gCurrentSelection->QuestionId = Question->QuestionId;
3465
3466 Status = EFI_UNSUPPORTED;
3467 }
3468
3469 //
3470 // Free FormSet save fail list.
3471 //
3472 while (!IsListEmpty (&FormSet->SaveFailStorageListHead)) {
3473 Link = GetFirstNode (&FormSet->SaveFailStorageListHead);
3474 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (Link);
3475 RemoveEntryList (&FormSetStorage->SaveFailLink);
3476 }
3477 } else {
3478 //
3479 // If in system level, just return error and handle the failed formset later.
3480 //
3481 Status = EFI_UNSUPPORTED;
3482 }
3483 }
3484
3485 //
3486 // 5. Update the NV flag.
3487 //
3488 ValueChangeResetFlagUpdate(TRUE, FormSet, NULL);
3489
3490 //
3491 // 6. Call callback with Submitted type to inform the driver.
3492 //
3493 if (!SubmitFormSetFail) {
3494 SubmitCallback (FormSet, NULL);
3495 }
3496
3497 return Status;
3498 }
3499
3500 /**
3501 Submit data for all formsets.
3502
3503 @retval EFI_SUCCESS The function completed successfully.
3504 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3505
3506 **/
3507 EFI_STATUS
3508 SubmitForSystem (
3509 VOID
3510 )
3511 {
3512 EFI_STATUS Status;
3513 LIST_ENTRY *Link;
3514 LIST_ENTRY *StorageLink;
3515 FORMSET_STORAGE *FormSetStorage;
3516 FORM_BROWSER_FORM *Form;
3517 FORM_BROWSER_FORMSET *LocalFormSet;
3518 UINT32 UserSelection;
3519 FORM_BROWSER_STATEMENT *Question;
3520
3521 mSystemSubmit = TRUE;
3522 Link = GetFirstNode (&gBrowserFormSetList);
3523 while (!IsNull (&gBrowserFormSetList, Link)) {
3524 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
3525 Link = GetNextNode (&gBrowserFormSetList, Link);
3526 if (!ValidateFormSet(LocalFormSet)) {
3527 continue;
3528 }
3529
3530 Status = SubmitForFormSet (LocalFormSet, TRUE);
3531 if (EFI_ERROR (Status)) {
3532 continue;
3533 }
3534
3535 //
3536 // Remove maintain backup list after save except for the current using FormSet.
3537 //
3538 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
3539 CleanBrowserStorage(LocalFormSet);
3540 RemoveEntryList (&LocalFormSet->Link);
3541 DestroyFormSet (LocalFormSet);
3542 }
3543 }
3544 mSystemSubmit = FALSE;
3545
3546 Status = EFI_SUCCESS;
3547
3548 //
3549 // Process the save failed formsets.
3550 //
3551 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3552 while (!IsNull (&gBrowserSaveFailFormSetList, Link)) {
3553 LocalFormSet = FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK (Link);
3554 Link = GetNextNode (&gBrowserSaveFailFormSetList, Link);
3555
3556 if (!ValidateFormSet(LocalFormSet)) {
3557 continue;
3558 }
3559
3560 Form = LocalFormSet->SaveFailForm;
3561 Question= LocalFormSet->SaveFailStatement;
3562
3563 //
3564 // Confirm with user, get user input.
3565 //
3566 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3567 //
3568 // NULL for SaveFailStorageListHead means error caused by NO_SUBMIT_IF check.
3569 //
3570 UserSelection = ConfirmNoSubmitFail (Form->FormTitle, LocalFormSet->HiiHandle);
3571 } else {
3572 UserSelection = ConfirmSaveFail (Form->FormTitle, LocalFormSet->HiiHandle);
3573 }
3574
3575 if (UserSelection == BROWSER_ACTION_DISCARD) {
3576 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3577 StorageLink = GetFirstNode (&LocalFormSet->StorageListHead);
3578 while (!IsNull (&LocalFormSet->StorageListHead, StorageLink)) {
3579 FormSetStorage = FORMSET_STORAGE_FROM_LINK (StorageLink);
3580 StorageLink = GetNextNode (&LocalFormSet->StorageListHead, StorageLink);
3581
3582 SynchronizeStorage(FormSetStorage->BrowserStorage, FormSetStorage->ConfigRequest, FALSE);
3583 }
3584 } else {
3585 StorageLink = GetFirstNode (&LocalFormSet->SaveFailStorageListHead);
3586 while (!IsNull (&LocalFormSet->SaveFailStorageListHead, StorageLink)) {
3587 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (StorageLink);
3588 StorageLink = GetNextNode (&LocalFormSet->SaveFailStorageListHead, StorageLink);
3589 //
3590 // Process the submit fail question, base on the RestoreConfigRequest to restore the EditBuffer
3591 // base on the SyncConfigRequest to Sync the buffer.
3592 //
3593 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->RestoreConfigRequest, FALSE);
3594 FreePool (FormSetStorage->RestoreConfigRequest);
3595 FormSetStorage->RestoreConfigRequest = NULL;
3596 if ( FormSetStorage->SyncConfigRequest != NULL) {
3597 SynchronizeStorage (FormSetStorage->BrowserStorage, FormSetStorage->SyncConfigRequest, TRUE);
3598 FreePool (FormSetStorage->SyncConfigRequest);
3599 FormSetStorage->SyncConfigRequest = NULL;
3600 }
3601 }
3602 }
3603
3604 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
3605 CleanBrowserStorage(LocalFormSet);
3606 RemoveEntryList (&LocalFormSet->Link);
3607 RemoveEntryList (&LocalFormSet->SaveFailLink);
3608 DestroyFormSet (LocalFormSet);
3609 } else {
3610 ValueChangeResetFlagUpdate(FALSE, LocalFormSet, NULL);
3611 }
3612 } else {
3613 if (IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3614 NoSubmitCheck (LocalFormSet, &Form, &Question);
3615 }
3616
3617 UiCopyMenuList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &Form->FormViewListHead);
3618
3619 gCurrentSelection->Action = UI_ACTION_REFRESH_FORMSET;
3620 gCurrentSelection->Handle = LocalFormSet->HiiHandle;
3621 CopyGuid (&gCurrentSelection->FormSetGuid, &LocalFormSet->Guid);
3622 gCurrentSelection->FormId = Form->FormId;
3623 gCurrentSelection->QuestionId = Question->QuestionId;
3624
3625 Status = EFI_UNSUPPORTED;
3626 break;
3627 }
3628 }
3629
3630 //
3631 // Clean the list which will not process.
3632 //
3633 while (!IsListEmpty (&gBrowserSaveFailFormSetList)) {
3634 Link = GetFirstNode (&gBrowserSaveFailFormSetList);
3635 LocalFormSet = FORM_BROWSER_FORMSET_FROM_SAVE_FAIL_LINK (Link);
3636 RemoveEntryList (&LocalFormSet->SaveFailLink);
3637
3638 while (!IsListEmpty (&LocalFormSet->SaveFailStorageListHead)) {
3639 StorageLink = GetFirstNode (&LocalFormSet->SaveFailStorageListHead);
3640 FormSetStorage = FORMSET_STORAGE_FROM_SAVE_FAIL_LINK (StorageLink);
3641 RemoveEntryList (&FormSetStorage->SaveFailLink);
3642 }
3643 }
3644
3645 return Status;
3646 }
3647
3648 /**
3649 Submit data based on the input Setting level (Form, FormSet or System).
3650
3651 @param FormSet FormSet data structure.
3652 @param Form Form data structure.
3653 @param SettingScope Setting Scope for Submit action.
3654
3655 @retval EFI_SUCCESS The function completed successfully.
3656 @retval EFI_UNSUPPORTED Unsupport SettingScope.
3657
3658 **/
3659 EFI_STATUS
3660 SubmitForm (
3661 IN FORM_BROWSER_FORMSET *FormSet,
3662 IN FORM_BROWSER_FORM *Form,
3663 IN BROWSER_SETTING_SCOPE SettingScope
3664 )
3665 {
3666 EFI_STATUS Status;
3667
3668 switch (SettingScope) {
3669 case FormLevel:
3670 Status = SubmitForForm(FormSet, Form);
3671 break;
3672
3673 case FormSetLevel:
3674 Status = SubmitForFormSet (FormSet, FALSE);
3675 break;
3676
3677 case SystemLevel:
3678 Status = SubmitForSystem ();
3679 break;
3680
3681 default:
3682 Status = EFI_UNSUPPORTED;
3683 break;
3684 }
3685
3686 return Status;
3687 }
3688
3689 /**
3690 Converts the unicode character of the string from uppercase to lowercase.
3691 This is a internal function.
3692
3693 @param ConfigString String to be converted
3694
3695 **/
3696 VOID
3697 EFIAPI
3698 HiiToLower (
3699 IN EFI_STRING ConfigString
3700 )
3701 {
3702 EFI_STRING String;
3703 BOOLEAN Lower;
3704
3705 ASSERT (ConfigString != NULL);
3706
3707 //
3708 // Convert all hex digits in range [A-F] in the configuration header to [a-f]
3709 //
3710 for (String = ConfigString, Lower = FALSE; *String != L'\0'; String++) {
3711 if (*String == L'=') {
3712 Lower = TRUE;
3713 } else if (*String == L'&') {
3714 Lower = FALSE;
3715 } else if (Lower && *String >= L'A' && *String <= L'F') {
3716 *String = (CHAR16) (*String - L'A' + L'a');
3717 }
3718 }
3719 }
3720
3721 /**
3722 Find the point in the ConfigResp string for this question.
3723
3724 @param Question The question.
3725 @param ConfigResp Get ConfigResp string.
3726
3727 @retval point to the offset where is for this question.
3728
3729 **/
3730 CHAR16 *
3731 GetOffsetFromConfigResp (
3732 IN FORM_BROWSER_STATEMENT *Question,
3733 IN CHAR16 *ConfigResp
3734 )
3735 {
3736 CHAR16 *RequestElement;
3737 CHAR16 *BlockData;
3738
3739 //
3740 // Type is EFI_HII_VARSTORE_NAME_VALUE.
3741 //
3742 if (Question->Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
3743 RequestElement = StrStr (ConfigResp, Question->VariableName);
3744 if (RequestElement != NULL) {
3745 //
3746 // Skip the "VariableName=" field.
3747 //
3748 RequestElement += StrLen (Question->VariableName) + 1;
3749 }
3750
3751 return RequestElement;
3752 }
3753
3754 //
3755 // Type is EFI_HII_VARSTORE_EFI_VARIABLE or EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER
3756 //
3757
3758 //
3759 // 1. Directly use Question->BlockName to find.
3760 //
3761 RequestElement = StrStr (ConfigResp, Question->BlockName);
3762 if (RequestElement != NULL) {
3763 //
3764 // Skip the "Question->BlockName&VALUE=" field.
3765 //
3766 RequestElement += StrLen (Question->BlockName) + StrLen (L"&VALUE=");
3767 return RequestElement;
3768 }
3769
3770 //
3771 // 2. Change all hex digits in Question->BlockName to lower and compare again.
3772 //
3773 BlockData = AllocateCopyPool (StrSize(Question->BlockName), Question->BlockName);
3774 ASSERT (BlockData != NULL);
3775 HiiToLower (BlockData);
3776 RequestElement = StrStr (ConfigResp, BlockData);
3777 FreePool (BlockData);
3778
3779 if (RequestElement != NULL) {
3780 //
3781 // Skip the "Question->BlockName&VALUE=" field.
3782 //
3783 RequestElement += StrLen (Question->BlockName) + StrLen (L"&VALUE=");
3784 }
3785
3786 return RequestElement;
3787 }
3788
3789 /**
3790 Get Question default value from AltCfg string.
3791
3792 @param FormSet The form set.
3793 @param Form The form
3794 @param Question The question.
3795
3796 @retval EFI_SUCCESS Question is reset to default value.
3797
3798 **/
3799 EFI_STATUS
3800 GetDefaultValueFromAltCfg (
3801 IN FORM_BROWSER_FORMSET *FormSet,
3802 IN FORM_BROWSER_FORM *Form,
3803 IN OUT FORM_BROWSER_STATEMENT *Question
3804 )
3805 {
3806 BROWSER_STORAGE *Storage;
3807 FORMSET_STORAGE *FormSetStorage;
3808 CHAR16 *ConfigResp;
3809 CHAR16 *Value;
3810 LIST_ENTRY *Link;
3811 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
3812
3813 Storage = Question->Storage;
3814 if ((Storage == NULL) || (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE)) {
3815 return EFI_NOT_FOUND;
3816 }
3817
3818 //
3819 // Try to get AltCfg string from form. If not found it, then
3820 // try to get it from formset.
3821 //
3822 ConfigResp = NULL;
3823 Link = GetFirstNode (&Form->ConfigRequestHead);
3824 while (!IsNull (&Form->ConfigRequestHead, Link)) {
3825 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
3826 Link = GetNextNode (&Form->ConfigRequestHead, Link);
3827
3828 if (Storage == ConfigInfo->Storage) {
3829 ConfigResp = ConfigInfo->ConfigAltResp;
3830 break;
3831 }
3832 }
3833
3834 if (ConfigResp == NULL) {
3835 Link = GetFirstNode (&FormSet->StorageListHead);
3836 while (!IsNull (&FormSet->StorageListHead, Link)) {
3837 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
3838 Link = GetNextNode (&FormSet->StorageListHead, Link);
3839
3840 if (Storage == FormSetStorage->BrowserStorage) {
3841 ConfigResp = FormSetStorage->ConfigAltResp;
3842 break;
3843 }
3844 }
3845 }
3846
3847 if (ConfigResp == NULL) {
3848 return EFI_NOT_FOUND;
3849 }
3850
3851 Value = GetOffsetFromConfigResp (Question, ConfigResp);
3852 if (Value == NULL) {
3853 return EFI_NOT_FOUND;
3854 }
3855
3856 return BufferToValue (Question, Value);
3857 }
3858
3859 /**
3860 Get default Id value used for browser.
3861
3862 @param DefaultId The default id value used by hii.
3863
3864 @retval Browser used default value.
3865
3866 **/
3867 INTN
3868 GetDefaultIdForCallBack (
3869 UINTN DefaultId
3870 )
3871 {
3872 if (DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) {
3873 return EFI_BROWSER_ACTION_DEFAULT_STANDARD;
3874 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
3875 return EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING;
3876 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_SAFE) {
3877 return EFI_BROWSER_ACTION_DEFAULT_SAFE;
3878 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN + 0x1000) {
3879 return EFI_BROWSER_ACTION_DEFAULT_PLATFORM + DefaultId - EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN;
3880 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN + 0x1000) {
3881 return EFI_BROWSER_ACTION_DEFAULT_HARDWARE + DefaultId - EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN;
3882 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN + 0x1000) {
3883 return EFI_BROWSER_ACTION_DEFAULT_FIRMWARE + DefaultId - EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN;
3884 } else {
3885 return -1;
3886 }
3887 }
3888
3889
3890
3891 /**
3892 Return data element in an Array by its Index.
3893
3894 @param Array The data array.
3895 @param Type Type of the data in this array.
3896 @param Index Zero based index for data in this array.
3897
3898 @retval Value The data to be returned
3899
3900 **/
3901 UINT64
3902 GetArrayData (
3903 IN VOID *Array,
3904 IN UINT8 Type,
3905 IN UINTN Index
3906 )
3907 {
3908 UINT64 Data;
3909
3910 ASSERT (Array != NULL);
3911
3912 Data = 0;
3913 switch (Type) {
3914 case EFI_IFR_TYPE_NUM_SIZE_8:
3915 Data = (UINT64) *(((UINT8 *) Array) + Index);
3916 break;
3917
3918 case EFI_IFR_TYPE_NUM_SIZE_16:
3919 Data = (UINT64) *(((UINT16 *) Array) + Index);
3920 break;
3921
3922 case EFI_IFR_TYPE_NUM_SIZE_32:
3923 Data = (UINT64) *(((UINT32 *) Array) + Index);
3924 break;
3925
3926 case EFI_IFR_TYPE_NUM_SIZE_64:
3927 Data = (UINT64) *(((UINT64 *) Array) + Index);
3928 break;
3929
3930 default:
3931 break;
3932 }
3933
3934 return Data;
3935 }
3936
3937
3938 /**
3939 Set value of a data element in an Array by its Index.
3940
3941 @param Array The data array.
3942 @param Type Type of the data in this array.
3943 @param Index Zero based index for data in this array.
3944 @param Value The value to be set.
3945
3946 **/
3947 VOID
3948 SetArrayData (
3949 IN VOID *Array,
3950 IN UINT8 Type,
3951 IN UINTN Index,
3952 IN UINT64 Value
3953 )
3954 {
3955
3956 ASSERT (Array != NULL);
3957
3958 switch (Type) {
3959 case EFI_IFR_TYPE_NUM_SIZE_8:
3960 *(((UINT8 *) Array) + Index) = (UINT8) Value;
3961 break;
3962
3963 case EFI_IFR_TYPE_NUM_SIZE_16:
3964 *(((UINT16 *) Array) + Index) = (UINT16) Value;
3965 break;
3966
3967 case EFI_IFR_TYPE_NUM_SIZE_32:
3968 *(((UINT32 *) Array) + Index) = (UINT32) Value;
3969 break;
3970
3971 case EFI_IFR_TYPE_NUM_SIZE_64:
3972 *(((UINT64 *) Array) + Index) = (UINT64) Value;
3973 break;
3974
3975 default:
3976 break;
3977 }
3978 }
3979
3980 /**
3981 Search an Option of a Question by its value.
3982
3983 @param Question The Question
3984 @param OptionValue Value for Option to be searched.
3985
3986 @retval Pointer Pointer to the found Option.
3987 @retval NULL Option not found.
3988
3989 **/
3990 QUESTION_OPTION *
3991 ValueToOption (
3992 IN FORM_BROWSER_STATEMENT *Question,
3993 IN EFI_HII_VALUE *OptionValue
3994 )
3995 {
3996 LIST_ENTRY *Link;
3997 QUESTION_OPTION *Option;
3998 INTN Result;
3999
4000 Link = GetFirstNode (&Question->OptionListHead);
4001 while (!IsNull (&Question->OptionListHead, Link)) {
4002 Option = QUESTION_OPTION_FROM_LINK (Link);
4003
4004 if ((CompareHiiValue (&Option->Value, OptionValue, &Result, NULL) == EFI_SUCCESS) && (Result == 0)) {
4005 //
4006 // Check the suppressif condition, only a valid option can be return.
4007 //
4008 if ((Option->SuppressExpression == NULL) ||
4009 ((EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) == ExpressFalse))) {
4010 return Option;
4011 }
4012 }
4013
4014 Link = GetNextNode (&Question->OptionListHead, Link);
4015 }
4016
4017 return NULL;
4018 }
4019
4020
4021 /**
4022 Reset Question to its default value.
4023
4024 @param FormSet The form set.
4025 @param Form The form.
4026 @param Question The question.
4027 @param DefaultId The Class of the default.
4028
4029 @retval EFI_SUCCESS Question is reset to default value.
4030
4031 **/
4032 EFI_STATUS
4033 GetQuestionDefault (
4034 IN FORM_BROWSER_FORMSET *FormSet,
4035 IN FORM_BROWSER_FORM *Form,
4036 IN FORM_BROWSER_STATEMENT *Question,
4037 IN UINT16 DefaultId
4038 )
4039 {
4040 EFI_STATUS Status;
4041 LIST_ENTRY *Link;
4042 QUESTION_DEFAULT *Default;
4043 QUESTION_OPTION *Option;
4044 EFI_HII_VALUE *HiiValue;
4045 UINT8 Index;
4046 EFI_STRING StrValue;
4047 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
4048 EFI_BROWSER_ACTION_REQUEST ActionRequest;
4049 INTN Action;
4050 CHAR16 *NewString;
4051 EFI_IFR_TYPE_VALUE *TypeValue;
4052
4053 Status = EFI_NOT_FOUND;
4054 StrValue = NULL;
4055
4056 //
4057 // Statement don't have storage, skip them
4058 //
4059 if (Question->QuestionId == 0) {
4060 return Status;
4061 }
4062
4063 //
4064 // There are Five ways to specify default value for a Question:
4065 // 1, use call back function (highest priority)
4066 // 2, use ExtractConfig function
4067 // 3, use nested EFI_IFR_DEFAULT
4068 // 4, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
4069 // 5, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
4070 //
4071 HiiValue = &Question->HiiValue;
4072 TypeValue = &HiiValue->Value;
4073 if (HiiValue->Type == EFI_IFR_TYPE_BUFFER) {
4074 //
4075 // For orderedlist, need to pass the BufferValue to Callback function.
4076 //
4077 TypeValue = (EFI_IFR_TYPE_VALUE *) Question->BufferValue;
4078 }
4079
4080 //
4081 // Get Question defaut value from call back function.
4082 //
4083 ConfigAccess = FormSet->ConfigAccess;
4084 Action = GetDefaultIdForCallBack (DefaultId);
4085 if ((Action > 0) && ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) && (ConfigAccess != NULL)) {
4086 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
4087 Status = ConfigAccess->Callback (
4088 ConfigAccess,
4089 Action,
4090 Question->QuestionId,
4091 HiiValue->Type,
4092 TypeValue,
4093 &ActionRequest
4094 );
4095 if (!EFI_ERROR (Status)) {
4096 if (HiiValue->Type == EFI_IFR_TYPE_STRING) {
4097 NewString = GetToken (Question->HiiValue.Value.string, FormSet->HiiHandle);
4098 ASSERT (NewString != NULL);
4099
4100 ASSERT (StrLen (NewString) * sizeof (CHAR16) <= Question->StorageWidth);
4101 if (StrLen (NewString) * sizeof (CHAR16) <= Question->StorageWidth) {
4102 CopyMem (Question->BufferValue, NewString, StrSize (NewString));
4103 } else {
4104 CopyMem (Question->BufferValue, NewString, Question->StorageWidth);
4105 }
4106
4107 FreePool (NewString);
4108 }
4109 return Status;
4110 }
4111 }
4112
4113 //
4114 // Get default value from altcfg string.
4115 //
4116 if (ConfigAccess != NULL) {
4117 Status = GetDefaultValueFromAltCfg(FormSet, Form, Question);
4118 if (!EFI_ERROR (Status)) {
4119 return Status;
4120 }
4121 }
4122
4123 //
4124 // EFI_IFR_DEFAULT has highest priority
4125 //
4126 if (!IsListEmpty (&Question->DefaultListHead)) {
4127 Link = GetFirstNode (&Question->DefaultListHead);
4128 while (!IsNull (&Question->DefaultListHead, Link)) {
4129 Default = QUESTION_DEFAULT_FROM_LINK (Link);
4130
4131 if (Default->DefaultId == DefaultId) {
4132 if (Default->ValueExpression != NULL) {
4133 //
4134 // Default is provided by an Expression, evaluate it
4135 //
4136 Status = EvaluateExpression (FormSet, Form, Default->ValueExpression);
4137 if (EFI_ERROR (Status)) {
4138 return Status;
4139 }
4140
4141 if (Default->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
4142 ASSERT (HiiValue->Type == EFI_IFR_TYPE_BUFFER && Question->BufferValue != NULL);
4143 if (Question->StorageWidth > Default->ValueExpression->Result.BufferLen) {
4144 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Default->ValueExpression->Result.BufferLen);
4145 Question->HiiValue.BufferLen = Default->ValueExpression->Result.BufferLen;
4146 } else {
4147 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Question->StorageWidth);
4148 Question->HiiValue.BufferLen = Question->StorageWidth;
4149 }
4150 FreePool (Default->ValueExpression->Result.Buffer);
4151 }
4152 HiiValue->Type = Default->ValueExpression->Result.Type;
4153 CopyMem (&HiiValue->Value, &Default->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
4154 } else {
4155 //
4156 // Default value is embedded in EFI_IFR_DEFAULT
4157 //
4158 if (Default->Value.Type == EFI_IFR_TYPE_BUFFER) {
4159 ASSERT (HiiValue->Buffer != NULL);
4160 CopyMem (HiiValue->Buffer, Default->Value.Buffer, Default->Value.BufferLen);
4161 } else {
4162 CopyMem (HiiValue, &Default->Value, sizeof (EFI_HII_VALUE));
4163 }
4164 }
4165
4166 if (HiiValue->Type == EFI_IFR_TYPE_STRING) {
4167 StrValue = HiiGetString (FormSet->HiiHandle, HiiValue->Value.string, NULL);
4168 if (StrValue == NULL) {
4169 return EFI_NOT_FOUND;
4170 }
4171 if (Question->StorageWidth > StrSize (StrValue)) {
4172 CopyMem (Question->BufferValue, StrValue, StrSize (StrValue));
4173 } else {
4174 CopyMem (Question->BufferValue, StrValue, Question->StorageWidth);
4175 }
4176 }
4177
4178 return EFI_SUCCESS;
4179 }
4180
4181 Link = GetNextNode (&Question->DefaultListHead, Link);
4182 }
4183 }
4184
4185 //
4186 // EFI_ONE_OF_OPTION
4187 //
4188 if ((Question->Operand == EFI_IFR_ONE_OF_OP) && !IsListEmpty (&Question->OptionListHead)) {
4189 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
4190 //
4191 // OneOfOption could only provide Standard and Manufacturing default
4192 //
4193 Link = GetFirstNode (&Question->OptionListHead);
4194 while (!IsNull (&Question->OptionListHead, Link)) {
4195 Option = QUESTION_OPTION_FROM_LINK (Link);
4196 Link = GetNextNode (&Question->OptionListHead, Link);
4197
4198 if ((Option->SuppressExpression != NULL) &&
4199 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4200 continue;
4201 }
4202
4203 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT) != 0)) ||
4204 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT_MFG) != 0))
4205 ) {
4206 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
4207
4208 return EFI_SUCCESS;
4209 }
4210 }
4211 }
4212 }
4213
4214 //
4215 // EFI_IFR_CHECKBOX - lowest priority
4216 //
4217 if (Question->Operand == EFI_IFR_CHECKBOX_OP) {
4218 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
4219 //
4220 // Checkbox could only provide Standard and Manufacturing default
4221 //
4222 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT) != 0)) ||
4223 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT_MFG) != 0))
4224 ) {
4225 HiiValue->Value.b = TRUE;
4226 } else {
4227 HiiValue->Value.b = FALSE;
4228 }
4229
4230 return EFI_SUCCESS;
4231 }
4232 }
4233
4234 //
4235 // For Questions without default
4236 //
4237 Status = EFI_NOT_FOUND;
4238 switch (Question->Operand) {
4239 case EFI_IFR_NUMERIC_OP:
4240 //
4241 // Take minimum value as numeric default value
4242 //
4243 if ((Question->Flags & EFI_IFR_DISPLAY) == 0) {
4244 //
4245 // In EFI_IFR_DISPLAY_INT_DEC type, should check value with int* type.
4246 //
4247 switch (Question->Flags & EFI_IFR_NUMERIC_SIZE) {
4248 case EFI_IFR_NUMERIC_SIZE_1:
4249 if (((INT8) HiiValue->Value.u8 < (INT8) Question->Minimum) || ((INT8) HiiValue->Value.u8 > (INT8) Question->Maximum)) {
4250 HiiValue->Value.u8 = (UINT8) Question->Minimum;
4251 Status = EFI_SUCCESS;
4252 }
4253 break;
4254 case EFI_IFR_NUMERIC_SIZE_2:
4255 if (((INT16) HiiValue->Value.u16 < (INT16) Question->Minimum) || ((INT16) HiiValue->Value.u16 > (INT16) Question->Maximum)) {
4256 HiiValue->Value.u16 = (UINT16) Question->Minimum;
4257 Status = EFI_SUCCESS;
4258 }
4259 break;
4260 case EFI_IFR_NUMERIC_SIZE_4:
4261 if (((INT32) HiiValue->Value.u32 < (INT32) Question->Minimum) || ((INT32) HiiValue->Value.u32 > (INT32) Question->Maximum)) {
4262 HiiValue->Value.u32 = (UINT32) Question->Minimum;
4263 Status = EFI_SUCCESS;
4264 }
4265 break;
4266 case EFI_IFR_NUMERIC_SIZE_8:
4267 if (((INT64) HiiValue->Value.u64 < (INT64) Question->Minimum) || ((INT64) HiiValue->Value.u64 > (INT64) Question->Maximum)) {
4268 HiiValue->Value.u64 = Question->Minimum;
4269 Status = EFI_SUCCESS;
4270 }
4271 break;
4272 default:
4273 break;
4274 }
4275 } else {
4276 if ((HiiValue->Value.u64 < Question->Minimum) || (HiiValue->Value.u64 > Question->Maximum)) {
4277 HiiValue->Value.u64 = Question->Minimum;
4278 Status = EFI_SUCCESS;
4279 }
4280 }
4281 break;
4282
4283 case EFI_IFR_ONE_OF_OP:
4284 //
4285 // Take first oneof option as oneof's default value
4286 //
4287 if (ValueToOption (Question, HiiValue) == NULL) {
4288 Link = GetFirstNode (&Question->OptionListHead);
4289 while (!IsNull (&Question->OptionListHead, Link)) {
4290 Option = QUESTION_OPTION_FROM_LINK (Link);
4291 Link = GetNextNode (&Question->OptionListHead, Link);
4292
4293 if ((Option->SuppressExpression != NULL) &&
4294 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4295 continue;
4296 }
4297
4298 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
4299 Status = EFI_SUCCESS;
4300 break;
4301 }
4302 }
4303 break;
4304
4305 case EFI_IFR_ORDERED_LIST_OP:
4306 //
4307 // Take option sequence in IFR as ordered list's default value
4308 //
4309 Index = 0;
4310 Link = GetFirstNode (&Question->OptionListHead);
4311 while (!IsNull (&Question->OptionListHead, Link)) {
4312 Status = EFI_SUCCESS;
4313 Option = QUESTION_OPTION_FROM_LINK (Link);
4314 Link = GetNextNode (&Question->OptionListHead, Link);
4315
4316 if ((Option->SuppressExpression != NULL) &&
4317 EvaluateExpressionList(Option->SuppressExpression, FALSE, NULL, NULL) != ExpressFalse) {
4318 continue;
4319 }
4320
4321 SetArrayData (Question->BufferValue, Question->ValueType, Index, Option->Value.Value.u64);
4322
4323 Index++;
4324 if (Index >= Question->MaxContainers) {
4325 break;
4326 }
4327 }
4328 break;
4329
4330 default:
4331 break;
4332 }
4333
4334 return Status;
4335 }
4336
4337 /**
4338 Get AltCfg string for current form.
4339
4340 @param FormSet Form data structure.
4341 @param Form Form data structure.
4342 @param DefaultId The Class of the default.
4343 @param BrowserStorage The input request storage for the questions.
4344
4345 **/
4346 VOID
4347 ExtractAltCfgForForm (
4348 IN FORM_BROWSER_FORMSET *FormSet,
4349 IN FORM_BROWSER_FORM *Form,
4350 IN UINT16 DefaultId,
4351 IN BROWSER_STORAGE *BrowserStorage
4352 )
4353 {
4354 EFI_STATUS Status;
4355 LIST_ENTRY *Link;
4356 CHAR16 *ConfigResp;
4357 CHAR16 *Progress;
4358 CHAR16 *Result;
4359 BROWSER_STORAGE *Storage;
4360 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
4361 FORMSET_STORAGE *FormSetStorage;
4362
4363 //
4364 // Check whether has get AltCfg string for this formset.
4365 // If yes, no need to get AltCfg for form.
4366 //
4367 Link = GetFirstNode (&FormSet->StorageListHead);
4368 while (!IsNull (&FormSet->StorageListHead, Link)) {
4369 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4370 Storage = FormSetStorage->BrowserStorage;
4371 Link = GetNextNode (&FormSet->StorageListHead, Link);
4372 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4373 continue;
4374 }
4375
4376 if (Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE &&
4377 FormSetStorage->ElementCount != 0 &&
4378 FormSetStorage->HasCallAltCfg) {
4379 return;
4380 }
4381 }
4382
4383 //
4384 // Get AltCfg string for each form.
4385 //
4386 Link = GetFirstNode (&Form->ConfigRequestHead);
4387 while (!IsNull (&Form->ConfigRequestHead, Link)) {
4388 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
4389 Link = GetNextNode (&Form->ConfigRequestHead, Link);
4390
4391 Storage = ConfigInfo->Storage;
4392 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4393 continue;
4394 }
4395
4396 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
4397 continue;
4398 }
4399
4400 //
4401 // 1. Skip if there is no RequestElement
4402 //
4403 if (ConfigInfo->ElementCount == 0) {
4404 continue;
4405 }
4406
4407 //
4408 // 2. Get value through hii config routine protocol.
4409 //
4410 Status = mHiiConfigRouting->ExtractConfig (
4411 mHiiConfigRouting,
4412 ConfigInfo->ConfigRequest,
4413 &Progress,
4414 &Result
4415 );
4416 if (EFI_ERROR (Status)) {
4417 continue;
4418 }
4419
4420 //
4421 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
4422 // Get the default configuration string according to the default ID.
4423 //
4424 Status = mHiiConfigRouting->GetAltConfig (
4425 mHiiConfigRouting,
4426 Result,
4427 &Storage->Guid,
4428 Storage->Name,
4429 NULL,
4430 &DefaultId, // it can be NULL to get the current setting.
4431 &ConfigResp
4432 );
4433 FreePool (Result);
4434 if (EFI_ERROR (Status)) {
4435 continue;
4436 }
4437
4438 ConfigInfo->ConfigAltResp = ConfigResp;
4439 }
4440 }
4441
4442 /**
4443 Clean AltCfg string for current form.
4444
4445 @param Form Form data structure.
4446
4447 **/
4448 VOID
4449 CleanAltCfgForForm (
4450 IN FORM_BROWSER_FORM *Form
4451 )
4452 {
4453 LIST_ENTRY *Link;
4454 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
4455
4456 Link = GetFirstNode (&Form->ConfigRequestHead);
4457 while (!IsNull (&Form->ConfigRequestHead, Link)) {
4458 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
4459 Link = GetNextNode (&Form->ConfigRequestHead, Link);
4460
4461 if (ConfigInfo->ConfigAltResp != NULL) {
4462 FreePool (ConfigInfo->ConfigAltResp);
4463 ConfigInfo->ConfigAltResp = NULL;
4464 }
4465 }
4466 }
4467
4468 /**
4469 Get AltCfg string for current formset.
4470
4471 @param FormSet Form data structure.
4472 @param DefaultId The Class of the default.
4473 @param BrowserStorage The input request storage for the questions.
4474
4475 **/
4476 VOID
4477 ExtractAltCfgForFormSet (
4478 IN FORM_BROWSER_FORMSET *FormSet,
4479 IN UINT16 DefaultId,
4480 IN BROWSER_STORAGE *BrowserStorage
4481 )
4482 {
4483 EFI_STATUS Status;
4484 LIST_ENTRY *Link;
4485 CHAR16 *ConfigResp;
4486 CHAR16 *Progress;
4487 CHAR16 *Result;
4488 BROWSER_STORAGE *Storage;
4489 FORMSET_STORAGE *FormSetStorage;
4490
4491 Link = GetFirstNode (&FormSet->StorageListHead);
4492 while (!IsNull (&FormSet->StorageListHead, Link)) {
4493 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4494 Storage = FormSetStorage->BrowserStorage;
4495 Link = GetNextNode (&FormSet->StorageListHead, Link);
4496
4497 if (BrowserStorage != NULL && BrowserStorage != Storage) {
4498 continue;
4499 }
4500
4501 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
4502 continue;
4503 }
4504
4505 //
4506 // 1. Skip if there is no RequestElement
4507 //
4508 if (FormSetStorage->ElementCount == 0) {
4509 continue;
4510 }
4511
4512 FormSetStorage->HasCallAltCfg = TRUE;
4513
4514 //
4515 // 2. Get value through hii config routine protocol.
4516 //
4517 Status = mHiiConfigRouting->ExtractConfig (
4518 mHiiConfigRouting,
4519 FormSetStorage->ConfigRequest,
4520 &Progress,
4521 &Result
4522 );
4523 if (EFI_ERROR (Status)) {
4524 continue;
4525 }
4526
4527 //
4528 // 3. Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
4529 // Get the default configuration string according to the default ID.
4530 //
4531 Status = mHiiConfigRouting->GetAltConfig (
4532 mHiiConfigRouting,
4533 Result,
4534 &Storage->Guid,
4535 Storage->Name,
4536 NULL,
4537 &DefaultId, // it can be NULL to get the current setting.
4538 &ConfigResp
4539 );
4540
4541 FreePool (Result);
4542 if (EFI_ERROR (Status)) {
4543 continue;
4544 }
4545
4546 FormSetStorage->ConfigAltResp = ConfigResp;
4547 }
4548
4549 }
4550
4551 /**
4552 Clean AltCfg string for current formset.
4553
4554 @param FormSet Form data structure.
4555
4556 **/
4557 VOID
4558 CleanAltCfgForFormSet (
4559 IN FORM_BROWSER_FORMSET *FormSet
4560 )
4561 {
4562 LIST_ENTRY *Link;
4563 FORMSET_STORAGE *FormSetStorage;
4564
4565 Link = GetFirstNode (&FormSet->StorageListHead);
4566 while (!IsNull (&FormSet->StorageListHead, Link)) {
4567 FormSetStorage = FORMSET_STORAGE_FROM_LINK (Link);
4568 Link = GetNextNode (&FormSet->StorageListHead, Link);
4569
4570 if (FormSetStorage->ConfigAltResp != NULL) {
4571 FreePool (FormSetStorage->ConfigAltResp);
4572 FormSetStorage->ConfigAltResp = NULL;
4573 }
4574
4575 FormSetStorage->HasCallAltCfg = FALSE;
4576 }
4577 }
4578
4579 /**
4580 Reset Questions to their initial value or default value in a Form, Formset or System.
4581
4582 GetDefaultValueScope parameter decides which questions will reset
4583 to its default value.
4584
4585 @param FormSet FormSet data structure.
4586 @param Form Form data structure.
4587 @param DefaultId The Class of the default.
4588 @param SettingScope Setting Scope for Default action.
4589 @param GetDefaultValueScope Get default value scope.
4590 @param Storage Get default value only for this storage.
4591 @param RetrieveValueFirst Whether call the retrieve call back to
4592 get the initial value before get default
4593 value.
4594 @param SkipGetAltCfg Whether skip the get altcfg string process.
4595
4596 @retval EFI_SUCCESS The function completed successfully.
4597 @retval EFI_UNSUPPORTED Unsupport SettingScope.
4598
4599 **/
4600 EFI_STATUS
4601 ExtractDefault (
4602 IN FORM_BROWSER_FORMSET *FormSet,
4603 IN FORM_BROWSER_FORM *Form,
4604 IN UINT16 DefaultId,
4605 IN BROWSER_SETTING_SCOPE SettingScope,
4606 IN BROWSER_GET_DEFAULT_VALUE GetDefaultValueScope,
4607 IN BROWSER_STORAGE *Storage OPTIONAL,
4608 IN BOOLEAN RetrieveValueFirst,
4609 IN BOOLEAN SkipGetAltCfg
4610 )
4611 {
4612 EFI_STATUS Status;
4613 LIST_ENTRY *FormLink;
4614 LIST_ENTRY *Link;
4615 FORM_BROWSER_STATEMENT *Question;
4616 FORM_BROWSER_FORMSET *LocalFormSet;
4617 FORM_BROWSER_FORMSET *OldFormSet;
4618
4619 Status = EFI_SUCCESS;
4620
4621 //
4622 // Check the supported setting level.
4623 //
4624 if (SettingScope >= MaxLevel || GetDefaultValueScope >= GetDefaultForMax) {
4625 return EFI_UNSUPPORTED;
4626 }
4627
4628 if (GetDefaultValueScope == GetDefaultForStorage && Storage == NULL) {
4629 return EFI_UNSUPPORTED;
4630 }
4631
4632 if (SettingScope == FormLevel) {
4633 //
4634 // Prepare the AltCfg String for form.
4635 //
4636 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4637 ExtractAltCfgForForm (FormSet, Form, DefaultId, Storage);
4638 }
4639
4640 //
4641 // Extract Form default
4642 //
4643 Link = GetFirstNode (&Form->StatementListHead);
4644 while (!IsNull (&Form->StatementListHead, Link)) {
4645 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
4646 Link = GetNextNode (&Form->StatementListHead, Link);
4647
4648 //
4649 // If get default value only for this storage, check the storage first.
4650 //
4651 if ((GetDefaultValueScope == GetDefaultForStorage) && (Question->Storage != Storage)) {
4652 continue;
4653 }
4654
4655 //
4656 // If get default value only for no storage question, just skip the question which has storage.
4657 //
4658 if ((GetDefaultValueScope == GetDefaultForNoStorage) && (Question->Storage != NULL)) {
4659 continue;
4660 }
4661
4662 //
4663 // If Question is disabled, don't reset it to default
4664 //
4665 if (Question->Expression != NULL) {
4666 if (EvaluateExpressionList(Question->Expression, TRUE, FormSet, Form) == ExpressDisable) {
4667 continue;
4668 }
4669 }
4670
4671 if (RetrieveValueFirst) {
4672 //
4673 // Call the Retrieve call back to get the initial question value.
4674 //
4675 Status = ProcessRetrieveForQuestion(FormSet->ConfigAccess, Question, FormSet);
4676 }
4677
4678 //
4679 // If not request to get the initial value or get initial value fail, then get default value.
4680 //
4681 if (!RetrieveValueFirst || EFI_ERROR (Status)) {
4682 Status = GetQuestionDefault (FormSet, Form, Question, DefaultId);
4683 if (EFI_ERROR (Status)) {
4684 continue;
4685 }
4686 }
4687
4688 //
4689 // Synchronize Buffer storage's Edit buffer
4690 //
4691 if ((Question->Storage != NULL) &&
4692 (Question->Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE)) {
4693 SetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4694 }
4695 }
4696
4697 //
4698 // Clean the AltCfg String.
4699 //
4700 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4701 CleanAltCfgForForm(Form);
4702 }
4703 } else if (SettingScope == FormSetLevel) {
4704 //
4705 // Prepare the AltCfg String for formset.
4706 //
4707 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4708 ExtractAltCfgForFormSet (FormSet, DefaultId, Storage);
4709 }
4710
4711 FormLink = GetFirstNode (&FormSet->FormListHead);
4712 while (!IsNull (&FormSet->FormListHead, FormLink)) {
4713 Form = FORM_BROWSER_FORM_FROM_LINK (FormLink);
4714 ExtractDefault (FormSet, Form, DefaultId, FormLevel, GetDefaultValueScope, Storage, RetrieveValueFirst, SkipGetAltCfg);
4715 FormLink = GetNextNode (&FormSet->FormListHead, FormLink);
4716 }
4717
4718 //
4719 // Clean the AltCfg String.
4720 //
4721 if (!SkipGetAltCfg && (GetDefaultValueScope != GetDefaultForNoStorage)) {
4722 CleanAltCfgForFormSet (FormSet);
4723 }
4724 } else if (SettingScope == SystemLevel) {
4725 //
4726 // Preload all Hii formset.
4727 //
4728 LoadAllHiiFormset();
4729
4730 OldFormSet = mSystemLevelFormSet;
4731
4732 //
4733 // Set Default Value for each FormSet in the maintain list.
4734 //
4735 Link = GetFirstNode (&gBrowserFormSetList);
4736 while (!IsNull (&gBrowserFormSetList, Link)) {
4737 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
4738 Link = GetNextNode (&gBrowserFormSetList, Link);
4739 if (!ValidateFormSet(LocalFormSet)) {
4740 continue;
4741 }
4742
4743 mSystemLevelFormSet = LocalFormSet;
4744
4745 ExtractDefault (LocalFormSet, NULL, DefaultId, FormSetLevel, GetDefaultValueScope, Storage, RetrieveValueFirst, SkipGetAltCfg);
4746 }
4747
4748 mSystemLevelFormSet = OldFormSet;
4749 }
4750
4751 return EFI_SUCCESS;
4752 }
4753
4754
4755 /**
4756 Validate whether this question's value has changed.
4757
4758 @param FormSet FormSet data structure.
4759 @param Form Form data structure.
4760 @param Question Question to be initialized.
4761 @param GetValueFrom Where to get value, may from editbuffer, buffer or hii driver.
4762
4763 @retval TRUE Question's value has changed.
4764 @retval FALSE Question's value has not changed
4765
4766 **/
4767 BOOLEAN
4768 IsQuestionValueChanged (
4769 IN FORM_BROWSER_FORMSET *FormSet,
4770 IN FORM_BROWSER_FORM *Form,
4771 IN OUT FORM_BROWSER_STATEMENT *Question,
4772 IN GET_SET_QUESTION_VALUE_WITH GetValueFrom
4773 )
4774 {
4775 EFI_HII_VALUE BackUpValue;
4776 CHAR8 *BackUpBuffer;
4777 EFI_HII_VALUE BackUpValue2;
4778 CHAR8 *BackUpBuffer2;
4779 EFI_STATUS Status;
4780 BOOLEAN ValueChanged;
4781 UINTN BufferWidth;
4782
4783 //
4784 // For quetion without storage, always mark it as data not changed.
4785 //
4786 if (Question->Storage == NULL && Question->Operand != EFI_IFR_TIME_OP && Question->Operand != EFI_IFR_DATE_OP) {
4787 return FALSE;
4788 }
4789
4790 BackUpBuffer = NULL;
4791 BackUpBuffer2 = NULL;
4792 ValueChanged = FALSE;
4793
4794 switch (Question->Operand) {
4795 case EFI_IFR_ORDERED_LIST_OP:
4796 BufferWidth = Question->StorageWidth;
4797 BackUpBuffer = AllocateCopyPool (BufferWidth, Question->BufferValue);
4798 ASSERT (BackUpBuffer != NULL);
4799 break;
4800
4801 case EFI_IFR_STRING_OP:
4802 case EFI_IFR_PASSWORD_OP:
4803 BufferWidth = (UINTN) Question->Maximum * sizeof (CHAR16);
4804 BackUpBuffer = AllocateCopyPool (BufferWidth, Question->BufferValue);
4805 ASSERT (BackUpBuffer != NULL);
4806 break;
4807
4808 default:
4809 BufferWidth = 0;
4810 break;
4811 }
4812 CopyMem (&BackUpValue, &Question->HiiValue, sizeof (EFI_HII_VALUE));
4813
4814 if (GetValueFrom == GetSetValueWithBothBuffer) {
4815 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4816 ASSERT_EFI_ERROR(Status);
4817
4818 switch (Question->Operand) {
4819 case EFI_IFR_ORDERED_LIST_OP:
4820 BufferWidth = Question->StorageWidth;
4821 BackUpBuffer2 = AllocateCopyPool (BufferWidth, Question->BufferValue);
4822 ASSERT (BackUpBuffer2 != NULL);
4823 break;
4824
4825 case EFI_IFR_STRING_OP:
4826 case EFI_IFR_PASSWORD_OP:
4827 BufferWidth = (UINTN) Question->Maximum * sizeof (CHAR16);
4828 BackUpBuffer2 = AllocateCopyPool (BufferWidth, Question->BufferValue);
4829 ASSERT (BackUpBuffer2 != NULL);
4830 break;
4831
4832 default:
4833 BufferWidth = 0;
4834 break;
4835 }
4836 CopyMem (&BackUpValue2, &Question->HiiValue, sizeof (EFI_HII_VALUE));
4837
4838 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithBuffer);
4839 ASSERT_EFI_ERROR(Status);
4840
4841 if (CompareMem (&BackUpValue2, &Question->HiiValue, sizeof (EFI_HII_VALUE)) != 0 ||
4842 CompareMem (BackUpBuffer2, Question->BufferValue, BufferWidth) != 0) {
4843 ValueChanged = TRUE;
4844 }
4845 } else {
4846 Status = GetQuestionValue (FormSet, Form, Question, GetValueFrom);
4847 ASSERT_EFI_ERROR(Status);
4848
4849 if (CompareMem (&BackUpValue, &Question->HiiValue, sizeof (EFI_HII_VALUE)) != 0 ||
4850 CompareMem (BackUpBuffer, Question->BufferValue, BufferWidth) != 0) {
4851 ValueChanged = TRUE;
4852 }
4853 }
4854
4855 CopyMem (&Question->HiiValue, &BackUpValue, sizeof (EFI_HII_VALUE));
4856 if (BackUpBuffer != NULL) {
4857 CopyMem (Question->BufferValue, BackUpBuffer, BufferWidth);
4858 FreePool (BackUpBuffer);
4859 }
4860
4861 if (BackUpBuffer2 != NULL) {
4862 FreePool (BackUpBuffer2);
4863 }
4864
4865 Question->ValueChanged = ValueChanged;
4866
4867 return ValueChanged;
4868 }
4869
4870 /**
4871 Initialize Question's Edit copy from Storage.
4872
4873 @param Selection Selection contains the information about
4874 the Selection, form and formset to be displayed.
4875 Selection action may be updated in retrieve callback.
4876 If Selection is NULL, only initialize Question value.
4877 @param FormSet FormSet data structure.
4878 @param Form Form data structure.
4879
4880 @retval EFI_SUCCESS The function completed successfully.
4881
4882 **/
4883 EFI_STATUS
4884 LoadFormConfig (
4885 IN OUT UI_MENU_SELECTION *Selection,
4886 IN FORM_BROWSER_FORMSET *FormSet,
4887 IN FORM_BROWSER_FORM *Form
4888 )
4889 {
4890 EFI_STATUS Status;
4891 LIST_ENTRY *Link;
4892 FORM_BROWSER_STATEMENT *Question;
4893
4894 Link = GetFirstNode (&Form->StatementListHead);
4895 while (!IsNull (&Form->StatementListHead, Link)) {
4896 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
4897
4898 //
4899 // Initialize local copy of Value for each Question
4900 //
4901 if (Question->Operand == EFI_IFR_PASSWORD_OP && (Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK)== 0) {
4902 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithHiiDriver);
4903 } else {
4904 Status = GetQuestionValue (FormSet, Form, Question, GetSetValueWithEditBuffer);
4905 }
4906 if (EFI_ERROR (Status)) {
4907 return Status;
4908 }
4909
4910 if ((Question->Operand == EFI_IFR_STRING_OP) || (Question->Operand == EFI_IFR_PASSWORD_OP)) {
4911 HiiSetString (FormSet->HiiHandle, Question->HiiValue.Value.string, (CHAR16*)Question->BufferValue, NULL);
4912 }
4913
4914 Link = GetNextNode (&Form->StatementListHead, Link);
4915 }
4916
4917 return EFI_SUCCESS;
4918 }
4919
4920 /**
4921 Initialize Question's Edit copy from Storage for the whole Formset.
4922
4923 @param Selection Selection contains the information about
4924 the Selection, form and formset to be displayed.
4925 Selection action may be updated in retrieve callback.
4926 If Selection is NULL, only initialize Question value.
4927 @param FormSet FormSet data structure.
4928
4929 @retval EFI_SUCCESS The function completed successfully.
4930
4931 **/
4932 EFI_STATUS
4933 LoadFormSetConfig (
4934 IN OUT UI_MENU_SELECTION *Selection,
4935 IN FORM_BROWSER_FORMSET *FormSet
4936 )
4937 {
4938 EFI_STATUS Status;
4939 LIST_ENTRY *Link;
4940 FORM_BROWSER_FORM *Form;
4941
4942 Link = GetFirstNode (&FormSet->FormListHead);
4943 while (!IsNull (&FormSet->FormListHead, Link)) {
4944 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
4945
4946 //
4947 // Initialize local copy of Value for each Form
4948 //
4949 Status = LoadFormConfig (Selection, FormSet, Form);
4950 if (EFI_ERROR (Status)) {
4951 return Status;
4952 }
4953
4954 Link = GetNextNode (&FormSet->FormListHead, Link);
4955 }
4956
4957 //
4958 // Finished question initialization.
4959 //
4960 FormSet->QuestionInited = TRUE;
4961
4962 return EFI_SUCCESS;
4963 }
4964
4965 /**
4966 Remove the Request element from the Config Request.
4967
4968 @param Storage Pointer to the browser storage.
4969 @param RequestElement The pointer to the Request element.
4970
4971 **/
4972 VOID
4973 RemoveElement (
4974 IN OUT BROWSER_STORAGE *Storage,
4975 IN CHAR16 *RequestElement
4976 )
4977 {
4978 CHAR16 *NewStr;
4979 CHAR16 *DestStr;
4980
4981 ASSERT (Storage->ConfigRequest != NULL && RequestElement != NULL);
4982
4983 NewStr = StrStr (Storage->ConfigRequest, RequestElement);
4984
4985 if (NewStr == NULL) {
4986 return;
4987 }
4988
4989 //
4990 // Remove this element from this ConfigRequest.
4991 //
4992 DestStr = NewStr;
4993 NewStr += StrLen (RequestElement);
4994 CopyMem (DestStr, NewStr, StrSize (NewStr));
4995
4996 Storage->SpareStrLen += StrLen (RequestElement);
4997 }
4998
4999 /**
5000 Adjust config request in storage, remove the request elements existed in the input ConfigRequest.
5001
5002 @param Storage Pointer to the formset storage.
5003 @param ConfigRequest The pointer to the Request element.
5004
5005 **/
5006 VOID
5007 RemoveConfigRequest (
5008 FORMSET_STORAGE *Storage,
5009 CHAR16 *ConfigRequest
5010 )
5011 {
5012 CHAR16 *RequestElement;
5013 CHAR16 *NextRequestElement;
5014 CHAR16 *SearchKey;
5015
5016 //
5017 // No request element in it, just return.
5018 //
5019 if (ConfigRequest == NULL) {
5020 return;
5021 }
5022
5023 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5024 //
5025 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
5026 //
5027 SearchKey = L"&";
5028 } else {
5029 //
5030 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
5031 //
5032 SearchKey = L"&OFFSET";
5033 }
5034
5035 //
5036 // Find SearchKey storage
5037 //
5038 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5039 RequestElement = StrStr (ConfigRequest, L"PATH");
5040 ASSERT (RequestElement != NULL);
5041 RequestElement = StrStr (RequestElement, SearchKey);
5042 } else {
5043 RequestElement = StrStr (ConfigRequest, SearchKey);
5044 }
5045
5046 while (RequestElement != NULL) {
5047 //
5048 // +1 to avoid find header itself.
5049 //
5050 NextRequestElement = StrStr (RequestElement + 1, SearchKey);
5051
5052 //
5053 // The last Request element in configRequest string.
5054 //
5055 if (NextRequestElement != NULL) {
5056 //
5057 // Replace "&" with '\0'.
5058 //
5059 *NextRequestElement = L'\0';
5060 }
5061
5062 RemoveElement (Storage->BrowserStorage, RequestElement);
5063
5064 if (NextRequestElement != NULL) {
5065 //
5066 // Restore '&' with '\0' for later used.
5067 //
5068 *NextRequestElement = L'&';
5069 }
5070
5071 RequestElement = NextRequestElement;
5072 }
5073
5074 //
5075 // If no request element remain, just remove the ConfigRequest string.
5076 //
5077 if (StrCmp (Storage->BrowserStorage->ConfigRequest, Storage->ConfigHdr) == 0) {
5078 FreePool (Storage->BrowserStorage->ConfigRequest);
5079 Storage->BrowserStorage->ConfigRequest = NULL;
5080 Storage->BrowserStorage->SpareStrLen = 0;
5081 }
5082 }
5083
5084 /**
5085 Base on the current formset info, clean the ConfigRequest string in browser storage.
5086
5087 @param FormSet Pointer of the FormSet
5088
5089 **/
5090 VOID
5091 CleanBrowserStorage (
5092 IN OUT FORM_BROWSER_FORMSET *FormSet
5093 )
5094 {
5095 LIST_ENTRY *Link;
5096 FORMSET_STORAGE *Storage;
5097
5098 Link = GetFirstNode (&FormSet->StorageListHead);
5099 while (!IsNull (&FormSet->StorageListHead, Link)) {
5100 Storage = FORMSET_STORAGE_FROM_LINK (Link);
5101 Link = GetNextNode (&FormSet->StorageListHead, Link);
5102
5103 if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
5104 if (Storage->ConfigRequest == NULL || Storage->BrowserStorage->ConfigRequest == NULL) {
5105 continue;
5106 }
5107
5108 RemoveConfigRequest (Storage, Storage->ConfigRequest);
5109 } else if (Storage->BrowserStorage->Type == EFI_HII_VARSTORE_BUFFER ||
5110 Storage->BrowserStorage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5111 if (Storage->BrowserStorage->ConfigRequest != NULL) {
5112 FreePool (Storage->BrowserStorage->ConfigRequest);
5113 Storage->BrowserStorage->ConfigRequest = NULL;
5114 }
5115 Storage->BrowserStorage->Initialized = FALSE;
5116 }
5117 }
5118 }
5119
5120 /**
5121 Check whether current element in the ConfigReqeust string.
5122
5123 @param BrowserStorage Storage which includes ConfigReqeust.
5124 @param RequestElement New element need to check.
5125
5126 @retval TRUE The Element is in the ConfigReqeust string.
5127 @retval FALSE The Element not in the configReqeust String.
5128
5129 **/
5130 BOOLEAN
5131 ElementValidation (
5132 BROWSER_STORAGE *BrowserStorage,
5133 CHAR16 *RequestElement
5134 )
5135 {
5136 return StrStr (BrowserStorage->ConfigRequest, RequestElement) != NULL ? TRUE : FALSE;
5137 }
5138
5139 /**
5140 Append the Request element to the Config Request.
5141
5142 @param ConfigRequest Current ConfigRequest info.
5143 @param SpareStrLen Current remain free buffer for config reqeust.
5144 @param RequestElement New Request element.
5145
5146 **/
5147 VOID
5148 AppendConfigRequest (
5149 IN OUT CHAR16 **ConfigRequest,
5150 IN OUT UINTN *SpareStrLen,
5151 IN CHAR16 *RequestElement
5152 )
5153 {
5154 CHAR16 *NewStr;
5155 UINTN StringSize;
5156 UINTN StrLength;
5157 UINTN MaxLen;
5158
5159 StrLength = StrLen (RequestElement);
5160 StringSize = (*ConfigRequest != NULL) ? StrSize (*ConfigRequest) : sizeof (CHAR16);
5161 MaxLen = StringSize / sizeof (CHAR16) + *SpareStrLen;
5162
5163 //
5164 // Append <RequestElement> to <ConfigRequest>
5165 //
5166 if (StrLength > *SpareStrLen) {
5167 //
5168 // Old String buffer is not sufficient for RequestElement, allocate a new one
5169 //
5170 MaxLen = StringSize / sizeof (CHAR16) + CONFIG_REQUEST_STRING_INCREMENTAL;
5171 NewStr = AllocateZeroPool (MaxLen * sizeof (CHAR16));
5172 ASSERT (NewStr != NULL);
5173
5174 if (*ConfigRequest != NULL) {
5175 CopyMem (NewStr, *ConfigRequest, StringSize);
5176 FreePool (*ConfigRequest);
5177 }
5178 *ConfigRequest = NewStr;
5179 *SpareStrLen = CONFIG_REQUEST_STRING_INCREMENTAL;
5180 }
5181
5182 StrCatS (*ConfigRequest, MaxLen, RequestElement);
5183 *SpareStrLen -= StrLength;
5184 }
5185
5186 /**
5187 Adjust the config request info, remove the request elements which already in AllConfigRequest string.
5188
5189 @param Storage Form set Storage.
5190 @param Request The input request string.
5191 @param RespString Whether the input is ConfigRequest or ConfigResp format.
5192
5193 @retval TRUE Has element not covered by current used elements, need to continue to call ExtractConfig
5194 @retval FALSE All elements covered by current used elements.
5195
5196 **/
5197 BOOLEAN
5198 ConfigRequestAdjust (
5199 IN BROWSER_STORAGE *Storage,
5200 IN CHAR16 *Request,
5201 IN BOOLEAN RespString
5202 )
5203 {
5204 CHAR16 *RequestElement;
5205 CHAR16 *NextRequestElement;
5206 CHAR16 *NextElementBakup;
5207 CHAR16 *SearchKey;
5208 CHAR16 *ValueKey;
5209 BOOLEAN RetVal;
5210 CHAR16 *ConfigRequest;
5211
5212 RetVal = FALSE;
5213 NextElementBakup = NULL;
5214 ValueKey = NULL;
5215
5216 if (Request != NULL) {
5217 ConfigRequest = Request;
5218 } else {
5219 ConfigRequest = Storage->ConfigRequest;
5220 }
5221
5222 if (Storage->ConfigRequest == NULL) {
5223 Storage->ConfigRequest = AllocateCopyPool (StrSize (ConfigRequest), ConfigRequest);
5224 return TRUE;
5225 }
5226
5227 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5228 //
5229 // "&Name1&Name2" section for EFI_HII_VARSTORE_NAME_VALUE storage
5230 //
5231 SearchKey = L"&";
5232 } else {
5233 //
5234 // "&OFFSET=####&WIDTH=####" section for EFI_HII_VARSTORE_BUFFER storage
5235 //
5236 SearchKey = L"&OFFSET";
5237 ValueKey = L"&VALUE";
5238 }
5239
5240 //
5241 // Find SearchKey storage
5242 //
5243 if (Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
5244 RequestElement = StrStr (ConfigRequest, L"PATH");
5245 ASSERT (RequestElement != NULL);
5246 RequestElement = StrStr (RequestElement, SearchKey);
5247 } else {
5248 RequestElement = StrStr (ConfigRequest, SearchKey);
5249 }
5250
5251 while (RequestElement != NULL) {
5252
5253 //
5254 // +1 to avoid find header itself.
5255 //
5256 NextRequestElement = StrStr (RequestElement + 1, SearchKey);
5257
5258 //
5259 // The last Request element in configRequest string.
5260 //
5261 if (NextRequestElement != NULL) {
5262 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5263 NextElementBakup = NextRequestElement;
5264 NextRequestElement = StrStr (RequestElement, ValueKey);
5265 ASSERT (NextRequestElement != NULL);
5266 }
5267 //
5268 // Replace "&" with '\0'.
5269 //
5270 *NextRequestElement = L'\0';
5271 } else {
5272 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5273 NextElementBakup = NextRequestElement;
5274 NextRequestElement = StrStr (RequestElement, ValueKey);
5275 ASSERT (NextRequestElement != NULL);
5276 //
5277 // Replace "&" with '\0'.
5278 //
5279 *NextRequestElement = L'\0';
5280 }
5281 }
5282
5283 if (!ElementValidation (Storage, RequestElement)) {
5284 //
5285 // Add this element to the Storage->BrowserStorage->AllRequestElement.
5286 //
5287 AppendConfigRequest(&Storage->ConfigRequest, &Storage->SpareStrLen, RequestElement);
5288 RetVal = TRUE;
5289 }
5290
5291 if (NextRequestElement != NULL) {
5292 //
5293 // Restore '&' with '\0' for later used.
5294 //
5295 *NextRequestElement = L'&';
5296 }
5297
5298 if (RespString && (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
5299 RequestElement = NextElementBakup;
5300 } else {
5301 RequestElement = NextRequestElement;
5302 }
5303 }
5304
5305 return RetVal;
5306 }
5307
5308 /**
5309 Fill storage's edit copy with settings requested from Configuration Driver.
5310
5311 @param FormSet FormSet data structure.
5312 @param Storage Buffer Storage.
5313
5314 **/
5315 VOID
5316 LoadStorage (
5317 IN FORM_BROWSER_FORMSET *FormSet,
5318 IN FORMSET_STORAGE *Storage
5319 )
5320 {
5321 EFI_STATUS Status;
5322 EFI_STRING Progress;
5323 EFI_STRING Result;
5324 CHAR16 *StrPtr;
5325 EFI_STRING ConfigRequest;
5326 UINTN StrLen;
5327
5328 ConfigRequest = NULL;
5329
5330 switch (Storage->BrowserStorage->Type) {
5331 case EFI_HII_VARSTORE_EFI_VARIABLE:
5332 return;
5333
5334 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
5335 if (Storage->BrowserStorage->ConfigRequest != NULL) {
5336 ConfigRequestAdjust(Storage->BrowserStorage, Storage->ConfigRequest, FALSE);
5337 return;
5338 }
5339 break;
5340
5341 case EFI_HII_VARSTORE_BUFFER:
5342 case EFI_HII_VARSTORE_NAME_VALUE:
5343 //
5344 // Skip if there is no RequestElement.
5345 //
5346 if (Storage->ElementCount == 0) {
5347 return;
5348 }
5349
5350 //
5351 // Just update the ConfigRequest, if storage already initialized.
5352 //
5353 if (Storage->BrowserStorage->Initialized) {
5354 ConfigRequestAdjust(Storage->BrowserStorage, Storage->ConfigRequest, FALSE);
5355 return;
5356 }
5357
5358 Storage->BrowserStorage->Initialized = TRUE;
5359 break;
5360
5361 default:
5362 return;
5363 }
5364
5365 if (Storage->BrowserStorage->Type != EFI_HII_VARSTORE_NAME_VALUE) {
5366 //
5367 // Create the config request string to get all fields for this storage.
5368 // Allocate and fill a buffer large enough to hold the <ConfigHdr> template
5369 // followed by "&OFFSET=0&WIDTH=WWWW"followed by a Null-terminator
5370 //
5371 StrLen = StrSize (Storage->ConfigHdr) + 20 * sizeof (CHAR16);
5372 ConfigRequest = AllocateZeroPool (StrLen);
5373 ASSERT (ConfigRequest != NULL);
5374 UnicodeSPrint (
5375 ConfigRequest,
5376 StrLen,
5377 L"%s&OFFSET=0&WIDTH=%04x",
5378 Storage->ConfigHdr,
5379 Storage->BrowserStorage->Size);
5380 } else {
5381 ConfigRequest = Storage->ConfigRequest;
5382 }
5383
5384 //
5385 // Request current settings from Configuration Driver
5386 //
5387 Status = mHiiConfigRouting->ExtractConfig (
5388 mHiiConfigRouting,
5389 ConfigRequest,
5390 &Progress,
5391 &Result
5392 );
5393
5394 //
5395 // If get value fail, extract default from IFR binary
5396 //
5397 if (EFI_ERROR (Status)) {
5398 ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel, GetDefaultForStorage, Storage->BrowserStorage, TRUE, TRUE);
5399 } else {
5400 //
5401 // Convert Result from <ConfigAltResp> to <ConfigResp>
5402 //
5403 StrPtr = StrStr (Result, L"&GUID=");
5404 if (StrPtr != NULL) {
5405 *StrPtr = L'\0';
5406 }
5407
5408 Status = ConfigRespToStorage (Storage->BrowserStorage, Result);
5409 FreePool (Result);
5410 }
5411
5412 Storage->BrowserStorage->ConfigRequest = AllocateCopyPool (StrSize (Storage->ConfigRequest), Storage->ConfigRequest);
5413
5414 //
5415 // Input NULL for ConfigRequest field means sync all fields from editbuffer to buffer.
5416 //
5417 SynchronizeStorage(Storage->BrowserStorage, NULL, TRUE);
5418
5419 if (Storage->BrowserStorage->Type != EFI_HII_VARSTORE_NAME_VALUE) {
5420 if (ConfigRequest != NULL) {
5421 FreePool (ConfigRequest);
5422 }
5423 }
5424 }
5425
5426 /**
5427 Get Value changed status from old question.
5428
5429 @param NewFormSet FormSet data structure.
5430 @param OldQuestion Old question which has value changed.
5431
5432 **/
5433 VOID
5434 SyncStatusForQuestion (
5435 IN OUT FORM_BROWSER_FORMSET *NewFormSet,
5436 IN FORM_BROWSER_STATEMENT *OldQuestion
5437 )
5438 {
5439 LIST_ENTRY *Link;
5440 LIST_ENTRY *QuestionLink;
5441 FORM_BROWSER_FORM *Form;
5442 FORM_BROWSER_STATEMENT *Question;
5443
5444 //
5445 // For each form in one formset.
5446 //
5447 Link = GetFirstNode (&NewFormSet->FormListHead);
5448 while (!IsNull (&NewFormSet->FormListHead, Link)) {
5449 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
5450 Link = GetNextNode (&NewFormSet->FormListHead, Link);
5451
5452 //
5453 // for each question in one form.
5454 //
5455 QuestionLink = GetFirstNode (&Form->StatementListHead);
5456 while (!IsNull (&Form->StatementListHead, QuestionLink)) {
5457 Question = FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink);
5458 QuestionLink = GetNextNode (&Form->StatementListHead, QuestionLink);
5459
5460 if (Question->QuestionId == OldQuestion->QuestionId) {
5461 Question->ValueChanged = TRUE;
5462 return;
5463 }
5464 }
5465 }
5466 }
5467
5468 /**
5469 Get Value changed status from old formset.
5470
5471 @param NewFormSet FormSet data structure.
5472 @param OldFormSet FormSet data structure.
5473
5474 **/
5475 VOID
5476 SyncStatusForFormSet (
5477 IN OUT FORM_BROWSER_FORMSET *NewFormSet,
5478 IN FORM_BROWSER_FORMSET *OldFormSet
5479 )
5480 {
5481 LIST_ENTRY *Link;
5482 LIST_ENTRY *QuestionLink;
5483 FORM_BROWSER_FORM *Form;
5484 FORM_BROWSER_STATEMENT *Question;
5485
5486 //
5487 // For each form in one formset.
5488 //
5489 Link = GetFirstNode (&OldFormSet->FormListHead);
5490 while (!IsNull (&OldFormSet->FormListHead, Link)) {
5491 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
5492 Link = GetNextNode (&OldFormSet->FormListHead, Link);
5493
5494 //
5495 // for each question in one form.
5496 //
5497 QuestionLink = GetFirstNode (&Form->StatementListHead);
5498 while (!IsNull (&Form->StatementListHead, QuestionLink)) {
5499 Question = FORM_BROWSER_STATEMENT_FROM_LINK (QuestionLink);
5500 QuestionLink = GetNextNode (&Form->StatementListHead, QuestionLink);
5501
5502 if (!Question->ValueChanged) {
5503 continue;
5504 }
5505
5506 //
5507 // Find the same question in new formset and update the value changed flag.
5508 //
5509 SyncStatusForQuestion (NewFormSet, Question);
5510 }
5511 }
5512 }
5513
5514 /**
5515 Get current setting of Questions.
5516
5517 @param FormSet FormSet data structure.
5518
5519 **/
5520 VOID
5521 InitializeCurrentSetting (
5522 IN OUT FORM_BROWSER_FORMSET *FormSet
5523 )
5524 {
5525 LIST_ENTRY *Link;
5526 FORMSET_STORAGE *Storage;
5527 FORM_BROWSER_FORMSET *OldFormSet;
5528
5529 //
5530 // Try to find pre FormSet in the maintain backup list.
5531 // If old formset != NULL, destroy this formset. Add new formset to gBrowserFormSetList.
5532 //
5533 OldFormSet = GetFormSetFromHiiHandle (FormSet->HiiHandle);
5534 if (OldFormSet != NULL) {
5535 SyncStatusForFormSet (FormSet, OldFormSet);
5536 RemoveEntryList (&OldFormSet->Link);
5537 DestroyFormSet (OldFormSet);
5538 }
5539 InsertTailList (&gBrowserFormSetList, &FormSet->Link);
5540
5541 //
5542 // Extract default from IFR binary for no storage questions.
5543 //
5544 ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel, GetDefaultForNoStorage, NULL, TRUE, FALSE);
5545
5546 //
5547 // Request current settings from Configuration Driver
5548 //
5549 Link = GetFirstNode (&FormSet->StorageListHead);
5550 while (!IsNull (&FormSet->StorageListHead, Link)) {
5551 Storage = FORMSET_STORAGE_FROM_LINK (Link);
5552
5553 LoadStorage (FormSet, Storage);
5554
5555 Link = GetNextNode (&FormSet->StorageListHead, Link);
5556 }
5557 }
5558
5559
5560 /**
5561 Fetch the Ifr binary data of a FormSet.
5562
5563 @param Handle PackageList Handle
5564 @param FormSetGuid On input, GUID or class GUID of a formset. If not
5565 specified (NULL or zero GUID), take the first
5566 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
5567 found in package list.
5568 On output, GUID of the formset found(if not NULL).
5569 @param BinaryLength The length of the FormSet IFR binary.
5570 @param BinaryData The buffer designed to receive the FormSet.
5571
5572 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
5573 BufferLength was updated.
5574 @retval EFI_INVALID_PARAMETER The handle is unknown.
5575 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
5576 be found with the requested FormId.
5577
5578 **/
5579 EFI_STATUS
5580 GetIfrBinaryData (
5581 IN EFI_HII_HANDLE Handle,
5582 IN OUT EFI_GUID *FormSetGuid,
5583 OUT UINTN *BinaryLength,
5584 OUT UINT8 **BinaryData
5585 )
5586 {
5587 EFI_STATUS Status;
5588 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;
5589 UINTN BufferSize;
5590 UINT8 *Package;
5591 UINT8 *OpCodeData;
5592 UINT32 Offset;
5593 UINT32 Offset2;
5594 UINT32 PackageListLength;
5595 EFI_HII_PACKAGE_HEADER PackageHeader;
5596 UINT8 Index;
5597 UINT8 NumberOfClassGuid;
5598 BOOLEAN ClassGuidMatch;
5599 EFI_GUID *ClassGuid;
5600 EFI_GUID *ComparingGuid;
5601
5602 OpCodeData = NULL;
5603 Package = NULL;
5604 ZeroMem (&PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));
5605
5606 //
5607 // if FormSetGuid is NULL or zero GUID, return first Setup FormSet in the package list
5608 //
5609 if (FormSetGuid == NULL) {
5610 ComparingGuid = &gZeroGuid;
5611 } else {
5612 ComparingGuid = FormSetGuid;
5613 }
5614
5615 //
5616 // Get HII PackageList
5617 //
5618 BufferSize = 0;
5619 HiiPackageList = NULL;
5620 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
5621 if (Status == EFI_BUFFER_TOO_SMALL) {
5622 HiiPackageList = AllocatePool (BufferSize);
5623 ASSERT (HiiPackageList != NULL);
5624
5625 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
5626 }
5627 if (EFI_ERROR (Status)) {
5628 return Status;
5629 }
5630 ASSERT (HiiPackageList != NULL);
5631
5632 //
5633 // Get Form package from this HII package List
5634 //
5635 Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);
5636 Offset2 = 0;
5637 CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));
5638
5639 ClassGuidMatch = FALSE;
5640 while (Offset < PackageListLength) {
5641 Package = ((UINT8 *) HiiPackageList) + Offset;
5642 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));
5643
5644 if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {
5645 //
5646 // Search FormSet in this Form Package
5647 //
5648 Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);
5649 while (Offset2 < PackageHeader.Length) {
5650 OpCodeData = Package + Offset2;
5651
5652 if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {
5653 //
5654 // Try to compare against formset GUID
5655 //
5656 if (CompareGuid (FormSetGuid, &gZeroGuid) ||
5657 CompareGuid (ComparingGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
5658 break;
5659 }
5660
5661 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
5662 //
5663 // Try to compare against formset class GUID
5664 //
5665 NumberOfClassGuid = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
5666 ClassGuid = (EFI_GUID *) (OpCodeData + sizeof (EFI_IFR_FORM_SET));
5667 for (Index = 0; Index < NumberOfClassGuid; Index++) {
5668 if (CompareGuid (ComparingGuid, ClassGuid + Index)) {
5669 ClassGuidMatch = TRUE;
5670 break;
5671 }
5672 }
5673 if (ClassGuidMatch) {
5674 break;
5675 }
5676 } else if (ComparingGuid == &gEfiHiiPlatformSetupFormsetGuid) {
5677 ClassGuidMatch = TRUE;
5678 break;
5679 }
5680 }
5681
5682 Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
5683 }
5684
5685 if (Offset2 < PackageHeader.Length) {
5686 //
5687 // Target formset found
5688 //
5689 break;
5690 }
5691 }
5692
5693 Offset += PackageHeader.Length;
5694 }
5695
5696 if (Offset >= PackageListLength) {
5697 //
5698 // Form package not found in this Package List
5699 //
5700 FreePool (HiiPackageList);
5701 return EFI_NOT_FOUND;
5702 }
5703
5704 if (FormSetGuid != NULL) {
5705 //
5706 // Return the FormSet GUID
5707 //
5708 CopyMem (FormSetGuid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID));
5709 }
5710
5711 //
5712 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
5713 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
5714 // of the Form Package.
5715 //
5716 *BinaryLength = PackageHeader.Length - Offset2;
5717 *BinaryData = AllocateCopyPool (*BinaryLength, OpCodeData);
5718
5719 FreePool (HiiPackageList);
5720
5721 if (*BinaryData == NULL) {
5722 return EFI_OUT_OF_RESOURCES;
5723 }
5724
5725 return EFI_SUCCESS;
5726 }
5727
5728
5729 /**
5730 Initialize the internal data structure of a FormSet.
5731
5732 @param Handle PackageList Handle
5733 @param FormSetGuid On input, GUID or class GUID of a formset. If not
5734 specified (NULL or zero GUID), take the first
5735 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
5736 found in package list.
5737 On output, GUID of the formset found(if not NULL).
5738 @param FormSet FormSet data structure.
5739
5740 @retval EFI_SUCCESS The function completed successfully.
5741 @retval EFI_NOT_FOUND The specified FormSet could not be found.
5742
5743 **/
5744 EFI_STATUS
5745 InitializeFormSet (
5746 IN EFI_HII_HANDLE Handle,
5747 IN OUT EFI_GUID *FormSetGuid,
5748 OUT FORM_BROWSER_FORMSET *FormSet
5749 )
5750 {
5751 EFI_STATUS Status;
5752 EFI_HANDLE DriverHandle;
5753
5754 Status = GetIfrBinaryData (Handle, FormSetGuid, &FormSet->IfrBinaryLength, &FormSet->IfrBinaryData);
5755 if (EFI_ERROR (Status)) {
5756 return Status;
5757 }
5758
5759 FormSet->Signature = FORM_BROWSER_FORMSET_SIGNATURE;
5760 FormSet->HiiHandle = Handle;
5761 CopyMem (&FormSet->Guid, FormSetGuid, sizeof (EFI_GUID));
5762 FormSet->QuestionInited = FALSE;
5763
5764 //
5765 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
5766 //
5767 Status = mHiiDatabase->GetPackageListHandle (mHiiDatabase, Handle, &DriverHandle);
5768 if (EFI_ERROR (Status)) {
5769 return Status;
5770 }
5771 FormSet->DriverHandle = DriverHandle;
5772 Status = gBS->HandleProtocol (
5773 DriverHandle,
5774 &gEfiHiiConfigAccessProtocolGuid,
5775 (VOID **) &FormSet->ConfigAccess
5776 );
5777 if (EFI_ERROR (Status)) {
5778 //
5779 // Configuration Driver don't attach ConfigAccess protocol to its HII package
5780 // list, then there will be no configuration action required
5781 //
5782 FormSet->ConfigAccess = NULL;
5783 }
5784
5785 //
5786 // Parse the IFR binary OpCodes
5787 //
5788 Status = ParseOpCodes (FormSet);
5789
5790 return Status;
5791 }
5792
5793
5794 /**
5795 Save globals used by previous call to SendForm(). SendForm() may be called from
5796 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
5797 So, save globals of previous call to SendForm() and restore them upon exit.
5798
5799 **/
5800 VOID
5801 SaveBrowserContext (
5802 VOID
5803 )
5804 {
5805 BROWSER_CONTEXT *Context;
5806 FORM_ENTRY_INFO *MenuList;
5807 FORM_BROWSER_FORMSET *FormSet;
5808
5809 gBrowserContextCount++;
5810 if (gBrowserContextCount == 1) {
5811 //
5812 // This is not reentry of SendForm(), no context to save
5813 //
5814 return;
5815 }
5816
5817 Context = AllocatePool (sizeof (BROWSER_CONTEXT));
5818 ASSERT (Context != NULL);
5819
5820 Context->Signature = BROWSER_CONTEXT_SIGNATURE;
5821
5822 //
5823 // Save FormBrowser context
5824 //
5825 Context->Selection = gCurrentSelection;
5826 Context->ResetRequired = gResetRequired;
5827 Context->FlagReconnect = gFlagReconnect;
5828 Context->CallbackReconnect = gCallbackReconnect;
5829 Context->ExitRequired = gExitRequired;
5830 Context->HiiHandle = mCurrentHiiHandle;
5831 Context->FormId = mCurrentFormId;
5832 CopyGuid (&Context->FormSetGuid, &mCurrentFormSetGuid);
5833 Context->SystemLevelFormSet = mSystemLevelFormSet;
5834 Context->CurFakeQestId = mCurFakeQestId;
5835 Context->HiiPackageListUpdated = mHiiPackageListUpdated;
5836 Context->FinishRetrieveCall = mFinishRetrieveCall;
5837
5838 //
5839 // Save the menu history data.
5840 //
5841 InitializeListHead(&Context->FormHistoryList);
5842 while (!IsListEmpty (&mPrivateData.FormBrowserEx2.FormViewHistoryHead)) {
5843 MenuList = FORM_ENTRY_INFO_FROM_LINK (mPrivateData.FormBrowserEx2.FormViewHistoryHead.ForwardLink);
5844 RemoveEntryList (&MenuList->Link);
5845
5846 InsertTailList(&Context->FormHistoryList, &MenuList->Link);
5847 }
5848
5849 //
5850 // Save formset list.
5851 //
5852 InitializeListHead(&Context->FormSetList);
5853 while (!IsListEmpty (&gBrowserFormSetList)) {
5854 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (gBrowserFormSetList.ForwardLink);
5855 RemoveEntryList (&FormSet->Link);
5856
5857 InsertTailList(&Context->FormSetList, &FormSet->Link);
5858 }
5859
5860 //
5861 // Insert to FormBrowser context list
5862 //
5863 InsertHeadList (&gBrowserContextList, &Context->Link);
5864 }
5865
5866
5867 /**
5868 Restore globals used by previous call to SendForm().
5869
5870 **/
5871 VOID
5872 RestoreBrowserContext (
5873 VOID
5874 )
5875 {
5876 LIST_ENTRY *Link;
5877 BROWSER_CONTEXT *Context;
5878 FORM_ENTRY_INFO *MenuList;
5879 FORM_BROWSER_FORMSET *FormSet;
5880
5881 ASSERT (gBrowserContextCount != 0);
5882 gBrowserContextCount--;
5883 if (gBrowserContextCount == 0) {
5884 //
5885 // This is not reentry of SendForm(), no context to restore
5886 //
5887 return;
5888 }
5889
5890 ASSERT (!IsListEmpty (&gBrowserContextList));
5891
5892 Link = GetFirstNode (&gBrowserContextList);
5893 Context = BROWSER_CONTEXT_FROM_LINK (Link);
5894
5895 //
5896 // Restore FormBrowser context
5897 //
5898 gCurrentSelection = Context->Selection;
5899 gResetRequired = Context->ResetRequired;
5900 gFlagReconnect = Context->FlagReconnect;
5901 gCallbackReconnect = Context->CallbackReconnect;
5902 gExitRequired = Context->ExitRequired;
5903 mCurrentHiiHandle = Context->HiiHandle;
5904 mCurrentFormId = Context->FormId;
5905 CopyGuid (&mCurrentFormSetGuid, &Context->FormSetGuid);
5906 mSystemLevelFormSet = Context->SystemLevelFormSet;
5907 mCurFakeQestId = Context->CurFakeQestId;
5908 mHiiPackageListUpdated = Context->HiiPackageListUpdated;
5909 mFinishRetrieveCall = Context->FinishRetrieveCall;
5910
5911 //
5912 // Restore the menu history data.
5913 //
5914 while (!IsListEmpty (&Context->FormHistoryList)) {
5915 MenuList = FORM_ENTRY_INFO_FROM_LINK (Context->FormHistoryList.ForwardLink);
5916 RemoveEntryList (&MenuList->Link);
5917
5918 InsertTailList(&mPrivateData.FormBrowserEx2.FormViewHistoryHead, &MenuList->Link);
5919 }
5920
5921 //
5922 // Restore the Formset data.
5923 //
5924 while (!IsListEmpty (&Context->FormSetList)) {
5925 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Context->FormSetList.ForwardLink);
5926 RemoveEntryList (&FormSet->Link);
5927
5928 InsertTailList(&gBrowserFormSetList, &FormSet->Link);
5929 }
5930
5931 //
5932 // Remove from FormBrowser context list
5933 //
5934 RemoveEntryList (&Context->Link);
5935 gBS->FreePool (Context);
5936 }
5937
5938 /**
5939 Find the matched FormSet context in the backup maintain list based on HiiHandle.
5940
5941 @param Handle The Hii Handle.
5942
5943 @return the found FormSet context. If no found, NULL will return.
5944
5945 **/
5946 FORM_BROWSER_FORMSET *
5947 GetFormSetFromHiiHandle (
5948 EFI_HII_HANDLE Handle
5949 )
5950 {
5951 LIST_ENTRY *Link;
5952 FORM_BROWSER_FORMSET *FormSet;
5953
5954 Link = GetFirstNode (&gBrowserFormSetList);
5955 while (!IsNull (&gBrowserFormSetList, Link)) {
5956 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
5957 Link = GetNextNode (&gBrowserFormSetList, Link);
5958 if (!ValidateFormSet(FormSet)) {
5959 continue;
5960 }
5961 if (FormSet->HiiHandle == Handle) {
5962 return FormSet;
5963 }
5964 }
5965
5966 return NULL;
5967 }
5968
5969 /**
5970 Check whether the input HII handle is the FormSet that is being used.
5971
5972 @param Handle The Hii Handle.
5973
5974 @retval TRUE HII handle is being used.
5975 @retval FALSE HII handle is not being used.
5976
5977 **/
5978 BOOLEAN
5979 IsHiiHandleInBrowserContext (
5980 EFI_HII_HANDLE Handle
5981 )
5982 {
5983 LIST_ENTRY *Link;
5984 BROWSER_CONTEXT *Context;
5985
5986 //
5987 // HiiHandle is Current FormSet.
5988 //
5989 if (mCurrentHiiHandle == Handle) {
5990 return TRUE;
5991 }
5992
5993 //
5994 // Check whether HiiHandle is in BrowserContext.
5995 //
5996 Link = GetFirstNode (&gBrowserContextList);
5997 while (!IsNull (&gBrowserContextList, Link)) {
5998 Context = BROWSER_CONTEXT_FROM_LINK (Link);
5999 if (Context->HiiHandle == Handle) {
6000 //
6001 // HiiHandle is in BrowserContext
6002 //
6003 return TRUE;
6004 }
6005 Link = GetNextNode (&gBrowserContextList, Link);
6006 }
6007
6008 return FALSE;
6009 }
6010
6011 /**
6012 Perform Password check.
6013 Passwork may be encrypted by driver that requires the specific check.
6014
6015 @param Form Form where Password Statement is in.
6016 @param Statement Password statement
6017 @param PasswordString Password string to be checked. It may be NULL.
6018 NULL means to restore password.
6019 "" string can be used to checked whether old password does exist.
6020
6021 @return Status Status of Password check.
6022 **/
6023 EFI_STATUS
6024 EFIAPI
6025 PasswordCheck (
6026 IN FORM_DISPLAY_ENGINE_FORM *Form,
6027 IN FORM_DISPLAY_ENGINE_STATEMENT *Statement,
6028 IN EFI_STRING PasswordString OPTIONAL
6029 )
6030 {
6031 EFI_STATUS Status;
6032 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
6033 EFI_BROWSER_ACTION_REQUEST ActionRequest;
6034 EFI_IFR_TYPE_VALUE IfrTypeValue;
6035 FORM_BROWSER_STATEMENT *Question;
6036
6037 ConfigAccess = gCurrentSelection->FormSet->ConfigAccess;
6038 Question = GetBrowserStatement(Statement);
6039 ASSERT (Question != NULL);
6040
6041 if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK) {
6042 if (ConfigAccess == NULL) {
6043 return EFI_UNSUPPORTED;
6044 }
6045 } else {
6046 if (PasswordString == NULL) {
6047 return EFI_SUCCESS;
6048 }
6049
6050 //
6051 // Check whether has preexisted password.
6052 //
6053 if (PasswordString[0] == 0) {
6054 if (*((CHAR16 *) Question->BufferValue) == 0) {
6055 return EFI_SUCCESS;
6056 } else {
6057 return EFI_NOT_READY;
6058 }
6059 }
6060
6061 //
6062 // Check whether the input password is same as preexisted password.
6063 //
6064 if (StrnCmp (PasswordString, (CHAR16 *) Question->BufferValue, Question->StorageWidth/sizeof (CHAR16)) == 0) {
6065 return EFI_SUCCESS;
6066 } else {
6067 return EFI_NOT_READY;
6068 }
6069 }
6070
6071 //
6072 // Prepare password string in HII database
6073 //
6074 if (PasswordString != NULL) {
6075 IfrTypeValue.string = NewString (PasswordString, gCurrentSelection->FormSet->HiiHandle);
6076 } else {
6077 IfrTypeValue.string = 0;
6078 }
6079
6080 //
6081 // Send password to Configuration Driver for validation
6082 //
6083 Status = ConfigAccess->Callback (
6084 ConfigAccess,
6085 EFI_BROWSER_ACTION_CHANGING,
6086 Question->QuestionId,
6087 Question->HiiValue.Type,
6088 &IfrTypeValue,
6089 &ActionRequest
6090 );
6091
6092 //
6093 // Remove password string from HII database
6094 //
6095 if (PasswordString != NULL) {
6096 DeleteString (IfrTypeValue.string, gCurrentSelection->FormSet->HiiHandle);
6097 }
6098
6099 return Status;
6100 }
6101
6102 /**
6103 Find the registered HotKey based on KeyData.
6104
6105 @param[in] KeyData A pointer to a buffer that describes the keystroke
6106 information for the hot key.
6107
6108 @return The registered HotKey context. If no found, NULL will return.
6109 **/
6110 BROWSER_HOT_KEY *
6111 GetHotKeyFromRegisterList (
6112 IN EFI_INPUT_KEY *KeyData
6113 )
6114 {
6115 LIST_ENTRY *Link;
6116 BROWSER_HOT_KEY *HotKey;
6117
6118 Link = GetFirstNode (&gBrowserHotKeyList);
6119 while (!IsNull (&gBrowserHotKeyList, Link)) {
6120 HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);
6121 if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {
6122 return HotKey;
6123 }
6124 Link = GetNextNode (&gBrowserHotKeyList, Link);
6125 }
6126
6127 return NULL;
6128 }
6129
6130 /**
6131 Configure what scope the hot key will impact.
6132 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
6133 If no scope is set, the default scope will be FormSet level.
6134 After all registered hot keys are removed, previous Scope can reset to another level.
6135
6136 @param[in] Scope Scope level to be set.
6137
6138 @retval EFI_SUCCESS Scope is set correctly.
6139 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
6140 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
6141
6142 **/
6143 EFI_STATUS
6144 EFIAPI
6145 SetScope (
6146 IN BROWSER_SETTING_SCOPE Scope
6147 )
6148 {
6149 if (Scope >= MaxLevel) {
6150 return EFI_INVALID_PARAMETER;
6151 }
6152
6153 //
6154 // When no hot key registered in system or on the first setting,
6155 // Scope can be set.
6156 //
6157 if (mBrowserScopeFirstSet || IsListEmpty (&gBrowserHotKeyList)) {
6158 gBrowserSettingScope = Scope;
6159 mBrowserScopeFirstSet = FALSE;
6160 } else if (Scope != gBrowserSettingScope) {
6161 return EFI_UNSUPPORTED;
6162 }
6163
6164 return EFI_SUCCESS;
6165 }
6166
6167 /**
6168 Register the hot key with its browser action, or unregistered the hot key.
6169 Only support hot key that is not printable character (control key, function key, etc.).
6170 If the action value is zero, the hot key will be unregistered if it has been registered.
6171 If the same hot key has been registered, the new action and help string will override the previous ones.
6172
6173 @param[in] KeyData A pointer to a buffer that describes the keystroke
6174 information for the hot key. Its type is EFI_INPUT_KEY to
6175 be supported by all ConsoleIn devices.
6176 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
6177 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
6178 @param[in] HelpString Help string that describes the hot key information.
6179 Its value may be NULL for the unregistered hot key.
6180
6181 @retval EFI_SUCCESS Hot key is registered or unregistered.
6182 @retval EFI_INVALID_PARAMETER KeyData is NULL or HelpString is NULL on register.
6183 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
6184 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
6185 @retval EFI_ALREADY_STARTED Key already been registered for one hot key.
6186 **/
6187 EFI_STATUS
6188 EFIAPI
6189 RegisterHotKey (
6190 IN EFI_INPUT_KEY *KeyData,
6191 IN UINT32 Action,
6192 IN UINT16 DefaultId,
6193 IN EFI_STRING HelpString OPTIONAL
6194 )
6195 {
6196 BROWSER_HOT_KEY *HotKey;
6197
6198 //
6199 // Check input parameters.
6200 //
6201 if (KeyData == NULL || KeyData->UnicodeChar != CHAR_NULL ||
6202 (Action != BROWSER_ACTION_UNREGISTER && HelpString == NULL)) {
6203 return EFI_INVALID_PARAMETER;
6204 }
6205
6206 //
6207 // Check whether the input KeyData is in BrowserHotKeyList.
6208 //
6209 HotKey = GetHotKeyFromRegisterList (KeyData);
6210
6211 //
6212 // Unregister HotKey
6213 //
6214 if (Action == BROWSER_ACTION_UNREGISTER) {
6215 if (HotKey != NULL) {
6216 //
6217 // The registered HotKey is found.
6218 // Remove it from List, and free its resource.
6219 //
6220 RemoveEntryList (&HotKey->Link);
6221 FreePool (HotKey->KeyData);
6222 FreePool (HotKey->HelpString);
6223 return EFI_SUCCESS;
6224 } else {
6225 //
6226 // The registered HotKey is not found.
6227 //
6228 return EFI_NOT_FOUND;
6229 }
6230 }
6231
6232 if (HotKey != NULL) {
6233 return EFI_ALREADY_STARTED;
6234 }
6235
6236 //
6237 // Create new Key, and add it into List.
6238 //
6239 HotKey = AllocateZeroPool (sizeof (BROWSER_HOT_KEY));
6240 ASSERT (HotKey != NULL);
6241 HotKey->Signature = BROWSER_HOT_KEY_SIGNATURE;
6242 HotKey->KeyData = AllocateCopyPool (sizeof (EFI_INPUT_KEY), KeyData);
6243 InsertTailList (&gBrowserHotKeyList, &HotKey->Link);
6244
6245 //
6246 // Fill HotKey information.
6247 //
6248 HotKey->Action = Action;
6249 HotKey->DefaultId = DefaultId;
6250 if (HotKey->HelpString != NULL) {
6251 FreePool (HotKey->HelpString);
6252 }
6253 HotKey->HelpString = AllocateCopyPool (StrSize (HelpString), HelpString);
6254
6255 return EFI_SUCCESS;
6256 }
6257
6258 /**
6259 Register Exit handler function.
6260 When more than one handler function is registered, the latter one will override the previous one.
6261 When NULL handler is specified, the previous Exit handler will be unregistered.
6262
6263 @param[in] Handler Pointer to handler function.
6264
6265 **/
6266 VOID
6267 EFIAPI
6268 RegiserExitHandler (
6269 IN EXIT_HANDLER Handler
6270 )
6271 {
6272 ExitHandlerFunction = Handler;
6273 return;
6274 }
6275
6276 /**
6277 Check whether the browser data has been modified.
6278
6279 @retval TRUE Browser data is modified.
6280 @retval FALSE No browser data is modified.
6281
6282 **/
6283 BOOLEAN
6284 EFIAPI
6285 IsBrowserDataModified (
6286 VOID
6287 )
6288 {
6289 LIST_ENTRY *Link;
6290 FORM_BROWSER_FORMSET *FormSet;
6291
6292 switch (gBrowserSettingScope) {
6293 case FormLevel:
6294 if (gCurrentSelection == NULL) {
6295 return FALSE;
6296 }
6297 return IsNvUpdateRequiredForForm (gCurrentSelection->Form);
6298
6299 case FormSetLevel:
6300 if (gCurrentSelection == NULL) {
6301 return FALSE;
6302 }
6303 return IsNvUpdateRequiredForFormSet (gCurrentSelection->FormSet);
6304
6305 case SystemLevel:
6306 Link = GetFirstNode (&gBrowserFormSetList);
6307 while (!IsNull (&gBrowserFormSetList, Link)) {
6308 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
6309 if (!ValidateFormSet(FormSet)) {
6310 continue;
6311 }
6312
6313 if (IsNvUpdateRequiredForFormSet (FormSet)) {
6314 return TRUE;
6315 }
6316 Link = GetNextNode (&gBrowserFormSetList, Link);
6317 }
6318 return FALSE;
6319
6320 default:
6321 return FALSE;
6322 }
6323 }
6324
6325 /**
6326 Execute the action requested by the Action parameter.
6327
6328 @param[in] Action Execute the request action.
6329 @param[in] DefaultId The default Id info when need to load default value. Only used when Action is BROWSER_ACTION_DEFAULT.
6330
6331 @retval EFI_SUCCESS Execute the request action succss.
6332 @retval EFI_INVALID_PARAMETER The input action value is invalid.
6333
6334 **/
6335 EFI_STATUS
6336 EFIAPI
6337 ExecuteAction (
6338 IN UINT32 Action,
6339 IN UINT16 DefaultId
6340 )
6341 {
6342 EFI_STATUS Status;
6343 FORM_BROWSER_FORMSET *FormSet;
6344 FORM_BROWSER_FORM *Form;
6345
6346 if (gBrowserSettingScope < SystemLevel && gCurrentSelection == NULL) {
6347 return EFI_NOT_READY;
6348 }
6349
6350 Status = EFI_SUCCESS;
6351 FormSet = NULL;
6352 Form = NULL;
6353 if (gBrowserSettingScope < SystemLevel) {
6354 FormSet = gCurrentSelection->FormSet;
6355 Form = gCurrentSelection->Form;
6356 }
6357
6358 //
6359 // Executet the discard action.
6360 //
6361 if ((Action & BROWSER_ACTION_DISCARD) != 0) {
6362 Status = DiscardForm (FormSet, Form, gBrowserSettingScope);
6363 if (EFI_ERROR (Status)) {
6364 return Status;
6365 }
6366 }
6367
6368 //
6369 // Executet the difault action.
6370 //
6371 if ((Action & BROWSER_ACTION_DEFAULT) != 0) {
6372 Status = ExtractDefault (FormSet, Form, DefaultId, gBrowserSettingScope, GetDefaultForAll, NULL, FALSE, FALSE);
6373 if (EFI_ERROR (Status)) {
6374 return Status;
6375 }
6376 UpdateStatementStatus (FormSet, Form, gBrowserSettingScope);
6377 }
6378
6379 //
6380 // Executet the submit action.
6381 //
6382 if ((Action & BROWSER_ACTION_SUBMIT) != 0) {
6383 Status = SubmitForm (FormSet, Form, gBrowserSettingScope);
6384 if (EFI_ERROR (Status)) {
6385 return Status;
6386 }
6387 }
6388
6389 //
6390 // Executet the reset action.
6391 //
6392 if ((Action & BROWSER_ACTION_RESET) != 0) {
6393 gResetRequired = TRUE;
6394 }
6395
6396 //
6397 // Executet the exit action.
6398 //
6399 if ((Action & BROWSER_ACTION_EXIT) != 0) {
6400 DiscardForm (FormSet, Form, gBrowserSettingScope);
6401 if (gBrowserSettingScope == SystemLevel) {
6402 if (ExitHandlerFunction != NULL) {
6403 ExitHandlerFunction ();
6404 }
6405 }
6406
6407 gExitRequired = TRUE;
6408 }
6409
6410 return Status;
6411 }
6412
6413 /**
6414 Create reminder to let user to choose save or discard the changed browser data.
6415 Caller can use it to actively check the changed browser data.
6416
6417 @retval BROWSER_NO_CHANGES No browser data is changed.
6418 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
6419 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
6420 @retval BROWSER_KEEP_CURRENT Browser keep current changes.
6421
6422 **/
6423 UINT32
6424 EFIAPI
6425 SaveReminder (
6426 VOID
6427 )
6428 {
6429 LIST_ENTRY *Link;
6430 FORM_BROWSER_FORMSET *FormSet;
6431 BOOLEAN IsDataChanged;
6432 UINT32 DataSavedAction;
6433 UINT32 ConfirmRet;
6434
6435 DataSavedAction = BROWSER_NO_CHANGES;
6436 IsDataChanged = FALSE;
6437 Link = GetFirstNode (&gBrowserFormSetList);
6438 while (!IsNull (&gBrowserFormSetList, Link)) {
6439 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
6440 Link = GetNextNode (&gBrowserFormSetList, Link);
6441 if (!ValidateFormSet(FormSet)) {
6442 continue;
6443 }
6444 if (IsNvUpdateRequiredForFormSet (FormSet)) {
6445 IsDataChanged = TRUE;
6446 break;
6447 }
6448 }
6449
6450 //
6451 // No data is changed. No save is required.
6452 //
6453 if (!IsDataChanged) {
6454 return DataSavedAction;
6455 }
6456
6457 //
6458 // If data is changed, prompt user to save or discard it.
6459 //
6460 do {
6461 ConfirmRet = (UINT32) mFormDisplay->ConfirmDataChange();
6462
6463 if (ConfirmRet == BROWSER_ACTION_SUBMIT) {
6464 SubmitForm (NULL, NULL, SystemLevel);
6465 DataSavedAction = BROWSER_SAVE_CHANGES;
6466 break;
6467 } else if (ConfirmRet == BROWSER_ACTION_DISCARD) {
6468 DiscardForm (NULL, NULL, SystemLevel);
6469 DataSavedAction = BROWSER_DISCARD_CHANGES;
6470 break;
6471 } else if (ConfirmRet == BROWSER_ACTION_NONE) {
6472 DataSavedAction = BROWSER_KEEP_CURRENT;
6473 break;
6474 }
6475 } while (1);
6476
6477 return DataSavedAction;
6478 }
6479
6480 /**
6481 Check whether the Reset Required for the browser
6482
6483 @retval TRUE Browser required to reset after exit.
6484 @retval FALSE Browser not need to reset after exit.
6485
6486 **/
6487 BOOLEAN
6488 EFIAPI
6489 IsResetRequired (
6490 VOID
6491 )
6492 {
6493 return gResetRequired;
6494 }
6495
EFI Development Kit II mirror for PVE