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