iio: adc: cc10001: Devm conversion
Jonathan Cameron
maintainercover iio: adc: cc10001: Devm conversion
From: Jonathan Cameron <[email protected]>
A very simple example of how using devm_ managed calls for everything can reduce complexity error handling and removal ordering in a driver.
Note I don't have one of these to test so if anyone has a chance to do so or give these a quick look at that would be much appreciated. Note this is a fairly old driver, so relative unlikely original authors still have access.
Jonathan Cameron (5):
iio: adc: cc10001: Add local struct device *dev variable to avoid
repitition
iio: adc: cc10001: Add devm_add_action_or_reset() to disable
regulator.
iio: adc: cc10001: Use devm_clk_get_enabled() to avoid boilerplate.
iio: adc: cc10001: Use devm_ to call device power down.
iio: adc: cc10001: Switch remaining IIO calls in probe to devm_ forms.
drivers/iio/adc/cc10001_adc.c | 89 +++++++++++++---------------------- 1 file changed, 34 insertions(+), 55 deletions(-)
Signature · 1 line
2.37.2
Jonathan Cameron
maintainerPATCH 1/5 iio: adc: cc10001: Add local struct device *dev variable to avoid repitition
From: Jonathan Cameron <[email protected]>
There are lots of uses of this in probe() and we are about to introduce some more, so add a local variable to simplify this.
--- drivers/iio/adc/cc10001_adc.c | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-)
drivers/iio/adc/cc10001_adc.c +9 -8
@@ -307,14 +307,15 @@ static int cc10001_adc_channel_init(struct iio_dev *indio_dev,static int cc10001_adc_probe (struct platform_device *pdev) { -struct device_node *node = pdev->dev.of_node; +struct device *dev = &pdev->dev; +struct device_node *node = dev->of_node;struct cc10001_adc_device *adc_dev;unsigned long adc_clk_rate;struct iio_dev *indio_dev;unsigned long channel_map;int ret; - indio_dev =devm_iio_device_alloc (&pdev->dev,sizeof (*adc_dev)); + indio_dev =devm_iio_device_alloc (dev,sizeof (*adc_dev));if (indio_dev ==NULL )return -ENOMEM ;
@@ -326,7 +327,7 @@ static int cc10001_adc_probe(struct platform_device *pdev) channel_map &= ~ret; } - adc_dev->reg =devm_regulator_get (&pdev->dev,"vref" ); + adc_dev->reg =devm_regulator_get (dev,"vref" );if (IS_ERR (adc_dev->reg))return PTR_ERR (adc_dev->reg);
@@ -334,7 +335,7 @@ static int cc10001_adc_probe(struct platform_device *pdev)if (ret)return ret; - indio_dev->name =dev_name (&pdev->dev); + indio_dev->name =dev_name (dev); indio_dev->info = &cc10001_adc_info; indio_dev->modes =INDIO_DIRECT_MODE ;
@@ -344,23 +345,23 @@ static int cc10001_adc_probe(struct platform_device *pdev) goto err_disable_reg; } - adc_dev->adc_clk =devm_clk_get (&pdev->dev,"adc" ); + adc_dev->adc_clk =devm_clk_get (dev,"adc" );if (IS_ERR (adc_dev->adc_clk)) { -dev_err (&pdev->dev,"failed to get the clock\n" ); +dev_err (dev,"failed to get the clock\n" ); ret =PTR_ERR (adc_dev->adc_clk); goto err_disable_reg; } ret =clk_prepare_enable (adc_dev->adc_clk);if (ret) { -dev_err (&pdev->dev,"failed to enable the clock\n" ); +dev_err (dev,"failed to enable the clock\n" ); goto err_disable_reg; } adc_clk_rate =clk_get_rate (adc_dev->adc_clk);if (!adc_clk_rate) { ret = -EINVAL ; -dev_err (&pdev->dev,"null clock rate!\n" ); +dev_err (dev,"null clock rate!\n" ); goto err_disable_clk; }
Signature · 1 line
2.37.2
Jonathan Cameron
maintainerPATCH 2/5 iio: adc: cc10001: Add devm_add_action_or_reset() to disable regulator.
In reply to Jonathan CameronFrom: Jonathan Cameron <[email protected]>
As the voltage of this regulator is queried, we cannot use the devm_regulator_get_enable() call and have to role our own disable.
--- drivers/iio/adc/cc10001_adc.c | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-)
drivers/iio/adc/cc10001_adc.c +13 -10
@@ -305,6 +305,11 @@ static int cc10001_adc_channel_init(struct iio_dev *indio_dev,return 0 ; } +static void cc10001_reg_disable (void *priv) +{ +regulator_disable (priv); +} +static int cc10001_adc_probe (struct platform_device *pdev) {struct device *dev = &pdev->dev;
@@ -335,27 +340,28 @@ static int cc10001_adc_probe(struct platform_device *pdev)if (ret)return ret; + ret =devm_add_action_or_reset (dev, cc10001_reg_disable, adc_dev->reg); +if (ret) +return ret; + indio_dev->name =dev_name (dev); indio_dev->info = &cc10001_adc_info; indio_dev->modes =INDIO_DIRECT_MODE ; adc_dev->reg_base =devm_platform_ioremap_resource (pdev,0 ); -if (IS_ERR (adc_dev->reg_base)) { - ret =PTR_ERR (adc_dev->reg_base); - goto err_disable_reg; - } +if (IS_ERR (adc_dev->reg_base)) +return PTR_ERR (adc_dev->reg_base); adc_dev->adc_clk =devm_clk_get (dev,"adc" );if (IS_ERR (adc_dev->adc_clk)) {dev_err (dev,"failed to get the clock\n" ); - ret =PTR_ERR (adc_dev->adc_clk); - goto err_disable_reg; +return PTR_ERR (adc_dev->adc_clk); } ret =clk_prepare_enable (adc_dev->adc_clk);if (ret) {dev_err (dev,"failed to enable the clock\n" ); - goto err_disable_reg; +return ret; } adc_clk_rate =clk_get_rate (adc_dev->adc_clk);
@@ -400,8 +406,6 @@ static int cc10001_adc_probe(struct platform_device *pdev)iio_triggered_buffer_cleanup (indio_dev); err_disable_clk:clk_disable_unprepare (adc_dev->adc_clk); -err_disable_reg: -regulator_disable (adc_dev->reg);return ret; }
@@ -414,7 +418,6 @@ static int cc10001_adc_remove(struct platform_device *pdev)iio_device_unregister (indio_dev);iio_triggered_buffer_cleanup (indio_dev);clk_disable_unprepare (adc_dev->adc_clk); -regulator_disable (adc_dev->reg);return 0 ; }
Signature · 1 line
2.37.2
Jonathan Cameron
maintainerPATCH 3/5 iio: adc: cc10001: Use devm_clk_get_enabled() to avoid boilerplate.
In reply to Jonathan CameronFrom: Jonathan Cameron <[email protected]>
As this driver just enables clock in probe() and disables in remove() we can use this new function to replace boilerplate and simplify error paths.
--- drivers/iio/adc/cc10001_adc.c | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-)
drivers/iio/adc/cc10001_adc.c +4 -14
@@ -352,23 +352,16 @@ static int cc10001_adc_probe(struct platform_device *pdev)if (IS_ERR (adc_dev->reg_base))return PTR_ERR (adc_dev->reg_base); - adc_dev->adc_clk =devm_clk_get (dev,"adc" ); + adc_dev->adc_clk =devm_clk_get_enabled (dev,"adc" );if (IS_ERR (adc_dev->adc_clk)) {dev_err (dev,"failed to get the clock\n" );return PTR_ERR (adc_dev->adc_clk); } - ret =clk_prepare_enable (adc_dev->adc_clk); -if (ret) { -dev_err (dev,"failed to enable the clock\n" ); -return ret; - } - adc_clk_rate =clk_get_rate (adc_dev->adc_clk);if (!adc_clk_rate) { - ret = -EINVAL ;dev_err (dev,"null clock rate!\n" ); - goto err_disable_clk; +return -EINVAL ; } adc_dev->eoc_delay_ns =NSEC_PER_SEC / adc_clk_rate;
@@ -385,14 +378,14 @@ static int cc10001_adc_probe(struct platform_device *pdev)/* Setup the ADC channels available on the device */ ret =cc10001_adc_channel_init (indio_dev, channel_map);if (ret <0 ) - goto err_disable_clk; +return ret;mutex_init (&adc_dev->lock); ret =iio_triggered_buffer_setup (indio_dev,NULL , &cc10001_adc_trigger_h,NULL );if (ret <0 ) - goto err_disable_clk; +return ret; ret =iio_device_register (indio_dev);if (ret <0 )
@@ -404,8 +397,6 @@ static int cc10001_adc_probe(struct platform_device *pdev) err_cleanup_buffer:iio_triggered_buffer_cleanup (indio_dev); -err_disable_clk: -clk_disable_unprepare (adc_dev->adc_clk);return ret; }
@@ -417,7 +408,6 @@ static int cc10001_adc_remove(struct platform_device *pdev)cc10001_adc_power_down (adc_dev);iio_device_unregister (indio_dev);iio_triggered_buffer_cleanup (indio_dev); -clk_disable_unprepare (adc_dev->adc_clk);return 0 ; }
Signature · 1 line
2.37.2
Sa, Nuno
reviewerRE: [PATCH 3/5] iio: adc: cc10001: Use devm_clk_get_enabled() to avoid boilerplate.
Quoted 29 lines
-----Original Message-----
From: Jonathan Cameron <[email protected]>
Sent: Sunday, October 16, 2022 7:10 PM
To: [email protected]
Cc: Jonathan Cameron <[email protected]>
Subject: [PATCH 3/5] iio: adc: cc10001: Usedevm_clk_get_enabled()to avoid boilerplate.[External]
From: Jonathan Cameron <[email protected]>
As this driver just enables clock in
probe()and disables inremove()we can use this new function to replace boilerplate and simplify error paths.Signed-off-by Jonathan Cameron <[email protected]>--- drivers/iio/adc/cc10001_adc.c | 18 ++++-------------- 1 file changed, 4 insertions(+), 14 deletions(-)drivers/iio/adc/cc10001_adc.c +0
-0@@ -352,23 +352,16 @@ static int cc10001_adc_probe(struct platform_device *pdev)
drivers/iio/adc/cc10001_adc.c static int cc10001_adc_probe(struct · line 361
Quoted 10 lines
drivers/iio/adc/cc10001_adc.c +1
-1if (IS_ERR (adc_dev->reg_base))return PTR_ERR (adc_dev->reg_base); - adc_dev->adc_clk =devm_clk_get (dev,"adc" ); + adc_dev->adc_clk =devm_clk_get_enabled (dev,"adc" );if (IS_ERR (adc_dev->adc_clk)) {dev_err (dev,"failed to get the clock\n" );return PTR_ERR (adc_dev->adc_clk); }
I guess we could also tweak the err() message as we loose "failed to enable the clock"...
- Nuno Sá
Jonathan Cameron
maintainerPATCH 4/5 iio: adc: cc10001: Use devm_ to call device power down.
In reply to Jonathan CameronFrom: Jonathan Cameron <[email protected]>
It is presumably safe to call the powerdown whether or not we are in the commented shared state (the driver always did this).
The power down was previously out of order wrt to the probe() function so move using devm_ will ensure it occurs after the userspace interfaces are removed.
--- drivers/iio/adc/cc10001_adc.c | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-)
drivers/iio/adc/cc10001_adc.c +8 -1
@@ -310,6 +310,11 @@ static void cc10001_reg_disable(void *priv)regulator_disable (priv); } +static void cc10001_pd_cb (void *priv) +{ +cc10001_adc_power_down (priv); +} +static int cc10001_adc_probe (struct platform_device *pdev) {struct device *dev = &pdev->dev;
@@ -375,6 +380,9 @@ static int cc10001_adc_probe(struct platform_device *pdev)if (adc_dev->shared)cc10001_adc_power_up (adc_dev); + ret =devm_add_action_or_reset (dev, cc10001_pd_cb, adc_dev); +if (ret) +return ret;/* Setup the ADC channels available on the device */ ret =cc10001_adc_channel_init (indio_dev, channel_map);if (ret <0 )
@@ -405,7 +413,6 @@ static int cc10001_adc_remove(struct platform_device *pdev)struct iio_dev *indio_dev =platform_get_drvdata (pdev);struct cc10001_adc_device *adc_dev =iio_priv (indio_dev); -cc10001_adc_power_down (adc_dev);iio_device_unregister (indio_dev);iio_triggered_buffer_cleanup (indio_dev);
Signature · 1 line
2.37.2
Jonathan Cameron
maintainerPATCH 5/5 iio: adc: cc10001: Switch remaining IIO calls in probe to devm_ forms.
In reply to Jonathan CameronFrom: Jonathan Cameron <[email protected]>
As everything else is now handled by devm managed releases the triggered buffer setup and IIO device registration can also be moved over to their devm forms allowing dropping of remove().
--- drivers/iio/adc/cc10001_adc.c | 28 +++------------------------- 1 file changed, 3 insertions(+), 25 deletions(-)
drivers/iio/adc/cc10001_adc.c +3 -25
@@ -390,33 +390,12 @@ static int cc10001_adc_probe(struct platform_device *pdev)mutex_init (&adc_dev->lock); - ret =iio_triggered_buffer_setup (indio_dev,NULL , - &cc10001_adc_trigger_h,NULL ); + ret =devm_iio_triggered_buffer_setup (dev, indio_dev,NULL , + &cc10001_adc_trigger_h,NULL );if (ret <0 )return ret; - ret =iio_device_register (indio_dev); -if (ret <0 ) - goto err_cleanup_buffer; - -platform_set_drvdata (pdev, indio_dev); - -return 0 ; - -err_cleanup_buffer: -iio_triggered_buffer_cleanup (indio_dev); -return ret; -} - -static int cc10001_adc_remove (struct platform_device *pdev) -{ -struct iio_dev *indio_dev =platform_get_drvdata (pdev); -struct cc10001_adc_device *adc_dev =iio_priv (indio_dev); - -iio_device_unregister (indio_dev); -iio_triggered_buffer_cleanup (indio_dev); - -return 0 ; +return devm_iio_device_register (dev, indio_dev); }static const struct of_device_id cc10001_adc_dt_ids[] = {
@@ -431,7 +410,6 @@ static struct platform_driver cc10001_adc_driver = { .of_match_table = cc10001_adc_dt_ids, }, .probe = cc10001_adc_probe, - .remove = cc10001_adc_remove, };module_platform_driver (cc10001_adc_driver);
Signature · 1 line
2.37.2
Sa, Nuno
reviewerRE: [PATCH 5/5] iio: adc: cc10001: Switch remaining IIO calls in probe to devm_ forms.
Quoted 35 lines
-----Original Message-----
From: Jonathan Cameron <[email protected]>
Sent: Sunday, October 16, 2022 7:10 PM
To: [email protected]
Cc: Jonathan Cameron <[email protected]>
Subject: [PATCH 5/5] iio: adc: cc10001: Switch remaining IIO calls in probe todevm_forms.[External]
From: Jonathan Cameron <[email protected]>
As everything else is now handled by devm managed releases the triggered buffer setup and IIO device registration can also be moved over to their devm forms allowing dropping of
remove().Signed-off-by Jonathan Cameron <[email protected]>--- drivers/iio/adc/cc10001_adc.c | 28 +++------------------------- 1 file changed, 3 insertions(+), 25 deletions(-)drivers/iio/adc/cc10001_adc.c +1
-2@@ -390,33 +390,12 @@ static int cc10001_adc_probe(struct platform_device *pdev) mutex_init(&adc_dev->lock); - ret =iio_triggered_buffer_setup (indio_dev,NULL , - &cc10001_adc_trigger_h,NULL ); + ret = devm_iio_triggered_buffer_setup(dev, indio_dev, NULL,
drivers/iio/adc/cc10001_adc.c static int cc10001_adc_probe(struct · line 404
Quoted 10 lines
drivers/iio/adc/cc10001_adc.c +1
-6+ &cc10001_adc_trigger_h, NULL);if (ret <0 )return ret; - ret =iio_device_register (indio_dev); -if (ret <0 ) - goto err_cleanup_buffer; - -platform_set_drvdata (pdev, indio_dev); -
I wonder if it's obvious to everyone that removing this call as a consequence of not needing .remove() is clear enough that it does not deserve a mention in the commit message?
Note that I don't find it particular important so I will still ack it and leave it up to you :)
- Nuno Sá
Jonathan Cameron
maintainerQuoted 5 lines · On Sun, 16 Oct 2022 18:09:45 +0100 Jonathan Cameron <[email protected]> wrote:
From: Jonathan Cameron <[email protected]>
A very simple example of how using
devm_managed calls for everything can reduce complexity error handling and removal ordering in a driver.
Quoted 7 lines
Note I don't have one of these to test so if anyone has a chance to do so or give these a quick look at that would be much appreciated. Note this is a fairly old driver, so relative unlikely original authors still have access.
Cc Phani Movva <[email protected]>Cc Naidu Tellapati <[email protected]>
If anyone has time for a quick glance at this it would be much appreciated!
Old maintainer issue of who is the fall back reviewer for the maintainers own patches to old drivers, where the authors etc have probably long since moved on.
Jonathan
Quoted 13 lines
Jonathan Cameron (5):
iio: adc: cc10001: Add local struct device *dev variable to avoid
repitition
iio: adc: cc10001: Adddevm_add_action_or_reset()to disable
regulator.
iio: adc: cc10001: Usedevm_clk_get_enabled()to avoid boilerplate.
iio: adc: cc10001: Usedevm_to call device power down.
iio: adc: cc10001: Switch remaining IIO calls in probe todevm_forms.drivers/iio/adc/cc10001_adc.c | 89 +++++++++++++---------------------- 1 file changed, 34 insertions(+), 55 deletions(-)
Quoted 28 lines
-----Original Message-----
From: Jonathan Cameron <[email protected]>
Sent: Saturday, October 29, 2022 2:44 PM
To: [email protected]
Cc: Jonathan Cameron <[email protected]>; Phani Movva <[email protected]>; Naidu Tellapati <[email protected]>
Subject: Re: [PATCH 0/5] iio: adc: cc10001: Devm conversion[External]
Quoted 5 lines · On Sun, 16 Oct 2022 18:09:45 +0100 Jonathan Cameron <[email protected]> wrote:
From: Jonathan Cameron <[email protected]>
A very simple example of how using
devm_managed calls for everything can reduce complexity error handling and removal ordering in a driver.Quoted 7 lines
Note I don't have one of these to test so if anyone has a chance to do so or give these a quick look at that would be much appreciated. Note this is a fairly old driver, so relative unlikely original authors still have access.
Cc Phani Movva <[email protected]>Cc Naidu Tellapati <[email protected]>
Quoted 20 lines
If anyone has time for a quick glance at this it would be much appreciated!
Old maintainer issue of who is the fall back reviewer for the maintainers own patches to old drivers, where the authors etc have probably long since moved on.
Jonathan
Quoted 13 lines
Jonathan Cameron (5):
iio: adc: cc10001: Add local struct device *dev variable to avoid
repitition
iio: adc: cc10001: Adddevm_add_action_or_reset()to disable
regulator.
iio: adc: cc10001: Usedevm_clk_get_enabled()to avoid boilerplate.
iio: adc: cc10001: Usedevm_to call device power down.
iio: adc: cc10001: Switch remaining IIO calls in probe todevm_forms.drivers/iio/adc/cc10001_adc.c | 89 +++++++++++++---------------------- 1 file changed, 34 insertions(+), 55 deletions(-)
Only minor comments, so feel free to add:
Jonathan Cameron
maintainerQuoted 43 lines · Nuno
Quoted 43 lines
-----Original Message-----
From: Jonathan Cameron <[email protected]>
Sent: Saturday, October 29, 2022 2:44 PM
To: [email protected]
Cc: Jonathan Cameron <[email protected]>; Phani Movva <[email protected]>; Naidu Tellapati <[email protected]>
Subject: Re: [PATCH 0/5] iio: adc: cc10001: Devm conversion[External]
Quoted 5 lines · On Sun, 16 Oct 2022 18:09:45 +0100 Jonathan Cameron <[email protected]> wrote:
From: Jonathan Cameron <[email protected]>
A very simple example of how using
devm_managed calls for everything can reduce complexity error handling and removal ordering in a driver.Quoted 7 lines
Note I don't have one of these to test so if anyone has a chance to do so or give these a quick look at that would be much appreciated. Note this is a fairly old driver, so relative unlikely original authors still have access.
Cc Phani Movva <[email protected]>Cc Naidu Tellapati <[email protected]>If anyone has time for a quick glance at this it would be much appreciated!
Old maintainer issue of who is the fall back reviewer for the maintainers own patches to old drivers, where the authors etc have probably long since moved on.
Jonathan
Quoted 10 lines
Jonathan Cameron (5):
iio: adc: cc10001: Add local struct device *dev variable to avoid
repitition
iio: adc: cc10001: Adddevm_add_action_or_reset()to disable
regulator.
iio: adc: cc10001: Usedevm_clk_get_enabled()to avoid boilerplate.
iio: adc: cc10001: Usedevm_to call device power down.
iio: adc: cc10001: Switch remaining IIO calls in probe todevm_forms.
Quoted 7 lines
Quoted 3 lines
Quoted 3 lines
drivers/iio/adc/cc10001_adc.c | 89 +++++++++++++---------------------- 1 file changed, 34 insertions(+), 55 deletions(-)Only minor comments, so feel free to add:
Reviewed-by Nuno Sá <[email protected]>
Tweaked as suggested whilst applying. Thanks!
Applied to the togreg branch of iio.git and pushed out as testing for all the normal reasons.
Thanks,
Jonathan