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;
Message-ID: <cdfb3f44-4400-1386-42cb-0fb7b30e45db@theobroma-systems.com>
Date:   Tue, 6 Dec 2022 12:11:06 +0100
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.5.0
Subject: Re: [PATCH v3 6/9] arm64: dts: allwinner: fix touchscreen reset GPIO
 polarity
Content-Language: en-US
To:     Samuel Holland <samuel@sholland.org>,
        Quentin Schulz <foss+kernel@0leil.net>
Cc:     linux-input@vger.kernel.org, linux-arm-msm@vger.kernel.org,
        linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org,
        linux-sunxi@lists.linux.dev, devicetree@vger.kernel.org,
        linux-rockchip@lists.infradead.org,
        Bastien Nocera <hadess@hadess.net>,
        =?UTF-8?Q?Guido_G=c3=bcnther?= <agx@sigxcpu.org>,
        Sascha Hauer <s.hauer@pengutronix.de>,
        Pengutronix Kernel Team <kernel@pengutronix.de>,
        Angus Ainslie <angus@akkea.ca>,
        Ondrej Jirman <megous@megous.com>,
        Icenowy Zheng <icenowy@aosc.io>,
        Andy Gross <agross@kernel.org>,
        Aleksei Mamlin <mamlinav@gmail.com>,
        Fabio Estevam <festevam@gmail.com>,
        David Jander <david@protonic.nl>,
        Frieder Schrempf <frieder.schrempf@kontron.de>,
        Bjorn Andersson <andersson@kernel.org>,
        Konrad Dybcio <konrad.dybcio@somainline.org>,
        Peter Geis <pgwipeout@gmail.com>,
        Heiko Stuebner <heiko@sntech.de>,
        Shawn Guo <shawnguo@kernel.org>,
        Jernej Skrabec <jernej.skrabec@gmail.com>,
        Lukasz Majewski <lukma@denx.de>,
        AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@somainline.org>,
        Chen-Yu Tsai <wens@csie.org>,
        Michael Riesch <michael.riesch@wolfvision.net>,
        Rob Herring <robh+dt@kernel.org>,
        NXP Linux Team <linux-imx@nxp.com>,
        Dmitry Torokhov <dmitry.torokhov@gmail.com>,
        Hans de Goede <hdegoede@redhat.com>,
        Jagan Teki <jagan@amarulasolutions.com>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
References: <20221103-upstream-goodix-reset-v3-0-0975809eb183@theobroma-systems.com>
 <20221103-upstream-goodix-reset-v3-6-0975809eb183@theobroma-systems.com>
 <a0c767d5-eb55-3479-c4bc-1029809027f5@sholland.org>
From:   Quentin Schulz <quentin.schulz@theobroma-systems.com>
In-Reply-To: <a0c767d5-eb55-3479-c4bc-1029809027f5@sholland.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Z1c4Y3lMMDFLN2RSTjVKdkQ0K1F0Y2oyekxZUTdaeXQ5VGVqOXdsbXlUUWkr?=
 =?utf-8?B?NDZWTnd3clIzelBBOVVlOVM2KzkyRTlITkhrUmpLeFB5eUZRYkczMnNFTFk5?=
 =?utf-8?B?UTVaTWlNemtyNXBLakQvaFEwbC9HWTlRTHpTM0pKZzZOL3dxUHUzZEZjcFVQ?=
 =?utf-8?B?bzA5STFLS0lGMDdlTkpNOWgxbnRWcEt1QUdEZndod2ZLWEtOaTVjL2FzZUd6?=
 =?utf-8?B?MHQwUERPT0lWSE9tb3ZpWlJOM3VZdG4yaVFoSGsyckdKYzF6ZFBjbkhLL1p2?=
 =?utf-8?B?VlFzcXJZMHdrb21aaURGSlRtWWZSWVNaVkp4UVpCL2hUYTBYT3V0Ump4YWtl?=
 =?utf-8?B?Q0JNNFBadWZvNzZEdnp4TWtlOVh5bVFSWFNlWXVqNDFlYWNJZXptY2MwVDRG?=
 =?utf-8?B?Y2hRZFUrcFpXY2NnRFpZbGVJSEJrUkJDTTI2cHdYTzVGdzRFV0lGbkdIY1Qy?=
 =?utf-8?B?VHZ3anVvWWVmaGVNdTVlSEtCa291bDJtTS9naUdoUDlpc21rTm1nejRwOCtP?=
 =?utf-8?B?d1ZEQ21lZFdVOGNadHlQYW1LR1FqSlNUMnNEOVMrQzRzenl1K2Y5YTl4ZENK?=
 =?utf-8?B?bEd5aXVRWnR0VjQ3NFpwQW51YUE3NDFwaytlR3FIQ21PWHFYajVJc2xRZVcv?=
 =?utf-8?B?OHZra2x2TFFxQkZtSkRpdVJKeGVJVnQ3cmd6LzhGZytSMlZCZUp4VGIvSmVn?=
 =?utf-8?B?aEI3N1VrOHhvRVkxTHE3Q0xXalZkVkhZMnptd3d4bVpxbE5SS1ZpU0dxYkhO?=
 =?utf-8?B?Z1UxLytoa1VLcmdEY015QXpVYTJKWnBGRFBnU1JwcEpDamMzZVlJZHdwT1Bx?=
 =?utf-8?B?LzV4VHhIQWFTc0hvZi9WeDN4TXQ4NmFCTENDSjJkNi9PWTk1aWZDVVNyemtt?=
 =?utf-8?B?b0xIQ3ZvdWlsdVVLY0YwakNjV2UrR091cE94a3hNYWN2eXlERXFOdFR3d1JW?=
 =?utf-8?B?dDdVRlVadXZvSXdEQ1p2andqUDNkNkd4czI2YUh4VlVmWlQwN1prMnZYWXIv?=
 =?utf-8?B?N3J6cytoeVIzeHZsL25qQVZTZ1hEdHgwYmU3bFBiT2dSL0NtOFpST1RJQkVE?=
 =?utf-8?B?RHlZRTJSYUhEa3diQm1hVHhGSjdzRTdkMzkzTEZ3UExwVkUyWHJpK2JIZHBa?=
 =?utf-8?B?d2hEOFBQaVl6VlI4MXM5RXVBbFVwRnlwdmlCWUozTTZaZGpSUUtPeFFVcWpG?=
 =?utf-8?B?anpOeDVHVTF1LzZnVDMwdnArTktjTHZSMEx1WVNkbUxiTUEzYkhpclFiQnQ1?=
 =?utf-8?B?UlV1UllyTWJrWFFOYXQ4L1lZcTdsRkx4L3hIWlhsemE0NmhpcVBoTmxlZ0dj?=
 =?utf-8?B?Zm8vM2NFRy9TZVJ5TmFKQzRMZFVVbnZ2YWhUdmttMVNjOWYrMFYxR3NiYlhS?=
 =?utf-8?B?SEtNLzV5R0w1WW5PYllEaVJUSEI1QU9MNGFvNVBrUndBSmJLQzdMRDFDa2hB?=
 =?utf-8?B?QnNOZ3RQczFoM2IzSm5KNWROR2pwODFCNmJ6SWM3ZGVVNTlQeGFzSG1vY0E2?=
 =?utf-8?B?M1M1Ry94cDNuWGdrSWp4SlgxRFZmYks0SmkxeHU2aEtsQ2tQT3BhaVRQOUZp?=
 =?utf-8?B?cnJHYWIxdVdmMWV1Wk9PUWN6NE1JeTlOOUxRa1hSc016c3diS2pLdTVhRGZx?=
 =?utf-8?B?NUtaT3BtR1BzenNZNUpSMEpvdXhkT1VYK2tYUjVRL0RHbFN5d29IOFd1Yklx?=
 =?utf-8?B?ZCtSSEdnbUNuMElERFpNbjNjaC9hU3k3dUtmTmVFL0RTMkNnTHpvSlc3S0dq?=
 =?utf-8?B?QXEvWUVvcEJETFF2WEJwOXBJMkRmN2Qxck9lTURqcTFueUo5bWoyaTdqRHlH?=
 =?utf-8?B?UHd6SFlCQmVwM1J2eEg1RVhKZjZHSm5XN052SWFzb0phaWZxZDM2c1BtTnpy?=
 =?utf-8?B?YXRra05xQWF3L0JSZHFsbmtXcTZZN0FiWHhLVUJZUDFzWkkwUVJDeThuc3Iz?=
 =?utf-8?B?RlRUOFdlY3pTbVZYa1dFYTg4aTE0cFFVTHZaM0pxUDVwZUJQbVNOcm5wa1hO?=
 =?utf-8?B?ZFFSME9kb1ZOaVZnb3VMb2lCNU5wUmppVHhObmhjMzYyVHp6WmphZkphSWpM?=
 =?utf-8?B?d0duTy9yeW1uQm11bklCMVI2L0RhV2RQZ2JnVlBpaWtCT1VaYWtIM1ZRUXdt?=
 =?utf-8?B?SE9PUHZrYnZXTEpPVWFMTUttK3Ewam8rQTl1WksvK3ZhaTRyenZBREdSQ3VZ?=
 =?utf-8?Q?qNpVdXyRlIeMGoygxcS9icA=3D?=
X-OriginatorOrg: theobroma-systems.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 2350755d-186f-424e-4132-08dad77a93a4
X-MS-Exchange-CrossTenant-AuthSource: DU2PR04MB8536.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Dec 2022 11:11:10.7157
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5e0e1b52-21b5-4e7b-83bb-514ec460677e
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: dNRvWMEsLAtxPQRO+hbxmMA2rmQb0iupD/UqJ+5tURePBEcAU7Y3W6Bmy7tEnPcBgPMYgeagLPqbA37nXVpTExqpdqWSbYKbRwboWSDNQHle0M54s+mxEMhYgz6K3eLm
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAXPR04MB8782
X-Spam-Status: No, score=-2.4 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS 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

Hi Samuel,

On 12/6/22 01:26, Samuel Holland wrote:
> Hi Quentin,
> 
> On 12/5/22 07:40, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>>
>> The reset line is active low for the Goodix touchscreen controller so
>> let's fix the polarity in the Device Tree node.
>>
>> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>> ---
>>   arch/arm64/boot/dts/allwinner/sun50i-a64-amarula-relic.dts       | 2 +-
>>   arch/arm64/boot/dts/allwinner/sun50i-a64-oceanic-5205-5inmfd.dts | 2 +-
>>   arch/arm64/boot/dts/allwinner/sun50i-a64-pinephone.dtsi          | 2 +-
>>   arch/arm64/boot/dts/allwinner/sun50i-a64-pinetab.dts             | 2 +-
>>   4 files changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/arch/arm64/boot/dts/allwinner/sun50i-a64-amarula-relic.dts b/arch/arm64/boot/dts/allwinner/sun50i-a64-amarula-relic.dts
>> index 8233582f62881..5fd581037d987 100644
>> --- a/arch/arm64/boot/dts/allwinner/sun50i-a64-amarula-relic.dts
>> +++ b/arch/arm64/boot/dts/allwinner/sun50i-a64-amarula-relic.dts
>> @@ -122,7 +122,7 @@ touchscreen@5d {
>>   		interrupt-parent = <&pio>;
>>   		interrupts = <7 4 IRQ_TYPE_EDGE_FALLING>;
>>   		irq-gpios = <&pio 7 4 GPIO_ACTIVE_HIGH>;	/* CTP-INT: PH4 */
>> -		reset-gpios = <&pio 7 8 GPIO_ACTIVE_HIGH>;	/* CTP-RST: PH8 */
>> +		reset-gpios = <&pio 7 8 GPIO_ACTIVE_LOW>;	/* CTP-RST: PH8 */
> 
> You are changing the DT binding here, in a way that breaks backward
> compatibility with existing devicetrees. NACK.
> 

Yes.

Some boards will get their DT binding broken, there's no way around it 
sadly.

We know already that the PRT8MM DT binding was written with a different 
understanding than for other boards. There are some board schematics I 
don't have access to so maybe the same applies to those.

A reminder that even if you got your polarity wrong, it could still work 
in some cases (timings right today but nothing guaranteed it'll stay 
this way forever).

with the current driver, what I assume we should get for an "incorrect" 
polarity (with GPIO_ACTIVE_LOW) is:
             ___________________
INT _______|                   |___________

     ____________           __________________
RST             |_________|

    ^
    L__ pull-up on RST so high by default
         ^
         L___ gpiod_direction_output(0) (deassert GPIO active-low, so high)
            ^
            L____ goodix_irq_direction_output
                 ^
                 L___ gpiod_direction_output(1) (assert GPIO active-low, 
so low)
                           ^
                           L____ gpiod_direction_input() (floating, 
pull-up on RST so high)

This works because of the pull-up on RST and that what matters is that 
the INT lane is configured 100µs before a rising edge on RST line (for 
at least 5ms). However, the init sequence is not properly followed and 
might get broken in the future since it is not something that we 
explicitly support.

With the proposed patch:
             ___________________
INT _______|                   |___________

     ____         __________________
RST     |_______|

    ^
    L__ pull-up on RST so high by default
         ^
         L___ gpiod_direction_output(1) (assert GPIO active-low, so low)
            ^
            L____ goodix_irq_direction_output
                 ^
                 L___ gpiod_direction_output(1) (deassert GPIO 
active-low, so high)
                           ^
                           L____ gpiod_direction_input() (floating, 
pull-up on RST so high)

This should work too and does not rely on some side effects/timings and 
should be future-proof.

The other option would be to only fix known "broken" boards (e.g. 
PRT8MM, maybe others) and specify in the DT binding documentation that 
the reset-gpios polarity is "inverted" (that is, the reset is asserted 
when the reset-gpios as specified in the DT is deasserted). This makes 
the DT binding documentation **implementation specific** which is 
everything the DT binding is trying to avoid.

Something needs to be done, and no solution will make everyone happy.

Cheers,
Quentin