xref: /freebsd/share/man/man4/sis.4 (revision 8eb2bee6c0f4957c6c1cea826e59cda4d18a2a64)
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 September 2, 2010
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.Bl -tag -width 10baseTXUTP
84.It autoselect
85Enable autoselection of the media type and options.
86The user can manually override
87the autoselected mode by adding media options to
88.Xr rc.conf 5 .
89.It 10baseT/UTP
90Set 10Mbps operation.
91The
92.Xr ifconfig 8
93.Cm mediaopt
94option can also be used to select either
95.Sq full-duplex
96or
97.Sq half-duplex
98modes.
99.It 100baseTX
100Set 100Mbps (Fast Ethernet) operation.
101The
102.Xr ifconfig 8
103.Cm mediaopt
104option can also be used to select either
105.Sq full-duplex
106or
107.Sq half-duplex
108modes.
109.El
110.Pp
111The
112.Nm
113driver supports the following media options:
114.Bl -tag -width full-duplex
115.It full-duplex
116Force full duplex operation.
117.It half-duplex
118Force half duplex operation.
119.El
120.Pp
121For more information on configuring this device, see
122.Xr ifconfig 8 .
123.Sh HARDWARE
124The
125.Nm
126driver supports Silicon Integrated Systems SiS 900 and SiS 7016 based
127Fast Ethernet adapters and embedded controllers, as well as Fast Ethernet
128adapters based on the National Semiconductor DP83815 (MacPhyter) and DP83816
129chips.
130Supported adapters include:
131.Pp
132.Bl -bullet -compact
133.It
134@Nifty FNECHARD IFC USUP-TX
135.It
136MELCO LGY-PCI-TXC
137.It
138Netgear FA311-TX (DP83815)
139.It
140Netgear FA312-TX (DP83815)
141.It
142SiS 630, 635, and 735 motherboard chipsets
143.It
144Soekris Engineering net45xx, net48xx, lan1621, and lan1641
145.El
146.Sh SYSCTL VARIABLES
147The following variable is available as both
148.Xr sysctl 8
149variable and
150.Xr loader 8
151tunable:
152.Bl -tag -width indent
153.It Va dev.sis.%unit.manual_pad
154This variable controls how to pad short frames for DP83815/DP83816
155controllers on the specified device.
156DP83815/DP83816 controllers are known to pad 0xFF for short frames
157which is violation of RFC 1042.
158Set this variable to a non-zero value to let driver manually pad
159each short frame with zeros at the cost of extra CPU cycles.
160The default value is 0 to let hardware perform automatic padding.
161.El
162.Sh DIAGNOSTICS
163.Bl -diag
164.It "sis%d: couldn't map ports/memory"
165A fatal initialization error has occurred.
166.It "sis%d: couldn't map interrupt"
167A fatal initialization error has occurred.
168.It "sis%d: watchdog timeout"
169The device has stopped responding to the network, or there is a problem with
170the network connection (e.g.\& a cable fault).
171.It "sis%d: no memory for rx list"
172The driver failed to allocate an mbuf for the receiver ring.
173.It "sis%d: no memory for tx list"
174The driver failed to allocate an mbuf for the transmitter ring when
175allocating a pad buffer or collapsing an mbuf chain into a cluster.
176.It "sis%d: chip is in D3 power state -- setting to D0"
177This message applies only to adapters which support power
178management.
179Some operating systems place the controller in low power
180mode when shutting down, and some PCI BIOSes fail to bring the chip
181out of this state before configuring it.
182The controller loses all of
183its PCI configuration in the D3 state, so if the BIOS does not set
184it back to full power mode in time, it will not be able to configure it
185correctly.
186The driver tries to detect this condition and bring
187the adapter back to the D0 (full power) state, but this may not be
188enough to return the driver to a fully operational condition.
189If
190you see this message at boot time and the driver fails to attach
191the device as a network interface, you will have to perform a
192warm boot to have the device properly configured.
193.Pp
194Note that this condition only occurs when warm booting from another
195operating system.
196If you power down your system prior to booting
197.Fx ,
198the card should be configured correctly.
199.El
200.Sh SEE ALSO
201.Xr altq 4 ,
202.Xr arp 4 ,
203.Xr miibus 4 ,
204.Xr netintro 4 ,
205.Xr ng_ether 4 ,
206.Xr polling 4 ,
207.Xr vlan 4 ,
208.Xr ifconfig 8
209.Rs
210.%T SiS 900 and SiS 7016 datasheets
211.%U https://www.sis.com.tw
212.Re
213.Rs
214.%T NatSemi DP83815 datasheet
215.Re
216.Sh HISTORY
217The
218.Nm
219device driver first appeared in
220.Fx 3.0 .
221.Sh AUTHORS
222The
223.Nm
224driver was written by
225.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
226