Re: [PATCH v2 05/13] dt-bindings: clock: imx: Add documentation for i.MXRT clock

From: Rob Herring <robh@kernel.org>
To: Jesse Taube <mr.bossman075@gmail.com>
Cc: linux-imx@nxp.com, mturquette@baylibre.com, sboyd@kernel.org,
	shawnguo@kernel.org, s.hauer@pengutronix.de,
	kernel@pengutronix.de, festevam@gmail.com,
	ulf.hansson@linaro.org, aisheng.dong@nxp.com, stefan@agner.ch,
	linus.walleij@linaro.org, gregkh@linuxfoundation.org,
	arnd@arndb.de, olof@lixom.net, soc@kernel.org,
	linux@armlinux.org.uk, abel.vesa@nxp.com,
	adrian.hunter@intel.com, jirislaby@kernel.org,
	giulio.benetti@benettiengineering.com,
	nobuhiro1.iwamatsu@toshiba.co.jp, linux-clk@vger.kernel.org,
	devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, linux-mmc@vger.kernel.org,
	linux-gpio@vger.kernel.org, linux-serial@vger.kernel.org
Subject: Re: [PATCH v2 05/13] dt-bindings: clock: imx: Add documentation for i.MXRT clock
Date: Mon, 8 Nov 2021 11:06:01 -0600	[thread overview]
Message-ID: <YYlY+S9iuTjRNFW+@robh.at.kernel.org> (raw)
In-Reply-To: <20211102225653.W9X4uTuBfjTBCe44PlQdYj5pRnczkEUmvmbnCVeKkeM@z>

On Tue, Nov 02, 2021 at 06:56:53PM -0400, Jesse Taube wrote:
> From: Jesse Taube <mr.bossman075@gmail.com>
> 
> Add DT binding documentation for i.MXRT clock driver.
> 
> Cc: Giulio Benetti <giulio.benetti@benettiengineering.com>
> Signed-off-by: Jesse Taube <Mr.Bossman075@gmail.com>
> ---
> V1->V2:
> * Replace macros with values
> ---
>  .../bindings/clock/imxrt-clock.yaml           | 70 +++++++++++++++++++
>  1 file changed, 70 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/imxrt-clock.yaml
> 
> diff --git a/Documentation/devicetree/bindings/clock/imxrt-clock.yaml b/Documentation/devicetree/bindings/clock/imxrt-clock.yaml
> new file mode 100644
> index 000000000000..4e92f79cf707
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/imxrt-clock.yaml
> @@ -0,0 +1,70 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/clock/imxrt-clock.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Clock bindings for Freescale i.MXRT
> +
> +maintainers:
> +  - Giulio Benetti <giulio.benetti@benettiengineering.com>
> +  - Jesse Taube <Mr.Bossman075@gmail.com>
> +
> +description: |
> +  The clock consumer should specify the desired clock by having the clock
> +  ID in its "clocks" phandle cell. See include/dt-bindings/clock/imxrt*-clock.h
> +  for the full list of i.MXRT clock IDs.

blank line

> +properties:
> +  compatible:
> +    oneOf:

Don't need oneOf for a single entry.

> +      - enum:
> +          - fsl,imxrt1050-ccm
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    minItems: 1
> +
> +  clock-names:
> +    minItems: 1

You have to define the name.

> +
> +  '#clock-cells':
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +  - '#clock-cells'
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    anatop: anatop@400d8000 {
> +      compatible = "fsl,imxrt-anatop";
> +      reg = <0x400d8000 0x4000>;
> +    };

Not relevant to the example.

> +
> +    ccm@400fc000 {
> +      compatible = "fsl,imxrt1050-ccm";
> +      reg = <0x400fc000 0x4000>;
> +      interrupts = <95>,<96>;
> +      clocks = <&osc>;
> +      clock-names = "osc";
> +      #clock-cells = <1>;
> +    };
> +
> +    gpt: timer@401ec000 {

Drop unused labels.

> +      compatible = "fsl,imx53-gpt", "fsl,imx31-gpt";

Probably should be: "fsl,imxrt1050-gpt", "fsl,imx31-gpt"

Unless there's same features/quirks as the MX53 version?

> +      reg = <0x401ec000 0x4000>;
> +      interrupts = <100>;
> +      clocks = <&clks 3>;
> +      clock-names = "per";
> +    };
> -- 
> 2.33.1
> 
> 
> _______________________________________________
> linux-arm-kernel mailing list
> linux-arm-kernel@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
> 