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