share/man/man4/ed.4

   1 .\"
   2 .\" Copyright (c) 1994, David Greenman
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by David Greenman.
  16 .\" 4. The name of the author may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd February 25, 2012
  34 .Dt ED 4
  35 .Os
  36 .Sh NAME
  37 .Nm ed
  38 .Nd "NE-2000 and WD-80x3 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 ed"
  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_ed_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for 8 and 16bit Ethernet cards that are based on
  58 the National Semiconductor DS8390 and similar NICs manufactured by
  59 other companies.
  60 The
  61 .Nm
  62 driver also supports many PC Card chips which interface via MII to a PHY.
  63 Axiom's AX88790, AX88190 and AX88190A;
  64 DLink's DL10019 and DL10022; and
  65 Tamarack's TC5299J chips all support internal or external MII/PHY combinations.
  66 Realtek's PCI and ISA RTL80x9-based cards are also supported.
  67 For these chipsets, autonegotiation and status reporting are supported.
  68 .Pp
  69 In addition to the standard port and IRQ specifications, the
  70 .Nm
  71 driver also supports a number of
  72 .Cd flags
  73 which can force 8/16bit mode, enable/disable multi-buffering, and select the default
  74 interface type (AUI/BNC, and for cards with twisted pair, AUI/10BaseT).
  75 .Pp
  76 The
  77 .Cd flags
  78 are a bit field, and are summarized as follows:
  79 .Bl -tag -width indent
  80 .It Li 0x01
  81 Disable transceiver.
  82 On those cards which support it, this flag causes the transceiver to
  83 be disabled and the AUI connection to be used by default.
  84 .It Li 0x02
  85 Force 8bit mode.
  86 This flag forces the card to 8bit mode regardless of how the
  87 card identifies itself.
  88 This may be needed for some clones which incorrectly
  89 identify themselves as 16bit, even though they only have an 8bit interface.
  90 This flag takes precedence over force 16bit mode.
  91 .It Li 0x04
  92 Force 16bit mode.
  93 This flag forces the card to 16bit mode regardless of how the
  94 card identifies itself.
  95 This may be needed for some clones which incorrectly
  96 identify themselves as 8bit, even though they have a 16bit ISA interface.
  97 .It Li 0x08
  98 Disable transmitter multi-buffering.
  99 This flag disables the use of multiple
 100 transmit buffers and may be necessary in rare cases where packets are sent out
 101 faster than a machine on the other end can handle (as evidenced by severe packet
 102 lossage).
 103 Some
 104 .No ( non- Ns Fx
 105 :-)) machines have terrible Ethernet performance
 106 and simply cannot cope with 1100K+ data rates.
 107 Use of this flag also provides
 108 one more packet worth of receiver buffering, and on 8bit cards, this may help
 109 reduce receiver lossage.
 110 .El
 111 .Pp
 112 When using a 3c503 card, the AUI connection may be selected by specifying the
 113 .Cm link2
 114 option to
 115 .Xr ifconfig 8
 116 (BNC is the default).
 117 .Sh HARDWARE
 118 The
 119 .Nm
 120 driver supports the following Ethernet NICs:
 121 .Pp
 122 .Bl -bullet -compact
 123 .It
 124 3Com 3c503 Etherlink II
 125 .Pq Cd "options ED_3C503"
 126 .It
 127 AR-P500 Ethernet
 128 .It
 129 Accton EN1644 (old model), EN1646 (old model), EN2203 (old model) (110pin)
 130 (flags 0xd00000)
 131 .It
 132 Accton EN2212/EN2216/UE2216
 133 .It
 134 Allied Telesis CentreCOM LA100-PCM_V2
 135 .It
 136 Allied Telesis LA-98 (flags 0x000000) (PC-98)
 137 .It
 138 Allied Telesis SIC-98, SIC-98NOTE (110pin), SIU-98 (flags 0x600000) (PC-98)
 139 .It
 140 Allied Telesis SIU-98-D (flags 0x610000) (PC-98)
 141 .It
 142 AmbiCom 10BaseT card
 143 .It
 144 Bay Networks NETGEAR FA410TXC Fast Ethernet
 145 .It
 146 Belkin F5D5020 PC Card Fast Ethernet
 147 .It
 148 Billionton LM5LT-10B Ethernet/Modem PC Card
 149 .It
 150 Bromax iPort 10/100 Ethernet PC Card
 151 .It
 152 Bromax iPort 10 Ethernet PC Card
 153 .It
 154 Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX PC Card
 155 .It
 156 CNet BC40 adapter
 157 .It
 158 Compex Net-A adapter
 159 .It
 160 Compex RL2000
 161 .It
 162 Contec C-NET(98), RT-1007(98), C-NET(9N) (110pin) (flags 0xa00000) (PC-98)
 163 .It
 164 Contec C-NET(98)E-A, C-NET(98)L-A, C-NET(98)P (flags 0x300000) (PC-98)
 165 .It
 166 Corega Ether98-T (flags 0x000000) (PC-98)
 167 .It
 168 Corega Ether PCC-T/EtherII PCC-T/FEther PCC-TXF/PCC-TXD PCC-T/Fether II TXD
 169 .It
 170 Corega LAPCCTXD (TC5299J)
 171 .It
 172 CyQ've ELA-010
 173 .It
 174 DEC EtherWorks DE305
 175 .It
 176 Danpex EN-6200P2
 177 .It
 178 D-Link DE-298, DE-298P (flags 0x500000) (PC-98)
 179 .It
 180 D-Link DE-660, DE-660+
 181 .It
 182 D-Link IC-CARD/IC-CARD+ Ethernet
 183 .It
 184 ELECOM LD-98P (flags 0x500000) (PC-98)
 185 .It
 186 ELECOM LD-BDN, LD-NW801G (flags 0x200000) (PC-98)
 187 .It
 188 ELECOM Laneed LD-CDL/TX, LD-CDF, LD-CDS, LD-10/100CD, LD-CDWA (DP83902A)
 189 .It
 190 Hawking PN652TX PC Card (AX88790)
 191 .It
 192 HP PC Lan+ 27247B and 27252A
 193 .Pq Cd "options ED_HPP"
 194 .It
 195 IBM Creditcard Ethernet I/II
 196 .It
 197 ICM AD-ET2-T, DT-ET-25, DT-ET-T5, IF-2766ET, IF-2771ET, NB-ET-T (110pin)
 198 (flags 0x500000) (PC-98)
 199 .It
 200 I-O DATA LA/T-98, LA/T-98SB, LA2/T-98, ET/T-98 (flags 0x900000) (PC-98)
 201 .It
 202 I-O DATA ET2/T-PCI
 203 .It
 204 I-O DATA PCLATE
 205 .It
 206 Kansai KLA-98C/T (flags 0x900000) (PC-98)
 207 .It
 208 Kingston KNE-PC2, CIO10T, KNE-PCM/x Ethernet
 209 .It
 210 KTI ET32P2 PCI
 211 .It
 212 Linksys EC2T/PCMPC100/PCM100, PCMLM56
 213 .It
 214 Linksys EtherFast 10/100 PC Card, Combo PCMCIA Ethernet Card (PCMPC100 V2)
 215 .It
 216 Logitec LAN-98T (flags 0xb00000) (PC-98)
 217 .It
 218 MACNICA Ethernet ME1 for JEIDA
 219 .It
 220 MACNICA ME98 (flags 0x900000) (PC-98)
 221 .It
 222 MACNICA NE2098 (flags 0x400000) (PC-98)
 223 .It
 224 MELCO EGY-98 (flags 0x300000) (PC-98)
 225 .It
 226 MELCO LGH-98, LGY-98, LGY-98-N (110pin), IND-SP, IND-SS (flags 0x400000) (PC-98)
 227 .It
 228 MELCO LGY-PCI-TR
 229 .It
 230 MELCO LPC-T/LPC2-T/LPC2-CLT/LPC2-TX/LPC3-TX/LPC3-CLX
 231 .It
 232 NDC Ethernet Instant-Link
 233 .It
 234 NEC PC-9801-77, PC-9801-78 (flags 0x910000) (PC-98)
 235 .It
 236 NEC PC-9801-107, PC-9801-108 (flags 0x800000) (PC-98)
 237 .It
 238 National Semiconductor InfoMover NE4100
 239 .It
 240 NetGear FA-410TX
 241 .It
 242 NetVin NV5000SC
 243 .It
 244 Network Everywhere Ethernet 10BaseT PC Card
 245 .It
 246 Networld 98X3 (flags 0xd00000) (PC-98)
 247 .It
 248 Networld EC-98X, EP-98X (flags 0xd10000) (PC-98)
 249 .It
 250 New Media LANSurfer 10+56 Ethernet/Modem
 251 .It
 252 New Media LANSurfer
 253 .It
 254 Novell NE1000/NE2000/NE2100
 255 .It
 256 PLANEX ENW-8300-T
 257 .It
 258 PLANEX EN-2298-C (flags 0x200000) (PC-98)
 259 .It
 260 PLANEX EN-2298P-T, EN-2298-T (flags 0x500000) (PC-98)
 261 .It
 262 PLANEX FNW-3600-T
 263 .It
 264 Psion 10/100 LANGLOBAL Combine iT
 265 .It
 266 RealTek 8019
 267 .It
 268 RealTek 8029
 269 .It
 270 Relia Combo-L/M-56k PC Card
 271 .It
 272 SMC Elite 16 WD8013
 273 .It
 274 SMC Elite Ultra
 275 .It
 276 SMC EtherEZ98 (flags 0x000000) (PC-98)
 277 .It
 278 SMC WD8003E/WD8003EBT/WD8003S/WD8003SBT/WD8003W/WD8013EBT/WD8013W and clones
 279 .It
 280 SMC EZCard PC Card, 8040-TX, 8041-TX (AX88x90), 8041-TX V.2 (TC5299J)
 281 .It
 282 Socket LP-E, ES-1000 Ethernet/Serial, LP-E CF, LP-FE CF
 283 .It
 284 Surecom EtherPerfect EP-427
 285 .It
 286 Surecom NE-34
 287 .It
 288 TDK 3000/3400/5670 Fast Ethernet/Modem
 289 .It
 290 TDK LAK-CD031, Grey Cell GCS2000 Ethernet Card
 291 .It
 292 TDK DFL5610WS Ethernet/Modem PC Card
 293 .It
 294 Telecom Device SuperSocket RE450T
 295 .It
 296 Toshiba LANCT00A PC Card
 297 .It
 298 VIA VT86C926
 299 .It
 300 Winbond W89C940
 301 .It
 302 Winbond W89C940F
 303 .El
 304 .Pp
 305 C-Bus, ISA, PCI and PC Card devices are supported.
 306 .Pp
 307 The
 308 .Nm
 309 driver does not support the following Ethernet NICs:
 310 .Pp
 311 .Bl -bullet -compact
 312 .It
 313 Mitsubishi LAN Adapter B8895
 314 .El
 315 .Sh DIAGNOSTICS
 316 .Bl -diag
 317 .It "ed%d: failed to clear shared memory at %x - check configuration."
 318 When the card was probed at system boot time, the
 319 .Nm
 320 driver found that it could not clear the card's shared memory.
 321 This is most commonly
 322 caused by a BIOS extension ROM being configured in the same address space as the
 323 Ethernet card's shared memory.
 324 Either find the offending card and change its BIOS
 325 ROM to be at an address that does not conflict, or change the
 326 settings in
 327 .Xr device.hints 5
 328 that the card's shared memory is mapped at a
 329 non-conflicting address.
 330 .It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
 331 The IRQ number that was specified in the
 332 .Xr device.hints 5
 333 file is not valid for the 3Com 3c503 card.
 334 The 3c503 can only be assigned to IRQs 2 through 5.
 335 .It "ed%d: Cannot find start of RAM."
 336 .It "ed%d: Cannot find any RAM, start : %d, x = %d."
 337 The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
 338 This likely indicates that the card was improperly recognized as a Gateway or that
 339 the card is defective.
 340 .It "ed: packets buffered, but transmitter idle."
 341 Indicates a logic problem in the driver.
 342 Should never happen.
 343 .It "ed%d: device timeout"
 344 Indicates that an expected transmitter interrupt did not occur.
 345 Usually caused by an
 346 interrupt conflict with another card on the ISA bus.
 347 This condition could also be caused if the kernel is configured for a
 348 different IRQ channel than the one the card is actually using.
 349 If that is the case, you will have to either reconfigure the card
 350 using a DOS utility or set the jumpers on the card appropriately.
 351 .It "ed%d: NIC memory corrupt - invalid packet length %d."
 352 Indicates that a packet was received with a packet length that was either larger than
 353 the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
 354 Usually
 355 caused by a conflict with another card on the ISA bus, but in some cases may also
 356 indicate faulty cabling.
 357 .It "ed%d: remote transmit DMA failed to complete."
 358 This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
 359 has failed to properly complete.
 360 Usually caused by the ISA bus speed being set
 361 too fast.
 362 .It "ed%d: Invalid irq configuration (%ld) must be %s for %s"
 363 Indicates the device has a different IRQ than supported or expected.
 364 .It "ed%d: Cannot locate my ports!"
 365 The device is using a different I/O port than the driver knows about.
 366 .It "ed%d: Cannot extract MAC address"
 367 Attempts to get the MAC address failed.
 368 .It "ed%d: Missing mii!"
 369 Probing for an MII bus has failed.
 370 This indicates a coding error in the PC Card attachment, because a PHY
 371 is required for the chips that generate this error message.
 372 .El
 373 .Sh SEE ALSO
 374 .Xr altq 4 ,
 375 .Xr arp 4 ,
 376 .Xr miibus 4 ,
 377 .Xr netintro 4 ,
 378 .Xr ng_ether 4 ,
 379 .Xr device.hints 5 ,
 380 .Xr ifconfig 8
 381 .Sh HISTORY
 382 The
 383 .Nm
 384 device driver first appeared in
 385 .Fx 1.0 .
 386 .Sh AUTHORS
 387 The
 388 .Nm
 389 device driver and this manual page were written by
 390 .An David Greenman .
 391 .Sh CAVEATS
 392 Early revision DS8390 chips have problems.
 393 They lock up whenever the receive
 394 ring-buffer overflows.
 395 They occasionally switch the byte order
 396 of the length field in the packet ring header (several different causes
 397 of this related to an off-by-one byte alignment) - resulting in
 398 .Qq Li "NIC memory corrupt - invalid packet length"
 399 messages.
 400 The card is reset
 401 whenever these problems occur, but otherwise there is no problem with
 402 recovering from these conditions.
 403 .Pp
 404 The NIC memory access to 3Com and Novell cards is much slower than it is on
 405 WD/SMC cards; it is less than 1MB/second on 8bit boards and less than 2MB/second
 406 on the 16bit cards.
 407 This can lead to ring-buffer overruns resulting in
 408 dropped packets during heavy network traffic.
 409 .Pp
 410 The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is
 411 undocumented.
 412 Neither the NE2000 nor the WD83x0 drivers work with this card.
 413 .Pp
 414 .Sh BUGS
 415 The
 416 .Nm
 417 driver is a bit too aggressive about resetting the card whenever any bad
 418 packets are received.
 419 As a result, it may throw out some good packets which
 420 have been received but not yet transferred from the card to main memory.
 421 .Pp
 422 The
 423 .Nm
 424 driver is slow by today's standards.
 425 .Pp
 426 PC Card attachment supports the D-Link DMF650TX LAN/Modem card's Ethernet
 427 port only at this time.
 428 .Pp
 429 Some devices supported by
 430 .Nm
 431 do not generate the link state change events used by
 432 .Xr devd 8
 433 to start
 434 .Xr dhclient 8 .
 435 If you have problems with
 436 .Xr dhclient 8
 437 not starting and the device is always attached to the network it may
 438 be possible to work around this by changing
 439 .Dq Li DHCP
 440 to
 441 .Dq Li SYNCDHCP
 442 in the
 443 .Va ifconfig_ed0
 444 entry in
 445 .Pa /etc/rc.conf .