2 .\" Copyright (c) 2010 Spectra Logic Corporation
3 .\" Copyright (c) 2014 LSI Corp
4 .\" Copyright (c) 2016 Avago Technologies
5 .\" Copyright (c) 2016 Broadcom Ltd.
6 .\" All rights reserved.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions, and the following disclaimer,
13 .\" without modification.
14 .\" 2. Redistributions in binary form must reproduce at minimum a disclaimer
15 .\" substantially similar to the "NO WARRANTY" disclaimer below
16 .\" ("Disclaimer") and any redistribution must be conditioned upon
17 .\" including a substantially similar Disclaimer requirement for further
18 .\" binary redistribution.
21 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
24 .\" A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 .\" HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 .\" POSSIBILITY OF SUCH DAMAGES.
33 .\" mpr driver man page.
35 .\" Author: Ken Merry <ken@FreeBSD.org>
36 .\" Author: Stephen McConnell <slm@FreeBSD.org>
46 .Nd "LSI Fusion-MPT 3 IT/IR 12Gb/s Serial Attached SCSI/SATA driver"
48 To compile this driver into the kernel, place these lines in the kernel
50 .Bd -ragged -offset indent
56 The driver can be loaded as a module at boot time by placing this line in
58 .Bd -literal -offset indent
64 driver provides support for Broadcom Ltd./Avago Tech (LSI)
69 These controllers are supported by the
75 Broadcom Ltd./Avago Tech (LSI) SAS 3004 (4 Port SAS)
77 Broadcom Ltd./Avago Tech (LSI) SAS 3008 (8 Port SAS)
79 Broadcom Ltd./Avago Tech (LSI) SAS 3108 (8 Port SAS)
81 Broadcom Ltd./Avago Tech (LSI) SAS 3216 (16 Port SAS)
83 Broadcom Ltd./Avago Tech (LSI) SAS 3224 (24 Port SAS)
87 In all tunable descriptions below, X represents the adapter number.
89 To disable MSI interrupts for all
91 driver instances, set this tunable value in
93 .Bd -literal -offset indent
97 To disable MSI interrupts for a specific
99 driver instance, set this tunable value in
101 .Bd -literal -offset indent
102 dev.mpr.X.disable_msi=1
105 To disable MSI-X interrupts for all
107 driver instances, set this tunable value in
109 .Bd -literal -offset indent
110 hw.mpr.disable_msix=1
113 To disable MSI-X interrupts for a specific
115 driver instance, set this tunable value in
117 .Bd -literal -offset indent
118 dev.mpr.X.disable_msix=1
121 To set the maximum number of DMA chains allocated for all adapters, set
124 .Bd -literal -offset indent
125 hw.mpr.max_chains=NNNN
128 To set the maximum number of DMA chains allocated for a specific adapter,
131 .Bd -literal -offset indent
132 dev.mpr.X.max_chains=NNNN
135 The default max_chains value is 2048.
137 The current number of free chain frames is stored in the
142 The lowest number of free chain frames seen since boot is stored in the
143 dev.mpr.X.chain_free_lowwater
147 The number of times that chain frame allocations have failed since boot is
149 dev.mpr.X.chain_alloc_fail
152 This can be used to determine whether the max_chains tunable should be
153 increased to help performance.
155 The current number of active I/O commands is shown in the
156 dev.mpr.X.io_cmds_active
161 To set the maximum number of pages that will be used per I/O for all adapters,
164 .Bd -literal -offset indent
165 hw.mpr.max_io_pages=NNNN
168 To set the maximum number of pages that will be used per I/O for a specific
169 adapter, set this tunable in
171 .Bd -literal -offset indent
172 dev.mpr.X.max_io_pages=NNNN
175 The default max_io_pages value is -1, meaning that the maximum I/O size that
176 will be used per I/O will be calculated using the IOCFacts values stored in
178 The lowest value that the driver will use for max_io_pages is 1, otherwise
179 IOCFacts will be used to calculate the maximum I/O size.
180 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
181 maximum I/O size used by the driver.
183 The highest number of active I/O commands seen since boot is stored in the
184 dev.mpr.X.io_cmds_highwater
188 Devices can be excluded from
190 control for all adapters by setting this tunable in
192 .Bd -literal -offset indent
196 Y represents the target ID of the device.
197 If more than one device is to be excluded, target IDs are separated by commas.
199 Devices can be excluded from
201 control for a specific adapter by setting this tunable in
203 .Bd -literal -offset indent
204 dev.mpr.X.exclude_ids=Y
207 Y represents the target ID of the device.
208 If more than one device is to be excluded, target IDs are separated by commas.
210 The adapter can issue the
212 SCSI command to SATA direct-access devices during shutdown.
213 This allows the device to quiesce powering down.
214 To control this feature for all adapters, set the
215 .Bd -literal -offset indent
221 to one of these values:
222 .Bl -tag -width 6n -offset indent
224 Do not send SSU to either HDDs or SSDs.
226 Send SSU to SSDs, but not to HDDs.
227 This is the default value.
229 Send SSU to HDDs, but not to SSDs.
231 Send SSU to both HDDs and SSDs.
234 To control the feature for a specific adapter, set this tunable value in
236 .Bd -literal -offset indent
240 The same set of values are valid when setting this tunable for all adapters.
242 SATA disks that take several seconds to spin up and fail the SATA Identify
243 command might not be discovered by the driver.
244 This problem can sometimes be overcome by increasing the value of the spinup
248 .Bd -literal -offset indent
249 hw.mpr.spinup_wait_time=NNNN
253 NNNN represents the number of seconds to wait for SATA devices to spin up when
254 the device fails the initial SATA Identify command.
256 Spinup wait times can be set for specific adapters in
259 .Bd -literal -offset indent
260 dev.mpr.X.spinup_wait_time=NNNN
264 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
265 the initial SATA Identify command.
267 To enable debugging prints from the
270 .Bd -literal -offset indent
278 These bits have the described effects:
279 .Bd -literal -offset indent
280 0x0001 Enable informational prints (set by default).
281 0x0002 Enable prints for driver faults (set by default).
282 0x0004 Enable prints for controller events.
283 0x0008 Enable prints for controller logging.
284 0x0010 Enable prints for tracing recovery operations.
285 0x0020 Enable prints for parameter errors and programming bugs.
286 0x0040 Enable prints for system initialization operations.
287 0x0080 Enable prints for more detailed information.
288 0x0100 Enable prints for user-generated commands (IOCTL).
289 0x0200 Enable prints for device mapping.
290 0x0400 Enable prints for tracing through driver functions.
308 driver first appeared in FreeBSD 9.3.
312 driver was originally written by
314 .An Scott Long Aq Mt scottl@FreeBSD.org .
315 It has been improved and tested by LSI Corporation,
316 Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
318 This man page was written by
319 .An Ken Merry Aq Mt ken@FreeBSD.org
320 with additional input from
321 .An Stephen McConnell Aq Mt slm@FreeBSD.org .