[PATCH] rotary encoder: Add wake up support

[PATCH] rotary encoder: Add wake up support

[Sylvain Rochet]

This patch add wake up support for rotary encoders.
New DT property: rotary-encoder,wakeup

Signed-off-by: Sylvain Rochet <sylvain.rochet@finsecur.com>
---
 .../devicetree/bindings/input/rotary-encoder.txt   |  1 +
 Documentation/input/rotary-encoder.txt             |  1 +
 drivers/input/misc/rotary_encoder.c                | 36 ++++++++++++++++++++++
 include/linux/rotary_encoder.h                     |  1 +
 4 files changed, 39 insertions(+)

diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
index 3315495..468d545 100644
--- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
+++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
@@ -15,6 +15,7 @@ Optional properties:
 - rotary-encoder,rollover: Automatic rollove when the rotary value becomes
   greater than the specified steps or smaller than 0. For absolute axis only.
 - rotary-encoder,half-period: Makes the driver work on half-period mode.
+- rotary-encoder,wakeup: Boolean, rotary encoder can wake-up the system.
 
 See Documentation/input/rotary-encoder.txt for more information.
 
diff --git a/Documentation/input/rotary-encoder.txt b/Documentation/input/rotary-encoder.txt
index 92e68bc..6cc873f 100644
--- a/Documentation/input/rotary-encoder.txt
+++ b/Documentation/input/rotary-encoder.txt
@@ -109,6 +109,7 @@ static struct rotary_encoder_platform_data my_rotary_encoder_info = {
 	.inverted_a	= 0,
 	.inverted_b	= 0,
 	.half_period	= false,
+	.wakeup		= false,
 };
 
 static struct platform_device rotary_encoder_device = {
diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
index f27f81e..029b8a1 100644
--- a/drivers/input/misc/rotary_encoder.c
+++ b/drivers/input/misc/rotary_encoder.c
@@ -26,6 +26,7 @@
 #include <linux/of.h>
 #include <linux/of_platform.h>
 #include <linux/of_gpio.h>
+#include <linux/pm.h>
 
 #define DRV_NAME "rotary-encoder"
 
@@ -180,6 +181,8 @@ static struct rotary_encoder_platform_data *rotary_encoder_parse_dt(struct devic
 					"rotary-encoder,rollover", NULL);
 	pdata->half_period = !!of_get_property(np,
 					"rotary-encoder,half-period", NULL);
+	pdata->wakeup = !!of_get_property(np,
+					"rotary-encoder,wakeup", NULL);
 
 	return pdata;
 }
@@ -280,6 +283,8 @@ static int rotary_encoder_probe(struct platform_device *pdev)
 		goto exit_free_irq_b;
 	}
 
+	device_init_wakeup(&pdev->dev, pdata->wakeup);
+
 	platform_set_drvdata(pdev, encoder);
 
 	return 0;
@@ -306,6 +311,8 @@ static int rotary_encoder_remove(struct platform_device *pdev)
 	struct rotary_encoder *encoder = platform_get_drvdata(pdev);
 	const struct rotary_encoder_platform_data *pdata = encoder->pdata;
 
+	device_init_wakeup(&pdev->dev, 0);
+
 	free_irq(encoder->irq_a, encoder);
 	free_irq(encoder->irq_b, encoder);
 	gpio_free(pdata->gpio_a);
@@ -320,11 +327,40 @@ static int rotary_encoder_remove(struct platform_device *pdev)
 	return 0;
 }
 
+#ifdef CONFIG_PM_SLEEP
+static int rotary_encoder_suspend(struct device *dev)
+{
+	struct rotary_encoder *encoder = dev_get_drvdata(dev);
+
+	if (device_may_wakeup(dev)) {
+		enable_irq_wake(encoder->irq_a);
+		enable_irq_wake(encoder->irq_b);
+	}
+
+	return 0;
+}
+
+static int rotary_encoder_resume(struct device *dev)
+{
+	struct rotary_encoder *encoder = dev_get_drvdata(dev);
+
+	if (device_may_wakeup(dev)) {
+		disable_irq_wake(encoder->irq_a);
+		disable_irq_wake(encoder->irq_b);
+	}
+
+	return 0;
+}
+#endif
+
+static SIMPLE_DEV_PM_OPS(rotary_encoder_pm_ops, rotary_encoder_suspend, rotary_encoder_resume);
+
 static struct platform_driver rotary_encoder_driver = {
 	.probe		= rotary_encoder_probe,
 	.remove		= rotary_encoder_remove,
 	.driver		= {
 		.name	= DRV_NAME,
+		.pm	= &rotary_encoder_pm_ops,
 		.of_match_table = of_match_ptr(rotary_encoder_of_match),
 	}
 };
diff --git a/include/linux/rotary_encoder.h b/include/linux/rotary_encoder.h
index 3f594dc..72b3fc9 100644
--- a/include/linux/rotary_encoder.h
+++ b/include/linux/rotary_encoder.h
@@ -11,6 +11,7 @@ struct rotary_encoder_platform_data {
 	bool relative_axis;
 	bool rollover;
 	bool half_period;
+	int wakeup;			/* configure the rotary-encoder as a wake-up source */
 };
 
 #endif /* __ROTARY_ENCODER_H__ */
-- 
2.1.4

Re: [PATCH] rotary encoder: Add wake up support

[Dmitry Torokhov]

On Tue, Jan 13, 2015 at 04:51:02PM +0100, Sylvain Rochet wrote:
> This patch add wake up support for rotary encoders.
> New DT property: rotary-encoder,wakeup
> 
> Signed-off-by: Sylvain Rochet <sylvain.rochet-ETtyaVkrhkNWk0Htik3J/w@public.gmane.org>
> ---
>  .../devicetree/bindings/input/rotary-encoder.txt   |  1 +
>  Documentation/input/rotary-encoder.txt             |  1 +
>  drivers/input/misc/rotary_encoder.c                | 36 ++++++++++++++++++++++
>  include/linux/rotary_encoder.h                     |  1 +
>  4 files changed, 39 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> index 3315495..468d545 100644
> --- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
> +++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> @@ -15,6 +15,7 @@ Optional properties:
>  - rotary-encoder,rollover: Automatic rollove when the rotary value becomes
>    greater than the specified steps or smaller than 0. For absolute axis only.
>  - rotary-encoder,half-period: Makes the driver work on half-period mode.
> +- rotary-encoder,wakeup: Boolean, rotary encoder can wake-up the system.

I wonder if this should be "rotary-encoder,wakeup", "linux,wakeup" or
"wakeup-source".

Devicetree folks, what say you?

Thanks.

-- 
Dmitry
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH] rotary encoder: Add wake up support

[Johan Hovold]

On Tue, Jan 13, 2015 at 04:51:02PM +0100, Sylvain Rochet wrote:
> This patch add wake up support for rotary encoders.
> New DT property: rotary-encoder,wakeup
> 
> Signed-off-by: Sylvain Rochet <sylvain.rochet@finsecur.com>
> ---
>  .../devicetree/bindings/input/rotary-encoder.txt   |  1 +
>  Documentation/input/rotary-encoder.txt             |  1 +
>  drivers/input/misc/rotary_encoder.c                | 36 ++++++++++++++++++++++
>  include/linux/rotary_encoder.h                     |  1 +
>  4 files changed, 39 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> index 3315495..468d545 100644
> --- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
> +++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> @@ -15,6 +15,7 @@ Optional properties:
>  - rotary-encoder,rollover: Automatic rollove when the rotary value becomes
>    greater than the specified steps or smaller than 0. For absolute axis only.
>  - rotary-encoder,half-period: Makes the driver work on half-period mode.
> +- rotary-encoder,wakeup: Boolean, rotary encoder can wake-up the system.

As Dmitry already mentioned this should probably just be
"wakeup-source".

[...]

> +static SIMPLE_DEV_PM_OPS(rotary_encoder_pm_ops, rotary_encoder_suspend, rotary_encoder_resume);

Please break this line to stay within 80 cols.

> +
>  static struct platform_driver rotary_encoder_driver = {
>  	.probe		= rotary_encoder_probe,
>  	.remove		= rotary_encoder_remove,
>  	.driver		= {
>  		.name	= DRV_NAME,
> +		.pm	= &rotary_encoder_pm_ops,
>  		.of_match_table = of_match_ptr(rotary_encoder_of_match),
>  	}
>  };
> diff --git a/include/linux/rotary_encoder.h b/include/linux/rotary_encoder.h
> index 3f594dc..72b3fc9 100644
> --- a/include/linux/rotary_encoder.h
> +++ b/include/linux/rotary_encoder.h
> @@ -11,6 +11,7 @@ struct rotary_encoder_platform_data {
>  	bool relative_axis;
>  	bool rollover;
>  	bool half_period;
> +	int wakeup;			/* configure the rotary-encoder as a wake-up source */

This should be bool.

I also suggest you rename the variable wakeup_source and drop the
verbose comment.

Looks good otherwise.

Thanks,
Johan

Re: [PATCH] rotary encoder: Add wake up support

[Sylvain Rochet]

Hello Johan,

On Thu, Jan 29, 2015 at 11:49:53AM +0100, Johan Hovold wrote:
> On Tue, Jan 13, 2015 at 04:51:02PM +0100, Sylvain Rochet wrote:
> > This patch add wake up support for rotary encoders.
> > New DT property: rotary-encoder,wakeup
> > 
> > Signed-off-by: Sylvain Rochet <sylvain.rochet@finsecur.com>
> > ---
> >  .../devicetree/bindings/input/rotary-encoder.txt   |  1 +
> >  Documentation/input/rotary-encoder.txt             |  1 +
> >  drivers/input/misc/rotary_encoder.c                | 36 ++++++++++++++++++++++
> >  include/linux/rotary_encoder.h                     |  1 +
> >  4 files changed, 39 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > index 3315495..468d545 100644
> > --- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > +++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > @@ -15,6 +15,7 @@ Optional properties:
> >  - rotary-encoder,rollover: Automatic rollove when the rotary value becomes
> >    greater than the specified steps or smaller than 0. For absolute axis only.
> >  - rotary-encoder,half-period: Makes the driver work on half-period mode.
> > +- rotary-encoder,wakeup: Boolean, rotary encoder can wake-up the system.
> 
> As Dmitry already mentioned this should probably just be
> "wakeup-source".

Yeah, I think so.


> > +static SIMPLE_DEV_PM_OPS(rotary_encoder_pm_ops, rotary_encoder_suspend, rotary_encoder_resume);
> 
> Please break this line to stay within 80 cols.

I saw that afterward, I waited the answer about DT property to propose a 
v2. Fixed.


> > +	int wakeup;			/* configure the rotary-encoder as a wake-up source */
> 
> This should be bool.

Ditto. Fixed.


> I also suggest you rename the variable wakeup_source and drop the
> verbose comment.

I agree, done !


> Looks good otherwise.

Thank for the review, v2 sent :)


Sylvain