xref: /openbsd-src/share/man/man4/sis.4 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\"	$OpenBSD: sis.4,v 1.13 2001/06/23 07:03:59 pjanzen 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 September 4, 1999
36.Dt SIS 4
37.Os
38.Sh NAME
39.Nm sis
40.Nd "SiS 900, SiS 7016, and NS DP83815 Fast Ethernet driver"
41.Sh SYNOPSIS
42.Cd "sis* at pci? dev ? function ?"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI Ethernet adapters and embedded
47controllers based on the Silicon Integrated Systems SiS 900
48and SiS 7016 Fast Ethernet controller chips, as well as support
49for adapters based on the National Semiconductor DP83815 (MacPhyter)
50PCI Ethernet controller chip, including the Netgear FA311 and FA312.
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 descriptor scheme.
55The SiS 7016 is similar to the SiS 900 except that it has no internal PHY,
56requiring instead an external transceiver to be attached to its MII interface.
57The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
58and a single perfect filter entry for the station address.
59.Pp
60The NS DP83815 is also a 100Mbps Ethernet MAC with integrated PHY.
61The NatSemi chip and the SiS 900 share many of the same features and
62a fairly similar programming interface, hence both chips are supported
63by the same driver.
64.Pp
65The
66.Nm
67driver supports the following media types:
68.Pp
69.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
70.It autoselect
71Enable autoselection of the media type and options.
72The user can manually override
73the autoselected mode by adding media options to the
74.Xr hostname.if 5
75file.
76.It 10baseT/UTP
77Set 10Mbps operation.
78The
79.Ar mediaopt
80option can also be used to select either
81.Ar full-duplex
82or
83.Ar half-duplex
84modes.
85.It 100baseTX
86Set 100Mbps (Fast Ethernet) operation.
87The
88.Ar mediaopt
89option can also be used to select either
90.Ar full-duplex
91or
92.Ar half-duplex
93modes.
94.El
95.Pp
96The
97.Nm
98driver supports the following media options:
99.Pp
100.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
101.It full-duplex
102Force full duplex operation
103.It half-duplex
104Force half duplex operation.
105.El
106.Pp
107For more information on configuring this device, see
108.Xr ifconfig 8 .
109.Sh DIAGNOSTICS
110.Bl -diag
111.It "sis%d: couldn't map ports/memory"
112A fatal initialization error has occurred.
113.It "sis%d: couldn't map interrupt"
114A fatal initialization error has occurred.
115.It "sis%d: watchdog timeout"
116The device has stopped responding to the network, or there is a problem with
117the network connection (cable).
118.It "sis%d: no memory for rx list"
119The driver failed to allocate an mbuf for the receiver ring.
120.It "sis%d: no memory for tx list"
121The driver failed to allocate an mbuf for the transmitter ring when
122allocating a pad buffer or collapsing an mbuf chain into a cluster.
123.It "sis%d: chip is in D3 power state -- setting to D0"
124This message applies only to adapters which support power management.
125Some operating systems place the controller in low power
126mode when shutting down, and some PCI BIOSes fail to bring the chip
127out of this state before configuring it.
128The controller loses all of its PCI configuration in the D3 state, so
129if the BIOS does not set it back to full power mode in time, it won't
130be able to configure it correctly.
131The driver tries to detect this condition and bring
132the adapter back to the D0 (full power) state, but this may not be
133enough to return the driver to a fully operational condition.
134If you see this message at boot time and the driver fails to attach
135the device as a network interface, you will have to perform second
136warm boot to have the device properly configured.
137.Pp
138Note that this condition only occurs when warm booting from another
139operating system.
140If you power down your system prior to booting
141.Ox ,
142the card should be configured correctly.
143.El
144.Sh SEE ALSO
145.Xr arp 4 ,
146.Xr netintro 4 ,
147.Xr ifconfig 8
148.Rs
149.%T SiS 900 and SiS 7016 datasheets
150.%O http://www.sis.com.tw
151.Re
152.Rs
153.%T NatSemi DP83815 datasheet
154.%O http://www.national.com
155.Re
156.Sh HISTORY
157The
158.Nm
159device driver first appeared in
160.Fx 3.0 .
161.Ox
162support was added in
163.Ox 2.7 .
164.Sh AUTHORS
165The
166.Nm
167driver was written by Bill Paul <wpaul@ee.columbia.edu> and ported to
168.Ox
169by Aaron Campbell <aaron@openbsd.org>.
170