[PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Javier Carrasco]

The ISRs of the tps25750 and tps6598x do not handle generated events
properly under all circumstances.

The tps6598x ISR does not read all bits of the INT_EVENTX registers,
leaving events signaled with bits above 64 unattended. Moreover, these
events are not cleared, leaving the interrupt enabled.

The tps25750 reads all bits of the INT_EVENT1 register, but the event
checking is not right because the same event is checked in two different
regions of the same register by means of an OR operation.

This series aims to fix both issues by reading all bits of the
INT_EVENTX registers, and limiting the event checking to the region
where the supported events are defined (currently they are limited to
the first 64 bits of the registers, as the are defined as BIT_ULL()).

If the need for events above the first 64 bits of the INT_EVENTX
registers arises, a different mechanism might be required. But for the
current needs, all definitions can be left as they are.

Note: resend to add 'stable' mailing list (fixes in the series).

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
Javier Carrasco (2):
      usb: typec: tipd: fix event checking for tps25750
      usb: typec: tipd: fix event checking for tps6598x

 drivers/usb/typec/tipd/core.c | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)
---
base-commit: 4cece764965020c22cff7665b18a012006359095
change-id: 20240328-tps6598x_fix_event_handling-8fff3a6018d9

Best regards,
-- 
Javier Carrasco <javier.carrasco@wolfvision.net>

[PATCH RESEND 1/2] usb: typec: tipd: fix event checking for tps25750

[Javier Carrasco]

In its current form, the interrupt service routine of the tps25750
checks the event flags in the lowest 64 bits of the interrupt event
register (event[0]), but also in the upper part (event[1]).

Given that all flags are defined as BIT() or BIT_ULL(), they are
restricted to the first 64 bits of the INT_EVENT1 register. Including
the upper part of the register can lead to false positives e.g. if the
event 64 bits above the one being checked is set, but the one being
checked is not.

Restrict the flag checking to the first 64 bits of the INT_EVENT1
register.

Fixes: 7e7a3c815d22 ("USB: typec: tps6598x: Add TPS25750 support")
Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 drivers/usb/typec/tipd/core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/usb/typec/tipd/core.c b/drivers/usb/typec/tipd/core.c
index 0717cfcd9f8c..7c2f01344860 100644
--- a/drivers/usb/typec/tipd/core.c
+++ b/drivers/usb/typec/tipd/core.c
@@ -604,11 +604,11 @@ static irqreturn_t tps25750_interrupt(int irq, void *data)
 	if (!tps6598x_read_status(tps, &status))
 		goto err_clear_ints;
 
-	if ((event[0] | event[1]) & TPS_REG_INT_POWER_STATUS_UPDATE)
+	if (event[0] & TPS_REG_INT_POWER_STATUS_UPDATE)
 		if (!tps6598x_read_power_status(tps))
 			goto err_clear_ints;
 
-	if ((event[0] | event[1]) & TPS_REG_INT_DATA_STATUS_UPDATE)
+	if (event[0] & TPS_REG_INT_DATA_STATUS_UPDATE)
 		if (!tps6598x_read_data_status(tps))
 			goto err_clear_ints;
 
@@ -617,7 +617,7 @@ static irqreturn_t tps25750_interrupt(int irq, void *data)
 	 * a plug event. Therefore, we need to check
 	 * for pr/dr status change to set TypeC dr/pr accordingly.
 	 */
-	if ((event[0] | event[1]) & TPS_REG_INT_PLUG_EVENT ||
+	if (event[0] & TPS_REG_INT_PLUG_EVENT ||
 	    tps6598x_has_role_changed(tps, status))
 		tps6598x_handle_plug_event(tps, status);
 

-- 
2.40.1

[PATCH RESEND 2/2] usb: typec: tipd: fix event checking for tps6598x

[Javier Carrasco]

The current interrupt service routine of the tps6598x only reads the
first 64 bits of the INT_EVENT1 and INT_EVENT2 registers, which means
that any event above that range will be ignored, leaving interrupts
unattended. Moreover, those events will not be cleared, and the device
will keep the interrupt enabled.

This issue has been observed while attempting to load patches, and the
'ReadyForPatch' field (bit 81) of INT_EVENT1 was set.

Read the complete INT_EVENT registers to handle all interrupts generated
by the device in a similar fashion to what is already done for the
tps25750.

Fixes: 0a4c005bd171 ("usb: typec: driver for TI TPS6598x USB Power Delivery controllers")
Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 drivers/usb/typec/tipd/core.c | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/drivers/usb/typec/tipd/core.c b/drivers/usb/typec/tipd/core.c
index 7c2f01344860..308748d6cae6 100644
--- a/drivers/usb/typec/tipd/core.c
+++ b/drivers/usb/typec/tipd/core.c
@@ -637,48 +637,53 @@ static irqreturn_t tps25750_interrupt(int irq, void *data)
 static irqreturn_t tps6598x_interrupt(int irq, void *data)
 {
 	struct tps6598x *tps = data;
-	u64 event1 = 0;
-	u64 event2 = 0;
+	u64 event1[2] = { };
+	u64 event2[2] = { };
 	u32 status;
 	int ret;
 
 	mutex_lock(&tps->lock);
 
-	ret = tps6598x_read64(tps, TPS_REG_INT_EVENT1, &event1);
-	ret |= tps6598x_read64(tps, TPS_REG_INT_EVENT2, &event2);
+	ret = tps6598x_block_read(tps, TPS_REG_INT_EVENT1, event1, 11);
 	if (ret) {
-		dev_err(tps->dev, "%s: failed to read events\n", __func__);
+		dev_err(tps->dev, "%s: failed to read event1\n", __func__);
 		goto err_unlock;
 	}
-	trace_tps6598x_irq(event1, event2);
+	ret = tps6598x_block_read(tps, TPS_REG_INT_EVENT2, event2, 11);
+	if (ret) {
+		dev_err(tps->dev, "%s: failed to read event2\n", __func__);
+		goto err_unlock;
+	}
+	trace_tps6598x_irq(event1[0], event2[0]);
 
-	if (!(event1 | event2))
+	if (!(event1[0] | event1[1] | event2[0] | event2[1]))
 		goto err_unlock;
 
 	if (!tps6598x_read_status(tps, &status))
 		goto err_clear_ints;
 
-	if ((event1 | event2) & TPS_REG_INT_POWER_STATUS_UPDATE)
+	if ((event1[0] | event2[0]) & TPS_REG_INT_POWER_STATUS_UPDATE)
 		if (!tps6598x_read_power_status(tps))
 			goto err_clear_ints;
 
-	if ((event1 | event2) & TPS_REG_INT_DATA_STATUS_UPDATE)
+	if ((event1[0] | event2[0]) & TPS_REG_INT_DATA_STATUS_UPDATE)
 		if (!tps6598x_read_data_status(tps))
 			goto err_clear_ints;
 
 	/* Handle plug insert or removal */
-	if ((event1 | event2) & TPS_REG_INT_PLUG_EVENT)
+	if ((event1[0] | event2[0]) & TPS_REG_INT_PLUG_EVENT)
 		tps6598x_handle_plug_event(tps, status);
 
 err_clear_ints:
-	tps6598x_write64(tps, TPS_REG_INT_CLEAR1, event1);
-	tps6598x_write64(tps, TPS_REG_INT_CLEAR2, event2);
+	tps6598x_block_write(tps, TPS_REG_INT_CLEAR1, event1, 11);
+	tps6598x_block_write(tps, TPS_REG_INT_CLEAR2, event2, 11);
 
 err_unlock:
 	mutex_unlock(&tps->lock);
 
-	if (event1 | event2)
+	if (event1[0] | event1[1] | event2[0] | event2[1])
 		return IRQ_HANDLED;
+
 	return IRQ_NONE;
 }
 

-- 
2.40.1

Re: [PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Greg Kroah-Hartman]

On Thu, Mar 28, 2024 at 05:25:20PM +0100, Javier Carrasco wrote:
> The ISRs of the tps25750 and tps6598x do not handle generated events
> properly under all circumstances.
> 
> The tps6598x ISR does not read all bits of the INT_EVENTX registers,
> leaving events signaled with bits above 64 unattended. Moreover, these
> events are not cleared, leaving the interrupt enabled.
> 
> The tps25750 reads all bits of the INT_EVENT1 register, but the event
> checking is not right because the same event is checked in two different
> regions of the same register by means of an OR operation.
> 
> This series aims to fix both issues by reading all bits of the
> INT_EVENTX registers, and limiting the event checking to the region
> where the supported events are defined (currently they are limited to
> the first 64 bits of the registers, as the are defined as BIT_ULL()).
> 
> If the need for events above the first 64 bits of the INT_EVENTX
> registers arises, a different mechanism might be required. But for the
> current needs, all definitions can be left as they are.
> 
> Note: resend to add 'stable' mailing list (fixes in the series).


<formletter>

This is not the correct way to submit patches for inclusion in the
stable kernel tree.  Please read:
    https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
for how to do this properly.

</formletter>

Re: [PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Javier Carrasco]

On 3/28/24 17:44, Greg Kroah-Hartman wrote:
> On Thu, Mar 28, 2024 at 05:25:20PM +0100, Javier Carrasco wrote:
>> The ISRs of the tps25750 and tps6598x do not handle generated events
>> properly under all circumstances.
>>
>> The tps6598x ISR does not read all bits of the INT_EVENTX registers,
>> leaving events signaled with bits above 64 unattended. Moreover, these
>> events are not cleared, leaving the interrupt enabled.
>>
>> The tps25750 reads all bits of the INT_EVENT1 register, but the event
>> checking is not right because the same event is checked in two different
>> regions of the same register by means of an OR operation.
>>
>> This series aims to fix both issues by reading all bits of the
>> INT_EVENTX registers, and limiting the event checking to the region
>> where the supported events are defined (currently they are limited to
>> the first 64 bits of the registers, as the are defined as BIT_ULL()).
>>
>> If the need for events above the first 64 bits of the INT_EVENTX
>> registers arises, a different mechanism might be required. But for the
>> current needs, all definitions can be left as they are.
>>
>> Note: resend to add 'stable' mailing list (fixes in the series).
> 
> 
> <formletter>
> 
> This is not the correct way to submit patches for inclusion in the
> stable kernel tree.  Please read:
>     https://www.kernel.org/doc/html/latest/process/stable-kernel-rules.html
> for how to do this properly.
> 
> </formletter>

Sorry, I will add stable@vger.kernel.org right above the Signed-off-by:
instead of adding to the Cc list and resend again.

Re: [PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Javier Carrasco]

On 4/2/24 12:21, Heikki Krogerus wrote:
> On Thu, Mar 28, 2024 at 05:55:50PM +0100, Javier Carrasco wrote:
>> The ISRs of the tps25750 and tps6598x do not handle generated events
>> properly under all circumstances.
>>
>> The tps6598x ISR does not read all bits of the INT_EVENTX registers,
>> leaving events signaled with bits above 64 unattended. Moreover, these
>> events are not cleared, leaving the interrupt enabled.
>>
>> The tps25750 reads all bits of the INT_EVENT1 register, but the event
>> checking is not right because the same event is checked in two different
>> regions of the same register by means of an OR operation.
>>
>> This series aims to fix both issues by reading all bits of the
>> INT_EVENTX registers, and limiting the event checking to the region
>> where the supported events are defined (currently they are limited to
>> the first 64 bits of the registers, as the are defined as BIT_ULL()).
>>
>> If the need for events above the first 64 bits of the INT_EVENTX
>> registers arises, a different mechanism might be required. But for the
>> current needs, all definitions can be left as they are.
>>
>> Note: resend to add the Cc tag for 'stable' (fixes in the series).
> 
> So this should be v3 (or v2?). Next time please follow the guide
> when submitting patches:
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#the-canonical-patch-format
> 
> thanks,
> 
The first resend only added 'stable' to Cc (which was wrong) with no
modifications at all, and the second resend (this one) actually modified
the commit description to include 'stable', which should have turned it
into a v2.

I will tag the next version as v3 to account for this, thanks for the
feedback.

Best regards,
Javier Carrasco

Re: [PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Heikki Krogerus]

On Thu, Mar 28, 2024 at 05:55:50PM +0100, Javier Carrasco wrote:
> The ISRs of the tps25750 and tps6598x do not handle generated events
> properly under all circumstances.
> 
> The tps6598x ISR does not read all bits of the INT_EVENTX registers,
> leaving events signaled with bits above 64 unattended. Moreover, these
> events are not cleared, leaving the interrupt enabled.
> 
> The tps25750 reads all bits of the INT_EVENT1 register, but the event
> checking is not right because the same event is checked in two different
> regions of the same register by means of an OR operation.
> 
> This series aims to fix both issues by reading all bits of the
> INT_EVENTX registers, and limiting the event checking to the region
> where the supported events are defined (currently they are limited to
> the first 64 bits of the registers, as the are defined as BIT_ULL()).
> 
> If the need for events above the first 64 bits of the INT_EVENTX
> registers arises, a different mechanism might be required. But for the
> current needs, all definitions can be left as they are.
> 
> Note: resend to add the Cc tag for 'stable' (fixes in the series).

So this should be v3 (or v2?). Next time please follow the guide
when submitting patches:
https://www.kernel.org/doc/html/latest/process/submitting-patches.html#the-canonical-patch-format

thanks,

-- 
heikki

[PATCH RESEND 0/2] usb: typec: tipd: fix event checking in interrupt service routines

[Javier Carrasco]

The ISRs of the tps25750 and tps6598x do not handle generated events
properly under all circumstances.

The tps6598x ISR does not read all bits of the INT_EVENTX registers,
leaving events signaled with bits above 64 unattended. Moreover, these
events are not cleared, leaving the interrupt enabled.

The tps25750 reads all bits of the INT_EVENT1 register, but the event
checking is not right because the same event is checked in two different
regions of the same register by means of an OR operation.

This series aims to fix both issues by reading all bits of the
INT_EVENTX registers, and limiting the event checking to the region
where the supported events are defined (currently they are limited to
the first 64 bits of the registers, as the are defined as BIT_ULL()).

If the need for events above the first 64 bits of the INT_EVENTX
registers arises, a different mechanism might be required. But for the
current needs, all definitions can be left as they are.

Note: resend to add the Cc tag for 'stable' (fixes in the series).

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
Javier Carrasco (2):
      usb: typec: tipd: fix event checking for tps25750
      usb: typec: tipd: fix event checking for tps6598x

 drivers/usb/typec/tipd/core.c | 37 +++++++++++++++++++++----------------
 1 file changed, 21 insertions(+), 16 deletions(-)
---
base-commit: 4cece764965020c22cff7665b18a012006359095
change-id: 20240328-tps6598x_fix_event_handling-3398d3d82f85

Best regards,
-- 
Javier Carrasco <javier.carrasco@wolfvision.net>