2020-04-28 11:16:23

by Alexandru Ardelean

[permalink] [raw]
Subject: [PATCH 1/3] iio: adc: ti_am335x_adc: alloc channels via devm_kcalloc()

This change attaches the life-cycle of the channels array to the parent
device object that is attached to the IIO device.
This way we can remove from the cleanup code, the explicit
tiadc_channels_remove() which simply does a kfree() on the channels array.

Signed-off-by: Alexandru Ardelean <[email protected]>
---

The reason I'm targetting this driver, is because it's among the few
places where 'indio_dev->buffer' is accessed directly in the driver, and
that makes it difficult to think of a sane-backwards-compatible way to
do multiple IIO buffers.

drivers/iio/adc/ti_am335x_adc.c | 15 +++++----------
1 file changed, 5 insertions(+), 10 deletions(-)

diff --git a/drivers/iio/adc/ti_am335x_adc.c b/drivers/iio/adc/ti_am335x_adc.c
index 9d984f2a8ba7..d932fe383a24 100644
--- a/drivers/iio/adc/ti_am335x_adc.c
+++ b/drivers/iio/adc/ti_am335x_adc.c
@@ -428,7 +428,8 @@ static const char * const chan_name_ain[] = {
"AIN7",
};

-static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
+static int tiadc_channel_init(struct device *dev, struct iio_dev *indio_dev,
+ int channels)
{
struct tiadc_device *adc_dev = iio_priv(indio_dev);
struct iio_chan_spec *chan_array;
@@ -436,7 +437,8 @@ static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
int i;

indio_dev->num_channels = channels;
- chan_array = kcalloc(channels, sizeof(*chan_array), GFP_KERNEL);
+ chan_array = devm_kcalloc(dev, channels, sizeof(*chan_array),
+ GFP_KERNEL);
if (chan_array == NULL)
return -ENOMEM;

@@ -459,11 +461,6 @@ static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
return 0;
}

-static void tiadc_channels_remove(struct iio_dev *indio_dev)
-{
- kfree(indio_dev->channels);
-}
-
static int tiadc_read_raw(struct iio_dev *indio_dev,
struct iio_chan_spec const *chan,
int *val, int *val2, long mask)
@@ -635,7 +632,7 @@ static int tiadc_probe(struct platform_device *pdev)
tiadc_writel(adc_dev, REG_FIFO1THR, FIFO1_THRESHOLD);
mutex_init(&adc_dev->fifo1_lock);

- err = tiadc_channel_init(indio_dev, adc_dev->channels);
+ err = tiadc_channel_init(&pdev->dev, indio_dev, adc_dev->channels);
if (err < 0)
return err;

@@ -666,7 +663,6 @@ static int tiadc_probe(struct platform_device *pdev)
err_buffer_unregister:
tiadc_iio_buffered_hardware_remove(indio_dev);
err_free_channels:
- tiadc_channels_remove(indio_dev);
return err;
}

@@ -684,7 +680,6 @@ static int tiadc_remove(struct platform_device *pdev)
}
iio_device_unregister(indio_dev);
tiadc_iio_buffered_hardware_remove(indio_dev);
- tiadc_channels_remove(indio_dev);

step_en = get_adc_step_mask(adc_dev);
am335x_tsc_se_clr(adc_dev->mfd_tscadc, step_en);
--
2.17.1


2020-04-28 11:18:52

by Alexandru Ardelean

[permalink] [raw]
Subject: [PATCH 2/3] iio: adc: ti_am335x_adc: alloc kfifo & IRQ via devm_ functions

This change attaches the life-cycle of the kfifo buffer & IRQ to the
parent-device. This in turn cleans up the exit & error paths, since we
don't need to explicitly cleanup these resources.

The main intent here is to remove the explicit cleanup of the
'indio_dev->buffer' via 'iio_kfifo_free(indio_dev->buffer);'.

As we want to add support for multiple buffers per IIO device, having it
exposed like this makes it tricky to consider a safe backwards compatible
approach for it.

Signed-off-by: Alexandru Ardelean <[email protected]>
---
drivers/iio/adc/ti_am335x_adc.c | 20 +++++---------------
1 file changed, 5 insertions(+), 15 deletions(-)

diff --git a/drivers/iio/adc/ti_am335x_adc.c b/drivers/iio/adc/ti_am335x_adc.c
index d932fe383a24..03b2ab649cc3 100644
--- a/drivers/iio/adc/ti_am335x_adc.c
+++ b/drivers/iio/adc/ti_am335x_adc.c
@@ -377,7 +377,8 @@ static const struct iio_buffer_setup_ops tiadc_buffer_setup_ops = {
.postdisable = &tiadc_buffer_postdisable,
};

-static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
+static int tiadc_iio_buffered_hardware_setup(struct device *dev,
+ struct iio_dev *indio_dev,
irqreturn_t (*pollfunc_bh)(int irq, void *p),
irqreturn_t (*pollfunc_th)(int irq, void *p),
int irq,
@@ -387,13 +388,13 @@ static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
struct iio_buffer *buffer;
int ret;

- buffer = iio_kfifo_allocate();
+ buffer = devm_iio_kfifo_allocate(dev);
if (!buffer)
return -ENOMEM;

iio_device_attach_buffer(indio_dev, buffer);

- ret = request_threaded_irq(irq, pollfunc_th, pollfunc_bh,
+ ret = devm_request_threaded_irq(dev, irq, pollfunc_th, pollfunc_bh,
flags, indio_dev->name, indio_dev);
if (ret)
goto error_kfifo_free;
@@ -408,15 +409,6 @@ static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
return ret;
}

-static void tiadc_iio_buffered_hardware_remove(struct iio_dev *indio_dev)
-{
- struct tiadc_device *adc_dev = iio_priv(indio_dev);
-
- free_irq(adc_dev->mfd_tscadc->irq, indio_dev);
- iio_kfifo_free(indio_dev->buffer);
-}
-
-
static const char * const chan_name_ain[] = {
"AIN0",
"AIN1",
@@ -636,7 +628,7 @@ static int tiadc_probe(struct platform_device *pdev)
if (err < 0)
return err;

- err = tiadc_iio_buffered_hardware_setup(indio_dev,
+ err = tiadc_iio_buffered_hardware_setup(&pdev->dev, indio_dev,
&tiadc_worker_h,
&tiadc_irq_h,
adc_dev->mfd_tscadc->irq,
@@ -661,7 +653,6 @@ static int tiadc_probe(struct platform_device *pdev)
err_dma:
iio_device_unregister(indio_dev);
err_buffer_unregister:
- tiadc_iio_buffered_hardware_remove(indio_dev);
err_free_channels:
return err;
}
@@ -679,7 +670,6 @@ static int tiadc_remove(struct platform_device *pdev)
dma_release_channel(dma->chan);
}
iio_device_unregister(indio_dev);
- tiadc_iio_buffered_hardware_remove(indio_dev);

step_en = get_adc_step_mask(adc_dev);
am335x_tsc_se_clr(adc_dev->mfd_tscadc, step_en);
--
2.17.1

2020-07-05 12:05:46

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH 2/3] iio: adc: ti_am335x_adc: alloc kfifo & IRQ via devm_ functions

On Tue, 28 Apr 2020 14:14:29 +0300
Alexandru Ardelean <[email protected]> wrote:

> This change attaches the life-cycle of the kfifo buffer & IRQ to the
> parent-device. This in turn cleans up the exit & error paths, since we
> don't need to explicitly cleanup these resources.
>
> The main intent here is to remove the explicit cleanup of the
> 'indio_dev->buffer' via 'iio_kfifo_free(indio_dev->buffer);'.
>
> As we want to add support for multiple buffers per IIO device, having it
> exposed like this makes it tricky to consider a safe backwards compatible
> approach for it.
>
> Signed-off-by: Alexandru Ardelean <[email protected]>
Applied.

> ---
> drivers/iio/adc/ti_am335x_adc.c | 20 +++++---------------
> 1 file changed, 5 insertions(+), 15 deletions(-)
>
> diff --git a/drivers/iio/adc/ti_am335x_adc.c b/drivers/iio/adc/ti_am335x_adc.c
> index d932fe383a24..03b2ab649cc3 100644
> --- a/drivers/iio/adc/ti_am335x_adc.c
> +++ b/drivers/iio/adc/ti_am335x_adc.c
> @@ -377,7 +377,8 @@ static const struct iio_buffer_setup_ops tiadc_buffer_setup_ops = {
> .postdisable = &tiadc_buffer_postdisable,
> };
>
> -static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
> +static int tiadc_iio_buffered_hardware_setup(struct device *dev,
> + struct iio_dev *indio_dev,
> irqreturn_t (*pollfunc_bh)(int irq, void *p),
> irqreturn_t (*pollfunc_th)(int irq, void *p),
> int irq,
> @@ -387,13 +388,13 @@ static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
> struct iio_buffer *buffer;
> int ret;
>
> - buffer = iio_kfifo_allocate();
> + buffer = devm_iio_kfifo_allocate(dev);
> if (!buffer)
> return -ENOMEM;
>
> iio_device_attach_buffer(indio_dev, buffer);
>
> - ret = request_threaded_irq(irq, pollfunc_th, pollfunc_bh,
> + ret = devm_request_threaded_irq(dev, irq, pollfunc_th, pollfunc_bh,
> flags, indio_dev->name, indio_dev);
> if (ret)
> goto error_kfifo_free;
> @@ -408,15 +409,6 @@ static int tiadc_iio_buffered_hardware_setup(struct iio_dev *indio_dev,
> return ret;
> }
>
> -static void tiadc_iio_buffered_hardware_remove(struct iio_dev *indio_dev)
> -{
> - struct tiadc_device *adc_dev = iio_priv(indio_dev);
> -
> - free_irq(adc_dev->mfd_tscadc->irq, indio_dev);
> - iio_kfifo_free(indio_dev->buffer);
> -}
> -
> -
> static const char * const chan_name_ain[] = {
> "AIN0",
> "AIN1",
> @@ -636,7 +628,7 @@ static int tiadc_probe(struct platform_device *pdev)
> if (err < 0)
> return err;
>
> - err = tiadc_iio_buffered_hardware_setup(indio_dev,
> + err = tiadc_iio_buffered_hardware_setup(&pdev->dev, indio_dev,
> &tiadc_worker_h,
> &tiadc_irq_h,
> adc_dev->mfd_tscadc->irq,
> @@ -661,7 +653,6 @@ static int tiadc_probe(struct platform_device *pdev)
> err_dma:
> iio_device_unregister(indio_dev);
> err_buffer_unregister:
> - tiadc_iio_buffered_hardware_remove(indio_dev);
> err_free_channels:
> return err;
> }
> @@ -679,7 +670,6 @@ static int tiadc_remove(struct platform_device *pdev)
> dma_release_channel(dma->chan);
> }
> iio_device_unregister(indio_dev);
> - tiadc_iio_buffered_hardware_remove(indio_dev);
>
> step_en = get_adc_step_mask(adc_dev);
> am335x_tsc_se_clr(adc_dev->mfd_tscadc, step_en);

2020-07-05 12:06:45

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH 1/3] iio: adc: ti_am335x_adc: alloc channels via devm_kcalloc()

On Tue, 28 Apr 2020 14:14:28 +0300
Alexandru Ardelean <[email protected]> wrote:

> This change attaches the life-cycle of the channels array to the parent
> device object that is attached to the IIO device.
> This way we can remove from the cleanup code, the explicit
> tiadc_channels_remove() which simply does a kfree() on the channels array.
>
> Signed-off-by: Alexandru Ardelean <[email protected]>
Still not sure on patch 3 but I'll pick up the first 2 so we can forget
about those.

Applied to the togreg branch of iio.git and pushed out as testing for
all the usual reasons.

Thanks,

Jonathan

> ---
>
> The reason I'm targetting this driver, is because it's among the few
> places where 'indio_dev->buffer' is accessed directly in the driver, and
> that makes it difficult to think of a sane-backwards-compatible way to
> do multiple IIO buffers.
>
> drivers/iio/adc/ti_am335x_adc.c | 15 +++++----------
> 1 file changed, 5 insertions(+), 10 deletions(-)
>
> diff --git a/drivers/iio/adc/ti_am335x_adc.c b/drivers/iio/adc/ti_am335x_adc.c
> index 9d984f2a8ba7..d932fe383a24 100644
> --- a/drivers/iio/adc/ti_am335x_adc.c
> +++ b/drivers/iio/adc/ti_am335x_adc.c
> @@ -428,7 +428,8 @@ static const char * const chan_name_ain[] = {
> "AIN7",
> };
>
> -static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
> +static int tiadc_channel_init(struct device *dev, struct iio_dev *indio_dev,
> + int channels)
> {
> struct tiadc_device *adc_dev = iio_priv(indio_dev);
> struct iio_chan_spec *chan_array;
> @@ -436,7 +437,8 @@ static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
> int i;
>
> indio_dev->num_channels = channels;
> - chan_array = kcalloc(channels, sizeof(*chan_array), GFP_KERNEL);
> + chan_array = devm_kcalloc(dev, channels, sizeof(*chan_array),
> + GFP_KERNEL);
> if (chan_array == NULL)
> return -ENOMEM;
>
> @@ -459,11 +461,6 @@ static int tiadc_channel_init(struct iio_dev *indio_dev, int channels)
> return 0;
> }
>
> -static void tiadc_channels_remove(struct iio_dev *indio_dev)
> -{
> - kfree(indio_dev->channels);
> -}
> -
> static int tiadc_read_raw(struct iio_dev *indio_dev,
> struct iio_chan_spec const *chan,
> int *val, int *val2, long mask)
> @@ -635,7 +632,7 @@ static int tiadc_probe(struct platform_device *pdev)
> tiadc_writel(adc_dev, REG_FIFO1THR, FIFO1_THRESHOLD);
> mutex_init(&adc_dev->fifo1_lock);
>
> - err = tiadc_channel_init(indio_dev, adc_dev->channels);
> + err = tiadc_channel_init(&pdev->dev, indio_dev, adc_dev->channels);
> if (err < 0)
> return err;
>
> @@ -666,7 +663,6 @@ static int tiadc_probe(struct platform_device *pdev)
> err_buffer_unregister:
> tiadc_iio_buffered_hardware_remove(indio_dev);
> err_free_channels:
> - tiadc_channels_remove(indio_dev);
> return err;
> }
>
> @@ -684,7 +680,6 @@ static int tiadc_remove(struct platform_device *pdev)
> }
> iio_device_unregister(indio_dev);
> tiadc_iio_buffered_hardware_remove(indio_dev);
> - tiadc_channels_remove(indio_dev);
>
> step_en = get_adc_step_mask(adc_dev);
> am335x_tsc_se_clr(adc_dev->mfd_tscadc, step_en);