2 .\" Bill Paul <wpaul@windriver.com>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
38 .Nd "VIA Networking Technologies Velocity Gigabit Ethernet adapter driver"
40 To compile this driver into the kernel,
41 place the following lines in your
42 kernel configuration file:
43 .Bd -ragged -offset indent
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for various NICs and embedded Ethernet interfaces
58 based on the VIA Technologies VT6120, VT6122, VT6130 and VT6132 Velocity
59 Family Gigabit Ethernet controller chips.
61 The VT6120/VT6122 is a 33/66MHz 64-bit PCI device which combines a tri-speed
62 MAC with an integrated 10/100/1000 copper PHY.
63 (Some older cards use an external PHY.)
64 The VT6130/VT6132 is the PCI express version of Velocity family.
65 The MAC supports TCP/IP hardware
66 checksums (IPv4 only), TCP large send, VLAN tag insertion and stripping,
67 as well as VLAN filtering, a 64-entry CAM filter and a 64-entry VLAN filter,
68 64-bit multicast hash filter, 4 separate transmit DMA queues, flow control
69 and jumbo frames (not on VT6130/VT6132) up to 16K in size.
70 The Velocity family controllers have a 16K receive FIFO and 48K transmit FIFO.
74 driver takes advantage of the controller's checksum offload and VLAN
75 tagging features, as well as the jumbo frame (except VT6130/VT6132) and CAM
77 The CAM filter is used for multicast address filtering to provide
78 64 perfect multicast address filter support.
79 If it is necessary for the interface to join more than 64 multicast
80 groups, the driver will switch over to using the hash filter.
82 The jumbo frame support can be enabled by setting the interface MTU
83 to any value larger than the default of 1500 bytes, up to a maximum
85 Jumbo frames are disabled on the VT6130/VT6132 controllers because the TX
86 MAC will hang when trying to send a frame that is larger than 4K.
87 The receive and transmit checksum offload support
88 can be toggled on and off using the
94 driver supports the following media types:
95 .Bl -tag -width ".Cm 10baseT/UTP"
97 Enable autoselection of the media type and options.
98 The user can manually override
99 the autoselected mode by adding media options to
102 Set 10Mbps operation.
106 option can also be used to select either
112 Set 100Mbps (Fast Ethernet) operation.
116 option can also be used to select either
122 Set 1000baseTX operation over twisted pair.
126 option can also be used to select either
135 driver supports the following media options:
136 .Bl -tag -width ".Cm full-duplex"
138 Force full duplex operation.
140 Force half duplex operation.
143 For more information on configuring this device, see
148 driver supports VIA Networking VT6120, VT6122, VT6130 and VT6132 based
149 Gigabit Ethernet adapters including:
153 VIA Networking LAN-on-motherboard Gigabit Ethernet
155 ZyXEL GN650-T 64-bit PCI Gigabit Ethernet NIC (ZX1701)
157 ZyXEL GN670-T 32-bit PCI Gigabit Ethernet NIC (ZX1702)
160 Tunables can be set at the
162 prompt before booting the kernel or stored in
164 .Bl -tag -width "xxxxxx"
165 .It Va hw.vge.msi_disable
166 This tunable disables MSI support on the Ethernet hardware.
167 The default value is 0.
170 The following variables are available as both
175 .Bl -tag -width "xxxxxx"
176 .It Va dev.vge.%d.int_holdoff
177 Maximum number of time to delay interrupts.
178 The valid range is 0 to 5100 in units of 1us, the default is
180 The resolution of timer is about 20us so finer tuning than
181 20us wouldn't be available.
182 The interface should be brought down and up again before a change
184 .It Va dev.vge.%d.rx_coal_pkt
185 Maximum number of packets to fire Rx completion interrupt.
186 The valid range is 1 to 255, the default is 64.
187 .It Va dev.vge.%d.tx_coal_pkt
188 Maximum number of packets to fire Tx completion interrupt.
189 The valid range is 1 to 255, the default is 128.
193 .It "vge%d: couldn't map memory"
194 A fatal initialization error has occurred.
195 .It "vge%d: couldn't map ports"
196 A fatal initialization error has occurred.
197 .It "vge%d: couldn't map interrupt"
198 A fatal initialization error has occurred.
199 .It "vge%d: failed to enable memory mapping!"
200 The driver failed to initialize PCI shared memory mapping.
202 happen if the card is not in a bus-master slot.
203 .It "vge%d: watchdog timeout"
204 The device has stopped responding to the network, or there is a problem with
205 the network connection (cable).
219 device driver first appeared in
224 driver was written by
225 .An Bill Paul Aq wpaul@windriver.com .