1.\" Copyright (c) 2011 Bryan Venteicher
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.\"
| 1.\" Copyright (c) 2011 Bryan Venteicher
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: head/share/man/man4/vtnet.4 230450 2012-01-22 10:16:24Z brueffer $
| 25.\" $FreeBSD: head/share/man/man4/vtnet.4 252707 2013-07-04 17:57:26Z bryanv $
|
26.\"
27.Dd January 22, 2012
28.Dt VTNET 4
29.Os
30.Sh NAME
31.Nm vtnet
32.Nd VirtIO Ethernet driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device if_vtnet"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45if_vtnet_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50device driver provides support for VirtIO Ethernet devices.
51.Pp
52If the hypervisor advertises the appreciate features, the
53.Nm
54driver supports TCP/UDP checksum offload for both transmit and receive,
55TCP segmentation offload (TSO), TCP large receive offload (LRO), and
56hardware VLAN tag stripping/insertion features, as well as a multicast
57hash filter, as well as Jumbo Frames (up to 9216 bytes), which can be
58configured via the interface MTU setting.
59Selecting an MTU larger than 1500 bytes with the
60.Xr ifconfig 8
61utility configures the adapter to receive and transmit Jumbo Frames.
62.Pp
63For more information on configuring this device, see
64.Xr ifconfig 8 .
65.Sh LOADER TUNABLES
66Tunables can be set at the
67.Xr loader 8
68prompt before booting the kernel or stored in
69.Xr loader.conf 5 .
70.Bl -tag -width "xxxxxx"
71.It Va hw.vtnet.csum_disable
72This tunable disables receive and send checksum offload.
73The default value is 0.
74.It Va hw.vtnet.tso_disable
75This tunable disables TSO.
76The default value is 0.
77.It Va hw.vtnet.lro_disable
78This tunable disables LRO.
79The default value is 0.
80.El
81.Sh SEE ALSO
82.Xr arp 4 ,
83.Xr netintro 4 ,
84.Xr ng_ether 4 ,
85.Xr virtio 4 ,
86.Xr vlan 4 ,
87.Xr ifconfig 8
88.Sh HISTORY
89The
90.Nm
91driver was written by
| 26.\"
27.Dd January 22, 2012
28.Dt VTNET 4
29.Os
30.Sh NAME
31.Nm vtnet
32.Nd VirtIO Ethernet driver
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device if_vtnet"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45if_vtnet_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50device driver provides support for VirtIO Ethernet devices.
51.Pp
52If the hypervisor advertises the appreciate features, the
53.Nm
54driver supports TCP/UDP checksum offload for both transmit and receive,
55TCP segmentation offload (TSO), TCP large receive offload (LRO), and
56hardware VLAN tag stripping/insertion features, as well as a multicast
57hash filter, as well as Jumbo Frames (up to 9216 bytes), which can be
58configured via the interface MTU setting.
59Selecting an MTU larger than 1500 bytes with the
60.Xr ifconfig 8
61utility configures the adapter to receive and transmit Jumbo Frames.
62.Pp
63For more information on configuring this device, see
64.Xr ifconfig 8 .
65.Sh LOADER TUNABLES
66Tunables can be set at the
67.Xr loader 8
68prompt before booting the kernel or stored in
69.Xr loader.conf 5 .
70.Bl -tag -width "xxxxxx"
71.It Va hw.vtnet.csum_disable
72This tunable disables receive and send checksum offload.
73The default value is 0.
74.It Va hw.vtnet.tso_disable
75This tunable disables TSO.
76The default value is 0.
77.It Va hw.vtnet.lro_disable
78This tunable disables LRO.
79The default value is 0.
80.El
81.Sh SEE ALSO
82.Xr arp 4 ,
83.Xr netintro 4 ,
84.Xr ng_ether 4 ,
85.Xr virtio 4 ,
86.Xr vlan 4 ,
87.Xr ifconfig 8
88.Sh HISTORY
89The
90.Nm
91driver was written by
|
92.An Bryan Venteicher Aq bryanv@daemoninthecloset.org .
| 92.An Bryan Venteicher Aq bryanv@FreeBSD.org .
|
93It first appeared in
94.Fx 9.0 .
95.Sh CAVEATS
96The
97.Nm
98driver only supports LRO when the hypervisor advertises the
99mergeable buffer feature.
| 93It first appeared in
94.Fx 9.0 .
95.Sh CAVEATS
96The
97.Nm
98driver only supports LRO when the hypervisor advertises the
99mergeable buffer feature.
|