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