Documentation: devicetree: fix reference to legacy wakeup properties
[firefly-linux-kernel-4.4.55.git] / Documentation / devicetree / bindings / input / gpio-keys-polled.txt
1 Device-Tree bindings for input/gpio_keys_polled.c keyboard driver
2
3 Required properties:
4         - compatible = "gpio-keys-polled";
5         - poll-interval: Poll interval time in milliseconds
6
7 Optional properties:
8         - autorepeat: Boolean, Enable auto repeat feature of Linux input
9           subsystem.
10
11 Each button (key) is represented as a sub-node of "gpio-keys-polled":
12 Subnode properties:
13
14         - gpios: OF device-tree gpio specification.
15         - label: Descriptive name of the key.
16         - linux,code: Keycode to emit.
17
18 Optional subnode-properties:
19         - linux,input-type: Specify event type this button/key generates.
20           If not specified defaults to <1> == EV_KEY.
21         - debounce-interval: Debouncing interval time in milliseconds.
22           If not specified defaults to 5.
23         - wakeup-source: Boolean, button can wake-up the system.
24                          (Legacy property supported: "gpio-key,wakeup")
25
26 Example nodes:
27
28         gpio_keys_polled {
29                         compatible = "gpio-keys-polled";
30                         #address-cells = <1>;
31                         #size-cells = <0>;
32                         poll-interval = <100>;
33                         autorepeat;
34                         button@21 {
35                                 label = "GPIO Key UP";
36                                 linux,code = <103>;
37                                 gpios = <&gpio1 0 1>;
38                         };
39                         ...