summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/input/gpio-mouse.yaml
blob: 3928ec6aff1dcd9f990ef61e3814fa30e776d9e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/input/gpio-mouse.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: GPIO attached mouse

description: |
  This simply uses standard GPIO handles to define a simple mouse connected
  to 5-7 GPIO lines.

maintainers:
  - Anshul Dalal <anshulusr@gmail.com>

properties:
  compatible:
    const: gpio-mouse

  scan-interval-ms:
    maxItems: 1

  up-gpios:
    maxItems: 1

  down-gpios:
    maxItems: 1

  left-gpios:
    maxItems: 1

  right-gpios:
    maxItems: 1

  button-left-gpios:
    maxItems: 1

  button-middle-gpios:
    maxItems: 1

  button-right-gpios:
    maxItems: 1

required:
  - compatible
  - scan-interval-ms
  - up-gpios
  - down-gpios
  - left-gpios
  - right-gpios

additionalProperties: false

examples:
  - |
    #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>;
    };