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