xref: /dragonfly/share/man/man4/vge.4 (revision 25a2db75)
1.\" Copyright (c) 2004
2.\"	Bill Paul <wpaul@windriver.com>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by Bill Paul.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"   without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29.\" THE POSSIBILITY OF SUCH DAMAGE.
30.\"
31.\" $FreeBSD: src/share/man/man4/vge.4,v 1.10 2005/10/07 02:32:15 trhodes Exp $
32.\" $DragonFly: src/share/man/man4/vge.4,v 1.4 2008/07/11 10:38:50 thomas Exp $
33.\"
34.Dd May 20, 2006
35.Dt VGE 4
36.Os
37.Sh NAME
38.Nm vge
39.Nd "VIA Networking Technologies VT6122 PCI Gigabit Ethernet adapter driver"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device miibus"
46.Cd "device vge"
47.Ed
48.Pp
49Alternatively, to load the driver as a
50module at boot time, place the following line in
51.Xr loader.conf 5 :
52.Bd -literal -offset indent
53if_vge_load="YES"
54.Ed
55.Sh DESCRIPTION
56The
57.Nm
58driver provides support for various NICs and embedded Ethernet interfaces
59based on the VIA Networking Technologies VT6122 Gigabit Ethernet
60controller chips.
61.Pp
62The VT6122 is a 33/66Mhz 64-bit PCI device which combines a tri-speed MAC with
63an integrated 10/100/1000 copper PHY.
64(Some older cards use an external PHY.)
65The MAC supports TCP/IP hardware
66checksums (IPv4 only), TCP large send, VLAN tag insertion and stripping,
67as well as VLAN filtering, a 64-entry CAM filter and a 64-entry VLAN filter,
6864-bit multicast hash filter, 4 separate transmit DMA queues, flow control
69and jumbo frames up to 16K in size.
70The VT6122 has a 16K receive FIFO and 48K transmit FIFO.
71.Pp
72The
73.Nm
74driver takes advantage of the VT6122's checksum offload and VLAN
75tagging features, as well as the jumbo frame and CAM filter support.
76The CAM filter is used for multicast address filtering to provide
7764 perfect multicast address filter support.
78If it is necessary for the interface to join more than 64 multicast
79groups, the driver will switch over to using the hash filter.
80.Pp
81The jumbo frame support can be enabled by setting the interface MTU
82to any value larger than the default of 1500 bytes, up to a maximum
83of 9000 bytes.
84The receive and transmit checksum offload support
85can be toggled on and off using the
86.Xr ifconfig 8
87utility.
88.Pp
89The
90.Nm
91driver supports the following media types:
92.Bl -tag -width ".Cm 10baseT/UTP"
93.It Cm autoselect
94Enable autoselection of the media type and options.
95The user can manually override
96the autoselected mode by adding media options to
97.Xr rc.conf 5 .
98.It Cm 10baseT/UTP
99Set 10Mbps operation.
100The
101.Xr ifconfig 8
102.Cm mediaopt
103option can also be used to select either
104.Cm full-duplex
105or
106.Cm half-duplex
107modes.
108.It Cm 100baseTX
109Set 100Mbps (Fast Ethernet) operation.
110The
111.Xr ifconfig 8
112.Cm mediaopt
113option can also be used to select either
114.Cm full-duplex
115or
116.Cm half-duplex
117modes.
118.It Cm 1000baseT
119Set 1000baseT operation over twisted pair.
120The
121.Xr ifconfig 8
122.Cm mediaopt
123option can also be used to select either
124.Cm full-duplex
125or
126.Cm half-duplex
127modes.
128.El
129.Pp
130The
131.Nm
132driver supports the following media options:
133.Bl -tag -width ".Cm full-duplex"
134.It Cm full-duplex
135Force full duplex operation.
136.It Cm half-duplex
137Force half duplex operation.
138.El
139.Pp
140The
141.Nm
142driver also supports one special link option for 1000baseT cards:
143.Bl -tag -width ".Cm link0"
144.It Cm link0
145With 1000baseT cards, establishing a link between two ports requires
146that one port be configured as a master and the other a slave.
147With autonegotiation,
148the master/slave settings will be chosen automatically.
149However when manually selecting the link state, it is necessary to
150force one side of the link to be a master and the other a slave.
151The
152.Nm
153driver configures the ports as slaves by default.
154Setting the
155.Cm link0
156flag with
157.Xr ifconfig 8
158will set a port as a master instead.
159.El
160.Pp
161For more information on configuring this device, see
162.Xr ifconfig 8 .
163The
164.Nm
165driver supports
166.Xr polling 4 .
167.Sh HARDWARE
168The
169.Nm
170driver supports VIA Networking VT3119 and VT6122 based
171Gigabit Ethernet adapters including:
172.Pp
173.Bl -bullet -compact
174.It
175VIA Networking LAN-on-motherboard Gigabit Ethernet
176.It
177ZyXEL GN650-T 64-bit PCI Gigabit Ethernet NIC (ZX1701)
178.It
179ZyXEL GN670-T 32-bit PCI Gigabit Ethernet NIC (ZX1702)
180.El
181.Sh DIAGNOSTICS
182.Bl -diag
183.It "vge%d: couldn't map memory"
184A fatal initialization error has occurred.
185.It "vge%d: couldn't map ports"
186A fatal initialization error has occurred.
187.It "vge%d: couldn't map interrupt"
188A fatal initialization error has occurred.
189.It "vge%d: failed to enable memory mapping!"
190The driver failed to initialize PCI shared memory mapping.
191This might
192happen if the card is not in a bus-master slot.
193.It "vge%d: watchdog timeout"
194The device has stopped responding to the network, or there is a problem with
195the network connection (cable).
196.El
197.Sh SEE ALSO
198.Xr arp 4 ,
199.Xr ifmedia 4 ,
200.Xr miibus 4 ,
201.Xr netintro 4 ,
202.Xr ng_ether 4 ,
203.Xr polling 4 ,
204.Xr vlan 4 ,
205.Xr ifconfig 8
206.Sh HISTORY
207The
208.Nm
209device driver first appeared in
210.Fx 5.3 .
211It was imported into
212.Dx 1.5 .
213.Sh AUTHORS
214The
215.Nm
216driver was written by
217.An Bill Paul Aq wpaul@windriver.com .
218.Sh BUGS
219.Xr polling 4
220may not work with
221.Xr vge 4 .
222