copier.c

// SPDX-License-Identifier: BSD-3-Clause
//
// Copyright(c) 2021 Intel Corporation. All rights reserved.
//
// Author: Rander Wang <rander.wang@linux.intel.com>

#include <sof/audio/buffer.h>
#include <sof/audio/component_ext.h>
#include <sof/audio/format.h>
#include <sof/audio/pipeline.h>
#include <sof/common.h>
#include <rtos/panic.h>
#include <rtos/interrupt.h>
#include <sof/ipc/msg.h>
#include <sof/ipc/topology.h>
#include <rtos/interrupt.h>
#include <rtos/timer.h>
#include <rtos/cache.h>
#include <rtos/init.h>
#include <sof/lib/memory.h>
#include <sof/lib/uuid.h>
#include <sof/list.h>
#include <rtos/string.h>
#include <sof/ut.h>
#include <sof/trace/trace.h>
#include <ipc4/alh.h>
#include <ipc4/base-config.h>
#include <ipc4/module.h>
#include <ipc4/error_status.h>
#include <ipc4/gateway.h>
#include <ipc4/fw_reg.h>
#include <ipc/dai.h>
#include <user/trace.h>
#include <errno.h>
#include <stddef.h>
#include <stdint.h>
#include <sof/audio/module_adapter/module/generic.h>
#include "copier.h"
#include "host_copier.h"
#include "dai_copier.h"
#include "ipcgtw_copier.h"
#if CONFIG_INTEL_ADSP_MIC_PRIVACY
#include <zephyr/drivers/mic_privacy/intel/mic_privacy.h>
#endif

#if CONFIG_ZEPHYR_NATIVE_DRIVERS
#include <zephyr/drivers/dai.h>
#endif

LOG_MODULE_REGISTER(copier, CONFIG_SOF_LOG_LEVEL);

/* this id aligns windows driver requirement to support windows driver */
SOF_DEFINE_REG_UUID(copier);

#if CONFIG_INTEL_ADSP_MIC_PRIVACY
static void mic_privacy_event(void *arg, enum notify_id type, void *data)
{
	struct mic_privacy_data *mic_priv_data = arg;
	struct mic_privacy_settings *mic_privacy_settings = data;

	if (type == NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE) {
		LOG_INF("state1 = %d, state2 = %d ",
			mic_privacy_settings->mic_privacy_state, mic_priv_data->mic_privacy_state);

		if (mic_privacy_settings->mic_privacy_state == MIC_PRIV_UNMUTED) {
			if (mic_priv_data->mic_privacy_state == MIC_PRIV_MUTED) {
				mic_priv_data->mic_privacy_state = MIC_PRIV_FADE_IN;
				LOG_INF("switch to FADE_IN");
			}
		} else {
			/* In case when mute would be triggered before copier instantiation. */
			if (mic_priv_data->mic_privacy_state != MIC_PRIV_MUTED) {
				mic_priv_data->mic_privacy_state = MIC_PRIV_FADE_OUT;
				LOG_INF("switch to FADE_OUT");
			}
		}
		mic_priv_data->max_ramp_time_in_ms = (mic_privacy_settings->max_ramp_time * 1000) /
						     ADSP_RTC_FREQUENCY;
	}
}

static int mic_privacy_configure(struct processing_module *mod, struct copier_data *cd)
{
	struct mic_privacy_data *mic_priv_data;
	int ret;

	mic_priv_data = mod_zalloc(mod, sizeof(struct mic_privacy_data));
	if (!mic_priv_data)
		return -ENOMEM;

	if (cd->gtw_type == ipc4_gtw_dmic)
		mic_privacy_enable_dmic_irq(true);

	mic_priv_data->audio_freq =  cd->config.base.audio_fmt.sampling_frequency;

	uint32_t zeroing_wait_time = (mic_privacy_get_dma_zeroing_wait_time() * 1000) /
				     ADSP_RTC_FREQUENCY;

	ret = copier_gain_set_params(mod->dev, &mic_priv_data->mic_priv_gain_params,
				     zeroing_wait_time, SOF_DAI_INTEL_NONE);
	if (ret != 0) {
		mod_free(mod, mic_priv_data);
		return ret;
	}

	cd->mic_priv = mic_priv_data;

	ret = notifier_register(cd->mic_priv, NULL, NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE,
				mic_privacy_event, 0);

	if (ret != 0)
		mod_free(mod, mic_priv_data);

	return ret;
}

static void mic_privacy_free(struct processing_module *mod)
{
	struct copier_data *cd = module_get_private_data(mod);

	if (cd->gtw_type == ipc4_gtw_dmic)
		mic_privacy_enable_dmic_irq(false);

	notifier_unregister(cd->mic_priv, NULL, NOTIFIER_ID_MIC_PRIVACY_STATE_CHANGE);

	mod_free(mod, cd->mic_priv);
}
#endif

__cold static int copier_init(struct processing_module *mod)
{
	union ipc4_connector_node_id node_id;
	struct copier_data *cd;
	struct comp_dev *dev = mod->dev;
	struct module_data *md = &mod->priv;
	struct ipc4_copier_module_cfg *copier = (struct ipc4_copier_module_cfg *)md->cfg.init_data;
	size_t cfg_total_size = sizeof(*copier);
	size_t gtw_cfg_var_size = 0;
	int i, ret = 0;

	assert_can_be_cold();

	if (copier->gtw_cfg.config_length > 1) {
		/* one word already included in gateway_cfg struct hence subtraction */
		gtw_cfg_var_size += (copier->gtw_cfg.config_length - 1) << 2;
		cfg_total_size += gtw_cfg_var_size;
	}

	cd = mod_zalloc(mod, sizeof(*cd) + gtw_cfg_var_size);
	if (!cd)
		return -ENOMEM;

	md->private = cd;

	if (memcpy_s(&cd->config, cfg_total_size, copier, cfg_total_size) < 0) {
		ret = -EINVAL;
		goto error;
	}

	for (i = 0; i < IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT; i++)
		cd->out_fmt[i] = cd->config.out_fmt;

	node_id = copier->gtw_cfg.node_id;
	/* copier is linked to gateway */
	if (node_id.dw != IPC4_INVALID_NODE_ID) {
		cd->direction = get_gateway_direction(node_id.f.dma_type);

		switch (node_id.f.dma_type) {
		case ipc4_hda_host_output_class:
		case ipc4_hda_host_input_class:
			ret = copier_host_create(mod, copier, dev->pipeline);
			if (ret < 0) {
				comp_err(dev, "unable to create host");
				goto error;
			}
#if CONFIG_INTEL_ADSP_MIC_PRIVACY
			if (cd->direction == SOF_IPC_STREAM_CAPTURE &&
			    node_id.f.dma_type == ipc4_hda_host_output_class) {
				ret = mic_privacy_configure(mod, cd);
				if (ret < 0) {
					comp_err(dev, "unable to configure mic privacy");
					goto error;
				}
			}
#endif
			break;
		case ipc4_hda_link_output_class:
		case ipc4_hda_link_input_class:
		case ipc4_dmic_link_input_class:
		case ipc4_i2s_link_output_class:
		case ipc4_i2s_link_input_class:
		case ipc4_alh_link_output_class:
		case ipc4_alh_link_input_class:
		case ipc4_alh_uaol_stream_link_output_class:
		case ipc4_alh_uaol_stream_link_input_class:
			ret = copier_dai_create(dev, cd, copier, dev->pipeline);
			if (ret < 0) {
				comp_err(dev, "unable to create dai");
				goto error;
			}
#if CONFIG_INTEL_ADSP_MIC_PRIVACY
			if (cd->direction == SOF_IPC_STREAM_CAPTURE) {
				ret = mic_privacy_configure(mod, cd);
				if (ret < 0) {
					comp_err(dev, "unable to configure mic privacy");
					goto error;
				}
			}
#endif
			break;
#if CONFIG_IPC4_GATEWAY
		case ipc4_ipc_output_class:
		case ipc4_ipc_input_class:
			ret = copier_ipcgtw_create(mod, copier, dev->pipeline);
			if (ret < 0) {
				comp_err(dev, "unable to create IPC gateway");
				goto error;
			}
			break;
#endif
		default:
			comp_err(dev, "unsupported dma type %x", (uint32_t)node_id.f.dma_type);
			ret = -EINVAL;
			goto error;
		};

		dev->direction_set = true;
	} else {
		cd->gtw_type = ipc4_gtw_none;

		/* set max sink count for module copier */
		mod->max_sinks = IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT;
	}

	dev->direction = cd->direction;
	dev->state = COMP_STATE_READY;
	return 0;
error:
	mod_free(mod, cd);
	return ret;
}

__cold static int copier_free(struct processing_module *mod)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;

	assert_can_be_cold();

#if CONFIG_INTEL_ADSP_MIC_PRIVACY
	mic_privacy_free(mod);
#endif

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		if (!cd->ipc_gtw)
			copier_host_free(mod);
		else
			/* handle gtw case */
			copier_ipcgtw_free(mod);
		break;
	case SOF_COMP_DAI:
		copier_dai_free(mod);
		break;
	default:
		break;
	}

	mod_free(mod, cd);

	return 0;
}

static int copier_params(struct processing_module *mod);

static int copier_prepare(struct processing_module *mod,
			  struct sof_source **sources, int num_of_sources,
			  struct sof_sink **sinks, int num_of_sinks)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;
	int ret;

	ret = copier_params(mod);
	if (ret < 0)
		return ret;

	comp_info(dev, "entry");

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		if (!cd->ipc_gtw) {
			ret = host_common_prepare(cd->hd);
			if (ret < 0)
				return ret;
		}
		break;
	case SOF_COMP_DAI:
		ret = copier_dai_prepare(dev, cd);
		if (ret < 0)
			return ret;
		break;
	default:
		break;
	}

	if (!cd->endpoint_num) {
		/* set up format conversion function for pin 0, for other pins (if any)
		 * format is set in IPC4_COPIER_MODULE_CFG_PARAM_SET_SINK_FORMAT handler
		 */
		cd->converter[0] = get_converter_func(&cd->config.base.audio_fmt,
							      &cd->config.out_fmt, ipc4_gtw_none,
							      ipc4_bidirection, DUMMY_CHMAP);
		if (!cd->converter[0]) {
			comp_err(dev, "can't support for in format %d, out format %d",
				 cd->config.base.audio_fmt.depth,  cd->config.out_fmt.depth);
			return -EINVAL;
		}
	}

	return 0;
}

static int copier_reset(struct processing_module *mod)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct ipc4_pipeline_registers pipe_reg;
	struct comp_dev *dev = mod->dev;

	comp_dbg(dev, "entry");

	cd->input_total_data_processed = 0;
	cd->output_total_data_processed = 0;

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		if (!cd->ipc_gtw)
			host_common_reset(cd->hd, dev->state);
		else
			copier_ipcgtw_reset(dev);
		break;
	case SOF_COMP_DAI:
		copier_dai_reset(cd, dev);
		break;
	default:
		break;
	}

	if (cd->pipeline_reg_offset) {
		pipe_reg.stream_start_offset = (uint64_t)-1;
		pipe_reg.stream_end_offset = (uint64_t)-1;
		mailbox_sw_regs_write(cd->pipeline_reg_offset, &pipe_reg, sizeof(pipe_reg));
	}

	return 0;
}

static int copier_comp_trigger(struct comp_dev *dev, int cmd)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct sof_ipc_stream_posn posn;
	struct comp_dev *dai_copier;
	struct comp_buffer *buffer;
	uint32_t latency;
	int ret;

	comp_dbg(dev, "entry");

	ret = comp_set_state(dev, cmd);
	if (ret < 0)
		return ret;

	if (ret == COMP_STATUS_STATE_ALREADY_SET)
		return PPL_STATUS_PATH_STOP;

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		if (!cd->ipc_gtw) {
			ret = host_common_trigger(cd->hd, dev, cmd);
			if (ret < 0)
				return ret;
		}
		break;
	case SOF_COMP_DAI:
		ret = copier_dai_trigger(cd, dev, cmd);
		break;
	default:
		break;
	}

	/* For capture cd->pipeline_reg_offset == 0 */
	if (!cd->endpoint_num || !cd->pipeline_reg_offset)
		return 0;

	dai_copier = pipeline_get_dai_comp_latency(dev->pipeline->pipeline_id, &latency);
	if (!dai_copier) {
		/*
		 * If the (playback) stream does not have a dai, the offset
		 * calculation is skipped
		 */
		comp_info(dev,
			  "No dai copier found, start/end offset is not calculated");
		return 0;
	}

	/* dai is in another pipeline and it is not prepared or active */
	if (dai_copier->state <= COMP_STATE_READY) {
		struct ipc4_pipeline_registers pipe_reg;

		comp_warn(dev, "dai is not ready");

		pipe_reg.stream_start_offset = 0;
		pipe_reg.stream_end_offset = 0;
		mailbox_sw_regs_write(cd->pipeline_reg_offset, &pipe_reg, sizeof(pipe_reg));

		return 0;
	}

	comp_position(dai_copier, &posn);

	/* update stream start and end offset for running message in host copier
	 * host driver uses DMA link counter to calculate stream position, but it is
	 * not fit for the following 3 cases:
	 * (1) dai is enabled before host since they are in different pipelines
	 * (2) multiple stream are mixed into one dai
	 * (3) one stream is paused but the dai is still working with other stream
	 *
	 * host uses stream_start_offset & stream_end_offset to deal with such cases:
	 * if (stream_start_offset) {
	 *	position = DMA counter - stream_start_offset
	 *	if (stream_stop_offset)
	 *		position = stream_stop_offset -stream_start_offset;
	 * } else {
	 *	position = 0;
	 * }
	 * When host component is started  stream_start_offset is set to DMA counter
	 * plus the latency from host to dai since the accurate DMA counter should be
	 * used when the data arrives dai from host.
	 *
	 * When pipeline is paused, stream_end_offset will save current DMA counter
	 * for resume case
	 *
	 * When pipeline is resumed, calculate stream_start_offset based on current
	 * DMA counter and stream_end_offset
	 */
	if (cmd == COMP_TRIGGER_START) {
		struct ipc4_pipeline_registers pipe_reg;

		if (list_is_empty(&dai_copier->bsource_list)) {
			comp_err(dev, "No source buffer bound to dai_copier");
			return -EINVAL;
		}

		buffer = comp_dev_get_first_data_producer(dai_copier);
		pipe_reg.stream_start_offset = posn.dai_posn +
			latency * audio_stream_period_bytes(&buffer->stream, dev->frames);
		pipe_reg.stream_end_offset = 0;
		mailbox_sw_regs_write(cd->pipeline_reg_offset, &pipe_reg, sizeof(pipe_reg));
	} else if (cmd == COMP_TRIGGER_PAUSE) {
		uint64_t stream_end_offset;

		stream_end_offset = posn.dai_posn;
		mailbox_sw_regs_write(cd->pipeline_reg_offset + sizeof(uint64_t),
				      &stream_end_offset, sizeof(stream_end_offset));
	} else if (cmd == COMP_TRIGGER_RELEASE) {
		struct ipc4_pipeline_registers pipe_reg;

		pipe_reg.stream_start_offset = mailbox_sw_reg_read64(cd->pipeline_reg_offset);
		pipe_reg.stream_end_offset = mailbox_sw_reg_read64(cd->pipeline_reg_offset +
			sizeof(pipe_reg.stream_start_offset));
		pipe_reg.stream_start_offset += posn.dai_posn - pipe_reg.stream_end_offset;

		if (list_is_empty(&dai_copier->bsource_list)) {
			comp_err(dev, "No source buffer bound to dai_copier");
			return -EINVAL;
		}

		buffer = comp_dev_get_first_data_producer(dai_copier);
		pipe_reg.stream_start_offset += latency *
			audio_stream_period_bytes(&buffer->stream, dev->frames);
		mailbox_sw_regs_write(cd->pipeline_reg_offset, &pipe_reg.stream_start_offset,
				      sizeof(pipe_reg.stream_start_offset));
	}

	return ret;
}

static int do_conversion_copy(struct comp_dev *dev,
			      struct copier_data *cd,
			      struct comp_buffer *src,
			      struct comp_buffer *sink,
			      struct comp_copy_limits *processed_data)
{
	int i;

	/* buffer params might be not yet configured by component on another pipeline */
	if (!audio_buffer_hw_params_configured(&src->audio_buffer) ||
	    !audio_buffer_hw_params_configured(&sink->audio_buffer))
		return 0;

	comp_get_copy_limits(src, sink, processed_data);

	/*
	 * Buffer ID is constructed as IPC4_COMP_ID(src_queue, dst_queue).
	 * From the buffer's perspective, copier's sink is the source,
	 * so we use IPC4_SRC_QUEUE_ID() to get the correct copier sink index.
	 */
	i = IPC4_SRC_QUEUE_ID(buf_get_id(sink));
	if (i >= IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT)
		return -EINVAL;
	buffer_stream_invalidate(src, processed_data->source_bytes);

	cd->converter[i](&src->stream, 0, &sink->stream, 0,
			 processed_data->frames * audio_stream_get_channels(&src->stream),
			 DUMMY_CHMAP);

	buffer_stream_writeback(sink, processed_data->sink_bytes);
	comp_update_buffer_produce(sink, processed_data->sink_bytes);

	return 0;
}

static int copier_copy_to_sinks(struct copier_data *cd, struct comp_dev *dev,
				struct comp_buffer *src_c,
				struct comp_copy_limits *processed_data)
{
	struct comp_buffer *sink;
	int ret = 0;

	/* module copy, one source to multiple sink buffers */
	comp_dev_for_each_consumer(dev, sink) {
		struct comp_dev *sink_dev;

		sink_dev = comp_buffer_get_sink_component(sink);
		processed_data->sink_bytes = 0;
		if (sink_dev->state == COMP_STATE_ACTIVE) {
			ret = do_conversion_copy(dev, cd, src_c, sink, processed_data);
			cd->output_total_data_processed += processed_data->sink_bytes;
		}
		if (ret < 0) {
			comp_err(dev, "failed to copy buffer for comp %x",
				 dev->ipc_config.id);
			break;
		}
	}

	if (!ret) {
		comp_update_buffer_consume(src_c, processed_data->source_bytes);
		/* module copy case with endpoint_num == 0 or src_c as source buffer */
		if (!cd->endpoint_num || cd->bsource_buffer)
			cd->input_total_data_processed += processed_data->source_bytes;
	}

	return ret;
}

static int copier_module_copy(struct processing_module *mod,
			      struct input_stream_buffer *input_buffers, int num_input_buffers,
			      struct output_stream_buffer *output_buffers, int num_output_buffers)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_buffer *src_c;
	struct comp_copy_limits processed_data;
	int i;

	if (!num_input_buffers || !num_output_buffers)
		return 0;

	src_c = container_of(input_buffers[0].data, struct comp_buffer, stream);

	processed_data.source_bytes = 0;

	/* convert format and copy to each active sink */
	for (i = 0; i < num_output_buffers; i++) {
		struct comp_buffer *sink_c;
		struct comp_dev *sink_dev;

		sink_c = container_of(output_buffers[i].data, struct comp_buffer, stream);
		sink_dev = comp_buffer_get_sink_component(sink_c);
		processed_data.sink_bytes = 0;
		if (sink_dev->state == COMP_STATE_ACTIVE) {
			uint32_t source_samples;
			int sink_queue_id;

			/*
			 * Buffer ID is constructed as IPC4_COMP_ID(src_queue, dst_queue).
			 * From the buffer's perspective, copier's sink is the source,
			 * so we use IPC4_SRC_QUEUE_ID() to get the correct copier sink index.
			 */
			sink_queue_id = IPC4_SRC_QUEUE_ID(buf_get_id(sink_c));
			if (sink_queue_id >= IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT)
				return -EINVAL;

			comp_get_copy_limits(src_c, sink_c, &processed_data);

			source_samples = processed_data.frames *
					audio_stream_get_channels(input_buffers[0].data);
			cd->converter[sink_queue_id](input_buffers[0].data, 0,
						     output_buffers[i].data, 0,
						     source_samples, DUMMY_CHMAP);

			output_buffers[i].size = processed_data.sink_bytes;
			cd->output_total_data_processed += processed_data.sink_bytes;
		}
	}

	input_buffers[0].consumed = processed_data.source_bytes;

	return 0;
}

static int copier_multi_endpoint_dai_copy(struct copier_data *cd, struct comp_dev *dev)
{
	struct comp_copy_limits processed_data;
	struct comp_buffer *src;
	int ret;

	processed_data.source_bytes = 0;

	if (!cd->bsource_buffer) {
		/* gateway(s) as input */
		ret = dai_zephyr_multi_endpoint_copy(cd->dd, dev, cd->multi_endpoint_buffer,
						     cd->endpoint_num);
		if (ret < 0)
			return ret;

		ret = copier_copy_to_sinks(cd, dev, cd->multi_endpoint_buffer, &processed_data);

		return ret;
	}

	/* component as input */
	if (list_is_empty(&dev->bsource_list)) {
		comp_err(dev, "No source buffer bound");
		return -EINVAL;
	}

	src = comp_dev_get_first_data_producer(dev);

	/* gateway(s) on output */
	ret = do_conversion_copy(dev, cd, src, cd->multi_endpoint_buffer, &processed_data);
	if (ret < 0)
		return ret;

	ret = dai_zephyr_multi_endpoint_copy(cd->dd, dev, cd->multi_endpoint_buffer,
					     cd->endpoint_num);
	if (!ret) {
		comp_update_buffer_consume(src, processed_data.source_bytes);
		cd->input_total_data_processed += processed_data.source_bytes;
	}

	return ret;
}

/* Copier has one input and one or more outputs. Maximum of one gateway can be connected
 * to copier or no gateway connected at all. Gateway can only be connected to either input
 * pin 0 (the only input) or output pin 0. With or without connected gateway it is also
 * possible to have component(s) connected on input and/or output pins.
 *
 * A special exception is a multichannel ALH gateway case. These are multiple gateways
 * but should be treated like a single gateway to satisfy rules above. Data from such
 * gateways has to be multiplexed into single stream (for input gateways) or demultiplexed
 * from single stream (for output gateways) so such gateways work kind of like a single
 * gateway, i.e., produce/consume single stream.
 */
static int copier_process(struct processing_module *mod,
			  struct input_stream_buffer *input_buffers, int num_input_buffers,
			  struct output_stream_buffer *output_buffers, int num_output_buffers)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;

	comp_dbg(dev, "entry");

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		if (!cd->ipc_gtw)
			return host_common_copy(cd->hd, dev, copier_host_dma_cb);

		/* do nothing in the gateway copier case */
		return 0;
	case SOF_COMP_DAI:
		if (cd->endpoint_num == 1)
			return dai_common_copy(cd->dd[0], dev, cd->converter);

		return copier_multi_endpoint_dai_copy(cd, dev);
	default:
		break;
	}

	/* module copier case */
	return copier_module_copy(mod, input_buffers, num_input_buffers, output_buffers,
				  num_output_buffers);
}

static int copier_params(struct processing_module *mod)
{
	struct sof_ipc_stream_params *params = mod->stream_params;
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;
	int i, ret = 0;

	comp_dbg(dev, "entry");

	copier_update_params(cd, dev, params);

	for (i = 0; i < cd->endpoint_num; i++) {
		switch (dev->ipc_config.type) {
		case SOF_COMP_HOST:
			if (!cd->ipc_gtw)
				ret = copier_host_params(cd, dev, params);
			else
				/* handle gtw case */
				ret = copier_ipcgtw_params(cd->ipcgtw_data, dev, params);
			break;
		case SOF_COMP_DAI:
			ret = copier_dai_params(cd, dev, params, i);
			break;
		default:
			break;
		}

		if (ret < 0)
			break;
	}

	return ret;
}

__cold static int copier_set_sink_fmt(struct comp_dev *dev, const void *data,
				      int max_data_size)
{
	const struct ipc4_copier_config_set_sink_format *sink_fmt = data;
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	uint32_t chmap;

	assert_can_be_cold();

	if (max_data_size < sizeof(*sink_fmt)) {
		comp_err(dev, "error: max_data_size %d should be bigger than %d", max_data_size,
			 sizeof(*sink_fmt));
		return -EINVAL;
	}

	if (sink_fmt->sink_id >= IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT) {
		comp_err(dev, "error: sink id %d is out of range", sink_fmt->sink_id);
		return -EINVAL;
	}

	if (memcmp(&cd->config.base.audio_fmt, &sink_fmt->source_fmt,
		   sizeof(sink_fmt->source_fmt))) {
		comp_err(dev, "error: source fmt should be equal to input fmt");
		return -EINVAL;
	}

	if (cd->endpoint_num && cd->bsource_buffer &&
	    sink_fmt->sink_id == IPC4_COPIER_GATEWAY_PIN) {
		comp_err(dev, "can't change gateway format");
		return -EINVAL;
	}

	cd->out_fmt[sink_fmt->sink_id] = sink_fmt->sink_fmt;

	if (cd->endpoint_num > 0 && dev->ipc_config.type == SOF_COMP_DAI)
		chmap = cd->dd[0]->chmap;
	else
		chmap = DUMMY_CHMAP;

	cd->converter[sink_fmt->sink_id] = get_converter_func(&sink_fmt->source_fmt,
							      &sink_fmt->sink_fmt, ipc4_gtw_none,
							      ipc4_bidirection, chmap);

	return 0;
}

__cold static int set_attenuation(struct comp_dev *dev, uint32_t data_offset, const char *data)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	uint32_t attenuation;
	enum sof_ipc_frame valid_fmt, frame_fmt;

	assert_can_be_cold();

	/* only support attenuation in format of 32bit */
	if (data_offset > sizeof(uint32_t)) {
		comp_err(dev, "attenuation data size %d is incorrect", data_offset);
		return -EINVAL;
	}

	attenuation = *(const uint32_t *)data;
	if (attenuation > 31) {
		comp_err(dev, "attenuation %d is out of range", attenuation);
		return -EINVAL;
	}

	audio_stream_fmt_conversion(cd->config.out_fmt.depth,
				    cd->config.out_fmt.valid_bit_depth,
				    &frame_fmt, &valid_fmt,
				    cd->config.out_fmt.s_type);

	if (frame_fmt < SOF_IPC_FRAME_S24_4LE) {
		comp_err(dev, "frame_fmt %d isn't supported by attenuation",
			 frame_fmt);
		return -EINVAL;
	}

	cd->attenuation = attenuation;

	return 0;
}

__cold static int set_chmap(struct comp_dev *dev, const void *data, size_t data_size)
{
	const struct ipc4_copier_config_channel_map *chmap_cfg = data;
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	enum ipc4_direction_type dir;
	struct ipc4_audio_format in_fmt = cd->config.base.audio_fmt;
	struct ipc4_audio_format out_fmt = cd->config.out_fmt;
	pcm_converter_func process;
	pcm_converter_func converters[IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT];
	int i;
	uint32_t irq_flags;

	assert_can_be_cold();

	if (data_size < sizeof(*chmap_cfg)) {
		comp_err(dev, "Wrong payload size: %d", data_size);
		return -EINVAL;
	}

	if (cd->endpoint_num == 0 || dev->ipc_config.type != SOF_COMP_DAI) {
		comp_err(dev, "Only DAI gateway supports changing chmap");
		return -EINVAL;
	}

	comp_info(dev, "New chmap requested: %x", chmap_cfg->channel_map);

	if (!cd->dd[0]->dma_buffer) {
		/* DMA buffer not yet created. Remember the chmap, it will be used
		 * later in .params() handler.
		 *
		 * The assignment should be atomic as LL thread can preempt this IPC thread.
		 */
		cd->dd[0]->chmap = chmap_cfg->channel_map;
		return 0;
	}

	copier_dai_adjust_params(cd, &in_fmt, &out_fmt);

	dir = (cd->direction == SOF_IPC_STREAM_PLAYBACK) ?
		ipc4_playback : ipc4_capture;

	process = get_converter_func(&in_fmt, &out_fmt, cd->gtw_type, dir, chmap_cfg->channel_map);

	if (!process) {
		comp_err(dev, "No gtw converter func found!");
		return -EINVAL;
	}

	/* Channel map is same for all sinks. However, as sinks allowed to have different
	 * sample formats, get new convert/remap function for each sink.
	 */
	for (i = 0; i < IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT; i++) {
		if (cd->converter[i]) {
			converters[i] = get_converter_func(&in_fmt, &cd->out_fmt[i],
							   ipc4_gtw_none, ipc4_bidirection,
							   chmap_cfg->channel_map);
			/* Do not report an error if converter not found as sinks could be
			 * bound/unbound on a fly and out_fmt[i] may contain obsolete data.
			 */
		} else {
			converters[i] = NULL;
		}
	}

	/* Atomically update chmap, process and converters */
	irq_local_disable(irq_flags);

	cd->dd[0]->chmap = chmap_cfg->channel_map;
	cd->dd[0]->process = process;
	for (i = 0; i < IPC4_COPIER_MODULE_OUTPUT_PINS_COUNT; i++)
		cd->converter[i] = converters[i];

	irq_local_enable(irq_flags);

	return 0;
}

__cold static int copier_set_configuration(struct processing_module *mod,
					   uint32_t config_id,
					   enum module_cfg_fragment_position pos,
					   uint32_t data_offset_size,
					   const uint8_t *fragment, size_t fragment_size,
					   uint8_t *response,
					   size_t response_size)
{
	struct comp_dev *dev = mod->dev;

	assert_can_be_cold();

	comp_dbg(dev, "copier_set_config()");

	switch (config_id) {
	case IPC4_COPIER_MODULE_CFG_PARAM_SET_SINK_FORMAT:
		return copier_set_sink_fmt(dev, fragment, fragment_size);
	case IPC4_COPIER_MODULE_CFG_ATTENUATION:
		return set_attenuation(dev, fragment_size, (const char *)fragment);
	case IPC4_COPIER_MODULE_CFG_PARAM_CHANNEL_MAP:
		return set_chmap(dev, fragment, fragment_size);
	default:
		return -EINVAL;
	}
}

static inline void convert_u64_to_u32s(uint64_t val, uint32_t *val_l, uint32_t *val_h)
{
	*val_l = (uint32_t)(val & 0xffffffff);
	*val_h = (uint32_t)((val >> 32) & 0xffffffff);
}

__cold static int copier_get_configuration(struct processing_module *mod,
					   uint32_t config_id, uint32_t *data_offset_size,
					   uint8_t *fragment, size_t fragment_size)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct ipc4_llp_reading_extended llp_ext;
	struct comp_dev *dev = mod->dev;
	struct sof_ipc_stream_posn posn;
	struct ipc4_llp_reading llp;

	assert_can_be_cold();

	if (cd->ipc_gtw)
		return 0;

	switch (config_id) {
	case IPC4_COPIER_MODULE_CFG_PARAM_LLP_READING:
		if (!cd->endpoint_num ||
		    comp_get_endpoint_type(dev) !=
		    COMP_ENDPOINT_DAI) {
			comp_err(dev, "Invalid component type");
			return -EINVAL;
		}

		if (*data_offset_size < sizeof(struct ipc4_llp_reading)) {
			comp_err(dev, "Config size %d is inadequate", *data_offset_size);
			return -EINVAL;
		}

		*data_offset_size = sizeof(struct ipc4_llp_reading);
		memset(&llp, 0, sizeof(llp));

		if (dev->state != COMP_STATE_ACTIVE) {
			memcpy_s(fragment, sizeof(llp), &llp, sizeof(llp));
			return 0;
		}

		/* get llp from dai */
		comp_position(dev, &posn);

		convert_u64_to_u32s(posn.comp_posn, &llp.llp_l, &llp.llp_u);
		convert_u64_to_u32s(posn.wallclock, &llp.wclk_l, &llp.wclk_u);
		memcpy_s(fragment, sizeof(llp), &llp, sizeof(llp));

		return 0;

	case IPC4_COPIER_MODULE_CFG_PARAM_LLP_READING_EXTENDED:
		if (!cd->endpoint_num ||
		    comp_get_endpoint_type(dev) !=
		    COMP_ENDPOINT_DAI) {
			comp_err(dev, "Invalid component type");
			return -EINVAL;
		}

		if (*data_offset_size < sizeof(struct ipc4_llp_reading_extended)) {
			comp_err(dev, "Config size %d is inadequate", *data_offset_size);
			return -EINVAL;
		}

		*data_offset_size = sizeof(struct ipc4_llp_reading_extended);
		memset(&llp_ext, 0, sizeof(llp_ext));

		if (dev->state != COMP_STATE_ACTIVE) {
			memcpy_s(fragment, sizeof(llp_ext), &llp_ext, sizeof(llp_ext));
			return 0;
		}

		/* get llp from dai */
		comp_position(dev, &posn);

		convert_u64_to_u32s(posn.comp_posn, &llp_ext.llp_reading.llp_l,
				    &llp_ext.llp_reading.llp_u);
		convert_u64_to_u32s(posn.wallclock, &llp_ext.llp_reading.wclk_l,
				    &llp_ext.llp_reading.wclk_u);

		convert_u64_to_u32s(posn.dai_posn, &llp_ext.tpd_low, &llp_ext.tpd_high);
		memcpy_s(fragment, sizeof(llp_ext), &llp_ext, sizeof(llp_ext));

		return 0;

	default:
		comp_err(dev, "unsupported param %d", config_id);
		break;
	}

	return -EINVAL;
}

static uint64_t copier_get_processed_data(struct comp_dev *dev, uint32_t stream_no, bool input)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	uint64_t ret = 0;
	bool source;

	/*
	 * total data processed is calculated as: accumulate all input data in bytes
	 * from host, then store in host_data structure, this function intend to retrieve
	 * correct processed data number.
	 * Due to host already integrated as part of copier, so for host specific case,
	 * as long as direction is correct, return correct processed data.
	 * Dai still use ops driver to get data, later, dai will also be integrated
	 * into copier, this part will be changed again for dai specific.
	 */
	if (cd->endpoint_num) {
		if (stream_no < cd->endpoint_num) {
			switch (dev->ipc_config.type) {
			case  SOF_COMP_HOST:
				source = dev->direction == SOF_IPC_STREAM_PLAYBACK;
				/* only support host, not support ipcgtw case */
				if (!cd->ipc_gtw && source == input)
					ret = cd->hd->total_data_processed;
				break;
			case  SOF_COMP_DAI:
				source = dev->direction == SOF_IPC_STREAM_CAPTURE;
				if (source == input)
					ret = cd->dd[0]->total_data_processed;
				break;
			default:
				comp_err(dev, "Unexpected gateway type encountered: %d",
					 dev->ipc_config.type);
				break;
			}
		}
	} else {
		if (stream_no == 0)
			ret = input ? cd->input_total_data_processed :
				      cd->output_total_data_processed;
	}

	return ret;
}

static int copier_position(struct comp_dev *dev, struct sof_ipc_stream_posn *posn)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	int ret = 0;

	/* Exit if no endpoints */
	if (!cd->endpoint_num)
		return -EINVAL;

	switch (dev->ipc_config.type) {
	case SOF_COMP_HOST:
		/* only support host not support gtw case */
		if (!cd->ipc_gtw) {
			posn->host_posn = cd->hd->local_pos;
			ret = posn->host_posn;
		}
		break;
	case SOF_COMP_DAI:
		ret = dai_common_position(cd->dd[0], dev, posn);
		break;
	default:
		break;
	}
	/* Return position from the default gateway pin */
	return ret;
}

static int copier_dai_ts_config_op(struct comp_dev *dev)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct dai_data *dd = cd->dd[0];

	return dai_common_ts_config_op(dd, dev);
}

static int copier_dai_ts_start_op(struct comp_dev *dev)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct dai_data *dd = cd->dd[0];

	comp_dbg(dev, "dai_ts_start()");

	return dai_common_ts_start(dd, dev);
}

#if CONFIG_ZEPHYR_NATIVE_DRIVERS
static int copier_dai_ts_get_op(struct comp_dev *dev, struct dai_ts_data *tsd)
#else
static int copier_dai_ts_get_op(struct comp_dev *dev, struct timestamp_data *tsd)
#endif
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct dai_data *dd = cd->dd[0];

	comp_dbg(dev, "dai_ts_get()");

	return dai_common_ts_get(dd, dev, tsd);
}

static int copier_dai_ts_stop_op(struct comp_dev *dev)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct dai_data *dd = cd->dd[0];

	comp_dbg(dev, "dai_ts_stop()");

	return dai_common_ts_stop(dd, dev);
}

__cold static int copier_get_hw_params(struct comp_dev *dev, struct sof_ipc_stream_params *params,
				       int dir)
{
	struct processing_module *mod = comp_mod(dev);
	struct copier_data *cd = module_get_private_data(mod);
	struct dai_data *dd = cd->dd[0];

	assert_can_be_cold();

	if (dev->ipc_config.type != SOF_COMP_DAI)
		return -EINVAL;

	return dai_common_get_hw_params(dd, dev, params, dir);
}

__cold static int copier_bind(struct processing_module *mod, struct bind_info *bind_data)
{
	const struct ipc4_module_bind_unbind *const bu = bind_data->ipc4_data;
	const uint32_t src_id = IPC4_COMP_ID(bu->primary.r.module_id, bu->primary.r.instance_id);
	const uint32_t src_queue_id = bu->extension.r.src_queue;
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;

	assert_can_be_cold();

	if (dev->ipc_config.id != src_id)
		return 0; /* Another component is a data producer */

	/* update sink format */
	struct comp_buffer *buffer;

	comp_dev_for_each_consumer(dev, buffer) {
		uint32_t id = IPC4_SRC_QUEUE_ID(buf_get_id(buffer));

		if (src_queue_id == id) {
			ipc4_update_buffer_format(buffer, &cd->out_fmt[id]);
			return 0;
		}
	}

	comp_err(dev, "No sink buffer found for src_queue = %u", src_queue_id);
	return -ENODEV;
}

__cold static int copier_unbind(struct processing_module *mod, struct bind_info *unbind_data)
{
	struct copier_data *cd = module_get_private_data(mod);
	struct comp_dev *dev = mod->dev;

	assert_can_be_cold();

	if (dev->ipc_config.type == SOF_COMP_DAI) {
		struct dai_data *dd = cd->dd[0];

		return dai_zephyr_unbind(dd, dev, unbind_data);
	}

	return 0;
}

static struct module_endpoint_ops copier_endpoint_ops = {
	.get_total_data_processed = copier_get_processed_data,
	.position = copier_position,
	.dai_ts_config = copier_dai_ts_config_op,
	.dai_ts_start = copier_dai_ts_start_op,
	.dai_ts_stop = copier_dai_ts_stop_op,
	.dai_ts_get = copier_dai_ts_get_op,
	.dai_get_hw_params = copier_get_hw_params,
	.trigger = copier_comp_trigger
};

static const struct module_interface copier_interface = {
	.init = copier_init,
	.prepare = copier_prepare,
	.process_audio_stream = copier_process,
	.reset = copier_reset,
	.free = copier_free,
	.set_configuration = copier_set_configuration,
	.get_configuration = copier_get_configuration,
	.bind = copier_bind,
	.unbind = copier_unbind,
	.endpoint_ops = &copier_endpoint_ops,
};

DECLARE_TR_CTX(copier_comp_tr, SOF_UUID(copier_uuid), LOG_LEVEL_INFO);

DECLARE_MODULE_ADAPTER(copier_interface, copier_uuid, copier_comp_tr);
SOF_MODULE_INIT(copier, sys_comp_module_copier_interface_init);