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)
86 In all tunable descriptions below, X represents the adapter number.
88 To disable MSI interrupts for all
90 driver instances, set this tunable value in
92 .Bd -literal -offset indent
96 To disable MSI interrupts for a specific
98 driver instance, set this tunable value in
100 .Bd -literal -offset indent
101 dev.mpr.X.disable_msi=1
104 To disable MSI-X interrupts for all
106 driver instances, set this tunable value in
108 .Bd -literal -offset indent
109 hw.mpr.disable_msix=1
112 To disable MSI-X interrupts for a specific
114 driver instance, set this tunable value in
116 .Bd -literal -offset indent
117 dev.mpr.X.disable_msix=1
120 To set the maximum number of DMA chains allocated for all adapters, set
123 .Bd -literal -offset indent
124 hw.mpr.max_chains=NNNN
127 To set the maximum number of DMA chains allocated for a specific adapter,
130 .Bd -literal -offset indent
131 dev.mpr.X.max_chains=NNNN
134 The default max_chains value is 2048.
136 The current number of free chain frames is stored in the
141 The lowest number of free chain frames seen since boot is stored in the
142 dev.mpr.X.chain_free_lowwater
146 The number of times that chain frame allocations have failed since boot is
148 dev.mpr.X.chain_alloc_fail
151 This can be used to determine whether the max_chains tunable should be
152 increased to help performance.
154 The current number of active I/O commands is shown in the
155 dev.mpr.X.io_cmds_active
159 To set the maximum number of pages that will be used per I/O for all adapters,
162 .Bd -literal -offset indent
163 hw.mpr.max_io_pages=NNNN
166 To set the maximum number of pages that will be used per I/O for a specific
167 adapter, set this tunable in
169 .Bd -literal -offset indent
170 dev.mpr.X.max_io_pages=NNNN
173 The default max_io_pages value is -1, meaning that the maximum I/O size that
174 will be used per I/O will be calculated using the IOCFacts values stored in
176 The lowest value that the driver will use for max_io_pages is 1, otherwise
177 IOCFacts will be used to calculate the maximum I/O size.
178 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
179 maximum I/O size used by the driver.
181 The highest number of active I/O commands seen since boot is stored in the
182 dev.mpr.X.io_cmds_highwater
186 Devices can be excluded from
188 control for all adapters by setting this tunable in
190 .Bd -literal -offset indent
194 Y represents the target ID of the device.
195 If more than one device is to be excluded, target IDs are separated by commas.
197 Devices can be excluded from
199 control for a specific adapter by setting this tunable in
201 .Bd -literal -offset indent
202 dev.mpr.X.exclude_ids=Y
205 Y represents the target ID of the device.
206 If more than one device is to be excluded, target IDs are separated by commas.
208 The adapter can issue the
210 SCSI command to SATA direct-access devices during shutdown.
211 This allows the device to quiesce powering down.
212 To control this feature for all adapters, set the
213 .Bd -literal -offset indent
219 to one of these values:
220 .Bl -tag -width 6n -offset indent
222 Do not send SSU to either HDDs or SSDs.
224 Send SSU to SSDs, but not to HDDs.
225 This is the default value.
227 Send SSU to HDDs, but not to SSDs.
229 Send SSU to both HDDs and SSDs.
232 To control the feature for a specific adapter, set this tunable value in
234 .Bd -literal -offset indent
238 The same set of values are valid when setting this tunable for all adapters.
240 SATA disks that take several seconds to spin up and fail the SATA Identify
241 command might not be discovered by the driver.
242 This problem can sometimes be overcome by increasing the value of the spinup
246 .Bd -literal -offset indent
247 hw.mpr.spinup_wait_time=NNNN
251 NNNN represents the number of seconds to wait for SATA devices to spin up when
252 the device fails the initial SATA Identify command.
254 Spinup wait times can be set for specific adapters in
257 .Bd -literal -offset indent
258 dev.mpr.X.spinup_wait_time=NNNN
262 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
263 the initial SATA Identify command.
265 To enable debugging prints from the
268 .Bd -literal -offset indent
276 These bits have the described effects:
277 .Bd -literal -offset indent
278 0x0001 Enable informational prints (set by default).
279 0x0002 Enable prints for driver faults (set by default).
280 0x0004 Enable prints for controller events.
281 0x0008 Enable prints for controller logging.
282 0x0010 Enable prints for tracing recovery operations.
283 0x0020 Enable prints for parameter errors and programming bugs.
284 0x0040 Enable prints for system initialization operations.
285 0x0080 Enable prints for more detailed information.
286 0x0100 Enable prints for user-generated commands (IOCTL).
287 0x0200 Enable prints for device mapping.
288 0x0400 Enable prints for tracing through driver functions.
306 driver first appeared in FreeBSD 9.3.
310 driver was originally written by
312 .An Scott Long Aq Mt scottl@FreeBSD.org .
313 It has been improved and tested by LSI Corporation,
314 Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
316 This man page was written by
317 .An Ken Merry Aq Mt ken@FreeBSD.org
318 with additional input from
319 .An Stephen McConnell Aq Mt slm@FreeBSD.org .