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