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 .\" 3. The name of the author may not be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd April 27, 2010
  29 .Dt MVS 4
  30 .Os
  31 .Sh NAME
  32 .Nm mvs
  33 .Nd Marvell Serial ATA Host Controller driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device pci"
  40 .Cd "device scbus"
  41 .Cd "device mvs"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 mvs_load="YES"
  49 .Ed
  50 .Pp
  51 The following tunables are settable from the
  52 .Xr loader 8 :
  53 .Bl -ohang
  54 .It Va hint.mvs. Ns Ar X Ns Va .msi
  55 controls Message Signaled Interrupts (MSI) usage by the specified controller.
  56 .It Va hint.mvs. Ns Ar X Ns Va .ccc
  57 controls Command Completion Coalescing (CCC) usage by the specified controller.
  58 Non-zero value enables CCC and defines maximum time (in us), request can wait
  59 for interrupt.
  60 CCC reduces number of context switches on systems with many parallel requests,
  61 but it can decrease disk performance on some workloads due to additional
  62 command latency.
  63 .It Va hint.mvs. Ns Ar X Ns Va .cccc
  64 defines number of completed commands for CCC, which trigger interrupt without
  65 waiting for specified coalescing timeout.
  66 .It Va hint.mvs. Ns Ar X Ns Va .pm_level
  67 controls SATA interface Power Management for the specified channel,
  68 allowing some power to be saved at the cost of additional command
  69 latency.
  70 Possible values:
  71 .Bl -tag -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.mvs. 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 Same hardware is also supported by atamarvell and ataadaptec drivers from
 114 .Xr ata 4
 115 subsystem.
 116 If both drivers are loaded at the same time, this one will be
 117 given precedence as the more functional of the two.
 118 .Sh HARDWARE
 119 The
 120 .Nm
 121 driver supports the following controllers:
 122 .Bl -tag -compact
 123 .It Gen-I (SATA 1.5Gbps):
 124 .Bl -bullet -compact
 125 .It
 126 88SX5040
 127 .It
 128 88SX5041
 129 .It
 130 88SX5080
 131 .It
 132 88SX5081
 133 .El
 134 .It Gen-II (SATA 3Gbps, NCQ, PMP):
 135 .Bl -bullet -compact
 136 .It
 137 88SX6040
 138 .It
 139 88SX6041 (including Adaptec 1420SA)
 140 .It
 141 88SX6080
 142 .It
 143 88SX6081
 144 .El
 145 .It Gen-IIe (SATA 3Gbps, NCQ, PMP with FBS):
 146 .Bl -bullet -compact
 147 .It
 148 88SX6042
 149 .It
 150 88SX7042 (including Adaptec 1430SA)
 151 .It
 152 88F5182 SoC
 153 .It
 154 88F6281 SoC
 155 .It
 156 MV78100 SoC
 157 .El
 158 .El
 159 Note, that this hardware supports command queueing and FIS-based switching
 160 only for ATA DMA commands. ATAPI and non-DMA ATA commands executed one by one
 161 for each port.
 162 .Pp
 163 .Sh SEE ALSO
 164 .Xr ada 4 ,
 165 .Xr ata 4 ,
 166 .Xr cam 4 ,
 167 .Xr cd 4 ,
 168 .Xr da 4 ,
 169 .Xr sa 4
 170 .Sh HISTORY
 171 The
 172 .Nm
 173 driver first appeared in
 174 .Fx 8.1 .
 175 .Sh AUTHORS
 176 .An Alexander Motin Aq mav@FreeBSD.org .