[v5,02/14] dt-bindings: clk: imx: Add fsl,scu-clk yaml file

Commit Message

Viorel Suman June 16, 2022, 4:42 p.m. UTC

From: Abel Vesa <[e-mail]>

In order to replace the fsl,scu txt file from bindings/arm/freescale,
we need to split it between the right subsystems. This patch documents
separately the 'clock' child node of the SCU main node.

Signed-off-by: Abel Vesa <[e-mail]>
Signed-off-by: Viorel Suman <[e-mail]>
---
 .../bindings/clock/fsl,scu-clk.yaml           | 58 +++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml

Comments

Krzysztof Kozlowski June 24, 2022, 10:05 a.m. UTC | #1

On 16/06/2022 18:42, Viorel Suman wrote:
> From: Abel Vesa <[e-mail]>
> 
> In order to replace the fsl,scu txt file from bindings/arm/freescale,
> we need to split it between the right subsystems. This patch documents
> separately the 'clock' child node of the SCU main node.
> 
> Signed-off-by: Abel Vesa <[e-mail]>
> Signed-off-by: Viorel Suman <[e-mail]>
> ---
>  .../bindings/clock/fsl,scu-clk.yaml           | 58 +++++++++++++++++++
>  1 file changed, 58 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml
> 
> diff --git a/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml b/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml
> new file mode 100644
> index 000000000000..8b59758eee4a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/clock/fsl,scu-clk.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: i.MX SCU Client Device Node - Clock bindings based on SCU Message Protocol
> +
> +maintainers:
> +  - Abel Vesa <[e-mail]>
> +
> +description: i.MX SCU Client Device Node
> +  Client nodes are maintained as children of the relevant IMX-SCU device node.
> +  This binding uses the common clock binding.
> +  (Documentation/devicetree/bindings/clock/clock-bindings.txt)
> +  The clock consumer should specify the desired clock by having the clock
> +  ID in its "clocks" phandle cell.
> +  See the full list of clock IDs from
> +  include/dt-bindings/clock/imx8qxp-clock.h
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - fsl,imx8dxl-clk
> +          - fsl,imx8qm-clk
> +          - fsl,imx8qxp-clk
> +      - const: fsl,scu-clk
> +
> +  '#clock-cells':
> +    const: 2
> +
> +  clocks:
> +    items:
> +      - description: XTAL 32KHz
> +      - description: XTAL 24MHz
> +    minItems: 1
> +
> +  clock-names:
> +    items:
> +      enum:
> +        - xtal_32KHz
> +        - xtal_24Mhz

No, this does not match your clocks property and allow any combination.
Are you sure that hardware can have entirely different clocks connected?

> +    minItems: 1
> +    maxItems: 2
> +
> +required:
> +  - compatible
> +  - '#clock-cells'

Why the clocks are not required?

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    clock-controller {
> +           compatible = "fsl,imx8qxp-clk", "fsl,scu-clk";

Wrong indentation. 4 spaces for DTS example.

> +           #clock-cells = <2>;
> +    };


Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml b/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml
new file mode 100644
index 000000000000..8b59758eee4a
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/fsl,scu-clk.yaml
@@ -0,0 +1,58 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/fsl,scu-clk.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: i.MX SCU Client Device Node - Clock bindings based on SCU Message Protocol
+
+maintainers:
+  - Abel Vesa <[e-mail]>
+
+description: i.MX SCU Client Device Node
+  Client nodes are maintained as children of the relevant IMX-SCU device node.
+  This binding uses the common clock binding.
+  (Documentation/devicetree/bindings/clock/clock-bindings.txt)
+  The clock consumer should specify the desired clock by having the clock
+  ID in its "clocks" phandle cell.
+  See the full list of clock IDs from
+  include/dt-bindings/clock/imx8qxp-clock.h
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - fsl,imx8dxl-clk
+          - fsl,imx8qm-clk
+          - fsl,imx8qxp-clk
+      - const: fsl,scu-clk
+
+  '#clock-cells':
+    const: 2
+
+  clocks:
+    items:
+      - description: XTAL 32KHz
+      - description: XTAL 24MHz
+    minItems: 1
+
+  clock-names:
+    items:
+      enum:
+        - xtal_32KHz
+        - xtal_24Mhz
+    minItems: 1
+    maxItems: 2
+
+required:
+  - compatible
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller {
+           compatible = "fsl,imx8qxp-clk", "fsl,scu-clk";
+           #clock-cells = <2>;
+    };