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