]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: watchdog: explain watchdog API options
authorShubham Chakraborty <chakrabortyshubham66@gmail.com>
Wed, 11 Mar 2026 12:16:01 +0000 (17:46 +0530)
committerGuenter Roeck <linux@roeck-us.net>
Sun, 3 May 2026 15:45:16 +0000 (08:45 -0700)
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>
Link: https://lore.kernel.org/r/20260311121602.139967-1-chakrabortyshubham66@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Documentation/watchdog/watchdog-api.rst

index 78e228c272cf8f4e3e7dce9a3f24893ec35fe774..984f7362d5fb9e20bcfac93704a08b8370b4dabe 100644 (file)
@@ -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.