Update HiiConfigAccess.ExtractConfig interface to support NULL request string and...
[efi/edk2/.git] / edk2 / MdeModulePkg / Universal / DriverSampleDxe / DriverSample.c
index 52d9b83..a1e5a1b 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 - 2009, Intel Corporation\r
+Copyright (c) 2004 - 2010, Intel Corporation\r
 All rights reserved. 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
@@ -380,9 +380,9 @@ ExtractConfig (
   UINTN                            ValueStrLen;\r
   CHAR16                           BackupChar;\r
   CHAR16                           *StrPointer;\r
+  BOOLEAN                          AllocatedRequest;\r
 \r
-\r
-  if (Progress == NULL || Results == NULL || Request == NULL) {\r
+  if (Progress == NULL || Results == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
   }\r
   //\r
@@ -392,6 +392,7 @@ ExtractConfig (
   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
@@ -422,8 +423,9 @@ ExtractConfig (
     // followed by "&OFFSET=0&WIDTH=WWWWWWWWWWWWWWWW" followed by a Null-terminator\r
     //\r
     ConfigRequestHdr = HiiConstructConfigHdr (&mFormSetGuid, VariableName, PrivateData->DriverHandle[0]);\r
-    Size = (StrLen (ConfigRequest) + 32 + 1) * sizeof (CHAR16);\r
+    Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
     ConfigRequest = AllocateZeroPool (Size);\r
+    AllocatedRequest = TRUE;\r
     UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
     FreePool (ConfigRequestHdr);\r
   } else {\r
@@ -434,110 +436,140 @@ ExtractConfig (
     if (!HiiIsConfigHdrMatch (Request, &mFormSetGuid, NULL)) {\r
       return EFI_NOT_FOUND;\r
     }\r
+    //\r
+    // Set Request to the unified request string.\r
+    //\r
     ConfigRequest = Request;\r
-\r
     //\r
-    // Check if requesting Name/Value storage\r
+    // Check whether Request includes Request Element.\r
     //\r
     if (StrStr (Request, L"OFFSET") == NULL) {\r
       //\r
-      // Update Name/Value storage Names\r
+      // Check Request Element does exist in Reques String\r
       //\r
-      Status = LoadNameValueNames (PrivateData);\r
-      if (EFI_ERROR (Status)) {\r
-        return Status;\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
+        AllocatedRequest = TRUE;\r
+        UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", Request, (UINT64)BufferSize);\r
+      }\r
+    }\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 (Request) +\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, Request);\r
-      Value = *Results;\r
+  //\r
+  // Check if requesting Name/Value storage\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
-      // 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
+    // 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 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
+    // 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
-      // Append value of NameValueVar2, type is CHAR16 *\r
+      // Convert Unicode String to Config String, e.g. "ABCD" => "0041004200430044"\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
+      StrPointer = (CHAR16 *) PrivateData->Configuration.NameValueVar2;\r
+      for (; *StrPointer != L'\0'; StrPointer++) {\r
+        Value += UnicodeValueToString (Value, PREFIX_ZERO | RADIX_HEX, *StrPointer, 4);\r
       }\r
-\r
-      Progress = (EFI_STRING *) Request + StrLen (Request);\r
-      return EFI_SUCCESS;\r
     }\r
+    \r
+    Status = EFI_SUCCESS;\r
+  } else {\r
+    //\r
+    // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
+    //\r
+    Status = HiiConfigRouting->BlockToConfig (\r
+                                  HiiConfigRouting,\r
+                                  ConfigRequest,\r
+                                  (UINT8 *) &PrivateData->Configuration,\r
+                                  BufferSize,\r
+                                  Results,\r
+                                  Progress\r
+                                  );\r
   }\r
 \r
   //\r
-  // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
+  // Free the allocated config request string.\r
   //\r
-  Status = HiiConfigRouting->BlockToConfig (\r
-                                HiiConfigRouting,\r
-                                ConfigRequest,\r
-                                (UINT8 *) &PrivateData->Configuration,\r
-                                BufferSize,\r
-                                Results,\r
-                                Progress\r
-                                );\r
-\r
-  if (Request == NULL) {\r
+  if (AllocatedRequest) {\r
     FreePool (ConfigRequest);\r
+  }\r
+  //\r
+  // Set Progress string to the original request string.\r
+  //\r
+  if (Request == NULL) {\r
     *Progress = NULL;\r
+  } else if (StrStr (Request, L"OFFSET") == NULL) {\r
+    *Progress = Request + StrLen (Request);\r
   }\r
 \r
   return Status;\r