xref: /openbsd-src/share/man/man4/sis.4 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\"	$OpenBSD: sis.4,v 1.26 2007/05/31 19:19:52 jmc Exp $
2.\"
3.\" Copyright (c) 1997, 1998, 1999
4.\"	Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by Bill Paul.
17.\" 4. Neither the name of the author nor the names of any co-contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"   without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31.\" THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" $FreeBSD: src/share/man/man4/sis.4,v 1.2 1999/11/15 23:14:27 phantom Exp $
34.\"
35.Dd $Mdocdate: May 31 2007 $
36.Dt SIS 4
37.Os
38.Sh NAME
39.Nm sis
40.Nd "SiS 900, SiS 7016, and NS DP83815/6 10/100 Ethernet device"
41.Sh SYNOPSIS
42.Cd "sis* at pci?"
43.Cd "icsphy* at mii?"
44.Cd "nsphyter* at mii?"
45.Cd "rlphy* at mii?"
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for PCI Ethernet adapters and embedded
50controllers based on the Silicon Integrated Systems SiS 900
51and SiS 7016 Fast Ethernet controller chips, as well as support
52for adapters based on National Semiconductor DP83815 (MacPHYTER)
53and DP83816 (MacPHYTER-II) PCI Ethernet controller chips,
54including the Netgear FA311, FA312 and FA331,
55and the embedded controllers on Soekris net4xxx single-board computers
56and lan16x1 multi-port PCI Ethernet adapters.
57.Pp
58The SiS 900 is a 100Mbps Ethernet MAC and MII-compliant transceiver
59in a single package.
60It uses a bus master DMA and a scatter/gather descriptor scheme.
61The SiS 7016 is similar to the SiS 900 except that it has no internal PHY,
62requiring instead an external transceiver to be attached to its MII interface.
63The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
64and a single perfect filter entry for the station address.
65.Pp
66The NS DP83815 and DP83816 are also 100Mbps Ethernet MACs
67with integrated PHY.
68The NatSemi chips and the SiS chips share many of the same features and
69a fairly similar programming interface, and hence are supported
70by the same driver.
71.Pp
72The
73.Nm
74driver supports the following media types:
75.Bl -tag -width full-duplex
76.It autoselect
77Enable autoselection of the media type and options.
78The user can manually override
79the autoselected mode by adding media options to the
80.Xr hostname.if 5
81file.
82.It 10baseT
83Set 10Mbps operation.
84The
85.Ar mediaopt
86option can also be used to select either
87.Ar full-duplex
88or
89.Ar half-duplex
90modes.
91.It 100baseTX
92Set 100Mbps (Fast Ethernet) operation.
93The
94.Ar mediaopt
95option can also be used to select either
96.Ar full-duplex
97or
98.Ar half-duplex
99modes.
100.El
101.Pp
102The
103.Nm
104driver supports the following media options:
105.Bl -tag -width full-duplex
106.It full-duplex
107Force full duplex operation.
108.It half-duplex
109Force half duplex operation.
110.El
111.Pp
112For more information on configuring this device, see
113.Xr ifconfig 8 .
114.Sh DIAGNOSTICS
115.Bl -diag
116.It "sis%d: couldn't map ports/memory"
117A fatal initialization error has occurred.
118.It "sis%d: couldn't map interrupt"
119A fatal initialization error has occurred.
120.It "sis%d: watchdog timeout"
121The device has stopped responding to the network, or there is a problem with
122the network connection (cable).
123.It "sis%d: no memory for rx list"
124The driver failed to allocate an mbuf for the receiver ring.
125.It "sis%d: no memory for tx list"
126The driver failed to allocate an mbuf for the transmitter ring when
127allocating a pad buffer or collapsing an mbuf chain into a cluster.
128.It "sis%d: chip is in D3 power state -- setting to D0"
129This message applies only to adapters which support power management.
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 its PCI configuration in the D3 state, so
134if the BIOS does not set it back to full power mode in time, it won't
135be able to configure it correctly.
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 this message appears at boot time and the driver fails to attach
140the device as a network interface, a second warm boot will have to be
141performed to have the device properly configured.
142.Pp
143Note that this condition only occurs when warm booting from another
144operating system.
145If the system is powered down prior to booting
146.Ox ,
147the card should be configured correctly.
148.El
149.Sh SEE ALSO
150.Xr arp 4 ,
151.Xr icsphy 4 ,
152.Xr ifmedia 4 ,
153.Xr intro 4 ,
154.Xr netintro 4 ,
155.Xr nsphyter 4 ,
156.Xr pci 4 ,
157.Xr rlphy 4 ,
158.Xr hostname.if 5 ,
159.Xr ifconfig 8
160.Rs
161.%T SiS 900 and SiS 7016 datasheets
162.%O http://www.sis.com.tw
163.Re
164.Rs
165.%T NatSemi DP83815 and DP83816 datasheets
166.%O http://www.national.com
167.Re
168.Sh HISTORY
169The
170.Nm
171device driver first appeared in
172.Fx 3.0 .
173.Ox
174support was added in
175.Ox 2.7 .
176.Sh AUTHORS
177.An -nosplit
178The
179.Nm
180driver was written by
181.An Bill Paul Aq wpaul@ee.columbia.edu
182and ported to
183.Ox
184by
185.An Aaron Campbell Aq aaron@openbsd.org .
186