xref: /dragonfly/share/man/man4/mps.4 (revision c880cbaf)
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: src/share/man/man4/mps.4,v 1.12 2013/01/04 00:45:41 svnexp Exp $
36.\"
37.Dd April 24, 2018
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.msi.enable=0
104.Ed
105.Pp
106.\"To disable MSI-X interrupts for all
107.\".Nm
108.\"driver instances, set the following tunable value in
109.\".Xr loader.conf 5 :
110.\".Bd -literal -offset indent
111.\"hw.mps.disable_msix=1
112.\".Ed
113.\".Pp
114.\"To disable MSI-X interrupts for a specific
115.\".Nm
116.\"driver instance, set the following tunable value in
117.\".Xr loader.conf 5 :
118.\".Bd -literal -offset indent
119.\"hw.mpsX.disable_msix=1
120.\".Ed
121.\".Pp
122To set the maximum number of DMA chains allocated for all adapters,
123set the following variable in
124.Xr loader.conf 5 :
125.Bd -literal -offset indent
126hw.mps.max_chains=NNNN
127.Ed
128.Pp
129To set the maximum number of DMA chains allocated for a specific adapter,
130set the following variable in
131.Xr loader.conf 5 :
132.Bd -literal -offset indent
133hw.mpsX.max_chains=NNNN
134.Ed
135.Pp
136This variable may also be viewed via
137.Xr sysctl 8
138to see the maximum set for a given adapter.
139.Pp
140The current number of free chain frames may be seen via the
141hw.mpsX.chain_free
142.Xr sysctl 8
143variable.
144.Pp
145The lowest number of free chain frames may be seen via the
146hw.mpsX.chain_free_lowwater
147.Xr sysctl 8
148variable.
149.Pp
150The current number of active I/O commands is shown in the
151hw.mpsX.io_cmds_active
152.Xr sysctl 8
153variable.
154.Pp
155The maximum number of active I/O command seen since boot is shown in the
156hw.mpsX.io_cmds_highwater
157.Xr sysctl 8
158variable.
159.Sh DEBUGGING
160To enable debugging prints from the
161.Nm
162driver, set the
163.Bd -literal -offset indent
164hw.mps.X.debug_level
165.Ed
166.Pp
167variable, where X is the adapter number, either in
168.Xr loader.conf 5
169or via
170.Xr sysctl 8 .
171The following bits have the described effects:
172.Bl -tag -offset indent -width "0x01"
173.It 0x01
174Enable informational prints.
175.It 0x02
176Enable tracing prints.
177.It 0x04
178Enable prints for driver faults.
179.It 0x08
180Enable prints for controller events.
181.El
182.Sh SEE ALSO
183.Xr cd 4 ,
184.Xr ch 4 ,
185.Xr da 4 ,
186.Xr mpr 4 ,
187.Xr mpt 4 ,
188.Xr pci 4 ,
189.Xr sa 4 ,
190.Xr scsi 4 ,
191.Xr targ 4 ,
192.Xr loader.conf 5 ,
193.Xr sysctl 8
194.Sh HISTORY
195The
196.Nm
197driver first appeared in
198.Fx 9.0 .
199.Sh AUTHORS
200.An -nosplit
201The
202.Nm
203driver was originally written by
204.An Scott Long Aq Mt scottl@FreeBSD.org .
205It has been improved and tested by LSI Logic Corporation.
206This man page was written by
207.An Ken Merry Aq Mt ken@FreeBSD.org .
208.Sh BUGS
209This driver has a couple of known shortcomings:
210.Bl -bullet -compact
211.It
212No userland utility available (e.g.
213.Xr mptutil 8 ) .
214.It
215The driver probes devices sequentially.
216If your system has a large number of devices, the probe will take a while.
217.El
218