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