2 .\" Device driver optimized for the Symbios/LSI 53C896/53C895A/53C1010
3 .\" PCI SCSI controllers.
5 .\" Copyright (C) 1999-2000 Gerard Roudier <groudier@club-internet.fr>
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.
12 .\" This driver for FreeBSD-CAM is derived from the Linux sym53c8xx driver.
13 .\" Copyright (C) 1998-1999 Gerard Roudier
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.
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
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.
27 .\" Other major contributions:
29 .\" NVRAM detection and reading.
30 .\" Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
32 .\" ----------------------------------------------------------------------------
34 .\" Redistribution and use in source and binary forms, with or without
35 .\" modification, are permitted provided that the following conditions
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.
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
64 .Nd NCR/Symbios/LSI Logic 53C8XX PCI SCSI host adapter driver
66 For any number of cards:
69 To disable PCI parity checking (needed for broken bridges)
70 .Cd options SYM_SETUP_PCI_PARITY=<boolean>
72 To control driver probing against HVD buses
73 .Cd options SYM_SETUP_SCSI_DIFF=<bit combination>
75 To control chip attachment balancing between the ncr driver and this driver
76 .Cd options SYM_SETUP_LP_PROBE_MAP=<bit combination>
78 This driver provides support for the Symbios/LSI Logic
96 Driver features include support for wide SCSI busses and fast10, fast20,
97 fast40 and fast80-dt synchronous data transfers depending on controller
99 It also provides generic SCSI features such as tagged command
100 queuing and auto-request sense.
101 This driver is configured by default
102 for a maximum of 446 outstanding commands per bus, 8 LUNs per target
103 and 64 tagged tasks per LUN.
104 These numbers are not so much limited by design
105 as they are considered reasonable values for current SCSI technology.
106 These values can be increased by changing appropriate
107 constants in driver header files (not recommended).
109 This driver supports the entire Symbios 53C8XX family of PCI SCSI
111 It also offers the advantage of architectural improvements available
112 only with newer chips.
115 notably handles phase mismatch from SCRIPTS for the 53C896, 53C895A,
117 As a result, it guarantees that no more than 1 interrupt
118 per IO completion is delivered to the CPU, and that the SCRIPTS processor
119 is never stalled waiting for CPU attention in normal situations.
122 also uses LOAD/STORE SCRIPTS instructions for chips that support it.
123 Only the early 810, 815 and 825 NCR chips do not support LOAD/STORE.
124 Use of LOAD/STORE instead of MEMORY MOVE allows SCRIPTS to access IO
125 registers internal to the chip (no external PCI cycles).
126 As a result, the driver guarantees that no PCI self-mastering will occur
127 for chips that support LOAD/STORE.
129 LOAD/STORE instructions are also faster than MEMORY MOVE because
130 they do not involve the chip DMA FIFO and are coded on 2 DWORDs
133 For the early NCR 810, 815 and 825 chips, the driver uses a separate
134 SCRIPTS set that uses MEMORY MOVE instructions for data movements.
135 This is because LOAD/STORE are not supported by these chips.
137 HVD/LVD capable controllers (895, 895A, 896, and 897) report
138 the actual bus mode in the STEST4 chip IO registers.
140 allows the driver to safely probe against bus mode and to set up the chip
142 By default the driver only supports HVD for these chips.
143 For other chips that can support HVD but not LVD, the driver has to probe
144 implementation dependent registers (GPIO) in order to detect HVD bus mode.
145 Only HVD implementations that conform with Symbios Logic recommendations can
146 be detected by the driver.
148 .Ar SYM_SETUP_SCSI_DIFF
149 kernel option is assigned
150 a value of 1, the driver will also probe against HVD for 825a, 875, 876 and
151 885 chips, assuming Symbios Logic compatible implementation of HVD.
154 .Ar SYM_SETUP_PCI_PARITY
155 is assigned a value of 0, the
156 driver will not enable PCI parity checking for 53C8XX devices.
158 checking should not be an option for PCI SCSI controllers, but some
159 systems have been reported to fail using 53C8XX chips, due to spurious or
160 permanent PCI parity errors detected.
161 This option is supplied for
162 convenience but it is neither recommended nor supported.
166 driver also supports SYM53C8XX based PCI SCSI controllers,
167 except for the SYM53C1010, which is only supported by the
171 By default, when both the
175 drivers are configured, the
177 driver takes precedence over the
180 The user can indicate a balancing of chip types between the two drivers
182 .Ar SYM_SETUP_LP_PROBE_MAP
183 kernel configuration option as follows:
185 .It Em "Bit Devices to be attached by ncr instead"
186 .It "0x01 53C810a, 53C860"
187 .It "0x02 53C825a, 53C875, 53C876, 53C885, 53C895"
188 .It "0x04 53C895a, 53C896, 53C897, 53C1510d"
189 .It "0x40 53C810, 53C815, 53C825"
193 .Ar SYM_SETUP_LP_PROBE_MAP
194 is supplied with the value 0x41, the
196 driver will attach to 53C810, 53C815, 53C825, 53C810a, and 53C860 based
200 driver will attach to all other 53C8XX based controllers.
204 driver is configured, the
205 .Ar SYM_SETUP_LP_PROBE_MAP
206 option has no effect.
207 Thus, in this case, the
209 driver will attach all 53C8XX based controllers present in the system.
211 This driver offers other options
212 that are not currently exported to the user.
213 They are defined and documented in the
216 Changing these options is not recommended unless absolutely necessary.
218 options are planned to be exported through
220 or an equivalent mechanism
221 in a future driver releases and therefore,
222 no compatibility is guaranteed.
224 At initialization, the driver tries to detect and read user settings from
226 The Symbios/Logic NVRAM layout and the Tekram NVRAM
227 layout are currently supported.
228 If the reading of the NVRAM succeeds, the
229 following settings are taken into account and reported to CAM:
231 .Bl -column "SCSI parity checking" "Symbios"
232 .It Em "Host settings Symbios Tekram"
233 .It "SCSI parity checking Y N"
234 .It "Host SCSI ident Y Y"
235 .It "Verbose messages Y N"
236 .It "Scan targets hi-lo Y N"
237 .It "Avoid SCSI bus reset Y N"
239 .Bl -column "Synchronous period" "Symbios"
240 .It Em "Device settings Symbios Tekram"
241 .It "Synchronous period Y Y"
242 .It "SCSI bus width Y Y"
243 .It "Queue tag enable Y Y"
244 .It "Number of tags NA Y"
245 .It "Disconnect enable Y Y"
246 .It "Scan at boot time Y N"
250 Devices that are configured as disabled for 'scan' in the NVRAM are not
251 reported to CAM at system start-up.
252 They can be discovered later using
254 .Ql camcontrol rescan
257 The table below summarizes the main features and capabilities of the
258 NCR/Symbios/LSI Logic 53C8XX family of PCI SCSI controllers.
260 .Bl -column sym53c1510d "80MHz" "Width" "SRAM" "PCI64"
261 .It Em "Chip Sync Width SRAM PCI64 Supported"
262 .It "sym53c810 10MHz 8Bit N N Y"
263 .It "sym53c810a 10MHz 8Bit N N Y"
264 .It "sym53c815 10MHz 8Bit N N Y"
265 .It "sym53c825 10MHz 16Bit N N Y"
266 .It "sym53c825a 10MHz 16Bit 4KB N Y"
267 .It "sym53c860 20MHz 8Bit N N Y"
268 .It "sym53c875 20MHz 16Bit 4KB N Y"
269 .It "sym53c876 20MHz 16Bit 4KB N Y"
270 .It "sym53c885 20MHz 16Bit 4KB N Y"
271 .It "sym53c895 40MHz 16Bit 4KB N Y"
272 .It "sym53c895A 40MHz 16Bit 8KB N Y"
273 .It "sym53c896 40MHz 16Bit 8KB Y Y"
274 .It "sym53c897 40MHz 16Bit 8KB Y Y"
275 .It "sym53c1510D 40MHz 16Bit 4KB Y Y"
276 .It "sym53c1010 80MHz 16Bit 8KB Y Y"
291 driver was written by
293 and is derived from the
294 Linux sym53c8xx driver from the same author.
295 The sym53c8xx driver is derived from the ncr53c8xx driver,
296 which was ported from the
299 driver to Linux-1.2.13.
302 driver was written for 386BSD and
305 .An Wolfgang Stanglmeier