/*
 *  Linux MegaRAID driver for SAS based RAID controllers
 *
 *  Copyright (c) 2003-2012  LSI Corporation.
 *
 *  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.
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 *  FILE: megaraid_sas_base.c
 *  Version : v06.506.00.00-rc1
 *
 *  Authors: LSI Corporation
 *           Sreenivas Bagalkote
 *           Sumant Patro
 *           Bo Yang
 *           Adam Radford <linuxraid@lsi.com>
 *
 *  Send feedback to: <megaraidlinux@lsi.com>
 *
 *  Mail to: LSI Corporation, 1621 Barber Lane, Milpitas, CA 95035
 *     ATTN: Linuxraid
 */

#include <linux/kernel.h>
#include <linux/types.h>
#include <linux/pci.h>
#include <linux/list.h>
#include <linux/moduleparam.h>
#include <linux/module.h>
#include <linux/spinlock.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/uio.h>
#include <linux/slab.h>
#include <asm/uaccess.h>
#include <linux/fs.h>
#include <linux/compat.h>
#include <linux/blkdev.h>
#include <linux/mutex.h>
#include <linux/poll.h>

#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_tcq.h>
#include "megaraid_sas_fusion.h"
#include "megaraid_sas.h"

/*
 * Number of sectors per IO command
 * Will be set in megasas_init_mfi if user does not provide
 */
static unsigned int max_sectors;
module_param_named(max_sectors, max_sectors, int, 0);
MODULE_PARM_DESC(max_sectors,
        "Maximum number of sectors per IO command");

static int msix_disable;
module_param(msix_disable, int, S_IRUGO);
MODULE_PARM_DESC(msix_disable, "Disable MSI-X interrupt handling. Default: 0");

static unsigned int msix_vectors;
module_param(msix_vectors, int, S_IRUGO);
MODULE_PARM_DESC(msix_vectors, "MSI-X max vector count. Default: Set by FW");

static int throttlequeuedepth = MEGASAS_THROTTLE_QUEUE_DEPTH;
module_param(throttlequeuedepth, int, S_IRUGO);
MODULE_PARM_DESC(throttlequeuedepth,
        "Adapter queue depth when throttled due to I/O timeout. Default: 16");

int resetwaittime = MEGASAS_RESET_WAIT_TIME;
module_param(resetwaittime, int, S_IRUGO);
MODULE_PARM_DESC(resetwaittime, "Wait time in seconds after I/O timeout "
                 "before resetting adapter. Default: 180");

MODULE_LICENSE("GPL");
MODULE_VERSION(MEGASAS_VERSION);
MODULE_AUTHOR("megaraidlinux@lsi.com");
MODULE_DESCRIPTION("LSI MegaRAID SAS Driver");

int megasas_transition_to_ready(struct megasas_instance *instance, int ocr);
static int megasas_get_pd_list(struct megasas_instance *instance);
static int megasas_issue_init_mfi(struct megasas_instance *instance);
static int megasas_register_aen(struct megasas_instance *instance,
                                u32 seq_num, u32 class_locale_word);
/*
 * PCI ID table for all supported controllers
 */
static struct pci_device_id megasas_pci_table[] = {

        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1064R)},
        /* xscale IOP */
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1078R)},
        /* ppc IOP */
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1078DE)},
        /* ppc IOP */
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS1078GEN2)},
        /* gen2*/
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS0079GEN2)},
        /* gen2*/
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS0073SKINNY)},
        /* skinny*/
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_SAS0071SKINNY)},
        /* skinny*/
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_VERDE_ZCR)},
        /* xscale IOP, vega */
        {PCI_DEVICE(PCI_VENDOR_ID_DELL, PCI_DEVICE_ID_DELL_PERC5)},
        /* xscale IOP */
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_FUSION)},
        /* Fusion */
        {PCI_DEVICE(PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_INVADER)},
        /* Invader */
        {}
};

MODULE_DEVICE_TABLE(pci, megasas_pci_table);

static int megasas_mgmt_majorno;
static struct megasas_mgmt_info megasas_mgmt_info;
static struct fasync_struct *megasas_async_queue;
static DEFINE_MUTEX(megasas_async_queue_mutex);

static int megasas_poll_wait_aen;
static DECLARE_WAIT_QUEUE_HEAD(megasas_poll_wait);
static u32 support_poll_for_event;
u32 megasas_dbg_lvl;
static u32 support_device_change;

/* define lock for aen poll */
spinlock_t poll_aen_lock;

void
megasas_complete_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd,
                     u8 alt_status);
static u32
megasas_read_fw_status_reg_gen2(struct megasas_register_set __iomem *regs);
static int
megasas_adp_reset_gen2(struct megasas_instance *instance,
                       struct megasas_register_set __iomem *reg_set);
static irqreturn_t megasas_isr(int irq, void *devp);
static u32
megasas_init_adapter_mfi(struct megasas_instance *instance);
u32
megasas_build_and_issue_cmd(struct megasas_instance *instance,
                            struct scsi_cmnd *scmd);
static void megasas_complete_cmd_dpc(unsigned long instance_addr);
void
megasas_release_fusion(struct megasas_instance *instance);
int
megasas_ioc_init_fusion(struct megasas_instance *instance);
void
megasas_free_cmds_fusion(struct megasas_instance *instance);
u8
megasas_get_map_info(struct megasas_instance *instance);
int
megasas_sync_map_info(struct megasas_instance *instance);
int
wait_and_poll(struct megasas_instance *instance, struct megasas_cmd *cmd);
void megasas_reset_reply_desc(struct megasas_instance *instance);
u8 MR_ValidateMapInfo(struct MR_FW_RAID_MAP_ALL *map,
                      struct LD_LOAD_BALANCE_INFO *lbInfo);
int megasas_reset_fusion(struct Scsi_Host *shost);
void megasas_fusion_ocr_wq(struct work_struct *work);

void
megasas_issue_dcmd(struct megasas_instance *instance, struct megasas_cmd *cmd)
{
        instance->instancet->fire_cmd(instance,
                cmd->frame_phys_addr, 0, instance->reg_set);
}

/**
 * megasas_get_cmd -    Get a command from the free pool
 * @instance:           Adapter soft state
 *
 * Returns a free command from the pool
 */
struct megasas_cmd *megasas_get_cmd(struct megasas_instance
                                                  *instance)
{
        unsigned long flags;
        struct megasas_cmd *cmd = NULL;

        spin_lock_irqsave(&instance->cmd_pool_lock, flags);

        if (!list_empty(&instance->cmd_pool)) {
                cmd = list_entry((&instance->cmd_pool)->next,
                                 struct megasas_cmd, list);
                list_del_init(&cmd->list);
        } else {
                printk(KERN_ERR "megasas: Command pool empty!\n");
        }

        spin_unlock_irqrestore(&instance->cmd_pool_lock, flags);
        return cmd;
}

/**
 * megasas_return_cmd - Return a cmd to free command pool
 * @instance:           Adapter soft state
 * @cmd:                Command packet to be returned to free command pool
 */
inline void
megasas_return_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd)
{
        unsigned long flags;

        spin_lock_irqsave(&instance->cmd_pool_lock, flags);

        cmd->scmd = NULL;
        cmd->frame_count = 0;
        if ((instance->pdev->device != PCI_DEVICE_ID_LSI_FUSION) &&
            (instance->pdev->device != PCI_DEVICE_ID_LSI_INVADER) &&
            (reset_devices))
                cmd->frame->hdr.cmd = MFI_CMD_INVALID;
        list_add_tail(&cmd->list, &instance->cmd_pool);

        spin_unlock_irqrestore(&instance->cmd_pool_lock, flags);
}


/**
*       The following functions are defined for xscale
*       (deviceid : 1064R, PERC5) controllers
*/

/**
 * megasas_enable_intr_xscale - Enables interrupts
 * @regs:                       MFI register set
 */
static inline void
megasas_enable_intr_xscale(struct megasas_register_set __iomem * regs)
{
        writel(0, &(regs)->outbound_intr_mask);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_disable_intr_xscale -Disables interrupt
 * @regs:                       MFI register set
 */
static inline void
megasas_disable_intr_xscale(struct megasas_register_set __iomem * regs)
{
        u32 mask = 0x1f;
        writel(mask, &regs->outbound_intr_mask);
        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_read_fw_status_reg_xscale - returns the current FW status value
 * @regs:                       MFI register set
 */
static u32
megasas_read_fw_status_reg_xscale(struct megasas_register_set __iomem * regs)
{
        return readl(&(regs)->outbound_msg_0);
}
/**
 * megasas_clear_interrupt_xscale -     Check & clear interrupt
 * @regs:                               MFI register set
 */
static int
megasas_clear_intr_xscale(struct megasas_register_set __iomem * regs)
{
        u32 status;
        u32 mfiStatus = 0;
        /*
         * Check if it is our interrupt
         */
        status = readl(&regs->outbound_intr_status);

        if (status & MFI_OB_INTR_STATUS_MASK)
                mfiStatus = MFI_INTR_FLAG_REPLY_MESSAGE;
        if (status & MFI_XSCALE_OMR0_CHANGE_INTERRUPT)
                mfiStatus |= MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE;

        /*
         * Clear the interrupt by writing back the same value
         */
        if (mfiStatus)
                writel(status, &regs->outbound_intr_status);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_status);

        return mfiStatus;
}

/**
 * megasas_fire_cmd_xscale -    Sends command to the FW
 * @frame_phys_addr :           Physical address of cmd
 * @frame_count :               Number of frames for the command
 * @regs :                      MFI register set
 */
static inline void
megasas_fire_cmd_xscale(struct megasas_instance *instance,
                dma_addr_t frame_phys_addr,
                u32 frame_count,
                struct megasas_register_set __iomem *regs)
{
        unsigned long flags;
        spin_lock_irqsave(&instance->hba_lock, flags);
        writel((frame_phys_addr >> 3)|(frame_count),
               &(regs)->inbound_queue_port);
        spin_unlock_irqrestore(&instance->hba_lock, flags);
}

/**
 * megasas_adp_reset_xscale -  For controller reset
 * @regs:                              MFI register set
 */
static int
megasas_adp_reset_xscale(struct megasas_instance *instance,
        struct megasas_register_set __iomem *regs)
{
        u32 i;
        u32 pcidata;
        writel(MFI_ADP_RESET, &regs->inbound_doorbell);

        for (i = 0; i < 3; i++)
                msleep(1000); /* sleep for 3 secs */
        pcidata  = 0;
        pci_read_config_dword(instance->pdev, MFI_1068_PCSR_OFFSET, &pcidata);
        printk(KERN_NOTICE "pcidata = %x\n", pcidata);
        if (pcidata & 0x2) {
                printk(KERN_NOTICE "mfi 1068 offset read=%x\n", pcidata);
                pcidata &= ~0x2;
                pci_write_config_dword(instance->pdev,
                                MFI_1068_PCSR_OFFSET, pcidata);

                for (i = 0; i < 2; i++)
                        msleep(1000); /* need to wait 2 secs again */

                pcidata  = 0;
                pci_read_config_dword(instance->pdev,
                                MFI_1068_FW_HANDSHAKE_OFFSET, &pcidata);
                printk(KERN_NOTICE "1068 offset handshake read=%x\n", pcidata);
                if ((pcidata & 0xffff0000) == MFI_1068_FW_READY) {
                        printk(KERN_NOTICE "1068 offset pcidt=%x\n", pcidata);
                        pcidata = 0;
                        pci_write_config_dword(instance->pdev,
                                MFI_1068_FW_HANDSHAKE_OFFSET, pcidata);
                }
        }
        return 0;
}

/**
 * megasas_check_reset_xscale - For controller reset check
 * @regs:                               MFI register set
 */
static int
megasas_check_reset_xscale(struct megasas_instance *instance,
                struct megasas_register_set __iomem *regs)
{
        u32 consumer;
        consumer = *instance->consumer;

        if ((instance->adprecovery != MEGASAS_HBA_OPERATIONAL) &&
                (*instance->consumer == MEGASAS_ADPRESET_INPROG_SIGN)) {
                return 1;
        }
        return 0;
}

static struct megasas_instance_template megasas_instance_template_xscale = {

        .fire_cmd = megasas_fire_cmd_xscale,
        .enable_intr = megasas_enable_intr_xscale,
        .disable_intr = megasas_disable_intr_xscale,
        .clear_intr = megasas_clear_intr_xscale,
        .read_fw_status_reg = megasas_read_fw_status_reg_xscale,
        .adp_reset = megasas_adp_reset_xscale,
        .check_reset = megasas_check_reset_xscale,
        .service_isr = megasas_isr,
        .tasklet = megasas_complete_cmd_dpc,
        .init_adapter = megasas_init_adapter_mfi,
        .build_and_issue_cmd = megasas_build_and_issue_cmd,
        .issue_dcmd = megasas_issue_dcmd,
};

/**
*       This is the end of set of functions & definitions specific
*       to xscale (deviceid : 1064R, PERC5) controllers
*/

/**
*       The following functions are defined for ppc (deviceid : 0x60)
*       controllers
*/

/**
 * megasas_enable_intr_ppc -    Enables interrupts
 * @regs:                       MFI register set
 */
static inline void
megasas_enable_intr_ppc(struct megasas_register_set __iomem * regs)
{
        writel(0xFFFFFFFF, &(regs)->outbound_doorbell_clear);

        writel(~0x80000000, &(regs)->outbound_intr_mask);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_disable_intr_ppc -   Disable interrupt
 * @regs:                       MFI register set
 */
static inline void
megasas_disable_intr_ppc(struct megasas_register_set __iomem * regs)
{
        u32 mask = 0xFFFFFFFF;
        writel(mask, &regs->outbound_intr_mask);
        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_read_fw_status_reg_ppc - returns the current FW status value
 * @regs:                       MFI register set
 */
static u32
megasas_read_fw_status_reg_ppc(struct megasas_register_set __iomem * regs)
{
        return readl(&(regs)->outbound_scratch_pad);
}

/**
 * megasas_clear_interrupt_ppc -        Check & clear interrupt
 * @regs:                               MFI register set
 */
static int
megasas_clear_intr_ppc(struct megasas_register_set __iomem * regs)
{
        u32 status, mfiStatus = 0;

        /*
         * Check if it is our interrupt
         */
        status = readl(&regs->outbound_intr_status);

        if (status & MFI_REPLY_1078_MESSAGE_INTERRUPT)
                mfiStatus = MFI_INTR_FLAG_REPLY_MESSAGE;

        if (status & MFI_G2_OUTBOUND_DOORBELL_CHANGE_INTERRUPT)
                mfiStatus |= MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE;

        /*
         * Clear the interrupt by writing back the same value
         */
        writel(status, &regs->outbound_doorbell_clear);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_doorbell_clear);

        return mfiStatus;
}

/**
 * megasas_fire_cmd_ppc -       Sends command to the FW
 * @frame_phys_addr :           Physical address of cmd
 * @frame_count :               Number of frames for the command
 * @regs :                      MFI register set
 */
static inline void
megasas_fire_cmd_ppc(struct megasas_instance *instance,
                dma_addr_t frame_phys_addr,
                u32 frame_count,
                struct megasas_register_set __iomem *regs)
{
        unsigned long flags;
        spin_lock_irqsave(&instance->hba_lock, flags);
        writel((frame_phys_addr | (frame_count<<1))|1,
                        &(regs)->inbound_queue_port);
        spin_unlock_irqrestore(&instance->hba_lock, flags);
}

/**
 * megasas_check_reset_ppc -    For controller reset check
 * @regs:                               MFI register set
 */
static int
megasas_check_reset_ppc(struct megasas_instance *instance,
                        struct megasas_register_set __iomem *regs)
{
        if (instance->adprecovery != MEGASAS_HBA_OPERATIONAL)
                return 1;

        return 0;
}

static struct megasas_instance_template megasas_instance_template_ppc = {

        .fire_cmd = megasas_fire_cmd_ppc,
        .enable_intr = megasas_enable_intr_ppc,
        .disable_intr = megasas_disable_intr_ppc,
        .clear_intr = megasas_clear_intr_ppc,
        .read_fw_status_reg = megasas_read_fw_status_reg_ppc,
        .adp_reset = megasas_adp_reset_xscale,
        .check_reset = megasas_check_reset_ppc,
        .service_isr = megasas_isr,
        .tasklet = megasas_complete_cmd_dpc,
        .init_adapter = megasas_init_adapter_mfi,
        .build_and_issue_cmd = megasas_build_and_issue_cmd,
        .issue_dcmd = megasas_issue_dcmd,
};

/**
 * megasas_enable_intr_skinny - Enables interrupts
 * @regs:                       MFI register set
 */
static inline void
megasas_enable_intr_skinny(struct megasas_register_set __iomem *regs)
{
        writel(0xFFFFFFFF, &(regs)->outbound_intr_mask);

        writel(~MFI_SKINNY_ENABLE_INTERRUPT_MASK, &(regs)->outbound_intr_mask);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_disable_intr_skinny -        Disables interrupt
 * @regs:                       MFI register set
 */
static inline void
megasas_disable_intr_skinny(struct megasas_register_set __iomem *regs)
{
        u32 mask = 0xFFFFFFFF;
        writel(mask, &regs->outbound_intr_mask);
        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_read_fw_status_reg_skinny - returns the current FW status value
 * @regs:                       MFI register set
 */
static u32
megasas_read_fw_status_reg_skinny(struct megasas_register_set __iomem *regs)
{
        return readl(&(regs)->outbound_scratch_pad);
}

/**
 * megasas_clear_interrupt_skinny -     Check & clear interrupt
 * @regs:                               MFI register set
 */
static int
megasas_clear_intr_skinny(struct megasas_register_set __iomem *regs)
{
        u32 status;
        u32 mfiStatus = 0;

        /*
         * Check if it is our interrupt
         */
        status = readl(&regs->outbound_intr_status);

        if (!(status & MFI_SKINNY_ENABLE_INTERRUPT_MASK)) {
                return 0;
        }

        /*
         * Check if it is our interrupt
         */
        if ((megasas_read_fw_status_reg_gen2(regs) & MFI_STATE_MASK) ==
            MFI_STATE_FAULT) {
                mfiStatus = MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE;
        } else
                mfiStatus = MFI_INTR_FLAG_REPLY_MESSAGE;

        /*
         * Clear the interrupt by writing back the same value
         */
        writel(status, &regs->outbound_intr_status);

        /*
        * dummy read to flush PCI
        */
        readl(&regs->outbound_intr_status);

        return mfiStatus;
}

/**
 * megasas_fire_cmd_skinny -    Sends command to the FW
 * @frame_phys_addr :           Physical address of cmd
 * @frame_count :               Number of frames for the command
 * @regs :                      MFI register set
 */
static inline void
megasas_fire_cmd_skinny(struct megasas_instance *instance,
                        dma_addr_t frame_phys_addr,
                        u32 frame_count,
                        struct megasas_register_set __iomem *regs)
{
        unsigned long flags;
        spin_lock_irqsave(&instance->hba_lock, flags);
        writel(0, &(regs)->inbound_high_queue_port);
        writel((frame_phys_addr | (frame_count<<1))|1,
                &(regs)->inbound_low_queue_port);
        spin_unlock_irqrestore(&instance->hba_lock, flags);
}

/**
 * megasas_check_reset_skinny - For controller reset check
 * @regs:                               MFI register set
 */
static int
megasas_check_reset_skinny(struct megasas_instance *instance,
                                struct megasas_register_set __iomem *regs)
{
        if (instance->adprecovery != MEGASAS_HBA_OPERATIONAL)
                return 1;

        return 0;
}

static struct megasas_instance_template megasas_instance_template_skinny = {

        .fire_cmd = megasas_fire_cmd_skinny,
        .enable_intr = megasas_enable_intr_skinny,
        .disable_intr = megasas_disable_intr_skinny,
        .clear_intr = megasas_clear_intr_skinny,
        .read_fw_status_reg = megasas_read_fw_status_reg_skinny,
        .adp_reset = megasas_adp_reset_gen2,
        .check_reset = megasas_check_reset_skinny,
        .service_isr = megasas_isr,
        .tasklet = megasas_complete_cmd_dpc,
        .init_adapter = megasas_init_adapter_mfi,
        .build_and_issue_cmd = megasas_build_and_issue_cmd,
        .issue_dcmd = megasas_issue_dcmd,
};


/**
*       The following functions are defined for gen2 (deviceid : 0x78 0x79)
*       controllers
*/

/**
 * megasas_enable_intr_gen2 -  Enables interrupts
 * @regs:                      MFI register set
 */
static inline void
megasas_enable_intr_gen2(struct megasas_register_set __iomem *regs)
{
        writel(0xFFFFFFFF, &(regs)->outbound_doorbell_clear);

        /* write ~0x00000005 (4 & 1) to the intr mask*/
        writel(~MFI_GEN2_ENABLE_INTERRUPT_MASK, &(regs)->outbound_intr_mask);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_disable_intr_gen2 - Disables interrupt
 * @regs:                      MFI register set
 */
static inline void
megasas_disable_intr_gen2(struct megasas_register_set __iomem *regs)
{
        u32 mask = 0xFFFFFFFF;
        writel(mask, &regs->outbound_intr_mask);
        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_mask);
}

/**
 * megasas_read_fw_status_reg_gen2 - returns the current FW status value
 * @regs:                      MFI register set
 */
static u32
megasas_read_fw_status_reg_gen2(struct megasas_register_set __iomem *regs)
{
        return readl(&(regs)->outbound_scratch_pad);
}

/**
 * megasas_clear_interrupt_gen2 -      Check & clear interrupt
 * @regs:                              MFI register set
 */
static int
megasas_clear_intr_gen2(struct megasas_register_set __iomem *regs)
{
        u32 status;
        u32 mfiStatus = 0;
        /*
         * Check if it is our interrupt
         */
        status = readl(&regs->outbound_intr_status);

        if (status & MFI_GEN2_ENABLE_INTERRUPT_MASK) {
                mfiStatus = MFI_INTR_FLAG_REPLY_MESSAGE;
        }
        if (status & MFI_G2_OUTBOUND_DOORBELL_CHANGE_INTERRUPT) {
                mfiStatus |= MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE;
        }

        /*
         * Clear the interrupt by writing back the same value
         */
        if (mfiStatus)
                writel(status, &regs->outbound_doorbell_clear);

        /* Dummy readl to force pci flush */
        readl(&regs->outbound_intr_status);

        return mfiStatus;
}
/**
 * megasas_fire_cmd_gen2 -     Sends command to the FW
 * @frame_phys_addr :          Physical address of cmd
 * @frame_count :              Number of frames for the command
 * @regs :                     MFI register set
 */
static inline void
megasas_fire_cmd_gen2(struct megasas_instance *instance,
                        dma_addr_t frame_phys_addr,
                        u32 frame_count,
                        struct megasas_register_set __iomem *regs)
{
        unsigned long flags;
        spin_lock_irqsave(&instance->hba_lock, flags);
        writel((frame_phys_addr | (frame_count<<1))|1,
                        &(regs)->inbound_queue_port);
        spin_unlock_irqrestore(&instance->hba_lock, flags);
}

/**
 * megasas_adp_reset_gen2 -     For controller reset
 * @regs:                               MFI register set
 */
static int
megasas_adp_reset_gen2(struct megasas_instance *instance,
                        struct megasas_register_set __iomem *reg_set)
{
        u32                     retry = 0 ;
        u32                     HostDiag;
        u32                     *seq_offset = &reg_set->seq_offset;
        u32                     *hostdiag_offset = &reg_set->host_diag;

        if (instance->instancet == &megasas_instance_template_skinny) {
                seq_offset = &reg_set->fusion_seq_offset;
                hostdiag_offset = &reg_set->fusion_host_diag;
        }

        writel(0, seq_offset);
        writel(4, seq_offset);
        writel(0xb, seq_offset);
        writel(2, seq_offset);
        writel(7, seq_offset);
        writel(0xd, seq_offset);

        msleep(1000);

        HostDiag = (u32)readl(hostdiag_offset);

        while ( !( HostDiag & DIAG_WRITE_ENABLE) ) {
                msleep(100);
                HostDiag = (u32)readl(hostdiag_offset);
                printk(KERN_NOTICE "RESETGEN2: retry=%x, hostdiag=%x\n",
                                        retry, HostDiag);

                if (retry++ >= 100)
                        return 1;

        }

        printk(KERN_NOTICE "ADP_RESET_GEN2: HostDiag=%x\n", HostDiag);

        writel((HostDiag | DIAG_RESET_ADAPTER), hostdiag_offset);

        ssleep(10);

        HostDiag = (u32)readl(hostdiag_offset);
        while ( ( HostDiag & DIAG_RESET_ADAPTER) ) {
                msleep(100);
                HostDiag = (u32)readl(hostdiag_offset);
                printk(KERN_NOTICE "RESET_GEN2: retry=%x, hostdiag=%x\n",
                                retry, HostDiag);

                if (retry++ >= 1000)
                        return 1;

        }
        return 0;
}

/**
 * megasas_check_reset_gen2 -   For controller reset check
 * @regs:                               MFI register set
 */
static int
megasas_check_reset_gen2(struct megasas_instance *instance,
                struct megasas_register_set __iomem *regs)
{
        if (instance->adprecovery != MEGASAS_HBA_OPERATIONAL) {
                return 1;
        }

        return 0;
}

static struct megasas_instance_template megasas_instance_template_gen2 = {

        .fire_cmd = megasas_fire_cmd_gen2,
        .enable_intr = megasas_enable_intr_gen2,
        .disable_intr = megasas_disable_intr_gen2,
        .clear_intr = megasas_clear_intr_gen2,
        .read_fw_status_reg = megasas_read_fw_status_reg_gen2,
        .adp_reset = megasas_adp_reset_gen2,
        .check_reset = megasas_check_reset_gen2,
        .service_isr = megasas_isr,
        .tasklet = megasas_complete_cmd_dpc,
        .init_adapter = megasas_init_adapter_mfi,
        .build_and_issue_cmd = megasas_build_and_issue_cmd,
        .issue_dcmd = megasas_issue_dcmd,
};

/**
*       This is the end of set of functions & definitions
*       specific to gen2 (deviceid : 0x78, 0x79) controllers
*/

/*
 * Template added for TB (Fusion)
 */
extern struct megasas_instance_template megasas_instance_template_fusion;

/**
 * megasas_issue_polled -       Issues a polling command
 * @instance:                   Adapter soft state
 * @cmd:                        Command packet to be issued
 *
 * For polling, MFI requires the cmd_status to be set to 0xFF before posting.
 */
int
megasas_issue_polled(struct megasas_instance *instance, struct megasas_cmd *cmd)
{

        struct megasas_header *frame_hdr = &cmd->frame->hdr;

        frame_hdr->cmd_status = 0xFF;
        frame_hdr->flags |= MFI_FRAME_DONT_POST_IN_REPLY_QUEUE;

        /*
         * Issue the frame using inbound queue port
         */
        instance->instancet->issue_dcmd(instance, cmd);

        /*
         * Wait for cmd_status to change
         */
        return wait_and_poll(instance, cmd);
}

/**
 * megasas_issue_blocked_cmd -  Synchronous wrapper around regular FW cmds
 * @instance:                   Adapter soft state
 * @cmd:                        Command to be issued
 *
 * This function waits on an event for the command to be returned from ISR.
 * Max wait time is MEGASAS_INTERNAL_CMD_WAIT_TIME secs
 * Used to issue ioctl commands.
 */
static int
megasas_issue_blocked_cmd(struct megasas_instance *instance,
                          struct megasas_cmd *cmd)
{
        cmd->cmd_status = ENODATA;

        instance->instancet->issue_dcmd(instance, cmd);

        wait_event(instance->int_cmd_wait_q, cmd->cmd_status != ENODATA);

        return 0;
}

/**
 * megasas_issue_blocked_abort_cmd -    Aborts previously issued cmd
 * @instance:                           Adapter soft state
 * @cmd_to_abort:                       Previously issued cmd to be aborted
 *
 * MFI firmware can abort previously issued AEN command (automatic event
 * notification). The megasas_issue_blocked_abort_cmd() issues such abort
 * cmd and waits for return status.
 * Max wait time is MEGASAS_INTERNAL_CMD_WAIT_TIME secs
 */
static int
megasas_issue_blocked_abort_cmd(struct megasas_instance *instance,
                                struct megasas_cmd *cmd_to_abort)
{
        struct megasas_cmd *cmd;
        struct megasas_abort_frame *abort_fr;

        cmd = megasas_get_cmd(instance);

        if (!cmd)
                return -1;

        abort_fr = &cmd->frame->abort;

        /*
         * Prepare and issue the abort frame
         */
        abort_fr->cmd = MFI_CMD_ABORT;
        abort_fr->cmd_status = 0xFF;
        abort_fr->flags = 0;
        abort_fr->abort_context = cmd_to_abort->index;
        abort_fr->abort_mfi_phys_addr_lo = cmd_to_abort->frame_phys_addr;
        abort_fr->abort_mfi_phys_addr_hi = 0;

        cmd->sync_cmd = 1;
        cmd->cmd_status = 0xFF;

        instance->instancet->issue_dcmd(instance, cmd);

        /*
         * Wait for this cmd to complete
         */
        wait_event(instance->abort_cmd_wait_q, cmd->cmd_status != 0xFF);
        cmd->sync_cmd = 0;

        megasas_return_cmd(instance, cmd);
        return 0;
}

/**
 * megasas_make_sgl32 - Prepares 32-bit SGL
 * @instance:           Adapter soft state
 * @scp:                SCSI command from the mid-layer
 * @mfi_sgl:            SGL to be filled in
 *
 * If successful, this function returns the number of SG elements. Otherwise,
 * it returnes -1.
 */
static int
megasas_make_sgl32(struct megasas_instance *instance, struct scsi_cmnd *scp,
                   union megasas_sgl *mfi_sgl)
{
        int i;
        int sge_count;
        struct scatterlist *os_sgl;

        sge_count = scsi_dma_map(scp);
        BUG_ON(sge_count < 0);

        if (sge_count) {
                scsi_for_each_sg(scp, os_sgl, sge_count, i) {
                        mfi_sgl->sge32[i].length = sg_dma_len(os_sgl);
                        mfi_sgl->sge32[i].phys_addr = sg_dma_address(os_sgl);
                }
        }
        return sge_count;
}

/**
 * megasas_make_sgl64 - Prepares 64-bit SGL
 * @instance:           Adapter soft state
 * @scp:                SCSI command from the mid-layer
 * @mfi_sgl:            SGL to be filled in
 *
 * If successful, this function returns the number of SG elements. Otherwise,
 * it returnes -1.
 */
static int
megasas_make_sgl64(struct megasas_instance *instance, struct scsi_cmnd *scp,
                   union megasas_sgl *mfi_sgl)
{
        int i;
        int sge_count;
        struct scatterlist *os_sgl;

        sge_count = scsi_dma_map(scp);
        BUG_ON(sge_count < 0);

        if (sge_count) {
                scsi_for_each_sg(scp, os_sgl, sge_count, i) {

                        mfi_sgl->sge64[i].length = sg_dma_len(os_sgl);
                        mfi_sgl->sge64[i].phys_addr = sg_dma_address(os_sgl);
                }
        }
        return sge_count;
}

/**
 * megasas_make_sgl_skinny - Prepares IEEE SGL
 * @instance:           Adapter soft state
 * @scp:                SCSI command from the mid-layer
 * @mfi_sgl:            SGL to be filled in
 *
 * If successful, this function returns the number of SG elements. Otherwise,
 * it returnes -1.
 */
static int
megasas_make_sgl_skinny(struct megasas_instance *instance,
                struct scsi_cmnd *scp, union megasas_sgl *mfi_sgl)
{
        int i;
        int sge_count;
        struct scatterlist *os_sgl;

        sge_count = scsi_dma_map(scp);

        if (sge_count) {
                scsi_for_each_sg(scp, os_sgl, sge_count, i) {
                        mfi_sgl->sge_skinny[i].length = sg_dma_len(os_sgl);
                        mfi_sgl->sge_skinny[i].phys_addr =
                                                sg_dma_address(os_sgl);
                        mfi_sgl->sge_skinny[i].flag = 0;
                }
        }
        return sge_count;
}

 /**
 * megasas_get_frame_count - Computes the number of frames
 * @frame_type          : type of frame- io or pthru frame
 * @sge_count           : number of sg elements
 *
 * Returns the number of frames required for numnber of sge's (sge_count)
 */

static u32 megasas_get_frame_count(struct megasas_instance *instance,
                        u8 sge_count, u8 frame_type)
{
        int num_cnt;
        int sge_bytes;
        u32 sge_sz;
        u32 frame_count=0;

        sge_sz = (IS_DMA64) ? sizeof(struct megasas_sge64) :
            sizeof(struct megasas_sge32);

        if (instance->flag_ieee) {
                sge_sz = sizeof(struct megasas_sge_skinny);
        }

        /*
         * Main frame can contain 2 SGEs for 64-bit SGLs and
         * 3 SGEs for 32-bit SGLs for ldio &
         * 1 SGEs for 64-bit SGLs and
         * 2 SGEs for 32-bit SGLs for pthru frame
         */
        if (unlikely(frame_type == PTHRU_FRAME)) {
                if (instance->flag_ieee == 1) {
                        num_cnt = sge_count - 1;
                } else if (IS_DMA64)
                        num_cnt = sge_count - 1;
                else
                        num_cnt = sge_count - 2;
        } else {
                if (instance->flag_ieee == 1) {
                        num_cnt = sge_count - 1;
                } else if (IS_DMA64)
                        num_cnt = sge_count - 2;
                else
                        num_cnt = sge_count - 3;
        }

        if(num_cnt>0){
                sge_bytes = sge_sz * num_cnt;

                frame_count = (sge_bytes / MEGAMFI_FRAME_SIZE) +
                    ((sge_bytes % MEGAMFI_FRAME_SIZE) ? 1 : 0) ;
        }
        /* Main frame */
        frame_count +=1;

        if (frame_count > 7)
                frame_count = 8;
        return frame_count;
}

/**
 * megasas_build_dcdb - Prepares a direct cdb (DCDB) command
 * @instance:           Adapter soft state
 * @scp:                SCSI command
 * @cmd:                Command to be prepared in
 *
 * This function prepares CDB commands. These are typcially pass-through
 * commands to the devices.
 */
static int
megasas_build_dcdb(struct megasas_instance *instance, struct scsi_cmnd *scp,
                   struct megasas_cmd *cmd)
{
        u32 is_logical;
        u32 device_id;
        u16 flags = 0;
        struct megasas_pthru_frame *pthru;

        is_logical = MEGASAS_IS_LOGICAL(scp);
        device_id = MEGASAS_DEV_INDEX(instance, scp);
        pthru = (struct megasas_pthru_frame *)cmd->frame;

        if (scp->sc_data_direction == PCI_DMA_TODEVICE)
                flags = MFI_FRAME_DIR_WRITE;
        else if (scp->sc_data_direction == PCI_DMA_FROMDEVICE)
                flags = MFI_FRAME_DIR_READ;
        else if (scp->sc_data_direction == PCI_DMA_NONE)
                flags = MFI_FRAME_DIR_NONE;

        if (instance->flag_ieee == 1) {
                flags |= MFI_FRAME_IEEE;
        }

        /*
         * Prepare the DCDB frame
         */
        pthru->cmd = (is_logical) ? MFI_CMD_LD_SCSI_IO : MFI_CMD_PD_SCSI_IO;
        pthru->cmd_status = 0x0;
        pthru->scsi_status = 0x0;
        pthru->target_id = device_id;
        pthru->lun = scp->device->lun;
        pthru->cdb_len = scp->cmd_len;
        pthru->timeout = 0;
        pthru->pad_0 = 0;
        pthru->flags = flags;
        pthru->data_xfer_len = scsi_bufflen(scp);

        memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);

        /*
        * If the command is for the tape device, set the
        * pthru timeout to the os layer timeout value.
        */
        if (scp->device->type == TYPE_TAPE) {
                if ((scp->request->timeout / HZ) > 0xFFFF)
                        pthru->timeout = 0xFFFF;
                else
                        pthru->timeout = scp->request->timeout / HZ;
        }

        /*
         * Construct SGL
         */
        if (instance->flag_ieee == 1) {
                pthru->flags |= MFI_FRAME_SGL64;
                pthru->sge_count = megasas_make_sgl_skinny(instance, scp,
                                                      &pthru->sgl);
        } else if (IS_DMA64) {
                pthru->flags |= MFI_FRAME_SGL64;
                pthru->sge_count = megasas_make_sgl64(instance, scp,
                                                      &pthru->sgl);
        } else
                pthru->sge_count = megasas_make_sgl32(instance, scp,
                                                      &pthru->sgl);

        if (pthru->sge_count > instance->max_num_sge) {
                printk(KERN_ERR "megasas: DCDB two many SGE NUM=%x\n",
                        pthru->sge_count);
                return 0;
        }

        /*
         * Sense info specific
         */
        pthru->sense_len = SCSI_SENSE_BUFFERSIZE;
        pthru->sense_buf_phys_addr_hi = 0;
        pthru->sense_buf_phys_addr_lo = cmd->sense_phys_addr;

        /*
         * Compute the total number of frames this command consumes. FW uses
         * this number to pull sufficient number of frames from host memory.
         */
        cmd->frame_count = megasas_get_frame_count(instance, pthru->sge_count,
                                                        PTHRU_FRAME);

        return cmd->frame_count;
}

/**
 * megasas_build_ldio - Prepares IOs to logical devices
 * @instance:           Adapter soft state
 * @scp:                SCSI command
 * @cmd:                Command to be prepared
 *
 * Frames (and accompanying SGLs) for regular SCSI IOs use this function.
 */
static int
megasas_build_ldio(struct megasas_instance *instance, struct scsi_cmnd *scp,
                   struct megasas_cmd *cmd)
{
        u32 device_id;
        u8 sc = scp->cmnd[0];
        u16 flags = 0;
        struct megasas_io_frame *ldio;

        device_id = MEGASAS_DEV_INDEX(instance, scp);
        ldio = (struct megasas_io_frame *)cmd->frame;

        if (scp->sc_data_direction == PCI_DMA_TODEVICE)
                flags = MFI_FRAME_DIR_WRITE;
        else if (scp->sc_data_direction == PCI_DMA_FROMDEVICE)
                flags = MFI_FRAME_DIR_READ;

        if (instance->flag_ieee == 1) {
                flags |= MFI_FRAME_IEEE;
        }

        /*
         * Prepare the Logical IO frame: 2nd bit is zero for all read cmds
         */
        ldio->cmd = (sc & 0x02) ? MFI_CMD_LD_WRITE : MFI_CMD_LD_READ;
        ldio->cmd_status = 0x0;
        ldio->scsi_status = 0x0;
        ldio->target_id = device_id;
        ldio->timeout = 0;
        ldio->reserved_0 = 0;
        ldio->pad_0 = 0;
        ldio->flags = flags;
        ldio->start_lba_hi = 0;
        ldio->access_byte = (scp->cmd_len != 6) ? scp->cmnd[1] : 0;

        /*
         * 6-byte READ(0x08) or WRITE(0x0A) cdb
         */
        if (scp->cmd_len == 6) {
                ldio->lba_count = (u32) scp->cmnd[4];
                ldio->start_lba_lo = ((u32) scp->cmnd[1] << 16) |
                    ((u32) scp->cmnd[2] << 8) | (u32) scp->cmnd[3];

                ldio->start_lba_lo &= 0x1FFFFF;
        }

        /*
         * 10-byte READ(0x28) or WRITE(0x2A) cdb
         */
        else if (scp->cmd_len == 10) {
                ldio->lba_count = (u32) scp->cmnd[8] |
                    ((u32) scp->cmnd[7] << 8);
                ldio->start_lba_lo = ((u32) scp->cmnd[2] << 24) |
                    ((u32) scp->cmnd[3] << 16) |
                    ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];
        }

        /*
         * 12-byte READ(0xA8) or WRITE(0xAA) cdb
         */
        else if (scp->cmd_len == 12) {
                ldio->lba_count = ((u32) scp->cmnd[6] << 24) |
                    ((u32) scp->cmnd[7] << 16) |
                    ((u32) scp->cmnd[8] << 8) | (u32) scp->cmnd[9];

                ldio->start_lba_lo = ((u32) scp->cmnd[2] << 24) |
                    ((u32) scp->cmnd[3] << 16) |
                    ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];
        }

        /*
         * 16-byte READ(0x88) or WRITE(0x8A) cdb
         */
        else if (scp->cmd_len == 16) {
                ldio->lba_count = ((u32) scp->cmnd[10] << 24) |
                    ((u32) scp->cmnd[11] << 16) |
                    ((u32) scp->cmnd[12] << 8) | (u32) scp->cmnd[13];

                ldio->start_lba_lo = ((u32) scp->cmnd[6] << 24) |
                    ((u32) scp->cmnd[7] << 16) |
                    ((u32) scp->cmnd[8] << 8) | (u32) scp->cmnd[9];

                ldio->start_lba_hi = ((u32) scp->cmnd[2] << 24) |
                    ((u32) scp->cmnd[3] << 16) |
                    ((u32) scp->cmnd[4] << 8) | (u32) scp->cmnd[5];

        }

        /*
         * Construct SGL
         */
        if (instance->flag_ieee) {
                ldio->flags |= MFI_FRAME_SGL64;
                ldio->sge_count = megasas_make_sgl_skinny(instance, scp,
                                              &ldio->sgl);
        } else if (IS_DMA64) {
                ldio->flags |= MFI_FRAME_SGL64;
                ldio->sge_count = megasas_make_sgl64(instance, scp, &ldio->sgl);
        } else
                ldio->sge_count = megasas_make_sgl32(instance, scp, &ldio->sgl);

        if (ldio->sge_count > instance->max_num_sge) {
                printk(KERN_ERR "megasas: build_ld_io: sge_count = %x\n",
                        ldio->sge_count);
                return 0;
        }

        /*
         * Sense info specific
         */
        ldio->sense_len = SCSI_SENSE_BUFFERSIZE;
        ldio->sense_buf_phys_addr_hi = 0;
        ldio->sense_buf_phys_addr_lo = cmd->sense_phys_addr;

        /*
         * Compute the total number of frames this command consumes. FW uses
         * this number to pull sufficient number of frames from host memory.
         */
        cmd->frame_count = megasas_get_frame_count(instance,
                        ldio->sge_count, IO_FRAME);

        return cmd->frame_count;
}

/**
 * megasas_is_ldio -            Checks if the cmd is for logical drive
 * @scmd:                       SCSI command
 *
 * Called by megasas_queue_command to find out if the command to be queued
 * is a logical drive command
 */
inline int megasas_is_ldio(struct scsi_cmnd *cmd)
{
        if (!MEGASAS_IS_LOGICAL(cmd))
                return 0;
        switch (cmd->cmnd[0]) {
        case READ_10:
        case WRITE_10:
        case READ_12:
        case WRITE_12:
        case READ_6:
        case WRITE_6:
        case READ_16:
        case WRITE_16:
                return 1;
        default:
                return 0;
        }
}

 /**
 * megasas_dump_pending_frames -        Dumps the frame address of all pending cmds
 *                                      in FW
 * @instance:                           Adapter soft state
 */
static inline void
megasas_dump_pending_frames(struct megasas_instance *instance)
{
        struct megasas_cmd *cmd;
        int i,n;
        union megasas_sgl *mfi_sgl;
        struct megasas_io_frame *ldio;
        struct megasas_pthru_frame *pthru;
        u32 sgcount;
        u32 max_cmd = instance->max_fw_cmds;

        printk(KERN_ERR "\nmegasas[%d]: Dumping Frame Phys Address of all pending cmds in FW\n",instance->host->host_no);
        printk(KERN_ERR "megasas[%d]: Total OS Pending cmds : %d\n",instance->host->host_no,atomic_read(&instance->fw_outstanding));
        if (IS_DMA64)
                printk(KERN_ERR "\nmegasas[%d]: 64 bit SGLs were sent to FW\n",instance->host->host_no);
        else
                printk(KERN_ERR "\nmegasas[%d]: 32 bit SGLs were sent to FW\n",instance->host->host_no);

        printk(KERN_ERR "megasas[%d]: Pending OS cmds in FW : \n",instance->host->host_no);
        for (i = 0; i < max_cmd; i++) {
                cmd = instance->cmd_list[i];
                if(!cmd->scmd)
                        continue;
                printk(KERN_ERR "megasas[%d]: Frame addr :0x%08lx : ",instance->host->host_no,(unsigned long)cmd->frame_phys_addr);
                if (megasas_is_ldio(cmd->scmd)){
                        ldio = (struct megasas_io_frame *)cmd->frame;
                        mfi_sgl = &ldio->sgl;
                        sgcount = ldio->sge_count;
                        printk(KERN_ERR "megasas[%d]: frame count : 0x%x, Cmd : 0x%x, Tgt id : 0x%x, lba lo : 0x%x, lba_hi : 0x%x, sense_buf addr : 0x%x,sge count : 0x%x\n",instance->host->host_no, cmd->frame_count,ldio->cmd,ldio->target_id, ldio->start_lba_lo,ldio->start_lba_hi,ldio->sense_buf_phys_addr_lo,sgcount);
                }
                else {
                        pthru = (struct megasas_pthru_frame *) cmd->frame;
                        mfi_sgl = &pthru->sgl;
                        sgcount = pthru->sge_count;
                        printk(KERN_ERR "megasas[%d]: frame count : 0x%x, Cmd : 0x%x, Tgt id : 0x%x, lun : 0x%x, cdb_len : 0x%x, data xfer len : 0x%x, sense_buf addr : 0x%x,sge count : 0x%x\n",instance->host->host_no,cmd->frame_count,pthru->cmd,pthru->target_id,pthru->lun,pthru->cdb_len , pthru->data_xfer_len,pthru->sense_buf_phys_addr_lo,sgcount);
                }
        if(megasas_dbg_lvl & MEGASAS_DBG_LVL){
                for (n = 0; n < sgcount; n++){
                        if (IS_DMA64)
                                printk(KERN_ERR "megasas: sgl len : 0x%x, sgl addr : 0x%08lx ",mfi_sgl->sge64[n].length , (unsigned long)mfi_sgl->sge64[n].phys_addr) ;
                        else
                                printk(KERN_ERR "megasas: sgl len : 0x%x, sgl addr : 0x%x ",mfi_sgl->sge32[n].length , mfi_sgl->sge32[n].phys_addr) ;
                        }
                }
                printk(KERN_ERR "\n");
        } /*for max_cmd*/
        printk(KERN_ERR "\nmegasas[%d]: Pending Internal cmds in FW : \n",instance->host->host_no);
        for (i = 0; i < max_cmd; i++) {

                cmd = instance->cmd_list[i];

                if(cmd->sync_cmd == 1){
                        printk(KERN_ERR "0x%08lx : ", (unsigned long)cmd->frame_phys_addr);
                }
        }
        printk(KERN_ERR "megasas[%d]: Dumping Done.\n\n",instance->host->host_no);
}

u32
megasas_build_and_issue_cmd(struct megasas_instance *instance,
                            struct scsi_cmnd *scmd)
{
        struct megasas_cmd *cmd;
        u32 frame_count;

        cmd = megasas_get_cmd(instance);
        if (!cmd)
                return SCSI_MLQUEUE_HOST_BUSY;

        /*
         * Logical drive command
         */
        if (megasas_is_ldio(scmd))
                frame_count = megasas_build_ldio(instance, scmd, cmd);
        else
                frame_count = megasas_build_dcdb(instance, scmd, cmd);

        if (!frame_count)
                goto out_return_cmd;

        cmd->scmd = scmd;
        scmd->SCp.ptr = (char *)cmd;

        /*
         * Issue the command to the FW
         */
        atomic_inc(&instance->fw_outstanding);

        instance->instancet->fire_cmd(instance, cmd->frame_phys_addr,
                                cmd->frame_count-1, instance->reg_set);

        return 0;
out_return_cmd:
        megasas_return_cmd(instance, cmd);
        return 1;
}


/**
 * megasas_queue_command -      Queue entry point
 * @scmd:                       SCSI command to be queued
 * @done:                       Callback entry point
 */
static int
megasas_queue_command_lck(struct scsi_cmnd *scmd, void (*done) (struct scsi_cmnd *))
{
        struct megasas_instance *instance;
        unsigned long flags;

        instance = (struct megasas_instance *)
            scmd->device->host->hostdata;

        if (instance->issuepend_done == 0)
                return SCSI_MLQUEUE_HOST_BUSY;

        spin_lock_irqsave(&instance->hba_lock, flags);
        if (instance->adprecovery != MEGASAS_HBA_OPERATIONAL) {
                spin_unlock_irqrestore(&instance->hba_lock, flags);
                return SCSI_MLQUEUE_HOST_BUSY;
        }

        spin_unlock_irqrestore(&instance->hba_lock, flags);

        scmd->scsi_done = done;
        scmd->result = 0;

        if (MEGASAS_IS_LOGICAL(scmd) &&
            (scmd->device->id >= MEGASAS_MAX_LD || scmd->device->lun)) {
                scmd->result = DID_BAD_TARGET << 16;
                goto out_done;
        }

        switch (scmd->cmnd[0]) {
        case SYNCHRONIZE_CACHE:
                /*
                 * FW takes care of flush cache on its own
                 * No need to send it down
                 */
                scmd->result = DID_OK << 16;
                goto out_done;
        default:
                break;
        }

        if (instance->instancet->build_and_issue_cmd(instance, scmd)) {
                printk(KERN_ERR "megasas: Err returned from build_and_issue_cmd\n");
                return SCSI_MLQUEUE_HOST_BUSY;
        }

        return 0;

 out_done:
        done(scmd);
        return 0;
}

static DEF_SCSI_QCMD(megasas_queue_command)

static struct megasas_instance *megasas_lookup_instance(u16 host_no)
{
        int i;

        for (i = 0; i < megasas_mgmt_info.max_index; i++) {

                if ((megasas_mgmt_info.instance[i]) &&
                    (megasas_mgmt_info.instance[i]->host->host_no == host_no))
                        return megasas_mgmt_info.instance[i];
        }

        return NULL;
}

static int megasas_slave_configure(struct scsi_device *sdev)
{
        u16             pd_index = 0;
        struct  megasas_instance *instance ;

        instance = megasas_lookup_instance(sdev->host->host_no);

        /*
        * Don't export physical disk devices to the disk driver.
        *
        * FIXME: Currently we don't export them to the midlayer at all.
        *        That will be fixed once LSI engineers have audited the
        *        firmware for possible issues.
        */
        if (sdev->channel < MEGASAS_MAX_PD_CHANNELS &&
                                sdev->type == TYPE_DISK) {
                pd_index = (sdev->channel * MEGASAS_MAX_DEV_PER_CHANNEL) +
                                                                sdev->id;
                if (instance->pd_list[pd_index].driveState ==
                                                MR_PD_STATE_SYSTEM) {
                        blk_queue_rq_timeout(sdev->request_queue,
                                MEGASAS_DEFAULT_CMD_TIMEOUT * HZ);
                        return 0;
                }
                return -ENXIO;
        }

        /*
        * The RAID firmware may require extended timeouts.
        */
        blk_queue_rq_timeout(sdev->request_queue,
                MEGASAS_DEFAULT_CMD_TIMEOUT * HZ);
        return 0;
}

static int megasas_slave_alloc(struct scsi_device *sdev)
{
        u16             pd_index = 0;
        struct megasas_instance *instance ;
        instance = megasas_lookup_instance(sdev->host->host_no);
        if ((sdev->channel < MEGASAS_MAX_PD_CHANNELS) &&
                                (sdev->type == TYPE_DISK)) {
                /*
                 * Open the OS scan to the SYSTEM PD
                 */
                pd_index =
                        (sdev->channel * MEGASAS_MAX_DEV_PER_CHANNEL) +
                        sdev->id;
                if ((instance->pd_list[pd_index].driveState ==
                                        MR_PD_STATE_SYSTEM) &&
                        (instance->pd_list[pd_index].driveType ==
                                                TYPE_DISK)) {
                        return 0;
                }
                return -ENXIO;
        }
        return 0;
}

void megaraid_sas_kill_hba(struct megasas_instance *instance)
{
        if ((instance->pdev->device == PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
            (instance->pdev->device == PCI_DEVICE_ID_LSI_SAS0071SKINNY) ||
            (instance->pdev->device == PCI_DEVICE_ID_LSI_FUSION) ||
            (instance->pdev->device == PCI_DEVICE_ID_LSI_INVADER)) {
                writel(MFI_STOP_ADP, &instance->reg_set->doorbell);
        } else {
                writel(MFI_STOP_ADP, &instance->reg_set->inbound_doorbell);
        }
}

 /**
  * megasas_check_and_restore_queue_depth - Check if queue depth needs to be
  *                                     restored to max value
  * @instance:                  Adapter soft state
  *
  */
void
megasas_check_and_restore_queue_depth(struct megasas_instance *instance)
{
        unsigned long flags;
        if (instance->flag & MEGASAS_FW_BUSY
            && time_after(jiffies, instance->last_time + 5 * HZ)
            && atomic_read(&instance->fw_outstanding) <
            instance->throttlequeuedepth + 1) {

                spin_lock_irqsave(instance->host->host_lock, flags);
                instance->flag &= ~MEGASAS_FW_BUSY;
                if ((instance->pdev->device ==
                        PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
                        (instance->pdev->device ==
                        PCI_DEVICE_ID_LSI_SAS0071SKINNY)) {
                        instance->host->can_queue =
                                instance->max_fw_cmds - MEGASAS_SKINNY_INT_CMDS;
                } else
                        instance->host->can_queue =
                                instance->max_fw_cmds - MEGASAS_INT_CMDS;

                spin_unlock_irqrestore(instance->host->host_lock, flags);
        }
}

/**
 * megasas_complete_cmd_dpc      -      Returns FW's controller structure
 * @instance_addr:                      Address of adapter soft state
 *
 * Tasklet to complete cmds
 */
static void megasas_complete_cmd_dpc(unsigned long instance_addr)
{
        u32 producer;
        u32 consumer;
        u32 context;
        struct megasas_cmd *cmd;
        struct megasas_instance *instance =
                                (struct megasas_instance *)instance_addr;
        unsigned long flags;

        /* If we have already declared adapter dead, donot complete cmds */
        if (instance->adprecovery == MEGASAS_HW_CRITICAL_ERROR )
                return;

        spin_lock_irqsave(&instance->completion_lock, flags);

        producer = *instance->producer;
        consumer = *instance->consumer;

        while (consumer != producer) {
                context = instance->reply_queue[consumer];
                if (context >= instance->max_fw_cmds) {
                        printk(KERN_ERR "Unexpected context value %x\n",
                                context);
                        BUG();
                }

                cmd = instance->cmd_list[context];

                megasas_complete_cmd(instance, cmd, DID_OK);

                consumer++;
                if (consumer == (instance->max_fw_cmds + 1)) {
                        consumer = 0;
                }
        }

        *instance->consumer = producer;

        spin_unlock_irqrestore(&instance->completion_lock, flags);

        /*
         * Check if we can restore can_queue
         */
        megasas_check_and_restore_queue_depth(instance);
}

static void
megasas_internal_reset_defer_cmds(struct megasas_instance *instance);

static void
process_fw_state_change_wq(struct work_struct *work);

void megasas_do_ocr(struct megasas_instance *instance)
{
        if ((instance->pdev->device == PCI_DEVICE_ID_LSI_SAS1064R) ||
        (instance->pdev->device == PCI_DEVICE_ID_DELL_PERC5) ||
        (instance->pdev->device == PCI_DEVICE_ID_LSI_VERDE_ZCR)) {
                *instance->consumer     = MEGASAS_ADPRESET_INPROG_SIGN;
        }
        instance->instancet->disable_intr(instance->reg_set);
        instance->adprecovery   = MEGASAS_ADPRESET_SM_INFAULT;
        instance->issuepend_done = 0;

        atomic_set(&instance->fw_outstanding, 0);
        megasas_internal_reset_defer_cmds(instance);
        process_fw_state_change_wq(&instance->work_init);
}

/**
 * megasas_wait_for_outstanding -       Wait for all outstanding cmds
 * @instance:                           Adapter soft state
 *
 * This function waits for up to MEGASAS_RESET_WAIT_TIME seconds for FW to
 * complete all its outstanding commands. Returns error if one or more IOs
 * are pending after this time period. It also marks the controller dead.
 */
static int megasas_wait_for_outstanding(struct megasas_instance *instance)
{
        int i;
        u32 reset_index;
        u32 wait_time = MEGASAS_RESET_WAIT_TIME;
        u8 adprecovery;
        unsigned long flags;
        struct list_head clist_local;
        struct megasas_cmd *reset_cmd;
        u32 fw_state;
        u8 kill_adapter_flag;

        spin_lock_irqsave(&instance->hba_lock, flags);
        adprecovery = instance->adprecovery;
        spin_unlock_irqrestore(&instance->hba_lock, flags);

        if (adprecovery != MEGASAS_HBA_OPERATIONAL) {

                INIT_LIST_HEAD(&clist_local);
                spin_lock_irqsave(&instance->hba_lock, flags);
                list_splice_init(&instance->internal_reset_pending_q,
                                &clist_local);
                spin_unlock_irqrestore(&instance->hba_lock, flags);

                printk(KERN_NOTICE "megasas: HBA reset wait ...\n");
                for (i = 0; i < wait_time; i++) {
                        msleep(1000);
                        spin_lock_irqsave(&instance->hba_lock, flags);
                        adprecovery = instance->adprecovery;
                        spin_unlock_irqrestore(&instance->hba_lock, flags);
                        if (adprecovery == MEGASAS_HBA_OPERATIONAL)
                                break;
                }

                if (adprecovery != MEGASAS_HBA_OPERATIONAL) {
                        printk(KERN_NOTICE "megasas: reset: Stopping HBA.\n");
                        spin_lock_irqsave(&instance->hba_lock, flags);
                        instance->adprecovery   = MEGASAS_HW_CRITICAL_ERROR;
                        spin_unlock_irqrestore(&instance->hba_lock, flags);
                        return FAILED;
                }

                reset_index     = 0;
                while (!list_empty(&clist_local)) {
                        reset_cmd       = list_entry((&clist_local)->next,
                                                struct megasas_cmd, list);
                        list_del_init(&reset_cmd->list);
                        if (reset_cmd->scmd) {
                                reset_cmd->scmd->result = DID_RESET << 16;
                                printk(KERN_NOTICE "%d:%p reset [%02x]\n",
                                        reset_index, reset_cmd,
                                        reset_cmd->scmd->cmnd[0]);

                                reset_cmd->scmd->scsi_done(reset_cmd->scmd);
                                megasas_return_cmd(instance, reset_cmd);
                        } else if (reset_cmd->sync_cmd) {
                                printk(KERN_NOTICE "megasas:%p synch cmds"
                                                "reset queue\n",
                                                reset_cmd);

                                reset_cmd->cmd_status = ENODATA;
                                instance->instancet->fire_cmd(instance,
                                                reset_cmd->frame_phys_addr,
                                                0, instance->reg_set);
                        } else {
                                printk(KERN_NOTICE "megasas: %p unexpected"
                                        "cmds lst\n",
                                        reset_cmd);
                        }
                        reset_index++;
                }

                return SUCCESS;
        }

        for (i = 0; i < resetwaittime; i++) {

                int outstanding = atomic_read(&instance->fw_outstanding);

                if (!outstanding)
                        break;

                if (!(i % MEGASAS_RESET_NOTICE_INTERVAL)) {
                        printk(KERN_NOTICE "megasas: [%2d]waiting for %d "
                               "commands to complete\n",i,outstanding);
                        /*
                         * Call cmd completion routine. Cmd to be
                         * be completed directly without depending on isr.
                         */
                        megasas_complete_cmd_dpc((unsigned long)instance);
                }

                msleep(1000);
        }

        i = 0;
        kill_adapter_flag = 0;
        do {
                fw_state = instance->instancet->read_fw_status_reg(
                                        instance->reg_set) & MFI_STATE_MASK;
                if ((fw_state == MFI_STATE_FAULT) &&
                        (instance->disableOnlineCtrlReset == 0)) {
                        if (i == 3) {
                                kill_adapter_flag = 2;
                                break;
                        }
                        megasas_do_ocr(instance);
                        kill_adapter_flag = 1;

                        /* wait for 1 secs to let FW finish the pending cmds */
                        msleep(1000);
                }
                i++;
        } while (i <= 3);

        if (atomic_read(&instance->fw_outstanding) &&
                                        !kill_adapter_flag) {
                if (instance->disableOnlineCtrlReset == 0) {

                        megasas_do_ocr(instance);

                        /* wait for 5 secs to let FW finish the pending cmds */
                        for (i = 0; i < wait_time; i++) {
                                int outstanding =
                                        atomic_read(&instance->fw_outstanding);
                                if (!outstanding)
                                        return SUCCESS;
                                msleep(1000);
                        }
                }
        }

        if (atomic_read(&instance->fw_outstanding) ||
                                        (kill_adapter_flag == 2)) {
                printk(KERN_NOTICE "megaraid_sas: pending cmds after reset\n");
                /*
                * Send signal to FW to stop processing any pending cmds.
                * The controller will be taken offline by the OS now.
                */
                if ((instance->pdev->device ==
                        PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
                        (instance->pdev->device ==
                        PCI_DEVICE_ID_LSI_SAS0071SKINNY)) {
                        writel(MFI_STOP_ADP,
                                &instance->reg_set->doorbell);
                } else {
                        writel(MFI_STOP_ADP,
                                &instance->reg_set->inbound_doorbell);
                }
                megasas_dump_pending_frames(instance);
                spin_lock_irqsave(&instance->hba_lock, flags);
                instance->adprecovery   = MEGASAS_HW_CRITICAL_ERROR;
                spin_unlock_irqrestore(&instance->hba_lock, flags);
                return FAILED;
        }

        printk(KERN_NOTICE "megaraid_sas: no pending cmds after reset\n");

        return SUCCESS;
}

/**
 * megasas_generic_reset -      Generic reset routine
 * @scmd:                       Mid-layer SCSI command
 *
 * This routine implements a generic reset handler for device, bus and host
 * reset requests. Device, bus and host specific reset handlers can use this
 * function after they do their specific tasks.
 */
static int megasas_generic_reset(struct scsi_cmnd *scmd)
{
        int ret_val;
        struct megasas_instance *instance;

        instance = (struct megasas_instance *)scmd->device->host->hostdata;

        scmd_printk(KERN_NOTICE, scmd, "megasas: RESET cmd=%x retries=%x\n",
                 scmd->cmnd[0], scmd->retries);

        if (instance->adprecovery == MEGASAS_HW_CRITICAL_ERROR) {
                printk(KERN_ERR "megasas: cannot recover from previous reset "
                       "failures\n");
                return FAILED;
        }

        ret_val = megasas_wait_for_outstanding(instance);
        if (ret_val == SUCCESS)
                printk(KERN_NOTICE "megasas: reset successful \n");
        else
                printk(KERN_ERR "megasas: failed to do reset\n");

        return ret_val;
}

/**
 * megasas_reset_timer - quiesce the adapter if required
 * @scmd:               scsi cmnd
 *
 * Sets the FW busy flag and reduces the host->can_queue if the
 * cmd has not been completed within the timeout period.
 */
static enum
blk_eh_timer_return megasas_reset_timer(struct scsi_cmnd *scmd)
{
        struct megasas_instance *instance;
        unsigned long flags;

        if (time_after(jiffies, scmd->jiffies_at_alloc +
                                (MEGASAS_DEFAULT_CMD_TIMEOUT * 2) * HZ)) {
                return BLK_EH_NOT_HANDLED;
        }

        instance = (struct megasas_instance *)scmd->device->host->hostdata;
        if (!(instance->flag & MEGASAS_FW_BUSY)) {
                /* FW is busy, throttle IO */
                spin_lock_irqsave(instance->host->host_lock, flags);

                instance->host->can_queue = instance->throttlequeuedepth;
                instance->last_time = jiffies;
                instance->flag |= MEGASAS_FW_BUSY;

                spin_unlock_irqrestore(instance->host->host_lock, flags);
        }
        return BLK_EH_RESET_TIMER;
}

/**
 * megasas_reset_device -       Device reset handler entry point
 */
static int megasas_reset_device(struct scsi_cmnd *scmd)
{
        int ret;

        /*
         * First wait for all commands to complete
         */
        ret = megasas_generic_reset(scmd);

        return ret;
}

/**
 * megasas_reset_bus_host -     Bus & host reset handler entry point
 */
static int megasas_reset_bus_host(struct scsi_cmnd *scmd)
{
        int ret;
        struct megasas_instance *instance;
        instance = (struct megasas_instance *)scmd->device->host->hostdata;

        /*
         * First wait for all commands to complete
         */
        if ((instance->pdev->device == PCI_DEVICE_ID_LSI_FUSION) ||
            (instance->pdev->device == PCI_DEVICE_ID_LSI_INVADER))
                ret = megasas_reset_fusion(scmd->device->host);
        else
                ret = megasas_generic_reset(scmd);

        return ret;
}

/**
 * megasas_bios_param - Returns disk geometry for a disk
 * @sdev:               device handle
 * @bdev:               block device
 * @capacity:           drive capacity
 * @geom:               geometry parameters
 */
static int
megasas_bios_param(struct scsi_device *sdev, struct block_device *bdev,
                 sector_t capacity, int geom[])
{
        int heads;
        int sectors;
        sector_t cylinders;
        unsigned long tmp;
        /* Default heads (64) & sectors (32) */
        heads = 64;
        sectors = 32;

        tmp = heads * sectors;
        cylinders = capacity;

        sector_div(cylinders, tmp);

        /*
         * Handle extended translation size for logical drives > 1Gb
         */

        if (capacity >= 0x200000) {
                heads = 255;
                sectors = 63;
                tmp = heads*sectors;
                cylinders = capacity;
                sector_div(cylinders, tmp);
        }

        geom[0] = heads;
        geom[1] = sectors;
        geom[2] = cylinders;

        return 0;
}

static void megasas_aen_polling(struct work_struct *work);

/**
 * megasas_service_aen -        Processes an event notification
 * @instance:                   Adapter soft state
 * @cmd:                        AEN command completed by the ISR
 *
 * For AEN, driver sends a command down to FW that is held by the FW till an
 * event occurs. When an event of interest occurs, FW completes the command
 * that it was previously holding.
 *
 * This routines sends SIGIO signal to processes that have registered with the
 * driver for AEN.
 */
static void
megasas_service_aen(struct megasas_instance *instance, struct megasas_cmd *cmd)
{
        unsigned long flags;
        /*
         * Don't signal app if it is just an aborted previously registered aen
         */
        if ((!cmd->abort_aen) && (instance->unload == 0)) {
                spin_lock_irqsave(&poll_aen_lock, flags);
                megasas_poll_wait_aen = 1;
                spin_unlock_irqrestore(&poll_aen_lock, flags);
                wake_up(&megasas_poll_wait);
                kill_fasync(&megasas_async_queue, SIGIO, POLL_IN);
        }
        else
                cmd->abort_aen = 0;

        instance->aen_cmd = NULL;
        megasas_return_cmd(instance, cmd);

        if ((instance->unload == 0) &&
                ((instance->issuepend_done == 1))) {
                struct megasas_aen_event *ev;
                ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
                if (!ev) {
                        printk(KERN_ERR "megasas_service_aen: out of memory\n");
                } else {
                        ev->instance = instance;
                        instance->ev = ev;
                        INIT_DELAYED_WORK(&ev->hotplug_work,
                                          megasas_aen_polling);
                        schedule_delayed_work(&ev->hotplug_work, 0);
                }
        }
}

static int megasas_change_queue_depth(struct scsi_device *sdev,
                                      int queue_depth, int reason)
{
        if (reason != SCSI_QDEPTH_DEFAULT)
                return -EOPNOTSUPP;

        if (queue_depth > sdev->host->can_queue)
                queue_depth = sdev->host->can_queue;
        scsi_adjust_queue_depth(sdev, scsi_get_tag_type(sdev),
                                queue_depth);

        return queue_depth;
}

/*
 * Scsi host template for megaraid_sas driver
 */
static struct scsi_host_template megasas_template = {

        .module = THIS_MODULE,
        .name = "LSI SAS based MegaRAID driver",
        .proc_name = "megaraid_sas",
        .slave_configure = megasas_slave_configure,
        .slave_alloc = megasas_slave_alloc,
        .queuecommand = megasas_queue_command,
        .eh_device_reset_handler = megasas_reset_device,
        .eh_bus_reset_handler = megasas_reset_bus_host,
        .eh_host_reset_handler = megasas_reset_bus_host,
        .eh_timed_out = megasas_reset_timer,
        .bios_param = megasas_bios_param,
        .use_clustering = ENABLE_CLUSTERING,
        .change_queue_depth = megasas_change_queue_depth,
};

/**
 * megasas_complete_int_cmd -   Completes an internal command
 * @instance:                   Adapter soft state
 * @cmd:                        Command to be completed
 *
 * The megasas_issue_blocked_cmd() function waits for a command to complete
 * after it issues a command. This function wakes up that waiting routine by
 * calling wake_up() on the wait queue.
 */
static void
megasas_complete_int_cmd(struct megasas_instance *instance,
                         struct megasas_cmd *cmd)
{
        cmd->cmd_status = cmd->frame->io.cmd_status;

        if (cmd->cmd_status == ENODATA) {
                cmd->cmd_status = 0;
        }
        wake_up(&instance->int_cmd_wait_q);
}

/**
 * megasas_complete_abort -     Completes aborting a command
 * @instance:                   Adapter soft state
 * @cmd:                        Cmd that was issued to abort another cmd
 *
 * The megasas_issue_blocked_abort_cmd() function waits on abort_cmd_wait_q
 * after it issues an abort on a previously issued command. This function
 * wakes up all functions waiting on the same wait queue.
 */
static void
megasas_complete_abort(struct megasas_instance *instance,
                       struct megasas_cmd *cmd)
{
        if (cmd->sync_cmd) {
                cmd->sync_cmd = 0;
                cmd->cmd_status = 0;
                wake_up(&instance->abort_cmd_wait_q);
        }

        return;
}

/**
 * megasas_complete_cmd -       Completes a command
 * @instance:                   Adapter soft state
 * @cmd:                        Command to be completed
 * @alt_status:                 If non-zero, use this value as status to
 *                              SCSI mid-layer instead of the value returned
 *                              by the FW. This should be used if caller wants
 *                              an alternate status (as in the case of aborted
 *                              commands)
 */
void
megasas_complete_cmd(struct megasas_instance *instance, struct megasas_cmd *cmd,
                     u8 alt_status)
{
        int exception = 0;
        struct megasas_header *hdr = &cmd->frame->hdr;
        unsigned long flags;
        struct fusion_context *fusion = instance->ctrl_context;

        /* flag for the retry reset */
        cmd->retry_for_fw_reset = 0;

        if (cmd->scmd)
                cmd->scmd->SCp.ptr = NULL;

        switch (hdr->cmd) {
        case MFI_CMD_INVALID:
                /* Some older 1068 controller FW may keep a pended
                   MR_DCMD_CTRL_EVENT_GET_INFO left over from the main kernel
                   when booting the kdump kernel.  Ignore this command to
                   prevent a kernel panic on shutdown of the kdump kernel. */
                printk(KERN_WARNING "megaraid_sas: MFI_CMD_INVALID command "
                       "completed.\n");
                printk(KERN_WARNING "megaraid_sas: If you have a controller "
                       "other than PERC5, please upgrade your firmware.\n");
                break;
        case MFI_CMD_PD_SCSI_IO:
        case MFI_CMD_LD_SCSI_IO:

                /*
                 * MFI_CMD_PD_SCSI_IO and MFI_CMD_LD_SCSI_IO could have been
                 * issued either through an IO path or an IOCTL path. If it
                 * was via IOCTL, we will send it to internal completion.
                 */
                if (cmd->sync_cmd) {
                        cmd->sync_cmd = 0;
                        megasas_complete_int_cmd(instance, cmd);
                        break;
                }

        case MFI_CMD_LD_READ:
        case MFI_CMD_LD_WRITE:

                if (alt_status) {
                        cmd->scmd->result = alt_status << 16;
                        exception = 1;
                }

                if (exception) {

                        atomic_dec(&instance->fw_outstanding);

                        scsi_dma_unmap(cmd->scmd);
                        cmd->scmd->scsi_done(cmd->scmd);
                        megasas_return_cmd(instance, cmd);

                        break;
                }

                switch (hdr->cmd_status) {

                case MFI_STAT_OK:
                        cmd->scmd->result = DID_OK << 16;
                        break;

                case MFI_STAT_SCSI_IO_FAILED:
                case MFI_STAT_LD_INIT_IN_PROGRESS:
                        cmd->scmd->result =
                            (DID_ERROR << 16) | hdr->scsi_status;
                        break;

                case MFI_STAT_SCSI_DONE_WITH_ERROR:

                        cmd->scmd->result = (DID_OK << 16) | hdr->scsi_status;

                        if (hdr->scsi_status == SAM_STAT_CHECK_CONDITION) {
                                memset(cmd->scmd->sense_buffer, 0,
                                       SCSI_SENSE_BUFFERSIZE);
                                memcpy(cmd->scmd->sense_buffer, cmd->sense,
                                       hdr->sense_len);

                                cmd->scmd->result |= DRIVER_SENSE << 24;
                        }

                        break;

                case MFI_STAT_LD_OFFLINE:
                case MFI_STAT_DEVICE_NOT_FOUND:
                        cmd->scmd->result = DID_BAD_TARGET << 16;
                        break;

                default:
                        printk(KERN_DEBUG "megasas: MFI FW status %#x\n",
                               hdr->cmd_status);
                        cmd->scmd->result = DID_ERROR << 16;
                        break;
                }

                atomic_dec(&instance->fw_outstanding);

                scsi_dma_unmap(cmd->scmd);
                cmd->scmd->scsi_done(cmd->scmd);
                megasas_return_cmd(instance, cmd);

                break;

        case MFI_CMD_SMP:
        case MFI_CMD_STP:
        case MFI_CMD_DCMD:
                /* Check for LD map update */
                if ((cmd->frame->dcmd.opcode == MR_DCMD_LD_MAP_GET_INFO) &&
                    (cmd->frame->dcmd.mbox.b[1] == 1)) {
                        spin_lock_irqsave(instance->host->host_lock, flags);
                        if (cmd->frame->hdr.cmd_status != 0) {
                                if (cmd->frame->hdr.cmd_status !=
                                    MFI_STAT_NOT_FOUND)
                                        printk(KERN_WARNING "megasas: map sync"
                                               "failed, status = 0x%x.\n",
                                               cmd->frame->hdr.cmd_status);
                                else {
                                        megasas_return_cmd(instance, cmd);
                                        spin_unlock_irqrestore(
                                                instance->host->host_lock,
                                                flags);
                                        break;
                                }
                        } else
                                instance->map_id++;
                        megasas_return_cmd(instance, cmd);
                        if (MR_ValidateMapInfo(
                                    fusion->ld_map[(instance->map_id & 1)],
                                    fusion->load_balance_info))
                                fusion->fast_path_io = 1;
                        else
                                fusion->fast_path_io = 0;
                        megasas_sync_map_info(instance);
                        spin_unlock_irqrestore(instance->host->host_lock,
                                               flags);
                        break;
                }
                if (cmd->frame->dcmd.opcode == MR_DCMD_CTRL_EVENT_GET_INFO ||
                        cmd->frame->dcmd.opcode == MR_DCMD_CTRL_EVENT_GET) {
                        spin_lock_irqsave(&poll_aen_lock, flags);
                        megasas_poll_wait_aen = 0;
                        spin_unlock_irqrestore(&poll_aen_lock, flags);
                }

                /*
                 * See if got an event notification
                 */
                if (cmd->frame->dcmd.opcode == MR_DCMD_CTRL_EVENT_WAIT)
                        megasas_service_aen(instance, cmd);
                else
                        megasas_complete_int_cmd(instance, cmd);

                break;

        case MFI_CMD_ABORT:
                /*
                 * Cmd issued to abort another cmd returned
                 */
                megasas_complete_abort(instance, cmd);
                break;

        default:
                printk("megasas: Unknown command completed! [0x%X]\n",
                       hdr->cmd);
                break;
        }
}

/**
 * megasas_issue_pending_cmds_again -   issue all pending cmds
 *                                      in FW again because of the fw reset
 * @instance:                           Adapter soft state
 */
static inline void
megasas_issue_pending_cmds_again(struct megasas_instance *instance)
{
        struct megasas_cmd *cmd;
        struct list_head clist_local;
        union megasas_evt_class_locale class_locale;
        unsigned long flags;
        u32 seq_num;

        INIT_LIST_HEAD(&clist_local);
        spin_lock_irqsave(&instance->hba_lock, flags);
        list_splice_init(&instance->internal_reset_pending_q, &clist_local);
        spin_unlock_irqrestore(&instance->hba_lock, flags);

        while (!list_empty(&clist_local)) {
                cmd     = list_entry((&clist_local)->next,
                                        struct megasas_cmd, list);
                list_del_init(&cmd->list);

                if (cmd->sync_cmd || cmd->scmd) {
                        printk(KERN_NOTICE "megaraid_sas: command %p, %p:%d"
                                "detected to be pending while HBA reset.\n",
                                        cmd, cmd->scmd, cmd->sync_cmd);

                        cmd->retry_for_fw_reset++;

                        if (cmd->retry_for_fw_reset == 3) {
                                printk(KERN_NOTICE "megaraid_sas: cmd %p, %p:%d"
                                        "was tried multiple times during reset."
                                        "Shutting down the HBA\n",
                                        cmd, cmd->scmd, cmd->sync_cmd);
                                megaraid_sas_kill_hba(instance);

                                instance->adprecovery =
                                                MEGASAS_HW_CRITICAL_ERROR;
                                return;
                        }
                }

                if (cmd->sync_cmd == 1) {
                        if (cmd->scmd) {
                                printk(KERN_NOTICE "megaraid_sas: unexpected"
                                        "cmd attached to internal command!\n");
                        }
                        printk(KERN_NOTICE "megasas: %p synchronous cmd"
                                                "on the internal reset queue,"
                                                "issue it again.\n", cmd);
                        cmd->cmd_status = ENODATA;
                        instance->instancet->fire_cmd(instance,
                                                        cmd->frame_phys_addr ,
                                                        0, instance->reg_set);
                } else if (cmd->scmd) {
                        printk(KERN_NOTICE "megasas: %p scsi cmd [%02x]"
                        "detected on the internal queue, issue again.\n",
                        cmd, cmd->scmd->cmnd[0]);

                        atomic_inc(&instance->fw_outstanding);
                        instance->instancet->fire_cmd(instance,
                                        cmd->frame_phys_addr,
                                        cmd->frame_count-1, instance->reg_set);
                } else {
                        printk(KERN_NOTICE "megasas: %p unexpected cmd on the"
                                "internal reset defer list while re-issue!!\n",
                                cmd);
                }
        }

        if (instance->aen_cmd) {
                printk(KERN_NOTICE "megaraid_sas: aen_cmd in def process\n");
                megasas_return_cmd(instance, instance->aen_cmd);

                instance->aen_cmd       = NULL;
        }

        /*
        * Initiate AEN (Asynchronous Event Notification)
        */
        seq_num = instance->last_seq_num;
        class_locale.members.reserved = 0;
        class_locale.members.locale = MR_EVT_LOCALE_ALL;
        class_locale.members.class = MR_EVT_CLASS_DEBUG;

        megasas_register_aen(instance, seq_num, class_locale.word);
}

/**
 * Move the internal reset pending commands to a deferred queue.
 *
 * We move the commands pending at internal reset time to a
 * pending queue. This queue would be flushed after successful
 * completion of the internal reset sequence. if the internal reset
 * did not complete in time, the kernel reset handler would flush
 * these commands.
 **/
static void
megasas_internal_reset_defer_cmds(struct megasas_instance *instance)
{
        struct megasas_cmd *cmd;
        int i;
        u32 max_cmd = instance->max_fw_cmds;
        u32 defer_index;
        unsigned long flags;

        defer_index     = 0;
        spin_lock_irqsave(&instance->cmd_pool_lock, flags);
        for (i = 0; i < max_cmd; i++) {
                cmd = instance->cmd_list[i];
                if (cmd->sync_cmd == 1 || cmd->scmd) {
                        printk(KERN_NOTICE "megasas: moving cmd[%d]:%p:%d:%p"
                                        "on the defer queue as internal\n",
                                defer_index, cmd, cmd->sync_cmd, cmd->scmd);

                        if (!list_empty(&cmd->list)) {
                                printk(KERN_NOTICE "megaraid_sas: ERROR while"
                                        " moving this cmd:%p, %d %p, it was"
                                        "discovered on some list?\n",
                                        cmd, cmd->sync_cmd, cmd->scmd);

                                list_del_init(&cmd->list);
                        }
                        defer_index++;
                        list_add_tail(&cmd->list,
                                &instance->internal_reset_pending_q);
                }
        }
        spin_unlock_irqrestore(&instance->cmd_pool_lock, flags);
}


static void
process_fw_state_change_wq(struct work_struct *work)
{
        struct megasas_instance *instance =
                container_of(work, struct megasas_instance, work_init);
        u32 wait;
        unsigned long flags;

        if (instance->adprecovery != MEGASAS_ADPRESET_SM_INFAULT) {
                printk(KERN_NOTICE "megaraid_sas: error, recovery st %x \n",
                                instance->adprecovery);
                return ;
        }

        if (instance->adprecovery == MEGASAS_ADPRESET_SM_INFAULT) {
                printk(KERN_NOTICE "megaraid_sas: FW detected to be in fault"
                                        "state, restarting it...\n");

                instance->instancet->disable_intr(instance->reg_set);
                atomic_set(&instance->fw_outstanding, 0);

                atomic_set(&instance->fw_reset_no_pci_access, 1);
                instance->instancet->adp_reset(instance, instance->reg_set);
                atomic_set(&instance->fw_reset_no_pci_access, 0 );

                printk(KERN_NOTICE "megaraid_sas: FW restarted successfully,"
                                        "initiating next stage...\n");

                printk(KERN_NOTICE "megaraid_sas: HBA recovery state machine,"
                                        "state 2 starting...\n");

                /*waitting for about 20 second before start the second init*/
                for (wait = 0; wait < 30; wait++) {
                        msleep(1000);
                }

                if (megasas_transition_to_ready(instance, 1)) {
                        printk(KERN_NOTICE "megaraid_sas:adapter not ready\n");

                        megaraid_sas_kill_hba(instance);
                        instance->adprecovery   = MEGASAS_HW_CRITICAL_ERROR;
                        return ;
                }

                if ((instance->pdev->device == PCI_DEVICE_ID_LSI_SAS1064R) ||
                        (instance->pdev->device == PCI_DEVICE_ID_DELL_PERC5) ||
                        (instance->pdev->device == PCI_DEVICE_ID_LSI_VERDE_ZCR)
                        ) {
                        *instance->consumer = *instance->producer;
                } else {
                        *instance->consumer = 0;
                        *instance->producer = 0;
                }

                megasas_issue_init_mfi(instance);

                spin_lock_irqsave(&instance->hba_lock, flags);
                instance->adprecovery   = MEGASAS_HBA_OPERATIONAL;
                spin_unlock_irqrestore(&instance->hba_lock, flags);
                instance->instancet->enable_intr(instance->reg_set);

                megasas_issue_pending_cmds_again(instance);
                instance->issuepend_done = 1;
        }
        return ;
}

/**
 * megasas_deplete_reply_queue -        Processes all completed commands
 * @instance:                           Adapter soft state
 * @alt_status:                         Alternate status to be returned to
 *                                      SCSI mid-layer instead of the status
 *                                      returned by the FW
 * Note: this must be called with hba lock held
 */
static int
megasas_deplete_reply_queue(struct megasas_instance *instance,
                                        u8 alt_status)
{
        u32 mfiStatus;
        u32 fw_state;

        if ((mfiStatus = instance->instancet->check_reset(instance,
                                        instance->reg_set)) == 1) {
                return IRQ_HANDLED;
        }

        if ((mfiStatus = instance->instancet->clear_intr(
                                                instance->reg_set)
                                                ) == 0) {
                /* Hardware may not set outbound_intr_status in MSI-X mode */
                if (!instance->msix_vectors)
                        return IRQ_NONE;
        }

        instance->mfiStatus = mfiStatus;

        if ((mfiStatus & MFI_INTR_FLAG_FIRMWARE_STATE_CHANGE)) {
                fw_state = instance->instancet->read_fw_status_reg(
                                instance->reg_set) & MFI_STATE_MASK;

                if (fw_state != MFI_STATE_FAULT) {
                        printk(KERN_NOTICE "megaraid_sas: fw state:%x\n",
                                                fw_state);
                }

                if ((fw_state == MFI_STATE_FAULT) &&
                                (instance->disableOnlineCtrlReset == 0)) {
                        printk(KERN_NOTICE "megaraid_sas: wait adp restart\n");

                        if ((instance->pdev->device ==
                                        PCI_DEVICE_ID_LSI_SAS1064R) ||
                                (instance->pdev->device ==
                                        PCI_DEVICE_ID_DELL_PERC5) ||
                                (instance->pdev->device ==
                                        PCI_DEVICE_ID_LSI_VERDE_ZCR)) {

                                *instance->consumer =
                                        MEGASAS_ADPRESET_INPROG_SIGN;
                        }


                        instance->instancet->disable_intr(instance->reg_set);
                        instance->adprecovery   = MEGASAS_ADPRESET_SM_INFAULT;
                        instance->issuepend_done = 0;

                        atomic_set(&instance->fw_outstanding, 0);
                        megasas_internal_reset_defer_cmds(instance);

                        printk(KERN_NOTICE "megasas: fwState=%x, stage:%d\n",
                                        fw_state, instance->adprecovery);

                        schedule_work(&instance->work_init);
                        return IRQ_HANDLED;

                } else {
                        printk(KERN_NOTICE "megasas: fwstate:%x, dis_OCR=%x\n",
                                fw_state, instance->disableOnlineCtrlReset);
                }
        }

        tasklet_schedule(&instance->isr_tasklet);
        return IRQ_HANDLED;
}
/**
 * megasas_isr - isr entry point
 */
static irqreturn_t megasas_isr(int irq, void *devp)
{
        struct megasas_irq_context *irq_context = devp;
        struct megasas_instance *instance = irq_context->instance;
        unsigned long flags;
        irqreturn_t     rc;

        if (atomic_read(&instance->fw_reset_no_pci_access))
                return IRQ_HANDLED;

        spin_lock_irqsave(&instance->hba_lock, flags);
        rc =  megasas_deplete_reply_queue(instance, DID_OK);
        spin_unlock_irqrestore(&instance->hba_lock, flags);

        return rc;
}

/**
 * megasas_transition_to_ready -        Move the FW to READY state
 * @instance:                           Adapter soft state
 *
 * During the initialization, FW passes can potentially be in any one of
 * several possible states. If the FW in operational, waiting-for-handshake
 * states, driver must take steps to bring it to ready state. Otherwise, it
 * has to wait for the ready state.
 */
int
megasas_transition_to_ready(struct megasas_instance *instance, int ocr)
{
        int i;
        u8 max_wait;
        u32 fw_state;
        u32 cur_state;
        u32 abs_state, curr_abs_state;

        fw_state = instance->instancet->read_fw_status_reg(instance->reg_set) & MFI_STATE_MASK;

        if (fw_state != MFI_STATE_READY)
                printk(KERN_INFO "megasas: Waiting for FW to come to ready"
                       " state\n");

        while (fw_state != MFI_STATE_READY) {

                abs_state =
                instance->instancet->read_fw_status_reg(instance->reg_set);

                switch (fw_state) {

                case MFI_STATE_FAULT:
                        printk(KERN_DEBUG "megasas: FW in FAULT state!!\n");
                        if (ocr) {
                                max_wait = MEGASAS_RESET_WAIT_TIME;
                                cur_state = MFI_STATE_FAULT;
                                break;
                        } else
                                return -ENODEV;

                case MFI_STATE_WAIT_HANDSHAKE:
                        /*
                         * Set the CLR bit in inbound doorbell
                         */
                        if ((instance->pdev->device ==
                                PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
                                (instance->pdev->device ==
                                 PCI_DEVICE_ID_LSI_SAS0071SKINNY) ||
                                (instance->pdev->device ==
                                 PCI_DEVICE_ID_LSI_FUSION) ||
                                (instance->pdev->device ==
                                PCI_DEVICE_ID_LSI_INVADER)) {
                                writel(
                                  MFI_INIT_CLEAR_HANDSHAKE|MFI_INIT_HOTPLUG,
                                  &instance->reg_set->doorbell);
                        } else {
                                writel(
                                    MFI_INIT_CLEAR_HANDSHAKE|MFI_INIT_HOTPLUG,
                                        &instance->reg_set->inbound_doorbell);
                        }

                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_WAIT_HANDSHAKE;
                        break;

                case MFI_STATE_BOOT_MESSAGE_PENDING:
                        if ((instance->pdev->device ==
                             PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
                                (instance->pdev->device ==
                                 PCI_DEVICE_ID_LSI_SAS0071SKINNY) ||
                            (instance->pdev->device ==
                             PCI_DEVICE_ID_LSI_FUSION) ||
                            (instance->pdev->device ==
                             PCI_DEVICE_ID_LSI_INVADER)) {
                                writel(MFI_INIT_HOTPLUG,
                                       &instance->reg_set->doorbell);
                        } else
                                writel(MFI_INIT_HOTPLUG,
                                        &instance->reg_set->inbound_doorbell);

                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_BOOT_MESSAGE_PENDING;
                        break;

                case MFI_STATE_OPERATIONAL:
                        /*
                         * Bring it to READY state; assuming max wait 10 secs
                         */
                        instance->instancet->disable_intr(instance->reg_set);
                        if ((instance->pdev->device ==
                                PCI_DEVICE_ID_LSI_SAS0073SKINNY) ||
                                (instance->pdev->device ==
                                PCI_DEVICE_ID_LSI_SAS0071SKINNY)  ||
                                (instance->pdev->device
                                        == PCI_DEVICE_ID_LSI_FUSION) ||
                                (instance->pdev->device
                                        == PCI_DEVICE_ID_LSI_INVADER)) {
                                writel(MFI_RESET_FLAGS,
                                        &instance->reg_set->doorbell);
                                if ((instance->pdev->device ==
                                    PCI_DEVICE_ID_LSI_FUSION) ||
                                    (instance->pdev->device ==
                                     PCI_DEVICE_ID_LSI_INVADER)) {
                                        for (i = 0; i < (10 * 1000); i += 20) {
                                                if (readl(
                                                            &instance->
                                                            reg_set->
                                                            doorbell) & 1)
                                                        msleep(20);
                                                else
                                                        break;
                                        }
                                }
                        } else
                                writel(MFI_RESET_FLAGS,
                                        &instance->reg_set->inbound_doorbell);

                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_OPERATIONAL;
                        break;

                case MFI_STATE_UNDEFINED:
                        /*
                         * This state should not last for more than 2 seconds
                         */
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_UNDEFINED;
                        break;

                case MFI_STATE_BB_INIT:
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_BB_INIT;
                        break;

                case MFI_STATE_FW_INIT:
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_FW_INIT;
                        break;

                case MFI_STATE_FW_INIT_2:
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_FW_INIT_2;
                        break;

                case MFI_STATE_DEVICE_SCAN:
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_DEVICE_SCAN;
                        break;

                case MFI_STATE_FLUSH_CACHE:
                        max_wait = MEGASAS_RESET_WAIT_TIME;
                        cur_state = MFI_STATE_FLUSH_CACHE;
                        break;

                default:
                        printk(KERN_DEBUG "megasas: Unknown state 0x%x\n",
                               fw_state);
                        return -ENODEV;
                }

                /*
                 * The cur_state should not last for more than max_wait secs
                 */
                for (i = 0; i < (max_wait * 1000); i++) {
                        fw_state = instance->instancet->read_fw_status_reg(instance->reg_set) &
                                        MFI_STATE_MASK ;
                curr_abs_state =
                instance->instancet->read_fw_status_reg(instance->reg_set);

                        if (abs_state == curr_abs_state) {
                                msleep(1);
                        } else
                                break;
                }

                /*
                 * Return error if fw_state hasn't changed after max_wait
                 */
                if (curr_abs_state == abs_state) {
                        printk(KERN_DEBUG "FW state [%d] hasn't changed "
                               "in %d secs\n", fw_state, max_wait);
                        return -ENODEV;
                }
        }
        printk(KERN_INFO "megasas: FW now in Ready state\n");

        return 0;
}

/**
 * megasas_teardown_frame_pool -        Destroy the cmd frame DMA pool
 * @instance:                           Adapter soft state
 */
static void megasas_teardown_frame_pool(struct megasas_instance *instance)
{
        int i;
        u32 max_cmd = instance->max_mfi_cmds;
        struct megasas_cmd *cmd;

        if (!instance->frame_dma_pool)
                return;

        /*
         * Return all frames to pool
         */
        for (i = 0; i < max_cmd; i++) {

                cmd = instance->cmd_list[i];

                if (cmd->frame)
                        pci_pool_free(instance->frame_dma_pool, cmd->frame,
                                      cmd->frame_phys_addr);

                if (cmd->sense)
                        pci_pool_free(instance->sense_dma_pool, cmd->sense,
                                      cmd->sense_phys_addr);
        }

        /*
         * Now destroy the pool itself
         */
        pci_pool_destroy(instance->frame_dma_pool);
        pci_pool_destroy(instance->sense_dma_pool);

        instance->frame_dma_pool = NULL;
        instance->sense_dma_pool = NULL;
}

/**
 * megasas_create_frame_pool -  Creates DMA pool for cmd frames
 * @instance:                   Adapter soft state
 *
 * Each command packet has an embedded DMA memory buffer that is used for
 * filling MFI frame and the SG list that immediately follows the frame. This
 * function creates those DMA memory buffers for each command packet by using
 * PCI pool facility.
 */
static int megasas_create_frame_pool(struct megasas_instance *instance)
{
        int i;
        u32 max_cmd;
        u32 sge_sz;
        u32 sgl_sz;
        u32 total_sz;
        u32 frame_count;
        struct megasas_cmd *cmd;

        max_cmd = instance->max_mfi_cmds;

        /*
         * Size of our frame is 64 bytes for MFI frame, followed by max SG
         * elements and finally SCSI_SENSE_BUFFERSIZE bytes for sense buffer
         */
        sge_sz = (IS_DMA64) ? sizeof(struct megasas_sge64) :
            sizeof(struct megasas_sge32);

        if (instance->flag_ieee) {
                sge_sz = sizeof(struct megasas_sge_skinny);
        }

        /*
         * Calculated the number of 64byte frames required for SGL
         */
        sgl_sz = sge_sz * instance->max_num_sge;
        frame_count = (sgl_sz + MEGAMFI_FRAME_SIZE - 1) / MEGAMFI_FRAME_SIZE;
        frame_count = 15;

        /*
         * We need one extra frame for the MFI command
         */
        frame_count++;

        total_sz = MEGAMFI_FRAME_SIZE * frame_count;
        /*
         * Use DMA pool facility provided by PCI layer
         */
        instance->frame_dma_pool = pci_pool_create("megasas frame pool",
                                                   instance->pdev, total_sz, 64,
                                                   0);

        if (!instance->frame_dma_pool) {
                printk(KERN_DEBUG "megasas: failed to setup frame pool\n");
                return -ENOMEM;
        }

        instance->sense_dma_pool = pci_pool_create("megasas sense pool",
                                                   instance->pdev, 128, 4, 0);

        if (!instance->sense_dma_pool) {
                printk(KERN_DEBUG "megasas: failed to setup sense pool\n");

                pci_pool_destroy(instance->frame_dma_pool);
                instance->frame_dma_pool = NULL;

                return -ENOMEM;
        }

        /*
         * Allocate and attach a frame to each of the commands in cmd_list.
         * By making cmd->index as the context instead of the &cmd, we can
         * always use 32bit context regardless of the architecture
         */
        for (i = 0; i < max_cmd; i++) {

                cmd = instance->cmd_list[i];

                cmd->frame = pci_pool_alloc(instance->frame_dma_pool,
                                            GFP_KERNEL, &cmd->frame_phys_addr);

                cmd->sense = pci_pool_alloc(instance->sense_dma_pool,
                                            GFP_KERNEL, &cmd->sense_phys_addr);

                /*
                 * megasas_teardown_frame_pool() takes care of freeing
                 * whatever has been allocated
                 */
                if (!cmd->frame || !cmd->sense) {
                        printk(KERN_DEBUG "megasas: pci_pool_alloc failed \n");
                        megasas_teardown_frame_pool(instance);
                        return -ENOMEM;
                }

                memset(cmd->frame, 0, total_sz);
                cmd->frame->io.context = cmd->index;
                cmd->frame->io.pad_0 = 0;
                if ((instance->pdev->device != PCI_DEVICE_ID_LSI_FUSION) &&
                    (instance->pdev->device != PCI_DEVICE_ID_LSI_INVADER) &&
                    (reset_devices))
                        cmd->frame->hdr.cmd = MFI_CMD_INVALID;
        }

        return 0;
}

/**
 * megasas_free_cmds -  Free all the cmds in the free cmd pool
 * @instance:           Adapter soft state
 */
void megasas_free_cmds(struct megasas_instance *instance)
{
        int i;
        /* First free the MFI frame pool */
        megasas_teardown_frame_pool(instance);

        /* Free all the commands in the cmd_list */
        for (i = 0; i < instance->max_mfi_cmds; i++)

                kfree(instance->cmd_list[i]);

        /* Free the cmd_list buffer itself */
        kfree(instance->cmd_list);
        instance->cmd_list = NULL;

        INIT_LIST_HEAD(&instance->cmd_pool);
}

/**
 * megasas_alloc_cmds - Allocates the command packets
 * @instance:           Adapter soft state
 *
 * Each command that is issued to the FW, whether IO commands from the OS or
 * internal commands like IOCTLs, are wrapped in local data structure called
 * megasas_cmd. The frame embedded in this megasas_cmd is actually issued to
 * the FW.
 *
 * Each frame has a 32-bit field called context (tag). This context is used
 * to get back the megasas_cmd from the frame when a frame gets completed in
 * the ISR. Typically the address of the megasas_cmd itself would be used as
 * the context. But we wanted to keep the differences between 32 and 64 bit
 * systems to the mininum. We always use 32 bit integers for the context. In
 * this driver, the 32 bit values are the indices into an array cmd_list.
 * This array is used only to look up the megasas_cmd given the context. The
 * free commands themselves are maintained in a linked list called cmd_pool.
 */
int megasas_alloc_cmds(struct megasas_instance *instance)