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 January 26, 2011
  34 .Dt RE 4
  35 .Os
  36 .Sh NAME
  37 .Nm re
  38 .Nd "RealTek 8139C+/8169/816xS/811xS/8168/810xE/8111 PCI/PCIe 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, RTL816xS, RTL811xS, RTL8168, RTL810xE and RTL8111 PCI and
  59 PCIe Ethernet controllers.
  60 .Pp
  61 NICs based on the 8139C+ and 810xE are capable of 10 and 100Mbps speeds
  62 over CAT5 cable.
  63 NICs based on the 8169, 816xS, 811xS, 8168 and 8111 are capable of 10, 100
  64 and 1000Mbps operation.
  65 .Pp
  66 All NICs supported by the
  67 .Nm
  68 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
  69 features, and use a descriptor-based DMA mechanism.
  70 They are also
  71 capable of TCP large send (TCP segmentation offload).
  72 .Pp
  73 The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
  74 The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
  75 The 816xS, 811xS, 8168 and 8111 are single-chip devices containing both a
  76 10/100/1000 MAC and 10/100/1000 copper PHY.
  77 Standalone 10/100/1000 cards are available
  78 in both 32-bit PCI and 64-bit PCI models.
  79 The 8110S is designed for
  80 embedded LAN-on-motherboard applications.
  81 .Pp
  82 The 8169, 8169S and 8110S also support jumbo frames, which can be configured
  83 via the interface MTU setting.
  84 The MTU is limited to 7422, since the chip cannot transmit larger frames.
  85 Selecting an MTU larger than 1500 bytes with the
  86 .Xr ifconfig 8
  87 utility configures the adapter to receive and transmit jumbo frames.
  88 .Pp
  89 The
  90 .Nm
  91 driver supports the following media types:
  92 .Bl -tag -width ".Cm 10baseT/UTP"
  93 .It Cm autoselect
  94 Enable autoselection of the media type and options.
  95 The user can manually override
  96 the autoselected mode by adding media options to
  97 .Xr rc.conf 5 .
  98 .It Cm 10baseT/UTP
  99 Set 10Mbps operation.
 100 The
 101 .Xr ifconfig 8
 102 .Cm mediaopt
 103 option can also be used to select either
 104 .Cm full-duplex
 105 or
 106 .Cm half-duplex
 107 modes.
 108 .It Cm 100baseTX
 109 Set 100Mbps (Fast Ethernet) operation.
 110 The
 111 .Xr ifconfig 8
 112 .Cm mediaopt
 113 option can also be used to select either
 114 .Cm full-duplex
 115 or
 116 .Cm half-duplex
 117 modes.
 118 .It Cm 1000baseTX
 119 Set 1000baseTX operation over twisted pair.
 120 The RealTek gigE chips support 1000Mbps in
 121 .Cm full-duplex
 122 mode only.
 123 .\" .It Cm 1000baseSX
 124 .\" Set 1000Mbps (Gigabit Ethernet) operation.
 125 .\" Both
 126 .\" .Cm full-duplex
 127 .\" and
 128 .\" .Cm half-duplex
 129 .\" modes are supported.
 130 .El
 131 .Pp
 132 The
 133 .Nm
 134 driver supports the following media options:
 135 .Bl -tag -width ".Cm full-duplex"
 136 .It Cm full-duplex
 137 Force full duplex operation.
 138 .It Cm half-duplex
 139 Force half duplex operation.
 140 .El
 141 .Pp
 142 For more information on configuring this device, see
 143 .Xr ifconfig 8 .
 144 .Sh HARDWARE
 145 The
 146 .Nm
 147 driver supports RealTek RTL8139C+, RTL8169, RTL816xS, RTL811xS, RTL8168,
 148 RTL810xE and RTL8111 based Fast Ethernet and Gigabit Ethernet adapters including:
 149 .Pp
 150 .Bl -bullet -compact
 151 .It
 152 Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
 153 .It
 154 Compaq Evo N1015v Integrated Ethernet (8139C+)
 155 .It
 156 Corega CG-LAPCIGT Gigabit Ethernet (8169S)
 157 .It
 158 D-Link DGE-528(T) Gigabit Ethernet (8169S)
 159 .It
 160 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
 161 .It
 162 LevelOne GNC-0105T (8169S)
 163 .It
 164 LinkSys EG1032 (32-bit PCI)
 165 .It
 166 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
 167 .It
 168 USRobotics USR997902 Gigabit Ethernet (8169S)
 169 .It
 170 Xterasys XN-152 10/100/1000 NIC (8169)
 171 .El
 172 .Sh LOADER TUNABLES
 173 Tunables can be set at the
 174 .Xr loader 8
 175 prompt before booting the kernel or stored in
 176 .Xr loader.conf 5 .
 177 .Bl -tag -width "xxxxxx"
 178 .It Va hw.re.intr_filter
 179 This tunable makes driver use interrupt filter handler on
 180 controllers that support MSI/MSI-X capability.
 181 If MSI/MSI-X is disabled by administrator this tunable has no
 182 effect and driver will use interrupt filter handler.
 183 The default value is 0 to use interrupt thread handler.
 184 .It Va hw.re.msi_disable
 185 This tunable disables MSI support on the Ethernet hardware.
 186 The default value is 0.
 187 .It Va hw.re.msix_disable
 188 This tunable disables MSI-X support on the Ethernet hardware.
 189 The default value is 0.
 190 .It Va hw.re.prefer_iomap
 191 This tunable controls which register mapping should be used on the
 192 specified device.
 193 A non-zero value enables I/O space register mapping.
 194 The default value is 0 to use memory space register mapping.
 195 .El
 196 .Sh SYSCTL VARIABLES
 197 The following variables are available as both
 198 .Xr sysctl 8
 199 variables and
 200 .Xr loader 8
 201 tunables:
 202 .Bl -tag -width "xxxxxx"
 203 .It Va dev.re.%d.int_rx_mod
 204 Maximum amount of time to delay receive interrupt processing in
 205 units of 1us.
 206 The accepted range is 0 to 65, the default is 65(65us).
 207 Value 0 completely disables the interrupt moderation.
 208 The interface need to be brought down and up again before a change
 209 takes effect.
 210 .El
 211 .Sh DIAGNOSTICS
 212 .Bl -diag
 213 .It "re%d: couldn't map memory"
 214 A fatal initialization error has occurred.
 215 .It "re%d: couldn't map ports"
 216 A fatal initialization error has occurred.
 217 .It "re%d: couldn't map interrupt"
 218 A fatal initialization error has occurred.
 219 .It "re%d: no memory for softc struct!"
 220 The driver failed to allocate memory for per-device instance information
 221 during initialization.
 222 .It "re%d: failed to enable memory mapping!"
 223 The driver failed to initialize PCI shared memory mapping.
 224 This might
 225 happen if the card is not in a bus-master slot.
 226 .It "re%d: no memory for jumbo buffers!"
 227 The driver failed to allocate memory for jumbo frames during
 228 initialization.
 229 .It "re%d: watchdog timeout"
 230 The device has stopped responding to the network, or there is a problem with
 231 the network connection (cable).
 232 .El
 233 .Sh SEE ALSO
 234 .Xr altq 4 ,
 235 .Xr arp 4 ,
 236 .Xr miibus 4 ,
 237 .Xr netintro 4 ,
 238 .Xr ng_ether 4 ,
 239 .Xr polling 4 ,
 240 .Xr rgephy 4 ,
 241 .Xr vlan 4 ,
 242 .Xr ifconfig 8
 243 .Rs
 244 .%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
 245 .%U http://www.realtek.com.tw/
 246 .Re
 247 .Sh HISTORY
 248 The
 249 .Nm
 250 device driver first appeared in
 251 .Fx 5.2 .
 252 .Sh AUTHORS
 253 The
 254 .Nm
 255 driver was written by
 256 .An Bill Paul Aq wpaul@windriver.com .
 257 .Sh BUGS
 258 The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
 259 Marvell 88E1000 PHY, has a defect that causes DMA corruption
 260 if the board is plugged into a 64-bit PCI slot.
 261 The defect
 262 lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
 263 lines should be pulled high, but they are not.
 264 The result is that the
 265 8169 chip is tricked into performing 64-bit DMA transfers even though
 266 a 64-bit data path between the NIC and the bus does not actually exist.
 267 .Pp
 268 Unfortunately, it is not possible to correct this problem in software,
 269 however it is possible to detect it.
 270 When the
 271 .Nm
 272 driver is loaded, it will run a diagnostic routine designed to
 273 validate DMA operation by placing the chip in digital loopback mode
 274 and initiating a packet transmission.
 275 If the card functions properly,
 276 the transmitted data will
 277 be echoed back unmodified.
 278 If the echoed data is corrupt, the driver
 279 will print an error message on the console and abort the device attach.
 280 The
 281 user should ensure the NIC is installed in a 32-bit PCI slot to
 282 avoid this problem.
 283 .Pp
 284 The RealTek 8169, 8169S and 8110S chips appear to only be capable of
 285 transmitting jumbo frames up to 7.5K in size.