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