Skip to contentSkip to conversation

i2c: designware: Make master module optional

PATCH In review Andy Shevchenko 3 participants 6 messages Mar 23, 2020 – Apr 15, 2020

Subsystems (3)
lore
Share & tools
lore

Andy Shevchenko

author reviewer
#0 lore raw

PATCH 1/2 i2c: designware: Make master module optional

In some cases we know that the controller will be always used in slave mode and master is just a bulk. In order to drop that, introduce a separate configuration parameter for master mode. Default it to core to avoid regressions.

---
 drivers/i2c/busses/Kconfig                  | 10 ++++++++++
 drivers/i2c/busses/Makefile                 |  5 ++++-
 drivers/i2c/busses/i2c-designware-core.h    | 19 ++++++++++++++++++-
 drivers/i2c/busses/i2c-designware-master.c  |  4 ++--
 drivers/i2c/busses/i2c-designware-pcidrv.c  |  2 +-
 drivers/i2c/busses/i2c-designware-platdrv.c |  6 +-----
 6 files changed, 36 insertions(+), 10 deletions(-)
drivers/i2c/busses/Kconfig +10 -0
index 2ddca08f8a76..1df238ff8dd0 100644
@@ -527,6 +527,16 @@ config I2C_DAVINCI
 config I2C_DESIGNWARE_CORE
 	tristate
 
+config I2C_DESIGNWARE_MASTER
+	bool "Synopsys DesignWare Master"
+	default I2C_DESIGNWARE_CORE
+	help
+	  If you say yes to this option, support will be included for the
+	  Synopsys DesignWare I2C master adapter.
+
+	  This is not a standalone module, this module compiles together with
+	  i2c-designware-core.
+
 config I2C_DESIGNWARE_PLATFORM
 	tristate "Synopsys DesignWare Platform"
 	select I2C_DESIGNWARE_CORE
drivers/i2c/busses/Makefile +4 -1
index 25d60889713c..829731d4a1f9 100644
@@ -49,7 +49,10 @@ obj-$(CONFIG_I2C_CBUS_GPIO)	+= i2c-cbus-gpio.o
 obj-$(CONFIG_I2C_CPM)		+= i2c-cpm.o
 obj-$(CONFIG_I2C_DAVINCI)	+= i2c-davinci.o
 obj-$(CONFIG_I2C_DESIGNWARE_CORE)	+= i2c-designware-core.o
-i2c-designware-core-objs := i2c-designware-common.o i2c-designware-master.o
+i2c-designware-core-objs := i2c-designware-common.o
+ifeq ($(CONFIG_I2C_DESIGNWARE_MASTER),y)
+i2c-designware-core-objs += i2c-designware-master.o
+endif
 ifeq ($(CONFIG_I2C_DESIGNWARE_SLAVE),y)
 i2c-designware-core-objs += i2c-designware-slave.o
 endif
drivers/i2c/busses/i2c-designware-core.h +18 -1
index b220ad64c38d..2d34c15dca75 100644
@@ -314,13 +314,30 @@ static inline void __i2c_dw_disable_nowait(struct dw_i2c_dev *dev)
 
 void __i2c_dw_disable(struct dw_i2c_dev *dev);
 
-extern int i2c_dw_probe(struct dw_i2c_dev *dev);
+#if IS_ENABLED(CONFIG_I2C_DESIGNWARE_MASTER)
+extern int i2c_dw_probe_master(struct dw_i2c_dev *dev);
+#else
+static inline int i2c_dw_probe_master(struct dw_i2c_dev *dev) { return -EINVAL; }
+#endif
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_SLAVE)
 extern int i2c_dw_probe_slave(struct dw_i2c_dev *dev);
 #else
 static inline int i2c_dw_probe_slave(struct dw_i2c_dev *dev) { return -EINVAL; }
 #endif
 
+static inline int i2c_dw_probe(struct dw_i2c_dev *dev)
+{
+	switch (dev->mode) {
+	case DW_IC_SLAVE:
+		return i2c_dw_probe_slave(dev);
+	case DW_IC_MASTER:
+		return i2c_dw_probe_master(dev);
+	default:
+		dev_err(dev->dev, "Wrong operation mode: %d\n", dev->mode);
+		return -EINVAL;
+	}
+}
+
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_BAYTRAIL)
 extern int i2c_dw_probe_lock_support(struct dw_i2c_dev *dev);
 #else
drivers/i2c/busses/i2c-designware-master.c +2 -2
index 3a58eef20936..9d2af87f45f1 100644
@@ -678,7 +678,7 @@ static int i2c_dw_init_recovery_info(struct dw_i2c_dev *dev)
 	return 0;
 }
 
-int i2c_dw_probe(struct dw_i2c_dev *dev)
+int i2c_dw_probe_master(struct dw_i2c_dev *dev)
 {
 	struct i2c_adapter *adap = &dev->adapter;
 	unsigned long irq_flags;
@@ -745,7 +745,7 @@ int i2c_dw_probe(struct dw_i2c_dev *dev)
 
 	return ret;
 }
-EXPORT_SYMBOL_GPL(i2c_dw_probe);
+EXPORT_SYMBOL_GPL(i2c_dw_probe_master);
 
 MODULE_DESCRIPTION("Synopsys DesignWare I2C bus master adapter");
 MODULE_LICENSE("GPL");
drivers/i2c/busses/i2c-designware-pcidrv.c +1 -1
index 7a0b65b5b5b5..cbab5346e311 100644
@@ -290,7 +290,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
 	ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
 	adap->nr = controller->bus_num;
 
-	r = i2c_dw_probe(dev);
+	r = i2c_dw_probe_master(dev);
 	if (r) {
 		pci_free_irq_vectors(pdev);
 		return r;
drivers/i2c/busses/i2c-designware-platdrv.c +1 -5
index c98befe2a92e..0edcebe2168f 100644
@@ -371,11 +371,7 @@ static int dw_i2c_plat_probe(struct platform_device *pdev)
 
 	pm_runtime_enable(&pdev->dev);
 
-	if (dev->mode == DW_IC_SLAVE)
-		ret = i2c_dw_probe_slave(dev);
-	else
-		ret = i2c_dw_probe(dev);
-
+	ret = i2c_dw_probe(dev);
 	if (ret)
 		goto exit_probe;
 
Signature · 1 line
2.25.1
author reviewer
#1 lore raw

PATCH 2/2 i2c: designware: Move configuration routines to respective modules

Move configuration routines to respective modules, i.e. master and slave.

---
 drivers/i2c/busses/i2c-designware-core.h    | 12 +++++++
 drivers/i2c/busses/i2c-designware-master.c  | 24 +++++++++++++
 drivers/i2c/busses/i2c-designware-platdrv.c | 38 +--------------------
 drivers/i2c/busses/i2c-designware-slave.c   | 11 ++++++
 4 files changed, 48 insertions(+), 37 deletions(-)
drivers/i2c/busses/i2c-designware-core.h +12 -0
index 2d34c15dca75..ba04fa91de0c 100644
@@ -315,13 +315,17 @@ static inline void __i2c_dw_disable_nowait(struct dw_i2c_dev *dev)
 void __i2c_dw_disable(struct dw_i2c_dev *dev);
 
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_MASTER)
+extern void i2c_dw_configure_master(struct dw_i2c_dev *dev);
 extern int i2c_dw_probe_master(struct dw_i2c_dev *dev);
 #else
+static inline void i2c_dw_configure_master(struct dw_i2c_dev *dev) { }
 static inline int i2c_dw_probe_master(struct dw_i2c_dev *dev) { return -EINVAL; }
 #endif
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_SLAVE)
+extern void i2c_dw_configure_slave(struct dw_i2c_dev *dev);
 extern int i2c_dw_probe_slave(struct dw_i2c_dev *dev);
 #else
+static inline void i2c_dw_configure_slave(struct dw_i2c_dev *dev) { }
 static inline int i2c_dw_probe_slave(struct dw_i2c_dev *dev) { return -EINVAL; }
 #endif
 
@@ -338,6 +342,14 @@ static inline int i2c_dw_probe(struct dw_i2c_dev *dev)
 	}
 }
 
+static inline void i2c_dw_configure(struct dw_i2c_dev *dev)
+{
+	if (i2c_detect_slave_mode(dev->dev))
+		i2c_dw_configure_slave(dev);
+	else
+		i2c_dw_configure_master(dev);
+}
+
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_BAYTRAIL)
 extern int i2c_dw_probe_lock_support(struct dw_i2c_dev *dev);
 #else
drivers/i2c/busses/i2c-designware-master.c +24 -0
index 9d2af87f45f1..66ada723d740 100644
@@ -632,6 +632,30 @@ static irqreturn_t i2c_dw_isr(int this_irq, void *dev_id)
 	return IRQ_HANDLED;
 }
 
+void i2c_dw_configure_master(struct dw_i2c_dev *dev)
+{
+	struct i2c_timings *t = &dev->timings;
+
+	dev->functionality = I2C_FUNC_10BIT_ADDR | DW_IC_DEFAULT_FUNCTIONALITY;
+
+	dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
+			  DW_IC_CON_RESTART_EN;
+
+	dev->mode = DW_IC_MASTER;
+
+	switch (t->bus_freq_hz) {
+	case I2C_MAX_STANDARD_MODE_FREQ:
+		dev->master_cfg |= DW_IC_CON_SPEED_STD;
+		break;
+	case I2C_MAX_HIGH_SPEED_MODE_FREQ:
+		dev->master_cfg |= DW_IC_CON_SPEED_HIGH;
+		break;
+	default:
+		dev->master_cfg |= DW_IC_CON_SPEED_FAST;
+	}
+}
+EXPORT_SYMBOL_GPL(i2c_dw_configure_master);
+
 static void i2c_dw_prepare_recovery(struct i2c_adapter *adap)
 {
 	struct dw_i2c_dev *dev = i2c_get_adapdata(adap);
drivers/i2c/busses/i2c-designware-platdrv.c +1 -37
index 0edcebe2168f..6da7f14cba62 100644
@@ -186,39 +186,6 @@ static inline int dw_i2c_of_configure(struct platform_device *pdev)
 }
 #endif
 
-static void i2c_dw_configure_master(struct dw_i2c_dev *dev)
-{
-	struct i2c_timings *t = &dev->timings;
-
-	dev->functionality = I2C_FUNC_10BIT_ADDR | DW_IC_DEFAULT_FUNCTIONALITY;
-
-	dev->master_cfg = DW_IC_CON_MASTER | DW_IC_CON_SLAVE_DISABLE |
-			  DW_IC_CON_RESTART_EN;
-
-	dev->mode = DW_IC_MASTER;
-
-	switch (t->bus_freq_hz) {
-	case I2C_MAX_STANDARD_MODE_FREQ:
-		dev->master_cfg |= DW_IC_CON_SPEED_STD;
-		break;
-	case I2C_MAX_HIGH_SPEED_MODE_FREQ:
-		dev->master_cfg |= DW_IC_CON_SPEED_HIGH;
-		break;
-	default:
-		dev->master_cfg |= DW_IC_CON_SPEED_FAST;
-	}
-}
-
-static void i2c_dw_configure_slave(struct dw_i2c_dev *dev)
-{
-	dev->functionality = I2C_FUNC_SLAVE | DW_IC_DEFAULT_FUNCTIONALITY;
-
-	dev->slave_cfg = DW_IC_CON_RX_FIFO_FULL_HLD_CTRL |
-			 DW_IC_CON_RESTART_EN | DW_IC_CON_STOP_DET_IFADDRESSED;
-
-	dev->mode = DW_IC_SLAVE;
-}
-
 static void dw_i2c_plat_pm_cleanup(struct dw_i2c_dev *dev)
 {
 	pm_runtime_disable(dev->dev);
@@ -323,10 +290,7 @@ static int dw_i2c_plat_probe(struct platform_device *pdev)
 	if (ret)
 		goto exit_reset;
 
-	if (i2c_detect_slave_mode(&pdev->dev))
-		i2c_dw_configure_slave(dev);
-	else
-		i2c_dw_configure_master(dev);
+	i2c_dw_configure(dev);
 
 	/* Optional interface clock */
 	dev->pclk = devm_clk_get_optional(&pdev->dev, "pclk");
drivers/i2c/busses/i2c-designware-slave.c +11 -0
index f5ecf76c0d02..576e7af4e94b 100644
@@ -241,6 +241,17 @@ static const struct i2c_algorithm i2c_dw_algo = {
 	.unreg_slave = i2c_dw_unreg_slave,
 };
 
+void i2c_dw_configure_slave(struct dw_i2c_dev *dev)
+{
+	dev->functionality = I2C_FUNC_SLAVE | DW_IC_DEFAULT_FUNCTIONALITY;
+
+	dev->slave_cfg = DW_IC_CON_RX_FIFO_FULL_HLD_CTRL |
+			 DW_IC_CON_RESTART_EN | DW_IC_CON_STOP_DET_IFADDRESSED;
+
+	dev->mode = DW_IC_SLAVE;
+}
+EXPORT_SYMBOL_GPL(i2c_dw_configure_slave);
+
 int i2c_dw_probe_slave(struct dw_i2c_dev *dev)
 {
 	struct i2c_adapter *adap = &dev->adapter;
Signature · 1 line
2.25.1
author reviewer
#2 lore raw
In reply to Andy Shevchenko
Quoted 4 lines · Andy Shevchenko

In some cases we know that the controller will be always used in slave mode and master is just a bulk. In order to drop that, introduce a separate configuration parameter for master mode. Default it to core to avoid regressions.

This series depends to [1] "Provide generic definitions for bus frequencies".

[1]: http://patchwork.ozlabs.org/patch/1259203/

Quoted 138 lines
---
 drivers/i2c/busses/Kconfig                  | 10 ++++++++++
 drivers/i2c/busses/Makefile                 |  5 ++++-
 drivers/i2c/busses/i2c-designware-core.h    | 19 ++++++++++++++++++-
 drivers/i2c/busses/i2c-designware-master.c  |  4 ++--
 drivers/i2c/busses/i2c-designware-pcidrv.c  |  2 +-
 drivers/i2c/busses/i2c-designware-platdrv.c |  6 +-----
 6 files changed, 36 insertions(+), 10 deletions(-)
drivers/i2c/busses/Kconfig +10 -0
index 2ddca08f8a76..1df238ff8dd0 100644
@@ -527,6 +527,16 @@ config I2C_DAVINCI
 config I2C_DESIGNWARE_CORE
 	tristate
 
+config I2C_DESIGNWARE_MASTER
+	bool "Synopsys DesignWare Master"
+	default I2C_DESIGNWARE_CORE
+	help
+	  If you say yes to this option, support will be included for the
+	  Synopsys DesignWare I2C master adapter.
+
+	  This is not a standalone module, this module compiles together with
+	  i2c-designware-core.
+
 config I2C_DESIGNWARE_PLATFORM
 	tristate "Synopsys DesignWare Platform"
 	select I2C_DESIGNWARE_CORE
drivers/i2c/busses/Makefile +4 -1
index 25d60889713c..829731d4a1f9 100644
@@ -49,7 +49,10 @@ obj-$(CONFIG_I2C_CBUS_GPIO)	+= i2c-cbus-gpio.o
 obj-$(CONFIG_I2C_CPM)		+= i2c-cpm.o
 obj-$(CONFIG_I2C_DAVINCI)	+= i2c-davinci.o
 obj-$(CONFIG_I2C_DESIGNWARE_CORE)	+= i2c-designware-core.o
-i2c-designware-core-objs := i2c-designware-common.o i2c-designware-master.o
+i2c-designware-core-objs := i2c-designware-common.o
+ifeq ($(CONFIG_I2C_DESIGNWARE_MASTER),y)
+i2c-designware-core-objs += i2c-designware-master.o
+endif
 ifeq ($(CONFIG_I2C_DESIGNWARE_SLAVE),y)
 i2c-designware-core-objs += i2c-designware-slave.o
 endif
drivers/i2c/busses/i2c-designware-core.h +18 -1
index b220ad64c38d..2d34c15dca75 100644
@@ -314,13 +314,30 @@ static inline void __i2c_dw_disable_nowait(struct dw_i2c_dev *dev)
 
 void __i2c_dw_disable(struct dw_i2c_dev *dev);
 
-extern int i2c_dw_probe(struct dw_i2c_dev *dev);
+#if IS_ENABLED(CONFIG_I2C_DESIGNWARE_MASTER)
+extern int i2c_dw_probe_master(struct dw_i2c_dev *dev);
+#else
+static inline int i2c_dw_probe_master(struct dw_i2c_dev *dev) { return -EINVAL; }
+#endif
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_SLAVE)
 extern int i2c_dw_probe_slave(struct dw_i2c_dev *dev);
 #else
 static inline int i2c_dw_probe_slave(struct dw_i2c_dev *dev) { return -EINVAL; }
 #endif
 
+static inline int i2c_dw_probe(struct dw_i2c_dev *dev)
+{
+	switch (dev->mode) {
+	case DW_IC_SLAVE:
+		return i2c_dw_probe_slave(dev);
+	case DW_IC_MASTER:
+		return i2c_dw_probe_master(dev);
+	default:
+		dev_err(dev->dev, "Wrong operation mode: %d\n", dev->mode);
+		return -EINVAL;
+	}
+}
+
 #if IS_ENABLED(CONFIG_I2C_DESIGNWARE_BAYTRAIL)
 extern int i2c_dw_probe_lock_support(struct dw_i2c_dev *dev);
 #else
drivers/i2c/busses/i2c-designware-master.c +2 -2
index 3a58eef20936..9d2af87f45f1 100644
@@ -678,7 +678,7 @@ static int i2c_dw_init_recovery_info(struct dw_i2c_dev *dev)
 	return 0;
 }
 
-int i2c_dw_probe(struct dw_i2c_dev *dev)
+int i2c_dw_probe_master(struct dw_i2c_dev *dev)
 {
 	struct i2c_adapter *adap = &dev->adapter;
 	unsigned long irq_flags;
@@ -745,7 +745,7 @@ int i2c_dw_probe(struct dw_i2c_dev *dev)
 
 	return ret;
 }
-EXPORT_SYMBOL_GPL(i2c_dw_probe);
+EXPORT_SYMBOL_GPL(i2c_dw_probe_master);
 
 MODULE_DESCRIPTION("Synopsys DesignWare I2C bus master adapter");
 MODULE_LICENSE("GPL");
drivers/i2c/busses/i2c-designware-pcidrv.c +1 -1
index 7a0b65b5b5b5..cbab5346e311 100644
@@ -290,7 +290,7 @@ static int i2c_dw_pci_probe(struct pci_dev *pdev,
 	ACPI_COMPANION_SET(&adap->dev, ACPI_COMPANION(&pdev->dev));
 	adap->nr = controller->bus_num;
 
-	r = i2c_dw_probe(dev);
+	r = i2c_dw_probe_master(dev);
 	if (r) {
 		pci_free_irq_vectors(pdev);
 		return r;
drivers/i2c/busses/i2c-designware-platdrv.c +1 -5
index c98befe2a92e..0edcebe2168f 100644
@@ -371,11 +371,7 @@ static int dw_i2c_plat_probe(struct platform_device *pdev)
 
 	pm_runtime_enable(&pdev->dev);
 
-	if (dev->mode == DW_IC_SLAVE)
-		ret = i2c_dw_probe_slave(dev);
-	else
-		ret = i2c_dw_probe(dev);
-
+	ret = i2c_dw_probe(dev);
 	if (ret)
 		goto exit_probe;
 
Signature · 1 line
2.25.1
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw
In reply to Andy Shevchenko
Quoted 22 lines · Andy Shevchenko

In some cases we know that the controller will be always used in slave mode and master is just a bulk. In order to drop that, introduce a separate configuration parameter for master mode. Default it to core to avoid regressions.

---
  drivers/i2c/busses/Kconfig                  | 10 ++++++++++
  drivers/i2c/busses/Makefile                 |  5 ++++-
  drivers/i2c/busses/i2c-designware-core.h    | 19 ++++++++++++++++++-
  drivers/i2c/busses/i2c-designware-master.c  |  4 ++--
  drivers/i2c/busses/i2c-designware-pcidrv.c  |  2 +-
  drivers/i2c/busses/i2c-designware-platdrv.c |  6 +-----
  6 files changed, 36 insertions(+), 10 deletions(-)
drivers/i2c/busses/Kconfig +0 -0
index 2ddca08f8a76..1df238ff8dd0 100644
@@ -527,6 +527,16 @@ config I2C_DAVINCI
  config I2C_DESIGNWARE_CORE
  	tristate
 

drivers/i2c/busses/Kconfig config I2C_DAVINCI · line 539

Quoted 10 lines
drivers/i2c/busses/Kconfig +10 -0
+config I2C_DESIGNWARE_MASTER
+	bool "Synopsys DesignWare Master"
+	default I2C_DESIGNWARE_CORE
+	help
+	  If you say yes to this option, support will be included for the
+	  Synopsys DesignWare I2C master adapter.
+
+	  This is not a standalone module, this module compiles together with
+	  i2c-designware-core.
+

I think we should go to a opposite direction - reduce the number of I2C_DESIGNWARE_ config options rather than add new ones. We already have 5 config options for it.

Size of i2c-designware-core.ko is around 12 kB with all master, slave and Baytrail semaphore code built in so I don't think it justifies the added config complexity. I think distributions will have anyway all of those options set.

Having those code in separate modules and load only when needed might make sense as that would save a few kB of RAM.

Signature · 1 line
Jarkko
author reviewer
#4 lore raw
Quoted 5 lines · Jarkko Nikula
Quoted 3 lines · Andy Shevchenko

In some cases we know that the controller will be always used in slave mode and master is just a bulk. In order to drop that, introduce a separate configuration parameter for master mode. Default it to core to avoid regressions.

Quoted 8 lines

I think we should go to a opposite direction - reduce the number of I2C_DESIGNWARE_ config options rather than add new ones. We already have 5 config options for it.

Size of i2c-designware-core.ko is around 12 kB with all master, slave and Baytrail semaphore code built in so I don't think it justifies the added config complexity. I think distributions will have anyway all of those options set.

I would rather go with conditional based on I²C generic options, like I2C_SLAVE. Do we have something similar for master?

Quoted 2 lines

Having those code in separate modules and load only when needed might make sense as that would save a few kB of RAM.

...which makes sense for embedded systems where exactly the device represents I²C slave.

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#5 lore raw
Quoted 8 lines
Quoted 5 lines

Size of i2c-designware-core.ko is around 12 kB with all master, slave and Baytrail semaphore code built in so I don't think it justifies the added config complexity. I think distributions will have anyway all of those options set.

I would rather go with conditional based on I²C generic options, like I2C_SLAVE. Do we have something similar for master?

No, we don't have that.

Quoted 6 lines
Quoted 3 lines

Having those code in separate modules and load only when needed might make sense as that would save a few kB of RAM.

...which makes sense for embedded systems where exactly the device represents I²C slave.

Frankly: an I2C-slave-only embedded system which runs a modern Linux and cannot afford those few KB on a core feature it needs? If so, maybe it should have an out-of-tree patch to achieve this. I don't think it is worth the added complexity for the upstream version.

Sidenote: There is a lot more overhead in the i2c-core. I think the complexity to move out stuff there is even more messy.

Disclaimer: you may prove me wrong, of course :)