1.\" Copyright (c) 2014 LSI Corp 2.\" All rights reserved. 3.\" Author: Kashyap Desai 4.\" Support: freebsdraid@lsi.com 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 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. 17.\" 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. 30.\" 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. 34.\" 35.\" $FreeBSD$ 36.\" 37.Dd February 4, 2021 38.Dt MRSAS 4 39.Os 40.Sh NAME 41.Nm mrsas 42.Nd "LSI MegaRAID 6Gb/s and 12Gb/s SAS+SATA RAID controller driver" 43.Sh SYNOPSIS 44To compile this driver into the kernel, 45place the following lines in your 46kernel configuration file: 47.Bd -ragged -offset indent 48.Cd "device pci" 49.Cd "device mrsas" 50.Ed 51.Pp 52Alternatively, to load the driver as a 53module at boot time, place the following line in 54.Xr loader.conf 5 : 55.Bd -literal -offset indent 56mrsas_load="YES" 57.Ed 58.Sh DESCRIPTION 59The 60.Nm 61driver will detect LSI's next generation (6Gb/s and 12Gb/s) PCI Express 62SAS/SATA RAID controllers. 63See the 64.Nm HARDWARE 65section for the supported devices list. 66A disk (virtual disk/physical disk) attached to the 67.Nm 68driver will be visible to the user through 69.Xr camcontrol 8 70as 71.Pa /dev/da? 72device nodes. 73A simple management interface is also provided on a per-controller basis via the 74.Pa /dev/mrsas? 75device node. 76.Pp 77The 78.Nm 79name is derived from the phrase "MegaRAID SAS HBA", which is 80substantially different than the old "MegaRAID" Driver 81.Xr mfi 4 82which does not connect targets 83to the 84.Xr cam 4 85layer and thus requires a new driver which attaches targets to the 86.Xr cam 4 87layer. 88Older MegaRAID controllers are supported by 89.Xr mfi 4 90and will not work with 91.Nm , 92but both the 93.Xr mfi 4 94and 95.Nm 96drivers can detect and manage the LSI MegaRAID SAS 2208/2308/3008/3108 series of 97controllers. 98.Pp 99The 100.Xr device.hints 5 101option is provided to tune the 102.Nm 103driver's behavior for LSI MegaRAID SAS 2208/2308/3008/3108 controllers. 104By default, the 105.Xr mfi 4 106driver will detect these controllers. 107See the 108.Nm PRIORITY 109section to know more about driver priority for MR-Fusion devices. 110.Pp 111.Nm 112will provide a priority of (-30) (between 113.Dv BUS_PROBE_DEFAULT 114and 115.Dv BUS_PROBE_LOW_PRIORITY ) 116at probe call for device id's 0x005B, 0x005D, and 1170x005F so that 118.Nm 119does not take control of these devices without user intervention. 120.Pp 121Solid-state drives (SSD) get ATA TRIM support with 122.Nm 123if underlying adapter allows it. 124This may require configuring SSD as Non-RAID drive 125rather then JBOD virtual mode. 126.Sh HARDWARE 127The 128.Nm 129driver supports the following hardware: 130.Pp 131[ Thunderbolt 6Gb/s MR controller ] 132.Bl -bullet -compact 133.It 134LSI MegaRAID SAS 9265 135.It 136LSI MegaRAID SAS 9266 137.It 138LSI MegaRAID SAS 9267 139.It 140LSI MegaRAID SAS 9270 141.It 142LSI MegaRAID SAS 9271 143.It 144LSI MegaRAID SAS 9272 145.It 146LSI MegaRAID SAS 9285 147.It 148LSI MegaRAID SAS 9286 149.It 150DELL PERC H810 151.It 152DELL PERC H710/P 153.El 154.Pp 155[ Invader/Fury 12Gb/s MR controller ] 156.Bl -bullet -compact 157.It 158LSI MegaRAID SAS 9380 159.It 160LSI MegaRAID SAS 9361 161.It 162LSI MegaRAID SAS 9341 163.It 164DELL PERC H830 165.It 166DELL PERC H730/P 167.It 168DELL PERC H330 169.El 170.Sh CONFIGURATION 171To disable Online Controller Reset(OCR) for a specific 172.Nm 173driver instance, set the 174following tunable value in 175.Xr loader.conf 5 : 176.Bd -literal -offset indent 177dev.mrsas.X.disable_ocr=1 178.Ed 179.Pp 180where X is the adapter number. 181.Pp 182To change the I/O timeout value for a specific 183.Nm 184driver instance, set the following tunable value in 185.Xr loader.conf 5 : 186.Bd -literal -offset indent 187dev.mrsas.X.mrsas_io_timeout=NNNNNN 188.Ed 189.Pp 190where NNNNNN is the timeout value in milli-seconds. 191.Pp 192To change the firmware fault check timer value for a specific 193.Nm 194driver instance, set the following tunable value in 195.Xr loader.conf 5 : 196.Bd -literal -offset indent 197dev.mrsas.X.mrsas_fw_fault_check_delay=NN 198.Ed 199.Pp 200where NN is the fault check delay value in seconds. 201.Pp 202The current number of active I/O commands is shown in the 203.Va dev.mrsas.X.fw_outstanding 204.Xr sysctl 8 205variable. 206.Sh DEBUGGING 207To enable debugging prints from the 208.Nm 209driver, set the 210.Va hw.mrsas.X.debug_level 211variable, where X is the adapter number, either in 212.Xr loader.conf 5 213or via 214.Xr sysctl 8 . 215The following bits have the described effects: 216.Bl -tag -width indent -offset indent 217.It 0x01 218Enable informational prints. 219.It 0x02 220Enable tracing prints. 221.It 0x04 222Enable prints for driver faults. 223.It 0x08 224Enable prints for OCR and I/O timeout. 225.It 0x10 226Enable prints for AEN events. 227.El 228.Sh PRIORITY 229The 230.Nm 231driver will always set a default (-30) priority in the PCI subsystem for 232selection of MR-Fusion cards. 233(It is between 234.Dv BUS_PROBE_DEFAULT 235and 236.Dv BUS_PROBE_LOW_PRIORITY ) . 237MR-Fusion Controllers include all cards with the 238Device IDs - 2390x005B, 2400x005D, 2410x005F. 242.Pp 243The 244.Xr mfi 4 245driver will set a priority of either 246.Dv BUS_PROBE_DEFAULT 247or 248.Dv BUS_PROBE_LOW_PRIORITY 249(depending on the device.hints setting) in the PCI 250subsystem for selection of MR-Fusion cards. 251With the above design in place, the 252.Xr mfi 4 253driver will attach to a MR-Fusion card given that it has a higher priority than 254.Nm . 255.Pp 256Using 257.Pa /boot/device.hints 258(as mentioned below), the user can provide a preference 259for the 260.Nm 261driver to detect a MR-Fusion card instead of the 262.Xr mfi 4 263driver. 264.Bd -ragged -offset indent 265.Cd hw.mfi.mrsas_enable="1" 266.Ed 267.Pp 268At boot time, the 269.Xr mfi 4 270driver will get priority to detect MR-Fusion controllers by default. 271Before 272changing this default driver selection policy, LSI advises users to understand 273how the driver selection policy works. 274LSI's policy is to provide priority to 275the 276.Xr mfi 4 277driver to detect MR-Fusion cards, but allow for the ability to choose the 278.Nm 279driver to detect MR-Fusion cards. 280.Pp 281LSI recommends setting hw.mfi.mrsas_enable="0" for customers who are using the 282older 283.Xr mfi 4 284driver and do not want to switch to 285.Nm . 286For those customers who are using a MR-Fusion controller for the first time, LSI 287recommends using the 288.Nm 289driver and setting hw.mfi.mrsas_enable="1". 290.Pp 291Changing the default behavior is well tested under most conditions, but 292unexpected behavior may pop up if more complex and unrealistic operations are 293executed by switching between the 294.Xr mfi 4 295and 296.Nm 297drivers for MR-Fusion. 298Switching drivers is designed to happen only one time. 299Although multiple 300switching is possible, it is not recommended. 301The user should decide from 302.Nm Start of Day 303which driver they want to use for the MR-Fusion card. 304.Pp 305The user may see different device names when switching from 306.Xr mfi 4 307to 308.Nm . 309This behavior is 310.Nm Functions As Designed 311and the user needs to change the 312.Xr fstab 5 313entry manually if they are doing any experiments with 314.Xr mfi 4 315and 316.Nm 317interoperability. 318.Sh FILES 319.Bl -tag -width ".Pa /dev/mrsas?" -compact 320.It Pa /dev/da? 321array/logical disk interface 322.It Pa /dev/mrsas? 323management interface 324.El 325.Sh SEE ALSO 326.Xr cam 4 , 327.Xr mfi 4 , 328.Xr pci 4 , 329.Xr device.hints 5 , 330.Xr camcontrol 8 331.Sh HISTORY 332The 333.Nm 334driver first appeared in 335.Fx 10.1 . 336.Bd -ragged 337.Cd "mfi Driver:" 338.Xr mfi 4 339is the old 340.Fx 341driver which started with support for Gen-1 Controllers and 342was extended to support up to MR-Fusion (Device ID = 0x005B, 0x005D, 0x005F). 343.Ed 344.Bd -ragged 345.Cd "mrsas Driver:" 346.Nm 347is the new driver reworked by LSI which supports Thunderbolt and onward 348products. 349The SAS+SATA RAID controller with device id 0x005b is referred to as 350the Thunderbolt controller throughout this man page. 351.Ed 352.Bd -ragged 353.Nm cam aware HBA drivers: 354.Fx 355has a 356.Xr cam 4 357layer which attaches storage devices and provides a common access mechanism to 358storage controllers and attached devices. 359The 360.Nm 361driver is 362.Xr cam 4 363aware and devices associated with 364.Nm 365can be seen using 366.Xr camcontrol 8 . 367The 368.Xr mfi 4 369driver does not understand the 370.Xr cam 4 371layer and it directly associates storage disks to the block layer. 372.Pp 373.Nm Thunderbolt Controller: 374This is the 6Gb/s MegaRAID HBA card which has device id 0x005B. 375.Pp 376.Nm Invader Controller: 377This is 12Gb/s MegaRAID HBA card which has device id 0x005D. 378.Pp 379.Nm Fury Controller: 380This is the 12Gb/s MegaRAID HBA card which has device id 0x005F. 381.Ed 382.Sh AUTHORS 383The 384.Nm 385driver and this manual page were written by 386.An Kashyap Desai Aq Mt Kashyap.Desai@lsi.com . 387.Sh TODO 388The driver does not support alias for device name (it is required when the user 389switches between two drivers and does not want to edit 390.Pa /etc/fstab 391manually). 392.Pp 393The 394.Nm 395driver exposes devices as 396.Pa /dev/da? , 397whereas 398.Xr mfi 4 399exposes devices as 400.Pa /dev/mfid? . 401.Pp 402.Nm 403does not support the Linux Emulator interface. 404.Pp 405.Nm 406will not work with 407.Xr mfiutil 8 . 408