share/man/man4/ahc.4

   1 .\"
   2 .\" Copyright (c) 1995, 1996, 1997, 1998, 2000
   3 .\"     Justin T. Gibbs.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  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 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd February 15, 2017
  28 .Dt AHC 4
  29 .Os
  30 .Sh NAME
  31 .Nm ahc
  32 .Nd Adaptec VL/ISA/PCI SCSI host adapter driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device scbus"
  39 .Cd "device ahc"
  40 .Pp
  41 For one or more PCI cards:
  42 .Cd "device pci"
  43 .Pp
  44 To allow PCI adapters to use memory mapped I/O if enabled:
  45 .Cd options AHC_ALLOW_MEMIO
  46 .Pp
  47 To configure one or more controllers to assume the target role:
  48 .Cd options AHC_TMODE_ENABLE <bitmask of units>
  49 .Ed
  50 .Pp
  51 Alternatively, to load the driver as a
  52 module at boot time, place the following lines in
  53 .Xr loader.conf 5 :
  54 .Bd -literal -offset indent
  55 ahc_load="YES"
  56 ahc_isa_load="YES"
  57 ahc_pci_load="YES"
  58 .Ed
  59 .Sh DESCRIPTION
  60 This driver provides access to the
  61 .Tn SCSI
  62 bus(es) connected to the Adaptec AIC77xx and AIC78xx
  63 host adapter chips.
  64 .Pp
  65 Driver features include support for twin and wide busses,
  66 fast, ultra or ultra2 synchronous transfers depending on controller type,
  67 tagged queueing, SCB paging, and target mode.
  68 .Pp
  69 Memory mapped I/O can be enabled for PCI devices with the
  70 .Dq Dv AHC_ALLOW_MEMIO
  71 configuration option.
  72 Memory mapped I/O is more efficient than the alternative, programmed I/O.
  73 Most PCI BIOSes will map devices so that either technique for communicating
  74 with the card is available.
  75 In some cases,
  76 usually when the PCI device is sitting behind a PCI->PCI bridge,
  77 the BIOS may fail to properly initialize the chip for memory mapped I/O.
  78 The typical symptom of this problem is a system hang if memory mapped I/O
  79 is attempted.
  80 Most modern motherboards perform the initialization correctly and work fine
  81 with this option enabled.
  82 .Pp
  83 Individual controllers may be configured to operate in the target role
  84 through the
  85 .Dq Dv AHC_TMODE_ENABLE
  86 configuration option.
  87 The value assigned to this option should be a bitmap
  88 of all units where target mode is desired.
  89 For example, a value of 0x25, would enable target mode on units 0, 2, and 5.
  90 A value of 0x8a enables it for units 1, 3, and 7.
  91 .Pp
  92 Per target configuration performed in the
  93 .Tn SCSI-Select
  94 menu, accessible at boot
  95 is honored by this driver.
  96 This includes synchronous/asynchronous transfers,
  97 maximum synchronous negotiation rate,
  98 wide transfers,
  99 disconnection,
 100 the host adapter's SCSI ID.
 101 For systems that store non-volatile settings in a system specific manner
 102 rather than a serial eeprom directly connected to the aic7xxx controller,
 103 the
 104 .Tn BIOS
 105 must be enabled for the driver to access this information.
 106 This restriction applies to
 107 many chip-down motherboard configurations.
 108 .Pp
 109 Performance and feature sets vary throughout the aic7xxx product line.
 110 The following table provides a comparison of the different chips supported
 111 by the
 112 .Nm
 113 driver.
 114 Note that wide and twin channel features, although always supported
 115 by a particular chip, may be disabled in a particular motherboard or card
 116 design.
 117 .Bd -ragged -offset indent
 118 .Bl -column "aic7895CX" "MIPSX" "PCI/64X" "MaxSyncX" "MaxWidthX" "SCBsX" "2 3 4 5 6 7 8X"
 119 .It Em "Chip" Ta "MIPS" Ta "Bus" Ta "MaxSync" Ta "MaxWidth" Ta "SCBs" Ta "Features"
 120 .It "aic7770" Ta "10" Ta "VL" Ta "10MHz" Ta "16Bit" Ta "4" Ta "1"
 121 .It "aic7850" Ta "10" Ta "PCI/32" Ta "10MHz" Ta "8Bit" Ta "3" Ta ""
 122 .It "aic7860" Ta "10" Ta "PCI/32" Ta "20MHz" Ta "8Bit" Ta "3" Ta ""
 123 .It "aic7870" Ta "10" Ta "PCI/32" Ta "10MHz" Ta "16Bit" Ta "16" Ta ""
 124 .It "aic7880" Ta "10" Ta "PCI/32" Ta "20MHz" Ta "16Bit" Ta "16" Ta ""
 125 .It "aic7890" Ta "20" Ta "PCI/32" Ta "40MHz" Ta "16Bit" Ta "16" Ta "3 4 5 6 7 8"
 126 .It "aic7891" Ta "20" Ta "PCI/64" Ta "40MHz" Ta "16Bit" Ta "16" Ta "3 4 5 6 7 8"
 127 .It "aic7892" Ta "20" Ta "PCI/64" Ta "80MHz" Ta "16Bit" Ta "16" Ta "3 4 5 6 7 8"
 128 .It "aic7895" Ta "15" Ta "PCI/32" Ta "20MHz" Ta "16Bit" Ta "16" Ta "2 3 4 5"
 129 .It "aic7895C" Ta "15" Ta "PCI/32" Ta "20MHz" Ta "16Bit" Ta "16" Ta "2 3 4 5 8"
 130 .It "aic7896" Ta "20" Ta "PCI/32" Ta "40MHz" Ta "16Bit" Ta "16" Ta "2 3 4 5 6 7 8"
 131 .It "aic7897" Ta "20" Ta "PCI/64" Ta "40MHz" Ta "16Bit" Ta "16" Ta "2 3 4 5 6 7 8"
 132 .It "aic7899" Ta "20" Ta "PCI/64" Ta "80MHz" Ta "16Bit" Ta "16" Ta "2 3 4 5 6 7 8"
 133 .El
 134 .Pp
 135 .Bl -enum -compact
 136 .It
 137 Multiplexed Twin Channel Device - One controller servicing two busses.
 138 .It
 139 Multi-function Twin Channel Device - Two controllers on one chip.
 140 .It
 141 Command Channel Secondary DMA Engine - Allows scatter gather list and
 142 SCB prefetch.
 143 .It
 144 64 Byte SCB Support - SCSI CDB is embedded in the SCB to eliminate an extra DMA.
 145 .It
 146 Block Move Instruction Support - Doubles the speed of certain sequencer
 147 operations.
 148 .It
 149 .Sq Bayonet
 150 style Scatter Gather Engine - Improves S/G prefetch performance.
 151 .It
 152 Queuing Registers - Allows queueing of new transactions without pausing the
 153 sequencer.
 154 .It
 155 Multiple Target IDs - Allows the controller to respond to selection as a
 156 target on multiple SCSI IDs.
 157 .El
 158 .Ed
 159 .Sh HARDWARE
 160 The
 161 .Nm
 162 driver supports the following
 163 .Tn SCSI
 164 host adapter chips and
 165 .Tn SCSI
 166 controller cards:
 167 .Pp
 168 .Bl -bullet -compact
 169 .It
 170 Adaptec
 171 .Tn AIC7770
 172 host adapter chip
 173 .It
 174 Adaptec
 175 .Tn AIC7850
 176 host adapter chip
 177 .It
 178 Adaptec
 179 .Tn AIC7860
 180 host adapter chip
 181 .It
 182 Adaptec
 183 .Tn AIC7870
 184 host adapter chip
 185 .It
 186 Adaptec
 187 .Tn AIC7880
 188 host adapter chip
 189 .It
 190 Adaptec
 191 .Tn AIC7890
 192 host adapter chip
 193 .It
 194 Adaptec
 195 .Tn AIC7891
 196 host adapter chip
 197 .It
 198 Adaptec
 199 .Tn AIC7892
 200 host adapter chip
 201 .It
 202 Adaptec
 203 .Tn AIC7895
 204 host adapter chip
 205 .It
 206 Adaptec
 207 .Tn AIC7896
 208 host adapter chip
 209 .It
 210 Adaptec
 211 .Tn AIC7897
 212 host adapter chip
 213 .It
 214 Adaptec
 215 .Tn AIC7899
 216 host adapter chip
 217 .It
 218 Adaptec
 219 .Tn 274X(W)
 220 .It
 221 Adaptec
 222 .Tn 274X(T)
 223 .It
 224 Adaptec
 225 .Tn 2910
 226 .It
 227 Adaptec
 228 .Tn 2915
 229 .It
 230 Adaptec
 231 .Tn 2920C
 232 .It
 233 Adaptec
 234 .Tn 2930C
 235 .It
 236 Adaptec
 237 .Tn 2930U2
 238 .It
 239 Adaptec
 240 .Tn 2940
 241 .It
 242 Adaptec
 243 .Tn 2940J
 244 .It
 245 Adaptec
 246 .Tn 2940N
 247 .It
 248 Adaptec
 249 .Tn 2940U
 250 .It
 251 Adaptec
 252 .Tn 2940AU
 253 .It
 254 Adaptec
 255 .Tn 2940UW
 256 .It
 257 Adaptec
 258 .Tn 2940UW Dual
 259 .It
 260 Adaptec
 261 .Tn 2940UW Pro
 262 .It
 263 Adaptec
 264 .Tn 2940U2W
 265 .It
 266 Adaptec
 267 .Tn 2940U2B
 268 .It
 269 Adaptec
 270 .Tn 2950U2W
 271 .It
 272 Adaptec
 273 .Tn 2950U2B
 274 .It
 275 Adaptec
 276 .Tn 19160B
 277 .It
 278 Adaptec
 279 .Tn 29160B
 280 .It
 281 Adaptec
 282 .Tn 29160N
 283 .It
 284 Adaptec
 285 .Tn 3940
 286 .It
 287 Adaptec
 288 .Tn 3940U
 289 .It
 290 Adaptec
 291 .Tn 3940AU
 292 .It
 293 Adaptec
 294 .Tn 3940UW
 295 .It
 296 Adaptec
 297 .Tn 3940AUW
 298 .It
 299 Adaptec
 300 .Tn 3940U2W
 301 .It
 302 Adaptec
 303 .Tn 3950U2
 304 .It
 305 Adaptec
 306 .Tn 3960
 307 .It
 308 Adaptec
 309 .Tn 39160
 310 .It
 311 Adaptec
 312 .Tn 3985
 313 .It
 314 Adaptec
 315 .Tn 4944UW
 316 .It
 317 Many motherboards with on-board
 318 .Tn SCSI
 319 support
 320 .El
 321 .Sh SCSI CONTROL BLOCKS (SCBs)
 322 Every transaction sent to a device on the SCSI bus is assigned a
 323 .Sq SCSI Control Block
 324 (SCB).
 325 The SCB contains all of the information required by the
 326 controller to process a transaction.
 327 The chip feature table lists
 328 the number of SCBs that can be stored in on-chip memory.
 329 All chips
 330 with model numbers greater than or equal to 7870 allow for the on chip
 331 SCB space to be augmented with external SRAM up to a maximum of 255 SCBs.
 332 Very few Adaptec controller configurations have external SRAM.
 333 .Pp
 334 If external SRAM is not available, SCBs are a limited resource.
 335 Using the SCBs in a straight forward manner would only allow the driver to
 336 handle as many concurrent transactions as there are physical SCBs.
 337 To fully utilize the SCSI bus and the devices on it,
 338 requires much more concurrency.
 339 The solution to this problem is
 340 .Em SCB Paging ,
 341 a concept similar to memory paging.
 342 SCB paging takes advantage of
 343 the fact that devices usually disconnect from the SCSI bus for long
 344 periods of time without talking to the controller.
 345 The SCBs for disconnected transactions are only of use to the controller
 346 when the transfer is resumed.
 347 When the host queues another transaction
 348 for the controller to execute, the controller firmware will use a
 349 free SCB if one is available.
 350 Otherwise, the state of the most recently
 351 disconnected (and therefore most likely to stay disconnected) SCB is
 352 saved, via dma, to host memory, and the local SCB reused to start
 353 the new transaction.
 354 This allows the controller to queue up to
 355 255 transactions regardless of the amount of SCB space.
 356 Since the
 357 local SCB space serves as a cache for disconnected transactions, the
 358 more SCB space available, the less host bus traffic consumed saving
 359 and restoring SCB data.
 360 .Sh SEE ALSO
 361 .Xr ahd 4 ,
 362 .Xr cd 4 ,
 363 .Xr da 4 ,
 364 .Xr sa 4 ,
 365 .Xr scsi 4
 366 .Sh HISTORY
 367 The
 368 .Nm
 369 driver appeared in
 370 .Fx 2.0 .
 371 .Sh AUTHORS
 372 The
 373 .Nm
 374 driver, the
 375 .Tn AIC7xxx
 376 sequencer-code assembler,
 377 and the firmware running on the aic7xxx chips was written by
 378 .An Justin T. Gibbs .
 379 .Sh BUGS
 380 Some Quantum drives (at least the Empire 2100 and 1080s) will not run on an
 381 .Tn AIC7870
 382 Rev B in synchronous mode at 10MHz.
 383 Controllers with this problem have a
 384 42 MHz clock crystal on them and run slightly above 10MHz.
 385 This confuses the drive and hangs the bus.
 386 Setting a maximum synchronous negotiation rate of 8MHz in the
 387 .Tn SCSI-Select
 388 utility will allow normal operation.
 389 .Pp
 390 Although the Ultra2 and Ultra160 products have sufficient instruction
 391 ram space to support both the initiator and target roles concurrently,
 392 this configuration is disabled in favor of allowing the target role
 393 to respond on multiple target ids.
 394 A method for configuring dual role mode should be provided.
 395 .Pp
 396 Tagged Queuing is not supported in target mode.
 397 .Pp
 398 Reselection in target mode fails to function correctly on all high
 399 voltage differential boards as shipped by Adaptec.
 400 Information on
 401 how to modify HVD board to work correctly in target mode is available
 402 from Adaptec.