share/man/man4/re.4

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