xref: /freebsd/share/man/man4/nge.4 (revision 2546665afcaf0d53dc2c7058fee96354b3680f5a)
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.It
66Netgear GA621
67.It
68Ark PC SOHO-GA2500T (32-bit PCI) and SOHO-GA2000T (64-bit PCI)
69.It
70Trendware TEG-PCITX (32-bit PCI) and TEG-PCITX2 (64-bit PCI)
71.El
72.Pp
73All of these NICs are capable of 10, 100 and 1000Mbps speeds over CAT5
74copper cable.
75The DP83820 supports TBI (ten bit interface) and GMII
76transceivers, which means it can be used with either copper or 1000baseX
77fiber applications.
78The DP83820 supports TCP/IP checksum offload and
79VLAN tagging/insertion as well as a 2048-bit multicast hash filter
80and up to 4 pattern match buffers.
81.Pp
82Most cards also use the DP83861 10/100/1000 copper gigabit transceiver
83chip, which supports autonegotiation of 10, 100 and 1000Mbps modes in
84full or half duplex.
85.Pp
86The DP83820 also supports jumbo frames, which can be configured
87via the interface MTU setting.
88Selecting an MTU larger than 1500 bytes with the
89.Xr ifconfig 8
90utility configures the adapter to receive and transmit jumbo frames.
91Using jumbo frames can greatly improve performance for certain tasks,
92such as file transfers and data streaming.
93.Pp
94The
95.Nm
96driver supports the following media types:
97.Bl -tag -width 10baseTXUTP
98.It Cm autoselect
99Enable autoselection of the media type and options.
100The user can manually override
101the autoselected mode by adding media options to
102.Xr rc.conf 5 .
103.It Cm 10baseT/UTP
104Set 10Mbps operation.
105The
106.Xr ifconfig 8
107.Ic mediaopt
108option can also be used to select either
109.Cm full-duplex
110or
111.Cm half-duplex
112modes.
113.It Cm 100baseTX
114Set 100Mbps (fast ethernet) operation.
115The
116.Xr ifconfig 8
117.Ic mediaopt
118option can also be used to select either
119.Cm full-duplex
120or
121.Cm half-duplex
122modes.
123.It Cm 1000baseTX
124Set 1000baseTX operation over twisted pair.
125.Cm full-duplex
126and
127.Cm half-duplex
128modes are supported.
129.It Cm 1000baseSX
130Set 1000Mbps (gigabit ethernet) operation.
131Both
132.Cm full-duplex
133and
134.Cm half-duplex
135modes are supported.
136.El
137.Pp
138The
139.Nm
140driver supports the following media options:
141.Bl -tag -width full-duplex
142.It Cm full-duplex
143Force full duplex operation.
144.It Cm half-duplex
145Force half duplex operation.
146.El
147.Pp
148The
149.Nm
150driver also supports one special link option for 1000baseTX cards:
151.Bl -tag -width link0
152.It Cm link0
153With 1000baseTX cards, establishing a link between two ports requires
154that one port be configured as a master and the other a slave.
155With autonegotiation,
156the master/slave settings will be chosen automatically.
157However when manually selecting the link state, it is necessary to
158force one side of the link to be a master and the other a slave.
159The
160.Nm
161driver configures the ports as slaves by default.
162Setting the
163.Cm link0
164flag with
165.Xr ifconfig 8
166will set a port as a master instead.
167.El
168.Pp
169For more information on configuring this device, see
170.Xr ifconfig 8 .
171.Sh DIAGNOSTICS
172.Bl -diag
173.It "nge%d: couldn't map memory"
174A fatal initialization error has occurred.
175.It "nge%d: couldn't map ports"
176A fatal initialization error has occurred.
177.It "nge%d: couldn't map interrupt"
178A fatal initialization error has occurred.
179.It "nge%d: no memory for softc struct!"
180The driver failed to allocate memory for per-device instance information
181during initialization.
182.It "nge%d: failed to enable memory mapping!"
183The driver failed to initialize PCI shared memory mapping.
184This might
185happen if the card is not in a bus-master slot.
186.It "nge%d: no memory for jumbo buffers!"
187The driver failed to allocate memory for jumbo frames during
188initialization.
189.It "nge%d: watchdog timeout"
190The device has stopped responding to the network, or there is a problem with
191the network connection (cable).
192.El
193.Sh SEE ALSO
194.Xr arp 4 ,
195.Xr miibus 4 ,
196.Xr netintro 4 ,
197.Xr ng_ether 4 ,
198.Xr vlan 4 ,
199.Xr ifconfig 8
200.Rs
201.%T National Semiconductor DP83820 datasheet
202.%O http://www.national.com
203.Re
204.Rs
205.%T National Semiconductor DP83861 datasheet
206.%O http://www.national.com
207.Re
208.Sh HISTORY
209The
210.Nm
211device driver first appeared in
212.Fx 4.4 .
213.Sh AUTHORS
214The
215.Nm
216driver was written by
217.An Bill Paul Aq wpaul@bsdi.com .
218