diff mbox series

[v4] i2c: Add i2c_get_match_data()

Message ID 20230607165738.138357-1-biju.das.jz@bp.renesas.com (mailing list archive)
State Not Applicable, archived
Headers show
Series [v4] i2c: Add i2c_get_match_data() | expand

Commit Message

Biju Das June 7, 2023, 4:57 p.m. UTC
Add i2c_get_match_data() to get match data for I2C, ACPI and
DT-based matching, so that we can optimize the driver code.

Suggested-by: Geert Uytterhoeven <geert+renesas@glider.be>
Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
v3->v4:
 * Added support for ACPI matching as well by replacing of_device_
   get_match_data->device_get_match_data.
 * Removed Rb tag from Geert as there is change in logic.
v2->v3:
 * Added support for getting match data for both I2C and DT-based
   matching.
 * Added Rb tag from Geert and retained the Rb tag as change is trivial.
v1->v2:
 * Dropped parameter const struct i2c_device_id *id and the helper function.

eg: The RTC pcf85063/isl1208 driver code can be optimized with this patch.
-       if (client->dev.of_node) {
-                config = of_device_get_match_data(&client->dev);
-               if (!config)
-                       return -ENODEV;
-       } else {
-               enum pcf85063_type type =
-                       i2c_match_id(pcf85063_ids, client)->driver_data;
-               if (type >= PCF85063_LAST_ID)
-                       return -ENODEV;
-               config = &pcf85063_cfg[type];
-       }
+       config = i2c_get_match_data(client);
+       if (!config)
+               return -ENODEV;

similar case exists for adding I2C match support for the below clock drivers
along with already supported OF/ACPI based matching.

https://elixir.bootlin.com/linux/latest/source/drivers/clk/clk-renesas-pcie.c#L282
https://elixir.bootlin.com/linux/latest/source/drivers/clk/clk-versaclock5.c#L956
https://elixir.bootlin.com/linux/latest/source/drivers/clk/clk-versaclock7.c#L1111
---
 drivers/i2c/i2c-core-base.c | 20 ++++++++++++++++++++
 include/linux/i2c.h         |  2 ++
 2 files changed, 22 insertions(+)

Comments

Wolfram Sang June 9, 2023, 3:25 p.m. UTC | #1
On Wed, Jun 07, 2023 at 05:57:38PM +0100, Biju Das wrote:
> Add i2c_get_match_data() to get match data for I2C, ACPI and
> DT-based matching, so that we can optimize the driver code.
> 
> Suggested-by: Geert Uytterhoeven <geert+renesas@glider.be>
> Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>

No further comments, yet I like it, so:

Applied to for-next, thanks!

With one minor change, I hope you are okay with it:

> +	struct device_driver *drv = client->dev.driver;
> +	struct i2c_driver *driver = to_i2c_driver(drv);

Variables 'drv' and 'driver' sounds like it could cause confusion later.
I merged the two and eliminated 'drv' that way.
Biju Das June 9, 2023, 3:34 p.m. UTC | #2
Hi Wolfram Sang,

> Subject: Re: [PATCH v4] i2c: Add i2c_get_match_data()
> 
> On Wed, Jun 07, 2023 at 05:57:38PM +0100, Biju Das wrote:
> > Add i2c_get_match_data() to get match data for I2C, ACPI and DT-based
> > matching, so that we can optimize the driver code.
> >
> > Suggested-by: Geert Uytterhoeven <geert+renesas@glider.be>
> > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> 
> No further comments, yet I like it, so:
> 
> Applied to for-next, thanks!
> 
> With one minor change, I hope you are okay with it:
> 
> > +	struct device_driver *drv = client->dev.driver;
> > +	struct i2c_driver *driver = to_i2c_driver(drv);
> 
> Variables 'drv' and 'driver' sounds like it could cause confusion later.
> I merged the two and eliminated 'drv' that way.

Yes, it is much better.

Cheers,
Biju
diff mbox series

Patch

diff --git a/drivers/i2c/i2c-core-base.c b/drivers/i2c/i2c-core-base.c
index ae3af738b03f..040544b2ced4 100644
--- a/drivers/i2c/i2c-core-base.c
+++ b/drivers/i2c/i2c-core-base.c
@@ -114,6 +114,26 @@  const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
 }
 EXPORT_SYMBOL_GPL(i2c_match_id);
 
+const void *i2c_get_match_data(const struct i2c_client *client)
+{
+	struct device_driver *drv = client->dev.driver;
+	struct i2c_driver *driver = to_i2c_driver(drv);
+	const struct i2c_device_id *match;
+	const void *data;
+
+	data = device_get_match_data(&client->dev);
+	if (!data) {
+		match = i2c_match_id(driver->id_table, client);
+		if (!match)
+			return NULL;
+
+		data = (const void *)match->driver_data;
+	}
+
+	return data;
+}
+EXPORT_SYMBOL(i2c_get_match_data);
+
 static int i2c_device_match(struct device *dev, struct device_driver *drv)
 {
 	struct i2c_client	*client = i2c_verify_client(dev);
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index 13a1ce38cb0c..3430cc2b05a6 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -367,6 +367,8 @@  struct i2c_adapter *i2c_verify_adapter(struct device *dev);
 const struct i2c_device_id *i2c_match_id(const struct i2c_device_id *id,
 					 const struct i2c_client *client);
 
+const void *i2c_get_match_data(const struct i2c_client *client);
+
 static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
 {
 	struct device * const dev = kobj_to_dev(kobj);