xref: /openbmc/linux/Documentation/devicetree/bindings/input/gpio-mouse.txt (revision 7e86548e2cc8d308cb75439480f428137151b0de)
1*055f624eSLinus WalleijDevice-Tree bindings for GPIO attached mice
2*055f624eSLinus Walleij
3*055f624eSLinus WalleijThis simply uses standard GPIO handles to define a simple mouse connected
4*055f624eSLinus Walleijto 5-7 GPIO lines.
5*055f624eSLinus Walleij
6*055f624eSLinus WalleijRequired properties:
7*055f624eSLinus Walleij	- compatible: must be "gpio-mouse"
8*055f624eSLinus Walleij	- scan-interval-ms: The scanning interval in milliseconds
9*055f624eSLinus Walleij	- up-gpios: GPIO line phandle to the line indicating "up"
10*055f624eSLinus Walleij	- down-gpios: GPIO line phandle to the line indicating "down"
11*055f624eSLinus Walleij	- left-gpios: GPIO line phandle to the line indicating "left"
12*055f624eSLinus Walleij	- right-gpios: GPIO line phandle to the line indicating "right"
13*055f624eSLinus Walleij
14*055f624eSLinus WalleijOptional properties:
15*055f624eSLinus Walleij	- button-left-gpios: GPIO line handle to the left mouse button
16*055f624eSLinus Walleij	- button-middle-gpios: GPIO line handle to the middle mouse button
17*055f624eSLinus Walleij	- button-right-gpios: GPIO line handle to the right mouse button
18*055f624eSLinus WalleijExample:
19*055f624eSLinus Walleij
20*055f624eSLinus Walleij#include <dt-bindings/gpio/gpio.h>
21*055f624eSLinus Walleij
22*055f624eSLinus Walleijgpio-mouse {
23*055f624eSLinus Walleij	compatible = "gpio-mouse";
24*055f624eSLinus Walleij	scan-interval-ms = <50>;
25*055f624eSLinus Walleij	up-gpios = <&gpio0 0 GPIO_ACTIVE_LOW>;
26*055f624eSLinus Walleij	down-gpios = <&gpio0 1 GPIO_ACTIVE_LOW>;
27*055f624eSLinus Walleij	left-gpios = <&gpio0 2 GPIO_ACTIVE_LOW>;
28*055f624eSLinus Walleij	right-gpios = <&gpio0 3 GPIO_ACTIVE_LOW>;
29*055f624eSLinus Walleij	button-left-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;
30*055f624eSLinus Walleij	button-middle-gpios = <&gpio0 5 GPIO_ACTIVE_LOW>;
31*055f624eSLinus Walleij	button-right-gpios = <&gpio0 6 GPIO_ACTIVE_LOW>;
32*055f624eSLinus Walleij};
33