share/man/man4/man4.arm/mge.4

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