| blob | 547d2059547463bb52e9324926642448c0ec33cf |
1 .\"
2 .\" Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
3 .\" PCI SCSI controllers.
4 .\"
5 .\" Copyright (C) 1999-2000 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 .\" 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 initialization 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 .\" $FreeBSD$
58 .\"
59 .Dd August 19, 2004
60 .Dt SYM 4
61 .Os
62 .Sh NAME
63 .Nm sym
64 .Nd NCR/Symbios/LSI Logic 53C8XX PCI SCSI host adapter driver
65 .Sh SYNOPSIS
66 To compile this driver into the kernel,
67 place the following lines in your
68 kernel configuration file:
69 .Bd -ragged -offset indent
70 .Cd "device pci"
71 .Cd "device scbus"
72 .Cd "device sym"
73 .Pp
74 To disable PCI parity checking (needed for broken bridges):
75 .Cd "options SYM_SETUP_PCI_PARITY=<boolean>"
76 .Pp
77 To control driver probing against HVD buses:
78 .Cd "options SYM_SETUP_SCSI_DIFF=<bit combination>"
79 .Pp
80 To control chip attachment balancing between the ncr driver and this driver:
81 .Cd "options SYM_SETUP_LP_PROBE_MAP=<bit combination>"
82 .Ed
83 .Pp
84 Alternatively, to load the driver as a
85 module at boot time, place the following line in
86 .Xr loader.conf 5 :
87 .Bd -literal -offset indent
88 sym_load="YES"
89 .Ed
90 .Sh DESCRIPTION
91 This driver provides support for the Symbios/LSI Logic 53C8XX
92 PCI SCSI controllers.
93 .Pp
94 Driver features include support for wide SCSI busses and fast10, fast20,
95 fast40 and fast80-dt synchronous data transfers depending on controller
96 capabilities.
97 It also provides generic SCSI features such as tagged command
98 queueing and auto-request sense.
99 This driver is configured by default
100 for a maximum of 446 outstanding commands per bus, 8 LUNs per target
101 and 64 tagged tasks per LUN.
102 These numbers are not so much limited by design
103 as they are considered reasonable values for current SCSI technology.
104 These values can be increased by changing appropriate
105 constants in driver header files (not recommended).
106 .Pp
107 This driver supports the entire Symbios 53C8XX family of PCI SCSI
108 controllers.
109 It also offers the advantage of architectural improvements available
110 only with newer chips.
111 .Pp
112 .Nm
113 notably handles phase mismatch from SCRIPTS for the 53C896, 53C895A,
114 and 53C1010 cores.
115 As a result, it guarantees that no more than 1 interrupt
116 per IO completion is delivered to the CPU, and that the SCRIPTS processor
117 is never stalled waiting for CPU attention in normal situations.
118 .Pp
119 .Nm
120 also uses LOAD/STORE SCRIPTS instructions for chips that support it.
121 Only the early 810, 815 and 825 NCR chips do not support LOAD/STORE.
122 Use of LOAD/STORE instead of MEMORY MOVE allows SCRIPTS to access IO
123 registers internal to the chip (no external PCI cycles).
124 As a result, the driver guarantees that no PCI self-mastering will occur
125 for chips that support LOAD/STORE.
126 .Pp
127 LOAD/STORE instructions are also faster than MEMORY MOVE because
128 they do not involve the chip DMA FIFO and are coded on 2 DWORDs
129 instead of 3.
130 .Pp
131 For the early NCR 810, 815 and 825 chips, the driver uses a separate
132 SCRIPTS set that uses MEMORY MOVE instructions for data movements.
133 This is because LOAD/STORE are not supported by these chips.
134 .Pp
135 HVD/LVD capable controllers (895, 895A, 896, and 897) report
136 the actual bus mode in the STEST4 chip IO registers.
137 This feature
138 allows the driver to safely probe against bus mode and to set up the chip
139 accordingly.
140 By default the driver only supports HVD for these chips.
141 For other chips that can support HVD but not LVD, the driver has to probe
142 implementation dependent registers (GPIO) in order to detect HVD bus mode.
143 Only HVD implementations that conform with Symbios Logic recommendations can
144 be detected by the driver.
145 When the
146 .Ar SYM_SETUP_SCSI_DIFF
147 kernel option is assigned
148 a value of 1, the driver will also probe against HVD for 825a, 875, 876 and
149 885 chips, assuming Symbios Logic compatible implementation of HVD.
150 .Pp
151 When the
152 .Ar SYM_SETUP_PCI_PARITY
153 is assigned a value of 0, the
154 driver will not enable PCI parity checking for 53C8XX devices.
155 PCI parity
156 checking should not be an option for PCI SCSI controllers, but some
157 systems have been reported to fail using 53C8XX chips, due to spurious or
158 permanent PCI parity errors detected.
159 This option is supplied for
160 convenience but it is neither recommended nor supported.
161 .Pp
162 The generic
163 .Xr ncr 4
164 driver also supports SYM53C8XX based PCI SCSI controllers,
165 except for the SYM53C1010, which is only supported by the
166 .Nm
167 driver.
168 .Pp
169 By default, when both the
170 .Xr ncr 4
171 and
172 .Nm
173 drivers are configured, the
174 .Nm
175 driver takes precedence over the
176 .Xr ncr 4
177 driver.
178 The user can indicate a balancing of chip types between the two drivers
179 by defining the
180 .Ar SYM_SETUP_LP_PROBE_MAP
181 kernel configuration option as follows:
182 .Bl -column "0x40"
183 .It Em "Bit Devices to be attached by ncr instead"
184 .It "0x01 53C810a, 53C860"
185 .It "0x02 53C825a, 53C875, 53C876, 53C885, 53C895"
186 .It "0x04 53C895a, 53C896, 53C897, 53C1510d"
187 .It "0x40 53C810, 53C815, 53C825"
188 .El
189 .Pp
190 For example, if
191 .Ar SYM_SETUP_LP_PROBE_MAP
192 is supplied with the value 0x41, the
193 .Xr ncr 4
194 driver will attach to 53C810, 53C815, 53C825, 53C810a, and 53C860 based
195 controllers,
196 and the
197 .Nm
198 driver will attach to all other 53C8XX based controllers.
199 .Pp
200 When only the
201 .Nm
202 driver is configured, the
203 .Ar SYM_SETUP_LP_PROBE_MAP
204 option has no effect.
205 Thus, in this case, the
206 .Nm
207 driver will attach all 53C8XX based controllers present in the system.
208 .Pp
209 This driver offers other options
210 that are not currently exported to the user.
211 They are defined and documented in the
212 .Pa sym_conf.h
213 driver file.
214 Changing these options is not recommended unless absolutely necessary.
215 Some of these
216 options are planned to be exported through
217 .Xr sysctl 3
218 or an equivalent mechanism
219 in a future driver releases and therefore,
220 no compatibility is guaranteed.
221 .Pp
222 At initialization, the driver tries to detect and read user settings from
223 controller NVRAM.
224 The Symbios/Logic NVRAM layout and the Tekram NVRAM
225 layout are currently supported.
226 If the reading of the NVRAM succeeds, the
227 following settings are taken into account and reported to CAM:
228 .Pp
229 .Bl -column "SCSI parity checking" "Symbios"
230 .It Em "Host settings Symbios Tekram"
231 .It "SCSI parity checking Y N"
232 .It "Host SCSI ident Y Y"
233 .It "Verbose messages Y N"
234 .It "Scan targets hi-lo Y N"
235 .It "Avoid SCSI bus reset Y N"
236 .El
237 .Bl -column "Synchronous period" "Symbios"
238 .It Em "Device settings Symbios Tekram"
239 .It "Synchronous period Y Y"
240 .It "SCSI bus width Y Y"
241 .It "Queue tag enable Y Y"
242 .It "Number of tags NA Y"
243 .It "Disconnect enable Y Y"
244 .It "Scan at boot time Y N"
245 .It "Scan LUN Y N"
246 .El
247 .Pp
248 Devices that are configured as disabled for 'scan' in the NVRAM are not
249 reported to CAM at system start-up.
250 They can be discovered later using
251 the
252 .Ql camcontrol rescan
253 command.
254 .Pp
255 The table below summarizes the main features and capabilities of the
256 NCR/Symbios/LSI Logic 53C8XX family of PCI SCSI controllers.
257 .Pp
258 .Bl -column sym53c1510d "80MHz" "Width" "SRAM" "PCI64"
259 .It Em "Chip Sync Width SRAM PCI64 Supported"
260 .It "sym53c810 10MHz 8Bit N N Y"
261 .It "sym53c810a 10MHz 8Bit N N Y"
262 .It "sym53c815 10MHz 8Bit N N Y"
263 .It "sym53c825 10MHz 16Bit N N Y"
264 .It "sym53c825a 10MHz 16Bit 4KB N Y"
265 .It "sym53c860 20MHz 8Bit N N Y"
266 .It "sym53c875 20MHz 16Bit 4KB N Y"
267 .It "sym53c876 20MHz 16Bit 4KB N Y"
268 .It "sym53c885 20MHz 16Bit 4KB N Y"
269 .It "sym53c895 40MHz 16Bit 4KB N Y"
270 .It "sym53c895A 40MHz 16Bit 8KB N Y"
271 .It "sym53c896 40MHz 16Bit 8KB Y Y"
272 .It "sym53c897 40MHz 16Bit 8KB Y Y"
273 .It "sym53c1510D 40MHz 16Bit 4KB Y Y"
274 .It "sym53c1010 80MHz 16Bit 8KB Y Y"
275 .El
276 .Sh HARDWARE
277 The
278 .Nm
279 driver provides support for the following Symbios/LSI Logic PCI SCSI
280 controllers:
281 .Pp
282 .Bl -bullet -compact
283 .It
284 .Tn 53C810
285 .It
286 .Tn 53C810A
287 .It
288 .Tn 53C815
289 .It
290 .Tn 53C825
291 .It
292 .Tn 53C825A
293 .It
294 .Tn 53C860
295 .It
296 .Tn 53C875
297 .It
298 .Tn 53C876
299 .It
300 .Tn 53C895
301 .It
302 .Tn 53C895A
303 .It
304 .Tn 53C896
305 .It
306 .Tn 53C897
307 .It
308 .Tn 53C1000
309 .It
310 .Tn 53C1000R
311 .It
312 .Tn 53C1010-33
313 .It
314 .Tn 53C1010-66
315 .It
316 .Tn 53C1510D
317 .El
318 .Pp
319 The SCSI controllers supported by
320 .Nm
321 can be either embedded on a motherboard, or on
322 one of the following add-on boards:
323 .Pp
324 .Bl -bullet -compact
325 .It
326 ASUS SC-200, SC-896
327 .It
328 Data Technology DTC3130 (all variants)
329 .It
330 DawiControl DC2976UW
331 .It
332 Diamond FirePort (all)
333 .It
334 I-O DATA SC-UPCI (PC-98)
335 .It
336 Logitec LHA-521UA (PC-98)
337 .It
338 NCR cards (all)
339 .It
340 Symbios cards (all)
341 .It
342 Tekram DC390W, 390U, 390F, 390U2B, 390U2W, 390U3D, and 390U3W
343 .It
344 Tyan S1365
345 .El
346 .Sh MISC
347 The DEC KZPCA-AA is a rebadged SYM8952U.
348 .Sh SEE ALSO
349 .Xr cd 4 ,
350 .Xr da 4 ,
351 .Xr ncr 4 ,
352 .Xr sa 4 ,
353 .Xr scsi 4 ,
354 .Xr camcontrol 8
355 .Sh HISTORY
356 The
357 .Nm
358 driver appeared in
359 .Fx 4.0 .
360 .Sh AUTHORS
361 .An -nosplit
362 The
363 .Nm
364 driver was written by
365 .An Gerard Roudier
366 and is derived from the
367 Linux sym53c8xx driver from the same author.
368 The sym53c8xx driver is derived from the ncr53c8xx driver,
369 which was ported from the
370 .Fx
371 .Xr ncr 4
372 driver to Linux-1.2.13.
373 The original
374 .Xr ncr 4
375 driver was written for
376 .Bx 386
377 and
378 .Fx
379 by
380 .An Wolfgang Stanglmeier
381 and
382 .An Stefan Esser .
383 .Sh BUGS
384 No known bugs.