1 .\" Copyright (c) 1997, 1998
2 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
38 .Nd RealTek 8129/8139 Fast Ethernet device driver
45 driver provides support for PCI Ethernet adapters and embedded
46 controllers based on the RealTek 8129 and 8139 Fast Ethernet controller
49 The RealTek 8129/8139 series controllers use bus master DMA but do not use a
50 descriptor-based data transfer mechanism.
52 single fixed size ring buffer from which packets must be copied
54 For transmission, there are only four outbound packet
55 address registers which require all outgoing packets to be stored
56 as contiguous buffers.
57 Furthermore, outbound packet buffers must
58 be longword aligned or else transmission will fail.
60 The 8129 differs from the 8139 in that the 8139 has an internal
61 PHY which is controlled through special direct access registers
62 whereas the 8129 uses an external PHY via an MII bus.
64 supports both 10 and 100Mbps speeds in either full or half duplex.
65 The 8129 can support the same speeds and modes given an appropriate
68 Note: support for the 8139C+ chip is provided by the
74 driver supports the following media types:
76 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
78 Enable autoselection of the media type and options.
80 supported if the PHY chip attached to the RealTek controller
81 supports NWAY autonegotiation.
82 The user can manually override
83 the autoselected mode by adding media options to the
90 option can also be used to select either
96 Set 100Mbps (Fast Ethernet) operation.
99 option can also be used to select either
108 driver supports the following media options:
110 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
112 Force full duplex operation
114 Force half duplex operation.
117 Note that the 100baseTX media type is only available if supported
119 For more information on configuring this device, see
122 Adapters supported by the
130 EN1207D (MPX 5030/5038; RealTek 8139 clone)
132 Allied Telesyn AT2550
134 Allied Telesyn AT2500TX
138 BUFFALO (Melco INC.) LPC-CB-CLX (CardBus)
142 CompUSA no-name 10/100 PCI Ethernet NIC
146 Corega FEtherII CB-TXD
156 Edimax EP-4103DL CardBus
158 Encore ENL832-TX 10/100 M PCI
160 Farallon NetLINE 10/100 PCI
164 GigaFast Ethernet EE100-AXP
166 KTX-9130TX 10/100 Fast Ethernet
170 Longshine LCS-8038TX-R
172 NDC Communications NE100TX-E
174 Netronix Inc.\& EA-1210 NetEther 10/100
176 Nortel Networks 10/100BaseTX
186 SMC EZ Card 10/100 PCI 1211-TX
188 SOHO (PRAGMATIC) UE-1211C
192 .It "rl%d: couldn't map memory"
193 A fatal initialization error has occurred.
194 .It "rl%d: couldn't map interrupt"
195 A fatal initialization error has occurred.
196 .It "rl%d: watchdog timeout"
197 The device has stopped responding to the network, or there is a problem with
198 the network connection (cable).
199 .It "rl%d: no memory for rx list"
200 The driver failed to allocate an mbuf for the receiver ring.
201 .It "rl%d: no memory for tx list"
202 The driver failed to allocate an mbuf for the transmitter ring when
203 allocating a pad buffer or collapsing an mbuf chain into a cluster.
204 .It "rl%d: chip is in D3 power state -- setting to D0"
205 This message applies only to adapters which support power
207 Some operating systems place the controller in low power
208 mode when shutting down, and some PCI BIOSes fail to bring the chip
209 out of this state before configuring it.
210 The controller loses all of
211 its PCI configuration in the D3 state, so if the BIOS does not set
212 it back to full power mode in time, it will not be able to configure it
214 The driver tries to detect this condition and bring
215 the adapter back to the D0 (full power) state, but this may not be
216 enough to return the driver to a fully operational condition.
218 you see this message at boot time and the driver fails to attach
219 the device as a network interface, you will have to perform second
220 warm boot to have the device properly configured.
222 Note that this condition only occurs when warm booting from another
224 If you power down your system prior to booting
226 the card should be configured correctly.
236 .%B The RealTek 8129, 8139 and 8139C+ datasheets
237 .%O http://www.realtek.com.tw
242 device driver first appeared in
247 driver was written by
248 .An Bill Paul Aq wpaul@ctr.columbia.edu .
250 Since outbound packets must be longword aligned, the transmit
251 routine has to copy an unaligned packet into an mbuf cluster buffer
253 The driver abuses the fact that the cluster buffer
254 pool is allocated at system startup time in a contiguous region starting
256 Since cluster buffers are 2048 bytes, they are
257 longword aligned by definition.
258 The driver probably should not be
259 depending on this characteristic.
261 The RealTek data sheets are of especially poor quality,
262 and there is a lot of information missing
263 particularly concerning the receiver operation.
265 important fact that the data sheets fail to mention relates to the
266 way in which the chip fills in the receive buffer.
268 is posted to signal that a frame has been received, it is possible that
269 another frame might be in the process of being copied into the receive
270 buffer while the driver is busy handling the first one.
272 manages to finish processing the first frame before the chip is done
273 DMAing the rest of the next frame, the driver may attempt to process
274 the next frame in the buffer before the chip has had a chance to finish
277 The driver can check for an incomplete frame by inspecting the frame
278 length in the header preceding the actual packet data: an incomplete
279 frame will have the magic length of 0xFFF0.
280 When the driver encounters
281 this value, it knows that it has finished processing all currently
283 Neither this magic value nor its significance are
284 documented anywhere in the RealTek data sheets.