Remove some ports specific references.
[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: src/share/man/man4/aac.4,v 1.3.2.8 2001/09/27 22:01:38 scottl Exp $
26 .\" $DragonFly: src/share/man/man4/aac.4,v 1.6 2006/05/11 08:23:19 swildner Exp $
27 .Dd May 11, 2006
28 .Dt AAC 4
29 .Os
30 .Sh NAME
31 .Nm aac
32 .Nd Adaptec AdvancedRAID Controller driver
33 .Sh SYNOPSIS
34 .Cd options AAC_DEBUG=N
35 .Cd device pci
36 .Cd device aac
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for the Adaptec AAC family SATA, SCSI Ultra2
41 and Ultra160/320 RAID controllers.
42 These controllers support RAID 0, 1, 5, 10, and volume sets.
43 They have four channels in the add-in version
44 or 1-2 channels in the motherboard integrated version,
45 and are most often found relabeled by Dell or Hewlett-Packard.
46 Supported controllers include:
47 .Bl -bullet
48 .It
49 AAC-364
50 .It
51 Adaptec SATA RAID 2410SA
52 .It
53 Adaptec SATA RAID 2810SA
54 .It
55 Adaptec SCSI RAID 2120S
56 .It
57 Adaptec SCSI RAID 2200S
58 .It
59 Adaptec SCSI RAID 5400S
60 .It
61 Dell CERC SATA RAID 2
62 .It
63 Dell PERC 2/Si
64 .It
65 Dell PERC 2/QC
66 .It
67 Dell PERC 3/Si
68 .It
69 Dell PERC 3/Di
70 .It
71 Dell PERC 320/DC
72 .It
73 HP NetRAID 4M
74 .El
75 .Pp
76 Access to RAID containers is available via the
77 .Pa /dev/aacd?
78 device nodes.
79 Individual drives cannot be accessed
80 unless they are part of a container or volume set,
81 and non-fixed disks cannot be accessed.
82 Containers can be configured by using
83 either the on-board BIOS utility of the card,
84 or a Linux-based management application.
85 .Pp
86 The
87 .Pa /dev/aac?
88 device nodes provide access to the management interface of the controller.
89 One node exists per installed card.
90 The aliases
91 .Pa /dev/afa?
92 and
93 .Pa /dev/hpn?
94 exist for the Dell and HP flavors, respectively, and are required for
95 the CLI management utility available from these vendors to work.
96 .Ss Tuning
97 The read-only sysctl
98 .Va hw.aac.iosize_max
99 defaults to 65536 and may be set at boot time to another value via
100 .Xr loader 8 .
101 This value determines the maximum data transfer size allowed
102 to/from an array.
103 Setting it higher will result in better performance,
104 especially for large sequential access patterns.
105 .Em Beware :
106 internal limitations
107 of the card limit this value to 64K for arrays with many members.
108 While it may be safe to raise this value, this is done
109 .Em at the operator's own risk .
110 Note also that
111 performance peaks at a value of 96K,
112 and drops off dramatically at 128K,
113 due to other limitations of the card.
114 .Sh FILES
115 .Bl -tag -width /modules/aac.ko -compact
116 .It Pa /dev/aac?
117 aac management interface
118 .It Pa /dev/aacd?
119 disk/container interface
120 .It Pa /modules/aac.ko
121 aac loadable module
122 .El
123 .Sh DIAGNOSTICS
124 Compiling with
125 .Dv AAC_DEBUG
126 set to a number between 0 and 3
127 will enable increasingly verbose debug messages.
128 .Pp
129 The adapter can send status and alert messages asynchronously
130 to the driver.
131 These messages are printed on the system console,
132 and are also queued for retrieval by a management application.
133 .Sh SEE ALSO
134 .Xr kld 4 ,
135 .Xr linux 4 ,
136 .Xr kldload 8 ,
137 .Xr loader 8 ,
138 .Xr sysctl 8
139 .Sh HISTORY
140 The
141 .Nm
142 driver first appeared in
143 .Fx 4.3 .
144 .Sh AUTHORS
145 .An Mike Smith
146 .Aq msmith@FreeBSD.org
147 .An Scott Long
148 .Aq scottl@FreeBSD.org
149 .Sh BUGS
150 This driver is not compatible with controllers that have version 1.x firmware.
151 The firmware version is the same as the kernel version printed in the BIOS
152 POST and driver attach messages.
153 .Pp
154 This driver will not work on systems with more than 4GB of memory.
155 .Pp
156 The controller is not actually paused on suspend/resume.
157 .Pp
158 Unloading driver is not supported at this time.
159 .Pp