xref: /freebsd/share/man/man4/nge.4 (revision 0fddbf874719b9bd50cf66ac26d1140bb3f2be69)
1.\" Copyright (c) 2001 Wind River Systems
2.\" Copyright (c) 1997, 1998, 1999, 2000, 2001
3.\"	Bill Paul <wpaul@bsdi.com>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. All advertising materials mentioning features or use of this software
14.\"    must display the following acknowledgement:
15.\"	This product includes software developed by Bill Paul.
16.\" 4. Neither the name of the author nor the names of any co-contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"   without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
24.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30.\" THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\" $FreeBSD$
33.\"
34.Dd May 11, 2001
35.Dt NGE 4
36.Os
37.Sh NAME
38.Nm nge
39.Nd "National Semiconductor PCI gigabit ethernet adapter driver"
40.Sh SYNOPSIS
41.Cd "device miibus"
42.Cd "device nge"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for various NICs based on the National Semiconductor
47DP83820 and DP83821 gigabit ethernet controller chips, including the
48following:
49.Pp
50.Bl -bullet -compact
51.It
52SMC EZ Card 1000 (SMC9462TX)
53.It
54D-Link DGE-500T
55.It
56Asante FriendlyNet GigaNIX 1000TA and 1000TPC
57.It
58Addtron AEG320T
59.It
60LinkSys EG1032 (32-bit PCI) and EG1064 (64-bit PCI)
61.It
62Surecom Technology EP-320G-TX
63.It
64Netgear GA622T
65.El
66.Pp
67All of these NICs are capable of 10, 100 and 1000mbps speeds over CAT5
68copper cable.
69The DP83820 supports TBI (ten bit interface) and GMII
70transceivers, which means it can be used with either copper of 1000baseX
71fiber applications.
72The DP83820 supports TCP/IP checksum offload and
73VLAN tagging/insertion as well as a 2048-bit multicast hash filter
74and up to 4 pattern match buffers.
75.Pp
76Most cards also use the DP83861 10/100/1000 copper gigabit tranceiver
77chip, which supports autonegotiation of 10, 100 and 1000mbps modes in
78full or half duplex.
79.Pp
80The DP83820 also supports jumbo frames, which can be configured
81via the interface MTU setting.
82Selecting an MTU larger than 1500 bytes with the
83.Xr ifconfig 8
84utility configures the adapter to receive and transmit jumbo frames.
85Using jumbo frames can greatly improve performance for certain tasks,
86such as file transfers and data streaming.
87.Pp
88The
89.Nm
90driver supports the following media types:
91.Bl -tag -width 10baseTXUTP
92.It Cm autoselect
93Enable autoselection of the media type and options.
94The user can manually override
95the autoselected mode by adding media options to
96.Xr rc.conf 5 .
97.It Cm 10baseT/UTP
98Set 10Mbps operation.
99The
100.Xr ifconfig 8
101.Ic mediaopt
102option can also be used to select either
103.Cm full-duplex
104or
105.Cm half-duplex
106modes.
107.It Cm 100baseTX
108Set 100Mbps (fast ethernet) operation.
109The
110.Xr ifconfig 8
111.Ic mediaopt
112option can also be used to select either
113.Cm full-duplex
114or
115.Cm half-duplex
116modes.
117.It Cm 1000baseTX
118Set 1000baseTX operation over twisted pair.
119.Cm full-duplex
120and
121.Cm half-duplex
122modes are supported.
123.It Cm 1000baseSX
124Set 1000Mbps (gigabit ethernet) operation.
125Both
126.Cm full-duplex
127and
128.Cm half-duplex
129modes are supported.
130.El
131.Pp
132The
133.Nm
134driver supports the following media options:
135.Bl -tag -width full-duplex
136.It Cm full-duplex
137Force full duplex operation.
138.It Cm half-duplex
139Force half duplex operation.
140.El
141.Pp
142The
143.Nm
144driver also supports one special link option for 1000baseTX cards:
145.Bl -tag -width link0
146.It Cm link0
147With 1000baseTX cards, establishing a link between two ports requires
148that one port be configured as a master and the other a slave.
149With autonegotiation,
150the master/slave settings will be chosen automatically.
151However when manually selecting the link state, it is necessary to
152force one side of the link to be a master and the other a slave.
153The
154.Nm
155driver configures the ports as slaves by default.
156Setting the
157.Cm link0
158flag with
159.Xr ifconfig 8
160will set a port as a master instead.
161.El
162.Pp
163For more information on configuring this device, see
164.Xr ifconfig 8 .
165.Sh DIAGNOSTICS
166.Bl -diag
167.It "nge%d: couldn't map memory"
168A fatal initialization error has occurred.
169.It "nge%d: couldn't map ports"
170A fatal initialization error has occurred.
171.It "nge%d: couldn't map interrupt"
172A fatal initialization error has occurred.
173.It "nge%d: no memory for softc struct!"
174The driver failed to allocate memory for per-device instance information
175during initialization.
176.It "nge%d: failed to enable memory mapping!"
177The driver failed to initialize PCI shared memory mapping.
178This might
179happen if the card is not in a bus-master slot.
180.It "nge%d: no memory for jumbo buffers!"
181The driver failed to allocate memory for jumbo frames during
182initialization.
183.It "nge%d: watchdog timeout"
184The device has stopped responding to the network, or there is a problem with
185the network connection (cable).
186.El
187.Sh SEE ALSO
188.Xr arp 4 ,
189.Xr netintro 4 ,
190.Xr ng_ether 4 ,
191.Xr vlan 4 ,
192.Xr ifconfig 8
193.Rs
194.%T National Semiconductor DP83820 datasheet
195.%O http://www.national.com
196.Re
197.Rs
198.%T National Semiconductor DP83861 datasheet
199.%O http://www.national.com
200.Re
201.Sh HISTORY
202The
203.Nm
204device driver first appeared in
205.Fx 4.4 .
206.Sh AUTHORS
207The
208.Nm
209driver was written by
210.An Bill Paul Aq wpaul@bsdi.com .
211