MFC r302673

Use real values to calculate Max I/O size instead of guessing.

Reviewed by:	ken, scottl
Approved by:	ken, scottl, ambrisko (mentors)
Differential Revision:	https://reviews.freebsd.org/D7043

2 files changed, 175 insertions, 80 deletions

diff --git a/share/man/man4/mpr.4 b/share/man/man4/mpr.4
index ff500c2..370d659 100644
--- a/share/man/man4/mpr.4
+++ b/share/man/man4/mpr.4
@@ -29,7 +29,7 @@
 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGES.
-.\" 
+.\"
 .\" mpr driver man page.
 .\"
 .\" Author: Ken Merry <ken@FreeBSD.org>
@@ -38,7 +38,7 @@
 .\" $Id$
 .\" $FreeBSD$
 .\"
-.Dd April 29, 2016
+.Dd July 6, 2016
 .Dt MPR 4
 .Os
 .Sh NAME
@@ -156,6 +156,29 @@ The current number of active I/O commands is shown in the
 dev.mpr.X.io_cmds_active
 .Xr sysctl 8
 variable.
+.Ed
+.Pp
+To set the maximum number of pages that will be used per I/O for all adapters,
+set this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.mpr.max_io_pages=NNNN
+.Ed
+.Pp
+To set the maximum number of pages that will be used per I/O for a specific
+adapter, set this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+dev.mpr.X.max_io_pages=NNNN
+.Ed
+.Pp
+The default max_io_pages value is -1, meaning that the maximum I/O size that
+will be used per I/O will be calculated using the IOCFacts values stored in
+the controller.
+The lowest value that the driver will use for max_io_pages is 1, otherwise
+IOCFacts will be used to calculate the maximum I/O size.
+The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
+maximum I/O size used by the driver.
 .Pp
 The highest number of active I/O commands seen since boot is stored in the
 dev.mpr.X.io_cmds_highwater
@@ -220,7 +243,7 @@ SATA disks that take several seconds to spin up and fail the SATA Identify
 command might not be discovered by the driver.
 This problem can sometimes be overcome by increasing the value of the spinup
 wait time in
-.Xr loader.conf 5 :
+.Xr loader.conf 5
 with the
 .Bd -literal -offset indent
 hw.mpr.spinup_wait_time=NNNN
@@ -250,7 +273,7 @@ hw.mpr.X.debug_level
 .Pp
 tunable, either in
 .Xr loader.conf 5
-or by using  
+or by using
 .Xr sysctl 8 .
 These bits have the described effects:
 .Bd -literal -offset indent
diff --git a/share/man/man4/mps.4 b/share/man/man4/mps.4
index 7e910b1..99af107 100644
--- a/share/man/man4/mps.4
+++ b/share/man/man4/mps.4
@@ -1,5 +1,8 @@
 .\"
 .\" Copyright (c) 2010 Spectra Logic Corporation
+.\" Copyright (c) 2014 LSI Corp
+.\" Copyright (c) 2016 Avago Technologies
+.\" Copyright (c) 2016 Broadcom Ltd.
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
@@ -30,25 +33,27 @@
 .\" mps driver man page.
 .\"
 .\" Author: Ken Merry <ken@FreeBSD.org>
+.\" Author: Stephen McConnell <slm@FreeBSD.org>
 .\"
 .\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
 .\" $FreeBSD$
 .\"
-.Dd December 9, 2015
+.Dd July 5, 2016
 .Dt MPS 4
 .Os
 .Sh NAME
 .Nm mps
-.Nd LSI Fusion-MPT 2 Serial Attached SCSI driver
+.Nd "LSI Fusion-MPT 2 IT/IR 6Gb/s Serial Attached SCSI/SATA driver"
 .Sh SYNOPSIS
-To compile this driver into your kernel,
-place the following lines in your kernel configuration file:
+To compile this driver into the kernel, place these lines in the kernel
+configuration file:
 .Bd -ragged -offset indent
+.Cd "device pci"
 .Cd "device scbus"
 .Cd "device mps"
 .Ed
 .Pp
-Or, to load the driver as a module at boot, place the following line in
+The driver can be loaded as a module at boot time by placing this line in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 mps_load="YES"
@@ -56,35 +61,30 @@ mps_load="YES"
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for LSI Logic Fusion-MPT 2
+driver provides support for Broadcom Ltd./Avago Tech (LSI)
+Fusion-MPT 2 IT/IR
 .Tn SAS
 controllers and WarpDrive solid state storage cards.
 .Sh HARDWARE
-The
+These controllers are supported by the
 .Nm
-driver supports the following hardware:
+driver:
 .Pp
 .Bl -bullet -compact
 .It
-LSI Logic SAS2004 (4 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2004 (4 Port SAS)
 .It
-LSI Logic SAS2008 (8 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2008 (8 Port SAS)
 .It
-LSI Logic SAS2108 (8 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2108 (8 Port SAS)
 .It
-LSI Logic SAS2116 (16 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2116 (16 Port SAS)
 .It
-LSI Logic SAS2208 (8 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2208 (8 Port SAS)
 .It
-LSI Logic SAS2308 (8 Port
-.Tn SAS )
+Broadcom Ltd./Avago Tech (LSI) SAS 2308 (8 Port SAS)
 .It
-LSI Logic SSS6200 Solid State Storage
+Broadcom Ltd./Avago Tech (LSI) SSS6200 Solid State Storage
 .It
 Intel Integrated RAID Module RMS25JB040
 .It
@@ -95,9 +95,12 @@ Intel Integrated RAID Module RMS25KB040
 Intel Integrated RAID Module RMS25KB080
 .El
 .Sh CONFIGURATION
+.Pp
+In all tunable descriptions below, X represents the adapter number.
+.Pp
 To disable MSI interrupts for all
 .Nm
-driver instances, set the following tunable value in
+driver instances, set this tunable value in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 hw.mps.disable_msi=1
@@ -105,17 +108,15 @@ hw.mps.disable_msi=1
 .Pp
 To disable MSI interrupts for a specific
 .Nm
-driver instance, set the following tunable value in
+driver instance, set this tunable value in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 dev.mps.X.disable_msi=1
 .Ed
 .Pp
-where X is the adapter number.
-.Pp
 To disable MSI-X interrupts for all
 .Nm
-driver instances, set the following tunable value in
+driver instances, set this tunable value in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 hw.mps.disable_msix=1
@@ -123,84 +124,157 @@ hw.mps.disable_msix=1
 .Pp
 To disable MSI-X interrupts for a specific
 .Nm
-driver instance, set the following tunable value in
+driver instance, set this tunable value in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 dev.mps.X.disable_msix=1
 .Ed
 .Pp
-where X is the adapter number.
-.Pp
-To set the maximum number of DMA chains allocated for all adapters,
-set the following variable in
+To set the maximum number of DMA chains allocated for all adapters, set this
+tunable in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 hw.mps.max_chains=NNNN
 .Ed
 .Pp
 To set the maximum number of DMA chains allocated for a specific adapter,
-set the following variable in
+set this tunable in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 dev.mps.X.max_chains=NNNN
 .Ed
 .Pp
-This variable may also be viewed via
-.Xr sysctl 8
-to see the maximum set for a given adapter.
+The default max_chains value is 2048.
 .Pp
-The current number of free chain frames may be seen via the
+The current number of free chain frames is stored in the
 dev.mps.X.chain_free
 .Xr sysctl 8
 variable.
 .Pp
-The lowest number of free chain frames may be seen via the
+The lowest number of free chain frames seen since boot is stored in the
 dev.mps.X.chain_free_lowwater
 .Xr sysctl 8
 variable.
 .Pp
+The number of times that chain frame allocations have failed since boot is
+stored in the
+dev.mps.X.chain_alloc_fail
+.Xr sysctl 8
+variable.
+This can be used to determine whether the max_chains tunable should be
+increased to help performance.
+.Pp
 The current number of active I/O commands is shown in the
 dev.mps.X.io_cmds_active
 .Xr sysctl 8
 variable.
+.Ed
+.Pp
+To set the maximum number of pages that will be used per I/O for all adapters,
+set this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.mps.max_io_pages=NNNN
+.Ed
 .Pp
-The maximum number of active I/O command seen since boot is shown in the
+To set the maximum number of pages that will be used per I/O for a specific
+adapter, set this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+dev.mps.X.max_io_pages=NNNN
+.Ed
+.Pp
+The default max_io_pages value is -1, meaning that the maximum I/O size that
+will be used per I/O will be calculated using the IOCFacts values stored in
+the controller.
+The lowest value that the driver will use for max_io_pages is 1, otherwise
+IOCFacts will be used to calculate the maximum I/O size.
+The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
+maximum I/O size used by the driver.
+.Pp
+The highest number of active I/O commands seen since boot is stored in the
 dev.mps.X.io_cmds_highwater
 .Xr sysctl 8
 variable.
 .Pp
+Devices can be excluded from
+.Nm
+control for all adapters by setting this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.mps.exclude_ids=Y
+.Ed
+.Pp
+Y represents the target ID of the device.
+If more than one device is to be excluded, target IDs are separated by commas.
+.Pp
+Devices can be excluded from
+.Nm
+control for a specific adapter by setting this tunable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+dev.mps.X.exclude_ids=Y
+.Ed
+.Pp
+Y represents the target ID of the device.
+If more than one device is to be excluded, target IDs are separated by commas.
+.Pp
 The adapter can issue the
 .Sy StartStopUnit
-SCSI command to SATA direct-access devices during shutdown, to allow the
-device to quiesce before being powered down.
+SCSI command to SATA direct-access devices during shutdown.
+This allows the device to quiesce powering down.
 To control this feature for all adapters, set the
 .Bd -literal -offset indent
 hw.mps.enable_ssu
 .Ed
 .Pp
-tunable value in
+tunable in
 .Xr loader.conf 5
-to one of the following values:
+to one of these values:
 .Bl -tag -width 6n -offset indent
 .It 0
 Do not send SSU to either HDDs or SSDs.
 .It 1
-Send SSU to SSDs, but not to HDDs; this is the default value.
+Send SSU to SSDs, but not to HDDs.
+This is the default value.
 .It 2
 Send SSU to HDDs, but not to SSDs.
 .It 3
 Send SSU to both HDDs and SSDs.
 .El
 .Pp
-To control the feature for a specific adapter, set the following tunable
-value in
+To control the feature for a specific adapter, set this tunable value in
 .Xr loader.conf 5 :
 .Bd -literal -offset indent
 dev.mps.X.enable_ssu
 .Ed
 .Pp
-where X is the adapter number.
-The same set of values are valid as for all adapters.
+The same set of values are valid when setting this tunable for all adapters.
+.Pp
+SATA disks that take several seconds to spin up and fail the SATA Identify
+command might not be discovered by the driver.
+This problem can sometimes be overcome by increasing the value of the spinup
+wait time in
+.Xr loader.conf 5
+with the
+.Bd -literal -offset indent
+hw.mps.spinup_wait_time=NNNN
+.Ed
+.Pp
+tunable.
+NNNN represents the number of seconds to wait for SATA devices to spin up when
+the device fails the initial SATA Identify command.
+.Pp
+Spinup wait times can be set for specific adapters in
+.Xr loader.conf 5 :
+with the
+.Bd -literal -offset indent
+dev.mps.X.spinup_wait_time=NNNN
+.Ed
+.Pp
+tunable.
+NNNN is the number of seconds to wait for SATA devices to spin up when they fail
+the initial SATA Identify command.
 .Sh DEBUGGING
 To enable debugging prints from the
 .Nm
@@ -209,25 +283,30 @@ driver, set the
 hw.mps.X.debug_level
 .Ed
 .Pp
-variable, where X is the adapter number, either in
+tunable, either in
 .Xr loader.conf 5
-or via
+or by using
 .Xr sysctl 8 .
-The following bits have the described effects:
-.Bl -tag -width 6n -offset indent
-.It 0x01
-Enable informational prints.
-.It 0x02
-Enable tracing prints.
-.It 0x04
-Enable prints for driver faults.
-.It 0x08
-Enable prints for controller events.
-.El
+These bits have the described effects:
+.Bd -literal -offset indent
+0x0001 Enable informational prints (set by default).
+0x0002 Enable prints for driver faults (set by default).
+0x0004 Enable prints for controller events.
+0x0008 Enable prints for controller logging.
+0x0010 Enable prints for tracing recovery operations.
+0x0020 Enable prints for parameter errors and programming bugs.
+0x0040 Enable prints for system initialization operations.
+0x0080 Enable prints for more detailed information.
+0x0100 Enable prints for user-generated commands (IOCTL).
+0x0200 Enable prints for device mapping.
+0x0400 Enable prints for tracing through driver functions.
+.Ed
 .Sh SEE ALSO
+.Xr cam 4 ,
 .Xr cd 4 ,
 .Xr ch 4 ,
 .Xr da 4 ,
+.Xr mpr 4 ,
 .Xr mpt 4 ,
 .Xr pci 4 ,
 .Xr sa 4 ,
@@ -238,24 +317,17 @@ Enable prints for controller events.
 .Sh HISTORY
 The
 .Nm
-driver first appeared in
-.Fx 9.0 .
+driver first appeared in FreeBSD 9.3.
 .Sh AUTHORS
-.An -nosplit
 The
 .Nm
 driver was originally written by
-.An Scott Long Aq scottl@FreeBSD.org .
-It has been improved and tested by LSI Logic Corporation.
+.An -nosplit
+.An Scott Long Aq Mt scottl@FreeBSD.org .
+It has been improved and tested by LSI Corporation,
+Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
+.Pp
 This man page was written by
-.An Ken Merry Aq ken@FreeBSD.org .
-.Sh BUGS
-This driver has a couple of known shortcomings:
-.Bl -bullet -compact
-.It
-No userland utility available (e.g.,
-.Xr mptutil 8 ) .
-.It
-The driver probes devices sequentially.
-If your system has a large number of devices, the probe will take a while.
-.El
+.An Ken Merry Aq Mt ken@FreeBSD.org
+with additional input from
+.An Stephen McConnell Aq Mt slm@FreeBSD.org .