github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-07-28 10:09:10 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: watchdog: explain watchdog API options

Browse Source 
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>
This commit is contained in:
Shubham Chakraborty 2026-03-11 17:46:01 +05:30 committed by Guenter Roeck
parent 5abb70c8f7
commit 63077abe9c
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/watchdog/watchdog-api.rst
View 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.