xref: /freebsd/share/man/man4/siis.4 (revision 069ac184)
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 SIIS 4
27.Os
28.Sh NAME
29.Nm siis
30.Nd SiliconImage 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 siis"
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
45siis_load="YES"
46.Ed
47.Pp
48The following tunables are settable from the
49.Xr loader 8 :
50.Bl -ohang
51.It Va hint.siis. Ns Ar X Ns Va .msi
52controls Message Signaled Interrupts (MSI) usage by the specified controller.
53.It Va hint.siisch. Ns Ar X Ns Va .pm_level
54controls SATA interface Power Management for the specified channel,
55allowing some power to be saved at the cost of additional command
56latency.
57Possible values:
58.Bl -tag -width 2n -offset indent
59.It 0
60interface Power Management is disabled (default);
61.It 1
62device is allowed to initiate PM state change, host is passive.
63.El
64.Pp
65Note that interface Power Management is not compatible with
66device presence detection.
67A manual bus reset is needed on device hot-plug.
68.It Va hint.siisch. Ns Ar X Ns Va .sata_rev
69setting to nonzero value limits maximum SATA revision (speed).
70Values 1, 2 and 3 are respectively 1.5, 3 and 6Gbps.
71.El
72.Sh DESCRIPTION
73This driver provides the
74.Xr CAM 4
75subsystem with native access to the
76.Tn SATA
77ports of controller.
78Each SATA port is represented to CAM as a separate bus with 16 targets.
79Most of the bus-management details are handled by the SATA-specific
80transport of CAM.
81Connected ATA disks are handled by the ATA protocol disk peripheral driver
82.Xr ada 4 .
83ATAPI devices are handled by the SCSI protocol peripheral drivers
84.Xr cd 4 ,
85.Xr da 4 ,
86.Xr sa 4 ,
87etc.
88.Pp
89Driver features include support for Serial ATA and ATAPI devices,
90Port Multipliers (including FIS-based switching), hardware command queues
91(31 command per port), Native Command Queuing, SATA interface Power Management,
92device hot-plug and Message Signaled Interrupts.
93.Pp
94The activity LEDs of the adapters supported by the
95.Nm
96driver can be controlled via the
97.Xr led 4
98API for localization or status reporting purposes.
99.Sh HARDWARE
100The
101.Nm
102driver supports the following controller chips:
103.Pp
104.Bl -bullet -compact
105.It
106SiI3124 (PCI-X 133MHz/64bit, 4 ports)
107.It
108SiI3131 (PCIe 1.0 x1, 1 port)
109.It
110SiI3132 (PCIe 1.0 x1, 2 ports)
111.It
112SiI3531 (PCIe 1.0 x1, 1 port)
113.El
114.Sh FILES
115.Bl -tag -width /dev/led/siisch*
116.It Pa /dev/led/siisch*
117identification LED device nodes
118.El
119.Sh SEE ALSO
120.Xr ada 4 ,
121.Xr ata 4 ,
122.Xr cam 4 ,
123.Xr cd 4 ,
124.Xr da 4 ,
125.Xr led 4 ,
126.Xr sa 4
127.Sh HISTORY
128The
129.Nm
130driver first appeared in
131.Fx 8.0 .
132.Sh AUTHORS
133.An Alexander Motin Aq Mt mav@FreeBSD.org
134