xref: /freebsd/share/man/man4/ix.4 (revision d8b48a267fc0f737a13cb52dc1071981ecb1e003)
1*d8b48a26SFelix Johnson.\" Copyright (c) 2001-2008, Intel Corporation
2*d8b48a26SFelix Johnson.\" All rights reserved.
3*d8b48a26SFelix Johnson.\"
4*d8b48a26SFelix Johnson.\" Redistribution and use in source and binary forms, with or without
5*d8b48a26SFelix Johnson.\" modification, are permitted provided that the following conditions are met:
6*d8b48a26SFelix Johnson.\"
7*d8b48a26SFelix Johnson.\" 1. Redistributions of source code must retain the above copyright notice,
8*d8b48a26SFelix Johnson.\"    this list of conditions and the following disclaimer.
9*d8b48a26SFelix Johnson.\"
10*d8b48a26SFelix Johnson.\" 2. Redistributions in binary form must reproduce the above copyright
11*d8b48a26SFelix Johnson.\"    notice, this list of conditions and the following disclaimer in the
12*d8b48a26SFelix Johnson.\"    documentation and/or other materials provided with the distribution.
13*d8b48a26SFelix Johnson.\"
14*d8b48a26SFelix Johnson.\" 3. Neither the name of the Intel Corporation nor the names of its
15*d8b48a26SFelix Johnson.\"    contributors may be used to endorse or promote products derived from
16*d8b48a26SFelix Johnson.\"    this software without specific prior written permission.
17*d8b48a26SFelix Johnson.\"
18*d8b48a26SFelix Johnson.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19*d8b48a26SFelix Johnson.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*d8b48a26SFelix Johnson.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*d8b48a26SFelix Johnson.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22*d8b48a26SFelix Johnson.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23*d8b48a26SFelix Johnson.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24*d8b48a26SFelix Johnson.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25*d8b48a26SFelix Johnson.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26*d8b48a26SFelix Johnson.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27*d8b48a26SFelix Johnson.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28*d8b48a26SFelix Johnson.\" POSSIBILITY OF SUCH DAMAGE.
29*d8b48a26SFelix Johnson.\"
30*d8b48a26SFelix Johnson.\" * Other names and brands may be claimed as the property of others.
31*d8b48a26SFelix Johnson.\"
32*d8b48a26SFelix Johnson.Dd May 17, 2023
33*d8b48a26SFelix Johnson.Dt IX 4
34*d8b48a26SFelix Johnson.Os
35*d8b48a26SFelix Johnson.Sh NAME
36*d8b48a26SFelix Johnson.Nm ix
37*d8b48a26SFelix Johnson.Nd "Intel(R) 10Gb Ethernet driver for the FreeBSD operating system"
38*d8b48a26SFelix Johnson.Sh SYNOPSIS
39*d8b48a26SFelix JohnsonTo compile this driver into the kernel,
40*d8b48a26SFelix Johnsonplace the following lines in your
41*d8b48a26SFelix Johnsonkernel configuration file:
42*d8b48a26SFelix Johnson.Bd -ragged -offset indent
43*d8b48a26SFelix Johnson.Cd "device iflib"
44*d8b48a26SFelix Johnson.Cd "device ix"
45*d8b48a26SFelix Johnson.Ed
46*d8b48a26SFelix Johnson.Pp
47*d8b48a26SFelix JohnsonAlternatively, to load the driver as a
48*d8b48a26SFelix Johnsonmodule at boot time, place the following line in
49*d8b48a26SFelix Johnson.Xr loader.conf 5 :
50*d8b48a26SFelix Johnson.Bd -literal -offset indent
51*d8b48a26SFelix Johnsonif_ix_load="YES"
52*d8b48a26SFelix Johnson.Ed
53*d8b48a26SFelix Johnson.Sh DESCRIPTION
54*d8b48a26SFelix JohnsonThe
55*d8b48a26SFelix Johnson.Nm
56*d8b48a26SFelix Johnsondriver provides support for PCI 10Gb Ethernet adapters based on
57*d8b48a26SFelix Johnsonthe Intel 82598EB Intel(R) Network Connections.
58*d8b48a26SFelix JohnsonThe driver supports Jumbo Frames, MSIX, TSO, and RSS.
59*d8b48a26SFelix Johnson.Pp
60*d8b48a26SFelix JohnsonFor questions related to hardware requirements,
61*d8b48a26SFelix Johnsonrefer to the documentation supplied with your Intel 10GbE adapter.
62*d8b48a26SFelix JohnsonAll hardware requirements listed apply to use with
63*d8b48a26SFelix Johnson.Fx .
64*d8b48a26SFelix Johnson.Pp
65*d8b48a26SFelix JohnsonSupport for Jumbo Frames is provided via the interface MTU setting.
66*d8b48a26SFelix JohnsonSelecting an MTU larger than 1500 bytes with the
67*d8b48a26SFelix Johnson.Xr ifconfig 8
68*d8b48a26SFelix Johnsonutility configures the adapter to receive and transmit Jumbo Frames.
69*d8b48a26SFelix JohnsonThe maximum MTU size for Jumbo Frames is 9710.
70*d8b48a26SFelix Johnson.Pp
71*d8b48a26SFelix JohnsonThis driver version supports VLANs.
72*d8b48a26SFelix JohnsonFor information on enabling VLANs, see
73*d8b48a26SFelix Johnson.Xr ifconfig 8 .
74*d8b48a26SFelix Johnson.Sh HARDWARE
75*d8b48a26SFelix JohnsonThe
76*d8b48a26SFelix Johnson.Nm
77*d8b48a26SFelix Johnsondriver supports the following cards:
78*d8b48a26SFelix Johnson.Pp
79*d8b48a26SFelix Johnson.Bl -bullet -compact
80*d8b48a26SFelix Johnson.It
81*d8b48a26SFelix JohnsonIntel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter
82*d8b48a26SFelix Johnson.It
83*d8b48a26SFelix JohnsonIntel(R) 10 Gigabit XF SR/LR Server Adapter
84*d8b48a26SFelix Johnson.It
85*d8b48a26SFelix JohnsonIntel(R) 82598EB 10 Gigabit AF Network Connection
86*d8b48a26SFelix Johnson.It
87*d8b48a26SFelix JohnsonIntel(R) 82598EB 10 Gigabit AT CX4 Network Connection
88*d8b48a26SFelix Johnson.El
89*d8b48a26SFelix Johnson.Sh DIAGNOSTICS
90*d8b48a26SFelix Johnson.Bl -diag
91*d8b48a26SFelix Johnson.It "ix%d: Unable to allocate bus resource: memory"
92*d8b48a26SFelix JohnsonA fatal initialization error has occurred.
93*d8b48a26SFelix Johnson.It "ix%d: Unable to allocate bus resource: interrupt"
94*d8b48a26SFelix JohnsonA fatal initialization error has occurred.
95*d8b48a26SFelix Johnson.It "ix%d: watchdog timeout -- resetting"
96*d8b48a26SFelix JohnsonThe device has stopped responding to the network, or there is a problem with
97*d8b48a26SFelix Johnsonthe network connection (cable).
98*d8b48a26SFelix Johnson.El
99*d8b48a26SFelix Johnson.Sh SUPPORT
100*d8b48a26SFelix JohnsonFor general information and support,
101*d8b48a26SFelix Johnsongo to the Intel support website at:
102*d8b48a26SFelix Johnson.Pa http://support.intel.com .
103*d8b48a26SFelix Johnson.Pp
104*d8b48a26SFelix JohnsonIf an issue is identified with the released source code on the supported kernel
105*d8b48a26SFelix Johnsonwith a supported adapter, email the specific information related to the
106*d8b48a26SFelix Johnsonissue to
107*d8b48a26SFelix Johnson.Aq Mt freebsd@intel.com .
108*d8b48a26SFelix Johnson.Sh SEE ALSO
109*d8b48a26SFelix Johnson.Xr altq 4 ,
110*d8b48a26SFelix Johnson.Xr arp 4 ,
111*d8b48a26SFelix Johnson.Xr iflib 4 ,
112*d8b48a26SFelix Johnson.Xr netintro 4 ,
113*d8b48a26SFelix Johnson.Xr ng_ether 4 ,
114*d8b48a26SFelix Johnson.Xr polling 4 ,
115*d8b48a26SFelix Johnson.Xr vlan 4 ,
116*d8b48a26SFelix Johnson.Xr ifconfig 8
117*d8b48a26SFelix Johnson.Sh HISTORY
118*d8b48a26SFelix JohnsonThe
119*d8b48a26SFelix Johnson.Nm
120*d8b48a26SFelix Johnsondevice driver first appeared in
121*d8b48a26SFelix Johnson.Fx 7.0 .
122*d8b48a26SFelix Johnson.Sh AUTHORS
123*d8b48a26SFelix JohnsonThe
124*d8b48a26SFelix Johnson.Nm
125*d8b48a26SFelix Johnsondriver was written by
126*d8b48a26SFelix Johnson.An Intel Corporation Aq Mt freebsd@intel.com .
127*d8b48a26SFelix Johnson.Sh CAVEATS
128*d8b48a26SFelix JohnsonIntel (R) Flow director support is not fully implemented in
129*d8b48a26SFelix Johnson.Fx
130*d8b48a26SFelix Johnsonat this time and additional work is required
131*d8b48a26SFelix Johnsonbefore those features can be supported.
132*d8b48a26SFelix Johnson.Pp
133*d8b48a26SFelix JohnsonEnabling flow director may route traffic to the wrong RX queue of the NIC,
134*d8b48a26SFelix Johnsonresulting in sub-optimal performance on the receive side.
135