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