share/man/man4/re.4

   1 .\" Copyright (c) 2003
   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 .\" $DragonFly: src/share/man/man4/re.4,v 1.6 2008/03/16 15:50:22 hasso Exp $
  33 .\"
  34 .Dd November 2, 2006
  35 .Dt RE 4
  36 .Os
  37 .Sh NAME
  38 .Nm re
  39 .Nd "RealTek 8139C+/8169/816xS/811xS/8101E PCI/PCIe Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 .Cd "device miibus"
  42 .Cd "device re"
  43 .Pp
  44 Alternatively, to load the driver as a module at boot time, place the
  45 following line in
  46 .Pa /boot/loader.conf :
  47 .Bd -literal -offset indent
  48 if_re_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for various NICs based on the RealTek
  54 RTL8139C+, RTL8169, RTL8169S, RTL8110S, RTL8168S, RTL8111S and RTL8101E
  55 PCI and PCIe ethernet controllers.
  56 .Pp
  57 NICs based on the
  58 8139C+ and 8101E
  59 are capable of 10 and 100Mbps speeds over CAT5 cable.
  60 NICs based on the
  61 8169, 816xS and 811xS
  62 are capable of 10, 100 and 1000Mbps operation.
  63 .Pp
  64 All NICs supported by the
  65 .Nm
  66 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
  67 features, and use a descriptor-based DMA mechanism. They are also
  68 capable of TCP large send (TCP segmentation offload).
  69 .Pp
  70 The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
  71 The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
  72 The 8169S and 8110S are single-chip devices containing both a 10/100/1000
  73 MAC and 10/100/1000 copper PHY. Standalone 10/100/1000 cards are available
  74 in both 32-bit PCI and 64-bit PCI models. The 8110S is designed for
  75 embedded LAN-on-motherboard applications.
  76 .Pp
  77 The 8169, 8169S and 8110S also support jumbo frames, which can be configured
  78 via the interface MTU setting.
  79 Selecting an MTU larger than 1500 bytes with the
  80 .Xr ifconfig 8
  81 utility configures the adapter to receive and transmit jumbo frames.
  82 .Pp
  83 The
  84 .Nm
  85 driver supports the following media types:
  86 .Bl -tag -width 10baseTXUTP
  87 .It Cm autoselect
  88 Enable autoselection of the media type and options.
  89 The user can manually override
  90 the autoselected mode by adding media options to
  91 .Xr rc.conf 5 .
  92 .It Cm 10baseT/UTP
  93 Set 10Mbps operation.
  94 The
  95 .Xr ifconfig 8
  96 .Ic mediaopt
  97 option can also be used to select either
  98 .Cm full-duplex
  99 or
 100 .Cm half-duplex
 101 modes.
 102 .It Cm 100baseTX
 103 Set 100Mbps (fast ethernet) operation.
 104 The
 105 .Xr ifconfig 8
 106 .Ic mediaopt
 107 option can also be used to select either
 108 .Cm full-duplex
 109 or
 110 .Cm half-duplex
 111 modes.
 112 .It Cm 1000baseT
 113 Set 1000baseT operation over twisted pair.
 114 The RealTek gigE chips support 1000Mbps in
 115 .Cm full-duplex
 116 mode only.
 117 .\" .It Cm 1000baseSX
 118 .\" Set 1000Mbps (gigabit ethernet) operation.
 119 .\" Both
 120 .\" .Cm full-duplex
 121 .\" and
 122 .\" .Cm half-duplex
 123 .\" modes are supported.
 124 .El
 125 .Pp
 126 The
 127 .Nm
 128 driver supports the following media options:
 129 .Bl -tag -width full-duplex
 130 .It Cm full-duplex
 131 Force full duplex operation.
 132 .It Cm half-duplex
 133 Force half duplex operation.
 134 .El
 135 .Pp
 136 For more information on configuring this device, see
 137 .Xr ifconfig 8 .
 138 .Ss MIB Variables
 139 A number of per-interface variables are implemented in the
 140 .Va hw.re Ns Em X
 141 branch of the
 142 .Xr sysctl 3
 143 MIB.
 144 .Bl -tag -width ".Va tx_moderation"
 145 .It Va tx_moderation
 146 Turn on (default) or off TX moderation.
 147 .El
 148 .Sh HARDWARE
 149 The
 150 .Nm
 151 driver supports RealTek RTL8139C+, RTL8169, RTL816xS, RTL811xS,
 152 and RTL8101E based Fast Ethernet and Gigabit Ethernet adapters including:
 153 .Pp
 154 .Bl -bullet -compact
 155 .It
 156 Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
 157 .It
 158 Compaq Evo N1015v Integrated Ethernet (8139C+)
 159 .It
 160 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
 161 .It
 162 D-Link DGE-528(T) Gigabit Ethernet (8169S)
 163 .It
 164 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
 165 .It
 166 LevelOne GNC-0105T (8169S)
 167 .It
 168 LinkSys EG1032 (32-bit PCI)
 169 .It
 170 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
 171 .It
 172 Xterasys XN-152 10/100/1000 NIC (8169)
 173 .El
 174 .Sh DIAGNOSTICS
 175 .Bl -diag
 176 .It "re%d: couldn't map ports"
 177 A fatal initialization error has occurred.
 178 .It "re%d: couldn't map interrupt"
 179 A fatal initialization error has occurred.
 180 .It "re%d: watchdog timeout"
 181 The device has stopped responding to the network, or there is a problem with
 182 the network connection (cable).
 183 .El
 184 .Sh SEE ALSO
 185 .Xr arp 4 ,
 186 .Xr ifmedia 4 ,
 187 .Xr miibus 4 ,
 188 .Xr netintro 4 ,
 189 .Xr ng_ether 4 ,
 190 .Xr polling 4 ,
 191 .Xr vlan 4 ,
 192 .Xr ifconfig 8
 193 .Rs
 194 .%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
 195 .%O http://www.realtek.com.tw
 196 .Re
 197 .Sh HISTORY
 198 The
 199 .Nm
 200 device driver first appeared in
 201 .Fx 5.2
 202 and
 203 .Dx 1.0 .
 204 .Sh AUTHORS
 205 The
 206 .Nm
 207 driver was written by
 208 .An Bill Paul Aq wpaul@windriver.com .
 209 .Sh BUGS
 210 The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
 211 Marvell 88E1000 PHY, has a defect that causes DMA corruption
 212 if the board is plugged into a 64-bit PCI slot. The defect
 213 lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
 214 lines should be pulled high, but they are not. The result is that the
 215 8169 chip is tricked into performing 64-bit DMA transfers even though
 216 a 64-bit data path between the NIC and the bus does not actually exist.
 217 .Pp
 218 Unfortunately, it is not possible to correct this problem in software,
 219 however it is possible to detect it. When the
 220 .Nm
 221 driver is loaded, it will run a diagnostic routine designed to
 222 validate DMA operation by placing the chip in digital loopback mode
 223 and initiating a packet transmission. If the card functions properly,
 224 the transmitted data will
 225 be echoed back unmodified. If the echoed data is corrupt, the driver
 226 will print an error message on the console and abort the device attach. The
 227 user should insure the NIC is installed in a 32-bit PCI slot to
 228 avoid this problem.
 229 .Pp
 230 The RealTek 8169, 8169S and 8110S chips appear to only be capable of
 231 transmitting jumbo frames up to 7440 bytes in size.