ASoC: SOF: ipc4-topology: implement KCPS adjustment

The SOF already supports the REGISTER_KCPS IPC, this patch also adds
support for it to the driver. A new topology token is used for this,
which specified the KCPS requirement for each pipeline. When a
pipeline is created, that had a KCPS value specified for it in the
topology, that value is sent to the firmware for clock adjustment.
When such a pipeline is destroyed, the same negative value is sent to
return the system clock rate to the original state.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>

Author: lyakh

include/sound/sof/ipc4/header.h

@@ -389,6 +389,7 @@ enum sof_ipc4_base_fw_params {
 	SOF_IPC4_FW_PARAM_MODULES_INFO_GET,
 	SOF_IPC4_FW_PARAM_LIBRARIES_INFO_GET = 16,
 	SOF_IPC4_FW_PARAM_SYSTEM_TIME = 20,
+	SOF_IPC4_FW_PARAM_REGISTER_KCPS = 22,
 };
 
 enum sof_ipc4_fw_config_params {

include/uapi/sound/sof/tokens.h

@@ -55,6 +55,7 @@
 #define SOF_TKN_SCHED_LP_MODE			207
 #define SOF_TKN_SCHED_MEM_USAGE			208
 #define SOF_TKN_SCHED_USE_CHAIN_DMA		209
+#define SOF_TKN_SCHED_PIPELINE_KCPS		210
 
 /* volume */
 #define SOF_TKN_VOLUME_RAMP_STEP_TYPE		250

sound/soc/sof/ipc4-topology.c

@@ -31,6 +31,8 @@ static const struct sof_topology_token ipc4_sched_tokens[] = {
 		offsetof(struct sof_ipc4_pipeline, use_chain_dma)},
 	{SOF_TKN_SCHED_CORE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
 		offsetof(struct sof_ipc4_pipeline, core_id)},
+	{SOF_TKN_SCHED_PIPELINE_KCPS, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
+		offsetof(struct sof_ipc4_pipeline, kcps)},
 };
 
 static const struct sof_topology_token pipeline_tokens[] = {
@@ -1976,12 +1978,30 @@ static int sof_ipc4_control_setup(struct snd_sof_dev *sdev, struct snd_sof_contr
 	return 0;
 }
 
+static int sof_ipc4_send_kcps(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget,
+			      __s32 delta_kcps)
+{
+	const struct sof_ipc_ops *iops = sdev->ipc->ops;
+	struct sof_ipc4_msg msg = {
+		.primary = SOF_IPC4_MSG_TARGET(SOF_IPC4_MODULE_MSG) |
+			SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST) |
+			SOF_IPC4_MOD_ID(SOF_IPC4_MOD_INIT_BASEFW_MOD_ID) |
+			SOF_IPC4_MOD_INSTANCE(SOF_IPC4_MOD_INIT_BASEFW_INSTANCE_ID),
+		.extension = SOF_IPC4_MOD_EXT_MSG_PARAM_ID(SOF_IPC4_FW_PARAM_REGISTER_KCPS),
+		.data_size = sizeof(delta_kcps),
+		.data_ptr = &delta_kcps,
+	};
+
+	return iops->set_get_data(sdev, &msg, msg.data_size, true);
+}
+
 static int sof_ipc4_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget)
 {
 	struct snd_sof_widget *pipe_widget = swidget->spipe->pipe_widget;
 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
 	struct sof_ipc4_pipeline *pipeline;
 	struct sof_ipc4_msg *msg;
+	__s32 delta_kcps = 0;
 	void *ipc_data = NULL;
 	u32 ipc_size = 0;
 	int ret;
@@ -2008,6 +2028,7 @@ static int sof_ipc4_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget
 		}
 		msg->primary &= ~SOF_IPC4_GLB_PIPE_INSTANCE_MASK;
 		msg->primary |= SOF_IPC4_GLB_PIPE_INSTANCE_ID(swidget->instance_id);
+		delta_kcps = pipeline->kcps;
 		break;
 	case snd_soc_dapm_aif_in:
 	case snd_soc_dapm_aif_out:
@@ -2127,6 +2148,12 @@ static int sof_ipc4_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget
 		} else {
 			ida_free(&pipeline_ida, swidget->instance_id);
 		}
+	} else if (delta_kcps) {
+		ret = sof_ipc4_send_kcps(sdev, swidget, delta_kcps);
+		if (ret < 0) {
+			dev_warn(sdev->dev, "failed to increase KCPS: %d, continuing\n", ret);
+			ret = 0;
+		}
 	}
 
 	return ret;
@@ -2161,6 +2188,13 @@ static int sof_ipc4_widget_free(struct snd_sof_dev *sdev, struct snd_sof_widget
 			dev_err(sdev->dev, "failed to free pipeline widget %s\n",
 				swidget->widget->name);
 
+		if (pipeline->kcps) {
+			ret = sof_ipc4_send_kcps(sdev, swidget, -pipeline->kcps);
+			if (ret < 0)
+				dev_warn(sdev->dev,
+					 "failed to decrease KCPS: %d, continuing\n", ret);
+		}
+
 		pipeline->mem_usage = 0;
 		pipeline->state = SOF_IPC4_PIPE_UNINITIALIZED;
 		ida_free(&pipeline_ida, swidget->instance_id);

sound/soc/sof/ipc4-topology.h

@@ -125,6 +125,7 @@ struct sof_ipc4_copier_config_set_sink_format {
  * @lp_mode: Low power mode
  * @mem_usage: Memory usage
  * @core_id: Target core for the pipeline
+ * @kcps: optionally provided by the topology pipeline KCPS requirement
  * @state: Pipeline state
  * @use_chain_dma: flag to indicate if the firmware shall use chained DMA
  * @msg: message structure for pipeline
@@ -135,6 +136,7 @@ struct sof_ipc4_pipeline {
 	uint32_t lp_mode;
 	uint32_t mem_usage;
 	uint32_t core_id;
+	uint32_t kcps;
 	int state;
 	bool use_chain_dma;
 	struct sof_ipc4_msg msg;