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$
  26 .\"
  27 .Dd March 4, 2012
  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 JMC25x PCI Express
  52 Gigabit Ethernet controllers and JMicron JMC26x 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), hardware VLAN tag stripping/insertion
  59 features, Wake On Lan (WOL) and an interrupt coalescing/moderation
  60 mechanism as well as a 64-bit multicast hash filter.
  61 .Pp
  62 The JMC25x also supports Jumbo Frames (up to 9216 bytes), which can be
  63 configured via the interface MTU setting.
  64 Selecting an MTU larger than 1500 bytes with the
  65 .Xr ifconfig 8
  66 utility configures the adapter to receive and transmit Jumbo Frames.
  67 .Pp
  68 The
  69 .Nm
  70 driver supports the following media types:
  71 .Bl -tag -width ".Cm 10baseT/UTP"
  72 .It Cm autoselect
  73 Enable autoselection of the media type and options.
  74 The user can manually override
  75 the autoselected mode by adding media options to
  76 .Xr rc.conf 5 .
  77 .It Cm 10baseT/UTP
  78 Set 10Mbps operation.
  79 .It Cm 100baseTX
  80 Set 100Mbps (Fast Ethernet) operation.
  81 .It Cm 1000baseTX
  82 Set 1000baseTX operation over twisted pair.
  83 .El
  84 .Pp
  85 The
  86 .Nm
  87 driver supports the following media options:
  88 .Bl -tag -width ".Cm full-duplex"
  89 .It Cm full-duplex
  90 Force full duplex operation.
  91 .It Cm half-duplex
  92 Force half duplex operation.
  93 .El
  94 .Pp
  95 For more information on configuring this device, see
  96 .Xr ifconfig 8 .
  97 .Sh HARDWARE
  98 The
  99 .Nm
 100 device driver provides support for the following Ethernet controllers:
 101 .Pp
 102 .Bl -bullet -compact
 103 .It
 104 JMicron JMC250 PCI Express Gigabit Ethernet controller
 105 .It
 106 JMicron JMC251 PCI Express Gigabit Ethernet with Card Read Host controller
 107 .It
 108 JMicron JMC260 PCI Express Fast Ethernet controller
 109 .It
 110 JMicron JMC261 PCI Express Gigabit Ethernet with Card Read Host controller
 111 .El
 112 .Sh LOADER TUNABLES
 113 Tunables can be set at the
 114 .Xr loader 8
 115 prompt before booting the kernel or stored in
 116 .Xr loader.conf 5 .
 117 .Bl -tag -width "xxxxxx"
 118 .It Va hw.jme.msi_disable
 119 This tunable disables MSI support on the Ethernet hardware.
 120 The default value is 0.
 121 .It Va hw.jme.msix_disable
 122 This tunable disables MSI-X support on the Ethernet hardware.
 123 The default value is 0.
 124 .El
 125 .Sh SYSCTL VARIABLES
 126 The following variables are available as both
 127 .Xr sysctl 8
 128 variables and
 129 .Xr loader 8
 130 tunables:
 131 .Bl -tag -width "xxxxxx"
 132 .It Va dev.jme.%d.tx_coal_to
 133 This variable sets the maximum amount of time to delay
 134 before sending a Tx completion interrupt, in microseconds.
 135 The accepted range is 1 to 65535; the default is 100 (100us).
 136 .It Va dev.jme.%d.tx_coal_pkt
 137 This variable sets the maximum number of outgoing packets which may be
 138 coalesced together into a single Tx completion interrupt.
 139 The accepted range is 1 to 255; the default is 8.
 140 .It Va dev.jme.%d.rx_coal_to
 141 This variable sets the maximum amount of time to wait for
 142 additional packets to arrive (for possible packet coalescing)
 143 before firing an Rx completion interrupt, in microseconds.
 144 The accepted range is 1 to 65535; the default is 100 (100us).
 145 .It Va dev.jme.%d.rx_coal_pkt
 146 This variable sets the maximum number of incoming packets which may be
 147 coalesced into a single Rx completion interrupt.
 148 The accepted range is 1 to 255; the default is 2.
 149 .It Va dev.jme.%d.process_limit
 150 This variable sets the maximum number of events that will be processed
 151 in a single batch before the handler is requeued into a taskqueue.
 152 The accepted range is 10 to 255; the default value is 128 events.
 153 The interface does not need to be brought down and up again before
 154 a change takes effect.
 155 .El
 156 .Sh SEE ALSO
 157 .Xr altq 4 ,
 158 .Xr arp 4 ,
 159 .Xr miibus 4 ,
 160 .Xr netintro 4 ,
 161 .Xr ng_ether 4 ,
 162 .Xr vlan 4 ,
 163 .Xr ifconfig 8
 164 .Sh HISTORY
 165 The
 166 .Nm
 167 driver was written by
 168 .An Pyun YongHyeon
 169 .Aq yongari@FreeBSD.org .
 170 It first appeared in
 171 .Fx 7.1 .
 172 .Sh CAVEATS
 173 The
 174 .Nm
 175 driver tries to avoid unnecessary station address reprogramming for
 176 controllers that use eFuse to store station address.
 177 The number of times that eFuse can be safely reprogrammed is 16 at
 178 most.
 179 In addition, there is no way to restore the factory default station
 180 address once the station address has been reprogrammed via eFuse.
 181 It is highly recommended not to reprogram the station address and
 182 it is the responsibility of the administrator to store the original station
 183 address in a safe place when station address is changed.
 184 .Pp
 185 There are two known 1000baseT link establishment issues with JMC25x.
 186 If the full mask revision number of JMC25x controller is less than
 187 or equal to 4 and the link partner enabled the IEEE 802.3az Energy Efficient
 188 Ethernet feature,  the controller will not be able to establish a
 189 1000baseT link.
 190 Also, if the length of the cable is longer than 120 meters, the controller
 191 can not establish a 1000baseT link.
 192 The known workaround for these issues is to force manual link
 193 configuration with 100baseTX instead of relying on auto-negotiation.
 194 The full mask revision number of controller can be checked with the
 195 verbose kernel boot option.
 196 Use the lower nibble of the chip revision number to get the
 197 full mask revision of the controller.