1.\" $NetBSD: ixg.4,v 1.14 2021/03/09 12:02:24 wiz 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 March 9, 2021 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, 82599, X540 and X550 Ethernet 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 DIAGNOSTICS 68.Bl -diag 69.It "ixg%d: Unable to allocate bus resource: memory" 70A fatal initialization error has occurred. 71.It "ixg%d: Unable to allocate bus resource: interrupt" 72A fatal initialization error has occurred. 73.It "ixg%d: watchdog timeout -- resetting" 74The device has stopped responding to the network, or there is a problem with 75the network connection (cable). 76.El 77.Sh SUPPORT 78For general information and support, 79go to the Intel support website at: 80.Lk http://www.intel.com/support/ . 81.\" .Pp 82.\" If an issue is identified with the released source code on the supported kernel 83.\" with a supported adapter, email the specific information related to the 84.\" issue to 85.\" .Aq freebsdnic@mailbox.intel.com . 86.Sh OPTIONS 87The 88.Nm 89driver doesn't use the common 90.Xr MCLGET 9 91interface and use the driver specific cluster allocation mechanism. 92If it's exhausted, the 93.Xr evcnt 9 94counter "ixgX qY Rx no jumbo mbuf" is incremented. 95If this is observed, 96the number can be changed by the following config parameter: 97.Bl -tag -width IXGBE_JCLNUM_MULTI -offset 3n 98.It Dv IXGBE_JCLNUM_MULTI 99The number of RX jumbo buffers (clusters) per queue is calculated by 100.Dv IXGBE_JCLNUM_MULTI 101* (number of rx descriptors). 102The total number of clusters per queue is available via the 103.Li hw.ixgN.num_jcl_per_queue 104.Xr sysctl 7 . 105.El 106.Sh SEE ALSO 107.Xr arp 4 , 108.Xr ixv 4 , 109.Xr netintro 4 , 110.Xr vlan 4 , 111.Xr ifconfig 8 112.Sh HISTORY 113The 114.Nm 115device driver comes from 116.Fx , 117where it is called 118.Nm ixgbe . 119It first appeared in 120.Nx 6.0 . 121.Sh AUTHORS 122The 123.Nm 124driver was written by 125.An Intel Corporation Aq Mt freebsdnic@mailbox.intel.com . 126It was imported from 127.Fx 128into 129.Nx 130by 131.An David Young Aq Mt dyoung@NetBSD.org . 132.Sh BUGS 133The hardware supports a maximum MTU of 16114 bytes, but the 134.Nx 135port of the driver supports only 9000 bytes. 136