/*
 * Scsi Host Layer for MPT (Message Passing Technology) based controllers
 *
 * This code is based on drivers/scsi/mpt3sas/mpt3sas_scsih.c
 * Copyright (C) 2012-2014  LSI Corporation
 * Copyright (C) 2013-2014 Avago Technologies
 *  (mailto: MPT-FusionLinux.pdl@avagotech.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * NO WARRANTY
 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
 * solely responsible for determining the appropriateness of using and
 * distributing the Program and assumes all risks associated with its
 * exercise of rights under this Agreement, including but not limited to
 * the risks and costs of program errors, damage to or loss of data,
 * programs or equipment, and unavailability or interruption of operations.

 * DISCLAIMER OF LIABILITY
 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/errno.h>
#include <linux/blkdev.h>
#include <linux/sched.h>
#include <linux/workqueue.h>
#include <linux/delay.h>
#include <linux/pci.h>
#include <linux/interrupt.h>
#include <linux/aer.h>
#include <linux/raid_class.h>
#include <asm/unaligned.h>

#include "mpt3sas_base.h"

#define RAID_CHANNEL 1
/* forward proto's */
static void _scsih_expander_node_remove(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_node *sas_expander);
static void _firmware_event_work(struct work_struct *work);

static void _scsih_remove_device(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_device *sas_device);
static int _scsih_add_device(struct MPT3SAS_ADAPTER *ioc, u16 handle,
        u8 retry_count, u8 is_pd);

static u8 _scsih_check_for_pending_tm(struct MPT3SAS_ADAPTER *ioc, u16 smid);

/* global parameters */
LIST_HEAD(mpt3sas_ioc_list);
/* global ioc lock for list operations */
DEFINE_SPINLOCK(gioc_lock);

MODULE_AUTHOR(MPT3SAS_AUTHOR);
MODULE_DESCRIPTION(MPT3SAS_DESCRIPTION);
MODULE_LICENSE("GPL");
MODULE_VERSION(MPT3SAS_DRIVER_VERSION);
MODULE_ALIAS("mpt2sas");

/* local parameters */
static u8 scsi_io_cb_idx = -1;
static u8 tm_cb_idx = -1;
static u8 ctl_cb_idx = -1;
static u8 base_cb_idx = -1;
static u8 port_enable_cb_idx = -1;
static u8 transport_cb_idx = -1;
static u8 scsih_cb_idx = -1;
static u8 config_cb_idx = -1;
static int mpt2_ids;
static int mpt3_ids;

static u8 tm_tr_cb_idx = -1 ;
static u8 tm_tr_volume_cb_idx = -1 ;
static u8 tm_sas_control_cb_idx = -1;

/* command line options */
static u32 logging_level;
MODULE_PARM_DESC(logging_level,
        " bits for enabling additional logging info (default=0)");


static ushort max_sectors = 0xFFFF;
module_param(max_sectors, ushort, 0);
MODULE_PARM_DESC(max_sectors, "max sectors, range 64 to 32767  default=32767");


static int missing_delay[2] = {-1, -1};
module_param_array(missing_delay, int, NULL, 0);
MODULE_PARM_DESC(missing_delay, " device missing delay , io missing delay");

/* scsi-mid layer global parmeter is max_report_luns, which is 511 */
#define MPT3SAS_MAX_LUN (16895)
static u64 max_lun = MPT3SAS_MAX_LUN;
module_param(max_lun, ullong, 0);
MODULE_PARM_DESC(max_lun, " max lun, default=16895 ");

static ushort hbas_to_enumerate;
module_param(hbas_to_enumerate, ushort, 0);
MODULE_PARM_DESC(hbas_to_enumerate,
                " 0 - enumerates both SAS 2.0 & SAS 3.0 generation HBAs\n \
                  1 - enumerates only SAS 2.0 generation HBAs\n \
                  2 - enumerates only SAS 3.0 generation HBAs (default=0)");

/* diag_buffer_enable is bitwise
 * bit 0 set = TRACE
 * bit 1 set = SNAPSHOT
 * bit 2 set = EXTENDED
 *
 * Either bit can be set, or both
 */
static int diag_buffer_enable = -1;
module_param(diag_buffer_enable, int, 0);
MODULE_PARM_DESC(diag_buffer_enable,
        " post diag buffers (TRACE=1/SNAPSHOT=2/EXTENDED=4/default=0)");
static int disable_discovery = -1;
module_param(disable_discovery, int, 0);
MODULE_PARM_DESC(disable_discovery, " disable discovery ");


/* permit overriding the host protection capabilities mask (EEDP/T10 PI) */
static int prot_mask = -1;
module_param(prot_mask, int, 0);
MODULE_PARM_DESC(prot_mask, " host protection capabilities mask, def=7 ");


/* raid transport support */
struct raid_template *mpt3sas_raid_template;
struct raid_template *mpt2sas_raid_template;


/**
 * struct sense_info - common structure for obtaining sense keys
 * @skey: sense key
 * @asc: additional sense code
 * @ascq: additional sense code qualifier
 */
struct sense_info {
        u8 skey;
        u8 asc;
        u8 ascq;
};

#define MPT3SAS_PROCESS_TRIGGER_DIAG (0xFFFB)
#define MPT3SAS_TURN_ON_PFA_LED (0xFFFC)
#define MPT3SAS_PORT_ENABLE_COMPLETE (0xFFFD)
#define MPT3SAS_ABRT_TASK_SET (0xFFFE)
#define MPT3SAS_REMOVE_UNRESPONDING_DEVICES (0xFFFF)
/**
 * struct fw_event_work - firmware event struct
 * @list: link list framework
 * @work: work object (ioc->fault_reset_work_q)
 * @ioc: per adapter object
 * @device_handle: device handle
 * @VF_ID: virtual function id
 * @VP_ID: virtual port id
 * @ignore: flag meaning this event has been marked to ignore
 * @event: firmware event MPI2_EVENT_XXX defined in mpi2_ioc.h
 * @refcount: kref for this event
 * @event_data: reply event data payload follows
 *
 * This object stored on ioc->fw_event_list.
 */
struct fw_event_work {
        struct list_head        list;
        struct work_struct      work;

        struct MPT3SAS_ADAPTER *ioc;
        u16                     device_handle;
        u8                      VF_ID;
        u8                      VP_ID;
        u8                      ignore;
        u16                     event;
        struct kref             refcount;
        char                    event_data[0] __aligned(4);
};

static void fw_event_work_free(struct kref *r)
{
        kfree(container_of(r, struct fw_event_work, refcount));
}

static void fw_event_work_get(struct fw_event_work *fw_work)
{
        kref_get(&fw_work->refcount);
}

static void fw_event_work_put(struct fw_event_work *fw_work)
{
        kref_put(&fw_work->refcount, fw_event_work_free);
}

static struct fw_event_work *alloc_fw_event_work(int len)
{
        struct fw_event_work *fw_event;

        fw_event = kzalloc(sizeof(*fw_event) + len, GFP_ATOMIC);
        if (!fw_event)
                return NULL;

        kref_init(&fw_event->refcount);
        return fw_event;
}

/**
 * struct _scsi_io_transfer - scsi io transfer
 * @handle: sas device handle (assigned by firmware)
 * @is_raid: flag set for hidden raid components
 * @dir: DMA_TO_DEVICE, DMA_FROM_DEVICE,
 * @data_length: data transfer length
 * @data_dma: dma pointer to data
 * @sense: sense data
 * @lun: lun number
 * @cdb_length: cdb length
 * @cdb: cdb contents
 * @timeout: timeout for this command
 * @VF_ID: virtual function id
 * @VP_ID: virtual port id
 * @valid_reply: flag set for reply message
 * @sense_length: sense length
 * @ioc_status: ioc status
 * @scsi_state: scsi state
 * @scsi_status: scsi staus
 * @log_info: log information
 * @transfer_length: data length transfer when there is a reply message
 *
 * Used for sending internal scsi commands to devices within this module.
 * Refer to _scsi_send_scsi_io().
 */
struct _scsi_io_transfer {
        u16     handle;
        u8      is_raid;
        enum dma_data_direction dir;
        u32     data_length;
        dma_addr_t data_dma;
        u8      sense[SCSI_SENSE_BUFFERSIZE];
        u32     lun;
        u8      cdb_length;
        u8      cdb[32];
        u8      timeout;
        u8      VF_ID;
        u8      VP_ID;
        u8      valid_reply;
  /* the following bits are only valid when 'valid_reply = 1' */
        u32     sense_length;
        u16     ioc_status;
        u8      scsi_state;
        u8      scsi_status;
        u32     log_info;
        u32     transfer_length;
};

/**
 * _scsih_set_debug_level - global setting of ioc->logging_level.
 *
 * Note: The logging levels are defined in mpt3sas_debug.h.
 */
static int
_scsih_set_debug_level(const char *val, struct kernel_param *kp)
{
        int ret = param_set_int(val, kp);
        struct MPT3SAS_ADAPTER *ioc;

        if (ret)
                return ret;

        pr_info("setting logging_level(0x%08x)\n", logging_level);
        spin_lock(&gioc_lock);
        list_for_each_entry(ioc, &mpt3sas_ioc_list, list)
                ioc->logging_level = logging_level;
        spin_unlock(&gioc_lock);
        return 0;
}
module_param_call(logging_level, _scsih_set_debug_level, param_get_int,
        &logging_level, 0644);

/**
 * _scsih_srch_boot_sas_address - search based on sas_address
 * @sas_address: sas address
 * @boot_device: boot device object from bios page 2
 *
 * Returns 1 when there's a match, 0 means no match.
 */
static inline int
_scsih_srch_boot_sas_address(u64 sas_address,
        Mpi2BootDeviceSasWwid_t *boot_device)
{
        return (sas_address == le64_to_cpu(boot_device->SASAddress)) ?  1 : 0;
}

/**
 * _scsih_srch_boot_device_name - search based on device name
 * @device_name: device name specified in INDENTIFY fram
 * @boot_device: boot device object from bios page 2
 *
 * Returns 1 when there's a match, 0 means no match.
 */
static inline int
_scsih_srch_boot_device_name(u64 device_name,
        Mpi2BootDeviceDeviceName_t *boot_device)
{
        return (device_name == le64_to_cpu(boot_device->DeviceName)) ? 1 : 0;
}

/**
 * _scsih_srch_boot_encl_slot - search based on enclosure_logical_id/slot
 * @enclosure_logical_id: enclosure logical id
 * @slot_number: slot number
 * @boot_device: boot device object from bios page 2
 *
 * Returns 1 when there's a match, 0 means no match.
 */
static inline int
_scsih_srch_boot_encl_slot(u64 enclosure_logical_id, u16 slot_number,
        Mpi2BootDeviceEnclosureSlot_t *boot_device)
{
        return (enclosure_logical_id == le64_to_cpu(boot_device->
            EnclosureLogicalID) && slot_number == le16_to_cpu(boot_device->
            SlotNumber)) ? 1 : 0;
}

/**
 * _scsih_is_boot_device - search for matching boot device.
 * @sas_address: sas address
 * @device_name: device name specified in INDENTIFY fram
 * @enclosure_logical_id: enclosure logical id
 * @slot_number: slot number
 * @form: specifies boot device form
 * @boot_device: boot device object from bios page 2
 *
 * Returns 1 when there's a match, 0 means no match.
 */
static int
_scsih_is_boot_device(u64 sas_address, u64 device_name,
        u64 enclosure_logical_id, u16 slot, u8 form,
        Mpi2BiosPage2BootDevice_t *boot_device)
{
        int rc = 0;

        switch (form) {
        case MPI2_BIOSPAGE2_FORM_SAS_WWID:
                if (!sas_address)
                        break;
                rc = _scsih_srch_boot_sas_address(
                    sas_address, &boot_device->SasWwid);
                break;
        case MPI2_BIOSPAGE2_FORM_ENCLOSURE_SLOT:
                if (!enclosure_logical_id)
                        break;
                rc = _scsih_srch_boot_encl_slot(
                    enclosure_logical_id,
                    slot, &boot_device->EnclosureSlot);
                break;
        case MPI2_BIOSPAGE2_FORM_DEVICE_NAME:
                if (!device_name)
                        break;
                rc = _scsih_srch_boot_device_name(
                    device_name, &boot_device->DeviceName);
                break;
        case MPI2_BIOSPAGE2_FORM_NO_DEVICE_SPECIFIED:
                break;
        }

        return rc;
}

/**
 * _scsih_get_sas_address - set the sas_address for given device handle
 * @handle: device handle
 * @sas_address: sas address
 *
 * Returns 0 success, non-zero when failure
 */
static int
_scsih_get_sas_address(struct MPT3SAS_ADAPTER *ioc, u16 handle,
        u64 *sas_address)
{
        Mpi2SasDevicePage0_t sas_device_pg0;
        Mpi2ConfigReply_t mpi_reply;
        u32 ioc_status;

        *sas_address = 0;

        if (handle <= ioc->sas_hba.num_phys) {
                *sas_address = ioc->sas_hba.sas_address;
                return 0;
        }

        if ((mpt3sas_config_get_sas_device_pg0(ioc, &mpi_reply, &sas_device_pg0,
            MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
                pr_err(MPT3SAS_FMT "failure at %s:%d/%s()!\n", ioc->name,
                __FILE__, __LINE__, __func__);
                return -ENXIO;
        }

        ioc_status = le16_to_cpu(mpi_reply.IOCStatus) & MPI2_IOCSTATUS_MASK;
        if (ioc_status == MPI2_IOCSTATUS_SUCCESS) {
                *sas_address = le64_to_cpu(sas_device_pg0.SASAddress);
                return 0;
        }

        /* we hit this becuase the given parent handle doesn't exist */
        if (ioc_status == MPI2_IOCSTATUS_CONFIG_INVALID_PAGE)
                return -ENXIO;

        /* else error case */
        pr_err(MPT3SAS_FMT
                "handle(0x%04x), ioc_status(0x%04x), failure at %s:%d/%s()!\n",
                ioc->name, handle, ioc_status,
             __FILE__, __LINE__, __func__);
        return -EIO;
}

/**
 * _scsih_determine_boot_device - determine boot device.
 * @ioc: per adapter object
 * @device: either sas_device or raid_device object
 * @is_raid: [flag] 1 = raid object, 0 = sas object
 *
 * Determines whether this device should be first reported device to
 * to scsi-ml or sas transport, this purpose is for persistent boot device.
 * There are primary, alternate, and current entries in bios page 2. The order
 * priority is primary, alternate, then current.  This routine saves
 * the corresponding device object and is_raid flag in the ioc object.
 * The saved data to be used later in _scsih_probe_boot_devices().
 */
static void
_scsih_determine_boot_device(struct MPT3SAS_ADAPTER *ioc,
        void *device, u8 is_raid)
{
        struct _sas_device *sas_device;
        struct _raid_device *raid_device;
        u64 sas_address;
        u64 device_name;
        u64 enclosure_logical_id;
        u16 slot;

         /* only process this function when driver loads */
        if (!ioc->is_driver_loading)
                return;

         /* no Bios, return immediately */
        if (!ioc->bios_pg3.BiosVersion)
                return;

        if (!is_raid) {
                sas_device = device;
                sas_address = sas_device->sas_address;
                device_name = sas_device->device_name;
                enclosure_logical_id = sas_device->enclosure_logical_id;
                slot = sas_device->slot;
        } else {
                raid_device = device;
                sas_address = raid_device->wwid;
                device_name = 0;
                enclosure_logical_id = 0;
                slot = 0;
        }

        if (!ioc->req_boot_device.device) {
                if (_scsih_is_boot_device(sas_address, device_name,
                    enclosure_logical_id, slot,
                    (ioc->bios_pg2.ReqBootDeviceForm &
                    MPI2_BIOSPAGE2_FORM_MASK),
                    &ioc->bios_pg2.RequestedBootDevice)) {
                        dinitprintk(ioc, pr_info(MPT3SAS_FMT
                           "%s: req_boot_device(0x%016llx)\n",
                            ioc->name, __func__,
                            (unsigned long long)sas_address));
                        ioc->req_boot_device.device = device;
                        ioc->req_boot_device.is_raid = is_raid;
                }
        }

        if (!ioc->req_alt_boot_device.device) {
                if (_scsih_is_boot_device(sas_address, device_name,
                    enclosure_logical_id, slot,
                    (ioc->bios_pg2.ReqAltBootDeviceForm &
                    MPI2_BIOSPAGE2_FORM_MASK),
                    &ioc->bios_pg2.RequestedAltBootDevice)) {
                        dinitprintk(ioc, pr_info(MPT3SAS_FMT
                           "%s: req_alt_boot_device(0x%016llx)\n",
                            ioc->name, __func__,
                            (unsigned long long)sas_address));
                        ioc->req_alt_boot_device.device = device;
                        ioc->req_alt_boot_device.is_raid = is_raid;
                }
        }

        if (!ioc->current_boot_device.device) {
                if (_scsih_is_boot_device(sas_address, device_name,
                    enclosure_logical_id, slot,
                    (ioc->bios_pg2.CurrentBootDeviceForm &
                    MPI2_BIOSPAGE2_FORM_MASK),
                    &ioc->bios_pg2.CurrentBootDevice)) {
                        dinitprintk(ioc, pr_info(MPT3SAS_FMT
                           "%s: current_boot_device(0x%016llx)\n",
                            ioc->name, __func__,
                            (unsigned long long)sas_address));
                        ioc->current_boot_device.device = device;
                        ioc->current_boot_device.is_raid = is_raid;
                }
        }
}

static struct _sas_device *
__mpt3sas_get_sdev_from_target(struct MPT3SAS_ADAPTER *ioc,
                struct MPT3SAS_TARGET *tgt_priv)
{
        struct _sas_device *ret;

        assert_spin_locked(&ioc->sas_device_lock);

        ret = tgt_priv->sdev;
        if (ret)
                sas_device_get(ret);

        return ret;
}

static struct _sas_device *
mpt3sas_get_sdev_from_target(struct MPT3SAS_ADAPTER *ioc,
                struct MPT3SAS_TARGET *tgt_priv)
{
        struct _sas_device *ret;
        unsigned long flags;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        ret = __mpt3sas_get_sdev_from_target(ioc, tgt_priv);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        return ret;
}


struct _sas_device *
__mpt3sas_get_sdev_by_addr(struct MPT3SAS_ADAPTER *ioc,
                                        u64 sas_address)
{
        struct _sas_device *sas_device;

        assert_spin_locked(&ioc->sas_device_lock);

        list_for_each_entry(sas_device, &ioc->sas_device_list, list)
                if (sas_device->sas_address == sas_address)
                        goto found_device;

        list_for_each_entry(sas_device, &ioc->sas_device_init_list, list)
                if (sas_device->sas_address == sas_address)
                        goto found_device;

        return NULL;

found_device:
        sas_device_get(sas_device);
        return sas_device;
}

/**
 * mpt3sas_get_sdev_by_addr - sas device search
 * @ioc: per adapter object
 * @sas_address: sas address
 * Context: Calling function should acquire ioc->sas_device_lock
 *
 * This searches for sas_device based on sas_address, then return sas_device
 * object.
 */
struct _sas_device *
mpt3sas_get_sdev_by_addr(struct MPT3SAS_ADAPTER *ioc,
        u64 sas_address)
{
        struct _sas_device *sas_device;
        unsigned long flags;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_addr(ioc,
                        sas_address);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        return sas_device;
}

static struct _sas_device *
__mpt3sas_get_sdev_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _sas_device *sas_device;

        assert_spin_locked(&ioc->sas_device_lock);

        list_for_each_entry(sas_device, &ioc->sas_device_list, list)
                if (sas_device->handle == handle)
                        goto found_device;

        list_for_each_entry(sas_device, &ioc->sas_device_init_list, list)
                if (sas_device->handle == handle)
                        goto found_device;

        return NULL;

found_device:
        sas_device_get(sas_device);
        return sas_device;
}

/**
 * mpt3sas_get_sdev_by_handle - sas device search
 * @ioc: per adapter object
 * @handle: sas device handle (assigned by firmware)
 * Context: Calling function should acquire ioc->sas_device_lock
 *
 * This searches for sas_device based on sas_address, then return sas_device
 * object.
 */
static struct _sas_device *
mpt3sas_get_sdev_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _sas_device *sas_device;
        unsigned long flags;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_handle(ioc, handle);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        return sas_device;
}

/**
 * _scsih_sas_device_remove - remove sas_device from list.
 * @ioc: per adapter object
 * @sas_device: the sas_device object
 * Context: This function will acquire ioc->sas_device_lock.
 *
 * If sas_device is on the list, remove it and decrement its reference count.
 */
static void
_scsih_sas_device_remove(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_device *sas_device)
{
        unsigned long flags;

        if (!sas_device)
                return;
        pr_info(MPT3SAS_FMT
            "removing handle(0x%04x), sas_addr(0x%016llx)\n",
            ioc->name, sas_device->handle,
            (unsigned long long) sas_device->sas_address);

        if (sas_device->enclosure_handle != 0)
                pr_info(MPT3SAS_FMT
                   "removing enclosure logical id(0x%016llx), slot(%d)\n",
                   ioc->name, (unsigned long long)
                   sas_device->enclosure_logical_id, sas_device->slot);

        if (sas_device->connector_name[0] != '\0')
                pr_info(MPT3SAS_FMT
                   "removing enclosure level(0x%04x), connector name( %s)\n",
                   ioc->name, sas_device->enclosure_level,
                   sas_device->connector_name);

        /*
         * The lock serializes access to the list, but we still need to verify
         * that nobody removed the entry while we were waiting on the lock.
         */
        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        if (!list_empty(&sas_device->list)) {
                list_del_init(&sas_device->list);
                sas_device_put(sas_device);
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
}

/**
 * _scsih_device_remove_by_handle - removing device object by handle
 * @ioc: per adapter object
 * @handle: device handle
 *
 * Return nothing.
 */
static void
_scsih_device_remove_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _sas_device *sas_device;
        unsigned long flags;

        if (ioc->shost_recovery)
                return;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_handle(ioc, handle);
        if (sas_device) {
                list_del_init(&sas_device->list);
                sas_device_put(sas_device);
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
        if (sas_device) {
                _scsih_remove_device(ioc, sas_device);
                sas_device_put(sas_device);
        }
}

/**
 * mpt3sas_device_remove_by_sas_address - removing device object by sas address
 * @ioc: per adapter object
 * @sas_address: device sas_address
 *
 * Return nothing.
 */
void
mpt3sas_device_remove_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
        u64 sas_address)
{
        struct _sas_device *sas_device;
        unsigned long flags;

        if (ioc->shost_recovery)
                return;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_addr(ioc, sas_address);
        if (sas_device) {
                list_del_init(&sas_device->list);
                sas_device_put(sas_device);
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
        if (sas_device) {
                _scsih_remove_device(ioc, sas_device);
                sas_device_put(sas_device);
        }
}

/**
 * _scsih_sas_device_add - insert sas_device to the list.
 * @ioc: per adapter object
 * @sas_device: the sas_device object
 * Context: This function will acquire ioc->sas_device_lock.
 *
 * Adding new object to the ioc->sas_device_list.
 */
static void
_scsih_sas_device_add(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_device *sas_device)
{
        unsigned long flags;

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "%s: handle(0x%04x), sas_addr(0x%016llx)\n",
                ioc->name, __func__, sas_device->handle,
                (unsigned long long)sas_device->sas_address));

        if (sas_device->enclosure_handle != 0)
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "%s: enclosure logical id(0x%016llx), slot( %d)\n",
                    ioc->name, __func__, (unsigned long long)
                    sas_device->enclosure_logical_id, sas_device->slot));

        if (sas_device->connector_name[0] != '\0')
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "%s: enclosure level(0x%04x), connector name( %s)\n",
                    ioc->name, __func__,
                    sas_device->enclosure_level, sas_device->connector_name));

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device_get(sas_device);
        list_add_tail(&sas_device->list, &ioc->sas_device_list);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        if (!mpt3sas_transport_port_add(ioc, sas_device->handle,
             sas_device->sas_address_parent)) {
                _scsih_sas_device_remove(ioc, sas_device);
        } else if (!sas_device->starget) {
                /*
                 * When asyn scanning is enabled, its not possible to remove
                 * devices while scanning is turned on due to an oops in
                 * scsi_sysfs_add_sdev()->add_device()->sysfs_addrm_start()
                 */
                if (!ioc->is_driver_loading) {
                        mpt3sas_transport_port_remove(ioc,
                            sas_device->sas_address,
                            sas_device->sas_address_parent);
                        _scsih_sas_device_remove(ioc, sas_device);
                }
        }
}

/**
 * _scsih_sas_device_init_add - insert sas_device to the list.
 * @ioc: per adapter object
 * @sas_device: the sas_device object
 * Context: This function will acquire ioc->sas_device_lock.
 *
 * Adding new object at driver load time to the ioc->sas_device_init_list.
 */
static void
_scsih_sas_device_init_add(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_device *sas_device)
{
        unsigned long flags;

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "%s: handle(0x%04x), sas_addr(0x%016llx)\n", ioc->name,
                __func__, sas_device->handle,
                (unsigned long long)sas_device->sas_address));

        if (sas_device->enclosure_handle != 0)
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "%s: enclosure logical id(0x%016llx), slot( %d)\n",
                    ioc->name, __func__, (unsigned long long)
                    sas_device->enclosure_logical_id, sas_device->slot));

        if (sas_device->connector_name[0] != '\0')
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "%s: enclosure level(0x%04x), connector name( %s)\n",
                    ioc->name, __func__, sas_device->enclosure_level,
                    sas_device->connector_name));

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device_get(sas_device);
        list_add_tail(&sas_device->list, &ioc->sas_device_init_list);
        _scsih_determine_boot_device(ioc, sas_device, 0);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
}

/**
 * _scsih_raid_device_find_by_id - raid device search
 * @ioc: per adapter object
 * @id: sas device target id
 * @channel: sas device channel
 * Context: Calling function should acquire ioc->raid_device_lock
 *
 * This searches for raid_device based on target id, then return raid_device
 * object.
 */
static struct _raid_device *
_scsih_raid_device_find_by_id(struct MPT3SAS_ADAPTER *ioc, int id, int channel)
{
        struct _raid_device *raid_device, *r;

        r = NULL;
        list_for_each_entry(raid_device, &ioc->raid_device_list, list) {
                if (raid_device->id == id && raid_device->channel == channel) {
                        r = raid_device;
                        goto out;
                }
        }

 out:
        return r;
}

/**
 * mpt3sas_raid_device_find_by_handle - raid device search
 * @ioc: per adapter object
 * @handle: sas device handle (assigned by firmware)
 * Context: Calling function should acquire ioc->raid_device_lock
 *
 * This searches for raid_device based on handle, then return raid_device
 * object.
 */
struct _raid_device *
mpt3sas_raid_device_find_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _raid_device *raid_device, *r;

        r = NULL;
        list_for_each_entry(raid_device, &ioc->raid_device_list, list) {
                if (raid_device->handle != handle)
                        continue;
                r = raid_device;
                goto out;
        }

 out:
        return r;
}

/**
 * _scsih_raid_device_find_by_wwid - raid device search
 * @ioc: per adapter object
 * @handle: sas device handle (assigned by firmware)
 * Context: Calling function should acquire ioc->raid_device_lock
 *
 * This searches for raid_device based on wwid, then return raid_device
 * object.
 */
static struct _raid_device *
_scsih_raid_device_find_by_wwid(struct MPT3SAS_ADAPTER *ioc, u64 wwid)
{
        struct _raid_device *raid_device, *r;

        r = NULL;
        list_for_each_entry(raid_device, &ioc->raid_device_list, list) {
                if (raid_device->wwid != wwid)
                        continue;
                r = raid_device;
                goto out;
        }

 out:
        return r;
}

/**
 * _scsih_raid_device_add - add raid_device object
 * @ioc: per adapter object
 * @raid_device: raid_device object
 *
 * This is added to the raid_device_list link list.
 */
static void
_scsih_raid_device_add(struct MPT3SAS_ADAPTER *ioc,
        struct _raid_device *raid_device)
{
        unsigned long flags;

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "%s: handle(0x%04x), wwid(0x%016llx)\n", ioc->name, __func__,
            raid_device->handle, (unsigned long long)raid_device->wwid));

        spin_lock_irqsave(&ioc->raid_device_lock, flags);
        list_add_tail(&raid_device->list, &ioc->raid_device_list);
        spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
}

/**
 * _scsih_raid_device_remove - delete raid_device object
 * @ioc: per adapter object
 * @raid_device: raid_device object
 *
 */
static void
_scsih_raid_device_remove(struct MPT3SAS_ADAPTER *ioc,
        struct _raid_device *raid_device)
{
        unsigned long flags;

        spin_lock_irqsave(&ioc->raid_device_lock, flags);
        list_del(&raid_device->list);
        kfree(raid_device);
        spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
}

/**
 * mpt3sas_scsih_expander_find_by_handle - expander device search
 * @ioc: per adapter object
 * @handle: expander handle (assigned by firmware)
 * Context: Calling function should acquire ioc->sas_device_lock
 *
 * This searches for expander device based on handle, then returns the
 * sas_node object.
 */
struct _sas_node *
mpt3sas_scsih_expander_find_by_handle(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _sas_node *sas_expander, *r;

        r = NULL;
        list_for_each_entry(sas_expander, &ioc->sas_expander_list, list) {
                if (sas_expander->handle != handle)
                        continue;
                r = sas_expander;
                goto out;
        }
 out:
        return r;
}

/**
 * mpt3sas_scsih_expander_find_by_sas_address - expander device search
 * @ioc: per adapter object
 * @sas_address: sas address
 * Context: Calling function should acquire ioc->sas_node_lock.
 *
 * This searches for expander device based on sas_address, then returns the
 * sas_node object.
 */
struct _sas_node *

mpt3sas_scsih_expander_find_by_sas_address(struct MPT3SAS_ADAPTER *ioc,
        u64 sas_address)
{
        struct _sas_node *sas_expander, *r;

        r = NULL;
        list_for_each_entry(sas_expander, &ioc->sas_expander_list, list) {
                if (sas_expander->sas_address != sas_address)
                        continue;
                r = sas_expander;
                goto out;
        }
 out:
        return r;
}

/**
 * _scsih_expander_node_add - insert expander device to the list.
 * @ioc: per adapter object
 * @sas_expander: the sas_device object
 * Context: This function will acquire ioc->sas_node_lock.
 *
 * Adding new object to the ioc->sas_expander_list.
 *
 * Return nothing.
 */
static void
_scsih_expander_node_add(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_node *sas_expander)
{
        unsigned long flags;

        spin_lock_irqsave(&ioc->sas_node_lock, flags);
        list_add_tail(&sas_expander->list, &ioc->sas_expander_list);
        spin_unlock_irqrestore(&ioc->sas_node_lock, flags);
}

/**
 * _scsih_is_end_device - determines if device is an end device
 * @device_info: bitfield providing information about the device.
 * Context: none
 *
 * Returns 1 if end device.
 */
static int
_scsih_is_end_device(u32 device_info)
{
        if (device_info & MPI2_SAS_DEVICE_INFO_END_DEVICE &&
                ((device_info & MPI2_SAS_DEVICE_INFO_SSP_TARGET) |
                (device_info & MPI2_SAS_DEVICE_INFO_STP_TARGET) |
                (device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE)))
                return 1;
        else
                return 0;
}

/**
 * _scsih_scsi_lookup_get - returns scmd entry
 * @ioc: per adapter object
 * @smid: system request message index
 *
 * Returns the smid stored scmd pointer.
 */
static struct scsi_cmnd *
_scsih_scsi_lookup_get(struct MPT3SAS_ADAPTER *ioc, u16 smid)
{
        return ioc->scsi_lookup[smid - 1].scmd;
}

/**
 * _scsih_scsi_lookup_get_clear - returns scmd entry
 * @ioc: per adapter object
 * @smid: system request message index
 *
 * Returns the smid stored scmd pointer.
 * Then will derefrence the stored scmd pointer.
 */
static inline struct scsi_cmnd *
_scsih_scsi_lookup_get_clear(struct MPT3SAS_ADAPTER *ioc, u16 smid)
{
        unsigned long flags;
        struct scsi_cmnd *scmd;

        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        scmd = ioc->scsi_lookup[smid - 1].scmd;
        ioc->scsi_lookup[smid - 1].scmd = NULL;
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);

        return scmd;
}

/**
 * _scsih_scsi_lookup_find_by_scmd - scmd lookup
 * @ioc: per adapter object
 * @smid: system request message index
 * @scmd: pointer to scsi command object
 * Context: This function will acquire ioc->scsi_lookup_lock.
 *
 * This will search for a scmd pointer in the scsi_lookup array,
 * returning the revelent smid.  A returned value of zero means invalid.
 */
static u16
_scsih_scsi_lookup_find_by_scmd(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd
        *scmd)
{
        u16 smid;
        unsigned long   flags;
        int i;

        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        smid = 0;
        for (i = 0; i < ioc->scsiio_depth; i++) {
                if (ioc->scsi_lookup[i].scmd == scmd) {
                        smid = ioc->scsi_lookup[i].smid;
                        goto out;
                }
        }
 out:
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);
        return smid;
}

/**
 * _scsih_scsi_lookup_find_by_target - search for matching channel:id
 * @ioc: per adapter object
 * @id: target id
 * @channel: channel
 * Context: This function will acquire ioc->scsi_lookup_lock.
 *
 * This will search for a matching channel:id in the scsi_lookup array,
 * returning 1 if found.
 */
static u8
_scsih_scsi_lookup_find_by_target(struct MPT3SAS_ADAPTER *ioc, int id,
        int channel)
{
        u8 found;
        unsigned long   flags;
        int i;

        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        found = 0;
        for (i = 0 ; i < ioc->scsiio_depth; i++) {
                if (ioc->scsi_lookup[i].scmd &&
                    (ioc->scsi_lookup[i].scmd->device->id == id &&
                    ioc->scsi_lookup[i].scmd->device->channel == channel)) {
                        found = 1;
                        goto out;
                }
        }
 out:
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);
        return found;
}

/**
 * _scsih_scsi_lookup_find_by_lun - search for matching channel:id:lun
 * @ioc: per adapter object
 * @id: target id
 * @lun: lun number
 * @channel: channel
 * Context: This function will acquire ioc->scsi_lookup_lock.
 *
 * This will search for a matching channel:id:lun in the scsi_lookup array,
 * returning 1 if found.
 */
static u8
_scsih_scsi_lookup_find_by_lun(struct MPT3SAS_ADAPTER *ioc, int id,
        unsigned int lun, int channel)
{
        u8 found;
        unsigned long   flags;
        int i;

        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        found = 0;
        for (i = 0 ; i < ioc->scsiio_depth; i++) {
                if (ioc->scsi_lookup[i].scmd &&
                    (ioc->scsi_lookup[i].scmd->device->id == id &&
                    ioc->scsi_lookup[i].scmd->device->channel == channel &&
                    ioc->scsi_lookup[i].scmd->device->lun == lun)) {
                        found = 1;
                        goto out;
                }
        }
 out:
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);
        return found;
}

/**
 * scsih_change_queue_depth - setting device queue depth
 * @sdev: scsi device struct
 * @qdepth: requested queue depth
 *
 * Returns queue depth.
 */
static int
scsih_change_queue_depth(struct scsi_device *sdev, int qdepth)
{
        struct Scsi_Host *shost = sdev->host;
        int max_depth;
        struct MPT3SAS_ADAPTER *ioc = shost_priv(shost);
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct _sas_device *sas_device;
        unsigned long flags;

        max_depth = shost->can_queue;

        /* limit max device queue for SATA to 32 */
        sas_device_priv_data = sdev->hostdata;
        if (!sas_device_priv_data)
                goto not_sata;
        sas_target_priv_data = sas_device_priv_data->sas_target;
        if (!sas_target_priv_data)
                goto not_sata;
        if ((sas_target_priv_data->flags & MPT_TARGET_FLAGS_VOLUME))
                goto not_sata;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_from_target(ioc, sas_target_priv_data);
        if (sas_device) {
                if (sas_device->device_info & MPI2_SAS_DEVICE_INFO_SATA_DEVICE)
                        max_depth = MPT3SAS_SATA_QUEUE_DEPTH;

                sas_device_put(sas_device);
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

 not_sata:

        if (!sdev->tagged_supported)
                max_depth = 1;
        if (qdepth > max_depth)
                qdepth = max_depth;
        return scsi_change_queue_depth(sdev, qdepth);
}

/**
 * scsih_target_alloc - target add routine
 * @starget: scsi target struct
 *
 * Returns 0 if ok. Any other return is assumed to be an error and
 * the device is ignored.
 */
static int
scsih_target_alloc(struct scsi_target *starget)
{
        struct Scsi_Host *shost = dev_to_shost(&starget->dev);
        struct MPT3SAS_ADAPTER *ioc = shost_priv(shost);
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct _sas_device *sas_device;
        struct _raid_device *raid_device;
        unsigned long flags;
        struct sas_rphy *rphy;

        sas_target_priv_data = kzalloc(sizeof(*sas_target_priv_data),
                                       GFP_KERNEL);
        if (!sas_target_priv_data)
                return -ENOMEM;

        starget->hostdata = sas_target_priv_data;
        sas_target_priv_data->starget = starget;
        sas_target_priv_data->handle = MPT3SAS_INVALID_DEVICE_HANDLE;

        /* RAID volumes */
        if (starget->channel == RAID_CHANNEL) {
                spin_lock_irqsave(&ioc->raid_device_lock, flags);
                raid_device = _scsih_raid_device_find_by_id(ioc, starget->id,
                    starget->channel);
                if (raid_device) {
                        sas_target_priv_data->handle = raid_device->handle;
                        sas_target_priv_data->sas_address = raid_device->wwid;
                        sas_target_priv_data->flags |= MPT_TARGET_FLAGS_VOLUME;
                        if (ioc->is_warpdrive)
                                sas_target_priv_data->raid_device = raid_device;
                        raid_device->starget = starget;
                }
                spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
                return 0;
        }

        /* sas/sata devices */
        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        rphy = dev_to_rphy(starget->dev.parent);
        sas_device = __mpt3sas_get_sdev_by_addr(ioc,
           rphy->identify.sas_address);

        if (sas_device) {
                sas_target_priv_data->handle = sas_device->handle;
                sas_target_priv_data->sas_address = sas_device->sas_address;
                sas_target_priv_data->sdev = sas_device;
                sas_device->starget = starget;
                sas_device->id = starget->id;
                sas_device->channel = starget->channel;
                if (test_bit(sas_device->handle, ioc->pd_handles))
                        sas_target_priv_data->flags |=
                            MPT_TARGET_FLAGS_RAID_COMPONENT;
                if (sas_device->fast_path)
                        sas_target_priv_data->flags |= MPT_TARGET_FASTPATH_IO;
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        return 0;
}

/**
 * scsih_target_destroy - target destroy routine
 * @starget: scsi target struct
 *
 * Returns nothing.
 */
static void
scsih_target_destroy(struct scsi_target *starget)
{
        struct Scsi_Host *shost = dev_to_shost(&starget->dev);
        struct MPT3SAS_ADAPTER *ioc = shost_priv(shost);
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct _sas_device *sas_device;
        struct _raid_device *raid_device;
        unsigned long flags;

        sas_target_priv_data = starget->hostdata;
        if (!sas_target_priv_data)
                return;

        if (starget->channel == RAID_CHANNEL) {
                spin_lock_irqsave(&ioc->raid_device_lock, flags);
                raid_device = _scsih_raid_device_find_by_id(ioc, starget->id,
                    starget->channel);
                if (raid_device) {
                        raid_device->starget = NULL;
                        raid_device->sdev = NULL;
                }
                spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
                goto out;
        }

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_from_target(ioc, sas_target_priv_data);
        if (sas_device && (sas_device->starget == starget) &&
            (sas_device->id == starget->id) &&
            (sas_device->channel == starget->channel))
                sas_device->starget = NULL;

        if (sas_device) {
                /*
                 * Corresponding get() is in _scsih_target_alloc()
                 */
                sas_target_priv_data->sdev = NULL;
                sas_device_put(sas_device);

                sas_device_put(sas_device);
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

 out:
        kfree(sas_target_priv_data);
        starget->hostdata = NULL;
}

/**
 * scsih_slave_alloc - device add routine
 * @sdev: scsi device struct
 *
 * Returns 0 if ok. Any other return is assumed to be an error and
 * the device is ignored.
 */
static int
scsih_slave_alloc(struct scsi_device *sdev)
{
        struct Scsi_Host *shost;
        struct MPT3SAS_ADAPTER *ioc;
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_target *starget;
        struct _raid_device *raid_device;
        struct _sas_device *sas_device;
        unsigned long flags;

        sas_device_priv_data = kzalloc(sizeof(*sas_device_priv_data),
                                       GFP_KERNEL);
        if (!sas_device_priv_data)
                return -ENOMEM;

        sas_device_priv_data->lun = sdev->lun;
        sas_device_priv_data->flags = MPT_DEVICE_FLAGS_INIT;

        starget = scsi_target(sdev);
        sas_target_priv_data = starget->hostdata;
        sas_target_priv_data->num_luns++;
        sas_device_priv_data->sas_target = sas_target_priv_data;
        sdev->hostdata = sas_device_priv_data;
        if ((sas_target_priv_data->flags & MPT_TARGET_FLAGS_RAID_COMPONENT))
                sdev->no_uld_attach = 1;

        shost = dev_to_shost(&starget->dev);
        ioc = shost_priv(shost);
        if (starget->channel == RAID_CHANNEL) {
                spin_lock_irqsave(&ioc->raid_device_lock, flags);
                raid_device = _scsih_raid_device_find_by_id(ioc,
                    starget->id, starget->channel);
                if (raid_device)
                        raid_device->sdev = sdev; /* raid is single lun */
                spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
        }

        if (!(sas_target_priv_data->flags & MPT_TARGET_FLAGS_VOLUME)) {
                spin_lock_irqsave(&ioc->sas_device_lock, flags);
                sas_device = __mpt3sas_get_sdev_by_addr(ioc,
                                        sas_target_priv_data->sas_address);
                if (sas_device && (sas_device->starget == NULL)) {
                        sdev_printk(KERN_INFO, sdev,
                        "%s : sas_device->starget set to starget @ %d\n",
                             __func__, __LINE__);
                        sas_device->starget = starget;
                }

                if (sas_device)
                        sas_device_put(sas_device);

                spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
        }

        return 0;
}

/**
 * scsih_slave_destroy - device destroy routine
 * @sdev: scsi device struct
 *
 * Returns nothing.
 */
static void
scsih_slave_destroy(struct scsi_device *sdev)
{
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct scsi_target *starget;
        struct Scsi_Host *shost;
        struct MPT3SAS_ADAPTER *ioc;
        struct _sas_device *sas_device;
        unsigned long flags;

        if (!sdev->hostdata)
                return;

        starget = scsi_target(sdev);
        sas_target_priv_data = starget->hostdata;
        sas_target_priv_data->num_luns--;

        shost = dev_to_shost(&starget->dev);
        ioc = shost_priv(shost);

        if (!(sas_target_priv_data->flags & MPT_TARGET_FLAGS_VOLUME)) {
                spin_lock_irqsave(&ioc->sas_device_lock, flags);
                sas_device = __mpt3sas_get_sdev_from_target(ioc,
                                sas_target_priv_data);
                if (sas_device && !sas_target_priv_data->num_luns)
                        sas_device->starget = NULL;

                if (sas_device)
                        sas_device_put(sas_device);
                spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
        }

        kfree(sdev->hostdata);
        sdev->hostdata = NULL;
}

/**
 * _scsih_display_sata_capabilities - sata capabilities
 * @ioc: per adapter object
 * @handle: device handle
 * @sdev: scsi device struct
 */
static void
_scsih_display_sata_capabilities(struct MPT3SAS_ADAPTER *ioc,
        u16 handle, struct scsi_device *sdev)
{
        Mpi2ConfigReply_t mpi_reply;
        Mpi2SasDevicePage0_t sas_device_pg0;
        u32 ioc_status;
        u16 flags;
        u32 device_info;

        if ((mpt3sas_config_get_sas_device_pg0(ioc, &mpi_reply, &sas_device_pg0,
            MPI2_SAS_DEVICE_PGAD_FORM_HANDLE, handle))) {
                pr_err(MPT3SAS_FMT "failure at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                return;
        }

        ioc_status = le16_to_cpu(mpi_reply.IOCStatus) &
            MPI2_IOCSTATUS_MASK;
        if (ioc_status != MPI2_IOCSTATUS_SUCCESS) {
                pr_err(MPT3SAS_FMT "failure at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                return;
        }

        flags = le16_to_cpu(sas_device_pg0.Flags);
        device_info = le32_to_cpu(sas_device_pg0.DeviceInfo);

        sdev_printk(KERN_INFO, sdev,
            "atapi(%s), ncq(%s), asyn_notify(%s), smart(%s), fua(%s), "
            "sw_preserve(%s)\n",
            (device_info & MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE) ? "y" : "n",
            (flags & MPI2_SAS_DEVICE0_FLAGS_SATA_NCQ_SUPPORTED) ? "y" : "n",
            (flags & MPI2_SAS_DEVICE0_FLAGS_SATA_ASYNCHRONOUS_NOTIFY) ? "y" :
            "n",
            (flags & MPI2_SAS_DEVICE0_FLAGS_SATA_SMART_SUPPORTED) ? "y" : "n",
            (flags & MPI2_SAS_DEVICE0_FLAGS_SATA_FUA_SUPPORTED) ? "y" : "n",
            (flags & MPI2_SAS_DEVICE0_FLAGS_SATA_SW_PRESERVE) ? "y" : "n");
}

/*
 * raid transport support -
 * Enabled for SLES11 and newer, in older kernels the driver will panic when
 * unloading the driver followed by a load - I beleive that the subroutine
 * raid_class_release() is not cleaning up properly.
 */

/**
 * scsih_is_raid - return boolean indicating device is raid volume
 * @dev the device struct object
 */
static int
scsih_is_raid(struct device *dev)
{
        struct scsi_device *sdev = to_scsi_device(dev);
        struct MPT3SAS_ADAPTER *ioc = shost_priv(sdev->host);

        if (ioc->is_warpdrive)
                return 0;
        return (sdev->channel == RAID_CHANNEL) ? 1 : 0;
}

/**
 * scsih_get_resync - get raid volume resync percent complete
 * @dev the device struct object
 */
static void
scsih_get_resync(struct device *dev)
{
        struct scsi_device *sdev = to_scsi_device(dev);
        struct MPT3SAS_ADAPTER *ioc = shost_priv(sdev->host);
        static struct _raid_device *raid_device;
        unsigned long flags;
        Mpi2RaidVolPage0_t vol_pg0;
        Mpi2ConfigReply_t mpi_reply;
        u32 volume_status_flags;
        u8 percent_complete;
        u16 handle;

        percent_complete = 0;
        handle = 0;
        if (ioc->is_warpdrive)
                goto out;

        spin_lock_irqsave(&ioc->raid_device_lock, flags);
        raid_device = _scsih_raid_device_find_by_id(ioc, sdev->id,
            sdev->channel);
        if (raid_device) {
                handle = raid_device->handle;
                percent_complete = raid_device->percent_complete;
        }
        spin_unlock_irqrestore(&ioc->raid_device_lock, flags);

        if (!handle)
                goto out;

        if (mpt3sas_config_get_raid_volume_pg0(ioc, &mpi_reply, &vol_pg0,
             MPI2_RAID_VOLUME_PGAD_FORM_HANDLE, handle,
             sizeof(Mpi2RaidVolPage0_t))) {
                pr_err(MPT3SAS_FMT "failure at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                percent_complete = 0;
                goto out;
        }

        volume_status_flags = le32_to_cpu(vol_pg0.VolumeStatusFlags);
        if (!(volume_status_flags &
            MPI2_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS))
                percent_complete = 0;

 out:

        switch (ioc->hba_mpi_version_belonged) {
        case MPI2_VERSION:
                raid_set_resync(mpt2sas_raid_template, dev, percent_complete);
                break;
        case MPI25_VERSION:
        case MPI26_VERSION:
                raid_set_resync(mpt3sas_raid_template, dev, percent_complete);
                break;
        }
}

/**
 * scsih_get_state - get raid volume level
 * @dev the device struct object
 */
static void
scsih_get_state(struct device *dev)
{
        struct scsi_device *sdev = to_scsi_device(dev);
        struct MPT3SAS_ADAPTER *ioc = shost_priv(sdev->host);
        static struct _raid_device *raid_device;
        unsigned long flags;
        Mpi2RaidVolPage0_t vol_pg0;
        Mpi2ConfigReply_t mpi_reply;
        u32 volstate;
        enum raid_state state = RAID_STATE_UNKNOWN;
        u16 handle = 0;

        spin_lock_irqsave(&ioc->raid_device_lock, flags);
        raid_device = _scsih_raid_device_find_by_id(ioc, sdev->id,
            sdev->channel);
        if (raid_device)
                handle = raid_device->handle;
        spin_unlock_irqrestore(&ioc->raid_device_lock, flags);

        if (!raid_device)
                goto out;

        if (mpt3sas_config_get_raid_volume_pg0(ioc, &mpi_reply, &vol_pg0,
             MPI2_RAID_VOLUME_PGAD_FORM_HANDLE, handle,
             sizeof(Mpi2RaidVolPage0_t))) {
                pr_err(MPT3SAS_FMT "failure at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                goto out;
        }

        volstate = le32_to_cpu(vol_pg0.VolumeStatusFlags);
        if (volstate & MPI2_RAIDVOL0_STATUS_FLAG_RESYNC_IN_PROGRESS) {
                state = RAID_STATE_RESYNCING;
                goto out;
        }

        switch (vol_pg0.VolumeState) {
        case MPI2_RAID_VOL_STATE_OPTIMAL:
        case MPI2_RAID_VOL_STATE_ONLINE:
                state = RAID_STATE_ACTIVE;
                break;
        case  MPI2_RAID_VOL_STATE_DEGRADED:
                state = RAID_STATE_DEGRADED;
                break;
        case MPI2_RAID_VOL_STATE_FAILED:
        case MPI2_RAID_VOL_STATE_MISSING:
                state = RAID_STATE_OFFLINE;
                break;
        }
 out:
        switch (ioc->hba_mpi_version_belonged) {
        case MPI2_VERSION:
                raid_set_state(mpt2sas_raid_template, dev, state);
                break;
        case MPI25_VERSION:
        case MPI26_VERSION:
                raid_set_state(mpt3sas_raid_template, dev, state);
                break;
        }
}

/**
 * _scsih_set_level - set raid level
 * @sdev: scsi device struct
 * @volume_type: volume type
 */
static void
_scsih_set_level(struct MPT3SAS_ADAPTER *ioc,
        struct scsi_device *sdev, u8 volume_type)
{
        enum raid_level level = RAID_LEVEL_UNKNOWN;

        switch (volume_type) {
        case MPI2_RAID_VOL_TYPE_RAID0:
                level = RAID_LEVEL_0;
                break;
        case MPI2_RAID_VOL_TYPE_RAID10:
                level = RAID_LEVEL_10;
                break;
        case MPI2_RAID_VOL_TYPE_RAID1E:
                level = RAID_LEVEL_1E;
                break;
        case MPI2_RAID_VOL_TYPE_RAID1:
                level = RAID_LEVEL_1;
                break;
        }

        switch (ioc->hba_mpi_version_belonged) {
        case MPI2_VERSION:
                raid_set_level(mpt2sas_raid_template,
                        &sdev->sdev_gendev, level);
                break;
        case MPI25_VERSION:
        case MPI26_VERSION:
                raid_set_level(mpt3sas_raid_template,
                        &sdev->sdev_gendev, level);
                break;
        }
}


/**
 * _scsih_get_volume_capabilities - volume capabilities
 * @ioc: per adapter object
 * @sas_device: the raid_device object
 *
 * Returns 0 for success, else 1
 */
static int
_scsih_get_volume_capabilities(struct MPT3SAS_ADAPTER *ioc,
        struct _raid_device *raid_device)
{
        Mpi2RaidVolPage0_t *vol_pg0;
        Mpi2RaidPhysDiskPage0_t pd_pg0;
        Mpi2SasDevicePage0_t sas_device_pg0;
        Mpi2ConfigReply_t mpi_reply;
        u16 sz;
        u8 num_pds;

        if ((mpt3sas_config_get_number_pds(ioc, raid_device->handle,
            &num_pds)) || !num_pds) {
                dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                    "failure at %s:%d/%s()!\n", ioc->name, __FILE__, __LINE__,
                    __func__));
                return 1;
        }

        raid_device->num_pds = num_pds;
        sz = offsetof(Mpi2RaidVolPage0_t, PhysDisk) + (num_pds *
            sizeof(Mpi2RaidVol0PhysDisk_t));
        vol_pg0 = kzalloc(sz, GFP_KERNEL);
        if (!vol_pg0) {
                dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                    "failure at %s:%d/%s()!\n", ioc->name, __FILE__, __LINE__,
                    __func__));
                return 1;
        }

        if ((mpt3sas_config_get_raid_volume_pg0(ioc, &mpi_reply, vol_pg0,
             MPI2_RAID_VOLUME_PGAD_FORM_HANDLE, raid_device->handle, sz))) {
                dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                    "failure at %s:%d/%s()!\n", ioc->name, __FILE__, __LINE__,
                    __func__));
                kfree(vol_pg0);
                return 1;
        }

        raid_device->volume_type = vol_pg0->VolumeType;

        /* figure out what the underlying devices are by
         * obtaining the device_info bits for the 1st device
         */
        if (!(mpt3sas_config_get_phys_disk_pg0(ioc, &mpi_reply,
            &pd_pg0, MPI2_PHYSDISK_PGAD_FORM_PHYSDISKNUM,
            vol_pg0->PhysDisk[0].PhysDiskNum))) {
                if (!(mpt3sas_config_get_sas_device_pg0(ioc, &mpi_reply,
                    &sas_device_pg0, MPI2_SAS_DEVICE_PGAD_FORM_HANDLE,
                    le16_to_cpu(pd_pg0.DevHandle)))) {
                        raid_device->device_info =
                            le32_to_cpu(sas_device_pg0.DeviceInfo);
                }
        }

        kfree(vol_pg0);
        return 0;
}

/**
 * _scsih_enable_tlr - setting TLR flags
 * @ioc: per adapter object
 * @sdev: scsi device struct
 *
 * Enabling Transaction Layer Retries for tape devices when
 * vpd page 0x90 is present
 *
 */
static void
_scsih_enable_tlr(struct MPT3SAS_ADAPTER *ioc, struct scsi_device *sdev)
{

        /* only for TAPE */
        if (sdev->type != TYPE_TAPE)
                return;

        if (!(ioc->facts.IOCCapabilities & MPI2_IOCFACTS_CAPABILITY_TLR))
                return;

        sas_enable_tlr(sdev);
        sdev_printk(KERN_INFO, sdev, "TLR %s\n",
            sas_is_tlr_enabled(sdev) ? "Enabled" : "Disabled");
        return;

}

/**
 * scsih_slave_configure - device configure routine.
 * @sdev: scsi device struct
 *
 * Returns 0 if ok. Any other return is assumed to be an error and
 * the device is ignored.
 */
static int
scsih_slave_configure(struct scsi_device *sdev)
{
        struct Scsi_Host *shost = sdev->host;
        struct MPT3SAS_ADAPTER *ioc = shost_priv(shost);
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct MPT3SAS_TARGET *sas_target_priv_data;
        struct _sas_device *sas_device;
        struct _raid_device *raid_device;
        unsigned long flags;
        int qdepth;
        u8 ssp_target = 0;
        char *ds = "";
        char *r_level = "";
        u16 handle, volume_handle = 0;
        u64 volume_wwid = 0;

        qdepth = 1;
        sas_device_priv_data = sdev->hostdata;
        sas_device_priv_data->configured_lun = 1;
        sas_device_priv_data->flags &= ~MPT_DEVICE_FLAGS_INIT;
        sas_target_priv_data = sas_device_priv_data->sas_target;
        handle = sas_target_priv_data->handle;

        /* raid volume handling */
        if (sas_target_priv_data->flags & MPT_TARGET_FLAGS_VOLUME) {

                spin_lock_irqsave(&ioc->raid_device_lock, flags);
                raid_device = mpt3sas_raid_device_find_by_handle(ioc, handle);
                spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
                if (!raid_device) {
                        dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                            "failure at %s:%d/%s()!\n", ioc->name, __FILE__,
                            __LINE__, __func__));
                        return 1;
                }

                if (_scsih_get_volume_capabilities(ioc, raid_device)) {
                        dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                            "failure at %s:%d/%s()!\n", ioc->name, __FILE__,
                            __LINE__, __func__));
                        return 1;
                }

                /*
                 * WARPDRIVE: Initialize the required data for Direct IO
                 */
                mpt3sas_init_warpdrive_properties(ioc, raid_device);

                /* RAID Queue Depth Support
                 * IS volume = underlying qdepth of drive type, either
                 *    MPT3SAS_SAS_QUEUE_DEPTH or MPT3SAS_SATA_QUEUE_DEPTH
                 * IM/IME/R10 = 128 (MPT3SAS_RAID_QUEUE_DEPTH)
                 */
                if (raid_device->device_info &
                    MPI2_SAS_DEVICE_INFO_SSP_TARGET) {
                        qdepth = MPT3SAS_SAS_QUEUE_DEPTH;
                        ds = "SSP";
                } else {
                        qdepth = MPT3SAS_SATA_QUEUE_DEPTH;
                         if (raid_device->device_info &
                            MPI2_SAS_DEVICE_INFO_SATA_DEVICE)
                                ds = "SATA";
                        else
                                ds = "STP";
                }

                switch (raid_device->volume_type) {
                case MPI2_RAID_VOL_TYPE_RAID0:
                        r_level = "RAID0";
                        break;
                case MPI2_RAID_VOL_TYPE_RAID1E:
                        qdepth = MPT3SAS_RAID_QUEUE_DEPTH;
                        if (ioc->manu_pg10.OEMIdentifier &&
                            (le32_to_cpu(ioc->manu_pg10.GenericFlags0) &
                            MFG10_GF0_R10_DISPLAY) &&
                            !(raid_device->num_pds % 2))
                                r_level = "RAID10";
                        else
                                r_level = "RAID1E";
                        break;
                case MPI2_RAID_VOL_TYPE_RAID1:
                        qdepth = MPT3SAS_RAID_QUEUE_DEPTH;
                        r_level = "RAID1";
                        break;
                case MPI2_RAID_VOL_TYPE_RAID10:
                        qdepth = MPT3SAS_RAID_QUEUE_DEPTH;
                        r_level = "RAID10";
                        break;
                case MPI2_RAID_VOL_TYPE_UNKNOWN:
                default:
                        qdepth = MPT3SAS_RAID_QUEUE_DEPTH;
                        r_level = "RAIDX";
                        break;
                }

                if (!ioc->hide_ir_msg)
                        sdev_printk(KERN_INFO, sdev,
                           "%s: handle(0x%04x), wwid(0x%016llx),"
                            " pd_count(%d), type(%s)\n",
                            r_level, raid_device->handle,
                            (unsigned long long)raid_device->wwid,
                            raid_device->num_pds, ds);

                if (shost->max_sectors > MPT3SAS_RAID_MAX_SECTORS) {
                        blk_queue_max_hw_sectors(sdev->request_queue,
                                                MPT3SAS_RAID_MAX_SECTORS);
                        sdev_printk(KERN_INFO, sdev,
                                        "Set queue's max_sector to: %u\n",
                                                MPT3SAS_RAID_MAX_SECTORS);
                }

                scsih_change_queue_depth(sdev, qdepth);

                /* raid transport support */
                if (!ioc->is_warpdrive)
                        _scsih_set_level(ioc, sdev, raid_device->volume_type);
                return 0;
        }

        /* non-raid handling */
        if (sas_target_priv_data->flags & MPT_TARGET_FLAGS_RAID_COMPONENT) {
                if (mpt3sas_config_get_volume_handle(ioc, handle,
                    &volume_handle)) {
                        dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                            "failure at %s:%d/%s()!\n", ioc->name,
                            __FILE__, __LINE__, __func__));
                        return 1;
                }
                if (volume_handle && mpt3sas_config_get_volume_wwid(ioc,
                    volume_handle, &volume_wwid)) {
                        dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                            "failure at %s:%d/%s()!\n", ioc->name,
                            __FILE__, __LINE__, __func__));
                        return 1;
                }
        }

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_addr(ioc,
           sas_device_priv_data->sas_target->sas_address);
        if (!sas_device) {
                spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
                dfailprintk(ioc, pr_warn(MPT3SAS_FMT
                    "failure at %s:%d/%s()!\n", ioc->name, __FILE__, __LINE__,
                    __func__));
                return 1;
        }

        sas_device->volume_handle = volume_handle;
        sas_device->volume_wwid = volume_wwid;
        if (sas_device->device_info & MPI2_SAS_DEVICE_INFO_SSP_TARGET) {
                qdepth = MPT3SAS_SAS_QUEUE_DEPTH;
                ssp_target = 1;
                if (sas_device->device_info &
                                MPI2_SAS_DEVICE_INFO_SEP) {
                        sdev_printk(KERN_WARNING, sdev,
                        "set ignore_delay_remove for handle(0x%04x)\n",
                        sas_device_priv_data->sas_target->handle);
                        sas_device_priv_data->ignore_delay_remove = 1;
                        ds = "SES";
                } else
                        ds = "SSP";
        } else {
                qdepth = MPT3SAS_SATA_QUEUE_DEPTH;
                if (sas_device->device_info & MPI2_SAS_DEVICE_INFO_STP_TARGET)
                        ds = "STP";
                else if (sas_device->device_info &
                    MPI2_SAS_DEVICE_INFO_SATA_DEVICE)
                        ds = "SATA";
        }

        sdev_printk(KERN_INFO, sdev, "%s: handle(0x%04x), " \
            "sas_addr(0x%016llx), phy(%d), device_name(0x%016llx)\n",
            ds, handle, (unsigned long long)sas_device->sas_address,
            sas_device->phy, (unsigned long long)sas_device->device_name);
        if (sas_device->enclosure_handle != 0)
                sdev_printk(KERN_INFO, sdev,
                     "%s: enclosure_logical_id(0x%016llx), slot(%d)\n",
                     ds, (unsigned long long)
                     sas_device->enclosure_logical_id, sas_device->slot);
        if (sas_device->connector_name[0] != '\0')
                sdev_printk(KERN_INFO, sdev,
                     "%s: enclosure level(0x%04x), connector name( %s)\n",
                     ds, sas_device->enclosure_level,
                     sas_device->connector_name);

        sas_device_put(sas_device);
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        if (!ssp_target)
                _scsih_display_sata_capabilities(ioc, handle, sdev);


        scsih_change_queue_depth(sdev, qdepth);

        if (ssp_target) {
                sas_read_port_mode_page(sdev);
                _scsih_enable_tlr(ioc, sdev);
        }

        return 0;
}

/**
 * scsih_bios_param - fetch head, sector, cylinder info for a disk
 * @sdev: scsi device struct
 * @bdev: pointer to block device context
 * @capacity: device size (in 512 byte sectors)
 * @params: three element array to place output:
 *              params[0] number of heads (max 255)
 *              params[1] number of sectors (max 63)
 *              params[2] number of cylinders
 *
 * Return nothing.
 */
static int
scsih_bios_param(struct scsi_device *sdev, struct block_device *bdev,
        sector_t capacity, int params[])
{
        int             heads;
        int             sectors;
        sector_t        cylinders;
        ulong           dummy;

        heads = 64;
        sectors = 32;

        dummy = heads * sectors;
        cylinders = capacity;
        sector_div(cylinders, dummy);

        /*
         * Handle extended translation size for logical drives
         * > 1Gb
         */
        if ((ulong)capacity >= 0x200000) {
                heads = 255;
                sectors = 63;
                dummy = heads * sectors;
                cylinders = capacity;
                sector_div(cylinders, dummy);
        }

        /* return result */
        params[0] = heads;
        params[1] = sectors;
        params[2] = cylinders;

        return 0;
}

/**
 * _scsih_response_code - translation of device response code
 * @ioc: per adapter object
 * @response_code: response code returned by the device
 *
 * Return nothing.
 */
static void
_scsih_response_code(struct MPT3SAS_ADAPTER *ioc, u8 response_code)
{
        char *desc;

        switch (response_code) {
        case MPI2_SCSITASKMGMT_RSP_TM_COMPLETE:
                desc = "task management request completed";
                break;
        case MPI2_SCSITASKMGMT_RSP_INVALID_FRAME:
                desc = "invalid frame";
                break;
        case MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED:
                desc = "task management request not supported";
                break;
        case MPI2_SCSITASKMGMT_RSP_TM_FAILED:
                desc = "task management request failed";
                break;
        case MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED:
                desc = "task management request succeeded";
                break;
        case MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN:
                desc = "invalid lun";
                break;
        case 0xA:
                desc = "overlapped tag attempted";
                break;
        case MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC:
                desc = "task queued, however not sent to target";
                break;
        default:
                desc = "unknown";
                break;
        }
        pr_warn(MPT3SAS_FMT "response_code(0x%01x): %s\n",
                ioc->name, response_code, desc);
}

/**
 * _scsih_tm_done - tm completion routine
 * @ioc: per adapter object
 * @smid: system request message index
 * @msix_index: MSIX table index supplied by the OS
 * @reply: reply message frame(lower 32bit addr)
 * Context: none.
 *
 * The callback handler when using scsih_issue_tm.
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
static u8
_scsih_tm_done(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index, u32 reply)
{
        MPI2DefaultReply_t *mpi_reply;

        if (ioc->tm_cmds.status == MPT3_CMD_NOT_USED)
                return 1;
        if (ioc->tm_cmds.smid != smid)
                return 1;
        ioc->tm_cmds.status |= MPT3_CMD_COMPLETE;
        mpi_reply =  mpt3sas_base_get_reply_virt_addr(ioc, reply);
        if (mpi_reply) {
                memcpy(ioc->tm_cmds.reply, mpi_reply, mpi_reply->MsgLength*4);
                ioc->tm_cmds.status |= MPT3_CMD_REPLY_VALID;
        }
        ioc->tm_cmds.status &= ~MPT3_CMD_PENDING;
        complete(&ioc->tm_cmds.done);
        return 1;
}

/**
 * mpt3sas_scsih_set_tm_flag - set per target tm_busy
 * @ioc: per adapter object
 * @handle: device handle
 *
 * During taskmangement request, we need to freeze the device queue.
 */
void
mpt3sas_scsih_set_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;
        u8 skip = 0;

        shost_for_each_device(sdev, ioc->shost) {
                if (skip)
                        continue;
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (sas_device_priv_data->sas_target->handle == handle) {
                        sas_device_priv_data->sas_target->tm_busy = 1;
                        skip = 1;
                        ioc->ignore_loginfos = 1;
                }
        }
}

/**
 * mpt3sas_scsih_clear_tm_flag - clear per target tm_busy
 * @ioc: per adapter object
 * @handle: device handle
 *
 * During taskmangement request, we need to freeze the device queue.
 */
void
mpt3sas_scsih_clear_tm_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;
        u8 skip = 0;

        shost_for_each_device(sdev, ioc->shost) {
                if (skip)
                        continue;
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (sas_device_priv_data->sas_target->handle == handle) {
                        sas_device_priv_data->sas_target->tm_busy = 0;
                        skip = 1;
                        ioc->ignore_loginfos = 0;
                }
        }
}

/**
 * mpt3sas_scsih_issue_tm - main routine for sending tm requests
 * @ioc: per adapter struct
 * @device_handle: device handle
 * @channel: the channel assigned by the OS
 * @id: the id assigned by the OS
 * @lun: lun number
 * @type: MPI2_SCSITASKMGMT_TASKTYPE__XXX (defined in mpi2_init.h)
 * @smid_task: smid assigned to the task
 * @timeout: timeout in seconds
 * Context: user
 *
 * A generic API for sending task management requests to firmware.
 *
 * The callback index is set inside `ioc->tm_cb_idx`.
 *
 * Return SUCCESS or FAILED.
 */
int
mpt3sas_scsih_issue_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle, uint channel,
        uint id, uint lun, u8 type, u16 smid_task, ulong timeout)
{
        Mpi2SCSITaskManagementRequest_t *mpi_request;
        Mpi2SCSITaskManagementReply_t *mpi_reply;
        u16 smid = 0;
        u32 ioc_state;
        struct scsiio_tracker *scsi_lookup = NULL;
        int rc;
        u16 msix_task = 0;

        lockdep_assert_held(&ioc->tm_cmds.mutex);

        if (ioc->tm_cmds.status != MPT3_CMD_NOT_USED) {
                pr_info(MPT3SAS_FMT "%s: tm_cmd busy!!!\n",
                    __func__, ioc->name);
                return FAILED;
        }

        if (ioc->shost_recovery || ioc->remove_host ||
            ioc->pci_error_recovery) {
                pr_info(MPT3SAS_FMT "%s: host reset in progress!\n",
                    __func__, ioc->name);
                return FAILED;
        }

        ioc_state = mpt3sas_base_get_iocstate(ioc, 0);
        if (ioc_state & MPI2_DOORBELL_USED) {
                dhsprintk(ioc, pr_info(MPT3SAS_FMT
                        "unexpected doorbell active!\n", ioc->name));
                rc = mpt3sas_base_hard_reset_handler(ioc, FORCE_BIG_HAMMER);
                return (!rc) ? SUCCESS : FAILED;
        }

        if ((ioc_state & MPI2_IOC_STATE_MASK) == MPI2_IOC_STATE_FAULT) {
                mpt3sas_base_fault_info(ioc, ioc_state &
                    MPI2_DOORBELL_DATA_MASK);
                rc = mpt3sas_base_hard_reset_handler(ioc, FORCE_BIG_HAMMER);
                return (!rc) ? SUCCESS : FAILED;
        }

        smid = mpt3sas_base_get_smid_hpr(ioc, ioc->tm_cb_idx);
        if (!smid) {
                pr_err(MPT3SAS_FMT "%s: failed obtaining a smid\n",
                    ioc->name, __func__);
                return FAILED;
        }

        if (type == MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK)
                scsi_lookup = &ioc->scsi_lookup[smid_task - 1];

        dtmprintk(ioc, pr_info(MPT3SAS_FMT
                "sending tm: handle(0x%04x), task_type(0x%02x), smid(%d)\n",
                ioc->name, handle, type, smid_task));
        ioc->tm_cmds.status = MPT3_CMD_PENDING;
        mpi_request = mpt3sas_base_get_msg_frame(ioc, smid);
        ioc->tm_cmds.smid = smid;
        memset(mpi_request, 0, sizeof(Mpi2SCSITaskManagementRequest_t));
        memset(ioc->tm_cmds.reply, 0, sizeof(Mpi2SCSITaskManagementReply_t));
        mpi_request->Function = MPI2_FUNCTION_SCSI_TASK_MGMT;
        mpi_request->DevHandle = cpu_to_le16(handle);
        mpi_request->TaskType = type;
        mpi_request->TaskMID = cpu_to_le16(smid_task);
        int_to_scsilun(lun, (struct scsi_lun *)mpi_request->LUN);
        mpt3sas_scsih_set_tm_flag(ioc, handle);
        init_completion(&ioc->tm_cmds.done);
        if ((type == MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK) &&
                        (scsi_lookup->msix_io < ioc->reply_queue_count))
                msix_task = scsi_lookup->msix_io;
        else
                msix_task = 0;
        mpt3sas_base_put_smid_hi_priority(ioc, smid, msix_task);
        wait_for_completion_timeout(&ioc->tm_cmds.done, timeout*HZ);
        if (!(ioc->tm_cmds.status & MPT3_CMD_COMPLETE)) {
                pr_err(MPT3SAS_FMT "%s: timeout\n",
                    ioc->name, __func__);
                _debug_dump_mf(mpi_request,
                    sizeof(Mpi2SCSITaskManagementRequest_t)/4);
                if (!(ioc->tm_cmds.status & MPT3_CMD_RESET)) {
                        rc = mpt3sas_base_hard_reset_handler(ioc,
                                        FORCE_BIG_HAMMER);
                        rc = (!rc) ? SUCCESS : FAILED;
                        goto out;
                }
        }

        /* sync IRQs in case those were busy during flush. */
        mpt3sas_base_sync_reply_irqs(ioc);

        if (ioc->tm_cmds.status & MPT3_CMD_REPLY_VALID) {
                mpt3sas_trigger_master(ioc, MASTER_TRIGGER_TASK_MANAGMENT);
                mpi_reply = ioc->tm_cmds.reply;
                dtmprintk(ioc, pr_info(MPT3SAS_FMT "complete tm: " \
                    "ioc_status(0x%04x), loginfo(0x%08x), term_count(0x%08x)\n",
                    ioc->name, le16_to_cpu(mpi_reply->IOCStatus),
                    le32_to_cpu(mpi_reply->IOCLogInfo),
                    le32_to_cpu(mpi_reply->TerminationCount)));
                if (ioc->logging_level & MPT_DEBUG_TM) {
                        _scsih_response_code(ioc, mpi_reply->ResponseCode);
                        if (mpi_reply->IOCStatus)
                                _debug_dump_mf(mpi_request,
                                    sizeof(Mpi2SCSITaskManagementRequest_t)/4);
                }
        }

        switch (type) {
        case MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK:
                rc = SUCCESS;
                if (scsi_lookup->scmd == NULL)
                        break;
                rc = FAILED;
                break;

        case MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET:
                if (_scsih_scsi_lookup_find_by_target(ioc, id, channel))
                        rc = FAILED;
                else
                        rc = SUCCESS;
                break;
        case MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET:
        case MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET:
                if (_scsih_scsi_lookup_find_by_lun(ioc, id, lun, channel))
                        rc = FAILED;
                else
                        rc = SUCCESS;
                break;
        case MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK:
                rc = SUCCESS;
                break;
        default:
                rc = FAILED;
                break;
        }

out:
        mpt3sas_scsih_clear_tm_flag(ioc, handle);
        ioc->tm_cmds.status = MPT3_CMD_NOT_USED;
        return rc;
}

int mpt3sas_scsih_issue_locked_tm(struct MPT3SAS_ADAPTER *ioc, u16 handle,
        uint channel, uint id, uint lun, u8 type, u16 smid_task, ulong timeout)
{
        int ret;

        mutex_lock(&ioc->tm_cmds.mutex);
        ret = mpt3sas_scsih_issue_tm(ioc, handle, channel, id, lun, type,
                        smid_task, timeout);
        mutex_unlock(&ioc->tm_cmds.mutex);

        return ret;
}

/**
 * _scsih_tm_display_info - displays info about the device
 * @ioc: per adapter struct
 * @scmd: pointer to scsi command object
 *
 * Called by task management callback handlers.
 */
static void
_scsih_tm_display_info(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd *scmd)
{
        struct scsi_target *starget = scmd->device->sdev_target;
        struct MPT3SAS_TARGET *priv_target = starget->hostdata;
        struct _sas_device *sas_device = NULL;
        unsigned long flags;
        char *device_str = NULL;

        if (!priv_target)
                return;
        if (ioc->hide_ir_msg)
                device_str = "WarpDrive";
        else
                device_str = "volume";

        scsi_print_command(scmd);
        if (priv_target->flags & MPT_TARGET_FLAGS_VOLUME) {
                starget_printk(KERN_INFO, starget,
                        "%s handle(0x%04x), %s wwid(0x%016llx)\n",
                        device_str, priv_target->handle,
                    device_str, (unsigned long long)priv_target->sas_address);
        } else {
                spin_lock_irqsave(&ioc->sas_device_lock, flags);
                sas_device = __mpt3sas_get_sdev_from_target(ioc, priv_target);
                if (sas_device) {
                        if (priv_target->flags &
                            MPT_TARGET_FLAGS_RAID_COMPONENT) {
                                starget_printk(KERN_INFO, starget,
                                    "volume handle(0x%04x), "
                                    "volume wwid(0x%016llx)\n",
                                    sas_device->volume_handle,
                                   (unsigned long long)sas_device->volume_wwid);
                        }
                        starget_printk(KERN_INFO, starget,
                            "handle(0x%04x), sas_address(0x%016llx), phy(%d)\n",
                            sas_device->handle,
                            (unsigned long long)sas_device->sas_address,
                            sas_device->phy);
                        if (sas_device->enclosure_handle != 0)
                                starget_printk(KERN_INFO, starget,
                                 "enclosure_logical_id(0x%016llx), slot(%d)\n",
                                 (unsigned long long)
                                 sas_device->enclosure_logical_id,
                                 sas_device->slot);
                        if (sas_device->connector_name[0] != '\0')
                                starget_printk(KERN_INFO, starget,
                                "enclosure level(0x%04x),connector name(%s)\n",
                                 sas_device->enclosure_level,
                                 sas_device->connector_name);

                        sas_device_put(sas_device);
                }
                spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
        }
}

/**
 * scsih_abort - eh threads main abort routine
 * @scmd: pointer to scsi command object
 *
 * Returns SUCCESS if command aborted else FAILED
 */
static int
scsih_abort(struct scsi_cmnd *scmd)
{
        struct MPT3SAS_ADAPTER *ioc = shost_priv(scmd->device->host);
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        u16 smid;
        u16 handle;
        int r;

        sdev_printk(KERN_INFO, scmd->device,
                "attempting task abort! scmd(%p)\n", scmd);
        _scsih_tm_display_info(ioc, scmd);

        sas_device_priv_data = scmd->device->hostdata;
        if (!sas_device_priv_data || !sas_device_priv_data->sas_target) {
                sdev_printk(KERN_INFO, scmd->device,
                        "device been deleted! scmd(%p)\n", scmd);
                scmd->result = DID_NO_CONNECT << 16;
                scmd->scsi_done(scmd);
                r = SUCCESS;
                goto out;
        }

        /* search for the command */
        smid = _scsih_scsi_lookup_find_by_scmd(ioc, scmd);
        if (!smid) {
                scmd->result = DID_RESET << 16;
                r = SUCCESS;
                goto out;
        }

        /* for hidden raid components and volumes this is not supported */
        if (sas_device_priv_data->sas_target->flags &
            MPT_TARGET_FLAGS_RAID_COMPONENT ||
            sas_device_priv_data->sas_target->flags & MPT_TARGET_FLAGS_VOLUME) {
                scmd->result = DID_RESET << 16;
                r = FAILED;
                goto out;
        }

        mpt3sas_halt_firmware(ioc);

        handle = sas_device_priv_data->sas_target->handle;
        r = mpt3sas_scsih_issue_locked_tm(ioc, handle, scmd->device->channel,
            scmd->device->id, scmd->device->lun,
            MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK, smid, 30);

 out:
        sdev_printk(KERN_INFO, scmd->device, "task abort: %s scmd(%p)\n",
            ((r == SUCCESS) ? "SUCCESS" : "FAILED"), scmd);
        return r;
}

/**
 * scsih_dev_reset - eh threads main device reset routine
 * @scmd: pointer to scsi command object
 *
 * Returns SUCCESS if command aborted else FAILED
 */
static int
scsih_dev_reset(struct scsi_cmnd *scmd)
{
        struct MPT3SAS_ADAPTER *ioc = shost_priv(scmd->device->host);
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct _sas_device *sas_device = NULL;
        u16     handle;
        int r;

        struct scsi_target *starget = scmd->device->sdev_target;
        struct MPT3SAS_TARGET *target_priv_data = starget->hostdata;

        sdev_printk(KERN_INFO, scmd->device,
                "attempting device reset! scmd(%p)\n", scmd);
        _scsih_tm_display_info(ioc, scmd);

        sas_device_priv_data = scmd->device->hostdata;
        if (!sas_device_priv_data || !sas_device_priv_data->sas_target) {
                sdev_printk(KERN_INFO, scmd->device,
                        "device been deleted! scmd(%p)\n", scmd);
                scmd->result = DID_NO_CONNECT << 16;
                scmd->scsi_done(scmd);
                r = SUCCESS;
                goto out;
        }

        /* for hidden raid components obtain the volume_handle */
        handle = 0;
        if (sas_device_priv_data->sas_target->flags &
            MPT_TARGET_FLAGS_RAID_COMPONENT) {
                sas_device = mpt3sas_get_sdev_from_target(ioc,
                                target_priv_data);
                if (sas_device)
                        handle = sas_device->volume_handle;
        } else
                handle = sas_device_priv_data->sas_target->handle;

        if (!handle) {
                scmd->result = DID_RESET << 16;
                r = FAILED;
                goto out;
        }

        r = mpt3sas_scsih_issue_locked_tm(ioc, handle, scmd->device->channel,
            scmd->device->id, scmd->device->lun,
            MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET, 0, 30);

 out:
        sdev_printk(KERN_INFO, scmd->device, "device reset: %s scmd(%p)\n",
            ((r == SUCCESS) ? "SUCCESS" : "FAILED"), scmd);

        if (sas_device)
                sas_device_put(sas_device);

        return r;
}

/**
 * scsih_target_reset - eh threads main target reset routine
 * @scmd: pointer to scsi command object
 *
 * Returns SUCCESS if command aborted else FAILED
 */
static int
scsih_target_reset(struct scsi_cmnd *scmd)
{
        struct MPT3SAS_ADAPTER *ioc = shost_priv(scmd->device->host);
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct _sas_device *sas_device = NULL;
        u16     handle;
        int r;
        struct scsi_target *starget = scmd->device->sdev_target;
        struct MPT3SAS_TARGET *target_priv_data = starget->hostdata;

        starget_printk(KERN_INFO, starget, "attempting target reset! scmd(%p)\n",
                scmd);
        _scsih_tm_display_info(ioc, scmd);

        sas_device_priv_data = scmd->device->hostdata;
        if (!sas_device_priv_data || !sas_device_priv_data->sas_target) {
                starget_printk(KERN_INFO, starget, "target been deleted! scmd(%p)\n",
                        scmd);
                scmd->result = DID_NO_CONNECT << 16;
                scmd->scsi_done(scmd);
                r = SUCCESS;
                goto out;
        }

        /* for hidden raid components obtain the volume_handle */
        handle = 0;
        if (sas_device_priv_data->sas_target->flags &
            MPT_TARGET_FLAGS_RAID_COMPONENT) {
                sas_device = mpt3sas_get_sdev_from_target(ioc,
                                target_priv_data);
                if (sas_device)
                        handle = sas_device->volume_handle;
        } else
                handle = sas_device_priv_data->sas_target->handle;

        if (!handle) {
                scmd->result = DID_RESET << 16;
                r = FAILED;
                goto out;
        }

        r = mpt3sas_scsih_issue_locked_tm(ioc, handle, scmd->device->channel,
            scmd->device->id, 0, MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET, 0,
            30);

 out:
        starget_printk(KERN_INFO, starget, "target reset: %s scmd(%p)\n",
            ((r == SUCCESS) ? "SUCCESS" : "FAILED"), scmd);

        if (sas_device)
                sas_device_put(sas_device);

        return r;
}


/**
 * scsih_host_reset - eh threads main host reset routine
 * @scmd: pointer to scsi command object
 *
 * Returns SUCCESS if command aborted else FAILED
 */
static int
scsih_host_reset(struct scsi_cmnd *scmd)
{
        struct MPT3SAS_ADAPTER *ioc = shost_priv(scmd->device->host);
        int r, retval;

        pr_info(MPT3SAS_FMT "attempting host reset! scmd(%p)\n",
            ioc->name, scmd);
        scsi_print_command(scmd);

        if (ioc->is_driver_loading) {
                pr_info(MPT3SAS_FMT "Blocking the host reset\n",
                    ioc->name);
                r = FAILED;
                goto out;
        }

        retval = mpt3sas_base_hard_reset_handler(ioc, FORCE_BIG_HAMMER);
        r = (retval < 0) ? FAILED : SUCCESS;
out:
        pr_info(MPT3SAS_FMT "host reset: %s scmd(%p)\n",
            ioc->name, ((r == SUCCESS) ? "SUCCESS" : "FAILED"), scmd);

        return r;
}

/**
 * _scsih_fw_event_add - insert and queue up fw_event
 * @ioc: per adapter object
 * @fw_event: object describing the event
 * Context: This function will acquire ioc->fw_event_lock.
 *
 * This adds the firmware event object into link list, then queues it up to
 * be processed from user context.
 *
 * Return nothing.
 */
static void
_scsih_fw_event_add(struct MPT3SAS_ADAPTER *ioc, struct fw_event_work *fw_event)
{
        unsigned long flags;

        if (ioc->firmware_event_thread == NULL)
                return;

        spin_lock_irqsave(&ioc->fw_event_lock, flags);
        fw_event_work_get(fw_event);
        INIT_LIST_HEAD(&fw_event->list);
        list_add_tail(&fw_event->list, &ioc->fw_event_list);
        INIT_WORK(&fw_event->work, _firmware_event_work);
        fw_event_work_get(fw_event);
        queue_work(ioc->firmware_event_thread, &fw_event->work);
        spin_unlock_irqrestore(&ioc->fw_event_lock, flags);
}

/**
 * _scsih_fw_event_del_from_list - delete fw_event from the list
 * @ioc: per adapter object
 * @fw_event: object describing the event
 * Context: This function will acquire ioc->fw_event_lock.
 *
 * If the fw_event is on the fw_event_list, remove it and do a put.
 *
 * Return nothing.
 */
static void
_scsih_fw_event_del_from_list(struct MPT3SAS_ADAPTER *ioc, struct fw_event_work
        *fw_event)
{
        unsigned long flags;

        spin_lock_irqsave(&ioc->fw_event_lock, flags);
        if (!list_empty(&fw_event->list)) {
                list_del_init(&fw_event->list);
                fw_event_work_put(fw_event);
        }
        spin_unlock_irqrestore(&ioc->fw_event_lock, flags);
}


 /**
 * mpt3sas_send_trigger_data_event - send event for processing trigger data
 * @ioc: per adapter object
 * @event_data: trigger event data
 *
 * Return nothing.
 */
void
mpt3sas_send_trigger_data_event(struct MPT3SAS_ADAPTER *ioc,
        struct SL_WH_TRIGGERS_EVENT_DATA_T *event_data)
{
        struct fw_event_work *fw_event;
        u16 sz;

        if (ioc->is_driver_loading)
                return;
        sz = sizeof(*event_data);
        fw_event = alloc_fw_event_work(sz);
        if (!fw_event)
                return;
        fw_event->event = MPT3SAS_PROCESS_TRIGGER_DIAG;
        fw_event->ioc = ioc;
        memcpy(fw_event->event_data, event_data, sizeof(*event_data));
        _scsih_fw_event_add(ioc, fw_event);
        fw_event_work_put(fw_event);
}

/**
 * _scsih_error_recovery_delete_devices - remove devices not responding
 * @ioc: per adapter object
 *
 * Return nothing.
 */
static void
_scsih_error_recovery_delete_devices(struct MPT3SAS_ADAPTER *ioc)
{
        struct fw_event_work *fw_event;

        if (ioc->is_driver_loading)
                return;
        fw_event = alloc_fw_event_work(0);
        if (!fw_event)
                return;
        fw_event->event = MPT3SAS_REMOVE_UNRESPONDING_DEVICES;
        fw_event->ioc = ioc;
        _scsih_fw_event_add(ioc, fw_event);
        fw_event_work_put(fw_event);
}

/**
 * mpt3sas_port_enable_complete - port enable completed (fake event)
 * @ioc: per adapter object
 *
 * Return nothing.
 */
void
mpt3sas_port_enable_complete(struct MPT3SAS_ADAPTER *ioc)
{
        struct fw_event_work *fw_event;

        fw_event = alloc_fw_event_work(0);
        if (!fw_event)
                return;
        fw_event->event = MPT3SAS_PORT_ENABLE_COMPLETE;
        fw_event->ioc = ioc;
        _scsih_fw_event_add(ioc, fw_event);
        fw_event_work_put(fw_event);
}

static struct fw_event_work *dequeue_next_fw_event(struct MPT3SAS_ADAPTER *ioc)
{
        unsigned long flags;
        struct fw_event_work *fw_event = NULL;

        spin_lock_irqsave(&ioc->fw_event_lock, flags);
        if (!list_empty(&ioc->fw_event_list)) {
                fw_event = list_first_entry(&ioc->fw_event_list,
                                struct fw_event_work, list);
                list_del_init(&fw_event->list);
        }
        spin_unlock_irqrestore(&ioc->fw_event_lock, flags);

        return fw_event;
}

/**
 * _scsih_fw_event_cleanup_queue - cleanup event queue
 * @ioc: per adapter object
 *
 * Walk the firmware event queue, either killing timers, or waiting
 * for outstanding events to complete
 *
 * Return nothing.
 */
static void
_scsih_fw_event_cleanup_queue(struct MPT3SAS_ADAPTER *ioc)
{
        struct fw_event_work *fw_event;

        if (list_empty(&ioc->fw_event_list) ||
             !ioc->firmware_event_thread || in_interrupt())
                return;

        while ((fw_event = dequeue_next_fw_event(ioc))) {
                /*
                 * Wait on the fw_event to complete. If this returns 1, then
                 * the event was never executed, and we need a put for the
                 * reference the work had on the fw_event.
                 *
                 * If it did execute, we wait for it to finish, and the put will
                 * happen from _firmware_event_work()
                 */
                if (cancel_work_sync(&fw_event->work))
                        fw_event_work_put(fw_event);

                fw_event_work_put(fw_event);
        }
}

/**
 * _scsih_internal_device_block - block the sdev device
 * @sdev: per device object
 * @sas_device_priv_data : per device driver private data
 *
 * make sure device is blocked without error, if not
 * print an error
 */
static void
_scsih_internal_device_block(struct scsi_device *sdev,
                        struct MPT3SAS_DEVICE *sas_device_priv_data)
{
        int r = 0;

        sdev_printk(KERN_INFO, sdev, "device_block, handle(0x%04x)\n",
            sas_device_priv_data->sas_target->handle);
        sas_device_priv_data->block = 1;

        r = scsi_internal_device_block(sdev);
        if (r == -EINVAL)
                sdev_printk(KERN_WARNING, sdev,
                    "device_block failed with return(%d) for handle(0x%04x)\n",
                    sas_device_priv_data->sas_target->handle, r);
}

/**
 * _scsih_internal_device_unblock - unblock the sdev device
 * @sdev: per device object
 * @sas_device_priv_data : per device driver private data
 * make sure device is unblocked without error, if not retry
 * by blocking and then unblocking
 */

static void
_scsih_internal_device_unblock(struct scsi_device *sdev,
                        struct MPT3SAS_DEVICE *sas_device_priv_data)
{
        int r = 0;

        sdev_printk(KERN_WARNING, sdev, "device_unblock and setting to running, "
            "handle(0x%04x)\n", sas_device_priv_data->sas_target->handle);
        sas_device_priv_data->block = 0;
        r = scsi_internal_device_unblock(sdev, SDEV_RUNNING);
        if (r == -EINVAL) {
                /* The device has been set to SDEV_RUNNING by SD layer during
                 * device addition but the request queue is still stopped by
                 * our earlier block call. We need to perform a block again
                 * to get the device to SDEV_BLOCK and then to SDEV_RUNNING */

                sdev_printk(KERN_WARNING, sdev,
                    "device_unblock failed with return(%d) for handle(0x%04x) "
                    "performing a block followed by an unblock\n",
                    sas_device_priv_data->sas_target->handle, r);
                sas_device_priv_data->block = 1;
                r = scsi_internal_device_block(sdev);
                if (r)
                        sdev_printk(KERN_WARNING, sdev, "retried device_block "
                            "failed with return(%d) for handle(0x%04x)\n",
                            sas_device_priv_data->sas_target->handle, r);

                sas_device_priv_data->block = 0;
                r = scsi_internal_device_unblock(sdev, SDEV_RUNNING);
                if (r)
                        sdev_printk(KERN_WARNING, sdev, "retried device_unblock"
                            " failed with return(%d) for handle(0x%04x)\n",
                            sas_device_priv_data->sas_target->handle, r);
        }
}

/**
 * _scsih_ublock_io_all_device - unblock every device
 * @ioc: per adapter object
 *
 * change the device state from block to running
 */
static void
_scsih_ublock_io_all_device(struct MPT3SAS_ADAPTER *ioc)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;

        shost_for_each_device(sdev, ioc->shost) {
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (!sas_device_priv_data->block)
                        continue;

                dewtprintk(ioc, sdev_printk(KERN_INFO, sdev,
                        "device_running, handle(0x%04x)\n",
                    sas_device_priv_data->sas_target->handle));
                _scsih_internal_device_unblock(sdev, sas_device_priv_data);
        }
}


/**
 * _scsih_ublock_io_device - prepare device to be deleted
 * @ioc: per adapter object
 * @sas_addr: sas address
 *
 * unblock then put device in offline state
 */
static void
_scsih_ublock_io_device(struct MPT3SAS_ADAPTER *ioc, u64 sas_address)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;

        shost_for_each_device(sdev, ioc->shost) {
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (sas_device_priv_data->sas_target->sas_address
                    != sas_address)
                        continue;
                if (sas_device_priv_data->block)
                        _scsih_internal_device_unblock(sdev,
                                sas_device_priv_data);
        }
}

/**
 * _scsih_block_io_all_device - set the device state to SDEV_BLOCK
 * @ioc: per adapter object
 * @handle: device handle
 *
 * During device pull we need to appropiately set the sdev state.
 */
static void
_scsih_block_io_all_device(struct MPT3SAS_ADAPTER *ioc)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;

        shost_for_each_device(sdev, ioc->shost) {
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (sas_device_priv_data->block)
                        continue;
                if (sas_device_priv_data->ignore_delay_remove) {
                        sdev_printk(KERN_INFO, sdev,
                        "%s skip device_block for SES handle(0x%04x)\n",
                        __func__, sas_device_priv_data->sas_target->handle);
                        continue;
                }
                _scsih_internal_device_block(sdev, sas_device_priv_data);
        }
}

/**
 * _scsih_block_io_device - set the device state to SDEV_BLOCK
 * @ioc: per adapter object
 * @handle: device handle
 *
 * During device pull we need to appropiately set the sdev state.
 */
static void
_scsih_block_io_device(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct MPT3SAS_DEVICE *sas_device_priv_data;
        struct scsi_device *sdev;
        struct _sas_device *sas_device;

        sas_device = mpt3sas_get_sdev_by_handle(ioc, handle);
        if (!sas_device)
                return;

        shost_for_each_device(sdev, ioc->shost) {
                sas_device_priv_data = sdev->hostdata;
                if (!sas_device_priv_data)
                        continue;
                if (sas_device_priv_data->sas_target->handle != handle)
                        continue;
                if (sas_device_priv_data->block)
                        continue;
                if (sas_device->pend_sas_rphy_add)
                        continue;
                if (sas_device_priv_data->ignore_delay_remove) {
                        sdev_printk(KERN_INFO, sdev,
                        "%s skip device_block for SES handle(0x%04x)\n",
                        __func__, sas_device_priv_data->sas_target->handle);

                        continue;
                }
                _scsih_internal_device_block(sdev, sas_device_priv_data);
        }

        sas_device_put(sas_device);
}

/**
 * _scsih_block_io_to_children_attached_to_ex
 * @ioc: per adapter object
 * @sas_expander: the sas_device object
 *
 * This routine set sdev state to SDEV_BLOCK for all devices
 * attached to this expander. This function called when expander is
 * pulled.
 */
static void
_scsih_block_io_to_children_attached_to_ex(struct MPT3SAS_ADAPTER *ioc,
        struct _sas_node *sas_expander)
{
        struct _sas_port *mpt3sas_port;
        struct _sas_device *sas_device;
        struct _sas_node *expander_sibling;
        unsigned long flags;

        if (!sas_expander)
                return;

        list_for_each_entry(mpt3sas_port,
           &sas_expander->sas_port_list, port_list) {
                if (mpt3sas_port->remote_identify.device_type ==
                    SAS_END_DEVICE) {
                        spin_lock_irqsave(&ioc->sas_device_lock, flags);
                        sas_device = __mpt3sas_get_sdev_by_addr(ioc,
                            mpt3sas_port->remote_identify.sas_address);
                        if (sas_device) {
                                set_bit(sas_device->handle,
                                                ioc->blocking_handles);
                                sas_device_put(sas_device);
                        }
                        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);
                }
        }

        list_for_each_entry(mpt3sas_port,
           &sas_expander->sas_port_list, port_list) {

                if (mpt3sas_port->remote_identify.device_type ==
                    SAS_EDGE_EXPANDER_DEVICE ||
                    mpt3sas_port->remote_identify.device_type ==
                    SAS_FANOUT_EXPANDER_DEVICE) {
                        expander_sibling =
                            mpt3sas_scsih_expander_find_by_sas_address(
                            ioc, mpt3sas_port->remote_identify.sas_address);
                        _scsih_block_io_to_children_attached_to_ex(ioc,
                            expander_sibling);
                }
        }
}

/**
 * _scsih_block_io_to_children_attached_directly
 * @ioc: per adapter object
 * @event_data: topology change event data
 *
 * This routine set sdev state to SDEV_BLOCK for all devices
 * direct attached during device pull.
 */
static void
_scsih_block_io_to_children_attached_directly(struct MPT3SAS_ADAPTER *ioc,
        Mpi2EventDataSasTopologyChangeList_t *event_data)
{
        int i;
        u16 handle;
        u16 reason_code;

        for (i = 0; i < event_data->NumEntries; i++) {
                handle = le16_to_cpu(event_data->PHY[i].AttachedDevHandle);
                if (!handle)
                        continue;
                reason_code = event_data->PHY[i].PhyStatus &
                    MPI2_EVENT_SAS_TOPO_RC_MASK;
                if (reason_code == MPI2_EVENT_SAS_TOPO_RC_DELAY_NOT_RESPONDING)
                        _scsih_block_io_device(ioc, handle);
        }
}

/**
 * _scsih_tm_tr_send - send task management request
 * @ioc: per adapter object
 * @handle: device handle
 * Context: interrupt time.
 *
 * This code is to initiate the device removal handshake protocol
 * with controller firmware.  This function will issue target reset
 * using high priority request queue.  It will send a sas iounit
 * control request (MPI2_SAS_OP_REMOVE_DEVICE) from this completion.
 *
 * This is designed to send muliple task management request at the same
 * time to the fifo. If the fifo is full, we will append the request,
 * and process it in a future completion.
 */
static void
_scsih_tm_tr_send(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        Mpi2SCSITaskManagementRequest_t *mpi_request;
        u16 smid;
        struct _sas_device *sas_device = NULL;
        struct MPT3SAS_TARGET *sas_target_priv_data = NULL;
        u64 sas_address = 0;
        unsigned long flags;
        struct _tr_list *delayed_tr;
        u32 ioc_state;

        if (ioc->remove_host) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host has been removed: handle(0x%04x)\n",
                        __func__, ioc->name, handle));
                return;
        } else if (ioc->pci_error_recovery) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host in pci error recovery: handle(0x%04x)\n",
                        __func__, ioc->name,
                    handle));
                return;
        }
        ioc_state = mpt3sas_base_get_iocstate(ioc, 1);
        if (ioc_state != MPI2_IOC_STATE_OPERATIONAL) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host is not operational: handle(0x%04x)\n",
                        __func__, ioc->name,
                   handle));
                return;
        }

        /* if PD, then return */
        if (test_bit(handle, ioc->pd_handles))
                return;

        spin_lock_irqsave(&ioc->sas_device_lock, flags);
        sas_device = __mpt3sas_get_sdev_by_handle(ioc, handle);
        if (sas_device && sas_device->starget &&
            sas_device->starget->hostdata) {
                sas_target_priv_data = sas_device->starget->hostdata;
                sas_target_priv_data->deleted = 1;
                sas_address = sas_device->sas_address;
        }
        spin_unlock_irqrestore(&ioc->sas_device_lock, flags);

        if (sas_target_priv_data) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "setting delete flag: handle(0x%04x), sas_addr(0x%016llx)\n",
                        ioc->name, handle,
                    (unsigned long long)sas_address));
                if (sas_device->enclosure_handle != 0)
                        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                         "setting delete flag:enclosure logical id(0x%016llx),"
                         " slot(%d)\n", ioc->name, (unsigned long long)
                          sas_device->enclosure_logical_id,
                          sas_device->slot));
                if (sas_device->connector_name[0] != '\0')
                        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                         "setting delete flag: enclosure level(0x%04x),"
                         " connector name( %s)\n", ioc->name,
                          sas_device->enclosure_level,
                          sas_device->connector_name));
                _scsih_ublock_io_device(ioc, sas_address);
                sas_target_priv_data->handle = MPT3SAS_INVALID_DEVICE_HANDLE;
        }

        smid = mpt3sas_base_get_smid_hpr(ioc, ioc->tm_tr_cb_idx);
        if (!smid) {
                delayed_tr = kzalloc(sizeof(*delayed_tr), GFP_ATOMIC);
                if (!delayed_tr)
                        goto out;
                INIT_LIST_HEAD(&delayed_tr->list);
                delayed_tr->handle = handle;
                list_add_tail(&delayed_tr->list, &ioc->delayed_tr_list);
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "DELAYED:tr:handle(0x%04x), (open)\n",
                    ioc->name, handle));
                goto out;
        }

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "tr_send:handle(0x%04x), (open), smid(%d), cb(%d)\n",
                ioc->name, handle, smid,
            ioc->tm_tr_cb_idx));
        mpi_request = mpt3sas_base_get_msg_frame(ioc, smid);
        memset(mpi_request, 0, sizeof(Mpi2SCSITaskManagementRequest_t));
        mpi_request->Function = MPI2_FUNCTION_SCSI_TASK_MGMT;
        mpi_request->DevHandle = cpu_to_le16(handle);
        mpi_request->TaskType = MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET;
        mpt3sas_base_put_smid_hi_priority(ioc, smid, 0);
        mpt3sas_trigger_master(ioc, MASTER_TRIGGER_DEVICE_REMOVAL);

out:
        if (sas_device)
                sas_device_put(sas_device);
}

/**
 * _scsih_tm_tr_complete -
 * @ioc: per adapter object
 * @smid: system request message index
 * @msix_index: MSIX table index supplied by the OS
 * @reply: reply message frame(lower 32bit addr)
 * Context: interrupt time.
 *
 * This is the target reset completion routine.
 * This code is part of the code to initiate the device removal
 * handshake protocol with controller firmware.
 * It will send a sas iounit control request (MPI2_SAS_OP_REMOVE_DEVICE)
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
static u8
_scsih_tm_tr_complete(struct MPT3SAS_ADAPTER *ioc, u16 smid, u8 msix_index,
        u32 reply)
{
        u16 handle;
        Mpi2SCSITaskManagementRequest_t *mpi_request_tm;
        Mpi2SCSITaskManagementReply_t *mpi_reply =
            mpt3sas_base_get_reply_virt_addr(ioc, reply);
        Mpi2SasIoUnitControlRequest_t *mpi_request;
        u16 smid_sas_ctrl;
        u32 ioc_state;
        struct _sc_list *delayed_sc;

        if (ioc->remove_host) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host has been removed\n", __func__, ioc->name));
                return 1;
        } else if (ioc->pci_error_recovery) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host in pci error recovery\n", __func__,
                        ioc->name));
                return 1;
        }
        ioc_state = mpt3sas_base_get_iocstate(ioc, 1);
        if (ioc_state != MPI2_IOC_STATE_OPERATIONAL) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host is not operational\n", __func__, ioc->name));
                return 1;
        }
        if (unlikely(!mpi_reply)) {
                pr_err(MPT3SAS_FMT "mpi_reply not valid at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                return 1;
        }
        mpi_request_tm = mpt3sas_base_get_msg_frame(ioc, smid);
        handle = le16_to_cpu(mpi_request_tm->DevHandle);
        if (handle != le16_to_cpu(mpi_reply->DevHandle)) {
                dewtprintk(ioc, pr_err(MPT3SAS_FMT
                        "spurious interrupt: handle(0x%04x:0x%04x), smid(%d)!!!\n",
                        ioc->name, handle,
                    le16_to_cpu(mpi_reply->DevHandle), smid));
                return 0;
        }

        mpt3sas_trigger_master(ioc, MASTER_TRIGGER_TASK_MANAGMENT);
        dewtprintk(ioc, pr_info(MPT3SAS_FMT
            "tr_complete:handle(0x%04x), (open) smid(%d), ioc_status(0x%04x), "
            "loginfo(0x%08x), completed(%d)\n", ioc->name,
            handle, smid, le16_to_cpu(mpi_reply->IOCStatus),
            le32_to_cpu(mpi_reply->IOCLogInfo),
            le32_to_cpu(mpi_reply->TerminationCount)));

        smid_sas_ctrl = mpt3sas_base_get_smid(ioc, ioc->tm_sas_control_cb_idx);
        if (!smid_sas_ctrl) {
                delayed_sc = kzalloc(sizeof(*delayed_sc), GFP_ATOMIC);
                if (!delayed_sc)
                        return _scsih_check_for_pending_tm(ioc, smid);
                INIT_LIST_HEAD(&delayed_sc->list);
                delayed_sc->handle = mpi_request_tm->DevHandle;
                list_add_tail(&delayed_sc->list, &ioc->delayed_sc_list);
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "DELAYED:sc:handle(0x%04x), (open)\n",
                    ioc->name, handle));
                return _scsih_check_for_pending_tm(ioc, smid);
        }

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "sc_send:handle(0x%04x), (open), smid(%d), cb(%d)\n",
                ioc->name, handle, smid_sas_ctrl,
            ioc->tm_sas_control_cb_idx));
        mpi_request = mpt3sas_base_get_msg_frame(ioc, smid_sas_ctrl);
        memset(mpi_request, 0, sizeof(Mpi2SasIoUnitControlRequest_t));
        mpi_request->Function = MPI2_FUNCTION_SAS_IO_UNIT_CONTROL;
        mpi_request->Operation = MPI2_SAS_OP_REMOVE_DEVICE;
        mpi_request->DevHandle = mpi_request_tm->DevHandle;
        mpt3sas_base_put_smid_default(ioc, smid_sas_ctrl);

        return _scsih_check_for_pending_tm(ioc, smid);
}


/**
 * _scsih_sas_control_complete - completion routine
 * @ioc: per adapter object
 * @smid: system request message index
 * @msix_index: MSIX table index supplied by the OS
 * @reply: reply message frame(lower 32bit addr)
 * Context: interrupt time.
 *
 * This is the sas iounit control completion routine.
 * This code is part of the code to initiate the device removal
 * handshake protocol with controller firmware.
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
static u8
_scsih_sas_control_complete(struct MPT3SAS_ADAPTER *ioc, u16 smid,
        u8 msix_index, u32 reply)
{
        Mpi2SasIoUnitControlReply_t *mpi_reply =
            mpt3sas_base_get_reply_virt_addr(ioc, reply);

        if (likely(mpi_reply)) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "sc_complete:handle(0x%04x), (open) "
                "smid(%d), ioc_status(0x%04x), loginfo(0x%08x)\n",
                ioc->name, le16_to_cpu(mpi_reply->DevHandle), smid,
                le16_to_cpu(mpi_reply->IOCStatus),
                le32_to_cpu(mpi_reply->IOCLogInfo)));
        } else {
                pr_err(MPT3SAS_FMT "mpi_reply not valid at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
        }
        return mpt3sas_check_for_pending_internal_cmds(ioc, smid);
}

/**
 * _scsih_tm_tr_volume_send - send target reset request for volumes
 * @ioc: per adapter object
 * @handle: device handle
 * Context: interrupt time.
 *
 * This is designed to send muliple task management request at the same
 * time to the fifo. If the fifo is full, we will append the request,
 * and process it in a future completion.
 */
static void
_scsih_tm_tr_volume_send(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        Mpi2SCSITaskManagementRequest_t *mpi_request;
        u16 smid;
        struct _tr_list *delayed_tr;

        if (ioc->shost_recovery || ioc->remove_host ||
            ioc->pci_error_recovery) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host reset in progress!\n",
                        __func__, ioc->name));
                return;
        }

        smid = mpt3sas_base_get_smid_hpr(ioc, ioc->tm_tr_volume_cb_idx);
        if (!smid) {
                delayed_tr = kzalloc(sizeof(*delayed_tr), GFP_ATOMIC);
                if (!delayed_tr)
                        return;
                INIT_LIST_HEAD(&delayed_tr->list);
                delayed_tr->handle = handle;
                list_add_tail(&delayed_tr->list, &ioc->delayed_tr_volume_list);
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "DELAYED:tr:handle(0x%04x), (open)\n",
                    ioc->name, handle));
                return;
        }

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "tr_send:handle(0x%04x), (open), smid(%d), cb(%d)\n",
                ioc->name, handle, smid,
            ioc->tm_tr_volume_cb_idx));
        mpi_request = mpt3sas_base_get_msg_frame(ioc, smid);
        memset(mpi_request, 0, sizeof(Mpi2SCSITaskManagementRequest_t));
        mpi_request->Function = MPI2_FUNCTION_SCSI_TASK_MGMT;
        mpi_request->DevHandle = cpu_to_le16(handle);
        mpi_request->TaskType = MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET;
        mpt3sas_base_put_smid_hi_priority(ioc, smid, 0);
}

/**
 * _scsih_tm_volume_tr_complete - target reset completion
 * @ioc: per adapter object
 * @smid: system request message index
 * @msix_index: MSIX table index supplied by the OS
 * @reply: reply message frame(lower 32bit addr)
 * Context: interrupt time.
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
static u8
_scsih_tm_volume_tr_complete(struct MPT3SAS_ADAPTER *ioc, u16 smid,
        u8 msix_index, u32 reply)
{
        u16 handle;
        Mpi2SCSITaskManagementRequest_t *mpi_request_tm;
        Mpi2SCSITaskManagementReply_t *mpi_reply =
            mpt3sas_base_get_reply_virt_addr(ioc, reply);

        if (ioc->shost_recovery || ioc->remove_host ||
            ioc->pci_error_recovery) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                        "%s: host reset in progress!\n",
                        __func__, ioc->name));
                return 1;
        }
        if (unlikely(!mpi_reply)) {
                pr_err(MPT3SAS_FMT "mpi_reply not valid at %s:%d/%s()!\n",
                    ioc->name, __FILE__, __LINE__, __func__);
                return 1;
        }

        mpi_request_tm = mpt3sas_base_get_msg_frame(ioc, smid);
        handle = le16_to_cpu(mpi_request_tm->DevHandle);
        if (handle != le16_to_cpu(mpi_reply->DevHandle)) {
                dewtprintk(ioc, pr_err(MPT3SAS_FMT
                        "spurious interrupt: handle(0x%04x:0x%04x), smid(%d)!!!\n",
                        ioc->name, handle,
                    le16_to_cpu(mpi_reply->DevHandle), smid));
                return 0;
        }

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
            "tr_complete:handle(0x%04x), (open) smid(%d), ioc_status(0x%04x), "
            "loginfo(0x%08x), completed(%d)\n", ioc->name,
            handle, smid, le16_to_cpu(mpi_reply->IOCStatus),
            le32_to_cpu(mpi_reply->IOCLogInfo),
            le32_to_cpu(mpi_reply->TerminationCount)));

        return _scsih_check_for_pending_tm(ioc, smid);
}

/**
 * _scsih_issue_delayed_event_ack - issue delayed Event ACK messages
 * @ioc: per adapter object
 * @smid: system request message index
 * @event: Event ID
 * @event_context: used to track events uniquely
 *
 * Context - processed in interrupt context.
 */
static void
_scsih_issue_delayed_event_ack(struct MPT3SAS_ADAPTER *ioc, u16 smid, u16 event,
                                u32 event_context)
{
        Mpi2EventAckRequest_t *ack_request;
        int i = smid - ioc->internal_smid;
        unsigned long flags;

        /* Without releasing the smid just update the
         * call back index and reuse the same smid for
         * processing this delayed request
         */
        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        ioc->internal_lookup[i].cb_idx = ioc->base_cb_idx;
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                "EVENT ACK: event(0x%04x), smid(%d), cb(%d)\n",
                ioc->name, le16_to_cpu(event), smid,
                ioc->base_cb_idx));
        ack_request = mpt3sas_base_get_msg_frame(ioc, smid);
        memset(ack_request, 0, sizeof(Mpi2EventAckRequest_t));
        ack_request->Function = MPI2_FUNCTION_EVENT_ACK;
        ack_request->Event = event;
        ack_request->EventContext = event_context;
        ack_request->VF_ID = 0;  /* TODO */
        ack_request->VP_ID = 0;
        mpt3sas_base_put_smid_default(ioc, smid);
}

/**
 * _scsih_issue_delayed_sas_io_unit_ctrl - issue delayed
 *                              sas_io_unit_ctrl messages
 * @ioc: per adapter object
 * @smid: system request message index
 * @handle: device handle
 *
 * Context - processed in interrupt context.
 */
static void
_scsih_issue_delayed_sas_io_unit_ctrl(struct MPT3SAS_ADAPTER *ioc,
                                        u16 smid, u16 handle)
        {
                Mpi2SasIoUnitControlRequest_t *mpi_request;
                u32 ioc_state;
                int i = smid - ioc->internal_smid;
                unsigned long flags;

                if (ioc->remove_host) {
                        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                            "%s: host has been removed\n",
                             __func__, ioc->name));
                        return;
                } else if (ioc->pci_error_recovery) {
                        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                            "%s: host in pci error recovery\n",
                            __func__, ioc->name));
                return;
        }
        ioc_state = mpt3sas_base_get_iocstate(ioc, 1);
        if (ioc_state != MPI2_IOC_STATE_OPERATIONAL) {
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "%s: host is not operational\n",
                    __func__, ioc->name));
                return;
        }

        /* Without releasing the smid just update the
         * call back index and reuse the same smid for
         * processing this delayed request
         */
        spin_lock_irqsave(&ioc->scsi_lookup_lock, flags);
        ioc->internal_lookup[i].cb_idx = ioc->tm_sas_control_cb_idx;
        spin_unlock_irqrestore(&ioc->scsi_lookup_lock, flags);

        dewtprintk(ioc, pr_info(MPT3SAS_FMT
            "sc_send:handle(0x%04x), (open), smid(%d), cb(%d)\n",
            ioc->name, le16_to_cpu(handle), smid,
            ioc->tm_sas_control_cb_idx));
        mpi_request = mpt3sas_base_get_msg_frame(ioc, smid);
        memset(mpi_request, 0, sizeof(Mpi2SasIoUnitControlRequest_t));
        mpi_request->Function = MPI2_FUNCTION_SAS_IO_UNIT_CONTROL;
        mpi_request->Operation = MPI2_SAS_OP_REMOVE_DEVICE;
        mpi_request->DevHandle = handle;
        mpt3sas_base_put_smid_default(ioc, smid);
}

/**
 * _scsih_check_for_pending_internal_cmds - check for pending internal messages
 * @ioc: per adapter object
 * @smid: system request message index
 *
 * Context: Executed in interrupt context
 *
 * This will check delayed internal messages list, and process the
 * next request.
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
u8
mpt3sas_check_for_pending_internal_cmds(struct MPT3SAS_ADAPTER *ioc, u16 smid)
{
        struct _sc_list *delayed_sc;
        struct _event_ack_list *delayed_event_ack;

        if (!list_empty(&ioc->delayed_event_ack_list)) {
                delayed_event_ack = list_entry(ioc->delayed_event_ack_list.next,
                                                struct _event_ack_list, list);
                _scsih_issue_delayed_event_ack(ioc, smid,
                  delayed_event_ack->Event, delayed_event_ack->EventContext);
                list_del(&delayed_event_ack->list);
                kfree(delayed_event_ack);
                return 0;
        }

        if (!list_empty(&ioc->delayed_sc_list)) {
                delayed_sc = list_entry(ioc->delayed_sc_list.next,
                                                struct _sc_list, list);
                _scsih_issue_delayed_sas_io_unit_ctrl(ioc, smid,
                                                 delayed_sc->handle);
                list_del(&delayed_sc->list);
                kfree(delayed_sc);
                return 0;
        }
        return 1;
}

/**
 * _scsih_check_for_pending_tm - check for pending task management
 * @ioc: per adapter object
 * @smid: system request message index
 *
 * This will check delayed target reset list, and feed the
 * next reqeust.
 *
 * Return 1 meaning mf should be freed from _base_interrupt
 *        0 means the mf is freed from this function.
 */
static u8
_scsih_check_for_pending_tm(struct MPT3SAS_ADAPTER *ioc, u16 smid)
{
        struct _tr_list *delayed_tr;

        if (!list_empty(&ioc->delayed_tr_volume_list)) {
                delayed_tr = list_entry(ioc->delayed_tr_volume_list.next,
                    struct _tr_list, list);
                mpt3sas_base_free_smid(ioc, smid);
                _scsih_tm_tr_volume_send(ioc, delayed_tr->handle);
                list_del(&delayed_tr->list);
                kfree(delayed_tr);
                return 0;
        }

        if (!list_empty(&ioc->delayed_tr_list)) {
                delayed_tr = list_entry(ioc->delayed_tr_list.next,
                    struct _tr_list, list);
                mpt3sas_base_free_smid(ioc, smid);
                _scsih_tm_tr_send(ioc, delayed_tr->handle);
                list_del(&delayed_tr->list);
                kfree(delayed_tr);
                return 0;
        }

        return 1;
}

/**
 * _scsih_check_topo_delete_events - sanity check on topo events
 * @ioc: per adapter object
 * @event_data: the event data payload
 *
 * This routine added to better handle cable breaker.
 *
 * This handles the case where driver receives multiple expander
 * add and delete events in a single shot.  When there is a delete event
 * the routine will void any pending add events waiting in the event queue.
 *
 * Return nothing.
 */
static void
_scsih_check_topo_delete_events(struct MPT3SAS_ADAPTER *ioc,
        Mpi2EventDataSasTopologyChangeList_t *event_data)
{
        struct fw_event_work *fw_event;
        Mpi2EventDataSasTopologyChangeList_t *local_event_data;
        u16 expander_handle;
        struct _sas_node *sas_expander;
        unsigned long flags;
        int i, reason_code;
        u16 handle;

        for (i = 0 ; i < event_data->NumEntries; i++) {
                handle = le16_to_cpu(event_data->PHY[i].AttachedDevHandle);
                if (!handle)
                        continue;
                reason_code = event_data->PHY[i].PhyStatus &
                    MPI2_EVENT_SAS_TOPO_RC_MASK;
                if (reason_code == MPI2_EVENT_SAS_TOPO_RC_TARG_NOT_RESPONDING)
                        _scsih_tm_tr_send(ioc, handle);
        }

        expander_handle = le16_to_cpu(event_data->ExpanderDevHandle);
        if (expander_handle < ioc->sas_hba.num_phys) {
                _scsih_block_io_to_children_attached_directly(ioc, event_data);
                return;
        }
        if (event_data->ExpStatus ==
            MPI2_EVENT_SAS_TOPO_ES_DELAY_NOT_RESPONDING) {
                /* put expander attached devices into blocking state */
                spin_lock_irqsave(&ioc->sas_node_lock, flags);
                sas_expander = mpt3sas_scsih_expander_find_by_handle(ioc,
                    expander_handle);
                _scsih_block_io_to_children_attached_to_ex(ioc, sas_expander);
                spin_unlock_irqrestore(&ioc->sas_node_lock, flags);
                do {
                        handle = find_first_bit(ioc->blocking_handles,
                            ioc->facts.MaxDevHandle);
                        if (handle < ioc->facts.MaxDevHandle)
                                _scsih_block_io_device(ioc, handle);
                } while (test_and_clear_bit(handle, ioc->blocking_handles));
        } else if (event_data->ExpStatus == MPI2_EVENT_SAS_TOPO_ES_RESPONDING)
                _scsih_block_io_to_children_attached_directly(ioc, event_data);

        if (event_data->ExpStatus != MPI2_EVENT_SAS_TOPO_ES_NOT_RESPONDING)
                return;

        /* mark ignore flag for pending events */
        spin_lock_irqsave(&ioc->fw_event_lock, flags);
        list_for_each_entry(fw_event, &ioc->fw_event_list, list) {
                if (fw_event->event != MPI2_EVENT_SAS_TOPOLOGY_CHANGE_LIST ||
                    fw_event->ignore)
                        continue;
                local_event_data = (Mpi2EventDataSasTopologyChangeList_t *)
                                   fw_event->event_data;
                if (local_event_data->ExpStatus ==
                    MPI2_EVENT_SAS_TOPO_ES_ADDED ||
                    local_event_data->ExpStatus ==
                    MPI2_EVENT_SAS_TOPO_ES_RESPONDING) {
                        if (le16_to_cpu(local_event_data->ExpanderDevHandle) ==
                            expander_handle) {
                                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                                    "setting ignoring flag\n", ioc->name));
                                fw_event->ignore = 1;
                        }
                }
        }
        spin_unlock_irqrestore(&ioc->fw_event_lock, flags);
}

/**
 * _scsih_set_volume_delete_flag - setting volume delete flag
 * @ioc: per adapter object
 * @handle: device handle
 *
 * This returns nothing.
 */
static void
_scsih_set_volume_delete_flag(struct MPT3SAS_ADAPTER *ioc, u16 handle)
{
        struct _raid_device *raid_device;
        struct MPT3SAS_TARGET *sas_target_priv_data;
        unsigned long flags;

        spin_lock_irqsave(&ioc->raid_device_lock, flags);
        raid_device = mpt3sas_raid_device_find_by_handle(ioc, handle);
        if (raid_device && raid_device->starget &&
            raid_device->starget->hostdata) {
                sas_target_priv_data =
                    raid_device->starget->hostdata;
                sas_target_priv_data->deleted = 1;
                dewtprintk(ioc, pr_info(MPT3SAS_FMT
                    "setting delete flag: handle(0x%04x), "
                    "wwid(0x%016llx)\n", ioc->name, handle,
                    (unsigned long long) raid_device->wwid));
        }
        spin_unlock_irqrestore(&ioc->raid_device_lock, flags);
}

/**
 * _scsih_set_volume_handle_for_tr - set handle for target reset to volume
 * @handle: input handle
 * @a: handle for volume a
 * @b: handle for volume b
 *
 * IR firmware only supports two raid volumes.  The purpose of this
 * routine is to set the volume handle in either a or b. When the given
 * input handle is non-zero, or when a and b have not been set before.
 */
static void
_scsih_set_volume_handle_for_tr(u16 handle, u16 *a, u16 *b)
{
        if (!handle || handle == *a || handle == *b)
                return;
        if (!*a)
                *a = handle;
        else if (!*b)
                *b = handle;
}

/**
 * _scsih_check_ir_config_unhide_events - check for UNHIDE events
 * @ioc: per adapter object
 * @event_data: the event data payload
 * Context: interrupt time.
 *
 * This routine will send target reset to volume, followed by target
 * resets to the PDs. This is called when a PD has been removed, or
 * volume has been deleted or removed. When the target reset is sent
 * to volume, the PD target resets need to be queued to start upon
 * completion of the volume target reset.
 *
 * Return nothing.
 */
static void
_scsih_check_ir_config_unhide_events(struct MPT3SAS_ADAPTER *ioc,
        Mpi2EventDataIrConfigChangeList_t *event_data)
{
        Mpi2EventIrConfigElement_t *element;
        int i;
        u16 handle, volume_handle, a, b;
        struct _tr_list *delayed_tr;

        a = 0;
        b = 0;

        if (ioc->is_warpdrive)
                return;

        /* Volume Resets for Deleted or Removed */
        element = (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
        for (i = 0; i < event_data->NumElements; i++, element++) {
                if (le32_to_cpu(event_data->Flags) &
                    MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG)
                        continue;
                if (element->ReasonCode ==
                    MPI2_EVENT_IR_CHANGE_RC_VOLUME_DELETED ||
                    element->ReasonCode ==
                    MPI2_EVENT_IR_CHANGE_RC_REMOVED) {
                        volume_handle = le16_to_cpu(element->VolDevHandle);
                        _scsih_set_volume_delete_flag(ioc, volume_handle);
                        _scsih_set_volume_handle_for_tr(volume_handle, &a, &b);
                }
        }

        /* Volume Resets for UNHIDE events */
        element = (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
        for (i = 0; i < event_data->NumElements; i++, element++) {
                if (le32_to_cpu(event_data->Flags) &
                    MPI2_EVENT_IR_CHANGE_FLAGS_FOREIGN_CONFIG)
                        continue;
                if (element->ReasonCode == MPI2_EVENT_IR_CHANGE_RC_UNHIDE) {
                        volume_handle = le16_to_cpu(element->VolDevHandle);
                        _scsih_set_volume_handle_for_tr(volume_handle, &a, &b);
                }
        }

        if (a)
                _scsih_tm_tr_volume_send(ioc, a);
        if (b)
                _scsih_tm_tr_volume_send(ioc, b);

        /* PD target resets */
        element = (Mpi2EventIrConfigElement_t *)&event_data->ConfigElement[0];
        for (i = 0; i < event_data->NumElements; i++, element++) {
                if (element->ReasonCode != MPI2_EVENT_IR_CHANGE_RC_UNHIDE)
                        continue;
                handle = le16_to_cpu(element->PhysDiskDevHandle);
                volume_handle = le16_to_cpu(element->VolDevHandle);
                clear_bit(handle, ioc->pd_handles);
                if (!volume_handle)
                        _scsih_tm_tr_send(ioc, handle);
                else if (volume_handle == a || volume_handle == b) {
                        delayed_tr = kzalloc(sizeof(*delayed_tr), GFP_ATOMIC);
                        BUG_ON(!delayed_tr);
                        INIT_LIST_HEAD(&delayed_tr->list);
                        delayed_tr->handle = handle;
                        list_add_tail(&delayed_tr->list, &ioc->delayed_tr_list);
                        dewtprintk(ioc, pr_info(MPT3SAS_FMT
                            "DELAYED:tr:handle(0x%04x), (open)\n", ioc->name,
                            handle));
                } else
                        _scsih_tm_tr_send(ioc, handle);
        }
}


/**
 * _scsih_check_volume_delete_events - set delete flag for volumes
 * @ioc: per adapter object
 * @event_data: the event data payload
 * Context: interrupt time.
 *
 * This will handle the case when the cable connected to entire volume is
 * pulled. We will take care of setting the deleted flag so normal IO will
 * not be sent.
 *
 * Return nothing.
 */
static void
_scsih_check_volume_delete_events(struct MPT3SAS_ADAPTER *ioc,
        Mpi2EventDataIrVolume_t *event_data)
{
        u32 state;

        if (event_data->ReasonCode != MPI2_EVENT_IR_VOLUME_RC_STATE_CHANGED)
                return;
        state = le32_to_cpu(event_data->NewValue);
        if (state == MPI2_RAID_VOL_STATE_MISSING || state ==
            MPI2_RAID_VOL_STATE_FAILED)
                _scsih_set_volume_delete_flag(ioc,
                    le16_to_cpu(event_data->VolDevHandle));
}

/**
 * _scsih_temp_threshold_events - display temperature threshold exceeded events
 * @ioc: per adapter object
 * @event_data: the temp threshold event data
 * Context: interrupt time.
 *
 * Return nothing.
 */
static void
_scsih_temp_threshold_events(struct MPT3SAS_ADAPTER *ioc,
        Mpi2EventDataTemperature_t *event_data)
{
        if (ioc->temp_sensors_count >= event_data->SensorNum) {
                pr_err(MPT3SAS_FMT "Temperature Threshold flags %s%s%s%s"
                  " exceeded for Sensor: %d !!!\n", ioc->name,
                  ((le16_to_cpu(event_data->Status) & 0x1) == 1) ? "0 " : " ",
                  ((le16_to_cpu(event_data->Status) & 0x2) == 2) ? "1 " : " ",
                  ((le16_to_cpu(event_data->Status) & 0x4) == 4) ? "2 " : " ",
                  ((le16_to_cpu(event_data->Status) & 0x8) == 8) ? "3 " : " ",
                  event_data->SensorNum);
                pr_err(MPT3SAS_FMT "Current Temp In Celsius: %d\n",
                        ioc->name, event_data->CurrentTemperature);
        }
}

static inline bool ata_12_16_cmd(struct scsi_cmnd *scmd)
{
        return (scmd->cmnd[0] == ATA_12 || scmd->cmnd[0] == ATA_16);
}

/**
 * _scsih_flush_running_cmds - completing outstanding commands.
 * @ioc: per adapter object
 *
 * The flushing out of all pending scmd commands following host reset,
 * where all IO is dropped to the floor.
 *
 * Return nothing.
 */
static void
_scsih_flush_running_cmds(struct MPT3SAS_ADAPTER *ioc)
{
        struct scsi_cmnd *scmd;
        u16 smid;
        u16 count = 0;

        for (smid = 1; smid <= ioc->scsiio_depth; smid++) {
                scmd = _scsih_scsi_lookup_get_clear(ioc, smid);
                if (!scmd)
                        continue;
                count++;
                if (ata_12_16_cmd(scmd))
                        scsi_internal_device_unblock(scmd->device,
                                                        SDEV_RUNNING);
                mpt3sas_base_free_smid(ioc, smid);
                scsi_dma_unmap(scmd);
                if (ioc->pci_error_recovery)
                        scmd->result = DID_NO_CONNECT << 16;
                else
                        scmd->result = DID_RESET << 16;
                scmd->scsi_done(scmd);
        }
        dtmprintk(ioc, pr_info(MPT3SAS_FMT "completing %d cmds\n",
            ioc->name, count));
}

/**
 * _scsih_setup_eedp - setup MPI request for EEDP transfer
 * @ioc: per adapter object
 * @scmd: pointer to scsi command object
 * @mpi_request: pointer to the SCSI_IO reqest message frame
 *
 * Supporting protection 1 and 3.
 *
 * Returns nothing
 */
static void
_scsih_setup_eedp(struct MPT3SAS_ADAPTER *ioc, struct scsi_cmnd *scmd,
        Mpi2SCSIIORequest_t *mpi_request)
{
        u16 eedp_flags;
        unsigned char prot_op = scsi_get_prot_op(scmd);
        unsigned char prot_type = scsi_get_prot_type(scmd);
        Mpi25SCSIIORequest_t *mpi_request_3v =
           (Mpi25SCSIIORequest_t *)mpi_request;

        if (prot_type == SCSI_PROT_DIF_TYPE0 || prot_op == SCSI_PROT_NORMAL)
                return;

        if (prot_op ==  SCSI_PROT_READ_STRIP)
                eedp_flags = MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP;
        else if (prot_op ==  SCSI_PROT_WRITE_INSERT)
                eedp_flags = MPI2_SCSIIO_EEDPFLAGS_INSERT_OP;
        else
                return;

        switch (prot_type) {
        case SCSI_PROT_DIF_TYPE1:
        case SCSI_PROT_DIF_TYPE2:

                /*
                * enable ref/guard checking
                * auto increment ref tag
                */
                eedp_flags |= MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG |
                    MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG |
                    MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD;
                mpi_request->CDB.EEDP32.PrimaryReferenceTag =
                    cpu_to_be32(scsi_prot_ref_tag(scmd));
                break;

        case SCSI_PROT_DIF_TYPE3:

                /*
                * enable guard checking
                */
                eedp_flags |= MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD;

                break;
        }

        mpi_request_3v->EEDPBlockSize =
            cpu_to_le16(scmd->device->sector_size);
        mpi_request->EEDPFlags = cpu_to_le16(eedp_flags);
}

/**
 * _scsih_eedp_error_handling - return sense code for EEDP errors
 * @scmd: pointer to scsi command object
 * @ioc_status: ioc status
 *
 * Returns nothing
 */
static void
_scsih_eedp_error_handling(struct scsi_cmnd *scmd, u16 ioc_status)
{
        u8 ascq;