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