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 January 30, 2006
  40 .Dt LE 4
  41 .Os
  42 .Sh NAME
  43 .Nm le
  44 .Nd "AMD Am7900 LANCE and Am79C9xx 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 .\" In
  61 .\" .Pa /boot/device.hints :
  62 .\" .Cd hint.le.0.at="isa"
  63 .\" .Cd hint.le.0.port="0x280"
  64 .\" .Cd hint.le.0.irq="10"
  65 .\" .Cd hint.le.0.drq="0"
  66 .Sh DESCRIPTION
  67 The
  68 .Nm
  69 driver provides support for Ethernet adapters based on the
  70 .Tn AMD
  71 Am7990 and Am79C90 (CMOS, pin-compatible)
  72 Local Area Network Controller for Ethernet
  73 .Pq Tn LANCE
  74 chip set.
  75 .Pp
  76 The
  77 .Nm
  78 driver also supports PCnet adapters based on the
  79 .Tn AMD 79C9xx
  80 family of chips, which are single-chip implementations of a
  81 .Tn LANCE
  82 chip and a DMA engine.
  83 This includes a superset of the
  84 .Tn PCI
  85 bus Ethernet chip sets supported by the
  86 .Xr pcn 4
  87 driver.
  88 The
  89 .Nm
  90 driver treats all of these
  91 .Tn PCI
  92 bus Ethernet chip sets as an
  93 .Tn AMD Am79C970 PCnet-PCI
  94 and does not support the additional features like the MII bus and burst mode of
  95 .Tn AMD Am79C971 PCnet-FAST
  96 and greater chip sets.
  97 Thus the
  98 .Xr pcn 4
  99 driver should be preferred for the latter.
 100 .Pp
 101 The
 102 .Nm
 103 driver supports reception and transmission of extended frames for
 104 .Xr vlan 4 .
 105 Selective reception of multicast Ethernet frames is provided by a 64-bit mask;
 106 multicast destination addresses are hashed to a bit entry using the Ethernet
 107 CRC function.
 108 .Sh HARDWARE
 109 .\" .Ss ISA
 110 .\" The
 111 .\" .Tn ISA
 112 .\" bus Ethernet cards supported by the
 113 .\" .Nm
 114 .\" driver are:
 115 .\" .Pp
 116 .\" .Bl -bullet -compact
 117 .\" .It
 118 .\" .Tn BICC Isolan
 119 .\" .It
 120 .\" .Tn Novell NE2100
 121 .\" .It
 122 .\" .Tn Digital DEPCA
 123 .\" .El
 124 .\" .Ss EISA
 125 .\" The
 126 .\" .Tn EISA
 127 .\" bus Ethernet cards supported by the
 128 .\" .Nm
 129 .\" driver are:
 130 .\" .Pp
 131 .\" .Bl -bullet -compact
 132 .\" .It
 133 .\" .Tn DEC DE422
 134 .\" .El
 135 .\" .Ss MCA
 136 .\" The
 137 .\" .Tn MCA
 138 .\" bus Ethernet cards supported by the
 139 .\" .Nm
 140 .\" driver are:
 141 .\" .Pp
 142 .\" .Bl -bullet -compact
 143 .\" .It
 144 .\" .Tn SKNET Personal MC2
 145 .\" .It
 146 .\" .Tn SKNET MC2+
 147 .\" .El
 148 .Ss PCI
 149 The
 150 .Tn PCI
 151 bus Ethernet chip sets supported by the
 152 .Nm
 153 driver are:
 154 .Pp
 155 .Bl -bullet -compact
 156 .It
 157 .Tn AMD Am53C974/Am79C970/Am79C974 PCnet-PCI
 158 .It
 159 .Tn AMD Am79C970A PCnet-PCI II
 160 .It
 161 .Tn AMD Am79C971 PCnet-FAST
 162 .It
 163 .Tn AMD Am79C972 PCnet-FAST+
 164 .It
 165 .Tn AMD Am79C973/Am79C975 PCnet-FAST III
 166 .It
 167 .Tn AMD Am79C976 PCnet-PRO
 168 .It
 169 .Tn AMD Am79C978 PCnet-Home
 170 .El
 171 .Pp
 172 The
 173 .Nm
 174 driver supports the following media types with these chip sets:
 175 .Pp
 176 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 177 .It autoselect
 178 Enable autoselection of the media type.
 179 .It 10baseT/UTP
 180 Select UTP media.
 181 .It 10base5/AUI
 182 Select AUI/BNC media.
 183 .El
 184 .Pp
 185 The following media option is supported with these media types:
 186 .Pp
 187 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 188 .It full-duplex
 189 Select full duplex operation.
 190 .El
 191 .Pp
 192 Note that unlike the
 193 .Xr pcn 4
 194 driver, the
 195 .Nm
 196 driver does not support selecting 100Mbps (Fast Ethernet) media types.
 197 .Ss sparc64
 198 The
 199 .Nm
 200 driver supports the on-board
 201 .Tn LANCE
 202 interfaces found in
 203 .Tn Sun Ultra 1
 204 machines.
 205 The following media types are available with these:
 206 .Pp
 207 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 208 .It autoselect
 209 Enable autoselection of the media type.
 210 .It 10baseT/UTP
 211 Select UTP media.
 212 .It 10base5/AUI
 213 Select AUI media.
 214 .El
 215 .Pp
 216 When using autoselection, a default media type is selected for use by
 217 examining all ports for carrier.
 218 The first media type with which a carrier is detected will be selected.
 219 Additionally, if carrier is dropped on a port, the driver will switch
 220 between the possible ports until one with carrier is found.
 221 .\" .Pp
 222 .\" The
 223 .\" .Nm
 224 .\" driver also supports
 225 .\" .Tn SBus
 226 .\" Ethernet cards.
 227 .\" These include:
 228 .\" .Bl -bullet -compact
 229 .\" .It
 230 .\" SBE/S
 231 .\" .Tn SCSI
 232 .\" and Buffered Ethernet
 233 .\" (Sun P/N 501-1860)
 234 .\" .It
 235 .\" FSBE/S
 236 .\" Fast
 237 .\" .Tn SCSI
 238 .\" and Buffered Ethernet
 239 .\" (Sun P/N 501-2015)
 240 .\" .El
 241 .Pp
 242 For further information on configuring media types and options, see
 243 .Xr ifconfig 8 .
 244 .Sh DIAGNOSTICS
 245 .Bl -diag
 246 .It "le%d: overflow"
 247 More packets came in from the Ethernet than there was space in the
 248 .Tn LANCE
 249 receive buffers.
 250 Packets were missed.
 251 .It "le%d: receive buffer error"
 252 The
 253 .Tn LANCE
 254 ran out of buffer space, packet dropped.
 255 .It "le%d: lost carrier"
 256 The Ethernet carrier disappeared during an attempt to transmit.
 257 The
 258 .Tn LANCE
 259 will finish transmitting the current packet,
 260 but will not automatically retry transmission if there is a collision.
 261 .It "le%d: excessive collisions, tdr %d"
 262 The Ethernet was extremely busy or jammed,
 263 outbound packets were dropped after 16 attempts to retransmit.
 264 .Pp
 265 TDR
 266 is the abbreviation of
 267 .Qq Time Domain Reflectometry .
 268 The optionally reported TDR value is an internal counter of the interval
 269 between the start of a transmission and the occurrence of a collision.
 270 This value can be used to determine the distance from the Ethernet tap to
 271 the point on the Ethernet cable that is shorted or open (unterminated).
 272 .It "le%d: dropping chained buffer"
 273 A packet did not fit into a single receive buffer and was dropped.
 274 Since the
 275 .Nm
 276 driver allocates buffers large enough to receive maximum sized Ethernet
 277 packets, this means some other station on the LAN transmitted a packet
 278 larger than allowed by the Ethernet standard.
 279 .It "le%d: transmit buffer error"
 280 The
 281 .Tn LANCE
 282 ran out of buffer space before finishing the transmission of a packet.
 283 If this error occurs, the driver software has a bug.
 284 .It "le%d: underflow"
 285 The
 286 .Tn LANCE
 287 ran out of buffer space before finishing the transmission of a packet.
 288 If this error occurs, the driver software has a bug.
 289 .It "le%d: controller failed to initialize"
 290 Driver failed to start the
 291 .Tn LANCE .
 292 This is potentially a hardware failure.
 293 .It "le%d: memory error"
 294 RAM failed to respond within the timeout when the
 295 .Tn LANCE
 296 wanted to read or write it.
 297 This is potentially a hardware failure.
 298 .It "le%d: receiver disabled"
 299 The receiver of the
 300 .Tn LANCE
 301 was turned off due to an error.
 302 .It "le%d: transmitter disabled"
 303 The transmitter of the
 304 .Tn LANCE
 305 was turned off due to an error.
 306 .El
 307 .Sh SEE ALSO
 308 .Xr arp 4 ,
 309 .Xr intro 4 ,
 310 .Xr netintro 4 ,
 311 .Xr pcn 4 ,
 312 .Xr vlan 4 ,
 313 .Xr ifconfig 8
 314 .Sh HISTORY
 315 The
 316 .Nm
 317 driver was ported from
 318 .Nx
 319 and first appeared in
 320 .Fx 6.1 .
 321 The
 322 .Nx
 323 version in turn was derived from the
 324 .Nm
 325 driver which first appeared in
 326 .Bx 4.4 .
 327 .Sh AUTHORS
 328 The
 329 .Nm
 330 driver was ported by
 331 .An "Marius Strobl" Aq marius@FreeBSD.org .
 332 .\" .Sh BUGS
 333 .\" The Am7990 Revision C chips have a bug which causes garbage to be inserted
 334 .\" in front of the received packet occasionally.
 335 .\" The work-around is to ignore packets with an invalid destination address
 336 .\" (garbage will usually not match), by double-checking the destination
 337 .\" address of every packet in the driver.
 338 .\" This work-around can be enabled with the
 339 .\" .Dv LANCE_REVC_BUG
 340 .\" kernel option.
 341 .\" .Pp
 342 .\" When
 343 .\" .Dv LANCE_REVC_BUG
 344 .\" is enabled, the
 345 .\" .Nm
 346 .\" driver executes one or two calls to an inline Ethernet address comparison
 347 .\" function for every received packet.
 348 .\" On the
 349 .\" .Tn MC68000
 350 .\" it is exactly eight instructions of 16 bits each.
 351 .\" There is one comparison for each unicast packet, and two comparisons for
 352 .\" each broadcast packet.
 353 .\" .Pp
 354 .\" In summary, the cost of the LANCE_REVC_BUG option is:
 355 .\" .Bl -enum -compact
 356 .\" .It
 357 .\" loss of multicast support, and
 358 .\" .It
 359 .\" eight extra
 360 .\" .Tn CPU
 361 .\" instructions per received packet, sometimes sixteen, depending on both the
 362 .\" processor, and the type of packet.
 363 .\" .El
 364 .\" .Pp
 365 .\" All sun3 systems are presumed to have this bad revision of the Am7990,
 366 .\" until proven otherwise.
 367 .\" Alas, the only way to prove what revision of the chip is in a particular
 368 .\" system is inspection of the date code on the chip package,
 369 .\" to compare against a list of what chip revisions were fabricated between
 370 .\" which dates.
 371 .\" .Pp
 372 .\" Alas, the Am7990 chip is so old that
 373 .\" .Tn AMD
 374 .\" has
 375 .\" .Qq de-archived
 376 .\" the production information about it; pending a search elsewhere, we do not
 377 .\" know how to identify the revision C chip from the date codes.