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 .Dd April 19, 2023
  26 .Dt MFI 4
  27 .Os
  28 .Sh NAME
  29 .Nm mfi
  30 .Nd "LSI MegaRAID SAS driver"
  31 .Sh SYNOPSIS
  32 To compile this driver into the kernel,
  33 place the following lines in your
  34 kernel configuration file:
  35 .Bd -ragged -offset indent
  36 .Cd "device pci"
  37 .Cd "device mfi"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 mfi_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 This driver is for LSI's next generation PCI Express SAS RAID controllers.
  48 Access to RAID arrays (logical disks) from this driver is provided via
  49 .Pa /dev/mfid?
  50 device nodes.
  51 A simple management interface is also provided on a per-controller basis via
  52 the
  53 .Pa /dev/mfi?
  54 device node.
  55 .Pp
  56 The
  57 .Nm
  58 name is derived from the phrase "MegaRAID Firmware Interface", which is
  59 substantially different than the old "MegaRAID" interface and thus requires
  60 a new driver.
  61 Older SCSI and SATA MegaRAID cards are supported by
  62 .Xr amr 4
  63 and will not work with this driver.
  64 .Pp
  65 Two sysctls are provided to tune the
  66 .Nm
  67 driver's behavior when a request is made to remove a mounted volume.
  68 By default the driver will disallow any requests to remove a mounted volume.
  69 If the sysctl
  70 .Va dev.mfi.%d.delete_busy_volumes
  71 is set to 1,
  72 then the driver will allow mounted volumes to be removed.
  73 .Pp
  74 A tunable is provided to adjust the
  75 .Nm
  76 driver's behaviour when attaching to a card.
  77 By default the driver will attach to all known cards with high probe priority.
  78 If the tunable
  79 .Va hw.mfi.mrsas_enable
  80 is set to 1,
  81 then the driver will reduce its probe priority to allow
  82 .Xr mrsas 4
  83 to attach to the card instead of
  84 .Nm .
  85 .Pp
  86 .Nm
  87 does not provide ATA TRIM support.
  88 Refer to
  89 .Xr mrsas 4
  90 if TRIM support is required.
  91 .Sh HARDWARE
  92 The
  93 .Nm
  94 driver supports the following hardware:
  95 .Pp
  96 .Bl -bullet -compact
  97 .It
  98 LSI MegaRAID SAS 1078
  99 .It
 100 LSI MegaRAID SAS 8408E
 101 .It
 102 LSI MegaRAID SAS 8480E
 103 .It
 104 LSI MegaRAID SAS 9240
 105 .It
 106 LSI MegaRAID SAS 9260
 107 .It
 108 Dell PERC5
 109 .It
 110 Dell PERC6
 111 .It
 112 IBM ServeRAID M1015 SAS/SATA
 113 .It
 114 IBM ServeRAID M1115 SAS/SATA
 115 .It
 116 IBM ServeRAID M5015 SAS/SATA
 117 .It
 118 IBM ServeRAID M5110 SAS/SATA
 119 .It
 120 IBM ServeRAID-MR10i
 121 .It
 122 Intel RAID Controller SRCSAS18E
 123 .It
 124 Intel RAID Controller SROMBSAS18E
 125 .El
 126 .Sh FILES
 127 .Bl -tag -width ".Pa /dev/mfid?" -compact
 128 .It Pa /dev/mfid?
 129 array/logical disk interface
 130 .It Pa /dev/mfi?
 131 management interface
 132 .El
 133 .Sh DIAGNOSTICS
 134 .Bl -diag
 135 .It "mfid%d: Unable to delete busy device"
 136 An attempt was made to remove a mounted volume.
 137 .El
 138 .Sh SEE ALSO
 139 .Xr amr 4 ,
 140 .Xr pci 4 ,
 141 .Xr mfiutil 8
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 driver first appeared in
 146 .Fx 6.1 .
 147 .Sh AUTHORS
 148 The
 149 .Nm
 150 driver and this manual page were written by
 151 .An Scott Long Aq Mt scottl@FreeBSD.org .
 152 .Sh BUGS
 153 The driver does not support big-endian architectures at this time.