share/man/man4/mvs.4

   1 .\" Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 3, 2013
  28 .Dt MVS 4
  29 .Os
  30 .Sh NAME
  31 .Nm mvs
  32 .Nd Marvell Serial ATA Host Controller driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device pci"
  39 .Cd "device scbus"
  40 .Cd "device mvs"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 mvs_load="YES"
  48 .Ed
  49 .Pp
  50 The following tunables are settable from the
  51 .Xr loader 8 :
  52 .Bl -ohang
  53 .It Va hint.mvs. Ns Ar X Ns Va .msi
  54 controls Message Signaled Interrupts (MSI) usage by the specified controller.
  55 .It Va hint.mvs. Ns Ar X Ns Va .ccc
  56 controls Command Completion Coalescing (CCC) usage by the specified controller.
  57 Non-zero value enables CCC and defines maximum time (in us), request can wait
  58 for interrupt.
  59 CCC reduces number of context switches on systems with many parallel requests,
  60 but it can decrease disk performance on some workloads due to additional
  61 command latency.
  62 .It Va hint.mvs. Ns Ar X Ns Va .cccc
  63 defines number of completed commands for CCC, which trigger interrupt without
  64 waiting for specified coalescing timeout.
  65 .It Va hint.mvsch. Ns Ar X Ns Va .pm_level
  66 controls SATA interface Power Management for the specified channel,
  67 allowing some power to be saved at the cost of additional command
  68 latency.
  69 Possible values:
  70 .Pp
  71 .Bl -tag -width 4n -offset indent -compact
  72 .It 0
  73 interface Power Management is disabled (default);
  74 .It 1
  75 device is allowed to initiate PM state change, host is passive;
  76 .It 4
  77 driver initiates PARTIAL PM state transition 1ms after port becomes idle;
  78 .It 5
  79 driver initiates SLUMBER PM state transition 125ms after port becomes idle.
  80 .El
  81 .Pp
  82 Note that interface Power Management is not compatible with
  83 device presence detection.
  84 A manual bus reset is needed on device hot-plug.
  85 .It Va hint.mvsch. Ns Ar X Ns Va .sata_rev
  86 setting to nonzero value limits maximum SATA revision (speed).
  87 Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
  88 .El
  89 .Sh DESCRIPTION
  90 This driver provides the
  91 .Xr CAM 4
  92 subsystem with native access to the
  93 .Tn SATA
  94 ports of several generations (Gen-I/II/IIe) of Marvell SATA controllers.
  95 Each SATA port found is represented to CAM as a separate bus with one
  96 target, or, if HBA supports Port Multipliers (Gen-II/IIe), 16 targets.
  97 Most of the bus-management details are handled by the SATA-specific
  98 transport of CAM.
  99 Connected ATA disks are handled by the ATA protocol disk peripheral driver
 100 .Xr ada 4 .
 101 ATAPI devices are handled by the SCSI protocol peripheral drivers
 102 .Xr cd 4 ,
 103 .Xr da 4 ,
 104 .Xr sa 4 ,
 105 etc.
 106 .Pp
 107 Driver features include support for Serial ATA and ATAPI devices,
 108 Port Multipliers (including FIS-based switching, when supported),
 109 hardware command queues (up to 31 command per port),
 110 Native Command Queuing, SATA interface Power Management, device hot-plug
 111 and Message Signaled Interrupts.
 112 .Pp
 113 The same hardware is also supported by the atamarvell and ataadaptec
 114 drivers from the
 115 .Xr ata 4
 116 subsystem.
 117 If both drivers are loaded at the same time, this one will be
 118 given precedence as the more functional of the two.
 119 .Sh HARDWARE
 120 The
 121 .Nm
 122 driver supports the following controllers:
 123 .Pp
 124 Gen-I (SATA 1.5Gbps):
 125 .Bl -bullet -compact -offset "xxxxxx"
 126 .It
 127 88SX5040
 128 .It
 129 88SX5041
 130 .It
 131 88SX5080
 132 .It
 133 88SX5081
 134 .El
 135 .Pp
 136 Gen-II (SATA 3Gbps, NCQ, PMP):
 137 .Bl -bullet -compact -offset "xxxxxx"
 138 .It
 139 88SX6040
 140 .It
 141 88SX6041 (including Adaptec 1420SA)
 142 .It
 143 88SX6080
 144 .It
 145 88SX6081
 146 .El
 147 .Pp
 148 Gen-IIe (SATA 3Gbps, NCQ, PMP with FBS):
 149 .Bl -bullet -compact -offset "xxxxxx"
 150 .It
 151 88SX6042
 152 .It
 153 88SX7042 (including Adaptec 1430SA)
 154 .It
 155 88F5182 SoC
 156 .It
 157 88F6281 SoC
 158 .It
 159 MV78100 SoC
 160 .El
 161 .Pp
 162 Note, that this hardware supports command queueing and FIS-based switching
 163 only for ATA DMA commands.
 164 ATAPI and non-DMA ATA commands executed one by one for each port.
 165 .Sh SEE ALSO
 166 .Xr ada 4 ,
 167 .Xr ata 4 ,
 168 .Xr cam 4 ,
 169 .Xr cd 4 ,
 170 .Xr da 4 ,
 171 .Xr sa 4
 172 .Sh HISTORY
 173 The
 174 .Nm
 175 driver first appeared in
 176 .Fx 8.1 .
 177 .Sh AUTHORS
 178 .An Alexander Motin Aq mav@FreeBSD.org