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