1.\"- 2.\" SPDX-License-Identifier: BSD-3-Clause 3.\" 4.\" Copyright (c) 2001-2003, Intel Corporation 5.\" All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions are met: 9.\" 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 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation 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 March 20, 2024 36.Dt EM 4 37.Os 38.Sh NAME 39.Nm em , 40.Nm lem , 41.Nm igb 42.Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver" 43.Sh SYNOPSIS 44To compile this driver into the kernel, 45place the following lines in your 46kernel configuration file: 47.Bd -ragged -offset indent 48.Cd "device iflib" 49.Cd "device em" 50.Ed 51.Pp 52Alternatively, to load the driver as a 53module at boot time, place the following line in 54.Xr loader.conf 5 : 55.Bd -literal -offset indent 56if_em_load="YES" 57.Ed 58.Sh DESCRIPTION 59The 60.Nm 61driver provides support for PCI/PCI-X Gigabit Ethernet adapters based on 62the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 6382546EB, 82546GB, and 82547 controller chips. 64.Pp 65The 66.Nm 67driver provides support for PCI Express Gigabit Ethernet adapters 68based on the Intel 82571, 82572, 82573, 82574, and 82583 Ethernet 69controller chips. 70.Pp 71The 72.Nm 73driver provides support for Gigabit Ethernet adapters connected to I/O 74Controller Hub (ICH) and Platform Controller Hub (PCH) including Intel 7580003ES2LAN, 82562, 82566, 82567, 82577, 82578, 82579, i217, i218, and i219. 76.Pp 77The 78.Nm 79driver provides support for PCI Express Gigabit Ethernet adapters 80based on the Intel 82575, 82576, 82580, i210, i211, and i35x. 81These appear as 82.Nm igb 83interfaces to maintain compatibility with existing infrastructure. 84.Pp 85The driver supports Transmit/Receive checksum offload and Jumbo Frames 86on all but 82542-based adapters. 87.Pp 88Furthermore it supports TCP segmentation offload (TSO) on all adapters but 89those based on the 82542, 82543, 82544 and 82547 controller chips. 90The identification LEDs of the adapters supported by the 91.Nm 92driver can be controlled via the 93.Xr led 4 94API for localization purposes. 95For further hardware information, see the 96.Pa README 97included with the driver. 98.Pp 99For questions related to hardware requirements, refer to the 100documentation supplied with your Intel PRO/1000 adapter. 101All hardware requirements listed apply to use with 102.Fx . 103.Pp 104Support for Jumbo Frames is provided via the interface MTU setting. 105Selecting an MTU larger than 1500 bytes with the 106.Xr ifconfig 8 107utility configures the adapter to receive and transmit Jumbo Frames. 108The maximum MTU size for Jumbo Frames is 16114. 109.Pp 110This driver supports hardware assisted VLANs. 111The 112.Nm 113driver supports the following media types: 114.Bl -tag -width ".Cm 10baseT/UTP" 115.It Cm autoselect 116Enables auto-negotiation for speed and duplex. 117.It Cm 10baseT/UTP 118Sets 10Mbps operation. 119Use the 120.Cm mediaopt 121option to select 122.Cm full-duplex 123mode. 124.It Cm 100baseTX 125Sets 100Mbps operation. 126Use the 127.Cm mediaopt 128option to select 129.Cm full-duplex 130mode. 131.It Cm 1000baseSX 132Sets 1000Mbps operation. 133Only 134.Cm full-duplex 135mode is supported at this speed. 136.It Cm 1000baseTX 137Sets 1000Mbps operation. 138Only 139.Cm full-duplex 140mode is supported at this speed. 141.El 142.Pp 143The 144.Nm 145driver supports the following media options: 146.Bl -tag -width ".Cm full-duplex" 147.It Cm full-duplex 148Forces full-duplex operation 149.It Cm half-duplex 150Forces half-duplex operation. 151.El 152.Pp 153Only use 154.Cm mediaopt 155to set the driver to 156.Cm full-duplex . 157If 158.Cm mediaopt 159is not specified, the driver defaults to 160.Cm half-duplex . 161.Pp 162For more information on configuring this device, see 163.Xr ifconfig 8 . 164.Sh HARDWARE 165The 166.Nm 167driver supports Gigabit Ethernet adapters based on the Intel 16882540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB, 16982546GB, 82547, 82571, 82572, 82573, 82574, 82575, 82576, and 82580 170controller chips: 171.Pp 172.Bl -bullet -compact 173.It 174Intel Gigabit ET Dual Port Server Adapter (82576) 175.It 176Intel Gigabit VT Quad Port Server Adapter (82575) 177.It 178Intel Single, Dual and Quad Gigabit Ethernet Controller (82580) 179.It 180Intel i210 and i211 Gigabit Ethernet Controller 181.It 182Intel i350 and i354 Gigabit Ethernet Controller 183.It 184Intel PRO/1000 CT Network Connection (82547) 185.It 186Intel PRO/1000 F Server Adapter (82543) 187.It 188Intel PRO/1000 Gigabit Server Adapter (82542) 189.It 190Intel PRO/1000 GT Desktop Adapter (82541PI) 191.It 192Intel PRO/1000 MF Dual Port Server Adapter (82546) 193.It 194Intel PRO/1000 MF Server Adapter (82545) 195.It 196Intel PRO/1000 MF Server Adapter (LX) (82545) 197.It 198Intel PRO/1000 MT Desktop Adapter (82540) 199.It 200Intel PRO/1000 MT Desktop Adapter (82541) 201.It 202Intel PRO/1000 MT Dual Port Server Adapter (82546) 203.It 204Intel PRO/1000 MT Quad Port Server Adapter (82546EB) 205.It 206Intel PRO/1000 MT Server Adapter (82545) 207.It 208Intel PRO/1000 PF Dual Port Server Adapter (82571) 209.It 210Intel PRO/1000 PF Quad Port Server Adapter (82571) 211.It 212Intel PRO/1000 PF Server Adapter (82572) 213.It 214Intel PRO/1000 PT Desktop Adapter (82572) 215.It 216Intel PRO/1000 PT Dual Port Server Adapter (82571) 217.It 218Intel PRO/1000 PT Quad Port Server Adapter (82571) 219.It 220Intel PRO/1000 PT Server Adapter (82572) 221.It 222Intel PRO/1000 T Desktop Adapter (82544) 223.It 224Intel PRO/1000 T Server Adapter (82543) 225.It 226Intel PRO/1000 XF Server Adapter (82544) 227.It 228Intel PRO/1000 XT Server Adapter (82544) 229.El 230.Sh LOADER TUNABLES 231Tunables can be set at the 232.Xr loader 8 233prompt before booting the kernel or stored in 234.Xr loader.conf 5 . 235See 236.Xr iflib 4 237for per-instance variables. 238.Bl -tag -width indent 239.It Va hw.em.disable_crc_stripping 240Disable or enable hardware stripping of CRC field. 241This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC 242causes remote access over IPMI to fail. 243Default 0 (enabled). 244.It Va hw.em.eee_setting 245Disable or enable Energy Efficient Ethernet. 246Default 1 (disabled). 247.It Va hw.em.smart_pwr_down 248Enable or disable smart power down features on newer adapters. 249Default 0 (disabled). 250.It Va hw.em.sbp 251Show bad packets when in promiscuous mode. 252Default 0 (off). 253.It Va hw.em.rx_int_delay 254This value delays the generation of receive interrupts in units of 2551.024 microseconds. 256The default value is 0, since adapters may hang with this feature 257being enabled. 258.It Va hw.em.rx_abs_int_delay 259If 260.Va hw.em.rx_int_delay 261is non-zero, this tunable limits the maximum delay in which a receive 262interrupt is generated. 263.It Va hw.em.tx_int_delay 264This value delays the generation of transmit interrupts in units of 2651.024 microseconds. 266The default value is 64. 267.It Va hw.em.tx_abs_int_delay 268If 269.Va hw.em.tx_int_delay 270is non-zero, this tunable limits the maximum delay in which a transmit 271interrupt is generated. 272.It Va hw.em.max_interrupt_rate 273Maximum interrupts per second. 274The default value is 8000. 275.It Va hw.em.rx_process_limit 276Maximum number of received packets to process at a time, -1 means unlimited. 277The default value is 100. 278.El 279.Sh FILES 280.Bl -tag -width /dev/led/em* 281.It Pa /dev/led/em* 282identification LED device nodes 283.El 284.Sh EXAMPLES 285Make the identification LED of em0 blink: 286.Pp 287.Dl "echo f2 > /dev/led/em0" 288.Pp 289Turn the identification LED of em0 off again: 290.Pp 291.Dl "echo 0 > /dev/led/em0" 292.Sh DIAGNOSTICS 293.Bl -diag 294.It "em%d: Unable to allocate bus resource: memory" 295A fatal initialization error has occurred. 296.It "em%d: Unable to allocate bus resource: interrupt" 297A fatal initialization error has occurred. 298.It "em%d: watchdog timeout -- resetting" 299The device has stopped responding to the network, or there is a problem with 300the network connection (cable). 301.El 302.Sh SUPPORT 303For general information and support, 304go to the Intel support website at: 305.Pa http://support.intel.com . 306.Pp 307If an issue is identified with the released source code on the supported kernel 308with a supported adapter, email the specific information related to the 309issue to 310.Aq Mt freebsd@intel.com . 311.Sh SEE ALSO 312.Xr altq 4 , 313.Xr arp 4 , 314.Xr iflib 4 , 315.Xr led 4 , 316.Xr netintro 4 , 317.Xr ng_ether 4 , 318.Xr polling 4 , 319.Xr vlan 4 , 320.Xr ifconfig 8 321.Sh HISTORY 322The 323.Nm 324device driver first appeared in 325.Fx 4.4 . 326.Nm 327was merged with the 328.Nm lem 329and 330.Nm igb 331device drivers and converted to the 332.Xr iflib 4 333framework in 334.Fx 12.0 . 335.Sh AUTHORS 336.An -nosplit 337The 338.Nm 339driver was originally written by 340.An Intel Corporation Aq Mt freebsd@intel.com . 341It was merged with the 342.Nm igb 343driver and converted to the 344.Xr iflib 4 345framework by 346.An Matthew Macy Aq Mt mmacy@mattmacy.io 347and 348.An Sean Bruno Aq Mt sbruno@FreeBSD.org . 349