sound/soc/sof/ipc.c

   1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
   2 //
   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.
   5 //
   6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
   7 //
   8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
   9 //
  10 // Generic IPC layer that can work over MMIO and SPI/I2C. PHY layer provided
  11 // by platform driver code.
  12 //
  13
  14 #include <linux/mutex.h>
  15 #include <linux/types.h>
  16
  17 #include "sof-priv.h"
  18 #include "sof-audio.h"
  19 #include "ops.h"
  20
  21 static void ipc_trace_message(struct snd_sof_dev *sdev, u32 msg_id);
  22 static void ipc_stream_message(struct snd_sof_dev *sdev, u32 msg_cmd);
  23
  24 /*
  25  * IPC message Tx/Rx message handling.
  26  */
  27
  28 /* SOF generic IPC data */
  29 struct snd_sof_ipc {
  30         struct snd_sof_dev *sdev;
  31
  32         /* protects messages and the disable flag */
  33         struct mutex tx_mutex;
  34         /* disables further sending of ipc's */
  35         bool disable_ipc_tx;
  36
  37         struct snd_sof_ipc_msg msg;
  38 };
  39
  40 struct sof_ipc_ctrl_data_params {
  41         size_t msg_bytes;
  42         size_t hdr_bytes;
  43         size_t pl_size;
  44         size_t elems;
  45         u32 num_msg;
  46         u8 *src;
  47         u8 *dst;
  48 };
  49
  50 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_VERBOSE_IPC)
  51 static void ipc_log_header(struct device *dev, u8 *text, u32 cmd)
  52 {
  53         u8 *str;
  54         u8 *str2 = NULL;
  55         u32 glb;
  56         u32 type;
  57
  58         glb = cmd & SOF_GLB_TYPE_MASK;
  59         type = cmd & SOF_CMD_TYPE_MASK;
  60
  61         switch (glb) {
  62         case SOF_IPC_GLB_REPLY:
  63                 str = "GLB_REPLY"; break;
  64         case SOF_IPC_GLB_COMPOUND:
  65                 str = "GLB_COMPOUND"; break;
  66         case SOF_IPC_GLB_TPLG_MSG:
  67                 str = "GLB_TPLG_MSG";
  68                 switch (type) {
  69                 case SOF_IPC_TPLG_COMP_NEW:
  70                         str2 = "COMP_NEW"; break;
  71                 case SOF_IPC_TPLG_COMP_FREE:
  72                         str2 = "COMP_FREE"; break;
  73                 case SOF_IPC_TPLG_COMP_CONNECT:
  74                         str2 = "COMP_CONNECT"; break;
  75                 case SOF_IPC_TPLG_PIPE_NEW:
  76                         str2 = "PIPE_NEW"; break;
  77                 case SOF_IPC_TPLG_PIPE_FREE:
  78                         str2 = "PIPE_FREE"; break;
  79                 case SOF_IPC_TPLG_PIPE_CONNECT:
  80                         str2 = "PIPE_CONNECT"; break;
  81                 case SOF_IPC_TPLG_PIPE_COMPLETE:
  82                         str2 = "PIPE_COMPLETE"; break;
  83                 case SOF_IPC_TPLG_BUFFER_NEW:
  84                         str2 = "BUFFER_NEW"; break;
  85                 case SOF_IPC_TPLG_BUFFER_FREE:
  86                         str2 = "BUFFER_FREE"; break;
  87                 default:
  88                         str2 = "unknown type"; break;
  89                 }
  90                 break;
  91         case SOF_IPC_GLB_PM_MSG:
  92                 str = "GLB_PM_MSG";
  93                 switch (type) {
  94                 case SOF_IPC_PM_CTX_SAVE:
  95                         str2 = "CTX_SAVE"; break;
  96                 case SOF_IPC_PM_CTX_RESTORE:
  97                         str2 = "CTX_RESTORE"; break;
  98                 case SOF_IPC_PM_CTX_SIZE:
  99                         str2 = "CTX_SIZE"; break;
 100                 case SOF_IPC_PM_CLK_SET:
 101                         str2 = "CLK_SET"; break;
 102                 case SOF_IPC_PM_CLK_GET:
 103                         str2 = "CLK_GET"; break;
 104                 case SOF_IPC_PM_CLK_REQ:
 105                         str2 = "CLK_REQ"; break;
 106                 case SOF_IPC_PM_CORE_ENABLE:
 107                         str2 = "CORE_ENABLE"; break;
 108                 default:
 109                         str2 = "unknown type"; break;
 110                 }
 111                 break;
 112         case SOF_IPC_GLB_COMP_MSG:
 113                 str = "GLB_COMP_MSG";
 114                 switch (type) {
 115                 case SOF_IPC_COMP_SET_VALUE:
 116                         str2 = "SET_VALUE"; break;
 117                 case SOF_IPC_COMP_GET_VALUE:
 118                         str2 = "GET_VALUE"; break;
 119                 case SOF_IPC_COMP_SET_DATA:
 120                         str2 = "SET_DATA"; break;
 121                 case SOF_IPC_COMP_GET_DATA:
 122                         str2 = "GET_DATA"; break;
 123                 default:
 124                         str2 = "unknown type"; break;
 125                 }
 126                 break;
 127         case SOF_IPC_GLB_STREAM_MSG:
 128                 str = "GLB_STREAM_MSG";
 129                 switch (type) {
 130                 case SOF_IPC_STREAM_PCM_PARAMS:
 131                         str2 = "PCM_PARAMS"; break;
 132                 case SOF_IPC_STREAM_PCM_PARAMS_REPLY:
 133                         str2 = "PCM_REPLY"; break;
 134                 case SOF_IPC_STREAM_PCM_FREE:
 135                         str2 = "PCM_FREE"; break;
 136                 case SOF_IPC_STREAM_TRIG_START:
 137                         str2 = "TRIG_START"; break;
 138                 case SOF_IPC_STREAM_TRIG_STOP:
 139                         str2 = "TRIG_STOP"; break;
 140                 case SOF_IPC_STREAM_TRIG_PAUSE:
 141                         str2 = "TRIG_PAUSE"; break;
 142                 case SOF_IPC_STREAM_TRIG_RELEASE:
 143                         str2 = "TRIG_RELEASE"; break;
 144                 case SOF_IPC_STREAM_TRIG_DRAIN:
 145                         str2 = "TRIG_DRAIN"; break;
 146                 case SOF_IPC_STREAM_TRIG_XRUN:
 147                         str2 = "TRIG_XRUN"; break;
 148                 case SOF_IPC_STREAM_POSITION:
 149                         str2 = "POSITION"; break;
 150                 case SOF_IPC_STREAM_VORBIS_PARAMS:
 151                         str2 = "VORBIS_PARAMS"; break;
 152                 case SOF_IPC_STREAM_VORBIS_FREE:
 153                         str2 = "VORBIS_FREE"; break;
 154                 default:
 155                         str2 = "unknown type"; break;
 156                 }
 157                 break;
 158         case SOF_IPC_FW_READY:
 159                 str = "FW_READY"; break;
 160         case SOF_IPC_GLB_DAI_MSG:
 161                 str = "GLB_DAI_MSG";
 162                 switch (type) {
 163                 case SOF_IPC_DAI_CONFIG:
 164                         str2 = "CONFIG"; break;
 165                 case SOF_IPC_DAI_LOOPBACK:
 166                         str2 = "LOOPBACK"; break;
 167                 default:
 168                         str2 = "unknown type"; break;
 169                 }
 170                 break;
 171         case SOF_IPC_GLB_TRACE_MSG:
 172                 str = "GLB_TRACE_MSG"; break;
 173         case SOF_IPC_GLB_TEST_MSG:
 174                 str = "GLB_TEST_MSG";
 175                 switch (type) {
 176                 case SOF_IPC_TEST_IPC_FLOOD:
 177                         str2 = "IPC_FLOOD"; break;
 178                 default:
 179                         str2 = "unknown type"; break;
 180                 }
 181                 break;
 182         default:
 183                 str = "unknown GLB command"; break;
 184         }
 185
 186         if (str2)
 187                 dev_dbg(dev, "%s: 0x%x: %s: %s\n", text, cmd, str, str2);
 188         else
 189                 dev_dbg(dev, "%s: 0x%x: %s\n", text, cmd, str);
 190 }
 191 #else
 192 static inline void ipc_log_header(struct device *dev, u8 *text, u32 cmd)
 193 {
 194         if ((cmd & SOF_GLB_TYPE_MASK) != SOF_IPC_GLB_TRACE_MSG)
 195                 dev_dbg(dev, "%s: 0x%x\n", text, cmd);
 196 }
 197 #endif
 198
 199 /* wait for IPC message reply */
 200 static int tx_wait_done(struct snd_sof_ipc *ipc, struct snd_sof_ipc_msg *msg,
 201                         void *reply_data)
 202 {
 203         struct snd_sof_dev *sdev = ipc->sdev;
 204         struct sof_ipc_cmd_hdr *hdr = msg->msg_data;
 205         int ret;
 206
 207         /* wait for DSP IPC completion */
 208         ret = wait_event_timeout(msg->waitq, msg->ipc_complete,
 209                                  msecs_to_jiffies(sdev->ipc_timeout));
 210
 211         if (ret == 0) {
 212                 dev_err(sdev->dev, "error: ipc timed out for 0x%x size %d\n",
 213                         hdr->cmd, hdr->size);
 214                 snd_sof_handle_fw_exception(ipc->sdev);
 215                 ret = -ETIMEDOUT;
 216         } else {
 217                 /* copy the data returned from DSP */
 218                 ret = msg->reply_error;
 219                 if (msg->reply_size)
 220                         memcpy(reply_data, msg->reply_data, msg->reply_size);
 221                 if (ret < 0)
 222                         dev_err(sdev->dev, "error: ipc error for 0x%x size %zu\n",
 223                                 hdr->cmd, msg->reply_size);
 224                 else
 225                         ipc_log_header(sdev->dev, "ipc tx succeeded", hdr->cmd);
 226         }
 227
 228         return ret;
 229 }
 230
 231 /* send IPC message from host to DSP */
 232 static int sof_ipc_tx_message_unlocked(struct snd_sof_ipc *ipc, u32 header,
 233                                        void *msg_data, size_t msg_bytes,
 234                                        void *reply_data, size_t reply_bytes)
 235 {
 236         struct snd_sof_dev *sdev = ipc->sdev;
 237         struct snd_sof_ipc_msg *msg;
 238         int ret;
 239
 240         if (ipc->disable_ipc_tx)
 241                 return -ENODEV;
 242
 243         /*
 244          * The spin-lock is also still needed to protect message objects against
 245          * other atomic contexts.
 246          */
 247         spin_lock_irq(&sdev->ipc_lock);
 248
 249         /* initialise the message */
 250         msg = &ipc->msg;
 251
 252         msg->header = header;
 253         msg->msg_size = msg_bytes;
 254         msg->reply_size = reply_bytes;
 255         msg->reply_error = 0;
 256
 257         /* attach any data */
 258         if (msg_bytes)
 259                 memcpy(msg->msg_data, msg_data, msg_bytes);
 260
 261         sdev->msg = msg;
 262
 263         ret = snd_sof_dsp_send_msg(sdev, msg);
 264         /* Next reply that we receive will be related to this message */
 265         if (!ret)
 266                 msg->ipc_complete = false;
 267
 268         spin_unlock_irq(&sdev->ipc_lock);
 269
 270         if (ret < 0) {
 271                 dev_err_ratelimited(sdev->dev,
 272                                     "error: ipc tx failed with error %d\n",
 273                                     ret);
 274                 return ret;
 275         }
 276
 277         ipc_log_header(sdev->dev, "ipc tx", msg->header);
 278
 279         /* now wait for completion */
 280         if (!ret)
 281                 ret = tx_wait_done(ipc, msg, reply_data);
 282
 283         return ret;
 284 }
 285
 286 /* send IPC message from host to DSP */
 287 int sof_ipc_tx_message(struct snd_sof_ipc *ipc, u32 header,
 288                        void *msg_data, size_t msg_bytes, void *reply_data,
 289                        size_t reply_bytes)
 290 {
 291         const struct sof_dsp_power_state target_state = {
 292                 .state = SOF_DSP_PM_D0,
 293         };
 294         int ret;
 295
 296         /* ensure the DSP is in D0 before sending a new IPC */
 297         ret = snd_sof_dsp_set_power_state(ipc->sdev, &target_state);
 298         if (ret < 0) {
 299                 dev_err(ipc->sdev->dev, "error: resuming DSP %d\n", ret);
 300                 return ret;
 301         }
 302
 303         return sof_ipc_tx_message_no_pm(ipc, header, msg_data, msg_bytes,
 304                                         reply_data, reply_bytes);
 305 }
 306 EXPORT_SYMBOL(sof_ipc_tx_message);
 307
 308 /*
 309  * send IPC message from host to DSP without modifying the DSP state.
 310  * This will be used for IPC's that can be handled by the DSP
 311  * even in a low-power D0 substate.
 312  */
 313 int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, u32 header,
 314                              void *msg_data, size_t msg_bytes,
 315                              void *reply_data, size_t reply_bytes)
 316 {
 317         int ret;
 318
 319         if (msg_bytes > SOF_IPC_MSG_MAX_SIZE ||
 320             reply_bytes > SOF_IPC_MSG_MAX_SIZE)
 321                 return -ENOBUFS;
 322
 323         /* Serialise IPC TX */
 324         mutex_lock(&ipc->tx_mutex);
 325
 326         ret = sof_ipc_tx_message_unlocked(ipc, header, msg_data, msg_bytes,
 327                                           reply_data, reply_bytes);
 328
 329         mutex_unlock(&ipc->tx_mutex);
 330
 331         return ret;
 332 }
 333 EXPORT_SYMBOL(sof_ipc_tx_message_no_pm);
 334
 335 /* handle reply message from DSP */
 336 int snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id)
 337 {
 338         struct snd_sof_ipc_msg *msg = &sdev->ipc->msg;
 339
 340         if (msg->ipc_complete) {
 341                 dev_err(sdev->dev, "error: no reply expected, received 0x%x",
 342                         msg_id);
 343                 return -EINVAL;
 344         }
 345
 346         /* wake up and return the error if we have waiters on this message ? */
 347         msg->ipc_complete = true;
 348         wake_up(&msg->waitq);
 349
 350         return 0;
 351 }
 352 EXPORT_SYMBOL(snd_sof_ipc_reply);
 353
 354 /* DSP firmware has sent host a message  */
 355 void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev)
 356 {
 357         struct sof_ipc_cmd_hdr hdr;
 358         u32 cmd, type;
 359         int err = 0;
 360
 361         /* read back header */
 362         snd_sof_ipc_msg_data(sdev, NULL, &hdr, sizeof(hdr));
 363         ipc_log_header(sdev->dev, "ipc rx", hdr.cmd);
 364
 365         cmd = hdr.cmd & SOF_GLB_TYPE_MASK;
 366         type = hdr.cmd & SOF_CMD_TYPE_MASK;
 367
 368         /* check message type */
 369         switch (cmd) {
 370         case SOF_IPC_GLB_REPLY:
 371                 dev_err(sdev->dev, "error: ipc reply unknown\n");
 372                 break;
 373         case SOF_IPC_FW_READY:
 374                 /* check for FW boot completion */
 375                 if (sdev->fw_state == SOF_FW_BOOT_IN_PROGRESS) {
 376                         err = sof_ops(sdev)->fw_ready(sdev, cmd);
 377                         if (err < 0)
 378                                 sdev->fw_state = SOF_FW_BOOT_READY_FAILED;
 379                         else
 380                                 sdev->fw_state = SOF_FW_BOOT_COMPLETE;
 381
 382                         /* wake up firmware loader */
 383                         wake_up(&sdev->boot_wait);
 384                 }
 385                 break;
 386         case SOF_IPC_GLB_COMPOUND:
 387         case SOF_IPC_GLB_TPLG_MSG:
 388         case SOF_IPC_GLB_PM_MSG:
 389         case SOF_IPC_GLB_COMP_MSG:
 390                 break;
 391         case SOF_IPC_GLB_STREAM_MSG:
 392                 /* need to pass msg id into the function */
 393                 ipc_stream_message(sdev, hdr.cmd);
 394                 break;
 395         case SOF_IPC_GLB_TRACE_MSG:
 396                 ipc_trace_message(sdev, type);
 397                 break;
 398         default:
 399                 dev_err(sdev->dev, "error: unknown DSP message 0x%x\n", cmd);
 400                 break;
 401         }
 402
 403         ipc_log_header(sdev->dev, "ipc rx done", hdr.cmd);
 404 }
 405 EXPORT_SYMBOL(snd_sof_ipc_msgs_rx);
 406
 407 /*
 408  * IPC trace mechanism.
 409  */
 410
 411 static void ipc_trace_message(struct snd_sof_dev *sdev, u32 msg_id)
 412 {
 413         struct sof_ipc_dma_trace_posn posn;
 414
 415         switch (msg_id) {
 416         case SOF_IPC_TRACE_DMA_POSITION:
 417                 /* read back full message */
 418                 snd_sof_ipc_msg_data(sdev, NULL, &posn, sizeof(posn));
 419                 snd_sof_trace_update_pos(sdev, &posn);
 420                 break;
 421         default:
 422                 dev_err(sdev->dev, "error: unhandled trace message %x\n",
 423                         msg_id);
 424                 break;
 425         }
 426 }
 427
 428 /*
 429  * IPC stream position.
 430  */
 431
 432 static void ipc_period_elapsed(struct snd_sof_dev *sdev, u32 msg_id)
 433 {
 434         struct snd_soc_component *scomp = sdev->component;
 435         struct snd_sof_pcm_stream *stream;
 436         struct sof_ipc_stream_posn posn;
 437         struct snd_sof_pcm *spcm;
 438         int direction;
 439
 440         spcm = snd_sof_find_spcm_comp(scomp, msg_id, &direction);
 441         if (!spcm) {
 442                 dev_err(sdev->dev,
 443                         "error: period elapsed for unknown stream, msg_id %d\n",
 444                         msg_id);
 445                 return;
 446         }
 447
 448         stream = &spcm->stream[direction];
 449         snd_sof_ipc_msg_data(sdev, stream->substream, &posn, sizeof(posn));
 450
 451         dev_dbg(sdev->dev, "posn : host 0x%llx dai 0x%llx wall 0x%llx\n",
 452                 posn.host_posn, posn.dai_posn, posn.wallclock);
 453
 454         memcpy(&stream->posn, &posn, sizeof(posn));
 455
 456         /* only inform ALSA for period_wakeup mode */
 457         if (!stream->substream->runtime->no_period_wakeup)
 458                 snd_sof_pcm_period_elapsed(stream->substream);
 459 }
 460
 461 /* DSP notifies host of an XRUN within FW */
 462 static void ipc_xrun(struct snd_sof_dev *sdev, u32 msg_id)
 463 {
 464         struct snd_soc_component *scomp = sdev->component;
 465         struct snd_sof_pcm_stream *stream;
 466         struct sof_ipc_stream_posn posn;
 467         struct snd_sof_pcm *spcm;
 468         int direction;
 469
 470         spcm = snd_sof_find_spcm_comp(scomp, msg_id, &direction);
 471         if (!spcm) {
 472                 dev_err(sdev->dev, "error: XRUN for unknown stream, msg_id %d\n",
 473                         msg_id);
 474                 return;
 475         }
 476
 477         stream = &spcm->stream[direction];
 478         snd_sof_ipc_msg_data(sdev, stream->substream, &posn, sizeof(posn));
 479
 480         dev_dbg(sdev->dev,  "posn XRUN: host %llx comp %d size %d\n",
 481                 posn.host_posn, posn.xrun_comp_id, posn.xrun_size);
 482
 483 #if defined(CONFIG_SND_SOC_SOF_DEBUG_XRUN_STOP)
 484         /* stop PCM on XRUN - used for pipeline debug */
 485         memcpy(&stream->posn, &posn, sizeof(posn));
 486         snd_pcm_stop_xrun(stream->substream);
 487 #endif
 488 }
 489
 490 /* stream notifications from DSP FW */
 491 static void ipc_stream_message(struct snd_sof_dev *sdev, u32 msg_cmd)
 492 {
 493         /* get msg cmd type and msd id */
 494         u32 msg_type = msg_cmd & SOF_CMD_TYPE_MASK;
 495         u32 msg_id = SOF_IPC_MESSAGE_ID(msg_cmd);
 496
 497         switch (msg_type) {
 498         case SOF_IPC_STREAM_POSITION:
 499                 ipc_period_elapsed(sdev, msg_id);
 500                 break;
 501         case SOF_IPC_STREAM_TRIG_XRUN:
 502                 ipc_xrun(sdev, msg_id);
 503                 break;
 504         default:
 505                 dev_err(sdev->dev, "error: unhandled stream message %x\n",
 506                         msg_id);
 507                 break;
 508         }
 509 }
 510
 511 /* get stream position IPC - use faster MMIO method if available on platform */
 512 int snd_sof_ipc_stream_posn(struct snd_soc_component *scomp,
 513                             struct snd_sof_pcm *spcm, int direction,
 514                             struct sof_ipc_stream_posn *posn)
 515 {
 516         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 517         struct sof_ipc_stream stream;
 518         int err;
 519
 520         /* read position via slower IPC */
 521         stream.hdr.size = sizeof(stream);
 522         stream.hdr.cmd = SOF_IPC_GLB_STREAM_MSG | SOF_IPC_STREAM_POSITION;
 523         stream.comp_id = spcm->stream[direction].comp_id;
 524
 525         /* send IPC to the DSP */
 526         err = sof_ipc_tx_message(sdev->ipc,
 527                                  stream.hdr.cmd, &stream, sizeof(stream), &posn,
 528                                  sizeof(*posn));
 529         if (err < 0) {
 530                 dev_err(sdev->dev, "error: failed to get stream %d position\n",
 531                         stream.comp_id);
 532                 return err;
 533         }
 534
 535         return 0;
 536 }
 537 EXPORT_SYMBOL(snd_sof_ipc_stream_posn);
 538
 539 static int sof_get_ctrl_copy_params(enum sof_ipc_ctrl_type ctrl_type,
 540                                     struct sof_ipc_ctrl_data *src,
 541                                     struct sof_ipc_ctrl_data *dst,
 542                                     struct sof_ipc_ctrl_data_params *sparams)
 543 {
 544         switch (ctrl_type) {
 545         case SOF_CTRL_TYPE_VALUE_CHAN_GET:
 546         case SOF_CTRL_TYPE_VALUE_CHAN_SET:
 547                 sparams->src = (u8 *)src->chanv;
 548                 sparams->dst = (u8 *)dst->chanv;
 549                 break;
 550         case SOF_CTRL_TYPE_VALUE_COMP_GET:
 551         case SOF_CTRL_TYPE_VALUE_COMP_SET:
 552                 sparams->src = (u8 *)src->compv;
 553                 sparams->dst = (u8 *)dst->compv;
 554                 break;
 555         case SOF_CTRL_TYPE_DATA_GET:
 556         case SOF_CTRL_TYPE_DATA_SET:
 557                 sparams->src = (u8 *)src->data->data;
 558                 sparams->dst = (u8 *)dst->data->data;
 559                 break;
 560         default:
 561                 return -EINVAL;
 562         }
 563
 564         /* calculate payload size and number of messages */
 565         sparams->pl_size = SOF_IPC_MSG_MAX_SIZE - sparams->hdr_bytes;
 566         sparams->num_msg = DIV_ROUND_UP(sparams->msg_bytes, sparams->pl_size);
 567
 568         return 0;
 569 }
 570
 571 static int sof_set_get_large_ctrl_data(struct snd_sof_dev *sdev,
 572                                        struct sof_ipc_ctrl_data *cdata,
 573                                        struct sof_ipc_ctrl_data_params *sparams,
 574                                        bool send)
 575 {
 576         struct sof_ipc_ctrl_data *partdata;
 577         size_t send_bytes;
 578         size_t offset = 0;
 579         size_t msg_bytes;
 580         size_t pl_size;
 581         int err;
 582         int i;
 583
 584         /* allocate max ipc size because we have at least one */
 585         partdata = kzalloc(SOF_IPC_MSG_MAX_SIZE, GFP_KERNEL);
 586         if (!partdata)
 587                 return -ENOMEM;
 588
 589         if (send)
 590                 err = sof_get_ctrl_copy_params(cdata->type, cdata, partdata,
 591                                                sparams);
 592         else
 593                 err = sof_get_ctrl_copy_params(cdata->type, partdata, cdata,
 594                                                sparams);
 595         if (err < 0) {
 596                 kfree(partdata);
 597                 return err;
 598         }
 599
 600         msg_bytes = sparams->msg_bytes;
 601         pl_size = sparams->pl_size;
 602
 603         /* copy the header data */
 604         memcpy(partdata, cdata, sparams->hdr_bytes);
 605
 606         /* Serialise IPC TX */
 607         mutex_lock(&sdev->ipc->tx_mutex);
 608
 609         /* copy the payload data in a loop */
 610         for (i = 0; i < sparams->num_msg; i++) {
 611                 send_bytes = min(msg_bytes, pl_size);
 612                 partdata->num_elems = send_bytes;
 613                 partdata->rhdr.hdr.size = sparams->hdr_bytes + send_bytes;
 614                 partdata->msg_index = i;
 615                 msg_bytes -= send_bytes;
 616                 partdata->elems_remaining = msg_bytes;
 617
 618                 if (send)
 619                         memcpy(sparams->dst, sparams->src + offset, send_bytes);
 620
 621                 err = sof_ipc_tx_message_unlocked(sdev->ipc,
 622                                                   partdata->rhdr.hdr.cmd,
 623                                                   partdata,
 624                                                   partdata->rhdr.hdr.size,
 625                                                   partdata,
 626                                                   partdata->rhdr.hdr.size);
 627                 if (err < 0)
 628                         break;
 629
 630                 if (!send)
 631                         memcpy(sparams->dst + offset, sparams->src, send_bytes);
 632
 633                 offset += pl_size;
 634         }
 635
 636         mutex_unlock(&sdev->ipc->tx_mutex);
 637
 638         kfree(partdata);
 639         return err;
 640 }
 641
 642 /*
 643  * IPC get()/set() for kcontrols.
 644  */
 645 int snd_sof_ipc_set_get_comp_data(struct snd_sof_control *scontrol,
 646                                   u32 ipc_cmd,
 647                                   enum sof_ipc_ctrl_type ctrl_type,
 648                                   enum sof_ipc_ctrl_cmd ctrl_cmd,
 649                                   bool send)
 650 {
 651         struct snd_soc_component *scomp = scontrol->scomp;
 652         struct sof_ipc_ctrl_data *cdata = scontrol->control_data;
 653         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 654         struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
 655         struct sof_ipc_fw_version *v = &ready->version;
 656         struct sof_ipc_ctrl_data_params sparams;
 657         size_t send_bytes;
 658         int err;
 659
 660         /* read or write firmware volume */
 661         if (scontrol->readback_offset != 0) {
 662                 /* write/read value header via mmaped region */
 663                 send_bytes = sizeof(struct sof_ipc_ctrl_value_chan) *
 664                 cdata->num_elems;
 665                 if (send)
 666                         snd_sof_dsp_block_write(sdev, sdev->mmio_bar,
 667                                                 scontrol->readback_offset,
 668                                                 cdata->chanv, send_bytes);
 669
 670                 else
 671                         snd_sof_dsp_block_read(sdev, sdev->mmio_bar,
 672                                                scontrol->readback_offset,
 673                                                cdata->chanv, send_bytes);
 674                 return 0;
 675         }
 676
 677         cdata->rhdr.hdr.cmd = SOF_IPC_GLB_COMP_MSG | ipc_cmd;
 678         cdata->cmd = ctrl_cmd;
 679         cdata->type = ctrl_type;
 680         cdata->comp_id = scontrol->comp_id;
 681         cdata->msg_index = 0;
 682
 683         /* calculate header and data size */
 684         switch (cdata->type) {
 685         case SOF_CTRL_TYPE_VALUE_CHAN_GET:
 686         case SOF_CTRL_TYPE_VALUE_CHAN_SET:
 687                 sparams.msg_bytes = scontrol->num_channels *
 688                         sizeof(struct sof_ipc_ctrl_value_chan);
 689                 sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data);
 690                 sparams.elems = scontrol->num_channels;
 691                 break;
 692         case SOF_CTRL_TYPE_VALUE_COMP_GET:
 693         case SOF_CTRL_TYPE_VALUE_COMP_SET:
 694                 sparams.msg_bytes = scontrol->num_channels *
 695                         sizeof(struct sof_ipc_ctrl_value_comp);
 696                 sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data);
 697                 sparams.elems = scontrol->num_channels;
 698                 break;
 699         case SOF_CTRL_TYPE_DATA_GET:
 700         case SOF_CTRL_TYPE_DATA_SET:
 701                 sparams.msg_bytes = cdata->data->size;
 702                 sparams.hdr_bytes = sizeof(struct sof_ipc_ctrl_data) +
 703                         sizeof(struct sof_abi_hdr);
 704                 sparams.elems = cdata->data->size;
 705                 break;
 706         default:
 707                 return -EINVAL;
 708         }
 709
 710         cdata->rhdr.hdr.size = sparams.msg_bytes + sparams.hdr_bytes;
 711         cdata->num_elems = sparams.elems;
 712         cdata->elems_remaining = 0;
 713
 714         /* send normal size ipc in one part */
 715         if (cdata->rhdr.hdr.size <= SOF_IPC_MSG_MAX_SIZE) {
 716                 err = sof_ipc_tx_message(sdev->ipc, cdata->rhdr.hdr.cmd, cdata,
 717                                          cdata->rhdr.hdr.size, cdata,
 718                                          cdata->rhdr.hdr.size);
 719
 720                 if (err < 0)
 721                         dev_err(sdev->dev, "error: set/get ctrl ipc comp %d\n",
 722                                 cdata->comp_id);
 723
 724                 return err;
 725         }
 726
 727         /* data is bigger than max ipc size, chop into smaller pieces */
 728         dev_dbg(sdev->dev, "large ipc size %u, control size %u\n",
 729                 cdata->rhdr.hdr.size, scontrol->size);
 730
 731         /* large messages is only supported from ABI 3.3.0 onwards */
 732         if (v->abi_version < SOF_ABI_VER(3, 3, 0)) {
 733                 dev_err(sdev->dev, "error: incompatible FW ABI version\n");
 734                 return -EINVAL;
 735         }
 736
 737         err = sof_set_get_large_ctrl_data(sdev, cdata, &sparams, send);
 738
 739         if (err < 0)
 740                 dev_err(sdev->dev, "error: set/get large ctrl ipc comp %d\n",
 741                         cdata->comp_id);
 742
 743         return err;
 744 }
 745 EXPORT_SYMBOL(snd_sof_ipc_set_get_comp_data);
 746
 747 /*
 748  * IPC layer enumeration.
 749  */
 750
 751 int snd_sof_dsp_mailbox_init(struct snd_sof_dev *sdev, u32 dspbox,
 752                              size_t dspbox_size, u32 hostbox,
 753                              size_t hostbox_size)
 754 {
 755         sdev->dsp_box.offset = dspbox;
 756         sdev->dsp_box.size = dspbox_size;
 757         sdev->host_box.offset = hostbox;
 758         sdev->host_box.size = hostbox_size;
 759         return 0;
 760 }
 761 EXPORT_SYMBOL(snd_sof_dsp_mailbox_init);
 762
 763 int snd_sof_ipc_valid(struct snd_sof_dev *sdev)
 764 {
 765         struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
 766         struct sof_ipc_fw_version *v = &ready->version;
 767
 768         dev_info(sdev->dev,
 769                  "Firmware info: version %d:%d:%d-%s\n",  v->major, v->minor,
 770                  v->micro, v->tag);
 771         dev_info(sdev->dev,
 772                  "Firmware: ABI %d:%d:%d Kernel ABI %d:%d:%d\n",
 773                  SOF_ABI_VERSION_MAJOR(v->abi_version),
 774                  SOF_ABI_VERSION_MINOR(v->abi_version),
 775                  SOF_ABI_VERSION_PATCH(v->abi_version),
 776                  SOF_ABI_MAJOR, SOF_ABI_MINOR, SOF_ABI_PATCH);
 777
 778         if (SOF_ABI_VERSION_INCOMPATIBLE(SOF_ABI_VERSION, v->abi_version)) {
 779                 dev_err(sdev->dev, "error: incompatible FW ABI version\n");
 780                 return -EINVAL;
 781         }
 782
 783         if (v->abi_version > SOF_ABI_VERSION) {
 784                 if (!IS_ENABLED(CONFIG_SND_SOC_SOF_STRICT_ABI_CHECKS)) {
 785                         dev_warn(sdev->dev, "warn: FW ABI is more recent than kernel\n");
 786                 } else {
 787                         dev_err(sdev->dev, "error: FW ABI is more recent than kernel\n");
 788                         return -EINVAL;
 789                 }
 790         }
 791
 792         if (ready->flags & SOF_IPC_INFO_BUILD) {
 793                 dev_info(sdev->dev,
 794                          "Firmware debug build %d on %s-%s - options:\n"
 795                          " GDB: %s\n"
 796                          " lock debug: %s\n"
 797                          " lock vdebug: %s\n",
 798                          v->build, v->date, v->time,
 799                          (ready->flags & SOF_IPC_INFO_GDB) ?
 800                                 "enabled" : "disabled",
 801                          (ready->flags & SOF_IPC_INFO_LOCKS) ?
 802                                 "enabled" : "disabled",
 803                          (ready->flags & SOF_IPC_INFO_LOCKSV) ?
 804                                 "enabled" : "disabled");
 805         }
 806
 807         /* copy the fw_version into debugfs at first boot */
 808         memcpy(&sdev->fw_version, v, sizeof(*v));
 809
 810         return 0;
 811 }
 812 EXPORT_SYMBOL(snd_sof_ipc_valid);
 813
 814 struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev)
 815 {
 816         struct snd_sof_ipc *ipc;
 817         struct snd_sof_ipc_msg *msg;
 818
 819         ipc = devm_kzalloc(sdev->dev, sizeof(*ipc), GFP_KERNEL);
 820         if (!ipc)
 821                 return NULL;
 822
 823         mutex_init(&ipc->tx_mutex);
 824         ipc->sdev = sdev;
 825         msg = &ipc->msg;
 826
 827         /* indicate that we aren't sending a message ATM */
 828         msg->ipc_complete = true;
 829
 830         /* pre-allocate message data */
 831         msg->msg_data = devm_kzalloc(sdev->dev, SOF_IPC_MSG_MAX_SIZE,
 832                                      GFP_KERNEL);
 833         if (!msg->msg_data)
 834                 return NULL;
 835
 836         msg->reply_data = devm_kzalloc(sdev->dev, SOF_IPC_MSG_MAX_SIZE,
 837                                        GFP_KERNEL);
 838         if (!msg->reply_data)
 839                 return NULL;
 840
 841         init_waitqueue_head(&msg->waitq);
 842
 843         return ipc;
 844 }
 845 EXPORT_SYMBOL(snd_sof_ipc_init);
 846
 847 void snd_sof_ipc_free(struct snd_sof_dev *sdev)
 848 {
 849         struct snd_sof_ipc *ipc = sdev->ipc;
 850
 851         if (!ipc)
 852                 return;
 853
 854         /* disable sending of ipc's */
 855         mutex_lock(&ipc->tx_mutex);
 856         ipc->disable_ipc_tx = true;
 857         mutex_unlock(&ipc->tx_mutex);
 858 }
 859 EXPORT_SYMBOL(snd_sof_ipc_free);