xref: /dragonfly/share/man/man4/em.4 (revision 8a7bdfea)
1.\" Copyright (c) 2001-2003, Intel Corporation
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions are met:
6.\"
7.\" 1. Redistributions of source code must retain the above copyright notice,
8.\"    this list of conditions and the following disclaimer.
9.\"
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.
13.\"
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.
17.\"
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.
29.\"
30.\" * Other names and brands may be claimed as the property of others.
31.\"
32.\" $FreeBSD: src/share/man/man4/em.4,v 1.2.2.6 2003/02/01 01:21:31 pdeuskar Exp $
33.\" $DragonFly: src/share/man/man4/em.4,v 1.11 2008/02/01 21:40:53 swildner Exp $
34.\"
35.Dd February 1, 2008
36.Dt EM 4
37.Os
38.Sh NAME
39.Nm em
40.Nd "Intel(R) PRO/1000 gigabit Ethernet driver"
41.Sh SYNOPSIS
42.Cd "device em"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI gigabit Ethernet adapters based on
47the Intel 82540, 82541, 82542, 82543, 82544, 82546, and 82547 Ethernet
48controller chips.
49The driver does not support Transmit/Receive checksum offload and
50Jumbo Frames on adapters based on the Intel 82542 and 82573 LAN controllers.
51For a list of supported adapters, see the
52.Pa README
53included with the driver.
54.Pp
55For questions related to hardware requirements,
56refer to the documentation supplied with your Intel PRO/1000 adapter.
57All hardware requirements listed apply to use with
58.Dx .
59.Pp
60Support for Jumbo Frames is provided via the interface MTU setting.
61Selecting an MTU larger than 1500 bytes with the
62.Xr ifconfig 8
63utility configures the adapter to receive and transmit Jumbo Frames.
64The maximum MTU setting for Jumbo Frames is 16110.
65This value coincides with the maximum Jumbo Frames size of 16128.
66Some Intel gigabit adapters that support Jumbo Frames have a frame size
67limit of 9238 bytes, with a corresponding MTU size limit of 9216 bytes.
68The adapters with this limitation are based on the Intel(R)
6982571EB, 82572EI, 82573L, 82563EB and 82564EI LAN controllers.
70These correspond to the following product names:
71.Pp
72.Bl -bullet -compact
73.It
74Intel(R) PRO/1000 PT Server Adapter
75.It
76Intel(R) PRO/1000 PT Desktop Adapter
77.It
78Intel(R) PRO/1000 PT Network Connection
79.It
80Intel(R) PRO/1000 PT Dual Port Server Adapter
81.It
82Intel(R) PRO/1000 PT Dual Port Network Connection
83.It
84Intel(R) PRO/1000 PT Quad Port Server Adapter
85.It
86Intel(R) PRO/1000 PF Quad Port Server Adapter
87.It
88Intel(R) PRO/1000 PF Server Adapter
89.It
90Intel(R) PRO/1000 PF Network Connection
91.It
92Intel(R) PRO/1000 PF Dual Port Server Adapter
93.It
94Intel(R) PRO/1000 PB Server Connection
95.It
96Intel(R) PRO/1000 PL Network Connection
97.It
98Intel(R) PRO/1000 EB Network Connection with I/O Acceleration
99.It
100Intel(R) PRO/1000 EB Backplane Connection with I/O Acceleration
101.It
102Intel(R) 82566DM-2 Gigabit Network Connection
103.El
104.Pp
105Adapters based on the Intel(R) 82542 and 82573V/E controller do not
106support Jumbo Frames.
107These correspond to the following product names:
108.Pp
109.Bl -bullet -compact
110.It
111Intel(R) PRO/1000 Gigabit Server Adapter
112.It
113Intel(R) PRO/1000 PM Network Connection
114.El
115.Pp
116Using Jumbo Frames at 10 or 100 Mbps may result in poor performance or
117loss of link.
118.Pp
119The following adapters do not support Jumbo Frames:
120.Pp
121.Bl -bullet -compact
122.It
123Intel(R) 82562V 10/100 Network Connection
124.It
125Intel(R) 82566DM Gigabit Network Connection
126.It
127Intel(R) 82566DC Gigabit Network Connection
128.It
129Intel(R) 82566MM Gigabit Network Connection
130.It
131Intel(R) 82566MC Gigabit Network Connection
132.El
133.Pp
134This driver version supports VLANs.
135For information on enabling VLANs,
136see the
137.Pa README .
138The
139.Nm
140driver supports the following media types:
141.Bl -tag -width ".Cm 10baseT/UTP"
142.It Cm autoselect
143Enables auto-negotiation for speed and duplex.
144.It Cm 10baseT/UTP
145Sets 10Mbps operation.
146Use the
147.Cm mediaopt
148option to select
149.Cm full-duplex
150mode.
151.It Cm 100baseTX
152Sets 100Mbps operation.
153Use the
154.Cm mediaopt
155option to select
156.Cm full-duplex
157mode.
158.It Cm 1000baseSX
159Sets 1000Mbps operation.
160Only
161.Cm full-duplex
162mode is supported at this speed.
163.It Cm 1000baseT
164Sets 1000Mbps operation.
165Only
166.Cm full-duplex
167mode is supported at this speed.
168.El
169.Pp
170The
171.Nm
172driver supports the following media options:
173.Bl -tag -width ".Cm full-duplex"
174.It Cm full-duplex
175Forces full-duplex operation
176.It Cm half-duplex
177Forces half-duplex operation.
178.El
179.Pp
180Only use
181.Cm mediaopt
182to set the driver to
183.Cm full-duplex .
184If
185.Cm mediaopt
186is not specified, the driver defaults to
187.Cm half-duplex .
188.Pp
189For more information on configuring this device, see
190.Xr ifconfig 8 .
191.Sh TUNABLES
192.Bl -tag -width ".Va hw.em.int_throttle_ceil"
193.It Va hw.em.int_throttle_ceil
194Hardware interrupt throttling rate.
195The default value is 10000Hz.
196.It Va hw.em.rxd
197Number of receive descriptors allocated by the driver.
198The default value is 256.
199The 82542 and 82543-based adapters can handle up to 256 descriptors,
200while others can have up to 4096.
201.It Va hw.em.txd
202Number of transmit descriptors allocated by the driver.
203The default value is 256.
204The 82542 and 82543-based adapters can handle up to 256 descriptors,
205while others can have up to 4096.
206.It Va hw.em.rx_int_delay
207This value delays the generation of receive interrupts in units of
2081.024 microseconds.
209The default value is 0, since adapters may hang with this feature
210being enabled.
211.It Va hw.em.rx_abs_int_delay
212If
213.Va hw.em.rx_int_delay
214is non-zero, this tunable limits the maximum delay in which a receive
215interrupt is generated.
216.It Va hw.em.tx_int_delay
217This value delays the generation of transmit interrupts in units of
2181.024 microseconds.
219The default value is 64.
220.It Va hw.em.tx_abs_int_delay
221If
222.Va hw.em.tx_int_delay
223is non-zero, this tunable limits the maximum delay in which a transmit
224interrupt is generated.
225.El
226.Sh DIAGNOSTICS
227.Bl -diag
228.It "em%d: Unable to allocate bus resource: memory"
229A fatal initialization error has occurred.
230.It "em%d: Unable to allocate bus resource: interrupt"
231A fatal initialization error has occurred.
232.It "em%d: watchdog timeout -- resetting"
233The device has stopped responding to the network, or there is a problem with
234the network connection (cable).
235.El
236.Sh SUPPORT
237For additional information regarding building and installation,
238see the
239.Pa README
240included with the driver.
241For general information and support,
242go to the Intel support website at:
243.Pa http://support.intel.com .
244.Pp
245If an issue is identified with the released source code on the supported kernel
246with a supported adapter, email the specific information related to the
247issue to
248.Aq freebsdnic@mailbox.intel.com .
249.Sh SEE ALSO
250.Xr arp 4 ,
251.Xr ifmedia 4 ,
252.Xr netintro 4 ,
253.Xr ng_ether 4 ,
254.Xr polling 4 ,
255.Xr vlan 4 ,
256.Xr ifconfig 8
257.Sh HISTORY
258The
259.Nm
260device driver first appeared in
261.Fx 4.4 .
262.Sh AUTHORS
263The
264.Nm
265driver was written by
266.An Intel Corporation Aq freebsdnic@mailbox.intel.com .
267