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