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$
  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
  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 .Pp
  76 A tunable is provided to adjust the
  77 .Nm
  78 driver's behaviour when attaching to a card.  By default the driver will
  79 attach to all known cards with high probe priority.  If the tunable
  80 .Va hw.mfi.mrsas_enable
  81 is set to 1,
  82 then the driver will reduce its probe priority to allow
  83 .Cd mrsas
  84 to attach to the card instead of
  85 .Nm .
  86 .Sh HARDWARE
  87 The
  88 .Nm
  89 driver supports the following hardware:
  90 .Pp
  91 .Bl -bullet -compact
  92 .It
  93 LSI MegaRAID SAS 1078
  94 .It
  95 LSI MegaRAID SAS 8408E
  96 .It
  97 LSI MegaRAID SAS 8480E
  98 .It
  99 LSI MegaRAID SAS 9240
 100 .It
 101 LSI MegaRAID SAS 9260
 102 .It
 103 Dell PERC5
 104 .It
 105 Dell PERC6
 106 .It
 107 IBM ServeRAID M1015 SAS/SATA
 108 .It
 109 IBM ServeRAID M1115 SAS/SATA
 110 .It
 111 IBM ServeRAID M5015 SAS/SATA
 112 .It
 113 IBM ServeRAID M5110 SAS/SATA
 114 .It
 115 IBM ServeRAID-MR10i
 116 .It
 117 Intel RAID Controller SRCSAS18E
 118 .It
 119 Intel RAID Controller SROMBSAS18E
 120 .El
 121 .Sh FILES
 122 .Bl -tag -width ".Pa /dev/mfid?" -compact
 123 .It Pa /dev/mfid?
 124 array/logical disk interface
 125 .It Pa /dev/mfi?
 126 management interface
 127 .El
 128 .Sh DIAGNOSTICS
 129 .Bl -diag
 130 .It "mfid%d: Unable to delete busy device"
 131 An attempt was made to remove a mounted volume.
 132 .El
 133 .Sh SEE ALSO
 134 .Xr amr 4 ,
 135 .Xr pci 4 ,
 136 .Xr mfiutil 8
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 driver first appeared in
 141 .Fx 6.1 .
 142 .Sh AUTHORS
 143 The
 144 .Nm
 145 driver and this manual page were written by
 146 .An Scott Long Aq scottl@FreeBSD.org .
 147 .Sh BUGS
 148 The driver does not support big-endian architectures at this time.