diff mbox series

[v5,2/3] dt-bindings: input: Add TouchNetix axiom touchscreen

Message ID 20231211121430.1689139-3-kamel.bouhara@bootlin.com
State New
Headers
Series Input: Add TouchNetix axiom touchscreen driver |

Commit Message

Kamel Bouhara Dec. 11, 2023, 12:14 p.m. UTC 
  Add the TouchNetix axiom I2C touchscreen device tree bindings
documentation.

Signed-off-by: Kamel Bouhara <kamel.bouhara@bootlin.com>
---
 .../input/touchscreen/touchnetix,ax54a.yaml   | 64 +++++++++++++++++++
 MAINTAINERS                                   |  6 ++
 2 files changed, 70 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml

Comments

Conor Dooley Dec. 12, 2023, 4:57 p.m. UTC | #1 
On Mon, Dec 11, 2023 at 01:14:28PM +0100, Kamel Bouhara wrote:
> Add the TouchNetix axiom I2C touchscreen device tree bindings
> documentation.
> 
> Signed-off-by: Kamel Bouhara <kamel.bouhara@bootlin.com>
> ---
>  .../input/touchscreen/touchnetix,ax54a.yaml   | 64 +++++++++++++++++++
>  MAINTAINERS                                   |  6 ++
>  2 files changed, 70 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> new file mode 100644
> index 000000000000..cbdf48fc538b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> @@ -0,0 +1,64 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/input/touchscreen/touchnetix,ax54a.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: TouchNetix Axiom series touchscreen controller
> +
> +maintainers:
> +  - Kamel Bouhara <kamel.bouhara@bootlin.com>
> +
> +allOf:
> +  - $ref: /schemas/input/touchscreen/touchscreen.yaml#

Weird, you add this ref here but do not actually allow any properties
from it since you have "additionalProperties: false" below.

What's the point of its inclusion?

Cheers,
Conor.

> +  - $ref: /schemas/input/input.yaml#
> +
> +properties:
> +  compatible:
> +    const: touchnetix,ax54a
> +
> +  reg:
> +    const: 0x66
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  reset-gpios:
> +    maxItems: 1
> +
> +  vdda-supply:
> +    description: Analog power supply regulator on VDDA pin
> +
> +  vddi-supply:
> +    description: I/O power supply regulator on VDDI pin
> +
> +  poll-interval: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - vdda-supply
> +  - vddi-supply
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/gpio/gpio.h>
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      touchscreen@66 {
> +        compatible = "touchnetix,ax54a";
> +        reg = <0x66>;
> +        interrupt-parent = <&gpio2>;
> +        interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
> +        reset-gpios = <&gpio1 1 GPIO_ACTIVE_HIGH>;
> +        vdda-supply = <&vdda_reg>;
> +        vddi-supply = <&vddi_reg>;
> +        poll-interval = <20>;
> +      };
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7608b714653f..4752d8436dbb 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -21431,6 +21431,12 @@ S:	Maintained
>  F:	Documentation/ABI/testing/sysfs-class-firmware-attributes
>  F:	drivers/platform/x86/think-lmi.?
>  
> +TOUCHNETIX AXIOM I2C TOUCHSCREEN DRIVER
> +M:	Kamel Bouhara <kamel.bouhara@bootlin.com>
> +L:	linux-input@vger.kernel.org
> +S:	Maintained
> +F:	Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> +
>  THUNDERBOLT DMA TRAFFIC TEST DRIVER
>  M:	Isaac Hazan <isaac.hazan@intel.com>
>  L:	linux-usb@vger.kernel.org
> -- 
> 2.25.1
>
Krzysztof Kozlowski Dec. 13, 2023, 6:44 a.m. UTC | #2 
On 12/12/2023 17:57, Conor Dooley wrote:
> On Mon, Dec 11, 2023 at 01:14:28PM +0100, Kamel Bouhara wrote:
>> Add the TouchNetix axiom I2C touchscreen device tree bindings
>> documentation.
>>
>> Signed-off-by: Kamel Bouhara <kamel.bouhara@bootlin.com>
>> ---
>>  .../input/touchscreen/touchnetix,ax54a.yaml   | 64 +++++++++++++++++++
>>  MAINTAINERS                                   |  6 ++
>>  2 files changed, 70 insertions(+)
>>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
>> new file mode 100644
>> index 000000000000..cbdf48fc538b
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
>> @@ -0,0 +1,64 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/input/touchscreen/touchnetix,ax54a.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: TouchNetix Axiom series touchscreen controller
>> +
>> +maintainers:
>> +  - Kamel Bouhara <kamel.bouhara@bootlin.com>
>> +
>> +allOf:
>> +  - $ref: /schemas/input/touchscreen/touchscreen.yaml#
> 
> Weird, you add this ref here but do not actually allow any properties
> from it since you have "additionalProperties: false" below.
> 
> What's the point of its inclusion?

It still brings the type of some fields or the constraints. However need
of specifying "poll-interval" already points to missing
unevaluatedProperties.


Best regards,
Krzysztof
Kamel Bouhara Dec. 13, 2023, 8:14 a.m. UTC | #3 
Hi,

Le Tue, Dec 12, 2023 at 04:57:11PM +0000, Conor Dooley a écrit :
> On Mon, Dec 11, 2023 at 01:14:28PM +0100, Kamel Bouhara wrote:
> > Add the TouchNetix axiom I2C touchscreen device tree bindings
> > documentation.
> >
> > Signed-off-by: Kamel Bouhara <kamel.bouhara@bootlin.com>
> > ---
> >  .../input/touchscreen/touchnetix,ax54a.yaml   | 64 +++++++++++++++++++
> >  MAINTAINERS                                   |  6 ++
> >  2 files changed, 70 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> > new file mode 100644
> > index 000000000000..cbdf48fc538b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> > @@ -0,0 +1,64 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/input/touchscreen/touchnetix,ax54a.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: TouchNetix Axiom series touchscreen controller
> > +
> > +maintainers:
> > +  - Kamel Bouhara <kamel.bouhara@bootlin.com>
> > +
> > +allOf:
> > +  - $ref: /schemas/input/touchscreen/touchscreen.yaml#
>
> Weird, you add this ref here but do not actually allow any properties
> from it since you have "additionalProperties: false" below.
>
> What's the point of its inclusion?

Currently the driver doesn't use thoses properties but still some are
valid for this device.

Greetings,
Kamel

>
> Cheers,
> Conor.
>
> > +  - $ref: /schemas/input/input.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    const: touchnetix,ax54a
> > +
> > +  reg:
> > +    const: 0x66
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  reset-gpios:
> > +    maxItems: 1
> > +
> > +  vdda-supply:
> > +    description: Analog power supply regulator on VDDA pin
> > +
> > +  vddi-supply:
> > +    description: I/O power supply regulator on VDDI pin
> > +
> > +  poll-interval: true
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - vdda-supply
> > +  - vddi-supply
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/gpio/gpio.h>
> > +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +
> > +      touchscreen@66 {
> > +        compatible = "touchnetix,ax54a";
> > +        reg = <0x66>;
> > +        interrupt-parent = <&gpio2>;
> > +        interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
> > +        reset-gpios = <&gpio1 1 GPIO_ACTIVE_HIGH>;
> > +        vdda-supply = <&vdda_reg>;
> > +        vddi-supply = <&vddi_reg>;
> > +        poll-interval = <20>;
> > +      };
> > +    };
> > +...
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 7608b714653f..4752d8436dbb 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -21431,6 +21431,12 @@ S:	Maintained
> >  F:	Documentation/ABI/testing/sysfs-class-firmware-attributes
> >  F:	drivers/platform/x86/think-lmi.?
> >
> > +TOUCHNETIX AXIOM I2C TOUCHSCREEN DRIVER
> > +M:	Kamel Bouhara <kamel.bouhara@bootlin.com>
> > +L:	linux-input@vger.kernel.org
> > +S:	Maintained
> > +F:	Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> > +
> >  THUNDERBOLT DMA TRAFFIC TEST DRIVER
> >  M:	Isaac Hazan <isaac.hazan@intel.com>
> >  L:	linux-usb@vger.kernel.org
> > --
> > 2.25.1
> >



--
Kamel Bouhara, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
Kamel Bouhara Dec. 13, 2023, 8:22 a.m. UTC | #4 
Hello Krzysztof,

Le Wed, Dec 13, 2023 at 07:44:33AM +0100, Krzysztof Kozlowski a écrit :
> On 12/12/2023 17:57, Conor Dooley wrote:
> > On Mon, Dec 11, 2023 at 01:14:28PM +0100, Kamel Bouhara wrote:
> >> Add the TouchNetix axiom I2C touchscreen device tree bindings
> >> documentation.
> >>
> >> Signed-off-by: Kamel Bouhara <kamel.bouhara@bootlin.com>
> >> ---
> >>  .../input/touchscreen/touchnetix,ax54a.yaml   | 64 +++++++++++++++++++
> >>  MAINTAINERS                                   |  6 ++
> >>  2 files changed, 70 insertions(+)
> >>  create mode 100644 Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> >>
> >> diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> >> new file mode 100644
> >> index 000000000000..cbdf48fc538b
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
> >> @@ -0,0 +1,64 @@
> >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> >> +%YAML 1.2
> >> +---
> >> +$id: http://devicetree.org/schemas/input/touchscreen/touchnetix,ax54a.yaml#
> >> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >> +
> >> +title: TouchNetix Axiom series touchscreen controller
> >> +
> >> +maintainers:
> >> +  - Kamel Bouhara <kamel.bouhara@bootlin.com>
> >> +
> >> +allOf:
> >> +  - $ref: /schemas/input/touchscreen/touchscreen.yaml#
> >
> > Weird, you add this ref here but do not actually allow any properties
> > from it since you have "additionalProperties: false" below.
> >
> > What's the point of its inclusion?
>
> It still brings the type of some fields or the constraints. However need
> of specifying "poll-interval" already points to missing
> unevaluatedProperties.

Ok, this wasn't clear for me wether or not I should pick
unevaluatedProperties as I still reference "poll-interval" from the
input.yaml schema ?

Regards,

--
Kamel Bouhara, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
Krzysztof Kozlowski Dec. 13, 2023, 8:46 a.m. UTC | #5 
On 13/12/2023 09:22, Kamel Bouhara wrote:
>> It still brings the type of some fields or the constraints. However need
>> of specifying "poll-interval" already points to missing
>> unevaluatedProperties.
> 
> Ok, this wasn't clear for me wether or not I should pick
> unevaluatedProperties 

Yes

> as I still reference "poll-interval" from the
> input.yaml schema ?

You should drop it from your binding.

Best regards,
Krzysztof
Kamel Bouhara Dec. 13, 2023, 9:14 a.m. UTC | #6 
Le Wed, Dec 13, 2023 at 09:46:03AM +0100, Krzysztof Kozlowski a écrit :
> On 13/12/2023 09:22, Kamel Bouhara wrote:
> >> It still brings the type of some fields or the constraints. However need
> >> of specifying "poll-interval" already points to missing
> >> unevaluatedProperties.
> >
> > Ok, this wasn't clear for me wether or not I should pick
> > unevaluatedProperties
>
> Yes
>
> > as I still reference "poll-interval" from the
> > input.yaml schema ?
>
> You should drop it from your binding.

The driver use it could you explain why I should drop it ?

--
Kamel Bouhara, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
Krzysztof Kozlowski Dec. 13, 2023, 9:15 a.m. UTC | #7 
On 13/12/2023 10:14, Kamel Bouhara wrote:
> Le Wed, Dec 13, 2023 at 09:46:03AM +0100, Krzysztof Kozlowski a écrit :
>> On 13/12/2023 09:22, Kamel Bouhara wrote:
>>>> It still brings the type of some fields or the constraints. However need
>>>> of specifying "poll-interval" already points to missing
>>>> unevaluatedProperties.
>>>
>>> Ok, this wasn't clear for me wether or not I should pick
>>> unevaluatedProperties
>>
>> Yes
>>
>>> as I still reference "poll-interval" from the
>>> input.yaml schema ?
>>
>> You should drop it from your binding.
> 
> The driver use it could you explain why I should drop it ?

Because it comes from input.yaml and you did not add any constraints, so
poll-interval here is redundant.

Best regards,
Krzysztof
Kamel Bouhara Dec. 13, 2023, 9:59 a.m. UTC | #8 
Le Wed, Dec 13, 2023 at 10:15:35AM +0100, Krzysztof Kozlowski a écrit :
> On 13/12/2023 10:14, Kamel Bouhara wrote:
> > Le Wed, Dec 13, 2023 at 09:46:03AM +0100, Krzysztof Kozlowski a écrit :
> >> On 13/12/2023 09:22, Kamel Bouhara wrote:
> >>>> It still brings the type of some fields or the constraints. However need
> >>>> of specifying "poll-interval" already points to missing
> >>>> unevaluatedProperties.
> >>>
> >>> Ok, this wasn't clear for me wether or not I should pick
> >>> unevaluatedProperties
> >>
> >> Yes
> >>
> >>> as I still reference "poll-interval" from the
> >>> input.yaml schema ?
> >>
> >> You should drop it from your binding.
> >
> > The driver use it could you explain why I should drop it ?
>
> Because it comes from input.yaml and you did not add any constraints, so
> poll-interval here is redundant.
>

Ok clear, thanks !

Regards,
--
Kamel Bouhara, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
new file mode 100644
index 000000000000..cbdf48fc538b
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
@@ -0,0 +1,64 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/touchnetix,ax54a.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TouchNetix Axiom series touchscreen controller
+
+maintainers:
+  - Kamel Bouhara <kamel.bouhara@bootlin.com>
+
+allOf:
+  - $ref: /schemas/input/touchscreen/touchscreen.yaml#
+  - $ref: /schemas/input/input.yaml#
+
+properties:
+  compatible:
+    const: touchnetix,ax54a
+
+  reg:
+    const: 0x66
+
+  interrupts:
+    maxItems: 1
+
+  reset-gpios:
+    maxItems: 1
+
+  vdda-supply:
+    description: Analog power supply regulator on VDDA pin
+
+  vddi-supply:
+    description: I/O power supply regulator on VDDI pin
+
+  poll-interval: true
+
+required:
+  - compatible
+  - reg
+  - vdda-supply
+  - vddi-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      touchscreen@66 {
+        compatible = "touchnetix,ax54a";
+        reg = <0x66>;
+        interrupt-parent = <&gpio2>;
+        interrupts = <2 IRQ_TYPE_EDGE_FALLING>;
+        reset-gpios = <&gpio1 1 GPIO_ACTIVE_HIGH>;
+        vdda-supply = <&vdda_reg>;
+        vddi-supply = <&vddi_reg>;
+        poll-interval = <20>;
+      };
+    };
+...
diff --git a/MAINTAINERS b/MAINTAINERS
index 7608b714653f..4752d8436dbb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -21431,6 +21431,12 @@  S:	Maintained
 F:	Documentation/ABI/testing/sysfs-class-firmware-attributes
 F:	drivers/platform/x86/think-lmi.?
 
+TOUCHNETIX AXIOM I2C TOUCHSCREEN DRIVER
+M:	Kamel Bouhara <kamel.bouhara@bootlin.com>
+L:	linux-input@vger.kernel.org
+S:	Maintained
+F:	Documentation/devicetree/bindings/input/touchscreen/touchnetix,ax54a.yaml
+
 THUNDERBOLT DMA TRAFFIC TEST DRIVER
 M:	Isaac Hazan <isaac.hazan@intel.com>
 L:	linux-usb@vger.kernel.org