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