share/man/man4/igc.4

   1 .\"-
   2 .\" Copyright 2021 Intel Corp
   3 .\" Copyright 2021 Rubicon Communications, LLC (Netgate)
   4 .\" SPDX-License-Identifier: BSD-3-Clause
   5 .\"
   6 .Dd May 10, 2021
   7 .Dt IGC 4
   8 .Os
   9 .Sh NAME
  10 .Nm igc
  11 .Nd "Intel Ethernet Controller I225 driver"
  12 .Sh SYNOPSIS
  13 To compile this driver into the kernel,
  14 place the following lines in your
  15 kernel configuration file:
  16 .Bd -ragged -offset indent
  17 .Cd "device iflib"
  18 .Cd "device igc"
  19 .Ed
  20 .Pp
  21 Alternatively, to load the driver as a
  22 module at boot time, place the following line in
  23 .Xr loader.conf 5 :
  24 .Bd -literal -offset indent
  25 if_igc_load="YES"
  26 .Ed
  27 .Sh DESCRIPTION
  28 The
  29 .Nm
  30 driver provides support for any PCI Express adapter or LOM (LAN
  31 On Motherboard) based on the Intel I225 Multi Gigabit Controller.
  32 The driver supports Transmit/Receive checksum offload, Jumbo Frames,
  33 MSI/MSI-X, TSO, and RSS.
  34 .Pp
  35 Support for Jumbo Frames is provided via the interface MTU setting.
  36 Selecting an MTU larger than 1500 bytes with the
  37 .Xr ifconfig 8
  38 utility
  39 configures the adapter to receive and transmit Jumbo Frames.
  40 The maximum MTU size for Jumbo Frames is 9216 bytes.
  41 .Pp
  42 This driver version supports VLAN hardware insertion / extraction, and
  43 VLAN checksum offload.
  44 For information on enabling VLANs, see
  45 .Xr ifconfig 8 .
  46 The
  47 .Nm
  48 driver supports the following media types:
  49 .Bl -tag -width ".Cm 10baseT/UTP"
  50 .It Cm autoselect
  51 Enables auto-negotiation for speed and duplex.
  52 .It Cm 10baseT/UTP
  53 Sets 10Mbps operation.
  54 Use the
  55 .Cm mediaopt
  56 option to select
  57 .Cm half-duplex
  58 mode.
  59 .It Cm 100baseTX
  60 Sets 100Mbps operation.
  61 Use the
  62 .Cm mediaopt
  63 option to select
  64 .Cm half-duplex
  65 mode.
  66 .It Cm 1000baseT
  67 Sets 1000Mbps operation.
  68 Only
  69 .Cm full-duplex
  70 mode is supported at this speed.
  71 .It Cm 2500baseT
  72 Sets 2500Mbps operation.
  73 Only
  74 .Cm full-duplex
  75 mode is supported at this speed.
  76 .El
  77 .Sh HARDWARE
  78 The
  79 .Nm
  80 driver supports the following models:
  81 .Pp
  82 .Bl -bullet -compact
  83 .It
  84 I225-LM
  85 .It
  86 I225-V
  87 .It
  88 I225-IT
  89 .It
  90 I225-K
  91 .El
  92 .Sh LOADER TUNABLES
  93 Tunables can be set at the
  94 .Xr loader 8
  95 prompt before booting the kernel or stored in
  96 .Xr loader.conf 5 .
  97 .Bl -tag -width indent
  98 .It Va hw.igc.igc_disable_crc_stripping
  99 Disable or enable hardware stripping of CRC field.
 100 This is mostly useful on BMC/IPMI shared interfaces where stripping the
 101 CRC causes remote access over IPMI to fail.
 102 Default 0 (enabled).
 103 .It Va hw.igc.rx_int_delay
 104 This value delays the generation of receive interrupts in units
 105 of 1.024 microseconds.
 106 The default value is 0, since adapters may hang with this feature being
 107 enabled.
 108 .It Va hw.igc.rx_abs_int_delay
 109 If hw.igc.rx_int_delay is non-zero, this tunable limits the
 110 maximum delay in which a receive interrupt is generated.
 111 .It Va hw.igc.tx_int_delay
 112 This value delays the generation of transmit interrupts in units
 113 of 1.024 microseconds.
 114 The default value is 64.
 115 .It Va hw.igc.tx_abs_int_delay
 116 If hw.igc.tx_int_delay is non-zero, this tunable limits the
 117 maximum delay in which a transmit interrupt is generated.
 118 .It Va hw.igc.sbp
 119 Show bad packets when in promiscuous mode.
 120 Default is false.
 121 .It Va hw.igc.rx_process_limit
 122 Maximum number of received packets to process at a time.
 123 Default is 100.
 124 A value of -1 means unlimited.
 125 .It Va hw.igc.eee_setting
 126 Disable or enable Energy Efficient Ethernet.
 127 Default 1 (disabled).
 128 .It Va hw.igc.max_interrupt_rate
 129 Maximum device interrupts per second.
 130 The default is 8000.
 131 .El
 132 .Sh DIAGNOSTICS
 133 .Bl -diag
 134 .It "igc%d: Hardware Initialization Failed"
 135 A fatal initialization error has occurred.
 136 .It "igc%d: Unable to allocate bus resource: memory"
 137 A fatal initialization error has occurred.
 138 .It "igc%d: Invalid MAC address"
 139 The MAC address programmed into the EEPROM is either empty or a multicast/broadcast
 140 address.
 141 .El
 142 .Sh SEE ALSO
 143 .Xr altq 4 ,
 144 .Xr arp 4 ,
 145 .Xr iflib 4 ,
 146 .Xr netintro 4 ,
 147 .Xr ng_ether 4 ,
 148 .Xr vlan 4 ,
 149 .Xr ifconfig 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 device driver first appeared in
 154 .Fx 14.0 .
 155 .Sh AUTHORS
 156 .An -nosplit
 157 The
 158 .Nm
 159 was originally written by
 160 .An Intel Corporation
 161 and converted to the
 162 .Xr iflib 4
 163 framework by
 164 .An Netgate .