]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c
Fix the comments to follow UEFI Spec regarding how to check an EFI_HANDLE is valid...
[mirror_edk2.git] / MdeModulePkg / Universal / PlatformDriOverrideDxe / PlatDriOverrideDxe.c
index 2c1d9d96c5a4634de4885ef13d60e2025e78afe8..2a684c99dd0f8da79df72ae53b2c86ed8b8056fd 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
@@ -661,7 +661,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
@@ -1145,7 +1145,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 +1161,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, &mPlatformOverridesManagerGuid, 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 (&mPlatformOverridesManagerGuid, 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,10 +1258,23 @@ PlatOverMngrRouteConfig (
   UINT16                                    KeyValue;\r
   PLAT_OVER_MNGR_DATA                       *FakeNvData;\r
 \r
+  if (Configuration == NULL || Progress == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  *Progress = Configuration;\r
+\r
+  if (!HiiIsConfigHdrMatch (Configuration, &mPlatformOverridesManagerGuid, 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 (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData)) {\r
-    return EFI_NOT_FOUND;\r
+  if (!HiiGetBrowserData (&mPlatformOverridesManagerGuid, 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
@@ -1273,75 +1334,82 @@ PlatOverMngrCallback (
   EFI_STRING_ID                             NewStringToken;\r
   EFI_INPUT_KEY                             Key;\r
   PLAT_OVER_MNGR_DATA                       *FakeNvData;\r
-  \r
-  Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
-  FakeNvData = &Private->FakeNvData;\r
-  if (HiiGetBrowserData (&mPlatformOverridesManagerGuid, 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
+    Private = EFI_CALLBACK_INFO_FROM_THIS (This);\r
+    FakeNvData = &Private->FakeNvData;\r
+    if (!HiiGetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData)) {\r
+      return EFI_NOT_FOUND;\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_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
+      }\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_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
-  }\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_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_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
+    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
+      }\r
     }\r
-  }\r
 \r
-  if (KeyValue == KEY_VALUE_DEVICE_CLEAR) {\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
-    // Deletes all environment variable(s) that contain the override mappings info\r
+    // Pass changed uncommitted data back to Form Browser\r
     //\r
-    FreeMappingDatabase (&mMappingDataBase);\r
-    Status = SaveOverridesMapping (&mMappingDataBase);\r
-    UpdateDeviceSelectPage (Private, KeyValue, FakeNvData);\r
-  }\r
+    HiiSetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData, NULL);\r
+\r
+    return EFI_SUCCESS;\r
+  } \r
+\r
   //\r
-  // Pass changed uncommitted data back to Form Browser\r
+  // All other action return unsupported.\r
   //\r
-  HiiSetBrowserData (&mPlatformOverridesManagerGuid, mVariableName, sizeof (PLAT_OVER_MNGR_DATA), (UINT8 *) FakeNvData, NULL);\r
-\r
-  return EFI_SUCCESS;\r
+  return EFI_UNSUPPORTED;\r
 }\r
 \r
 /**\r
@@ -1361,10 +1429,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
@@ -1593,26 +1660,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
@@ -1630,6 +1678,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
@@ -1647,9 +1697,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