1 .\" Copyright (c) 2014 LSI Corp
2 .\" All rights reserved.
3 .\" Author: Kashyap Desai
4 .\" Support: freebsdraid@lsi.com
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the <ORGANIZATION> nor the names of its
15 .\" contributors may be used to endorse or promote products derived
16 .\" from this software without specific prior written permission.
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 MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 .\" POSSIBILITY OF SUCH DAMAGE.
31 .\" The views and conclusions contained in the software and documentation
32 .\" are those of the authors and should not be interpreted as representing
33 .\" official policies, either expressed or implied, of the FreeBSD Project.
35 .\" $FreeBSD: head/share/man/man4/mrsas.4 267182 2014-06-06 19:00:43Z joel $
42 .Nd "LSI MegaRAID 6Gb/s and 12Gb/s SAS+SATA RAID controller driver"
44 To compile this driver into the kernel,
45 place the following lines in your
46 kernel configuration file:
47 .Bd -ragged -offset indent
52 Alternatively, to load the driver as a
53 module at boot time, place the following line in
55 .Bd -literal -offset indent
61 driver will detect LSI's next generation (6Gb/s and 12Gb/s) PCI Express
62 SAS/SATA RAID controllers.
65 section for the supported devices list.
66 A disk (virtual disk/physical disk) attached to the
68 driver will be visible to the user through
73 A simple management interface is also provided on a per-controller basis via the
79 name is derived from the phrase "MegaRAID SAS HBA", which is
80 substantially different than the old "MegaRAID" Driver
82 which does not connect targets
85 layer and thus requires a new driver which attaches targets to the
88 Older MegaRAID controllers are supported by
92 and will not work with
98 drivers can detect and manage the LSI MegaRAID SAS 2208/2308/3008/3108 series of
103 driver supports the following hardware:
105 [ Thunderbolt 6Gb/s MR controller ]
108 LSI MegaRAID SAS 9265
110 LSI MegaRAID SAS 9266
112 LSI MegaRAID SAS 9267
114 LSI MegaRAID SAS 9270
116 LSI MegaRAID SAS 9271
118 LSI MegaRAID SAS 9272
120 LSI MegaRAID SAS 9285
122 LSI MegaRAID SAS 9286
129 [ Invader/Fury 12Gb/s MR controller ]
132 LSI MegaRAID SAS 9380
134 LSI MegaRAID SAS 9361
136 LSI MegaRAID SAS 9341
145 A tunable is provided to adjust the
147 driver's behaviour when attaching to a card.
148 By default, the driver will attach to all known cards with
152 series cards this behavior can be changed to attaching via the
154 driver by setting the following tunable value in
156 .Bd -literal -offset indent
157 hw.mrsas.mfi_enable=1
160 By default, the driver will use MSI if it is supported.
161 This behavior can be turned off by setting the following tunable value in
163 .Bd -literal -offset indent
164 hw.mrsas.msi.enable=0
167 To disable Online Controller Reset(OCR) for a specific
169 driver instance, set the
170 following tunable value in
172 .Bd -literal -offset indent
173 hw.mrsasX.disable_ocr=1
176 where X is the adapter number.
178 To change the I/O timeout value for a specific
180 driver instance, set the following tunable value in
182 .Bd -literal -offset indent
183 hw.mrsasX.mrsas_io_timeout=NNNNNN
186 where NNNNNN is the timeout value in milli-seconds.
188 To change the firmware fault check timer value for a specific
190 driver instance, set the following tunable value in
192 .Bd -literal -offset indent
193 hw.mrsasX.mrsas_fw_fault_check_delay=NN
196 where NN is the fault check delay value in seconds.
198 The current number of active I/O commands is shown in the
199 .Va dev.mrsas.X.fw_outstanding
203 To enable debugging prints from the
206 .Va dev.mrsas.X.debug_level
207 variable, where X is the adapter number, either in
211 The following bits have the described effects:
213 .Bl -tag -width "0x01" -offset indent -compact
215 Enable informational prints.
217 Enable tracing prints.
219 Enable prints for driver faults.
221 Enable prints for OCR and I/O timeout.
223 Enable prints for AEN events.
226 .Bl -tag -width ".Pa /dev/mrsas?" -compact
228 array/logical disk interface
242 driver first appeared in
251 driver which started with support for Gen-1 Controllers and
252 was extended to support up to MR-Fusion (Device ID = 0x005B, 0x005D, 0x005F).
257 is the new driver reworked by LSI which supports Thunderbolt and onward
259 The SAS+SATA RAID controller with device id 0x005b is referred to as
260 the Thunderbolt controller throughout this man page.
263 .Nm cam aware HBA drivers:
267 layer which attaches storage devices and provides a common access mechanism to
268 storage controllers and attached devices.
273 aware and devices associated with
279 driver does not understand the
281 layer and it directly associates storage disks to the block layer.
283 .Nm Thunderbolt Controller:
284 This is the 6Gb/s MegaRAID HBA card which has device id 0x005B.
286 .Nm Invader Controller:
287 This is 12Gb/s MegaRAID HBA card which has device id 0x005D.
290 This is the 12Gb/s MegaRAID HBA card which has device id 0x005F.
295 driver and this manual page were written by
296 .An Kashyap Desai Aq Mt Kashyap.Desai@lsi.com .
300 .An Sascha Wildner Aq Mt swildner@dragonflybsd.org .
302 .\"The driver does not support big-endian architectures at this time.
304 The driver does not support alias for device name (it is required when the user
305 switches between two drivers and does not want to edit
310 It is recommended to use the approriate device nodes in
313 They should be available for all controllers supported by
318 driver exposes devices as