]> asedeno.scripts.mit.edu Git - linux.git/commitdiff
soundwire: add debugfs support
authorPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Wed, 21 Aug 2019 18:58:18 +0000 (13:58 -0500)
committerVinod Koul <vkoul@kernel.org>
Fri, 23 Aug 2019 06:31:02 +0000 (12:01 +0530)
Add base debugfs mechanism for SoundWire bus by creating soundwire
root and master-N and slave-x hierarchy.

Also add SDW Slave SCP, DP0 and DP-N register debug file.

Registers not implemented will print as "XX"

Credits: this patch is based on an earlier internal contribution by
Vinod Koul, Sanyog Kale, Shreyas Nc and Hardik Shah.

Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Sanyog Kale <sanyog.r.kale@intel.com>
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Link: https://lore.kernel.org/r/20190821185821.12690-2-pierre-louis.bossart@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org>
drivers/soundwire/Makefile
drivers/soundwire/bus.c
drivers/soundwire/bus.h
drivers/soundwire/bus_type.c
drivers/soundwire/debugfs.c [new file with mode: 0644]
drivers/soundwire/slave.c
include/linux/soundwire/sdw.h

index fd99a831b92a0baf3a15b4a42db8160034b1468e..34bbd36a9851f51d245eb21902afd17631b261e6 100644 (file)
@@ -7,6 +7,10 @@
 soundwire-bus-objs := bus_type.o bus.o slave.o mipi_disco.o stream.o
 obj-$(CONFIG_SOUNDWIRE_BUS) += soundwire-bus.o
 
 soundwire-bus-objs := bus_type.o bus.o slave.o mipi_disco.o stream.o
 obj-$(CONFIG_SOUNDWIRE_BUS) += soundwire-bus.o
 
+ifdef CONFIG_DEBUG_FS
+soundwire-bus-objs += debugfs.o
+endif
+
 #Cadence Objs
 soundwire-cadence-objs := cadence_master.o
 obj-$(CONFIG_SOUNDWIRE_CADENCE) += soundwire-cadence.o
 #Cadence Objs
 soundwire-cadence-objs := cadence_master.o
 obj-$(CONFIG_SOUNDWIRE_CADENCE) += soundwire-cadence.o
index 50f9cc5eb5f6549c45914c7923cbed70c8184d26..728db3ebad6ecbff3fc858da9d5bd57b2576e102 100644 (file)
@@ -49,6 +49,8 @@ int sdw_add_bus_master(struct sdw_bus *bus)
                }
        }
 
                }
        }
 
+       sdw_bus_debugfs_init(bus);
+
        /*
         * Device numbers in SoundWire are 0 through 15. Enumeration device
         * number (0), Broadcast device number (15), Group numbers (12 and
        /*
         * Device numbers in SoundWire are 0 through 15. Enumeration device
         * number (0), Broadcast device number (15), Group numbers (12 and
@@ -109,6 +111,8 @@ static int sdw_delete_slave(struct device *dev, void *data)
        struct sdw_slave *slave = dev_to_sdw_dev(dev);
        struct sdw_bus *bus = slave->bus;
 
        struct sdw_slave *slave = dev_to_sdw_dev(dev);
        struct sdw_bus *bus = slave->bus;
 
+       sdw_slave_debugfs_exit(slave);
+
        mutex_lock(&bus->bus_lock);
 
        if (slave->dev_num) /* clear dev_num if assigned */
        mutex_lock(&bus->bus_lock);
 
        if (slave->dev_num) /* clear dev_num if assigned */
@@ -130,6 +134,8 @@ static int sdw_delete_slave(struct device *dev, void *data)
 void sdw_delete_bus_master(struct sdw_bus *bus)
 {
        device_for_each_child(bus->dev, NULL, sdw_delete_slave);
 void sdw_delete_bus_master(struct sdw_bus *bus)
 {
        device_for_each_child(bus->dev, NULL, sdw_delete_slave);
+
+       sdw_bus_debugfs_exit(bus);
 }
 EXPORT_SYMBOL(sdw_delete_bus_master);
 
 }
 EXPORT_SYMBOL(sdw_delete_bus_master);
 
index 4429c51c5f86b3c3bf856d2f1fb15a7d68266b11..9d6ea7e447ffd1bc50247ae6f5b8503fec2409e8 100644 (file)
@@ -18,6 +18,22 @@ static inline int sdw_acpi_find_slaves(struct sdw_bus *bus)
 void sdw_extract_slave_id(struct sdw_bus *bus,
                          u64 addr, struct sdw_slave_id *id);
 
 void sdw_extract_slave_id(struct sdw_bus *bus,
                          u64 addr, struct sdw_slave_id *id);
 
+#ifdef CONFIG_DEBUG_FS
+void sdw_bus_debugfs_init(struct sdw_bus *bus);
+void sdw_bus_debugfs_exit(struct sdw_bus *bus);
+void sdw_slave_debugfs_init(struct sdw_slave *slave);
+void sdw_slave_debugfs_exit(struct sdw_slave *slave);
+void sdw_debugfs_init(void);
+void sdw_debugfs_exit(void);
+#else
+static inline void sdw_bus_debugfs_init(struct sdw_bus *bus) {}
+static inline void sdw_bus_debugfs_exit(struct sdw_bus *bus) {}
+static inline void sdw_slave_debugfs_init(struct sdw_slave *slave) {}
+static inline void sdw_slave_debugfs_exit(struct sdw_slave *slave) {}
+static inline void sdw_debugfs_init(void) {}
+static inline void sdw_debugfs_exit(void) {}
+#endif
+
 enum {
        SDW_MSG_FLAG_READ = 0,
        SDW_MSG_FLAG_WRITE,
 enum {
        SDW_MSG_FLAG_READ = 0,
        SDW_MSG_FLAG_WRITE,
index 2655602f0cfb7492ac53345152ff78e9704a3e24..4a465f55039f4b769463531a67dea7c02e21ac08 100644 (file)
@@ -6,6 +6,7 @@
 #include <linux/pm_domain.h>
 #include <linux/soundwire/sdw.h>
 #include <linux/soundwire/sdw_type.h>
 #include <linux/pm_domain.h>
 #include <linux/soundwire/sdw.h>
 #include <linux/soundwire/sdw_type.h>
+#include "bus.h"
 
 /**
  * sdw_get_device_id - find the matching SoundWire device id
 
 /**
  * sdw_get_device_id - find the matching SoundWire device id
@@ -177,11 +178,13 @@ EXPORT_SYMBOL_GPL(sdw_unregister_driver);
 
 static int __init sdw_bus_init(void)
 {
 
 static int __init sdw_bus_init(void)
 {
+       sdw_debugfs_init();
        return bus_register(&sdw_bus_type);
 }
 
 static void __exit sdw_bus_exit(void)
 {
        return bus_register(&sdw_bus_type);
 }
 
 static void __exit sdw_bus_exit(void)
 {
+       sdw_debugfs_exit();
        bus_unregister(&sdw_bus_type);
 }
 
        bus_unregister(&sdw_bus_type);
 }
 
diff --git a/drivers/soundwire/debugfs.c b/drivers/soundwire/debugfs.c
new file mode 100644 (file)
index 0000000..fb1140e
--- /dev/null
@@ -0,0 +1,151 @@
+// SPDX-License-Identifier: GPL-2.0
+// Copyright(c) 2017-2019 Intel Corporation.
+
+#include <linux/device.h>
+#include <linux/debugfs.h>
+#include <linux/mod_devicetable.h>
+#include <linux/slab.h>
+#include <linux/soundwire/sdw.h>
+#include <linux/soundwire/sdw_registers.h>
+#include "bus.h"
+
+static struct dentry *sdw_debugfs_root;
+
+void sdw_bus_debugfs_init(struct sdw_bus *bus)
+{
+       char name[16];
+
+       if (!sdw_debugfs_root)
+               return;
+
+       /* create the debugfs master-N */
+       snprintf(name, sizeof(name), "master-%d", bus->link_id);
+       bus->debugfs = debugfs_create_dir(name, sdw_debugfs_root);
+}
+
+void sdw_bus_debugfs_exit(struct sdw_bus *bus)
+{
+       debugfs_remove_recursive(bus->debugfs);
+}
+
+#define RD_BUF (3 * PAGE_SIZE)
+
+static ssize_t sdw_sprintf(struct sdw_slave *slave,
+                          char *buf, size_t pos, unsigned int reg)
+{
+       int value;
+
+       value = sdw_read(slave, reg);
+
+       if (value < 0)
+               return scnprintf(buf + pos, RD_BUF - pos, "%3x\tXX\n", reg);
+       else
+               return scnprintf(buf + pos, RD_BUF - pos,
+                               "%3x\t%2x\n", reg, value);
+}
+
+static int sdw_slave_reg_show(struct seq_file *s_file, void *data)
+{
+       struct sdw_slave *slave = s_file->private;
+       char *buf;
+       ssize_t ret;
+       int i, j;
+
+       buf = kzalloc(RD_BUF, GFP_KERNEL);
+       if (!buf)
+               return -ENOMEM;
+
+       ret = scnprintf(buf, RD_BUF, "Register  Value\n");
+
+       /* DP0 non-banked registers */
+       ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP0\n");
+       for (i = SDW_DP0_INT; i <= SDW_DP0_PREPARECTRL; i++)
+               ret += sdw_sprintf(slave, buf, ret, i);
+
+       /* DP0 Bank 0 registers */
+       ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
+       ret += sdw_sprintf(slave, buf, ret, SDW_DP0_CHANNELEN);
+       for (i = SDW_DP0_SAMPLECTRL1; i <= SDW_DP0_LANECTRL; i++)
+               ret += sdw_sprintf(slave, buf, ret, i);
+
+       /* DP0 Bank 1 registers */
+       ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
+       ret += sdw_sprintf(slave, buf, ret,
+                       SDW_DP0_CHANNELEN + SDW_BANK1_OFFSET);
+       for (i = SDW_DP0_SAMPLECTRL1 + SDW_BANK1_OFFSET;
+                       i <= SDW_DP0_LANECTRL + SDW_BANK1_OFFSET; i++)
+               ret += sdw_sprintf(slave, buf, ret, i);
+
+       /* SCP registers */
+       ret += scnprintf(buf + ret, RD_BUF - ret, "\nSCP\n");
+       for (i = SDW_SCP_INT1; i <= SDW_SCP_BANKDELAY; i++)
+               ret += sdw_sprintf(slave, buf, ret, i);
+       for (i = SDW_SCP_DEVID_0; i <= SDW_SCP_DEVID_5; i++)
+               ret += sdw_sprintf(slave, buf, ret, i);
+
+       /*
+        * SCP Bank 0/1 registers are read-only and cannot be
+        * retrieved from the Slave. The Master typically keeps track
+        * of the current frame size so the information can be found
+        * in other places
+        */
+
+       /* DP1..14 registers */
+       for (i = 1; SDW_VALID_PORT_RANGE(i); i++) {
+
+               /* DPi registers */
+               ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP%d\n", i);
+               for (j = SDW_DPN_INT(i); j <= SDW_DPN_PREPARECTRL(i); j++)
+                       ret += sdw_sprintf(slave, buf, ret, j);
+
+               /* DPi Bank0 registers */
+               ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
+               for (j = SDW_DPN_CHANNELEN_B0(i);
+                    j <= SDW_DPN_LANECTRL_B0(i); j++)
+                       ret += sdw_sprintf(slave, buf, ret, j);
+
+               /* DPi Bank1 registers */
+               ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
+               for (j = SDW_DPN_CHANNELEN_B1(i);
+                    j <= SDW_DPN_LANECTRL_B1(i); j++)
+                       ret += sdw_sprintf(slave, buf, ret, j);
+       }
+
+       seq_printf(s_file, "%s", buf);
+       kfree(buf);
+
+       return 0;
+}
+DEFINE_SHOW_ATTRIBUTE(sdw_slave_reg);
+
+void sdw_slave_debugfs_init(struct sdw_slave *slave)
+{
+       struct dentry *master;
+       struct dentry *d;
+       char name[32];
+
+       master = slave->bus->debugfs;
+
+       /* create the debugfs slave-name */
+       snprintf(name, sizeof(name), "%s", dev_name(&slave->dev));
+       d = debugfs_create_dir(name, master);
+
+       debugfs_create_file("registers", 0400, d, slave, &sdw_slave_reg_fops);
+
+       slave->debugfs = d;
+}
+
+void sdw_slave_debugfs_exit(struct sdw_slave *slave)
+{
+       debugfs_remove_recursive(slave->debugfs);
+}
+
+void sdw_debugfs_init(void)
+{
+       sdw_debugfs_root = debugfs_create_dir("soundwire", NULL);
+}
+
+void sdw_debugfs_exit(void)
+{
+       debugfs_remove_recursive(sdw_debugfs_root);
+}
index f39a5815e25dcf4b98e8cc270659d7968d20c71f..4b522f6d123872d622a34f5ab4370b6595e2d87c 100644 (file)
@@ -56,6 +56,7 @@ static int sdw_slave_add(struct sdw_bus *bus,
                mutex_unlock(&bus->bus_lock);
                put_device(&slave->dev);
        }
                mutex_unlock(&bus->bus_lock);
                put_device(&slave->dev);
        }
+       sdw_slave_debugfs_init(slave);
 
        return ret;
 }
 
        return ret;
 }
index 131d49ef1cb4bdbc90b67da1dfddd3afb4fe8dce..2028318a4c62082623b428875da1d5edba3c2812 100644 (file)
@@ -542,6 +542,7 @@ struct sdw_slave_ops {
  * @bus: Bus handle
  * @ops: Slave callback ops
  * @prop: Slave properties
  * @bus: Bus handle
  * @ops: Slave callback ops
  * @prop: Slave properties
+ * @debugfs: Slave debugfs
  * @node: node for bus list
  * @port_ready: Port ready completion flag for each Slave port
  * @dev_num: Device Number assigned by Bus
  * @node: node for bus list
  * @port_ready: Port ready completion flag for each Slave port
  * @dev_num: Device Number assigned by Bus
@@ -553,6 +554,9 @@ struct sdw_slave {
        struct sdw_bus *bus;
        const struct sdw_slave_ops *ops;
        struct sdw_slave_prop prop;
        struct sdw_bus *bus;
        const struct sdw_slave_ops *ops;
        struct sdw_slave_prop prop;
+#ifdef CONFIG_DEBUG_FS
+       struct dentry *debugfs;
+#endif
        struct list_head node;
        struct completion *port_ready;
        u16 dev_num;
        struct list_head node;
        struct completion *port_ready;
        u16 dev_num;
@@ -729,6 +733,7 @@ struct sdw_master_ops {
  * @m_rt_list: List of Master instance of all stream(s) running on Bus. This
  * is used to compute and program bus bandwidth, clock, frame shape,
  * transport and port parameters
  * @m_rt_list: List of Master instance of all stream(s) running on Bus. This
  * is used to compute and program bus bandwidth, clock, frame shape,
  * transport and port parameters
+ * @debugfs: Bus debugfs
  * @defer_msg: Defer message
  * @clk_stop_timeout: Clock stop timeout computed
  * @bank_switch_timeout: Bank switch timeout computed
  * @defer_msg: Defer message
  * @clk_stop_timeout: Clock stop timeout computed
  * @bank_switch_timeout: Bank switch timeout computed
@@ -748,6 +753,9 @@ struct sdw_bus {
        struct sdw_bus_params params;
        struct sdw_master_prop prop;
        struct list_head m_rt_list;
        struct sdw_bus_params params;
        struct sdw_master_prop prop;
        struct list_head m_rt_list;
+#ifdef CONFIG_DEBUG_FS
+       struct dentry *debugfs;
+#endif
        struct sdw_defer defer_msg;
        unsigned int clk_stop_timeout;
        u32 bank_switch_timeout;
        struct sdw_defer defer_msg;
        unsigned int clk_stop_timeout;
        u32 bank_switch_timeout;