xref: /freebsd/share/man/man4/aac.4 (revision b28624fde638caadd4a89f50c9b7e7da0f98c4d2)
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 August 23, 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 SAS RAID 3405
117.It
118Adaptec SAS RAID 3805
119.It
120Adaptec SAS RAID 4000SAS
121.It
122Adaptec SAS RAID 4005SAS
123.It
124Adaptec SAS RAID 4800SAS
125.It
126Adaptec SAS RAID 4805SAS
127.It
128Adaptec SATA RAID 2020SA ZCR
129.It
130Adaptec SATA RAID 2025SA ZCR
131.It
132Adaptec SATA RAID 2026ZCR
133.It
134Adaptec SATA RAID 2410SA
135.It
136Adaptec SATA RAID 2420SA
137.It
138Adaptec SATA RAID 2610SA
139.It
140Adaptec SATA RAID 2620SA
141.It
142Adaptec SATA RAID 2810SA
143.It
144Adaptec SATA RAID 2820SA
145.It
146Adaptec SATA RAID 21610SA
147.It
148Adaptec SCSI RAID 2020ZCR
149.It
150Adaptec SCSI RAID 2025ZCR
151.It
152Adaptec SCSI RAID 2120S
153.It
154Adaptec SCSI RAID 2130S
155.It
156Adaptec SCSI RAID 2130SLP
157.It
158Adaptec SCSI RAID 2230SLP
159.It
160Adaptec SCSI RAID 2200S
161.It
162Adaptec SCSI RAID 2240S
163.It
164Adaptec SCSI RAID 3230S
165.It
166Adaptec SCSI RAID 3240S
167.It
168Adaptec SCSI RAID 5400S
169.It
170Dell CERC SATA RAID 2
171.It
172Dell PERC 2/Si
173.It
174Dell PERC 2/QC
175.It
176Dell PERC 3/Si
177.It
178Dell PERC 3/Di
179.It
180Dell PERC 320/DC
181.It
182HP ML110 G2 (Adaptec SATA RAID 2610SA)
183.It
184HP NetRAID 4M
185.It
186IBM ServeRAID 8i
187.It
188IBM ServeRAID 8k
189.It
190ICP ICP5085BR SAS RAID
191.It
192ICP ICP9085LI SAS RAID
193.It
194ICP ICP9047MA SATA RAID
195.It
196ICP ICP9087MA SATA RAID
197.It
198ICP ICP9014RO SCSI RAID
199.It
200ICP ICP9024RO SCSI RAID
201.It
202Legend S220
203.It
204Legend S230
205.El
206.Sh FILES
207.Bl -tag -width /boot/kernel/aac.ko -compact
208.It Pa /dev/aac?
209aac management interface
210.It Pa /dev/aacd?
211disk/container interface
212.El
213.Sh DIAGNOSTICS
214Compiling with
215.Dv AAC_DEBUG
216set to a number between 0 and 3
217will enable increasingly verbose debug messages.
218.Pp
219The adapter can send status and alert messages asynchronously
220to the driver.
221These messages are printed on the system console,
222and are also queued for retrieval by a management application.
223.Sh SEE ALSO
224.Xr kld 4 ,
225.Xr linux 4 ,
226.Xr scsi 4 ,
227.Xr kldload 8 ,
228.Xr loader 8 ,
229.Xr sysctl 8
230.Sh HISTORY
231The
232.Nm
233driver first appeared in
234.Fx 4.3 .
235.Sh AUTHORS
236.An Mike Smith
237.Aq msmith@FreeBSD.org
238.An Scott Long
239.Aq scottl@FreeBSD.org
240.Sh BUGS
241This driver is not compatible with Dell controllers that have version 1.x
242firmware.
243The firmware version is the same as the kernel version printed in the BIOS
244POST and driver attach messages.
245.Pp
246The controller is not actually paused on suspend/resume.
247