diff mbox series

[1/1] dt-bindings: input: touchscreen: convert colibri-vf50-ts.txt to yaml

Message ID 20240812231123.3838058-1-Frank.Li@nxp.com (mailing list archive)
State Superseded
Headers show
Series [1/1] dt-bindings: input: touchscreen: convert colibri-vf50-ts.txt to yaml | expand

Commit Message

Frank Li Aug. 12, 2024, 11:11 p.m. UTC 
Convert binding doc colibri-vf50-ts.txt to yaml.
Additional change:
- add ref touchscreen.yaml.
- remove standard pinctrl properties.

Fix below warning:
arch/arm64/boot/dts/freescale/imx8qm-apalis-eval.dtb: /touchscreen:
  failed to match any schema with compatible: ['toradex,vf50-touchscreen']

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../input/touchscreen/colibri-vf50-ts.txt     | 34 ----------
 .../input/touchscreen/toradex,vf50.yaml       | 68 +++++++++++++++++++
 2 files changed, 68 insertions(+), 34 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml

Comments

Conor Dooley Aug. 13, 2024, 3:58 p.m. UTC | #1 
On Mon, Aug 12, 2024 at 07:11:19PM -0400, Frank Li wrote:
> Convert binding doc colibri-vf50-ts.txt to yaml.
> Additional change:
> - add ref touchscreen.yaml.
> - remove standard pinctrl properties.
> 
> Fix below warning:
> arch/arm64/boot/dts/freescale/imx8qm-apalis-eval.dtb: /touchscreen:
>   failed to match any schema with compatible: ['toradex,vf50-touchscreen']
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../input/touchscreen/colibri-vf50-ts.txt     | 34 ----------
>  .../input/touchscreen/toradex,vf50.yaml       | 68 +++++++++++++++++++
>  2 files changed, 68 insertions(+), 34 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt b/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
> deleted file mode 100644
> index ca304357c374a..0000000000000
> --- a/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
> +++ /dev/null
> @@ -1,34 +0,0 @@
> -* Toradex Colibri VF50 Touchscreen driver
> -
> -Required Properties:
> -- compatible must be toradex,vf50-touchscreen
> -- io-channels: adc channels being used by the Colibri VF50 module
> -    IIO ADC for Y-, X-, Y+, X+ connections
> -- xp-gpios: FET gate driver for input of X+
> -- xm-gpios: FET gate driver for input of X-
> -- yp-gpios: FET gate driver for input of Y+
> -- ym-gpios: FET gate driver for input of Y-
> -- interrupts: pen irq interrupt for touch detection, signal from X plate
> -- pinctrl-names: "idle", "default"
> -- pinctrl-0: pinctrl node for pen/touch detection, pinctrl must provide
> -    pull-up resistor on X+, X-.
> -- pinctrl-1: pinctrl node for X/Y and pressure measurement (ADC) state pinmux
> -- vf50-ts-min-pressure: pressure level at which to stop measuring X/Y values
> -
> -Example:
> -
> -	touchctrl: vf50_touchctrl {
> -		compatible = "toradex,vf50-touchscreen";
> -		io-channels = <&adc1 0>,<&adc0 0>,
> -				<&adc0 1>,<&adc1 2>;
> -		xp-gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
> -		xm-gpios = <&gpio2 29 GPIO_ACTIVE_HIGH>;
> -		yp-gpios = <&gpio0 12 GPIO_ACTIVE_LOW>;
> -		ym-gpios = <&gpio0 4 GPIO_ACTIVE_HIGH>;
> -		interrupt-parent = <&gpio0>;
> -		interrupts = <8 IRQ_TYPE_LEVEL_LOW>;
> -		pinctrl-names = "idle","default";
> -		pinctrl-0 = <&pinctrl_touchctrl_idle>, <&pinctrl_touchctrl_gpios>;
> -		pinctrl-1 = <&pinctrl_touchctrl_default>, <&pinctrl_touchctrl_gpios>;
> -		vf50-ts-min-pressure = <200>;
> -	};
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml b/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml
> new file mode 100644
> index 0000000000000..6ff3ad1f9edfd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml
> @@ -0,0 +1,68 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/toradex,vf50.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Toradex Colibri VF50 Touchscreen
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +properties:
> +  compatible:
> +    const: toradex,vf50-touchscreen
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  io-channels:
> +    maxItems: 4
> +    description:
> +      adc channels being used by the Colibri VF50 module
> +      IIO ADC for Y-, X-, Y+, X+ connections
> +
> +  xp-gpios:
> +    description: FET gate driver for input of X+
> +
> +  xm-gpios:
> +    description: FET gate driver for input of X-
> +
> +  yp-gpios:
> +    description: FET gate driver for input of Y+
> +
> +  ym-gpios:
> +    description: FET gate driver for input of Y-
> +
> +  vf50-ts-min-pressure:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: pressure level at which to stop measuring X/Y values

What are the constraints on this value?

> +
> +required:
> +  - compatible

The text binding lists all of the properties as required.

> +
> +allOf:
> +  - $ref: touchscreen.yaml#
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +
> +    touchscreen {
> +        compatible = "toradex,vf50-touchscreen";
> +        interrupt-parent = <&gpio0>;
> +        interrupts = <8 IRQ_TYPE_LEVEL_LOW>;
> +        io-channels = <&adc1 0>,<&adc0 0>, <&adc0 1>,<&adc1 2>;

This line has inconsistent formatting.
Otherwise, the conversion looks good.

Thanks,
Conor.

> +        xp-gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
> +        xm-gpios = <&gpio2 29 GPIO_ACTIVE_HIGH>;
> +        yp-gpios = <&gpio0 12 GPIO_ACTIVE_LOW>;
> +        ym-gpios = <&gpio0 4 GPIO_ACTIVE_HIGH>;
> +        pinctrl-names = "idle", "default";
> +        pinctrl-0 = <&pinctrl_touchctrl_idle>, <&pinctrl_touchctrl_gpios>;
> +        pinctrl-1 = <&pinctrl_touchctrl_default>, <&pinctrl_touchctrl_gpios>;
> +        vf50-ts-min-pressure = <200>;
> +    };
> +
> -- 
> 2.34.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt b/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
deleted file mode 100644
index ca304357c374a..0000000000000
--- a/Documentation/devicetree/bindings/input/touchscreen/colibri-vf50-ts.txt
+++ /dev/null
@@ -1,34 +0,0 @@ 
-* Toradex Colibri VF50 Touchscreen driver
-
-Required Properties:
-- compatible must be toradex,vf50-touchscreen
-- io-channels: adc channels being used by the Colibri VF50 module
-    IIO ADC for Y-, X-, Y+, X+ connections
-- xp-gpios: FET gate driver for input of X+
-- xm-gpios: FET gate driver for input of X-
-- yp-gpios: FET gate driver for input of Y+
-- ym-gpios: FET gate driver for input of Y-
-- interrupts: pen irq interrupt for touch detection, signal from X plate
-- pinctrl-names: "idle", "default"
-- pinctrl-0: pinctrl node for pen/touch detection, pinctrl must provide
-    pull-up resistor on X+, X-.
-- pinctrl-1: pinctrl node for X/Y and pressure measurement (ADC) state pinmux
-- vf50-ts-min-pressure: pressure level at which to stop measuring X/Y values
-
-Example:
-
-	touchctrl: vf50_touchctrl {
-		compatible = "toradex,vf50-touchscreen";
-		io-channels = <&adc1 0>,<&adc0 0>,
-				<&adc0 1>,<&adc1 2>;
-		xp-gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
-		xm-gpios = <&gpio2 29 GPIO_ACTIVE_HIGH>;
-		yp-gpios = <&gpio0 12 GPIO_ACTIVE_LOW>;
-		ym-gpios = <&gpio0 4 GPIO_ACTIVE_HIGH>;
-		interrupt-parent = <&gpio0>;
-		interrupts = <8 IRQ_TYPE_LEVEL_LOW>;
-		pinctrl-names = "idle","default";
-		pinctrl-0 = <&pinctrl_touchctrl_idle>, <&pinctrl_touchctrl_gpios>;
-		pinctrl-1 = <&pinctrl_touchctrl_default>, <&pinctrl_touchctrl_gpios>;
-		vf50-ts-min-pressure = <200>;
-	};
diff --git a/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml b/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml
new file mode 100644
index 0000000000000..6ff3ad1f9edfd
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/toradex,vf50.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/toradex,vf50.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Toradex Colibri VF50 Touchscreen
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    const: toradex,vf50-touchscreen
+
+  interrupts:
+    maxItems: 1
+
+  io-channels:
+    maxItems: 4
+    description:
+      adc channels being used by the Colibri VF50 module
+      IIO ADC for Y-, X-, Y+, X+ connections
+
+  xp-gpios:
+    description: FET gate driver for input of X+
+
+  xm-gpios:
+    description: FET gate driver for input of X-
+
+  yp-gpios:
+    description: FET gate driver for input of Y+
+
+  ym-gpios:
+    description: FET gate driver for input of Y-
+
+  vf50-ts-min-pressure:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: pressure level at which to stop measuring X/Y values
+
+required:
+  - compatible
+
+allOf:
+  - $ref: touchscreen.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+
+    touchscreen {
+        compatible = "toradex,vf50-touchscreen";
+        interrupt-parent = <&gpio0>;
+        interrupts = <8 IRQ_TYPE_LEVEL_LOW>;
+        io-channels = <&adc1 0>,<&adc0 0>, <&adc0 1>,<&adc1 2>;
+        xp-gpios = <&gpio0 13 GPIO_ACTIVE_LOW>;
+        xm-gpios = <&gpio2 29 GPIO_ACTIVE_HIGH>;
+        yp-gpios = <&gpio0 12 GPIO_ACTIVE_LOW>;
+        ym-gpios = <&gpio0 4 GPIO_ACTIVE_HIGH>;
+        pinctrl-names = "idle", "default";
+        pinctrl-0 = <&pinctrl_touchctrl_idle>, <&pinctrl_touchctrl_gpios>;
+        pinctrl-1 = <&pinctrl_touchctrl_default>, <&pinctrl_touchctrl_gpios>;
+        vf50-ts-min-pressure = <200>;
+    };
+