[mirror_ubuntu-focal-kernel.git] / drivers / scsi / hpsa.h

/*
 *    Disk Array driver for HP Smart Array SAS controllers
 *    Copyright 2000, 2009 Hewlett-Packard Development Company, L.P.
 *
 *    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; version 2 of the License.
 *
 *    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, GOOD TITLE or
 *    NON INFRINGEMENT.  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., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *    Questions/Comments/Bugfixes to iss_storagedev@hp.com
 *
 */
#ifndef HPSA_H
#define HPSA_H

#include <scsi/scsicam.h>

#define IO_OK		0
#define IO_ERROR	1

struct ctlr_info;

struct access_method {
	void (*submit_command)(struct ctlr_info *h,
		struct CommandList *c);
	void (*set_intr_mask)(struct ctlr_info *h, unsigned long val);
	unsigned long (*fifo_full)(struct ctlr_info *h);
	bool (*intr_pending)(struct ctlr_info *h);
	unsigned long (*command_completed)(struct ctlr_info *h, u8 q);
};

struct hpsa_scsi_dev_t {
	int devtype;
	int bus, target, lun;		/* as presented to the OS */
	unsigned char scsi3addr[8];	/* as presented to the HW */
#define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
	unsigned char device_id[16];    /* from inquiry pg. 0x83 */
	unsigned char vendor[8];        /* bytes 8-15 of inquiry data */
	unsigned char model[16];        /* bytes 16-31 of inquiry data */
	unsigned char raid_level;	/* from inquiry page 0xC1 */
	u32 ioaccel_handle;
	int offload_config;		/* I/O accel RAID offload configured */
	int offload_enabled;		/* I/O accel RAID offload enabled */
	int offload_to_mirror;		/* Send next I/O accelerator RAID
					 * offload request to mirror drive
					 */
	struct raid_map_data raid_map;	/* I/O accelerator RAID map */

};

struct reply_pool {
	u64 *head;
	size_t size;
	u8 wraparound;
	u32 current_entry;
};

struct ctlr_info {
	int	ctlr;
	char	devname[8];
	char    *product_name;
	struct pci_dev *pdev;
	u32	board_id;
	void __iomem *vaddr;
	unsigned long paddr;
	int 	nr_cmds; /* Number of commands allowed on this controller */
	struct CfgTable __iomem *cfgtable;
	int	interrupts_enabled;
	int	major;
	int 	max_commands;
	int	commands_outstanding;
	int 	max_outstanding; /* Debug */
	int	usage_count;  /* number of opens all all minor devices */
#	define PERF_MODE_INT	0
#	define DOORBELL_INT	1
#	define SIMPLE_MODE_INT	2
#	define MEMQ_MODE_INT	3
	unsigned int intr[MAX_REPLY_QUEUES];
	unsigned int msix_vector;
	unsigned int msi_vector;
	int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
	struct access_method access;

	/* queue and queue Info */
	struct list_head reqQ;
	struct list_head cmpQ;
	unsigned int Qdepth;
	unsigned int maxSG;
	spinlock_t lock;
	int maxsgentries;
	u8 max_cmd_sg_entries;
	int chainsize;
	struct SGDescriptor **cmd_sg_list;

	/* pointers to command and error info pool */
	struct CommandList 	*cmd_pool;
	dma_addr_t		cmd_pool_dhandle;
	struct io_accel1_cmd	*ioaccel_cmd_pool;
	dma_addr_t		ioaccel_cmd_pool_dhandle;
	struct ErrorInfo 	*errinfo_pool;
	dma_addr_t		errinfo_pool_dhandle;
	unsigned long  		*cmd_pool_bits;
	int			scan_finished;
	spinlock_t		scan_lock;
	wait_queue_head_t	scan_wait_queue;

	struct Scsi_Host *scsi_host;
	spinlock_t devlock; /* to protect hba[ctlr]->dev[];  */
	int ndevices; /* number of used elements in .dev[] array. */
	struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
	/*
	 * Performant mode tables.
	 */
	u32 trans_support;
	u32 trans_offset;
	struct TransTable_struct *transtable;
	unsigned long transMethod;

	/* cap concurrent passthrus at some reasonable maximum */
#define HPSA_MAX_CONCURRENT_PASSTHRUS (20)
	spinlock_t passthru_count_lock; /* protects passthru_count */
	int passthru_count;

	/*
	 * Performant mode completion buffers
	 */
	u64 *reply_pool;
	size_t reply_pool_size;
	struct reply_pool reply_queue[MAX_REPLY_QUEUES];
	u8 nreply_queues;
	dma_addr_t reply_pool_dhandle;
	u32 *blockFetchTable;
	u32 *ioaccel1_blockFetchTable;
	unsigned char *hba_inquiry_data;
	u32 driver_support;
	u32 fw_support;
	int ioaccel_support;
	int ioaccel_maxsg;
	u64 last_intr_timestamp;
	u32 last_heartbeat;
	u64 last_heartbeat_timestamp;
	u32 heartbeat_sample_interval;
	atomic_t firmware_flash_in_progress;
	u32 lockup_detected;
	struct delayed_work monitor_ctlr_work;
	int remove_in_progress;
	u32 fifo_recently_full;
	/* Address of h->q[x] is passed to intr handler to know which queue */
	u8 q[MAX_REPLY_QUEUES];
	u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
#define HPSATMF_BITS_SUPPORTED  (1 << 0)
#define HPSATMF_PHYS_LUN_RESET  (1 << 1)
#define HPSATMF_PHYS_NEX_RESET  (1 << 2)
#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
#define HPSATMF_PHYS_CLEAR_ACA  (1 << 5)
#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
#define HPSATMF_PHYS_QRY_TASK   (1 << 7)
#define HPSATMF_PHYS_QRY_TSET   (1 << 8)
#define HPSATMF_PHYS_QRY_ASYNC  (1 << 9)
#define HPSATMF_MASK_SUPPORTED  (1 << 16)
#define HPSATMF_LOG_LUN_RESET   (1 << 17)
#define HPSATMF_LOG_NEX_RESET   (1 << 18)
#define HPSATMF_LOG_TASK_ABORT  (1 << 19)
#define HPSATMF_LOG_TSET_ABORT  (1 << 20)
#define HPSATMF_LOG_CLEAR_ACA   (1 << 21)
#define HPSATMF_LOG_CLEAR_TSET  (1 << 22)
#define HPSATMF_LOG_QRY_TASK    (1 << 23)
#define HPSATMF_LOG_QRY_TSET    (1 << 24)
#define HPSATMF_LOG_QRY_ASYNC   (1 << 25)
};
#define HPSA_ABORT_MSG 0
#define HPSA_DEVICE_RESET_MSG 1
#define HPSA_RESET_TYPE_CONTROLLER 0x00
#define HPSA_RESET_TYPE_BUS 0x01
#define HPSA_RESET_TYPE_TARGET 0x03
#define HPSA_RESET_TYPE_LUN 0x04
#define HPSA_MSG_SEND_RETRY_LIMIT 10
#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)

/* Maximum time in seconds driver will wait for command completions
 * when polling before giving up.
 */
#define HPSA_MAX_POLL_TIME_SECS (20)

/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
 * how many times to retry TEST UNIT READY on a device
 * while waiting for it to become ready before giving up.
 * HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
 * between sending TURs while waiting for a device
 * to become ready.
 */
#define HPSA_TUR_RETRY_LIMIT (20)
#define HPSA_MAX_WAIT_INTERVAL_SECS (30)

/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
 * to become ready, in seconds, before giving up on it.
 * HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
 * between polling the board to see if it is ready, in
 * milliseconds.  HPSA_BOARD_READY_POLL_INTERVAL and
 * HPSA_BOARD_READY_ITERATIONS are derived from those.
 */
#define HPSA_BOARD_READY_WAIT_SECS (120)
#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
#define HPSA_BOARD_READY_POLL_INTERVAL \
	((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
#define HPSA_BOARD_READY_ITERATIONS \
	((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
		HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
#define HPSA_BOARD_NOT_READY_ITERATIONS \
	((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
		HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
#define HPSA_POST_RESET_PAUSE_MSECS (3000)
#define HPSA_POST_RESET_NOOP_RETRIES (12)

/*  Defining the diffent access_menthods */
/*
 * Memory mapped FIFO interface (SMART 53xx cards)
 */
#define SA5_DOORBELL	0x20
#define SA5_REQUEST_PORT_OFFSET	0x40
#define SA5_REPLY_INTR_MASK_OFFSET	0x34
#define SA5_REPLY_PORT_OFFSET		0x44
#define SA5_INTR_STATUS		0x30
#define SA5_SCRATCHPAD_OFFSET	0xB0

#define SA5_CTCFG_OFFSET	0xB4
#define SA5_CTMEM_OFFSET	0xB8

#define SA5_INTR_OFF		0x08
#define SA5B_INTR_OFF		0x04
#define SA5_INTR_PENDING	0x08
#define SA5B_INTR_PENDING	0x04
#define FIFO_EMPTY		0xffffffff
#define HPSA_FIRMWARE_READY	0xffff0000 /* value in scratchpad register */

#define HPSA_ERROR_BIT		0x02

/* Performant mode flags */
#define SA5_PERF_INTR_PENDING   0x04
#define SA5_PERF_INTR_OFF       0x05
#define SA5_OUTDB_STATUS_PERF_BIT       0x01
#define SA5_OUTDB_CLEAR_PERF_BIT        0x01
#define SA5_OUTDB_CLEAR         0xA0
#define SA5_OUTDB_CLEAR_PERF_BIT        0x01
#define SA5_OUTDB_STATUS        0x9C


#define HPSA_INTR_ON 	1
#define HPSA_INTR_OFF	0
/*
	Send the command to the hardware
*/
static void SA5_submit_command(struct ctlr_info *h,
	struct CommandList *c)
{
	dev_dbg(&h->pdev->dev, "Sending %x, tag = %x\n", c->busaddr,
		c->Header.Tag.lower);
	writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
	(void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
}

/*
 *  This card is the opposite of the other cards.
 *   0 turns interrupts on...
 *   0x08 turns them off...
 */
static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
{
	if (val) { /* Turn interrupts on */
		h->interrupts_enabled = 1;
		writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
	} else { /* Turn them off */
		h->interrupts_enabled = 0;
		writel(SA5_INTR_OFF,
			h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
	}
}

static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
{
	if (val) { /* turn on interrupts */
		h->interrupts_enabled = 1;
		writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
	} else {
		h->interrupts_enabled = 0;
		writel(SA5_PERF_INTR_OFF,
			h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
		(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
	}
}

static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
{
	struct reply_pool *rq = &h->reply_queue[q];
	unsigned long flags, register_value = FIFO_EMPTY;

	/* msi auto clears the interrupt pending bit. */
	if (!(h->msi_vector || h->msix_vector)) {
		/* flush the controller write of the reply queue by reading
		 * outbound doorbell status register.
		 */
		register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
		writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
		/* Do a read in order to flush the write to the controller
		 * (as per spec.)
		 */
		register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
	}

	if ((rq->head[rq->current_entry] & 1) == rq->wraparound) {
		register_value = rq->head[rq->current_entry];
		rq->current_entry++;
		spin_lock_irqsave(&h->lock, flags);
		h->commands_outstanding--;
		spin_unlock_irqrestore(&h->lock, flags);
	} else {
		register_value = FIFO_EMPTY;
	}
	/* Check for wraparound */
	if (rq->current_entry == h->max_commands) {
		rq->current_entry = 0;
		rq->wraparound ^= 1;
	}
	return register_value;
}

/*
 *  Returns true if fifo is full.
 *
 */
static unsigned long SA5_fifo_full(struct ctlr_info *h)
{
	if (h->commands_outstanding >= h->max_commands)
		return 1;
	else
		return 0;

}
/*
 *   returns value read from hardware.
 *     returns FIFO_EMPTY if there is nothing to read
 */
static unsigned long SA5_completed(struct ctlr_info *h,
	__attribute__((unused)) u8 q)
{
	unsigned long register_value
		= readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
	unsigned long flags;

	if (register_value != FIFO_EMPTY) {
		spin_lock_irqsave(&h->lock, flags);
		h->commands_outstanding--;
		spin_unlock_irqrestore(&h->lock, flags);
	}

#ifdef HPSA_DEBUG
	if (register_value != FIFO_EMPTY)
		dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
			register_value);
	else
		dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
#endif

	return register_value;
}
/*
 *	Returns true if an interrupt is pending..
 */
static bool SA5_intr_pending(struct ctlr_info *h)
{
	unsigned long register_value  =
		readl(h->vaddr + SA5_INTR_STATUS);
	dev_dbg(&h->pdev->dev, "intr_pending %lx\n", register_value);
	return register_value & SA5_INTR_PENDING;
}

static bool SA5_performant_intr_pending(struct ctlr_info *h)
{
	unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);

	if (!register_value)
		return false;

	if (h->msi_vector || h->msix_vector)
		return true;

	/* Read outbound doorbell to flush */
	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
	return register_value & SA5_OUTDB_STATUS_PERF_BIT;
}

#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT    0x100

static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
{
	unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);

	return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
		true : false;
}

#define IOACCEL_MODE1_REPLY_QUEUE_INDEX  0x1A0
#define IOACCEL_MODE1_PRODUCER_INDEX     0x1B8
#define IOACCEL_MODE1_CONSUMER_INDEX     0x1BC
#define IOACCEL_MODE1_REPLY_UNUSED       0xFFFFFFFFFFFFFFFFULL

static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
{
	u64 register_value;
	struct reply_pool *rq = &h->reply_queue[q];
	unsigned long flags;

	BUG_ON(q >= h->nreply_queues);

	register_value = rq->head[rq->current_entry];
	if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
		rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
		if (++rq->current_entry == rq->size)
			rq->current_entry = 0;
		/*
		 * @todo
		 *
		 * Don't really need to write the new index after each command,
		 * but with current driver design this is easiest.
		 */
		wmb();
		writel((q << 24) | rq->current_entry, h->vaddr +
				IOACCEL_MODE1_CONSUMER_INDEX);
		spin_lock_irqsave(&h->lock, flags);
		h->commands_outstanding--;
		spin_unlock_irqrestore(&h->lock, flags);
	}
	return (unsigned long) register_value;
}

static struct access_method SA5_access = {
	SA5_submit_command,
	SA5_intr_mask,
	SA5_fifo_full,
	SA5_intr_pending,
	SA5_completed,
};

static struct access_method SA5_ioaccel_mode1_access = {
	SA5_submit_command,
	SA5_performant_intr_mask,
	SA5_fifo_full,
	SA5_ioaccel_mode1_intr_pending,
	SA5_ioaccel_mode1_completed,
};

static struct access_method SA5_performant_access = {
	SA5_submit_command,
	SA5_performant_intr_mask,
	SA5_fifo_full,
	SA5_performant_intr_pending,
	SA5_performant_completed,
};

struct board_type {
	u32	board_id;
	char	*product_name;
	struct access_method *access;
};

#endif /* HPSA_H */
Commit	Line	Data
edd16368 SC	1	/*
	2	* Disk Array driver for HP Smart Array SAS controllers
	3	* Copyright 2000, 2009 Hewlett-Packard Development Company, L.P.
	4	*
	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; version 2 of the License.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
	12	* NON INFRINGEMENT. See the GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	17	*
	18	* Questions/Comments/Bugfixes to iss_storagedev@hp.com
	19	*
	20	*/
	21	#ifndef HPSA_H
	22	#define HPSA_H
	23
	24	#include <scsi/scsicam.h>
	25
	26	#define IO_OK 0
	27	#define IO_ERROR 1
	28
	29	struct ctlr_info;
	30
	31	struct access_method {
	32	void (submit_command)(struct ctlr_info h,
	33	struct CommandList *c);
	34	void (set_intr_mask)(struct ctlr_info h, unsigned long val);
	35	unsigned long (fifo_full)(struct ctlr_info h);
900c5440	36	bool (intr_pending)(struct ctlr_info h);
254f796b	37	unsigned long (command_completed)(struct ctlr_info h, u8 q);
edd16368 SC	38	};
	39
	40	struct hpsa_scsi_dev_t {
	41	int devtype;
	42	int bus, target, lun; /* as presented to the OS */
	43	unsigned char scsi3addr[8]; /* as presented to the HW */
	44	#define RAID_CTLR_LUNID "\0\0\0\0\0\0\0\0"
	45	unsigned char device_id[16]; /* from inquiry pg. 0x83 */
	46	unsigned char vendor[8]; /* bytes 8-15 of inquiry data */
	47	unsigned char model[16]; /* bytes 16-31 of inquiry data */
edd16368	48	unsigned char raid_level; /* from inquiry page 0xC1 */
e1f7de0c	49	u32 ioaccel_handle;
283b4a9b SC	50	int offload_config; /* I/O accel RAID offload configured */
	51	int offload_enabled; /* I/O accel RAID offload enabled */
	52	int offload_to_mirror; /* Send next I/O accelerator RAID
	53	* offload request to mirror drive
	54	*/
	55	struct raid_map_data raid_map; /* I/O accelerator RAID map */
	56
edd16368 SC	57	};
edd16368 SC	58
254f796b MG	59	struct reply_pool {
	60	u64 *head;
	61	size_t size;
	62	u8 wraparound;
	63	u32 current_entry;
	64	};
	65
edd16368 SC	66	struct ctlr_info {
	67	int ctlr;
	68	char devname[8];
	69	char *product_name;
edd16368	70	struct pci_dev *pdev;
01a02ffc	71	u32 board_id;
edd16368 SC	72	void __iomem *vaddr;
	73	unsigned long paddr;
	74	int nr_cmds; /* Number of commands allowed on this controller */
	75	struct CfgTable __iomem *cfgtable;
	76	int interrupts_enabled;
	77	int major;
	78	int max_commands;
	79	int commands_outstanding;
	80	int max_outstanding; /* Debug */
	81	int usage_count; /* number of opens all all minor devices */
303932fd DB	82	# define PERF_MODE_INT 0
303932fd DB	83	# define DOORBELL_INT 1
edd16368 SC	84	# define SIMPLE_MODE_INT 2
edd16368 SC	85	# define MEMQ_MODE_INT 3
254f796b	86	unsigned int intr[MAX_REPLY_QUEUES];
edd16368 SC	87	unsigned int msix_vector;
edd16368 SC	88	unsigned int msi_vector;
a9a3a273	89	int intr_mode; /* either PERF_MODE_INT or SIMPLE_MODE_INT */
edd16368 SC	90	struct access_method access;
	91
	92	/* queue and queue Info */
9e0fc764 SC	93	struct list_head reqQ;
9e0fc764 SC	94	struct list_head cmpQ;
edd16368	95	unsigned int Qdepth;
edd16368 SC	96	unsigned int maxSG;
edd16368 SC	97	spinlock_t lock;
33a2ffce SC	98	int maxsgentries;
	99	u8 max_cmd_sg_entries;
	100	int chainsize;
	101	struct SGDescriptor **cmd_sg_list;
edd16368 SC	102
	103	/* pointers to command and error info pool */
	104	struct CommandList *cmd_pool;
	105	dma_addr_t cmd_pool_dhandle;
e1f7de0c MG	106	struct io_accel1_cmd *ioaccel_cmd_pool;
e1f7de0c MG	107	dma_addr_t ioaccel_cmd_pool_dhandle;
edd16368 SC	108	struct ErrorInfo *errinfo_pool;
	109	dma_addr_t errinfo_pool_dhandle;
	110	unsigned long *cmd_pool_bits;
a08a8471 SC	111	int scan_finished;
	112	spinlock_t scan_lock;
	113	wait_queue_head_t scan_wait_queue;
edd16368 SC	114
	115	struct Scsi_Host *scsi_host;
	116	spinlock_t devlock; /* to protect hba[ctlr]->dev[]; */
	117	int ndevices; /* number of used elements in .dev[] array. */
cfe5badc	118	struct hpsa_scsi_dev_t *dev[HPSA_MAX_DEVICES];
303932fd DB	119	/*
	120	* Performant mode tables.
	121	*/
	122	u32 trans_support;
	123	u32 trans_offset;
	124	struct TransTable_struct *transtable;
	125	unsigned long transMethod;
	126
0390f0c0 SC	127	/* cap concurrent passthrus at some reasonable maximum */
	128	#define HPSA_MAX_CONCURRENT_PASSTHRUS (20)
	129	spinlock_t passthru_count_lock; /* protects passthru_count */
	130	int passthru_count;
	131
303932fd	132	/*
254f796b	133	* Performant mode completion buffers
303932fd DB	134	*/
303932fd DB	135	u64 *reply_pool;
303932fd	136	size_t reply_pool_size;
254f796b MG	137	struct reply_pool reply_queue[MAX_REPLY_QUEUES];
	138	u8 nreply_queues;
	139	dma_addr_t reply_pool_dhandle;
303932fd	140	u32 *blockFetchTable;
e1f7de0c	141	u32 *ioaccel1_blockFetchTable;
339b2b14	142	unsigned char *hba_inquiry_data;
283b4a9b SC	143	u32 driver_support;
	144	u32 fw_support;
	145	int ioaccel_support;
	146	int ioaccel_maxsg;
a0c12413 SC	147	u64 last_intr_timestamp;
	148	u32 last_heartbeat;
	149	u64 last_heartbeat_timestamp;
e85c5974 SC	150	u32 heartbeat_sample_interval;
e85c5974 SC	151	atomic_t firmware_flash_in_progress;
a0c12413	152	u32 lockup_detected;
8a98db73 SC	153	struct delayed_work monitor_ctlr_work;
8a98db73 SC	154	int remove_in_progress;
396883e2	155	u32 fifo_recently_full;
254f796b MG	156	/* Address of h->q[x] is passed to intr handler to know which queue */
254f796b MG	157	u8 q[MAX_REPLY_QUEUES];
75167d2c SC	158	u32 TMFSupportFlags; /* cache what task mgmt funcs are supported. */
	159	#define HPSATMF_BITS_SUPPORTED (1 << 0)
	160	#define HPSATMF_PHYS_LUN_RESET (1 << 1)
	161	#define HPSATMF_PHYS_NEX_RESET (1 << 2)
	162	#define HPSATMF_PHYS_TASK_ABORT (1 << 3)
	163	#define HPSATMF_PHYS_TSET_ABORT (1 << 4)
	164	#define HPSATMF_PHYS_CLEAR_ACA (1 << 5)
	165	#define HPSATMF_PHYS_CLEAR_TSET (1 << 6)
	166	#define HPSATMF_PHYS_QRY_TASK (1 << 7)
	167	#define HPSATMF_PHYS_QRY_TSET (1 << 8)
	168	#define HPSATMF_PHYS_QRY_ASYNC (1 << 9)
	169	#define HPSATMF_MASK_SUPPORTED (1 << 16)
	170	#define HPSATMF_LOG_LUN_RESET (1 << 17)
	171	#define HPSATMF_LOG_NEX_RESET (1 << 18)
	172	#define HPSATMF_LOG_TASK_ABORT (1 << 19)
	173	#define HPSATMF_LOG_TSET_ABORT (1 << 20)
	174	#define HPSATMF_LOG_CLEAR_ACA (1 << 21)
	175	#define HPSATMF_LOG_CLEAR_TSET (1 << 22)
	176	#define HPSATMF_LOG_QRY_TASK (1 << 23)
	177	#define HPSATMF_LOG_QRY_TSET (1 << 24)
	178	#define HPSATMF_LOG_QRY_ASYNC (1 << 25)
edd16368 SC	179	};
	180	#define HPSA_ABORT_MSG 0
	181	#define HPSA_DEVICE_RESET_MSG 1
64670ac8 SC	182	#define HPSA_RESET_TYPE_CONTROLLER 0x00
	183	#define HPSA_RESET_TYPE_BUS 0x01
	184	#define HPSA_RESET_TYPE_TARGET 0x03
	185	#define HPSA_RESET_TYPE_LUN 0x04
edd16368	186	#define HPSA_MSG_SEND_RETRY_LIMIT 10
516fda49	187	#define HPSA_MSG_SEND_RETRY_INTERVAL_MSECS (10000)
edd16368 SC	188
	189	/* Maximum time in seconds driver will wait for command completions
	190	* when polling before giving up.
	191	*/
	192	#define HPSA_MAX_POLL_TIME_SECS (20)
	193
	194	/* During SCSI error recovery, HPSA_TUR_RETRY_LIMIT defines
	195	* how many times to retry TEST UNIT READY on a device
	196	* while waiting for it to become ready before giving up.
	197	* HPSA_MAX_WAIT_INTERVAL_SECS is the max wait interval
	198	* between sending TURs while waiting for a device
	199	* to become ready.
	200	*/
	201	#define HPSA_TUR_RETRY_LIMIT (20)
	202	#define HPSA_MAX_WAIT_INTERVAL_SECS (30)
	203
	204	/* HPSA_BOARD_READY_WAIT_SECS is how long to wait for a board
	205	* to become ready, in seconds, before giving up on it.
	206	* HPSA_BOARD_READY_POLL_INTERVAL_MSECS * is how long to wait
	207	* between polling the board to see if it is ready, in
	208	* milliseconds. HPSA_BOARD_READY_POLL_INTERVAL and
	209	* HPSA_BOARD_READY_ITERATIONS are derived from those.
	210	*/
	211	#define HPSA_BOARD_READY_WAIT_SECS (120)
2ed7127b	212	#define HPSA_BOARD_NOT_READY_WAIT_SECS (100)
edd16368 SC	213	#define HPSA_BOARD_READY_POLL_INTERVAL_MSECS (100)
	214	#define HPSA_BOARD_READY_POLL_INTERVAL \
	215	((HPSA_BOARD_READY_POLL_INTERVAL_MSECS * HZ) / 1000)
	216	#define HPSA_BOARD_READY_ITERATIONS \
	217	((HPSA_BOARD_READY_WAIT_SECS * 1000) / \
	218	HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
fe5389c8 SC	219	#define HPSA_BOARD_NOT_READY_ITERATIONS \
	220	((HPSA_BOARD_NOT_READY_WAIT_SECS * 1000) / \
	221	HPSA_BOARD_READY_POLL_INTERVAL_MSECS)
edd16368 SC	222	#define HPSA_POST_RESET_PAUSE_MSECS (3000)
	223	#define HPSA_POST_RESET_NOOP_RETRIES (12)
	224
	225	/* Defining the diffent access_menthods */
	226	/*
	227	* Memory mapped FIFO interface (SMART 53xx cards)
	228	*/
	229	#define SA5_DOORBELL 0x20
	230	#define SA5_REQUEST_PORT_OFFSET 0x40
	231	#define SA5_REPLY_INTR_MASK_OFFSET 0x34
	232	#define SA5_REPLY_PORT_OFFSET 0x44
	233	#define SA5_INTR_STATUS 0x30
	234	#define SA5_SCRATCHPAD_OFFSET 0xB0
	235
	236	#define SA5_CTCFG_OFFSET 0xB4
	237	#define SA5_CTMEM_OFFSET 0xB8
	238
	239	#define SA5_INTR_OFF 0x08
	240	#define SA5B_INTR_OFF 0x04
	241	#define SA5_INTR_PENDING 0x08
	242	#define SA5B_INTR_PENDING 0x04
	243	#define FIFO_EMPTY 0xffffffff
	244	#define HPSA_FIRMWARE_READY 0xffff0000 /* value in scratchpad register */
	245
	246	#define HPSA_ERROR_BIT 0x02
edd16368	247
303932fd DB	248	/* Performant mode flags */
	249	#define SA5_PERF_INTR_PENDING 0x04
	250	#define SA5_PERF_INTR_OFF 0x05
	251	#define SA5_OUTDB_STATUS_PERF_BIT 0x01
	252	#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
	253	#define SA5_OUTDB_CLEAR 0xA0
	254	#define SA5_OUTDB_CLEAR_PERF_BIT 0x01
	255	#define SA5_OUTDB_STATUS 0x9C
	256
	257
edd16368 SC	258	#define HPSA_INTR_ON 1
	259	#define HPSA_INTR_OFF 0
	260	/*
	261	Send the command to the hardware
	262	*/
	263	static void SA5_submit_command(struct ctlr_info *h,
	264	struct CommandList *c)
	265	{
303932fd DB	266	dev_dbg(&h->pdev->dev, "Sending %x, tag = %x\n", c->busaddr,
303932fd DB	267	c->Header.Tag.lower);
edd16368	268	writel(c->busaddr, h->vaddr + SA5_REQUEST_PORT_OFFSET);
fec62c36	269	(void) readl(h->vaddr + SA5_SCRATCHPAD_OFFSET);
edd16368 SC	270	}
	271
	272	/*
	273	* This card is the opposite of the other cards.
	274	* 0 turns interrupts on...
	275	* 0x08 turns them off...
	276	*/
	277	static void SA5_intr_mask(struct ctlr_info *h, unsigned long val)
	278	{
	279	if (val) { /* Turn interrupts on */
	280	h->interrupts_enabled = 1;
	281	writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
8cd21da7	282	(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
edd16368 SC	283	} else { /* Turn them off */
	284	h->interrupts_enabled = 0;
	285	writel(SA5_INTR_OFF,
	286	h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
8cd21da7	287	(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
edd16368 SC	288	}
edd16368 SC	289	}
303932fd DB	290
	291	static void SA5_performant_intr_mask(struct ctlr_info *h, unsigned long val)
	292	{
	293	if (val) { /* turn on interrupts */
	294	h->interrupts_enabled = 1;
	295	writel(0, h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
8cd21da7	296	(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
303932fd DB	297	} else {
	298	h->interrupts_enabled = 0;
	299	writel(SA5_PERF_INTR_OFF,
	300	h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
8cd21da7	301	(void) readl(h->vaddr + SA5_REPLY_INTR_MASK_OFFSET);
303932fd DB	302	}
	303	}
	304
254f796b	305	static unsigned long SA5_performant_completed(struct ctlr_info *h, u8 q)
303932fd	306	{
254f796b	307	struct reply_pool *rq = &h->reply_queue[q];
e16a33ad	308	unsigned long flags, register_value = FIFO_EMPTY;
303932fd	309
303932fd DB	310	/* msi auto clears the interrupt pending bit. */
303932fd DB	311	if (!(h->msi_vector \|\| h->msix_vector)) {
2c17d2da SC	312	/* flush the controller write of the reply queue by reading
	313	* outbound doorbell status register.
	314	*/
	315	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
303932fd DB	316	writel(SA5_OUTDB_CLEAR_PERF_BIT, h->vaddr + SA5_OUTDB_CLEAR);
	317	/* Do a read in order to flush the write to the controller
	318	* (as per spec.)
	319	*/
	320	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
	321	}
	322
254f796b MG	323	if ((rq->head[rq->current_entry] & 1) == rq->wraparound) {
	324	register_value = rq->head[rq->current_entry];
	325	rq->current_entry++;
e16a33ad	326	spin_lock_irqsave(&h->lock, flags);
303932fd	327	h->commands_outstanding--;
e16a33ad	328	spin_unlock_irqrestore(&h->lock, flags);
303932fd DB	329	} else {
	330	register_value = FIFO_EMPTY;
	331	}
	332	/* Check for wraparound */
254f796b MG	333	if (rq->current_entry == h->max_commands) {
	334	rq->current_entry = 0;
	335	rq->wraparound ^= 1;
303932fd	336	}
303932fd DB	337	return register_value;
	338	}
	339
edd16368 SC	340	/*
	341	* Returns true if fifo is full.
	342	*
	343	*/
	344	static unsigned long SA5_fifo_full(struct ctlr_info *h)
	345	{
	346	if (h->commands_outstanding >= h->max_commands)
	347	return 1;
	348	else
	349	return 0;
	350
	351	}
	352	/*
	353	* returns value read from hardware.
	354	* returns FIFO_EMPTY if there is nothing to read
	355	*/
254f796b MG	356	static unsigned long SA5_completed(struct ctlr_info *h,
254f796b MG	357	__attribute__((unused)) u8 q)
edd16368 SC	358	{
	359	unsigned long register_value
	360	= readl(h->vaddr + SA5_REPLY_PORT_OFFSET);
e16a33ad	361	unsigned long flags;
edd16368	362
e16a33ad MG	363	if (register_value != FIFO_EMPTY) {
e16a33ad MG	364	spin_lock_irqsave(&h->lock, flags);
edd16368	365	h->commands_outstanding--;
e16a33ad MG	366	spin_unlock_irqrestore(&h->lock, flags);
e16a33ad MG	367	}
edd16368 SC	368
	369	#ifdef HPSA_DEBUG
	370	if (register_value != FIFO_EMPTY)
84ca0be2	371	dev_dbg(&h->pdev->dev, "Read %lx back from board\n",
edd16368 SC	372	register_value);
edd16368 SC	373	else
f79cfec6	374	dev_dbg(&h->pdev->dev, "FIFO Empty read\n");
edd16368 SC	375	#endif
	376
	377	return register_value;
	378	}
	379	/*
	380	* Returns true if an interrupt is pending..
	381	*/
900c5440	382	static bool SA5_intr_pending(struct ctlr_info *h)
edd16368 SC	383	{
	384	unsigned long register_value =
	385	readl(h->vaddr + SA5_INTR_STATUS);
84ca0be2	386	dev_dbg(&h->pdev->dev, "intr_pending %lx\n", register_value);
900c5440	387	return register_value & SA5_INTR_PENDING;
edd16368 SC	388	}
edd16368 SC	389
303932fd DB	390	static bool SA5_performant_intr_pending(struct ctlr_info *h)
	391	{
	392	unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
	393
	394	if (!register_value)
	395	return false;
	396
	397	if (h->msi_vector \|\| h->msix_vector)
	398	return true;
	399
	400	/* Read outbound doorbell to flush */
	401	register_value = readl(h->vaddr + SA5_OUTDB_STATUS);
	402	return register_value & SA5_OUTDB_STATUS_PERF_BIT;
	403	}
edd16368	404
e1f7de0c MG	405	#define SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT 0x100
	406
	407	static bool SA5_ioaccel_mode1_intr_pending(struct ctlr_info *h)
	408	{
	409	unsigned long register_value = readl(h->vaddr + SA5_INTR_STATUS);
	410
	411	return (register_value & SA5_IOACCEL_MODE1_INTR_STATUS_CMP_BIT) ?
	412	true : false;
	413	}
	414
	415	#define IOACCEL_MODE1_REPLY_QUEUE_INDEX 0x1A0
	416	#define IOACCEL_MODE1_PRODUCER_INDEX 0x1B8
	417	#define IOACCEL_MODE1_CONSUMER_INDEX 0x1BC
	418	#define IOACCEL_MODE1_REPLY_UNUSED 0xFFFFFFFFFFFFFFFFULL
	419
283b4a9b	420	static unsigned long SA5_ioaccel_mode1_completed(struct ctlr_info *h, u8 q)
e1f7de0c MG	421	{
	422	u64 register_value;
	423	struct reply_pool *rq = &h->reply_queue[q];
	424	unsigned long flags;
	425
	426	BUG_ON(q >= h->nreply_queues);
	427
	428	register_value = rq->head[rq->current_entry];
	429	if (register_value != IOACCEL_MODE1_REPLY_UNUSED) {
	430	rq->head[rq->current_entry] = IOACCEL_MODE1_REPLY_UNUSED;
	431	if (++rq->current_entry == rq->size)
	432	rq->current_entry = 0;
283b4a9b SC	433	/*
	434	* @todo
	435	*
	436	* Don't really need to write the new index after each command,
	437	* but with current driver design this is easiest.
	438	*/
	439	wmb();
	440	writel((q << 24) \| rq->current_entry, h->vaddr +
	441	IOACCEL_MODE1_CONSUMER_INDEX);
e1f7de0c MG	442	spin_lock_irqsave(&h->lock, flags);
	443	h->commands_outstanding--;
	444	spin_unlock_irqrestore(&h->lock, flags);
e1f7de0c MG	445	}
	446	return (unsigned long) register_value;
	447	}
	448
edd16368 SC	449	static struct access_method SA5_access = {
	450	SA5_submit_command,
	451	SA5_intr_mask,
	452	SA5_fifo_full,
	453	SA5_intr_pending,
	454	SA5_completed,
	455	};
	456
e1f7de0c MG	457	static struct access_method SA5_ioaccel_mode1_access = {
	458	SA5_submit_command,
	459	SA5_performant_intr_mask,
	460	SA5_fifo_full,
	461	SA5_ioaccel_mode1_intr_pending,
	462	SA5_ioaccel_mode1_completed,
	463	};
	464
303932fd DB	465	static struct access_method SA5_performant_access = {
	466	SA5_submit_command,
	467	SA5_performant_intr_mask,
	468	SA5_fifo_full,
	469	SA5_performant_intr_pending,
	470	SA5_performant_completed,
	471	};
	472
edd16368	473	struct board_type {
01a02ffc	474	u32 board_id;
edd16368 SC	475	char *product_name;
	476	struct access_method *access;
	477	};
	478
edd16368 SC	479	#endif /* HPSA_H */
edd16368 SC	480