Skip to contentSkip to conversation

i2c: designware: Consolidate PM ops

PATCH Superseded Andy Shevchenko 2 participants 3 messages Aug 23, 2024 – Aug 26, 2024

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Andy Shevchenko

author reviewer
#0 lore raw

PATCH 1/1 i2c: designware: Consolidate PM ops

We have the same (*) PM ops in the PCI and plaform drivers. Instead, consolidate that PM ops under exported variable and deduplicate them.

*)
With the subtle ACPI and P-Unit behaviour differences in PCI case. But this is not a problem as for ACPI we need to take care of the P-Unit semaphore anyway and calling PM ops for PCI makes sense as it might provide specific operation regions in ACPI (however there are no known devices on market that are using it with PCI enabled I2C). Note, the clocks are not in use in the PCI case.

---

This is just a split of a single patch from bigger series [1]. It was made in no functionality change manner, except the PCI case described above. But since it touches PM and it was an area where regressions were observed I would like to have a formal Tested-by from AMD people to make sure we don't break their setup / configurations.

 drivers/i2c/busses/i2c-designware-common.c  | 62 +++++++++++++++++++++
 drivers/i2c/busses/i2c-designware-core.h    |  3 +
 drivers/i2c/busses/i2c-designware-pcidrv.c  | 44 +--------------
 drivers/i2c/busses/i2c-designware-platdrv.c | 62 ---------------------
 4 files changed, 67 insertions(+), 104 deletions(-)
drivers/i2c/busses/i2c-designware-common.c +62 -0
index b60c55587e48..fb65fe6d8122 100644
@@ -21,6 +21,7 @@
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/of.h>
+#include <linux/pm.h>
 #include <linux/pm_runtime.h>
 #include <linux/property.h>
 #include <linux/regmap.h>
@@ -736,5 +737,66 @@ void i2c_dw_disable(struct dw_i2c_dev *dev)
 }
 EXPORT_SYMBOL_GPL(i2c_dw_disable);
 
+static int i2c_dw_prepare(struct device *device)
+{
+	/*
+	 * If the ACPI companion device object is present for this device,
+	 * it may be accessed during suspend and resume of other devices via
+	 * I2C operation regions, so tell the PM core and middle layers to
+	 * avoid skipping system suspend/resume callbacks for it in that case.
+	 */
+	return !has_acpi_companion(device);
+}
+
+static int i2c_dw_runtime_suspend(struct device *device)
+{
+	struct dw_i2c_dev *dev = dev_get_drvdata(device);
+
+	if (dev->shared_with_punit)
+		return 0;
+
+	i2c_dw_disable(dev);
+	i2c_dw_prepare_clk(dev, false);
+
+	return 0;
+}
+
+static int i2c_dw_suspend(struct device *device)
+{
+	struct dw_i2c_dev *dev = dev_get_drvdata(device);
+
+	i2c_mark_adapter_suspended(&dev->adapter);
+
+	return i2c_dw_runtime_suspend(device);
+}
+
+static int i2c_dw_runtime_resume(struct device *device)
+{
+	struct dw_i2c_dev *dev = dev_get_drvdata(device);
+
+	if (!dev->shared_with_punit)
+		i2c_dw_prepare_clk(dev, true);
+
+	dev->init(dev);
+
+	return 0;
+}
+
+static int i2c_dw_resume(struct device *device)
+{
+	struct dw_i2c_dev *dev = dev_get_drvdata(device);
+
+	i2c_dw_runtime_resume(device);
+	i2c_mark_adapter_resumed(&dev->adapter);
+
+	return 0;
+}
+
+EXPORT_GPL_DEV_PM_OPS(i2c_dw_dev_pm_ops) = {
+	.prepare = pm_sleep_ptr(i2c_dw_prepare),
+	LATE_SYSTEM_SLEEP_PM_OPS(i2c_dw_suspend, i2c_dw_resume)
+	RUNTIME_PM_OPS(i2c_dw_runtime_suspend, i2c_dw_runtime_resume, NULL)
+};
+
 MODULE_DESCRIPTION("Synopsys DesignWare I2C bus adapter core");
 MODULE_LICENSE("GPL");
drivers/i2c/busses/i2c-designware-core.h +3 -0
index 723d599cca93..c6bd6f65a2d3 100644
@@ -15,6 +15,7 @@
 #include <linux/dev_printk.h>
 #include <linux/errno.h>
 #include <linux/i2c.h>
+#include <linux/pm.h>
 #include <linux/regmap.h>
 #include <linux/types.h>
 
@@ -341,6 +342,8 @@ int i2c_dw_handle_tx_abort(struct dw_i2c_dev *dev);
 int i2c_dw_set_fifo_size(struct dw_i2c_dev *dev);
 u32 i2c_dw_func(struct i2c_adapter *adap);
 
+extern const struct dev_pm_ops i2c_dw_dev_pm_ops;
+
 static inline void __i2c_dw_enable(struct dw_i2c_dev *dev)
 {
 	dev->status |= STATUS_ACTIVE;
drivers/i2c/busses/i2c-designware-pcidrv.c +2 -42

62 lines not on this page · raw message

drivers/i2c/busses/i2c-designware-platdrv.c +0 -62

74 lines not on this page · raw message

Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
#1 lore raw
kernel test robot noticed the following build errors:

Hi Andy,

kernel test robot noticed the following build errors:

[auto build test ERROR on andi-shyti/i2c/i2c-host]
[also build test ERROR on next-20240826]
[cannot apply to linus/master v6.11-rc5]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Andy-Shevchenko/i2c-designware-Consolidate-PM-ops/20240826-171118
base:   https://git.kernel.org/pub/scm/linux/kernel/git/andi.shyti/linux.git i2c/i2c-host
patch link:    https://lore.kernel.org/r/20240823163057.1175381-1-andriy.shevchenko%40linux.intel.com
patch subject: [PATCH v1 1/1] i2c: designware: Consolidate PM ops
config: m68k-allmodconfig (https://download.01.org/0day-ci/archive/20240826/[email protected]/config)
compiler: m68k-linux-gcc (GCC) 14.1.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240826/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All errors (new ones prefixed by >>):

In file included from include/linux/cpumask.h:11,
from include/linux/smp.h:13,
from include/linux/lockdep.h:14,
from include/linux/spinlock.h:63,
from include/linux/mmzone.h:8,
from include/linux/gfp.h:7,
from include/linux/slab.h:16,
from include/linux/resource_ext.h:11, from include/linux/acpi.h:13,
from drivers/i2c/busses/i2c-designware-platdrv.c:11:

>> drivers/i2c/busses/i2c-designware-platdrv.c:383:35: error: 'dw_i2c_dev_pm_ops' undeclared here (not in a function)
     383 |                 .pm     = pm_ptr(&dw_i2c_dev_pm_ops),
         |                                   ^~~~~~~~~~~~~~~~~
   include/linux/kernel.h:48:44: note: in definition of macro 'PTR_IF'
      48 | #define PTR_IF(cond, ptr)       ((cond) ? (ptr) : NULL)
         |                                            ^~~
   drivers/i2c/busses/i2c-designware-platdrv.c:383:27: note: in expansion of macro 'pm_ptr'
     383 |                 .pm     = pm_ptr(&dw_i2c_dev_pm_ops),
         |                           ^~~~~~

vim +/dw_i2c_dev_pm_ops +383 drivers/i2c/busses/i2c-designware-platdrv.c

2373f6b9744d53 Dirk Brandewie   2011-10-29  375  
2373f6b9744d53 Dirk Brandewie   2011-10-29  376  static struct platform_driver dw_i2c_driver = {
6ad6fde3970c98 Jarkko Nikula    2015-08-31  377  	.probe = dw_i2c_plat_probe,
e190a0c389e601 Uwe Kleine-König 2023-05-08  378  	.remove_new = dw_i2c_plat_remove,
2373f6b9744d53 Dirk Brandewie   2011-10-29  379  	.driver		= {
2373f6b9744d53 Dirk Brandewie   2011-10-29  380  		.name	= "i2c_designware",
231da4058f0ae9 Andy Shevchenko  2024-08-19  381  		.of_match_table = dw_i2c_of_match,
231da4058f0ae9 Andy Shevchenko  2024-08-19  382  		.acpi_match_table = dw_i2c_acpi_match,
a9e4d8b641bc6c Paul Cercueil    2023-07-22 @383  		.pm	= pm_ptr(&dw_i2c_dev_pm_ops),
2373f6b9744d53 Dirk Brandewie   2011-10-29  384  	},
61e05bad821cb2 Andy Shevchenko  2024-04-25  385  	.id_table = dw_i2c_platform_ids,
2373f6b9744d53 Dirk Brandewie   2011-10-29  386  };
2373f6b9744d53 Dirk Brandewie   2011-10-29  387  
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki
#2 lore raw
In reply to Andy Shevchenko
kernel test robot noticed the following build errors:

Hi Andy,

kernel test robot noticed the following build errors:

[auto build test ERROR on andi-shyti/i2c/i2c-host]
[also build test ERROR on next-20240826]
[cannot apply to linus/master v6.11-rc5]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Andy-Shevchenko/i2c-designware-Consolidate-PM-ops/20240826-171118
base:   https://git.kernel.org/pub/scm/linux/kernel/git/andi.shyti/linux.git i2c/i2c-host
patch link:    https://lore.kernel.org/r/20240823163057.1175381-1-andriy.shevchenko%40linux.intel.com
patch subject: [PATCH v1 1/1] i2c: designware: Consolidate PM ops
config: s390-allmodconfig (https://download.01.org/0day-ci/archive/20240827/[email protected]/config)
compiler: clang version 20.0.0git (https://github.com/llvm/llvm-project 08e5a1de8227512d4774a534b91cb2353cef6284)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240827/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All errors (new ones prefixed by >>):

In file included from drivers/i2c/busses/i2c-designware-platdrv.c:11:
In file included from include/linux/acpi.h:14:
In file included from include/linux/device.h:32:
In file included from include/linux/device/driver.h:21:
In file included from include/linux/module.h:19:
In file included from include/linux/elf.h:6:
In file included from arch/s390/include/asm/elf.h:181:
In file included from arch/s390/include/asm/mmu_context.h:11:
In file included from arch/s390/include/asm/pgalloc.h:18:
In file included from include/linux/mm.h:2228:
include/linux/vmstat.h:503:43: warning: arithmetic between different enumeration types ('enum zone_stat_item' and 'enum numa_stat_item') [-Wenum-enum-conversion]

     503 |         return vmstat_text[NR_VM_ZONE_STAT_ITEMS +
         |                            ~~~~~~~~~~~~~~~~~~~~~ ^
     504 |                            item];
         |                            ~~~~
   include/linux/vmstat.h:510:43: warning: arithmetic between different enumeration types ('enum zone_stat_item' and 'enum numa_stat_item') [-Wenum-enum-conversion]
     510 |         return vmstat_text[NR_VM_ZONE_STAT_ITEMS +
         |                            ~~~~~~~~~~~~~~~~~~~~~ ^
     511 |                            NR_VM_NUMA_EVENT_ITEMS +
         |                            ~~~~~~~~~~~~~~~~~~~~~~
   include/linux/vmstat.h:517:36: warning: arithmetic between different enumeration types ('enum node_stat_item' and 'enum lru_list') [-Wenum-enum-conversion]
     517 |         return node_stat_name(NR_LRU_BASE + lru) + 3; // skip "nr_"
         |                               ~~~~~~~~~~~ ^ ~~~
   include/linux/vmstat.h:523:43: warning: arithmetic between different enumeration types ('enum zone_stat_item' and 'enum numa_stat_item') [-Wenum-enum-conversion]
     523 |         return vmstat_text[NR_VM_ZONE_STAT_ITEMS +
         |                            ~~~~~~~~~~~~~~~~~~~~~ ^
     524 |                            NR_VM_NUMA_EVENT_ITEMS +
         |                            ~~~~~~~~~~~~~~~~~~~~~~
   In file included from drivers/i2c/busses/i2c-designware-platdrv.c:20:
   In file included from include/linux/io.h:14:
   In file included from arch/s390/include/asm/io.h:93:
   include/asm-generic/io.h:548:31: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     548 |         val = __raw_readb(PCI_IOBASE + addr);
         |                           ~~~~~~~~~~ ^
   include/asm-generic/io.h:561:61: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     561 |         val = __le16_to_cpu((__le16 __force)__raw_readw(PCI_IOBASE + addr));
         |                                                         ~~~~~~~~~~ ^
   include/uapi/linux/byteorder/big_endian.h:37:59: note: expanded from macro '__le16_to_cpu'
      37 | #define __le16_to_cpu(x) __swab16((__force __u16)(__le16)(x))
         |                                                           ^
   include/uapi/linux/swab.h:102:54: note: expanded from macro '__swab16'
     102 | #define __swab16(x) (__u16)__builtin_bswap16((__u16)(x))
         |                                                      ^
   In file included from drivers/i2c/busses/i2c-designware-platdrv.c:20:
   In file included from include/linux/io.h:14:
   In file included from arch/s390/include/asm/io.h:93:
   include/asm-generic/io.h:574:61: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     574 |         val = __le32_to_cpu((__le32 __force)__raw_readl(PCI_IOBASE + addr));
         |                                                         ~~~~~~~~~~ ^
   include/uapi/linux/byteorder/big_endian.h:35:59: note: expanded from macro '__le32_to_cpu'
      35 | #define __le32_to_cpu(x) __swab32((__force __u32)(__le32)(x))
         |                                                           ^
   include/uapi/linux/swab.h:115:54: note: expanded from macro '__swab32'
     115 | #define __swab32(x) (__u32)__builtin_bswap32((__u32)(x))
         |                                                      ^
   In file included from drivers/i2c/busses/i2c-designware-platdrv.c:20:
   In file included from include/linux/io.h:14:
   In file included from arch/s390/include/asm/io.h:93:
   include/asm-generic/io.h:585:33: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     585 |         __raw_writeb(value, PCI_IOBASE + addr);
         |                             ~~~~~~~~~~ ^
   include/asm-generic/io.h:595:59: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     595 |         __raw_writew((u16 __force)cpu_to_le16(value), PCI_IOBASE + addr);
         |                                                       ~~~~~~~~~~ ^
   include/asm-generic/io.h:605:59: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     605 |         __raw_writel((u32 __force)cpu_to_le32(value), PCI_IOBASE + addr);
         |                                                       ~~~~~~~~~~ ^
   include/asm-generic/io.h:693:20: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     693 |         readsb(PCI_IOBASE + addr, buffer, count);
         |                ~~~~~~~~~~ ^
   include/asm-generic/io.h:701:20: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     701 |         readsw(PCI_IOBASE + addr, buffer, count);
         |                ~~~~~~~~~~ ^
   include/asm-generic/io.h:709:20: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     709 |         readsl(PCI_IOBASE + addr, buffer, count);
         |                ~~~~~~~~~~ ^
   include/asm-generic/io.h:718:21: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     718 |         writesb(PCI_IOBASE + addr, buffer, count);
         |                 ~~~~~~~~~~ ^
   include/asm-generic/io.h:727:21: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     727 |         writesw(PCI_IOBASE + addr, buffer, count);
         |                 ~~~~~~~~~~ ^
   include/asm-generic/io.h:736:21: warning: performing pointer arithmetic on a null pointer has undefined behavior [-Wnull-pointer-arithmetic]
     736 |         writesl(PCI_IOBASE + addr, buffer, count);
         |                 ~~~~~~~~~~ ^
>> drivers/i2c/busses/i2c-designware-platdrv.c:383:17: error: use of undeclared identifier 'dw_i2c_dev_pm_ops'; did you mean 'i2c_dw_dev_pm_ops'?
     383 |                 .pm     = pm_ptr(&dw_i2c_dev_pm_ops),
         |                                   ^~~~~~~~~~~~~~~~~
         |                                   i2c_dw_dev_pm_ops
   include/linux/pm.h:475:53: note: expanded from macro 'pm_ptr'
     475 | #define pm_ptr(_ptr) PTR_IF(IS_ENABLED(CONFIG_PM), (_ptr))
         |                                                     ^
   include/linux/kernel.h:48:38: note: expanded from macro 'PTR_IF'
      48 | #define PTR_IF(cond, ptr)       ((cond) ? (ptr) : NULL)
         |                                            ^
   drivers/i2c/busses/i2c-designware-core.h:345:32: note: 'i2c_dw_dev_pm_ops' declared here
     345 | extern const struct dev_pm_ops i2c_dw_dev_pm_ops;
         |                                ^

16 warnings and 1 error generated.

vim +383 drivers/i2c/busses/i2c-designware-platdrv.c

2373f6b9744d53 Dirk Brandewie   2011-10-29  375  
2373f6b9744d53 Dirk Brandewie   2011-10-29  376  static struct platform_driver dw_i2c_driver = {
6ad6fde3970c98 Jarkko Nikula    2015-08-31  377  	.probe = dw_i2c_plat_probe,
e190a0c389e601 Uwe Kleine-König 2023-05-08  378  	.remove_new = dw_i2c_plat_remove,
2373f6b9744d53 Dirk Brandewie   2011-10-29  379  	.driver		= {
2373f6b9744d53 Dirk Brandewie   2011-10-29  380  		.name	= "i2c_designware",
231da4058f0ae9 Andy Shevchenko  2024-08-19  381  		.of_match_table = dw_i2c_of_match,
231da4058f0ae9 Andy Shevchenko  2024-08-19  382  		.acpi_match_table = dw_i2c_acpi_match,
a9e4d8b641bc6c Paul Cercueil    2023-07-22 @383  		.pm	= pm_ptr(&dw_i2c_dev_pm_ops),
2373f6b9744d53 Dirk Brandewie   2011-10-29  384  	},
61e05bad821cb2 Andy Shevchenko  2024-04-25  385  	.id_table = dw_i2c_platform_ids,
2373f6b9744d53 Dirk Brandewie   2011-10-29  386  };
2373f6b9744d53 Dirk Brandewie   2011-10-29  387  
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki