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
99 In all tunable descriptions below, X represents the adapter number.
101 To disable MSI interrupts for all
103 driver instances, set this tunable value in
105 .Bd -literal -offset indent
109 To disable MSI interrupts for a specific
111 driver instance, set this tunable value in
113 .Bd -literal -offset indent
114 dev.mps.X.disable_msi=1
117 To disable MSI-X interrupts for all
119 driver instances, set this tunable value in
121 .Bd -literal -offset indent
122 hw.mps.disable_msix=1
125 To disable MSI-X interrupts for a specific
127 driver instance, set this tunable value in
129 .Bd -literal -offset indent
130 dev.mps.X.disable_msix=1
133 To set the maximum number of DMA chains allocated for all adapters, set this
136 .Bd -literal -offset indent
137 hw.mps.max_chains=NNNN
140 To set the maximum number of DMA chains allocated for a specific adapter,
143 .Bd -literal -offset indent
144 dev.mps.X.max_chains=NNNN
147 The default max_chains value is 2048.
149 The current number of free chain frames is stored in the
154 The lowest number of free chain frames seen since boot is stored in the
155 dev.mps.X.chain_free_lowwater
159 The number of times that chain frame allocations have failed since boot is
161 dev.mps.X.chain_alloc_fail
164 This can be used to determine whether the max_chains tunable should be
165 increased to help performance.
167 The current number of active I/O commands is shown in the
168 dev.mps.X.io_cmds_active
173 To set the maximum number of pages that will be used per I/O for all adapters,
176 .Bd -literal -offset indent
177 hw.mps.max_io_pages=NNNN
180 To set the maximum number of pages that will be used per I/O for a specific
181 adapter, set this tunable in
183 .Bd -literal -offset indent
184 dev.mps.X.max_io_pages=NNNN
187 The default max_io_pages value is -1, meaning that the maximum I/O size that
188 will be used per I/O will be calculated using the IOCFacts values stored in
190 The lowest value that the driver will use for max_io_pages is 1, otherwise
191 IOCFacts will be used to calculate the maximum I/O size.
192 The smaller I/O size calculated from either max_io_pages or IOCFacts will be the
193 maximum I/O size used by the driver.
195 The highest number of active I/O commands seen since boot is stored in the
196 dev.mps.X.io_cmds_highwater
200 Devices can be excluded from
202 control for all adapters by setting this tunable in
204 .Bd -literal -offset indent
208 Y represents the target ID of the device.
209 If more than one device is to be excluded, target IDs are separated by commas.
211 Devices can be excluded from
213 control for a specific adapter by setting this tunable in
215 .Bd -literal -offset indent
216 dev.mps.X.exclude_ids=Y
219 Y represents the target ID of the device.
220 If more than one device is to be excluded, target IDs are separated by commas.
222 The adapter can issue the
224 SCSI command to SATA direct-access devices during shutdown.
225 This allows the device to quiesce powering down.
226 To control this feature for all adapters, set the
227 .Bd -literal -offset indent
233 to one of these values:
234 .Bl -tag -width 6n -offset indent
236 Do not send SSU to either HDDs or SSDs.
238 Send SSU to SSDs, but not to HDDs.
239 This is the default value.
241 Send SSU to HDDs, but not to SSDs.
243 Send SSU to both HDDs and SSDs.
246 To control this feature for a specific adapter, set this tunable value in
248 .Bd -literal -offset indent
252 The same set of values are valid as when setting this tunable for all adapters.
254 SATA disks that take several seconds to spin up and fail the SATA Identify
255 command might not be discovered by the driver.
256 This problem can sometimes be overcome by increasing the value of the spinup
260 .Bd -literal -offset indent
261 hw.mps.spinup_wait_time=NNNN
265 NNNN represents the number of seconds to wait for SATA devices to spin up when
266 the device fails the initial SATA Identify command.
268 Spinup wait times can be set for specific adapters in
271 .Bd -literal -offset indent
272 dev.mps.X.spinup_wait_time=NNNN
276 NNNN is the number of seconds to wait for SATA devices to spin up when they fail
277 the initial SATA Identify command.
279 The driver can map devices discovered by the adapter so that target IDs
280 corresponding to a specific device persist across resets and reboots.
281 In some cases it is possible for devices to lose their mapped IDs due to
282 unexpected behavior from certain hardware, such as some types of enclosures.
283 To overcome this problem, a tunable is provided that will force the driver to
284 map devices using the Phy number associated with the device.
285 This feature is not recommended if the topology includes multiple
286 enclosures/expanders.
287 If multiple enclosures/expanders are present in the topology, Phy numbers are
288 repeated, causing all devices at these Phy numbers except the first device to
290 To control this feature for all adapters, set the
291 .Bd -literal -offset indent
297 to one of these values:
298 .Bl -tag -width 6n -offset indent
300 Only use Phy numbers to map devices and bypass the driver's mapping logic.
302 Never use Phy numbers to map devices.
304 Use Phy numbers to map devices, but only if the driver's mapping logic fails
305 to map the device that is being enumerated.
306 This is the default value.
309 To control this feature for a specific adapter, set this tunable value in
311 .Bd -literal -offset indent
312 dev.mps.X.use_phy_num
315 The same set of values are valid as when setting this tunable for all adapters.
318 To enable debugging prints from the
321 .Bd -literal -offset indent
329 These bits have the described effects:
330 .Bd -literal -offset indent
331 0x0001 Enable informational prints (set by default).
332 0x0002 Enable prints for driver faults (set by default).
333 0x0004 Enable prints for controller events.
334 0x0008 Enable prints for controller logging.
335 0x0010 Enable prints for tracing recovery operations.
336 0x0020 Enable prints for parameter errors and programming bugs.
337 0x0040 Enable prints for system initialization operations.
338 0x0080 Enable prints for more detailed information.
339 0x0100 Enable prints for user-generated commands (IOCTL).
340 0x0200 Enable prints for device mapping.
341 0x0400 Enable prints for tracing through driver functions.
359 driver first appeared in FreeBSD 9.3.
363 driver was originally written by
365 .An Scott Long Aq Mt scottl@FreeBSD.org .
366 It has been improved and tested by LSI Corporation,
367 Avago Technologies (formally LSI), and Broadcom Ltd. (formally Avago).
369 This man page was written by
370 .An Ken Merry Aq Mt ken@FreeBSD.org
371 with additional input from
372 .An Stephen McConnell Aq Mt slm@FreeBSD.org .