Sync with Intel's 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.4 2005/08/01 01:49:17 swildner Exp $
34 .\"
35 .Dd July 26, 2002
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, 82542, 82543, 82544 and 82546 Ethernet controller chips.
48 The driver supports Transmit/Receive checksum offload
49 and Jumbo Frames only on 82540, 82543, 82544 and 82546-based adapters.
50 For a list of supported adapters, see the
51 .Pa README
52 included with the driver.
53 .Pp
54 For questions related to hardware requirements,
55 refer to the documentation supplied with your Intel PRO/1000 adapter.
56 All hardware requirements listed apply to use with
57 .Dx .
58 .Pp
59 Support for Jumbo Frames is provided via the interface MTU setting.
60 Selecting an MTU larger than 1500 bytes with the
61 .Xr ifconfig 8
62 utility configures the adapter to receive and transmit Jumbo Frames.
63 The maximum MTU size for Jumbo Frames is 16114.
64 .Pp
65 This driver version supports VLANs.
66 For information on enabling VLANs, see the
67 .Pa README .
68 The
69 .Nm
70 driver supports the following media types:
71 .Bl -tag -width ".Cm 10baseT/UTP"
72 .It Cm autoselect
73 Enables auto-negotiation for speed and duplex.
74 .It Cm 10baseT/UTP
75 Sets 10Mbps operation.
76 Use the
77 .Cm mediaopt
78 option to select
79 .Cm full-duplex
80 mode.
81 .It Cm 100baseTX
82 Sets 100Mbps operation.
83 Use the
84 .Cm mediaopt
85 option to select
86 .Cm full-duplex
87 mode.
88 .It Cm 1000baseSX
89 Sets 1000Mbps operation.
90 Only
91 .Cm full-duplex
92 mode is supported at this speed.
93 .It Cm 1000baseTX
94 Sets 1000Mbps operation.
95 Only
96 .Cm full-duplex
97 mode is supported at this speed.
98 .El
99 .Pp
100 The
101 .Nm
102 driver supports the following media options:
103 .Bl -tag -width ".Cm full-duplex"
104 .It Cm full-duplex
105 Forces full-duplex operation
106 .It Cm half-duplex
107 Forces half-duplex operation.
108 .El
109 .Pp
110 Only use
111 .Cm mediaopt
112 to set the driver to
113 .Cm full-duplex .
114 If
115 .Cm mediaopt
116 is not specified, the driver defaults to
117 .Cm half-duplex .
118 .Pp
119 For more information on configuring this device, see
120 .Xr ifconfig 8 .
121 .Sh DIAGNOSTICS
122 .Bl -diag
123 .It "em%d: Unable to allocate bus resource: memory"
124 A fatal initialization error has occurred.
125 .It "em%d: Unable to allocate bus resource: interrupt"
126 A fatal initialization error has occurred.
127 .It "em%d: watchdog timeout -- resetting"
128 The device has stopped responding to the network, or there is a problem with
129 the network connection (cable).
130 .El
131 .Sh SUPPORT
132 For additional information regarding building and installation,
133 see the
134 .Pa README
135 included with the driver.
136 For general information and support,
137 go to the Intel support website at:
138 .Pa http://support.intel.com .
139 .Pp
140 If an issue is identified with the released source code on the supported kernel
141 with a supported adapter, email the specific information related to the
142 issue to
143 .Aq freebsdnic@mailbox.intel.com .
144 .Sh SEE ALSO
145 .Xr arp 4 ,
146 .Xr gx 4 ,
147 .Xr netintro 4 ,
148 .Xr ng_ether 4 ,
149 .Xr vlan 4 ,
150 .Xr ifconfig 8
151 .Sh HISTORY
152 The
153 .Nm
154 device driver first appeared in
155 .Fx 4.4 .
156 .Sh AUTHORS
157 The
158 .Nm
159 driver was written by
160 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .