]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c
Per UEFI spec, on CallBack action EFI_BROWSER_ACTION_CHANGING, the return value of...
[mirror_edk2.git] / MdeModulePkg / Universal / PlatformDriOverrideDxe / PlatDriOverrideDxe.c
index 47921cd43befba29df33634160c6566edcf5e905..ab8a000f1360916ae4a421974b99934f4a3e0cbf 100644 (file)
@@ -13,8 +13,8 @@
   4. It save all the mapping info in NV variables which will be consumed\r
      by platform override protocol driver to publish the platform override protocol.\r
 \r
-Copyright (c) 2007 - 2009, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2011, 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
@@ -61,7 +61,6 @@ extern UINT8  PlatDriOverrideDxeStrings[];
 //\r
 // module global data\r
 //\r
-EFI_GUID                     mPlatformOverridesManagerGuid = PLAT_OVER_MNGR_GUID;\r
 CHAR16                       mVariableName[] = L"Data";\r
 LIST_ENTRY                   mMappingDataBase = INITIALIZE_LIST_HEAD_VARIABLE (mMappingDataBase);\r
 BOOLEAN                      mEnvironmentVariableRead = FALSE;\r
@@ -92,7 +91,7 @@ HII_VENDOR_DEVICE_PATH  mHiiVendorDevicePath = {
         (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
       }\r
     },\r
-    EFI_CALLER_ID_GUID\r
+    PLAT_OVER_MNGR_GUID\r
   },\r
   {\r
     END_DEVICE_PATH_TYPE,\r
@@ -400,7 +399,7 @@ UpdateDeviceSelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_DEVICE,\r
     StartOpCodeHandle, // Label FORM_ID_DEVICE\r
     EndOpCodeHandle    // LABEL_END\r
@@ -531,7 +530,7 @@ UpdateDeviceSelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_DEVICE,\r
     StartOpCodeHandle, // Label FORM_ID_DEVICE\r
     EndOpCodeHandle    // LABEL_END\r
@@ -661,7 +660,7 @@ UpdateBindingDriverSelectPage (
   // Switch the item callback key value to its NO. in mDevicePathHandleBuffer\r
   //\r
   mSelectedCtrIndex = KeyValue - KEY_VALUE_DEVICE_OFFSET;\r
-  ASSERT (mSelectedCtrIndex < MAX_CHOICE_NUM);\r
+  ASSERT (mSelectedCtrIndex >= 0 && mSelectedCtrIndex < MAX_CHOICE_NUM);\r
 \r
   mLastSavedDriverImageNum = 0;\r
 \r
@@ -693,7 +692,7 @@ UpdateBindingDriverSelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_DRIVER,\r
     StartOpCodeHandle,\r
     EndOpCodeHandle\r
@@ -860,7 +859,7 @@ UpdateBindingDriverSelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_DRIVER,\r
     StartOpCodeHandle, // Label FORM_ID_DRIVER\r
     EndOpCodeHandle    // LABEL_END\r
@@ -937,7 +936,7 @@ UpdatePrioritySelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_ORDER,\r
     StartOpCodeHandle,\r
     EndOpCodeHandle\r
@@ -1060,7 +1059,7 @@ UpdatePrioritySelectPage (
   //\r
   HiiUpdateForm (\r
     Private->RegisteredHandle,\r
-    &mPlatformOverridesManagerGuid,\r
+    &gPlatformOverridesManagerGuid,\r
     FORM_ID_ORDER,\r
     StartOpCodeHandle, // Label FORM_ID_ORDER\r
     EndOpCodeHandle    // LABEL_END\r
@@ -1145,7 +1144,7 @@ CommintChanges (
 \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 driver.\r
 \r
 **/\r
@@ -1161,25 +1160,73 @@ PlatOverMngrExtractConfig (
   EFI_STATUS                       Status;\r
   EFI_CALLBACK_INFO                *Private;\r
   EFI_HII_CONFIG_ROUTING_PROTOCOL  *HiiConfigRouting;\r
-  \r
-  if (Request == NULL) {\r
+  EFI_STRING                       ConfigRequestHdr;\r
+  EFI_STRING                       ConfigRequest;\r
+  BOOLEAN                          AllocatedRequest;\r
+  UINTN                            Size;\r
+  UINTN                            BufferSize;\r
+\r
+  if (Progress == NULL || Results == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  *Progress = Request;\r
+  if ((Request != NULL) && !HiiIsConfigHdrMatch (Request, &gPlatformOverridesManagerGuid, mVariableName)) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
-  Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
+  ConfigRequestHdr = NULL;\r
+  ConfigRequest    = NULL;\r
+  Size             = 0;\r
+  AllocatedRequest = FALSE;\r
+\r
+  Private          = EFI_CALLBACK_INFO_FROM_THIS (This);\r
   HiiConfigRouting = Private->HiiConfigRouting;\r
+  ConfigRequest = Request;\r
+  if ((Request == NULL) || (StrStr (Request, L"OFFSET") == NULL)) {\r
+    //\r
+    // Request has no request element, construct full request string.\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 (&gPlatformOverridesManagerGuid, mVariableName, Private->DriverHandle);\r
+    Size = (StrLen (ConfigRequestHdr) + 32 + 1) * sizeof (CHAR16);\r
+    ConfigRequest = AllocateZeroPool (Size);\r
+    ASSERT (ConfigRequest != NULL);\r
+    AllocatedRequest = TRUE;\r
+    BufferSize = sizeof (PLAT_OVER_MNGR_DATA);\r
+    UnicodeSPrint (ConfigRequest, Size, L"%s&OFFSET=0&WIDTH=%016LX", ConfigRequestHdr, (UINT64)BufferSize);\r
+    FreePool (ConfigRequestHdr);\r
+  }\r
 \r
   //\r
   // Convert buffer data to <ConfigResp> by helper function BlockToConfig()\r
   //\r
   Status = HiiConfigRouting->BlockToConfig (\r
                                 HiiConfigRouting,\r
-                                Request,\r
+                                ConfigRequest,\r
                                 (UINT8 *) &Private->FakeNvData,\r
                                 sizeof (PLAT_OVER_MNGR_DATA),\r
                                 Results,\r
                                 Progress\r
                                 );\r
+\r
+  //\r
+  // Free the allocated config request string.\r
+  //\r
+  if (AllocatedRequest) {\r
+    FreePool (ConfigRequest);\r
+    ConfigRequest = NULL;\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
@@ -1210,11 +1257,24 @@ PlatOverMngrRouteConfig (
   UINT16                                    KeyValue;\r
   PLAT_OVER_MNGR_DATA                       *FakeNvData;\r
 \r
-  Private    = EFI_CALLBACK_INFO_FROM_THIS (This);\r
-  FakeNvData = (PLAT_OVER_MNGR_DATA *) HiiGetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA));\r
-  if (FakeNvData == NULL) {\r
+  if (Configuration == NULL || Progress == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  *Progress = Configuration;\r
+\r
+  if (!HiiIsConfigHdrMatch (Configuration, &gPlatformOverridesManagerGuid, mVariableName)) {\r
     return EFI_NOT_FOUND;\r
   }\r
+  \r
+  *Progress = Configuration + StrLen (Configuration);\r
+  Private    = EFI_CALLBACK_INFO_FROM_THIS (This);\r
+  FakeNvData = &Private->FakeNvData;\r
+  if (!HiiGetBrowserData (&gPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData)) {\r
+    //\r
+    // FakeNvData can't be got from SetupBrowser, which doesn't need to be set.\r
+    //\r
+    return EFI_SUCCESS;\r
+  }\r
 \r
   if (mCurrentPage == FORM_ID_DRIVER) {\r
     KeyValue = KEY_VALUE_DRIVER_GOTO_ORDER;\r
@@ -1233,10 +1293,6 @@ PlatOverMngrRouteConfig (
     CommintChanges (Private, KeyValue, FakeNvData);\r
   }\r
 \r
-  if (FakeNvData != NULL) {\r
-    FreePool (FakeNvData);\r
-  }\r
-\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -1277,81 +1333,101 @@ PlatOverMngrCallback (
   EFI_STRING_ID                             NewStringToken;\r
   EFI_INPUT_KEY                             Key;\r
   PLAT_OVER_MNGR_DATA                       *FakeNvData;\r
-  \r
+\r
+  if ((Action != EFI_BROWSER_ACTION_CHANGING) && (Action != EFI_BROWSER_ACTION_CHANGED)) {\r
+    //\r
+    // All other action return unsupported.\r
+    //\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
   Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
-  FakeNvData = (PLAT_OVER_MNGR_DATA *) HiiGetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA));\r
-  if (FakeNvData == NULL) {\r
+  FakeNvData = &Private->FakeNvData;\r
+  if (!HiiGetBrowserData (&gPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData)) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
-  if (KeyValue == KEY_VALUE_DEVICE_REFRESH ||\r
-      KeyValue == KEY_VALUE_DEVICE_FILTER ||\r
-      KeyValue == KEY_VALUE_DRIVER_GOTO_PREVIOUS\r
-      ) {\r
-    UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
-    //\r
-    // Update page title string\r
-    //\r
-    NewStringToken = STRING_TOKEN (STR_TITLE);\r
-    if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"First, Select the controller by device path", NULL) == 0) {\r
-      ASSERT (FALSE);\r
+  if (Action == EFI_BROWSER_ACTION_CHANGING) {\r
+    if (Value == NULL) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+    \r
+    if (KeyValue == KEY_VALUE_DRIVER_GOTO_PREVIOUS) {\r
+      UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
+      //\r
+      // Update page title string\r
+      //\r
+      NewStringToken = STRING_TOKEN (STR_TITLE);\r
+      if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"First, Select the controller by device path", NULL) == 0) {\r
+        ASSERT (FALSE);\r
+      }\r
     }\r
-  }\r
 \r
-  if (((KeyValue >= KEY_VALUE_DEVICE_OFFSET) && (KeyValue < KEY_VALUE_DEVICE_MAX)) || (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS)) {\r
-    if (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS) {\r
-      KeyValue = (EFI_QUESTION_ID) (mSelectedCtrIndex + KEY_VALUE_DEVICE_OFFSET);\r
+    if (((KeyValue >= KEY_VALUE_DEVICE_OFFSET) && (KeyValue < KEY_VALUE_DEVICE_MAX)) || (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS)) {\r
+      if (KeyValue == KEY_VALUE_ORDER_GOTO_PREVIOUS) {\r
+        KeyValue = (EFI_QUESTION_ID) (mSelectedCtrIndex + KEY_VALUE_DEVICE_OFFSET);\r
+      }\r
+      UpdateBindingDriverSelectPage (Private, KeyValue, FakeNvData);\r
+      //\r
+      // Update page title string\r
+      //\r
+      NewStringToken = STRING_TOKEN (STR_TITLE);\r
+      if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"Second, Select drivers for the previous selected controller", NULL) == 0) {\r
+        ASSERT (FALSE);\r
+      }\r
     }\r
-    UpdateBindingDriverSelectPage (Private, KeyValue, FakeNvData);\r
-    //\r
-    // Update page title string\r
-    //\r
-    NewStringToken = STRING_TOKEN (STR_TITLE);\r
-    if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"Second, Select drivers for the previous selected controller", NULL) == 0) {\r
-      ASSERT (FALSE);\r
+\r
+    if (KeyValue == KEY_VALUE_DRIVER_GOTO_ORDER) {\r
+      UpdatePrioritySelectPage (Private, KeyValue, FakeNvData);\r
+      //\r
+      // Update page title string\r
+      //\r
+      NewStringToken = STRING_TOKEN (STR_TITLE);\r
+      if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"Finally, Set the priority order for the drivers and save them", NULL) == 0) {\r
+        ASSERT (FALSE);\r
+      }\r
     }\r
-  }\r
 \r
-  if (KeyValue == KEY_VALUE_DRIVER_GOTO_ORDER) {\r
-    UpdatePrioritySelectPage (Private, KeyValue, FakeNvData);\r
-    //\r
-    // Update page title string\r
-    //\r
-    NewStringToken = STRING_TOKEN (STR_TITLE);\r
-    if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"Finally, Set the priority order for the drivers and save them", NULL) == 0) {\r
-      ASSERT (FALSE);\r
+    if (KeyValue == KEY_VALUE_DEVICE_CLEAR) {\r
+      //\r
+      // Deletes all environment variable(s) that contain the override mappings info\r
+      //\r
+      FreeMappingDatabase (&mMappingDataBase);\r
+      Status = SaveOverridesMapping (&mMappingDataBase);\r
+      UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
     }\r
-  }\r
+  } else if (Action == EFI_BROWSER_ACTION_CHANGED) {\r
+    switch (KeyValue) {\r
+    case KEY_VALUE_DEVICE_REFRESH:\r
+    case KEY_VALUE_DEVICE_FILTER:\r
+      UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
+      //\r
+      // Update page title string\r
+      //\r
+      NewStringToken = STRING_TOKEN (STR_TITLE);\r
+      if (HiiSetString (Private->RegisteredHandle, NewStringToken, L"First, Select the controller by device path", NULL) == 0) {\r
+        ASSERT (FALSE);\r
+      }\r
+    break;\r
+    \r
+    case KEY_VALUE_ORDER_SAVE_AND_EXIT:\r
+      Status = CommintChanges (Private, KeyValue, FakeNvData);\r
+      *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
+      if (EFI_ERROR (Status)) {\r
+        CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Single Override Info too large, Saving Error!", NULL);\r
+        return EFI_DEVICE_ERROR;\r
+      }\r
+    break;\r
 \r
-  if (KeyValue == KEY_VALUE_ORDER_SAVE_AND_EXIT) {\r
-    Status = CommintChanges (Private, KeyValue, FakeNvData);\r
-    *ActionRequest = EFI_BROWSER_ACTION_REQUEST_SUBMIT;\r
-    if (EFI_ERROR (Status)) {\r
-      CreatePopUp (EFI_LIGHTGRAY | EFI_BACKGROUND_BLUE, &Key, L"Single Override Info too large, Saving Error!", NULL);\r
-      return EFI_DEVICE_ERROR;\r
+    default:\r
+    break;\r
     }\r
   }\r
 \r
-  if (KeyValue == KEY_VALUE_DEVICE_CLEAR) {\r
-    //\r
-    // Deletes all environment variable(s) that contain the override mappings info\r
-    //\r
-    FreeMappingDatabase (&mMappingDataBase);\r
-    Status = SaveOverridesMapping (&mMappingDataBase);\r
-    UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
-  }\r
   //\r
   // Pass changed uncommitted data back to Form Browser\r
   //\r
-  HiiSetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData, NULL);\r
-  \r
-  //\r
-  // Update local configuration buffer.\r
-  //\r
-  CopyMem (&Private->FakeNvData, FakeNvData, sizeof (PLAT_OVER_MNGR_DATA));\r
-  if (FakeNvData != NULL) {\r
-    FreePool (FakeNvData);\r
-  }\r
+  HiiSetBrowserData (&gPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData, NULL);\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -1373,10 +1449,9 @@ PlatOverMngrCallback (
                                  returned in DriverImageHandle.\r
   @retval EFI_NOT_FOUND          A driver override for ControllerHandle was not\r
                                  found.\r
-  @retval EFI_INVALID_PARAMETER  The handle specified by ControllerHandle is not a\r
-                                 valid handle. DriverImageHandle is not a handle\r
-                                 that was returned on a previous  call to\r
-                                 GetDriver().\r
+  @retval EFI_INVALID_PARAMETER  The handle specified by ControllerHandle is NULL.\r
+                                 DriverImageHandle is not a handle that was returned\r
+                                 on a previous  call to GetDriver().\r
 \r
 **/\r
 EFI_STATUS\r
@@ -1569,7 +1644,7 @@ PlatDriOverrideDxeInit (
   // Publish our HII data\r
   //\r
   mCallbackInfo->RegisteredHandle = HiiAddPackages (\r
-                                     &mPlatformOverridesManagerGuid,\r
+                                     &gPlatformOverridesManagerGuid,\r
                                      mCallbackInfo->DriverHandle,\r
                                      VfrBin,\r
                                      PlatDriOverrideDxeStrings,\r
@@ -1605,26 +1680,7 @@ PlatDriOverrideDxeInit (
   return EFI_SUCCESS;\r
 \r
 Finish:\r
-  if (mCallbackInfo->DriverHandle != NULL) {\r
-    gBS->UninstallMultipleProtocolInterfaces (\r
-           mCallbackInfo->DriverHandle,\r
-           &gEfiDevicePathProtocolGuid,\r
-           &mHiiVendorDevicePath,\r
-           &gEfiHiiConfigAccessProtocolGuid,\r
-           &mCallbackInfo->ConfigAccess,\r
-           &gEfiPlatformDriverOverrideProtocolGuid,\r
-           &mCallbackInfo->PlatformDriverOverride,\r
-           NULL\r
-           );\r
-  }\r
-  \r
-  if (mCallbackInfo->RegisteredHandle != NULL) {\r
-    HiiRemovePackages (mCallbackInfo->RegisteredHandle);\r
-  }\r
-\r
-  if (mCallbackInfo != NULL) {\r
-    FreePool (mCallbackInfo);\r
-  }\r
+  PlatDriOverrideDxeUnload (ImageHandle);\r
 \r
   return Status;\r
 }\r
@@ -1642,6 +1698,8 @@ PlatDriOverrideDxeUnload (
   IN EFI_HANDLE  ImageHandle\r
   )\r
 {\r
+  ASSERT (mCallbackInfo != NULL);\r
+\r
   if (mCallbackInfo->DriverHandle != NULL) {\r
     gBS->UninstallMultipleProtocolInterfaces (\r
            mCallbackInfo->DriverHandle,\r
@@ -1659,9 +1717,7 @@ PlatDriOverrideDxeUnload (
     HiiRemovePackages (mCallbackInfo->RegisteredHandle);\r
   }\r
 \r
-  if (mCallbackInfo != NULL) {\r
-    FreePool (mCallbackInfo);\r
-  }\r
+  FreePool (mCallbackInfo);\r
 \r
   return EFI_SUCCESS;\r
 }\r