[PATCH] docs: watchdog: explain watchdog API options

Shubham Chakraborty posted 1 patch 3 weeks, 6 days ago
Documentation/watchdog/watchdog-api.rst | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
[PATCH] docs: watchdog: explain watchdog API options
Posted by Shubham Chakraborty 3 weeks, 6 days ago
Replace FIXME comment with proper documentation for
WDIOS_DISABLECARD, WDIOS_ENABLECARD, and WDIOS_TEMPPANIC
options.

Signed-off-by: Shubham Chakraborty <chakrabortyshubham66@gmail.com>
---
 Documentation/watchdog/watchdog-api.rst | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/Documentation/watchdog/watchdog-api.rst b/Documentation/watchdog/watchdog-api.rst
index 78e228c272cf..984f7362d5fb 100644
--- a/Documentation/watchdog/watchdog-api.rst
+++ b/Documentation/watchdog/watchdog-api.rst
@@ -268,4 +268,13 @@ The following options are available:
 	WDIOS_TEMPPANIC		Kernel panic on temperature trip
 	=================	================================
 
-[FIXME -- better explanations]
+The WDIOS_DISABLECARD option allows you to stop the watchdog timer via
+software. Note that this will only work if the "nowayout" module parameter
+(or CONFIG_WATCHDOG_NOWAYOUT) is not set.
+
+The WDIOS_ENABLECARD option turns on the watchdog timer.
+
+The WDIOS_TEMPPANIC option is used by some drivers (like the pcwd driver)
+to trigger a system halt (typically a kernel panic or power off) when the
+temperature trip point is reached. This ensures that the system is halted
+immediately in case of an overheat condition.
-- 
2.53.0
Re: [PATCH] docs: watchdog: explain watchdog API options
Posted by Guenter Roeck 2 weeks ago
On 3/11/26 05:16, Shubham Chakraborty wrote:
> Replace FIXME comment with proper documentation for
> WDIOS_DISABLECARD, WDIOS_ENABLECARD, and WDIOS_TEMPPANIC
> options.
> 
> Signed-off-by: Shubham Chakraborty <chakrabortyshubham66@gmail.com>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
>   Documentation/watchdog/watchdog-api.rst | 11 ++++++++++-
>   1 file changed, 10 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/watchdog/watchdog-api.rst b/Documentation/watchdog/watchdog-api.rst
> index 78e228c272cf..984f7362d5fb 100644
> --- a/Documentation/watchdog/watchdog-api.rst
> +++ b/Documentation/watchdog/watchdog-api.rst
> @@ -268,4 +268,13 @@ The following options are available:
>   	WDIOS_TEMPPANIC		Kernel panic on temperature trip
>   	=================	================================
>   
> -[FIXME -- better explanations]
> +The WDIOS_DISABLECARD option allows you to stop the watchdog timer via
> +software. Note that this will only work if the "nowayout" module parameter
> +(or CONFIG_WATCHDOG_NOWAYOUT) is not set.
> +
> +The WDIOS_ENABLECARD option turns on the watchdog timer.
> +
> +The WDIOS_TEMPPANIC option is used by some drivers (like the pcwd driver)
> +to trigger a system halt (typically a kernel panic or power off) when the
> +temperature trip point is reached. This ensures that the system is halted
> +immediately in case of an overheat condition.