share/man/man4/ahd.4

   1 .\"
   2 .\" Copyright (c) 1995, 1996, 1997, 1998, 2000
   3 .\"     Justin T. Gibbs.  All rights reserved.
   4 .\" Copyright (c) 2002
   5 .\"     Scott Long.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd July 4, 2004
  32 .Dt AHD 4
  33 .Os
  34 .Sh NAME
  35 .Nm ahd
  36 .Nd Adaptec PCI/PCI-X Ultra320 SCSI host adapter driver
  37 .Sh SYNOPSIS
  38 To compile this driver into the kernel,
  39 place the following lines in your
  40 kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device pci"
  43 .Cd "device scbus"
  44 .Cd "device ahd"
  45 .Pp
  46 To compile in debugging code:
  47 .Cd options AHD_DEBUG
  48 .Cd options AHD_DEBUG_OPTS=<bitmask of options>
  49 .Cd options AHD_REG_PRETTY_PRINT
  50 .Pp
  51 To configure one or more controllers to assume the target role:
  52 .Cd options AHD_TMODE_ENABLE=<bitmask of units>
  53 .Ed
  54 .Pp
  55 Alternatively, to load the driver as a
  56 module at boot time, place the following line in
  57 .Xr loader.conf 5 :
  58 .Bd -literal -offset indent
  59 ahd_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 This driver provides access to the
  63 .Tn SCSI
  64 bus(es) connected to Adaptec
  65 .Tn AIC79xx
  66 host adapter chips.
  67 .Pp
  68 Driver features include support for narrow and wide busses,
  69 fast, ultra, ultra2, ultra160, and ultra320 synchronous transfers,
  70 packetized transfers, tagged queueing, 512 SCB's, and target mode.
  71 .Pp
  72 The
  73 .Dv AHD_DEBUG_OPTS
  74 option is used to control which diagnostic messages are printed to the
  75 console when
  76 .Dv AHD_DEBUG
  77 is enabled.
  78 Logically OR the following bits together:
  79 .Bl -column -offset indent Value Function
  80 .Em "Value      Function"
  81 0x0001  Show miscellaneous information
  82 0x0002  Show sense data
  83 0x0004  Show Serial EEPROM contents
  84 0x0008  Show bus termination settings
  85 0x0010  Show host memory usage
  86 0x0020  Show SCSI protocol messages
  87 0x0040  Show mode pointer of the chip register window
  88 0x0080  Show selection timeouts
  89 0x0100  Show FIFO usage messages
  90 0x0200  Show Queue Full status
  91 0x0400  Show SCB queue status
  92 0x0800  Show inbound packet information
  93 0x1000  Show S/G list information
  94 0x2000  Enable extra diagnostic code in the firmware
  95 .El
  96 .Pp
  97 The
  98 .Dv AHD_REG_PRETTY_PRINT
  99 option compiles in support for human-readable bit definitions for each register
 100 that is printed by the debugging code.
 101 However, it also bloats the compiled
 102 size of the driver by approximately 215KB.
 103 .Pp
 104 Individual controllers may be configured to operate in the target role
 105 through the
 106 .Dv AHD_TMODE_ENABLE
 107 configuration option.
 108 The value assigned to this option should be a bitmap
 109 of all units where target mode is desired.
 110 For example, a value of 0x25 would enable target mode on units 0, 2, and 5.
 111 Note that target mode is only supported for ultra160 speeds and below.
 112 .Pp
 113 Per target configuration performed in the
 114 .Tn SCSI-Select
 115 menu, accessible at boot,
 116 is honored by this driver.
 117 This includes synchronous/asynchronous transfers,
 118 maximum synchronous negotiation rate,
 119 wide transfers,
 120 disconnection,
 121 and the host adapter's
 122 .Tn SCSI
 123 ID.
 124 .Sh HARDWARE
 125 The
 126 .Nm
 127 driver supports the following:
 128 .Pp
 129 .Bl -bullet -compact
 130 .It
 131 Adaptec
 132 .Tn AIC7901
 133 host adapter chip
 134 .It
 135 Adaptec
 136 .Tn AIC7901A
 137 host adapter chip
 138 .It
 139 Adaptec
 140 .Tn AIC7902
 141 host adapter chip
 142 .It
 143 Adaptec
 144 .Tn 29320
 145 host adapter
 146 .It
 147 Adaptec
 148 .Tn 39320
 149 host adapter
 150 .It
 151 Many motherboards with on-board
 152 .Tn SCSI
 153 support
 154 .El
 155 .Sh SEE ALSO
 156 .Xr ahc 4 ,
 157 .Xr cd 4 ,
 158 .Xr da 4 ,
 159 .Xr sa 4 ,
 160 .Xr scsi 4
 161 .Sh HISTORY
 162 The
 163 .Nm
 164 driver first appeared in
 165 .Fx 4.7 .
 166 .Sh AUTHORS
 167 The
 168 .Nm
 169 driver, the
 170 .Tn AIC7xxx
 171 sequencer-code assembler,
 172 and the firmware running on the aic79xx chips was written by
 173 .An Justin T. Gibbs .
 174 This manual page is based on the
 175 .Xr ahc 4
 176 manual page.
 177 .Sh BUGS
 178 The current generation of 79xx chips do not support target mode in Ultra320
 179 mode.
 180 Target mode in general has not been well tested in this driver.