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 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2015, 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
CHAR16 VariableName[] = L"MyIfrNVData";\r
CHAR16 MyEfiVar[] = L"MyEfiVar";\r
EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r
-DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;\r
+DRIVER_SAMPLE_PRIVATE_DATA *mPrivateData = NULL;\r
EFI_EVENT mEvent;\r
\r
HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {\r
//\r
EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
ASSERT (EncodedPassword != NULL);\r
- StrnCpy (EncodedPassword, Password, StrLen (Password));\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
FreePool (TempPassword);\r
return EFI_NOT_READY;\r
}\r
- StrnCpy (Password, TempPassword, StrLen (TempPassword));\r
+ StrnCpyS (Password, PasswordSize / sizeof (CHAR16), TempPassword, StrLen (TempPassword));\r
FreePool (TempPassword);\r
\r
//\r
\r
TmpStr = StringPtr;\r
if (Result != NULL) {\r
- StrCpy (StringPtr, Result);\r
+ StrCpyS (StringPtr, NewLen / sizeof (CHAR16), Result);\r
StringPtr += StrLen (Result); \r
FreePool (Result);\r
}\r
UINTN ValueWidth;\r
EFI_STATUS Status;\r
\r
+ TmpBuffer = NULL;\r
StringPtr = *RequestResult;\r
StringPtr = StrStr (StringPtr, L"OFFSET");\r
BlockSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
1 + sizeof (PrivateData->Configuration.NameValueVar2) * 2 + 1) * sizeof (CHAR16);\r
*Results = AllocateZeroPool (BufferSize);\r
ASSERT (*Results != NULL);\r
- StrCpy (*Results, ConfigRequest);\r
+ StrCpyS (*Results, BufferSize / sizeof (CHAR16), ConfigRequest);\r
Value = *Results;\r
\r
//\r
StrBuffer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r
ZeroMem (TemStr, sizeof (TemStr));\r
while (Value < StrPtr) {\r
- StrnCpy (TemStr, Value, 4);\r
+ StrnCpyS (TemStr, sizeof (TemStr) / sizeof (CHAR16), Value, 4);\r
*(StrBuffer++) = (CHAR16) StrHexToUint64 (TemStr);\r
Value += 4;\r
}\r
DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
MY_EFI_VARSTORE_DATA *EfiData;\r
EFI_FORM_ID FormId;\r
+ EFI_STRING Progress;\r
+ EFI_STRING Results;\r
+ UINT32 ProgressErr;\r
+ CHAR16 *TmpStr;\r
\r
if (((Value == NULL) && (Action != EFI_BROWSER_ACTION_FORM_OPEN) && (Action != EFI_BROWSER_ACTION_FORM_CLOSE))||\r
(ActionRequest == NULL)) {\r
\r
\r
FormId = 0;\r
+ ProgressErr = 0;\r
Status = EFI_SUCCESS;\r
PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
\r
\r
case EFI_BROWSER_ACTION_RETRIEVE:\r
{\r
- if (QuestionId == 0x1248) {\r
- {\r
- if (Type != EFI_IFR_TYPE_REF) {\r
- return EFI_INVALID_PARAMETER;\r
+ switch (QuestionId ) {\r
+ case 0x1248:\r
+ if (Type != EFI_IFR_TYPE_REF) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ Value->ref.FormId = 0x3;\r
+ break;\r
+\r
+ case 0x5678:\r
+ case 0x1247:\r
+ //\r
+ // We will reach here once the Question is refreshed\r
+ //\r
+\r
+ //\r
+ // Initialize the container for dynamic opcodes\r
+ //\r
+ StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+ ASSERT (StartOpCodeHandle != NULL);\r
+\r
+ //\r
+ // Create Hii Extend Label OpCode as the start opcode\r
+ //\r
+ StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
+ StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
+ if (QuestionId == 0x5678) {\r
+ StartLabel->Number = LABEL_UPDATE2;\r
+ FormId = 0x03;\r
+ PrivateData->Configuration.DynamicRefresh++;\r
+ } else if (QuestionId == 0x1247 ) {\r
+ StartLabel->Number = LABEL_UPDATE3;\r
+ FormId = 0x06;\r
+ PrivateData->Configuration.RefreshGuidCount++;\r
+ }\r
+\r
+ HiiCreateActionOpCode (\r
+ StartOpCodeHandle, // Container for dynamic created opcodes\r
+ 0x1237, // Question ID\r
+ STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
+ STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
+ EFI_IFR_FLAG_CALLBACK, // Question flag\r
+ 0 // Action String ID\r
+ );\r
+ \r
+ HiiUpdateForm (\r
+ PrivateData->HiiHandle[0], // HII handle\r
+ &gDriverSampleFormSetGuid, // Formset GUID\r
+ FormId, // Form ID\r
+ StartOpCodeHandle, // Label for where to insert opcodes\r
+ NULL // Insert data\r
+ );\r
+\r
+ HiiFreeOpCodeHandle (StartOpCodeHandle);\r
+\r
+ //\r
+ // Refresh the Question value\r
+ //\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
+\r
+ if (QuestionId == 0x5678) {\r
+ //\r
+ // Update uncommitted data of Browser\r
+ //\r
+ EfiData = AllocateZeroPool (sizeof (MY_EFI_VARSTORE_DATA));\r
+ ASSERT (EfiData != NULL);\r
+ if (HiiGetBrowserData (&gDriverSampleFormSetGuid, MyEfiVar, sizeof (MY_EFI_VARSTORE_DATA), (UINT8 *) EfiData)) {\r
+ EfiData->Field8 = 111;\r
+ HiiSetBrowserData (\r
+ &gDriverSampleFormSetGuid,\r
+ MyEfiVar,\r
+ sizeof (MY_EFI_VARSTORE_DATA),\r
+ (UINT8 *) EfiData,\r
+ NULL\r
+ );\r
}\r
- \r
- Value->ref.FormId = 0x3;\r
+ FreePool (EfiData);\r
}\r
+ break;\r
}\r
}\r
break;\r
HiiFreeOpCodeHandle (EndOpCodeHandle);\r
break;\r
\r
- case 0x5678:\r
- case 0x1247:\r
- //\r
- // We will reach here once the Question is refreshed\r
- //\r
-\r
- //\r
- // Initialize the container for dynamic opcodes\r
- //\r
- StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
- ASSERT (StartOpCodeHandle != NULL);\r
-\r
- //\r
- // Create Hii Extend Label OpCode as the start opcode\r
- //\r
- StartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (StartOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
- StartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
- if (QuestionId == 0x5678) {\r
- StartLabel->Number = LABEL_UPDATE2;\r
- FormId = 0x03;\r
- PrivateData->Configuration.DynamicRefresh++;\r
- } else if (QuestionId == 0x1247 ) {\r
- StartLabel->Number = LABEL_UPDATE3;\r
- FormId = 0x06;\r
- PrivateData->Configuration.RefreshGuidCount++;\r
- }\r
-\r
- HiiCreateActionOpCode (\r
- StartOpCodeHandle, // Container for dynamic created opcodes\r
- 0x1237, // Question ID\r
- STRING_TOKEN(STR_EXIT_TEXT), // Prompt text\r
- STRING_TOKEN(STR_EXIT_TEXT), // Help text\r
- EFI_IFR_FLAG_CALLBACK, // Question flag\r
- 0 // Action String ID\r
- );\r
-\r
- HiiUpdateForm (\r
- PrivateData->HiiHandle[0], // HII handle\r
- &gDriverSampleFormSetGuid, // Formset GUID\r
- FormId, // Form ID\r
- StartOpCodeHandle, // Label for where to insert opcodes\r
- NULL // Insert data\r
- );\r
-\r
- HiiFreeOpCodeHandle (StartOpCodeHandle);\r
-\r
- //\r
- // Refresh the Question value\r
- //\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
-\r
- if (QuestionId == 0x5678) {\r
- //\r
- // Update uncommitted data of Browser\r
- //\r
- EfiData = AllocateZeroPool (sizeof (MY_EFI_VARSTORE_DATA));\r
- ASSERT (EfiData != NULL);\r
- if (HiiGetBrowserData (&gDriverSampleFormSetGuid, MyEfiVar, sizeof (MY_EFI_VARSTORE_DATA), (UINT8 *) EfiData)) {\r
- EfiData->Field8 = 111;\r
- HiiSetBrowserData (\r
- &gDriverSampleFormSetGuid,\r
- MyEfiVar,\r
- sizeof (MY_EFI_VARSTORE_DATA),\r
- (UINT8 *) EfiData,\r
- NULL\r
- );\r
- }\r
- FreePool (EfiData);\r
- }\r
- break;\r
-\r
case 0x2000:\r
//\r
// Only used to update the state.\r
//\r
*ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;\r
break;\r
+\r
+ case 0x1231:\r
+ //\r
+ // 1. Check to see whether system support keyword.\r
+ //\r
+ Status = PrivateData->HiiKeywordHandler->GetData (PrivateData->HiiKeywordHandler,\r
+ L"NAMESPACE=x-UEFI-ns",\r
+ L"KEYWORD=iSCSIBootEnable",\r
+ &Progress,\r
+ &ProgressErr,\r
+ &Results\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ do {\r
+ CreatePopUp (\r
+ EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r
+ &Key,\r
+ L"",\r
+ L"This system not support this keyword!",\r
+ L"Press ENTER to continue ...",\r
+ L"",\r
+ NULL\r
+ );\r
+ } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
+\r
+ Status = EFI_SUCCESS;\r
+ break;\r
+ }\r
+\r
+ //\r
+ // 2. If system support this keyword, just try to change value.\r
+ //\r
\r
+ //\r
+ // Change value from '0' to '1' or from '1' to '0'\r
+ //\r
+ TmpStr = StrStr (Results, L"&VALUE=");\r
+ ASSERT (TmpStr != NULL);\r
+ TmpStr += StrLen (L"&VALUE=");\r
+ TmpStr++;\r
+ if (*TmpStr == L'0') {\r
+ *TmpStr = L'1';\r
+ } else {\r
+ *TmpStr = L'0';\r
+ }\r
+\r
+ //\r
+ // 3. Call the keyword handler protocol to change the value.\r
+ //\r
+ Status = PrivateData->HiiKeywordHandler->SetData (PrivateData->HiiKeywordHandler,\r
+ Results,\r
+ &Progress,\r
+ &ProgressErr\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ do {\r
+ CreatePopUp (\r
+ EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r
+ &Key,\r
+ L"",\r
+ L"Set keyword to the system failed!",\r
+ L"Press ENTER to continue ...",\r
+ L"",\r
+ NULL\r
+ );\r
+ } while (Key.UnicodeChar != CHAR_CARRIAGE_RETURN);\r
+\r
+ Status = EFI_SUCCESS;\r
+ break;\r
+ }\r
+ break;\r
+\r
default:\r
break;\r
}\r
EFI_HII_STRING_PROTOCOL *HiiString;\r
EFI_FORM_BROWSER2_PROTOCOL *FormBrowser2;\r
EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
+ EFI_CONFIG_KEYWORD_HANDLER_PROTOCOL *HiiKeywordHandler;\r
CHAR16 *NewString;\r
UINTN BufferSize;\r
DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
//\r
// Initialize driver private data\r
//\r
- PrivateData = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
- if (PrivateData == NULL) {\r
+ mPrivateData = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
+ if (mPrivateData == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
- PrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r
+ mPrivateData->Signature = DRIVER_SAMPLE_PRIVATE_SIGNATURE;\r
\r
- PrivateData->ConfigAccess.ExtractConfig = ExtractConfig;\r
- PrivateData->ConfigAccess.RouteConfig = RouteConfig;\r
- PrivateData->ConfigAccess.Callback = DriverCallback;\r
- PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\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
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- PrivateData->HiiDatabase = HiiDatabase;\r
+ mPrivateData->HiiDatabase = HiiDatabase;\r
\r
//\r
// Locate HiiString protocol\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- PrivateData->HiiString = HiiString;\r
+ mPrivateData->HiiString = HiiString;\r
\r
//\r
// Locate Formbrowser2 protocol\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- PrivateData->FormBrowser2 = FormBrowser2;\r
+ mPrivateData->FormBrowser2 = FormBrowser2;\r
\r
//\r
// Locate ConfigRouting protocol\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
- PrivateData->HiiConfigRouting = HiiConfigRouting;\r
+ mPrivateData->HiiConfigRouting = HiiConfigRouting;\r
+\r
+ //\r
+ // Locate keyword handler protocol\r
+ //\r
+ Status = gBS->LocateProtocol (&gEfiConfigKeywordHandlerProtocolGuid, NULL, (VOID **) &HiiKeywordHandler);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+ mPrivateData->HiiKeywordHandler = HiiKeywordHandler;\r
\r
Status = gBS->InstallMultipleProtocolInterfaces (\r
&DriverHandle[0],\r
&gEfiDevicePathProtocolGuid,\r
&mHiiVendorDevicePath0,\r
&gEfiHiiConfigAccessProtocolGuid,\r
- &PrivateData->ConfigAccess,\r
+ &mPrivateData->ConfigAccess,\r
NULL\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
- PrivateData->DriverHandle[0] = DriverHandle[0];\r
+ mPrivateData->DriverHandle[0] = DriverHandle[0];\r
\r
//\r
// Publish our HII data\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
- PrivateData->HiiHandle[0] = HiiHandle[0];\r
+ mPrivateData->HiiHandle[0] = HiiHandle[0];\r
\r
//\r
// Publish another Fromset\r
&DriverHandle[1],\r
&gEfiDevicePathProtocolGuid,\r
&mHiiVendorDevicePath1,\r
+ &gEfiHiiConfigAccessProtocolGuid,\r
+ &mPrivateData->ConfigAccess,\r
NULL\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
- PrivateData->DriverHandle[1] = DriverHandle[1];\r
+ mPrivateData->DriverHandle[1] = DriverHandle[1];\r
\r
HiiHandle[1] = HiiAddPackages (\r
&gDriverSampleInventoryGuid,\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
- PrivateData->HiiHandle[1] = HiiHandle[1];\r
+ mPrivateData->HiiHandle[1] = HiiHandle[1];\r
\r
//\r
// Update the device path string.\r
//\r
// Initialize Name/Value name String ID\r
//\r
- PrivateData->NameStringId[0] = STR_NAME_VALUE_VAR_NAME0;\r
- PrivateData->NameStringId[1] = STR_NAME_VALUE_VAR_NAME1;\r
- PrivateData->NameStringId[2] = STR_NAME_VALUE_VAR_NAME2;\r
+ mPrivateData->NameStringId[0] = STR_NAME_VALUE_VAR_NAME0;\r
+ mPrivateData->NameStringId[1] = STR_NAME_VALUE_VAR_NAME1;\r
+ mPrivateData->NameStringId[2] = STR_NAME_VALUE_VAR_NAME2;\r
\r
//\r
// Initialize configuration data\r
//\r
- Configuration = &PrivateData->Configuration;\r
+ Configuration = &mPrivateData->Configuration;\r
ZeroMem (Configuration, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
\r
//\r
//\r
// Initialize efi varstore configuration data\r
//\r
- VarStoreConfig = &PrivateData->VarStoreConfig;\r
+ VarStoreConfig = &mPrivateData->VarStoreConfig;\r
ZeroMem (VarStoreConfig, sizeof (MY_EFI_VARSTORE_DATA));\r
\r
ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, MyEfiVar, DriverHandle[0]);\r
// Register the default HotKey F9 and F10 again.\r
//\r
HotKey.ScanCode = SCAN_F10;\r
- NewString = HiiGetString (PrivateData->HiiHandle[0], STRING_TOKEN (FUNCTION_TEN_STRING), NULL);\r
+ NewString = HiiGetString (mPrivateData->HiiHandle[0], STRING_TOKEN (FUNCTION_TEN_STRING), NULL);\r
ASSERT (NewString != NULL);\r
FormBrowserEx->RegisterHotKey (&HotKey, BROWSER_ACTION_SUBMIT, 0, NewString);\r
HotKey.ScanCode = SCAN_F9;\r
- NewString = HiiGetString (PrivateData->HiiHandle[0], STRING_TOKEN (FUNCTION_NINE_STRING), NULL);\r
+ NewString = HiiGetString (mPrivateData->HiiHandle[0], STRING_TOKEN (FUNCTION_NINE_STRING), NULL);\r
ASSERT (NewString != NULL);\r
FormBrowserEx->RegisterHotKey (&HotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, NewString);\r
}\r
{\r
UINTN Index;\r
\r
- ASSERT (PrivateData != NULL);\r
+ ASSERT (mPrivateData != NULL);\r
\r
if (DriverHandle[0] != NULL) {\r
gBS->UninstallMultipleProtocolInterfaces (\r
&gEfiDevicePathProtocolGuid,\r
&mHiiVendorDevicePath0,\r
&gEfiHiiConfigAccessProtocolGuid,\r
- &PrivateData->ConfigAccess,\r
+ &mPrivateData->ConfigAccess,\r
NULL\r
);\r
DriverHandle[0] = NULL;\r
DriverHandle[1] = NULL;\r
}\r
\r
- if (PrivateData->HiiHandle[0] != NULL) {\r
- HiiRemovePackages (PrivateData->HiiHandle[0]);\r
+ if (mPrivateData->HiiHandle[0] != NULL) {\r
+ HiiRemovePackages (mPrivateData->HiiHandle[0]);\r
}\r
\r
- if (PrivateData->HiiHandle[1] != NULL) {\r
- HiiRemovePackages (PrivateData->HiiHandle[1]);\r
+ if (mPrivateData->HiiHandle[1] != NULL) {\r
+ HiiRemovePackages (mPrivateData->HiiHandle[1]);\r
}\r
\r
for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {\r
- if (PrivateData->NameValueName[Index] != NULL) {\r
- FreePool (PrivateData->NameValueName[Index]);\r
+ if (mPrivateData->NameValueName[Index] != NULL) {\r
+ FreePool (mPrivateData->NameValueName[Index]);\r
}\r
}\r
- FreePool (PrivateData);\r
- PrivateData = NULL;\r
+ FreePool (mPrivateData);\r
+ mPrivateData = NULL;\r
\r
gBS->CloseEvent (mEvent);\r
\r
projects / mirror_edk2.git / blobdiff