Fix a bug about the iSCSI DHCP dependency issue.

Create rules to determine whether iSCSI need DHCP protocol in current configuration by examining user’s configuration data in DriverBindingSupported().

Signed-off-by: Wu Jiaxin <jiaxin.wu@intel.com >
Reviewed-by: Ye Ting <ting.ye@intel.com>
Reviewed-by: Fu Siyuan <siyuan.fu@intel.com>

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

3 files changed, 125 insertions, 14 deletions

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.c
index f668fe3d9c..f4663d9f59 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 - 2011, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2013, 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

@@ -24,6 +24,44 @@ EFI_DRIVER_BINDING_PROTOCOL gIScsiDriverBinding = {
 };

 

 /**

+  Tests to see if this driver supports the RemainingDevicePath. 

+

+  @param[in]  RemainingDevicePath  A pointer to the remaining portion of a device path.  This 

+                                   parameter is ignored by device drivers, and is optional for bus 

+                                   drivers. For bus drivers, if this parameter is not NULL, then 

+                                   the bus driver must determine if the bus controller specified 

+                                   by ControllerHandle and the child controller specified 

+                                   by RemainingDevicePath are both supported by this 

+                                   bus driver.

+

+  @retval EFI_SUCCESS              The RemainingDevicePath is supported or NULL.

+  @retval EFI_UNSUPPORTED          The device specified by ControllerHandle and

+                                   RemainingDevicePath is not supported by the driver specified by This.

+**/

+EFI_STATUS

+IScsiIsDevicePathSupported (

+  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL

+  )

+{

+  EFI_DEVICE_PATH_PROTOCOL  *CurrentDevicePath;

+

+  CurrentDevicePath = RemainingDevicePath;

+  if (CurrentDevicePath != NULL) {

+    while (!IsDevicePathEnd (CurrentDevicePath)) {

+      if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {

+        return EFI_SUCCESS;

+      }

+

+      CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);

+    }

+

+    return EFI_UNSUPPORTED;

+  }

+

+  return EFI_SUCCESS;

+}

+

+/**

   Tests to see if this driver supports a given controller. If a child device is provided, 

   it further tests to see if this driver supports creating a handle for the specified child device.

 

@@ -56,7 +94,6 @@ IScsiDriverBindingSupported (
   )

 {

   EFI_STATUS                Status;

-  EFI_DEVICE_PATH_PROTOCOL  *CurrentDevicePath;

 

   Status = gBS->OpenProtocol (

                   ControllerHandle,

@@ -82,17 +119,23 @@ IScsiDriverBindingSupported (
     return EFI_UNSUPPORTED;

   }

 

-  CurrentDevicePath = RemainingDevicePath;

-  if (CurrentDevicePath != NULL) {

-    while (!IsDevicePathEnd (CurrentDevicePath)) {

-      if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {

-        return EFI_SUCCESS;

-      }

+  Status = IScsiIsDevicePathSupported (RemainingDevicePath);

+  if (EFI_ERROR (Status)) {

+    return EFI_UNSUPPORTED;

+  }

 

-      CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);

+  if (IScsiDhcpIsConfigured (ControllerHandle)) {

+    Status = gBS->OpenProtocol (

+                    ControllerHandle,

+                    &gEfiDhcp4ServiceBindingProtocolGuid,

+                    NULL,

+                    This->DriverBindingHandle,

+                    ControllerHandle,

+                    EFI_OPEN_PROTOCOL_TEST_PROTOCOL

+                    );

+    if (EFI_ERROR (Status)) {

+      return EFI_UNSUPPORTED;

     }

-

-    return EFI_UNSUPPORTED;

   }

 

   return EFI_SUCCESS;

@@ -170,7 +213,7 @@ IScsiDriverBindingStart (
     goto ON_ERROR;

   }

 

-  //
+  //

   // Always install private protocol no matter what happens later. We need to 

   // keep the relationship between ControllerHandle and ChildHandle.

   //

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
index 5341e5a01e..16ffec09bd 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 - 2011, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2013, 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

@@ -617,6 +617,60 @@ IScsiCleanDriverData (
 }

 

 /**

+  Check wheather the Controller is configured to use DHCP protocol.

+

+  @param[in]  Controller           The handle of the controller.

+  

+  @retval TRUE                     The handle of the controller need the Dhcp protocol.

+  @retval FALSE                    The handle of the controller does not need the Dhcp protocol.

+  

+**/

+BOOLEAN

+IScsiDhcpIsConfigured (

+  IN EFI_HANDLE  Controller

+  )

+{

+  EFI_STATUS                  Status;

+  EFI_MAC_ADDRESS             MacAddress;

+  UINTN                       HwAddressSize;

+  UINT16                      VlanId;

+  CHAR16                      MacString[70];

+  ISCSI_SESSION_CONFIG_NVDATA *ConfigDataTmp;

+

+  //

+  // Get the mac string, it's the name of various variable

+  //

+  Status = NetLibGetMacAddress (Controller, &MacAddress, &HwAddressSize);

+  if (EFI_ERROR (Status)) {

+    return FALSE;

+  }

+  VlanId = NetLibGetVlanId (Controller);

+  IScsiMacAddrToStr (&MacAddress, (UINT32) HwAddressSize, VlanId, MacString);

+

+  //

+  // Get the normal configuration.

+  //

+  Status = GetVariable2 (

+             MacString,

+             &gEfiIScsiInitiatorNameProtocolGuid,

+             (VOID**)&ConfigDataTmp,

+             NULL

+             );

+  if (EFI_ERROR (Status)) {

+    return FALSE;

+  }

+  

+

+  if (ConfigDataTmp->Enabled && ConfigDataTmp->InitiatorInfoFromDhcp) {

+    FreePool (ConfigDataTmp);

+    return TRUE;

+  }

+

+  FreePool (ConfigDataTmp);

+  return FALSE;

+}

+

+/**

   Get the various configuration data of this iSCSI instance.

 

   @param[in]  Private   The iSCSI driver data.

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.h
index 512c67c38c..b310c9c579 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 - 2011, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2004 - 2013, 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

@@ -222,6 +222,20 @@ IScsiCleanDriverData (
   );

 

 /**

+  Check wheather the Controller is configured to use DHCP protocol.

+

+  @param[in]  Controller           The handle of the controller.

+  

+  @retval TRUE                     The handle of the controller need the Dhcp protocol.

+  @retval FALSE                    The handle of the controller does not need the Dhcp protocol.

+  

+**/

+BOOLEAN

+IScsiDhcpIsConfigured (

+  IN EFI_HANDLE  Controller

+  );

+

+/**

   Get the various configuration data of this iSCSI instance.

 

   @param[in]  Private   The iSCSI driver data.