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