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