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