Staging: nvec: nvec: fixed two usleep_range is preferred over udelay warnings

Message ID 20240212133645.1836-1-mo.c.weber@gmail.com
State New
Headers
Series Staging: nvec: nvec: fixed two usleep_range is preferred over udelay warnings |

Commit Message

Moritz C. Weber Feb. 12, 2024, 1:36 p.m. UTC
  Fixed a code style issue raised by checkpatch.
---
 drivers/staging/nvec/nvec.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Nam Cao Feb. 12, 2024, 2:21 p.m. UTC | #1
On 12/Feb/2024 Moritz C. Weber wrote:
> Fixed a code style issue raised by checkpatch.
> ---
>  drivers/staging/nvec/nvec.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/staging/nvec/nvec.c b/drivers/staging/nvec/nvec.c
> index 2823cacde..18c5471d5 100644
> --- a/drivers/staging/nvec/nvec.c
> +++ b/drivers/staging/nvec/nvec.c
> @@ -627,7 +627,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
>  		break;
>  	case 2:		/* first byte after command */
>  		if (status == (I2C_SL_IRQ | RNW | RCVD)) {
> -			udelay(33);
> +			usleep_range(32, 33);
>  			if (nvec->rx->data[0] != 0x01) {
>  				dev_err(nvec->dev,
>  					"Read without prior read command\n");
> @@ -714,7 +714,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
>  	 * We experience less incomplete messages with this delay than without
>  	 * it, but we don't know why. Help is appreciated.
>  	 */
> -	udelay(100);
> +	usleep_range(99, 100);
>  
>  	return IRQ_HANDLED;
>  }

I have zero knowledge about this driver, but nvec_interrupt() seems to be
a hard interrupt handler, and sleeping in an interrupt handler is a big no
no. So I think this change breaks the driver.

Delaying like the driver is currently doing doesn't break things, but it is
not very nice because this is interrupt handler and the processor cannot
switch to other tasks, so delaying is wasting processor's cycles here. The
better fix would be to figure out how to remove the delay entirely, or
switch to threaded interrupt handler and then we can use usleep_range() in
there, but you need actual hardware to test such changes.

Best regards,
Nam
  
Thierry Reding Feb. 16, 2024, 11:53 a.m. UTC | #2
On Mon Feb 12, 2024 at 3:21 PM CET, Nam Cao wrote:
> On 12/Feb/2024 Moritz C. Weber wrote:
> > Fixed a code style issue raised by checkpatch.
> > ---
> >  drivers/staging/nvec/nvec.c | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/drivers/staging/nvec/nvec.c b/drivers/staging/nvec/nvec.c
> > index 2823cacde..18c5471d5 100644
> > --- a/drivers/staging/nvec/nvec.c
> > +++ b/drivers/staging/nvec/nvec.c
> > @@ -627,7 +627,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
> >  		break;
> >  	case 2:		/* first byte after command */
> >  		if (status == (I2C_SL_IRQ | RNW | RCVD)) {
> > -			udelay(33);
> > +			usleep_range(32, 33);
> >  			if (nvec->rx->data[0] != 0x01) {
> >  				dev_err(nvec->dev,
> >  					"Read without prior read command\n");
> > @@ -714,7 +714,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
> >  	 * We experience less incomplete messages with this delay than without
> >  	 * it, but we don't know why. Help is appreciated.
> >  	 */
> > -	udelay(100);
> > +	usleep_range(99, 100);
> >  
> >  	return IRQ_HANDLED;
> >  }
>
> I have zero knowledge about this driver, but nvec_interrupt() seems to be
> a hard interrupt handler, and sleeping in an interrupt handler is a big no
> no. So I think this change breaks the driver.
>
> Delaying like the driver is currently doing doesn't break things, but it is
> not very nice because this is interrupt handler and the processor cannot
> switch to other tasks, so delaying is wasting processor's cycles here. The
> better fix would be to figure out how to remove the delay entirely, or
> switch to threaded interrupt handler and then we can use usleep_range() in
> there, but you need actual hardware to test such changes.

Also, pay attention to what else is being said in the timers-howto.rst
documentation. It specifically mentions that usleep_range() uses a range
in order to give the scheduler some leeway in coalescing with other
wakeups, so choosing a range of 32-33 us or 99-100 us isn't very useful.

Thierry
  
Marc Dietrich Feb. 18, 2024, 5:42 p.m. UTC | #3
Hi,

On Mon, 12 Feb 2024, Nam Cao wrote:

> On 12/Feb/2024 Moritz C. Weber wrote:
>> Fixed a code style issue raised by checkpatch.
>> ---
>>  drivers/staging/nvec/nvec.c | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/staging/nvec/nvec.c b/drivers/staging/nvec/nvec.c
>> index 2823cacde..18c5471d5 100644
>> --- a/drivers/staging/nvec/nvec.c
>> +++ b/drivers/staging/nvec/nvec.c
>> @@ -627,7 +627,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
>>  		break;
>>  	case 2:		/* first byte after command */
>>  		if (status == (I2C_SL_IRQ | RNW | RCVD)) {
>> -			udelay(33);
>> +			usleep_range(32, 33);
>>  			if (nvec->rx->data[0] != 0x01) {
>>  				dev_err(nvec->dev,
>>  					"Read without prior read command\n");
>> @@ -714,7 +714,7 @@ static irqreturn_t nvec_interrupt(int irq, void *dev)
>>  	 * We experience less incomplete messages with this delay than without
>>  	 * it, but we don't know why. Help is appreciated.
>>  	 */
>> -	udelay(100);
>> +	usleep_range(99, 100);
>>
>>  	return IRQ_HANDLED;
>>  }
>
> I have zero knowledge about this driver, but nvec_interrupt() seems to be
> a hard interrupt handler, and sleeping in an interrupt handler is a big no
> no. So I think this change breaks the driver.
>
> Delaying like the driver is currently doing doesn't break things, but it is
> not very nice because this is interrupt handler and the processor cannot
> switch to other tasks, so delaying is wasting processor's cycles here. The
> better fix would be to figure out how to remove the delay entirely, or
> switch to threaded interrupt handler and then we can use usleep_range() in
> there, but you need actual hardware to test such changes.

the real fix to read back the value we wrote to the controller, similar to
what is done for the tegra i2c host, which is a trival fix.
Unfortunately, this breaks the touch pad initialisation, which needs to be
fixed first. As this topic comes up every year, I'm going to post a patch
in order to updated the comment, so this kind of patches should
(hopefully) stop in the future.

Best regrards,

Marc
  

Patch

diff --git a/drivers/staging/nvec/nvec.c b/drivers/staging/nvec/nvec.c
index 2823cacde..18c5471d5 100644
--- a/drivers/staging/nvec/nvec.c
+++ b/drivers/staging/nvec/nvec.c
@@ -627,7 +627,7 @@  static irqreturn_t nvec_interrupt(int irq, void *dev)
 		break;
 	case 2:		/* first byte after command */
 		if (status == (I2C_SL_IRQ | RNW | RCVD)) {
-			udelay(33);
+			usleep_range(32, 33);
 			if (nvec->rx->data[0] != 0x01) {
 				dev_err(nvec->dev,
 					"Read without prior read command\n");
@@ -714,7 +714,7 @@  static irqreturn_t nvec_interrupt(int irq, void *dev)
 	 * We experience less incomplete messages with this delay than without
 	 * it, but we don't know why. Help is appreciated.
 	 */
-	udelay(100);
+	usleep_range(99, 100);
 
 	return IRQ_HANDLED;
 }