Re: [PATCH v1 1/2] dt-binding: ptp: add bindings document for dte based ptp clock

From: Rob Herring
Date: Sun Jun 18 2017 - 10:08:18 EST


On Mon, Jun 12, 2017 at 01:26:00PM -0700, Arun Parameswaran wrote:
> Add device tree binding documentation for the Broadcom DTE
> PTP clock driver.
>
> Signed-off-by: Arun Parameswaran <arun.parameswaran@xxxxxxxxxxxx>
> ---
> Documentation/devicetree/bindings/ptp/brcm,ptp-dte.txt | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/ptp/brcm,ptp-dte.txt
>
> diff --git a/Documentation/devicetree/bindings/ptp/brcm,ptp-dte.txt b/Documentation/devicetree/bindings/ptp/brcm,ptp-dte.txt
> new file mode 100644
> index 0000000..07590bc
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ptp/brcm,ptp-dte.txt
> @@ -0,0 +1,13 @@
> +* Broadcom Digital Timing Engine(DTE) based PTP clock driver

Bindings describe h/w, not drivers.

> +
> +Required properties:
> +- compatible: should be "brcm,ptp-dte"

Looks too generic. You need SoC specific compatible strings.

> +- reg: address and length of the DTE block's NCO registers
> +
> +Example:
> +
> +ptp_dte: ptp_dte@180af650 {

Don't use '_' in node names.

> + compatible = "brcm,ptp-dte";
> + reg = <0x180af650 0x10>;
> + status = "okay";
> +};
> --
> 1.9.1
>