[PATCH] dt-bindings: input: touchscreen: goodix: clarify irq-gpios misleading text

[PATCH] dt-bindings: input: touchscreen: goodix: clarify irq-gpios misleading text

[Luca Ceresoli]

The irq-gpios description misleading, apparently saying that driving the
IRQ GPIO resets the device, which is even more puzzling as there is a reset
GPIO as well.

In reality the IRQ pin can be driven during the reset sequence to configure
the client address, as it becomes clear after checking both the datasheet
and the driver code. Improve the text to clarify that.

Also rephrase to remove reference to the driver, which is not appropriate
in the bindings.

Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
---
 .../devicetree/bindings/input/touchscreen/goodix.yaml         | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml b/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
index 3d016b87c8df..26ad104052ba 100644
--- a/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
+++ b/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
@@ -37,8 +37,8 @@ properties:
     maxItems: 1
 
   irq-gpios:
-    description: GPIO pin used for IRQ. The driver uses the interrupt gpio pin
-      as output to reset the device.
+    description: GPIO pin used for IRQ. The IRQ line can be driven during the
+      reset sequence to configure the client address.
     maxItems: 1
 
   reset-gpios:
-- 
2.34.1

Re: [PATCH] dt-bindings: input: touchscreen: goodix: clarify irq-gpios misleading text

[Jeff LaBundy]

Hi Luca,

On Wed, Apr 19, 2023 at 07:18:49PM +0200, Luca Ceresoli wrote:
> The irq-gpios description misleading, apparently saying that driving the
> IRQ GPIO resets the device, which is even more puzzling as there is a reset
> GPIO as well.
> 
> In reality the IRQ pin can be driven during the reset sequence to configure
> the client address, as it becomes clear after checking both the datasheet
> and the driver code. Improve the text to clarify that.
> 
> Also rephrase to remove reference to the driver, which is not appropriate
> in the bindings.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  .../devicetree/bindings/input/touchscreen/goodix.yaml         | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml b/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
> index 3d016b87c8df..26ad104052ba 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
> +++ b/Documentation/devicetree/bindings/input/touchscreen/goodix.yaml
> @@ -37,8 +37,8 @@ properties:
>      maxItems: 1
>  
>    irq-gpios:
> -    description: GPIO pin used for IRQ. The driver uses the interrupt gpio pin
> -      as output to reset the device.
> +    description: GPIO pin used for IRQ. The IRQ line can be driven during the
> +      reset sequence to configure the client address.

This is a step in the right direction, but in my humble opinion it is now
ambiguous who drives the bidirectional IRQ pin (device or driver). Perhaps
combining both versions conveys the appropriate message:

"...The driver uses the interrupt GPIO pin as an output to configure the client
address during the reset sequence."

>      maxItems: 1
>  
>    reset-gpios:
> -- 
> 2.34.1
> 

Kind regards,
Jeff LaBundy

Re: [PATCH] dt-bindings: input: touchscreen: goodix: clarify irq-gpios misleading text

[Rob Herring]

On Wed, 19 Apr 2023 19:18:49 +0200, Luca Ceresoli wrote:
> The irq-gpios description misleading, apparently saying that driving the
> IRQ GPIO resets the device, which is even more puzzling as there is a reset
> GPIO as well.
> 
> In reality the IRQ pin can be driven during the reset sequence to configure
> the client address, as it becomes clear after checking both the datasheet
> and the driver code. Improve the text to clarify that.
> 
> Also rephrase to remove reference to the driver, which is not appropriate
> in the bindings.
> 
> Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
> ---
>  .../devicetree/bindings/input/touchscreen/goodix.yaml         | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Reviewed-by: Rob Herring <robh@kernel.org>