Documentation: DT: net: Add Xilinx gmiitorgmii converter device tree binding document...
authorAppana Durga Kedareswara Rao <appana.durga.rao@xilinx.com>
Wed, 10 Aug 2016 05:50:07 +0000 (11:20 +0530)
committerDavid S. Miller <davem@davemloft.net>
Fri, 12 Aug 2016 23:57:20 +0000 (16:57 -0700)
Device-tree binding documentation for xilinx gmiitorgmii converter.

Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/devicetree/bindings/net/xilinx_gmii2rgmii.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/net/xilinx_gmii2rgmii.txt b/Documentation/devicetree/bindings/net/xilinx_gmii2rgmii.txt
new file mode 100644 (file)
index 0000000..038dda4
--- /dev/null
@@ -0,0 +1,35 @@
+XILINX GMIITORGMII Converter Driver Device Tree Bindings
+--------------------------------------------------------
+
+The Gigabit Media Independent Interface (GMII) to Reduced Gigabit Media
+Independent Interface (RGMII) core provides the RGMII between RGMII-compliant
+Ethernet physical media devices (PHY) and the Gigabit Ethernet controller.
+This core can be used in all three modes of operation(10/100/1000 Mb/s).
+The Management Data Input/Output (MDIO) interface is used to configure the
+Speed of operation. This core can switch dynamically between the three
+Different speed modes by configuring the conveter register through mdio write.
+
+This converter sits between the ethernet MAC and the external phy.
+MAC <==> GMII2RGMII <==> RGMII_PHY
+
+For more details about mdio please refer phy.txt file in the same directory.
+
+Required properties:
+- compatible   : Should be "xlnx,gmii-to-rgmii-1.0"
+- reg          : The ID number for the phy, usually a small integer
+- phy-handle   : Should point to the external phy device.
+                 See ethernet.txt file in the same directory.
+
+Example:
+       mdio {
+               #address-cells = <1>;
+               #size-cells = <0>;
+               phy: ethernet-phy@0 {
+                       ......
+               };
+               gmiitorgmii: gmiitorgmii@8 {
+                       compatible = "xlnx,gmii-to-rgmii-1.0";
+                       reg = <8>;
+                       phy-handle = <&phy>;
+               };
+       };