[PATCH 0/2] input: rotary-encoder: Support key events

[PATCH 0/2] input: rotary-encoder: Support key events

[Donghoon Han]

This patchset supports generating EV_KEY, instead of EV_REL.

An example could be a volume knob, with key events:
 - KEY_VOLUMEDOWN / KEY_VOLUMEUP

[tested on imx6q platform,  full period, half period]

Donghoon Han (2):
    Input: rotary_encoder - Support key events
    Input: rotaty-encoder - Add DT binding document

 Documentation/devicetree/bindings/input/rotary-encoder.txt | 12 ++++++++++++
 drivers/input/misc/rotary_encoder.c                        | 23 +++++++++++++++++++++--
 2 files changed, 33 insertions(+), 2 deletions(-)

[PATCH 1/2] Input: rotary_encoder - Support key events

[Donghoon Han]

From: Steven Han <nazgul33@gmail.com>

Support generating EV_KEY pair, instead of EV_REL.

Signed-off-by: Donghoon Han <nazgul33@gmail.com>
---
 drivers/input/misc/rotary_encoder.c | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
index 72eee6d55527..180e35884289 100644
--- a/drivers/input/misc/rotary_encoder.c
+++ b/drivers/input/misc/rotary_encoder.c
@@ -41,6 +41,8 @@ struct rotary_encoder {
 	u32 steps;
 	u32 axis;
 	bool relative_axis;
+	bool relative_keys;
+	u32 keycodes[2];
 	bool rollover;
 	enum rotary_encoder_encoding encoding;
 
@@ -79,6 +81,10 @@ static void rotary_encoder_report_event(struct rotary_encoder *encoder)
 	if (encoder->relative_axis) {
 		input_report_rel(encoder->input,
 				 encoder->axis, encoder->dir);
+	} else if (encoder->relative_keys) {
+		u32 keycode = encoder->keycodes[encoder->dir > 0];
+		input_event(encoder->input, EV_KEY, keycode, 1);
+		input_event(encoder->input, EV_KEY, keycode, 0);
 	} else {
 		unsigned int pos = encoder->pos;
 
@@ -237,6 +243,16 @@ static int rotary_encoder_probe(struct platform_device *pdev)
 	device_property_read_u32(dev, "linux,axis", &encoder->axis);
 	encoder->relative_axis =
 		device_property_read_bool(dev, "rotary-encoder,relative-axis");
+	encoder->relative_keys =
+		device_property_read_bool(dev, "rotary-encoder,relative-keys");
+	if (encoder->relative_keys) {
+		err = device_property_read_u32_array(dev,
+					"rotary-encoder,relative-keycodes",
+					encoder->keycodes, 2);
+		if (err)
+			dev_err(dev, "unable to get keycodes: %d\n", err);
+		return err;
+	}
 
 	encoder->gpios = devm_gpiod_get_array(dev, NULL, GPIOD_IN);
 	if (IS_ERR(encoder->gpios)) {
@@ -260,9 +276,12 @@ static int rotary_encoder_probe(struct platform_device *pdev)
 	input->id.bustype = BUS_HOST;
 	input->dev.parent = dev;
 
-	if (encoder->relative_axis)
+	if (encoder->relative_axis) {
 		input_set_capability(input, EV_REL, encoder->axis);
-	else
+	} else if (encoder->relative_keys) {
+		input_set_capability(input, EV_KEY, encoder->keycodes[0]);
+		input_set_capability(input, EV_KEY, encoder->keycodes[1]);
+	} else
 		input_set_abs_params(input,
 				     encoder->axis, 0, encoder->steps, 0, 1);
 
-- 
2.17.1

[PATCH 2/2] Input: rotaty-encoder - Add DT binding document

[Donghoon Han]

Add DT binding document for rotary-encoder, keycode options.

Signed-off-by: Donghoon Han <nazgul33@gmail.com>
---
 .../devicetree/bindings/input/rotary-encoder.txt     | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
index f99fe5cdeaec..113640079de3 100644
--- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
+++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
@@ -12,6 +12,10 @@ Optional properties:
 - 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,relative-keys : generate pair of key events. This setting
+  behaves just like relative-axis, generating key events. keycode[2]
+  corresponds -1/1 events.
+- rotary-encoder,relative-keycodes : keycodes for relative-keys
 - rotary-encoder,rollover: Automatic rollover when the rotary value becomes
   greater than the specified steps or smaller than 0. For absolute axis only.
 - rotary-encoder,steps-per-period: Number of steps (stable states) per period.
@@ -48,3 +52,11 @@ Example:
 			rotary-encoder,encoding = "binary";
 			rotary-encoder,rollover;
 		};
+
+		rotary@2 {
+			compatible = "rotary-encoder";
+			gpios = <&gpio 21 0>, <&gpio 22 0>;
+			rotary-encoder,relative-keys;
+			rotary-encoder,relative-keycode = <103>, <108>;
+			rotary-encoder,steps-per-period = <2>;
+		};
-- 
2.17.1

Re: [PATCH 2/2] Input: rotaty-encoder - Add DT binding document

[Dmitry Torokhov]

On Sat, Jan 5, 2019 at 2:27 PM Donghoon Han <nazgul33@gmail.com> wrote:
>
> Add DT binding document for rotary-encoder, keycode options.
>
> Signed-off-by: Donghoon Han <nazgul33@gmail.com>
> ---
>  .../devicetree/bindings/input/rotary-encoder.txt     | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> index f99fe5cdeaec..113640079de3 100644
> --- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
> +++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> @@ -12,6 +12,10 @@ Optional properties:
>  - 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,relative-keys : generate pair of key events. This setting
> +  behaves just like relative-axis, generating key events. keycode[2]
> +  corresponds -1/1 events.
> +- rotary-encoder,relative-keycodes : keycodes for relative-keys
>  - rotary-encoder,rollover: Automatic rollover when the rotary value becomes
>    greater than the specified steps or smaller than 0. For absolute axis only.
>  - rotary-encoder,steps-per-period: Number of steps (stable states) per period.
> @@ -48,3 +52,11 @@ Example:
>                         rotary-encoder,encoding = "binary";
>                         rotary-encoder,rollover;
>                 };
> +
> +               rotary@2 {
> +                       compatible = "rotary-encoder";
> +                       gpios = <&gpio 21 0>, <&gpio 22 0>;
> +                       rotary-encoder,relative-keys;
> +                       rotary-encoder,relative-keycode = <103>, <108>;
> +                       rotary-encoder,steps-per-period = <2>;

Do you need steps for keys? They weren't required for the relative axis mode.

Thanks.

-- 
Dmitry

Re: [PATCH 1/2] Input: rotary_encoder - Support key events

[Dmitry Torokhov]

On Sat, Jan 5, 2019 at 2:27 PM Donghoon Han <nazgul33@gmail.com> wrote:
>
> From: Steven Han <nazgul33@gmail.com>
>
> Support generating EV_KEY pair, instead of EV_REL.
>
> Signed-off-by: Donghoon Han <nazgul33@gmail.com>
> ---
>  drivers/input/misc/rotary_encoder.c | 23 +++++++++++++++++++++--
>  1 file changed, 21 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
> index 72eee6d55527..180e35884289 100644
> --- a/drivers/input/misc/rotary_encoder.c
> +++ b/drivers/input/misc/rotary_encoder.c
> @@ -41,6 +41,8 @@ struct rotary_encoder {
>         u32 steps;
>         u32 axis;
>         bool relative_axis;
> +       bool relative_keys;
> +       u32 keycodes[2];
>         bool rollover;
>         enum rotary_encoder_encoding encoding;
>
> @@ -79,6 +81,10 @@ static void rotary_encoder_report_event(struct rotary_encoder *encoder)
>         if (encoder->relative_axis) {
>                 input_report_rel(encoder->input,
>                                  encoder->axis, encoder->dir);
> +       } else if (encoder->relative_keys) {
> +               u32 keycode = encoder->keycodes[encoder->dir > 0];
> +               input_event(encoder->input, EV_KEY, keycode, 1);

You need input_sync() here.

> +               input_event(encoder->input, EV_KEY, keycode, 0);
>         } else {
>                 unsigned int pos = encoder->pos;
>
> @@ -237,6 +243,16 @@ static int rotary_encoder_probe(struct platform_device *pdev)
>         device_property_read_u32(dev, "linux,axis", &encoder->axis);
>         encoder->relative_axis =
>                 device_property_read_bool(dev, "rotary-encoder,relative-axis");
> +       encoder->relative_keys =
> +               device_property_read_bool(dev, "rotary-encoder,relative-keys");
> +       if (encoder->relative_keys) {
> +               err = device_property_read_u32_array(dev,
> +                                       "rotary-encoder,relative-keycodes",
> +                                       encoder->keycodes, 2);
> +               if (err)
> +                       dev_err(dev, "unable to get keycodes: %d\n", err);
> +               return err;
> +       }
>
>         encoder->gpios = devm_gpiod_get_array(dev, NULL, GPIOD_IN);
>         if (IS_ERR(encoder->gpios)) {
> @@ -260,9 +276,12 @@ static int rotary_encoder_probe(struct platform_device *pdev)
>         input->id.bustype = BUS_HOST;
>         input->dev.parent = dev;
>
> -       if (encoder->relative_axis)
> +       if (encoder->relative_axis) {
>                 input_set_capability(input, EV_REL, encoder->axis);
> -       else
> +       } else if (encoder->relative_keys) {
> +               input_set_capability(input, EV_KEY, encoder->keycodes[0]);
> +               input_set_capability(input, EV_KEY, encoder->keycodes[1]);
> +       } else
>                 input_set_abs_params(input,
>                                      encoder->axis, 0, encoder->steps, 0, 1);
>
> --
> 2.17.1
>

Thanks.

-- 
Dmitry

Re: [PATCH 1/2] Input: rotary_encoder - Support key events

[nazgul33]

input_sync() is there, at the end of the function.

static void rotary_encoder_report_event(struct rotary_encoder *encoder)
{
    if (encoder->relative_axis) {
        input_report_rel(encoder->input,
            encoder->axis, encoder->dir);
    } else if (encoder->relative_keys) {
        u32 keycode = encoder->keycodes[encoder->dir > 0];
        input_event(encoder->input, EV_KEY, keycode, 1);
        input_event(encoder->input, EV_KEY, keycode, 0);
    } else {
        unsigned int pos = encoder->pos;

        if (encoder->dir < 0) {
            /* turning counter-clockwise */
            if (encoder->rollover)
            pos += encoder->steps;
            if (pos)
                pos--;
            } else {
               /* turning clockwise */
               if (encoder->rollover || pos < encoder->steps)
                      pos++;
           }

           if (encoder->rollover)
               pos %= encoder->steps;

           encoder->pos = pos;
           input_report_abs(encoder->input, encoder->axis, encoder->pos);
        }

        input_sync(encoder->input);
}

On Sun, Jan 6, 2019 at 8:12 AM Dmitry Torokhov
<dmitry.torokhov@gmail.com> wrote:
>
> On Sat, Jan 5, 2019 at 2:27 PM Donghoon Han <nazgul33@gmail.com> wrote:
> >
> > From: Steven Han <nazgul33@gmail.com>
> >
> > Support generating EV_KEY pair, instead of EV_REL.
> >
> > Signed-off-by: Donghoon Han <nazgul33@gmail.com>
> > ---
> >  drivers/input/misc/rotary_encoder.c | 23 +++++++++++++++++++++--
> >  1 file changed, 21 insertions(+), 2 deletions(-)
> >
> > diff --git a/drivers/input/misc/rotary_encoder.c b/drivers/input/misc/rotary_encoder.c
> > index 72eee6d55527..180e35884289 100644
> > --- a/drivers/input/misc/rotary_encoder.c
> > +++ b/drivers/input/misc/rotary_encoder.c
> > @@ -41,6 +41,8 @@ struct rotary_encoder {
> >         u32 steps;
> >         u32 axis;
> >         bool relative_axis;
> > +       bool relative_keys;
> > +       u32 keycodes[2];
> >         bool rollover;
> >         enum rotary_encoder_encoding encoding;
> >
> > @@ -79,6 +81,10 @@ static void rotary_encoder_report_event(struct rotary_encoder *encoder)
> >         if (encoder->relative_axis) {
> >                 input_report_rel(encoder->input,
> >                                  encoder->axis, encoder->dir);
> > +       } else if (encoder->relative_keys) {
> > +               u32 keycode = encoder->keycodes[encoder->dir > 0];
> > +               input_event(encoder->input, EV_KEY, keycode, 1);
>
> You need input_sync() here.
>
> > +               input_event(encoder->input, EV_KEY, keycode, 0);
> >         } else {
> >                 unsigned int pos = encoder->pos;
> >
> > @@ -237,6 +243,16 @@ static int rotary_encoder_probe(struct platform_device *pdev)
> >         device_property_read_u32(dev, "linux,axis", &encoder->axis);
> >         encoder->relative_axis =
> >                 device_property_read_bool(dev, "rotary-encoder,relative-axis");
> > +       encoder->relative_keys =
> > +               device_property_read_bool(dev, "rotary-encoder,relative-keys");
> > +       if (encoder->relative_keys) {
> > +               err = device_property_read_u32_array(dev,
> > +                                       "rotary-encoder,relative-keycodes",
> > +                                       encoder->keycodes, 2);
> > +               if (err)
> > +                       dev_err(dev, "unable to get keycodes: %d\n", err);
> > +               return err;
> > +       }
> >
> >         encoder->gpios = devm_gpiod_get_array(dev, NULL, GPIOD_IN);
> >         if (IS_ERR(encoder->gpios)) {
> > @@ -260,9 +276,12 @@ static int rotary_encoder_probe(struct platform_device *pdev)
> >         input->id.bustype = BUS_HOST;
> >         input->dev.parent = dev;
> >
> > -       if (encoder->relative_axis)
> > +       if (encoder->relative_axis) {
> >                 input_set_capability(input, EV_REL, encoder->axis);
> > -       else
> > +       } else if (encoder->relative_keys) {
> > +               input_set_capability(input, EV_KEY, encoder->keycodes[0]);
> > +               input_set_capability(input, EV_KEY, encoder->keycodes[1]);
> > +       } else
> >                 input_set_abs_params(input,
> >                                      encoder->axis, 0, encoder->steps, 0, 1);
> >
> > --
> > 2.17.1
> >
>
> Thanks.
>
> --
> Dmitry



-- 
한동훈 드림.

Re: [PATCH 2/2] Input: rotaty-encoder - Add DT binding document

[nazgul33]

Yes, it's needed.
Even with the same encoder, adjusting steps affects rate of event generation.
(the steps defines 1 cycle of encoder rotation, and 1 cycle = 1 key event.)

On Sun, Jan 6, 2019 at 8:11 AM Dmitry Torokhov
<dmitry.torokhov@gmail.com> wrote:
>
> On Sat, Jan 5, 2019 at 2:27 PM Donghoon Han <nazgul33@gmail.com> wrote:
> >
> > Add DT binding document for rotary-encoder, keycode options.
> >
> > Signed-off-by: Donghoon Han <nazgul33@gmail.com>
> > ---
> >  .../devicetree/bindings/input/rotary-encoder.txt     | 12 ++++++++++++
> >  1 file changed, 12 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/input/rotary-encoder.txt b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > index f99fe5cdeaec..113640079de3 100644
> > --- a/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > +++ b/Documentation/devicetree/bindings/input/rotary-encoder.txt
> > @@ -12,6 +12,10 @@ Optional properties:
> >  - 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,relative-keys : generate pair of key events. This setting
> > +  behaves just like relative-axis, generating key events. keycode[2]
> > +  corresponds -1/1 events.
> > +- rotary-encoder,relative-keycodes : keycodes for relative-keys
> >  - rotary-encoder,rollover: Automatic rollover when the rotary value becomes
> >    greater than the specified steps or smaller than 0. For absolute axis only.
> >  - rotary-encoder,steps-per-period: Number of steps (stable states) per period.
> > @@ -48,3 +52,11 @@ Example:
> >                         rotary-encoder,encoding = "binary";
> >                         rotary-encoder,rollover;
> >                 };
> > +
> > +               rotary@2 {
> > +                       compatible = "rotary-encoder";
> > +                       gpios = <&gpio 21 0>, <&gpio 22 0>;
> > +                       rotary-encoder,relative-keys;
> > +                       rotary-encoder,relative-keycode = <103>, <108>;
> > +                       rotary-encoder,steps-per-period = <2>;
>
> Do you need steps for keys? They weren't required for the relative axis mode.
>
> Thanks.
>
> --
> Dmitry



-- 
한동훈 드림.

Re: [PATCH 1/2] Input: rotary_encoder - Support key events

[Dmitry Torokhov]

On Sat, Jan 5, 2019 at 9:36 PM nazgul33 <nazgul33@gmail.com> wrote:
>
> input_sync() is there, at the end of the function.

I know. Nonetheless, you need another one between sending distinct key
events. Userspace is allowed to accumulate device state until
EV_SYN/SYN_REPORT is received, which can result in your key events
being a noop.

Thanks.

-- 
Dmitry