xref: /freebsd/share/man/man4/ixgbe.4 (revision 7cc42f6d)
1.\" Copyright (c) 2001-2008, 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 July 17, 2019
35.Dt IXGBE 4
36.Os
37.Sh NAME
38.Nm ixgbe
39.Nd "Intel(R) 10Gb Ethernet driver for the FreeBSD operating system"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device iflib"
46.Cd "device ixgbe"
47.Ed
48.Pp
49Alternatively, to load the driver as a
50module at boot time, place the following line in
51.Xr loader.conf 5 :
52.Bd -literal -offset indent
53if_ixgbe_load="YES"
54.Ed
55.Sh DESCRIPTION
56The
57.Nm
58driver provides support for PCI 10Gb Ethernet adapters based on
59the Intel 82598EB Intel(R) Network Connections.
60The driver supports Jumbo Frames, MSIX, TSO, and RSS.
61.Pp
62For questions related to hardware requirements,
63refer to the documentation supplied with your Intel 10GbE adapter.
64All hardware requirements listed apply to use with
65.Fx .
66.Pp
67Support for Jumbo Frames is provided via the interface MTU setting.
68Selecting an MTU larger than 1500 bytes with the
69.Xr ifconfig 8
70utility configures the adapter to receive and transmit Jumbo Frames.
71The maximum MTU size for Jumbo Frames is 16114.
72.Pp
73This driver version supports VLANs.
74For information on enabling VLANs, see
75.Xr ifconfig 8 .
76.Sh HARDWARE
77The
78.Nm
79driver supports the following cards:
80.Pp
81.Bl -bullet -compact
82.It
83Intel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter
84.It
85Intel(R) 10 Gigabit XF SR/LR Server Adapter
86.It
87Intel(R) 82598EB 10 Gigabit AF Network Connection
88.It
89Intel(R) 82598EB 10 Gigabit AT CX4 Network Connection
90.El
91.Sh DIAGNOSTICS
92.Bl -diag
93.It "ixgbe%d: Unable to allocate bus resource: memory"
94A fatal initialization error has occurred.
95.It "ixgbe%d: Unable to allocate bus resource: interrupt"
96A fatal initialization error has occurred.
97.It "ixgbe%d: watchdog timeout -- resetting"
98The device has stopped responding to the network, or there is a problem with
99the network connection (cable).
100.El
101.Sh SUPPORT
102For general information and support,
103go to the Intel support website at:
104.Pa http://support.intel.com .
105.Pp
106If an issue is identified with the released source code on the supported kernel
107with a supported adapter, email the specific information related to the
108issue to
109.Aq Mt freebsd@intel.com .
110.Sh SEE ALSO
111.Xr altq 4 ,
112.Xr arp 4 ,
113.Xr iflib 4 ,
114.Xr netintro 4 ,
115.Xr ng_ether 4 ,
116.Xr polling 4 ,
117.Xr vlan 4 ,
118.Xr ifconfig 8
119.Sh HISTORY
120The
121.Nm
122device driver first appeared in
123.Fx 7.0 .
124.Sh AUTHORS
125The
126.Nm
127driver was written by
128.An Intel Corporation Aq Mt freebsd@intel.com .
129