ffad85e590bc241dbed98fe75ff6e79c6dbd46e6
[dragonfly.git] / share / man / man4 / mfi.4
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 .\"
27 .Dd August 11, 2011
28 .Dt MFI 4
29 .Os
30 .Sh NAME
31 .Nm mfi
32 .Nd "LSI MegaRAID SAS driver"
33 .Sh SYNOPSIS
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
38 .Cd "device pci"
39 .Cd "device mfi"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 mfi_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 This driver is for LSI's next generation PCI Express SAS RAID controllers.
50 Access to RAID arrays (logical disks) from this driver is provided via
51 .Pa /dev/mfid?
52 and access to JBOD disks is provided via
53 .Pa /dev/mfisyspd?
54 device nodes.
55 A simple management interface is also provided on a per-controller basis via
56 the
57 .Pa /dev/mfi?
58 device node.
59 .Pp
60 The
61 .Nm
62 name is derived from the phrase "MegaRAID Firmware Interface", which is
63 substantially different than the old "MegaRAID" interface and thus requires
64 a new driver.
65 Older SCSI and SATA MegaRAID cards are supported by
66 .Xr amr 4
67 and will not work with this driver.
68 .Pp
69 3 Gb/s and 6 Gb/s support both initiator target (IT) and integrated RAID (IR)
70 firmware (see
71 .Pa http://kb.lsi.com/KnowledgebaseArticle16266.aspx ) .
72 The
73 .Nm
74 driver supports controllers with an IR image.
75 At least some cards (such as the
76 .Tn IBM ServeRAID M1015 )
77 will attach to the
78 .Xr mps 4
79 driver when IT firmware is used.
80 .Pp
81 Two sysctls are provided to tune the
82 .Nm
83 driver's behavior when a request is made to remove a mounted volume.
84 By default the driver will disallow any requests to remove a mounted volume.
85 If the sysctl
86 .Va dev.mfi.%d.delete_busy_volumes
87 is set to 1,
88 then the driver will allow mounted volumes to be removed.
89 .Sh HARDWARE
90 The
91 .Nm
92 driver supports the following hardware:
93 .Pp
94 .Bl -bullet -compact
95 .It
96 LSI MegaRAID SAS 1078
97 .It
98 LSI MegaRAID SAS 8408E
99 .It
100 LSI MegaRAID SAS 8480E
101 .It
102 LSI MegaRAID SAS 9240-4i
103 .It
104 LSI MegaRAID SAS 9240-8i
105 .It
106 LSI MegaRAID SAS 9260-4i
107 .It
108 LSI MegaRAID SAS 9260-8i
109 .It
110 LSI MegaRAID SAS 9260DE-8i
111 .It
112 LSI MegaRAID SAS 9260-16i
113 .It
114 LSI MegaRAID SAS 9261-8i
115 .It
116 LSI MegaRAID SAS 9280-4i4e
117 .It
118 LSI MegaRAID SAS 9280-8e
119 .It
120 LSI MegaRAID SAS 9280DE-8e
121 .It
122 LSI MegaRAID SAS 9280-16i4e
123 .It
124 LSI MegaRAID SAS 9280-24i4e
125 .It
126 Dell PERC5
127 .It
128 Dell PERC6
129 .It
130 IBM ServeRAID M1015 SAS/SATA
131 .It
132 IBM ServeRAID M5015 SAS/SATA
133 .It
134 IBM ServeRAID-MR10i
135 .It
136 Intel RAID Controller SROMBSAS18E
137 .El
138 .Sh FILES
139 .Bl -tag -width ".Pa /dev/mfisyspd?" -compact
140 .It Pa /dev/mfid?
141 array/logical disk interface
142 .It Pa /dev/mfisyspd?
143 JBOD disk interface
144 .It Pa /dev/mfi?
145 management interface
146 .El
147 .Sh DIAGNOSTICS
148 .Bl -diag
149 .It "mfid%d: Unable to delete busy device"
150 An attempt was made to remove a mounted volume.
151 .It "mfisyspd%d: Unable to delete busy device"
152 dito for JBOD disks
153 .El
154 .Sh SEE ALSO
155 .Xr amr 4 ,
156 .Xr mps 4 ,
157 .Xr pci 4 ,
158 .Xr mfiutil 8
159 .Sh HISTORY
160 The
161 .Nm
162 driver first appeared in
163 .Fx 6.1 .
164 .Sh AUTHORS
165 The
166 .Nm
167 driver and this manual page were written by
168 .An Scott Long Aq scottl@FreeBSD.org .
169 .\".Sh BUGS
170 .\"The driver does not support big-endian architectures at this time.