xref: /freebsd/share/man/man4/man4.arm/mge.4 (revision b1f9167f94059fd55c630891d359bcff987bd7eb)
1.\"
2.\" Copyright (c) 2008 Semihalf, Rafal Jaworowski
3.\"
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 DEVELOPERS ``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 DEVELOPERS 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.\" $FreeBSD$
27.\"
28.Dd November 27, 2008
29.Dt MGE 4
30.Os
31.Sh NAME
32.Nm mge
33.Nd "Marvell Gigabit Ethernet device driver"
34.Sh SYNOPSIS
35To compile this driver into the kernel, place the following lines in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device mge"
39.Cd "device miibus"
40.Ed
41.Sh DESCRIPTION
42The
43.Nm
44driver provides support for gigabit Ethernet controller integrated in Marvell
45system-on-chip devices.
46.Pp
47The
48.Nm
49driver supports the following media types:
50.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
51.It autoselect
52Enable autoselection of the media type and options
53.It 10baseT/UTP
54Set 10Mbps operation
55.It 100baseTX
56Set 100Mbps operation
57.It 1000baseT
58Set 1000baseT operation
59.El
60.Pp
61The
62.Nm
63driver supports the following media options:
64.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
65.It full-duplex
66Set full duplex operation
67.El
68.Pp
69The
70.Nm
71driver supports polled operation when the system is configured with
72DEVICE_POLLING kernel option, see
73.Xr polling 4
74for more details.
75.Pp
76The
77.Nm
78driver supports reception and transmission of extended frames
79for
80.Xr vlan 4 .
81This capability of
82.Nm
83can be controlled by means of the
84.Cm vlanmtu
85parameter
86to
87.Xr ifconfig 8 .
88.Pp
89The
90.Nm
91driver supports interrupts coalescing (IC) so that raising a transmit/receive
92frame interrupt is delayed, if possible, until a threshold-defined period of
93time has elapsed. The following sysctls regulate this behaviour (separately
94for each path):
95.Bl -tag -width indent
96.It Va dev.mge.X.int_coal.rx_time
97.It Va dev.mge.X.int_coal.tx_time
98.Pp
99Value of 0 disables IC on the given path, value greater than zero corresponds
100to a real time period and is expressed in units equivalent to 64 ticks of the
101MGE clock.  Maximum allowed value depends on MGE hardware revision. User
102provided values larger than supported will be trimmed to the maximum
103supported. More details are available in the reference manual of the device.
104.El
105.Sh HARDWARE
106Gigabit Ethernet controllers built into the following Marvell systems-on-chip
107are known to work with the
108.Nm
109driver:
110.Pp
111.Bl -bullet -compact
112.It
113Orion 88F5182
114.It
115Orion 88F5281
116.It
117Kirkwood 88F6281 (MGE V2)
118.It
119Discovery MV78100 (MGE V2)
120.El
121.Pp
122There are also Marvell system controllers for PowerPC processors, which
123include a variation of this gigabit Ethernet module integrated on chip, and
124they should also work with the
125.Nm
126driver, but this wasn't tested:
127.Pp
128.Bl -bullet -compact
129.It
130MV64430
131.It
132MV64460, MV64461, MV64462
133.El
134.Sh SEE ALSO
135.Xr altq 4 ,
136.Xr arp 4 ,
137.Xr miibus 4 ,
138.Xr netintro 4 ,
139.Xr ng_ether 4 ,
140.Xr polling 4 ,
141.Xr vlan 4 ,
142.Xr ifconfig 8
143.Sh HISTORY
144The
145.Nm
146device driver first appeared in
147.Fx 8.0 .
148.Sh AUTHORS
149.An -nosplit
150The base version of
151.Nm
152device driver was written by
153.An Grzegorz Bernacki.
154It has been extended with advanced features (polling, interrupt coalescing,
155multicast, h/w checksum calculation etc.) by
156.An Piotr Ziecik .
157This manual page was written by
158.An Rafal Jaworowski .
159