share/man/man4/le.4

   1 .\"     $NetBSD: le.4,v 1.22 2004/10/04 19:12:52 rumble Exp $
   2 .\"
   3 .\"-
   4 .\" Copyright (c) 1992, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" This software was developed by the Computer Systems Engineering group
   8 .\" at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
   9 .\" contributed to Berkeley.
  10 .\"
  11 .\" Redistribution and use in source and binary forms, with or without
  12 .\" modification, are permitted provided that the following conditions
  13 .\" are met:
  14 .\" 1. Redistributions of source code must retain the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer.
  16 .\" 2. Redistributions in binary form must reproduce the above copyright
  17 .\"    notice, this list of conditions and the following disclaimer in the
  18 .\"    documentation and/or other materials provided with the distribution.
  19 .\" 3. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     from: Header: le.4,v 1.2 92/10/13 05:31:33 leres Exp
  36 .\"     from: @(#)le.4  8.1 (Berkeley) 6/9/93
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd February 15, 2017
  40 .Dt LE 4
  41 .Os
  42 .Sh NAME
  43 .Nm le
  44 .Nd "AMD Am7900 LANCE and Am79C9xx ILACC/PCnet Ethernet interface driver"
  45 .Sh SYNOPSIS
  46 To compile this driver into the kernel,
  47 place the following line in your
  48 kernel configuration file:
  49 .Bd -ragged -offset indent
  50 .Cd "device le"
  51 .Ed
  52 .Pp
  53 Alternatively, to load the driver as a
  54 module at boot time, place the following line in
  55 .Xr loader.conf 5 :
  56 .Bd -literal -offset indent
  57 if_le_load="YES"
  58 .Ed
  59 .Pp
  60 For ISA non-PnP adapters, the port address as well as the IRQ and the DRQ
  61 numbers have to be specified in
  62 .Pa /boot/device.hints :
  63 .Cd hint.le.0.at="isa"
  64 .Cd hint.le.0.port="0x280"
  65 .Cd hint.le.0.irq="10"
  66 .Cd hint.le.0.drq="0"
  67 .Sh DESCRIPTION
  68 The
  69 .Nm
  70 driver provides support for Ethernet adapters based on the
  71 .Tn AMD Am7990
  72 and
  73 .Tn Am79C90
  74 .Pq CMOS, pin-compatible
  75 Local Area Network Controller for Ethernet
  76 .Pq Tn LANCE
  77 chips.
  78 .Pp
  79 The
  80 .Nm
  81 driver also supports Ethernet adapters based on the
  82 .Tn AMD Am79C900
  83 Integrated Local Area Communications Controller
  84 .Pq Tn ILACC
  85 as well as the
  86 .Tn Am79C9xx PCnet
  87 family of chips, which are single-chip implementations of a
  88 .Tn LANCE
  89 chip and a DMA engine.
  90 This includes a superset of the
  91 .Tn PCI
  92 bus Ethernet chips supported by the
  93 .Xr pcn 4
  94 driver.
  95 The
  96 .Nm
  97 driver treats all of these
  98 .Tn PCI
  99 bus Ethernet chips as an
 100 .Tn AMD Am79C970 PCnet-PCI
 101 and does not support the additional features like the MII bus and burst mode of
 102 .Tn AMD Am79C971 PCnet-FAST
 103 and greater chips.
 104 Thus the
 105 .Xr pcn 4
 106 driver should be preferred for the latter.
 107 .Pp
 108 Generally, the
 109 .Nm
 110 driver aims at supporting as many different chips on as many different
 111 platforms as possible,
 112 partially at the cost of the best performance with some of these.
 113 .Pp
 114 The
 115 .Nm
 116 driver supports reception and transmission of extended frames for
 117 .Xr vlan 4 .
 118 Selective reception of multicast Ethernet frames is provided by a 64-bit mask;
 119 multicast destination addresses are hashed to a bit entry using the Ethernet
 120 CRC function.
 121 .Sh HARDWARE
 122 .Ss ISA
 123 The
 124 .Nm
 125 driver supports
 126 .Tn ISA
 127 bus Ethernet adapters which are based on the following chips:
 128 .Pp
 129 .Bl -bullet -compact
 130 .It
 131 .Tn AMD Am7990 and Am79C90 LANCE
 132 .It
 133 .Tn AMD Am79C960 PCnet-ISA
 134 .It
 135 .Tn AMD Am79C961 PCnet-ISA+
 136 .It
 137 .Tn AMD Am79C961A PCnet-ISA II
 138 .El
 139 .Pp
 140 This includes support for the following Ethernet adapters:
 141 .Pp
 142 ISA non-PnP:
 143 .Pp
 144 .Bl -bullet -compact
 145 .It
 146 .Tn BICC Isolan
 147 .\" .It
 148 .\" .Tn Digital DEPCA
 149 .It
 150 .Tn Novell NE2100
 151 .El
 152 .Pp
 153 ISA PnP:
 154 .Pp
 155 .Bl -bullet -compact
 156 .It
 157 .Tn AMD AM1500T/AM2100
 158 .It
 159 .Tn AMD PCnet-32
 160 .It
 161 .Tn AMD PCnet-ISA
 162 .It
 163 .Tn Allied Telesyn AT-1500
 164 .It
 165 .Tn Boca LANCard Combo
 166 .It
 167 .Tn Cabletron E2100 Series DNI
 168 .It
 169 .Tn Cabletron E2200 Single Chip
 170 .It
 171 .Tn Melco Inc. LGY-IV
 172 .It
 173 .Tn Novell NE2100
 174 .It
 175 .Tn Racal InterLan EtherBlaster
 176 .El
 177 .Pp
 178 The
 179 .Nm
 180 driver does not support the selection of media types and options via
 181 .Xr ifconfig 8
 182 with
 183 .Tn ISA
 184 bus Ethernet adapters.
 185 .Ss PCI
 186 The
 187 .Tn PCI
 188 bus Ethernet chips supported by the
 189 .Nm
 190 driver are:
 191 .Pp
 192 .Bl -bullet -compact
 193 .It
 194 .Tn AMD Am53C974/Am79C970/Am79C974 PCnet-PCI
 195 .It
 196 .Tn AMD Am79C970A PCnet-PCI II
 197 .It
 198 .Tn AMD Am79C971 PCnet-FAST
 199 .It
 200 .Tn AMD Am79C972 PCnet-FAST+
 201 .It
 202 .Tn AMD Am79C973/Am79C975 PCnet-FAST III
 203 .It
 204 .Tn AMD Am79C976 PCnet-PRO
 205 .It
 206 .Tn AMD Am79C978 PCnet-Home
 207 .El
 208 .Pp
 209 This includes support for the following Ethernet adapters:
 210 .Pp
 211 .Bl -bullet -compact
 212 .It
 213 .Tn AcerLAN NIC P20
 214 .It
 215 .Tn Allied Telesyn AT-2450 and AT-2700 series
 216 .It
 217 .Tn VMware emulated AMD Am79C970A PCnet-PCI II interface
 218 .El
 219 .Pp
 220 The
 221 .Nm
 222 driver supports the selection of the following media types via
 223 .Xr ifconfig 8
 224 with
 225 .Tn PCI
 226 bus Ethernet adapters:
 227 .Bl -tag -width ".Cm 10base5/AUI"
 228 .It Cm autoselect
 229 Enable autoselection of the media type.
 230 .It Cm 10baseT/UTP
 231 Select UTP media.
 232 .It Cm 10base5/AUI
 233 Select AUI/BNC media.
 234 .El
 235 .Pp
 236 The following media option is supported with these media types:
 237 .Bl -tag -width ".Cm full-duplex"
 238 .It Cm full-duplex
 239 Select full duplex operation.
 240 .El
 241 .Pp
 242 Note that unlike the
 243 .Xr pcn 4
 244 driver, the
 245 .Nm
 246 driver does not support selecting 100Mbps (Fast Ethernet) media types.
 247 .Sh DIAGNOSTICS
 248 .Bl -diag
 249 .It "le%d: overflow"
 250 More packets came in from the Ethernet than there was space in the
 251 .Tn LANCE
 252 receive buffers.
 253 Packets were missed.
 254 .It "le%d: receive buffer error"
 255 The
 256 .Tn LANCE
 257 ran out of buffer space, packet dropped.
 258 .It "le%d: lost carrier"
 259 The Ethernet carrier disappeared during an attempt to transmit.
 260 The
 261 .Tn LANCE
 262 will finish transmitting the current packet,
 263 but will not automatically retry transmission if there is a collision.
 264 .It "le%d: excessive collisions, tdr %d"
 265 The Ethernet was extremely busy or jammed,
 266 outbound packets were dropped after 16 attempts to retransmit.
 267 .Pp
 268 TDR
 269 is the abbreviation of
 270 .Qq Time Domain Reflectometry .
 271 The optionally reported TDR value is an internal counter of the interval
 272 between the start of a transmission and the occurrence of a collision.
 273 This value can be used to determine the distance from the Ethernet tap to
 274 the point on the Ethernet cable that is shorted or open (unterminated).
 275 .It "le%d: dropping chained buffer"
 276 A packet did not fit into a single receive buffer and was dropped.
 277 Since the
 278 .Nm
 279 driver allocates buffers large enough to receive maximum sized Ethernet
 280 packets, this means some other station on the LAN transmitted a packet
 281 larger than allowed by the Ethernet standard.
 282 .It "le%d: transmit buffer error"
 283 The
 284 .Tn LANCE
 285 ran out of buffer space before finishing the transmission of a packet.
 286 If this error occurs, the driver software has a bug.
 287 .It "le%d: underflow"
 288 The
 289 .Tn LANCE
 290 ran out of buffer space before finishing the transmission of a packet.
 291 If this error occurs, the driver software has a bug.
 292 .It "le%d: controller failed to initialize"
 293 Driver failed to start the
 294 .Tn LANCE .
 295 This is potentially a hardware failure.
 296 .It "le%d: memory error"
 297 RAM failed to respond within the timeout when the
 298 .Tn LANCE
 299 wanted to read or write it.
 300 This is potentially a hardware failure.
 301 .It "le%d: receiver disabled"
 302 The receiver of the
 303 .Tn LANCE
 304 was turned off due to an error.
 305 .It "le%d: transmitter disabled"
 306 The transmitter of the
 307 .Tn LANCE
 308 was turned off due to an error.
 309 .El
 310 .Sh SEE ALSO
 311 .Xr altq 4 ,
 312 .Xr arp 4 ,
 313 .Xr intro 4 ,
 314 .Xr netintro 4 ,
 315 .Xr pcn 4 ,
 316 .Xr vlan 4 ,
 317 .Xr ifconfig 8
 318 .Sh HISTORY
 319 The
 320 .Nm
 321 driver was ported from
 322 .Nx
 323 and first appeared in
 324 .Fx 6.1 .
 325 The
 326 .Nx
 327 version in turn was derived from the
 328 .Nm
 329 driver which first appeared in
 330 .Bx 4.4 .
 331 .Sh AUTHORS
 332 The
 333 .Nm
 334 driver was ported by
 335 .An Marius Strobl Aq Mt marius@FreeBSD.org .
 336 .\" .Sh BUGS
 337 .\" The Am7990 Revision C chips have a bug which causes garbage to be inserted
 338 .\" in front of the received packet occasionally.
 339 .\" The work-around is to ignore packets with an invalid destination address
 340 .\" (garbage will usually not match), by double-checking the destination
 341 .\" address of every packet in the driver.
 342 .\" This work-around can be enabled with the
 343 .\" .Dv LANCE_REVC_BUG
 344 .\" kernel option.
 345 .\" .Pp
 346 .\" When
 347 .\" .Dv LANCE_REVC_BUG
 348 .\" is enabled, the
 349 .\" .Nm
 350 .\" driver executes one or two calls to an inline Ethernet address comparison
 351 .\" function for every received packet.
 352 .\" On the
 353 .\" .Tn MC68000
 354 .\" it is exactly eight instructions of 16 bits each.
 355 .\" There is one comparison for each unicast packet, and two comparisons for
 356 .\" each broadcast packet.
 357 .\" .Pp
 358 .\" In summary, the cost of the LANCE_REVC_BUG option is:
 359 .\" .Bl -enum -compact
 360 .\" .It
 361 .\" loss of multicast support, and
 362 .\" .It
 363 .\" eight extra
 364 .\" .Tn CPU
 365 .\" instructions per received packet, sometimes sixteen, depending on both the
 366 .\" processor, and the type of packet.
 367 .\" .El
 368 .\" .Pp
 369 .\" All sun3 systems are presumed to have this bad revision of the Am7990,
 370 .\" until proven otherwise.
 371 .\" Alas, the only way to prove what revision of the chip is in a particular
 372 .\" system is inspection of the date code on the chip package,
 373 .\" to compare against a list of what chip revisions were fabricated between
 374 .\" which dates.
 375 .\" .Pp
 376 .\" Alas, the Am7990 chip is so old that
 377 .\" .Tn AMD
 378 .\" has
 379 .\" .Qq de-archived
 380 .\" the production information about it; pending a search elsewhere, we do not
 381 .\" know how to identify the revision C chip from the date codes.