share/man/man4/mps.4

   1 .\"
   2 .\" Copyright (c) 2010 Spectra Logic Corporation
   3 .\" Copyright (c) 2014 LSI Corp
   4 .\" Copyright (c) 2015-2017 Avago Technologies
   5 .\" Copyright (c) 2015-2017 Broadcom Ltd.
   6 .\" All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions, and the following disclaimer,
  13 .\"    without modification.
  14 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
  15 .\"    substantially similar to the "NO WARRANTY" disclaimer below
  16 .\"    ("Disclaimer") and any redistribution must be conditioned upon
  17 .\"    including a substantially similar Disclaimer requirement for further
  18 .\"    binary redistribution.
  19 .\"
  20 .\" NO WARRANTY
  21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  24 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  30 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31 .\" POSSIBILITY OF SUCH DAMAGES.
  32 .\"
  33 .\" mps driver man page.
  34 .\"
  35 .\" Author: Ken Merry <ken@FreeBSD.org>
  36 .\" Author: Stephen McConnell <slm@FreeBSD.org>
  37 .\"
  38 .\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
  39 .\" $FreeBSD$
  40 .\"
  41 .Dd May 25, 2017
  42 .Dt MPS 4
  43 .Os
  44 .Sh NAME
  45 .Nm mps
  46 .Nd "LSI Fusion-MPT 2 IT/IR 6Gb/s Serial Attached SCSI/SATA driver"
  47 .Sh SYNOPSIS
  48 To compile this driver into the kernel, place these lines in the kernel
  49 configuration file:
  50 .Bd -ragged -offset indent
  51 .Cd "device pci"
  52 .Cd "device scbus"
  53 .Cd "device mps"
  54 .Ed
  55 .Pp
  56 The driver can be loaded as a module at boot time by placing this line in
  57 .Xr loader.conf 5 :
  58 .Bd -literal -offset indent
  59 mps_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for Broadcom Ltd./Avago Tech (LSI)
  65 Fusion-MPT 2 IT/IR
  66 .Tn SAS
  67 controllers and WarpDrive solid state storage cards.
  68 .Sh HARDWARE
  69 These controllers are supported by the
  70 .Nm
  71 driver:
  72 .Pp
  73 .Bl -bullet -compact
  74 .It
  75 Broadcom Ltd./Avago Tech (LSI) SAS 2004 (4 Port SAS)
  76 .It
  77 Broadcom Ltd./Avago Tech (LSI) SAS 2008 (8 Port SAS)
  78 .It
  79 Broadcom Ltd./Avago Tech (LSI) SAS 2108 (8 Port SAS)
  80 .It
  81 Broadcom Ltd./Avago Tech (LSI) SAS 2116 (16 Port SAS)
  82 .It
  83 Broadcom Ltd./Avago Tech (LSI) SAS 2208 (8 Port SAS)
  84 .It
  85 Broadcom Ltd./Avago Tech (LSI) SAS 2308 (8 Port SAS)
  86 .It
  87 Broadcom Ltd./Avago Tech (LSI) 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 .Pp
  99 In all tunable descriptions below, X represents the adapter number.
 100 .Pp
 101 To disable MSI interrupts for all
 102 .Nm
 103 driver instances, set this tunable value in
 104 .Xr loader.conf 5 :
 105 .Bd -literal -offset indent
 106 hw.mps.disable_msi=1
 107 .Ed
 108 .Pp
 109 To disable MSI interrupts for a specific
 110 .Nm
 111 driver instance, set this tunable value in
 112 .Xr loader.conf 5 :
 113 .Bd -literal -offset indent
 114 dev.mps.X.disable_msi=1
 115 .Ed
 116 .Pp
 117 To disable MSI-X interrupts for all
 118 .Nm
 119 driver instances, set this tunable value in
 120 .Xr loader.conf 5 :
 121 .Bd -literal -offset indent
 122 hw.mps.disable_msix=1
 123 .Ed
 124 .Pp
 125 To disable MSI-X interrupts for a specific
 126 .Nm
 127 driver instance, set this tunable value in
 128 .Xr loader.conf 5 :
 129 .Bd -literal -offset indent
 130 dev.mps.X.disable_msix=1
 131 .Ed
 132 .Pp
 133 To set the maximum number of DMA chains allocated for all adapters, set this
 134 tunable in
 135 .Xr loader.conf 5 :
 136 .Bd -literal -offset indent
 137 hw.mps.max_chains=NNNN
 138 .Ed
 139 .Pp
 140 To set the maximum number of DMA chains allocated for a specific adapter,
 141 set this tunable in
 142 .Xr loader.conf 5 :
 143 .Bd -literal -offset indent
 144 dev.mps.X.max_chains=NNNN
 145 .Ed
 146 .Pp
 147 The default max_chains value is 2048.
 148 .Pp
 149 The current number of free chain frames is stored in the
 150 dev.mps.X.chain_free
 151 .Xr sysctl 8
 152 variable.
 153 .Pp
 154 The lowest number of free chain frames seen since boot is stored in the
 155 dev.mps.X.chain_free_lowwater
 156 .Xr sysctl 8
 157 variable.
 158 .Pp
 159 The number of times that chain frame allocations have failed since boot is
 160 stored in the
 161 dev.mps.X.chain_alloc_fail
 162 .Xr sysctl 8
 163 variable.
 164 This can be used to determine whether the max_chains tunable should be
 165 increased to help performance.
 166 .Pp
 167 The current number of active I/O commands is shown in the
 168 dev.mps.X.io_cmds_active
 169 .Xr sysctl 8
 170 variable.
 171 .Ed
 172 .Pp
 173 To set the maximum number of pages that will be used per I/O for all adapters,
 174 set this tunable in
 175 .Xr loader.conf 5 :
 176 .Bd -literal -offset indent
 177 hw.mps.max_io_pages=NNNN
 178 .Ed
 179 .Pp
 180 To set the maximum number of pages that will be used per I/O for a specific
 181 adapter, set this tunable in
 182 .Xr loader.conf 5 :
 183 .Bd -literal -offset indent
 184 dev.mps.X.max_io_pages=NNNN
 185 .Ed
 186 .Pp
 187 The default max_io_pages value is -1, meaning that the maximum I/O size that
 188 will be used per I/O will be calculated using the IOCFacts values stored in
 189 the controller.
 190 The lowest value that the driver will use for max_io_pages is 1, otherwise
 191 IOCFacts will be used to calculate the maximum I/O size.
 192 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
 193 maximum I/O size used by the driver.
 194 .Pp
 195 The highest number of active I/O commands seen since boot is stored in the
 196 dev.mps.X.io_cmds_highwater
 197 .Xr sysctl 8
 198 variable.
 199 .Pp
 200 Devices can be excluded from
 201 .Nm
 202 control for all adapters by setting this tunable in
 203 .Xr loader.conf 5 :
 204 .Bd -literal -offset indent
 205 hw.mps.exclude_ids=Y
 206 .Ed
 207 .Pp
 208 Y represents the target ID of the device.
 209 If more than one device is to be excluded, target IDs are separated by commas.
 210 .Pp
 211 Devices can be excluded from
 212 .Nm
 213 control for a specific adapter by setting this tunable in
 214 .Xr loader.conf 5 :
 215 .Bd -literal -offset indent
 216 dev.mps.X.exclude_ids=Y
 217 .Ed
 218 .Pp
 219 Y represents the target ID of the device.
 220 If more than one device is to be excluded, target IDs are separated by commas.
 221 .Pp
 222 The adapter can issue the
 223 .Sy StartStopUnit
 224 SCSI command to SATA direct-access devices during shutdown.
 225 This allows the device to quiesce powering down.
 226 To control this feature for all adapters, set the
 227 .Bd -literal -offset indent
 228 hw.mps.enable_ssu
 229 .Ed
 230 .Pp
 231 tunable in
 232 .Xr loader.conf 5
 233 to one of these values:
 234 .Bl -tag -width 6n -offset indent
 235 .It 0
 236 Do not send SSU to either HDDs or SSDs.
 237 .It 1
 238 Send SSU to SSDs, but not to HDDs.
 239 This is the default value.
 240 .It 2
 241 Send SSU to HDDs, but not to SSDs.
 242 .It 3
 243 Send SSU to both HDDs and SSDs.
 244 .El
 245 .Pp
 246 To control this feature for a specific adapter, set this tunable value in
 247 .Xr loader.conf 5 :
 248 .Bd -literal -offset indent
 249 dev.mps.X.enable_ssu
 250 .Ed
 251 .Pp
 252 The same set of values are valid as when setting this tunable for all adapters.
 253 .Pp
 254 SATA disks that take several seconds to spin up and fail the SATA Identify
 255 command might not be discovered by the driver.
 256 This problem can sometimes be overcome by increasing the value of the spinup
 257 wait time in
 258 .Xr loader.conf 5
 259 with the
 260 .Bd -literal -offset indent
 261 hw.mps.spinup_wait_time=NNNN
 262 .Ed
 263 .Pp
 264 tunable.
 265 NNNN represents the number of seconds to wait for SATA devices to spin up when
 266 the device fails the initial SATA Identify command.
 267 .Pp
 268 Spinup wait times can be set for specific adapters in
 269 .Xr loader.conf 5 :
 270 with the
 271 .Bd -literal -offset indent
 272 dev.mps.X.spinup_wait_time=NNNN
 273 .Ed
 274 .Pp
 275 tunable.
 276 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
 277 the initial SATA Identify command.
 278 .Pp
 279 The driver can map devices discovered by the adapter so that target IDs
 280 corresponding to a specific device persist across resets and reboots.
 281 In some cases it is possible for devices to lose their mapped IDs due to
 282 unexpected behavior from certain hardware, such as some types of enclosures.
 283 To overcome this problem, a tunable is provided that will force the driver to
 284 map devices using the Phy number associated with the device.
 285 This feature is not recommended if the topology includes multiple
 286 enclosures/expanders.
 287 If multiple enclosures/expanders are present in the topology, Phy numbers are
 288 repeated, causing all devices at these Phy numbers except the first device to
 289 fail enumeration.
 290 To control this feature for all adapters, set the
 291 .Bd -literal -offset indent
 292 hw.mps.use_phy_num
 293 .Ed
 294 .Pp
 295 tunable in
 296 .Xr loader.conf 5
 297 to one of these values:
 298 .Bl -tag -width 6n -offset indent
 299 .It -1
 300 Only use Phy numbers to map devices and bypass the driver's mapping logic.
 301 .It 0
 302 Never use Phy numbers to map devices.
 303 .It 1
 304 Use Phy numbers to map devices, but only if the driver's mapping logic fails
 305 to map the device that is being enumerated.
 306 This is the default value.
 307 .El
 308 .Pp
 309 To control this feature for a specific adapter, set this tunable value in
 310 .Xr loader.conf 5 :
 311 .Bd -literal -offset indent
 312 dev.mps.X.use_phy_num
 313 .Ed
 314 .Pp
 315 The same set of values are valid as when setting this tunable for all adapters.
 316 .Pp
 317 .Sh DEBUGGING
 318 To enable debugging prints from the
 319 .Nm
 320 driver, set the
 321 .Bd -literal -offset indent
 322 hw.mps.X.debug_level
 323 .Ed
 324 .Pp
 325 tunable, either in
 326 .Xr loader.conf 5
 327 or by using
 328 .Xr sysctl 8 .
 329 These bits have the described effects:
 330 .Bd -literal -offset indent
 331 0x0001 Enable informational prints (set by default).
 332 0x0002 Enable prints for driver faults (set by default).
 333 0x0004 Enable prints for controller events.
 334 0x0008 Enable prints for controller logging.
 335 0x0010 Enable prints for tracing recovery operations.
 336 0x0020 Enable prints for parameter errors and programming bugs.
 337 0x0040 Enable prints for system initialization operations.
 338 0x0080 Enable prints for more detailed information.
 339 0x0100 Enable prints for user-generated commands (IOCTL).
 340 0x0200 Enable prints for device mapping.
 341 0x0400 Enable prints for tracing through driver functions.
 342 .Ed
 343 .Sh SEE ALSO
 344 .Xr cam 4 ,
 345 .Xr cd 4 ,
 346 .Xr ch 4 ,
 347 .Xr da 4 ,
 348 .Xr mpr 4 ,
 349 .Xr mpt 4 ,
 350 .Xr pci 4 ,
 351 .Xr sa 4 ,
 352 .Xr scsi 4 ,
 353 .Xr targ 4 ,
 354 .Xr loader.conf 5 ,
 355 .Xr sysctl 8
 356 .Sh HISTORY
 357 The
 358 .Nm
 359 driver first appeared in
 360 .Fx 9.0 .
 361 .Sh AUTHORS
 362 The
 363 .Nm
 364 driver was originally written by
 365 .An -nosplit
 366 .An Scott Long Aq Mt scottl@FreeBSD.org .
 367 It has been improved and tested by LSI Corporation,
 368 Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
 369 .Pp
 370 This man page was written by
 371 .An Ken Merry Aq Mt ken@FreeBSD.org
 372 with additional input from
 373 .An Stephen McConnell Aq Mt slm@FreeBSD.org .