share/man/man4/ixgbe.4

   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$
  33 .\"
  34 .Dd June 11, 2008
  35 .Dt IXGBE 4
  36 .Os
  37 .Sh NAME
  38 .Nm ixgbe
  39 .Nd "Intel(R) 10Gb Ethernet driver for the FreeBSD operating system"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following line in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device ixgbe"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_ixgbe_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI 10Gb Ethernet adapters based on
  58 the Intel 82598EB Intel(R) Network Connections.
  59 The driver supports Jumbo Frames, MSIX, TSO, and RSS.
  60 .Pp
  61 For questions related to hardware requirements,
  62 refer to the documentation supplied with your Intel 10GbE adapter.
  63 All hardware requirements listed apply to use with
  64 .Fx .
  65 .Pp
  66 Support for Jumbo Frames is provided via the interface MTU setting.
  67 Selecting an MTU larger than 1500 bytes with the
  68 .Xr ifconfig 8
  69 utility configures the adapter to receive and transmit Jumbo Frames.
  70 The maximum MTU size for Jumbo Frames is 16114.
  71 .Pp
  72 This driver version supports VLANs.
  73 For information on enabling VLANs, see
  74 .Xr ifconfig 8 .
  75 .Sh HARDWARE
  76 The
  77 .Nm
  78 driver supports the following cards:
  79 .Pp
  80 .Bl -bullet -compact
  81 .It
  82 Intel(R) 10 Gigabit XF SR/AF Dual Port Server Adapter
  83 .It
  84 Intel(R) 10 Gigabit XF SR/LR Server Adapter
  85 .It
  86 Intel(R) 82598EB 10 Gigabit AF Network Connection
  87 .It
  88 Intel(R) 82598EB 10 Gigabit AT CX4 Network Connection
  89 .El
  90 .Sh DIAGNOSTICS
  91 .Bl -diag
  92 .It "ixgbe%d: Unable to allocate bus resource: memory"
  93 A fatal initialization error has occurred.
  94 .It "ixgbe%d: Unable to allocate bus resource: interrupt"
  95 A fatal initialization error has occurred.
  96 .It "ixgbe%d: watchdog timeout -- resetting"
  97 The device has stopped responding to the network, or there is a problem with
  98 the network connection (cable).
  99 .El
 100 .Sh SUPPORT
 101 For general information and support,
 102 go to the Intel support website at:
 103 .Pa http://support.intel.com .
 104 .Pp
 105 If an issue is identified with the released source code on the supported kernel
 106 with a supported adapter, email the specific information related to the
 107 issue to
 108 .Aq freebsdnic@mailbox.intel.com .
 109 .Sh SEE ALSO
 110 .Xr arp 4 ,
 111 .Xr netintro 4 ,
 112 .Xr ng_ether 4 ,
 113 .Xr polling 4 ,
 114 .Xr vlan 4 ,
 115 .Xr ifconfig 8
 116 .Sh HISTORY
 117 The
 118 .Nm
 119 device driver first appeared in
 120 .Fx 7.0 .
 121 .Sh AUTHORS
 122 The
 123 .Nm
 124 driver was written by
 125 .An Intel Corporation Aq freebsdnic@mailbox.intel.com .