Skip to contentSkip to conversation

adc-joystick: Add polled support

PATCH Superseded Chris Morgan 5 participants 10 messages Jun 27, 2022 – Jun 30, 2022

Subsystems (5)

v4 of 13 Superseded Latest is v13 →

lore
Share & tools
lore
#0 lore raw

v4 cover adc-joystick: Add polled support

Add support to the existing adc-joystick driver to support polling rather than relying on triggered buffers. This is useful for devices that do not offer triggered buffers in hardware. Code adapted from changes made by Maya Matuszczyk <[email protected]>.

Changes from V3:
- After lengthy discussion decided to support with existing attribute of "poll-interval". If present, the driver will use polling and if not present, it will use triggered buffers (as the driver does today).
- Corrected some lines to honor the 80 character line-limit.
- Check return value from polling method and return early if there is an error reading the data.

Changes from V2:
- Changed parameter from "adc-joystick,polled" to "adc-joystick,no-hardware-trigger" as it is more representative of what the driver and hardware are doing.

Changes from V1:
- Removed driver compatible string of "adc-joystick-polled".
- Added new optional boolean value of "adc-joystick,polled".
- Cleaned up if statements regarding polling behavior.

Chris Morgan (3):
dt-bindings: adc-joystick: add poll-interval
Input: adc-joystick - Add polled input device support
arm64: dts: rockchip: Update joystick to polled for Odroid-Go2

 .../bindings/input/adc-joystick.yaml          |  6 +++
 .../boot/dts/rockchip/rk3326-odroid-go2.dts   |  1 +
 drivers/input/joystick/adc-joystick.c         | 49 ++++++++++++++-----
 3 files changed, 45 insertions(+), 11 deletions(-)
Signature · 1 line
2.34.1
#1 lore raw

PATCH v4 1/3 dt-bindings: adc-joystick: add poll-interval

Add poll-interval support for the adc-joystick documentation. This is an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided, the adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/input/adc-joystick.yaml +6 -0
index 2ee04e03bc22..2d755091e46d 100644
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified, device will use
+      triggered buffer.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
   io-channels:
     minItems: 1
     maxItems: 1024
Signature · 1 line
2.34.1
#2 lore raw

Re: [PATCH v4 1/3] dt-bindings: adc-joystick: add poll-interval

Hi Chris,

Quoted 22 lines · Chris Morgan

Add poll-interval support for the adc-joystick documentation. This is an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided, the adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -0
index 2ee04e03bc22..2d755091e46d 100644
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified, device 
Quoted 2 lines

will use
+ triggered buffer.

It doesn't have to use *triggered* buffer - it can use regular buffer as well.

The property should use a unit suffix, as explained here:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml

So it should be named poll-interval-ms.

Cheers,
-Paul

Quoted 8 lines
Documentation/devicetree/bindings/input/adc-joystick.yaml +2 -1
+    $ref: /schemas/types.yaml#/definitions/uint32
+
   io-channels:
     minItems: 1
     maxItems: 1024
--

2.34.1

#3 lore raw

Re: [PATCH v4 1/3] dt-bindings: adc-joystick: add poll-interval

Quoted 33 lines · Paul Cercueil

Hi Chris,

Quoted 23 lines · Chris Morgan

Add poll-interval support for the adc-joystick documentation. This is an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided, the adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -0
index 2ee04e03bc22..2d755091e46d 100644
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified, device will
Quoted 2 lines

use
+ triggered buffer.

It doesn't have to use *triggered* buffer - it can use regular buffer as well.

Quoted 7 lines

The property should use a unit suffix, as explained here:
https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdevicetree-org%2Fdt-schema%2Fblob%2Fmain%2Fdtschema%2Fschemas%2Fproperty-units.yaml&amp;data=05%7C01%7C%7Cf6306210eda84b58f7f408da588d1627%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637919660856597552%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=NVqhWKdycQsv0ksiILD8aH%2BnZ6aji%2BhNxSEwBkQlZC0%3D&amp;reserved=0

So it should be named poll-interval-ms.

Cheers,
-Paul

Understood, though the logic here was to be consistent with existing implementations (such as adc-keys and gpio-keys-polled) which all use poll-interval (no ms). Honest question, would it be better to be right (poll-interval-ms) or consistent (poll-interval) in this case?

Thank you.

Quoted 11 lines
Quoted 9 lines
Documentation/devicetree/bindings/input/adc-joystick.yaml +2 -1
+    $ref: /schemas/types.yaml#/definitions/uint32
+
   io-channels:
     minItems: 1
     maxItems: 1024
--

2.34.1

#4 lore raw

Re: [PATCH v4 1/3] dt-bindings: adc-joystick: add poll-interval

Quoted 46 lines · Chris Morgan
Quoted 45 lines · Paul Cercueil

Hi Chris,

Quoted 1 line · Chris Morgan

Add poll-interval support for the adc-joystick documentation.

This is

Quoted 2 lines

an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided,

the

Quoted 6 lines

adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6 

++++++

Review

Quoted 3 lines
 1 file changed, 6 insertions(+)
(quoted diff) +0 -0

a/Documentation/devicetree/bindings/input/adc-joystick.yaml

Documentation/devicetree/bindings/input/adc-joystick.yaml properties: · line 23

Quoted 11 lines

b/Documentation/devicetree/bindings/input/adc-joystick.yaml index 2ee04e03bc22..2d755091e46d 100644

Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -0
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified, 

device will

Quoted 2 lines

use
+ triggered buffer.

It doesn't have to use *triggered* buffer - it can use regular
buffer as
well.

The property should use a unit suffix, as explained here:

https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdevicetree-org%2Fdt-schema%2Fblob%2Fmain%2Fdtschema%2Fschemas%2Fproperty-units.yaml&data=05%7C01%7C%7Cf6306210eda84b58f7f408da588d1627%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637919660856597552%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=NVqhWKdycQsv0ksiILD8aH%2BnZ6aji%2BhNxSEwBkQlZC0%3D&reserved=0

So it should be named poll-interval-ms.

Quoted 7 lines
Quoted 2 lines

Cheers,
-Paul

Understood, though the logic here was to be consistent with existing implementations (such as adc-keys and gpio-keys-polled) which all use poll-interval (no ms). Honest question, would it be better to be right (poll-interval-ms) or consistent (poll-interval) in this case?

I guess those don't have a suffix for legacy reasons, and newly introduced properties should follow the standard.

But I guess that's a question for DT maintainers.

Cheers,
-Paul

Quoted 14 lines

Thank you.

Quoted 11 lines
Quoted 9 lines
Documentation/devicetree/bindings/input/adc-joystick.yaml +2 -1
+    $ref: /schemas/types.yaml#/definitions/uint32
+
   io-channels:
     minItems: 1
     maxItems: 1024
--

2.34.1

#5 lore raw

Re: [PATCH v4 1/3] dt-bindings: adc-joystick: add poll-interval

Quoted 59 lines · Paul Cercueil
Quoted 46 lines · Chris Morgan
Quoted 45 lines · Paul Cercueil

Hi Chris,

Quoted 1 line · Chris Morgan

Add poll-interval support for the adc-joystick documentation.

This is

Quoted 2 lines

an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided,

the

Quoted 6 lines

adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6

++++++

Quoted 3 lines
 1 file changed, 6 insertions(+)

diff --git

a/Documentation/devicetree/bindings/input/adc-joystick.yaml

Documentation/devicetree/bindings/input/adc-joystick.yaml properties: · line 23

Quoted 11 lines

b/Documentation/devicetree/bindings/input/adc-joystick.yaml index 2ee04e03bc22..2d755091e46d 100644

Documentation/devicetree/bindings/input/adc-joystick.yaml +3 -0
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified,

device will

Quoted 2 lines

use
+ triggered buffer.

It doesn't have to use *triggered* buffer - it can use regular
buffer as
well.

The property should use a unit suffix, as explained here:

https://nam12.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fdevicetree-org%2Fdt-schema%2Fblob%2Fmain%2Fdtschema%2Fschemas%2Fproperty-units.yaml&data=05%7C01%7C%7Cf6306210eda84b58f7f408da588d1627%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637919660856597552%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=NVqhWKdycQsv0ksiILD8aH%2BnZ6aji%2BhNxSEwBkQlZC0%3D&reserved=0

So it should be named poll-interval-ms.

Quoted 7 lines
Quoted 2 lines

Cheers,
-Paul

Understood, though the logic here was to be consistent with existing implementations (such as adc-keys and gpio-keys-polled) which all use poll-interval (no ms). Honest question, would it be better to be right (poll-interval-ms) or consistent (poll-interval) in this case?

Quoted 4 lines

I guess those don't have a suffix for legacy reasons, and newly introduced properties should follow the standard.

But I guess that's a question for DT maintainers.

It should be consistent with the rest of the input bindings.

Rob

#6 lore raw

Re: [PATCH v4 1/3] dt-bindings: adc-joystick: add poll-interval

In reply to Chris Morgan
Quoted 17 lines · Chris Morgan

Add poll-interval support for the adc-joystick documentation. This is an optional value and if not provided the adc-joystick works as it does today (with triggered buffers). If this value is provided, the adc-joystick driver is polled at the specified interval.

---
 Documentation/devicetree/bindings/input/adc-joystick.yaml | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/devicetree/bindings/input/adc-joystick.yaml +0 -0
index 2ee04e03bc22..2d755091e46d 100644

Documentation/devicetree/bindings/input/adc-joystick.yaml properties: · line 25

Quoted 8 lines
Documentation/devicetree/bindings/input/adc-joystick.yaml +5 -0
@@ -18,6 +18,12 @@ properties:
   compatible:
     const: adc-joystick
 
+  poll-interval:
+    description:
+      Poll interval time in milliseconds. If not specified, device will use
+      triggered buffer.
+    $ref: /schemas/types.yaml#/definitions/uint32

Already defined in input.yaml, so add a $ref to it and here you just need 'poll-interval: true'.

Rob

#7 lore raw

PATCH v4 2/3 Input: adc-joystick - Add polled input device support

In reply to Chris Morgan

Add polled input device support to the adc-joystick driver. This is useful for devices which do not have hardware capable triggers on their SARADC. Code modified from adc-joystick.c changes made by Maya Matuszczyk.

---
 drivers/input/joystick/adc-joystick.c | 49 +++++++++++++++++++++------
 1 file changed, 38 insertions(+), 11 deletions(-)
drivers/input/joystick/adc-joystick.c +38 -11
index 78ebca7d400a..7e3c5083ec3c 100644
@@ -26,8 +26,23 @@ struct adc_joystick {
 	struct adc_joystick_axis *axes;
 	struct iio_channel *chans;
 	int num_chans;
+	bool polled;
 };
 
+static void adc_joystick_poll(struct input_dev *input)
+{
+	struct adc_joystick *joy = input_get_drvdata(input);
+	int i, val, ret;
+
+	for (i = 0; i < joy->num_chans; i++) {
+		ret = iio_read_channel_raw(&joy->chans[i], &val);
+		if (ret < 0)
+			return;
+		input_report_abs(input, joy->axes[i].code, val);
+	}
+	input_sync(input);
+}
+
 static int adc_joystick_handle(const void *data, void *private)
 {
 	struct adc_joystick *joy = private;
@@ -179,6 +194,7 @@ static int adc_joystick_probe(struct platform_device *pdev)
 	int error;
 	int bits;
 	int i;
+	int value;
 
 	joy = devm_kzalloc(dev, sizeof(*joy), GFP_KERNEL);
 	if (!joy)
@@ -215,8 +231,15 @@ static int adc_joystick_probe(struct platform_device *pdev)
 	joy->input = input;
 	input->name = pdev->name;
 	input->id.bustype = BUS_HOST;
-	input->open = adc_joystick_open;
-	input->close = adc_joystick_close;
+
+	if (!device_property_read_u32(dev, "poll-interval", &value)) {
+		joy->polled = 1;
+		input_setup_polling(input, adc_joystick_poll);
+		input_set_poll_interval(input, value);
+	} else {
+		input->open = adc_joystick_open;
+		input->close = adc_joystick_close;
+	}
 
 	error = adc_joystick_set_axes(dev, joy);
 	if (error)
@@ -229,16 +252,20 @@ static int adc_joystick_probe(struct platform_device *pdev)
 		return error;
 	}
 
-	joy->buffer = iio_channel_get_all_cb(dev, adc_joystick_handle, joy);
-	if (IS_ERR(joy->buffer)) {
-		dev_err(dev, "Unable to allocate callback buffer\n");
-		return PTR_ERR(joy->buffer);
-	}
+	if (!joy->polled) {
+		joy->buffer = iio_channel_get_all_cb(dev, adc_joystick_handle,
+						     joy);
+		if (IS_ERR(joy->buffer)) {
+			dev_err(dev, "Unable to allocate callback buffer\n");
+			return PTR_ERR(joy->buffer);
+		}
 
-	error = devm_add_action_or_reset(dev, adc_joystick_cleanup, joy->buffer);
-	if (error)  {
-		dev_err(dev, "Unable to add action\n");
-		return error;
+		error = devm_add_action_or_reset(dev, adc_joystick_cleanup,
+						 joy->buffer);
+		if (error)  {
+			dev_err(dev, "Unable to add action\n");
+			return error;
+		}
 	}
 
 	return 0;
Signature · 1 line
2.34.1
#8 lore raw

Re: [PATCH v4 2/3] Input: adc-joystick - Add polled input device support

Quoted 8 lines · Chris Morgan

Add polled input device support to the adc-joystick driver. This is useful for devices which do not have hardware capable triggers on their SARADC. Code modified from adc-joystick.c changes made by Maya Matuszczyk.

---

Hey Chris,

comments inline.

Quoted 33 lines
 drivers/input/joystick/adc-joystick.c | 49 +++++++++++++++++++++------
 1 file changed, 38 insertions(+), 11 deletions(-)
drivers/input/joystick/adc-joystick.c +15 -0
index 78ebca7d400a..7e3c5083ec3c 100644
@@ -26,8 +26,23 @@ struct adc_joystick {
 	struct adc_joystick_axis *axes;
 	struct iio_channel *chans;
 	int num_chans;
+	bool polled;
 };
 
+static void adc_joystick_poll(struct input_dev *input)
+{
+	struct adc_joystick *joy = input_get_drvdata(input);
+	int i, val, ret;
+
+	for (i = 0; i < joy->num_chans; i++) {
+		ret = iio_read_channel_raw(&joy->chans[i], &val);
+		if (ret < 0)
+			return;
+		input_report_abs(input, joy->axes[i].code, val);
+	}
+	input_sync(input);
+}
+
 static int adc_joystick_handle(const void *data, void *private)
 {
 	struct adc_joystick *joy = private;

drivers/input/joystick/adc-joystick.c static int adc_joystick_probe(struct · line 198

Quoted 5 lines
drivers/input/joystick/adc-joystick.c +1 -0
@@ -179,6 +194,7 @@ static int adc_joystick_probe(struct 
 platform_device *pdev)
 	int error;
 	int bits;
 	int i;
+	int value;

This name is not self-describing. How about poll_interval instead?

Quoted 9 lines
drivers/input/joystick/adc-joystick.c +0 -1
 	joy = devm_kzalloc(dev, sizeof(*joy), GFP_KERNEL);
 	if (!joy)
@@ -215,8 +231,15 @@ static int adc_joystick_probe(struct 
 platform_device *pdev)
 	joy->input = input;
 	input->name = pdev->name;
 	input->id.bustype = BUS_HOST;
-	input->open = adc_joystick_open;

drivers/input/joystick/adc-joystick.c static int adc_joystick_probe(struct · line 243

Quoted 10 lines
drivers/input/joystick/adc-joystick.c +9 -1
-	input->close = adc_joystick_close;
+
+	if (!device_property_read_u32(dev, "poll-interval", &value)) {
+		joy->polled = 1;
+		input_setup_polling(input, adc_joystick_poll);
+		input_set_poll_interval(input, value);
+	} else {
+		input->open = adc_joystick_open;
+		input->close = adc_joystick_close;
+	}

Let's move the polling setup logic for after you establish the value of joy->polled:

```
	joy->polled = !device_property_read_u32(dev, "poll-interval",
						&poll_interval);
	if (joy->polled) {
		input_setup_polling(input, adc_joystick_poll);
		input_set_poll_interval(input, poll_interval);
	} else {
		input->open = adc_joystick_open;
		input->close = adc_joystick_close;
	}
```

This makes the intention more clear and is consistent with the if (!joy->polled) check later on.

Cheers,
Artur

Quoted 35 lines
drivers/input/joystick/adc-joystick.c +13 -9
 	error = adc_joystick_set_axes(dev, joy);
 	if (error)
@@ -229,16 +252,20 @@ static int adc_joystick_probe(struct
 platform_device *pdev)
 		return error;
 	}
 
-	joy->buffer = iio_channel_get_all_cb(dev, adc_joystick_handle, joy);
-	if (IS_ERR(joy->buffer)) {
-		dev_err(dev, "Unable to allocate callback buffer\n");
-		return PTR_ERR(joy->buffer);
-	}
+	if (!joy->polled) {
+		joy->buffer = iio_channel_get_all_cb(dev, adc_joystick_handle,
+						     joy);
+		if (IS_ERR(joy->buffer)) {
+			dev_err(dev, "Unable to allocate callback buffer\n");
+			return PTR_ERR(joy->buffer);
+		}
 
-	error = devm_add_action_or_reset(dev, adc_joystick_cleanup, 
 joy->buffer);
-	if (error)  {
-		dev_err(dev, "Unable to add action\n");
-		return error;
+		error = devm_add_action_or_reset(dev, adc_joystick_cleanup,
+						 joy->buffer);
+		if (error)  {
+			dev_err(dev, "Unable to add action\n");
+			return error;
+		}
 	}

return 0;

#9 lore raw

PATCH v4 3/3 arm64: dts: rockchip: Update joystick to polled for Odroid-Go2

In reply to Chris Morgan

Update the Odroid Go Advance to use "poll-interval" from the adc-joystick driver.

---
 arch/arm64/boot/dts/rockchip/rk3326-odroid-go2.dts | 1 +
 1 file changed, 1 insertion(+)
arch/arm64/boot/dts/rockchip/rk3326-odroid-go2.dts +1 -0
index ea0695b51ecd..61583c3f24e6 100644
@@ -26,6 +26,7 @@ adc-joystick {
 		compatible = "adc-joystick";
 		io-channels = <&saradc 1>,
 			      <&saradc 2>;
+		poll-interval = <60>;
 		#address-cells = <1>;
 		#size-cells = <0>;
 
Signature · 1 line
2.34.1