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