share/man/man4/jme.4

   1 .\" Copyright (c) 2008 Pyun YongHyeon
   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
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man4/jme.4,v 1.1 2008/05/27 01:59:17 yongari Exp $
  26 .\"
  27 .Dd May 24, 2013
  28 .Dt JME 4
  29 .Os
  30 .Sh NAME
  31 .Nm jme
  32 .Nd JMicron Gigabit/Fast Ethernet driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device miibus"
  39 .Cd "device jme"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 if_jme_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 device driver provides support for JMicron JMC250 PCI Express
  52 Gigabit Ethernet controllers and JMicron JMC260 PCI Express Fast
  53 Ethernet controllers.
  54 .Pp
  55 All LOMs supported by the
  56 .Nm
  57 driver have TCP/UDP/IP checksum offload for both transmit and receive,
  58 TCP segmentation offload (TSO),
  59 receive side scaling (RSS),
  60 multiple vector MSI-X,
  61 hardware VLAN tag stripping/insertion features,
  62 .\" Wake On Lan (WOL)
  63 an interrupt coalescing/moderation mechanism as well as
  64 a 64-bit multicast hash filter.
  65 Up to 4 reception queues can be enabled.
  66 By default, the
  67 .Nm
  68 driver will try enabling as many reception queues as allowed by
  69 the number of CPUs in the system.
  70 .Pp
  71 The JMC250 also supports Jumbo Frames (up to 9216 bytes), which can be
  72 configured via the interface MTU setting.
  73 Selecting an MTU larger than 1500 bytes with the
  74 .Xr ifconfig 8
  75 utility configures the adapter to receive and transmit Jumbo Frames.
  76 .Pp
  77 The
  78 .Nm
  79 driver supports the following media types:
  80 .Bl -tag -width ".Cm 10baseT/UTP"
  81 .It Cm autoselect
  82 Enable autoselection of the media type and options.
  83 The user can manually override
  84 the autoselected mode by adding media options to
  85 .Xr rc.conf 5 .
  86 .It Cm 10baseT/UTP
  87 Set 10Mbps operation.
  88 .It Cm 100baseTX
  89 Set 100Mbps (Fast Ethernet) operation.
  90 .It Cm 1000baseT
  91 Set 1000baseT operation over twisted pair.
  92 .El
  93 .Pp
  94 The
  95 .Nm
  96 driver supports the following media options:
  97 .Bl -tag -width ".Cm full-duplex"
  98 .It Cm full-duplex
  99 Force full duplex operation.
 100 .It Cm half-duplex
 101 Force half duplex operation.
 102 .El
 103 .Pp
 104 For more information on configuring this device, see
 105 .Xr ifconfig 8 .
 106 The
 107 .Nm
 108 driver supports
 109 .Xr polling 4 .
 110 .Ss Loader Tunables
 111 By default, the driver will use MSI-X if it is supported.
 112 This behavior can be turned off by setting the following tunable:
 113 .Em ( X
 114 is the device unit number):
 115 .Bd -literal -offset indent
 116 hw.jme.msix.enable=0
 117 hw.jmeX.msix.enable=0
 118 .Ed
 119 .Pp
 120 If MSI-X is used,
 121 the transmission queue MSI-X's target CPU
 122 can be specified using the following tunable:
 123 .Bd -literal -offset indent
 124 hw.jmeX.msix.txoff
 125 .Ed
 126 .Pp
 127 The maximum allowed value for this tunable is
 128 the power of 2 number of CPUs minus one.
 129 .Pp
 130 If MSI-X is used,
 131 the reception queue MSI-Xs' leading target CPU
 132 can be specified using the following tunable:
 133 .Bd -literal -offset indent
 134 hw.jmeX.msix.rxoff
 135 .Ed
 136 .Pp
 137 The value specificed must be aligned to the number of reception queues enabled
 138 and must be less than the power of 2 number of CPUs.
 139 .Pp
 140 If MSI-X is disabled,
 141 the driver will use MSI if it is supported.
 142 This behavior can be turned off by setting the following tunable:
 143 .Bd -literal -offset indent
 144 hw.jme.msi.enable=0
 145 hw.jmeX.msi.enable=0
 146 .Ed
 147 .Pp
 148 If MSI is used,
 149 MSI's target CPU can be changed by the following tunable:
 150 .Bd -literal -offset indent
 151 hw.jmeX.msi.cpu
 152 .Ed
 153 .Pp
 154 The maximum allowed value for this tunable is the number of CPUs minus one.
 155 .Pp
 156 Number of reception queues that can be enabled:
 157 .Bd -literal -offset indent
 158 hw.jme.rx_ring_count
 159 hw.jmeX.rx_ring_count
 160 .Ed
 161 .Pp
 162 Maximum allowed value for these tunables is 4
 163 and it must be power of 2 aligned.
 164 Setting these tunables to 0 allows driver to enable as many reception queues
 165 as allowed by the number of CPUs.
 166 .Pp
 167 Number of reception descriptors that can be used:
 168 .Bd -literal -offset indent
 169 hw.jme.rx_desc_count
 170 hw.jmeX.rx_desc_count
 171 .Ed
 172 .Pp
 173 Maximum allowed value for these tunables is 1024.
 174 .Pp
 175 Number of transmission descriptors that can be used:
 176 .Bd -literal -offset indent
 177 hw.jme.tx_desc_count
 178 hw.jmeX.tx_desc_count
 179 .Ed
 180 .Pp
 181 Maximum allowed value for these tunables is 1024.
 182 .Pp
 183 .Xr polling 4
 184 reception queues' leading target CPU can be specified by the following tunable:
 185 .Bd -literal -offset indent
 186 hw.jmeX.npoll.rxoff
 187 .Ed
 188 .Pp
 189 The value specificed must be aligned to the number of reception queues enabled
 190 and must be less than the power of 2 number of CPUs.
 191 .Pp
 192 .Xr polling 4
 193 transmission queue's target CPU can be specified by the following tunable:
 194 .Bd -literal -offset indent
 195 hw.jmeX.npoll.txoff
 196 .Ed
 197 .Pp
 198 The maximum allowed value for this tunable is
 199 the power of 2 number of CPUs minus one.
 200 .Ss MIB Variables
 201 A number of per-interface variables are implemented in the
 202 .Va hw.jme Ns Em X
 203 branch of the
 204 .Xr sysctl 3
 205 MIB.
 206 .Bl -tag -width "rx_ring_count"
 207 .It Va tx_coal_to
 208 Maximum amount of time to delay for TX completion interrupt in
 209 units of 1us.
 210 The accepted range is 1 to 65535, the default is 250 (250us).
 211 .It Va tx_coal_pkt
 212 Maximum number of packets to fire TX completion interrupt.
 213 The accepted range is 0 to 255, the default is 128.
 214 Packet count based TX interrupt coalescing could be disabled
 215 by setting this variable to 0.
 216 .It Va rx_coal_to
 217 Maximum amount of time to delay for RX completion interrupt in
 218 units of 1us.
 219 The accepted range is 1 to 65535, the default is 150 (150us).
 220 .It Va rx_coal_pkt
 221 Maximum number of packets to fire RX completion interrupt.
 222 The accepted range is 0 to 255, the default is 64.
 223 Packet count based RX interrupt coalescing could be disabled
 224 by setting this variable to 0.
 225 .It Va rx_desc_count
 226 Number of RX descriptors per-ring (read-only).
 227 Use the tunable
 228 .Va hw.jme.rx_desc_count
 229 to configure it.
 230 .It Va tx_desc_count
 231 Number of TX descriptors (read-only).
 232 Use the tunable
 233 .Va hw.jme.tx_desc_count
 234 to configure it.
 235 .It Va rx_ring_count
 236 Number of RX rings (read-only).
 237 Use the tunable
 238 .Va hw.jme.rx_ring_count
 239 to configure it.
 240 .It Va tx_wreg
 241 The number of transmission descriptors should be setup
 242 before the hardware register is written.
 243 Setting this value too high will have negative effect on
 244 transmission timeliness.
 245 Setting this value too low will hurt overall transmission
 246 due to the frequent hardware register writing.
 247 .It Va npoll_rxoff
 248 .Xr polling 4
 249 reception queues' leading target CPU.
 250 It has the same constraints as the tunable
 251 .Va hw.jmeX.npoll.rxoff .
 252 The set value will take effect the next time
 253 .Xr polling 4
 254 is enabled on the device.
 255 .It Va npoll_txoff
 256 .Xr polling 4
 257 transmission queue's target CPU.
 258 It has the same constraints as the tunable
 259 .Va hw.jmeX.npoll.txoff .
 260 The set value will take effect the next time
 261 .Xr polling 4
 262 is enabled on the device.
 263 .El
 264 .Sh SEE ALSO
 265 .Xr altq 4 ,
 266 .Xr arp 4 ,
 267 .Xr ifmedia 4 ,
 268 .Xr miibus 4 ,
 269 .Xr netintro 4 ,
 270 .Xr ng_ether 4 ,
 271 .Xr polling 4 ,
 272 .Xr vlan 4 ,
 273 .Xr ifconfig 8
 274 .Sh HISTORY
 275 The
 276 .Nm
 277 driver was written by
 278 .An Pyun YongHyeon
 279 .Aq yongari@FreeBSD.org .
 280 It first appeared in
 281 .Fx 7.1
 282 and was imported into
 283 .Dx 2.1 .
 284 Sepherosa Ziehau added the receive side scaling and
 285 multiple vector MSI-X support to
 286 .Dx .