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