Commit bf03473d authored by Pierre-Louis Bossart's avatar Pierre-Louis Bossart Committed by Vinod Koul
Browse files

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.

Reviewed-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: default avatarSanyog Kale <sanyog.r.kale@intel.com>
Signed-off-by: default avatarPierre-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: default avatarVinod Koul <vkoul@kernel.org>
parent e87cf358

drivers/soundwire/Makefile

+4 −0
Original line number Diff line number Diff line
@@ -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



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
Original line number Diff line number Diff line
@@ -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
@@ -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;



	sdw_slave_debugfs_exit(slave);



	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);



	sdw_bus_debugfs_exit(bus);

}

EXPORT_SYMBOL(sdw_delete_bus_master);

drivers/soundwire/bus.h

+16 −0
Original line number Diff line number Diff line
@@ -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);



#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,

drivers/soundwire/bus_type.c

+3 −0
Original line number Diff line number Diff line
@@ -6,6 +6,7 @@ 
#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
@@ -177,11 +178,13 @@ EXPORT_SYMBOL_GPL(sdw_unregister_driver); 


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

0 → 100644
+151 −0
Original line number Diff line number Diff line 
// 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);

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE