dt-bindings: Document the standard property "poweroff-source"

Signed-off-by: Romain Perier <romain.perier@gmail.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Romain Perier 2014-10-14 06:31:12 +00:00 committed by Mark Brown
parent 2b17fa2825
commit a88f5c6deb
1 changed files with 18 additions and 0 deletions

View File

@ -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;
}