1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
3 // This file is provided under a dual BSD/GPLv2 license. When using or
4 // redistributing this file, you may do so under either license.
6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
11 #include <linux/firmware.h>
12 #include <sound/tlv.h>
13 #include <sound/pcm_params.h>
14 #include <uapi/sound/sof/tokens.h>
18 #define COMP_ID_UNASSIGNED 0xffffffff
20 * Constants used in the computation of linear volume gain
21 * from dB gain 20th root of 10 in Q1.16 fixed-point notation
23 #define VOL_TWENTIETH_ROOT_OF_TEN 73533
24 /* 40th root of 10 in Q1.16 fixed-point notation*/
25 #define VOL_FORTIETH_ROOT_OF_TEN 69419
27 * Volume fractional word length define to 16 sets
28 * the volume linear gain value to use Qx.16 format
31 /* 0.5 dB step value in topology TLV */
32 #define VOL_HALF_DB_STEP 50
33 /* Full volume for default values */
34 #define VOL_ZERO_DB BIT(VOLUME_FWL)
42 /* size of tplg abi in byte */
43 #define SOF_TPLG_ABI_SIZE 3
45 struct sof_widget_data {
48 struct sof_abi_hdr *pdata;
49 struct snd_sof_control *control;
52 /* send pcm params ipc */
53 static int ipc_pcm_params(struct snd_sof_widget *swidget, int dir)
55 struct sof_ipc_pcm_params_reply ipc_params_reply;
56 struct snd_sof_dev *sdev = swidget->sdev;
57 struct sof_ipc_pcm_params pcm;
58 struct snd_pcm_hw_params *params;
59 struct snd_sof_pcm *spcm;
62 memset(&pcm, 0, sizeof(pcm));
64 /* get runtime PCM params using widget's stream name */
65 spcm = snd_sof_find_spcm_name(sdev, swidget->widget->sname);
67 dev_err(sdev->dev, "error: cannot find PCM for %s\n",
68 swidget->widget->name);
72 params = &spcm->params[dir];
74 /* set IPC PCM params */
75 pcm.hdr.size = sizeof(pcm);
76 pcm.hdr.cmd = SOF_IPC_GLB_STREAM_MSG | SOF_IPC_STREAM_PCM_PARAMS;
77 pcm.comp_id = swidget->comp_id;
78 pcm.params.hdr.size = sizeof(pcm.params);
79 pcm.params.direction = dir;
80 pcm.params.sample_valid_bytes = params_width(params) >> 3;
81 pcm.params.buffer_fmt = SOF_IPC_BUFFER_INTERLEAVED;
82 pcm.params.rate = params_rate(params);
83 pcm.params.channels = params_channels(params);
84 pcm.params.host_period_bytes = params_period_bytes(params);
87 switch (params_format(params)) {
88 case SNDRV_PCM_FORMAT_S16:
89 pcm.params.frame_fmt = SOF_IPC_FRAME_S16_LE;
91 case SNDRV_PCM_FORMAT_S24:
92 pcm.params.frame_fmt = SOF_IPC_FRAME_S24_4LE;
94 case SNDRV_PCM_FORMAT_S32:
95 pcm.params.frame_fmt = SOF_IPC_FRAME_S32_LE;
101 /* send IPC to the DSP */
102 ret = sof_ipc_tx_message(sdev->ipc, pcm.hdr.cmd, &pcm, sizeof(pcm),
103 &ipc_params_reply, sizeof(ipc_params_reply));
105 dev_err(sdev->dev, "error: pcm params failed for %s\n",
106 swidget->widget->name);
111 /* send stream trigger ipc */
112 static int ipc_trigger(struct snd_sof_widget *swidget, int cmd)
114 struct snd_sof_dev *sdev = swidget->sdev;
115 struct sof_ipc_stream stream;
116 struct sof_ipc_reply reply;
119 /* set IPC stream params */
120 stream.hdr.size = sizeof(stream);
121 stream.hdr.cmd = SOF_IPC_GLB_STREAM_MSG | cmd;
122 stream.comp_id = swidget->comp_id;
124 /* send IPC to the DSP */
125 ret = sof_ipc_tx_message(sdev->ipc, stream.hdr.cmd, &stream,
126 sizeof(stream), &reply, sizeof(reply));
128 dev_err(sdev->dev, "error: failed to trigger %s\n",
129 swidget->widget->name);
134 static int sof_keyword_dapm_event(struct snd_soc_dapm_widget *w,
135 struct snd_kcontrol *k, int event)
137 struct snd_sof_widget *swidget = w->dobj.private;
138 struct snd_sof_dev *sdev;
144 sdev = swidget->sdev;
146 dev_dbg(sdev->dev, "received event %d for widget %s\n",
151 case SND_SOC_DAPM_PRE_PMU:
153 ret = ipc_pcm_params(swidget, SOF_IPC_STREAM_CAPTURE);
156 "error: failed to set pcm params for widget %s\n",
157 swidget->widget->name);
162 ret = ipc_trigger(swidget, SOF_IPC_STREAM_TRIG_START);
165 "error: failed to trigger widget %s\n",
166 swidget->widget->name);
168 case SND_SOC_DAPM_POST_PMD:
170 ret = ipc_trigger(swidget, SOF_IPC_STREAM_TRIG_STOP);
173 "error: failed to trigger widget %s\n",
174 swidget->widget->name);
177 ret = ipc_trigger(swidget, SOF_IPC_STREAM_PCM_FREE);
180 "error: failed to trigger widget %s\n",
181 swidget->widget->name);
190 /* event handlers for keyword detect component */
191 static const struct snd_soc_tplg_widget_events sof_kwd_events[] = {
192 {SOF_KEYWORD_DETECT_DAPM_EVENT, sof_keyword_dapm_event},
195 static inline int get_tlv_data(const int *p, int tlv[TLV_ITEMS])
197 /* we only support dB scale TLV type at the moment */
198 if ((int)p[SNDRV_CTL_TLVO_TYPE] != SNDRV_CTL_TLVT_DB_SCALE)
201 /* min value in topology tlv data is multiplied by 100 */
202 tlv[TLV_MIN] = (int)p[SNDRV_CTL_TLVO_DB_SCALE_MIN] / 100;
205 tlv[TLV_STEP] = (int)(p[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] &
209 if ((p[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] &
210 TLV_DB_SCALE_MUTE) == 0)
219 * Function to truncate an unsigned 64-bit number
220 * by x bits and return 32-bit unsigned number. This
221 * function also takes care of rounding while truncating
223 static inline u32 vol_shift_64(u64 i, u32 x)
225 /* do not truncate more than 32 bits */
232 return (u32)(((i >> (x - 1)) + 1) >> 1);
236 * Function to compute a ^ exp where,
237 * a is a fractional number represented by a fixed-point
238 * integer with a fractional world length of "fwl"
240 * fwl is the fractional word length
241 * Return value is a fractional number represented by a
242 * fixed-point integer with a fractional word length of "fwl"
244 static u32 vol_pow32(u32 a, int exp, u32 fwl)
247 u32 power = 1 << fwl;
250 /* if exponent is 0, return 1 */
254 /* determine the number of iterations based on the exponent */
260 /* mutiply a "iter" times to compute power */
261 for (i = 0; i < iter; i++) {
263 * Product of 2 Qx.fwl fixed-point numbers yields a Q2*x.2*fwl
264 * Truncate product back to fwl fractional bits with rounding
266 power = vol_shift_64((u64)power * a, fwl);
270 /* if exp is positive, return the result */
274 /* if exp is negative, return the multiplicative inverse */
275 numerator = (u64)1 << (fwl << 1);
276 do_div(numerator, power);
278 return (u32)numerator;
282 * Function to calculate volume gain from TLV data.
283 * This function can only handle gain steps that are multiples of 0.5 dB
285 static u32 vol_compute_gain(u32 value, int *tlv)
292 if (value == 0 && tlv[TLV_MUTE])
296 * compute dB gain from tlv. tlv_step
297 * in topology is multiplied by 100
299 dB_gain = tlv[TLV_MIN] + (value * tlv[TLV_STEP]) / 100;
302 * compute linear gain represented by fixed-point
303 * int with VOLUME_FWL fractional bits
305 linear_gain = vol_pow32(VOL_TWENTIETH_ROOT_OF_TEN, dB_gain, VOLUME_FWL);
307 /* extract the fractional part of volume step */
308 f_step = tlv[TLV_STEP] - (tlv[TLV_STEP] / 100);
310 /* if volume step is an odd multiple of 0.5 dB */
311 if (f_step == VOL_HALF_DB_STEP && (value & 1))
312 linear_gain = vol_shift_64((u64)linear_gain *
313 VOL_FORTIETH_ROOT_OF_TEN,
320 * Set up volume table for kcontrols from tlv data
321 * "size" specifies the number of entries in the table
323 static int set_up_volume_table(struct snd_sof_control *scontrol,
324 int tlv[TLV_ITEMS], int size)
328 /* init the volume table */
329 scontrol->volume_table = kcalloc(size, sizeof(u32), GFP_KERNEL);
330 if (!scontrol->volume_table)
333 /* populate the volume table */
334 for (j = 0; j < size ; j++)
335 scontrol->volume_table[j] = vol_compute_gain(j, tlv);
340 struct sof_dai_types {
342 enum sof_ipc_dai_type type;
345 static const struct sof_dai_types sof_dais[] = {
346 {"SSP", SOF_DAI_INTEL_SSP},
347 {"HDA", SOF_DAI_INTEL_HDA},
348 {"DMIC", SOF_DAI_INTEL_DMIC},
349 {"SAI", SOF_DAI_IMX_SAI},
350 {"ESAI", SOF_DAI_IMX_ESAI},
353 static enum sof_ipc_dai_type find_dai(const char *name)
357 for (i = 0; i < ARRAY_SIZE(sof_dais); i++) {
358 if (strcmp(name, sof_dais[i].name) == 0)
359 return sof_dais[i].type;
362 return SOF_DAI_INTEL_NONE;
366 * Supported Frame format types and lookup, add new ones to end of list.
369 struct sof_frame_types {
371 enum sof_ipc_frame frame;
374 static const struct sof_frame_types sof_frames[] = {
375 {"s16le", SOF_IPC_FRAME_S16_LE},
376 {"s24le", SOF_IPC_FRAME_S24_4LE},
377 {"s32le", SOF_IPC_FRAME_S32_LE},
378 {"float", SOF_IPC_FRAME_FLOAT},
381 static enum sof_ipc_frame find_format(const char *name)
385 for (i = 0; i < ARRAY_SIZE(sof_frames); i++) {
386 if (strcmp(name, sof_frames[i].name) == 0)
387 return sof_frames[i].frame;
390 /* use s32le if nothing is specified */
391 return SOF_IPC_FRAME_S32_LE;
394 struct sof_process_types {
396 enum sof_ipc_process_type type;
397 enum sof_comp_type comp_type;
400 static const struct sof_process_types sof_process[] = {
401 {"EQFIR", SOF_PROCESS_EQFIR, SOF_COMP_EQ_FIR},
402 {"EQIIR", SOF_PROCESS_EQIIR, SOF_COMP_EQ_IIR},
403 {"KEYWORD_DETECT", SOF_PROCESS_KEYWORD_DETECT, SOF_COMP_KEYWORD_DETECT},
404 {"KPB", SOF_PROCESS_KPB, SOF_COMP_KPB},
405 {"CHAN_SELECTOR", SOF_PROCESS_CHAN_SELECTOR, SOF_COMP_SELECTOR},
406 {"MUX", SOF_PROCESS_MUX, SOF_COMP_MUX},
407 {"DEMUX", SOF_PROCESS_DEMUX, SOF_COMP_DEMUX},
410 static enum sof_ipc_process_type find_process(const char *name)
414 for (i = 0; i < ARRAY_SIZE(sof_process); i++) {
415 if (strcmp(name, sof_process[i].name) == 0)
416 return sof_process[i].type;
419 return SOF_PROCESS_NONE;
422 static enum sof_comp_type find_process_comp_type(enum sof_ipc_process_type type)
426 for (i = 0; i < ARRAY_SIZE(sof_process); i++) {
427 if (sof_process[i].type == type)
428 return sof_process[i].comp_type;
431 return SOF_COMP_NONE;
435 * Standard Kcontrols.
438 static int sof_control_load_volume(struct snd_soc_component *scomp,
439 struct snd_sof_control *scontrol,
440 struct snd_kcontrol_new *kc,
441 struct snd_soc_tplg_ctl_hdr *hdr)
443 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
444 struct snd_soc_tplg_mixer_control *mc =
445 container_of(hdr, struct snd_soc_tplg_mixer_control, hdr);
446 struct sof_ipc_ctrl_data *cdata;
451 /* validate topology data */
452 if (le32_to_cpu(mc->num_channels) > SND_SOC_TPLG_MAX_CHAN)
455 /* init the volume get/put data */
456 scontrol->size = struct_size(scontrol->control_data, chanv,
457 le32_to_cpu(mc->num_channels));
458 scontrol->control_data = kzalloc(scontrol->size, GFP_KERNEL);
459 if (!scontrol->control_data)
462 scontrol->comp_id = sdev->next_comp_id;
463 scontrol->min_volume_step = le32_to_cpu(mc->min);
464 scontrol->max_volume_step = le32_to_cpu(mc->max);
465 scontrol->num_channels = le32_to_cpu(mc->num_channels);
467 /* set cmd for mixer control */
468 if (le32_to_cpu(mc->max) == 1) {
469 scontrol->cmd = SOF_CTRL_CMD_SWITCH;
473 scontrol->cmd = SOF_CTRL_CMD_VOLUME;
475 /* extract tlv data */
476 if (get_tlv_data(kc->tlv.p, tlv) < 0) {
477 dev_err(sdev->dev, "error: invalid TLV data\n");
481 /* set up volume table */
482 ret = set_up_volume_table(scontrol, tlv, le32_to_cpu(mc->max) + 1);
484 dev_err(sdev->dev, "error: setting up volume table\n");
488 /* set default volume values to 0dB in control */
489 cdata = scontrol->control_data;
490 for (i = 0; i < scontrol->num_channels; i++) {
491 cdata->chanv[i].channel = i;
492 cdata->chanv[i].value = VOL_ZERO_DB;
496 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d\n",
497 scontrol->comp_id, scontrol->num_channels);
502 static int sof_control_load_enum(struct snd_soc_component *scomp,
503 struct snd_sof_control *scontrol,
504 struct snd_kcontrol_new *kc,
505 struct snd_soc_tplg_ctl_hdr *hdr)
507 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
508 struct snd_soc_tplg_enum_control *ec =
509 container_of(hdr, struct snd_soc_tplg_enum_control, hdr);
511 /* validate topology data */
512 if (le32_to_cpu(ec->num_channels) > SND_SOC_TPLG_MAX_CHAN)
515 /* init the enum get/put data */
516 scontrol->size = struct_size(scontrol->control_data, chanv,
517 le32_to_cpu(ec->num_channels));
518 scontrol->control_data = kzalloc(scontrol->size, GFP_KERNEL);
519 if (!scontrol->control_data)
522 scontrol->comp_id = sdev->next_comp_id;
523 scontrol->num_channels = le32_to_cpu(ec->num_channels);
525 scontrol->cmd = SOF_CTRL_CMD_ENUM;
527 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d comp_id %d\n",
528 scontrol->comp_id, scontrol->num_channels, scontrol->comp_id);
533 static int sof_control_load_bytes(struct snd_soc_component *scomp,
534 struct snd_sof_control *scontrol,
535 struct snd_kcontrol_new *kc,
536 struct snd_soc_tplg_ctl_hdr *hdr)
538 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
539 struct sof_ipc_ctrl_data *cdata;
540 struct snd_soc_tplg_bytes_control *control =
541 container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
542 struct soc_bytes_ext *sbe = (struct soc_bytes_ext *)kc->private_value;
543 int max_size = sbe->max;
545 if (le32_to_cpu(control->priv.size) > max_size) {
546 dev_err(sdev->dev, "err: bytes data size %d exceeds max %d.\n",
547 control->priv.size, max_size);
551 /* init the get/put bytes data */
552 scontrol->size = sizeof(struct sof_ipc_ctrl_data) +
553 le32_to_cpu(control->priv.size);
554 scontrol->control_data = kzalloc(max_size, GFP_KERNEL);
555 cdata = scontrol->control_data;
556 if (!scontrol->control_data)
559 scontrol->comp_id = sdev->next_comp_id;
560 scontrol->cmd = SOF_CTRL_CMD_BINARY;
562 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d\n",
563 scontrol->comp_id, scontrol->num_channels);
565 if (le32_to_cpu(control->priv.size) > 0) {
566 memcpy(cdata->data, control->priv.data,
567 le32_to_cpu(control->priv.size));
569 if (cdata->data->magic != SOF_ABI_MAGIC) {
570 dev_err(sdev->dev, "error: Wrong ABI magic 0x%08x.\n",
574 if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION,
577 "error: Incompatible ABI version 0x%08x.\n",
581 if (cdata->data->size + sizeof(const struct sof_abi_hdr) !=
582 le32_to_cpu(control->priv.size)) {
584 "error: Conflict in bytes vs. priv size.\n");
592 * Topology Token Parsing.
593 * New tokens should be added to headers and parsing tables below.
596 struct sof_topology_token {
599 int (*get_token)(void *elem, void *object, u32 offset, u32 size);
604 static int get_token_u32(void *elem, void *object, u32 offset, u32 size)
606 struct snd_soc_tplg_vendor_value_elem *velem = elem;
607 u32 *val = (u32 *)((u8 *)object + offset);
609 *val = le32_to_cpu(velem->value);
613 static int get_token_u16(void *elem, void *object, u32 offset, u32 size)
615 struct snd_soc_tplg_vendor_value_elem *velem = elem;
616 u16 *val = (u16 *)((u8 *)object + offset);
618 *val = (u16)le32_to_cpu(velem->value);
622 static int get_token_comp_format(void *elem, void *object, u32 offset, u32 size)
624 struct snd_soc_tplg_vendor_string_elem *velem = elem;
625 u32 *val = (u32 *)((u8 *)object + offset);
627 *val = find_format(velem->string);
631 static int get_token_dai_type(void *elem, void *object, u32 offset, u32 size)
633 struct snd_soc_tplg_vendor_string_elem *velem = elem;
634 u32 *val = (u32 *)((u8 *)object + offset);
636 *val = find_dai(velem->string);
640 static int get_token_process_type(void *elem, void *object, u32 offset,
643 struct snd_soc_tplg_vendor_string_elem *velem = elem;
644 u32 *val = (u32 *)((u8 *)object + offset);
646 *val = find_process(velem->string);
651 static const struct sof_topology_token buffer_tokens[] = {
652 {SOF_TKN_BUF_SIZE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
653 offsetof(struct sof_ipc_buffer, size), 0},
654 {SOF_TKN_BUF_CAPS, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
655 offsetof(struct sof_ipc_buffer, caps), 0},
659 static const struct sof_topology_token dai_tokens[] = {
660 {SOF_TKN_DAI_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_dai_type,
661 offsetof(struct sof_ipc_comp_dai, type), 0},
662 {SOF_TKN_DAI_INDEX, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
663 offsetof(struct sof_ipc_comp_dai, dai_index), 0},
664 {SOF_TKN_DAI_DIRECTION, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
665 offsetof(struct sof_ipc_comp_dai, direction), 0},
669 static const struct sof_topology_token dai_link_tokens[] = {
670 {SOF_TKN_DAI_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_dai_type,
671 offsetof(struct sof_ipc_dai_config, type), 0},
672 {SOF_TKN_DAI_INDEX, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
673 offsetof(struct sof_ipc_dai_config, dai_index), 0},
677 static const struct sof_topology_token sched_tokens[] = {
678 {SOF_TKN_SCHED_PERIOD, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
679 offsetof(struct sof_ipc_pipe_new, period), 0},
680 {SOF_TKN_SCHED_PRIORITY, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
681 offsetof(struct sof_ipc_pipe_new, priority), 0},
682 {SOF_TKN_SCHED_MIPS, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
683 offsetof(struct sof_ipc_pipe_new, period_mips), 0},
684 {SOF_TKN_SCHED_CORE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
685 offsetof(struct sof_ipc_pipe_new, core), 0},
686 {SOF_TKN_SCHED_FRAMES, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
687 offsetof(struct sof_ipc_pipe_new, frames_per_sched), 0},
688 {SOF_TKN_SCHED_TIME_DOMAIN, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
689 offsetof(struct sof_ipc_pipe_new, time_domain), 0},
693 static const struct sof_topology_token volume_tokens[] = {
694 {SOF_TKN_VOLUME_RAMP_STEP_TYPE, SND_SOC_TPLG_TUPLE_TYPE_WORD,
695 get_token_u32, offsetof(struct sof_ipc_comp_volume, ramp), 0},
696 {SOF_TKN_VOLUME_RAMP_STEP_MS,
697 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
698 offsetof(struct sof_ipc_comp_volume, initial_ramp), 0},
702 static const struct sof_topology_token src_tokens[] = {
703 {SOF_TKN_SRC_RATE_IN, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
704 offsetof(struct sof_ipc_comp_src, source_rate), 0},
705 {SOF_TKN_SRC_RATE_OUT, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
706 offsetof(struct sof_ipc_comp_src, sink_rate), 0},
710 static const struct sof_topology_token tone_tokens[] = {
714 static const struct sof_topology_token process_tokens[] = {
715 {SOF_TKN_PROCESS_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING,
716 get_token_process_type,
717 offsetof(struct sof_ipc_comp_process, type), 0},
721 static const struct sof_topology_token pcm_tokens[] = {
722 {SOF_TKN_PCM_DMAC_CONFIG, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
723 offsetof(struct sof_ipc_comp_host, dmac_config), 0},
726 /* Generic components */
727 static const struct sof_topology_token comp_tokens[] = {
728 {SOF_TKN_COMP_PERIOD_SINK_COUNT,
729 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
730 offsetof(struct sof_ipc_comp_config, periods_sink), 0},
731 {SOF_TKN_COMP_PERIOD_SOURCE_COUNT,
732 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
733 offsetof(struct sof_ipc_comp_config, periods_source), 0},
734 {SOF_TKN_COMP_FORMAT,
735 SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_comp_format,
736 offsetof(struct sof_ipc_comp_config, frame_fmt), 0},
740 static const struct sof_topology_token ssp_tokens[] = {
741 {SOF_TKN_INTEL_SSP_CLKS_CONTROL,
742 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
743 offsetof(struct sof_ipc_dai_ssp_params, clks_control), 0},
744 {SOF_TKN_INTEL_SSP_MCLK_ID,
745 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
746 offsetof(struct sof_ipc_dai_ssp_params, mclk_id), 0},
747 {SOF_TKN_INTEL_SSP_SAMPLE_BITS, SND_SOC_TPLG_TUPLE_TYPE_WORD,
749 offsetof(struct sof_ipc_dai_ssp_params, sample_valid_bits), 0},
750 {SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH, SND_SOC_TPLG_TUPLE_TYPE_SHORT,
752 offsetof(struct sof_ipc_dai_ssp_params, frame_pulse_width), 0},
753 {SOF_TKN_INTEL_SSP_QUIRKS, SND_SOC_TPLG_TUPLE_TYPE_WORD,
755 offsetof(struct sof_ipc_dai_ssp_params, quirks), 0},
756 {SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT, SND_SOC_TPLG_TUPLE_TYPE_BOOL,
758 offsetof(struct sof_ipc_dai_ssp_params,
759 tdm_per_slot_padding_flag), 0},
760 {SOF_TKN_INTEL_SSP_BCLK_DELAY, SND_SOC_TPLG_TUPLE_TYPE_WORD,
762 offsetof(struct sof_ipc_dai_ssp_params, bclk_delay), 0},
767 static const struct sof_topology_token dmic_tokens[] = {
768 {SOF_TKN_INTEL_DMIC_DRIVER_VERSION,
769 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
770 offsetof(struct sof_ipc_dai_dmic_params, driver_ipc_version),
772 {SOF_TKN_INTEL_DMIC_CLK_MIN,
773 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
774 offsetof(struct sof_ipc_dai_dmic_params, pdmclk_min), 0},
775 {SOF_TKN_INTEL_DMIC_CLK_MAX,
776 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
777 offsetof(struct sof_ipc_dai_dmic_params, pdmclk_max), 0},
778 {SOF_TKN_INTEL_DMIC_SAMPLE_RATE,
779 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
780 offsetof(struct sof_ipc_dai_dmic_params, fifo_fs), 0},
781 {SOF_TKN_INTEL_DMIC_DUTY_MIN,
782 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
783 offsetof(struct sof_ipc_dai_dmic_params, duty_min), 0},
784 {SOF_TKN_INTEL_DMIC_DUTY_MAX,
785 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
786 offsetof(struct sof_ipc_dai_dmic_params, duty_max), 0},
787 {SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE,
788 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
789 offsetof(struct sof_ipc_dai_dmic_params,
791 {SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH,
792 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
793 offsetof(struct sof_ipc_dai_dmic_params, fifo_bits), 0},
794 {SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS,
795 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
796 offsetof(struct sof_ipc_dai_dmic_params, unmute_ramp_time), 0},
802 * SOF_TKN_INTEL_DMIC_PDM_CTRL_ID should be the first token
803 * as it increments the index while parsing the array of pdm tokens
804 * and determines the correct offset
806 static const struct sof_topology_token dmic_pdm_tokens[] = {
807 {SOF_TKN_INTEL_DMIC_PDM_CTRL_ID,
808 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
809 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, id),
811 {SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable,
812 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
813 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, enable_mic_a),
815 {SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable,
816 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
817 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, enable_mic_b),
819 {SOF_TKN_INTEL_DMIC_PDM_POLARITY_A,
820 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
821 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, polarity_mic_a),
823 {SOF_TKN_INTEL_DMIC_PDM_POLARITY_B,
824 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
825 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, polarity_mic_b),
827 {SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE,
828 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
829 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, clk_edge),
831 {SOF_TKN_INTEL_DMIC_PDM_SKEW,
832 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
833 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, skew),
838 static const struct sof_topology_token hda_tokens[] = {
841 static void sof_parse_uuid_tokens(struct snd_soc_component *scomp,
843 const struct sof_topology_token *tokens,
845 struct snd_soc_tplg_vendor_array *array)
847 struct snd_soc_tplg_vendor_uuid_elem *elem;
850 /* parse element by element */
851 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
852 elem = &array->uuid[i];
854 /* search for token */
855 for (j = 0; j < count; j++) {
856 /* match token type */
857 if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_UUID)
861 if (tokens[j].token != le32_to_cpu(elem->token))
864 /* matched - now load token */
865 tokens[j].get_token(elem, object, tokens[j].offset,
871 static void sof_parse_string_tokens(struct snd_soc_component *scomp,
873 const struct sof_topology_token *tokens,
875 struct snd_soc_tplg_vendor_array *array)
877 struct snd_soc_tplg_vendor_string_elem *elem;
880 /* parse element by element */
881 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
882 elem = &array->string[i];
884 /* search for token */
885 for (j = 0; j < count; j++) {
886 /* match token type */
887 if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_STRING)
891 if (tokens[j].token != le32_to_cpu(elem->token))
894 /* matched - now load token */
895 tokens[j].get_token(elem, object, tokens[j].offset,
901 static void sof_parse_word_tokens(struct snd_soc_component *scomp,
903 const struct sof_topology_token *tokens,
905 struct snd_soc_tplg_vendor_array *array)
907 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
908 struct snd_soc_tplg_vendor_value_elem *elem;
909 size_t size = sizeof(struct sof_ipc_dai_dmic_pdm_ctrl);
914 /* parse element by element */
915 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
916 elem = &array->value[i];
918 /* search for token */
919 for (j = 0; j < count; j++) {
920 /* match token type */
921 if (!(tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_WORD ||
922 tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_SHORT))
926 if (tokens[j].token != le32_to_cpu(elem->token))
929 /* pdm config array index */
931 index = sdev->private;
933 /* matched - determine offset */
934 switch (tokens[j].token) {
935 case SOF_TKN_INTEL_DMIC_PDM_CTRL_ID:
937 /* inc number of pdm array index */
941 case SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable:
942 case SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable:
943 case SOF_TKN_INTEL_DMIC_PDM_POLARITY_A:
944 case SOF_TKN_INTEL_DMIC_PDM_POLARITY_B:
945 case SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE:
946 case SOF_TKN_INTEL_DMIC_PDM_SKEW:
948 /* check if array index is valid */
949 if (!index || *index == 0) {
951 "error: invalid array offset\n");
954 /* offset within the pdm config array */
955 offset = size * (*index - 1);
964 tokens[j].get_token(elem, object,
965 offset + tokens[j].offset,
971 static int sof_parse_tokens(struct snd_soc_component *scomp,
973 const struct sof_topology_token *tokens,
975 struct snd_soc_tplg_vendor_array *array,
978 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
981 while (priv_size > 0) {
982 asize = le32_to_cpu(array->size);
985 if (asize < 0) { /* FIXME: A zero-size array makes no sense */
986 dev_err(sdev->dev, "error: invalid array size 0x%x\n",
991 /* make sure there is enough data before parsing */
994 dev_err(sdev->dev, "error: invalid array size 0x%x\n",
999 /* call correct parser depending on type */
1000 switch (le32_to_cpu(array->type)) {
1001 case SND_SOC_TPLG_TUPLE_TYPE_UUID:
1002 sof_parse_uuid_tokens(scomp, object, tokens, count,
1005 case SND_SOC_TPLG_TUPLE_TYPE_STRING:
1006 sof_parse_string_tokens(scomp, object, tokens, count,
1009 case SND_SOC_TPLG_TUPLE_TYPE_BOOL:
1010 case SND_SOC_TPLG_TUPLE_TYPE_BYTE:
1011 case SND_SOC_TPLG_TUPLE_TYPE_WORD:
1012 case SND_SOC_TPLG_TUPLE_TYPE_SHORT:
1013 sof_parse_word_tokens(scomp, object, tokens, count,
1017 dev_err(sdev->dev, "error: unknown token type %d\n",
1023 array = (struct snd_soc_tplg_vendor_array *)((u8 *)array
1029 static void sof_dbg_comp_config(struct snd_soc_component *scomp,
1030 struct sof_ipc_comp_config *config)
1032 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1034 dev_dbg(sdev->dev, " config: periods snk %d src %d fmt %d\n",
1035 config->periods_sink, config->periods_source,
1039 /* external kcontrol init - used for any driver specific init */
1040 static int sof_control_load(struct snd_soc_component *scomp, int index,
1041 struct snd_kcontrol_new *kc,
1042 struct snd_soc_tplg_ctl_hdr *hdr)
1044 struct soc_mixer_control *sm;
1045 struct soc_bytes_ext *sbe;
1046 struct soc_enum *se;
1047 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1048 struct snd_soc_dobj *dobj;
1049 struct snd_sof_control *scontrol;
1052 dev_dbg(sdev->dev, "tplg: load control type %d name : %s\n",
1053 hdr->type, hdr->name);
1055 scontrol = kzalloc(sizeof(*scontrol), GFP_KERNEL);
1059 scontrol->sdev = sdev;
1061 switch (le32_to_cpu(hdr->ops.info)) {
1062 case SND_SOC_TPLG_CTL_VOLSW:
1063 case SND_SOC_TPLG_CTL_VOLSW_SX:
1064 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1065 sm = (struct soc_mixer_control *)kc->private_value;
1067 ret = sof_control_load_volume(scomp, scontrol, kc, hdr);
1069 case SND_SOC_TPLG_CTL_BYTES:
1070 sbe = (struct soc_bytes_ext *)kc->private_value;
1072 ret = sof_control_load_bytes(scomp, scontrol, kc, hdr);
1074 case SND_SOC_TPLG_CTL_ENUM:
1075 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1076 se = (struct soc_enum *)kc->private_value;
1078 ret = sof_control_load_enum(scomp, scontrol, kc, hdr);
1080 case SND_SOC_TPLG_CTL_RANGE:
1081 case SND_SOC_TPLG_CTL_STROBE:
1082 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1083 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1084 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1085 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1086 case SND_SOC_TPLG_DAPM_CTL_PIN:
1088 dev_warn(sdev->dev, "control type not supported %d:%d:%d\n",
1089 hdr->ops.get, hdr->ops.put, hdr->ops.info);
1094 dobj->private = scontrol;
1095 list_add(&scontrol->list, &sdev->kcontrol_list);
1099 static int sof_control_unload(struct snd_soc_component *scomp,
1100 struct snd_soc_dobj *dobj)
1102 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1103 struct sof_ipc_free fcomp;
1104 struct snd_sof_control *scontrol = dobj->private;
1106 dev_dbg(sdev->dev, "tplg: unload control name : %s\n", scomp->name);
1108 fcomp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_FREE;
1109 fcomp.hdr.size = sizeof(fcomp);
1110 fcomp.id = scontrol->comp_id;
1112 kfree(scontrol->control_data);
1113 list_del(&scontrol->list);
1115 /* send IPC to the DSP */
1116 return sof_ipc_tx_message(sdev->ipc,
1117 fcomp.hdr.cmd, &fcomp, sizeof(fcomp),
1125 static int sof_connect_dai_widget(struct snd_soc_component *scomp,
1126 struct snd_soc_dapm_widget *w,
1127 struct snd_soc_tplg_dapm_widget *tw,
1128 struct snd_sof_dai *dai)
1130 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1131 struct snd_soc_card *card = scomp->card;
1132 struct snd_soc_pcm_runtime *rtd;
1134 list_for_each_entry(rtd, &card->rtd_list, list) {
1135 dev_vdbg(sdev->dev, "tplg: check widget: %s stream: %s dai stream: %s\n",
1136 w->name, w->sname, rtd->dai_link->stream_name);
1138 if (!w->sname || !rtd->dai_link->stream_name)
1141 /* does stream match DAI link ? */
1142 if (strcmp(w->sname, rtd->dai_link->stream_name))
1146 case snd_soc_dapm_dai_out:
1147 rtd->cpu_dai->capture_widget = w;
1148 dai->name = rtd->dai_link->name;
1149 dev_dbg(sdev->dev, "tplg: connected widget %s -> DAI link %s\n",
1150 w->name, rtd->dai_link->name);
1152 case snd_soc_dapm_dai_in:
1153 rtd->cpu_dai->playback_widget = w;
1154 dai->name = rtd->dai_link->name;
1155 dev_dbg(sdev->dev, "tplg: connected widget %s -> DAI link %s\n",
1156 w->name, rtd->dai_link->name);
1163 /* check we have a connection */
1165 dev_err(sdev->dev, "error: can't connect DAI %s stream %s\n",
1173 static int sof_widget_load_dai(struct snd_soc_component *scomp, int index,
1174 struct snd_sof_widget *swidget,
1175 struct snd_soc_tplg_dapm_widget *tw,
1176 struct sof_ipc_comp_reply *r,
1177 struct snd_sof_dai *dai)
1179 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1180 struct snd_soc_tplg_private *private = &tw->priv;
1181 struct sof_ipc_comp_dai comp_dai;
1184 /* configure dai IPC message */
1185 memset(&comp_dai, 0, sizeof(comp_dai));
1186 comp_dai.comp.hdr.size = sizeof(comp_dai);
1187 comp_dai.comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1188 comp_dai.comp.id = swidget->comp_id;
1189 comp_dai.comp.type = SOF_COMP_DAI;
1190 comp_dai.comp.pipeline_id = index;
1191 comp_dai.config.hdr.size = sizeof(comp_dai.config);
1193 ret = sof_parse_tokens(scomp, &comp_dai, dai_tokens,
1194 ARRAY_SIZE(dai_tokens), private->array,
1195 le32_to_cpu(private->size));
1197 dev_err(sdev->dev, "error: parse dai tokens failed %d\n",
1198 le32_to_cpu(private->size));
1202 ret = sof_parse_tokens(scomp, &comp_dai.config, comp_tokens,
1203 ARRAY_SIZE(comp_tokens), private->array,
1204 le32_to_cpu(private->size));
1206 dev_err(sdev->dev, "error: parse dai.cfg tokens failed %d\n",
1211 dev_dbg(sdev->dev, "dai %s: type %d index %d\n",
1212 swidget->widget->name, comp_dai.type, comp_dai.dai_index);
1213 sof_dbg_comp_config(scomp, &comp_dai.config);
1215 ret = sof_ipc_tx_message(sdev->ipc, comp_dai.comp.hdr.cmd,
1216 &comp_dai, sizeof(comp_dai), r, sizeof(*r));
1218 if (ret == 0 && dai) {
1220 memcpy(&dai->comp_dai, &comp_dai, sizeof(comp_dai));
1230 static int sof_widget_load_buffer(struct snd_soc_component *scomp, int index,
1231 struct snd_sof_widget *swidget,
1232 struct snd_soc_tplg_dapm_widget *tw,
1233 struct sof_ipc_comp_reply *r)
1235 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1236 struct snd_soc_tplg_private *private = &tw->priv;
1237 struct sof_ipc_buffer *buffer;
1240 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
1244 /* configure dai IPC message */
1245 buffer->comp.hdr.size = sizeof(*buffer);
1246 buffer->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_BUFFER_NEW;
1247 buffer->comp.id = swidget->comp_id;
1248 buffer->comp.type = SOF_COMP_BUFFER;
1249 buffer->comp.pipeline_id = index;
1251 ret = sof_parse_tokens(scomp, buffer, buffer_tokens,
1252 ARRAY_SIZE(buffer_tokens), private->array,
1253 le32_to_cpu(private->size));
1255 dev_err(sdev->dev, "error: parse buffer tokens failed %d\n",
1261 dev_dbg(sdev->dev, "buffer %s: size %d caps 0x%x\n",
1262 swidget->widget->name, buffer->size, buffer->caps);
1264 swidget->private = buffer;
1266 ret = sof_ipc_tx_message(sdev->ipc, buffer->comp.hdr.cmd, buffer,
1267 sizeof(*buffer), r, sizeof(*r));
1269 dev_err(sdev->dev, "error: buffer %s load failed\n",
1270 swidget->widget->name);
1277 /* bind PCM ID to host component ID */
1278 static int spcm_bind(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
1281 struct snd_sof_widget *host_widget;
1283 host_widget = snd_sof_find_swidget_sname(sdev,
1284 spcm->pcm.caps[dir].name,
1287 dev_err(sdev->dev, "can't find host comp to bind pcm\n");
1291 spcm->stream[dir].comp_id = host_widget->comp_id;
1300 static int sof_widget_load_pcm(struct snd_soc_component *scomp, int index,
1301 struct snd_sof_widget *swidget,
1302 enum sof_ipc_stream_direction dir,
1303 struct snd_soc_tplg_dapm_widget *tw,
1304 struct sof_ipc_comp_reply *r)
1306 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1307 struct snd_soc_tplg_private *private = &tw->priv;
1308 struct sof_ipc_comp_host *host;
1311 host = kzalloc(sizeof(*host), GFP_KERNEL);
1315 /* configure host comp IPC message */
1316 host->comp.hdr.size = sizeof(*host);
1317 host->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1318 host->comp.id = swidget->comp_id;
1319 host->comp.type = SOF_COMP_HOST;
1320 host->comp.pipeline_id = index;
1321 host->direction = dir;
1322 host->config.hdr.size = sizeof(host->config);
1324 ret = sof_parse_tokens(scomp, host, pcm_tokens,
1325 ARRAY_SIZE(pcm_tokens), private->array,
1326 le32_to_cpu(private->size));
1328 dev_err(sdev->dev, "error: parse host tokens failed %d\n",
1333 ret = sof_parse_tokens(scomp, &host->config, comp_tokens,
1334 ARRAY_SIZE(comp_tokens), private->array,
1335 le32_to_cpu(private->size));
1337 dev_err(sdev->dev, "error: parse host.cfg tokens failed %d\n",
1338 le32_to_cpu(private->size));
1342 dev_dbg(sdev->dev, "loaded host %s\n", swidget->widget->name);
1343 sof_dbg_comp_config(scomp, &host->config);
1345 swidget->private = host;
1347 ret = sof_ipc_tx_message(sdev->ipc, host->comp.hdr.cmd, host,
1348 sizeof(*host), r, sizeof(*r));
1359 int sof_load_pipeline_ipc(struct snd_sof_dev *sdev,
1360 struct sof_ipc_pipe_new *pipeline,
1361 struct sof_ipc_comp_reply *r)
1363 struct sof_ipc_pm_core_config pm_core_config;
1366 ret = sof_ipc_tx_message(sdev->ipc, pipeline->hdr.cmd, pipeline,
1367 sizeof(*pipeline), r, sizeof(*r));
1369 dev_err(sdev->dev, "error: load pipeline ipc failure\n");
1373 /* power up the core that this pipeline is scheduled on */
1374 ret = snd_sof_dsp_core_power_up(sdev, 1 << pipeline->core);
1376 dev_err(sdev->dev, "error: powering up pipeline schedule core %d\n",
1381 /* update enabled cores mask */
1382 sdev->enabled_cores_mask |= 1 << pipeline->core;
1385 * Now notify DSP that the core that this pipeline is scheduled on
1386 * has been powered up
1388 memset(&pm_core_config, 0, sizeof(pm_core_config));
1389 pm_core_config.enable_mask = sdev->enabled_cores_mask;
1391 /* configure CORE_ENABLE ipc message */
1392 pm_core_config.hdr.size = sizeof(pm_core_config);
1393 pm_core_config.hdr.cmd = SOF_IPC_GLB_PM_MSG | SOF_IPC_PM_CORE_ENABLE;
1396 ret = sof_ipc_tx_message(sdev->ipc, pm_core_config.hdr.cmd,
1397 &pm_core_config, sizeof(pm_core_config),
1398 &pm_core_config, sizeof(pm_core_config));
1400 dev_err(sdev->dev, "error: core enable ipc failure\n");
1405 static int sof_widget_load_pipeline(struct snd_soc_component *scomp,
1406 int index, struct snd_sof_widget *swidget,
1407 struct snd_soc_tplg_dapm_widget *tw,
1408 struct sof_ipc_comp_reply *r)
1410 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1411 struct snd_soc_tplg_private *private = &tw->priv;
1412 struct sof_ipc_pipe_new *pipeline;
1413 struct snd_sof_widget *comp_swidget;
1416 pipeline = kzalloc(sizeof(*pipeline), GFP_KERNEL);
1420 /* configure dai IPC message */
1421 pipeline->hdr.size = sizeof(*pipeline);
1422 pipeline->hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_PIPE_NEW;
1423 pipeline->pipeline_id = index;
1424 pipeline->comp_id = swidget->comp_id;
1426 /* component at start of pipeline is our stream id */
1427 comp_swidget = snd_sof_find_swidget(sdev, tw->sname);
1428 if (!comp_swidget) {
1429 dev_err(sdev->dev, "error: widget %s refers to non existent widget %s\n",
1430 tw->name, tw->sname);
1435 pipeline->sched_id = comp_swidget->comp_id;
1437 dev_dbg(sdev->dev, "tplg: pipeline id %d comp %d scheduling comp id %d\n",
1438 pipeline->pipeline_id, pipeline->comp_id, pipeline->sched_id);
1440 ret = sof_parse_tokens(scomp, pipeline, sched_tokens,
1441 ARRAY_SIZE(sched_tokens), private->array,
1442 le32_to_cpu(private->size));
1444 dev_err(sdev->dev, "error: parse pipeline tokens failed %d\n",
1449 dev_dbg(sdev->dev, "pipeline %s: period %d pri %d mips %d core %d frames %d\n",
1450 swidget->widget->name, pipeline->period, pipeline->priority,
1451 pipeline->period_mips, pipeline->core, pipeline->frames_per_sched);
1453 swidget->private = pipeline;
1455 /* send ipc's to create pipeline comp and power up schedule core */
1456 ret = sof_load_pipeline_ipc(sdev, pipeline, r);
1468 static int sof_widget_load_mixer(struct snd_soc_component *scomp, int index,
1469 struct snd_sof_widget *swidget,
1470 struct snd_soc_tplg_dapm_widget *tw,
1471 struct sof_ipc_comp_reply *r)
1473 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1474 struct snd_soc_tplg_private *private = &tw->priv;
1475 struct sof_ipc_comp_mixer *mixer;
1478 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
1482 /* configure mixer IPC message */
1483 mixer->comp.hdr.size = sizeof(*mixer);
1484 mixer->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1485 mixer->comp.id = swidget->comp_id;
1486 mixer->comp.type = SOF_COMP_MIXER;
1487 mixer->comp.pipeline_id = index;
1488 mixer->config.hdr.size = sizeof(mixer->config);
1490 ret = sof_parse_tokens(scomp, &mixer->config, comp_tokens,
1491 ARRAY_SIZE(comp_tokens), private->array,
1492 le32_to_cpu(private->size));
1494 dev_err(sdev->dev, "error: parse mixer.cfg tokens failed %d\n",
1500 sof_dbg_comp_config(scomp, &mixer->config);
1502 swidget->private = mixer;
1504 ret = sof_ipc_tx_message(sdev->ipc, mixer->comp.hdr.cmd, mixer,
1505 sizeof(*mixer), r, sizeof(*r));
1515 static int sof_widget_load_mux(struct snd_soc_component *scomp, int index,
1516 struct snd_sof_widget *swidget,
1517 struct snd_soc_tplg_dapm_widget *tw,
1518 struct sof_ipc_comp_reply *r)
1520 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1521 struct snd_soc_tplg_private *private = &tw->priv;
1522 struct sof_ipc_comp_mux *mux;
1525 mux = kzalloc(sizeof(*mux), GFP_KERNEL);
1529 /* configure mux IPC message */
1530 mux->comp.hdr.size = sizeof(*mux);
1531 mux->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1532 mux->comp.id = swidget->comp_id;
1533 mux->comp.type = SOF_COMP_MUX;
1534 mux->comp.pipeline_id = index;
1535 mux->config.hdr.size = sizeof(mux->config);
1537 ret = sof_parse_tokens(scomp, &mux->config, comp_tokens,
1538 ARRAY_SIZE(comp_tokens), private->array,
1539 le32_to_cpu(private->size));
1541 dev_err(sdev->dev, "error: parse mux.cfg tokens failed %d\n",
1547 sof_dbg_comp_config(scomp, &mux->config);
1549 swidget->private = mux;
1551 ret = sof_ipc_tx_message(sdev->ipc, mux->comp.hdr.cmd, mux,
1552 sizeof(*mux), r, sizeof(*r));
1563 static int sof_widget_load_pga(struct snd_soc_component *scomp, int index,
1564 struct snd_sof_widget *swidget,
1565 struct snd_soc_tplg_dapm_widget *tw,
1566 struct sof_ipc_comp_reply *r)
1568 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1569 struct snd_soc_tplg_private *private = &tw->priv;
1570 struct sof_ipc_comp_volume *volume;
1571 struct snd_sof_control *scontrol;
1576 volume = kzalloc(sizeof(*volume), GFP_KERNEL);
1580 if (le32_to_cpu(tw->num_kcontrols) != 1) {
1581 dev_err(sdev->dev, "error: invalid kcontrol count %d for volume\n",
1587 /* configure volume IPC message */
1588 volume->comp.hdr.size = sizeof(*volume);
1589 volume->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1590 volume->comp.id = swidget->comp_id;
1591 volume->comp.type = SOF_COMP_VOLUME;
1592 volume->comp.pipeline_id = index;
1593 volume->config.hdr.size = sizeof(volume->config);
1595 ret = sof_parse_tokens(scomp, volume, volume_tokens,
1596 ARRAY_SIZE(volume_tokens), private->array,
1597 le32_to_cpu(private->size));
1599 dev_err(sdev->dev, "error: parse volume tokens failed %d\n",
1603 ret = sof_parse_tokens(scomp, &volume->config, comp_tokens,
1604 ARRAY_SIZE(comp_tokens), private->array,
1605 le32_to_cpu(private->size));
1607 dev_err(sdev->dev, "error: parse volume.cfg tokens failed %d\n",
1608 le32_to_cpu(private->size));
1612 sof_dbg_comp_config(scomp, &volume->config);
1614 swidget->private = volume;
1616 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
1617 if (scontrol->comp_id == swidget->comp_id) {
1618 min_step = scontrol->min_volume_step;
1619 max_step = scontrol->max_volume_step;
1620 volume->min_value = scontrol->volume_table[min_step];
1621 volume->max_value = scontrol->volume_table[max_step];
1622 volume->channels = scontrol->num_channels;
1627 ret = sof_ipc_tx_message(sdev->ipc, volume->comp.hdr.cmd, volume,
1628 sizeof(*volume), r, sizeof(*r));
1640 static int sof_widget_load_src(struct snd_soc_component *scomp, int index,
1641 struct snd_sof_widget *swidget,
1642 struct snd_soc_tplg_dapm_widget *tw,
1643 struct sof_ipc_comp_reply *r)
1645 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1646 struct snd_soc_tplg_private *private = &tw->priv;
1647 struct sof_ipc_comp_src *src;
1650 src = kzalloc(sizeof(*src), GFP_KERNEL);
1654 /* configure src IPC message */
1655 src->comp.hdr.size = sizeof(*src);
1656 src->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1657 src->comp.id = swidget->comp_id;
1658 src->comp.type = SOF_COMP_SRC;
1659 src->comp.pipeline_id = index;
1660 src->config.hdr.size = sizeof(src->config);
1662 ret = sof_parse_tokens(scomp, src, src_tokens,
1663 ARRAY_SIZE(src_tokens), private->array,
1664 le32_to_cpu(private->size));
1666 dev_err(sdev->dev, "error: parse src tokens failed %d\n",
1671 ret = sof_parse_tokens(scomp, &src->config, comp_tokens,
1672 ARRAY_SIZE(comp_tokens), private->array,
1673 le32_to_cpu(private->size));
1675 dev_err(sdev->dev, "error: parse src.cfg tokens failed %d\n",
1676 le32_to_cpu(private->size));
1680 dev_dbg(sdev->dev, "src %s: source rate %d sink rate %d\n",
1681 swidget->widget->name, src->source_rate, src->sink_rate);
1682 sof_dbg_comp_config(scomp, &src->config);
1684 swidget->private = src;
1686 ret = sof_ipc_tx_message(sdev->ipc, src->comp.hdr.cmd, src,
1687 sizeof(*src), r, sizeof(*r));
1696 * Signal Generator Topology
1699 static int sof_widget_load_siggen(struct snd_soc_component *scomp, int index,
1700 struct snd_sof_widget *swidget,
1701 struct snd_soc_tplg_dapm_widget *tw,
1702 struct sof_ipc_comp_reply *r)
1704 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1705 struct snd_soc_tplg_private *private = &tw->priv;
1706 struct sof_ipc_comp_tone *tone;
1709 tone = kzalloc(sizeof(*tone), GFP_KERNEL);
1713 /* configure siggen IPC message */
1714 tone->comp.hdr.size = sizeof(*tone);
1715 tone->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1716 tone->comp.id = swidget->comp_id;
1717 tone->comp.type = SOF_COMP_TONE;
1718 tone->comp.pipeline_id = index;
1719 tone->config.hdr.size = sizeof(tone->config);
1721 ret = sof_parse_tokens(scomp, tone, tone_tokens,
1722 ARRAY_SIZE(tone_tokens), private->array,
1723 le32_to_cpu(private->size));
1725 dev_err(sdev->dev, "error: parse tone tokens failed %d\n",
1726 le32_to_cpu(private->size));
1730 ret = sof_parse_tokens(scomp, &tone->config, comp_tokens,
1731 ARRAY_SIZE(comp_tokens), private->array,
1732 le32_to_cpu(private->size));
1734 dev_err(sdev->dev, "error: parse tone.cfg tokens failed %d\n",
1735 le32_to_cpu(private->size));
1739 dev_dbg(sdev->dev, "tone %s: frequency %d amplitude %d\n",
1740 swidget->widget->name, tone->frequency, tone->amplitude);
1741 sof_dbg_comp_config(scomp, &tone->config);
1743 swidget->private = tone;
1745 ret = sof_ipc_tx_message(sdev->ipc, tone->comp.hdr.cmd, tone,
1746 sizeof(*tone), r, sizeof(*r));
1754 static size_t sof_get_control_data(struct snd_sof_dev *sdev,
1755 struct snd_soc_dapm_widget *widget,
1756 struct sof_widget_data *wdata)
1758 const struct snd_kcontrol_new *kc;
1759 struct soc_mixer_control *sm;
1760 struct soc_bytes_ext *sbe;
1761 struct soc_enum *se;
1765 for (i = 0; i < widget->num_kcontrols; i++) {
1766 kc = &widget->kcontrol_news[i];
1768 switch (widget->dobj.widget.kcontrol_type) {
1769 case SND_SOC_TPLG_TYPE_MIXER:
1770 sm = (struct soc_mixer_control *)kc->private_value;
1771 wdata[i].control = sm->dobj.private;
1773 case SND_SOC_TPLG_TYPE_BYTES:
1774 sbe = (struct soc_bytes_ext *)kc->private_value;
1775 wdata[i].control = sbe->dobj.private;
1777 case SND_SOC_TPLG_TYPE_ENUM:
1778 se = (struct soc_enum *)kc->private_value;
1779 wdata[i].control = se->dobj.private;
1782 dev_err(sdev->dev, "error: unknown kcontrol type %d in widget %s\n",
1783 widget->dobj.widget.kcontrol_type,
1788 if (!wdata[i].control) {
1789 dev_err(sdev->dev, "error: no scontrol for widget %s\n",
1794 wdata[i].pdata = wdata[i].control->control_data->data;
1795 if (!wdata[i].pdata)
1798 /* make sure data is valid - data can be updated at runtime */
1799 if (wdata[i].pdata->magic != SOF_ABI_MAGIC)
1802 size += wdata[i].pdata->size;
1805 switch (wdata[i].control->cmd) {
1806 case SOF_CTRL_CMD_VOLUME:
1807 case SOF_CTRL_CMD_ENUM:
1808 case SOF_CTRL_CMD_SWITCH:
1809 wdata[i].ipc_cmd = SOF_IPC_COMP_SET_VALUE;
1810 wdata[i].ctrl_type = SOF_CTRL_TYPE_VALUE_CHAN_SET;
1812 case SOF_CTRL_CMD_BINARY:
1813 wdata[i].ipc_cmd = SOF_IPC_COMP_SET_DATA;
1814 wdata[i].ctrl_type = SOF_CTRL_TYPE_DATA_SET;
1824 static int sof_process_load(struct snd_soc_component *scomp, int index,
1825 struct snd_sof_widget *swidget,
1826 struct snd_soc_tplg_dapm_widget *tw,
1827 struct sof_ipc_comp_reply *r,
1830 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1831 struct snd_soc_dapm_widget *widget = swidget->widget;
1832 struct snd_soc_tplg_private *private = &tw->priv;
1833 struct sof_ipc_comp_process *process = NULL;
1834 struct sof_widget_data *wdata = NULL;
1835 size_t ipc_data_size = 0;
1841 if (type == SOF_COMP_NONE) {
1842 dev_err(sdev->dev, "error: invalid process comp type %d\n",
1847 /* allocate struct for widget control data sizes and types */
1848 if (widget->num_kcontrols) {
1849 wdata = kcalloc(widget->num_kcontrols,
1856 /* get possible component controls and get size of all pdata */
1857 ipc_data_size = sof_get_control_data(sdev, widget, wdata);
1859 if (ipc_data_size <= 0) {
1860 ret = ipc_data_size;
1865 ipc_size = sizeof(struct sof_ipc_comp_process) +
1866 le32_to_cpu(private->size) +
1869 /* we are exceeding max ipc size, config needs to be sent separately */
1870 if (ipc_size > SOF_IPC_MSG_MAX_SIZE) {
1871 ipc_size -= ipc_data_size;
1875 process = kzalloc(ipc_size, GFP_KERNEL);
1881 /* configure iir IPC message */
1882 process->comp.hdr.size = ipc_size;
1883 process->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1884 process->comp.id = swidget->comp_id;
1885 process->comp.type = type;
1886 process->comp.pipeline_id = index;
1887 process->config.hdr.size = sizeof(process->config);
1889 ret = sof_parse_tokens(scomp, &process->config, comp_tokens,
1890 ARRAY_SIZE(comp_tokens), private->array,
1891 le32_to_cpu(private->size));
1893 dev_err(sdev->dev, "error: parse process.cfg tokens failed %d\n",
1894 le32_to_cpu(private->size));
1898 sof_dbg_comp_config(scomp, &process->config);
1901 * found private data in control, so copy it.
1902 * get possible component controls - get size of all pdata,
1903 * then memcpy with headers
1905 if (ipc_data_size) {
1906 for (i = 0; i < widget->num_kcontrols; i++) {
1907 memcpy(&process->data + offset,
1908 wdata[i].pdata->data,
1909 wdata[i].pdata->size);
1910 offset += wdata[i].pdata->size;
1914 process->size = ipc_data_size;
1915 swidget->private = process;
1917 ret = sof_ipc_tx_message(sdev->ipc, process->comp.hdr.cmd, process,
1918 ipc_size, r, sizeof(*r));
1921 dev_err(sdev->dev, "error: create process failed\n");
1925 /* we sent the data in single message so return */
1929 /* send control data with large message supported method */
1930 for (i = 0; i < widget->num_kcontrols; i++) {
1931 wdata[i].control->readback_offset = 0;
1932 ret = snd_sof_ipc_set_get_comp_data(sdev->ipc, wdata[i].control,
1935 wdata[i].control->cmd,
1938 dev_err(sdev->dev, "error: send control failed\n");
1952 * Processing Component Topology - can be "effect", "codec", or general
1956 static int sof_widget_load_process(struct snd_soc_component *scomp, int index,
1957 struct snd_sof_widget *swidget,
1958 struct snd_soc_tplg_dapm_widget *tw,
1959 struct sof_ipc_comp_reply *r)
1961 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1962 struct snd_soc_tplg_private *private = &tw->priv;
1963 struct sof_ipc_comp_process config;
1966 /* check we have some tokens - we need at least process type */
1967 if (le32_to_cpu(private->size) == 0) {
1968 dev_err(sdev->dev, "error: process tokens not found\n");
1972 memset(&config, 0, sizeof(config));
1974 /* get the process token */
1975 ret = sof_parse_tokens(scomp, &config, process_tokens,
1976 ARRAY_SIZE(process_tokens), private->array,
1977 le32_to_cpu(private->size));
1979 dev_err(sdev->dev, "error: parse process tokens failed %d\n",
1980 le32_to_cpu(private->size));
1984 /* now load process specific data and send IPC */
1985 ret = sof_process_load(scomp, index, swidget, tw, r,
1986 find_process_comp_type(config.type));
1988 dev_err(sdev->dev, "error: process loading failed\n");
1995 static int sof_widget_bind_event(struct snd_sof_dev *sdev,
1996 struct snd_sof_widget *swidget,
1999 struct sof_ipc_comp *ipc_comp;
2001 /* validate widget event type */
2002 switch (event_type) {
2003 case SOF_KEYWORD_DETECT_DAPM_EVENT:
2004 /* only KEYWORD_DETECT comps should handle this */
2005 if (swidget->id != snd_soc_dapm_effect)
2008 ipc_comp = swidget->private;
2009 if (ipc_comp && ipc_comp->type != SOF_COMP_KEYWORD_DETECT)
2012 /* bind event to keyword detect comp */
2013 return snd_soc_tplg_widget_bind_event(swidget->widget,
2015 ARRAY_SIZE(sof_kwd_events),
2022 "error: invalid event type %d for widget %s\n",
2023 event_type, swidget->widget->name);
2027 /* external widget init - used for any driver specific init */
2028 static int sof_widget_ready(struct snd_soc_component *scomp, int index,
2029 struct snd_soc_dapm_widget *w,
2030 struct snd_soc_tplg_dapm_widget *tw)
2032 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2033 struct snd_sof_widget *swidget;
2034 struct snd_sof_dai *dai;
2035 struct sof_ipc_comp_reply reply;
2036 struct snd_sof_control *scontrol;
2039 swidget = kzalloc(sizeof(*swidget), GFP_KERNEL);
2043 swidget->sdev = sdev;
2044 swidget->widget = w;
2045 swidget->comp_id = sdev->next_comp_id++;
2046 swidget->complete = 0;
2047 swidget->id = w->id;
2048 swidget->pipeline_id = index;
2049 swidget->private = NULL;
2050 memset(&reply, 0, sizeof(reply));
2052 dev_dbg(sdev->dev, "tplg: ready widget id %d pipe %d type %d name : %s stream %s\n",
2053 swidget->comp_id, index, swidget->id, tw->name,
2054 strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
2055 ? tw->sname : "none");
2057 /* handle any special case widgets */
2059 case snd_soc_dapm_dai_in:
2060 case snd_soc_dapm_dai_out:
2061 dai = kzalloc(sizeof(*dai), GFP_KERNEL);
2067 ret = sof_widget_load_dai(scomp, index, swidget, tw, &reply,
2070 sof_connect_dai_widget(scomp, w, tw, dai);
2071 list_add(&dai->list, &sdev->dai_list);
2072 swidget->private = dai;
2077 case snd_soc_dapm_mixer:
2078 ret = sof_widget_load_mixer(scomp, index, swidget, tw, &reply);
2080 case snd_soc_dapm_pga:
2081 ret = sof_widget_load_pga(scomp, index, swidget, tw, &reply);
2082 /* Find scontrol for this pga and set readback offset*/
2083 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
2084 if (scontrol->comp_id == swidget->comp_id) {
2085 scontrol->readback_offset = reply.offset;
2090 case snd_soc_dapm_buffer:
2091 ret = sof_widget_load_buffer(scomp, index, swidget, tw, &reply);
2093 case snd_soc_dapm_scheduler:
2094 ret = sof_widget_load_pipeline(scomp, index, swidget, tw,
2097 case snd_soc_dapm_aif_out:
2098 ret = sof_widget_load_pcm(scomp, index, swidget,
2099 SOF_IPC_STREAM_CAPTURE, tw, &reply);
2101 case snd_soc_dapm_aif_in:
2102 ret = sof_widget_load_pcm(scomp, index, swidget,
2103 SOF_IPC_STREAM_PLAYBACK, tw, &reply);
2105 case snd_soc_dapm_src:
2106 ret = sof_widget_load_src(scomp, index, swidget, tw, &reply);
2108 case snd_soc_dapm_siggen:
2109 ret = sof_widget_load_siggen(scomp, index, swidget, tw, &reply);
2111 case snd_soc_dapm_effect:
2112 ret = sof_widget_load_process(scomp, index, swidget, tw,
2115 case snd_soc_dapm_mux:
2116 case snd_soc_dapm_demux:
2117 ret = sof_widget_load_mux(scomp, index, swidget, tw, &reply);
2119 case snd_soc_dapm_switch:
2120 case snd_soc_dapm_dai_link:
2121 case snd_soc_dapm_kcontrol:
2123 dev_warn(sdev->dev, "warning: widget type %d name %s not handled\n",
2124 swidget->id, tw->name);
2128 /* check IPC reply */
2129 if (ret < 0 || reply.rhdr.error < 0) {
2131 "error: DSP failed to add widget id %d type %d name : %s stream %s reply %d\n",
2132 tw->shift, swidget->id, tw->name,
2133 strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
2134 ? tw->sname : "none", reply.rhdr.error);
2139 /* bind widget to external event */
2140 if (tw->event_type) {
2141 ret = sof_widget_bind_event(sdev, swidget,
2142 le16_to_cpu(tw->event_type));
2144 dev_err(sdev->dev, "error: widget event binding failed\n");
2145 kfree(swidget->private);
2151 w->dobj.private = swidget;
2152 list_add(&swidget->list, &sdev->widget_list);
2156 static int sof_route_unload(struct snd_soc_component *scomp,
2157 struct snd_soc_dobj *dobj)
2159 struct snd_sof_route *sroute;
2161 sroute = dobj->private;
2165 /* free sroute and its private data */
2166 kfree(sroute->private);
2167 list_del(&sroute->list);
2173 static int sof_widget_unload(struct snd_soc_component *scomp,
2174 struct snd_soc_dobj *dobj)
2176 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2177 const struct snd_kcontrol_new *kc;
2178 struct snd_soc_dapm_widget *widget;
2179 struct sof_ipc_pipe_new *pipeline;
2180 struct snd_sof_control *scontrol;
2181 struct snd_sof_widget *swidget;
2182 struct soc_mixer_control *sm;
2183 struct soc_bytes_ext *sbe;
2184 struct snd_sof_dai *dai;
2185 struct soc_enum *se;
2189 swidget = dobj->private;
2193 widget = swidget->widget;
2195 switch (swidget->id) {
2196 case snd_soc_dapm_dai_in:
2197 case snd_soc_dapm_dai_out:
2198 dai = swidget->private;
2201 /* free dai config */
2202 kfree(dai->dai_config);
2203 list_del(&dai->list);
2206 case snd_soc_dapm_scheduler:
2208 /* power down the pipeline schedule core */
2209 pipeline = swidget->private;
2210 ret = snd_sof_dsp_core_power_down(sdev, 1 << pipeline->core);
2212 dev_err(sdev->dev, "error: powering down pipeline schedule core %d\n",
2215 /* update enabled cores mask */
2216 sdev->enabled_cores_mask &= ~(1 << pipeline->core);
2222 for (i = 0; i < widget->num_kcontrols; i++) {
2223 kc = &widget->kcontrol_news[i];
2224 switch (dobj->widget.kcontrol_type) {
2225 case SND_SOC_TPLG_TYPE_MIXER:
2226 sm = (struct soc_mixer_control *)kc->private_value;
2227 scontrol = sm->dobj.private;
2229 kfree(scontrol->volume_table);
2231 case SND_SOC_TPLG_TYPE_ENUM:
2232 se = (struct soc_enum *)kc->private_value;
2233 scontrol = se->dobj.private;
2235 case SND_SOC_TPLG_TYPE_BYTES:
2236 sbe = (struct soc_bytes_ext *)kc->private_value;
2237 scontrol = sbe->dobj.private;
2240 dev_warn(sdev->dev, "unsupported kcontrol_type\n");
2243 kfree(scontrol->control_data);
2244 list_del(&scontrol->list);
2249 /* free private value */
2250 kfree(swidget->private);
2252 /* remove and free swidget object */
2253 list_del(&swidget->list);
2260 * DAI HW configuration.
2263 /* FE DAI - used for any driver specific init */
2264 static int sof_dai_load(struct snd_soc_component *scomp, int index,
2265 struct snd_soc_dai_driver *dai_drv,
2266 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
2268 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2269 struct snd_soc_tplg_stream_caps *caps;
2270 struct snd_sof_pcm *spcm;
2271 int stream = SNDRV_PCM_STREAM_PLAYBACK;
2274 /* nothing to do for BEs atm */
2278 spcm = kzalloc(sizeof(*spcm), GFP_KERNEL);
2283 spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].comp_id = COMP_ID_UNASSIGNED;
2284 spcm->stream[SNDRV_PCM_STREAM_CAPTURE].comp_id = COMP_ID_UNASSIGNED;
2288 dev_dbg(sdev->dev, "tplg: load pcm %s\n", pcm->dai_name);
2290 dai_drv->dobj.private = spcm;
2291 list_add(&spcm->list, &sdev->pcm_list);
2293 /* do we need to allocate playback PCM DMA pages */
2294 if (!spcm->pcm.playback)
2297 caps = &spcm->pcm.caps[stream];
2299 /* allocate playback page table buffer */
2300 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
2301 PAGE_SIZE, &spcm->stream[stream].page_table);
2303 dev_err(sdev->dev, "error: can't alloc page table for %s %d\n",
2309 /* bind pcm to host comp */
2310 ret = spcm_bind(sdev, spcm, stream);
2313 "error: can't bind pcm to host\n");
2314 goto free_playback_tables;
2318 stream = SNDRV_PCM_STREAM_CAPTURE;
2320 /* do we need to allocate capture PCM DMA pages */
2321 if (!spcm->pcm.capture)
2324 caps = &spcm->pcm.caps[stream];
2326 /* allocate capture page table buffer */
2327 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
2328 PAGE_SIZE, &spcm->stream[stream].page_table);
2330 dev_err(sdev->dev, "error: can't alloc page table for %s %d\n",
2332 goto free_playback_tables;
2335 /* bind pcm to host comp */
2336 ret = spcm_bind(sdev, spcm, stream);
2339 "error: can't bind pcm to host\n");
2340 snd_dma_free_pages(&spcm->stream[stream].page_table);
2341 goto free_playback_tables;
2346 free_playback_tables:
2347 if (spcm->pcm.playback)
2348 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
2353 static int sof_dai_unload(struct snd_soc_component *scomp,
2354 struct snd_soc_dobj *dobj)
2356 struct snd_sof_pcm *spcm = dobj->private;
2358 /* free PCM DMA pages */
2359 if (spcm->pcm.playback)
2360 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
2362 if (spcm->pcm.capture)
2363 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_CAPTURE].page_table);
2365 /* remove from list and free spcm */
2366 list_del(&spcm->list);
2372 static void sof_dai_set_format(struct snd_soc_tplg_hw_config *hw_config,
2373 struct sof_ipc_dai_config *config)
2375 /* clock directions wrt codec */
2376 if (hw_config->bclk_master == SND_SOC_TPLG_BCLK_CM) {
2377 /* codec is bclk master */
2378 if (hw_config->fsync_master == SND_SOC_TPLG_FSYNC_CM)
2379 config->format |= SOF_DAI_FMT_CBM_CFM;
2381 config->format |= SOF_DAI_FMT_CBM_CFS;
2383 /* codec is bclk slave */
2384 if (hw_config->fsync_master == SND_SOC_TPLG_FSYNC_CM)
2385 config->format |= SOF_DAI_FMT_CBS_CFM;
2387 config->format |= SOF_DAI_FMT_CBS_CFS;
2390 /* inverted clocks ? */
2391 if (hw_config->invert_bclk) {
2392 if (hw_config->invert_fsync)
2393 config->format |= SOF_DAI_FMT_IB_IF;
2395 config->format |= SOF_DAI_FMT_IB_NF;
2397 if (hw_config->invert_fsync)
2398 config->format |= SOF_DAI_FMT_NB_IF;
2400 config->format |= SOF_DAI_FMT_NB_NF;
2404 /* set config for all DAI's with name matching the link name */
2405 static int sof_set_dai_config(struct snd_sof_dev *sdev, u32 size,
2406 struct snd_soc_dai_link *link,
2407 struct sof_ipc_dai_config *config)
2409 struct snd_sof_dai *dai;
2412 list_for_each_entry(dai, &sdev->dai_list, list) {
2416 if (strcmp(link->name, dai->name) == 0) {
2417 dai->dai_config = kmemdup(config, size, GFP_KERNEL);
2418 if (!dai->dai_config)
2421 /* set cpu_dai_name */
2422 dai->cpu_dai_name = link->cpus->dai_name;
2429 * machine driver may define a dai link with playback and capture
2430 * dai enabled, but the dai link in topology would support both, one
2431 * or none of them. Here print a warning message to notify user
2434 dev_warn(sdev->dev, "warning: failed to find dai for dai link %s",
2441 static int sof_link_ssp_load(struct snd_soc_component *scomp, int index,
2442 struct snd_soc_dai_link *link,
2443 struct snd_soc_tplg_link_config *cfg,
2444 struct snd_soc_tplg_hw_config *hw_config,
2445 struct sof_ipc_dai_config *config)
2447 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2448 struct snd_soc_tplg_private *private = &cfg->priv;
2449 struct sof_ipc_reply reply;
2450 u32 size = sizeof(*config);
2453 /* handle master/slave and inverted clocks */
2454 sof_dai_set_format(hw_config, config);
2457 memset(&config->ssp, 0, sizeof(struct sof_ipc_dai_ssp_params));
2458 config->hdr.size = size;
2460 ret = sof_parse_tokens(scomp, &config->ssp, ssp_tokens,
2461 ARRAY_SIZE(ssp_tokens), private->array,
2462 le32_to_cpu(private->size));
2464 dev_err(sdev->dev, "error: parse ssp tokens failed %d\n",
2465 le32_to_cpu(private->size));
2469 config->ssp.mclk_rate = le32_to_cpu(hw_config->mclk_rate);
2470 config->ssp.bclk_rate = le32_to_cpu(hw_config->bclk_rate);
2471 config->ssp.fsync_rate = le32_to_cpu(hw_config->fsync_rate);
2472 config->ssp.tdm_slots = le32_to_cpu(hw_config->tdm_slots);
2473 config->ssp.tdm_slot_width = le32_to_cpu(hw_config->tdm_slot_width);
2474 config->ssp.mclk_direction = hw_config->mclk_direction;
2475 config->ssp.rx_slots = le32_to_cpu(hw_config->rx_slots);
2476 config->ssp.tx_slots = le32_to_cpu(hw_config->tx_slots);
2478 dev_dbg(sdev->dev, "tplg: config SSP%d fmt 0x%x mclk %d bclk %d fclk %d width (%d)%d slots %d mclk id %d quirks %d\n",
2479 config->dai_index, config->format,
2480 config->ssp.mclk_rate, config->ssp.bclk_rate,
2481 config->ssp.fsync_rate, config->ssp.sample_valid_bits,
2482 config->ssp.tdm_slot_width, config->ssp.tdm_slots,
2483 config->ssp.mclk_id, config->ssp.quirks);
2485 /* validate SSP fsync rate and channel count */
2486 if (config->ssp.fsync_rate < 8000 || config->ssp.fsync_rate > 192000) {
2487 dev_err(sdev->dev, "error: invalid fsync rate for SSP%d\n",
2492 if (config->ssp.tdm_slots < 1 || config->ssp.tdm_slots > 8) {
2493 dev_err(sdev->dev, "error: invalid channel count for SSP%d\n",
2498 /* send message to DSP */
2499 ret = sof_ipc_tx_message(sdev->ipc,
2500 config->hdr.cmd, config, size, &reply,
2504 dev_err(sdev->dev, "error: failed to set DAI config for SSP%d\n",
2509 /* set config for all DAI's with name matching the link name */
2510 ret = sof_set_dai_config(sdev, size, link, config);
2512 dev_err(sdev->dev, "error: failed to save DAI config for SSP%d\n",
2518 static int sof_link_sai_load(struct snd_soc_component *scomp, int index,
2519 struct snd_soc_dai_link *link,
2520 struct snd_soc_tplg_link_config *cfg,
2521 struct snd_soc_tplg_hw_config *hw_config,
2522 struct sof_ipc_dai_config *config)
2524 /*TODO: Add implementation */
2528 static int sof_link_esai_load(struct snd_soc_component *scomp, int index,
2529 struct snd_soc_dai_link *link,
2530 struct snd_soc_tplg_link_config *cfg,
2531 struct snd_soc_tplg_hw_config *hw_config,
2532 struct sof_ipc_dai_config *config)
2534 /*TODO: Add implementation */
2538 static int sof_link_dmic_load(struct snd_soc_component *scomp, int index,
2539 struct snd_soc_dai_link *link,
2540 struct snd_soc_tplg_link_config *cfg,
2541 struct snd_soc_tplg_hw_config *hw_config,
2542 struct sof_ipc_dai_config *config)
2544 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2545 struct snd_soc_tplg_private *private = &cfg->priv;
2546 struct sof_ipc_dai_config *ipc_config;
2547 struct sof_ipc_reply reply;
2548 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
2549 struct sof_ipc_fw_version *v = &ready->version;
2554 * config is only used for the common params in dmic_params structure
2555 * that does not include the PDM controller config array
2556 * Set the common params to 0.
2558 memset(&config->dmic, 0, sizeof(struct sof_ipc_dai_dmic_params));
2560 /* get DMIC tokens */
2561 ret = sof_parse_tokens(scomp, &config->dmic, dmic_tokens,
2562 ARRAY_SIZE(dmic_tokens), private->array,
2563 le32_to_cpu(private->size));
2565 dev_err(sdev->dev, "error: parse dmic tokens failed %d\n",
2566 le32_to_cpu(private->size));
2571 * allocate memory for dmic dai config accounting for the
2572 * variable number of active pdm controllers
2573 * This will be the ipc payload for setting dai config
2575 size = sizeof(*config) + sizeof(struct sof_ipc_dai_dmic_pdm_ctrl) *
2576 config->dmic.num_pdm_active;
2578 ipc_config = kzalloc(size, GFP_KERNEL);
2582 /* copy the common dai config and dmic params */
2583 memcpy(ipc_config, config, sizeof(*config));
2586 * alloc memory for private member
2587 * Used to track the pdm config array index currently being parsed
2589 sdev->private = kzalloc(sizeof(u32), GFP_KERNEL);
2590 if (!sdev->private) {
2595 /* get DMIC PDM tokens */
2596 ret = sof_parse_tokens(scomp, &ipc_config->dmic.pdm[0], dmic_pdm_tokens,
2597 ARRAY_SIZE(dmic_pdm_tokens), private->array,
2598 le32_to_cpu(private->size));
2600 dev_err(sdev->dev, "error: parse dmic pdm tokens failed %d\n",
2601 le32_to_cpu(private->size));
2605 /* set IPC header size */
2606 ipc_config->hdr.size = size;
2608 /* debug messages */
2609 dev_dbg(sdev->dev, "tplg: config DMIC%d driver version %d\n",
2610 ipc_config->dai_index, ipc_config->dmic.driver_ipc_version);
2611 dev_dbg(sdev->dev, "pdmclk_min %d pdm_clkmax %d duty_min %hd\n",
2612 ipc_config->dmic.pdmclk_min, ipc_config->dmic.pdmclk_max,
2613 ipc_config->dmic.duty_min);
2614 dev_dbg(sdev->dev, "duty_max %hd fifo_fs %d num_pdms active %d\n",
2615 ipc_config->dmic.duty_max, ipc_config->dmic.fifo_fs,
2616 ipc_config->dmic.num_pdm_active);
2617 dev_dbg(sdev->dev, "fifo word length %hd\n",
2618 ipc_config->dmic.fifo_bits);
2620 for (j = 0; j < ipc_config->dmic.num_pdm_active; j++) {
2621 dev_dbg(sdev->dev, "pdm %hd mic a %hd mic b %hd\n",
2622 ipc_config->dmic.pdm[j].id,
2623 ipc_config->dmic.pdm[j].enable_mic_a,
2624 ipc_config->dmic.pdm[j].enable_mic_b);
2625 dev_dbg(sdev->dev, "pdm %hd polarity a %hd polarity b %hd\n",
2626 ipc_config->dmic.pdm[j].id,
2627 ipc_config->dmic.pdm[j].polarity_mic_a,
2628 ipc_config->dmic.pdm[j].polarity_mic_b);
2629 dev_dbg(sdev->dev, "pdm %hd clk_edge %hd skew %hd\n",
2630 ipc_config->dmic.pdm[j].id,
2631 ipc_config->dmic.pdm[j].clk_edge,
2632 ipc_config->dmic.pdm[j].skew);
2635 if (SOF_ABI_VER(v->major, v->minor, v->micro) < SOF_ABI_VER(3, 0, 1)) {
2636 /* this takes care of backwards compatible handling of fifo_bits_b */
2637 ipc_config->dmic.reserved_2 = ipc_config->dmic.fifo_bits;
2640 /* send message to DSP */
2641 ret = sof_ipc_tx_message(sdev->ipc,
2642 ipc_config->hdr.cmd, ipc_config, size, &reply,
2647 "error: failed to set DAI config for DMIC%d\n",
2652 /* set config for all DAI's with name matching the link name */
2653 ret = sof_set_dai_config(sdev, size, link, ipc_config);
2655 dev_err(sdev->dev, "error: failed to save DAI config for DMIC%d\n",
2659 kfree(sdev->private);
2666 * for hda link, playback and capture are supported by different dai
2667 * in FW. Here get the dai_index, set dma channel of each dai
2668 * and send config to FW. In FW, each dai sets config by dai_index
2670 static int sof_link_hda_process(struct snd_sof_dev *sdev,
2671 struct snd_soc_dai_link *link,
2672 struct sof_ipc_dai_config *config)
2674 struct sof_ipc_reply reply;
2675 u32 size = sizeof(*config);
2676 struct snd_sof_dai *sof_dai;
2680 list_for_each_entry(sof_dai, &sdev->dai_list, list) {
2684 if (strcmp(link->name, sof_dai->name) == 0) {
2685 config->dai_index = sof_dai->comp_dai.dai_index;
2688 config->hda.link_dma_ch = DMA_CHAN_INVALID;
2690 /* save config in dai component */
2691 sof_dai->dai_config = kmemdup(config, size, GFP_KERNEL);
2692 if (!sof_dai->dai_config)
2695 sof_dai->cpu_dai_name = link->cpus->dai_name;
2697 /* send message to DSP */
2698 ret = sof_ipc_tx_message(sdev->ipc,
2699 config->hdr.cmd, config, size,
2700 &reply, sizeof(reply));
2703 dev_err(sdev->dev, "error: failed to set DAI config for direction:%d of HDA dai %d\n",
2704 sof_dai->comp_dai.direction,
2713 * machine driver may define a dai link with playback and capture
2714 * dai enabled, but the dai link in topology would support both, one
2715 * or none of them. Here print a warning message to notify user
2718 dev_warn(sdev->dev, "warning: failed to find dai for dai link %s",
2725 static int sof_link_hda_load(struct snd_soc_component *scomp, int index,
2726 struct snd_soc_dai_link *link,
2727 struct snd_soc_tplg_link_config *cfg,
2728 struct snd_soc_tplg_hw_config *hw_config,
2729 struct sof_ipc_dai_config *config)
2731 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2732 struct snd_soc_tplg_private *private = &cfg->priv;
2733 struct snd_soc_dai *dai;
2734 u32 size = sizeof(*config);
2738 memset(&config->hda, 0, sizeof(struct sof_ipc_dai_hda_params));
2739 config->hdr.size = size;
2741 /* get any bespoke DAI tokens */
2742 ret = sof_parse_tokens(scomp, config, hda_tokens,
2743 ARRAY_SIZE(hda_tokens), private->array,
2744 le32_to_cpu(private->size));
2746 dev_err(sdev->dev, "error: parse hda tokens failed %d\n",
2747 le32_to_cpu(private->size));
2751 dai = snd_soc_find_dai(link->cpus);
2753 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2754 link->cpus->dai_name, __func__);
2758 ret = sof_link_hda_process(sdev, link, config);
2760 dev_err(sdev->dev, "error: failed to process hda dai link %s",
2766 /* DAI link - used for any driver specific init */
2767 static int sof_link_load(struct snd_soc_component *scomp, int index,
2768 struct snd_soc_dai_link *link,
2769 struct snd_soc_tplg_link_config *cfg)
2771 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2772 struct snd_soc_tplg_private *private = &cfg->priv;
2773 struct sof_ipc_dai_config config;
2774 struct snd_soc_tplg_hw_config *hw_config;
2779 if (!link->platforms) {
2780 dev_err(sdev->dev, "error: no platforms\n");
2783 link->platforms->name = dev_name(sdev->dev);
2786 * Set nonatomic property for FE dai links as their trigger action
2789 if (!link->no_pcm) {
2790 link->nonatomic = true;
2792 /* nothing more to do for FE dai links */
2796 /* check we have some tokens - we need at least DAI type */
2797 if (le32_to_cpu(private->size) == 0) {
2798 dev_err(sdev->dev, "error: expected tokens for DAI, none found\n");
2802 /* Send BE DAI link configurations to DSP */
2803 memset(&config, 0, sizeof(config));
2805 /* get any common DAI tokens */
2806 ret = sof_parse_tokens(scomp, &config, dai_link_tokens,
2807 ARRAY_SIZE(dai_link_tokens), private->array,
2808 le32_to_cpu(private->size));
2810 dev_err(sdev->dev, "error: parse link tokens failed %d\n",
2811 le32_to_cpu(private->size));
2816 * DAI links are expected to have at least 1 hw_config.
2817 * But some older topologies might have no hw_config for HDA dai links.
2819 num_hw_configs = le32_to_cpu(cfg->num_hw_configs);
2820 if (!num_hw_configs) {
2821 if (config.type != SOF_DAI_INTEL_HDA) {
2822 dev_err(sdev->dev, "error: unexpected DAI config count %d!\n",
2823 le32_to_cpu(cfg->num_hw_configs));
2827 dev_dbg(sdev->dev, "tplg: %d hw_configs found, default id: %d!\n",
2828 cfg->num_hw_configs, le32_to_cpu(cfg->default_hw_config_id));
2830 for (i = 0; i < num_hw_configs; i++) {
2831 if (cfg->hw_config[i].id == cfg->default_hw_config_id)
2835 if (i == num_hw_configs) {
2836 dev_err(sdev->dev, "error: default hw_config id: %d not found!\n",
2837 le32_to_cpu(cfg->default_hw_config_id));
2842 /* configure dai IPC message */
2843 hw_config = &cfg->hw_config[i];
2845 config.hdr.cmd = SOF_IPC_GLB_DAI_MSG | SOF_IPC_DAI_CONFIG;
2846 config.format = le32_to_cpu(hw_config->fmt);
2848 /* now load DAI specific data and send IPC - type comes from token */
2849 switch (config.type) {
2850 case SOF_DAI_INTEL_SSP:
2851 ret = sof_link_ssp_load(scomp, index, link, cfg, hw_config,
2854 case SOF_DAI_INTEL_DMIC:
2855 ret = sof_link_dmic_load(scomp, index, link, cfg, hw_config,
2858 case SOF_DAI_INTEL_HDA:
2859 ret = sof_link_hda_load(scomp, index, link, cfg, hw_config,
2862 case SOF_DAI_IMX_SAI:
2863 ret = sof_link_sai_load(scomp, index, link, cfg, hw_config,
2866 case SOF_DAI_IMX_ESAI:
2867 ret = sof_link_esai_load(scomp, index, link, cfg, hw_config,
2871 dev_err(sdev->dev, "error: invalid DAI type %d\n", config.type);
2881 static int sof_link_hda_unload(struct snd_sof_dev *sdev,
2882 struct snd_soc_dai_link *link)
2884 struct snd_soc_dai *dai;
2887 dai = snd_soc_find_dai(link->cpus);
2889 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2890 link->cpus->dai_name, __func__);
2897 static int sof_link_unload(struct snd_soc_component *scomp,
2898 struct snd_soc_dobj *dobj)
2900 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2901 struct snd_soc_dai_link *link =
2902 container_of(dobj, struct snd_soc_dai_link, dobj);
2904 struct snd_sof_dai *sof_dai;
2907 /* only BE link is loaded by sof */
2911 list_for_each_entry(sof_dai, &sdev->dai_list, list) {
2915 if (strcmp(link->name, sof_dai->name) == 0)
2919 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2920 link->name, __func__);
2924 switch (sof_dai->dai_config->type) {
2925 case SOF_DAI_INTEL_SSP:
2926 case SOF_DAI_INTEL_DMIC:
2927 /* no resource needs to be released for SSP and DMIC */
2929 case SOF_DAI_INTEL_HDA:
2930 ret = sof_link_hda_unload(sdev, link);
2933 dev_err(sdev->dev, "error: invalid DAI type %d\n",
2934 sof_dai->dai_config->type);
2942 /* DAI link - used for any driver specific init */
2943 static int sof_route_load(struct snd_soc_component *scomp, int index,
2944 struct snd_soc_dapm_route *route)
2946 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2947 struct sof_ipc_pipe_comp_connect *connect;
2948 struct snd_sof_widget *source_swidget, *sink_swidget;
2949 struct snd_soc_dobj *dobj = &route->dobj;
2950 struct snd_sof_route *sroute;
2951 struct sof_ipc_reply reply;
2954 /* allocate memory for sroute and connect */
2955 sroute = kzalloc(sizeof(*sroute), GFP_KERNEL);
2959 sroute->sdev = sdev;
2961 connect = kzalloc(sizeof(*connect), GFP_KERNEL);
2967 connect->hdr.size = sizeof(*connect);
2968 connect->hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_CONNECT;
2970 dev_dbg(sdev->dev, "sink %s control %s source %s\n",
2971 route->sink, route->control ? route->control : "none",
2974 /* source component */
2975 source_swidget = snd_sof_find_swidget(sdev, (char *)route->source);
2976 if (!source_swidget) {
2977 dev_err(sdev->dev, "error: source %s not found\n",
2984 * Virtual widgets of type output/out_drv may be added in topology
2985 * for compatibility. These are not handled by the FW.
2986 * So, don't send routes whose source/sink widget is of such types
2989 if (source_swidget->id == snd_soc_dapm_out_drv ||
2990 source_swidget->id == snd_soc_dapm_output)
2993 connect->source_id = source_swidget->comp_id;
2995 /* sink component */
2996 sink_swidget = snd_sof_find_swidget(sdev, (char *)route->sink);
2997 if (!sink_swidget) {
2998 dev_err(sdev->dev, "error: sink %s not found\n",
3005 * Don't send routes whose sink widget is of type
3006 * output or out_drv to the DSP
3008 if (sink_swidget->id == snd_soc_dapm_out_drv ||
3009 sink_swidget->id == snd_soc_dapm_output)
3012 connect->sink_id = sink_swidget->comp_id;
3015 * For virtual routes, both sink and source are not
3016 * buffer. Since only buffer linked to component is supported by
3017 * FW, others are reported as error, add check in route function,
3018 * do not send it to FW when both source and sink are not buffer
3020 if (source_swidget->id != snd_soc_dapm_buffer &&
3021 sink_swidget->id != snd_soc_dapm_buffer) {
3022 dev_dbg(sdev->dev, "warning: neither Linked source component %s nor sink component %s is of buffer type, ignoring link\n",
3023 route->source, route->sink);
3027 ret = sof_ipc_tx_message(sdev->ipc,
3029 connect, sizeof(*connect),
3030 &reply, sizeof(reply));
3032 /* check IPC return value */
3034 dev_err(sdev->dev, "error: failed to add route sink %s control %s source %s\n",
3036 route->control ? route->control : "none",
3041 /* check IPC reply */
3042 if (reply.error < 0) {
3043 dev_err(sdev->dev, "error: DSP failed to add route sink %s control %s source %s result %d\n",
3045 route->control ? route->control : "none",
3046 route->source, reply.error);
3051 sroute->route = route;
3052 dobj->private = sroute;
3053 sroute->private = connect;
3055 /* add route to route list */
3056 list_add(&sroute->list, &sdev->route_list);
3067 /* Function to set the initial value of SOF kcontrols.
3068 * The value will be stored in scontrol->control_data
3070 static int snd_sof_cache_kcontrol_val(struct snd_sof_dev *sdev)
3072 struct snd_sof_control *scontrol = NULL;
3073 int ipc_cmd, ctrl_type;
3076 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
3078 /* notify DSP of kcontrol values */
3079 switch (scontrol->cmd) {
3080 case SOF_CTRL_CMD_VOLUME:
3081 case SOF_CTRL_CMD_ENUM:
3082 case SOF_CTRL_CMD_SWITCH:
3083 ipc_cmd = SOF_IPC_COMP_GET_VALUE;
3084 ctrl_type = SOF_CTRL_TYPE_VALUE_CHAN_GET;
3086 case SOF_CTRL_CMD_BINARY:
3087 ipc_cmd = SOF_IPC_COMP_GET_DATA;
3088 ctrl_type = SOF_CTRL_TYPE_DATA_GET;
3092 "error: Invalid scontrol->cmd: %d\n",
3096 ret = snd_sof_ipc_set_get_comp_data(sdev->ipc, scontrol,
3102 "error: kcontrol value get for widget: %d\n",
3110 int snd_sof_complete_pipeline(struct snd_sof_dev *sdev,
3111 struct snd_sof_widget *swidget)
3113 struct sof_ipc_pipe_ready ready;
3114 struct sof_ipc_reply reply;
3117 dev_dbg(sdev->dev, "tplg: complete pipeline %s id %d\n",
3118 swidget->widget->name, swidget->comp_id);
3120 memset(&ready, 0, sizeof(ready));
3121 ready.hdr.size = sizeof(ready);
3122 ready.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_PIPE_COMPLETE;
3123 ready.comp_id = swidget->comp_id;
3125 ret = sof_ipc_tx_message(sdev->ipc,
3126 ready.hdr.cmd, &ready, sizeof(ready), &reply,
3133 /* completion - called at completion of firmware loading */
3134 static void sof_complete(struct snd_soc_component *scomp)
3136 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
3137 struct snd_sof_widget *swidget;
3139 /* some widget types require completion notificattion */
3140 list_for_each_entry(swidget, &sdev->widget_list, list) {
3141 if (swidget->complete)
3144 switch (swidget->id) {
3145 case snd_soc_dapm_scheduler:
3147 snd_sof_complete_pipeline(sdev, swidget);
3154 * cache initial values of SOF kcontrols by reading DSP value over
3155 * IPC. It may be overwritten by alsa-mixer after booting up
3157 snd_sof_cache_kcontrol_val(sdev);
3160 /* manifest - optional to inform component of manifest */
3161 static int sof_manifest(struct snd_soc_component *scomp, int index,
3162 struct snd_soc_tplg_manifest *man)
3164 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
3168 size = le32_to_cpu(man->priv.size);
3170 /* backward compatible with tplg without ABI info */
3172 dev_dbg(sdev->dev, "No topology ABI info\n");
3176 if (size != SOF_TPLG_ABI_SIZE) {
3177 dev_err(sdev->dev, "error: invalid topology ABI size\n");
3182 "Topology: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
3183 man->priv.data[0], man->priv.data[1],
3184 man->priv.data[2], SOF_ABI_MAJOR, SOF_ABI_MINOR,
3187 abi_version = SOF_ABI_VER(man->priv.data[0],
3191 if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, abi_version)) {
3192 dev_err(sdev->dev, "error: incompatible topology ABI version\n");
3196 if (abi_version > SOF_ABI_VERSION) {
3197 if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
3198 dev_warn(sdev->dev, "warn: topology ABI is more recent than kernel\n");
3200 dev_err(sdev->dev, "error: topology ABI is more recent than kernel\n");
3208 /* vendor specific kcontrol handlers available for binding */
3209 static const struct snd_soc_tplg_kcontrol_ops sof_io_ops[] = {
3210 {SOF_TPLG_KCTL_VOL_ID, snd_sof_volume_get, snd_sof_volume_put},
3211 {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_get, snd_sof_bytes_put},
3212 {SOF_TPLG_KCTL_ENUM_ID, snd_sof_enum_get, snd_sof_enum_put},
3213 {SOF_TPLG_KCTL_SWITCH_ID, snd_sof_switch_get, snd_sof_switch_put},
3216 /* vendor specific bytes ext handlers available for binding */
3217 static const struct snd_soc_tplg_bytes_ext_ops sof_bytes_ext_ops[] = {
3218 {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_ext_get, snd_sof_bytes_ext_put},
3221 static struct snd_soc_tplg_ops sof_tplg_ops = {
3222 /* external kcontrol init - used for any driver specific init */
3223 .control_load = sof_control_load,
3224 .control_unload = sof_control_unload,
3226 /* external kcontrol init - used for any driver specific init */
3227 .dapm_route_load = sof_route_load,
3228 .dapm_route_unload = sof_route_unload,
3230 /* external widget init - used for any driver specific init */
3231 /* .widget_load is not currently used */
3232 .widget_ready = sof_widget_ready,
3233 .widget_unload = sof_widget_unload,
3235 /* FE DAI - used for any driver specific init */
3236 .dai_load = sof_dai_load,
3237 .dai_unload = sof_dai_unload,
3239 /* DAI link - used for any driver specific init */
3240 .link_load = sof_link_load,
3241 .link_unload = sof_link_unload,
3243 /* completion - called at completion of firmware loading */
3244 .complete = sof_complete,
3246 /* manifest - optional to inform component of manifest */
3247 .manifest = sof_manifest,
3249 /* vendor specific kcontrol handlers available for binding */
3250 .io_ops = sof_io_ops,
3251 .io_ops_count = ARRAY_SIZE(sof_io_ops),
3253 /* vendor specific bytes ext handlers available for binding */
3254 .bytes_ext_ops = sof_bytes_ext_ops,
3255 .bytes_ext_ops_count = ARRAY_SIZE(sof_bytes_ext_ops),
3258 int snd_sof_init_topology(struct snd_sof_dev *sdev,
3259 struct snd_soc_tplg_ops *ops)
3261 /* TODO: support linked list of topologies */
3262 sdev->tplg_ops = ops;
3265 EXPORT_SYMBOL(snd_sof_init_topology);
3267 int snd_sof_load_topology(struct snd_sof_dev *sdev, const char *file)
3269 const struct firmware *fw;
3272 dev_dbg(sdev->dev, "loading topology:%s\n", file);
3274 ret = request_firmware(&fw, file, sdev->dev);
3276 dev_err(sdev->dev, "error: tplg request firmware %s failed err: %d\n",
3281 ret = snd_soc_tplg_component_load(sdev->component,
3283 SND_SOC_TPLG_INDEX_ALL);
3285 dev_err(sdev->dev, "error: tplg component load failed %d\n",
3290 release_firmware(fw);
3293 EXPORT_SYMBOL(snd_sof_load_topology);