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