Fix bug in unload function: Check if component name protocol exist, only uninstall it when it really exists.

Signed-off-by: Fu Siyuan <siyuan.fu@intel.com>
Reviewed-by: Tian, Feng <feng.tian@intel.com>
Reviewed-by: Jin, Eric <eric.jin@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15092 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 171 insertions, 24 deletions

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
index f4663d9..b389610 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
@@ -1,7 +1,7 @@
 /** @file

   The entry point of IScsi driver.

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -439,10 +439,12 @@ EfiIScsiUnload (
   IN EFI_HANDLE  ImageHandle

   )

 {

-  EFI_STATUS  Status;

-  UINTN       DeviceHandleCount;

-  EFI_HANDLE  *DeviceHandleBuffer;

-  UINTN       Index;

+  EFI_STATUS                        Status;

+  UINTN                             DeviceHandleCount;

+  EFI_HANDLE                        *DeviceHandleBuffer;

+  UINTN                             Index;

+  EFI_COMPONENT_NAME_PROTOCOL       *ComponentName;

+  EFI_COMPONENT_NAME2_PROTOCOL      *ComponentName2;

 

   //

   // Try to disonnect the driver from the devices it's controlling.

@@ -454,40 +456,89 @@ EfiIScsiUnload (
                   &DeviceHandleCount,

                   &DeviceHandleBuffer

                   );

-  if (!EFI_ERROR (Status)) {

-    for (Index = 0; Index < DeviceHandleCount; Index++) {

-      Status = gBS->DisconnectController (

-                      DeviceHandleBuffer[Index],

-                      ImageHandle,

-                      NULL

-                      );

-    }

+  if (EFI_ERROR (Status)) {

+    return Status;

+  }

 

-    if (DeviceHandleBuffer != NULL) {

-      FreePool (DeviceHandleBuffer);

+  for (Index = 0; Index < DeviceHandleCount; Index++) {

+    Status = IScsiTestManagedDevice (

+               DeviceHandleBuffer[Index],

+               gIScsiDriverBinding.DriverBindingHandle,

+               &gEfiTcp4ProtocolGuid

+               );

+    if (EFI_ERROR (Status)) {

+      continue;

     }

-  }

+    Status = gBS->DisconnectController (

+                    DeviceHandleBuffer[Index],

+                    gIScsiDriverBinding.DriverBindingHandle,

+                    NULL

+                    );

+    if (EFI_ERROR (Status)) {

+      goto ON_EXIT;

+    }

+  }  

+

   //

   // Unload the iSCSI configuration form.

   //

-  IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);

+  Status = IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);

+  if (EFI_ERROR (Status)) {

+    goto ON_EXIT;

+  }

 

   //

-  // Uninstall the protocols installed by iSCSI driver.

+  // Uninstall the ComponentName and ComponentName2 protocol from iSCSI4 driver binding handle

+  // if it has been installed.

   //

+  Status = gBS->HandleProtocol (

+                  gIScsiDriverBinding.DriverBindingHandle,

+                  &gEfiComponentNameProtocolGuid,

+                  (VOID **) &ComponentName

+                  );

+  if (!EFI_ERROR (Status)) {

+    Status = gBS->UninstallMultipleProtocolInterfaces (

+           gIScsiDriverBinding.DriverBindingHandle,

+           &gEfiComponentNameProtocolGuid,

+           ComponentName,

+           NULL

+           );

+    if (EFI_ERROR (Status)) {

+      goto ON_EXIT;

+    }

+  }

+  

+  Status = gBS->HandleProtocol (

+                  gIScsiDriverBinding.DriverBindingHandle,

+                  &gEfiComponentName2ProtocolGuid,

+                  (VOID **) &ComponentName2

+                  );

+  if (!EFI_ERROR (Status)) {

+    gBS->UninstallMultipleProtocolInterfaces (

+           gIScsiDriverBinding.DriverBindingHandle,

+           &gEfiComponentName2ProtocolGuid,

+           ComponentName2,

+           NULL

+           );

+    if (EFI_ERROR (Status)) {

+      goto ON_EXIT;

+    }

+  }

+

   Status = gBS->UninstallMultipleProtocolInterfaces (

                   ImageHandle,

                   &gEfiDriverBindingProtocolGuid,

                   &gIScsiDriverBinding,

-                  &gEfiComponentName2ProtocolGuid,

-                  &gIScsiComponentName2,

-                  &gEfiComponentNameProtocolGuid,

-                  &gIScsiComponentName,

                   &gEfiIScsiInitiatorNameProtocolGuid,

                   &gIScsiInitiatorName,

                   NULL

                   );

+ON_EXIT:

 

+  if (DeviceHandleBuffer != NULL) {

+    FreePool (DeviceHandleBuffer);

+  }

+  

   return Status;

 }

 

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
index 2e43b41..a00d805 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
@@ -1,7 +1,7 @@
 /** @file

   Miscellaneous routines for iSCSI driver.

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -852,3 +852,70 @@ IScsiOnExitBootService (
 

   IScsiSessionAbort (&Private->Session);

 }

+

+/**

+  Tests whether a controller handle is being managed by IScsi driver.

+

+  This function tests whether the driver specified by DriverBindingHandle is

+  currently managing the controller specified by ControllerHandle.  This test

+  is performed by evaluating if the the protocol specified by ProtocolGuid is

+  present on ControllerHandle and is was opened by DriverBindingHandle and Nic

+  Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. 

+  If ProtocolGuid is NULL, then ASSERT().

+

+  @param  ControllerHandle     A handle for a controller to test.

+  @param  DriverBindingHandle  Specifies the driver binding handle for the

+                               driver.

+  @param  ProtocolGuid         Specifies the protocol that the driver specified

+                               by DriverBindingHandle opens in its Start()

+                               function.

+

+  @retval EFI_SUCCESS          ControllerHandle is managed by the driver

+                               specified by DriverBindingHandle.

+  @retval EFI_UNSUPPORTED      ControllerHandle is not managed by the driver

+                               specified by DriverBindingHandle.

+

+**/

+EFI_STATUS

+EFIAPI

+IScsiTestManagedDevice (

+  IN  EFI_HANDLE       ControllerHandle,

+  IN  EFI_HANDLE       DriverBindingHandle,

+  IN  EFI_GUID         *ProtocolGuid

+  )

+{

+  EFI_STATUS     Status;

+  VOID           *ManagedInterface;

+  EFI_HANDLE     NicControllerHandle;

+

+  ASSERT (ProtocolGuid != NULL);

+

+  NicControllerHandle = NetLibGetNicHandle (ControllerHandle, ProtocolGuid);

+  if (NicControllerHandle == NULL) {

+    return EFI_UNSUPPORTED;

+  }

+

+  Status = gBS->OpenProtocol (

+                  ControllerHandle,

+                  (EFI_GUID *) ProtocolGuid,

+                  &ManagedInterface,

+                  DriverBindingHandle,

+                  NicControllerHandle,

+                  EFI_OPEN_PROTOCOL_BY_DRIVER

+                  );

+  if (!EFI_ERROR (Status)) {

+    gBS->CloseProtocol (

+           ControllerHandle,

+           (EFI_GUID *) ProtocolGuid,

+           DriverBindingHandle,

+           NicControllerHandle

+           );

+    return EFI_UNSUPPORTED;

+  }

+

+  if (Status != EFI_ALREADY_STARTED) {

+    return EFI_UNSUPPORTED;

+  }

+

+  return EFI_SUCCESS;

+}

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
index b310c9c..052a90f 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
@@ -1,7 +1,7 @@
 /** @file

   Miscellaneous definitions for iSCSI driver.

 

-Copyright (c) 2004 - 2013, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -275,6 +275,35 @@ IScsiOnExitBootService (
   IN VOID       *Context

   );

 

+/**

+  Tests whether a controller handle is being managed by IScsi driver.

+

+  This function tests whether the driver specified by DriverBindingHandle is

+  currently managing the controller specified by ControllerHandle.  This test

+  is performed by evaluating if the the protocol specified by ProtocolGuid is

+  present on ControllerHandle and is was opened by DriverBindingHandle and Nic

+  Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER. 

+  If ProtocolGuid is NULL, then ASSERT().

+

+  @param  ControllerHandle     A handle for a controller to test.

+  @param  DriverBindingHandle  Specifies the driver binding handle for the

+                               driver.

+  @param  ProtocolGuid         Specifies the protocol that the driver specified

+                               by DriverBindingHandle opens in its Start()

+                               function.

+

+  @retval EFI_SUCCESS          ControllerHandle is managed by the driver

+                               specified by DriverBindingHandle.

+  @retval EFI_UNSUPPORTED      ControllerHandle is not managed by the driver

+                               specified by DriverBindingHandle.

 

+**/

+EFI_STATUS

+EFIAPI

+IScsiTestManagedDevice (

+  IN  EFI_HANDLE       ControllerHandle,

+  IN  EFI_HANDLE       DriverBindingHandle,

+  IN  EFI_GUID         *ProtocolGuid

+  );

 

 #endif