xref: /dragonfly/share/man/man4/ix.4 (revision 82730a9c)
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: src/share/man/man4/ixgbe.4,v 1.2 2008/06/17 21:14:02 brueffer Exp $
33.\"
34.Dd December 30, 2013
35.Dt IX 4
36.Os
37.Sh NAME
38.Nm ix
39.Nd "Intel(R) 10Gb Ethernet 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 ix"
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_ix_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for PCI 10Gb Ethernet adapters based on
58the Intel
5982598EB,
6082599 and
61X540
62Intel(R) Network Connections.
63The driver supports Jumbo Frames, MSIX, TSO, and RSS.
64.Pp
65For questions related to hardware requirements,
66refer to the documentation supplied with your Intel 10GbE adapter.
67All hardware requirements listed apply to use with
68.Dx .
69.Pp
70Support for Jumbo Frames is provided via the interface MTU setting.
71Selecting an MTU larger than 1500 bytes with the
72.Xr ifconfig 8
73utility configures the adapter to receive and transmit Jumbo Frames.
74The maximum MTU size for Jumbo Frames is 16114.
75.Pp
76This driver version supports VLANs.
77For information on enabling VLANs, see
78.Xr ifconfig 8 .
79.Sh HARDWARE
80The
81.Nm
82driver supports the following cards:
83.Pp
84.Bl -bullet -compact
85.It
86Intel 10 Gigabit AF DA Dual Port Server Adapter
87.It
88Intel 10 Gigabit AT Server Adapter
89.It
90Intel 10 Gigabit AT2 Server Adapter
91.It
92Intel 10 Gigabit CX4 Dual Port Server Adapter
93.It
94Intel 10 Gigabit XF LR Server Adapter
95.It
96Intel 10 Gigabit XF SR Dual Port Server Adapter
97.It
98Intel 10 Gigabit XF SR Server Adapter
99.It
100Intel 82598 10 Gigabit Ethernet Controller
101.It
102Intel 82599 10 Gigabit Ethernet Controller
103.It
104Intel Ethernet Controller X540-AT2
105.It
106Intel Ethernet Converged Network Adapter X520 Series
107.It
108Intel Ethernet Converged Network Adapter X540-T1
109.It
110Intel Ethernet Converged Network Adapter X540-T2
111.It
112Intel Ethernet Server Adapter X520 Series
113.It
114Intel Ethernet Server Adapter X520-DA2
115.It
116Intel Ethernet Server Adapter X520-LR1
117.It
118Intel Ethernet Server Adapter X520-SR1
119.It
120Intel Ethernet Server Adapter X520-SR2
121.It
122Intel Ethernet Server Adapter X520-T2
123.El
124.Sh DIAGNOSTICS
125.Bl -diag
126.It "ix%d: Unable to allocate bus resource: memory"
127A fatal initialization error has occurred.
128.It "ix%d: Unable to allocate bus resource: interrupt"
129A fatal initialization error has occurred.
130.It "ix%d: watchdog timeout -- resetting"
131The device has stopped responding to the network, or there is a problem with
132the network connection (cable).
133.El
134.Sh SUPPORT
135For general information and support,
136go to the Intel support website at:
137.Pa http://support.intel.com .
138.Pp
139If an issue is identified with the released source code on the supported kernel
140with a supported adapter, email the specific information related to the
141issue to
142.Aq Mt freebsdnic@mailbox.intel.com .
143.Sh SEE ALSO
144.Xr arp 4 ,
145.Xr ifmedia 4 ,
146.Xr netintro 4 ,
147.Xr ng_ether 4 ,
148.Xr polling 4 ,
149.Xr vlan 4 ,
150.Xr ifconfig 8
151.Sh HISTORY
152The
153.Nm
154device driver first appeared in
155.Dx 3.1 .
156.Sh AUTHORS
157The
158.Nm
159driver was written by
160.An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com .
161