Skip to contentSkip to conversation

HID: i2c-hid: Reorganize to allow supporting goodix,gt7375p

PATCH Superseded Douglas Anderson 3 participants 11 messages Nov 9, 2020 – Nov 11, 2020

Subsystems (3)

v5 of 9 Superseded Latest is v9 →

lore
Share & tools
lore
#0 lore raw

v5 cover HID: i2c-hid: Reorganize to allow supporting goodix,gt7375p

The goal of this series is to support the Goodix GT7375P touchscreen. This touchscreen is special because it has power sequencing requirements that necessitate driving a reset GPIO.

To do this, we totally rejigger the way i2c-hid is organized so that it's easier to jam the Goodix support in there.

This series was:
- Tested on a device that uses normal i2c-hid.
- Tested on a device that has a Goodix i2c-hid device.
- NOT tested on any ACPI devices (just compile tested).

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- Added mention of i2c-hid in the yaml itself as per Rob.
- Adjusted subject as per Rob.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Changes in v4:
- ("arm64: defconfig: Update config names for i2c-hid rejigger") new for v4.
- Fully rejigger so ACPI and OF are full subclasses.
- Totally redid based on the new subclass system.

Changes in v3:
- Fixed compatible in example.
- Removed Benjamin as a maintainer.
- Rework to use subclassing.
- Updated description.

Changes in v2:
- ("dt-bindings: HID: i2c-hid: Introduce bindings for the Goodix GT7375P") new in v2.
- Get timings based on the compatible string.
- Use a separate compatible string for this new touchscreen.

Douglas Anderson (4):
HID: i2c-hid: Reorganize so ACPI and OF are separate modules
arm64: defconfig: Update config names for i2c-hid rejigger
dt-bindings: input: HID: i2c-hid: Introduce bindings for the Goodix

    GT7375P

HID: i2c-hid: Introduce goodix-i2c-hid using i2c-hid core

 .../bindings/input/goodix,gt7375p.yaml        |  65 +++++
 arch/arm64/configs/defconfig                  |   3 +-
 drivers/hid/Makefile                          |   2 +-
 drivers/hid/i2c-hid/Kconfig                   |  47 +++-
 drivers/hid/i2c-hid/Makefile                  |   6 +-
 drivers/hid/i2c-hid/i2c-hid-acpi.c            | 170 ++++++++++++
 drivers/hid/i2c-hid/i2c-hid-core.c            | 252 +++---------------
 drivers/hid/i2c-hid/i2c-hid-of-goodix.c       | 120 +++++++++
 drivers/hid/i2c-hid/i2c-hid-of.c              | 147 ++++++++++
 drivers/hid/i2c-hid/i2c-hid.h                 |  25 ++
 include/linux/platform_data/i2c-hid.h         |  41 ---
 11 files changed, 615 insertions(+), 263 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7375p.yaml
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-acpi.c
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-of-goodix.c
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-of.c
 delete mode 100644 include/linux/platform_data/i2c-hid.h
Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog
#1 lore raw

PATCH v5 1/4 HID: i2c-hid: Reorganize so ACPI and OF are separate modules

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Changes in v4:
- Fully rejigger so ACPI and OF are full subclasses.

Changes in v3:
- Rework to use subclassing.

Changes in v2:
- Get timings based on the compatible string.
- Use a separate compatible string for this new touchscreen.

 drivers/hid/Makefile                  |   2 +-
 drivers/hid/i2c-hid/Kconfig           |  32 +++-
 drivers/hid/i2c-hid/Makefile          |   5 +-
 drivers/hid/i2c-hid/i2c-hid-acpi.c    | 170 +++++++++++++++++
 drivers/hid/i2c-hid/i2c-hid-core.c    | 252 ++++----------------------
 drivers/hid/i2c-hid/i2c-hid-of.c      | 147 +++++++++++++++
 drivers/hid/i2c-hid/i2c-hid.h         |  25 +++
 include/linux/platform_data/i2c-hid.h |  41 -----
 8 files changed, 412 insertions(+), 262 deletions(-)
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-acpi.c
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-of.c
 delete mode 100644 include/linux/platform_data/i2c-hid.h
drivers/hid/Makefile +1 -1
index 4acb583c92a6..8d0c15a0d652 100644
@@ -138,7 +138,7 @@ obj-$(CONFIG_USB_HID)		+= usbhid/
 obj-$(CONFIG_USB_MOUSE)		+= usbhid/
 obj-$(CONFIG_USB_KBD)		+= usbhid/
 
-obj-$(CONFIG_I2C_HID)		+= i2c-hid/
+obj-$(CONFIG_I2C_HID_CORE)	+= i2c-hid/
 
 obj-$(CONFIG_INTEL_ISH_HID)	+= intel-ish-hid/
 obj-$(INTEL_ISH_FIRMWARE_DOWNLOADER)	+= intel-ish-hid/
drivers/hid/i2c-hid/Kconfig +27 -5
index c4e5dfeab2bd..819b7521c182 100644
@@ -2,18 +2,40 @@
 menu "I2C HID support"
 	depends on I2C
 
-config I2C_HID
-	tristate "HID over I2C transport layer"
+config I2C_HID_ACPI
+	tristate "HID over I2C transport layer ACPI driver"
 	default n
-	depends on I2C && INPUT
-	select HID
+	depends on I2C && INPUT && ACPI
+	help
+	  Say Y here if you use a keyboard, a touchpad, a touchscreen, or any
+	  other HID based devices which is connected to your computer via I2C.
+	  This driver supports ACPI-based systems.
+
+	  If unsure, say N.
+
+	  This support is also available as a module.  If so, the module
+	  will be called i2c-hid-acpi.  It will also build/depend on the
+	  module i2c-hid.
+
+config I2C_HID_OF
+	tristate "HID over I2C transport layer Open Firmware driver"
+	default n
+	depends on I2C && INPUT && OF
 	help
 	  Say Y here if you use a keyboard, a touchpad, a touchscreen, or any
 	  other HID based devices which is connected to your computer via I2C.
+	  This driver supports Open Firmware (Device Tree)-based systems.
 
 	  If unsure, say N.
 
 	  This support is also available as a module.  If so, the module
-	  will be called i2c-hid.
+	  will be called i2c-hid-of.  It will also build/depend on the
+	  module i2c-hid.
 
 endmenu
+
+config I2C_HID_CORE
+	tristate
+	default y if I2C_HID_ACPI=y || I2C_HID_OF=y
+	default m if I2C_HID_ACPI=m || I2C_HID_OF=m
+	select HID
drivers/hid/i2c-hid/Makefile +4 -1
index 681b3896898e..9b4a73446841 100644
@@ -3,7 +3,10 @@
 # Makefile for the I2C input drivers
 #
 
-obj-$(CONFIG_I2C_HID)				+= i2c-hid.o
+obj-$(CONFIG_I2C_HID_CORE)			+= i2c-hid.o
 
 i2c-hid-objs					=  i2c-hid-core.o
 i2c-hid-$(CONFIG_DMI)				+= i2c-hid-dmi-quirks.o
+
+obj-$(CONFIG_I2C_HID_ACPI)			+= i2c-hid-acpi.o
+obj-$(CONFIG_I2C_HID_OF)			+= i2c-hid-of.o
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +170 -0

170 lines not on this page · raw message

drivers/hid/i2c-hid/i2c-hid-core.c +38 -214

377 lines not on this page · raw message

drivers/hid/i2c-hid/i2c-hid-of.c new file +147 -0

147 lines not on this page · raw message

drivers/hid/i2c-hid/i2c-hid.h +25 -0
index a8c19aef5824..13e666ec366c 100644
@@ -3,6 +3,7 @@
 #ifndef I2C_HID_H
 #define I2C_HID_H
 
+#include <linux/i2c.h>
 
 #ifdef CONFIG_DMI
 struct i2c_hid_desc *i2c_hid_get_dmi_i2c_hid_desc_override(uint8_t *i2c_name);
@@ -17,4 +18,28 @@ static inline char *i2c_hid_get_dmi_hid_report_desc_override(uint8_t *i2c_name,
 { return NULL; }
 #endif
 
+/**
+ * struct i2chid_ops - Ops provided to the core.
+ *
+ * @power_up: do sequencing to power up the device.
+ * @power_down: do sequencing to power down the device.
+ * @shutdown_tail: called at the end of shutdown.
+ */
+struct i2chid_ops {
+	int (*power_up)(struct i2chid_ops *ops);
+	void (*power_down)(struct i2chid_ops *ops);
+	void (*shutdown_tail)(struct i2chid_ops *ops);
+};
+
+int i2c_hid_core_probe(struct i2c_client *client, struct i2chid_ops *ops,
+		       u16 hid_descriptor_address);
+int i2c_hid_core_remove(struct i2c_client *client);
+
+void i2c_hid_core_shutdown(struct i2c_client *client);
+
+#ifdef CONFIG_PM_SLEEP
+int i2c_hid_core_suspend(struct device *dev);
+int i2c_hid_core_resume(struct device *dev);
+#endif
+
 #endif
include/linux/platform_data/i2c-hid.h deleted +0 -41

41 lines not on this page · raw message

Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog
#2 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

Hi,

drivers/hid/i2c-hid/i2c-hid-acpi.c line 116

Quoted 13 lines · Douglas Anderson
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +12 -0
+int i2c_hid_acpi_probe(struct i2c_client *client,
+                      const struct i2c_device_id *dev_id)
+{
+       struct device *dev = &client->dev;
+       struct i2c_hid_acpi *ihid_acpi;
+       u16 hid_descriptor_address;
+       int ret;
+
+       ihid_acpi = devm_kzalloc(&client->dev, sizeof(*ihid_acpi), GFP_KERNEL);
+       if (!ihid_acpi)
+               return -ENOMEM;
+

Turns out one way to find some folks to help me test this code is to break them. Maybe not a good way, but a way. :(

There should have been a:

ihid_acpi->client = client;

...here. If you're willing to look at Chrome OS gerrit pages, you can find the fix at <https://crrev.com/c/2527946>.

If everything about this patch looks good, I'm OK w/ a maintainer fixing this when applying. I'm also happy to send out a v6, but I'll wait a little bit in case there are other comments.

-Doug

Reviewed-by on v5 1/4
#3 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

In reply to Douglas Anderson

Hi,

Quoted 18 lines · Douglas Anderson

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

Quoted 9 lines

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Thanks this looks good to now, 2 small remarks below (since you are going to do a v6 anyways). Feel free to ignore these remarks if you prefer to keep things as is.

And feel free to add my reviewed-by to v6 of this patch:

<snip>

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +0 -0
new file mode 100644
index 000000000000..5f09635d00ce
@@ -0,0 +1,170 @@

<snip>

drivers/hid/i2c-hid/i2c-hid-acpi.c line 150

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +6 -0
+static const struct i2c_device_id i2c_hid_acpi_id_table[] = {
+	{ "hid", 0 },
+	{ "hid-over-i2c", 0 },
+	{ },
+};
+MODULE_DEVICE_TABLE(i2c, i2c_hid_acpi_id_table);

Hmm, I do not think these old-style i2c-ids are necessarry at all in this driver. I expect all use-cases to use either of or acpi matches.

This was already present in the code before though, so please ignore this remark. This is just something which I noticed and thought was worth while pointing out as a future cleanup.

<snip>

drivers/hid/i2c-hid/i2c-hid-core.c line 38

Quoted 11 lines
drivers/hid/i2c-hid/i2c-hid-core.c +0 -2
index aeff1ffb0c8b..9551ba96dc49 100644
@@ -35,12 +35,8 @@
 #include <linux/kernel.h>
 #include <linux/hid.h>
 #include <linux/mutex.h>
-#include <linux/acpi.h>
-#include <linux/of.h>
 #include <linux/regulator/consumer.h>

I think you can drop this regulator include here now too ?

Quoted 5 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +0 -0
new file mode 100644
index 000000000000..15d533be2b24

<snip>

drivers/hid/i2c-hid/i2c-hid-of.c line 114

Quoted 3 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +3 -0
+static const struct dev_pm_ops i2c_hid_of_pm = {
+	SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_core_suspend, i2c_hid_core_resume)
+};

This dev_pm_ops struct is identical to the one in i2c-hid-acpi.c and the one which you introduce later in i2c-hid-of-goodix.c is also identical, so that is 3 copies.

Maybe just put a shared dev_pm_ops struct in the i2c-core (and don't export the suspend/resume handlers) ?

Regards,

Hans

#4 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

Hi,

Quoted 32 lines · Hans de Goede

Hi,

Quoted 18 lines · Douglas Anderson

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

Quoted 9 lines

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Quoted 7 lines

Thanks this looks good to now, 2 small remarks below (since you are going to do a v6 anyways). Feel free to ignore these remarks if you prefer to keep things as is.

And feel free to add my reviewed-by to v6 of this patch:

Thanks!

Quoted 11 lines

drivers/hid/i2c-hid/i2c-hid-acpi.c line 150

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +6 -0
+static const struct i2c_device_id i2c_hid_acpi_id_table[] = {
+     { "hid", 0 },
+     { "hid-over-i2c", 0 },
+     { },
+};
+MODULE_DEVICE_TABLE(i2c, i2c_hid_acpi_id_table);

Hmm, I do not think these old-style i2c-ids are necessarry at all in this driver. I expect all use-cases to use either of or acpi matches.

Quoted 4 lines

This was already present in the code before though, so please ignore this remark. This is just something which I noticed and thought was worth while pointing out as a future cleanup.

Yeah, I wasn't sure if there was anyone using them.

Hrm. Thinking about it, though, is it really OK for two drivers to both have the same table listed? I'm not sure how that would work. Do you know?

I don't know a ton about ACPI, but for device tree I know i2c has a fallback mode. Specifically having this table means that we'll match compatible strings such as:

"zipzapzing,hid"
"kapowzers,hid-over-i2c"

In other words it'll ignore the vendor part and just match on the second half. Just to make sure I wasn't remembering that from a dream I tried it and it worked. I don't see any mainline device trees that look like that, though. I could delete it, though it doesn't really take up much space and it seems nice to keep it working in case anyone was relying on it?

For ACPI is there a similar fallback? If not then it seems like it'd be easy to remove it from there...

Quoted 15 lines

<snip>

drivers/hid/i2c-hid/i2c-hid-core.c line 38

Quoted 11 lines
drivers/hid/i2c-hid/i2c-hid-core.c +0 -2
index aeff1ffb0c8b..9551ba96dc49 100644
@@ -35,12 +35,8 @@
 #include <linux/kernel.h>
 #include <linux/hid.h>
 #include <linux/mutex.h>
-#include <linux/acpi.h>
-#include <linux/of.h>
 #include <linux/regulator/consumer.h>

I think you can drop this regulator include here now too ?

Good point.

Quoted 15 lines
Quoted 5 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +0 -0
new file mode 100644
index 000000000000..15d533be2b24

<snip>

drivers/hid/i2c-hid/i2c-hid-of.c line 114

Quoted 3 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +3 -0
+static const struct dev_pm_ops i2c_hid_of_pm = {
+     SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_core_suspend, i2c_hid_core_resume)
+};

This dev_pm_ops struct is identical to the one in i2c-hid-acpi.c and the one which you introduce later in i2c-hid-of-goodix.c is also identical, so that is 3 copies.

Quoted 2 lines

Maybe just put a shared dev_pm_ops struct in the i2c-core (and don't export the suspend/resume handlers) ?

Sounds good.

-Doug

maintainer
#5 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

Quoted 82 lines · Doug Anderson

Hi,

Quoted 32 lines · Hans de Goede

Hi,

Quoted 18 lines · Douglas Anderson

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

Quoted 9 lines

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Quoted 7 lines

Thanks this looks good to now, 2 small remarks below (since you are going to do a v6 anyways). Feel free to ignore these remarks if you prefer to keep things as is.

And feel free to add my reviewed-by to v6 of this patch:

Thanks!

Quoted 11 lines

drivers/hid/i2c-hid/i2c-hid-acpi.c line 150

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +6 -0
+static const struct i2c_device_id i2c_hid_acpi_id_table[] = {
+     { "hid", 0 },
+     { "hid-over-i2c", 0 },
+     { },
+};
+MODULE_DEVICE_TABLE(i2c, i2c_hid_acpi_id_table);

Hmm, I do not think these old-style i2c-ids are necessarry at all in this driver. I expect all use-cases to use either of or acpi matches.

Quoted 4 lines

This was already present in the code before though, so please ignore this remark. This is just something which I noticed and thought was worth while pointing out as a future cleanup.

Yeah, I wasn't sure if there was anyone using them.

Hrm. Thinking about it, though, is it really OK for two drivers to both have the same table listed? I'm not sure how that would work. Do you know?

I don't know a ton about ACPI, but for device tree I know i2c has a fallback mode. Specifically having this table means that we'll match compatible strings such as:

"zipzapzing,hid"
"kapowzers,hid-over-i2c"

In other words it'll ignore the vendor part and just match on the second half. Just to make sure I wasn't remembering that from a dream I tried it and it worked. I don't see any mainline device trees that look like that, though. I could delete it, though it doesn't really take up much space and it seems nice to keep it working in case anyone was relying on it?

Quoted 2 lines

For ACPI is there a similar fallback? If not then it seems like it'd be easy to remove it from there...

Just a random thought - will all this still be working with ACPI PRP0001 and DT-style compatible string and properties in _DSD?

Thanks.

Signature · 1 line
Dmitry
#6 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

Hi,

Quoted 83 lines · Dmitry Torokhov
Quoted 82 lines · Doug Anderson

Hi,

Quoted 32 lines · Hans de Goede

Hi,

Quoted 18 lines · Douglas Anderson

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

Quoted 9 lines

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Quoted 7 lines

Thanks this looks good to now, 2 small remarks below (since you are going to do a v6 anyways). Feel free to ignore these remarks if you prefer to keep things as is.

And feel free to add my reviewed-by to v6 of this patch:

Thanks!

Quoted 11 lines

drivers/hid/i2c-hid/i2c-hid-acpi.c line 150

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +6 -0
+static const struct i2c_device_id i2c_hid_acpi_id_table[] = {
+     { "hid", 0 },
+     { "hid-over-i2c", 0 },
+     { },
+};
+MODULE_DEVICE_TABLE(i2c, i2c_hid_acpi_id_table);

Hmm, I do not think these old-style i2c-ids are necessarry at all in this driver. I expect all use-cases to use either of or acpi matches.

Quoted 4 lines

This was already present in the code before though, so please ignore this remark. This is just something which I noticed and thought was worth while pointing out as a future cleanup.

Yeah, I wasn't sure if there was anyone using them.

Hrm. Thinking about it, though, is it really OK for two drivers to both have the same table listed? I'm not sure how that would work. Do you know?

I don't know a ton about ACPI, but for device tree I know i2c has a fallback mode. Specifically having this table means that we'll match compatible strings such as:

"zipzapzing,hid"
"kapowzers,hid-over-i2c"

In other words it'll ignore the vendor part and just match on the second half. Just to make sure I wasn't remembering that from a dream I tried it and it worked. I don't see any mainline device trees that look like that, though. I could delete it, though it doesn't really take up much space and it seems nice to keep it working in case anyone was relying on it?

Quoted 5 lines
Quoted 2 lines

For ACPI is there a similar fallback? If not then it seems like it'd be easy to remove it from there...

Just a random thought - will all this still be working with ACPI PRP0001 and DT-style compatible string and properties in _DSD?

That should keep working. Unless someone mixes a DT-style compatible string with the PNP0C50 ACPI HID specific DSM for getting the hid_descriptor_address (instead of a DT style property). But that would be a really weird mix to use and obviously would go against both the PNP0C50 and the PRP0001 specs.

Regards,

Hans

#7 lore raw

Re: [PATCH v5 1/4] HID: i2c-hid: Reorganize so ACPI and OF are separate modules

In reply to Doug Anderson

Hi,

Quoted 62 lines · Doug Anderson

Hi,

Quoted 32 lines · Hans de Goede

Hi,

Quoted 18 lines · Douglas Anderson

This patch rejiggers the i2c-hid code so that the OF (Open Firmware aka Device Tree) and ACPI support is separated out a bit. The OF and ACPI drivers are now separate modules that wrap the core module.

Essentially, what we're doing here:
* Make "power up" and "power down" a function that can be (optionally) implemented by a given user of the i2c-hid core.
* The OF and ACPI modules are drivers on their own, so they implement probe / remove / suspend / resume / shutdown. The core code provides implementations that OF and ACPI can call into.

We'll organize this so that we now have 3 modules: the old i2c-hid module becomes the "core" module and two new modules will depend on it, handling probing the specific device.

As part of this work, we'll remove the i2c-hid "platform data" concept since it's not needed.

Quoted 9 lines

---

Changes in v5:
- Add shutdown_tail op and use it in ACPI.
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Quoted 7 lines

Thanks this looks good to now, 2 small remarks below (since you are going to do a v6 anyways). Feel free to ignore these remarks if you prefer to keep things as is.

And feel free to add my reviewed-by to v6 of this patch:

Thanks!

Quoted 11 lines

drivers/hid/i2c-hid/i2c-hid-acpi.c line 150

Quoted 6 lines
drivers/hid/i2c-hid/i2c-hid-acpi.c new file +6 -0
+static const struct i2c_device_id i2c_hid_acpi_id_table[] = {
+     { "hid", 0 },
+     { "hid-over-i2c", 0 },
+     { },
+};
+MODULE_DEVICE_TABLE(i2c, i2c_hid_acpi_id_table);

Hmm, I do not think these old-style i2c-ids are necessarry at all in this driver. I expect all use-cases to use either of or acpi matches.

Quoted 4 lines

This was already present in the code before though, so please ignore this remark. This is just something which I noticed and thought was worth while pointing out as a future cleanup.

Quoted 5 lines

Yeah, I wasn't sure if there was anyone using them.

Hrm. Thinking about it, though, is it really OK for two drivers to both have the same table listed? I'm not sure how that would work. Do you know?

Ah I missed that you are adding the i2c_device_id table to both the new -acpi and -of drivers.

That indeed is not a good idea.

Quoted 9 lines

I don't know a ton about ACPI, but for device tree I know i2c has a fallback mode. Specifically having this table means that we'll match compatible strings such as:

"zipzapzing,hid"
"kapowzers,hid-over-i2c"

In other words it'll ignore the vendor part and just match on the second half.

Yeah I know about that clever hack the i2c subsys has.

Quoted 5 lines

Just to make sure I wasn't remembering that from a dream
I tried it and it worked. I don't see any mainline device trees that look like that, though. I could delete it, though it doesn't really take up much space and it seems nice to keep it working in case anyone was relying on it?

Ack, so in the of case there is a reason to keep this. But ACPI binding does not use anything similar, so the old-style i2c_device_id table should probably be removed from the -acpi driver.

Quoted 38 lines

For ACPI is there a similar fallback? If not then it seems like it'd be easy to remove it from there...

Quoted 15 lines

<snip>

drivers/hid/i2c-hid/i2c-hid-core.c line 38

Quoted 11 lines
drivers/hid/i2c-hid/i2c-hid-core.c +0 -2
index aeff1ffb0c8b..9551ba96dc49 100644
@@ -35,12 +35,8 @@
 #include <linux/kernel.h>
 #include <linux/hid.h>
 #include <linux/mutex.h>
-#include <linux/acpi.h>
-#include <linux/of.h>
 #include <linux/regulator/consumer.h>

I think you can drop this regulator include here now too ?

Good point.

Quoted 15 lines
Quoted 5 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +0 -0
new file mode 100644
index 000000000000..15d533be2b24

<snip>

drivers/hid/i2c-hid/i2c-hid-of.c line 114

Quoted 3 lines
drivers/hid/i2c-hid/i2c-hid-of.c new file +3 -0
+static const struct dev_pm_ops i2c_hid_of_pm = {
+     SET_SYSTEM_SLEEP_PM_OPS(i2c_hid_core_suspend, i2c_hid_core_resume)
+};

This dev_pm_ops struct is identical to the one in i2c-hid-acpi.c and the one which you introduce later in i2c-hid-of-goodix.c is also identical, so that is 3 copies.

Quoted 4 lines
Quoted 2 lines

Maybe just put a shared dev_pm_ops struct in the i2c-core (and don't export the suspend/resume handlers) ?

Sounds good.

Regards,

Hans

#8 lore raw

PATCH v5 2/4 arm64: defconfig: Update config names for i2c-hid rejigger

In reply to Douglas Anderson

The i2c-hid driver has been split in two. Let's enable both halves.

---

(no changes since v4)

Changes in v4:
- ("arm64: defconfig: Update config names for i2c-hid rejigger") new for v4.

 arch/arm64/configs/defconfig | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
arch/arm64/configs/defconfig +2 -1
index 5cfe3cf6f2ac..9258d623331e 100644
@@ -725,7 +725,8 @@ CONFIG_SND_SOC_WM8904=m
 CONFIG_SND_SOC_WSA881X=m
 CONFIG_SND_SIMPLE_CARD=m
 CONFIG_SND_AUDIO_GRAPH_CARD=m
-CONFIG_I2C_HID=m
+CONFIG_I2C_HID_ACPI=m
+CONFIG_I2C_HID_OF=m
 CONFIG_USB_CONN_GPIO=m
 CONFIG_USB=y
 CONFIG_USB_OTG=y
Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog
#9 lore raw

PATCH v5 3/4 dt-bindings: input: HID: i2c-hid: Introduce bindings for the Goodix GT7375P

In reply to Douglas Anderson

This adds new bindings for the Goodix GT7375P touchscreen. While this touchscreen's communications are based on the generic "i2c-over-hid" protocol, it needs special power sequencing and thus gets its own compatible and bindings.

---

Changes in v5:
- Added mention of i2c-hid in the yaml itself as per Rob.
- Adjusted subject as per Rob.

Changes in v3:
- Fixed compatible in example.
- Removed Benjamin as a maintainer.
- Updated description.

Changes in v2:
- ("dt-bindings: HID: i2c-hid: Introduce bindings for the Goodix GT7375P") new in v2.

 .../bindings/input/goodix,gt7375p.yaml        | 65 +++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/input/goodix,gt7375p.yaml
Documentation/devicetree/bindings/input/goodix,gt7375p.yaml new file +65 -0
new file mode 100644
index 000000000000..fe1c5016f7f3
@@ -0,0 +1,65 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/input/goodix,gt7375p.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Goodix GT7375P touchscreen
+
+maintainers:
+  - Douglas Anderson <[email protected]>
+
+description:
+  Supports the Goodix GT7375P touchscreen.
+  This touchscreen uses the i2c-hid protocol but has some non-standard
+  power sequencing required.
+
+properties:
+  compatible:
+    items:
+      - const: goodix,gt7375p
+
+  reg:
+    enum:
+      - 0x5d
+      - 0x14
+
+  interrupts:
+    maxItems: 1
+
+  reset-gpios:
+    true
+
+  vdd-supply:
+    description: The 3.3V supply to the touchscreen.
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - reset-gpios
+  - vdd-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/qcom,rpmh.h>
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      ap_ts: touchscreen@5d {
+        compatible = "goodix,gt7375p";
+        reg = <0x5d>;
+
+        interrupt-parent = <&tlmm>;
+        interrupts = <9 IRQ_TYPE_LEVEL_LOW>;
+
+        reset-gpios = <&tlmm 8 GPIO_ACTIVE_LOW>;
+        vdd-supply = <&pp3300_ts>;
+      };
+    };
Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog
#10 lore raw

PATCH v5 4/4 HID: i2c-hid: Introduce goodix-i2c-hid using i2c-hid core

In reply to Douglas Anderson

Goodix i2c-hid touchscreens are mostly i2c-hid compliant but have some special power sequencing requirements, including the need to drive a reset line during the sequencing.

Let's use the new rejiggering of i2c-hid to support this with a thin wrapper driver to support the first Goodix i2c-hid touchscreen:
GT7375P

---

Changes in v5:
- i2chid_subclass_data => i2chid_ops.
- power_up_device => power_up (same with power_down).
- subclass => ops.

Changes in v4:
- Totally redid based on the new subclass system.

Changes in v3:
- Rework to use subclassing.

 drivers/hid/i2c-hid/Kconfig             |  19 +++-
 drivers/hid/i2c-hid/Makefile            |   1 +
 drivers/hid/i2c-hid/i2c-hid-of-goodix.c | 120 ++++++++++++++++++++++++
 3 files changed, 138 insertions(+), 2 deletions(-)
 create mode 100644 drivers/hid/i2c-hid/i2c-hid-of-goodix.c
drivers/hid/i2c-hid/Kconfig +17 -2
index 819b7521c182..a16c6a69680b 100644
@@ -32,10 +32,25 @@ config I2C_HID_OF
 	  will be called i2c-hid-of.  It will also build/depend on the
 	  module i2c-hid.
 
+config I2C_HID_OF_GOODIX
+	tristate "Driver for Goodix hid-i2c based devices on OF systems"
+	default n
+	depends on I2C && INPUT && OF
+	help
+	  Say Y here if you want support for Goodix i2c devices that use
+	  the i2c-hid protocol on Open Firmware (Device Tree)-based
+	  systems.
+
+	  If unsure, say N.
+
+	  This support is also available as a module.  If so, the module
+	  will be called i2c-hid-of-goodix.  It will also build/depend on
+	  the module i2c-hid.
+
 endmenu
 
 config I2C_HID_CORE
 	tristate
-	default y if I2C_HID_ACPI=y || I2C_HID_OF=y
-	default m if I2C_HID_ACPI=m || I2C_HID_OF=m
+	default y if I2C_HID_ACPI=y || I2C_HID_OF=y || I2C_HID_OF_GOODIX=y
+	default m if I2C_HID_ACPI=m || I2C_HID_OF=m || I2C_HID_OF_GOODIX=m
 	select HID
drivers/hid/i2c-hid/Makefile +1 -0
index 9b4a73446841..302545a771f3 100644
@@ -10,3 +10,4 @@ i2c-hid-$(CONFIG_DMI)				+= i2c-hid-dmi-quirks.o
 
 obj-$(CONFIG_I2C_HID_ACPI)			+= i2c-hid-acpi.o
 obj-$(CONFIG_I2C_HID_OF)			+= i2c-hid-of.o
+obj-$(CONFIG_I2C_HID_OF_GOODIX)			+= i2c-hid-of-goodix.o
drivers/hid/i2c-hid/i2c-hid-of-goodix.c new file +120 -0

120 lines not on this page · raw message

Signature · 1 line
2.29.2.222.g5d2a92d10f8-goog