Skip to content

soundwire: debugfs: add root-level peripherals table #5738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bardliao wants to merge 1 commit into
base: topic/sof-dev
Choose a base branch
from
+72 −0
Open

soundwire: debugfs: add root-level peripherals table #5738

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions drivers/soundwire/debugfs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,82 @@
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/soundwire/sdw.h>
#include <linux/soundwire/sdw_type.h>
#include <linux/soundwire/sdw_registers.h>
#include <linux/string_choices.h>
#include "bus.h"

static struct dentry *sdw_debugfs_root;

#define SDW_PERIPH_HEADER_FMT "%-28s %-7s %-16s %-6s %-7s %-8s %-9s %-11s\n"
#define SDW_PERIPH_ENTRY_FMT "%-28s %-7u %#016llx %-6.4x %-7.4x %-8.2x %-9.2x %-11.1x\n"
Comment on lines +19 to +20
Copy link
Copy Markdown
Collaborator Author

@bardliao bardliao May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output looks like

cat peripherals
master-0-2
name                         dev_num addr             mfg_id part_id class_id unique_id sdw_version
sdw:0:2:01fa:4245:01         6       0x023001fa424501 01fa   4245    01       ff        3

master-0-3
name                         dev_num addr             mfg_id part_id class_id unique_id sdw_version
sdw:0:3:01fa:3563:01:1       1       0x033101fa356301 01fa   3563    01       01        3
sdw:0:3:01fa:3563:01:3       2       0x033301fa356301 01fa   3563    01       03        3

So, it should be fine.


static u64 sdw_slave_addr_from_id(struct sdw_bus *bus,
const struct sdw_slave_id *id)
{
u64 addr = 0;
u8 unique_id = id->unique_id;

if (unique_id == SDW_IGNORED_UNIQUE_ID)
unique_id = 0;

addr |= FIELD_PREP(SDW_DISCO_LINK_ID_MASK, bus->link_id);
addr |= FIELD_PREP(SDW_VERSION_MASK, id->sdw_version);
addr |= FIELD_PREP(SDW_UNIQUE_ID_MASK, unique_id);
addr |= FIELD_PREP(SDW_MFG_ID_MASK, id->mfg_id);
addr |= FIELD_PREP(SDW_PART_ID_MASK, id->part_id);
addr |= FIELD_PREP(SDW_CLASS_ID_MASK, id->class_id);

return addr;
}

static void sdw_dump_bus_peripherals(struct seq_file *s_file, struct sdw_bus *bus)
{
struct sdw_slave *slave;
u64 addr;

seq_printf(s_file, "master-%d-%d\n",
bus->controller_id, bus->link_id);
seq_printf(s_file, SDW_PERIPH_HEADER_FMT,
"name", "dev_num", "addr", "mfg_id", "part_id",
"class_id", "unique_id", "sdw_version");

Comment on lines +46 to +51
Copy link
Copy Markdown
Collaborator Author

@bardliao bardliao May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ATTACHED status is unreliable. And the "get the detected status by the dev_num." description in the commit message is to let the user know that we can know if the peripheral is detected or not according to its dev_num.

mutex_lock(&bus->bus_lock);
list_for_each_entry(slave, &bus->slaves, node) {
addr = sdw_slave_addr_from_id(bus, &slave->id);
seq_printf(s_file, SDW_PERIPH_ENTRY_FMT,
dev_name(&slave->dev), slave->dev_num,
addr,
slave->id.mfg_id, slave->id.part_id,
slave->id.class_id, slave->id.unique_id,
slave->id.sdw_version);
Comment on lines +54 to +60
}
mutex_unlock(&bus->bus_lock);

seq_putc(s_file, '\n');
}

static int sdw_root_peripherals_dump(struct device *dev, void *data)
{
struct sdw_master_device *md;
struct seq_file *s_file = data;

if (dev->type != &sdw_master_type)
return 0;

md = dev_to_sdw_master_device(dev);
sdw_dump_bus_peripherals(s_file, md->bus);

return 0;
}

static int sdw_root_peripherals_show(struct seq_file *s_file, void *data)
{
return bus_for_each_dev(&sdw_bus_type, NULL, s_file,
sdw_root_peripherals_dump);
}
DEFINE_SHOW_ATTRIBUTE(sdw_root_peripherals);

void sdw_bus_debugfs_init(struct sdw_bus *bus)
{
char name[16];
Expand Down Expand Up @@ -372,6 +442,8 @@ void sdw_slave_debugfs_exit(struct sdw_slave *slave)
void sdw_debugfs_init(void)
{
sdw_debugfs_root = debugfs_create_dir("soundwire", NULL);
debugfs_create_file("peripherals", 0400, sdw_debugfs_root, NULL,
&sdw_root_peripherals_fops);
}

void sdw_debugfs_exit(void)
Expand Down
Loading