Commit 1d6204e2 authored by Benjamin Gaignard's avatar Benjamin Gaignard Committed by Dmitry Torokhov
Browse files

dt-bindings: touchscreen: Add touchscreen schema

parent 273db8f0
Loading
Loading
Loading
Loading
+1 −39
Original line number Diff line number Diff line
General Touchscreen Properties:

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

Deprecated properties for Touchscreens:
 - x-size			: deprecated name for touchscreen-size-x
 - y-size			: deprecated name for touchscreen-size-y
 - moving-threshold		: deprecated name for a combination of
				  touchscreen-fuzz-x and touchscreen-fuzz-y
 - contact-threshold		: deprecated name for touchscreen-fuzz-pressure
 - x-invert			: deprecated name for touchscreen-inverted-x
 - y-invert			: deprecated name for touchscreen-inverted-y
See touchscreen.yaml
+83 −0
Original line number Diff line number Diff line
# 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
    $ref: /schemas/types.yaml#/definitions/uint32
    default: 0

  touchscreen-min-y:
    description: minimum y coordinate reported
    $ref: /schemas/types.yaml#/definitions/uint32
    default: 0

  touchscreen-size-x:
    description: horizontal resolution of touchscreen (maximum x coordinate reported + 1)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-size-y:
    description: vertical resolution of touchscreen (maximum y coordinate reported + 1)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-max-pressure:
    description: maximum reported pressure (arbitrary range dependent on the controller)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-min-pressure:
    description: minimum pressure on the touchscreen to be achieved in order for the
                 touchscreen driver to report a touch event.
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-fuzz-x:
    description: horizontal noise value of the absolute input device (in pixels)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-fuzz-y:
    description: vertical noise value of the absolute input device (in pixels)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-fuzz-pressure:
    description: pressure noise value of the absolute input device (arbitrary range
                 dependent on the controller)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-average-samples:
    description: Number of data samples which are averaged for each read (valid values
                 dependent on the controller)
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-inverted-x:
    description: X axis is inverted
    type: boolean

  touchscreen-inverted-y:
    description: Y axis is inverted
    type: boolean

  touchscreen-swapped-x-y:
    description: X and Y axis are swapped
                 Swapping is done after inverting the axis
    type: boolean

  touchscreen-x-mm:
    description: horizontal length in mm of the touchscreen
    $ref: /schemas/types.yaml#/definitions/uint32

  touchscreen-y-mm:
    description: vertical length in mm of the touchscreen
    $ref: /schemas/types.yaml#/definitions/uint32

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