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