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