import PULS_20180308
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / sound / core / compress_offload.c
CommitLineData
b21c60a4
VK
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>
f0283b58 31#include <linux/math64.h>
b21c60a4
VK
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>
f0283b58 37#include <linux/types.h>
b21c60a4
VK
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
54static DEFINE_MUTEX(device_mutex);
55
56struct 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 */
76static 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
81cb3246 85 if ((f->f_flags & O_ACCMODE) == O_WRONLY)
b21c60a4 86 dirn = SND_COMPRESS_PLAYBACK;
81cb3246 87 else if ((f->f_flags & O_ACCMODE) == O_RDONLY)
b21c60a4 88 dirn = SND_COMPRESS_CAPTURE;
81cb3246 89 else
b21c60a4 90 return -EINVAL;
b21c60a4
VK
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");
a0830dbd 105 snd_card_unref(compr->card);
b21c60a4
VK
106 return -EINVAL;
107 }
108
109 data = kzalloc(sizeof(*data), GFP_KERNEL);
a0830dbd
TI
110 if (!data) {
111 snd_card_unref(compr->card);
b21c60a4 112 return -ENOMEM;
a0830dbd 113 }
b21c60a4
VK
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);
a0830dbd 121 snd_card_unref(compr->card);
b21c60a4
VK
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 }
a0830dbd 135 snd_card_unref(compr->card);
62726e2f 136 return ret;
b21c60a4
VK
137}
138
139static 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
17ac8e5c 149static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
b21c60a4
VK
150 struct snd_compr_tstamp *tstamp)
151{
152 if (!stream->ops->pointer)
17ac8e5c 153 return -ENOTSUPP;
b21c60a4
VK
154 stream->ops->pointer(stream, tstamp);
155 pr_debug("dsp consumed till %d total %d bytes\n",
156 tstamp->byte_offset, tstamp->copied_total);
5b1f79f7
CK
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;
17ac8e5c 161 return 0;
b21c60a4
VK
162}
163
164static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
165 struct snd_compr_avail *avail)
166{
17ac8e5c 167 memset(avail, 0, sizeof(*avail));
b21c60a4 168 snd_compr_update_tstamp(stream, &avail->tstamp);
17ac8e5c 169 /* Still need to return avail even if tstamp can't be filled in */
b21c60a4 170
b21c60a4 171 if (stream->runtime->total_bytes_available == 0 &&
5b1f79f7
CK
172 stream->runtime->state == SNDRV_PCM_STATE_SETUP &&
173 stream->direction == SND_COMPRESS_PLAYBACK) {
b21c60a4
VK
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) {
5b1f79f7
CK
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 }
b21c60a4
VK
189 }
190
5b1f79f7
CK
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
4c28e32d
CK
196 pr_debug("ret avail as %lld\n", avail->avail);
197 return avail->avail;
b21c60a4
VK
198}
199
200static 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
207static int
208snd_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
222static 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;
f0283b58
CK
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);
b21c60a4 233
f0283b58 234 dstn = runtime->buffer + app_pointer;
b21c60a4 235 pr_debug("copying %ld at %lld\n",
f0283b58
CK
236 (unsigned long)count, app_pointer);
237 if (count < runtime->buffer_size - app_pointer) {
b21c60a4
VK
238 if (copy_from_user(dstn, buf, count))
239 return -EFAULT;
b21c60a4 240 } else {
f0283b58 241 copy = runtime->buffer_size - app_pointer;
b21c60a4
VK
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;
b21c60a4
VK
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
253static 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
4daf891c
CK
279 if (stream->ops->copy) {
280 char __user* cbuf = (char __user*)buf;
281 retval = stream->ops->copy(stream, cbuf, avail);
282 } else {
b21c60a4 283 retval = snd_compr_write_data(stream, buf, avail);
4daf891c 284 }
b21c60a4
VK
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
300static ssize_t snd_compr_read(struct file *f, char __user *buf,
301 size_t count, loff_t *offset)
302{
49bb6402
CK
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
75481347
VK
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:
49bb6402
CK
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
343out:
344 mutex_unlock(&stream->device->lock);
345 return retval;
b21c60a4
VK
346}
347
348static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
349{
350 return -ENXIO;
351}
352
353static 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
361static 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 }
406out:
407 mutex_unlock(&stream->device->lock);
408 return retval;
409}
410
411static int
412snd_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
1c62e9f2 420 memset(&caps, 0, sizeof(caps));
b21c60a4
VK
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;
426out:
427 return retval;
428}
429
430static int
431snd_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
47966e97 439 caps = kzalloc(sizeof(*caps), GFP_KERNEL);
b21c60a4
VK
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
449out:
450 kfree(caps);
451 return retval;
452}
453
454/* revisit this with snd_pcm_preallocate_xxx */
455static 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
4dc040a0
VK
479static 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 ||
4b9e9796 483 params->buffer.fragments > INT_MAX / params->buffer.fragment_size)
4dc040a0
VK
484 return -EINVAL;
485
fb4a9779
VK
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 if (!(params->codec.sample_rate & SNDRV_PCM_RATE_8000_192000))
494 return -EINVAL;
495
4dc040a0
VK
496 return 0;
497}
498
b21c60a4
VK
499static int
500snd_compr_set_params(struct snd_compr_stream *stream, unsigned long arg)
501{
502 struct snd_compr_params *params;
503 int retval;
504
505 if (stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
506 /*
507 * we should allow parameter change only when stream has been
508 * opened not in other cases
509 */
510 params = kmalloc(sizeof(*params), GFP_KERNEL);
511 if (!params)
512 return -ENOMEM;
769fab2a
JJ
513 if (copy_from_user(params, (void __user *)arg, sizeof(*params))) {
514 retval = -EFAULT;
515 goto out;
516 }
4dc040a0
VK
517
518 retval = snd_compress_check_input(params);
519 if (retval)
520 goto out;
521
b21c60a4
VK
522 retval = snd_compr_allocate_buffer(stream, params);
523 if (retval) {
769fab2a
JJ
524 retval = -ENOMEM;
525 goto out;
b21c60a4 526 }
4dc040a0 527
b21c60a4
VK
528 retval = stream->ops->set_params(stream, params);
529 if (retval)
530 goto out;
49bb6402 531
9727b490
JK
532 stream->metadata_set = false;
533 stream->next_track = false;
49bb6402
CK
534
535 if (stream->direction == SND_COMPRESS_PLAYBACK)
536 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
537 else
538 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
769fab2a 539 } else {
b21c60a4 540 return -EPERM;
769fab2a 541 }
b21c60a4
VK
542out:
543 kfree(params);
544 return retval;
545}
546
547static int
548snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
549{
550 struct snd_codec *params;
551 int retval;
552
553 if (!stream->ops->get_params)
554 return -EBADFD;
555
47966e97 556 params = kzalloc(sizeof(*params), GFP_KERNEL);
b21c60a4
VK
557 if (!params)
558 return -ENOMEM;
559 retval = stream->ops->get_params(stream, params);
560 if (retval)
561 goto out;
562 if (copy_to_user((char __user *)arg, params, sizeof(*params)))
563 retval = -EFAULT;
564
565out:
566 kfree(params);
567 return retval;
568}
569
9727b490
JK
570static int
571snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
572{
573 struct snd_compr_metadata metadata;
574 int retval;
575
576 if (!stream->ops->get_metadata)
577 return -ENXIO;
578
579 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
580 return -EFAULT;
581
582 retval = stream->ops->get_metadata(stream, &metadata);
583 if (retval != 0)
584 return retval;
585
586 if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
587 return -EFAULT;
588
589 return 0;
590}
591
592static int
593snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
594{
595 struct snd_compr_metadata metadata;
596 int retval;
597
598 if (!stream->ops->set_metadata)
599 return -ENXIO;
600 /*
601 * we should allow parameter change only when stream has been
602 * opened not in other cases
603 */
604 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
605 return -EFAULT;
606
607 retval = stream->ops->set_metadata(stream, &metadata);
608 stream->metadata_set = true;
609
610 return retval;
611}
612
b21c60a4
VK
613static inline int
614snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
615{
17ac8e5c
RF
616 struct snd_compr_tstamp tstamp = {0};
617 int ret;
b21c60a4 618
17ac8e5c
RF
619 ret = snd_compr_update_tstamp(stream, &tstamp);
620 if (ret == 0)
621 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
622 &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
623 return ret;
b21c60a4
VK
624}
625
626static int snd_compr_pause(struct snd_compr_stream *stream)
627{
628 int retval;
629
630 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
631 return -EPERM;
632 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
6b18f793 633 if (!retval)
b21c60a4 634 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
b21c60a4
VK
635 return retval;
636}
637
638static int snd_compr_resume(struct snd_compr_stream *stream)
639{
640 int retval;
641
642 if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
643 return -EPERM;
644 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
645 if (!retval)
646 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
647 return retval;
648}
649
650static int snd_compr_start(struct snd_compr_stream *stream)
651{
652 int retval;
653
654 if (stream->runtime->state != SNDRV_PCM_STATE_PREPARED)
655 return -EPERM;
656 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
657 if (!retval)
658 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
659 return retval;
660}
661
662static int snd_compr_stop(struct snd_compr_stream *stream)
663{
664 int retval;
665
666 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
667 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
668 return -EPERM;
669 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
670 if (!retval) {
16442d4f 671 snd_compr_drain_notify(stream);
8b21460a
VK
672 stream->runtime->total_bytes_available = 0;
673 stream->runtime->total_bytes_transferred = 0;
b21c60a4
VK
674 }
675 return retval;
676}
677
16442d4f
VK
678static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
679{
86e6de78
VK
680 int ret;
681
16442d4f
VK
682 /*
683 * We are called with lock held. So drop the lock while we wait for
684 * drain complete notfication from the driver
685 *
686 * It is expected that driver will notify the drain completion and then
687 * stream will be moved to SETUP state, even if draining resulted in an
688 * error. We can trigger next track after this.
689 */
690 stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
691 mutex_unlock(&stream->device->lock);
692
86e6de78
VK
693 /* we wait for drain to complete here, drain can return when
694 * interruption occurred, wait returned error or success.
695 * For the first two cases we don't do anything different here and
696 * return after waking up
697 */
698
699 ret = wait_event_interruptible(stream->runtime->sleep,
700 (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
701 if (ret == -ERESTARTSYS)
702 pr_debug("wait aborted by a signal");
703 else if (ret)
704 pr_debug("wait for drain failed with %d\n", ret);
705
16442d4f
VK
706
707 wake_up(&stream->runtime->sleep);
708 mutex_lock(&stream->device->lock);
709
86e6de78 710 return ret;
16442d4f
VK
711}
712
b21c60a4
VK
713static int snd_compr_drain(struct snd_compr_stream *stream)
714{
715 int retval;
716
717 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
718 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
719 return -EPERM;
16442d4f 720
b21c60a4 721 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
16442d4f 722 if (retval) {
86e6de78 723 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
b21c60a4 724 wake_up(&stream->runtime->sleep);
16442d4f 725 return retval;
b21c60a4 726 }
16442d4f 727
86e6de78 728 return snd_compress_wait_for_drain(stream);
b21c60a4
VK
729}
730
9727b490
JK
731static int snd_compr_next_track(struct snd_compr_stream *stream)
732{
733 int retval;
734
735 /* only a running stream can transition to next track */
736 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
737 return -EPERM;
738
739 /* you can signal next track isf this is intended to be a gapless stream
740 * and current track metadata is set
741 */
742 if (stream->metadata_set == false)
743 return -EPERM;
744
745 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
746 if (retval != 0)
747 return retval;
748 stream->metadata_set = false;
749 stream->next_track = true;
750 return 0;
751}
752
753static int snd_compr_partial_drain(struct snd_compr_stream *stream)
754{
755 int retval;
756 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
757 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
758 return -EPERM;
759 /* stream can be drained only when next track has been signalled */
760 if (stream->next_track == false)
761 return -EPERM;
762
763 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
16442d4f 764 if (retval) {
86e6de78 765 pr_debug("Partial drain returned failure\n");
16442d4f
VK
766 wake_up(&stream->runtime->sleep);
767 return retval;
768 }
9727b490
JK
769
770 stream->next_track = false;
16442d4f 771 return snd_compress_wait_for_drain(stream);
9727b490
JK
772}
773
b21c60a4
VK
774static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
775{
776 struct snd_compr_file *data = f->private_data;
777 struct snd_compr_stream *stream;
778 int retval = -ENOTTY;
779
780 if (snd_BUG_ON(!data))
781 return -EFAULT;
782 stream = &data->stream;
783 if (snd_BUG_ON(!stream))
784 return -EFAULT;
785 mutex_lock(&stream->device->lock);
786 switch (_IOC_NR(cmd)) {
787 case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
d54d012b 788 retval = put_user(SNDRV_COMPRESS_VERSION,
b21c60a4
VK
789 (int __user *)arg) ? -EFAULT : 0;
790 break;
791 case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
792 retval = snd_compr_get_caps(stream, arg);
793 break;
794 case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
795 retval = snd_compr_get_codec_caps(stream, arg);
796 break;
797 case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
798 retval = snd_compr_set_params(stream, arg);
799 break;
800 case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
801 retval = snd_compr_get_params(stream, arg);
802 break;
9727b490
JK
803 case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
804 retval = snd_compr_set_metadata(stream, arg);
805 break;
806 case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
807 retval = snd_compr_get_metadata(stream, arg);
808 break;
b21c60a4
VK
809 case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
810 retval = snd_compr_tstamp(stream, arg);
811 break;
812 case _IOC_NR(SNDRV_COMPRESS_AVAIL):
813 retval = snd_compr_ioctl_avail(stream, arg);
814 break;
815 case _IOC_NR(SNDRV_COMPRESS_PAUSE):
816 retval = snd_compr_pause(stream);
817 break;
818 case _IOC_NR(SNDRV_COMPRESS_RESUME):
819 retval = snd_compr_resume(stream);
820 break;
821 case _IOC_NR(SNDRV_COMPRESS_START):
822 retval = snd_compr_start(stream);
823 break;
824 case _IOC_NR(SNDRV_COMPRESS_STOP):
825 retval = snd_compr_stop(stream);
826 break;
827 case _IOC_NR(SNDRV_COMPRESS_DRAIN):
828 retval = snd_compr_drain(stream);
829 break;
9727b490
JK
830 case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
831 retval = snd_compr_partial_drain(stream);
832 break;
833 case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
834 retval = snd_compr_next_track(stream);
835 break;
836
b21c60a4
VK
837 }
838 mutex_unlock(&stream->device->lock);
839 return retval;
840}
841
842static const struct file_operations snd_compr_file_ops = {
843 .owner = THIS_MODULE,
844 .open = snd_compr_open,
845 .release = snd_compr_free,
846 .write = snd_compr_write,
847 .read = snd_compr_read,
848 .unlocked_ioctl = snd_compr_ioctl,
849 .mmap = snd_compr_mmap,
850 .poll = snd_compr_poll,
851};
852
853static int snd_compress_dev_register(struct snd_device *device)
854{
855 int ret = -EINVAL;
856 char str[16];
857 struct snd_compr *compr;
858
859 if (snd_BUG_ON(!device || !device->device_data))
860 return -EBADFD;
861 compr = device->device_data;
862
863 sprintf(str, "comprC%iD%i", compr->card->number, compr->device);
864 pr_debug("reg %s for device %s, direction %d\n", str, compr->name,
865 compr->direction);
866 /* register compressed device */
867 ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS, compr->card,
868 compr->device, &snd_compr_file_ops, compr, str);
869 if (ret < 0) {
870 pr_err("snd_register_device failed\n %d", ret);
871 return ret;
872 }
873 return ret;
874
875}
876
877static int snd_compress_dev_disconnect(struct snd_device *device)
878{
879 struct snd_compr *compr;
880
881 compr = device->device_data;
1aff4161
LG
882 snd_unregister_device(SNDRV_DEVICE_TYPE_COMPRESS, compr->card,
883 compr->device);
b21c60a4
VK
884 return 0;
885}
886
887/*
888 * snd_compress_new: create new compress device
889 * @card: sound card pointer
890 * @device: device number
891 * @dirn: device direction, should be of type enum snd_compr_direction
892 * @compr: compress device pointer
893 */
894int snd_compress_new(struct snd_card *card, int device,
895 int dirn, struct snd_compr *compr)
896{
897 static struct snd_device_ops ops = {
898 .dev_free = NULL,
899 .dev_register = snd_compress_dev_register,
900 .dev_disconnect = snd_compress_dev_disconnect,
901 };
902
903 compr->card = card;
904 compr->device = device;
905 compr->direction = dirn;
906 return snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
907}
908EXPORT_SYMBOL_GPL(snd_compress_new);
909
910static int snd_compress_add_device(struct snd_compr *device)
911{
912 int ret;
913
914 if (!device->card)
915 return -EINVAL;
916
917 /* register the card */
918 ret = snd_card_register(device->card);
919 if (ret)
920 goto out;
921 return 0;
922
923out:
924 pr_err("failed with %d\n", ret);
925 return ret;
926
927}
928
929static int snd_compress_remove_device(struct snd_compr *device)
930{
931 return snd_card_free(device->card);
932}
933
934/**
935 * snd_compress_register - register compressed device
936 *
937 * @device: compressed device to register
938 */
939int snd_compress_register(struct snd_compr *device)
940{
941 int retval;
942
943 if (device->name == NULL || device->dev == NULL || device->ops == NULL)
944 return -EINVAL;
945
946 pr_debug("Registering compressed device %s\n", device->name);
947 if (snd_BUG_ON(!device->ops->open))
948 return -EINVAL;
949 if (snd_BUG_ON(!device->ops->free))
950 return -EINVAL;
951 if (snd_BUG_ON(!device->ops->set_params))
952 return -EINVAL;
953 if (snd_BUG_ON(!device->ops->trigger))
954 return -EINVAL;
955
956 mutex_init(&device->lock);
957
958 /* register a compressed card */
959 mutex_lock(&device_mutex);
960 retval = snd_compress_add_device(device);
961 mutex_unlock(&device_mutex);
962 return retval;
963}
964EXPORT_SYMBOL_GPL(snd_compress_register);
965
966int snd_compress_deregister(struct snd_compr *device)
967{
968 pr_debug("Removing compressed device %s\n", device->name);
969 mutex_lock(&device_mutex);
970 snd_compress_remove_device(device);
971 mutex_unlock(&device_mutex);
972 return 0;
973}
974EXPORT_SYMBOL_GPL(snd_compress_deregister);
975
976static int __init snd_compress_init(void)
977{
978 return 0;
979}
980
981static void __exit snd_compress_exit(void)
982{
983}
984
985module_init(snd_compress_init);
986module_exit(snd_compress_exit);
987
988MODULE_DESCRIPTION("ALSA Compressed offload framework");
989MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
990MODULE_LICENSE("GPL v2");