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: src/share/man/man4/ed.4,v 1.19.2.10 2003/02/17 21:20:39 trhodes Exp $
  32 .\"
  33 .Dd October 28, 1995
  34 .Dt ED 4
  35 .Os
  36 .Sh NAME
  37 .Nm ed
  38 .Nd ethernet device driver
  39 .Sh SYNOPSIS
  40 .Cd "device miibus"
  41 .Cd "device ed0 at isa? port 0x280 irq 5 iomem 0xd8000"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 driver provides support for 8 and 16bit ethernet cards that are based on
  46 the National Semiconductor DS8390 and similar NICs manufactured by other companies.
  47 .Pp
  48 It supports all 80x3 series ethernet cards manufactured by Western Digital and SMC,
  49 the SMC Ultra, the 3Com 3c503, the Novell NE1000/NE2000 and compatible cards,
  50 the HP PC Lan+ and the Digital Equipment EtherWorks DE305 card.
  51 ISA, PCI and PC Card devices are supported.
  52 .Pp
  53 The
  54 .Nm
  55 driver uses a unique multi-buffering mechanism to achieve high transmit performance.
  56 When using 16bit ISA cards, as high as 97% of the theoretical maximum performance of
  57 the IEEE 802.3 CSMA ethernet is possible.
  58 .Pp
  59 In addition to the standard port and IRQ specifications, the
  60 .Nm
  61 driver also supports a number of
  62 .Cd flags
  63 which can force 8/16bit mode, enable/disable multi-buffering, and select the default
  64 interface type (AUI/BNC, and for cards with twisted pair, AUI/10BaseT).
  65 .Pp
  66 The
  67 .Cd flags
  68 are a bit field, and are summarized as follows:
  69 .Bl -tag -width indent
  70 .It Li 0x01
  71 Disable transceiver.
  72 On those cards which support it, this flag causes the transceiver to
  73 be disabled and the AUI connection to be used by default.
  74 .It Li 0x02
  75 Force 8bit mode.
  76 This flag forces the card to 8bit mode regardless of how the
  77 card identifies itself.
  78 This may be needed for some clones which incorrectly
  79 identify themselves as 16bit, even though they only have an 8bit interface.
  80 .It Li 0x04
  81 Force 16bit mode.
  82 This flag forces the card to 16bit mode regardless of how the
  83 card identifies itself.
  84 This may be needed for some clones which incorrectly
  85 identify themselves as 8bit, even though they have a 16bit ISA interface.
  86 .It Li 0x08
  87 Disable transmitter multi-buffering.
  88 This flag disables the use of multiple
  89 transmit buffers and may be necessary in rare cases where packets are sent out
  90 faster than a machine on the other end can handle (as evidenced by severe packet
  91 lossage).
  92 Some
  93 .No ( non- Ns Fx
  94 :-)) machines have terrible ethernet performance
  95 and simply can't cope with 1100K+ data rates.
  96 Use of this flag also provides
  97 one more packet worth of receiver buffering, and on 8bit cards, this may help
  98 reduce receiver lossage.
  99 .El
 100 .Pp
 101 When using a 3c503 card, the AUI connection may be selected by specifying the
 102 .Cm link2
 103 option to
 104 .Xr ifconfig 8
 105 (BNC is the default).
 106 .Sh DIAGNOSTICS
 107 .Bl -diag
 108 .It "ed%d: kernel configured irq %d doesn't match board configured irq %d."
 109 The IRQ number that was specified in the kernel config file (and then compiled
 110 into the kernel) differs from the IRQ that has been set on the interface card.
 111 .It "ed%d: failed to clear shared memory at %x - check configuration."
 112 When the card was probed at system boot time, the
 113 .Nm
 114 driver found that it could not clear the card's shared memory.
 115 This is most commonly
 116 caused by a BIOS extension ROM being configured in the same address space as the
 117 ethernet card's shared memory.
 118 Either find the offending card and change its BIOS
 119 ROM to be at an address that doesn't conflict, or change the
 120 .Cd iomem
 121 option in the kernel config file so that the card's shared memory is mapped at a
 122 non-conflicting address.
 123 .It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
 124 The IRQ number that was specified in the kernel config file is not valid for
 125 the 3Com 3c503 card.
 126 The 3c503 can only be assigned to IRQs 2 through 5.
 127 .It "ed%d: Cannot find start of RAM."
 128 .It "ed%d: Cannot find any RAM, start : %d, x = %d."
 129 The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
 130 This likely indicates that the card was improperly recognized as a Gateway or that
 131 the card is defective.
 132 .It "ed: packets buffered, but transmitter idle."
 133 Indicates a logic problem in the driver.
 134 Should never happen.
 135 .It "ed%d: device timeout"
 136 Indicates that an expected transmitter interrupt didn't occur.
 137 Usually caused by an
 138 interrupt conflict with another card on the ISA bus.
 139 This condition could also be caused if the kernel is configured for a
 140 different IRQ channel than the one the card is actually using.
 141 If that is the case, you will have to either reconfigure the card
 142 using a DOS utility or set the jumpers on the card appropriately.
 143 .It "ed%d: NIC memory corrupt - invalid packet length %d."
 144 Indicates that a packet was received with a packet length that was either larger than
 145 the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
 146 Usually
 147 caused by a conflict with another card on the ISA bus, but in some cases may also
 148 indicate faulty cabling.
 149 .It "ed%d: remote transmit DMA failed to complete."
 150 This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
 151 has failed to properly complete.
 152 Usually caused by the ISA bus speed being set
 153 too fast.
 154 .El
 155 .Sh CAVEATS
 156 Early revision DS8390 chips have problems.
 157 They lock up whenever the receive
 158 ring-buffer overflows.
 159 They occasionally switch the byte order
 160 of the length field in the packet ring header (several different causes
 161 of this related to an off-by-one byte alignment) - resulting in
 162 .Qq Li "NIC memory corrupt - invalid packet length"
 163 messages.
 164 The card is reset
 165 whenever these problems occur, but otherwise there is no problem with
 166 recovering from these conditions.
 167 .Pp
 168 The NIC memory access to 3Com and Novell cards is much slower than it is on
 169 WD/SMC cards; it's less than 1MB/second on 8bit boards and less than 2MB/second
 170 on the 16bit cards.
 171 This can lead to ring-buffer overruns resulting in
 172 dropped packets during heavy network traffic.
 173 .Pp
 174 16bit Compex cards identify themselves as being 8bit.
 175 While these cards will
 176 work in 8bit mode, much higher performance can be achieved by specifying
 177 .Cd "flags 0x04"
 178 (force 16bit mode) in your kernel config file.
 179 In addition, you should also specify
 180 .Cd "iosiz 16384"
 181 to take advantage of the extra 8K of shared memory that 16bit mode provides.
 182 .Sh BUGS
 183 The
 184 .Nm
 185 driver is a bit too aggressive about resetting the card whenever any bad
 186 packets are received.
 187 As a result, it may throw out some good packets which
 188 have been received but not yet transfered from the card to main memory.
 189 .Sh SEE ALSO
 190 .Xr arp 4 ,
 191 .Xr miibus 4 ,
 192 .Xr netintro 4 ,
 193 .Xr ng_ether 4 ,
 194 .Xr ifconfig 8
 195 .Sh HISTORY
 196 The
 197 .Nm
 198 device driver first appeared in
 199 .Fx 1.0 .
 200 .Sh AUTHORS
 201 The
 202 .Nm
 203 device driver and this manual page were written by
 204 .An David Greenman .