xref: /freebsd/share/man/man4/man4.arm/mge.4 (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
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.Dd November 27, 2008
27.Dt MGE 4
28.Os
29.Sh NAME
30.Nm mge
31.Nd "Marvell Gigabit Ethernet device driver"
32.Sh SYNOPSIS
33To compile this driver into the kernel, place the following lines in your
34kernel configuration file:
35.Bd -ragged -offset indent
36.Cd "device mge"
37.Cd "device miibus"
38.Ed
39.Sh DESCRIPTION
40The
41.Nm
42driver provides support for gigabit Ethernet controller integrated in Marvell
43system-on-chip devices.
44.Pp
45The
46.Nm
47driver supports the following media types:
48.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
49.It autoselect
50Enable autoselection of the media type and options
51.It 10baseT/UTP
52Set 10Mbps operation
53.It 100baseTX
54Set 100Mbps operation
55.It 1000baseT
56Set 1000baseT operation
57.El
58.Pp
59The
60.Nm
61driver supports the following media options:
62.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
63.It full-duplex
64Set full duplex operation
65.El
66.Pp
67The
68.Nm
69driver supports polled operation when the system is configured with
70DEVICE_POLLING kernel option, see
71.Xr polling 4
72for more details.
73.Pp
74The
75.Nm
76driver supports reception and transmission of extended frames
77for
78.Xr vlan 4 .
79This capability of
80.Nm
81can be controlled by means of the
82.Cm vlanmtu
83parameter
84to
85.Xr ifconfig 8 .
86.Pp
87The
88.Nm
89driver supports interrupts coalescing (IC) so that raising a transmit/receive
90frame interrupt is delayed, if possible, until a threshold-defined period of
91time has elapsed.
92The following sysctls regulate this behaviour (separately for each path):
93.Bl -tag -width indent
94.It Va dev.mge.X.int_coal.rx_time
95.It Va dev.mge.X.int_coal.tx_time
96.Pp
97Value of 0 disables IC on the given path, value greater than zero corresponds
98to a real time period and is expressed in units equivalent to 64 ticks of the
99MGE clock.
100Maximum allowed value depends on MGE hardware revision.
101User provided values larger than supported will be trimmed to the maximum
102supported.
103More 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