diff mbox series

[2/2] media: ov5675: Elongate reset to first transaction minimum gap

Message ID 20240711-linux-next-ov5675-v1-2-69e9b6c62c16@linaro.org (mailing list archive)
State New
Headers show
Series media: ov5675: Fixup ov5675 reset failures | expand

Commit Message

Bryan O'Donoghue July 11, 2024, 10:20 a.m. UTC
The ov5675 specification says that the gap between XSHUTDN deassert and the
first I2C transaction should be a minimum of 8192 XVCLK cycles.

Right now we use a usleep_rage() that gives a sleep time of between about
430 and 860 microseconds.

On the Lenovo X13s we have observed that in about 1/20 cases the current
timing is too tight and we start transacting before the ov5675's reset
cycle completes, leading to I2C bus transaction failures.

The reset racing is sometimes triggered at initial chip probe but, more
usually on a subsequent power-off/power-on cycle e.g.

[   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
[   71.451686] ov5675 24-0010: failed to set plls

The current quiescence period we have is too tight, doubling the minimum
appears to fix the issue observed on X13s.

Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and support runtime PM")
Cc: stable@vger.kernel.org
Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
---
 drivers/media/i2c/ov5675.c | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Quentin Schulz July 11, 2024, 10:40 a.m. UTC | #1
Hi Bryan,

On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
> The ov5675 specification says that the gap between XSHUTDN deassert and the
> first I2C transaction should be a minimum of 8192 XVCLK cycles.
> 
> Right now we use a usleep_rage() that gives a sleep time of between about
> 430 and 860 microseconds.
> 
> On the Lenovo X13s we have observed that in about 1/20 cases the current
> timing is too tight and we start transacting before the ov5675's reset
> cycle completes, leading to I2C bus transaction failures.
> 
> The reset racing is sometimes triggered at initial chip probe but, more
> usually on a subsequent power-off/power-on cycle e.g.
> 
> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
> [   71.451686] ov5675 24-0010: failed to set plls
> 
> The current quiescence period we have is too tight, doubling the minimum
> appears to fix the issue observed on X13s.
> 
> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and support runtime PM")
> Cc: stable@vger.kernel.org
> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
> ---
>   drivers/media/i2c/ov5675.c | 9 +++++++--
>   1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
> index 92bd35133a5d..0498f8f3064d 100644
> --- a/drivers/media/i2c/ov5675.c
> +++ b/drivers/media/i2c/ov5675.c
> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>   
>   	gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>   
> -	/* 8192 xvclk cycles prior to the first SCCB transation */
> -	usleep_range(delay_us, delay_us * 2);
> +	/* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
> +	 * transacting on the I2C bus, which translates to about 430
> +	 * microseconds at 19.2 MHz.
> +	 * Testing shows the range 8192 - 16384 cycles to be unreliable.
> +	 * Grant a more liberal 2x -3x clock cycle grace time.
> +	 */
> +	usleep_range(delay_us * 2, delay_us * 3);
>   

Would it make sense to have power_off have the same logic? We do a 
usleep_range of those same values currently, so keeping them in sync 
seems to make sense to me.

Also, I'm wondering if it isn't an issue with the gpio not being high 
right after gpoiod_set_value_cansleep() returns, i.e. the time it 
actually takes for the HW to reach the IO level that means "high" for 
the camera. And that this increased sleep is just a way to mitigate that?

With this patch we essentially postpone the power_on by another 430ms 
making it almost a full second before we can start using the camera. 
That's quite a lot I think? We don't have a usecase right now that 
requires this to be blazing fast (and we anyway would need at the very 
least 430ms), so take this remark as what it is, a remark.

The change looks fine to me even though it feels like a band-aid patch.

Cheers,
Quentin
Dave Stevenson July 11, 2024, 11:17 a.m. UTC | #2
Hi Quentin and Bryan

On Thu, 11 Jul 2024 at 11:40, Quentin Schulz <quentin.schulz@cherry.de> wrote:
>
> Hi Bryan,
>
> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
> > The ov5675 specification says that the gap between XSHUTDN deassert and the
> > first I2C transaction should be a minimum of 8192 XVCLK cycles.
> >
> > Right now we use a usleep_rage() that gives a sleep time of between about
> > 430 and 860 microseconds.
> >
> > On the Lenovo X13s we have observed that in about 1/20 cases the current
> > timing is too tight and we start transacting before the ov5675's reset
> > cycle completes, leading to I2C bus transaction failures.
> >
> > The reset racing is sometimes triggered at initial chip probe but, more
> > usually on a subsequent power-off/power-on cycle e.g.
> >
> > [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
> > [   71.451686] ov5675 24-0010: failed to set plls
> >
> > The current quiescence period we have is too tight, doubling the minimum
> > appears to fix the issue observed on X13s.
> >
> > Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and support runtime PM")
> > Cc: stable@vger.kernel.org
> > Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
> > ---
> >   drivers/media/i2c/ov5675.c | 9 +++++++--
> >   1 file changed, 7 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
> > index 92bd35133a5d..0498f8f3064d 100644
> > --- a/drivers/media/i2c/ov5675.c
> > +++ b/drivers/media/i2c/ov5675.c
> > @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
> >
> >       gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
> >
> > -     /* 8192 xvclk cycles prior to the first SCCB transation */
> > -     usleep_range(delay_us, delay_us * 2);
> > +     /* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
> > +      * transacting on the I2C bus, which translates to about 430
> > +      * microseconds at 19.2 MHz.
> > +      * Testing shows the range 8192 - 16384 cycles to be unreliable.
> > +      * Grant a more liberal 2x -3x clock cycle grace time.
> > +      */
> > +     usleep_range(delay_us * 2, delay_us * 3);
> >
>
> Would it make sense to have power_off have the same logic? We do a
> usleep_range of those same values currently, so keeping them in sync
> seems to make sense to me.
>
> Also, I'm wondering if it isn't an issue with the gpio not being high
> right after gpoiod_set_value_cansleep() returns, i.e. the time it
> actually takes for the HW to reach the IO level that means "high" for
> the camera. And that this increased sleep is just a way to mitigate that?
>
> With this patch we essentially postpone the power_on by another 430ms
> making it almost a full second before we can start using the camera.
> That's quite a lot I think? We don't have a usecase right now that
> requires this to be blazing fast (and we anyway would need at the very
> least 430ms), so take this remark as what it is, a remark.

I think you've misread 430 usec as 430 msec.

I was looking at the series and trying to decide whether it's worth
going to the effort of computing the time at all when even on the
slowest 6MHz XVCLK we're sub 1.5ms for the required delay.
At the max XVLCK of 24MHz you could save 1ms. I know of very few use
cases that would suffer for a 1ms delay.

I know we all like to be precise, but it sounds like the precision
actually causes grief in this situation.

  Dave

>
> The change looks fine to me even though it feels like a band-aid patch.
>
> Cheers,
> Quentin
>
Bryan O'Donoghue July 11, 2024, 11:22 a.m. UTC | #3
On 11/07/2024 11:40, Quentin Schulz wrote:
> Hi Bryan,
> 
> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
>> The ov5675 specification says that the gap between XSHUTDN deassert 
>> and the
>> first I2C transaction should be a minimum of 8192 XVCLK cycles.
>>
>> Right now we use a usleep_rage() that gives a sleep time of between about
>> 430 and 860 microseconds.
>>
>> On the Lenovo X13s we have observed that in about 1/20 cases the current
>> timing is too tight and we start transacting before the ov5675's reset
>> cycle completes, leading to I2C bus transaction failures.
>>
>> The reset racing is sometimes triggered at initial chip probe but, more
>> usually on a subsequent power-off/power-on cycle e.g.
>>
>> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
>> [   71.451686] ov5675 24-0010: failed to set plls
>>
>> The current quiescence period we have is too tight, doubling the minimum
>> appears to fix the issue observed on X13s.
>>
>> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and 
>> support runtime PM")
>> Cc: stable@vger.kernel.org
>> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
>> ---
>>   drivers/media/i2c/ov5675.c | 9 +++++++--
>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
>> index 92bd35133a5d..0498f8f3064d 100644
>> --- a/drivers/media/i2c/ov5675.c
>> +++ b/drivers/media/i2c/ov5675.c
>> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>>       gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>> -    /* 8192 xvclk cycles prior to the first SCCB transation */
>> -    usleep_range(delay_us, delay_us * 2);
>> +    /* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
>> +     * transacting on the I2C bus, which translates to about 430
>> +     * microseconds at 19.2 MHz.
>> +     * Testing shows the range 8192 - 16384 cycles to be unreliable.
>> +     * Grant a more liberal 2x -3x clock cycle grace time.
>> +     */
>> +    usleep_range(delay_us * 2, delay_us * 3);
> 
> Would it make sense to have power_off have the same logic? We do a 
> usleep_range of those same values currently, so keeping them in sync 
> seems to make sense to me.

I have no evidence to suggest there's a problem on the shutdown path, 
that's why I left the quiescence period as-is there.

> Also, I'm wondering if it isn't an issue with the gpio not being high 
> right after gpoiod_set_value_cansleep() returns, i.e. the time it 
> actually takes for the HW to reach the IO level that means "high" for 
> the camera. And that this increased sleep is just a way to mitigate that?

No, that's not what I found.

I tried changing

         usleep_range(2000, 2200);

to
         usleep_range(200000, 220000);

but could still elicit the I2C transaction failure. If the time it took 
for the GPIO to hit logical 1 were the issue then multiplying the reset 
time by 100 would certainly account for that.

// BOD set the chip into reset
         gpiod_set_value_cansleep(ov5675->reset_gpio, 1);

// BOD apply power
         ret = regulator_bulk_enable(OV5675_NUM_SUPPLIES, ov5675->supplies);
         if (ret) {
                 clk_disable_unprepare(ov5675->xvclk);
                 return ret;
         }

         /* Reset pulse should be at least 2ms and reset gpio released 
only once
          * regulators are stable.
          */

// BOD spec specifies 2 milliseconds here not a count of XVCLKs
         usleep_range(2000, 2200);

         gpiod_set_value_cansleep(ov5675->reset_gpio, 0);

// BOD spec calls for a _minimum_ of 8192 XVCLK cycles before I2C
         /* 8192 xvclk cycles prior to the first SCCB transation */
         usleep_range(delay_us, delay_us * 2);

The issue is initiating an I2C transaction too early _after_ reset 
completion not the duration of that reset.

As I stated in the cover letter, I tried a longer reset duration, a 
higher drive-strength on the GPIO as well as I didn't put in my cover 
letter, inverting the logic of the GPIO reset, which unsurprisingly 
didn't work.

No matter how long we hold the chip in reset, unless we give more grace 
time _subsequent_ to the reset before initiating an I2C transaction, we 
will encounter transaction failures.

This is a fairly common and logical fault if you think about it.

XVCLK is providing a clock to the ov5675 core to "do stuff" whatever 
that stuff is. Bring up an internal firmware, lock a fundamental PLL - 
whatever.

If we start an I2C transaction before the hypothetical internal core has 
booted up then - meh no bueno we'll get no transaction response.

That's the error - speaking too soon.

A little like myself in the mornings, cranky before I've had my coffee 
and unresponsive.

;)

> With this patch we essentially postpone the power_on by another 430ms 
> making it almost a full second before we can start using the camera. 
> That's quite a lot I think? We don't have a usecase right now that 
> requires this to be blazing fast (and we anyway would need at the very 
> least 430ms), so take this remark as what it is, a remark.

Not a full second, a millisecond.

8/10ths of 1 millisecond instead of 4/10ths of one millisecond.

19.2MHz is 52.083333333333 nanoseconds per clock

52.083333333333 * 8192 => 426666 nanoseconds => 0.426666 milliseconds or 
426.6 microseconds

So our post reset quiesence minimum @ 19.2MHz moves from 426.6 
microseconds to 853.

> The change looks fine to me even though it feels like a band-aid patch.

I mean it's not a second - if you feel very strongly that 426 
milliseconds * 2 is wrong, I guess I could add some more complex logic 
however I like this simple fix for backporting.

---
bod
Bryan O'Donoghue July 11, 2024, 11:24 a.m. UTC | #4
On 11/07/2024 12:17, Dave Stevenson wrote:
> Hi Quentin and Bryan
> 
> On Thu, 11 Jul 2024 at 11:40, Quentin Schulz <quentin.schulz@cherry.de> wrote:
>>
>> Hi Bryan,
>>
>> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
>>> The ov5675 specification says that the gap between XSHUTDN deassert and the
>>> first I2C transaction should be a minimum of 8192 XVCLK cycles.
>>>
>>> Right now we use a usleep_rage() that gives a sleep time of between about
>>> 430 and 860 microseconds.
>>>
>>> On the Lenovo X13s we have observed that in about 1/20 cases the current
>>> timing is too tight and we start transacting before the ov5675's reset
>>> cycle completes, leading to I2C bus transaction failures.
>>>
>>> The reset racing is sometimes triggered at initial chip probe but, more
>>> usually on a subsequent power-off/power-on cycle e.g.
>>>
>>> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
>>> [   71.451686] ov5675 24-0010: failed to set plls
>>>
>>> The current quiescence period we have is too tight, doubling the minimum
>>> appears to fix the issue observed on X13s.
>>>
>>> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and support runtime PM")
>>> Cc: stable@vger.kernel.org
>>> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
>>> ---
>>>    drivers/media/i2c/ov5675.c | 9 +++++++--
>>>    1 file changed, 7 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
>>> index 92bd35133a5d..0498f8f3064d 100644
>>> --- a/drivers/media/i2c/ov5675.c
>>> +++ b/drivers/media/i2c/ov5675.c
>>> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>>>
>>>        gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>>
>>> -     /* 8192 xvclk cycles prior to the first SCCB transation */
>>> -     usleep_range(delay_us, delay_us * 2);
>>> +     /* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
>>> +      * transacting on the I2C bus, which translates to about 430
>>> +      * microseconds at 19.2 MHz.
>>> +      * Testing shows the range 8192 - 16384 cycles to be unreliable.
>>> +      * Grant a more liberal 2x -3x clock cycle grace time.
>>> +      */
>>> +     usleep_range(delay_us * 2, delay_us * 3);
>>>
>>
>> Would it make sense to have power_off have the same logic? We do a
>> usleep_range of those same values currently, so keeping them in sync
>> seems to make sense to me.
>>
>> Also, I'm wondering if it isn't an issue with the gpio not being high
>> right after gpoiod_set_value_cansleep() returns, i.e. the time it
>> actually takes for the HW to reach the IO level that means "high" for
>> the camera. And that this increased sleep is just a way to mitigate that?
>>
>> With this patch we essentially postpone the power_on by another 430ms
>> making it almost a full second before we can start using the camera.
>> That's quite a lot I think? We don't have a usecase right now that
>> requires this to be blazing fast (and we anyway would need at the very
>> least 430ms), so take this remark as what it is, a remark.
> 
> I think you've misread 430 usec as 430 msec.
> 
> I was looking at the series and trying to decide whether it's worth
> going to the effort of computing the time at all when even on the
> slowest 6MHz XVCLK we're sub 1.5ms for the required delay.
> At the max XVLCK of 24MHz you could save 1ms. I know of very few use
> cases that would suffer for a 1ms delay.
> 
> I know we all like to be precise, but it sounds like the precision
> actually causes grief in this situation.

Yeah the first draft of the patch just had a post-reset delay of I 
forget - I think I just used usleep_range(2000, 2200); again but I kind 
respected the attempt to hit the specification and wanted to fix the 
original logic, which is close but no cigar ATM.

---
bod
Bryan O'Donoghue July 11, 2024, 11:28 a.m. UTC | #5
On 11/07/2024 12:22, Bryan O'Donoghue wrote:
> if you feel very strongly that 426 milliseconds * 2 is wrong

MICROSECONDS !

Bah

---
bod
Quentin Schulz July 11, 2024, 11:41 a.m. UTC | #6
Hi Bryan and Dave,

On 7/11/24 1:22 PM, Bryan O'Donoghue wrote:
> On 11/07/2024 11:40, Quentin Schulz wrote:
>> Hi Bryan,
>>
>> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
>>> The ov5675 specification says that the gap between XSHUTDN deassert 
>>> and the
>>> first I2C transaction should be a minimum of 8192 XVCLK cycles.
>>>
>>> Right now we use a usleep_rage() that gives a sleep time of between 
>>> about
>>> 430 and 860 microseconds.
>>>
>>> On the Lenovo X13s we have observed that in about 1/20 cases the current
>>> timing is too tight and we start transacting before the ov5675's reset
>>> cycle completes, leading to I2C bus transaction failures.
>>>
>>> The reset racing is sometimes triggered at initial chip probe but, more
>>> usually on a subsequent power-off/power-on cycle e.g.
>>>
>>> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
>>> [   71.451686] ov5675 24-0010: failed to set plls
>>>
>>> The current quiescence period we have is too tight, doubling the minimum
>>> appears to fix the issue observed on X13s.
>>>
>>> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and 
>>> support runtime PM")
>>> Cc: stable@vger.kernel.org
>>> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
>>> ---
>>>   drivers/media/i2c/ov5675.c | 9 +++++++--
>>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>>
>>> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
>>> index 92bd35133a5d..0498f8f3064d 100644
>>> --- a/drivers/media/i2c/ov5675.c
>>> +++ b/drivers/media/i2c/ov5675.c
>>> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>>>       gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>> -    /* 8192 xvclk cycles prior to the first SCCB transation */
>>> -    usleep_range(delay_us, delay_us * 2);
>>> +    /* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
>>> +     * transacting on the I2C bus, which translates to about 430
>>> +     * microseconds at 19.2 MHz.
>>> +     * Testing shows the range 8192 - 16384 cycles to be unreliable.
>>> +     * Grant a more liberal 2x -3x clock cycle grace time.
>>> +     */
>>> +    usleep_range(delay_us * 2, delay_us * 3);
>>
>> Would it make sense to have power_off have the same logic? We do a 
>> usleep_range of those same values currently, so keeping them in sync 
>> seems to make sense to me.
> 
> I have no evidence to suggest there's a problem on the shutdown path, 
> that's why I left the quiescence period as-is there.
> 
>> Also, I'm wondering if it isn't an issue with the gpio not being high 
>> right after gpoiod_set_value_cansleep() returns, i.e. the time it 
>> actually takes for the HW to reach the IO level that means "high" for 
>> the camera. And that this increased sleep is just a way to mitigate that?
> 
> No, that's not what I found.
> 
> I tried changing
> 
>          usleep_range(2000, 2200);
> 
> to
>          usleep_range(200000, 220000);
> 
> but could still elicit the I2C transaction failure. If the time it took 
> for the GPIO to hit logical 1 were the issue then multiplying the reset 
> time by 100 would certainly account for that.
> 
> // BOD set the chip into reset
>          gpiod_set_value_cansleep(ov5675->reset_gpio, 1);
> 
> // BOD apply power
>          ret = regulator_bulk_enable(OV5675_NUM_SUPPLIES, 
> ov5675->supplies);
>          if (ret) {
>                  clk_disable_unprepare(ov5675->xvclk);
>                  return ret;
>          }
> 
>          /* Reset pulse should be at least 2ms and reset gpio released 
> only once
>           * regulators are stable.
>           */
> 
> // BOD spec specifies 2 milliseconds here not a count of XVCLKs
>          usleep_range(2000, 2200);
> 
>          gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
> 

I meant to say this gpiod_set_value_cansleep(), which is logical LOW and 
not HIGH, brain not braining today sorry. But the question remains the same.

> // BOD spec calls for a _minimum_ of 8192 XVCLK cycles before I2C
>          /* 8192 xvclk cycles prior to the first SCCB transation */
>          usleep_range(delay_us, delay_us * 2);
> 
> The issue is initiating an I2C transaction too early _after_ reset 
> completion not the duration of that reset.
> 
> As I stated in the cover letter, I tried a longer reset duration, a 
> higher drive-strength on the GPIO as well as I didn't put in my cover 
> letter, inverting the logic of the GPIO reset, which unsurprisingly 
> didn't work.
> 
> No matter how long we hold the chip in reset, unless we give more grace 
> time _subsequent_ to the reset before initiating an I2C transaction, we 
> will encounter transaction failures.
> 
> This is a fairly common and logical fault if you think about it.
> 
> XVCLK is providing a clock to the ov5675 core to "do stuff" whatever 
> that stuff is. Bring up an internal firmware, lock a fundamental PLL - 
> whatever.
> 
> If we start an I2C transaction before the hypothetical internal core has 
> booted up then - meh no bueno we'll get no transaction response.
> 
> That's the error - speaking too soon.
> 

Yeah, that's what I meant sorry.

> A little like myself in the mornings, cranky before I've had my coffee 
> and unresponsive.
> 
> ;)
> 
>> With this patch we essentially postpone the power_on by another 430ms 
>> making it almost a full second before we can start using the camera. 
>> That's quite a lot I think? We don't have a usecase right now that 
>> requires this to be blazing fast (and we anyway would need at the very 
>> least 430ms), so take this remark as what it is, a remark.
> 
> Not a full second, a millisecond.
> 
> 8/10ths of 1 millisecond instead of 4/10ths of one millisecond.
> 
> 19.2MHz is 52.083333333333 nanoseconds per clock
> 
> 52.083333333333 * 8192 => 426666 nanoseconds => 0.426666 milliseconds or 
> 426.6 microseconds
> 
> So our post reset quiesence minimum @ 19.2MHz moves from 426.6 
> microseconds to 853.
> 
>> The change looks fine to me even though it feels like a band-aid patch.
> 
> I mean it's not a second - if you feel very strongly that 426 
> milliseconds * 2 is wrong, I guess I could add some more complex logic 
> however I like this simple fix for backporting.
> 

Somehow I read microsecond, translated this to ms and then translated it 
again to millisecond. Don't ask :)

So, maybe this is all too complex for something that could be as simple 
as 8192 XVCLK cycles for 6MHz as Dave suggested I believe. And have some 
wiggle room added in case we ever support 6MHz and it has the same issue 
as you encountered with 19.2MHz (or whatever was that rate you were 
running the camera at). 1/6MHz * 8192 * 2 ~= 2.7ms if I'm not mistaken. 
So maybe go with that with a comment just above to justify why we are 
doing this with hardcoded values?

But ok, almost meaningless time increase in the grand scheme of things, 
so fine with me :)

Cheers,
Quentin
Bryan O'Donoghue July 11, 2024, 12:07 p.m. UTC | #7
On 11/07/2024 12:41, Quentin Schulz wrote:
> Hi Bryan and Dave,
> 
> On 7/11/24 1:22 PM, Bryan O'Donoghue wrote:
>> On 11/07/2024 11:40, Quentin Schulz wrote:
>>> Hi Bryan,
>>>
>>> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
>>>> The ov5675 specification says that the gap between XSHUTDN deassert 
>>>> and the
>>>> first I2C transaction should be a minimum of 8192 XVCLK cycles.
>>>>
>>>> Right now we use a usleep_rage() that gives a sleep time of between 
>>>> about
>>>> 430 and 860 microseconds.
>>>>
>>>> On the Lenovo X13s we have observed that in about 1/20 cases the 
>>>> current
>>>> timing is too tight and we start transacting before the ov5675's reset
>>>> cycle completes, leading to I2C bus transaction failures.
>>>>
>>>> The reset racing is sometimes triggered at initial chip probe but, more
>>>> usually on a subsequent power-off/power-on cycle e.g.
>>>>
>>>> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
>>>> [   71.451686] ov5675 24-0010: failed to set plls
>>>>
>>>> The current quiescence period we have is too tight, doubling the 
>>>> minimum
>>>> appears to fix the issue observed on X13s.
>>>>
>>>> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and 
>>>> support runtime PM")
>>>> Cc: stable@vger.kernel.org
>>>> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
>>>> ---
>>>>   drivers/media/i2c/ov5675.c | 9 +++++++--
>>>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
>>>> index 92bd35133a5d..0498f8f3064d 100644
>>>> --- a/drivers/media/i2c/ov5675.c
>>>> +++ b/drivers/media/i2c/ov5675.c
>>>> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>>>>       gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>>> -    /* 8192 xvclk cycles prior to the first SCCB transation */
>>>> -    usleep_range(delay_us, delay_us * 2);
>>>> +    /* The spec calls for a minimum delay of 8192 XVCLK cycles 
>>>> prior to
>>>> +     * transacting on the I2C bus, which translates to about 430
>>>> +     * microseconds at 19.2 MHz.
>>>> +     * Testing shows the range 8192 - 16384 cycles to be unreliable.
>>>> +     * Grant a more liberal 2x -3x clock cycle grace time.
>>>> +     */
>>>> +    usleep_range(delay_us * 2, delay_us * 3);
>>>
>>> Would it make sense to have power_off have the same logic? We do a 
>>> usleep_range of those same values currently, so keeping them in sync 
>>> seems to make sense to me.
>>
>> I have no evidence to suggest there's a problem on the shutdown path, 
>> that's why I left the quiescence period as-is there.
>>
>>> Also, I'm wondering if it isn't an issue with the gpio not being high 
>>> right after gpoiod_set_value_cansleep() returns, i.e. the time it 
>>> actually takes for the HW to reach the IO level that means "high" for 
>>> the camera. And that this increased sleep is just a way to mitigate 
>>> that?
>>
>> No, that's not what I found.
>>
>> I tried changing
>>
>>          usleep_range(2000, 2200);
>>
>> to
>>          usleep_range(200000, 220000);
>>
>> but could still elicit the I2C transaction failure. If the time it 
>> took for the GPIO to hit logical 1 were the issue then multiplying the 
>> reset time by 100 would certainly account for that.
>>
>> // BOD set the chip into reset
>>          gpiod_set_value_cansleep(ov5675->reset_gpio, 1);
>>
>> // BOD apply power
>>          ret = regulator_bulk_enable(OV5675_NUM_SUPPLIES, 
>> ov5675->supplies);
>>          if (ret) {
>>                  clk_disable_unprepare(ov5675->xvclk);
>>                  return ret;
>>          }
>>
>>          /* Reset pulse should be at least 2ms and reset gpio released 
>> only once
>>           * regulators are stable.
>>           */
>>
>> // BOD spec specifies 2 milliseconds here not a count of XVCLKs
>>          usleep_range(2000, 2200);
>>
>>          gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>
> 
> I meant to say this gpiod_set_value_cansleep(), which is logical LOW and 
> not HIGH, brain not braining today sorry. But the question remains the 
> same.

Ah right yes I get you, you mean how can I prove the sensor has come out 
of reset by the time we start counting for the first I2C transaction delay ?

There's no way to prove that, the only thing we can do is elongate the 
post reset delay by X, whatever X we choose.

> So, maybe this is all too complex for something that could be as simple 
> as 8192 XVCLK cycles for 6MHz as Dave suggested I believe. And have some 
> wiggle room added in case we ever support 6MHz and it has the same issue 
> as you encountered with 19.2MHz (or whatever was that rate you were 
> running the camera at). 1/6MHz * 8192 * 2 ~= 2.7ms if I'm not mistaken. 
> So maybe go with that with a comment just above to justify why we are 
> doing this with hardcoded values?

2.7 milliseconds is alot.

Worst case XVCLK period is 1.365 milliseconds.

If your theory on the GPIO is correct, its still difficult to see how @ 
6MHz - which we don't yet support and probably never will, that 1.5 
milliseconds would be insufficient.

So - I'm happy enough to throw out the first patch and give a range of 
1.5 to 1.6 milliseconds instead.

---
bod
Quentin Schulz July 11, 2024, 12:22 p.m. UTC | #8
Hi Bryan,

On 7/11/24 2:07 PM, Bryan O'Donoghue wrote:
> On 11/07/2024 12:41, Quentin Schulz wrote:
>> Hi Bryan and Dave,
>>
>> On 7/11/24 1:22 PM, Bryan O'Donoghue wrote:
>>> On 11/07/2024 11:40, Quentin Schulz wrote:
>>>> Hi Bryan,
>>>>
>>>> On 7/11/24 12:20 PM, Bryan O'Donoghue wrote:
>>>>> The ov5675 specification says that the gap between XSHUTDN deassert 
>>>>> and the
>>>>> first I2C transaction should be a minimum of 8192 XVCLK cycles.
>>>>>
>>>>> Right now we use a usleep_rage() that gives a sleep time of between 
>>>>> about
>>>>> 430 and 860 microseconds.
>>>>>
>>>>> On the Lenovo X13s we have observed that in about 1/20 cases the 
>>>>> current
>>>>> timing is too tight and we start transacting before the ov5675's reset
>>>>> cycle completes, leading to I2C bus transaction failures.
>>>>>
>>>>> The reset racing is sometimes triggered at initial chip probe but, 
>>>>> more
>>>>> usually on a subsequent power-off/power-on cycle e.g.
>>>>>
>>>>> [   71.451662] ov5675 24-0010: failed to write reg 0x0103. error = -5
>>>>> [   71.451686] ov5675 24-0010: failed to set plls
>>>>>
>>>>> The current quiescence period we have is too tight, doubling the 
>>>>> minimum
>>>>> appears to fix the issue observed on X13s.
>>>>>
>>>>> Fixes: 49d9ad719e89 ("media: ov5675: add device-tree support and 
>>>>> support runtime PM")
>>>>> Cc: stable@vger.kernel.org
>>>>> Signed-off-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
>>>>> ---
>>>>>   drivers/media/i2c/ov5675.c | 9 +++++++--
>>>>>   1 file changed, 7 insertions(+), 2 deletions(-)
>>>>>
>>>>> diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
>>>>> index 92bd35133a5d..0498f8f3064d 100644
>>>>> --- a/drivers/media/i2c/ov5675.c
>>>>> +++ b/drivers/media/i2c/ov5675.c
>>>>> @@ -1018,8 +1018,13 @@ static int ov5675_power_on(struct device *dev)
>>>>>       gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>>>> -    /* 8192 xvclk cycles prior to the first SCCB transation */
>>>>> -    usleep_range(delay_us, delay_us * 2);
>>>>> +    /* The spec calls for a minimum delay of 8192 XVCLK cycles 
>>>>> prior to
>>>>> +     * transacting on the I2C bus, which translates to about 430
>>>>> +     * microseconds at 19.2 MHz.
>>>>> +     * Testing shows the range 8192 - 16384 cycles to be unreliable.
>>>>> +     * Grant a more liberal 2x -3x clock cycle grace time.
>>>>> +     */
>>>>> +    usleep_range(delay_us * 2, delay_us * 3);
>>>>
>>>> Would it make sense to have power_off have the same logic? We do a 
>>>> usleep_range of those same values currently, so keeping them in sync 
>>>> seems to make sense to me.
>>>
>>> I have no evidence to suggest there's a problem on the shutdown path, 
>>> that's why I left the quiescence period as-is there.
>>>
>>>> Also, I'm wondering if it isn't an issue with the gpio not being 
>>>> high right after gpoiod_set_value_cansleep() returns, i.e. the time 
>>>> it actually takes for the HW to reach the IO level that means "high" 
>>>> for the camera. And that this increased sleep is just a way to 
>>>> mitigate that?
>>>
>>> No, that's not what I found.
>>>
>>> I tried changing
>>>
>>>          usleep_range(2000, 2200);
>>>
>>> to
>>>          usleep_range(200000, 220000);
>>>
>>> but could still elicit the I2C transaction failure. If the time it 
>>> took for the GPIO to hit logical 1 were the issue then multiplying 
>>> the reset time by 100 would certainly account for that.
>>>
>>> // BOD set the chip into reset
>>>          gpiod_set_value_cansleep(ov5675->reset_gpio, 1);
>>>
>>> // BOD apply power
>>>          ret = regulator_bulk_enable(OV5675_NUM_SUPPLIES, 
>>> ov5675->supplies);
>>>          if (ret) {
>>>                  clk_disable_unprepare(ov5675->xvclk);
>>>                  return ret;
>>>          }
>>>
>>>          /* Reset pulse should be at least 2ms and reset gpio 
>>> released only once
>>>           * regulators are stable.
>>>           */
>>>
>>> // BOD spec specifies 2 milliseconds here not a count of XVCLKs
>>>          usleep_range(2000, 2200);
>>>
>>>          gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
>>>
>>
>> I meant to say this gpiod_set_value_cansleep(), which is logical LOW 
>> and not HIGH, brain not braining today sorry. But the question remains 
>> the same.
> 
> Ah right yes I get you, you mean how can I prove the sensor has come out 
> of reset by the time we start counting for the first I2C transaction 
> delay ?
> 
> There's no way to prove that, the only thing we can do is elongate the 
> post reset delay by X, whatever X we choose.
> 

I think we could, checking the delay between the moment the GPIO reaches 
logical low and the moment we send the first I2C command and comparing 
this against 8192 * 1/19.2MHz. Not sure we need to spend the time on 
this though? There isn't really a strong need for optimizing this as 
much as we can I believe? (and worst case scenario, we can do it later on).

>> So, maybe this is all too complex for something that could be as 
>> simple as 8192 XVCLK cycles for 6MHz as Dave suggested I believe. And 
>> have some wiggle room added in case we ever support 6MHz and it has 
>> the same issue as you encountered with 19.2MHz (or whatever was that 
>> rate you were running the camera at). 1/6MHz * 8192 * 2 ~= 2.7ms if 
>> I'm not mistaken. So maybe go with that with a comment just above to 
>> justify why we are doing this with hardcoded values?
> 
> 2.7 milliseconds is alot.
> 
> Worst case XVCLK period is 1.365 milliseconds.
> 
> If your theory on the GPIO is correct, its still difficult to see how @ 
> 6MHz - which we don't yet support and probably never will, that 1.5 
> milliseconds would be insufficient.
> 
> So - I'm happy enough to throw out the first patch and give a range of 
> 1.5 to 1.6 milliseconds instead.
> 

Works for me.

Cheers,
Quentin
Bryan O'Donoghue July 11, 2024, 12:25 p.m. UTC | #9
On 11/07/2024 13:22, Quentin Schulz wrote:
> Hi Bryan,
> 
> On 7/11/24 2:07 PM, Bryan O'Donoghue wrote:
>> On 11/07/2024 12:41, Quentin Schulz wrote:
>> Worst case XVCLK period is 1.365 milliseconds.
>>
>> If your theory on the GPIO is correct, its still difficult to see how 
>> @ 6MHz - which we don't yet support and probably never will, that 1.5 
>> milliseconds would be insufficient.
>>
>> So - I'm happy enough to throw out the first patch and give a range of 
>> 1.5 to 1.6 milliseconds instead.
>>
> 
> Works for me.

Great.

Just for record, I'll update power_off() too to match the logic we are 
applying @ power_on since we've decided the calculation based on XVCLK 
is overkill.

---
bod
diff mbox series

Patch

diff --git a/drivers/media/i2c/ov5675.c b/drivers/media/i2c/ov5675.c
index 92bd35133a5d..0498f8f3064d 100644
--- a/drivers/media/i2c/ov5675.c
+++ b/drivers/media/i2c/ov5675.c
@@ -1018,8 +1018,13 @@  static int ov5675_power_on(struct device *dev)
 
 	gpiod_set_value_cansleep(ov5675->reset_gpio, 0);
 
-	/* 8192 xvclk cycles prior to the first SCCB transation */
-	usleep_range(delay_us, delay_us * 2);
+	/* The spec calls for a minimum delay of 8192 XVCLK cycles prior to
+	 * transacting on the I2C bus, which translates to about 430
+	 * microseconds at 19.2 MHz.
+	 * Testing shows the range 8192 - 16384 cycles to be unreliable.
+	 * Grant a more liberal 2x -3x clock cycle grace time.
+	 */
+	usleep_range(delay_us * 2, delay_us * 3);
 
 	return 0;
 }