diff --git a/share/man/man4/ixgbe.4 b/share/man/man4/ixgbe.4 new file mode 100644 index 000000000000..88eb4a48af2a --- /dev/null +++ b/share/man/man4/ixgbe.4 @@ -0,0 +1,121 @@ +.\" Copyright (c) 2001-2008, Intel Corporation +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" 3. Neither the name of the Intel Corporation nor the names of its +.\" contributors may be used to endorse or promote products derived from +.\" this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.\" * Other names and brands may be claimed as the property of others. +.\" +.\" $FreeBSD$ +.\" +.Dd March 3, 2008 +.Dt IXGBE 4 +.Os +.Sh NAME +.Nm ixgbe +.Nd "10 Gigabit Ethernet driver for the FreeBSD operating system" +.Sh SYNOPSIS +.Cd "device ixgbe" +.Sh DESCRIPTION +The +.Nm +driver provides support for PCI 10Gb Ethernet adapters based on +the Intel 82598EB Intel(R) Network Connections. +The driver supports Jumbo Frames, MSIX, TSO, and RSS. +For a list of supported adapters, see the +.Pa README +included with the driver. +.Pp +For questions related to hardware requirements, +refer to the documentation supplied with your Intel 10GbE adapter. +All hardware requirements listed apply to use with +.Fx . +.Pp +Support for Jumbo Frames is provided via the interface MTU setting. +Selecting an MTU larger than 1500 bytes with the +.Xr ifconfig 8 +utility configures the adapter to receive and transmit Jumbo Frames. +The maximum MTU size for Jumbo Frames is 16114. +.Pp +This driver version supports VLANs. +For information on enabling VLANs, see the +.Pa README . +.Sh HARDWARE +The +.Nm +driver supports the following cards: +.Pp +.Bl -bullet -compact +.It +Intel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter +.It +Intel(R) 10 Gigabit XF SR/LR Server Adapter +.IT +Intel(R) 82598EB 10 Gigabit AF Network Connection +.IT +Intel(R) 82598EB 10 Gigabit AT CX4 Network Connection +.El +.Sh DIAGNOSTICS +.Bl -diag +.It "ixgbe%d: Unable to allocate bus resource: memory" +A fatal initialization error has occurred. +.It "ixgbe%d: Unable to allocate bus resource: interrupt" +A fatal initialization error has occurred. +.It "ixgbe%d: watchdog timeout -- resetting" +The device has stopped responding to the network, or there is a problem with +the network connection (cable). +.El +.Sh SUPPORT +For additional information regarding building and installation, +see the +.Pa README +included with the driver. +For general information and support, +go to the Intel support website at: +.Pa http://support.intel.com . +.Pp +If an issue is identified with the released source code on the supported kernel +with a supported adapter, email the specific information related to the +issue to +.Aq freebsdnic@mailbox.intel.com . +.Sh SEE ALSO +.Xr arp 4 , +.Xr gx 4 , +.Xr netintro 4 , +.Xr ng_ether 4 , +.Xr polling 4 , +.Xr vlan 4 , +.Xr ifconfig 8 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 7.0 . +.Sh AUTHORS +The +.Nm +driver was written by +.An Intel Corporation Aq freebsdnic@mailbox.intel.com .