[1/6] dt-bindings: watchdog: drop duplicated GPIO watchdog bindings

Commit Message

Krzysztof Kozlowski April 15, 2023, 9:51 a.m. UTC

Two conversions to DT schema of GPIO watchdog binding happened and came
through different trees.  Merge them into one:
1. Combine maintainers,
2. Use more descriptive property descriptions and constraints from
   gpio-wdt.yaml,
3. Switch to unevaluatedProperties:false, to allow generic watchdog
   properties.

Signed-off-by: Krzysztof Kozlowski <[e-mail]>
---
 .../bindings/watchdog/gpio-wdt.yaml           | 55 -------------------
 .../bindings/watchdog/linux,wdt-gpio.yaml     | 17 +++++-
 2 files changed, 15 insertions(+), 57 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml

Comments

Guenter Roeck April 16, 2023, 4:04 p.m. UTC | #1

On 4/15/23 02:51, Krzysztof Kozlowski wrote:
> Two conversions to DT schema of GPIO watchdog binding happened and came
> through different trees.  Merge them into one:
> 1. Combine maintainers,
> 2. Use more descriptive property descriptions and constraints from
>     gpio-wdt.yaml,
> 3. Switch to unevaluatedProperties:false, to allow generic watchdog
>     properties.
> 
> Signed-off-by: Krzysztof Kozlowski <[e-mail]>


For the series:

Reviewed-by: Guenter Roeck <[e-mail]>

On a side note, the e-mail addresses in patchwork are messed up for
patches sent by you. As result, I can not reply to your e-mails after
pulling a patch from patchwork. This means that some replies get lost
if I did not keep the original e-mail.

That is how it looks like after I pull one of your patches from patchwork:

To:
+=?unknown-8bit?q?Wim_Van_Sebroeck_=3Cwim=40linux-watchdog=2Eorg=3E=2C_Gu?==?unknown-8bit?q?enter_Roeck_=3Clinux=40roeck-us=2Enet=3E=2C_Rob_Herring_?==?unknown-8bit?q?=3Crobh+dt=40kernel=2Eorg=3E=2C_Krzysztof_Kozlowski_=3Ckrz?==?unknown-8bit?q?yszt
+of=2Ekozlowski+dt=40linaro=2Eorg=3E=2C_Neil_Armstrong_?==?unknown-8bit?q?=3Cneil=2Earmstrong=40linaro=2Eorg=3E=2C_Kevin_Hilman_=3Ck?==?unknown-8bit?q?hilman=40baylibre=2Ecom=3E=2C_Jerome_Brunet_=3Cjbrunet=40b?==?unknown-8bit?q?aylibre=2Ecom=3E=2C_
+Martin_Blumenstingl_=3Cmartin=2Eblumen?==?unknown-8bit?q?stingl=40googlemail=2Ecom=3E=2C_Julius_Werner_=3Cjwerner?==?unknown-8bit?q?=40chromium=2Eorg=3E=2C_Evan_Benn_=3Cevanbenn=40chromium?==?unknown-8bit?q?=2Eorg=3E=2C_Nicolas_Ferre_=3Cnicolas=2E
+ferre=40microchip?==?unknown-8bit?q?=2Ecom=3E=2C_Alexandre_Belloni_=3Calexandre=2Ebelloni=40bo?==?unknown-8bit?q?otlin=2Ecom=3E=2C_Claudiu_Beznea_=3Cclaudiu=2Ebeznea=40mic?==?unknown-8bit?q?rochip=2Ecom=3E=2C_Florian_Fainelli_=3Cf=2Efainelli=40gma
+i?==?unknown-8bit?q?l=

Guenter

> ---
>   .../bindings/watchdog/gpio-wdt.yaml           | 55 -------------------
>   .../bindings/watchdog/linux,wdt-gpio.yaml     | 17 +++++-
>   2 files changed, 15 insertions(+), 57 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml b/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
> deleted file mode 100644
> index 155dc7965e9b..000000000000
> --- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
> +++ /dev/null
> @@ -1,55 +0,0 @@
> -# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> -%YAML 1.2
> ----
> -$id: http://devicetree.org/schemas/watchdog/gpio-wdt.yaml#
> -$schema: http://devicetree.org/meta-schemas/core.yaml#
> -
> -title: GPIO controlled watchdog
> -
> -maintainers:
> -  - Robert Marko <[e-mail]>
> -
> -properties:
> -  compatible:
> -    const: linux,wdt-gpio
> -
> -  gpios:
> -    maxItems: 1
> -    description: GPIO connected to the WDT reset pin
> -
> -  hw_algo:
> -    $ref: /schemas/types.yaml#/definitions/string
> -    description: Algorithm used by the driver
> -    oneOf:
> -      - description:
> -          Either a high-to-low or a low-to-high transition clears the WDT counter.
> -          The watchdog timer is disabled when GPIO is left floating or connected
> -          to a three-state buffer.
> -        const: toggle
> -      - description:
> -          Low or high level starts counting WDT timeout, the opposite level
> -          disables the WDT.
> -          Active level is determined by the GPIO flags.
> -        const: level
> -
> -  hw_margin_ms:
> -    $ref: /schemas/types.yaml#/definitions/uint32
> -    description: Maximum time to reset watchdog circuit (in milliseconds)
> -    minimum: 2
> -    maximum: 65535
> -
> -  always-running:
> -    type: boolean
> -    description:
> -      If the watchdog timer cannot be disabled, add this flag to have the driver
> -      keep toggling the signal without a client.
> -      It will only cease to toggle the signal when the device is open and the
> -      timeout elapsed.
> -
> -required:
> -  - compatible
> -  - gpios
> -  - hw_algo
> -  - hw_margin_ms
> -
> -unevaluatedProperties: false
> diff --git a/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
> index 50af79af6416..499f1b7e03f9 100644
> --- a/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
> +++ b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
> @@ -8,6 +8,7 @@ title: GPIO-controlled Watchdog
>   
>   maintainers:
>     - Guenter Roeck <[e-mail]>
> +  - Robert Marko <[e-mail]>
>   
>   properties:
>     compatible:
> @@ -19,11 +20,23 @@ properties:
>   
>     hw_algo:
>       description: The algorithm used by the driver.
> -    enum: [ level, toggle ]
> +    oneOf:
> +      - description:
> +          Either a high-to-low or a low-to-high transition clears the WDT counter.
> +          The watchdog timer is disabled when GPIO is left floating or connected
> +          to a three-state buffer.
> +        const: toggle
> +      - description:
> +          Low or high level starts counting WDT timeout, the opposite level
> +          disables the WDT.
> +          Active level is determined by the GPIO flags.
> +        const: level
>   
>     hw_margin_ms:
>       description: Maximum time to reset watchdog circuit (milliseconds).
>       $ref: /schemas/types.yaml#/definitions/uint32
> +    minimum: 2
> +    maximum: 65535
>   
>     always-running:
>       type: boolean
> @@ -42,7 +55,7 @@ required:
>   allOf:
>     - $ref: watchdog.yaml#
>   
> -additionalProperties: false
> +unevaluatedProperties: false
>   
>   examples:
>     - |

Krzysztof Kozlowski April 16, 2023, 5:26 p.m. UTC | #2

On 16/04/2023 18:04, Guenter Roeck wrote:
> On 4/15/23 02:51, Krzysztof Kozlowski wrote:
>> Two conversions to DT schema of GPIO watchdog binding happened and came
>> through different trees.  Merge them into one:
>> 1. Combine maintainers,
>> 2. Use more descriptive property descriptions and constraints from
>>     gpio-wdt.yaml,
>> 3. Switch to unevaluatedProperties:false, to allow generic watchdog
>>     properties.
>>
>> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> 
> 
> For the series:
> 
> Reviewed-by: Guenter Roeck <[e-mail]>
> 
> On a side note, the e-mail addresses in patchwork are messed up for
> patches sent by you. As result, I can not reply to your e-mails after
> pulling a patch from patchwork. This means that some replies get lost
> if I did not keep the original e-mail.
> 
> That is how it looks like after I pull one of your patches from patchwork:
> 
> To:
> +=?unknown-8bit?q?Wim_Van_Sebroeck_=3Cwim=40linux-watchdog=2Eorg=3E=2C_Gu?==?unknown-8bit?q?enter_Roeck_=3Clinux=40roeck-us=2Enet=3E=2C_Rob_Herring_?==?unknown-8bit?q?=3Crobh+dt=40kernel=2Eorg=3E=2C_Krzysztof_Kozlowski_=3Ckrz?==?unknown-8bit?q?yszt

(Trimmed cc list)

Thanks for letting me know, I wonder what's the problem. I am sending
with send-email exactly the same way every day, but somehow this series
have such header in Patchwork:
https://patchwork.kernel.org/project/linux-watchdog/patch/[e-mail]/

Which I do not see in:
1. lore:
https://lore.kernel.org/all/[e-mail]/

2. Previous patches on Patchwork:
https://patchwork.kernel.org/project/linux-watchdog/patch/[e-mail]/

Lore (1 above) points to possible unescaped UTF character for
[e-mail], but I wonder why send-email did not handle it.

Best regards,
Krzysztof

Rob Herring April 18, 2023, 9:23 p.m. UTC | #3

On Sat, 15 Apr 2023 11:51:07 +0200, Krzysztof Kozlowski wrote:
> Two conversions to DT schema of GPIO watchdog binding happened and came
> through different trees.  Merge them into one:
> 1. Combine maintainers,
> 2. Use more descriptive property descriptions and constraints from
>    gpio-wdt.yaml,
> 3. Switch to unevaluatedProperties:false, to allow generic watchdog
>    properties.
> 
> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> ---
>  .../bindings/watchdog/gpio-wdt.yaml           | 55 -------------------
>  .../bindings/watchdog/linux,wdt-gpio.yaml     | 17 +++++-
>  2 files changed, 15 insertions(+), 57 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
> 

Reviewed-by: Rob Herring <[e-mail]>

Rob Herring April 18, 2023, 9:35 p.m. UTC | #4

On Sun, Apr 16, 2023 at 07:26:27PM +0200, Krzysztof Kozlowski wrote:
> On 16/04/2023 18:04, Guenter Roeck wrote:
> > On 4/15/23 02:51, Krzysztof Kozlowski wrote:
> >> Two conversions to DT schema of GPIO watchdog binding happened and came
> >> through different trees.  Merge them into one:
> >> 1. Combine maintainers,
> >> 2. Use more descriptive property descriptions and constraints from
> >>     gpio-wdt.yaml,
> >> 3. Switch to unevaluatedProperties:false, to allow generic watchdog
> >>     properties.
> >>
> >> Signed-off-by: Krzysztof Kozlowski <[e-mail]>
> > 
> > 
> > For the series:
> > 
> > Reviewed-by: Guenter Roeck <[e-mail]>
> > 
> > On a side note, the e-mail addresses in patchwork are messed up for
> > patches sent by you. As result, I can not reply to your e-mails after
> > pulling a patch from patchwork. This means that some replies get lost
> > if I did not keep the original e-mail.
> > 
> > That is how it looks like after I pull one of your patches from patchwork:
> > 
> > To:
> > +=?unknown-8bit?q?Wim_Van_Sebroeck_=3Cwim=40linux-watchdog=2Eorg=3E=2C_Gu?==?unknown-8bit?q?enter_Roeck_=3Clinux=40roeck-us=2Enet=3E=2C_Rob_Herring_?==?unknown-8bit?q?=3Crobh+dt=40kernel=2Eorg=3E=2C_Krzysztof_Kozlowski_=3Ckrz?==?unknown-8bit?q?yszt
> 
> (Trimmed cc list)
> 
> Thanks for letting me know, I wonder what's the problem. I am sending
> with send-email exactly the same way every day, but somehow this series
> have such header in Patchwork:
> https://patchwork.kernel.org/project/linux-watchdog/patch/[e-mail]/
> 
> Which I do not see in:
> 1. lore:
> https://lore.kernel.org/all/[e-mail]/
> 
> 2. Previous patches on Patchwork:
> https://patchwork.kernel.org/project/linux-watchdog/patch/[e-mail]/
> 
> Lore (1 above) points to possible unescaped UTF character for
> [e-mail], but I wonder why send-email did not handle it.

Looks to me like Content-Type header is missing. Usually, I get a prompt 
from git-send-email with what encoding to use if it needs to use UTF8.

Rob

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml b/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
deleted file mode 100644
index 155dc7965e9b..000000000000
--- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.yaml
+++ /dev/null
@@ -1,55 +0,0 @@ 
-# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
-%YAML 1.2
----
-$id: http://devicetree.org/schemas/watchdog/gpio-wdt.yaml#
-$schema: http://devicetree.org/meta-schemas/core.yaml#
-
-title: GPIO controlled watchdog
-
-maintainers:
-  - Robert Marko <[e-mail]>
-
-properties:
-  compatible:
-    const: linux,wdt-gpio
-
-  gpios:
-    maxItems: 1
-    description: GPIO connected to the WDT reset pin
-
-  hw_algo:
-    $ref: /schemas/types.yaml#/definitions/string
-    description: Algorithm used by the driver
-    oneOf:
-      - description:
-          Either a high-to-low or a low-to-high transition clears the WDT counter.
-          The watchdog timer is disabled when GPIO is left floating or connected
-          to a three-state buffer.
-        const: toggle
-      - description:
-          Low or high level starts counting WDT timeout, the opposite level
-          disables the WDT.
-          Active level is determined by the GPIO flags.
-        const: level
-
-  hw_margin_ms:
-    $ref: /schemas/types.yaml#/definitions/uint32
-    description: Maximum time to reset watchdog circuit (in milliseconds)
-    minimum: 2
-    maximum: 65535
-
-  always-running:
-    type: boolean
-    description:
-      If the watchdog timer cannot be disabled, add this flag to have the driver
-      keep toggling the signal without a client.
-      It will only cease to toggle the signal when the device is open and the
-      timeout elapsed.
-
-required:
-  - compatible
-  - gpios
-  - hw_algo
-  - hw_margin_ms
-
-unevaluatedProperties: false
diff --git a/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
index 50af79af6416..499f1b7e03f9 100644
--- a/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
+++ b/Documentation/devicetree/bindings/watchdog/linux,wdt-gpio.yaml
@@ -8,6 +8,7 @@  title: GPIO-controlled Watchdog
 
 maintainers:
   - Guenter Roeck <[e-mail]>
+  - Robert Marko <[e-mail]>
 
 properties:
   compatible:
@@ -19,11 +20,23 @@  properties:
 
   hw_algo:
     description: The algorithm used by the driver.
-    enum: [ level, toggle ]
+    oneOf:
+      - description:
+          Either a high-to-low or a low-to-high transition clears the WDT counter.
+          The watchdog timer is disabled when GPIO is left floating or connected
+          to a three-state buffer.
+        const: toggle
+      - description:
+          Low or high level starts counting WDT timeout, the opposite level
+          disables the WDT.
+          Active level is determined by the GPIO flags.
+        const: level
 
   hw_margin_ms:
     description: Maximum time to reset watchdog circuit (milliseconds).
     $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 2
+    maximum: 65535
 
   always-running:
     type: boolean
@@ -42,7 +55,7 @@  required:
 allOf:
   - $ref: watchdog.yaml#
 
-additionalProperties: false
+unevaluatedProperties: false
 
 examples:
   - |