sound/core/compress_offload.c

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