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