kernel: Remove support for the EISA bus and EISA/VLB devices.
[dragonfly.git] / share / man / man4 / man4.i386 / lnc.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: /repoman/r/ncvs/src/share/man/man4/le.4,v 1.2 2006/02/02 14:57:00 marius Exp $
38 .\" $DragonFly: src/share/man/man4/man4.i386/lnc.4,v 1.7 2008/05/02 02:05:06 swildner Exp $
39 .\"
40 .Dd July 7, 2006
41 .Dt LNC 4 i386
42 .Os
43 .Sh NAME
44 .Nm lnc
45 .Nd AMD Am7900 LANCE and Am79C9xx PCnet Ethernet interface driver
46 .Sh SYNOPSIS
47 .Cd "device lnc"
48 .Sh DESCRIPTION
49 The
50 .Nm
51 driver provides support for the AMD family of Lance/PCnet Ethernet NICs
52 including the Am7990 and Am79C960.
53 .Pp
54 The
55 .Nm
56 driver also supports PCnet adapters based on the
57 .Tn AMD 79C9xx
58 family of chips, which are single-chip implementations of a
59 .Tn LANCE
60 chip and a DMA engine.
61 This includes a superset of the
62 .Tn PCI
63 bus Ethernet chip sets supported by the
64 .Xr pcn 4
65 driver.
66 The
67 .Nm
68 driver treats all of these
69 .Tn PCI
70 bus Ethernet chip sets as an
71 .Tn AMD Am79C970 PCnet-PCI
72 and does not support the additional features like the MII bus and burst mode of
73 .Tn AMD Am79C971 PCnet-FAST
74 and greater chip sets.
75 Thus the
76 .Xr pcn 4
77 driver should be preferred for the latter.
78 .Pp
79 The
80 .Nm
81 driver supports reception and transmission of extended frames for
82 .Xr vlan 4 .
83 Selective reception of multicast Ethernet frames is provided by a 64-bit mask;
84 multicast destination addresses are hashed to a bit entry using the Ethernet
85 CRC function.
86 .Sh HARDWARE
87 .\" .Ss ISA
88 .\" The
89 .\" .Tn ISA
90 .\" bus Ethernet cards supported by the
91 .\" .Nm
92 .\" driver are:
93 .\" .Pp
94 .\" .Bl -bullet -compact
95 .\" .It
96 .\" .Tn BICC Isolan
97 .\" .It
98 .\" .Tn Novell NE2100
99 .\" .It
100 .\" .Tn Digital DEPCA
101 .\" .El
102 .\" .Ss MCA
103 .\" The
104 .\" .Tn MCA
105 .\" bus Ethernet cards supported by the
106 .\" .Nm
107 .\" driver are:
108 .\" .Pp
109 .\" .Bl -bullet -compact
110 .\" .It
111 .\" .Tn SKNET Personal MC2
112 .\" .It
113 .\" .Tn SKNET MC2+
114 .\" .El
115 .Ss PCI
116 The
117 .Tn PCI
118 bus Ethernet chip sets supported by the
119 .Nm
120 driver are:
121 .Pp
122 .Bl -bullet -compact
123 .It
124 .Tn AMD Am53C974/Am79C970/Am79C974 PCnet-PCI
125 .It
126 .Tn AMD Am79C970A PCnet-PCI II
127 .It
128 .Tn AMD Am79C971 PCnet-FAST
129 .It
130 .Tn AMD Am79C972 PCnet-FAST+
131 .It
132 .Tn AMD Am79C973/Am79C975 PCnet-FAST III
133 .It
134 .Tn AMD Am79C976 PCnet-PRO
135 .It
136 .Tn AMD Am79C978 PCnet-Home
137 .El
138 .Pp
139 The
140 .Nm
141 driver supports the following media types with these chip sets:
142 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
143 .It autoselect
144 Enable autoselection of the media type.
145 .It 10baseT/UTP
146 Select UTP media.
147 .It 10base5/AUI
148 Select AUI/BNC media.
149 .El
150 .Pp
151 The following media option is supported with these media types:
152 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
153 .It full-duplex
154 Select full duplex operation.
155 .El
156 .Pp
157 Note that unlike the
158 .Xr pcn 4
159 driver, the
160 .Nm
161 driver does not support selecting 100Mbps (Fast Ethernet) media types.
162 .Pp
163 For further information on configuring media types and options, see
164 .Xr ifconfig 8 .
165 .Sh DIAGNOSTICS
166 .Bl -diag
167 .It "lnc%d: overflow"
168 More packets came in from the Ethernet than there was space in the
169 .Tn LANCE
170 receive buffers.
171 Packets were missed.
172 .It "lnc%d: receive buffer error"
173 The
174 .Tn LANCE
175 ran out of buffer space, packet dropped.
176 .It "lnc%d: lost carrier"
177 The Ethernet carrier disappeared during an attempt to transmit.
178 The
179 .Tn LANCE
180 will finish transmitting the current packet,
181 but will not automatically retry transmission if there is a collision.
182 .It "lnc%d: excessive collisions, tdr %d"
183 The Ethernet was extremely busy or jammed,
184 outbound packets were dropped after 16 attempts to retransmit.
185 .Pp
186 TDR
187 is the abbreviation of
188 .Qq Time Domain Reflectometry .
189 The optionally reported TDR value is an internal counter of the interval
190 between the start of a transmission and the occurrence of a collision.
191 This value can be used to determine the distance from the Ethernet tap to
192 the point on the Ethernet cable that is shorted or open (unterminated).
193 .It "lnc%d: dropping chained buffer"
194 A packet did not fit into a single receive buffer and was dropped.
195 Since the
196 .Nm
197 driver allocates buffers large enough to receive maximum sized Ethernet
198 packets, this means some other station on the LAN transmitted a packet
199 larger than allowed by the Ethernet standard.
200 .It "lnc%d: transmit buffer error"
201 The
202 .Tn LANCE
203 ran out of buffer space before finishing the transmission of a packet.
204 If this error occurs, the driver software has a bug.
205 .It "lnc%d: underflow"
206 The
207 .Tn LANCE
208 ran out of buffer space before finishing the transmission of a packet.
209 If this error occurs, the driver software has a bug.
210 .It "lnc%d: controller failed to initialize"
211 Driver failed to start the
212 .Tn LANCE .
213 This is potentially a hardware failure.
214 .It "lnc%d: memory error"
215 RAM failed to respond within the timeout when the
216 .Tn LANCE
217 wanted to read or write it.
218 This is potentially a hardware failure.
219 .It "lnc%d: receiver disabled"
220 The receiver of the
221 .Tn LANCE
222 was turned off due to an error.
223 .It "lnc%d: transmitter disabled"
224 The transmitter of the
225 .Tn LANCE
226 was turned off due to an error.
227 .El
228 .Sh SEE ALSO
229 .Xr arp 4 ,
230 .Xr ifmedia 4 ,
231 .Xr intro 4 ,
232 .Xr netintro 4 ,
233 .Xr pcn 4 ,
234 .Xr vlan 4 ,
235 .Xr ifconfig 8
236 .Sh HISTORY
237 The
238 .Nm
239 driver first appeared in
240 .Fx 2.2 ,
241 it was replaced in
242 .Dx 1.5
243 with the
244 .Xr le 4
245 driver from
246 .Fx 6.1
247 which was in turn ported from
248 .Nx .
249 The
250 .Nx
251 driver was derived from the
252 .Xr le 4
253 driver in
254 .Bx 4.4 .
255 .Sh AUTHORS
256 .An -nosplit
257 The
258 .Nm
259 driver was ported to
260 .Fx
261 by
262 .An "Marius Strobl" Aq marius@FreeBSD.org
263 and later ported to
264 .Dx
265 by
266 .An "Bill Marquette" Aq bill.marquette@gmail.com .
267 .\" .Sh BUGS
268 .\" The Am7990 Revision C chips have a bug which causes garbage to be inserted
269 .\" in front of the received packet occasionally.
270 .\" The work-around is to ignore packets with an invalid destination address
271 .\" (garbage will usually not match), by double-checking the destination
272 .\" address of every packet in the driver.
273 .\" This work-around can be enabled with the
274 .\" .Dv LANCE_REVC_BUG
275 .\" kernel option.
276 .\" .Pp
277 .\" When
278 .\" .Dv LANCE_REVC_BUG
279 .\" is enabled, the
280 .\" .Nm
281 .\" driver executes one or two calls to an inline Ethernet address comparison
282 .\" function for every received packet.
283 .\" There is one comparison for each unicast packet, and two comparisons for
284 .\" each broadcast packet.
285 .\" .Pp
286 .\" In summary, the cost of the LANCE_REVC_BUG option is:
287 .\" .Bl -enum -compact
288 .\" .It
289 .\" loss of multicast support, and
290 .\" .It
291 .\" eight extra
292 .\" .Tn CPU
293 .\" instructions per received packet, sometimes sixteen, depending on both the
294 .\" processor, and the type of packet.
295 .\" .El
296 .\" .Pp
297 .\" Alas, the Am7990 chip is so old that
298 .\" .Tn AMD
299 .\" has
300 .\" .Qq de-archived
301 .\" the production information about it; pending a search elsewhere, we do not
302 .\" know how to identify the revision C chip from the date codes.