ASoC: SOF: Convert the generic probe support to SOF client

Add a new client driver for probes support and move
all the probes-related code from the core to the
client driver.
The probes client driver registers a component driver
with one CPU DAI driver for extraction and creates a
new sound card with one DUMMY DAI link with a dummy codec
that will be used for extracting audio data from specific
points in the audio pipeline.
The probes debugfs ops are based on the initial
implementation by Cezary Rojewski and have been moved
out of the SOF core into the client driver making it
easier to maintain. This change will make it easier
for the probes functionality to be added for all platforms
without having the need to modify the existing(15+) machine
drivers.
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>

Author: ujfalusi

sound/soc/sof/Kconfig

@@ -53,13 +53,14 @@ config SND_SOC_SOF_COMPRESS
 	select SND_SOC_COMPRESS
 
 config SND_SOC_SOF_DEBUG_PROBES
-	bool "SOF enable data probing"
+	tristate
+	select SND_SOC_SOF_CLIENT
 	select SND_SOC_COMPRESS
 	help
  This option enables the data probing feature that can be used to
  gather data directly from specific points of the audio pipeline.
-Say Y if you want to enable probes.
-If unsure, select "N".
+This option is not user-selectable but automagically handled by
+'select' statements at a higher level.
 
 config SND_SOC_SOF_CLIENT
 	tristate

sound/soc/sof/Makefile

@@ -4,7 +4,6 @@ snd-sof-objs := core.o ops.o loader.o ipc.o pcm.o pm.o debug.o topology.o\
  control.o trace.o iomem-utils.o sof-audio.o stream-ipc.o ipc4.o
 snd-sof-$(CONFIG_SND_SOC_SOF_CLIENT) += sof-client.o
 
-snd-sof-$(CONFIG_SND_SOC_SOF_DEBUG_PROBES) += sof-probes.o
 snd-sof-$(CONFIG_SND_SOC_SOF_COMPRESS) += compress.o
 
 snd-sof-pci-objs := sof-pci-dev.o
@@ -13,6 +12,7 @@ snd-sof-of-objs := sof-of-dev.o
 
 snd-sof-ipc-flood-test-objs := sof-client-ipc-flood-test.o
 snd-sof-ipc-msg-injector-objs := sof-client-ipc-msg-injector.o
+snd-sof-probes-objs := sof-client-probes.o
 
 snd-sof-nocodec-objs := nocodec.o
 
@@ -29,6 +29,7 @@ obj-$(CONFIG_SND_SOC_SOF_PCI_DEV) += snd-sof-pci.o
 
 obj-$(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST) += snd-sof-ipc-flood-test.o
 obj-$(CONFIG_SND_SOC_SOF_DEBUG_IPC_MSG_INJECTOR) += snd-sof-ipc-msg-injector.o
+obj-$(CONFIG_SND_SOC_SOF_DEBUG_PROBES) += snd-sof-probes.o
 
 obj-$(CONFIG_SND_SOC_SOF_INTEL_TOPLEVEL) += intel/
 obj-$(CONFIG_SND_SOC_SOF_IMX_TOPLEVEL) += imx/

sound/soc/sof/core.c

@@ -14,9 +14,6 @@
 #include<sound/sof.h>
 #include"sof-priv.h"
 #include"ops.h"
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
-#include"sof-probes.h"
-#endif
 
 /* see SOF_DBG_ flags */
 staticintsof_core_debug=IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE);
@@ -358,9 +355,6 @@ int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data)
 
 sdev->pdata=plat_data;
 sdev->first_boot= true;
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
-sdev->extractor_stream_tag=SOF_PROBE_INVALID_NODE_ID;
-#endif
 dev_set_drvdata(dev, sdev);
 
 /* check all mandatory ops */

sound/soc/sof/debug.c

@@ -19,221 +19,6 @@
 #include"sof-priv.h"
 #include"ops.h"
 
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
-#include"sof-probes.h"
-
-/**
- * strsplit_u32 - Split string into sequence of u32 tokens
- * @buf:	String to split into tokens.
- * @delim:	String containing delimiter characters.
- * @tkns:	Returned u32 sequence pointer.
- * @num_tkns:	Returned number of tokens obtained.
- */
-staticint
-strsplit_u32(char**buf, constchar*delim, u32**tkns, size_t*num_tkns)
-{
-char*s;
-u32*data, *tmp;
-size_tcount=0;
-size_tcap=32;
-intret=0;
-
-*tkns=NULL;
-*num_tkns=0;
-data=kcalloc(cap, sizeof(*data), GFP_KERNEL);
-if (!data)
-return-ENOMEM;
-
-while ((s=strsep(buf, delim)) !=NULL) {
-ret=kstrtouint(s, 0, data+count);
-if (ret)
- goto exit;
-if (++count >= cap) {
-cap *= 2;
-tmp=krealloc(data, cap*sizeof(*data), GFP_KERNEL);
-if (!tmp) {
-ret=-ENOMEM;
- goto exit;
- }
-data=tmp;
- }
-	}
-
-if (!count)
- goto exit;
-*tkns=kmemdup(data, count*sizeof(*data), GFP_KERNEL);
-if (*tkns==NULL) {
-ret=-ENOMEM;
- goto exit;
-	}
-*num_tkns=count;
-
-exit:
-kfree(data);
-returnret;
-}
-
-staticinttokenize_input(constchar__user*from, size_tcount,
-loff_t*ppos, u32**tkns, size_t*num_tkns)
-{
-char*buf;
-intret;
-
-buf=kmalloc(count+1, GFP_KERNEL);
-if (!buf)
-return-ENOMEM;
-
-ret=simple_write_to_buffer(buf, count, ppos, from, count);
-if (ret!=count) {
-ret=ret >= 0 ? -EIO : ret;
- goto exit;
-	}
-
-buf[count] ='\0';
-ret=strsplit_u32((char**)&buf, ",", tkns, num_tkns);
-exit:
-kfree(buf);
-returnret;
-}
-
-staticssize_tprobe_points_read(structfile*file,
-char__user*to, size_tcount, loff_t*ppos)
-{
-structsnd_sof_dfsentry*dfse=file->private_data;
-structsnd_sof_dev*sdev=dfse->sdev;
-structsof_probe_point_desc*desc;
-size_tnum_desc, len=0;
-char*buf;
-inti, ret;
-
-if (sdev->extractor_stream_tag==SOF_PROBE_INVALID_NODE_ID) {
-dev_warn(sdev->dev, "no extractor stream running\n");
-return-ENOENT;
-	}
-
-buf=kzalloc(PAGE_SIZE, GFP_KERNEL);
-if (!buf)
-return-ENOMEM;
-
-ret=sof_ipc_probe_points_info(sdev, &desc, &num_desc);
-if (ret<0)
- goto exit;
-
-for (i=0; i<num_desc; i++) {
-ret=snprintf(buf+len, PAGE_SIZE-len,
-"Id: %#010x Purpose: %d Node id: %#x\n",
-desc[i].buffer_id, desc[i].purpose, desc[i].stream_tag);
-if (ret<0)
- goto free_desc;
-len+=ret;
-	}
-
-ret=simple_read_from_buffer(to, count, ppos, buf, len);
-free_desc:
-kfree(desc);
-exit:
-kfree(buf);
-returnret;
-}
-
-staticssize_tprobe_points_write(structfile*file,
-constchar__user*from, size_tcount, loff_t*ppos)
-{
-structsnd_sof_dfsentry*dfse=file->private_data;
-structsnd_sof_dev*sdev=dfse->sdev;
-structsof_probe_point_desc*desc;
-size_tnum_tkns, bytes;
-u32*tkns;
-intret;
-
-if (sdev->extractor_stream_tag==SOF_PROBE_INVALID_NODE_ID) {
-dev_warn(sdev->dev, "no extractor stream running\n");
-return-ENOENT;
-	}
-
-ret=tokenize_input(from, count, ppos, &tkns, &num_tkns);
-if (ret<0)
-returnret;
-bytes=sizeof(*tkns) *num_tkns;
-if (!num_tkns|| (bytes % sizeof(*desc))) {
-ret=-EINVAL;
- goto exit;
-	}
-
-desc= (structsof_probe_point_desc*)tkns;
-ret=sof_ipc_probe_points_add(sdev,
-desc, bytes / sizeof(*desc));
-if (!ret)
-ret=count;
-exit:
-kfree(tkns);
-returnret;
-}
-
-staticconststructfile_operationsprobe_points_fops= {
-	.open=simple_open,
-	.read=probe_points_read,
-	.write=probe_points_write,
-	.llseek=default_llseek,
-};
-
-staticssize_tprobe_points_remove_write(structfile*file,
-constchar__user*from, size_tcount, loff_t*ppos)
-{
-structsnd_sof_dfsentry*dfse=file->private_data;
-structsnd_sof_dev*sdev=dfse->sdev;
-size_tnum_tkns;
-u32*tkns;
-intret;
-
-if (sdev->extractor_stream_tag==SOF_PROBE_INVALID_NODE_ID) {
-dev_warn(sdev->dev, "no extractor stream running\n");
-return-ENOENT;
-	}
-
-ret=tokenize_input(from, count, ppos, &tkns, &num_tkns);
-if (ret<0)
-returnret;
-if (!num_tkns) {
-ret=-EINVAL;
- goto exit;
-	}
-
-ret=sof_ipc_probe_points_remove(sdev, tkns, num_tkns);
-if (!ret)
-ret=count;
-exit:
-kfree(tkns);
-returnret;
-}
-
-staticconststructfile_operationsprobe_points_remove_fops= {
-	.open=simple_open,
-	.write=probe_points_remove_write,
-	.llseek=default_llseek,
-};
-
-staticintsnd_sof_debugfs_probe_item(structsnd_sof_dev*sdev,
-constchar*name, mode_tmode,
-conststructfile_operations*fops)
-{
-structsnd_sof_dfsentry*dfse;
-
-dfse=devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
-if (!dfse)
-return-ENOMEM;
-
-dfse->type=SOF_DFSENTRY_TYPE_BUF;
-dfse->sdev=sdev;
-
-debugfs_create_file(name, mode, sdev->debugfs_root, dfse, fops);
-/* add to dfsentry list */
-list_add(&dfse->list, &sdev->dfsentry_list);
-
-return0;
-}
-#endif
-
 staticssize_tsof_dfsentry_write(structfile*file, constchar__user*buffer,
 size_tcount, loff_t*ppos)
 {
@@ -569,17 +354,6 @@ int snd_sof_dbg_init(struct snd_sof_dev *sdev)
 returnerr;
 	}
 
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_PROBES)
-err=snd_sof_debugfs_probe_item(sdev, "probe_points",
-0644, &probe_points_fops);
-if (err<0)
-returnerr;
-err=snd_sof_debugfs_probe_item(sdev, "probe_points_remove",
-0200, &probe_points_remove_fops);
-if (err<0)
-returnerr;
-#endif
-
 return0;
 }
 EXPORT_SYMBOL_GPL(snd_sof_dbg_init);

sound/soc/sof/intel/Kconfig

@@ -215,6 +215,7 @@ config SND_SOC_SOF_HDA_COMMON
 	select SND_SOC_SOF_PCI_DEV
 	select SND_INTEL_DSP_CONFIG
 	select SND_SOC_SOF_HDA_LINK_BASELINE
+	select SND_SOC_SOF_HDA_PROBES
 	help
  This option is not user-selectable but automagically handled by
  'select' statements at a higher level.
@@ -240,15 +241,6 @@ config SND_SOC_SOF_HDA_AUDIO_CODEC
  Say Y if you want to enable HDAudio codecs with SOF.
  If unsure select "N".
 
-config SND_SOC_SOF_HDA_PROBES
-	bool "SOF enable probes over HDA"
-	depends on SND_SOC_SOF_DEBUG_PROBES
-	help
- This option enables the data probing for Intel(R)
- Skylake and newer platforms.
- Say Y if you want to enable probes.
- If unsure, select "N".
-
 endif ## SND_SOC_SOF_HDA_COMMON
 
 config SND_SOC_SOF_HDA_LINK_BASELINE
@@ -266,6 +258,15 @@ config SND_SOC_SOF_HDA
  This option is not user-selectable but automagically handled by
  'select' statements at a higher level.
 
+config SND_SOC_SOF_HDA_PROBES
+	bool
+	select SND_SOC_SOF_DEBUG_PROBES
+	help
+ The option enables the data probing for Intel(R) Skylake and newer
+ (HDA) platforms.
+ This option is not user-selectable but automagically handled by
+ 'select' statements at a higher level.
+
 config SND_SOC_SOF_INTEL_SOUNDWIRE_LINK_BASELINE
 	tristate
 	select SOUNDWIRE_INTEL if SND_SOC_SOF_INTEL_SOUNDWIRE

sound/soc/sof/intel/apl.c

@@ -80,15 +80,6 @@ const struct snd_sof_dsp_ops sof_apl_ops = {
 	.pcm_pointer=hda_dsp_pcm_pointer,
 	.pcm_ack=hda_dsp_pcm_ack,
 
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_HDA_PROBES)
-/* probe callbacks */
-	.probe_assign=hda_probe_compr_assign,
-	.probe_free=hda_probe_compr_free,
-	.probe_set_params=hda_probe_compr_set_params,
-	.probe_trigger=hda_probe_compr_trigger,
-	.probe_pointer=hda_probe_compr_pointer,
-#endif
-
 /* firmware loading */
 	.load_firmware=snd_sof_load_firmware_raw,
 
@@ -110,6 +101,10 @@ const struct snd_sof_dsp_ops sof_apl_ops = {
 	.trace_release=hda_dsp_trace_release,
 	.trace_trigger=hda_dsp_trace_trigger,
 
+/* client ops */
+	.register_ipc_clients=hda_register_clients,
+	.unregister_ipc_clients=hda_unregister_clients,
+
 /* DAI drivers */
 	.drv=skl_dai,
 	.num_drv=SOF_SKL_NUM_DAIS,

sound/soc/sof/intel/cnl.c

@@ -300,15 +300,6 @@ const struct snd_sof_dsp_ops sof_cnl_ops = {
 	.pcm_pointer=hda_dsp_pcm_pointer,
 	.pcm_ack=hda_dsp_pcm_ack,
 
-#ifIS_ENABLED(CONFIG_SND_SOC_SOF_HDA_PROBES)
-/* probe callbacks */
-	.probe_assign=hda_probe_compr_assign,
-	.probe_free=hda_probe_compr_free,
-	.probe_set_params=hda_probe_compr_set_params,
-	.probe_trigger=hda_probe_compr_trigger,
-	.probe_pointer=hda_probe_compr_pointer,
-#endif
-
 /* firmware loading */
 	.load_firmware=snd_sof_load_firmware_raw,
 
@@ -330,6 +321,10 @@ const struct snd_sof_dsp_ops sof_cnl_ops = {
 	.trace_release=hda_dsp_trace_release,
 	.trace_trigger=hda_dsp_trace_trigger,
 
+/* client ops */
+	.register_ipc_clients=hda_register_clients,
+	.unregister_ipc_clients=hda_unregister_clients,
+
 /* DAI drivers */
 	.drv=skl_dai,
 	.num_drv=SOF_SKL_NUM_DAIS,