share/man/man4/aac.4

   1 .\" Copyright (c) 2000 Scott Long
   2 .\" 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 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd November 3, 2006
  27 .Dt AAC 4
  28 .Os
  29 .Sh NAME
  30 .Nm aac
  31 .Nd Adaptec AdvancedRAID Controller driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd device pci
  38 .Cd device aac
  39 .Cd device aacp
  40 .Pp
  41 To compile in debugging code:
  42 .Cd options AAC_DEBUG=N
  43 .Ed
  44 .Pp
  45 Alternatively, to load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 aac_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver provides support for the Adaptec AAC family of SCSI Ultra2, Ultra160,
  55 and Ultra320, SATA and SAS RAID controllers.
  56 .Pp
  57 Access to RAID containers is available via the
  58 .Pa /dev/aacd?
  59 device nodes.
  60 The
  61 .Nm aacp
  62 device enables the SCSI pass-thru interface and allows devices connected
  63 to the card such as CD-ROMs to be available via the CAM
  64 .Xr scsi 4
  65 subsystem.
  66 Note that not all cards allow this interface to be enabled.
  67 .Pp
  68 The
  69 .Pa /dev/aac?
  70 device nodes provide access to the management interface of the controller.
  71 One node exists per installed card.
  72 The aliases
  73 .Pa /dev/afa?
  74 and
  75 .Pa /dev/hpn?
  76 exist for compatibility with the Dell and HP versions of management tools,
  77 respectively.
  78 If the kernel is compiled with the
  79 .Dv COMPAT_LINUX
  80 option, or the
  81 .Pa aac_linux.ko
  82 and
  83 .Pa linux.ko
  84 modules are loaded, the
  85 Linux-compatible
  86 .Xr ioctl 2
  87 interface for the management device will be enabled and will allow
  88 Linux-based management applications to control the card.
  89 .Ss Tuning
  90 The read-only sysctl
  91 .Va hw.aac.iosize_max
  92 defaults to 65536 and may be set at boot time to another value via
  93 .Xr loader 8 .
  94 This value determines the maximum data transfer size allowed
  95 to/from an array.
  96 Setting it higher will result in better performance,
  97 especially for large sequential access patterns.
  98 .Em Beware :
  99 internal limitations
 100 of the card limit this value to 64K for arrays with many members.
 101 While it may be safe to raise this value, this is done
 102 .Em at the operator's own risk .
 103 Note also that
 104 performance peaks at a value of 96K,
 105 and drops off dramatically at 128K,
 106 due to other limitations of the card.
 107 .Sh HARDWARE
 108 Controllers supported by the
 109 .Nm
 110 driver include:
 111 .Pp
 112 .Bl -bullet -compact
 113 .It
 114 Adaptec AAC-364
 115 .It
 116 Adaptec SAS RAID 4000SAS
 117 .It
 118 Adaptec SAS RAID 4005SAS
 119 .It
 120 Adaptec SAS RAID 4800SAS
 121 .It
 122 Adaptec SAS RAID 4805SAS
 123 .It
 124 Adaptec SATA RAID 2020SA ZCR
 125 .It
 126 Adaptec SATA RAID 2025SA ZCR
 127 .It
 128 Adaptec SATA RAID 2026ZCR
 129 .It
 130 Adaptec SATA RAID 2410SA
 131 .It
 132 Adaptec SATA RAID 2420SA
 133 .It
 134 Adaptec SATA RAID 2610SA
 135 .It
 136 Adaptec SATA RAID 2620SA
 137 .It
 138 Adaptec SATA RAID 2810SA
 139 .It
 140 Adaptec SATA RAID 2820SA
 141 .It
 142 Adaptec SATA RAID 21610SA
 143 .It
 144 Adaptec SCSI RAID 2020ZCR
 145 .It
 146 Adaptec SCSI RAID 2025ZCR
 147 .It
 148 Adaptec SCSI RAID 2120S
 149 .It
 150 Adaptec SCSI RAID 2130S
 151 .It
 152 Adaptec SCSI RAID 2130SLP
 153 .It
 154 Adaptec SCSI RAID 2230SLP
 155 .It
 156 Adaptec SCSI RAID 2200S
 157 .It
 158 Adaptec SCSI RAID 2240S
 159 .It
 160 Adaptec SCSI RAID 3230S
 161 .It
 162 Adaptec SCSI RAID 3240S
 163 .It
 164 Adaptec SCSI RAID 5400S
 165 .It
 166 Dell CERC SATA RAID 2
 167 .It
 168 Dell PERC 2/Si
 169 .It
 170 Dell PERC 2/QC
 171 .It
 172 Dell PERC 3/Si
 173 .It
 174 Dell PERC 3/Di
 175 .It
 176 Dell PERC 320/DC
 177 .It
 178 HP ML110 G2 (Adaptec SATA RAID 2610SA)
 179 .It
 180 HP NetRAID 4M
 181 .It
 182 IBM ServeRAID 8i
 183 .It
 184 IBM ServeRAID 8k
 185 .It
 186 ICP ICP5085BR SAS RAID
 187 .It
 188 ICP ICP9085LI SAS RAID
 189 .It
 190 ICP ICP9047MA SATA RAID
 191 .It
 192 ICP ICP9087MA SATA RAID
 193 .It
 194 ICP ICP9014RO SCSI RAID
 195 .It
 196 ICP ICP9024RO SCSI RAID
 197 .It
 198 Legend S220
 199 .It
 200 Legend S230
 201 .El
 202 .Sh FILES
 203 .Bl -tag -width /boot/kernel/aac.ko -compact
 204 .It Pa /dev/aac?
 205 aac management interface
 206 .It Pa /dev/aacd?
 207 disk/container interface
 208 .El
 209 .Sh DIAGNOSTICS
 210 Compiling with
 211 .Dv AAC_DEBUG
 212 set to a number between 0 and 3
 213 will enable increasingly verbose debug messages.
 214 .Pp
 215 The adapter can send status and alert messages asynchronously
 216 to the driver.
 217 These messages are printed on the system console,
 218 and are also queued for retrieval by a management application.
 219 .Sh SEE ALSO
 220 .Xr kld 4 ,
 221 .Xr linux 4 ,
 222 .Xr scsi 4 ,
 223 .Xr kldload 8 ,
 224 .Xr loader 8 ,
 225 .Xr sysctl 8
 226 .Sh HISTORY
 227 The
 228 .Nm
 229 driver first appeared in
 230 .Fx 4.3 .
 231 .Sh AUTHORS
 232 .An Mike Smith
 233 .Aq msmith@FreeBSD.org
 234 .An Scott Long
 235 .Aq scottl@FreeBSD.org
 236 .Sh BUGS
 237 This driver is not compatible with Dell controllers that have version 1.x
 238 firmware.
 239 The firmware version is the same as the kernel version printed in the BIOS
 240 POST and driver attach messages.
 241 .Pp
 242 The controller is not actually paused on suspend/resume.