regmap: Disable debugfs when locking is disabled
Subsystems (2)
Mark Brown
maintainerPATCH 1/1 regmap: Disable debugfs when locking is disabled
The recently added support for disabling the regmap internal locking left debugfs enabled for devices with the locking disabled. This is a problem since debugfs allows userspace to do things like initiate reads from the hardware which will use the scratch buffers protected by the regmap locking so could cause data corruption.
For safety address this by just disabling debugfs for these devices. That is overly conservative since some of the debugfs files just read internal data structures but it's much simpler to implmement and less likely to lead to problems with tooling that works with debugfs.
---
Compile tested only so far.
drivers/base/regmap/internal.h | 8 ++++++++ drivers/base/regmap/regmap-debugfs.c | 3 +++ drivers/base/regmap/regmap.c | 1 + 3 files changed, 12 insertions(+)
drivers/base/regmap/internal.h +8 -0
@@ -77,6 +77,7 @@ struct regmap {int async_ret;#ifdef CONFIG_DEBUG_FS +bool debugfs_disable;struct dentry *debugfs;const char *debugfs_name;
@@ -215,10 +216,17 @@ struct regmap_field {extern void regmap_debugfs_initcall (void );extern void regmap_debugfs_init (struct regmap *map,const char *name);extern void regmap_debugfs_exit (struct regmap *map); + +static void regmap_debugfs_disable (struct regmap *map) +{ + map->debugfs_disable = true; +} +#else static inline void regmap_debugfs_initcall (void ) { }static inline void regmap_debugfs_init (struct regmap *map,const char *name) { }static inline void regmap_debugfs_exit (struct regmap *map) { } +static inline void regmap_debugfs_disable (struct regmap *map) { }#endif /* regcache core declarations */
drivers/base/regmap/regmap-debugfs.c +3 -0
@@ -529,6 +529,9 @@ void regmap_debugfs_init(struct regmap *map, const char *name)struct regmap_range_node *range_node;const char *devname ="dummy" ; +if (map->debugfs_disable) +return ; +/* If we don't have the debugfs root yet, postpone init */ if (!regmap_debugfs_root) {struct regmap_debugfs_node *node;
drivers/base/regmap/regmap.c +1 -0
@@ -674,6 +674,7 @@ struct regmap *__regmap_init(struct device *dev,if (config->disable_locking) { map->lock = map->unlock = regmap_lock_unlock_empty; +regmap_debugfs_disable (map); }else if (config->lock && config->unlock) { map->lock = config->lock; map->unlock = config->unlock;
Signature · 1 line
2.15.1
2017-12-12 18:13 GMT+01:00 Mark Brown <[email protected]>:
Quoted 57 lines
The recently added support for disabling the regmap internal locking left debugfs enabled for devices with the locking disabled. This is a problem since debugfs allows userspace to do things like initiate reads from the hardware which will use the scratch buffers protected by the regmap locking so could cause data corruption.
For safety address this by just disabling debugfs for these devices. That is overly conservative since some of the debugfs files just read internal data structures but it's much simpler to implmement and less likely to lead to problems with tooling that works with debugfs.
Reported-by Lars-Peter Clausen <[email protected]>Signed-off-by Mark Brown <[email protected]>---
Compile tested only so far.
drivers/base/regmap/internal.h | 8 ++++++++ drivers/base/regmap/regmap-debugfs.c | 3 +++ drivers/base/regmap/regmap.c | 1 + 3 files changed, 12 insertions(+)drivers/base/regmap/internal.h +8
-0@@ -77,6 +77,7 @@ struct regmap {int async_ret;#ifdef CONFIG_DEBUG_FS +bool debugfs_disable;struct dentry *debugfs;const char *debugfs_name;@@ -215,10 +216,17 @@ struct regmap_field {extern void regmap_debugfs_initcall (void );extern void regmap_debugfs_init (struct regmap *map,const char *name);extern void regmap_debugfs_exit (struct regmap *map); + +static void regmap_debugfs_disable (struct regmap *map) +{ + map->debugfs_disable = true; +} +#else static inline void regmap_debugfs_initcall (void ) { }static inline void regmap_debugfs_init (struct regmap *map,const char *name) { }static inline void regmap_debugfs_exit (struct regmap *map) { } +static inline void regmap_debugfs_disable (struct regmap *map) { }#endif /* regcache core declarations */ drivers/base/regmap/regmap-debugfs.c +0
-0
drivers/base/regmap/regmap-debugfs.c void regmap_debugfs_init(struct regmap *map, const char *name) · line 534
Quoted 6 lines
drivers/base/regmap/regmap-debugfs.c +3
-0@@ -529,6 +529,9 @@ void regmap_debugfs_init(struct regmap *map, const char *name)struct regmap_range_node *range_node;const char *devname ="dummy" ; +if (map->debugfs_disable) +return ; +
I would still add the dev_dbg() here like in my version, since someone may start wondering why the debugfs files are not being creating for certain regmaps.
Thanks,
Bartosz
Quoted 18 lines
drivers/base/regmap/regmap-debugfs.c +0
-0/* If we don't have the debugfs root yet, postpone init */ if (!regmap_debugfs_root) {struct regmap_debugfs_node *node;drivers/base/regmap/regmap.c +1
-1@@ -674,6 +674,7 @@ struct regmap *__regmap_init(struct device *dev,if (config->disable_locking) { map->lock = map->unlock = regmap_lock_unlock_empty; +regmap_debugfs_disable (map); }else if (config->lock && config->unlock) { map->lock = config->lock; map->unlock = config->unlock; --2.15.1
Mark Brown
maintainerQuoted 3 lines · Bartosz Golaszewski
I would still add the
dev_dbg()here like in my version, since someone may start wondering why the debugfs files are not being creating for certain regmaps.
Sure, can you send a patch for that please - I already applied mine?
2017-12-13 17:47 GMT+01:00 Mark Brown <[email protected]>:
Quoted 7 lines · Bartosz Golaszewski
Quoted 4 lines
I would still add the
dev_dbg()here like in my version, since someone may start wondering why the debugfs files are not being creating for certain regmaps.Sure, can you send a patch for that please - I already applied mine?
Done.
Thanks,
Bartosz