Add the AMD-766, Apple KeyLargo, and SiS 5571.
[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.2 2003/06/17 04:36:59 dillon 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
59 supports both 10 and 100Mbps speeds in either full or half duplex
60 using an MII transceiver.
61 .Pp
62 The
63 .Nm
64 driver supports the following media types:
65 .Pp
66 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
67 .It autoselect
68 Enable autoselection of the media type and options.
69 The user can manually override
70 the autoselected mode by adding media options to the
71 .Pa /etc/rc.conf
72 fine.
73 .It 10baseT/UTP
74 Set 10Mbps operation.
75 The
76 .Ar mediaopt
77 option can also be used to select either
78 .Ar full-duplex
79 or
80 .Ar half-duplex
81 modes.
82 .It 100baseTX
83 Set 100Mbps (fast ethernet) operation.
84 The
85 .Ar mediaopt
86 option can also be used to select either
87 .Ar full-duplex
88 or
89 .Ar half-duplex
90 modes.
91 .El
92 .Pp
93 The
94 .Nm
95 driver supports the following media options:
96 .Pp
97 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
98 .It full-duplex
99 Force full duplex operation
100 .It half-duplex
101 Force half duplex operation.
102 .El
103 .Pp
104 For more information on configuring this device, see
105 .Xr ifconfig 8 .
106 .Sh DIAGNOSTICS
107 .Bl -diag
108 .It "ste%d: couldn't map ports/memory"
109 A fatal initialization error has occurred.
110 .It "ste%d: couldn't map interrupt"
111 A fatal initialization error has occurred.
112 .It "ste%d: watchdog timeout"
113 The device has stopped responding to the network, or there is a problem with
114 the network connection (cable).
115 .It "ste%d: no memory for rx list"
116 The driver failed to allocate an mbuf for the receiver ring.
117 .It "ste%d: no memory for tx list"
118 The driver failed to allocate an mbuf for the transmitter ring when
119 allocating a pad buffer or collapsing an mbuf chain into a cluster.
120 .It "ste%d: chip is in D3 power state -- setting to D0"
121 This message applies only to adapters which support power
122 management.
123 Some operating systems place the controller in low power
124 mode when shutting down, and some PCI BIOSes fail to bring the chip
125 out of this state before configuring it.
126 The controller loses all of
127 its PCI configuration in the D3 state, so if the BIOS does not set
128 it back to full power mode in time, it won't be able to configure it
129 correctly.
130 The driver tries to detect this condition and bring
131 the adapter back to the D0 (full power) state, but this may not be
132 enough to return the driver to a fully operational condition.
133 If
134 you see this message at boot time and the driver fails to attach
135 the device as a network interface, you will have to perform second
136 warm boot to have the device properly configured.
137 .Pp
138 Note that this condition only occurs when warm booting from another
139 operating system.
140 If you power down your system prior to booting
141 .Fx ,
142 the card should be configured correctly.
143 .El
144 .Sh SEE ALSO
145 .Xr arp 4 ,
146 .Xr miibus 4 ,
147 .Xr netintro 4 ,
148 .Xr ng_ether 4 ,
149 .Xr ifconfig 8
150 .Rs
151 .%T Sundance ST201 data sheet
152 .%O http://www.sundanceti.com
153 .Re
154 .Sh HISTORY
155 The
156 .Nm
157 device driver first appeared in
158 .Fx 3.0 .
159 .Sh AUTHORS
160 The
161 .Nm
162 driver was written by
163 .An Bill Paul Aq wpaul@ee.columbia.edu .