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 January 27, 2008
  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 The
  70 .Nm
  71 driver uses a unique multi-buffering mechanism to achieve high transmit performance.
  72 When using 16bit ISA cards, as high as 97% of the theoretical maximum performance of
  73 the IEEE 802.3 CSMA Ethernet is possible.
  74 .Pp
  75 In addition to the standard port and IRQ specifications, the
  76 .Nm
  77 driver also supports a number of
  78 .Cd flags
  79 which can force 8/16bit mode, enable/disable multi-buffering, and select the default
  80 interface type (AUI/BNC, and for cards with twisted pair, AUI/10BaseT).
  81 .Pp
  82 The
  83 .Cd flags
  84 are a bit field, and are summarized as follows:
  85 .Bl -tag -width indent
  86 .It Li 0x01
  87 Disable transceiver.
  88 On those cards which support it, this flag causes the transceiver to
  89 be disabled and the AUI connection to be used by default.
  90 .It Li 0x02
  91 Force 8bit mode.
  92 This flag forces the card to 8bit mode regardless of how the
  93 card identifies itself.
  94 This may be needed for some clones which incorrectly
  95 identify themselves as 16bit, even though they only have an 8bit interface.
  96 This flag takes precedence over force 16bit mode.
  97 .It Li 0x04
  98 Force 16bit mode.
  99 This flag forces the card to 16bit mode regardless of how the
 100 card identifies itself.
 101 This may be needed for some clones which incorrectly
 102 identify themselves as 8bit, even though they have a 16bit ISA interface.
 103 .It Li 0x08
 104 Disable transmitter multi-buffering.
 105 This flag disables the use of multiple
 106 transmit buffers and may be necessary in rare cases where packets are sent out
 107 faster than a machine on the other end can handle (as evidenced by severe packet
 108 lossage).
 109 Some
 110 .No ( non- Ns Fx
 111 :-)) machines have terrible Ethernet performance
 112 and simply cannot cope with 1100K+ data rates.
 113 Use of this flag also provides
 114 one more packet worth of receiver buffering, and on 8bit cards, this may help
 115 reduce receiver lossage.
 116 .El
 117 .Pp
 118 When using a 3c503 card, the AUI connection may be selected by specifying the
 119 .Cm link2
 120 option to
 121 .Xr ifconfig 8
 122 (BNC is the default).
 123 .Sh HARDWARE
 124 The
 125 .Nm
 126 driver supports the following Ethernet NICs:
 127 .Pp
 128 .Bl -bullet -compact
 129 .It
 130 3Com 3c503 Etherlink II
 131 .Pq Cd "options ED_3C503"
 132 .It
 133 AR-P500 Ethernet
 134 .It
 135 Accton EN1644 (old model), EN1646 (old model), EN2203 (old model) (110pin)
 136 (flags 0xd00000)
 137 .It
 138 Accton EN2212/EN2216/UE2216
 139 .It
 140 Allied Telesis CentreCOM LA100-PCM_V2
 141 .It
 142 Allied Telesis LA-98 (flags 0x000000) (PC-98)
 143 .It
 144 Allied Telesis SIC-98, SIC-98NOTE (110pin), SIU-98 (flags 0x600000) (PC-98)
 145 .It
 146 Allied Telesis SIU-98-D (flags 0x610000) (PC-98)
 147 .It
 148 AmbiCom 10BaseT card
 149 .It
 150 Bay Networks NETGEAR FA410TXC Fast Ethernet
 151 .It
 152 Belkin F5D5020 PC Card Fast Ethernet
 153 .It
 154 Billionton LM5LT-10B Ethernet/Modem PC Card
 155 .It
 156 Bromax iPort 10/100 Ethernet PC Card
 157 .It
 158 Bromax iPort 10 Ethernet PC Card
 159 .It
 160 Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX PC Card
 161 .It
 162 CNet BC40 adapter
 163 .It
 164 Compex Net-A adapter
 165 .It
 166 Compex RL2000
 167 .It
 168 Contec C-NET(98), RT-1007(98), C-NET(9N) (110pin) (flags 0xa00000) (PC-98)
 169 .It
 170 Contec C-NET(98)E-A, C-NET(98)L-A, C-NET(98)P (flags 0x300000) (PC-98)
 171 .It
 172 Corega Ether98-T (flags 0x000000) (PC-98)
 173 .It
 174 Corega Ether PCC-T/EtherII PCC-T/FEther PCC-TXF/PCC-TXD PCC-T/Fether II TXD
 175 .It
 176 Corega LAPCCTXD (TC5299J)
 177 .It
 178 CyQ've ELA-010
 179 .It
 180 DEC EtherWorks DE305
 181 .It
 182 Danpex EN-6200P2
 183 .It
 184 D-Link DE-298, DE-298P (flags 0x500000) (PC-98)
 185 .It
 186 D-Link DE-650/660
 187 .It
 188 D-Link IC-CARD/IC-CARD+ Ethernet
 189 .It
 190 ELECOM LD-98P (flags 0x500000) (PC-98)
 191 .It
 192 ELECOM LD-BDN, LD-NW801G (flags 0x200000) (PC-98)
 193 .It
 194 ELECOM Laneed LD-CDL/TX, LD-CDF, LD-CDS, LD-10/100CD, LD-CDWA (DP83902A)
 195 .It
 196 Hawking PN652TX PC Card (AX88790)
 197 .It
 198 HP PC Lan+ 27247B and 27252A
 199 .Pq Cd "options ED_HPP"
 200 .It
 201 IBM Creditcard Ethernet I/II
 202 .It
 203 ICM AD-ET2-T, DT-ET-25, DT-ET-T5, IF-2766ET, IF-2771ET, NB-ET-T (110pin)
 204 (flags 0x500000) (PC-98)
 205 .It
 206 I-O DATA LA/T-98, LA/T-98SB, LA2/T-98, ET/T-98 (flags 0x900000) (PC-98)
 207 .It
 208 I-O DATA ET2/T-PCI
 209 .It
 210 I-O DATA PCLATE
 211 .It
 212 Kansai KLA-98C/T (flags 0x900000) (PC-98)
 213 .It
 214 Kingston KNE-PC2, CIO10T, KNE-PCM/x Ethernet
 215 .It
 216 KTI ET32P2 PCI
 217 .It
 218 Linksys EC2T/PCMPC100/PCM100, PCMLM56
 219 .It
 220 Linksys EtherFast 10/100 PC Card, Combo PCMCIA Ethernet Card (PCMPC100 V2)
 221 .It
 222 Logitec LAN-98T (flags 0xb00000) (PC-98)
 223 .It
 224 MACNICA Ethernet ME1 for JEIDA
 225 .It
 226 MACNICA ME98 (flags 0x900000) (PC-98)
 227 .It
 228 MACNICA NE2098 (flags 0x400000) (PC-98)
 229 .It
 230 MELCO EGY-98 (flags 0x300000) (PC-98)
 231 .It
 232 MELCO LGH-98, LGY-98, LGY-98-N (110pin), IND-SP, IND-SS (flags 0x400000) (PC-98)
 233 .It
 234 MELCO LGY-PCI-TR
 235 .It
 236 MELCO LPC-T/LPC2-T/LPC2-CLT/LPC2-TX/LPC3-TX/LPC3-CLX
 237 .It
 238 NDC Ethernet Instant-Link
 239 .It
 240 NEC PC-9801-77, PC-9801-78 (flags 0x910000) (PC-98)
 241 .It
 242 NEC PC-9801-107, PC-9801-108 (flags 0x800000) (PC-98)
 243 .It
 244 National Semiconductor InfoMover NE4100
 245 .It
 246 NetGear FA-410TX
 247 .It
 248 NetVin NV5000SC
 249 .It
 250 Network Everywhere Ethernet 10BaseT PC Card
 251 .It
 252 Networld 98X3 (flags 0xd00000) (PC-98)
 253 .It
 254 Networld EC-98X, EP-98X (flags 0xd10000) (PC-98)
 255 .It
 256 New Media LANSurfer 10+56 Ethernet/Modem
 257 .It
 258 New Media LANSurfer
 259 .It
 260 Novell NE1000/NE2000/NE2100
 261 .It
 262 PLANEX ENW-8300-T
 263 .It
 264 PLANEX EN-2298-C (flags 0x200000) (PC-98)
 265 .It
 266 PLANEX EN-2298P-T, EN-2298-T (flags 0x500000) (PC-98)
 267 .It
 268 PLANEX FNW-3600-T
 269 .It
 270 Psion 10/100 LANGLOBAL Combine iT
 271 .It
 272 RealTek 8019
 273 .It
 274 RealTek 8029
 275 .It
 276 Relia Combo-L/M-56k PC Card
 277 .It
 278 SMC Elite 16 WD8013
 279 .It
 280 SMC Elite Ultra
 281 .It
 282 SMC EtherEZ98 (flags 0x000000) (PC-98)
 283 .It
 284 SMC WD8003E/WD8003EBT/WD8003S/WD8003SBT/WD8003W/WD8013EBT/WD8013W and clones
 285 .It
 286 SMC EZCard PC Card, 8040-TX, 8041-TX (AX88x90), 8041-TX V.2 (TC5299J)
 287 .It
 288 Socket LP-E, ES-1000 Ethernet/Serial, LP-E CF, LP-FE CF
 289 .It
 290 Surecom EtherPerfect EP-427
 291 .It
 292 Surecom NE-34
 293 .It
 294 TDK 3000/3400/5670 Fast Etherenet/Modem
 295 .It
 296 TDK LAK-CD031, Grey Cell GCS2000 Ethernet Card
 297 .It
 298 TDK DFL5610WS Ethernet/Modem PC Card
 299 .It
 300 Telecom Device SuperSocket RE450T
 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 .Sh DIAGNOSTICS
 311 .Bl -diag
 312 .It "ed%d: failed to clear shared memory at %x - check configuration."
 313 When the card was probed at system boot time, the
 314 .Nm
 315 driver found that it could not clear the card's shared memory.
 316 This is most commonly
 317 caused by a BIOS extension ROM being configured in the same address space as the
 318 Ethernet card's shared memory.
 319 Either find the offending card and change its BIOS
 320 ROM to be at an address that does not conflict, or change the
 321 settings in
 322 .Xr device.hints 5
 323 that the card's shared memory is mapped at a
 324 non-conflicting address.
 325 .It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
 326 The IRQ number that was specified in the
 327 .Xr device.hints 5
 328 file is not valid for the 3Com 3c503 card.
 329 The 3c503 can only be assigned to IRQs 2 through 5.
 330 .It "ed%d: Cannot find start of RAM."
 331 .It "ed%d: Cannot find any RAM, start : %d, x = %d."
 332 The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
 333 This likely indicates that the card was improperly recognized as a Gateway or that
 334 the card is defective.
 335 .It "ed: packets buffered, but transmitter idle."
 336 Indicates a logic problem in the driver.
 337 Should never happen.
 338 .It "ed%d: device timeout"
 339 Indicates that an expected transmitter interrupt did not occur.
 340 Usually caused by an
 341 interrupt conflict with another card on the ISA bus.
 342 This condition could also be caused if the kernel is configured for a
 343 different IRQ channel than the one the card is actually using.
 344 If that is the case, you will have to either reconfigure the card
 345 using a DOS utility or set the jumpers on the card appropriately.
 346 .It "ed%d: NIC memory corrupt - invalid packet length %d."
 347 Indicates that a packet was received with a packet length that was either larger than
 348 the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
 349 Usually
 350 caused by a conflict with another card on the ISA bus, but in some cases may also
 351 indicate faulty cabling.
 352 .It "ed%d: remote transmit DMA failed to complete."
 353 This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
 354 has failed to properly complete.
 355 Usually caused by the ISA bus speed being set
 356 too fast.
 357 .It "ed%d: Invalid irq configuration (%ld) must be %s for %s"
 358 Indicates the device has a different IRQ than supported or expected.
 359 .It "ed%d: Cannot locate my ports!"
 360 The device is using a different I/O port than the driver knows about.
 361 .It "ed%d: Cannot extract MAC address"
 362 Attempts to get the MAC address failed.
 363 .It "ed%d: Missing mii!"
 364 Probing for an MII bus has failed.
 365 .El
 366 .Sh CAVEATS
 367 Early revision DS8390 chips have problems.
 368 They lock up whenever the receive
 369 ring-buffer overflows.
 370 They occasionally switch the byte order
 371 of the length field in the packet ring header (several different causes
 372 of this related to an off-by-one byte alignment) - resulting in
 373 .Qq Li "NIC memory corrupt - invalid packet length"
 374 messages.
 375 The card is reset
 376 whenever these problems occur, but otherwise there is no problem with
 377 recovering from these conditions.
 378 .Pp
 379 The NIC memory access to 3Com and Novell cards is much slower than it is on
 380 WD/SMC cards; it is less than 1MB/second on 8bit boards and less than 2MB/second
 381 on the 16bit cards.
 382 This can lead to ring-buffer overruns resulting in
 383 dropped packets during heavy network traffic.
 384 .Pp
 385 16bit Compex cards identify themselves as being 8bit.
 386 While these cards will
 387 work in 8bit mode, much higher performance can be achieved by specifying
 388 .Cd "flags 0x04"
 389 (force 16bit mode) in your kernel config file.
 390 In addition, you should also specify
 391 .Cd "iosiz 16384"
 392 to take advantage of the extra 8K of shared memory that 16bit mode provides.
 393 .Sh SEE ALSO
 394 .Xr altq 4 ,
 395 .Xr arp 4 ,
 396 .Xr miibus 4 ,
 397 .Xr netintro 4 ,
 398 .Xr ng_ether 4 ,
 399 .Xr device.hints 5 ,
 400 .Xr ifconfig 8
 401 .Sh HISTORY
 402 The
 403 .Nm
 404 device driver first appeared in
 405 .Fx 1.0 .
 406 .Sh AUTHORS
 407 The
 408 .Nm
 409 device driver and this manual page were written by
 410 .An David Greenman .
 411 .Sh BUGS
 412 The
 413 .Nm
 414 driver is a bit too aggressive about resetting the card whenever any bad
 415 packets are received.
 416 As a result, it may throw out some good packets which
 417 have been received but not yet transferred from the card to main memory.
 418 .Pp
 419 The
 420 .Nm
 421 PC Card attachment supports the D-Link DMF650TX LAN/Modem card's Ethernet
 422 port only at this time.