WIP FPC-III support

[linux/fpc-iii.git] / sound / soc / sof / ipc.c

// SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
//
// This file is provided under a dual BSD/GPLv2 license.  When using or
// redistributing this file, you may do so under either license.
//
// Copyright(c) 2018 Intel Corporation. All rights reserved.
//
// Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
//
// Generic IPC layer that can work over MMIO and SPI/I2C. PHY layer provided
// by platform driver code.
//

#include <linux/mutex.h>
#include <linux/types.h>

#include "sof-priv.h"
#include "sof-audio.h"
#include "ops.h"

static void ipc_trace_message(struct snd_sof_dev *sdev, u32 msg_id);
static void ipc_stream_message(struct snd_sof_dev *sdev, u32 msg_cmd);

/*
 * IPC message Tx/Rx message handling.
 */

/* SOF generic IPC data */
struct snd_sof_ipc {
        struct snd_sof_dev *sdev;

        /* protects messages and the disable flag */
        struct mutex tx_mutex;
        /* disables further sending of ipc's */
        bool disable_ipc_tx;

        struct snd_sof_ipc_msg msg;
};

struct sof_ipc_ctrl_data_params {
        size_t msg_bytes;
        size_t hdr_bytes;
        size_t pl_size;
        size_t elems;
        u32 num_msg;
        u8 *src;
        u8 *dst;
};

#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_VERBOSE_IPC)
static void ipc_log_header(struct device *dev, u8 *text, u32 cmd)
{
        u8 *str;
        u8 *str2 = NULL;
        u32 glb;
        u32 type;
        bool vdbg = false;

        glb = cmd & SOF_GLB_TYPE_MASK;
        type = cmd & SOF_CMD_TYPE_MASK;

        switch (glb) {
        case SOF_IPC_GLB_REPLY:
                str = "GLB_REPLY"; break;
        case SOF_IPC_GLB_COMPOUND:
                str = "GLB_COMPOUND"; break;
        case SOF_IPC_GLB_TPLG_MSG:
                str = "GLB_TPLG_MSG";
                switch (type) {
                case SOF_IPC_TPLG_COMP_NEW:
                        str2 = "COMP_NEW"; break;
                case SOF_IPC_TPLG_COMP_FREE:
                        str2 = "COMP_FREE"; break;
                case SOF_IPC_TPLG_COMP_CONNECT:
                        str2 = "COMP_CONNECT"; break;
                case SOF_IPC_TPLG_PIPE_NEW:
                        str2 = "PIPE_NEW"; break;
                case SOF_IPC_TPLG_PIPE_FREE:
                        str2 = "PIPE_FREE"; break;
                case SOF_IPC_TPLG_PIPE_CONNECT:
                        str2 = "PIPE_CONNECT"; break;
                case SOF_IPC_TPLG_PIPE_COMPLETE:
                        str2 = "PIPE_COMPLETE"; break;
                case SOF_IPC_TPLG_BUFFER_NEW:
                        str2 = "BUFFER_NEW"; break;
                case SOF_IPC_TPLG_BUFFER_FREE:
                        str2 = "BUFFER_FREE"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_GLB_PM_MSG:
                str = "GLB_PM_MSG";
                switch (type) {
                case SOF_IPC_PM_CTX_SAVE:
                        str2 = "CTX_SAVE"; break;
                case SOF_IPC_PM_CTX_RESTORE:
                        str2 = "CTX_RESTORE"; break;
                case SOF_IPC_PM_CTX_SIZE:
                        str2 = "CTX_SIZE"; break;
                case SOF_IPC_PM_CLK_SET:
                        str2 = "CLK_SET"; break;
                case SOF_IPC_PM_CLK_GET:
                        str2 = "CLK_GET"; break;
                case SOF_IPC_PM_CLK_REQ:
                        str2 = "CLK_REQ"; break;
                case SOF_IPC_PM_CORE_ENABLE:
                        str2 = "CORE_ENABLE"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_GLB_COMP_MSG:
                str = "GLB_COMP_MSG";
                switch (type) {
                case SOF_IPC_COMP_SET_VALUE:
                        str2 = "SET_VALUE"; break;
                case SOF_IPC_COMP_GET_VALUE:
                        str2 = "GET_VALUE"; break;
                case SOF_IPC_COMP_SET_DATA:
                        str2 = "SET_DATA"; break;
                case SOF_IPC_COMP_GET_DATA:
                        str2 = "GET_DATA"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_GLB_STREAM_MSG:
                str = "GLB_STREAM_MSG";
                switch (type) {
                case SOF_IPC_STREAM_PCM_PARAMS:
                        str2 = "PCM_PARAMS"; break;
                case SOF_IPC_STREAM_PCM_PARAMS_REPLY:
                        str2 = "PCM_REPLY"; break;
                case SOF_IPC_STREAM_PCM_FREE:
                        str2 = "PCM_FREE"; break;
                case SOF_IPC_STREAM_TRIG_START:
                        str2 = "TRIG_START"; break;
                case SOF_IPC_STREAM_TRIG_STOP:
                        str2 = "TRIG_STOP"; break;
                case SOF_IPC_STREAM_TRIG_PAUSE:
                        str2 = "TRIG_PAUSE"; break;
                case SOF_IPC_STREAM_TRIG_RELEASE:
                        str2 = "TRIG_RELEASE"; break;
                case SOF_IPC_STREAM_TRIG_DRAIN:
                        str2 = "TRIG_DRAIN"; break;
                case SOF_IPC_STREAM_TRIG_XRUN:
                        str2 = "TRIG_XRUN"; break;
                case SOF_IPC_STREAM_POSITION:
                        vdbg = true;
                        str2 = "POSITION"; break;
                case SOF_IPC_STREAM_VORBIS_PARAMS:
                        str2 = "VORBIS_PARAMS"; break;
                case SOF_IPC_STREAM_VORBIS_FREE:
                        str2 = "VORBIS_FREE"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_FW_READY:
                str = "FW_READY"; break;
        case SOF_IPC_GLB_DAI_MSG:
                str = "GLB_DAI_MSG";
                switch (type) {
                case SOF_IPC_DAI_CONFIG:
                        str2 = "CONFIG"; break;
                case SOF_IPC_DAI_LOOPBACK:
                        str2 = "LOOPBACK"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_GLB_TRACE_MSG:
                str = "GLB_TRACE_MSG"; break;
        case SOF_IPC_GLB_TEST_MSG:
                str = "GLB_TEST_MSG";
                switch (type) {
                case SOF_IPC_TEST_IPC_FLOOD:
                        str2 = "IPC_FLOOD"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        case SOF_IPC_GLB_DEBUG:
                str = "GLB_DEBUG";
                switch (type) {
                case SOF_IPC_DEBUG_MEM_USAGE:
                        str2 = "MEM_USAGE"; break;
                default:
                        str2 = "unknown type"; break;
                }
                break;
        default:
                str = "unknown GLB command"; break;
        }

        if (str2) {
                if (vdbg)
                        dev_vdbg(dev, "%s: 0x%x: %s: %s\n", text, cmd, str, str2);
                else
                        dev_dbg(dev, "%s: 0x%x: %s: %s\n", text, cmd, str, str2);
        } else {
                dev_dbg(dev, "%s: 0x%x: %s\n", text, cmd, str);
        }
}
#else
static inline void ipc_log_header(struct device *dev, u8 *text, u32 cmd)
{
        if ((cmd & SOF_GLB_TYPE_MASK) != SOF_IPC_GLB_TRACE_MSG)
                dev_dbg(dev, "%s: 0x%x\n", text, cmd);
}
#endif

/* wait for IPC message reply */
static int tx_wait_done(struct snd_sof_ipc *ipc, struct snd_sof_ipc_msg *msg,
                        void *reply_data)
{
        struct snd_sof_dev *sdev = ipc->sdev;
        struct sof_ipc_cmd_hdr *hdr = msg->msg_data;
        int ret;

        /* wait for DSP IPC completion */
        ret = wait_event_timeout(msg->waitq, msg->ipc_complete,
                                 msecs_to_jiffies(sdev->ipc_timeout));

        if (ret == 0) {
                dev_err(sdev->dev, "error: ipc timed out for 0x%x size %d\n",
                        hdr->cmd, hdr->size);
                snd_sof_handle_fw_exception(ipc->sdev);
                ret = -ETIMEDOUT;
        } else {
                ret = msg->reply_error;
                if (ret < 0) {
                        dev_err(sdev->dev, "error: ipc error for 0x%x size %zu\n",
                                hdr->cmd, msg->reply_size);
                } else {
                        ipc_log_header(sdev->dev, "ipc tx succeeded", hdr->cmd);
                        if (msg->reply_size)
                                /* copy the data returned from DSP */
                                memcpy(reply_data, msg->reply_data,
                                       msg->reply_size);
                }
        }

        return ret;
}

/* send IPC message from host to DSP */
static int sof_ipc_tx_message_unlocked(struct snd_sof_ipc *ipc, u32 header,
                                       void *msg_data, size_t msg_bytes,
                                       void *reply_data, size_t reply_bytes)
{
        struct snd_sof_dev *sdev = ipc->sdev;
        struct snd_sof_ipc_msg *msg;
        int ret;

        if (ipc->disable_ipc_tx)
                return -ENODEV;

        /*
         * The spin-lock is also still needed to protect message objects against
         * other atomic contexts.
         */
        spin_lock_irq(&sdev->ipc_lock);

        /* initialise the message */
        msg = &ipc->msg;

        msg->header = header;
        msg->msg_size = msg_bytes;
        msg->reply_size = reply_bytes;
        msg->reply_error = 0;

        /* attach any data */
        if (msg_bytes)
                memcpy(msg->msg_data, msg_data, msg_bytes);

        sdev->msg = msg;

        ret = snd_sof_dsp_send_msg(sdev, msg);
        /* Next reply that we receive will be related to this message */
        if (!ret)
                msg->ipc_complete = false;

        spin_unlock_irq(&sdev->ipc_lock);

        if (ret < 0) {
                dev_err_ratelimited(sdev->dev,
                                    "error: ipc tx failed with error %d\n",
                                    ret);
                return ret;
        }

        ipc_log_header(sdev->dev, "ipc tx", msg->header);

        /* now wait for completion */
        if (!ret)
                ret = tx_wait_done(ipc, msg, reply_data);

        return ret;
}

/* send IPC message from host to DSP */
int sof_ipc_tx_message(struct snd_sof_ipc *ipc, u32 header,
                       void *msg_data, size_t msg_bytes, void *reply_data,
                       size_t reply_bytes)
{
        const struct sof_dsp_power_state target_state = {
                .state = SOF_DSP_PM_D0,
        };
        int ret;

        /* ensure the DSP is in D0 before sending a new IPC */
        ret = snd_sof_dsp_set_power_state(ipc->sdev, &target_state);
        if (ret < 0) {
                dev_err(ipc->sdev->dev, "error: resuming DSP %d\n", ret);
                return ret;
        }

        return sof_ipc_tx_message_no_pm(ipc, header, msg_data, msg_bytes,
                                        reply_data, reply_bytes);
}
EXPORT_SYMBOL(sof_ipc_tx_message);

/*
 * send IPC message from host to DSP without modifying the DSP state.
 * This will be used for IPC's that can be handled by the DSP
 * even in a low-power D0 substate.
 */
int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, u32 header,
                             void *msg_data, size_t msg_bytes,
                             void *reply_data, size_t reply_bytes)
{
        int ret;

        if (msg_bytes > SOF_IPC_MSG_MAX_SIZE ||
            reply_bytes > SOF_IPC_MSG_MAX_SIZE)
                return -ENOBUFS;

        /* Serialise IPC TX */
        mutex_lock(&ipc->tx_mutex);

        ret = sof_ipc_tx_message_unlocked(ipc, header, msg_data, msg_bytes,
                                          reply_data, reply_bytes);

        mutex_unlock(&ipc->tx_mutex);

        return ret;
}
EXPORT_SYMBOL(sof_ipc_tx_message_no_pm);

/* handle reply message from DSP */
void snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id)
{
        struct snd_sof_ipc_msg *msg = &sdev->ipc->msg;

        if (msg->ipc_complete) {
                dev_dbg(sdev->dev,
                        "no reply expected, received 0x%x, will be ignored",
                        msg_id);
                return;
        }

        /* wake up and return the error if we have waiters on this message ? */
        msg->ipc_complete = true;
        wake_up(&msg->waitq);
}
EXPORT_SYMBOL(snd_sof_ipc_reply);

/* DSP firmware has sent host a message  */
void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev)
{
        struct sof_ipc_cmd_hdr hdr;
        u32 cmd, type;
        int err = 0;

        /* read back header */
        snd_sof_ipc_msg_data(sdev, NULL, &hdr, sizeof(hdr));
        ipc_log_header(sdev->dev, "ipc rx", hdr.cmd);

        cmd = hdr.cmd & SOF_GLB_TYPE_MASK;
        type = hdr.cmd & SOF_CMD_TYPE_MASK;

        /* check message type */
        switch (cmd) {
        case SOF_IPC_GLB_REPLY:
                dev_err(sdev->dev, "error: ipc reply unknown\n");
                break;
        case SOF_IPC_FW_READY:
                /* check for FW boot completion */
                if (sdev->fw_state == SOF_FW_BOOT_IN_PROGRESS) {
                        err = sof_ops(sdev)->fw_ready(sdev, cmd);
                        if (err < 0)
                                sdev->fw_state = SOF_FW_BOOT_READY_FAILED;
                        else
                                sdev->fw_state = SOF_FW_BOOT_COMPLETE;

                        /* wake up firmware loader */
                        wake_up(&sdev->boot_wait);
                }
                break;
        case SOF_IPC_GLB_COMPOUND:
        case SOF_IPC_GLB_TPLG_MSG:
        case SOF_IPC_GLB_PM_MSG:
        case SOF_IPC_GLB_COMP_MSG:
                break;
        case SOF_IPC_GLB_STREAM_MSG:
                /* need to pass msg id into the function */
                ipc_stream_message(sdev, hdr.cmd);
                break;
        case SOF_IPC_GLB_TRACE_MSG:
                ipc_trace_message(sdev, type);
                break;
        default:
                dev_err(sdev->dev, "error: unknown DSP message 0x%x\n", cmd);
                break;
        }

        ipc_log_header(sdev->dev, "ipc rx done", hdr.cmd);
}
EXPORT_SYMBOL(snd_sof_ipc_msgs_rx);

/*
 * IPC trace mechanism.
 */

static void ipc_trace_message(struct snd_sof_dev *sdev, u32 msg_id)
{
        struct sof_ipc_dma_trace_posn posn;

        switch (msg_id) {
        case SOF_IPC_TRACE_DMA_POSITION:
                /* read back full message */
                snd_sof_ipc_msg_data(sdev, NULL, &posn, sizeof(posn));
                snd_sof_trace_update_pos(sdev, &posn);
                break;
        default:
                dev_err(sdev->dev, "error: unhandled trace message %x\n",
                        msg_id);
                break;
        }
}

/*
 * IPC stream position.
 */

static void ipc_period_elapsed(struct snd_sof_dev *sdev, u32 msg_id)
{
        struct snd_soc_component *scomp = sdev->component;
        struct snd_sof_pcm_stream *stream;
        struct sof_ipc_stream_posn posn;
        struct snd_sof_pcm *spcm;
        int direction;

        spcm = snd_sof_find_spcm_comp(scomp, msg_id, &direction);
        if (!spcm) {
                dev_err(sdev->dev,
                        "error: period elapsed for unknown stream, msg_id %d\n",
                        msg_id);
                return;
        }

        stream = &spcm->stream[direction];
        snd_sof_ipc_msg_data(sdev, stream->substream, &posn, sizeof(posn));

        dev_vdbg(sdev->dev, "posn : host 0x%llx dai 0x%llx wall 0x%llx\n",
                 posn.host_posn, posn.dai_posn, posn.wallclock);

        memcpy(&stream->posn, &posn, sizeof(posn));

        /* only inform ALSA for period_wakeup mode */
        if (!stream->substream->runtime->no_period_wakeup)
                snd_sof_pcm_period_elapsed(stream->substream);
}

/* DSP notifies host of an XRUN within FW */
static void ipc_xrun(struct snd_sof_dev *sdev, u32 msg_id)
{
        struct snd_soc_component *scomp = sdev->component;
        struct snd_sof_pcm_stream *stream;
        struct sof_ipc_stream_posn posn;
        struct snd_sof_pcm *spcm;
        int direction;

        spcm = snd_sof_find_spcm_comp(scomp, msg_id, &direction);
        if (!spcm) {
                dev_err(sdev->dev, "error: XRUN for unknown stream, msg_id %d\n",
                        msg_id);
                return;
        }

        stream = &spcm->stream[direction];
        snd_sof_ipc_msg_data(sdev, stream->substream, &posn, sizeof(posn));

        dev_dbg(sdev->dev,  "posn XRUN: host %llx comp %d size %d\n",
                posn.host_posn, posn.xrun_comp_id, posn.xrun_size);

#if defined(CONFIG_SND_SOC_SOF_DEBUG_XRUN_STOP)
        /* stop PCM on XRUN - used for pipeline debug */
        memcpy(&stream->posn, &posn, sizeof(posn));
        snd_pcm_stop_xrun(stream->substream);
#endif
}

/* stream notifications from DSP FW */
static void ipc_stream_message(struct snd_sof_dev *sdev, u32 msg_cmd)
{
        /* get msg cmd type and msd id */
        u32 msg_type = msg_cmd & SOF_CMD_TYPE_MASK;
        u32 msg_id = SOF_IPC_MESSAGE_ID(msg_cmd);

        switch (msg_type) {
        case SOF_IPC_STREAM_POSITION:
                ipc_period_elapsed(sdev, msg_id);
                break;
        case SOF_IPC_STREAM_TRIG_XRUN:
                ipc_xrun(sdev, msg_id);
                break;
        default:
                dev_err(sdev->dev, "error: unhandled stream message %x\n",
                        msg_id);
                break;
        }
}

/* get stream position IPC - use faster MMIO method if available on platform */
int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
                            struct snd_sof_pcm *spcm, int direction,
                            struct sof_ipc_stream_posn *posn)
{
        struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
        struct sof_ipc_stream stream;
        int err;

        /* read position via slower IPC */
        stream.hdr.size = sizeof(stream);
        stream.hdr.cmd = SOF_IPC_GLB_STREAM_MSG | SOF_IPC_STREAM_POSITION;
        stream.comp_id = spcm->stream[direction].comp_id;

        /* send IPC to the DSP */
        err = sof_ipc_tx_message(sdev->ipc,
                                 stream.hdr.cmd, &stream, sizeof(stream), posn,
                                 sizeof(*posn));
        if (err < 0) {
                dev_err(sdev->dev, "error: failed to get stream %d position\n",
                        stream.comp_id);
                return err;
        }

        return 0;
}
EXPORT_SYMBOL(snd_sof_ipc_stream_posn);

static int sof_get_ctrl_copy_params(enum sof_ipc_ctrl_type ctrl_type,
                                    struct sof_ipc_ctrl_data *src,
                                    struct sof_ipc_ctrl_data *dst,
                                    struct sof_ipc_ctrl_data_params *sparams)
{
        switch (ctrl_type) {
        case SOF_CTRL_TYPE_VALUE_CHAN_GET:
        case SOF_CTRL_TYPE_VALUE_CHAN_SET:
                sparams->src = (u8 *)src->chanv;
                sparams->dst = (u8 *)dst->chanv;
                break;
        case SOF_CTRL_TYPE_VALUE_COMP_GET:
        case SOF_CTRL_TYPE_VALUE_COMP_SET:
                sparams->src = (u8 *)src->compv;
                sparams->dst = (u8 *)dst->compv;
                break;
        case SOF_CTRL_TYPE_DATA_GET:
        case SOF_CTRL_TYPE_DATA_SET:
                sparams->src = (u8 *)src->data->data;
                sparams->dst = (u8 *)dst->data->data;
                break;
        default:
                return -EINVAL;
        }

        /* calculate payload size and number of messages */
        sparams->pl_size = SOF_IPC_MSG_MAX_SIZE - sparams->hdr_bytes;
        sparams->num_msg = DIV_ROUND_UP(sparams->msg_bytes, sparams->pl_size);

        return 0;
}

static int sof_set_get_large_ctrl_data(struct snd_sof_dev *sdev,
                                       struct sof_ipc_ctrl_data *cdata,
                                       struct sof_ipc_ctrl_data_params *sparams,
                                       bool send)
{
        struct sof_ipc_ctrl_data *partdata;
        size_t send_bytes;
        size_t offset = 0;
        size_t msg_bytes;
        size_t pl_size;
        int err;
        int i;

        /* allocate max ipc size because we have at least one */
        partdata = kzalloc(SOF_IPC_MSG_MAX_SIZE, GFP_KERNEL);
        if (!partdata)
                return -ENOMEM;

        if (send)
                err = sof_get_ctrl_copy_params(cdata->type, cdata, partdata,
                                               sparams);
        else
                err = sof_get_ctrl_copy_params(cdata->type, partdata, cdata,
                                               sparams);
        if (err < 0) {
                kfree(partdata);
                return err;
        }

        msg_bytes = sparams->msg_bytes;
        pl_size = sparams->pl_size;

        /* copy the header data */
        memcpy(partdata, cdata, sparams->hdr_bytes);

        /* Serialise IPC TX */
        mutex_lock(&sdev->ipc->tx_mutex);

        /* copy the payload data in a loop */
        for (i = 0; i < sparams->num_msg; i++) {
                send_bytes = min(msg_bytes, pl_size);
                partdata->num_elems = send_bytes;
                partdata->rhdr.hdr.size = sparams->hdr_bytes + send_bytes;
                partdata->msg_index = i;
                msg_bytes -= send_bytes;
                partdata->elems_remaining = msg_bytes;

                if (send)
                        memcpy(sparams->dst, sparams->src + offset, send_bytes);

                err = sof_ipc_tx_message_unlocked(sdev->ipc,
                                                  partdata->rhdr.hdr.cmd,
                                                  partdata,
                                                  partdata->rhdr.hdr.size,
                                                  partdata,
                                                  partdata->rhdr.hdr.size);
                if (err < 0)
                        break;

                if (!send)
                        memcpy(sparams->dst + offset, sparams->src, send_bytes);

                offset += pl_size;
        }

        mutex_unlock(&sdev->ipc->tx_mutex);

        kfree(partdata);
        return err;
}

/*
 * IPC get()/set() for kcontrols.
 */
int snd_sof_ipc_set_get_comp_data(struct snd_sof_control *scontrol,
                                  u32 ipc_cmd,
                                  enum sof_ipc_ctrl_type ctrl_type,
                                  enum sof_ipc_ctrl_cmd ctrl_cmd,
                                  bool send)
{
        struct snd_soc_component *scomp = scontrol->scomp;
        struct sof_ipc_ctrl_data *cdata = scontrol->control_data;
        struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
        struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
        struct sof_ipc_fw_version *v = &ready->version;
        struct sof_ipc_ctrl_data_params sparams;
        size_t send_bytes;
        int err;

        /* read or write firmware volume */
        if (scontrol->readback_offset != 0) {
                /* write/read value header via mmaped region */
                send_bytes = sizeof(struct sof_ipc_ctrl_value_chan) *
                cdata->num_elems;
                if (send)
                        snd_sof_dsp_block_write(sdev, sdev->mmio_bar,
                                                scontrol->readback_offset,
                                                cdata->chanv, send_bytes);

                else
                        snd_sof_dsp_block_read(sdev, sdev->mmio_bar,
                                               scontrol->readback_offset,
                                               cdata->chanv, send_bytes);
                return 0;
        }

        cdata->rhdr.hdr.cmd = SOF_IPC_GLB_COMP_MSG | ipc_cmd;
        cdata->cmd = ctrl_cmd;
        cdata->type = ctrl_type;
        cdata->comp_id = scontrol->comp_id;
        cdata->msg_index = 0;

        /* calculate header and data size */
        switch (cdata->type) {
        case SOF_CTRL_TYPE_VALUE_CHAN_GET:
        case SOF_CTRL_TYPE_VALUE_CHAN_SET:
                sparams.msg_bytes = scontrol->num_channels *
                        sizeof(struct sof_ipc_ctrl_value_chan);
                sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data);
                sparams.elems = scontrol->num_channels;
                break;
        case SOF_CTRL_TYPE_VALUE_COMP_GET:
        case SOF_CTRL_TYPE_VALUE_COMP_SET:
                sparams.msg_bytes = scontrol->num_channels *
                        sizeof(struct sof_ipc_ctrl_value_comp);
                sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data);
                sparams.elems = scontrol->num_channels;
                break;
        case SOF_CTRL_TYPE_DATA_GET:
        case SOF_CTRL_TYPE_DATA_SET:
                sparams.msg_bytes = cdata->data->size;
                sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data) +
                        sizeof(struct sof_abi_hdr);
                sparams.elems = cdata->data->size;
                break;
        default:
                return -EINVAL;
        }

        cdata->rhdr.hdr.size = sparams.msg_bytes + sparams.hdr_bytes;
        cdata->num_elems = sparams.elems;
        cdata->elems_remaining = 0;

        /* send normal size ipc in one part */
        if (cdata->rhdr.hdr.size <= SOF_IPC_MSG_MAX_SIZE) {
                err = sof_ipc_tx_message(sdev->ipc, cdata->rhdr.hdr.cmd, cdata,
                                         cdata->rhdr.hdr.size, cdata,
                                         cdata->rhdr.hdr.size);

                if (err < 0)
                        dev_err(sdev->dev, "error: set/get ctrl ipc comp %d\n",
                                cdata->comp_id);

                return err;
        }

        /* data is bigger than max ipc size, chop into smaller pieces */
        dev_dbg(sdev->dev, "large ipc size %u, control size %u\n",
                cdata->rhdr.hdr.size, scontrol->size);

        /* large messages is only supported from ABI 3.3.0 onwards */
        if (v->abi_version < SOF_ABI_VER(3, 3, 0)) {
                dev_err(sdev->dev, "error: incompatible FW ABI version\n");
                return -EINVAL;
        }

        err = sof_set_get_large_ctrl_data(sdev, cdata, &sparams, send);

        if (err < 0)
                dev_err(sdev->dev, "error: set/get large ctrl ipc comp %d\n",
                        cdata->comp_id);

        return err;
}
EXPORT_SYMBOL(snd_sof_ipc_set_get_comp_data);

/*
 * IPC layer enumeration.
 */

int snd_sof_dsp_mailbox_init(struct snd_sof_dev *sdev, u32 dspbox,
                             size_t dspbox_size, u32 hostbox,
                             size_t hostbox_size)
{
        sdev->dsp_box.offset = dspbox;
        sdev->dsp_box.size = dspbox_size;
        sdev->host_box.offset = hostbox;
        sdev->host_box.size = hostbox_size;
        return 0;
}
EXPORT_SYMBOL(snd_sof_dsp_mailbox_init);

int snd_sof_ipc_valid(struct snd_sof_dev *sdev)
{
        struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
        struct sof_ipc_fw_version *v = &ready->version;

        dev_info(sdev->dev,
                 "Firmware info: version %d:%d:%d-%s\n",  v->major, v->minor,
                 v->micro, v->tag);
        dev_info(sdev->dev,
                 "Firmware: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
                 SOF_ABI_VERSION_MAJOR(v->abi_version),
                 SOF_ABI_VERSION_MINOR(v->abi_version),
                 SOF_ABI_VERSION_PATCH(v->abi_version),
                 SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH);

        if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, v->abi_version)) {
                dev_err(sdev->dev, "error: incompatible FW ABI version\n");
                return -EINVAL;
        }

        if (v->abi_version > SOF_ABI_VERSION) {
                if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
                        dev_warn(sdev->dev, "warn: FW ABI is more recent than kernel\n");
                } else {
                        dev_err(sdev->dev, "error: FW ABI is more recent than kernel\n");
                        return -EINVAL;
                }
        }

        if (ready->flags & SOF_IPC_INFO_BUILD) {
                dev_info(sdev->dev,
                         "Firmware debug build %d on %s-%s - options:\n"
                         " GDB: %s\n"
                         " lock debug: %s\n"
                         " lock vdebug: %s\n",
                         v->build, v->date, v->time,
                         (ready->flags & SOF_IPC_INFO_GDB) ?
                                "enabled" : "disabled",
                         (ready->flags & SOF_IPC_INFO_LOCKS) ?
                                "enabled" : "disabled",
                         (ready->flags & SOF_IPC_INFO_LOCKSV) ?
                                "enabled" : "disabled");
        }

        /* copy the fw_version into debugfs at first boot */
        memcpy(&sdev->fw_version, v, sizeof(*v));

        return 0;
}
EXPORT_SYMBOL(snd_sof_ipc_valid);

struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev)
{
        struct snd_sof_ipc *ipc;
        struct snd_sof_ipc_msg *msg;

        ipc = devm_kzalloc(sdev->dev, sizeof(*ipc), GFP_KERNEL);
        if (!ipc)
                return NULL;

        mutex_init(&ipc->tx_mutex);
        ipc->sdev = sdev;
        msg = &ipc->msg;

        /* indicate that we aren't sending a message ATM */
        msg->ipc_complete = true;

        /* pre-allocate message data */
        msg->msg_data = devm_kzalloc(sdev->dev, SOF_IPC_MSG_MAX_SIZE,
                                     GFP_KERNEL);
        if (!msg->msg_data)
                return NULL;

        msg->reply_data = devm_kzalloc(sdev->dev, SOF_IPC_MSG_MAX_SIZE,
                                       GFP_KERNEL);
        if (!msg->reply_data)
                return NULL;

        init_waitqueue_head(&msg->waitq);

        return ipc;
}
EXPORT_SYMBOL(snd_sof_ipc_init);

void snd_sof_ipc_free(struct snd_sof_dev *sdev)
{
        struct snd_sof_ipc *ipc = sdev->ipc;

        if (!ipc)
                return;

        /* disable sending of ipc's */
        mutex_lock(&ipc->tx_mutex);
        ipc->disable_ipc_tx = true;
        mutex_unlock(&ipc->tx_mutex);
}
EXPORT_SYMBOL(snd_sof_ipc_free);