[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / 53c700.h

/* -*- mode: c; c-basic-offset: 8 -*- */

/* Driver for 53c700 and 53c700-66 chips from NCR and Symbios
 *
 * Copyright (C) 2001 by James.Bottomley@HansenPartnership.com
 */

#ifndef _53C700_H
#define _53C700_H

#include <linux/interrupt.h>
#include <asm/io.h>

#include <scsi/scsi_device.h>


/* Turn on for general debugging---too verbose for normal use */
#undef	NCR_700_DEBUG
/* Debug the tag queues, checking hash queue allocation and deallocation
 * and search for duplicate tags */
#undef NCR_700_TAG_DEBUG

#ifdef NCR_700_DEBUG
#define DEBUG(x)	printk x
#define DDEBUG(prefix, sdev, fmt, a...) \
	sdev_printk(prefix, sdev, fmt, ##a)
#define CDEBUG(prefix, scmd, fmt, a...) \
	scmd_printk(prefix, scmd, fmt, ##a)
#else
#define DEBUG(x)	do {} while (0)
#define DDEBUG(prefix, scmd, fmt, a...) do {} while (0)
#define CDEBUG(prefix, scmd, fmt, a...) do {} while (0)
#endif

/* The number of available command slots */
#define NCR_700_COMMAND_SLOTS_PER_HOST	64
/* The maximum number of Scatter Gathers we allow */
#define NCR_700_SG_SEGMENTS		32
/* The maximum number of luns (make this of the form 2^n) */
#define NCR_700_MAX_LUNS		32
#define NCR_700_LUN_MASK		(NCR_700_MAX_LUNS - 1)
/* Maximum number of tags the driver ever allows per device */
#define NCR_700_MAX_TAGS		16
/* Tag depth the driver starts out with (can be altered in sysfs) */
#define NCR_700_DEFAULT_TAGS		4
/* This is the default number of commands per LUN in the untagged case.
 * two is a good value because it means we can have one command active and
 * one command fully prepared and waiting
 */
#define NCR_700_CMD_PER_LUN		2
/* magic byte identifying an internally generated REQUEST_SENSE command */
#define NCR_700_INTERNAL_SENSE_MAGIC	0x42

struct NCR_700_Host_Parameters;

/* These are the externally used routines */
struct Scsi_Host *NCR_700_detect(struct scsi_host_template *,
		struct NCR_700_Host_Parameters *, struct device *);
int NCR_700_release(struct Scsi_Host *host);
irqreturn_t NCR_700_intr(int, void *, struct pt_regs *);


enum NCR_700_Host_State {
	NCR_700_HOST_BUSY,
	NCR_700_HOST_FREE,
};

struct NCR_700_SG_List {
	/* The following is a script fragment to move the buffer onto the
	 * bus and then link the next fragment or return */
	#define	SCRIPT_MOVE_DATA_IN		0x09000000
	#define	SCRIPT_MOVE_DATA_OUT		0x08000000
	__u32	ins;
	__u32	pAddr;
	#define	SCRIPT_NOP			0x80000000
	#define	SCRIPT_RETURN			0x90080000
};

/* We use device->hostdata to store negotiated parameters.  This is
 * supposed to be a pointer to a device private area, but we cannot
 * really use it as such since it will never be freed, so just use the
 * 32 bits to cram the information.  The SYNC negotiation sequence looks
 * like:
 * 
 * If DEV_NEGOTIATED_SYNC not set, tack and SDTR message on to the
 * initial identify for the device and set DEV_BEGIN_SYNC_NEGOTATION
 * If we get an SDTR reply, work out the SXFER parameters, squirrel
 * them away here, clear DEV_BEGIN_SYNC_NEGOTIATION and set
 * DEV_NEGOTIATED_SYNC.  If we get a REJECT msg, squirrel
 *
 *
 * 0:7	SXFER_REG negotiated value for this device
 * 8:15 Current queue depth
 * 16	negotiated SYNC flag
 * 17 begin SYNC negotiation flag 
 * 18 device supports tag queueing */
#define NCR_700_DEV_NEGOTIATED_SYNC	(1<<16)
#define NCR_700_DEV_BEGIN_SYNC_NEGOTIATION	(1<<17)
#define NCR_700_DEV_PRINT_SYNC_NEGOTIATION (1<<19)

static inline void
NCR_700_set_depth(struct scsi_device *SDp, __u8 depth)
{
	long l = (long)SDp->hostdata;

	l &= 0xffff00ff;
	l |= 0xff00 & (depth << 8);
	SDp->hostdata = (void *)l;
}
static inline __u8
NCR_700_get_depth(struct scsi_device *SDp)
{
	return ((((unsigned long)SDp->hostdata) & 0xff00)>>8);
}
static inline int
NCR_700_is_flag_set(struct scsi_device *SDp, __u32 flag)
{
	return (spi_flags(SDp->sdev_target) & flag) == flag;
}
static inline int
NCR_700_is_flag_clear(struct scsi_device *SDp, __u32 flag)
{
	return (spi_flags(SDp->sdev_target) & flag) == 0;
}
static inline void
NCR_700_set_flag(struct scsi_device *SDp, __u32 flag)
{
	spi_flags(SDp->sdev_target) |= flag;
}
static inline void
NCR_700_clear_flag(struct scsi_device *SDp, __u32 flag)
{
	spi_flags(SDp->sdev_target) &= ~flag;
}

enum NCR_700_tag_neg_state {
	NCR_700_START_TAG_NEGOTIATION = 0,
	NCR_700_DURING_TAG_NEGOTIATION = 1,
	NCR_700_FINISHED_TAG_NEGOTIATION = 2,
};

static inline enum NCR_700_tag_neg_state
NCR_700_get_tag_neg_state(struct scsi_device *SDp)
{
	return (enum NCR_700_tag_neg_state)((spi_flags(SDp->sdev_target)>>20) & 0x3);
}

static inline void
NCR_700_set_tag_neg_state(struct scsi_device *SDp,
			  enum NCR_700_tag_neg_state state)
{
	/* clear the slot */
	spi_flags(SDp->sdev_target) &= ~(0x3 << 20);
	spi_flags(SDp->sdev_target) |= ((__u32)state) << 20;
}

struct NCR_700_command_slot {
	struct NCR_700_SG_List	SG[NCR_700_SG_SEGMENTS+1];
	struct NCR_700_SG_List	*pSG;
	#define NCR_700_SLOT_MASK 0xFC
	#define NCR_700_SLOT_MAGIC 0xb8
	#define	NCR_700_SLOT_FREE (0|NCR_700_SLOT_MAGIC) /* slot may be used */
	#define NCR_700_SLOT_BUSY (1|NCR_700_SLOT_MAGIC) /* slot has command active on HA */
	#define NCR_700_SLOT_QUEUED (2|NCR_700_SLOT_MAGIC) /* slot has command to be made active on HA */
	__u8	state;
	int	tag;
	__u32	resume_offset;
	struct scsi_cmnd *cmnd;
	/* The pci_mapped address of the actual command in cmnd */
	dma_addr_t	pCmd;
	__u32		temp;
	/* if this command is a pci_single mapping, holds the dma address
	 * for later unmapping in the done routine */
	dma_addr_t	dma_handle;
	/* historical remnant, now used to link free commands */
	struct NCR_700_command_slot *ITL_forw;
};

struct NCR_700_Host_Parameters {
	/* These must be filled in by the calling driver */
	int	clock;			/* board clock speed in MHz */
	void __iomem	*base;		/* the base for the port (copied to host) */
	struct device	*dev;
	__u32	dmode_extra;	/* adjustable bus settings */
	__u32	differential:1;	/* if we are differential */
#ifdef CONFIG_53C700_LE_ON_BE
	/* This option is for HP only.  Set it if your chip is wired for
	 * little endian on this platform (which is big endian) */
	__u32	force_le_on_be:1;
#endif
	__u32	chip710:1;	/* set if really a 710 not 700 */
	__u32	burst_disable:1;	/* set to 1 to disable 710 bursting */

	/* NOTHING BELOW HERE NEEDS ALTERING */
	__u32	fast:1;		/* if we can alter the SCSI bus clock
                                   speed (so can negiotiate sync) */
	int	sync_clock;	/* The speed of the SYNC core */

	__u32	*script;		/* pointer to script location */
	__u32	pScript;		/* physical mem addr of script */

	enum NCR_700_Host_State state; /* protected by state lock */
	struct scsi_cmnd *cmd;
	/* Note: pScript contains the single consistent block of
	 * memory.  All the msgin, msgout and status are allocated in
	 * this memory too (at separate cache lines).  TOTAL_MEM_SIZE
	 * represents the total size of this area */
#define	MSG_ARRAY_SIZE	8
#define	MSGOUT_OFFSET	(L1_CACHE_ALIGN(sizeof(SCRIPT)))
	__u8	*msgout;
#define MSGIN_OFFSET	(MSGOUT_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	__u8	*msgin;
#define STATUS_OFFSET	(MSGIN_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	__u8	*status;
#define SLOTS_OFFSET	(STATUS_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	struct NCR_700_command_slot	*slots;
#define	TOTAL_MEM_SIZE	(SLOTS_OFFSET + L1_CACHE_ALIGN(sizeof(struct NCR_700_command_slot) * NCR_700_COMMAND_SLOTS_PER_HOST))
	int	saved_slot_position;
	int	command_slot_count; /* protected by state lock */
	__u8	tag_negotiated;
	__u8	rev;
	__u8	reselection_id;
	__u8	min_period;

	/* Free list, singly linked by ITL_forw elements */
	struct NCR_700_command_slot *free_list;
	/* Completion for waited for ops, like reset, abort or
	 * device reset.
	 *
	 * NOTE: relies on single threading in the error handler to
	 * have only one outstanding at once */
	struct completion *eh_complete;
};

/*
 *	53C700 Register Interface - the offset from the Selected base
 *	I/O address */
#ifdef CONFIG_53C700_LE_ON_BE
#define bE	(hostdata->force_le_on_be ? 0 : 3)
#define	bSWAP	(hostdata->force_le_on_be)
#define bEBus	(!hostdata->force_le_on_be)
#elif defined(__BIG_ENDIAN)
#define bE	3
#define bSWAP	0
#elif defined(__LITTLE_ENDIAN)
#define bE	0
#define bSWAP	0
#else
#error "__BIG_ENDIAN or __LITTLE_ENDIAN must be defined, did you include byteorder.h?"
#endif
#ifndef bEBus
#ifdef CONFIG_53C700_BE_BUS
#define bEBus	1
#else
#define bEBus	0
#endif
#endif
#define bS_to_cpu(x)	(bSWAP ? le32_to_cpu(x) : (x))
#define bS_to_host(x)	(bSWAP ? cpu_to_le32(x) : (x))

/* NOTE: These registers are in the LE register space only, the required byte
 * swapping is done by the NCR_700_{read|write}[b] functions */
#define	SCNTL0_REG			0x00
#define		FULL_ARBITRATION	0xc0
#define 	PARITY			0x08
#define		ENABLE_PARITY		0x04
#define 	AUTO_ATN		0x02
#define	SCNTL1_REG			0x01
#define 	SLOW_BUS		0x80
#define		ENABLE_SELECT		0x20
#define		ASSERT_RST		0x08
#define		ASSERT_EVEN_PARITY	0x04
#define	SDID_REG			0x02
#define	SIEN_REG			0x03
#define 	PHASE_MM_INT		0x80
#define 	FUNC_COMP_INT		0x40
#define 	SEL_TIMEOUT_INT		0x20
#define 	SELECT_INT		0x10
#define 	GROSS_ERR_INT		0x08
#define 	UX_DISC_INT		0x04
#define 	RST_INT			0x02
#define 	PAR_ERR_INT		0x01
#define	SCID_REG			0x04
#define SXFER_REG			0x05
#define		ASYNC_OPERATION		0x00
#define SODL_REG                        0x06
#define	SOCL_REG			0x07
#define	SFBR_REG			0x08
#define	SIDL_REG			0x09
#define	SBDL_REG			0x0A
#define	SBCL_REG			0x0B
/* read bits */
#define		SBCL_IO			0x01
/*write bits */
#define		SYNC_DIV_AS_ASYNC	0x00
#define		SYNC_DIV_1_0		0x01
#define		SYNC_DIV_1_5		0x02
#define		SYNC_DIV_2_0		0x03
#define	DSTAT_REG			0x0C
#define		ILGL_INST_DETECTED	0x01
#define		WATCH_DOG_INTERRUPT	0x02
#define		SCRIPT_INT_RECEIVED	0x04
#define		ABORTED			0x10
#define	SSTAT0_REG			0x0D
#define		PARITY_ERROR		0x01
#define		SCSI_RESET_DETECTED	0x02
#define		UNEXPECTED_DISCONNECT	0x04
#define		SCSI_GROSS_ERROR	0x08
#define		SELECTED		0x10
#define		SELECTION_TIMEOUT	0x20
#define		FUNCTION_COMPLETE	0x40
#define		PHASE_MISMATCH 		0x80
#define	SSTAT1_REG			0x0E
#define		SIDL_REG_FULL		0x80
#define		SODR_REG_FULL		0x40
#define		SODL_REG_FULL		0x20
#define SSTAT2_REG                      0x0F
#define CTEST0_REG                      0x14
#define		BTB_TIMER_DISABLE	0x40
#define CTEST1_REG                      0x15
#define CTEST2_REG                      0x16
#define CTEST3_REG                      0x17
#define CTEST4_REG                      0x18
#define         DISABLE_FIFO            0x00
#define         SLBE                    0x10
#define         SFWR                    0x08
#define         BYTE_LANE0              0x04
#define         BYTE_LANE1              0x05
#define         BYTE_LANE2              0x06
#define         BYTE_LANE3              0x07
#define         SCSI_ZMODE              0x20
#define         ZMODE                   0x40
#define CTEST5_REG                      0x19
#define         MASTER_CONTROL          0x10
#define         DMA_DIRECTION           0x08
#define CTEST7_REG                      0x1B
#define		BURST_DISABLE		0x80 /* 710 only */
#define		SEL_TIMEOUT_DISABLE	0x10 /* 710 only */
#define         DFP                     0x08
#define         EVP                     0x04
#define		DIFF			0x01
#define CTEST6_REG                      0x1A
#define	TEMP_REG			0x1C
#define	DFIFO_REG			0x20
#define		FLUSH_DMA_FIFO		0x80
#define		CLR_FIFO		0x40
#define	ISTAT_REG			0x21
#define		ABORT_OPERATION		0x80
#define		SOFTWARE_RESET_710	0x40
#define		DMA_INT_PENDING		0x01
#define		SCSI_INT_PENDING	0x02
#define		CONNECTED		0x08
#define CTEST8_REG                      0x22
#define         LAST_DIS_ENBL           0x01
#define		SHORTEN_FILTERING	0x04
#define		ENABLE_ACTIVE_NEGATION	0x10
#define		GENERATE_RECEIVE_PARITY	0x20
#define		CLR_FIFO_710		0x04
#define		FLUSH_DMA_FIFO_710	0x08
#define CTEST9_REG                      0x23
#define	DBC_REG				0x24
#define	DCMD_REG			0x27
#define	DNAD_REG			0x28
#define	DIEN_REG			0x39
#define		BUS_FAULT		0x20
#define 	ABORT_INT		0x10
#define 	INT_INST_INT		0x04
#define 	WD_INT			0x02
#define 	ILGL_INST_INT		0x01
#define	DCNTL_REG			0x3B
#define		SOFTWARE_RESET		0x01
#define		COMPAT_700_MODE		0x01
#define 	SCRPTS_16BITS		0x20
#define		ASYNC_DIV_2_0		0x00
#define		ASYNC_DIV_1_5		0x40
#define		ASYNC_DIV_1_0		0x80
#define		ASYNC_DIV_3_0		0xc0
#define DMODE_710_REG			0x38
#define	DMODE_700_REG			0x34
#define		BURST_LENGTH_1		0x00
#define		BURST_LENGTH_2		0x40
#define		BURST_LENGTH_4		0x80
#define		BURST_LENGTH_8		0xC0
#define		DMODE_FC1		0x10
#define		DMODE_FC2		0x20
#define 	BW16			32 
#define 	MODE_286		16
#define 	IO_XFER			8
#define 	FIXED_ADDR		4

#define DSP_REG                         0x2C
#define DSPS_REG                        0x30

/* Parameters to begin SDTR negotiations.  Empirically, I find that
 * the 53c700-66 cannot handle an offset >8, so don't change this  */
#define NCR_700_MAX_OFFSET	8
/* Was hoping the max offset would be greater for the 710, but
 * empirically it seems to be 8 also */
#define NCR_710_MAX_OFFSET	8
#define NCR_700_MIN_XFERP	1
#define NCR_710_MIN_XFERP	0
#define NCR_700_MIN_PERIOD	25 /* for SDTR message, 100ns */

#define script_patch_32(script, symbol, value) \
{ \
	int i; \
	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
		__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]) + value; \
		(script)[A_##symbol##_used[i]] = bS_to_host(val); \
		dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
		DEBUG((" script, patching %s at %d to 0x%lx\n", \
		       #symbol, A_##symbol##_used[i], (value))); \
	} \
}

#define script_patch_32_abs(script, symbol, value) \
{ \
	int i; \
	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
		(script)[A_##symbol##_used[i]] = bS_to_host(value); \
		dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
		DEBUG((" script, patching %s at %d to 0x%lx\n", \
		       #symbol, A_##symbol##_used[i], (value))); \
	} \
}

/* Used for patching the SCSI ID in the SELECT instruction */
#define script_patch_ID(script, symbol, value) \
{ \
	int i; \
	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
		__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]); \
		val &= 0xff00ffff; \
		val |= ((value) & 0xff) << 16; \
		(script)[A_##symbol##_used[i]] = bS_to_host(val); \
		dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
		DEBUG((" script, patching ID field %s at %d to 0x%x\n", \
		       #symbol, A_##symbol##_used[i], val)); \
	} \
}

#define script_patch_16(script, symbol, value) \
{ \
	int i; \
	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
		__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]); \
		val &= 0xffff0000; \
		val |= ((value) & 0xffff); \
		(script)[A_##symbol##_used[i]] = bS_to_host(val); \
		dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
		DEBUG((" script, patching short field %s at %d to 0x%x\n", \
		       #symbol, A_##symbol##_used[i], val)); \
	} \
}


static inline __u8
NCR_700_readb(struct Scsi_Host *host, __u32 reg)
{
	const struct NCR_700_Host_Parameters *hostdata
		= (struct NCR_700_Host_Parameters *)host->hostdata[0];

	return ioread8(hostdata->base + (reg^bE));
}

static inline __u32
NCR_700_readl(struct Scsi_Host *host, __u32 reg)
{
	const struct NCR_700_Host_Parameters *hostdata
		= (struct NCR_700_Host_Parameters *)host->hostdata[0];
	__u32 value = bEBus ? ioread32be(hostdata->base + reg) :
		ioread32(hostdata->base + reg);
#if 1
	/* sanity check the register */
	if((reg & 0x3) != 0)
		BUG();
#endif

	return value;
}

static inline void
NCR_700_writeb(__u8 value, struct Scsi_Host *host, __u32 reg)
{
	const struct NCR_700_Host_Parameters *hostdata
		= (struct NCR_700_Host_Parameters *)host->hostdata[0];

	iowrite8(value, hostdata->base + (reg^bE));
}

static inline void
NCR_700_writel(__u32 value, struct Scsi_Host *host, __u32 reg)
{
	const struct NCR_700_Host_Parameters *hostdata
		= (struct NCR_700_Host_Parameters *)host->hostdata[0];

#if 1
	/* sanity check the register */
	if((reg & 0x3) != 0)
		BUG();
#endif

	bEBus ? iowrite32be(value, hostdata->base + reg): 
		iowrite32(value, hostdata->base + reg);
}

#endif
Commit	Line	Data
1da177e4 LT	1	/* -- mode: c; c-basic-offset: 8 -- */
	2
	3	/* Driver for 53c700 and 53c700-66 chips from NCR and Symbios
	4	*
	5	* Copyright (C) 2001 by James.Bottomley@HansenPartnership.com
	6	*/
	7
	8	#ifndef _53C700_H
	9	#define _53C700_H
	10
	11	#include <linux/interrupt.h>
	12	#include <asm/io.h>
	13
	14	#include <scsi/scsi_device.h>
	15
	16
1da177e4 LT	17	/* Turn on for general debugging---too verbose for normal use */
	18	#undef NCR_700_DEBUG
	19	/* Debug the tag queues, checking hash queue allocation and deallocation
	20	* and search for duplicate tags */
	21	#undef NCR_700_TAG_DEBUG
	22
	23	#ifdef NCR_700_DEBUG
	24	#define DEBUG(x) printk x
017560fc JG	25	#define DDEBUG(prefix, sdev, fmt, a...) \
	26	sdev_printk(prefix, sdev, fmt, ##a)
	27	#define CDEBUG(prefix, scmd, fmt, a...) \
	28	scmd_printk(prefix, scmd, fmt, ##a)
1da177e4	29	#else
017560fc JG	30	#define DEBUG(x) do {} while (0)
	31	#define DDEBUG(prefix, scmd, fmt, a...) do {} while (0)
	32	#define CDEBUG(prefix, scmd, fmt, a...) do {} while (0)
1da177e4 LT	33	#endif
	34
	35	/* The number of available command slots */
	36	#define NCR_700_COMMAND_SLOTS_PER_HOST 64
	37	/* The maximum number of Scatter Gathers we allow */
	38	#define NCR_700_SG_SEGMENTS 32
	39	/* The maximum number of luns (make this of the form 2^n) */
	40	#define NCR_700_MAX_LUNS 32
	41	#define NCR_700_LUN_MASK (NCR_700_MAX_LUNS - 1)
	42	/* Maximum number of tags the driver ever allows per device */
	43	#define NCR_700_MAX_TAGS 16
	44	/* Tag depth the driver starts out with (can be altered in sysfs) */
	45	#define NCR_700_DEFAULT_TAGS 4
	46	/* This is the default number of commands per LUN in the untagged case.
	47	* two is a good value because it means we can have one command active and
	48	* one command fully prepared and waiting
	49	*/
	50	#define NCR_700_CMD_PER_LUN 2
	51	/* magic byte identifying an internally generated REQUEST_SENSE command */
	52	#define NCR_700_INTERNAL_SENSE_MAGIC 0x42
	53
1da177e4 LT	54	struct NCR_700_Host_Parameters;
	55
	56	/* These are the externally used routines */
	57	struct Scsi_Host NCR_700_detect(struct scsi_host_template ,
	58	struct NCR_700_Host_Parameters , struct device );
	59	int NCR_700_release(struct Scsi_Host *host);
	60	irqreturn_t NCR_700_intr(int, void , struct pt_regs );
	61
	62
	63	enum NCR_700_Host_State {
	64	NCR_700_HOST_BUSY,
	65	NCR_700_HOST_FREE,
	66	};
	67
	68	struct NCR_700_SG_List {
	69	/* The following is a script fragment to move the buffer onto the
	70	* bus and then link the next fragment or return */
	71	#define SCRIPT_MOVE_DATA_IN 0x09000000
	72	#define SCRIPT_MOVE_DATA_OUT 0x08000000
	73	__u32 ins;
	74	__u32 pAddr;
	75	#define SCRIPT_NOP 0x80000000
	76	#define SCRIPT_RETURN 0x90080000
	77	};
	78
	79	/* We use device->hostdata to store negotiated parameters. This is
	80	* supposed to be a pointer to a device private area, but we cannot
	81	* really use it as such since it will never be freed, so just use the
	82	* 32 bits to cram the information. The SYNC negotiation sequence looks
	83	* like:
	84	*
	85	* If DEV_NEGOTIATED_SYNC not set, tack and SDTR message on to the
	86	* initial identify for the device and set DEV_BEGIN_SYNC_NEGOTATION
	87	* If we get an SDTR reply, work out the SXFER parameters, squirrel
	88	* them away here, clear DEV_BEGIN_SYNC_NEGOTIATION and set
	89	* DEV_NEGOTIATED_SYNC. If we get a REJECT msg, squirrel
	90	*
	91	*
	92	* 0:7 SXFER_REG negotiated value for this device
	93	* 8:15 Current queue depth
	94	* 16 negotiated SYNC flag
	95	* 17 begin SYNC negotiation flag
	96	* 18 device supports tag queueing */
	97	#define NCR_700_DEV_NEGOTIATED_SYNC (1<<16)
	98	#define NCR_700_DEV_BEGIN_SYNC_NEGOTIATION (1<<17)
	99	#define NCR_700_DEV_PRINT_SYNC_NEGOTIATION (1<<19)
	100
	101	static inline void
	102	NCR_700_set_depth(struct scsi_device *SDp, __u8 depth)
	103	{
	104	long l = (long)SDp->hostdata;
	105
	106	l &= 0xffff00ff;
	107	l \|= 0xff00 & (depth << 8);
	108	SDp->hostdata = (void *)l;
	109	}
	110	static inline __u8
	111	NCR_700_get_depth(struct scsi_device *SDp)
	112	{
	113	return ((((unsigned long)SDp->hostdata) & 0xff00)>>8);
	114	}
	115	static inline int
	116	NCR_700_is_flag_set(struct scsi_device *SDp, __u32 flag)
	117	{
118	return (spi_flags(SDp->sdev_target) & flag) == flag;
119	}
120	static inline int
121	NCR_700_is_flag_clear(struct scsi_device *SDp, __u32 flag)
122	{
123	return (spi_flags(SDp->sdev_target) & flag) == 0;
124	}
125	static inline void
126	NCR_700_set_flag(struct scsi_device *SDp, __u32 flag)
127	{
128	spi_flags(SDp->sdev_target) \|= flag;
129	}
130	static inline void
131	NCR_700_clear_flag(struct scsi_device *SDp, __u32 flag)
132	{
133	spi_flags(SDp->sdev_target) &= ~flag;
134	}
135
136	enum NCR_700_tag_neg_state {
137	NCR_700_START_TAG_NEGOTIATION = 0,
138	NCR_700_DURING_TAG_NEGOTIATION = 1,
139	NCR_700_FINISHED_TAG_NEGOTIATION = 2,
140	};
141
142	static inline enum NCR_700_tag_neg_state
143	NCR_700_get_tag_neg_state(struct scsi_device *SDp)
144	{
145	return (enum NCR_700_tag_neg_state)((spi_flags(SDp->sdev_target)>>20) & 0x3);
146	}
147
148	static inline void
149	NCR_700_set_tag_neg_state(struct scsi_device *SDp,
150	enum NCR_700_tag_neg_state state)
151	{
152	/* clear the slot */
153	spi_flags(SDp->sdev_target) &= ~(0x3 << 20);
154	spi_flags(SDp->sdev_target) \|= ((__u32)state) << 20;
155	}
156
157	struct NCR_700_command_slot {
158	struct NCR_700_SG_List SG[NCR_700_SG_SEGMENTS+1];
159	struct NCR_700_SG_List *pSG;
160	#define NCR_700_SLOT_MASK 0xFC
161	#define NCR_700_SLOT_MAGIC 0xb8
162	#define NCR_700_SLOT_FREE (0\|NCR_700_SLOT_MAGIC) /* slot may be used */
163	#define NCR_700_SLOT_BUSY (1\|NCR_700_SLOT_MAGIC) /* slot has command active on HA */
164	#define NCR_700_SLOT_QUEUED (2\|NCR_700_SLOT_MAGIC) /* slot has command to be made active on HA */
165	__u8 state;
166	int tag;
167	__u32 resume_offset;
168	struct scsi_cmnd *cmnd;
169	/* The pci_mapped address of the actual command in cmnd */
170	dma_addr_t pCmd;
171	__u32 temp;
172	/* if this command is a pci_single mapping, holds the dma address
173	* for later unmapping in the done routine */
174	dma_addr_t dma_handle;
175	/* historical remnant, now used to link free commands */
176	struct NCR_700_command_slot *ITL_forw;
177	};
178
179	struct NCR_700_Host_Parameters {
180	/* These must be filled in by the calling driver */
181	int clock; /* board clock speed in MHz */
56fece20	182	void __iomem base; / the base for the port (copied to host) */
1da177e4 LT	183	struct device *dev;
	184	__u32 dmode_extra; /* adjustable bus settings */
	185	__u32 differential:1; /* if we are differential */
	186	#ifdef CONFIG_53C700_LE_ON_BE
	187	/* This option is for HP only. Set it if your chip is wired for
	188	* little endian on this platform (which is big endian) */
	189	__u32 force_le_on_be:1;
	190	#endif
	191	__u32 chip710:1; /* set if really a 710 not 700 */
	192	__u32 burst_disable:1; /* set to 1 to disable 710 bursting */
	193
	194	/* NOTHING BELOW HERE NEEDS ALTERING */
	195	__u32 fast:1; /* if we can alter the SCSI bus clock
	196	speed (so can negiotiate sync) */
1da177e4 LT	197	int sync_clock; /* The speed of the SYNC core */
	198
	199	__u32 script; / pointer to script location */
	200	__u32 pScript; /* physical mem addr of script */
	201
	202	enum NCR_700_Host_State state; /* protected by state lock */
	203	struct scsi_cmnd *cmd;
	204	/* Note: pScript contains the single consistent block of
	205	* memory. All the msgin, msgout and status are allocated in
	206	* this memory too (at separate cache lines). TOTAL_MEM_SIZE
	207	* represents the total size of this area */
	208	#define MSG_ARRAY_SIZE 8
	209	#define MSGOUT_OFFSET (L1_CACHE_ALIGN(sizeof(SCRIPT)))
	210	__u8 *msgout;
	211	#define MSGIN_OFFSET (MSGOUT_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	212	__u8 *msgin;
	213	#define STATUS_OFFSET (MSGIN_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	214	__u8 *status;
	215	#define SLOTS_OFFSET (STATUS_OFFSET + L1_CACHE_ALIGN(MSG_ARRAY_SIZE))
	216	struct NCR_700_command_slot *slots;
	217	#define TOTAL_MEM_SIZE (SLOTS_OFFSET + L1_CACHE_ALIGN(sizeof(struct NCR_700_command_slot) * NCR_700_COMMAND_SLOTS_PER_HOST))
	218	int saved_slot_position;
	219	int command_slot_count; /* protected by state lock */
	220	__u8 tag_negotiated;
	221	__u8 rev;
	222	__u8 reselection_id;
	223	__u8 min_period;
	224
	225	/* Free list, singly linked by ITL_forw elements */
	226	struct NCR_700_command_slot *free_list;
	227	/* Completion for waited for ops, like reset, abort or
	228	* device reset.
	229	*
	230	* NOTE: relies on single threading in the error handler to
	231	* have only one outstanding at once */
	232	struct completion *eh_complete;
	233	};
	234
	235	/*
	236	* 53C700 Register Interface - the offset from the Selected base
	237	* I/O address */
	238	#ifdef CONFIG_53C700_LE_ON_BE
	239	#define bE (hostdata->force_le_on_be ? 0 : 3)
	240	#define bSWAP (hostdata->force_le_on_be)
8f23d475	241	#define bEBus (!hostdata->force_le_on_be)
1da177e4 LT	242	#elif defined(__BIG_ENDIAN)
	243	#define bE 3
	244	#define bSWAP 0
	245	#elif defined(__LITTLE_ENDIAN)
	246	#define bE 0
	247	#define bSWAP 0
	248	#else
	249	#error "__BIG_ENDIAN or __LITTLE_ENDIAN must be defined, did you include byteorder.h?"
	250	#endif
8f23d475 JB	251	#ifndef bEBus
	252	#ifdef CONFIG_53C700_BE_BUS
	253	#define bEBus 1
	254	#else
	255	#define bEBus 0
	256	#endif
	257	#endif
1da177e4 LT	258	#define bS_to_cpu(x) (bSWAP ? le32_to_cpu(x) : (x))
	259	#define bS_to_host(x) (bSWAP ? cpu_to_le32(x) : (x))
	260
	261	/* NOTE: These registers are in the LE register space only, the required byte
	262	* swapping is done by the NCR_700_{read\|write}[b] functions */
	263	#define SCNTL0_REG 0x00
	264	#define FULL_ARBITRATION 0xc0
	265	#define PARITY 0x08
	266	#define ENABLE_PARITY 0x04
	267	#define AUTO_ATN 0x02
	268	#define SCNTL1_REG 0x01
	269	#define SLOW_BUS 0x80
	270	#define ENABLE_SELECT 0x20
	271	#define ASSERT_RST 0x08
	272	#define ASSERT_EVEN_PARITY 0x04
	273	#define SDID_REG 0x02
	274	#define SIEN_REG 0x03
	275	#define PHASE_MM_INT 0x80
	276	#define FUNC_COMP_INT 0x40
	277	#define SEL_TIMEOUT_INT 0x20
	278	#define SELECT_INT 0x10
	279	#define GROSS_ERR_INT 0x08
	280	#define UX_DISC_INT 0x04
	281	#define RST_INT 0x02
	282	#define PAR_ERR_INT 0x01
	283	#define SCID_REG 0x04
	284	#define SXFER_REG 0x05
	285	#define ASYNC_OPERATION 0x00
	286	#define SODL_REG 0x06
	287	#define SOCL_REG 0x07
	288	#define SFBR_REG 0x08
	289	#define SIDL_REG 0x09
	290	#define SBDL_REG 0x0A
	291	#define SBCL_REG 0x0B
	292	/* read bits */
	293	#define SBCL_IO 0x01
	294	/write bits /
	295	#define SYNC_DIV_AS_ASYNC 0x00
	296	#define SYNC_DIV_1_0 0x01
	297	#define SYNC_DIV_1_5 0x02
	298	#define SYNC_DIV_2_0 0x03
	299	#define DSTAT_REG 0x0C
	300	#define ILGL_INST_DETECTED 0x01
	301	#define WATCH_DOG_INTERRUPT 0x02
	302	#define SCRIPT_INT_RECEIVED 0x04
	303	#define ABORTED 0x10
	304	#define SSTAT0_REG 0x0D
	305	#define PARITY_ERROR 0x01
	306	#define SCSI_RESET_DETECTED 0x02
	307	#define UNEXPECTED_DISCONNECT 0x04
	308	#define SCSI_GROSS_ERROR 0x08
	309	#define SELECTED 0x10
	310	#define SELECTION_TIMEOUT 0x20
	311	#define FUNCTION_COMPLETE 0x40
	312	#define PHASE_MISMATCH 0x80
	313	#define SSTAT1_REG 0x0E
	314	#define SIDL_REG_FULL 0x80
	315	#define SODR_REG_FULL 0x40
	316	#define SODL_REG_FULL 0x20
	317	#define SSTAT2_REG 0x0F
	318	#define CTEST0_REG 0x14
	319	#define BTB_TIMER_DISABLE 0x40
	320	#define CTEST1_REG 0x15
	321	#define CTEST2_REG 0x16
322	#define CTEST3_REG 0x17
323	#define CTEST4_REG 0x18
324	#define DISABLE_FIFO 0x00
325	#define SLBE 0x10
326	#define SFWR 0x08
327	#define BYTE_LANE0 0x04
328	#define BYTE_LANE1 0x05
329	#define BYTE_LANE2 0x06
330	#define BYTE_LANE3 0x07
331	#define SCSI_ZMODE 0x20
332	#define ZMODE 0x40
333	#define CTEST5_REG 0x19
334	#define MASTER_CONTROL 0x10
335	#define DMA_DIRECTION 0x08
336	#define CTEST7_REG 0x1B
337	#define BURST_DISABLE 0x80 /* 710 only */
338	#define SEL_TIMEOUT_DISABLE 0x10 /* 710 only */
339	#define DFP 0x08
340	#define EVP 0x04
341	#define DIFF 0x01
342	#define CTEST6_REG 0x1A
343	#define TEMP_REG 0x1C
344	#define DFIFO_REG 0x20
345	#define FLUSH_DMA_FIFO 0x80
346	#define CLR_FIFO 0x40
347	#define ISTAT_REG 0x21
348	#define ABORT_OPERATION 0x80
349	#define SOFTWARE_RESET_710 0x40
350	#define DMA_INT_PENDING 0x01
351	#define SCSI_INT_PENDING 0x02
352	#define CONNECTED 0x08
353	#define CTEST8_REG 0x22
354	#define LAST_DIS_ENBL 0x01
355	#define SHORTEN_FILTERING 0x04
356	#define ENABLE_ACTIVE_NEGATION 0x10
357	#define GENERATE_RECEIVE_PARITY 0x20
358	#define CLR_FIFO_710 0x04
359	#define FLUSH_DMA_FIFO_710 0x08
360	#define CTEST9_REG 0x23
361	#define DBC_REG 0x24
362	#define DCMD_REG 0x27
363	#define DNAD_REG 0x28
364	#define DIEN_REG 0x39
365	#define BUS_FAULT 0x20
366	#define ABORT_INT 0x10
367	#define INT_INST_INT 0x04
368	#define WD_INT 0x02
369	#define ILGL_INST_INT 0x01
370	#define DCNTL_REG 0x3B
371	#define SOFTWARE_RESET 0x01
372	#define COMPAT_700_MODE 0x01
373	#define SCRPTS_16BITS 0x20
374	#define ASYNC_DIV_2_0 0x00
375	#define ASYNC_DIV_1_5 0x40
376	#define ASYNC_DIV_1_0 0x80
377	#define ASYNC_DIV_3_0 0xc0
378	#define DMODE_710_REG 0x38
379	#define DMODE_700_REG 0x34
380	#define BURST_LENGTH_1 0x00
381	#define BURST_LENGTH_2 0x40
382	#define BURST_LENGTH_4 0x80
383	#define BURST_LENGTH_8 0xC0
384	#define DMODE_FC1 0x10
385	#define DMODE_FC2 0x20
386	#define BW16 32
387	#define MODE_286 16
388	#define IO_XFER 8
389	#define FIXED_ADDR 4
390
391	#define DSP_REG 0x2C
392	#define DSPS_REG 0x30
393
394	/* Parameters to begin SDTR negotiations. Empirically, I find that
395	* the 53c700-66 cannot handle an offset >8, so don't change this */
396	#define NCR_700_MAX_OFFSET 8
397	/* Was hoping the max offset would be greater for the 710, but
398	* empirically it seems to be 8 also */
399	#define NCR_710_MAX_OFFSET 8
400	#define NCR_700_MIN_XFERP 1
401	#define NCR_710_MIN_XFERP 0
402	#define NCR_700_MIN_PERIOD 25 /* for SDTR message, 100ns */
403
404	#define script_patch_32(script, symbol, value) \
405	{ \
406	int i; \
407	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
408	__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]) + value; \
409	(script)[A_##symbol##_used[i]] = bS_to_host(val); \
410	dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
411	DEBUG((" script, patching %s at %d to 0x%lx\n", \
412	#symbol, A_##symbol##_used[i], (value))); \
413	} \
414	}
415
416	#define script_patch_32_abs(script, symbol, value) \
417	{ \
418	int i; \
419	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
420	(script)[A_##symbol##_used[i]] = bS_to_host(value); \
421	dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
422	DEBUG((" script, patching %s at %d to 0x%lx\n", \
423	#symbol, A_##symbol##_used[i], (value))); \
424	} \
425	}
426
427	/* Used for patching the SCSI ID in the SELECT instruction */
428	#define script_patch_ID(script, symbol, value) \
429	{ \
430	int i; \
431	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
432	__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]); \
433	val &= 0xff00ffff; \
434	val \|= ((value) & 0xff) << 16; \
435	(script)[A_##symbol##_used[i]] = bS_to_host(val); \
436	dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
437	DEBUG((" script, patching ID field %s at %d to 0x%x\n", \
438	#symbol, A_##symbol##_used[i], val)); \
439	} \
440	}
441
442	#define script_patch_16(script, symbol, value) \
443	{ \
444	int i; \
445	for(i=0; i< (sizeof(A_##symbol##_used) / sizeof(__u32)); i++) { \
446	__u32 val = bS_to_cpu((script)[A_##symbol##_used[i]]); \
447	val &= 0xffff0000; \
448	val \|= ((value) & 0xffff); \
449	(script)[A_##symbol##_used[i]] = bS_to_host(val); \
450	dma_cache_sync(&(script)[A_##symbol##_used[i]], 4, DMA_TO_DEVICE); \
451	DEBUG((" script, patching short field %s at %d to 0x%x\n", \
452	#symbol, A_##symbol##_used[i], val)); \
453	} \
454	}
455
456
457	static inline __u8
56fece20	458	NCR_700_readb(struct Scsi_Host *host, __u32 reg)
1da177e4	459	{
56fece20	460	const struct NCR_700_Host_Parameters *hostdata
1da177e4 LT	461	= (struct NCR_700_Host_Parameters *)host->hostdata[0];
1da177e4 LT	462
56fece20	463	return ioread8(hostdata->base + (reg^bE));
1da177e4 LT	464	}
	465
	466	static inline __u32
56fece20	467	NCR_700_readl(struct Scsi_Host *host, __u32 reg)
1da177e4	468	{
56fece20	469	const struct NCR_700_Host_Parameters *hostdata
1da177e4	470	= (struct NCR_700_Host_Parameters *)host->hostdata[0];
8f23d475 JB	471	__u32 value = bEBus ? ioread32be(hostdata->base + reg) :
8f23d475 JB	472	ioread32(hostdata->base + reg);
1da177e4 LT	473	#if 1
	474	/* sanity check the register */
	475	if((reg & 0x3) != 0)
	476	BUG();
	477	#endif
	478
8f23d475	479	return value;
1da177e4 LT	480	}
	481
	482	static inline void
56fece20	483	NCR_700_writeb(__u8 value, struct Scsi_Host *host, __u32 reg)
1da177e4	484	{
56fece20	485	const struct NCR_700_Host_Parameters *hostdata
1da177e4 LT	486	= (struct NCR_700_Host_Parameters *)host->hostdata[0];
1da177e4 LT	487
56fece20	488	iowrite8(value, hostdata->base + (reg^bE));
1da177e4 LT	489	}
	490
	491	static inline void
56fece20	492	NCR_700_writel(__u32 value, struct Scsi_Host *host, __u32 reg)
1da177e4	493	{
56fece20	494	const struct NCR_700_Host_Parameters *hostdata
1da177e4 LT	495	= (struct NCR_700_Host_Parameters *)host->hostdata[0];
	496
	497	#if 1
	498	/* sanity check the register */
	499	if((reg & 0x3) != 0)
	500	BUG();
	501	#endif
	502
8f23d475 JB	503	bEBus ? iowrite32be(value, hostdata->base + reg):
8f23d475 JB	504	iowrite32(value, hostdata->base + reg);
1da177e4 LT	505	}
1da177e4 LT	506
1da177e4	507	#endif