share/man/man4/mps.4

   1 .\"
   2 .\" Copyright (c) 2010 Spectra Logic Corporation
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions, and the following disclaimer,
  10 .\"    without modification.
  11 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12 .\"    substantially similar to the "NO WARRANTY" disclaimer below
  13 .\"    ("Disclaimer") and any redistribution must be conditioned upon
  14 .\"    including a substantially similar Disclaimer requirement for further
  15 .\"    binary redistribution.
  16 .\"
  17 .\" NO WARRANTY
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  21 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  27 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGES.
  29 .\"
  30 .\" mps driver man page.
  31 .\"
  32 .\" Author: Ken Merry <ken@FreeBSD.org>
  33 .\"
  34 .\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
  35 .\" $FreeBSD$
  36 .\"
  37 .Dd December 9, 2015
  38 .Dt MPS 4
  39 .Os
  40 .Sh NAME
  41 .Nm mps
  42 .Nd LSI Fusion-MPT 2 Serial Attached SCSI driver
  43 .Sh SYNOPSIS
  44 To compile this driver into your kernel,
  45 place the following lines in your kernel configuration file:
  46 .Bd -ragged -offset indent
  47 .Cd "device scbus"
  48 .Cd "device mps"
  49 .Ed
  50 .Pp
  51 Or, to load the driver as a module at boot, place the following line in
  52 .Xr loader.conf 5 :
  53 .Bd -literal -offset indent
  54 mps_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for LSI Logic Fusion-MPT 2
  60 .Tn SAS
  61 controllers and WarpDrive solid state storage cards.
  62 .Sh HARDWARE
  63 The
  64 .Nm
  65 driver supports the following hardware:
  66 .Pp
  67 .Bl -bullet -compact
  68 .It
  69 LSI Logic SAS2004 (4 Port
  70 .Tn SAS )
  71 .It
  72 LSI Logic SAS2008 (8 Port
  73 .Tn SAS )
  74 .It
  75 LSI Logic SAS2108 (8 Port
  76 .Tn SAS )
  77 .It
  78 LSI Logic SAS2116 (16 Port
  79 .Tn SAS )
  80 .It
  81 LSI Logic SAS2208 (8 Port
  82 .Tn SAS )
  83 .It
  84 LSI Logic SAS2308 (8 Port
  85 .Tn SAS )
  86 .It
  87 LSI Logic SSS6200 Solid State Storage
  88 .It
  89 Intel Integrated RAID Module RMS25JB040
  90 .It
  91 Intel Integrated RAID Module RMS25JB080
  92 .It
  93 Intel Integrated RAID Module RMS25KB040
  94 .It
  95 Intel Integrated RAID Module RMS25KB080
  96 .El
  97 .Sh CONFIGURATION
  98 To disable MSI interrupts for all
  99 .Nm
 100 driver instances, set the following tunable value in
 101 .Xr loader.conf 5 :
 102 .Bd -literal -offset indent
 103 hw.mps.disable_msi=1
 104 .Ed
 105 .Pp
 106 To disable MSI interrupts for a specific
 107 .Nm
 108 driver instance, set the following tunable value in
 109 .Xr loader.conf 5 :
 110 .Bd -literal -offset indent
 111 dev.mps.X.disable_msi=1
 112 .Ed
 113 .Pp
 114 where X is the adapter number.
 115 .Pp
 116 To disable MSI-X interrupts for all
 117 .Nm
 118 driver instances, set the following tunable value in
 119 .Xr loader.conf 5 :
 120 .Bd -literal -offset indent
 121 hw.mps.disable_msix=1
 122 .Ed
 123 .Pp
 124 To disable MSI-X interrupts for a specific
 125 .Nm
 126 driver instance, set the following tunable value in
 127 .Xr loader.conf 5 :
 128 .Bd -literal -offset indent
 129 dev.mps.X.disable_msix=1
 130 .Ed
 131 .Pp
 132 where X is the adapter number.
 133 .Pp
 134 To set the maximum number of DMA chains allocated for all adapters,
 135 set the following variable in
 136 .Xr loader.conf 5 :
 137 .Bd -literal -offset indent
 138 hw.mps.max_chains=NNNN
 139 .Ed
 140 .Pp
 141 To set the maximum number of DMA chains allocated for a specific adapter,
 142 set the following variable in
 143 .Xr loader.conf 5 :
 144 .Bd -literal -offset indent
 145 dev.mps.X.max_chains=NNNN
 146 .Ed
 147 .Pp
 148 This variable may also be viewed via
 149 .Xr sysctl 8
 150 to see the maximum set for a given adapter.
 151 .Pp
 152 The current number of free chain frames may be seen via the
 153 dev.mps.X.chain_free
 154 .Xr sysctl 8
 155 variable.
 156 .Pp
 157 The lowest number of free chain frames may be seen via the
 158 dev.mps.X.chain_free_lowwater
 159 .Xr sysctl 8
 160 variable.
 161 .Pp
 162 The current number of active I/O commands is shown in the
 163 dev.mps.X.io_cmds_active
 164 .Xr sysctl 8
 165 variable.
 166 .Pp
 167 The maximum number of active I/O command seen since boot is shown in the
 168 dev.mps.X.io_cmds_highwater
 169 .Xr sysctl 8
 170 variable.
 171 .Pp
 172 The adapter can issue the
 173 .Sy StartStopUnit
 174 SCSI command to SATA direct-access devices during shutdown, to allow the
 175 device to quiesce before being powered down.
 176 To control this feature for all adapters, set the
 177 .Bd -literal -offset indent
 178 hw.mps.enable_ssu
 179 .Ed
 180 .Pp
 181 tunable value in
 182 .Xr loader.conf 5
 183 to one of the following values:
 184 .Bl -tag -width 6n -offset indent
 185 .It 0
 186 Do not send SSU to either HDDs or SSDs.
 187 .It 1
 188 Send SSU to SSDs, but not to HDDs; this is the default value.
 189 .It 2
 190 Send SSU to HDDs, but not to SSDs.
 191 .It 3
 192 Send SSU to both HDDs and SSDs.
 193 .El
 194 .Pp
 195 To control the feature for a specific adapter, set the following tunable
 196 value in
 197 .Xr loader.conf 5 :
 198 .Bd -literal -offset indent
 199 dev.mps.X.enable_ssu
 200 .Ed
 201 .Pp
 202 where X is the adapter number.
 203 The same set of values are valid as for all adapters.
 204 .Sh DEBUGGING
 205 To enable debugging prints from the
 206 .Nm
 207 driver, set the
 208 .Bd -literal -offset indent
 209 hw.mps.X.debug_level
 210 .Ed
 211 .Pp
 212 variable, where X is the adapter number, either in
 213 .Xr loader.conf 5
 214 or via
 215 .Xr sysctl 8 .
 216 The following bits have the described effects:
 217 .Bl -tag -width 6n -offset indent
 218 .It 0x01
 219 Enable informational prints.
 220 .It 0x02
 221 Enable tracing prints.
 222 .It 0x04
 223 Enable prints for driver faults.
 224 .It 0x08
 225 Enable prints for controller events.
 226 .El
 227 .Sh SEE ALSO
 228 .Xr cd 4 ,
 229 .Xr ch 4 ,
 230 .Xr da 4 ,
 231 .Xr mpt 4 ,
 232 .Xr pci 4 ,
 233 .Xr sa 4 ,
 234 .Xr scsi 4 ,
 235 .Xr targ 4 ,
 236 .Xr loader.conf 5 ,
 237 .Xr sysctl 8
 238 .Sh HISTORY
 239 The
 240 .Nm
 241 driver first appeared in
 242 .Fx 9.0 .
 243 .Sh AUTHORS
 244 .An -nosplit
 245 The
 246 .Nm
 247 driver was originally written by
 248 .An Scott Long Aq scottl@FreeBSD.org .
 249 It has been improved and tested by LSI Logic Corporation.
 250 This man page was written by
 251 .An Ken Merry Aq ken@FreeBSD.org .
 252 .Sh BUGS
 253 This driver has a couple of known shortcomings:
 254 .Bl -bullet -compact
 255 .It
 256 No userland utility available (e.g.,
 257 .Xr mptutil 8 ) .
 258 .It
 259 The driver probes devices sequentially.
 260 If your system has a large number of devices, the probe will take a while.
 261 .El