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