diff options
| author | Guenter Roeck <linux@roeck-us.net> | 2016-05-27 14:19:06 -0700 |
|---|---|---|
| committer | Wim Van Sebroeck <wim@iguana.be> | 2016-07-17 21:00:14 +0200 |
| commit | f9f535c1b76128f94dae7a4bb41464aacd4c10ec (patch) | |
| tree | b2ce4e82c3ce2e81dd03adeddd4c8ff1d13df1c3 | |
| parent | c3c1e29c8ad11dec67d01203759272da0d0df3aa (diff) | |
| download | linux-f9f535c1b76128f94dae7a4bb41464aacd4c10ec.tar.gz linux-f9f535c1b76128f94dae7a4bb41464aacd4c10ec.tar.bz2 linux-f9f535c1b76128f94dae7a4bb41464aacd4c10ec.zip | |
watchdog: Improve description of min_hw_heartbeat_ms
The description of min_hw_heartbeat_ms is misleading and needs some
improvements.
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@iguana.be>
| -rw-r--r-- | Documentation/watchdog/watchdog-kernel-api.txt | 5 | ||||
| -rw-r--r-- | include/linux/watchdog.h | 3 |
2 files changed, 5 insertions, 3 deletions
diff --git a/Documentation/watchdog/watchdog-kernel-api.txt b/Documentation/watchdog/watchdog-kernel-api.txt index 917eeeabfa5e..92700d229bf9 100644 --- a/Documentation/watchdog/watchdog-kernel-api.txt +++ b/Documentation/watchdog/watchdog-kernel-api.txt @@ -82,8 +82,9 @@ It contains following fields: * max_timeout: the watchdog timer's maximum timeout value (in seconds), as seen from userspace. If set, the maximum configurable value for 'timeout'. Not used if max_hw_heartbeat_ms is non-zero. -* min_hw_heartbeat_ms: Minimum time between heartbeats sent to the chip, - in milli-seconds. +* min_hw_heartbeat_ms: Hardware limit for minimum time between heartbeats, + in milli-seconds. This value is normally 0; it should only be provided + if the hardware can not tolerate lower intervals between heartbeats. * max_hw_heartbeat_ms: Maximum hardware heartbeat, in milli-seconds. If set, the infrastructure will send heartbeats to the watchdog driver if 'timeout' is larger than max_hw_heartbeat_ms, unless WDOG_ACTIVE diff --git a/include/linux/watchdog.h b/include/linux/watchdog.h index 6b75e38b683f..7047bc7f8106 100644 --- a/include/linux/watchdog.h +++ b/include/linux/watchdog.h @@ -66,7 +66,8 @@ struct watchdog_ops { * as configurable from user space. Only relevant if * max_hw_heartbeat_ms is not provided. * @min_hw_heartbeat_ms: - * Minimum time between heartbeats, in milli-seconds. + * Hardware limit for minimum time between heartbeats, + * in milli-seconds. * @max_hw_heartbeat_ms: * Hardware limit for maximum timeout, in milli-seconds. * Replaces max_timeout if specified. |