xref: /dragonfly/share/man/man4/sis.4 (revision 71126e33)
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.3 2004/03/11 12:28:55 hmp 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.Pp
72.Bl -tag -width 10baseTXUTP
73.It autoselect
74Enable autoselection of the media type and options.
75The user can manually override
76the autoselected mode by adding media options to
77.Xr rc.conf 5 .
78.It 10baseT/UTP
79Set 10Mbps operation.
80The
81.Xr ifconfig 8
82.Cm mediaopt
83option can also be used to select either
84.Sq full-duplex
85or
86.Sq half-duplex
87modes.
88.It 100baseTX
89Set 100Mbps (fast ethernet) operation.
90The
91.Xr ifconfig 8
92.Cm mediaopt
93option can also be used to select either
94.Sq full-duplex
95or
96.Sq half-duplex
97modes.
98.El
99.Pp
100The
101.Nm
102driver supports the following media options:
103.Pp
104.Bl -tag -width full-duplex
105.It full-duplex
106Force full duplex operation
107.It half-duplex
108Force half duplex operation.
109.El
110.Pp
111For 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"
116A fatal initialization error has occurred.
117.It "sis%d: couldn't map interrupt"
118A fatal initialization error has occurred.
119.It "sis%d: watchdog timeout"
120The device has stopped responding to the network, or there is a problem with
121the network connection (e.g. a cable fault).
122.It "sis%d: no memory for rx list"
123The driver failed to allocate an mbuf for the receiver ring.
124.It "sis%d: no memory for tx list"
125The driver failed to allocate an mbuf for the transmitter ring when
126allocating a pad buffer or collapsing an mbuf chain into a clusisr.
127.It "sis%d: chip is in D3 power state -- setting to D0"
128This message applies only to adapters which support power
129management.
130Some operating systems place the controller in low power
131mode when shutting down, and some PCI BIOSes fail to bring the chip
132out of this state before configuring it.
133The controller loses all of
134its PCI configuration in the D3 state, so if the BIOS does not set
135it back to full power mode in time, it will not be able to configure it
136correctly.
137The driver tries to detect this condition and bring
138the adapter back to the D0 (full power) state, but this may not be
139enough to return the driver to a fully operational condition.
140If
141you see this message at boot time and the driver fails to attach
142the device as a network interface, you will have to perform a
143warm boot to have the device properly configured.
144.Pp
145Note that this condition only occurs when warm booting from another
146operating system.
147If you power down your system prior to booting
148.Dx ,
149the card should be configured correctly.
150.El
151.Sh SEE ALSO
152.Xr arp 4 ,
153.Xr miibus 4 ,
154.Xr netintro 4 ,
155.Xr ng_ether 4 ,
156.Xr ifconfig 8
157.Rs
158.%T SiS 900 and SiS 7016 datasheets
159.%O http://www.sis.com.tw
160.Re
161.Rs
162.%T NatSemi DP83815 datasheet
163.%O http://www.national.com
164.Re
165.Sh HISTORY
166The
167.Nm
168device driver first appeared in
169.Fx 3.0 .
170.Sh AUTHORS
171The
172.Nm
173driver was written by
174.An Bill Paul Aq wpaul@ee.columbia.edu .
175