share/man/man4/rl.4

   1 .\" Copyright (c) 1997, 1998
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu>. 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 28, 2007
  34 .Dt RL 4
  35 .Os
  36 .Sh NAME
  37 .Nm rl
  38 .Nd "RealTek 8129/8139 Fast Ethernet device 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 rl"
  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_rl_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Ethernet adapters and embedded
  58 controllers based on the RealTek 8129 and 8139 Fast Ethernet controller
  59 chips.
  60 .Pp
  61 The RealTek 8129/8139 series controllers use bus master DMA but do not use a
  62 descriptor-based data transfer mechanism.
  63 The receiver uses a
  64 single fixed size ring buffer from which packets must be copied
  65 into mbufs.
  66 For transmission, there are only four outbound packet
  67 address registers which require all outgoing packets to be stored
  68 as contiguous buffers.
  69 Furthermore, outbound packet buffers must
  70 be longword aligned or else transmission will fail.
  71 .Pp
  72 The 8129 differs from the 8139 in that the 8139 has an internal
  73 PHY which is controlled through special direct access registers
  74 whereas the 8129 uses an external PHY via an MII bus.
  75 The 8139
  76 supports both 10 and 100Mbps speeds in either full or half duplex.
  77 The 8129 can support the same speeds and modes given an appropriate
  78 PHY chip.
  79 .Pp
  80 Note: support for the 8139C+ chip is provided by the
  81 .Xr re 4
  82 driver.
  83 .Pp
  84 The
  85 .Nm
  86 driver supports the following media types:
  87 .Pp
  88 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  89 .It autoselect
  90 Enable autoselection of the media type and options.
  91 This is only
  92 supported if the PHY chip attached to the RealTek controller
  93 supports NWAY autonegotiation.
  94 The user can manually override
  95 the autoselected mode by adding media options to the
  96 .Pa /etc/rc.conf
  97 file.
  98 .It 10baseT/UTP
  99 Set 10Mbps operation.
 100 The
 101 .Ar mediaopt
 102 option can also be used to select either
 103 .Ar full-duplex
 104 or
 105 .Ar half-duplex
 106 modes.
 107 .It 100baseTX
 108 Set 100Mbps (Fast Ethernet) operation.
 109 The
 110 .Ar mediaopt
 111 option can also be used to select either
 112 .Ar full-duplex
 113 or
 114 .Ar half-duplex
 115 modes.
 116 .El
 117 .Pp
 118 The
 119 .Nm
 120 driver supports the following media options:
 121 .Pp
 122 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 123 .It full-duplex
 124 Force full duplex operation
 125 .It half-duplex
 126 Force half duplex operation.
 127 .El
 128 .Pp
 129 Note that the 100baseTX media type is only available if supported
 130 by the adapter.
 131 For more information on configuring this device, see
 132 .Xr ifconfig 8 .
 133 .Sh HARDWARE
 134 Adapters supported by the
 135 .Nm
 136 driver include:
 137 .Pp
 138 .Bl -bullet -compact
 139 .It
 140 Accton
 141 .Dq Cheetah
 142 EN1207D (MPX 5030/5038; RealTek 8139 clone)
 143 .It
 144 Allied Telesyn AT2550
 145 .It
 146 Allied Telesyn AT2500TX
 147 .It
 148 Belkin F5D5000
 149 .It
 150 BUFFALO (Melco INC.) LPC-CB-CLX (CardBus)
 151 .It
 152 Compaq HNE-300
 153 .It
 154 CompUSA no-name 10/100 PCI Ethernet NIC
 155 .It
 156 Corega FEther CB-TXD
 157 .It
 158 Corega FEtherII CB-TXD
 159 .It
 160 D-Link DFE-528TX
 161 .It
 162 D-Link DFE-530TX+
 163 .It
 164 D-Link DFE-538TX
 165 .It
 166 D-Link DFE-690TXD
 167 .It
 168 Edimax EP-4103DL CardBus
 169 .It
 170 Encore ENL832-TX 10/100 M PCI
 171 .It
 172 Farallon NetLINE 10/100 PCI
 173 .It
 174 Genius GF100TXR
 175 .It
 176 GigaFast Ethernet EE100-AXP
 177 .It
 178 KTX-9130TX 10/100 Fast Ethernet
 179 .It
 180 LevelOne FPC-0106TX
 181 .It
 182 Longshine LCS-8038TX-R
 183 .It
 184 NDC Communications NE100TX-E
 185 .It
 186 Netronix Inc.\& EA-1210 NetEther 10/100
 187 .It
 188 Nortel Networks 10/100BaseTX
 189 .It
 190 OvisLink LEF-8129TX
 191 .It
 192 OvisLink LEF-8139TX
 193 .It
 194 Peppercon AG ROL-F
 195 .It
 196 Planex FNW-3603-TX
 197 .It
 198 Planex FNW-3800-TX
 199 .It
 200 SMC EZ Card 10/100 PCI 1211-TX
 201 .It
 202 SOHO (PRAGMATIC) UE-1211C
 203 .El
 204 .Sh DIAGNOSTICS
 205 .Bl -diag
 206 .It "rl%d: couldn't map memory"
 207 A fatal initialization error has occurred.
 208 .It "rl%d: couldn't map interrupt"
 209 A fatal initialization error has occurred.
 210 .It "rl%d: watchdog timeout"
 211 The device has stopped responding to the network, or there is a problem with
 212 the network connection (cable).
 213 .It "rl%d: no memory for rx list"
 214 The driver failed to allocate an mbuf for the receiver ring.
 215 .It "rl%d: no memory for tx list"
 216 The driver failed to allocate an mbuf for the transmitter ring when
 217 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 218 .It "rl%d: chip is in D3 power state -- setting to D0"
 219 This message applies only to adapters which support power
 220 management.
 221 Some operating systems place the controller in low power
 222 mode when shutting down, and some PCI BIOSes fail to bring the chip
 223 out of this state before configuring it.
 224 The controller loses all of
 225 its PCI configuration in the D3 state, so if the BIOS does not set
 226 it back to full power mode in time, it will not be able to configure it
 227 correctly.
 228 The driver tries to detect this condition and bring
 229 the adapter back to the D0 (full power) state, but this may not be
 230 enough to return the driver to a fully operational condition.
 231 If
 232 you see this message at boot time and the driver fails to attach
 233 the device as a network interface, you will have to perform second
 234 warm boot to have the device properly configured.
 235 .Pp
 236 Note that this condition only occurs when warm booting from another
 237 operating system.
 238 If you power down your system prior to booting
 239 .Fx ,
 240 the card should be configured correctly.
 241 .El
 242 .Sh SEE ALSO
 243 .Xr altq 4 ,
 244 .Xr arp 4 ,
 245 .Xr miibus 4 ,
 246 .Xr netintro 4 ,
 247 .Xr ng_ether 4 ,
 248 .Xr polling 4 ,
 249 .Xr ifconfig 8
 250 .Rs
 251 .%B The RealTek 8129, 8139 and 8139C+ datasheets
 252 .%O http://www.realtek.com.tw
 253 .Re
 254 .Sh HISTORY
 255 The
 256 .Nm
 257 device driver first appeared in
 258 .Fx 3.0 .
 259 .Sh AUTHORS
 260 The
 261 .Nm
 262 driver was written by
 263 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 264 .Sh BUGS
 265 Since outbound packets must be longword aligned, the transmit
 266 routine has to copy an unaligned packet into an mbuf cluster buffer
 267 before transmission.
 268 The driver abuses the fact that the cluster buffer
 269 pool is allocated at system startup time in a contiguous region starting
 270 at a page boundary.
 271 Since cluster buffers are 2048 bytes, they are
 272 longword aligned by definition.
 273 The driver probably should not be
 274 depending on this characteristic.
 275 .Pp
 276 The RealTek data sheets are of especially poor quality,
 277 and there is a lot of information missing
 278 particularly concerning the receiver operation.
 279 One particularly
 280 important fact that the data sheets fail to mention relates to the
 281 way in which the chip fills in the receive buffer.
 282 When an interrupt
 283 is posted to signal that a frame has been received, it is possible that
 284 another frame might be in the process of being copied into the receive
 285 buffer while the driver is busy handling the first one.
 286 If the driver
 287 manages to finish processing the first frame before the chip is done
 288 DMAing the rest of the next frame, the driver may attempt to process
 289 the next frame in the buffer before the chip has had a chance to finish
 290 DMAing all of it.
 291 .Pp
 292 The driver can check for an incomplete frame by inspecting the frame
 293 length in the header preceding the actual packet data: an incomplete
 294 frame will have the magic length of 0xFFF0.
 295 When the driver encounters
 296 this value, it knows that it has finished processing all currently
 297 available packets.
 298 Neither this magic value nor its significance are
 299 documented anywhere in the RealTek data sheets.