[PATCH v3 2/3] HID: i2c-hid: Allow subclasses of i2c-hid for power sequencing

Douglas Anderson
2020-11-03T00:13:12Z

This exports some things from i2c-hid so that we can have a driver
that's effectively a subclass of it and that can do its own power
sequencing.

Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

Changes in v3:
- Rework to use subclassing.

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

drivers/hid/i2c-hid/i2c-hid-core.c | 78 +++++++++++++++++----------
include/linux/input/i2c-hid-core.h | 19 +++++++
include/linux/platform_data/i2c-hid.h | 9 ++++
3 files changed, 79 insertions(+), 27 deletions(-)
create mode 100644 include/linux/input/i2c-hid-core.h

diff --git a/drivers/hid/i2c-hid/i2c-hid-core.c b/drivers/hid/i2c-hid/i2c-hid-core.c
index 786e3e9af1c9..910e9089fcf8 100644
--- a/drivers/hid/i2c-hid/i2c-hid-core.c
+++ b/drivers/hid/i2c-hid/i2c-hid-core.c
@@ -22,6 +22,7 @@
#include <linux/i2c.h>
#include <linux/interrupt.h>
#include <linux/input.h>
+#include <linux/input/i2c-hid-core.h>
#include <linux/irq.h>
#include <linux/delay.h>
#include <linux/slab.h>
@@ -1007,8 +1008,33 @@ static void i2c_hid_fwnode_probe(struct i2c_client *client,
pdata->post_power_delay_ms = val;
}

-static int i2c_hid_probe(struct i2c_client *client,
- const struct i2c_device_id *dev_id)
+static int i2c_hid_power_up_device(struct i2c_hid_platform_data *pdata)
+{
+ struct i2c_hid *ihid = container_of(pdata, struct i2c_hid, pdata);
+ struct hid_device *hid = ihid->hid;
+ int ret;
+
+ ret = regulator_bulk_enable(ARRAY_SIZE(pdata->supplies),
+ pdata->supplies);
+ if (ret) {
+ if (hid)
+ hid_warn(hid, "Failed to enable supplies: %d\n", ret);
+ return ret;
+ }
+
+ if (pdata->post_power_delay_ms)
+ msleep(pdata->post_power_delay_ms);
+
+ return 0;
+}
+
+static void i2c_hid_power_down_device(struct i2c_hid_platform_data *pdata)
+{
+ regulator_bulk_disable(ARRAY_SIZE(pdata->supplies), pdata->supplies);
+}
+
+int i2c_hid_probe(struct i2c_client *client,
+ const struct i2c_device_id *dev_id)
{
int ret;
struct i2c_hid *ihid;
@@ -1035,6 +1061,9 @@ static int i2c_hid_probe(struct i2c_client *client,
if (!ihid)
return -ENOMEM;

+ if (platform_data)
+ ihid->pdata = *platform_data;
+
if (client->dev.of_node) {
ret = i2c_hid_of_probe(client, &ihid->pdata);
if (ret)
@@ -1043,13 +1072,16 @@ static int i2c_hid_probe(struct i2c_client *client,
ret = i2c_hid_acpi_pdata(client, &ihid->pdata);
if (ret)
return ret;
- } else {
- ihid->pdata = *platform_data;
}

/* Parse platform agnostic common properties from ACPI / device tree */
i2c_hid_fwnode_probe(client, &ihid->pdata);

+ if (!ihid->pdata.power_up_device)
+ ihid->pdata.power_up_device = i2c_hid_power_up_device;
+ if (!ihid->pdata.power_down_device)
+ ihid->pdata.power_down_device = i2c_hid_power_down_device;
+
ihid->pdata.supplies[0].supply = "vdd";
ihid->pdata.supplies[1].supply = "vddl";

@@ -1059,14 +1091,10 @@ static int i2c_hid_probe(struct i2c_client *client,
if (ret)
return ret;

- ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
- ihid->pdata.supplies);
- if (ret < 0)
+ ret = ihid->pdata.power_up_device(&ihid->pdata);
+ if (ret)
return ret;

- if (ihid->pdata.post_power_delay_ms)
- msleep(ihid->pdata.post_power_delay_ms);
-
i2c_set_clientdata(client, ihid);

ihid->client = client;
@@ -1144,13 +1172,13 @@ static int i2c_hid_probe(struct i2c_client *client,
free_irq(client->irq, ihid);

err_regulator:
- regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
- ihid->pdata.supplies);
+ ihid->pdata.power_down_device(&ihid->pdata);
i2c_hid_free_buffers(ihid);
return ret;
}
+EXPORT_SYMBOL_GPL(i2c_hid_probe);

-static int i2c_hid_remove(struct i2c_client *client)
+int i2c_hid_remove(struct i2c_client *client)
{
struct i2c_hid *ihid = i2c_get_clientdata(client);
struct hid_device *hid;
@@ -1163,22 +1191,23 @@ static int i2c_hid_remove(struct i2c_client *client)
if (ihid->bufsize)
i2c_hid_free_buffers(ihid);

- regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
- ihid->pdata.supplies);
+ ihid->pdata.power_down_device(&ihid->pdata);

return 0;
}
+EXPORT_SYMBOL_GPL(i2c_hid_remove);

-static void i2c_hid_shutdown(struct i2c_client *client)
+void i2c_hid_shutdown(struct i2c_client *client)
{
struct i2c_hid *ihid = i2c_get_clientdata(client);

i2c_hid_set_power(client, I2C_HID_PWR_SLEEP);
free_irq(client->irq, ihid);
}
+EXPORT_SYMBOL_GPL(i2c_hid_shutdown);

#ifdef CONFIG_PM_SLEEP
-static int i2c_hid_suspend(struct device *dev)
+int i2c_hid_suspend(struct device *dev)
{
struct i2c_client *client = to_i2c_client(dev);
struct i2c_hid *ihid = i2c_get_clientdata(client);
@@ -1205,14 +1234,14 @@ static int i2c_hid_suspend(struct device *dev)
hid_warn(hid, "Failed to enable irq wake: %d\n",
wake_status);
} else {
- regulator_bulk_disable(ARRAY_SIZE(ihid->pdata.supplies),
- ihid->pdata.supplies);
+ ihid->pdata.power_down_device(&ihid->pdata);
}

return 0;
}
+EXPORT_SYMBOL_GPL(i2c_hid_suspend);

-static int i2c_hid_resume(struct device *dev)
+int i2c_hid_resume(struct device *dev)
{
int ret;
struct i2c_client *client = to_i2c_client(dev);
@@ -1221,13 +1250,7 @@ static int i2c_hid_resume(struct device *dev)
int wake_status;

if (!device_may_wakeup(&client->dev)) {
- ret = regulator_bulk_enable(ARRAY_SIZE(ihid->pdata.supplies),
- ihid->pdata.supplies);
- if (ret)
- hid_warn(hid, "Failed to enable supplies: %d\n", ret);
-
- if (ihid->pdata.post_power_delay_ms)
- msleep(ihid->pdata.post_power_delay_ms);
+ ihid->pdata.power_up_device(&ihid->pdata);
} else if (ihid->irq_wake_enabled) {
wake_status = disable_irq_wake(client->irq);
if (!wake_status)
@@ -1262,6 +1285,7 @@ static int i2c_hid_resume(struct device *dev)

return 0;
}
+EXPORT_SYMBOL_GPL(i2c_hid_resume);
#endif

static const struct dev_pm_ops i2c_hid_pm = {
diff --git a/include/linux/input/i2c-hid-core.h b/include/linux/input/i2c-hid-core.h
new file mode 100644
index 000000000000..da7b0475f6f4
--- /dev/null
+++ b/include/linux/input/i2c-hid-core.h
@@ -0,0 +1,19 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+
+#ifndef I2C_HID_CORE_H
+#define I2C_HID_CORE_H
+
+#include <linux/i2c.h>
+
+int i2c_hid_probe(struct i2c_client *client,
+ const struct i2c_device_id *dev_id);
+int i2c_hid_remove(struct i2c_client *client);
+
+void i2c_hid_shutdown(struct i2c_client *client);
+
+#ifdef CONFIG_PM_SLEEP
+int i2c_hid_suspend(struct device *dev);
+int i2c_hid_resume(struct device *dev);
+#endif
+
+#endif
diff --git a/include/linux/platform_data/i2c-hid.h b/include/linux/platform_data/i2c-hid.h
index c628bb5e1061..db567463d43e 100644
--- a/include/linux/platform_data/i2c-hid.h
+++ b/include/linux/platform_data/i2c-hid.h
@@ -21,6 +21,11 @@
* @supplies: regulators for powering on the device.
* @post_power_delay_ms: delay after powering on before device is usable.
*
+ * @power_up_device: do sequencing to power up the device; may use the above
+ * supplies / post_power_delay_ms or ignore.
+ * @power_down_device: do sequencing to power down the device.
+ * @power_data: opaque pointer that power_up and power_down can use.
+ *
* Note that it is the responsibility of the platform driver (or the acpi 5.0
* driver, or the flattened device tree) to setup the irq related to the gpio in
* the struct i2c_board_info.
@@ -36,6 +41,10 @@ struct i2c_hid_platform_data {
u16 hid_descriptor_address;
struct regulator_bulk_data supplies[2];
int post_power_delay_ms;
+
+ int (*power_up_device)(struct i2c_hid_platform_data *pdata);
+ void (*power_down_device)(struct i2c_hid_platform_data *pdata);
+ void *power_data;
};

#endif /* __LINUX_I2C_HID_H */
--
2.29.1.341.ge80a0c044ae-goog