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