xref: /freebsd/share/man/man4/em.4 (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
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 January 30, 2005
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
41.Cd "device em"
42.Sh DESCRIPTION
43The
44.Nm
45driver provides support for PCI Gigabit Ethernet adapters based on
46the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546,
4782546EB, 82546GB and 82547 Ethernet controller chips.
48The driver supports Transmit/Receive checksum offload
49and Jumbo Frames only on 82540, 82543, 82544 and 82546-based adapters.
50For further hardware information, see the
51.Pa README
52included with the driver.
53.Pp
54For questions related to hardware requirements,
55refer to the documentation supplied with your Intel PRO/1000 adapter.
56All hardware requirements listed apply to use with
57.Fx .
58.Pp
59Support for Jumbo Frames is provided via the interface MTU setting.
60Selecting an MTU larger than 1500 bytes with the
61.Xr ifconfig 8
62utility configures the adapter to receive and transmit Jumbo Frames.
63The maximum MTU size for Jumbo Frames is 16114.
64.Pp
65This driver version supports VLANs.
66For information on enabling VLANs, see the
67.Pa README .
68The
69.Nm
70driver supports the following media types:
71.Bl -tag -width ".Cm 10baseT/UTP"
72.It Cm autoselect
73Enables auto-negotiation for speed and duplex.
74.It Cm 10baseT/UTP
75Sets 10Mbps operation.
76Use the
77.Cm mediaopt
78option to select
79.Cm full-duplex
80mode.
81.It Cm 100baseTX
82Sets 100Mbps operation.
83Use the
84.Cm mediaopt
85option to select
86.Cm full-duplex
87mode.
88.It Cm 1000baseSX
89Sets 1000Mbps operation.
90Only
91.Cm full-duplex
92mode is supported at this speed.
93.It Cm 1000baseTX
94Sets 1000Mbps operation.
95Only
96.Cm full-duplex
97mode is supported at this speed.
98.El
99.Pp
100The
101.Nm
102driver supports the following media options:
103.Bl -tag -width ".Cm full-duplex"
104.It Cm full-duplex
105Forces full-duplex operation
106.It Cm half-duplex
107Forces half-duplex operation.
108.El
109.Pp
110Only use
111.Cm mediaopt
112to set the driver to
113.Cm full-duplex .
114If
115.Cm mediaopt
116is not specified, the driver defaults to
117.Cm half-duplex .
118.Pp
119For more information on configuring this device, see
120.Xr ifconfig 8 .
121.Sh HARDWARE
122The
123.Nm
124driver supports Gigabit Ethernet adapters based on the Intel
12582540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
12682546GB and 82547 controller chips:
127.Pp
128.Bl -bullet -compact
129.It
130Intel PRO/1000 CT Network Connection (82547)
131.It
132Intel PRO/1000 F Server Adapter (82543)
133.It
134Intel PRO/1000 Gigabit Server Adapter (82542)
135.It
136Intel PRO/1000 GT Desktop Adapter (82541PI)
137.It
138Intel PRO/1000 MF Dual Port Server Adapter (82546)
139.It
140Intel PRO/1000 MF Server Adapter (82545)
141.It
142Intel PRO/1000 MF Server Adapter (LX) (82545)
143.It
144Intel PRO/1000 MT Desktop Adapter (82540)
145.It
146Intel PRO/1000 MT Desktop Adapter (82541)
147.It
148Intel PRO/1000 MT Dual Port Server Adapter (82546)
149.It
150Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
151.It
152Intel PRO/1000 MT Server Adapter (82545)
153.It
154Intel PRO/1000 T Desktop Adapter (82544)
155.It
156Intel PRO/1000 T Server Adapter (82543)
157.It
158Intel PRO/1000 XF Server Adapter (82544)
159.It
160Intel PRO/1000 XT Server Adapter (82544)
161.El
162.Sh DIAGNOSTICS
163.Bl -diag
164.It "em%d: Unable to allocate bus resource: memory"
165A fatal initialization error has occurred.
166.It "em%d: Unable to allocate bus resource: interrupt"
167A fatal initialization error has occurred.
168.It "em%d: watchdog timeout -- resetting"
169The device has stopped responding to the network, or there is a problem with
170the network connection (cable).
171.El
172.Sh SUPPORT
173For additional information regarding building and installation,
174see the
175.Pa README
176included with the driver.
177For general information and support,
178go to the Intel support website at:
179.Pa http://support.intel.com .
180.Pp
181If an issue is identified with the released source code on the supported kernel
182with a supported adapter, email the specific information related to the
183issue to
184.Aq freebsdnic@mailbox.intel.com .
185.Sh SEE ALSO
186.Xr arp 4 ,
187.Xr netintro 4 ,
188.Xr ng_ether 4 ,
189.Xr polling 4 ,
190.Xr vlan 4 ,
191.Xr ifconfig 8
192.Sh HISTORY
193The
194.Nm
195device driver first appeared in
196.Fx 4.4 .
197.Sh AUTHORS
198The
199.Nm
200driver was written by
201.An Intel Corporation Aq freebsdnic@mailbox.intel.com .
202.Sh BUGS
203Hardware-assisted VLAN processing is disabled by default.
204You can enable it on an
205.Nm
206interface using
207.Xr ifconfig 8
208unless you are going to run
209.Xr bridge 4
210on the interface.
211In any case, VLAN can operate safely without the hardware acceleration.
212