2022-05-17 09:08:35

by Jesse T

Subject: [PATCH v3 07/15] dt-bindings: clock: imx: Add documentation for i.MXRT1170 clock

Add DT binding documentation for i.MXRT1170 clock driver.

Cc: Giulio Benetti <[email protected]>
Signed-off-by: Jesse Taube <[email protected]>
---
V1 -> V2:
- Change title to Clock Controller
- Rename to add fsl
V2 -> V3:
- Remove unused include causing error
---
.../bindings/clock/fsl,imxrt1170-clock.yaml | 57 +++++++++++++++++++
1 file changed, 57 insertions(+)
create mode 100644 Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml

diff --git a/Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml b/Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml
new file mode 100644
index 000000000000..57881e22c400
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml
@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/imxrt1170-clock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale i.MXRT1170 Clock Controller
+
+maintainers:
+ - Giulio Benetti <[email protected]>
+ - Jesse Taube <[email protected]>
+
+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.
+
+properties:
+ compatible:
+ const: fsl,imxrt1170-ccm
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ items:
+ - description: 32M ext osc
+ - description: 16M int rcosc
+ - description: 32k osc
+
+ clock-names:
+ items:
+ - const: osc
+ - const: rcosc16M
+ - const: osc32k
+
+ '#clock-cells':
+ const: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+ - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+ - |
+ clks: clock-controller@40cc0000 {
+ compatible = "fsl,imxrt1170-ccm";
+ reg = <0x40cc0000 0x4000>;
+ clocks = <&osc>, <&rcosc16M>, <&osc32k>;
+ clock-names = "osc", "rcosc16M", "osc32k";
+ #clock-cells = <1>;
+ };
--
2.36.1

2022-05-18 04:47:02

by Rob Herring

Subject: Re: [PATCH v3 07/15] dt-bindings: clock: imx: Add documentation for i.MXRT1170 clock

On Mon, 16 May 2022 23:27:54 -0400, Jesse Taube wrote:
> Add DT binding documentation for i.MXRT1170 clock driver.
>
> Cc: Giulio Benetti <[email protected]>
> Signed-off-by: Jesse Taube <[email protected]>
> ---
> V1 -> V2:
> - Change title to Clock Controller
> - Rename to add fsl
> V2 -> V3:
> - Remove unused include causing error
> ---
> .../bindings/clock/fsl,imxrt1170-clock.yaml | 57 +++++++++++++++++++
> 1 file changed, 57 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml
>

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
./Documentation/devicetree/bindings/clock/fsl,imxrt1170-clock.yaml: $id: relative path/filename doesn't match actual path or filename
expected: http://devicetree.org/schemas/clock/fsl,imxrt1170-clock.yaml#

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.