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