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 28, 2014
  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 .Pp
  66 Older SCSI and SATA MegaRAID cards are supported by
  67 .Xr amr 4
  68 and will not work with this driver.
  69 Likewise, newer LSI MegaRAID SAS controllers are supported by
  70 .Xr mrsas 4
  71 and will not work with this driver.
  72 .Pp
  73 3 Gb/s and 6 Gb/s support both initiator target (IT) and integrated RAID (IR)
  74 firmware (see
  75 .Pa http://kb.lsi.com/KnowledgebaseArticle16266.aspx ) .
  76 The
  77 .Nm
  78 driver supports controllers with an IR image.
  79 At least some cards (such as the
  80 .Tn IBM ServeRAID M1015 )
  81 will attach to the
  82 .Xr mps 4
  83 driver when IT firmware is used.
  84 .Pp
  85 Two sysctls are provided to tune the
  86 .Nm
  87 driver's behavior when a request is made to remove a mounted volume.
  88 By default the driver will disallow any requests to remove a mounted volume.
  89 If the sysctl
  90 .Va dev.mfi.%d.delete_busy_volumes
  91 is set to 1,
  92 then the driver will allow mounted volumes to be removed.
  93 To not detach the mfid device for a busy volume that is deleted, set the
  94 sysctl
  95 .Va dev.mfi.%d.keep_deleted_volumes
  96 to 1.
  97 .Sh LOADER TUNABLES
  98 .Bl -tag -width indent
  99 .It Va hw.mfi.msi.enable
 100 By default, the driver will use MSI if it is supported.
 101 This behavior can be turned off by setting this tunable to 0.
 102 .It Va hw.mfi.mrsas_enable
 103 See description above.
 104 .El
 105 .Sh HARDWARE
 106 The
 107 .Nm
 108 driver supports the following hardware:
 109 .Pp
 110 .Bl -bullet -compact
 111 .It
 112 LSI MegaRAID SAS 1078
 113 .It
 114 LSI MegaRAID SAS 8408E
 115 .It
 116 LSI MegaRAID SAS 8480E
 117 .It
 118 LSI MegaRAID SAS 9240-4i
 119 .It
 120 LSI MegaRAID SAS 9240-8i
 121 .It
 122 LSI MegaRAID SAS 9260-4i
 123 .It
 124 LSI MegaRAID SAS 9260-8i
 125 .It
 126 LSI MegaRAID SAS 9260DE-8i
 127 .It
 128 LSI MegaRAID SAS 9260-16i
 129 .It
 130 LSI MegaRAID SAS 9261-8i
 131 .It
 132 LSI MegaRAID SAS 9280-4i4e
 133 .It
 134 LSI MegaRAID SAS 9280-8e
 135 .It
 136 LSI MegaRAID SAS 9280DE-8e
 137 .It
 138 LSI MegaRAID SAS 9280-16i4e
 139 .It
 140 LSI MegaRAID SAS 9280-24i4e
 141 .It
 142 Dell PERC5
 143 .It
 144 Dell PERC6
 145 .It
 146 Dell PERC H710 Embedded
 147 .It
 148 Dell PERC H710 Adapter
 149 .It
 150 Dell PERC H710 Mini (blades)
 151 .It
 152 Dell PERC H710 Mini (monolithics)
 153 .It
 154 Dell PERC H710P Adapter
 155 .It
 156 Dell PERC H710P Mini (blades)
 157 .It
 158 Dell PERC H710P Mini (monolithics)
 159 .It
 160 Dell PERC H810 Adapter
 161 .It
 162 IBM ServeRAID M1015 SAS/SATA
 163 .It
 164 IBM ServeRAID M5015 SAS/SATA
 165 .It
 166 IBM ServeRAID-MR10i
 167 .It
 168 Intel RAID Controller SROMBSAS18E
 169 .It
 170 Intel RAID Controller RS25DB080
 171 .It
 172 Intel RAID Controller RS25NB008
 173 .El
 174 .Sh FILES
 175 .Bl -tag -width ".Pa /dev/mfisyspd?" -compact
 176 .It Pa /dev/mfid?
 177 array/logical disk interface
 178 .It Pa /dev/mfisyspd?
 179 JBOD disk interface
 180 .It Pa /dev/mfi?
 181 management interface
 182 .El
 183 .Sh DIAGNOSTICS
 184 .Bl -diag
 185 .It "mfid%d: Unable to delete busy device"
 186 An attempt was made to remove a mounted volume.
 187 .It "mfisyspd%d: Unable to delete busy device"
 188 dito for JBOD disks
 189 .El
 190 .Sh SEE ALSO
 191 .Xr amr 4 ,
 192 .Xr mps 4 ,
 193 .Xr mrsas 4 ,
 194 .Xr pci 4 ,
 195 .Xr mfiutil 8
 196 .Sh HISTORY
 197 The
 198 .Nm
 199 driver first appeared in
 200 .Fx 6.1 .
 201 .Sh AUTHORS
 202 The
 203 .Nm
 204 driver and this manual page were written by
 205 .An Scott Long Aq Mt scottl@FreeBSD.org .
 206 .\".Sh BUGS
 207 .\"The driver does not support big-endian architectures at this time.