diff mbox series

dt-bindings: input: atmel,captouch: convert bindings to YAML

Message ID 20240207090853.188400-1-dharma.b@microchip.com (mailing list archive)
State New, archived
Headers show
Series dt-bindings: input: atmel,captouch: convert bindings to YAML | expand

Commit Message

Dharma Balasubiramani Feb. 7, 2024, 9:08 a.m. UTC 
Convert the Atmel capacitive touchscreen bindings to YAML format.

Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.com>
---
 .../bindings/input/atmel,captouch.txt         | 36 -----------
 .../bindings/input/atmel,captouch.yaml        | 62 +++++++++++++++++++
 2 files changed, 62 insertions(+), 36 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/input/atmel,captouch.txt
 create mode 100644 Documentation/devicetree/bindings/input/atmel,captouch.yaml

Comments

Krzysztof Kozlowski Feb. 7, 2024, 3:15 p.m. UTC | #1 
On 07/02/2024 10:08, Dharma Balasubiramani wrote:
> Convert the Atmel capacitive touchscreen bindings to YAML format.
> 
> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.co

Thank you for your patch. There is something to discuss/improve.

> +
> +properties:
> +  compatible:
> +    const: atmel,captouch
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  linux,keycodes:
> +    minItems: 1
> +    maxItems: 8
> +
> +  autorepeat:
> +    type: boolean

You can drop entire property, coming from input.yaml.

> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - linux,keycodes
> +
> +additionalProperties: false

Instead:
unevaluatedProperties: false

> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    #include <dt-bindings/input/linux-event-codes.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      atmel-captouch@51 {

Instead:
touchscreen? touchpad? if none of these, then just "touch@51"

> +        compatible = "atmel,captouch";
> +        reg = <0x51>;


Best regards,
Krzysztof
Dharma Balasubiramani Feb. 8, 2024, 3:59 a.m. UTC | #2 
Hi Krzysztof,

On 07/02/24 8:45 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On 07/02/2024 10:08, Dharma Balasubiramani wrote:
>> Convert the Atmel capacitive touchscreen bindings to YAML format.
>>
>> Signed-off-by: Dharma Balasubiramani <dharma.b@microchip.co
> 
> Thank you for your patch. There is something to discuss/improve.
> 
>> +
>> +properties:
>> +  compatible:
>> +    const: atmel,captouch
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  linux,keycodes:
>> +    minItems: 1
>> +    maxItems: 8
>> +
>> +  autorepeat:
>> +    type: boolean
> 
> You can drop entire property, coming from input.yaml.

Sure, I will drop the 'linux,keycodes' and 'autorepeat' properties.
> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - linux,keycodes
>> +
>> +additionalProperties: false
> 
> Instead:
> unevaluatedProperties: false

Noted, Thanks.
> 
>> +
>> +examples:
>> +  - |
>> +    #include <dt-bindings/interrupt-controller/irq.h>
>> +    #include <dt-bindings/input/linux-event-codes.h>
>> +    i2c {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +      atmel-captouch@51 {
> 
> Instead:
> touchscreen? touchpad? if none of these, then just "touch@51"

I will go with touch@51.

Thanks.
> 
>> +        compatible = "atmel,captouch";
>> +        reg = <0x51>;
> 
> 
> Best regards,
> Krzysztof
>
Krzysztof Kozlowski Feb. 8, 2024, 7:29 a.m. UTC | #3 
On 08/02/2024 04:59, Dharma.B@microchip.com wrote:
>>> +
>>> +properties:
>>> +  compatible:
>>> +    const: atmel,captouch
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  linux,keycodes:
>>> +    minItems: 1
>>> +    maxItems: 8
>>> +
>>> +  autorepeat:
>>> +    type: boolean
>>
>> You can drop entire property, coming from input.yaml.
> 
> Sure, I will drop the 'linux,keycodes' and 'autorepeat' properties.

Why linux,keycodes? Is the size restricted in any other referenced schema?

Best regards,
Krzysztof
Dharma Balasubiramani Feb. 8, 2024, 8:36 a.m. UTC | #4 
Hi Krzysztof,

On 08/02/24 12:59 pm, Krzysztof Kozlowski wrote:
> EXTERNAL EMAIL: Do not click links or open attachments unless you know the content is safe
> 
> On 08/02/2024 04:59, Dharma.B@microchip.com wrote:
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    const: atmel,captouch
>>>> +
>>>> +  reg:
>>>> +    maxItems: 1
>>>> +
>>>> +  interrupts:
>>>> +    maxItems: 1
>>>> +
>>>> +  linux,keycodes:
>>>> +    minItems: 1
>>>> +    maxItems: 8
>>>> +
>>>> +  autorepeat:
>>>> +    type: boolean
>>>
>>> You can drop entire property, coming from input.yaml.
>>
>> Sure, I will drop the 'linux,keycodes' and 'autorepeat' properties.
> 
> Why linux,keycodes? Is the size restricted in any other referenced schema?

Sorry, I misinterpreted the statement "entire property(ies) coming from 
input.yaml".

The linux,keycodes size should be restricted to maxitems 8 here.

I will drop only the optional property "autorepeat".

Thanks.

> 
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/input/atmel,captouch.txt b/Documentation/devicetree/bindings/input/atmel,captouch.txt
deleted file mode 100644
index fe9ee5c53bcc..000000000000
--- a/Documentation/devicetree/bindings/input/atmel,captouch.txt
+++ /dev/null
@@ -1,36 +0,0 @@ 
-Device tree bindings for Atmel capacitive touch device, typically
-an Atmel touch sensor connected to AtmegaXX MCU running firmware
-based on Qtouch library.
-
-The node for this device must be a child of a I2C controller node, as the
-device communicates via I2C.
-
-Required properties:
-
-	compatible:	Must be "atmel,captouch".
-	reg:		The I2C slave address of the device.
-	interrupts:	Property describing the interrupt line the device
-			is connected to. The device only has one interrupt
-			source.
-	linux,keycodes:	Specifies an array of numeric keycode values to
-			be used for reporting button presses. The array can
-			contain up to 8 entries.
-
-Optional properties:
-
-	autorepeat:	Enables the Linux input system's autorepeat
-			feature on the input device.
-
-Example:
-
-	atmel-captouch@51 {
-		compatible = "atmel,captouch";
-		reg = <0x51>;
-		interrupt-parent = <&tlmm>;
-		interrupts = <67 IRQ_TYPE_EDGE_FALLING>;
-		linux,keycodes = <BTN_0>, <BTN_1>,
-			<BTN_2>, <BTN_3>,
-			<BTN_4>, <BTN_5>,
-			<BTN_6>, <BTN_7>;
-		autorepeat;
-	};
diff --git a/Documentation/devicetree/bindings/input/atmel,captouch.yaml b/Documentation/devicetree/bindings/input/atmel,captouch.yaml
new file mode 100644
index 000000000000..5d5679896bc9
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/atmel,captouch.yaml
@@ -0,0 +1,62 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/atmel,captouch.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel capacitive touch device
+
+maintainers:
+  - Dharma balasubiramani <dharma.b@microchip.com>
+
+description:
+  Atmel capacitive touch device, typically an Atmel touch sensor connected to
+  AtmegaXX MCU running firmware based on Qtouch library.
+
+allOf:
+  - $ref: input.yaml#
+
+properties:
+  compatible:
+    const: atmel,captouch
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  linux,keycodes:
+    minItems: 1
+    maxItems: 8
+
+  autorepeat:
+    type: boolean
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - linux,keycodes
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    #include <dt-bindings/input/linux-event-codes.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      atmel-captouch@51 {
+        compatible = "atmel,captouch";
+        reg = <0x51>;
+        interrupt-parent = <&tlmm>;
+        interrupts = <67 IRQ_TYPE_EDGE_FALLING>;
+        linux,keycodes = <BTN_0>, <BTN_1>,
+                         <BTN_2>, <BTN_3>,
+                         <BTN_4>, <BTN_5>,
+                         <BTN_6>, <BTN_7>;
+        autorepeat;
+      };
+    };