Document which drivers are using MSI and how it can be disabled.
[dragonfly.git] / share / man / man4 / mfi.4
CommitLineData
249d29c8
SW
1.\" Copyright (c) 2006 Scott Long
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD: src/share/man/man4/mfi.4,v 1.13 2010/05/12 17:12:38 brueffer Exp $
26.\"
5cee4cf5 27.Dd April 7, 2012
249d29c8
SW
28.Dt MFI 4
29.Os
30.Sh NAME
31.Nm mfi
32.Nd "LSI MegaRAID SAS driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device pci"
39.Cd "device mfi"
40.Ed
41.Pp
42Alternatively, to load the driver as a
43module at boot time, place the following line in
44.Xr loader.conf 5 :
45.Bd -literal -offset indent
46mfi_load="YES"
47.Ed
48.Sh DESCRIPTION
49This driver is for LSI's next generation PCI Express SAS RAID controllers.
50Access to RAID arrays (logical disks) from this driver is provided via
51.Pa /dev/mfid?
17566092
SW
52and access to JBOD disks is provided via
53.Pa /dev/mfisyspd?
249d29c8
SW
54device nodes.
55A simple management interface is also provided on a per-controller basis via
56the
57.Pa /dev/mfi?
58device node.
59.Pp
60The
61.Nm
62name is derived from the phrase "MegaRAID Firmware Interface", which is
63substantially different than the old "MegaRAID" interface and thus requires
64a new driver.
65Older SCSI and SATA MegaRAID cards are supported by
66.Xr amr 4
67and will not work with this driver.
68.Pp
17566092
SW
693 Gb/s and 6 Gb/s support both initiator target (IT) and integrated RAID (IR)
70firmware (see
71.Pa http://kb.lsi.com/KnowledgebaseArticle16266.aspx ) .
72The
73.Nm
74driver supports controllers with an IR image.
75At least some cards (such as the
76.Tn IBM ServeRAID M1015 )
77will attach to the
78.Xr mps 4
79driver when IT firmware is used.
80.Pp
249d29c8
SW
81Two sysctls are provided to tune the
82.Nm
83driver's behavior when a request is made to remove a mounted volume.
84By default the driver will disallow any requests to remove a mounted volume.
85If the sysctl
86.Va dev.mfi.%d.delete_busy_volumes
87is set to 1,
88then the driver will allow mounted volumes to be removed.
5cee4cf5
SW
89.Sh LOADER TUNABLES
90.Bl -tag -width indent
91.It Va hw.mfi.msi.enable
92By default, the driver will use MSI if it is supported.
93This behavior can be turned off by setting this tunable to 0.
94.El
249d29c8
SW
95.Sh HARDWARE
96The
97.Nm
98driver supports the following hardware:
99.Pp
100.Bl -bullet -compact
101.It
102LSI MegaRAID SAS 1078
103.It
104LSI MegaRAID SAS 8408E
105.It
106LSI MegaRAID SAS 8480E
107.It
17566092
SW
108LSI MegaRAID SAS 9240-4i
109.It
110LSI MegaRAID SAS 9240-8i
111.It
112LSI MegaRAID SAS 9260-4i
113.It
114LSI MegaRAID SAS 9260-8i
115.It
116LSI MegaRAID SAS 9260DE-8i
117.It
118LSI MegaRAID SAS 9260-16i
119.It
120LSI MegaRAID SAS 9261-8i
121.It
122LSI MegaRAID SAS 9280-4i4e
123.It
124LSI MegaRAID SAS 9280-8e
125.It
126LSI MegaRAID SAS 9280DE-8e
127.It
128LSI MegaRAID SAS 9280-16i4e
129.It
130LSI MegaRAID SAS 9280-24i4e
249d29c8
SW
131.It
132Dell PERC5
133.It
134Dell PERC6
135.It
590ba11d
SW
136Dell PERC H710 Embedded
137.It
138Dell PERC H710 Adapter
139.It
140Dell PERC H710 Mini (blades)
141.It
142Dell PERC H710 Mini (monolithics)
143.It
144Dell PERC H710P Adapter
145.It
146Dell PERC H710P Mini (blades)
147.It
148Dell PERC H710P Mini (monolithics)
149.It
150Dell PERC H810 Adapter
151.It
17566092
SW
152IBM ServeRAID M1015 SAS/SATA
153.It
249d29c8
SW
154IBM ServeRAID M5015 SAS/SATA
155.It
156IBM ServeRAID-MR10i
157.It
158Intel RAID Controller SROMBSAS18E
590ba11d
SW
159.It
160Intel RAID Controller RS25DB080
161.It
162Intel RAID Controller RS25NB008
249d29c8
SW
163.El
164.Sh FILES
17566092 165.Bl -tag -width ".Pa /dev/mfisyspd?" -compact
249d29c8
SW
166.It Pa /dev/mfid?
167array/logical disk interface
17566092
SW
168.It Pa /dev/mfisyspd?
169JBOD disk interface
249d29c8
SW
170.It Pa /dev/mfi?
171management interface
172.El
173.Sh DIAGNOSTICS
174.Bl -diag
175.It "mfid%d: Unable to delete busy device"
176An attempt was made to remove a mounted volume.
17566092
SW
177.It "mfisyspd%d: Unable to delete busy device"
178dito for JBOD disks
249d29c8
SW
179.El
180.Sh SEE ALSO
181.Xr amr 4 ,
17566092 182.Xr mps 4 ,
249d29c8
SW
183.Xr pci 4 ,
184.Xr mfiutil 8
185.Sh HISTORY
186The
187.Nm
188driver first appeared in
189.Fx 6.1 .
190.Sh AUTHORS
191The
192.Nm
193driver and this manual page were written by
194.An Scott Long Aq scottl@FreeBSD.org .
17566092
SW
195.\".Sh BUGS
196.\"The driver does not support big-endian architectures at this time.