share/man/man4/sym.4

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