xref: /dragonfly/share/man/man4/sis.4 (revision ab709bfb)
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.7 2008/07/11 10:38:50 thomas 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
44The
45.Nm
46driver provides support for PCI ethernet adapters and embedded
47controllers based on the Silicon Integrated Systems SiS 900
48and SiS 7016 fast ethernet controller chips, as well as support
49for adapters based on the National Semiconductor DP83815 (MacPhyter)
50PCI ethernet controller chip, including the Netgear FA311-TX and
51FA312-TX.
52.Pp
53The SiS 900 is a 100Mbps ethernet MAC and MII-compliant transceiver
54in a single package.
55It uses a bus master DMA and a scatter/gather
56descriptor scheme.
57The SiS 7016 is similar to the SiS 900 except
58that it has no internal PHY, requiring instead an external transceiver
59to be attached to its MII interface.
60The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
61and a single perfect filter entry for the station address.
62.Pp
63The NS DP83815 is also a 100Mbps ethernet MAC with integrated PHY.
64The NatSemi chip and the SiS 900 share many of the same features and
65a fairly similar programming interface, hence both chips are supported
66by the same driver.
67.Pp
68The
69.Nm
70driver supports the following media types:
71.Bl -tag -width 10baseTXUTP
72.It autoselect
73Enable autoselection of the media type and options.
74The user can manually override
75the autoselected mode by adding media options to
76.Xr rc.conf 5 .
77.It 10baseT/UTP
78Set 10Mbps operation.
79The
80.Xr ifconfig 8
81.Cm mediaopt
82option can also be used to select either
83.Sq full-duplex
84or
85.Sq half-duplex
86modes.
87.It 100baseTX
88Set 100Mbps (fast ethernet) operation.
89The
90.Xr ifconfig 8
91.Cm mediaopt
92option can also be used to select either
93.Sq full-duplex
94or
95.Sq half-duplex
96modes.
97.El
98.Pp
99The
100.Nm
101driver supports the following media options:
102.Bl -tag -width full-duplex
103.It full-duplex
104Force full duplex operation
105.It half-duplex
106Force half duplex operation.
107.El
108.Pp
109For more information on configuring this device, see
110.Xr ifconfig 8 .
111The
112.Nm
113driver supports
114.Xr polling 4 .
115.Sh DIAGNOSTICS
116.Bl -diag
117.It "sis%d: couldn't map ports/memory"
118A fatal initialization error has occurred.
119.It "sis%d: couldn't map interrupt"
120A fatal initialization error has occurred.
121.It "sis%d: watchdog timeout"
122The device has stopped responding to the network, or there is a problem with
123the network connection (e.g. a cable fault).
124.It "sis%d: no memory for rx list"
125The driver failed to allocate an mbuf for the receiver ring.
126.It "sis%d: no memory for tx list"
127The driver failed to allocate an mbuf for the transmitter ring when
128allocating a pad buffer or collapsing an mbuf chain into a clusisr.
129.It "sis%d: chip is in D3 power state -- setting to D0"
130This message applies only to adapters which support power
131management.
132Some operating systems place the controller in low power
133mode when shutting down, and some PCI BIOSes fail to bring the chip
134out of this state before configuring it.
135The controller loses all of
136its PCI configuration in the D3 state, so if the BIOS does not set
137it back to full power mode in time, it will not be able to configure it
138correctly.
139The driver tries to detect this condition and bring
140the adapter back to the D0 (full power) state, but this may not be
141enough to return the driver to a fully operational condition.
142If
143you see this message at boot time and the driver fails to attach
144the device as a network interface, you will have to perform a
145warm boot to have the device properly configured.
146.Pp
147Note that this condition only occurs when warm booting from another
148operating system.
149If you power down your system prior to booting
150.Dx ,
151the card should be configured correctly.
152.El
153.Sh SEE ALSO
154.Xr arp 4 ,
155.Xr ifmedia 4 ,
156.Xr miibus 4 ,
157.Xr netintro 4 ,
158.Xr ng_ether 4 ,
159.Xr polling 4 ,
160.Xr ifconfig 8
161.Rs
162.%T SiS 900 and SiS 7016 datasheets
163.%O http://www.sis.com.tw
164.Re
165.Rs
166.%T NatSemi DP83815 datasheet
167.%O http://www.national.com
168.Re
169.Sh HISTORY
170The
171.Nm
172device driver first appeared in
173.Fx 3.0 .
174.Sh AUTHORS
175The
176.Nm
177driver was written by
178.An Bill Paul Aq wpaul@ee.columbia.edu .
179