shell: add kctl_list command

Add 'sof kctl_list', a read-only walker over the IPC component
list that prints, per component, the comp_id, pipeline_id, core,
decoded module name (volume / gain / mixin / mixout / eqiir / src /
...) taken from cd->drv->tctx->uuid_p->name, a coarse 'kind' tag
(volume / mixer / blob / config) for control-bearing modules, and
the current comp_state.

Module-adapter components all share SOF_COMP_MODULE_ADAPTER for
drv->type, so the UUID-derived name string is the only stable
per-module label available in firmware. This is enough to identify
which comp_id carries which control before driving the value
through host-side tools.

kctl_get / kctl_set are intentionally not implemented in firmware:
control values flow through per-module IPC4 large_config blobs
(set_configuration / get_configuration), each with their own
config_id namespace and TLV layout, which would duplicate the
host-side tplg / IPC marshalling. Use tinymix / sof-ctl for that.

New Kconfig (default y, depends on SHELL):
  CONFIG_SOF_SHELL_KCTL_LIST

This concludes the documented quick-win list in zephyr/shell.md.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>

Author: lrgirdwo

zephyr/Kconfig

@@ -597,6 +597,26 @@ config SOF_SHELL_DMA_STATUS
 	  free bytes, read/write positions and total_copied. Pairs well
 	  with 'sof dai_list' for diagnosing P2M/M2P paths.
 
+config SOF_SHELL_KCTL_LIST
+	bool "kcontrol introspection command"
+	default y
+	depends on SHELL
+	help
+	  Enables 'sof kctl_list' which walks the IPC component list and
+	  prints, per component, the comp_id, pipeline_id, core, decoded
+	  module name (volume / gain / mixin / mixout / eqiir / src /
+	  ...) taken from the trace UUID context, a coarse 'kind' tag
+	  (volume / mixer / blob / config) for control-bearing modules,
+	  and the current comp_state.
+
+	  This is read-only on purpose. Actual kcontrol get/set values
+	  flow through per-module IPC4 large_config blobs
+	  (set_configuration / get_configuration) which need
+	  module-specific marshalling and are intentionally left to host
+	  tools (tinymix, sof-ctl). Use this command together with 'sof
+	  module_status' to identify which comp_id carries which control
+	  before going through the host path.
+
 endmenu # SOF shell commands
 
 config SOF_VREGIONS

zephyr/shell.md

@@ -69,7 +69,7 @@ debug or testing. Items get ticked off as commands land on `topic/shell`.
 
 | Area | Suggested commands | Status |
 |---|---|---|
-| kcontrols / mixer | `kctl_list`, `kctl_get <id>`, `kctl_set <id> <val>` | TODO |
+| **kcontrols / mixer** | `kctl_list`, `kctl_get <id>`, `kctl_set <id> <val>` | **DONE (task 8)** &mdash; `kctl_list` decodes module names + kind for every component. `kctl_get/set` deferred (per-module IPC4 large_config blobs &mdash; use host tools). |
 | Module runtime config | `mod_config_get/set <mod_id> <inst> <param_id>` | TODO |
 | Stream / copier | `stream_list`, `stream_pause/resume <id>`, `copier_gain_set` | TODO |
 | Clocks (extend `clock_status`) | `clock_set <core> <freq>`, `clock_force <pll>` | TODO |
@@ -116,7 +116,7 @@ debug or testing. Items get ticked off as commands land on `topic/shell`.
 5. **`mailbox_hex` / `dbgwin_dump`** &mdash; DONE (was originally `crash_log`/`bt`; pivoted because SOF panic.c isn't built on Zephyr and `bt` of a running CPU from itself isn't meaningful).
 6. **`perf_status`** &mdash; DONE.
 7. **`dai_list` / `dma_status`** &mdash; DONE.
-8. `kctl_get/set` &mdash; today only doable via tplg/IPC.
+8. **`kctl_get/set`** &mdash; DONE (`kctl_list` only; values stay on host).
 
 ---
 
@@ -392,3 +392,40 @@ debug or testing. Items get ticked off as commands land on `topic/shell`.
   ships its own `dma` shell when `CONFIG_DMA_SHELL=y`, but that one
   walks Zephyr DMA devices and exposes raw register pokes, so the
   two are complementary.
+
+## Task 8 &mdash; `kctl_list`
+
+### Commands
+
+| Command | Description |
+|---|---|
+| `sof kctl_list` | Walk every component in the IPC topology and print `comp_id`, `pipeline_id`, `core`, the decoded module name (`volume`, `gain`, `mixin`, `mixout`, `eqiir`, `src`, ...), a coarse `kind` tag for control-bearing modules (`volume` / `mixer` / `blob` / `config`) and the current `comp_state`. |
+
+### Implementation
+
+- Module-adapter components all share `SOF_COMP_MODULE_ADAPTER` for
+  `drv->type`, so the only stable per-module label available in
+  firmware is the UUID name string from
+  `cd->drv->tctx->uuid_p->name` (the same name the LDC tool prints).
+  `kctl_drv_name()` reads that, `kctl_drv_kind()` maps known module
+  names to a coarse control-family tag.
+- New Kconfig (default `y`, depends on `SHELL`):
+  `CONFIG_SOF_SHELL_KCTL_LIST`.
+- Shell command in [zephyr/sof_shell.c](zephyr/sof_shell.c).
+
+### Notes / follow-ups
+
+- Read-only on purpose. `kctl_get` / `kctl_set` are intentionally
+  not implemented in firmware. Control values flow through
+  per-module IPC4 large_config blobs
+  (`set_configuration` / `get_configuration` in
+  [src/include/module/module/interface.h](src/include/module/module/interface.h)),
+  each with their own `config_id` namespace and TLV layout.
+  Marshalling that from the shell would essentially duplicate the
+  host-side tplg / IPC code path. Use `tinymix` /
+  [sof-ctl](tools/ctl) on the host instead, and pair with
+  `sof module_status` for raw component state.
+- This concludes the documented quick-win list. Future shell
+  commands should follow the same pattern: small, read-only,
+  Kconfig-gated, and complementary to (not a replacement for) the
+  host control plane.

zephyr/sof_shell.c

@@ -2427,6 +2427,108 @@ __cold static int cmd_sof_dma_status(const struct shell *sh,
 
 #endif /* CONFIG_SOF_SHELL_DMA_STATUS */
 
+#if CONFIG_SOF_SHELL_KCTL_LIST
+
+/*
+ * Best-effort decoded driver name. Module-adapter components share
+ * SOF_COMP_MODULE_ADAPTER for drv->type, so the only stable per-module
+ * label available in firmware is the UUID name string from the trace
+ * context (which carries the same name printed by the LDC tool).
+ */
+static const char *kctl_drv_name(const struct comp_dev *cd)
+{
+	if (cd && cd->drv && cd->drv->tctx && cd->drv->tctx->uuid_p &&
+	    cd->drv->tctx->uuid_p->name[0])
+		return cd->drv->tctx->uuid_p->name;
+	return "?";
+}
+
+/*
+ * Tag the modules that are known to expose ALSA-style kcontrols
+ * (volume / gain / mixer-style switches and enums). This is purely a
+ * UI hint -- the actual control values live behind per-module
+ * config_id blobs that need IPC4 large_config marshalling, which is
+ * intentionally out of scope here (see shell.md).
+ */
+static const char *kctl_drv_kind(const char *name)
+{
+	if (!name)
+		return "";
+	if (!strcmp(name, "volume") || !strcmp(name, "gain"))
+		return "volume";
+	if (!strcmp(name, "mixin") || !strcmp(name, "mixout") ||
+	    !strcmp(name, "mixer"))
+		return "mixer";
+	if (!strcmp(name, "eqiir") || !strcmp(name, "eqfir") ||
+	    !strcmp(name, "drc") || !strcmp(name, "multiband_drc") ||
+	    !strcmp(name, "dcblock") || !strcmp(name, "tdfb") ||
+	    !strcmp(name, "crossover") || !strcmp(name, "google_rtc_audio_processing"))
+		return "blob";
+	if (!strcmp(name, "selector") || !strcmp(name, "src") ||
+	    !strcmp(name, "asrc"))
+		return "config";
+	return "";
+}
+
+__cold static int cmd_sof_kctl_list(const struct shell *sh,
+				    size_t argc, char *argv[])
+{
+	struct ipc *ipc = sof_get()->ipc;
+	struct list_item *clist;
+	struct ipc_comp_dev *icd;
+	int count = 0;
+
+	ARG_UNUSED(argc);
+	ARG_UNUSED(argv);
+
+	if (!ipc) {
+		shell_print(sh, "No IPC");
+		return 0;
+	}
+
+	shell_print(sh, "%-12s %-8s %-5s %-24s %-8s %s",
+		    "comp_id", "ppl_id", "core", "module", "kind", "state");
+
+	list_for_item(clist, &ipc->comp_list) {
+		const struct comp_dev *cd;
+		const char *name;
+
+		icd = container_of(clist, struct ipc_comp_dev, list);
+		if (icd->type != COMP_TYPE_COMPONENT)
+			continue;
+
+		cd = icd->cd;
+		name = kctl_drv_name(cd);
+
+		shell_print(sh, "0x%-10x %-8u %-5u %-24s %-8s %s",
+			    icd->id,
+			    cd->pipeline ? cd->pipeline->pipeline_id : 0,
+			    icd->core, name, kctl_drv_kind(name),
+			    comp_state_str(cd->state));
+		count++;
+	}
+
+	if (!count) {
+		shell_print(sh,
+			    "No components found. Start an audio stream first.");
+		return 0;
+	}
+
+	shell_print(sh, "");
+	shell_print(sh,
+		    "kctl get/set is intentionally not exposed here -- control");
+	shell_print(sh,
+		    "values flow through per-module IPC4 large_config blobs");
+	shell_print(sh,
+		    "(set_configuration / get_configuration). Use tinymix /");
+	shell_print(sh,
+		    "sof-ctl on the host, or 'sof module_status' for raw state.");
+
+	return 0;
+}
+
+#endif /* CONFIG_SOF_SHELL_KCTL_LIST */
+
 SHELL_STATIC_SUBCMD_SET_CREATE(sof_commands,
 	SHELL_CMD(test_inject_sched_gap, NULL,
 		  "Inject a gap to audio scheduling\n",
@@ -2648,6 +2750,12 @@ SHELL_STATIC_SUBCMD_SET_CREATE(sof_commands,
 		  cmd_sof_dma_status, 1, 2),
 #endif
 
+#if CONFIG_SOF_SHELL_KCTL_LIST
+	SHELL_CMD(kctl_list, NULL,
+		  "List components and their decoded module name / kind\n",
+		  cmd_sof_kctl_list),
+#endif
+
 	SHELL_SUBCMD_SET_END
 );