share/man/man4/vte.4

   1 .\" Copyright (c) 2010 Pyun YongHyeon
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 30, 2010
  28 .Dt VTE 4
  29 .Os
  30 .Sh NAME
  31 .Nm vte
  32 .Nd Vortex86 RDC R6040 Fast Ethernet driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device miibus"
  39 .Cd "device vte"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 if_vte_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 device driver provides support for RDC R6040 Fast Ethernet controller
  52 which is commonly found on Vortex86 System On a Chip (SoC).
  53 .Pp
  54 The RDC R6040 has integrated 10/100 PHY for 10/100Mbps support in full
  55 or half-duplex.
  56 The controller supports interrupt moderation mechanism, a 64-bit multicast
  57 hash filter, VLAN over-size frame and four station addresses.
  58 The
  59 .Nm
  60 device driver uses three station addresses out of four as perfect
  61 multicast filter.
  62 .Pp
  63 The
  64 .Nm
  65 driver supports the following media types:
  66 .Bl -tag -width ".Cm 10baseT/UTP"
  67 .It Cm autoselect
  68 Enable autoselection of the media type and options.
  69 The user can manually override
  70 the autoselected mode by adding media options to
  71 .Xr rc.conf 5 .
  72 .It Cm 10baseT/UTP
  73 Set 10Mbps operation.
  74 .It Cm 100baseTX
  75 Set 100Mbps (Fast Ethernet) operation.
  76 .El
  77 .Pp
  78 The
  79 .Nm
  80 driver supports the following media options:
  81 .Bl -tag -width ".Cm full-duplex"
  82 .It Cm full-duplex
  83 Force full duplex operation.
  84 .It Cm half-duplex
  85 Force half duplex operation.
  86 .El
  87 .Pp
  88 For more information on configuring this device, see
  89 .Xr ifconfig 8 .
  90 .Sh HARDWARE
  91 The
  92 .Nm
  93 device driver provides support for the following Ethernet controllers:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 DM&P Vortex86 RDC R6040 Fast Ethernet controller
  98 .El
  99 .Sh LOADER TUNABLES
 100 Tunables can be set at the
 101 .Xr loader 8
 102 prompt before booting the kernel or stored in
 103 .Xr loader.conf 5 .
 104 .Bl -tag -width "xxxxxx"
 105 .It Va hw.vte.tx_deep_copy
 106 The RDC R6040 controller has no auto-padding support for short
 107 frames and the controller's DMA engine does not have capability to
 108 handle multiple buffers for a TX frame such that driver has to
 109 create a single contiguous TX buffer.
 110 This hardware limitation leads to poor TX performance since most of
 111 CPU cycles are wasted on both de-fragmenting mbuf chains and padding.
 112 This tunable enables deep copy operation for TX frames such that
 113 driver will spend less CPU cycles in de-fragmentation with the
 114 cost of extra TX buffer memory.
 115 The default value is 1 to use deep copy.
 116 .El
 117 .Sh SYSCTL VARIABLES
 118 The following variables are available as both
 119 .Xr sysctl 8
 120 variables and
 121 .Xr loader 8
 122 tunables:
 123 .Bl -tag -width "xxxxxx"
 124 .It Va dev.vte.%d.rx_mod
 125 Maximum number of packets to fire RX completion interrupt.
 126 The accepted range is 0 to 15, the default is 15.
 127 .It Va dev.vte.%d.tx_mod
 128 Maximum number of packets to fire TX completion interrupt.
 129 The accepted range is 0 to 15, the default is 15.
 130 .It Va dev.vte.%d.stats
 131 Show hardware MAC statistics maintained in driver.
 132 .El
 133 .Sh SEE ALSO
 134 .Xr altq 4 ,
 135 .Xr arp 4 ,
 136 .Xr miibus 4 ,
 137 .Xr netintro 4 ,
 138 .Xr ng_ether 4 ,
 139 .Xr vlan 4 ,
 140 .Xr ifconfig 8
 141 .Rs
 142 .%T "DM&P Electronics Inc. Vortex86"
 143 .%U http://www.dmp.com.tw
 144 .Re
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 driver was written by
 149 .An Pyun YongHyeon
 150 .Aq yongari@FreeBSD.org .
 151 It first appeared in
 152 .Fx 8.3 .