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