No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / jme.4
blob787b449448bce1271ef21009cbe98e8bd76936b4
1 .\"     $NetBSD: jme.4,v 1.5 2008/10/17 20:02:39 bouyer Exp $
2 .\"
3 .\" Copyright (c) 2008 Manuel Bouyer
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .Dd October 17, 2008
27 .Dt JME 4
28 .Os
29 .Sh NAME
30 .Nm jme
31 .Nd JMicron Technologies JMC250 Gigabit Ethernet and JMC260 Fast Ethernet controller driver
32 .Sh SYNOPSIS
33 .Cd "jme* at pci? dev ? function ?"
34 .Pp
35 Configuration of PHYs is necessary.
36 See
37 .Xr mii 4 .
38 .Sh DESCRIPTION
39 The
40 .Nm jme
41 device driver supports network adapters based on the JMicron
42 Technologies JMC250 Gigabit Ethernet and JMC260 Fast Ethernet chips.
43 The following features are supported:
44 .Bd -literal -offset indent
45 IPv4 transmit/receive IP/TCP/UDP checksum offload
46 IPv6 transmit TCP/UDP checksum offload
47 IPv4 and IPv6 TCP segmentation offload
48 VLAN tag insertion/removal
49 Interrupt coalescing
50 10/100/1000Mbps operation in full-duplex mode
51 10/100Mbps operation in half-duplex mode
52 Jumbo frames (up to 9022 bytes)
53 .Ed
54 .Pp
55 Due to hardware limitation checksums and TCP segmentation offload can't
56 be enabled if the configured MTU is larger than 4000 bytes.
57 .Pp
58 Interrupt coalescing can be controlled on a per-adapter basis through
59 the following sysctls:
60 .Bl -tag -width ".Cm hw.jme.jmeXxX.int_rxtos"
61 .It Cm hw.jme.jme\*[Lt]x\*[Gt].int_rxtos
62 jme receive interrupt moderation timer, in microseconds (defaults to 100)
63 .It Cm hw.jme.jme\*[Lt]x\*[Gt].int_rxct
64 jme receive interrupt moderation packet counter (defaults to 128)
65 .It Cm hw.jme.jme\*[Lt]x\*[Gt].int_txto
66 jme transmit interrupt moderation timer, in microseconds (defaults to 100)
67 .It Cm hw.jme.jme\*[Lt]x\*[Gt].int_txct
68 jme transmit interrupt moderation packet counter (defaults to 128)
69 .El
70 .Sh SEE ALSO
71 .Xr ifmedia 4 ,
72 .Xr mii 4 ,
73 .Xr netintro 4 ,
74 .Xr pci 4 ,
75 .Xr ifconfig 8
76 .Sh HISTORY
77 The
78 .Nm
79 device driver first appeared in
80 .Nx 5.0 .
81 .Sh BUGS
82 Hardware bugs prevent support of IPv6 receive TCP/UDP checksum offload
83 in the JMC250 rev A2, and is disabled in the driver.
84 This should be revisited when a newer hardware revision is available.