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