[PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Geert Uytterhoeven]

Replace the sentences in the description listing some supported variants
by comments on the individual compatible values, to ease future
maintenance.  While at it, restore alphabetical sort order.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 .../bindings/timer/sifive,clint.yaml          | 21 +++++++------------
 1 file changed, 8 insertions(+), 13 deletions(-)

diff --git a/Documentation/devicetree/bindings/timer/sifive,clint.yaml b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
index 94bef9424df1bc6a..34a81510678134eb 100644
--- a/Documentation/devicetree/bindings/timer/sifive,clint.yaml
+++ b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
@@ -29,11 +29,11 @@ properties:
     oneOf:
       - items:
           - enum:
-              - sifive,fu540-c000-clint
-              - starfive,jh7100-clint
-              - starfive,jh7110-clint
-              - canaan,k210-clint
-          - const: sifive,clint0
+              - canaan,k210-clint       # Canaan Kendryte K210
+              - sifive,fu540-c000-clint # SiFive FU540
+              - starfive,jh7100-clint   # StarFive JH7100
+              - starfive,jh7110-clint   # StarFive JH7110
+          - const: sifive,clint0        # SiFive CLINT v0 IP block
       - items:
           - enum:
               - allwinner,sun20i-d1-clint
@@ -45,14 +45,9 @@ properties:
         description: For the QEMU virt machine only
 
     description:
-      Should be "<vendor>,<chip>-clint" and "sifive,clint<version>".
-      Supported compatible strings are -
-      "sifive,fu540-c000-clint" for the SiFive CLINT v0 as integrated
-      onto the SiFive FU540 chip, "canaan,k210-clint" for the SiFive
-      CLINT v0 as integrated onto the Canaan Kendryte K210 chip, and
-      "sifive,clint0" for the SiFive CLINT v0 IP block with no chip
-      integration tweaks.
-      Please refer to sifive-blocks-ip-versioning.txt for details
+      Should be "<vendor>,<chip>-clint", followed by "sifive,clint<version>"
+      when compatible with a SiFive CLINT.  Please refer to
+      sifive-blocks-ip-versioning.txt for details regarding the latter.
 
   reg:
     maxItems: 1
-- 
2.34.1

Re: [PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Krzysztof Kozlowski]

On 10/05/2023 15:27, Geert Uytterhoeven wrote:
> Replace the sentences in the description listing some supported variants
> by comments on the individual compatible values, to ease future
> maintenance.  While at it, restore alphabetical sort order.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  .../bindings/timer/sifive,clint.yaml          | 21 +++++++------------
>  1 file changed, 8 insertions(+), 13 deletions(-)
> 

Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof

Re: [PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2812 bytes --]

On Wed, May 10, 2023 at 03:27:24PM +0200, Geert Uytterhoeven wrote:
> Replace the sentences in the description listing some supported variants
> by comments on the individual compatible values, to ease future
> maintenance.  While at it, restore alphabetical sort order.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  .../bindings/timer/sifive,clint.yaml          | 21 +++++++------------
>  1 file changed, 8 insertions(+), 13 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/timer/sifive,clint.yaml b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> index 94bef9424df1bc6a..34a81510678134eb 100644
> --- a/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> +++ b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> @@ -29,11 +29,11 @@ properties:
>      oneOf:
>        - items:
>            - enum:
> -              - sifive,fu540-c000-clint
> -              - starfive,jh7100-clint
> -              - starfive,jh7110-clint
> -              - canaan,k210-clint
> -          - const: sifive,clint0
> +              - canaan,k210-clint       # Canaan Kendryte K210
> +              - sifive,fu540-c000-clint # SiFive FU540
> +              - starfive,jh7100-clint   # StarFive JH7100
> +              - starfive,jh7110-clint   # StarFive JH7110
> +          - const: sifive,clint0        # SiFive CLINT v0 IP block
>        - items:
>            - enum:
>                - allwinner,sun20i-d1-clint
> @@ -45,14 +45,9 @@ properties:
>          description: For the QEMU virt machine only
>  
>      description:
> -      Should be "<vendor>,<chip>-clint" and "sifive,clint<version>".
> -      Supported compatible strings are -
> -      "sifive,fu540-c000-clint" for the SiFive CLINT v0 as integrated
> -      onto the SiFive FU540 chip, "canaan,k210-clint" for the SiFive
> -      CLINT v0 as integrated onto the Canaan Kendryte K210 chip, and
> -      "sifive,clint0" for the SiFive CLINT v0 IP block with no chip
> -      integration tweaks.
> -      Please refer to sifive-blocks-ip-versioning.txt for details

> +      Should be "<vendor>,<chip>-clint", followed by "sifive,clint<version>"
> +      when compatible with a SiFive CLINT.  Please refer to
> +      sifive-blocks-ip-versioning.txt for details regarding the latter.

Does this section actually add any value at all?
By nature of oneOf structure above, such an ordering is required for
existing entries. For something not here, should we instead be noting
that sifive,clint0 is to be used when compatible with the SiFive/RISC-V
clint, rather than doing a sifive-blocks-ip-versioning.txt dance?

As it stands though, patch is an improvement, so:
Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Thanks,
Conor.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Geert Uytterhoeven]

Hi Conor,

On Wed, May 10, 2023 at 6:02 PM Conor Dooley <conor@kernel.org> wrote:
> On Wed, May 10, 2023 at 03:27:24PM +0200, Geert Uytterhoeven wrote:
> > Replace the sentences in the description listing some supported variants
> > by comments on the individual compatible values, to ease future
> > maintenance.  While at it, restore alphabetical sort order.
> >
> > Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> > ---
> >  .../bindings/timer/sifive,clint.yaml          | 21 +++++++------------
> >  1 file changed, 8 insertions(+), 13 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/timer/sifive,clint.yaml b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> > index 94bef9424df1bc6a..34a81510678134eb 100644
> > --- a/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> > +++ b/Documentation/devicetree/bindings/timer/sifive,clint.yaml
> > @@ -29,11 +29,11 @@ properties:
> >      oneOf:
> >        - items:
> >            - enum:
> > -              - sifive,fu540-c000-clint
> > -              - starfive,jh7100-clint
> > -              - starfive,jh7110-clint
> > -              - canaan,k210-clint
> > -          - const: sifive,clint0
> > +              - canaan,k210-clint       # Canaan Kendryte K210
> > +              - sifive,fu540-c000-clint # SiFive FU540
> > +              - starfive,jh7100-clint   # StarFive JH7100
> > +              - starfive,jh7110-clint   # StarFive JH7110
> > +          - const: sifive,clint0        # SiFive CLINT v0 IP block
> >        - items:
> >            - enum:
> >                - allwinner,sun20i-d1-clint
> > @@ -45,14 +45,9 @@ properties:
> >          description: For the QEMU virt machine only
> >
> >      description:
> > -      Should be "<vendor>,<chip>-clint" and "sifive,clint<version>".
> > -      Supported compatible strings are -
> > -      "sifive,fu540-c000-clint" for the SiFive CLINT v0 as integrated
> > -      onto the SiFive FU540 chip, "canaan,k210-clint" for the SiFive
> > -      CLINT v0 as integrated onto the Canaan Kendryte K210 chip, and
> > -      "sifive,clint0" for the SiFive CLINT v0 IP block with no chip
> > -      integration tweaks.
> > -      Please refer to sifive-blocks-ip-versioning.txt for details
>
> > +      Should be "<vendor>,<chip>-clint", followed by "sifive,clint<version>"
> > +      when compatible with a SiFive CLINT.  Please refer to
> > +      sifive-blocks-ip-versioning.txt for details regarding the latter.
>
> Does this section actually add any value at all?
> By nature of oneOf structure above, such an ordering is required for
> existing entries. For something not here, should we instead be noting
> that sifive,clint0 is to be used when compatible with the SiFive/RISC-V
> clint, rather than doing a sifive-blocks-ip-versioning.txt dance?

I considered removing the paragraph.  But I kept it, just not to loose
the reference to sifive-blocks-ip-versioning.txt, which someone might
find useful.

> As it stands though, patch is an improvement, so:
> Reviewed-by: Conor Dooley <conor.dooley@microchip.com>

Thanks!

Gr{oetje,eeting}s,

                        Geert

-- 
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds

Re: [PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 614 bytes --]

On Wed, May 10, 2023 at 03:27:24PM +0200, Geert Uytterhoeven wrote:
> Replace the sentences in the description listing some supported variants
> by comments on the individual compatible values, to ease future
> maintenance.  While at it, restore alphabetical sort order.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Palmer has assigned this one to me on the RISC-V patchwork, any objections
to me taking it via the riscv-dt tree? There's some other patches for a
new platform thats almost read touching the file too, so (to me) would
probably make sense to take.

Cheers,
Conor.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] dt-bindings: timer: sifive,clint: Clean up compatible value section

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 942 bytes --]

On Thu, May 18, 2023 at 10:10:00PM +0100, Conor Dooley wrote:
> On Wed, May 10, 2023 at 03:27:24PM +0200, Geert Uytterhoeven wrote:
> > Replace the sentences in the description listing some supported variants
> > by comments on the individual compatible values, to ease future
> > maintenance.  While at it, restore alphabetical sort order.
> > 
> > Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> 
> Palmer has assigned this one to me on the RISC-V patchwork, any objections
> to me taking it via the riscv-dt tree? There's some other patches for a
> new platform thats almost read touching the file too, so (to me) would
> probably make sense to take.

Given the silence, I've picked it up. Scream and I can drop it again :)

Applied to riscv-dt-for-next, thanks!

[1/1] dt-bindings: timer: sifive,clint: Clean up compatible value section
      https://git.kernel.org/conor/c/1bd2339df1b5

Thanks,
Conor

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]