[deliverable/linux.git] / Documentation / devicetree / bindings / power / power-controller.txt

* Generic system power control capability

Power-management integrated circuits or miscellaneous hardware components are
sometimes able to control the system power. The device driver associated with these
components might need to define this capability, which tells the kernel that
it can be used to switch off the system. The corresponding device must have the
standard property "system-power-controller" in its device node. This property
marks the device as able to control the system power. In order to test if this
property is found programmatically, use the helper function
"of_device_is_system_power_controller" from of.h .

Example:

act8846: act8846@5 {
	 compatible = "active-semi,act8846";
	 status = "okay";
	 system-power-controller;
}
Commit	Line	Data
0ce5b307	1	* Generic system power control capability
a88f5c6d	2
0ce5b307 RP	3	Power-management integrated circuits or miscellaneous hardware components are
	4	sometimes able to control the system power. The device driver associated with these
	5	components might need to define this capability, which tells the kernel that
	6	it can be used to switch off the system. The corresponding device must have the
	7	standard property "system-power-controller" in its device node. This property
	8	marks the device as able to control the system power. In order to test if this
	9	property is found programmatically, use the helper function
	10	"of_device_is_system_power_controller" from of.h .
a88f5c6d RP	11
	12	Example:
	13
	14	act8846: act8846@5 {
	15	compatible = "active-semi,act8846";
	16	status = "okay";
0ce5b307	17	system-power-controller;
a88f5c6d	18	}