1.\" Copyright (c) 2013-2018, Intel Corporation 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 are met: 6.\" 7.\" 1. Redistributions of source code must retain the above copyright notice, 8.\" this list of conditions and the following disclaimer. 9.\" 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" 3. Neither the name of the Intel Corporation nor the names of its 15.\" contributors may be used to endorse or promote products derived from 16.\" this software without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.\" * Other names and brands may be claimed as the property of others. 31.\" 32.\" $FreeBSD$ 33.\" 34.Dd January 30, 2019 35.Dt IAVF 4 36.Os 37.Sh NAME 38.Nm iavf 39.Nd "Intel Adaptive Virtual Function driver" 40.Sh SYNOPSIS 41To compile this driver into the kernel, place the following lines in your 42kernel configuration file: 43.Bd -ragged -offset indent 44.Cd "device iflib" 45.Cd "device iavf" 46.Ed 47.Pp 48To load the driver as a module at boot time, place the following lines in 49.Xr loader.conf 5 : 50.Bd -literal -offset indent 51if_iavf_load="YES" 52.Ed 53.Sh DESCRIPTION 54The 55.Nm 56driver provides support for the PCI Virtual Functions from the 700 Series of 57ethernet devices and newer product families. 58The driver supports Jumbo Frames, TX/RX checksum offload, 59TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN 60tag insertion/extraction, VLAN checksum offload, VLAN TSO, and 61Receive Side Steering (RSS), all for both IPv4 and IPv6. 62For further hardware information and questions related to hardware 63requirements, see 64.Pa http://support.intel.com/ . 65.Pp 66Support for Jumbo Frames is provided via the interface MTU setting. 67Selecting an MTU larger than 1500 bytes with the 68.Xr ifconfig 8 69utility configures the adapter to receive and transmit Jumbo Frames. 70The maximum MTU size for Jumbo Frames is 9706. 71.Pp 72Offloads are also controlled via the interface, for instance, 73checksumming for both IPv4 and IPv6 can be set and unset, TSO4 74and/or TSO6, and finally LRO can be set and unset. 75.Pp 76For more information on configuring this device, see 77.Xr ifconfig 8 . 78.Pp 79.Em NOTE : 80This 81.Nm 82driver is only for Virtual Functions. 83For 700 series Physical Functions, use the 84.Xr ixl 4 85driver. 86.Sh LOADER TUNABLES 87Tunables can be set at the 88.Xr loader 8 89prompt before booting the kernel or stored in 90.Xr loader.conf 5 . 91.Bl -tag -width indent 92.It Va hw.iavf.rx_itr 93The RX interrupt rate value, set to 62 (124 usec) by default. 94.It Va hw.iavf.tx_itr 95The TX interrupt rate value, set to 122 (244 usec) by default. 96.It Va hw.iavf.enable_head_writeback 97When the driver is finding the last TX descriptor processed by the hardware, 98use a value written to memory by the hardware instead of scanning the 99descriptor ring for completed descriptors. 100Disabled by default; this mimics the "legacy" TX behavior found in 101.Xr ixgbe 4 . 102to ensure compatibility with future, non-700 series VF devices. 103.El 104.Sh SUPPORT 105For general information and support, 106go to the Intel support website at: 107.Pa http://support.intel.com/ . 108.Pp 109If an issue is identified with this driver with a supported adapter, 110email all the specific information related to the issue to 111.Mt freebsd@intel.com . 112.Sh SEE ALSO 113.Xr arp 4 , 114.Xr ixl 4 , 115.Xr netintro 4 , 116.Xr vlan 4 , 117.Xr ifconfig 8 , 118.Xr iflib 9 119.Sh HISTORY 120The 121.Nm 122device driver first appeared in 123.Fx 10.1 . 124under the name "ixlv" 125It was converted to use 126.Xr iflib 9 127and changed to its current name in 128.Fx 12 . 129.Sh AUTHORS 130.An -nosplit 131The 132.Nm 133driver was written by 134.An Jack Vogel Aq Mt jfv@freebsd.org 135and 136.An Eric Joyner Aq Mt erj@freebsd.org . 137.Sh CAVEATS 138This driver is supposed to function on VFs spawned from future network devices by Intel, 139but at the time of this writing, has only been tested on the 700 series VFs. 140