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 May 27, 2008
  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), 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 JMC250 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 LOADER TUNABLES
  98 Tunables can be set at the
  99 .Xr loader 8
 100 prompt before booting the kernel or stored in
 101 .Xr loader.conf 5 .
 102 .Bl -tag -width "xxxxxx"
 103 .It Va hw.jme.msi_disable
 104 This tunable disables MSI support on the Ethernet hardware.
 105 The default value is 0.
 106 .It Va hw.jme.msix_disable
 107 This tunable disables MSI-X support on the Ethernet hardware.
 108 The default value is 0.
 109 .El
 110 .Sh SYSCTL VARIABLES
 111 The following variables are available as both
 112 .Xr sysctl 8
 113 variables and
 114 .Xr loader 8
 115 tunables:
 116 .Bl -tag -width "xxxxxx"
 117 .It Va dev.jme.%d.tx_coal_to
 118 Maximum amount of time to delay for Tx completion interrupt in
 119 units of 1us.
 120 The accepted range is 1 to 65535, the default is 100 (100us).
 121 .It Va dev.jme.%d.tx_coal_pkt
 122 Maximum number of packets to fire Tx completion interrupt.
 123 The accepted range is 1 to 255, the default is 8.
 124 .It Va dev.jme.%d.rx_coal_to
 125 Maximum amount of time to delay for Rx completion interrupt in
 126 units of 1us.
 127 The accepted range is 1 to 65535, the default is 100 (100us).
 128 .It Va dev.jme.%d.rx_coal_pkt
 129 Maximum number of packets to fire Rx completion interrupt.
 130 The accepted range is 1 to 255, the default is 2.
 131 .It Va dev.jme.%d.process_limit
 132 Maximum amount of Rx events to be processed in the event loop before
 133 rescheduling a taskqueue.
 134 The accepted range is 10 to 255, the default value is 128 events.
 135 The interface does not need to be brought down and up again before
 136 a change takes effect.
 137 .El
 138 .Sh SEE ALSO
 139 .Xr altq 4 ,
 140 .Xr arp 4 ,
 141 .Xr miibus 4 ,
 142 .Xr netintro 4 ,
 143 .Xr ng_ether 4 ,
 144 .Xr vlan 4 ,
 145 .Xr ifconfig 8
 146 .Sh HISTORY
 147 The
 148 .Nm
 149 driver was written by
 150 .An Pyun YongHyeon
 151 .Aq yongari@FreeBSD.org .
 152 It first appeared in
 153 .Fx 7.1 .