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