]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
MdeModulePkg/Universal: Fix typos in comments
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
index e7c1202ecfd7eacc68b2ce22a9627c356e428c2b..3c494e3c83376fe7c6fbedf48df7b8a047d5d66e 100644 (file)
@@ -2,7 +2,7 @@
 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 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2004 - 2016, 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
@@ -21,7 +21,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 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
@@ -68,6 +68,48 @@ HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePath1 = {
   }\r
 };\r
 \r
+/**\r
+  Set value of a data element in an Array by its Index.\r
+\r
+  @param  Array                  The data array.\r
+  @param  Type                   Type of the data in this array.\r
+  @param  Index                  Zero based index for data in this array.\r
+  @param  Value                  The value to be set.\r
+\r
+**/\r
+VOID\r
+SetArrayData (\r
+  IN VOID                     *Array,\r
+  IN UINT8                    Type,\r
+  IN UINTN                    Index,\r
+  IN UINT64                   Value\r
+  )\r
+{\r
+\r
+  ASSERT (Array != NULL);\r
+\r
+  switch (Type) {\r
+  case EFI_IFR_TYPE_NUM_SIZE_8:\r
+    *(((UINT8 *) Array) + Index) = (UINT8) Value;\r
+    break;\r
+\r
+  case EFI_IFR_TYPE_NUM_SIZE_16:\r
+    *(((UINT16 *) Array) + Index) = (UINT16) Value;\r
+    break;\r
+\r
+  case EFI_IFR_TYPE_NUM_SIZE_32:\r
+    *(((UINT32 *) Array) + Index) = (UINT32) Value;\r
+    break;\r
+\r
+  case EFI_IFR_TYPE_NUM_SIZE_64:\r
+    *(((UINT64 *) Array) + Index) = (UINT64) Value;\r
+    break;\r
+\r
+  default:\r
+    break;\r
+  }\r
+}\r
+\r
 /**\r
   Add empty function for event process function.\r
 \r
@@ -330,7 +372,7 @@ ValidatePassword (
   //\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
@@ -388,7 +430,7 @@ SetPassword (
   //\r
   // Get user input password\r
   //\r
-  Password = &PrivateData->Configuration.WhatIsThePassword2[0];\r
+  Password = PrivateData->Configuration.WhatIsThePassword2;\r
   PasswordSize = sizeof (PrivateData->Configuration.WhatIsThePassword2);\r
   ZeroMem (Password, PasswordSize);\r
 \r
@@ -400,11 +442,11 @@ SetPassword (
     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
-  // Retrive uncommitted data from Browser\r
+  // Retrieve uncommitted data from Browser\r
   //\r
   Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
   ASSERT (Configuration != NULL);\r
@@ -601,7 +643,7 @@ CreateAltCfgString (
 \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
@@ -671,6 +713,7 @@ AppendAltCfgString (
   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
@@ -734,6 +777,11 @@ AppendAltCfgString (
     }\r
     StringPtr += Length;\r
 \r
+    //\r
+    // Skip the character "&" before "OFFSET".\r
+    //\r
+    StringPtr ++;\r
+\r
     //\r
     // Calculate Value and convert it to hex string.\r
     //\r
@@ -907,7 +955,7 @@ ExtractConfig (
       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
@@ -1183,7 +1231,7 @@ RouteConfig (
       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
@@ -1278,7 +1326,13 @@ DriverCallback (
   DRIVER_SAMPLE_CONFIGURATION     *Configuration;\r
   MY_EFI_VARSTORE_DATA            *EfiData;\r
   EFI_FORM_ID                     FormId;\r
-  \r
+  EFI_STRING                      Progress;\r
+  EFI_STRING                      Results;\r
+  UINT32                          ProgressErr;\r
+  CHAR16                          *TmpStr;\r
+  UINTN                           Index;\r
+  UINT64                          BufferValue;\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
@@ -1286,7 +1340,9 @@ DriverCallback (
 \r
 \r
   FormId = 0;\r
+  ProgressErr = 0;\r
   Status = EFI_SUCCESS;\r
+  BufferValue = 3;\r
   PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
 \r
   switch (Action) {\r
@@ -1369,14 +1425,90 @@ DriverCallback (
     \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
@@ -1388,6 +1520,12 @@ DriverCallback (
         Value->u8 = DEFAULT_CLASS_STANDARD_VALUE;\r
       break;\r
 \r
+      case 0x1252:\r
+        for (Index = 0; Index < 3; Index ++) {\r
+          SetArrayData (Value, EFI_IFR_TYPE_NUM_SIZE_8, Index, BufferValue--);\r
+        }\r
+      break;\r
+\r
       default:\r
         Status = EFI_UNSUPPORTED;\r
       break;\r
@@ -1590,83 +1728,6 @@ DriverCallback (
       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
@@ -1752,12 +1813,105 @@ DriverCallback (
         //\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
   break;\r
 \r
+  case EFI_BROWSER_ACTION_SUBMITTED:\r
+    {\r
+      if (QuestionId == 0x1250) {\r
+        //\r
+        // Sample CallBack for EFI_BROWSER_ACTION_SUBMITTED action:\r
+        // Show up a pop-up to show SUBMITTED callback has been triggered.\r
+        //\r
+        do {\r
+          CreatePopUp (\r
+            EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE,\r
+            &Key,\r
+            L"",\r
+            L"EfiVarstore value has been submitted!",\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
+    break;\r
+\r
   default:\r
     Status = EFI_UNSUPPORTED;\r
     break;\r
@@ -1789,17 +1943,23 @@ DriverSampleInit (
   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
   BOOLEAN                         ActionFlag;\r
   EFI_STRING                      ConfigRequestHdr;\r
+  EFI_STRING                      NameRequestHdr;\r
   MY_EFI_VARSTORE_DATA            *VarStoreConfig;\r
+  EFI_INPUT_KEY                   HotKey;\r
+  EDKII_FORM_BROWSER_EXTENSION_PROTOCOL *FormBrowserEx;\r
 \r
   //\r
   // Initialize the local variables.\r
   //\r
   ConfigRequestHdr = NULL;\r
+  NewString        = NULL;\r
+\r
   //\r
   // Initialize screen dimensions for SendForm().\r
   // Remove 3 characters from top and bottom\r
@@ -1813,17 +1973,17 @@ DriverSampleInit (
   //\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
@@ -1832,7 +1992,7 @@ DriverSampleInit (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  PrivateData->HiiDatabase = HiiDatabase;\r
+  mPrivateData->HiiDatabase = HiiDatabase;\r
 \r
   //\r
   // Locate HiiString protocol\r
@@ -1841,7 +2001,7 @@ DriverSampleInit (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  PrivateData->HiiString = HiiString;\r
+  mPrivateData->HiiString = HiiString;\r
 \r
   //\r
   // Locate Formbrowser2 protocol\r
@@ -1850,7 +2010,7 @@ DriverSampleInit (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  PrivateData->FormBrowser2 = FormBrowser2;\r
+  mPrivateData->FormBrowser2 = FormBrowser2;\r
 \r
   //\r
   // Locate ConfigRouting protocol\r
@@ -1859,19 +2019,28 @@ DriverSampleInit (
   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
@@ -1887,7 +2056,7 @@ DriverSampleInit (
     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
@@ -1896,11 +2065,13 @@ DriverSampleInit (
                   &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
@@ -1914,16 +2085,20 @@ DriverSampleInit (
     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
-  if (HiiSetString (HiiHandle[0], STRING_TOKEN (STR_DEVICE_PATH), (EFI_STRING) &mHiiVendorDevicePath0, NULL) == 0) {\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
-  \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
@@ -1940,14 +2115,14 @@ DriverSampleInit (
   //\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
@@ -1956,6 +2131,9 @@ DriverSampleInit (
   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, &gDriverSampleFormSetGuid, NULL, &BufferSize, Configuration);\r
   if (EFI_ERROR (Status)) {\r
@@ -1969,26 +2147,47 @@ DriverSampleInit (
                     sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
                     Configuration\r
                     );\r
-    ASSERT (Status == EFI_SUCCESS);\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
-    ASSERT (ActionFlag);\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
-    ASSERT (ActionFlag);\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
+  VarStoreConfig = &mPrivateData->VarStoreConfig;\r
   ZeroMem (VarStoreConfig, sizeof (MY_EFI_VARSTORE_DATA));\r
 \r
   ConfigRequestHdr = HiiConstructConfigHdr (&gDriverSampleFormSetGuid, MyEfiVar, DriverHandle[0]);\r
@@ -2007,19 +2206,28 @@ DriverSampleInit (
                     sizeof (MY_EFI_VARSTORE_DATA),\r
                     VarStoreConfig\r
                     );\r
-    ASSERT (Status == EFI_SUCCESS);\r
+    if (EFI_ERROR (Status)) {\r
+      DriverSampleUnload (ImageHandle);\r
+      return Status;\r
+    }\r
     //\r
     // EFI variable for NV config doesn't exit, we should build this variable\r
     // based on default values stored in IFR\r
     //\r
     ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
-    ASSERT (ActionFlag);\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
-    ASSERT (ActionFlag);\r
+    if (!ActionFlag) {\r
+      DriverSampleUnload (ImageHandle);\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
   }\r
   FreePool (ConfigRequestHdr);\r
 \r
@@ -2032,6 +2240,34 @@ DriverSampleInit (
         &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 (&gEdkiiFormBrowserExProtocolGuid, 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 (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 (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
   //\r
   // In default, this driver is built into Flash device image,\r
   // the following code doesn't run.\r
@@ -2079,7 +2315,7 @@ DriverSampleUnload (
 {\r
   UINTN Index;\r
 \r
-  ASSERT (PrivateData != NULL);\r
+  ASSERT (mPrivateData != NULL);\r
 \r
   if (DriverHandle[0] != NULL) {\r
     gBS->UninstallMultipleProtocolInterfaces (\r
@@ -2087,7 +2323,7 @@ DriverSampleUnload (
             &gEfiDevicePathProtocolGuid,\r
             &mHiiVendorDevicePath0,\r
             &gEfiHiiConfigAccessProtocolGuid,\r
-            &PrivateData->ConfigAccess,\r
+            &mPrivateData->ConfigAccess,\r
             NULL\r
            );\r
     DriverHandle[0] = NULL;\r
@@ -2098,26 +2334,28 @@ DriverSampleUnload (
             DriverHandle[1],\r
             &gEfiDevicePathProtocolGuid,\r
             &mHiiVendorDevicePath1,\r
+            &gEfiHiiConfigAccessProtocolGuid,\r
+            &mPrivateData->ConfigAccess,\r
             NULL\r
            );\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