8ddc092a4ada838bcde8e5513a7f70af1f9e6555
[dragonfly.git] / 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 July 11, 2012
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 .Cd options AMR_DEBUG=x # x=3 is maximum verbosity
44 .Ed
45 .Pp
46 Alternatively, to load the driver as a
47 module at boot time, place the following line in
48 .Xr loader.conf 5 :
49 .Bd -literal -offset indent
50 amr_load="YES"
51 .Ed
52 .Sh DESCRIPTION
53 The
54 .Nm
55 driver provides support for LSI Logic MegaRAID SCSI, ATA and SATA
56 RAID controllers and legacy American Megatrends MegaRAID
57 SCSI RAID controllers, including models relabeled
58 and sold by Dell and Hewlett-Packard.
59 .Pp
60 LSI MegaRAID SAS controllers are supported by
61 .Xr mfi 4
62 and will not work with this driver.
63 .Sh HARDWARE
64 Controllers supported by the
65 .Nm
66 driver include:
67 .Pp
68 .Bl -bullet -compact
69 .It
70 MegaRAID SATA 150-4
71 .It
72 MegaRAID SATA 150-6
73 .It
74 MegaRAID SATA 300-4X
75 .It
76 MegaRAID SATA 300-8X
77 .It
78 MegaRAID SCSI 320-1E
79 .It
80 MegaRAID SCSI 320-2E
81 .It
82 MegaRAID SCSI 320-4E
83 .It
84 MegaRAID SCSI 320-0X
85 .It
86 MegaRAID SCSI 320-2X
87 .It
88 MegaRAID SCSI 320-4X
89 .It
90 MegaRAID SCSI 320-0
91 .It
92 MegaRAID SCSI 320-1
93 .It
94 MegaRAID SCSI 320-2
95 .It
96 MegaRAID SCSI 320-4
97 .It
98 MegaRAID Series 418
99 .It
100 MegaRAID i4 133 RAID
101 .It
102 MegaRAID Elite 1500 (Series 467)
103 .It
104 MegaRAID Elite 1600 (Series 493)
105 .It
106 MegaRAID Elite 1650 (Series 4xx)
107 .It
108 MegaRAID Enterprise 1200 (Series 428)
109 .It
110 MegaRAID Enterprise 1300 (Series 434)
111 .It
112 MegaRAID Enterprise 1400 (Series 438)
113 .It
114 MegaRAID Enterprise 1500 (Series 467)
115 .It
116 MegaRAID Enterprise 1600 (Series 471)
117 .It
118 MegaRAID Express 100 (Series 466WS)
119 .It
120 MegaRAID Express 200 (Series 466)
121 .It
122 MegaRAID Express 300 (Series 490)
123 .It
124 MegaRAID Express 500 (Series 475)
125 .It
126 Dell PERC
127 .It
128 Dell PERC 2/SC
129 .It
130 Dell PERC 2/DC
131 .It
132 Dell PERC 3/DCL
133 .It
134 Dell PERC 3/QC
135 .It
136 Dell PERC 4/DC
137 .It
138 Dell PERC 4/IM
139 .It
140 Dell PERC 4/SC
141 .It
142 Dell PERC 4/Di
143 .It
144 Dell PERC 4e/DC
145 .It
146 Dell PERC 4e/Di
147 .It
148 Dell PERC 4e/Si
149 .It
150 Dell PERC 4ei
151 .It
152 HP NetRAID-1/Si
153 .It
154 HP NetRAID-3/Si (D4943A)
155 .It
156 HP Embedded NetRAID
157 .It
158 Intel RAID Controller SRCS16
159 .It
160 Intel RAID Controller SRCU42X
161 .El
162 .Sh DIAGNOSTICS
163 Compiling with
164 .Dv AAC_DEBUG
165 will enable debug messages.
166 .Ss Driver initialisation/shutdown phase
167 .Bl -diag
168 .It amr%d: memory window not available
169 .It amr%d: I/O window not available
170 .Pp
171 The PCI BIOS did not allocate resources necessary for the correct operation of
172 the controller.
173 The driver cannot attach to this controller.
174 .It amr%d: busmaster bit not set, enabling
175 .Pp
176 The PCI BIOS did not enable busmaster DMA,
177 which is required for the correct operation of the controller.
178 The driver has enabled this bit and initialisation will proceed.
179 .It amr%d: can't allocate register window
180 .It amr%d: can't allocate interrupt
181 .It amr%d: can't set up interrupt
182 .It amr%d: can't allocate parent DMA tag
183 .It amr%d: can't allocate buffer DMA tag
184 .It amr%d: can't allocate scatter/gather DMA tag
185 .It amr%d: can't allocate s/g table
186 .It amr%d: can't allocate mailbox tag
187 .It amr%d: can't allocate mailbox memory
188 .Pp
189 A resource allocation error occurred while initialising the driver;
190 initialisation has failed and the driver will not attach to this controller.
191 .It amr%d: can't obtain configuration data from controller
192 .It amr%d: can't obtain product data from controller
193 .Pp
194 The driver was unable to obtain vital configuration data from the controller.
195 Initialisation has failed and the driver will not attach to this controller.
196 .It amr%d: can't establish configuration hook
197 .It amr%d: can't scan controller for drives
198 .Pp
199 The scan for logical drives managed by the controller failed.
200 No drives will be attached.
201 .It amr%d: device_add_child failed
202 .It amr%d: bus_generic_attach returned %d
203 .Pp
204 Creation of the logical drive instances failed;
205 attachment of one or more logical drives may have been aborted.
206 .It amr%d: flushing cache...
207 .Pp
208 The controller cache is being flushed prior to shutdown or detach.
209 .El
210 .Ss Operational diagnostics
211 .Bl -diag
212 .It amr%d: I/O beyond end of unit (%u,%d > %u)
213 .Pp
214 A partitioning error or disk corruption has caused an I/O request
215 beyond the end of the logical drive.
216 This may also occur if FlexRAID Virtual Sizing is enabled and
217 an I/O operation is attempted on a portion of the virtual drive
218 beyond the actual capacity available.
219 .It amr%d: polled command timeout
220 .Pp
221 An initialisation command timed out.
222 The initialisation process may fail as a result.
223 .It amr%d: bad slot %d completed
224 .Pp
225 The controller reported completion of a command that the driver did not issue.
226 This may result in data corruption,
227 and suggests a hardware or firmware problem with the system or controller.
228 .It amr%d: I/O error - %x
229 .Pp
230 An I/O error has occurred.
231 .El
232 .Sh SEE ALSO
233 .Xr cd 4 ,
234 .Xr da 4 ,
235 .Xr mfi 4 ,
236 .Xr sa 4 ,
237 .Xr scsi 4
238 .Sh AUTHORS
239 .An -nosplit
240 The
241 .Nm
242 driver was written by
243 .An Mike Smith Aq msmith@FreeBSD.org .
244 .Pp
245 This manual page was written by
246 .An Mike Smith Aq msmith@FreeBSD.org
247 and
248 .An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org .