2 .\" Copyright (c) 2010 Spectra Logic Corporation
3 .\" Copyright (c) 2014 LSI Corp
4 .\" Copyright (c) 2015-2017 Avago Technologies
5 .\" Copyright (c) 2015-2017 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 .\" mps driver man page.
35 .\" Author: Ken Merry <ken@FreeBSD.org>
36 .\" Author: Stephen McConnell <slm@FreeBSD.org>
38 .\" $Id: //depot/SpectraBSD/head/share/man/man4/mps.4#6 $
46 .Nd "LSI Fusion-MPT 2 IT/IR 6Gb/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)
67 controllers and WarpDrive solid state storage cards.
69 These controllers are supported by the
75 Broadcom Ltd./Avago Tech (LSI) SAS 2004 (4 Port SAS)
77 Broadcom Ltd./Avago Tech (LSI) SAS 2008 (8 Port SAS)
79 Broadcom Ltd./Avago Tech (LSI) SAS 2108 (8 Port SAS)
81 Broadcom Ltd./Avago Tech (LSI) SAS 2116 (16 Port SAS)
83 Broadcom Ltd./Avago Tech (LSI) SAS 2208 (8 Port SAS)
85 Broadcom Ltd./Avago Tech (LSI) SAS 2308 (8 Port SAS)
87 Broadcom Ltd./Avago Tech (LSI) SSS6200 Solid State Storage
89 Intel Integrated RAID Module RMS25JB040
91 Intel Integrated RAID Module RMS25JB080
93 Intel Integrated RAID Module RMS25KB040
95 Intel Integrated RAID Module RMS25KB080
98 In all tunable descriptions below, X represents the adapter number.
100 To disable MSI interrupts for all
102 driver instances, set this tunable value in
104 .Bd -literal -offset indent
108 To disable MSI interrupts for a specific
110 driver instance, set this tunable value in
112 .Bd -literal -offset indent
113 dev.mps.X.disable_msi=1
116 To disable MSI-X interrupts for all
118 driver instances, set this tunable value in
120 .Bd -literal -offset indent
121 hw.mps.disable_msix=1
124 To disable MSI-X interrupts for a specific
126 driver instance, set this tunable value in
128 .Bd -literal -offset indent
129 dev.mps.X.disable_msix=1
132 To set the maximum number of DMA chains allocated for all adapters, set this
135 .Bd -literal -offset indent
136 hw.mps.max_chains=NNNN
139 To set the maximum number of DMA chains allocated for a specific adapter,
142 .Bd -literal -offset indent
143 dev.mps.X.max_chains=NNNN
146 The default max_chains value is 16384.
148 The current number of free chain frames is stored in the
153 The lowest number of free chain frames seen since boot is stored in the
154 dev.mps.X.chain_free_lowwater
158 The number of times that chain frame allocations have failed since boot is
160 dev.mps.X.chain_alloc_fail
163 This can be used to determine whether the max_chains tunable should be
164 increased to help performance.
166 The current number of active I/O commands is shown in the
167 dev.mps.X.io_cmds_active
171 To set the maximum number of pages that will be used per I/O for all adapters,
174 .Bd -literal -offset indent
175 hw.mps.max_io_pages=NNNN
178 To set the maximum number of pages that will be used per I/O for a specific
179 adapter, set this tunable in
181 .Bd -literal -offset indent
182 dev.mps.X.max_io_pages=NNNN
185 The default max_io_pages value is -1, meaning that the maximum I/O size that
186 will be used per I/O will be calculated using the IOCFacts values stored in
188 The lowest value that the driver will use for max_io_pages is 1, otherwise
189 IOCFacts will be used to calculate the maximum I/O size.
190 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
191 maximum I/O size used by the driver.
193 The highest number of active I/O commands seen since boot is stored in the
194 dev.mps.X.io_cmds_highwater
198 Devices can be excluded from
200 control for all adapters by setting this tunable in
202 .Bd -literal -offset indent
206 Y represents the target ID of the device.
207 If more than one device is to be excluded, target IDs are separated by commas.
209 Devices can be excluded from
211 control for a specific adapter by setting this tunable in
213 .Bd -literal -offset indent
214 dev.mps.X.exclude_ids=Y
217 Y represents the target ID of the device.
218 If more than one device is to be excluded, target IDs are separated by commas.
220 The adapter can issue the
222 SCSI command to SATA direct-access devices during shutdown.
223 This allows the device to quiesce powering down.
224 To control this feature for all adapters, set the
225 .Bd -literal -offset indent
231 to one of these values:
232 .Bl -tag -width 6n -offset indent
234 Do not send SSU to either HDDs or SSDs.
236 Send SSU to SSDs, but not to HDDs.
237 This is the default value.
239 Send SSU to HDDs, but not to SSDs.
241 Send SSU to both HDDs and SSDs.
244 To control this feature for a specific adapter, set this tunable value in
246 .Bd -literal -offset indent
250 The same set of values are valid as when setting this tunable for all adapters.
252 SATA disks that take several seconds to spin up and fail the SATA Identify
253 command might not be discovered by the driver.
254 This problem can sometimes be overcome by increasing the value of the spinup
258 .Bd -literal -offset indent
259 hw.mps.spinup_wait_time=NNNN
263 NNNN represents the number of seconds to wait for SATA devices to spin up when
264 the device fails the initial SATA Identify command.
266 Spinup wait times can be set for specific adapters in
269 .Bd -literal -offset indent
270 dev.mps.X.spinup_wait_time=NNNN
274 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
275 the initial SATA Identify command.
277 The driver can map devices discovered by the adapter so that target IDs
278 corresponding to a specific device persist across resets and reboots.
279 In some cases it is possible for devices to lose their mapped IDs due to
280 unexpected behavior from certain hardware, such as some types of enclosures.
281 To overcome this problem, a tunable is provided that will force the driver to
282 map devices using the Phy number associated with the device.
283 This feature is not recommended if the topology includes multiple
284 enclosures/expanders.
285 If multiple enclosures/expanders are present in the topology, Phy numbers are
286 repeated, causing all devices at these Phy numbers except the first device to
288 To control this feature for all adapters, set the
289 .Bd -literal -offset indent
295 to one of these values:
296 .Bl -tag -width 6n -offset indent
298 Only use Phy numbers to map devices and bypass the driver's mapping logic.
300 Never use Phy numbers to map devices.
302 Use Phy numbers to map devices, but only if the driver's mapping logic fails
303 to map the device that is being enumerated.
304 This is the default value.
307 To control this feature for a specific adapter, set this tunable value in
309 .Bd -literal -offset indent
310 dev.mps.X.use_phy_num
313 The same set of values are valid as when setting this tunable for all adapters.
315 Driver diagnostic printing is controlled in
318 .Va hw.mps.debug_level
320 .Va dev.mps.X.debug_level
322 One can alter the debug level for any adapter at run-time using the
325 .Va dev.mps.X.debug_level .
329 variables can be named by either an integer value or a text string.
330 Multiple values can be specified together by either ORing the
331 integer values or by providing a comma-separated list of names.
332 A text string prefixed by
334 adds the specified debug levels to the existing set, while the prefix
336 removes them from the existing set.
339 status is reported in both formats for convenience.
340 The following levels are available:
341 .Bl -column "FlagXX" "NameXXXX" "Description" -offset indent
342 .It Em Flag Ta Em Name Ta Em Description
343 .It 0x0001 Ta info Ta Basic information (enabled by default)
344 .It 0x0002 Ta fault Ta Driver faults (enabled by default)
345 .It 0x0004 Ta event Ta Controller events
346 .It 0x0008 Ta log Ta Logging data from controller
347 .It 0x0010 Ta recovery Ta Tracing of recovery operations
348 .It 0x0020 Ta error Ta Parameter errors and programming bugs
349 .It 0x0040 Ta init Ta System initialization operations
350 .It 0x0080 Ta xinfo Ta More detailed information
351 .It 0x0100 Ta user Ta Tracing of user-generated commands (IOCTL)
352 .It 0x0200 Ta mapping Ta Tracing of device mapping
353 .It 0x0400 Ta trace Ta Tracing through driver functions
372 driver first appeared in
377 driver was originally written by
379 .An Scott Long Aq Mt scottl@FreeBSD.org .
380 It has been improved and tested by LSI Corporation,
381 Avago Technologies (formerly LSI), and Broadcom Ltd. (formerly Avago).
383 This manual page was written by
384 .An Ken Merry Aq Mt ken@FreeBSD.org
385 with additional input from
386 .An Stephen McConnell Aq Mt slm@FreeBSD.org .