[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiDriver.c

/** @file\r
  The entry point of IScsi driver\r
\r
Copyright (c) 2004 - 2008, Intel Corporation\r
All rights reserved. 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
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  IScsiDriver.c\r
\r
Abstract:\r
  The entry point of IScsi driver\r
\r
**/\r
\r
#include "IScsiImpl.h"\r
\r
EFI_DRIVER_BINDING_PROTOCOL gIScsiDriverBinding = {\r
  IScsiDriverBindingSupported,\r
  IScsiDriverBindingStart,\r
  IScsiDriverBindingStop,\r
  0xa,\r
  NULL,\r
  NULL\r
};\r
\r
EFI_GUID                    mIScsiPrivateGuid   = ISCSI_PRIVATE_GUID;\r
\r
/**\r
  Test to see if IScsi driver supports the given controller. \r
\r
  @param  This[in]                Protocol instance pointer.\r
\r
  @param  ControllerHandle[in]    Handle of controller to test.\r
\r
  @param  RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
\r
  @retval EFI_SUCCES              This driver supports the controller.\r
\r
  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
\r
  @retval EFI_UNSUPPORTED         This driver doesn't support the controller.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiDriverBindingSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS                Status;\r
  EFI_DEVICE_PATH_PROTOCOL  *CurrentDevicePath;\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &mIScsiPrivateGuid,\r
                  NULL,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiTcp4ServiceBindingProtocolGuid,\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
  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
  Start to manage the controller. \r
\r
  @param  This[in]                Protocol instance pointer.\r
\r
  @param  ControllerHandle[in]    Handle of the controller.\r
\r
  @param  RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
\r
  @retval EFI_SUCCES              This driver supports this device.\r
\r
  @retval EFI_ALREADY_STARTED     This driver is already running on this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiDriverBindingStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
  )\r
{\r
  EFI_STATUS        Status;\r
  ISCSI_DRIVER_DATA *Private;\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
  Status = IScsiGetConfigData (Private);\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
  //\r
  // Try to login and create an iSCSI session according to the configuration.\r
  //\r
  Status = IScsiSessionLogin (Private);\r
  if (Status == EFI_MEDIA_CHANGED) {\r
    //\r
    // The specified target is not available and the redirection information is\r
    // got, login the session again with the updated target address.\r
    //\r
    Status = IScsiSessionLogin (Private);\r
  }\r
\r
  if (EFI_ERROR (Status)) {\r
    goto ON_ERROR;\r
  }\r
  //\r
  // Duplicate the Session's tcp connection device path. The source port field\r
  // will be set to zero as one iSCSI session is comprised of several iSCSI\r
  // connections.\r
  //\r
  Private->DevicePath = IScsiGetTcpConnDevicePath (Private);\r
  if (Private->DevicePath == NULL) {\r
    goto ON_ERROR;\r
  }\r
  //\r
  // Install the updated device path onto the ExtScsiPassThruHandle.\r
  //\r
  Status = gBS->InstallProtocolInterface (\r
                  &Private->ExtScsiPassThruHandle,\r
                  &gEfiDevicePathProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  Private->DevicePath\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
  // Update/Publish the iSCSI Boot Firmware Table.\r
  //\r
  IScsiPublishIbft ();\r
\r
  return EFI_SUCCESS;\r
\r
ON_ERROR:\r
\r
  IScsiSessionAbort (&Private->Session);\r
  IScsiCleanDriverData (Private);\r
\r
  return Status;\r
}\r
\r
/**\r
  Release the control of this controller and remove the IScsi functions.\r
\r
  @param  This[in]              Protocol instance pointer.\r
\r
  @param  ControllerHandle[in]  Handle of controller to stop.\r
\r
  @param  NumberOfChildren[in]  Not used.\r
\r
  @param  ChildHandleBuffer[in] Not used.\r
\r
  @retval EFI_SUCCES            This driver supports this device.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiDriverBindingStop (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   ControllerHandle,\r
  IN UINTN                        NumberOfChildren,\r
  IN EFI_HANDLE                   *ChildHandleBuffer\r
  )\r
{\r
  EFI_HANDLE                      IScsiController;\r
  EFI_STATUS                      Status;\r
  ISCSI_PRIVATE_PROTOCOL          *IScsiIdentifier;\r
  ISCSI_DRIVER_DATA               *Private;\r
  EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r
  ISCSI_CONNECTION                *Conn;\r
\r
  if (NumberOfChildren != 0) {\r
    //\r
    // We should have only one child.\r
    //\r
    Status = gBS->OpenProtocol (\r
                    ChildHandleBuffer[0],\r
                    &gEfiExtScsiPassThruProtocolGuid,\r
                    (VOID **) &PassThru,\r
                    This->DriverBindingHandle,\r
                    ControllerHandle,\r
                    EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      return EFI_DEVICE_ERROR;\r
    }\r
\r
    Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);\r
    Conn    = NET_LIST_HEAD (&Private->Session.Conns, ISCSI_CONNECTION, Link);\r
\r
    //\r
    // Previously the TCP4 protocol is opened BY_CHILD_CONTROLLER. Just close\r
    // the protocol here but not uninstall the device path protocol and\r
    // EXT SCSI PASS THRU protocol installed on ExtScsiPassThruHandle.\r
    //\r
    gBS->CloseProtocol (\r
          Conn->Tcp4Io.Handle,\r
          &gEfiTcp4ProtocolGuid,\r
          Private->Image,\r
          Private->ExtScsiPassThruHandle\r
          );\r
\r
    return EFI_SUCCESS;\r
  }\r
  //\r
  // Get the handle of the controller we are controling.\r
  //\r
  IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);\r
\r
  Status = gBS->OpenProtocol (\r
                  IScsiController,\r
                  &mIScsiPrivateGuid,\r
                  (VOID **)&IScsiIdentifier,\r
                  This->DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  Private = ISCSI_DRIVER_DATA_FROM_IDENTIFIER (IScsiIdentifier);\r
\r
  //\r
  // Uninstall the private protocol.\r
  //\r
  gBS->UninstallProtocolInterface (\r
        IScsiController,\r
        &mIScsiPrivateGuid,\r
        &Private->IScsiIdentifier\r
        );\r
\r
  //\r
  // Update the iSCSI Boot Firware Table.\r
  //\r
  IScsiPublishIbft ();\r
\r
  IScsiSessionAbort (&Private->Session);\r
  IScsiCleanDriverData (Private);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Unload the iSCSI driver.\r
\r
  @param  ImageHandle[in]  The handle of the driver image.\r
\r
  @retval EFI_SUCCESS      The driver is unloaded.\r
\r
  @retval EFI_DEVICE_ERROR Some unexpected error happened.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
EfiIScsiUnload (\r
  IN EFI_HANDLE  ImageHandle\r
  )\r
{\r
  EFI_STATUS  Status;\r
  UINTN       DeviceHandleCount;\r
  EFI_HANDLE  *DeviceHandleBuffer;\r
  UINTN       Index;\r
\r
  //\r
  // Try to disonnect the driver from the devices it's controlling.\r
  //\r
  Status = gBS->LocateHandleBuffer (\r
                  AllHandles,\r
                  NULL,\r
                  NULL,\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
\r
    if (DeviceHandleBuffer != NULL) {\r
      gBS->FreePool (DeviceHandleBuffer);\r
    }\r
  }\r
  //\r
  // Unload the iSCSI configuration form.\r
  //\r
  IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);\r
\r
  //\r
  // Uninstall the protocols installed by iSCSI driver.\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
\r
  return Status;\r
}\r
\r
/**\r
  Initialize the global variables publish the driver binding protocol.\r
\r
  @param  ImageHandle[in]  The handle of the driver image.\r
\r
  @param  SystemTable[in]  The EFI system table.\r
\r
  @retval EFI_SUCCESS      The protocols are installed.\r
\r
  @retval EFI_DEVICE_ERROR Some unexpected error happened.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IScsiDriverEntryPoint (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  )\r
{\r
  EFI_STATUS                         Status;\r
  EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *IScsiInitiatorName;\r
\r
  //\r
  // There should be only one EFI_ISCSI_INITIATOR_NAME_PROTOCOL.\r
  //\r
  Status = gBS->LocateProtocol (\r
                   &gEfiIScsiInitiatorNameProtocolGuid,\r
                   NULL,\r
                   (VOID**) &IScsiInitiatorName\r
                   );\r
\r
  if (!EFI_ERROR (Status)) {\r
    return EFI_ACCESS_DENIED;\r
  }\r
\r
  //\r
  // Initialize the EFI Driver Library\r
  //\r
  Status = EfiLibInstallDriverBindingComponentName2 (\r
             ImageHandle,\r
             SystemTable,\r
             &gIScsiDriverBinding,\r
             ImageHandle,\r
             &gIScsiComponentName,\r
             &gIScsiComponentName2\r
           );\r
\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Install the iSCSI Initiator Name Protocol.\r
    //\r
    Status = gBS->InstallProtocolInterface (\r
                    &ImageHandle,\r
                    &gEfiIScsiInitiatorNameProtocolGuid,\r
                    EFI_NATIVE_INTERFACE,\r
                    &gIScsiInitiatorName\r
                    );\r
    if (EFI_ERROR (Status)) {\r
      gBS->UninstallMultipleProtocolInterfaces (\r
            ImageHandle,\r
            &gEfiDriverBindingProtocolGuid,\r
            &gIScsiDriverBinding,\r
            &gEfiComponentName2ProtocolGuid,\r
            &gIScsiComponentName2,\r
            &gEfiComponentNameProtocolGuid,\r
            &gIScsiComponentName,\r
            NULL\r
            );\r
      return Status;\r
    }\r
  \r
    //\r
    // Initialize the configuration form of iSCSI.\r
    //\r
    Status = IScsiConfigFormInit (gIScsiDriverBinding.DriverBindingHandle);\r
    if (EFI_ERROR (Status)) {\r
      gBS->UninstallMultipleProtocolInterfaces (\r
            ImageHandle,\r
            &gEfiDriverBindingProtocolGuid,\r
            &gIScsiDriverBinding,\r
            &gEfiComponentName2ProtocolGuid,\r
            &gIScsiComponentName2,\r
            &gEfiComponentNameProtocolGuid,\r
            &gIScsiComponentName,\r
            &gEfiIScsiInitiatorNameProtocolGuid,\r
            &gIScsiInitiatorName,\r
            NULL\r
            );\r
    }\r
  }\r
  return Status;\r
}\r
\r
Commit	Line	Data
12618416	1	/** @file\r
12618416	2	The entry point of IScsi driver\r
6a690e23	3	\r
f2a94e25	4	Copyright (c) 2004 - 2008, Intel Corporation\r
7a444476	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
6a690e23	12	\r
	13	Module Name:\r
	14	\r
	15	IScsiDriver.c\r
	16	\r
	17	Abstract:\r
12618416	18	The entry point of IScsi driver\r
6a690e23	19	\r
12618416	20	**/\r
6a690e23	21	\r
	22	#include "IScsiImpl.h"\r
	23	\r
	24	EFI_DRIVER_BINDING_PROTOCOL gIScsiDriverBinding = {\r
	25	IScsiDriverBindingSupported,\r
	26	IScsiDriverBindingStart,\r
	27	IScsiDriverBindingStop,\r
	28	0xa,\r
	29	NULL,\r
	30	NULL\r
	31	};\r
	32	\r
	33	EFI_GUID mIScsiPrivateGuid = ISCSI_PRIVATE_GUID;\r
	34	\r
12618416	35	/**\r
12618416	36	Test to see if IScsi driver supports the given controller. \r
6a690e23	37	\r
12618416	38	@param This[in] Protocol instance pointer.\r
6a690e23	39	\r
12618416	40	@param ControllerHandle[in] Handle of controller to test.\r
6a690e23	41	\r
12618416	42	@param RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
6a690e23	43	\r
12618416	44	@retval EFI_SUCCES This driver supports the controller.\r
6a690e23	45	\r
12618416	46	@retval EFI_ALREADY_STARTED This driver is already running on this device.\r
6a690e23	47	\r
12618416	48	@retval EFI_UNSUPPORTED This driver doesn't support the controller.\r
6a690e23	49	\r
12618416	50	**/\r
	51	EFI_STATUS\r
	52	EFIAPI\r
	53	IScsiDriverBindingSupported (\r
	54	IN EFI_DRIVER_BINDING_PROTOCOL * This,\r
	55	IN EFI_HANDLE ControllerHandle,\r
	56	IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
	57	)\r
6a690e23	58	{\r
	59	EFI_STATUS Status;\r
	60	EFI_DEVICE_PATH_PROTOCOL *CurrentDevicePath;\r
	61	\r
	62	Status = gBS->OpenProtocol (\r
	63	ControllerHandle,\r
	64	&mIScsiPrivateGuid,\r
	65	NULL,\r
	66	This->DriverBindingHandle,\r
	67	ControllerHandle,\r
	68	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	69	);\r
	70	if (!EFI_ERROR (Status)) {\r
	71	return EFI_ALREADY_STARTED;\r
	72	}\r
	73	\r
	74	Status = gBS->OpenProtocol (\r
	75	ControllerHandle,\r
	76	&gEfiTcp4ServiceBindingProtocolGuid,\r
	77	NULL,\r
	78	This->DriverBindingHandle,\r
	79	ControllerHandle,\r
	80	EFI_OPEN_PROTOCOL_TEST_PROTOCOL\r
	81	);\r
	82	if (EFI_ERROR (Status)) {\r
	83	return EFI_UNSUPPORTED;\r
	84	}\r
	85	\r
	86	CurrentDevicePath = RemainingDevicePath;\r
	87	if (CurrentDevicePath != NULL) {\r
	88	while (!IsDevicePathEnd (CurrentDevicePath)) {\r
	89	if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {\r
	90	return EFI_SUCCESS;\r
	91	}\r
	92	\r
	93	CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);\r
	94	}\r
	95	\r
	96	return EFI_UNSUPPORTED;\r
	97	}\r
	98	\r
	99	return EFI_SUCCESS;\r
	100	}\r
	101	\r
12618416	102	/**\r
	103	Start to manage the controller. \r
	104	\r
	105	@param This[in] Protocol instance pointer.\r
	106	\r
	107	@param ControllerHandle[in] Handle of the controller.\r
	108	\r
	109	@param RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.\r
	110	\r
	111	@retval EFI_SUCCES This driver supports this device.\r
	112	\r
	113	@retval EFI_ALREADY_STARTED This driver is already running on this device.\r
	114	\r
	115	**/\r
6a690e23	116	EFI_STATUS\r
	117	EFIAPI\r
	118	IScsiDriverBindingStart (\r
	119	IN EFI_DRIVER_BINDING_PROTOCOL * This,\r
	120	IN EFI_HANDLE ControllerHandle,\r
	121	IN EFI_DEVICE_PATH_PROTOCOL * RemainingDevicePath OPTIONAL\r
	122	)\r
6a690e23	123	{\r
	124	EFI_STATUS Status;\r
	125	ISCSI_DRIVER_DATA *Private;\r
	126	\r
	127	//\r
	128	// Try to add a port configuration page for this controller.\r
	129	//\r
	130	IScsiConfigUpdateForm (This->DriverBindingHandle, ControllerHandle, TRUE);\r
	131	\r
	132	Private = IScsiCreateDriverData (This->DriverBindingHandle, ControllerHandle);\r
	133	if (Private == NULL) {\r
	134	return EFI_OUT_OF_RESOURCES;\r
	135	}\r
	136	//\r
	137	// Get the iSCSI configuration data of this controller.\r
	138	//\r
	139	Status = IScsiGetConfigData (Private);\r
	140	if (EFI_ERROR (Status)) {\r
	141	goto ON_ERROR;\r
	142	}\r
	143	//\r
	144	// Try to login and create an iSCSI session according to the configuration.\r
	145	//\r
	146	Status = IScsiSessionLogin (Private);\r
	147	if (Status == EFI_MEDIA_CHANGED) {\r
	148	//\r
	149	// The specified target is not available and the redirection information is\r
	150	// got, login the session again with the updated target address.\r
	151	//\r
	152	Status = IScsiSessionLogin (Private);\r
	153	}\r
	154	\r
	155	if (EFI_ERROR (Status)) {\r
	156	goto ON_ERROR;\r
	157	}\r
	158	//\r
	159	// Duplicate the Session's tcp connection device path. The source port field\r
	160	// will be set to zero as one iSCSI session is comprised of several iSCSI\r
	161	// connections.\r
	162	//\r
	163	Private->DevicePath = IScsiGetTcpConnDevicePath (Private);\r
	164	if (Private->DevicePath == NULL) {\r
	165	goto ON_ERROR;\r
	166	}\r
	167	//\r
	168	// Install the updated device path onto the ExtScsiPassThruHandle.\r
	169	//\r
	170	Status = gBS->InstallProtocolInterface (\r
	171	&Private->ExtScsiPassThruHandle,\r
	172	&gEfiDevicePathProtocolGuid,\r
	173	EFI_NATIVE_INTERFACE,\r
	174	Private->DevicePath\r
	175	);\r
	176	if (EFI_ERROR (Status)) {\r
	177	goto ON_ERROR;\r
	178	}\r
	179	//\r
	180	// Install the iSCSI private stuff as a flag to indicate this controller\r
	181	// is already controlled by iSCSI driver.\r
	182	//\r
	183	Status = gBS->InstallProtocolInterface (\r
	184	&ControllerHandle,\r
	185	&mIScsiPrivateGuid,\r
	186	EFI_NATIVE_INTERFACE,\r
187	&Private->IScsiIdentifier\r
188	);\r
189	if (EFI_ERROR (Status)) {\r
190	goto ON_ERROR;\r
191	}\r
192	//\r
193	// Update/Publish the iSCSI Boot Firmware Table.\r
194	//\r
195	IScsiPublishIbft ();\r
196	\r
197	return EFI_SUCCESS;\r
198	\r
199	ON_ERROR:\r
200	\r
201	IScsiSessionAbort (&Private->Session);\r
202	IScsiCleanDriverData (Private);\r
203	\r
204	return Status;\r
205	}\r
206	\r
12618416	207	/**\r
	208	Release the control of this controller and remove the IScsi functions.\r
	209	\r
	210	@param This[in] Protocol instance pointer.\r
	211	\r
	212	@param ControllerHandle[in] Handle of controller to stop.\r
	213	\r
	214	@param NumberOfChildren[in] Not used.\r
	215	\r
	216	@param ChildHandleBuffer[in] Not used.\r
	217	\r
	218	@retval EFI_SUCCES This driver supports this device.\r
	219	\r
	220	**/\r
6a690e23	221	EFI_STATUS\r
	222	EFIAPI\r
	223	IScsiDriverBindingStop (\r
	224	IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
	225	IN EFI_HANDLE ControllerHandle,\r
	226	IN UINTN NumberOfChildren,\r
	227	IN EFI_HANDLE *ChildHandleBuffer\r
	228	)\r
6a690e23	229	{\r
	230	EFI_HANDLE IScsiController;\r
	231	EFI_STATUS Status;\r
	232	ISCSI_PRIVATE_PROTOCOL *IScsiIdentifier;\r
	233	ISCSI_DRIVER_DATA *Private;\r
	234	EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r
	235	ISCSI_CONNECTION *Conn;\r
	236	\r
	237	if (NumberOfChildren != 0) {\r
	238	//\r
	239	// We should have only one child.\r
	240	//\r
	241	Status = gBS->OpenProtocol (\r
	242	ChildHandleBuffer[0],\r
	243	&gEfiExtScsiPassThruProtocolGuid,\r
	244	(VOID **) &PassThru,\r
	245	This->DriverBindingHandle,\r
	246	ControllerHandle,\r
	247	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	248	);\r
	249	if (EFI_ERROR (Status)) {\r
	250	return EFI_DEVICE_ERROR;\r
	251	}\r
	252	\r
	253	Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);\r
	254	Conn = NET_LIST_HEAD (&Private->Session.Conns, ISCSI_CONNECTION, Link);\r
	255	\r
	256	//\r
	257	// Previously the TCP4 protocol is opened BY_CHILD_CONTROLLER. Just close\r
	258	// the protocol here but not uninstall the device path protocol and\r
	259	// EXT SCSI PASS THRU protocol installed on ExtScsiPassThruHandle.\r
	260	//\r
	261	gBS->CloseProtocol (\r
	262	Conn->Tcp4Io.Handle,\r
	263	&gEfiTcp4ProtocolGuid,\r
	264	Private->Image,\r
	265	Private->ExtScsiPassThruHandle\r
	266	);\r
	267	\r
	268	return EFI_SUCCESS;\r
	269	}\r
	270	//\r
	271	// Get the handle of the controller we are controling.\r
	272	//\r
	273	IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);\r
	274	\r
	275	Status = gBS->OpenProtocol (\r
	276	IScsiController,\r
	277	&mIScsiPrivateGuid,\r
	278	(VOID **)&IScsiIdentifier,\r
	279	This->DriverBindingHandle,\r
	280	ControllerHandle,\r
	281	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	282	);\r
	283	if (EFI_ERROR (Status)) {\r
	284	return EFI_DEVICE_ERROR;\r
	285	}\r
	286	\r
	287	Private = ISCSI_DRIVER_DATA_FROM_IDENTIFIER (IScsiIdentifier);\r
	288	\r
	289	//\r
	290	// Uninstall the private protocol.\r
	291	//\r
	292	gBS->UninstallProtocolInterface (\r
293	IScsiController,\r
294	&mIScsiPrivateGuid,\r
295	&Private->IScsiIdentifier\r
296	);\r
297	\r
298	//\r
299	// Update the iSCSI Boot Firware Table.\r
300	//\r
301	IScsiPublishIbft ();\r
302	\r
303	IScsiSessionAbort (&Private->Session);\r
304	IScsiCleanDriverData (Private);\r
305	\r
306	return EFI_SUCCESS;\r
307	}\r
308	\r
12618416	309	/**\r
6a690e23	310	Unload the iSCSI driver.\r
6a690e23	311	\r
12618416	312	@param ImageHandle[in] The handle of the driver image.\r
6a690e23	313	\r
12618416	314	@retval EFI_SUCCESS The driver is unloaded.\r
6a690e23	315	\r
12618416	316	@retval EFI_DEVICE_ERROR Some unexpected error happened.\r
6a690e23	317	\r
12618416	318	**/\r
	319	EFI_STATUS\r
	320	EFIAPI\r
	321	EfiIScsiUnload (\r
	322	IN EFI_HANDLE ImageHandle\r
	323	)\r
6a690e23	324	{\r
	325	EFI_STATUS Status;\r
	326	UINTN DeviceHandleCount;\r
	327	EFI_HANDLE *DeviceHandleBuffer;\r
	328	UINTN Index;\r
	329	\r
	330	//\r
	331	// Try to disonnect the driver from the devices it's controlling.\r
	332	//\r
	333	Status = gBS->LocateHandleBuffer (\r
	334	AllHandles,\r
	335	NULL,\r
	336	NULL,\r
	337	&DeviceHandleCount,\r
	338	&DeviceHandleBuffer\r
	339	);\r
	340	if (!EFI_ERROR (Status)) {\r
	341	for (Index = 0; Index < DeviceHandleCount; Index++) {\r
	342	Status = gBS->DisconnectController (\r
	343	DeviceHandleBuffer[Index],\r
	344	ImageHandle,\r
	345	NULL\r
	346	);\r
	347	}\r
	348	\r
	349	if (DeviceHandleBuffer != NULL) {\r
e48e37fc	350	gBS->FreePool (DeviceHandleBuffer);\r
6a690e23	351	}\r
	352	}\r
	353	//\r
	354	// Unload the iSCSI configuration form.\r
	355	//\r
	356	IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);\r
	357	\r
	358	//\r
	359	// Uninstall the protocols installed by iSCSI driver.\r
	360	//\r
	361	Status = gBS->UninstallMultipleProtocolInterfaces (\r
	362	ImageHandle,\r
	363	&gEfiDriverBindingProtocolGuid,\r
	364	&gIScsiDriverBinding,\r
	365	&gEfiComponentName2ProtocolGuid,\r
	366	&gIScsiComponentName2,\r
	367	&gEfiComponentNameProtocolGuid,\r
	368	&gIScsiComponentName,\r
	369	&gEfiIScsiInitiatorNameProtocolGuid,\r
	370	&gIScsiInitiatorName,\r
	371	NULL\r
	372	);\r
	373	\r
	374	return Status;\r
	375	}\r
	376	\r
12618416	377	/**\r
6a690e23	378	Initialize the global variables publish the driver binding protocol.\r
6a690e23	379	\r
12618416	380	@param ImageHandle[in] The handle of the driver image.\r
6a690e23	381	\r
12618416	382	@param SystemTable[in] The EFI system table.\r
6a690e23	383	\r
12618416	384	@retval EFI_SUCCESS The protocols are installed.\r
6a690e23	385	\r
12618416	386	@retval EFI_DEVICE_ERROR Some unexpected error happened.\r
6a690e23	387	\r
12618416	388	**/\r
	389	EFI_STATUS\r
	390	EFIAPI\r
	391	IScsiDriverEntryPoint (\r
	392	IN EFI_HANDLE ImageHandle,\r
	393	IN EFI_SYSTEM_TABLE *SystemTable\r
	394	)\r
6a690e23	395	{\r
f2a94e25	396	EFI_STATUS Status;\r
	397	EFI_ISCSI_INITIATOR_NAME_PROTOCOL *IScsiInitiatorName;\r
	398	\r
	399	//\r
	400	// There should be only one EFI_ISCSI_INITIATOR_NAME_PROTOCOL.\r
	401	//\r
	402	Status = gBS->LocateProtocol (\r
	403	&gEfiIScsiInitiatorNameProtocolGuid,\r
	404	NULL,\r
b4df5011	405	(VOID**) &IScsiInitiatorName\r
f2a94e25	406	);\r
	407	\r
	408	if (!EFI_ERROR (Status)) {\r
	409	return EFI_ACCESS_DENIED;\r
	410	}\r
6a690e23	411	\r
	412	//\r
	413	// Initialize the EFI Driver Library\r
	414	//\r
	415	Status = EfiLibInstallDriverBindingComponentName2 (\r
	416	ImageHandle,\r
	417	SystemTable,\r
	418	&gIScsiDriverBinding,\r
	419	ImageHandle,\r
	420	&gIScsiComponentName,\r
	421	&gIScsiComponentName2\r
	422	);\r
6a690e23	423	\r
6a690e23	424	if (!EFI_ERROR (Status)) {\r
f2a94e25	425	//\r
	426	// Install the iSCSI Initiator Name Protocol.\r
	427	//\r
6a690e23	428	Status = gBS->InstallProtocolInterface (\r
	429	&ImageHandle,\r
	430	&gEfiIScsiInitiatorNameProtocolGuid,\r
	431	EFI_NATIVE_INTERFACE,\r
	432	&gIScsiInitiatorName\r
	433	);\r
	434	if (EFI_ERROR (Status)) {\r
	435	gBS->UninstallMultipleProtocolInterfaces (\r
	436	ImageHandle,\r
	437	&gEfiDriverBindingProtocolGuid,\r
	438	&gIScsiDriverBinding,\r
	439	&gEfiComponentName2ProtocolGuid,\r
	440	&gIScsiComponentName2,\r
	441	&gEfiComponentNameProtocolGuid,\r
	442	&gIScsiComponentName,\r
	443	NULL\r
	444	);\r
f2a94e25	445	return Status;\r
	446	}\r
	447	\r
	448	//\r
	449	// Initialize the configuration form of iSCSI.\r
	450	//\r
	451	Status = IScsiConfigFormInit (gIScsiDriverBinding.DriverBindingHandle);\r
	452	if (EFI_ERROR (Status)) {\r
	453	gBS->UninstallMultipleProtocolInterfaces (\r
	454	ImageHandle,\r
	455	&gEfiDriverBindingProtocolGuid,\r
	456	&gIScsiDriverBinding,\r
	457	&gEfiComponentName2ProtocolGuid,\r
	458	&gIScsiComponentName2,\r
	459	&gEfiComponentNameProtocolGuid,\r
	460	&gIScsiComponentName,\r
	461	&gEfiIScsiInitiatorNameProtocolGuid,\r
	462	&gIScsiInitiatorName,\r
	463	NULL\r
	464	);\r
6a690e23	465	}\r
6a690e23	466	}\r
6a690e23	467	return Status;\r
	468	}\r
	469	\r