xref: /freebsd/share/man/man4/arcmsr.4 (revision c1d255d3) 
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$
26.\"
27.Dd October 15, 2020
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.
67Management tools for i386 and amd64 are available from Areca.
68.Sh HARDWARE
69The
70.Nm
71driver supports the following cards:
72.Pp
73.Bl -bullet -compact
74.It
75ARC-1110
76.It
77ARC-1120
78.It
79ARC-1130
80.It
81ARC-1160
82.It
83ARC-1170
84.It
85ARC-1110ML
86.It
87ARC-1120ML
88.It
89ARC-1130ML
90.It
91ARC-1160ML
92.It
93ARC-1200
94.It
95ARC-1201
96.It
97ARC-1203
98.It
99ARC-1210
100.It
101ARC-1212
102.It
103ARC-1213
104.It
105ARC-1214
106.It
107ARC-1216
108.It
109ARC-1220
110.It
111ARC-1222
112.It
113ARC-1223
114.It
115ARC-1224
116.It
117ARC-1226
118.It
119ARC-1230
120.It
121ARC-1231
122.It
123ARC-1260
124.It
125ARC-1261
126.It
127ARC-1270
128.It
129ARC-1280
130.It
131ARC-1210ML
132.It
133ARC-1220ML
134.It
135ARC-1231ML
136.It
137ARC-1261ML
138.It
139ARC-1280ML
140.It
141ARC-1380
142.It
143ARC-1381
144.It
145ARC-1680
146.It
147ARC-1681
148.It
149ARC-1880
150.It
151ARC-1882
152.It
153ARC-1883
154.It
155ARC-1884
156.It
157ARC-1886
158.El
159.Sh FILES
160.Bl -tag -width ".Pa /dev/arcmsr?" -compact
161.It Pa /dev/da?
162Array block device
163.It Pa /dev/arcmsr?
164Management interface
165.El
166.Sh SEE ALSO
167.Xr da 4 ,
168.Xr scbus 4
169.Sh HISTORY
170The
171.Nm
172driver first appeared in
173.Fx 5.4 .
174.Sh AUTHORS
175The driver was written by
176.An Erich Chen Aq Mt erich@areca.com.tw .
177.Sh BUGS
178The driver has been tested on i386 and amd64.
179It likely requires additional
180work to function on big-endian architectures.
181