share/man/man4/ixgb.4

   1 .\" Copyright (c) 2001-2004, 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 August 18, 2006
  35 .Dt IXGB 4
  36 .Os
  37 .Sh NAME
  38 .Nm ixgb
  39 .Nd "Intel(R) PRO/10GbE 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 ixgb"
  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_ixgb_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Gigabit Ethernet adapters based on
  58 the Intel 82597EX Ethernet controller chips.
  59 The driver supports Transmit/Receive checksum offload
  60 and Jumbo Frames.
  61 .Pp
  62 For questions related to hardware requirements,
  63 refer to the documentation supplied with your Intel PRO/10GbE adapter.
  64 All hardware requirements listed apply to use with
  65 .Fx .
  66 .Pp
  67 Support for Jumbo Frames is provided via the interface MTU setting.
  68 Selecting an MTU larger than 1500 bytes with the
  69 .Xr ifconfig 8
  70 utility configures the adapter to receive and transmit Jumbo Frames.
  71 The maximum MTU size for Jumbo Frames is 16114.
  72 .Pp
  73 This driver version supports VLANs.
  74 For information on enabling VLANs, see
  75 .Xr ifconfig 8 .
  76 .Sh HARDWARE
  77 The
  78 .Nm
  79 driver supports the following cards:
  80 .Pp
  81 .Bl -bullet -compact
  82 .It
  83 Intel PRO/10GbE LR Server Adapter
  84 .It
  85 Intel PRO/10GbE SR Server Adapter
  86 .El
  87 .Sh DIAGNOSTICS
  88 .Bl -diag
  89 .It "ixgb%d: Unable to allocate bus resource: memory"
  90 A fatal initialization error has occurred.
  91 .It "ixgb%d: Unable to allocate bus resource: interrupt"
  92 A fatal initialization error has occurred.
  93 .It "ixgb%d: watchdog timeout -- resetting"
  94 The device has stopped responding to the network, or there is a problem with
  95 the network connection (cable).
  96 .El
  97 .Sh SUPPORT
  98 For general information and support,
  99 go to the Intel support website at:
 100 .Pa http://support.intel.com .
 101 .Pp
 102 If an issue is identified with the released source code on the supported kernel
 103 with a supported adapter, email the specific information related to the
 104 issue to
 105 .Aq freebsd@intel.com .
 106 .Sh SEE ALSO
 107 .Xr arp 4 ,
 108 .Xr em 4 ,
 109 .Xr netintro 4 ,
 110 .Xr ng_ether 4 ,
 111 .Xr polling 4 ,
 112 .Xr vlan 4 ,
 113 .Xr ifconfig 8
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 device driver first appeared in
 118 .Fx 4.11
 119 and
 120 .Fx 5.3 .
 121 .Sh AUTHORS
 122 The
 123 .Nm
 124 driver was written by
 125 .An Intel Corporation Aq freebsd@intel.com .