diff mbox series

[06/10] thunderbolt: Create debugfs directory automatically for services

Message ID 20201104140030.6853-7-mika.westerberg@linux.intel.com (mailing list archive)
State Not Applicable
Delegated to: Netdev Maintainers
Headers show
Series thunderbolt: Add DMA traffic test driver | expand

Commit Message

Mika Westerberg Nov. 4, 2020, 2 p.m. UTC
This allows service drivers to use it as parent directory if they need
to add their own debugfs entries.

Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
---
 drivers/thunderbolt/debugfs.c | 24 ++++++++++++++++++++++++
 drivers/thunderbolt/tb.h      |  4 ++++
 drivers/thunderbolt/xdomain.c |  3 +++
 include/linux/thunderbolt.h   |  4 ++++
 4 files changed, 35 insertions(+)

Comments

Greg KH Nov. 4, 2020, 2:20 p.m. UTC | #1
On Wed, Nov 04, 2020 at 05:00:26PM +0300, Mika Westerberg wrote:
> This allows service drivers to use it as parent directory if they need
> to add their own debugfs entries.
> 
> Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
> ---
>  drivers/thunderbolt/debugfs.c | 24 ++++++++++++++++++++++++
>  drivers/thunderbolt/tb.h      |  4 ++++
>  drivers/thunderbolt/xdomain.c |  3 +++
>  include/linux/thunderbolt.h   |  4 ++++
>  4 files changed, 35 insertions(+)
> 
> diff --git a/drivers/thunderbolt/debugfs.c b/drivers/thunderbolt/debugfs.c
> index ed65d2b13964..a80278fc50af 100644
> --- a/drivers/thunderbolt/debugfs.c
> +++ b/drivers/thunderbolt/debugfs.c
> @@ -691,6 +691,30 @@ void tb_switch_debugfs_remove(struct tb_switch *sw)
>  	debugfs_remove_recursive(sw->debugfs_dir);
>  }
>  
> +/**
> + * tb_service_debugfs_init() - Add debugfs directory for service
> + * @svc: Thunderbolt service pointer
> + *
> + * Adds debugfs directory for service.
> + */
> +void tb_service_debugfs_init(struct tb_service *svc)
> +{
> +	svc->debugfs_dir = debugfs_create_dir(dev_name(&svc->dev),
> +					      tb_debugfs_root);
> +}
> +
> +/**
> + * tb_service_debugfs_remove() - Remove service debugfs directory
> + * @svc: Thunderbolt service pointer
> + *
> + * Removes the previously created debugfs directory for @svc.
> + */
> +void tb_service_debugfs_remove(struct tb_service *svc)
> +{
> +	debugfs_remove(svc->debugfs_dir);

debugfs_remove_recursive() just to be safe that you really did clean
everything up?  As you aren't "owning" this directory here, you don't
know what will get added by some other patch :)

Other than that tiny nit, this series looks good to me, nice work.

thanks,

greg k-h
Mika Westerberg Nov. 4, 2020, 2:58 p.m. UTC | #2
On Wed, Nov 04, 2020 at 03:20:38PM +0100, Greg KH wrote:
> > +/**
> > + * tb_service_debugfs_remove() - Remove service debugfs directory
> > + * @svc: Thunderbolt service pointer
> > + *
> > + * Removes the previously created debugfs directory for @svc.
> > + */
> > +void tb_service_debugfs_remove(struct tb_service *svc)
> > +{
> > +	debugfs_remove(svc->debugfs_dir);
> 
> debugfs_remove_recursive() just to be safe that you really did clean
> everything up?  As you aren't "owning" this directory here, you don't
> know what will get added by some other patch :)

Good point. I'll change it to debugfs_remove_recursive().

> Other than that tiny nit, this series looks good to me, nice work.

Thanks!
diff mbox series

Patch

diff --git a/drivers/thunderbolt/debugfs.c b/drivers/thunderbolt/debugfs.c
index ed65d2b13964..a80278fc50af 100644
--- a/drivers/thunderbolt/debugfs.c
+++ b/drivers/thunderbolt/debugfs.c
@@ -691,6 +691,30 @@  void tb_switch_debugfs_remove(struct tb_switch *sw)
 	debugfs_remove_recursive(sw->debugfs_dir);
 }
 
+/**
+ * tb_service_debugfs_init() - Add debugfs directory for service
+ * @svc: Thunderbolt service pointer
+ *
+ * Adds debugfs directory for service.
+ */
+void tb_service_debugfs_init(struct tb_service *svc)
+{
+	svc->debugfs_dir = debugfs_create_dir(dev_name(&svc->dev),
+					      tb_debugfs_root);
+}
+
+/**
+ * tb_service_debugfs_remove() - Remove service debugfs directory
+ * @svc: Thunderbolt service pointer
+ *
+ * Removes the previously created debugfs directory for @svc.
+ */
+void tb_service_debugfs_remove(struct tb_service *svc)
+{
+	debugfs_remove(svc->debugfs_dir);
+	svc->debugfs_dir = NULL;
+}
+
 void tb_debugfs_init(void)
 {
 	tb_debugfs_root = debugfs_create_dir("thunderbolt", NULL);
diff --git a/drivers/thunderbolt/tb.h b/drivers/thunderbolt/tb.h
index aa7e2dc66059..08af4fe642c0 100644
--- a/drivers/thunderbolt/tb.h
+++ b/drivers/thunderbolt/tb.h
@@ -1029,11 +1029,15 @@  void tb_debugfs_init(void);
 void tb_debugfs_exit(void);
 void tb_switch_debugfs_init(struct tb_switch *sw);
 void tb_switch_debugfs_remove(struct tb_switch *sw);
+void tb_service_debugfs_init(struct tb_service *svc);
+void tb_service_debugfs_remove(struct tb_service *svc);
 #else
 static inline void tb_debugfs_init(void) { }
 static inline void tb_debugfs_exit(void) { }
 static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
 static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
+static inline void tb_service_debugfs_init(struct tb_service *svc) { }
+static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
 #endif
 
 #ifdef CONFIG_USB4_KUNIT_TEST
diff --git a/drivers/thunderbolt/xdomain.c b/drivers/thunderbolt/xdomain.c
index 63889fbd8156..c36b29736cd0 100644
--- a/drivers/thunderbolt/xdomain.c
+++ b/drivers/thunderbolt/xdomain.c
@@ -777,6 +777,7 @@  static void tb_service_release(struct device *dev)
 	struct tb_service *svc = container_of(dev, struct tb_service, dev);
 	struct tb_xdomain *xd = tb_service_parent(svc);
 
+	tb_service_debugfs_remove(svc);
 	ida_simple_remove(&xd->service_ids, svc->id);
 	kfree(svc->key);
 	kfree(svc);
@@ -891,6 +892,8 @@  static void enumerate_services(struct tb_xdomain *xd)
 		svc->dev.parent = &xd->dev;
 		dev_set_name(&svc->dev, "%s.%d", dev_name(&xd->dev), svc->id);
 
+		tb_service_debugfs_init(svc);
+
 		if (device_register(&svc->dev)) {
 			put_device(&svc->dev);
 			break;
diff --git a/include/linux/thunderbolt.h b/include/linux/thunderbolt.h
index 0a747f92847e..a844fd5d96ab 100644
--- a/include/linux/thunderbolt.h
+++ b/include/linux/thunderbolt.h
@@ -350,6 +350,9 @@  void tb_unregister_protocol_handler(struct tb_protocol_handler *handler);
  * @prtcvers: Protocol version from the properties directory
  * @prtcrevs: Protocol software revision from the properties directory
  * @prtcstns: Protocol settings mask from the properties directory
+ * @debugfs_dir: Pointer to the service debugfs directory. Always created
+ *		 when debugfs is enabled. Can be used by service drivers to
+ *		 add their own entries under the service.
  *
  * Each domain exposes set of services it supports as collection of
  * properties. For each service there will be one corresponding
@@ -363,6 +366,7 @@  struct tb_service {
 	u32 prtcvers;
 	u32 prtcrevs;
 	u32 prtcstns;
+	struct dentry *debugfs_dir;
 };
 
 static inline struct tb_service *tb_service_get(struct tb_service *svc)