ppi.4: remove wrong statement
[dragonfly.git] / share / man / man4 / aac.4
blobcf47e88d375d407b4ab0c68aae468b9456f17a38
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: src/share/man/man4/aac.4,v 1.31.2.1.2.1 2006/12/14 23:56:26 brueffer Exp $
26 .\" $DragonFly: src/share/man/man4/aac.4,v 1.8 2008/09/02 11:50:46 matthias Exp $
27 .Dd May 8, 2009
28 .Dt AAC 4
29 .Os
30 .Sh NAME
31 .Nm aac
32 .Nd Adaptec AdvancedRAID Controller driver
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd device pci
39 .Cd device aac
40 .Cd device aacp
41 .Pp
42 To compile in debugging code:
43 .Cd options AAC_DEBUG=N
44 .Ed
45 .Pp
46 Alternatively, to load the driver as a
47 module at boot time, place the following line in
48 .Xr loader.conf 5 :
49 .Bd -literal -offset indent
50 aac_load="YES"
51 .Ed
52 .Sh DESCRIPTION
53 The
54 .Nm
55 driver provides support for the Adaptec AAC family of SCSI Ultra2, Ultra160,
56 and Ultra320, SATA and SAS RAID controllers.
57 .Pp
58 Access to RAID containers is available via the
59 .Pa /dev/aacd?
60 device nodes.
61 The
62 .Nm aacp
63 device enables the SCSI pass-thru interface and allows devices connected
64 to the card such as CD-ROMs to be available via the CAM
65 .Xr scsi 4
66 subsystem.
67 Note that not all cards allow this interface to be enabled.
68 .Pp
69 The
70 .Pa /dev/aac?
71 device nodes provide access to the management interface of the controller.
72 One node exists per installed card.
73 The aliases
74 .Pa /dev/afa?
75 and
76 .Pa /dev/hpn?
77 exist for compatibilty with the Dell and HP versions of management tools,
78 respectively.
79 If the kernel is compiled with the
80 .Dv COMPAT_LINUX
81 option, or the
82 .Pa aac_linux.ko
83 and
84 .Pa linux.ko
85 modules are loaded, the
86 Linux-compatible
87 .Xr ioctl 2
88 interface for the management device will be enabled and will allow
89 Linux-based management applications to control the card.
90 .Ss Tuning
91 The read-only sysctl
92 .Va hw.aac.iosize_max
93 defaults to 65536 and may be set at boot time to another value via
94 .Xr loader 8 .
95 This value determines the maximum data transfer size allowed
96 to/from an array.
97 Setting it higher will result in better performance,
98 especially for large sequential access patterns.
99 .Em Beware :
100 internal limitations
101 of the card limit this value to 64K for arrays with many members.
102 While it may be safe to raise this value, this is done
103 .Em at the operator's own risk .
104 Note also that
105 performance peaks at a value of 96K,
106 and drops off dramatically at 128K,
107 due to other limitations of the card.
108 .Sh HARDWARE
109 Controllers supported by the
111 driver include:
113 .Bl -bullet -compact
115 Adaptec AAC-364
117 Adaptec SAS RAID 4000SAS
119 Adaptec SAS RAID 4005SAS
121 Adaptec SAS RAID 4800SAS
123 Adaptec SAS RAID 4805SAS
125 Adaptec SATA RAID 2020SA ZCR
127 Adaptec SATA RAID 2025SA ZCR
129 Adaptec SATA RAID 2026ZCR
131 Adaptec SATA RAID 2410SA
133 Adaptec SATA RAID 2420SA
135 Adaptec SATA RAID 2610SA
137 Adaptec SATA RAID 2620SA
139 Adaptec SATA RAID 2810SA
141 Adaptec SATA RAID 2820SA
143 Adaptec SATA RAID 21610SA
145 Adaptec SCSI RAID 2020ZCR
147 Adaptec SCSI RAID 2025ZCR
149 Adaptec SCSI RAID 2120S
151 Adaptec SCSI RAID 2130S
153 Adaptec SCSI RAID 2130SLP
155 Adaptec SCSI RAID 2230SLP
157 Adaptec SCSI RAID 2200S
159 Adaptec SCSI RAID 2240S
161 Adaptec SCSI RAID 3230S
163 Adaptec SCSI RAID 3240S
165 Adaptec SCSI RAID 5400S
167 Dell CERC SATA RAID 2
169 Dell PERC 2/Si
171 Dell PERC 2/QC
173 Dell PERC 3/Si
175 Dell PERC 3/Di
177 Dell PERC 320/DC
179 HP ML110 G2 (Adaptec SATA RAID 2610SA)
181 HP NetRAID 4M
183 IBM ServeRAID 8i
185 IBM ServeRAID 8k
187 ICP ICP5085BR SAS RAID
189 ICP ICP9085LI SAS RAID
191 ICP ICP9047MA SATA RAID
193 ICP ICP9087MA SATA RAID
195 ICP ICP9014RO SCSI RAID
197 ICP ICP9024RO SCSI RAID
199 Legend S220
201 Legend S230
203 .Sh FILES
204 .Bl -tag -width ".Pa /dev/aacd?" -compact
205 .It Pa /dev/aac?
206 aac management interface
207 .It Pa /dev/aacd?
208 disk/container interface
210 .Sh DIAGNOSTICS
211 Compiling with
212 .Dv AAC_DEBUG
213 set to a number between 0 and 2
214 will enable increasingly verbose debug messages.
216 The adapter can send status and alert messages asynchronously
217 to the driver.
218 These messages are printed on the system console,
219 and are also queued for retrieval by a management application.
220 .Sh SEE ALSO
221 .Xr kld 4 ,
222 .Xr linux 4 ,
223 .Xr scsi 4 ,
224 .Xr kldload 8 ,
225 .Xr loader 8 ,
226 .Xr sysctl 8
227 .Sh HISTORY
230 driver first appeared in
231 .Fx 4.3 .
232 .Sh AUTHORS
233 .An Mike Smith
234 .Aq msmith@FreeBSD.org
235 .An Scott Long
236 .Aq scottl@FreeBSD.org
237 .Sh BUGS
238 This driver is not compatible with Dell controllers that have version 1.x
239 firmware.
240 The firmware version is the same as the kernel version printed in the BIOS
241 POST and driver attach messages.
243 .\"This driver will not work on systems with more than 4GB of memory.
244 .\".Pp
245 The controller is not actually paused on suspend/resume.