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.
33 .Dd September 21, 2016
38 .Nd "RealTek 8139C+/8169/816xS/811xS/8168/810xE/8111 PCI/PCIe Ethernet adapter driver"
40 To compile this driver into the kernel,
41 place the following lines in your
42 kernel configuration file:
43 .Bd -ragged -offset indent
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for various NICs based on the RealTek RTL8139C+,
58 RTL8169, RTL816xS, RTL811xS, RTL8168, RTL810xE and RTL8111 PCI and
59 PCIe Ethernet controllers.
61 NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps speeds
63 NICs based on the 8169, 816xS, 811xS, 8168 and 8111 are capable of 10, 100
64 and 1000Mbps operation.
66 All NICs supported by the
68 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
69 features, and use a descriptor-based DMA mechanism.
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 816xS, 811xS, 8168 and 8111 are single-chip devices containing both a
76 10/100/1000 MAC and 10/100/1000 copper PHY.
77 Standalone 10/100/1000 cards are available
78 in both 32-bit PCI and 64-bit PCI models.
79 The 8110S is designed for
80 embedded LAN-on-motherboard applications.
82 The 8169, 8169S and 8110S also support jumbo frames, which can be configured
83 via the interface MTU setting.
84 The MTU is limited to 7422, since the chip cannot transmit larger frames.
85 Selecting an MTU larger than 1500 bytes with the
87 utility configures the adapter to receive and transmit jumbo frames.
91 driver supports the following media types:
92 .Bl -tag -width ".Cm 10baseT/UTP"
94 Enable autoselection of the media type and options.
95 The user can manually override
96 the autoselected mode by adding media options to
103 option can also be used to select either
109 Set 100Mbps (Fast Ethernet) operation.
113 option can also be used to select either
119 Set 1000baseTX operation over twisted pair.
120 The RealTek gigE chips support 1000Mbps in
123 .\" .It Cm 1000baseSX
124 .\" Set 1000Mbps (Gigabit Ethernet) operation.
129 .\" modes are supported.
134 driver supports the following media options:
135 .Bl -tag -width ".Cm full-duplex"
137 Force full duplex operation.
139 Force half duplex operation.
142 For more information on configuring this device, see
147 driver supports RealTek RTL8139C+, RTL8169, RTL816xS, RTL811xS, RTL8168,
148 RTL810xE and RTL8111 based Fast Ethernet and Gigabit Ethernet adapters including:
152 Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
154 Compaq Evo N1015v Integrated Ethernet (8139C+)
156 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
158 D-Link DGE-528(T) Gigabit Ethernet (8169S)
160 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
162 LevelOne GNC-0105T (8169S)
164 LinkSys EG1032 (32-bit PCI)
166 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
168 TP-Link TG-3468 v2 Gigabit Ethernet (8168)
170 USRobotics USR997902 Gigabit Ethernet (8169S)
172 Xterasys XN-152 10/100/1000 NIC (8169)
175 Tunables can be set at the
177 prompt before booting the kernel or stored in
179 .Bl -tag -width "xxxxxx"
180 .It Va hw.re.intr_filter
181 This tunable makes driver use interrupt filter handler on
182 controllers that support MSI/MSI-X capability.
183 If MSI/MSI-X is disabled by administrator this tunable has no
184 effect and driver will use interrupt filter handler.
185 The default value is 0 to use interrupt thread handler.
186 .It Va hw.re.msi_disable
187 This tunable disables MSI support on the Ethernet hardware.
188 The default value is 0.
189 .It Va hw.re.msix_disable
190 This tunable disables MSI-X support on the Ethernet hardware.
191 The default value is 0.
192 .It Va hw.re.prefer_iomap
193 This tunable controls which register mapping should be used on the
195 A non-zero value enables I/O space register mapping.
196 The default value is 0 to use memory space register mapping.
199 The following variables are available as both
204 .Bl -tag -width "xxxxxx"
205 .It Va dev.re.%d.int_rx_mod
206 Maximum amount of time to delay receive interrupt processing in
208 The accepted range is 0 to 65, the default is 65(65us).
209 Value 0 completely disables the interrupt moderation.
210 The interface need to be brought down and up again before a change
215 .It "re%d: couldn't map memory"
216 A fatal initialization error has occurred.
217 .It "re%d: couldn't map ports"
218 A fatal initialization error has occurred.
219 .It "re%d: couldn't map interrupt"
220 A fatal initialization error has occurred.
221 .It "re%d: no memory for softc struct!"
222 The driver failed to allocate memory for per-device instance information
223 during initialization.
224 .It "re%d: failed to enable memory mapping!"
225 The driver failed to initialize PCI shared memory mapping.
227 happen if the card is not in a bus-master slot.
228 .It "re%d: no memory for jumbo buffers!"
229 The driver failed to allocate memory for jumbo frames during
231 .It "re%d: watchdog timeout"
232 The device has stopped responding to the network, or there is a problem with
233 the network connection (cable).
246 .%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
247 .%U http://www.realtek.com.tw/
252 device driver first appeared in
257 driver was written by
258 .An Bill Paul Aq Mt wpaul@windriver.com .
260 The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
261 Marvell 88E1000 PHY, has a defect that causes DMA corruption
262 if the board is plugged into a 64-bit PCI slot.
264 lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
265 lines should be pulled high, but they are not.
266 The result is that the
267 8169 chip is tricked into performing 64-bit DMA transfers even though
268 a 64-bit data path between the NIC and the bus does not actually exist.
270 Unfortunately, it is not possible to correct this problem in software,
271 however it is possible to detect it.
274 driver is loaded, it will run a diagnostic routine designed to
275 validate DMA operation by placing the chip in digital loopback mode
276 and initiating a packet transmission.
277 If the card functions properly,
278 the transmitted data will
279 be echoed back unmodified.
280 If the echoed data is corrupt, the driver
281 will print an error message on the console and abort the device attach.
283 user should ensure the NIC is installed in a 32-bit PCI slot to
286 The RealTek 8169, 8169S and 8110S chips appear to only be capable of
287 transmitting jumbo frames up to 7.5K in size.