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: head/share/man/man4/arcmsr.4 259564 2013-12-18 19:23:05Z delphij $
  26 .\"
  27 .Dd November 6, 2017
  28 .Dt ARCMSR 4
  29 .Os
  30 .Sh NAME
  31 .Nm arcmsr
  32 .Nd Areca 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, ARC-12xx, ARC-13xx,
  54 ARC-16xx and ARC-18xx series of SAS and SATA 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 LOADER TUNABLES
  69 .Bl -tag -width indent
  70 .It Va hw.arcmsr.msi.enable
  71 By default, the driver will use MSI if it is supported.
  72 This behavior can be turned off by setting this tunable to 0.
  73 .El
  74 .Sh HARDWARE
  75 The
  76 .Nm
  77 driver supports the following cards:
  78 .Pp
  79 .Bl -bullet -compact
  80 .It
  81 ARC-1110
  82 .It
  83 ARC-1120
  84 .It
  85 ARC-1130
  86 .It
  87 ARC-1160
  88 .It
  89 ARC-1170
  90 .It
  91 ARC-1110ML
  92 .It
  93 ARC-1120ML
  94 .It
  95 ARC-1130ML
  96 .It
  97 ARC-1160ML
  98 .It
  99 ARC-1200
 100 .It
 101 ARC-1201
 102 .It
 103 ARC-1203
 104 .It
 105 ARC-1210
 106 .It
 107 ARC-1212
 108 .It
 109 ARC-1213
 110 .It
 111 ARC-1214
 112 .It
 113 ARC-1216
 114 .It
 115 ARC-1220
 116 .It
 117 ARC-1222
 118 .It
 119 ARC-1223
 120 .It
 121 ARC-1224
 122 .It
 123 ARC-1226
 124 .It
 125 ARC-1230
 126 .It
 127 ARC-1231
 128 .It
 129 ARC-1260
 130 .It
 131 ARC-1261
 132 .It
 133 ARC-1264
 134 .It
 135 ARC-1270
 136 .It
 137 ARC-1280
 138 .It
 139 ARC-1284
 140 .It
 141 ARC-1210ML
 142 .It
 143 ARC-1220ML
 144 .It
 145 ARC-1231ML
 146 .It
 147 ARC-1261ML
 148 .It
 149 ARC-1280ML
 150 .It
 151 ARC-1380
 152 .It
 153 ARC-1381
 154 .It
 155 ARC-1680i
 156 .It
 157 ARC-1680x
 158 .It
 159 ARC-1680ix
 160 .It
 161 ARC-1680ixl
 162 .It
 163 ARC-1680LP
 164 .It
 165 ARC-1681
 166 .It
 167 ARC-1880i
 168 .It
 169 ARC-1880x
 170 .It
 171 ARC-1880ix
 172 .It
 173 ARC-1880ixl
 174 .It
 175 ARC-1882
 176 .It
 177 ARC-1883
 178 .It
 179 ARC-1884
 180 .El
 181 .Sh FILES
 182 .Bl -tag -width ".Pa /dev/arcmsr?" -compact
 183 .It Pa /dev/da?
 184 Array block device
 185 .It Pa /dev/arcmsr?
 186 Management interface
 187 .El
 188 .Sh SEE ALSO
 189 .Xr da 4 ,
 190 .Xr scbus 4
 191 .Sh HISTORY
 192 The
 193 .Nm
 194 driver first appeared in
 195 .Fx 5.4 .
 196 .Sh AUTHORS
 197 The driver was written by
 198 .An Erich Chen Aq Mt erich@areca.com.tw .
 199 .Sh BUGS
 200 The driver has been tested on i386 and amd64.
 201 It likely requires additional
 202 work to function on big-endian architectures.