1 .\" Copyright (c) 2001-2003, Intel Corporation
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions are met:
7 .\" 1. Redistributions of source code must retain the above copyright notice,
8 .\" this list of conditions and the following disclaimer.
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.
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.
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.
30 .\" * Other names and brands may be claimed as the property of others.
39 .Nd "Intel(R) PRO/1000 PCI Express Gigabit Ethernet adapter driver"
41 To compile this driver into the kernel,
42 place the following line in your
43 kernel configuration file:
44 .Bd -ragged -offset indent
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
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
61 Furthermore it supports TCP segmentation offload (TSO) on all
63 The identification LEDs of the adapters supported by the
65 driver can be controlled via the
67 API for localization purposes.
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
74 Support for Jumbo Frames is provided via the interface MTU setting.
75 Selecting an MTU larger than 1500 bytes with the
77 utility configures the adapter to receive and transmit Jumbo Frames.
78 The maximum MTU size for Jumbo Frames is 9216.
80 This driver supports hardware assisted VLANs.
83 driver supports the following media types:
84 .Bl -tag -width ".Cm 10baseT/UTP"
86 Enables auto-negotiation for speed and duplex.
88 Sets 10Mbps operation.
95 Sets 100Mbps operation.
102 Sets 1000Mbps operation.
105 mode is supported at this speed.
107 Sets 1000Mbps operation.
110 mode is supported at this speed.
115 driver supports the following media options:
116 .Bl -tag -width ".Cm full-duplex"
118 Forces full-duplex operation
120 Forces half-duplex operation.
129 is not specified, the driver defaults to
132 For more information on configuring this device, see
137 driver supports Gigabit Ethernet adapters based on the Intel 82575 and
138 82576 controller chips:
142 Intel Gigabit ET Dual Port Server Adapter (82576)
144 Intel Gigabit VT Quad Port Server Adapter (82575)
147 Tunables can be set at the
149 prompt before booting the kernel or stored in
151 .Bl -tag -width indent
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.
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.
178 .Bl -tag -width /dev/led/igb*
180 identification LED device nodes
183 Make the identification LED of igb0 blink:
185 .Dl "echo f2 > /dev/led/igb0"
187 Turn the identification LED of igb0 off again:
189 .Dl "echo 0 > /dev/led/igb0"
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).
201 For general information and support,
202 go to the Intel support website at:
203 .Pa http://support.intel.com .
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
208 .Aq freebsd@intel.com .
222 device driver first appeared in
227 driver was written by
228 .An Intel Corporation Aq freebsd@intel.com .