share/man/man4/mpr.4

   1 .\"
   2 .\" Copyright (c) 2010 Spectra Logic Corporation
   3 .\" Copyright (c) 2014 LSI Corp
   4 .\" Copyright (c) 2016 Avago Technologies
   5 .\" Copyright (c) 2016 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 .\" mpr driver man page.
  34 .\"
  35 .\" Author: Ken Merry <ken@FreeBSD.org>
  36 .\" Author: Stephen McConnell <slm@FreeBSD.org>
  37 .\"
  38 .\" $Id$
  39 .\" $FreeBSD$
  40 .\"
  41 .Dd July 6, 2016
  42 .Dt MPR 4
  43 .Os
  44 .Sh NAME
  45 .Nm mpr
  46 .Nd "LSI Fusion-MPT 3 IT/IR 12Gb/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 mpr"
  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 mpr_load="YES"
  60 .Ed
  61 .Sh DESCRIPTION
  62 The
  63 .Nm
  64 driver provides support for Broadcom Ltd./Avago Tech (LSI)
  65 Fusion-MPT 3 IT/IR
  66 .Tn SAS
  67 controllers.
  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 3004 (4 Port SAS)
  76 .It
  77 Broadcom Ltd./Avago Tech (LSI) SAS 3008 (8 Port SAS)
  78 .It
  79 Broadcom Ltd./Avago Tech (LSI) SAS 3108 (8 Port SAS)
  80 .It
  81 Broadcom Ltd./Avago Tech (LSI) SAS 3216 (16 Port SAS)
  82 .It
  83 Broadcom Ltd./Avago Tech (LSI) SAS 3224 (24 Port SAS)
  84 .El
  85 .Sh CONFIGURATION
  86 .Pp
  87 In all tunable descriptions below, X represents the adapter number.
  88 .Pp
  89 To disable MSI interrupts for all
  90 .Nm
  91 driver instances, set this tunable value in
  92 .Xr loader.conf 5 :
  93 .Bd -literal -offset indent
  94 hw.mpr.disable_msi=1
  95 .Ed
  96 .Pp
  97 To disable MSI interrupts for a specific
  98 .Nm
  99 driver instance, set this tunable value in
 100 .Xr loader.conf 5 :
 101 .Bd -literal -offset indent
 102 dev.mpr.X.disable_msi=1
 103 .Ed
 104 .Pp
 105 To disable MSI-X interrupts for all
 106 .Nm
 107 driver instances, set this tunable value in
 108 .Xr loader.conf 5 :
 109 .Bd -literal -offset indent
 110 hw.mpr.disable_msix=1
 111 .Ed
 112 .Pp
 113 To disable MSI-X interrupts for a specific
 114 .Nm
 115 driver instance, set this tunable value in
 116 .Xr loader.conf 5 :
 117 .Bd -literal -offset indent
 118 dev.mpr.X.disable_msix=1
 119 .Ed
 120 .Pp
 121 To set the maximum number of DMA chains allocated for all adapters, set
 122 this tunable in
 123 .Xr loader.conf 5 :
 124 .Bd -literal -offset indent
 125 hw.mpr.max_chains=NNNN
 126 .Ed
 127 .Pp
 128 To set the maximum number of DMA chains allocated for a specific adapter,
 129 set this tunable in
 130 .Xr loader.conf 5 :
 131 .Bd -literal -offset indent
 132 dev.mpr.X.max_chains=NNNN
 133 .Ed
 134 .Pp
 135 The default max_chains value is 2048.
 136 .Pp
 137 The current number of free chain frames is stored in the
 138 dev.mpr.X.chain_free
 139 .Xr sysctl 8
 140 variable.
 141 .Pp
 142 The lowest number of free chain frames seen since boot is stored in the
 143 dev.mpr.X.chain_free_lowwater
 144 .Xr sysctl 8
 145 variable.
 146 .Pp
 147 The number of times that chain frame allocations have failed since boot is
 148 stored in the
 149 dev.mpr.X.chain_alloc_fail
 150 .Xr sysctl 8
 151 variable.
 152 This can be used to determine whether the max_chains tunable should be
 153 increased to help performance.
 154 .Pp
 155 The current number of active I/O commands is shown in the
 156 dev.mpr.X.io_cmds_active
 157 .Xr sysctl 8
 158 variable.
 159 .Ed
 160 .Pp
 161 To set the maximum number of pages that will be used per I/O for all adapters,
 162 set this tunable in
 163 .Xr loader.conf 5 :
 164 .Bd -literal -offset indent
 165 hw.mpr.max_io_pages=NNNN
 166 .Ed
 167 .Pp
 168 To set the maximum number of pages that will be used per I/O for a specific
 169 adapter, set this tunable in
 170 .Xr loader.conf 5 :
 171 .Bd -literal -offset indent
 172 dev.mpr.X.max_io_pages=NNNN
 173 .Ed
 174 .Pp
 175 The default max_io_pages value is -1, meaning that the maximum I/O size that
 176 will be used per I/O will be calculated using the IOCFacts values stored in
 177 the controller.
 178 The lowest value that the driver will use for max_io_pages is 1, otherwise
 179 IOCFacts will be used to calculate the maximum I/O size.
 180 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
 181 maximum I/O size used by the driver.
 182 .Pp
 183 The highest number of active I/O commands seen since boot is stored in the
 184 dev.mpr.X.io_cmds_highwater
 185 .Xr sysctl 8
 186 variable.
 187 .Pp
 188 Devices can be excluded from
 189 .Nm
 190 control for all adapters by setting this tunable in
 191 .Xr loader.conf 5 :
 192 .Bd -literal -offset indent
 193 hw.mpr.exclude_ids=Y
 194 .Ed
 195 .Pp
 196 Y represents the target ID of the device.
 197 If more than one device is to be excluded, target IDs are separated by commas.
 198 .Pp
 199 Devices can be excluded from
 200 .Nm
 201 control for a specific adapter by setting this tunable in
 202 .Xr loader.conf 5 :
 203 .Bd -literal -offset indent
 204 dev.mpr.X.exclude_ids=Y
 205 .Ed
 206 .Pp
 207 Y represents the target ID of the device.
 208 If more than one device is to be excluded, target IDs are separated by commas.
 209 .Pp
 210 The adapter can issue the
 211 .Sy StartStopUnit
 212 SCSI command to SATA direct-access devices during shutdown.
 213 This allows the device to quiesce powering down.
 214 To control this feature for all adapters, set the
 215 .Bd -literal -offset indent
 216 hw.mpr.enable_ssu
 217 .Ed
 218 .Pp
 219 tunable in
 220 .Xr loader.conf 5
 221 to one of these values:
 222 .Bl -tag -width 6n -offset indent
 223 .It 0
 224 Do not send SSU to either HDDs or SSDs.
 225 .It 1
 226 Send SSU to SSDs, but not to HDDs.
 227 This is the default value.
 228 .It 2
 229 Send SSU to HDDs, but not to SSDs.
 230 .It 3
 231 Send SSU to both HDDs and SSDs.
 232 .El
 233 .Pp
 234 To control the feature for a specific adapter, set this tunable value in
 235 .Xr loader.conf 5 :
 236 .Bd -literal -offset indent
 237 dev.mpr.X.enable_ssu
 238 .Ed
 239 .Pp
 240 The same set of values are valid when setting this tunable for all adapters.
 241 .Pp
 242 SATA disks that take several seconds to spin up and fail the SATA Identify
 243 command might not be discovered by the driver.
 244 This problem can sometimes be overcome by increasing the value of the spinup
 245 wait time in
 246 .Xr loader.conf 5
 247 with the
 248 .Bd -literal -offset indent
 249 hw.mpr.spinup_wait_time=NNNN
 250 .Ed
 251 .Pp
 252 tunable.
 253 NNNN represents the number of seconds to wait for SATA devices to spin up when
 254 the device fails the initial SATA Identify command.
 255 .Pp
 256 Spinup wait times can be set for specific adapters in
 257 .Xr loader.conf 5 :
 258 with the
 259 .Bd -literal -offset indent
 260 dev.mpr.X.spinup_wait_time=NNNN
 261 .Ed
 262 .Pp
 263 tunable.
 264 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
 265 the initial SATA Identify command.
 266 .Sh DEBUGGING
 267 To enable debugging prints from the
 268 .Nm
 269 driver, set the
 270 .Bd -literal -offset indent
 271 hw.mpr.X.debug_level
 272 .Ed
 273 .Pp
 274 tunable, either in
 275 .Xr loader.conf 5
 276 or by using
 277 .Xr sysctl 8 .
 278 These bits have the described effects:
 279 .Bd -literal -offset indent
 280 0x0001 Enable informational prints (set by default).
 281 0x0002 Enable prints for driver faults (set by default).
 282 0x0004 Enable prints for controller events.
 283 0x0008 Enable prints for controller logging.
 284 0x0010 Enable prints for tracing recovery operations.
 285 0x0020 Enable prints for parameter errors and programming bugs.
 286 0x0040 Enable prints for system initialization operations.
 287 0x0080 Enable prints for more detailed information.
 288 0x0100 Enable prints for user-generated commands (IOCTL).
 289 0x0200 Enable prints for device mapping.
 290 0x0400 Enable prints for tracing through driver functions.
 291 .Ed
 292 .Sh SEE ALSO
 293 .Xr cam 4 ,
 294 .Xr cd 4 ,
 295 .Xr ch 4 ,
 296 .Xr da 4 ,
 297 .Xr mps 4 ,
 298 .Xr mpt 4 ,
 299 .Xr pci 4 ,
 300 .Xr sa 4 ,
 301 .Xr scsi 4 ,
 302 .Xr targ 4 ,
 303 .Xr loader.conf 5 ,
 304 .Xr sysctl 8
 305 .Sh HISTORY
 306 The
 307 .Nm
 308 driver first appeared in FreeBSD 9.3.
 309 .Sh AUTHORS
 310 The
 311 .Nm
 312 driver was originally written by
 313 .An -nosplit
 314 .An Scott Long Aq Mt scottl@FreeBSD.org .
 315 It has been improved and tested by LSI Corporation,
 316 Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
 317 .Pp
 318 This man page was written by
 319 .An Ken Merry Aq Mt ken@FreeBSD.org
 320 with additional input from
 321 .An Stephen McConnell Aq Mt slm@FreeBSD.org .