This is an example of how a driver might export data to the HII protocol to be\r
later utilized by the Setup Protocol\r
\r
-Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2017, 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
CHAR16 VariableName[] = L"MyIfrNVData";\r
CHAR16 MyEfiVar[] = L"MyEfiVar";\r
+CHAR16 MyEfiBitVar[] = L"MyEfiBitVar";\r
+CHAR16 MyEfiUnionVar[] = L"MyEfiUnionVar";\r
+\r
EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r
DRIVER_SAMPLE_PRIVATE_DATA *mPrivateData = NULL;\r
EFI_EVENT mEvent;\r
}\r
}\r
\r
-/**\r
- Add empty function for event process function.\r
-\r
- @param Event The Event need to be process\r
- @param Context The context of the event.\r
-\r
-**/\r
-VOID\r
-EFIAPI\r
-DriverSampleInternalEmptyFunction (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-{\r
-}\r
-\r
/**\r
Notification function for keystrokes.\r
\r
return EFI_SUCCESS;\r
}\r
\r
-\r
-/**\r
- Encode the password using a simple algorithm.\r
-\r
- @param Password The string to be encoded.\r
- @param MaxSize The size of the string.\r
-\r
-**/\r
-VOID\r
-EncodePassword (\r
- IN CHAR16 *Password,\r
- IN UINTN MaxSize\r
- )\r
-{\r
- UINTN Index;\r
- UINTN Loop;\r
- CHAR16 *Buffer;\r
- CHAR16 *Key;\r
-\r
- Key = L"MAR10648567";\r
- Buffer = AllocateZeroPool (MaxSize);\r
- ASSERT (Buffer != NULL);\r
-\r
- for (Index = 0; Key[Index] != 0; Index++) {\r
- for (Loop = 0; Loop < (UINT8) (MaxSize / 2); Loop++) {\r
- Buffer[Loop] = (CHAR16) (Password[Loop] ^ Key[Index]);\r
- }\r
- }\r
-\r
- CopyMem (Password, Buffer, MaxSize);\r
-\r
- FreePool (Buffer);\r
- return ;\r
-}\r
-\r
-/**\r
- Validate the user's password.\r
-\r
- @param PrivateData This driver's private context data.\r
- @param StringId The user's input.\r
-\r
- @retval EFI_SUCCESS The user's input matches the password.\r
- @retval EFI_NOT_READY The user's input does not match the password.\r
-**/\r
-EFI_STATUS\r
-ValidatePassword (\r
- IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
- IN EFI_STRING_ID StringId\r
- )\r
-{\r
- EFI_STATUS Status;\r
- UINTN Index;\r
- UINTN BufferSize;\r
- UINTN PasswordMaxSize;\r
- CHAR16 *Password;\r
- CHAR16 *EncodedPassword;\r
- BOOLEAN OldPassword;\r
-\r
- //\r
- // Get encoded password first\r
- //\r
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Status = gRT->GetVariable (\r
- VariableName,\r
- &gDriverSampleFormSetGuid,\r
- NULL,\r
- &BufferSize,\r
- &PrivateData->Configuration\r
- );\r
- if (EFI_ERROR (Status)) {\r
- //\r
- // Old password not exist, prompt for new password\r
- //\r
- return EFI_SUCCESS;\r
- }\r
-\r
- OldPassword = FALSE;\r
- PasswordMaxSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r
- //\r
- // Check whether we have any old password set\r
- //\r
- for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {\r
- if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {\r
- OldPassword = TRUE;\r
- break;\r
- }\r
- }\r
- if (!OldPassword) {\r
- //\r
- // Old password not exist, return EFI_SUCCESS to prompt for new password\r
- //\r
- return EFI_SUCCESS;\r
- }\r
-\r
- //\r
- // Get user input password\r
- //\r
- Password = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r
- if (Password == NULL) {\r
- return EFI_NOT_READY;\r
- }\r
- if (StrSize (Password) > PasswordMaxSize) {\r
- FreePool (Password);\r
- return EFI_NOT_READY;\r
- }\r
-\r
- //\r
- // Validate old password\r
- //\r
- EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
- ASSERT (EncodedPassword != NULL);\r
- StrnCpyS (EncodedPassword, PasswordMaxSize / sizeof (CHAR16), Password, StrLen (Password));\r
- EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));\r
- if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, PasswordMaxSize) != 0) {\r
- //\r
- // Old password mismatch, return EFI_NOT_READY to prompt for error message\r
- //\r
- Status = EFI_NOT_READY;\r
- } else {\r
- Status = EFI_SUCCESS;\r
- }\r
-\r
- FreePool (Password);\r
- FreePool (EncodedPassword);\r
-\r
- return Status;\r
-}\r
-\r
-/**\r
- Encode the password using a simple algorithm.\r
-\r
- @param PrivateData This driver's private context data.\r
- @param StringId The password from User.\r
-\r
- @retval EFI_SUCESS The operation is successful.\r
- @return Other value if gRT->SetVariable () fails.\r
-\r
-**/\r
-EFI_STATUS\r
-SetPassword (\r
- IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
- IN EFI_STRING_ID StringId\r
- )\r
-{\r
- EFI_STATUS Status;\r
- CHAR16 *Password;\r
- CHAR16 *TempPassword;\r
- UINTN PasswordSize;\r
- DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
- UINTN BufferSize;\r
-\r
- //\r
- // Get Buffer Storage data from EFI variable\r
- //\r
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Status = gRT->GetVariable (\r
- VariableName,\r
- &gDriverSampleFormSetGuid,\r
- NULL,\r
- &BufferSize,\r
- &PrivateData->Configuration\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- //\r
- // Get user input password\r
- //\r
- Password = PrivateData->Configuration.WhatIsThePassword2;\r
- PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r
- ZeroMem (Password, PasswordSize);\r
-\r
- TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r
- if (TempPassword == NULL) {\r
- return EFI_NOT_READY;\r
- }\r
- if (StrSize (TempPassword) > PasswordSize) {\r
- FreePool (TempPassword);\r
- return EFI_NOT_READY;\r
- }\r
- StrnCpyS (Password, PasswordSize / sizeof (CHAR16), TempPassword, StrLen (TempPassword));\r
- FreePool (TempPassword);\r
-\r
- //\r
- // Retrive uncommitted data from Browser\r
- //\r
- Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
- ASSERT (Configuration != NULL);\r
- if (HiiGetBrowserData (&gDriverSampleFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r
- //\r
- // Update password's clear text in the screen\r
- //\r
- CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r
-\r
- //\r
- // Update uncommitted data of Browser\r
- //\r
- HiiSetBrowserData (\r
- &gDriverSampleFormSetGuid,\r
- VariableName,\r
- sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
- (UINT8 *) Configuration,\r
- NULL\r
- );\r
- }\r
-\r
- //\r
- // Free Configuration Buffer\r
- //\r
- FreePool (Configuration);\r
-\r
-\r
- //\r
- // Set password\r
- //\r
- EncodePassword (Password, StrLen (Password) * 2);\r
- Status = gRT->SetVariable(\r
- VariableName,\r
- &gDriverSampleFormSetGuid,\r
- EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
- sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
- &PrivateData->Configuration\r
- );\r
- return Status;\r
-}\r
-\r
/**\r
Update names of Name/Value storage to current language.\r
\r
if (HiiIsConfigHdrMatch(Request, &gDriverSampleFormSetGuid, MyEfiVar)) {\r
return EFI_UNSUPPORTED;\r
}\r
+ if (HiiIsConfigHdrMatch(Request, &gDriverSampleFormSetGuid, MyEfiBitVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ if (HiiIsConfigHdrMatch(Request, &gDriverSampleFormSetGuid, MyEfiUnionVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
//\r
// Set Request to the unified request string.\r
//\r
\r
BackupChar = Value[ValueStrLen];\r
*Value++ = L'=';\r
- Value += UnicodeValueToString (\r
- Value, \r
- PREFIX_ZERO | RADIX_HEX, \r
- PrivateData->Configuration.NameValueVar0, \r
- sizeof (PrivateData->Configuration.NameValueVar0) * 2\r
- );\r
+ UnicodeValueToStringS (\r
+ Value,\r
+ BufferSize - ((UINTN)Value - (UINTN)*Results),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ PrivateData->Configuration.NameValueVar0,\r
+ sizeof (PrivateData->Configuration.NameValueVar0) * 2\r
+ );\r
+ Value += StrnLenS (Value, (BufferSize - ((UINTN)Value - (UINTN)*Results)) / sizeof (CHAR16));\r
*Value = BackupChar;\r
}\r
\r
\r
BackupChar = Value[ValueStrLen];\r
*Value++ = L'=';\r
- Value += UnicodeValueToString (\r
- Value, \r
- PREFIX_ZERO | RADIX_HEX, \r
- PrivateData->Configuration.NameValueVar1, \r
- sizeof (PrivateData->Configuration.NameValueVar1) * 2\r
- );\r
+ UnicodeValueToStringS (\r
+ Value,\r
+ BufferSize - ((UINTN)Value - (UINTN)*Results),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ PrivateData->Configuration.NameValueVar1,\r
+ sizeof (PrivateData->Configuration.NameValueVar1) * 2\r
+ );\r
+ Value += StrnLenS (Value, (BufferSize - ((UINTN)Value - (UINTN)*Results)) / sizeof (CHAR16));\r
*Value = BackupChar;\r
}\r
\r
//\r
StrPointer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r
for (; *StrPointer != L'\0'; StrPointer++) {\r
- Value += UnicodeValueToString (Value, PREFIX_ZERO | RADIX_HEX, *StrPointer, 4);\r
+ UnicodeValueToStringS (\r
+ Value,\r
+ BufferSize - ((UINTN)Value - (UINTN)*Results),\r
+ PREFIX_ZERO | RADIX_HEX,\r
+ *StrPointer,\r
+ 4\r
+ );\r
+ Value += StrnLenS (Value, (BufferSize - ((UINTN)Value - (UINTN)*Results)) / sizeof (CHAR16));\r
}\r
}\r
\r
if (HiiIsConfigHdrMatch(Configuration, &gDriverSampleFormSetGuid, MyEfiVar)) {\r
return EFI_UNSUPPORTED;\r
}\r
+ if (HiiIsConfigHdrMatch(Configuration, &gDriverSampleFormSetGuid, MyEfiBitVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ if (HiiIsConfigHdrMatch(Configuration, &gDriverSampleFormSetGuid, MyEfiUnionVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
\r
//\r
// Get Buffer Storage data from EFI variable\r
CHAR16 *TmpStr;\r
UINTN Index;\r
UINT64 BufferValue;\r
+ EFI_HII_POPUP_SELECTION UserSelection;\r
+\r
+ UserSelection = 0xFF;\r
\r
if (((Value == NULL) && (Action != EFI_BROWSER_ACTION_FORM_OPEN) && (Action != EFI_BROWSER_ACTION_FORM_CLOSE))||\r
(ActionRequest == NULL)) {\r
}\r
break;\r
\r
+ case 0x6666:\r
+ Value->u8 = 12;\r
+ break;\r
+\r
default:\r
Status = EFI_UNSUPPORTED;\r
break;\r
Value->u8 = DEFAULT_CLASS_MANUFACTURING_VALUE;\r
break;\r
\r
+ case 0x6666:\r
+ Value->u8 = 13;\r
+ break;\r
+\r
default:\r
Status = EFI_UNSUPPORTED; \r
break;\r
HiiFreeOpCodeHandle (EndOpCodeHandle);\r
break;\r
\r
- case 0x2000:\r
- //\r
- // Only used to update the state.\r
- //\r
- if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0) && \r
- (PrivateData->PasswordState == BROWSER_STATE_SET_PASSWORD)) {\r
- PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
- return EFI_INVALID_PARAMETER;\r
- }\r
-\r
- //\r
- // When try to set a new password, user will be chanlleged with old password.\r
- // The Callback is responsible for validating old password input by user,\r
- // If Callback return EFI_SUCCESS, it indicates validation pass.\r
- //\r
- switch (PrivateData->PasswordState) {\r
- case BROWSER_STATE_VALIDATE_PASSWORD:\r
- Status = ValidatePassword (PrivateData, Value->string);\r
- if (Status == EFI_SUCCESS) {\r
- PrivateData->PasswordState = BROWSER_STATE_SET_PASSWORD;\r
- }\r
- break;\r
-\r
- case BROWSER_STATE_SET_PASSWORD:\r
- Status = SetPassword (PrivateData, Value->string);\r
- PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
- break;\r
-\r
- default:\r
- break;\r
- }\r
-\r
- break;\r
-\r
default:\r
break;\r
}\r
}\r
break;\r
\r
+ case 0x1330:\r
+ Status = mPrivateData->HiiPopup->CreatePopup (\r
+ mPrivateData->HiiPopup,\r
+ EfiHiiPopupStyleInfo,\r
+ EfiHiiPopupTypeYesNo,\r
+ mPrivateData->HiiHandle[0],\r
+ STRING_TOKEN (STR_POPUP_STRING),\r
+ &UserSelection\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ if (UserSelection == EfiHiiPopupSelectionYes) {\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ }\r
+ }\r
+ break;\r
+\r
default:\r
break;\r
}\r
EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *HiiKeywordHandler;\r
+ EFI_HII_POPUP_PROTOCOL *PopupHandler;\r
CHAR16 *NewString;\r
UINTN BufferSize;\r
DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
EFI_STRING ConfigRequestHdr;\r
EFI_STRING NameRequestHdr;\r
MY_EFI_VARSTORE_DATA *VarStoreConfig;\r
+ MY_EFI_BITS_VARSTORE_DATA *BitsVarStoreConfig;\r
+ MY_EFI_UNION_DATA *UnionConfig;\r
EFI_INPUT_KEY HotKey;\r
- EFI_FORM_BROWSER_EXTENSION_PROTOCOL *FormBrowserEx;\r
+ EDKII_FORM_BROWSER_EXTENSION_PROTOCOL *FormBrowserEx;\r
\r
//\r
// Initialize the local variables.\r
mPrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r
mPrivateData->ConfigAccess.RouteConfig = RouteConfig;\r
mPrivateData->ConfigAccess.Callback = DriverCallback;\r
- mPrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\r
\r
//\r
// Locate Hii Database protocol\r
}\r
mPrivateData->HiiKeywordHandler = HiiKeywordHandler;\r
\r
+ //\r
+ // Locate HiiPopup protocol\r
+ //\r
+ Status = gBS->LocateProtocol (&gEfiHiiPopupProtocolGuid, NULL, (VOID **) &PopupHandler);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ mPrivateData->HiiPopup = PopupHandler;\r
+\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
&DriverHandle[0],\r
&gEfiDevicePathProtocolGuid,\r
}\r
FreePool (ConfigRequestHdr);\r
\r
+ //\r
+ // Initialize Bits efi varstore configuration data\r
+ //\r
+ BitsVarStoreConfig = &mPrivateData->BitsVarStoreConfig;\r
+ ZeroMem (BitsVarStoreConfig, sizeof (MY_EFI_BITS_VARSTORE_DATA));\r
+\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, MyEfiBitVar, DriverHandle[0]);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
+\r
+ BufferSize = sizeof (MY_EFI_BITS_VARSTORE_DATA);\r
+ Status = gRT->GetVariable (MyEfiBitVar, &gDriverSampleFormSetGuid, NULL, &BufferSize, BitsVarStoreConfig);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Store zero data to EFI variable Storage.\r
+ //\r
+ Status = gRT->SetVariable(\r
+ MyEfiBitVar,\r
+ &gDriverSampleFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (MY_EFI_BITS_VARSTORE_DATA),\r
+ BitsVarStoreConfig\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return Status;\r
+ }\r
+ //\r
+ // EFI variable for NV config doesn't exit, we should build this variable\r
+ // based on default values stored in IFR\r
+ //\r
+ ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ } else {\r
+ //\r
+ // EFI variable does exist and Validate Current Setting\r
+ //\r
+ ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+ FreePool (ConfigRequestHdr);\r
+\r
+ //\r
+ // Initialize Union efi varstore configuration data\r
+ //\r
+ UnionConfig = &mPrivateData->UnionConfig;\r
+ ZeroMem (UnionConfig, sizeof (MY_EFI_UNION_DATA));\r
+\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, MyEfiUnionVar, DriverHandle[0]);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
+\r
+ BufferSize = sizeof (MY_EFI_UNION_DATA);\r
+ Status = gRT->GetVariable (MyEfiUnionVar, &gDriverSampleFormSetGuid, NULL, &BufferSize, UnionConfig);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Store zero data to EFI variable Storage.\r
+ //\r
+ Status = gRT->SetVariable(\r
+ MyEfiUnionVar,\r
+ &gDriverSampleFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (MY_EFI_UNION_DATA),\r
+ UnionConfig\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return Status;\r
+ }\r
+ //\r
+ // EFI variable for NV config doesn't exit, we should build this variable\r
+ // based on default values stored in IFR\r
+ //\r
+ ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ } else {\r
+ //\r
+ // EFI variable does exist and Validate Current Setting\r
+ //\r
+ ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+ FreePool (ConfigRequestHdr);\r
+\r
Status = gBS->CreateEventEx (\r
EVT_NOTIFY_SIGNAL, \r
TPL_NOTIFY,\r
- DriverSampleInternalEmptyFunction,\r
+ EfiEventEmptyFunction,\r
NULL,\r
&gEfiIfrRefreshIdOpGuid,\r
&mEvent\r
//\r
// Example of how to use BrowserEx protocol to register HotKey.\r
// \r
- Status = gBS->LocateProtocol (&gEfiFormBrowserExProtocolGuid, NULL, (VOID **) &FormBrowserEx);\r
+ Status = gBS->LocateProtocol (&gEdkiiFormBrowserExProtocolGuid, NULL, (VOID **) &FormBrowserEx);\r
if (!EFI_ERROR (Status)) {\r
//\r
// First unregister the default hot key F9 and F10.\r
projects / mirror_edk2.git / blobdiff