2 .\" Bill Paul <wpaul@windriver.com>. 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.
32 .\" $DragonFly: src/share/man/man4/re.4,v 1.1 2004/07/07 09:47:27 joerg Exp $
39 .Nd "RealTek 8139C+/8169/8169S/8110S PCI ethernet adapter driver"
46 driver provides support for various NICs based on the RealTek RTL8139C+,
47 RTL8169, RTL8169S and RTL8110S PCI ethernet controllers, including
52 Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
54 Compaq Evo N1015v Integrated Ethernet (8139C+)
56 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
58 PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S)
60 Xterasys XN-152 10/100/1000 NIC (8169)
63 NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over CAT5
64 cable. NICs based on the 8169, 8169S and 8110S are capable of 10, 100 and
67 All NICs supported by the
69 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
70 features, and use a descriptor-based DMA mechanism. They are also
71 capable of TCP large send (TCP segmentation offload).
73 The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
74 The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
75 The 8169S and 8110S are single-chip devices containing both a 10/100/1000
76 MAC and 10/100/1000 copper PHY. Standalone 10/100/1000 cards are available
77 in both 32-bit PCI and 64-bit PCI models. The 8110S is designed for
78 embedded LAN-on-motherboard applications.
80 The 8169, 8169S and 8110S also support jumbo frames, which can be configured
81 via the interface MTU setting.
82 Selecting an MTU larger than 1500 bytes with the
84 utility configures the adapter to receive and transmit jumbo frames.
88 driver supports the following media types:
89 .Bl -tag -width 10baseTXUTP
91 Enable autoselection of the media type and options.
92 The user can manually override
93 the autoselected mode by adding media options to
100 option can also be used to select either
106 Set 100Mbps (fast ethernet) operation.
110 option can also be used to select either
116 Set 1000baseTX operation over twisted pair.
117 The RealTek gigE chips support 1000Mbps in
120 .\" .It Cm 1000baseSX
121 .\" Set 1000Mbps (gigabit ethernet) operation.
126 .\" modes are supported.
131 driver supports the following media options:
132 .Bl -tag -width full-duplex
134 Force full duplex operation.
136 Force half duplex operation.
139 For more information on configuring this device, see
143 .It "re%d: couldn't map memory"
144 A fatal initialization error has occurred.
145 .It "re%d: couldn't map ports"
146 A fatal initialization error has occurred.
147 .It "re%d: couldn't map interrupt"
148 A fatal initialization error has occurred.
149 .It "re%d: no memory for softc struct!"
150 The driver failed to allocate memory for per-device instance information
151 during initialization.
152 .It "re%d: failed to enable memory mapping!"
153 The driver failed to initialize PCI shared memory mapping.
155 happen if the card is not in a bus-master slot.
156 .It "re%d: no memory for jumbo buffers!"
157 The driver failed to allocate memory for jumbo frames during
159 .It "re%d: watchdog timeout"
160 The device has stopped responding to the network, or there is a problem with
161 the network connection (cable).
171 .%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
172 .%O http://www.realtek.com.tw
177 device driver first appeared in
184 driver was written by
185 .An Bill Paul Aq wpaul@windriver.com .
187 The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
188 Marvell 88E1000 PHY, has a defect that causes DMA corruption
189 if the board is plugged into a 64-bit PCI slot. The defect
190 lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
191 lines should be pulled high, but they are not. The result is that the
192 8169 chip is tricked into performing 64-bit DMA transfers even though
193 a 64-bit data path between the NIC and the bus does not actually exist.
195 Unfortunately, it is not possible to correct this problem in software,
196 however it is possible to detect it. When the
198 driver is loaded, it will run a diagnostic routine designed to
199 validate DMA operation by placing the chip in digital loopback mode
200 and initiating a packet transmission. If the card functions properly,
201 the transmitted data will
202 be echoed back unmodified. If the echoed data is corrupt, the driver
203 will print an error message on the console and abort the device attach. The
204 user should insure the NIC is installed in a 32-bit PCI slot to
207 The RealTek 8169, 8169S and 8110S chips appear to only be capable of
208 transmitting jumbo frames up to 7.5K in size.