2 * compress_core.c - compress offload core
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 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
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.
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.
22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 #define FORMAT(fmt) "%s: %d: " fmt, __func__, __LINE__
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " FORMAT(fmt)
28 #include <linux/file.h>
30 #include <linux/list.h>
32 #include <linux/mutex.h>
33 #include <linux/poll.h>
34 #include <linux/slab.h>
35 #include <linux/sched.h>
36 #include <linux/uio.h>
37 #include <linux/uaccess.h>
38 #include <linux/module.h>
39 #include <sound/core.h>
40 #include <sound/initval.h>
41 #include <sound/compress_params.h>
42 #include <sound/compress_offload.h>
43 #include <sound/compress_driver.h>
46 * - add substream support for multiple devices in case of
47 * SND_DYNAMIC_MINORS is not used
48 * - Multiple node representation
49 * driver should be able to register multiple nodes
52 static DEFINE_MUTEX(device_mutex
);
54 struct snd_compr_file
{
56 struct snd_compr_stream stream
;
60 * a note on stream states used:
61 * we use follwing 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_RUNNING: When stream has been started and is
67 * decoding/encoding and rendering/capturing data.
68 * SNDRV_PCM_STATE_DRAINING: When stream is draining current data. This is done
69 * by calling SNDRV_COMPRESS_DRAIN.
70 * SNDRV_PCM_STATE_PAUSED: When stream is paused. This is done by calling
71 * SNDRV_COMPRESS_PAUSE. It can be stopped or resumed by calling
72 * SNDRV_COMPRESS_STOP or SNDRV_COMPRESS_RESUME respectively.
74 static int snd_compr_open(struct inode
*inode
, struct file
*f
)
76 struct snd_compr
*compr
;
77 struct snd_compr_file
*data
;
78 struct snd_compr_runtime
*runtime
;
79 enum snd_compr_direction dirn
;
80 int maj
= imajor(inode
);
83 if ((f
->f_flags
& O_ACCMODE
) == O_WRONLY
)
84 dirn
= SND_COMPRESS_PLAYBACK
;
85 else if ((f
->f_flags
& O_ACCMODE
) == O_RDONLY
)
86 dirn
= SND_COMPRESS_CAPTURE
;
91 compr
= snd_lookup_minor_data(iminor(inode
),
92 SNDRV_DEVICE_TYPE_COMPRESS
);
97 pr_err("no device data!!!\n");
101 if (dirn
!= compr
->direction
) {
102 pr_err("this device doesn't support this direction\n");
106 data
= kzalloc(sizeof(*data
), GFP_KERNEL
);
109 data
->stream
.ops
= compr
->ops
;
110 data
->stream
.direction
= dirn
;
111 data
->stream
.private_data
= compr
->private_data
;
112 data
->stream
.device
= compr
;
113 runtime
= kzalloc(sizeof(*runtime
), GFP_KERNEL
);
118 runtime
->state
= SNDRV_PCM_STATE_OPEN
;
119 init_waitqueue_head(&runtime
->sleep
);
120 data
->stream
.runtime
= runtime
;
121 f
->private_data
= (void *)data
;
122 mutex_lock(&compr
->lock
);
123 ret
= compr
->ops
->open(&data
->stream
);
124 mutex_unlock(&compr
->lock
);
132 static int snd_compr_free(struct inode
*inode
, struct file
*f
)
134 struct snd_compr_file
*data
= f
->private_data
;
135 data
->stream
.ops
->free(&data
->stream
);
136 kfree(data
->stream
.runtime
->buffer
);
137 kfree(data
->stream
.runtime
);
142 static void snd_compr_update_tstamp(struct snd_compr_stream
*stream
,
143 struct snd_compr_tstamp
*tstamp
)
145 if (!stream
->ops
->pointer
)
147 stream
->ops
->pointer(stream
, tstamp
);
148 pr_debug("dsp consumed till %d total %d bytes\n",
149 tstamp
->byte_offset
, tstamp
->copied_total
);
150 stream
->runtime
->hw_pointer
= tstamp
->byte_offset
;
151 stream
->runtime
->total_bytes_transferred
= tstamp
->copied_total
;
154 static size_t snd_compr_calc_avail(struct snd_compr_stream
*stream
,
155 struct snd_compr_avail
*avail
)
157 long avail_calc
; /*this needs to be signed variable */
159 snd_compr_update_tstamp(stream
, &avail
->tstamp
);
161 /* FIXME: This needs to be different for capture stream,
162 available is # of compressed data, for playback it's
163 remainder of buffer */
165 if (stream
->runtime
->total_bytes_available
== 0 &&
166 stream
->runtime
->state
== SNDRV_PCM_STATE_SETUP
) {
167 pr_debug("detected init and someone forgot to do a write\n");
168 return stream
->runtime
->buffer_size
;
170 pr_debug("app wrote %lld, DSP consumed %lld\n",
171 stream
->runtime
->total_bytes_available
,
172 stream
->runtime
->total_bytes_transferred
);
173 if (stream
->runtime
->total_bytes_available
==
174 stream
->runtime
->total_bytes_transferred
) {
175 pr_debug("both pointers are same, returning full avail\n");
176 return stream
->runtime
->buffer_size
;
179 /* FIXME: this routine isn't consistent, in one test we use
180 * cumulative values and in the other byte offsets. Do we
181 * really need the byte offsets if the cumulative values have
182 * been updated? In the PCM interface app_ptr and hw_ptr are
183 * already cumulative */
185 avail_calc
= stream
->runtime
->buffer_size
-
186 (stream
->runtime
->app_pointer
- stream
->runtime
->hw_pointer
);
187 pr_debug("calc avail as %ld, app_ptr %lld, hw+ptr %lld\n", avail_calc
,
188 stream
->runtime
->app_pointer
,
189 stream
->runtime
->hw_pointer
);
190 if (avail_calc
>= stream
->runtime
->buffer_size
)
191 avail_calc
-= stream
->runtime
->buffer_size
;
192 pr_debug("ret avail as %ld\n", avail_calc
);
193 avail
->avail
= avail_calc
;
197 static inline size_t snd_compr_get_avail(struct snd_compr_stream
*stream
)
199 struct snd_compr_avail avail
;
201 return snd_compr_calc_avail(stream
, &avail
);
205 snd_compr_ioctl_avail(struct snd_compr_stream
*stream
, unsigned long arg
)
207 struct snd_compr_avail ioctl_avail
;
210 avail
= snd_compr_calc_avail(stream
, &ioctl_avail
);
211 ioctl_avail
.avail
= avail
;
213 if (copy_to_user((__u64 __user
*)arg
,
214 &ioctl_avail
, sizeof(ioctl_avail
)))
219 static int snd_compr_write_data(struct snd_compr_stream
*stream
,
220 const char __user
*buf
, size_t count
)
224 struct snd_compr_runtime
*runtime
= stream
->runtime
;
226 dstn
= runtime
->buffer
+ runtime
->app_pointer
;
227 pr_debug("copying %ld at %lld\n",
228 (unsigned long)count
, runtime
->app_pointer
);
229 if (count
< runtime
->buffer_size
- runtime
->app_pointer
) {
230 if (copy_from_user(dstn
, buf
, count
))
232 runtime
->app_pointer
+= count
;
234 copy
= runtime
->buffer_size
- runtime
->app_pointer
;
235 if (copy_from_user(dstn
, buf
, copy
))
237 if (copy_from_user(runtime
->buffer
, buf
+ copy
, count
- copy
))
239 runtime
->app_pointer
= count
- copy
;
241 /* if DSP cares, let it know data has been written */
242 if (stream
->ops
->ack
)
243 stream
->ops
->ack(stream
, count
);
247 static ssize_t
snd_compr_write(struct file
*f
, const char __user
*buf
,
248 size_t count
, loff_t
*offset
)
250 struct snd_compr_file
*data
= f
->private_data
;
251 struct snd_compr_stream
*stream
;
255 if (snd_BUG_ON(!data
))
258 stream
= &data
->stream
;
259 mutex_lock(&stream
->device
->lock
);
260 /* write is allowed when stream is running or has been steup */
261 if (stream
->runtime
->state
!= SNDRV_PCM_STATE_SETUP
&&
262 stream
->runtime
->state
!= SNDRV_PCM_STATE_RUNNING
) {
263 mutex_unlock(&stream
->device
->lock
);
267 avail
= snd_compr_get_avail(stream
);
268 pr_debug("avail returned %ld\n", (unsigned long)avail
);
269 /* calculate how much we can write to buffer */
273 if (stream
->ops
->copy
)
274 retval
= stream
->ops
->copy(stream
, buf
, avail
);
276 retval
= snd_compr_write_data(stream
, buf
, avail
);
278 stream
->runtime
->total_bytes_available
+= retval
;
280 /* while initiating the stream, write should be called before START
281 * call, so in setup move state */
282 if (stream
->runtime
->state
== SNDRV_PCM_STATE_SETUP
) {
283 stream
->runtime
->state
= SNDRV_PCM_STATE_PREPARED
;
284 pr_debug("stream prepared, Houston we are good to go\n");
287 mutex_unlock(&stream
->device
->lock
);
292 static ssize_t
snd_compr_read(struct file
*f
, char __user
*buf
,
293 size_t count
, loff_t
*offset
)
298 static int snd_compr_mmap(struct file
*f
, struct vm_area_struct
*vma
)
303 static inline int snd_compr_get_poll(struct snd_compr_stream
*stream
)
305 if (stream
->direction
== SND_COMPRESS_PLAYBACK
)
306 return POLLOUT
| POLLWRNORM
;
308 return POLLIN
| POLLRDNORM
;
311 static unsigned int snd_compr_poll(struct file
*f
, poll_table
*wait
)
313 struct snd_compr_file
*data
= f
->private_data
;
314 struct snd_compr_stream
*stream
;
318 if (snd_BUG_ON(!data
))
320 stream
= &data
->stream
;
321 if (snd_BUG_ON(!stream
))
324 mutex_lock(&stream
->device
->lock
);
325 if (stream
->runtime
->state
== SNDRV_PCM_STATE_PAUSED
||
326 stream
->runtime
->state
== SNDRV_PCM_STATE_OPEN
) {
330 poll_wait(f
, &stream
->runtime
->sleep
, wait
);
332 avail
= snd_compr_get_avail(stream
);
333 pr_debug("avail is %ld\n", (unsigned long)avail
);
334 /* check if we have at least one fragment to fill */
335 switch (stream
->runtime
->state
) {
336 case SNDRV_PCM_STATE_DRAINING
:
337 /* stream has been woken up after drain is complete
338 * draining done so set stream state to stopped
340 retval
= snd_compr_get_poll(stream
);
341 stream
->runtime
->state
= SNDRV_PCM_STATE_SETUP
;
343 case SNDRV_PCM_STATE_RUNNING
:
344 case SNDRV_PCM_STATE_PREPARED
:
345 case SNDRV_PCM_STATE_PAUSED
:
346 if (avail
>= stream
->runtime
->fragment_size
)
347 retval
= snd_compr_get_poll(stream
);
350 if (stream
->direction
== SND_COMPRESS_PLAYBACK
)
351 retval
= POLLOUT
| POLLWRNORM
| POLLERR
;
353 retval
= POLLIN
| POLLRDNORM
| POLLERR
;
357 mutex_unlock(&stream
->device
->lock
);
362 snd_compr_get_caps(struct snd_compr_stream
*stream
, unsigned long arg
)
365 struct snd_compr_caps caps
;
367 if (!stream
->ops
->get_caps
)
370 retval
= stream
->ops
->get_caps(stream
, &caps
);
373 if (copy_to_user((void __user
*)arg
, &caps
, sizeof(caps
)))
380 snd_compr_get_codec_caps(struct snd_compr_stream
*stream
, unsigned long arg
)
383 struct snd_compr_codec_caps
*caps
;
385 if (!stream
->ops
->get_codec_caps
)
388 caps
= kmalloc(sizeof(*caps
), GFP_KERNEL
);
392 retval
= stream
->ops
->get_codec_caps(stream
, caps
);
395 if (copy_to_user((void __user
*)arg
, caps
, sizeof(*caps
)))
403 /* revisit this with snd_pcm_preallocate_xxx */
404 static int snd_compr_allocate_buffer(struct snd_compr_stream
*stream
,
405 struct snd_compr_params
*params
)
407 unsigned int buffer_size
;
410 buffer_size
= params
->buffer
.fragment_size
* params
->buffer
.fragments
;
411 if (stream
->ops
->copy
) {
413 /* if copy is defined the driver will be required to copy
417 buffer
= kmalloc(buffer_size
, GFP_KERNEL
);
421 stream
->runtime
->fragment_size
= params
->buffer
.fragment_size
;
422 stream
->runtime
->fragments
= params
->buffer
.fragments
;
423 stream
->runtime
->buffer
= buffer
;
424 stream
->runtime
->buffer_size
= buffer_size
;
429 snd_compr_set_params(struct snd_compr_stream
*stream
, unsigned long arg
)
431 struct snd_compr_params
*params
;
434 if (stream
->runtime
->state
== SNDRV_PCM_STATE_OPEN
) {
436 * we should allow parameter change only when stream has been
437 * opened not in other cases
439 params
= kmalloc(sizeof(*params
), GFP_KERNEL
);
442 if (copy_from_user(params
, (void __user
*)arg
, sizeof(*params
))) {
446 retval
= snd_compr_allocate_buffer(stream
, params
);
451 retval
= stream
->ops
->set_params(stream
, params
);
454 stream
->runtime
->state
= SNDRV_PCM_STATE_SETUP
;
464 snd_compr_get_params(struct snd_compr_stream
*stream
, unsigned long arg
)
466 struct snd_codec
*params
;
469 if (!stream
->ops
->get_params
)
472 params
= kmalloc(sizeof(*params
), GFP_KERNEL
);
475 retval
= stream
->ops
->get_params(stream
, params
);
478 if (copy_to_user((char __user
*)arg
, params
, sizeof(*params
)))
487 snd_compr_tstamp(struct snd_compr_stream
*stream
, unsigned long arg
)
489 struct snd_compr_tstamp tstamp
;
491 snd_compr_update_tstamp(stream
, &tstamp
);
492 return copy_to_user((struct snd_compr_tstamp __user
*)arg
,
493 &tstamp
, sizeof(tstamp
)) ? -EFAULT
: 0;
496 static int snd_compr_pause(struct snd_compr_stream
*stream
)
500 if (stream
->runtime
->state
!= SNDRV_PCM_STATE_RUNNING
)
502 retval
= stream
->ops
->trigger(stream
, SNDRV_PCM_TRIGGER_PAUSE_PUSH
);
504 stream
->runtime
->state
= SNDRV_PCM_STATE_PAUSED
;
508 static int snd_compr_resume(struct snd_compr_stream
*stream
)
512 if (stream
->runtime
->state
!= SNDRV_PCM_STATE_PAUSED
)
514 retval
= stream
->ops
->trigger(stream
, SNDRV_PCM_TRIGGER_PAUSE_RELEASE
);
516 stream
->runtime
->state
= SNDRV_PCM_STATE_RUNNING
;
520 static int snd_compr_start(struct snd_compr_stream
*stream
)
524 if (stream
->runtime
->state
!= SNDRV_PCM_STATE_PREPARED
)
526 retval
= stream
->ops
->trigger(stream
, SNDRV_PCM_TRIGGER_START
);
528 stream
->runtime
->state
= SNDRV_PCM_STATE_RUNNING
;
532 static int snd_compr_stop(struct snd_compr_stream
*stream
)
536 if (stream
->runtime
->state
== SNDRV_PCM_STATE_PREPARED
||
537 stream
->runtime
->state
== SNDRV_PCM_STATE_SETUP
)
539 retval
= stream
->ops
->trigger(stream
, SNDRV_PCM_TRIGGER_STOP
);
541 stream
->runtime
->state
= SNDRV_PCM_STATE_SETUP
;
542 wake_up(&stream
->runtime
->sleep
);
543 stream
->runtime
->hw_pointer
= 0;
544 stream
->runtime
->app_pointer
= 0;
545 stream
->runtime
->total_bytes_available
= 0;
546 stream
->runtime
->total_bytes_transferred
= 0;
551 static int snd_compr_drain(struct snd_compr_stream
*stream
)
555 if (stream
->runtime
->state
== SNDRV_PCM_STATE_PREPARED
||
556 stream
->runtime
->state
== SNDRV_PCM_STATE_SETUP
)
558 retval
= stream
->ops
->trigger(stream
, SND_COMPR_TRIGGER_DRAIN
);
560 stream
->runtime
->state
= SNDRV_PCM_STATE_DRAINING
;
561 wake_up(&stream
->runtime
->sleep
);
566 static long snd_compr_ioctl(struct file
*f
, unsigned int cmd
, unsigned long arg
)
568 struct snd_compr_file
*data
= f
->private_data
;
569 struct snd_compr_stream
*stream
;
570 int retval
= -ENOTTY
;
572 if (snd_BUG_ON(!data
))
574 stream
= &data
->stream
;
575 if (snd_BUG_ON(!stream
))
577 mutex_lock(&stream
->device
->lock
);
578 switch (_IOC_NR(cmd
)) {
579 case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION
):
580 put_user(SNDRV_COMPRESS_VERSION
,
581 (int __user
*)arg
) ? -EFAULT
: 0;
583 case _IOC_NR(SNDRV_COMPRESS_GET_CAPS
):
584 retval
= snd_compr_get_caps(stream
, arg
);
586 case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS
):
587 retval
= snd_compr_get_codec_caps(stream
, arg
);
589 case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS
):
590 retval
= snd_compr_set_params(stream
, arg
);
592 case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS
):
593 retval
= snd_compr_get_params(stream
, arg
);
595 case _IOC_NR(SNDRV_COMPRESS_TSTAMP
):
596 retval
= snd_compr_tstamp(stream
, arg
);
598 case _IOC_NR(SNDRV_COMPRESS_AVAIL
):
599 retval
= snd_compr_ioctl_avail(stream
, arg
);
601 case _IOC_NR(SNDRV_COMPRESS_PAUSE
):
602 retval
= snd_compr_pause(stream
);
604 case _IOC_NR(SNDRV_COMPRESS_RESUME
):
605 retval
= snd_compr_resume(stream
);
607 case _IOC_NR(SNDRV_COMPRESS_START
):
608 retval
= snd_compr_start(stream
);
610 case _IOC_NR(SNDRV_COMPRESS_STOP
):
611 retval
= snd_compr_stop(stream
);
613 case _IOC_NR(SNDRV_COMPRESS_DRAIN
):
614 retval
= snd_compr_drain(stream
);
617 mutex_unlock(&stream
->device
->lock
);
621 static const struct file_operations snd_compr_file_ops
= {
622 .owner
= THIS_MODULE
,
623 .open
= snd_compr_open
,
624 .release
= snd_compr_free
,
625 .write
= snd_compr_write
,
626 .read
= snd_compr_read
,
627 .unlocked_ioctl
= snd_compr_ioctl
,
628 .mmap
= snd_compr_mmap
,
629 .poll
= snd_compr_poll
,
632 static int snd_compress_dev_register(struct snd_device
*device
)
636 struct snd_compr
*compr
;
638 if (snd_BUG_ON(!device
|| !device
->device_data
))
640 compr
= device
->device_data
;
642 sprintf(str
, "comprC%iD%i", compr
->card
->number
, compr
->device
);
643 pr_debug("reg %s for device %s, direction %d\n", str
, compr
->name
,
645 /* register compressed device */
646 ret
= snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS
, compr
->card
,
647 compr
->device
, &snd_compr_file_ops
, compr
, str
);
649 pr_err("snd_register_device failed\n %d", ret
);
656 static int snd_compress_dev_disconnect(struct snd_device
*device
)
658 struct snd_compr
*compr
;
660 compr
= device
->device_data
;
661 snd_unregister_device(compr
->direction
, compr
->card
, compr
->device
);
666 * snd_compress_new: create new compress device
667 * @card: sound card pointer
668 * @device: device number
669 * @dirn: device direction, should be of type enum snd_compr_direction
670 * @compr: compress device pointer
672 int snd_compress_new(struct snd_card
*card
, int device
,
673 int dirn
, struct snd_compr
*compr
)
675 static struct snd_device_ops ops
= {
677 .dev_register
= snd_compress_dev_register
,
678 .dev_disconnect
= snd_compress_dev_disconnect
,
682 compr
->device
= device
;
683 compr
->direction
= dirn
;
684 return snd_device_new(card
, SNDRV_DEV_COMPRESS
, compr
, &ops
);
686 EXPORT_SYMBOL_GPL(snd_compress_new
);
688 static int snd_compress_add_device(struct snd_compr
*device
)
695 /* register the card */
696 ret
= snd_card_register(device
->card
);
702 pr_err("failed with %d\n", ret
);
707 static int snd_compress_remove_device(struct snd_compr
*device
)
709 return snd_card_free(device
->card
);
713 * snd_compress_register - register compressed device
715 * @device: compressed device to register
717 int snd_compress_register(struct snd_compr
*device
)
721 if (device
->name
== NULL
|| device
->dev
== NULL
|| device
->ops
== NULL
)
724 pr_debug("Registering compressed device %s\n", device
->name
);
725 if (snd_BUG_ON(!device
->ops
->open
))
727 if (snd_BUG_ON(!device
->ops
->free
))
729 if (snd_BUG_ON(!device
->ops
->set_params
))
731 if (snd_BUG_ON(!device
->ops
->trigger
))
734 mutex_init(&device
->lock
);
736 /* register a compressed card */
737 mutex_lock(&device_mutex
);
738 retval
= snd_compress_add_device(device
);
739 mutex_unlock(&device_mutex
);
742 EXPORT_SYMBOL_GPL(snd_compress_register
);
744 int snd_compress_deregister(struct snd_compr
*device
)
746 pr_debug("Removing compressed device %s\n", device
->name
);
747 mutex_lock(&device_mutex
);
748 snd_compress_remove_device(device
);
749 mutex_unlock(&device_mutex
);
752 EXPORT_SYMBOL_GPL(snd_compress_deregister
);
754 static int __init
snd_compress_init(void)
759 static void __exit
snd_compress_exit(void)
763 module_init(snd_compress_init
);
764 module_exit(snd_compress_exit
);
766 MODULE_DESCRIPTION("ALSA Compressed offload framework");
767 MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
768 MODULE_LICENSE("GPL v2");