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 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
  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 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-1180
  92 .It
  93 ARC-1110ML
  94 .It
  95 ARC-1120ML
  96 .It
  97 ARC-1130ML
  98 .It
  99 ARC-1160ML
 100 .It
 101 ARC-1210
 102 .It
 103 ARC-1220
 104 .It
 105 ARC-1230
 106 .It
 107 ARC-1260
 108 .It
 109 ARC-1280
 110 .It
 111 ARC-1210ML
 112 .It
 113 ARC-1220ML
 114 .It
 115 ARC-1231ML
 116 .It
 117 ARC-1261ML
 118 .It
 119 ARC-1280ML
 120 .It
 121 ARC-1680i
 122 .It
 123 ARC-1680x
 124 .It
 125 ARC-1680ix
 126 .It
 127 ARC-1680ixl
 128 .It
 129 ARC-1680LP
 130 .It
 131 ARC-1880i
 132 .It
 133 ARC-1880x
 134 .It
 135 ARC-1880ix
 136 .It
 137 ARC-1880ixl
 138 .El
 139 .Sh FILES
 140 .Bl -tag -width ".Pa /dev/arcmsr?" -compact
 141 .It Pa /dev/da?
 142 Array block device
 143 .It Pa /dev/arcmsr?
 144 Management interface
 145 .El
 146 .Sh SEE ALSO
 147 .Xr da 4 ,
 148 .Xr scbus 4
 149 .Sh HISTORY
 150 The
 151 .Nm
 152 driver first appeared in
 153 .Fx 5.4 .
 154 .Sh AUTHORS
 155 The driver was written by
 156 .An Erich Chen Aq erich@areca.com.tw .
 157 .Sh BUGS
 158 The driver has been tested on i386 and amd64.
 159 It likely requires additional
 160 work to function on big-endian architectures.