/** @file\r
-Copyright (c) 2004 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+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
+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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
- DriverSample.c\r
+**/\r
+\r
+\r
+#include "DriverSample.h"\r
+\r
+#define DISPLAY_ONLY_MY_ITEM 0x0002\r
\r
-Abstract:\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
+EFI_EVENT mEvent;\r
+\r
+HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath0 = {\r
+ {\r
+ {\r
+ HARDWARE_DEVICE_PATH,\r
+ HW_VENDOR_DP,\r
+ {\r
+ (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
+ (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
+ }\r
+ },\r
+ DRIVER_SAMPLE_FORMSET_GUID\r
+ },\r
+ {\r
+ END_DEVICE_PATH_TYPE,\r
+ END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
+ {\r
+ (UINT8) (END_DEVICE_PATH_LENGTH),\r
+ (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
+ }\r
+ }\r
+};\r
+\r
+HII_VENDOR_DEVICE_PATH mHiiVendorDevicePath1 = {\r
+ {\r
+ {\r
+ HARDWARE_DEVICE_PATH,\r
+ HW_VENDOR_DP,\r
+ {\r
+ (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
+ (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
+ }\r
+ },\r
+ DRIVER_SAMPLE_INVENTORY_GUID\r
+ },\r
+ {\r
+ END_DEVICE_PATH_TYPE,\r
+ END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
+ {\r
+ (UINT8) (END_DEVICE_PATH_LENGTH),\r
+ (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
+ }\r
+ }\r
+};\r
\r
- 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
+ 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
-#include "DriverSample.h"\r
+ @param[in] KeyData The key that was pressed.\r
\r
-#define DISPLAY_ONLY_MY_ITEM 0x0002\r
+ @retval EFI_SUCCESS The operation was successful.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NotificationFunction(\r
+ IN EFI_KEY_DATA *KeyData\r
+ )\r
+{\r
+ gBS->SignalEvent (mEvent);\r
+ \r
+ return EFI_SUCCESS;\r
+}\r
\r
-EFI_GUID mFormSetGuid = FORMSET_GUID;\r
-EFI_GUID mInventoryGuid = INVENTORY_GUID;\r
+/**\r
+ Function to start monitoring for CTRL-C using SimpleTextInputEx. \r
\r
-CHAR16 VariableName[] = L"MyIfrNVData";\r
+ @retval EFI_SUCCESS The feature is enabled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalStartMonitor(\r
+ VOID\r
+ )\r
+{\r
+ EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;\r
+ EFI_KEY_DATA KeyData;\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE *Handles;\r
+ UINTN HandleCount;\r
+ UINTN HandleIndex;\r
+ EFI_HANDLE NotifyHandle;\r
+\r
+ Status = gBS->LocateHandleBuffer (\r
+ ByProtocol,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ NULL,\r
+ &HandleCount,\r
+ &Handles\r
+ );\r
+ for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
+ Status = gBS->HandleProtocol (Handles[HandleIndex], &gEfiSimpleTextInputExProtocolGuid, (VOID **) &SimpleEx);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ KeyData.KeyState.KeyToggleState = 0;\r
+ KeyData.Key.ScanCode = 0;\r
+ KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;\r
+ KeyData.Key.UnicodeChar = L'c';\r
+\r
+ Status = SimpleEx->RegisterKeyNotify(\r
+ SimpleEx,\r
+ &KeyData,\r
+ NotificationFunction,\r
+ &NotifyHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ break;\r
+ }\r
+ \r
+ KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;\r
+ Status = SimpleEx->RegisterKeyNotify(\r
+ SimpleEx,\r
+ &KeyData,\r
+ NotificationFunction,\r
+ &NotifyHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ break;\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Function to stop monitoring for CTRL-C using SimpleTextInputEx. \r
\r
+ @retval EFI_SUCCESS The feature is enabled.\r
+ @retval EFI_OUT_OF_RESOURCES There is not enough mnemory available.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalStopMonitor(\r
+ VOID\r
+ )\r
+{\r
+ EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *SimpleEx;\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE *Handles;\r
+ EFI_KEY_DATA KeyData; \r
+ UINTN HandleCount;\r
+ UINTN HandleIndex;\r
+ EFI_HANDLE NotifyHandle;\r
+\r
+ Status = gBS->LocateHandleBuffer (\r
+ ByProtocol,\r
+ &gEfiSimpleTextInputExProtocolGuid,\r
+ NULL,\r
+ &HandleCount,\r
+ &Handles\r
+ );\r
+ for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {\r
+ Status = gBS->HandleProtocol (Handles[HandleIndex], &gEfiSimpleTextInputExProtocolGuid, (VOID **) &SimpleEx);\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ KeyData.KeyState.KeyToggleState = 0;\r
+ KeyData.Key.ScanCode = 0;\r
+ KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_LEFT_CONTROL_PRESSED;\r
+ KeyData.Key.UnicodeChar = L'c';\r
+\r
+ Status = SimpleEx->RegisterKeyNotify(\r
+ SimpleEx,\r
+ &KeyData,\r
+ NotificationFunction,\r
+ &NotifyHandle);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = SimpleEx->UnregisterKeyNotify (SimpleEx, NotifyHandle);\r
+ }\r
+\r
+ KeyData.KeyState.KeyShiftState = EFI_SHIFT_STATE_VALID|EFI_RIGHT_CONTROL_PRESSED;\r
+ Status = SimpleEx->RegisterKeyNotify(\r
+ SimpleEx,\r
+ &KeyData,\r
+ NotificationFunction,\r
+ &NotifyHandle);\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = SimpleEx->UnregisterKeyNotify (SimpleEx, NotifyHandle);\r
+ }\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 UINT8 MaxSize\r
+ IN UINTN MaxSize\r
)\r
{\r
UINTN Index;\r
\r
CopyMem (Password, Buffer, MaxSize);\r
\r
- gBS->FreePool (Buffer);\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
- DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
- EFI_STRING_ID StringId\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
BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
Status = gRT->GetVariable (\r
VariableName,\r
- &mFormSetGuid,\r
+ &gDriverSampleFormSetGuid,\r
NULL,\r
&BufferSize,\r
&PrivateData->Configuration\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
//\r
// Get user input password\r
//\r
- BufferSize = 21 * sizeof (CHAR16);\r
- Password = AllocateZeroPool (BufferSize);\r
- ASSERT (Password != NULL);\r
-\r
- Status = IfrLibGetString (PrivateData->HiiHandle[0], StringId, Password, &BufferSize);\r
- if (EFI_ERROR (Status)) {\r
- gBS->FreePool (Password);\r
- return Status;\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 = AllocateCopyPool (21 * sizeof (CHAR16), Password);\r
+ EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
ASSERT (EncodedPassword != NULL);\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
Status = EFI_SUCCESS;\r
}\r
\r
- gBS->FreePool (Password);\r
- gBS->FreePool (EncodedPassword);\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
- DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
- EFI_STRING_ID StringId\r
+ IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData,\r
+ IN EFI_STRING_ID StringId\r
)\r
{\r
EFI_STATUS Status;\r
- UINTN BufferSize;\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
BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
Status = gRT->GetVariable (\r
VariableName,\r
- &mFormSetGuid,\r
+ &gDriverSampleFormSetGuid,\r
NULL,\r
&BufferSize,\r
&PrivateData->Configuration\r
//\r
// Get user input password\r
//\r
- Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r
- ZeroMem (Password, 20 * sizeof (CHAR16));\r
- Status = IfrLibGetString (PrivateData->HiiHandle[0], StringId, Password, &BufferSize);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\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
+ StrnCpy (Password, TempPassword, StrLen (TempPassword));\r
+ FreePool (TempPassword);\r
\r
//\r
// Retrive uncommitted data from Browser\r
//\r
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_PRIVATE_DATA));\r
+ Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
ASSERT (Configuration != NULL);\r
- Status = GetBrowserData (&mFormSetGuid, VariableName, &BufferSize, (UINT8 *) Configuration);\r
- if (!EFI_ERROR (Status)) {\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, 20 * sizeof (CHAR16));\r
+ CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r
\r
//\r
// Update uncommitted data of Browser\r
//\r
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Status = SetBrowserData (\r
- &mFormSetGuid,\r
- VariableName,\r
- BufferSize,\r
- (UINT8 *) Configuration,\r
- NULL\r
- );\r
+ HiiSetBrowserData (\r
+ &gDriverSampleFormSetGuid,\r
+ VariableName,\r
+ sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+ (UINT8 *) Configuration,\r
+ NULL\r
+ );\r
}\r
- gBS->FreePool (Configuration);\r
+\r
+ //\r
+ // Free Configuration Buffer\r
+ //\r
+ FreePool (Configuration);\r
+\r
\r
//\r
// Set password\r
//\r
- EncodePassword (Password, 20 * sizeof (CHAR16));\r
+ EncodePassword (Password, StrLen (Password) * 2);\r
Status = gRT->SetVariable(\r
VariableName,\r
- &mFormSetGuid,\r
+ &gDriverSampleFormSetGuid,\r
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
&PrivateData->Configuration\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
+/**\r
+ Get the value of <Number> in <BlockConfig> format, i.e. the value of OFFSET\r
+ or WIDTH or VALUE.\r
+ <BlockConfig> ::= 'OFFSET='<Number>&'WIDTH='<Number>&'VALUE'=<Number>\r
+\r
+ This is a internal function.\r
+\r
+ @param StringPtr String in <BlockConfig> format and points to the\r
+ first character of <Number>.\r
+ @param Number The output value. Caller takes the responsibility\r
+ to free memory.\r
+ @param Len Length of the <Number>, in characters.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Insufficient resources to store neccessary\r
+ structures.\r
+ @retval EFI_SUCCESS Value of <Number> is outputted in Number\r
+ successfully.\r
+\r
+**/\r
+EFI_STATUS\r
+GetValueOfNumber (\r
+ IN EFI_STRING StringPtr,\r
+ OUT UINT8 **Number,\r
+ OUT UINTN *Len\r
+ )\r
+{\r
+ EFI_STRING TmpPtr;\r
+ UINTN Length;\r
+ EFI_STRING Str;\r
+ UINT8 *Buf;\r
+ EFI_STATUS Status;\r
+ UINT8 DigitUint8;\r
+ UINTN Index;\r
+ CHAR16 TemStr[2];\r
+\r
+ if (StringPtr == NULL || *StringPtr == L'\0' || Number == NULL || Len == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Buf = NULL;\r
+\r
+ TmpPtr = StringPtr;\r
+ while (*StringPtr != L'\0' && *StringPtr != L'&') {\r
+ StringPtr++;\r
+ }\r
+ *Len = StringPtr - TmpPtr;\r
+ Length = *Len + 1;\r
+\r
+ Str = (EFI_STRING) AllocateZeroPool (Length * sizeof (CHAR16));\r
+ if (Str == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Exit;\r
+ }\r
+ CopyMem (Str, TmpPtr, *Len * sizeof (CHAR16));\r
+ *(Str + *Len) = L'\0';\r
+\r
+ Length = (Length + 1) / 2;\r
+ Buf = (UINT8 *) AllocateZeroPool (Length);\r
+ if (Buf == NULL) {\r
+ Status = EFI_OUT_OF_RESOURCES;\r
+ goto Exit;\r
+ }\r
+ \r
+ Length = *Len;\r
+ ZeroMem (TemStr, sizeof (TemStr));\r
+ for (Index = 0; Index < Length; Index ++) {\r
+ TemStr[0] = Str[Length - Index - 1];\r
+ DigitUint8 = (UINT8) StrHexToUint64 (TemStr);\r
+ if ((Index & 1) == 0) {\r
+ Buf [Index/2] = DigitUint8;\r
+ } else {\r
+ Buf [Index/2] = (UINT8) ((DigitUint8 << 4) + Buf [Index/2]);\r
+ }\r
+ }\r
+\r
+ *Number = Buf;\r
+ Status = EFI_SUCCESS;\r
+\r
+Exit:\r
+ if (Str != NULL) {\r
+ FreePool (Str);\r
+ }\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Create altcfg string. \r
+\r
+ @param Result The request result string.\r
+ @param ConfigHdr The request head info. <ConfigHdr> format.\r
+ @param Offset The offset of the parameter int he structure.\r
+ @param Width The width of the parameter.\r
+\r
+\r
+ @retval The string with altcfg info append at the end.\r
+**/\r
+EFI_STRING \r
+CreateAltCfgString (\r
+ IN EFI_STRING Result,\r
+ IN EFI_STRING ConfigHdr,\r
+ IN UINTN Offset,\r
+ IN UINTN Width\r
+ )\r
+{\r
+ EFI_STRING StringPtr;\r
+ EFI_STRING TmpStr;\r
+ UINTN NewLen;\r
+\r
+ NewLen = StrLen (Result);\r
+ //\r
+ // String Len = ConfigResp + AltConfig + AltConfig + 1("\0")\r
+ //\r
+ NewLen = (NewLen + ((1 + StrLen (ConfigHdr) + 8 + 4) + (8 + 4 + 7 + 4 + 7 + 4)) * 2 + 1) * sizeof (CHAR16);\r
+ StringPtr = AllocateZeroPool (NewLen);\r
+ if (StringPtr == NULL) {\r
+ return NULL;\r
+ }\r
+\r
+ TmpStr = StringPtr;\r
+ if (Result != NULL) {\r
+ StrCpy (StringPtr, Result);\r
+ StringPtr += StrLen (Result); \r
+ FreePool (Result);\r
+ }\r
+ \r
+ UnicodeSPrint (\r
+ StringPtr, \r
+ (1 + StrLen (ConfigHdr) + 8 + 4 + 1) * sizeof (CHAR16), \r
+ L"&%s&ALTCFG=%04x", \r
+ ConfigHdr, \r
+ EFI_HII_DEFAULT_CLASS_STANDARD\r
+ );\r
+ StringPtr += StrLen (StringPtr);\r
+\r
+ UnicodeSPrint (\r
+ StringPtr, \r
+ (8 + 4 + 7 + 4 + 7 + 4 + 1) * sizeof (CHAR16),\r
+ L"&OFFSET=%04x&WIDTH=%04x&VALUE=%04x", \r
+ Offset, \r
+ Width,\r
+ DEFAULT_CLASS_STANDARD_VALUE\r
+ );\r
+ StringPtr += StrLen (StringPtr); \r
+\r
+ UnicodeSPrint (\r
+ StringPtr, \r
+ (1 + StrLen (ConfigHdr) + 8 + 4 + 1) * sizeof (CHAR16), \r
+ L"&%s&ALTCFG=%04x", \r
+ ConfigHdr, \r
+ EFI_HII_DEFAULT_CLASS_MANUFACTURING\r
+ );\r
+ StringPtr += StrLen (StringPtr);\r
+\r
+ UnicodeSPrint (\r
+ StringPtr, \r
+ (8 + 4 + 7 + 4 + 7 + 4 + 1) * sizeof (CHAR16),\r
+ L"&OFFSET=%04x&WIDTH=%04x&VALUE=%04x", \r
+ Offset, \r
+ Width,\r
+ DEFAULT_CLASS_MANUFACTURING_VALUE\r
+ );\r
+ StringPtr += StrLen (StringPtr); \r
+\r
+ return TmpStr;\r
+}\r
+\r
+/**\r
+ Check whether need to add the altcfg string. if need to add, add the altcfg \r
+ string.\r
+\r
+ @param RequestResult The request result string.\r
+ @param ConfigRequestHdr The request head info. <ConfigHdr> format.\r
+\r
+**/\r
+VOID \r
+AppendAltCfgString (\r
+ IN OUT EFI_STRING *RequestResult,\r
+ IN EFI_STRING ConfigRequestHdr\r
+ )\r
+{\r
+ EFI_STRING StringPtr;\r
+ UINTN Length;\r
+ UINT8 *TmpBuffer;\r
+ UINTN Offset;\r
+ UINTN Width;\r
+ UINTN BlockSize;\r
+ UINTN ValueOffset;\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
+ ValueOffset = OFFSET_OF (DRIVER_SAMPLE_CONFIGURATION, GetDefaultValueFromAccess);\r
+ ValueWidth = sizeof (((DRIVER_SAMPLE_CONFIGURATION *)0)->GetDefaultValueFromAccess);\r
+\r
+ if (StringPtr == NULL) {\r
+ return;\r
+ }\r
+\r
+ while (*StringPtr != 0 && StrnCmp (StringPtr, L"OFFSET=", StrLen (L"OFFSET=")) == 0) {\r
+ StringPtr += StrLen (L"OFFSET=");\r
+ //\r
+ // Get Offset\r
+ //\r
+ Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
+ if (EFI_ERROR (Status)) {\r
+ return;\r
+ }\r
+ Offset = 0;\r
+ CopyMem (\r
+ &Offset,\r
+ TmpBuffer,\r
+ (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)\r
+ );\r
+ FreePool (TmpBuffer);\r
+\r
+ StringPtr += Length;\r
+ if (StrnCmp (StringPtr, L"&WIDTH=", StrLen (L"&WIDTH=")) != 0) {\r
+ return;\r
+ }\r
+ StringPtr += StrLen (L"&WIDTH=");\r
+\r
+ //\r
+ // Get Width\r
+ //\r
+ Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
+ if (EFI_ERROR (Status)) {\r
+ return;\r
+ }\r
+ Width = 0;\r
+ CopyMem (\r
+ &Width,\r
+ TmpBuffer,\r
+ (((Length + 1) / 2) < sizeof (UINTN)) ? ((Length + 1) / 2) : sizeof (UINTN)\r
+ );\r
+ FreePool (TmpBuffer);\r
+\r
+ StringPtr += Length;\r
+ if (StrnCmp (StringPtr, L"&VALUE=", StrLen (L"&VALUE=")) != 0) {\r
+ return;\r
+ }\r
+ StringPtr += StrLen (L"&VALUE=");\r
+\r
+ //\r
+ // Get Value\r
+ //\r
+ Status = GetValueOfNumber (StringPtr, &TmpBuffer, &Length);\r
+ if (EFI_ERROR (Status)) {\r
+ return;\r
+ }\r
+ StringPtr += Length;\r
+\r
+ //\r
+ // Calculate Value and convert it to hex string.\r
+ //\r
+ if (Offset + Width > BlockSize) {\r
+ return;\r
+ }\r
+\r
+ if (Offset <= ValueOffset && Offset + Width >= ValueOffset + ValueWidth) {\r
+ *RequestResult = CreateAltCfgString(*RequestResult, ConfigRequestHdr, ValueOffset, ValueWidth);\r
+ return;\r
+ }\r
+ }\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
- // 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
+ &gDriverSampleFormSetGuid,\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, construct full request string.\r
+ //\r
+\r
+ //\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
+ ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, 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
+ ConfigRequestHdr = NULL;\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, &gDriverSampleFormSetGuid, NULL)) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+ //\r
+ // Check whether request for EFI Varstore. EFI varstore get data\r
+ // through hii database, not support in this path.\r
+ //\r
+ if (HiiIsConfigHdrMatch(Request, &gDriverSampleFormSetGuid, MyEfiVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\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
- // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
+ // Check if requesting Name/Value storage\r
//\r
- Status = HiiConfigRouting->BlockToConfig (\r
- HiiConfigRouting,\r
- Request,\r
- (UINT8 *) &PrivateData->Configuration,\r
- BufferSize,\r
- Results,\r
- Progress\r
- );\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
+ if (!EFI_ERROR (Status)) {\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
+ AppendAltCfgString(Results, ConfigRequestHdr);\r
+ }\r
+ }\r
+\r
+ //\r
+ // Free the allocated config request string.\r
+ //\r
+ if (AllocatedRequest) {\r
+ FreePool (ConfigRequest);\r
+ }\r
+\r
+ if (ConfigRequestHdr != NULL) {\r
+ FreePool (ConfigRequestHdr);\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
+ 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, &gDriverSampleFormSetGuid, NULL)) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
+ //\r
+ // Check whether request for EFI Varstore. EFI varstore get data\r
+ // through hii database, not support in this path.\r
+ //\r
+ if (HiiIsConfigHdrMatch(Configuration, &gDriverSampleFormSetGuid, MyEfiVar)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
\r
//\r
// Get Buffer Storage data from EFI 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
+ &gDriverSampleFormSetGuid,\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
+ &gDriverSampleFormSetGuid,\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
//\r
Status = gRT->SetVariable(\r
VariableName,\r
- &mFormSetGuid,\r
+ &gDriverSampleFormSetGuid,\r
EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
&PrivateData->Configuration\r
{\r
DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
EFI_STATUS Status;\r
- EFI_HII_UPDATE_DATA UpdateData;\r
- IFR_OPTION *IfrOptionList;\r
-\r
- if ((Value == NULL) || (ActionRequest == NULL)) {\r
+ VOID *StartOpCodeHandle;\r
+ VOID *OptionsOpCodeHandle;\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
+ MY_EFI_VARSTORE_DATA *EfiData;\r
+ EFI_FORM_ID FormId;\r
+ \r
+ if (((Value == NULL) && (Action != EFI_BROWSER_ACTION_FORM_OPEN) && (Action != EFI_BROWSER_ACTION_FORM_CLOSE))||\r
+ (ActionRequest == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+\r
+ FormId = 0;\r
Status = EFI_SUCCESS;\r
PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
\r
- switch (QuestionId) {\r
- case 0x1234:\r
- //\r
- // Create dynamic page for this interactive goto\r
- //\r
- UpdateData.BufferSize = 0x1000;\r
- UpdateData.Offset = 0;\r
- UpdateData.Data = AllocatePool (0x1000);\r
- ASSERT (UpdateData.Data != NULL);\r
-\r
- IfrOptionList = AllocatePool (2 * sizeof (IFR_OPTION));\r
- ASSERT (IfrOptionList != NULL);\r
-\r
- IfrOptionList[0].Flags = 0;\r
- IfrOptionList[0].StringToken = STRING_TOKEN (STR_BOOT_OPTION1);\r
- IfrOptionList[0].Value.u8 = 1;\r
- IfrOptionList[1].Flags = EFI_IFR_OPTION_DEFAULT;\r
- IfrOptionList[1].StringToken = STRING_TOKEN (STR_BOOT_OPTION2);\r
- IfrOptionList[1].Value.u8 = 2;\r
-\r
- CreateActionOpCode (\r
- 0x1237,\r
- STRING_TOKEN(STR_EXIT_TEXT),\r
- STRING_TOKEN(STR_EXIT_TEXT),\r
- EFI_IFR_FLAG_CALLBACK,\r
- 0,\r
- &UpdateData\r
- );\r
+ switch (Action) {\r
+ case EFI_BROWSER_ACTION_FORM_OPEN:\r
+ {\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
+ &gDriverSampleFormSetGuid, // 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
\r
- CreateOneOfOpCode (\r
- 0x8001,\r
- 0,\r
- 0,\r
- STRING_TOKEN (STR_ONE_OF_PROMPT),\r
- STRING_TOKEN (STR_ONE_OF_HELP),\r
- EFI_IFR_FLAG_CALLBACK,\r
- EFI_IFR_NUMERIC_SIZE_1,\r
- IfrOptionList,\r
- 2,\r
- &UpdateData\r
- );\r
+ if (QuestionId == 0x1247) {\r
+ Status = InternalStartMonitor ();\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+ }\r
+ break;\r
\r
- CreateOrderedListOpCode (\r
- 0x8002,\r
- 0,\r
- 0,\r
- STRING_TOKEN (STR_BOOT_OPTIONS),\r
- STRING_TOKEN (STR_BOOT_OPTIONS),\r
- EFI_IFR_FLAG_RESET_REQUIRED,\r
- 0,\r
- EFI_IFR_NUMERIC_SIZE_1,\r
- 10,\r
- IfrOptionList,\r
- 2,\r
- &UpdateData\r
- );\r
+ case EFI_BROWSER_ACTION_FORM_CLOSE:\r
+ {\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
\r
- CreateGotoOpCode (\r
- 1,\r
- STRING_TOKEN (STR_GOTO_FORM1),\r
- STRING_TOKEN (STR_GOTO_HELP),\r
- 0,\r
- 0x8003,\r
- &UpdateData\r
- );\r
+ if (QuestionId == 0x1247) {\r
+ Status = InternalStopMonitor ();\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+ }\r
+ break;\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
+ }\r
+ \r
+ Value->ref.FormId = 0x3;\r
+ }\r
+ }\r
+ }\r
+ break;\r
\r
- Status = IfrLibUpdateForm (\r
- PrivateData->HiiHandle[0],\r
- &mFormSetGuid,\r
- 0x1234,\r
- 0x1234,\r
- TRUE,\r
- &UpdateData\r
- );\r
- gBS->FreePool (IfrOptionList);\r
- gBS->FreePool (UpdateData.Data);\r
+ case EFI_BROWSER_ACTION_DEFAULT_STANDARD:\r
+ {\r
+ switch (QuestionId) {\r
+ case 0x1240:\r
+ Value->u8 = DEFAULT_CLASS_STANDARD_VALUE;\r
+ break;\r
+\r
+ default:\r
+ Status = EFI_UNSUPPORTED;\r
+ break;\r
+ }\r
+ }\r
break;\r
\r
- case 0x1237:\r
- //\r
- // User press "Exit now", request Browser to exit\r
- //\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ case EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING:\r
+ {\r
+ switch (QuestionId) {\r
+ case 0x1240:\r
+ Value->u8 = DEFAULT_CLASS_MANUFACTURING_VALUE;\r
+ break;\r
+\r
+ default:\r
+ Status = EFI_UNSUPPORTED; \r
+ break;\r
+ }\r
+ }\r
break;\r
\r
- case 0x1238:\r
- //\r
- // User press "Save now", request Browser to save the uncommitted data.\r
- //\r
- *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
+ case EFI_BROWSER_ACTION_CHANGING:\r
+ {\r
+ switch (QuestionId) {\r
+ case 0x1249:\r
+ {\r
+ if (Type != EFI_IFR_TYPE_REF) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ Value->ref.FormId = 0x1234;\r
+ }\r
break;\r
+ case 0x1234:\r
+ //\r
+ // Initialize the container for dynamic opcodes\r
+ //\r
+ StartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+ ASSERT (StartOpCodeHandle != NULL);\r
+\r
+ EndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+ ASSERT (EndOpCodeHandle != 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_UPDATE1;\r
+\r
+ //\r
+ // Create Hii Extend Label OpCode as the end opcode\r
+ //\r
+ EndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (EndOpCodeHandle, &gEfiIfrTianoGuid, NULL, sizeof (EFI_IFR_GUID_LABEL));\r
+ EndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
+ EndLabel->Number = LABEL_END;\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
- case 0x2000:\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
+ // Create Option OpCode\r
+ //\r
+ OptionsOpCodeHandle = HiiAllocateOpCodeHandle ();\r
+ ASSERT (OptionsOpCodeHandle != NULL);\r
+\r
+ HiiCreateOneOfOptionOpCode (\r
+ OptionsOpCodeHandle,\r
+ STRING_TOKEN (STR_BOOT_OPTION1),\r
+ 0,\r
+ EFI_IFR_NUMERIC_SIZE_1,\r
+ 1\r
+ );\r
+\r
+ HiiCreateOneOfOptionOpCode (\r
+ OptionsOpCodeHandle,\r
+ STRING_TOKEN (STR_BOOT_OPTION2),\r
+ 0,\r
+ EFI_IFR_NUMERIC_SIZE_1,\r
+ 2\r
+ );\r
+\r
+ //\r
+ // Prepare initial value for the dynamic created oneof Question\r
+ //\r
+ PrivateData->Configuration.DynamicOneof = 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
+\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 (&gDriverSampleFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r
+ Configuration->DynamicOneof = 2;\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
+ FreePool (Configuration);\r
+\r
+ HiiCreateOneOfOpCode (\r
+ StartOpCodeHandle, // Container for dynamic created opcodes\r
+ 0x8001, // Question ID (or call it "key")\r
+ CONFIGURATION_VARSTORE_ID, // VarStore ID\r
+ (UINT16) DYNAMIC_ONE_OF_VAR_OFFSET, // Offset in Buffer Storage\r
+ STRING_TOKEN (STR_ONE_OF_PROMPT), // Question prompt text\r
+ STRING_TOKEN (STR_ONE_OF_HELP), // Question help text\r
+ EFI_IFR_FLAG_CALLBACK, // Question flag\r
+ EFI_IFR_NUMERIC_SIZE_1, // Data type of Question Value\r
+ OptionsOpCodeHandle, // Option Opcode list\r
+ NULL // Default Opcode is NULl\r
+ );\r
+\r
+ HiiCreateOrderedListOpCode (\r
+ StartOpCodeHandle, // Container for dynamic created opcodes\r
+ 0x8002, // Question ID\r
+ CONFIGURATION_VARSTORE_ID, // VarStore ID\r
+ (UINT16) DYNAMIC_ORDERED_LIST_VAR_OFFSET, // Offset in Buffer Storage\r
+ STRING_TOKEN (STR_BOOT_OPTIONS), // Question prompt text\r
+ STRING_TOKEN (STR_BOOT_OPTIONS), // Question help text\r
+ EFI_IFR_FLAG_RESET_REQUIRED, // Question flag\r
+ 0, // Ordered list flag, e.g. EFI_IFR_UNIQUE_SET\r
+ EFI_IFR_NUMERIC_SIZE_1, // Data type of Question value\r
+ 5, // Maximum container\r
+ OptionsOpCodeHandle, // Option Opcode list\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
+ STRING_TOKEN (STR_GOTO_FORM1), // Prompt text\r
+ STRING_TOKEN (STR_GOTO_HELP), // Help text\r
+ 0, // Question flag\r
+ 0x8003 // Question ID\r
+ );\r
+\r
+ HiiUpdateForm (\r
+ PrivateData->HiiHandle[0], // HII handle\r
+ &gDriverSampleFormSetGuid, // Formset GUID\r
+ 0x1234, // Form ID\r
+ StartOpCodeHandle, // Label for where to insert opcodes\r
+ EndOpCodeHandle // Replace data\r
+ );\r
+\r
+ HiiFreeOpCodeHandle (StartOpCodeHandle);\r
+ HiiFreeOpCodeHandle (OptionsOpCodeHandle);\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 BROWSER_STATE_SET_PASSWORD:\r
- Status = SetPassword (PrivateData, Value->string);\r
- PrivateData->PasswordState = BROWSER_STATE_VALIDATE_PASSWORD;\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
+ break;\r
+\r
+ case EFI_BROWSER_ACTION_CHANGED:\r
+ switch (QuestionId) {\r
+ case 0x1237:\r
+ //\r
+ // User press "Exit now", request Browser to exit\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
+ break;\r
+ \r
+ case 0x1238:\r
+ //\r
+ // User press "Save now", request Browser to save the uncommitted data.\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
+ break;\r
+ \r
+ case 0x1241:\r
+ case 0x1246:\r
+ //\r
+ // User press "Submit current form and Exit now", request Browser to submit current form and exit\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT;\r
+ break;\r
+ \r
+ case 0x1242:\r
+ //\r
+ // User press "Discard current form now", request Browser to discard the uncommitted data.\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD;\r
+ break;\r
+ \r
+ case 0x1243:\r
+ //\r
+ // User press "Submit current form now", request Browser to save the uncommitted data.\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_APPLY;\r
+ break;\r
+ \r
+ case 0x1244:\r
+ case 0x1245:\r
+ //\r
+ // User press "Discard current form and Exit now", request Browser to discard the uncommitted data and exit.\r
+ //\r
+ *ActionRequest = EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT;\r
+ break;\r
+ \r
+ default:\r
+ break;\r
+ }\r
+ break;\r
\r
default:\r
+ Status = EFI_UNSUPPORTED;\r
break;\r
}\r
\r
return Status;\r
}\r
\r
+/**\r
+ Main entry for this driver.\r
+\r
+ @param ImageHandle Image handle this driver.\r
+ @param SystemTable Pointer to SystemTable.\r
+\r
+ @retval EFI_SUCESS This function always complete successfully.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
DriverSampleInit (\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_STATUS SavedStatus;\r
- EFI_HII_PACKAGE_LIST_HEADER *PackageList;\r
EFI_HII_HANDLE HiiHandle[2];\r
- EFI_HANDLE DriverHandle[2];\r
- DRIVER_SAMPLE_PRIVATE_DATA *PrivateData;\r
EFI_SCREEN_DESCRIPTOR Screen;\r
EFI_HII_DATABASE_PROTOCOL *HiiDatabase;\r
EFI_HII_STRING_PROTOCOL *HiiString;\r
CHAR16 *NewString;\r
UINTN BufferSize;\r
DRIVER_SAMPLE_CONFIGURATION *Configuration;\r
- BOOLEAN ExtractIfrDefault;\r
+ BOOLEAN ActionFlag;\r
+ EFI_STRING ConfigRequestHdr;\r
+ EFI_STRING NameRequestHdr;\r
+ MY_EFI_VARSTORE_DATA *VarStoreConfig;\r
+ EFI_INPUT_KEY HotKey;\r
+ EFI_FORM_BROWSER_EXTENSION_PROTOCOL *FormBrowserEx;\r
\r
//\r
- // Initialize the library and our protocol.\r
+ // Initialize the local variables.\r
//\r
- //@MT: EfiInitializeDriverLib (ImageHandle, SystemTable);\r
+ ConfigRequestHdr = NULL;\r
+ NewString = NULL;\r
\r
//\r
// Initialize screen dimensions for SendForm().\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
}\r
PrivateData->HiiConfigRouting = HiiConfigRouting;\r
\r
- //\r
- // Install Config Access protocol\r
- //\r
- Status = HiiLibCreateHiiDriverHandle (&DriverHandle[0]);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
- PrivateData->DriverHandle[0] = DriverHandle[0];\r
-\r
- Status = gBS->InstallProtocolInterface (\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
&DriverHandle[0],\r
+ &gEfiDevicePathProtocolGuid,\r
+ &mHiiVendorDevicePath0,\r
&gEfiHiiConfigAccessProtocolGuid,\r
- EFI_NATIVE_INTERFACE,\r
- &PrivateData->ConfigAccess\r
+ &PrivateData->ConfigAccess,\r
+ NULL\r
);\r
ASSERT_EFI_ERROR (Status);\r
\r
+ PrivateData->DriverHandle[0] = DriverHandle[0];\r
+\r
//\r
// Publish our HII data\r
//\r
- PackageList = PreparePackageList (\r
- 2,\r
- &mFormSetGuid,\r
- DriverSampleStrings,\r
- VfrBin\r
- );\r
- if (PackageList == NULL) {\r
+ HiiHandle[0] = HiiAddPackages (\r
+ &gDriverSampleFormSetGuid,\r
+ DriverHandle[0],\r
+ DriverSampleStrings,\r
+ VfrBin,\r
+ NULL\r
+ );\r
+ if (HiiHandle[0] == NULL) {\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
- Status = HiiDatabase->NewPackageList (\r
- HiiDatabase,\r
- PackageList,\r
- DriverHandle[0],\r
- &HiiHandle[0]\r
- );\r
- gBS->FreePool (PackageList);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
PrivateData->HiiHandle[0] = HiiHandle[0];\r
\r
//\r
// Publish another Fromset\r
//\r
- Status = HiiLibCreateHiiDriverHandle (&DriverHandle[1]);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &DriverHandle[1],\r
+ &gEfiDevicePathProtocolGuid,\r
+ &mHiiVendorDevicePath1,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
PrivateData->DriverHandle[1] = DriverHandle[1];\r
\r
- PackageList = PreparePackageList (\r
- 2,\r
- &mInventoryGuid,\r
- DriverSampleStrings,\r
- InventoryBin\r
- );\r
- if (PackageList == NULL) {\r
+ HiiHandle[1] = HiiAddPackages (\r
+ &gDriverSampleInventoryGuid,\r
+ DriverHandle[1],\r
+ DriverSampleStrings,\r
+ InventoryBin,\r
+ NULL\r
+ );\r
+ if (HiiHandle[1] == NULL) {\r
+ DriverSampleUnload (ImageHandle);\r
return EFI_OUT_OF_RESOURCES;\r
}\r
\r
- Status = HiiDatabase->NewPackageList (\r
- HiiDatabase,\r
- PackageList,\r
- DriverHandle[1],\r
- &HiiHandle[1]\r
- );\r
- gBS->FreePool (PackageList);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
PrivateData->HiiHandle[1] = HiiHandle[1];\r
\r
+ //\r
+ // Update the device path string.\r
+ //\r
+ NewString = ConvertDevicePathToText((EFI_DEVICE_PATH_PROTOCOL*)&mHiiVendorDevicePath0, FALSE, FALSE);\r
+ if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_DEVICE_PATH), NewString, NULL) == 0) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ if (NewString != NULL) {\r
+ FreePool (NewString);\r
+ }\r
+\r
//\r
// Very simple example of how one would update a string that is already\r
// in the HII database\r
//\r
NewString = L"700 Mhz";\r
\r
- Status = IfrLibSetString (HiiHandle[0], STRING_TOKEN (STR_CPU_STRING2), NewString);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\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 (&gDriverSampleFormSetGuid, VariableName, DriverHandle[0]);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
+\r
+ NameRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, NULL, DriverHandle[0]);\r
+ ASSERT (NameRequestHdr != 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
+ Status = gRT->GetVariable (VariableName, &gDriverSampleFormSetGuid, NULL, &BufferSize, Configuration);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Store zero data Buffer Storage to EFI variable\r
+ //\r
+ Status = gRT->SetVariable(\r
+ VariableName,\r
+ &gDriverSampleFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+ Configuration\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 (NameRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\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 (NameRequestHdr);\r
+ if (!ActionFlag) {\r
+ DriverSampleUnload (ImageHandle);\r
+ return EFI_INVALID_PARAMETER;\r
+ }\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 efi varstore configuration data\r
+ //\r
+ VarStoreConfig = &PrivateData->VarStoreConfig;\r
+ ZeroMem (VarStoreConfig, sizeof (MY_EFI_VARSTORE_DATA));\r
\r
- if (ExtractIfrDefault) {\r
+ ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, MyEfiVar, DriverHandle[0]);\r
+ ASSERT (ConfigRequestHdr != NULL);\r
+\r
+ BufferSize = sizeof (MY_EFI_VARSTORE_DATA);\r
+ Status = gRT->GetVariable (MyEfiVar, &gDriverSampleFormSetGuid, NULL, &BufferSize, VarStoreConfig);\r
+ if (EFI_ERROR (Status)) {\r
+ //\r
+ // Store zero data to EFI variable Storage.\r
+ //\r
+ Status = gRT->SetVariable(\r
+ MyEfiVar,\r
+ &gDriverSampleFormSetGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (MY_EFI_VARSTORE_DATA),\r
+ VarStoreConfig\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
- BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
- Status = ExtractDefault (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
+ 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
+ NULL,\r
+ &gEfiIfrRefreshIdOpGuid,\r
+ &mEvent\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ //\r
+ // Example of how to use BrowserEx protocol to register HotKey.\r
+ // \r
+ Status = gBS->LocateProtocol (&gEfiFormBrowserExProtocolGuid, NULL, (VOID **) &FormBrowserEx);\r
+ if (!EFI_ERROR (Status)) {\r
+ //\r
+ // First unregister the default hot key F9 and F10.\r
+ //\r
+ HotKey.UnicodeChar = CHAR_NULL;\r
+ HotKey.ScanCode = SCAN_F9;\r
+ FormBrowserEx->RegisterHotKey (&HotKey, 0, 0, NULL);\r
+ HotKey.ScanCode = SCAN_F10;\r
+ FormBrowserEx->RegisterHotKey (&HotKey, 0, 0, NULL);\r
+ \r
+ //\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
+ 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
+ ASSERT (NewString != NULL);\r
+ FormBrowserEx->RegisterHotKey (&HotKey, BROWSER_ACTION_DEFAULT, EFI_HII_DEFAULT_CLASS_STANDARD, NewString);\r
+ }\r
+\r
+ //\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
+ // it need to call SendForm to show front page by itself.\r
//\r
- if (DISPLAY_ONLY_MY_ITEM == 0x0001) {\r
+ if (DISPLAY_ONLY_MY_ITEM <= 1) {\r
//\r
// Have the browser pull out our copy of the data, and only display our data\r
//\r
- // Status = FormConfig->SendForm (FormConfig, TRUE, HiiHandle, NULL, NULL, NULL, &Screen, NULL);\r
- //\r
Status = FormBrowser2->SendForm (\r
FormBrowser2,\r
- HiiHandle,\r
+ &(HiiHandle[DISPLAY_ONLY_MY_ITEM]),\r
1,\r
NULL,\r
0,\r
NULL,\r
NULL\r
);\r
- SavedStatus = Status;\r
\r
- Status = HiiDatabase->RemovePackageList (HiiDatabase, HiiHandle[0]);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
+ HiiRemovePackages (HiiHandle[0]);\r
\r
- Status = HiiDatabase->RemovePackageList (HiiDatabase, HiiHandle[1]);\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
+ HiiRemovePackages (HiiHandle[1]);\r
+ }\r
\r
- return SavedStatus;\r
- } else {\r
- //\r
- // Have the browser pull out all the data in the HII Database and display it.\r
- //\r
- // Status = FormConfig->SendForm (FormConfig, TRUE, 0, NULL, NULL, NULL, NULL, NULL);\r
- //\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Unloads the application and its installed protocol.\r
+\r
+ @param[in] ImageHandle Handle that identifies the image to be unloaded.\r
+\r
+ @retval EFI_SUCCESS The image has been unloaded.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+DriverSampleUnload (\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
+ &gEfiDevicePathProtocolGuid,\r
+ &mHiiVendorDevicePath0,\r
+ &gEfiHiiConfigAccessProtocolGuid,\r
+ &PrivateData->ConfigAccess,\r
+ NULL\r
+ );\r
+ DriverHandle[0] = NULL;\r
+ }\r
+\r
+ if (DriverHandle[1] != NULL) {\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ DriverHandle[1],\r
+ &gEfiDevicePathProtocolGuid,\r
+ &mHiiVendorDevicePath1,\r
+ NULL\r
+ );\r
+ DriverHandle[1] = NULL;\r
}\r
\r
+ if (PrivateData->HiiHandle[0] != NULL) {\r
+ HiiRemovePackages (PrivateData->HiiHandle[0]);\r
+ }\r
+\r
+ if (PrivateData->HiiHandle[1] != NULL) {\r
+ HiiRemovePackages (PrivateData->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
+ }\r
+ }\r
+ FreePool (PrivateData);\r
+ PrivateData = NULL;\r
+\r
+ gBS->CloseEvent (mEvent);\r
+\r
return EFI_SUCCESS;\r
}\r
projects / mirror_edk2.git / blobdiff