[v1,04/12] dt-bindings: clock: imx: Add documentation for i.MXRT1170 clock

Commit Message

Jesse T March 26, 2022, 2:43 p.m. UTC

Add DT binding documentation for i.MXRT1170 clock driver.

Cc: Giulio Benetti <[e-mail]>
Signed-off-by: Jesse Taube <[e-mail]>
---
 .../bindings/clock/imxrt1170-clock.yaml       | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml

Comments

Krzysztof Kozlowski March 27, 2022, 7:12 p.m. UTC | #1

On 26/03/2022 15:43, Jesse Taube wrote:
> Add DT binding documentation for i.MXRT1170 clock driver.
> 
> Cc: Giulio Benetti <[e-mail]>
> Signed-off-by: Jesse Taube <[e-mail]>
> ---
>  .../bindings/clock/imxrt1170-clock.yaml       | 59 +++++++++++++++++++
>  1 file changed, 59 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml

Missing vendor prefix in file name. Add "fsl,"

> 
> diff --git a/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml b/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml
> new file mode 100644
> index 000000000000..ca0f9ba8b3da
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml
> @@ -0,0 +1,59 @@
> +# 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: Clock bindings for Freescale i.MXRT

Really wrong name. This is name of hardware, not "bindings". It's not
for every i.MXRT, is it?

Just like you did in patch #3, so this could be:
Freescale i.MXRT1170 Clock Controller



Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml b/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml
new file mode 100644
index 000000000000..ca0f9ba8b3da
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/imxrt1170-clock.yaml
@@ -0,0 +1,59 @@ 
+# 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: Clock bindings for Freescale i.MXRT
+
+maintainers:
+  - Giulio Benetti <[e-mail]>
+  - Jesse Taube <[e-mail]>
+
+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:
+  - |
+    #include <dt-bindings/clock/imxrt1170-clock.h>
+
+    clks: clock-controller@40cc0000 {
+        compatible = "fsl,imxrt1170-ccm";
+        reg = <0x40cc0000 0x4000>;
+        clocks = <&osc>, <&rcosc16M>, <&osc32k>;
+        clock-names = "osc", "rcosc16M", "osc32k";
+        #clock-cells = <1>;
+    };