ahci/sili.4 - Document sysctl nodes & loader tunables
[dragonfly.git] / share / man / man4 / sili.4
1 .\"     $OpenBSD: sili.4,v 1.3 2007/05/31 19:19:52 jmc Exp $
2 .\"
3 .\" Copyright (c) 2007 David Gwynne <dlg@openbsd.org>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 .\" TORTIOUS ACTION, ARISING OUT OF
15 .\" PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd June 23, 2009
18 .Dt SILI 4
19 .Os
20 .Sh NAME
21 .Nm sili
22 .Nd Silicon Image 3124/3132 SATA controller
23 .Sh SYNOPSIS
24 To compile this driver into the kernel,
25 place the following line in your
26 kernel configuration file:
27 .Bd -ragged -offset indent
28 .Cd "device sili"
29 .Ed
30 .Pp
31 Alternatively, to load the driver as a
32 module at boot time, place the following line in
33 .Xr loader.conf 5 :
34 .Bd -literal -offset indent
35 sili_load="YES"
36 .Ed
37 .Sh DESCRIPTION
38 The
39 .Nm
40 driver provides support for SATA controllers using the Silicon Image
41 3124/3132 SATALink chipsets.
42 .Pp
43 Although
44 .Nm
45 controllers are actual ATA controllers, the driver emulates SCSI via a
46 translation layer.
47 .Sh LOADER TUNABLES
48 The following hints may be set in
49 .Xr loader.conf 5
50 to control the
51 .Nm
52 driver's behavior.
53 Note that the hint need only exist, so removing it requires commenting it out.
54 .Pp
55 Usually both the
56 .Xr nata 4
57 and the
58 .Nm
59 drivers are loaded.
60 The
61 .Xr nata 4
62 driver will pick up any ata-like devices which the
63 .Nm
64 driver misses.
65 If the
66 .Nm
67 driver is disabled the
68 .Xr nata 4
69 driver will typically pick up the
70 .Nm
71 devices, albeit under the
72 .Pa ad
73 disk name rather than the
74 .Pa da
75 disk name.
76 .Bd -literal -offset indent
77 hint.sili.disabled=1
78 .Ed
79 .Pp
80 The
81 .Nm
82 driver can be told to force a lower-speed 1.5Gb link speed
83 if necessary, and can also be told to refrain from attempting to send
84 certain higher-level ATA commands to initialize ATA features which
85 some devices might not properly implement.
86 .Bd -literal -offset indent
87 hint.sili.force150=1
88 hint.sili.nofeatures=1
89 .Ed
90 .Sh SEE ALSO
91 .Xr ahci 4 ,
92 .Xr intro 4 ,
93 .Xr nata 4 ,
94 .Xr pci 4 ,
95 .Xr scsi 4 ,
96 .Xr loader.conf 5
97 .Sh HISTORY
98 The
99 .Nm
100 driver first appeared in
101 .Dx 2.3 .
102 .Sh AUTHORS
103 .An -nosplit
104 The
105 .Nm
106 driver was originally written by
107 .An David Gwynne Aq dlg@openbsd.org
108 and
109 .An Christopher Pascoe Aq pascoe@openbsd.org
110 for
111 .Ox .
112 .Pp
113 It was ported to
114 .Dx
115 by
116 .An Matt Dillon Aq dillon@apollo.backplane.com
117 who added new features such as hot-plug and port multiplier support.