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 {"ALH", SOF_DAI_INTEL_ALH},
350 {"SAI", SOF_DAI_IMX_SAI},
351 {"ESAI", SOF_DAI_IMX_ESAI},
354 static enum sof_ipc_dai_type find_dai(const char *name)
358 for (i = 0; i < ARRAY_SIZE(sof_dais); i++) {
359 if (strcmp(name, sof_dais[i].name) == 0)
360 return sof_dais[i].type;
363 return SOF_DAI_INTEL_NONE;
367 * Supported Frame format types and lookup, add new ones to end of list.
370 struct sof_frame_types {
372 enum sof_ipc_frame frame;
375 static const struct sof_frame_types sof_frames[] = {
376 {"s16le", SOF_IPC_FRAME_S16_LE},
377 {"s24le", SOF_IPC_FRAME_S24_4LE},
378 {"s32le", SOF_IPC_FRAME_S32_LE},
379 {"float", SOF_IPC_FRAME_FLOAT},
382 static enum sof_ipc_frame find_format(const char *name)
386 for (i = 0; i < ARRAY_SIZE(sof_frames); i++) {
387 if (strcmp(name, sof_frames[i].name) == 0)
388 return sof_frames[i].frame;
391 /* use s32le if nothing is specified */
392 return SOF_IPC_FRAME_S32_LE;
395 struct sof_process_types {
397 enum sof_ipc_process_type type;
398 enum sof_comp_type comp_type;
401 static const struct sof_process_types sof_process[] = {
402 {"EQFIR", SOF_PROCESS_EQFIR, SOF_COMP_EQ_FIR},
403 {"EQIIR", SOF_PROCESS_EQIIR, SOF_COMP_EQ_IIR},
404 {"KEYWORD_DETECT", SOF_PROCESS_KEYWORD_DETECT, SOF_COMP_KEYWORD_DETECT},
405 {"KPB", SOF_PROCESS_KPB, SOF_COMP_KPB},
406 {"CHAN_SELECTOR", SOF_PROCESS_CHAN_SELECTOR, SOF_COMP_SELECTOR},
407 {"MUX", SOF_PROCESS_MUX, SOF_COMP_MUX},
408 {"DEMUX", SOF_PROCESS_DEMUX, SOF_COMP_DEMUX},
411 static enum sof_ipc_process_type find_process(const char *name)
415 for (i = 0; i < ARRAY_SIZE(sof_process); i++) {
416 if (strcmp(name, sof_process[i].name) == 0)
417 return sof_process[i].type;
420 return SOF_PROCESS_NONE;
423 static enum sof_comp_type find_process_comp_type(enum sof_ipc_process_type type)
427 for (i = 0; i < ARRAY_SIZE(sof_process); i++) {
428 if (sof_process[i].type == type)
429 return sof_process[i].comp_type;
432 return SOF_COMP_NONE;
436 * Standard Kcontrols.
439 static int sof_control_load_volume(struct snd_soc_component *scomp,
440 struct snd_sof_control *scontrol,
441 struct snd_kcontrol_new *kc,
442 struct snd_soc_tplg_ctl_hdr *hdr)
444 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
445 struct snd_soc_tplg_mixer_control *mc =
446 container_of(hdr, struct snd_soc_tplg_mixer_control, hdr);
447 struct sof_ipc_ctrl_data *cdata;
452 /* validate topology data */
453 if (le32_to_cpu(mc->num_channels) > SND_SOC_TPLG_MAX_CHAN)
456 /* init the volume get/put data */
457 scontrol->size = struct_size(scontrol->control_data, chanv,
458 le32_to_cpu(mc->num_channels));
459 scontrol->control_data = kzalloc(scontrol->size, GFP_KERNEL);
460 if (!scontrol->control_data)
463 scontrol->comp_id = sdev->next_comp_id;
464 scontrol->min_volume_step = le32_to_cpu(mc->min);
465 scontrol->max_volume_step = le32_to_cpu(mc->max);
466 scontrol->num_channels = le32_to_cpu(mc->num_channels);
468 /* set cmd for mixer control */
469 if (le32_to_cpu(mc->max) == 1) {
470 scontrol->cmd = SOF_CTRL_CMD_SWITCH;
474 scontrol->cmd = SOF_CTRL_CMD_VOLUME;
476 /* extract tlv data */
477 if (get_tlv_data(kc->tlv.p, tlv) < 0) {
478 dev_err(sdev->dev, "error: invalid TLV data\n");
482 /* set up volume table */
483 ret = set_up_volume_table(scontrol, tlv, le32_to_cpu(mc->max) + 1);
485 dev_err(sdev->dev, "error: setting up volume table\n");
489 /* set default volume values to 0dB in control */
490 cdata = scontrol->control_data;
491 for (i = 0; i < scontrol->num_channels; i++) {
492 cdata->chanv[i].channel = i;
493 cdata->chanv[i].value = VOL_ZERO_DB;
497 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d\n",
498 scontrol->comp_id, scontrol->num_channels);
503 static int sof_control_load_enum(struct snd_soc_component *scomp,
504 struct snd_sof_control *scontrol,
505 struct snd_kcontrol_new *kc,
506 struct snd_soc_tplg_ctl_hdr *hdr)
508 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
509 struct snd_soc_tplg_enum_control *ec =
510 container_of(hdr, struct snd_soc_tplg_enum_control, hdr);
512 /* validate topology data */
513 if (le32_to_cpu(ec->num_channels) > SND_SOC_TPLG_MAX_CHAN)
516 /* init the enum get/put data */
517 scontrol->size = struct_size(scontrol->control_data, chanv,
518 le32_to_cpu(ec->num_channels));
519 scontrol->control_data = kzalloc(scontrol->size, GFP_KERNEL);
520 if (!scontrol->control_data)
523 scontrol->comp_id = sdev->next_comp_id;
524 scontrol->num_channels = le32_to_cpu(ec->num_channels);
526 scontrol->cmd = SOF_CTRL_CMD_ENUM;
528 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d comp_id %d\n",
529 scontrol->comp_id, scontrol->num_channels, scontrol->comp_id);
534 static int sof_control_load_bytes(struct snd_soc_component *scomp,
535 struct snd_sof_control *scontrol,
536 struct snd_kcontrol_new *kc,
537 struct snd_soc_tplg_ctl_hdr *hdr)
539 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
540 struct sof_ipc_ctrl_data *cdata;
541 struct snd_soc_tplg_bytes_control *control =
542 container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
543 struct soc_bytes_ext *sbe = (struct soc_bytes_ext *)kc->private_value;
544 int max_size = sbe->max;
546 if (le32_to_cpu(control->priv.size) > max_size) {
547 dev_err(sdev->dev, "err: bytes data size %d exceeds max %d.\n",
548 control->priv.size, max_size);
552 /* init the get/put bytes data */
553 scontrol->size = sizeof(struct sof_ipc_ctrl_data) +
554 le32_to_cpu(control->priv.size);
555 scontrol->control_data = kzalloc(max_size, GFP_KERNEL);
556 cdata = scontrol->control_data;
557 if (!scontrol->control_data)
560 scontrol->comp_id = sdev->next_comp_id;
561 scontrol->cmd = SOF_CTRL_CMD_BINARY;
563 dev_dbg(sdev->dev, "tplg: load kcontrol index %d chans %d\n",
564 scontrol->comp_id, scontrol->num_channels);
566 if (le32_to_cpu(control->priv.size) > 0) {
567 memcpy(cdata->data, control->priv.data,
568 le32_to_cpu(control->priv.size));
570 if (cdata->data->magic != SOF_ABI_MAGIC) {
571 dev_err(sdev->dev, "error: Wrong ABI magic 0x%08x.\n",
575 if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION,
578 "error: Incompatible ABI version 0x%08x.\n",
582 if (cdata->data->size + sizeof(const struct sof_abi_hdr) !=
583 le32_to_cpu(control->priv.size)) {
585 "error: Conflict in bytes vs. priv size.\n");
593 * Topology Token Parsing.
594 * New tokens should be added to headers and parsing tables below.
597 struct sof_topology_token {
600 int (*get_token)(void *elem, void *object, u32 offset, u32 size);
605 static int get_token_u32(void *elem, void *object, u32 offset, u32 size)
607 struct snd_soc_tplg_vendor_value_elem *velem = elem;
608 u32 *val = (u32 *)((u8 *)object + offset);
610 *val = le32_to_cpu(velem->value);
614 static int get_token_u16(void *elem, void *object, u32 offset, u32 size)
616 struct snd_soc_tplg_vendor_value_elem *velem = elem;
617 u16 *val = (u16 *)((u8 *)object + offset);
619 *val = (u16)le32_to_cpu(velem->value);
623 static int get_token_comp_format(void *elem, void *object, u32 offset, u32 size)
625 struct snd_soc_tplg_vendor_string_elem *velem = elem;
626 u32 *val = (u32 *)((u8 *)object + offset);
628 *val = find_format(velem->string);
632 static int get_token_dai_type(void *elem, void *object, u32 offset, u32 size)
634 struct snd_soc_tplg_vendor_string_elem *velem = elem;
635 u32 *val = (u32 *)((u8 *)object + offset);
637 *val = find_dai(velem->string);
641 static int get_token_process_type(void *elem, void *object, u32 offset,
644 struct snd_soc_tplg_vendor_string_elem *velem = elem;
645 u32 *val = (u32 *)((u8 *)object + offset);
647 *val = find_process(velem->string);
652 static const struct sof_topology_token buffer_tokens[] = {
653 {SOF_TKN_BUF_SIZE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
654 offsetof(struct sof_ipc_buffer, size), 0},
655 {SOF_TKN_BUF_CAPS, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
656 offsetof(struct sof_ipc_buffer, caps), 0},
660 static const struct sof_topology_token dai_tokens[] = {
661 {SOF_TKN_DAI_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_dai_type,
662 offsetof(struct sof_ipc_comp_dai, type), 0},
663 {SOF_TKN_DAI_INDEX, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
664 offsetof(struct sof_ipc_comp_dai, dai_index), 0},
665 {SOF_TKN_DAI_DIRECTION, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
666 offsetof(struct sof_ipc_comp_dai, direction), 0},
670 static const struct sof_topology_token dai_link_tokens[] = {
671 {SOF_TKN_DAI_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_dai_type,
672 offsetof(struct sof_ipc_dai_config, type), 0},
673 {SOF_TKN_DAI_INDEX, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
674 offsetof(struct sof_ipc_dai_config, dai_index), 0},
678 static const struct sof_topology_token sched_tokens[] = {
679 {SOF_TKN_SCHED_PERIOD, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
680 offsetof(struct sof_ipc_pipe_new, period), 0},
681 {SOF_TKN_SCHED_PRIORITY, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
682 offsetof(struct sof_ipc_pipe_new, priority), 0},
683 {SOF_TKN_SCHED_MIPS, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
684 offsetof(struct sof_ipc_pipe_new, period_mips), 0},
685 {SOF_TKN_SCHED_CORE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
686 offsetof(struct sof_ipc_pipe_new, core), 0},
687 {SOF_TKN_SCHED_FRAMES, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
688 offsetof(struct sof_ipc_pipe_new, frames_per_sched), 0},
689 {SOF_TKN_SCHED_TIME_DOMAIN, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
690 offsetof(struct sof_ipc_pipe_new, time_domain), 0},
694 static const struct sof_topology_token volume_tokens[] = {
695 {SOF_TKN_VOLUME_RAMP_STEP_TYPE, SND_SOC_TPLG_TUPLE_TYPE_WORD,
696 get_token_u32, offsetof(struct sof_ipc_comp_volume, ramp), 0},
697 {SOF_TKN_VOLUME_RAMP_STEP_MS,
698 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
699 offsetof(struct sof_ipc_comp_volume, initial_ramp), 0},
703 static const struct sof_topology_token src_tokens[] = {
704 {SOF_TKN_SRC_RATE_IN, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
705 offsetof(struct sof_ipc_comp_src, source_rate), 0},
706 {SOF_TKN_SRC_RATE_OUT, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
707 offsetof(struct sof_ipc_comp_src, sink_rate), 0},
711 static const struct sof_topology_token tone_tokens[] = {
715 static const struct sof_topology_token process_tokens[] = {
716 {SOF_TKN_PROCESS_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING,
717 get_token_process_type,
718 offsetof(struct sof_ipc_comp_process, type), 0},
722 static const struct sof_topology_token pcm_tokens[] = {
723 {SOF_TKN_PCM_DMAC_CONFIG, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
724 offsetof(struct sof_ipc_comp_host, dmac_config), 0},
727 /* Generic components */
728 static const struct sof_topology_token comp_tokens[] = {
729 {SOF_TKN_COMP_PERIOD_SINK_COUNT,
730 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
731 offsetof(struct sof_ipc_comp_config, periods_sink), 0},
732 {SOF_TKN_COMP_PERIOD_SOURCE_COUNT,
733 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
734 offsetof(struct sof_ipc_comp_config, periods_source), 0},
735 {SOF_TKN_COMP_FORMAT,
736 SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_comp_format,
737 offsetof(struct sof_ipc_comp_config, frame_fmt), 0},
741 static const struct sof_topology_token ssp_tokens[] = {
742 {SOF_TKN_INTEL_SSP_CLKS_CONTROL,
743 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
744 offsetof(struct sof_ipc_dai_ssp_params, clks_control), 0},
745 {SOF_TKN_INTEL_SSP_MCLK_ID,
746 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
747 offsetof(struct sof_ipc_dai_ssp_params, mclk_id), 0},
748 {SOF_TKN_INTEL_SSP_SAMPLE_BITS, SND_SOC_TPLG_TUPLE_TYPE_WORD,
750 offsetof(struct sof_ipc_dai_ssp_params, sample_valid_bits), 0},
751 {SOF_TKN_INTEL_SSP_FRAME_PULSE_WIDTH, SND_SOC_TPLG_TUPLE_TYPE_SHORT,
753 offsetof(struct sof_ipc_dai_ssp_params, frame_pulse_width), 0},
754 {SOF_TKN_INTEL_SSP_QUIRKS, SND_SOC_TPLG_TUPLE_TYPE_WORD,
756 offsetof(struct sof_ipc_dai_ssp_params, quirks), 0},
757 {SOF_TKN_INTEL_SSP_TDM_PADDING_PER_SLOT, SND_SOC_TPLG_TUPLE_TYPE_BOOL,
759 offsetof(struct sof_ipc_dai_ssp_params,
760 tdm_per_slot_padding_flag), 0},
761 {SOF_TKN_INTEL_SSP_BCLK_DELAY, SND_SOC_TPLG_TUPLE_TYPE_WORD,
763 offsetof(struct sof_ipc_dai_ssp_params, bclk_delay), 0},
768 static const struct sof_topology_token dmic_tokens[] = {
769 {SOF_TKN_INTEL_DMIC_DRIVER_VERSION,
770 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
771 offsetof(struct sof_ipc_dai_dmic_params, driver_ipc_version),
773 {SOF_TKN_INTEL_DMIC_CLK_MIN,
774 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
775 offsetof(struct sof_ipc_dai_dmic_params, pdmclk_min), 0},
776 {SOF_TKN_INTEL_DMIC_CLK_MAX,
777 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
778 offsetof(struct sof_ipc_dai_dmic_params, pdmclk_max), 0},
779 {SOF_TKN_INTEL_DMIC_SAMPLE_RATE,
780 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
781 offsetof(struct sof_ipc_dai_dmic_params, fifo_fs), 0},
782 {SOF_TKN_INTEL_DMIC_DUTY_MIN,
783 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
784 offsetof(struct sof_ipc_dai_dmic_params, duty_min), 0},
785 {SOF_TKN_INTEL_DMIC_DUTY_MAX,
786 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
787 offsetof(struct sof_ipc_dai_dmic_params, duty_max), 0},
788 {SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE,
789 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
790 offsetof(struct sof_ipc_dai_dmic_params,
792 {SOF_TKN_INTEL_DMIC_FIFO_WORD_LENGTH,
793 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
794 offsetof(struct sof_ipc_dai_dmic_params, fifo_bits), 0},
795 {SOF_TKN_INTEL_DMIC_UNMUTE_RAMP_TIME_MS,
796 SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
797 offsetof(struct sof_ipc_dai_dmic_params, unmute_ramp_time), 0},
803 * SOF_TKN_INTEL_DMIC_PDM_CTRL_ID should be the first token
804 * as it increments the index while parsing the array of pdm tokens
805 * and determines the correct offset
807 static const struct sof_topology_token dmic_pdm_tokens[] = {
808 {SOF_TKN_INTEL_DMIC_PDM_CTRL_ID,
809 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
810 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, id),
812 {SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable,
813 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
814 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, enable_mic_a),
816 {SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable,
817 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
818 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, enable_mic_b),
820 {SOF_TKN_INTEL_DMIC_PDM_POLARITY_A,
821 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
822 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, polarity_mic_a),
824 {SOF_TKN_INTEL_DMIC_PDM_POLARITY_B,
825 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
826 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, polarity_mic_b),
828 {SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE,
829 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
830 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, clk_edge),
832 {SOF_TKN_INTEL_DMIC_PDM_SKEW,
833 SND_SOC_TPLG_TUPLE_TYPE_SHORT, get_token_u16,
834 offsetof(struct sof_ipc_dai_dmic_pdm_ctrl, skew),
839 static const struct sof_topology_token hda_tokens[] = {
842 static void sof_parse_uuid_tokens(struct snd_soc_component *scomp,
844 const struct sof_topology_token *tokens,
846 struct snd_soc_tplg_vendor_array *array)
848 struct snd_soc_tplg_vendor_uuid_elem *elem;
851 /* parse element by element */
852 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
853 elem = &array->uuid[i];
855 /* search for token */
856 for (j = 0; j < count; j++) {
857 /* match token type */
858 if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_UUID)
862 if (tokens[j].token != le32_to_cpu(elem->token))
865 /* matched - now load token */
866 tokens[j].get_token(elem, object, tokens[j].offset,
872 static void sof_parse_string_tokens(struct snd_soc_component *scomp,
874 const struct sof_topology_token *tokens,
876 struct snd_soc_tplg_vendor_array *array)
878 struct snd_soc_tplg_vendor_string_elem *elem;
881 /* parse element by element */
882 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
883 elem = &array->string[i];
885 /* search for token */
886 for (j = 0; j < count; j++) {
887 /* match token type */
888 if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_STRING)
892 if (tokens[j].token != le32_to_cpu(elem->token))
895 /* matched - now load token */
896 tokens[j].get_token(elem, object, tokens[j].offset,
902 static void sof_parse_word_tokens(struct snd_soc_component *scomp,
904 const struct sof_topology_token *tokens,
906 struct snd_soc_tplg_vendor_array *array)
908 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
909 struct snd_soc_tplg_vendor_value_elem *elem;
910 size_t size = sizeof(struct sof_ipc_dai_dmic_pdm_ctrl);
915 /* parse element by element */
916 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
917 elem = &array->value[i];
919 /* search for token */
920 for (j = 0; j < count; j++) {
921 /* match token type */
922 if (!(tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_WORD ||
923 tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_SHORT))
927 if (tokens[j].token != le32_to_cpu(elem->token))
930 /* pdm config array index */
932 index = sdev->private;
934 /* matched - determine offset */
935 switch (tokens[j].token) {
936 case SOF_TKN_INTEL_DMIC_PDM_CTRL_ID:
938 /* inc number of pdm array index */
942 case SOF_TKN_INTEL_DMIC_PDM_MIC_A_Enable:
943 case SOF_TKN_INTEL_DMIC_PDM_MIC_B_Enable:
944 case SOF_TKN_INTEL_DMIC_PDM_POLARITY_A:
945 case SOF_TKN_INTEL_DMIC_PDM_POLARITY_B:
946 case SOF_TKN_INTEL_DMIC_PDM_CLK_EDGE:
947 case SOF_TKN_INTEL_DMIC_PDM_SKEW:
949 /* check if array index is valid */
950 if (!index || *index == 0) {
952 "error: invalid array offset\n");
955 /* offset within the pdm config array */
956 offset = size * (*index - 1);
965 tokens[j].get_token(elem, object,
966 offset + tokens[j].offset,
972 static int sof_parse_tokens(struct snd_soc_component *scomp,
974 const struct sof_topology_token *tokens,
976 struct snd_soc_tplg_vendor_array *array,
979 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
982 while (priv_size > 0) {
983 asize = le32_to_cpu(array->size);
986 if (asize < 0) { /* FIXME: A zero-size array makes no sense */
987 dev_err(sdev->dev, "error: invalid array size 0x%x\n",
992 /* make sure there is enough data before parsing */
995 dev_err(sdev->dev, "error: invalid array size 0x%x\n",
1000 /* call correct parser depending on type */
1001 switch (le32_to_cpu(array->type)) {
1002 case SND_SOC_TPLG_TUPLE_TYPE_UUID:
1003 sof_parse_uuid_tokens(scomp, object, tokens, count,
1006 case SND_SOC_TPLG_TUPLE_TYPE_STRING:
1007 sof_parse_string_tokens(scomp, object, tokens, count,
1010 case SND_SOC_TPLG_TUPLE_TYPE_BOOL:
1011 case SND_SOC_TPLG_TUPLE_TYPE_BYTE:
1012 case SND_SOC_TPLG_TUPLE_TYPE_WORD:
1013 case SND_SOC_TPLG_TUPLE_TYPE_SHORT:
1014 sof_parse_word_tokens(scomp, object, tokens, count,
1018 dev_err(sdev->dev, "error: unknown token type %d\n",
1024 array = (struct snd_soc_tplg_vendor_array *)((u8 *)array
1030 static void sof_dbg_comp_config(struct snd_soc_component *scomp,
1031 struct sof_ipc_comp_config *config)
1033 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1035 dev_dbg(sdev->dev, " config: periods snk %d src %d fmt %d\n",
1036 config->periods_sink, config->periods_source,
1040 /* external kcontrol init - used for any driver specific init */
1041 static int sof_control_load(struct snd_soc_component *scomp, int index,
1042 struct snd_kcontrol_new *kc,
1043 struct snd_soc_tplg_ctl_hdr *hdr)
1045 struct soc_mixer_control *sm;
1046 struct soc_bytes_ext *sbe;
1047 struct soc_enum *se;
1048 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1049 struct snd_soc_dobj *dobj;
1050 struct snd_sof_control *scontrol;
1053 dev_dbg(sdev->dev, "tplg: load control type %d name : %s\n",
1054 hdr->type, hdr->name);
1056 scontrol = kzalloc(sizeof(*scontrol), GFP_KERNEL);
1060 scontrol->sdev = sdev;
1062 switch (le32_to_cpu(hdr->ops.info)) {
1063 case SND_SOC_TPLG_CTL_VOLSW:
1064 case SND_SOC_TPLG_CTL_VOLSW_SX:
1065 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1066 sm = (struct soc_mixer_control *)kc->private_value;
1068 ret = sof_control_load_volume(scomp, scontrol, kc, hdr);
1070 case SND_SOC_TPLG_CTL_BYTES:
1071 sbe = (struct soc_bytes_ext *)kc->private_value;
1073 ret = sof_control_load_bytes(scomp, scontrol, kc, hdr);
1075 case SND_SOC_TPLG_CTL_ENUM:
1076 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1077 se = (struct soc_enum *)kc->private_value;
1079 ret = sof_control_load_enum(scomp, scontrol, kc, hdr);
1081 case SND_SOC_TPLG_CTL_RANGE:
1082 case SND_SOC_TPLG_CTL_STROBE:
1083 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1084 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1085 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1086 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1087 case SND_SOC_TPLG_DAPM_CTL_PIN:
1089 dev_warn(sdev->dev, "control type not supported %d:%d:%d\n",
1090 hdr->ops.get, hdr->ops.put, hdr->ops.info);
1095 dobj->private = scontrol;
1096 list_add(&scontrol->list, &sdev->kcontrol_list);
1100 static int sof_control_unload(struct snd_soc_component *scomp,
1101 struct snd_soc_dobj *dobj)
1103 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1104 struct sof_ipc_free fcomp;
1105 struct snd_sof_control *scontrol = dobj->private;
1107 dev_dbg(sdev->dev, "tplg: unload control name : %s\n", scomp->name);
1109 fcomp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_FREE;
1110 fcomp.hdr.size = sizeof(fcomp);
1111 fcomp.id = scontrol->comp_id;
1113 kfree(scontrol->control_data);
1114 list_del(&scontrol->list);
1116 /* send IPC to the DSP */
1117 return sof_ipc_tx_message(sdev->ipc,
1118 fcomp.hdr.cmd, &fcomp, sizeof(fcomp),
1126 static int sof_connect_dai_widget(struct snd_soc_component *scomp,
1127 struct snd_soc_dapm_widget *w,
1128 struct snd_soc_tplg_dapm_widget *tw,
1129 struct snd_sof_dai *dai)
1131 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1132 struct snd_soc_card *card = scomp->card;
1133 struct snd_soc_pcm_runtime *rtd;
1135 list_for_each_entry(rtd, &card->rtd_list, list) {
1136 dev_vdbg(sdev->dev, "tplg: check widget: %s stream: %s dai stream: %s\n",
1137 w->name, w->sname, rtd->dai_link->stream_name);
1139 if (!w->sname || !rtd->dai_link->stream_name)
1142 /* does stream match DAI link ? */
1143 if (strcmp(w->sname, rtd->dai_link->stream_name))
1147 case snd_soc_dapm_dai_out:
1148 rtd->cpu_dai->capture_widget = w;
1149 dai->name = rtd->dai_link->name;
1150 dev_dbg(sdev->dev, "tplg: connected widget %s -> DAI link %s\n",
1151 w->name, rtd->dai_link->name);
1153 case snd_soc_dapm_dai_in:
1154 rtd->cpu_dai->playback_widget = w;
1155 dai->name = rtd->dai_link->name;
1156 dev_dbg(sdev->dev, "tplg: connected widget %s -> DAI link %s\n",
1157 w->name, rtd->dai_link->name);
1164 /* check we have a connection */
1166 dev_err(sdev->dev, "error: can't connect DAI %s stream %s\n",
1174 static int sof_widget_load_dai(struct snd_soc_component *scomp, int index,
1175 struct snd_sof_widget *swidget,
1176 struct snd_soc_tplg_dapm_widget *tw,
1177 struct sof_ipc_comp_reply *r,
1178 struct snd_sof_dai *dai)
1180 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1181 struct snd_soc_tplg_private *private = &tw->priv;
1182 struct sof_ipc_comp_dai comp_dai;
1185 /* configure dai IPC message */
1186 memset(&comp_dai, 0, sizeof(comp_dai));
1187 comp_dai.comp.hdr.size = sizeof(comp_dai);
1188 comp_dai.comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1189 comp_dai.comp.id = swidget->comp_id;
1190 comp_dai.comp.type = SOF_COMP_DAI;
1191 comp_dai.comp.pipeline_id = index;
1192 comp_dai.config.hdr.size = sizeof(comp_dai.config);
1194 ret = sof_parse_tokens(scomp, &comp_dai, dai_tokens,
1195 ARRAY_SIZE(dai_tokens), private->array,
1196 le32_to_cpu(private->size));
1198 dev_err(sdev->dev, "error: parse dai tokens failed %d\n",
1199 le32_to_cpu(private->size));
1203 ret = sof_parse_tokens(scomp, &comp_dai.config, comp_tokens,
1204 ARRAY_SIZE(comp_tokens), private->array,
1205 le32_to_cpu(private->size));
1207 dev_err(sdev->dev, "error: parse dai.cfg tokens failed %d\n",
1212 dev_dbg(sdev->dev, "dai %s: type %d index %d\n",
1213 swidget->widget->name, comp_dai.type, comp_dai.dai_index);
1214 sof_dbg_comp_config(scomp, &comp_dai.config);
1216 ret = sof_ipc_tx_message(sdev->ipc, comp_dai.comp.hdr.cmd,
1217 &comp_dai, sizeof(comp_dai), r, sizeof(*r));
1219 if (ret == 0 && dai) {
1221 memcpy(&dai->comp_dai, &comp_dai, sizeof(comp_dai));
1231 static int sof_widget_load_buffer(struct snd_soc_component *scomp, int index,
1232 struct snd_sof_widget *swidget,
1233 struct snd_soc_tplg_dapm_widget *tw,
1234 struct sof_ipc_comp_reply *r)
1236 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1237 struct snd_soc_tplg_private *private = &tw->priv;
1238 struct sof_ipc_buffer *buffer;
1241 buffer = kzalloc(sizeof(*buffer), GFP_KERNEL);
1245 /* configure dai IPC message */
1246 buffer->comp.hdr.size = sizeof(*buffer);
1247 buffer->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_BUFFER_NEW;
1248 buffer->comp.id = swidget->comp_id;
1249 buffer->comp.type = SOF_COMP_BUFFER;
1250 buffer->comp.pipeline_id = index;
1252 ret = sof_parse_tokens(scomp, buffer, buffer_tokens,
1253 ARRAY_SIZE(buffer_tokens), private->array,
1254 le32_to_cpu(private->size));
1256 dev_err(sdev->dev, "error: parse buffer tokens failed %d\n",
1262 dev_dbg(sdev->dev, "buffer %s: size %d caps 0x%x\n",
1263 swidget->widget->name, buffer->size, buffer->caps);
1265 swidget->private = buffer;
1267 ret = sof_ipc_tx_message(sdev->ipc, buffer->comp.hdr.cmd, buffer,
1268 sizeof(*buffer), r, sizeof(*r));
1270 dev_err(sdev->dev, "error: buffer %s load failed\n",
1271 swidget->widget->name);
1278 /* bind PCM ID to host component ID */
1279 static int spcm_bind(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm,
1282 struct snd_sof_widget *host_widget;
1284 host_widget = snd_sof_find_swidget_sname(sdev,
1285 spcm->pcm.caps[dir].name,
1288 dev_err(sdev->dev, "can't find host comp to bind pcm\n");
1292 spcm->stream[dir].comp_id = host_widget->comp_id;
1301 static int sof_widget_load_pcm(struct snd_soc_component *scomp, int index,
1302 struct snd_sof_widget *swidget,
1303 enum sof_ipc_stream_direction dir,
1304 struct snd_soc_tplg_dapm_widget *tw,
1305 struct sof_ipc_comp_reply *r)
1307 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1308 struct snd_soc_tplg_private *private = &tw->priv;
1309 struct sof_ipc_comp_host *host;
1312 host = kzalloc(sizeof(*host), GFP_KERNEL);
1316 /* configure host comp IPC message */
1317 host->comp.hdr.size = sizeof(*host);
1318 host->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1319 host->comp.id = swidget->comp_id;
1320 host->comp.type = SOF_COMP_HOST;
1321 host->comp.pipeline_id = index;
1322 host->direction = dir;
1323 host->config.hdr.size = sizeof(host->config);
1325 ret = sof_parse_tokens(scomp, host, pcm_tokens,
1326 ARRAY_SIZE(pcm_tokens), private->array,
1327 le32_to_cpu(private->size));
1329 dev_err(sdev->dev, "error: parse host tokens failed %d\n",
1334 ret = sof_parse_tokens(scomp, &host->config, comp_tokens,
1335 ARRAY_SIZE(comp_tokens), private->array,
1336 le32_to_cpu(private->size));
1338 dev_err(sdev->dev, "error: parse host.cfg tokens failed %d\n",
1339 le32_to_cpu(private->size));
1343 dev_dbg(sdev->dev, "loaded host %s\n", swidget->widget->name);
1344 sof_dbg_comp_config(scomp, &host->config);
1346 swidget->private = host;
1348 ret = sof_ipc_tx_message(sdev->ipc, host->comp.hdr.cmd, host,
1349 sizeof(*host), r, sizeof(*r));
1360 int sof_load_pipeline_ipc(struct snd_sof_dev *sdev,
1361 struct sof_ipc_pipe_new *pipeline,
1362 struct sof_ipc_comp_reply *r)
1364 struct sof_ipc_pm_core_config pm_core_config;
1367 ret = sof_ipc_tx_message(sdev->ipc, pipeline->hdr.cmd, pipeline,
1368 sizeof(*pipeline), r, sizeof(*r));
1370 dev_err(sdev->dev, "error: load pipeline ipc failure\n");
1374 /* power up the core that this pipeline is scheduled on */
1375 ret = snd_sof_dsp_core_power_up(sdev, 1 << pipeline->core);
1377 dev_err(sdev->dev, "error: powering up pipeline schedule core %d\n",
1382 /* update enabled cores mask */
1383 sdev->enabled_cores_mask |= 1 << pipeline->core;
1386 * Now notify DSP that the core that this pipeline is scheduled on
1387 * has been powered up
1389 memset(&pm_core_config, 0, sizeof(pm_core_config));
1390 pm_core_config.enable_mask = sdev->enabled_cores_mask;
1392 /* configure CORE_ENABLE ipc message */
1393 pm_core_config.hdr.size = sizeof(pm_core_config);
1394 pm_core_config.hdr.cmd = SOF_IPC_GLB_PM_MSG | SOF_IPC_PM_CORE_ENABLE;
1397 ret = sof_ipc_tx_message(sdev->ipc, pm_core_config.hdr.cmd,
1398 &pm_core_config, sizeof(pm_core_config),
1399 &pm_core_config, sizeof(pm_core_config));
1401 dev_err(sdev->dev, "error: core enable ipc failure\n");
1406 static int sof_widget_load_pipeline(struct snd_soc_component *scomp,
1407 int index, struct snd_sof_widget *swidget,
1408 struct snd_soc_tplg_dapm_widget *tw,
1409 struct sof_ipc_comp_reply *r)
1411 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1412 struct snd_soc_tplg_private *private = &tw->priv;
1413 struct sof_ipc_pipe_new *pipeline;
1414 struct snd_sof_widget *comp_swidget;
1417 pipeline = kzalloc(sizeof(*pipeline), GFP_KERNEL);
1421 /* configure dai IPC message */
1422 pipeline->hdr.size = sizeof(*pipeline);
1423 pipeline->hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_PIPE_NEW;
1424 pipeline->pipeline_id = index;
1425 pipeline->comp_id = swidget->comp_id;
1427 /* component at start of pipeline is our stream id */
1428 comp_swidget = snd_sof_find_swidget(sdev, tw->sname);
1429 if (!comp_swidget) {
1430 dev_err(sdev->dev, "error: widget %s refers to non existent widget %s\n",
1431 tw->name, tw->sname);
1436 pipeline->sched_id = comp_swidget->comp_id;
1438 dev_dbg(sdev->dev, "tplg: pipeline id %d comp %d scheduling comp id %d\n",
1439 pipeline->pipeline_id, pipeline->comp_id, pipeline->sched_id);
1441 ret = sof_parse_tokens(scomp, pipeline, sched_tokens,
1442 ARRAY_SIZE(sched_tokens), private->array,
1443 le32_to_cpu(private->size));
1445 dev_err(sdev->dev, "error: parse pipeline tokens failed %d\n",
1450 dev_dbg(sdev->dev, "pipeline %s: period %d pri %d mips %d core %d frames %d\n",
1451 swidget->widget->name, pipeline->period, pipeline->priority,
1452 pipeline->period_mips, pipeline->core, pipeline->frames_per_sched);
1454 swidget->private = pipeline;
1456 /* send ipc's to create pipeline comp and power up schedule core */
1457 ret = sof_load_pipeline_ipc(sdev, pipeline, r);
1469 static int sof_widget_load_mixer(struct snd_soc_component *scomp, int index,
1470 struct snd_sof_widget *swidget,
1471 struct snd_soc_tplg_dapm_widget *tw,
1472 struct sof_ipc_comp_reply *r)
1474 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1475 struct snd_soc_tplg_private *private = &tw->priv;
1476 struct sof_ipc_comp_mixer *mixer;
1479 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
1483 /* configure mixer IPC message */
1484 mixer->comp.hdr.size = sizeof(*mixer);
1485 mixer->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1486 mixer->comp.id = swidget->comp_id;
1487 mixer->comp.type = SOF_COMP_MIXER;
1488 mixer->comp.pipeline_id = index;
1489 mixer->config.hdr.size = sizeof(mixer->config);
1491 ret = sof_parse_tokens(scomp, &mixer->config, comp_tokens,
1492 ARRAY_SIZE(comp_tokens), private->array,
1493 le32_to_cpu(private->size));
1495 dev_err(sdev->dev, "error: parse mixer.cfg tokens failed %d\n",
1501 sof_dbg_comp_config(scomp, &mixer->config);
1503 swidget->private = mixer;
1505 ret = sof_ipc_tx_message(sdev->ipc, mixer->comp.hdr.cmd, mixer,
1506 sizeof(*mixer), r, sizeof(*r));
1516 static int sof_widget_load_mux(struct snd_soc_component *scomp, int index,
1517 struct snd_sof_widget *swidget,
1518 struct snd_soc_tplg_dapm_widget *tw,
1519 struct sof_ipc_comp_reply *r)
1521 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1522 struct snd_soc_tplg_private *private = &tw->priv;
1523 struct sof_ipc_comp_mux *mux;
1526 mux = kzalloc(sizeof(*mux), GFP_KERNEL);
1530 /* configure mux IPC message */
1531 mux->comp.hdr.size = sizeof(*mux);
1532 mux->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1533 mux->comp.id = swidget->comp_id;
1534 mux->comp.type = SOF_COMP_MUX;
1535 mux->comp.pipeline_id = index;
1536 mux->config.hdr.size = sizeof(mux->config);
1538 ret = sof_parse_tokens(scomp, &mux->config, comp_tokens,
1539 ARRAY_SIZE(comp_tokens), private->array,
1540 le32_to_cpu(private->size));
1542 dev_err(sdev->dev, "error: parse mux.cfg tokens failed %d\n",
1548 sof_dbg_comp_config(scomp, &mux->config);
1550 swidget->private = mux;
1552 ret = sof_ipc_tx_message(sdev->ipc, mux->comp.hdr.cmd, mux,
1553 sizeof(*mux), r, sizeof(*r));
1564 static int sof_widget_load_pga(struct snd_soc_component *scomp, int index,
1565 struct snd_sof_widget *swidget,
1566 struct snd_soc_tplg_dapm_widget *tw,
1567 struct sof_ipc_comp_reply *r)
1569 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1570 struct snd_soc_tplg_private *private = &tw->priv;
1571 struct sof_ipc_comp_volume *volume;
1572 struct snd_sof_control *scontrol;
1577 volume = kzalloc(sizeof(*volume), GFP_KERNEL);
1581 if (le32_to_cpu(tw->num_kcontrols) != 1) {
1582 dev_err(sdev->dev, "error: invalid kcontrol count %d for volume\n",
1588 /* configure volume IPC message */
1589 volume->comp.hdr.size = sizeof(*volume);
1590 volume->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1591 volume->comp.id = swidget->comp_id;
1592 volume->comp.type = SOF_COMP_VOLUME;
1593 volume->comp.pipeline_id = index;
1594 volume->config.hdr.size = sizeof(volume->config);
1596 ret = sof_parse_tokens(scomp, volume, volume_tokens,
1597 ARRAY_SIZE(volume_tokens), private->array,
1598 le32_to_cpu(private->size));
1600 dev_err(sdev->dev, "error: parse volume tokens failed %d\n",
1604 ret = sof_parse_tokens(scomp, &volume->config, comp_tokens,
1605 ARRAY_SIZE(comp_tokens), private->array,
1606 le32_to_cpu(private->size));
1608 dev_err(sdev->dev, "error: parse volume.cfg tokens failed %d\n",
1609 le32_to_cpu(private->size));
1613 sof_dbg_comp_config(scomp, &volume->config);
1615 swidget->private = volume;
1617 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
1618 if (scontrol->comp_id == swidget->comp_id) {
1619 min_step = scontrol->min_volume_step;
1620 max_step = scontrol->max_volume_step;
1621 volume->min_value = scontrol->volume_table[min_step];
1622 volume->max_value = scontrol->volume_table[max_step];
1623 volume->channels = scontrol->num_channels;
1628 ret = sof_ipc_tx_message(sdev->ipc, volume->comp.hdr.cmd, volume,
1629 sizeof(*volume), r, sizeof(*r));
1641 static int sof_widget_load_src(struct snd_soc_component *scomp, int index,
1642 struct snd_sof_widget *swidget,
1643 struct snd_soc_tplg_dapm_widget *tw,
1644 struct sof_ipc_comp_reply *r)
1646 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1647 struct snd_soc_tplg_private *private = &tw->priv;
1648 struct sof_ipc_comp_src *src;
1651 src = kzalloc(sizeof(*src), GFP_KERNEL);
1655 /* configure src IPC message */
1656 src->comp.hdr.size = sizeof(*src);
1657 src->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1658 src->comp.id = swidget->comp_id;
1659 src->comp.type = SOF_COMP_SRC;
1660 src->comp.pipeline_id = index;
1661 src->config.hdr.size = sizeof(src->config);
1663 ret = sof_parse_tokens(scomp, src, src_tokens,
1664 ARRAY_SIZE(src_tokens), private->array,
1665 le32_to_cpu(private->size));
1667 dev_err(sdev->dev, "error: parse src tokens failed %d\n",
1672 ret = sof_parse_tokens(scomp, &src->config, comp_tokens,
1673 ARRAY_SIZE(comp_tokens), private->array,
1674 le32_to_cpu(private->size));
1676 dev_err(sdev->dev, "error: parse src.cfg tokens failed %d\n",
1677 le32_to_cpu(private->size));
1681 dev_dbg(sdev->dev, "src %s: source rate %d sink rate %d\n",
1682 swidget->widget->name, src->source_rate, src->sink_rate);
1683 sof_dbg_comp_config(scomp, &src->config);
1685 swidget->private = src;
1687 ret = sof_ipc_tx_message(sdev->ipc, src->comp.hdr.cmd, src,
1688 sizeof(*src), r, sizeof(*r));
1697 * Signal Generator Topology
1700 static int sof_widget_load_siggen(struct snd_soc_component *scomp, int index,
1701 struct snd_sof_widget *swidget,
1702 struct snd_soc_tplg_dapm_widget *tw,
1703 struct sof_ipc_comp_reply *r)
1705 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1706 struct snd_soc_tplg_private *private = &tw->priv;
1707 struct sof_ipc_comp_tone *tone;
1710 tone = kzalloc(sizeof(*tone), GFP_KERNEL);
1714 /* configure siggen IPC message */
1715 tone->comp.hdr.size = sizeof(*tone);
1716 tone->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1717 tone->comp.id = swidget->comp_id;
1718 tone->comp.type = SOF_COMP_TONE;
1719 tone->comp.pipeline_id = index;
1720 tone->config.hdr.size = sizeof(tone->config);
1722 ret = sof_parse_tokens(scomp, tone, tone_tokens,
1723 ARRAY_SIZE(tone_tokens), private->array,
1724 le32_to_cpu(private->size));
1726 dev_err(sdev->dev, "error: parse tone tokens failed %d\n",
1727 le32_to_cpu(private->size));
1731 ret = sof_parse_tokens(scomp, &tone->config, comp_tokens,
1732 ARRAY_SIZE(comp_tokens), private->array,
1733 le32_to_cpu(private->size));
1735 dev_err(sdev->dev, "error: parse tone.cfg tokens failed %d\n",
1736 le32_to_cpu(private->size));
1740 dev_dbg(sdev->dev, "tone %s: frequency %d amplitude %d\n",
1741 swidget->widget->name, tone->frequency, tone->amplitude);
1742 sof_dbg_comp_config(scomp, &tone->config);
1744 swidget->private = tone;
1746 ret = sof_ipc_tx_message(sdev->ipc, tone->comp.hdr.cmd, tone,
1747 sizeof(*tone), r, sizeof(*r));
1755 static int sof_get_control_data(struct snd_sof_dev *sdev,
1756 struct snd_soc_dapm_widget *widget,
1757 struct sof_widget_data *wdata,
1760 const struct snd_kcontrol_new *kc;
1761 struct soc_mixer_control *sm;
1762 struct soc_bytes_ext *sbe;
1763 struct soc_enum *se;
1768 for (i = 0; i < widget->num_kcontrols; i++) {
1769 kc = &widget->kcontrol_news[i];
1771 switch (widget->dobj.widget.kcontrol_type) {
1772 case SND_SOC_TPLG_TYPE_MIXER:
1773 sm = (struct soc_mixer_control *)kc->private_value;
1774 wdata[i].control = sm->dobj.private;
1776 case SND_SOC_TPLG_TYPE_BYTES:
1777 sbe = (struct soc_bytes_ext *)kc->private_value;
1778 wdata[i].control = sbe->dobj.private;
1780 case SND_SOC_TPLG_TYPE_ENUM:
1781 se = (struct soc_enum *)kc->private_value;
1782 wdata[i].control = se->dobj.private;
1785 dev_err(sdev->dev, "error: unknown kcontrol type %d in widget %s\n",
1786 widget->dobj.widget.kcontrol_type,
1791 if (!wdata[i].control) {
1792 dev_err(sdev->dev, "error: no scontrol for widget %s\n",
1797 wdata[i].pdata = wdata[i].control->control_data->data;
1798 if (!wdata[i].pdata)
1801 /* make sure data is valid - data can be updated at runtime */
1802 if (wdata[i].pdata->magic != SOF_ABI_MAGIC)
1805 *size += wdata[i].pdata->size;
1808 switch (wdata[i].control->cmd) {
1809 case SOF_CTRL_CMD_VOLUME:
1810 case SOF_CTRL_CMD_ENUM:
1811 case SOF_CTRL_CMD_SWITCH:
1812 wdata[i].ipc_cmd = SOF_IPC_COMP_SET_VALUE;
1813 wdata[i].ctrl_type = SOF_CTRL_TYPE_VALUE_CHAN_SET;
1815 case SOF_CTRL_CMD_BINARY:
1816 wdata[i].ipc_cmd = SOF_IPC_COMP_SET_DATA;
1817 wdata[i].ctrl_type = SOF_CTRL_TYPE_DATA_SET;
1827 static int sof_process_load(struct snd_soc_component *scomp, int index,
1828 struct snd_sof_widget *swidget,
1829 struct snd_soc_tplg_dapm_widget *tw,
1830 struct sof_ipc_comp_reply *r,
1833 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1834 struct snd_soc_dapm_widget *widget = swidget->widget;
1835 struct snd_soc_tplg_private *private = &tw->priv;
1836 struct sof_ipc_comp_process *process = NULL;
1837 struct sof_widget_data *wdata = NULL;
1838 size_t ipc_data_size = 0;
1844 if (type == SOF_COMP_NONE) {
1845 dev_err(sdev->dev, "error: invalid process comp type %d\n",
1850 /* allocate struct for widget control data sizes and types */
1851 if (widget->num_kcontrols) {
1852 wdata = kcalloc(widget->num_kcontrols,
1859 /* get possible component controls and get size of all pdata */
1860 ret = sof_get_control_data(sdev, widget, wdata,
1867 ipc_size = sizeof(struct sof_ipc_comp_process) +
1868 le32_to_cpu(private->size) +
1871 /* we are exceeding max ipc size, config needs to be sent separately */
1872 if (ipc_size > SOF_IPC_MSG_MAX_SIZE) {
1873 ipc_size -= ipc_data_size;
1877 process = kzalloc(ipc_size, GFP_KERNEL);
1883 /* configure iir IPC message */
1884 process->comp.hdr.size = ipc_size;
1885 process->comp.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_NEW;
1886 process->comp.id = swidget->comp_id;
1887 process->comp.type = type;
1888 process->comp.pipeline_id = index;
1889 process->config.hdr.size = sizeof(process->config);
1891 ret = sof_parse_tokens(scomp, &process->config, comp_tokens,
1892 ARRAY_SIZE(comp_tokens), private->array,
1893 le32_to_cpu(private->size));
1895 dev_err(sdev->dev, "error: parse process.cfg tokens failed %d\n",
1896 le32_to_cpu(private->size));
1900 sof_dbg_comp_config(scomp, &process->config);
1903 * found private data in control, so copy it.
1904 * get possible component controls - get size of all pdata,
1905 * then memcpy with headers
1907 if (ipc_data_size) {
1908 for (i = 0; i < widget->num_kcontrols; i++) {
1909 memcpy(&process->data + offset,
1910 wdata[i].pdata->data,
1911 wdata[i].pdata->size);
1912 offset += wdata[i].pdata->size;
1916 process->size = ipc_data_size;
1917 swidget->private = process;
1919 ret = sof_ipc_tx_message(sdev->ipc, process->comp.hdr.cmd, process,
1920 ipc_size, r, sizeof(*r));
1923 dev_err(sdev->dev, "error: create process failed\n");
1927 /* we sent the data in single message so return */
1931 /* send control data with large message supported method */
1932 for (i = 0; i < widget->num_kcontrols; i++) {
1933 wdata[i].control->readback_offset = 0;
1934 ret = snd_sof_ipc_set_get_comp_data(sdev->ipc, wdata[i].control,
1937 wdata[i].control->cmd,
1940 dev_err(sdev->dev, "error: send control failed\n");
1954 * Processing Component Topology - can be "effect", "codec", or general
1958 static int sof_widget_load_process(struct snd_soc_component *scomp, int index,
1959 struct snd_sof_widget *swidget,
1960 struct snd_soc_tplg_dapm_widget *tw,
1961 struct sof_ipc_comp_reply *r)
1963 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1964 struct snd_soc_tplg_private *private = &tw->priv;
1965 struct sof_ipc_comp_process config;
1968 /* check we have some tokens - we need at least process type */
1969 if (le32_to_cpu(private->size) == 0) {
1970 dev_err(sdev->dev, "error: process tokens not found\n");
1974 memset(&config, 0, sizeof(config));
1976 /* get the process token */
1977 ret = sof_parse_tokens(scomp, &config, process_tokens,
1978 ARRAY_SIZE(process_tokens), private->array,
1979 le32_to_cpu(private->size));
1981 dev_err(sdev->dev, "error: parse process tokens failed %d\n",
1982 le32_to_cpu(private->size));
1986 /* now load process specific data and send IPC */
1987 ret = sof_process_load(scomp, index, swidget, tw, r,
1988 find_process_comp_type(config.type));
1990 dev_err(sdev->dev, "error: process loading failed\n");
1997 static int sof_widget_bind_event(struct snd_sof_dev *sdev,
1998 struct snd_sof_widget *swidget,
2001 struct sof_ipc_comp *ipc_comp;
2003 /* validate widget event type */
2004 switch (event_type) {
2005 case SOF_KEYWORD_DETECT_DAPM_EVENT:
2006 /* only KEYWORD_DETECT comps should handle this */
2007 if (swidget->id != snd_soc_dapm_effect)
2010 ipc_comp = swidget->private;
2011 if (ipc_comp && ipc_comp->type != SOF_COMP_KEYWORD_DETECT)
2014 /* bind event to keyword detect comp */
2015 return snd_soc_tplg_widget_bind_event(swidget->widget,
2017 ARRAY_SIZE(sof_kwd_events),
2024 "error: invalid event type %d for widget %s\n",
2025 event_type, swidget->widget->name);
2029 /* external widget init - used for any driver specific init */
2030 static int sof_widget_ready(struct snd_soc_component *scomp, int index,
2031 struct snd_soc_dapm_widget *w,
2032 struct snd_soc_tplg_dapm_widget *tw)
2034 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2035 struct snd_sof_widget *swidget;
2036 struct snd_sof_dai *dai;
2037 struct sof_ipc_comp_reply reply;
2038 struct snd_sof_control *scontrol;
2041 swidget = kzalloc(sizeof(*swidget), GFP_KERNEL);
2045 swidget->sdev = sdev;
2046 swidget->widget = w;
2047 swidget->comp_id = sdev->next_comp_id++;
2048 swidget->complete = 0;
2049 swidget->id = w->id;
2050 swidget->pipeline_id = index;
2051 swidget->private = NULL;
2052 memset(&reply, 0, sizeof(reply));
2054 dev_dbg(sdev->dev, "tplg: ready widget id %d pipe %d type %d name : %s stream %s\n",
2055 swidget->comp_id, index, swidget->id, tw->name,
2056 strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
2057 ? tw->sname : "none");
2059 /* handle any special case widgets */
2061 case snd_soc_dapm_dai_in:
2062 case snd_soc_dapm_dai_out:
2063 dai = kzalloc(sizeof(*dai), GFP_KERNEL);
2069 ret = sof_widget_load_dai(scomp, index, swidget, tw, &reply,
2072 sof_connect_dai_widget(scomp, w, tw, dai);
2073 list_add(&dai->list, &sdev->dai_list);
2074 swidget->private = dai;
2079 case snd_soc_dapm_mixer:
2080 ret = sof_widget_load_mixer(scomp, index, swidget, tw, &reply);
2082 case snd_soc_dapm_pga:
2083 ret = sof_widget_load_pga(scomp, index, swidget, tw, &reply);
2084 /* Find scontrol for this pga and set readback offset*/
2085 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
2086 if (scontrol->comp_id == swidget->comp_id) {
2087 scontrol->readback_offset = reply.offset;
2092 case snd_soc_dapm_buffer:
2093 ret = sof_widget_load_buffer(scomp, index, swidget, tw, &reply);
2095 case snd_soc_dapm_scheduler:
2096 ret = sof_widget_load_pipeline(scomp, index, swidget, tw,
2099 case snd_soc_dapm_aif_out:
2100 ret = sof_widget_load_pcm(scomp, index, swidget,
2101 SOF_IPC_STREAM_CAPTURE, tw, &reply);
2103 case snd_soc_dapm_aif_in:
2104 ret = sof_widget_load_pcm(scomp, index, swidget,
2105 SOF_IPC_STREAM_PLAYBACK, tw, &reply);
2107 case snd_soc_dapm_src:
2108 ret = sof_widget_load_src(scomp, index, swidget, tw, &reply);
2110 case snd_soc_dapm_siggen:
2111 ret = sof_widget_load_siggen(scomp, index, swidget, tw, &reply);
2113 case snd_soc_dapm_effect:
2114 ret = sof_widget_load_process(scomp, index, swidget, tw,
2117 case snd_soc_dapm_mux:
2118 case snd_soc_dapm_demux:
2119 ret = sof_widget_load_mux(scomp, index, swidget, tw, &reply);
2121 case snd_soc_dapm_switch:
2122 case snd_soc_dapm_dai_link:
2123 case snd_soc_dapm_kcontrol:
2125 dev_warn(sdev->dev, "warning: widget type %d name %s not handled\n",
2126 swidget->id, tw->name);
2130 /* check IPC reply */
2131 if (ret < 0 || reply.rhdr.error < 0) {
2133 "error: DSP failed to add widget id %d type %d name : %s stream %s reply %d\n",
2134 tw->shift, swidget->id, tw->name,
2135 strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
2136 ? tw->sname : "none", reply.rhdr.error);
2141 /* bind widget to external event */
2142 if (tw->event_type) {
2143 ret = sof_widget_bind_event(sdev, swidget,
2144 le16_to_cpu(tw->event_type));
2146 dev_err(sdev->dev, "error: widget event binding failed\n");
2147 kfree(swidget->private);
2153 w->dobj.private = swidget;
2154 list_add(&swidget->list, &sdev->widget_list);
2158 static int sof_route_unload(struct snd_soc_component *scomp,
2159 struct snd_soc_dobj *dobj)
2161 struct snd_sof_route *sroute;
2163 sroute = dobj->private;
2167 /* free sroute and its private data */
2168 kfree(sroute->private);
2169 list_del(&sroute->list);
2175 static int sof_widget_unload(struct snd_soc_component *scomp,
2176 struct snd_soc_dobj *dobj)
2178 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2179 const struct snd_kcontrol_new *kc;
2180 struct snd_soc_dapm_widget *widget;
2181 struct sof_ipc_pipe_new *pipeline;
2182 struct snd_sof_control *scontrol;
2183 struct snd_sof_widget *swidget;
2184 struct soc_mixer_control *sm;
2185 struct soc_bytes_ext *sbe;
2186 struct snd_sof_dai *dai;
2187 struct soc_enum *se;
2191 swidget = dobj->private;
2195 widget = swidget->widget;
2197 switch (swidget->id) {
2198 case snd_soc_dapm_dai_in:
2199 case snd_soc_dapm_dai_out:
2200 dai = swidget->private;
2203 /* free dai config */
2204 kfree(dai->dai_config);
2205 list_del(&dai->list);
2208 case snd_soc_dapm_scheduler:
2210 /* power down the pipeline schedule core */
2211 pipeline = swidget->private;
2212 ret = snd_sof_dsp_core_power_down(sdev, 1 << pipeline->core);
2214 dev_err(sdev->dev, "error: powering down pipeline schedule core %d\n",
2217 /* update enabled cores mask */
2218 sdev->enabled_cores_mask &= ~(1 << pipeline->core);
2224 for (i = 0; i < widget->num_kcontrols; i++) {
2225 kc = &widget->kcontrol_news[i];
2226 switch (dobj->widget.kcontrol_type) {
2227 case SND_SOC_TPLG_TYPE_MIXER:
2228 sm = (struct soc_mixer_control *)kc->private_value;
2229 scontrol = sm->dobj.private;
2231 kfree(scontrol->volume_table);
2233 case SND_SOC_TPLG_TYPE_ENUM:
2234 se = (struct soc_enum *)kc->private_value;
2235 scontrol = se->dobj.private;
2237 case SND_SOC_TPLG_TYPE_BYTES:
2238 sbe = (struct soc_bytes_ext *)kc->private_value;
2239 scontrol = sbe->dobj.private;
2242 dev_warn(sdev->dev, "unsupported kcontrol_type\n");
2245 kfree(scontrol->control_data);
2246 list_del(&scontrol->list);
2251 /* free private value */
2252 kfree(swidget->private);
2254 /* remove and free swidget object */
2255 list_del(&swidget->list);
2262 * DAI HW configuration.
2265 /* FE DAI - used for any driver specific init */
2266 static int sof_dai_load(struct snd_soc_component *scomp, int index,
2267 struct snd_soc_dai_driver *dai_drv,
2268 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
2270 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2271 struct snd_soc_tplg_stream_caps *caps;
2272 struct snd_sof_pcm *spcm;
2273 int stream = SNDRV_PCM_STREAM_PLAYBACK;
2276 /* nothing to do for BEs atm */
2280 spcm = kzalloc(sizeof(*spcm), GFP_KERNEL);
2285 spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].comp_id = COMP_ID_UNASSIGNED;
2286 spcm->stream[SNDRV_PCM_STREAM_CAPTURE].comp_id = COMP_ID_UNASSIGNED;
2290 dev_dbg(sdev->dev, "tplg: load pcm %s\n", pcm->dai_name);
2292 dai_drv->dobj.private = spcm;
2293 list_add(&spcm->list, &sdev->pcm_list);
2295 /* do we need to allocate playback PCM DMA pages */
2296 if (!spcm->pcm.playback)
2299 caps = &spcm->pcm.caps[stream];
2301 /* allocate playback page table buffer */
2302 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
2303 PAGE_SIZE, &spcm->stream[stream].page_table);
2305 dev_err(sdev->dev, "error: can't alloc page table for %s %d\n",
2311 /* bind pcm to host comp */
2312 ret = spcm_bind(sdev, spcm, stream);
2315 "error: can't bind pcm to host\n");
2316 goto free_playback_tables;
2320 stream = SNDRV_PCM_STREAM_CAPTURE;
2322 /* do we need to allocate capture PCM DMA pages */
2323 if (!spcm->pcm.capture)
2326 caps = &spcm->pcm.caps[stream];
2328 /* allocate capture page table buffer */
2329 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
2330 PAGE_SIZE, &spcm->stream[stream].page_table);
2332 dev_err(sdev->dev, "error: can't alloc page table for %s %d\n",
2334 goto free_playback_tables;
2337 /* bind pcm to host comp */
2338 ret = spcm_bind(sdev, spcm, stream);
2341 "error: can't bind pcm to host\n");
2342 snd_dma_free_pages(&spcm->stream[stream].page_table);
2343 goto free_playback_tables;
2348 free_playback_tables:
2349 if (spcm->pcm.playback)
2350 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
2355 static int sof_dai_unload(struct snd_soc_component *scomp,
2356 struct snd_soc_dobj *dobj)
2358 struct snd_sof_pcm *spcm = dobj->private;
2360 /* free PCM DMA pages */
2361 if (spcm->pcm.playback)
2362 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
2364 if (spcm->pcm.capture)
2365 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_CAPTURE].page_table);
2367 /* remove from list and free spcm */
2368 list_del(&spcm->list);
2374 static void sof_dai_set_format(struct snd_soc_tplg_hw_config *hw_config,
2375 struct sof_ipc_dai_config *config)
2377 /* clock directions wrt codec */
2378 if (hw_config->bclk_master == SND_SOC_TPLG_BCLK_CM) {
2379 /* codec is bclk master */
2380 if (hw_config->fsync_master == SND_SOC_TPLG_FSYNC_CM)
2381 config->format |= SOF_DAI_FMT_CBM_CFM;
2383 config->format |= SOF_DAI_FMT_CBM_CFS;
2385 /* codec is bclk slave */
2386 if (hw_config->fsync_master == SND_SOC_TPLG_FSYNC_CM)
2387 config->format |= SOF_DAI_FMT_CBS_CFM;
2389 config->format |= SOF_DAI_FMT_CBS_CFS;
2392 /* inverted clocks ? */
2393 if (hw_config->invert_bclk) {
2394 if (hw_config->invert_fsync)
2395 config->format |= SOF_DAI_FMT_IB_IF;
2397 config->format |= SOF_DAI_FMT_IB_NF;
2399 if (hw_config->invert_fsync)
2400 config->format |= SOF_DAI_FMT_NB_IF;
2402 config->format |= SOF_DAI_FMT_NB_NF;
2406 /* set config for all DAI's with name matching the link name */
2407 static int sof_set_dai_config(struct snd_sof_dev *sdev, u32 size,
2408 struct snd_soc_dai_link *link,
2409 struct sof_ipc_dai_config *config)
2411 struct snd_sof_dai *dai;
2414 list_for_each_entry(dai, &sdev->dai_list, list) {
2418 if (strcmp(link->name, dai->name) == 0) {
2419 dai->dai_config = kmemdup(config, size, GFP_KERNEL);
2420 if (!dai->dai_config)
2423 /* set cpu_dai_name */
2424 dai->cpu_dai_name = link->cpus->dai_name;
2431 * machine driver may define a dai link with playback and capture
2432 * dai enabled, but the dai link in topology would support both, one
2433 * or none of them. Here print a warning message to notify user
2436 dev_warn(sdev->dev, "warning: failed to find dai for dai link %s",
2443 static int sof_link_ssp_load(struct snd_soc_component *scomp, int index,
2444 struct snd_soc_dai_link *link,
2445 struct snd_soc_tplg_link_config *cfg,
2446 struct snd_soc_tplg_hw_config *hw_config,
2447 struct sof_ipc_dai_config *config)
2449 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2450 struct snd_soc_tplg_private *private = &cfg->priv;
2451 struct sof_ipc_reply reply;
2452 u32 size = sizeof(*config);
2455 /* handle master/slave and inverted clocks */
2456 sof_dai_set_format(hw_config, config);
2459 memset(&config->ssp, 0, sizeof(struct sof_ipc_dai_ssp_params));
2460 config->hdr.size = size;
2462 ret = sof_parse_tokens(scomp, &config->ssp, ssp_tokens,
2463 ARRAY_SIZE(ssp_tokens), private->array,
2464 le32_to_cpu(private->size));
2466 dev_err(sdev->dev, "error: parse ssp tokens failed %d\n",
2467 le32_to_cpu(private->size));
2471 config->ssp.mclk_rate = le32_to_cpu(hw_config->mclk_rate);
2472 config->ssp.bclk_rate = le32_to_cpu(hw_config->bclk_rate);
2473 config->ssp.fsync_rate = le32_to_cpu(hw_config->fsync_rate);
2474 config->ssp.tdm_slots = le32_to_cpu(hw_config->tdm_slots);
2475 config->ssp.tdm_slot_width = le32_to_cpu(hw_config->tdm_slot_width);
2476 config->ssp.mclk_direction = hw_config->mclk_direction;
2477 config->ssp.rx_slots = le32_to_cpu(hw_config->rx_slots);
2478 config->ssp.tx_slots = le32_to_cpu(hw_config->tx_slots);
2480 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",
2481 config->dai_index, config->format,
2482 config->ssp.mclk_rate, config->ssp.bclk_rate,
2483 config->ssp.fsync_rate, config->ssp.sample_valid_bits,
2484 config->ssp.tdm_slot_width, config->ssp.tdm_slots,
2485 config->ssp.mclk_id, config->ssp.quirks);
2487 /* validate SSP fsync rate and channel count */
2488 if (config->ssp.fsync_rate < 8000 || config->ssp.fsync_rate > 192000) {
2489 dev_err(sdev->dev, "error: invalid fsync rate for SSP%d\n",
2494 if (config->ssp.tdm_slots < 1 || config->ssp.tdm_slots > 8) {
2495 dev_err(sdev->dev, "error: invalid channel count for SSP%d\n",
2500 /* send message to DSP */
2501 ret = sof_ipc_tx_message(sdev->ipc,
2502 config->hdr.cmd, config, size, &reply,
2506 dev_err(sdev->dev, "error: failed to set DAI config for SSP%d\n",
2511 /* set config for all DAI's with name matching the link name */
2512 ret = sof_set_dai_config(sdev, size, link, config);
2514 dev_err(sdev->dev, "error: failed to save DAI config for SSP%d\n",
2520 static int sof_link_sai_load(struct snd_soc_component *scomp, int index,
2521 struct snd_soc_dai_link *link,
2522 struct snd_soc_tplg_link_config *cfg,
2523 struct snd_soc_tplg_hw_config *hw_config,
2524 struct sof_ipc_dai_config *config)
2526 /*TODO: Add implementation */
2530 static int sof_link_esai_load(struct snd_soc_component *scomp, int index,
2531 struct snd_soc_dai_link *link,
2532 struct snd_soc_tplg_link_config *cfg,
2533 struct snd_soc_tplg_hw_config *hw_config,
2534 struct sof_ipc_dai_config *config)
2536 /*TODO: Add implementation */
2540 static int sof_link_dmic_load(struct snd_soc_component *scomp, int index,
2541 struct snd_soc_dai_link *link,
2542 struct snd_soc_tplg_link_config *cfg,
2543 struct snd_soc_tplg_hw_config *hw_config,
2544 struct sof_ipc_dai_config *config)
2546 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2547 struct snd_soc_tplg_private *private = &cfg->priv;
2548 struct sof_ipc_dai_config *ipc_config;
2549 struct sof_ipc_reply reply;
2550 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
2551 struct sof_ipc_fw_version *v = &ready->version;
2556 * config is only used for the common params in dmic_params structure
2557 * that does not include the PDM controller config array
2558 * Set the common params to 0.
2560 memset(&config->dmic, 0, sizeof(struct sof_ipc_dai_dmic_params));
2562 /* get DMIC tokens */
2563 ret = sof_parse_tokens(scomp, &config->dmic, dmic_tokens,
2564 ARRAY_SIZE(dmic_tokens), private->array,
2565 le32_to_cpu(private->size));
2567 dev_err(sdev->dev, "error: parse dmic tokens failed %d\n",
2568 le32_to_cpu(private->size));
2573 * allocate memory for dmic dai config accounting for the
2574 * variable number of active pdm controllers
2575 * This will be the ipc payload for setting dai config
2577 size = sizeof(*config) + sizeof(struct sof_ipc_dai_dmic_pdm_ctrl) *
2578 config->dmic.num_pdm_active;
2580 ipc_config = kzalloc(size, GFP_KERNEL);
2584 /* copy the common dai config and dmic params */
2585 memcpy(ipc_config, config, sizeof(*config));
2588 * alloc memory for private member
2589 * Used to track the pdm config array index currently being parsed
2591 sdev->private = kzalloc(sizeof(u32), GFP_KERNEL);
2592 if (!sdev->private) {
2597 /* get DMIC PDM tokens */
2598 ret = sof_parse_tokens(scomp, &ipc_config->dmic.pdm[0], dmic_pdm_tokens,
2599 ARRAY_SIZE(dmic_pdm_tokens), private->array,
2600 le32_to_cpu(private->size));
2602 dev_err(sdev->dev, "error: parse dmic pdm tokens failed %d\n",
2603 le32_to_cpu(private->size));
2607 /* set IPC header size */
2608 ipc_config->hdr.size = size;
2610 /* debug messages */
2611 dev_dbg(sdev->dev, "tplg: config DMIC%d driver version %d\n",
2612 ipc_config->dai_index, ipc_config->dmic.driver_ipc_version);
2613 dev_dbg(sdev->dev, "pdmclk_min %d pdm_clkmax %d duty_min %hd\n",
2614 ipc_config->dmic.pdmclk_min, ipc_config->dmic.pdmclk_max,
2615 ipc_config->dmic.duty_min);
2616 dev_dbg(sdev->dev, "duty_max %hd fifo_fs %d num_pdms active %d\n",
2617 ipc_config->dmic.duty_max, ipc_config->dmic.fifo_fs,
2618 ipc_config->dmic.num_pdm_active);
2619 dev_dbg(sdev->dev, "fifo word length %hd\n",
2620 ipc_config->dmic.fifo_bits);
2622 for (j = 0; j < ipc_config->dmic.num_pdm_active; j++) {
2623 dev_dbg(sdev->dev, "pdm %hd mic a %hd mic b %hd\n",
2624 ipc_config->dmic.pdm[j].id,
2625 ipc_config->dmic.pdm[j].enable_mic_a,
2626 ipc_config->dmic.pdm[j].enable_mic_b);
2627 dev_dbg(sdev->dev, "pdm %hd polarity a %hd polarity b %hd\n",
2628 ipc_config->dmic.pdm[j].id,
2629 ipc_config->dmic.pdm[j].polarity_mic_a,
2630 ipc_config->dmic.pdm[j].polarity_mic_b);
2631 dev_dbg(sdev->dev, "pdm %hd clk_edge %hd skew %hd\n",
2632 ipc_config->dmic.pdm[j].id,
2633 ipc_config->dmic.pdm[j].clk_edge,
2634 ipc_config->dmic.pdm[j].skew);
2637 if (SOF_ABI_VER(v->major, v->minor, v->micro) < SOF_ABI_VER(3, 0, 1)) {
2638 /* this takes care of backwards compatible handling of fifo_bits_b */
2639 ipc_config->dmic.reserved_2 = ipc_config->dmic.fifo_bits;
2642 /* send message to DSP */
2643 ret = sof_ipc_tx_message(sdev->ipc,
2644 ipc_config->hdr.cmd, ipc_config, size, &reply,
2649 "error: failed to set DAI config for DMIC%d\n",
2654 /* set config for all DAI's with name matching the link name */
2655 ret = sof_set_dai_config(sdev, size, link, ipc_config);
2657 dev_err(sdev->dev, "error: failed to save DAI config for DMIC%d\n",
2661 kfree(sdev->private);
2668 * for hda link, playback and capture are supported by different dai
2669 * in FW. Here get the dai_index, set dma channel of each dai
2670 * and send config to FW. In FW, each dai sets config by dai_index
2672 static int sof_link_hda_process(struct snd_sof_dev *sdev,
2673 struct snd_soc_dai_link *link,
2674 struct sof_ipc_dai_config *config)
2676 struct sof_ipc_reply reply;
2677 u32 size = sizeof(*config);
2678 struct snd_sof_dai *sof_dai;
2682 list_for_each_entry(sof_dai, &sdev->dai_list, list) {
2686 if (strcmp(link->name, sof_dai->name) == 0) {
2687 config->dai_index = sof_dai->comp_dai.dai_index;
2690 config->hda.link_dma_ch = DMA_CHAN_INVALID;
2692 /* save config in dai component */
2693 sof_dai->dai_config = kmemdup(config, size, GFP_KERNEL);
2694 if (!sof_dai->dai_config)
2697 sof_dai->cpu_dai_name = link->cpus->dai_name;
2699 /* send message to DSP */
2700 ret = sof_ipc_tx_message(sdev->ipc,
2701 config->hdr.cmd, config, size,
2702 &reply, sizeof(reply));
2705 dev_err(sdev->dev, "error: failed to set DAI config for direction:%d of HDA dai %d\n",
2706 sof_dai->comp_dai.direction,
2715 * machine driver may define a dai link with playback and capture
2716 * dai enabled, but the dai link in topology would support both, one
2717 * or none of them. Here print a warning message to notify user
2720 dev_warn(sdev->dev, "warning: failed to find dai for dai link %s",
2727 static int sof_link_hda_load(struct snd_soc_component *scomp, int index,
2728 struct snd_soc_dai_link *link,
2729 struct snd_soc_tplg_link_config *cfg,
2730 struct snd_soc_tplg_hw_config *hw_config,
2731 struct sof_ipc_dai_config *config)
2733 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2734 struct snd_soc_tplg_private *private = &cfg->priv;
2735 struct snd_soc_dai *dai;
2736 u32 size = sizeof(*config);
2740 memset(&config->hda, 0, sizeof(struct sof_ipc_dai_hda_params));
2741 config->hdr.size = size;
2743 /* get any bespoke DAI tokens */
2744 ret = sof_parse_tokens(scomp, config, hda_tokens,
2745 ARRAY_SIZE(hda_tokens), private->array,
2746 le32_to_cpu(private->size));
2748 dev_err(sdev->dev, "error: parse hda tokens failed %d\n",
2749 le32_to_cpu(private->size));
2753 dai = snd_soc_find_dai(link->cpus);
2755 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2756 link->cpus->dai_name, __func__);
2760 ret = sof_link_hda_process(sdev, link, config);
2762 dev_err(sdev->dev, "error: failed to process hda dai link %s",
2768 static int sof_link_alh_load(struct snd_soc_component *scomp, int index,
2769 struct snd_soc_dai_link *link,
2770 struct snd_soc_tplg_link_config *cfg,
2771 struct snd_soc_tplg_hw_config *hw_config,
2772 struct sof_ipc_dai_config *config)
2774 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2775 struct sof_ipc_reply reply;
2776 u32 size = sizeof(*config);
2780 config->hdr.size = size;
2782 /* send message to DSP */
2783 ret = sof_ipc_tx_message(sdev->ipc,
2784 config->hdr.cmd, config, size, &reply,
2788 dev_err(sdev->dev, "error: failed to set DAI config for ALH %d\n",
2793 /* set config for all DAI's with name matching the link name */
2794 ret = sof_set_dai_config(sdev, size, link, config);
2796 dev_err(sdev->dev, "error: failed to save DAI config for ALH %d\n",
2802 /* DAI link - used for any driver specific init */
2803 static int sof_link_load(struct snd_soc_component *scomp, int index,
2804 struct snd_soc_dai_link *link,
2805 struct snd_soc_tplg_link_config *cfg)
2807 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2808 struct snd_soc_tplg_private *private = &cfg->priv;
2809 struct sof_ipc_dai_config config;
2810 struct snd_soc_tplg_hw_config *hw_config;
2815 if (!link->platforms) {
2816 dev_err(sdev->dev, "error: no platforms\n");
2819 link->platforms->name = dev_name(sdev->dev);
2822 * Set nonatomic property for FE dai links as their trigger action
2825 if (!link->no_pcm) {
2826 link->nonatomic = true;
2828 /* nothing more to do for FE dai links */
2832 /* check we have some tokens - we need at least DAI type */
2833 if (le32_to_cpu(private->size) == 0) {
2834 dev_err(sdev->dev, "error: expected tokens for DAI, none found\n");
2838 /* Send BE DAI link configurations to DSP */
2839 memset(&config, 0, sizeof(config));
2841 /* get any common DAI tokens */
2842 ret = sof_parse_tokens(scomp, &config, dai_link_tokens,
2843 ARRAY_SIZE(dai_link_tokens), private->array,
2844 le32_to_cpu(private->size));
2846 dev_err(sdev->dev, "error: parse link tokens failed %d\n",
2847 le32_to_cpu(private->size));
2852 * DAI links are expected to have at least 1 hw_config.
2853 * But some older topologies might have no hw_config for HDA dai links.
2855 num_hw_configs = le32_to_cpu(cfg->num_hw_configs);
2856 if (!num_hw_configs) {
2857 if (config.type != SOF_DAI_INTEL_HDA) {
2858 dev_err(sdev->dev, "error: unexpected DAI config count %d!\n",
2859 le32_to_cpu(cfg->num_hw_configs));
2863 dev_dbg(sdev->dev, "tplg: %d hw_configs found, default id: %d!\n",
2864 cfg->num_hw_configs, le32_to_cpu(cfg->default_hw_config_id));
2866 for (i = 0; i < num_hw_configs; i++) {
2867 if (cfg->hw_config[i].id == cfg->default_hw_config_id)
2871 if (i == num_hw_configs) {
2872 dev_err(sdev->dev, "error: default hw_config id: %d not found!\n",
2873 le32_to_cpu(cfg->default_hw_config_id));
2878 /* configure dai IPC message */
2879 hw_config = &cfg->hw_config[i];
2881 config.hdr.cmd = SOF_IPC_GLB_DAI_MSG | SOF_IPC_DAI_CONFIG;
2882 config.format = le32_to_cpu(hw_config->fmt);
2884 /* now load DAI specific data and send IPC - type comes from token */
2885 switch (config.type) {
2886 case SOF_DAI_INTEL_SSP:
2887 ret = sof_link_ssp_load(scomp, index, link, cfg, hw_config,
2890 case SOF_DAI_INTEL_DMIC:
2891 ret = sof_link_dmic_load(scomp, index, link, cfg, hw_config,
2894 case SOF_DAI_INTEL_HDA:
2895 ret = sof_link_hda_load(scomp, index, link, cfg, hw_config,
2898 case SOF_DAI_INTEL_ALH:
2899 ret = sof_link_alh_load(scomp, index, link, cfg, hw_config,
2902 case SOF_DAI_IMX_SAI:
2903 ret = sof_link_sai_load(scomp, index, link, cfg, hw_config,
2906 case SOF_DAI_IMX_ESAI:
2907 ret = sof_link_esai_load(scomp, index, link, cfg, hw_config,
2911 dev_err(sdev->dev, "error: invalid DAI type %d\n", config.type);
2921 static int sof_link_hda_unload(struct snd_sof_dev *sdev,
2922 struct snd_soc_dai_link *link)
2924 struct snd_soc_dai *dai;
2927 dai = snd_soc_find_dai(link->cpus);
2929 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2930 link->cpus->dai_name, __func__);
2937 static int sof_link_unload(struct snd_soc_component *scomp,
2938 struct snd_soc_dobj *dobj)
2940 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2941 struct snd_soc_dai_link *link =
2942 container_of(dobj, struct snd_soc_dai_link, dobj);
2944 struct snd_sof_dai *sof_dai;
2947 /* only BE link is loaded by sof */
2951 list_for_each_entry(sof_dai, &sdev->dai_list, list) {
2955 if (strcmp(link->name, sof_dai->name) == 0)
2959 dev_err(sdev->dev, "error: failed to find dai %s in %s",
2960 link->name, __func__);
2964 switch (sof_dai->dai_config->type) {
2965 case SOF_DAI_INTEL_SSP:
2966 case SOF_DAI_INTEL_DMIC:
2967 case SOF_DAI_INTEL_ALH:
2968 /* no resource needs to be released for SSP, DMIC and ALH */
2970 case SOF_DAI_INTEL_HDA:
2971 ret = sof_link_hda_unload(sdev, link);
2974 dev_err(sdev->dev, "error: invalid DAI type %d\n",
2975 sof_dai->dai_config->type);
2983 /* DAI link - used for any driver specific init */
2984 static int sof_route_load(struct snd_soc_component *scomp, int index,
2985 struct snd_soc_dapm_route *route)
2987 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2988 struct sof_ipc_pipe_comp_connect *connect;
2989 struct snd_sof_widget *source_swidget, *sink_swidget;
2990 struct snd_soc_dobj *dobj = &route->dobj;
2991 struct snd_sof_route *sroute;
2992 struct sof_ipc_reply reply;
2995 /* allocate memory for sroute and connect */
2996 sroute = kzalloc(sizeof(*sroute), GFP_KERNEL);
3000 sroute->sdev = sdev;
3002 connect = kzalloc(sizeof(*connect), GFP_KERNEL);
3008 connect->hdr.size = sizeof(*connect);
3009 connect->hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_COMP_CONNECT;
3011 dev_dbg(sdev->dev, "sink %s control %s source %s\n",
3012 route->sink, route->control ? route->control : "none",
3015 /* source component */
3016 source_swidget = snd_sof_find_swidget(sdev, (char *)route->source);
3017 if (!source_swidget) {
3018 dev_err(sdev->dev, "error: source %s not found\n",
3025 * Virtual widgets of type output/out_drv may be added in topology
3026 * for compatibility. These are not handled by the FW.
3027 * So, don't send routes whose source/sink widget is of such types
3030 if (source_swidget->id == snd_soc_dapm_out_drv ||
3031 source_swidget->id == snd_soc_dapm_output)
3034 connect->source_id = source_swidget->comp_id;
3036 /* sink component */
3037 sink_swidget = snd_sof_find_swidget(sdev, (char *)route->sink);
3038 if (!sink_swidget) {
3039 dev_err(sdev->dev, "error: sink %s not found\n",
3046 * Don't send routes whose sink widget is of type
3047 * output or out_drv to the DSP
3049 if (sink_swidget->id == snd_soc_dapm_out_drv ||
3050 sink_swidget->id == snd_soc_dapm_output)
3053 connect->sink_id = sink_swidget->comp_id;
3056 * For virtual routes, both sink and source are not
3057 * buffer. Since only buffer linked to component is supported by
3058 * FW, others are reported as error, add check in route function,
3059 * do not send it to FW when both source and sink are not buffer
3061 if (source_swidget->id != snd_soc_dapm_buffer &&
3062 sink_swidget->id != snd_soc_dapm_buffer) {
3063 dev_dbg(sdev->dev, "warning: neither Linked source component %s nor sink component %s is of buffer type, ignoring link\n",
3064 route->source, route->sink);
3068 ret = sof_ipc_tx_message(sdev->ipc,
3070 connect, sizeof(*connect),
3071 &reply, sizeof(reply));
3073 /* check IPC return value */
3075 dev_err(sdev->dev, "error: failed to add route sink %s control %s source %s\n",
3077 route->control ? route->control : "none",
3082 /* check IPC reply */
3083 if (reply.error < 0) {
3084 dev_err(sdev->dev, "error: DSP failed to add route sink %s control %s source %s result %d\n",
3086 route->control ? route->control : "none",
3087 route->source, reply.error);
3092 sroute->route = route;
3093 dobj->private = sroute;
3094 sroute->private = connect;
3096 /* add route to route list */
3097 list_add(&sroute->list, &sdev->route_list);
3108 /* Function to set the initial value of SOF kcontrols.
3109 * The value will be stored in scontrol->control_data
3111 static int snd_sof_cache_kcontrol_val(struct snd_sof_dev *sdev)
3113 struct snd_sof_control *scontrol = NULL;
3114 int ipc_cmd, ctrl_type;
3117 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
3119 /* notify DSP of kcontrol values */
3120 switch (scontrol->cmd) {
3121 case SOF_CTRL_CMD_VOLUME:
3122 case SOF_CTRL_CMD_ENUM:
3123 case SOF_CTRL_CMD_SWITCH:
3124 ipc_cmd = SOF_IPC_COMP_GET_VALUE;
3125 ctrl_type = SOF_CTRL_TYPE_VALUE_CHAN_GET;
3127 case SOF_CTRL_CMD_BINARY:
3128 ipc_cmd = SOF_IPC_COMP_GET_DATA;
3129 ctrl_type = SOF_CTRL_TYPE_DATA_GET;
3133 "error: Invalid scontrol->cmd: %d\n",
3137 ret = snd_sof_ipc_set_get_comp_data(sdev->ipc, scontrol,
3143 "error: kcontrol value get for widget: %d\n",
3151 int snd_sof_complete_pipeline(struct snd_sof_dev *sdev,
3152 struct snd_sof_widget *swidget)
3154 struct sof_ipc_pipe_ready ready;
3155 struct sof_ipc_reply reply;
3158 dev_dbg(sdev->dev, "tplg: complete pipeline %s id %d\n",
3159 swidget->widget->name, swidget->comp_id);
3161 memset(&ready, 0, sizeof(ready));
3162 ready.hdr.size = sizeof(ready);
3163 ready.hdr.cmd = SOF_IPC_GLB_TPLG_MSG | SOF_IPC_TPLG_PIPE_COMPLETE;
3164 ready.comp_id = swidget->comp_id;
3166 ret = sof_ipc_tx_message(sdev->ipc,
3167 ready.hdr.cmd, &ready, sizeof(ready), &reply,
3174 /* completion - called at completion of firmware loading */
3175 static void sof_complete(struct snd_soc_component *scomp)
3177 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
3178 struct snd_sof_widget *swidget;
3180 /* some widget types require completion notificattion */
3181 list_for_each_entry(swidget, &sdev->widget_list, list) {
3182 if (swidget->complete)
3185 switch (swidget->id) {
3186 case snd_soc_dapm_scheduler:
3188 snd_sof_complete_pipeline(sdev, swidget);
3195 * cache initial values of SOF kcontrols by reading DSP value over
3196 * IPC. It may be overwritten by alsa-mixer after booting up
3198 snd_sof_cache_kcontrol_val(sdev);
3201 /* manifest - optional to inform component of manifest */
3202 static int sof_manifest(struct snd_soc_component *scomp, int index,
3203 struct snd_soc_tplg_manifest *man)
3205 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
3209 size = le32_to_cpu(man->priv.size);
3211 /* backward compatible with tplg without ABI info */
3213 dev_dbg(sdev->dev, "No topology ABI info\n");
3217 if (size != SOF_TPLG_ABI_SIZE) {
3218 dev_err(sdev->dev, "error: invalid topology ABI size\n");
3223 "Topology: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
3224 man->priv.data[0], man->priv.data[1],
3225 man->priv.data[2], SOF_ABI_MAJOR, SOF_ABI_MINOR,
3228 abi_version = SOF_ABI_VER(man->priv.data[0],
3232 if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, abi_version)) {
3233 dev_err(sdev->dev, "error: incompatible topology ABI version\n");
3237 if (abi_version > SOF_ABI_VERSION) {
3238 if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
3239 dev_warn(sdev->dev, "warn: topology ABI is more recent than kernel\n");
3241 dev_err(sdev->dev, "error: topology ABI is more recent than kernel\n");
3249 /* vendor specific kcontrol handlers available for binding */
3250 static const struct snd_soc_tplg_kcontrol_ops sof_io_ops[] = {
3251 {SOF_TPLG_KCTL_VOL_ID, snd_sof_volume_get, snd_sof_volume_put},
3252 {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_get, snd_sof_bytes_put},
3253 {SOF_TPLG_KCTL_ENUM_ID, snd_sof_enum_get, snd_sof_enum_put},
3254 {SOF_TPLG_KCTL_SWITCH_ID, snd_sof_switch_get, snd_sof_switch_put},
3257 /* vendor specific bytes ext handlers available for binding */
3258 static const struct snd_soc_tplg_bytes_ext_ops sof_bytes_ext_ops[] = {
3259 {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_ext_get, snd_sof_bytes_ext_put},
3262 static struct snd_soc_tplg_ops sof_tplg_ops = {
3263 /* external kcontrol init - used for any driver specific init */
3264 .control_load = sof_control_load,
3265 .control_unload = sof_control_unload,
3267 /* external kcontrol init - used for any driver specific init */
3268 .dapm_route_load = sof_route_load,
3269 .dapm_route_unload = sof_route_unload,
3271 /* external widget init - used for any driver specific init */
3272 /* .widget_load is not currently used */
3273 .widget_ready = sof_widget_ready,
3274 .widget_unload = sof_widget_unload,
3276 /* FE DAI - used for any driver specific init */
3277 .dai_load = sof_dai_load,
3278 .dai_unload = sof_dai_unload,
3280 /* DAI link - used for any driver specific init */
3281 .link_load = sof_link_load,
3282 .link_unload = sof_link_unload,
3284 /* completion - called at completion of firmware loading */
3285 .complete = sof_complete,
3287 /* manifest - optional to inform component of manifest */
3288 .manifest = sof_manifest,
3290 /* vendor specific kcontrol handlers available for binding */
3291 .io_ops = sof_io_ops,
3292 .io_ops_count = ARRAY_SIZE(sof_io_ops),
3294 /* vendor specific bytes ext handlers available for binding */
3295 .bytes_ext_ops = sof_bytes_ext_ops,
3296 .bytes_ext_ops_count = ARRAY_SIZE(sof_bytes_ext_ops),
3299 int snd_sof_init_topology(struct snd_sof_dev *sdev,
3300 struct snd_soc_tplg_ops *ops)
3302 /* TODO: support linked list of topologies */
3303 sdev->tplg_ops = ops;
3306 EXPORT_SYMBOL(snd_sof_init_topology);
3308 int snd_sof_load_topology(struct snd_sof_dev *sdev, const char *file)
3310 const struct firmware *fw;
3313 dev_dbg(sdev->dev, "loading topology:%s\n", file);
3315 ret = request_firmware(&fw, file, sdev->dev);
3317 dev_err(sdev->dev, "error: tplg request firmware %s failed err: %d\n",
3322 ret = snd_soc_tplg_component_load(sdev->component,
3324 SND_SOC_TPLG_INDEX_ALL);
3326 dev_err(sdev->dev, "error: tplg component load failed %d\n",
3331 release_firmware(fw);
3334 EXPORT_SYMBOL(snd_sof_load_topology);