[PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[Sayyad Abid]

This patch fixes the issue with x-plat-ohm missing a type definition.
The patch adds the fix for this issue by adding value of this property
should be a 32-bit unsigned integer.

Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>

---
 .../devicetree/bindings/input/touchscreen/ti,tsc2005.yaml       | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
index 7187c390b2f5..98ff65cf9f9f 100644
--- a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
+++ b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
@@ -38,6 +38,8 @@ properties:
 
   ti,x-plate-ohms:
     description: resistance of the touchscreen's X plates in ohm (defaults to 280)
+    $ref: /schemas/types.yaml#/definitions/uint32
+
 
   ti,esd-recovery-timeout-ms:
     description: |
-- 
2.39.2

Re: [PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[Krzysztof Kozlowski]

On Sun, Sep 08, 2024 at 08:47:43PM +0530, Sayyad Abid wrote:
> This patch fixes the issue with x-plat-ohm missing a type definition.
> The patch adds the fix for this issue by adding value of this property

You repeated twice the same while it is unclear why this is missing.

Also:
Please do not use "This commit/patch/change", but imperative mood. See
longer explanation here:
https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95


> should be a 32-bit unsigned integer.
> 
> Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
> 
> ---
>  .../devicetree/bindings/input/touchscreen/ti,tsc2005.yaml       | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> index 7187c390b2f5..98ff65cf9f9f 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> @@ -38,6 +38,8 @@ properties:
>  
>    ti,x-plate-ohms:
>      description: resistance of the touchscreen's X plates in ohm (defaults to 280)

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

$ref should not be needed, so what is exactly missing? Provide some
sort of proof that you are fixing real issue.

> +

Just one blank line.


Best regards,
Krzysztof

Re: [PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[Sayyad Abid]

On Mon, Sep 9, 2024 at 1:21 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
>
> On 09/09/2024 09:48, Sayyad Abid wrote:
> > On Mon, Sep 9, 2024 at 12:02 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> >>
> >> On Sun, Sep 08, 2024 at 08:47:43PM +0530, Sayyad Abid wrote:
> >>> This patch fixes the issue with x-plat-ohm missing a type definition.
> >>> The patch adds the fix for this issue by adding value of this property
> >>
> >> You repeated twice the same while it is unclear why this is missing.
> > I must have overlooked it, my bad.
>
> Keep discussion public.
I am away form my desktop and trying to reply with Gmail's client,
I use mutt otherwise hence the trouble. I hit 'reply' instead of 'reply all'.
>
> >>
> >> Also:
> >> Please do not use "This commit/patch/change", but imperative mood. See
> >> longer explanation here:
> >> https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
> > Okay, I'll refer to this article for any further patches. Thank you!
> >>
> >>
> >>> should be a 32-bit unsigned integer.
> >>>
> >>> Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
> >>>
> >>> ---
> >>>  .../devicetree/bindings/input/touchscreen/ti,tsc2005.yaml       | 2 ++
> >>>  1 file changed, 2 insertions(+)
> >>>
> >>> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> >>> index 7187c390b2f5..98ff65cf9f9f 100644
> >>> --- a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> >>> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> >>> @@ -38,6 +38,8 @@ properties:
> >>>
> >>>    ti,x-plate-ohms:
> >>>      description: resistance of the touchscreen's X plates in ohm (defaults to 280)
> >>
> >>> +    $ref: /schemas/types.yaml#/definitions/uint32
> >>
> >> $ref should not be needed, so what is exactly missing? Provide some
> >> sort of proof that you are fixing real issue.
> > I ran dt_bindings_check on the file which resulted in a warning
> > "x-plate-ohm : missing type definition", to resolve this warning I
> > looked at the other yaml files in the ti,txc2005.yaml directory
> > (/Documentation/devicetree/bindings/input/touchscreen/), Where I found
> > out that one of the TI's touchscreen (ti,am3359) binding used $ref
> > property for the similar "x-plate-resistance" property.
> >
> > Adding the $ref resolved the warnings.
>
> You run some older dtschema.
I'll update this and check again.
>
> Anyway, each commit must explain why you are doing this. Whatever
> warning you fix, you should mention it in the commit msg, because that's
> the answer to "why?" part.
>
Yes, will keep this in mind for any further patches.
> Best regards,
> Krzysztof
>
Thank you for your time and input.

-- 
Abid

Re: [PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[Sayyad Abid]

On Mon, Sep 9, 2024 at 1:36 PM Sayyad Abid <sayyad.abid16@gmail.com> wrote:
>
> On Mon, Sep 9, 2024 at 1:21 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> >
> > On 09/09/2024 09:48, Sayyad Abid wrote:
> > > On Mon, Sep 9, 2024 at 12:02 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> > >>
> > >> On Sun, Sep 08, 2024 at 08:47:43PM +0530, Sayyad Abid wrote:
> > >>> This patch fixes the issue with x-plat-ohm missing a type definition.
> > >>> The patch adds the fix for this issue by adding value of this property
> > >>
> > >> You repeated twice the same while it is unclear why this is missing.
> > > I must have overlooked it, my bad.
> >
> > Keep discussion public.
> I am away form my desktop and trying to reply with Gmail's client,
> I use mutt otherwise hence the trouble. I hit 'reply' instead of 'reply all'.
> >
> > >>
> > >> Also:
> > >> Please do not use "This commit/patch/change", but imperative mood. See
> > >> longer explanation here:
> > >> https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
> > > Okay, I'll refer to this article for any further patches. Thank you!
> > >>
> > >>
> > >>> should be a 32-bit unsigned integer.
> > >>>
> > >>> Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
> > >>>
> > >>> ---
> > >>>  .../devicetree/bindings/input/touchscreen/ti,tsc2005.yaml       | 2 ++
> > >>>  1 file changed, 2 insertions(+)
> > >>>
> > >>> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> > >>> index 7187c390b2f5..98ff65cf9f9f 100644
> > >>> --- a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> > >>> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
> > >>> @@ -38,6 +38,8 @@ properties:
> > >>>
> > >>>    ti,x-plate-ohms:
> > >>>      description: resistance of the touchscreen's X plates in ohm (defaults to 280)
> > >>
> > >>> +    $ref: /schemas/types.yaml#/definitions/uint32
> > >>
> > >> $ref should not be needed, so what is exactly missing? Provide some
> > >> sort of proof that you are fixing real issue.
> > > I ran dt_bindings_check on the file which resulted in a warning
> > > "x-plate-ohm : missing type definition", to resolve this warning I
> > > looked at the other yaml files in the ti,txc2005.yaml directory
> > > (/Documentation/devicetree/bindings/input/touchscreen/), Where I found
> > > out that one of the TI's touchscreen (ti,am3359) binding used $ref
> > > property for the similar "x-plate-resistance" property.
> > >
> > > Adding the $ref resolved the warnings.
> >
> > You run some older dtschema.
> I'll update this and check again.
So I did a full clean clone of the kernel repo and followed the
dtschema installation
as mentioned in the Linux Kernel Documentation.
Running the dt_binding_check resulted in the same warning.
> >
> > Anyway, each commit must explain why you are doing this. Whatever
> > warning you fix, you should mention it in the commit msg, because that's
> > the answer to "why?" part.
> >
> Yes, will keep this in mind for any further patches.
> > Best regards,
> > Krzysztof
> >
> Thank you for your time and input.
>
> --
> Abid
What else should I try?

Thank You!

-- 
Abid

Re: [PATCH] dt-binding: touchscreen: fix x-plat-ohm missing type definition

[Krzysztof Kozlowski]

On 09/09/2024 14:48, Sayyad Abid wrote:
> On Mon, Sep 9, 2024 at 1:36 PM Sayyad Abid <sayyad.abid16@gmail.com> wrote:
>>
>> On Mon, Sep 9, 2024 at 1:21 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
>>>
>>> On 09/09/2024 09:48, Sayyad Abid wrote:
>>>> On Mon, Sep 9, 2024 at 12:02 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
>>>>>
>>>>> On Sun, Sep 08, 2024 at 08:47:43PM +0530, Sayyad Abid wrote:
>>>>>> This patch fixes the issue with x-plat-ohm missing a type definition.
>>>>>> The patch adds the fix for this issue by adding value of this property
>>>>>
>>>>> You repeated twice the same while it is unclear why this is missing.
>>>> I must have overlooked it, my bad.
>>>
>>> Keep discussion public.
>> I am away form my desktop and trying to reply with Gmail's client,
>> I use mutt otherwise hence the trouble. I hit 'reply' instead of 'reply all'.
>>>
>>>>>
>>>>> Also:
>>>>> Please do not use "This commit/patch/change", but imperative mood. See
>>>>> longer explanation here:
>>>>> https://elixir.bootlin.com/linux/v5.17.1/source/Documentation/process/submitting-patches.rst#L95
>>>> Okay, I'll refer to this article for any further patches. Thank you!
>>>>>
>>>>>
>>>>>> should be a 32-bit unsigned integer.
>>>>>>
>>>>>> Signed-off-by: Sayyad Abid <sayyad.abid16@gmail.com>
>>>>>>
>>>>>> ---
>>>>>>  .../devicetree/bindings/input/touchscreen/ti,tsc2005.yaml       | 2 ++
>>>>>>  1 file changed, 2 insertions(+)
>>>>>>
>>>>>> diff --git a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
>>>>>> index 7187c390b2f5..98ff65cf9f9f 100644
>>>>>> --- a/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
>>>>>> +++ b/Documentation/devicetree/bindings/input/touchscreen/ti,tsc2005.yaml
>>>>>> @@ -38,6 +38,8 @@ properties:
>>>>>>
>>>>>>    ti,x-plate-ohms:
>>>>>>      description: resistance of the touchscreen's X plates in ohm (defaults to 280)
>>>>>
>>>>>> +    $ref: /schemas/types.yaml#/definitions/uint32
>>>>>
>>>>> $ref should not be needed, so what is exactly missing? Provide some
>>>>> sort of proof that you are fixing real issue.
>>>> I ran dt_bindings_check on the file which resulted in a warning
>>>> "x-plate-ohm : missing type definition", to resolve this warning I
>>>> looked at the other yaml files in the ti,txc2005.yaml directory
>>>> (/Documentation/devicetree/bindings/input/touchscreen/), Where I found
>>>> out that one of the TI's touchscreen (ti,am3359) binding used $ref
>>>> property for the similar "x-plate-resistance" property.
>>>>
>>>> Adding the $ref resolved the warnings.
>>>
>>> You run some older dtschema.
>> I'll update this and check again.
> So I did a full clean clone of the kernel repo and followed the
> dtschema installation
> as mentioned in the Linux Kernel Documentation.
> Running the dt_binding_check resulted in the same warning.

The dtschema change fixing this ("schemas: property-units: Exclude some
non-conforming properties") is not yet in a released version, so I
suggest do nothing or try the latest dtschema from master. But in any
case this change does not look good. ohms should not have a ref, so even
if this warning is legitimate, the fix should be probably different.

Best regards,
Krzysztof