xref: /freebsd/share/man/man4/mfi.4 (revision 3416500aef140042c64bc149cb1ec6620483bc44)
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$
26.\"
27.Dd July 15, 2013
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?
52device nodes.
53A simple management interface is also provided on a per-controller basis via
54the
55.Pa /dev/mfi?
56device node.
57.Pp
58The
59.Nm
60name is derived from the phrase "MegaRAID Firmware Interface", which is
61substantially different than the old "MegaRAID" interface and thus requires
62a new driver.
63Older SCSI and SATA MegaRAID cards are supported by
64.Xr amr 4
65and will not work with this driver.
66.Pp
67Two sysctls are provided to tune the
68.Nm
69driver's behavior when a request is made to remove a mounted volume.
70By default the driver will disallow any requests to remove a mounted volume.
71If the sysctl
72.Va dev.mfi.%d.delete_busy_volumes
73is set to 1,
74then the driver will allow mounted volumes to be removed.
75.Pp
76A tunable is provided to adjust the
77.Nm
78driver's behaviour when attaching to a card.
79By default the driver will attach to all known cards with high probe priority.
80If the tunable
81.Va hw.mfi.mrsas_enable
82is set to 1,
83then the driver will reduce its probe priority to allow
84.Cd mrsas
85to attach to the card instead of
86.Nm .
87.Sh HARDWARE
88The
89.Nm
90driver supports the following hardware:
91.Pp
92.Bl -bullet -compact
93.It
94LSI MegaRAID SAS 1078
95.It
96LSI MegaRAID SAS 8408E
97.It
98LSI MegaRAID SAS 8480E
99.It
100LSI MegaRAID SAS 9240
101.It
102LSI MegaRAID SAS 9260
103.It
104Dell PERC5
105.It
106Dell PERC6
107.It
108IBM ServeRAID M1015 SAS/SATA
109.It
110IBM ServeRAID M1115 SAS/SATA
111.It
112IBM ServeRAID M5015 SAS/SATA
113.It
114IBM ServeRAID M5110 SAS/SATA
115.It
116IBM ServeRAID-MR10i
117.It
118Intel RAID Controller SRCSAS18E
119.It
120Intel RAID Controller SROMBSAS18E
121.El
122.Sh FILES
123.Bl -tag -width ".Pa /dev/mfid?" -compact
124.It Pa /dev/mfid?
125array/logical disk interface
126.It Pa /dev/mfi?
127management interface
128.El
129.Sh DIAGNOSTICS
130.Bl -diag
131.It "mfid%d: Unable to delete busy device"
132An attempt was made to remove a mounted volume.
133.El
134.Sh SEE ALSO
135.Xr amr 4 ,
136.Xr pci 4 ,
137.Xr mfiutil 8
138.Sh HISTORY
139The
140.Nm
141driver first appeared in
142.Fx 6.1 .
143.Sh AUTHORS
144The
145.Nm
146driver and this manual page were written by
147.An Scott Long Aq Mt scottl@FreeBSD.org .
148.Sh BUGS
149The driver does not support big-endian architectures at this time.
150