[linux-2.6-block.git] / drivers / scsi / sym53c8xx_2 / sym53c8xx.h

/*
 * Device driver for the SYMBIOS/LSILOGIC 53C8XX and 53C1010 family 
 * of PCI-SCSI IO processors.
 *
 * Copyright (C) 1999-2001  Gerard Roudier <groudier@free.fr>
 *
 * This driver is derived from the Linux sym53c8xx driver.
 * Copyright (C) 1998-2000  Gerard Roudier
 *
 * The sym53c8xx driver is derived from the ncr53c8xx driver that had been 
 * a port of the FreeBSD ncr driver to Linux-1.2.13.
 *
 * The original ncr driver has been written for 386bsd and FreeBSD by
 *         Wolfgang Stanglmeier        <wolf@cologne.de>
 *         Stefan Esser                <se@mi.Uni-Koeln.de>
 * Copyright (C) 1994  Wolfgang Stanglmeier
 *
 * Other major contributions:
 *
 * NVRAM detection and reading.
 * Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
 *
 *-----------------------------------------------------------------------------
 *
 * 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
 */

#ifndef SYM53C8XX_H
#define SYM53C8XX_H


/*
 *  DMA addressing mode.
 *
 *  0 : 32 bit addressing for all chips.
 *  1 : 40 bit addressing when supported by chip.
 *  2 : 64 bit addressing when supported by chip,
 *      limited to 16 segments of 4 GB -> 64 GB max.
 */
#define	SYM_CONF_DMA_ADDRESSING_MODE CONFIG_SCSI_SYM53C8XX_DMA_ADDRESSING_MODE

/*
 *  NVRAM support.
 */
#if 1
#define SYM_CONF_NVRAM_SUPPORT		(1)
#endif

/*
 *  These options are not tunable from 'make config'
 */
#if 1
#define	SYM_LINUX_PROC_INFO_SUPPORT
#define SYM_LINUX_USER_COMMAND_SUPPORT
#define SYM_LINUX_USER_INFO_SUPPORT
#define SYM_LINUX_DEBUG_CONTROL_SUPPORT
#endif

/*
 *  Also handle old NCR chips if not (0).
 */
#define SYM_CONF_GENERIC_SUPPORT	(1)

/*
 *  Allow tags from 2 to 256, default 8
 */
#ifndef CONFIG_SCSI_SYM53C8XX_MAX_TAGS
#define CONFIG_SCSI_SYM53C8XX_MAX_TAGS	(8)
#endif

#if	CONFIG_SCSI_SYM53C8XX_MAX_TAGS < 2
#define SYM_CONF_MAX_TAG	(2)
#elif	CONFIG_SCSI_SYM53C8XX_MAX_TAGS > 256
#define SYM_CONF_MAX_TAG	(256)
#else
#define	SYM_CONF_MAX_TAG	CONFIG_SCSI_SYM53C8XX_MAX_TAGS
#endif

#ifndef	CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS
#define	CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS	SYM_CONF_MAX_TAG
#endif

/*
 *  Anyway, we configure the driver for at least 64 tags per LUN. :)
 */
#if	SYM_CONF_MAX_TAG <= 64
#define SYM_CONF_MAX_TAG_ORDER	(6)
#elif	SYM_CONF_MAX_TAG <= 128
#define SYM_CONF_MAX_TAG_ORDER	(7)
#else
#define SYM_CONF_MAX_TAG_ORDER	(8)
#endif

/*
 *  Max number of SG entries.
 */
#define SYM_CONF_MAX_SG		(96)

/*
 *  Driver setup structure.
 *
 *  This structure is initialized from linux config options.
 *  It can be overridden at boot-up by the boot command line.
 */
struct sym_driver_setup {
	u_short	max_tag;
	u_char	burst_order;
	u_char	scsi_led;
	u_char	scsi_diff;
	u_char	irq_mode;
	u_char	scsi_bus_check;
	u_char	host_id;

	u_char	verbose;
	u_char	settle_delay;
	u_char	use_nvram;
	u_long	excludes[8];
};

#define SYM_SETUP_MAX_TAG		sym_driver_setup.max_tag
#define SYM_SETUP_BURST_ORDER		sym_driver_setup.burst_order
#define SYM_SETUP_SCSI_LED		sym_driver_setup.scsi_led
#define SYM_SETUP_SCSI_DIFF		sym_driver_setup.scsi_diff
#define SYM_SETUP_IRQ_MODE		sym_driver_setup.irq_mode
#define SYM_SETUP_SCSI_BUS_CHECK	sym_driver_setup.scsi_bus_check
#define SYM_SETUP_HOST_ID		sym_driver_setup.host_id
#define boot_verbose			sym_driver_setup.verbose

/*
 *  Initial setup.
 *
 *  Can be overriden at startup by a command line.
 */
#define SYM_LINUX_DRIVER_SETUP	{				\
	.max_tag	= CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS,	\
	.burst_order	= 7,					\
	.scsi_led	= 1,					\
	.scsi_diff	= 1,					\
	.irq_mode	= 0,					\
	.scsi_bus_check	= 1,					\
	.host_id	= 7,					\
	.verbose	= 0,					\
	.settle_delay	= 3,					\
	.use_nvram	= 1,					\
}

extern struct sym_driver_setup sym_driver_setup;
extern unsigned int sym_debug_flags;
#define DEBUG_FLAGS	sym_debug_flags

/*
 *  Max number of targets.
 *  Maximum is 16 and you are advised not to change this value.
 */
#ifndef SYM_CONF_MAX_TARGET
#define SYM_CONF_MAX_TARGET	(16)
#endif

/*
 *  Max number of logical units.
 *  SPI-2 allows up to 64 logical units, but in real life, target
 *  that implements more that 7 logical units are pretty rare.
 *  Anyway, the cost of accepting up to 64 logical unit is low in 
 *  this driver, thus going with the maximum is acceptable.
 */
#ifndef SYM_CONF_MAX_LUN
#define SYM_CONF_MAX_LUN	(64)
#endif

/*
 *  Max number of IO control blocks queued to the controller.
 *  Each entry needs 8 bytes and the queues are allocated contiguously.
 *  Since we donnot want to allocate more than a page, the theorical 
 *  maximum is PAGE_SIZE/8. For safety, we announce a bit less to the 
 *  access method. :)
 *  When not supplied, as it is suggested, the driver compute some 
 *  good value for this parameter.
 */
/* #define SYM_CONF_MAX_START	(PAGE_SIZE/8 - 16) */

/*
 *  Support for Immediate Arbitration.
 *  Not advised.
 */
/* #define SYM_CONF_IARB_SUPPORT */

/*
 *  Only relevant if IARB support configured.
 *  - Max number of successive settings of IARB hints.
 *  - Set IARB on arbitration lost.
 */
#define SYM_CONF_IARB_MAX 3
#define SYM_CONF_SET_IARB_ON_ARB_LOST 1

/*
 *  Returning wrong residuals may make problems.
 *  When zero, this define tells the driver to 
 *  always return 0 as transfer residual.
 *  Btw, all my testings of residuals have succeeded.
 */
#define SYM_SETUP_RESIDUAL_SUPPORT 1

#endif /* SYM53C8XX_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Device driver for the SYMBIOS/LSILOGIC 53C8XX and 53C1010 family
	3	* of PCI-SCSI IO processors.
	4	*
	5	* Copyright (C) 1999-2001 Gerard Roudier <groudier@free.fr>
	6	*
	7	* This driver is derived from the Linux sym53c8xx driver.
	8	* Copyright (C) 1998-2000 Gerard Roudier
	9	*
	10	* The sym53c8xx driver is derived from the ncr53c8xx driver that had been
	11	* a port of the FreeBSD ncr driver to Linux-1.2.13.
	12	*
	13	* The original ncr driver has been written for 386bsd and FreeBSD by
	14	* Wolfgang Stanglmeier <wolf@cologne.de>
	15	* Stefan Esser <se@mi.Uni-Koeln.de>
	16	* Copyright (C) 1994 Wolfgang Stanglmeier
	17	*
	18	* Other major contributions:
	19	*
	20	* NVRAM detection and reading.
	21	* Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
	22	*
	23	*-----------------------------------------------------------------------------
	24	*
	25	* This program is free software; you can redistribute it and/or modify
	26	* it under the terms of the GNU General Public License as published by
	27	* the Free Software Foundation; either version 2 of the License, or
	28	* (at your option) any later version.
	29	*
	30	* This program is distributed in the hope that it will be useful,
	31	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	32	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	33	* GNU General Public License for more details.
	34	*
	35	* You should have received a copy of the GNU General Public License
	36	* along with this program; if not, write to the Free Software
	37	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	38	*/
	39
	40	#ifndef SYM53C8XX_H
	41	#define SYM53C8XX_H
	42
1da177e4 LT	43
	44	/*
	45	* DMA addressing mode.
	46	*
	47	* 0 : 32 bit addressing for all chips.
	48	* 1 : 40 bit addressing when supported by chip.
	49	* 2 : 64 bit addressing when supported by chip,
	50	* limited to 16 segments of 4 GB -> 64 GB max.
	51	*/
	52	#define SYM_CONF_DMA_ADDRESSING_MODE CONFIG_SCSI_SYM53C8XX_DMA_ADDRESSING_MODE
	53
	54	/*
	55	* NVRAM support.
	56	*/
	57	#if 1
	58	#define SYM_CONF_NVRAM_SUPPORT (1)
	59	#endif
	60
	61	/*
	62	* These options are not tunable from 'make config'
	63	*/
	64	#if 1
	65	#define SYM_LINUX_PROC_INFO_SUPPORT
	66	#define SYM_LINUX_USER_COMMAND_SUPPORT
	67	#define SYM_LINUX_USER_INFO_SUPPORT
	68	#define SYM_LINUX_DEBUG_CONTROL_SUPPORT
	69	#endif
	70
	71	/*
	72	* Also handle old NCR chips if not (0).
	73	*/
	74	#define SYM_CONF_GENERIC_SUPPORT (1)
	75
	76	/*
	77	* Allow tags from 2 to 256, default 8
	78	*/
	79	#ifndef CONFIG_SCSI_SYM53C8XX_MAX_TAGS
	80	#define CONFIG_SCSI_SYM53C8XX_MAX_TAGS (8)
	81	#endif
	82
	83	#if CONFIG_SCSI_SYM53C8XX_MAX_TAGS < 2
	84	#define SYM_CONF_MAX_TAG (2)
	85	#elif CONFIG_SCSI_SYM53C8XX_MAX_TAGS > 256
	86	#define SYM_CONF_MAX_TAG (256)
	87	#else
	88	#define SYM_CONF_MAX_TAG CONFIG_SCSI_SYM53C8XX_MAX_TAGS
	89	#endif
	90
	91	#ifndef CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS
	92	#define CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS SYM_CONF_MAX_TAG
	93	#endif
	94
	95	/*
	96	* Anyway, we configure the driver for at least 64 tags per LUN. :)
	97	*/
	98	#if SYM_CONF_MAX_TAG <= 64
	99	#define SYM_CONF_MAX_TAG_ORDER (6)
	100	#elif SYM_CONF_MAX_TAG <= 128
	101	#define SYM_CONF_MAX_TAG_ORDER (7)
	102	#else
	103	#define SYM_CONF_MAX_TAG_ORDER (8)
	104	#endif
	105
	106	/*
107	* Max number of SG entries.
108	*/
109	#define SYM_CONF_MAX_SG (96)
110
111	/*
112	* Driver setup structure.
113	*
114	* This structure is initialized from linux config options.
115	* It can be overridden at boot-up by the boot command line.
116	*/
117	struct sym_driver_setup {
118	u_short max_tag;
119	u_char burst_order;
120	u_char scsi_led;
121	u_char scsi_diff;
122	u_char irq_mode;
123	u_char scsi_bus_check;
124	u_char host_id;
125
126	u_char verbose;
127	u_char settle_delay;
128	u_char use_nvram;
129	u_long excludes[8];
1da177e4 LT	130	};
	131
	132	#define SYM_SETUP_MAX_TAG sym_driver_setup.max_tag
	133	#define SYM_SETUP_BURST_ORDER sym_driver_setup.burst_order
	134	#define SYM_SETUP_SCSI_LED sym_driver_setup.scsi_led
	135	#define SYM_SETUP_SCSI_DIFF sym_driver_setup.scsi_diff
	136	#define SYM_SETUP_IRQ_MODE sym_driver_setup.irq_mode
	137	#define SYM_SETUP_SCSI_BUS_CHECK sym_driver_setup.scsi_bus_check
	138	#define SYM_SETUP_HOST_ID sym_driver_setup.host_id
	139	#define boot_verbose sym_driver_setup.verbose
	140
	141	/*
	142	* Initial setup.
	143	*
	144	* Can be overriden at startup by a command line.
	145	*/
	146	#define SYM_LINUX_DRIVER_SETUP { \
	147	.max_tag = CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS, \
	148	.burst_order = 7, \
	149	.scsi_led = 1, \
	150	.scsi_diff = 1, \
	151	.irq_mode = 0, \
	152	.scsi_bus_check = 1, \
	153	.host_id = 7, \
	154	.verbose = 0, \
	155	.settle_delay = 3, \
	156	.use_nvram = 1, \
	157	}
	158
	159	extern struct sym_driver_setup sym_driver_setup;
	160	extern unsigned int sym_debug_flags;
	161	#define DEBUG_FLAGS sym_debug_flags
	162
	163	/*
	164	* Max number of targets.
	165	* Maximum is 16 and you are advised not to change this value.
	166	*/
	167	#ifndef SYM_CONF_MAX_TARGET
	168	#define SYM_CONF_MAX_TARGET (16)
	169	#endif
	170
	171	/*
	172	* Max number of logical units.
	173	* SPI-2 allows up to 64 logical units, but in real life, target
	174	* that implements more that 7 logical units are pretty rare.
	175	* Anyway, the cost of accepting up to 64 logical unit is low in
	176	* this driver, thus going with the maximum is acceptable.
	177	*/
	178	#ifndef SYM_CONF_MAX_LUN
	179	#define SYM_CONF_MAX_LUN (64)
	180	#endif
	181
	182	/*
	183	* Max number of IO control blocks queued to the controller.
	184	* Each entry needs 8 bytes and the queues are allocated contiguously.
	185	* Since we donnot want to allocate more than a page, the theorical
	186	* maximum is PAGE_SIZE/8. For safety, we announce a bit less to the
	187	* access method. :)
	188	* When not supplied, as it is suggested, the driver compute some
	189	* good value for this parameter.
	190	*/
	191	/* #define SYM_CONF_MAX_START (PAGE_SIZE/8 - 16) */
	192
	193	/*
194	* Support for Immediate Arbitration.
195	* Not advised.
196	*/
197	/* #define SYM_CONF_IARB_SUPPORT */
198
199	/*
200	* Only relevant if IARB support configured.
201	* - Max number of successive settings of IARB hints.
202	* - Set IARB on arbitration lost.
203	*/
204	#define SYM_CONF_IARB_MAX 3
205	#define SYM_CONF_SET_IARB_ON_ARB_LOST 1
206
207	/*
208	* Returning wrong residuals may make problems.
209	* When zero, this define tells the driver to
210	* always return 0 as transfer residual.
211	* Btw, all my testings of residuals have succeeded.
212	*/
213	#define SYM_SETUP_RESIDUAL_SUPPORT 1
214
215	#endif /* SYM53C8XX_H */