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 January 12, 2000 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 66For any number of cards: 67.Cd device sym 68.Pp 69To disable PCI parity checking (needed for broken bridges) 70.Cd options SYM_SETUP_PCI_PARITY=<boolean> 71.Pp 72To control driver probing against HVD buses 73.Cd options SYM_SETUP_SCSI_DIFF=<bit combination> 74.Pp 75To control chip attachment balancing between the ncr driver and this driver 76.Cd options SYM_SETUP_LP_PROBE_MAP=<bit combination> 77.Sh DESCRIPTION 78This driver provides support for the Symbios/LSI Logic 79.Tn 53C810 , 80.Tn 53C815 , 81.Tn 53C825 , 82.Tn 53C810A , 83.Tn 53C825A , 84.Tn 53C860 , 85.Tn 53C875 , 86.Tn 53C876 , 87.Tn 53C895 , 88.Tn 53C895A , 89.Tn 53C896 , 90.Tn 53C897 , 91.Tn 53C1510D , 92and 93.Tn 53C1010 94PCI SCSI controllers. 95.Pp 96Driver features include support for wide SCSI busses and fast10, fast20, 97fast40 and fast80-dt synchronous data transfers depending on controller 98capabilities. 99It also provides generic SCSI features such as tagged command 100queueing and auto-request sense. 101This driver is configured by default 102for a maximum of 446 outstanding commands per bus, 8 LUNs per target 103and 64 tagged tasks per LUN. 104These numbers are not so much limited by design 105as they are considered reasonable values for current SCSI technology. 106These values can be increased by changing appropriate 107constants in driver header files (not recommended). 108.Pp 109This driver supports the entire Symbios 53C8XX family of PCI SCSI 110controllers. 111It also offers the advantage of architectural improvements available 112only with newer chips. 113.Pp 114.Nm 115notably handles phase mismatch from SCRIPTS for the 53C896, 53C895A, 116and 53C1010 cores. 117As a result, it guarantees that no more than 1 interrupt 118per IO completion is delivered to the CPU, and that the SCRIPTS processor 119is never stalled waiting for CPU attention in normal situations. 120.Pp 121.Nm 122also uses LOAD/STORE SCRIPTS instructions for chips that support it. 123Only the early 810, 815 and 825 NCR chips do not support LOAD/STORE. 124Use of LOAD/STORE instead of MEMORY MOVE allows SCRIPTS to access IO 125registers internal to the chip (no external PCI cycles). 126As a result, the driver guarantees that no PCI self-mastering will occur 127for chips that support LOAD/STORE. 128.Pp 129LOAD/STORE instructions are also faster than MEMORY MOVE because 130they do not involve the chip DMA FIFO and are coded on 2 DWORDs 131instead of 3. 132.Pp 133For the early NCR 810, 815 and 825 chips, the driver uses a separate 134SCRIPTS set that uses MEMORY MOVE instructions for data movements. 135This is because LOAD/STORE are not supported by these chips. 136.Pp 137HVD/LVD capable controllers (895, 895A, 896, and 897) report 138the actual bus mode in the STEST4 chip IO registers. 139This feature 140allows the driver to safely probe against bus mode and to set up the chip 141accordingly. 142By default the driver only supports HVD for these chips. 143For other chips that can support HVD but not LVD, the driver has to probe 144implementation dependent registers (GPIO) in order to detect HVD bus mode. 145Only HVD implementations that conform with Symbios Logic recommendations can 146be detected by the driver. 147When the 148.Ar SYM_SETUP_SCSI_DIFF 149kernel option is assigned 150a value of 1, the driver will also probe against HVD for 825a, 875, 876 and 151885 chips, assuming Symbios Logic compatible implementation of HVD. 152.Pp 153When the 154.Ar SYM_SETUP_PCI_PARITY 155is assigned a value of 0, the 156driver will not enable PCI parity checking for 53C8XX devices. 157PCI parity 158checking should not be an option for PCI SCSI controllers, but some 159systems have been reported to fail using 53C8XX chips, due to spurious or 160permanent PCI parity errors detected. 161This option is supplied for 162convenience but it is neither recommended nor supported. 163.Pp 164The generic 165.Xr ncr 4 166driver also supports SYM53C8XX based PCI SCSI controllers, 167except for the SYM53C1010, which is only supported by the 168.Nm 169driver. 170.Pp 171By default, when both the 172.Xr ncr 4 173and 174.Nm 175drivers are configured, the 176.Nm 177driver takes precedence over the 178.Xr ncr 4 179driver. 180The user can indicate a balancing of chip types between the two drivers 181by defining the 182.Ar SYM_SETUP_LP_PROBE_MAP 183kernel configuration option as follows: 184.Bl -column "0x40" 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" 190.El 191.Pp 192For example, if 193.Ar SYM_SETUP_LP_PROBE_MAP 194is supplied with the value 0x41, the 195.Xr ncr 4 196driver will attach to 53C810, 53C815, 53C825, 53C810a, and 53C860 based 197controllers, 198and the 199.Nm 200driver will attach to all other 53C8XX based controllers. 201.Pp 202When only the 203.Nm 204driver is configured, the 205.Ar SYM_SETUP_LP_PROBE_MAP 206option has no effect. 207Thus, in this case, the 208.Nm 209driver will attach all 53C8XX based controllers present in the system. 210.Pp 211This driver offers other options 212that are not currently exported to the user. 213They are defined and documented in the 214.Pa sym_conf.h 215driver file. 216Changing these options is not recommended unless absolutely necessary. 217Some of these 218options are planned to be exported through 219.Xr sysctl 3 220or an equivalent mechanism 221in a future driver releases and therefore, 222no compatibility is guaranteed. 223.Pp 224At initialization, the driver tries to detect and read user settings from 225controller NVRAM. 226The Symbios/Logic NVRAM layout and the Tekram NVRAM 227layout are currently supported. 228If the reading of the NVRAM succeeds, the 229following settings are taken into account and reported to CAM: 230.Pp 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" 238.El 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" 247.It "Scan LUN Y N" 248.El 249.Pp 250Devices that are configured as disabled for 'scan' in the NVRAM are not 251reported to CAM at system start-up. 252They can be discovered later using 253the 254.Ql camcontrol rescan 255command. 256.Pp 257The table below summarizes the main features and capabilities of the 258NCR/Symbios/LSI Logic 53C8XX family of PCI SCSI controllers. 259.Pp 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" 277.El 278.Sh MISC 279The DEC KZPCA-AA is a rebadged SYM8952U. 280.Sh BUGS 281No known bugs. 282.Sh SEE ALSO 283.Xr cd 4 , 284.Xr da 4 , 285.Xr ncr 4 , 286.Xr sa 4 , 287.Xr scsi 4 , 288.Xr camcontrol 8 289.Sh AUTHORS 290.An -nosplit 291The 292.Nm 293driver was written by 294.An Gerard Roudier 295and is derived from the 296Linux sym53c8xx driver from the same author. 297The sym53c8xx driver is derived from the ncr53c8xx driver, 298which was ported from the 299.Fx 300.Xr ncr 4 301driver to Linux-1.2.13. 302The original 303.Xr ncr 4 304driver was written for 305.Bx 386 306and 307.Fx 308by 309.An Wolfgang Stanglmeier 310and 311.An Stefan Esser . 312.Sh HISTORY 313The 314.Nm 315driver appeared in 316.Fx 4.0 . 317