Commit 247141f5 authored by Marek Vasut's avatar Marek Vasut Committed by Dmitry Torokhov
Browse files

dt-bindings: input: tsc2005: Convert to YAML schema



Convert the TI TSC2004/TSC2005 DT bindings to YAML schema.

Signed-off-by: default avatarMarek Vasut <marex@denx.de>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20210620210708.100147-1-marex@denx.de


Signed-off-by: default avatarDmitry Torokhov <dmitry.torokhov@gmail.com>
parent 62e4fe9f
Loading
Loading
Loading
Loading
+128 −0
Original line number Diff line number Diff line
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/input/touchscreen/ti,tsc2005.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Texas Instruments TSC2004 and TSC2005 touchscreen controller bindings

maintainers:
  - Marek Vasut <marex@denx.de>
  - Michael Welling <mwelling@ieee.org>

properties:
  $nodename:
    pattern: "^touchscreen(@.*)?$"

  compatible:
    enum:
      - ti,tsc2004
      - ti,tsc2005

  reg:
    maxItems: 1
    description: |
      I2C address when used on the I2C bus, or the SPI chip select index
      when used on the SPI bus

  interrupts:
    maxItems: 1

  reset-gpios:
    maxItems: 1
    description: GPIO specifier for the controller reset line

  spi-max-frequency:
    description: TSC2005 SPI bus clock frequency.
    maximum: 25000000

  ti,x-plate-ohms:
    description: resistance of the touchscreen's X plates in ohm (defaults to 280)

  ti,esd-recovery-timeout-ms:
    description: |
        if the touchscreen does not respond after the configured time
        (in milli seconds), the driver will reset it. This is disabled
        by default.

  vio-supply:
    description: Regulator specifier

  touchscreen-fuzz-pressure: true
  touchscreen-fuzz-x: true
  touchscreen-fuzz-y: true
  touchscreen-max-pressure: true
  touchscreen-size-x: true
  touchscreen-size-y: true

allOf:
  - $ref: touchscreen.yaml#
  - if:
      properties:
        compatible:
          contains:
            const: ti,tsc2004
    then:
      properties:
        spi-max-frequency: false

additionalProperties: false

required:
  - compatible
  - reg
  - interrupts

examples:
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/gpio/gpio.h>
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;
        touchscreen@48 {
            compatible = "ti,tsc2004";
            reg = <0x48>;
            vio-supply = <&vio>;

            reset-gpios = <&gpio4 8 GPIO_ACTIVE_HIGH>;
            interrupts-extended = <&gpio1 27 IRQ_TYPE_EDGE_RISING>;

            touchscreen-fuzz-x = <4>;
            touchscreen-fuzz-y = <7>;
            touchscreen-fuzz-pressure = <2>;
            touchscreen-size-x = <4096>;
            touchscreen-size-y = <4096>;
            touchscreen-max-pressure = <2048>;

            ti,x-plate-ohms = <280>;
            ti,esd-recovery-timeout-ms = <8000>;
        };
    };
  - |
    #include <dt-bindings/interrupt-controller/irq.h>
    #include <dt-bindings/gpio/gpio.h>
    spi {
        #address-cells = <1>;
        #size-cells = <0>;
        touchscreen@0 {
            compatible = "ti,tsc2005";
            spi-max-frequency = <6000000>;
            reg = <0>;

            vio-supply = <&vio>;

            reset-gpios = <&gpio4 8 GPIO_ACTIVE_HIGH>; /* 104 */
            interrupts-extended = <&gpio4 4 IRQ_TYPE_EDGE_RISING>; /* 100 */

            touchscreen-fuzz-x = <4>;
            touchscreen-fuzz-y = <7>;
            touchscreen-fuzz-pressure = <2>;
            touchscreen-size-x = <4096>;
            touchscreen-size-y = <4096>;
            touchscreen-max-pressure = <2048>;

            ti,x-plate-ohms = <280>;
            ti,esd-recovery-timeout-ms = <8000>;
        };
    };
+0 −64
Original line number Diff line number Diff line
* Texas Instruments tsc2004 and tsc2005 touchscreen controllers

Required properties:
 - compatible		      : "ti,tsc2004" or "ti,tsc2005"
 - reg			      : Device address
 - interrupts		      : IRQ specifier
 - spi-max-frequency	      : Maximum SPI clocking speed of the device
			        (for tsc2005)

Optional properties:
 - vio-supply		      : Regulator specifier
 - reset-gpios		      : GPIO specifier for the controller reset line
 - ti,x-plate-ohms	      : integer, resistance of the touchscreen's X plates
				in ohm (defaults to 280)
 - ti,esd-recovery-timeout-ms : integer, if the touchscreen does not respond after
				the configured time (in milli seconds), the driver
				will reset it. This is disabled by default.
 - properties defined in touchscreen.txt

Example:

&i2c3 {
	tsc2004@48 {
		compatible = "ti,tsc2004";
		reg = <0x48>;
		vio-supply = <&vio>;

		reset-gpios = <&gpio4 8 GPIO_ACTIVE_HIGH>;
		interrupts-extended = <&gpio1 27 IRQ_TYPE_EDGE_RISING>;

		touchscreen-fuzz-x = <4>;
		touchscreen-fuzz-y = <7>;
		touchscreen-fuzz-pressure = <2>;
		touchscreen-size-x = <4096>;
		touchscreen-size-y = <4096>;
		touchscreen-max-pressure = <2048>;

		ti,x-plate-ohms = <280>;
		ti,esd-recovery-timeout-ms = <8000>;
	};
}

&mcspi1 {
	tsc2005@0 {
		compatible = "ti,tsc2005";
		spi-max-frequency = <6000000>;
		reg = <0>;

		vio-supply = <&vio>;

		reset-gpios = <&gpio4 8 GPIO_ACTIVE_HIGH>; /* 104 */
		interrupts-extended = <&gpio4 4 IRQ_TYPE_EDGE_RISING>; /* 100 */

		touchscreen-fuzz-x = <4>;
		touchscreen-fuzz-y = <7>;
		touchscreen-fuzz-pressure = <2>;
		touchscreen-size-x = <4096>;
		touchscreen-size-y = <4096>;
		touchscreen-max-pressure = <2048>;

		ti,x-plate-ohms = <280>;
		ti,esd-recovery-timeout-ms = <8000>;
	};
}