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