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: src/share/man/man4/rl.4,v 1.15.2.8 2003/02/17 21:20:39 trhodes Exp $
  32 .\" $DragonFly: src/share/man/man4/rl.4,v 1.3 2004/03/11 12:28:55 hmp Exp $
  33 .\"
  34 .Dd November 4, 1998
  35 .Dt RL 4
  36 .Os
  37 .Sh NAME
  38 .Nm rl
  39 .Nd RealTek 8129/8139 fast ethernet device driver
  40 .Sh SYNOPSIS
  41 .Cd "device rl"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for PCI ethernet adapters and embedded
  46 controllers based on the RealTek 8129 and 8139 fast ethernet controller
  47 chips.
  48 This includes the Allied Telesyn AT2550, Farallon NetLINE 10/100 PCI,
  49 Genius GF100TXR,
  50 NDC Communications NE100TX-E, OvisLink LEF-8129TX, OvisLink LEF-8139TX,
  51 Netronix Inc. EA-1210 NetEther 10/100, KTX-9130TX 10/100 Fast Ethernet,
  52 Encore ENL832-TX 10/100 M PCI, Longshine LCS-8038TX-R, the
  53 SMC EZ Card 10/100 PCI 1211-TX, and various other cheap adapters.
  54 It also supports the Accton EN1207D which has a
  55 chip labeled MPX5030 (or MPX5038) which appears to be a RealTek workalike.
  56 .Pp
  57 The RealTek controllers use bus master DMA but do not use a
  58 descriptor-based data transfer mechanism.
  59 The receiver uses a
  60 single fixed size ring buffer from which packets must be copied
  61 into mbufs.
  62 For transmission, there are only four outbound packet
  63 address registers which require all outgoing packets to be stored
  64 as contiguous buffers.
  65 Furthermore, outbound packet buffers must
  66 be longword aligned or else transmission will fail.
  67 .Pp
  68 The 8129 differs from the 8139 in that the 8139 has an internal
  69 PHY which is controlled through special direct access registers
  70 whereas the 8129 uses an external PHY via an MII bus.
  71 The 8139
  72 supports both 10 and 100Mbps speeds in either full or half duplex.
  73 The 8129 can support the same speeds and modes given an appropriate
  74 PHY chip.
  75 .Pp
  76 The
  77 .Nm
  78 driver supports the following media types:
  79 .Pp
  80 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  81 .It autoselect
  82 Enable autoselection of the media type and options.
  83 This is only
  84 supported if the PHY chip attached to the RealTek controller
  85 supports NWAY autonegotiation.
  86 The user can manually override
  87 the autoselected mode by adding media options to the
  88 .Pa /etc/rc.conf
  89 file.
  90 .It 10baseT/UTP
  91 Set 10Mbps operation.
  92 The
  93 .Ar mediaopt
  94 option can also be used to select either
  95 .Ar full-duplex
  96 or
  97 .Ar half-duplex
  98 modes.
  99 .It 100baseTX
 100 Set 100Mbps (fast ethernet) operation.
 101 The
 102 .Ar mediaopt
 103 option can also be used to select either
 104 .Ar full-duplex
 105 or
 106 .Ar half-duplex
 107 modes.
 108 .El
 109 .Pp
 110 The
 111 .Nm
 112 driver supports the following media options:
 113 .Pp
 114 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 115 .It full-duplex
 116 Force full duplex operation
 117 .It half-duplex
 118 Force half duplex operation.
 119 .El
 120 .Pp
 121 Note that the 100baseTX media type is only available if supported
 122 by the adapter.
 123 For more information on configuring this device, see
 124 .Xr ifconfig 8 .
 125 .Sh DIAGNOSTICS
 126 .Bl -diag
 127 .It "rl%d: couldn't map memory"
 128 A fatal initialization error has occurred.
 129 .It "rl%d: couldn't map interrupt"
 130 A fatal initialization error has occurred.
 131 .It "rl%d: watchdog timeout"
 132 The device has stopped responding to the network, or there is a problem with
 133 the network connection (cable).
 134 .It "rl%d: no memory for rx list"
 135 The driver failed to allocate an mbuf for the receiver ring.
 136 .It "rl%d: no memory for tx list"
 137 The driver failed to allocate an mbuf for the transmitter ring when
 138 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 139 .It "rl%d: chip is in D3 power state -- setting to D0"
 140 This message applies only to adapters which support power
 141 management.
 142 Some operating systems place the controller in low power
 143 mode when shutting down, and some PCI BIOSes fail to bring the chip
 144 out of this state before configuring it.
 145 The controller loses all of
 146 its PCI configuration in the D3 state, so if the BIOS does not set
 147 it back to full power mode in time, it won't be able to configure it
 148 correctly.
 149 The driver tries to detect this condition and bring
 150 the adapter back to the D0 (full power) state, but this may not be
 151 enough to return the driver to a fully operational condition.
 152 If
 153 you see this message at boot time and the driver fails to attach
 154 the device as a network interface, you will have to perform second
 155 warm boot to have the device properly configured.
 156 .Pp
 157 Note that this condition only occurs when warm booting from another
 158 operating system.
 159 If you power down your system prior to booting
 160 .Dx ,
 161 the card should be configured correctly.
 162 .El
 163 .Sh SEE ALSO
 164 .Xr arp 4 ,
 165 .Xr miibus 4 ,
 166 .Xr netintro 4 ,
 167 .Xr ng_ether 4 ,
 168 .Xr ifconfig 8
 169 .Rs
 170 .%B The RealTek 8129 and 8139 datasheets
 171 .%O ftp.realtek.com.tw:/lancard/data sheet
 172 .Re
 173 .Sh HISTORY
 174 The
 175 .Nm
 176 device driver first appeared in
 177 .Fx 3.0 .
 178 .Sh AUTHORS
 179 The
 180 .Nm
 181 driver was written by
 182 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 183 .Sh BUGS
 184 Since outbound packets must be longword aligned, the transmit
 185 routine has to copy an unaligned packet into an mbuf cluster buffer
 186 before transmission.
 187 The driver abuses the fact that the cluster buffer
 188 pool is allocated at system startup time in a contiguous region starting
 189 at a page boundary.
 190 Since cluster buffers are 2048 bytes, they are
 191 longword aligned by definition.
 192 The driver probably should not be
 193 depending on this characteristic.
 194 .Pp
 195 The RealTek data sheets are of especially poor quality,
 196 and there is a lot of information missing
 197 particularly concerning the receiver operation.
 198 One particularly
 199 important fact that the data sheets fail to mention relates to the
 200 way in which the chip fills in the receive buffer.
 201 When an interrupt
 202 is posted to signal that a frame has been received, it is possible that
 203 another frame might be in the process of being copied into the receive
 204 buffer while the driver is busy handling the first one.
 205 If the driver
 206 manages to finish processing the first frame before the chip is done
 207 DMAing the rest of the next frame, the driver may attempt to process
 208 the next frame in the buffer before the chip has had a chance to finish
 209 DMAing all of it.
 210 .Pp
 211 The driver can check for an incomplete frame by inspecting the frame
 212 length in the header preceding the actual packet data: an incomplete
 213 frame will have the magic length of 0xFFF0.
 214 When the driver encounters
 215 this value, it knows that it has finished processing all currently
 216 available packets.
 217 Neither this magic value nor its significance are
 218 documented anywhere in the RealTek data sheets.