]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
Correct DriverSample ConfigAcess protocol ExtractConfig interface.
[mirror_edk2.git] / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
index 573374f59bf949421f0d8f54c19306191519496a..38d36f8a287a26c292f8a5e0c9278c7293870fe1 100644 (file)
@@ -22,7 +22,6 @@ EFI_GUID   mFormSetGuid = FORMSET_GUID;
 EFI_GUID   mInventoryGuid = INVENTORY_GUID;\r
 \r
 CHAR16     VariableName[] = L"MyIfrNVData";\r
-\r
 EFI_HANDLE                      DriverHandle[2] = {NULL, NULL};\r
 DRIVER_SAMPLE_PRIVATE_DATA      *PrivateData = NULL;\r
 \r
@@ -128,6 +127,7 @@ ValidatePassword (
   EFI_STATUS                      Status;\r
   UINTN                           Index;\r
   UINTN                           BufferSize;\r
+  UINTN                           PasswordMaxSize;\r
   CHAR16                          *Password;\r
   CHAR16                          *EncodedPassword;\r
   BOOLEAN                         OldPassword;\r
@@ -151,10 +151,11 @@ ValidatePassword (
   }\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
@@ -174,7 +175,7 @@ ValidatePassword (
   if (Password == NULL) {\r
     return EFI_NOT_READY;\r
   }\r
-  if (StrLen (Password) > 20) {\r
+  if (StrSize (Password) > PasswordMaxSize) {\r
     FreePool (Password);\r
     return EFI_NOT_READY;\r
   }\r
@@ -182,11 +183,11 @@ ValidatePassword (
   //\r
   // Validate old password\r
   //\r
-  EncodedPassword = AllocateZeroPool (21 * sizeof (CHAR16));\r
+  EncodedPassword = AllocateZeroPool (PasswordMaxSize);\r
   ASSERT (EncodedPassword != NULL);\r
-  StrnCpy (EncodedPassword, Password, 21);\r
-  EncodePassword (EncodedPassword, 20 * sizeof (CHAR16));\r
-  if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, 20 * sizeof (CHAR16)) != 0) {\r
+  StrnCpy (EncodedPassword, Password, StrLen (Password));\r
+  EncodePassword (EncodedPassword, StrLen (EncodedPassword) * sizeof (CHAR16));\r
+  if (CompareMem (EncodedPassword, PrivateData->Configuration.WhatIsThePassword2, StrLen (EncodedPassword) * sizeof (CHAR16)) != 0) {\r
     //\r
     // Old password mismatch, return EFI_NOT_READY to prompt for error message\r
     //\r
@@ -250,22 +251,23 @@ SetPassword (
   if (TempPassword == NULL) {\r
     return EFI_NOT_READY;\r
   }\r
-  if (StrLen (TempPassword) > PasswordSize / sizeof (CHAR16)) {\r
+  if (StrSize (TempPassword) > PasswordSize) {\r
     FreePool (TempPassword);\r
     return EFI_NOT_READY;\r
   }\r
-  StrnCpy (Password, TempPassword, PasswordSize / sizeof (CHAR16));\r
+  StrnCpy (Password, TempPassword, StrLen (TempPassword));\r
   FreePool (TempPassword);\r
 \r
   //\r
   // Retrive uncommitted data from Browser\r
   //\r
-  Configuration = (DRIVER_SAMPLE_CONFIGURATION *) HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
-  if (Configuration != NULL) {\r
+  Configuration = AllocateZeroPool (sizeof (DRIVER_SAMPLE_CONFIGURATION));\r
+  ASSERT (Configuration != NULL);\r
+  if (HiiGetBrowserData (&mFormSetGuid, VariableName, sizeof (DRIVER_SAMPLE_CONFIGURATION), (UINT8 *) Configuration)) {\r
     //\r
     // Update password's clear text in the screen\r
     //\r
-    CopyMem (Configuration->PasswordClearText, Password, PasswordSize);\r
+    CopyMem (Configuration->PasswordClearText, Password, StrSize (Password));\r
 \r
     //\r
     // Update uncommitted data of Browser\r
@@ -277,15 +279,18 @@ SetPassword (
        (UINT8 *) Configuration,\r
        NULL\r
        );\r
-    \r
-    FreePool (Configuration);\r
   }\r
 \r
+  //\r
+  // Free Configuration Buffer\r
+  //\r
+  FreePool (Configuration);\r
+\r
 \r
   //\r
   // Set password\r
   //\r
-  EncodePassword (Password, PasswordSize);\r
+  EncodePassword (Password, StrLen (Password) * 2);\r
   Status = gRT->SetVariable(\r
                   VariableName,\r
                   &mFormSetGuid,\r
@@ -336,62 +341,63 @@ ExtractConfig (
   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
+  \r
+  if (Progress == NULL || Results == NULL || Request == 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
 \r
   PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
   HiiConfigRouting = PrivateData->HiiConfigRouting;\r
 \r
   //\r
-  //\r
-  // Get Buffer Storage data from EFI variable\r
+  // Get Buffer Storage data from EFI variable.\r
+  // Try to get the current setting from variable.\r
   //\r
   BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
   Status = gRT->GetVariable (\r
-                  VariableName,\r
-                  &mFormSetGuid,\r
-                  NULL,\r
-                  &BufferSize,\r
-                  &PrivateData->Configuration\r
-                  );\r
+            VariableName,\r
+            &mFormSetGuid,\r
+            NULL,\r
+            &BufferSize,\r
+            &PrivateData->Configuration\r
+            );\r
   if (EFI_ERROR (Status)) {\r
-    return Status;\r
+    return EFI_NOT_FOUND;\r
   }\r
-\r
+  \r
   if (Request == NULL) {\r
     //\r
-    // Request is set to NULL, return all configurable elements together with ALTCFG\r
+    // Request is set to NULL, construct full request string.\r
     //\r
-    *Results = HiiConstructConfigAltResp (\r
-                 &mFormSetGuid,\r
-                 VariableName,\r
-                 PrivateData->DriverHandle[0],\r
-                 &PrivateData->Configuration,\r
-                 BufferSize,\r
-                 VfrMyIfrNVDataBlockName,\r
-                 STRING_TOKEN (STR_STANDARD_DEFAULT_PROMPT),\r
-                 VfrMyIfrNVDataDefault0000,\r
-                 STRING_TOKEN (STR_MANUFACTURE_DEFAULT_PROMPT),\r
-                 VfrMyIfrNVDataDefault0001,\r
-                 0,\r
-                 NULL\r
-               );\r
-    \r
+\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
-    // No matched storage is found.\r
+    ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
+    Size = (StrLen (ConfigRequest) + 32 + 1) * sizeof (CHAR16);\r
+    ConfigRequest = AllocateZeroPool (Size);\r
+    UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
+    FreePool (ConfigRequestHdr);\r
+  } else {\r
+    //\r
+    // Check routing data in <ConfigHdr>.\r
+    // Note: if only one Storage is used, then this checking could be skipped.\r
     //\r
-    if (*Results == NULL) {\r
+    if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, VariableName)) {\r
       return EFI_NOT_FOUND;\r
     }\r
-\r
-    return EFI_SUCCESS;\r
-  }\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 (Request, &mFormSetGuid, VariableName)) {\r
-    *Progress = Request;\r
-    return EFI_NOT_FOUND;\r
+    ConfigRequest = Request;\r
   }\r
 \r
   //\r
@@ -399,12 +405,18 @@ ExtractConfig (
   //\r
   Status = HiiConfigRouting->BlockToConfig (\r
                                 HiiConfigRouting,\r
-                                Request,\r
+                                ConfigRequest,\r
                                 (UINT8 *) &PrivateData->Configuration,\r
                                 BufferSize,\r
                                 Results,\r
                                 Progress\r
                                 );\r
+  \r
+  if (Request == NULL) {\r
+    FreePool (ConfigRequest);\r
+    *Progress = NULL;\r
+  }\r
+\r
   return Status;\r
 }\r
 \r
@@ -447,6 +459,7 @@ RouteConfig (
   PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
   HiiConfigRouting = PrivateData->HiiConfigRouting;\r
 \r
+  //\r
   // Check routing data in <ConfigHdr>.\r
   // Note: if only one Storage is used, then this checking could be skipped.\r
   //\r
@@ -460,12 +473,12 @@ RouteConfig (
   //\r
   BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
   Status = gRT->GetVariable (\r
-                  VariableName,\r
-                  &mFormSetGuid,\r
-                  NULL,\r
-                  &BufferSize,\r
-                  &PrivateData->Configuration\r
-                  );\r
+            VariableName,\r
+            &mFormSetGuid,\r
+            NULL,\r
+            &BufferSize,\r
+            &PrivateData->Configuration\r
+            );\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
@@ -545,6 +558,11 @@ DriverCallback (
   if ((Value == NULL) || (ActionRequest == NULL)) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
+  \r
+  if ((Type == EFI_IFR_TYPE_STRING) && (Value->string == 0)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+   \r
 \r
   Status = EFI_SUCCESS;\r
   PrivateData = DRIVER_SAMPLE_PRIVATE_FROM_THIS (This);\r
@@ -792,7 +810,6 @@ DriverSampleInit (
   )\r
 {\r
   EFI_STATUS                      Status;\r
-  EFI_STATUS                      SavedStatus;\r
   EFI_HII_HANDLE                  HiiHandle[2];\r
   EFI_SCREEN_DESCRIPTOR           Screen;\r
   EFI_HII_DATABASE_PROTOCOL       *HiiDatabase;\r
@@ -802,12 +819,13 @@ DriverSampleInit (
   CHAR16                          *NewString;\r
   UINTN                           BufferSize;\r
   DRIVER_SAMPLE_CONFIGURATION     *Configuration;\r
-  BOOLEAN                         ExtractIfrDefault;\r
-\r
+  BOOLEAN                         ActionFlag;\r
+  EFI_STRING                      ConfigRequestHdr;  \r
+  \r
   //\r
-  // Initialize the library and our protocol.\r
+  // Initialize the local variables.\r
   //\r
-\r
+  ConfigRequestHdr = NULL;\r
   //\r
   // Initialize screen dimensions for SendForm().\r
   // Remove 3 characters from top and bottom\r
@@ -942,36 +960,42 @@ DriverSampleInit (
   //\r
   // Try to read NV config EFI variable first\r
   //\r
-  ExtractIfrDefault = TRUE;\r
+  ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, DriverHandle[0]);\r
+  ASSERT (ConfigRequestHdr != NULL);\r
+\r
   BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
   Status = gRT->GetVariable (VariableName, &mFormSetGuid, NULL, &BufferSize, Configuration);\r
-  if (!EFI_ERROR (Status) && (BufferSize == sizeof (DRIVER_SAMPLE_CONFIGURATION))) {\r
-    ExtractIfrDefault = FALSE;\r
-  }\r
-\r
-  if (ExtractIfrDefault) {\r
+  if (EFI_ERROR (Status)) {\r
+    //\r
+    // Store zero data Buffer Storage to EFI variable\r
+    //\r
+    Status = gRT->SetVariable(\r
+                    VariableName,\r
+                    &mFormSetGuid,\r
+                    EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+                    sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
+                    Configuration\r
+                    );\r
+    ASSERT (Status == EFI_SUCCESS);\r
     //\r
     // EFI variable for NV config doesn't exit, we should build this variable\r
     // based on default values stored in IFR\r
     //\r
-    BufferSize = sizeof (DRIVER_SAMPLE_CONFIGURATION);\r
-    Status = HiiIfrLibExtractDefault (Configuration, &BufferSize, 1, VfrMyIfrNVDataDefault0000);\r
-\r
-    if (!EFI_ERROR (Status)) {\r
-      gRT->SetVariable(\r
-             VariableName,\r
-             &mFormSetGuid,\r
-             EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
-             sizeof (DRIVER_SAMPLE_CONFIGURATION),\r
-             Configuration\r
-             );\r
-    }\r
+    ActionFlag = HiiSetToDefaults (ConfigRequestHdr, EFI_HII_DEFAULT_CLASS_STANDARD);\r
+    ASSERT (ActionFlag);\r
+  } else {\r
+    //\r
+    // EFI variable does exist and Validate Current Setting\r
+    //\r
+    ActionFlag = HiiValidateSettings (ConfigRequestHdr);\r
+    ASSERT (ActionFlag);\r
   }\r
   \r
-  SavedStatus = EFI_SUCCESS;\r
+  FreePool (ConfigRequestHdr);\r
+\r
 \r
   //\r
-  // Default this driver is built into Flash device image, \r
+  // In default, this driver is built into Flash device image, \r
   // the following code doesn't run.\r
   //\r
 \r
@@ -993,20 +1017,13 @@ DriverSampleInit (
                              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
+  return EFI_SUCCESS;\r
 }\r
 \r
 /**\r
@@ -1042,6 +1059,14 @@ DriverSampleUnload (
            );\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
   if (PrivateData != NULL) {\r
     FreePool (PrivateData);\r
   }\r