summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/power/power-controller.txt
diff options
context:
space:
mode:
authorRomain Perier <romain.perier@gmail.com>2014-11-25 12:28:25 +0000
committerMark Brown <broonie@kernel.org>2014-12-01 19:33:44 +0000
commit8f73110f6bac043026bc923b0a66abe24dd48058 (patch)
tree77fe0fd9bed38af5153ac43baa264b2e931c64a7 /Documentation/devicetree/bindings/power/power-controller.txt
parent7a5f5d7b7ec6ccd2e907534e31c13ca63d2b497f (diff)
downloadlwn-8f73110f6bac043026bc923b0a66abe24dd48058.tar.gz
lwn-8f73110f6bac043026bc923b0a66abe24dd48058.zip
of: Rename "poweroff-source" property to "system-power-controller"
It reverts commit a4b4e0461ec5 ("of: Add standard property for poweroff capability"). As discussed on the mailing list, it makes more sense to rename back to the old established property name, without the vendor prefix. Problem being that the word "source" usually tends to be used for inputs and that is out of control of the OS. The poweroff capability is an output which simply turns the system-power off. Also, this property might be used by drivers which power-off the system and power back on subsequent RTC alarms. This seems to suggest to remove "poweroff" from the property name and to choose "system-power-controller" as the more generic name. This patchs adds the required renaming changes and defines an helper function which checks if this property is set. Signed-off-by: Romain Perier <romain.perier@gmail.com> Acked-by: Grant Likely <grant.likely@linaro.org> Acked-by: Johan Hovold <johan@kernel.org> Signed-off-by: Mark Brown <broonie@kernel.org>
Diffstat (limited to 'Documentation/devicetree/bindings/power/power-controller.txt')
-rw-r--r--Documentation/devicetree/bindings/power/power-controller.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/power/power-controller.txt b/Documentation/devicetree/bindings/power/power-controller.txt
new file mode 100644
index 000000000000..845868bf3273
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/power-controller.txt
@@ -0,0 +1,18 @@
+* Generic Poweroff capability
+
+Power-management integrated circuits or miscellaneous harware components are
+sometimes able to control the system power. The device driver associated to these
+components might needs to define poweroff capability, which tells to the kernel
+how to switch off the system. The corresponding driver must have the standard
+property "poweroff-source" in its device node. This property marks the device as
+able to shutdown the system. In order to test if this property is found
+programmatically, use the helper function "of_system_has_poweroff_source" from
+of.h .
+
+Example:
+
+act8846: act8846@5 {
+ compatible = "active-semi,act8846";
+ status = "okay";
+ poweroff-source;
+}