xref: /openbsd-src/share/man/man4/vge.4 (revision 3ead84f28bf291f24701fa771c0e891591353c3e)
1.\" $OpenBSD: vge.4,v 1.23 2021/09/08 20:29:21 jmc Exp $
2.\" $FreeBSD: vge.4,v 1.6 2004/11/24 19:06:43 brueffer Exp $
3.\"
4.\" Copyright (c) 2004
5.\"	Bill Paul <wpaul@windriver.com>. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by Bill Paul.
18.\" 4. Neither the name of the author nor the names of any co-contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"   without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32.\" THE POSSIBILITY OF SUCH DAMAGE.
33.\"
34.Dd $Mdocdate: September 8 2021 $
35.Dt VGE 4
36.Os
37.Sh NAME
38.Nm vge
39.Nd VIA Velocity 10/100/1Gb Ethernet device
40.Sh SYNOPSIS
41.Cd "vge* at pci?"
42.Cd "ciphy* at mii?"
43.Cd "ipgphy* at mii?"
44.Sh DESCRIPTION
45The
46.Nm
47driver provides support for various NICs and embedded Ethernet interfaces
48based on the VIA Networking Technologies VT6120, VT6122, VT6130 and VT6132
49Gigabit Ethernet controller chips, including the following:
50.Pp
51.Bl -bullet -compact
52.It
53ZyXEL GN650-T 64-bit PCI Gigabit Ethernet NIC (ZX1701)
54.It
55ZyXEL GN670-T 32-bit PCI Gigabit Ethernet NIC (ZX1702)
56.El
57.Pp
58The VT6120/VT6122 is a 33/66MHz 64-bit PCI device which combines a tri-speed
59MAC with an integrated 10/100/1000 copper PHY.
60(Some older cards use an external PHY.)
61The VT6130/VT6132 is the PCI Express version.
62The MAC supports IPv4 transmit/receive IP/TCP/UDP checksum offload,
63VLAN tag insertion and stripping, a 64-entry CAM filter and a 64-entry
64VLAN filter, 64-bit multicast hash filter, 4 separate transmit DMA
65queues, flow control and jumbo frames (not on VT6130/VT6132).
66The Velocity family has a 16K receive FIFO and 48K transmit FIFO.
67.Pp
68The
69.Nm
70driver takes advantage of the IPv4 transmit/receive IP/TCP/UDP checksum
71offload, VLAN tag insertion and stripping, and the CAM filter support.
72The CAM filter is used for multicast address filtering to provide
7364 perfect multicast address filter support.
74If it is necessary for the interface to join more than 64 multicast
75groups, the driver will switch over to using the hash filter.
76.Pp
77The
78.Nm
79driver supports the following media types:
80.Bl -tag -width 10baseTXUTP
81.It Cm autoselect
82Enable autoselection of the media type and options.
83The user can manually override the autoselected mode by adding media
84options to the appropriate
85.Xr hostname.if 5
86file.
87.It Cm 10baseT/UTP
88Set 10Mbps operation.
89The
90.Xr ifconfig 8
91.Ic mediaopt
92option can also be used to select either
93.Cm full-duplex
94or
95.Cm half-duplex
96modes.
97.It Cm 100baseTX
98Set 100Mbps (Fast Ethernet) operation.
99The
100.Xr ifconfig 8
101.Ic mediaopt
102option can also be used to select either
103.Cm full-duplex
104or
105.Cm half-duplex
106modes.
107.It Cm 1000baseT
108Set 1000baseT operation over twisted pair.
109Both
110.Cm full-duplex
111and
112.Cm half-duplex
113modes are supported.
114.El
115.Pp
116The
117.Nm
118driver supports the following media options:
119.Bl -tag -width full-duplex
120.It Cm full-duplex
121Force full duplex operation.
122.It Cm half-duplex
123Force half duplex operation.
124.El
125.Pp
126For more information on configuring this device, see
127.Xr ifconfig 8 .
128.Sh SEE ALSO
129.Xr arp 4 ,
130.Xr ciphy 4 ,
131.Xr ifmedia 4 ,
132.Xr intro 4 ,
133.Xr ipgphy 4 ,
134.Xr netintro 4 ,
135.Xr pci 4 ,
136.Xr hostname.if 5 ,
137.Xr ifconfig 8
138.Sh HISTORY
139The
140.Nm
141device driver first appeared in
142.Ox 3.7 .
143.Sh AUTHORS
144.An -nosplit
145The
146.Nm
147driver was written by
148.An Bill Paul Aq Mt wpaul@windriver.com
149and ported to
150.Ox
151by
152.An Peter Valchev Aq Mt pvalchev@openbsd.org .
153