xref: /freebsd/share/man/man4/mps.4 (revision 246e7a2b6494cd991b08ac669ed761ecea0cc98c)
1.\"
2.\" Copyright (c) 2010 Spectra Logic Corporation
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions, and the following disclaimer,
10.\"    without modification.
11.\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
12.\"    substantially similar to the "NO WARRANTY" disclaimer below
13.\"    ("Disclaimer") and any redistribution must be conditioned upon
14.\"    including a substantially similar Disclaimer requirement for further
15.\"    binary redistribution.
16.\"
17.\" NO WARRANTY
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
21.\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22.\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGES.
29.\"
30.\" mps driver man page.
31.\"
32.\" Author: Ken Merry <ken@FreeBSD.org>
33.\"
34.\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
35.\" $FreeBSD$
36.\"
37.Dd January 3, 2013
38.Dt MPS 4
39.Os
40.Sh NAME
41.Nm mps
42.Nd LSI Fusion-MPT 2 Serial Attached SCSI driver
43.Sh SYNOPSIS
44To compile this driver into your kernel,
45place the following lines in your kernel configuration file:
46.Bd -ragged -offset indent
47.Cd "device scbus"
48.Cd "device mps"
49.Ed
50.Pp
51Or, to load the driver as a module at boot, place the following line in
52.Xr loader.conf 5 :
53.Bd -literal -offset indent
54mps_load="YES"
55.Ed
56.Sh DESCRIPTION
57The
58.Nm
59driver provides support for LSI Logic Fusion-MPT 2
60.Tn SAS
61controllers and WarpDrive solid state storage cards.
62.Sh HARDWARE
63The
64.Nm
65driver supports the following hardware:
66.Pp
67.Bl -bullet -compact
68.It
69LSI Logic SAS2004 (4 Port
70.Tn SAS )
71.It
72LSI Logic SAS2008 (8 Port
73.Tn SAS )
74.It
75LSI Logic SAS2108 (8 Port
76.Tn SAS )
77.It
78LSI Logic SAS2116 (16 Port
79.Tn SAS )
80.It
81LSI Logic SAS2208 (8 Port
82.Tn SAS )
83.It
84LSI Logic SAS2308 (8 Port
85.Tn SAS )
86.It
87LSI Logic 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
98To disable MSI interrupts for all
99.Nm
100driver instances, set the following tunable value in
101.Xr loader.conf 5 :
102.Bd -literal -offset indent
103hw.mps.disable_msi=1
104.Ed
105.Pp
106To disable MSI interrupts for a specific
107.Nm
108driver instance, set the following tunable value in
109.Xr loader.conf 5 :
110.Bd -literal -offset indent
111dev.mps.X.disable_msi=1
112.Ed
113.Pp
114where X is the adapter number.
115.Pp
116To disable MSI-X interrupts for all
117.Nm
118driver instances, set the following 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 the following 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,
133set the following variable 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 the following variable in
141.Xr loader.conf 5 :
142.Bd -literal -offset indent
143dev.mps.X.max_chains=NNNN
144.Ed
145.Pp
146This variable may also be viewed via
147.Xr sysctl 8
148to see the maximum set for a given adapter.
149.Pp
150The current number of free chain frames may be seen via the
151dev.mps.X.chain_free
152.Xr sysctl 8
153variable.
154.Pp
155The lowest number of free chain frames may be seen via the
156dev.mps.X.chain_free_lowwater
157.Xr sysctl 8
158variable.
159.Pp
160The current number of active I/O commands is shown in the
161dev.mps.X.io_cmds_active
162.Xr sysctl 8
163variable.
164.Pp
165The maximum number of active I/O command seen since boot is shown in the
166dev.mps.X.io_cmds_highwater
167.Xr sysctl 8
168variable.
169.Sh DEBUGGING
170To enable debugging prints from the
171.Nm
172driver, set the
173.Bd -literal -offset indent
174hw.mps.X.debug_level
175.Ed
176.Pp
177variable, where X is the adapter number, either in
178.Xr loader.conf 5
179or via
180.Xr sysctl 8 .
181The following bits have the described effects:
182.Bl -tag -width 6n -offset indent
183.It 0x01
184Enable informational prints.
185.It 0x02
186Enable tracing prints.
187.It 0x04
188Enable prints for driver faults.
189.It 0x08
190Enable prints for controller events.
191.El
192.Sh SEE ALSO
193.Xr cd 4 ,
194.Xr ch 4 ,
195.Xr da 4 ,
196.Xr mpt 4 ,
197.Xr pci 4 ,
198.Xr sa 4 ,
199.Xr scsi 4 ,
200.Xr targ 4 ,
201.Xr loader.conf 5 ,
202.Xr sysctl 8
203.Sh HISTORY
204The
205.Nm
206driver first appeared in
207.Fx 9.0 .
208.Sh AUTHORS
209.An -nosplit
210The
211.Nm
212driver was originally written by
213.An Scott Long Aq Mt scottl@FreeBSD.org .
214It has been improved and tested by LSI Logic Corporation.
215This man page was written by
216.An Ken Merry Aq Mt ken@FreeBSD.org .
217.Sh BUGS
218This driver has a couple of known shortcomings:
219.Bl -bullet -compact
220.It
221No userland utility available (e.g.
222.Xr mptutil 8 ) .
223.It
224The driver probes devices sequentially.
225If your system has a large number of devices, the probe will take a while.
226.El
227