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 6, 2008
  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 .Pp
  64 For questions related to hardware requirements, refer to the
  65 documentation supplied with your Intel PRO/1000 adapter.
  66 All hardware requirements listed apply to use with
  67 .Fx .
  68 .Pp
  69 Support for Jumbo Frames is provided via the interface MTU setting.
  70 Selecting an MTU larger than 1500 bytes with the
  71 .Xr ifconfig 8
  72 utility configures the adapter to receive and transmit Jumbo Frames.
  73 The maximum MTU size for Jumbo Frames is 9216.
  74 .Pp
  75 This driver supports hardware assisted VLANs.
  76 The
  77 .Nm
  78 driver supports the following media types:
  79 .Bl -tag -width ".Cm 10baseT/UTP"
  80 .It Cm autoselect
  81 Enables auto-negotiation for speed and duplex.
  82 .It Cm 10baseT/UTP
  83 Sets 10Mbps operation.
  84 Use the
  85 .Cm mediaopt
  86 option to select
  87 .Cm full-duplex
  88 mode.
  89 .It Cm 100baseTX
  90 Sets 100Mbps operation.
  91 Use the
  92 .Cm mediaopt
  93 option to select
  94 .Cm full-duplex
  95 mode.
  96 .It Cm 1000baseSX
  97 Sets 1000Mbps operation.
  98 Only
  99 .Cm full-duplex
 100 mode is supported at this speed.
 101 .It Cm 1000baseTX
 102 Sets 1000Mbps operation.
 103 Only
 104 .Cm full-duplex
 105 mode is supported at this speed.
 106 .El
 107 .Pp
 108 The
 109 .Nm
 110 driver supports the following media options:
 111 .Bl -tag -width ".Cm full-duplex"
 112 .It Cm full-duplex
 113 Forces full-duplex operation
 114 .It Cm half-duplex
 115 Forces half-duplex operation.
 116 .El
 117 .Pp
 118 Only use
 119 .Cm mediaopt
 120 to set the driver to
 121 .Cm full-duplex .
 122 If
 123 .Cm mediaopt
 124 is not specified, the driver defaults to
 125 .Cm half-duplex .
 126 .Pp
 127 For more information on configuring this device, see
 128 .Xr ifconfig 8 .
 129 .Sh HARDWARE
 130 The
 131 .Nm
 132 driver supports Gigabit Ethernet adapters based on the Intel 82575 and
 133 82576 controller chips:
 134 .Pp
 135 .Bl -bullet -compact
 136 .It
 137 Intel Gigabit ET Dual Port Server Adapter (82576)
 138 .It
 139 Intel Gigabit VT Quad Port Server Adapter (82575)
 140 .El
 141 .Sh LOADER TUNABLES
 142 Tunables can be set at the
 143 .Xr loader 8
 144 prompt before booting the kernel or stored in
 145 .Xr loader.conf 5 .
 146 .Bl -tag -width indent
 147 .It Va hw.igb.rxd
 148 Number of receive descriptors allocated by the driver.
 149 The default value is 256.
 150 The minimum is 80, and the maximum is 4096.
 151 .It Va hw.igb.txd
 152 Number of transmit descriptors allocated by the driver.
 153 The default value is 256.
 154 The minimum is 80, and the maximum is 4096.
 155 .It Va hw.igb.enable_aim
 156 If set to 1, enable Adaptive Interrupt Moderation.
 157 The default is to enable Adaptive Interrupt Moderation.
 158 .El
 159 .Sh DIAGNOSTICS
 160 .Bl -diag
 161 .It "igb%d: Unable to allocate bus resource: memory"
 162 A fatal initialization error has occurred.
 163 .It "igb%d: Unable to allocate bus resource: interrupt"
 164 A fatal initialization error has occurred.
 165 .It "igb%d: watchdog timeout -- resetting"
 166 The device has stopped responding to the network, or there is a problem with
 167 the network connection (cable).
 168 .El
 169 .Sh SUPPORT
 170 For general information and support,
 171 go to the Intel support website at:
 172 .Pa http://support.intel.com .
 173 .Pp
 174 If an issue is identified with the released source code on the supported kernel
 175 with a supported adapter, email the specific information related to the
 176 issue to
 177 .Aq freebsdnic@mailbox.intel.com .
 178 .Sh SEE ALSO
 179 .Xr altq 4 ,
 180 .Xr arp 4 ,
 181 .Xr em 4 ,
 182 .Xr netintro 4 ,
 183 .Xr ng_ether 4 ,
 184 .Xr polling 4 ,
 185 .Xr vlan 4 ,
 186 .Xr ifconfig 8
 187 .Sh HISTORY
 188 The
 189 .Nm
 190 device driver first appeared in
 191 .Fx 7.1 .
 192 .Sh AUTHORS
 193 The
 194 .Nm
 195 driver was written by
 196 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .