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