diff options
author | brueffer <brueffer@FreeBSD.org> | 2014-05-16 16:03:26 +0000 |
---|---|---|
committer | brueffer <brueffer@FreeBSD.org> | 2014-05-16 16:03:26 +0000 |
commit | fa02a5fab40e4170f06b272d58cd00f4ca9500e8 (patch) | |
tree | 445744117cb64c268b954023b6e47c0ff88cdb99 /share | |
parent | 6c4033c89f2630952f5b5e5fb6d1a0b35339f2fc (diff) | |
download | FreeBSD-src-fa02a5fab40e4170f06b272d58cd00f4ca9500e8.zip FreeBSD-src-fa02a5fab40e4170f06b272d58cd00f4ca9500e8.tar.gz |
MFC: r265583, r265716
First cleanup pass: new sentence -> new line, mdoc, typos and style.
Fix two more typos. (1)
Submitted by: Trond Endrestol (1)
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man4/mrsas.4 | 127 |
1 files changed, 78 insertions, 49 deletions
diff --git a/share/man/man4/mrsas.4 b/share/man/man4/mrsas.4 index 18c87e0..60c144e 100644 --- a/share/man/man4/mrsas.4 +++ b/share/man/man4/mrsas.4 @@ -27,21 +27,19 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. - +.\" .\" The views and conclusions contained in the software and documentation .\" are those of the authors and should not be interpreted as representing -.\" official policies,either expressed or implied, of the FreeBSD Project +.\" official policies, either expressed or implied, of the FreeBSD Project. .\" .\" $FreeBSD$ .\" - - -.Dd Apr 12, 2013 +.Dd May 8, 2014 .Dt MRSAS 4 .Os .Sh NAME .Nm mrsas -.Nd "LSI MegaRAID 6Gb/s and 12Gb/s SAS+SATA Raid controller driver" +.Nd "LSI MegaRAID 6Gb/s and 12Gb/s SAS+SATA RAID controller driver" .Sh SYNOPSIS To compile this driver into the kernel, place the following lines in your @@ -68,7 +66,8 @@ section for the supported devices list. A disk (virtual disk/physical disk) attached to the .Nm driver will be visible to the user through -.Xr camcontrol 8 as +.Xr camcontrol 8 +as .Pa /dev/da? device nodes. A simple management interface is also provided on a per-controller basis via the @@ -85,7 +84,8 @@ to the .Xr cam 4 layer and thus requires a new driver which attaches targets to the .Xr cam 4 -layer. Older MegaRAID controllers are supported by +layer. +Older MegaRAID controllers are supported by .Xr mfi 4 and will not work with .Nm , @@ -97,19 +97,23 @@ drivers can detect and manage the LSI MegaRAID SAS 2208/2308/3008/3108 series of controllers. .Pp The -.Nm device.hints +.Xr device.hints 5 option is provided to tune the .Nm driver's behavior for LSI MegaRAID SAS 2208/2308/3008/3108 controllers. By default, the .Xr mfi 4 -driver will detect these controllers. See the +driver will detect these controllers. +See the .Nm PRIORITY section to know more about driver priority for MR-Fusion devices. .Pp .Nm -will provide a priority of (-30) (between BUS_PROBE_DEFAULT and -BUS_PROBE_LOW_PRIORITY) at probe call for device id's 0x005B, 0x005D, and +will provide a priority of (-30) (between +.Dv BUS_PROBE_DEFAULT +and +.Dv BUS_PROBE_LOW_PRIORITY ) +at probe call for device id's 0x005B, 0x005D, and 0x005F so that .Nm does not take control of these devices without user intervention. @@ -118,8 +122,8 @@ The .Nm driver supports the following hardware: .Pp +[ Thunderbolt 6Gb/s MR controller ] .Bl -bullet -compact -[ Thunderbolt 6Gbp/s MR controller ] .It LSI MegaRAID SAS 9265 .It @@ -142,8 +146,8 @@ DELL PERC H810 DELL PERC H710/P .El .Pp +[ Invader/Fury 12Gb/s MR controller ] .Bl -bullet -compact -[ Invader/Fury 12Gpb/s MR controller ] .It LSI MegaRAID SAS 9380 .It @@ -169,7 +173,7 @@ dev.mrsas.X.disable_ocr=1 .Pp where X is the adapter number. .Pp -To change the IO timeout value for a specific +To change the I/O timeout value for a specific .Nm driver instance, set the following tunable value in .Xr loader.conf 5 : @@ -190,17 +194,14 @@ dev.mrsas.X.mrsas_fw_fault_check_delay=NN where NN is the fault check delay value in seconds. .Pp The current number of active I/O commands is shown in the -dev.mrsas.X.fw_outstanding +.Va dev.mrsas.X.fw_outstanding .Xr sysctl 8 variable. .Sh DEBUGGING To enable debugging prints from the .Nm driver, set the -.Bd -literal -offset indent -hw.mrsas.X.debug_level -.Ed -.Pp +.Va hw.mrsas.X.debug_level variable, where X is the adapter number, either in .Xr loader.conf 5 or via @@ -214,16 +215,20 @@ Enable tracing prints. .It 0x04 Enable prints for driver faults. .It 0x08 -Enable prints for OCR and IO timeout. +Enable prints for OCR and I/O timeout. .It 0x10 Enable prints for AEN events. .El .Sh PRIORITY The .Nm -driver will always set a default (-30) priority in the pci subsystem for -selection of MR-Fusion cards. (It is between BUS_PROBE_DEFAULT and -BUS_PROBE_LOW_PRIORITY). MR-Fusion Controllers include all cards with the +driver will always set a default (-30) priority in the PCI subsystem for +selection of MR-Fusion cards. +(It is between +.Dv BUS_PROBE_DEFAULT +and +.Dv BUS_PROBE_LOW_PRIORITY ) . +MR-Fusion Controllers include all cards with the Device IDs - 0x005B, 0x005D, @@ -231,14 +236,20 @@ Device IDs - .Pp The .Xr mfi 4 -driver will set a priority of either BUS_PROBE_DEFAULT or -BUS_PROBE_LOW_PRIORITY (depending on the device.hint setting) in the pci -subsystem for selection of MR-Fusion cards. With the above design in place, the +driver will set a priority of either +.Dv BUS_PROBE_DEFAULT +or +.Dv BUS_PROBE_LOW_PRIORITY +(depending on the device.hints setting) in the PCI +subsystem for selection of MR-Fusion cards. +With the above design in place, the .Xr mfi 4 driver will attach to a MR-Fusion card given that it has a higher priority than .Nm . .Pp -Using /boot/device.hints (as mentioned below), the user can provide a preference +Using +.Pa /boot/device.hints +(as mentioned below), the user can provide a preference for the .Nm driver to detect a MR-Fusion card instead of the @@ -250,9 +261,11 @@ driver. .Pp At boot time, the .Xr mfi 4 -driver will get priority to detect MR-Fusion controllers by default. Before +driver will get priority to detect MR-Fusion controllers by default. +Before changing this default driver selection policy, LSI advises users to understand -how the driver selection policy works. LSI's policy is to provide priority to +how the driver selection policy works. +LSI's policy is to provide priority to the .Xr mfi 4 driver to detect MR-Fusion cards, but allow for the ability to choose the @@ -272,11 +285,14 @@ driver and setting hw.mfi.mrsas_enable="1". Changing the default behavior is well tested under most conditions, but unexpected behavior may pop up if more complex and unrealistic operations are executed by switching between the -.Xr mfi 4 and +.Xr mfi 4 +and .Nm drivers for MR-Fusion. -Switching drivers is designed to happen only one time. Although multiple -switching is possible, it is not recommended. The user should decide from +Switching drivers is designed to happen only one time. +Although multiple +switching is possible, it is not recommended. +The user should decide from .Nm Start of Day which driver they want to use for the MR-Fusion card. .Pp @@ -286,7 +302,8 @@ to .Nm . This behavior is .Nm Functions As Designed -and the user needs to change the fstab +and the user needs to change the +.Xr fstab 5 entry manually if they are doing any experiments with .Xr mfi 4 and @@ -294,43 +311,50 @@ and interoperability. .Sh FILES .Bl -tag -width ".Pa /dev/mrsas?" -compact -.It /dev/da? +.It Pa /dev/da? array/logical disk interface -.It /dev/mrsas? +.It Pa /dev/mrsas? management interface .El .Sh SEE ALSO -.Xr pci 4 , -.Xr mfi 4 , .Xr cam 4 , +.Xr mfi 4 , +.Xr pci 4 , .Xr device.hints 5 , +.Xt camcontrol 8 .Sh HISTORY The .Nm driver first appeared in -.Fx 10.0 . +.Fx 10.1 . .Bd -ragged .Cd "mfi Driver:" .Xr mfi 4 -is the old FreeBSD driver which started with support for Gen-1 Controllers and +is the old +.Fx +driver which started with support for Gen-1 Controllers and was extended to support up to MR-Fusion (Device ID = 0x005B, 0x005D, 0x005F). .Ed .Bd -ragged .Cd "mrsas Driver:" .Nm is the new driver reworked by LSI which supports Thunderbolt and onward -products. The SAS+SATA RAID controller with device id 0x005b is referred to as -the Thunderbolt controller throughout in this man page. +products. +The SAS+SATA RAID controller with device id 0x005b is referred to as +the Thunderbolt controller throughout this man page. .Ed .Bd -ragged .Nm cam aware HBA drivers: -FreeBSD has a +.Fx +has a .Xr cam 4 layer which attaches storage devices and provides a common access mechanism to -storage controllers and attached devices. The +storage controllers and attached devices. +The .Nm driver is -.Xr cam 4 aware and devices associated with +.Xr cam 4 +aware and devices associated with .Nm can be seen using .Xr camcontrol 8 . @@ -358,17 +382,22 @@ driver and this manual page were written by The driver does not support big-endian architectures at this time. .Pp The driver does not support alias for device name (it is required when the user -switches between two drivers and does not want to edit /etc/fstab manually). +switches between two drivers and does not want to edit +.Pa /etc/fstab +manually). .Pp The .Nm -driver exposes devices as /dev/da?, whereas +driver exposes devices as +.Pa /dev/da? , +whereas .Xr mfi 4 -exposes deivces as /dev/mfid? +exposes devices as +.Pa /dev/mfid? . .Pp .Nm does not support the Linux Emulator interface. .Pp .Nm will not work with -.Xr mfiutil 8 +.Xr mfiutil 8 . |