drivers/staging/intel_sst/intel_sst_drv_interface.c

   1 /*
   2  *  intel_sst_interface.c - Intel SST Driver for audio engine
   3  *
   4  *  Copyright (C) 2008-10 Intel Corp
   5  *  Authors:    Vinod Koul <vinod.koul@intel.com>
   6  *              Harsha Priya <priya.harsha@intel.com>
   7  *              Dharageswari R <dharageswari.r@intel.com)
   8  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   9  *
  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 published by
  12  *  the Free Software Foundation; version 2 of the License.
  13  *
  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.
  18  *
  19  *  You should have received a copy of the GNU General Public License along
  20  *  with this program; if not, write to the Free Software Foundation, Inc.,
  21  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  22  *
  23  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24  *  This driver exposes the audio engine functionalities to the ALSA
  25  *      and middleware.
  26  *  Upper layer interfaces (MAD driver, MMF) to SST driver
  27  */
  28
  29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  30
  31 #include <linux/delay.h>
  32 #include <linux/pci.h>
  33 #include <linux/fs.h>
  34 #include <linux/firmware.h>
  35 #include <linux/pm_runtime.h>
  36 #include "intel_sst.h"
  37 #include "intel_sst_ioctl.h"
  38 #include "intel_sst_fw_ipc.h"
  39 #include "intel_sst_common.h"
  40
  41
  42 /*
  43  * sst_download_fw - download the audio firmware to DSP
  44  *
  45  * This function is called when the FW needs to be downloaded to SST DSP engine
  46  */
  47 int sst_download_fw(void)
  48 {
  49         int retval;
  50         const struct firmware *fw_sst;
  51         char name[20];
  52
  53         if (sst_drv_ctx->sst_state != SST_UN_INIT)
  54                 return -EPERM;
  55
  56         /* Reload firmware is not needed for MRST */
  57         if ( (sst_drv_ctx->pci_id == SST_MRST_PCI_ID) && sst_drv_ctx->fw_downloaded) {
  58                 pr_debug("FW already downloaded, skip for MRST platform\n");
  59                 sst_drv_ctx->sst_state = SST_FW_RUNNING;
  60                 return 0;
  61         }
  62
  63         snprintf(name, sizeof(name), "%s%04x%s", "fw_sst_",
  64                                         sst_drv_ctx->pci_id, ".bin");
  65
  66         pr_debug("Downloading %s FW now...\n", name);
  67         retval = request_firmware(&fw_sst, name, &sst_drv_ctx->pci->dev);
  68         if (retval) {
  69                 pr_err("request fw failed %d\n", retval);
  70                 return retval;
  71         }
  72         sst_drv_ctx->alloc_block[0].sst_id = FW_DWNL_ID;
  73         sst_drv_ctx->alloc_block[0].ops_block.condition = false;
  74         retval = sst_load_fw(fw_sst, NULL);
  75         if (retval)
  76                 goto end_restore;
  77
  78         retval = sst_wait_timeout(sst_drv_ctx, &sst_drv_ctx->alloc_block[0]);
  79         if (retval)
  80                 pr_err("fw download failed %d\n" , retval);
  81         else
  82                 sst_drv_ctx->fw_downloaded = 1;
  83
  84 end_restore:
  85         release_firmware(fw_sst);
  86         sst_drv_ctx->alloc_block[0].sst_id = BLOCK_UNINIT;
  87         return retval;
  88 }
  89
  90
  91 /*
  92  * sst_stalled - this function checks if the lpe is in stalled state
  93  */
  94 int sst_stalled(void)
  95 {
  96         int retry = 1000;
  97         int retval = -1;
  98
  99         while (retry) {
 100                 if (!sst_drv_ctx->lpe_stalled)
 101                         return 0;
 102                 /*wait for time and re-check*/
 103                 msleep(1);
 104
 105                 retry--;
 106         }
 107         pr_debug("in Stalled State\n");
 108         return retval;
 109 }
 110
 111 void free_stream_context(unsigned int str_id)
 112 {
 113         struct stream_info *stream;
 114
 115         if (!sst_validate_strid(str_id)) {
 116                 /* str_id is valid, so stream is alloacted */
 117                 stream = &sst_drv_ctx->streams[str_id];
 118                 if (sst_free_stream(str_id))
 119                         sst_clean_stream(&sst_drv_ctx->streams[str_id]);
 120                 if (stream->ops == STREAM_OPS_PLAYBACK ||
 121                                 stream->ops == STREAM_OPS_PLAYBACK_DRM) {
 122                         sst_drv_ctx->pb_streams--;
 123                         if (sst_drv_ctx->pci_id == SST_MFLD_PCI_ID)
 124                                 sst_drv_ctx->scard_ops->power_down_pmic_pb(
 125                                                 stream->device);
 126                         else {
 127                                 if (sst_drv_ctx->pb_streams == 0)
 128                                         sst_drv_ctx->scard_ops->
 129                                         power_down_pmic_pb(stream->device);
 130                         }
 131                 } else if (stream->ops == STREAM_OPS_CAPTURE) {
 132                         sst_drv_ctx->cp_streams--;
 133                         if (sst_drv_ctx->cp_streams == 0)
 134                                 sst_drv_ctx->scard_ops->power_down_pmic_cp(
 135                                                 stream->device);
 136                 }
 137                 if (sst_drv_ctx->pb_streams == 0
 138                                 && sst_drv_ctx->cp_streams == 0)
 139                         sst_drv_ctx->scard_ops->power_down_pmic();
 140         }
 141 }
 142
 143 /*
 144  * sst_get_stream_allocated - this function gets a stream allocated with
 145  * the given params
 146  *
 147  * @str_param : stream params
 148  * @lib_dnld : pointer to pointer of lib downlaod struct
 149  *
 150  * This creates new stream id for a stream, in case lib is to be downloaded to
 151  * DSP, it downloads that
 152  */
 153 int sst_get_stream_allocated(struct snd_sst_params *str_param,
 154                 struct snd_sst_lib_download **lib_dnld)
 155 {
 156         int retval, str_id;
 157         struct stream_info *str_info;
 158
 159         retval = sst_alloc_stream((char *) &str_param->sparams, str_param->ops,
 160                                 str_param->codec, str_param->device_type);
 161         if (retval < 0) {
 162                 pr_err("sst_alloc_stream failed %d\n", retval);
 163                 return retval;
 164         }
 165         pr_debug("Stream allocated %d\n", retval);
 166         str_id = retval;
 167         str_info = &sst_drv_ctx->streams[str_id];
 168         /* Block the call for reply */
 169         retval = sst_wait_interruptible_timeout(sst_drv_ctx,
 170                         &str_info->ctrl_blk, SST_BLOCK_TIMEOUT);
 171         if ((retval != 0) || (str_info->ctrl_blk.ret_code != 0)) {
 172                 pr_debug("FW alloc failed retval %d, ret_code %d\n",
 173                                 retval, str_info->ctrl_blk.ret_code);
 174                 str_id = -str_info->ctrl_blk.ret_code; /*return error*/
 175                 *lib_dnld = str_info->ctrl_blk.data;
 176                 sst_clean_stream(str_info);
 177         } else
 178                 pr_debug("FW Stream allocated success\n");
 179         return str_id; /*will ret either error (in above if) or correct str id*/
 180 }
 181
 182 /*
 183  * sst_get_sfreq - this function returns the frequency of the stream
 184  *
 185  * @str_param : stream params
 186  */
 187 static int sst_get_sfreq(struct snd_sst_params *str_param)
 188 {
 189         switch (str_param->codec) {
 190         case SST_CODEC_TYPE_PCM:
 191                 return 48000; /*str_param->sparams.uc.pcm_params.sfreq;*/
 192         case SST_CODEC_TYPE_MP3:
 193                 return str_param->sparams.uc.mp3_params.sfreq;
 194         case SST_CODEC_TYPE_AAC:
 195                 return str_param->sparams.uc.aac_params.sfreq;
 196         case SST_CODEC_TYPE_WMA9:
 197                 return str_param->sparams.uc.wma_params.sfreq;
 198         default:
 199                 return 0;
 200         }
 201 }
 202
 203 /*
 204  * sst_get_stream - this function prepares for stream allocation
 205  *
 206  * @str_param : stream param
 207  */
 208 int sst_get_stream(struct snd_sst_params *str_param)
 209 {
 210         int i, retval;
 211         struct stream_info *str_info;
 212         struct snd_sst_lib_download *lib_dnld;
 213
 214         /* stream is not allocated, we are allocating */
 215         retval = sst_get_stream_allocated(str_param, &lib_dnld);
 216         if (retval == -(SST_LIB_ERR_LIB_DNLD_REQUIRED)) {
 217                 /* codec download is required */
 218                 struct snd_sst_alloc_response *response;
 219
 220                 pr_debug("Codec is required.... trying that\n");
 221                 if (lib_dnld == NULL) {
 222                         pr_err("lib download null!!! abort\n");
 223                         return -EIO;
 224                 }
 225                 i = sst_get_block_stream(sst_drv_ctx);
 226                 response = sst_drv_ctx->alloc_block[i].ops_block.data;
 227                 pr_debug("alloc block allocated = %d\n", i);
 228                 if (i < 0) {
 229                         kfree(lib_dnld);
 230                         return -ENOMEM;
 231                 }
 232                 retval = sst_load_library(lib_dnld, str_param->ops);
 233                 kfree(lib_dnld);
 234
 235                 sst_drv_ctx->alloc_block[i].sst_id = BLOCK_UNINIT;
 236                 if (!retval) {
 237                         pr_debug("codec was downloaded successfully\n");
 238
 239                         retval = sst_get_stream_allocated(str_param, &lib_dnld);
 240                         if (retval <= 0)
 241                                 goto err;
 242
 243                         pr_debug("Alloc done stream id %d\n", retval);
 244                 } else {
 245                         pr_debug("codec download failed\n");
 246                         retval = -EIO;
 247                         goto err;
 248                 }
 249         } else if  (retval <= 0)
 250                 goto err;
 251         /*else
 252                 set_port_params(str_param, str_param->ops);*/
 253
 254         /* store sampling freq */
 255         str_info = &sst_drv_ctx->streams[retval];
 256         str_info->sfreq = sst_get_sfreq(str_param);
 257
 258         /* power on the analog, if reqd */
 259         if (str_param->ops == STREAM_OPS_PLAYBACK ||
 260                         str_param->ops == STREAM_OPS_PLAYBACK_DRM) {
 261                 if (sst_drv_ctx->pci_id == SST_MRST_PCI_ID)
 262                         sst_drv_ctx->scard_ops->power_up_pmic_pb(
 263                                         sst_drv_ctx->pmic_port_instance);
 264                 else
 265                         sst_drv_ctx->scard_ops->power_up_pmic_pb(
 266                                                         str_info->device);
 267                 /*Only if the playback is MP3 - Send a message*/
 268                 sst_drv_ctx->pb_streams++;
 269         } else if (str_param->ops == STREAM_OPS_CAPTURE) {
 270
 271                 sst_drv_ctx->scard_ops->power_up_pmic_cp(
 272                                 sst_drv_ctx->pmic_port_instance);
 273                 /*Send a messageif not sent already*/
 274                 sst_drv_ctx->cp_streams++;
 275         }
 276
 277 err:
 278         return retval;
 279 }
 280
 281 void sst_process_mad_ops(struct work_struct *work)
 282 {
 283
 284         struct mad_ops_wq *mad_ops =
 285                         container_of(work, struct mad_ops_wq, wq);
 286         int retval = 0;
 287
 288         switch (mad_ops->control_op) {
 289         case SST_SND_PAUSE:
 290                 retval = sst_pause_stream(mad_ops->stream_id);
 291                 break;
 292         case SST_SND_RESUME:
 293                 retval = sst_resume_stream(mad_ops->stream_id);
 294                 break;
 295         case SST_SND_DROP:
 296                 retval = sst_drop_stream(mad_ops->stream_id);
 297                 break;
 298         case SST_SND_START:
 299                         pr_debug("SST Debug: start stream\n");
 300                 retval = sst_start_stream(mad_ops->stream_id);
 301                 break;
 302         case SST_SND_STREAM_PROCESS:
 303                 pr_debug("play/capt frames...\n");
 304                 break;
 305         default:
 306                 pr_err(" wrong control_ops reported\n");
 307         }
 308         return;
 309 }
 310
 311 void send_intial_rx_timeslot(void)
 312 {
 313         if (sst_drv_ctx->pci_id == SST_MRST_PCI_ID &&
 314                         sst_drv_ctx->rx_time_slot_status != RX_TIMESLOT_UNINIT
 315                         && sst_drv_ctx->pmic_vendor != SND_NC)
 316                 sst_enable_rx_timeslot(sst_drv_ctx->rx_time_slot_status);
 317 }
 318
 319 /*
 320  * sst_open_pcm_stream - Open PCM interface
 321  *
 322  * @str_param: parameters of pcm stream
 323  *
 324  * This function is called by MID sound card driver to open
 325  * a new pcm interface
 326  */
 327 int sst_open_pcm_stream(struct snd_sst_params *str_param)
 328 {
 329         struct stream_info *str_info;
 330         int retval;
 331
 332         pm_runtime_get_sync(&sst_drv_ctx->pci->dev);
 333
 334         if (sst_drv_ctx->sst_state == SST_SUSPENDED) {
 335                 /* LPE is suspended, resume it before proceeding*/
 336                 pr_debug("Resuming from Suspended state\n");
 337                 retval = intel_sst_resume(sst_drv_ctx->pci);
 338                 if (retval) {
 339                         pr_err("Resume Failed = %#x, abort\n", retval);
 340                         pm_runtime_put(&sst_drv_ctx->pci->dev);
 341                         return retval;
 342                 }
 343         }
 344         if (sst_drv_ctx->sst_state == SST_UN_INIT) {
 345                 /* FW is not downloaded */
 346                 pr_debug("DSP Downloading FW now...\n");
 347                 retval = sst_download_fw();
 348                 if (retval) {
 349                         pr_err("FW download fail %x, abort\n", retval);
 350                         pm_runtime_put(&sst_drv_ctx->pci->dev);
 351                         return retval;
 352                 }
 353                 send_intial_rx_timeslot();
 354         }
 355
 356         if (!str_param) {
 357                 pm_runtime_put(&sst_drv_ctx->pci->dev);
 358                 return -EINVAL;
 359         }
 360
 361         retval = sst_get_stream(str_param);
 362         if (retval > 0) {
 363                 sst_drv_ctx->stream_cnt++;
 364                 str_info = &sst_drv_ctx->streams[retval];
 365                 str_info->src = MAD_DRV;
 366         } else
 367                 pm_runtime_put(&sst_drv_ctx->pci->dev);
 368
 369         return retval;
 370 }
 371
 372 /*
 373  * sst_close_pcm_stream - Close PCM interface
 374  *
 375  * @str_id: stream id to be closed
 376  *
 377  * This function is called by MID sound card driver to close
 378  * an existing pcm interface
 379  */
 380 int sst_close_pcm_stream(unsigned int str_id)
 381 {
 382         struct stream_info *stream;
 383
 384         pr_debug("sst: stream free called\n");
 385         if (sst_validate_strid(str_id))
 386                 return -EINVAL;
 387         stream = &sst_drv_ctx->streams[str_id];
 388         free_stream_context(str_id);
 389         stream->pcm_substream = NULL;
 390         stream->status = STREAM_UN_INIT;
 391         stream->period_elapsed = NULL;
 392         sst_drv_ctx->stream_cnt--;
 393         pr_debug("sst: will call runtime put now\n");
 394         pm_runtime_put(&sst_drv_ctx->pci->dev);
 395         return 0;
 396 }
 397
 398 /*
 399  * sst_device_control - Set Control params
 400  *
 401  * @cmd: control cmd to be set
 402  * @arg: command argument
 403  *
 404  * This function is called by MID sound card driver to set
 405  * SST/Sound card controls for an opened stream.
 406  * This is registered with MID driver
 407  */
 408 int sst_device_control(int cmd, void *arg)
 409 {
 410         int retval = 0, str_id = 0;
 411
 412         switch (cmd) {
 413         case SST_SND_PAUSE:
 414         case SST_SND_RESUME:
 415         case SST_SND_DROP:
 416         case SST_SND_START:
 417                 sst_drv_ctx->mad_ops.control_op = cmd;
 418                 sst_drv_ctx->mad_ops.stream_id = *(int *)arg;
 419                 queue_work(sst_drv_ctx->mad_wq, &sst_drv_ctx->mad_ops.wq);
 420                 break;
 421
 422         case SST_SND_STREAM_INIT: {
 423                 struct pcm_stream_info *str_info;
 424                 struct stream_info *stream;
 425
 426                 pr_debug("stream init called\n");
 427                 str_info = (struct pcm_stream_info *)arg;
 428                 str_id = str_info->str_id;
 429                 retval = sst_validate_strid(str_id);
 430                 if (retval)
 431                         break;
 432
 433                 stream = &sst_drv_ctx->streams[str_id];
 434                 pr_debug("setting the period ptrs\n");
 435                 stream->pcm_substream = str_info->mad_substream;
 436                 stream->period_elapsed = str_info->period_elapsed;
 437                 stream->sfreq = str_info->sfreq;
 438                 stream->prev = stream->status;
 439                 stream->status = STREAM_INIT;
 440                 break;
 441         }
 442
 443         case SST_SND_BUFFER_POINTER: {
 444                 struct pcm_stream_info *stream_info;
 445                 struct snd_sst_tstamp fw_tstamp = {0,};
 446                 struct stream_info *stream;
 447
 448
 449                 stream_info = (struct pcm_stream_info *)arg;
 450                 str_id = stream_info->str_id;
 451                 retval = sst_validate_strid(str_id);
 452                 if (retval)
 453                         break;
 454                 stream = &sst_drv_ctx->streams[str_id];
 455
 456                 if (!stream->pcm_substream)
 457                         break;
 458                 memcpy_fromio(&fw_tstamp,
 459                         ((void *)(sst_drv_ctx->mailbox + SST_TIME_STAMP)
 460                         +(str_id * sizeof(fw_tstamp))),
 461                         sizeof(fw_tstamp));
 462
 463                 pr_debug("Pointer Query on strid = %d ops %d\n",
 464                                                 str_id, stream->ops);
 465
 466                 if (stream->ops == STREAM_OPS_PLAYBACK)
 467                         stream_info->buffer_ptr = fw_tstamp.samples_rendered;
 468                 else
 469                         stream_info->buffer_ptr = fw_tstamp.samples_processed;
 470                 pr_debug("Samples rendered = %llu, buffer ptr %llu\n",
 471                         fw_tstamp.samples_rendered, stream_info->buffer_ptr);
 472                 break;
 473         }
 474         case SST_ENABLE_RX_TIME_SLOT: {
 475                 int status = *(int *)arg;
 476                 sst_drv_ctx->rx_time_slot_status = status ;
 477                 sst_enable_rx_timeslot(status);
 478                 break;
 479         }
 480         default:
 481                 /* Illegal case */
 482                 pr_warn("illegal req\n");
 483                 return -EINVAL;
 484         }
 485
 486         return retval;
 487 }
 488
 489
 490 struct intel_sst_pcm_control pcm_ops = {
 491         .open = sst_open_pcm_stream,
 492         .device_control = sst_device_control,
 493         .close = sst_close_pcm_stream,
 494 };
 495
 496 struct intel_sst_card_ops sst_pmic_ops = {
 497         .pcm_control = &pcm_ops,
 498 };
 499
 500 /*
 501  * register_sst_card - function for sound card to register
 502  *
 503  * @card: pointer to structure of operations
 504  *
 505  * This function is called card driver loads and is ready for registration
 506  */
 507 int register_sst_card(struct intel_sst_card_ops *card)
 508 {
 509         if (!sst_drv_ctx) {
 510                 pr_err("No SST driver register card reject\n");
 511                 return -ENODEV;
 512         }
 513
 514         if (!card || !card->module_name) {
 515                 pr_err("Null Pointer Passed\n");
 516                 return -EINVAL;
 517         }
 518         if (sst_drv_ctx->pmic_state == SND_MAD_UN_INIT) {
 519                 /* register this driver */
 520                 if ((strncmp(SST_CARD_NAMES, card->module_name,
 521                                 strlen(SST_CARD_NAMES))) == 0) {
 522                         sst_drv_ctx->pmic_vendor = card->vendor_id;
 523                         sst_drv_ctx->scard_ops =  card->scard_ops;
 524                         sst_pmic_ops.module_name = card->module_name;
 525                         sst_drv_ctx->pmic_state = SND_MAD_INIT_DONE;
 526                         sst_drv_ctx->rx_time_slot_status = 0; /*default AMIC*/
 527                         card->pcm_control = sst_pmic_ops.pcm_control;
 528                         return 0;
 529                 } else {
 530                         pr_err("strcmp fail %s\n", card->module_name);
 531                         return -EINVAL;
 532                 }
 533
 534         } else {
 535                 /* already registered a driver */
 536                 pr_err("Repeat for registration..denied\n");
 537                 return -EBADRQC;
 538         }
 539         /* The ASoC code doesn't set scard_ops */
 540         if (sst_drv_ctx->scard_ops)
 541                 sst_drv_ctx->scard_ops->card_status = SND_CARD_UN_INIT;
 542         return 0;
 543 }
 544 EXPORT_SYMBOL_GPL(register_sst_card);
 545
 546 /*
 547  * unregister_sst_card- function for sound card to un-register
 548  *
 549  * @card: pointer to structure of operations
 550  *
 551  * This function is called when card driver unloads
 552  */
 553 void unregister_sst_card(struct intel_sst_card_ops *card)
 554 {
 555         if (sst_pmic_ops.pcm_control == card->pcm_control) {
 556                 /* unreg */
 557                 sst_pmic_ops.module_name = "";
 558                 sst_drv_ctx->pmic_state = SND_MAD_UN_INIT;
 559                 pr_debug("Unregistered %s\n", card->module_name);
 560         }
 561         return;
 562 }
 563 EXPORT_SYMBOL_GPL(unregister_sst_card);