share/man/man4/amr.4

   1 .\"
   2 .\" Copyright (c) 2000 Jeroen Ruigrok van der Werven
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD: src/share/man/man4/amr.4,v 1.35 2006/06/18 14:45:28 brueffer Exp $
  25 .\"
  26 .Dd December 10, 2014
  27 .Dt AMR 4
  28 .Os
  29 .Sh NAME
  30 .Nm amr
  31 .Nd MegaRAID SCSI/ATA/SATA RAID driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device pci"
  38 .Cd "device scbus"
  39 .Cd "device amr"
  40 .Ed
  41 .Pp
  42 To compile in debugging code:
  43 .Bd -ragged -offset indent
  44 .Cd options AMR_DEBUG=x # x=3 is maximum verbosity
  45 .Ed
  46 .Pp
  47 Alternatively, to load the driver as a
  48 module at boot time, place the following line in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 amr_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for LSI Logic MegaRAID SCSI, ATA and SATA
  57 RAID controllers and legacy American Megatrends MegaRAID
  58 SCSI RAID controllers, including models relabeled
  59 and sold by Dell and Hewlett-Packard.
  60 .Pp
  61 LSI MegaRAID SAS controllers are supported by
  62 .Xr mfi 4
  63 and
  64 .Xr mrsas 4
  65 and will not work with this driver.
  66 .Sh FILES
  67 .Bl -tag -width ".Pa /dev/amrdX" -compact
  68 .It Pa /dev/amrdX
  69 .Nm
  70 device nodes
  71 .El
  72 .Sh HARDWARE
  73 Controllers supported by the
  74 .Nm
  75 driver include:
  76 .Pp
  77 .Bl -bullet -compact
  78 .It
  79 MegaRAID SATA 150-4
  80 .It
  81 MegaRAID SATA 150-6
  82 .It
  83 MegaRAID SATA 300-4X
  84 .It
  85 MegaRAID SATA 300-8X
  86 .It
  87 MegaRAID SCSI 320-1E
  88 .It
  89 MegaRAID SCSI 320-2E
  90 .It
  91 MegaRAID SCSI 320-4E
  92 .It
  93 MegaRAID SCSI 320-0X
  94 .It
  95 MegaRAID SCSI 320-2X
  96 .It
  97 MegaRAID SCSI 320-4X
  98 .It
  99 MegaRAID SCSI 320-0
 100 .It
 101 MegaRAID SCSI 320-1
 102 .It
 103 MegaRAID SCSI 320-2
 104 .It
 105 MegaRAID SCSI 320-4
 106 .It
 107 MegaRAID Series 418
 108 .It
 109 MegaRAID i4 133 RAID
 110 .It
 111 MegaRAID Elite 1500 (Series 467)
 112 .It
 113 MegaRAID Elite 1600 (Series 493)
 114 .It
 115 MegaRAID Elite 1650 (Series 4xx)
 116 .It
 117 MegaRAID Enterprise 1200 (Series 428)
 118 .It
 119 MegaRAID Enterprise 1300 (Series 434)
 120 .It
 121 MegaRAID Enterprise 1400 (Series 438)
 122 .It
 123 MegaRAID Enterprise 1500 (Series 467)
 124 .It
 125 MegaRAID Enterprise 1600 (Series 471)
 126 .It
 127 MegaRAID Express 100 (Series 466WS)
 128 .It
 129 MegaRAID Express 200 (Series 466)
 130 .It
 131 MegaRAID Express 300 (Series 490)
 132 .It
 133 MegaRAID Express 500 (Series 475)
 134 .It
 135 Dell PERC
 136 .It
 137 Dell PERC 2/SC
 138 .It
 139 Dell PERC 2/DC
 140 .It
 141 Dell PERC 3/DCL
 142 .It
 143 Dell PERC 3/QC
 144 .It
 145 Dell PERC 4/DC
 146 .It
 147 Dell PERC 4/IM
 148 .It
 149 Dell PERC 4/SC
 150 .It
 151 Dell PERC 4/Di
 152 .It
 153 Dell PERC 4e/DC
 154 .It
 155 Dell PERC 4e/Di
 156 .It
 157 Dell PERC 4e/Si
 158 .It
 159 Dell PERC 4ei
 160 .It
 161 HP NetRAID-1/Si
 162 .It
 163 HP NetRAID-3/Si (D4943A)
 164 .It
 165 HP Embedded NetRAID
 166 .It
 167 Intel RAID Controller SRCS16
 168 .It
 169 Intel RAID Controller SRCU42X
 170 .El
 171 .Sh DIAGNOSTICS
 172 Compiling with
 173 .Dv AAC_DEBUG
 174 will enable debug messages.
 175 .Ss Driver initialisation/shutdown phase
 176 .Bl -diag
 177 .It amr%d: memory window not available
 178 .It amr%d: I/O window not available
 179 .Pp
 180 The PCI BIOS did not allocate resources necessary for the correct operation of
 181 the controller.
 182 The driver cannot attach to this controller.
 183 .It amr%d: busmaster bit not set, enabling
 184 .Pp
 185 The PCI BIOS did not enable busmaster DMA,
 186 which is required for the correct operation of the controller.
 187 The driver has enabled this bit and initialisation will proceed.
 188 .It amr%d: can't allocate register window
 189 .It amr%d: can't allocate interrupt
 190 .It amr%d: can't set up interrupt
 191 .It amr%d: can't allocate parent DMA tag
 192 .It amr%d: can't allocate buffer DMA tag
 193 .It amr%d: can't allocate scatter/gather DMA tag
 194 .It amr%d: can't allocate s/g table
 195 .It amr%d: can't allocate mailbox tag
 196 .It amr%d: can't allocate mailbox memory
 197 .Pp
 198 A resource allocation error occurred while initialising the driver;
 199 initialisation has failed and the driver will not attach to this controller.
 200 .It amr%d: can't obtain configuration data from controller
 201 .It amr%d: can't obtain product data from controller
 202 .Pp
 203 The driver was unable to obtain vital configuration data from the controller.
 204 Initialisation has failed and the driver will not attach to this controller.
 205 .It amr%d: can't establish configuration hook
 206 .It amr%d: can't scan controller for drives
 207 .Pp
 208 The scan for logical drives managed by the controller failed.
 209 No drives will be attached.
 210 .It amr%d: device_add_child failed
 211 .It amr%d: bus_generic_attach returned %d
 212 .Pp
 213 Creation of the logical drive instances failed;
 214 attachment of one or more logical drives may have been aborted.
 215 .It amr%d: flushing cache...
 216 .Pp
 217 The controller cache is being flushed prior to shutdown or detach.
 218 .El
 219 .Ss Operational diagnostics
 220 .Bl -diag
 221 .It amr%d: I/O beyond end of unit (%u,%d > %u)
 222 .Pp
 223 A partitioning error or disk corruption has caused an I/O request
 224 beyond the end of the logical drive.
 225 This may also occur if FlexRAID Virtual Sizing is enabled and
 226 an I/O operation is attempted on a portion of the virtual drive
 227 beyond the actual capacity available.
 228 .It amr%d: polled command timeout
 229 .Pp
 230 An initialisation command timed out.
 231 The initialisation process may fail as a result.
 232 .It amr%d: bad slot %d completed
 233 .Pp
 234 The controller reported completion of a command that the driver did not issue.
 235 This may result in data corruption,
 236 and suggests a hardware or firmware problem with the system or controller.
 237 .It amr%d: I/O error - %x
 238 .Pp
 239 An I/O error has occurred.
 240 .El
 241 .Sh SEE ALSO
 242 .Xr cd 4 ,
 243 .Xr da 4 ,
 244 .Xr mfi 4 ,
 245 .Xr mrsas 4 ,
 246 .Xr sa 4 ,
 247 .Xr scsi 4
 248 .Sh AUTHORS
 249 .An -nosplit
 250 The
 251 .Nm
 252 driver was written by
 253 .An Mike Smith Aq Mt msmith@FreeBSD.org .
 254 .Pp
 255 This manual page was written by
 256 .An Mike Smith Aq Mt msmith@FreeBSD.org
 257 and
 258 .An Jeroen Ruigrok van der Werven Aq Mt asmodai@FreeBSD.org .