/** @file\r
The entry point of IScsi driver.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2014, 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
NULL\r
};\r
\r
-EFI_GUID mIScsiPrivateGuid = ISCSI_PRIVATE_GUID;\r
+/**\r
+ Tests to see if this driver supports the RemainingDevicePath. \r
+\r
+ @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
+ parameter is ignored by device drivers, and is optional for bus \r
+ drivers. For bus drivers, if this parameter is not NULL, then \r
+ the bus driver must determine if the bus controller specified \r
+ by ControllerHandle and the child controller specified \r
+ by RemainingDevicePath are both supported by this \r
+ bus driver.\r
+\r
+ @retval EFI_SUCCESS The RemainingDevicePath is supported or NULL.\r
+ @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
+ RemainingDevicePath is not supported by the driver specified by This.\r
+**/\r
+EFI_STATUS\r
+IScsiIsDevicePathSupported (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r
+ )\r
+{\r
+ EFI_DEVICE_PATH_PROTOCOL *CurrentDevicePath;\r
+\r
+ CurrentDevicePath = RemainingDevicePath;\r
+ if (CurrentDevicePath != NULL) {\r
+ while (!IsDevicePathEnd (CurrentDevicePath)) {\r
+ if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {\r
+ return EFI_SUCCESS;\r
+ }\r
\r
+ CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);\r
+ }\r
+\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
\r
/**\r
Tests to see if this driver supports a given controller. If a child device is provided, \r
)\r
{\r
EFI_STATUS Status;\r
- EFI_DEVICE_PATH_PROTOCOL *CurrentDevicePath;\r
\r
Status = gBS->OpenProtocol (\r
ControllerHandle,\r
- &mIScsiPrivateGuid,\r
+ &gEfiCallerIdGuid,\r
NULL,\r
This->DriverBindingHandle,\r
ControllerHandle,\r
return EFI_UNSUPPORTED;\r
}\r
\r
- CurrentDevicePath = RemainingDevicePath;\r
- if (CurrentDevicePath != NULL) {\r
- while (!IsDevicePathEnd (CurrentDevicePath)) {\r
- if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {\r
- return EFI_SUCCESS;\r
- }\r
+ Status = IScsiIsDevicePathSupported (RemainingDevicePath);\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
\r
- CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);\r
+ if (IScsiDhcpIsConfigured (ControllerHandle)) {\r
+ Status = gBS->OpenProtocol (\r
+ ControllerHandle,\r
+ &gEfiDhcp4ServiceBindingProtocolGuid,\r
+ NULL,\r
+ This->DriverBindingHandle,\r
+ ControllerHandle,\r
+ EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ return EFI_UNSUPPORTED;\r
}\r
-\r
- return EFI_UNSUPPORTED;\r
}\r
\r
return EFI_SUCCESS;\r
}\r
\r
/**\r
- Start this driver on ControllerHandle. The Start() function is designed to be \r
- invoked from the EFI boot service ConnectController(). As a result, much of \r
- the error checking on the parameters to Start() has been moved into this \r
- common boot service. It is legal to call Start() from other locations, \r
- but the following calling restrictions must be followed or the system behavior will not be deterministic.\r
+ Start this driver on ControllerHandle. \r
+ \r
+ The Start() function is designed to be invoked from the EFI boot service ConnectController(). \r
+ As a result, much of the error checking on the parameters to Start() has been moved into this \r
+ common boot service. It is legal to call Start() from other locations, but the following calling \r
+ restrictions must be followed or the system behavior will not be deterministic.\r
1. ControllerHandle must be a valid EFI_HANDLE.\r
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
EFI_DEVICE_PATH_PROTOCOL.\r
{\r
EFI_STATUS Status;\r
ISCSI_DRIVER_DATA *Private;\r
+ VOID *Interface;\r
+\r
+ Private = IScsiCreateDriverData (This->DriverBindingHandle, ControllerHandle);\r
+ if (Private == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ //\r
+ // Create a underlayer child instance, but not need to configure it. Just open ChildHandle\r
+ // via BY_DRIVER. That is, establishing the relationship between ControllerHandle and ChildHandle.\r
+ // Therefore, when DisconnectController(), especially VLAN virtual controller handle,\r
+ // IScsiDriverBindingStop() will be called.\r
+ //\r
+ Status = NetLibCreateServiceChild (\r
+ ControllerHandle,\r
+ This->DriverBindingHandle,\r
+ &gEfiTcp4ServiceBindingProtocolGuid,\r
+ &Private->ChildHandle\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
+\r
+ Status = gBS->OpenProtocol (\r
+ Private->ChildHandle,\r
+ &gEfiTcp4ProtocolGuid,\r
+ &Interface,\r
+ This->DriverBindingHandle,\r
+ ControllerHandle,\r
+ EFI_OPEN_PROTOCOL_BY_DRIVER\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
+\r
+ //\r
+ // Always install private protocol no matter what happens later. We need to \r
+ // keep the relationship between ControllerHandle and ChildHandle.\r
+ //\r
+ Status = gBS->InstallProtocolInterface (\r
+ &ControllerHandle,\r
+ &gEfiCallerIdGuid,\r
+ EFI_NATIVE_INTERFACE,\r
+ &Private->IScsiIdentifier\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
\r
//\r
// Try to add a port configuration page for this controller.\r
//\r
IScsiConfigUpdateForm (This->DriverBindingHandle, ControllerHandle, TRUE);\r
\r
- Private = IScsiCreateDriverData (This->DriverBindingHandle, ControllerHandle);\r
- if (Private == NULL) {\r
- return EFI_OUT_OF_RESOURCES;\r
- }\r
//\r
// Get the iSCSI configuration data of this controller.\r
//\r
if (EFI_ERROR (Status)) {\r
goto ON_ERROR;\r
}\r
- //\r
- // Install the iSCSI private stuff as a flag to indicate this controller\r
- // is already controlled by iSCSI driver.\r
- //\r
- Status = gBS->InstallProtocolInterface (\r
- &ControllerHandle,\r
- &mIScsiPrivateGuid,\r
- EFI_NATIVE_INTERFACE,\r
- &Private->IScsiIdentifier\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto ON_ERROR;\r
- }\r
+\r
//\r
// Update/Publish the iSCSI Boot Firmware Table.\r
//\r
ON_ERROR:\r
\r
IScsiSessionAbort (&Private->Session);\r
- IScsiCleanDriverData (Private);\r
\r
return Status;\r
}\r
IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
IN EFI_HANDLE ControllerHandle,\r
IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
+ IN EFI_HANDLE *ChildHandleBuffer OPTIONAL\r
)\r
{\r
EFI_HANDLE IScsiController;\r
\r
Status = gBS->OpenProtocol (\r
IScsiController,\r
- &mIScsiPrivateGuid,\r
+ &gEfiCallerIdGuid,\r
(VOID **)&IScsiIdentifier,\r
This->DriverBindingHandle,\r
ControllerHandle,\r
\r
Private = ISCSI_DRIVER_DATA_FROM_IDENTIFIER (IScsiIdentifier);\r
\r
+ if (Private->ChildHandle != NULL) {\r
+ Status = gBS->CloseProtocol (\r
+ Private->ChildHandle,\r
+ &gEfiTcp4ProtocolGuid,\r
+ This->DriverBindingHandle,\r
+ IScsiController\r
+ );\r
+\r
+ ASSERT (!EFI_ERROR (Status));\r
+\r
+ Status = NetLibDestroyServiceChild (\r
+ IScsiController,\r
+ This->DriverBindingHandle,\r
+ &gEfiTcp4ServiceBindingProtocolGuid,\r
+ Private->ChildHandle\r
+ );\r
+ ASSERT (!EFI_ERROR (Status));\r
+ }\r
+\r
+ IScsiConfigUpdateForm (This->DriverBindingHandle, IScsiController, FALSE);\r
+\r
//\r
// Uninstall the private protocol.\r
//\r
gBS->UninstallProtocolInterface (\r
IScsiController,\r
- &mIScsiPrivateGuid,\r
+ &gEfiCallerIdGuid,\r
&Private->IScsiIdentifier\r
);\r
\r
IN EFI_HANDLE ImageHandle\r
)\r
{\r
- EFI_STATUS Status;\r
- UINTN DeviceHandleCount;\r
- EFI_HANDLE *DeviceHandleBuffer;\r
- UINTN Index;\r
+ EFI_STATUS Status;\r
+ UINTN DeviceHandleCount;\r
+ EFI_HANDLE *DeviceHandleBuffer;\r
+ UINTN Index;\r
+ EFI_COMPONENT_NAME_PROTOCOL *ComponentName;\r
+ EFI_COMPONENT_NAME2_PROTOCOL *ComponentName2;\r
\r
//\r
// Try to disonnect the driver from the devices it's controlling.\r
&DeviceHandleCount,\r
&DeviceHandleBuffer\r
);\r
- if (!EFI_ERROR (Status)) {\r
- for (Index = 0; Index < DeviceHandleCount; Index++) {\r
- Status = gBS->DisconnectController (\r
- DeviceHandleBuffer[Index],\r
- ImageHandle,\r
- NULL\r
- );\r
- }\r
+ if (EFI_ERROR (Status)) {\r
+ return Status;\r
+ }\r
\r
- if (DeviceHandleBuffer != NULL) {\r
- gBS->FreePool (DeviceHandleBuffer);\r
+ for (Index = 0; Index < DeviceHandleCount; Index++) {\r
+ Status = IScsiTestManagedDevice (\r
+ DeviceHandleBuffer[Index],\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ &gEfiTcp4ProtocolGuid\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ continue;\r
}\r
- }\r
+ Status = gBS->DisconnectController (\r
+ DeviceHandleBuffer[Index],\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
+ } \r
+\r
//\r
// Unload the iSCSI configuration form.\r
//\r
- IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);\r
+ Status = IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
\r
//\r
- // Uninstall the protocols installed by iSCSI driver.\r
+ // Uninstall the ComponentName and ComponentName2 protocol from iSCSI4 driver binding handle\r
+ // if it has been installed.\r
//\r
+ Status = gBS->HandleProtocol (\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ &gEfiComponentNameProtocolGuid,\r
+ (VOID **) &ComponentName\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = gBS->UninstallMultipleProtocolInterfaces (\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ &gEfiComponentNameProtocolGuid,\r
+ ComponentName,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
+ }\r
+ \r
+ Status = gBS->HandleProtocol (\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ &gEfiComponentName2ProtocolGuid,\r
+ (VOID **) &ComponentName2\r
+ );\r
+ if (!EFI_ERROR (Status)) {\r
+ gBS->UninstallMultipleProtocolInterfaces (\r
+ gIScsiDriverBinding.DriverBindingHandle,\r
+ &gEfiComponentName2ProtocolGuid,\r
+ ComponentName2,\r
+ NULL\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_EXIT;\r
+ }\r
+ }\r
+\r
Status = gBS->UninstallMultipleProtocolInterfaces (\r
ImageHandle,\r
&gEfiDriverBindingProtocolGuid,\r
&gIScsiDriverBinding,\r
- &gEfiComponentName2ProtocolGuid,\r
- &gIScsiComponentName2,\r
- &gEfiComponentNameProtocolGuid,\r
- &gIScsiComponentName,\r
&gEfiIScsiInitiatorNameProtocolGuid,\r
&gIScsiInitiatorName,\r
NULL\r
);\r
+ON_EXIT:\r
\r
+ if (DeviceHandleBuffer != NULL) {\r
+ FreePool (DeviceHandleBuffer);\r
+ }\r
+ \r
return Status;\r
}\r
\r