[dtschema PATCH] schemas: clock: Add example for 'clock-indices'

[dtschema PATCH] schemas: clock: Add example for 'clock-indices'

[Rob Herring]

Add description for assigned-clocks properties from clock-binding.txt in
the Linux kernel.

This is relicensed from GPL-2.0 (the default) to BSD-2-Clause. The Cc list
are the original authors.

Cc: Ben Dooks <ben.dooks-4yDnlxn2s6sWdaTGBSpHTA@public.gmane.org>
Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
Please ack the license change.

 dtschema/schemas/clock/clock.yaml | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/dtschema/schemas/clock/clock.yaml b/dtschema/schemas/clock/clock.yaml
index 5299653b80b6..433a858ef31e 100644
--- a/dtschema/schemas/clock/clock.yaml
+++ b/dtschema/schemas/clock/clock.yaml
@@ -94,9 +94,21 @@ properties:
 
   clock-indices:
     $ref: "/schemas/types.yaml#/definitions/uint32-array"
-    description: If the identifying number for the clocks in the node
-      is not linear from zero, then this allows the mapping of identifiers
-      into the clock-output-names array.
+    description: |
+      If the identifying number for the clocks in the node is not linear from
+      zero, then this allows the mapping of identifiers into the
+      clock-output-names array.
+
+      For example, if we have two clocks <&oscillator 1> and <&oscillator 3>:
+
+        oscillator {
+            compatible = "myclocktype";
+            #clock-cells = <1>;
+            clock-indices = <1>, <3>;
+            clock-output-names = "clka", "clkb";
+        }
+
+      This ensures we do not have any empty strings in clock-output-names
 
   # Consumer properties
   clocks:
-- 
2.34.1

Re: [dtschema PATCH] schemas: clock: Add example for 'clock-indices'

[Stephen Boyd]

Quoting Rob Herring (2022-04-28 08:27:19)
> Add description for assigned-clocks properties from clock-binding.txt in
> the Linux kernel.
> 
> This is relicensed from GPL-2.0 (the default) to BSD-2-Clause. The Cc list
> are the original authors.
> 
> Cc: Ben Dooks <ben.dooks-4yDnlxn2s6sWdaTGBSpHTA@public.gmane.org>
> Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
> ---

Acked-by: Stephen Boyd <sboyd-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>

Re: [dtschema PATCH] schemas: clock: Add example for 'clock-indices'

[Rob Herring]

On Thu, Apr 28, 2022 at 10:27 AM Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org> wrote:
>
> Add description for assigned-clocks properties from clock-binding.txt in
> the Linux kernel.
>
> This is relicensed from GPL-2.0 (the default) to BSD-2-Clause. The Cc list
> are the original authors.
>
> Cc: Ben Dooks <ben.dooks-4yDnlxn2s6sWdaTGBSpHTA@public.gmane.org>
> Signed-off-by: Rob Herring <robh-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
> ---
> Please ack the license change.

Ben, need your ack on this please.

>
>  dtschema/schemas/clock/clock.yaml | 18 +++++++++++++++---
>  1 file changed, 15 insertions(+), 3 deletions(-)
>
> diff --git a/dtschema/schemas/clock/clock.yaml b/dtschema/schemas/clock/clock.yaml
> index 5299653b80b6..433a858ef31e 100644
> --- a/dtschema/schemas/clock/clock.yaml
> +++ b/dtschema/schemas/clock/clock.yaml
> @@ -94,9 +94,21 @@ properties:
>
>    clock-indices:
>      $ref: "/schemas/types.yaml#/definitions/uint32-array"
> -    description: If the identifying number for the clocks in the node
> -      is not linear from zero, then this allows the mapping of identifiers
> -      into the clock-output-names array.
> +    description: |
> +      If the identifying number for the clocks in the node is not linear from
> +      zero, then this allows the mapping of identifiers into the
> +      clock-output-names array.
> +
> +      For example, if we have two clocks <&oscillator 1> and <&oscillator 3>:
> +
> +        oscillator {
> +            compatible = "myclocktype";
> +            #clock-cells = <1>;
> +            clock-indices = <1>, <3>;
> +            clock-output-names = "clka", "clkb";
> +        }
> +
> +      This ensures we do not have any empty strings in clock-output-names
>
>    # Consumer properties
>    clocks:
> --
> 2.34.1
>