xref: /freebsd/share/man/man4/siis.4 (revision 830940567b49bb0c08dfaed40418999e76616909)
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 July 18, 2009
29.Dt SIIS 4
30.Os
31.Sh NAME
32.Nm siis
33.Nd SiliconImage Serial ATA Host Controller driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device pci"
40.Cd "device scbus"
41.Cd "device siis"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48siis_load="YES"
49.Ed
50.Pp
51The following tunables are settable from the loader:
52.Bl -ohang
53.It Va hint.siis.X.msi
54controls Message Signaled Interrupts (MSI) usage by the specified controller.
55.It Va hint.siisch.X.pm_level
56controls SATA interface Power Management for specified channel,
57allowing some power to be saved at the cost of additional command
58latency.
59Possible values:
60.Bl -tag -compact
61.It 0
62interface Power Management is disabled (default);
63.It 1
64device is allowed to initiate PM state change, host is passive.
65.El
66Note that interface Power Management is not compatible with
67device presence detection.
68You will have to reset bus manually on device hot-plug.
69.It Va hint.siisch.X.sata_rev
70setting to nonzero value limits maximum SATA revision (speed).
71Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
72.El
73.Sh DESCRIPTION
74This driver provides the CAM subsystem native access to the
75.Tn SATA
76ports of controller.
77Each SATA port is represented to CAM as a separate bus with 16 targets.
78Most of the bus-management details are handled by the SATA-specific
79transport of CAM.
80Connected ATA disks are handled by the ATA protocol disk peripheral driver
81.Xr ada 4 .
82ATAPI devices are handled by the SCSI protocol peripheral drivers
83.Xr cd 4 ,
84.Xr da 4 ,
85.Xr sa 4 ,
86etc.
87.Pp
88Driver features include support for Serial ATA and ATAPI devices,
89Port Multipliers (including FIS-based switching), hardware command queues
90(31 command per port), Native Command Queuing, SATA interface Power Management,
91device hot-plug and Message Signaled Interrupts.
92.Pp
93Same hardware is also supported by atasiliconimage driver from
94.Xr ata 4
95subsystem. If both drivers are loaded at the same time, this one will be
96given precedence as the more functional of the two.
97.Sh HARDWARE
98The
99.Nm
100driver supports following controllers:
101.Bl -bullet -compact
102.It
103SiI3124
104.It
105SiI3132
106.It
107SiI3531
108.El
109.Sh SEE ALSO
110.Xr ada 4 ,
111.Xr cd 4 ,
112.Xr da 4 ,
113.Xr sa 4 ,
114.Xr scsi 4 ,
115.Xr ata 4
116.Sh HISTORY
117The
118.Nm
119driver first appeared in
120.Fx 8.0 .
121.Sh AUTHORS
122.An Alexander Motin Aq mav@FreeBSD.org .
123