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.
32 .\" $FreeBSD: src/share/man/man4/em.4,v 1.30 2008/10/06 21:55:53 simon Exp $
34 .Dd September 17, 2012
40 .Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver"
42 To compile this driver into the kernel,
43 place the following lines in your
44 kernel configuration file:
45 .Bd -ragged -offset indent
47 .Cd "device em # for em(4)"
48 .Cd "device emx # for emx(4)"
51 Alternatively, to load the driver as a
52 module at boot time, place the following lines in
54 .Bd -literal -offset indent
56 if_em_load="YES" # for em(4)
57 if_emx_load="YES" # for emx(4)
62 driver provides support for PCI Gigabit Ethernet adapters based on
63 the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
64 82546EB, 82546GB, 82547, 82571, 81572, 82573, and 82574 Ethernet
66 The driver supports Transmit/Receive checksum offload
67 and Jumbo Frames on all but 82542-based adapters.
68 Furthermore it supports TCP segmentation offload (TSO) on adapters
69 based on the 82571, 82572, 82573 and 82574 controller chips.
70 For further hardware information, see the
72 included with the driver.
78 driver for 82571, 82572, 82573, and 82574 Ethernet controller chips that
79 additionally supports RSS (Receive Side Scaling).
81 For questions related to hardware requirements,
82 refer to the documentation supplied with your Intel PRO/1000 adapter.
83 All hardware requirements listed apply to use with
86 Support for Jumbo Frames is provided via the interface MTU setting.
87 Selecting an MTU larger than 1500 bytes with the
89 utility configures the adapter to receive and transmit Jumbo Frames.
90 The maximum MTU size for Jumbo Frames is 16114.
92 This driver version supports VLANs.
97 drivers support the following media types:
98 .Bl -tag -width ".Cm 10baseT/UTP"
100 Enables auto-negotiation for speed and duplex.
102 Sets 10Mbps operation.
109 Sets 100Mbps operation.
116 Sets 1000Mbps operation.
119 mode is supported at this speed.
121 Sets 1000Mbps operation.
124 mode is supported at this speed.
131 drivers support the following media options:
132 .Bl -tag -width ".Cm full-duplex"
134 Forces full-duplex operation
136 Forces half-duplex operation.
145 is not specified, the driver defaults to
148 For more information on configuring this device, see
160 driver supports Gigabit Ethernet adapters based on the Intel
161 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
162 82546GB, 82547, 82571, 82572, 82573, and 82574 controller chips:
166 Intel PRO/1000 CT Network Connection (82547)
168 Intel PRO/1000 F Server Adapter (82543)
170 Intel PRO/1000 Gigabit Server Adapter (82542)
172 Intel PRO/1000 GT Desktop Adapter (82541PI)
174 Intel PRO/1000 MF Dual Port Server Adapter (82546)
176 Intel PRO/1000 MF Server Adapter (82545)
178 Intel PRO/1000 MF Server Adapter (LX) (82545)
180 Intel PRO/1000 MT Desktop Adapter (82540)
182 Intel PRO/1000 MT Desktop Adapter (82541)
184 Intel PRO/1000 MT Dual Port Server Adapter (82546)
186 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
188 Intel PRO/1000 MT Server Adapter (82545)
190 Intel PRO/1000 PF Dual Port Server Adapter (82571)
192 Intel PRO/1000 PF Quad Port Server Adapter (82571)
194 Intel PRO/1000 PF Server Adapter (82572)
196 Intel PRO/1000 PT Desktop Adapter (82572)
198 Intel PRO/1000 PT Dual Port Server Adapter (82571)
200 Intel PRO/1000 PT Quad Port Server Adapter (82571)
202 Intel PRO/1000 PT Server Adapter (82572)
204 Intel PRO/1000 T Desktop Adapter (82544)
206 Intel PRO/1000 T Server Adapter (82543)
208 Intel PRO/1000 XF Server Adapter (82544)
210 Intel PRO/1000 XT Server Adapter (82544)
215 driver supports Gigabit Ethernet adapters based on the Intel
216 82571, 82572, 82573, and 82574 controller chips.
218 Tunables can be set at the
220 prompt before booting the kernel or stored in
222 .Bl -tag -width indent
223 .It Va hw.em.int_throttle_ceil
224 Hardware interrupt throttling rate.
225 The default value is 10000Hz.
227 Number of receive descriptors allocated by the driver.
228 The default value is 256.
229 The 82542 and 82543-based adapters can handle up to 256 descriptors,
230 while others can have up to 4096.
232 Number of transmit descriptors allocated by the driver.
233 The default value is 256.
234 The 82542 and 82543-based adapters can handle up to 256 descriptors,
235 while others can have up to 4096.
236 .It Va hw.em.int_tx_nsegs
237 This value controls how many transmit descriptors should be consumed
238 by the hardware before the hardware generates a transmit interrupt.
239 The default value is 1/16 of the number of transmit descriptors.
242 is not used on the hardware and
243 the major part of the transmitted data are bulk data,
244 this value could safely be set to 1/2 of the number of transmit descriptors.
245 .It Va hw.em.msi.enable
246 By default, the driver will use MSI if it is supported.
247 This behavior can be turned off by setting this tunable to 0.
250 .\" XXX emx(4) tunables
253 .It "em%d: Unable to allocate bus resource: memory"
254 A fatal initialization error has occurred.
255 .It "em%d: Unable to allocate bus resource: interrupt"
256 A fatal initialization error has occurred.
257 .It "em%d: watchdog timeout -- resetting"
258 The device has stopped responding to the network, or there is a problem with
259 the network connection (cable).
262 For general information and support,
263 go to the Intel support website at:
264 .Pa http://support.intel.com .
266 If an issue is identified with the released source code on the supported kernel
267 with a supported adapter, email the specific information related to the
269 .Aq freebsdnic@mailbox.intel.com .
281 device driver first appeared in
285 driver first appeared in
291 driver was written by
292 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .
296 driver was written by