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