xref: /freebsd/sys/dev/sym/sym_conf.h (revision 5129159789cc9d7bc514e4546b88e3427695002d)
1 /*
2  *  Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
3  *  PCI-SCSI controllers.
4  *
5  *  Copyright (C) 1999  Gerard Roudier <groudier@club-internet.fr>
6  *
7  *  This driver also supports the following Symbios/LSI PCI-SCSI chips:
8  *	53C810A, 53C825A, 53C860, 53C875, 53C876, 53C885, 53C895.
9  *
10  *  but does not support earlier chips as the following ones:
11  *	53C810, 53C815, 53C825.
12  *
13  *  This driver for FreeBSD-CAM is derived from the Linux sym53c8xx driver.
14  *  Copyright (C) 1998-1999  Gerard Roudier
15  *
16  *  The sym53c8xx driver is derived from the ncr53c8xx driver that had been
17  *  a port of the FreeBSD ncr driver to Linux-1.2.13.
18  *
19  *  The original ncr driver has been written for 386bsd and FreeBSD by
20  *          Wolfgang Stanglmeier        <wolf@cologne.de>
21  *          Stefan Esser                <se@mi.Uni-Koeln.de>
22  *  Copyright (C) 1994  Wolfgang Stanglmeier
23  *
24  *  The initialisation code, and part of the code that addresses
25  *  FreeBSD-CAM services is based on the aic7xxx driver for FreeBSD-CAM
26  *  written by Justin T. Gibbs.
27  *
28  *  Other major contributions:
29  *
30  *  NVRAM detection and reading.
31  *  Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
32  *
33  *-----------------------------------------------------------------------------
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  * 1. Redistributions of source code must retain the above copyright
39  *    notice, this list of conditions and the following disclaimer.
40  * 2. Redistributions in binary form must reproduce the above copyright
41  *    notice, this list of conditions and the following disclaimer in the
42  *    documentation and/or other materials provided with the distribution.
43  * 3. The name of the author may not be used to endorse or promote products
44  *    derived from this software without specific prior written permission.
45  *
46  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
50  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56  * SUCH DAMAGE.
57  */
58 #ifndef SYM_CONF_H
59 #define SYM_CONF_H
60 
61 /*-------------------------------------------------------------------
62  *  Static configuration.
63  *-------------------------------------------------------------------
64  */
65 
66 /*
67  *  Support for earliest LSI53C1010 boards.
68  *
69  *  This option enables work-arounds for the experimental
70  *  C1010 chips revision 0 to work in DT mode.
71  *  Since, officially supported chips (B0 stepping and later)
72  *  have been fixed, nobody, except driver maintainers,
73  *  should ever needed this option to have been defined.
74  *  This option and the code it addresses will be removed
75  *  from the source in some later version of the driver.
76  *  By the way, the 53C1010 B0 stepping (rev. 1) has been
77  *  tested ok with Ultra3 DT data transfers using this driver,
78  *  without these work-arounds being enabled.
79  */
80 /* #define	SYM_CONF_BROKEN_U3EN_SUPPORT */
81 
82 /*
83  *  Use Normal IO instead of MMIO.
84  */
85 /* #define SYM_CONF_IOMAPPED */
86 
87 /*
88  *  Max tags for a device (logical unit)
89  * 	We use a power of 2, (7) means 2<<7=128
90  *  Maximum is 8 -> 256 tags
91  */
92 #define SYM_CONF_MAX_TAG_ORDER	(6)
93 
94 /*
95  *  Max number of scatter/gather entries for en IO.
96  *  Each entry costs 8 bytes in the internal CCB data structure.
97  *  For now 65 should suffice given the BSD O/Ses capabilities.
98  */
99 #define SYM_CONF_MAX_SG		(33)
100 
101 /*
102  *  Max number of targets.
103  *  Maximum is 16 and you are advised not to change this value.
104  */
105 #define SYM_CONF_MAX_TARGET	(16)
106 
107 /*
108  *  Max number of logical units.
109  *  SPI-2 allows up to 64 logical units, but in real life, target
110  *  that implements more that 7 logical units are pretty rare.
111  *  Anyway, the cost of accepting up to 64 logical unit is low in
112  *  this driver, thus going with the maximum is acceptable.
113  */
114 #define SYM_CONF_MAX_LUN		(64)
115 
116 /*
117  *  Max number of IO control blocks queued to the controller.
118  *  Each entry needs 8 bytes and the queues are allocated contiguously.
119  *  Since we donnot want to allocate more than a page, the theorical
120  *  maximum is PAGE_SIZE/8. For safety, we announce a bit less to the
121  *  access method. :)
122  *  When not supplied, as it is suggested, the driver compute some
123  *  good value for this parameter.
124  */
125 /* #define SYM_CONF_MAX_START	(PAGE_SIZE/8 - 16) */
126 
127 /*
128  *  Support for NVRAM.
129  */
130 #define SYM_CONF_NVRAM_SUPPORT
131 /* #define SYM_CONF_DEBUG_SUPPORT */
132 
133 /*
134  *  Support for Immediate Arbitration.
135  *  Not advised.
136  */
137 /* #define SYM_CONF_IARB_SUPPORT */
138 
139 /*
140  *  Not needed on FreeBSD, since the system allocator
141  *  does provide naturally aligned addresses.
142  */
143 #define	SYM_CONF_USE_INTERNAL_ALLOCATOR
144 
145 /*-------------------------------------------------------------------
146  *  Configuration that could be dynamic if it was possible
147  *  to pass arguments to the driver.
148  *-------------------------------------------------------------------
149  */
150 
151 /*
152  *  HOST default scsi id.
153  */
154 #define SYM_SETUP_HOST_ID	7
155 
156 /*
157  *  Max synchronous transfers.
158  */
159 #define SYM_SETUP_MIN_SYNC	(9)
160 
161 /*
162  *  Max wide order.
163  */
164 #define SYM_SETUP_MAX_WIDE	(1)
165 
166 /*
167  *  Max SCSI offset.
168  */
169 #define SYM_SETUP_MAX_OFFS	(64)
170 
171 /*
172  *  Default number of tags.
173  */
174 #define SYM_SETUP_MAX_TAG	(1<<SYM_CONF_MAX_TAG_ORDER)
175 
176 /*
177  *  SYMBIOS NVRAM format support.
178  */
179 #define SYM_SETUP_SYMBIOS_NVRAM	(1)
180 
181 /*
182  *  TEKRAM NVRAM format support.
183  */
184 #define SYM_SETUP_TEKRAM_NVRAM	(1)
185 
186 /*
187  *  PCI parity checking.
188  *  It should not be an option, but some poor or broken
189  *  PCI-HOST bridges have been reported to make problems
190  *  when this feature is enabled.
191  *  Setting this option to 0 tells the driver not to
192  *  enable the checking against PCI parity.
193  */
194 #ifndef SYM_SETUP_PCI_PARITY
195 #define SYM_SETUP_PCI_PARITY	(1)
196 #endif
197 
198 /*
199  *  SCSI parity checking.
200  */
201 #define SYM_SETUP_SCSI_PARITY	(1)
202 
203 /*
204  *  SCSI activity LED.
205  */
206 #define SYM_SETUP_SCSI_LED	(0)
207 
208 /*
209  *  SCSI High Voltage Differential support.
210  *
211  *  HVD/LVD/SE capable controllers (895, 895A, 896, 1010)
212  *  report the actual SCSI BUS mode from the STEST4 IO
213  *  register.
214  *
215  *  But for HVD/SE only capable chips (825a, 875, 885),
216  *  the driver uses some heuristic to probe against HVD.
217  *  Normally, the chip senses the DIFFSENS signal and
218  *  should switch its BUS tranceivers to high impedance
219  *  in situation of the driver having been wrong about
220  *  the actual BUS mode. May-be, the BUS mode probing of
221  *  the driver is safe, but, given that it may be partially
222  *  based on some previous IO register settings, it
223  *  cannot be stated so. Thus, decision has been taken
224  *  to require a user option to be set for the DIFF probing
225  *  to be applied for the 825a, 875 and 885 chips.
226  *
227  *  This setup option works as follows:
228  *
229  *    0  ->  HVD only supported for 895, 895A, 896, 1010.
230  *    1  ->  HVD probed  for 825A, 875, 885.
231  *    2  ->  HVD assumed for 825A, 875, 885 (not advised).
232  */
233 #ifndef SYM_SETUP_SCSI_DIFF
234 #define SYM_SETUP_SCSI_DIFF	(0)
235 #endif
236 
237 /*
238  *  IRQ mode.
239  */
240 #define SYM_SETUP_IRQ_MODE	(0)
241 
242 /*
243  *  Check SCSI BUS signal on reset.
244  */
245 #define SYM_SETUP_SCSI_BUS_CHECK	(1)
246 
247 /*
248  *  Max burst for PCI (1<<value)
249  *  7 means: (1<<7) = 128 DWORDS.
250  */
251 #define SYM_SETUP_BURST_ORDER	(7)
252 
253 /*
254  *  Only relevant if IARB support configured.
255  *  - Max number of successive settings of IARB hints.
256  *  - Set IARB on arbitration lost.
257  */
258 #define SYM_CONF_IARB_MAX 3
259 #define SYM_CONF_SET_IARB_ON_ARB_LOST 1
260 
261 /*
262  *  Returning wrong residuals may make problems.
263  *  When zero, this define tells the driver to
264  *  always return 0 as transfer residual.
265  *  Btw, all my testings of residuals have succeeded.
266  */
267 #define SYM_CONF_RESIDUAL_SUPPORT 1
268 
269 /*
270  *  Supported maximum number of LUNs to announce to
271  *  the access method.
272  *  The driver supports up to 64 LUNs per target as
273  *  required by SPI-2/SPI-3. However some SCSI devices
274  *  designed prior to these specifications or not being
275  *  conformant may be highly confused when they are
276  *  asked about a LUN > 7.
277  */
278 #ifndef SYM_SETUP_MAX_LUN
279 #define SYM_SETUP_MAX_LUN	(8)
280 #endif
281 
282 /*
283  *  Low priority probe map.
284  *
285  *  This option is used as a bitmap to tell the driver
286  *  about chips that are to be claimed with a low priority
287  *  (-2000) by the probe method. This allows any other driver
288  *  that may return some higher priority value for the same
289  *  chips to take precedence over this driver (sym).
290  *  This option may be used when both the ncr driver and this
291  *  driver are configured.
292  *
293  *  Bits are to be coded as follows:
294  *    1  ->  810a, 860
295  *    2  ->  825a, 875, 885, 895
296  *    4  ->  895a, 896, 1510d
297  *    8  ->  1010
298  *
299  *  For example, value 5 tells the driver to claim support
300  *  for 810a, 860, 895a, 896 and 1510d with low priority,
301  *  allowing the ncr driver to take precedence if configured.
302  */
303 #ifndef SYM_SETUP_LP_PROBE_MAP
304 #define SYM_SETUP_LP_PROBE_MAP 0
305 #endif
306 
307 #endif /* SYM_CONF_H */
308