share/man/man4/dc.4

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ee.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/dc.4,v 1.6.2.9 2003/02/17 21:20:39 trhodes Exp $
  32 .\"
  33 .Dd November 20, 1999
  34 .Dt DC 4
  35 .Os
  36 .Sh NAME
  37 .Nm dc
  38 .Nd "DEC/Intel 21143 and clone 10/100 ethernet driver"
  39 .Sh SYNOPSIS
  40 .Cd "device miibus"
  41 .Cd "device dc"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for several PCI fast ethernet adapters and
  46 embedded controllers based on the following chipsets:
  47 .Pp
  48 .Bl -bullet -compact -offset indent
  49 .It
  50 DEC/Intel 21143
  51 .It
  52 Macronix 98713, 98713A, 98715, 98715A and 98725
  53 .It
  54 Davicom DM9100, DM9102 and DM9102A
  55 .It
  56 ASIX Electronics AX88140A and AX88141
  57 .It
  58 ADMtek AL981 Comet and AN985 Centaur
  59 .It
  60 Lite-On 82c168 and 82c169 PNIC
  61 .It
  62 Lite-On/Macronix 82c115 PNIC II
  63 .It
  64 Conexant LANfinity RS7112 (miniPCI)
  65 .El
  66 .Pp
  67 All of these chips have the same general register layout, DMA
  68 descriptor format and method of operation.
  69 All of the clone chips
  70 are based on the 21143 design with various modifications.
  71 The
  72 21143 itself has support for 10baseT, BNC, AUI, MII and symbol
  73 media attachments, 10 and 100Mbps speeds in full or half duplex,
  74 built in NWAY autonegotiation and wake on LAN.
  75 The 21143 also
  76 offers several receive filter programming options including
  77 perfect filtering, inverse perfect filtering and hash table
  78 filtering.
  79 .Pp
  80 Some clone chips duplicate the 21143 fairly closely while others
  81 only maintain superficial similarities.
  82 Some support only MII
  83 media attachments.
  84 Others use different receiver filter programming
  85 mechanisms.
  86 At least one supports only chained DMA descriptors
  87 (most support both chained descriptors and contiguously allocated
  88 fixed size rings). Some chips (especially the PNIC) also have
  89 peculiar bugs.
  90 The
  91 .Nm
  92 driver does its best to provide generalized support for all
  93 of these chipsets in order to keep special case code to a minimun.
  94 .Pp
  95 These chips are used by many vendors which makes it
  96 difficult to provide a complete list of all supported cards.
  97 The
  98 following NICs are known to work with the
  99 .Nm
 100 driver at this time:
 101 .Pp
 102 .Bl -bullet -compact -offset indent
 103 .It
 104 Digital DE500-BA 10/100 (21143, non-MII)
 105 .It
 106 Built in DE500-BA on DEC Alpha workstations (21143, non-MII)
 107 .It
 108 Built in 10Mbps only ethernet on Compaq Presario 7900 series
 109 desktops (21143, non-MII)
 110 .It
 111 Built in ethernet on LinkSys EtherFast 10/100 Instant GigaDrive (DM9102, MII)
 112 .It
 113 Kingston KNE100TX (21143, MII)
 114 .It
 115 D-Link DFE-570TX (21143, MII, quad port)
 116 .It
 117 NDC SOHOware SFA110 (98713A)
 118 .It
 119 SVEC PN102-TX (98713)
 120 .It
 121 CNet Pro120A (98715A or 98713A) and CNet Pro120B (98715)
 122 .It
 123 Compex RL100-TX (98713 or 98713A)
 124 .It
 125 LinkSys LNE100TX (PNIC 82c168, 82c169)
 126 .It
 127 NetGear FA310-TX Rev. D1, D2 or D3 (PNIC 82c169)
 128 .It
 129 Matrox FastNIC 10/100 (PNIC 82c168, 82c169)
 130 .It
 131 Kingston KNE110TX (PNIC 82c169)
 132 .It
 133 LinkSys LNE100TX v2.0 (PNIC II 82c115)
 134 .It
 135 Jaton XpressNet (Davicom DM9102)
 136 .It
 137 Alfa Inc GFC2204 (ASIX AX88140A)
 138 .It
 139 CNet Pro110B (ASIX AX88140A)
 140 .El
 141 .Pp
 142 The
 143 .Nm
 144 driver supports the following media types:
 145 .Pp
 146 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 147 .It autoselect
 148 Enable autoselection of the media type and options.
 149 The user can manually override
 150 the autoselected mode by adding media options to the
 151 .Pa /etc/rc.conf
 152 file.
 153 .Pp
 154 Note: the built-in NWAY autonegotiation on the original PNIC 82c168
 155 chip is horribly broken and is not supported by the
 156 .Nm
 157 driver at this time (see the
 158 .Sx BUGS
 159 section for details).
 160 The original 82c168 appears
 161 on very early revisions of the LinkSys LNE100TX and Matrox FastNIC.
 162 .It 10baseT/UTP
 163 Set 10Mbps operation.
 164 The
 165 .Ar mediaopt
 166 option can also be used to enable
 167 .Ar full-duplex
 168 operation.
 169 Not specifying
 170 .Ar full duplex
 171 implies
 172 .Ar half-duplex
 173 mode.
 174 .It 100baseTX
 175 Set 100Mbps (fast ethernet) operation.
 176 The
 177 .Ar mediaopt
 178 option can also be used to enable
 179 .Ar full-duplex
 180 operation.
 181 Not specifying
 182 .Ar full duplex
 183 implies
 184 .Ar half-duplex
 185 mode.
 186 .El
 187 .Pp
 188 The
 189 .Nm
 190 driver supports the following media options:
 191 .Pp
 192 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 193 .It full-duplex
 194 Force full duplex operation.
 195 The interface will operate in
 196 half duplex mode if this media option is not specified.
 197 .El
 198 .Pp
 199 Note that the 100baseTX media type may not be available on certain
 200 Intel 21143 adapters which support 10mbps media attachments only.
 201 For more information on configuring this device, see
 202 .Xr ifconfig 8 .
 203 .Sh DIAGNOSTICS
 204 .Bl -diag
 205 .It "dc%d: couldn't map ports/memory"
 206 A fatal initialization error has occurred.
 207 .It "dc%d: couldn't map interrupt"
 208 A fatal initialization error has occurred.
 209 .It "dc%d: watchdog timeout"
 210 A packet was queued for transmission and a transmit command was
 211 issued, but the device failed to acknowledge the transmission
 212 before a timeout expired.
 213 This can happen if the device is unable
 214 to deliver interrupts for some reason, of if there is a problem with
 215 the network connection (cable or network equipment) that results in a loss
 216 of link.
 217 .It "dc%d: no memory for rx list"
 218 The driver failed to allocate an mbuf for the receiver ring.
 219 .It "dc%d: TX underrun -- increasing TX threshold"
 220 The device generated a transmit underrun error while attempting to
 221 DMA and transmit a packet.
 222 This happens if the host is not able to
 223 DMA the packet data into the NIC's FIFO fast enough.
 224 The driver
 225 will dynamically increase the transmit start threshold so that
 226 more data must be DMAed into the FIFO before the NIC will start
 227 transmitting it onto the wire.
 228 .It "dc%d: TX underrun -- using store and forward mode"
 229 The device continued to generate transmit underruns even after all
 230 possible transmit start threshold settings had been tried, so the
 231 driver programmed the chip for store and forward mode.
 232 In this mode,
 233 the NIC will not begin transmission until the entire packet has been
 234 transfered into its FIFO memory.
 235 .It "dc%d: chip is in D3 power state -- setting to D0"
 236 This message applies only to adapters which support power
 237 management.
 238 Some operating systems place the controller in low power
 239 mode when shutting down, and some PCI BIOSes fail to bring the chip
 240 out of this state before configuring it.
 241 The controller loses all of
 242 its PCI configuration in the D3 state, so if the BIOS does not set
 243 it back to full power mode in time, it won't be able to configure it
 244 correctly.
 245 The driver tries to detect this condition and bring
 246 the adapter back to the D0 (full power) state, but this may not be
 247 enough to return the driver to a fully operational condition.
 248 If
 249 you see this message at boot time and the driver fails to attach
 250 the device as a network interface, you will have to perform a second
 251 warm boot to have the device properly configured.
 252 .Pp
 253 Note that this condition only occurs when warm booting from another
 254 operating system.
 255 If you power down your system prior to booting
 256 .Fx ,
 257 the card should be configured correctly.
 258 .El
 259 .Sh SEE ALSO
 260 .Xr arp 4 ,
 261 .Xr miibus 4 ,
 262 .Xr netintro 4 ,
 263 .Xr ng_ether 4 ,
 264 .Xr ifconfig 8
 265 .Rs
 266 .%T ADMtek AL981, AL983 and AL985 data sheets
 267 .%O http://www.admtek.com.tw
 268 .Re
 269 .Rs
 270 .%T ASIX Electronics AX88140A and AX88141 data sheets
 271 .%O http://www.asix.com.tw
 272 .Re
 273 .Rs
 274 .%T Davicom DM9102 data sheet
 275 .%O http://www.davicom8.com
 276 .Re
 277 .Rs
 278 .%T Intel 21143 Hardware Reference Manual
 279 .%O http://developer.intel.com
 280 .Re
 281 .Rs
 282 .%T Macronix 98713/A, 98715/A and 98725 data sheets
 283 .%O http://www.macronix.com
 284 .Re
 285 .Rs
 286 .%T Macronix 98713/A and 98715/A app notes
 287 .%O http://www.macronix.com
 288 .Re
 289 .Sh HISTORY
 290 The
 291 .Nm
 292 device driver first appeared in
 293 .Fx 4.0 .
 294 .Sh AUTHORS
 295 The
 296 .Nm
 297 driver was written by
 298 .An Bill Paul Aq wpaul@ee.columbia.edu .
 299 .Sh BUGS
 300 The Macronix application notes claim that in order to put the
 301 chips in normal operation, the driver must write a certain magic
 302 number into the CSR16 register.
 303 The numbers are documented in
 304 the app notes, but the exact meaning of the bits is not.
 305 .Pp
 306 The 98713A seems to have a problem with 10Mbps full duplex mode.
 307 The transmitter works but the receiver tends to produce many
 308 unexplained errors leading to very poor overall performance.
 309 The
 310 98715A does not exhibit this problem.
 311 All other modes on the
 312 98713A seem to work correctly.
 313 .Pp
 314 The original 82c168 PNIC chip has built in NWAY support which is
 315 used on certain early LinkSys LNE100TX and Matrox FastNIC cards,
 316 however it is horribly broken and difficult to use reliably.
 317 Consequently, autonegotiation is not currently supported for this
 318 chipset: the driver defaults the NIC to 10baseT half duplex, and it's
 319 up to the operator to manually select a different mode if necessary.
 320 (Later cards use an external MII transceiver to implement NWAY
 321 autonegotiation and work correctly.)
 322 .Pp
 323 The
 324 .Nm
 325 driver programs 82c168 and 82c169 PNIC chips to use the store and
 326 forward setting for the transmit start threshold by default.
 327 This
 328 is to work around problems with some NIC/PCI bus combinations where
 329 the PNIC can transmit corrupt frames when operating at 100Mbps,
 330 probably due to PCI DMA burst transfer errors.
 331 .Pp
 332 The 82c168 and 82c169 PNIC chips also have a receiver bug that
 333 sometimes manifests during periods of heavy receive and transmit
 334 activity, where the chip will improperly DMA received frames to
 335 the host.
 336 The chips appear to upload several kilobytes of garbage
 337 data along with the received frame data, dirtying several RX buffers
 338 instead of just the expected one.
 339 The
 340 .Nm
 341 driver detects this condition and will salvage the frame; however,
 342 it incurs a serious performance penalty in the process.
 343 .Pp
 344 The PNIC chips also sometimes generate a transmit underrun error when
 345 the driver attempts to download the receiver filter setup frame, which
 346 can result in the receive filter being incorrectly programmed.
 347 The
 348 .Nm
 349 driver will watch for this condition and requeue the setup frame until
 350 it is transfered successfully.
 351 .Pp
 352 The ADMtek AL981 chip (and possibly the AN985 as well) has been observed
 353 to sometimes wedge on transmit: this appears to happen when the driver
 354 queues a sequence of frames which cause it to wrap from the end of the
 355 transmit descriptor ring back to the beginning.
 356 The
 357 .Nm
 358 driver attempts to avoid this condition by not queing any frames past
 359 the end of the transmit ring during a single invocation of the
 360 .Fn dc_start
 361 routine.
 362 This workaround has a negligible impact on transmit performance.