Fix typo.
[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.4 2006/03/26 22:56:57 swildner Exp $
27 .Dd February 22, 2001
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_COMPAT_LINUX
35 .Cd options AAC_DEBUG=N
36 .Cd device pci
37 .Cd device aac
38 .Sh DESCRIPTION
39 The
40 .Nm
41 driver provides support for the Adaptec AAC family SCSI Ultra2 and Ultra160
42 RAID controllers.
43 These controllers support RAID 0, 1, 5, 10, and volume sets.
44 They have four channels in the add-in version
45 or 1-2 channels in the motherboard integrated version,
46 and are most often found relabeled by Dell or Hewlett-Packard.
47 Supported controllers include:
48 .Bl -bullet
49 .It
50 AAC-364
51 .It
52 Adaptec SCSI RAID 5400S
53 .It
54 HP NetRAID 4M
55 .It
56 Dell PERC 2/Si
57 .It
58 Dell PERC 2/QC
59 .It
60 Dell PERC 3/Si
61 .It
62 Dell PERC 3/Di
63 .El
64 Access to RAID containers is available via the
65 .Pa /dev/aacd?
66 device nodes.
67 Individual drives cannot be accessed
68 unless they are part of a container or volume set,
69 and non-fixed disks cannot be accessed.
70 Containers can be configured by using
71 either the on-board BIOS utility of the card,
72 or a Linux-based management application.
73 .Pp
74 The
75 .Pa /dev/aac?
76 device nodes provide access to the management interface of the controller.
77 One node exists per installed card.
78 The aliases
79 .Pa /dev/afa?
80 and
81 .Pa /dev/hpn?
82 exist for the Dell and HP flavors, respectively, and are required for
83 the CLI management utility available from these vendors to work.
84 Compiling the driver with the
85 .Dv AAC_COMPAT_LINUX
86 option enables the Linux-compatible
87 .Xr ioctl 2
88 interface for the management device.
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 FILES
108 .Bl -tag -width /modules/aac.ko -compact
109 .It Pa /dev/aac?
110 aac management interface
111 .It Pa /dev/aacd?
112 disk/container interface
113 .It Pa /modules/aac.ko
114 aac loadable module
115 .El
116 .Sh DIAGNOSTICS
117 Compiling with
118 .Dv AAC_DEBUG
119 set to a number between 0 and 3
120 will enable increasingly verbose debug messages.
121 .Pp
122 The adapter can send status and alert messages asynchronously
123 to the driver.
124 These messages are printed on the system console,
125 and are also queued for retrieval by a management application.
126 .Sh SEE ALSO
127 .Xr kld 4 ,
128 .Xr linux 4 ,
129 .Xr kldload 8 ,
130 .Xr loader 8 ,
131 .Xr sysctl 8
132 .Sh HISTORY
133 The
134 .Nm
135 driver first appeared in
136 .Fx 4.3 .
137 .Sh AUTHORS
138 .An Mike Smith
139 .Aq msmith@FreeBSD.org
140 .An Scott Long
141 .Aq scottl@FreeBSD.org
142 .Sh BUGS
143 This driver is not compatible with controllers that have version 1.x firmware.
144 The firmware version is the same as the kernel version printed in the BIOS
145 POST and driver attach messages.
146 .Pp
147 This driver will not work on systems with more than 4GB of memory.
148 .Pp
149 The controller is not actually paused on suspend/resume.
150 .Pp
151 Unloading driver is not supported at this time.
152 .Pp