1.\" Copyright (c) 2003 2.\" Bill Paul <wpaul@windriver.com>. 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.Dd November 7, 2022 32.Dt RE 4 33.Os 34.Sh NAME 35.Nm re 36.Nd "RealTek 8139C+/8169/816xS/811xS/8168/810xE/8111 PCI/PCIe Ethernet adapter driver" 37.Sh SYNOPSIS 38To compile this driver into the kernel, 39place the following lines in your 40kernel configuration file: 41.Bd -ragged -offset indent 42.Cd "device miibus" 43.Cd "device re" 44.Ed 45.Pp 46Alternatively, to load the driver as a 47module at boot time, place the following line in 48.Xr loader.conf 5 : 49.Bd -literal -offset indent 50if_re_load="YES" 51.Ed 52.Sh DESCRIPTION 53The 54.Nm 55driver provides support for various NICs based on the RealTek RTL8139C+, 56RTL8169, RTL816xS, RTL811xS, RTL8168, RTL810xE and RTL8111 PCI and 57PCIe Ethernet controllers. 58.Pp 59NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps speeds 60over CAT5 cable. 61NICs based on the 8169, 816xS, 811xS, 8168 and 8111 are capable of 10, 100 62and 1000Mbps operation. 63.Pp 64All NICs supported by the 65.Nm 66driver have TCP/IP checksum offload and hardware VLAN tagging/insertion 67features, and use a descriptor-based DMA mechanism. 68They are also 69capable of TCP large send (TCP segmentation offload). 70.Pp 71The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY. 72The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY. 73The 816xS, 811xS, 8168 and 8111 are single-chip devices containing both a 7410/100/1000 MAC and 10/100/1000 copper PHY. 75Standalone 10/100/1000 cards are available 76in both 32-bit PCI and 64-bit PCI models. 77The 8110S is designed for 78embedded LAN-on-motherboard applications. 79.Pp 80The 8169, 8169S and 8110S also support jumbo frames, which can be configured 81via the interface MTU setting. 82The MTU is limited to 7422, since the chip cannot transmit larger frames. 83Selecting an MTU larger than 1500 bytes with the 84.Xr ifconfig 8 85utility configures the adapter to receive and transmit jumbo frames. 86.Pp 87The 88.Nm 89driver supports the following media types: 90.Bl -tag -width ".Cm 10baseT/UTP" 91.It Cm autoselect 92Enable autoselection of the media type and options. 93The user can manually override 94the autoselected mode by adding media options to 95.Xr rc.conf 5 . 96.It Cm 10baseT/UTP 97Set 10Mbps operation. 98The 99.Xr ifconfig 8 100.Cm mediaopt 101option can also be used to select either 102.Cm full-duplex 103or 104.Cm half-duplex 105modes. 106.It Cm 100baseTX 107Set 100Mbps (Fast Ethernet) operation. 108The 109.Xr ifconfig 8 110.Cm mediaopt 111option can also be used to select either 112.Cm full-duplex 113or 114.Cm half-duplex 115modes. 116.It Cm 1000baseTX 117Set 1000baseTX operation over twisted pair. 118The RealTek gigE chips support 1000Mbps in 119.Cm full-duplex 120mode only. 121.\" .It Cm 1000baseSX 122.\" Set 1000Mbps (Gigabit Ethernet) operation. 123.\" Both 124.\" .Cm full-duplex 125.\" and 126.\" .Cm half-duplex 127.\" modes are supported. 128.El 129.Pp 130The 131.Nm 132driver supports the following media options: 133.Bl -tag -width ".Cm full-duplex" 134.It Cm full-duplex 135Force full duplex operation. 136.It Cm half-duplex 137Force half duplex operation. 138.El 139.Pp 140For more information on configuring this device, see 141.Xr ifconfig 8 . 142.Sh HARDWARE 143The 144.Nm 145driver supports RealTek RTL8139C+, RTL8169, RTL816xS, RTL811xS, RTL8168, 146RTL810xE and RTL8111 based Fast Ethernet and Gigabit Ethernet adapters including: 147.Pp 148.Bl -bullet -compact 149.It 150Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+) 151.It 152Compaq Evo N1015v Integrated Ethernet (8139C+) 153.It 154Corega CG-LAPCIGT Gigabit Ethernet (8169S) 155.It 156D-Link DGE-528(T) Gigabit Ethernet (8169S) 157.It 158Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S) 159.It 160LevelOne GNC-0105T (8169S) 161.It 162LinkSys EG1032 (32-bit PCI) 163.It 164PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S) 165.It 166TP-Link TG-3468 v2 Gigabit Ethernet (8168) 167.It 168USRobotics USR997902 Gigabit Ethernet (8169S) 169.It 170Xterasys XN-152 10/100/1000 NIC (8169) 171.El 172.Sh LOADER TUNABLES 173Tunables can be set at the 174.Xr loader 8 175prompt before booting the kernel or stored in 176.Xr loader.conf 5 . 177.Bl -tag -width "xxxxxx" 178.It Va hw.re.intr_filter 179This tunable makes driver use interrupt filter handler on 180controllers that support MSI/MSI-X capability. 181If MSI/MSI-X is disabled by administrator this tunable has no 182effect and driver will use interrupt filter handler. 183The default value is 0 to use interrupt thread handler. 184.It Va hw.re.msi_disable 185This tunable disables MSI support on the Ethernet hardware. 186The default value is 0. 187.It Va hw.re.msix_disable 188This tunable disables MSI-X support on the Ethernet hardware. 189The default value is 0. 190.It Va hw.re.prefer_iomap 191This tunable controls which register mapping should be used on the 192specified device. 193A non-zero value enables I/O space register mapping. 194The default value is 0 to use memory space register mapping. 195.El 196.Sh SYSCTL VARIABLES 197The following variables are available as both 198.Xr sysctl 8 199variables and 200.Xr loader 8 201tunables: 202.Bl -tag -width "xxxxxx" 203.It Va dev.re.%d.int_rx_mod 204Maximum amount of time to delay receive interrupt processing in 205units of 1us. 206The accepted range is 0 to 65, the default is 65(65us). 207Value 0 completely disables the interrupt moderation. 208The interface need to be brought down and up again before a change 209takes effect. 210.El 211.Sh DIAGNOSTICS 212.Bl -diag 213.It "re%d: couldn't map memory" 214A fatal initialization error has occurred. 215.It "re%d: couldn't map ports" 216A fatal initialization error has occurred. 217.It "re%d: couldn't map interrupt" 218A fatal initialization error has occurred. 219.It "re%d: no memory for softc struct!" 220The driver failed to allocate memory for per-device instance information 221during initialization. 222.It "re%d: failed to enable memory mapping!" 223The driver failed to initialize PCI shared memory mapping. 224This might 225happen if the card is not in a bus-master slot. 226.It "re%d: no memory for jumbo buffers!" 227The driver failed to allocate memory for jumbo frames during 228initialization. 229.It "re%d: watchdog timeout" 230The device has stopped responding to the network, or there is a problem with 231the network connection (cable). 232.El 233.Sh SEE ALSO 234.Xr altq 4 , 235.Xr arp 4 , 236.Xr miibus 4 , 237.Xr netintro 4 , 238.Xr ng_ether 4 , 239.Xr polling 4 , 240.Xr rgephy 4 , 241.Xr vlan 4 , 242.Xr ifconfig 8 243.Rs 244.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets 245.%U https://www.realtek.com 246.Re 247.Sh HISTORY 248The 249.Nm 250device driver first appeared in 251.Fx 5.2 . 252.Sh AUTHORS 253The 254.Nm 255driver was written by 256.An Bill Paul Aq Mt wpaul@windriver.com . 257.Sh BUGS 258The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and 259Marvell 88E1000 PHY, has a defect that causes DMA corruption 260if the board is plugged into a 64-bit PCI slot. 261The defect 262lies in the board design, not the chip itself: the PCI REQ64# and ACK64# 263lines should be pulled high, but they are not. 264The result is that the 2658169 chip is tricked into performing 64-bit DMA transfers even though 266a 64-bit data path between the NIC and the bus does not actually exist. 267.Pp 268Unfortunately, it is not possible to correct this problem in software, 269however it is possible to detect it. 270When the 271.Nm 272driver is loaded, it will run a diagnostic routine designed to 273validate DMA operation by placing the chip in digital loopback mode 274and initiating a packet transmission. 275If the card functions properly, 276the transmitted data will 277be echoed back unmodified. 278If the echoed data is corrupt, the driver 279will print an error message on the console and abort the device attach. 280The 281user should ensure the NIC is installed in a 32-bit PCI slot to 282avoid this problem. 283.Pp 284The RealTek 8169, 8169S and 8110S chips appear to only be capable of 285transmitting jumbo frames up to 7.5K in size. 286.Pp 287If this driver is causing problems then an updated driver from 288the vendor can be found in ports under net/realtek-re-kmod. 289