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$
  32 .\"
  33 .Dd October 24, 2011
  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 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 dc"
  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_dc_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for several PCI Fast Ethernet adapters and
  58 embedded controllers based on the DEC/Intel 21143 chipset and clones.
  59 .Pp
  60 All of supported chipsets have the same general register layout, DMA
  61 descriptor format and method of operation.
  62 All of the clone chips
  63 are based on the 21143 design with various modifications.
  64 The
  65 21143 itself has support for 10baseT, BNC, AUI, MII and symbol
  66 media attachments, 10 and 100Mbps speeds in full or half duplex,
  67 built in NWAY autonegotiation and wake on LAN.
  68 The 21143 also
  69 offers several receive filter programming options including
  70 perfect filtering, inverse perfect filtering and hash table
  71 filtering.
  72 .Pp
  73 Some clone chips duplicate the 21143 fairly closely while others
  74 only maintain superficial similarities.
  75 Some support only MII
  76 media attachments.
  77 Others use different receiver filter programming
  78 mechanisms.
  79 At least one supports only chained DMA descriptors
  80 (most support both chained descriptors and contiguously allocated
  81 fixed size rings).
  82 Some chips (especially the PNIC) also have
  83 peculiar bugs.
  84 The
  85 .Nm
  86 driver does its best to provide generalized support for all
  87 of these chipsets in order to keep special case code to a minimum.
  88 .Pp
  89 These chips are used by many vendors which makes it
  90 difficult to provide a complete list of all supported cards.
  91 .Pp
  92 The
  93 .Nm
  94 driver supports the following media types:
  95 .Bl -tag -width ".Cm 10baseT/UTP"
  96 .It Cm autoselect
  97 Enable autoselection of the media type and options.
  98 The user can manually override
  99 the autoselected mode by adding media options to the
 100 .Pa /etc/rc.conf
 101 file.
 102 .Pp
 103 Note: the built-in NWAY autonegotiation on the original PNIC 82c168
 104 chip is horribly broken and is not supported by the
 105 .Nm
 106 driver at this time (see the
 107 .Sx BUGS
 108 section for details).
 109 The original 82c168 appears
 110 on very early revisions of the LinkSys LNE100TX and Matrox FastNIC.
 111 .It Cm 10baseT/UTP
 112 Set 10Mbps operation.
 113 The
 114 .Cm mediaopt
 115 option can also be used to enable
 116 .Cm full-duplex
 117 operation.
 118 Not specifying
 119 .Cm full-duplex
 120 implies
 121 .Cm half-duplex
 122 mode.
 123 .It Cm 100baseTX
 124 Set 100Mbps (Fast Ethernet) operation.
 125 The
 126 .Cm mediaopt
 127 option can also be used to enable
 128 .Cm full-duplex
 129 operation.
 130 Not specifying
 131 .Cm full-duplex
 132 implies
 133 .Cm half-duplex
 134 mode.
 135 .El
 136 .Pp
 137 The
 138 .Nm
 139 driver supports the following media options:
 140 .Bl -tag -width ".Cm full-duplex"
 141 .It Cm full-duplex
 142 Force full duplex operation.
 143 The interface will operate in
 144 half duplex mode if this media option is not specified.
 145 .El
 146 .Pp
 147 Note that the 100baseTX media type may not be available on certain
 148 Intel 21143 adapters which support 10Mbps media attachments only.
 149 For more information on configuring this device, see
 150 .Xr ifconfig 8 .
 151 .Sh HARDWARE
 152 The
 153 .Nm
 154 driver provides support for the following chipsets:
 155 .Pp
 156 .Bl -bullet -compact
 157 .It
 158 DEC/Intel 21143
 159 .It
 160 ADMtek AL981 Comet, AN985 Centaur, ADM9511 Centaur II and ADM9513
 161 Centaur II
 162 .It
 163 ALi/ULi M5261 and M5263
 164 .It
 165 ASIX Electronics AX88140A and AX88141
 166 .It
 167 Conexant LANfinity RS7112 (miniPCI)
 168 .It
 169 Davicom DM9009, DM9100, DM9102 and DM9102A
 170 .It
 171 Lite-On 82c168 and 82c169 PNIC
 172 .It
 173 Lite-On/Macronix 82c115 PNIC II
 174 .It
 175 Macronix 98713, 98713A, 98715, 98715A, 98715AEC-C, 98725, 98727 and 98732
 176 .It
 177 Xircom X3201 (cardbus only)
 178 .El
 179 .Pp
 180 The
 181 following NICs are known to work with the
 182 .Nm
 183 driver at this time:
 184 .Pp
 185 .Bl -bullet -compact
 186 .It
 187 3Com OfficeConnect 10/100B (ADMtek AN985 Centaur-P)
 188 .It
 189 Abocom FE2500
 190 .It
 191 Accton EN1217 (98715A)
 192 .It
 193 Accton EN2242 MiniPCI
 194 .It
 195 Adico AE310TX (98715A)
 196 .It
 197 Alfa Inc GFC2204 (ASIX AX88140A)
 198 .It
 199 Built in 10Mbps only Ethernet on Compaq Presario 7900 series
 200 desktops (21143, non-MII)
 201 .It
 202 Built in Sun DMFE 10/100 Mbps Ethernet on Sun Netra X1 and Sun Fire V100
 203 (DM9102A, MII)
 204 .It
 205 Built in Ethernet on LinkSys EtherFast 10/100 Instant GigaDrive (DM9102, MII)
 206 .It
 207 CNet Pro110B (ASIX AX88140A)
 208 .It
 209 CNet Pro120A (98715A or 98713A) and CNet Pro120B (98715)
 210 .It
 211 Compex RL100-TX (98713 or 98713A)
 212 .It
 213 D-Link DFE-570TX (21143, MII, quad port)
 214 .It
 215 Digital DE500-BA 10/100 (21143, non-MII)
 216 .It
 217 ELECOM Laneed LD-CBL/TXA (ADMtek AN985)
 218 .It
 219 Hawking CB102 CardBus
 220 .It
 221 IBM EtherJet Cardbus Adapter
 222 .It
 223 Intel PRO/100 Mobile Cardbus (versions that use the X3201 chipset)
 224 .It
 225 Jaton XpressNet (Davicom DM9102)
 226 .It
 227 Kingston KNE100TX (21143, MII)
 228 .It
 229 Kingston KNE110TX (PNIC 82c169)
 230 .It
 231 LinkSys LNE100TX (PNIC 82c168, 82c169)
 232 .It
 233 LinkSys LNE100TX v2.0 (PNIC II 82c115)
 234 .It
 235 LinkSys LNE100TX v4.0/4.1 (ADMtek AN985 Centaur-P)
 236 .It
 237 Matrox FastNIC 10/100 (PNIC 82c168, 82c169)
 238 .It
 239 Melco LGY-PCI-TXL
 240 .It
 241 Microsoft MN-120 10/100 CardBus (ADMTek Centaur-C)
 242 .It
 243 Microsoft MN-130 10/100 PCI (ADMTek Centaur-P)
 244 .It
 245 NDC SOHOware SFA110A (98713A)
 246 .It
 247 NDC SOHOware SFA110A Rev B4 (98715AEC-C)
 248 .It
 249 NetGear FA310-TX Rev.\& D1, D2 or D3 (PNIC 82c169)
 250 .It
 251 Netgear FA511
 252 .It
 253 PlaneX FNW-3602-T (ADMtek AN985)
 254 .It
 255 SMC EZ Card 10/100 1233A-TX (ADMtek AN985)
 256 .It
 257 SVEC PN102-TX (98713)
 258 .It
 259 Xircom Cardbus Realport
 260 .It
 261 Xircom Cardbus Ethernet 10/100
 262 .It
 263 Xircom Cardbus Ethernet II 10/100
 264 .El
 265 .Sh NOTES
 266 On sparc64 the
 267 .Nm
 268 driver respects the
 269 .Va local-mac-address?
 270 system configuration variable for the built in Sun DMFE 10/100 Mbps Ethernet
 271 interfaces on Sun Netra X1 and Sun Fire V100.
 272 This system configuration variable can be set in the Open Firmware boot
 273 monitor using the
 274 .Ic setenv
 275 command or by
 276 .Xr eeprom 8 .
 277 If set to
 278 .Dq Li false
 279 (the default), the
 280 .Nm
 281 driver will use the system's default MAC address for both of the built in
 282 devices.
 283 If set to
 284 .Dq Li true ,
 285 the unique MAC address of each interface is used rather than the system's
 286 default MAC address.
 287 .Sh DIAGNOSTICS
 288 .Bl -diag
 289 .It "dc%d: couldn't map ports/memory"
 290 A fatal initialization error has occurred.
 291 .It "dc%d: couldn't map interrupt"
 292 A fatal initialization error has occurred.
 293 .It "dc%d: watchdog timeout"
 294 A packet was queued for transmission and a transmit command was
 295 issued, but the device failed to acknowledge the transmission
 296 before a timeout expired.
 297 This can happen if the device is unable
 298 to deliver interrupts for some reason, of if there is a problem with
 299 the network connection (cable or network equipment) that results in a loss
 300 of link.
 301 .It "dc%d: no memory for rx list"
 302 The driver failed to allocate an mbuf for the receiver ring.
 303 .It "dc%d: TX underrun -- increasing TX threshold"
 304 The device generated a transmit underrun error while attempting to
 305 DMA and transmit a packet.
 306 This happens if the host is not able to
 307 DMA the packet data into the NIC's FIFO fast enough.
 308 The driver
 309 will dynamically increase the transmit start threshold so that
 310 more data must be DMAed into the FIFO before the NIC will start
 311 transmitting it onto the wire.
 312 .It "dc%d: TX underrun -- using store and forward mode"
 313 The device continued to generate transmit underruns even after all
 314 possible transmit start threshold settings had been tried, so the
 315 driver programmed the chip for store and forward mode.
 316 In this mode,
 317 the NIC will not begin transmission until the entire packet has been
 318 transferred into its FIFO memory.
 319 .It "dc%d: chip is in D3 power state -- setting to D0"
 320 This message applies only to adapters which support power
 321 management.
 322 Some operating systems place the controller in low power
 323 mode when shutting down, and some PCI BIOSes fail to bring the chip
 324 out of this state before configuring it.
 325 The controller loses all of
 326 its PCI configuration in the D3 state, so if the BIOS does not set
 327 it back to full power mode in time, it will not be able to configure it
 328 correctly.
 329 The driver tries to detect this condition and bring
 330 the adapter back to the D0 (full power) state, but this may not be
 331 enough to return the driver to a fully operational condition.
 332 If
 333 you see this message at boot time and the driver fails to attach
 334 the device as a network interface, you will have to perform a second
 335 warm boot to have the device properly configured.
 336 .Pp
 337 Note that this condition only occurs when warm booting from another
 338 operating system.
 339 If you power down your system prior to booting
 340 .Fx ,
 341 the card should be configured correctly.
 342 .El
 343 .Sh SEE ALSO
 344 .Xr altq 4 ,
 345 .Xr arp 4 ,
 346 .Xr miibus 4 ,
 347 .Xr netintro 4 ,
 348 .Xr ng_ether 4 ,
 349 .Xr polling 4 ,
 350 .Xr vlan 4 ,
 351 .Xr eeprom 8 ,
 352 .Xr ifconfig 8
 353 .Rs
 354 .%T ADMtek AL981, AL983 and AL985 data sheets
 355 .%U http://www.admtek.com.tw
 356 .Re
 357 .Rs
 358 .%T ASIX Electronics AX88140A and AX88141 data sheets
 359 .%U http://www.asix.com.tw
 360 .Re
 361 .Rs
 362 .%T Davicom DM9102 data sheet
 363 .%U http://www.davicom.com.tw/userfile/24247/DM9102H-DS-F01-021508.pdf
 364 .Re
 365 .Rs
 366 .%T Intel 21143 Hardware Reference Manual
 367 .%U http://developer.intel.com
 368 .Re
 369 .Rs
 370 .%T Macronix 98713/A, 98715/A and 98725 data sheets
 371 .%U http://www.macronix.com
 372 .Re
 373 .Rs
 374 .%T Macronix 98713/A and 98715/A app notes
 375 .%U http://www.macronix.com
 376 .Re
 377 .Sh HISTORY
 378 The
 379 .Nm
 380 device driver first appeared in
 381 .Fx 4.0 .
 382 .Sh AUTHORS
 383 The
 384 .Nm
 385 driver was written by
 386 .An Bill Paul Aq wpaul@ee.columbia.edu .
 387 .Sh BUGS
 388 The Macronix application notes claim that in order to put the
 389 chips in normal operation, the driver must write a certain magic
 390 number into the CSR16 register.
 391 The numbers are documented in
 392 the app notes, but the exact meaning of the bits is not.
 393 .Pp
 394 The 98713A seems to have a problem with 10Mbps full duplex mode.
 395 The transmitter works but the receiver tends to produce many
 396 unexplained errors leading to very poor overall performance.
 397 The
 398 98715A does not exhibit this problem.
 399 All other modes on the
 400 98713A seem to work correctly.
 401 .Pp
 402 The original 82c168 PNIC chip has built in NWAY support which is
 403 used on certain early LinkSys LNE100TX and Matrox FastNIC cards,
 404 however it is horribly broken and difficult to use reliably.
 405 Consequently, autonegotiation is not currently supported for this
 406 chipset: the driver defaults the NIC to 10baseT half duplex, and it is
 407 up to the operator to manually select a different mode if necessary.
 408 (Later cards use an external MII transceiver to implement NWAY
 409 autonegotiation and work correctly.)
 410 .Pp
 411 The
 412 .Nm
 413 driver programs 82c168 and 82c169 PNIC chips to use the store and
 414 forward setting for the transmit start threshold by default.
 415 This
 416 is to work around problems with some NIC/PCI bus combinations where
 417 the PNIC can transmit corrupt frames when operating at 100Mbps,
 418 probably due to PCI DMA burst transfer errors.
 419 .Pp
 420 The 82c168 and 82c169 PNIC chips also have a receiver bug that
 421 sometimes manifests during periods of heavy receive and transmit
 422 activity, where the chip will improperly DMA received frames to
 423 the host.
 424 The chips appear to upload several kilobytes of garbage
 425 data along with the received frame data, dirtying several RX buffers
 426 instead of just the expected one.
 427 The
 428 .Nm
 429 driver detects this condition and will salvage the frame; however,
 430 it incurs a serious performance penalty in the process.
 431 .Pp
 432 The PNIC chips also sometimes generate a transmit underrun error when
 433 the driver attempts to download the receiver filter setup frame, which
 434 can result in the receive filter being incorrectly programmed.
 435 The
 436 .Nm
 437 driver will watch for this condition and requeue the setup frame until
 438 it is transferred successfully.
 439 .Pp
 440 The ADMtek AL981 chip (and possibly the AN985 as well) has been observed
 441 to sometimes wedge on transmit: this appears to happen when the driver
 442 queues a sequence of frames which cause it to wrap from the end of the
 443 transmit descriptor ring back to the beginning.
 444 The
 445 .Nm
 446 driver attempts to avoid this condition by not queuing any frames past
 447 the end of the transmit ring during a single invocation of the
 448 .Fn dc_start
 449 routine.
 450 This workaround has a negligible impact on transmit performance.