xref: /linux/Documentation/devicetree/bindings/power/wakeup-source.txt (revision e5c86679d5e864947a52fb31e45a425dea3e7fa9) 
1Specifying wakeup capability for devices
2============================================
3
4Any device nodes
5----------------
6Nodes that describe devices which has wakeup capability must contain an
7"wakeup-source" boolean property.
8
9Also, if device is marked as a wakeup source, then all the primary
10interrupt(s) can be used as wakeup interrupt(s).
11
12However if the devices have dedicated interrupt as the wakeup source
13then they need to specify/identify the same using device specific
14interrupt name. In such cases only that interrupt can be used as wakeup
15interrupt.
16
17List of legacy properties and respective binding document
18---------------------------------------------------------
19
201. "enable-sdio-wakeup"		Documentation/devicetree/bindings/mmc/mmc.txt
212. "gpio-key,wakeup"		Documentation/devicetree/bindings/input/gpio-keys{,-polled}.txt
223. "has-tpo"			Documentation/devicetree/bindings/rtc/rtc-opal.txt
234. "isil,irq2-can-wakeup-machine" Documentation/devicetree/bindings/rtc/isil,isl12057.txt
245. "linux,wakeup"		Documentation/devicetree/bindings/input/gpio-matrix-keypad.txt
25				Documentation/devicetree/bindings/mfd/tc3589x.txt
26				Documentation/devicetree/bindings/input/ads7846.txt
276. "linux,keypad-wakeup"	Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt
287. "linux,input-wakeup"		Documentation/devicetree/bindings/input/samsung-keypad.txt
298. "nvidia,wakeup-source"	Documentation/devicetree/bindings/input/nvidia,tegra20-kbc.txt
30
31Examples
32--------
33
341. With "wakeup" interrupt name
35
36	device@10000 {
37		compatible	= "vendor,device-id";
38		reg		= <0x10000 0x1000>;
39		interrupts	= <0 19 4>, <0 21 4>, <0 22 4>;
40		interrupt-names	= "ack", "err", "wakeup";
41		wakeup-source;
42	};
43
442. Without "wakeup" interrupt name
45
46	embedded-controller {
47		compatible = "google,cros-ec-i2c";
48		reg = <0x1e>;
49		interrupts = <6 0>;
50		interrupt-parent = <&gpx1>;
51		pinctrl-names = "default";
52		pinctrl-0 = <&ec_irq>;
53		wakeup-source;
54	};
55
563. Without interrupts
57
58	gpio_keys {
59		compatible = "gpio-keys";
60		#address-cells = <1>;
61		#size-cells = <0>;
62
63		button@1 {
64			debounce_interval = <50>;
65			wakeup-source;
66			linux,code = <116>;
67			label = "POWER";
68			gpios = <&iofpga_gpio0 0 0x4>;
69		};
70		[....]
71	};
72