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 Gigabit Ethernet adapters based on
59 the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
60 82546EB, 82546GB, 82547, 82571, 81572, 82573, and 82574 Ethernet
65 driver also provides support for PCI Express Gigabit Ethernet adapters
66 based on the Intel 82575, 82576, 82580, i21x and i35x.
68 The driver supports Transmit/Receive checksum offload and Jumbo Frames
69 on all but 82542-based adapters.
71 Furthermore it supports TCP segmentation offload (TSO) on all adapters but
72 those based on the 82543, 82544 and 82547 controller chips.
73 The identification LEDs of the adapters supported by the
75 driver can be controlled via the
77 API for localization purposes.
78 For further hardware information, see the
80 included with the driver.
82 For questions related to hardware requirements, refer to the
83 documentation supplied with your Intel PRO/1000 adapter.
84 All hardware requirements listed apply to use with
87 Support for Jumbo Frames is provided via the interface MTU setting.
88 Selecting an MTU larger than 1500 bytes with the
90 utility configures the adapter to receive and transmit Jumbo Frames.
91 The maximum MTU size for Jumbo Frames is 16114.
93 This driver supports hardware assisted VLANs.
96 driver supports the following media types:
97 .Bl -tag -width ".Cm 10baseT/UTP"
99 Enables auto-negotiation for speed and duplex.
101 Sets 10Mbps operation.
108 Sets 100Mbps operation.
115 Sets 1000Mbps operation.
118 mode is supported at this speed.
120 Sets 1000Mbps operation.
123 mode is supported at this speed.
128 driver supports the following media options:
129 .Bl -tag -width ".Cm full-duplex"
131 Forces full-duplex operation
133 Forces half-duplex operation.
142 is not specified, the driver defaults to
145 For more information on configuring this device, see
150 driver supports Gigabit Ethernet adapters based on the Intel
151 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
152 82546GB, 82547, 82571, 82572, 82573, 82574, 82575, 82576, and 82580
157 Intel Gigabit ET Dual Port Server Adapter (82576)
159 Intel Gigabit VT Quad Port Server Adapter (82575)
161 Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)
163 Intel i210 and i211 Gigabit Ethernet Controller
165 Intel i350 and i354 Gigabit Ethernet Controller
167 Intel PRO/1000 CT Network Connection (82547)
169 Intel PRO/1000 F Server Adapter (82543)
171 Intel PRO/1000 Gigabit Server Adapter (82542)
173 Intel PRO/1000 GT Desktop Adapter (82541PI)
175 Intel PRO/1000 MF Dual Port Server Adapter (82546)
177 Intel PRO/1000 MF Server Adapter (82545)
179 Intel PRO/1000 MF Server Adapter (LX) (82545)
181 Intel PRO/1000 MT Desktop Adapter (82540)
183 Intel PRO/1000 MT Desktop Adapter (82541)
185 Intel PRO/1000 MT Dual Port Server Adapter (82546)
187 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
189 Intel PRO/1000 MT Server Adapter (82545)
191 Intel PRO/1000 PF Dual Port Server Adapter (82571)
193 Intel PRO/1000 PF Quad Port Server Adapter (82571)
195 Intel PRO/1000 PF Server Adapter (82572)
197 Intel PRO/1000 PT Desktop Adapter (82572)
199 Intel PRO/1000 PT Dual Port Server Adapter (82571)
201 Intel PRO/1000 PT Quad Port Server Adapter (82571)
203 Intel PRO/1000 PT Server Adapter (82572)
205 Intel PRO/1000 T Desktop Adapter (82544)
207 Intel PRO/1000 T Server Adapter (82543)
209 Intel PRO/1000 XF Server Adapter (82544)
211 Intel PRO/1000 XT Server Adapter (82544)
214 Tunables can be set at the
216 prompt before booting the kernel or stored in
218 .Bl -tag -width indent
219 .It Va hw.em.disable_crc_stripping
220 Disable or enable hardware stripping of CRC field.
221 This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC
222 causes remote access over IPMI to fail.
224 .It Va hw.em.eee_setting
225 Disable or enable Energy Efficient Ethernet.
226 Default 1 (disabled).
228 Enable or disable MSI-X style interrupts.
230 .It Va hw.em.smart_pwr_down
231 Enable or disable smart power down features on newer adapters.
232 Default 0 (disabled).
234 Show bad packets when in promiscuous mode.
237 Number of receive descriptors allocated by the driver.
238 The default value is 1024 for adapters newer than 82547,
239 and 256 for older ones.
240 The 82542 and 82543-based adapters can handle up to 256 descriptors,
241 while others can have up to 4096.
243 Number of transmit descriptors allocated by the driver.
244 The default value is 1024 for adapters newer than 82547,
245 and 256 for older ones.
246 The 82542 and 82543-based adapters can handle up to 256 descriptors,
247 while others can have up to 4096.
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.
269 .Bl -tag -width /dev/led/em*
271 identification LED device nodes
274 Make the identification LED of em0 blink:
276 .Dl "echo f2 > /dev/led/em0"
278 Turn the identification LED of em0 off again:
280 .Dl "echo 0 > /dev/led/em0"
283 .It "em%d: Unable to allocate bus resource: memory"
284 A fatal initialization error has occurred.
285 .It "em%d: Unable to allocate bus resource: interrupt"
286 A fatal initialization error has occurred.
287 .It "em%d: watchdog timeout -- resetting"
288 The device has stopped responding to the network, or there is a problem with
289 the network connection (cable).
292 For general information and support,
293 go to the Intel support website at:
294 .Pa http://support.intel.com .
296 If an issue is identified with the released source code on the supported kernel
297 with a supported adapter, email the specific information related to the
299 .Aq Mt freebsd@intel.com .
313 device driver first appeared in
316 was merged with the igb device driver and converted to the iflib framework in
322 driver was originally written by
323 .An Intel Corporation Aq Mt freebsd@intel.com .
324 It was merged with igb driver and converted to the iflib framework by
325 .An Matthew Macy Aq Mt mmacy@mattmacy.io
327 .An Sean Bruno Aq Mt sbruno@FreeBSD.org .