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.
39 .Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following lines in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
49 Alternatively, to load the driver as a
50 module at boot time, place the following line in
52 .Bd -literal -offset indent
58 driver provides support for PCI/PCI-X Gigabit Ethernet adapters based on
59 the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
60 82546EB, 82546GB, and 82547 controller chips.
64 driver provides support for PCI Express Gigabit Ethernet adapters
65 based on the Intel 82571, 82572, 82573, 82574, and 82583 Ethernet
70 driver provides support for Gigabit Ethernet adapters connected to I/O
71 Controller Hub (ICH) and Platform Controller Hub (PCH) including Intel
72 80003ES2LAN, 82562, 82566, 82567, 82577, 82578, 82579, i217, i218, and i219.
76 driver provides support for PCI Express Gigabit Ethernet adapters
77 based on the Intel 82575, 82576, 82580, i210, i211, and i35x. These
80 interfaces to maintain compatibility with existing infrastructure.
82 The driver supports Transmit/Receive checksum offload and Jumbo Frames
83 on all but 82542-based adapters.
85 Furthermore it supports TCP segmentation offload (TSO) on all adapters but
86 those based on the 82542, 82543, 82544 and 82547 controller chips.
87 The identification LEDs of the adapters supported by the
89 driver can be controlled via the
91 API for localization purposes.
92 For further hardware information, see the
94 included with the driver.
96 For questions related to hardware requirements, refer to the
97 documentation supplied with your Intel PRO/1000 adapter.
98 All hardware requirements listed apply to use with
101 Support for Jumbo Frames is provided via the interface MTU setting.
102 Selecting an MTU larger than 1500 bytes with the
104 utility configures the adapter to receive and transmit Jumbo Frames.
105 The maximum MTU size for Jumbo Frames is 16114.
107 This driver supports hardware assisted VLANs.
110 driver supports the following media types:
111 .Bl -tag -width ".Cm 10baseT/UTP"
113 Enables auto-negotiation for speed and duplex.
115 Sets 10Mbps operation.
122 Sets 100Mbps operation.
129 Sets 1000Mbps operation.
132 mode is supported at this speed.
134 Sets 1000Mbps operation.
137 mode is supported at this speed.
142 driver supports the following media options:
143 .Bl -tag -width ".Cm full-duplex"
145 Forces full-duplex operation
147 Forces half-duplex operation.
156 is not specified, the driver defaults to
159 For more information on configuring this device, see
164 driver supports Gigabit Ethernet adapters based on the Intel
165 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
166 82546GB, 82547, 82571, 82572, 82573, 82574, 82575, 82576, and 82580
171 Intel Gigabit ET Dual Port Server Adapter (82576)
173 Intel Gigabit VT Quad Port Server Adapter (82575)
175 Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)
177 Intel i210 and i211 Gigabit Ethernet Controller
179 Intel i350 and i354 Gigabit Ethernet Controller
181 Intel PRO/1000 CT Network Connection (82547)
183 Intel PRO/1000 F Server Adapter (82543)
185 Intel PRO/1000 Gigabit Server Adapter (82542)
187 Intel PRO/1000 GT Desktop Adapter (82541PI)
189 Intel PRO/1000 MF Dual Port Server Adapter (82546)
191 Intel PRO/1000 MF Server Adapter (82545)
193 Intel PRO/1000 MF Server Adapter (LX) (82545)
195 Intel PRO/1000 MT Desktop Adapter (82540)
197 Intel PRO/1000 MT Desktop Adapter (82541)
199 Intel PRO/1000 MT Dual Port Server Adapter (82546)
201 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
203 Intel PRO/1000 MT Server Adapter (82545)
205 Intel PRO/1000 PF Dual Port Server Adapter (82571)
207 Intel PRO/1000 PF Quad Port Server Adapter (82571)
209 Intel PRO/1000 PF Server Adapter (82572)
211 Intel PRO/1000 PT Desktop Adapter (82572)
213 Intel PRO/1000 PT Dual Port Server Adapter (82571)
215 Intel PRO/1000 PT Quad Port Server Adapter (82571)
217 Intel PRO/1000 PT Server Adapter (82572)
219 Intel PRO/1000 T Desktop Adapter (82544)
221 Intel PRO/1000 T Server Adapter (82543)
223 Intel PRO/1000 XF Server Adapter (82544)
225 Intel PRO/1000 XT Server Adapter (82544)
228 Tunables can be set at the
230 prompt before booting the kernel or stored in
234 for per-instance variables.
235 .Bl -tag -width indent
236 .It Va hw.em.disable_crc_stripping
237 Disable or enable hardware stripping of CRC field.
238 This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC
239 causes remote access over IPMI to fail.
241 .It Va hw.em.eee_setting
242 Disable or enable Energy Efficient Ethernet.
243 Default 1 (disabled).
244 .It Va hw.em.smart_pwr_down
245 Enable or disable smart power down features on newer adapters.
246 Default 0 (disabled).
248 Show bad packets when in promiscuous mode.
250 .It Va hw.em.rx_int_delay
251 This value delays the generation of receive interrupts in units of
253 The default value is 0, since adapters may hang with this feature
255 .It Va hw.em.rx_abs_int_delay
257 .Va hw.em.rx_int_delay
258 is non-zero, this tunable limits the maximum delay in which a receive
259 interrupt is generated.
260 .It Va hw.em.tx_int_delay
261 This value delays the generation of transmit interrupts in units of
263 The default value is 64.
264 .It Va hw.em.tx_abs_int_delay
266 .Va hw.em.tx_int_delay
267 is non-zero, this tunable limits the maximum delay in which a transmit
268 interrupt is generated.
269 .It Va hw.em.max_interrupt_rate
270 Maximum interrupts per second.
271 The default value is 8000.
272 .It Va hw.em.rx_process_limit
273 Maximum number of received packets to process at a time, -1 means unlimited.
274 The default value is 100.
277 .Bl -tag -width /dev/led/em*
279 identification LED device nodes
282 Make the identification LED of em0 blink:
284 .Dl "echo f2 > /dev/led/em0"
286 Turn the identification LED of em0 off again:
288 .Dl "echo 0 > /dev/led/em0"
291 .It "em%d: Unable to allocate bus resource: memory"
292 A fatal initialization error has occurred.
293 .It "em%d: Unable to allocate bus resource: interrupt"
294 A fatal initialization error has occurred.
295 .It "em%d: watchdog timeout -- resetting"
296 The device has stopped responding to the network, or there is a problem with
297 the network connection (cable).
300 For general information and support,
301 go to the Intel support website at:
302 .Pa http://support.intel.com .
304 If an issue is identified with the released source code on the supported kernel
305 with a supported adapter, email the specific information related to the
307 .Aq Mt freebsd@intel.com .
321 device driver first appeared in
324 was merged with the lem and igb device driver and converted to the iflib
331 driver was originally written by
332 .An Intel Corporation Aq Mt freebsd@intel.com .
333 It was merged with igb driver and converted to the iflib framework by
334 .An Matthew Macy Aq Mt mmacy@mattmacy.io
336 .An Sean Bruno Aq Mt sbruno@FreeBSD.org .