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