Commit af5e7abe authored by David Heidelberg's avatar David Heidelberg Committed by Rob Herring
Browse files

dt-bindings: input: elan,ekth3000: Convert txt bindings to yaml 



Convert Elan touchpad documentation to the YAML syntax.

Reviewed-by: default avatarDmitry Osipenko <digetx@gmail.com>
Signed-off-by: default avatarDavid Heidelberg <david@ixit.cz>
Link: https://lore.kernel.org/r/20211009183016.65218-1-david@ixit.cz


Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent e8a3d847

Documentation/devicetree/bindings/input/elan,ekth3000.yaml

0 → 100644
+81 −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/elan,ekth3000.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Elantech I2C Touchpad



maintainers:

  - Dmitry Torokhov <dmitry.torokhov@gmail.com>



allOf:

  - $ref: touchscreen/touchscreen.yaml#



properties:

  compatible:

    const: elan,ekth3000



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  wakeup-source:

    type: boolean

    description: touchpad can be used as a wakeup source



  vcc-supply:

    description: a phandle for the regulator supplying 3.3V power



  elan,trackpoint:

    type: boolean

    description: touchpad can support a trackpoint



  elan,clickpad:

    type: boolean

    description: touchpad is a clickpad (the entire surface is a button)



  elan,middle-button:

    type: boolean

    description: touchpad has a physical middle button



  elan,x_traces:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: number of antennas on the x axis



  elan,y_traces:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: number of antennas on the y axis



  touchscreen-size-x: true



  touchscreen-size-y: true



  touchscreen-x-mm: true



  touchscreen-y-mm: true



required:

  - compatible

  - reg

  - interrupts



additionalProperties: false



examples:

  - |

    #include <dt-bindings/interrupt-controller/irq.h>

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;



        touchpad@15 {

            compatible = "elan,ekth3000";

            reg = <0x15>;

            interrupt-parent = <&gpio4>;

            interrupts = <0x0 IRQ_TYPE_EDGE_FALLING>;

            wakeup-source;

        };

    };

Documentation/devicetree/bindings/input/elan_i2c.txt

deleted100644 → 0
+0 −44
Original line number Diff line number Diff line 
Elantech I2C Touchpad



Required properties:

- compatible: must be "elan,ekth3000".

- reg: I2C address of the chip.

- interrupts: interrupt to which the chip is connected (see interrupt

  binding[0]).



Optional properties:

- wakeup-source: touchpad can be used as a wakeup source.

- pinctrl-names: should be "default" (see pinctrl binding [1]).

- pinctrl-0: a phandle pointing to the pin settings for the device (see

  pinctrl binding [1]).

- vcc-supply: a phandle for the regulator supplying 3.3V power.

- elan,trackpoint: touchpad can support a trackpoint (boolean)

- elan,clickpad: touchpad is a clickpad (the entire surface is a button)

- elan,middle-button: touchpad has a physical middle button

- elan,x_traces: number of antennas on the x axis

- elan,y_traces: number of antennas on the y axis

- some generic touchscreen properties [2]:

  * touchscreen-size-x

  * touchscreen-size-y

  * touchscreen-x-mm

  * touchscreen-y-mm





[0]: Documentation/devicetree/bindings/interrupt-controller/interrupts.txt

[1]: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt

[2]: Documentation/devicetree/bindings/input/touchscreen/touchscreen.txt



Example:

	&i2c1 {

		/* ... */



		touchpad@15 {

			compatible = "elan,ekth3000";

			reg = <0x15>;

			interrupt-parent = <&gpio4>;

			interrupts = <0x0 IRQ_TYPE_EDGE_FALLING>;

			wakeup-source;

		};



		/* ... */

	};