b06c1d5d707a79b394aeec93ec585bb51d109960
[dragonfly.git] / 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: head/share/man/man4/aac.4 195614 2009-07-11 08:10:18Z jkim $
26 .Dd March 19, 2014
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
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-through 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 .Sh LOADER TUNABLES
90 .Bl -tag -width indent
91 .It Va hw.aac.msi.enable
92 By default, the driver will use MSI if it is supported.
93 This behavior can be turned off by setting this tunable to 0.
94 .El
95 .Sh HARDWARE
96 Controllers supported by the
97 .Nm
98 driver include:
99 .Pp
100 .Bl -bullet -compact
101 .It
102 Adaptec AAC-364
103 .It
104 Adaptec RAID 2045
105 .It
106 Adaptec RAID 2405
107 .It
108 Adaptec RAID 2445
109 .It
110 Adaptec RAID 2805
111 .It
112 Adaptec RAID 3085
113 .It
114 Adaptec RAID 31205
115 .It
116 Adaptec RAID 31605
117 .It
118 Adaptec RAID 5085
119 .It
120 Adaptec RAID 51205
121 .It
122 Adaptec RAID 51245
123 .It
124 Adaptec RAID 51605
125 .It
126 Adaptec RAID 51645
127 .It
128 Adaptec RAID 52445
129 .It
130 Adaptec RAID 5405
131 .It
132 Adaptec RAID 5445
133 .It
134 Adaptec RAID 5805
135 .It
136 Adaptec SAS RAID 3405
137 .It
138 Adaptec SAS RAID 3805
139 .It
140 Adaptec SAS RAID 4000SAS
141 .It
142 Adaptec SAS RAID 4005SAS
143 .It
144 Adaptec SAS RAID 4800SAS
145 .It
146 Adaptec SAS RAID 4805SAS
147 .It
148 Adaptec SATA RAID 2020SA ZCR
149 .It
150 Adaptec SATA RAID 2025SA ZCR
151 .It
152 Adaptec SATA RAID 2026ZCR
153 .It
154 Adaptec SATA RAID 2410SA
155 .It
156 Adaptec SATA RAID 2420SA
157 .It
158 Adaptec SATA RAID 2610SA
159 .It
160 Adaptec SATA RAID 2620SA
161 .It
162 Adaptec SATA RAID 2810SA
163 .It
164 Adaptec SATA RAID 2820SA
165 .It
166 Adaptec SATA RAID 21610SA
167 .It
168 Adaptec SCSI RAID 2020ZCR
169 .It
170 Adaptec SCSI RAID 2025ZCR
171 .It
172 Adaptec SCSI RAID 2120S
173 .It
174 Adaptec SCSI RAID 2130S
175 .It
176 Adaptec SCSI RAID 2130SLP
177 .It
178 Adaptec SCSI RAID 2230SLP
179 .It
180 Adaptec SCSI RAID 2200S
181 .It
182 Adaptec SCSI RAID 2240S
183 .It
184 Adaptec SCSI RAID 3230S
185 .It
186 Adaptec SCSI RAID 3240S
187 .It
188 Adaptec SCSI RAID 5400S
189 .It
190 Dell CERC SATA RAID 2
191 .It
192 Dell PERC 2/Si
193 .It
194 Dell PERC 2/QC
195 .It
196 Dell PERC 3/Si
197 .It
198 Dell PERC 3/Di
199 .It
200 Dell PERC 320/DC
201 .It
202 HP ML110 G2 (Adaptec SATA RAID 2610SA)
203 .It
204 HP NetRAID 4M
205 .It
206 IBM ServeRAID 8i
207 .It
208 IBM ServeRAID 8k
209 .It
210 IBM ServeRAID 8s
211 .It
212 ICP RAID ICP5045BL
213 .It
214 ICP RAID ICP5085BL
215 .It
216 ICP RAID ICP5085SL
217 .It
218 ICP RAID ICP5125BR
219 .It
220 ICP RAID ICP5125SL
221 .It
222 ICP RAID ICP5165BR
223 .It
224 ICP RAID ICP5165SL
225 .It
226 ICP RAID ICP5445SL
227 .It
228 ICP RAID ICP5805BL
229 .It
230 ICP RAID ICP5805SL
231 .It
232 ICP ICP5085BR SAS RAID
233 .It
234 ICP ICP9085LI SAS RAID
235 .It
236 ICP ICP9047MA SATA RAID
237 .It
238 ICP ICP9067MA SATA RAID
239 .It
240 ICP ICP9087MA SATA RAID
241 .It
242 ICP ICP9014RO SCSI RAID
243 .It
244 ICP ICP9024RO SCSI RAID
245 .It
246 Legend S220
247 .It
248 Legend S230
249 .It
250 Sun STK RAID REM
251 .It
252 Sun STK RAID EM
253 .It
254 SG-XPCIESAS-R-IN
255 .It
256 SG-XPCIESAS-R-EX
257 .It
258 AOC-USAS-S4i
259 .It
260 AOC-USAS-S8i
261 .It
262 AOC-USAS-S4iR
263 .It
264 AOC-USAS-S8iR
265 .It
266 AOC-USAS-S8i-LP
267 .It
268 AOC-USAS-S8iR-LP
269 .El
270 .Sh FILES
271 .Bl -tag -width /boot/kernel/aac.ko -compact
272 .It Pa /dev/aac?
273 aac management interface
274 .It Pa /dev/aacd?
275 disk/container interface
276 .El
277 .Sh DIAGNOSTICS
278 Compiling with
279 .Dv AAC_DEBUG
280 will enable debug messages.
281 .Pp
282 The adapter can send status and alert messages asynchronously
283 to the driver.
284 These messages are printed on the system console,
285 and are also queued for retrieval by a management application.
286 .Sh SEE ALSO
287 .Xr kld 4 ,
288 .\".Xr linux 4 ,
289 .Xr scsi 4 ,
290 .Xr kldload 8
291 .Sh HISTORY
292 The
293 .Nm
294 driver first appeared in
295 .Fx 4.3 .
296 .Sh AUTHORS
297 .An Mike Smith Aq Mt msmith@FreeBSD.org
298 .An Scott Long Aq Mt scottl@FreeBSD.org
299 .Sh BUGS
300 This driver is not compatible with Dell controllers that have version 1.x
301 firmware.
302 The firmware version is the same as the kernel version printed in the BIOS
303 POST and driver attach messages.
304 .Pp
305 The controller is not actually paused on suspend/resume.