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