diff mbox series

[v3,1/2] dt-bindings: input: touchscreen: ilitek_ts_i2c: Add bindings

Message ID 20210218064435.1360483-1-joe_hung@ilitek.com (mailing list archive)
State Superseded
Headers show
Series [v3,1/2] dt-bindings: input: touchscreen: ilitek_ts_i2c: Add bindings | expand

Commit Message

Joe Hung (洪銘陽) Feb. 18, 2021, 6:44 a.m. UTC
Add binding documentation for ILITEK touch devices.

Signed-off-by: Joe Hung <joe_hung@ilitek.com>
---
Changes in v3:
  - Add include header in examples, and pass the dt binding check

Changes in v2:
  - Convert to DT schema format
  - Using interrupts instead of irq-gpios

 .../input/touchscreen/ilitek_ts_i2c.yaml      | 46 +++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml

--
2.25.1

Comments

Dmitry Torokhov Feb. 21, 2021, 5:03 a.m. UTC | #1
Hi Joe,

On Thu, Feb 18, 2021 at 02:44:34PM +0800, Joe Hung wrote:
> Add binding documentation for ILITEK touch devices.
> 
> Signed-off-by: Joe Hung <joe_hung@ilitek.com>
> ---
> Changes in v3:
>   - Add include header in examples, and pass the dt binding check
> 
> Changes in v2:
>   - Convert to DT schema format
>   - Using interrupts instead of irq-gpios
> 
>  .../input/touchscreen/ilitek_ts_i2c.yaml      | 46 +++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> new file mode 100644
> index 000000000000..5da9020ed272
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/ilitek_ts_i2c.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Ilitek I2C Touchscreen Controller
> +
> +maintainers:
> +  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ilitek,ili2520
> +      - ilitek,ili2510
> +  reg:
> +    const: 0x41
> +  interrupts:
> +    maxItems: 1
> +  reset-gpios:
> +    maxItems: 1
> +
> +additionalProperties: false

I think you need to make sure that wakeup-source and various
touchscreen-* properties can be used in this binding.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - reset-gpios
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/gpio/gpio.h>
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        touchscreen@41 {
> +                compatible = "ilitek,ili2520";
> +                reg = <0x41>;
> +                interrupt-parent = <&gpio1>;
> +                interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
> +                reset-gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>;
> +        };
> +    };
> --
> 2.25.1
> 
> 

Thanks.
Joe Hung (洪銘陽) Feb. 23, 2021, 7:04 a.m. UTC | #2
Hi Dmitry,

Many thanks for your review.
Should be updated in v4 shortly.

On Sat, Feb 20, 2021 21:03:29PM -0800, Dmitry Torokhov wrote:
> Hi Joe,
> 
> On Thu, Feb 18, 2021 at 02:44:34PM +0800, Joe Hung wrote:
> > Add binding documentation for ILITEK touch devices.
> > 
> > Signed-off-by: Joe Hung <joe_hung@ilitek.com>
> > ---
> > Changes in v3:
> >   - Add include header in examples, and pass the dt binding check
> > 
> > Changes in v2:
> >   - Convert to DT schema format
> >   - Using interrupts instead of irq-gpios
> > 
> >  .../input/touchscreen/ilitek_ts_i2c.yaml      | 46 +++++++++++++++++++
> >  1 file changed, 46 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> > new file mode 100644
> > index 000000000000..5da9020ed272
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
> > @@ -0,0 +1,46 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/input/touchscreen/ilitek_ts_i2c.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Ilitek I2C Touchscreen Controller
> > +
> > +maintainers:
> > +  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - ilitek,ili2520
> > +      - ilitek,ili2510
> > +  reg:
> > +    const: 0x41
> > +  interrupts:
> > +    maxItems: 1
> > +  reset-gpios:
> > +    maxItems: 1
> > +
> > +additionalProperties: false
> 
> I think you need to make sure that wakeup-source and various
> touchscreen-* properties can be used in this binding.
> 
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - interrupts
> > +  - reset-gpios
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +        touchscreen@41 {
> > +                compatible = "ilitek,ili2520";
> > +                reg = <0x41>;
> > +                interrupt-parent = <&gpio1>;
> > +                interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
> > +                reset-gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>;
> > +        };
> > +    };
> > --
> > 2.25.1
> > 
> > 
> 
> Thanks.
> 
> -- 
> Dmitry

Many thanks.

--
Joe Hung
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
new file mode 100644
index 000000000000..5da9020ed272
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/ilitek_ts_i2c.yaml
@@ -0,0 +1,46 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/ilitek_ts_i2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Ilitek I2C Touchscreen Controller
+
+maintainers:
+  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
+
+properties:
+  compatible:
+    enum:
+      - ilitek,ili2520
+      - ilitek,ili2510
+  reg:
+    const: 0x41
+  interrupts:
+    maxItems: 1
+  reset-gpios:
+    maxItems: 1
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - reset-gpios
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/gpio/gpio.h>
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        touchscreen@41 {
+                compatible = "ilitek,ili2520";
+                reg = <0x41>;
+                interrupt-parent = <&gpio1>;
+                interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
+                reset-gpios = <&gpio1 8 GPIO_ACTIVE_HIGH>;
+        };
+    };