2019-09-19 00:58:32

by Vincent Cheng

Subject: [PATCH 1/2] dt-bindings: ptp: Add binding doc for IDT ClockMatrix based PTP clock

From: Vincent Cheng <[email protected]>

Add device tree binding doc for the IDT ClockMatrix PTP clock driver.

Signed-off-by: Vincent Cheng <[email protected]>
---
Documentation/devicetree/bindings/ptp/ptp-idtcm.txt | 15 +++++++++++++++
1 file changed, 15 insertions(+)
create mode 100644 Documentation/devicetree/bindings/ptp/ptp-idtcm.txt

diff --git a/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt b/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
new file mode 100644
index 0000000..4eaa34d
--- /dev/null
+++ b/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
@@ -0,0 +1,15 @@
+* IDT ClockMatrix (TM) PTP clock
+
+Required properties:
+
+ - compatible Should be "idt,8a3400x-ptp" for System Synchronizer
+ Should be "idt,8a3401x-ptp" for Port Synchronizer
+ Should be "idt,8a3404x-ptp" for Universal Frequency Translator (UFT)
+ - reg I2C slave address of the device
+
+Example:
+
+ phc@5b {
+ compatible = "idt,8a3400x-ptp";
+ reg = <0x5b>;
+ };
--
2.7.4

2019-10-02 05:54:00

by Rob Herring

Subject: Re: [PATCH 1/2] dt-bindings: ptp: Add binding doc for IDT ClockMatrix based PTP clock

On Wed, Sep 18, 2019 at 04:06:37PM -0400, [email protected] wrote:
> From: Vincent Cheng <[email protected]>
>
> Add device tree binding doc for the IDT ClockMatrix PTP clock driver.

Bindings are for h/w, not drivers...

>
> Signed-off-by: Vincent Cheng <[email protected]>
> ---
> Documentation/devicetree/bindings/ptp/ptp-idtcm.txt | 15 +++++++++++++++
> 1 file changed, 15 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/ptp/ptp-idtcm.txt

Please make this a DT schema.

>
> diff --git a/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt b/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
> new file mode 100644
> index 0000000..4eaa34d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
> @@ -0,0 +1,15 @@
> +* IDT ClockMatrix (TM) PTP clock
> +
> +Required properties:
> +
> + - compatible Should be "idt,8a3400x-ptp" for System Synchronizer
> + Should be "idt,8a3401x-ptp" for Port Synchronizer
> + Should be "idt,8a3404x-ptp" for Universal Frequency Translator (UFT)

If PTP is the only function of the chip, you don't need to append
'-ptp'.

What's the 'x' for? We generally don't use wildcards in compatible
strings.

> + - reg I2C slave address of the device
> +
> +Example:
> +
> + phc@5b {
> + compatible = "idt,8a3400x-ptp";
> + reg = <0x5b>;
> + };
> --
> 2.7.4
>

2019-10-03 15:13:12

by Vincent Cheng

Subject: Re: [PATCH 1/2] dt-bindings: ptp: Add binding doc for IDT ClockMatrix based PTP clock

On Tue, Oct 01, 2019 at 06:09:06PM EDT, Rob Herring wrote:
>On Wed, Sep 18, 2019 at 04:06:37PM -0400, [email protected] wrote:
>> From: Vincent Cheng <[email protected]>

Hi Rob,

Welcome back. Thank-you for providing feedback.

>>
>> Add device tree binding doc for the IDT ClockMatrix PTP clock driver.
>
>Bindings are for h/w, not drivers...

Yes, will remove 'driver'.

>> Documentation/devicetree/bindings/ptp/ptp-idtcm.txt | 15 +++++++++++++++
>> 1 file changed, 15 insertions(+)
>> create mode 100644 Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
>
>Please make this a DT schema.

Sure, will give it a try.

>> + - compatible Should be "idt,8a3400x-ptp" for System Synchronizer
>> + Should be "idt,8a3401x-ptp" for Port Synchronizer
>> + Should be "idt,8a3404x-ptp" for Universal Frequency Translator (UFT)
>
>If PTP is the only function of the chip, you don't need to append
>'-ptp'.

Okay, will remove '-ptp'. Thanks.


>What's the 'x' for? We generally don't use wildcards in compatible
>strings.

We were hoping to use 'x' to represent a single driver to match the various
part numbers 8A34001, 8A34002, 8A34003, 8A34004, 8A34011, 8A34012, etc.

What should be used instead of 'x'?

Thanks,
Vincent

2019-10-03 16:00:49

by Rob Herring

Subject: Re: [PATCH 1/2] dt-bindings: ptp: Add binding doc for IDT ClockMatrix based PTP clock

On Thu, Oct 3, 2019 at 10:12 AM Vincent Cheng
<[email protected]> wrote:
>
> On Tue, Oct 01, 2019 at 06:09:06PM EDT, Rob Herring wrote:
> >On Wed, Sep 18, 2019 at 04:06:37PM -0400, [email protected] wrote:
> >> From: Vincent Cheng <[email protected]>
>
> Hi Rob,
>
> Welcome back. Thank-you for providing feedback.
>
> >>
> >> Add device tree binding doc for the IDT ClockMatrix PTP clock driver.
> >
> >Bindings are for h/w, not drivers...
>
> Yes, will remove 'driver'.
>
> >> Documentation/devicetree/bindings/ptp/ptp-idtcm.txt | 15 +++++++++++++++
> >> 1 file changed, 15 insertions(+)
> >> create mode 100644 Documentation/devicetree/bindings/ptp/ptp-idtcm.txt
> >
> >Please make this a DT schema.
>
> Sure, will give it a try.
>
> >> + - compatible Should be "idt,8a3400x-ptp" for System Synchronizer
> >> + Should be "idt,8a3401x-ptp" for Port Synchronizer
> >> + Should be "idt,8a3404x-ptp" for Universal Frequency Translator (UFT)
> >
> >If PTP is the only function of the chip, you don't need to append
> >'-ptp'.
>
> Okay, will remove '-ptp'. Thanks.
>
>
> >What's the 'x' for? We generally don't use wildcards in compatible
> >strings.
>
> We were hoping to use 'x' to represent a single driver to match the various
> part numbers 8A34001, 8A34002, 8A34003, 8A34004, 8A34011, 8A34012, etc.
>
> What should be used instead of 'x'?

Enumerate all the part numbers. Are the differences discoverable in
some other way? If so, then 'x' is fine, but just add a note how
models are distinguished.

Rob