ASoC: SOF: Add optional SOF client for dma-trace support

ujfalusi · ujfalusi · commit 38bb9800cdca · 2021-08-10T18:13:20.000+03:00
Add a new client driver to implement the dma-trace functionality outside
of the SOF core.

This is optional for now, if the dma-trace client is enabled via the
SND_SOC_SOF_HDA_DMA_TRACE kconfig option then the core's built in
implementation is force disabled.

Signed-off-by: Peter Ujfalusi &lt;peter.ujfalusi@linux.intel.com&gt;
diff --git a/sound/soc/sof/Kconfig b/sound/soc/sof/Kconfig
@@ -56,6 +56,16 @@ config SND_SOC_SOF_DEBUG_PROBES
 	  This option is not user-selectable but automagically handled by
 	  'select' statements at a higher level.
 
+config SND_SOC_SOF_DEBUG_DMA_TRACE
+	tristate
+	select SND_SOC_SOF_CLIENT
+	help
+	  This option enables the dma-trace feature that can be used to
+	  gather trace information in close to real time from firmware, backed
+	  by DMA.
+	  This option is not user-selectable but automagically handled by
+	  'select' statements at a higher level.
+
 config SND_SOC_SOF_PCM_DISABLE_PAUSE
 	bool "SOF disable pause push/release"
 	help
diff --git a/sound/soc/sof/Makefile b/sound/soc/sof/Makefile
@@ -10,6 +10,7 @@ snd-sof-of-objs := sof-of-dev.o
 
 snd-sof-ipc-test-objs := sof-client-ipc-test.o
 snd-sof-probes-objs := sof-client-probes.o
+snd-sof-dma-trace-objs := sof-client-dma-trace.o
 
 snd-sof-nocodec-objs := nocodec.o
 
@@ -26,6 +27,7 @@ obj-$(CONFIG_SND_SOC_SOF_PCI_DEV) += snd-sof-pci.o
 
 obj-$(CONFIG_SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST) += snd-sof-ipc-test.o
 obj-$(CONFIG_SND_SOC_SOF_DEBUG_PROBES) += snd-sof-probes.o
+obj-$(CONFIG_SND_SOC_SOF_DEBUG_DMA_TRACE) += snd-sof-dma-trace.o
 
 obj-$(CONFIG_SND_SOC_SOF_INTEL_TOPLEVEL) += intel/
 obj-$(CONFIG_SND_SOC_SOF_IMX_TOPLEVEL) += imx/
diff --git a/sound/soc/sof/core.c b/sound/soc/sof/core.c
@@ -199,6 +199,10 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
 		goto fw_run_err;
 	}
 
+#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_DMA_TRACE)
+	/* trace support via SOF client */
+	sdev->dtrace_is_supported = false;
+#else
 	if (sof_core_debug & SOF_DBG_ENABLE_TRACE) {
 		sdev->dtrace_is_supported = true;
 
@@ -213,6 +217,7 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
 	} else {
 		dev_dbg(sdev->dev, "SOF firmware trace disabled\n");
 	}
+#endif
 
 	/* hereafter all FW boot flows are for PM reasons */
 	sdev->first_boot = false;
diff --git a/sound/soc/sof/intel/Kconfig b/sound/soc/sof/intel/Kconfig
@@ -15,6 +15,20 @@ config SND_SOC_SOF_INTEL_HIFI_EP_IPC
 	  This option is not user-selectable but automagically handled by
 	  'select' statements at a higher level.
 
+#config SND_SOC_SOF_HDA_DMA_TRACE
+#	tristate
+#	select SND_SOC_SOF_DEBUG_DMA_TRACE
+#	help
+#	  This option is not user-selectable but automagically handled by
+#	  'select' statements at a higher level.
+
+config SND_SOC_SOF_HDA_DMA_TRACE
+	bool "Enable dma-trace for HDA"
+	select SND_SOC_SOF_DEBUG_DMA_TRACE
+	help
+	  This option is not user-selectable but automagically handled by
+	  'select' statements at a higher level.
+
 config SND_SOC_SOF_INTEL_ATOM_HIFI_EP
 	tristate
 	select SND_SOC_SOF_INTEL_COMMON
@@ -31,6 +45,7 @@ config SND_SOC_SOF_INTEL_COMMON
 	select SND_SOC_INTEL_MACH
 	select SND_SOC_ACPI if ACPI
 	select SND_INTEL_DSP_CONFIG
+#	select SND_SOC_SOF_HDA_DMA_TRACE
 	help
 	  This option is not user-selectable but automagically handled by
 	  'select' statements at a higher level.
diff --git a/sound/soc/sof/intel/Makefile b/sound/soc/sof/intel/Makefile
@@ -5,11 +5,12 @@ snd-sof-acpi-intel-bdw-objs := bdw.o
 
 snd-sof-intel-ipc-objs := intel-ipc.o
 
-snd-sof-intel-hda-common-objs := hda.o hda-loader.o hda-stream.o hda-trace.o \
-				 hda-dsp.o hda-ipc.o hda-ctrl.o hda-pcm.o \
-				 hda-dai.o hda-bus.o \
-				 apl.o cnl.o tgl.o icl.o
+snd-sof-intel-hda-common-objs := hda.o hda-loader.o hda-stream.o hda-dsp.o \
+				 hda-ipc.o hda-ctrl.o hda-pcm.o hda-dai.o \
+				 hda-bus.o apl.o cnl.o tgl.o icl.o
 snd-sof-intel-hda-common-$(CONFIG_SND_SOC_SOF_HDA_PROBES) += hda-probes.o
+# snd-sof-intel-hda-common-$(CONFIG_SND_SOC_SOF_HDA_DMA_TRACE) += hda-trace.o
+snd-sof-intel-hda-common-objs += hda-trace.o
 
 snd-sof-intel-hda-objs := hda-codec.o
 
diff --git a/sound/soc/sof/intel/apl.c b/sound/soc/sof/intel/apl.c
@@ -27,12 +27,19 @@ static const struct snd_sof_debugfs_map apl_dsp_debugfs[] = {
 
 static int apl_register_clients(struct snd_sof_dev *sdev)
 {
-	return hda_probes_register(sdev);
+	int ret;
+
+	ret = hda_probes_register(sdev);
+	if (ret)
+		return ret;
+
+	return hda_dma_trace_register(sdev);
 }
 
 static void apl_unregister_clients(struct snd_sof_dev *sdev)
 {
 	hda_probes_unregister(sdev);
+	hda_dma_trace_unregister(sdev);
 }
 
 /* apollolake ops */
diff --git a/sound/soc/sof/intel/atom.c b/sound/soc/sof/intel/atom.c
@@ -23,6 +23,7 @@
 #include "atom.h"
 #include "../sof-acpi-dev.h"
 #include "../sof-audio.h"
+#include "../sof-client-dma-trace.h"
 #include "../../intel/common/soc-intel-quirks.h"
 
 static void atom_host_done(struct snd_sof_dev *sdev);
@@ -457,4 +458,18 @@ void atom_set_mach_params(const struct snd_soc_acpi_mach *mach,
 }
 EXPORT_SYMBOL_NS(atom_set_mach_params, SND_SOC_SOF_INTEL_ATOM_HIFI_EP);
 
+int atom_dma_trace_register(struct snd_sof_dev *sdev)
+{
+	return sof_client_dev_register(sdev, "atom-dma-trace", 0, NULL, 0);
+}
+EXPORT_SYMBOL_NS(atom_dma_trace_register, SND_SOC_SOF_INTEL_ATOM_HIFI_EP);
+
+void atom_dma_trace_unregister(struct snd_sof_dev *sdev)
+{
+	sof_client_dev_unregister(sdev, "atom-dma-trace", 0);
+}
+EXPORT_SYMBOL_NS(atom_dma_trace_unregister, SND_SOC_SOF_INTEL_ATOM_HIFI_EP);
+
+MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);
+
 MODULE_LICENSE("Dual BSD/GPL");
diff --git a/sound/soc/sof/intel/atom.h b/sound/soc/sof/intel/atom.h
@@ -71,4 +71,7 @@ void atom_set_mach_params(const struct snd_soc_acpi_mach *mach,
 
 extern struct snd_soc_dai_driver atom_dai[];
 
+int atom_dma_trace_register(struct snd_sof_dev *sdev);
+void atom_dma_trace_unregister(struct snd_sof_dev *sdev);
+
 #endif
diff --git a/sound/soc/sof/intel/bdw.c b/sound/soc/sof/intel/bdw.c
@@ -22,6 +22,7 @@
 #include "shim.h"
 #include "../sof-acpi-dev.h"
 #include "../sof-audio.h"
+#include "../sof-client-dma-trace.h"
 
 /* BARs */
 #define BDW_DSP_BAR 0
@@ -580,6 +581,16 @@ static void bdw_set_mach_params(const struct snd_soc_acpi_mach *mach,
 	mach_params->dai_drivers = desc->ops->drv;
 }
 
+static int bdw_dma_trace_register(struct snd_sof_dev *sdev)
+{
+	return sof_client_dev_register(sdev, "bdw-dma-trace", 0, NULL, 0);
+}
+
+static void bdw_dma_trace_unregister(struct snd_sof_dev *sdev)
+{
+	sof_client_dev_unregister(sdev, "bdw-dma-trace", 0);
+}
+
 /* Broadwell DAIs */
 static struct snd_soc_dai_driver bdw_dai[] = {
 {
@@ -656,6 +667,10 @@ static const struct snd_sof_dsp_ops sof_bdw_ops = {
 	/*Firmware loading */
 	.load_firmware	= snd_sof_load_firmware_memcpy,
 
+	/* client ops */
+	.register_ipc_clients = bdw_dma_trace_register,
+	.unregister_ipc_clients = bdw_dma_trace_unregister,
+
 	/* DAI drivers */
 	.drv = bdw_dai,
 	.num_drv = ARRAY_SIZE(bdw_dai),
@@ -735,3 +750,4 @@ MODULE_LICENSE("Dual BSD/GPL");
 MODULE_IMPORT_NS(SND_SOC_SOF_INTEL_HIFI_EP_IPC);
 MODULE_IMPORT_NS(SND_SOC_SOF_XTENSA);
 MODULE_IMPORT_NS(SND_SOC_SOF_ACPI_DEV);
+MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);
diff --git a/sound/soc/sof/intel/byt.c b/sound/soc/sof/intel/byt.c
@@ -274,6 +274,10 @@ static const struct snd_sof_dsp_ops sof_byt_ops = {
 	.suspend = byt_suspend,
 	.resume = byt_resume,
 
+	/* client ops */
+	.register_ipc_clients = atom_dma_trace_register,
+	.unregister_ipc_clients = atom_dma_trace_unregister,
+
 	/* DAI drivers */
 	.drv = atom_dai,
 	.num_drv = 3, /* we have only 3 SSPs on byt*/
@@ -352,6 +356,10 @@ static const struct snd_sof_dsp_ops sof_cht_ops = {
 	.suspend = byt_suspend,
 	.resume = byt_resume,
 
+	/* client ops */
+	.register_ipc_clients = atom_dma_trace_register,
+	.unregister_ipc_clients = atom_dma_trace_unregister,
+
 	/* DAI drivers */
 	.drv = atom_dai,
 	/* all 6 SSPs may be available for cherrytrail */
diff --git a/sound/soc/sof/intel/cnl.c b/sound/soc/sof/intel/cnl.c
@@ -232,12 +232,19 @@ void cnl_ipc_dump(struct snd_sof_dev *sdev)
 
 static int cnl_register_clients(struct snd_sof_dev *sdev)
 {
-	return hda_probes_register(sdev);
+	int ret;
+
+	ret = hda_probes_register(sdev);
+	if (ret)
+		return ret;
+
+	return hda_dma_trace_register(sdev);
 }
 
 static void cnl_unregister_clients(struct snd_sof_dev *sdev)
 {
 	hda_probes_unregister(sdev);
+	hda_dma_trace_unregister(sdev);
 }
 
 /* cannonlake ops */
diff --git a/sound/soc/sof/intel/hda-trace.c b/sound/soc/sof/intel/hda-trace.c
@@ -17,6 +17,8 @@
 
 #include <sound/hdaudio_ext.h>
 #include "../ops.h"
+#include "../sof-client-dma-trace.h"
+#include "../sof-client.h"
 #include "hda.h"
 
 static int hda_dsp_trace_prepare(struct snd_sof_dev *sdev, struct snd_dma_buffer *dmab)
@@ -91,3 +93,79 @@ int hda_dsp_trace_trigger(struct snd_sof_dev *sdev, int cmd)
 
 	return hda_dsp_stream_trigger(sdev, hda->dtrace_stream, cmd);
 }
+
+#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_DMA_TRACE)
+static int hda_dma_trace_init(struct sof_client_dev *cdev,
+			      struct snd_dma_buffer *dmab, u32 *stream_tag)
+{
+	struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
+	struct sof_intel_hda_dev *hda = sdev->pdata->hw_pdata;
+	int ret;
+
+	hda->dtrace_stream = hda_dsp_stream_get(sdev, SNDRV_PCM_STREAM_CAPTURE,
+						SOF_HDA_STREAM_DMI_L1_COMPATIBLE);
+
+	if (!hda->dtrace_stream) {
+		dev_err(sdev->dev,
+			"error: no available capture stream for DMA trace\n");
+		return -ENODEV;
+	}
+
+	*stream_tag = hda->dtrace_stream->hstream.stream_tag;
+
+	/*
+	 * initialize capture stream, set BDL address and return corresponding
+	 * stream tag which will be sent to the firmware by IPC message.
+	 */
+	ret = hda_dsp_trace_prepare(sdev, dmab);
+	if (ret < 0) {
+		dev_err(sdev->dev, "error: hdac trace init failed: %d\n", ret);
+		hda_dsp_stream_put(sdev, SNDRV_PCM_STREAM_CAPTURE, *stream_tag);
+		hda->dtrace_stream = NULL;
+		*stream_tag = 0;
+	}
+
+	return ret;
+}
+
+static int hda_dma_trace_release(struct sof_client_dev *cdev)
+{
+	struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
+
+	return hda_dsp_trace_release(sdev);
+}
+
+static int hda_dma_trace_start(struct sof_client_dev *cdev)
+{
+	struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
+
+	return hda_dsp_trace_trigger(sdev, SNDRV_PCM_TRIGGER_START);
+}
+
+static int hda_dma_trace_stop(struct sof_client_dev *cdev)
+{
+	struct snd_sof_dev *sdev = sof_client_dev_to_sof_dev(cdev);
+
+	return hda_dsp_trace_trigger(sdev, SNDRV_PCM_TRIGGER_STOP);
+}
+
+static const struct sof_dma_trace_host_ops hda_dma_trace_ops = {
+	.init = hda_dma_trace_init,
+	.release = hda_dma_trace_release,
+	.start = hda_dma_trace_start,
+	.stop = hda_dma_trace_stop,
+};
+
+int hda_dma_trace_register(struct snd_sof_dev *sdev)
+{
+	return sof_client_dev_register(sdev, "hda-dma-trace", 0, &hda_dma_trace_ops,
+				       sizeof(hda_dma_trace_ops));
+}
+
+void hda_dma_trace_unregister(struct snd_sof_dev *sdev)
+{
+	sof_client_dev_unregister(sdev, "hda-dma-trace", 0);
+}
+
+MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);
+#endif
diff --git a/sound/soc/sof/intel/hda.h b/sound/soc/sof/intel/hda.h
@@ -715,6 +715,20 @@ static inline void hda_probes_unregister(struct snd_sof_dev *sdev)
 }
 #endif /* CONFIG_SND_SOC_SOF_HDA_PROBES */
 
+#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_DMA_TRACE)
+int hda_dma_trace_register(struct snd_sof_dev *sdev);
+void hda_dma_trace_unregister(struct snd_sof_dev *sdev);
+#else
+static inline int hda_dma_trace_register(struct snd_sof_dev *sdev)
+{
+	return 0;
+}
+
+static inline void hda_dma_trace_unregister(struct snd_sof_dev *sdev)
+{
+}
+#endif /* CONFIG_SND_SOC_SOF_HDA_DMA_TRACE */
+
 /* machine driver select */
 void hda_machine_select(struct snd_sof_dev *sdev);
 void hda_set_mach_params(const struct snd_soc_acpi_mach *mach,
diff --git a/sound/soc/sof/intel/icl.c b/sound/soc/sof/intel/icl.c
@@ -26,12 +26,19 @@ static const struct snd_sof_debugfs_map icl_dsp_debugfs[] = {
 
 static int icl_register_clients(struct snd_sof_dev *sdev)
 {
-	return hda_probes_register(sdev);
+	int ret;
+
+	ret = hda_probes_register(sdev);
+	if (ret)
+		return ret;
+
+	return hda_dma_trace_register(sdev);
 }
 
 static void icl_unregister_clients(struct snd_sof_dev *sdev)
 {
 	hda_probes_unregister(sdev);
+	hda_dma_trace_unregister(sdev);
 }
 
 /* Icelake ops */
diff --git a/sound/soc/sof/intel/tgl.c b/sound/soc/sof/intel/tgl.c
@@ -62,12 +62,19 @@ static int tgl_dsp_core_put(struct snd_sof_dev *sdev, int core)
 
 static int tgl_register_clients(struct snd_sof_dev *sdev)
 {
-	return hda_probes_register(sdev);
+	int ret;
+
+	ret = hda_probes_register(sdev);
+	if (ret)
+		return ret;
+
+	return hda_dma_trace_register(sdev);
 }
 
 static void tgl_unregister_clients(struct snd_sof_dev *sdev)
 {
 	hda_probes_unregister(sdev);
+	hda_dma_trace_unregister(sdev);
 }
 
 /* Tigerlake ops */
diff --git a/sound/soc/sof/sof-client-dma-trace.c b/sound/soc/sof/sof-client-dma-trace.c
diff --git a/sound/soc/sof/sof-client-dma-trace.h b/sound/soc/sof/sof-client-dma-trace.h

Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,19 @@ static const struct snd_sof_debugfs_map apl_dsp_debugfs[] = {`
`27`	`27`
`28`	`28`	`static int apl_register_clients(struct snd_sof_dev *sdev)`
`29`	`29`	`{`
`30`		`- return hda_probes_register(sdev);`
	`30`	`+ int ret;`
	`31`	`+`
	`32`	`+ ret = hda_probes_register(sdev);`
	`33`	`+ if (ret)`
	`34`	`+ return ret;`
	`35`	`+`
	`36`	`+ return hda_dma_trace_register(sdev);`
`31`	`37`	`}`
`32`	`38`
`33`	`39`	`static void apl_unregister_clients(struct snd_sof_dev *sdev)`
`34`	`40`	`{`
`35`	`41`	`hda_probes_unregister(sdev);`
	`42`	`+ hda_dma_trace_unregister(sdev);`
`36`	`43`	`}`
`37`	`44`
`38`	`45`	`/* apollolake ops */`