xref: /freebsd/sys/dev/sym/sym_conf.h (revision 40a8ac8f62b535d30349faf28cf47106b7041b83)
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 an I/O.
94  *  Each entry costs 8 bytes in the internal CCB data structure.
95  *  We use at most 33 segments but also no more than required for handling
96  *  MAXPHYS.
97  */
98 #define	SYM_CONF_MAX_SG		(MIN(33, (MAXPHYS / PAGE_SIZE) + 1))
99 
100 /*
101  *  Max number of targets.
102  *  Maximum is 16 and you are advised not to change this value.
103  */
104 #define SYM_CONF_MAX_TARGET	(16)
105 
106 /*
107  *  Max number of logical units.
108  *  SPI-2 allows up to 64 logical units, but in real life, target
109  *  that implements more that 7 logical units are pretty rare.
110  *  Anyway, the cost of accepting up to 64 logical unit is low in
111  *  this driver, thus going with the maximum is acceptable.
112  */
113 #define SYM_CONF_MAX_LUN		(64)
114 
115 /*
116  *  Max number of IO control blocks queued to the controller.
117  *  Each entry needs 8 bytes and the queues are allocated contiguously.
118  *  Since we donnot want to allocate more than a page, the theorical
119  *  maximum is PAGE_SIZE/8. For safety, we announce a bit less to the
120  *  access method. :)
121  *  When not supplied, as it is suggested, the driver compute some
122  *  good value for this parameter.
123  */
124 /* #define SYM_CONF_MAX_START	(PAGE_SIZE/8 - 16) */
125 
126 /*
127  *  Support for NVRAM.
128  */
129 #define SYM_CONF_NVRAM_SUPPORT
130 /* #define SYM_CONF_NVRAM_SUPPORT */
131 
132 /*
133  *  Support for Immediate Arbitration.
134  *  Not advised.
135  */
136 /* #define SYM_CONF_IARB_SUPPORT */
137 
138 /*-------------------------------------------------------------------
139  *  Configuration that could be dynamic if it was possible
140  *  to pass arguments to the driver.
141  *-------------------------------------------------------------------
142  */
143 
144 /*
145  *  HOST default scsi id.
146  */
147 #define SYM_SETUP_HOST_ID	7
148 
149 /*
150  *  Max synchronous transfers.
151  */
152 #define SYM_SETUP_MIN_SYNC	(9)
153 
154 /*
155  *  Max wide order.
156  */
157 #define SYM_SETUP_MAX_WIDE	(1)
158 
159 /*
160  *  Max SCSI offset.
161  */
162 #define SYM_SETUP_MAX_OFFS	(63)
163 
164 /*
165  *  Default number of tags.
166  */
167 #define SYM_SETUP_MAX_TAG	(1<<SYM_CONF_MAX_TAG_ORDER)
168 
169 /*
170  *  SYMBIOS NVRAM format support.
171  */
172 #define SYM_SETUP_SYMBIOS_NVRAM	(1)
173 
174 /*
175  *  TEKRAM NVRAM format support.
176  */
177 #define SYM_SETUP_TEKRAM_NVRAM	(1)
178 
179 /*
180  *  PCI parity checking.
181  *  It should not be an option, but some poor or broken
182  *  PCI-HOST bridges have been reported to make problems
183  *  when this feature is enabled.
184  *  Setting this option to 0 tells the driver not to
185  *  enable the checking against PCI parity.
186  */
187 #ifndef SYM_SETUP_PCI_PARITY
188 #define SYM_SETUP_PCI_PARITY	(1)
189 #endif
190 
191 /*
192  *  SCSI parity checking.
193  */
194 #define SYM_SETUP_SCSI_PARITY	(1)
195 
196 /*
197  *  SCSI activity LED.
198  */
199 #define SYM_SETUP_SCSI_LED	(0)
200 
201 /*
202  *  SCSI High Voltage Differential support.
203  *
204  *  HVD/LVD/SE capable controllers (895, 895A, 896, 1010)
205  *  report the actual SCSI BUS mode from the STEST4 IO
206  *  register.
207  *
208  *  But for HVD/SE only capable chips (825a, 875, 885),
209  *  the driver uses some heuristic to probe against HVD.
210  *  Normally, the chip senses the DIFFSENS signal and
211  *  should switch its BUS tranceivers to high impedance
212  *  in situation of the driver having been wrong about
213  *  the actual BUS mode. May-be, the BUS mode probing of
214  *  the driver is safe, but, given that it may be partially
215  *  based on some previous IO register settings, it
216  *  cannot be stated so. Thus, decision has been taken
217  *  to require a user option to be set for the DIFF probing
218  *  to be applied for the 825a, 875 and 885 chips.
219  *
220  *  This setup option works as follows:
221  *
222  *    0  ->  HVD only supported for 895, 895A, 896, 1010.
223  *    1  ->  HVD probed  for 825A, 875, 885.
224  *    2  ->  HVD assumed for 825A, 875, 885 (not advised).
225  */
226 #ifndef SYM_SETUP_SCSI_DIFF
227 #define SYM_SETUP_SCSI_DIFF	(0)
228 #endif
229 
230 /*
231  *  IRQ mode.
232  */
233 #define SYM_SETUP_IRQ_MODE	(0)
234 
235 /*
236  *  Check SCSI BUS signal on reset.
237  */
238 #define SYM_SETUP_SCSI_BUS_CHECK	(1)
239 
240 /*
241  *  Max burst for PCI (1<<value)
242  *  7 means: (1<<7) = 128 DWORDS.
243  */
244 #define SYM_SETUP_BURST_ORDER	(7)
245 
246 /*
247  *  Only relevant if IARB support configured.
248  *  - Max number of successive settings of IARB hints.
249  *  - Set IARB on arbitration lost.
250  */
251 #define SYM_CONF_IARB_MAX 3
252 #define SYM_CONF_SET_IARB_ON_ARB_LOST 1
253 
254 /*
255  *  Returning wrong residuals may make problems.
256  *  When zero, this define tells the driver to
257  *  always return 0 as transfer residual.
258  *  Btw, all my testings of residuals have succeeded.
259  */
260 #define SYM_CONF_RESIDUAL_SUPPORT 1
261 
262 /*
263  *  Supported maximum number of LUNs to announce to
264  *  the access method.
265  *  The driver supports up to 64 LUNs per target as
266  *  required by SPI-2/SPI-3. However some SCSI devices
267  *  designed prior to these specifications or not being
268  *  conformant may be highly confused when they are
269  *  asked about a LUN > 7.
270  */
271 #ifndef SYM_SETUP_MAX_LUN
272 #define SYM_SETUP_MAX_LUN	(8)
273 #endif
274 
275 /*
276  *  Low priority probe map.
277  *
278  *  This option is used as a bitmap to tell the driver
279  *  about chips that are to be claimed with a low priority
280  *  (-2000) by the probe method. This allows any other driver
281  *  that may return some higher priority value for the same
282  *  chips to take precedence over this driver (sym).
283  *  This option may be used when both the ncr driver and this
284  *  driver are configured.
285  *
286  *  Bits are to be coded as follows:
287  *    0x01  ->  810a, 860
288  *    0x02  ->  825a, 875, 885, 895
289  *    0x04  ->  895a, 896, 1510d
290  *    0x08  ->  1010
291  *    0x40  ->  810, 815, 825
292  *
293  *  For example, value 5 tells the driver to claim support
294  *  for 810a, 860, 895a, 896 and 1510d with low priority,
295  *  allowing the ncr driver to take precedence if configured.
296  */
297 #ifndef SYM_SETUP_LP_PROBE_MAP
298 #define SYM_SETUP_LP_PROBE_MAP 0
299 #endif
300 
301 #endif /* SYM_CONF_H */
302