share/man/man4/man4.powerpc/dtsec.4

   1 .\"
   2 .\" Copyright (c) 2016 Justin Hibbits
   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 28, 2016
  29 .Dt DTSEC 4
  30 .Os
  31 .Sh NAME
  32 .Nm dtsec
  33 .Nd "Freescale Datapath Acceleration Architecture-based 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 "include ""dpaa/DPAA""
  39 .Cd "options QORIQ_DPAA"
  40 .Cd "device dpaa"
  41 .Cd "device dtsec"
  42 .Cd "device miibus"
  43 .Ed
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 driver provides support for the DPAA-based gigabit Ethernet controller
  48 integrated in some of the Freescale system-on-chip devices.
  49 .Pp
  50 The
  51 .Nm
  52 driver supports the following media types:
  53 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  54 .It autoselect
  55 Enable autoselection of the media type and options
  56 .It 10baseT/UTP
  57 Set 10Mbps operation
  58 .It 100baseTX
  59 Set 100Mbps operation
  60 .It 1000baseT
  61 Set 1000baseT operation
  62 .El
  63 .Pp
  64 The
  65 .Nm
  66 driver supports the following media options:
  67 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  68 .It full-duplex
  69 Set full duplex operation
  70 .El
  71 .Pp
  72 The
  73 .Nm
  74 driver supports two operating modes:
  75 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  76 .It Regular
  77 Normal mode, utilizing the full datapath acceleration, Buffer Manager, and Queue
  78 Manager.
  79 .It Independent
  80 Runs disconnected from the Buffer Manager and Queue Manager.
  81 .El
  82 .Sh HARDWARE
  83 Gigabit Ethernet controllers built into the following Freescale
  84 system-on-chip devices are known to work with the
  85 .Nm
  86 driver:
  87 .Pp
  88 .Bl -bullet -compact
  89 .It
  90 P2041, P3041
  91 .It
  92 P5010, P5020
  93 .El
  94 .Sh SEE ALSO
  95 .Xr altq 4 ,
  96 .Xr arp 4 ,
  97 .Xr miibus 4 ,
  98 .Xr netintro 4 ,
  99 .Xr ng_ether 4 ,
 100 .Xr ifconfig 8
 101 .Sh BUGS
 102 The
 103 .Nm
 104 driver assumes that there is only one Frame Manager, and that dtsec0 controls
 105 the MDIO interface.  Though this is the case for the supported devices, other
 106 SoCs with the DPAA controller may not work correctly.  Particularly, the P5040
 107 and P4080 SoCs have two frame managers, which breaks this assumption.
 108 .Sh HISTORY
 109 The
 110 .Nm
 111 device driver first appeared in
 112 .Fx 11.0 .
 113 .Sh AUTHORS
 114 .An -nosplit
 115 The base version of
 116 .Nm
 117 device driver was written by
 118 .An Semihalf .
 119 This manual page was written by
 120 .An Justin Hibbits .