share/man/man4/vge.4

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