nrelease - fix/improve livecd
[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 December 4, 2013
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. Both 3124-1 (1.5 Gbps) and 3124-2 (3 Gbps)
42 versions of the 3124 chip are supported.
43 .Pp
44 Although
45 .Nm
46 controllers are actual ATA controllers, the driver emulates SCSI via a
47 translation layer.
48 .Sh LOADER TUNABLES
49 The following hints may be set in
50 .Xr loader.conf 5
51 to control the
52 .Nm
53 driver's behavior.
54 Note that the hint need only exist, so removing it requires commenting it out.
55 .Pp
56 Usually both the
57 .Xr nata 4
58 and the
59 .Nm
60 drivers are loaded.
61 The
62 .Xr nata 4
63 driver will pick up any ata-like devices which the
64 .Nm
65 driver misses.
66 If the
67 .Nm
68 driver is disabled the
69 .Xr nata 4
70 driver will typically pick up the
71 .Nm
72 devices, albeit under the
73 .Pa ad
74 disk name rather than the
75 .Pa da
76 disk name.
77 .Bd -literal -offset indent
78 hint.sili.disabled=1
79 .Ed
80 .Pp
81 The
82 .Nm
83 driver can be told to force a lower-speed 1.5Gb link speed
84 if necessary, and can also be told to refrain from attempting to send
85 certain higher-level ATA commands to initialize ATA features which
86 some devices might not properly implement.
87 .Bd -literal -offset indent
88 hint.sili.force150=1
89 hint.sili.nofeatures=1
90 .Ed
91 .Pp
92 The
93 .Nm
94 driver supports MSI but support is turned off by default.
95 It can be enabled by setting the
96 .Va hw.sili.msi.enable
97 tunable to 1.
98 .Sh SEE ALSO
99 .Xr ahci 4 ,
100 .Xr intro 4 ,
101 .Xr nata 4 ,
102 .Xr nvme 4 ,
103 .Xr pci 4 ,
104 .Xr scsi 4 ,
105 .Xr loader.conf 5
106 .Sh HISTORY
107 The
108 .Nm
109 driver first appeared in
110 .Dx 2.3 .
111 .Sh AUTHORS
112 .An -nosplit
113 The
114 .Nm
115 driver was originally written by
116 .An David Gwynne Aq Mt dlg@openbsd.org
117 and
118 .An Christopher Pascoe Aq Mt pascoe@openbsd.org
119 for
120 .Ox .
121 .Pp
122 It was ported to
123 .Dx
124 by
125 .An Matt Dillon Aq Mt dillon@apollo.backplane.com ,
126 who added new features such as hot-plug and port multiplier support.