[PATCH v2] iio: adc: at91-sama5d2_adc: add support for suspend/resume functionality

[PATCH v2] iio: adc: at91-sama5d2_adc: add support for suspend/resume functionality

[Eugen Hristev]

Added support for suspend/resume functionality for the ADC IP
in sama5d2 SoC.
In order to enter Suspend to ram mode (backup + self refresh mode for
memory), in which the ADC IP is no longer powered, we need to reset the
pins to default state, for the scenario when they are also used for I2C
bus to communicate with the PMIC.
On resume, we need to reconfigure the ADC IP registers and reconfigure the
trigger registers in the case when the suspend procedure is done while
sysfs has the buffer and trigger enabled.
In the case the suspend happens exactly during a software triggered
conversion, the request will time out, because we reset and power down
the ADC.

Signed-off-by: Eugen Hristev <eugen.hristev@microchip.com>
---
 This patch is based on patch [PATCH v5 4/4] iio: adc: at91-sama5d2_adc:
 add hw trigger and buffer support
 which was accepted and on it's way upstream.
 Building without it will fail.

 Changes in v2:
 - added include header for pinctrl to avoid build issues on other arch

 drivers/iio/adc/at91-sama5d2_adc.c | 92 +++++++++++++++++++++++++++++++++-----
 1 file changed, 82 insertions(+), 10 deletions(-)

diff --git a/drivers/iio/adc/at91-sama5d2_adc.c b/drivers/iio/adc/at91-sama5d2_adc.c
index 1773a5d..3d7599f 100644
--- a/drivers/iio/adc/at91-sama5d2_adc.c
+++ b/drivers/iio/adc/at91-sama5d2_adc.c
@@ -29,6 +29,7 @@
 #include <linux/iio/trigger.h>
 #include <linux/iio/trigger_consumer.h>
 #include <linux/iio/triggered_buffer.h>
+#include <linux/pinctrl/consumer.h>
 #include <linux/regulator/consumer.h>
 
 /* Control Register */
@@ -576,6 +577,20 @@ static const struct iio_info at91_adc_info = {
 	.driver_module = THIS_MODULE,
 };
 
+static void at91_adc_hw_init(struct at91_adc_state *st)
+{
+	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
+	at91_adc_writel(st, AT91_SAMA5D2_IDR, 0xffffffff);
+	/*
+	 * Transfer field must be set to 2 according to the datasheet and
+	 * allows different analog settings for each channel.
+	 */
+	at91_adc_writel(st, AT91_SAMA5D2_MR,
+			AT91_SAMA5D2_MR_TRANSFER(2) | AT91_SAMA5D2_MR_ANACH);
+
+	at91_adc_setup_samp_freq(st, st->soc_info.min_sample_rate);
+}
+
 static int at91_adc_probe(struct platform_device *pdev)
 {
 	struct iio_dev *indio_dev;
@@ -694,16 +709,7 @@ static int at91_adc_probe(struct platform_device *pdev)
 		goto vref_disable;
 	}
 
-	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
-	at91_adc_writel(st, AT91_SAMA5D2_IDR, 0xffffffff);
-	/*
-	 * Transfer field must be set to 2 according to the datasheet and
-	 * allows different analog settings for each channel.
-	 */
-	at91_adc_writel(st, AT91_SAMA5D2_MR,
-			AT91_SAMA5D2_MR_TRANSFER(2) | AT91_SAMA5D2_MR_ANACH);
-
-	at91_adc_setup_samp_freq(st, st->soc_info.min_sample_rate);
+	at91_adc_hw_init(st);
 
 	ret = clk_prepare_enable(st->per_clk);
 	if (ret)
@@ -759,6 +765,71 @@ static int at91_adc_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM_SLEEP
+static int at91_adc_suspend(struct device *dev)
+{
+	struct iio_dev *indio_dev =
+			platform_get_drvdata(to_platform_device(dev));
+	struct at91_adc_state *st = iio_priv(indio_dev);
+
+	/*
+	 * Do a sofware reset of the ADC before we go to suspend.
+	 * this will ensure that all pins are free from being muxed by the ADC
+	 * and can be used by for other devices.
+	 * Otherwise, ADC will hog them and we can't go to suspend mode.
+	 */
+	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
+
+	clk_disable_unprepare(st->per_clk);
+	regulator_disable(st->vref);
+	regulator_disable(st->reg);
+
+	return pinctrl_pm_select_sleep_state(dev);
+}
+
+static int at91_adc_resume(struct device *dev)
+{
+	struct iio_dev *indio_dev =
+			platform_get_drvdata(to_platform_device(dev));
+	struct at91_adc_state *st = iio_priv(indio_dev);
+	int ret;
+
+	ret = pinctrl_pm_select_default_state(dev);
+	if (ret)
+		goto resume_failed;
+
+	ret = regulator_enable(st->reg);
+	if (ret)
+		goto resume_failed;
+
+	ret = regulator_enable(st->vref);
+	if (ret)
+		goto reg_disable_resume;
+
+	ret = clk_prepare_enable(st->per_clk);
+	if (ret)
+		goto vref_disable_resume;
+
+	at91_adc_hw_init(st);
+
+	/* reconfiguring trigger hardware state */
+	if (iio_buffer_enabled(indio_dev))
+		at91_adc_configure_trigger(st->trig, true);
+
+	return 0;
+
+vref_disable_resume:
+	regulator_disable(st->vref);
+reg_disable_resume:
+	regulator_disable(st->reg);
+resume_failed:
+	dev_err(&indio_dev->dev, "failed to resume\n");
+	return ret;
+}
+#endif
+
+static SIMPLE_DEV_PM_OPS(at91_adc_pm_ops, at91_adc_suspend, at91_adc_resume);
+
 static const struct of_device_id at91_adc_dt_match[] = {
 	{
 		.compatible = "atmel,sama5d2-adc",
@@ -774,6 +845,7 @@ static struct platform_driver at91_adc_driver = {
 	.driver = {
 		.name = "at91-sama5d2_adc",
 		.of_match_table = at91_adc_dt_match,
+		.pm = &at91_adc_pm_ops,
 	},
 };
 module_platform_driver(at91_adc_driver)
-- 
2.7.4

Re: [PATCH v2] iio: adc: at91-sama5d2_adc: add support for suspend/resume functionality

[Jonathan Cameron]

On Fri, 23 Jun 2017 15:54:57 +0300
Eugen Hristev <eugen.hristev@microchip.com> wrote:

> Added support for suspend/resume functionality for the ADC IP
> in sama5d2 SoC.
> In order to enter Suspend to ram mode (backup + self refresh mode for
> memory), in which the ADC IP is no longer powered, we need to reset the
> pins to default state, for the scenario when they are also used for I2C
> bus to communicate with the PMIC.
> On resume, we need to reconfigure the ADC IP registers and reconfigure the
> trigger registers in the case when the suspend procedure is done while
> sysfs has the buffer and trigger enabled.
> In the case the suspend happens exactly during a software triggered
> conversion, the request will time out, because we reset and power down
> the ADC.
> 
> Signed-off-by: Eugen Hristev <eugen.hristev@microchip.com>
> ---
>  This patch is based on patch [PATCH v5 4/4] iio: adc: at91-sama5d2_adc:
>  add hw trigger and buffer support
>  which was accepted and on it's way upstream.
>  Building without it will fail.
I'm  a little confused on this.   You mean that if we apply this patch
without the prerequisit it won't work? (fair enough) or that without
it the original patch won't work?  I'll assume the first but shout if
I'm wrong.

A minor point inline to avoid the inevitable patch from Arnd to fix it :)

The pinctrl stuff matches up with various other drivers so whilst I'm
not familiar with that corner it looks right.

I'll fix up the __maybe_unused bit and apply this to the togreg branch of
iio.git - initially pushed out as testing.

Jonathan
> 
>  Changes in v2:
>  - added include header for pinctrl to avoid build issues on other arch
> 
>  drivers/iio/adc/at91-sama5d2_adc.c | 92 +++++++++++++++++++++++++++++++++-----
>  1 file changed, 82 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/iio/adc/at91-sama5d2_adc.c b/drivers/iio/adc/at91-sama5d2_adc.c
> index 1773a5d..3d7599f 100644
> --- a/drivers/iio/adc/at91-sama5d2_adc.c
> +++ b/drivers/iio/adc/at91-sama5d2_adc.c
> @@ -29,6 +29,7 @@
>  #include <linux/iio/trigger.h>
>  #include <linux/iio/trigger_consumer.h>
>  #include <linux/iio/triggered_buffer.h>
> +#include <linux/pinctrl/consumer.h>
>  #include <linux/regulator/consumer.h>
>  
>  /* Control Register */
> @@ -576,6 +577,20 @@ static const struct iio_info at91_adc_info = {
>  	.driver_module = THIS_MODULE,
>  };
>  
> +static void at91_adc_hw_init(struct at91_adc_state *st)
> +{
> +	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
> +	at91_adc_writel(st, AT91_SAMA5D2_IDR, 0xffffffff);
> +	/*
> +	 * Transfer field must be set to 2 according to the datasheet and
> +	 * allows different analog settings for each channel.
> +	 */
> +	at91_adc_writel(st, AT91_SAMA5D2_MR,
> +			AT91_SAMA5D2_MR_TRANSFER(2) | AT91_SAMA5D2_MR_ANACH);
> +
> +	at91_adc_setup_samp_freq(st, st->soc_info.min_sample_rate);
> +}
> +
>  static int at91_adc_probe(struct platform_device *pdev)
>  {
>  	struct iio_dev *indio_dev;
> @@ -694,16 +709,7 @@ static int at91_adc_probe(struct platform_device *pdev)
>  		goto vref_disable;
>  	}
>  
> -	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
> -	at91_adc_writel(st, AT91_SAMA5D2_IDR, 0xffffffff);
> -	/*
> -	 * Transfer field must be set to 2 according to the datasheet and
> -	 * allows different analog settings for each channel.
> -	 */
> -	at91_adc_writel(st, AT91_SAMA5D2_MR,
> -			AT91_SAMA5D2_MR_TRANSFER(2) | AT91_SAMA5D2_MR_ANACH);
> -
> -	at91_adc_setup_samp_freq(st, st->soc_info.min_sample_rate);
> +	at91_adc_hw_init(st);
>  
>  	ret = clk_prepare_enable(st->per_clk);
>  	if (ret)
> @@ -759,6 +765,71 @@ static int at91_adc_remove(struct platform_device *pdev)
>  	return 0;
>  }
>  
> +#ifdef CONFIG_PM_SLEEP
General move in the kernel has been towards marking
suspend and resume with __maybe_unused rather than 
putting them in this ifdef.

An example of patch with description of why is:
https://patchwork.linuxtv.org/patch/38262/

Arnd has changed a lot of IIO drivers, but there are probably still
some to do.
> +static int at91_adc_suspend(struct device *dev)
> +{
> +	struct iio_dev *indio_dev =
> +			platform_get_drvdata(to_platform_device(dev));
> +	struct at91_adc_state *st = iio_priv(indio_dev);
> +
> +	/*
> +	 * Do a sofware reset of the ADC before we go to suspend.
> +	 * this will ensure that all pins are free from being muxed by the ADC
> +	 * and can be used by for other devices.
> +	 * Otherwise, ADC will hog them and we can't go to suspend mode.
> +	 */
> +	at91_adc_writel(st, AT91_SAMA5D2_CR, AT91_SAMA5D2_CR_SWRST);
> +
> +	clk_disable_unprepare(st->per_clk);
> +	regulator_disable(st->vref);
> +	regulator_disable(st->reg);
> +
> +	return pinctrl_pm_select_sleep_state(dev);
> +}
> +
> +static int at91_adc_resume(struct device *dev)
> +{
> +	struct iio_dev *indio_dev =
> +			platform_get_drvdata(to_platform_device(dev));
> +	struct at91_adc_state *st = iio_priv(indio_dev);
> +	int ret;
> +
> +	ret = pinctrl_pm_select_default_state(dev);
> +	if (ret)
> +		goto resume_failed;
> +
> +	ret = regulator_enable(st->reg);
> +	if (ret)
> +		goto resume_failed;
> +
> +	ret = regulator_enable(st->vref);
> +	if (ret)
> +		goto reg_disable_resume;
> +
> +	ret = clk_prepare_enable(st->per_clk);
> +	if (ret)
> +		goto vref_disable_resume;
> +
> +	at91_adc_hw_init(st);
> +
> +	/* reconfiguring trigger hardware state */
> +	if (iio_buffer_enabled(indio_dev))
> +		at91_adc_configure_trigger(st->trig, true);
> +
> +	return 0;
> +
> +vref_disable_resume:
> +	regulator_disable(st->vref);
> +reg_disable_resume:
> +	regulator_disable(st->reg);
> +resume_failed:
> +	dev_err(&indio_dev->dev, "failed to resume\n");
> +	return ret;
> +}
> +#endif
> +
> +static SIMPLE_DEV_PM_OPS(at91_adc_pm_ops, at91_adc_suspend, at91_adc_resume);
> +
>  static const struct of_device_id at91_adc_dt_match[] = {
>  	{
>  		.compatible = "atmel,sama5d2-adc",
> @@ -774,6 +845,7 @@ static struct platform_driver at91_adc_driver = {
>  	.driver = {
>  		.name = "at91-sama5d2_adc",
>  		.of_match_table = at91_adc_dt_match,
> +		.pm = &at91_adc_pm_ops,
>  	},
>  };
>  module_platform_driver(at91_adc_driver)