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