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