| blob | 6ad88c2eb49e7aa826ba03090e35bfcf3a2babb0 |
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 June 27, 2008
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 RAID 2045
117 .It
118 Adaptec RAID 2405
119 .It
120 Adaptec RAID 2445
121 .It
122 Adaptec RAID 2805
123 .It
124 Adaptec RAID 3085
125 .It
126 Adaptec RAID 31205
127 .It
128 Adaptec RAID 31605
129 .It
130 Adaptec RAID 5085
131 .It
132 Adaptec RAID 51205
133 .It
134 Adaptec RAID 51245
135 .It
136 Adaptec RAID 51605
137 .It
138 Adaptec RAID 51645
139 .It
140 Adaptec RAID 52445
141 .It
142 Adaptec RAID 5405
143 .It
144 Adaptec RAID 5445
145 .It
146 Adaptec RAID 5805
147 .It
148 Adaptec SAS RAID 3405
149 .It
150 Adaptec SAS RAID 3805
151 .It
152 Adaptec SAS RAID 4000SAS
153 .It
154 Adaptec SAS RAID 4005SAS
155 .It
156 Adaptec SAS RAID 4800SAS
157 .It
158 Adaptec SAS RAID 4805SAS
159 .It
160 Adaptec SATA RAID 2020SA ZCR
161 .It
162 Adaptec SATA RAID 2025SA ZCR
163 .It
164 Adaptec SATA RAID 2026ZCR
165 .It
166 Adaptec SATA RAID 2410SA
167 .It
168 Adaptec SATA RAID 2420SA
169 .It
170 Adaptec SATA RAID 2610SA
171 .It
172 Adaptec SATA RAID 2620SA
173 .It
174 Adaptec SATA RAID 2810SA
175 .It
176 Adaptec SATA RAID 2820SA
177 .It
178 Adaptec SATA RAID 21610SA
179 .It
180 Adaptec SCSI RAID 2020ZCR
181 .It
182 Adaptec SCSI RAID 2025ZCR
183 .It
184 Adaptec SCSI RAID 2120S
185 .It
186 Adaptec SCSI RAID 2130S
187 .It
188 Adaptec SCSI RAID 2130SLP
189 .It
190 Adaptec SCSI RAID 2230SLP
191 .It
192 Adaptec SCSI RAID 2200S
193 .It
194 Adaptec SCSI RAID 2240S
195 .It
196 Adaptec SCSI RAID 3230S
197 .It
198 Adaptec SCSI RAID 3240S
199 .It
200 Adaptec SCSI RAID 5400S
201 .It
202 Dell CERC SATA RAID 2
203 .It
204 Dell PERC 2/Si
205 .It
206 Dell PERC 2/QC
207 .It
208 Dell PERC 3/Si
209 .It
210 Dell PERC 3/Di
211 .It
212 Dell PERC 320/DC
213 .It
214 HP ML110 G2 (Adaptec SATA RAID 2610SA)
215 .It
216 HP NetRAID 4M
217 .It
218 IBM ServeRAID 8i
219 .It
220 IBM ServeRAID 8k
221 .It
222 IBM ServeRAID 8s
223 .It
224 ICP RAID ICP5045BL
225 .It
226 ICP RAID ICP5085BL
227 .It
228 ICP RAID ICP5085SL
229 .It
230 ICP RAID ICP5125BR
231 .It
232 ICP RAID ICP5125SL
233 .It
234 ICP RAID ICP5165BR
235 .It
236 ICP RAID ICP5165SL
237 .It
238 ICP RAID ICP5445SL
239 .It
240 ICP RAID ICP5805BL
241 .It
242 ICP RAID ICP5805SL
243 .It
244 ICP ICP5085BR SAS RAID
245 .It
246 ICP ICP9085LI SAS RAID
247 .It
248 ICP ICP9047MA SATA RAID
249 .It
250 ICP ICP9067MA SATA RAID
251 .It
252 ICP ICP9087MA SATA RAID
253 .It
254 ICP ICP9014RO SCSI RAID
255 .It
256 ICP ICP9024RO SCSI RAID
257 .It
258 Legend S220
259 .It
260 Legend S230
261 .It
262 Sun STK RAID REM
263 .It
264 Sun STK RAID EM
265 .It
266 SG-XPCIESAS-R-IN
267 .It
268 SG-XPCIESAS-R-EX
269 .It
270 AOC-USAS-S4i
271 .It
272 AOC-USAS-S8i
273 .It
274 AOC-USAS-S4iR
275 .It
276 AOC-USAS-S8iR
277 .It
278 AOC-USAS-S8i-LP
279 .It
280 AOC-USAS-S8iR-LP
281 .El
282 .Sh FILES
283 .Bl -tag -width /boot/kernel/aac.ko -compact
284 .It Pa /dev/aac?
285 aac management interface
286 .It Pa /dev/aacd?
287 disk/container interface
288 .El
289 .Sh DIAGNOSTICS
290 Compiling with
291 .Dv AAC_DEBUG
292 set to a number between 0 and 3
293 will enable increasingly verbose debug messages.
294 .Pp
295 The adapter can send status and alert messages asynchronously
296 to the driver.
297 These messages are printed on the system console,
298 and are also queued for retrieval by a management application.
299 .Sh SEE ALSO
300 .Xr kld 4 ,
301 .Xr linux 4 ,
302 .Xr scsi 4 ,
303 .Xr kldload 8 ,
304 .Xr loader 8 ,
305 .Xr sysctl 8
306 .Sh HISTORY
307 The
308 .Nm
309 driver first appeared in
310 .Fx 4.3 .
311 .Sh AUTHORS
312 .An Mike Smith
313 .Aq msmith@FreeBSD.org
314 .An Scott Long
315 .Aq scottl@FreeBSD.org
316 .Sh BUGS
317 This driver is not compatible with Dell controllers that have version 1.x
318 firmware.
319 The firmware version is the same as the kernel version printed in the BIOS
320 POST and driver attach messages.
321 .Pp
322 The controller is not actually paused on suspend/resume.