From: Wolfram Sang <wsa+renesas@sang-engineering.com>
Date: Mon, 17 Dec 2018 19:33:14 +0000 (+0100)
Subject: watchdog: add documentation for PM usage
X-Git-Tag: v5.0-rc1~74^2~3
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e536f7304badbf15e2099f08b5d47fbbf111a624;p=thirdparty%2Fkernel%2Flinux.git

watchdog: add documentation for PM usage

Add the first rule we recently agreed on.

Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
---

diff --git a/Documentation/watchdog/watchdog-pm.txt b/Documentation/watchdog/watchdog-pm.txt
new file mode 100644
index 0000000000000..7a4dd46e0d244
--- /dev/null
+++ b/Documentation/watchdog/watchdog-pm.txt
@@ -0,0 +1,19 @@
+The Linux WatchDog Timer Power Management Guide
+===============================================
+Last reviewed: 17-Dec-2018
+
+Wolfram Sang <wsa+renesas@sang-engineering.com>
+
+Introduction
+------------
+This document states rules about watchdog devices and their power management
+handling to ensure a uniform behaviour for Linux systems.
+
+
+Ping on resume
+--------------
+On resume, a watchdog timer shall be reset to its selected value to give
+userspace enough time to resume. [1] [2]
+
+[1] https://patchwork.kernel.org/patch/10252209/
+[2] https://patchwork.kernel.org/patch/10711625/