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 <linux/compat.h>
  42 #include <sound/core.h>
  43 #include <sound/initval.h>
  44 #include <sound/info.h>
  45 #include <sound/compress_params.h>
  46 #include <sound/compress_offload.h>
  47 #include <sound/compress_driver.h>
  48
  49 /* struct snd_compr_codec_caps overflows the ioctl bit size for some
  50  * architectures, so we need to disable the relevant ioctls.
  51  */
  52 #if _IOC_SIZEBITS < 14
  53 #define COMPR_CODEC_CAPS_OVERFLOW
  54 #endif
  55
  56 /* TODO:
  57  * - add substream support for multiple devices in case of
  58  *      SND_DYNAMIC_MINORS is not used
  59  * - Multiple node representation
  60  *      driver should be able to register multiple nodes
  61  */
  62
  63 static DEFINE_MUTEX(device_mutex);
  64
  65 struct snd_compr_file {
  66         unsigned long caps;
  67         struct snd_compr_stream stream;
  68 };
  69
  70 static void error_delayed_work(struct work_struct *work);
  71
  72 /*
  73  * a note on stream states used:
  74  * we use following states in the compressed core
  75  * SNDRV_PCM_STATE_OPEN: When stream has been opened.
  76  * SNDRV_PCM_STATE_SETUP: When stream has been initialized. This is done by
  77  *      calling SNDRV_COMPRESS_SET_PARAMS. Running streams will come to this
  78  *      state at stop by calling SNDRV_COMPRESS_STOP, or at end of drain.
  79  * SNDRV_PCM_STATE_PREPARED: When a stream has been written to (for
  80  *      playback only). User after setting up stream writes the data buffer
  81  *      before starting the stream.
  82  * SNDRV_PCM_STATE_RUNNING: When stream has been started and is
  83  *      decoding/encoding and rendering/capturing data.
  84  * SNDRV_PCM_STATE_DRAINING: When stream is draining current data. This is done
  85  *      by calling SNDRV_COMPRESS_DRAIN.
  86  * SNDRV_PCM_STATE_PAUSED: When stream is paused. This is done by calling
  87  *      SNDRV_COMPRESS_PAUSE. It can be stopped or resumed by calling
  88  *      SNDRV_COMPRESS_STOP or SNDRV_COMPRESS_RESUME respectively.
  89  */
  90 static int snd_compr_open(struct inode *inode, struct file *f)
  91 {
  92         struct snd_compr *compr;
  93         struct snd_compr_file *data;
  94         struct snd_compr_runtime *runtime;
  95         enum snd_compr_direction dirn;
  96         int maj = imajor(inode);
  97         int ret;
  98
  99         if ((f->f_flags & O_ACCMODE) == O_WRONLY)
 100                 dirn = SND_COMPRESS_PLAYBACK;
 101         else if ((f->f_flags & O_ACCMODE) == O_RDONLY)
 102                 dirn = SND_COMPRESS_CAPTURE;
 103         else
 104                 return -EINVAL;
 105
 106         if (maj == snd_major)
 107                 compr = snd_lookup_minor_data(iminor(inode),
 108                                         SNDRV_DEVICE_TYPE_COMPRESS);
 109         else
 110                 return -EBADFD;
 111
 112         if (compr == NULL) {
 113                 pr_err("no device data!!!\n");
 114                 return -ENODEV;
 115         }
 116
 117         if (dirn != compr->direction) {
 118                 pr_err("this device doesn't support this direction\n");
 119                 snd_card_unref(compr->card);
 120                 return -EINVAL;
 121         }
 122
 123         data = kzalloc(sizeof(*data), GFP_KERNEL);
 124         if (!data) {
 125                 snd_card_unref(compr->card);
 126                 return -ENOMEM;
 127         }
 128
 129         INIT_DELAYED_WORK(&data->stream.error_work, error_delayed_work);
 130
 131         data->stream.ops = compr->ops;
 132         data->stream.direction = dirn;
 133         data->stream.private_data = compr->private_data;
 134         data->stream.device = compr;
 135         runtime = kzalloc(sizeof(*runtime), GFP_KERNEL);
 136         if (!runtime) {
 137                 kfree(data);
 138                 snd_card_unref(compr->card);
 139                 return -ENOMEM;
 140         }
 141         runtime->state = SNDRV_PCM_STATE_OPEN;
 142         init_waitqueue_head(&runtime->sleep);
 143         data->stream.runtime = runtime;
 144         f->private_data = (void *)data;
 145         mutex_lock(&compr->lock);
 146         ret = compr->ops->open(&data->stream);
 147         mutex_unlock(&compr->lock);
 148         if (ret) {
 149                 kfree(runtime);
 150                 kfree(data);
 151         }
 152         snd_card_unref(compr->card);
 153         return ret;
 154 }
 155
 156 static int snd_compr_free(struct inode *inode, struct file *f)
 157 {
 158         struct snd_compr_file *data = f->private_data;
 159         struct snd_compr_runtime *runtime = data->stream.runtime;
 160
 161         cancel_delayed_work_sync(&data->stream.error_work);
 162
 163         switch (runtime->state) {
 164         case SNDRV_PCM_STATE_RUNNING:
 165         case SNDRV_PCM_STATE_DRAINING:
 166         case SNDRV_PCM_STATE_PAUSED:
 167                 data->stream.ops->trigger(&data->stream, SNDRV_PCM_TRIGGER_STOP);
 168                 break;
 169         default:
 170                 break;
 171         }
 172
 173         data->stream.ops->free(&data->stream);
 174         kfree(data->stream.runtime->buffer);
 175         kfree(data->stream.runtime);
 176         kfree(data);
 177         return 0;
 178 }
 179
 180 static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
 181                 struct snd_compr_tstamp *tstamp)
 182 {
 183         if (!stream->ops->pointer)
 184                 return -ENOTSUPP;
 185         stream->ops->pointer(stream, tstamp);
 186         pr_debug("dsp consumed till %d total %d bytes\n",
 187                 tstamp->byte_offset, tstamp->copied_total);
 188         if (stream->direction == SND_COMPRESS_PLAYBACK)
 189                 stream->runtime->total_bytes_transferred = tstamp->copied_total;
 190         else
 191                 stream->runtime->total_bytes_available = tstamp->copied_total;
 192         return 0;
 193 }
 194
 195 static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
 196                 struct snd_compr_avail *avail)
 197 {
 198         memset(avail, 0, sizeof(*avail));
 199         snd_compr_update_tstamp(stream, &avail->tstamp);
 200         /* Still need to return avail even if tstamp can't be filled in */
 201
 202         if (stream->runtime->total_bytes_available == 0 &&
 203                         stream->runtime->state == SNDRV_PCM_STATE_SETUP &&
 204                         stream->direction == SND_COMPRESS_PLAYBACK) {
 205                 pr_debug("detected init and someone forgot to do a write\n");
 206                 return stream->runtime->buffer_size;
 207         }
 208         pr_debug("app wrote %lld, DSP consumed %lld\n",
 209                         stream->runtime->total_bytes_available,
 210                         stream->runtime->total_bytes_transferred);
 211         if (stream->runtime->total_bytes_available ==
 212                                 stream->runtime->total_bytes_transferred) {
 213                 if (stream->direction == SND_COMPRESS_PLAYBACK) {
 214                         pr_debug("both pointers are same, returning full avail\n");
 215                         return stream->runtime->buffer_size;
 216                 } else {
 217                         pr_debug("both pointers are same, returning no avail\n");
 218                         return 0;
 219                 }
 220         }
 221
 222         avail->avail = stream->runtime->total_bytes_available -
 223                         stream->runtime->total_bytes_transferred;
 224         if (stream->direction == SND_COMPRESS_PLAYBACK)
 225                 avail->avail = stream->runtime->buffer_size - avail->avail;
 226
 227         pr_debug("ret avail as %lld\n", avail->avail);
 228         return avail->avail;
 229 }
 230
 231 static inline size_t snd_compr_get_avail(struct snd_compr_stream *stream)
 232 {
 233         struct snd_compr_avail avail;
 234
 235         return snd_compr_calc_avail(stream, &avail);
 236 }
 237
 238 static int
 239 snd_compr_ioctl_avail(struct snd_compr_stream *stream, unsigned long arg)
 240 {
 241         struct snd_compr_avail ioctl_avail;
 242         size_t avail;
 243
 244         avail = snd_compr_calc_avail(stream, &ioctl_avail);
 245         ioctl_avail.avail = avail;
 246
 247         switch (stream->runtime->state) {
 248         case SNDRV_PCM_STATE_OPEN:
 249                 return -EBADFD;
 250         case SNDRV_PCM_STATE_XRUN:
 251                 return -EPIPE;
 252         default:
 253                 break;
 254         }
 255
 256         if (copy_to_user((__u64 __user *)arg,
 257                                 &ioctl_avail, sizeof(ioctl_avail)))
 258                 return -EFAULT;
 259         return 0;
 260 }
 261
 262 static int snd_compr_write_data(struct snd_compr_stream *stream,
 263                const char __user *buf, size_t count)
 264 {
 265         void *dstn;
 266         size_t copy;
 267         struct snd_compr_runtime *runtime = stream->runtime;
 268         /* 64-bit Modulus */
 269         u64 app_pointer = div64_u64(runtime->total_bytes_available,
 270                                     runtime->buffer_size);
 271         app_pointer = runtime->total_bytes_available -
 272                       (app_pointer * runtime->buffer_size);
 273
 274         dstn = runtime->buffer + app_pointer;
 275         pr_debug("copying %ld at %lld\n",
 276                         (unsigned long)count, app_pointer);
 277         if (count < runtime->buffer_size - app_pointer) {
 278                 if (copy_from_user(dstn, buf, count))
 279                         return -EFAULT;
 280         } else {
 281                 copy = runtime->buffer_size - app_pointer;
 282                 if (copy_from_user(dstn, buf, copy))
 283                         return -EFAULT;
 284                 if (copy_from_user(runtime->buffer, buf + copy, count - copy))
 285                         return -EFAULT;
 286         }
 287         /* if DSP cares, let it know data has been written */
 288         if (stream->ops->ack)
 289                 stream->ops->ack(stream, count);
 290         return count;
 291 }
 292
 293 static ssize_t snd_compr_write(struct file *f, const char __user *buf,
 294                 size_t count, loff_t *offset)
 295 {
 296         struct snd_compr_file *data = f->private_data;
 297         struct snd_compr_stream *stream;
 298         size_t avail;
 299         int retval;
 300
 301         if (snd_BUG_ON(!data))
 302                 return -EFAULT;
 303
 304         stream = &data->stream;
 305         mutex_lock(&stream->device->lock);
 306         /* write is allowed when stream is running or has been steup */
 307         switch (stream->runtime->state) {
 308         case SNDRV_PCM_STATE_SETUP:
 309         case SNDRV_PCM_STATE_PREPARED:
 310         case SNDRV_PCM_STATE_RUNNING:
 311                 break;
 312         default:
 313                 mutex_unlock(&stream->device->lock);
 314                 return -EBADFD;
 315         }
 316
 317         avail = snd_compr_get_avail(stream);
 318         pr_debug("avail returned %ld\n", (unsigned long)avail);
 319         /* calculate how much we can write to buffer */
 320         if (avail > count)
 321                 avail = count;
 322
 323         if (stream->ops->copy) {
 324                 char __user* cbuf = (char __user*)buf;
 325                 retval = stream->ops->copy(stream, cbuf, avail);
 326         } else {
 327                 retval = snd_compr_write_data(stream, buf, avail);
 328         }
 329         if (retval > 0)
 330                 stream->runtime->total_bytes_available += retval;
 331
 332         /* while initiating the stream, write should be called before START
 333          * call, so in setup move state */
 334         if (stream->runtime->state == SNDRV_PCM_STATE_SETUP) {
 335                 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
 336                 pr_debug("stream prepared, Houston we are good to go\n");
 337         }
 338
 339         mutex_unlock(&stream->device->lock);
 340         return retval;
 341 }
 342
 343
 344 static ssize_t snd_compr_read(struct file *f, char __user *buf,
 345                 size_t count, loff_t *offset)
 346 {
 347         struct snd_compr_file *data = f->private_data;
 348         struct snd_compr_stream *stream;
 349         size_t avail;
 350         int retval;
 351
 352         if (snd_BUG_ON(!data))
 353                 return -EFAULT;
 354
 355         stream = &data->stream;
 356         mutex_lock(&stream->device->lock);
 357
 358         /* read is allowed when stream is running, paused, draining and setup
 359          * (yes setup is state which we transition to after stop, so if user
 360          * wants to read data after stop we allow that)
 361          */
 362         switch (stream->runtime->state) {
 363         case SNDRV_PCM_STATE_OPEN:
 364         case SNDRV_PCM_STATE_PREPARED:
 365         case SNDRV_PCM_STATE_SUSPENDED:
 366         case SNDRV_PCM_STATE_DISCONNECTED:
 367                 retval = -EBADFD;
 368                 goto out;
 369         case SNDRV_PCM_STATE_XRUN:
 370                 retval = -EPIPE;
 371                 goto out;
 372         }
 373
 374         avail = snd_compr_get_avail(stream);
 375         pr_debug("avail returned %ld\n", (unsigned long)avail);
 376         /* calculate how much we can read from buffer */
 377         if (avail > count)
 378                 avail = count;
 379
 380         if (stream->ops->copy) {
 381                 retval = stream->ops->copy(stream, buf, avail);
 382         } else {
 383                 retval = -ENXIO;
 384                 goto out;
 385         }
 386         if (retval > 0)
 387                 stream->runtime->total_bytes_transferred += retval;
 388
 389 out:
 390         mutex_unlock(&stream->device->lock);
 391         return retval;
 392 }
 393
 394 static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
 395 {
 396         return -ENXIO;
 397 }
 398
 399 static inline int snd_compr_get_poll(struct snd_compr_stream *stream)
 400 {
 401         if (stream->direction == SND_COMPRESS_PLAYBACK)
 402                 return POLLOUT | POLLWRNORM;
 403         else
 404                 return POLLIN | POLLRDNORM;
 405 }
 406
 407 static unsigned int snd_compr_poll(struct file *f, poll_table *wait)
 408 {
 409         struct snd_compr_file *data = f->private_data;
 410         struct snd_compr_stream *stream;
 411         size_t avail;
 412         int retval = 0;
 413
 414         if (snd_BUG_ON(!data))
 415                 return POLLERR;
 416
 417         stream = &data->stream;
 418
 419         mutex_lock(&stream->device->lock);
 420
 421         switch (stream->runtime->state) {
 422         case SNDRV_PCM_STATE_OPEN:
 423         case SNDRV_PCM_STATE_XRUN:
 424                 retval = snd_compr_get_poll(stream) | POLLERR;
 425                 goto out;
 426         default:
 427                 break;
 428         }
 429
 430         poll_wait(f, &stream->runtime->sleep, wait);
 431
 432         avail = snd_compr_get_avail(stream);
 433         pr_debug("avail is %ld\n", (unsigned long)avail);
 434         /* check if we have at least one fragment to fill */
 435         switch (stream->runtime->state) {
 436         case SNDRV_PCM_STATE_DRAINING:
 437                 /* stream has been woken up after drain is complete
 438                  * draining done so set stream state to stopped
 439                  */
 440                 retval = snd_compr_get_poll(stream);
 441                 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 442                 break;
 443         case SNDRV_PCM_STATE_RUNNING:
 444         case SNDRV_PCM_STATE_PREPARED:
 445         case SNDRV_PCM_STATE_PAUSED:
 446                 if (avail >= stream->runtime->fragment_size)
 447                         retval = snd_compr_get_poll(stream);
 448                 break;
 449         default:
 450                 retval = snd_compr_get_poll(stream) | POLLERR;
 451                 break;
 452         }
 453 out:
 454         mutex_unlock(&stream->device->lock);
 455         return retval;
 456 }
 457
 458 static int
 459 snd_compr_get_caps(struct snd_compr_stream *stream, unsigned long arg)
 460 {
 461         int retval;
 462         struct snd_compr_caps caps;
 463
 464         if (!stream->ops->get_caps)
 465                 return -ENXIO;
 466
 467         memset(&caps, 0, sizeof(caps));
 468         retval = stream->ops->get_caps(stream, &caps);
 469         if (retval)
 470                 goto out;
 471         if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
 472                 retval = -EFAULT;
 473 out:
 474         return retval;
 475 }
 476
 477 #ifndef COMPR_CODEC_CAPS_OVERFLOW
 478 static int
 479 snd_compr_get_codec_caps(struct snd_compr_stream *stream, unsigned long arg)
 480 {
 481         int retval;
 482         struct snd_compr_codec_caps *caps;
 483
 484         if (!stream->ops->get_codec_caps)
 485                 return -ENXIO;
 486
 487         caps = kzalloc(sizeof(*caps), GFP_KERNEL);
 488         if (!caps)
 489                 return -ENOMEM;
 490
 491         retval = stream->ops->get_codec_caps(stream, caps);
 492         if (retval)
 493                 goto out;
 494         if (copy_to_user((void __user *)arg, caps, sizeof(*caps)))
 495                 retval = -EFAULT;
 496
 497 out:
 498         kfree(caps);
 499         return retval;
 500 }
 501 #endif /* !COMPR_CODEC_CAPS_OVERFLOW */
 502
 503 /* revisit this with snd_pcm_preallocate_xxx */
 504 static int snd_compr_allocate_buffer(struct snd_compr_stream *stream,
 505                 struct snd_compr_params *params)
 506 {
 507         unsigned int buffer_size;
 508         void *buffer;
 509
 510         buffer_size = params->buffer.fragment_size * params->buffer.fragments;
 511         if (stream->ops->copy) {
 512                 buffer = NULL;
 513                 /* if copy is defined the driver will be required to copy
 514                  * the data from core
 515                  */
 516         } else {
 517                 buffer = kmalloc(buffer_size, GFP_KERNEL);
 518                 if (!buffer)
 519                         return -ENOMEM;
 520         }
 521         stream->runtime->fragment_size = params->buffer.fragment_size;
 522         stream->runtime->fragments = params->buffer.fragments;
 523         stream->runtime->buffer = buffer;
 524         stream->runtime->buffer_size = buffer_size;
 525         return 0;
 526 }
 527
 528 static int snd_compress_check_input(struct snd_compr_params *params)
 529 {
 530         /* first let's check the buffer parameter's */
 531         if (params->buffer.fragment_size == 0 ||
 532             params->buffer.fragments > U32_MAX / params->buffer.fragment_size ||
 533             params->buffer.fragments == 0)
 534                 return -EINVAL;
 535
 536         /* now codec parameters */
 537         if (params->codec.id == 0 || params->codec.id > SND_AUDIOCODEC_MAX)
 538                 return -EINVAL;
 539
 540         if (params->codec.ch_in == 0 || params->codec.ch_out == 0)
 541                 return -EINVAL;
 542
 543         return 0;
 544 }
 545
 546 static int
 547 snd_compr_set_params(struct snd_compr_stream *stream, unsigned long arg)
 548 {
 549         struct snd_compr_params *params;
 550         int retval;
 551
 552         if (stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
 553                 /*
 554                  * we should allow parameter change only when stream has been
 555                  * opened not in other cases
 556                  */
 557                 params = memdup_user((void __user *)arg, sizeof(*params));
 558                 if (IS_ERR(params))
 559                         return PTR_ERR(params);
 560
 561                 retval = snd_compress_check_input(params);
 562                 if (retval)
 563                         goto out;
 564
 565                 retval = snd_compr_allocate_buffer(stream, params);
 566                 if (retval) {
 567                         retval = -ENOMEM;
 568                         goto out;
 569                 }
 570
 571                 retval = stream->ops->set_params(stream, params);
 572                 if (retval)
 573                         goto out;
 574
 575                 stream->metadata_set = false;
 576                 stream->next_track = false;
 577
 578                 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 579         } else {
 580                 return -EPERM;
 581         }
 582 out:
 583         kfree(params);
 584         return retval;
 585 }
 586
 587 static int
 588 snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
 589 {
 590         struct snd_codec *params;
 591         int retval;
 592
 593         if (!stream->ops->get_params)
 594                 return -EBADFD;
 595
 596         params = kzalloc(sizeof(*params), GFP_KERNEL);
 597         if (!params)
 598                 return -ENOMEM;
 599         retval = stream->ops->get_params(stream, params);
 600         if (retval)
 601                 goto out;
 602         if (copy_to_user((char __user *)arg, params, sizeof(*params)))
 603                 retval = -EFAULT;
 604
 605 out:
 606         kfree(params);
 607         return retval;
 608 }
 609
 610 static int
 611 snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
 612 {
 613         struct snd_compr_metadata metadata;
 614         int retval;
 615
 616         if (!stream->ops->get_metadata)
 617                 return -ENXIO;
 618
 619         if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
 620                 return -EFAULT;
 621
 622         retval = stream->ops->get_metadata(stream, &metadata);
 623         if (retval != 0)
 624                 return retval;
 625
 626         if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
 627                 return -EFAULT;
 628
 629         return 0;
 630 }
 631
 632 static int
 633 snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
 634 {
 635         struct snd_compr_metadata metadata;
 636         int retval;
 637
 638         if (!stream->ops->set_metadata)
 639                 return -ENXIO;
 640         /*
 641         * we should allow parameter change only when stream has been
 642         * opened not in other cases
 643         */
 644         if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
 645                 return -EFAULT;
 646
 647         retval = stream->ops->set_metadata(stream, &metadata);
 648         stream->metadata_set = true;
 649
 650         return retval;
 651 }
 652
 653 static inline int
 654 snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
 655 {
 656         struct snd_compr_tstamp tstamp = {0};
 657         int ret;
 658
 659         ret = snd_compr_update_tstamp(stream, &tstamp);
 660         if (ret == 0)
 661                 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
 662                         &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
 663         return ret;
 664 }
 665
 666 static int snd_compr_pause(struct snd_compr_stream *stream)
 667 {
 668         int retval;
 669
 670         if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
 671                 return -EPERM;
 672         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
 673         if (!retval)
 674                 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
 675         return retval;
 676 }
 677
 678 static int snd_compr_resume(struct snd_compr_stream *stream)
 679 {
 680         int retval;
 681
 682         if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
 683                 return -EPERM;
 684         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
 685         if (!retval)
 686                 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
 687         return retval;
 688 }
 689
 690 static int snd_compr_start(struct snd_compr_stream *stream)
 691 {
 692         int retval;
 693
 694         switch (stream->runtime->state) {
 695         case SNDRV_PCM_STATE_SETUP:
 696                 if (stream->direction != SND_COMPRESS_CAPTURE)
 697                         return -EPERM;
 698                 break;
 699         case SNDRV_PCM_STATE_PREPARED:
 700                 break;
 701         default:
 702                 return -EPERM;
 703         }
 704
 705         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
 706         if (!retval)
 707                 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
 708         return retval;
 709 }
 710
 711 static int snd_compr_stop(struct snd_compr_stream *stream)
 712 {
 713         int retval;
 714
 715         switch (stream->runtime->state) {
 716         case SNDRV_PCM_STATE_OPEN:
 717         case SNDRV_PCM_STATE_SETUP:
 718         case SNDRV_PCM_STATE_PREPARED:
 719                 return -EPERM;
 720         default:
 721                 break;
 722         }
 723
 724         retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
 725         if (!retval) {
 726                 /* clear flags and stop any drain wait */
 727                 stream->partial_drain = false;
 728                 stream->metadata_set = false;
 729                 snd_compr_drain_notify(stream);
 730                 stream->runtime->total_bytes_available = 0;
 731                 stream->runtime->total_bytes_transferred = 0;
 732         }
 733         return retval;
 734 }
 735
 736 static void error_delayed_work(struct work_struct *work)
 737 {
 738         struct snd_compr_stream *stream;
 739
 740         stream = container_of(work, struct snd_compr_stream, error_work.work);
 741
 742         mutex_lock(&stream->device->lock);
 743
 744         stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
 745         wake_up(&stream->runtime->sleep);
 746
 747         mutex_unlock(&stream->device->lock);
 748 }
 749
 750 /*
 751  * snd_compr_stop_error: Report a fatal error on a stream
 752  * @stream: pointer to stream
 753  * @state: state to transition the stream to
 754  *
 755  * Stop the stream and set its state.
 756  *
 757  * Should be called with compressed device lock held.
 758  */
 759 int snd_compr_stop_error(struct snd_compr_stream *stream,
 760                          snd_pcm_state_t state)
 761 {
 762         if (stream->runtime->state == state)
 763                 return 0;
 764
 765         stream->runtime->state = state;
 766
 767         pr_debug("Changing state to: %d\n", state);
 768
 769         queue_delayed_work(system_power_efficient_wq, &stream->error_work, 0);
 770
 771         return 0;
 772 }
 773 EXPORT_SYMBOL_GPL(snd_compr_stop_error);
 774
 775 static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
 776 {
 777         int ret;
 778
 779         /*
 780          * We are called with lock held. So drop the lock while we wait for
 781          * drain complete notification from the driver
 782          *
 783          * It is expected that driver will notify the drain completion and then
 784          * stream will be moved to SETUP state, even if draining resulted in an
 785          * error. We can trigger next track after this.
 786          */
 787         stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
 788         mutex_unlock(&stream->device->lock);
 789
 790         /* we wait for drain to complete here, drain can return when
 791          * interruption occurred, wait returned error or success.
 792          * For the first two cases we don't do anything different here and
 793          * return after waking up
 794          */
 795
 796         ret = wait_event_interruptible(stream->runtime->sleep,
 797                         (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
 798         if (ret == -ERESTARTSYS)
 799                 pr_debug("wait aborted by a signal\n");
 800         else if (ret)
 801                 pr_debug("wait for drain failed with %d\n", ret);
 802
 803
 804         wake_up(&stream->runtime->sleep);
 805         mutex_lock(&stream->device->lock);
 806
 807         return ret;
 808 }
 809
 810 static int snd_compr_drain(struct snd_compr_stream *stream)
 811 {
 812         int retval;
 813
 814         switch (stream->runtime->state) {
 815         case SNDRV_PCM_STATE_OPEN:
 816         case SNDRV_PCM_STATE_SETUP:
 817         case SNDRV_PCM_STATE_PREPARED:
 818         case SNDRV_PCM_STATE_PAUSED:
 819                 return -EPERM;
 820         case SNDRV_PCM_STATE_XRUN:
 821                 return -EPIPE;
 822         default:
 823                 break;
 824         }
 825
 826         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
 827         if (retval) {
 828                 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
 829                 wake_up(&stream->runtime->sleep);
 830                 return retval;
 831         }
 832
 833         return snd_compress_wait_for_drain(stream);
 834 }
 835
 836 static int snd_compr_next_track(struct snd_compr_stream *stream)
 837 {
 838         int retval;
 839
 840         /* only a running stream can transition to next track */
 841         if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
 842                 return -EPERM;
 843
 844         /* next track doesn't have any meaning for capture streams */
 845         if (stream->direction == SND_COMPRESS_CAPTURE)
 846                 return -EPERM;
 847
 848         /* you can signal next track if this is intended to be a gapless stream
 849          * and current track metadata is set
 850          */
 851         if (stream->metadata_set == false)
 852                 return -EPERM;
 853
 854         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
 855         if (retval != 0)
 856                 return retval;
 857         stream->metadata_set = false;
 858         stream->next_track = true;
 859         return 0;
 860 }
 861
 862 static int snd_compr_partial_drain(struct snd_compr_stream *stream)
 863 {
 864         int retval;
 865
 866         switch (stream->runtime->state) {
 867         case SNDRV_PCM_STATE_OPEN:
 868         case SNDRV_PCM_STATE_SETUP:
 869         case SNDRV_PCM_STATE_PREPARED:
 870         case SNDRV_PCM_STATE_PAUSED:
 871                 return -EPERM;
 872         case SNDRV_PCM_STATE_XRUN:
 873                 return -EPIPE;
 874         default:
 875                 break;
 876         }
 877
 878         /* partial drain doesn't have any meaning for capture streams */
 879         if (stream->direction == SND_COMPRESS_CAPTURE)
 880                 return -EPERM;
 881
 882         /* stream can be drained only when next track has been signalled */
 883         if (stream->next_track == false)
 884                 return -EPERM;
 885
 886         stream->partial_drain = true;
 887         retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
 888         if (retval) {
 889                 pr_debug("Partial drain returned failure\n");
 890                 wake_up(&stream->runtime->sleep);
 891                 return retval;
 892         }
 893
 894         stream->next_track = false;
 895         return snd_compress_wait_for_drain(stream);
 896 }
 897
 898 static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
 899 {
 900         struct snd_compr_file *data = f->private_data;
 901         struct snd_compr_stream *stream;
 902         int retval = -ENOTTY;
 903
 904         if (snd_BUG_ON(!data))
 905                 return -EFAULT;
 906
 907         stream = &data->stream;
 908
 909         mutex_lock(&stream->device->lock);
 910         switch (_IOC_NR(cmd)) {
 911         case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
 912                 retval = put_user(SNDRV_COMPRESS_VERSION,
 913                                 (int __user *)arg) ? -EFAULT : 0;
 914                 break;
 915         case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
 916                 retval = snd_compr_get_caps(stream, arg);
 917                 break;
 918 #ifndef COMPR_CODEC_CAPS_OVERFLOW
 919         case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
 920                 retval = snd_compr_get_codec_caps(stream, arg);
 921                 break;
 922 #endif
 923         case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
 924                 retval = snd_compr_set_params(stream, arg);
 925                 break;
 926         case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
 927                 retval = snd_compr_get_params(stream, arg);
 928                 break;
 929         case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
 930                 retval = snd_compr_set_metadata(stream, arg);
 931                 break;
 932         case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
 933                 retval = snd_compr_get_metadata(stream, arg);
 934                 break;
 935         case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
 936                 retval = snd_compr_tstamp(stream, arg);
 937                 break;
 938         case _IOC_NR(SNDRV_COMPRESS_AVAIL):
 939                 retval = snd_compr_ioctl_avail(stream, arg);
 940                 break;
 941         case _IOC_NR(SNDRV_COMPRESS_PAUSE):
 942                 retval = snd_compr_pause(stream);
 943                 break;
 944         case _IOC_NR(SNDRV_COMPRESS_RESUME):
 945                 retval = snd_compr_resume(stream);
 946                 break;
 947         case _IOC_NR(SNDRV_COMPRESS_START):
 948                 retval = snd_compr_start(stream);
 949                 break;
 950         case _IOC_NR(SNDRV_COMPRESS_STOP):
 951                 retval = snd_compr_stop(stream);
 952                 break;
 953         case _IOC_NR(SNDRV_COMPRESS_DRAIN):
 954                 retval = snd_compr_drain(stream);
 955                 break;
 956         case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
 957                 retval = snd_compr_partial_drain(stream);
 958                 break;
 959         case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
 960                 retval = snd_compr_next_track(stream);
 961                 break;
 962
 963         }
 964         mutex_unlock(&stream->device->lock);
 965         return retval;
 966 }
 967
 968 /* support of 32bit userspace on 64bit platforms */
 969 #ifdef CONFIG_COMPAT
 970 static long snd_compr_ioctl_compat(struct file *file, unsigned int cmd,
 971                                                 unsigned long arg)
 972 {
 973         return snd_compr_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
 974 }
 975 #endif
 976
 977 static const struct file_operations snd_compr_file_ops = {
 978                 .owner =        THIS_MODULE,
 979                 .open =         snd_compr_open,
 980                 .release =      snd_compr_free,
 981                 .write =        snd_compr_write,
 982                 .read =         snd_compr_read,
 983                 .unlocked_ioctl = snd_compr_ioctl,
 984 #ifdef CONFIG_COMPAT
 985                 .compat_ioctl = snd_compr_ioctl_compat,
 986 #endif
 987                 .mmap =         snd_compr_mmap,
 988                 .poll =         snd_compr_poll,
 989 };
 990
 991 static int snd_compress_dev_register(struct snd_device *device)
 992 {
 993         int ret = -EINVAL;
 994         struct snd_compr *compr;
 995
 996         if (snd_BUG_ON(!device || !device->device_data))
 997                 return -EBADFD;
 998         compr = device->device_data;
 999
1000         pr_debug("reg device %s, direction %d\n", compr->name,
1001                         compr->direction);
1002         /* register compressed device */
1003         ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS,
1004                                   compr->card, compr->device,
1005                                   &snd_compr_file_ops, compr, &compr->dev);
1006         if (ret < 0) {
1007                 pr_err("snd_register_device failed %d\n", ret);
1008                 return ret;
1009         }
1010         return ret;
1011
1012 }
1013
1014 static int snd_compress_dev_disconnect(struct snd_device *device)
1015 {
1016         struct snd_compr *compr;
1017
1018         compr = device->device_data;
1019         snd_unregister_device(&compr->dev);
1020         return 0;
1021 }
1022
1023 #ifdef CONFIG_SND_VERBOSE_PROCFS
1024 static void snd_compress_proc_info_read(struct snd_info_entry *entry,
1025                                         struct snd_info_buffer *buffer)
1026 {
1027         struct snd_compr *compr = (struct snd_compr *)entry->private_data;
1028
1029         snd_iprintf(buffer, "card: %d\n", compr->card->number);
1030         snd_iprintf(buffer, "device: %d\n", compr->device);
1031         snd_iprintf(buffer, "stream: %s\n",
1032                         compr->direction == SND_COMPRESS_PLAYBACK
1033                                 ? "PLAYBACK" : "CAPTURE");
1034         snd_iprintf(buffer, "id: %s\n", compr->id);
1035 }
1036
1037 static int snd_compress_proc_init(struct snd_compr *compr)
1038 {
1039         struct snd_info_entry *entry;
1040         char name[16];
1041
1042         sprintf(name, "compr%i", compr->device);
1043         entry = snd_info_create_card_entry(compr->card, name,
1044                                            compr->card->proc_root);
1045         if (!entry)
1046                 return -ENOMEM;
1047         entry->mode = S_IFDIR | S_IRUGO | S_IXUGO;
1048         if (snd_info_register(entry) < 0) {
1049                 snd_info_free_entry(entry);
1050                 return -ENOMEM;
1051         }
1052         compr->proc_root = entry;
1053
1054         entry = snd_info_create_card_entry(compr->card, "info",
1055                                            compr->proc_root);
1056         if (entry) {
1057                 snd_info_set_text_ops(entry, compr,
1058                                       snd_compress_proc_info_read);
1059                 if (snd_info_register(entry) < 0) {
1060                         snd_info_free_entry(entry);
1061                         entry = NULL;
1062                 }
1063         }
1064         compr->proc_info_entry = entry;
1065
1066         return 0;
1067 }
1068
1069 static void snd_compress_proc_done(struct snd_compr *compr)
1070 {
1071         snd_info_free_entry(compr->proc_info_entry);
1072         compr->proc_info_entry = NULL;
1073         snd_info_free_entry(compr->proc_root);
1074         compr->proc_root = NULL;
1075 }
1076
1077 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1078 {
1079         strlcpy(compr->id, id, sizeof(compr->id));
1080 }
1081 #else
1082 static inline int snd_compress_proc_init(struct snd_compr *compr)
1083 {
1084         return 0;
1085 }
1086
1087 static inline void snd_compress_proc_done(struct snd_compr *compr)
1088 {
1089 }
1090
1091 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1092 {
1093 }
1094 #endif
1095
1096 static int snd_compress_dev_free(struct snd_device *device)
1097 {
1098         struct snd_compr *compr;
1099
1100         compr = device->device_data;
1101         snd_compress_proc_done(compr);
1102         put_device(&compr->dev);
1103         return 0;
1104 }
1105
1106 /*
1107  * snd_compress_new: create new compress device
1108  * @card: sound card pointer
1109  * @device: device number
1110  * @dirn: device direction, should be of type enum snd_compr_direction
1111  * @compr: compress device pointer
1112  */
1113 int snd_compress_new(struct snd_card *card, int device,
1114                         int dirn, const char *id, struct snd_compr *compr)
1115 {
1116         static struct snd_device_ops ops = {
1117                 .dev_free = snd_compress_dev_free,
1118                 .dev_register = snd_compress_dev_register,
1119                 .dev_disconnect = snd_compress_dev_disconnect,
1120         };
1121         int ret;
1122
1123         compr->card = card;
1124         compr->device = device;
1125         compr->direction = dirn;
1126
1127         snd_compress_set_id(compr, id);
1128
1129         snd_device_initialize(&compr->dev, card);
1130         dev_set_name(&compr->dev, "comprC%iD%i", card->number, device);
1131
1132         ret = snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
1133         if (ret == 0)
1134                 snd_compress_proc_init(compr);
1135
1136         return ret;
1137 }
1138 EXPORT_SYMBOL_GPL(snd_compress_new);
1139
1140 static int snd_compress_add_device(struct snd_compr *device)
1141 {
1142         int ret;
1143
1144         if (!device->card)
1145                 return -EINVAL;
1146
1147         /* register the card */
1148         ret = snd_card_register(device->card);
1149         if (ret)
1150                 goto out;
1151         return 0;
1152
1153 out:
1154         pr_err("failed with %d\n", ret);
1155         return ret;
1156
1157 }
1158
1159 static int snd_compress_remove_device(struct snd_compr *device)
1160 {
1161         return snd_card_free(device->card);
1162 }
1163
1164 /**
1165  * snd_compress_register - register compressed device
1166  *
1167  * @device: compressed device to register
1168  */
1169 int snd_compress_register(struct snd_compr *device)
1170 {
1171         int retval;
1172
1173         if (device->name == NULL || device->ops == NULL)
1174                 return -EINVAL;
1175
1176         pr_debug("Registering compressed device %s\n", device->name);
1177         if (snd_BUG_ON(!device->ops->open))
1178                 return -EINVAL;
1179         if (snd_BUG_ON(!device->ops->free))
1180                 return -EINVAL;
1181         if (snd_BUG_ON(!device->ops->set_params))
1182                 return -EINVAL;
1183         if (snd_BUG_ON(!device->ops->trigger))
1184                 return -EINVAL;
1185
1186         mutex_init(&device->lock);
1187
1188         /* register a compressed card */
1189         mutex_lock(&device_mutex);
1190         retval = snd_compress_add_device(device);
1191         mutex_unlock(&device_mutex);
1192         return retval;
1193 }
1194 EXPORT_SYMBOL_GPL(snd_compress_register);
1195
1196 int snd_compress_deregister(struct snd_compr *device)
1197 {
1198         pr_debug("Removing compressed device %s\n", device->name);
1199         mutex_lock(&device_mutex);
1200         snd_compress_remove_device(device);
1201         mutex_unlock(&device_mutex);
1202         return 0;
1203 }
1204 EXPORT_SYMBOL_GPL(snd_compress_deregister);
1205
1206 static int __init snd_compress_init(void)
1207 {
1208         return 0;
1209 }
1210
1211 static void __exit snd_compress_exit(void)
1212 {
1213 }
1214
1215 module_init(snd_compress_init);
1216 module_exit(snd_compress_exit);
1217
1218 MODULE_DESCRIPTION("ALSA Compressed offload framework");
1219 MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
1220 MODULE_LICENSE("GPL v2");