diff mbox

[1/2] phy: zynqmp: Add dt bindings for ZynqMP PHY.

Message ID 1452676943-18931-1-git-send-email-sbhatta@xilinx.com
State Superseded, archived
Headers show

Commit Message

Subbaraya Sundeep Bhatta Jan. 13, 2016, 9:22 a.m. UTC
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: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
---
 .../devicetree/bindings/phy/phy-zynqmp.txt         | 104 +++++++++++++++++++++
 1 file changed, 104 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/phy/phy-zynqmp.txt

Comments

Kishon Vijay Abraham I Jan. 13, 2016, 11:08 a.m. UTC | #1
Hi,

On Wednesday 13 January 2016 02:52 PM, Subbaraya Sundeep Bhatta wrote:
> 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: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> ---
>  .../devicetree/bindings/phy/phy-zynqmp.txt         | 104 +++++++++++++++++++++
>  1 file changed, 104 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..ec0d3de
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
> @@ -0,0 +1,104 @@
> +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.
> +
> +Required properties (controller (parent) node):
> +- compatible    : Should be "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
> +			- lpd: Low power domain peripherals reset control
> +			- fpd: Full power domain peripherals reset control
> +
> +-xlnx,tx_termination_fix: Include fix for a functional issue in the GT. The TX
> +			  termination resistance can be out of spec due to a
> +			  bug in the calibration logic. This issue will be fixed
> +			  in silicon in future versions.
> +
> +Required nodes	:  A sub-node is required for each lane the controller
> +		   provides. These nodes are translated by the driver's
> +		   .xlate() function.

driver details need not be in the binding documentation.
> +
> +Required properties (port (child) nodes):
> +lane0:
> +- #phy-cells	: Should be 1
> +		  Cell after port phandle is device type from:
> +			- XPSGTR_TYPE_PCIE_0
> +			- XPSGTR_TYPE_SATA_0
> +			- XPSGTR_TYPE_USB0
> +			- XPSGTR_TYPE_DP_1
> +			- XPSGTR_TYPE_SGMII0

Why not use the already existing PHY TYPES?
phy-cells can be made as '2' and the last cell can be used as index if that's
required.

Thanks
Kishon
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Subbaraya Sundeep Bhatta Jan. 13, 2016, 11:49 a.m. UTC | #2
Hi Kishon,

> -----Original Message-----
> From: Kishon Vijay Abraham I [mailto:kishon@ti.com]
> Sent: Wednesday, January 13, 2016 4:39 PM
> To: Subbaraya Sundeep Bhatta; robh@kernel.org
> Cc: balbi@ti.com; gregkh@linuxfoundation.org; devicetree@vger.kernel.org;
> linux-kernel@vger.kernel.org; Subbaraya Sundeep Bhatta
> Subject: Re: [PATCH 1/2] phy: zynqmp: Add dt bindings for ZynqMP PHY.
> 
> Hi,
> 
> On Wednesday 13 January 2016 02:52 PM, Subbaraya Sundeep Bhatta wrote:
> > 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: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> > ---
> >  .../devicetree/bindings/phy/phy-zynqmp.txt         | 104
> +++++++++++++++++++++
> >  1 file changed, 104 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..ec0d3de
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
> > @@ -0,0 +1,104 @@
> > +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.
> > +
> > +Required properties (controller (parent) node):
> > +- compatible    : Should be "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
> > +			- lpd: Low power domain peripherals reset control
> > +			- fpd: Full power domain peripherals reset control
> > +
> > +-xlnx,tx_termination_fix: Include fix for a functional issue in the GT. The TX
> > +			  termination resistance can be out of spec due to a
> > +			  bug in the calibration logic. This issue will be fixed
> > +			  in silicon in future versions.
> > +
> > +Required nodes	:  A sub-node is required for each lane the controller
> > +		   provides. These nodes are translated by the driver's
> > +		   .xlate() function.
> 
> driver details need not be in the binding documentation.

Ok will remove this.
> > +
> > +Required properties (port (child) nodes):
> > +lane0:
> > +- #phy-cells	: Should be 1
> > +		  Cell after port phandle is device type from:
> > +			- XPSGTR_TYPE_PCIE_0
> > +			- XPSGTR_TYPE_SATA_0
> > +			- XPSGTR_TYPE_USB0
> > +			- XPSGTR_TYPE_DP_1
> > +			- XPSGTR_TYPE_SGMII0
> 
> Why not use the already existing PHY TYPES?
> phy-cells can be made as '2' and the last cell can be used as index if that's
> required.

PCIE_0 means lane 0 of PCIe controller and USB0 is USB 0 controller
(there are two USB controllers). To differentiate I named like above.
phy-cells with 2 sounds good. Shall I add PHY_TYPE_SGMII to
include/dt-bindings/phy/phy.h and remove the phy-zynqmp.h ?

Thanks,
Sundeep.B.S.

> 
> Thanks
> Kishon
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Kishon Vijay Abraham I Jan. 13, 2016, 11:59 a.m. UTC | #3
On Wednesday 13 January 2016 05:19 PM, Subbaraya Sundeep Bhatta wrote:
> Hi Kishon,
> 
>> -----Original Message-----
>> From: Kishon Vijay Abraham I [mailto:kishon@ti.com]
>> Sent: Wednesday, January 13, 2016 4:39 PM
>> To: Subbaraya Sundeep Bhatta; robh@kernel.org
>> Cc: balbi@ti.com; gregkh@linuxfoundation.org; devicetree@vger.kernel.org;
>> linux-kernel@vger.kernel.org; Subbaraya Sundeep Bhatta
>> Subject: Re: [PATCH 1/2] phy: zynqmp: Add dt bindings for ZynqMP PHY.
>>
>> Hi,
>>
>> On Wednesday 13 January 2016 02:52 PM, Subbaraya Sundeep Bhatta wrote:
>>> 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: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
>>> ---
>>>  .../devicetree/bindings/phy/phy-zynqmp.txt         | 104
>> +++++++++++++++++++++
>>>  1 file changed, 104 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..ec0d3de
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
>>> @@ -0,0 +1,104 @@
>>> +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.
>>> +
>>> +Required properties (controller (parent) node):
>>> +- compatible    : Should be "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
>>> +			- lpd: Low power domain peripherals reset control
>>> +			- fpd: Full power domain peripherals reset control
>>> +
>>> +-xlnx,tx_termination_fix: Include fix for a functional issue in the GT. The TX
>>> +			  termination resistance can be out of spec due to a
>>> +			  bug in the calibration logic. This issue will be fixed
>>> +			  in silicon in future versions.
>>> +
>>> +Required nodes	:  A sub-node is required for each lane the controller
>>> +		   provides. These nodes are translated by the driver's
>>> +		   .xlate() function.
>>
>> driver details need not be in the binding documentation.
> 
> Ok will remove this.
>>> +
>>> +Required properties (port (child) nodes):
>>> +lane0:
>>> +- #phy-cells	: Should be 1
>>> +		  Cell after port phandle is device type from:
>>> +			- XPSGTR_TYPE_PCIE_0
>>> +			- XPSGTR_TYPE_SATA_0
>>> +			- XPSGTR_TYPE_USB0
>>> +			- XPSGTR_TYPE_DP_1
>>> +			- XPSGTR_TYPE_SGMII0
>>
>> Why not use the already existing PHY TYPES?
>> phy-cells can be made as '2' and the last cell can be used as index if that's
>> required.
> 
> PCIE_0 means lane 0 of PCIe controller and USB0 is USB 0 controller
> (there are two USB controllers). To differentiate I named like above.
> phy-cells with 2 sounds good. Shall I add PHY_TYPE_SGMII to
> include/dt-bindings/phy/phy.h and remove the phy-zynqmp.h ?

yes, so that it can be used by others too.

Thanks
Kishon
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Soren Brinkmann Jan. 13, 2016, 3:25 p.m. UTC | #4
On Wed, 2016-01-13 at 02:52PM +0530, Subbaraya Sundeep Bhatta wrote:
> 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: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com>
> ---
>  .../devicetree/bindings/phy/phy-zynqmp.txt         | 104 +++++++++++++++++++++
>  1 file changed, 104 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..ec0d3de
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
> @@ -0,0 +1,104 @@
> +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.
> +
> +Required properties (controller (parent) node):
> +- compatible    : Should be "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
> +			- lpd: Low power domain peripherals reset control
> +			- fpd: Full power domain peripherals reset control

Reset registers should not be directly modifiable by Linux. This is
likely to need a reset controller that uses FW to control eligible
resets.

> +
> +-xlnx,tx_termination_fix: Include fix for a functional issue in the GT. The TX
> +			  termination resistance can be out of spec due to a
> +			  bug in the calibration logic. This issue will be fixed
> +			  in silicon in future versions.

Isn't the silicon version run-time detectable? This property may not be
needed.

	Thanks,
	Sören
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/phy/phy-zynqmp.txt b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
new file mode 100644
index 0000000..ec0d3de
--- /dev/null
+++ b/Documentation/devicetree/bindings/phy/phy-zynqmp.txt
@@ -0,0 +1,104 @@ 
+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.
+
+Required properties (controller (parent) node):
+- compatible    : Should be "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
+			- lpd: Low power domain peripherals reset control
+			- fpd: Full power domain peripherals reset control
+
+-xlnx,tx_termination_fix: Include fix for a functional issue in the GT. The TX
+			  termination resistance can be out of spec due to a
+			  bug in the calibration logic. This issue will be fixed
+			  in silicon in future versions.
+
+Required nodes	:  A sub-node is required for each lane the controller
+		   provides. These nodes are translated by the driver's
+		   .xlate() function.
+
+Required properties (port (child) nodes):
+lane0:
+- #phy-cells	: Should be 1
+		  Cell after port phandle is device type from:
+			- XPSGTR_TYPE_PCIE_0
+			- XPSGTR_TYPE_SATA_0
+			- XPSGTR_TYPE_USB0
+			- XPSGTR_TYPE_DP_1
+			- XPSGTR_TYPE_SGMII0
+lane1:
+- #phy-cells	: Should be 1
+		  Cell after port phandle is device type from:
+			- XPSGTR_TYPE_PCIE_1
+			- XPSGTR_TYPE_SATA_1
+			- XPSGTR_TYPE_USB0
+			- XPSGTR_TYPE_DP_0
+			- XPSGTR_TYPE_SGMII1
+lane2:
+- #phy-cells	: Should be 1
+		  Cell after port phandle is device type from:
+			- XPSGTR_TYPE_PCIE_2
+			- XPSGTR_TYPE_SATA_0
+			- XPSGTR_TYPE_USB0
+			- XPSGTR_TYPE_DP_1
+			- XPSGTR_TYPE_SGMII2
+lane3:
+- #phy-cells	: Should be 1
+		  Cell after port phandle is device type from:
+			- XPSGTR_TYPE_PCIE_3
+			- XPSGTR_TYPE_SATA_1
+			- XPSGTR_TYPE_USB1
+			- XPSGTR_TYPE_DP_0
+			- XPSGTR_TYPE_SGMII3
+
+Example:
+	zynqmp_phy@fd400000 {
+		compatible = "xlnx,zynqmp-psgtr";
+		status = "okay";
+		reg = <0x0 0xfd400000 0x40000>, <0x0 0xfd3d0000 0x1000>,
+			<0x0 0xfd1a0000 0x1000>, <0x0 0xff5e0000 0x1000>;
+		reg-names = "serdes", "siou", "fpd", "lpd";
+
+		lane0: lane@0 {
+			#phy-cells = <1>;
+		};
+		lane1: lane@1 {
+			#phy-cells = <1>;
+		};
+		lane2: lane@2 {
+			#phy-cells = <1>;
+		};
+		lane3: lane@3 {
+			#phy-cells = <1>;
+		};
+	};
+
+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.
+
+Example:
+
+#include <dt-bindings/phy/phy.h>
+
+	usb@fe200000 {
+		...
+		phys	  = <&lane2 XPSGTR_TYPE_USB0>;
+		...
+	};
+
+	ahci@fd0c0000 {
+		...
+		phys	  = <&lane3 XPSGTR_TYPE_SATA_0>;
+		...
+	};