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