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 IXL 4 36.Os 37.Sh NAME 38.Nm ixl 39.Nd "Intel Ethernet 700 Series Driver" 40.Sh SYNOPSIS 41To compile this driver into the kernel, place the following lines in your 42kernel configuration file: 43.Bd -ragged -offset indent 44.Cd "device ixl" 45.Ed 46.Pp 47To load the driver as a module at boot time, place the following lines in 48.Xr loader.conf 5 : 49.Bd -literal -offset indent 50if_ixl_load="YES" 51.Ed 52.Sh DESCRIPTION 53.Ss Features 54The 55.Nm 56driver provides support for any PCI Express adapter or LOM 57(LAN On Motherboard) 58in the Intel Ethernet 700 Series. 59As of this writing, the series includes devices with these model numbers: 60.Pp 61.Bl -bullet -compact 62.It 63XL710 (40G) 64.It 65X710 (10G) 66.It 67XXV710 (25G) 68.It 69X722 (10G) 70.El 71.Pp 72The driver supports Jumbo Frames, TX/RX checksum offload, 73TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN 74tag insertion/extraction, VLAN checksum offload, VLAN TSO, and 75Receive Side Steering (RSS), all for both IPv4 and IPv6. 76For further hardware information and questions related to hardware 77requirements, see 78.Pa http://support.intel.com/ . 79.Pp 80Support for Jumbo Frames is provided via the interface MTU setting. 81Selecting an MTU larger than 1500 bytes with the 82.Xr ifconfig 8 83utility configures the adapter to receive and transmit Jumbo Frames. 84The maximum MTU size for Jumbo Frames is 9706. 85.Pp 86Offloads are also controlled via the interface, for instance, 87checksumming for both IPv4 and IPv6 can be set and unset, TSO4 88and/or TSO6, and finally LRO can be set and unset. 89.Pp 90For more information on configuring this device, see 91.Xr ifconfig 8 . 92.Ss Additional Utilities 93There are additional tools available from Intel to help configure and update 94the adapters covered by this driver. 95These tools can be downloaded directly from Intel at 96.Pa downloadcenter.intel.com , 97by searching for their names, or by installing certain packages: 98.Bl -item 99.It 100To change the behavior of the QSFP+ ports on XL710 adapters, use the 101Intel QCU (QSFP+ configuration utility); installed by the 102.Em sysutils/intel-qcu 103package. 104.It 105To update the firmware on an adapter, use the Intel Non-Volatile Memory (NVM) 106Update Utility; installed by the 107.Em sysutils/intel-nvmupdate 108package. 109.It 110Drivers are provided by Intel outside of the 111.Fx 112kernel; install the 113.Em net/intel-ixl-kmod 114package for the latest driver. 115.El 116.Sh HARDWARE 117Most adapters in the Intel Ethernet 700 Series with SFP+/SFP28/QSFP+ cages 118have firmware that requires that Intel qualified modules are used; these 119qualified modules are listed below. 120This qualification check cannot be disabled by the driver. 121.Pp 122The 123.Nm 124driver supports 40Gb Ethernet adapters with these QSFP+ modules: 125.Pp 126.Bl -bullet -compact 127.It 128Intel 4x10G/40G QSFP+ 40GBASE-SR4 E40GQSFPSR 129.It 130Intel 4x10G/40G QSFP+ 40GBASE-LR4 E40GQSFPLR 131.El 132.Pp 133The 134.Nm 135driver supports 25Gb Ethernet adapters with these SFP28 modules: 136.Pp 137.Bl -bullet -compact 138.It 139Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SR 140.It 141Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SRX (Extended Temp) 142.El 143.Pp 144The 145.Nm 146driver supports 25Gb and 10Gb Ethernet adapters with these SFP+ modules: 147.Pp 148.Bl -bullet -compact 149.It 150Intel 1G/10G SFP+ SR FTLX8571D3BCV-IT 151.It 152Intel 1G/10G SFP+ SR AFBR-703SDZ-IN2 153.It 154Intel 1G/10G SFP+ LR FTLX1471D3BCV-IT 155.It 156Intel 1G/10G SFP+ LR AFCT-701SDZ-IN2 157.It 158Intel 1G/10G SFP+ 10GBASE-SR E10GSFPSR 159.It 160Intel 10G SFP+ 10GBASE-SR E10GSFPSRX (Extended Temp) 161.It 162Intel 1G/10G SFP+ 10GBASE-LR E10GSFPLR 163.El 164.Pp 165Note that adapters also support all passive and active 166limiting direct attach cables that comply with SFF-8431 v4.1 and 167SFF-8472 v10.4 specifications. 168.Pp 169This is not an exhaustive list; please consult product documentation for an 170up-to-date list of supported media. 171.Sh LOADER TUNABLES 172Tunables can be set at the 173.Xr loader 8 174prompt before booting the kernel or stored in 175.Xr loader.conf 5 . 176.Bl -tag -width indent 177.It Va hw.ixl.rx_itr 178The RX interrupt rate value, set to 62 (124 usec) by default. 179.It Va hw.ixl.tx_itr 180The TX interrupt rate value, set to 122 (244 usec) by default. 181.It Va hw.ixl.i2c_access_method 182Access method that driver will use for I2C read and writes via 183.Xr sysctl 8 184or verbose 185.Xr ifconfig 8 186information display: 187.Bd -literal -offset indent 1880 - best available method 1891 - bit bang via I2CPARAMS register 1902 - register read/write via I2CCMD register 1913 - Use Admin Queue command (default best) 192.Ed 193.Pp 194Using the Admin Queue is only supported on 710 devices with FW version 1.7 or 195newer. 196Set to 0 by default. 197.It Va hw.ixl.enable_tx_fc_filter 198Filter out packets with Ethertype 0x8808 from being sent out by non-adapter 199sources. 200This prevents (potentially untrusted) software or 201.Xr iavf 4 202devices from sending out flow control packets and creating a DoS (Denial of 203Service) event. 204Enabled by default. 205.It Va hw.ixl.enable_head_writeback 206When the driver is finding the last TX descriptor processed by the hardware, 207use a value written to memory by the hardware instead of scanning the 208descriptor ring for completed descriptors. 209Enabled by default; disable to mimic the TX behavior found in 210.Xr ixgbe 4 . 211.El 212.Sh SYSCTL PROCEDURES 213.Bl -tag -width indent 214.It Va dev.ixl.#.fc 215Sets the 802.3x flow control mode that the adapter will advertise on the link. 216A value of 0 disables flow control, 3 enables full, 1 is RX, and 2 is TX pause. 217.Pp 218The negotiated flow control setting can be viewed in 219.Xr ifconfig 8 , 220in the interface's media field. 221.It Va dev.ixl.#.advertise_speed 222Set the speeds that the interface will advertise on the link. 223.Va dev.ixl.#.supported_speeds 224contains the speeds that are allowed to be set. 225.It Va dev.ixl.#.current_speed 226Displays the current speed. 227.It Va dev.ixl.#.fw_version 228Displays the current firmware and NVM versions of the adapter. 229.El 230.Sh INTERRUPT STORMS 231It is important to note that 40G operation can generate high 232numbers of interrupts, often incorrectly being interpreted as 233a storm condition in the kernel. 234It is suggested that this be resolved by setting: 235.Bl -tag -width indent 236.It Va hw.intr_storm_threshold: 0 237.El 238.Sh IOVCTL OPTIONS 239The driver supports additional optional parameters for created VFs 240(Virtual Functions) when using 241.Xr iovctl 8 : 242.Bl -tag -width indent 243.It mac-addr Pq unicast-mac 244Set the Ethernet MAC address that the VF will use. 245If unspecified, the VF will use a randomly generated MAC address. 246.It mac-anti-spoof Pq bool 247Prevent the VF from sending Ethernet frames with a source address 248that does not match its own. 249.It allow-set-mac Pq bool 250Allow the VF to set its own Ethernet MAC address 251.It allow-promisc Pq bool 252Allow the VF to inspect all of the traffic sent to the port. 253.It num-queues Pq uint16_t 254Specify the number of queues the VF will have. 255By default, this is set to the number of MSI-X vectors supported by the VF 256minus one. 257.El 258.Pp 259An up to date list of parameters and their defaults can be found by using 260.Xr iovctl 8 261with the -S option. 262.Sh SUPPORT 263For general information and support, 264go to the Intel support website at: 265.Pa http://support.intel.com/ . 266.Pp 267If an issue is identified with this driver with a supported adapter, 268email all the specific information related to the issue to 269.Mt freebsd@intel.com . 270.Sh SEE ALSO 271.Xr arp 4 , 272.Xr iavf 4 , 273.Xr netintro 4 , 274.Xr vlan 4 , 275.Xr ifconfig 8 , 276.Xr iovctl 8 , 277.Xr iflib 9 278.Sh HISTORY 279The 280.Nm 281device driver first appeared in 282.Fx 10.1 . 283It was converted to use 284.Xr iflib 9 285in 286.Fx 12 . 287.Sh AUTHORS 288.An -nosplit 289The 290.Nm 291driver was written by 292.An Jack Vogel Aq Mt jfv@freebsd.org 293and 294.An Eric Joyner Aq Mt erj@freebsd.org . 295