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