]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
MdeModulePkg: Add match2 opcode support in SetupBrowserDxe and sample code in DriverS...
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
index 4b44330ec8ccbf32612f60a0e2585453a1b9bf95..204c043ff45e9617935f68aadb8ef9f9e1f72079 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 - 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
@@ -388,7 +388,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
@@ -671,6 +671,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
@@ -1667,50 +1668,6 @@ DriverCallback (
       }\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
-      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
     case 0x2000:\r
       //\r
       // Only used to update the state.\r
@@ -1751,6 +1708,57 @@ DriverCallback (
   }\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
@@ -1787,12 +1795,17 @@ DriverSampleInit (
   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
+  EFI_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
@@ -1912,11 +1925,15 @@ DriverSampleInit (
   //\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
@@ -1949,6 +1966,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
@@ -1962,19 +1982,40 @@ 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
@@ -2000,19 +2041,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
@@ -2025,6 +2075,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 (&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