1.\" $NetBSD: re.4,v 1.9 2006/02/19 09:40:32 xtraeme 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 February 19, 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). 76.Pp 77The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY. 78The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY. 79The 8169S and 8110S are single-chip devices containing both a 10/100/1000 80MAC and 10/100/1000 copper PHY. 81Standalone 10/100/1000 cards are available in both 32-bit PCI and 8264-bit PCI models. 83The 8110S is designed for embedded LAN-on-motherboard applications. 84.Pp 85The 8169, 8169S, and 8110S also support jumbo frames, which can be 86configured via 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 10baseTXUTP 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.Ic 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.Ic 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 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 happen if the card is not in a bus-master slot. 160.It "re%d: no memory for jumbo buffers!" 161The driver failed to allocate memory for jumbo frames during 162initialization. 163.It "re%d: watchdog timeout" 164The device has stopped responding to the network, or there is a problem with 165the network connection (cable). 166.El 167.Sh SEE ALSO 168.Xr arp 4 , 169.Xr cardbus 4 , 170.Xr mii 4 , 171.Xr netintro 4 , 172.Xr pci 4 , 173.Xr ifconfig 8 174.Rs 175.%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S, and RTL8110S datasheets 176.%O http://www.realtek.com.tw 177.Re 178.Sh HISTORY 179The 180.Nm 181device driver first appeared in 182.Fx 5.2 183and was ported to 184.Nx 2.0 . 185.Sh AUTHORS 186The 187.Nm 188driver was written by 189.An Bill Paul Aq wpaul@windriver.com . 190.Sh BUGS 191The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and 192Marvell 88E1000 PHY, has a defect that causes DMA corruption 193if the board is plugged into a 64-bit PCI slot. 194The defect lies in the board design, not the chip itself: the PCI 195REQ64# and ACK64# lines should be pulled high, but they are not. 196The result is that the 8169 chip is tricked into performing 64-bit 197DMA transfers even though a 64-bit data path between the NIC and 198the 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, the transmitted data will 208be echoed back unmodified. 209If the echoed data is corrupt, the driver 210will print an error message on the console and abort the device attach. 211The user should ensure the NIC is installed in a 32-bit PCI slot to 212avoid this problem. 213.Pp 214The RealTek 8169, 8169S, and 8110S chips appear to only be capable of 215transmitting jumbo frames up to 7.5K in size. 216