xref: /netbsd-src/share/man/man4/ixg.4 (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1.\" $NetBSD: ixg.4,v 1.6 2014/03/18 18:20:39 riastradh Exp $
2.\"
3.\" Copyright (c) 2001-2008, Intel Corporation
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions are met:
8.\"
9.\" 1. Redistributions of source code must retain the above copyright notice,
10.\"    this list of conditions and the following disclaimer.
11.\"
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" 3. Neither the name of the Intel Corporation nor the names of its
17.\"    contributors may be used to endorse or promote products derived from
18.\"    this software without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30.\" POSSIBILITY OF SUCH DAMAGE.
31.\"
32.\" * Other names and brands may be claimed as the property of others.
33.\"
34.\" $FreeBSD: src/share/man/man4/ixgbe.4,v 1.3 2010/12/19 23:54:31 yongari Exp $
35.\"
36.Dd July 25, 2011
37.Dt IXG 4
38.Os
39.Sh NAME
40.Nm ixg
41.Nd Intel(R) 10Gb Ethernet driver
42.Sh SYNOPSIS
43.Cd "ixg* at pci? dev ? function ?"
44.Sh DESCRIPTION
45The
46.Nm
47driver provides support for PCI 10Gb Ethernet adapters based on
48the Intel(R) 82598EB and 82599 10 GbE Controllers.
49The driver supports Jumbo Frames, TCP Segmentation Offload (TSO).
50.Pp
51For questions related to hardware requirements,
52refer to the documentation supplied with your Intel 10GbE adapter.
53All hardware requirements listed apply to use with
54.Nx .
55.Pp
56Support for Jumbo Frames is provided via the interface MTU setting.
57Selecting an MTU larger than 1500 bytes with the
58.Xr ifconfig 8
59utility configures the adapter to receive and transmit Jumbo Frames.
60On
61.Nx ,
62the maximum MTU size for Jumbo Frames is 9000 bytes.
63.Pp
64This driver version supports VLANs.
65For information on enabling VLANs, see
66.Xr ifconfig 8 .
67.Sh HARDWARE
68The
69.Nm
70driver supports the following cards:
71.Pp
72.Bl -bullet -compact
73.It
74Intel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter
75.It
76Intel(R) 10 Gigabit XF SR/LR Server Adapter
77.It
78Intel(R) 82598EB 10 Gigabit AF Network Connection
79.It
80Intel(R) 82598EB 10 Gigabit AT CX4 Network Connection
81.El
82.Sh DIAGNOSTICS
83.Bl -diag
84.It "ixg%d: Unable to allocate bus resource: memory"
85A fatal initialization error has occurred.
86.It "ixg%d: Unable to allocate bus resource: interrupt"
87A fatal initialization error has occurred.
88.It "ixg%d: watchdog timeout -- resetting"
89The device has stopped responding to the network, or there is a problem with
90the network connection (cable).
91.El
92.Sh SUPPORT
93For general information and support,
94go to the Intel support website at:
95.Lk http://www.intel.com/support/ .
96.\" .Pp
97.\" If an issue is identified with the released source code on the supported kernel
98.\" with a supported adapter, email the specific information related to the
99.\" issue to
100.\" .Aq freebsdnic@mailbox.intel.com .
101.Sh SEE ALSO
102.Xr arp 4 ,
103.Xr netintro 4 ,
104.Xr vlan 4 ,
105.Xr ifconfig 8
106.Sh HISTORY
107The
108.Nm
109device driver comes from
110.Fx ,
111where it is called
112.Xr ixgbe 4 .
113It first appeared in
114.Nx 6.0 .
115.Sh AUTHORS
116The
117.Nm
118driver was written by
119.An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com .
120It was imported from
121.Fx
122into
123.Nx
124by
125.An David Young Aq Mt dyoung@NetBSD.org .
126.Sh BUGS
127The hardware supports a maximum MTU of 16114 bytes, but the
128.Nx
129port of the driver supports only 9000 bytes.
130.Pp
131The hardware supports Message-Signalled Interrupts (MSI and MSI-X)
132and Receive-Side Scaling (RSS), however, these features are not
133enabled in the
134.Nx
135driver at this time.
136