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