soundwire: add debugfs support

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.

Pierre-Louis Bossart committed 7 years ago

Commit bf034731 parent e87cf357 files · +189 −0Browse files

Unified · Split

7 files

drivers/soundwire/Makefile +4 −0
drivers/soundwire/bus.c +6 −0
drivers/soundwire/bus.h +16 −0
drivers/soundwire/bus_type.c +3 −0
drivers/soundwire/debugfs.c +151 −0
drivers/soundwire/slave.c +1 −0
include/linux/soundwire/sdw.h +8 −0

drivers/soundwire/Makefile+4−0

 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

drivers/soundwire/bus.c+6−0

 		}
 	}
+	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
 	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 */
 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);

drivers/soundwire/bus.h+16−0

@@ -18,6 +18,22 @@ static inline int sdw_acpi_find_slaves(struct sdw_bus *bus) · 17 unmodified lines
18	void sdw_extract_slave_id(struct sdw_bus *bus,	18	void sdw_extract_slave_id(struct sdw_bus *bus,
19	u64 addr, struct sdw_slave_id *id);	19	u64 addr, struct sdw_slave_id *id);
20		20
		21	#ifdef CONFIG_DEBUG_FS
		22	void sdw_bus_debugfs_init(struct sdw_bus *bus);
		23	void sdw_bus_debugfs_exit(struct sdw_bus *bus);
		24	void sdw_slave_debugfs_init(struct sdw_slave *slave);
		25	void sdw_slave_debugfs_exit(struct sdw_slave *slave);
		26	void sdw_debugfs_init(void);
		27	void sdw_debugfs_exit(void);
		28	#else
		29	static inline void sdw_bus_debugfs_init(struct sdw_bus *bus) {}
		30	static inline void sdw_bus_debugfs_exit(struct sdw_bus *bus) {}
		31	static inline void sdw_slave_debugfs_init(struct sdw_slave *slave) {}
		32	static inline void sdw_slave_debugfs_exit(struct sdw_slave *slave) {}
		33	static inline void sdw_debugfs_init(void) {}
		34	static inline void sdw_debugfs_exit(void) {}
		35	#endif
		36
21	enum {	37	enum {
22	SDW_MSG_FLAG_READ = 0,	38	SDW_MSG_FLAG_READ = 0,
23	SDW_MSG_FLAG_WRITE,	39	SDW_MSG_FLAG_WRITE,

drivers/soundwire/bus_type.c+3−0

 #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
 static int __init sdw_bus_init(void)
 {
+	sdw_debugfs_init();
 	return bus_register(&sdw_bus_type);
 }
 static void __exit sdw_bus_exit(void)
 {
+	sdw_debugfs_exit();
 	bus_unregister(&sdw_bus_type);
 }

drivers/soundwire/debugfs.c+151−0

@@ -0,0 +1,151 @@
	1	// SPDX-License-Identifier: GPL-2.0
	2	// Copyright(c) 2017-2019 Intel Corporation.
	3
	4	#include <linux/device.h>
	5	#include <linux/debugfs.h>
	6	#include <linux/mod_devicetable.h>
	7	#include <linux/slab.h>
	8	#include <linux/soundwire/sdw.h>
	9	#include <linux/soundwire/sdw_registers.h>
	10	#include "bus.h"
	11
	12	static struct dentry *sdw_debugfs_root;
	13
	14	void sdw_bus_debugfs_init(struct sdw_bus *bus)
	15	{
	16	char name[16];
	17
	18	if (!sdw_debugfs_root)
	19	return;
	20
	21	/* create the debugfs master-N */
	22	snprintf(name, sizeof(name), "master-%d", bus->link_id);
	23	bus->debugfs = debugfs_create_dir(name, sdw_debugfs_root);
	24	}
	25
	26	void sdw_bus_debugfs_exit(struct sdw_bus *bus)
	27	{
	28	debugfs_remove_recursive(bus->debugfs);
	29	}
	30
	31	#define RD_BUF (3 * PAGE_SIZE)
	32
	33	static ssize_t sdw_sprintf(struct sdw_slave *slave,
	34	char *buf, size_t pos, unsigned int reg)
	35	{
	36	int value;
	37
	38	value = sdw_read(slave, reg);
	39
	40	if (value < 0)
	41	return scnprintf(buf + pos, RD_BUF - pos, "%3x\tXX\n", reg);
	42	else
	43	return scnprintf(buf + pos, RD_BUF - pos,
	44	"%3x\t%2x\n", reg, value);
	45	}
	46
	47	static int sdw_slave_reg_show(struct seq_file s_file, void data)
	48	{
	49	struct sdw_slave *slave = s_file->private;
	50	char *buf;
	51	ssize_t ret;
	52	int i, j;
	53
	54	buf = kzalloc(RD_BUF, GFP_KERNEL);
	55	if (!buf)
	56	return -ENOMEM;
	57
	58	ret = scnprintf(buf, RD_BUF, "Register Value\n");
	59
	60	/* DP0 non-banked registers */
	61	ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP0\n");
	62	for (i = SDW_DP0_INT; i <= SDW_DP0_PREPARECTRL; i++)
	63	ret += sdw_sprintf(slave, buf, ret, i);
	64
	65	/* DP0 Bank 0 registers */
	66	ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
	67	ret += sdw_sprintf(slave, buf, ret, SDW_DP0_CHANNELEN);
	68	for (i = SDW_DP0_SAMPLECTRL1; i <= SDW_DP0_LANECTRL; i++)
	69	ret += sdw_sprintf(slave, buf, ret, i);
	70
	71	/* DP0 Bank 1 registers */
	72	ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
	73	ret += sdw_sprintf(slave, buf, ret,
	74	SDW_DP0_CHANNELEN + SDW_BANK1_OFFSET);
	75	for (i = SDW_DP0_SAMPLECTRL1 + SDW_BANK1_OFFSET;
	76	i <= SDW_DP0_LANECTRL + SDW_BANK1_OFFSET; i++)
	77	ret += sdw_sprintf(slave, buf, ret, i);
	78
	79	/* SCP registers */
	80	ret += scnprintf(buf + ret, RD_BUF - ret, "\nSCP\n");
	81	for (i = SDW_SCP_INT1; i <= SDW_SCP_BANKDELAY; i++)
	82	ret += sdw_sprintf(slave, buf, ret, i);
	83	for (i = SDW_SCP_DEVID_0; i <= SDW_SCP_DEVID_5; i++)
	84	ret += sdw_sprintf(slave, buf, ret, i);
	85
	86	/*
	87	* SCP Bank 0/1 registers are read-only and cannot be
	88	* retrieved from the Slave. The Master typically keeps track
	89	* of the current frame size so the information can be found
	90	* in other places
	91	*/
	92
	93	/* DP1..14 registers */
	94	for (i = 1; SDW_VALID_PORT_RANGE(i); i++) {
	95
	96	/* DPi registers */
	97	ret += scnprintf(buf + ret, RD_BUF - ret, "\nDP%d\n", i);
	98	for (j = SDW_DPN_INT(i); j <= SDW_DPN_PREPARECTRL(i); j++)
	99	ret += sdw_sprintf(slave, buf, ret, j);
	100
	101	/* DPi Bank0 registers */
	102	ret += scnprintf(buf + ret, RD_BUF - ret, "Bank0\n");
	103	for (j = SDW_DPN_CHANNELEN_B0(i);
	104	j <= SDW_DPN_LANECTRL_B0(i); j++)
	105	ret += sdw_sprintf(slave, buf, ret, j);
	106
	107	/* DPi Bank1 registers */
	108	ret += scnprintf(buf + ret, RD_BUF - ret, "Bank1\n");
	109	for (j = SDW_DPN_CHANNELEN_B1(i);
	110	j <= SDW_DPN_LANECTRL_B1(i); j++)
	111	ret += sdw_sprintf(slave, buf, ret, j);
	112	}
	113
	114	seq_printf(s_file, "%s", buf);
	115	kfree(buf);
	116
	117	return 0;
	118	}
	119	DEFINE_SHOW_ATTRIBUTE(sdw_slave_reg);
	120
	121	void sdw_slave_debugfs_init(struct sdw_slave *slave)
	122	{
	123	struct dentry *master;
	124	struct dentry *d;
	125	char name[32];
	126
	127	master = slave->bus->debugfs;
	128
	129	/* create the debugfs slave-name */
	130	snprintf(name, sizeof(name), "%s", dev_name(&slave->dev));
	131	d = debugfs_create_dir(name, master);
	132
	133	debugfs_create_file("registers", 0400, d, slave, &sdw_slave_reg_fops);
	134
	135	slave->debugfs = d;
	136	}
	137
	138	void sdw_slave_debugfs_exit(struct sdw_slave *slave)
	139	{
	140	debugfs_remove_recursive(slave->debugfs);
	141	}
	142
	143	void sdw_debugfs_init(void)
	144	{
	145	sdw_debugfs_root = debugfs_create_dir("soundwire", NULL);
	146	}
	147
	148	void sdw_debugfs_exit(void)
	149	{
	150	debugfs_remove_recursive(sdw_debugfs_root);
	151	}

drivers/soundwire/slave.c+1−0

@@ -56,6 +56,7 @@ static int sdw_slave_add(struct sdw_bus *bus, · 55 unmodified lines
56	mutex_unlock(&bus->bus_lock);	56	mutex_unlock(&bus->bus_lock);
57	put_device(&slave->dev);	57	put_device(&slave->dev);
58	}	58	}
		59	sdw_slave_debugfs_init(slave);
59		60
60	return ret;	61	return ret;
61	}	62	}

include/linux/soundwire/sdw.h+8−0

  * @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
 	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;
  * @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
 	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;

soundwire: add debugfs support

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code