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