share/man/man4/cxgb.4

   1 .\" Copyright (c) 2007, Chelsio Inc
   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 Chelsio Inc 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 March 14, 2007
  35 .Dt CXGB 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgb
  39 .Nd "Chelsio T3 10 Gigabit Ethernet adapter driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device firmware"
  46 .Cd "device cxgb"
  47 .Ed
  48 .Pp
  49 To load the driver as a
  50 module at boot time, place the following line in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_cxgb_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver supports Transmit/Receive checksum offload,
  59 Jumbo Frames as well as TCP segmentation offload (TSO).
  60 For further hardware information, see
  61 .Pa http://www.chelsio.com/ .
  62 .Pp
  63 For questions related to hardware requirements,
  64 refer to the documentation supplied with your Chelsio T3 adapter.
  65 All hardware requirements listed apply to use with
  66 .Fx .
  67 .Pp
  68 Support for Jumbo Frames is provided via the interface MTU setting.
  69 Selecting an MTU larger than 1500 bytes with the
  70 .Xr ifconfig 8
  71 utility configures the adapter to receive and transmit Jumbo Frames.
  72 The maximum MTU size for Jumbo Frames is 9000.
  73 .Pp
  74 For more information on configuring this device, see
  75 .Xr ifconfig 8 .
  76 .Sh HARDWARE
  77 The
  78 .Nm
  79 driver supports 10 Gigabit Ethernet adapters based on the T3 and T3B chipset:
  80 .Pp
  81 .Bl -bullet -compact
  82 .It
  83 Chelsio 10GBase-CX4
  84 .It
  85 Chelsio 10GBase-LR
  86 .It
  87 Chelsio 10GBase-SR
  88 .El
  89 .Sh LOADER TUNABLES
  90 Tunables can be set at the
  91 .Xr loader 8
  92 prompt before booting the kernel or stored in
  93 .Xr loader.conf 5 .
  94 .Bl -tag -width indent
  95 .El
  96 .Sh DIAGNOSTICS
  97 .Bl -diag
  98 .It "cxgb%d: Unable to allocate bus resource: memory"
  99 A fatal initialization error has occurred.
 100 .It "cxgb%d: Unable to allocate bus resource: interrupt"
 101 A fatal initialization error has occurred.
 102 .It "cxgb%d: Could not find firmware image %s"
 103 The appropriate firmware kld module was not installed.
 104 This is a fatal initialization error.
 105 .El
 106 .Sh SUPPORT
 107 For general information and support,
 108 go to the Chelsio support website at:
 109 .Pa http://www.chelsio.com/ .
 110 .Pp
 111 If an issue is identified with the released source code on the supported kernel
 112 with a supported adapter, email the specific information related to the
 113 issue to
 114 .Aq help@chelsio.com .
 115 .Sh SEE ALSO
 116 .Xr altq 4 ,
 117 .Xr arp 4 ,
 118 .Xr netintro 4 ,
 119 .Xr ng_ether 4 ,
 120 .Xr ifconfig 8
 121 .Sh HISTORY
 122 The
 123 .Nm
 124 device driver first appeared in
 125 .Fx 6.3
 126 and
 127 .Fx 7.0 .
 128 .Sh AUTHORS
 129 .An -nosplit
 130 The
 131 .Nm
 132 driver was written by
 133 .An Kip Macy Aq kmacy@FreeBSD.org
 134 with substantial support from
 135 .An Scott Long Aq scottl@FreeBSD.org .