| Message ID | 20230419171849.946986-1-luca.ceresoli@bootlin.com |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp556817vqo;
Wed, 19 Apr 2023 10:36:22 -0700 (PDT)
X-Google-Smtp-Source:
AKy350aQq0MVaQ213hYYkw/yle4dL+l1ADTiaESSPTkXE3axDCWVFgMk59nuVzHlX4gyxM/KUa+P
X-Received: by 2002:a05:6a00:189e:b0:625:e051:e462 with SMTP id
x30-20020a056a00189e00b00625e051e462mr5321190pfh.15.1681925781979;
Wed, 19 Apr 2023 10:36:21 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; t=1681925781; cv=none;
d=google.com; s=arc-20160816;
b=e4HK9NpA4c8RG2GuPhtWMO5GmbE0a49P+ivDyeQFcC5q7gj7b9oXxK4Ex1s5AtZBIM
Y5LSb1NQQ2eKExQjcnDK7DVXzluCfFwsdeUQgSJ0UWa1QPeLK/FcA9WYLX3XcS0foVcP
PiFMpzKNqDVJYHuPwLb7qXqSOydMcKuE7CaVUsm9jxRB8shWRaskUX9uAa/iszLgby9K
m47kYyEoksvw73yFUj6k4yefXGVAsQaQx0dEkO44cNJ7i8KYR9CYzOceYsYLzJkIVMQY
i//GMy4x4QZvJBMi9bYoYT7KPGIJF6IcKXilLRQRYCe9xqNNKLmGU25Ll+LelZC+CtDx
rpCA==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:content-transfer-encoding:mime-version
:message-id:date:subject:cc:to:from:dkim-signature;
bh=IKopK6ySs5davKjamt5/6SrPTUXqWy10uMvUkbDLpMw=;
b=KJfbbOApwbhi5qTbFExQFrUA0+9KGgjxzxJvIjMwjWy5tNCA2aGPFLNAYDNM3Thfj+
emEXg3wdVigWIhu2cl9fIC19N7LhypMKPfSgFHCI5tb45ukuPVz/YqQLF1KEFYuFLPts
qqKVHu4I6ySxSX3Qp32M+8prs8ucHvl2XGiLu1k2FQt1EyRhLx6dEUc7gAX3X9uwK0m8
VmdVYzxmwe/4DWSOWTTlIywxzsCtg/RPEV/OsEbFnX2pVXECUcHVR0ZTaQa/Ot8elTnh
yaCEoj+/TQJPHIlCVl/ZQFjbTOA7ws7qMSmerWMV5/3lEcgcS6xepKXNqjDfcVQJUzHk
G5JA==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@bootlin.com header.s=gm1 header.b=opbBz3i4;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com
Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20])
by mx.google.com with ESMTP id
w17-20020aa79a11000000b0063b754972f4si12863526pfj.159.2023.04.19.10.36.05;
Wed, 19 Apr 2023 10:36:21 -0700 (PDT)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
client-ip=2620:137:e000::1:20;
Authentication-Results: mx.google.com;
dkim=pass header.i=@bootlin.com header.s=gm1 header.b=opbBz3i4;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S231927AbjDSRTB (ORCPT <rfc822;peter110.wang@gmail.com>
+ 99 others); Wed, 19 Apr 2023 13:19:01 -0400
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36732 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S229558AbjDSRTA (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Wed, 19 Apr 2023 13:19:00 -0400
Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net
[217.70.183.197])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D8B58769D;
Wed, 19 Apr 2023 10:18:57 -0700 (PDT)
Received: from booty.fritz.box (unknown [77.244.183.192])
(Authenticated sender: luca.ceresoli@bootlin.com)
by mail.gandi.net (Postfix) with ESMTPA id 25DB11C0003;
Wed, 19 Apr 2023 17:18:55 +0000 (UTC)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1;
t=1681924736;
h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
to:to:cc:cc:mime-version:mime-version:
content-transfer-encoding:content-transfer-encoding;
bh=IKopK6ySs5davKjamt5/6SrPTUXqWy10uMvUkbDLpMw=;
b=opbBz3i4AlnSeXYPRzVoCf/grp9GjMYTtivQDNZDLVgCVm2kcMxsrWz7UkG95gNA5IbwPR
RH9tC1I5NRjBPKbef++M45g259SeHE4cjL9XUrE+Oi26zlxSh+qu9jnwmC/4zx4xxcgnse
NGeziyfdGb3Z5tGbW/wDSJPA+RSfxgRgKw+MehLb592JbWDBji9uiUBwGDrbT6jYYoQO1A
PZx+C7d0GHxeJ12x8JS/AY+e4404RskSWuVQB3Kz7wjmt5ijldXyAd6EJ97N2PoDAosDz7
2cl3oCUwZhL+SqCJLiChkGMnxDMQ/oi3wDYsUOejQ6//5yzaJQxuQImSCLcqUA==
From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: Dmitry Torokhov <dmitry.torokhov@gmail.com>,
devicetree@vger.kernel.org
Cc: Luca Ceresoli <luca.ceresoli@bootlin.com>,
Rob Herring <robh+dt@kernel.org>,
Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
Stephen Boyd <sboyd@kernel.org>,
Jarrah Gosbell <kernel@undef.tools>,
linux-input@vger.kernel.org, linux-kernel@vger.kernel.org,
Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH] dt-bindings: input: touchscreen: goodix: clarify irq-gpios
misleading text
Date: Wed, 19 Apr 2023 19:18:49 +0200
Message-Id: <20230419171849.946986-1-luca.ceresoli@bootlin.com>
X-Mailer: git-send-email 2.34.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,
RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE,
URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?=
X-GMAIL-THRID: =?utf-8?q?1763627008457465953?=
X-GMAIL-MSGID: =?utf-8?q?1763627008457465953?=
|
| Series |
dt-bindings: input: touchscreen: goodix: clarify irq-gpios misleading text
|
|
Commit Message
Luca Ceresoli
April 19, 2023, 5:18 p.m. UTC
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(-)
Comments
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
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>
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: