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 April 7, 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 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 hardware VLAN tag stripping/insertion features,
  60 .\" Wake On Lan (WOL)
  61 an interrupt coalescing/moderation mechanism as well as
  62 a 64-bit multicast hash filter.
  63 .Pp
  64 The JMC250 also supports Jumbo Frames (up to 9216 bytes), which can be
  65 configured via the interface MTU setting.
  66 Selecting an MTU larger than 1500 bytes with the
  67 .Xr ifconfig 8
  68 utility configures the adapter to receive and transmit Jumbo Frames.
  69 .Pp
  70 The
  71 .Nm
  72 driver supports the following media types:
  73 .Bl -tag -width ".Cm 10baseT/UTP"
  74 .It Cm autoselect
  75 Enable autoselection of the media type and options.
  76 The user can manually override
  77 the autoselected mode by adding media options to
  78 .Xr rc.conf 5 .
  79 .It Cm 10baseT/UTP
  80 Set 10Mbps operation.
  81 .It Cm 100baseTX
  82 Set 100Mbps (Fast Ethernet) operation.
  83 .It Cm 1000baseT
  84 Set 1000baseT operation over twisted pair.
  85 .El
  86 .Pp
  87 The
  88 .Nm
  89 driver supports the following media options:
  90 .Bl -tag -width ".Cm full-duplex"
  91 .It Cm full-duplex
  92 Force full duplex operation.
  93 .It Cm half-duplex
  94 Force half duplex operation.
  95 .El
  96 .Pp
  97 For more information on configuring this device, see
  98 .Xr ifconfig 8 .
  99 The
 100 .Nm
 101 driver supports
 102 .Xr polling 4 .
 103 .Ss Loader Tunables
 104 By default, the driver will use MSI if it is supported.
 105 This behavior can be turned off by setting the following tunable:
 106 .Bd -literal -offset indent
 107 hw.jme.msi.enable=0
 108 .Ed
 109 .Ss MIB Variables
 110 A number of per-interface variables are implemented in the
 111 .Va hw.jme Ns Em X
 112 branch of the
 113 .Xr sysctl 3
 114 MIB.
 115 .Bl -tag -width "rx_ring_count"
 116 .It Va tx_coal_to
 117 Maximum amount of time to delay for TX completion interrupt in
 118 units of 1us.
 119 The accepted range is 1 to 65535, the default is 65535 (65535us).
 120 .It Va tx_coal_pkt
 121 Maximum number of packets to fire TX completion interrupt.
 122 The accepted range is 0 to 255, the default is 64.
 123 Packet count based TX interrupt coalescing could be disabled
 124 by setting this variable to 0.
 125 .It Va rx_coal_to
 126 Maximum amount of time to delay for RX completion interrupt in
 127 units of 1us.
 128 The accepted range is 1 to 65535, the default is 100 (100us).
 129 .It Va rx_coal_pkt
 130 Maximum number of packets to fire RX completion interrupt.
 131 The accepted range is 0 to 255, the default is 64.
 132 Packet count based RX interrupt coalescing could be disabled
 133 by setting this variable to 0.
 134 .It Va rx_desc_count
 135 Number of RX descriptors per-ring (read-only).
 136 Use the tunable
 137 .Va hw.jme.rx_desc_count
 138 to configure it.
 139 .It Va tx_desc_count
 140 Number of TX descriptors (read-only).
 141 Use the tunable
 142 .Va hw.jme.tx_desc_count
 143 to configure it.
 144 .It Va rx_ring_count
 145 Number of RX rings (read-only).
 146 Use the tunable
 147 .Va hw.jme.rx_ring_count
 148 to configure it.
 149 .It Va rx_ring_inuse
 150 Number of RX rings being used (read-only).
 151 .El
 152 .Sh SEE ALSO
 153 .Xr altq 4 ,
 154 .Xr arp 4 ,
 155 .Xr ifmedia 4 ,
 156 .Xr miibus 4 ,
 157 .Xr netintro 4 ,
 158 .Xr ng_ether 4 ,
 159 .Xr polling 4 ,
 160 .Xr vlan 4 ,
 161 .Xr ifconfig 8
 162 .Sh HISTORY
 163 The
 164 .Nm
 165 driver was written by
 166 .An Pyun YongHyeon
 167 .Aq yongari@FreeBSD.org .
 168 It first appeared in
 169 .Fx 7.1
 170 and was imported into
 171 .Dx 2.1 .