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