xref: /freebsd/share/man/man4/siis.4 (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
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 8, 2011
28.Dt SIIS 4
29.Os
30.Sh NAME
31.Nm siis
32.Nd SiliconImage 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 siis"
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
47siis_load="YES"
48.Ed
49.Pp
50The following tunables are settable from the
51.Xr loader 8 :
52.Bl -ohang
53.It Va hint.siis. Ns Ar X Ns Va .msi
54controls Message Signaled Interrupts (MSI) usage by the specified controller.
55.It Va hint.siisch. Ns Ar X Ns Va .pm_level
56controls SATA interface Power Management for the specified channel,
57allowing some power to be saved at the cost of additional command
58latency.
59Possible values:
60.Bl -tag -width 2n -offset indent
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
66.Pp
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
96The activity LEDs of the adapters supported by the
97.Nm
98driver can be controlled via the
99.Xr led 4
100API for localization or status reporting purposes.
101.Pp
102Same hardware is also supported by the atasiliconimage driver from
103.Xr ata 4
104subsystem.
105If both drivers are loaded at the same time, this one will be
106given precedence as the more functional of the two.
107.Sh HARDWARE
108The
109.Nm
110driver supports the following controller chips:
111.Pp
112.Bl -bullet -compact
113.It
114SiI3124 (PCI-X 133MHz/64bit, 4 ports)
115.It
116SiI3131 (PCIe 1.0 x1, 1 port)
117.It
118SiI3132 (PCIe 1.0 x1, 2 ports)
119.It
120SiI3531 (PCIe 1.0 x1, 1 port)
121.El
122.Sh FILES
123.Bl -tag -width /dev/led/siisch*
124.It Pa /dev/led/siisch*
125identification LED device nodes
126.El
127.Sh SEE ALSO
128.Xr ada 4 ,
129.Xr ata 4 ,
130.Xr cam 4 ,
131.Xr cd 4 ,
132.Xr da 4 ,
133.Xr led 4 ,
134.Xr sa 4
135.Sh HISTORY
136The
137.Nm
138driver first appeared in
139.Fx 8.0 .
140.Sh AUTHORS
141.An Alexander Motin Aq mav@FreeBSD.org .
142