Documentation/devicetree/bindings/net/fsl-tsec-phy.txt

   1 * MDIO IO device
   2
   3 The MDIO is a bus to which the PHY devices are connected.  For each
   4 device that exists on this bus, a child node should be created.  See
   5 the definition of the PHY node in booting-without-of.txt for an example
   6 of how to define a PHY.
   7
   8 Required properties:
   9   - reg : Offset and length of the register set for the device
  10   - compatible : Should define the compatible device type for the
  11     mdio. Currently supported strings/devices are:
  12         - "fsl,gianfar-tbi"
  13         - "fsl,gianfar-mdio"
  14         - "fsl,etsec2-tbi"
  15         - "fsl,etsec2-mdio"
  16         - "fsl,ucc-mdio"
  17         - "fsl,fman-mdio"
  18     When device_type is "mdio", the following strings are also considered:
  19         - "gianfar"
  20         - "ucc_geth_phy"
  21
  22 Example:
  23
  24         mdio@24520 {
  25                 reg = <24520 20>;
  26                 compatible = "fsl,gianfar-mdio";
  27
  28                 ethernet-phy@0 {
  29                         ......
  30                 };
  31         };
  32
  33 * TBI Internal MDIO bus
  34
  35 As of this writing, every tsec is associated with an internal TBI PHY.
  36 This PHY is accessed through the local MDIO bus.  These buses are defined
  37 similarly to the mdio buses, except they are compatible with "fsl,gianfar-tbi".
  38 The TBI PHYs underneath them are similar to normal PHYs, but the reg property
  39 is considered instructive, rather than descriptive.  The reg property should
  40 be chosen so it doesn't interfere with other PHYs on the bus.
  41
  42 * Gianfar-compatible ethernet nodes
  43
  44 Properties:
  45
  46   - device_type : Should be "network"
  47   - model : Model of the device.  Can be "TSEC", "eTSEC", or "FEC"
  48   - compatible : Should be "gianfar"
  49   - reg : Offset and length of the register set for the device
  50   - interrupts : For FEC devices, the first interrupt is the device's
  51     interrupt.  For TSEC and eTSEC devices, the first interrupt is
  52     transmit, the second is receive, and the third is error.
  53   - phy-handle : See ethernet.txt file in the same directory.
  54   - fixed-link : See fixed-link.txt in the same directory.
  55   - phy-connection-type : See ethernet.txt file in the same directory.
  56     This property is only really needed if the connection is of type
  57     "rgmii-id", as all other connection types are detected by hardware.
  58   - fsl,magic-packet : If present, indicates that the hardware supports
  59     waking up via magic packet.
  60   - bd-stash : If present, indicates that the hardware supports stashing
  61     buffer descriptors in the L2.
  62   - rx-stash-len : Denotes the number of bytes of a received buffer to stash
  63     in the L2.
  64   - rx-stash-idx : Denotes the index of the first byte from the received
  65     buffer to stash in the L2.
  66
  67 Example:
  68         ethernet@24000 {
  69                 device_type = "network";
  70                 model = "TSEC";
  71                 compatible = "gianfar";
  72                 reg = <0x24000 0x1000>;
  73                 local-mac-address = [ 00 E0 0C 00 73 00 ];
  74                 interrupts = <29 2 30 2 34 2>;
  75                 interrupt-parent = <&mpic>;
  76                 phy-handle = <&phy0>
  77         };
  78
  79 * Gianfar PTP clock nodes
  80
  81 General Properties:
  82
  83   - compatible   Should be "fsl,etsec-ptp"
  84   - reg          Offset and length of the register set for the device
  85   - interrupts   There should be at least two interrupts. Some devices
  86                  have as many as four PTP related interrupts.
  87
  88 Clock Properties:
  89
  90   - fsl,cksel        Timer reference clock source.
  91   - fsl,tclk-period  Timer reference clock period in nanoseconds.
  92   - fsl,tmr-prsc     Prescaler, divides the output clock.
  93   - fsl,tmr-add      Frequency compensation value.
  94   - fsl,tmr-fiper1   Fixed interval period pulse generator.
  95   - fsl,tmr-fiper2   Fixed interval period pulse generator.
  96   - fsl,max-adj      Maximum frequency adjustment in parts per billion.
  97
  98   These properties set the operational parameters for the PTP
  99   clock. You must choose these carefully for the clock to work right.
 100   Here is how to figure good values:
 101
 102   TimerOsc     = selected reference clock   MHz
 103   tclk_period  = desired clock period       nanoseconds
 104   NominalFreq  = 1000 / tclk_period         MHz
 105   FreqDivRatio = TimerOsc / NominalFreq     (must be greater that 1.0)
 106   tmr_add      = ceil(2^32 / FreqDivRatio)
 107   OutputClock  = NominalFreq / tmr_prsc     MHz
 108   PulseWidth   = 1 / OutputClock            microseconds
 109   FiperFreq1   = desired frequency in Hz
 110   FiperDiv1    = 1000000 * OutputClock / FiperFreq1
 111   tmr_fiper1   = tmr_prsc * tclk_period * FiperDiv1 - tclk_period
 112   max_adj      = 1000000000 * (FreqDivRatio - 1.0) - 1
 113
 114   The calculation for tmr_fiper2 is the same as for tmr_fiper1. The
 115   driver expects that tmr_fiper1 will be correctly set to produce a 1
 116   Pulse Per Second (PPS) signal, since this will be offered to the PPS
 117   subsystem to synchronize the Linux clock.
 118
 119   Reference clock source is determined by the value, which is holded
 120   in CKSEL bits in TMR_CTRL register. "fsl,cksel" property keeps the
 121   value, which will be directly written in those bits, that is why,
 122   according to reference manual, the next clock sources can be used:
 123
 124   <0> - external high precision timer reference clock (TSEC_TMR_CLK
 125         input is used for this purpose);
 126   <1> - eTSEC system clock;
 127   <2> - eTSEC1 transmit clock;
 128   <3> - RTC clock input.
 129
 130   When this attribute is not used, eTSEC system clock will serve as
 131   IEEE 1588 timer reference clock.
 132
 133 Example:
 134
 135         ptp_clock@24E00 {
 136                 compatible = "fsl,etsec-ptp";
 137                 reg = <0x24E00 0xB0>;
 138                 interrupts = <12 0x8 13 0x8>;
 139                 interrupt-parent = < &ipic >;
 140                 fsl,cksel       = <1>;
 141                 fsl,tclk-period = <10>;
 142                 fsl,tmr-prsc    = <100>;
 143                 fsl,tmr-add     = <0x999999A4>;
 144                 fsl,tmr-fiper1  = <0x3B9AC9F6>;
 145                 fsl,tmr-fiper2  = <0x00018696>;
 146                 fsl,max-adj     = <659999998>;
 147         };