Skip to contentSkip to conversation

mfd: syscon: Give each syscon its own lockdep class

PATCH New Arun Iyengar 2 participants 2 messages Nov 20

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mfd: syscon: Give each syscon its own lockdep class

All syscon regmaps share one lockdep class, as regmap_init_mmio() uses a static key per call site. Lockdep then mixes up unrelated syscons: on RK3588 the clock-gated VO1 GRF calls clk_enable() under its regmap lock, while the CRU's GRF gates take the SYS GRF regmap lock under enable_lock. This is reported as a circular dependency and disables lockdep.

Lock each syscon regmap with its own spinlock and lockdep class.

---
Tested on an Orange Pi 5 (RK3588S) with a 7.3 based kernel that has out-of-tree DisplayPort patches, lockdep and KASAN on. Without the patch lockdep reports the cycle during boot. With it /proc/lockdep shows one syscon lock -> enable_lock and enable_lock -> another syscon lock, there is no report and lockdep stays on. Build-tested on for-mfd-next.

Applies on top of "mfd: syscon: Put the clock after regmap_exit()":
https://lore.kernel.org/r/[email protected]

Developed with Claude (Anthropic), which wrote the code and the commit message. I reviewed every change.

---
 drivers/mfd/syscon.c | 36 +++++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)
drivers/mfd/syscon.c +35 -1
index 3ff4e024542b..34f278dfd2a8 100644
@@ -13,6 +13,7 @@
 #include <linux/err.h>
 #include <linux/hwspinlock.h>
 #include <linux/list.h>
+#include <linux/lockdep.h>
 #include <linux/mutex.h>
 #include <linux/of.h>
 #include <linux/of_address.h>
@@ -20,6 +21,7 @@
 #include <linux/reset.h>
 #include <linux/mfd/syscon.h>
 #include <linux/slab.h>
+#include <linux/spinlock.h>
 
 static DEFINE_MUTEX(syscon_list_lock);
 static LIST_HEAD(syscon_list);
@@ -29,8 +31,29 @@ struct syscon {
 	struct regmap *regmap;
 	struct reset_control *reset;
 	struct list_head list;
+	spinlock_t lock;
+	unsigned long lock_flags;
+	struct lock_class_key lock_key;
 };
 
+static void syscon_lock(void *arg)
+__acquires(&syscon->lock)
+{
+	struct syscon *syscon = arg;
+	unsigned long flags;
+
+	spin_lock_irqsave(&syscon->lock, flags);
+	syscon->lock_flags = flags;
+}
+
+static void syscon_unlock(void *arg)
+__releases(&syscon->lock)
+{
+	struct syscon *syscon = arg;
+
+	spin_unlock_irqrestore(&syscon->lock, syscon->lock_flags);
+}
+
 static const struct regmap_config syscon_regmap_config = {
 	.reg_bits = 32,
 	.val_bits = 32,
@@ -114,12 +137,21 @@ static struct syscon *of_syscon_register(struct device_node *np, bool check_res)
 	if (!syscon_config.max_register)
 		syscon_config.max_register_is_0 = true;
 
+	lockdep_register_key(&syscon->lock_key);
+	spin_lock_init(&syscon->lock);
+	lockdep_set_class(&syscon->lock, &syscon->lock_key);
+	if (!syscon_config.use_hwlock) {
+		syscon_config.lock = syscon_lock;
+		syscon_config.unlock = syscon_unlock;
+		syscon_config.lock_arg = syscon;
+	}
+
 	regmap = regmap_init_mmio(NULL, base, &syscon_config);
 	kfree(syscon_config.name);
 	if (IS_ERR(regmap)) {
 		pr_err("regmap init failed\n");
 		ret = PTR_ERR(regmap);
-		goto err_regmap;
+		goto err_key;
 	}
 
 	if (check_res) {
@@ -159,6 +191,8 @@ static struct syscon *of_syscon_register(struct device_node *np, bool check_res)
 	regmap_exit(regmap);
 	if (!IS_ERR(clk))
 		clk_put(clk);
+err_key:
+	lockdep_unregister_key(&syscon->lock_key);
 err_regmap:
 	iounmap(base);
 	return ERR_PTR(ret);

---
base-commit: 1cb7268b6638c411fc32f373e965eb8ba9e9b2b4
change-id: 20261115-syscon-lockdep-d133fb58c2be
prerequisite-message-id: <[email protected]>
prerequisite-patch-id: 7cf33abeabb3eeaf1ba8ac6c461726fca87702cd

Best regards,

Signature · 1 line
Arun Iyengar <[email protected]>
#1 lore raw
Thank you for your contribution! Sashiko AI review found 1 potential issue to consider: - [Low] mfd: syscon: undeclared identifier in syscon_lock() context annotations --

Thank you for your contribution! Sashiko AI review found 1 potential issue to consider:
- [Low] mfd: syscon: undeclared identifier in syscon_lock() context annotations
--

commit a05c15e1f84840a481c30788a689c7e2574c1c6f
Author: Arun Iyengar <[email protected]>

mfd: syscon: Give each syscon its own lockdep class

This commit gives each syscon regmap its own spinlock and dynamic lockdep class key so that lockdep does not conflate unrelated syscon instances.

Quoted 4 lines
drivers/mfd/syscon.c +0 -0
index 3ff4e024542bf..34f278dfd2a84 100644

[ ... ]

Quoted 16 lines
drivers/mfd/syscon.c +10 -0
@@ -29,8 +31,29 @@ struct syscon {
 	struct regmap *regmap;
 	struct reset_control *reset;
 	struct list_head list;
+	spinlock_t lock;
+	unsigned long lock_flags;
+	struct lock_class_key lock_key;
 };
 
+static void syscon_lock(void *arg)
+__acquires(&syscon->lock)
+{
+	struct syscon *syscon = arg;
+	unsigned long flags;
+
+	spin_lock_irqsave(&syscon->lock, flags);

drivers/mfd/syscon.c struct syscon { · line 55

Quoted 10 lines
drivers/mfd/syscon.c +10 -0
+	syscon->lock_flags = flags;
+}
+
+static void syscon_unlock(void *arg)
+__releases(&syscon->lock)
+{
+	struct syscon *syscon = arg;
+
+	spin_unlock_irqrestore(&syscon->lock, syscon->lock_flags);
+}

[Severity: Low]
Does &syscon->lock in the __acquires() and __releases() attributes fail to compile when WARN_CONTEXT_ANALYSIS is enabled?

When CONFIG_WARN_CONTEXT_ANALYSIS_ALL=y, __acquires() and __releases() expand to Clang capability attributes whose arguments are evaluated in parameter scope before the function body. Because syscon is a local variable rather than a parameter, syscon is undeclared at the attribute site; the annotations need to reference arg instead (for example, &((struct syscon *)arg)->lock).

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1