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