a49dcd4554701bb239d7557b2a8fb9a73eea8e58
[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 November 30, 2010
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 device nodes.
53 A simple management interface is also provided on a per-controller basis via
54 the
55 .Pa /dev/mfi?
56 device node.
57 .Pp
58 The
59 .Nm
60 name is derived from the phrase "MegaRAID Firmware Interface", which is
61 substantially different than the old "MegaRAID" interface and thus requires
62 a new driver.
63 Older SCSI and SATA MegaRAID cards are supported by
64 .Xr amr 4
65 and will not work with this driver.
66 .Pp
67 Two sysctls are provided to tune the
68 .Nm
69 driver's behavior when a request is made to remove a mounted volume.
70 By default the driver will disallow any requests to remove a mounted volume.
71 If the sysctl
72 .Va dev.mfi.%d.delete_busy_volumes
73 is set to 1,
74 then the driver will allow mounted volumes to be removed.
75 .Sh HARDWARE
76 The
77 .Nm
78 driver supports the following hardware:
79 .Pp
80 .Bl -bullet -compact
81 .It
82 LSI MegaRAID SAS 1078
83 .It
84 LSI MegaRAID SAS 8408E
85 .It
86 LSI MegaRAID SAS 8480E
87 .It
88 LSI MegaRAID SAS 9260
89 .It
90 Dell PERC5
91 .It
92 Dell PERC6
93 .It
94 IBM ServeRAID M5015 SAS/SATA
95 .It
96 IBM ServeRAID-MR10i
97 .It
98 Intel RAID Controller SROMBSAS18E
99 .El
100 .Sh FILES
101 .Bl -tag -width ".Pa /dev/mfid?" -compact
102 .It Pa /dev/mfid?
103 array/logical disk interface
104 .It Pa /dev/mfi?
105 management interface
106 .El
107 .Sh DIAGNOSTICS
108 .Bl -diag
109 .It "mfid%d: Unable to delete busy device"
110 An attempt was made to remove a mounted volume.
111 .El
112 .Sh SEE ALSO
113 .Xr amr 4 ,
114 .Xr pci 4 ,
115 .Xr mfiutil 8
116 .Sh HISTORY
117 The
118 .Nm
119 driver first appeared in
120 .Fx 6.1 .
121 .Sh AUTHORS
122 The
123 .Nm
124 driver and this manual page were written by
125 .An Scott Long Aq scottl@FreeBSD.org .
126 .Sh BUGS
127 The driver does not support big-endian architectures at this time.