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