xref: /freebsd/sys/contrib/device-tree/Bindings/input/touchscreen/touchscreen.yaml (revision a90b9d0159070121c221b966469c3e36d912bf82)
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/input/touchscreen/touchscreen.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Common touchscreen
8
9maintainers:
10  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
11
12properties:
13  panel:
14    description: If this touchscreen is integrally connected to a panel, this
15      is a reference to that panel. The presence of this reference indicates
16      that the touchscreen should be power sequenced together with the panel
17      and that they may share power and/or reset signals.
18    $ref: /schemas/types.yaml#/definitions/phandle
19
20  touchscreen-min-x:
21    description: minimum x coordinate reported
22    $ref: /schemas/types.yaml#/definitions/uint32
23    default: 0
24
25  touchscreen-min-y:
26    description: minimum y coordinate reported
27    $ref: /schemas/types.yaml#/definitions/uint32
28    default: 0
29
30  touchscreen-size-x:
31    description: horizontal resolution of touchscreen (maximum x coordinate reported + 1)
32    $ref: /schemas/types.yaml#/definitions/uint32
33
34  touchscreen-size-y:
35    description: vertical resolution of touchscreen (maximum y coordinate reported + 1)
36    $ref: /schemas/types.yaml#/definitions/uint32
37
38  touchscreen-max-pressure:
39    description: maximum reported pressure (arbitrary range dependent on the controller)
40    $ref: /schemas/types.yaml#/definitions/uint32
41
42  touchscreen-min-pressure:
43    description: minimum pressure on the touchscreen to be achieved in order
44      for the touchscreen driver to report a touch event.
45    $ref: /schemas/types.yaml#/definitions/uint32
46
47  touchscreen-fuzz-x:
48    description: horizontal noise value of the absolute input device (in pixels)
49    $ref: /schemas/types.yaml#/definitions/uint32
50
51  touchscreen-fuzz-y:
52    description: vertical noise value of the absolute input device (in pixels)
53    $ref: /schemas/types.yaml#/definitions/uint32
54
55  touchscreen-fuzz-pressure:
56    description: pressure noise value of the absolute input device (arbitrary
57      range dependent on the controller)
58    $ref: /schemas/types.yaml#/definitions/uint32
59
60  touchscreen-average-samples:
61    description: Number of data samples which are averaged for each read (valid
62      values dependent on the controller)
63    $ref: /schemas/types.yaml#/definitions/uint32
64
65  touchscreen-inverted-x:
66    description: X axis is inverted
67    type: boolean
68
69  touchscreen-inverted-y:
70    description: Y axis is inverted
71    type: boolean
72
73  touchscreen-swapped-x-y:
74    description: X and Y axis are swapped
75                 Swapping is done after inverting the axis
76    type: boolean
77
78  touchscreen-x-mm:
79    description: horizontal length in mm of the touchscreen
80
81  touchscreen-y-mm:
82    description: vertical length in mm of the touchscreen
83
84  touchscreen-x-plate-ohms:
85    description: Resistance of the X-plate in Ohms
86
87  touchscreen-y-plate-ohms:
88    description: Resistance of the Y-plate in Ohms
89
90dependencies:
91  touchscreen-size-x: [ touchscreen-size-y ]
92  touchscreen-size-y: [ touchscreen-size-x ]
93  touchscreen-x-mm: [ touchscreen-y-mm ]
94  touchscreen-y-mm: [ touchscreen-x-mm ]
95
96additionalProperties: true
97