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