xref: /freebsd/share/man/man4/em.4 (revision 9fd69f37d28cfd7438cac3eeb45fe9dd46b4d7dd)
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$
33.\"
34.Dd October 6, 2008
35.Dt EM 4
36.Os
37.Sh NAME
38.Nm em
39.Nd "Intel(R) PRO/1000 Gigabit Ethernet adapter driver"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following line in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device em"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_em_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for PCI Gigabit Ethernet adapters based on
58the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
5982546EB, 82546GB, 82547, 82571, 81572, 82573, and 82574 Ethernet
60controller chips.
61The driver supports Transmit/Receive checksum offload
62and Jumbo Frames on all but 82542-based adapters.
63Furthermore it supports TCP segmentation offload (TSO) on all adapters but
64those based on the 82543, 82544 and 82547 controller chips.
65For further hardware information, see the
66.Pa README
67included with the driver.
68.Pp
69For questions related to hardware requirements,
70refer to the documentation supplied with your Intel PRO/1000 adapter.
71All hardware requirements listed apply to use with
72.Fx .
73.Pp
74Support for Jumbo Frames is provided via the interface MTU setting.
75Selecting an MTU larger than 1500 bytes with the
76.Xr ifconfig 8
77utility configures the adapter to receive and transmit Jumbo Frames.
78The maximum MTU size for Jumbo Frames is 16114.
79.Pp
80This driver version supports VLANs.
81The
82.Nm
83driver supports the following media types:
84.Bl -tag -width ".Cm 10baseT/UTP"
85.It Cm autoselect
86Enables auto-negotiation for speed and duplex.
87.It Cm 10baseT/UTP
88Sets 10Mbps operation.
89Use the
90.Cm mediaopt
91option to select
92.Cm full-duplex
93mode.
94.It Cm 100baseTX
95Sets 100Mbps operation.
96Use the
97.Cm mediaopt
98option to select
99.Cm full-duplex
100mode.
101.It Cm 1000baseSX
102Sets 1000Mbps operation.
103Only
104.Cm full-duplex
105mode is supported at this speed.
106.It Cm 1000baseTX
107Sets 1000Mbps operation.
108Only
109.Cm full-duplex
110mode is supported at this speed.
111.El
112.Pp
113The
114.Nm
115driver supports the following media options:
116.Bl -tag -width ".Cm full-duplex"
117.It Cm full-duplex
118Forces full-duplex operation
119.It Cm half-duplex
120Forces half-duplex operation.
121.El
122.Pp
123Only use
124.Cm mediaopt
125to set the driver to
126.Cm full-duplex .
127If
128.Cm mediaopt
129is not specified, the driver defaults to
130.Cm half-duplex .
131.Pp
132For more information on configuring this device, see
133.Xr ifconfig 8 .
134.Sh HARDWARE
135The
136.Nm
137driver supports Gigabit Ethernet adapters based on the Intel
13882540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
13982546GB, 82547, 82571, 82572, 82573, and 82574 controller chips:
140.Pp
141.Bl -bullet -compact
142.It
143Intel PRO/1000 CT Network Connection (82547)
144.It
145Intel PRO/1000 F Server Adapter (82543)
146.It
147Intel PRO/1000 Gigabit Server Adapter (82542)
148.It
149Intel PRO/1000 GT Desktop Adapter (82541PI)
150.It
151Intel PRO/1000 MF Dual Port Server Adapter (82546)
152.It
153Intel PRO/1000 MF Server Adapter (82545)
154.It
155Intel PRO/1000 MF Server Adapter (LX) (82545)
156.It
157Intel PRO/1000 MT Desktop Adapter (82540)
158.It
159Intel PRO/1000 MT Desktop Adapter (82541)
160.It
161Intel PRO/1000 MT Dual Port Server Adapter (82546)
162.It
163Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
164.It
165Intel PRO/1000 MT Server Adapter (82545)
166.It
167Intel PRO/1000 PF Dual Port Server Adapter (82571)
168.It
169Intel PRO/1000 PF Quad Port Server Adapter (82571)
170.It
171Intel PRO/1000 PF Server Adapter (82572)
172.It
173Intel PRO/1000 PT Desktop Adapter (82572)
174.It
175Intel PRO/1000 PT Dual Port Server Adapter (82571)
176.It
177Intel PRO/1000 PT Quad Port Server Adapter (82571)
178.It
179Intel PRO/1000 PT Server Adapter (82572)
180.It
181Intel PRO/1000 T Desktop Adapter (82544)
182.It
183Intel PRO/1000 T Server Adapter (82543)
184.It
185Intel PRO/1000 XF Server Adapter (82544)
186.It
187Intel PRO/1000 XT Server Adapter (82544)
188.El
189.Sh LOADER TUNABLES
190Tunables can be set at the
191.Xr loader 8
192prompt before booting the kernel or stored in
193.Xr loader.conf 5 .
194.Bl -tag -width indent
195.It Va hw.em.rxd
196Number of receive descriptors allocated by the driver.
197The default value is 256.
198The 82542 and 82543-based adapters can handle up to 256 descriptors,
199while others can have up to 4096.
200.It Va hw.em.txd
201Number of transmit descriptors allocated by the driver.
202The default value is 256.
203The 82542 and 82543-based adapters can handle up to 256 descriptors,
204while others can have up to 4096.
205.It Va hw.em.rx_int_delay
206This value delays the generation of receive interrupts in units of
2071.024 microseconds.
208The default value is 0, since adapters may hang with this feature
209being enabled.
210.It Va hw.em.rx_abs_int_delay
211If
212.Va hw.em.rx_int_delay
213is non-zero, this tunable limits the maximum delay in which a receive
214interrupt is generated.
215.It Va hw.em.tx_int_delay
216This value delays the generation of transmit interrupts in units of
2171.024 microseconds.
218The default value is 64.
219.It Va hw.em.tx_abs_int_delay
220If
221.Va hw.em.tx_int_delay
222is non-zero, this tunable limits the maximum delay in which a transmit
223interrupt is generated.
224.El
225.Sh DIAGNOSTICS
226.Bl -diag
227.It "em%d: Unable to allocate bus resource: memory"
228A fatal initialization error has occurred.
229.It "em%d: Unable to allocate bus resource: interrupt"
230A fatal initialization error has occurred.
231.It "em%d: watchdog timeout -- resetting"
232The device has stopped responding to the network, or there is a problem with
233the network connection (cable).
234.El
235.Sh SUPPORT
236For general information and support,
237go to the Intel support website at:
238.Pa http://support.intel.com .
239.Pp
240If an issue is identified with the released source code on the supported kernel
241with a supported adapter, email the specific information related to the
242issue to
243.Aq freebsdnic@mailbox.intel.com .
244.Sh SEE ALSO
245.Xr altq 4 ,
246.Xr arp 4 ,
247.Xr igb 4 ,
248.Xr netintro 4 ,
249.Xr ng_ether 4 ,
250.Xr polling 4 ,
251.Xr vlan 4 ,
252.Xr ifconfig 8
253.Sh HISTORY
254The
255.Nm
256device driver first appeared in
257.Fx 4.4 .
258.Sh AUTHORS
259The
260.Nm
261driver was written by
262.An Intel Corporation Aq freebsdnic@mailbox.intel.com .
263.Sh BUGS
264Hardware-assisted VLAN processing is disabled by default.
265You can enable it on an
266.Nm
267interface using
268.Xr ifconfig 8 .
269