Add a missing '-width' in various manpages' lists.
[dragonfly.git] / share / man / man4 / mps.4
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#4 $
35 .\" $FreeBSD: src/share/man/man4/mps.4,v 1.5 2011/11/11 12:06:09 brueffer Exp $
36 .\"
37 .Dd September 13, 2010
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
44 To compile this driver into your kernel,
45 place 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
51 Or, to load the driver as a module at boot, place the following line in
52 .Xr loader.conf 5 :
53 .Bd -literal -offset indent
54 mps_load="YES"
55 .Ed
56 .Sh DESCRIPTION
57 The
58 .Nm
59 driver provides support for LSI Logic Fusion-MPT 2
60 .Tn SAS
61 controllers.
62 .Sh HARDWARE
63 The
64 .Nm
65 driver supports the following controllers:
66 .Pp
67 .Bl -bullet -compact
68 .It
69 LSI Logic SAS2004 (4 Port
70 .Tn SAS )
71 .It
72 LSI Logic SAS2008 (8 Port
73 .Tn SAS )
74 .It
75 LSI Logic SAS2108 (8 Port
76 .Tn SAS )
77 .It
78 LSI Logic SAS2116 (16 Port
79 .Tn SAS )
80 .It
81 LSI Logic SAS2208 (8 Port
82 .Tn SAS )
83 .El
84 .Sh CONFIGURATION
85 To disable MSI interrupts for all
86 .Nm
87 driver instances, set the following tunable value in
88 .Xr loader.conf 5 :
89 .Bd -literal -offset indent
90 hw.mps.msi.enable=0
91 .Ed
92 .Pp
93 .\"To disable MSI-X interrupts for all
94 .\".Nm
95 .\"driver instances, set the following tunable value in
96 .\".Xr loader.conf 5 :
97 .\".Bd -literal -offset indent
98 .\"hw.mps.disable_msix=1
99 .\".Ed
100 .\".Pp
101 To allow the driver to send multiple task management commands (like abort,
102 LUN reset, etc.), set the following variable:
103 .Bd -literal -offset indent
104 hw.mps.X.allow_multiple_tm_cmds=1
105 .Ed
106 .Pp
107 via
108 .Xr loader.conf 5
109 or
110 .Xr sysctl 8 ,
111 where X is the adapter number.
112 By default the driver only sends one task management command at a time, to
113 avoid causing a potential controller lock-up.
114 .Sh DEBUGGING
115 To enable debugging prints from the
116 .Nm
117 driver, set the
118 .Bd -literal -offset indent
119 hw.mps.X.debug_level
120 .Ed
121 .Pp
122 variable, where X is the adapter number, either in
123 .Xr loader.conf 5
124 or via
125 .Xr sysctl 8 .
126 The following bits have the described effects:
127 .Bl -tag -offset indent -width "0x01"
128 .It 0x01
129 Enable informational prints.
130 .It 0x02
131 Enable tracing prints.
132 .It 0x04
133 Enable prints for driver faults.
134 .It 0x08
135 Enable prints for controller events.
136 .El
137 .Sh SEE ALSO
138 .Xr cd 4 ,
139 .Xr ch 4 ,
140 .Xr da 4 ,
141 .Xr mpt 4 ,
142 .Xr pci 4 ,
143 .Xr sa 4 ,
144 .Xr scsi 4 ,
145 .Xr targ 4
146 .Sh HISTORY
147 The
148 .Nm
149 driver first appeared in
150 .Fx 9.0 .
151 .Sh AUTHORS
152 .An -nosplit
153 The
154 .Nm
155 driver was originally written by
156 .An Scott Long Aq scottl@FreeBSD.org .
157 This man page was written by
158 .An Ken Merry Aq ken@FreeBSD.org .
159 .Sh BUGS
160 This driver is still in development, it has only been tested on the amd64
161 architecture and has some known shortcomings:
162 .Bl -bullet -compact
163 .It
164 No IR (Integrated RAID) support.
165 .It
166 No userland utility support (e.g.
167 .Xr mptutil 8 ) .
168 .It
169 Sometimes the driver gets into a state where devices arrive and depart multiple
170 times, without user intervention.
171 .It
172 The error recovery code isn't complete.
173 .El