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