[SCSI] sym53c8xx: Work around 53c896 erratum
[linux-2.6] / drivers / scsi / sym53c8xx_2 / sym53c8xx.h
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
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];
130         char    tag_ctrl[100];
131 };
132
133 #define SYM_SETUP_MAX_TAG               sym_driver_setup.max_tag
134 #define SYM_SETUP_BURST_ORDER           sym_driver_setup.burst_order
135 #define SYM_SETUP_SCSI_LED              sym_driver_setup.scsi_led
136 #define SYM_SETUP_SCSI_DIFF             sym_driver_setup.scsi_diff
137 #define SYM_SETUP_IRQ_MODE              sym_driver_setup.irq_mode
138 #define SYM_SETUP_SCSI_BUS_CHECK        sym_driver_setup.scsi_bus_check
139 #define SYM_SETUP_HOST_ID               sym_driver_setup.host_id
140 #define boot_verbose                    sym_driver_setup.verbose
141
142 /*
143  *  Initial setup.
144  *
145  *  Can be overriden at startup by a command line.
146  */
147 #define SYM_LINUX_DRIVER_SETUP  {                               \
148         .max_tag        = CONFIG_SCSI_SYM53C8XX_DEFAULT_TAGS,   \
149         .burst_order    = 7,                                    \
150         .scsi_led       = 1,                                    \
151         .scsi_diff      = 1,                                    \
152         .irq_mode       = 0,                                    \
153         .scsi_bus_check = 1,                                    \
154         .host_id        = 7,                                    \
155         .verbose        = 0,                                    \
156         .settle_delay   = 3,                                    \
157         .use_nvram      = 1,                                    \
158 }
159
160 extern struct sym_driver_setup sym_driver_setup;
161 extern unsigned int sym_debug_flags;
162 #define DEBUG_FLAGS     sym_debug_flags
163
164 /*
165  *  Max number of targets.
166  *  Maximum is 16 and you are advised not to change this value.
167  */
168 #ifndef SYM_CONF_MAX_TARGET
169 #define SYM_CONF_MAX_TARGET     (16)
170 #endif
171
172 /*
173  *  Max number of logical units.
174  *  SPI-2 allows up to 64 logical units, but in real life, target
175  *  that implements more that 7 logical units are pretty rare.
176  *  Anyway, the cost of accepting up to 64 logical unit is low in 
177  *  this driver, thus going with the maximum is acceptable.
178  */
179 #ifndef SYM_CONF_MAX_LUN
180 #define SYM_CONF_MAX_LUN        (64)
181 #endif
182
183 /*
184  *  Max number of IO control blocks queued to the controller.
185  *  Each entry needs 8 bytes and the queues are allocated contiguously.
186  *  Since we donnot want to allocate more than a page, the theorical 
187  *  maximum is PAGE_SIZE/8. For safety, we announce a bit less to the 
188  *  access method. :)
189  *  When not supplied, as it is suggested, the driver compute some 
190  *  good value for this parameter.
191  */
192 /* #define SYM_CONF_MAX_START   (PAGE_SIZE/8 - 16) */
193
194 /*
195  *  Support for Immediate Arbitration.
196  *  Not advised.
197  */
198 /* #define SYM_CONF_IARB_SUPPORT */
199
200 /*
201  *  Only relevant if IARB support configured.
202  *  - Max number of successive settings of IARB hints.
203  *  - Set IARB on arbitration lost.
204  */
205 #define SYM_CONF_IARB_MAX 3
206 #define SYM_CONF_SET_IARB_ON_ARB_LOST 1
207
208 /*
209  *  Returning wrong residuals may make problems.
210  *  When zero, this define tells the driver to 
211  *  always return 0 as transfer residual.
212  *  Btw, all my testings of residuals have succeeded.
213  */
214 #define SYM_SETUP_RESIDUAL_SUPPORT 1
215
216 #endif /* SYM53C8XX_H */