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