Nuke fla(4). It's known to be buggy, supports very limited set of obsolete
[dragonfly.git] / share / man / man4 / sis.4
1 .\" Copyright (c) 1997, 1998, 1999
2 .\"     Bill Paul <wpaul@ee.columbia.edu>. 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by Bill Paul.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\"    may be used to endorse or promote products derived from this software
17 .\"   without specific prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 .\" THE POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .\" $FreeBSD: src/share/man/man4/sis.4,v 1.6.2.4 2003/02/17 21:20:39 trhodes Exp $
32 .\" $DragonFly: src/share/man/man4/sis.4,v 1.5 2007/02/25 12:03:07 swildner Exp $
33 .\"
34 .Dd September 4, 1999
35 .Dt SIS 4
36 .Os
37 .Sh NAME
38 .Nm sis
39 .Nd "SiS 900, SiS 7016 and NS DP83815 fast ethernet device driver"
40 .Sh SYNOPSIS
41 .Cd "device miibus"
42 .Cd "device sis"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for PCI ethernet adapters and embedded
47 controllers based on the Silicon Integrated Systems SiS 900
48 and SiS 7016 fast ethernet controller chips, as well as support
49 for adapters based on the National Semiconductor DP83815 (MacPhyter)
50 PCI ethernet controller chip, including the Netgear FA311-TX and
51 FA312-TX.
52 .Pp
53 The SiS 900 is a 100Mbps ethernet MAC and MII-compliant transceiver
54 in a single package.
55 It uses a bus master DMA and a scatter/gather
56 descriptor scheme.
57 The SiS 7016 is similar to the SiS 900 except
58 that it has no internal PHY, requiring instead an external transceiver
59 to be attached to its MII interface.
60 The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
61 and a single perfect filter entry for the station address.
62 .Pp
63 The NS DP83815 is also a 100Mbps ethernet MAC with integrated PHY.
64 The NatSemi chip and the SiS 900 share many of the same features and
65 a fairly similar programming interface, hence both chips are supported
66 by the same driver.
67 .Pp
68 The
69 .Nm
70 driver supports the following media types:
71 .Pp
72 .Bl -tag -width 10baseTXUTP
73 .It autoselect
74 Enable autoselection of the media type and options.
75 The user can manually override
76 the autoselected mode by adding media options to
77 .Xr rc.conf 5 .
78 .It 10baseT/UTP
79 Set 10Mbps operation.
80 The
81 .Xr ifconfig 8
82 .Cm mediaopt
83 option can also be used to select either
84 .Sq full-duplex
85 or
86 .Sq half-duplex
87 modes.
88 .It 100baseTX
89 Set 100Mbps (fast ethernet) operation.
90 The
91 .Xr ifconfig 8
92 .Cm mediaopt
93 option can also be used to select either
94 .Sq full-duplex
95 or
96 .Sq half-duplex
97 modes.
98 .El
99 .Pp
100 The
101 .Nm
102 driver supports the following media options:
103 .Pp
104 .Bl -tag -width full-duplex
105 .It full-duplex
106 Force full duplex operation
107 .It half-duplex
108 Force half duplex operation.
109 .El
110 .Pp
111 For more information on configuring this device, see
112 .Xr ifconfig 8 .
113 .Sh DIAGNOSTICS
114 .Bl -diag
115 .It "sis%d: couldn't map ports/memory"
116 A fatal initialization error has occurred.
117 .It "sis%d: couldn't map interrupt"
118 A fatal initialization error has occurred.
119 .It "sis%d: watchdog timeout"
120 The device has stopped responding to the network, or there is a problem with
121 the network connection (e.g. a cable fault).
122 .It "sis%d: no memory for rx list"
123 The driver failed to allocate an mbuf for the receiver ring.
124 .It "sis%d: no memory for tx list"
125 The driver failed to allocate an mbuf for the transmitter ring when
126 allocating a pad buffer or collapsing an mbuf chain into a clusisr.
127 .It "sis%d: chip is in D3 power state -- setting to D0"
128 This message applies only to adapters which support power
129 management.
130 Some operating systems place the controller in low power
131 mode when shutting down, and some PCI BIOSes fail to bring the chip
132 out of this state before configuring it.
133 The controller loses all of
134 its PCI configuration in the D3 state, so if the BIOS does not set
135 it back to full power mode in time, it will not be able to configure it
136 correctly.
137 The driver tries to detect this condition and bring
138 the adapter back to the D0 (full power) state, but this may not be
139 enough to return the driver to a fully operational condition.
140 If
141 you see this message at boot time and the driver fails to attach
142 the device as a network interface, you will have to perform a
143 warm boot to have the device properly configured.
144 .Pp
145 Note that this condition only occurs when warm booting from another
146 operating system.
147 If you power down your system prior to booting
148 .Dx ,
149 the card should be configured correctly.
150 .El
151 .Sh SEE ALSO
152 .Xr arp 4 ,
153 .Xr ifmedia 4 ,
154 .Xr miibus 4 ,
155 .Xr netintro 4 ,
156 .Xr ng_ether 4 ,
157 .Xr polling 4 ,
158 .Xr ifconfig 8
159 .Rs
160 .%T SiS 900 and SiS 7016 datasheets
161 .%O http://www.sis.com.tw
162 .Re
163 .Rs
164 .%T NatSemi DP83815 datasheet
165 .%O http://www.national.com
166 .Re
167 .Sh HISTORY
168 The
169 .Nm
170 device driver first appeared in
171 .Fx 3.0 .
172 .Sh AUTHORS
173 The
174 .Nm
175 driver was written by
176 .An Bill Paul Aq wpaul@ee.columbia.edu .