1.\" $NetBSD: re.4,v 1.10 2006/08/07 20:41:16 pavel Exp $ 2.\" 3.\" Copyright (c) 2003 4.\" Bill Paul <wpaul@windriver.com>. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Bill Paul. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31.\" THE POSSIBILITY OF SUCH DAMAGE. 32.\" 33.\" $FreeBSD: src/share/man/man4/re.4,v 1.4 2004/03/04 06:42:46 sanpei Exp $ 34.\" 35.Dd August 7, 2006 36.Dt RE 4 37.Os 38.Sh NAME 39.Nm re 40.Nd "RealTek 8139C+/8169/8169S/8110S PCI Ethernet adapter driver" 41.Sh SYNOPSIS 42.Cd "re* at pci? dev ? function ?" 43.Cd "re* at cardbus? function ?" 44.Sh DESCRIPTION 45The 46.Nm 47driver provides support for various NICs based on the RealTek RTL8139C+, 48RTL8169, RTL8169S, and RTL8110S PCI/Cardbus Ethernet controllers, including 49the following: 50.Pp 51.Bl -bullet -compact 52.It 53Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+) 54.It 55Compaq Evo N1015v Integrated Ethernet (8139C+) 56.It 57Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S) 58.It 59NETGEAR GA311 (8169S) 60.It 61PLANEX COMMUNICATIONS Inc. GN-1200TC (8169S) 62.It 63Xterasys XN-152 10/100/1000 NIC (8169) 64.El 65.Pp 66NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over 67CAT5 cable. 68NICs based on the 8169, 8169S, and 8110S are capable of 10, 100, and 691000Mbps operation. 70.Pp 71All NICs supported by the 72.Nm 73driver have TCP/IP checksum offload and hardware VLAN tagging/insertion 74features, and use a descriptor-based DMA mechanism. 75They are also capable of TCP large send (TCP segmentation offload). 76There are issues with hardware VLAN tagging in this version of the 77driver, so this feature is currently disabled. 78.Pp 79The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY. 80The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY. 81The 8169S and 8110S are single-chip devices containing both a 10/100/1000 82MAC and 10/100/1000 copper PHY. 83Standalone 10/100/1000 cards are available in both 32-bit PCI and 8464-bit PCI models. 85The 8110S is designed for embedded LAN-on-motherboard applications. 86.Pp 87The 8169, 8169S, and 8110S also support jumbo frames, which can be 88configured via the interface MTU setting. 89Selecting an MTU larger than 1500 bytes with the 90.Xr ifconfig 8 91utility configures the adapter to receive and transmit jumbo frames. 92.Pp 93The 94.Nm 95driver supports the following media types: 96.Bl -tag -width 10baseTXUTP 97.It Cm autoselect 98Enable autoselection of the media type and options. 99The user can manually override 100the autoselected mode by adding media options to 101.Xr rc.conf 5 . 102.It Cm 10baseT/UTP 103Set 10Mbps 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 100baseTX 113Set 100Mbps (Fast Ethernet) operation. 114The 115.Xr ifconfig 8 116.Ic mediaopt 117option can also be used to select either 118.Cm full-duplex 119or 120.Cm half-duplex 121modes. 122.It Cm 1000baseTX 123Set 1000baseTX operation over twisted pair. 124The RealTek GigE chips support 1000Mbps in 125.Cm full-duplex 126mode only. 127.\" .It Cm 1000baseSX 128.\" Set 1000Mbps (Gigabit Ethernet) operation. 129.\" Both 130.\" .Cm full-duplex 131.\" and 132.\" .Cm half-duplex 133.\" modes are supported. 134.El 135.Pp 136The 137.Nm 138driver supports the following media options: 139.Bl -tag -width full-duplex 140.It Cm full-duplex 141Force full duplex operation. 142.It Cm half-duplex 143Force half duplex operation. 144.El 145.Pp 146For more information on configuring this device, see 147.Xr ifconfig 8 . 148.Sh DIAGNOSTICS 149.Bl -diag 150.It "re%d: couldn't map memory" 151A fatal initialization error has occurred. 152.It "re%d: couldn't map ports" 153A fatal initialization error has occurred. 154.It "re%d: couldn't map interrupt" 155A fatal initialization error has occurred. 156.It "re%d: no memory for softc struct!" 157The driver failed to allocate memory for per-device instance information 158during initialization. 159.It "re%d: failed to enable memory mapping!" 160The driver failed to initialize PCI shared memory mapping. 161This might happen if the card is not in a bus-master slot. 162.It "re%d: no memory for jumbo buffers!" 163The driver failed to allocate memory for jumbo frames during 164initialization. 165.It "re%d: watchdog timeout" 166The device has stopped responding to the network, or there is a problem with 167the network connection (cable). 168.El 169.Sh SEE ALSO 170.Xr arp 4 , 171.Xr cardbus 4 , 172.Xr mii 4 , 173.Xr netintro 4 , 174.Xr pci 4 , 175.Xr ifconfig 8 176.Rs 177.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S, and RTL8110S datasheets 178.%O http://www.realtek.com.tw 179.Re 180.Sh HISTORY 181The 182.Nm 183device driver first appeared in 184.Fx 5.2 185and was ported to 186.Nx 2.0 . 187.Sh AUTHORS 188The 189.Nm 190driver was written by 191.An Bill Paul Aq wpaul@windriver.com . 192.Sh BUGS 193The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and 194Marvell 88E1000 PHY, has a defect that causes DMA corruption 195if the board is plugged into a 64-bit PCI slot. 196The defect lies in the board design, not the chip itself: the PCI 197REQ64# and ACK64# lines should be pulled high, but they are not. 198The result is that the 8169 chip is tricked into performing 64-bit 199DMA transfers even though a 64-bit data path between the NIC and 200the bus does not actually exist. 201.Pp 202Unfortunately, it is not possible to correct this problem in software, 203however it is possible to detect it. 204When the 205.Nm 206driver is loaded, it will run a diagnostic routine designed to 207validate DMA operation by placing the chip in digital loopback mode 208and initiating a packet transmission. 209If the card functions properly, the transmitted data will 210be echoed back unmodified. 211If the echoed data is corrupt, the driver 212will print an error message on the console and abort the device attach. 213The user should ensure 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