iio: adc: npcm: fix unbalanced clk_disable_unprepare()
Subsystems (2)
PATCH v2 1/1 iio: adc: npcm: fix unbalanced clk_disable_unprepare()
The driver acquired the ADC clock with devm_clk_get() and read its rate, but never called clk_prepare_enable(). The probe error path and npcm_adc_remove() both called clk_disable_unprepare() unconditionally, causing the clk framework's enable/prepare counts to underflow on probe failure or module unbind.
The issue went unnoticed because NPCM BMC firmware leaves the ADC clock enabled at boot, so the driver happened to work in practice.
Switch to devm_clk_get_enabled() so the clock is properly enabled during probe and automatically released by the device-managed cleanup, and drop the now-redundant clk_disable_unprepare() from both the probe error path and remove().
---
v2: drop redundant dev_err() on devm_request_irq() failure since the
IRQ core already logs it, and remove the now-single-statement braces (Andy Shevchenko).
drivers/iio/adc/npcm_adc.c | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-)
drivers/iio/adc/npcm_adc.c +7 -14
@@ -231,7 +231,7 @@ static int npcm_adc_probe(struct platform_device *pdev)if (IS_ERR (info->reset))return PTR_ERR (info->reset); - info->adc_clk =devm_clk_get (&pdev->dev,NULL ); + info->adc_clk =devm_clk_get_enabled (&pdev->dev,NULL );if (IS_ERR (info->adc_clk)) {dev_warn (&pdev->dev,"ADC clock failed: can't read clk\n" );return PTR_ERR (info->adc_clk);
@@ -244,17 +244,13 @@ static int npcm_adc_probe(struct platform_device *pdev) info->adc_sample_hz =clk_get_rate (info->adc_clk) / ((div +1 ) *2 ); irq =platform_get_irq (pdev,0 ); -if (irq <0 ) { - ret = irq; - goto err_disable_clk; - } +if (irq <0 ) +return irq; ret =devm_request_irq (&pdev->dev, irq, npcm_adc_isr,0 ,"NPCM_ADC" , indio_dev); -if (ret <0 ) { -dev_err (dev,"failed requesting interrupt\n" ); - goto err_disable_clk; - } +if (ret <0 ) +return ret; reg_con =ioread32 (info->regs +NPCM_ADCCON ); info->vref =devm_regulator_get_optional (&pdev->dev,"vref" );
@@ -262,7 +258,7 @@ static int npcm_adc_probe(struct platform_device *pdev) ret =regulator_enable (info->vref);if (ret) {dev_err (&pdev->dev,"Can't enable ADC reference voltage\n" ); - goto err_disable_clk; +return ret; } iowrite32(reg_con & ~NPCM_ADCCON_REFSEL,
@@ -274,7 +270,7 @@ static int npcm_adc_probe(struct platform_device *pdev)*/ if (PTR_ERR (info->vref) != -ENODEV ) { ret =PTR_ERR (info->vref); - goto err_disable_clk; +return ret; }/* Use internal reference */
@@ -314,8 +310,6 @@ static int npcm_adc_probe(struct platform_device *pdev)iowrite32 (reg_con & ~NPCM_ADCCON_ADC_EN , info->regs +NPCM_ADCCON );if (!IS_ERR (info->vref))regulator_disable (info->vref); -err_disable_clk: -clk_disable_unprepare (info->adc_clk);return ret; }
@@ -332,7 +326,6 @@ static void npcm_adc_remove(struct platform_device *pdev)iowrite32 (regtemp & ~NPCM_ADCCON_ADC_EN , info->regs +NPCM_ADCCON );if (!IS_ERR (info->vref))regulator_disable (info->vref); -clk_disable_unprepare (info->adc_clk); }static struct platform_driver npcm_adc_driver = {
Signature · 1 line
2.53.0
Quoted 6 lines · David Carlier
The driver acquired the ADC clock with
devm_clk_get()and read its rate, but never calledclk_prepare_enable(). The probe error path andnpcm_adc_remove()both calledclk_disable_unprepare()unconditionally, causing the clk framework's enable/prepare counts to underflow on probe failure or module unbind.
Quoted 7 lines
The issue went unnoticed because NPCM BMC firmware leaves the ADC clock enabled at boot, so the driver happened to work in practice.
Switch to
devm_clk_get_enabled()so the clock is properly enabled during probe and automatically released by the device-managed cleanup, and drop the now-redundantclk_disable_unprepare()from both the probe error path andremove().
Also need to mention the message drop here.
"While at it, drop the duplicate error message on ..."
Quoted 6 lines
Fixes 9bf85fbc9d8f ("iio: adc: add NPCM ADC driver")Signed-off-by David Carlier <[email protected]>---
v2: drop redundantdev_err()ondevm_request_irq()failure since the
IRQ core already logs it, and remove the now-single-statement braces (Andy Shevchenko).
...
drivers/iio/adc/npcm_adc.c static int npcm_adc_probe(struct platform_device *pdev) · line 273
Quoted 4 lines
drivers/iio/adc/npcm_adc.c +1
-1if (PTR_ERR (info->vref) != -ENODEV ) { ret =PTR_ERR (info->vref); - goto err_disable_clk; +return ret;
Now it's simply
return PTR_ERR(info->vref);
Quoted 1 line
}
...
With those two being addressed, feel free to add
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 27 lines · Andy Shevchenko
Quoted 6 lines · David Carlier
The driver acquired the ADC clock with
devm_clk_get()and read its rate, but never calledclk_prepare_enable(). The probe error path andnpcm_adc_remove()both calledclk_disable_unprepare()unconditionally, causing the clk framework's enable/prepare counts to underflow on probe failure or module unbind.Quoted 7 lines
The issue went unnoticed because NPCM BMC firmware leaves the ADC clock enabled at boot, so the driver happened to work in practice.
Switch to
devm_clk_get_enabled()so the clock is properly enabled during probe and automatically released by the device-managed cleanup, and drop the now-redundantclk_disable_unprepare()from both the probe error path andremove().Also need to mention the message drop here.
"While at it, drop the duplicate error message on ..."
Quoted 6 lines
Fixes 9bf85fbc9d8f ("iio: adc: add NPCM ADC driver")Signed-off-by David Carlier <[email protected]>---
v2: drop redundantdev_err()ondevm_request_irq()failure since the
IRQ core already logs it, and remove the now-single-statement braces (Andy Shevchenko).
Quoted 9 lines
...
Review
Quoted 4 lines
if (PTR_ERR(info->vref) != -ENODEV) { ret = PTR_ERR(info->vref);(quoted diff) +1
-1- goto err_disable_clk; + return ret;Now it's simply
ah yes true true :)
Quoted 14 lines
return PTR_ERR(info->vref);Quoted 1 line
}...
With those two being addressed, feel free to add
Reviewed-by Andy Shevchenko <[email protected]>--
With Best Regards,
Andy Shevchenko