Add an ifmedia(4) reference to the manpages of all drivers that support
[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.5 2007/02/25 12:03:07 swildner Exp $
39 .\"
40 .Dd July 07, 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 EISA
103 .\" The
104 .\" .Tn EISA
105 .\" bus Ethernet cards supported by the
106 .\" .Nm
107 .\" driver are:
108 .\" .Pp
109 .\" .Bl -bullet -compact
110 .\" .It
111 .\" .Tn DEC DE422
112 .\" .El
113 .\" .Ss MCA
114 .\" The
115 .\" .Tn MCA
116 .\" bus Ethernet cards supported by the
117 .\" .Nm
118 .\" driver are:
119 .\" .Pp
120 .\" .Bl -bullet -compact
121 .\" .It
122 .\" .Tn SKNET Personal MC2
123 .\" .It
124 .\" .Tn SKNET MC2+
125 .\" .El
126 .Ss PCI
127 The
128 .Tn PCI
129 bus Ethernet chip sets supported by the
130 .Nm
131 driver are:
132 .Pp
133 .Bl -bullet -compact
134 .It
135 .Tn AMD Am53C974/Am79C970/Am79C974 PCnet-PCI
136 .It
137 .Tn AMD Am79C970A PCnet-PCI II
138 .It
139 .Tn AMD Am79C971 PCnet-FAST
140 .It
141 .Tn AMD Am79C972 PCnet-FAST+
142 .It
143 .Tn AMD Am79C973/Am79C975 PCnet-FAST III
144 .It
145 .Tn AMD Am79C976 PCnet-PRO
146 .It
147 .Tn AMD Am79C978 PCnet-Home
148 .El
149 .Pp
150 The
151 .Nm
152 driver supports the following media types with these chip sets:
153 .Pp
154 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
155 .It autoselect
156 Enable autoselection of the media type.
157 .It 10baseT/UTP
158 Select UTP media.
159 .It 10base5/AUI
160 Select AUI/BNC media.
161 .El
162 .Pp
163 The following media option is supported with these media types:
164 .Pp
165 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
166 .It full-duplex
167 Select full duplex operation.
168 .El
169 .Pp
170 Note that unlike the
171 .Xr pcn 4
172 driver, the
173 .Nm
174 driver does not support selecting 100Mbps (Fast Ethernet) media types.
175 .Pp
176 For further information on configuring media types and options, see
177 .Xr ifconfig 8 .
178 .Sh DIAGNOSTICS
179 .Bl -diag
180 .It "lnc%d: overflow"
181 More packets came in from the Ethernet than there was space in the
182 .Tn LANCE
183 receive buffers.
184 Packets were missed.
185 .It "lnc%d: receive buffer error"
186 The
187 .Tn LANCE
188 ran out of buffer space, packet dropped.
189 .It "lnc%d: lost carrier"
190 The Ethernet carrier disappeared during an attempt to transmit.
191 The
192 .Tn LANCE
193 will finish transmitting the current packet,
194 but will not automatically retry transmission if there is a collision.
195 .It "lnc%d: excessive collisions, tdr %d"
196 The Ethernet was extremely busy or jammed,
197 outbound packets were dropped after 16 attempts to retransmit.
198 .Pp
199 TDR
200 is the abbreviation of
201 .Qq Time Domain Reflectometry .
202 The optionally reported TDR value is an internal counter of the interval
203 between the start of a transmission and the occurrence of a collision.
204 This value can be used to determine the distance from the Ethernet tap to
205 the point on the Ethernet cable that is shorted or open (unterminated).
206 .It "lnc%d: dropping chained buffer"
207 A packet did not fit into a single receive buffer and was dropped.
208 Since the
209 .Nm
210 driver allocates buffers large enough to receive maximum sized Ethernet
211 packets, this means some other station on the LAN transmitted a packet
212 larger than allowed by the Ethernet standard.
213 .It "lnc%d: transmit buffer error"
214 The
215 .Tn LANCE
216 ran out of buffer space before finishing the transmission of a packet.
217 If this error occurs, the driver software has a bug.
218 .It "lnc%d: underflow"
219 The
220 .Tn LANCE
221 ran out of buffer space before finishing the transmission of a packet.
222 If this error occurs, the driver software has a bug.
223 .It "lnc%d: controller failed to initialize"
224 Driver failed to start the
225 .Tn LANCE .
226 This is potentially a hardware failure.
227 .It "lnc%d: memory error"
228 RAM failed to respond within the timeout when the
229 .Tn LANCE
230 wanted to read or write it.
231 This is potentially a hardware failure.
232 .It "lnc%d: receiver disabled"
233 The receiver of the
234 .Tn LANCE
235 was turned off due to an error.
236 .It "lnc%d: transmitter disabled"
237 The transmitter of the
238 .Tn LANCE
239 was turned off due to an error.
240 .El
241 .Sh SEE ALSO
242 .Xr arp 4 ,
243 .Xr ifmedia 4 ,
244 .Xr intro 4 ,
245 .Xr netintro 4 ,
246 .Xr pcn 4 ,
247 .Xr vlan 4 ,
248 .Xr ifconfig 8
249 .Sh HISTORY
250 The
251 .Nm
252 driver first appeared in
253 .Fx 2.2 ,
254 it was replaced in
255 .Dx 1.5
256 with the
257 .Xr le 4
258 driver from
259 .Fx 6.1
260 which was in turn ported from
261 .Nx .
262 The
263 .Nx
264 driver was derived from the
265 .Xr le 4 driver in
266 .Bx 4.4 .
267 .Sh AUTHORS
268 .An -nosplit
269 The
270 .Nm
271 driver was ported to
272 .Fx
273 by
274 .An "Marius Strobl" Aq marius@FreeBSD.org
275 and later ported to
276 .Dx
277 by
278 .An "Bill Marquette" Aq bill.marquette@gmail.com .
279 .\" .Sh BUGS
280 .\" The Am7990 Revision C chips have a bug which causes garbage to be inserted
281 .\" in front of the received packet occasionally.
282 .\" The work-around is to ignore packets with an invalid destination address
283 .\" (garbage will usually not match), by double-checking the destination
284 .\" address of every packet in the driver.
285 .\" This work-around can be enabled with the
286 .\" .Dv LANCE_REVC_BUG
287 .\" kernel option.
288 .\" .Pp
289 .\" When
290 .\" .Dv LANCE_REVC_BUG
291 .\" is enabled, the
292 .\" .Nm
293 .\" driver executes one or two calls to an inline Ethernet address comparison
294 .\" function for every received packet.
295 .\" There is one comparison for each unicast packet, and two comparisons for
296 .\" each broadcast packet.
297 .\" .Pp
298 .\" In summary, the cost of the LANCE_REVC_BUG option is:
299 .\" .Bl -enum -compact
300 .\" .It
301 .\" loss of multicast support, and
302 .\" .It
303 .\" eight extra
304 .\" .Tn CPU
305 .\" instructions per received packet, sometimes sixteen, depending on both the
306 .\" processor, and the type of packet.
307 .\" .El
308 .\" .Pp
309 .\" Alas, the Am7990 chip is so old that
310 .\" .Tn AMD
311 .\" has
312 .\" .Qq de-archived
313 .\" the production information about it; pending a search elsewhere, we do not
314 .\" know how to identify the revision C chip from the date codes.