4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The entry point of IScsi driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_GUID mIScsiV4PrivateGuid = ISCSI_V4_PRIVATE_GUID;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_GUID mIScsiV6PrivateGuid = ISCSI_V6_PRIVATE_GUID;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Tests to see if this driver supports the RemainingDevicePath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored by device drivers, and is optional for bus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drivers. For bus drivers, if this parameter is not NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the bus driver must determine if the bus controller specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ControllerHandle and the child controller specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by RemainingDevicePath are both supported by this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bus driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The RemainingDevicePath is supported or NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is not supported by the driver specified by This.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CurrentDevicePath->Type == MESSAGING_DEVICE_PATH) && (CurrentDevicePath->SubType == MSG_ISCSI_DP)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CurrentDevicePath = NextDevicePathNode (CurrentDevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Tests to see if this driver supports a given controller. If a child device is provided,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it further tests to see if this driver supports creating a handle for the specified child device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function checks to see if the driver specified by This supports the device specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle. Drivers typically use the device path attached to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle and/or the services from the bus I/O abstraction attached to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle to determine if the driver supports ControllerHandle. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may be called many times during platform initialization. In order to reduce boot times, the tests
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync performed by this function must be very small and take as little time as possible to execute. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function must not change the state of any hardware devices, and this function must be aware that the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device specified by ControllerHandle may already be managed by the same driver or a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync different driver. This function must match its calls to AllocatePages() with FreePages(),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Since ControllerHandle may have been previously started by the same driver, if a protocol is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync already in the opened state, then it must not be closed with CloseProtocol(). This is required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to guarantee the state of ControllerHandle is not modified by this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ControllerHandle The handle of the controller to test. This handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must support a protocol interface that supplies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an I/O abstraction to the driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored by device drivers, and is optional for bus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drivers. For bus drivers, if this parameter is not NULL, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the bus driver must determine if the bus controller specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by ControllerHandle and the child controller specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by RemainingDevicePath are both supported by this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync bus driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The device specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is supported by the driver specified by This.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is already being managed by the driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by This.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is already being managed by a different
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver or an application that requires exclusive access.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Currently not implemented.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The device specified by ControllerHandle and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is not supported by the driver specified by This.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = IScsiIsDevicePathSupported (RemainingDevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = IScsiIsDevicePathSupported (RemainingDevicePath);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Start to manage the controller. This is the worker function for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IScsiDriverBindingStart.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Image Handle of the image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ControllerHandle Handle of the controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpVersion Ip4 or Ip6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCES This driver supports this device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED This driver is already running on this device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND There is no sufficient information to establish
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the iScsi session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR Failed to get TCP connection device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_EXT_SCSI_PASS_THRU_PROTOCOL *ExistIScsiExtScsiPassThru;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Test to see if iSCSI driver supports the given controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TcpServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TcpServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Record the incoming NIC info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create the instance private data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = IScsiCreateDriverData (Image, ControllerHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create a underlayer child instance, but not need to configure it. Just open ChildHandle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // via BY_DRIVER. That is, establishing the relationship between ControllerHandle and ChildHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Therefore, when DisconnectController(), especially VLAN virtual controller handle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // IScsiDriverBindingStop() will be called.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Always install private protocol no matter what happens later. We need to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // keep the relationship between ControllerHandle and ChildHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the current iSCSI configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If there is already a successul attempt, check whether this attempt is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // first "enabled for MPIO" attempt. If not, still try the first attempt.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In single path mode, try all attempts.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mPrivate->OneSessionEstablished && mPrivate->EnableMpio) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_LIST_FOR_EACH (Entry, &mPrivate->AttemptConfigs) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData = NET_LIST_USER_STRUCT (Entry, ISCSI_ATTEMPT_CONFIG_NVDATA, Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.Enabled == ISCSI_ENABLED_FOR_MPIO) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->AttemptConfigIndex == mPrivate->BootSelectedIndex) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Uninstall the original ExtScsiPassThru first.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Locate all ExtScsiPassThru protocol instances.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find ExtScsiPassThru protocol instance produced by this driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < NumberOfHandles && ExistIScsiExtScsiPassThru == NULL; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((DevicePath->Type == MESSAGING_DEVICE_PATH) && (DevicePath->SubType == MSG_MAC_ADDR_DP)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the ExtScsiPassThru protocol instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ExistPrivate = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (ExistIScsiExtScsiPassThru);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install the Ext SCSI PASS THRU protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, &mPrivate->AttemptConfigs) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData = NET_LIST_USER_STRUCT (Entry, ISCSI_ATTEMPT_CONFIG_NVDATA, Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't process the attempt that does not associate with the current NIC or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // this attempt is disabled or established.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->NicIndex != mPrivate->CurrentNic ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->SessionConfigData.Enabled == ISCSI_DISABLED ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In multipath mode, don't process attempts configured for single path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In default single path mode, don't process attempts configured for multipath.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->SessionConfigData.Enabled != ISCSI_ENABLED_FOR_MPIO) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->SessionConfigData.Enabled != ISCSI_ENABLED)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't process the attempt that fails to get the init/target information from DHCP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.InitiatorInfoFromDhcp &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!mPrivate->EnableMpio && mPrivate->ValidSinglePathCount > 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't process the autoconfigure path if it is already established.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->AutoConfigureMode == IP_MODE_AUTOCONFIG_SUCCESS) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't process the attempt if its IP mode is not in the current IP version.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_IP6) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->AutoConfigureMode == IP_MODE_AUTOCONFIG_IP6) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_IP4) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->AutoConfigureMode == IP_MODE_AUTOCONFIG_IP4) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill in the Session and init it.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Session = (ISCSI_SESSION *) AllocateZeroPool (sizeof (ISCSI_SESSION));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Session->AuthType = AttemptConfigData->AuthenticationType;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AsciiStrToUnicodeStr (AttemptConfigData->MacString, MacString);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Session->AuthData.CHAP.AuthConfig = &AttemptConfigData->AuthConfigData.CHAP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try to login and create an iSCSI session according to the configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The specified target is not available, and the redirection information is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // received. Login the session again with the updated target address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In Single path mode, only the successful attempt will be recorded in iBFT;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // in multi-path mode, all the attempt entries in MPIO will be recorded in iBFT.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!mPrivate->EnableMpio && mPrivate->ValidSinglePathCount > 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do not record the attempt in iBFT if it login with KRB5.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // TODO: record KRB5 attempt information in the iSCSI device path.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!mPrivate->EnableMpio && mPrivate->ValidSinglePathCount > 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // IScsi session success. Update the attempt state to NVR.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigData->SessionConfigData.IpMode == IP_MODE_AUTOCONFIG) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync AttemptConfigData->AutoConfigureMode = IP_MODE_AUTOCONFIG_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Select the first login session. Abort others.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BootSelected = AttemptConfigData->AttemptConfigIndex;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't validate other attempt in multipath mode if one is success.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // All attempts configured for this driver instance are not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reinstall the original ExtScsiPassThru back.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mPrivate->OneSessionEstablished && ExistPrivate != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // More than one attempt successes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Private->Session != NULL && mPrivate->OneSessionEstablished) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync L"AttemptOrder",
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < AttemptConfigOrderSize / sizeof (UINT8); Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigOrder[Index] == mPrivate->BootSelectedIndex ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use the attempt in earlier order. Abort the later one in MPIO.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigOrder[Index] == mPrivate->BootSelectedIndex) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reinstall the original ExtScsiPassThru back.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT (AttemptConfigOrder[Index] == BootSelected);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clear the resource in ExistPrivate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Use the attempt in earlier order as boot selected in single path mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (AttemptConfigOrder[Index] == mPrivate->BootSelectedIndex) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Duplicate the Session's tcp connection device path. The source port field
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // will be set to zero as one iSCSI session is comprised of several iSCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // connections.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->DevicePath = IScsiGetTcpConnDevicePath (Private->Session);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install the updated device path onto the ExtScsiPassThruHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update/Publish the iSCSI Boot Firmware Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Starts a device controller or a bus controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Start() function is designed to be invoked from the EFI boot service ConnectController().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As a result, much of the error checking on the parameters to Start() has been moved into this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync common boot service. It is legal to call Start() from other locations,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync but the following calling restrictions must be followed or the system behavior will not be deterministic.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. ControllerHandle must be a valid EFI_HANDLE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_DEVICE_PATH_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 3. Prior to calling Start(), the Supported() function for the driver specified by This must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ControllerHandle The handle of the controller to start. This handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync must support a protocol interface that supplies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an I/O abstraction to the driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameter is ignored by device drivers, and is optional for bus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync drivers. For a bus driver, if this parameter is NULL, then handles
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for all the children of Controller are created by this driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If this parameter is not NULL and the first Device Path Node is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not the End of Device Path Node, then only the handle for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync child device specified by the first Device Path Node of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RemainingDevicePath is created by this driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the first Device Path Node of RemainingDevicePath is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the End of Device Path Node, no child handle is created by this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The device was started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others The driver failed to start the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync V4Status = IScsiStart (This->DriverBindingHandle, ControllerHandle, IP_VERSION_4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync V6Status = IScsiStart (This->DriverBindingHandle, ControllerHandle, IP_VERSION_6);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!EFI_ERROR (V4Status) || !EFI_ERROR (V6Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Stops a device controller or a bus controller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Stop() function is designed to be invoked from the EFI boot service DisconnectController().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync As a result, much of the error checking on the parameters to Stop() has been moved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync into this common boot service. It is legal to call Stop() from other locations,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync but the following calling restrictions must be followed or the system behavior will not be deterministic.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync same driver's Start() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_HANDLE. In addition, all of these handles must have been created in this driver's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Start() function, and the Start() function must have called OpenProtocol() on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ControllerHandle A handle to the device being stopped. The handle must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support a bus specific I/O protocol for the driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to use to stop the device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if NumberOfChildren is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The device was stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // We should have only one child.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Conn = NET_LIST_HEAD (&Private->Session->Conns, ISCSI_CONNECTION, Link);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Previously the TCP protocol is opened BY_CHILD_CONTROLLER. Just close
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the protocol here, but do not uninstall the device path protocol and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // EXT SCSI PASS THRU protocol installed on ExtScsiPassThruHandle.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get the handle of the controller we are controling.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp4ProtocolGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TcpServiceBindingGuid = &gEfiTcp4ServiceBindingProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IScsiController = NetLibGetNicHandle (ControllerHandle, &gEfiTcp6ProtocolGuid);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TcpServiceBindingGuid = &gEfiTcp6ServiceBindingProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private = ISCSI_DRIVER_DATA_FROM_IDENTIFIER (IScsiIdentifier);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Remove this NIC.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update the iSCSI Boot Firware Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Unload the iSCSI driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ImageHandle The handle of the driver image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The driver is unloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Try to disonnect the driver from the devices it's controlling.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < DeviceHandleCount; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Unload the iSCSI configuration form.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IScsiConfigFormUnload (gIScsiDriverBinding.DriverBindingHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Uninstall the protocols installed by iSCSI driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is the declaration of an EFI image entry point. This entry point is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync both device drivers and bus drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The entry point for iSCSI driver which initializes the global variables and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync installs the driver binding, component name protocol, iSCSI initiator name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol and Authentication Info protocol on its image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ImageHandle The firmware allocated handle for the UEFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SystemTable A pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ISCSI_INITIATOR_NAME_PROTOCOL *IScsiInitiatorName;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_AUTHENTICATION_INFO_PROTOCOL *AuthenticationInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There should be only one EFI_ISCSI_INITIATOR_NAME_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize the EFI Driver Library.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiLibInstallDriverBindingComponentName2 (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install the iSCSI Initiator Name Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create the private data structures.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mPrivate = AllocateZeroPool (sizeof (ISCSI_PRIVATE_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Initialize the configuration form of iSCSI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = IScsiConfigFormInit (gIScsiDriverBinding.DriverBindingHandle);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There should be only one EFI_AUTHENTICATION_INFO_PROTOCOL. If already exists,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // do not produce the protocol instance.