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 October 6, 2008
  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, 82573, and 82574 Ethernet
  60 controller chips.
  61 The driver supports Transmit/Receive checksum offload
  62 and Jumbo Frames on all but 82542-based adapters.
  63 Furthermore it supports TCP segmentation offload (TSO) on all adapters but
  64 those based on the 82543, 82544 and 82547 controller chips.
  65 For further hardware information, see the
  66 .Pa README
  67 included with the driver.
  68 .Pp
  69 For questions related to hardware requirements,
  70 refer to the documentation supplied with your Intel PRO/1000 adapter.
  71 All hardware requirements listed apply to use with
  72 .Fx .
  73 .Pp
  74 Support for Jumbo Frames is provided via the interface MTU setting.
  75 Selecting an MTU larger than 1500 bytes with the
  76 .Xr ifconfig 8
  77 utility configures the adapter to receive and transmit Jumbo Frames.
  78 The maximum MTU size for Jumbo Frames is 16114.
  79 .Pp
  80 This driver version supports VLANs.
  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 1000baseTX
 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 HARDWARE
 135 The
 136 .Nm
 137 driver supports Gigabit Ethernet adapters based on the Intel
 138 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
 139 82546GB, 82547, 82571, 82572, 82573, and 82574 controller chips:
 140 .Pp
 141 .Bl -bullet -compact
 142 .It
 143 Intel PRO/1000 CT Network Connection (82547)
 144 .It
 145 Intel PRO/1000 F Server Adapter (82543)
 146 .It
 147 Intel PRO/1000 Gigabit Server Adapter (82542)
 148 .It
 149 Intel PRO/1000 GT Desktop Adapter (82541PI)
 150 .It
 151 Intel PRO/1000 MF Dual Port Server Adapter (82546)
 152 .It
 153 Intel PRO/1000 MF Server Adapter (82545)
 154 .It
 155 Intel PRO/1000 MF Server Adapter (LX) (82545)
 156 .It
 157 Intel PRO/1000 MT Desktop Adapter (82540)
 158 .It
 159 Intel PRO/1000 MT Desktop Adapter (82541)
 160 .It
 161 Intel PRO/1000 MT Dual Port Server Adapter (82546)
 162 .It
 163 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
 164 .It
 165 Intel PRO/1000 MT Server Adapter (82545)
 166 .It
 167 Intel PRO/1000 PF Dual Port Server Adapter (82571)
 168 .It
 169 Intel PRO/1000 PF Quad Port Server Adapter (82571)
 170 .It
 171 Intel PRO/1000 PF Server Adapter (82572)
 172 .It
 173 Intel PRO/1000 PT Desktop Adapter (82572)
 174 .It
 175 Intel PRO/1000 PT Dual Port Server Adapter (82571)
 176 .It
 177 Intel PRO/1000 PT Quad Port Server Adapter (82571)
 178 .It
 179 Intel PRO/1000 PT Server Adapter (82572)
 180 .It
 181 Intel PRO/1000 T Desktop Adapter (82544)
 182 .It
 183 Intel PRO/1000 T Server Adapter (82543)
 184 .It
 185 Intel PRO/1000 XF Server Adapter (82544)
 186 .It
 187 Intel PRO/1000 XT Server Adapter (82544)
 188 .El
 189 .Sh LOADER TUNABLES
 190 Tunables can be set at the
 191 .Xr loader 8
 192 prompt before booting the kernel or stored in
 193 .Xr loader.conf 5 .
 194 .Bl -tag -width indent
 195 .It Va hw.em.rxd
 196 Number of receive descriptors allocated by the driver.
 197 The default value is 256.
 198 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 199 while others can have up to 4096.
 200 .It Va hw.em.txd
 201 Number of transmit descriptors allocated by the driver.
 202 The default value is 256.
 203 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 204 while others can have up to 4096.
 205 .It Va hw.em.rx_int_delay
 206 This value delays the generation of receive interrupts in units of
 207 1.024 microseconds.
 208 The default value is 0, since adapters may hang with this feature
 209 being enabled.
 210 .It Va hw.em.rx_abs_int_delay
 211 If
 212 .Va hw.em.rx_int_delay
 213 is non-zero, this tunable limits the maximum delay in which a receive
 214 interrupt is generated.
 215 .It Va hw.em.tx_int_delay
 216 This value delays the generation of transmit interrupts in units of
 217 1.024 microseconds.
 218 The default value is 64.
 219 .It Va hw.em.tx_abs_int_delay
 220 If
 221 .Va hw.em.tx_int_delay
 222 is non-zero, this tunable limits the maximum delay in which a transmit
 223 interrupt is generated.
 224 .El
 225 .Sh DIAGNOSTICS
 226 .Bl -diag
 227 .It "em%d: Unable to allocate bus resource: memory"
 228 A fatal initialization error has occurred.
 229 .It "em%d: Unable to allocate bus resource: interrupt"
 230 A fatal initialization error has occurred.
 231 .It "em%d: watchdog timeout -- resetting"
 232 The device has stopped responding to the network, or there is a problem with
 233 the network connection (cable).
 234 .El
 235 .Sh SUPPORT
 236 For general information and support,
 237 go to the Intel support website at:
 238 .Pa http://support.intel.com .
 239 .Pp
 240 If an issue is identified with the released source code on the supported kernel
 241 with a supported adapter, email the specific information related to the
 242 issue to
 243 .Aq freebsdnic@mailbox.intel.com .
 244 .Sh SEE ALSO
 245 .Xr altq 4 ,
 246 .Xr arp 4 ,
 247 .Xr netintro 4 ,
 248 .Xr ng_ether 4 ,
 249 .Xr polling 4 ,
 250 .Xr vlan 4 ,
 251 .Xr ifconfig 8
 252 .Sh HISTORY
 253 The
 254 .Nm
 255 device driver first appeared in
 256 .Fx 4.4 .
 257 .Sh AUTHORS
 258 The
 259 .Nm
 260 driver was written by
 261 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .
 262 .Sh BUGS
 263 Hardware-assisted VLAN processing is disabled by default.
 264 You can enable it on an
 265 .Nm
 266 interface using
 267 .Xr ifconfig 8 .