share/man/man4/ixlv.4

   1 .\" Copyright (c) 2013-2015, 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 March 25, 2015
  35 .Dt IXLV 4
  36 .Os
  37 .Sh NAME
  38 .Nm ixlv
  39 .Nd "Intel XL710 Ethernet 40Gb VF driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device ixlv"
  46 .Ed
  47 .Pp
  48 To load the driver as a
  49 module at boot time, place the following lines in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_ixlv_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides virtualization support for PCI Express adapters
  58 or LOMs in the XL710 Family of ethernet devices.
  59 The driver supports Jumbo Frames, TX/RX checksum offload,
  60 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  61 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  62 Receive Side Steering (RSS), all for both IPv4 and IPv6.
  63 For further hardware information and questions related to hardware
  64 requirements, see
  65 .Pa http://support.intel.com/ .
  66 .Pp
  67 Support for Jumbo Frames is provided via the interface MTU setting.
  68 Selecting an MTU larger than 1500 bytes with the
  69 .Xr ifconfig 8
  70 utility configures the adapter to receive and transmit Jumbo Frames.
  71 The maximum MTU size for Jumbo Frames is 9706.
  72 .Pp
  73 Offloads are also controlled via the interface, for instance,
  74 checksumming for both IPv4 and IPv6 can be set and unset, TSO4
  75 and/or TSO6, and finally LRO can be set and unset.
  76 .Pp
  77 For more information on configuring this device, see
  78 .Xr ifconfig 8 .
  79 .Pp
  80 .Em NOTE :
  81 The
  82 .Nm
  83 driver is only used by means of SRIOV, normally in a VM on a
  84 hosting server with the
  85 .Xr ixl 4
  86 driver.
  87 .Sh LOADER TUNABLES
  88 Tunables can be set at the
  89 .Xr loader 8
  90 prompt before booting the kernel or stored in
  91 .Xr loader.conf 5 .
  92 .Bl -tag -width indent
  93 .It Va hw.ixlv.ringsz
  94 Set the number of descriptors in the rings, note that this
  95 changes BOTH the TX and RX rings, they cannot be set independently.
  96 .It Va hw.ixlv.max_queues
  97 Set the number of queues (each a TX/RX pair) for the port, this
  98 allows one to override the autocalculation if it is set to 0.
  99 .It Va hw.ixlv.txbrsz
 100 Set the size of the buff ring used by the transmit side of the
 101 stack, we have found that it is necessary to have it quite large
 102 in order to get UDP to perform well.
 103 .It Va hw.ixlv.dynamic_rx_itr
 104 The dynamic RX interrupt control, set to 1 to enable, off by default.
 105 .It Va hw.ixlv.dynamic_tx_itr
 106 The dynamic TX interrupt control, set to 1 to enable, off by default.
 107 .It Va hw.ixlv.rx_itr
 108 The RX interrupt rate value, set to 8K by default.
 109 .It Va hw.ixlv.tx_itr
 110 The TX interrupt rate value, set to 4K by default.
 111 .El
 112 .Sh SUPPORT
 113 For general information and support,
 114 go to the Intel support website at:
 115 .Pa http://support.intel.com/ .
 116 .Pp
 117 If an issue is identified with this driver with a supported adapter,
 118 email all the specific information related to the issue to
 119 .Aq freebsd@intel.com .
 120 .Sh SEE ALSO
 121 .Xr arp 4 ,
 122 .Xr ixl 4 ,
 123 .Xr netintro 4 ,
 124 .Xr ng_ether 4 ,
 125 .Xr vlan 4 ,
 126 .Xr ifconfig 8
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 device driver first appeared in
 131 .Fx 10.1 .
 132 .Sh AUTHORS
 133 .An -nosplit
 134 The
 135 .Nm
 136 driver was written by
 137 .An Jack Vogel Aq Mt jfv@FreeBSD.org
 138 and
 139 .An Eric Joyner Aq Mt ricera10@gmail.com .