1.\"- 2.\" SPDX-License-Identifier: BSD-3-Clause 3.\" 4.\" Copyright (c) 2019-2020, Intel Corporation 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms of the Software, with or 8.\" without modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright notice, 11.\" this list of conditions and the following disclaimer. 12.\" 13.\" 2. Redistributions in binary form must reproduce the above copyright notice, 14.\" this list of conditions and the following disclaimer in the documentation 15.\" and/or other materials provided with the distribution. 16.\" 17.\" 3. Neither the name of the Intel Corporation nor the names of its 18.\" contributors may be used to endorse or promote products derived from 19.\" this Software without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 25.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31.\" POSSIBILITY OF SUCH DAMAGE. 32.\" 33.\" * Other names and brands may be claimed as the property of others. 34.\" 35.Dd May 20, 2024 36.Dt ICE 4 37.Os 38.Sh NAME 39.Nm ice 40.Nd "Intel Ethernet 800 Series Driver" 41.Sh SYNOPSIS 42To compile this driver into the kernel, place the following lines in your 43kernel configuration file: 44.Bd -ragged -offset indent 45.Cd "device iflib" 46.Cd "device ice" 47.Ed 48.Pp 49To load the driver as a module at boot time, place the following lines in 50.Xr loader.conf 5 : 51.Bd -literal -offset indent 52if_ice_load="YES" 53.Ed 54.Sh DESCRIPTION 55.Ss Features 56The 57.Nm 58driver provides support for any PCI Express adapter or LOM 59(LAN On Motherboard) 60in the Intel Ethernet 800 Series. 61As of this writing, the series includes devices with these model numbers: 62.Pp 63.Bl -bullet -compact 64.It 65Intel\(rg Ethernet Controller E810\-C 66.It 67Intel\(rg Ethernet Controller E810\-XXV 68.It 69Intel\(rg Ethernet Connection E822\-C 70.It 71Intel\(rg Ethernet Connection E822\-L 72.It 73Intel\(rg Ethernet Connection E823\-C 74.It 75Intel\(rg Ethernet Connection E823\-L 76.El 77.Pp 78For questions related to hardware requirements, refer to the documentation 79supplied with your adapter. 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. 86This value coincides with the maximum Jumbo Frame size of 9728. 87.Pp 88This driver version supports VLANs. 89For information on enabling VLANs, see the 90.Pa README . 91.Pp 92Offloads are also controlled via the interface, for instance, checksumming for 93both IPv4 and IPv6 can be set and unset, TSO4 and/or TSO6, and finally LRO can 94be set and unset. 95.Pp 96For more information on configuring this device, see 97.Xr ifconfig 8 . 98.Ss Additional Utilities 99There are additional tools available from Intel to help configure and update 100the adapters covered by this driver. 101These tools can be downloaded directly from Intel at 102.Lk https://downloadcenter.intel.com , 103by searching for their names, or by installing certain packages: 104.Bl -bullet 105.It 106To change the behavior of the QSFP28 ports on E810-C adapters, use the 107Intel EPCT (Ethernet Port configuration tool); installed by the 108.Em sysutils/intel-epct 109package. 110.It 111To update the firmware on an adapter, use the Intel Non-Volatile Memory (NVM) 112Update Utility for Intel Network Adapter 800 series; installed by the 113.Em sysutils/intel-nvmupdate-100g 114package. 115.El 116.Sh HARDWARE 117The 118.Nm 119driver supports the Intel Ethernet 800 series. 120Most adapters in this series with SFP28/QSFP28 cages 121have firmware that requires that Intel qualified modules are used; these 122qualified modules are listed below. 123This qualification check cannot be disabled by the driver. 124.Pp 125The 126.Nm 127driver supports 100Gb Ethernet adapters with these QSFP28 modules: 128.Pp 129.Bl -bullet -compact 130.It 131Intel\(rg 100G QSFP28 100GBASE-SR4 E100GQSFPSR28SRX 132.It 133Intel\(rg 100G QSFP28 100GBASE-SR4 SPTMBP1PMCDF 134.It 135Intel\(rg 100G QSFP28 100GBASE-CWDM4 SPTSBP3CLCCO 136.It 137Intel\(rg 100G QSFP28 100GBASE-DR SPTSLP2SLCDF 138.El 139.Pp 140The 141.Nm 142driver supports 25Gb and 10Gb Ethernet adapters with these SFP28 modules: 143.Pp 144.Bl -bullet -compact 145.It 146Intel\(rg 10G/25G SFP28 25GBASE-SR E25GSFP28SR 147.It 148Intel\(rg 25G SFP28 25GBASE-SR E25GSFP28SRX (Extended Temp) 149.It 150Intel\(rg 25G SFP28 25GBASE-LR E25GSFP28LRX (Extended Temp) 151.El 152.Pp 153The 154.Nm 155driver supports 10Gb and 1Gb Ethernet adapters with these SFP+ modules: 156.Pp 157.Bl -bullet -compact 158.It 159Intel\(rg 1G/10G SFP+ 10GBASE-SR E10GSFPSR 160.It 161Intel\(rg 1G/10G SFP+ 10GBASE-SR E10GSFPSRG1P5 162.It 163Intel\(rg 1G/10G SFP+ 10GBASE-SR E10GSFPSRG2P5 164.It 165Intel\(rg 10G SFP+ 10GBASE-SR E10GSFPSRX (Extended Temp) 166.It 167Intel\(rg 1G/10G SFP+ 10GBASE-LR E10GSFPLR 168.El 169.Pp 170Note that adapters also support all passive and active 171limiting direct attach cables that comply with SFF-8431 v4.1 and 172SFF-8472 v10.4 specifications. 173.Pp 174This is not an exhaustive list; please consult product documentation for an 175up-to-date list of supported media. 176.Sh LOADER TUNABLES 177Tunables can be set at the 178.Xr loader 8 179prompt before booting the kernel or stored in 180.Xr loader.conf 5 . 181See the 182.Xr iflib 4 183man page for more information on using iflib sysctl variables as tunables. 184.Bl -tag -width indent 185.It Va hw.ice.#.enable_health_events 186TBW 187.It Va hw.ice.#.debug.enable_tx_fc_filter 188TBW 189.It Va hw.ice.#.debug.enable_tx_lldp_filter 190TBW 191.It Va hw.ice.#.debug.enable_health_events 192TBW 193.El 194.Sh SYSCTL PROCEDURES 195.Bl -tag -width indent 196.It Va dev.ice.#.fc 197Allows one to set the flow control value. 198A value of 0 disables flow control, 3 enables full, 1 is RX, and 2 is 199TX pause. 200.It Va dev.ice.#.advertise_speed 201Allows one to set advertised link speeds, this will then cause a link 202renegotiation. 203.It Va dev.ice.#.current_speed 204This is a display of the current setting. 205.It Va dev.ice.#.fw_version 206Displays the current firmware and NVM versions of the adapter. 207.It Va dev.ice.#.ddp_version 208TBW 209.It Va dev.ice.#.requested_fec 210TBW 211.It Va dev.ice.#.negotiated_fec 212TBW 213.It Va dev.ice.#.fw_lldp_agent 214TBW 215.It Va dev.ice.#.ets_min_rate 216TBW 217.It Va dev.ice.#.up2tc_map 218TBW 219.It Va dev.ice.#.pfc 220TBW 221.El 222.Sh INTERRUPT STORMS 223It is important to note that 100G operation can generate high 224numbers of interrupts, often incorrectly being interpreted as 225a storm condition in the kernel. 226It is suggested that this be resolved by setting 227.Va hw.intr_storm_threshold 228to 0. 229.Sh SUPPORT 230For general information and support, 231go to the Intel support website at: 232.Lk http://www.intel.com/support/ . 233.Pp 234If an issue is identified with this driver with a supported adapter, 235email all the specific information related to the issue to 236.Aq Mt freebsd@intel.com . 237.Sh SEE ALSO 238.Xr arp 4 , 239.Xr iflib 4 , 240.Xr netintro 4 , 241.Xr ng_ether 4 , 242.Xr vlan 4 , 243.Xr ifconfig 8 244.Sh HISTORY 245The 246.Nm 247device driver first appeared in 248.Fx 12.2 . 249.Sh AUTHORS 250The 251.Nm 252driver was written by 253.An Intel Corporation Aq Mt freebsd@intel.com . 254