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$
  33 .\"
  34 .Dd October 17, 2014
  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 igb"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_igb_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Express Gigabit Ethernet adapters
  58 based on the Intel 82575, 82576, 82580, i21x and i35x
  59 Ethernet controller chips.
  60 The driver supports Transmit/Receive checksum offload and Jumbo
  61 Frames.
  62 Furthermore it supports TCP segmentation offload (TSO) on all
  63 adapters.
  64 The identification LEDs of the adapters supported by the
  65 .Nm
  66 driver can be controlled via the
  67 .Xr led 4
  68 API for localization purposes.
  69 .Pp
  70 For questions related to hardware requirements, refer to the
  71 documentation supplied with your Intel PRO/1000 adapter.
  72 All hardware requirements listed apply to use with
  73 .Fx .
  74 .Pp
  75 Support for Jumbo Frames is provided via the interface MTU setting.
  76 Selecting an MTU larger than 1500 bytes with the
  77 .Xr ifconfig 8
  78 utility configures the adapter to receive and transmit Jumbo Frames.
  79 The maximum MTU size for Jumbo Frames is 9216.
  80 .Pp
  81 This driver supports hardware assisted VLANs.
  82 The
  83 .Nm
  84 driver supports the following media types:
  85 .Bl -tag -width ".Cm 10baseT/UTP"
  86 .It Cm autoselect
  87 Enables auto-negotiation for speed and duplex.
  88 .It Cm 10baseT/UTP
  89 Sets 10Mbps operation.
  90 Use the
  91 .Cm mediaopt
  92 option to select
  93 .Cm full-duplex
  94 mode.
  95 .It Cm 100baseTX
  96 Sets 100Mbps operation.
  97 Use the
  98 .Cm mediaopt
  99 option to select
 100 .Cm full-duplex
 101 mode.
 102 .It Cm 1000baseSX
 103 Sets 1000Mbps operation.
 104 Only
 105 .Cm full-duplex
 106 mode is supported at this speed.
 107 .It Cm 1000baseTX
 108 Sets 1000Mbps operation.
 109 Only
 110 .Cm full-duplex
 111 mode is supported at this speed.
 112 .El
 113 .Pp
 114 The
 115 .Nm
 116 driver supports the following media options:
 117 .Bl -tag -width ".Cm full-duplex"
 118 .It Cm full-duplex
 119 Forces full-duplex operation
 120 .It Cm half-duplex
 121 Forces half-duplex operation.
 122 .El
 123 .Pp
 124 Only use
 125 .Cm mediaopt
 126 to set the driver to
 127 .Cm full-duplex .
 128 If
 129 .Cm mediaopt
 130 is not specified, the driver defaults to
 131 .Cm half-duplex .
 132 .Pp
 133 For more information on configuring this device, see
 134 .Xr ifconfig 8 .
 135 .Sh HARDWARE
 136 The
 137 .Nm
 138 driver supports Gigabit Ethernet adapters based on the Intel 82575 and
 139 82576 controller chips:
 140 .Pp
 141 .Bl -bullet -compact
 142 .It
 143 Intel Gigabit ET Dual Port Server Adapter (82576)
 144 .It
 145 Intel Gigabit VT Quad Port Server Adapter (82575)
 146 .It
 147 Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)
 148 .It
 149 Intel i210 and i211 Gigabit Ethernet Controller
 150 .It
 151 Intel i350 and i354 Gigabit Ethernet Controller
 152 .El
 153 .Sh LOADER TUNABLES
 154 Tunables can be set at the
 155 .Xr loader 8
 156 prompt before booting the kernel or stored in
 157 .Xr loader.conf 5 .
 158 .Bl -tag -width indent
 159 .It Va hw.igb.rxd
 160 Number of receive descriptors allocated by the driver.
 161 The default value is 1024.
 162 The minimum is 80, and the maximum is 4096.
 163 .It Va hw.igb.txd
 164 Number of transmit descriptors allocated by the driver.
 165 The default value is 1024.
 166 The minimum is 80, and the maximum is 4096.
 167 .It Va hw.igb.enable_aim
 168 If set to 1, enable Adaptive Interrupt Moderation.
 169 The default is to enable Adaptive Interrupt Moderation.
 170 .It Va hw.igb.num_queues
 171 Number of queues used for data transfer.
 172 If set to 0, number of queues will be configured
 173 automatically based on number of CPUs and max
 174 supported MSI-X messages on the device.
 175 .It Va kern.ipc.nmbclusters
 176 The maximum number of mbuf clusters allowed.
 177 If the system has more than one igb card or jumbo frames are
 178 enabled, this value will need to be increased.
 179 .It Va kern.ipc.nmbjumbo9k
 180 The maximum number of mbuf 9k jumbo clusters allowed.
 181 Increasing this to allow for at least 8192 extra clusters
 182 per interface can allow for an mtu of 8192.
 183 .El
 184 .Sh FILES
 185 .Bl -tag -width /dev/led/igb*
 186 .It Pa /dev/led/igb*
 187 identification LED device nodes
 188 .El
 189 .Sh EXAMPLES
 190 Make the identification LED of igb0 blink:
 191 .Pp
 192 .Dl "echo f2 > /dev/led/igb0"
 193 .Pp
 194 Turn the identification LED of igb0 off again:
 195 .Pp
 196 .Dl "echo 0 > /dev/led/igb0"
 197 .Sh DIAGNOSTICS
 198 .Bl -diag
 199 .It "igb%d: Unable to allocate bus resource: memory"
 200 A fatal initialization error has occurred.
 201 .It "igb%d: Unable to allocate bus resource: interrupt"
 202 A fatal initialization error has occurred.
 203 .It "igb%d: watchdog timeout -- resetting"
 204 The device has stopped responding to the network, or there is a problem with
 205 the network connection (cable).
 206 .El
 207 .Sh SUPPORT
 208 For general information and support,
 209 go to the Intel support website at:
 210 .Pa http://support.intel.com .
 211 .Pp
 212 If an issue is identified with the released source code on the supported kernel
 213 with a supported adapter, email the specific information related to the
 214 issue to
 215 .Aq Mt freebsd@intel.com .
 216 .Sh SEE ALSO
 217 .Xr altq 4 ,
 218 .Xr arp 4 ,
 219 .Xr em 4 ,
 220 .Xr led 4 ,
 221 .Xr netintro 4 ,
 222 .Xr ng_ether 4 ,
 223 .Xr polling 4 ,
 224 .Xr vlan 4 ,
 225 .Xr ifconfig 8
 226 .Sh HISTORY
 227 The
 228 .Nm
 229 device driver first appeared in
 230 .Fx 7.1 .
 231 .Sh AUTHORS
 232 The
 233 .Nm
 234 driver was written by
 235 .An Intel Corporation Aq Mt freebsd@intel.com .