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