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 August 1, 2023 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.Lk 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.Lk https://downloadcenter.intel.com , 98by searching for their names, or by installing certain packages: 99.Bl -bullet 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-10g , 109.Em sysutils/intel-nvmupdate-40g , 110or 111.Em sysutils/intel-nvmupdate-100g , 112package. 113.It 114Drivers are provided by Intel outside of the 115.Fx 116kernel; install the 117.Em net/intel-ixl-kmod 118package for the latest driver. 119.El 120.Sh HARDWARE 121Most adapters in the Intel Ethernet 700 Series with SFP+/SFP28/QSFP+ cages 122have firmware that requires that Intel qualified modules are used; these 123qualified modules are listed below. 124This qualification check cannot be disabled by the driver. 125.Pp 126The 127.Nm 128driver supports 40Gb Ethernet adapters with these QSFP+ modules: 129.Pp 130.Bl -bullet -compact 131.It 132Intel 4x10G/40G QSFP+ 40GBASE-SR4 E40GQSFPSR 133.It 134Intel 4x10G/40G QSFP+ 40GBASE-LR4 E40GQSFPLR 135.El 136.Pp 137The 138.Nm 139driver supports 25Gb Ethernet adapters with these SFP28 modules: 140.Pp 141.Bl -bullet -compact 142.It 143Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SR 144.It 145Intel 10G/25G SFP28 25GBASE-SR E25GSFP28SRX (Extended Temp) 146.El 147.Pp 148The 149.Nm 150driver supports 25Gb and 10Gb Ethernet adapters with these SFP+ modules: 151.Pp 152.Bl -bullet -compact 153.It 154Intel 1G/10G SFP+ SR FTLX8571D3BCV-IT 155.It 156Intel 1G/10G SFP+ SR AFBR-703SDZ-IN2 157.It 158Intel 1G/10G SFP+ LR FTLX1471D3BCV-IT 159.It 160Intel 1G/10G SFP+ LR AFCT-701SDZ-IN2 161.It 162Intel 1G/10G SFP+ 10GBASE-SR E10GSFPSR 163.It 164Intel 10G SFP+ 10GBASE-SR E10GSFPSRX (Extended Temp) 165.It 166Intel 1G/10G SFP+ 10GBASE-LR E10GSFPLR 167.El 168.Pp 169Note that adapters also support all passive and active 170limiting direct attach cables that comply with SFF-8431 v4.1 and 171SFF-8472 v10.4 specifications. 172.Pp 173This is not an exhaustive list; please consult product documentation for an 174up-to-date list of supported media. 175.Sh LOADER TUNABLES 176Tunables can be set at the 177.Xr loader 8 178prompt before booting the kernel or stored in 179.Xr loader.conf 5 . 180.Bl -tag -width indent 181.It Va hw.ixl.rx_itr 182The RX interrupt rate value, set to 62 (124 usec) by default. 183.It Va hw.ixl.tx_itr 184The TX interrupt rate value, set to 122 (244 usec) by default. 185.It Va hw.ixl.i2c_access_method 186Access method that driver will use for I2C read and writes via 187.Xr sysctl 8 188or verbose 189.Xr ifconfig 8 190information display: 191.Bd -literal -offset indent 1920 - best available method 1931 - bit bang via I2CPARAMS register 1942 - register read/write via I2CCMD register 1953 - Use Admin Queue command (default best) 196.Ed 197.Pp 198Using the Admin Queue is only supported on 710 devices with FW version 1.7 or 199newer. 200Set to 0 by default. 201.It Va hw.ixl.enable_tx_fc_filter 202Filter out packets with Ethertype 0x8808 from being sent out by non-adapter 203sources. 204This prevents (potentially untrusted) software or 205.Xr iavf 4 206devices from sending out flow control packets and creating a DoS (Denial of 207Service) event. 208Enabled by default. 209.It Va hw.ixl.enable_head_writeback 210When the driver is finding the last TX descriptor processed by the hardware, 211use a value written to memory by the hardware instead of scanning the 212descriptor ring for completed descriptors. 213Enabled by default; disable to mimic the TX behavior found in 214.Xr ixgbe 4 . 215.El 216.Sh SYSCTL PROCEDURES 217.Bl -tag -width indent 218.It Va dev.ixl.#.fc 219Sets the 802.3x flow control mode that the adapter will advertise on the link. 220A value of 0 disables flow control, 3 enables full, 1 is RX, and 2 is TX pause. 221.Pp 222The negotiated flow control setting can be viewed in 223.Xr ifconfig 8 , 224in the interface's media field. 225.It Va dev.ixl.#.advertise_speed 226Set the speeds that the interface will advertise on the link. 227.Va dev.ixl.#.supported_speeds 228contains the speeds that are allowed to be set. 229.It Va dev.ixl.#.current_speed 230Displays the current speed. 231.It Va dev.ixl.#.fw_version 232Displays the current firmware and NVM versions of the adapter. 233.It Va dev.ixl.#.debug.switch_vlans 234Set the Ethertype used by the hardware itself to handle internal 235services. 236Frames with this Ethertype will be dropped without notice. 237Defaults to 238.Dv 0x88a8 , 239which is a well known number for IEEE 802.1ad VLAN stacking. 240If you need 802.1ad support, set this number to any another Ethertype i.e. 241.Dv 0xffff . 242.El 243.Sh INTERRUPT STORMS 244It is important to note that 40G operation can generate high 245numbers of interrupts, often incorrectly being interpreted as 246a storm condition in the kernel. 247It is suggested that this be resolved by setting: 248.Bl -tag -width indent 249.It Va hw.intr_storm_threshold: 0 250.El 251.Sh IOVCTL OPTIONS 252The driver supports additional optional parameters for created VFs 253(Virtual Functions) when using 254.Xr iovctl 8 : 255.Bl -tag -width indent 256.It mac-addr Pq unicast-mac 257Set the Ethernet MAC address that the VF will use. 258If unspecified, the VF will use a randomly generated MAC address. 259.It mac-anti-spoof Pq bool 260Prevent the VF from sending Ethernet frames with a source address 261that does not match its own. 262.It allow-set-mac Pq bool 263Allow the VF to set its own Ethernet MAC address 264.It allow-promisc Pq bool 265Allow the VF to inspect all of the traffic sent to the port. 266.It num-queues Pq uint16_t 267Specify the number of queues the VF will have. 268By default, this is set to the number of MSI-X vectors supported by the VF 269minus one. 270.El 271.Pp 272An up to date list of parameters and their defaults can be found by using 273.Xr iovctl 8 274with the -S option. 275.Sh SUPPORT 276For general information and support, 277go to the Intel support website at: 278.Lk http://support.intel.com/ . 279.Pp 280If an issue is identified with this driver with a supported adapter, 281email all the specific information related to the issue to 282.Mt freebsd@intel.com . 283.Sh SEE ALSO 284.Xr arp 4 , 285.Xr iavf 4 , 286.Xr iflib 4 , 287.Xr netintro 4 , 288.Xr vlan 4 , 289.Xr ifconfig 8 , 290.Xr iovctl 8 291.Sh HISTORY 292The 293.Nm 294device driver first appeared in 295.Fx 10.1 . 296It was converted to use 297.Xr iflib 9 298in 299.Fx 12 . 300.Sh AUTHORS 301.An -nosplit 302The 303.Nm 304driver was written by 305.An Jack Vogel Aq Mt jfv@freebsd.org 306and 307.An Eric Joyner Aq Mt erj@freebsd.org . 308