xref: /freebsd/share/man/man4/siis.4 (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
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
52.Xr loader 8 :
53.Bl -ohang
54.It Va hint.siis. Ns Ar X Ns Va .msi
55controls Message Signaled Interrupts (MSI) usage by the specified controller.
56.It Va hint.siisch. Ns Ar X Ns Va .pm_level
57controls SATA interface Power Management for the specified channel,
58allowing some power to be saved at the cost of additional command
59latency.
60Possible values:
61.Bl -tag -compact
62.It 0
63interface Power Management is disabled (default);
64.It 1
65device is allowed to initiate PM state change, host is passive.
66.El
67Note that interface Power Management is not compatible with
68device presence detection.
69A manual bus reset is needed on device hot-plug.
70.It Va hint.siisch. Ns Ar X Ns Va .sata_rev
71setting to nonzero value limits maximum SATA revision (speed).
72Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
73.El
74.Sh DESCRIPTION
75This driver provides the
76.Xr CAM 4
77subsystem with native access to the
78.Tn SATA
79ports of controller.
80Each SATA port is represented to CAM as a separate bus with 16 targets.
81Most of the bus-management details are handled by the SATA-specific
82transport of CAM.
83Connected ATA disks are handled by the ATA protocol disk peripheral driver
84.Xr ada 4 .
85ATAPI devices are handled by the SCSI protocol peripheral drivers
86.Xr cd 4 ,
87.Xr da 4 ,
88.Xr sa 4 ,
89etc.
90.Pp
91Driver features include support for Serial ATA and ATAPI devices,
92Port Multipliers (including FIS-based switching), hardware command queues
93(31 command per port), Native Command Queuing, SATA interface Power Management,
94device hot-plug and Message Signaled Interrupts.
95.Pp
96Same hardware is also supported by the atasiliconimage driver from
97.Xr ata 4
98subsystem.
99If both drivers are loaded at the same time, this one will be
100given precedence as the more functional of the two.
101.Sh HARDWARE
102The
103.Nm
104driver supports the following controllers:
105.Bl -bullet -compact
106.It
107SiI3124
108.It
109SiI3132
110.It
111SiI3531
112.El
113.Sh SEE ALSO
114.Xr ada 4 ,
115.Xr ata 4 ,
116.Xr cam 4 ,
117.Xr cd 4 ,
118.Xr da 4 ,
119.Xr sa 4
120.Sh HISTORY
121The
122.Nm
123driver first appeared in
124.Fx 8.0 .
125.Sh AUTHORS
126.An Alexander Motin Aq mav@FreeBSD.org .
127