ASoC: SOF: Convert the dma-trace support to SOF client

Add a new client driver for dma trace support and move all related code
from core to the new client driver.

The dma trace is supported and used on all existing platform (intel and
i.MX), thus the new client driver is selected by all platforms to be built
and the CONFIG_SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE is used as a default
value for enable/disable the functionality.

The new module supports overriding the default state with 'enable' module
parameter.

Signed-off-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>

Author: ujfalusi

sound/soc/sof/Kconfig

@@ -60,6 +60,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_CLIENT
 	tristate
 	select AUXILIARY_BUS
@@ -188,8 +198,8 @@ config SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE
 	bool "SOF enable firmware trace"
 	help
 	  The firmware trace can be enabled either at build-time with
-	  this option, or dynamically by setting flags in the SOF core
-	  module parameter (similar to dynamic debug).
+	  this option, or dynamically by setting the 'enable' module parameter
+	  for the snd_sof_dma_trace module.
 	  If unsure, select "N".
 
 config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST

sound/soc/sof/Makefile

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
 
 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
+		control.o iomem-utils.o sof-audio.o stream-ipc.o
 snd-sof-$(CONFIG_SND_SOC_SOF_CLIENT) += sof-client.o
 
 snd-sof-$(CONFIG_SND_SOC_SOF_COMPRESS) += compress.o
@@ -12,6 +12,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
 
@@ -28,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-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/

sound/soc/sof/core.c

@@ -220,20 +220,8 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
 		goto fw_run_err;
 	}
 
-	if (sof_core_debug & SOF_DBG_ENABLE_TRACE) {
-		sdev->dtrace_is_supported = true;
-
-		/* init DMA trace */
-		ret = snd_sof_init_trace(sdev);
-		if (ret < 0) {
-			/* non fatal */
-			dev_warn(sdev->dev,
-				 "warning: failed to initialize trace %d\n",
-				 ret);
-		}
-	} else {
-		dev_dbg(sdev->dev, "SOF firmware trace disabled\n");
-	}
+	if (sof_core_debug & SOF_DBG_ENABLE_TRACE)
+		dev_dbg(sdev->dev, "SOF_DBG_ENABLE_TRACE is no longer used\n");
 
 	/* hereafter all FW boot flows are for PM reasons */
 	sdev->first_boot = false;
@@ -245,14 +233,14 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
 	if (ret < 0) {
 		dev_err(sdev->dev,
 			"error: failed to register DSP DAI driver %d\n", ret);
-		goto fw_trace_err;
+		goto fw_run_err;
 	}
 
 	ret = snd_sof_machine_register(sdev, plat_data);
 	if (ret < 0) {
 		dev_err(sdev->dev,
 			"error: failed to register machine driver %d\n", ret);
-		goto fw_trace_err;
+		goto fw_run_err;
 	}
 
 	ret = sof_register_clients(sdev);
@@ -278,8 +266,6 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
 
 sof_machine_err:
 	snd_sof_machine_unregister(sdev, plat_data);
-fw_trace_err:
-	snd_sof_free_trace(sdev);
 fw_run_err:
 	snd_sof_fw_unload(sdev);
 fw_load_err:
@@ -412,7 +398,6 @@ int snd_sof_device_remove(struct device *dev)
 
 		snd_sof_ipc_free(sdev);
 		snd_sof_free_debug(sdev);
-		snd_sof_free_trace(sdev);
 	}
 
 	/*

sound/soc/sof/debug.c

@@ -407,6 +407,5 @@ void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev)
 	/* dump vital information to the logs */
 	snd_sof_ipc_dump(sdev);
 	snd_sof_dsp_dbg_dump(sdev, SOF_DBG_DUMP_REGS | SOF_DBG_DUMP_MBOX);
-	snd_sof_trace_notify_for_error(sdev);
 }
 EXPORT_SYMBOL(snd_sof_handle_fw_exception);

sound/soc/sof/imx/Kconfig

@@ -4,6 +4,7 @@ config SND_SOC_SOF_IMX_TOPLEVEL
 	bool "SOF support for NXP i.MX audio DSPs"
 	depends on ARM64|| COMPILE_TEST
 	depends on SND_SOC_SOF_OF
+	select SND_SOC_SOF_DEBUG_DMA_TRACE
 	help
 	  This adds support for Sound Open Firmware for NXP i.MX platforms.
 	  Say Y if you have such a device.

sound/soc/sof/imx/imx-common.c

@@ -7,6 +7,7 @@
 #include <linux/module.h>
 #include <sound/sof/xtensa.h>
 #include "../ops.h"
+#include "../sof-client-dma-trace.h"
 
 #include "imx-common.h"
 
@@ -74,4 +75,17 @@ void imx8_dump(struct snd_sof_dev *sdev, u32 flags)
 }
 EXPORT_SYMBOL(imx8_dump);
 
+int imx8_dma_trace_register(struct snd_sof_dev *sdev)
+{
+	return sof_client_dev_register(sdev, "imx8-dma-trace", 0, NULL, 0);
+}
+EXPORT_SYMBOL(imx8_dma_trace_register);
+
+void imx8_dma_trace_unregister(struct snd_sof_dev *sdev)
+{
+	sof_client_dev_unregister(sdev, "imx8-dma-trace", 0);
+}
+EXPORT_SYMBOL(imx8_dma_trace_unregister);
+
+MODULE_IMPORT_NS(SND_SOC_SOF_CLIENT);
 MODULE_LICENSE("Dual BSD/GPL");

sound/soc/sof/imx/imx-common.h

@@ -13,4 +13,7 @@ void imx8_get_registers(struct snd_sof_dev *sdev,
 
 void imx8_dump(struct snd_sof_dev *sdev, u32 flags);
 
+int imx8_dma_trace_register(struct snd_sof_dev *sdev);
+void imx8_dma_trace_unregister(struct snd_sof_dev *sdev);
+
 #endif

sound/soc/sof/imx/imx8.c

@@ -433,6 +433,10 @@ struct snd_sof_dsp_ops sof_imx8_ops = {
 	/* firmware loading */
 	.load_firmware	= snd_sof_load_firmware_memcpy,
 
+	/* client ops */
+	.register_ipc_clients = imx8_dma_trace_register,
+	.unregister_ipc_clients = imx8_dma_trace_unregister,
+
 	/* Debug information */
 	.dbg_dump = imx8_dump,
 	.debugfs_add_region_item = snd_sof_debugfs_add_region_item_iomem,
@@ -488,6 +492,10 @@ struct snd_sof_dsp_ops sof_imx8x_ops = {
 	/* firmware loading */
 	.load_firmware	= snd_sof_load_firmware_memcpy,
 
+	/* client ops */
+	.register_ipc_clients = imx8_dma_trace_register,
+	.unregister_ipc_clients = imx8_dma_trace_unregister,
+
 	/* Debug information */
 	.dbg_dump = imx8_dump,
 	.debugfs_add_region_item = snd_sof_debugfs_add_region_item_iomem,

sound/soc/sof/imx/imx8m.c

@@ -296,6 +296,10 @@ struct snd_sof_dsp_ops sof_imx8m_ops = {
 	/* firmware loading */
 	.load_firmware	= snd_sof_load_firmware_memcpy,
 
+	/* client ops */
+	.register_ipc_clients = imx8_dma_trace_register,
+	.unregister_ipc_clients = imx8_dma_trace_unregister,
+
 	/* Debug information */
 	.dbg_dump = imx8_dump,
 	.debugfs_add_region_item = snd_sof_debugfs_add_region_item_iomem,

sound/soc/sof/intel/Kconfig

@@ -15,6 +15,13 @@ 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
+	bool
+	select SND_SOC_SOF_DEBUG_DMA_TRACE
+	help
+	  This option is not user-selectable but following the higher level
+	  SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE option.
+
 config SND_SOC_SOF_INTEL_ATOM_HIFI_EP
 	tristate
 	select SND_SOC_SOF_INTEL_COMMON
@@ -31,6 +38,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_DEBUG_DMA_TRACE
 	help
 	  This option is not user-selectable but automagically handled by
 	  'select' statements at a higher level.
@@ -216,6 +224,7 @@ config SND_SOC_SOF_HDA_COMMON
 	select SND_INTEL_DSP_CONFIG
 	select SND_SOC_SOF_HDA_LINK_BASELINE
 	select SND_SOC_SOF_HDA_PROBES
+	select SND_SOC_SOF_HDA_DMA_TRACE
 	help
 	  This option is not user-selectable but automagically handled by
 	  'select' statements at a higher level.