Bring in arcmsr(4), a driver for Areca RAID controllers.
[dragonfly.git] / share / man / man4 / arcmsr.4
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 August 24, 2010
28 .Dt ARCMSR 4
29 .Os
30 .Sh NAME
31 .Nm arcmsr
32 .Nd Areca SATA II RAID Controller driver
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel 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
44 Alternatively, to load the driver as a
45 module at boot time, place the following line in
46 .Xr loader.conf 5 :
47 .Bd -literal -offset indent
48 arcmsr_load="YES"
49 .Ed
50 .Sh DESCRIPTION
51 The
52 .Nm
53 driver provides support for the Areca ARC-11xx and ARC-12xx series of SATA II
54 RAID controllers.
55 These controllers feature RAID-0, 1, 3, 5, 6, and 10 and
56 JBOD acceleration for up to 16 SATA drives.
57 Raid level and stripe level
58 migration, online capacity expansion, hot insertion/removal, automatic failover
59 and rebuild, and SMART are also supported.
60 Access to the arrays is provided
61 via the SCSI CAM
62 .Pa /dev/da?
63 device nodes.
64 A management interface is also present via the
65 .Pa /dev/arcmsr?
66 device node.
67 Management tools for i386 and amd64 are available from Areca.
68 .Sh HARDWARE
69 The
70 .Nm
71 driver supports the following cards:
72 .Pp
73 .Bl -bullet -compact
74 .It
75 ARC-1110
76 .It
77 ARC-1120
78 .It
79 ARC-1130
80 .It
81 ARC-1160
82 .It
83 ARC-1170
84 .It
85 ARC-1180
86 .It
87 ARC-1110ML
88 .It
89 ARC-1120ML
90 .It
91 ARC-1130ML
92 .It
93 ARC-1160ML
94 .It
95 ARC-1210
96 .It
97 ARC-1220
98 .It
99 ARC-1230
100 .It
101 ARC-1260
102 .It
103 ARC-1280
104 .It
105 ARC-1210ML
106 .It
107 ARC-1220ML
108 .It
109 ARC-1231ML
110 .It
111 ARC-1261ML
112 .It
113 ARC-1280ML
114 .El
115 .Sh FILES
116 .Bl -tag -width ".Pa /dev/arcmsr?" -compact
117 .It Pa /dev/da?
118 Array block device
119 .It Pa /dev/arcmsr?
120 Management interface
121 .El
122 .Sh SEE ALSO
123 .Xr da 4 ,
124 .Xr scbus 4
125 .Sh HISTORY
126 The
127 .Nm
128 driver first appeared in
129 .Fx 5.4 .
130 .Sh AUTHORS
131 The driver was written by
132 .An Erich Chen Aq erich@areca.com.tw .
133 .Sh BUGS
134 The driver has been tested on i386 and amd64.
135 It likely requires additional
136 work to function on big-endian architectures.