Fix the comments to follow UEFI Spec regarding how to check an EFI_HANDLE is valid...

[mirror_edk2.git] / MdeModulePkg / Universal / PlatformDriOverrideDxe / PlatDriOverrideDxe.c

diff --git a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c
index 1e5481ef725e6311cb6018fb82692daa1ece6432..2a684c99dd0f8da79df72ae53b2c86ed8b8056fd 100644 (file)
--- a/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c
+++ b/MdeModulePkg/Universal/PlatformDriOverrideDxe/PlatDriOverrideDxe.c
@@ -13,7 +13,7 @@
   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 - 2010, Intel Corporation. All rights reserved.<BR>\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
@@ -1334,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
@@ -1422,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