Sync em(4) manpage with the one in Intel em 6.2.9
[dragonfly.git] / share / man / man4 / em.4
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.5 2006/12/23 10:42:29 sephe Exp $
34 .\"
35 .Dd December 5, 2006
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
44 The
45 .Nm
46 driver provides support for PCI gigabit Ethernet adapters based on
47 the Intel 82540, 82541, 82542, 82543, 82544, 82546, and 82547 Ethernet
48 controller chips.
49 The driver does not support Transmit/Receive checksum offload and
50 Jumbo Frames on adapters based on the Intel 82542 and 82573 LAN controllers.
51 For a list of supported adapters, see the
52 .Pa README
53 included with the driver.
54 .Pp
55 For questions related to hardware requirements,
56 refer to the documentation supplied with your Intel PRO/1000 adapter.
57 All hardware requirements listed apply to use with
58 .Dx .
59 .Pp
60 Support for Jumbo Frames is provided via the interface MTU setting.
61 Selecting an MTU larger than 1500 bytes with the
62 .Xr ifconfig 8
63 utility configures the adapter to receive and transmit Jumbo Frames.
64 The maximum MTU setting for Jumbo Frames is 16110.
65 This value coincides with the maximum Jumbo Frames size of 16128.
66 Some Intel gigabit adapters that support Jumbo Frames have a frame size
67 limit of 9238 bytes, with a corresponding MTU size limit of 9216 bytes.
68 The adapters with this limitation are based on the Intel(R)
69 82571EB, 82572EI, 82573L, 82563EB and 82564EI LAN controllers.
70 .Pp
71 The following Intel gigabit LAN devices do not support Jumbo Frames:
72 .Pp
73 Intel(R) PRO/1000 PM Network Connection
74 .Pp
75 Adapters based on the Intel(R) 82542 and 82573 LAN controllers.
76 .Pp
77 This driver version supports VLANs.
78 For information on enabling VLANs,
79 see the
80 .Pa README .
81 The
82 .Nm
83 driver supports the following media types:
84 .Bl -tag -width ".Cm 10baseT/UTP"
85 .It Cm autoselect
86 Enables auto-negotiation for speed and duplex.
87 .It Cm 10baseT/UTP
88 Sets 10Mbps operation.
89 Use the
90 .Cm mediaopt
91 option to select
92 .Cm full-duplex
93 mode.
94 .It Cm 100baseTX
95 Sets 100Mbps operation.
96 Use the
97 .Cm mediaopt
98 option to select
99 .Cm full-duplex
100 mode.
101 .It Cm 1000baseSX
102 Sets 1000Mbps operation.
103 Only
104 .Cm full-duplex
105 mode is supported at this speed.
106 .It Cm 1000baseT
107 Sets 1000Mbps operation.
108 Only
109 .Cm full-duplex
110 mode is supported at this speed.
111 .El
112 .Pp
113 The
114 .Nm
115 driver supports the following media options:
116 .Bl -tag -width ".Cm full-duplex"
117 .It Cm full-duplex
118 Forces full-duplex operation
119 .It Cm half-duplex
120 Forces half-duplex operation.
121 .El
122 .Pp
123 Only use
124 .Cm mediaopt
125 to set the driver to
126 .Cm full-duplex .
127 If
128 .Cm mediaopt
129 is not specified, the driver defaults to
130 .Cm half-duplex .
131 .Pp
132 For 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"
137 A fatal initialization error has occurred.
138 .It "em%d: Unable to allocate bus resource: interrupt"
139 A fatal initialization error has occurred.
140 .It "em%d: watchdog timeout -- resetting"
141 The device has stopped responding to the network, or there is a problem with
142 the network connection (cable).
143 .El
144 .Sh SUPPORT
145 For additional information regarding building and installation,
146 see the
147 .Pa README
148 included with the driver.
149 For general information and support,
150 go to the Intel support website at:
151 .Pa http://support.intel.com .
152 .Pp
153 If an issue is identified with the released source code on the supported kernel
154 with a supported adapter, email the specific information related to the
155 issue 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
165 The
166 .Nm
167 device driver first appeared in
168 .Fx 4.4 .
169 .Sh AUTHORS
170 The
171 .Nm
172 driver was written by
173 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .