sound/core/compress_offload.c

   1 /*
   2  *  compress_core.c - compress offload core
   3  *
   4  *  Copyright (C) 2011 Intel Corporation
   5  *  Authors:    Vinod Koul <vinod.koul@linux.intel.com>
   6  *              Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
   7  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; version 2 of the License.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  *
  24  */
  25 #define FORMAT(fmt) "%s: %d: " fmt, __func__, __LINE__
  26 #define pr_fmt(fmt) KBUILD_MODNAME ": " FORMAT(fmt)
  27
  28 #include <linux/file.h>
  29 #include <linux/fs.h>
  30 #include <linux/list.h>
  31 #include <linux/math64.h>
  32 #include <linux/mm.h>
  33 #include <linux/mutex.h>
  34 #include <linux/poll.h>
  35 #include <linux/slab.h>
  36 #include <linux/sched.h>
  37 #include <linux/types.h>
  38 #include <linux/uio.h>
  39 #include <linux/uaccess.h>
  40 #include <linux/module.h>
  41 #include <sound/core.h>
  42 #include <sound/initval.h>
  43 #include <sound/compress_params.h>
  44 #include <sound/compress_offload.h>
  45 #include <sound/compress_driver.h>
  46
  47 /* TODO:
  48  * - add substream support for multiple devices in case of
  49  *      SND_DYNAMIC_MINORS is not used
  50  * - Multiple node representation
  51  *      driver should be able to register multiple nodes
  52  */
  53
  54 static DEFINE_MUTEX(device_mutex);
  55
  56 struct snd_compr_file {
  57         unsigned long caps;
  58         struct snd_compr_stream stream;
  59 };
  60
  61 /*
  62  * a note on stream states used:
  63  * we use follwing states in the compressed core
  64  * SNDRV_PCM_STATE_OPEN: When stream has been opened.
  65  * SNDRV_PCM_STATE_SETUP: When stream has been initialized. This is done by
  66  *      calling SNDRV_COMPRESS_SET_PARAMS. running streams will come to this
  67  *      state at stop by calling SNDRV_COMPRESS_STOP, or at end of drain.
  68  * SNDRV_PCM_STATE_RUNNING: When stream has been started and is
  69  *      decoding/encoding and rendering/capturing data.
  70  * SNDRV_PCM_STATE_DRAINING: When stream is draining current data. This is done
  71  *      by calling SNDRV_COMPRESS_DRAIN.
  72  * SNDRV_PCM_STATE_PAUSED: When stream is paused. This is done by calling
  73  *      SNDRV_COMPRESS_PAUSE. It can be stopped or resumed by calling
  74  *      SNDRV_COMPRESS_STOP or SNDRV_COMPRESS_RESUME respectively.
  75  */
  76 static int snd_compr_open(struct inode *inode, struct file *f)
  77 {
  78         struct snd_compr *compr;
  79         struct snd_compr_file *data;
  80         struct snd_compr_runtime *runtime;
  81         enum snd_compr_direction dirn;
  82         int maj = imajor(inode);
  83         int ret;
  84
  85         if ((f->f_flags & O_ACCMODE) == O_WRONLY)
  86                 dirn = SND_COMPRESS_PLAYBACK;
  87         else if ((f->f_flags & O_ACCMODE) == O_RDONLY)
  88                 dirn = SND_COMPRESS_CAPTURE;
  89         else
  90                 return -EINVAL;
  91
  92         if (maj == snd_major)
  93                 compr = snd_lookup_minor_data(iminor(inode),
  94                                         SNDRV_DEVICE_TYPE_COMPRESS);
  95         else
  96                 return -EBADFD;
  97
  98         if (compr == NULL) {
  99                 pr_err("no device data!!!\n");
 100                 return -ENODEV;
 101         }
 102
 103         if (dirn != compr->direction) {
 104                 pr_err("this device doesn't support this direction\n");
 105                 snd_card_unref(compr->card);
 106                 return -EINVAL;
 107         }
 108
 109         data = kzalloc(sizeof(*data), GFP_KERNEL);
 110         if (!data) {
 111                 snd_card_unref(compr->card);
 112                 return -ENOMEM;
 113         }
 114         data->stream.ops = compr->ops;
 115         data->stream.direction = dirn;
 116         data->stream.private_data = compr->private_data;
 117         data->stream.device = compr;
 118         runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
 119         if (!runtime) {
 120                 kfree(data);
 121                 snd_card_unref(compr->card);
 122                 return -ENOMEM;
 123         }
 124         runtime->state = SNDRV_PCM_STATE_OPEN;
 125         init_waitqueue_head(&runtime->sleep);
 126         data->stream.runtime = runtime;
 127         f->private_data = (void *)data;
 128         mutex_lock(&compr->lock);
 129         ret = compr->ops->open(&data->stream);
 130         mutex_unlock(&compr->lock);
 131         if (ret) {
 132                 kfree(runtime);
 133                 kfree(data);
 134         }
 135         snd_card_unref(compr->card);
 136         return ret;
 137 }
 138
 139 static int snd_compr_free(struct inode *inode, struct file *f)
 140 {
 141         struct snd_compr_file *data = f->private_data;
 142         data->stream.ops->free(&data->stream);
 143         kfree(data->stream.runtime->buffer);
 144         kfree(data->stream.runtime);
 145         kfree(data);
 146         return 0;
 147 }
 148
 149 static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
 150                 struct snd_compr_tstamp *tstamp)
 151 {
 152         if (!stream->ops->pointer)
 153                 return -ENOTSUPP;
 154         stream->ops->pointer(stream, tstamp);
 155         pr_debug("dsp consumed till %d total %d bytes\n",
 156                 tstamp->byte_offset, tstamp->copied_total);
 157         if (stream->direction == SND_COMPRESS_PLAYBACK)
 158                 stream->runtime->total_bytes_transferred = tstamp->copied_total;
 159         else
 160                 stream->runtime->total_bytes_available = tstamp->copied_total;
 161         return 0;
 162 }
 163
 164 static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
 165                 struct snd_compr_avail *avail)
 166 {
 167         memset(avail, 0, sizeof(*avail));
 168         snd_compr_update_tstamp(stream, &avail->tstamp);
 169         /* Still need to return avail even if tstamp can't be filled in */
 170
 171         if (stream->runtime->total_bytes_available == 0 &&
 172                         stream->runtime->state == SNDRV_PCM_STATE_SETUP &&
 173                         stream->direction == SND_COMPRESS_PLAYBACK) {
 174                 pr_debug("detected init and someone forgot to do a write\n");
 175                 return stream->runtime->buffer_size;
 176         }
 177         pr_debug("app wrote %lld, DSP consumed %lld\n",
 178                         stream->runtime->total_bytes_available,
 179                         stream->runtime->total_bytes_transferred);
 180         if (stream->runtime->total_bytes_available ==
 181                                 stream->runtime->total_bytes_transferred) {
 182                 if (stream->direction == SND_COMPRESS_PLAYBACK) {
 183                         pr_debug("both pointers are same, returning full avail\n");
 184                         return stream->runtime->buffer_size;
 185                 } else {
 186                         pr_debug("both pointers are same, returning no avail\n");
 187                         return 0;
 188                 }
 189         }
 190
 191         avail->avail = stream->runtime->total_bytes_available -
 192                         stream->runtime->total_bytes_transferred;
 193         if (stream->direction == SND_COMPRESS_PLAYBACK)
 194                 avail->avail = stream->runtime->buffer_size - avail->avail;
 195
 196         pr_debug("ret avail as %lld\n", avail->avail);
 197         return avail->avail;
 198 }
 199
 200 static inline size_t snd_compr_get_avail(struct snd_compr_stream *stream)
 201 {
 202         struct snd_compr_avail avail;
 203
 204         return snd_compr_calc_avail(stream, &avail);
 205 }
 206
 207 static int
 208 snd_compr_ioctl_avail(struct snd_compr_stream *stream, unsigned long arg)
 209 {
 210         struct snd_compr_avail ioctl_avail;
 211         size_t avail;
 212
 213         avail = snd_compr_calc_avail(stream, &ioctl_avail);
 214         ioctl_avail.avail = avail;
 215
 216         if (copy_to_user((__u64 __user *)arg,
 217                                 &ioctl_avail, sizeof(ioctl_avail)))
 218                 return -EFAULT;
 219         return 0;
 220 }
 221
 222 static int snd_compr_write_data(struct snd_compr_stream *stream,
 223                const char __user *buf, size_t count)
 224 {
 225         void *dstn;
 226         size_t copy;
 227         struct snd_compr_runtime *runtime = stream->runtime;
 228         /* 64-bit Modulus */
 229         u64 app_pointer = div64_u64(runtime->total_bytes_available,
 230                                     runtime->buffer_size);
 231         app_pointer = runtime->total_bytes_available -
 232                       (app_pointer * runtime->buffer_size);
 233
 234         dstn = runtime->buffer + app_pointer;
 235         pr_debug("copying %ld at %lld\n",
 236                         (unsigned long)count, app_pointer);
 237         if (count < runtime->buffer_size - app_pointer) {
 238                 if (copy_from_user(dstn, buf, count))
 239                         return -EFAULT;
 240         } else {
 241                 copy = runtime->buffer_size - app_pointer;
 242                 if (copy_from_user(dstn, buf, copy))
 243                         return -EFAULT;
 244                 if (copy_from_user(runtime->buffer, buf + copy, count - copy))
 245                         return -EFAULT;
 246         }
 247         /* if DSP cares, let it know data has been written */
 248         if (stream->ops->ack)
 249                 stream->ops->ack(stream, count);
 250         return count;
 251 }
 252
 253 static ssize_t snd_compr_write(struct file *f, const char __user *buf,
 254                 size_t count, loff_t *offset)
 255 {
 256         struct snd_compr_file *data = f->private_data;
 257         struct snd_compr_stream *stream;
 258         size_t avail;
 259         int retval;
 260
 261         if (snd_BUG_ON(!data))
 262                 return -EFAULT;
 263
 264         stream = &data->stream;
 265         mutex_lock(&stream->device->lock);
 266         /* write is allowed when stream is running or has been steup */
 267         if (stream->runtime->state != SNDRV_PCM_STATE_SETUP &&
 268                         stream->runtime->state != SNDRV_PCM_STATE_RUNNING) {
 269                 mutex_unlock(&stream->device->lock);
 270                 return -EBADFD;
 271         }
 272
 273         avail = snd_compr_get_avail(stream);
 274         pr_debug("avail returned %ld\n", (unsigned long)avail);
 275         /* calculate how much we can write to buffer */
 276         if (avail > count)
 277                 avail = count;
 278
 279         if (stream->ops->copy) {
 280                 char __user* cbuf = (char __user*)buf;
 281                 retval = stream->ops->copy(stream, cbuf, avail);
 282         } else {
 283                 retval = snd_compr_write_data(stream, buf, avail);
 284         }
 285         if (retval > 0)
 286                 stream->runtime->total_bytes_available += retval;
 287
 288         /* while initiating the stream, write should be called before START
 289          * call, so in setup move state */
 290         if (stream->runtime->state == SNDRV_PCM_STATE_SETUP) {
 291                 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
 292                 pr_debug("stream prepared, Houston we are good to go\n");
 293         }
 294
 295         mutex_unlock(&stream->device->lock);
 296         return retval;
 297 }
 298
 299
 300 static ssize_t snd_compr_read(struct file *f, char __user *buf,
 301                 size_t count, loff_t *offset)
 302 {
 303         struct snd_compr_file *data = f->private_data;
 304         struct snd_compr_stream *stream;
 305         size_t avail;
 306         int retval;
 307
 308         if (snd_BUG_ON(!data))
 309                 return -EFAULT;
 310
 311         stream = &data->stream;
 312         mutex_lock(&stream->device->lock);
 313
 314         /* read is allowed when stream is running, paused, draining and setup
 315          * (yes setup is state which we transition to after stop, so if user
 316          * wants to read data after stop we allow that)
 317          */
 318         switch (stream->runtime->state) {
 319         case SNDRV_PCM_STATE_OPEN:
 320         case SNDRV_PCM_STATE_PREPARED:
 321         case SNDRV_PCM_STATE_XRUN:
 322         case SNDRV_PCM_STATE_SUSPENDED:
 323         case SNDRV_PCM_STATE_DISCONNECTED:
 324                 retval = -EBADFD;
 325                 goto out;
 326         }
 327
 328         avail = snd_compr_get_avail(stream);
 329         pr_debug("avail returned %ld\n", (unsigned long)avail);
 330         /* calculate how much we can read from buffer */
 331         if (avail > count)
 332                 avail = count;
 333
 334         if (stream->ops->copy) {
 335                 retval = stream->ops->copy(stream, buf, avail);
 336         } else {
 337                 retval = -ENXIO;
 338                 goto out;
 339         }
 340         if (retval > 0)
 341                 stream->runtime->total_bytes_transferred += retval;
 342
 343 out:
 344         mutex_unlock(&stream->device->lock);
 345         return retval;
 346 }
 347
 348 static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
 349 {
 350         return -ENXIO;
 351 }
 352
 353 static inline int snd_compr_get_poll(struct snd_compr_stream *stream)
 354 {
 355         if (stream->direction == SND_COMPRESS_PLAYBACK)
 356                 return POLLOUT | POLLWRNORM;
 357         else
 358                 return POLLIN | POLLRDNORM;
 359 }
 360
 361 static unsigned int snd_compr_poll(struct file *f, poll_table *wait)
 362 {
 363         struct snd_compr_file *data = f->private_data;
 364         struct snd_compr_stream *stream;
 365         size_t avail;
 366         int retval = 0;
 367
 368         if (snd_BUG_ON(!data))
 369                 return -EFAULT;
 370         stream = &data->stream;
 371         if (snd_BUG_ON(!stream))
 372                 return -EFAULT;
 373
 374         mutex_lock(&stream->device->lock);
 375         if (stream->runtime->state == SNDRV_PCM_STATE_PAUSED ||
 376                         stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
 377                 retval = -EBADFD;
 378                 goto out;
 379         }
 380         poll_wait(f, &stream->runtime->sleep, wait);
 381
 382         avail = snd_compr_get_avail(stream);
 383         pr_debug("avail is %ld\n", (unsigned long)avail);
 384         /* check if we have at least one fragment to fill */
 385         switch (stream->runtime->state) {
 386         case SNDRV_PCM_STATE_DRAINING:
 387                 /* stream has been woken up after drain is complete
 388                  * draining done so set stream state to stopped
 389                  */
 390                 retval = snd_compr_get_poll(stream);
 391                 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 392                 break;
 393         case SNDRV_PCM_STATE_RUNNING:
 394         case SNDRV_PCM_STATE_PREPARED:
 395         case SNDRV_PCM_STATE_PAUSED:
 396                 if (avail >= stream->runtime->fragment_size)
 397                         retval = snd_compr_get_poll(stream);
 398                 break;
 399         default:
 400                 if (stream->direction == SND_COMPRESS_PLAYBACK)
 401                         retval = POLLOUT | POLLWRNORM | POLLERR;
 402                 else
 403                         retval = POLLIN | POLLRDNORM | POLLERR;
 404                 break;
 405         }
 406 out:
 407         mutex_unlock(&stream->device->lock);
 408         return retval;
 409 }
 410
 411 static int
 412 snd_compr_get_caps(struct snd_compr_stream *stream, unsigned long arg)
 413 {
 414         int retval;
 415         struct snd_compr_caps caps;
 416
 417         if (!stream->ops->get_caps)
 418                 return -ENXIO;
 419
 420         memset(&caps, 0, sizeof(caps));
 421         retval = stream->ops->get_caps(stream, &caps);
 422         if (retval)
 423                 goto out;
 424         if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
 425                 retval = -EFAULT;
 426 out:
 427         return retval;
 428 }
 429
 430 static int
 431 snd_compr_get_codec_caps(struct snd_compr_stream *stream, unsigned long arg)
 432 {
 433         int retval;
 434         struct snd_compr_codec_caps *caps;
 435
 436         if (!stream->ops->get_codec_caps)
 437                 return -ENXIO;
 438
 439         caps = kzalloc(sizeof(*caps), GFP_KERNEL);
 440         if (!caps)
 441                 return -ENOMEM;
 442
 443         retval = stream->ops->get_codec_caps(stream, caps);
 444         if (retval)
 445                 goto out;
 446         if (copy_to_user((void __user *)arg, caps, sizeof(*caps)))
 447                 retval = -EFAULT;
 448
 449 out:
 450         kfree(caps);
 451         return retval;
 452 }
 453
 454 /* revisit this with snd_pcm_preallocate_xxx */
 455 static int snd_compr_allocate_buffer(struct snd_compr_stream *stream,
 456                 struct snd_compr_params *params)
 457 {
 458         unsigned int buffer_size;
 459         void *buffer;
 460
 461         buffer_size = params->buffer.fragment_size * params->buffer.fragments;
 462         if (stream->ops->copy) {
 463                 buffer = NULL;
 464                 /* if copy is defined the driver will be required to copy
 465                  * the data from core
 466                  */
 467         } else {
 468                 buffer = kmalloc(buffer_size, GFP_KERNEL);
 469                 if (!buffer)
 470                         return -ENOMEM;
 471         }
 472         stream->runtime->fragment_size = params->buffer.fragment_size;
 473         stream->runtime->fragments = params->buffer.fragments;
 474         stream->runtime->buffer = buffer;
 475         stream->runtime->buffer_size = buffer_size;
 476         return 0;
 477 }
 478
 479 static int snd_compress_check_input(struct snd_compr_params *params)
 480 {
 481         /* first let's check the buffer parameter's */
 482         if (params->buffer.fragment_size == 0 ||
 483                         params->buffer.fragments > SIZE_MAX / params->buffer.fragment_size)
 484                 return -EINVAL;
 485
 486         /* now codec parameters */
 487         if (params->codec.id == 0 || params->codec.id > SND_AUDIOCODEC_MAX)
 488                 return -EINVAL;
 489
 490         if (params->codec.ch_in == 0 || params->codec.ch_out == 0)
 491                 return -EINVAL;
 492
 493         return 0;
 494 }
 495
 496 static int
 497 snd_compr_set_params(struct snd_compr_stream *stream, unsigned long arg)
 498 {
 499         struct snd_compr_params *params;
 500         int retval;
 501
 502         if (stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
 503                 /*
 504                  * we should allow parameter change only when stream has been
 505                  * opened not in other cases
 506                  */
 507                 params = kmalloc(sizeof(*params), GFP_KERNEL);
 508                 if (!params)
 509                         return -ENOMEM;
 510                 if (copy_from_user(params, (void __user *)arg, sizeof(*params))) {
 511                         retval = -EFAULT;
 512                         goto out;
 513                 }
 514
 515                 retval = snd_compress_check_input(params);
 516                 if (retval)
 517                         goto out;
 518
 519                 retval = snd_compr_allocate_buffer(stream, params);
 520                 if (retval) {
 521                         retval = -ENOMEM;
 522                         goto out;
 523                 }
 524
 525                 retval = stream->ops->set_params(stream, params);
 526                 if (retval)
 527                         goto out;
 528
 529                 stream->metadata_set = false;
 530                 stream->next_track = false;
 531
 532                 if (stream->direction == SND_COMPRESS_PLAYBACK)
 533                         stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 534                 else
 535                         stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
 536         } else {
 537                 return -EPERM;
 538         }
 539 out:
 540         kfree(params);
 541         return retval;
 542 }
 543
 544 static int
 545 snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
 546 {
 547         struct snd_codec *params;
 548         int retval;
 549
 550         if (!stream->ops->get_params)
 551                 return -EBADFD;
 552
 553         params = kzalloc(sizeof(*params), GFP_KERNEL);
 554         if (!params)
 555                 return -ENOMEM;
 556         retval = stream->ops->get_params(stream, params);
 557         if (retval)
 558                 goto out;
 559         if (copy_to_user((char __user *)arg, params, sizeof(*params)))
 560                 retval = -EFAULT;
 561
 562 out:
 563         kfree(params);
 564         return retval;
 565 }
 566
 567 static int
 568 snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
 569 {
 570         struct snd_compr_metadata metadata;
 571         int retval;
 572
 573         if (!stream->ops->get_metadata)
 574                 return -ENXIO;
 575
 576         if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
 577                 return -EFAULT;
 578
 579         retval = stream->ops->get_metadata(stream, &metadata);
 580         if (retval != 0)
 581                 return retval;
 582
 583         if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
 584                 return -EFAULT;
 585
 586         return 0;
 587 }
 588
 589 static int
 590 snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
 591 {
 592         struct snd_compr_metadata metadata;
 593         int retval;
 594
 595         if (!stream->ops->set_metadata)
 596                 return -ENXIO;
 597         /*
 598         * we should allow parameter change only when stream has been
 599         * opened not in other cases
 600         */
 601         if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
 602                 return -EFAULT;
 603
 604         retval = stream->ops->set_metadata(stream, &metadata);
 605         stream->metadata_set = true;
 606
 607         return retval;
 608 }
 609
 610 static inline int
 611 snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
 612 {
 613         struct snd_compr_tstamp tstamp = {0};
 614         int ret;
 615
 616         ret = snd_compr_update_tstamp(stream, &tstamp);
 617         if (ret == 0)
 618                 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
 619                         &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
 620         return ret;
 621 }
 622
 623 static int snd_compr_pause(struct snd_compr_stream *stream)
 624 {
 625         int retval;
 626
 627         if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
 628                 return -EPERM;
 629         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
 630         if (!retval)
 631                 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
 632         return retval;
 633 }
 634
 635 static int snd_compr_resume(struct snd_compr_stream *stream)
 636 {
 637         int retval;
 638
 639         if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
 640                 return -EPERM;
 641         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
 642         if (!retval)
 643                 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
 644         return retval;
 645 }
 646
 647 static int snd_compr_start(struct snd_compr_stream *stream)
 648 {
 649         int retval;
 650
 651         if (stream->runtime->state != SNDRV_PCM_STATE_PREPARED)
 652                 return -EPERM;
 653         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
 654         if (!retval)
 655                 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
 656         return retval;
 657 }
 658
 659 static int snd_compr_stop(struct snd_compr_stream *stream)
 660 {
 661         int retval;
 662
 663         if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
 664                         stream->runtime->state == SNDRV_PCM_STATE_SETUP)
 665                 return -EPERM;
 666         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
 667         if (!retval) {
 668                 snd_compr_drain_notify(stream);
 669                 stream->runtime->total_bytes_available = 0;
 670                 stream->runtime->total_bytes_transferred = 0;
 671         }
 672         return retval;
 673 }
 674
 675 static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
 676 {
 677         int ret;
 678
 679         /*
 680          * We are called with lock held. So drop the lock while we wait for
 681          * drain complete notfication from the driver
 682          *
 683          * It is expected that driver will notify the drain completion and then
 684          * stream will be moved to SETUP state, even if draining resulted in an
 685          * error. We can trigger next track after this.
 686          */
 687         stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
 688         mutex_unlock(&stream->device->lock);
 689
 690         /* we wait for drain to complete here, drain can return when
 691          * interruption occurred, wait returned error or success.
 692          * For the first two cases we don't do anything different here and
 693          * return after waking up
 694          */
 695
 696         ret = wait_event_interruptible(stream->runtime->sleep,
 697                         (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
 698         if (ret == -ERESTARTSYS)
 699                 pr_debug("wait aborted by a signal");
 700         else if (ret)
 701                 pr_debug("wait for drain failed with %d\n", ret);
 702
 703
 704         wake_up(&stream->runtime->sleep);
 705         mutex_lock(&stream->device->lock);
 706
 707         return ret;
 708 }
 709
 710 static int snd_compr_drain(struct snd_compr_stream *stream)
 711 {
 712         int retval;
 713
 714         if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
 715                         stream->runtime->state == SNDRV_PCM_STATE_SETUP)
 716                 return -EPERM;
 717
 718         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
 719         if (retval) {
 720                 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
 721                 wake_up(&stream->runtime->sleep);
 722                 return retval;
 723         }
 724
 725         return snd_compress_wait_for_drain(stream);
 726 }
 727
 728 static int snd_compr_next_track(struct snd_compr_stream *stream)
 729 {
 730         int retval;
 731
 732         /* only a running stream can transition to next track */
 733         if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
 734                 return -EPERM;
 735
 736         /* you can signal next track isf this is intended to be a gapless stream
 737          * and current track metadata is set
 738          */
 739         if (stream->metadata_set == false)
 740                 return -EPERM;
 741
 742         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
 743         if (retval != 0)
 744                 return retval;
 745         stream->metadata_set = false;
 746         stream->next_track = true;
 747         return 0;
 748 }
 749
 750 static int snd_compr_partial_drain(struct snd_compr_stream *stream)
 751 {
 752         int retval;
 753         if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
 754                         stream->runtime->state == SNDRV_PCM_STATE_SETUP)
 755                 return -EPERM;
 756         /* stream can be drained only when next track has been signalled */
 757         if (stream->next_track == false)
 758                 return -EPERM;
 759
 760         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
 761         if (retval) {
 762                 pr_debug("Partial drain returned failure\n");
 763                 wake_up(&stream->runtime->sleep);
 764                 return retval;
 765         }
 766
 767         stream->next_track = false;
 768         return snd_compress_wait_for_drain(stream);
 769 }
 770
 771 static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
 772 {
 773         struct snd_compr_file *data = f->private_data;
 774         struct snd_compr_stream *stream;
 775         int retval = -ENOTTY;
 776
 777         if (snd_BUG_ON(!data))
 778                 return -EFAULT;
 779         stream = &data->stream;
 780         if (snd_BUG_ON(!stream))
 781                 return -EFAULT;
 782         mutex_lock(&stream->device->lock);
 783         switch (_IOC_NR(cmd)) {
 784         case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
 785                 retval = put_user(SNDRV_COMPRESS_VERSION,
 786                                 (int __user *)arg) ? -EFAULT : 0;
 787                 break;
 788         case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
 789                 retval = snd_compr_get_caps(stream, arg);
 790                 break;
 791         case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
 792                 retval = snd_compr_get_codec_caps(stream, arg);
 793                 break;
 794         case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
 795                 retval = snd_compr_set_params(stream, arg);
 796                 break;
 797         case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
 798                 retval = snd_compr_get_params(stream, arg);
 799                 break;
 800         case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
 801                 retval = snd_compr_set_metadata(stream, arg);
 802                 break;
 803         case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
 804                 retval = snd_compr_get_metadata(stream, arg);
 805                 break;
 806         case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
 807                 retval = snd_compr_tstamp(stream, arg);
 808                 break;
 809         case _IOC_NR(SNDRV_COMPRESS_AVAIL):
 810                 retval = snd_compr_ioctl_avail(stream, arg);
 811                 break;
 812         case _IOC_NR(SNDRV_COMPRESS_PAUSE):
 813                 retval = snd_compr_pause(stream);
 814                 break;
 815         case _IOC_NR(SNDRV_COMPRESS_RESUME):
 816                 retval = snd_compr_resume(stream);
 817                 break;
 818         case _IOC_NR(SNDRV_COMPRESS_START):
 819                 retval = snd_compr_start(stream);
 820                 break;
 821         case _IOC_NR(SNDRV_COMPRESS_STOP):
 822                 retval = snd_compr_stop(stream);
 823                 break;
 824         case _IOC_NR(SNDRV_COMPRESS_DRAIN):
 825                 retval = snd_compr_drain(stream);
 826                 break;
 827         case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
 828                 retval = snd_compr_partial_drain(stream);
 829                 break;
 830         case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
 831                 retval = snd_compr_next_track(stream);
 832                 break;
 833
 834         }
 835         mutex_unlock(&stream->device->lock);
 836         return retval;
 837 }
 838
 839 static const struct file_operations snd_compr_file_ops = {
 840                 .owner =        THIS_MODULE,
 841                 .open =         snd_compr_open,
 842                 .release =      snd_compr_free,
 843                 .write =        snd_compr_write,
 844                 .read =         snd_compr_read,
 845                 .unlocked_ioctl = snd_compr_ioctl,
 846                 .mmap =         snd_compr_mmap,
 847                 .poll =         snd_compr_poll,
 848 };
 849
 850 static int snd_compress_dev_register(struct snd_device *device)
 851 {
 852         int ret = -EINVAL;
 853         char str[16];
 854         struct snd_compr *compr;
 855
 856         if (snd_BUG_ON(!device || !device->device_data))
 857                 return -EBADFD;
 858         compr = device->device_data;
 859
 860         sprintf(str, "comprC%iD%i", compr->card->number, compr->device);
 861         pr_debug("reg %s for device %s, direction %d\n", str, compr->name,
 862                         compr->direction);
 863         /* register compressed device */
 864         ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS, compr->card,
 865                         compr->device, &snd_compr_file_ops, compr, str);
 866         if (ret < 0) {
 867                 pr_err("snd_register_device failed\n %d", ret);
 868                 return ret;
 869         }
 870         return ret;
 871
 872 }
 873
 874 static int snd_compress_dev_disconnect(struct snd_device *device)
 875 {
 876         struct snd_compr *compr;
 877
 878         compr = device->device_data;
 879         snd_unregister_device(SNDRV_DEVICE_TYPE_COMPRESS, compr->card,
 880                 compr->device);
 881         return 0;
 882 }
 883
 884 /*
 885  * snd_compress_new: create new compress device
 886  * @card: sound card pointer
 887  * @device: device number
 888  * @dirn: device direction, should be of type enum snd_compr_direction
 889  * @compr: compress device pointer
 890  */
 891 int snd_compress_new(struct snd_card *card, int device,
 892                         int dirn, struct snd_compr *compr)
 893 {
 894         static struct snd_device_ops ops = {
 895                 .dev_free = NULL,
 896                 .dev_register = snd_compress_dev_register,
 897                 .dev_disconnect = snd_compress_dev_disconnect,
 898         };
 899
 900         compr->card = card;
 901         compr->device = device;
 902         compr->direction = dirn;
 903         return snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
 904 }
 905 EXPORT_SYMBOL_GPL(snd_compress_new);
 906
 907 static int snd_compress_add_device(struct snd_compr *device)
 908 {
 909         int ret;
 910
 911         if (!device->card)
 912                 return -EINVAL;
 913
 914         /* register the card */
 915         ret = snd_card_register(device->card);
 916         if (ret)
 917                 goto out;
 918         return 0;
 919
 920 out:
 921         pr_err("failed with %d\n", ret);
 922         return ret;
 923
 924 }
 925
 926 static int snd_compress_remove_device(struct snd_compr *device)
 927 {
 928         return snd_card_free(device->card);
 929 }
 930
 931 /**
 932  * snd_compress_register - register compressed device
 933  *
 934  * @device: compressed device to register
 935  */
 936 int snd_compress_register(struct snd_compr *device)
 937 {
 938         int retval;
 939
 940         if (device->name == NULL || device->dev == NULL || device->ops == NULL)
 941                 return -EINVAL;
 942
 943         pr_debug("Registering compressed device %s\n", device->name);
 944         if (snd_BUG_ON(!device->ops->open))
 945                 return -EINVAL;
 946         if (snd_BUG_ON(!device->ops->free))
 947                 return -EINVAL;
 948         if (snd_BUG_ON(!device->ops->set_params))
 949                 return -EINVAL;
 950         if (snd_BUG_ON(!device->ops->trigger))
 951                 return -EINVAL;
 952
 953         mutex_init(&device->lock);
 954
 955         /* register a compressed card */
 956         mutex_lock(&device_mutex);
 957         retval = snd_compress_add_device(device);
 958         mutex_unlock(&device_mutex);
 959         return retval;
 960 }
 961 EXPORT_SYMBOL_GPL(snd_compress_register);
 962
 963 int snd_compress_deregister(struct snd_compr *device)
 964 {
 965         pr_debug("Removing compressed device %s\n", device->name);
 966         mutex_lock(&device_mutex);
 967         snd_compress_remove_device(device);
 968         mutex_unlock(&device_mutex);
 969         return 0;
 970 }
 971 EXPORT_SYMBOL_GPL(snd_compress_deregister);
 972
 973 static int __init snd_compress_init(void)
 974 {
 975         return 0;
 976 }
 977
 978 static void __exit snd_compress_exit(void)
 979 {
 980 }
 981
 982 module_init(snd_compress_init);
 983 module_exit(snd_compress_exit);
 984
 985 MODULE_DESCRIPTION("ALSA Compressed offload framework");
 986 MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
 987 MODULE_LICENSE("GPL v2");