Sync em(4) manpage with the one in Intel em 6.2.9
[dragonfly.git] / share / man / man4 / em.4
CommitLineData
984263bc
MD
1.\" Copyright (c) 2001-2003, Intel Corporation
2.\" All rights reserved.
1bf4b486 3.\"
984263bc
MD
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 $
829c4df6 33.\" $DragonFly: src/share/man/man4/em.4,v 1.5 2006/12/23 10:42:29 sephe Exp $
984263bc 34.\"
829c4df6 35.Dd December 5, 2006
984263bc
MD
36.Dt EM 4
37.Os
38.Sh NAME
39.Nm em
9bb2a92d 40.Nd "Intel(R) PRO/1000 gigabit Ethernet driver"
984263bc
MD
41.Sh SYNOPSIS
42.Cd "device em"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI gigabit Ethernet adapters based on
829c4df6
SZ
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.
984263bc
MD
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
9bb2a92d 58.Dx .
984263bc
MD
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.
829c4df6
SZ
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.
70.Pp
71The following Intel gigabit LAN devices do not support Jumbo Frames:
72.Pp
73Intel(R) PRO/1000 PM Network Connection
74.Pp
75Adapters based on the Intel(R) 82542 and 82573 LAN controllers.
984263bc
MD
76.Pp
77This driver version supports VLANs.
829c4df6
SZ
78For information on enabling VLANs,
79see the
984263bc
MD
80.Pa README .
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.
829c4df6 106.It Cm 1000baseT
984263bc
MD
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 DIAGNOSTICS
135.Bl -diag
136.It "em%d: Unable to allocate bus resource: memory"
137A fatal initialization error has occurred.
138.It "em%d: Unable to allocate bus resource: interrupt"
139A fatal initialization error has occurred.
140.It "em%d: watchdog timeout -- resetting"
141The device has stopped responding to the network, or there is a problem with
142the network connection (cable).
143.El
144.Sh SUPPORT
145For additional information regarding building and installation,
146see the
147.Pa README
148included with the driver.
149For general information and support,
150go to the Intel support website at:
151.Pa http://support.intel.com .
152.Pp
153If an issue is identified with the released source code on the supported kernel
154with a supported adapter, email the specific information related to the
155issue to
156.Aq freebsdnic@mailbox.intel.com .
157.Sh SEE ALSO
158.Xr arp 4 ,
159.Xr gx 4 ,
160.Xr netintro 4 ,
161.Xr ng_ether 4 ,
162.Xr vlan 4 ,
163.Xr ifconfig 8
164.Sh HISTORY
165The
166.Nm
167device driver first appeared in
168.Fx 4.4 .
169.Sh AUTHORS
170The
171.Nm
172driver was written by
173.An Intel Corporation Aq freebsdnic@mailbox.intel.com .