Skip to contentSkip to conversation

Add support for Imagis touchscreens

PATCH Superseded Markuss Broks 4 participants 11 messages Feb 10, 2022 – Feb 15, 2022

Subsystems (4)

v2 of 10 Superseded Latest is v10 →

lore
Share & tools
lore

Markuss Broks

author maintainer
#0 lore raw

v2 cover Add support for Imagis touchscreens

Add support for Imagis touchscreens, used on various mobile devices such as Samsung Galaxy J5 (2015), J3 (2015), J5 (2016).

v2: rebase on top of the correct tree

Markuss Broks (2):
dt-bindings: input/touchscreen: bindings for Imagis
Input: add Imagis touchscreen driver

 .../input/touchscreen/imagis,ist3038c.yaml    |  78 +++++
 .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
 MAINTAINERS                                   |   6 +
 drivers/input/touchscreen/Kconfig             |  10 +
 drivers/input/touchscreen/Makefile            |   1 +
 drivers/input/touchscreen/imagis.c            | 329 ++++++++++++++++++
 6 files changed, 426 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
 create mode 100644 drivers/input/touchscreen/imagis.c
Signature · 1 line
2.35.0
author maintainer
#1 lore raw

PATCH v2 1/2 dt-bindings: input/touchscreen: bindings for Imagis

This patch adds device-tree bindings for the Imagis IST3038C touch screen IC.

---
 .../input/touchscreen/imagis,ist3038c.yaml    | 78 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 2 files changed, 80 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +78 -0
new file mode 100644
index 000000000000..da1630eb957b
@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/imagis,ist3038c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Imagis IST30XXC family touchscreen controller bindings
+
+maintainers:
+  - Markuss Broks <[email protected]>
+
+allOf:
+  - $ref: touchscreen.yaml#
+
+properties:
+  $nodename:
+    pattern: "^touchscreen(@.*)?$"
+
+  compatible:
+    items:
+      - enum:
+          - imagis,ist3038c
+
+  reg:
+    description: I2C address
+
+  interrupts:
+    maxItems: 1
+
+  vdd-supply:
+    description: Power supply regulator for the chip
+
+  vddio-supply:
+    description: Power supply regulator for the I2C bus
+
+  touchscreen-size-x: true
+  touchscreen-size-y: true
+  touchscreen-fuzz-x: true
+  touchscreen-fuzz-y: true
+  touchscreen-fuzz-pressure: true
+  touchscreen-inverted-x: true
+  touchscreen-inverted-y: true
+  touchscreen-swapped-x-y: true
+  touchscreen-max-pressure: true
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - touchscreen-size-x
+  - touchscreen-size-y
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      touchscreen@48 {
+        compatible = "imagis,ist3038c";
+        reg = <0x50>;
+        interrupt-parent = <&gpio>;
+        interrupts = <13 IRQ_TYPE_EDGE_FALLING>;
+        vdd-supply = <&ldo1_reg>;
+        vddio-supply = <&ldo2_reg>;
+        touchscreen-size-x = <720>;
+        touchscreen-size-y = <1280>;
+        touchscreen-fuzz-x = <10>;
+        touchscreen-fuzz-y = <10>;
+        touchscreen-fuzz-pressure = <10>;
+        touchscreen-inverted-x;
+        touchscreen-inverted-y;
+      };
+    };
+
+...
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index cdc851e275f1..9357cdc5aef5 100644
@@ -551,6 +551,8 @@ patternProperties:
     description: Ingenieurburo Fur Ic-Technologie (I/F/I)
   "^ilitek,.*":
     description: ILI Technology Corporation (ILITEK)
+  "^imagis,.*":
+    description: Imagis Technologies Co., Ltd.
   "^img,.*":
     description: Imagination Technologies Ltd.
   "^imi,.*":
Signature · 1 line
2.35.0
maintainer
#2 lore raw

Re: [PATCH v2 1/2] dt-bindings: input/touchscreen: bindings for Imagis

Quoted 10 lines · Markuss Broks

This patch adds device-tree bindings for the Imagis IST3038C touch screen IC.

---
 .../input/touchscreen/imagis,ist3038c.yaml    | 78 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 2 files changed, 80 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.example.dts:23.26-37.13: Warning (i2c_bus_reg): /example-0/i2c/touchscreen@48: I2C bus unit address format error, expected "50"

doc reference errors (make refcheckdocs):

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

This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.

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

pip3 install dtschema --upgrade

Please check and re-submit.

author maintainer
#3 lore raw

v3 cover Add support for Imagis touchscreens

Add support for Imagis touchscreens, used on various mobile devices such as Samsung Galaxy J5 (2015), J3 (2015), J5 (2016).

v2: rebase on top of the correct tree
v3:
- prefix all defines as IST3038C
- use two tabs for all defines
- add missing <linux/regulator/consumer.h> header
- drop ADDR_LEN and DATA_LEN defines; use sizeof(reg_be) instead
- use __be32 type for reg_be
- add a comment about i2c read not being successful on first try
- use "ret" instead of "res" in read_reg function
- don't use the internal __cpu_to_be32 function, use cpu_to_be32 instead
- use "error" instead of "ret" in interrupt handler
- pass the slot state directly, without ternary operator
- drop the dev_err in init_input_dev function
- reorder the functions in _probe so that the chipid command is read as fast as possible
- don't use imagis_start in probe
- initialize the irq after the chip is powered
- save the return value in imagis_resume
- drop WIDTH_MAJOR since only TOUCH_MAJOR is reported
- the "chip detected" message is now dev_dbg
- reorder headers so they are in alphabetic order
- use GENMASK to generate masks for getting the X and Y coordinates and touch area
- drop *_pressure from device tree bindings since the driver doesn't support reporting pressure
- fix the typo with i2c address in device treee bindings (48 instead of 50)
- add IRQF_NO_AUTOEN flag to avoid unbalanced irq enable

Markuss Broks (2):
dt-bindings: input/touchscreen: bindings for Imagis
Input: add Imagis touchscreen driver

 .../input/touchscreen/imagis,ist3038c.yaml    |  78 +++++
 .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
 MAINTAINERS                                   |   6 +
 drivers/input/touchscreen/Kconfig             |  10 +
 drivers/input/touchscreen/Makefile            |   1 +
 drivers/input/touchscreen/imagis.c            | 329 ++++++++++++++++++
 6 files changed, 426 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
 create mode 100644 drivers/input/touchscreen/imagis.c
Signature · 1 line
2.35.0
author maintainer
#4 lore raw

PATCH v3 1/2 dt-bindings: input/touchscreen: bindings for Imagis

This patch adds device-tree bindings for the Imagis IST3038C touch screen IC.

---
 .../input/touchscreen/imagis,ist3038c.yaml    | 75 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 2 files changed, 77 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +75 -0
new file mode 100644
index 000000000000..7b127817e1f6
@@ -0,0 +1,75 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/imagis,ist3038c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Imagis IST30XXC family touchscreen controller bindings
+
+maintainers:
+  - Markuss Broks <[email protected]>
+
+allOf:
+  - $ref: touchscreen.yaml#
+
+properties:
+  $nodename:
+    pattern: "^touchscreen(@.*)?$"
+
+  compatible:
+    items:
+      - enum:
+          - imagis,ist3038c
+
+  reg:
+    description: I2C address
+
+  interrupts:
+    maxItems: 1
+
+  vdd-supply:
+    description: Power supply regulator for the chip
+
+  vddio-supply:
+    description: Power supply regulator for the I2C bus
+
+  touchscreen-size-x: true
+  touchscreen-size-y: true
+  touchscreen-fuzz-x: true
+  touchscreen-fuzz-y: true
+  touchscreen-inverted-x: true
+  touchscreen-inverted-y: true
+  touchscreen-swapped-x-y: true
+
+additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - touchscreen-size-x
+  - touchscreen-size-y
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      touchscreen@50 {
+        compatible = "imagis,ist3038c";
+        reg = <0x50>;
+        interrupt-parent = <&gpio>;
+        interrupts = <13 IRQ_TYPE_EDGE_FALLING>;
+        vdd-supply = <&ldo1_reg>;
+        vddio-supply = <&ldo2_reg>;
+        touchscreen-size-x = <720>;
+        touchscreen-size-y = <1280>;
+        touchscreen-fuzz-x = <10>;
+        touchscreen-fuzz-y = <10>;
+        touchscreen-inverted-x;
+        touchscreen-inverted-y;
+      };
+    };
+
+...
Documentation/devicetree/bindings/vendor-prefixes.yaml +2 -0
index cdc851e275f1..9357cdc5aef5 100644
@@ -551,6 +551,8 @@ patternProperties:
     description: Ingenieurburo Fur Ic-Technologie (I/F/I)
   "^ilitek,.*":
     description: ILI Technology Corporation (ILITEK)
+  "^imagis,.*":
+    description: Imagis Technologies Co., Ltd.
   "^img,.*":
     description: Imagination Technologies Ltd.
   "^imi,.*":
Signature · 1 line
2.35.0
#5 lore raw

Re: [PATCH v3 1/2] dt-bindings: input/touchscreen: bindings for Imagis

Quoted 23 lines · Markuss Broks

This patch adds device-tree bindings for the Imagis IST3038C touch screen IC.

---
 .../input/touchscreen/imagis,ist3038c.yaml    | 75 +++++++++++++++++++
 .../devicetree/bindings/vendor-prefixes.yaml  |  2 +
 2 files changed, 77 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +7 -0
new file mode 100644
index 000000000000..7b127817e1f6
@@ -0,0 +1,75 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/touchscreen/imagis,ist3038c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Imagis IST30XXC family touchscreen controller bindings

Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml line 17

Quoted 10 lines
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +10 -0
+
+maintainers:
+  - Markuss Broks <[email protected]>
+
+allOf:
+  - $ref: touchscreen.yaml#
+
+properties:
+  $nodename:
+    pattern: "^touchscreen(@.*)?$"

reg is required, so @ is not optional:
^touchscreen@[0-9a-f]+$

Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml line 20

Quoted 3 lines
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +3 -0
+
+  compatible:
+    items:

Do you expect here multiple compatibles? If not, the items are not needed.

Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml line 25

Quoted 5 lines
Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml new file +5 -0
+      - enum:
+          - imagis,ist3038c
+
+  reg:
+    description: I2C address

You can skip description because it is fairly obvious, but instead you need maxItems. Alternatively, a list (items) with description defines max items.

Best regards,
Krzysztof

author maintainer
#6 lore raw

PATCH v3 2/2 Input: add Imagis touchscreen driver

In reply to Markuss Broks

Add support for the IST3038C touchscreen IC from Imagis, based on downstream driver. The driver supports multi-touch (10 touch points) The IST3038C IC supports touch keys, but the support isn't added because the touch screen used for testing doesn't utilize touch keys. Looking at the downstream driver, it is possible to add support for other Imagis ICs of IST30**C series.

---
 MAINTAINERS                        |   6 +
 drivers/input/touchscreen/Kconfig  |  10 +
 drivers/input/touchscreen/Makefile |   1 +
 drivers/input/touchscreen/imagis.c | 330 +++++++++++++++++++++++++++++
 4 files changed, 347 insertions(+)
 create mode 100644 drivers/input/touchscreen/imagis.c
MAINTAINERS +6 -0
index a899828a8d4e..f7f717ae926a 100644
@@ -9405,6 +9405,12 @@ F:	Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml
 F:	Documentation/devicetree/bindings/iio/afe/voltage-divider.yaml
 F:	drivers/iio/afe/iio-rescale.c
 
+IMAGIS TOUCHSCREEN DRIVER
+M:	Markuss Broks <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
+F:	drivers/input/touchscreen/imagis.c
+
 IKANOS/ADI EAGLE ADSL USB DRIVER
 M:	Matthieu Castet <[email protected]>
 M:	Stanislaw Gruszka <[email protected]>
drivers/input/touchscreen/Kconfig +10 -0
index 2f6adfb7b938..6810b4b094e8 100644
@@ -1367,4 +1367,14 @@ config TOUCHSCREEN_ZINITIX
 	  To compile this driver as a module, choose M here: the
 	  module will be called zinitix.
 
+config TOUCHSCREEN_IMAGIS
+	tristate "Imagis touchscreen support"
+	depends on I2C
+	help
+		Say Y here if you have an Imagis IST30xxC touchscreen.
+		If unsure, say N.
+
+		To compile this driver as a module, choose M here: the
+		module will be called imagis.
+
 endif
drivers/input/touchscreen/Makefile +1 -0
index 39a8127cf6a5..989bb1d563d3 100644
@@ -115,3 +115,4 @@ obj-$(CONFIG_TOUCHSCREEN_ROHM_BU21023)	+= rohm_bu21023.o
 obj-$(CONFIG_TOUCHSCREEN_RASPBERRYPI_FW)	+= raspberrypi-ts.o
 obj-$(CONFIG_TOUCHSCREEN_IQS5XX)	+= iqs5xx.o
 obj-$(CONFIG_TOUCHSCREEN_ZINITIX)	+= zinitix.o
+obj-$(CONFIG_TOUCHSCREEN_IMAGIS)	+= imagis.o
drivers/input/touchscreen/imagis.c new file +330 -0

330 lines not on this page · raw message

Signature · 1 line
2.35.0
#7 lore raw

Re: [PATCH v3 2/2] Input: add Imagis touchscreen driver

Quoted 21 lines · Markuss Broks

Add support for the IST3038C touchscreen IC from Imagis, based on downstream driver. The driver supports multi-touch (10 touch points) The IST3038C IC supports touch keys, but the support isn't added because the touch screen used for testing doesn't utilize touch keys. Looking at the downstream driver, it is possible to add support for other Imagis ICs of IST30**C series.

---
 MAINTAINERS                        |   6 +
 drivers/input/touchscreen/Kconfig  |  10 +
 drivers/input/touchscreen/Makefile |   1 +
 drivers/input/touchscreen/imagis.c | 330 +++++++++++++++++++++++++++++
 4 files changed, 347 insertions(+)
 create mode 100644 drivers/input/touchscreen/imagis.c
MAINTAINERS +0 -0
index a899828a8d4e..f7f717ae926a 100644

MAINTAINERS F: Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml · line 9408

Quoted 4 lines
MAINTAINERS +1 -0
@@ -9405,6 +9405,12 @@ F:	Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml
 F:	Documentation/devicetree/bindings/iio/afe/voltage-divider.yaml
 F:	drivers/iio/afe/iio-rescale.c
 
+IMAGIS TOUCHSCREEN DRIVER

Please read the line 143-144 of this file.

Quoted 13 lines
MAINTAINERS +5 -0
+M:	Markuss Broks <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
+F:	drivers/input/touchscreen/imagis.c
+
 IKANOS/ADI EAGLE ADSL USB DRIVER
 M:	Matthieu Castet <[email protected]>
 M:	Stanislaw Gruszka <[email protected]>
drivers/input/touchscreen/Kconfig +0 -0
index 2f6adfb7b938..6810b4b094e8 100644

drivers/input/touchscreen/Kconfig config TOUCHSCREEN_ZINITIX · line 1370

Quoted 4 lines
drivers/input/touchscreen/Kconfig +1 -0
@@ -1367,4 +1367,14 @@ config TOUCHSCREEN_ZINITIX
 	  To compile this driver as a module, choose M here: the
 	  module will be called zinitix.
 
+config TOUCHSCREEN_IMAGIS

Here and in Makefile - do not add entries at the end, but alphabetically. This reduces conflicts.

Quoted 19 lines
drivers/input/touchscreen/Kconfig +9 -0
+	tristate "Imagis touchscreen support"
+	depends on I2C
+	help
+		Say Y here if you have an Imagis IST30xxC touchscreen.
+		If unsure, say N.
+
+		To compile this driver as a module, choose M here: the
+		module will be called imagis.
+
 endif
drivers/input/touchscreen/Makefile +1 -0
index 39a8127cf6a5..989bb1d563d3 100644
@@ -115,3 +115,4 @@ obj-$(CONFIG_TOUCHSCREEN_ROHM_BU21023)	+= rohm_bu21023.o
 obj-$(CONFIG_TOUCHSCREEN_RASPBERRYPI_FW)	+= raspberrypi-ts.o
 obj-$(CONFIG_TOUCHSCREEN_IQS5XX)	+= iqs5xx.o
 obj-$(CONFIG_TOUCHSCREEN_ZINITIX)	+= zinitix.o
+obj-$(CONFIG_TOUCHSCREEN_IMAGIS)	+= imagis.o

(...)

drivers/input/touchscreen/Makefile

Quoted 13 lines
drivers/input/touchscreen/Makefile +13 -0
+
+static int imagis_init_regulators(struct imagis_ts *ts)
+{
+	struct i2c_client *client = ts->client;
+	int error;
+
+	ts->supplies[0].supply = "vdd";
+	ts->supplies[1].supply = "vddio";
+	error = devm_regulator_bulk_get(&client->dev,
+					ARRAY_SIZE(ts->supplies),
+					ts->supplies);
+	if (error < 0) {
+		dev_err(&client->dev, "Failed to get regulators: %d\n", error);

This should be also dev_err_probe() in case of deferred probing. On the other hand, you already handle printing in probe(), so why doing it twice?

Quoted 23 lines
drivers/input/touchscreen/Makefile +23 -0
+		return error;
+	}
+
+	return 0;
+}
+
+static int imagis_probe(struct i2c_client *i2c)
+{
+	struct device *dev;
+	struct imagis_ts *ts;
+	int chip_id, ret;
+
+	dev = &i2c->dev;
+
+	ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
+	if (!ts)
+		return -ENOMEM;
+
+	ts->client = i2c;
+
+	ret = imagis_init_regulators(ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "regulator init error: %d\n", ret);

drivers/input/touchscreen/Makefile

Quoted 10 lines
drivers/input/touchscreen/Makefile +10 -0
+
+	ret = regulator_bulk_enable(ARRAY_SIZE(ts->supplies),
+				    ts->supplies);
+	if (ret)
+		return dev_err_probe(dev, ret, "failed to enable regulators: %d\n", ret);
+
+	msleep(IST3038C_CHIP_ON_DELAY);
+
+	ret = imagis_i2c_read_reg(ts, IST3038C_REG_CHIPID | IST3038C_DIRECT_ACCESS, &chip_id);
+	if (ret)

You miss here and other error paths the regulator cleanup (disabling).

drivers/input/touchscreen/Makefile

Quoted 10 lines
drivers/input/touchscreen/Makefile +10 -0
+		return dev_err_probe(dev, ret, "chip ID read failure: %d\n", ret);
+
+	if (chip_id == IST3038C_WHOAMI)
+		dev_dbg(dev, "Detected IST3038C chip\n");
+	else
+		return dev_err_probe(dev, -EINVAL, "unknown chip ID: 0x%x\n", chip_id);
+
+	ret = devm_request_threaded_irq(dev, i2c->irq,
+					NULL, imagis_interrupt,
+					IRQF_ONESHOT | IRQF_TRIGGER_FALLING | IRQF_NO_AUTOEN,

The interrupt edge should come from DT, not be hard-coded. I think you can safely skip IRQF_TRIGGER_FALLING.

drivers/input/touchscreen/Makefile

Quoted 11 lines
drivers/input/touchscreen/Makefile +11 -0
+					"imagis-touchscreen", ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "IRQ allocation failure: %d\n", ret);
+
+	ret = imagis_init_input_dev(ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "input subsystem init error: %d\n", ret);
+
+	return 0;
+}
+

Best regards,
Krzysztof

author maintainer
#8 lore raw

PATCH v2 2/2 Input: add Imagis touchscreen driver

In reply to Markuss Broks

Add support for the IST3038C touchscreen IC from Imagis, based on downstream driver. The driver supports multi-touch (10 touch points) The IST3038C IC supports touch keys, but the support isn't added because the touch screen used for testing doesn't utilize touch keys. Looking at the downstream driver, it is possible to add support for other Imagis ICs of IST30**C series.

---
 MAINTAINERS                        |   6 +
 drivers/input/touchscreen/Kconfig  |  10 +
 drivers/input/touchscreen/Makefile |   1 +
 drivers/input/touchscreen/imagis.c | 329 +++++++++++++++++++++++++++++
 4 files changed, 346 insertions(+)
 create mode 100644 drivers/input/touchscreen/imagis.c
MAINTAINERS +6 -0
index a899828a8d4e..f7f717ae926a 100644
@@ -9405,6 +9405,12 @@ F:	Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml
 F:	Documentation/devicetree/bindings/iio/afe/voltage-divider.yaml
 F:	drivers/iio/afe/iio-rescale.c
 
+IMAGIS TOUCHSCREEN DRIVER
+M:	Markuss Broks <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
+F:	drivers/input/touchscreen/imagis.c
+
 IKANOS/ADI EAGLE ADSL USB DRIVER
 M:	Matthieu Castet <[email protected]>
 M:	Stanislaw Gruszka <[email protected]>
drivers/input/touchscreen/Kconfig +10 -0
index 2f6adfb7b938..6810b4b094e8 100644
@@ -1367,4 +1367,14 @@ config TOUCHSCREEN_ZINITIX
 	  To compile this driver as a module, choose M here: the
 	  module will be called zinitix.
 
+config TOUCHSCREEN_IMAGIS
+	tristate "Imagis touchscreen support"
+	depends on I2C
+	help
+		Say Y here if you have an Imagis IST30xxC touchscreen.
+		If unsure, say N.
+
+		To compile this driver as a module, choose M here: the
+		module will be called imagis.
+
 endif
drivers/input/touchscreen/Makefile +1 -0
index 39a8127cf6a5..989bb1d563d3 100644
@@ -115,3 +115,4 @@ obj-$(CONFIG_TOUCHSCREEN_ROHM_BU21023)	+= rohm_bu21023.o
 obj-$(CONFIG_TOUCHSCREEN_RASPBERRYPI_FW)	+= raspberrypi-ts.o
 obj-$(CONFIG_TOUCHSCREEN_IQS5XX)	+= iqs5xx.o
 obj-$(CONFIG_TOUCHSCREEN_ZINITIX)	+= zinitix.o
+obj-$(CONFIG_TOUCHSCREEN_IMAGIS)	+= imagis.o
drivers/input/touchscreen/imagis.c new file +329 -0

329 lines not on this page · raw message

Signature · 1 line
2.35.0
#9 lore raw

Re: [PATCH v2 2/2] Input: add Imagis touchscreen driver

Hi Markuss,

Neat little driver! Some humble feedback below.

Quoted 85 lines · Markuss Broks

Add support for the IST3038C touchscreen IC from Imagis, based on downstream driver. The driver supports multi-touch (10 touch points) The IST3038C IC supports touch keys, but the support isn't added because the touch screen used for testing doesn't utilize touch keys. Looking at the downstream driver, it is possible to add support for other Imagis ICs of IST30**C series.

---
 MAINTAINERS                        |   6 +
 drivers/input/touchscreen/Kconfig  |  10 +
 drivers/input/touchscreen/Makefile |   1 +
 drivers/input/touchscreen/imagis.c | 329 +++++++++++++++++++++++++++++
 4 files changed, 346 insertions(+)
 create mode 100644 drivers/input/touchscreen/imagis.c
MAINTAINERS +6 -0
index a899828a8d4e..f7f717ae926a 100644
@@ -9405,6 +9405,12 @@ F:	Documentation/devicetree/bindings/iio/afe/current-sense-shunt.yaml
 F:	Documentation/devicetree/bindings/iio/afe/voltage-divider.yaml
 F:	drivers/iio/afe/iio-rescale.c
 
+IMAGIS TOUCHSCREEN DRIVER
+M:	Markuss Broks <[email protected]>
+S:	Maintained
+F:	Documentation/devicetree/bindings/input/touchscreen/imagis,ist3038c.yaml
+F:	drivers/input/touchscreen/imagis.c
+
 IKANOS/ADI EAGLE ADSL USB DRIVER
 M:	Matthieu Castet <[email protected]>
 M:	Stanislaw Gruszka <[email protected]>
drivers/input/touchscreen/Kconfig +10 -0
index 2f6adfb7b938..6810b4b094e8 100644
@@ -1367,4 +1367,14 @@ config TOUCHSCREEN_ZINITIX
 	  To compile this driver as a module, choose M here: the
 	  module will be called zinitix.
 
+config TOUCHSCREEN_IMAGIS
+	tristate "Imagis touchscreen support"
+	depends on I2C
+	help
+		Say Y here if you have an Imagis IST30xxC touchscreen.
+		If unsure, say N.
+
+		To compile this driver as a module, choose M here: the
+		module will be called imagis.
+
 endif
drivers/input/touchscreen/Makefile +1 -0
index 39a8127cf6a5..989bb1d563d3 100644
@@ -115,3 +115,4 @@ obj-$(CONFIG_TOUCHSCREEN_ROHM_BU21023)	+= rohm_bu21023.o
 obj-$(CONFIG_TOUCHSCREEN_RASPBERRYPI_FW)	+= raspberrypi-ts.o
 obj-$(CONFIG_TOUCHSCREEN_IQS5XX)	+= iqs5xx.o
 obj-$(CONFIG_TOUCHSCREEN_ZINITIX)	+= zinitix.o
+obj-$(CONFIG_TOUCHSCREEN_IMAGIS)	+= imagis.o
drivers/input/touchscreen/imagis.c new file +18 -0
new file mode 100644
index 000000000000..308f097a95c1
@@ -0,0 +1,329 @@
+// SPDX-License-Identifier: GPL-2.0-only
+
+#include <linux/delay.h>
+#include <linux/i2c.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/property.h>
+#include <linux/input.h>
+#include <linux/input/mt.h>
+#include <linux/input/touchscreen.h>
+
+#define IST3038_ADDR_LEN		4
+#define IST3038_DATA_LEN		4
+#define IST3038_HIB_ACCESS		(0x800B << 16)
+#define IST3038_DIRECT_ACCESS   BIT(31)
+#define IST3038_REG_CHIPID      0x40001000
+
+#define IST3038_REG_HIB_BASE		(0x30000100)

drivers/input/touchscreen/imagis.c line 28

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+#define IST3038_REG_TOUCH_STATUS        (IST3038_REG_HIB_BASE | IST3038_HIB_ACCESS)
+#define IST3038_REG_TOUCH_COORD        (IST3038_REG_HIB_BASE | IST3038_HIB_ACCESS | 0x8)
+#define IST3038_REG_INTR_MESSAGE        (IST3038_REG_HIB_BASE | IST3038_HIB_ACCESS | 0x4)
+
+#define IST3038C_WHOAMI			0x38c
+#define CHIP_ON_DELAY				60 // ms
+
+#define I2C_RETRY_COUNT			3
+
+#define MAX_SUPPORTED_FINGER_NUM		10

Please prefix all #defines with a common namespace (e.g. IST3038C).

drivers/input/touchscreen/imagis.c line 40

Quoted 12 lines
drivers/input/touchscreen/imagis.c new file +12 -0
+
+struct imagis_ts {
+	struct i2c_client *client;
+	struct input_dev *input_dev;
+	struct touchscreen_properties prop;
+	struct regulator_bulk_data supplies[2];
+};
+
+static int imagis_i2c_read_reg(struct imagis_ts *ts,
+			       unsigned int reg, unsigned int *buffer)
+{
+	unsigned int reg_be = __cpu_to_be32(reg);

Technically this type should be __be32. Also, why to use __cpu_to_be32 in place of cpu_to_be32?

drivers/input/touchscreen/imagis.c line 46

Quoted 6 lines
drivers/input/touchscreen/imagis.c new file +6 -0
+	struct i2c_msg msg[] = {
+		{
+			.addr = ts->client->addr,
+			.flags = 0,
+			.buf = (unsigned char *)&reg_be,
+			.len = IST3038_ADDR_LEN,

I do not think we need these #defines; just use sizeof(reg_be).

drivers/input/touchscreen/imagis.c line 51

Quoted 5 lines
drivers/input/touchscreen/imagis.c new file +5 -0
+		}, {
+			.addr = ts->client->addr,
+			.flags = I2C_M_RD,
+			.buf = (unsigned char *)buffer,
+			.len = IST3038_DATA_LEN,

Same here.

drivers/input/touchscreen/imagis.c line 54

Quoted 3 lines
drivers/input/touchscreen/imagis.c new file +3 -0
+		},
+	};
+	int res;

For these return variables that may be positive or negative, it is more common to use 'ret'.

Quoted 4 lines
drivers/input/touchscreen/imagis.c new file +4 -0
+	int error;
+	int retry = I2C_RETRY_COUNT;
+
+	do {

drivers/input/touchscreen/imagis.c line 68

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+		res = i2c_transfer(ts->client->adapter, msg, ARRAY_SIZE(msg));
+		if (res == ARRAY_SIZE(msg)) {
+			*buffer = __be32_to_cpu(*buffer);
+			return 0;
+		}
+
+		error = res < 0 ? res : -EIO;
+		dev_err(&ts->client->dev,
+			"%s - i2c_transfer failed: %d (%d)\n",
+			__func__, error, res);

Does this controller suffer some sort of erratum that requires I2C reads to be retried? If so, it would be handy to include a comment here as to why we do not expect the read to be successful right away.

drivers/input/touchscreen/imagis.c line 78

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+	} while (--retry);
+
+	return error;
+}
+
+static irqreturn_t imagis_interrupt(int irq, void *dev_id)
+{
+	struct imagis_ts *ts = dev_id;
+	unsigned int finger_status, intr_message;
+	int ret, i, finger_count, finger_pressed;

Please use 'error' for return values that only return 0 or an -errno.

drivers/input/touchscreen/imagis.c line 87

Quoted 9 lines
drivers/input/touchscreen/imagis.c new file +9 -0
+
+	ret = imagis_i2c_read_reg(ts, IST3038_REG_INTR_MESSAGE, &intr_message);
+	if (ret) {
+		dev_err(&ts->client->dev, "failed to read the interrupt message\n");
+		return IRQ_HANDLED;
+	}
+
+	finger_count = (intr_message >> 12) & 0xF;
+	finger_pressed = intr_message & 0x3FF;

Please #define bit shift and masks, with GENMASK used for the latter.

drivers/input/touchscreen/imagis.c line 91

Quoted 4 lines
drivers/input/touchscreen/imagis.c new file +4 -0
+	if (finger_count > 10) {
+		dev_err(&ts->client->dev, "finger count is more than maximum supported\n");
+		return IRQ_HANDLED;
+	}

You seem to have #defined the maximum finger count but it is not used here.

drivers/input/touchscreen/imagis.c line 98

Quoted 7 lines
drivers/input/touchscreen/imagis.c new file +7 -0
+
+	for (i = 0; i < finger_count; i++) {
+		ret = imagis_i2c_read_reg(ts, IST3038_REG_TOUCH_COORD + (i * 4), &finger_status);
+		if (ret) {
+			dev_err(&ts->client->dev, "failed to read coordinates for finger %d\n", i);
+			return IRQ_HANDLED;
+		}

Can this not be done in a bulk read so as to save up to 10 stop/starts?

Maybe it makes sense to define a bulk read function, with imagis_i2c_read simply calling the bulk read function with a fixed length.

drivers/input/touchscreen/imagis.c line 101

Quoted 3 lines
drivers/input/touchscreen/imagis.c new file +3 -0
+		input_mt_slot(ts->input_dev, i);
+		input_mt_report_slot_state(ts->input_dev, MT_TOOL_FINGER,
+					   (finger_pressed & BIT(i)) ? 1 : 0);

No need for the ternary operator here; just pass the boolean as-is.

Quoted 15 lines
drivers/input/touchscreen/imagis.c new file +15 -0
+		touchscreen_report_pos(ts->input_dev, &ts->prop,
+				       (finger_status >> 12) & 0xFFF, finger_status & 0xFFF, 1);
+		input_report_abs(ts->input_dev, ABS_MT_TOUCH_MAJOR, (finger_status >> 24) & 0xFFF);
+	}
+	input_mt_sync_frame(ts->input_dev);
+	input_sync(ts->input_dev);
+
+	return IRQ_HANDLED;
+}
+
+static int imagis_start(struct imagis_ts *ts)
+{
+	int error;
+
+	error = regulator_bulk_enable(ARRAY_SIZE(ts->supplies),

drivers/input/touchscreen/imagis.c line 126

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+				      ts->supplies);
+	if (error) {
+		dev_err(&ts->client->dev,
+			"Failed to enable regulators: %d\n", error);
+		return error;
+	}
+
+	msleep(CHIP_ON_DELAY);
+
+	enable_irq(ts->client->irq);

This is going to cause unbalanced irq enable/disable because you're calling this function from probe.

Quoted 8 lines
drivers/input/touchscreen/imagis.c new file +8 -0
+	return 0;
+}
+
+static int imagis_stop(struct imagis_ts *ts)
+{
+	int error;
+
+	disable_irq(ts->client->irq);

drivers/input/touchscreen/imagis.c line 144

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+
+	error = regulator_bulk_disable(ARRAY_SIZE(ts->supplies),
+				       ts->supplies);
+	if (error) {
+		dev_err(&ts->client->dev,
+			"Failed to disable regulators: %d\n", error);
+		return error;
+	}
+
+	return 0;

This is largely personal preference, but this is shorter:

error = ...
if (error)

        dev_err(...);

return error;

Quoted 17 lines
drivers/input/touchscreen/imagis.c new file +17 -0
+}
+
+static int imagis_input_open(struct input_dev *dev)
+{
+	struct imagis_ts *ts = input_get_drvdata(dev);
+
+	return imagis_start(ts);
+}
+
+static void imagis_input_close(struct input_dev *dev)
+{
+	struct imagis_ts *ts = input_get_drvdata(dev);
+
+	imagis_stop(ts);
+}
+
+static int imagis_init_input_dev(struct imagis_ts *ts)

drivers/input/touchscreen/imagis.c line 171

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+{
+	struct input_dev *input_dev;
+	int error;
+
+	input_dev = devm_input_allocate_device(&ts->client->dev);
+	if (!input_dev) {
+		dev_err(&ts->client->dev,
+			"Failed to allocate input device.");
+		return -ENOMEM;
+	}

No need for a message here.

Quoted 4 lines
drivers/input/touchscreen/imagis.c new file +4 -0
+
+	ts->input_dev = input_dev;
+
+	input_dev->name = "Imagis capacitive touchscreen";

drivers/input/touchscreen/imagis.c line 185

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+	input_dev->phys = "input/ts";
+	input_dev->id.bustype = BUS_I2C;
+	input_dev->open = imagis_input_open;
+	input_dev->close = imagis_input_close;
+
+	input_set_drvdata(input_dev, ts);
+
+	input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_X);
+	input_set_capability(input_dev, EV_ABS, ABS_MT_POSITION_Y);
+	input_set_abs_params(input_dev, ABS_MT_WIDTH_MAJOR, 0, 255, 0, 0);

WIDTH is advertised here but never reported in the interrupt handler.

Quoted 13 lines
drivers/input/touchscreen/imagis.c new file +13 -0
+	input_set_abs_params(input_dev, ABS_MT_TOUCH_MAJOR, 0, 255, 0, 0);
+
+	touchscreen_parse_properties(input_dev, true, &ts->prop);
+	if (!ts->prop.max_x || !ts->prop.max_y) {
+		dev_err(&ts->client->dev,
+			"Touchscreen-size-x and/or touchscreen-size-y not set in dts\n");
+		return -EINVAL;
+	}
+
+	error = input_mt_init_slots(input_dev, MAX_SUPPORTED_FINGER_NUM,
+				    INPUT_MT_DIRECT | INPUT_MT_DROP_UNUSED);
+	if (error) {
+		dev_err(&ts->client->dev,

drivers/input/touchscreen/imagis.c line 208

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+			"Failed to initialize MT slots: %d", error);
+		return error;
+	}
+
+	error = input_register_device(input_dev);
+	if (error) {
+		dev_err(&ts->client->dev,
+			"Failed to register input device: %d", error);
+		return error;
+	}

I suggest using the device-managed version here, as you have no remove callback.

drivers/input/touchscreen/imagis.c line 219

Quoted 11 lines
drivers/input/touchscreen/imagis.c new file +11 -0
+
+	return 0;
+}
+
+static int imagis_init_regulators(struct imagis_ts *ts)
+{
+	struct i2c_client *client = ts->client;
+	int error;
+
+	ts->supplies[0].supply = "vdd";
+	ts->supplies[1].supply = "vddio";

How does this work?

Quoted 21 lines
drivers/input/touchscreen/imagis.c new file +21 -0
+	error = devm_regulator_bulk_get(&client->dev,
+					ARRAY_SIZE(ts->supplies),
+					ts->supplies);
+	if (error < 0) {
+		dev_err(&client->dev, "Failed to get regulators: %d\n", error);
+		return error;
+	}
+
+	return 0;
+}
+
+static int imagis_probe(struct i2c_client *i2c)
+{
+	struct device *dev;
+	struct imagis_ts *ts;
+	int chip_id, ret;
+
+	dev = &i2c->dev;
+
+	ts = devm_kzalloc(dev, sizeof(*ts), GFP_KERNEL);
+	if (!ts)

drivers/input/touchscreen/imagis.c line 250

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+		return -ENOMEM;
+
+	ts->client = i2c;
+
+	ret = devm_request_threaded_irq(dev, i2c->irq,
+					NULL, imagis_interrupt,
+					IRQF_ONESHOT | IRQF_TRIGGER_FALLING,
+					"imagis-touchscreen", ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "IRQ allocation failure: %d\n", ret);

Are you sure it's safe to enable interrupts before the controller has been powered?

Quoted 5 lines
drivers/input/touchscreen/imagis.c new file +5 -0
+
+	ret = imagis_init_regulators(ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "regulator init error: %d\n", ret);
+

drivers/input/touchscreen/imagis.c line 265

Quoted 10 lines
drivers/input/touchscreen/imagis.c new file +10 -0
+	ret = imagis_start(ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "regulator enable error: %d\n", ret);
+
+	ret = imagis_i2c_read_reg(ts, IST3038_REG_CHIPID | IST3038_DIRECT_ACCESS, &chip_id);
+	if (ret)
+		return dev_err_probe(dev, ret, "chip ID read failure: %d\n", ret);
+
+	if (chip_id == IST3038C_WHOAMI)
+		dev_info(dev, "Detected IST3038C chip\n");

This should be dev_dbg, if at all.

drivers/input/touchscreen/imagis.c line 267

Quoted 2 lines
drivers/input/touchscreen/imagis.c new file +2 -0
+	else
+		return dev_err_probe(dev, -EINVAL, "unknown chip ID: 0x%x\n", chip_id);

Usually you want to ID the controller as early as possibe, to avoid wasting time allocating resources if there is a problem.

drivers/input/touchscreen/imagis.c line 272

Quoted 5 lines
drivers/input/touchscreen/imagis.c new file +5 -0
+
+	ret = imagis_init_input_dev(ts);
+	if (ret)
+		return dev_err_probe(dev, ret, "input subsystem init error: %d\n", ret);
+

Just for my own understanding, this controller needs no configuration or register writes after power-on?

drivers/input/touchscreen/imagis.c line 284

Quoted 12 lines
drivers/input/touchscreen/imagis.c new file +12 -0
+	return 0;
+}
+
+static int __maybe_unused imagis_suspend(struct device *dev)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct imagis_ts *ts = i2c_get_clientdata(client);
+
+	mutex_lock(&ts->input_dev->mutex);
+
+	if (input_device_enabled(ts->input_dev))
+		imagis_stop(ts);

I would prefer to salvage the return value and return it after mutex unlock.

Quoted 48 lines
drivers/input/touchscreen/imagis.c new file +45 -0
+
+	mutex_unlock(&ts->input_dev->mutex);
+
+	return 0;
+}
+
+static int __maybe_unused imagis_resume(struct device *dev)
+{
+	struct i2c_client *client = to_i2c_client(dev);
+	struct imagis_ts *ts = i2c_get_clientdata(client);
+
+	mutex_lock(&ts->input_dev->mutex);
+
+	if (input_device_enabled(ts->input_dev))
+		imagis_start(ts);
+
+	mutex_unlock(&ts->input_dev->mutex);
+
+	return 0;
+}
+
+static SIMPLE_DEV_PM_OPS(imagis_pm_ops, imagis_suspend, imagis_resume);
+
+#ifdef CONFIG_OF
+static const struct of_device_id imagis_of_match[] = {
+	{ .compatible = "imagis,ist3038c", },
+	{ },
+};
+MODULE_DEVICE_TABLE(i2c, imagis_of_match);
+#endif
+
+static struct i2c_driver imagis_ts_driver = {
+	.driver = {
+		   .name = "imagis-touchscreen",
+		   .pm = &imagis_pm_ops,
+		   .of_match_table = of_match_ptr(imagis_of_match),
+	},
+	.probe_new	= imagis_probe,
+};
+
+module_i2c_driver(imagis_ts_driver);
+
+MODULE_DESCRIPTION("Imagis IST3038C Touchscreen Driver");
+MODULE_AUTHOR("Markuss Broks <[email protected]>");
+MODULE_LICENSE("GPL");
Signature · 1 line
2.35.0

Kind regards,
Jeff LaBundy

#10 lore raw

Re: [PATCH v2 2/2] Input: add Imagis touchscreen driver

Hi Markuss,

One tiny correction to my previous feedback.

Quoted 4 lines · Jeff LaBundy

Hi Markuss,

Neat little driver! Some humble feedback below.

[...]

Quoted 9 lines

drivers/input/touchscreen/imagis.c line 208

Quoted 6 lines
drivers/input/touchscreen/imagis.c new file +6 -0
+	error = input_register_device(input_dev);
+	if (error) {
+		dev_err(&ts->client->dev,
+			"Failed to register input device: %d", error);
+		return error;
+	}

I suggest using the device-managed version here, as you have no remove callback.

Please ignore this bit :)

[...]

Kind regards,
Jeff LaBundy