share/man/man4/iavf.4

   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
  41 To compile this driver into the kernel, place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device iflib"
  45 .Cd "device iavf"
  46 .Ed
  47 .Pp
  48 To load the driver as a module at boot time, place the following lines in
  49 .Xr loader.conf 5 :
  50 .Bd -literal -offset indent
  51 if_iavf_load="YES"
  52 .Ed
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 driver provides support for the PCI Virtual Functions from the 700 Series of
  57 ethernet devices and newer product families.
  58 The driver supports Jumbo Frames, TX/RX checksum offload,
  59 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  60 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  61 Receive Side Steering (RSS), all for both IPv4 and IPv6.
  62 For further hardware information and questions related to hardware
  63 requirements, see
  64 .Pa http://support.intel.com/ .
  65 .Pp
  66 Support for Jumbo Frames is provided via the interface MTU setting.
  67 Selecting an MTU larger than 1500 bytes with the
  68 .Xr ifconfig 8
  69 utility configures the adapter to receive and transmit Jumbo Frames.
  70 The maximum MTU size for Jumbo Frames is 9706.
  71 .Pp
  72 Offloads are also controlled via the interface, for instance,
  73 checksumming for both IPv4 and IPv6 can be set and unset, TSO4
  74 and/or TSO6, and finally LRO can be set and unset.
  75 .Pp
  76 For more information on configuring this device, see
  77 .Xr ifconfig 8 .
  78 .Pp
  79 .Em NOTE :
  80 This
  81 .Nm
  82 driver is only for Virtual Functions.
  83 For 700 series Physical Functions, use the
  84 .Xr ixl 4
  85 driver.
  86 .Sh LOADER TUNABLES
  87 Tunables can be set at the
  88 .Xr loader 8
  89 prompt before booting the kernel or stored in
  90 .Xr loader.conf 5 .
  91 .Bl -tag -width indent
  92 .It Va hw.iavf.rx_itr
  93 The RX interrupt rate value, set to 62 (124 usec) by default.
  94 .It Va hw.iavf.tx_itr
  95 The TX interrupt rate value, set to 122 (244 usec) by default.
  96 .It Va hw.iavf.enable_head_writeback
  97 When the driver is finding the last TX descriptor processed by the hardware,
  98 use a value written to memory by the hardware instead of scanning the
  99 descriptor ring for completed descriptors.
 100 Disabled by default; this mimics the "legacy" TX behavior found in
 101 .Xr ixgbe 4 .
 102 to ensure compatibility with future, non-700 series VF devices.
 103 .El
 104 .Sh SUPPORT
 105 For general information and support,
 106 go to the Intel support website at:
 107 .Pa http://support.intel.com/ .
 108 .Pp
 109 If an issue is identified with this driver with a supported adapter,
 110 email 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
 120 The
 121 .Nm
 122 device driver first appeared in
 123 .Fx 10.1 .
 124 under the name "ixlv"
 125 It was converted to use
 126 .Xr iflib 9
 127 and changed to its current name in
 128 .Fx 12 .
 129 .Sh AUTHORS
 130 .An -nosplit
 131 The
 132 .Nm
 133 driver was written by
 134 .An Jack Vogel Aq Mt jfv@freebsd.org
 135 and
 136 .An Eric Joyner Aq Mt erj@freebsd.org .
 137 .Sh CAVEATS
 138 This driver is supposed to function on VFs spawned from future network devices by Intel,
 139 but at the time of this writing, has only been tested on the 700 series VFs.