The Devicetree bindings coding convention, as used in most of the files
and expressed in Documentation/devicetree/bindings/example-schema.yaml,
expects:
1. "allOf:" block just before "properties:" (or after "required:" for
more complex cases),
2. additionalProperties/unevaluatedProperties at the end of the file,
just before the examples section.
Re-order few schemas to match the convention to avoid repeating review
comments for new patches using existing code as template. No functional
changes.
Signed-off-by: Krzysztof Kozlowski <[email protected]>
---
.../bindings/watchdog/allwinner,sun4i-a10-wdt.yaml | 6 +++---
.../bindings/watchdog/alphascale,asm9260-wdt.yaml | 6 +++---
.../devicetree/bindings/watchdog/apple,wdt.yaml | 6 +++---
.../devicetree/bindings/watchdog/arm-smc-wdt.yaml | 6 +++---
.../devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml | 10 +++++-----
.../devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml | 6 +++---
.../devicetree/bindings/watchdog/maxim,max63xx.yaml | 8 ++++----
.../devicetree/bindings/watchdog/snps,dw-wdt.yaml | 10 +++++-----
8 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
index 274519fc24fd..64c8f7393809 100644
--- a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
@@ -6,13 +6,13 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: Allwinner A10 Watchdog
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Chen-Yu Tsai <[email protected]>
- Maxime Ripard <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
oneOf:
diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
index fea84f5b7e6d..6425fe51d20c 100644
--- a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
@@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: Alphascale asm9260 Watchdog timer
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Oleksij Rempel <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
const: alphascale,asm9260-wdt
diff --git a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
index 929681127df0..21872e15916c 100644
--- a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
@@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: Apple SoC Watchdog
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Sven Peter <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
items:
diff --git a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
index b5573852ef5a..8e9d0b7e8244 100644
--- a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
@@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: ARM Secure Monitor Call based watchdog
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Julius Werner <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
enum:
diff --git a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
index 526ff908d134..e898167ef628 100644
--- a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
@@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: BCM63xx and BCM7038 watchdog timer
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Florian Fainelli <[email protected]>
- Justin Chen <[email protected]>
- Rafał Miłecki <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
enum:
@@ -29,11 +29,11 @@ properties:
The clock running the watchdog. If no clock is found the driver will
default to 27000000 Hz.
-unevaluatedProperties: false
-
required:
- reg
+unevaluatedProperties: false
+
examples:
- |
watchdog@f040a7e8 {
diff --git a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
index 1844d7e026fe..13236ee61f6f 100644
--- a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
@@ -12,12 +12,12 @@ description: |
timer counters. The first timer (called "Timer A") is the only one that can be
used as watchdog.
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Baruch Siach <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
const: cnxt,cx92755-wdt
diff --git a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
index 1a6490c43d89..442c21f12a3b 100644
--- a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
+++ b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
@@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: Maxim 63xx Watchdog Timers
-allOf:
- - $ref: watchdog.yaml#
- - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml#
-
maintainers:
- Marc Zyngier <[email protected]>
- Linus Walleij <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+ - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml#
+
properties:
compatible:
enum:
diff --git a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
index 76eceeddd150..c7aab0418a32 100644
--- a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
@@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
title: Synopsys Designware Watchdog Timer
-allOf:
- - $ref: watchdog.yaml#
-
maintainers:
- Jamie Iles <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
oneOf:
@@ -73,13 +73,13 @@ properties:
minItems: 16
maxItems: 16
-unevaluatedProperties: false
-
required:
- compatible
- reg
- clocks
+unevaluatedProperties: false
+
examples:
- |
watchdog@ffd02000 {
--
2.34.1
Reference common watchdog.yaml schema to allow "timeout-sec" property
and enforce proper device node name.
Signed-off-by: Krzysztof Kozlowski <[email protected]>
---
.../devicetree/bindings/watchdog/intel,keembay-wdt.yaml | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml b/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
index 1437ff8a122f..8231dde2bfa6 100644
--- a/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
+++ b/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
@@ -9,6 +9,9 @@ title: Intel Keem Bay SoC non-secure Watchdog Timer
maintainers:
- Wan Ahmad Zainie <[email protected]>
+allOf:
+ - $ref: watchdog.yaml#
+
properties:
compatible:
enum:
@@ -37,7 +40,7 @@ required:
- interrupt-names
- clocks
-additionalProperties: false
+unevaluatedProperties: false
examples:
- |
--
2.34.1
On 11/5/23 10:41, Krzysztof Kozlowski wrote:
> The Devicetree bindings coding convention, as used in most of the files
> and expressed in Documentation/devicetree/bindings/example-schema.yaml,
> expects:
> 1. "allOf:" block just before "properties:" (or after "required:" for
> more complex cases),
> 2. additionalProperties/unevaluatedProperties at the end of the file,
> just before the examples section.
>
> Re-order few schemas to match the convention to avoid repeating review
> comments for new patches using existing code as template. No functional
> changes.
>
> Signed-off-by: Krzysztof Kozlowski <[email protected]>
Acked-by: Guenter Roeck <[email protected]>
> ---
> .../bindings/watchdog/allwinner,sun4i-a10-wdt.yaml | 6 +++---
> .../bindings/watchdog/alphascale,asm9260-wdt.yaml | 6 +++---
> .../devicetree/bindings/watchdog/apple,wdt.yaml | 6 +++---
> .../devicetree/bindings/watchdog/arm-smc-wdt.yaml | 6 +++---
> .../devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml | 10 +++++-----
> .../devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml | 6 +++---
> .../devicetree/bindings/watchdog/maxim,max63xx.yaml | 8 ++++----
> .../devicetree/bindings/watchdog/snps,dw-wdt.yaml | 10 +++++-----
> 8 files changed, 29 insertions(+), 29 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
> index 274519fc24fd..64c8f7393809 100644
> --- a/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/allwinner,sun4i-a10-wdt.yaml
> @@ -6,13 +6,13 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: Allwinner A10 Watchdog
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Chen-Yu Tsai <[email protected]>
> - Maxime Ripard <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> oneOf:
> diff --git a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
> index fea84f5b7e6d..6425fe51d20c 100644
> --- a/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/alphascale,asm9260-wdt.yaml
> @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: Alphascale asm9260 Watchdog timer
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Oleksij Rempel <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> const: alphascale,asm9260-wdt
> diff --git a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
> index 929681127df0..21872e15916c 100644
> --- a/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/apple,wdt.yaml
> @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: Apple SoC Watchdog
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Sven Peter <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> items:
> diff --git a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
> index b5573852ef5a..8e9d0b7e8244 100644
> --- a/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/arm-smc-wdt.yaml
> @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: ARM Secure Monitor Call based watchdog
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Julius Werner <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> enum:
> diff --git a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
> index 526ff908d134..e898167ef628 100644
> --- a/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/brcm,bcm7038-wdt.yaml
> @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: BCM63xx and BCM7038 watchdog timer
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Florian Fainelli <[email protected]>
> - Justin Chen <[email protected]>
> - Rafał Miłecki <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> enum:
> @@ -29,11 +29,11 @@ properties:
> The clock running the watchdog. If no clock is found the driver will
> default to 27000000 Hz.
>
> -unevaluatedProperties: false
> -
> required:
> - reg
>
> +unevaluatedProperties: false
> +
> examples:
> - |
> watchdog@f040a7e8 {
> diff --git a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
> index 1844d7e026fe..13236ee61f6f 100644
> --- a/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/cnxt,cx92755-wdt.yaml
> @@ -12,12 +12,12 @@ description: |
> timer counters. The first timer (called "Timer A") is the only one that can be
> used as watchdog.
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Baruch Siach <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> const: cnxt,cx92755-wdt
> diff --git a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
> index 1a6490c43d89..442c21f12a3b 100644
> --- a/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/maxim,max63xx.yaml
> @@ -6,14 +6,14 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: Maxim 63xx Watchdog Timers
>
> -allOf:
> - - $ref: watchdog.yaml#
> - - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml#
> -
> maintainers:
> - Marc Zyngier <[email protected]>
> - Linus Walleij <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> + - $ref: /schemas/memory-controllers/mc-peripheral-props.yaml#
> +
> properties:
> compatible:
> enum:
> diff --git a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
> index 76eceeddd150..c7aab0418a32 100644
> --- a/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/snps,dw-wdt.yaml
> @@ -6,12 +6,12 @@ $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> title: Synopsys Designware Watchdog Timer
>
> -allOf:
> - - $ref: watchdog.yaml#
> -
> maintainers:
> - Jamie Iles <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> oneOf:
> @@ -73,13 +73,13 @@ properties:
> minItems: 16
> maxItems: 16
>
> -unevaluatedProperties: false
> -
> required:
> - compatible
> - reg
> - clocks
>
> +unevaluatedProperties: false
> +
> examples:
> - |
> watchdog@ffd02000 {
On 11/5/23 10:41, Krzysztof Kozlowski wrote:
> Reference common watchdog.yaml schema to allow "timeout-sec" property
> and enforce proper device node name.
>
> Signed-off-by: Krzysztof Kozlowski <[email protected]>
Acked-by: Guenter Roeck <[email protected]>
> ---
> .../devicetree/bindings/watchdog/intel,keembay-wdt.yaml | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml b/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
> index 1437ff8a122f..8231dde2bfa6 100644
> --- a/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/intel,keembay-wdt.yaml
> @@ -9,6 +9,9 @@ title: Intel Keem Bay SoC non-secure Watchdog Timer
> maintainers:
> - Wan Ahmad Zainie <[email protected]>
>
> +allOf:
> + - $ref: watchdog.yaml#
> +
> properties:
> compatible:
> enum:
> @@ -37,7 +40,7 @@ required:
> - interrupt-names
> - clocks
>
> -additionalProperties: false
> +unevaluatedProperties: false
>
> examples:
> - |
On 2023-11-05 19:41, Krzysztof Kozlowski wrote:
> The Devicetree bindings coding convention, as used in most of the files
> and expressed in Documentation/devicetree/bindings/example-schema.yaml,
> expects:
> 1. "allOf:" block just before "properties:" (or after "required:" for
> more complex cases),
> 2. additionalProperties/unevaluatedProperties at the end of the file,
> just before the examples section.
>
> Re-order few schemas to match the convention to avoid repeating review
> comments for new patches using existing code as template. No
> functional
> changes.
It's surely going to help a bit but for a long time solution maybe you
could consider adding proper check to Rob's bot and/or checkpatch.pl.
--
Rafał Miłecki