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