xref: /freebsd/share/man/man4/mvs.4 (revision a2f733abcff64628b7771a47089628b7327a88bd)
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.Dd March 23, 2015
26.Dt MVS 4
27.Os
28.Sh NAME
29.Nm mvs
30.Nd Marvell Serial ATA Host Controller driver
31.Sh SYNOPSIS
32To compile this driver into the kernel,
33place the following lines in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device pci"
37.Cd "device scbus"
38.Cd "device mvs"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45mvs_load="YES"
46.Ed
47.Pp
48The following tunables are settable from the
49.Xr loader 8 :
50.Bl -ohang
51.It Va hint.mvs. Ns Ar X Ns Va .msi
52controls Message Signaled Interrupts (MSI) usage by the specified controller.
53.It Va hint.mvs. Ns Ar X Ns Va .ccc
54controls Command Completion Coalescing (CCC) usage by the specified controller.
55Non-zero value enables CCC and defines maximum time (in us), request can wait
56for interrupt.
57CCC reduces number of context switches on systems with many parallel requests,
58but it can decrease disk performance on some workloads due to additional
59command latency.
60.It Va hint.mvs. Ns Ar X Ns Va .cccc
61defines number of completed commands for CCC, which trigger interrupt without
62waiting for specified coalescing timeout.
63.It Va hint.mvsch. Ns Ar X Ns Va .pm_level
64controls SATA interface Power Management for the specified channel,
65allowing some power to be saved at the cost of additional command
66latency.
67Possible values:
68.Pp
69.Bl -tag -width 4n -offset indent -compact
70.It 0
71interface Power Management is disabled (default);
72.It 1
73device is allowed to initiate PM state change, host is passive;
74.It 4
75driver initiates PARTIAL PM state transition 1ms after port becomes idle;
76.It 5
77driver initiates SLUMBER PM state transition 125ms after port becomes idle.
78.El
79.Pp
80Note that interface Power Management is not compatible with
81device presence detection.
82A manual bus reset is needed on device hot-plug.
83.It Va hint.mvsch. Ns Ar X Ns Va .sata_rev
84setting to nonzero value limits maximum SATA revision (speed).
85Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
86.El
87.Sh DESCRIPTION
88This driver provides the
89.Xr CAM 4
90subsystem with native access to the
91.Tn SATA
92ports of several generations (Gen-I/II/IIe) of Marvell SATA controllers.
93Each SATA port found is represented to CAM as a separate bus with one
94target, or, if HBA supports Port Multipliers (Gen-II/IIe), 16 targets.
95Most of the bus-management details are handled by the SATA-specific
96transport of CAM.
97Connected ATA disks are handled by the ATA protocol disk peripheral driver
98.Xr ada 4 .
99ATAPI devices are handled by the SCSI protocol peripheral drivers
100.Xr cd 4 ,
101.Xr da 4 ,
102.Xr sa 4 ,
103etc.
104.Pp
105Driver features include support for Serial ATA and ATAPI devices,
106Port Multipliers (including FIS-based switching, when supported),
107hardware command queues (up to 31 command per port),
108Native Command Queuing, SATA interface Power Management, device hot-plug
109and Message Signaled Interrupts.
110.Sh HARDWARE
111The
112.Nm
113driver supports the following controllers:
114.Pp
115Gen-I (SATA 1.5Gbps):
116.Bl -bullet -compact -offset "xxxxxx"
117.It
11888SX5040
119.It
12088SX5041
121.It
12288SX5080
123.It
12488SX5081
125.El
126.Pp
127Gen-II (SATA 3Gbps, NCQ, PMP):
128.Bl -bullet -compact -offset "xxxxxx"
129.It
13088SX6040
131.It
13288SX6041 (including Adaptec 1420SA)
133.It
13488SX6080
135.It
13688SX6081
137.El
138.Pp
139Gen-IIe (SATA 3Gbps, NCQ, PMP with FBS):
140.Bl -bullet -compact -offset "xxxxxx"
141.It
14288SX6042
143.It
14488SX7042 (including Adaptec 1430SA)
145.It
14688F5182 SoC
147.It
14888F6281 SoC
149.It
150MV78100 SoC
151.El
152.Pp
153Note, that this hardware supports command queueing and FIS-based switching
154only for ATA DMA commands.
155ATAPI and non-DMA ATA commands executed one by one for each port.
156.Sh SEE ALSO
157.Xr ada 4 ,
158.Xr ata 4 ,
159.Xr cam 4 ,
160.Xr cd 4 ,
161.Xr da 4 ,
162.Xr sa 4
163.Sh HISTORY
164The
165.Nm
166driver first appeared in
167.Fx 8.1 .
168.Sh AUTHORS
169.An Alexander Motin Aq Mt mav@FreeBSD.org
170