xref: /freebsd/share/man/man4/aac.4 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f) 
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 29, 2007
27.Dt AAC 4
28.Os
29.Sh NAME
30.Nm aac
31.Nd Adaptec AdvancedRAID Controller driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd device pci
38.Cd device aac
39.Cd device aacp
40.Pp
41To compile in debugging code:
42.Cd options AAC_DEBUG=N
43.Ed
44.Pp
45Alternatively, to load the driver as a
46module at boot time, place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49aac_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver provides support for the Adaptec AAC family of SCSI Ultra2, Ultra160,
55and Ultra320, SATA and SAS RAID controllers.
56.Pp
57Access to RAID containers is available via the
58.Pa /dev/aacd?
59device nodes.
60The
61.Nm aacp
62device enables the SCSI pass-thru interface and allows devices connected
63to the card such as CD-ROMs to be available via the CAM
64.Xr scsi 4
65subsystem.
66Note that not all cards allow this interface to be enabled.
67.Pp
68The
69.Pa /dev/aac?
70device nodes provide access to the management interface of the controller.
71One node exists per installed card.
72The aliases
73.Pa /dev/afa?
74and
75.Pa /dev/hpn?
76exist for compatibility with the Dell and HP versions of management tools,
77respectively.
78If the kernel is compiled with the
79.Dv COMPAT_LINUX
80option, or the
81.Pa aac_linux.ko
82and
83.Pa linux.ko
84modules are loaded, the
85Linux-compatible
86.Xr ioctl 2
87interface for the management device will be enabled and will allow
88Linux-based management applications to control the card.
89.Ss Tuning
90The read-only sysctl
91.Va hw.aac.iosize_max
92defaults to 65536 and may be set at boot time to another value via
93.Xr loader 8 .
94This value determines the maximum data transfer size allowed
95to/from an array.
96Setting it higher will result in better performance,
97especially for large sequential access patterns.
98.Em Beware :
99internal limitations
100of the card limit this value to 64K for arrays with many members.
101While it may be safe to raise this value, this is done
102.Em at the operator's own risk .
103Note also that
104performance peaks at a value of 96K,
105and drops off dramatically at 128K,
106due to other limitations of the card.
107.Sh HARDWARE
108Controllers supported by the
109.Nm
110driver include:
111.Pp
112.Bl -bullet -compact
113.It
114Adaptec AAC-364
115.It
116Adaptec RAID 3085
117.It
118Adaptec RAID 31205
119.It
120Adaptec RAID 31605
121.It
122Adaptec RAID 5085
123.It
124Adaptec RAID 51205
125.It
126Adaptec RAID 51245
127.It
128Adaptec RAID 51605
129.It
130Adaptec RAID 51645
131.It
132Adaptec RAID 52445
133.It
134Adaptec RAID 5405
135.It
136Adaptec RAID 5445
137.It
138Adaptec RAID 5805
139.It
140Adaptec SAS RAID 3405
141.It
142Adaptec SAS RAID 3805
143.It
144Adaptec SAS RAID 4000SAS
145.It
146Adaptec SAS RAID 4005SAS
147.It
148Adaptec SAS RAID 4800SAS
149.It
150Adaptec SAS RAID 4805SAS
151.It
152Adaptec SATA RAID 2020SA ZCR
153.It
154Adaptec SATA RAID 2025SA ZCR
155.It
156Adaptec SATA RAID 2026ZCR
157.It
158Adaptec SATA RAID 2410SA
159.It
160Adaptec SATA RAID 2420SA
161.It
162Adaptec SATA RAID 2610SA
163.It
164Adaptec SATA RAID 2620SA
165.It
166Adaptec SATA RAID 2810SA
167.It
168Adaptec SATA RAID 2820SA
169.It
170Adaptec SATA RAID 21610SA
171.It
172Adaptec SCSI RAID 2020ZCR
173.It
174Adaptec SCSI RAID 2025ZCR
175.It
176Adaptec SCSI RAID 2120S
177.It
178Adaptec SCSI RAID 2130S
179.It
180Adaptec SCSI RAID 2130SLP
181.It
182Adaptec SCSI RAID 2230SLP
183.It
184Adaptec SCSI RAID 2200S
185.It
186Adaptec SCSI RAID 2240S
187.It
188Adaptec SCSI RAID 3230S
189.It
190Adaptec SCSI RAID 3240S
191.It
192Adaptec SCSI RAID 5400S
193.It
194Dell CERC SATA RAID 2
195.It
196Dell PERC 2/Si
197.It
198Dell PERC 2/QC
199.It
200Dell PERC 3/Si
201.It
202Dell PERC 3/Di
203.It
204Dell PERC 320/DC
205.It
206HP ML110 G2 (Adaptec SATA RAID 2610SA)
207.It
208HP NetRAID 4M
209.It
210IBM ServeRAID 8i
211.It
212IBM ServeRAID 8k
213.It
214IBM ServeRAID 8s
215.It
216ICP RAID ICP5045BL
217.It
218ICP RAID ICP5085BL
219.It
220ICP RAID ICP5085SL
221.It
222ICP RAID ICP5125BR
223.It
224ICP RAID ICP5125SL
225.It
226ICP RAID ICP5165BR
227.It
228ICP RAID ICP5165SL
229.It
230ICP RAID ICP5445SL
231.It
232ICP RAID ICP5805BL
233.It
234ICP RAID ICP5805SL
235.It
236ICP ICP5085BR SAS RAID
237.It
238ICP ICP9085LI SAS RAID
239.It
240ICP ICP9047MA SATA RAID
241.It
242ICP ICP9067MA SATA RAID
243.It
244ICP ICP9087MA SATA RAID
245.It
246ICP ICP9014RO SCSI RAID
247.It
248ICP ICP9024RO SCSI RAID
249.It
250Legend S220
251.It
252Legend S230
253.It
254Sun STK RAID REM
255.It
256Sun STK RAID EM
257.It
258SG-XPCIESAS-R-IN
259.It
260SG-XPCIESAS-R-EX
261.It
262AOC-USAS-S4i
263.It
264AOC-USAS-S8i
265.It
266AOC-USAS-S4iR
267.It
268AOC-USAS-S8iR
269.It
270AOC-USAS-S8i-LP
271.It
272AOC-USAS-S8iR-LP
273.El
274.Sh FILES
275.Bl -tag -width /boot/kernel/aac.ko -compact
276.It Pa /dev/aac?
277aac management interface
278.It Pa /dev/aacd?
279disk/container interface
280.El
281.Sh DIAGNOSTICS
282Compiling with
283.Dv AAC_DEBUG
284set to a number between 0 and 3
285will enable increasingly verbose debug messages.
286.Pp
287The adapter can send status and alert messages asynchronously
288to the driver.
289These messages are printed on the system console,
290and are also queued for retrieval by a management application.
291.Sh SEE ALSO
292.Xr kld 4 ,
293.Xr linux 4 ,
294.Xr scsi 4 ,
295.Xr kldload 8 ,
296.Xr loader 8 ,
297.Xr sysctl 8
298.Sh HISTORY
299The
300.Nm
301driver first appeared in
302.Fx 4.3 .
303.Sh AUTHORS
304.An Mike Smith
305.Aq msmith@FreeBSD.org
306.An Scott Long
307.Aq scottl@FreeBSD.org
308.Sh BUGS
309This driver is not compatible with Dell controllers that have version 1.x
310firmware.
311The firmware version is the same as the kernel version printed in the BIOS
312POST and driver attach messages.
313.Pp
314The controller is not actually paused on suspend/resume.
315