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

From: Rob Herring
Date: Tue Oct 01 2019 - 18:09:12 EST


On Wed, Sep 18, 2019 at 04:06:37PM -0400, vincent.cheng.xh@xxxxxxxxxxx wrote:
> From: Vincent Cheng <vincent.cheng.xh@xxxxxxxxxxx>
>
> Add device tree binding doc for the IDT ClockMatrix PTP clock driver.

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

>
> Signed-off-by: Vincent Cheng <vincent.cheng.xh@xxxxxxxxxxx>
> ---
> 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
>