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, 2003
  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, including
  47 the following:
  48 .Pp
  49 .Bl -bullet -compact
  50 .It
  51 Alloy Computer Products EtherGOLD 1439E 10/100 (8139C+)
  52 .It
  53 Compaq Evo N1015v Integrated Ethernet (8139C+)
  54 .It
  55 Gigabyte 7N400 Pro2 Integrated Gigabit Ethernet (8110S)
  56 .It
  57 PLANEX COMMUNICATIONS Inc.\& GN-1200TC (8169S)
  58 .It
  59 Xterasys XN-152 10/100/1000 NIC (8169)
  60 .El
  61 .Pp
  62 NICs based on the 8139C+ are capable of 10 and 100Mbps speeds over CAT5
  63 cable.
  64 NICs based on the 8169, 8169S and 8110S are capable of 10, 100 and
  65 1000Mbps operation.
  66 .Pp
  67 All NICs supported by the
  68 .Nm
  69 driver have TCP/IP checksum offload and hardware VLAN tagging/insertion
  70 features, and use a descriptor-based DMA mechanism.
  71 They are also
  72 capable of TCP large send (TCP segmentation offload).
  73 .Pp
  74 The 8139C+ is a single-chip solution combining both a 10/100 MAC and PHY.
  75 The 8169 is a 10/100/1000 MAC only, requiring a GMII or TBI external PHY.
  76 The 8169S and 8110S are single-chip devices containing both a 10/100/1000
  77 MAC and 10/100/1000 copper PHY.
  78 Standalone 10/100/1000 cards are available
  79 in both 32-bit PCI and 64-bit PCI models.
  80 The 8110S is designed for
  81 embedded LAN-on-motherboard applications.
  82 .Pp
  83 The 8169, 8169S and 8110S also support jumbo frames, which can be configured
  84 via the interface MTU setting.
  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 DIAGNOSTICS
 145 .Bl -diag
 146 .It "re%d: couldn't map memory"
 147 A fatal initialization error has occurred.
 148 .It "re%d: couldn't map ports"
 149 A fatal initialization error has occurred.
 150 .It "re%d: couldn't map interrupt"
 151 A fatal initialization error has occurred.
 152 .It "re%d: no memory for softc struct!"
 153 The driver failed to allocate memory for per-device instance information
 154 during initialization.
 155 .It "re%d: failed to enable memory mapping!"
 156 The driver failed to initialize PCI shared memory mapping.
 157 This might
 158 happen if the card is not in a bus-master slot.
 159 .It "re%d: no memory for jumbo buffers!"
 160 The driver failed to allocate memory for jumbo frames during
 161 initialization.
 162 .It "re%d: watchdog timeout"
 163 The device has stopped responding to the network, or there is a problem with
 164 the network connection (cable).
 165 .El
 166 .Sh SEE ALSO
 167 .Xr arp 4 ,
 168 .Xr miibus 4 ,
 169 .Xr netintro 4 ,
 170 .Xr ng_ether 4 ,
 171 .Xr vlan 4 ,
 172 .Xr ifconfig 8
 173 .Rs
 174 .%T RealTek Semiconductor RTL8139C+, RTL8169, RTL8169S and RTL8110S datasheets
 175 .%O http://www.realtek.com.tw/
 176 .Re
 177 .Sh HISTORY
 178 The
 179 .Nm
 180 device driver first appeared in
 181 .Fx 5.2 .
 182 .Sh AUTHORS
 183 The
 184 .Nm
 185 driver was written by
 186 .An Bill Paul Aq wpaul@windriver.com .
 187 .Sh BUGS
 188 The Xterasys XN-152 32-bit PCI NIC, which uses the RTL8169 MAC and
 189 Marvell 88E1000 PHY, has a defect that causes DMA corruption
 190 if the board is plugged into a 64-bit PCI slot.
 191 The defect
 192 lies in the board design, not the chip itself: the PCI REQ64# and ACK64#
 193 lines should be pulled high, but they are not.
 194 The result is that the
 195 8169 chip is tricked into performing 64-bit DMA transfers even though
 196 a 64-bit data path between the NIC and the bus does not actually exist.
 197 .Pp
 198 Unfortunately, it is not possible to correct this problem in software,
 199 however it is possible to detect it.
 200 When the
 201 .Nm
 202 driver is loaded, it will run a diagnostic routine designed to
 203 validate DMA operation by placing the chip in digital loopback mode
 204 and initiating a packet transmission.
 205 If the card functions properly,
 206 the transmitted data will
 207 be echoed back unmodified.
 208 If the echoed data is corrupt, the driver
 209 will print an error message on the console and abort the device attach.
 210 The
 211 user should insure the NIC is installed in a 32-bit PCI slot to
 212 avoid this problem.
 213 .Pp
 214 The RealTek 8169, 8169S and 8110S chips appear to only be capable of
 215 transmitting jumbo frames up to 7.5K in size.