man4: use .Mt for emails (1/2)
[dragonfly.git] / share / man / man4 / sis.4
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: src/share/man/man4/sis.4,v 1.6.2.4 2003/02/17 21:20:39 trhodes Exp $
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
43 The
44 .Nm
45 driver provides support for PCI ethernet adapters and embedded
46 controllers based on the Silicon Integrated Systems SiS 900
47 and SiS 7016 fast ethernet controller chips, as well as support
48 for adapters based on the National Semiconductor DP83815 (MacPhyter)
49 PCI ethernet controller chip, including the Netgear FA311-TX and
50 FA312-TX.
51 .Pp
52 The SiS 900 is a 100Mbps ethernet MAC and MII-compliant transceiver
53 in a single package.
54 It uses a bus master DMA and a scatter/gather
55 descriptor scheme.
56 The SiS 7016 is similar to the SiS 900 except
57 that it has no internal PHY, requiring instead an external transceiver
58 to be attached to its MII interface.
59 The SiS 900 and SiS 7016 both have a 128-bit multicast hash filter
60 and a single perfect filter entry for the station address.
61 .Pp
62 The NS DP83815 is also a 100Mbps ethernet MAC with integrated PHY.
63 The NatSemi chip and the SiS 900 share many of the same features and
64 a fairly similar programming interface, hence both chips are supported
65 by the same driver.
66 .Pp
67 The
68 .Nm
69 driver supports the following media types:
70 .Bl -tag -width 10baseTXUTP
71 .It autoselect
72 Enable autoselection of the media type and options.
73 The user can manually override
74 the autoselected mode by adding media options to
75 .Xr rc.conf 5 .
76 .It 10baseT/UTP
77 Set 10Mbps operation.
78 The
79 .Xr ifconfig 8
80 .Cm mediaopt
81 option can also be used to select either
82 .Sq full-duplex
83 or
84 .Sq half-duplex
85 modes.
86 .It 100baseTX
87 Set 100Mbps (fast ethernet) operation.
88 The
89 .Xr ifconfig 8
90 .Cm mediaopt
91 option can also be used to select either
92 .Sq full-duplex
93 or
94 .Sq half-duplex
95 modes.
96 .El
97 .Pp
98 The
99 .Nm
100 driver supports the following media options:
101 .Bl -tag -width full-duplex
102 .It full-duplex
103 Force full duplex operation
104 .It half-duplex
105 Force half duplex operation.
106 .El
107 .Pp
108 For more information on configuring this device, see
109 .Xr ifconfig 8 .
110 The
111 .Nm
112 driver supports
113 .Xr polling 4 .
114 .Sh DIAGNOSTICS
115 .Bl -diag
116 .It "sis%d: couldn't map ports/memory"
117 A fatal initialization error has occurred.
118 .It "sis%d: couldn't map interrupt"
119 A fatal initialization error has occurred.
120 .It "sis%d: watchdog timeout"
121 The device has stopped responding to the network, or there is a problem with
122 the network connection (e.g. a cable fault).
123 .It "sis%d: no memory for rx list"
124 The driver failed to allocate an mbuf for the receiver ring.
125 .It "sis%d: no memory for tx list"
126 The driver failed to allocate an mbuf for the transmitter ring when
127 allocating a pad buffer or collapsing an mbuf chain into a clusisr.
128 .It "sis%d: chip is in D3 power state -- setting to D0"
129 This message applies only to adapters which support power
130 management.
131 Some operating systems place the controller in low power
132 mode when shutting down, and some PCI BIOSes fail to bring the chip
133 out of this state before configuring it.
134 The controller loses all of
135 its PCI configuration in the D3 state, so if the BIOS does not set
136 it back to full power mode in time, it will not be able to configure it
137 correctly.
138 The driver tries to detect this condition and bring
139 the adapter back to the D0 (full power) state, but this may not be
140 enough to return the driver to a fully operational condition.
141 If
142 you see this message at boot time and the driver fails to attach
143 the device as a network interface, you will have to perform a
144 warm boot to have the device properly configured.
145 .Pp
146 Note that this condition only occurs when warm booting from another
147 operating system.
148 If you power down your system prior to booting
149 .Dx ,
150 the card should be configured correctly.
151 .El
152 .Sh SEE ALSO
153 .Xr arp 4 ,
154 .Xr ifmedia 4 ,
155 .Xr miibus 4 ,
156 .Xr netintro 4 ,
157 .Xr ng_ether 4 ,
158 .Xr polling 4 ,
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 datasheet
166 .%O http://www.national.com
167 .Re
168 .Sh HISTORY
169 The
170 .Nm
171 device driver first appeared in
172 .Fx 3.0 .
173 .Sh AUTHORS
174 The
175 .Nm
176 driver was written by
177 .An Bill Paul Aq Mt wpaul@ee.columbia.edu .