mps.4: Sync with FreeBSD to document the current state of affairs.
authorSascha Wildner <saw@online.de>
Wed, 14 Aug 2013 15:38:22 +0000 (17:38 +0200)
committerSascha Wildner <saw@online.de>
Wed, 14 Aug 2013 15:38:45 +0000 (17:38 +0200)
share/man/man4/mps.4

index 56b9574..9ccf64d 100644 (file)
 .\"
 .\" Author: Ken Merry <ken@FreeBSD.org>
 .\"
-.\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#4 $
-.\" $FreeBSD: src/share/man/man4/mps.4,v 1.5 2011/11/11 12:06:09 brueffer Exp $
+.\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
+.\" $FreeBSD: src/share/man/man4/mps.4,v 1.12 2013/01/04 00:45:41 svnexp Exp $
 .\"
-.Dd September 13, 2010
+.Dd August 14, 2013
 .Dt MPS 4
 .Os
 .Sh NAME
@@ -58,11 +58,11 @@ The
 .Nm
 driver provides support for LSI Logic Fusion-MPT 2
 .Tn SAS
-controllers.
+controllers and WarpDrive solid state storage cards.
 .Sh HARDWARE
 The
 .Nm
-driver supports the following controllers:
+driver supports the following hardware:
 .Pp
 .Bl -bullet -compact
 .It
@@ -80,6 +80,19 @@ LSI Logic SAS2116 (16 Port
 .It
 LSI Logic SAS2208 (8 Port
 .Tn SAS )
+.It
+LSI Logic SAS2308 (8 Port
+.Tn SAS )
+.It
+LSI Logic SSS6200 Solid State Storage
+.It
+Intel Integrated RAID Module RMS25JB040
+.It
+Intel Integrated RAID Module RMS25JB080
+.It
+Intel Integrated RAID Module RMS25KB040
+.It
+Intel Integrated RAID Module RMS25KB080
 .El
 .Sh CONFIGURATION
 To disable MSI interrupts for all
@@ -98,19 +111,51 @@ hw.mps.msi.enable=0
 .\"hw.mps.disable_msix=1
 .\".Ed
 .\".Pp
-To allow the driver to send multiple task management commands (like abort,
-LUN reset, etc.), set the following variable:
+.\"To disable MSI-X interrupts for a specific
+.\".Nm
+.\"driver instance, set the following tunable value in
+.\".Xr loader.conf 5 :
+.\".Bd -literal -offset indent
+.\"hw.mpsX.disable_msix=1
+.\".Ed
+.\".Pp
+To set the maximum number of DMA chains allocated for all adapters,
+set the following variable in
+.Xr loader.conf 5 :
 .Bd -literal -offset indent
-hw.mps.X.allow_multiple_tm_cmds=1
+hw.mps.max_chains=NNNN
 .Ed
 .Pp
-via
-.Xr loader.conf 5
-or
-.Xr sysctl 8 ,
-where X is the adapter number.
-By default the driver only sends one task management command at a time, to
-avoid causing a potential controller lock-up.
+To set the maximum number of DMA chains allocated for a specific adapter,
+set the following variable in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+hw.mpsX.max_chains=NNNN
+.Ed
+.Pp
+This variable may also be viewed via
+.Xr sysctl 8
+to see the maximum set for a given adapter.
+.Pp
+The current number of free chain frames may be seen via the
+hw.mpsX.chain_free
+.Xr sysctl 8
+variable.
+.Pp
+The lowest number of free chain frames may be seen via the
+hw.mpsX.chain_free_lowwater
+.Xr sysctl 8
+variable.
+.Pp
+The current number of active I/O commands is shown in the
+hw.mpsX.io_cmds_active
+.Xr sysctl 8
+variable.
+.Pp
+The maximum number of active I/O command seen since boot is shown in the
+hw.mpsX.io_cmds_highwater
+.Xr sysctl 8
+variable.
 .Sh DEBUGGING
 To enable debugging prints from the
 .Nm
@@ -142,7 +187,9 @@ Enable prints for controller events.
 .Xr pci 4 ,
 .Xr sa 4 ,
 .Xr scsi 4 ,
-.Xr targ 4
+.Xr targ 4 ,
+.Xr loader.conf 5 ,
+.Xr sysctl 8
 .Sh HISTORY
 The
 .Nm
@@ -154,20 +201,16 @@ The
 .Nm
 driver was originally written by
 .An Scott Long Aq Mt scottl@FreeBSD.org .
+It has been improved and tested by LSI Logic Corporation.
 This man page was written by
 .An Ken Merry Aq Mt ken@FreeBSD.org .
 .Sh BUGS
-This driver is still in development, it has only been tested on the amd64
-architecture and has some known shortcomings:
+This driver has a couple of known shortcomings:
 .Bl -bullet -compact
 .It
-No IR (Integrated RAID) support.
-.It
-No userland utility support (e.g.
+No userland utility available (e.g.
 .Xr mptutil 8 ) .
 .It
-Sometimes the driver gets into a state where devices arrive and depart multiple
-times, without user intervention.
-.It
-The error recovery code isn't complete.
+The driver probes devices sequentially.
+If your system has a large number of devices, the probe will take a while.
 .El