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 - 2008, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2010, 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
http://opensource.org/licenses/bsd-license.php\r
EFI_GUID mInventoryGuid = INVENTORY_GUID;\r
\r
CHAR16 VariableName[] = L"MyIfrNVData";\r
-\r
EFI_HANDLE DriverHandle[2] = {NULL, NULL};\r
DRIVER_SAMPLE_PRIVATE_DATA *PrivateData = NULL;\r
\r
{\r
END_DEVICE_PATH_TYPE,\r
END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
- { \r
+ {\r
(UINT8) (END_DEVICE_PATH_LENGTH),\r
(UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
}\r
{\r
END_DEVICE_PATH_TYPE,\r
END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
- { \r
+ {\r
(UINT8) (END_DEVICE_PATH_LENGTH),\r
(UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
}\r
\r
/**\r
Encode the password using a simple algorithm.\r
- \r
+\r
@param Password The string to be encoded.\r
@param MaxSize The size of the string.\r
- \r
+\r
**/\r
VOID\r
EncodePassword (\r
\r
/**\r
Validate the user's password.\r
- \r
+\r
@param PrivateData This driver's private context data.\r
@param StringId The user's input.\r
- \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 Status;\r
UINTN Index;\r
UINTN BufferSize;\r
+ UINTN PasswordMaxSize;\r
CHAR16 *Password;\r
CHAR16 *EncodedPassword;\r
BOOLEAN OldPassword;\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 < 20; Index++) {\r
+ for (Index = 0; Index < PasswordMaxSize / sizeof (UINT16); Index++) {\r
if (PrivateData->Configuration.WhatIsThePassword2[Index] != 0) {\r
OldPassword = TRUE;\r
break;\r
if (Password == NULL) {\r
return EFI_NOT_READY;\r
}\r
- if (StrLen (Password) > 20) {\r
+ if (StrSize (Password) > PasswordMaxSize) {\r
FreePool (Password);\r
return EFI_NOT_READY;\r
}\r
//\r
// Validate old password\r
//\r
- EncodedPassword = AllocateZeroPool (21 * sizeof (CHAR16));\r
+ EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
ASSERT (EncodedPassword != NULL);\r
- StrnCpy (EncodedPassword, Password, 21);\r
- EncodePassword (EncodedPassword, 20 * sizeof (CHAR16));\r
- if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, 20 * sizeof (CHAR16)) != 0) {\r
+ StrnCpy (EncodedPassword, 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
\r
/**\r
Encode the password using a simple algorithm.\r
- \r
+\r
@param PrivateData This driver's private context data.\r
@param StringId The password from User.\r
- \r
+\r
@retval EFI_SUCESS The operation is successful.\r
@return Other value if gRT->SetVariable () fails.\r
- \r
+\r
**/\r
EFI_STATUS\r
SetPassword (\r
// Get user input password\r
//\r
Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r
- PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2); \r
+ PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r
ZeroMem (Password, PasswordSize);\r
- \r
+\r
TempPassword = HiiGetString (PrivateData->HiiHandle[0], StringId, NULL);\r
if (TempPassword == NULL) {\r
return EFI_NOT_READY;\r
}\r
- if (StrLen (TempPassword) > PasswordSize / sizeof (CHAR16)) {\r
+ if (StrSize (TempPassword) > PasswordSize) {\r
FreePool (TempPassword);\r
return EFI_NOT_READY;\r
}\r
- StrnCpy (Password, TempPassword, PasswordSize / sizeof (CHAR16));\r
+ StrnCpy (Password, TempPassword, StrLen (TempPassword));\r
FreePool (TempPassword);\r
\r
//\r
//\r
// Update password's clear text in the screen\r
//\r
- CopyMem (Configuration->PasswordClearText, Password, PasswordSize);\r
+ CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r
\r
//\r
// Update uncommitted data of Browser\r
//\r
// Set password\r
//\r
- EncodePassword (Password, PasswordSize);\r
+ EncodePassword (Password, StrLen (Password) * 2);\r
Status = gRT->SetVariable(\r
VariableName,\r
&mFormSetGuid,\r
return Status;\r
}\r
\r
+/**\r
+ Update names of Name/Value storage to current language.\r
+\r
+ @param PrivateData Points to the driver private data.\r
+\r
+ @retval EFI_SUCCESS All names are successfully updated.\r
+ @retval EFI_NOT_FOUND Failed to get Name from HII database.\r
+\r
+**/\r
+EFI_STATUS\r
+LoadNameValueNames (\r
+ IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData\r
+ )\r
+{\r
+ UINTN Index;\r
+\r
+ //\r
+ // Get Name/Value name string of current language\r
+ //\r
+ for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {\r
+ PrivateData->NameValueName[Index] = HiiGetString (\r
+ PrivateData->HiiHandle[0],\r
+ PrivateData->NameStringId[Index],\r
+ NULL\r
+ );\r
+ if (PrivateData->NameValueName[Index] == NULL) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
\r
/**\r
This function allows a caller to extract the current configuration for one\r
\r
@retval EFI_SUCCESS The Results is filled with the requested values.\r
@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
- @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
+ @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.\r
@retval EFI_NOT_FOUND Routing data doesn't match any storage in this\r
driver.\r
\r
UINTN BufferSize;\r
DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
+ EFI_STRING ConfigRequest;\r
+ EFI_STRING ConfigRequestHdr;\r
+ UINTN Size;\r
+ EFI_STRING Value;\r
+ UINTN ValueStrLen;\r
+ CHAR16 BackupChar;\r
+ CHAR16 *StrPointer;\r
+ BOOLEAN AllocatedRequest;\r
+\r
+ if (Progress == NULL || Results == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ //\r
+ // Initialize the local variables.\r
+ //\r
+ ConfigRequestHdr = NULL;\r
+ ConfigRequest = NULL;\r
+ Size = 0;\r
+ *Progress = Request;\r
+ AllocatedRequest = FALSE;\r
\r
PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
HiiConfigRouting = PrivateData->HiiConfigRouting;\r
\r
//\r
- //\r
- // Get Buffer Storage data from EFI variable\r
+ // Get Buffer Storage data from EFI variable.\r
+ // Try to get the current setting from variable.\r
//\r
BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
Status = gRT->GetVariable (\r
- VariableName,\r
- &mFormSetGuid,\r
- NULL,\r
- &BufferSize,\r
- &PrivateData->Configuration\r
- );\r
+ VariableName,\r
+ &mFormSetGuid,\r
+ NULL,\r
+ &BufferSize,\r
+ &PrivateData->Configuration\r
+ );\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ return EFI_NOT_FOUND;\r
}\r
\r
if (Request == NULL) {\r
//\r
- // Request is set to NULL, return all configurable elements together with ALTCFG\r
- //\r
- *Results = HiiConstructConfigAltResp (\r
- &mFormSetGuid,\r
- VariableName,\r
- PrivateData->DriverHandle[0],\r
- &PrivateData->Configuration,\r
- BufferSize,\r
- VfrMyIfrNVDataBlockName,\r
- STRING_TOKEN (STR_STANDARD_DEFAULT_PROMPT),\r
- VfrMyIfrNVDataDefault0000,\r
- STRING_TOKEN (STR_MANUFACTURE_DEFAULT_PROMPT),\r
- VfrMyIfrNVDataDefault0001,\r
- 0,\r
- NULL\r
- );\r
- \r
+ // Request is set to NULL, construct full request string.\r
+ //\r
+\r
//\r
- // No matched storage is found.\r
+ // Allocate and fill a buffer large enough to hold the <ConfigHdr> template\r
+ // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
//\r
- if (*Results == NULL) {\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
+ Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
+ ConfigRequest = AllocateZeroPool (Size);\r
+ ASSERT (ConfigRequest != NULL);\r
+ AllocatedRequest = TRUE;\r
+ UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
+ FreePool (ConfigRequestHdr);\r
+ } else {\r
+ //\r
+ // Check routing data in <ConfigHdr>.\r
+ // Note: if only one Storage is used, then this checking could be skipped.\r
+ //\r
+ if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, NULL)) {\r
return EFI_NOT_FOUND;\r
}\r
-\r
- return EFI_SUCCESS;\r
+ //\r
+ // Set Request to the unified request string.\r
+ //\r
+ ConfigRequest = Request;\r
+ //\r
+ // Check whether Request includes Request Element.\r
+ //\r
+ if (StrStr (Request, L"OFFSET") == NULL) {\r
+ //\r
+ // Check Request Element does exist in Reques String\r
+ //\r
+ StrPointer = StrStr (Request, L"PATH");\r
+ if (StrPointer == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if (StrStr (StrPointer, L"&") == NULL) {\r
+ Size = (StrLen (Request) + 32 + 1) * sizeof (CHAR16);\r
+ ConfigRequest = AllocateZeroPool (Size);\r
+ ASSERT (ConfigRequest != NULL);\r
+ AllocatedRequest = TRUE;\r
+ UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", Request, (UINT64)BufferSize);\r
+ }\r
+ }\r
}\r
\r
//\r
- // Check routing data in <ConfigHdr>.\r
- // Note: if only one Storage is used, then this checking could be skipped.\r
+ // Check if requesting Name/Value storage\r
//\r
- if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, VariableName)) {\r
- *Progress = Request;\r
- return EFI_NOT_FOUND;\r
+ if (StrStr (ConfigRequest, L"OFFSET") == NULL) {\r
+ //\r
+ // Update Name/Value storage Names\r
+ //\r
+ Status = LoadNameValueNames (PrivateData);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Allocate memory for <ConfigResp>, e.g. Name0=0x11, Name1=0x1234, Name2="ABCD"\r
+ // <Request> ::=<ConfigHdr>&Name0&Name1&Name2\r
+ // <ConfigResp>::=<ConfigHdr>&Name0=11&Name1=1234&Name2=0041004200430044\r
+ //\r
+ BufferSize = (StrLen (ConfigRequest) +\r
+ 1 + sizeof (PrivateData->Configuration.NameValueVar0) * 2 +\r
+ 1 + sizeof (PrivateData->Configuration.NameValueVar1) * 2 +\r
+ 1 + sizeof (PrivateData->Configuration.NameValueVar2) * 2 + 1) * sizeof (CHAR16);\r
+ *Results = AllocateZeroPool (BufferSize);\r
+ ASSERT (*Results != NULL);\r
+ StrCpy (*Results, ConfigRequest);\r
+ Value = *Results;\r
+\r
+ //\r
+ // Append value of NameValueVar0, type is UINT8\r
+ //\r
+ if ((Value = StrStr (*Results, PrivateData->NameValueName[0])) != NULL) {\r
+ Value += StrLen (PrivateData->NameValueName[0]);\r
+ ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar0) * 2) + 1);\r
+ CopyMem (Value + ValueStrLen, Value, StrSize (Value));\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
+ *Value = BackupChar;\r
+ }\r
+\r
+ //\r
+ // Append value of NameValueVar1, type is UINT16\r
+ //\r
+ if ((Value = StrStr (*Results, PrivateData->NameValueName[1])) != NULL) {\r
+ Value += StrLen (PrivateData->NameValueName[1]);\r
+ ValueStrLen = ((sizeof (PrivateData->Configuration.NameValueVar1) * 2) + 1);\r
+ CopyMem (Value + ValueStrLen, Value, StrSize (Value));\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
+ *Value = BackupChar;\r
+ }\r
+\r
+ //\r
+ // Append value of NameValueVar2, type is CHAR16 *\r
+ //\r
+ if ((Value = StrStr (*Results, PrivateData->NameValueName[2])) != NULL) {\r
+ Value += StrLen (PrivateData->NameValueName[2]);\r
+ ValueStrLen = StrLen (PrivateData->Configuration.NameValueVar2) * 4 + 1;\r
+ CopyMem (Value + ValueStrLen, Value, StrSize (Value));\r
+\r
+ *Value++ = L'=';\r
+ //\r
+ // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"\r
+ //\r
+ StrPointer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r
+ for (; *StrPointer != L'\0'; StrPointer++) {\r
+ Value += UnicodeValueToString (Value, PREFIX_ZERO | RADIX_HEX, *StrPointer, 4);\r
+ }\r
+ }\r
+ \r
+ Status = EFI_SUCCESS;\r
+ } else {\r
+ //\r
+ // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
+ //\r
+ Status = HiiConfigRouting->BlockToConfig (\r
+ HiiConfigRouting,\r
+ ConfigRequest,\r
+ (UINT8 *) &PrivateData->Configuration,\r
+ BufferSize,\r
+ Results,\r
+ Progress\r
+ );\r
}\r
\r
//\r
- // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
+ // Free the allocated config request string.\r
//\r
- Status = HiiConfigRouting->BlockToConfig (\r
- HiiConfigRouting,\r
- Request,\r
- (UINT8 *) &PrivateData->Configuration,\r
- BufferSize,\r
- Results,\r
- Progress\r
- );\r
+ if (AllocatedRequest) {\r
+ FreePool (ConfigRequest);\r
+ }\r
+ //\r
+ // Set Progress string to the original request string.\r
+ //\r
+ if (Request == NULL) {\r
+ *Progress = NULL;\r
+ } else if (StrStr (Request, L"OFFSET") == NULL) {\r
+ *Progress = Request + StrLen (Request);\r
+ }\r
+\r
return Status;\r
}\r
\r
UINTN BufferSize;\r
DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
EFI_HII_CONFIG_ROUTING_PROTOCOL *HiiConfigRouting;\r
-\r
- if (Configuration == NULL) {\r
+ CHAR16 *Value;\r
+ CHAR16 *StrPtr;\r
+ CHAR16 TemStr[5];\r
+ UINT8 *DataBuffer;\r
+ UINT8 DigitUint8;\r
+ UINTN Index;\r
+ CHAR16 *StrBuffer;\r
+\r
+ if (Configuration == NULL || Progress == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
HiiConfigRouting = PrivateData->HiiConfigRouting;\r
+ *Progress = Configuration;\r
\r
+ //\r
// Check routing data in <ConfigHdr>.\r
// Note: if only one Storage is used, then this checking could be skipped.\r
//\r
- if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, VariableName)) {\r
- *Progress = Configuration;\r
+ if (!HiiIsConfigHdrMatch (Configuration, &mFormSetGuid, NULL)) {\r
return EFI_NOT_FOUND;\r
}\r
\r
//\r
BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
Status = gRT->GetVariable (\r
- VariableName,\r
- &mFormSetGuid,\r
- NULL,\r
- &BufferSize,\r
- &PrivateData->Configuration\r
- );\r
+ VariableName,\r
+ &mFormSetGuid,\r
+ NULL,\r
+ &BufferSize,\r
+ &PrivateData->Configuration\r
+ );\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
+ //\r
+ // Check if configuring Name/Value storage\r
+ //\r
+ if (StrStr (Configuration, L"OFFSET") == NULL) {\r
+ //\r
+ // Update Name/Value storage Names\r
+ //\r
+ Status = LoadNameValueNames (PrivateData);\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
+\r
+ //\r
+ // Convert value for NameValueVar0\r
+ //\r
+ if ((Value = StrStr (Configuration, PrivateData->NameValueName[0])) != NULL) {\r
+ //\r
+ // Skip "Name="\r
+ //\r
+ Value += StrLen (PrivateData->NameValueName[0]);\r
+ Value++;\r
+ //\r
+ // Get Value String\r
+ //\r
+ StrPtr = StrStr (Value, L"&");\r
+ if (StrPtr == NULL) {\r
+ StrPtr = Value + StrLen (Value);\r
+ }\r
+ //\r
+ // Convert Value to Buffer data\r
+ //\r
+ DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar0;\r
+ ZeroMem (TemStr, sizeof (TemStr));\r
+ for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {\r
+ TemStr[0] = *StrPtr;\r
+ DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
+ if ((Index & 1) == 0) {\r
+ DataBuffer [Index/2] = DigitUint8;\r
+ } else {\r
+ DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Convert value for NameValueVar1\r
+ //\r
+ if ((Value = StrStr (Configuration, PrivateData->NameValueName[1])) != NULL) {\r
+ //\r
+ // Skip "Name="\r
+ //\r
+ Value += StrLen (PrivateData->NameValueName[1]);\r
+ Value++;\r
+ //\r
+ // Get Value String\r
+ //\r
+ StrPtr = StrStr (Value, L"&");\r
+ if (StrPtr == NULL) {\r
+ StrPtr = Value + StrLen (Value);\r
+ }\r
+ //\r
+ // Convert Value to Buffer data\r
+ //\r
+ DataBuffer = (UINT8 *) &PrivateData->Configuration.NameValueVar1;\r
+ ZeroMem (TemStr, sizeof (TemStr));\r
+ for (Index = 0, StrPtr --; StrPtr >= Value; StrPtr --, Index ++) {\r
+ TemStr[0] = *StrPtr;\r
+ DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
+ if ((Index & 1) == 0) {\r
+ DataBuffer [Index/2] = DigitUint8;\r
+ } else {\r
+ DataBuffer [Index/2] = (UINT8) ((UINT8) (DigitUint8 << 4) + DataBuffer [Index/2]);\r
+ }\r
+ }\r
+ }\r
+\r
+ //\r
+ // Convert value for NameValueVar2\r
+ //\r
+ if ((Value = StrStr (Configuration, PrivateData->NameValueName[2])) != NULL) {\r
+ //\r
+ // Skip "Name="\r
+ //\r
+ Value += StrLen (PrivateData->NameValueName[2]);\r
+ Value++;\r
+ //\r
+ // Get Value String\r
+ //\r
+ StrPtr = StrStr (Value, L"&");\r
+ if (StrPtr == NULL) {\r
+ StrPtr = Value + StrLen (Value);\r
+ }\r
+ //\r
+ // Convert Config String to Unicode String, e.g "0041004200430044" => "ABCD"\r
+ //\r
+ StrBuffer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r
+ ZeroMem (TemStr, sizeof (TemStr));\r
+ while (Value < StrPtr) {\r
+ StrnCpy (TemStr, Value, 4);\r
+ *(StrBuffer++) = (CHAR16) StrHexToUint64 (TemStr);\r
+ Value += 4;\r
+ }\r
+ *StrBuffer = L'\0';\r
+ }\r
+\r
+ //\r
+ // Store Buffer Storage back to EFI variable\r
+ //\r
+ Status = gRT->SetVariable(\r
+ VariableName,\r
+ &mFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+ &PrivateData->Configuration\r
+ );\r
+\r
+ return Status;\r
+ }\r
+\r
//\r
// Convert <ConfigResp> to buffer data by helper function ConfigToBlock()\r
//\r
EFI_IFR_GUID_LABEL *StartLabel;\r
VOID *EndOpCodeHandle;\r
EFI_IFR_GUID_LABEL *EndLabel;\r
+ EFI_INPUT_KEY Key;\r
+ DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
+ UINTN MyVarSize;\r
+\r
+ if (Action == EFI_BROWSER_ACTION_FORM_OPEN) {\r
+ if (QuestionId == 0x1234) {\r
+ //\r
+ // Sample CallBack for UEFI FORM_OPEN action:\r
+ // Add Save action into Form 3 when Form 1 is opened.\r
+ // This will be done only in FORM_OPEN CallBack of question with ID 0x1234 from Form 1.\r
+ //\r
+ PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\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
+ StartLabel->Number = LABEL_UPDATE2;\r
+\r
+ HiiCreateActionOpCode (\r
+ StartOpCodeHandle, // Container for dynamic created opcodes\r
+ 0x1238, // Question ID\r
+ STRING_TOKEN(STR_SAVE_TEXT), // Prompt text\r
+ STRING_TOKEN(STR_SAVE_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
+ &mFormSetGuid, // Formset GUID\r
+ 0x3, // Form ID\r
+ StartOpCodeHandle, // Label for where to insert opcodes\r
+ NULL // Insert data\r
+ );\r
+\r
+ HiiFreeOpCodeHandle (StartOpCodeHandle);\r
+ }\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ if (Action == EFI_BROWSER_ACTION_FORM_CLOSE) {\r
+ if (QuestionId == 0x5678) {\r
+ //\r
+ // Sample CallBack for UEFI FORM_CLOSE action:\r
+ // Show up a pop-up to specify Form 3 will be closed when exit Form 3.\r
+ //\r
+ do {\r
+ CreatePopUp (\r
+ EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r
+ &Key,\r
+ L"",\r
+ L"You are going to leave third Form!",\r
+ L"Press ESC or ENTER to continue ...",\r
+ L"",\r
+ NULL\r
+ );\r
+ } while ((Key.ScanCode != SCAN_ESC) && (Key.UnicodeChar != CHAR_CARRIAGE_RETURN));\r
+ }\r
+ return EFI_SUCCESS;\r
+ }\r
\r
if ((Value == NULL) || (ActionRequest == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+\r
Status = EFI_SUCCESS;\r
PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
\r
&PrivateData->Configuration\r
);\r
\r
+ //\r
+ // Set initial vlaue of dynamic created oneof Question in Form Browser\r
+ //\r
+ Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
+ ASSERT (Configuration != NULL);\r
+ if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r
+ Configuration->DynamicOneof = 2;\r
+\r
+ //\r
+ // Update uncommitted data of Browser\r
+ //\r
+ HiiSetBrowserData (\r
+ &mFormSetGuid,\r
+ VariableName,\r
+ sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+ (UINT8 *) Configuration,\r
+ NULL\r
+ );\r
+ }\r
+ FreePool (Configuration);\r
+\r
HiiCreateOneOfOpCode (\r
StartOpCodeHandle, // Container for dynamic created opcodes\r
0x8001, // Question ID (or call it "key")\r
NULL // Default Opcode is NULl\r
);\r
\r
+ HiiCreateTextOpCode (\r
+ StartOpCodeHandle,\r
+ STRING_TOKEN(STR_TEXT_SAMPLE_HELP),\r
+ STRING_TOKEN(STR_TEXT_SAMPLE_HELP),\r
+ STRING_TOKEN(STR_TEXT_SAMPLE_STRING)\r
+ );\r
+\r
+ HiiCreateDateOpCode (\r
+ StartOpCodeHandle,\r
+ 0x8004,\r
+ 0x0,\r
+ 0x0,\r
+ STRING_TOKEN(STR_DATE_SAMPLE_HELP),\r
+ STRING_TOKEN(STR_DATE_SAMPLE_HELP),\r
+ 0,\r
+ QF_DATE_STORAGE_TIME,\r
+ NULL\r
+ );\r
+\r
+ HiiCreateTimeOpCode (\r
+ StartOpCodeHandle,\r
+ 0x8005,\r
+ 0x0,\r
+ 0x0,\r
+ STRING_TOKEN(STR_TIME_SAMPLE_HELP),\r
+ STRING_TOKEN(STR_TIME_SAMPLE_HELP),\r
+ 0,\r
+ QF_TIME_STORAGE_TIME,\r
+ NULL\r
+ );\r
+\r
HiiCreateGotoOpCode (\r
StartOpCodeHandle, // Container for dynamic created opcodes\r
1, // Target Form ID\r
\r
HiiFreeOpCodeHandle (StartOpCodeHandle);\r
HiiFreeOpCodeHandle (OptionsOpCodeHandle);\r
+ HiiFreeOpCodeHandle (EndOpCodeHandle);\r
break;\r
- \r
+\r
case 0x5678:\r
//\r
// We will reach here once the Question is refreshed\r
EFI_IFR_FLAG_CALLBACK, // Question flag\r
0 // Action String ID\r
);\r
- \r
+\r
HiiUpdateForm (\r
PrivateData->HiiHandle[0], // HII handle\r
&mFormSetGuid, // Formset GUID\r
NULL // Insert data\r
);\r
\r
- HiiFreeOpCodeHandle (StartOpCodeHandle); \r
- \r
+ HiiFreeOpCodeHandle (StartOpCodeHandle);\r
+\r
//\r
// Refresh the Question value\r
//\r
sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
&PrivateData->Configuration\r
);\r
- \r
+\r
//\r
// Change an EFI Variable storage (MyEfiVar) asynchronous, this will cause\r
// the first statement in Form 3 be suppressed\r
//\r
+ MyVarSize = 1;\r
MyVar = 111;\r
Status = gRT->SetVariable(\r
L"MyVar",\r
&mFormSetGuid,\r
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
- 1,\r
+ MyVarSize,\r
&MyVar\r
);\r
break;\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
\r
break;\r
\r
+ case 0x1111:\r
+ //\r
+ // EfiVarstore question takes sample action (print value as debug information) \r
+ // after read/write question.\r
+ //\r
+ MyVarSize = 1;\r
+ Status = gRT->GetVariable(\r
+ L"MyVar",\r
+ &mFormSetGuid,\r
+ NULL,\r
+ &MyVarSize,\r
+ &MyVar\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ DEBUG ((DEBUG_INFO, "EfiVarstore question: Tall value is %d with value width %d\n", MyVar, MyVarSize));\r
default:\r
break;\r
}\r
\r
/**\r
Main entry for this driver.\r
- \r
+\r
@param ImageHandle Image handle this driver.\r
@param SystemTable Pointer to SystemTable.\r
\r
CHAR16 *NewString;\r
UINTN BufferSize;\r
DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
- BOOLEAN ExtractIfrDefault;\r
+ BOOLEAN ActionFlag;\r
+ EFI_STRING ConfigRequestHdr;\r
\r
//\r
- // Initialize the library and our protocol.\r
+ // Initialize the local variables.\r
//\r
-\r
+ ConfigRequestHdr = NULL;\r
//\r
// Initialize screen dimensions for SendForm().\r
// Remove 3 characters from top and bottom\r
//\r
// Initialize driver private data\r
//\r
- PrivateData = AllocatePool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
+ PrivateData = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
if (PrivateData == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
NULL\r
);\r
if (HiiHandle[1] == NULL) {\r
+ DriverSampleUnload (ImageHandle);\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
NewString = L"700 Mhz";\r
\r
if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString, NULL) == 0) {\r
+ DriverSampleUnload (ImageHandle);\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
+ HiiSetString (HiiHandle[0], 0, NewString, NULL);\r
+\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
+\r
//\r
// Initialize configuration data\r
//\r
//\r
// Try to read NV config EFI variable first\r
//\r
- ExtractIfrDefault = TRUE;\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
+\r
BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r
- if (!EFI_ERROR (Status) && (BufferSize == sizeof (DRIVER_SAMPLE_CONFIGURATION))) {\r
- ExtractIfrDefault = FALSE;\r
- }\r
-\r
- if (ExtractIfrDefault) {\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Store zero data Buffer Storage to EFI variable\r
+ //\r
+ Status = gRT->SetVariable(\r
+ VariableName,\r
+ &mFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+ Configuration\r
+ );\r
+ ASSERT (Status == EFI_SUCCESS);\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
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Status = HiiIfrLibExtractDefault (Configuration, &BufferSize, 1, VfrMyIfrNVDataDefault0000);\r
-\r
- if (!EFI_ERROR (Status)) {\r
- gRT->SetVariable(\r
- VariableName,\r
- &mFormSetGuid,\r
- EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
- sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
- Configuration\r
- );\r
- }\r
+ ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
+ ASSERT (ActionFlag);\r
+ } else {\r
+ //\r
+ // EFI variable does exist and Validate Current Setting\r
+ //\r
+ ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
+ ASSERT (ActionFlag);\r
}\r
\r
+ FreePool (ConfigRequestHdr);\r
+\r
+\r
//\r
- // Default this driver is built into Flash device image, \r
+ // In default, this driver is built into Flash device image,\r
// the following code doesn't run.\r
//\r
\r
//\r
// Example of how to display only the item we sent to HII\r
- // When this driver is not built into Flash device image, \r
+ // When this driver is not built into Flash device image,\r
// it need to call SendForm to show front page by itself.\r
//\r
if (DISPLAY_ONLY_MY_ITEM <= 1) {\r
NULL,\r
NULL\r
);\r
- \r
+\r
HiiRemovePackages (HiiHandle[0]);\r
- \r
+\r
HiiRemovePackages (HiiHandle[1]);\r
}\r
\r
- return Status;\r
+ return EFI_SUCCESS;\r
}\r
\r
/**\r
IN EFI_HANDLE ImageHandle\r
)\r
{\r
+ UINTN Index;\r
+\r
+ ASSERT (PrivateData != NULL);\r
+\r
if (DriverHandle[0] != NULL) {\r
gBS->UninstallMultipleProtocolInterfaces (\r
DriverHandle[0],\r
&PrivateData->ConfigAccess,\r
NULL\r
);\r
+ DriverHandle[0] = NULL;\r
}\r
\r
if (DriverHandle[1] != NULL) {\r
&mHiiVendorDevicePath1,\r
NULL\r
);\r
+ DriverHandle[1] = NULL;\r
}\r
\r
if (PrivateData->HiiHandle[0] != NULL) {\r
HiiRemovePackages (PrivateData->HiiHandle[1]);\r
}\r
\r
- if (PrivateData != NULL) {\r
- FreePool (PrivateData);\r
+ for (Index = 0; Index < NAME_VALUE_NAME_NUMBER; Index++) {\r
+ if (PrivateData->NameValueName[Index] != NULL) {\r
+ FreePool (PrivateData->NameValueName[Index]);\r
+ }\r
}\r
+ FreePool (PrivateData);\r
+ PrivateData = NULL;\r
\r
return EFI_SUCCESS;\r
}\r
projects / mirror_edk2.git / blobdiff