1 .\" Copyright (c) 2001-2003, Intel Corporation
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" this list of conditions and the following disclaimer.
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.
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.
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.
30 .\" * Other names and brands may be claimed as the property of others.
37 .Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver"
39 To compile this driver into the kernel,
40 place the following lines in your
41 kernel configuration file:
42 .Bd -ragged -offset indent
47 Alternatively, to load the driver as a
48 module at boot time, place the following line in
50 .Bd -literal -offset indent
56 driver provides support for PCI/PCI-X Gigabit Ethernet adapters based on
57 the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
58 82546EB, 82546GB, and 82547 controller chips.
62 driver provides support for PCI Express Gigabit Ethernet adapters
63 based on the Intel 82571, 82572, 82573, 82574, and 82583 Ethernet
68 driver provides support for Gigabit Ethernet adapters connected to I/O
69 Controller Hub (ICH) and Platform Controller Hub (PCH) including Intel
70 80003ES2LAN, 82562, 82566, 82567, 82577, 82578, 82579, i217, i218, and i219.
74 driver provides support for PCI Express Gigabit Ethernet adapters
75 based on the Intel 82575, 82576, 82580, i210, i211, and i35x. These
78 interfaces to maintain compatibility with existing infrastructure.
80 The driver supports Transmit/Receive checksum offload and Jumbo Frames
81 on all but 82542-based adapters.
83 Furthermore it supports TCP segmentation offload (TSO) on all adapters but
84 those based on the 82542, 82543, 82544 and 82547 controller chips.
85 The identification LEDs of the adapters supported by the
87 driver can be controlled via the
89 API for localization purposes.
90 For further hardware information, see the
92 included with the driver.
94 For questions related to hardware requirements, refer to the
95 documentation supplied with your Intel PRO/1000 adapter.
96 All hardware requirements listed apply to use with
99 Support for Jumbo Frames is provided via the interface MTU setting.
100 Selecting an MTU larger than 1500 bytes with the
102 utility configures the adapter to receive and transmit Jumbo Frames.
103 The maximum MTU size for Jumbo Frames is 16114.
105 This driver supports hardware assisted VLANs.
108 driver supports the following media types:
109 .Bl -tag -width ".Cm 10baseT/UTP"
111 Enables auto-negotiation for speed and duplex.
113 Sets 10Mbps operation.
120 Sets 100Mbps operation.
127 Sets 1000Mbps operation.
130 mode is supported at this speed.
132 Sets 1000Mbps operation.
135 mode is supported at this speed.
140 driver supports the following media options:
141 .Bl -tag -width ".Cm full-duplex"
143 Forces full-duplex operation
145 Forces half-duplex operation.
154 is not specified, the driver defaults to
157 For more information on configuring this device, see
162 driver supports Gigabit Ethernet adapters based on the Intel
163 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
164 82546GB, 82547, 82571, 82572, 82573, 82574, 82575, 82576, and 82580
169 Intel Gigabit ET Dual Port Server Adapter (82576)
171 Intel Gigabit VT Quad Port Server Adapter (82575)
173 Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)
175 Intel i210 and i211 Gigabit Ethernet Controller
177 Intel i350 and i354 Gigabit Ethernet Controller
179 Intel PRO/1000 CT Network Connection (82547)
181 Intel PRO/1000 F Server Adapter (82543)
183 Intel PRO/1000 Gigabit Server Adapter (82542)
185 Intel PRO/1000 GT Desktop Adapter (82541PI)
187 Intel PRO/1000 MF Dual Port Server Adapter (82546)
189 Intel PRO/1000 MF Server Adapter (82545)
191 Intel PRO/1000 MF Server Adapter (LX) (82545)
193 Intel PRO/1000 MT Desktop Adapter (82540)
195 Intel PRO/1000 MT Desktop Adapter (82541)
197 Intel PRO/1000 MT Dual Port Server Adapter (82546)
199 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
201 Intel PRO/1000 MT Server Adapter (82545)
203 Intel PRO/1000 PF Dual Port Server Adapter (82571)
205 Intel PRO/1000 PF Quad Port Server Adapter (82571)
207 Intel PRO/1000 PF Server Adapter (82572)
209 Intel PRO/1000 PT Desktop Adapter (82572)
211 Intel PRO/1000 PT Dual Port Server Adapter (82571)
213 Intel PRO/1000 PT Quad Port Server Adapter (82571)
215 Intel PRO/1000 PT Server Adapter (82572)
217 Intel PRO/1000 T Desktop Adapter (82544)
219 Intel PRO/1000 T Server Adapter (82543)
221 Intel PRO/1000 XF Server Adapter (82544)
223 Intel PRO/1000 XT Server Adapter (82544)
226 Tunables can be set at the
228 prompt before booting the kernel or stored in
232 for per-instance variables.
233 .Bl -tag -width indent
234 .It Va hw.em.disable_crc_stripping
235 Disable or enable hardware stripping of CRC field.
236 This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC
237 causes remote access over IPMI to fail.
239 .It Va hw.em.eee_setting
240 Disable or enable Energy Efficient Ethernet.
241 Default 1 (disabled).
242 .It Va hw.em.smart_pwr_down
243 Enable or disable smart power down features on newer adapters.
244 Default 0 (disabled).
246 Show bad packets when in promiscuous mode.
248 .It Va hw.em.rx_int_delay
249 This value delays the generation of receive interrupts in units of
251 The default value is 0, since adapters may hang with this feature
253 .It Va hw.em.rx_abs_int_delay
255 .Va hw.em.rx_int_delay
256 is non-zero, this tunable limits the maximum delay in which a receive
257 interrupt is generated.
258 .It Va hw.em.tx_int_delay
259 This value delays the generation of transmit interrupts in units of
261 The default value is 64.
262 .It Va hw.em.tx_abs_int_delay
264 .Va hw.em.tx_int_delay
265 is non-zero, this tunable limits the maximum delay in which a transmit
266 interrupt is generated.
267 .It Va hw.em.max_interrupt_rate
268 Maximum interrupts per second.
269 The default value is 8000.
270 .It Va hw.em.rx_process_limit
271 Maximum number of received packets to process at a time, -1 means unlimited.
272 The default value is 100.
275 .Bl -tag -width /dev/led/em*
277 identification LED device nodes
280 Make the identification LED of em0 blink:
282 .Dl "echo f2 > /dev/led/em0"
284 Turn the identification LED of em0 off again:
286 .Dl "echo 0 > /dev/led/em0"
289 .It "em%d: Unable to allocate bus resource: memory"
290 A fatal initialization error has occurred.
291 .It "em%d: Unable to allocate bus resource: interrupt"
292 A fatal initialization error has occurred.
293 .It "em%d: watchdog timeout -- resetting"
294 The device has stopped responding to the network, or there is a problem with
295 the network connection (cable).
298 For general information and support,
299 go to the Intel support website at:
300 .Pa http://support.intel.com .
302 If an issue is identified with the released source code on the supported kernel
303 with a supported adapter, email the specific information related to the
305 .Aq Mt freebsd@intel.com .
319 device driver first appeared in
322 was merged with the lem and igb device driver and converted to the iflib
329 driver was originally written by
330 .An Intel Corporation Aq Mt freebsd@intel.com .
331 It was merged with igb driver and converted to the iflib framework by
332 .An Matthew Macy Aq Mt mmacy@mattmacy.io
334 .An Sean Bruno Aq Mt sbruno@FreeBSD.org .