xref: /dragonfly/share/man/man4/arcmsr.4 (revision 783d47c4)
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: src/share/man/man4/arcmsr.4,v 1.6 2008/03/28 23:25:58 brueffer Exp $
26.\"
27.Dd April 7, 2012
28.Dt ARCMSR 4
29.Os
30.Sh NAME
31.Nm arcmsr
32.Nd Areca SATA II 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 and ARC-12xx series of SATA II
54RAID 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.
67Management 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-1180
92.It
93ARC-1110ML
94.It
95ARC-1120ML
96.It
97ARC-1130ML
98.It
99ARC-1160ML
100.It
101ARC-1210
102.It
103ARC-1220
104.It
105ARC-1230
106.It
107ARC-1260
108.It
109ARC-1280
110.It
111ARC-1210ML
112.It
113ARC-1220ML
114.It
115ARC-1231ML
116.It
117ARC-1261ML
118.It
119ARC-1280ML
120.It
121ARC-1680i
122.It
123ARC-1680x
124.It
125ARC-1680ix
126.It
127ARC-1680ixl
128.It
129ARC-1680LP
130.It
131ARC-1880i
132.It
133ARC-1880x
134.It
135ARC-1880ix
136.It
137ARC-1880ixl
138.El
139.Sh FILES
140.Bl -tag -width ".Pa /dev/arcmsr?" -compact
141.It Pa /dev/da?
142Array block device
143.It Pa /dev/arcmsr?
144Management interface
145.El
146.Sh SEE ALSO
147.Xr da 4 ,
148.Xr scbus 4
149.Sh HISTORY
150The
151.Nm
152driver first appeared in
153.Fx 5.4 .
154.Sh AUTHORS
155The driver was written by
156.An Erich Chen Aq erich@areca.com.tw .
157.Sh BUGS
158The driver has been tested on i386 and amd64.
159It likely requires additional
160work to function on big-endian architectures.
161