xref: /linux/Documentation/devicetree/bindings/input/touchscreen/edt-ft5x06.yaml (revision 53597deca0e38c30e6cd4ba2114fa42d2bcd85bb) 
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
7title: FocalTech EDT-FT5x06 Polytouch
8
9description: |
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
17maintainers:
18  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
19
20allOf:
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
34properties:
35  compatible:
36    oneOf:
37      - enum:
38          - edt,edt-ft5206
39          - edt,edt-ft5306
40          - edt,edt-ft5406
41          - edt,edt-ft5506
42          - evervision,ev-ft5726
43          - focaltech,ft3518
44          - focaltech,ft5426
45          - focaltech,ft5452
46          - focaltech,ft6236
47          - focaltech,ft8201
48          - focaltech,ft8716
49          - focaltech,ft8719
50      - items:
51          - const: focaltech,ft3519
52          - const: focaltech,ft3518
53
54  reg:
55    maxItems: 1
56
57  interrupts:
58    maxItems: 1
59
60  reset-gpios:
61    maxItems: 1
62
63  wake-gpios:
64    maxItems: 1
65
66  wakeup-source: true
67
68  vcc-supply: true
69  iovcc-supply: true
70
71  gain:
72    description: Allows setting the sensitivity in the range from 0 to 31.
73                 Note that lower values indicate higher sensitivity.
74    $ref: /schemas/types.yaml#/definitions/uint32
75    minimum: 0
76    maximum: 31
77
78  offset:
79    description: Allows setting the edge compensation in the range from 0 to 31.
80    $ref: /schemas/types.yaml#/definitions/uint32
81    minimum: 0
82    maximum: 31
83
84  offset-x:
85    description: Same as offset, but applies only to the horizontal position.
86                 Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
87    $ref: /schemas/types.yaml#/definitions/uint32
88    minimum: 0
89    maximum: 80
90
91  offset-y:
92    description: Same as offset, but applies only to the vertical position.
93                 Range from 0 to 80, only supported by evervision,ev-ft5726 devices.
94    $ref: /schemas/types.yaml#/definitions/uint32
95    minimum: 0
96    maximum: 80
97
98  report-rate-hz:
99    description: |
100                 Allows setting the scan rate in Hertz.
101                  M06 supports range from 30 to 140 Hz.
102                  M12 supports range from 1 to 255 Hz.
103    minimum: 1
104    maximum: 255
105
106  threshold:
107    description: Allows setting the  "click"-threshold in the range from 0 to 255.
108    $ref: /schemas/types.yaml#/definitions/uint32
109    minimum: 0
110    maximum: 255
111
112  interrupt-controller: true
113
114unevaluatedProperties: false
115
116required:
117  - compatible
118  - reg
119  - interrupts
120
121examples:
122  - |
123    #include <dt-bindings/gpio/gpio.h>
124    #include <dt-bindings/interrupt-controller/arm-gic.h>
125    i2c {
126      #address-cells = <1>;
127      #size-cells = <0>;
128      touchscreen@38 {
129        compatible = "edt,edt-ft5406";
130        reg = <0x38>;
131        interrupt-parent = <&gpio2>;
132        interrupts = <5 IRQ_TYPE_EDGE_FALLING>;
133        reset-gpios = <&gpio2 6 GPIO_ACTIVE_LOW>;
134        wake-gpios = <&gpio4 9 GPIO_ACTIVE_HIGH>;
135      };
136    };
137
138...
139