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 .\" $DragonFly: src/share/man/man4/jme.4,v 1.1 2008/07/26 14:30:39 sephe Exp $
  27 .\"
  28 .Dd July 26, 2008
  29 .Dt JME 4
  30 .Os
  31 .Sh NAME
  32 .Nm jme
  33 .Nd JMicron Gigabit/Fast Ethernet driver
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device miibus"
  40 .Cd "device jme"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_jme_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 device driver provides support for JMicron JMC250 PCI Express
  53 Gigabit Ethernet controllers and JMicron JMC260 PCI Express Fast
  54 Ethernet controllers.
  55 .Pp
  56 All LOMs supported by the
  57 .Nm
  58 driver have TCP/UDP/IP checksum offload for both transmit and receive,
  59 .\" TCP segmentation offload (TSO),
  60 hardware VLAN tag stripping/insertion features,
  61 .\" Wake On Lan (WOL)
  62 an interrupt coalescing/moderation mechanism as well as
  63 a 64-bit multicast hash filter.
  64 .Pp
  65 The JMC250 also supports Jumbo Frames (up to 9216 bytes), which can be
  66 configured via the interface MTU setting.
  67 Selecting an MTU larger than 1500 bytes with the
  68 .Xr ifconfig 8
  69 utility configures the adapter to receive and transmit Jumbo Frames.
  70 .Pp
  71 The
  72 .Nm
  73 driver supports the following media types:
  74 .Bl -tag -width ".Cm 10baseT/UTP"
  75 .It Cm autoselect
  76 Enable autoselection of the media type and options.
  77 The user can manually override
  78 the autoselected mode by adding media options to
  79 .Xr rc.conf 5 .
  80 .It Cm 10baseT/UTP
  81 Set 10Mbps operation.
  82 .It Cm 100baseTX
  83 Set 100Mbps (Fast Ethernet) operation.
  84 .It Cm 1000baseT
  85 Set 1000baseT operation over twisted pair.
  86 .El
  87 .Pp
  88 The
  89 .Nm
  90 driver supports the following media options:
  91 .Bl -tag -width ".Cm full-duplex"
  92 .It Cm full-duplex
  93 Force full duplex operation.
  94 .It Cm half-duplex
  95 Force half duplex operation.
  96 .El
  97 .Pp
  98 For more information on configuring this device, see
  99 .Xr ifconfig 8 .
 100 .El
 101 .Sh TUNABLES
 102 .Bl -tag -width "tx_coal_pkt"
 103 .It Va tx_coal_to
 104 Maximum amount of time to delay for Tx completion interrupt in
 105 units of 1us.
 106 The accepted range is 1 to 65535, the default is 100 (100us).
 107 .It Va tx_coal_pkt
 108 Maximum number of packets to fire Tx completion interrupt.
 109 The accepted range is 1 to 255, the default is 8.
 110 .It Va rx_coal_to
 111 Maximum amount of time to delay for Rx completion interrupt in
 112 units of 1us.
 113 The accepted range is 1 to 65535, the default is 100 (100us).
 114 .It Va rx_coal_pkt
 115 Maximum number of packets to fire Rx completion interrupt.
 116 The accepted range is 1 to 255, the default is 2.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr altq 4 ,
 120 .Xr arp 4 ,
 121 .Xr miibus 4 ,
 122 .Xr netintro 4 ,
 123 .Xr ng_ether 4 ,
 124 .Xr vlan 4 ,
 125 .Xr ifconfig 8
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 driver was written by
 130 .An Pyun YongHyeon
 131 .Aq yongari@FreeBSD.org .
 132 It first appeared in
 133 .Fx 7.1
 134 and was imported into
 135 .Dx 2.1 .