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