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: head/share/man/man4/sis.4 138068 2004-11-24 19:06:43Z brueffer $
32.\"
33.Dd November 24, 2004
34.Dt SIS 4
35.Os
36.Sh NAME
37.Nm sis
38.Nd "SiS 900, SiS 7016 and NS DP83815 Fast Ethernet device driver"
39.Sh SYNOPSIS
40.Cd "device miibus"
41.Cd "device sis"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for PCI Ethernet adapters and embedded
46controllers based on the Silicon Integrated Systems SiS 900
47and SiS 7016 Fast Ethernet controller chips.
48.Pp
49This driver also supports
50adapters based on the National Semiconductor DP83815 (MacPhyter)
51PCI Ethernet controller chip.
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 HARDWARE
114The
115.Nm
116driver supports Silicon Integrated Systems SiS 900 and SiS 7016 based
117Fast Ethernet adapters and embedded controllers, as well as Fast Ethernet
118adapters based on the National Semiconductor DP83815 (MacPhyter) chip.
119Supported adapters include:
120.Pp
121.Bl -bullet -compact
122.It
123@Nifty FNECHARD IFC USUP-TX
124.It
125MELCO LGY-PCI-TXC
126.It
127Netgear FA311-TX (DP83815)
128.It
129Netgear FA312-TX (DP83815)
130.It
131SiS 630, 635, and 735 motherboard chipsets
132.El
133.Sh DIAGNOSTICS
134.Bl -diag
135.It "sis%d: couldn't map ports/memory"
136A fatal initialization error has occurred.
137.It "sis%d: couldn't map interrupt"
138A fatal initialization error has occurred.
139.It "sis%d: watchdog timeout"
140The device has stopped responding to the network, or there is a problem with
141the network connection (e.g.\& a cable fault).
142.It "sis%d: no memory for rx list"
143The driver failed to allocate an mbuf for the receiver ring.
144.It "sis%d: no memory for tx list"
145The driver failed to allocate an mbuf for the transmitter ring when
146allocating a pad buffer or collapsing an mbuf chain into a cluster.
147.It "sis%d: chip is in D3 power state -- setting to D0"
148This message applies only to adapters which support power
149management.
150Some operating systems place the controller in low power
151mode when shutting down, and some PCI BIOSes fail to bring the chip
152out of this state before configuring it.
153The controller loses all of
154its PCI configuration in the D3 state, so if the BIOS does not set
155it back to full power mode in time, it will not be able to configure it
156correctly.
157The driver tries to detect this condition and bring
158the adapter back to the D0 (full power) state, but this may not be
159enough to return the driver to a fully operational condition.
160If
161you see this message at boot time and the driver fails to attach
162the device as a network interface, you will have to perform a
163warm boot to have the device properly configured.
164.Pp
165Note that this condition only occurs when warm booting from another
166operating system.
167If you power down your system prior to booting
168.Fx ,
169the card should be configured correctly.
170.El
171.Sh SEE ALSO
172.Xr arp 4 ,
173.Xr miibus 4 ,
174.Xr netintro 4 ,
175.Xr ng_ether 4 ,
176.Xr polling 4 ,
177.Xr ifconfig 8
178.Rs
179.%T SiS 900 and SiS 7016 datasheets
180.%O http://www.sis.com.tw
181.Re
182.Rs
183.%T NatSemi DP83815 datasheet
184.%O http://www.national.com
185.Re
186.Sh HISTORY
187The
188.Nm
189device driver first appeared in
190.Fx 3.0 .
191.Sh AUTHORS
192The
193.Nm
194driver was written by
195.An Bill Paul Aq wpaul@ee.columbia.edu .
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: head/share/man/man4/sis.4 138068 2004-11-24 19:06:43Z brueffer $
32.\"
33.Dd November 24, 2004
34.Dt SIS 4
35.Os
36.Sh NAME
37.Nm sis
38.Nd "SiS 900, SiS 7016 and NS DP83815 Fast Ethernet device driver"
39.Sh SYNOPSIS
40.Cd "device miibus"
41.Cd "device sis"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for PCI Ethernet adapters and embedded
46controllers based on the Silicon Integrated Systems SiS 900
47and SiS 7016 Fast Ethernet controller chips.
48.Pp
49This driver also supports
50adapters based on the National Semiconductor DP83815 (MacPhyter)
51PCI Ethernet controller chip.
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 HARDWARE
114The
115.Nm
116driver supports Silicon Integrated Systems SiS 900 and SiS 7016 based
117Fast Ethernet adapters and embedded controllers, as well as Fast Ethernet
118adapters based on the National Semiconductor DP83815 (MacPhyter) chip.
119Supported adapters include:
120.Pp
121.Bl -bullet -compact
122.It
123@Nifty FNECHARD IFC USUP-TX
124.It
125MELCO LGY-PCI-TXC
126.It
127Netgear FA311-TX (DP83815)
128.It
129Netgear FA312-TX (DP83815)
130.It
131SiS 630, 635, and 735 motherboard chipsets
132.El
133.Sh DIAGNOSTICS
134.Bl -diag
135.It "sis%d: couldn't map ports/memory"
136A fatal initialization error has occurred.
137.It "sis%d: couldn't map interrupt"
138A fatal initialization error has occurred.
139.It "sis%d: watchdog timeout"
140The device has stopped responding to the network, or there is a problem with
141the network connection (e.g.\& a cable fault).
142.It "sis%d: no memory for rx list"
143The driver failed to allocate an mbuf for the receiver ring.
144.It "sis%d: no memory for tx list"
145The driver failed to allocate an mbuf for the transmitter ring when
146allocating a pad buffer or collapsing an mbuf chain into a cluster.
147.It "sis%d: chip is in D3 power state -- setting to D0"
148This message applies only to adapters which support power
149management.
150Some operating systems place the controller in low power
151mode when shutting down, and some PCI BIOSes fail to bring the chip
152out of this state before configuring it.
153The controller loses all of
154its PCI configuration in the D3 state, so if the BIOS does not set
155it back to full power mode in time, it will not be able to configure it
156correctly.
157The driver tries to detect this condition and bring
158the adapter back to the D0 (full power) state, but this may not be
159enough to return the driver to a fully operational condition.
160If
161you see this message at boot time and the driver fails to attach
162the device as a network interface, you will have to perform a
163warm boot to have the device properly configured.
164.Pp
165Note that this condition only occurs when warm booting from another
166operating system.
167If you power down your system prior to booting
168.Fx ,
169the card should be configured correctly.
170.El
171.Sh SEE ALSO
172.Xr arp 4 ,
173.Xr miibus 4 ,
174.Xr netintro 4 ,
175.Xr ng_ether 4 ,
176.Xr polling 4 ,
177.Xr ifconfig 8
178.Rs
179.%T SiS 900 and SiS 7016 datasheets
180.%O http://www.sis.com.tw
181.Re
182.Rs
183.%T NatSemi DP83815 datasheet
184.%O http://www.national.com
185.Re
186.Sh HISTORY
187The
188.Nm
189device driver first appeared in
190.Fx 3.0 .
191.Sh AUTHORS
192The
193.Nm
194driver was written by
195.An Bill Paul Aq wpaul@ee.columbia.edu .