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 (8002, 8002T, 8010 and 8610)
 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 Billionton LNT-10TB, LNT-10TN Ethernet PC Card
 151 .It
 152 Bromax iPort 10/100 Ethernet PC Card
 153 .It
 154 Bromax iPort 10 Ethernet PC Card
 155 .It
 156 Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX, LPC-CTX PC Card
 157 .It
 158 Buffalo LPC-CF-CLT CF Card
 159 .It
 160 CNet BC40 adapter
 161 .It
 162 Compex Net-A adapter
 163 .It
 164 Compex RL2000
 165 .It
 166 Contec C-NET(98), RT-1007(98), C-NET(9N) (110pin) (flags 0xa00000) (PC-98)
 167 .It
 168 Contec C-NET(98)E-A, C-NET(98)L-A, C-NET(98)P (flags 0x300000) (PC-98)
 169 .It
 170 Corega Ether98-T (flags 0x000000) (PC-98)
 171 .It
 172 Corega Ether PCC-T/EtherII PCC-T/FEther PCC-TXF/PCC-TXD PCC-T/Fether II TXD
 173 .It
 174 Corega LAPCCTXD (TC5299J)
 175 .It
 176 CyQ've ELA-010
 177 .It
 178 DEC EtherWorks DE305
 179 .It
 180 Danpex EN-6200P2
 181 .It
 182 D-Link DE-298, DE-298P (flags 0x500000) (PC-98)
 183 .It
 184 D-Link DE-660, DE-660+
 185 .It
 186 D-Link IC-CARD/IC-CARD+ Ethernet
 187 .It
 188 ELECOM LD-98P (flags 0x500000) (PC-98)
 189 .It
 190 ELECOM LD-BDN, LD-NW801G (flags 0x200000) (PC-98)
 191 .It
 192 ELECOM Laneed LD-CDL/TX, LD-CDF, LD-CDS, LD-10/100CD, LD-CDWA (DP83902A)
 193 .It
 194 Hawking PN652TX PC Card (AX88790)
 195 .It
 196 HP PC Lan+ 27247B and 27252A
 197 .Pq Cd "options ED_HPP"
 198 .It
 199 IBM Creditcard Ethernet I/II
 200 .It
 201 ICM AD-ET2-T, DT-ET-25, DT-ET-T5, IF-2766ET, IF-2771ET, NB-ET-T (110pin)
 202 (flags 0x500000) (PC-98)
 203 .It
 204 I-O DATA LA/T-98, LA/T-98SB, LA2/T-98, ET/T-98 (flags 0x900000) (PC-98)
 205 .It
 206 I-O DATA ET2/T-PCI
 207 .It
 208 I-O DATA PCLATE
 209 .It
 210 Kansai KLA-98C/T (flags 0x900000) (PC-98)
 211 .It
 212 Kingston KNE-PC2, CIO10T, KNE-PCM/x Ethernet
 213 .It
 214 KTI ET32P2 PCI
 215 .It
 216 Linksys EC2T/PCMPC100/PCM100, PCMLM56
 217 .It
 218 Linksys EtherFast 10/100 PC Card, Combo PCMCIA Ethernet Card (PCMPC100 V2)
 219 .It
 220 Logitec LAN-98T (flags 0xb00000) (PC-98)
 221 .It
 222 MACNICA Ethernet ME1 for JEIDA
 223 .It
 224 MACNICA ME98 (flags 0x900000) (PC-98)
 225 .It
 226 MACNICA NE2098 (flags 0x400000) (PC-98)
 227 .It
 228 MELCO EGY-98 (flags 0x300000) (PC-98)
 229 .It
 230 MELCO LGH-98, LGY-98, LGY-98-N (110pin), IND-SP, IND-SS (flags 0x400000) (PC-98)
 231 .It
 232 MELCO LGY-PCI-TR
 233 .It
 234 MELCO LPC-T/LPC2-T/LPC2-CLT/LPC2-TX/LPC3-TX/LPC3-CLX
 235 .It
 236 NDC Ethernet Instant-Link
 237 .It
 238 NEC PC-9801-77, PC-9801-78 (flags 0x910000) (PC-98)
 239 .It
 240 NEC PC-9801-107, PC-9801-108 (flags 0x800000) (PC-98)
 241 .It
 242 National Semiconductor InfoMover NE4100
 243 .It
 244 NetGear FA-410TX
 245 .It
 246 NetVin NV5000SC
 247 .It
 248 Network Everywhere Ethernet 10BaseT PC Card
 249 .It
 250 Networld 98X3 (flags 0xd00000) (PC-98)
 251 .It
 252 Networld EC-98X, EP-98X (flags 0xd10000) (PC-98)
 253 .It
 254 New Media LANSurfer 10+56 Ethernet/Modem
 255 .It
 256 New Media LANSurfer
 257 .It
 258 Novell NE1000/NE2000/NE2100
 259 .It
 260 PLANEX ENW-8300-T
 261 .It
 262 PLANEX EN-2298-C (flags 0x200000) (PC-98)
 263 .It
 264 PLANEX EN-2298P-T, EN-2298-T (flags 0x500000) (PC-98)
 265 .It
 266 PLANEX FNW-3600-T
 267 .It
 268 Psion 10/100 LANGLOBAL Combine iT
 269 .It
 270 RealTek 8019
 271 .It
 272 RealTek 8029
 273 .It
 274 Relia Combo-L/M-56k PC Card
 275 .It
 276 SMC Elite 16 WD8013
 277 .It
 278 SMC Elite Ultra
 279 .It
 280 SMC EtherEZ98 (flags 0x000000) (PC-98)
 281 .It
 282 SMC WD8003E/WD8003EBT/WD8003S/WD8003SBT/WD8003W/WD8013EBT/WD8013W and clones
 283 .It
 284 SMC EZCard PC Card, 8040-TX, 8041-TX (AX88x90), 8041-TX V.2 (TC5299J)
 285 .It
 286 Socket LP-E, ES-1000 Ethernet/Serial, LP-E CF, LP-FE CF
 287 .It
 288 Surecom EtherPerfect EP-427
 289 .It
 290 Surecom NE-34
 291 .It
 292 TDK 3000/3400/5670 Fast Ethernet/Modem
 293 .It
 294 TDK LAK-CD031, Grey Cell GCS2000 Ethernet Card
 295 .It
 296 TDK DFL5610WS Ethernet/Modem PC Card
 297 .It
 298 Telecom Device SuperSocket RE450T
 299 .It
 300 Toshiba LANCT00A PC Card
 301 .It
 302 VIA VT86C926
 303 .It
 304 Winbond W89C940
 305 .It
 306 Winbond W89C940F
 307 .El
 308 .Pp
 309 C-Bus, ISA, PCI and PC Card devices are supported.
 310 .Pp
 311 The
 312 .Nm
 313 driver does not support the following Ethernet NICs:
 314 .Pp
 315 .Bl -bullet -compact
 316 .It
 317 Mitsubishi LAN Adapter B8895
 318 .El
 319 .Sh DIAGNOSTICS
 320 .Bl -diag
 321 .It "ed%d: failed to clear shared memory at %x - check configuration."
 322 When the card was probed at system boot time, the
 323 .Nm
 324 driver found that it could not clear the card's shared memory.
 325 This is most commonly
 326 caused by a BIOS extension ROM being configured in the same address space as the
 327 Ethernet card's shared memory.
 328 Either find the offending card and change its BIOS
 329 ROM to be at an address that does not conflict, or change the
 330 settings in
 331 .Xr device.hints 5
 332 that the card's shared memory is mapped at a
 333 non-conflicting address.
 334 .It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
 335 The IRQ number that was specified in the
 336 .Xr device.hints 5
 337 file is not valid for the 3Com 3c503 card.
 338 The 3c503 can only be assigned to IRQs 2 through 5.
 339 .It "ed%d: Cannot find start of RAM."
 340 .It "ed%d: Cannot find any RAM, start : %d, x = %d."
 341 The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
 342 This likely indicates that the card was improperly recognized as a Gateway or that
 343 the card is defective.
 344 .It "ed: packets buffered, but transmitter idle."
 345 Indicates a logic problem in the driver.
 346 Should never happen.
 347 .It "ed%d: device timeout"
 348 Indicates that an expected transmitter interrupt did not occur.
 349 Usually caused by an
 350 interrupt conflict with another card on the ISA bus.
 351 This condition could also be caused if the kernel is configured for a
 352 different IRQ channel than the one the card is actually using.
 353 If that is the case, you will have to either reconfigure the card
 354 using a DOS utility or set the jumpers on the card appropriately.
 355 .It "ed%d: NIC memory corrupt - invalid packet length %d."
 356 Indicates that a packet was received with a packet length that was either larger than
 357 the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
 358 Usually
 359 caused by a conflict with another card on the ISA bus, but in some cases may also
 360 indicate faulty cabling.
 361 .It "ed%d: remote transmit DMA failed to complete."
 362 This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
 363 has failed to properly complete.
 364 Usually caused by the ISA bus speed being set
 365 too fast.
 366 .It "ed%d: Invalid irq configuration (%ld) must be %s for %s"
 367 Indicates the device has a different IRQ than supported or expected.
 368 .It "ed%d: Cannot locate my ports!"
 369 The device is using a different I/O port than the driver knows about.
 370 .It "ed%d: Cannot extract MAC address"
 371 Attempts to get the MAC address failed.
 372 .It "ed%d: Missing mii!"
 373 Probing for an MII bus has failed.
 374 This indicates a coding error in the PC Card attachment, because a PHY
 375 is required for the chips that generate this error message.
 376 .El
 377 .Sh SEE ALSO
 378 .Xr altq 4 ,
 379 .Xr arp 4 ,
 380 .Xr miibus 4 ,
 381 .Xr netintro 4 ,
 382 .Xr ng_ether 4 ,
 383 .Xr device.hints 5 ,
 384 .Xr ifconfig 8
 385 .Sh HISTORY
 386 The
 387 .Nm
 388 device driver first appeared in
 389 .Fx 1.0 .
 390 .Sh AUTHORS
 391 The
 392 .Nm
 393 device driver and this manual page were written by
 394 .An David Greenman .
 395 .Sh CAVEATS
 396 Early revision DS8390 chips have problems.
 397 They lock up whenever the receive
 398 ring-buffer overflows.
 399 They occasionally switch the byte order
 400 of the length field in the packet ring header (several different causes
 401 of this related to an off-by-one byte alignment) - resulting in
 402 .Qq Li "NIC memory corrupt - invalid packet length"
 403 messages.
 404 The card is reset
 405 whenever these problems occur, but otherwise there is no problem with
 406 recovering from these conditions.
 407 .Pp
 408 The NIC memory access to 3Com and Novell cards is much slower than it is on
 409 WD/SMC cards; it is less than 1MB/second on 8bit boards and less than 2MB/second
 410 on the 16bit cards.
 411 This can lead to ring-buffer overruns resulting in
 412 dropped packets during heavy network traffic.
 413 .Pp
 414 The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is
 415 undocumented.
 416 Neither the NE2000 nor the WD83x0 drivers work with this card.
 417 .Sh BUGS
 418 The
 419 .Nm
 420 driver is a bit too aggressive about resetting the card whenever any bad
 421 packets are received.
 422 As a result, it may throw out some good packets which
 423 have been received but not yet transferred from the card to main memory.
 424 .Pp
 425 The
 426 .Nm
 427 driver is slow by today's standards.
 428 .Pp
 429 PC Card attachment supports the D-Link DMF650TX LAN/Modem card's Ethernet
 430 port only at this time.
 431 .Pp
 432 Some devices supported by
 433 .Nm
 434 do not generate the link state change events used by
 435 .Xr devd 8
 436 to start
 437 .Xr dhclient 8 .
 438 If you have problems with
 439 .Xr dhclient 8
 440 not starting and the device is always attached to the network it may
 441 be possible to work around this by changing
 442 .Dq Li DHCP
 443 to
 444 .Dq Li SYNCDHCP
 445 in the
 446 .Va ifconfig_ed0
 447 entry in
 448 .Pa /etc/rc.conf .