2010-09-14 21:40:29 +00:00
|
|
|
.\"
|
|
|
|
.\" Copyright (c) 2010 Spectra Logic Corporation
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions, and the following disclaimer,
|
|
|
|
.\" without modification.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
|
|
|
|
.\" substantially similar to the "NO WARRANTY" disclaimer below
|
|
|
|
.\" ("Disclaimer") and any redistribution must be conditioned upon
|
|
|
|
.\" including a substantially similar Disclaimer requirement for further
|
|
|
|
.\" binary redistribution.
|
|
|
|
.\"
|
|
|
|
.\" NO WARRANTY
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
|
|
|
|
.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
|
|
.\" 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.
|
|
|
|
.\"
|
|
|
|
.\" mps driver man page.
|
|
|
|
.\"
|
|
|
|
.\" Author: Ken Merry <ken@FreeBSD.org>
|
|
|
|
.\"
|
2012-02-07 23:43:29 +00:00
|
|
|
.\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
|
2010-09-14 21:40:29 +00:00
|
|
|
.\" $FreeBSD$
|
|
|
|
.\"
|
2012-02-07 23:43:29 +00:00
|
|
|
.Dd February 7, 2012
|
2010-09-14 21:40:29 +00:00
|
|
|
.Dt MPS 4
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm mps
|
|
|
|
.Nd LSI Fusion-MPT 2 Serial Attached SCSI driver
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
To compile this driver into your kernel,
|
|
|
|
place the following lines in your kernel configuration file:
|
|
|
|
.Bd -ragged -offset indent
|
|
|
|
.Cd "device scbus"
|
|
|
|
.Cd "device mps"
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
Or, to load the driver as a module at boot, place the following line in
|
|
|
|
.Xr loader.conf 5 :
|
|
|
|
.Bd -literal -offset indent
|
2010-09-15 16:05:51 +00:00
|
|
|
mps_load="YES"
|
2010-09-14 21:40:29 +00:00
|
|
|
.Ed
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
driver provides support for LSI Logic Fusion-MPT 2
|
|
|
|
.Tn SAS
|
2012-02-07 23:43:29 +00:00
|
|
|
controllers and WarpDrive solid state storage cards.
|
2010-09-14 21:40:29 +00:00
|
|
|
.Sh HARDWARE
|
2011-11-11 12:06:09 +00:00
|
|
|
The
|
2010-09-14 21:40:29 +00:00
|
|
|
.Nm
|
2011-11-11 12:06:09 +00:00
|
|
|
driver supports the following controllers:
|
2010-09-14 21:40:29 +00:00
|
|
|
.Pp
|
|
|
|
.Bl -bullet -compact
|
|
|
|
.It
|
|
|
|
LSI Logic SAS2004 (4 Port
|
|
|
|
.Tn SAS )
|
|
|
|
.It
|
|
|
|
LSI Logic SAS2008 (8 Port
|
|
|
|
.Tn SAS )
|
|
|
|
.It
|
|
|
|
LSI Logic SAS2108 (8 Port
|
|
|
|
.Tn SAS )
|
|
|
|
.It
|
|
|
|
LSI Logic SAS2116 (16 Port
|
|
|
|
.Tn SAS )
|
|
|
|
.It
|
|
|
|
LSI Logic SAS2208 (8 Port
|
|
|
|
.Tn SAS )
|
|
|
|
.El
|
|
|
|
.Sh CONFIGURATION
|
|
|
|
To disable MSI interrupts for all
|
|
|
|
.Nm
|
|
|
|
driver instances, set the following tunable value in
|
|
|
|
.Xr loader.conf 5 :
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
hw.mps.disable_msi=1
|
|
|
|
.Ed
|
|
|
|
.Pp
|
2012-02-07 23:43:29 +00:00
|
|
|
To disable MSI interrupts for a specific
|
|
|
|
.Nm
|
|
|
|
driver instance, set the following 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
|
2010-09-14 21:40:29 +00:00
|
|
|
To disable MSI-X interrupts for all
|
|
|
|
.Nm
|
|
|
|
driver instances, set the following tunable value in
|
|
|
|
.Xr loader.conf 5 :
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
hw.mps.disable_msix=1
|
|
|
|
.Ed
|
Turn on serialization of task management commands going down to the
controller, but make it optional.
After a problem report from Andrew Boyer, it looks like the LSI
chip may have issues (the watchdog timer fired) if too many aborts
are sent down to the chip at the same time. We know that task
management commands are serialized, and although the manual doesn't
say it, it may be a good idea to just send one at a time.
But, since I'm not certain that this is necessary, add a tunable
and sysctl variable (hw.mps.%d.allow_multiple_tm_cmds) to control
the driver's behavior.
mps.c: Add support for the sysctl and tunable, and add a
comment about the possible return values to
mps_map_command().
mps_sas.c: Run all task management commands through two new
routines, mpssas_issue_tm_request() and
mpssas_complete_tm_request().
This allows us to optionally serialize task
management commands. Also, change things so that
the response to a task management command always
comes back through the callback. (Before it could
come via the callback or the return value.)
mpsvar.h: Add softc variables for the list of active task
management commands, the number of active commands,
and whether we should allow multiple active task
management commands. Add an active command flag.
mps.4: Describe the new sysctl/loader tunable variable.
Sponsored by: Spectra Logic Corporation
2010-10-07 21:56:10 +00:00
|
|
|
.Pp
|
2012-02-07 23:43:29 +00:00
|
|
|
To disable MSI-X interrupts for a specific
|
|
|
|
.Nm
|
|
|
|
driver instance, set the following tunable value in
|
|
|
|
.Xr loader.conf 5 :
|
Turn on serialization of task management commands going down to the
controller, but make it optional.
After a problem report from Andrew Boyer, it looks like the LSI
chip may have issues (the watchdog timer fired) if too many aborts
are sent down to the chip at the same time. We know that task
management commands are serialized, and although the manual doesn't
say it, it may be a good idea to just send one at a time.
But, since I'm not certain that this is necessary, add a tunable
and sysctl variable (hw.mps.%d.allow_multiple_tm_cmds) to control
the driver's behavior.
mps.c: Add support for the sysctl and tunable, and add a
comment about the possible return values to
mps_map_command().
mps_sas.c: Run all task management commands through two new
routines, mpssas_issue_tm_request() and
mpssas_complete_tm_request().
This allows us to optionally serialize task
management commands. Also, change things so that
the response to a task management command always
comes back through the callback. (Before it could
come via the callback or the return value.)
mpsvar.h: Add softc variables for the list of active task
management commands, the number of active commands,
and whether we should allow multiple active task
management commands. Add an active command flag.
mps.4: Describe the new sysctl/loader tunable variable.
Sponsored by: Spectra Logic Corporation
2010-10-07 21:56:10 +00:00
|
|
|
.Bd -literal -offset indent
|
2012-02-07 23:43:29 +00:00
|
|
|
dev.mps.X.disable_msix=1
|
Turn on serialization of task management commands going down to the
controller, but make it optional.
After a problem report from Andrew Boyer, it looks like the LSI
chip may have issues (the watchdog timer fired) if too many aborts
are sent down to the chip at the same time. We know that task
management commands are serialized, and although the manual doesn't
say it, it may be a good idea to just send one at a time.
But, since I'm not certain that this is necessary, add a tunable
and sysctl variable (hw.mps.%d.allow_multiple_tm_cmds) to control
the driver's behavior.
mps.c: Add support for the sysctl and tunable, and add a
comment about the possible return values to
mps_map_command().
mps_sas.c: Run all task management commands through two new
routines, mpssas_issue_tm_request() and
mpssas_complete_tm_request().
This allows us to optionally serialize task
management commands. Also, change things so that
the response to a task management command always
comes back through the callback. (Before it could
come via the callback or the return value.)
mpsvar.h: Add softc variables for the list of active task
management commands, the number of active commands,
and whether we should allow multiple active task
management commands. Add an active command flag.
mps.4: Describe the new sysctl/loader tunable variable.
Sponsored by: Spectra Logic Corporation
2010-10-07 21:56:10 +00:00
|
|
|
.Ed
|
|
|
|
.Pp
|
2012-02-07 23:43:29 +00:00
|
|
|
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.max_chains=NNNN
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
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
|
|
|
|
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.
|
|
|
|
.Pp
|
|
|
|
The current number of free chain frames may be seen via the
|
|
|
|
dev.mps.X.chain_free
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable.
|
|
|
|
.Pp
|
|
|
|
The lowest number of free chain frames may be seen via the
|
|
|
|
dev.mps.X.chain_free_lowwater
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable.
|
|
|
|
.Pp
|
|
|
|
The current number of active I/O commands is shown in the
|
|
|
|
dev.mps.X.io_cmds_active
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable.
|
|
|
|
.Pp
|
|
|
|
The maximum number of active I/O command seen since boot is shown in the
|
|
|
|
dev.mps.X.io_cmds_highwater
|
|
|
|
.Xr sysctl 8
|
|
|
|
variable.
|
2010-09-14 21:40:29 +00:00
|
|
|
.Sh DEBUGGING
|
|
|
|
To enable debugging prints from the
|
|
|
|
.Nm
|
|
|
|
driver, set the
|
|
|
|
.Bd -literal -offset indent
|
|
|
|
hw.mps.X.debug_level
|
|
|
|
.Ed
|
|
|
|
.Pp
|
|
|
|
variable, where X is the adapter number, either in
|
|
|
|
.Xr loader.conf 5
|
|
|
|
or via
|
|
|
|
.Xr sysctl 8 .
|
|
|
|
The following bits have the described effects:
|
|
|
|
.Bl -tag -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
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr cd 4 ,
|
|
|
|
.Xr ch 4 ,
|
|
|
|
.Xr da 4 ,
|
|
|
|
.Xr mpt 4 ,
|
|
|
|
.Xr pci 4 ,
|
|
|
|
.Xr sa 4 ,
|
|
|
|
.Xr scsi 4 ,
|
2012-02-07 23:43:29 +00:00
|
|
|
.Xr targ 4 ,
|
|
|
|
.Xr loader.conf 5 ,
|
|
|
|
.Xr sysctl 8
|
2011-06-02 09:56:53 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
driver first appeared in
|
|
|
|
.Fx 9.0 .
|
|
|
|
.Sh AUTHORS
|
|
|
|
.An -nosplit
|
|
|
|
The
|
|
|
|
.Nm
|
|
|
|
driver was originally written by
|
|
|
|
.An Scott Long Aq scottl@FreeBSD.org .
|
2012-02-07 23:43:29 +00:00
|
|
|
It has been improved and tested by LSI Logic Corporation.
|
2011-06-02 09:56:53 +00:00
|
|
|
This man page was written by
|
|
|
|
.An Ken Merry Aq ken@FreeBSD.org .
|
2010-09-14 21:40:29 +00:00
|
|
|
.Sh BUGS
|
2012-02-07 23:43:29 +00:00
|
|
|
This driver has a couple of known shortcomings:
|
2010-09-14 21:40:29 +00:00
|
|
|
.Bl -bullet -compact
|
|
|
|
.It
|
2012-02-07 23:43:29 +00:00
|
|
|
Not endian safe.
|
|
|
|
It only works on little endian machines (e.g. amd64 and i386).
|
2010-09-14 21:40:29 +00:00
|
|
|
.It
|
2012-02-07 23:43:29 +00:00
|
|
|
No userland utility available (e.g.
|
|
|
|
.Xr mptutil 8)
|
2010-09-14 21:40:29 +00:00
|
|
|
.It
|
2012-02-07 23:43:29 +00:00
|
|
|
The driver probes devices sequentially.
|
|
|
|
If your system has a large number of devices, the probe will take a while.
|
2010-09-14 21:40:29 +00:00
|
|
|
.El
|