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 .Pp
  51 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  52 .It autoselect
  53 Enable autoselection of the media type and options
  54 .It 10baseT/UTP
  55 Set 10Mbps operation
  56 .It 100baseTX
  57 Set 100Mbps operation
  58 .It 1000baseT
  59 Set 1000baseT operation
  60 .El
  61 .Pp
  62 The
  63 .Nm
  64 driver supports the following media options:
  65 .Pp
  66 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  67 .It full-duplex
  68 Set full duplex operation
  69 .El
  70 .Pp
  71 The
  72 .Nm
  73 driver supports polled operation when the system is configured with
  74 DEVICE_POLLING kernel option, see
  75 .Xr polling 4
  76 for more details.
  77 .Pp
  78 The
  79 .Nm
  80 driver supports reception and transmission of extended frames
  81 for
  82 .Xr vlan 4 .
  83 This capability of
  84 .Nm
  85 can be controlled by means of the
  86 .Cm vlanmtu
  87 parameter
  88 to
  89 .Xr ifconfig 8 .
  90 .Pp
  91 The
  92 .Nm
  93 driver supports interrupts coalescing (IC) so that raising a transmit/receive
  94 frame interrupt is delayed, if possible, until a threshold-defined period of
  95 time has elapsed, or a threshold-defined frame counter has been reached
  96 (whichever occurs first). The following sysctls regulate this behaviour:
  97 .Bl -tag -width indent
  98 .It Va dev.tsec.X.int_coal.rx_time
  99 .It Va dev.tsec.X.int_coal.rx_count
 100 .It Va dev.tsec.X.int_coal.tx_time
 101 .It Va dev.tsec.X.int_coal.tx_count
 102 .Pp
 103 Value of 0 for either time or count disables IC on the given path. 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. Count 1-255 represents the number of frames
 106 (note that value of 1 is equivalent to IC disabled). User provided values
 107 larger than supported will be trimmed to the maximum supported. More details
 108 are available in the reference manual of the device.
 109 .El
 110 .Sh HARDWARE
 111 Gigabit Ethernet controllers built into the following Freescale
 112 system-on-chip devices are known to work with the
 113 .Nm
 114 driver:
 115 .Pp
 116 .Bl -bullet -compact
 117 .It
 118 MPC8349
 119 .It
 120 MPC8533, MPC8541, MPC8555
 121 .El
 122 .Pp
 123 The enhanced version of the controller (eTSEC), integrated in the following
 124 devices, is also supported by this driver:
 125 .Pp
 126 .Bl -bullet -compact
 127 .It
 128 MPC8548, MPC8572
 129 .El
 130 .Sh SEE ALSO
 131 .Xr altq 4 ,
 132 .Xr arp 4 ,
 133 .Xr miibus 4 ,
 134 .Xr netintro 4 ,
 135 .Xr ng_ether 4 ,
 136 .Xr polling 4 ,
 137 .Xr vlan 4 ,
 138 .Xr ifconfig 8
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 device driver first appeared in
 143 .Fx 8.0 .
 144 .Sh AUTHORS
 145 .An -nosplit
 146 The base version of
 147 .Nm
 148 device driver was written by
 149 .An Piotr Kruszynski.
 150 It has been extended with polling and interrupt coalescing support by
 151 .An Rafal Jaworowski.
 152 It has been further enhanced with multicast, h/w checksum calculation and vlan
 153 support by
 154 .An Piotr Ziecik .
 155 This manual page was written by
 156 .An Rafal Jaworowski .