share/man/man4/man4.powerpc/tsec.4

   1 .\"
   2 .\" Copyright (c) 2009 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 April 22, 2009
  29 .Dt TSEC 4
  30 .Os
  31 .Sh NAME
  32 .Nm tsec
  33 .Nd "Freescale Three-Speed Ethernet Controller 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 tsec"
  39 .Cd "device miibus"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for the gigabit Ethernet controller integrated in
  45 some of the Freescale 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, or a threshold-defined frame counter has been reached
  94 (whichever occurs first). The following sysctls regulate this behaviour:
  95 .Bl -tag -width indent
  96 .It Va dev.tsec.X.int_coal.rx_time
  97 .It Va dev.tsec.X.int_coal.rx_count
  98 .It Va dev.tsec.X.int_coal.tx_time
  99 .It Va dev.tsec.X.int_coal.tx_count
 100 .Pp
 101 Value of 0 for either time or count disables IC on the given path. Time value
 102 1-65535 corresponds to a real time period and is expressed in units equivalent
 103 to 64 ticks of the TSEC clock. Count 1-255 represents the number of frames
 104 (note that value of 1 is equivalent to IC disabled). User provided values
 105 larger than supported will be trimmed to the maximum supported. More details
 106 are available in the reference manual of the device.
 107 .El
 108 .Sh HARDWARE
 109 Gigabit Ethernet controllers built into the following Freescale
 110 system-on-chip devices are known to work with the
 111 .Nm
 112 driver:
 113 .Pp
 114 .Bl -bullet -compact
 115 .It
 116 MPC8349
 117 .It
 118 MPC8533, MPC8541, MPC8555
 119 .El
 120 .Pp
 121 The enhanced version of the controller (eTSEC), integrated in the following
 122 devices, is also supported by this driver:
 123 .Pp
 124 .Bl -bullet -compact
 125 .It
 126 MPC8548, MPC8572
 127 .El
 128 .Sh SEE ALSO
 129 .Xr altq 4 ,
 130 .Xr arp 4 ,
 131 .Xr miibus 4 ,
 132 .Xr netintro 4 ,
 133 .Xr ng_ether 4 ,
 134 .Xr polling 4 ,
 135 .Xr vlan 4 ,
 136 .Xr ifconfig 8
 137 .Sh HISTORY
 138 The
 139 .Nm
 140 device driver first appeared in
 141 .Fx 8.0 .
 142 .Sh AUTHORS
 143 .An -nosplit
 144 The base version of
 145 .Nm
 146 device driver was written by
 147 .An Piotr Kruszynski.
 148 It has been extended with polling and interrupt coalescing support by
 149 .An Rafal Jaworowski.
 150 It has been further enhanced with multicast, h/w checksum calculation and vlan
 151 support by
 152 .An Piotr Ziecik .
 153 This manual page was written by
 154 .An Rafal Jaworowski .