Input: gpio_mouse - add DT bindings
authorLinus Walleij <linus.walleij@linaro.org>
Thu, 19 Oct 2017 23:21:05 +0000 (16:21 -0700)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Fri, 20 Oct 2017 00:08:45 +0000 (17:08 -0700)
This adds DT bindings for simple mice attached to GPIO lines. As the
properties are very general and pertains to all mice I can think of, we use
very generic names for the 4-7 GPIO lines, "up", "down" etc.

Acked-by: Hans-Christian Noren Egtvedt <egtvedt@samfundet.no>
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Documentation/devicetree/bindings/input/gpio-mouse.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/input/gpio-mouse.txt b/Documentation/devicetree/bindings/input/gpio-mouse.txt
new file mode 100644 (file)
index 0000000..519510a
--- /dev/null
@@ -0,0 +1,32 @@
+Device-Tree bindings for GPIO attached mice
+
+This simply uses standard GPIO handles to define a simple mouse connected
+to 5-7 GPIO lines.
+
+Required properties:
+       - compatible: must be "gpio-mouse"
+       - scan-interval-ms: The scanning interval in milliseconds
+       - up-gpios: GPIO line phandle to the line indicating "up"
+       - down-gpios: GPIO line phandle to the line indicating "down"
+       - left-gpios: GPIO line phandle to the line indicating "left"
+       - right-gpios: GPIO line phandle to the line indicating "right"
+
+Optional properties:
+       - button-left-gpios: GPIO line handle to the left mouse button
+       - button-middle-gpios: GPIO line handle to the middle mouse button
+       - button-right-gpios: GPIO line handle to the right mouse button
+Example:
+
+#include <dt-bindings/gpio/gpio.h>
+
+gpio-mouse {
+       compatible = "gpio-mouse";
+       scan-interval-ms = <50>;
+       up-gpios = <&gpio0 0 GPIO_ACTIVE_LOW>;
+       down-gpios = <&gpio0 1 GPIO_ACTIVE_LOW>;
+       left-gpios = <&gpio0 2 GPIO_ACTIVE_LOW>;
+       right-gpios = <&gpio0 3 GPIO_ACTIVE_LOW>;
+       button-left-gpios = <&gpio0 4 GPIO_ACTIVE_LOW>;
+       button-middle-gpios = <&gpio0 5 GPIO_ACTIVE_LOW>;
+       button-right-gpios = <&gpio0 6 GPIO_ACTIVE_LOW>;
+};