power: reset: ltc2952: document optional trigger behavior
authorFrans Klaver <frans.klaver@xsens.com>
Wed, 14 Jan 2015 08:15:46 +0000 (09:15 +0100)
committerSebastian Reichel <sre@kernel.org>
Tue, 20 Jan 2015 12:58:31 +0000 (13:58 +0100)
Document the fact that the trigger signal is now optional, and describe
the behavior when this is used.

While at it, fix a typo, and paraphrase a sentence to be less platform
specific.

Signed-off-by: Frans Klaver <frans.klaver@xsens.com>
Signed-off-by: Sebastian Reichel <sre@kernel.org>
Documentation/devicetree/bindings/power/reset/ltc2952-poweroff.txt

index 0c94c63..cd2d7f5 100644 (file)
@@ -1,20 +1,23 @@
 Binding for the LTC2952 PowerPath controller
 
 This chip is used to externally trigger a system shut down. Once the trigger has
-been sent, the chips' watchdog has to be reset to gracefully shut down.
-If the Linux systems decides to shut down it powers off the platform via the
-kill signal.
+been sent, the chip's watchdog has to be reset to gracefully shut down.
+A full powerdown can be triggered via the kill signal.
 
 Required properties:
 
 - compatible:          Must contain: "lltc,ltc2952"
-- trigger-gpios:       phandle + gpio-specifier for the GPIO connected to the
-                       chip's trigger line
 - watchdog-gpios:      phandle + gpio-specifier for the GPIO connected to the
                        chip's watchdog line
 - kill-gpios:          phandle + gpio-specifier for the GPIO connected to the
                        chip's kill line
 
+Optional properties:
+- trigger-gpios:       phandle + gpio-specifier for the GPIO connected to the
+                       chip's trigger line. If this property is not set, the
+                       trigger function is ignored and the chip is kept alive
+                       until an explicit kill signal is received
+
 Example:
 
 ltc2952 {