2020-07-19 22:12:51

by Artur Rojek

[permalink] [raw]
Subject: [PATCH v8 0/2] input: ADC joystick driver & DT bindings

Hi all,

this series is a continuation of adc-joystick changes split from:
https://lore.kernel.org/linux-iio/[email protected]/

Rob, the bindings example in patch 1/2 depends on changes introduced
in another patchset, still to be merged:
https://lore.kernel.org/linux-iio/[email protected]/
Your scripts will most likely fail to validate this. You have already
reviewed this patch when it was still part of the aforementioned series.

Cheers,
Artur

Artur Rojek (2):
dt-bindings: input: Add docs for ADC driven joystick.
input: joystick: Add ADC attached joystick driver.

.../bindings/input/adc-joystick.yaml | 121 +++++++++
drivers/input/joystick/Kconfig | 10 +
drivers/input/joystick/Makefile | 1 +
drivers/input/joystick/adc-joystick.c | 253 ++++++++++++++++++
4 files changed, 385 insertions(+)
create mode 100644 Documentation/devicetree/bindings/input/adc-joystick.yaml
create mode 100644 drivers/input/joystick/adc-joystick.c

--
2.27.0


2020-07-19 22:13:37

by Artur Rojek

[permalink] [raw]
Subject: [PATCH v8 2/2] input: joystick: Add ADC attached joystick driver.

Add a driver for joystick devices connected to ADC controllers
supporting the Industrial I/O subsystem.

Signed-off-by: Artur Rojek <[email protected]>
Tested-by: Paul Cercueil <[email protected]>
Tested-by: Heiko Stuebner <[email protected]>
Acked-by: Dmitry Torokhov <[email protected]>
---

Changes:

v2: - sanity check supported channel format on probe,
- rename adc_joystick_disable to a more sensible adc_joystick_cleanup,
- enforce correct axis order by checking the `reg` property of
child nodes

v3-v5: no change

v6: - remove redundant `<linux/of.h>`
- set `val` for each endianness case in their respective branches
- pass received error codes to return value of `adc_joystick_set_axes`
- change `(bits >> 3) > 2` to `bits > 16` for readability
- drop `of_match_ptr`

v7: no change

v8: - respect scan index when reading channel data,
- solve sparse warnings related to *_to_cpu calls,
- simplify channel count logic,
- drop the redundant comma from adc_joystick_of_match[]

drivers/input/joystick/Kconfig | 10 +
drivers/input/joystick/Makefile | 1 +
drivers/input/joystick/adc-joystick.c | 253 ++++++++++++++++++++++++++
3 files changed, 264 insertions(+)
create mode 100644 drivers/input/joystick/adc-joystick.c

diff --git a/drivers/input/joystick/Kconfig b/drivers/input/joystick/Kconfig
index eb031b7a4866..b080f0cfb068 100644
--- a/drivers/input/joystick/Kconfig
+++ b/drivers/input/joystick/Kconfig
@@ -42,6 +42,16 @@ config JOYSTICK_A3D
To compile this driver as a module, choose M here: the
module will be called a3d.

+config JOYSTICK_ADC
+ tristate "Simple joystick connected over ADC"
+ depends on IIO
+ select IIO_BUFFER_CB
+ help
+ Say Y here if you have a simple joystick connected over ADC.
+
+ To compile this driver as a module, choose M here: the
+ module will be called adc-joystick.
+
config JOYSTICK_ADI
tristate "Logitech ADI digital joysticks and gamepads"
select GAMEPORT
diff --git a/drivers/input/joystick/Makefile b/drivers/input/joystick/Makefile
index 8656023f6ef5..58232b3057d3 100644
--- a/drivers/input/joystick/Makefile
+++ b/drivers/input/joystick/Makefile
@@ -6,6 +6,7 @@
# Each configuration option enables a list of files.

obj-$(CONFIG_JOYSTICK_A3D) += a3d.o
+obj-$(CONFIG_JOYSTICK_ADC) += adc-joystick.o
obj-$(CONFIG_JOYSTICK_ADI) += adi.o
obj-$(CONFIG_JOYSTICK_AMIGA) += amijoy.o
obj-$(CONFIG_JOYSTICK_AS5011) += as5011.o
diff --git a/drivers/input/joystick/adc-joystick.c b/drivers/input/joystick/adc-joystick.c
new file mode 100644
index 000000000000..a2c570de0b8a
--- /dev/null
+++ b/drivers/input/joystick/adc-joystick.c
@@ -0,0 +1,253 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Input driver for joysticks connected over ADC.
+ * Copyright (c) 2019-2020 Artur Rojek <[email protected]>
+ */
+#include <linux/ctype.h>
+#include <linux/input.h>
+#include <linux/iio/iio.h>
+#include <linux/iio/consumer.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/property.h>
+
+struct adc_joystick_axis {
+ u32 code;
+ s32 range[2];
+ s32 fuzz;
+ s32 flat;
+};
+
+struct adc_joystick {
+ struct input_dev *input;
+ struct iio_cb_buffer *buffer;
+ struct adc_joystick_axis *axes;
+ struct iio_channel *chans;
+ int num_chans;
+};
+
+static int adc_joystick_handle(const void *data, void *private)
+{
+ struct adc_joystick *joy = private;
+ enum iio_endian endianness;
+ int bytes, msb, val, idx, i;
+ bool sign;
+
+ bytes = joy->chans[0].channel->scan_type.storagebits >> 3;
+
+ for (i = 0; i < joy->num_chans; ++i) {
+ idx = joy->chans[i].channel->scan_index;
+ endianness = joy->chans[i].channel->scan_type.endianness;
+ msb = joy->chans[i].channel->scan_type.realbits - 1;
+ sign = (tolower(joy->chans[i].channel->scan_type.sign) == 's');
+
+ switch (bytes) {
+ case 1:
+ val = ((const u8 *)data)[idx];
+ break;
+ case 2:
+ if (endianness == IIO_BE)
+ val = be16_to_cpu(((const __be16 *)data)[idx]);
+ else if (endianness == IIO_LE)
+ val = le16_to_cpu(((const __le16 *)data)[idx]);
+ else /* IIO_CPU */
+ val = ((const u16 *)data)[idx];
+ break;
+ default:
+ return -EINVAL;
+ }
+
+ val >>= joy->chans[i].channel->scan_type.shift;
+ if (sign)
+ val = sign_extend32(val, msb);
+ else
+ val &= GENMASK(msb, 0);
+ input_report_abs(joy->input, joy->axes[i].code, val);
+ }
+
+ input_sync(joy->input);
+
+ return 0;
+}
+
+static int adc_joystick_open(struct input_dev *dev)
+{
+ struct adc_joystick *joy = input_get_drvdata(dev);
+ int ret;
+
+ ret = iio_channel_start_all_cb(joy->buffer);
+ if (ret)
+ dev_err(dev->dev.parent, "Unable to start callback buffer");
+
+ return ret;
+}
+
+static void adc_joystick_close(struct input_dev *dev)
+{
+ struct adc_joystick *joy = input_get_drvdata(dev);
+
+ iio_channel_stop_all_cb(joy->buffer);
+}
+
+static void adc_joystick_cleanup(void *data)
+{
+ iio_channel_release_all_cb(data);
+}
+
+static int adc_joystick_set_axes(struct device *dev, struct adc_joystick *joy)
+{
+ struct adc_joystick_axis *axes;
+ struct fwnode_handle *child;
+ int num_axes, ret, i;
+
+ num_axes = device_get_child_node_count(dev);
+ if (!num_axes) {
+ dev_err(dev, "Unable to find child nodes");
+ return -EINVAL;
+ }
+
+ if (num_axes != joy->num_chans) {
+ dev_err(dev, "Got %d child nodes for %d channels",
+ num_axes, joy->num_chans);
+ return -EINVAL;
+ }
+
+ axes = devm_kmalloc_array(dev, num_axes, sizeof(*axes), GFP_KERNEL);
+ if (!axes)
+ return -ENOMEM;
+
+ device_for_each_child_node(dev, child) {
+ ret = fwnode_property_read_u32(child, "reg", &i);
+ if (ret) {
+ dev_err(dev, "reg invalid or missing");
+ goto err;
+ }
+
+ if (i >= num_axes) {
+ ret = -EINVAL;
+ dev_err(dev, "No matching axis for reg %d", i);
+ goto err;
+ }
+
+ ret = fwnode_property_read_u32(child, "linux,code",
+ &axes[i].code);
+ if (ret) {
+ dev_err(dev, "linux,code invalid or missing");
+ goto err;
+ }
+
+ ret = fwnode_property_read_u32_array(child, "abs-range",
+ axes[i].range, 2);
+ if (ret) {
+ dev_err(dev, "abs-range invalid or missing");
+ goto err;
+ }
+
+ fwnode_property_read_u32(child, "abs-fuzz",
+ &axes[i].fuzz);
+ fwnode_property_read_u32(child, "abs-flat",
+ &axes[i].flat);
+
+ input_set_abs_params(joy->input, axes[i].code,
+ axes[i].range[0], axes[i].range[1],
+ axes[i].fuzz,
+ axes[i].flat);
+ input_set_capability(joy->input, EV_ABS, axes[i].code);
+ }
+
+ joy->axes = axes;
+
+ return 0;
+
+err:
+ fwnode_handle_put(child);
+ return ret;
+}
+
+static int adc_joystick_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct adc_joystick *joy;
+ struct input_dev *input;
+ int bits, ret, i;
+
+ joy = devm_kzalloc(dev, sizeof(*joy), GFP_KERNEL);
+ if (!joy)
+ return -ENOMEM;
+
+ joy->chans = devm_iio_channel_get_all(dev);
+ if (IS_ERR(joy->chans)) {
+ ret = PTR_ERR(joy->chans);
+ if (ret != -EPROBE_DEFER)
+ dev_err(dev, "Unable to get IIO channels");
+ return ret;
+ }
+
+ /* Count how many channels we got. NULL terminated. */
+ for (i = 0; joy->chans[i].indio_dev; ++i) {
+ bits = joy->chans[i].channel->scan_type.storagebits;
+ if (!bits || (bits > 16)) {
+ dev_err(dev, "Unsupported channel storage size");
+ return -EINVAL;
+ }
+ if (bits != joy->chans[0].channel->scan_type.storagebits) {
+ dev_err(dev, "Channels must have equal storage size");
+ return -EINVAL;
+ }
+ }
+ joy->num_chans = i;
+
+ input = devm_input_allocate_device(dev);
+ if (!input) {
+ dev_err(dev, "Unable to allocate input device");
+ return -ENOMEM;
+ }
+
+ joy->input = input;
+ input->name = pdev->name;
+ input->id.bustype = BUS_HOST;
+ input->open = adc_joystick_open;
+ input->close = adc_joystick_close;
+
+ ret = adc_joystick_set_axes(dev, joy);
+ if (ret)
+ return ret;
+
+ input_set_drvdata(input, joy);
+ ret = input_register_device(input);
+ if (ret) {
+ dev_err(dev, "Unable to register input device: %d", ret);
+ return ret;
+ }
+
+ 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");
+ return PTR_ERR(joy->buffer);
+ }
+
+ ret = devm_add_action_or_reset(dev, adc_joystick_cleanup, joy->buffer);
+ if (ret)
+ dev_err(dev, "Unable to add action");
+
+ return ret;
+}
+
+static const struct of_device_id adc_joystick_of_match[] = {
+ { .compatible = "adc-joystick", },
+ { }
+};
+MODULE_DEVICE_TABLE(of, adc_joystick_of_match);
+
+static struct platform_driver adc_joystick_driver = {
+ .driver = {
+ .name = "adc-joystick",
+ .of_match_table = adc_joystick_of_match,
+ },
+ .probe = adc_joystick_probe,
+};
+module_platform_driver(adc_joystick_driver);
+
+MODULE_DESCRIPTION("Input driver for joysticks connected over ADC");
+MODULE_AUTHOR("Artur Rojek <[email protected]>");
+MODULE_LICENSE("GPL");
--
2.27.0

2020-07-19 22:14:56

by Artur Rojek

[permalink] [raw]
Subject: [PATCH v8 1/2] dt-bindings: input: Add docs for ADC driven joystick.

Add documentation for the adc-joystick driver, used to provide support
for joysticks connected over ADC.

Signed-off-by: Artur Rojek <[email protected]>
Tested-by: Paul Cercueil <[email protected]>
Reviewed-by: Rob Herring <[email protected]>
---

Changes:

v2: - Add `reg` property to axis subnode in order to enumerate the axes,
- rename `linux,abs-code` property to `linux,code`,
- drop `linux,` prefix from the remaining properties of axis subnode

v3: no change

v4: - remove "bindings" from the unique identifier string,
- replace `|` with `>` for all description properties,
- specify the number of items for `io-channels`,
- correct the regex pattern of `axis` property,
- specify the value range of `reg` property for each axis,
- put `abs-range` properties under `allOf`

v5: add `a-f` to the regex pattern of `axis` property

v6-v8: no change

Notes:

Rob, the bindings example in this patch depends on changes introduced
in another patchset, still to be merged:
https://lore.kernel.org/linux-iio/[email protected]/
Your scripts will most likely fail to validate this.

.../bindings/input/adc-joystick.yaml | 121 ++++++++++++++++++
1 file changed, 121 insertions(+)
create mode 100644 Documentation/devicetree/bindings/input/adc-joystick.yaml

diff --git a/Documentation/devicetree/bindings/input/adc-joystick.yaml b/Documentation/devicetree/bindings/input/adc-joystick.yaml
new file mode 100644
index 000000000000..054406bbd22b
--- /dev/null
+++ b/Documentation/devicetree/bindings/input/adc-joystick.yaml
@@ -0,0 +1,121 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2019-2020 Artur Rojek
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/input/adc-joystick.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: ADC attached joystick
+
+maintainers:
+ - Artur Rojek <[email protected]>
+
+description: >
+ Bindings for joystick devices connected to ADC controllers supporting
+ the Industrial I/O subsystem.
+
+properties:
+ compatible:
+ const: adc-joystick
+
+ io-channels:
+ minItems: 1
+ maxItems: 1024
+ description: >
+ List of phandle and IIO specifier pairs.
+ Each pair defines one ADC channel to which a joystick axis is connected.
+ See Documentation/devicetree/bindings/iio/iio-bindings.txt for details.
+
+ '#address-cells':
+ const: 1
+
+ '#size-cells':
+ const: 0
+
+required:
+ - compatible
+ - io-channels
+ - '#address-cells'
+ - '#size-cells'
+
+additionalProperties: false
+
+patternProperties:
+ "^axis@[0-9a-f]+$":
+ type: object
+ description: >
+ Represents a joystick axis bound to the given ADC channel.
+ For each entry in the io-channels list, one axis subnode with a matching
+ reg property must be specified.
+
+ properties:
+ reg:
+ minimum: 0
+ maximum: 1023
+ description: Index of an io-channels list entry bound to this axis.
+
+ linux,code:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: EV_ABS specific event code generated by the axis.
+
+ abs-range:
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32-array
+ - items:
+ - description: minimum value
+ - description: maximum value
+ description: >
+ Minimum and maximum values produced by the axis.
+ For an ABS_X axis this will be the left-most and right-most
+ inclination of the joystick. If min > max, it is left to userspace to
+ treat the axis as inverted.
+ This property is interpreted as two signed 32 bit values.
+
+ abs-fuzz:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: >
+ Amount of noise in the input value.
+ Omitting this property indicates the axis is precise.
+
+ abs-flat:
+ $ref: /schemas/types.yaml#/definitions/uint32
+ description: >
+ Axial "deadzone", or area around the center position, where the axis
+ is considered to be at rest.
+ Omitting this property indicates the axis always returns to exactly
+ the center position.
+
+ required:
+ - reg
+ - linux,code
+ - abs-range
+
+ additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/iio/adc/ingenic,adc.h>
+ #include <dt-bindings/input/input.h>
+
+ joystick: adc-joystick {
+ compatible = "adc-joystick";
+ io-channels = <&adc INGENIC_ADC_TOUCH_XP>,
+ <&adc INGENIC_ADC_TOUCH_YP>;
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ axis@0 {
+ reg = <0>;
+ linux,code = <ABS_X>;
+ abs-range = <3300 0>;
+ abs-fuzz = <4>;
+ abs-flat = <200>;
+ };
+ axis@1 {
+ reg = <1>;
+ linux,code = <ABS_Y>;
+ abs-range = <0 3300>;
+ abs-fuzz = <4>;
+ abs-flat = <200>;
+ };
+ };
--
2.27.0

2020-07-20 09:57:57

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH v8 0/2] input: ADC joystick driver & DT bindings

On Mon, 20 Jul 2020 00:11:01 +0200
Artur Rojek <[email protected]> wrote:

> Hi all,
>
> this series is a continuation of adc-joystick changes split from:
> https://lore.kernel.org/linux-iio/[email protected]/
>
> Rob, the bindings example in patch 1/2 depends on changes introduced
> in another patchset, still to be merged:
> https://lore.kernel.org/linux-iio/[email protected]/
> Your scripts will most likely fail to validate this. You have already
> reviewed this patch when it was still part of the aforementioned series.

I've just taken v9 of the dependency into iio.git as an immutable branch based on 5.8

https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git ib-5.8-jz47xx-ts

Thanks,

Jonathan

>
> Cheers,
> Artur
>
> Artur Rojek (2):
> dt-bindings: input: Add docs for ADC driven joystick.
> input: joystick: Add ADC attached joystick driver.
>
> .../bindings/input/adc-joystick.yaml | 121 +++++++++
> drivers/input/joystick/Kconfig | 10 +
> drivers/input/joystick/Makefile | 1 +
> drivers/input/joystick/adc-joystick.c | 253 ++++++++++++++++++
> 4 files changed, 385 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/adc-joystick.yaml
> create mode 100644 drivers/input/joystick/adc-joystick.c
>

2020-07-20 10:07:20

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH v8 2/2] input: joystick: Add ADC attached joystick driver.

On Mon, 20 Jul 2020 00:11:03 +0200
Artur Rojek <[email protected]> wrote:

> Add a driver for joystick devices connected to ADC controllers
> supporting the Industrial I/O subsystem.
>
> Signed-off-by: Artur Rojek <[email protected]>
> Tested-by: Paul Cercueil <[email protected]>
> Tested-by: Heiko Stuebner <[email protected]>
> Acked-by: Dmitry Torokhov <[email protected]>

Looks good to me.

Acked-by: Jonathan Cameron <[email protected]>

I'm assuming this will got through input.

Jonathan

> ---
>
> Changes:
>
> v2: - sanity check supported channel format on probe,
> - rename adc_joystick_disable to a more sensible adc_joystick_cleanup,
> - enforce correct axis order by checking the `reg` property of
> child nodes
>
> v3-v5: no change
>
> v6: - remove redundant `<linux/of.h>`
> - set `val` for each endianness case in their respective branches
> - pass received error codes to return value of `adc_joystick_set_axes`
> - change `(bits >> 3) > 2` to `bits > 16` for readability
> - drop `of_match_ptr`
>
> v7: no change
>
> v8: - respect scan index when reading channel data,
> - solve sparse warnings related to *_to_cpu calls,
> - simplify channel count logic,
> - drop the redundant comma from adc_joystick_of_match[]
>
> drivers/input/joystick/Kconfig | 10 +
> drivers/input/joystick/Makefile | 1 +
> drivers/input/joystick/adc-joystick.c | 253 ++++++++++++++++++++++++++
> 3 files changed, 264 insertions(+)
> create mode 100644 drivers/input/joystick/adc-joystick.c
>
> diff --git a/drivers/input/joystick/Kconfig b/drivers/input/joystick/Kconfig
> index eb031b7a4866..b080f0cfb068 100644
> --- a/drivers/input/joystick/Kconfig
> +++ b/drivers/input/joystick/Kconfig
> @@ -42,6 +42,16 @@ config JOYSTICK_A3D
> To compile this driver as a module, choose M here: the
> module will be called a3d.
>
> +config JOYSTICK_ADC
> + tristate "Simple joystick connected over ADC"
> + depends on IIO
> + select IIO_BUFFER_CB
> + help
> + Say Y here if you have a simple joystick connected over ADC.
> +
> + To compile this driver as a module, choose M here: the
> + module will be called adc-joystick.
> +
> config JOYSTICK_ADI
> tristate "Logitech ADI digital joysticks and gamepads"
> select GAMEPORT
> diff --git a/drivers/input/joystick/Makefile b/drivers/input/joystick/Makefile
> index 8656023f6ef5..58232b3057d3 100644
> --- a/drivers/input/joystick/Makefile
> +++ b/drivers/input/joystick/Makefile
> @@ -6,6 +6,7 @@
> # Each configuration option enables a list of files.
>
> obj-$(CONFIG_JOYSTICK_A3D) += a3d.o
> +obj-$(CONFIG_JOYSTICK_ADC) += adc-joystick.o
> obj-$(CONFIG_JOYSTICK_ADI) += adi.o
> obj-$(CONFIG_JOYSTICK_AMIGA) += amijoy.o
> obj-$(CONFIG_JOYSTICK_AS5011) += as5011.o
> diff --git a/drivers/input/joystick/adc-joystick.c b/drivers/input/joystick/adc-joystick.c
> new file mode 100644
> index 000000000000..a2c570de0b8a
> --- /dev/null
> +++ b/drivers/input/joystick/adc-joystick.c
> @@ -0,0 +1,253 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Input driver for joysticks connected over ADC.
> + * Copyright (c) 2019-2020 Artur Rojek <[email protected]>
> + */
> +#include <linux/ctype.h>
> +#include <linux/input.h>
> +#include <linux/iio/iio.h>
> +#include <linux/iio/consumer.h>
> +#include <linux/module.h>
> +#include <linux/platform_device.h>
> +#include <linux/property.h>
> +
> +struct adc_joystick_axis {
> + u32 code;
> + s32 range[2];
> + s32 fuzz;
> + s32 flat;
> +};
> +
> +struct adc_joystick {
> + struct input_dev *input;
> + struct iio_cb_buffer *buffer;
> + struct adc_joystick_axis *axes;
> + struct iio_channel *chans;
> + int num_chans;
> +};
> +
> +static int adc_joystick_handle(const void *data, void *private)
> +{
> + struct adc_joystick *joy = private;
> + enum iio_endian endianness;
> + int bytes, msb, val, idx, i;
> + bool sign;
> +
> + bytes = joy->chans[0].channel->scan_type.storagebits >> 3;
> +
> + for (i = 0; i < joy->num_chans; ++i) {
> + idx = joy->chans[i].channel->scan_index;
> + endianness = joy->chans[i].channel->scan_type.endianness;
> + msb = joy->chans[i].channel->scan_type.realbits - 1;
> + sign = (tolower(joy->chans[i].channel->scan_type.sign) == 's');
> +
> + switch (bytes) {
> + case 1:
> + val = ((const u8 *)data)[idx];
> + break;
> + case 2:
> + if (endianness == IIO_BE)
> + val = be16_to_cpu(((const __be16 *)data)[idx]);
> + else if (endianness == IIO_LE)
> + val = le16_to_cpu(((const __le16 *)data)[idx]);
> + else /* IIO_CPU */
> + val = ((const u16 *)data)[idx];
> + break;
> + default:
> + return -EINVAL;
> + }
> +
> + val >>= joy->chans[i].channel->scan_type.shift;
> + if (sign)
> + val = sign_extend32(val, msb);
> + else
> + val &= GENMASK(msb, 0);
> + input_report_abs(joy->input, joy->axes[i].code, val);
> + }
> +
> + input_sync(joy->input);
> +
> + return 0;
> +}
> +
> +static int adc_joystick_open(struct input_dev *dev)
> +{
> + struct adc_joystick *joy = input_get_drvdata(dev);
> + int ret;
> +
> + ret = iio_channel_start_all_cb(joy->buffer);
> + if (ret)
> + dev_err(dev->dev.parent, "Unable to start callback buffer");
> +
> + return ret;
> +}
> +
> +static void adc_joystick_close(struct input_dev *dev)
> +{
> + struct adc_joystick *joy = input_get_drvdata(dev);
> +
> + iio_channel_stop_all_cb(joy->buffer);
> +}
> +
> +static void adc_joystick_cleanup(void *data)
> +{
> + iio_channel_release_all_cb(data);
> +}
> +
> +static int adc_joystick_set_axes(struct device *dev, struct adc_joystick *joy)
> +{
> + struct adc_joystick_axis *axes;
> + struct fwnode_handle *child;
> + int num_axes, ret, i;
> +
> + num_axes = device_get_child_node_count(dev);
> + if (!num_axes) {
> + dev_err(dev, "Unable to find child nodes");
> + return -EINVAL;
> + }
> +
> + if (num_axes != joy->num_chans) {
> + dev_err(dev, "Got %d child nodes for %d channels",
> + num_axes, joy->num_chans);
> + return -EINVAL;
> + }
> +
> + axes = devm_kmalloc_array(dev, num_axes, sizeof(*axes), GFP_KERNEL);
> + if (!axes)
> + return -ENOMEM;
> +
> + device_for_each_child_node(dev, child) {
> + ret = fwnode_property_read_u32(child, "reg", &i);
> + if (ret) {
> + dev_err(dev, "reg invalid or missing");
> + goto err;
> + }
> +
> + if (i >= num_axes) {
> + ret = -EINVAL;
> + dev_err(dev, "No matching axis for reg %d", i);
> + goto err;
> + }
> +
> + ret = fwnode_property_read_u32(child, "linux,code",
> + &axes[i].code);
> + if (ret) {
> + dev_err(dev, "linux,code invalid or missing");
> + goto err;
> + }
> +
> + ret = fwnode_property_read_u32_array(child, "abs-range",
> + axes[i].range, 2);
> + if (ret) {
> + dev_err(dev, "abs-range invalid or missing");
> + goto err;
> + }
> +
> + fwnode_property_read_u32(child, "abs-fuzz",
> + &axes[i].fuzz);
> + fwnode_property_read_u32(child, "abs-flat",
> + &axes[i].flat);
> +
> + input_set_abs_params(joy->input, axes[i].code,
> + axes[i].range[0], axes[i].range[1],
> + axes[i].fuzz,
> + axes[i].flat);
> + input_set_capability(joy->input, EV_ABS, axes[i].code);
> + }
> +
> + joy->axes = axes;
> +
> + return 0;
> +
> +err:
> + fwnode_handle_put(child);
> + return ret;
> +}
> +
> +static int adc_joystick_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct adc_joystick *joy;
> + struct input_dev *input;
> + int bits, ret, i;
> +
> + joy = devm_kzalloc(dev, sizeof(*joy), GFP_KERNEL);
> + if (!joy)
> + return -ENOMEM;
> +
> + joy->chans = devm_iio_channel_get_all(dev);
> + if (IS_ERR(joy->chans)) {
> + ret = PTR_ERR(joy->chans);
> + if (ret != -EPROBE_DEFER)
> + dev_err(dev, "Unable to get IIO channels");
> + return ret;
> + }
> +
> + /* Count how many channels we got. NULL terminated. */
> + for (i = 0; joy->chans[i].indio_dev; ++i) {
> + bits = joy->chans[i].channel->scan_type.storagebits;
> + if (!bits || (bits > 16)) {
> + dev_err(dev, "Unsupported channel storage size");
> + return -EINVAL;
> + }
> + if (bits != joy->chans[0].channel->scan_type.storagebits) {
> + dev_err(dev, "Channels must have equal storage size");
> + return -EINVAL;
> + }
> + }
> + joy->num_chans = i;
> +
> + input = devm_input_allocate_device(dev);
> + if (!input) {
> + dev_err(dev, "Unable to allocate input device");
> + return -ENOMEM;
> + }
> +
> + joy->input = input;
> + input->name = pdev->name;
> + input->id.bustype = BUS_HOST;
> + input->open = adc_joystick_open;
> + input->close = adc_joystick_close;
> +
> + ret = adc_joystick_set_axes(dev, joy);
> + if (ret)
> + return ret;
> +
> + input_set_drvdata(input, joy);
> + ret = input_register_device(input);
> + if (ret) {
> + dev_err(dev, "Unable to register input device: %d", ret);
> + return ret;
> + }
> +
> + 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");
> + return PTR_ERR(joy->buffer);
> + }
> +
> + ret = devm_add_action_or_reset(dev, adc_joystick_cleanup, joy->buffer);
> + if (ret)
> + dev_err(dev, "Unable to add action");
> +
> + return ret;
> +}
> +
> +static const struct of_device_id adc_joystick_of_match[] = {
> + { .compatible = "adc-joystick", },
> + { }
> +};
> +MODULE_DEVICE_TABLE(of, adc_joystick_of_match);
> +
> +static struct platform_driver adc_joystick_driver = {
> + .driver = {
> + .name = "adc-joystick",
> + .of_match_table = adc_joystick_of_match,
> + },
> + .probe = adc_joystick_probe,
> +};
> +module_platform_driver(adc_joystick_driver);
> +
> +MODULE_DESCRIPTION("Input driver for joysticks connected over ADC");
> +MODULE_AUTHOR("Artur Rojek <[email protected]>");
> +MODULE_LICENSE("GPL");

2020-07-20 16:35:00

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH v8 1/2] dt-bindings: input: Add docs for ADC driven joystick.

On Mon, 20 Jul 2020 00:11:02 +0200, Artur Rojek wrote:
> Add documentation for the adc-joystick driver, used to provide support
> for joysticks connected over ADC.
>
> Signed-off-by: Artur Rojek <[email protected]>
> Tested-by: Paul Cercueil <[email protected]>
> Reviewed-by: Rob Herring <[email protected]>
> ---
>
> Changes:
>
> v2: - Add `reg` property to axis subnode in order to enumerate the axes,
> - rename `linux,abs-code` property to `linux,code`,
> - drop `linux,` prefix from the remaining properties of axis subnode
>
> v3: no change
>
> v4: - remove "bindings" from the unique identifier string,
> - replace `|` with `>` for all description properties,
> - specify the number of items for `io-channels`,
> - correct the regex pattern of `axis` property,
> - specify the value range of `reg` property for each axis,
> - put `abs-range` properties under `allOf`
>
> v5: add `a-f` to the regex pattern of `axis` property
>
> v6-v8: no change
>
> Notes:
>
> Rob, the bindings example in this patch depends on changes introduced
> in another patchset, still to be merged:
> https://lore.kernel.org/linux-iio/[email protected]/
> Your scripts will most likely fail to validate this.
>
> .../bindings/input/adc-joystick.yaml | 121 ++++++++++++++++++
> 1 file changed, 121 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/input/adc-joystick.yaml
>


My bot found errors running 'make dt_binding_check' on your patch:

Error: Documentation/devicetree/bindings/input/adc-joystick.example.dts:24.31-32 syntax error
FATAL ERROR: Unable to parse input tree
scripts/Makefile.lib:315: recipe for target 'Documentation/devicetree/bindings/input/adc-joystick.example.dt.yaml' failed
make[1]: *** [Documentation/devicetree/bindings/input/adc-joystick.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
Makefile:1347: recipe for target 'dt_binding_check' failed
make: *** [dt_binding_check] Error 2


See https://patchwork.ozlabs.org/patch/1331964

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.