GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / input / elan,ekth3000.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/input/elan,ekth3000.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Elantech I2C Touchpad
8
9 maintainers:
10   - Dmitry Torokhov <dmitry.torokhov@gmail.com>
11
12 allOf:
13   - $ref: touchscreen/touchscreen.yaml#
14
15 properties:
16   compatible:
17     const: elan,ekth3000
18
19   reg:
20     maxItems: 1
21
22   interrupts:
23     maxItems: 1
24
25   wakeup-source:
26     type: boolean
27     description: touchpad can be used as a wakeup source
28
29   vcc-supply:
30     description: a phandle for the regulator supplying 3.3V power
31
32   elan,trackpoint:
33     type: boolean
34     description: touchpad can support a trackpoint
35
36   elan,clickpad:
37     type: boolean
38     description: touchpad is a clickpad (the entire surface is a button)
39
40   elan,middle-button:
41     type: boolean
42     description: touchpad has a physical middle button
43
44   elan,x_traces:
45     $ref: /schemas/types.yaml#/definitions/uint32
46     description: number of antennas on the x axis
47
48   elan,y_traces:
49     $ref: /schemas/types.yaml#/definitions/uint32
50     description: number of antennas on the y axis
51
52   touchscreen-size-x: true
53
54   touchscreen-size-y: true
55
56   touchscreen-x-mm: true
57
58   touchscreen-y-mm: true
59
60 required:
61   - compatible
62   - reg
63   - interrupts
64
65 additionalProperties: false
66
67 examples:
68   - |
69     #include <dt-bindings/interrupt-controller/irq.h>
70     i2c {
71         #address-cells = <1>;
72         #size-cells = <0>;
73
74         touchpad@15 {
75             compatible = "elan,ekth3000";
76             reg = <0x15>;
77             interrupt-parent = <&gpio4>;
78             interrupts = <0x0 IRQ_TYPE_EDGE_FALLING>;
79             wakeup-source;
80         };
81     };