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