amr.4: Add missing .Bd
[dragonfly.git] / share / man / man4 / amr.4
CommitLineData
984263bc
MD
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.\"
1fcd0ba2 24.\" $FreeBSD: src/share/man/man4/amr.4,v 1.35 2006/06/18 14:45:28 brueffer Exp $
984263bc 25.\"
2063b358 26.Dd July 11, 2012
984263bc
MD
27.Dt AMR 4
28.Os
29.Sh NAME
30.Nm amr
1fcd0ba2 31.Nd MegaRAID SCSI/ATA/SATA RAID driver
984263bc 32.Sh SYNOPSIS
1fcd0ba2
SW
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device pci"
38.Cd "device scbus"
39.Cd "device amr"
40.Ed
41.Pp
2063b358 42To compile in debugging code:
14a57dc9 43.Bd -ragged -offset indent
2063b358
SW
44.Cd options AMR_DEBUG=x # x=3 is maximum verbosity
45.Ed
46.Pp
1fcd0ba2
SW
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51amr_load="YES"
52.Ed
984263bc
MD
53.Sh DESCRIPTION
54The
55.Nm
1fcd0ba2
SW
56driver provides support for LSI Logic MegaRAID SCSI, ATA and SATA
57RAID controllers and legacy American Megatrends MegaRAID
58SCSI RAID controllers, including models relabeled
59and sold by Dell and Hewlett-Packard.
249d29c8
SW
60.Pp
61LSI MegaRAID SAS controllers are supported by
62.Xr mfi 4
63and will not work with this driver.
1fcd0ba2
SW
64.Sh HARDWARE
65Controllers supported by the
66.Nm
67driver include:
249d29c8 68.Pp
1fcd0ba2
SW
69.Bl -bullet -compact
70.It
71MegaRAID SATA 150-4
72.It
73MegaRAID SATA 150-6
74.It
75MegaRAID SATA 300-4X
76.It
77MegaRAID SATA 300-8X
78.It
79MegaRAID SCSI 320-1E
80.It
81MegaRAID SCSI 320-2E
82.It
83MegaRAID SCSI 320-4E
984263bc 84.It
1fcd0ba2 85MegaRAID SCSI 320-0X
984263bc 86.It
1fcd0ba2
SW
87MegaRAID SCSI 320-2X
88.It
89MegaRAID SCSI 320-4X
90.It
91MegaRAID SCSI 320-0
92.It
93MegaRAID SCSI 320-1
94.It
95MegaRAID SCSI 320-2
96.It
97MegaRAID SCSI 320-4
984263bc
MD
98.It
99MegaRAID Series 418
100.It
1fcd0ba2
SW
101MegaRAID i4 133 RAID
102.It
103MegaRAID Elite 1500 (Series 467)
104.It
105MegaRAID Elite 1600 (Series 493)
106.It
107MegaRAID Elite 1650 (Series 4xx)
108.It
984263bc
MD
109MegaRAID Enterprise 1200 (Series 428)
110.It
111MegaRAID Enterprise 1300 (Series 434)
112.It
113MegaRAID Enterprise 1400 (Series 438)
114.It
115MegaRAID Enterprise 1500 (Series 467)
116.It
117MegaRAID Enterprise 1600 (Series 471)
118.It
984263bc
MD
119MegaRAID Express 100 (Series 466WS)
120.It
121MegaRAID Express 200 (Series 466)
122.It
123MegaRAID Express 300 (Series 490)
124.It
125MegaRAID Express 500 (Series 475)
126.It
127Dell PERC
128.It
129Dell PERC 2/SC
130.It
131Dell PERC 2/DC
132.It
1fcd0ba2
SW
133Dell PERC 3/DCL
134.It
135Dell PERC 3/QC
136.It
137Dell PERC 4/DC
138.It
139Dell PERC 4/IM
140.It
141Dell PERC 4/SC
142.It
143Dell PERC 4/Di
144.It
145Dell PERC 4e/DC
146.It
147Dell PERC 4e/Di
148.It
149Dell PERC 4e/Si
150.It
151Dell PERC 4ei
152.It
984263bc
MD
153HP NetRAID-1/Si
154.It
1fcd0ba2 155HP NetRAID-3/Si (D4943A)
984263bc
MD
156.It
157HP Embedded NetRAID
1fcd0ba2
SW
158.It
159Intel RAID Controller SRCS16
160.It
161Intel RAID Controller SRCU42X
984263bc
MD
162.El
163.Sh DIAGNOSTICS
2063b358
SW
164Compiling with
165.Dv AAC_DEBUG
166will enable debug messages.
984263bc
MD
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
172The PCI BIOS did not allocate resources necessary for the correct operation of
173the controller.
174The driver cannot attach to this controller.
175.It amr%d: busmaster bit not set, enabling
176.Pp
177The PCI BIOS did not enable busmaster DMA,
178which is required for the correct operation of the controller.
179The 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
190A resource allocation error occurred while initialising the driver;
191initialisation 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
195The driver was unable to obtain vital configuration data from the controller.
196Initialisation 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
200The scan for logical drives managed by the controller failed.
201No drives will be attached.
202.It amr%d: device_add_child failed
203.It amr%d: bus_generic_attach returned %d
204.Pp
205Creation of the logical drive instances failed;
206attachment of one or more logical drives may have been aborted.
207.It amr%d: flushing cache...
208.Pp
209The 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
215A partitioning error or disk corruption has caused an I/O request
216beyond the end of the logical drive.
217This may also occur if FlexRAID Virtual Sizing is enabled and
218an I/O operation is attempted on a portion of the virtual drive
219beyond the actual capacity available.
220.It amr%d: polled command timeout
221.Pp
222An initialisation command timed out.
223The initialisation process may fail as a result.
224.It amr%d: bad slot %d completed
225.Pp
226The controller reported completion of a command that the driver did not issue.
227This may result in data corruption,
228and suggests a hardware or firmware problem with the system or controller.
229.It amr%d: I/O error - %x
230.Pp
231An I/O error has occurred.
232.El
233.Sh SEE ALSO
234.Xr cd 4 ,
235.Xr da 4 ,
249d29c8 236.Xr mfi 4 ,
984263bc
MD
237.Xr sa 4 ,
238.Xr scsi 4
239.Sh AUTHORS
240.An -nosplit
241The
242.Nm
243driver was written by
1fcd0ba2 244.An Mike Smith Aq msmith@FreeBSD.org .
984263bc
MD
245.Pp
246This manual page was written by
1fcd0ba2 247.An Mike Smith Aq msmith@FreeBSD.org
984263bc 248and
1fcd0ba2 249.An Jeroen Ruigrok van der Werven Aq asmodai@FreeBSD.org .