diff mbox series

[1/2] dt-bindings: watchdog: gpio-wdt: add "start-at-boot"

Message ID 20210421162621.24910-2-francesco.zanella@vimar.com (mailing list archive)
State New
Headers show
Series GPIO WDT "start-at-boot" property | expand

Commit Message

Francesco Zanella April 21, 2021, 4:26 p.m. UTC
Documentation for new device tree property "start-at-boot".

Signed-off-by: Francesco Zanella <francesco.zanella@vimar.com>
---
 Documentation/devicetree/bindings/watchdog/gpio-wdt.txt | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Guenter Roeck April 21, 2021, 4:37 p.m. UTC | #1
On Wed, Apr 21, 2021 at 06:26:20PM +0200, Francesco Zanella wrote:
> Documentation for new device tree property "start-at-boot".
> 
> Signed-off-by: Francesco Zanella <francesco.zanella@vimar.com>
> ---
>  Documentation/devicetree/bindings/watchdog/gpio-wdt.txt | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
> index 198794963786..cdaf7f0602e8 100644
> --- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
> +++ b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
> @@ -17,6 +17,13 @@ Optional Properties:
>  - always-running: 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.
> +- start-at-boot: Start pinging hw watchdog at probe, in order to take advantage
> +  of kernel configs:
> +  - WATCHDOG_HANDLE_BOOT_ENABLED: Avoid possible reboot if hw watchdog was been
> +    enabled before the kernel (by uboot for example) and userspace doesn't take
> +    control of /dev/watchdog in time;
> +  - WATCHDOG_OPEN_TIMEOUT: Reboot if userspace doesn't take control of
> +    /dev/watchdog within the timeout.

You are not supposed to refer to Linux kernel details in devicetree
bindings documents.

Guenter

>  
>  Example:
>  	watchdog: watchdog {
> -- 
> 2.17.1
>
Francesco Zanella April 22, 2021, 4:28 p.m. UTC | #2
On 21/04/21 18:37, Guenter Roeck wrote:
> On Wed, Apr 21, 2021 at 06:26:20PM +0200, Francesco Zanella wrote:
>> Documentation for new device tree property "start-at-boot".
>>
>> Signed-off-by: Francesco Zanella <francesco.zanella@vimar.com>
>> ---
>>  Documentation/devicetree/bindings/watchdog/gpio-wdt.txt | 7 +++++++
>>  1 file changed, 7 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
>> index 198794963786..cdaf7f0602e8 100644
>> --- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
>> +++ b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
>> @@ -17,6 +17,13 @@ Optional Properties:
>>  - always-running: 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.
>> +- start-at-boot: Start pinging hw watchdog at probe, in order to take advantage
>> +  of kernel configs:
>> +  - WATCHDOG_HANDLE_BOOT_ENABLED: Avoid possible reboot if hw watchdog was been
>> +    enabled before the kernel (by uboot for example) and userspace doesn't take
>> +    control of /dev/watchdog in time;
>> +  - WATCHDOG_OPEN_TIMEOUT: Reboot if userspace doesn't take control of
>> +    /dev/watchdog within the timeout.
> 
> You are not supposed to refer to Linux kernel details in devicetree
> bindings documents.
> 
> Guenter
> 
>>  
>>  Example:
>>  	watchdog: watchdog {
>> -- 
>> 2.17.1
>>

OK, I'm sorry. I will resend the patch series without kernel configs
references in documents.

Francesco
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
index 198794963786..cdaf7f0602e8 100644
--- a/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
+++ b/Documentation/devicetree/bindings/watchdog/gpio-wdt.txt
@@ -17,6 +17,13 @@  Optional Properties:
 - always-running: 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.
+- start-at-boot: Start pinging hw watchdog at probe, in order to take advantage
+  of kernel configs:
+  - WATCHDOG_HANDLE_BOOT_ENABLED: Avoid possible reboot if hw watchdog was been
+    enabled before the kernel (by uboot for example) and userspace doesn't take
+    control of /dev/watchdog in time;
+  - WATCHDOG_OPEN_TIMEOUT: Reboot if userspace doesn't take control of
+    /dev/watchdog within the timeout.
 
 Example:
 	watchdog: watchdog {