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 $
33 .\" $DragonFly: src/share/man/man4/em.4,v 1.12 2008/07/11 10:38:50 thomas Exp $
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
50 Alternatively, to load the driver as a
51 module at boot time, place the following lines in
53 .Bd -literal -offset indent
60 driver provides support for PCI Gigabit Ethernet adapters based on
61 the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
62 82546EB, 82546GB, 82547, 82571, 81572, 82573, and 82574 Ethernet
64 The driver supports Transmit/Receive checksum offload
65 and Jumbo Frames on all but 82542-based adapters.
66 .\" Furthermore it supports TCP segmentation offload (TSO) on all adapters but
67 .\" those based on the 82543, 82544 and 82547 controller chips.
68 For further hardware information, see the
70 included with the driver.
72 For questions related to hardware requirements,
73 refer to the documentation supplied with your Intel PRO/1000 adapter.
74 All hardware requirements listed apply to use with
77 Support for Jumbo Frames is provided via the interface MTU setting.
78 Selecting an MTU larger than 1500 bytes with the
80 utility configures the adapter to receive and transmit Jumbo Frames.
81 The maximum MTU size for Jumbo Frames is 16114.
83 This driver version supports VLANs.
86 driver supports the following media types:
87 .Bl -tag -width ".Cm 10baseT/UTP"
89 Enables auto-negotiation for speed and duplex.
91 Sets 10Mbps operation.
98 Sets 100Mbps operation.
105 Sets 1000Mbps operation.
108 mode is supported at this speed.
110 Sets 1000Mbps operation.
113 mode is supported at this speed.
118 driver supports the following media options:
119 .Bl -tag -width ".Cm full-duplex"
121 Forces full-duplex operation
123 Forces half-duplex operation.
132 is not specified, the driver defaults to
135 For more information on configuring this device, see
144 driver supports Gigabit Ethernet adapters based on the Intel
145 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
146 82546GB, 82547, 82571, 82572, 82573, and 82574 controller chips:
150 Intel PRO/1000 CT Network Connection (82547)
152 Intel PRO/1000 F Server Adapter (82543)
154 Intel PRO/1000 Gigabit Server Adapter (82542)
156 Intel PRO/1000 GT Desktop Adapter (82541PI)
158 Intel PRO/1000 MF Dual Port Server Adapter (82546)
160 Intel PRO/1000 MF Server Adapter (82545)
162 Intel PRO/1000 MF Server Adapter (LX) (82545)
164 Intel PRO/1000 MT Desktop Adapter (82540)
166 Intel PRO/1000 MT Desktop Adapter (82541)
168 Intel PRO/1000 MT Dual Port Server Adapter (82546)
170 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
172 Intel PRO/1000 MT Server Adapter (82545)
174 Intel PRO/1000 PF Dual Port Server Adapter (82571)
176 Intel PRO/1000 PF Quad Port Server Adapter (82571)
178 Intel PRO/1000 PF Server Adapter (82572)
180 Intel PRO/1000 PT Desktop Adapter (82572)
182 Intel PRO/1000 PT Dual Port Server Adapter (82571)
184 Intel PRO/1000 PT Quad Port Server Adapter (82571)
186 Intel PRO/1000 PT Server Adapter (82572)
188 Intel PRO/1000 T Desktop Adapter (82544)
190 Intel PRO/1000 T Server Adapter (82543)
192 Intel PRO/1000 XF Server Adapter (82544)
194 Intel PRO/1000 XT Server Adapter (82544)
197 Tunables can be set at the
199 prompt before booting the kernel or stored in
201 .Bl -tag -width indent
202 .It Va hw.em.int_throttle_ceil
203 Hardware interrupt throttling rate.
204 The default value is 10000Hz.
206 Number of receive descriptors allocated by the driver.
207 The default value is 256.
208 The 82542 and 82543-based adapters can handle up to 256 descriptors,
209 while others can have up to 4096.
211 Number of transmit descriptors allocated by the driver.
212 The default value is 256.
213 The 82542 and 82543-based adapters can handle up to 256 descriptors,
214 while others can have up to 4096.
215 .It Va hw.em.int_tx_nsegs
216 This value controls how many transmit descriptors should be consumed
217 by the hardware before the hardware generates a transmit interrupt.
218 The default value is 1/16 of the number of transmit descriptors.
221 is not used on the hardware and
222 the major part of the transmitted data are bulk data,
223 this value could safely be set to 1/2 of the number of transmit descriptors.
227 .It "em%d: Unable to allocate bus resource: memory"
228 A fatal initialization error has occurred.
229 .It "em%d: Unable to allocate bus resource: interrupt"
230 A fatal initialization error has occurred.
231 .It "em%d: watchdog timeout -- resetting"
232 The device has stopped responding to the network, or there is a problem with
233 the network connection (cable).
236 For general information and support,
237 go to the Intel support website at:
238 .Pa http://support.intel.com .
240 If an issue is identified with the released source code on the supported kernel
241 with a supported adapter, email the specific information related to the
243 .Aq freebsdnic@mailbox.intel.com .
255 device driver first appeared in
260 driver was written by
261 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .