Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
dt-bindings: input: touchscreen: convert ads7846.txt to yaml
Convert binding doc ads7846.txt to yaml format.
Additional change:
- add ref to touchscreen.yaml and spi-peripheral-props.yaml.
- use common node name touchscreen.
- sort ti properties alphabetically.
- sort common properties alphabetically.
- sort compatible string alphabetically.
- remove vcc-supply from required list.
- deprecated ti,x-min, ti,y-min
Fix below warning: arch/arm64/boot/dts/freescale/imx8mm-var-som-symphony.dtb: touchscreen@0:
ti,x-min: b'\x00}' is not of type 'object', 'array', 'boolean', 'null'
Reviewed-by: Rob Herring (Arm) <robh@kernel.org>
Reviewed-by: Marek Vasut <marex@denx.de>
Signed-off-by: Frank Li <Frank.Li@nxp.com>
Link: https://lore.kernel.org/r/20240826162302.960732-1-Frank.Li@nxp.com
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
authored by
Frank Li
and committed by
Dmitry Torokhov
45d6486d
b7ffc98a
+184
-108
-107
Documentation/devicetree/bindings/input/touchscreen/ads7846.txt
-107
Documentation/devicetree/bindings/input/touchscreen/ads7846.txt
···
1
-
Device tree bindings for TI's ADS7843, ADS7845, ADS7846, ADS7873, TSC2046
2
-
SPI driven touch screen controllers.
3
-
4
-
The node for this driver must be a child node of a SPI controller, hence
5
-
all mandatory properties described in
6
-
7
-
Documentation/devicetree/bindings/spi/spi-bus.txt
8
-
9
-
must be specified.
10
-
11
-
Additional required properties:
12
-
13
-
compatible Must be one of the following, depending on the
14
-
model:
15
-
"ti,tsc2046"
16
-
"ti,ads7843"
17
-
"ti,ads7845"
18
-
"ti,ads7846"
19
-
"ti,ads7873"
20
-
21
-
interrupts An interrupt node describing the IRQ line the chip's
22
-
!PENIRQ pin is connected to.
23
-
vcc-supply A regulator node for the supply voltage.
24
-
25
-
26
-
Optional properties:
27
-
28
-
ti,vref-delay-usecs vref supply delay in usecs, 0 for
29
-
external vref (u16).
30
-
ti,vref-mv The VREF voltage, in millivolts (u16).
31
-
Set to 0 to use internal references
32
-
(ADS7846).
33
-
ti,keep-vref-on set to keep vref on for differential
34
-
measurements as well
35
-
ti,settle-delay-usec Settling time of the analog signals;
36
-
a function of Vcc and the capacitance
37
-
on the X/Y drivers. If set to non-zero,
38
-
two samples are taken with settle_delay
39
-
us apart, and the second one is used.
40
-
~150 uSec with 0.01uF caps (u16).
41
-
ti,penirq-recheck-delay-usecs If set to non-zero, after samples are
42
-
taken this delay is applied and penirq
43
-
is rechecked, to help avoid false
44
-
events. This value is affected by the
45
-
material used to build the touch layer
46
-
(u16).
47
-
ti,x-plate-ohms Resistance of the X-plate,
48
-
in Ohms (u16).
49
-
ti,y-plate-ohms Resistance of the Y-plate,
50
-
in Ohms (u16).
51
-
ti,x-min Minimum value on the X axis (u16).
52
-
ti,y-min Minimum value on the Y axis (u16).
53
-
ti,debounce-tol Tolerance used for filtering (u16).
54
-
ti,debounce-rep Additional consecutive good readings
55
-
required after the first two (u16).
56
-
ti,pendown-gpio-debounce Platform specific debounce time for the
57
-
pendown-gpio (u32).
58
-
pendown-gpio GPIO handle describing the pin the !PENIRQ
59
-
line is connected to.
60
-
ti,hsync-gpios GPIO line to poll for hsync
61
-
wakeup-source use any event on touchscreen as wakeup event.
62
-
(Legacy property support: "linux,wakeup")
63
-
touchscreen-size-x General touchscreen binding, see [1].
64
-
touchscreen-size-y General touchscreen binding, see [1].
65
-
touchscreen-max-pressure General touchscreen binding, see [1].
66
-
touchscreen-min-pressure General touchscreen binding, see [1].
67
-
touchscreen-average-samples General touchscreen binding, see [1].
68
-
touchscreen-inverted-x General touchscreen binding, see [1].
69
-
touchscreen-inverted-y General touchscreen binding, see [1].
70
-
touchscreen-swapped-x-y General touchscreen binding, see [1].
71
-
72
-
[1] All general touchscreen properties are described in
73
-
Documentation/devicetree/bindings/input/touchscreen/touchscreen.txt.
74
-
75
-
Deprecated properties:
76
-
77
-
ti,swap-xy swap x and y axis
78
-
ti,x-max Maximum value on the X axis (u16).
79
-
ti,y-max Maximum value on the Y axis (u16).
80
-
ti,pressure-min Minimum reported pressure value
81
-
(threshold) - u16.
82
-
ti,pressure-max Maximum reported pressure value (u16).
83
-
ti,debounce-max Max number of additional readings per
84
-
sample (u16).
85
-
86
-
Example for a TSC2046 chip connected to an McSPI controller of an OMAP SoC::
87
-
88
-
spi_controller {
89
-
tsc2046@0 {
90
-
reg = <0>; /* CS0 */
91
-
compatible = "ti,tsc2046";
92
-
interrupt-parent = <&gpio1>;
93
-
interrupts = <8 0>; /* BOOT6 / GPIO 8 */
94
-
spi-max-frequency = <1000000>;
95
-
pendown-gpio = <&gpio1 8 0>;
96
-
vcc-supply = <®_vcc3>;
97
-
98
-
ti,x-min = /bits/ 16 <0>;
99
-
ti,x-max = /bits/ 16 <8000>;
100
-
ti,y-min = /bits/ 16 <0>;
101
-
ti,y-max = /bits/ 16 <4800>;
102
-
ti,x-plate-ohms = /bits/ 16 <40>;
103
-
ti,pressure-max = /bits/ 16 <255>;
104
-
105
-
wakeup-source;
106
-
};
107
-
};
+183
Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml
+183
Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.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/touchscreen/ti,ads7843.yaml#
5
+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6
+
7
+
title: TI's SPI driven touch screen controllers
8
+
9
+
maintainers:
10
+
- Alexander Stein <alexander.stein@ew.tq-group.com>
11
+
- Dmitry Torokhov <dmitry.torokhov@gmail.com>
12
+
- Marek Vasut <marex@denx.de>
13
+
14
+
description:
15
+
TI's ADS7843, ADS7845, ADS7846, ADS7873, TSC2046 SPI driven touch screen
16
+
controllers.
17
+
18
+
properties:
19
+
compatible:
20
+
enum:
21
+
- ti,ads7843
22
+
- ti,ads7845
23
+
- ti,ads7846
24
+
- ti,ads7873
25
+
- ti,tsc2046
26
+
27
+
interrupts:
28
+
maxItems: 1
29
+
30
+
pendown-gpio:
31
+
maxItems: 1
32
+
description:
33
+
GPIO handle describing the pin the !PENIRQ line is connected to.
34
+
35
+
vcc-supply:
36
+
description:
37
+
A regulator node for the supply voltage.
38
+
39
+
wakeup-source: true
40
+
41
+
ti,debounce-max:
42
+
deprecated: true
43
+
$ref: /schemas/types.yaml#/definitions/uint16
44
+
description:
45
+
Max number of additional readings per sample.
46
+
47
+
ti,debounce-rep:
48
+
$ref: /schemas/types.yaml#/definitions/uint16
49
+
description:
50
+
Additional consecutive good readings required after the first two.
51
+
52
+
ti,debounce-tol:
53
+
$ref: /schemas/types.yaml#/definitions/uint16
54
+
description:
55
+
Tolerance used for filtering.
56
+
57
+
ti,hsync-gpios:
58
+
maxItems: 1
59
+
description:
60
+
GPIO line to poll for hsync.
61
+
62
+
ti,keep-vref-on:
63
+
$ref: /schemas/types.yaml#/definitions/flag
64
+
description:
65
+
Set to keep Vref on for differential measurements as well.
66
+
67
+
ti,pendown-gpio-debounce:
68
+
$ref: /schemas/types.yaml#/definitions/uint32
69
+
description:
70
+
Platform specific debounce time for the pendown-gpio.
71
+
72
+
ti,penirq-recheck-delay-usecs:
73
+
$ref: /schemas/types.yaml#/definitions/uint16
74
+
description:
75
+
If set to non-zero, after samples are taken this delay is applied and
76
+
penirq is rechecked, to help avoid false events. This value is
77
+
affected by the material used to build the touch layer.
78
+
79
+
ti,pressure-max:
80
+
deprecated: true
81
+
$ref: /schemas/types.yaml#/definitions/uint16
82
+
description:
83
+
Maximum reported pressure value.
84
+
85
+
ti,pressure-min:
86
+
deprecated: true
87
+
$ref: /schemas/types.yaml#/definitions/uint16
88
+
description:
89
+
Minimum reported pressure value (threshold).
90
+
91
+
ti,settle-delay-usec:
92
+
$ref: /schemas/types.yaml#/definitions/uint16
93
+
description:
94
+
Settling time of the analog signals; a function of Vcc and the
95
+
capacitance on the X/Y drivers. If set to non-zero, two samples are
96
+
taken with settle_delay us apart, and the second one is used. ~150
97
+
uSec with 0.01uF caps.
98
+
99
+
ti,swap-xy:
100
+
deprecated: true
101
+
$ref: /schemas/types.yaml#/definitions/flag
102
+
description:
103
+
Swap x and y axis.
104
+
105
+
ti,vref-delay-usecs:
106
+
$ref: /schemas/types.yaml#/definitions/uint16
107
+
description:
108
+
Vref supply delay in usecs, 0 for external Vref.
109
+
110
+
ti,vref-mv:
111
+
$ref: /schemas/types.yaml#/definitions/uint16
112
+
description:
113
+
The VREF voltage, in millivolts.
114
+
Set to 0 to use internal references (ADS7846).
115
+
116
+
ti,x-plate-ohms:
117
+
$ref: /schemas/types.yaml#/definitions/uint16
118
+
description:
119
+
Resistance of the X-plate, in Ohms.
120
+
121
+
ti,x-max:
122
+
deprecated: true
123
+
$ref: /schemas/types.yaml#/definitions/uint16
124
+
description:
125
+
Maximum value on the X axis.
126
+
127
+
ti,x-min:
128
+
deprecated: true
129
+
$ref: /schemas/types.yaml#/definitions/uint16
130
+
description:
131
+
Minimum value on the X axis.
132
+
133
+
ti,y-plate-ohms:
134
+
$ref: /schemas/types.yaml#/definitions/uint16
135
+
description:
136
+
Resistance of the Y-plate, in Ohms.
137
+
138
+
ti,y-max:
139
+
deprecated: true
140
+
$ref: /schemas/types.yaml#/definitions/uint16
141
+
description:
142
+
Maximum value on the Y axis.
143
+
144
+
ti,y-min:
145
+
deprecated: true
146
+
$ref: /schemas/types.yaml#/definitions/uint16
147
+
description:
148
+
Minimum value on the Y axis.
149
+
150
+
required:
151
+
- compatible
152
+
- reg
153
+
154
+
allOf:
155
+
- $ref: touchscreen.yaml#
156
+
- $ref: /schemas/spi/spi-peripheral-props.yaml#
157
+
158
+
unevaluatedProperties: false
159
+
160
+
examples:
161
+
- |
162
+
spi{
163
+
#address-cells = <1>;
164
+
#size-cells = <0>;
165
+
166
+
touchscreen@0 {
167
+
compatible = "ti,tsc2046";
168
+
reg = <0>; /* CS0 */
169
+
interrupt-parent = <&gpio1>;
170
+
interrupts = <8 0>; /* BOOT6 / GPIO 8 */
171
+
pendown-gpio = <&gpio1 8 0>;
172
+
spi-max-frequency = <1000000>;
173
+
vcc-supply = <®_vcc3>;
174
+
wakeup-source;
175
+
176
+
ti,pressure-max = /bits/ 16 <255>;
177
+
ti,x-max = /bits/ 16 <8000>;
178
+
ti,x-min = /bits/ 16 <0>;
179
+
ti,x-plate-ohms = /bits/ 16 <40>;
180
+
ti,y-max = /bits/ 16 <4800>;
181
+
ti,y-min = /bits/ 16 <0>;
182
+
};
183
+
};
+1
-1
Documentation/devicetree/bindings/power/wakeup-source.txt
+1
-1
Documentation/devicetree/bindings/power/wakeup-source.txt
···
25
25
2. "has-tpo" Documentation/devicetree/bindings/rtc/rtc-opal.txt
26
26
3. "linux,wakeup" Documentation/devicetree/bindings/input/gpio-matrix-keypad.txt
27
27
Documentation/devicetree/bindings/mfd/tc3589x.txt
28
-
Documentation/devicetree/bindings/input/touchscreen/ads7846.txt
28
+
Documentation/devicetree/bindings/input/touchscreen/ti,ads7843.yaml
29
29
4. "linux,keypad-wakeup" Documentation/devicetree/bindings/input/qcom,pm8xxx-keypad.txt
30
30
5. "linux,input-wakeup" Documentation/devicetree/bindings/input/samsung,s3c6410-keypad.yaml
31
31
6. "nvidia,wakeup-source" Documentation/devicetree/bindings/input/nvidia,tegra20-kbc.txt