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