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