This patch adds the document describing dt bindings for ZynqMP
phy. ZynqMP SOC has a High Speed Processing System Gigabit
Transceiver which provides PHY capabilties to USB, SATA,
PCIE, Display Port and Ehernet SGMII controllers.

Signed-off-by: Anurag Kumar Vulisha <[email protected]>
---
 Changes in v4:
        1. Fixed the changes in phy-zynqmp.txt as suggested by "Rob Herring"
        2. Moved changes from include/dt-bindings/phy/phy.h into Patch 2 to 1

 Changes in v3:
        1. Corrected the Documentation as suggested by "Vivek Gautam"

 Changes in v2:
        1. None
---
 .../devicetree/bindings/phy/phy-zynqmp.txt         | 109 +++++++++++++++++++++
 include/dt-bindings/phy/phy.h                      |   2 +
 2 files changed, 111 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/phy-zynqmp.txt

diff --git a/Documentation/devicetree/bindings/phy/phy-zynqmp.txt 
b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
new file mode 100644
index 0000000..ed501c4
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
@@ -0,0 +1,109 @@
+Xilinx ZynqMP PHY binding
+
+This binding describes a ZynqMP PHY device that is used to control ZynqMP
+High Speed Gigabit Transceiver(GT). ZynqMP PS GTR provides four lanes
+and are used by USB, SATA, PCIE, Display port and Ethernet SGMMI controllers.
+
+Phy provider node
+=================
+
+Required properties:
+- compatible   : Can be "xlnx,zynqmp-psgtr-v1.1" or "xlnx,zynqmp-psgtr"
+
+- reg           : Address and length of register sets for each device in
+                  "reg-names"
+
+- reg-names     : The names of the register addresses corresponding to the
+                 registers filled in "reg":
+                       - serdes: SERDES block register set
+                       - siou: SIOU block register set
+
+Optional properties:
+- xlnx,tx-termination-fix : Include this for fixing functional issue with the
+                 TX termination resistance in GT, which can be out of spec for
+                 the XCZU9EG silicon version. This property is not required for
+                 "xlnx,zynqmp-psgtr-v1.1"
+
+Required nodes :  A sub-node is required for each lane the controller
+                  provides.
+
+Phy sub-nodes
+=============
+
+Required properties:
+lane@0:
+- #phy-cells   : Should be 4
+
+lane@1:
+- #phy-cells   : Should be 4
+
+lane@2:
+- #phy-cells   : Should be 4
+
+lane@3:
+- #phy-cells   : Should be 4
+
+Example:
+       zynqmp_phy: phy@fd400000 {
+               compatible = "xlnx,zynqmp-psgtr-v1.1";
+               status = "okay";
+               reg = <0x0 0xfd400000 0x0 0x40000>, <0x0 0xfd3d0000 0x0 0x1000>;
+               reg-names = "serdes", "siou";
+
+               lane0: lane@0 {
+                       #phy-cells = <4>;
+               };
+               lane1: lane@1 {
+                       #phy-cells = <4>;
+               };
+               lane2: lane@2 {
+                       #phy-cells = <4>;
+               };
+               lane3: lane@3 {
+                       #phy-cells = <4>;
+               };
+       };
+
+Specifying phy control of devices
+=================================
+
+Device nodes should specify the configuration required in their "phys"
+property, containing a phandle to the phy port node and a device type.
+
+phys = <PHANDLE CONTROLLER_TYPE CONTROLLER_INSTANCE LANE_REF_CLK LANE_FREQ>;
+
+PHANDLE                 = &lane0 or &lane1 or &lane2 or &lane3
+CONTROLLER_TYPE         = PHY_TYPE_PCIE or PHY_TYPE_SATA or PHY_TYPE_USB
+                         or PHY_TYPE_DP or PHY_TYPE_SGMII
+CONTROLLER_INSTANCE     = Depends on controller type used, can be any of
+                               PHY_TYPE_PCIE : 0 or 1 or 2 or 3
+                               PHY_TYPE_SATA : 0 or 1
+                               PHY_TYPE_USB  : 0 or 1
+                               PHY_TYPE_DP   : 0 or 1
+                               PHY_TYPE_SGMII: 0 or 1 or 2 or 3
+LANE_REF_CLK            = Depends on which lane clock is used as ref clk, can 
be
+                         0 or 1 or 2 or 3
+LANE_FREQ               = Frequency of the reference clock, can be any of the
+                         below mentioned based on the phy type used
+- PHY_TYPE_PCIE         = 100Mhz
+- PHY_TYPE_SGMII        = 125Mhz
+- PHY_TYPE_SATA         = 125Mhz, 150Mhz
+- PHY_TYPE_USB          = 26Mhz, 52Mhz, 100Mhz
+- PHY_TYPE_DP           = 27Mhz, 108Mhz, 135Mhz
+
+Example:
+
+#include <dt-bindings/phy/phy.h>
+
+       usb@fe200000 {
+               ...
+               phys = <&lane2 PHY_TYPE_USB3 0 2 2600000>;
+               ...
+       };
+
+       zynqmp-display@fd4a0000 {
+               ...
+               phys = <&lane1 PHY_TYPE_DP 0 1 27000000>,
+                      <&lane0 PHY_TYPE_DP 1 1 27000000>;
+               ...
+       };
diff --git a/include/dt-bindings/phy/phy.h b/include/dt-bindings/phy/phy.h
index d16e875..09cc0a6 100644
--- a/include/dt-bindings/phy/phy.h
+++ b/include/dt-bindings/phy/phy.h
@@ -16,5 +16,7 @@
 #define PHY_TYPE_USB2          3
 #define PHY_TYPE_USB3          4
 #define PHY_TYPE_UFS           5
+#define PHY_TYPE_DP            6
+#define PHY_TYPE_SGMII         7
 
 #endif /* _DT_BINDINGS_PHY */
-- 
2.1.1

Reply via email to