xref: /freebsd/share/man/man4/vge.4 (revision b6de9e91bd2c47efaeec72a08642f8fd99cc7b20)
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$
32.\"
33.Dd July 16, 2005
34.Dt VGE 4
35.Os
36.Sh NAME
37.Nm vge
38.Nd "VIA Networking Technologies VT6122 PCI Gigabit Ethernet adapter driver"
39.Sh SYNOPSIS
40To compile support for the
41.Nm
42driver into your kernel, place 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
50.Nm
51driver at boot time, place the following line in
52.Xr loader.conf 5 :
53.Bd -literal -offset indent
54if_vge_load="YES"
55.Ed
56.Sh DESCRIPTION
57The
58.Nm
59driver provides support for various NICs and embedded Ethernet interfaces
60based on the VIA Networking Technologies VT6122 Gigabit Ethernet
61controller chips.
62.Pp
63The VT6122 is a 33/66Mhz 64-bit PCI device which combines a tri-speed MAC with
64an integrated 10/100/1000 copper PHY.
65(Some older cards use an external PHY.)
66The MAC supports TCP/IP hardware
67checksums (IPv4 only), TCP large send, VLAN tag insertion and stripping,
68as well as VLAN filtering, a 64-entry CAM filter and a 64-entry VLAN filter,
6964-bit multicast hash filter, 4 separate transmit DMA queues, flow control
70and jumbo frames up to 16K in size.
71The VT6122 has a 16K receive FIFO and 48K transmit FIFO.
72.Pp
73The
74.Nm
75driver takes advantage of the VT6122's checksum offload and VLAN
76tagging features, as well as the jumbo frame and CAM filter support.
77The CAM filter is used for multicast address filtering to provide
7864 perfect multicast address filter support.
79If it is necessary for the interface to join more than 64 multicast
80groups, the driver will switch over to using the hash filter.
81.Pp
82The jumbo frame support can be enabled by setting the interface MTU
83to any value larger than the default of 1500 bytes, up to a maximum
84of 9000 bytes.
85The receive and transmit checksum offload support
86can be toggled on and off using the
87.Xr ifconfig 8
88utility.
89.Pp
90The
91.Nm
92driver supports the following media types:
93.Bl -tag -width ".Cm 10baseT/UTP"
94.It Cm autoselect
95Enable autoselection of the media type and options.
96The user can manually override
97the autoselected mode by adding media options to
98.Xr rc.conf 5 .
99.It Cm 10baseT/UTP
100Set 10Mbps operation.
101The
102.Xr ifconfig 8
103.Cm mediaopt
104option can also be used to select either
105.Cm full-duplex
106or
107.Cm half-duplex
108modes.
109.It Cm 100baseTX
110Set 100Mbps (Fast Ethernet) operation.
111The
112.Xr ifconfig 8
113.Cm mediaopt
114option can also be used to select either
115.Cm full-duplex
116or
117.Cm half-duplex
118modes.
119.It Cm 1000baseTX
120Set 1000baseTX operation over twisted pair.
121The
122.Xr ifconfig 8
123.Cm mediaopt
124option can also be used to select either
125.Cm full-duplex
126or
127.Cm half-duplex
128modes.
129.El
130.Pp
131The
132.Nm
133driver supports the following media options:
134.Bl -tag -width ".Cm full-duplex"
135.It Cm full-duplex
136Force full duplex operation.
137.It Cm half-duplex
138Force half duplex operation.
139.El
140.Pp
141The
142.Nm
143driver also supports one special link option for 1000baseTX cards:
144.Bl -tag -width ".Cm link0"
145.It Cm link0
146With 1000baseTX cards, establishing a link between two ports requires
147that one port be configured as a master and the other a slave.
148With autonegotiation,
149the master/slave settings will be chosen automatically.
150However when manually selecting the link state, it is necessary to
151force one side of the link to be a master and the other a slave.
152The
153.Nm
154driver configures the ports as slaves by default.
155Setting the
156.Cm link0
157flag with
158.Xr ifconfig 8
159will set a port as a master instead.
160.El
161.Pp
162For more information on configuring this device, see
163.Xr ifconfig 8 .
164.Sh HARDWARE
165The
166.Nm
167driver supports VIA Networking VT3119 and VT6122 based
168Gigabit Ethernet adapters including:
169.Pp
170.Bl -bullet -compact
171.It
172VIA Networking LAN-on-motherboard Gigabit Ethernet
173.It
174ZyXEL GN650-T 64-bit PCI Gigabit Ethernet NIC (ZX1701)
175.It
176ZyXEL GN670-T 32-bit PCI Gigabit Ethernet NIC (ZX1702)
177.El
178.Sh DIAGNOSTICS
179.Bl -diag
180.It "vge%d: couldn't map memory"
181A fatal initialization error has occurred.
182.It "vge%d: couldn't map ports"
183A fatal initialization error has occurred.
184.It "vge%d: couldn't map interrupt"
185A fatal initialization error has occurred.
186.It "vge%d: failed to enable memory mapping!"
187The driver failed to initialize PCI shared memory mapping.
188This might
189happen if the card is not in a bus-master slot.
190.It "vge%d: watchdog timeout"
191The device has stopped responding to the network, or there is a problem with
192the network connection (cable).
193.El
194.Sh SEE ALSO
195.Xr arp 4 ,
196.Xr miibus 4 ,
197.Xr netintro 4 ,
198.Xr ng_ether 4 ,
199.Xr polling 4 ,
200.Xr vlan 4 ,
201.Xr ifconfig 8
202.Sh HISTORY
203The
204.Nm
205device driver first appeared in
206.Fx 5.3 .
207.Sh AUTHORS
208The
209.Nm
210driver was written by
211.An Bill Paul Aq wpaul@windriver.com .
212