xref: /dragonfly/share/man/man4/arcmsr.4 (revision 0ca59c34) 
1.\" Copyright (c) 2005 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: head/share/man/man4/arcmsr.4 259564 2013-12-18 19:23:05Z delphij $
26.\"
27.Dd February 25, 2014
28.Dt ARCMSR 4
29.Os
30.Sh NAME
31.Nm arcmsr
32.Nd Areca RAID Controller driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device pci"
39.Cd "device scbus"
40.Cd "device da"
41.Cd "device arcmsr"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48arcmsr_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for the Areca ARC-11xx, ARC-12xx, ARC-13xx,
54ARC-16xx and ARC-18xx series of SAS and SATA RAID controllers.
55These controllers feature RAID-0, 1, 3, 5, 6, and 10 and
56JBOD acceleration for up to 16 SATA drives.
57RAID level and stripe level
58migration, online capacity expansion, hot insertion/removal, automatic failover
59and rebuild, and SMART are also supported.
60Access to the arrays is provided
61via the SCSI CAM
62.Pa /dev/da?
63device nodes.
64A management interface is also present via the
65.Pa /dev/arcmsr?
66device node.
67.\"Management tools for i386 and amd64 are available from Areca.
68.Sh LOADER TUNABLES
69.Bl -tag -width indent
70.It Va hw.arcmsr.msi.enable
71By default, the driver will use MSI if it is supported.
72This behavior can be turned off by setting this tunable to 0.
73.El
74.Sh HARDWARE
75The
76.Nm
77driver supports the following cards:
78.Pp
79.Bl -bullet -compact
80.It
81ARC-1110
82.It
83ARC-1120
84.It
85ARC-1130
86.It
87ARC-1160
88.It
89ARC-1170
90.It
91ARC-1110ML
92.It
93ARC-1120ML
94.It
95ARC-1130ML
96.It
97ARC-1160ML
98.It
99ARC-1200
100.It
101ARC-1201
102.It
103ARC-1210
104.It
105ARC-1212
106.It
107ARC-1213
108.It
109ARC-1214
110.It
111ARC-1220
112.It
113ARC-1222
114.It
115ARC-1223
116.It
117ARC-1224
118.It
119ARC-1230
120.It
121ARC-1231
122.It
123ARC-1260
124.It
125ARC-1261
126.It
127ARC-1264
128.It
129ARC-1270
130.It
131ARC-1280
132.It
133ARC-1284
134.It
135ARC-1210ML
136.It
137ARC-1220ML
138.It
139ARC-1231ML
140.It
141ARC-1261ML
142.It
143ARC-1280ML
144.It
145ARC-1380
146.It
147ARC-1381
148.It
149ARC-1680i
150.It
151ARC-1680x
152.It
153ARC-1680ix
154.It
155ARC-1680ixl
156.It
157ARC-1680LP
158.It
159ARC-1681
160.It
161ARC-1880i
162.It
163ARC-1880x
164.It
165ARC-1880ix
166.It
167ARC-1880ixl
168.It
169ARC-1882
170.It
171ARC-1883
172.El
173.Sh FILES
174.Bl -tag -width ".Pa /dev/arcmsr?" -compact
175.It Pa /dev/da?
176Array block device
177.It Pa /dev/arcmsr?
178Management interface
179.El
180.Sh SEE ALSO
181.Xr da 4 ,
182.Xr scbus 4
183.Sh HISTORY
184The
185.Nm
186driver first appeared in
187.Fx 5.4 .
188.Sh AUTHORS
189The driver was written by
190.An Erich Chen Aq Mt erich@areca.com.tw .
191.Sh BUGS
192The driver has been tested on i386 and amd64.
193It likely requires additional
194work to function on big-endian architectures.
195