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