1 .\" Copyright (c) 2001-2003, Intel Corporation
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" this list of conditions and the following disclaimer.
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.
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.
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.
30 .\" * Other names and brands may be claimed as the property of others.
32 .\" $FreeBSD: src/share/man/man4/igb.4,v 1.2 2010/05/14 20:11:30 marius Exp $
39 .Nd "Intel(R) PRO/1000 PCI Express Gigabit Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following line in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
49 Alternatively, to load the driver as a
50 module at boot time, place the following line in
52 .Bd -literal -offset indent
59 driver provides support for PCI Express Gigabit Ethernet adapters based on
67 Ethernet controller chips.
72 .Bl -item -offset indent -compact
74 Transmit/Receive checksum offload for IP/UDP/TCP.
79 TCP segmentation offload (TSO)
81 Receive side scaling (RSS)
83 Multiple tranmission queues
87 VLAN tag stripping and inserting
96 driver will try enabling as many reception queues and transmission queues
97 as are allowed by the number of CPUs in the system.
99 If multiple transmission queues are used,
100 the round-robin arbitration is performed among the transmission queues.
101 It should be noted that
102 if both TSO and multiple transmission queues are used,
103 for 82575, the round-robin arbitration between transmission queues is done
104 at the TSO packet boundary;
105 for the reset of the hardware, the round-robin arbitration
106 between transmission queues is done at the TCP segment boundary after
107 the hardware segmentation is performed.
109 82575 supports 4 reception queues and 4 transmission queues.
110 MSI-X is not enabled due to hardware errata.
111 Under MSI or legacy interrupt mode,
112 2 reception queues are enabled for hardware RSS hash
113 and only 1 transmission queue is enable.
115 82576 supports 16 reception queues and 16 transmission queues.
116 MSI-X is enable by default.
118 due to the number of MSI-X vectors is 10,
119 at most 8 reception queues and 8 transmission queues will be enabled
123 is enabled on the devices,
124 at most 16 reception queues and 16 transmission queues will be enabled.
127 I350 and I354 support 8 reception queues and 8 transmission queues.
128 MSI-X is enabled by default.
130 I210 supports 4 reception queues and 4 transmission queues.
131 MSI-X is enabled by default.
133 I211 supports 2 reception queues and 2 transmission queues.
134 MSI-X is enabled by default.
136 .\"For questions related to hardware requirements, refer to the
137 .\"documentation supplied with your Intel PRO/1000 adapter.
138 .\"All hardware requirements listed apply to use with
141 .\"Support for Jumbo Frames is provided via the interface MTU setting.
142 .\"Selecting an MTU larger than 1500 bytes with the
144 .\"utility configures the adapter to receive and transmit Jumbo Frames.
145 .\"The maximum MTU size for Jumbo Frames is 9216.
149 driver supports the following media types:
150 .Bl -tag -width ".Cm 10baseT/UTP"
152 Enables auto-negotiation for speed and duplex.
154 Sets 10Mbps operation.
161 Sets 100Mbps operation.
168 Sets 1000Mbps operation.
171 mode is supported at this speed.
173 Sets 1000Mbps operation.
176 mode is supported at this speed.
181 driver supports the following media options:
182 .Bl -tag -width ".Cm full-duplex"
184 Forces full-duplex operation
186 Forces half-duplex operation.
188 Enable flow control PAUSE reception.
189 This is only supported by
195 Enable flow control PAUSE transmission.
196 This is only supported by
202 Force flow control PAUSE operation as configured by
215 is not specified, the driver defaults to
218 For more information on configuring this device, see
227 driver supports Gigabit Ethernet adapters based on the Intel
238 Intel 82576EB Gigabit Ethernet Controller
240 Intel 82576NS Gigabit Ethernet Controller
242 Intel 82580EB Gigabit Ethernet Controller
244 Intel Ethernet Server Adapter I340-F4
246 Intel Ethernet Server Adapter I340-T4
248 Intel Gigabit ET2 Quad Port Server Adapter
250 Intel Gigabit VT Quad Port Server Adapter
252 Intel 82575EB Gigabit Ethernet Controller
254 Intel Gigabit EF Dual Port Server Adapter
256 Intel Gigabit ET Dual Port Server Adapter
258 Intel Gigabit ET Quad Port Server Adapter
260 Intel Ethernet Controller I350-AM4
262 Intel Ethernet Controller I350-BT2
264 Intel Ethernet Controller I350-AM2
266 Intel Ethernet Server Adapter I350-T2
268 Intel Ethernet Server Adapter I350-T4
270 Intel Ethernet Server Adapter I350-F2
272 Intel Ethernet Server Adapter I350-F4
274 Intel Ethernet Controller I210-AT
276 Intel Ethernet Controller I210-IS
278 Intel Ethernet Controller I210-IT
280 Intel Ethernet Controller I211-AT
282 Intel Ethernet Server Adapter I210-T1
284 Intel Ethernet Controller I210-AS
286 Intel Ethernet Controller I210-CS
289 Tunables can be set at the
291 prompt before booting the kernel or stored in
294 is the device unit number.
295 .Bl -tag -width ".Va hw.igbX.irq.unshared"
296 .It Va hw.igb.rxd Va hw.igbX.rxd
297 Number of receive descriptors allocated by the driver.
298 The default value is 512.
300 and the maximum is 4096.
301 .It Va hw.igb.txd Va hw.igbX.txd
302 Number of transmit descriptors allocated by the driver.
303 The default value is 1024.
305 and the maximum is 4096.
306 .It Va hw.igb.rxr Va hw.igbX.rxr
307 This tunable specifies the number of reception queues could be enabled.
308 Maximum allowed value for these tunables is device specific
309 and it must be power of 2 aligned.
310 Setting these tunables to 0 allows the driver to make
311 as many reception queues ready-for-use as allowed by the number of CPUs.
312 .It Va hw.igb.txr Va hw.igbX.txr
313 This tunable specifies the number of transmission queues could be enabled.
314 Maximum allowed value for these tunables is device specific
315 and it must be power of 2 aligned.
316 Setting these tunables to 0 allows the driver to make
317 as many transmission queues ready-for-use as allowed by the number of CPUs.
318 .It Va hw.igb.msix.enable Va hw.igbX.msix.enable
320 the driver will use MSI-X if it is supported.
321 This behaviour can be turned off by setting this tunable to 0.
322 .It Va hw.igb.msix.agg_rxtx Va hw.igbX.msix.agg_rxtx
324 the driver aggregates transmission queue and reception queue processing
326 This behaviour could be turned off by setting this tunable to 0.
327 If the number of MSI-X vectors is not enough to
328 put transmission queue processing and reception queue processing
329 onto independent MSI-X vector,
330 then transmission queue and reception queue processing are always
332 .It Va hw.igbX.msix.off
334 and transmission queue and reception queue processing are aggregated,
335 this tunable specifies the leading target CPU for
336 transmission and reception queues processing.
337 The value specificed must be aligned to the maximum of
338 the number of reception queues
339 and the number of transmission queues enabled,
340 and must be less than the power of 2 number of CPUs.
341 .It Va hw.igbX.msix.rxoff
343 and transmission queue and reception queue processing are not aggregated,
344 this tunable specifies the leading target CPU for reception queues processing.
345 The value specificed must be aligned to the number of reception queues enabled
346 and must be less than the power of 2 number of CPUs.
347 .It Va hw.igbX.msix.txoff
349 and transmission queue and reception queue processing are not aggregated,
350 this tunable specifies the leading target CPU
351 for transmission queues processing.
352 The value specificed must be aligned to
353 the number of transmission queues enabled
354 and must be less than the power of 2 number of CPUs.
355 .It Va hw.igb.msi.enable Va hw.igbX.msi.enable
356 If MSI-X is disabled and MSI is supported,
357 the driver will use MSI.
358 This behavior can be turned off by setting this tunable to 0.
359 .It Va hw.igbX.msi.cpu
361 it specifies the MSI's target CPU.
362 .It Va hw.igbX.irq.unshared
363 If legacy interrupt is used,
365 the driver assumes the interrupt could be shared.
366 Setting this tunable to 1 allows the driver to perform certain
367 optimization based on the knowledge that the interrupt is not shared.
368 .It Va hw.igbX.npoll.txoff
369 This tunable specifies the leading target CPU for
373 The value specificed must be aligned to the number of transmission queues
374 enabled and must be less than the power of 2 number of CPUs.
375 .It Va hw.igbX.npoll.rxoff
376 This tunable specifies the leading target CPU for
380 The value specificed must be aligned to the number of reception queues
381 enabled and must be less than the power of 2 number of CPUs.
382 .It Va hw.igb.flow_ctrl Va hw.igbX.flow_ctrl
383 The default flow control settings.
384 Supported values are:
385 rxpause (only enable PAUSE reception),
386 txpause (only enable PAUSE transmission),
387 full (enable PAUSE reception and transmission),
388 none (disable flow control PAUSE operation),
389 force-rxpause (force PAUSE reception),
390 force-txpause (force PAUSE transmission),
391 force-full (forcefully enable PAUSE reception and transmission),
392 force-none (forcefully disable flow control PAUSE operation).
396 A number of per-interface variables are implemented in the
401 .Bl -tag -width "rxtx_intr_rate"
403 Number of reception queues could be enabled (read-only).
410 Number of reception queues being used (read-only).
412 Number of transmission queues could be enabled (read-only).
419 Number of transmission queues being used (read-only).
421 Number of descriptors per reception queue (read-only).
428 Number of descriptors per transmission queue (read-only).
434 .It Va rxtx_intr_rate
435 If MSI or legacy interrupt is used,
436 this sysctl controls the highest possible frequency
437 that interrupt could be generated by the device.
439 this sysctl controls the highest possible frequency
440 that interrupt could be generated by the MSI-X vectors,
441 which aggregate transmission queue and reception queue procecssing.
442 It is 6000 by default (~150us).
445 this sysctl controls the highest possible frequency
446 that interrupt could be generated by the MSI-X vectors,
447 which only process reception queue.
448 It is 6000 by default (~150us).
451 this sysctl controls the highest possible frequency
452 that interrupt could be generated by the MSI-X vectors,
453 which only process transmission queue.
454 It is 4000 by default (250us).
457 this sysctl controls the highest possible frequency
458 that interrupt could be generated by the MSI-X vectors,
459 which only process chip status changes.
460 It is 6000 by default (~150us).
462 Transmission interrupt is asked to be generated upon every
464 transmission descritors having been setup.
465 The default value is 1/16 of the number of transmission descriptors per queue.
467 The number of transmission descriptors should be setup
468 before the hardware register is written.
469 Setting this value too high will have negative effect
470 on transmission timeliness.
471 Setting this value too low will hurt overall transmission performance
472 due to the frequent hardware register writing.
473 The default value is 8.
475 The number of reception descriptors should be setup
476 before the hardware register is written.
477 Setting this value too high will make device drop incoming packets.
478 Setting this value too low will hurt overall reception performance
479 due to the frequent hardware register writing.
480 The default value is 32.
483 .Va hw.igbX.npoll.rxoff .
484 The set value will take effect the next time
486 is enabled on the device.
489 .Va hw.igbX.npoll.txoff .
490 The set value will take effect the next time
492 is enabled on the device.
495 .\"For general information and support,
496 .\"go to the Intel support website at:
497 .\".Pa http://support.intel.com .
499 .\"If an issue is identified with the released source code on the supported kernel
500 .\"with a supported adapter, email the specific information related to the
502 .\".Aq Mt freebsdnic@mailbox.intel.com .
515 device driver first appeared in
520 driver was written by
521 .An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com .