share/man/man4/scsi.4

   1 .\" Copyright (c) 1996
   2 .\"     Julian Elischer <julian@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\"
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .Dd October 15, 1998
  28 .Dt SCSI 4
  29 .Os
  30 .Sh NAME
  31 .Nm SCSI ,
  32 .Nm CAM
  33 .Nd CAM SCSI subsystem
  34 .Sh SYNOPSIS
  35 .Cd "device scbus"
  36 .Cd "device cd"
  37 .Cd "device ch"
  38 .Cd "device da"
  39 .Cd "device pass"
  40 .Cd "device pt"
  41 .Cd "device sa"
  42 .Cd "options CAMDEBUG"
  43 .Cd "options CAM_DEBUG_BUS=-1"
  44 .Cd "options CAM_DEBUG_TARGET=-1"
  45 .Cd "options CAM_DEBUG_LUN=-1"
  46 .Cd "options CAM_DEBUG_FLAGS=CAM_DEBUG_INFO|CAM_DEBUG_CDB"
  47 .Cd "options CAM_MAX_HIGHPOWER=4"
  48 .Cd "options SCSI_NO_SENSE_STRINGS"
  49 .Cd "options SCSI_NO_OP_STRINGS"
  50 .Cd "options SCSI_DELAY=8000"
  51 .Sh DESCRIPTION
  52 The CAM
  53 .Tn SCSI
  54 subsystem provides a uniform and modular system for the implementation
  55 of drivers to control various
  56 .Tn SCSI
  57 devices, and to utilize different
  58 .Tn SCSI
  59 host adapters through host adapter drivers.
  60 When the system probes the
  61 .Tn SCSI
  62 busses, it attaches any devices it finds to the appropriate
  63 drivers.
  64 The
  65 .Xr pass 4
  66 driver, if it is configured in the kernel, will attach to all
  67 .Tn SCSI
  68 devices.
  69 .Sh KERNEL CONFIGURATION
  70 There are a number of generic kernel configuration options for the
  71 CAM
  72 .Tn SCSI
  73 subsystem:
  74 .Bl -tag -width SCSI_NO_SENSE_STRINGS
  75 .It Dv CAMDEBUG
  76 This option enables the CAM debugging printf code.
  77 This will not actually
  78 cause any debugging information to be printed out when included by itself.
  79 Enabling printouts requires additional configuration.
  80 See below for details.
  81 .It Dv "CAM_MAX_HIGHPOWER=4"
  82 This sets the maximum allowable number of concurrent "high power" commands.
  83 A "high power" command is a command that takes more electrical power than
  84 most to complete.
  85 An example of this (and the only command currently
  86 tagged as "high power") is the
  87 .Tn SCSI
  88 START UNIT command.
  89 Starting a SCSI disk often takes significantly more
  90 electrical power than normal operation of the disk.
  91 This option allows the
  92 user to specify how many concurrent high power commands may be outstanding
  93 without overloading the power supply on his computer.
  94 .It Dv SCSI_NO_SENSE_STRINGS
  95 This eliminates text descriptions of each
  96 .Tn SCSI
  97 Additional Sense Code and Additional Sense Code Qualifier pair.
  98 Since this
  99 is a fairly large text database, eliminating it reduces the size of the
 100 kernel somewhat.
 101 This is primarily necessary for boot floppies and other
 102 low disk space or low memory space environments.
 103 In most cases, though,
 104 this should be enabled, since it speeds the interpretation of
 105 .Tn SCSI
 106 error messages.
 107 Do not let the "kernel bloat" zealots get to you -- leave
 108 the sense descriptions in your kernel!
 109 .It Dv SCSI_NO_OP_STRINGS
 110 This disables text descriptions of each
 111 .Tn SCSI
 112 opcode.
 113 This option, like the sense string option above, is primarily
 114 useful for environments like a boot floppy where kernel size is critical.
 115 Enabling this option for normal use is not recommended, since it slows
 116 debugging of
 117 .Tn SCSI
 118 problems.
 119 .It Dv SCSI_DELAY=8000
 120 This is the
 121 .Tn SCSI
 122 "bus settle delay."
 123 In CAM, it is specified in
 124 .Em milliseconds ,
 125 not seconds like the old
 126 .Tn SCSI
 127 layer used to do.
 128 When the kernel boots, it sends a bus reset to each
 129 .Tn SCSI
 130 bus to tell each device to reset itself to a default set of transfer
 131 negotiations and other settings.
 132 Most
 133 .Tn SCSI
 134 devices need some amount of time to recover from a bus reset.
 135 Newer disks
 136 may need as little as 100ms, while old, slow devices may need much longer.
 137 If the
 138 .Dv SCSI_DELAY
 139 is not specified, it defaults to 2 seconds.
 140 The minimum allowable value for
 141 .Dv SCSI_DELAY
 142 is "100", or 100ms.
 143 One special case is that if the
 144 .Dv SCSI_DELAY
 145 is set to 0, that will be taken to mean the "lowest possible value."
 146 In that case, the
 147 .Dv SCSI_DELAY
 148 will be reset to 100ms.
 149 .El
 150 .Pp
 151 All devices and the SCSI busses support boot time allocation so that
 152 an upper number of devices and controllers does not need to be configured;
 153 .Cd "device da0"
 154 will suffice for any number of disk drivers.
 155 .Pp
 156 The devices are either
 157 .Em wired
 158 so they appear as a particular device unit or
 159 .Em counted
 160 so that they appear as the next available unused unit.
 161 .Pp
 162 Units are wired down by setting kernel environment hints.
 163 This is usually done either interactively from the
 164 .Xr loader 8 ,
 165 or automatically via the
 166 .Pa /boot/device.hints
 167 file.
 168 The basic syntax is:
 169 .Bd -literal -offset indent
 170 hint.device.unit.property="value"
 171 .Ed
 172 .Pp
 173 Individual
 174 .Nm
 175 bus numbers can be wired down to specific controllers with
 176 a config line similar to the following:
 177 .Bd -literal -offset indent
 178 hint.scbus.0.at="ahd1"
 179 .Ed
 180 .Pp
 181 This assigns
 182 .Nm
 183 bus number 0 to the
 184 .Em ahd1
 185 driver instance.
 186 For controllers supporting more than one bus, a particular bus can be assigned
 187 as follows:
 188 .Bd -literal -offset indent
 189 hint.scbus.0.at="ahc1"
 190 hint.scbus.0.bus="1"
 191 .Ed
 192 .Pp
 193 This assigns
 194 .Nm
 195 bus 0 to the bus 1 instance on
 196 .Em ahc0 .
 197 Peripheral drivers can be wired to a specific bus, target, and lun as so:
 198 .Bd -literal -offset indent
 199 hint.da.0.at="scbus0"
 200 hint.da.0.target="0"
 201 hint.da.0.unit="0"
 202 .Ed
 203 .Pp
 204 This assigns
 205 .Em da0
 206 to target 0, unit (lun) 0 of scbus 0.
 207 Omitting the target or unit hints will instruct CAM to treat them as wildcards
 208 and use the first respective counted instances.
 209 These examples can be combined together to allow a peripheral device to be
 210 wired to any particular controller, bus, target, and/or unit instance.
 211 .Pp
 212 When you have a mixture of wired down and counted devices then the
 213 counting begins with the first non-wired down unit for a particular
 214 type.
 215 That is, if you have a disk wired down as
 216 .Em "device da1" ,
 217 then the first non-wired disk shall come on line as
 218 .Em da2 .
 219 .Sh ADAPTERS
 220 The system allows common device drivers to work through many different
 221 types of adapters.
 222 The adapters take requests from the upper layers and do
 223 all IO between the
 224 .Em SCSI
 225 bus and the system.
 226 The maximum size of a transfer is governed by the
 227 adapter.
 228 Most adapters can transfer 64KB in a single operation, however
 229 many can transfer larger amounts.
 230 .Sh TARGET MODE
 231 Some adapters support
 232 .Em target mode
 233 in which the system is capable of operating as a device, responding to
 234 operations initiated by another system.
 235 Target mode is supported for
 236 some adapters, but is not yet complete for this version of the CAM
 237 .Tn SCSI
 238 subsystem.
 239 .Sh FILES
 240 see other
 241 .Nm
 242 device entries.
 243 .Sh DIAGNOSTICS
 244 When the kernel is compiled with options CAMDEBUG, an XPT_DEBUG CCB can be
 245 used to enable various amounts of tracing information on any
 246 specific device.
 247 Devices not being traced will not produce trace information.
 248 There are currently four debugging flags that may be turned on:
 249 .Bl -tag -width CAM_DEBUG_SUBTRACE
 250 .It Dv CAM_DEBUG_INFO
 251 This debugging flag enables general informational printfs for the device
 252 or devices in question.
 253 .It Dv CAM_DEBUG_TRACE
 254 This debugging flag enables function-level command flow tracing.
 255 i.e.\&
 256 kernel printfs will happen at the entrance and exit of various functions.
 257 .It Dv CAM_DEBUG_SUBTRACE
 258 This debugging flag enables debugging output internal to various functions.
 259 .It Dv CAM_DEBUG_CDB
 260 This debugging flag will cause the kernel to print out all
 261 .Tn SCSI
 262 commands sent to a particular device or devices.
 263 .El
 264 .Pp
 265 Some of these flags, most notably
 266 .Dv CAM_DEBUG_TRACE
 267 and
 268 .Dv CAM_DEBUG_SUBTRACE
 269 will produce kernel printfs in EXTREME numbers,
 270 and because of that, they are not especially useful.
 271 There are not many things logged at the
 272 .Dv CAM_DEBUG_INFO
 273 level, so it is not especially useful.
 274 The most useful debugging flag is the
 275 .Dv CAM_DEBUG_CDB
 276 flag.
 277 Users can enable debugging from their kernel config file, by using
 278 the following kernel config options:
 279 .Bl -tag -width CAM_DEBUG_TARGET
 280 .It Dv CAMDEBUG
 281 This enables CAM debugging.
 282 Without this option, users will not even be able
 283 to turn on debugging from userland via
 284 .Xr camcontrol 8 .
 285 .It Dv CAM_DEBUG_FLAGS
 286 This allows the user to set the various debugging flags described above
 287 in a kernel config file.
 288 Flags may be ORed together if the user wishes to
 289 see printfs for multiple debugging levels.
 290 .It Dv CAM_DEBUG_BUS
 291 Specify a bus to debug.
 292 To debug all busses, set this to -1.
 293 .It Dv CAM_DEBUG_TARGET
 294 Specify a target to debug.
 295 To debug all targets, set this to -1.
 296 .It Dv CAM_DEBUG_LUN
 297 Specify a lun to debug.
 298 To debug all luns, set this to -1.
 299 .El
 300 .Pp
 301 When specifying a bus, target or lun to debug, you
 302 .Em MUST
 303 specify all three bus/target/lun options above.
 304 Using wildcards, you
 305 should be able to enable debugging on most anything.
 306 .Pp
 307 Users may also enable debugging printfs on the fly, if the
 308 .Dv CAMDEBUG
 309 option is their config file, by using the
 310 .Xr camcontrol 8
 311 utility.
 312 See
 313 .Xr camcontrol 8
 314 for details.
 315 .Sh SEE ALSO
 316 .Xr aha 4 ,
 317 .Xr ahb 4 ,
 318 .Xr ahc 4 ,
 319 .Xr bt 4 ,
 320 .Xr cd 4 ,
 321 .Xr ch 4 ,
 322 .Xr da 4 ,
 323 .Xr pass 4 ,
 324 .Xr pt 4 ,
 325 .Xr sa 4 ,
 326 .Xr xpt 4 ,
 327 .Xr camcontrol 8
 328 .Sh HISTORY
 329 The CAM
 330 .Tn SCSI
 331 subsystem first appeared in
 332 .Fx 3.0 .
 333 .Sh AUTHORS
 334 .An -nosplit
 335 The CAM
 336 .Tn SCSI
 337 subsystem was written by
 338 .An Justin Gibbs
 339 and
 340 .An Kenneth Merry .