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 AmbiCom 10BaseT card (8002, 8002T, 8010 and 8610)
 137 .It
 138 Bay Networks NETGEAR FA410TXC Fast Ethernet
 139 .It
 140 Belkin F5D5020 PC Card Fast Ethernet
 141 .It
 142 Billionton LM5LT-10B Ethernet/Modem PC Card
 143 .It
 144 Billionton LNT-10TB, LNT-10TN Ethernet PC Card
 145 .It
 146 Bromax iPort 10/100 Ethernet PC Card
 147 .It
 148 Bromax iPort 10 Ethernet PC Card
 149 .It
 150 Buffalo LPC2-CLT, LPC3-CLT, LPC3-CLX, LPC4-TX, LPC-CTX PC Card
 151 .It
 152 Buffalo LPC-CF-CLT CF Card
 153 .It
 154 CNet BC40 adapter
 155 .It
 156 Compex Net-A adapter
 157 .It
 158 Compex RL2000
 159 .It
 160 Corega Ether PCC-T/EtherII PCC-T/FEther PCC-TXF/PCC-TXD PCC-T/Fether II TXD
 161 .It
 162 Corega LAPCCTXD (TC5299J)
 163 .It
 164 CyQ've ELA-010
 165 .It
 166 DEC EtherWorks DE305
 167 .It
 168 Danpex EN-6200P2
 169 .It
 170 D-Link DE-660, DE-660+
 171 .It
 172 D-Link IC-CARD/IC-CARD+ Ethernet
 173 .It
 174 ELECOM Laneed LD-CDL/TX, LD-CDF, LD-CDS, LD-10/100CD, LD-CDWA (DP83902A)
 175 .It
 176 Hawking PN652TX PC Card (AX88790)
 177 .It
 178 HP PC Lan+ 27247B and 27252A
 179 .Pq Cd "options ED_HPP"
 180 .It
 181 IBM Creditcard Ethernet I/II
 182 .It
 183 I-O DATA ET2/T-PCI
 184 .It
 185 I-O DATA PCLATE
 186 .It
 187 Kingston KNE-PC2, CIO10T, KNE-PCM/x Ethernet
 188 .It
 189 KTI ET32P2 PCI
 190 .It
 191 Linksys EC2T/PCMPC100/PCM100, PCMLM56
 192 .It
 193 Linksys EtherFast 10/100 PC Card, Combo PCMCIA Ethernet Card (PCMPC100 V2)
 194 .It
 195 MACNICA Ethernet ME1 for JEIDA
 196 .It
 197 MELCO LGY-PCI-TR
 198 .It
 199 MELCO LPC-T/LPC2-T/LPC2-CLT/LPC2-TX/LPC3-TX/LPC3-CLX
 200 .It
 201 NDC Ethernet Instant-Link
 202 .It
 203 National Semiconductor InfoMover NE4100
 204 .It
 205 NetGear FA-410TX
 206 .It
 207 NetVin NV5000SC
 208 .It
 209 Network Everywhere Ethernet 10BaseT PC Card
 210 .It
 211 New Media LANSurfer 10+56 Ethernet/Modem
 212 .It
 213 New Media LANSurfer
 214 .It
 215 Novell NE1000/NE2000/NE2100
 216 .It
 217 PLANEX ENW-8300-T
 218 .It
 219 PLANEX FNW-3600-T
 220 .It
 221 Psion 10/100 LANGLOBAL Combine iT
 222 .It
 223 RealTek 8019
 224 .It
 225 RealTek 8029
 226 .It
 227 Relia Combo-L/M-56k PC Card
 228 .It
 229 SMC Elite 16 WD8013
 230 .It
 231 SMC Elite Ultra
 232 .It
 233 SMC WD8003E/WD8003EBT/WD8003S/WD8003SBT/WD8003W/WD8013EBT/WD8013W and clones
 234 .It
 235 SMC EZCard PC Card, 8040-TX, 8041-TX (AX88x90), 8041-TX V.2 (TC5299J)
 236 .It
 237 Socket LP-E, ES-1000 Ethernet/Serial, LP-E CF, LP-FE CF
 238 .It
 239 Surecom EtherPerfect EP-427
 240 .It
 241 Surecom NE-34
 242 .It
 243 TDK 3000/3400/5670 Fast Ethernet/Modem
 244 .It
 245 TDK LAK-CD031, Grey Cell GCS2000 Ethernet Card
 246 .It
 247 TDK DFL5610WS Ethernet/Modem PC Card
 248 .It
 249 Telecom Device SuperSocket RE450T
 250 .It
 251 Toshiba LANCT00A PC Card
 252 .It
 253 VIA VT86C926
 254 .It
 255 Winbond W89C940
 256 .It
 257 Winbond W89C940F
 258 .El
 259 .Pp
 260 ISA, PCI and PC Card devices are supported.
 261 .Pp
 262 The
 263 .Nm
 264 driver does not support the following Ethernet NICs:
 265 .Pp
 266 .Bl -bullet -compact
 267 .It
 268 Mitsubishi LAN Adapter B8895
 269 .El
 270 .Sh DIAGNOSTICS
 271 .Bl -diag
 272 .It "ed%d: failed to clear shared memory at %x - check configuration."
 273 When the card was probed at system boot time, the
 274 .Nm
 275 driver found that it could not clear the card's shared memory.
 276 This is most commonly
 277 caused by a BIOS extension ROM being configured in the same address space as the
 278 Ethernet card's shared memory.
 279 Either find the offending card and change its BIOS
 280 ROM to be at an address that does not conflict, or change the
 281 settings in
 282 .Xr device.hints 5
 283 that the card's shared memory is mapped at a
 284 non-conflicting address.
 285 .It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
 286 The IRQ number that was specified in the
 287 .Xr device.hints 5
 288 file is not valid for the 3Com 3c503 card.
 289 The 3c503 can only be assigned to IRQs 2 through 5.
 290 .It "ed%d: Cannot find start of RAM."
 291 .It "ed%d: Cannot find any RAM, start : %d, x = %d."
 292 The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
 293 This likely indicates that the card was improperly recognized as a Gateway or that
 294 the card is defective.
 295 .It "ed: packets buffered, but transmitter idle."
 296 Indicates a logic problem in the driver.
 297 Should never happen.
 298 .It "ed%d: device timeout"
 299 Indicates that an expected transmitter interrupt did not occur.
 300 Usually caused by an
 301 interrupt conflict with another card on the ISA bus.
 302 This condition could also be caused if the kernel is configured for a
 303 different IRQ channel than the one the card is actually using.
 304 If that is the case, you will have to either reconfigure the card
 305 using a DOS utility or set the jumpers on the card appropriately.
 306 .It "ed%d: NIC memory corrupt - invalid packet length %d."
 307 Indicates that a packet was received with a packet length that was either larger than
 308 the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
 309 Usually
 310 caused by a conflict with another card on the ISA bus, but in some cases may also
 311 indicate faulty cabling.
 312 .It "ed%d: remote transmit DMA failed to complete."
 313 This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
 314 has failed to properly complete.
 315 Usually caused by the ISA bus speed being set
 316 too fast.
 317 .It "ed%d: Invalid irq configuration (%ld) must be %s for %s"
 318 Indicates the device has a different IRQ than supported or expected.
 319 .It "ed%d: Cannot locate my ports!"
 320 The device is using a different I/O port than the driver knows about.
 321 .It "ed%d: Cannot extract MAC address"
 322 Attempts to get the MAC address failed.
 323 .It "ed%d: Missing mii!"
 324 Probing for an MII bus has failed.
 325 This indicates a coding error in the PC Card attachment, because a PHY
 326 is required for the chips that generate this error message.
 327 .El
 328 .Sh SEE ALSO
 329 .Xr altq 4 ,
 330 .Xr arp 4 ,
 331 .Xr miibus 4 ,
 332 .Xr netintro 4 ,
 333 .Xr ng_ether 4 ,
 334 .Xr device.hints 5 ,
 335 .Xr ifconfig 8
 336 .Sh HISTORY
 337 The
 338 .Nm
 339 device driver first appeared in
 340 .Fx 1.0 .
 341 .Sh AUTHORS
 342 The
 343 .Nm
 344 device driver and this manual page were written by
 345 .An David Greenman .
 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 The Mitsubishi B8895 PC Card uses a DP83902, but its ASIC part is
 366 undocumented.
 367 Neither the NE2000 nor the WD83x0 drivers work with this card.
 368 .Sh BUGS
 369 The
 370 .Nm
 371 driver is a bit too aggressive about resetting the card whenever any bad
 372 packets are received.
 373 As a result, it may throw out some good packets which
 374 have been received but not yet transferred from the card to main memory.
 375 .Pp
 376 The
 377 .Nm
 378 driver is slow by today's standards.
 379 .Pp
 380 PC Card attachment supports the D-Link DMF650TX LAN/Modem card's Ethernet
 381 port only at this time.
 382 .Pp
 383 Some devices supported by
 384 .Nm
 385 do not generate the link state change events used by
 386 .Xr devd 8
 387 to start
 388 .Xr dhclient 8 .
 389 If you have problems with
 390 .Xr dhclient 8
 391 not starting and the device is always attached to the network it may
 392 be possible to work around this by changing
 393 .Dq Li DHCP
 394 to
 395 .Dq Li SYNCDHCP
 396 in the
 397 .Va ifconfig_ed0
 398 entry in
 399 .Pa /etc/rc.conf .