share/man/man4/cxgbe.4

   1 .\" Copyright (c) 2011, 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 February 14, 2011
  35 .Dt CXGBE 4
  36 .Os
  37 .Sh NAME
  38 .Nm cxgbe
  39 .Nd "Chelsio T4 10Gb and 1Gb 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 cxgbe"
  46 .Ed
  47 .Pp
  48 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_cxgbe_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Express Ethernet adapters based on
  58 the Chelsio Terminator 4 (T4) ASIC.
  59 The driver supprts Jumbo Frames, Transmit/Receive checksum offload,
  60 TCP segmentation offload (TSO), Large Receive Offload (LRO), VLAN
  61 tag insertion/extraction, VLAN checksum offload, VLAN TSO, and
  62 Receive Side Steering (RSS).
  63 For further hardware information and questions related to hardware
  64 requirements, see
  65 .Pa http://www.chelsio.com/ .
  66 .Pp
  67 For more information on configuring this device, see
  68 .Xr ifconfig 8 .
  69 .Sh HARDWARE
  70 The
  71 .Nm
  72 driver supports 10Gb and 1Gb Ethernet adapters based on the T4 ASIC:
  73 .Pp
  74 .Bl -bullet -compact
  75 .It
  76 Chelsio T420-CR
  77 .It
  78 Chelsio T422-CR
  79 .It
  80 Chelsio T440-CR
  81 .It
  82 Chelsio T420-BCH
  83 .It
  84 Chelsio T440-BCH
  85 .It
  86 Chelsio T440-CH
  87 .It
  88 Chelsio T420-SO
  89 .It
  90 Chelsio T420-CX
  91 .It
  92 Chelsio T420-BT
  93 .It
  94 Chelsio T404-BT
  95 .El
  96 .Sh LOADER TUNABLES
  97 Tunables can be set at the
  98 .Xr loader 8
  99 prompt before booting the kernel or stored in
 100 .Xr loader.conf 5 .
 101 .Bl -tag -width indent
 102 .It Va hw.cxgbe.max_ntxq_10G_port
 103 The maximum number of tx queues to use for a 10Gb port.
 104 The default value is 8.
 105 .It Va hw.cxgbe.max_nrxq_10G_port
 106 The maximum number of rx queues to use for a 10Gb port.
 107 The default value is 8.
 108 .It Va hw.cxgbe.max_ntxq_1G_port
 109 The maximum number of tx queues to use for a 1Gb port.
 110 The default value is 2.
 111 .It Va hw.cxgbe.max_nrxq_1G_port
 112 The maximum number of rx queues to use for a 1Gb port.
 113 The default value is 2.
 114 .It Va hw.cxgbe.holdoff_timer_idx_10G
 115 .It Va hw.cxgbe.holdoff_timer_idx_1G
 116 The timer index value to use to delay interrupts.
 117 The holdoff timer list has the values 1, 5, 10, 50, 100, and 200
 118 by default (all values are in microseconds) and the index selects a
 119 value from this list.
 120 The default value is 1 for both 10Gb and 1Gb ports, which means the
 121 timer value is 5us.
 122 .It Va hw.cxgbe.holdoff_pktc_idx_10G
 123 .It Va hw.cxgbe.holdoff_pktc_idx_1G
 124 The packet-count index value to use to delay interrupts.
 125 The packet-count list has the values 1, 8, 16, and 32 by default
 126 and the index selects a value from this list.
 127 The default value is 2 for both 10Gb and 1Gb ports, which means 16
 128 packets (or the holdoff timer going off) before an interrupt is
 129 generated.
 130 .It Va hw.cxgbe.qsize_txq
 131 The size, in number of entries, of the descriptor ring used for a tx
 132 queue.
 133 A buf_ring of the same size is also allocated for additional
 134 software queuing.  See
 135 .Xr ifnet 9 .
 136 The default value is 1024.
 137 .It Va hw.cxgbe.qsize_rxq
 138 The size, in number of entries, of the descriptor ring used for an
 139 rx queue.
 140 The default value is 1024.
 141 .El
 142 .Sh SUPPORT
 143 For general information and support,
 144 go to the Chelsio support website at:
 145 .Pa http://www.chelsio.com/ .
 146 .Pp
 147 If an issue is identified with this driver with a supported adapter,
 148 email all the specific information related to the issue to
 149 .Aq support@chelsio.com .
 150 .Sh SEE ALSO
 151 .Xr altq 4 ,
 152 .Xr arp 4 ,
 153 .Xr cxgb 4 ,
 154 .Xr netintro 4 ,
 155 .Xr ng_ether 4 ,
 156 .Xr ifconfig 8
 157 .Sh HISTORY
 158 The
 159 .Nm
 160 device driver first appeared in
 161 .Fx 9.0
 162 .Sh AUTHORS
 163 .An -nosplit
 164 The
 165 .Nm
 166 driver was written by
 167 .An Navdeep Parhar Aq np@FreeBSD.org .