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.\" $FreeBSD$ 32.\" 33.Dd September 4, 2003 34.Dt RE 4 35.Os 36.Sh NAME 37.Nm re 38.Nd "RealTek 8139C+/8169/8169S/8110S PCI Ethernet adapter driver" 39.Sh SYNOPSIS 40.Cd "device miibus" 41.Cd "device re" 42.Sh DESCRIPTION 43The 44.Nm 45driver provides support for various NICs based on the RealTek RTL8139C+, 46RTL8169, RTL8169S and RTL8110S PCI Ethernet controllers, including 47the following: 48.Pp 49.Bl -bullet -compact 50.It 51Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+) 52.It 53Compaq Evo N1015v Integrated Ethernet (8139C+) 54.It 55Corega CG-LAPCIGT Gigabit Ethernet(8169S) 56.It 57Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S) 58.It 59PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S) 60.It 61Xterasys XN-152 10/100/1000 NIC (8169) 62.El 63.Pp 64NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over CAT5 65cable. 66NICs based on the 8169, 8169S and 8110S are capable of 10, 100 and 671000Mbps operation. 68.Pp 69All NICs supported by the 70.Nm 71driver have TCP/IP checksum offload and hardware VLAN tagging/insertion 72features, and use a descriptor-based DMA mechanism. 73They are also 74capable of TCP large send (TCP segmentation offload). 75.Pp 76The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY. 77The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY. 78The 8169S and 8110S are single-chip devices containing both a 10/100/1000 79MAC and 10/100/1000 copper PHY. 80Standalone 10/100/1000 cards are available 81in both 32-bit PCI and 64-bit PCI models. 82The 8110S is designed for 83embedded LAN-on-motherboard applications. 84.Pp 85The 8169, 8169S and 8110S also support jumbo frames, which can be configured 86via the interface MTU setting. 87Selecting an MTU larger than 1500 bytes with the 88.Xr ifconfig 8 89utility configures the adapter to receive and transmit jumbo frames. 90.Pp 91The 92.Nm 93driver supports the following media types: 94.Bl -tag -width ".Cm 10baseT/UTP" 95.It Cm autoselect 96Enable autoselection of the media type and options. 97The user can manually override 98the autoselected mode by adding media options to 99.Xr rc.conf 5 . 100.It Cm 10baseT/UTP 101Set 10Mbps operation. 102The 103.Xr ifconfig 8 104.Cm mediaopt 105option can also be used to select either 106.Cm full-duplex 107or 108.Cm half-duplex 109modes. 110.It Cm 100baseTX 111Set 100Mbps (Fast Ethernet) operation. 112The 113.Xr ifconfig 8 114.Cm mediaopt 115option can also be used to select either 116.Cm full-duplex 117or 118.Cm half-duplex 119modes. 120.It Cm 1000baseTX 121Set 1000baseTX operation over twisted pair. 122The RealTek gigE chips support 1000Mbps in 123.Cm full-duplex 124mode only. 125.\" .It Cm 1000baseSX 126.\" Set 1000Mbps (Gigabit Ethernet) operation. 127.\" Both 128.\" .Cm full-duplex 129.\" and 130.\" .Cm half-duplex 131.\" modes are supported. 132.El 133.Pp 134The 135.Nm 136driver supports the following media options: 137.Bl -tag -width ".Cm full-duplex" 138.It Cm full-duplex 139Force full duplex operation. 140.It Cm half-duplex 141Force half duplex operation. 142.El 143.Pp 144For more information on configuring this device, see 145.Xr ifconfig 8 . 146.Sh DIAGNOSTICS 147.Bl -diag 148.It "re%d: couldn't map memory" 149A fatal initialization error has occurred. 150.It "re%d: couldn't map ports" 151A fatal initialization error has occurred. 152.It "re%d: couldn't map interrupt" 153A fatal initialization error has occurred. 154.It "re%d: no memory for softc struct!" 155The driver failed to allocate memory for per-device instance information 156during initialization. 157.It "re%d: failed to enable memory mapping!" 158The driver failed to initialize PCI shared memory mapping. 159This might 160happen if the card is not in a bus-master slot. 161.It "re%d: no memory for jumbo buffers!" 162The driver failed to allocate memory for jumbo frames during 163initialization. 164.It "re%d: watchdog timeout" 165The device has stopped responding to the network, or there is a problem with 166the network connection (cable). 167.El 168.Sh SEE ALSO 169.Xr arp 4 , 170.Xr miibus 4 , 171.Xr netintro 4 , 172.Xr ng_ether 4 , 173.Xr vlan 4 , 174.Xr ifconfig 8 175.Rs 176.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets 177.%O http://www.realtek.com.tw/ 178.Re 179.Sh HISTORY 180The 181.Nm 182device driver first appeared in 183.Fx 5.2 . 184.Sh AUTHORS 185The 186.Nm 187driver was written by 188.An Bill Paul Aq wpaul@windriver.com . 189.Sh BUGS 190The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and 191Marvell 88E1000 PHY, has a defect that causes DMA corruption 192if the board is plugged into a 64-bit PCI slot. 193The defect 194lies in the board design, not the chip itself: the PCI REQ64# and ACK64# 195lines should be pulled high, but they are not. 196The result is that the 1978169 chip is tricked into performing 64-bit DMA transfers even though 198a 64-bit data path between the NIC and the bus does not actually exist. 199.Pp 200Unfortunately, it is not possible to correct this problem in software, 201however it is possible to detect it. 202When the 203.Nm 204driver is loaded, it will run a diagnostic routine designed to 205validate DMA operation by placing the chip in digital loopback mode 206and initiating a packet transmission. 207If the card functions properly, 208the transmitted data will 209be echoed back unmodified. 210If the echoed data is corrupt, the driver 211will print an error message on the console and abort the device attach. 212The 213user should insure the NIC is installed in a 32-bit PCI slot to 214avoid this problem. 215.Pp 216The RealTek 8169, 8169S and 8110S chips appear to only be capable of 217transmitting jumbo frames up to 7.5K in size. 218