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 January 17, 2008
  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 8408E
  83 .It
  84 LSI MegaRAID SAS 8480E
  85 .It
  86 LSI MegaRAID SAS 1078
  87 .It
  88 Dell PERC5
  89 .It
  90 Dell PERC6
  91 .El
  92 .Sh FILES
  93 .Bl -tag -width ".Pa /dev/mfid?" -compact
  94 .It Pa /dev/mfid?
  95 array/logical disk interface
  96 .It Pa /dev/mfi?
  97 management interface
  98 .El
  99 .Sh DIAGNOSTICS
 100 .Bl -diag
 101 .It "mfid%d: Unable to delete busy device"
 102 An attempt was made to remove a mounted volume.
 103 .El
 104 .Sh SEE ALSO
 105 .Xr amr 4 ,
 106 .Xr pci 4
 107 .Sh HISTORY
 108 The
 109 .Nm
 110 driver first appeared in
 111 .Fx 6.1 .
 112 .Sh AUTHORS
 113 The
 114 .Nm
 115 driver and this manual page were written by
 116 .An Scott Long Aq scottl@FreeBSD.org .
 117 .Sh BUGS
 118 The driver does not support big-endian architectures at this time.