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