share/man/man4/igb.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/igb.4,v 1.2 2010/05/14 20:11:30 marius Exp $
  33 .\"
  34 .Dd June 21, 2013
  35 .Dt IGB 4
  36 .Os
  37 .Sh NAME
  38 .Nm igb
  39 .Nd "Intel(R) PRO/1000 PCI Express 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 ig_hal"
  46 .Cd "device igb"
  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 ig_hal_load="YES"
  54 if_igb_load="YES"
  55 .Ed
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 driver provides support for PCI Express Gigabit Ethernet adapters based on
  60 the Intel
  61 82575,
  62 82576,
  63 82580,
  64 I210,
  65 I211,
  66 and I350
  67 Ethernet controller chips.
  68 The
  69 .Nm
  70 driver supports:
  71 .Pp
  72 .Bl -item -offset indent -compact
  73 .It
  74 Transmit/Receive checksum offload for IP/UDP/TCP.
  75 .\"Jumbo Frames.
  76 .It
  77 Interrupt moderation
  78 .It
  79 TCP segmentation offload (TSO)
  80 .It
  81 Receive side scaling (RSS)
  82 .It
  83 Multiple tranmission queues
  84 .It
  85 Multiple vector MSI-X
  86 .It
  87 VLAN tag stripping and inserting
  88 .El
  89 .Pp
  90 If
  91 .Xr polling 4
  92 or MSI-X is used,
  93 by default,
  94 the
  95 .Nm
  96 driver will try enabling as many reception queues and transmission queues
  97 as are allowed by the number of CPUs in the system.
  98 .Pp
  99 82575 supports 4 reception queues and 4 transmission queues.
 100 MSI-X is not enabled due to hardware errata.
 101 Under MSI or legacy interrupt mode,
 102 2 reception queues are enabled for hardware RSS hash
 103 and only 1 transmission queue is enable.
 104 .Pp
 105 82576 supports 16 reception queues and 16 transmission queues.
 106 MSI-X is enable by default.
 107 However,
 108 due to the number of MSI-X vectors is 10,
 109 at most 8 reception queues and 8 transmission queues will be enabled
 110 under MSI-X mode.
 111 When
 112 .Xr polling 4
 113 is enabled on the devices,
 114 at most 16 reception queues and 16 transmission queues will be enabled.
 115 .Pp
 116 82580 and I350 support 8 reception queues and 8 transmission queues.
 117 MSI-X is enabled by default.
 118 .Pp
 119 I210 supports 4 reception queues and 4 transmission queues.
 120 MSI-X is enabled by default.
 121 .Pp
 122 I211 supports 2 reception queues and 2 transmission queues.
 123 MSI-X is enabled by default.
 124 .Pp
 125 .\"For questions related to hardware requirements, refer to the
 126 .\"documentation supplied with your Intel PRO/1000 adapter.
 127 .\"All hardware requirements listed apply to use with
 128 .\".Dx .
 129 .\".Pp
 130 .\"Support for Jumbo Frames is provided via the interface MTU setting.
 131 .\"Selecting an MTU larger than 1500 bytes with the
 132 .\".Xr ifconfig 8
 133 .\"utility configures the adapter to receive and transmit Jumbo Frames.
 134 .\"The maximum MTU size for Jumbo Frames is 9216.
 135 .\".Pp
 136 The
 137 .Nm
 138 driver supports the following media types:
 139 .Bl -tag -width ".Cm 10baseT/UTP"
 140 .It Cm autoselect
 141 Enables auto-negotiation for speed and duplex.
 142 .It Cm 10baseT/UTP
 143 Sets 10Mbps operation.
 144 Use the
 145 .Cm mediaopt
 146 option to select
 147 .Cm full-duplex
 148 mode.
 149 .It Cm 100baseTX
 150 Sets 100Mbps operation.
 151 Use the
 152 .Cm mediaopt
 153 option to select
 154 .Cm full-duplex
 155 mode.
 156 .It Cm 1000baseSX
 157 Sets 1000Mbps operation.
 158 Only
 159 .Cm full-duplex
 160 mode is supported at this speed.
 161 .It Cm 1000baseT
 162 Sets 1000Mbps operation.
 163 Only
 164 .Cm full-duplex
 165 mode is supported at this speed.
 166 .El
 167 .Pp
 168 The
 169 .Nm
 170 driver supports the following media options:
 171 .Bl -tag -width ".Cm full-duplex"
 172 .It Cm full-duplex
 173 Forces full-duplex operation
 174 .It Cm half-duplex
 175 Forces half-duplex operation.
 176 .El
 177 .Pp
 178 Only use
 179 .Cm mediaopt
 180 to set the driver to
 181 .Cm full-duplex .
 182 If
 183 .Cm mediaopt
 184 is not specified, the driver defaults to
 185 .Cm half-duplex .
 186 .Pp
 187 For more information on configuring this device, see
 188 .Xr ifconfig 8 .
 189 The
 190 .Nm
 191 driver supports
 192 .Xr polling 4 .
 193 .Sh HARDWARE
 194 The
 195 .Nm
 196 driver supports Gigabit Ethernet adapters based on the Intel
 197 82575,
 198 82576,
 199 82580,
 200 I210,
 201 I211,
 202 and I350
 203 controller chips:
 204 .Pp
 205 .Bl -bullet -compact
 206 .It
 207 Intel 82575EB Gigabit Ethernet Controller
 208 .It
 209 Intel 82576 Gigabit Ethernet Controller
 210 .It
 211 Intel 82580EB Gigabit Ethernet Controller
 212 .It
 213 Intel Ethernet Controller I210 Series
 214 .It
 215 Intel Ethernet Controller I211 Series
 216 .It
 217 Intel Ethernet Controller I350
 218 .It
 219 Intel Ethernet Server Adapter I210-T1
 220 .It
 221 Intel Ethernet Server Adapter I340-F4
 222 .It
 223 Intel Ethernet Server Adapter I340-T4
 224 .It
 225 Intel Ethernet Server Adapter I350-F2
 226 .It
 227 Intel Ethernet Server Adapter I350-F4
 228 .It
 229 Intel Ethernet Server Adapter I350-T2
 230 .It
 231 Intel Ethernet Server Adapter I350-T4
 232 .It
 233 Intel Gigabit EF Dual Port Server Adapter
 234 .It
 235 Intel Gigabit ET Dual Port Server Adapter
 236 .It
 237 Intel Gigabit ET Quad Port Server Adapter
 238 .It
 239 Intel Gigabit ET2 Quad Port Server Adapter
 240 .It
 241 Intel Gigabit VT Quad Port Server Adapter
 242 .El
 243 .Sh TUNABLES
 244 Tunables can be set at the
 245 .Xr loader 8
 246 prompt before booting the kernel or stored in
 247 .Xr loader.conf 5 .
 248 .Em X
 249 is the device unit number.
 250 .Bl -tag -width ".Va hw.igbX.irq.unshared"
 251 .It Va hw.igb.rxd Va hw.igbX.rxd
 252 Number of receive descriptors allocated by the driver.
 253 The default value is 512.
 254 The minimum is 256,
 255 and the maximum is 4096.
 256 .It Va hw.igb.txd Va hw.igbX.txd
 257 Number of transmit descriptors allocated by the driver.
 258 The default value is 1024.
 259 The minimum is 256,
 260 and the maximum is 4096.
 261 .It Va hw.igb.rxr Va hw.igbX.rxr
 262 This tunable specifies the number of reception queues could be enabled.
 263 Maximum allowed value for these tunables is device specific
 264 and it must be power of 2 aligned.
 265 Setting these tunables to 0 allows the driver to make
 266 as many reception queues ready-for-use as allowed by the number of CPUs.
 267 .It Va hw.igb.txr Va hw.igbX.txr
 268 This tunable specifies the number of transmission queues could be enabled.
 269 Maximum allowed value for these tunables is device specific
 270 and it must be power of 2 aligned.
 271 Setting these tunables to 0 allows the driver to make
 272 as many transmission queues ready-for-use as allowed by the number of CPUs.
 273 .It Va hw.igb.msix.enable Va hw.igbX.msix.enable
 274 By default,
 275 the driver will use MSI-X if it is supported.
 276 This behaviour can be turned off by setting this tunable to 0.
 277 .It Va hw.igbX.msix.off
 278 If MSI-X is used
 279 and the number of MSI-X vectors is not enough to
 280 put transmission queue processing and reception queue processing
 281 onto independent MSI-X vector,
 282 this tunable specifies the leading target CPU for
 283 transmission and reception queues processing.
 284 The value specificed must be aligned to the maximum of
 285 the number of reception queues
 286 and the number of transmission queues enabled,
 287 and must be less than the power of 2 number of CPUs.
 288 .It Va hw.igbX.msix.rxoff
 289 If MSI-X is used
 290 and the number of MSI-X vectors is enough to
 291 put transmission queue processing and reception queue processing
 292 onto independent MSI-X vector,
 293 this tunable specifies the leading target CPU for reception queues processing.
 294 The value specificed must be aligned to the number of reception queues enabled
 295 and must be less than the power of 2 number of CPUs.
 296 .It Va hw.igbX.msix.txoff
 297 If MSI-X is used
 298 and the number of MSI-X vectors is enough to
 299 put transmission queue processing and reception queue processing
 300 onto independent MSI-X vector,
 301 this tunable specifies the leading target CPU
 302 for transmission queues processing.
 303 The value specificed must be aligned to
 304 the number of transmission queues enabled
 305 and must be less than the power of 2 number of CPUs.
 306 .It Va hw.igb.msi.enable Va hw.igbX.msi.enable
 307 If MSI-X is disabled and MSI is supported,
 308 the driver will use MSI.
 309 This behavior can be turned off by setting this tunable to 0.
 310 .It Va hw.igbX.msi.cpu
 311 If MSI is used,
 312 it specifies the MSI's target CPU.
 313 .It Va hw.igbX.irq.unshared
 314 If legacy interrupt is used,
 315 by default,
 316 the driver assumes the interrupt could be shared.
 317 Setting this tunable to 1 allows the driver to perform certain
 318 optimization based on the knowledge that the interrupt is not shared.
 319 .It Va hw.igbX.npoll.txoff
 320 This tunable specifies the leading target CPU for
 321 transmission queue
 322 .Xr polling 4
 323 processing.
 324 The value specificed must be aligned to the number of transmission queues
 325 enabled and must be less than the power of 2 number of CPUs.
 326 .It Va hw.igbX.npoll.rxoff
 327 This tunable specifies the leading target CPU for
 328 reception queue
 329 .Xr polling 4
 330 processing.
 331 The value specificed must be aligned to the number of reception queues
 332 enabled and must be less than the power of 2 number of CPUs.
 333 .El
 334 .Sh MIB Variables
 335 A number of per-interface variables are implemented in the
 336 .Va hw.igb Ns Em X
 337 branch of the
 338 .Xr sysctl 3
 339 MIB.
 340 .Bl -tag -width "tx_intr_nsegs"
 341 .It Va rxr
 342 Number of reception queues could be enabled (read-only).
 343 Use the tunable
 344 .Va hw.igb.rxr
 345 or
 346 .Va hw.igbX.rxr
 347 to configure it.
 348 .It Va rxr_inuse
 349 Number of reception queues being used (read-only).
 350 .It Va txr
 351 Number of transmission queues could be enabled (read-only).
 352 Use the tunable
 353 .Va hw.igb.txr
 354 or
 355 .Va hw.igbX.txr
 356 to configure it.
 357 .It Va txr_inuse
 358 Number of transmission queues being used (read-only).
 359 .It Va rxd
 360 Number of descriptors per reception queue (read-only).
 361 Use the tunable
 362 .Va hw.igb.rxd
 363 or
 364 .Va hw.igbX.rxd
 365 to configure it.
 366 .It Va txd
 367 Number of descriptors per transmission queue (read-only).
 368 Use the tunable
 369 .Va hw.igb.txd
 370 or
 371 .Va hw.igbX.txd
 372 to configure it.
 373 .It Va intr_rate
 374 If MSI or legacy interrupt is used,
 375 this sysctl controls the highest possible frequency
 376 that interrupt could be generated by the device.
 377 It is 6000 by default (~150us).
 378 .It Va msixY_rate
 379 If MSI-X is used,
 380 this sysctl controls the highest possible frequency
 381 that interrupt could be generated by the
 382 .Em Y
 383 MSI-X vector.
 384 For reception processing only MSI-X vector,
 385 the default value is 6000 (~150us).
 386 For transmission processing only MSI-X vector,
 387 the default value is 4000 (250us).
 388 For MSI-X vector which handles both reception and transmission,
 389 the default value is 6000 (~150us).
 390 .It Va tx_intr_nsegs
 391 Transmission interrupt is asked to be generated upon every
 392 .Va tx_intr_nsegs
 393 transmission descritors having been setup.
 394 The default value is 1/16 of the number of transmission descriptors per queue.
 395 .It Va tx_wreg_nsegs
 396 The number of transmission descriptors should be setup
 397 before the hardware register is written.
 398 Setting this value too high will have negative effect
 399 on transmission timeliness.
 400 Setting this value too low will hurt overall transmission performance
 401 due to the frequent hardware register writing.
 402 The default value is 8.
 403 .It Va rx_wreg_nsegs
 404 The number of reception descriptors should be setup
 405 before the hardware register is written.
 406 Setting this value too high will make device drop incoming packets.
 407 Setting this value too low will hurt overall reception performance
 408 due to the frequent hardware register writing.
 409 The default value is 32.
 410 .It Va npoll_rxoff
 411 See the tunable
 412 .Va hw.igbX.npoll.rxoff .
 413 The set value will take effect the next time
 414 .Xr polling 4
 415 is enabled on the device.
 416 .It Va npoll_txoff
 417 See the tunable
 418 .Va hw.igbX.npoll.txoff .
 419 The set value will take effect the next time
 420 .Xr polling 4
 421 is enabled on the device.
 422 .El
 423 .\".Sh SUPPORT
 424 .\"For general information and support,
 425 .\"go to the Intel support website at:
 426 .\".Pa http://support.intel.com .
 427 .\".Pp
 428 .\"If an issue is identified with the released source code on the supported kernel
 429 .\"with a supported adapter, email the specific information related to the
 430 .\"issue to
 431 .\".Aq Mt freebsdnic@mailbox.intel.com .
 432 .Sh SEE ALSO
 433 .Xr altq 4 ,
 434 .Xr arp 4 ,
 435 .Xr em 4 ,
 436 .Xr emx 4 ,
 437 .Xr ifmedia 4 ,
 438 .Xr netintro 4 ,
 439 .Xr ng_ether 4 ,
 440 .Xr polling 4 ,
 441 .Xr vlan 4 ,
 442 .Xr ifconfig 8
 443 .Sh HISTORY
 444 The
 445 .Nm
 446 device driver first appeared in
 447 .Fx 7.1 .
 448 .Sh AUTHORS
 449 The
 450 .Nm
 451 driver was written by
 452 .An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com .