2 * skl-message.c - HDA DSP interface for FW registration, Pipe and Module
5 * Copyright (C) 2015 Intel Corp
6 * Author:Rafal Redzimski <rafal.f.redzimski@intel.com>
7 * Jeeja KP <jeeja.kp@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as version 2, as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
20 #include <linux/slab.h>
21 #include <linux/pci.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include "skl-sst-dsp.h"
25 #include "cnl-sst-dsp.h"
26 #include "skl-sst-ipc.h"
28 #include "../common/sst-dsp.h"
29 #include "../common/sst-dsp-priv.h"
30 #include "skl-topology.h"
31 #include "skl-tplg-interface.h"
33 static int skl_alloc_dma_buf(struct device *dev,
34 struct snd_dma_buffer *dmab, size_t size)
36 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
37 struct hdac_bus *bus = ebus_to_hbus(ebus);
42 return bus->io_ops->dma_alloc_pages(bus, SNDRV_DMA_TYPE_DEV, size, dmab);
45 static int skl_free_dma_buf(struct device *dev, struct snd_dma_buffer *dmab)
47 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
48 struct hdac_bus *bus = ebus_to_hbus(ebus);
53 bus->io_ops->dma_free_pages(bus, dmab);
58 #define NOTIFICATION_PARAM_ID 3
59 #define NOTIFICATION_MASK 0xf
61 /* disable notfication for underruns/overruns from firmware module */
62 void skl_dsp_enable_notification(struct skl_sst *ctx, bool enable)
64 struct notification_mask mask;
65 struct skl_ipc_large_config_msg msg = {0};
67 mask.notify = NOTIFICATION_MASK;
70 msg.large_param_id = NOTIFICATION_PARAM_ID;
71 msg.param_data_size = sizeof(mask);
73 skl_ipc_set_large_config(&ctx->ipc, &msg, (u32 *)&mask);
76 static int skl_dsp_setup_spib(struct device *dev, unsigned int size,
77 int stream_tag, int enable)
79 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
80 struct hdac_bus *bus = ebus_to_hbus(ebus);
81 struct hdac_stream *stream = snd_hdac_get_stream(bus,
82 SNDRV_PCM_STREAM_PLAYBACK, stream_tag);
83 struct hdac_ext_stream *estream;
88 estream = stream_to_hdac_ext_stream(stream);
89 /* enable/disable SPIB for this hdac stream */
90 snd_hdac_ext_stream_spbcap_enable(ebus, enable, stream->index);
92 /* set the spib value */
93 snd_hdac_ext_stream_set_spib(ebus, estream, size);
98 static int skl_dsp_prepare(struct device *dev, unsigned int format,
99 unsigned int size, struct snd_dma_buffer *dmab)
101 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
102 struct hdac_bus *bus = ebus_to_hbus(ebus);
103 struct hdac_ext_stream *estream;
104 struct hdac_stream *stream;
105 struct snd_pcm_substream substream;
111 memset(&substream, 0, sizeof(substream));
112 substream.stream = SNDRV_PCM_STREAM_PLAYBACK;
114 estream = snd_hdac_ext_stream_assign(ebus, &substream,
115 HDAC_EXT_STREAM_TYPE_HOST);
119 stream = hdac_stream(estream);
121 /* assign decouple host dma channel */
122 ret = snd_hdac_dsp_prepare(stream, format, size, dmab);
126 skl_dsp_setup_spib(dev, size, stream->stream_tag, true);
128 return stream->stream_tag;
131 static int skl_dsp_trigger(struct device *dev, bool start, int stream_tag)
133 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
134 struct hdac_stream *stream;
135 struct hdac_bus *bus = ebus_to_hbus(ebus);
140 stream = snd_hdac_get_stream(bus,
141 SNDRV_PCM_STREAM_PLAYBACK, stream_tag);
145 snd_hdac_dsp_trigger(stream, start);
150 static int skl_dsp_cleanup(struct device *dev,
151 struct snd_dma_buffer *dmab, int stream_tag)
153 struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
154 struct hdac_stream *stream;
155 struct hdac_ext_stream *estream;
156 struct hdac_bus *bus = ebus_to_hbus(ebus);
161 stream = snd_hdac_get_stream(bus,
162 SNDRV_PCM_STREAM_PLAYBACK, stream_tag);
166 estream = stream_to_hdac_ext_stream(stream);
167 skl_dsp_setup_spib(dev, 0, stream_tag, false);
168 snd_hdac_ext_stream_release(estream, HDAC_EXT_STREAM_TYPE_HOST);
170 snd_hdac_dsp_cleanup(stream, dmab);
175 static struct skl_dsp_loader_ops skl_get_loader_ops(void)
177 struct skl_dsp_loader_ops loader_ops;
179 memset(&loader_ops, 0, sizeof(struct skl_dsp_loader_ops));
181 loader_ops.alloc_dma_buf = skl_alloc_dma_buf;
182 loader_ops.free_dma_buf = skl_free_dma_buf;
187 static struct skl_dsp_loader_ops bxt_get_loader_ops(void)
189 struct skl_dsp_loader_ops loader_ops;
191 memset(&loader_ops, 0, sizeof(loader_ops));
193 loader_ops.alloc_dma_buf = skl_alloc_dma_buf;
194 loader_ops.free_dma_buf = skl_free_dma_buf;
195 loader_ops.prepare = skl_dsp_prepare;
196 loader_ops.trigger = skl_dsp_trigger;
197 loader_ops.cleanup = skl_dsp_cleanup;
202 static const struct skl_dsp_ops dsp_ops[] = {
206 .loader_ops = skl_get_loader_ops,
207 .init = skl_sst_dsp_init,
208 .init_fw = skl_sst_init_fw,
209 .cleanup = skl_sst_dsp_cleanup
214 .loader_ops = skl_get_loader_ops,
215 .init = kbl_sst_dsp_init,
216 .init_fw = skl_sst_init_fw,
217 .cleanup = skl_sst_dsp_cleanup
222 .loader_ops = bxt_get_loader_ops,
223 .init = bxt_sst_dsp_init,
224 .init_fw = bxt_sst_init_fw,
225 .cleanup = bxt_sst_dsp_cleanup
230 .loader_ops = bxt_get_loader_ops,
231 .init = bxt_sst_dsp_init,
232 .init_fw = bxt_sst_init_fw,
233 .cleanup = bxt_sst_dsp_cleanup
238 .loader_ops = bxt_get_loader_ops,
239 .init = cnl_sst_dsp_init,
240 .init_fw = cnl_sst_init_fw,
241 .cleanup = cnl_sst_dsp_cleanup
245 const struct skl_dsp_ops *skl_get_dsp_ops(int pci_id)
249 for (i = 0; i < ARRAY_SIZE(dsp_ops); i++) {
250 if (dsp_ops[i].id == pci_id)
257 int skl_init_dsp(struct skl *skl)
259 void __iomem *mmio_base;
260 struct hdac_ext_bus *ebus = &skl->ebus;
261 struct hdac_bus *bus = ebus_to_hbus(ebus);
262 struct skl_dsp_loader_ops loader_ops;
264 const struct skl_dsp_ops *ops;
265 struct skl_dsp_cores *cores;
268 /* enable ppcap interrupt */
269 snd_hdac_ext_bus_ppcap_enable(&skl->ebus, true);
270 snd_hdac_ext_bus_ppcap_int_enable(&skl->ebus, true);
272 /* read the BAR of the ADSP MMIO */
273 mmio_base = pci_ioremap_bar(skl->pci, 4);
274 if (mmio_base == NULL) {
275 dev_err(bus->dev, "ioremap error\n");
279 ops = skl_get_dsp_ops(skl->pci->device);
285 loader_ops = ops->loader_ops();
286 ret = ops->init(bus->dev, mmio_base, irq,
287 skl->fw_name, loader_ops,
293 skl->skl_sst->dsp_ops = ops;
294 cores = &skl->skl_sst->cores;
295 cores->count = ops->num_cores;
297 cores->state = kcalloc(cores->count, sizeof(*cores->state), GFP_KERNEL);
303 cores->usage_count = kcalloc(cores->count, sizeof(*cores->usage_count),
305 if (!cores->usage_count) {
307 goto free_core_state;
310 dev_dbg(bus->dev, "dsp registration status=%d\n", ret);
323 int skl_free_dsp(struct skl *skl)
325 struct hdac_ext_bus *ebus = &skl->ebus;
326 struct hdac_bus *bus = ebus_to_hbus(ebus);
327 struct skl_sst *ctx = skl->skl_sst;
329 /* disable ppcap interrupt */
330 snd_hdac_ext_bus_ppcap_int_enable(&skl->ebus, false);
332 ctx->dsp_ops->cleanup(bus->dev, ctx);
334 kfree(ctx->cores.state);
335 kfree(ctx->cores.usage_count);
337 if (ctx->dsp->addr.lpe)
338 iounmap(ctx->dsp->addr.lpe);
344 * In the case of "suspend_active" i.e, the Audio IP being active
345 * during system suspend, immediately excecute any pending D0i3 work
346 * before suspending. This is needed for the IP to work in low power
347 * mode during system suspend. In the case of normal suspend, cancel
348 * any pending D0i3 work.
350 int skl_suspend_late_dsp(struct skl *skl)
352 struct skl_sst *ctx = skl->skl_sst;
353 struct delayed_work *dwork;
358 dwork = &ctx->d0i3.work;
360 if (dwork->work.func) {
361 if (skl->supend_active)
362 flush_delayed_work(dwork);
364 cancel_delayed_work_sync(dwork);
370 int skl_suspend_dsp(struct skl *skl)
372 struct skl_sst *ctx = skl->skl_sst;
375 /* if ppcap is not supported return 0 */
376 if (!skl->ebus.bus.ppcap)
379 ret = skl_dsp_sleep(ctx->dsp);
383 /* disable ppcap interrupt */
384 snd_hdac_ext_bus_ppcap_int_enable(&skl->ebus, false);
385 snd_hdac_ext_bus_ppcap_enable(&skl->ebus, false);
390 int skl_resume_dsp(struct skl *skl)
392 struct skl_sst *ctx = skl->skl_sst;
395 /* if ppcap is not supported return 0 */
396 if (!skl->ebus.bus.ppcap)
399 /* enable ppcap interrupt */
400 snd_hdac_ext_bus_ppcap_enable(&skl->ebus, true);
401 snd_hdac_ext_bus_ppcap_int_enable(&skl->ebus, true);
403 /* check if DSP 1st boot is done */
404 if (skl->skl_sst->is_first_boot == true)
407 ret = skl_dsp_wake(ctx->dsp);
411 skl_dsp_enable_notification(skl->skl_sst, false);
415 enum skl_bitdepth skl_get_bit_depth(int params)
419 return SKL_DEPTH_8BIT;
422 return SKL_DEPTH_16BIT;
425 return SKL_DEPTH_24BIT;
428 return SKL_DEPTH_32BIT;
431 return SKL_DEPTH_INVALID;
437 * Each module in DSP expects a base module configuration, which consists of
438 * PCM format information, which we calculate in driver and resource values
439 * which are read from widget information passed through topology binary
440 * This is send when we create a module with INIT_INSTANCE IPC msg
442 static void skl_set_base_module_format(struct skl_sst *ctx,
443 struct skl_module_cfg *mconfig,
444 struct skl_base_cfg *base_cfg)
446 struct skl_module *module = mconfig->module;
447 struct skl_module_res *res = &module->resources[mconfig->res_idx];
448 struct skl_module_iface *fmt = &module->formats[mconfig->fmt_idx];
449 struct skl_module_fmt *format = &fmt->inputs[0].fmt;
451 base_cfg->audio_fmt.number_of_channels = format->channels;
453 base_cfg->audio_fmt.s_freq = format->s_freq;
454 base_cfg->audio_fmt.bit_depth = format->bit_depth;
455 base_cfg->audio_fmt.valid_bit_depth = format->valid_bit_depth;
456 base_cfg->audio_fmt.ch_cfg = format->ch_cfg;
458 dev_dbg(ctx->dev, "bit_depth=%x valid_bd=%x ch_config=%x\n",
459 format->bit_depth, format->valid_bit_depth,
462 base_cfg->audio_fmt.channel_map = format->ch_map;
464 base_cfg->audio_fmt.interleaving = format->interleaving_style;
466 base_cfg->cps = res->cps;
467 base_cfg->ibs = res->ibs;
468 base_cfg->obs = res->obs;
469 base_cfg->is_pages = res->is_pages;
473 * Copies copier capabilities into copier module and updates copier module
476 static void skl_copy_copier_caps(struct skl_module_cfg *mconfig,
477 struct skl_cpr_cfg *cpr_mconfig)
479 if (mconfig->formats_config.caps_size == 0)
482 memcpy(cpr_mconfig->gtw_cfg.config_data,
483 mconfig->formats_config.caps,
484 mconfig->formats_config.caps_size);
486 cpr_mconfig->gtw_cfg.config_length =
487 (mconfig->formats_config.caps_size) / 4;
490 #define SKL_NON_GATEWAY_CPR_NODE_ID 0xFFFFFFFF
492 * Calculate the gatewat settings required for copier module, type of
493 * gateway and index of gateway to use
495 static u32 skl_get_node_id(struct skl_sst *ctx,
496 struct skl_module_cfg *mconfig)
498 union skl_connector_node_id node_id = {0};
499 union skl_ssp_dma_node ssp_node = {0};
500 struct skl_pipe_params *params = mconfig->pipe->p_params;
502 switch (mconfig->dev_type) {
504 node_id.node.dma_type =
505 (SKL_CONN_SOURCE == mconfig->hw_conn_type) ?
506 SKL_DMA_I2S_LINK_OUTPUT_CLASS :
507 SKL_DMA_I2S_LINK_INPUT_CLASS;
508 node_id.node.vindex = params->host_dma_id +
509 (mconfig->vbus_id << 3);
513 node_id.node.dma_type =
514 (SKL_CONN_SOURCE == mconfig->hw_conn_type) ?
515 SKL_DMA_I2S_LINK_OUTPUT_CLASS :
516 SKL_DMA_I2S_LINK_INPUT_CLASS;
517 ssp_node.dma_node.time_slot_index = mconfig->time_slot;
518 ssp_node.dma_node.i2s_instance = mconfig->vbus_id;
519 node_id.node.vindex = ssp_node.val;
522 case SKL_DEVICE_DMIC:
523 node_id.node.dma_type = SKL_DMA_DMIC_LINK_INPUT_CLASS;
524 node_id.node.vindex = mconfig->vbus_id +
525 (mconfig->time_slot);
528 case SKL_DEVICE_HDALINK:
529 node_id.node.dma_type =
530 (SKL_CONN_SOURCE == mconfig->hw_conn_type) ?
531 SKL_DMA_HDA_LINK_OUTPUT_CLASS :
532 SKL_DMA_HDA_LINK_INPUT_CLASS;
533 node_id.node.vindex = params->link_dma_id;
536 case SKL_DEVICE_HDAHOST:
537 node_id.node.dma_type =
538 (SKL_CONN_SOURCE == mconfig->hw_conn_type) ?
539 SKL_DMA_HDA_HOST_OUTPUT_CLASS :
540 SKL_DMA_HDA_HOST_INPUT_CLASS;
541 node_id.node.vindex = params->host_dma_id;
545 node_id.val = 0xFFFFFFFF;
552 static void skl_setup_cpr_gateway_cfg(struct skl_sst *ctx,
553 struct skl_module_cfg *mconfig,
554 struct skl_cpr_cfg *cpr_mconfig)
557 struct skl_module_res *res;
558 int res_idx = mconfig->res_idx;
559 struct skl *skl = get_skl_ctx(ctx->dev);
561 cpr_mconfig->gtw_cfg.node_id = skl_get_node_id(ctx, mconfig);
563 if (cpr_mconfig->gtw_cfg.node_id == SKL_NON_GATEWAY_CPR_NODE_ID) {
564 cpr_mconfig->cpr_feature_mask = 0;
568 if (skl->nr_modules) {
569 res = &mconfig->module->resources[mconfig->res_idx];
570 cpr_mconfig->gtw_cfg.dma_buffer_size = res->dma_buffer_size;
571 goto skip_buf_size_calc;
573 res = &mconfig->module->resources[res_idx];
576 switch (mconfig->hw_conn_type) {
577 case SKL_CONN_SOURCE:
578 if (mconfig->dev_type == SKL_DEVICE_HDAHOST)
579 dma_io_buf = res->ibs;
581 dma_io_buf = res->obs;
585 if (mconfig->dev_type == SKL_DEVICE_HDAHOST)
586 dma_io_buf = res->obs;
588 dma_io_buf = res->ibs;
592 dev_warn(ctx->dev, "wrong connection type: %d\n",
593 mconfig->hw_conn_type);
597 cpr_mconfig->gtw_cfg.dma_buffer_size =
598 mconfig->dma_buffer_size * dma_io_buf;
600 /* fallback to 2ms default value */
601 if (!cpr_mconfig->gtw_cfg.dma_buffer_size) {
602 if (mconfig->hw_conn_type == SKL_CONN_SOURCE)
603 cpr_mconfig->gtw_cfg.dma_buffer_size = 2 * res->obs;
605 cpr_mconfig->gtw_cfg.dma_buffer_size = 2 * res->ibs;
609 cpr_mconfig->cpr_feature_mask = 0;
610 cpr_mconfig->gtw_cfg.config_length = 0;
612 skl_copy_copier_caps(mconfig, cpr_mconfig);
615 #define DMA_CONTROL_ID 5
616 #define DMA_I2S_BLOB_SIZE 21
618 int skl_dsp_set_dma_control(struct skl_sst *ctx, u32 *caps,
619 u32 caps_size, u32 node_id)
621 struct skl_dma_control *dma_ctrl;
622 struct skl_ipc_large_config_msg msg = {0};
627 * if blob size zero, then return
632 msg.large_param_id = DMA_CONTROL_ID;
633 msg.param_data_size = sizeof(struct skl_dma_control) + caps_size;
635 dma_ctrl = kzalloc(msg.param_data_size, GFP_KERNEL);
636 if (dma_ctrl == NULL)
639 dma_ctrl->node_id = node_id;
642 * NHLT blob may contain additional configs along with i2s blob.
643 * firmware expects only the i2s blob size as the config_length.
644 * So fix to i2s blob size.
647 dma_ctrl->config_length = DMA_I2S_BLOB_SIZE;
649 memcpy(dma_ctrl->config_data, caps, caps_size);
651 err = skl_ipc_set_large_config(&ctx->ipc, &msg, (u32 *)dma_ctrl);
657 static void skl_setup_out_format(struct skl_sst *ctx,
658 struct skl_module_cfg *mconfig,
659 struct skl_audio_data_format *out_fmt)
661 struct skl_module *module = mconfig->module;
662 struct skl_module_iface *fmt = &module->formats[mconfig->fmt_idx];
663 struct skl_module_fmt *format = &fmt->outputs[0].fmt;
665 out_fmt->number_of_channels = (u8)format->channels;
666 out_fmt->s_freq = format->s_freq;
667 out_fmt->bit_depth = format->bit_depth;
668 out_fmt->valid_bit_depth = format->valid_bit_depth;
669 out_fmt->ch_cfg = format->ch_cfg;
671 out_fmt->channel_map = format->ch_map;
672 out_fmt->interleaving = format->interleaving_style;
673 out_fmt->sample_type = format->sample_type;
675 dev_dbg(ctx->dev, "copier out format chan=%d fre=%d bitdepth=%d\n",
676 out_fmt->number_of_channels, format->s_freq, format->bit_depth);
680 * DSP needs SRC module for frequency conversion, SRC takes base module
681 * configuration and the target frequency as extra parameter passed as src
684 static void skl_set_src_format(struct skl_sst *ctx,
685 struct skl_module_cfg *mconfig,
686 struct skl_src_module_cfg *src_mconfig)
688 struct skl_module *module = mconfig->module;
689 struct skl_module_iface *iface = &module->formats[mconfig->fmt_idx];
690 struct skl_module_fmt *fmt = &iface->outputs[0].fmt;
692 skl_set_base_module_format(ctx, mconfig,
693 (struct skl_base_cfg *)src_mconfig);
695 src_mconfig->src_cfg = fmt->s_freq;
699 * DSP needs updown module to do channel conversion. updown module take base
700 * module configuration and channel configuration
701 * It also take coefficients and now we have defaults applied here
703 static void skl_set_updown_mixer_format(struct skl_sst *ctx,
704 struct skl_module_cfg *mconfig,
705 struct skl_up_down_mixer_cfg *mixer_mconfig)
707 struct skl_module *module = mconfig->module;
708 struct skl_module_iface *iface = &module->formats[mconfig->fmt_idx];
709 struct skl_module_fmt *fmt = &iface->outputs[0].fmt;
711 skl_set_base_module_format(ctx, mconfig,
712 (struct skl_base_cfg *)mixer_mconfig);
713 mixer_mconfig->out_ch_cfg = fmt->ch_cfg;
714 mixer_mconfig->ch_map = fmt->ch_map;
718 * 'copier' is DSP internal module which copies data from Host DMA (HDA host
719 * dma) or link (hda link, SSP, PDM)
720 * Here we calculate the copier module parameters, like PCM format, output
721 * format, gateway settings
722 * copier_module_config is sent as input buffer with INIT_INSTANCE IPC msg
724 static void skl_set_copier_format(struct skl_sst *ctx,
725 struct skl_module_cfg *mconfig,
726 struct skl_cpr_cfg *cpr_mconfig)
728 struct skl_audio_data_format *out_fmt = &cpr_mconfig->out_fmt;
729 struct skl_base_cfg *base_cfg = (struct skl_base_cfg *)cpr_mconfig;
731 skl_set_base_module_format(ctx, mconfig, base_cfg);
733 skl_setup_out_format(ctx, mconfig, out_fmt);
734 skl_setup_cpr_gateway_cfg(ctx, mconfig, cpr_mconfig);
738 * Algo module are DSP pre processing modules. Algo module take base module
739 * configuration and params
742 static void skl_set_algo_format(struct skl_sst *ctx,
743 struct skl_module_cfg *mconfig,
744 struct skl_algo_cfg *algo_mcfg)
746 struct skl_base_cfg *base_cfg = (struct skl_base_cfg *)algo_mcfg;
748 skl_set_base_module_format(ctx, mconfig, base_cfg);
750 if (mconfig->formats_config.caps_size == 0)
753 memcpy(algo_mcfg->params,
754 mconfig->formats_config.caps,
755 mconfig->formats_config.caps_size);
760 * Mic select module allows selecting one or many input channels, thus
763 * Mic select module take base module configuration and out-format
766 static void skl_set_base_outfmt_format(struct skl_sst *ctx,
767 struct skl_module_cfg *mconfig,
768 struct skl_base_outfmt_cfg *base_outfmt_mcfg)
770 struct skl_audio_data_format *out_fmt = &base_outfmt_mcfg->out_fmt;
771 struct skl_base_cfg *base_cfg =
772 (struct skl_base_cfg *)base_outfmt_mcfg;
774 skl_set_base_module_format(ctx, mconfig, base_cfg);
775 skl_setup_out_format(ctx, mconfig, out_fmt);
778 static u16 skl_get_module_param_size(struct skl_sst *ctx,
779 struct skl_module_cfg *mconfig)
783 switch (mconfig->m_type) {
784 case SKL_MODULE_TYPE_COPIER:
785 param_size = sizeof(struct skl_cpr_cfg);
786 param_size += mconfig->formats_config.caps_size;
789 case SKL_MODULE_TYPE_SRCINT:
790 return sizeof(struct skl_src_module_cfg);
792 case SKL_MODULE_TYPE_UPDWMIX:
793 return sizeof(struct skl_up_down_mixer_cfg);
795 case SKL_MODULE_TYPE_ALGO:
796 param_size = sizeof(struct skl_base_cfg);
797 param_size += mconfig->formats_config.caps_size;
800 case SKL_MODULE_TYPE_BASE_OUTFMT:
801 case SKL_MODULE_TYPE_MIC_SELECT:
802 case SKL_MODULE_TYPE_KPB:
803 return sizeof(struct skl_base_outfmt_cfg);
807 * return only base cfg when no specific module type is
810 return sizeof(struct skl_base_cfg);
817 * DSP firmware supports various modules like copier, SRC, updown etc.
818 * These modules required various parameters to be calculated and sent for
819 * the module initialization to DSP. By default a generic module needs only
820 * base module format configuration
823 static int skl_set_module_format(struct skl_sst *ctx,
824 struct skl_module_cfg *module_config,
825 u16 *module_config_size,
830 param_size = skl_get_module_param_size(ctx, module_config);
832 *param_data = kzalloc(param_size, GFP_KERNEL);
833 if (NULL == *param_data)
836 *module_config_size = param_size;
838 switch (module_config->m_type) {
839 case SKL_MODULE_TYPE_COPIER:
840 skl_set_copier_format(ctx, module_config, *param_data);
843 case SKL_MODULE_TYPE_SRCINT:
844 skl_set_src_format(ctx, module_config, *param_data);
847 case SKL_MODULE_TYPE_UPDWMIX:
848 skl_set_updown_mixer_format(ctx, module_config, *param_data);
851 case SKL_MODULE_TYPE_ALGO:
852 skl_set_algo_format(ctx, module_config, *param_data);
855 case SKL_MODULE_TYPE_BASE_OUTFMT:
856 case SKL_MODULE_TYPE_MIC_SELECT:
857 case SKL_MODULE_TYPE_KPB:
858 skl_set_base_outfmt_format(ctx, module_config, *param_data);
862 skl_set_base_module_format(ctx, module_config, *param_data);
867 dev_dbg(ctx->dev, "Module type=%d config size: %d bytes\n",
868 module_config->id.module_id, param_size);
869 print_hex_dump_debug("Module params:", DUMP_PREFIX_OFFSET, 8, 4,
870 *param_data, param_size, false);
874 static int skl_get_queue_index(struct skl_module_pin *mpin,
875 struct skl_module_inst_id id, int max)
879 for (i = 0; i < max; i++) {
880 if (mpin[i].id.module_id == id.module_id &&
881 mpin[i].id.instance_id == id.instance_id)
889 * Allocates queue for each module.
890 * if dynamic, the pin_index is allocated 0 to max_pin.
891 * In static, the pin_index is fixed based on module_id and instance id
893 static int skl_alloc_queue(struct skl_module_pin *mpin,
894 struct skl_module_cfg *tgt_cfg, int max)
897 struct skl_module_inst_id id = tgt_cfg->id;
899 * if pin in dynamic, find first free pin
900 * otherwise find match module and instance id pin as topology will
901 * ensure a unique pin is assigned to this so no need to
904 for (i = 0; i < max; i++) {
905 if (mpin[i].is_dynamic) {
906 if (!mpin[i].in_use &&
907 mpin[i].pin_state == SKL_PIN_UNBIND) {
909 mpin[i].in_use = true;
910 mpin[i].id.module_id = id.module_id;
911 mpin[i].id.instance_id = id.instance_id;
912 mpin[i].id.pvt_id = id.pvt_id;
913 mpin[i].tgt_mcfg = tgt_cfg;
917 if (mpin[i].id.module_id == id.module_id &&
918 mpin[i].id.instance_id == id.instance_id &&
919 mpin[i].pin_state == SKL_PIN_UNBIND) {
921 mpin[i].tgt_mcfg = tgt_cfg;
930 static void skl_free_queue(struct skl_module_pin *mpin, int q_index)
932 if (mpin[q_index].is_dynamic) {
933 mpin[q_index].in_use = false;
934 mpin[q_index].id.module_id = 0;
935 mpin[q_index].id.instance_id = 0;
936 mpin[q_index].id.pvt_id = 0;
938 mpin[q_index].pin_state = SKL_PIN_UNBIND;
939 mpin[q_index].tgt_mcfg = NULL;
942 /* Module state will be set to unint, if all the out pin state is UNBIND */
944 static void skl_clear_module_state(struct skl_module_pin *mpin, int max,
945 struct skl_module_cfg *mcfg)
950 for (i = 0; i < max; i++) {
951 if (mpin[i].pin_state == SKL_PIN_UNBIND)
958 mcfg->m_state = SKL_MODULE_INIT_DONE;
963 * A module needs to be instanataited in DSP. A mdoule is present in a
964 * collection of module referred as a PIPE.
965 * We first calculate the module format, based on module type and then
966 * invoke the DSP by sending IPC INIT_INSTANCE using ipc helper
968 int skl_init_module(struct skl_sst *ctx,
969 struct skl_module_cfg *mconfig)
971 u16 module_config_size = 0;
972 void *param_data = NULL;
974 struct skl_ipc_init_instance_msg msg;
976 dev_dbg(ctx->dev, "%s: module_id = %d instance=%d\n", __func__,
977 mconfig->id.module_id, mconfig->id.pvt_id);
979 if (mconfig->pipe->state != SKL_PIPE_CREATED) {
980 dev_err(ctx->dev, "Pipe not created state= %d pipe_id= %d\n",
981 mconfig->pipe->state, mconfig->pipe->ppl_id);
985 ret = skl_set_module_format(ctx, mconfig,
986 &module_config_size, ¶m_data);
988 dev_err(ctx->dev, "Failed to set module format ret=%d\n", ret);
992 msg.module_id = mconfig->id.module_id;
993 msg.instance_id = mconfig->id.pvt_id;
994 msg.ppl_instance_id = mconfig->pipe->ppl_id;
995 msg.param_data_size = module_config_size;
996 msg.core_id = mconfig->core_id;
997 msg.domain = mconfig->domain;
999 ret = skl_ipc_init_instance(&ctx->ipc, &msg, param_data);
1001 dev_err(ctx->dev, "Failed to init instance ret=%d\n", ret);
1005 mconfig->m_state = SKL_MODULE_INIT_DONE;
1010 static void skl_dump_bind_info(struct skl_sst *ctx, struct skl_module_cfg
1011 *src_module, struct skl_module_cfg *dst_module)
1013 dev_dbg(ctx->dev, "%s: src module_id = %d src_instance=%d\n",
1014 __func__, src_module->id.module_id, src_module->id.pvt_id);
1015 dev_dbg(ctx->dev, "%s: dst_module=%d dst_instance=%d\n", __func__,
1016 dst_module->id.module_id, dst_module->id.pvt_id);
1018 dev_dbg(ctx->dev, "src_module state = %d dst module state = %d\n",
1019 src_module->m_state, dst_module->m_state);
1023 * On module freeup, we need to unbind the module with modules
1024 * it is already bind.
1025 * Find the pin allocated and unbind then using bind_unbind IPC
1027 int skl_unbind_modules(struct skl_sst *ctx,
1028 struct skl_module_cfg *src_mcfg,
1029 struct skl_module_cfg *dst_mcfg)
1032 struct skl_ipc_bind_unbind_msg msg;
1033 struct skl_module_inst_id src_id = src_mcfg->id;
1034 struct skl_module_inst_id dst_id = dst_mcfg->id;
1035 int in_max = dst_mcfg->module->max_input_pins;
1036 int out_max = src_mcfg->module->max_output_pins;
1037 int src_index, dst_index, src_pin_state, dst_pin_state;
1039 skl_dump_bind_info(ctx, src_mcfg, dst_mcfg);
1041 /* get src queue index */
1042 src_index = skl_get_queue_index(src_mcfg->m_out_pin, dst_id, out_max);
1046 msg.src_queue = src_index;
1048 /* get dst queue index */
1049 dst_index = skl_get_queue_index(dst_mcfg->m_in_pin, src_id, in_max);
1053 msg.dst_queue = dst_index;
1055 src_pin_state = src_mcfg->m_out_pin[src_index].pin_state;
1056 dst_pin_state = dst_mcfg->m_in_pin[dst_index].pin_state;
1058 if (src_pin_state != SKL_PIN_BIND_DONE ||
1059 dst_pin_state != SKL_PIN_BIND_DONE)
1062 msg.module_id = src_mcfg->id.module_id;
1063 msg.instance_id = src_mcfg->id.pvt_id;
1064 msg.dst_module_id = dst_mcfg->id.module_id;
1065 msg.dst_instance_id = dst_mcfg->id.pvt_id;
1068 ret = skl_ipc_bind_unbind(&ctx->ipc, &msg);
1070 /* free queue only if unbind is success */
1071 skl_free_queue(src_mcfg->m_out_pin, src_index);
1072 skl_free_queue(dst_mcfg->m_in_pin, dst_index);
1075 * check only if src module bind state, bind is
1076 * always from src -> sink
1078 skl_clear_module_state(src_mcfg->m_out_pin, out_max, src_mcfg);
1084 static void fill_pin_params(struct skl_audio_data_format *pin_fmt,
1085 struct skl_module_fmt *format)
1087 pin_fmt->number_of_channels = format->channels;
1088 pin_fmt->s_freq = format->s_freq;
1089 pin_fmt->bit_depth = format->bit_depth;
1090 pin_fmt->valid_bit_depth = format->valid_bit_depth;
1091 pin_fmt->ch_cfg = format->ch_cfg;
1092 pin_fmt->sample_type = format->sample_type;
1093 pin_fmt->channel_map = format->ch_map;
1094 pin_fmt->interleaving = format->interleaving_style;
1097 #define CPR_SINK_FMT_PARAM_ID 2
1100 * Once a module is instantiated it need to be 'bind' with other modules in
1101 * the pipeline. For binding we need to find the module pins which are bind
1103 * This function finds the pins and then sends bund_unbind IPC message to
1104 * DSP using IPC helper
1106 int skl_bind_modules(struct skl_sst *ctx,
1107 struct skl_module_cfg *src_mcfg,
1108 struct skl_module_cfg *dst_mcfg)
1111 struct skl_ipc_bind_unbind_msg msg;
1112 int in_max = dst_mcfg->module->max_input_pins;
1113 int out_max = src_mcfg->module->max_output_pins;
1114 int src_index, dst_index;
1115 struct skl_module_fmt *format;
1116 struct skl_cpr_pin_fmt pin_fmt;
1117 struct skl_module *module;
1118 struct skl_module_iface *fmt;
1120 skl_dump_bind_info(ctx, src_mcfg, dst_mcfg);
1122 if (src_mcfg->m_state < SKL_MODULE_INIT_DONE ||
1123 dst_mcfg->m_state < SKL_MODULE_INIT_DONE)
1126 src_index = skl_alloc_queue(src_mcfg->m_out_pin, dst_mcfg, out_max);
1130 msg.src_queue = src_index;
1131 dst_index = skl_alloc_queue(dst_mcfg->m_in_pin, src_mcfg, in_max);
1132 if (dst_index < 0) {
1133 skl_free_queue(src_mcfg->m_out_pin, src_index);
1138 * Copier module requires the separate large_config_set_ipc to
1139 * configure the pins other than 0
1141 if (src_mcfg->m_type == SKL_MODULE_TYPE_COPIER && src_index > 0) {
1142 pin_fmt.sink_id = src_index;
1143 module = src_mcfg->module;
1144 fmt = &module->formats[src_mcfg->fmt_idx];
1146 /* Input fmt is same as that of src module input cfg */
1147 format = &fmt->inputs[0].fmt;
1148 fill_pin_params(&(pin_fmt.src_fmt), format);
1150 format = &fmt->outputs[src_index].fmt;
1151 fill_pin_params(&(pin_fmt.dst_fmt), format);
1152 ret = skl_set_module_params(ctx, (void *)&pin_fmt,
1153 sizeof(struct skl_cpr_pin_fmt),
1154 CPR_SINK_FMT_PARAM_ID, src_mcfg);
1160 msg.dst_queue = dst_index;
1162 dev_dbg(ctx->dev, "src queue = %d dst queue =%d\n",
1163 msg.src_queue, msg.dst_queue);
1165 msg.module_id = src_mcfg->id.module_id;
1166 msg.instance_id = src_mcfg->id.pvt_id;
1167 msg.dst_module_id = dst_mcfg->id.module_id;
1168 msg.dst_instance_id = dst_mcfg->id.pvt_id;
1171 ret = skl_ipc_bind_unbind(&ctx->ipc, &msg);
1174 src_mcfg->m_state = SKL_MODULE_BIND_DONE;
1175 src_mcfg->m_out_pin[src_index].pin_state = SKL_PIN_BIND_DONE;
1176 dst_mcfg->m_in_pin[dst_index].pin_state = SKL_PIN_BIND_DONE;
1180 /* error case , if IPC fails, clear the queue index */
1181 skl_free_queue(src_mcfg->m_out_pin, src_index);
1182 skl_free_queue(dst_mcfg->m_in_pin, dst_index);
1187 static int skl_set_pipe_state(struct skl_sst *ctx, struct skl_pipe *pipe,
1188 enum skl_ipc_pipeline_state state)
1190 dev_dbg(ctx->dev, "%s: pipe_satate = %d\n", __func__, state);
1192 return skl_ipc_set_pipeline_state(&ctx->ipc, pipe->ppl_id, state);
1196 * A pipeline is a collection of modules. Before a module in instantiated a
1197 * pipeline needs to be created for it.
1198 * This function creates pipeline, by sending create pipeline IPC messages
1201 int skl_create_pipeline(struct skl_sst *ctx, struct skl_pipe *pipe)
1205 dev_dbg(ctx->dev, "%s: pipe_id = %d\n", __func__, pipe->ppl_id);
1207 ret = skl_ipc_create_pipeline(&ctx->ipc, pipe->memory_pages,
1208 pipe->pipe_priority, pipe->ppl_id,
1211 dev_err(ctx->dev, "Failed to create pipeline\n");
1215 pipe->state = SKL_PIPE_CREATED;
1221 * A pipeline needs to be deleted on cleanup. If a pipeline is running, then
1222 * pause the pipeline first and then delete it
1223 * The pipe delete is done by sending delete pipeline IPC. DSP will stop the
1224 * DMA engines and releases resources
1226 int skl_delete_pipe(struct skl_sst *ctx, struct skl_pipe *pipe)
1230 dev_dbg(ctx->dev, "%s: pipe = %d\n", __func__, pipe->ppl_id);
1232 /* If pipe is started, do stop the pipe in FW. */
1233 if (pipe->state >= SKL_PIPE_STARTED) {
1234 ret = skl_set_pipe_state(ctx, pipe, PPL_PAUSED);
1236 dev_err(ctx->dev, "Failed to stop pipeline\n");
1240 pipe->state = SKL_PIPE_PAUSED;
1243 /* If pipe was not created in FW, do not try to delete it */
1244 if (pipe->state < SKL_PIPE_CREATED)
1247 ret = skl_ipc_delete_pipeline(&ctx->ipc, pipe->ppl_id);
1249 dev_err(ctx->dev, "Failed to delete pipeline\n");
1253 pipe->state = SKL_PIPE_INVALID;
1259 * A pipeline is also a scheduling entity in DSP which can be run, stopped
1260 * For processing data the pipe need to be run by sending IPC set pipe state
1263 int skl_run_pipe(struct skl_sst *ctx, struct skl_pipe *pipe)
1267 dev_dbg(ctx->dev, "%s: pipe = %d\n", __func__, pipe->ppl_id);
1269 /* If pipe was not created in FW, do not try to pause or delete */
1270 if (pipe->state < SKL_PIPE_CREATED)
1273 /* Pipe has to be paused before it is started */
1274 ret = skl_set_pipe_state(ctx, pipe, PPL_PAUSED);
1276 dev_err(ctx->dev, "Failed to pause pipe\n");
1280 pipe->state = SKL_PIPE_PAUSED;
1282 ret = skl_set_pipe_state(ctx, pipe, PPL_RUNNING);
1284 dev_err(ctx->dev, "Failed to start pipe\n");
1288 pipe->state = SKL_PIPE_STARTED;
1294 * Stop the pipeline by sending set pipe state IPC
1295 * DSP doesnt implement stop so we always send pause message
1297 int skl_stop_pipe(struct skl_sst *ctx, struct skl_pipe *pipe)
1301 dev_dbg(ctx->dev, "In %s pipe=%d\n", __func__, pipe->ppl_id);
1303 /* If pipe was not created in FW, do not try to pause or delete */
1304 if (pipe->state < SKL_PIPE_PAUSED)
1307 ret = skl_set_pipe_state(ctx, pipe, PPL_PAUSED);
1309 dev_dbg(ctx->dev, "Failed to stop pipe\n");
1313 pipe->state = SKL_PIPE_PAUSED;
1319 * Reset the pipeline by sending set pipe state IPC this will reset the DMA
1322 int skl_reset_pipe(struct skl_sst *ctx, struct skl_pipe *pipe)
1326 /* If pipe was not created in FW, do not try to pause or delete */
1327 if (pipe->state < SKL_PIPE_PAUSED)
1330 ret = skl_set_pipe_state(ctx, pipe, PPL_RESET);
1332 dev_dbg(ctx->dev, "Failed to reset pipe ret=%d\n", ret);
1336 pipe->state = SKL_PIPE_RESET;
1341 /* Algo parameter set helper function */
1342 int skl_set_module_params(struct skl_sst *ctx, u32 *params, int size,
1343 u32 param_id, struct skl_module_cfg *mcfg)
1345 struct skl_ipc_large_config_msg msg;
1347 msg.module_id = mcfg->id.module_id;
1348 msg.instance_id = mcfg->id.pvt_id;
1349 msg.param_data_size = size;
1350 msg.large_param_id = param_id;
1352 return skl_ipc_set_large_config(&ctx->ipc, &msg, params);
1355 int skl_get_module_params(struct skl_sst *ctx, u32 *params, int size,
1356 u32 param_id, struct skl_module_cfg *mcfg)
1358 struct skl_ipc_large_config_msg msg;
1360 msg.module_id = mcfg->id.module_id;
1361 msg.instance_id = mcfg->id.pvt_id;
1362 msg.param_data_size = size;
1363 msg.large_param_id = param_id;
1365 return skl_ipc_get_large_config(&ctx->ipc, &msg, params);