[deliverable/linux.git] / Documentation / devicetree / bindings / gpio / gpio_keys.txt

Device-Tree bindings for input/gpio_keys.c keyboard driver

Required properties:
	- compatible = "gpio-keys";

Optional properties:
	- autorepeat: Boolean, Enable auto repeat feature of Linux input
	  subsystem.

Each button (key) is represented as a sub-node of "gpio-keys":
Subnode properties:

	- gpios: OF devcie-tree gpio specificatin.
	- label: Descriptive name of the key.
	- linux,code: Keycode to emit.

Optional subnode-properties:
	- linux,input-type: Specify event type this button/key generates.
	  If not specified defaults to <1> == EV_KEY.
	- debounce-interval: Debouncing interval time in milliseconds.
	  If not specified defaults to 5.
	- gpio-key,wakeup: Boolean, button can wake-up the system.

Example nodes:

	gpio_keys {
			compatible = "gpio-keys";
			#address-cells = <1>;
			#size-cells = <0>;
			autorepeat;
			button@21 {
				label = "GPIO Key UP";
				linux,code = <103>;
				gpios = <&gpio1 0 1>;
			};
			...
Commit	Line	Data
fd05d089 DJ	1	Device-Tree bindings for input/gpio_keys.c keyboard driver
	2
	3	Required properties:
	4	- compatible = "gpio-keys";
	5
	6	Optional properties:
	7	- autorepeat: Boolean, Enable auto repeat feature of Linux input
	8	subsystem.
	9
	10	Each button (key) is represented as a sub-node of "gpio-keys":
	11	Subnode properties:
	12
	13	- gpios: OF devcie-tree gpio specificatin.
	14	- label: Descriptive name of the key.
	15	- linux,code: Keycode to emit.
	16
	17	Optional subnode-properties:
	18	- linux,input-type: Specify event type this button/key generates.
	19	If not specified defaults to <1> == EV_KEY.
	20	- debounce-interval: Debouncing interval time in milliseconds.
	21	If not specified defaults to 5.
	22	- gpio-key,wakeup: Boolean, button can wake-up the system.
	23
	24	Example nodes:
	25
	26	gpio_keys {
	27	compatible = "gpio-keys";
	28	#address-cells = <1>;
	29	#size-cells = <0>;
	30	autorepeat;
	31	button@21 {
	32	label = "GPIO Key UP";
	33	linux,code = <103>;
	34	gpios = <&gpio1 0 1>;
	35	};
	36	...