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 .Ss sparc64
 248 The
 249 .Nm
 250 driver supports the on-board
 251 .Tn LANCE
 252 interfaces found in
 253 .Tn Sun Ultra 1
 254 machines.
 255 The
 256 .Nm
 257 driver allows the selection of the following media types via
 258 .Xr ifconfig 8
 259 with these on-board interfaces:
 260 .Bl -tag -width ".Cm 10base5/AUI"
 261 .It Cm autoselect
 262 Enable autoselection of the media type.
 263 .It Cm 10baseT/UTP
 264 Select UTP media.
 265 .It Cm 10base5/AUI
 266 Select AUI media.
 267 .El
 268 .Pp
 269 When using autoselection, a default media type is selected for use by
 270 examining all ports for carrier.
 271 The first media type with which a carrier is detected will be selected.
 272 Additionally, if carrier is dropped on a port, the driver will switch
 273 between the possible ports until one with carrier is found.
 274 .Pp
 275 The
 276 .Nm
 277 driver also supports the following
 278 .Tn Sun SBus
 279 Ethernet add-on adapters:
 280 .Pp
 281 .Bl -bullet -compact
 282 .It
 283 .Tn SCSI HBA and Buffered Ethernet
 284 .Pq SBE/S, P/N 501-1869
 285 .It
 286 .Tn Fast SCSI and Buffered Ethernet
 287 .Pq FSBE/S, P/N 501-2015 and 501-2981
 288 .El
 289 .Pp
 290 The
 291 .Nm
 292 driver does not support the selection of media types and options via
 293 .Xr ifconfig 8
 294 with
 295 .Tn SBus
 296 Ethernet add-on adapters.
 297 .Pp
 298 For further information on configuring media types and options, see
 299 .Xr ifconfig 8 .
 300 .Sh DIAGNOSTICS
 301 .Bl -diag
 302 .It "le%d: overflow"
 303 More packets came in from the Ethernet than there was space in the
 304 .Tn LANCE
 305 receive buffers.
 306 Packets were missed.
 307 .It "le%d: receive buffer error"
 308 The
 309 .Tn LANCE
 310 ran out of buffer space, packet dropped.
 311 .It "le%d: lost carrier"
 312 The Ethernet carrier disappeared during an attempt to transmit.
 313 The
 314 .Tn LANCE
 315 will finish transmitting the current packet,
 316 but will not automatically retry transmission if there is a collision.
 317 .It "le%d: excessive collisions, tdr %d"
 318 The Ethernet was extremely busy or jammed,
 319 outbound packets were dropped after 16 attempts to retransmit.
 320 .Pp
 321 TDR
 322 is the abbreviation of
 323 .Qq Time Domain Reflectometry .
 324 The optionally reported TDR value is an internal counter of the interval
 325 between the start of a transmission and the occurrence of a collision.
 326 This value can be used to determine the distance from the Ethernet tap to
 327 the point on the Ethernet cable that is shorted or open (unterminated).
 328 .It "le%d: dropping chained buffer"
 329 A packet did not fit into a single receive buffer and was dropped.
 330 Since the
 331 .Nm
 332 driver allocates buffers large enough to receive maximum sized Ethernet
 333 packets, this means some other station on the LAN transmitted a packet
 334 larger than allowed by the Ethernet standard.
 335 .It "le%d: transmit buffer error"
 336 The
 337 .Tn LANCE
 338 ran out of buffer space before finishing the transmission of a packet.
 339 If this error occurs, the driver software has a bug.
 340 .It "le%d: underflow"
 341 The
 342 .Tn LANCE
 343 ran out of buffer space before finishing the transmission of a packet.
 344 If this error occurs, the driver software has a bug.
 345 .It "le%d: controller failed to initialize"
 346 Driver failed to start the
 347 .Tn LANCE .
 348 This is potentially a hardware failure.
 349 .It "le%d: memory error"
 350 RAM failed to respond within the timeout when the
 351 .Tn LANCE
 352 wanted to read or write it.
 353 This is potentially a hardware failure.
 354 .It "le%d: receiver disabled"
 355 The receiver of the
 356 .Tn LANCE
 357 was turned off due to an error.
 358 .It "le%d: transmitter disabled"
 359 The transmitter of the
 360 .Tn LANCE
 361 was turned off due to an error.
 362 .El
 363 .Sh SEE ALSO
 364 .Xr altq 4 ,
 365 .Xr arp 4 ,
 366 .Xr intro 4 ,
 367 .Xr netintro 4 ,
 368 .Xr pcn 4 ,
 369 .Xr vlan 4 ,
 370 .Xr ifconfig 8
 371 .Sh HISTORY
 372 The
 373 .Nm
 374 driver was ported from
 375 .Nx
 376 and first appeared in
 377 .Fx 6.1 .
 378 The
 379 .Nx
 380 version in turn was derived from the
 381 .Nm
 382 driver which first appeared in
 383 .Bx 4.4 .
 384 .Sh AUTHORS
 385 The
 386 .Nm
 387 driver was ported by
 388 .An Marius Strobl Aq Mt marius@FreeBSD.org .
 389 .\" .Sh BUGS
 390 .\" The Am7990 Revision C chips have a bug which causes garbage to be inserted
 391 .\" in front of the received packet occasionally.
 392 .\" The work-around is to ignore packets with an invalid destination address
 393 .\" (garbage will usually not match), by double-checking the destination
 394 .\" address of every packet in the driver.
 395 .\" This work-around can be enabled with the
 396 .\" .Dv LANCE_REVC_BUG
 397 .\" kernel option.
 398 .\" .Pp
 399 .\" When
 400 .\" .Dv LANCE_REVC_BUG
 401 .\" is enabled, the
 402 .\" .Nm
 403 .\" driver executes one or two calls to an inline Ethernet address comparison
 404 .\" function for every received packet.
 405 .\" On the
 406 .\" .Tn MC68000
 407 .\" it is exactly eight instructions of 16 bits each.
 408 .\" There is one comparison for each unicast packet, and two comparisons for
 409 .\" each broadcast packet.
 410 .\" .Pp
 411 .\" In summary, the cost of the LANCE_REVC_BUG option is:
 412 .\" .Bl -enum -compact
 413 .\" .It
 414 .\" loss of multicast support, and
 415 .\" .It
 416 .\" eight extra
 417 .\" .Tn CPU
 418 .\" instructions per received packet, sometimes sixteen, depending on both the
 419 .\" processor, and the type of packet.
 420 .\" .El
 421 .\" .Pp
 422 .\" All sun3 systems are presumed to have this bad revision of the Am7990,
 423 .\" until proven otherwise.
 424 .\" Alas, the only way to prove what revision of the chip is in a particular
 425 .\" system is inspection of the date code on the chip package,
 426 .\" to compare against a list of what chip revisions were fabricated between
 427 .\" which dates.
 428 .\" .Pp
 429 .\" Alas, the Am7990 chip is so old that
 430 .\" .Tn AMD
 431 .\" has
 432 .\" .Qq de-archived
 433 .\" the production information about it; pending a search elsewhere, we do not
 434 .\" know how to identify the revision C chip from the date codes.