xref: /linux/Documentation/devicetree/bindings/net/fsl-tsec-phy.txt (revision a1ff5a7d78a036d6c2178ee5acd6ba4946243800)
1d524dac9SGrant Likely* MDIO IO device
2d524dac9SGrant Likely
3d524dac9SGrant LikelyThe MDIO is a bus to which the PHY devices are connected.  For each
4d524dac9SGrant Likelydevice that exists on this bus, a child node should be created.  See
5d524dac9SGrant Likelythe definition of the PHY node in booting-without-of.txt for an example
6d524dac9SGrant Likelyof how to define a PHY.
7d524dac9SGrant Likely
8d524dac9SGrant LikelyRequired properties:
921481189SEsben Haabendal  - reg : Offset and length of the register set for the device, and optionally
1021481189SEsben Haabendal          the offset and length of the TBIPA register (TBI PHY address
1121481189SEsben Haabendal	  register).  If TBIPA register is not specified, the driver will
1221481189SEsben Haabendal	  attempt to infer it from the register set specified (your mileage may
1321481189SEsben Haabendal	  vary).
14d524dac9SGrant Likely  - compatible : Should define the compatible device type for the
15132d7bcaSShruti Kanetkar    mdio. Currently supported strings/devices are:
16132d7bcaSShruti Kanetkar	- "fsl,gianfar-tbi"
17132d7bcaSShruti Kanetkar	- "fsl,gianfar-mdio"
18132d7bcaSShruti Kanetkar	- "fsl,etsec2-tbi"
19132d7bcaSShruti Kanetkar	- "fsl,etsec2-mdio"
20132d7bcaSShruti Kanetkar	- "fsl,ucc-mdio"
21132d7bcaSShruti Kanetkar	- "fsl,fman-mdio"
22132d7bcaSShruti Kanetkar    When device_type is "mdio", the following strings are also considered:
23132d7bcaSShruti Kanetkar	- "gianfar"
24132d7bcaSShruti Kanetkar	- "ucc_geth_phy"
25d524dac9SGrant Likely
26d524dac9SGrant LikelyExample:
27d524dac9SGrant Likely
28d524dac9SGrant Likely	mdio@24520 {
29d524dac9SGrant Likely		reg = <24520 20>;
30d524dac9SGrant Likely		compatible = "fsl,gianfar-mdio";
31d524dac9SGrant Likely
32d524dac9SGrant Likely		ethernet-phy@0 {
33d524dac9SGrant Likely			......
34d524dac9SGrant Likely		};
35d524dac9SGrant Likely	};
36d524dac9SGrant Likely
37d524dac9SGrant Likely* TBI Internal MDIO bus
38d524dac9SGrant Likely
39d524dac9SGrant LikelyAs of this writing, every tsec is associated with an internal TBI PHY.
40d524dac9SGrant LikelyThis PHY is accessed through the local MDIO bus.  These buses are defined
41d524dac9SGrant Likelysimilarly to the mdio buses, except they are compatible with "fsl,gianfar-tbi".
42d524dac9SGrant LikelyThe TBI PHYs underneath them are similar to normal PHYs, but the reg property
43d524dac9SGrant Likelyis considered instructive, rather than descriptive.  The reg property should
44d524dac9SGrant Likelybe chosen so it doesn't interfere with other PHYs on the bus.
45d524dac9SGrant Likely
46d524dac9SGrant Likely* Gianfar-compatible ethernet nodes
47d524dac9SGrant Likely
48d524dac9SGrant LikelyProperties:
49d524dac9SGrant Likely
50d524dac9SGrant Likely  - device_type : Should be "network"
51d524dac9SGrant Likely  - model : Model of the device.  Can be "TSEC", "eTSEC", or "FEC"
52d524dac9SGrant Likely  - compatible : Should be "gianfar"
53d524dac9SGrant Likely  - reg : Offset and length of the register set for the device
54d524dac9SGrant Likely  - interrupts : For FEC devices, the first interrupt is the device's
55d524dac9SGrant Likely    interrupt.  For TSEC and eTSEC devices, the first interrupt is
56d524dac9SGrant Likely    transmit, the second is receive, and the third is error.
57e8f08ee0SSergei Shtylyov  - phy-handle : See ethernet.txt file in the same directory.
58ae21888fSFlorian Fainelli  - fixed-link : See fixed-link.txt in the same directory.
59e8f08ee0SSergei Shtylyov  - phy-connection-type : See ethernet.txt file in the same directory.
60e8f08ee0SSergei Shtylyov    This property is only really needed if the connection is of type
61e8f08ee0SSergei Shtylyov    "rgmii-id", as all other connection types are detected by hardware.
62d524dac9SGrant Likely  - fsl,magic-packet : If present, indicates that the hardware supports
63d524dac9SGrant Likely    waking up via magic packet.
6466cebb86SClaudiu Manoil  - fsl,wake-on-filer : If present, indicates that the hardware supports
6566cebb86SClaudiu Manoil    waking up by Filer General Purpose Interrupt (FGPI) asserted on the
6666cebb86SClaudiu Manoil    Rx int line.  This is an advanced power management capability allowing
6766cebb86SClaudiu Manoil    certain packet types (user) defined by filer rules to wake up the system.
68d524dac9SGrant Likely  - bd-stash : If present, indicates that the hardware supports stashing
69d524dac9SGrant Likely    buffer descriptors in the L2.
70d524dac9SGrant Likely  - rx-stash-len : Denotes the number of bytes of a received buffer to stash
71d524dac9SGrant Likely    in the L2.
72d524dac9SGrant Likely  - rx-stash-idx : Denotes the index of the first byte from the received
73d524dac9SGrant Likely    buffer to stash in the L2.
74d524dac9SGrant Likely
75d524dac9SGrant LikelyExample:
76d524dac9SGrant Likely	ethernet@24000 {
77d524dac9SGrant Likely		device_type = "network";
78d524dac9SGrant Likely		model = "TSEC";
79d524dac9SGrant Likely		compatible = "gianfar";
80d524dac9SGrant Likely		reg = <0x24000 0x1000>;
81d524dac9SGrant Likely		local-mac-address = [ 00 E0 0C 00 73 00 ];
82d524dac9SGrant Likely		interrupts = <29 2 30 2 34 2>;
83d524dac9SGrant Likely		interrupt-parent = <&mpic>;
84d524dac9SGrant Likely		phy-handle = <&phy0>
85d524dac9SGrant Likely	};
86c78275f3SRichard Cochran
87c78275f3SRichard Cochran* Gianfar PTP clock nodes
88c78275f3SRichard Cochran
89*01479f1bSFrank LiRefer to Documentation/devicetree/bindings/ptp/fsl,ptp.yaml
90