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 162The generic 163.Xr ncr 4 164driver also supports SYM53C8XX based PCI SCSI controllers, 165except for the SYM53C1010, which is only supported by the 166.Nm 167driver. 168.Pp 169By default, when both the 170.Xr ncr 4 171and 172.Nm 173drivers are configured, the 174.Nm 175driver takes precedence over the 176.Xr ncr 4 177driver. 178The user can indicate a balancing of chip types between the two drivers 179by defining the 180.Ar SYM_SETUP_LP_PROBE_MAP 181kernel 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 190For example, if 191.Ar SYM_SETUP_LP_PROBE_MAP 192is supplied with the value 0x41, the 193.Xr ncr 4 194driver will attach to 53C810, 53C815, 53C825, 53C810a, and 53C860 based 195controllers, 196and the 197.Nm 198driver will attach to all other 53C8XX based controllers. 199.Pp 200When only the 201.Nm 202driver is configured, the 203.Ar SYM_SETUP_LP_PROBE_MAP 204option has no effect. 205Thus, in this case, the 206.Nm 207driver will attach all 53C8XX based controllers present in the system. 208.Pp 209This driver offers other options 210that are not currently exported to the user. 211They are defined and documented in the 212.Pa sym_conf.h 213driver file. 214Changing these options is not recommended unless absolutely necessary. 215Some of these 216options are planned to be exported through 217.Xr sysctl 3 218or an equivalent mechanism 219in a future driver releases and therefore, 220no compatibility is guaranteed. 221.Pp 222At initialization, the driver tries to detect and read user settings from 223controller NVRAM. 224The Symbios/Logic NVRAM layout and the Tekram NVRAM 225layout are currently supported. 226If the reading of the NVRAM succeeds, the 227following settings are taken into account and reported to CAM: 228.Bl -column "SCSI parity checking" "Symbios" 229.It Em "Host settings Symbios Tekram" 230.It "SCSI parity checking Y N" 231.It "Host SCSI ident Y Y" 232.It "Verbose messages Y N" 233.It "Scan targets hi-lo Y N" 234.It "Avoid SCSI bus reset Y N" 235.El 236.Bl -column "Synchronous period" "Symbios" 237.It Em "Device settings Symbios Tekram" 238.It "Synchronous period Y Y" 239.It "SCSI bus width Y Y" 240.It "Queue tag enable Y Y" 241.It "Number of tags NA Y" 242.It "Disconnect enable Y Y" 243.It "Scan at boot time Y N" 244.It "Scan LUN Y N" 245.El 246.Pp 247Devices that are configured as disabled for 'scan' in the NVRAM are not 248reported to CAM at system start-up. 249They can be discovered later using 250the 251.Ql camcontrol rescan 252command. 253.Pp 254The table below summarizes the main features and capabilities of the 255NCR/Symbios/LSI Logic 53C8XX family of PCI SCSI controllers. 256.Bl -column sym53c1510d "80MHz" "Width" "SRAM" "PCI64" 257.It Em "Chip Sync Width SRAM PCI64 Supported" 258.It "sym53c810 10MHz 8Bit N N Y" 259.It "sym53c810a 10MHz 8Bit N N Y" 260.It "sym53c815 10MHz 8Bit N N Y" 261.It "sym53c825 10MHz 16Bit N N Y" 262.It "sym53c825a 10MHz 16Bit 4KB N Y" 263.It "sym53c860 20MHz 8Bit N N Y" 264.It "sym53c875 20MHz 16Bit 4KB N Y" 265.It "sym53c876 20MHz 16Bit 4KB N Y" 266.It "sym53c885 20MHz 16Bit 4KB N Y" 267.It "sym53c895 40MHz 16Bit 4KB N Y" 268.It "sym53c895A 40MHz 16Bit 8KB N Y" 269.It "sym53c896 40MHz 16Bit 8KB Y Y" 270.It "sym53c897 40MHz 16Bit 8KB Y Y" 271.It "sym53c1510D 40MHz 16Bit 4KB Y Y" 272.It "sym53c1010 80MHz 16Bit 8KB Y Y" 273.El 274.Sh HARDWARE 275The 276.Nm 277driver provides support for the following Symbios/LSI Logic PCI SCSI 278controllers: 279.Pp 280.Bl -bullet -compact 281.It 282.Tn 53C810 283.It 284.Tn 53C810A 285.It 286.Tn 53C815 287.It 288.Tn 53C825 289.It 290.Tn 53C825A 291.It 292.Tn 53C860 293.It 294.Tn 53C875 295.It 296.Tn 53C876 297.It 298.Tn 53C895 299.It 300.Tn 53C895A 301.It 302.Tn 53C896 303.It 304.Tn 53C897 305.It 306.Tn 53C1000 307.It 308.Tn 53C1000R 309.It 310.Tn 53C1010-33 311.It 312.Tn 53C1010-66 313.It 314.Tn 53C1510D 315.El 316.Pp 317The SCSI controllers supported by 318.Nm 319can be either embedded on a motherboard, or on 320one of the following add-on boards: 321.Pp 322.Bl -bullet -compact 323.It 324ASUS SC-200, SC-896 325.It 326Data Technology DTC3130 (all variants) 327.It 328DawiControl DC2976UW 329.It 330Diamond FirePort (all) 331.It 332I-O DATA SC-UPCI (PC-98) 333.It 334Logitec LHA-521UA (PC-98) 335.It 336NCR cards (all) 337.It 338Symbios cards (all) 339.It 340Tekram DC390W, 390U, 390F, 390U2B, 390U2W, 390U3D, and 390U3W 341.It 342Tyan S1365 343.El 344.Sh MISC 345The DEC KZPCA-AA is a rebadged SYM8952U. 346.Sh SEE ALSO 347.Xr cd 4 , 348.Xr da 4 , 349.Xr ncr 4 , 350.Xr sa 4 , 351.Xr scsi 4 , 352.Xr camcontrol 8 353.Sh HISTORY 354The 355.Nm 356driver appeared in 357.Fx 4.0 . 358.Sh AUTHORS 359.An -nosplit 360The 361.Nm 362driver was written by 363.An Gerard Roudier 364and is derived from the 365Linux sym53c8xx driver from the same author. 366The sym53c8xx driver is derived from the ncr53c8xx driver, 367which was ported from the 368.Fx 369.Xr ncr 4 370driver to Linux-1.2.13. 371The original 372.Xr ncr 4 373driver was written for 374.Bx 386 375and 376.Fx 377by 378.An Wolfgang Stanglmeier 379and 380.An Stefan Esser . 381.Sh BUGS 382No known bugs. 383