xref: /freebsd/share/man/man4/sis.4 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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$
32.\"
33.Dd October 28, 2006
34.Dt SIS 4
35.Os
36.Sh NAME
37.Nm sis
38.Nd "SiS 900, SiS 7016 and NS DP83815/DP83816 Fast Ethernet device driver"
39.Sh SYNOPSIS
40To compile this driver into the kernel,
41place the following lines in your
42kernel configuration file:
43.Bd -ragged -offset indent
44.Cd "device miibus"
45.Cd "device sis"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_sis_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for PCI Ethernet adapters and embedded
58controllers based on the Silicon Integrated Systems SiS 900
59and SiS 7016 Fast Ethernet controller chips.
60.Pp
61This driver also supports
62adapters based on the National Semiconductor DP83815 (MacPhyter) and DP83816
63PCI Ethernet controller chip.
64.Pp
65The SiS 900 is a 100Mbps Ethernet MAC and MII-compliant transceiver
66in a single package.
67It uses a bus master DMA and a scatter/gather
68descriptor scheme.
69The SiS 7016 is similar to the SiS 900 except
70that it has no internal PHY, requiring instead an external transceiver
71to be attached to its MII interface.
72The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
73and a single perfect filter entry for the station address.
74.Pp
75The NS DP83815 is also a 100Mbps Ethernet MAC with integrated PHY.
76The NatSemi chip and the SiS 900 share many of the same features and
77a fairly similar programming interface, hence both chips are supported
78by the same driver.
79.Pp
80The
81.Nm
82driver supports the following media types:
83.Pp
84.Bl -tag -width 10baseTXUTP
85.It autoselect
86Enable autoselection of the media type and options.
87The user can manually override
88the autoselected mode by adding media options to
89.Xr rc.conf 5 .
90.It 10baseT/UTP
91Set 10Mbps operation.
92The
93.Xr ifconfig 8
94.Cm mediaopt
95option can also be used to select either
96.Sq full-duplex
97or
98.Sq half-duplex
99modes.
100.It 100baseTX
101Set 100Mbps (Fast Ethernet) operation.
102The
103.Xr ifconfig 8
104.Cm mediaopt
105option can also be used to select either
106.Sq full-duplex
107or
108.Sq half-duplex
109modes.
110.El
111.Pp
112The
113.Nm
114driver supports the following media options:
115.Pp
116.Bl -tag -width full-duplex
117.It full-duplex
118Force full duplex operation
119.It half-duplex
120Force half duplex operation.
121.El
122.Pp
123For more information on configuring this device, see
124.Xr ifconfig 8 .
125.Sh HARDWARE
126The
127.Nm
128driver supports Silicon Integrated Systems SiS 900 and SiS 7016 based
129Fast Ethernet adapters and embedded controllers, as well as Fast Ethernet
130adapters based on the National Semiconductor DP83815 (MacPhyter) and DP83816
131chips.
132Supported adapters include:
133.Pp
134.Bl -bullet -compact
135.It
136@Nifty FNECHARD IFC USUP-TX
137.It
138MELCO LGY-PCI-TXC
139.It
140Netgear FA311-TX (DP83815)
141.It
142Netgear FA312-TX (DP83815)
143.It
144SiS 630, 635, and 735 motherboard chipsets
145.It
146Soekris Engineering net45xx, net48xx, lan1621, and lan1641
147.El
148.Sh DIAGNOSTICS
149.Bl -diag
150.It "sis%d: couldn't map ports/memory"
151A fatal initialization error has occurred.
152.It "sis%d: couldn't map interrupt"
153A fatal initialization error has occurred.
154.It "sis%d: watchdog timeout"
155The device has stopped responding to the network, or there is a problem with
156the network connection (e.g.\& a cable fault).
157.It "sis%d: no memory for rx list"
158The driver failed to allocate an mbuf for the receiver ring.
159.It "sis%d: no memory for tx list"
160The driver failed to allocate an mbuf for the transmitter ring when
161allocating a pad buffer or collapsing an mbuf chain into a cluster.
162.It "sis%d: chip is in D3 power state -- setting to D0"
163This message applies only to adapters which support power
164management.
165Some operating systems place the controller in low power
166mode when shutting down, and some PCI BIOSes fail to bring the chip
167out of this state before configuring it.
168The controller loses all of
169its PCI configuration in the D3 state, so if the BIOS does not set
170it back to full power mode in time, it will not be able to configure it
171correctly.
172The driver tries to detect this condition and bring
173the adapter back to the D0 (full power) state, but this may not be
174enough to return the driver to a fully operational condition.
175If
176you see this message at boot time and the driver fails to attach
177the device as a network interface, you will have to perform a
178warm boot to have the device properly configured.
179.Pp
180Note that this condition only occurs when warm booting from another
181operating system.
182If you power down your system prior to booting
183.Fx ,
184the card should be configured correctly.
185.El
186.Sh SEE ALSO
187.Xr altq 4 ,
188.Xr arp 4 ,
189.Xr miibus 4 ,
190.Xr netintro 4 ,
191.Xr ng_ether 4 ,
192.Xr polling 4 ,
193.Xr ifconfig 8
194.Rs
195.%T SiS 900 and SiS 7016 datasheets
196.%O http://www.sis.com.tw
197.Re
198.Rs
199.%T NatSemi DP83815 datasheet
200.%O http://www.national.com
201.Re
202.Sh HISTORY
203The
204.Nm
205device driver first appeared in
206.Fx 3.0 .
207.Sh AUTHORS
208The
209.Nm
210driver was written by
211.An Bill Paul Aq wpaul@ee.columbia.edu .
212