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