ASoC: SOF: ipc4-topology: add process support

include/uapi/sound/sof/abi.h

@@ -60,5 +60,6 @@
 
 /* SOF ABI magic number "SOF\0". */
 #define SOF_ABI_MAGIC 0x00464F53
+#define SOF_IPC4_ABI_MAGIC	0x34464F53
 
 #endif

include/uapi/sound/sof/header.h

@@ -26,6 +26,30 @@ struct sof_abi_hdr {
 	__u32 data[]; /**< Component data - opaque to core */
 } __packed;
 
+/*
+ * Identifies data type, size and ABI for IPC4.
+ * Used by any bespoke component data structures or binary blobs.
+ */
+struct sof_ipc4_abi_hdr {
+	__u32 magic; /**< 'S', 'O', 'F', '4' */
+	__u32 rsvd1;
+	__u32 size; /**< size in bytes of data excl. this struct */
+	__u32 abi; /**< SOF ABI version */
+	__u32 ipc_blob_type;	/** IPC4 type. 0: init, 2: config, 4: large_config */
+	/*
+ * ipc_extension is used in ipc4 message extension field. Please check
+ * struct sof_ipc4_msg for the ipc4 message structure details.
+ * ipc_extension in this structure is used by module config/large_config
+ * ipc message. Module config message uses extension to send the configure
+ * data while module large_config message uses extension to describe
+ * the message payload size, param_id and etc. If the extension is not
+ * used, it should be set to 0.
+ */
+	__u32 ipc_extension;
+	__u32 rsvd2[2];	/**< reserved for future use */
+	__u32 data[]; /**< Component data - opaque to core */
+} __packed;
+
 #define SOF_MANIFEST_DATA_TYPE_NHLT 1
 
 /**

include/uapi/sound/sof/tokens.h

@@ -96,7 +96,7 @@
  */
 #define SOF_TKN_COMP_SINK_PIN_BINDING_WNAME	413
 #define SOF_TKN_COMP_SRC_PIN_BINDING_WNAME	414
-
+#define SOF_TKN_COMP_PAYLOAD_WITH_OUTPUT	415
 
 /* SSP */
 #define SOF_TKN_INTEL_SSP_CLKS_CONTROL 500

sound/soc/sof/ipc4-control.c

@@ -173,15 +173,25 @@ static int sof_ipc4_widget_kcontrol_setup(struct snd_sof_dev *sdev, struct snd_s
 	struct snd_sof_control *scontrol;
 	int ret;
 
-	list_for_each_entry(scontrol, &sdev->kcontrol_list, list)
+	list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
  if (scontrol->comp_id == swidget->comp_id) {
- ret = sof_ipc4_set_volume_data(sdev, swidget, scontrol);
- if (ret < 0) {
- dev_err(sdev->dev, "%s: kcontrol %d set up failed for widget %s\n",
- __func__, scontrol->comp_id, swidget->widget->name);
- return ret;
+ switch (scontrol->info_type) {
+ case SND_SOC_TPLG_CTL_VOLSW:
+ case SND_SOC_TPLG_CTL_VOLSW_SX:
+ case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
+ ret = sof_ipc4_set_volume_data(sdev, swidget, scontrol);
+ if (ret < 0) {
+ dev_err(sdev->dev, "kcontrol %d set up failed for widget %s\n",
+ scontrol->comp_id, swidget->widget->name);
+ return ret;
+ }
+ break;
+ default:
+ /* do nothing */
+ break;
  }
  }
+	}
 
 	return 0;
 }

sound/soc/sof/ipc4-topology.c

@@ -100,6 +100,8 @@ static const struct sof_topology_token dai_tokens[] = {
 static const struct sof_topology_token comp_ext_tokens[] = {
 	{SOF_TKN_COMP_UUID, SND_SOC_TPLG_TUPLE_TYPE_UUID, get_token_uuid,
  offsetof(struct snd_sof_widget, uuid)},
+	{SOF_TKN_COMP_PAYLOAD_WITH_OUTPUT, SND_SOC_TPLG_TUPLE_TYPE_BOOL, get_token_u16,
+ offsetof(struct snd_sof_widget, payload_with_output)},
 };
 
 static const struct sof_topology_token gain_tokens[] = {
@@ -803,6 +805,86 @@ static void sof_ipc4_widget_free_comp_mixer(struct snd_sof_widget *swidget)
 	swidget->private = NULL;
 }
 
+/*
+ * Add the process modules support. The process modules are defined as snd_soc_dapm_effect modules.
+ */
+static int sof_ipc4_widget_setup_comp_process(struct snd_sof_widget *swidget)
+{
+	struct snd_soc_component *scomp = swidget->scomp;
+	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
+	struct sof_ipc4_control_data *control_data;
+	struct sof_ipc4_process *process;
+	struct snd_sof_control *scontrol;
+	int cfg_size;
+	void *cfg;
+	int ret;
+
+	process = kzalloc(sizeof(*process), GFP_KERNEL);
+	if (!process)
+ return -ENOMEM;
+
+	swidget->private = process;
+
+	ret = sof_ipc4_get_audio_fmt(scomp, swidget, &process->available_fmt, true);
+	if (ret)
+ goto err;
+
+	cfg_size = sizeof(struct sof_ipc4_base_module_cfg);
+	if (swidget->payload_with_output)
+ cfg_size += sizeof(struct sof_ipc4_audio_format);
+
+	/* allocate the cfg for process modules */
+	list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
+ if (scontrol->comp_id == swidget->comp_id) {
+ control_data = scontrol->ipc_control_data;
+ /*
+ * TODO: add flag in topology to indicate whether the module has
+ * SOF_IPC4_MOD_INIT_INSTANCE type kcontrol and do sanity check here
+ */
+ if (control_data->data->ipc_blob_type == SOF_IPC4_MOD_INIT_INSTANCE) {
+ cfg_size += control_data->data->size;
+ break;
+ }
+ }
+	}
+
+	cfg = kzalloc(cfg_size, GFP_KERNEL);
+	if (!cfg) {
+ ret = -ENOMEM;
+ goto free_available_fmt;
+	}
+
+	process->ipc_config_data = cfg;
+	process->ipc_config_size = cfg_size;
+	ret = sof_ipc4_widget_setup_msg(swidget, &process->msg);
+	if (ret)
+ goto free_cfg_data;
+
+	return 0;
+free_cfg_data:
+	kfree(process->ipc_config_data);
+	process->ipc_config_data = NULL;
+free_available_fmt:
+	sof_ipc4_free_audio_fmt(&process->available_fmt);
+err:
+	kfree(process);
+	swidget->private = NULL;
+	return ret;
+}
+
+static void sof_ipc4_widget_free_comp_process(struct snd_sof_widget *swidget)
+{
+	struct sof_ipc4_process *process = swidget->private;
+
+	if (!process)
+ return;
+
+	kfree(process->ipc_config_data);
+	sof_ipc4_free_audio_fmt(&process->available_fmt);
+	kfree(swidget->private);
+	swidget->private = NULL;
+}
+
 static void
 sof_ipc4_update_pipeline_mem_usage(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget,
  struct sof_ipc4_base_module_cfg *base_config)
@@ -1387,6 +1469,86 @@ static int sof_ipc4_prepare_src_module(struct snd_sof_widget *swidget,
 	return 0;
 }
 
+static int sof_ipc4_prepare_process_module(struct snd_sof_widget *swidget,
+ struct snd_pcm_hw_params *fe_params,
+ struct snd_sof_platform_stream_params *platform_params,
+ struct snd_pcm_hw_params *pipeline_params, int dir)
+{
+	struct snd_soc_component *scomp = swidget->scomp;
+	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
+	struct snd_soc_dapm_widget *widget = swidget->widget;
+	struct sof_ipc4_process *process = swidget->private;
+	struct sof_ipc4_available_audio_format *available_fmt = &process->available_fmt;
+	struct sof_ipc4_control_data *control_data;
+	struct snd_sof_control *scontrol = NULL;
+	void *cfg = process->ipc_config_data;
+	const struct snd_kcontrol_new *kc;
+	struct soc_bytes_ext *sbe;
+	void *extra_flag;
+	int ret, i;
+
+	available_fmt->ref_audio_fmt = &available_fmt->base_config->audio_fmt;
+
+	/*
+ * Output format is optional for process modules.
+ * Process modules setup the output format based on audio format tokens in topology.
+ */
+	if (swidget->payload_with_output)
+ ret = sof_ipc4_init_audio_fmt(sdev, swidget, &process->base_config,
+ &process->output_format, pipeline_params,
+ available_fmt,
+ sizeof(struct sof_ipc4_base_module_cfg));
+	else
+ ret = sof_ipc4_init_audio_fmt(sdev, swidget, &process->base_config,
+ NULL, pipeline_params, available_fmt,
+ sizeof(struct sof_ipc4_base_module_cfg));
+	if (ret < 0)
+ return ret;
+
+	/* update pipeline memory usage */
+	sof_ipc4_update_pipeline_mem_usage(sdev, swidget, &process->base_config);
+
+	/*
+ * ipc_config_data is composed of the base_config, optional output formats followed
+ * by the data required for module init in that order.
+ */
+	memcpy(cfg, &process->base_config, sizeof(struct sof_ipc4_base_module_cfg));
+	cfg += sizeof(struct sof_ipc4_base_module_cfg);
+
+	/* copy output format to configure data payload */
+	if (swidget->payload_with_output) {
+ memcpy(cfg, &process->output_format, sizeof(struct sof_ipc4_audio_format));
+ cfg += sizeof(struct sof_ipc4_audio_format);
+	}
+
+	for (i = 0; i < widget->num_kcontrols; i++) {
+ kc = &widget->kcontrol_news[i];
+ if (!kc)
+ return -ENODEV;
+
+ /* payload uses byte kcontrol */
+ if (widget->dobj.widget.kcontrol_type[i] != SND_SOC_TPLG_TYPE_BYTES)
+ continue;
+ sbe = (struct soc_bytes_ext *)kc->private_value;
+ scontrol = sbe->dobj.private;
+ if (!scontrol)
+ continue;
+ control_data = scontrol->ipc_control_data;
+ if (control_data->data->ipc_blob_type != SOF_IPC4_MOD_INIT_INSTANCE)
+ continue;
+
+ /*
+ * TODO: add flag in topology to indicate whether the module has
+ * SOF_IPC4_MOD_INIT_INSTANCE type kcontrol and do sanity check here
+ */
+ extra_flag = (void *)control_data->data->data;
+ memcpy(cfg, extra_flag, control_data->data->size);
+ break;
+	}
+
+	return 0;
+}
+
 static int sof_ipc4_control_load_volume(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol)
 {
 	struct sof_ipc4_control_data *control_data;
@@ -1419,13 +1581,55 @@ static int sof_ipc4_control_load_volume(struct snd_sof_dev *sdev, struct snd_sof
 	return 0;
 }
 
+static int sof_ipc4_control_load_bytes(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol)
+{
+	struct sof_ipc4_control_data *control_data;
+	int ret;
+
+	scontrol->size = sizeof(struct sof_ipc4_control_data) + scontrol->priv_size;
+
+	scontrol->ipc_control_data = kzalloc(scontrol->size, GFP_KERNEL);
+	if (!scontrol->ipc_control_data)
+ return -ENOMEM;
+
+	control_data = scontrol->ipc_control_data;
+	control_data->index = scontrol->index;
+	if (scontrol->priv_size > 0) {
+ memcpy(control_data->data, scontrol->priv, scontrol->priv_size);
+
+ if (control_data->data->magic != SOF_IPC4_ABI_MAGIC) {
+ dev_err(sdev->dev, "Wrong ABI magic 0x%08x.\n", control_data->data->magic);
+ ret = -EINVAL;
+ goto err;
+ }
+
+ /* TODO: check the ABI version */
+
+ if (control_data->data->size + sizeof(struct sof_ipc4_abi_hdr) !=
+ scontrol->priv_size) {
+ dev_err(sdev->dev, "Conflict in bytes vs. priv size.\n");
+ ret = -EINVAL;
+ goto err;
+ }
+	}
+
+	return 0;
+
+err:
+	kfree(scontrol->ipc_control_data);
+	scontrol->ipc_control_data = NULL;
+	return ret;
+}
+
 static int sof_ipc4_control_setup(struct snd_sof_dev *sdev, struct snd_sof_control *scontrol)
 {
 	switch (scontrol->info_type) {
 	case SND_SOC_TPLG_CTL_VOLSW:
 	case SND_SOC_TPLG_CTL_VOLSW_SX:
 	case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
  return sof_ipc4_control_load_volume(sdev, scontrol);
+	case SND_SOC_TPLG_CTL_BYTES:
+ return sof_ipc4_control_load_bytes(sdev, scontrol);
 	default:
  break;
 	}
@@ -1517,6 +1721,22 @@ static int sof_ipc4_widget_setup(struct snd_sof_dev *sdev, struct snd_sof_widget
  msg = &src->msg;
  break;
 	}
+	case snd_soc_dapm_effect:
+	{
+ struct sof_ipc4_process *process = swidget->private;
+
+ if (!process->ipc_config_size) {
+ dev_err(sdev->dev, "module %s has no config data!\n",
+ swidget->widget->name);
+ return -EINVAL;
+ }
+
+ ipc_size = process->ipc_config_size;
+ ipc_data = process->ipc_config_data;
+
+ msg = &process->msg;
+ break;
+	}
 	default:
  dev_err(sdev->dev, "widget type %d not supported", swidget->id);
  return -EINVAL;
@@ -2024,6 +2244,15 @@ static enum sof_tokens src_token_list[] = {
 	SOF_COMP_EXT_TOKENS,
 };
 
+static enum sof_tokens process_token_list[] = {
+	SOF_COMP_TOKENS,
+	SOF_AUDIO_FMT_NUM_TOKENS,
+	SOF_IN_AUDIO_FORMAT_TOKENS,
+	SOF_OUT_AUDIO_FORMAT_TOKENS,
+	SOF_AUDIO_FORMAT_BUFFER_SIZE_TOKENS,
+	SOF_COMP_EXT_TOKENS,
+};
+
 static const struct sof_ipc_tplg_widget_ops tplg_ipc4_widget_ops[SND_SOC_DAPM_TYPE_COUNT] = {
 	[snd_soc_dapm_aif_in] = {sof_ipc4_widget_setup_pcm, sof_ipc4_widget_free_comp_pcm,
  host_token_list, ARRAY_SIZE(host_token_list), NULL,
@@ -2057,6 +2286,11 @@ static const struct sof_ipc_tplg_widget_ops tplg_ipc4_widget_ops[SND_SOC_DAPM_TY
  src_token_list, ARRAY_SIZE(src_token_list),
  NULL, sof_ipc4_prepare_src_module,
  NULL},
+	[snd_soc_dapm_effect] = {sof_ipc4_widget_setup_comp_process,
+ sof_ipc4_widget_free_comp_process,
+ process_token_list, ARRAY_SIZE(process_token_list),
+ NULL, sof_ipc4_prepare_process_module,
+ NULL},
 };
 
 const struct sof_ipc_tplg_ops ipc4_tplg_ops = {