]> 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
Add code check to avoid access violation.
[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / Setup.c
1 /** @file
2 Entry and initialization module for the browser.
3
4 Copyright (c) 2007 - 2012, 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
32 EFI_HII_DATABASE_PROTOCOL *mHiiDatabase;
33 EFI_HII_STRING_PROTOCOL *mHiiString;
34 EFI_HII_CONFIG_ROUTING_PROTOCOL *mHiiConfigRouting;
35
36 UINTN gBrowserContextCount = 0;
37 LIST_ENTRY gBrowserContextList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserContextList);
38 LIST_ENTRY gBrowserFormSetList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserFormSetList);
39 LIST_ENTRY gBrowserHotKeyList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserHotKeyList);
40
41 BANNER_DATA *gBannerData;
42 EFI_HII_HANDLE gFrontPageHandle;
43 UINTN gClassOfVfr;
44 UINTN gFunctionKeySetting;
45 BOOLEAN gResetRequired;
46 EFI_HII_HANDLE gHiiHandle;
47 UINT16 gDirection;
48 EFI_SCREEN_DESCRIPTOR gScreenDimensions;
49 BROWSER_SETTING_SCOPE gBrowserSettingScope = FormSetLevel;
50 BOOLEAN mBrowserScopeFirstSet = TRUE;
51 EXIT_HANDLER ExitHandlerFunction = NULL;
52 UINTN gFooterHeight;
53
54 //
55 // Browser Global Strings
56 //
57 CHAR16 *gSaveFailed;
58 CHAR16 *gDiscardFailed;
59 CHAR16 *gDefaultFailed;
60 CHAR16 *gEnterString;
61 CHAR16 *gEnterCommitString;
62 CHAR16 *gEnterEscapeString;
63 CHAR16 *gEscapeString;
64 CHAR16 *gMoveHighlight;
65 CHAR16 *gMakeSelection;
66 CHAR16 *gDecNumericInput;
67 CHAR16 *gHexNumericInput;
68 CHAR16 *gToggleCheckBox;
69 CHAR16 *gPromptForData;
70 CHAR16 *gPromptForPassword;
71 CHAR16 *gPromptForNewPassword;
72 CHAR16 *gConfirmPassword;
73 CHAR16 *gConfirmError;
74 CHAR16 *gPassowordInvalid;
75 CHAR16 *gPressEnter;
76 CHAR16 *gEmptyString;
77 CHAR16 *gAreYouSure;
78 CHAR16 *gYesResponse;
79 CHAR16 *gNoResponse;
80 CHAR16 *gMiniString;
81 CHAR16 *gPlusString;
82 CHAR16 *gMinusString;
83 CHAR16 *gAdjustNumber;
84 CHAR16 *gSaveChanges;
85 CHAR16 *gOptionMismatch;
86 CHAR16 *gFormSuppress;
87
88 CHAR16 *mUnknownString = L"!";
89
90 CHAR16 gPromptBlockWidth;
91 CHAR16 gOptionBlockWidth;
92 CHAR16 gHelpBlockWidth;
93
94 EFI_GUID gZeroGuid = {0, 0, 0, {0, 0, 0, 0, 0, 0, 0, 0}};
95 EFI_GUID gSetupBrowserGuid = {
96 0xab368524, 0xb60c, 0x495b, {0xa0, 0x9, 0x12, 0xe8, 0x5b, 0x1a, 0xea, 0x32}
97 };
98
99 FORM_BROWSER_FORMSET *gOldFormSet = NULL;
100
101 FUNCTIION_KEY_SETTING gFunctionKeySettingTable[] = {
102 //
103 // Boot Manager
104 //
105 {
106 {
107 0x847bc3fe,
108 0xb974,
109 0x446d,
110 {
111 0x94,
112 0x49,
113 0x5a,
114 0xd5,
115 0x41,
116 0x2e,
117 0x99,
118 0x3b
119 }
120 },
121 NONE_FUNCTION_KEY_SETTING
122 },
123 //
124 // Device Manager
125 //
126 {
127 {
128 0x3ebfa8e6,
129 0x511d,
130 0x4b5b,
131 {
132 0xa9,
133 0x5f,
134 0xfb,
135 0x38,
136 0x26,
137 0xf,
138 0x1c,
139 0x27
140 }
141 },
142 NONE_FUNCTION_KEY_SETTING
143 },
144 //
145 // BMM FormSet.
146 //
147 {
148 {
149 0x642237c7,
150 0x35d4,
151 0x472d,
152 {
153 0x83,
154 0x65,
155 0x12,
156 0xe0,
157 0xcc,
158 0xf2,
159 0x7a,
160 0x22
161 }
162 },
163 NONE_FUNCTION_KEY_SETTING
164 },
165 //
166 // BMM File Explorer FormSet.
167 //
168 {
169 {
170 0x1f2d63e1,
171 0xfebd,
172 0x4dc7,
173 {
174 0x9c,
175 0xc5,
176 0xba,
177 0x2b,
178 0x1c,
179 0xef,
180 0x9c,
181 0x5b
182 }
183 },
184 NONE_FUNCTION_KEY_SETTING
185 },
186 };
187
188 /**
189 This is the routine which an external caller uses to direct the browser
190 where to obtain it's information.
191
192
193 @param This The Form Browser protocol instanse.
194 @param Handles A pointer to an array of Handles. If HandleCount > 1 we
195 display a list of the formsets for the handles specified.
196 @param HandleCount The number of Handles specified in Handle.
197 @param FormSetGuid This field points to the EFI_GUID which must match the Guid
198 field in the EFI_IFR_FORM_SET op-code for the specified
199 forms-based package. If FormSetGuid is NULL, then this
200 function will display the first found forms package.
201 @param FormId This field specifies which EFI_IFR_FORM to render as the first
202 displayable page. If this field has a value of 0x0000, then
203 the forms browser will render the specified forms in their encoded order.
204 @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in
205 characters.
206 @param ActionRequest Points to the action recommended by the form.
207
208 @retval EFI_SUCCESS The function completed successfully.
209 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
210 @retval EFI_NOT_FOUND No valid forms could be found to display.
211
212 **/
213 EFI_STATUS
214 EFIAPI
215 SendForm (
216 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
217 IN EFI_HII_HANDLE *Handles,
218 IN UINTN HandleCount,
219 IN EFI_GUID *FormSetGuid, OPTIONAL
220 IN UINT16 FormId, OPTIONAL
221 IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
222 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL
223 )
224 {
225 EFI_STATUS Status;
226 UI_MENU_SELECTION *Selection;
227 UINTN Index;
228 FORM_BROWSER_FORMSET *FormSet;
229 LIST_ENTRY *Link;
230
231 //
232 // Calculate total number of Register HotKeys.
233 //
234 Index = 0;
235 Link = GetFirstNode (&gBrowserHotKeyList);
236 while (!IsNull (&gBrowserHotKeyList, Link)) {
237 Link = GetNextNode (&gBrowserHotKeyList, Link);
238 Index ++;
239 }
240 //
241 // Show three HotKeys help information on one ROW.
242 //
243 gFooterHeight = FOOTER_HEIGHT + (Index / 3);
244
245 //
246 // Save globals used by SendForm()
247 //
248 SaveBrowserContext ();
249
250 gResetRequired = FALSE;
251 Status = EFI_SUCCESS;
252 ZeroMem (&gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
253
254 //
255 // Seed the dimensions in the global
256 //
257 gST->ConOut->QueryMode (
258 gST->ConOut,
259 gST->ConOut->Mode->Mode,
260 &gScreenDimensions.RightColumn,
261 &gScreenDimensions.BottomRow
262 );
263
264 if (ScreenDimensions != NULL) {
265 //
266 // Check local dimension vs. global dimension.
267 //
268 if ((gScreenDimensions.RightColumn < ScreenDimensions->RightColumn) ||
269 (gScreenDimensions.BottomRow < ScreenDimensions->BottomRow)
270 ) {
271 Status = EFI_INVALID_PARAMETER;
272 goto Done;
273 } else {
274 //
275 // Local dimension validation.
276 //
277 if ((ScreenDimensions->RightColumn > ScreenDimensions->LeftColumn) &&
278 (ScreenDimensions->BottomRow > ScreenDimensions->TopRow) &&
279 ((ScreenDimensions->RightColumn - ScreenDimensions->LeftColumn) > 2) &&
280 (
281 (ScreenDimensions->BottomRow - ScreenDimensions->TopRow) > STATUS_BAR_HEIGHT +
282 SCROLL_ARROW_HEIGHT *
283 2 +
284 FRONT_PAGE_HEADER_HEIGHT +
285 gFooterHeight +
286 1
287 )
288 ) {
289 CopyMem (&gScreenDimensions, (VOID *) ScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));
290 } else {
291 Status = EFI_INVALID_PARAMETER;
292 goto Done;
293 }
294 }
295 }
296
297 gOptionBlockWidth = (CHAR16) ((gScreenDimensions.RightColumn - gScreenDimensions.LeftColumn) / 3);
298 gPromptBlockWidth = (CHAR16) (gOptionBlockWidth + LEFT_SKIPPED_COLUMNS);
299 gHelpBlockWidth = (CHAR16) (gOptionBlockWidth - LEFT_SKIPPED_COLUMNS);
300
301 //
302 // Initialize the strings for the browser, upon exit of the browser, the strings will be freed
303 //
304 InitializeBrowserStrings ();
305
306 gFunctionKeySetting = ENABLE_FUNCTION_KEY_SETTING;
307
308 //
309 // Ensure we are in Text mode
310 //
311 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
312
313 for (Index = 0; Index < HandleCount; Index++) {
314 Selection = AllocateZeroPool (sizeof (UI_MENU_SELECTION));
315 ASSERT (Selection != NULL);
316
317 Selection->Handle = Handles[Index];
318 if (FormSetGuid != NULL) {
319 CopyMem (&Selection->FormSetGuid, FormSetGuid, sizeof (EFI_GUID));
320 Selection->FormId = FormId;
321 } else {
322 CopyMem (&Selection->FormSetGuid, &gEfiHiiPlatformSetupFormsetGuid, sizeof (EFI_GUID));
323 }
324
325 do {
326 FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
327 ASSERT (FormSet != NULL);
328
329 //
330 // Initialize internal data structures of FormSet
331 //
332 Status = InitializeFormSet (Selection->Handle, &Selection->FormSetGuid, FormSet, TRUE);
333 if (EFI_ERROR (Status) || IsListEmpty (&FormSet->FormListHead)) {
334 DestroyFormSet (FormSet);
335 break;
336 }
337 Selection->FormSet = FormSet;
338
339 //
340 // Try to find pre FormSet in the maintain backup list.
341 //
342 gOldFormSet = GetFormSetFromHiiHandle (Selection->Handle);
343
344 //
345 // Display this formset
346 //
347 gCurrentSelection = Selection;
348
349 Status = SetupBrowser (Selection);
350
351 gCurrentSelection = NULL;
352
353 if (EFI_ERROR (Status)) {
354 break;
355 }
356
357 } while (Selection->Action == UI_ACTION_REFRESH_FORMSET);
358
359 if (gOldFormSet != NULL) {
360 //
361 // If no data is changed, don't need to save current FormSet into the maintain list.
362 //
363 if (!IsNvUpdateRequired (gOldFormSet)) {
364 RemoveEntryList (&gOldFormSet->Link);
365 DestroyFormSet (gOldFormSet);
366 }
367 gOldFormSet = NULL;
368 }
369
370 FreePool (Selection);
371 }
372
373 if (ActionRequest != NULL) {
374 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
375 if (gResetRequired) {
376 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_RESET;
377 }
378 }
379
380 FreeBrowserStrings ();
381
382 gST->ConOut->SetAttribute (gST->ConOut, EFI_TEXT_ATTR (EFI_LIGHTGRAY, EFI_BLACK));
383 gST->ConOut->ClearScreen (gST->ConOut);
384
385 Done:
386 //
387 // Restore globals used by SendForm()
388 //
389 RestoreBrowserContext ();
390
391 return Status;
392 }
393
394
395 /**
396 This function is called by a callback handler to retrieve uncommitted state
397 data from the browser.
398
399 @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL
400 instance.
401 @param ResultsDataSize A pointer to the size of the buffer associated
402 with ResultsData.
403 @param ResultsData A string returned from an IFR browser or
404 equivalent. The results string will have no
405 routing information in them.
406 @param RetrieveData A BOOLEAN field which allows an agent to retrieve
407 (if RetrieveData = TRUE) data from the uncommitted
408 browser state information or set (if RetrieveData
409 = FALSE) data in the uncommitted browser state
410 information.
411 @param VariableGuid An optional field to indicate the target variable
412 GUID name to use.
413 @param VariableName An optional field to indicate the target
414 human-readable variable name.
415
416 @retval EFI_SUCCESS The results have been distributed or are awaiting
417 distribution.
418 @retval EFI_BUFFER_TOO_SMALL The ResultsDataSize specified was too small to
419 contain the results data.
420
421 **/
422 EFI_STATUS
423 EFIAPI
424 BrowserCallback (
425 IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,
426 IN OUT UINTN *ResultsDataSize,
427 IN OUT EFI_STRING ResultsData,
428 IN BOOLEAN RetrieveData,
429 IN CONST EFI_GUID *VariableGuid, OPTIONAL
430 IN CONST CHAR16 *VariableName OPTIONAL
431 )
432 {
433 EFI_STATUS Status;
434 LIST_ENTRY *Link;
435 FORMSET_STORAGE *Storage;
436 FORM_BROWSER_FORMSET *FormSet;
437 BOOLEAN Found;
438 CHAR16 *ConfigResp;
439 CHAR16 *StrPtr;
440 UINTN BufferSize;
441 UINTN TmpSize;
442
443 if (ResultsDataSize == NULL || ResultsData == NULL) {
444 return EFI_INVALID_PARAMETER;
445 }
446
447 if (gCurrentSelection == NULL) {
448 return EFI_NOT_READY;
449 }
450
451 Storage = NULL;
452 ConfigResp = NULL;
453 FormSet = gCurrentSelection->FormSet;
454
455 //
456 // Find target storage
457 //
458 Link = GetFirstNode (&FormSet->StorageListHead);
459 if (IsNull (&FormSet->StorageListHead, Link)) {
460 return EFI_UNSUPPORTED;
461 }
462
463 if (VariableGuid != NULL) {
464 //
465 // Try to find target storage
466 //
467 Found = FALSE;
468 while (!IsNull (&FormSet->StorageListHead, Link)) {
469 Storage = FORMSET_STORAGE_FROM_LINK (Link);
470 Link = GetNextNode (&FormSet->StorageListHead, Link);
471
472 if (CompareGuid (&Storage->Guid, (EFI_GUID *) VariableGuid)) {
473 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
474 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
475 //
476 // Buffer storage require both GUID and Name
477 //
478 if (VariableName == NULL) {
479 return EFI_NOT_FOUND;
480 }
481
482 if (StrCmp (Storage->Name, (CHAR16 *) VariableName) != 0) {
483 continue;
484 }
485 }
486 Found = TRUE;
487 break;
488 }
489 }
490
491 if (!Found) {
492 return EFI_NOT_FOUND;
493 }
494 } else {
495 //
496 // GUID/Name is not specified, take the first storage in FormSet
497 //
498 Storage = FORMSET_STORAGE_FROM_LINK (Link);
499 }
500
501 if (RetrieveData) {
502 //
503 // Skip if there is no RequestElement
504 //
505 if (Storage->ElementCount == 0) {
506 return EFI_SUCCESS;
507 }
508
509 //
510 // Generate <ConfigResp>
511 //
512 Status = StorageToConfigResp (Storage, &ConfigResp, FALSE);
513 if (EFI_ERROR (Status)) {
514 return Status;
515 }
516
517 //
518 // Skip <ConfigHdr> and '&' to point to <ConfigBody>
519 //
520 StrPtr = ConfigResp + StrLen (Storage->ConfigHdr) + 1;
521
522 BufferSize = StrSize (StrPtr);
523 if (*ResultsDataSize < BufferSize) {
524 *ResultsDataSize = BufferSize;
525
526 FreePool (ConfigResp);
527 return EFI_BUFFER_TOO_SMALL;
528 }
529
530 *ResultsDataSize = BufferSize;
531 CopyMem (ResultsData, StrPtr, BufferSize);
532
533 FreePool (ConfigResp);
534 } else {
535 //
536 // Prepare <ConfigResp>
537 //
538 TmpSize = StrLen (ResultsData);
539 BufferSize = (TmpSize + StrLen (Storage->ConfigHdr) + 2) * sizeof (CHAR16);
540 ConfigResp = AllocateZeroPool (BufferSize);
541 ASSERT (ConfigResp != NULL);
542
543 StrCpy (ConfigResp, Storage->ConfigHdr);
544 StrCat (ConfigResp, L"&");
545 StrCat (ConfigResp, ResultsData);
546
547 //
548 // Update Browser uncommited data
549 //
550 Status = ConfigRespToStorage (Storage, ConfigResp);
551 if (EFI_ERROR (Status)) {
552 return Status;
553 }
554 }
555
556 return EFI_SUCCESS;
557 }
558
559 /**
560 Notify function will remove the formset in the maintain list
561 once this formset is removed.
562
563 Functions which are registered to receive notification of
564 database events have this prototype. The actual event is encoded
565 in NotifyType. The following table describes how PackageType,
566 PackageGuid, Handle, and Package are used for each of the
567 notification types.
568
569 @param PackageType Package type of the notification.
570
571 @param PackageGuid If PackageType is
572 EFI_HII_PACKAGE_TYPE_GUID, then this is
573 the pointer to the GUID from the Guid
574 field of EFI_HII_PACKAGE_GUID_HEADER.
575 Otherwise, it must be NULL.
576
577 @param Package Points to the package referred to by the
578 notification Handle The handle of the package
579 list which contains the specified package.
580
581 @param Handle The HII handle.
582
583 @param NotifyType The type of change concerning the
584 database. See
585 EFI_HII_DATABASE_NOTIFY_TYPE.
586
587 **/
588 EFI_STATUS
589 EFIAPI
590 FormsetRemoveNotify (
591 IN UINT8 PackageType,
592 IN CONST EFI_GUID *PackageGuid,
593 IN CONST EFI_HII_PACKAGE_HEADER *Package,
594 IN EFI_HII_HANDLE Handle,
595 IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType
596 )
597 {
598 FORM_BROWSER_FORMSET *FormSet;
599
600 //
601 // Ignore the update for current using formset, which is handled by another notify function.
602 //
603 if (IsHiiHandleInBrowserContext (Handle)) {
604 return EFI_SUCCESS;
605 }
606
607 //
608 // Remove the backup FormSet data when the Form Package is removed.
609 //
610 FormSet = GetFormSetFromHiiHandle (Handle);
611 if (FormSet != NULL) {
612 RemoveEntryList (&FormSet->Link);
613 DestroyFormSet (FormSet);
614 }
615
616 return EFI_SUCCESS;
617 }
618
619 /**
620 Initialize Setup Browser driver.
621
622 @param ImageHandle The image handle.
623 @param SystemTable The system table.
624
625 @retval EFI_SUCCESS The Setup Browser module is initialized correctly..
626 @return Other value if failed to initialize the Setup Browser module.
627
628 **/
629 EFI_STATUS
630 EFIAPI
631 InitializeSetup (
632 IN EFI_HANDLE ImageHandle,
633 IN EFI_SYSTEM_TABLE *SystemTable
634 )
635 {
636 EFI_STATUS Status;
637 EFI_HANDLE NotifyHandle;
638 EFI_INPUT_KEY DefaultHotKey;
639 EFI_STRING HelpString;
640
641 //
642 // Locate required Hii relative protocols
643 //
644 Status = gBS->LocateProtocol (
645 &gEfiHiiDatabaseProtocolGuid,
646 NULL,
647 (VOID **) &mHiiDatabase
648 );
649 ASSERT_EFI_ERROR (Status);
650
651 Status = gBS->LocateProtocol (
652 &gEfiHiiStringProtocolGuid,
653 NULL,
654 (VOID **) &mHiiString
655 );
656 ASSERT_EFI_ERROR (Status);
657
658 Status = gBS->LocateProtocol (
659 &gEfiHiiConfigRoutingProtocolGuid,
660 NULL,
661 (VOID **) &mHiiConfigRouting
662 );
663 ASSERT_EFI_ERROR (Status);
664
665 //
666 // Publish our HII data
667 //
668 gHiiHandle = HiiAddPackages (
669 &gSetupBrowserGuid,
670 ImageHandle,
671 SetupBrowserStrings,
672 NULL
673 );
674 ASSERT (gHiiHandle != NULL);
675
676 //
677 // Initialize Driver private data
678 //
679 gBannerData = AllocateZeroPool (sizeof (BANNER_DATA));
680 ASSERT (gBannerData != NULL);
681
682 //
683 // Initialize generic help strings.
684 //
685 gSaveFailed = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);
686 gDiscardFailed = GetToken (STRING_TOKEN (DISCARD_FAILED), gHiiHandle);
687 gDefaultFailed = GetToken (STRING_TOKEN (DEFAULT_FAILED), gHiiHandle);
688
689 //
690 // Install FormBrowser2 protocol
691 //
692 mPrivateData.Handle = NULL;
693 Status = gBS->InstallProtocolInterface (
694 &mPrivateData.Handle,
695 &gEfiFormBrowser2ProtocolGuid,
696 EFI_NATIVE_INTERFACE,
697 &mPrivateData.FormBrowser2
698 );
699 ASSERT_EFI_ERROR (Status);
700
701 //
702 // Install default HotKey F10 for Save
703 //
704 DefaultHotKey.UnicodeChar = CHAR_NULL;
705 HelpString = GetToken (STRING_TOKEN (FUNCTION_TEN_STRING), gHiiHandle);
706 DefaultHotKey.ScanCode = SCAN_F10;
707 RegisterHotKey (&DefaultHotKey, BROWSER_ACTION_SUBMIT, 0, HelpString);
708 FreePool (HelpString);
709 //
710 // Install default HotKey F9 for Reset To Defaults
711 //
712 DefaultHotKey.ScanCode = SCAN_F9;
713 HelpString = GetToken (STRING_TOKEN (FUNCTION_NINE_STRING), gHiiHandle);
714 RegisterHotKey (&DefaultHotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, HelpString);
715 FreePool (HelpString);
716
717 //
718 // Install FormBrowserEx protocol
719 //
720 mPrivateData.Handle = NULL;
721 Status = gBS->InstallProtocolInterface (
722 &mPrivateData.Handle,
723 &gEfiFormBrowserExProtocolGuid,
724 EFI_NATIVE_INTERFACE,
725 &mPrivateData.FormBrowserEx
726 );
727 ASSERT_EFI_ERROR (Status);
728
729 //
730 // Register notify for Form package remove
731 //
732 Status = mHiiDatabase->RegisterPackageNotify (
733 mHiiDatabase,
734 EFI_HII_PACKAGE_FORMS,
735 NULL,
736 FormsetRemoveNotify,
737 EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,
738 &NotifyHandle
739 );
740 ASSERT_EFI_ERROR (Status);
741
742 return Status;
743 }
744
745
746 /**
747 Create a new string in HII Package List.
748
749 @param String The String to be added
750 @param HiiHandle The package list in the HII database to insert the
751 specified string.
752
753 @return The output string.
754
755 **/
756 EFI_STRING_ID
757 NewString (
758 IN CHAR16 *String,
759 IN EFI_HII_HANDLE HiiHandle
760 )
761 {
762 EFI_STRING_ID StringId;
763
764 StringId = HiiSetString (HiiHandle, 0, String, NULL);
765 ASSERT (StringId != 0);
766
767 return StringId;
768 }
769
770
771 /**
772 Delete a string from HII Package List.
773
774 @param StringId Id of the string in HII database.
775 @param HiiHandle The HII package list handle.
776
777 @retval EFI_SUCCESS The string was deleted successfully.
778
779 **/
780 EFI_STATUS
781 DeleteString (
782 IN EFI_STRING_ID StringId,
783 IN EFI_HII_HANDLE HiiHandle
784 )
785 {
786 CHAR16 NullChar;
787
788 NullChar = CHAR_NULL;
789 HiiSetString (HiiHandle, StringId, &NullChar, NULL);
790 return EFI_SUCCESS;
791 }
792
793
794 /**
795 Get the string based on the StringId and HII Package List Handle.
796
797 @param Token The String's ID.
798 @param HiiHandle The package list in the HII database to search for
799 the specified string.
800
801 @return The output string.
802
803 **/
804 CHAR16 *
805 GetToken (
806 IN EFI_STRING_ID Token,
807 IN EFI_HII_HANDLE HiiHandle
808 )
809 {
810 EFI_STRING String;
811
812 if (HiiHandle == NULL) {
813 return NULL;
814 }
815
816 String = HiiGetString (HiiHandle, Token, NULL);
817 if (String == NULL) {
818 String = AllocateCopyPool (sizeof (mUnknownString), mUnknownString);
819 ASSERT (String != NULL);
820 }
821 return (CHAR16 *) String;
822 }
823
824
825 /**
826 Allocate new memory and then copy the Unicode string Source to Destination.
827
828 @param Dest Location to copy string
829 @param Src String to copy
830
831 **/
832 VOID
833 NewStringCpy (
834 IN OUT CHAR16 **Dest,
835 IN CHAR16 *Src
836 )
837 {
838 if (*Dest != NULL) {
839 FreePool (*Dest);
840 }
841 *Dest = AllocateCopyPool (StrSize (Src), Src);
842 ASSERT (*Dest != NULL);
843 }
844
845
846 /**
847 Allocate new memory and concatinate Source on the end of Destination.
848
849 @param Dest String to added to the end of.
850 @param Src String to concatinate.
851
852 **/
853 VOID
854 NewStringCat (
855 IN OUT CHAR16 **Dest,
856 IN CHAR16 *Src
857 )
858 {
859 CHAR16 *NewString;
860 UINTN TmpSize;
861
862 if (*Dest == NULL) {
863 NewStringCpy (Dest, Src);
864 return;
865 }
866
867 TmpSize = StrSize (*Dest);
868 NewString = AllocateZeroPool (TmpSize + StrSize (Src) - 1);
869 ASSERT (NewString != NULL);
870
871 StrCpy (NewString, *Dest);
872 StrCat (NewString, Src);
873
874 FreePool (*Dest);
875 *Dest = NewString;
876 }
877
878
879 /**
880 Synchronize or restore Storage's Edit copy and Shadow copy.
881
882 @param Storage The Storage to be synchronized.
883 @param SyncOrRestore Sync the buffer to editbuffer or Restore the
884 editbuffer to buffer
885 if TRUE, copy the editbuffer to the buffer.
886 if FALSE, copy the buffer to the editbuffer.
887
888 **/
889 VOID
890 SynchronizeStorage (
891 IN FORMSET_STORAGE *Storage,
892 IN BOOLEAN SyncOrRestore
893 )
894 {
895 LIST_ENTRY *Link;
896 NAME_VALUE_NODE *Node;
897
898 switch (Storage->Type) {
899 case EFI_HII_VARSTORE_BUFFER:
900 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
901 if (SyncOrRestore) {
902 CopyMem (Storage->Buffer, Storage->EditBuffer, Storage->Size);
903 } else {
904 CopyMem (Storage->EditBuffer, Storage->Buffer, Storage->Size);
905 }
906 break;
907
908 case EFI_HII_VARSTORE_NAME_VALUE:
909 Link = GetFirstNode (&Storage->NameValueListHead);
910 while (!IsNull (&Storage->NameValueListHead, Link)) {
911 Node = NAME_VALUE_NODE_FROM_LINK (Link);
912
913 if (SyncOrRestore) {
914 NewStringCpy (&Node->Value, Node->EditValue);
915 } else {
916 NewStringCpy (&Node->EditValue, Node->Value);
917 }
918
919 Link = GetNextNode (&Storage->NameValueListHead, Link);
920 }
921 break;
922
923 case EFI_HII_VARSTORE_EFI_VARIABLE:
924 default:
925 break;
926 }
927 }
928
929
930 /**
931 Get Value for given Name from a NameValue Storage.
932
933 @param Storage The NameValue Storage.
934 @param Name The Name.
935 @param Value The retured Value.
936
937 @retval EFI_SUCCESS Value found for given Name.
938 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
939
940 **/
941 EFI_STATUS
942 GetValueByName (
943 IN FORMSET_STORAGE *Storage,
944 IN CHAR16 *Name,
945 IN OUT CHAR16 **Value
946 )
947 {
948 LIST_ENTRY *Link;
949 NAME_VALUE_NODE *Node;
950
951 *Value = NULL;
952
953 Link = GetFirstNode (&Storage->NameValueListHead);
954 while (!IsNull (&Storage->NameValueListHead, Link)) {
955 Node = NAME_VALUE_NODE_FROM_LINK (Link);
956
957 if (StrCmp (Name, Node->Name) == 0) {
958 NewStringCpy (Value, Node->EditValue);
959 return EFI_SUCCESS;
960 }
961
962 Link = GetNextNode (&Storage->NameValueListHead, Link);
963 }
964
965 return EFI_NOT_FOUND;
966 }
967
968
969 /**
970 Set Value of given Name in a NameValue Storage.
971
972 @param Storage The NameValue Storage.
973 @param Name The Name.
974 @param Value The Value to set.
975 @param Edit Whether update editValue or Value.
976
977 @retval EFI_SUCCESS Value found for given Name.
978 @retval EFI_NOT_FOUND No such Name found in NameValue storage.
979
980 **/
981 EFI_STATUS
982 SetValueByName (
983 IN FORMSET_STORAGE *Storage,
984 IN CHAR16 *Name,
985 IN CHAR16 *Value,
986 IN BOOLEAN Edit
987 )
988 {
989 LIST_ENTRY *Link;
990 NAME_VALUE_NODE *Node;
991 CHAR16 *Buffer;
992
993 Link = GetFirstNode (&Storage->NameValueListHead);
994 while (!IsNull (&Storage->NameValueListHead, Link)) {
995 Node = NAME_VALUE_NODE_FROM_LINK (Link);
996
997 if (StrCmp (Name, Node->Name) == 0) {
998 if (Edit) {
999 Buffer = Node->EditValue;
1000 } else {
1001 Buffer = Node->Value;
1002 }
1003 if (Buffer != NULL) {
1004 FreePool (Buffer);
1005 }
1006 Buffer = AllocateCopyPool (StrSize (Value), Value);
1007 ASSERT (Buffer != NULL);
1008 if (Edit) {
1009 Node->EditValue = Buffer;
1010 } else {
1011 Node->Value = Buffer;
1012 }
1013 return EFI_SUCCESS;
1014 }
1015
1016 Link = GetNextNode (&Storage->NameValueListHead, Link);
1017 }
1018
1019 return EFI_NOT_FOUND;
1020 }
1021
1022
1023 /**
1024 Convert setting of Buffer Storage or NameValue Storage to <ConfigResp>.
1025
1026 @param Buffer The Storage to be conveted.
1027 @param ConfigResp The returned <ConfigResp>.
1028 @param SingleForm Whether update data for single form or formset level.
1029
1030 @retval EFI_SUCCESS Convert success.
1031 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1032
1033 **/
1034 EFI_STATUS
1035 StorageToConfigResp (
1036 IN VOID *Buffer,
1037 IN CHAR16 **ConfigResp,
1038 IN BOOLEAN SingleForm
1039 )
1040 {
1041 EFI_STATUS Status;
1042 EFI_STRING Progress;
1043 LIST_ENTRY *Link;
1044 NAME_VALUE_NODE *Node;
1045 CHAR16 *ConfigRequest;
1046 FORMSET_STORAGE *Storage;
1047 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
1048
1049 Status = EFI_SUCCESS;
1050 if (SingleForm) {
1051 ConfigInfo = (FORM_BROWSER_CONFIG_REQUEST *) Buffer;
1052 Storage = ConfigInfo->Storage;
1053 ConfigRequest = ConfigInfo->ConfigRequest;
1054 } else {
1055 Storage = (FORMSET_STORAGE *) Buffer;
1056 ConfigRequest = Storage->ConfigRequest;
1057 }
1058
1059 switch (Storage->Type) {
1060 case EFI_HII_VARSTORE_BUFFER:
1061 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
1062 Status = mHiiConfigRouting->BlockToConfig (
1063 mHiiConfigRouting,
1064 ConfigRequest,
1065 Storage->EditBuffer,
1066 Storage->Size,
1067 ConfigResp,
1068 &Progress
1069 );
1070 break;
1071
1072 case EFI_HII_VARSTORE_NAME_VALUE:
1073 *ConfigResp = NULL;
1074 NewStringCat (ConfigResp, Storage->ConfigHdr);
1075
1076 Link = GetFirstNode (&Storage->NameValueListHead);
1077 while (!IsNull (&Storage->NameValueListHead, Link)) {
1078 Node = NAME_VALUE_NODE_FROM_LINK (Link);
1079
1080 if (StrStr (ConfigRequest, Node->Name) != NULL) {
1081 NewStringCat (ConfigResp, L"&");
1082 NewStringCat (ConfigResp, Node->Name);
1083 NewStringCat (ConfigResp, L"=");
1084 NewStringCat (ConfigResp, Node->EditValue);
1085 }
1086 Link = GetNextNode (&Storage->NameValueListHead, Link);
1087 }
1088 break;
1089
1090 case EFI_HII_VARSTORE_EFI_VARIABLE:
1091 default:
1092 Status = EFI_INVALID_PARAMETER;
1093 break;
1094 }
1095
1096 return Status;
1097 }
1098
1099
1100 /**
1101 Convert <ConfigResp> to settings in Buffer Storage or NameValue Storage.
1102
1103 @param Storage The Storage to receive the settings.
1104 @param ConfigResp The <ConfigResp> to be converted.
1105
1106 @retval EFI_SUCCESS Convert success.
1107 @retval EFI_INVALID_PARAMETER Incorrect storage type.
1108
1109 **/
1110 EFI_STATUS
1111 ConfigRespToStorage (
1112 IN FORMSET_STORAGE *Storage,
1113 IN CHAR16 *ConfigResp
1114 )
1115 {
1116 EFI_STATUS Status;
1117 EFI_STRING Progress;
1118 UINTN BufferSize;
1119 CHAR16 *StrPtr;
1120 CHAR16 *Name;
1121 CHAR16 *Value;
1122
1123 Status = EFI_SUCCESS;
1124
1125 switch (Storage->Type) {
1126 case EFI_HII_VARSTORE_BUFFER:
1127 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
1128 BufferSize = Storage->Size;
1129 Status = mHiiConfigRouting->ConfigToBlock (
1130 mHiiConfigRouting,
1131 ConfigResp,
1132 Storage->EditBuffer,
1133 &BufferSize,
1134 &Progress
1135 );
1136 break;
1137
1138 case EFI_HII_VARSTORE_NAME_VALUE:
1139 StrPtr = StrStr (ConfigResp, L"PATH");
1140 if (StrPtr == NULL) {
1141 break;
1142 }
1143 StrPtr = StrStr (ConfigResp, L"&");
1144 while (StrPtr != NULL) {
1145 //
1146 // Skip '&'
1147 //
1148 StrPtr = StrPtr + 1;
1149 Name = StrPtr;
1150 StrPtr = StrStr (StrPtr, L"=");
1151 if (StrPtr == NULL) {
1152 break;
1153 }
1154 *StrPtr = 0;
1155
1156 //
1157 // Skip '='
1158 //
1159 StrPtr = StrPtr + 1;
1160 Value = StrPtr;
1161 StrPtr = StrStr (StrPtr, L"&");
1162 if (StrPtr != NULL) {
1163 *StrPtr = 0;
1164 }
1165 SetValueByName (Storage, Name, Value, TRUE);
1166 }
1167 break;
1168
1169 case EFI_HII_VARSTORE_EFI_VARIABLE:
1170 default:
1171 Status = EFI_INVALID_PARAMETER;
1172 break;
1173 }
1174
1175 return Status;
1176 }
1177
1178
1179 /**
1180 Get Question's current Value.
1181
1182 @param FormSet FormSet data structure.
1183 @param Form Form data structure.
1184 @param Question Question to be initialized.
1185 @param Cached TRUE: get from Edit copy FALSE: get from original
1186 Storage
1187
1188 @retval EFI_SUCCESS The function completed successfully.
1189
1190 **/
1191 EFI_STATUS
1192 GetQuestionValue (
1193 IN FORM_BROWSER_FORMSET *FormSet,
1194 IN FORM_BROWSER_FORM *Form,
1195 IN OUT FORM_BROWSER_STATEMENT *Question,
1196 IN BOOLEAN Cached
1197 )
1198 {
1199 EFI_STATUS Status;
1200 BOOLEAN Enabled;
1201 BOOLEAN Pending;
1202 UINT8 *Dst;
1203 UINTN StorageWidth;
1204 EFI_TIME EfiTime;
1205 FORMSET_STORAGE *Storage;
1206 EFI_IFR_TYPE_VALUE *QuestionValue;
1207 CHAR16 *ConfigRequest;
1208 CHAR16 *Progress;
1209 CHAR16 *Result;
1210 CHAR16 *Value;
1211 CHAR16 *StringPtr;
1212 UINTN Length;
1213 UINTN Index;
1214 UINTN LengthStr;
1215 BOOLEAN IsBufferStorage;
1216 BOOLEAN IsString;
1217 CHAR16 TemStr[5];
1218 UINT8 DigitUint8;
1219 UINT8 *TemBuffer;
1220
1221 Status = EFI_SUCCESS;
1222 Value = NULL;
1223 Result = NULL;
1224
1225 //
1226 // Statement don't have storage, skip them
1227 //
1228 if (Question->QuestionId == 0) {
1229 return Status;
1230 }
1231
1232 //
1233 // Question value is provided by an Expression, evaluate it
1234 //
1235 if (Question->ValueExpression != NULL) {
1236 Status = EvaluateExpression (FormSet, Form, Question->ValueExpression);
1237 if (!EFI_ERROR (Status)) {
1238 if (Question->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
1239 ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);
1240 if (Question->StorageWidth > Question->ValueExpression->Result.BufferLen) {
1241 CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->ValueExpression->Result.BufferLen);
1242 Question->HiiValue.BufferLen = Question->ValueExpression->Result.BufferLen;
1243 } else {
1244 CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->StorageWidth);
1245 Question->HiiValue.BufferLen = Question->StorageWidth;
1246 }
1247 FreePool (Question->ValueExpression->Result.Buffer);
1248 }
1249 Question->HiiValue.Type = Question->ValueExpression->Result.Type;
1250 CopyMem (&Question->HiiValue.Value, &Question->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
1251 }
1252 return Status;
1253 }
1254
1255 //
1256 // Get question value by read expression.
1257 //
1258 if (Question->ReadExpression != NULL && Form->FormType == STANDARD_MAP_FORM_TYPE) {
1259 Status = EvaluateExpression (FormSet, Form, Question->ReadExpression);
1260 if (!EFI_ERROR (Status) &&
1261 ((Question->ReadExpression->Result.Type < EFI_IFR_TYPE_OTHER) || (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER))) {
1262 //
1263 // Only update question value to the valid result.
1264 //
1265 if (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
1266 ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);
1267 if (Question->StorageWidth > Question->ReadExpression->Result.BufferLen) {
1268 CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->ReadExpression->Result.BufferLen);
1269 Question->HiiValue.BufferLen = Question->ReadExpression->Result.BufferLen;
1270 } else {
1271 CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->StorageWidth);
1272 Question->HiiValue.BufferLen = Question->StorageWidth;
1273 }
1274 FreePool (Question->ReadExpression->Result.Buffer);
1275 }
1276 Question->HiiValue.Type = Question->ReadExpression->Result.Type;
1277 CopyMem (&Question->HiiValue.Value, &Question->ReadExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
1278 return EFI_SUCCESS;
1279 }
1280 }
1281
1282 //
1283 // Question value is provided by RTC
1284 //
1285 Storage = Question->Storage;
1286 QuestionValue = &Question->HiiValue.Value;
1287 if (Storage == NULL) {
1288 //
1289 // It's a Question without storage, or RTC date/time
1290 //
1291 if (Question->Operand == EFI_IFR_DATE_OP || Question->Operand == EFI_IFR_TIME_OP) {
1292 //
1293 // Date and time define the same Flags bit
1294 //
1295 switch (Question->Flags & EFI_QF_DATE_STORAGE) {
1296 case QF_DATE_STORAGE_TIME:
1297 Status = gRT->GetTime (&EfiTime, NULL);
1298 break;
1299
1300 case QF_DATE_STORAGE_WAKEUP:
1301 Status = gRT->GetWakeupTime (&Enabled, &Pending, &EfiTime);
1302 break;
1303
1304 case QF_DATE_STORAGE_NORMAL:
1305 default:
1306 //
1307 // For date/time without storage
1308 //
1309 return EFI_SUCCESS;
1310 }
1311
1312 if (EFI_ERROR (Status)) {
1313 return Status;
1314 }
1315
1316 if (Question->Operand == EFI_IFR_DATE_OP) {
1317 QuestionValue->date.Year = EfiTime.Year;
1318 QuestionValue->date.Month = EfiTime.Month;
1319 QuestionValue->date.Day = EfiTime.Day;
1320 } else {
1321 QuestionValue->time.Hour = EfiTime.Hour;
1322 QuestionValue->time.Minute = EfiTime.Minute;
1323 QuestionValue->time.Second = EfiTime.Second;
1324 }
1325 }
1326
1327 return EFI_SUCCESS;
1328 }
1329
1330 //
1331 // Question value is provided by EFI variable
1332 //
1333 StorageWidth = Question->StorageWidth;
1334 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
1335 if (Question->BufferValue != NULL) {
1336 Dst = Question->BufferValue;
1337 } else {
1338 Dst = (UINT8 *) QuestionValue;
1339 }
1340
1341 Status = gRT->GetVariable (
1342 Question->VariableName,
1343 &Storage->Guid,
1344 NULL,
1345 &StorageWidth,
1346 Dst
1347 );
1348 //
1349 // Always return success, even this EFI variable doesn't exist
1350 //
1351 return EFI_SUCCESS;
1352 }
1353
1354 //
1355 // Question Value is provided by Buffer Storage or NameValue Storage
1356 //
1357 if (Question->BufferValue != NULL) {
1358 //
1359 // This Question is password or orderedlist
1360 //
1361 Dst = Question->BufferValue;
1362 } else {
1363 //
1364 // Other type of Questions
1365 //
1366 Dst = (UINT8 *) &Question->HiiValue.Value;
1367 }
1368
1369 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
1370 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1371 IsBufferStorage = TRUE;
1372 } else {
1373 IsBufferStorage = FALSE;
1374 }
1375 IsString = (BOOLEAN) ((Question->HiiValue.Type == EFI_IFR_TYPE_STRING) ? TRUE : FALSE);
1376 if (Cached) {
1377 if (IsBufferStorage) {
1378 //
1379 // Copy from storage Edit buffer
1380 //
1381 CopyMem (Dst, Storage->EditBuffer + Question->VarStoreInfo.VarOffset, StorageWidth);
1382 } else {
1383 Value = NULL;
1384 Status = GetValueByName (Storage, Question->VariableName, &Value);
1385 if (EFI_ERROR (Status)) {
1386 return Status;
1387 }
1388
1389 ASSERT (Value != NULL);
1390 LengthStr = StrLen (Value);
1391 Status = EFI_SUCCESS;
1392 if (IsString) {
1393 //
1394 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1395 // Add string tail char L'\0' into Length
1396 //
1397 Length = StorageWidth + sizeof (CHAR16);
1398 if (Length < ((LengthStr / 4 + 1) * 2)) {
1399 Status = EFI_BUFFER_TOO_SMALL;
1400 } else {
1401 StringPtr = (CHAR16 *) Dst;
1402 ZeroMem (TemStr, sizeof (TemStr));
1403 for (Index = 0; Index < LengthStr; Index += 4) {
1404 StrnCpy (TemStr, Value + Index, 4);
1405 StringPtr[Index/4] = (CHAR16) StrHexToUint64 (TemStr);
1406 }
1407 //
1408 // Add tailing L'\0' character
1409 //
1410 StringPtr[Index/4] = L'\0';
1411 }
1412 } else {
1413 if (StorageWidth < ((LengthStr + 1) / 2)) {
1414 Status = EFI_BUFFER_TOO_SMALL;
1415 } else {
1416 ZeroMem (TemStr, sizeof (TemStr));
1417 for (Index = 0; Index < LengthStr; Index ++) {
1418 TemStr[0] = Value[LengthStr - Index - 1];
1419 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
1420 if ((Index & 1) == 0) {
1421 Dst [Index/2] = DigitUint8;
1422 } else {
1423 Dst [Index/2] = (UINT8) ((DigitUint8 << 4) + Dst [Index/2]);
1424 }
1425 }
1426 }
1427 }
1428
1429 FreePool (Value);
1430 }
1431 } else {
1432 if (Storage->Type == EFI_HII_VARSTORE_BUFFER || Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
1433 //
1434 // Request current settings from Configuration Driver
1435 //
1436 if (FormSet->ConfigAccess == NULL) {
1437 return EFI_NOT_FOUND;
1438 }
1439
1440 //
1441 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
1442 // <ConfigHdr> + "&" + <VariableName>
1443 //
1444 if (IsBufferStorage) {
1445 Length = StrLen (Storage->ConfigHdr);
1446 Length += StrLen (Question->BlockName);
1447 } else {
1448 Length = StrLen (Storage->ConfigHdr);
1449 Length += StrLen (Question->VariableName) + 1;
1450 }
1451 ConfigRequest = AllocateZeroPool ((Length + 1) * sizeof (CHAR16));
1452 ASSERT (ConfigRequest != NULL);
1453
1454 StrCpy (ConfigRequest, Storage->ConfigHdr);
1455 if (IsBufferStorage) {
1456 StrCat (ConfigRequest, Question->BlockName);
1457 } else {
1458 StrCat (ConfigRequest, L"&");
1459 StrCat (ConfigRequest, Question->VariableName);
1460 }
1461
1462 Status = FormSet->ConfigAccess->ExtractConfig (
1463 FormSet->ConfigAccess,
1464 ConfigRequest,
1465 &Progress,
1466 &Result
1467 );
1468 FreePool (ConfigRequest);
1469 if (EFI_ERROR (Status)) {
1470 return Status;
1471 }
1472
1473 //
1474 // Skip <ConfigRequest>
1475 //
1476 if (IsBufferStorage) {
1477 Value = StrStr (Result, L"&VALUE");
1478 if (Value == NULL) {
1479 FreePool (Result);
1480 return EFI_NOT_FOUND;
1481 }
1482 //
1483 // Skip "&VALUE"
1484 //
1485 Value = Value + 6;
1486 } else {
1487 Value = Result + Length;
1488 }
1489 if (*Value != '=') {
1490 FreePool (Result);
1491 return EFI_NOT_FOUND;
1492 }
1493 //
1494 // Skip '=', point to value
1495 //
1496 Value = Value + 1;
1497
1498 //
1499 // Suppress <AltResp> if any
1500 //
1501 StringPtr = Value;
1502 while (*StringPtr != L'\0' && *StringPtr != L'&') {
1503 StringPtr++;
1504 }
1505 *StringPtr = L'\0';
1506
1507 LengthStr = StrLen (Value);
1508 Status = EFI_SUCCESS;
1509 if (!IsBufferStorage && IsString) {
1510 //
1511 // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"
1512 // Add string tail char L'\0' into Length
1513 //
1514 Length = StorageWidth + sizeof (CHAR16);
1515 if (Length < ((LengthStr / 4 + 1) * 2)) {
1516 Status = EFI_BUFFER_TOO_SMALL;
1517 } else {
1518 StringPtr = (CHAR16 *) Dst;
1519 ZeroMem (TemStr, sizeof (TemStr));
1520 for (Index = 0; Index < LengthStr; Index += 4) {
1521 StrnCpy (TemStr, Value + Index, 4);
1522 StringPtr[Index/4] = (CHAR16) StrHexToUint64 (TemStr);
1523 }
1524 //
1525 // Add tailing L'\0' character
1526 //
1527 StringPtr[Index/4] = L'\0';
1528 }
1529 } else {
1530 if (StorageWidth < ((LengthStr + 1) / 2)) {
1531 Status = EFI_BUFFER_TOO_SMALL;
1532 } else {
1533 ZeroMem (TemStr, sizeof (TemStr));
1534 for (Index = 0; Index < LengthStr; Index ++) {
1535 TemStr[0] = Value[LengthStr - Index - 1];
1536 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
1537 if ((Index & 1) == 0) {
1538 Dst [Index/2] = DigitUint8;
1539 } else {
1540 Dst [Index/2] = (UINT8) ((DigitUint8 << 4) + Dst [Index/2]);
1541 }
1542 }
1543 }
1544 }
1545
1546 if (EFI_ERROR (Status)) {
1547 FreePool (Result);
1548 return Status;
1549 }
1550 } else if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1551 TemBuffer = NULL;
1552 TemBuffer = AllocateZeroPool (Storage->Size);
1553 if (TemBuffer == NULL) {
1554 Status = EFI_OUT_OF_RESOURCES;
1555 return Status;
1556 }
1557 Length = Storage->Size;
1558 Status = gRT->GetVariable (
1559 Storage->Name,
1560 &Storage->Guid,
1561 NULL,
1562 &Length,
1563 TemBuffer
1564 );
1565 if (EFI_ERROR (Status)) {
1566 FreePool (TemBuffer);
1567 return Status;
1568 }
1569
1570 CopyMem (Dst, TemBuffer + Question->VarStoreInfo.VarOffset, StorageWidth);
1571
1572 FreePool (TemBuffer);
1573 }
1574
1575 //
1576 // Synchronize Edit Buffer
1577 //
1578 if (IsBufferStorage) {
1579 CopyMem (Storage->EditBuffer + Question->VarStoreInfo.VarOffset, Dst, StorageWidth);
1580 } else {
1581 SetValueByName (Storage, Question->VariableName, Value, TRUE);
1582 }
1583
1584 if (Result != NULL) {
1585 FreePool (Result);
1586 }
1587 }
1588
1589 return Status;
1590 }
1591
1592
1593 /**
1594 Save Question Value to edit copy(cached) or Storage(uncached).
1595
1596 @param FormSet FormSet data structure.
1597 @param Form Form data structure.
1598 @param Question Pointer to the Question.
1599 @param Cached TRUE: set to Edit copy FALSE: set to original
1600 Storage
1601
1602 @retval EFI_SUCCESS The function completed successfully.
1603
1604 **/
1605 EFI_STATUS
1606 SetQuestionValue (
1607 IN FORM_BROWSER_FORMSET *FormSet,
1608 IN FORM_BROWSER_FORM *Form,
1609 IN OUT FORM_BROWSER_STATEMENT *Question,
1610 IN BOOLEAN Cached
1611 )
1612 {
1613 EFI_STATUS Status;
1614 BOOLEAN Enabled;
1615 BOOLEAN Pending;
1616 UINT8 *Src;
1617 EFI_TIME EfiTime;
1618 UINTN BufferLen;
1619 UINTN StorageWidth;
1620 FORMSET_STORAGE *Storage;
1621 EFI_IFR_TYPE_VALUE *QuestionValue;
1622 CHAR16 *ConfigResp;
1623 CHAR16 *Progress;
1624 CHAR16 *Value;
1625 UINTN Length;
1626 BOOLEAN IsBufferStorage;
1627 BOOLEAN IsString;
1628 UINT8 *TemBuffer;
1629 CHAR16 *TemName;
1630 CHAR16 *TemString;
1631 UINTN Index;
1632
1633 Status = EFI_SUCCESS;
1634
1635 //
1636 // Statement don't have storage, skip them
1637 //
1638 if (Question->QuestionId == 0) {
1639 return Status;
1640 }
1641
1642 //
1643 // If Question value is provided by an Expression, then it is read only
1644 //
1645 if (Question->ValueExpression != NULL) {
1646 return Status;
1647 }
1648
1649 //
1650 // Before set question value, evaluate its write expression.
1651 //
1652 if (Question->WriteExpression != NULL && Form->FormType == STANDARD_MAP_FORM_TYPE) {
1653 Status = EvaluateExpression (FormSet, Form, Question->WriteExpression);
1654 if (EFI_ERROR (Status)) {
1655 return Status;
1656 }
1657 }
1658
1659 //
1660 // Question value is provided by RTC
1661 //
1662 Storage = Question->Storage;
1663 QuestionValue = &Question->HiiValue.Value;
1664 if (Storage == NULL) {
1665 //
1666 // It's a Question without storage, or RTC date/time
1667 //
1668 if (Question->Operand == EFI_IFR_DATE_OP || Question->Operand == EFI_IFR_TIME_OP) {
1669 //
1670 // Date and time define the same Flags bit
1671 //
1672 switch (Question->Flags & EFI_QF_DATE_STORAGE) {
1673 case QF_DATE_STORAGE_TIME:
1674 Status = gRT->GetTime (&EfiTime, NULL);
1675 break;
1676
1677 case QF_DATE_STORAGE_WAKEUP:
1678 Status = gRT->GetWakeupTime (&Enabled, &Pending, &EfiTime);
1679 break;
1680
1681 case QF_DATE_STORAGE_NORMAL:
1682 default:
1683 //
1684 // For date/time without storage
1685 //
1686 return EFI_SUCCESS;
1687 }
1688
1689 if (EFI_ERROR (Status)) {
1690 return Status;
1691 }
1692
1693 if (Question->Operand == EFI_IFR_DATE_OP) {
1694 EfiTime.Year = QuestionValue->date.Year;
1695 EfiTime.Month = QuestionValue->date.Month;
1696 EfiTime.Day = QuestionValue->date.Day;
1697 } else {
1698 EfiTime.Hour = QuestionValue->time.Hour;
1699 EfiTime.Minute = QuestionValue->time.Minute;
1700 EfiTime.Second = QuestionValue->time.Second;
1701 }
1702
1703 if ((Question->Flags & EFI_QF_DATE_STORAGE) == QF_DATE_STORAGE_TIME) {
1704 Status = gRT->SetTime (&EfiTime);
1705 } else {
1706 Status = gRT->SetWakeupTime (TRUE, &EfiTime);
1707 }
1708 }
1709
1710 return Status;
1711 }
1712
1713 //
1714 // Question value is provided by EFI variable
1715 //
1716 StorageWidth = Question->StorageWidth;
1717 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
1718 if (Question->BufferValue != NULL) {
1719 Src = Question->BufferValue;
1720 } else {
1721 Src = (UINT8 *) QuestionValue;
1722 }
1723
1724 Status = gRT->SetVariable (
1725 Question->VariableName,
1726 &Storage->Guid,
1727 Storage->Attributes,
1728 StorageWidth,
1729 Src
1730 );
1731 return Status;
1732 }
1733
1734 //
1735 // Question Value is provided by Buffer Storage or NameValue Storage
1736 //
1737 if (Question->BufferValue != NULL) {
1738 Src = Question->BufferValue;
1739 } else {
1740 Src = (UINT8 *) &Question->HiiValue.Value;
1741 }
1742
1743 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
1744 Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1745 IsBufferStorage = TRUE;
1746 } else {
1747 IsBufferStorage = FALSE;
1748 }
1749 IsString = (BOOLEAN) ((Question->HiiValue.Type == EFI_IFR_TYPE_STRING) ? TRUE : FALSE);
1750 if (IsBufferStorage) {
1751 //
1752 // Copy to storage edit buffer
1753 //
1754 CopyMem (Storage->EditBuffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
1755 } else {
1756 if (IsString) {
1757 //
1758 // Allocate enough string buffer.
1759 //
1760 Value = NULL;
1761 BufferLen = ((StrLen ((CHAR16 *) Src) * 4) + 1) * sizeof (CHAR16);
1762 Value = AllocateZeroPool (BufferLen);
1763 ASSERT (Value != NULL);
1764 //
1765 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1766 //
1767 TemName = (CHAR16 *) Src;
1768 TemString = Value;
1769 for (; *TemName != L'\0'; TemName++) {
1770 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemName, 4);
1771 }
1772 } else {
1773 BufferLen = StorageWidth * 2 + 1;
1774 Value = AllocateZeroPool (BufferLen * sizeof (CHAR16));
1775 ASSERT (Value != NULL);
1776 //
1777 // Convert Buffer to Hex String
1778 //
1779 TemBuffer = Src + StorageWidth - 1;
1780 TemString = Value;
1781 for (Index = 0; Index < StorageWidth; Index ++, TemBuffer --) {
1782 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
1783 }
1784 }
1785
1786 Status = SetValueByName (Storage, Question->VariableName, Value, TRUE);
1787 FreePool (Value);
1788 }
1789
1790 if (!Cached) {
1791 if (Storage->Type == EFI_HII_VARSTORE_BUFFER || Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
1792 //
1793 // <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||
1794 // <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"
1795 //
1796 if (IsBufferStorage) {
1797 Length = StrLen (Question->BlockName) + 7;
1798 } else {
1799 Length = StrLen (Question->VariableName) + 2;
1800 }
1801 if (!IsBufferStorage && IsString) {
1802 Length += (StrLen ((CHAR16 *) Src) * 4);
1803 } else {
1804 Length += (StorageWidth * 2);
1805 }
1806 ConfigResp = AllocateZeroPool ((StrLen (Storage->ConfigHdr) + Length + 1) * sizeof (CHAR16));
1807 ASSERT (ConfigResp != NULL);
1808
1809 StrCpy (ConfigResp, Storage->ConfigHdr);
1810 if (IsBufferStorage) {
1811 StrCat (ConfigResp, Question->BlockName);
1812 StrCat (ConfigResp, L"&VALUE=");
1813 } else {
1814 StrCat (ConfigResp, L"&");
1815 StrCat (ConfigResp, Question->VariableName);
1816 StrCat (ConfigResp, L"=");
1817 }
1818
1819 Value = ConfigResp + StrLen (ConfigResp);
1820
1821 if (!IsBufferStorage && IsString) {
1822 //
1823 // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"
1824 //
1825 TemName = (CHAR16 *) Src;
1826 TemString = Value;
1827 for (; *TemName != L'\0'; TemName++) {
1828 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemName, 4);
1829 }
1830 } else {
1831 //
1832 // Convert Buffer to Hex String
1833 //
1834 TemBuffer = Src + StorageWidth - 1;
1835 TemString = Value;
1836 for (Index = 0; Index < StorageWidth; Index ++, TemBuffer --) {
1837 TemString += UnicodeValueToString (TemString, PREFIX_ZERO | RADIX_HEX, *TemBuffer, 2);
1838 }
1839 }
1840
1841 //
1842 // Convert to lower char.
1843 //
1844 for (TemString = Value; *Value != L'\0'; Value++) {
1845 if (*Value >= L'A' && *Value <= L'Z') {
1846 *Value = (CHAR16) (*Value - L'A' + L'a');
1847 }
1848 }
1849
1850 //
1851 // Submit Question Value to Configuration Driver
1852 //
1853 if (FormSet->ConfigAccess != NULL) {
1854 Status = FormSet->ConfigAccess->RouteConfig (
1855 FormSet->ConfigAccess,
1856 ConfigResp,
1857 &Progress
1858 );
1859 if (EFI_ERROR (Status)) {
1860 FreePool (ConfigResp);
1861 return Status;
1862 }
1863 }
1864 FreePool (ConfigResp);
1865
1866 } else if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
1867 TemBuffer = NULL;
1868 TemBuffer = AllocateZeroPool(Storage->Size);
1869 if (TemBuffer == NULL) {
1870 Status = EFI_OUT_OF_RESOURCES;
1871 return Status;
1872 }
1873 Length = Storage->Size;
1874 Status = gRT->GetVariable (
1875 Storage->Name,
1876 &Storage->Guid,
1877 NULL,
1878 &Length,
1879 TemBuffer
1880 );
1881
1882 CopyMem (TemBuffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
1883
1884 Status = gRT->SetVariable (
1885 Storage->Name,
1886 &Storage->Guid,
1887 Storage->Attributes,
1888 Storage->Size,
1889 TemBuffer
1890 );
1891 FreePool (TemBuffer);
1892 if (EFI_ERROR (Status)){
1893 return Status;
1894 }
1895 }
1896 //
1897 // Sync storage, from editbuffer to buffer.
1898 //
1899 CopyMem (Storage->Buffer + Question->VarStoreInfo.VarOffset, Src, StorageWidth);
1900 }
1901
1902 return Status;
1903 }
1904
1905
1906 /**
1907 Perform inconsistent check for a Form.
1908
1909 @param FormSet FormSet data structure.
1910 @param Form Form data structure.
1911 @param Question The Question to be validated.
1912 @param Type Validation type: InConsistent or NoSubmit
1913
1914 @retval EFI_SUCCESS Form validation pass.
1915 @retval other Form validation failed.
1916
1917 **/
1918 EFI_STATUS
1919 ValidateQuestion (
1920 IN FORM_BROWSER_FORMSET *FormSet,
1921 IN FORM_BROWSER_FORM *Form,
1922 IN FORM_BROWSER_STATEMENT *Question,
1923 IN UINTN Type
1924 )
1925 {
1926 EFI_STATUS Status;
1927 LIST_ENTRY *Link;
1928 LIST_ENTRY *ListHead;
1929 EFI_STRING PopUp;
1930 EFI_INPUT_KEY Key;
1931 FORM_EXPRESSION *Expression;
1932
1933 if (Type == EFI_HII_EXPRESSION_INCONSISTENT_IF) {
1934 ListHead = &Question->InconsistentListHead;
1935 } else if (Type == EFI_HII_EXPRESSION_NO_SUBMIT_IF) {
1936 ListHead = &Question->NoSubmitListHead;
1937 } else {
1938 return EFI_UNSUPPORTED;
1939 }
1940
1941 Link = GetFirstNode (ListHead);
1942 while (!IsNull (ListHead, Link)) {
1943 Expression = FORM_EXPRESSION_FROM_LINK (Link);
1944
1945 //
1946 // Evaluate the expression
1947 //
1948 Status = EvaluateExpression (FormSet, Form, Expression);
1949 if (EFI_ERROR (Status)) {
1950 return Status;
1951 }
1952
1953 if ((Expression->Result.Type == EFI_IFR_TYPE_BOOLEAN) && Expression->Result.Value.b) {
1954 //
1955 // Condition meet, show up error message
1956 //
1957 if (Expression->Error != 0) {
1958 PopUp = GetToken (Expression->Error, FormSet->HiiHandle);
1959 do {
1960 CreateDialog (4, TRUE, 0, NULL, &Key, gEmptyString, PopUp, gPressEnter, gEmptyString);
1961 } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);
1962 FreePool (PopUp);
1963 }
1964
1965 return EFI_NOT_READY;
1966 }
1967
1968 Link = GetNextNode (ListHead, Link);
1969 }
1970
1971 return EFI_SUCCESS;
1972 }
1973
1974
1975 /**
1976 Perform NoSubmit check for each Form in FormSet.
1977
1978 @param FormSet FormSet data structure.
1979 @param CurrentForm Current input form data structure.
1980
1981 @retval EFI_SUCCESS Form validation pass.
1982 @retval other Form validation failed.
1983
1984 **/
1985 EFI_STATUS
1986 NoSubmitCheck (
1987 IN FORM_BROWSER_FORMSET *FormSet,
1988 IN FORM_BROWSER_FORM *CurrentForm
1989 )
1990 {
1991 EFI_STATUS Status;
1992 LIST_ENTRY *Link;
1993 FORM_BROWSER_STATEMENT *Question;
1994 FORM_BROWSER_FORM *Form;
1995 LIST_ENTRY *LinkForm;
1996
1997 LinkForm = GetFirstNode (&FormSet->FormListHead);
1998 while (!IsNull (&FormSet->FormListHead, LinkForm)) {
1999 Form = FORM_BROWSER_FORM_FROM_LINK (LinkForm);
2000 LinkForm = GetNextNode (&FormSet->FormListHead, LinkForm);
2001
2002 if (CurrentForm != NULL && CurrentForm != Form) {
2003 continue;
2004 }
2005
2006 Link = GetFirstNode (&Form->StatementListHead);
2007 while (!IsNull (&Form->StatementListHead, Link)) {
2008 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
2009
2010 Status = ValidateQuestion (FormSet, Form, Question, EFI_HII_EXPRESSION_NO_SUBMIT_IF);
2011 if (EFI_ERROR (Status)) {
2012 return Status;
2013 }
2014
2015 Link = GetNextNode (&Form->StatementListHead, Link);
2016 }
2017 }
2018
2019 return EFI_SUCCESS;
2020 }
2021
2022 /**
2023 Fill storage's edit copy with settings requested from Configuration Driver.
2024
2025 @param FormSet FormSet data structure.
2026 @param ConfigInfo The config info related to this form.
2027 @param SyncOrRestore Sync the buffer to editbuffer or Restore the
2028 editbuffer to buffer
2029 if TRUE, copy the editbuffer to the buffer.
2030 if FALSE, copy the buffer to the editbuffer.
2031
2032 @retval EFI_SUCCESS The function completed successfully.
2033
2034 **/
2035 EFI_STATUS
2036 SynchronizeStorageForForm (
2037 IN FORM_BROWSER_FORMSET *FormSet,
2038 IN FORM_BROWSER_CONFIG_REQUEST *ConfigInfo,
2039 IN BOOLEAN SyncOrRestore
2040 )
2041 {
2042 EFI_STATUS Status;
2043 EFI_STRING Progress;
2044 EFI_STRING Result;
2045 UINTN BufferSize;
2046 LIST_ENTRY *Link;
2047 NAME_VALUE_NODE *Node;
2048 UINT8 *Src;
2049 UINT8 *Dst;
2050
2051 Status = EFI_SUCCESS;
2052 Result = NULL;
2053 if (FormSet->ConfigAccess == NULL && ConfigInfo->Storage->Type != EFI_HII_VARSTORE_NAME_VALUE) {
2054 return EFI_NOT_FOUND;
2055 }
2056
2057 if (ConfigInfo->ElementCount == 0) {
2058 //
2059 // Skip if there is no RequestElement
2060 //
2061 return EFI_SUCCESS;
2062 }
2063
2064 if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_BUFFER ||
2065 (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
2066 BufferSize = ConfigInfo->Storage->Size;
2067
2068 if (SyncOrRestore) {
2069 Src = ConfigInfo->Storage->EditBuffer;
2070 Dst = ConfigInfo->Storage->Buffer;
2071 } else {
2072 Src = ConfigInfo->Storage->Buffer;
2073 Dst = ConfigInfo->Storage->EditBuffer;
2074 }
2075
2076 Status = mHiiConfigRouting->BlockToConfig(
2077 mHiiConfigRouting,
2078 ConfigInfo->ConfigRequest,
2079 Src,
2080 BufferSize,
2081 &Result,
2082 &Progress
2083 );
2084 if (EFI_ERROR (Status)) {
2085 return Status;
2086 }
2087
2088 Status = mHiiConfigRouting->ConfigToBlock (
2089 mHiiConfigRouting,
2090 Result,
2091 Dst,
2092 &BufferSize,
2093 &Progress
2094 );
2095 if (Result != NULL) {
2096 FreePool (Result);
2097 }
2098 } else if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2099 Link = GetFirstNode (&ConfigInfo->Storage->NameValueListHead);
2100 while (!IsNull (&ConfigInfo->Storage->NameValueListHead, Link)) {
2101 Node = NAME_VALUE_NODE_FROM_LINK (Link);
2102
2103 if (StrStr (ConfigInfo->ConfigRequest, Node->Name) != NULL) {
2104 if (SyncOrRestore) {
2105 NewStringCpy (&Node->Value, Node->EditValue);
2106 } else {
2107 NewStringCpy (&Node->EditValue, Node->Value);
2108 }
2109 }
2110
2111 Link = GetNextNode (&ConfigInfo->Storage->NameValueListHead, Link);
2112 }
2113 }
2114
2115 return Status;
2116 }
2117
2118
2119 /**
2120 Discard data based on the input setting scope (Form, FormSet or System).
2121
2122 @param FormSet FormSet data structure.
2123 @param Form Form data structure.
2124 @param SettingScope Setting Scope for Discard action.
2125
2126 @retval EFI_SUCCESS The function completed successfully.
2127 @retval EFI_UNSUPPORTED Unsupport SettingScope.
2128
2129 **/
2130 EFI_STATUS
2131 DiscardForm (
2132 IN FORM_BROWSER_FORMSET *FormSet,
2133 IN FORM_BROWSER_FORM *Form,
2134 IN BROWSER_SETTING_SCOPE SettingScope
2135 )
2136 {
2137 LIST_ENTRY *Link;
2138 FORMSET_STORAGE *Storage;
2139 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
2140 FORM_BROWSER_FORMSET *LocalFormSet;
2141
2142 //
2143 // Check the supported setting level.
2144 //
2145 if (SettingScope >= MaxLevel) {
2146 return EFI_UNSUPPORTED;
2147 }
2148
2149 if (SettingScope == FormLevel && Form->NvUpdateRequired) {
2150 ConfigInfo = NULL;
2151 Link = GetFirstNode (&Form->ConfigRequestHead);
2152 while (!IsNull (&Form->ConfigRequestHead, Link)) {
2153 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
2154 Link = GetNextNode (&Form->ConfigRequestHead, Link);
2155
2156 if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2157 continue;
2158 }
2159
2160 //
2161 // Skip if there is no RequestElement
2162 //
2163 if (ConfigInfo->ElementCount == 0) {
2164 continue;
2165 }
2166
2167 //
2168 // Prepare <ConfigResp>
2169 //
2170 SynchronizeStorageForForm(FormSet, ConfigInfo, FALSE);
2171 }
2172
2173 Form->NvUpdateRequired = FALSE;
2174 } else if (SettingScope == FormSetLevel && IsNvUpdateRequired(FormSet)) {
2175 //
2176 // Discard Buffer storage or Name/Value storage
2177 //
2178 Link = GetFirstNode (&FormSet->StorageListHead);
2179 while (!IsNull (&FormSet->StorageListHead, Link)) {
2180 Storage = FORMSET_STORAGE_FROM_LINK (Link);
2181 Link = GetNextNode (&FormSet->StorageListHead, Link);
2182
2183 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2184 continue;
2185 }
2186
2187 //
2188 // Skip if there is no RequestElement
2189 //
2190 if (Storage->ElementCount == 0) {
2191 continue;
2192 }
2193
2194 SynchronizeStorage(Storage, FALSE);
2195 }
2196
2197 UpdateNvInfoInForm (FormSet, FALSE);
2198 } else if (SettingScope == SystemLevel) {
2199 //
2200 // System Level Discard.
2201 //
2202
2203 //
2204 // Discard changed value for each FormSet in the maintain list.
2205 //
2206 Link = GetFirstNode (&gBrowserFormSetList);
2207 while (!IsNull (&gBrowserFormSetList, Link)) {
2208 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
2209 DiscardForm (LocalFormSet, NULL, FormSetLevel);
2210 Link = GetNextNode (&gBrowserFormSetList, Link);
2211 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
2212 //
2213 // Remove maintain backup list after discard except for the current using FormSet.
2214 //
2215 RemoveEntryList (&LocalFormSet->Link);
2216 DestroyFormSet (LocalFormSet);
2217 }
2218 }
2219 }
2220
2221 return EFI_SUCCESS;
2222 }
2223
2224 /**
2225 Submit data based on the input Setting level (Form, FormSet or System).
2226
2227 @param FormSet FormSet data structure.
2228 @param Form Form data structure.
2229 @param SettingScope Setting Scope for Submit action.
2230
2231 @retval EFI_SUCCESS The function completed successfully.
2232 @retval EFI_UNSUPPORTED Unsupport SettingScope.
2233
2234 **/
2235 EFI_STATUS
2236 SubmitForm (
2237 IN FORM_BROWSER_FORMSET *FormSet,
2238 IN FORM_BROWSER_FORM *Form,
2239 IN BROWSER_SETTING_SCOPE SettingScope
2240 )
2241 {
2242 EFI_STATUS Status;
2243 LIST_ENTRY *Link;
2244 EFI_STRING ConfigResp;
2245 EFI_STRING Progress;
2246 FORMSET_STORAGE *Storage;
2247 UINTN BufferSize;
2248 UINT8 *TmpBuf;
2249 FORM_BROWSER_FORMSET *LocalFormSet;
2250 FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;
2251
2252 //
2253 // Check the supported setting level.
2254 //
2255 if (SettingScope >= MaxLevel) {
2256 return EFI_UNSUPPORTED;
2257 }
2258
2259 //
2260 // Validate the Form by NoSubmit check
2261 //
2262 Status = EFI_SUCCESS;
2263 if (SettingScope == FormLevel) {
2264 Status = NoSubmitCheck (FormSet, Form);
2265 } else if (SettingScope == FormSetLevel) {
2266 Status = NoSubmitCheck (FormSet, NULL);
2267 }
2268 if (EFI_ERROR (Status)) {
2269 return Status;
2270 }
2271
2272 if (SettingScope == FormLevel && Form->NvUpdateRequired) {
2273 ConfigInfo = NULL;
2274 Link = GetFirstNode (&Form->ConfigRequestHead);
2275 while (!IsNull (&Form->ConfigRequestHead, Link)) {
2276 ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);
2277 Link = GetNextNode (&Form->ConfigRequestHead, Link);
2278
2279 Storage = ConfigInfo->Storage;
2280 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2281 continue;
2282 }
2283
2284 //
2285 // Skip if there is no RequestElement
2286 //
2287 if (ConfigInfo->ElementCount == 0) {
2288 continue;
2289 }
2290
2291 //
2292 // 1. Prepare <ConfigResp>
2293 //
2294 Status = StorageToConfigResp (ConfigInfo, &ConfigResp, TRUE);
2295 if (EFI_ERROR (Status)) {
2296 return Status;
2297 }
2298
2299 //
2300 // 2. Set value to hii driver or efi variable.
2301 //
2302 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
2303 Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2304 //
2305 // Send <ConfigResp> to Configuration Driver
2306 //
2307 if (FormSet->ConfigAccess != NULL) {
2308 Status = FormSet->ConfigAccess->RouteConfig (
2309 FormSet->ConfigAccess,
2310 ConfigResp,
2311 &Progress
2312 );
2313 if (EFI_ERROR (Status)) {
2314 FreePool (ConfigResp);
2315 return Status;
2316 }
2317 }
2318 } else if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
2319 TmpBuf = NULL;
2320 TmpBuf = AllocateZeroPool(Storage->Size);
2321 if (TmpBuf == NULL) {
2322 Status = EFI_OUT_OF_RESOURCES;
2323 return Status;
2324 }
2325
2326 BufferSize = Storage->Size;
2327 Status = gRT->GetVariable (
2328 Storage->Name,
2329 &Storage->Guid,
2330 NULL,
2331 &BufferSize,
2332 TmpBuf
2333 );
2334 if (EFI_ERROR (Status)) {
2335 FreePool (TmpBuf);
2336 FreePool (ConfigResp);
2337 return Status;
2338 }
2339 ASSERT (BufferSize == Storage->Size);
2340 Status = mHiiConfigRouting->ConfigToBlock (
2341 mHiiConfigRouting,
2342 ConfigResp,
2343 TmpBuf,
2344 &BufferSize,
2345 &Progress
2346 );
2347 if (EFI_ERROR (Status)) {
2348 FreePool (TmpBuf);
2349 FreePool (ConfigResp);
2350 return Status;
2351 }
2352
2353 Status = gRT->SetVariable (
2354 Storage->Name,
2355 &Storage->Guid,
2356 Storage->Attributes,
2357 Storage->Size,
2358 TmpBuf
2359 );
2360 FreePool (TmpBuf);
2361 if (EFI_ERROR (Status)) {
2362 FreePool (ConfigResp);
2363 return Status;
2364 }
2365 }
2366 FreePool (ConfigResp);
2367 //
2368 // 3. Config success, update storage shadow Buffer, only update the data belong to this form.
2369 //
2370 SynchronizeStorageForForm(FormSet, ConfigInfo, TRUE);
2371 }
2372
2373 //
2374 // 4. Update the NV flag.
2375 //
2376 Form->NvUpdateRequired = FALSE;
2377 } else if (SettingScope == FormSetLevel && IsNvUpdateRequired(FormSet)) {
2378 //
2379 // Submit Buffer storage or Name/Value storage
2380 //
2381 Link = GetFirstNode (&FormSet->StorageListHead);
2382 while (!IsNull (&FormSet->StorageListHead, Link)) {
2383 Storage = FORMSET_STORAGE_FROM_LINK (Link);
2384 Link = GetNextNode (&FormSet->StorageListHead, Link);
2385
2386 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
2387 continue;
2388 }
2389
2390 //
2391 // Skip if there is no RequestElement
2392 //
2393 if (Storage->ElementCount == 0) {
2394 continue;
2395 }
2396
2397 //
2398 // 1. Prepare <ConfigResp>
2399 //
2400 Status = StorageToConfigResp (Storage, &ConfigResp, FALSE);
2401 if (EFI_ERROR (Status)) {
2402 return Status;
2403 }
2404
2405 if (Storage->Type == EFI_HII_VARSTORE_BUFFER ||
2406 Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {
2407
2408 //
2409 // 2. Send <ConfigResp> to Configuration Driver
2410 //
2411 if (FormSet->ConfigAccess != NULL) {
2412 Status = FormSet->ConfigAccess->RouteConfig (
2413 FormSet->ConfigAccess,
2414 ConfigResp,
2415 &Progress
2416 );
2417 if (EFI_ERROR (Status)) {
2418 FreePool (ConfigResp);
2419 return Status;
2420 }
2421 }
2422 } else if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
2423 //
2424 // 1&2. Set the edit data to the variable.
2425 //
2426 TmpBuf = NULL;
2427 TmpBuf = AllocateZeroPool (Storage->Size);
2428 if (TmpBuf == NULL) {
2429 Status = EFI_OUT_OF_RESOURCES;
2430 return Status;
2431 }
2432 BufferSize = Storage->Size;
2433 Status = gRT->GetVariable (
2434 Storage->Name,
2435 &Storage->Guid,
2436 NULL,
2437 &BufferSize,
2438 TmpBuf
2439 );
2440 ASSERT (BufferSize == Storage->Size);
2441 Status = mHiiConfigRouting->ConfigToBlock (
2442 mHiiConfigRouting,
2443 ConfigResp,
2444 TmpBuf,
2445 &BufferSize,
2446 &Progress
2447 );
2448 if (EFI_ERROR (Status)) {
2449 FreePool (TmpBuf);
2450 FreePool (ConfigResp);
2451 return Status;
2452 }
2453
2454 Status = gRT->SetVariable (
2455 Storage->Name,
2456 &Storage->Guid,
2457 Storage->Attributes,
2458 Storage->Size,
2459 TmpBuf
2460 );
2461 if (EFI_ERROR (Status)) {
2462 FreePool (TmpBuf);
2463 FreePool (ConfigResp);
2464 return Status;
2465 }
2466 FreePool (TmpBuf);
2467 }
2468 FreePool (ConfigResp);
2469 //
2470 // 3. Config success, update storage shadow Buffer
2471 //
2472 SynchronizeStorage (Storage, TRUE);
2473 }
2474
2475 //
2476 // 4. Update the NV flag.
2477 //
2478 UpdateNvInfoInForm (FormSet, FALSE);
2479 } else if (SettingScope == SystemLevel) {
2480 //
2481 // System Level Save.
2482 //
2483
2484 //
2485 // Save changed value for each FormSet in the maintain list.
2486 //
2487 Link = GetFirstNode (&gBrowserFormSetList);
2488 while (!IsNull (&gBrowserFormSetList, Link)) {
2489 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
2490 SubmitForm (LocalFormSet, NULL, FormSetLevel);
2491 Link = GetNextNode (&gBrowserFormSetList, Link);
2492 if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {
2493 //
2494 // Remove maintain backup list after save except for the current using FormSet.
2495 //
2496 RemoveEntryList (&LocalFormSet->Link);
2497 DestroyFormSet (LocalFormSet);
2498 }
2499 }
2500 }
2501
2502 return EFI_SUCCESS;
2503 }
2504
2505 /**
2506 Get Question default value from AltCfg string.
2507
2508 @param FormSet The form set.
2509 @param Question The question.
2510 @param DefaultId The default Id.
2511
2512 @retval EFI_SUCCESS Question is reset to default value.
2513
2514 **/
2515 EFI_STATUS
2516 GetDefaultValueFromAltCfg (
2517 IN FORM_BROWSER_FORMSET *FormSet,
2518 IN OUT FORM_BROWSER_STATEMENT *Question,
2519 IN UINT16 DefaultId
2520 )
2521 {
2522 BOOLEAN IsBufferStorage;
2523 BOOLEAN IsString;
2524 UINTN Length;
2525 FORMSET_STORAGE *Storage;
2526 CHAR16 *ConfigRequest;
2527 CHAR16 *Progress;
2528 CHAR16 *Result;
2529 CHAR16 *ConfigResp;
2530 CHAR16 *Value;
2531 CHAR16 *StringPtr;
2532 UINTN LengthStr;
2533 UINT8 *Dst;
2534 CHAR16 TemStr[5];
2535 UINTN Index;
2536 UINT8 DigitUint8;
2537 EFI_STATUS Status;
2538
2539 Status = EFI_NOT_FOUND;
2540 Length = 0;
2541 Dst = NULL;
2542 ConfigRequest = NULL;
2543 Result = NULL;
2544 ConfigResp = NULL;
2545 Value = NULL;
2546 Storage = Question->Storage;
2547
2548 if ((Storage == NULL) ||
2549 (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) ||
2550 (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER)) {
2551 return Status;
2552 }
2553
2554 //
2555 // Question Value is provided by Buffer Storage or NameValue Storage
2556 //
2557 if (Question->BufferValue != NULL) {
2558 //
2559 // This Question is password or orderedlist
2560 //
2561 Dst = Question->BufferValue;
2562 } else {
2563 //
2564 // Other type of Questions
2565 //
2566 Dst = (UINT8 *) &Question->HiiValue.Value;
2567 }
2568
2569 IsBufferStorage = (BOOLEAN) ((Storage->Type == EFI_HII_VARSTORE_BUFFER) ? TRUE : FALSE);
2570 IsString = (BOOLEAN) ((Question->HiiValue.Type == EFI_IFR_TYPE_STRING) ? TRUE : FALSE);
2571
2572 //
2573 // <ConfigRequest> ::= <ConfigHdr> + <BlockName> ||
2574 // <ConfigHdr> + "&" + <VariableName>
2575 //
2576 if (IsBufferStorage) {
2577 Length = StrLen (Storage->ConfigHdr);
2578 Length += StrLen (Question->BlockName);
2579 } else {
2580 Length = StrLen (Storage->ConfigHdr);
2581 Length += StrLen (Question->VariableName) + 1;
2582 }
2583 ConfigRequest = AllocateZeroPool ((Length + 1) * sizeof (CHAR16));
2584 ASSERT (ConfigRequest != NULL);
2585
2586 StrCpy (ConfigRequest, Storage->ConfigHdr);
2587 if (IsBufferStorage) {
2588 StrCat (ConfigRequest, Question->BlockName);
2589 } else {
2590 StrCat (ConfigRequest, L"&");
2591 StrCat (ConfigRequest, Question->VariableName);
2592 }
2593
2594 Status = FormSet->ConfigAccess->ExtractConfig (
2595 FormSet->ConfigAccess,
2596 ConfigRequest,
2597 &Progress,
2598 &Result
2599 );
2600 if (EFI_ERROR (Status)) {
2601 goto Done;
2602 }
2603
2604 //
2605 // Call ConfigRouting GetAltCfg(ConfigRoute, <ConfigResponse>, Guid, Name, DevicePath, AltCfgId, AltCfgResp)
2606 // Get the default configuration string according to the default ID.
2607 //
2608 Status = mHiiConfigRouting->GetAltConfig (
2609 mHiiConfigRouting,
2610 Result,
2611 &Storage->Guid,
2612 Storage->Name,
2613 NULL,
2614 &DefaultId, // it can be NULL to get the current setting.
2615 &ConfigResp
2616 );
2617
2618 //
2619 // The required setting can't be found. So, it is not required to be validated and set.
2620 //
2621 if (EFI_ERROR (Status)) {
2622 goto Done;
2623 }
2624
2625 //
2626 // Skip <ConfigRequest>
2627 //
2628 if (IsBufferStorage) {
2629 Value = StrStr (ConfigResp, L"&VALUE");
2630 ASSERT (Value != NULL);
2631 //
2632 // Skip "&VALUE"
2633 //
2634 Value = Value + 6;
2635 } else {
2636 Value = StrStr (ConfigResp, Question->VariableName);
2637 ASSERT (Value != NULL);
2638
2639 Value = Value + StrLen (Question->VariableName);
2640 }
2641 if (*Value != '=') {
2642 Status = EFI_NOT_FOUND;
2643 goto Done;
2644 }
2645 //
2646 // Skip '=', point to value
2647 //
2648 Value = Value + 1;
2649
2650 //
2651 // Suppress <AltResp> if any
2652 //
2653 StringPtr = Value;
2654 while (*StringPtr != L'\0' && *StringPtr != L'&') {
2655 StringPtr++;
2656 }
2657 *StringPtr = L'\0';
2658
2659 LengthStr = StrLen (Value);
2660 if (!IsBufferStorage && IsString) {
2661 StringPtr = (CHAR16 *) Dst;
2662 ZeroMem (TemStr, sizeof (TemStr));
2663 for (Index = 0; Index < LengthStr; Index += 4) {
2664 StrnCpy (TemStr, Value + Index, 4);
2665 StringPtr[Index/4] = (CHAR16) StrHexToUint64 (TemStr);
2666 }
2667 //
2668 // Add tailing L'\0' character
2669 //
2670 StringPtr[Index/4] = L'\0';
2671 } else {
2672 ZeroMem (TemStr, sizeof (TemStr));
2673 for (Index = 0; Index < LengthStr; Index ++) {
2674 TemStr[0] = Value[LengthStr - Index - 1];
2675 DigitUint8 = (UINT8) StrHexToUint64 (TemStr);
2676 if ((Index & 1) == 0) {
2677 Dst [Index/2] = DigitUint8;
2678 } else {
2679 Dst [Index/2] = (UINT8) ((DigitUint8 << 4) + Dst [Index/2]);
2680 }
2681 }
2682 }
2683
2684 Done:
2685 if (ConfigRequest != NULL){
2686 FreePool (ConfigRequest);
2687 }
2688
2689 if (ConfigResp != NULL) {
2690 FreePool (ConfigResp);
2691 }
2692
2693 if (Result != NULL) {
2694 FreePool (Result);
2695 }
2696
2697 return Status;
2698 }
2699
2700 /**
2701 Get default Id value used for browser.
2702
2703 @param DefaultId The default id value used by hii.
2704
2705 @retval Browser used default value.
2706
2707 **/
2708 INTN
2709 GetDefaultIdForCallBack (
2710 UINTN DefaultId
2711 )
2712 {
2713 if (DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) {
2714 return EFI_BROWSER_ACTION_DEFAULT_STANDARD;
2715 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
2716 return EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING;
2717 } else if (DefaultId == EFI_HII_DEFAULT_CLASS_SAFE) {
2718 return EFI_BROWSER_ACTION_DEFAULT_SAFE;
2719 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN + 0x1000) {
2720 return EFI_BROWSER_ACTION_DEFAULT_PLATFORM + DefaultId - EFI_HII_DEFAULT_CLASS_PLATFORM_BEGIN;
2721 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN + 0x1000) {
2722 return EFI_BROWSER_ACTION_DEFAULT_HARDWARE + DefaultId - EFI_HII_DEFAULT_CLASS_HARDWARE_BEGIN;
2723 } else if (DefaultId >= EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN && DefaultId < EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN + 0x1000) {
2724 return EFI_BROWSER_ACTION_DEFAULT_FIRMWARE + DefaultId - EFI_HII_DEFAULT_CLASS_FIRMWARE_BEGIN;
2725 } else {
2726 return -1;
2727 }
2728 }
2729
2730 /**
2731 Reset Question to its default value.
2732
2733 @param FormSet The form set.
2734 @param Form The form.
2735 @param Question The question.
2736 @param DefaultId The Class of the default.
2737
2738 @retval EFI_SUCCESS Question is reset to default value.
2739
2740 **/
2741 EFI_STATUS
2742 GetQuestionDefault (
2743 IN FORM_BROWSER_FORMSET *FormSet,
2744 IN FORM_BROWSER_FORM *Form,
2745 IN FORM_BROWSER_STATEMENT *Question,
2746 IN UINT16 DefaultId
2747 )
2748 {
2749 EFI_STATUS Status;
2750 LIST_ENTRY *Link;
2751 QUESTION_DEFAULT *Default;
2752 QUESTION_OPTION *Option;
2753 EFI_HII_VALUE *HiiValue;
2754 UINT8 Index;
2755 EFI_STRING StrValue;
2756 EFI_HII_CONFIG_ACCESS_PROTOCOL *ConfigAccess;
2757 EFI_BROWSER_ACTION_REQUEST ActionRequest;
2758 INTN Action;
2759
2760 Status = EFI_NOT_FOUND;
2761 StrValue = NULL;
2762
2763 //
2764 // Statement don't have storage, skip them
2765 //
2766 if (Question->QuestionId == 0) {
2767 return Status;
2768 }
2769
2770 //
2771 // There are Five ways to specify default value for a Question:
2772 // 1, use call back function (highest priority)
2773 // 2, use ExtractConfig function
2774 // 3, use nested EFI_IFR_DEFAULT
2775 // 4, set flags of EFI_ONE_OF_OPTION (provide Standard and Manufacturing default)
2776 // 5, set flags of EFI_IFR_CHECKBOX (provide Standard and Manufacturing default) (lowest priority)
2777 //
2778 HiiValue = &Question->HiiValue;
2779
2780 //
2781 // Get Question defaut value from call back function.
2782 //
2783 ConfigAccess = FormSet->ConfigAccess;
2784 Action = GetDefaultIdForCallBack (DefaultId);
2785 if ((Action > 0) && ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) && (ConfigAccess != NULL)) {
2786 ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;
2787 Status = ConfigAccess->Callback (
2788 ConfigAccess,
2789 Action,
2790 Question->QuestionId,
2791 HiiValue->Type,
2792 &HiiValue->Value,
2793 &ActionRequest
2794 );
2795 if (!EFI_ERROR (Status)) {
2796 return Status;
2797 }
2798 }
2799
2800 //
2801 // Get default value from altcfg string.
2802 //
2803 if (ConfigAccess != NULL) {
2804 Status = GetDefaultValueFromAltCfg(FormSet, Question, DefaultId);
2805 if (!EFI_ERROR (Status)) {
2806 return Status;
2807 }
2808 }
2809
2810 //
2811 // EFI_IFR_DEFAULT has highest priority
2812 //
2813 if (!IsListEmpty (&Question->DefaultListHead)) {
2814 Link = GetFirstNode (&Question->DefaultListHead);
2815 while (!IsNull (&Question->DefaultListHead, Link)) {
2816 Default = QUESTION_DEFAULT_FROM_LINK (Link);
2817
2818 if (Default->DefaultId == DefaultId) {
2819 if (Default->ValueExpression != NULL) {
2820 //
2821 // Default is provided by an Expression, evaluate it
2822 //
2823 Status = EvaluateExpression (FormSet, Form, Default->ValueExpression);
2824 if (EFI_ERROR (Status)) {
2825 return Status;
2826 }
2827
2828 if (Default->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {
2829 ASSERT (HiiValue->Type == EFI_IFR_TYPE_BUFFER && Question->BufferValue != NULL);
2830 if (Question->StorageWidth > Default->ValueExpression->Result.BufferLen) {
2831 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Default->ValueExpression->Result.BufferLen);
2832 Question->HiiValue.BufferLen = Default->ValueExpression->Result.BufferLen;
2833 } else {
2834 CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Question->StorageWidth);
2835 Question->HiiValue.BufferLen = Question->StorageWidth;
2836 }
2837 FreePool (Default->ValueExpression->Result.Buffer);
2838 }
2839 HiiValue->Type = Default->ValueExpression->Result.Type;
2840 CopyMem (&HiiValue->Value, &Default->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE));
2841 } else {
2842 //
2843 // Default value is embedded in EFI_IFR_DEFAULT
2844 //
2845 CopyMem (HiiValue, &Default->Value, sizeof (EFI_HII_VALUE));
2846 }
2847
2848 if (HiiValue->Type == EFI_IFR_TYPE_STRING) {
2849 StrValue = HiiGetString (FormSet->HiiHandle, HiiValue->Value.string, NULL);
2850 if (StrValue == NULL) {
2851 return EFI_NOT_FOUND;
2852 }
2853 if (Question->StorageWidth > StrSize (StrValue)) {
2854 CopyMem (Question->BufferValue, StrValue, StrSize (StrValue));
2855 } else {
2856 CopyMem (Question->BufferValue, StrValue, Question->StorageWidth);
2857 }
2858 }
2859
2860 return EFI_SUCCESS;
2861 }
2862
2863 Link = GetNextNode (&Question->DefaultListHead, Link);
2864 }
2865 }
2866
2867 //
2868 // EFI_ONE_OF_OPTION
2869 //
2870 if ((Question->Operand == EFI_IFR_ONE_OF_OP) && !IsListEmpty (&Question->OptionListHead)) {
2871 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
2872 //
2873 // OneOfOption could only provide Standard and Manufacturing default
2874 //
2875 Link = GetFirstNode (&Question->OptionListHead);
2876 while (!IsNull (&Question->OptionListHead, Link)) {
2877 Option = QUESTION_OPTION_FROM_LINK (Link);
2878
2879 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT) != 0)) ||
2880 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Option->Flags & EFI_IFR_OPTION_DEFAULT_MFG) != 0))
2881 ) {
2882 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
2883
2884 return EFI_SUCCESS;
2885 }
2886
2887 Link = GetNextNode (&Question->OptionListHead, Link);
2888 }
2889 }
2890 }
2891
2892 //
2893 // EFI_IFR_CHECKBOX - lowest priority
2894 //
2895 if (Question->Operand == EFI_IFR_CHECKBOX_OP) {
2896 if (DefaultId <= EFI_HII_DEFAULT_CLASS_MANUFACTURING) {
2897 //
2898 // Checkbox could only provide Standard and Manufacturing default
2899 //
2900 if (((DefaultId == EFI_HII_DEFAULT_CLASS_STANDARD) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT) != 0)) ||
2901 ((DefaultId == EFI_HII_DEFAULT_CLASS_MANUFACTURING) && ((Question->Flags & EFI_IFR_CHECKBOX_DEFAULT_MFG) != 0))
2902 ) {
2903 HiiValue->Value.b = TRUE;
2904 } else {
2905 HiiValue->Value.b = FALSE;
2906 }
2907
2908 return EFI_SUCCESS;
2909 }
2910 }
2911
2912 //
2913 // For Questions without default
2914 //
2915 Status = EFI_NOT_FOUND;
2916 switch (Question->Operand) {
2917 case EFI_IFR_NUMERIC_OP:
2918 //
2919 // Take minimum value as numeric default value
2920 //
2921 if ((HiiValue->Value.u64 < Question->Minimum) || (HiiValue->Value.u64 > Question->Maximum)) {
2922 HiiValue->Value.u64 = Question->Minimum;
2923 Status = EFI_SUCCESS;
2924 }
2925 break;
2926
2927 case EFI_IFR_ONE_OF_OP:
2928 //
2929 // Take first oneof option as oneof's default value
2930 //
2931 if (ValueToOption (Question, HiiValue) == NULL) {
2932 Link = GetFirstNode (&Question->OptionListHead);
2933 if (!IsNull (&Question->OptionListHead, Link)) {
2934 Option = QUESTION_OPTION_FROM_LINK (Link);
2935 CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));
2936 Status = EFI_SUCCESS;
2937 }
2938 }
2939 break;
2940
2941 case EFI_IFR_ORDERED_LIST_OP:
2942 //
2943 // Take option sequence in IFR as ordered list's default value
2944 //
2945 Index = 0;
2946 Link = GetFirstNode (&Question->OptionListHead);
2947 while (!IsNull (&Question->OptionListHead, Link)) {
2948 Status = EFI_SUCCESS;
2949 Option = QUESTION_OPTION_FROM_LINK (Link);
2950
2951 SetArrayData (Question->BufferValue, Question->ValueType, Index, Option->Value.Value.u64);
2952
2953 Index++;
2954 if (Index >= Question->MaxContainers) {
2955 break;
2956 }
2957
2958 Link = GetNextNode (&Question->OptionListHead, Link);
2959 }
2960 break;
2961
2962 default:
2963 break;
2964 }
2965
2966 return Status;
2967 }
2968
2969
2970 /**
2971 Reset Questions to their default value in a Form, Formset or System.
2972
2973 @param FormSet FormSet data structure.
2974 @param Form Form data structure.
2975 @param DefaultId The Class of the default.
2976 @param SettingScope Setting Scope for Default action.
2977
2978 @retval EFI_SUCCESS The function completed successfully.
2979 @retval EFI_UNSUPPORTED Unsupport SettingScope.
2980
2981 **/
2982 EFI_STATUS
2983 ExtractDefault (
2984 IN FORM_BROWSER_FORMSET *FormSet,
2985 IN FORM_BROWSER_FORM *Form,
2986 IN UINT16 DefaultId,
2987 IN BROWSER_SETTING_SCOPE SettingScope
2988 )
2989 {
2990 EFI_STATUS Status;
2991 LIST_ENTRY *FormLink;
2992 LIST_ENTRY *Link;
2993 FORM_BROWSER_STATEMENT *Question;
2994 FORM_BROWSER_FORMSET *BackUpFormSet;
2995 FORM_BROWSER_FORMSET *LocalFormSet;
2996 EFI_HII_HANDLE *HiiHandles;
2997 UINTN Index;
2998 EFI_GUID ZeroGuid;
2999
3000 //
3001 // Check the supported setting level.
3002 //
3003 if (SettingScope >= MaxLevel) {
3004 return EFI_UNSUPPORTED;
3005 }
3006
3007 if (SettingScope == FormLevel) {
3008 //
3009 // Extract Form default
3010 //
3011 Link = GetFirstNode (&Form->StatementListHead);
3012 while (!IsNull (&Form->StatementListHead, Link)) {
3013 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
3014 Link = GetNextNode (&Form->StatementListHead, Link);
3015
3016 //
3017 // If Question is disabled, don't reset it to default
3018 //
3019 if (Question->Expression != NULL) {
3020 if (EvaluateExpressionList(Question->Expression, TRUE, FormSet, Form) == ExpressDisable) {
3021 continue;
3022 }
3023 }
3024
3025 //
3026 // Reset Question to its default value
3027 //
3028 Status = GetQuestionDefault (FormSet, Form, Question, DefaultId);
3029 if (EFI_ERROR (Status)) {
3030 continue;
3031 }
3032
3033 //
3034 // Synchronize Buffer storage's Edit buffer
3035 //
3036 if ((Question->Storage != NULL) &&
3037 (Question->Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE)) {
3038 SetQuestionValue (FormSet, Form, Question, TRUE);
3039 //
3040 // Update Form NV flag.
3041 //
3042 Form->NvUpdateRequired = TRUE;
3043 }
3044 }
3045 } else if (SettingScope == FormSetLevel) {
3046 FormLink = GetFirstNode (&FormSet->FormListHead);
3047 while (!IsNull (&FormSet->FormListHead, FormLink)) {
3048 Form = FORM_BROWSER_FORM_FROM_LINK (FormLink);
3049 ExtractDefault (FormSet, Form, DefaultId, FormLevel);
3050 FormLink = GetNextNode (&FormSet->FormListHead, FormLink);
3051 }
3052 } else if (SettingScope == SystemLevel) {
3053 //
3054 // Open all FormSet by locate HII packages.
3055 // Initiliaze the maintain FormSet to store default data as back up data.
3056 //
3057 BackUpFormSet = gOldFormSet;
3058 gOldFormSet = NULL;
3059
3060 //
3061 // Get all the Hii handles
3062 //
3063 HiiHandles = HiiGetHiiHandles (NULL);
3064 ASSERT (HiiHandles != NULL);
3065
3066 //
3067 // Search for formset of each class type
3068 //
3069 for (Index = 0; HiiHandles[Index] != NULL; Index++) {
3070 //
3071 // Check HiiHandles[Index] does exist in global maintain list.
3072 //
3073 if (GetFormSetFromHiiHandle (HiiHandles[Index]) != NULL) {
3074 continue;
3075 }
3076
3077 //
3078 // Initilize FormSet Setting
3079 //
3080 LocalFormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));
3081 ASSERT (LocalFormSet != NULL);
3082 ZeroMem (&ZeroGuid, sizeof (ZeroGuid));
3083 Status = InitializeFormSet (HiiHandles[Index], &ZeroGuid, LocalFormSet, FALSE);
3084 if (EFI_ERROR (Status) || IsListEmpty (&LocalFormSet->FormListHead)) {
3085 DestroyFormSet (LocalFormSet);
3086 continue;
3087 }
3088 Status = InitializeCurrentSetting (LocalFormSet);
3089 if (EFI_ERROR (Status)) {
3090 DestroyFormSet (LocalFormSet);
3091 continue;
3092 }
3093 //
3094 // Initilize Questions' Value
3095 //
3096 LoadFormSetConfig (NULL, LocalFormSet);
3097 if (EFI_ERROR (Status)) {
3098 DestroyFormSet (LocalFormSet);
3099 continue;
3100 }
3101
3102 //
3103 // Add FormSet into the maintain list.
3104 //
3105 InsertTailList (&gBrowserFormSetList, &LocalFormSet->Link);
3106 }
3107
3108 //
3109 // Free resources, and restore gOldFormSet and gClassOfVfr
3110 //
3111 FreePool (HiiHandles);
3112 gOldFormSet = BackUpFormSet;
3113
3114 //
3115 // Set Default Value for each FormSet in the maintain list.
3116 //
3117 Link = GetFirstNode (&gBrowserFormSetList);
3118 while (!IsNull (&gBrowserFormSetList, Link)) {
3119 LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
3120 ExtractDefault (LocalFormSet, NULL, DefaultId, FormSetLevel);
3121 Link = GetNextNode (&gBrowserFormSetList, Link);
3122 }
3123 }
3124
3125 return EFI_SUCCESS;
3126 }
3127
3128 /**
3129 Initialize Question's Edit copy from Storage.
3130
3131 @param Selection Selection contains the information about
3132 the Selection, form and formset to be displayed.
3133 Selection action may be updated in retrieve callback.
3134 If Selection is NULL, only initialize Question value.
3135 @param FormSet FormSet data structure.
3136 @param Form Form data structure.
3137
3138 @retval EFI_SUCCESS The function completed successfully.
3139
3140 **/
3141 EFI_STATUS
3142 LoadFormConfig (
3143 IN OUT UI_MENU_SELECTION *Selection,
3144 IN FORM_BROWSER_FORMSET *FormSet,
3145 IN FORM_BROWSER_FORM *Form
3146 )
3147 {
3148 EFI_STATUS Status;
3149 LIST_ENTRY *Link;
3150 FORM_BROWSER_STATEMENT *Question;
3151 UINT8 *BufferValue;
3152 UINTN StorageWidth;
3153
3154 Link = GetFirstNode (&Form->StatementListHead);
3155 while (!IsNull (&Form->StatementListHead, Link)) {
3156 Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);
3157
3158 //
3159 // Initialize local copy of Value for each Question
3160 //
3161 Status = GetQuestionValue (FormSet, Form, Question, TRUE);
3162 if (EFI_ERROR (Status)) {
3163 return Status;
3164 }
3165
3166 if ((Question->Operand == EFI_IFR_STRING_OP) || (Question->Operand == EFI_IFR_PASSWORD_OP)) {
3167 HiiSetString (FormSet->HiiHandle, Question->HiiValue.Value.string, (CHAR16*)Question->BufferValue, NULL);
3168 }
3169
3170 //
3171 // According the spec, ref opcode try to get value from call back with "retrieve" type.
3172 //
3173 if ((Question->Operand == EFI_IFR_REF_OP) && (FormSet->ConfigAccess != NULL) && (Selection != NULL)) {
3174 Status = ProcessCallBackFunction(Selection, Question, EFI_BROWSER_ACTION_RETRIEVE, TRUE);
3175 if (EFI_ERROR (Status)) {
3176 return Status;
3177 }
3178 }
3179
3180 //
3181 // Check whether EfiVarstore with CallBack can be got.
3182 //
3183 if ((FormSet->ConfigAccess != NULL) &&
3184 (Selection != NULL) &&
3185 (Selection->Action != UI_ACTION_REFRESH_FORMSET) &&
3186 (Question->QuestionId != 0) &&
3187 (Question->Storage != NULL) &&
3188 (Question->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) &&
3189 ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) == EFI_IFR_FLAG_CALLBACK)) {
3190
3191 //
3192 // Check QuestionValue does exist.
3193 //
3194 StorageWidth = Question->StorageWidth;
3195 if (Question->BufferValue != NULL) {
3196 BufferValue = Question->BufferValue;
3197 } else {
3198 BufferValue = (UINT8 *) &Question->HiiValue.Value;
3199 }
3200 Status = gRT->GetVariable (
3201 Question->VariableName,
3202 &Question->Storage->Guid,
3203 NULL,
3204 &StorageWidth,
3205 BufferValue
3206 );
3207
3208 if (!EFI_ERROR (Status)) {
3209 Status = ProcessCallBackFunction(Selection, Question, EFI_BROWSER_ACTION_RETRIEVE, TRUE);
3210 }
3211 }
3212
3213 Link = GetNextNode (&Form->StatementListHead, Link);
3214 }
3215
3216 return EFI_SUCCESS;
3217 }
3218
3219 /**
3220 Initialize Question's Edit copy from Storage for the whole Formset.
3221
3222 @param Selection Selection contains the information about
3223 the Selection, form and formset to be displayed.
3224 Selection action may be updated in retrieve callback.
3225 If Selection is NULL, only initialize Question value.
3226 @param FormSet FormSet data structure.
3227
3228 @retval EFI_SUCCESS The function completed successfully.
3229
3230 **/
3231 EFI_STATUS
3232 LoadFormSetConfig (
3233 IN OUT UI_MENU_SELECTION *Selection,
3234 IN FORM_BROWSER_FORMSET *FormSet
3235 )
3236 {
3237 EFI_STATUS Status;
3238 LIST_ENTRY *Link;
3239 FORM_BROWSER_FORM *Form;
3240
3241 Link = GetFirstNode (&FormSet->FormListHead);
3242 while (!IsNull (&FormSet->FormListHead, Link)) {
3243 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
3244
3245 //
3246 // Initialize local copy of Value for each Form
3247 //
3248 Status = LoadFormConfig (Selection, FormSet, Form);
3249 if (EFI_ERROR (Status)) {
3250 return Status;
3251 }
3252
3253 Link = GetNextNode (&FormSet->FormListHead, Link);
3254 }
3255
3256 return EFI_SUCCESS;
3257 }
3258
3259 /**
3260 Fill storage's edit copy with settings requested from Configuration Driver.
3261
3262 @param FormSet FormSet data structure.
3263 @param Storage Buffer Storage.
3264
3265 @retval EFI_SUCCESS The function completed successfully.
3266
3267 **/
3268 EFI_STATUS
3269 LoadStorage (
3270 IN FORM_BROWSER_FORMSET *FormSet,
3271 IN FORMSET_STORAGE *Storage
3272 )
3273 {
3274 EFI_STATUS Status;
3275 EFI_STRING Progress;
3276 EFI_STRING Result;
3277 CHAR16 *StrPtr;
3278
3279 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {
3280 return EFI_SUCCESS;
3281 }
3282
3283 if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {
3284 Status = gRT->GetVariable (
3285 Storage->Name,
3286 &Storage->Guid,
3287 NULL,
3288 (UINTN*)&Storage->Size,
3289 Storage->EditBuffer
3290 );
3291 return Status;
3292 }
3293
3294 if (FormSet->ConfigAccess == NULL) {
3295 return EFI_NOT_FOUND;
3296 }
3297
3298 if (Storage->ElementCount == 0) {
3299 //
3300 // Skip if there is no RequestElement
3301 //
3302 return EFI_SUCCESS;
3303 }
3304
3305 //
3306 // Request current settings from Configuration Driver
3307 //
3308 Status = FormSet->ConfigAccess->ExtractConfig (
3309 FormSet->ConfigAccess,
3310 Storage->ConfigRequest,
3311 &Progress,
3312 &Result
3313 );
3314 if (EFI_ERROR (Status)) {
3315 return Status;
3316 }
3317
3318 //
3319 // Convert Result from <ConfigAltResp> to <ConfigResp>
3320 //
3321 StrPtr = StrStr (Result, L"ALTCFG");
3322 if (StrPtr != NULL) {
3323 *StrPtr = L'\0';
3324 }
3325
3326 Status = ConfigRespToStorage (Storage, Result);
3327 FreePool (Result);
3328 return Status;
3329 }
3330
3331
3332 /**
3333 Copy uncommitted data from source Storage to destination Storage.
3334
3335 @param Dst Target Storage for uncommitted data.
3336 @param Src Source Storage for uncommitted data.
3337
3338 @retval EFI_SUCCESS The function completed successfully.
3339 @retval EFI_INVALID_PARAMETER Source and destination Storage is not the same type.
3340
3341 **/
3342 EFI_STATUS
3343 CopyStorage (
3344 IN OUT FORMSET_STORAGE *Dst,
3345 IN FORMSET_STORAGE *Src
3346 )
3347 {
3348 LIST_ENTRY *Link;
3349 NAME_VALUE_NODE *Node;
3350
3351 if ((Dst->Type != Src->Type) || (Dst->Size != Src->Size)) {
3352 return EFI_INVALID_PARAMETER;
3353 }
3354
3355 switch (Src->Type) {
3356 case EFI_HII_VARSTORE_BUFFER:
3357 case EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER:
3358 CopyMem (Dst->EditBuffer, Src->EditBuffer, Src->Size);
3359 CopyMem (Dst->Buffer, Src->Buffer, Src->Size);
3360 break;
3361
3362 case EFI_HII_VARSTORE_NAME_VALUE:
3363 Link = GetFirstNode (&Src->NameValueListHead);
3364 while (!IsNull (&Src->NameValueListHead, Link)) {
3365 Node = NAME_VALUE_NODE_FROM_LINK (Link);
3366
3367 SetValueByName (Dst, Node->Name, Node->EditValue, TRUE);
3368 SetValueByName (Dst, Node->Name, Node->Value, FALSE);
3369
3370 Link = GetNextNode (&Src->NameValueListHead, Link);
3371 }
3372 break;
3373
3374 case EFI_HII_VARSTORE_EFI_VARIABLE:
3375 default:
3376 break;
3377 }
3378
3379 return EFI_SUCCESS;
3380 }
3381
3382
3383 /**
3384 Get current setting of Questions.
3385
3386 @param FormSet FormSet data structure.
3387
3388 @retval EFI_SUCCESS The function completed successfully.
3389
3390 **/
3391 EFI_STATUS
3392 InitializeCurrentSetting (
3393 IN OUT FORM_BROWSER_FORMSET *FormSet
3394 )
3395 {
3396 LIST_ENTRY *Link;
3397 LIST_ENTRY *Link2;
3398 FORMSET_STORAGE *Storage;
3399 FORMSET_STORAGE *StorageSrc;
3400 FORMSET_STORAGE *OldStorage;
3401 FORM_BROWSER_FORM *Form;
3402 FORM_BROWSER_FORM *Form2;
3403 EFI_STATUS Status;
3404
3405 //
3406 // Extract default from IFR binary
3407 //
3408 ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel);
3409 UpdateNvInfoInForm (FormSet, FALSE);
3410
3411 //
3412 // Request current settings from Configuration Driver
3413 //
3414 Link = GetFirstNode (&FormSet->StorageListHead);
3415 while (!IsNull (&FormSet->StorageListHead, Link)) {
3416 Storage = FORMSET_STORAGE_FROM_LINK (Link);
3417
3418 OldStorage = NULL;
3419 if (gOldFormSet != NULL) {
3420 //
3421 // Try to find the Storage in backup formset gOldFormSet
3422 //
3423 Link2 = GetFirstNode (&gOldFormSet->StorageListHead);
3424 while (!IsNull (&gOldFormSet->StorageListHead, Link2)) {
3425 StorageSrc = FORMSET_STORAGE_FROM_LINK (Link2);
3426
3427 if (StorageSrc->VarStoreId == Storage->VarStoreId) {
3428 OldStorage = StorageSrc;
3429 break;
3430 }
3431
3432 Link2 = GetNextNode (&gOldFormSet->StorageListHead, Link2);
3433 }
3434 }
3435
3436 if (OldStorage == NULL) {
3437 //
3438 // Storage is not found in backup formset, request it from ConfigDriver
3439 //
3440 Status = LoadStorage (FormSet, Storage);
3441 //
3442 // Now Edit Buffer is filled with default values(lower priority) and current
3443 // settings(higher priority), sychronize it to shadow Buffer
3444 //
3445 if (!EFI_ERROR (Status)) {
3446 SynchronizeStorage (Storage, TRUE);
3447 }
3448 } else {
3449 //
3450 // Storage found in backup formset, use it
3451 //
3452 Status = CopyStorage (Storage, OldStorage);
3453 }
3454
3455 Link = GetNextNode (&FormSet->StorageListHead, Link);
3456 }
3457
3458 //
3459 // If has old formset, get the old nv update status.
3460 //
3461 if (gOldFormSet != NULL) {
3462 Link = GetFirstNode (&FormSet->FormListHead);
3463 while (!IsNull (&FormSet->FormListHead, Link)) {
3464 Form = FORM_BROWSER_FORM_FROM_LINK (Link);
3465
3466 Link2 = GetFirstNode (&gOldFormSet->FormListHead);
3467 while (!IsNull (&gOldFormSet->FormListHead, Link2)) {
3468 Form2 = FORM_BROWSER_FORM_FROM_LINK (Link2);
3469
3470 if (Form->FormId == Form2->FormId) {
3471 Form->NvUpdateRequired = Form2->NvUpdateRequired;
3472 break;
3473 }
3474
3475 Link2 = GetNextNode (&gOldFormSet->FormListHead, Link2);
3476 }
3477 Link = GetNextNode (&FormSet->FormListHead, Link);
3478 }
3479 }
3480
3481 return EFI_SUCCESS;
3482 }
3483
3484
3485 /**
3486 Fetch the Ifr binary data of a FormSet.
3487
3488 @param Handle PackageList Handle
3489 @param FormSetGuid On input, GUID or class GUID of a formset. If not
3490 specified (NULL or zero GUID), take the first
3491 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
3492 found in package list.
3493 On output, GUID of the formset found(if not NULL).
3494 @param BinaryLength The length of the FormSet IFR binary.
3495 @param BinaryData The buffer designed to receive the FormSet.
3496
3497 @retval EFI_SUCCESS Buffer filled with the requested FormSet.
3498 BufferLength was updated.
3499 @retval EFI_INVALID_PARAMETER The handle is unknown.
3500 @retval EFI_NOT_FOUND A form or FormSet on the requested handle cannot
3501 be found with the requested FormId.
3502
3503 **/
3504 EFI_STATUS
3505 GetIfrBinaryData (
3506 IN EFI_HII_HANDLE Handle,
3507 IN OUT EFI_GUID *FormSetGuid,
3508 OUT UINTN *BinaryLength,
3509 OUT UINT8 **BinaryData
3510 )
3511 {
3512 EFI_STATUS Status;
3513 EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList;
3514 UINTN BufferSize;
3515 UINT8 *Package;
3516 UINT8 *OpCodeData;
3517 UINT32 Offset;
3518 UINT32 Offset2;
3519 UINT32 PackageListLength;
3520 EFI_HII_PACKAGE_HEADER PackageHeader;
3521 UINT8 Index;
3522 UINT8 NumberOfClassGuid;
3523 BOOLEAN ClassGuidMatch;
3524 EFI_GUID *ClassGuid;
3525 EFI_GUID *ComparingGuid;
3526
3527 OpCodeData = NULL;
3528 Package = NULL;
3529 ZeroMem (&PackageHeader, sizeof (EFI_HII_PACKAGE_HEADER));
3530
3531 //
3532 // if FormSetGuid is NULL or zero GUID, return first Setup FormSet in the package list
3533 //
3534 if (FormSetGuid == NULL) {
3535 ComparingGuid = &gZeroGuid;
3536 } else {
3537 ComparingGuid = FormSetGuid;
3538 }
3539
3540 //
3541 // Get HII PackageList
3542 //
3543 BufferSize = 0;
3544 HiiPackageList = NULL;
3545 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
3546 if (Status == EFI_BUFFER_TOO_SMALL) {
3547 HiiPackageList = AllocatePool (BufferSize);
3548 ASSERT (HiiPackageList != NULL);
3549
3550 Status = mHiiDatabase->ExportPackageLists (mHiiDatabase, Handle, &BufferSize, HiiPackageList);
3551 }
3552 if (EFI_ERROR (Status)) {
3553 return Status;
3554 }
3555 ASSERT (HiiPackageList != NULL);
3556
3557 //
3558 // Get Form package from this HII package List
3559 //
3560 Offset = sizeof (EFI_HII_PACKAGE_LIST_HEADER);
3561 Offset2 = 0;
3562 CopyMem (&PackageListLength, &HiiPackageList->PackageLength, sizeof (UINT32));
3563
3564 ClassGuidMatch = FALSE;
3565 while (Offset < PackageListLength) {
3566 Package = ((UINT8 *) HiiPackageList) + Offset;
3567 CopyMem (&PackageHeader, Package, sizeof (EFI_HII_PACKAGE_HEADER));
3568
3569 if (PackageHeader.Type == EFI_HII_PACKAGE_FORMS) {
3570 //
3571 // Search FormSet in this Form Package
3572 //
3573 Offset2 = sizeof (EFI_HII_PACKAGE_HEADER);
3574 while (Offset2 < PackageHeader.Length) {
3575 OpCodeData = Package + Offset2;
3576
3577 if (((EFI_IFR_OP_HEADER *) OpCodeData)->OpCode == EFI_IFR_FORM_SET_OP) {
3578 //
3579 // Try to compare against formset GUID
3580 //
3581 if (CompareGuid (FormSetGuid, &gZeroGuid) ||
3582 CompareGuid (ComparingGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {
3583 break;
3584 }
3585
3586 if (((EFI_IFR_OP_HEADER *) OpCodeData)->Length > OFFSET_OF (EFI_IFR_FORM_SET, Flags)) {
3587 //
3588 // Try to compare against formset class GUID
3589 //
3590 NumberOfClassGuid = (UINT8) (((EFI_IFR_FORM_SET *) OpCodeData)->Flags & 0x3);
3591 ClassGuid = (EFI_GUID *) (OpCodeData + sizeof (EFI_IFR_FORM_SET));
3592 for (Index = 0; Index < NumberOfClassGuid; Index++) {
3593 if (CompareGuid (ComparingGuid, ClassGuid + Index)) {
3594 ClassGuidMatch = TRUE;
3595 break;
3596 }
3597 }
3598 if (ClassGuidMatch) {
3599 break;
3600 }
3601 } else if (ComparingGuid == &gEfiHiiPlatformSetupFormsetGuid) {
3602 ClassGuidMatch = TRUE;
3603 break;
3604 }
3605 }
3606
3607 Offset2 += ((EFI_IFR_OP_HEADER *) OpCodeData)->Length;
3608 }
3609
3610 if (Offset2 < PackageHeader.Length) {
3611 //
3612 // Target formset found
3613 //
3614 break;
3615 }
3616 }
3617
3618 Offset += PackageHeader.Length;
3619 }
3620
3621 if (Offset >= PackageListLength) {
3622 //
3623 // Form package not found in this Package List
3624 //
3625 FreePool (HiiPackageList);
3626 return EFI_NOT_FOUND;
3627 }
3628
3629 if (FormSetGuid != NULL) {
3630 //
3631 // Return the FormSet GUID
3632 //
3633 CopyMem (FormSetGuid, &((EFI_IFR_FORM_SET *) OpCodeData)->Guid, sizeof (EFI_GUID));
3634 }
3635
3636 //
3637 // To determine the length of a whole FormSet IFR binary, one have to parse all the Opcodes
3638 // in this FormSet; So, here just simply copy the data from start of a FormSet to the end
3639 // of the Form Package.
3640 //
3641 *BinaryLength = PackageHeader.Length - Offset2;
3642 *BinaryData = AllocateCopyPool (*BinaryLength, OpCodeData);
3643
3644 FreePool (HiiPackageList);
3645
3646 if (*BinaryData == NULL) {
3647 return EFI_OUT_OF_RESOURCES;
3648 }
3649
3650 return EFI_SUCCESS;
3651 }
3652
3653
3654 /**
3655 Initialize the internal data structure of a FormSet.
3656
3657 @param Handle PackageList Handle
3658 @param FormSetGuid On input, GUID or class GUID of a formset. If not
3659 specified (NULL or zero GUID), take the first
3660 FormSet with class GUID EFI_HII_PLATFORM_SETUP_FORMSET_GUID
3661 found in package list.
3662 On output, GUID of the formset found(if not NULL).
3663 @param FormSet FormSet data structure.
3664 @param UpdateGlobalVar Whether need to update the global variable.
3665
3666 @retval EFI_SUCCESS The function completed successfully.
3667 @retval EFI_NOT_FOUND The specified FormSet could not be found.
3668
3669 **/
3670 EFI_STATUS
3671 InitializeFormSet (
3672 IN EFI_HII_HANDLE Handle,
3673 IN OUT EFI_GUID *FormSetGuid,
3674 OUT FORM_BROWSER_FORMSET *FormSet,
3675 IN BOOLEAN UpdateGlobalVar
3676 )
3677 {
3678 EFI_STATUS Status;
3679 EFI_HANDLE DriverHandle;
3680 UINT16 Index;
3681
3682 Status = GetIfrBinaryData (Handle, FormSetGuid, &FormSet->IfrBinaryLength, &FormSet->IfrBinaryData);
3683 if (EFI_ERROR (Status)) {
3684 return Status;
3685 }
3686
3687 FormSet->Signature = FORM_BROWSER_FORMSET_SIGNATURE;
3688 FormSet->HiiHandle = Handle;
3689 CopyMem (&FormSet->Guid, FormSetGuid, sizeof (EFI_GUID));
3690
3691 //
3692 // Retrieve ConfigAccess Protocol associated with this HiiPackageList
3693 //
3694 Status = mHiiDatabase->GetPackageListHandle (mHiiDatabase, Handle, &DriverHandle);
3695 if (EFI_ERROR (Status)) {
3696 return Status;
3697 }
3698 FormSet->DriverHandle = DriverHandle;
3699 Status = gBS->HandleProtocol (
3700 DriverHandle,
3701 &gEfiHiiConfigAccessProtocolGuid,
3702 (VOID **) &FormSet->ConfigAccess
3703 );
3704 if (EFI_ERROR (Status)) {
3705 //
3706 // Configuration Driver don't attach ConfigAccess protocol to its HII package
3707 // list, then there will be no configuration action required
3708 //
3709 FormSet->ConfigAccess = NULL;
3710 }
3711
3712 //
3713 // Parse the IFR binary OpCodes
3714 //
3715 Status = ParseOpCodes (FormSet);
3716 if (EFI_ERROR (Status)) {
3717 return Status;
3718 }
3719
3720 //
3721 // If not need to update the global variable, just return.
3722 //
3723 if (!UpdateGlobalVar) {
3724 return Status;
3725 }
3726
3727 //
3728 // Set VFR type by FormSet SubClass field
3729 //
3730 gClassOfVfr = FORMSET_CLASS_PLATFORM_SETUP;
3731 if (FormSet->SubClass == EFI_FRONT_PAGE_SUBCLASS) {
3732 gClassOfVfr = FORMSET_CLASS_FRONT_PAGE;
3733 }
3734
3735 //
3736 // Set VFR type by FormSet class guid
3737 //
3738 for (Index = 0; Index < 3; Index ++) {
3739 if (CompareGuid (&FormSet->ClassGuid[Index], &gEfiHiiPlatformSetupFormsetGuid)) {
3740 gClassOfVfr |= FORMSET_CLASS_PLATFORM_SETUP;
3741 break;
3742 }
3743 }
3744
3745 if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE) {
3746 gFrontPageHandle = FormSet->HiiHandle;
3747 gFunctionKeySetting = NONE_FUNCTION_KEY_SETTING;
3748 }
3749
3750 //
3751 // Match GUID to find out the function key setting. If match fail, use the default setting.
3752 //
3753 for (Index = 0; Index < sizeof (gFunctionKeySettingTable) / sizeof (FUNCTIION_KEY_SETTING); Index++) {
3754 if (CompareGuid (&FormSet->Guid, &(gFunctionKeySettingTable[Index].FormSetGuid))) {
3755 //
3756 // Update the function key setting.
3757 //
3758 gFunctionKeySetting = gFunctionKeySettingTable[Index].KeySetting;
3759 }
3760 }
3761
3762 return EFI_SUCCESS;
3763 }
3764
3765
3766 /**
3767 Save globals used by previous call to SendForm(). SendForm() may be called from
3768 HiiConfigAccess.Callback(), this will cause SendForm() be reentried.
3769 So, save globals of previous call to SendForm() and restore them upon exit.
3770
3771 **/
3772 VOID
3773 SaveBrowserContext (
3774 VOID
3775 )
3776 {
3777 BROWSER_CONTEXT *Context;
3778
3779 gBrowserContextCount++;
3780 if (gBrowserContextCount == 1) {
3781 //
3782 // This is not reentry of SendForm(), no context to save
3783 //
3784 return;
3785 }
3786
3787 Context = AllocatePool (sizeof (BROWSER_CONTEXT));
3788 ASSERT (Context != NULL);
3789
3790 Context->Signature = BROWSER_CONTEXT_SIGNATURE;
3791
3792 //
3793 // Save FormBrowser context
3794 //
3795 Context->BannerData = gBannerData;
3796 Context->ClassOfVfr = gClassOfVfr;
3797 Context->FunctionKeySetting = gFunctionKeySetting;
3798 Context->ResetRequired = gResetRequired;
3799 Context->Direction = gDirection;
3800 Context->EnterString = gEnterString;
3801 Context->EnterCommitString = gEnterCommitString;
3802 Context->EnterEscapeString = gEnterEscapeString;
3803 Context->EscapeString = gEscapeString;
3804 Context->MoveHighlight = gMoveHighlight;
3805 Context->MakeSelection = gMakeSelection;
3806 Context->DecNumericInput = gDecNumericInput;
3807 Context->HexNumericInput = gHexNumericInput;
3808 Context->ToggleCheckBox = gToggleCheckBox;
3809 Context->PromptForData = gPromptForData;
3810 Context->PromptForPassword = gPromptForPassword;
3811 Context->PromptForNewPassword = gPromptForNewPassword;
3812 Context->ConfirmPassword = gConfirmPassword;
3813 Context->ConfirmError = gConfirmError;
3814 Context->PassowordInvalid = gPassowordInvalid;
3815 Context->PressEnter = gPressEnter;
3816 Context->EmptyString = gEmptyString;
3817 Context->AreYouSure = gAreYouSure;
3818 Context->YesResponse = gYesResponse;
3819 Context->NoResponse = gNoResponse;
3820 Context->MiniString = gMiniString;
3821 Context->PlusString = gPlusString;
3822 Context->MinusString = gMinusString;
3823 Context->AdjustNumber = gAdjustNumber;
3824 Context->SaveChanges = gSaveChanges;
3825 Context->OptionMismatch = gOptionMismatch;
3826 Context->FormSuppress = gFormSuppress;
3827 Context->PromptBlockWidth = gPromptBlockWidth;
3828 Context->OptionBlockWidth = gOptionBlockWidth;
3829 Context->HelpBlockWidth = gHelpBlockWidth;
3830 Context->OldFormSet = gOldFormSet;
3831 Context->MenuRefreshHead = gMenuRefreshHead;
3832
3833 CopyMem (&Context->ScreenDimensions, &gScreenDimensions, sizeof (gScreenDimensions));
3834 CopyMem (&Context->MenuOption, &gMenuOption, sizeof (gMenuOption));
3835
3836 //
3837 // Insert to FormBrowser context list
3838 //
3839 InsertHeadList (&gBrowserContextList, &Context->Link);
3840 }
3841
3842
3843 /**
3844 Restore globals used by previous call to SendForm().
3845
3846 **/
3847 VOID
3848 RestoreBrowserContext (
3849 VOID
3850 )
3851 {
3852 LIST_ENTRY *Link;
3853 BROWSER_CONTEXT *Context;
3854
3855 ASSERT (gBrowserContextCount != 0);
3856 gBrowserContextCount--;
3857 if (gBrowserContextCount == 0) {
3858 //
3859 // This is not reentry of SendForm(), no context to restore
3860 //
3861 return;
3862 }
3863
3864 ASSERT (!IsListEmpty (&gBrowserContextList));
3865
3866 Link = GetFirstNode (&gBrowserContextList);
3867 Context = BROWSER_CONTEXT_FROM_LINK (Link);
3868
3869 //
3870 // Restore FormBrowser context
3871 //
3872 gBannerData = Context->BannerData;
3873 gClassOfVfr = Context->ClassOfVfr;
3874 gFunctionKeySetting = Context->FunctionKeySetting;
3875 gResetRequired = Context->ResetRequired;
3876 gDirection = Context->Direction;
3877 gEnterString = Context->EnterString;
3878 gEnterCommitString = Context->EnterCommitString;
3879 gEnterEscapeString = Context->EnterEscapeString;
3880 gEscapeString = Context->EscapeString;
3881 gMoveHighlight = Context->MoveHighlight;
3882 gMakeSelection = Context->MakeSelection;
3883 gDecNumericInput = Context->DecNumericInput;
3884 gHexNumericInput = Context->HexNumericInput;
3885 gToggleCheckBox = Context->ToggleCheckBox;
3886 gPromptForData = Context->PromptForData;
3887 gPromptForPassword = Context->PromptForPassword;
3888 gPromptForNewPassword = Context->PromptForNewPassword;
3889 gConfirmPassword = Context->ConfirmPassword;
3890 gConfirmError = Context->ConfirmError;
3891 gPassowordInvalid = Context->PassowordInvalid;
3892 gPressEnter = Context->PressEnter;
3893 gEmptyString = Context->EmptyString;
3894 gAreYouSure = Context->AreYouSure;
3895 gYesResponse = Context->YesResponse;
3896 gNoResponse = Context->NoResponse;
3897 gMiniString = Context->MiniString;
3898 gPlusString = Context->PlusString;
3899 gMinusString = Context->MinusString;
3900 gAdjustNumber = Context->AdjustNumber;
3901 gSaveChanges = Context->SaveChanges;
3902 gOptionMismatch = Context->OptionMismatch;
3903 gFormSuppress = Context->FormSuppress;
3904 gPromptBlockWidth = Context->PromptBlockWidth;
3905 gOptionBlockWidth = Context->OptionBlockWidth;
3906 gHelpBlockWidth = Context->HelpBlockWidth;
3907 gOldFormSet = Context->OldFormSet;
3908 gMenuRefreshHead = Context->MenuRefreshHead;
3909
3910 CopyMem (&gScreenDimensions, &Context->ScreenDimensions, sizeof (gScreenDimensions));
3911 CopyMem (&gMenuOption, &Context->MenuOption, sizeof (gMenuOption));
3912
3913 //
3914 // Remove from FormBrowser context list
3915 //
3916 RemoveEntryList (&Context->Link);
3917 gBS->FreePool (Context);
3918 }
3919
3920 /**
3921 Find the matched FormSet context in the backup maintain list based on HiiHandle.
3922
3923 @param Handle The Hii Handle.
3924
3925 @return the found FormSet context. If no found, NULL will return.
3926
3927 **/
3928 FORM_BROWSER_FORMSET *
3929 GetFormSetFromHiiHandle (
3930 EFI_HII_HANDLE Handle
3931 )
3932 {
3933 LIST_ENTRY *Link;
3934 FORM_BROWSER_FORMSET *FormSet;
3935
3936 Link = GetFirstNode (&gBrowserFormSetList);
3937 while (!IsNull (&gBrowserFormSetList, Link)) {
3938 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
3939 if (FormSet->HiiHandle == Handle) {
3940 return FormSet;
3941 }
3942 Link = GetNextNode (&gBrowserFormSetList, Link);
3943 }
3944
3945 return NULL;
3946 }
3947
3948 /**
3949 Check whether the input HII handle is the FormSet that is being used.
3950
3951 @param Handle The Hii Handle.
3952
3953 @retval TRUE HII handle is being used.
3954 @retval FALSE HII handle is not being used.
3955
3956 **/
3957 BOOLEAN
3958 IsHiiHandleInBrowserContext (
3959 EFI_HII_HANDLE Handle
3960 )
3961 {
3962 LIST_ENTRY *Link;
3963 BROWSER_CONTEXT *Context;
3964
3965 //
3966 // HiiHandle is Current FormSet.
3967 //
3968 if ((gOldFormSet != NULL) && (gOldFormSet->HiiHandle == Handle)) {
3969 return TRUE;
3970 }
3971
3972 //
3973 // Check whether HiiHandle is in BrowserContext.
3974 //
3975 Link = GetFirstNode (&gBrowserContextList);
3976 while (!IsNull (&gBrowserContextList, Link)) {
3977 Context = BROWSER_CONTEXT_FROM_LINK (Link);
3978 if (Context->OldFormSet->HiiHandle == Handle) {
3979 //
3980 // HiiHandle is in BrowserContext
3981 //
3982 return TRUE;
3983 }
3984 Link = GetNextNode (&gBrowserContextList, Link);
3985 }
3986
3987 return FALSE;
3988 }
3989
3990 /**
3991 Find the registered HotKey based on KeyData.
3992
3993 @param[in] KeyData A pointer to a buffer that describes the keystroke
3994 information for the hot key.
3995
3996 @return The registered HotKey context. If no found, NULL will return.
3997 **/
3998 BROWSER_HOT_KEY *
3999 GetHotKeyFromRegisterList (
4000 IN EFI_INPUT_KEY *KeyData
4001 )
4002 {
4003 LIST_ENTRY *Link;
4004 BROWSER_HOT_KEY *HotKey;
4005
4006 Link = GetFirstNode (&gBrowserHotKeyList);
4007 while (!IsNull (&gBrowserHotKeyList, Link)) {
4008 HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);
4009 if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {
4010 return HotKey;
4011 }
4012 Link = GetNextNode (&gBrowserHotKeyList, Link);
4013 }
4014
4015 return NULL;
4016 }
4017
4018 /**
4019 Configure what scope the hot key will impact.
4020 All hot keys have the same scope. The mixed hot keys with the different level are not supported.
4021 If no scope is set, the default scope will be FormSet level.
4022 After all registered hot keys are removed, previous Scope can reset to another level.
4023
4024 @param[in] Scope Scope level to be set.
4025
4026 @retval EFI_SUCCESS Scope is set correctly.
4027 @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE.
4028 @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.
4029
4030 **/
4031 EFI_STATUS
4032 EFIAPI
4033 SetScope (
4034 IN BROWSER_SETTING_SCOPE Scope
4035 )
4036 {
4037 if (Scope >= MaxLevel) {
4038 return EFI_INVALID_PARAMETER;
4039 }
4040
4041 //
4042 // When no hot key registered in system or on the first setting,
4043 // Scope can be set.
4044 //
4045 if (mBrowserScopeFirstSet || IsListEmpty (&gBrowserHotKeyList)) {
4046 gBrowserSettingScope = Scope;
4047 mBrowserScopeFirstSet = FALSE;
4048 } else if (Scope != gBrowserSettingScope) {
4049 return EFI_UNSUPPORTED;
4050 }
4051
4052 return EFI_SUCCESS;
4053 }
4054
4055 /**
4056 Register the hot key with its browser action, or unregistered the hot key.
4057 Only support hot key that is not printable character (control key, function key, etc.).
4058 If the action value is zero, the hot key will be unregistered if it has been registered.
4059 If the same hot key has been registered, the new action and help string will override the previous ones.
4060
4061 @param[in] KeyData A pointer to a buffer that describes the keystroke
4062 information for the hot key. Its type is EFI_INPUT_KEY to
4063 be supported by all ConsoleIn devices.
4064 @param[in] Action Action value that describes what action will be trigged when the hot key is pressed.
4065 @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.
4066 @param[in] HelpString Help string that describes the hot key information.
4067 Its value may be NULL for the unregistered hot key.
4068
4069 @retval EFI_SUCCESS Hot key is registered or unregistered.
4070 @retval EFI_INVALID_PARAMETER KeyData is NULL or HelpString is NULL on register.
4071 @retval EFI_NOT_FOUND KeyData is not found to be unregistered.
4072 @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.
4073 **/
4074 EFI_STATUS
4075 EFIAPI
4076 RegisterHotKey (
4077 IN EFI_INPUT_KEY *KeyData,
4078 IN UINT32 Action,
4079 IN UINT16 DefaultId,
4080 IN EFI_STRING HelpString OPTIONAL
4081 )
4082 {
4083 BROWSER_HOT_KEY *HotKey;
4084
4085 //
4086 // Check input parameters.
4087 //
4088 if (KeyData == NULL || KeyData->UnicodeChar != CHAR_NULL ||
4089 (Action != BROWSER_ACTION_UNREGISTER && HelpString == NULL)) {
4090 return EFI_INVALID_PARAMETER;
4091 }
4092
4093 //
4094 // Check whether the input KeyData is in BrowserHotKeyList.
4095 //
4096 HotKey = GetHotKeyFromRegisterList (KeyData);
4097
4098 //
4099 // Unregister HotKey
4100 //
4101 if (Action == BROWSER_ACTION_UNREGISTER) {
4102 if (HotKey != NULL) {
4103 //
4104 // The registered HotKey is found.
4105 // Remove it from List, and free its resource.
4106 //
4107 RemoveEntryList (&HotKey->Link);
4108 FreePool (HotKey->KeyData);
4109 FreePool (HotKey->HelpString);
4110 return EFI_SUCCESS;
4111 } else {
4112 //
4113 // The registered HotKey is not found.
4114 //
4115 return EFI_NOT_FOUND;
4116 }
4117 }
4118
4119 //
4120 // Register HotKey into List.
4121 //
4122 if (HotKey == NULL) {
4123 //
4124 // Create new Key, and add it into List.
4125 //
4126 HotKey = AllocateZeroPool (sizeof (BROWSER_HOT_KEY));
4127 ASSERT (HotKey != NULL);
4128 HotKey->Signature = BROWSER_HOT_KEY_SIGNATURE;
4129 HotKey->KeyData = AllocateCopyPool (sizeof (EFI_INPUT_KEY), KeyData);
4130 InsertTailList (&gBrowserHotKeyList, &HotKey->Link);
4131 }
4132
4133 //
4134 // Fill HotKey information.
4135 //
4136 HotKey->Action = Action;
4137 HotKey->DefaultId = DefaultId;
4138 if (HotKey->HelpString != NULL) {
4139 FreePool (HotKey->HelpString);
4140 }
4141 HotKey->HelpString = AllocateCopyPool (StrSize (HelpString), HelpString);
4142
4143 return EFI_SUCCESS;
4144 }
4145
4146 /**
4147 Register Exit handler function.
4148 When more than one handler function is registered, the latter one will override the previous one.
4149 When NULL handler is specified, the previous Exit handler will be unregistered.
4150
4151 @param[in] Handler Pointer to handler function.
4152
4153 **/
4154 VOID
4155 EFIAPI
4156 RegiserExitHandler (
4157 IN EXIT_HANDLER Handler
4158 )
4159 {
4160 ExitHandlerFunction = Handler;
4161 return;
4162 }
4163
4164 /**
4165 Create reminder to let user to choose save or discard the changed browser data.
4166 Caller can use it to actively check the changed browser data.
4167
4168 @retval BROWSER_NO_CHANGES No browser data is changed.
4169 @retval BROWSER_SAVE_CHANGES The changed browser data is saved.
4170 @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.
4171
4172 **/
4173 UINT32
4174 EFIAPI
4175 SaveReminder (
4176 VOID
4177 )
4178 {
4179 LIST_ENTRY *Link;
4180 FORM_BROWSER_FORMSET *FormSet;
4181 BOOLEAN IsDataChanged;
4182 UINT32 DataSavedAction;
4183 CHAR16 *YesResponse;
4184 CHAR16 *NoResponse;
4185 CHAR16 *EmptyString;
4186 CHAR16 *ChangeReminderString;
4187 CHAR16 *SaveConfirmString;
4188 EFI_INPUT_KEY Key;
4189
4190 DataSavedAction = BROWSER_NO_CHANGES;
4191 IsDataChanged = FALSE;
4192 Link = GetFirstNode (&gBrowserFormSetList);
4193 while (!IsNull (&gBrowserFormSetList, Link)) {
4194 FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);
4195 if (IsNvUpdateRequired (FormSet)) {
4196 IsDataChanged = TRUE;
4197 break;
4198 }
4199 Link = GetNextNode (&gBrowserFormSetList, Link);
4200 }
4201
4202 //
4203 // No data is changed. No save is required.
4204 //
4205 if (!IsDataChanged) {
4206 return DataSavedAction;
4207 }
4208
4209 //
4210 // If data is changed, prompt user
4211 //
4212 gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
4213
4214 YesResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_YES), gHiiHandle);
4215 ASSERT (YesResponse != NULL);
4216 NoResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_NO), gHiiHandle);
4217 ASSERT (NoResponse != NULL);
4218 EmptyString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);
4219 ChangeReminderString = GetToken (STRING_TOKEN (CHANGE_REMINDER), gHiiHandle);
4220 SaveConfirmString = GetToken (STRING_TOKEN (SAVE_CONFIRM), gHiiHandle);
4221
4222 do {
4223 CreateDialog (4, TRUE, 0, NULL, &Key, EmptyString, ChangeReminderString, SaveConfirmString, EmptyString);
4224 } while
4225 (((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse[0] | UPPER_LOWER_CASE_OFFSET)) &&
4226 ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse[0] | UPPER_LOWER_CASE_OFFSET))
4227 );
4228
4229 //
4230 // If the user hits the YesResponse key
4231 //
4232 if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse[0] | UPPER_LOWER_CASE_OFFSET)) {
4233 SubmitForm (NULL, NULL, SystemLevel);
4234 DataSavedAction = BROWSER_SAVE_CHANGES;
4235 } else {
4236 DiscardForm (NULL, NULL, SystemLevel);
4237 DataSavedAction = BROWSER_DISCARD_CHANGES;
4238 gResetRequired = FALSE;
4239 }
4240
4241 FreePool (YesResponse);
4242 FreePool (NoResponse);
4243 FreePool (EmptyString);
4244 FreePool (SaveConfirmString);
4245 FreePool (ChangeReminderString);
4246
4247 return DataSavedAction;
4248 }
EFI Development Kit II mirror for PVE