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