* Sync pages with FreeBSD 4.x
[dragonfly.git] / share / man / man4 / ste.4
1 .\" Copyright (c) 1997, 1998, 1999
2 .\"     Bill Paul <wpaul@ctr.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/ste.4,v 1.7.2.5 2003/02/17 21:20:39 trhodes Exp $
32 .\" $DragonFly: src/share/man/man4/ste.4,v 1.3 2004/01/31 01:09:19 drhodus Exp $
33 .\"
34 .Dd August 21, 1999
35 .Dt STE 4
36 .Os
37 .Sh NAME
38 .Nm ste
39 .Nd "Sundance Technologies ST201 fast ethernet device driver"
40 .Sh SYNOPSIS
41 .Cd "device miibus"
42 .Cd "device ste"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for PCI ethernet adapters and embedded
47 controllers based on the Sundance Technologies ST201 PCI fast
48 ethernet controller chip.
49 This includes the D-Link DFE-550TX.
50 .Pp
51 The Sundance ST201 uses bus master DMA and is designed to be a
52 3Com Etherlink XL workalike.
53 It uses the same DMA descriptor
54 structure and is very similar in operation, however its register
55 layout is different.
56 The ST201 has a 64-bit multicast hash filter
57 and a single perfect filter entry for the station address.
58 It supports both 10 and 100Mbps speeds in either full or half duplex
59 using an MII transceiver.
60 .Pp
61 The
62 .Nm
63 driver supports the following media types:
64 .Pp
65 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
66 .It autoselect
67 Enable autoselection of the media type and options.
68 The user can manually override
69 the autoselected mode by adding media options to the
70 .Pa /etc/rc.conf
71 file.
72 .It 10baseT/UTP
73 Set 10Mbps operation.
74 The
75 .Ar mediaopt
76 option can also be used to select either
77 .Ar full-duplex
78 or
79 .Ar half-duplex
80 modes.
81 .It 100baseTX
82 Set 100Mbps (fast ethernet) operation.
83 The
84 .Ar mediaopt
85 option can also be used to select either
86 .Ar full-duplex
87 or
88 .Ar half-duplex
89 modes.
90 .El
91 .Pp
92 The
93 .Nm
94 driver supports the following media options:
95 .Pp
96 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
97 .It full-duplex
98 Force full duplex operation
99 .It half-duplex
100 Force half duplex operation.
101 .El
102 .Pp
103 For more information on configuring this device, see
104 .Xr ifconfig 8 .
105 .Sh DIAGNOSTICS
106 .Bl -diag
107 .It "ste%d: couldn't map ports/memory"
108 A fatal initialization error has occurred.
109 .It "ste%d: couldn't map interrupt"
110 A fatal initialization error has occurred.
111 .It "ste%d: watchdog timeout"
112 The device has stopped responding to the network, or there is a problem with
113 the network connection (cable).
114 .It "ste%d: no memory for rx list"
115 The driver failed to allocate an mbuf for the receiver ring.
116 .It "ste%d: no memory for tx list"
117 The driver failed to allocate an mbuf for the transmitter ring when
118 allocating a pad buffer or collapsing an mbuf chain into a cluster.
119 .It "ste%d: chip is in D3 power state -- setting to D0"
120 This message applies only to adapters which support power
121 management.
122 Some operating systems place the controller in low power
123 mode when shutting down, and some PCI BIOSes fail to bring the chip
124 out of this state before configuring it.
125 The controller loses all of
126 its PCI configuration in the D3 state, so if the BIOS does not set
127 it back to full power mode in time, it won't be able to configure it
128 correctly.
129 The driver tries to detect this condition and bring
130 the adapter back to the D0 (full power) state, but this may not be
131 enough to return the driver to a fully operational condition.
132 If
133 you see this message at boot time and the driver fails to attach
134 the device as a network interface, you will have to perform a second
135 warm boot to have the device properly configured.
136 .Pp
137 Note that this condition only occurs when warm booting from another
138 operating system.
139 If you power down your system prior to booting
140 .Fx ,
141 the card should be configured correctly.
142 .El
143 .Sh SEE ALSO
144 .Xr arp 4 ,
145 .Xr miibus 4 ,
146 .Xr netintro 4 ,
147 .Xr ng_ether 4 ,
148 .Xr ifconfig 8
149 .Rs
150 .%T Sundance ST201 data sheet
151 .%O http://www.sundanceti.com
152 .Re
153 .Sh HISTORY
154 The
155 .Nm
156 device driver first appeared in
157 .Fx 3.0 .
158 .Sh AUTHORS
159 The
160 .Nm
161 driver was written by
162 .An Bill Paul Aq wpaul@ee.columbia.edu .