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