share/man/man4/ixl.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 January 14, 2015
  35 .Dt IXL 4
  36 .Os
  37 .Sh NAME
  38 .Nm ixl
  39 .Nd "Intel XL710 Ethernet 40Gb Base 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 ixl"
  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_ixl_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Express adapters or LOMs
  58 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 .Sh HARDWARE
  80 The
  81 .Nm
  82 driver supports these SFP+ Pluggable Optics:
  83 .Pp
  84 .Bl -bullet -compact
  85 .It
  86 Intel TRIPLE RATE 1G/10G/40G QSFP+ SR (bailed) E40GQSFPSR
  87 .It
  88 Intel TRIPLE RATE 1G/10G/40G QSFP+ SR (bailed) E40GQSFPLR
  89 .El
  90 .Pp
  91 The
  92 .Nm
  93 driver supports 10Gb and 1Gb Ethernet adapters with SR Modules:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 Intel DUAL RATE 1G/10G SFP+ SR (bailed) FTLX8571D3BCV-IT
  98 .It
  99 Intel DUAL RATE 1G/10G SFP+ SR (bailed) AFBR-703SDZ-IN2
 100 .El
 101 .Pp
 102 The
 103 .Nm
 104 driver supports 10Gb and 1Gb Ethernet adapters with LR Modules:
 105 .Pp
 106 .Bl -bullet -compact
 107 .It
 108 Intel DUAL RATE 1G/10G SFP+ LR (bailed) FTLX1471D3BCV-IT
 109 .It
 110 Intel DUAL RATE 1G/10G SFP+ LR (bailed) AFCT-701SDZ-IN2
 111 .El
 112 .Pp
 113 Note that X710/XL710 Based SFP+ adapters also support all passive and active
 114 limiting direct attach cables that comply with SFF-8431 v4.1 and
 115 SFF-8472 v10.4 specifications.
 116
 117 .Pp
 118 .Sh LOADER TUNABLES
 119 Tunables can be set at the
 120 .Xr loader 8
 121 prompt before booting the kernel or stored in
 122 .Xr loader.conf 5 .
 123 .Bl -tag -width indent
 124 .It Va hw.ixl.enable_msix
 125 Allows one to enable/disable MSIX, thus forcing MSI instead.
 126 .It Va hw.ixl.ringsz
 127 Set the number of descriptors in the rings, note that this
 128 changes BOTH the TX and RX rings, they cannot be set independly.
 129 .It Va hw.ixl.max_queues
 130 Set the number of queues (each a TX/RX pair) for the port, this
 131 allows one to override the autocalculation if its set to 0.
 132 .It Va hw.ixl.dynamic_rx_itr
 133 The dynamic RX interrupt control, set to 1 to enable.
 134 .It Va hw.ixl.dynamic_tx_itr
 135 The dynamic TX interrupt control, set to 1 to enable.
 136 .It Va hw.ixl.rx_itr
 137 The RX interrupt rate value, set to 8K by default.
 138 .It Va hw.ixl.tx_itr
 139 The TX interrupt rate value, set to 4K by default.
 140 .El
 141 .Pp
 142 .Sh SYSCTL PROCEDURES
 143 .Bl -tag -width indent
 144 .It Va hw.ixl.fc
 145 Allows one to set the flow control value. A value of 0 disables
 146 flow control, 3 enables full, 1 is RX, and 2 is TX pause.
 147 .It Va hw.ixl.advertise_speed
 148 Allows one to set advertised link speeds, this will then
 149 cause a link renegotiation. With the appropriate adapter
 150 this can cause a link at 10GB, 1GB, or 100MB.
 151 .It Va hw.ixl.current_speed
 152 This is a display of the current setting.
 153 .It Va hw.ixl.fw_version
 154 This is a display of the Firmware version.
 155 .Sh Interrupt Storms
 156 It is important to note that 40G operation can generate high
 157 numbers of interrupts, often incorrectly being interpreted as
 158 a storm condition in the kernel. It is suggested that this
 159 be resolved by setting:
 160 .Bl -tag -width indent
 161 .It Va hw.intr_storm_threshold: 0
 162 .Sh SUPPORT
 163 For general information and support,
 164 go to the Intel support website at:
 165 .Pa http://support.intel.com/ .
 166 .Pp
 167 If an issue is identified with this driver with a supported adapter,
 168 email all the specific information related to the issue to
 169 .Aq freebsd@intel.com .
 170 .Sh SEE ALSO
 171 .Xr arp 4 ,
 172 .Xr netintro 4 ,
 173 .Xr ng_ether 4 ,
 174 .Xr vlan 4 ,
 175 .Xr ifconfig 8
 176 .Sh HISTORY
 177 The
 178 .Nm
 179 device driver first appeared in
 180 .Fx 10.1 .
 181 .Sh AUTHORS
 182 .An -nosplit
 183 The
 184 .Nm
 185 driver was written by
 186 .An Jack Vogel Aq Mt jfv@FreeBSD.org
 187 and
 188 .An Eric Joyner Aq Mt ricera10@gmail.com .