[PATCH 1/2] input: rotary-encoder: add DT bindings

[PATCH 1/2] input: rotary-encoder: add DT bindings

[Daniel Mack]

This adds devicetree bindings to the rotary encoder driver and some
documenation about how to use them. Tested on a PXA3xx platform.

Signed-off-by: Daniel Mack <zonque@gmail.com>
---
 .../devicetree/bindings/input/rotary-encoder.txt   |   37 ++++++++++++
 drivers/input/misc/rotary_encoder.c                |   63 +++++++++++++++++++-
 2 files changed, 99 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/input/rotary-encoder.txt

diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
new file mode 100644
index 0000000..dd1f634
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
@@ -0,0 +1,37 @@
+Rotary encoder DT bindings
+
+Required properties:
+- gpios: a spec for two GPIOs to be used
+
+Optional properties:
+- linux,axis: the input subsystem axis to map to this rotary encoder.
+  Defaults to 0 (ABS_X / REL_X)
+- rotary-encoder,steps: Number of steps in a full turnaround of the
+  encoder. Only relevant for absolute axis. Defaults to 24 which is a
+  typical value for such devices.
+- rotary-encoder,relative-axis: register a relative axis rather than an
+  absolute one. Relative axis will only generate +1/-1 events on the input
+  device, hence no steps need to be passed.
+- 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.
+
+See Documentation/input/rotary-encoder.txt for more information.
+
+Example:
+
+		rotary@0 {
+			compatible = "rotary-encoder";
+			gpios = <&gpio 19 1>, <&gpio 20 0>; /* GPIO19 is inverted */
+			linux,axis = <0>; /* REL_X */
+			rotary-encoder,relative-axis;
+		};
+
+		rotary@1 {
+			compatible = "rotary-encoder";
+			gpios = <&gpio 21 0>, <&gpio 22 0>;
+			linux,axis = <1>; /* ABS_Y */
+			rotary-encoder,steps = <24>;
+			rotary-encoder,rollover;
+		};
+
diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
index f07f784..350cbd1 100644
--- a/drivers/input/misc/rotary_encoder.c
+++ b/drivers/input/misc/rotary_encoder.c
@@ -24,6 +24,8 @@
 #include <linux/gpio.h>
 #include <linux/rotary_encoder.h>
 #include <linux/slab.h>
+#include <linux/of_platform.h>
+#include <linux/of_gpio.h>
 
 #define DRV_NAME "rotary-encoder"
 
@@ -140,14 +142,72 @@ static irqreturn_t rotary_encoder_half_period_irq(int irq, void *dev_id)
 	return IRQ_HANDLED;
 }
 
+#ifdef CONFIG_OF
+static struct of_device_id rotary_encoder_of_match[] = {
+	{ .compatible = "rotary-encoder", },
+	{ },
+};
+MODULE_DEVICE_TABLE(of, rotary_encoder_of_match);
+
+static int rotary_encoder_probe_dt(struct platform_device *pdev)
+{
+	int tmp;
+	enum of_gpio_flags flags;
+	struct rotary_encoder_platform_data *pdata;
+	struct device_node *np = pdev->dev.of_node;
+	const struct of_device_id *of_id =
+		of_match_device(rotary_encoder_of_match, &pdev->dev);
+
+	if (!of_id)
+		return 0;
+
+	pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
+	if (!pdata)
+		return -ENOMEM;
+
+	if (of_property_read_u32(np, "rotary-encoder,steps", &tmp) == 0)
+		pdata->steps = tmp;
+	if (of_property_read_u32(np, "linux,axis", &tmp) == 0)
+		pdata->axis = tmp;
+
+	pdata->gpio_a = of_get_gpio_flags(np, 0, &flags);
+	pdata->inverted_a = flags & OF_GPIO_ACTIVE_LOW;
+
+	pdata->gpio_b = of_get_gpio_flags(np, 1, &flags);
+	pdata->inverted_b = flags & OF_GPIO_ACTIVE_LOW;
+
+	if (of_get_property(np, "rotary-encoder,relative-axis", NULL))
+		pdata->relative_axis = 1;
+	if (of_get_property(np, "rotary-encoder,rollover", NULL))
+		pdata->rollover = 1;
+	if (of_get_property(np, "rotary-encoder,half-period", NULL))
+		pdata->half_period = 1;
+
+	pdev->dev.platform_data = pdata;
+
+	return 0;
+}
+#else
+static inline int rotary_encoder_probe_dt(struct platform_device *)
+{
+	return 0;
+}
+#endif
+
 static int __devinit rotary_encoder_probe(struct platform_device *pdev)
 {
-	struct rotary_encoder_platform_data *pdata = pdev->dev.platform_data;
+	struct rotary_encoder_platform_data *pdata;
 	struct rotary_encoder *encoder;
 	struct input_dev *input;
 	irq_handler_t handler;
 	int err;
 
+	err = rotary_encoder_probe_dt(pdev);
+	if (err)
+		return err;
+
+	pdata = pdev->dev.platform_data;
+
 	if (!pdata) {
 		dev_err(&pdev->dev, "missing platform data\n");
 		return -ENOENT;
@@ -282,6 +342,7 @@ static struct platform_driver rotary_encoder_driver = {
 	.driver		= {
 		.name	= DRV_NAME,
 		.owner	= THIS_MODULE,
+		.of_match_table = of_match_ptr(rotary_encoder_of_match),
 	}
 };
 module_platform_driver(rotary_encoder_driver);
-- 
1.7.10.4

[PATCH 2/2] input: rotary-encoder: defer calls gpio_to_irq()

[Daniel Mack]

Don't call gpio_to_irq() on GPIOs before gpio_request() succeeded on
them. This avoids Ooopses with incorrect DT bindings.

Signed-off-by: Daniel Mack <zonque@gmail.com>
---
 drivers/input/misc/rotary_encoder.c |    5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
index 350cbd1..474b04f 100644
--- a/drivers/input/misc/rotary_encoder.c
+++ b/drivers/input/misc/rotary_encoder.c
@@ -223,8 +223,6 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
 
 	encoder->input = input;
 	encoder->pdata = pdata;
-	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
-	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
 
 	/* create and register the input driver */
 	input->name = pdev->name;
@@ -275,6 +273,9 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
 		goto exit_free_gpio_a;
 	}
 
+	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
+	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
+
 	/* request the IRQs */
 	if (pdata->half_period) {
 		handler = &rotary_encoder_half_period_irq;
-- 
1.7.10.4

RE: [PATCH 2/2] input: rotary-encoder: defer calls gpio_to_irq()

[H Hartley Sweeten]

On Tuesday, July 24, 2012 10:38 AM, Daniel Mack wrote:
> Don't call gpio_to_irq() on GPIOs before gpio_request() succeeded on
> them. This avoids Ooopses with incorrect DT bindings.
>
> Signed-off-by: Daniel Mack <zonque@gmail.com>
> ---
>  drivers/input/misc/rotary_encoder.c |    5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
> index 350cbd1..474b04f 100644
> --- a/drivers/input/misc/rotary_encoder.c
> +++ b/drivers/input/misc/rotary_encoder.c
> @@ -223,8 +223,6 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
>  
>  	encoder->input = input;
>  	encoder->pdata = pdata;
> -	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
> -	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
>  
>  	/* create and register the input driver */
>  	input->name = pdev->name;
> @@ -275,6 +273,9 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
>  		goto exit_free_gpio_a;
>  	}
>  
> +	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
> +	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
> +
>  	/* request the IRQs */
>  	if (pdata->half_period) {
>  		handler = &rotary_encoder_half_period_irq;

Daniel,

You might want to put this patch first before adding the DT binding
stuff.

You also might consider using gpio_request_one() or even the
devm_* version, instead of doing the gpio_request() followed
by the  gpio_direction_input().

Actually, if you convert the probe to use the managed resource
devm_* stuff it would really cleanup the error path and the remove.

Regardless...

Reviewed-by: H Hartley Sweeten <hsweeten@visionengravers.com>

Re: [PATCH 2/2] input: rotary-encoder: defer calls gpio_to_irq()

[Daniel Mack]

On 24.07.2012 21:45, H Hartley Sweeten wrote:
> On Tuesday, July 24, 2012 10:38 AM, Daniel Mack wrote:
>> Don't call gpio_to_irq() on GPIOs before gpio_request() succeeded on
>> them. This avoids Ooopses with incorrect DT bindings.
>>
>> Signed-off-by: Daniel Mack <zonque@gmail.com>
>> ---
>>  drivers/input/misc/rotary_encoder.c |    5 +++--
>>  1 file changed, 3 insertions(+), 2 deletions(-)
>>
>> diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
>> index 350cbd1..474b04f 100644
>> --- a/drivers/input/misc/rotary_encoder.c
>> +++ b/drivers/input/misc/rotary_encoder.c
>> @@ -223,8 +223,6 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
>>  
>>  	encoder->input = input;
>>  	encoder->pdata = pdata;
>> -	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
>> -	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
>>  
>>  	/* create and register the input driver */
>>  	input->name = pdev->name;
>> @@ -275,6 +273,9 @@ static int __devinit rotary_encoder_probe(struct platform_device *pdev)
>>  		goto exit_free_gpio_a;
>>  	}
>>  
>> +	encoder->irq_a = gpio_to_irq(pdata->gpio_a);
>> +	encoder->irq_b = gpio_to_irq(pdata->gpio_b);
>> +
>>  	/* request the IRQs */
>>  	if (pdata->half_period) {
>>  		handler = &rotary_encoder_half_period_irq;
> 
> Daniel,
> 
> You might want to put this patch first before adding the DT binding
> stuff.
> 
> You also might consider using gpio_request_one() or even the
> devm_* version, instead of doing the gpio_request() followed
> by the  gpio_direction_input().
> 
> Actually, if you convert the probe to use the managed resource
> devm_* stuff it would really cleanup the error path and the remove.

Yes, you're right. Thanks for the hint. New version coming up. Does your
Reviewed-by: still apply?


Daniel

RE: [PATCH 2/2] input: rotary-encoder: defer calls gpio_to_irq()

[H Hartley Sweeten]

On Wednesday, July 25, 2012 12:43 AM, Daniel Mack wrote:
> On 24.07.2012 21:45, H Hartley Sweeten wrote:
>> You might want to put this patch first before adding the DT binding
>> stuff.
>> 
>> You also might consider using gpio_request_one() or even the
>> devm_* version, instead of doing the gpio_request() followed
>> by the  gpio_direction_input().
>> 
>> Actually, if you convert the probe to use the managed resource
>> devm_* stuff it would really cleanup the error path and the remove.
>
> Yes, you're right. Thanks for the hint. New version coming up. Does your
> Reviewed-by: still apply?

As pointed out by Dmitry, the devm_* stuff will not work with this driver.

Please update the patch to just use the gpio_request_one() and I'll
review it again.

Sorry about that.

Hartley