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