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 September 20, 2018
  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 .Pp
  62 The
  63 .Nm
  64 driver also provides support for PCI Express Gigabit Ethernet adapters
  65 based on the Intel 82575, 82576, 82580, i21x and i35x.
  66 .Pp
  67 The driver supports Transmit/Receive checksum offload and Jumbo Frames
  68 on all but 82542-based adapters.
  69 .Pp
  70 Furthermore it supports TCP segmentation offload (TSO) on all adapters but
  71 those based on the 82543, 82544 and 82547 controller chips.
  72 The identification LEDs of the adapters supported by the
  73 .Nm
  74 driver can be controlled via the
  75 .Xr led 4
  76 API for localization purposes.
  77 For further hardware information, see the
  78 .Pa README
  79 included with the driver.
  80 .Pp
  81 For questions related to hardware requirements, refer to the
  82 documentation supplied with your Intel PRO/1000 adapter.
  83 All hardware requirements listed apply to use with
  84 .Fx .
  85 .Pp
  86 Support for Jumbo Frames is provided via the interface MTU setting.
  87 Selecting an MTU larger than 1500 bytes with the
  88 .Xr ifconfig 8
  89 utility configures the adapter to receive and transmit Jumbo Frames.
  90 The maximum MTU size for Jumbo Frames is 16114.
  91 .Pp
  92 This driver supports hardware assisted VLANs.
  93 The
  94 .Nm
  95 driver supports the following media types:
  96 .Bl -tag -width ".Cm 10baseT/UTP"
  97 .It Cm autoselect
  98 Enables auto-negotiation for speed and duplex.
  99 .It Cm 10baseT/UTP
 100 Sets 10Mbps operation.
 101 Use the
 102 .Cm mediaopt
 103 option to select
 104 .Cm full-duplex
 105 mode.
 106 .It Cm 100baseTX
 107 Sets 100Mbps operation.
 108 Use the
 109 .Cm mediaopt
 110 option to select
 111 .Cm full-duplex
 112 mode.
 113 .It Cm 1000baseSX
 114 Sets 1000Mbps operation.
 115 Only
 116 .Cm full-duplex
 117 mode is supported at this speed.
 118 .It Cm 1000baseTX
 119 Sets 1000Mbps operation.
 120 Only
 121 .Cm full-duplex
 122 mode is supported at this speed.
 123 .El
 124 .Pp
 125 The
 126 .Nm
 127 driver supports the following media options:
 128 .Bl -tag -width ".Cm full-duplex"
 129 .It Cm full-duplex
 130 Forces full-duplex operation
 131 .It Cm half-duplex
 132 Forces half-duplex operation.
 133 .El
 134 .Pp
 135 Only use
 136 .Cm mediaopt
 137 to set the driver to
 138 .Cm full-duplex .
 139 If
 140 .Cm mediaopt
 141 is not specified, the driver defaults to
 142 .Cm half-duplex .
 143 .Pp
 144 For more information on configuring this device, see
 145 .Xr ifconfig 8 .
 146 .Sh HARDWARE
 147 The
 148 .Nm
 149 driver supports Gigabit Ethernet adapters based on the Intel
 150 82540, 82541ER, 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB,
 151 82546GB, 82547, 82571, 82572, 82573, 82574, 82575, 82576, and 82580
 152 controller chips:
 153 .Pp
 154 .Bl -bullet -compact
 155 .It
 156 Intel Gigabit ET Dual Port Server Adapter (82576)
 157 .It
 158 Intel Gigabit VT Quad Port Server Adapter (82575)
 159 .It
 160 Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)
 161 .It
 162 Intel i210 and i211 Gigabit Ethernet Controller
 163 .It
 164 Intel i350 and i354 Gigabit Ethernet Controller
 165 .It
 166 Intel PRO/1000 CT Network Connection (82547)
 167 .It
 168 Intel PRO/1000 F Server Adapter (82543)
 169 .It
 170 Intel PRO/1000 Gigabit Server Adapter (82542)
 171 .It
 172 Intel PRO/1000 GT Desktop Adapter (82541PI)
 173 .It
 174 Intel PRO/1000 MF Dual Port Server Adapter (82546)
 175 .It
 176 Intel PRO/1000 MF Server Adapter (82545)
 177 .It
 178 Intel PRO/1000 MF Server Adapter (LX) (82545)
 179 .It
 180 Intel PRO/1000 MT Desktop Adapter (82540)
 181 .It
 182 Intel PRO/1000 MT Desktop Adapter (82541)
 183 .It
 184 Intel PRO/1000 MT Dual Port Server Adapter (82546)
 185 .It
 186 Intel PRO/1000 MT Quad Port Server Adapter (82546EB)
 187 .It
 188 Intel PRO/1000 MT Server Adapter (82545)
 189 .It
 190 Intel PRO/1000 PF Dual Port Server Adapter (82571)
 191 .It
 192 Intel PRO/1000 PF Quad Port Server Adapter (82571)
 193 .It
 194 Intel PRO/1000 PF Server Adapter (82572)
 195 .It
 196 Intel PRO/1000 PT Desktop Adapter (82572)
 197 .It
 198 Intel PRO/1000 PT Dual Port Server Adapter (82571)
 199 .It
 200 Intel PRO/1000 PT Quad Port Server Adapter (82571)
 201 .It
 202 Intel PRO/1000 PT Server Adapter (82572)
 203 .It
 204 Intel PRO/1000 T Desktop Adapter (82544)
 205 .It
 206 Intel PRO/1000 T Server Adapter (82543)
 207 .It
 208 Intel PRO/1000 XF Server Adapter (82544)
 209 .It
 210 Intel PRO/1000 XT Server Adapter (82544)
 211 .El
 212 .Sh LOADER TUNABLES
 213 Tunables can be set at the
 214 .Xr loader 8
 215 prompt before booting the kernel or stored in
 216 .Xr loader.conf 5 .
 217 .Bl -tag -width indent
 218 .It Va hw.em.disable_crc_stripping
 219 Disable or enable hardware stripping of CRC field.
 220 This is mostly useful on BMC/IPMI shared interfaces where stripping the CRC
 221 causes remote access over IPMI to fail.
 222 Default 0 (enabled).
 223 .It Va hw.em.eee_setting
 224 Disable or enable Energy Efficient Ethernet.
 225 Default 1 (disabled).
 226 .It Va hw.em.msix
 227 Enable or disable MSI-X style interrupts.
 228 Default 1 (enabled).
 229 .It Va hw.em.smart_pwr_down
 230 Enable or disable smart power down features on newer adapters.
 231 Default 0 (disabled).
 232 .It Va hw.em.sbp
 233 Show bad packets when in promiscuous mode.
 234 Default 0 (off).
 235 .It Va hw.em.rxd
 236 Number of receive descriptors allocated by the driver.
 237 The default value is 1024 for adapters newer than 82547,
 238 and 256 for older ones.
 239 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 240 while others can have up to 4096.
 241 .It Va hw.em.txd
 242 Number of transmit descriptors allocated by the driver.
 243 The default value is 1024 for adapters newer than 82547,
 244 and 256 for older ones.
 245 The 82542 and 82543-based adapters can handle up to 256 descriptors,
 246 while others can have up to 4096.
 247 .It Va hw.em.rx_int_delay
 248 This value delays the generation of receive interrupts in units of
 249 1.024 microseconds.
 250 The default value is 0, since adapters may hang with this feature
 251 being enabled.
 252 .It Va hw.em.rx_abs_int_delay
 253 If
 254 .Va hw.em.rx_int_delay
 255 is non-zero, this tunable limits the maximum delay in which a receive
 256 interrupt is generated.
 257 .It Va hw.em.tx_int_delay
 258 This value delays the generation of transmit interrupts in units of
 259 1.024 microseconds.
 260 The default value is 64.
 261 .It Va hw.em.tx_abs_int_delay
 262 If
 263 .Va hw.em.tx_int_delay
 264 is non-zero, this tunable limits the maximum delay in which a transmit
 265 interrupt is generated.
 266 .Sh FILES
 267 .Bl -tag -width /dev/led/em*
 268 .It Pa /dev/led/em*
 269 identification LED device nodes
 270 .El
 271 .Sh EXAMPLES
 272 Make the identification LED of em0 blink:
 273 .Pp
 274 .Dl "echo f2 > /dev/led/em0"
 275 .Pp
 276 Turn the identification LED of em0 off again:
 277 .Pp
 278 .Dl "echo 0 > /dev/led/em0"
 279 .Sh DIAGNOSTICS
 280 .Bl -diag
 281 .It "em%d: Unable to allocate bus resource: memory"
 282 A fatal initialization error has occurred.
 283 .It "em%d: Unable to allocate bus resource: interrupt"
 284 A fatal initialization error has occurred.
 285 .It "em%d: watchdog timeout -- resetting"
 286 The device has stopped responding to the network, or there is a problem with
 287 the network connection (cable).
 288 .El
 289 .Sh SUPPORT
 290 For general information and support,
 291 go to the Intel support website at:
 292 .Pa http://support.intel.com .
 293 .Pp
 294 If an issue is identified with the released source code on the supported kernel
 295 with a supported adapter, email the specific information related to the
 296 issue to
 297 .Aq Mt freebsd@intel.com .
 298 .Sh SEE ALSO
 299 .Xr altq 4 ,
 300 .Xr arp 4 ,
 301 .Xr iflib 4 ,
 302 .Xr led 4 ,
 303 .Xr netintro 4 ,
 304 .Xr ng_ether 4 ,
 305 .Xr polling 4 ,
 306 .Xr vlan 4 ,
 307 .Xr ifconfig 8
 308 .Sh HISTORY
 309 The
 310 .Nm
 311 device driver first appeared in
 312 .Fx 4.4 .
 313 .Nm
 314 was merged with the igb device driver and converted to the iflib framework in
 315 .Fx 12.0 .
 316 .Sh AUTHORS
 317 .An -nosplit
 318 The
 319 .Nm
 320 driver was originally written by
 321 .An Intel Corporation Aq Mt freebsd@intel.com .
 322 It was merged with igb driver and converted to the iflib framework by
 323 .An Matthew Macy Aq Mt mmacy@mattmacy.io
 324 and
 325 .An Sean Bruno Aq Mt sbruno@FreeBSD.org .