GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / input / touchscreen / edt-ft5x06.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/input/touchscreen/edt-ft5x06.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: FocalTech EDT-FT5x06 Polytouch Bindings
8
9 description: |
10              There are 5 variants of the chip for various touch panel sizes
11               FT5206GE1  2.8" .. 3.8"
12               FT5306DE4  4.3" .. 7"
13               FT5406EE8  7"   .. 8.9"
14               FT5506EEG  7"   .. 8.9"
15               FT5726NEI  5.7” .. 11.6"
16
17 maintainers:
18   - Dmitry Torokhov <dmitry.torokhov@gmail.com>
19
20 allOf:
21   - $ref: touchscreen.yaml#
22   - if:
23       properties:
24         compatible:
25           contains:
26             enum:
27               - evervision,ev-ft5726
28
29     then:
30       properties:
31         offset-x: true
32         offset-y: true
33
34 properties:
35   compatible:
36     enum:
37       - edt,edt-ft5206
38       - edt,edt-ft5306
39       - edt,edt-ft5406
40       - edt,edt-ft5506
41       - evervision,ev-ft5726
42       - focaltech,ft6236
43
44   reg:
45     maxItems: 1
46
47   interrupts:
48     maxItems: 1
49
50   reset-gpios:
51     maxItems: 1
52
53   wake-gpios:
54     maxItems: 1
55
56   wakeup-source: true
57
58   vcc-supply: true
59   iovcc-supply: true
60
61   gain:
62     description: Allows setting the sensitivity in the range from 0 to 31.
63                  Note that lower values indicate higher sensitivity.
64     $ref: /schemas/types.yaml#/definitions/uint32
65     minimum: 0
66     maximum: 31
67
68   offset:
69     description: Allows setting the edge compensation in the range from 0 to 31.
70     $ref: /schemas/types.yaml#/definitions/uint32
71     minimum: 0
72     maximum: 31
73
74   offset-x:
75     description: Same as offset, but applies only to the horizontal position.
76                  Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
77     $ref: /schemas/types.yaml#/definitions/uint32
78     minimum: 0
79     maximum: 80
80
81   offset-y:
82     description: Same as offset, but applies only to the vertical position.
83                  Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
84     $ref: /schemas/types.yaml#/definitions/uint32
85     minimum: 0
86     maximum: 80
87
88   report-rate-hz:
89     description: |
90                  Allows setting the scan rate in Hertz.
91                   M06 supports range from 30 to 140 Hz.
92                   M12 supports range from 1 to 255 Hz.
93     minimum: 1
94     maximum: 255
95
96   touchscreen-size-x: true
97   touchscreen-size-y: true
98   touchscreen-fuzz-x: true
99   touchscreen-fuzz-y: true
100   touchscreen-inverted-x: true
101   touchscreen-inverted-y: true
102   touchscreen-swapped-x-y: true
103   interrupt-controller: true
104
105 additionalProperties: false
106
107 required:
108   - compatible
109   - reg
110   - interrupts
111
112 examples:
113   - |
114     #include <dt-bindings/gpio/gpio.h>
115     #include <dt-bindings/interrupt-controller/arm-gic.h>
116     i2c {
117       #address-cells = <1>;
118       #size-cells = <0>;
119       edt-ft5x06@38 {
120         compatible = "edt,edt-ft5406";
121         reg = <0x38>;
122         interrupt-parent = <&gpio2>;
123         interrupts = <5 IRQ_TYPE_EDGE_FALLING>;
124         reset-gpios = <&gpio2 6 GPIO_ACTIVE_LOW>;
125         wake-gpios = <&gpio4 9 GPIO_ACTIVE_HIGH>;
126       };
127     };
128
129 ...