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