[1/2] dt-bindings: touchscreen: Add touchscreen schema
diff mbox series

Message ID 20200107130903.14421-2-benjamin.gaignard@st.com
State New
Headers show
Series
  • Convert Goodix touchscreen to json-schema
Related show

Commit Message

Benjamin Gaignard Jan. 7, 2020, 1:09 p.m. UTC
Add touchscreen schema for common properties

Signed-off-by: Benjamin Gaignard <benjamin.gaignard@st.com>
---
 .../bindings/input/touchscreen/touchscreen.yaml    | 63 ++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml

Comments

Rob Herring Jan. 7, 2020, 5:47 p.m. UTC | #1
On Tue, Jan 7, 2020 at 7:09 AM Benjamin Gaignard
<benjamin.gaignard@st.com> wrote:
>
> Add touchscreen schema for common properties
>
> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@st.com>
> ---
>  .../bindings/input/touchscreen/touchscreen.yaml    | 63 ++++++++++++++++++++++
>  1 file changed, 63 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml

Don't just add schema. Remove the old definitions. To avoid updating a
bunch of references to touchscreen.txt, I just put a 'see
touchscreen.yaml' in it.

> diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
> new file mode 100644
> index 000000000000..f6e7c73ef14e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/touchscreen.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Common touchscreen Bindings
> +
> +maintainers:
> +  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
> +
> +properties:
> +  touchscreen-min-x:
> +    description: minimum x coordinate reported (0 if not set)

You need a type reference on a bunch of these. And "(0 if not set)"
sounds like a 'default' constraint.

> +
> +  touchscreen-min-y:
> +    description: minimum y coordinate reported (0 if not set)
> +
> +  touchscreen-size-x:
> +    description: horizontal resolution of touchscreen (maximum x coordinate reported + 1)
> +
> +  touchscreen-size-y:
> +    description: vertical resolution of touchscreen (maximum y coordinate reported + 1)

I don't think it makes sense if both of these aren't present, so you need:

dependencies:
  touchscreen-size-x: [ touchscreen-size-y ]
  touchscreen-size-y: [ touchscreen-size-x ]

> +
> +  touchscreen-max-pressure:
> +    description: maximum reported pressure (arbitrary range dependent on the controller)
> +
> +  touchscreen-min-pressure:
> +    description: minimum pressure on the touchscreen to be achieved in order for the
> +                 touchscreen driver to report a touch event.
> +
> +  touchscreen-fuzz-x:
> +    description: horizontal noise value of the absolute input device (in pixels)
> +
> +  touchscreen-fuzz-y:
> +    description: vertical noise value of the absolute input device (in pixels)
> +
> +  touchscreen-fuzz-pressure:
> +    description: pressure noise value of the absolute input device (arbitrary range
> +                 dependent on the controller)
> +
> +  touchscreen-average-samples:
> +    description: Number of data samples which are averaged for each read (valid values
> +                 dependent on the controller)
> +
> +  touchscreen-inverted-x:
> +    description: X axis is inverted (boolean)
> +    type: boolean
> +
> +  touchscreen-inverted-y:
> +    description: Y axis is inverted (boolean)
> +    type: boolean
> +
> +  touchscreen-swapped-x-y:
> +    description: X and Y axis are swapped (boolean)
> +                 Swapping is done after inverting the axis
> +    type: boolean
> +
> +  touchscreen-x-mm:
> +    description: horizontal length in mm of the touchscreen
> +
> +  touchscreen-y-mm:
> +    description: vertical length in mm of the touchscreen

Same dependencies here.

Rob

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
new file mode 100644
index 000000000000..f6e7c73ef14e
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/touchscreen.yaml
@@ -0,0 +1,63 @@ 
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/touchscreen.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Common touchscreen Bindings
+
+maintainers:
+  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
+
+properties:
+  touchscreen-min-x:
+    description: minimum x coordinate reported (0 if not set)
+
+  touchscreen-min-y:
+    description: minimum y coordinate reported (0 if not set)
+
+  touchscreen-size-x:
+    description: horizontal resolution of touchscreen (maximum x coordinate reported + 1)
+
+  touchscreen-size-y:
+    description: vertical resolution of touchscreen (maximum y coordinate reported + 1)
+
+  touchscreen-max-pressure:
+    description: maximum reported pressure (arbitrary range dependent on the controller)
+
+  touchscreen-min-pressure:
+    description: minimum pressure on the touchscreen to be achieved in order for the
+                 touchscreen driver to report a touch event.
+
+  touchscreen-fuzz-x:
+    description: horizontal noise value of the absolute input device (in pixels)
+
+  touchscreen-fuzz-y:
+    description: vertical noise value of the absolute input device (in pixels)
+
+  touchscreen-fuzz-pressure:
+    description: pressure noise value of the absolute input device (arbitrary range
+                 dependent on the controller)
+
+  touchscreen-average-samples:
+    description: Number of data samples which are averaged for each read (valid values
+                 dependent on the controller)
+
+  touchscreen-inverted-x:
+    description: X axis is inverted (boolean)
+    type: boolean
+
+  touchscreen-inverted-y:
+    description: Y axis is inverted (boolean)
+    type: boolean
+
+  touchscreen-swapped-x-y:
+    description: X and Y axis are swapped (boolean)
+                 Swapping is done after inverting the axis
+    type: boolean
+
+  touchscreen-x-mm:
+    description: horizontal length in mm of the touchscreen
+
+  touchscreen-y-mm:
+    description: vertical length in mm of the touchscreen