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