/** @file\r
Entry and initialization module for the browser.\r
\r
-Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
{\r
SendForm,\r
BrowserCallback\r
+ },\r
+ {\r
+ SetScope,\r
+ RegisterHotKey,\r
+ RegiserExitHandler,\r
+ SaveReminder\r
}\r
};\r
\r
\r
UINTN gBrowserContextCount = 0;\r
LIST_ENTRY gBrowserContextList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserContextList);\r
+LIST_ENTRY gBrowserFormSetList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserFormSetList);\r
+LIST_ENTRY gBrowserHotKeyList = INITIALIZE_LIST_HEAD_VARIABLE (gBrowserHotKeyList);\r
\r
BANNER_DATA *gBannerData;\r
EFI_HII_HANDLE gFrontPageHandle;\r
EFI_HII_HANDLE gHiiHandle;\r
UINT16 gDirection;\r
EFI_SCREEN_DESCRIPTOR gScreenDimensions;\r
+BROWSER_SETTING_SCOPE gBrowserSettingScope = FormSetLevel;\r
+BOOLEAN mBrowserScopeFirstSet = TRUE;\r
+EXIT_HANDLER ExitHandlerFunction = NULL;\r
+UINTN gFooterHeight;\r
\r
//\r
// Browser Global Strings\r
//\r
-CHAR16 *gFunctionNineString;\r
-CHAR16 *gFunctionTenString;\r
+CHAR16 *gSaveFailed;\r
+CHAR16 *gDiscardFailed;\r
+CHAR16 *gDefaultFailed;\r
CHAR16 *gEnterString;\r
CHAR16 *gEnterCommitString;\r
CHAR16 *gEnterEscapeString;\r
CHAR16 *gEscapeString;\r
-CHAR16 *gSaveFailed;\r
CHAR16 *gMoveHighlight;\r
CHAR16 *gMakeSelection;\r
CHAR16 *gDecNumericInput;\r
0xab368524, 0xb60c, 0x495b, {0xa0, 0x9, 0x12, 0xe8, 0x5b, 0x1a, 0xea, 0x32}\r
};\r
\r
-FORM_BROWSER_FORMSET *gOldFormSet;\r
+FORM_BROWSER_FORMSET *gOldFormSet = NULL;\r
\r
FUNCTIION_KEY_SETTING gFunctionKeySettingTable[] = {\r
//\r
UI_MENU_SELECTION *Selection;\r
UINTN Index;\r
FORM_BROWSER_FORMSET *FormSet;\r
+ LIST_ENTRY *Link;\r
+\r
+ //\r
+ // Calculate total number of Register HotKeys. \r
+ //\r
+ Index = 0;\r
+ Link = GetFirstNode (&gBrowserHotKeyList);\r
+ while (!IsNull (&gBrowserHotKeyList, Link)) {\r
+ Link = GetNextNode (&gBrowserHotKeyList, Link);\r
+ Index ++;\r
+ }\r
+ //\r
+ // Show three HotKeys help information on one ROW.\r
+ //\r
+ gFooterHeight = FOOTER_HEIGHT + (Index / 3);\r
\r
//\r
// Save globals used by SendForm()\r
//\r
SaveBrowserContext ();\r
\r
+ gResetRequired = FALSE;\r
Status = EFI_SUCCESS;\r
ZeroMem (&gScreenDimensions, sizeof (EFI_SCREEN_DESCRIPTOR));\r
\r
SCROLL_ARROW_HEIGHT *\r
2 +\r
FRONT_PAGE_HEADER_HEIGHT +\r
- FOOTER_HEIGHT +\r
+ gFooterHeight +\r
1\r
)\r
) {\r
//\r
InitializeBrowserStrings ();\r
\r
- gFunctionKeySetting = DEFAULT_FUNCTION_KEY_SETTING;\r
+ gFunctionKeySetting = ENABLE_FUNCTION_KEY_SETTING;\r
\r
//\r
// Ensure we are in Text mode\r
if (FormSetGuid != NULL) {\r
CopyMem (&Selection->FormSetGuid, FormSetGuid, sizeof (EFI_GUID));\r
Selection->FormId = FormId;\r
+ } else {\r
+ CopyMem (&Selection->FormSetGuid, &gEfiHiiPlatformSetupFormsetGuid, sizeof (EFI_GUID));\r
}\r
\r
- gOldFormSet = NULL;\r
-\r
do {\r
FormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));\r
ASSERT (FormSet != NULL);\r
//\r
// Initialize internal data structures of FormSet\r
//\r
- Status = InitializeFormSet (Selection->Handle, &Selection->FormSetGuid, FormSet);\r
+ Status = InitializeFormSet (Selection->Handle, &Selection->FormSetGuid, FormSet, TRUE);\r
if (EFI_ERROR (Status) || IsListEmpty (&FormSet->FormListHead)) {\r
DestroyFormSet (FormSet);\r
break;\r
}\r
Selection->FormSet = FormSet;\r
\r
+ //\r
+ // Try to find pre FormSet in the maintain backup list.\r
+ //\r
+ gOldFormSet = GetFormSetFromHiiHandle (Selection->Handle);\r
+\r
//\r
// Display this formset\r
//\r
} while (Selection->Action == UI_ACTION_REFRESH_FORMSET);\r
\r
if (gOldFormSet != NULL) {\r
- DestroyFormSet (gOldFormSet);\r
+ //\r
+ // If no data is changed, don't need to save current FormSet into the maintain list.\r
+ //\r
+ if (!IsNvUpdateRequired (gOldFormSet)) {\r
+ RemoveEntryList (&gOldFormSet->Link);\r
+ DestroyFormSet (gOldFormSet);\r
+ }\r
gOldFormSet = NULL;\r
}\r
\r
return EFI_SUCCESS;\r
}\r
\r
+/**\r
+ Notify function will remove the formset in the maintain list \r
+ once this formset is removed.\r
+ \r
+ Functions which are registered to receive notification of\r
+ database events have this prototype. The actual event is encoded\r
+ in NotifyType. The following table describes how PackageType,\r
+ PackageGuid, Handle, and Package are used for each of the\r
+ notification types.\r
+\r
+ @param PackageType Package type of the notification.\r
+\r
+ @param PackageGuid If PackageType is\r
+ EFI_HII_PACKAGE_TYPE_GUID, then this is\r
+ the pointer to the GUID from the Guid\r
+ field of EFI_HII_PACKAGE_GUID_HEADER.\r
+ Otherwise, it must be NULL.\r
+\r
+ @param Package Points to the package referred to by the\r
+ notification Handle The handle of the package\r
+ list which contains the specified package.\r
+\r
+ @param Handle The HII handle.\r
+\r
+ @param NotifyType The type of change concerning the\r
+ database. See\r
+ EFI_HII_DATABASE_NOTIFY_TYPE.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FormsetRemoveNotify (\r
+ IN UINT8 PackageType,\r
+ IN CONST EFI_GUID *PackageGuid,\r
+ IN CONST EFI_HII_PACKAGE_HEADER *Package,\r
+ IN EFI_HII_HANDLE Handle,\r
+ IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r
+ )\r
+{\r
+ FORM_BROWSER_FORMSET *FormSet;\r
+\r
+ //\r
+ // Ignore the update for current using formset, which is handled by another notify function.\r
+ //\r
+ if (IsHiiHandleInBrowserContext (Handle)) {\r
+ return EFI_SUCCESS;\r
+ }\r
+ \r
+ //\r
+ // Remove the backup FormSet data when the Form Package is removed.\r
+ //\r
+ FormSet = GetFormSetFromHiiHandle (Handle);\r
+ if (FormSet != NULL) {\r
+ RemoveEntryList (&FormSet->Link);\r
+ DestroyFormSet (FormSet);\r
+ }\r
+ \r
+ return EFI_SUCCESS;\r
+}\r
\r
/**\r
Initialize Setup Browser driver.\r
)\r
{\r
EFI_STATUS Status;\r
+ EFI_HANDLE NotifyHandle;\r
+ EFI_INPUT_KEY DefaultHotKey;\r
+ EFI_STRING HelpString;\r
\r
//\r
// Locate required Hii relative protocols\r
//\r
gBannerData = AllocateZeroPool (sizeof (BANNER_DATA));\r
ASSERT (gBannerData != NULL);\r
+ \r
+ //\r
+ // Initialize generic help strings.\r
+ //\r
+ gSaveFailed = GetToken (STRING_TOKEN (SAVE_FAILED), gHiiHandle);\r
+ gDiscardFailed = GetToken (STRING_TOKEN (DISCARD_FAILED), gHiiHandle);\r
+ gDefaultFailed = GetToken (STRING_TOKEN (DEFAULT_FAILED), gHiiHandle);\r
\r
//\r
// Install FormBrowser2 protocol\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
+ //\r
+ // Install default HotKey F10 for Save\r
+ //\r
+ DefaultHotKey.UnicodeChar = CHAR_NULL;\r
+ HelpString = GetToken (STRING_TOKEN (FUNCTION_TEN_STRING), gHiiHandle);\r
+ DefaultHotKey.ScanCode = SCAN_F10;\r
+ RegisterHotKey (&DefaultHotKey, BROWSER_ACTION_SUBMIT, 0, HelpString);\r
+ FreePool (HelpString);\r
+ //\r
+ // Install default HotKey F9 for Reset To Defaults\r
+ //\r
+ DefaultHotKey.ScanCode = SCAN_F9;\r
+ HelpString = GetToken (STRING_TOKEN (FUNCTION_NINE_STRING), gHiiHandle);\r
+ RegisterHotKey (&DefaultHotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, HelpString);\r
+ FreePool (HelpString);\r
+\r
+ //\r
+ // Install FormBrowserEx protocol\r
+ //\r
+ mPrivateData.Handle = NULL;\r
+ Status = gBS->InstallProtocolInterface (\r
+ &mPrivateData.Handle,\r
+ &gEfiFormBrowserExProtocolGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ &mPrivateData.FormBrowserEx\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Register notify for Form package remove\r
+ //\r
+ Status = mHiiDatabase->RegisterPackageNotify (\r
+ mHiiDatabase,\r
+ EFI_HII_PACKAGE_FORMS,\r
+ NULL,\r
+ FormsetRemoveNotify,\r
+ EFI_HII_DATABASE_NOTIFY_REMOVE_PACK,\r
+ &NotifyHandle\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
return Status;\r
}\r
\r
\r
Status = EFI_SUCCESS;\r
Value = NULL;\r
+ Result = NULL;\r
\r
//\r
// Statement don't have storage, skip them\r
if (Question->ValueExpression != NULL) {\r
Status = EvaluateExpression (FormSet, Form, Question->ValueExpression);\r
if (!EFI_ERROR (Status)) {\r
- CopyMem (&Question->HiiValue, &Question->ValueExpression->Result, sizeof (EFI_HII_VALUE));\r
+ if (Question->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {\r
+ ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);\r
+ if (Question->StorageWidth > Question->ValueExpression->Result.BufferLen) {\r
+ CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->ValueExpression->Result.BufferLen);\r
+ Question->HiiValue.BufferLen = Question->ValueExpression->Result.BufferLen;\r
+ } else {\r
+ CopyMem (Question->HiiValue.Buffer, Question->ValueExpression->Result.Buffer, Question->StorageWidth);\r
+ Question->HiiValue.BufferLen = Question->StorageWidth;\r
+ }\r
+ FreePool (Question->ValueExpression->Result.Buffer);\r
+ }\r
+ Question->HiiValue.Type = Question->ValueExpression->Result.Type;\r
+ CopyMem (&Question->HiiValue.Value, &Question->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE)); \r
}\r
return Status;\r
}\r
//\r
if (Question->ReadExpression != NULL && Form->FormType == STANDARD_MAP_FORM_TYPE) {\r
Status = EvaluateExpression (FormSet, Form, Question->ReadExpression);\r
- if (!EFI_ERROR (Status) && (Question->ReadExpression->Result.Type < EFI_IFR_TYPE_OTHER)) {\r
+ if (!EFI_ERROR (Status) && \r
+ ((Question->ReadExpression->Result.Type < EFI_IFR_TYPE_OTHER) || (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER))) {\r
//\r
// Only update question value to the valid result.\r
//\r
- CopyMem (&Question->HiiValue, &Question->ReadExpression->Result, sizeof (EFI_HII_VALUE));\r
+ if (Question->ReadExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {\r
+ ASSERT (Question->HiiValue.Type == EFI_IFR_TYPE_BUFFER && Question->HiiValue.Buffer != NULL);\r
+ if (Question->StorageWidth > Question->ReadExpression->Result.BufferLen) {\r
+ CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->ReadExpression->Result.BufferLen);\r
+ Question->HiiValue.BufferLen = Question->ReadExpression->Result.BufferLen;\r
+ } else {\r
+ CopyMem (Question->HiiValue.Buffer, Question->ReadExpression->Result.Buffer, Question->StorageWidth);\r
+ Question->HiiValue.BufferLen = Question->StorageWidth;\r
+ }\r
+ FreePool (Question->ReadExpression->Result.Buffer);\r
+ }\r
+ Question->HiiValue.Type = Question->ReadExpression->Result.Type;\r
+ CopyMem (&Question->HiiValue.Value, &Question->ReadExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE)); \r
return EFI_SUCCESS;\r
}\r
}\r
FreePool (Value);\r
}\r
} else {\r
- if (Storage->Type == EFI_HII_VARSTORE_BUFFER) {\r
+ if (Storage->Type == EFI_HII_VARSTORE_BUFFER || Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {\r
//\r
// Request current settings from Configuration Driver\r
//\r
//\r
// Skip <ConfigRequest>\r
//\r
- Value = Result + Length;\r
if (IsBufferStorage) {\r
+ Value = StrStr (Result, L"&VALUE");\r
+ if (Value == NULL) {\r
+ FreePool (Result);\r
+ return EFI_NOT_FOUND;\r
+ }\r
//\r
// Skip "&VALUE"\r
//\r
Value = Value + 6;\r
+ } else {\r
+ Value = Result + Length;\r
}\r
if (*Value != '=') {\r
FreePool (Result);\r
}\r
}\r
}\r
- FreePool (Result);\r
\r
if (EFI_ERROR (Status)) {\r
+ FreePool (Result);\r
return Status;\r
}\r
} else if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE_BUFFER) {\r
} else {\r
SetValueByName (Storage, Question->VariableName, Value, TRUE);\r
}\r
+\r
+ if (Result != NULL) {\r
+ FreePool (Result);\r
+ }\r
}\r
\r
return Status;\r
}\r
\r
if (!Cached) {\r
- if (Storage->Type == EFI_HII_VARSTORE_BUFFER) {\r
+ if (Storage->Type == EFI_HII_VARSTORE_BUFFER || Storage->Type == EFI_HII_VARSTORE_NAME_VALUE) {\r
//\r
// <ConfigResp> ::= <ConfigHdr> + <BlockName> + "&VALUE=" + "<HexCh>StorageWidth * 2" ||\r
// <ConfigHdr> + "&" + <VariableName> + "=" + "<string>"\r
return Status;\r
}\r
\r
- if (Expression->Result.Value.b) {\r
+ if ((Expression->Result.Type == EFI_IFR_TYPE_BOOLEAN) && Expression->Result.Value.b) {\r
//\r
// Condition meet, show up error message\r
//\r
\r
\r
/**\r
- Discard data for form level or formset level.\r
+ Discard data based on the input setting scope (Form, FormSet or System).\r
\r
@param FormSet FormSet data structure.\r
@param Form Form data structure.\r
- @param SingleForm Only discard single form or formset.\r
+ @param SettingScope Setting Scope for Discard action.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_UNSUPPORTED Unsupport SettingScope.\r
\r
**/\r
EFI_STATUS\r
DiscardForm (\r
IN FORM_BROWSER_FORMSET *FormSet,\r
IN FORM_BROWSER_FORM *Form,\r
- IN BOOLEAN SingleForm\r
+ IN BROWSER_SETTING_SCOPE SettingScope\r
)\r
{\r
- LIST_ENTRY *Link;\r
- FORMSET_STORAGE *Storage;\r
+ LIST_ENTRY *Link;\r
+ FORMSET_STORAGE *Storage;\r
FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;\r
+ FORM_BROWSER_FORMSET *LocalFormSet;\r
\r
- if (SingleForm) {\r
- if (Form->NvUpdateRequired) {\r
- ConfigInfo = NULL;\r
- Link = GetFirstNode (&Form->ConfigRequestHead);\r
- while (!IsNull (&Form->ConfigRequestHead, Link)) {\r
- ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);\r
- Link = GetNextNode (&Form->ConfigRequestHead, Link);\r
-\r
- if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {\r
- continue;\r
- }\r
+ //\r
+ // Check the supported setting level.\r
+ //\r
+ if (SettingScope >= MaxLevel) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
\r
- //\r
- // Skip if there is no RequestElement\r
- //\r
- if (ConfigInfo->ElementCount == 0) {\r
- continue;\r
- }\r
+ if (SettingScope == FormLevel && Form->NvUpdateRequired) {\r
+ ConfigInfo = NULL;\r
+ Link = GetFirstNode (&Form->ConfigRequestHead);\r
+ while (!IsNull (&Form->ConfigRequestHead, Link)) {\r
+ ConfigInfo = FORM_BROWSER_CONFIG_REQUEST_FROM_LINK (Link);\r
+ Link = GetNextNode (&Form->ConfigRequestHead, Link);\r
\r
- //\r
- // Prepare <ConfigResp>\r
- //\r
- SynchronizeStorageForForm(FormSet, ConfigInfo, FALSE);\r
+ if (ConfigInfo->Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {\r
+ continue;\r
}\r
\r
- Form->NvUpdateRequired = FALSE;\r
+ //\r
+ // Skip if there is no RequestElement\r
+ //\r
+ if (ConfigInfo->ElementCount == 0) {\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Prepare <ConfigResp>\r
+ //\r
+ SynchronizeStorageForForm(FormSet, ConfigInfo, FALSE);\r
}\r
- } else {\r
- if (IsNvUpdateRequired(FormSet)) {\r
+\r
+ Form->NvUpdateRequired = FALSE;\r
+ } else if (SettingScope == FormSetLevel && IsNvUpdateRequired(FormSet)) {\r
+ //\r
+ // Discard Buffer storage or Name/Value storage\r
+ //\r
+ Link = GetFirstNode (&FormSet->StorageListHead);\r
+ while (!IsNull (&FormSet->StorageListHead, Link)) {\r
+ Storage = FORMSET_STORAGE_FROM_LINK (Link);\r
+ Link = GetNextNode (&FormSet->StorageListHead, Link);\r
+\r
+ if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {\r
+ continue;\r
+ }\r
+\r
//\r
- // Discard Buffer storage or Name/Value storage\r
+ // Skip if there is no RequestElement\r
//\r
- Link = GetFirstNode (&FormSet->StorageListHead);\r
- while (!IsNull (&FormSet->StorageListHead, Link)) {\r
- Storage = FORMSET_STORAGE_FROM_LINK (Link);\r
- Link = GetNextNode (&FormSet->StorageListHead, Link);\r
+ if (Storage->ElementCount == 0) {\r
+ continue;\r
+ }\r
\r
- if (Storage->Type == EFI_HII_VARSTORE_EFI_VARIABLE) {\r
- continue;\r
- }\r
+ SynchronizeStorage(Storage, FALSE);\r
+ }\r
\r
+ UpdateNvInfoInForm (FormSet, FALSE); \r
+ } else if (SettingScope == SystemLevel) {\r
+ //\r
+ // System Level Discard.\r
+ //\r
+ \r
+ //\r
+ // Discard changed value for each FormSet in the maintain list.\r
+ //\r
+ Link = GetFirstNode (&gBrowserFormSetList);\r
+ while (!IsNull (&gBrowserFormSetList, Link)) {\r
+ LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);\r
+ DiscardForm (LocalFormSet, NULL, FormSetLevel);\r
+ Link = GetNextNode (&gBrowserFormSetList, Link);\r
+ if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {\r
//\r
- // Skip if there is no RequestElement\r
+ // Remove maintain backup list after discard except for the current using FormSet.\r
//\r
- if (Storage->ElementCount == 0) {\r
- continue;\r
- }\r
-\r
- SynchronizeStorage(Storage, FALSE);\r
+ RemoveEntryList (&LocalFormSet->Link);\r
+ DestroyFormSet (LocalFormSet);\r
}\r
-\r
- UpdateNvInfoInForm(FormSet, FALSE); \r
}\r
}\r
\r
}\r
\r
/**\r
- Submit data for form level or formset level.\r
+ Submit data based on the input Setting level (Form, FormSet or System).\r
\r
@param FormSet FormSet data structure.\r
@param Form Form data structure.\r
- @param SingleForm whether submit for the single form or all form set.\r
+ @param SettingScope Setting Scope for Submit action.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_UNSUPPORTED Unsupport SettingScope.\r
\r
**/\r
EFI_STATUS\r
SubmitForm (\r
IN FORM_BROWSER_FORMSET *FormSet,\r
IN FORM_BROWSER_FORM *Form,\r
- IN BOOLEAN SingleForm\r
+ IN BROWSER_SETTING_SCOPE SettingScope\r
)\r
{\r
EFI_STATUS Status;\r
EFI_STRING Progress;\r
FORMSET_STORAGE *Storage;\r
UINTN BufferSize;\r
- UINT8 *TmpBuf;\r
+ UINT8 *TmpBuf; \r
+ FORM_BROWSER_FORMSET *LocalFormSet;\r
FORM_BROWSER_CONFIG_REQUEST *ConfigInfo;\r
\r
+ //\r
+ // Check the supported setting level.\r
+ //\r
+ if (SettingScope >= MaxLevel) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
//\r
// Validate the Form by NoSubmit check\r
//\r
- if (SingleForm) {\r
+ Status = EFI_SUCCESS;\r
+ if (SettingScope == FormLevel) {\r
Status = NoSubmitCheck (FormSet, Form);\r
- } else {\r
+ } else if (SettingScope == FormSetLevel) {\r
Status = NoSubmitCheck (FormSet, NULL);\r
}\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
- if (SingleForm) {\r
+ if (SettingScope == FormLevel && Form->NvUpdateRequired) {\r
ConfigInfo = NULL;\r
Link = GetFirstNode (&Form->ConfigRequestHead);\r
while (!IsNull (&Form->ConfigRequestHead, Link)) {\r
// 4. Update the NV flag.\r
// \r
Form->NvUpdateRequired = FALSE;\r
- } else {\r
+ } else if (SettingScope == FormSetLevel && IsNvUpdateRequired(FormSet)) {\r
//\r
// Submit Buffer storage or Name/Value storage\r
//\r
//\r
// 4. Update the NV flag.\r
// \r
- UpdateNvInfoInForm(FormSet, FALSE);\r
+ UpdateNvInfoInForm (FormSet, FALSE);\r
+ } else if (SettingScope == SystemLevel) {\r
+ //\r
+ // System Level Save.\r
+ //\r
+\r
+ //\r
+ // Save changed value for each FormSet in the maintain list.\r
+ //\r
+ Link = GetFirstNode (&gBrowserFormSetList);\r
+ while (!IsNull (&gBrowserFormSetList, Link)) {\r
+ LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);\r
+ SubmitForm (LocalFormSet, NULL, FormSetLevel);\r
+ Link = GetNextNode (&gBrowserFormSetList, Link);\r
+ if (!IsHiiHandleInBrowserContext (LocalFormSet->HiiHandle)) {\r
+ //\r
+ // Remove maintain backup list after save except for the current using FormSet.\r
+ //\r
+ RemoveEntryList (&LocalFormSet->Link);\r
+ DestroyFormSet (LocalFormSet);\r
+ }\r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
EFI_BROWSER_ACTION_REQUEST ActionRequest;\r
INTN Action;\r
\r
- Status = EFI_SUCCESS;\r
+ Status = EFI_NOT_FOUND;\r
StrValue = NULL;\r
\r
//\r
return Status;\r
}\r
\r
- CopyMem (HiiValue, &Default->ValueExpression->Result, sizeof (EFI_HII_VALUE));\r
+ if (Default->ValueExpression->Result.Type == EFI_IFR_TYPE_BUFFER) {\r
+ ASSERT (HiiValue->Type == EFI_IFR_TYPE_BUFFER && Question->BufferValue != NULL);\r
+ if (Question->StorageWidth > Default->ValueExpression->Result.BufferLen) {\r
+ CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Default->ValueExpression->Result.BufferLen);\r
+ Question->HiiValue.BufferLen = Default->ValueExpression->Result.BufferLen;\r
+ } else {\r
+ CopyMem (Question->HiiValue.Buffer, Default->ValueExpression->Result.Buffer, Question->StorageWidth);\r
+ Question->HiiValue.BufferLen = Question->StorageWidth;\r
+ }\r
+ FreePool (Default->ValueExpression->Result.Buffer);\r
+ }\r
+ HiiValue->Type = Default->ValueExpression->Result.Type;\r
+ CopyMem (&HiiValue->Value, &Default->ValueExpression->Result.Value, sizeof (EFI_IFR_TYPE_VALUE)); \r
} else {\r
//\r
// Default value is embedded in EFI_IFR_DEFAULT\r
if (StrValue == NULL) {\r
return EFI_NOT_FOUND;\r
}\r
- Question->BufferValue = AllocateCopyPool (StrSize (StrValue), StrValue);\r
+ if (Question->StorageWidth > StrSize (StrValue)) {\r
+ CopyMem (Question->BufferValue, StrValue, StrSize (StrValue));\r
+ } else {\r
+ CopyMem (Question->BufferValue, StrValue, Question->StorageWidth);\r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
//\r
// For Questions without default\r
//\r
+ Status = EFI_NOT_FOUND;\r
switch (Question->Operand) {\r
case EFI_IFR_NUMERIC_OP:\r
//\r
//\r
if ((HiiValue->Value.u64 < Question->Minimum) || (HiiValue->Value.u64 > Question->Maximum)) {\r
HiiValue->Value.u64 = Question->Minimum;\r
+ Status = EFI_SUCCESS;\r
}\r
break;\r
\r
if (!IsNull (&Question->OptionListHead, Link)) {\r
Option = QUESTION_OPTION_FROM_LINK (Link);\r
CopyMem (HiiValue, &Option->Value, sizeof (EFI_HII_VALUE));\r
+ Status = EFI_SUCCESS;\r
}\r
}\r
break;\r
Index = 0;\r
Link = GetFirstNode (&Question->OptionListHead);\r
while (!IsNull (&Question->OptionListHead, Link)) {\r
+ Status = EFI_SUCCESS;\r
Option = QUESTION_OPTION_FROM_LINK (Link);\r
\r
SetArrayData (Question->BufferValue, Question->ValueType, Index, Option->Value.Value.u64);\r
break;\r
\r
default:\r
- Status = EFI_NOT_FOUND;\r
break;\r
}\r
\r
\r
\r
/**\r
- Reset Questions in a Formset to their default value.\r
+ Reset Questions to their default value in a Form, Formset or System.\r
\r
@param FormSet FormSet data structure.\r
+ @param Form Form data structure.\r
@param DefaultId The Class of the default.\r
+ @param SettingScope Setting Scope for Default action.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
+ @retval EFI_UNSUPPORTED Unsupport SettingScope.\r
\r
**/\r
EFI_STATUS\r
-ExtractFormSetDefault (\r
+ExtractDefault (\r
IN FORM_BROWSER_FORMSET *FormSet,\r
- IN UINT16 DefaultId\r
+ IN FORM_BROWSER_FORM *Form,\r
+ IN UINT16 DefaultId,\r
+ IN BROWSER_SETTING_SCOPE SettingScope\r
)\r
{\r
EFI_STATUS Status;\r
LIST_ENTRY *FormLink;\r
- LIST_ENTRY *StatementLink;\r
+ LIST_ENTRY *Link;\r
FORM_BROWSER_STATEMENT *Question;\r
- FORM_BROWSER_FORM *Form;\r
+ FORM_BROWSER_FORMSET *BackUpFormSet;\r
+ FORM_BROWSER_FORMSET *LocalFormSet;\r
+ EFI_HII_HANDLE *HiiHandles;\r
+ UINTN Index;\r
+ EFI_GUID ZeroGuid;\r
\r
- FormLink = GetFirstNode (&FormSet->FormListHead);\r
- while (!IsNull (&FormSet->FormListHead, FormLink)) {\r
- Form = FORM_BROWSER_FORM_FROM_LINK (FormLink); \r
- \r
+ //\r
+ // Check the supported setting level.\r
+ //\r
+ if (SettingScope >= MaxLevel) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ \r
+ if (SettingScope == FormLevel) {\r
//\r
// Extract Form default\r
//\r
- StatementLink = GetFirstNode (&Form->StatementListHead);\r
- while (!IsNull (&Form->StatementListHead, StatementLink)) {\r
- Question = FORM_BROWSER_STATEMENT_FROM_LINK (StatementLink);\r
- StatementLink = GetNextNode (&Form->StatementListHead, StatementLink);\r
-\r
+ Link = GetFirstNode (&Form->StatementListHead);\r
+ while (!IsNull (&Form->StatementListHead, Link)) {\r
+ Question = FORM_BROWSER_STATEMENT_FROM_LINK (Link);\r
+ Link = GetNextNode (&Form->StatementListHead, Link);\r
+ \r
//\r
// If Question is disabled, don't reset it to default\r
//\r
- if (Question->DisableExpression != NULL) {\r
- Status = EvaluateExpression (FormSet, Form, Question->DisableExpression);\r
- if (!EFI_ERROR (Status) && Question->DisableExpression->Result.Value.b) {\r
+ if (Question->Expression != NULL) {\r
+ if (EvaluateExpressionList(Question->Expression, TRUE, FormSet, Form) == ExpressDisable) {\r
continue;\r
}\r
}\r
-\r
+ \r
//\r
// Reset Question to its default value\r
//\r
if (EFI_ERROR (Status)) {\r
continue;\r
}\r
-\r
+ \r
//\r
// Synchronize Buffer storage's Edit buffer\r
//\r
if ((Question->Storage != NULL) &&\r
(Question->Storage->Type != EFI_HII_VARSTORE_EFI_VARIABLE)) {\r
SetQuestionValue (FormSet, Form, Question, TRUE);\r
+ //\r
+ // Update Form NV flag.\r
+ //\r
+ Form->NvUpdateRequired = TRUE;\r
}\r
}\r
- FormLink = GetNextNode (&FormSet->FormListHead, FormLink);\r
+ } else if (SettingScope == FormSetLevel) {\r
+ FormLink = GetFirstNode (&FormSet->FormListHead);\r
+ while (!IsNull (&FormSet->FormListHead, FormLink)) {\r
+ Form = FORM_BROWSER_FORM_FROM_LINK (FormLink);\r
+ ExtractDefault (FormSet, Form, DefaultId, FormLevel);\r
+ FormLink = GetNextNode (&FormSet->FormListHead, FormLink);\r
+ }\r
+ } else if (SettingScope == SystemLevel) {\r
+ //\r
+ // Open all FormSet by locate HII packages.\r
+ // Initiliaze the maintain FormSet to store default data as back up data.\r
+ //\r
+ BackUpFormSet = gOldFormSet;\r
+ gOldFormSet = NULL;\r
+\r
+ //\r
+ // Get all the Hii handles\r
+ //\r
+ HiiHandles = HiiGetHiiHandles (NULL);\r
+ ASSERT (HiiHandles != NULL);\r
+\r
+ //\r
+ // Search for formset of each class type\r
+ //\r
+ for (Index = 0; HiiHandles[Index] != NULL; Index++) {\r
+ //\r
+ // Check HiiHandles[Index] does exist in global maintain list. \r
+ //\r
+ if (GetFormSetFromHiiHandle (HiiHandles[Index]) != NULL) {\r
+ continue;\r
+ }\r
+ \r
+ //\r
+ // Initilize FormSet Setting\r
+ //\r
+ LocalFormSet = AllocateZeroPool (sizeof (FORM_BROWSER_FORMSET));\r
+ ASSERT (LocalFormSet != NULL);\r
+ ZeroMem (&ZeroGuid, sizeof (ZeroGuid));\r
+ Status = InitializeFormSet (HiiHandles[Index], &ZeroGuid, LocalFormSet, FALSE);\r
+ if (EFI_ERROR (Status) || IsListEmpty (&LocalFormSet->FormListHead)) {\r
+ DestroyFormSet (LocalFormSet);\r
+ continue;\r
+ }\r
+ Status = InitializeCurrentSetting (LocalFormSet);\r
+ if (EFI_ERROR (Status)) {\r
+ DestroyFormSet (LocalFormSet);\r
+ continue;\r
+ }\r
+ //\r
+ // Initilize Questions' Value\r
+ //\r
+ LoadFormSetConfig (NULL, LocalFormSet);\r
+ if (EFI_ERROR (Status)) {\r
+ DestroyFormSet (LocalFormSet);\r
+ continue;\r
+ }\r
+\r
+ //\r
+ // Add FormSet into the maintain list.\r
+ //\r
+ InsertTailList (&gBrowserFormSetList, &LocalFormSet->Link);\r
+ }\r
+ \r
+ //\r
+ // Free resources, and restore gOldFormSet and gClassOfVfr\r
+ //\r
+ FreePool (HiiHandles);\r
+ gOldFormSet = BackUpFormSet;\r
+ \r
+ //\r
+ // Set Default Value for each FormSet in the maintain list.\r
+ //\r
+ Link = GetFirstNode (&gBrowserFormSetList);\r
+ while (!IsNull (&gBrowserFormSetList, Link)) {\r
+ LocalFormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);\r
+ ExtractDefault (LocalFormSet, NULL, DefaultId, FormSetLevel);\r
+ Link = GetNextNode (&gBrowserFormSetList, Link);\r
+ }\r
}\r
\r
return EFI_SUCCESS;\r
@param Selection Selection contains the information about \r
the Selection, form and formset to be displayed.\r
Selection action may be updated in retrieve callback.\r
+ If Selection is NULL, only initialize Question value.\r
@param FormSet FormSet data structure.\r
@param Form Form data structure.\r
\r
//\r
// According the spec, ref opcode try to get value from call back with "retrieve" type.\r
//\r
- if ((Question->Operand == EFI_IFR_REF_OP) && (FormSet->ConfigAccess != NULL)) {\r
+ if ((Question->Operand == EFI_IFR_REF_OP) && (FormSet->ConfigAccess != NULL) && (Selection != NULL)) {\r
Status = ProcessCallBackFunction(Selection, Question, EFI_BROWSER_ACTION_RETRIEVE, TRUE);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
// Check whether EfiVarstore with CallBack can be got.\r
//\r
if ((FormSet->ConfigAccess != NULL) &&\r
+ (Selection != NULL) &&\r
(Selection->Action != UI_ACTION_REFRESH_FORMSET) &&\r
(Question->QuestionId != 0) && \r
(Question->Storage != NULL) &&\r
@param Selection Selection contains the information about \r
the Selection, form and formset to be displayed.\r
Selection action may be updated in retrieve callback.\r
+ If Selection is NULL, only initialize Question value.\r
@param FormSet FormSet data structure.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
//\r
// Extract default from IFR binary\r
//\r
- Status = ExtractFormSetDefault (FormSet, EFI_HII_DEFAULT_CLASS_STANDARD);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
+ ExtractDefault (FormSet, NULL, EFI_HII_DEFAULT_CLASS_STANDARD, FormSetLevel);\r
+ UpdateNvInfoInForm (FormSet, FALSE);\r
\r
//\r
// Request current settings from Configuration Driver\r
//\r
// if FormSetGuid is NULL or zero GUID, return first Setup FormSet in the package list\r
//\r
- if (FormSetGuid == NULL || CompareGuid (FormSetGuid, &gZeroGuid)) {\r
- ComparingGuid = &gEfiHiiPlatformSetupFormsetGuid;\r
+ if (FormSetGuid == NULL) {\r
+ ComparingGuid = &gZeroGuid;\r
} else {\r
ComparingGuid = FormSetGuid;\r
}\r
//\r
// Try to compare against formset GUID\r
//\r
- if (CompareGuid (ComparingGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {\r
+ if (CompareGuid (FormSetGuid, &gZeroGuid) || \r
+ CompareGuid (ComparingGuid, (EFI_GUID *)(OpCodeData + sizeof (EFI_IFR_OP_HEADER)))) {\r
break;\r
}\r
\r
return EFI_NOT_FOUND;\r
}\r
\r
- if (ClassGuidMatch && (FormSetGuid != NULL)) {\r
+ if (FormSetGuid != NULL) {\r
//\r
// Return the FormSet GUID\r
//\r
found in package list.\r
On output, GUID of the formset found(if not NULL).\r
@param FormSet FormSet data structure.\r
+ @param UpdateGlobalVar Whether need to update the global variable.\r
\r
@retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_NOT_FOUND The specified FormSet could not be found.\r
InitializeFormSet (\r
IN EFI_HII_HANDLE Handle,\r
IN OUT EFI_GUID *FormSetGuid,\r
- OUT FORM_BROWSER_FORMSET *FormSet\r
+ OUT FORM_BROWSER_FORMSET *FormSet,\r
+ IN BOOLEAN UpdateGlobalVar \r
)\r
{\r
EFI_STATUS Status;\r
return Status;\r
}\r
\r
+ FormSet->Signature = FORM_BROWSER_FORMSET_SIGNATURE;\r
FormSet->HiiHandle = Handle;\r
CopyMem (&FormSet->Guid, FormSetGuid, sizeof (EFI_GUID));\r
\r
return Status;\r
}\r
\r
+ // \r
+ // If not need to update the global variable, just return.\r
+ //\r
+ if (!UpdateGlobalVar) {\r
+ return Status;\r
+ }\r
+\r
//\r
// Set VFR type by FormSet SubClass field\r
//\r
\r
if ((gClassOfVfr & FORMSET_CLASS_FRONT_PAGE) == FORMSET_CLASS_FRONT_PAGE) {\r
gFrontPageHandle = FormSet->HiiHandle;\r
+ gFunctionKeySetting = NONE_FUNCTION_KEY_SETTING;\r
}\r
\r
//\r
// Update the function key setting.\r
//\r
gFunctionKeySetting = gFunctionKeySettingTable[Index].KeySetting;\r
- //\r
- // Function key prompt can not be displayed if the function key has been disabled.\r
- //\r
- if ((gFunctionKeySetting & FUNCTION_NINE) != FUNCTION_NINE) {\r
- gFunctionNineString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
- }\r
-\r
- if ((gFunctionKeySetting & FUNCTION_TEN) != FUNCTION_TEN) {\r
- gFunctionTenString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
- }\r
}\r
}\r
\r
- return Status;\r
+ return EFI_SUCCESS;\r
}\r
\r
\r
Context->FunctionKeySetting = gFunctionKeySetting;\r
Context->ResetRequired = gResetRequired;\r
Context->Direction = gDirection;\r
- Context->FunctionNineString = gFunctionNineString;\r
- Context->FunctionTenString = gFunctionTenString;\r
Context->EnterString = gEnterString;\r
Context->EnterCommitString = gEnterCommitString;\r
Context->EnterEscapeString = gEnterEscapeString;\r
Context->EscapeString = gEscapeString;\r
- Context->SaveFailed = gSaveFailed;\r
Context->MoveHighlight = gMoveHighlight;\r
Context->MakeSelection = gMakeSelection;\r
Context->DecNumericInput = gDecNumericInput;\r
gFunctionKeySetting = Context->FunctionKeySetting;\r
gResetRequired = Context->ResetRequired;\r
gDirection = Context->Direction;\r
- gFunctionNineString = Context->FunctionNineString;\r
- gFunctionTenString = Context->FunctionTenString;\r
gEnterString = Context->EnterString;\r
gEnterCommitString = Context->EnterCommitString;\r
gEnterEscapeString = Context->EnterEscapeString;\r
gEscapeString = Context->EscapeString;\r
- gSaveFailed = Context->SaveFailed;\r
gMoveHighlight = Context->MoveHighlight;\r
gMakeSelection = Context->MakeSelection;\r
gDecNumericInput = Context->DecNumericInput;\r
RemoveEntryList (&Context->Link);\r
gBS->FreePool (Context);\r
}\r
+\r
+/**\r
+ Find the matched FormSet context in the backup maintain list based on HiiHandle.\r
+ \r
+ @param Handle The Hii Handle.\r
+ \r
+ @return the found FormSet context. If no found, NULL will return.\r
+\r
+**/\r
+FORM_BROWSER_FORMSET * \r
+GetFormSetFromHiiHandle (\r
+ EFI_HII_HANDLE Handle\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ FORM_BROWSER_FORMSET *FormSet;\r
+\r
+ Link = GetFirstNode (&gBrowserFormSetList);\r
+ while (!IsNull (&gBrowserFormSetList, Link)) {\r
+ FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);\r
+ if (FormSet->HiiHandle == Handle) {\r
+ return FormSet;\r
+ }\r
+ Link = GetNextNode (&gBrowserFormSetList, Link);\r
+ }\r
+ \r
+ return NULL;\r
+}\r
+\r
+/**\r
+ Check whether the input HII handle is the FormSet that is being used.\r
+ \r
+ @param Handle The Hii Handle.\r
+ \r
+ @retval TRUE HII handle is being used.\r
+ @retval FALSE HII handle is not being used.\r
+\r
+**/\r
+BOOLEAN\r
+IsHiiHandleInBrowserContext (\r
+ EFI_HII_HANDLE Handle\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ BROWSER_CONTEXT *Context;\r
+\r
+ //\r
+ // HiiHandle is Current FormSet.\r
+ //\r
+ if ((gOldFormSet != NULL) && (gOldFormSet->HiiHandle == Handle)) {\r
+ return TRUE;\r
+ }\r
+\r
+ //\r
+ // Check whether HiiHandle is in BrowserContext.\r
+ //\r
+ Link = GetFirstNode (&gBrowserContextList);\r
+ while (!IsNull (&gBrowserContextList, Link)) {\r
+ Context = BROWSER_CONTEXT_FROM_LINK (Link);\r
+ if (Context->OldFormSet->HiiHandle == Handle) {\r
+ //\r
+ // HiiHandle is in BrowserContext\r
+ //\r
+ return TRUE;\r
+ }\r
+ Link = GetNextNode (&gBrowserContextList, Link);\r
+ }\r
+ \r
+ return FALSE;\r
+}\r
+\r
+/**\r
+ Find the registered HotKey based on KeyData.\r
+ \r
+ @param[in] KeyData A pointer to a buffer that describes the keystroke\r
+ information for the hot key.\r
+\r
+ @return The registered HotKey context. If no found, NULL will return.\r
+**/\r
+BROWSER_HOT_KEY *\r
+GetHotKeyFromRegisterList (\r
+ IN EFI_INPUT_KEY *KeyData\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ BROWSER_HOT_KEY *HotKey;\r
+\r
+ Link = GetFirstNode (&gBrowserHotKeyList);\r
+ while (!IsNull (&gBrowserHotKeyList, Link)) {\r
+ HotKey = BROWSER_HOT_KEY_FROM_LINK (Link);\r
+ if (HotKey->KeyData->ScanCode == KeyData->ScanCode) {\r
+ return HotKey;\r
+ }\r
+ Link = GetNextNode (&gBrowserHotKeyList, Link);\r
+ }\r
+ \r
+ return NULL;\r
+}\r
+\r
+/**\r
+ Configure what scope the hot key will impact.\r
+ All hot keys have the same scope. The mixed hot keys with the different level are not supported.\r
+ If no scope is set, the default scope will be FormSet level.\r
+ After all registered hot keys are removed, previous Scope can reset to another level.\r
+ \r
+ @param[in] Scope Scope level to be set. \r
+ \r
+ @retval EFI_SUCCESS Scope is set correctly.\r
+ @retval EFI_INVALID_PARAMETER Scope is not the valid value specified in BROWSER_SETTING_SCOPE. \r
+ @retval EFI_UNSPPORTED Scope level is different from current one that the registered hot keys have.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SetScope (\r
+ IN BROWSER_SETTING_SCOPE Scope\r
+ )\r
+{\r
+ if (Scope >= MaxLevel) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ \r
+ //\r
+ // When no hot key registered in system or on the first setting,\r
+ // Scope can be set.\r
+ //\r
+ if (mBrowserScopeFirstSet || IsListEmpty (&gBrowserHotKeyList)) {\r
+ gBrowserSettingScope = Scope;\r
+ mBrowserScopeFirstSet = FALSE;\r
+ } else if (Scope != gBrowserSettingScope) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Register the hot key with its browser action, or unregistered the hot key.\r
+ Only support hot key that is not printable character (control key, function key, etc.).\r
+ If the action value is zero, the hot key will be unregistered if it has been registered.\r
+ If the same hot key has been registered, the new action and help string will override the previous ones.\r
+ \r
+ @param[in] KeyData A pointer to a buffer that describes the keystroke\r
+ information for the hot key. Its type is EFI_INPUT_KEY to \r
+ be supported by all ConsoleIn devices.\r
+ @param[in] Action Action value that describes what action will be trigged when the hot key is pressed. \r
+ @param[in] DefaultId Specifies the type of defaults to retrieve, which is only for DEFAULT action.\r
+ @param[in] HelpString Help string that describes the hot key information.\r
+ Its value may be NULL for the unregistered hot key.\r
+ \r
+ @retval EFI_SUCCESS Hot key is registered or unregistered.\r
+ @retval EFI_INVALID_PARAMETER KeyData is NULL or HelpString is NULL on register.\r
+ @retval EFI_NOT_FOUND KeyData is not found to be unregistered.\r
+ @retval EFI_UNSUPPORTED Key represents a printable character. It is conflicted with Browser.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+RegisterHotKey (\r
+ IN EFI_INPUT_KEY *KeyData,\r
+ IN UINT32 Action,\r
+ IN UINT16 DefaultId,\r
+ IN EFI_STRING HelpString OPTIONAL\r
+ )\r
+{\r
+ BROWSER_HOT_KEY *HotKey;\r
+\r
+ //\r
+ // Check input parameters.\r
+ //\r
+ if (KeyData == NULL || KeyData->UnicodeChar != CHAR_NULL || \r
+ (Action != BROWSER_ACTION_UNREGISTER && HelpString == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ // Check whether the input KeyData is in BrowserHotKeyList.\r
+ //\r
+ HotKey = GetHotKeyFromRegisterList (KeyData);\r
+ \r
+ //\r
+ // Unregister HotKey\r
+ //\r
+ if (Action == BROWSER_ACTION_UNREGISTER) {\r
+ if (HotKey != NULL) {\r
+ //\r
+ // The registered HotKey is found. \r
+ // Remove it from List, and free its resource.\r
+ //\r
+ RemoveEntryList (&HotKey->Link);\r
+ FreePool (HotKey->KeyData);\r
+ FreePool (HotKey->HelpString);\r
+ return EFI_SUCCESS;\r
+ } else {\r
+ //\r
+ // The registered HotKey is not found. \r
+ //\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ }\r
+ \r
+ //\r
+ // Register HotKey into List.\r
+ //\r
+ if (HotKey == NULL) {\r
+ //\r
+ // Create new Key, and add it into List.\r
+ //\r
+ HotKey = AllocateZeroPool (sizeof (BROWSER_HOT_KEY));\r
+ ASSERT (HotKey != NULL);\r
+ HotKey->Signature = BROWSER_HOT_KEY_SIGNATURE;\r
+ HotKey->KeyData = AllocateCopyPool (sizeof (EFI_INPUT_KEY), KeyData);\r
+ InsertTailList (&gBrowserHotKeyList, &HotKey->Link);\r
+ }\r
+\r
+ //\r
+ // Fill HotKey information.\r
+ //\r
+ HotKey->Action = Action;\r
+ HotKey->DefaultId = DefaultId;\r
+ if (HotKey->HelpString != NULL) {\r
+ FreePool (HotKey->HelpString);\r
+ }\r
+ HotKey->HelpString = AllocateCopyPool (StrSize (HelpString), HelpString);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Register Exit handler function. \r
+ When more than one handler function is registered, the latter one will override the previous one. \r
+ When NULL handler is specified, the previous Exit handler will be unregistered. \r
+ \r
+ @param[in] Handler Pointer to handler function. \r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+RegiserExitHandler (\r
+ IN EXIT_HANDLER Handler\r
+ )\r
+{\r
+ ExitHandlerFunction = Handler;\r
+ return;\r
+}\r
+\r
+/**\r
+ Create reminder to let user to choose save or discard the changed browser data.\r
+ Caller can use it to actively check the changed browser data.\r
+\r
+ @retval BROWSER_NO_CHANGES No browser data is changed.\r
+ @retval BROWSER_SAVE_CHANGES The changed browser data is saved.\r
+ @retval BROWSER_DISCARD_CHANGES The changed browser data is discard.\r
+\r
+**/\r
+UINT32\r
+EFIAPI\r
+SaveReminder (\r
+ VOID\r
+ )\r
+{\r
+ LIST_ENTRY *Link;\r
+ FORM_BROWSER_FORMSET *FormSet;\r
+ BOOLEAN IsDataChanged;\r
+ UINT32 DataSavedAction;\r
+ CHAR16 *YesResponse;\r
+ CHAR16 *NoResponse;\r
+ CHAR16 *EmptyString;\r
+ CHAR16 *ChangeReminderString;\r
+ CHAR16 *SaveConfirmString;\r
+ EFI_INPUT_KEY Key;\r
+\r
+ DataSavedAction = BROWSER_NO_CHANGES;\r
+ IsDataChanged = FALSE;\r
+ Link = GetFirstNode (&gBrowserFormSetList);\r
+ while (!IsNull (&gBrowserFormSetList, Link)) {\r
+ FormSet = FORM_BROWSER_FORMSET_FROM_LINK (Link);\r
+ if (IsNvUpdateRequired (FormSet)) {\r
+ IsDataChanged = TRUE;\r
+ break;\r
+ }\r
+ Link = GetNextNode (&gBrowserFormSetList, Link);\r
+ }\r
+ \r
+ //\r
+ // No data is changed. No save is required. \r
+ //\r
+ if (!IsDataChanged) {\r
+ return DataSavedAction;\r
+ }\r
+ \r
+ //\r
+ // If data is changed, prompt user\r
+ //\r
+ gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);\r
+\r
+ YesResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_YES), gHiiHandle);\r
+ ASSERT (YesResponse != NULL);\r
+ NoResponse = GetToken (STRING_TOKEN (ARE_YOU_SURE_NO), gHiiHandle);\r
+ ASSERT (NoResponse != NULL);\r
+ EmptyString = GetToken (STRING_TOKEN (EMPTY_STRING), gHiiHandle);\r
+ ChangeReminderString = GetToken (STRING_TOKEN (CHANGE_REMINDER), gHiiHandle);\r
+ SaveConfirmString = GetToken (STRING_TOKEN (SAVE_CONFIRM), gHiiHandle);\r
+\r
+ do {\r
+ CreateDialog (4, TRUE, 0, NULL, &Key, EmptyString, ChangeReminderString, SaveConfirmString, EmptyString);\r
+ } while\r
+ (((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (NoResponse[0] | UPPER_LOWER_CASE_OFFSET)) &&\r
+ ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) != (YesResponse[0] | UPPER_LOWER_CASE_OFFSET))\r
+ );\r
+\r
+ //\r
+ // If the user hits the YesResponse key\r
+ //\r
+ if ((Key.UnicodeChar | UPPER_LOWER_CASE_OFFSET) == (YesResponse[0] | UPPER_LOWER_CASE_OFFSET)) {\r
+ SubmitForm (NULL, NULL, SystemLevel);\r
+ DataSavedAction = BROWSER_SAVE_CHANGES;\r
+ } else {\r
+ DiscardForm (NULL, NULL, SystemLevel);\r
+ DataSavedAction = BROWSER_DISCARD_CHANGES;\r
+ gResetRequired = FALSE;\r
+ }\r
+\r
+ FreePool (YesResponse);\r
+ FreePool (NoResponse);\r
+ FreePool (EmptyString);\r
+ FreePool (SaveConfirmString);\r
+ FreePool (ChangeReminderString);\r
+\r
+ return DataSavedAction;\r
+}\r
projects / mirror_edk2.git / blobdiff