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>
31 #include <linux/math64.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>
49 /* struct snd_compr_codec_caps overflows the ioctl bit size for some
50 * architectures, so we need to disable the relevant ioctls.
52 #if _IOC_SIZEBITS < 14
53 #define COMPR_CODEC_CAPS_OVERFLOW
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
63 static DEFINE_MUTEX(device_mutex);
65 struct snd_compr_file {
67 struct snd_compr_stream stream;
70 static void error_delayed_work(struct work_struct *work);
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.
90 static int snd_compr_open(struct inode *inode, struct file *f)
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);
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;
106 if (maj == snd_major)
107 compr = snd_lookup_minor_data(iminor(inode),
108 SNDRV_DEVICE_TYPE_COMPRESS);
113 pr_err("no device data!!!\n");
117 if (dirn != compr->direction) {
118 pr_err("this device doesn't support this direction\n");
119 snd_card_unref(compr->card);
123 data = kzalloc(sizeof(*data), GFP_KERNEL);
125 snd_card_unref(compr->card);
129 INIT_DELAYED_WORK(&data->stream.error_work, error_delayed_work);
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);
138 snd_card_unref(compr->card);
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);
152 snd_card_unref(compr->card);
156 static int snd_compr_free(struct inode *inode, struct file *f)
158 struct snd_compr_file *data = f->private_data;
159 struct snd_compr_runtime *runtime = data->stream.runtime;
161 cancel_delayed_work_sync(&data->stream.error_work);
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);
173 data->stream.ops->free(&data->stream);
174 kfree(data->stream.runtime->buffer);
175 kfree(data->stream.runtime);
180 static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
181 struct snd_compr_tstamp *tstamp)
183 if (!stream->ops->pointer)
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;
191 stream->runtime->total_bytes_available = tstamp->copied_total;
195 static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
196 struct snd_compr_avail *avail)
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 */
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;
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;
217 pr_debug("both pointers are same, returning no avail\n");
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;
227 pr_debug("ret avail as %lld\n", avail->avail);
231 static inline size_t snd_compr_get_avail(struct snd_compr_stream *stream)
233 struct snd_compr_avail avail;
235 return snd_compr_calc_avail(stream, &avail);
239 snd_compr_ioctl_avail(struct snd_compr_stream *stream, unsigned long arg)
241 struct snd_compr_avail ioctl_avail;
244 avail = snd_compr_calc_avail(stream, &ioctl_avail);
245 ioctl_avail.avail = avail;
247 switch (stream->runtime->state) {
248 case SNDRV_PCM_STATE_OPEN:
250 case SNDRV_PCM_STATE_XRUN:
256 if (copy_to_user((__u64 __user *)arg,
257 &ioctl_avail, sizeof(ioctl_avail)))
262 static int snd_compr_write_data(struct snd_compr_stream *stream,
263 const char __user *buf, size_t count)
267 struct snd_compr_runtime *runtime = stream->runtime;
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);
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))
281 copy = runtime->buffer_size - app_pointer;
282 if (copy_from_user(dstn, buf, copy))
284 if (copy_from_user(runtime->buffer, buf + copy, count - copy))
287 /* if DSP cares, let it know data has been written */
288 if (stream->ops->ack)
289 stream->ops->ack(stream, count);
293 static ssize_t snd_compr_write(struct file *f, const char __user *buf,
294 size_t count, loff_t *offset)
296 struct snd_compr_file *data = f->private_data;
297 struct snd_compr_stream *stream;
301 if (snd_BUG_ON(!data))
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:
313 mutex_unlock(&stream->device->lock);
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 */
323 if (stream->ops->copy) {
324 char __user* cbuf = (char __user*)buf;
325 retval = stream->ops->copy(stream, cbuf, avail);
327 retval = snd_compr_write_data(stream, buf, avail);
330 stream->runtime->total_bytes_available += retval;
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");
339 mutex_unlock(&stream->device->lock);
344 static ssize_t snd_compr_read(struct file *f, char __user *buf,
345 size_t count, loff_t *offset)
347 struct snd_compr_file *data = f->private_data;
348 struct snd_compr_stream *stream;
352 if (snd_BUG_ON(!data))
355 stream = &data->stream;
356 mutex_lock(&stream->device->lock);
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)
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:
369 case SNDRV_PCM_STATE_XRUN:
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 */
380 if (stream->ops->copy) {
381 retval = stream->ops->copy(stream, buf, avail);
387 stream->runtime->total_bytes_transferred += retval;
390 mutex_unlock(&stream->device->lock);
394 static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
399 static __poll_t snd_compr_get_poll(struct snd_compr_stream *stream)
401 if (stream->direction == SND_COMPRESS_PLAYBACK)
402 return EPOLLOUT | EPOLLWRNORM;
404 return EPOLLIN | EPOLLRDNORM;
407 static __poll_t snd_compr_poll(struct file *f, poll_table *wait)
409 struct snd_compr_file *data = f->private_data;
410 struct snd_compr_stream *stream;
414 if (snd_BUG_ON(!data))
417 stream = &data->stream;
419 mutex_lock(&stream->device->lock);
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;
430 poll_wait(f, &stream->runtime->sleep, wait);
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
440 retval = snd_compr_get_poll(stream);
441 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
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);
450 retval = snd_compr_get_poll(stream) | EPOLLERR;
454 mutex_unlock(&stream->device->lock);
459 snd_compr_get_caps(struct snd_compr_stream *stream, unsigned long arg)
462 struct snd_compr_caps caps;
464 if (!stream->ops->get_caps)
467 memset(&caps, 0, sizeof(caps));
468 retval = stream->ops->get_caps(stream, &caps);
471 if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
477 #ifndef COMPR_CODEC_CAPS_OVERFLOW
479 snd_compr_get_codec_caps(struct snd_compr_stream *stream, unsigned long arg)
482 struct snd_compr_codec_caps *caps;
484 if (!stream->ops->get_codec_caps)
487 caps = kzalloc(sizeof(*caps), GFP_KERNEL);
491 retval = stream->ops->get_codec_caps(stream, caps);
494 if (copy_to_user((void __user *)arg, caps, sizeof(*caps)))
501 #endif /* !COMPR_CODEC_CAPS_OVERFLOW */
503 /* revisit this with snd_pcm_preallocate_xxx */
504 static int snd_compr_allocate_buffer(struct snd_compr_stream *stream,
505 struct snd_compr_params *params)
507 unsigned int buffer_size;
510 buffer_size = params->buffer.fragment_size * params->buffer.fragments;
511 if (stream->ops->copy) {
513 /* if copy is defined the driver will be required to copy
517 buffer = kmalloc(buffer_size, GFP_KERNEL);
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;
528 static int snd_compress_check_input(struct snd_compr_params *params)
530 /* first let's check the buffer parameter's */
531 if (params->buffer.fragment_size == 0 ||
532 params->buffer.fragments > U32_MAX / params->buffer.fragment_size ||
533 params->buffer.fragments == 0)
536 /* now codec parameters */
537 if (params->codec.id == 0 || params->codec.id > SND_AUDIOCODEC_MAX)
540 if (params->codec.ch_in == 0 || params->codec.ch_out == 0)
547 snd_compr_set_params(struct snd_compr_stream *stream, unsigned long arg)
549 struct snd_compr_params *params;
552 if (stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
554 * we should allow parameter change only when stream has been
555 * opened not in other cases
557 params = memdup_user((void __user *)arg, sizeof(*params));
559 return PTR_ERR(params);
561 retval = snd_compress_check_input(params);
565 retval = snd_compr_allocate_buffer(stream, params);
571 retval = stream->ops->set_params(stream, params);
575 stream->metadata_set = false;
576 stream->next_track = false;
578 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
588 snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
590 struct snd_codec *params;
593 if (!stream->ops->get_params)
596 params = kzalloc(sizeof(*params), GFP_KERNEL);
599 retval = stream->ops->get_params(stream, params);
602 if (copy_to_user((char __user *)arg, params, sizeof(*params)))
611 snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
613 struct snd_compr_metadata metadata;
616 if (!stream->ops->get_metadata)
619 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
622 retval = stream->ops->get_metadata(stream, &metadata);
626 if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
633 snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
635 struct snd_compr_metadata metadata;
638 if (!stream->ops->set_metadata)
641 * we should allow parameter change only when stream has been
642 * opened not in other cases
644 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
647 retval = stream->ops->set_metadata(stream, &metadata);
648 stream->metadata_set = true;
654 snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
656 struct snd_compr_tstamp tstamp = {0};
659 ret = snd_compr_update_tstamp(stream, &tstamp);
661 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
662 &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
666 static int snd_compr_pause(struct snd_compr_stream *stream)
670 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
672 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
674 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
678 static int snd_compr_resume(struct snd_compr_stream *stream)
682 if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
684 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
686 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
690 static int snd_compr_start(struct snd_compr_stream *stream)
694 switch (stream->runtime->state) {
695 case SNDRV_PCM_STATE_SETUP:
696 if (stream->direction != SND_COMPRESS_CAPTURE)
699 case SNDRV_PCM_STATE_PREPARED:
705 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
707 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
711 static int snd_compr_stop(struct snd_compr_stream *stream)
715 switch (stream->runtime->state) {
716 case SNDRV_PCM_STATE_OPEN:
717 case SNDRV_PCM_STATE_SETUP:
718 case SNDRV_PCM_STATE_PREPARED:
724 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
726 /* clear flags and stop any drain wait */
727 stream->partial_drain = false;
728 stream->metadata_set = false;
729 snd_compr_drain_notify(stream);
730 stream->runtime->total_bytes_available = 0;
731 stream->runtime->total_bytes_transferred = 0;
736 static void error_delayed_work(struct work_struct *work)
738 struct snd_compr_stream *stream;
740 stream = container_of(work, struct snd_compr_stream, error_work.work);
742 mutex_lock(&stream->device->lock);
744 stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
745 wake_up(&stream->runtime->sleep);
747 mutex_unlock(&stream->device->lock);
751 * snd_compr_stop_error: Report a fatal error on a stream
752 * @stream: pointer to stream
753 * @state: state to transition the stream to
755 * Stop the stream and set its state.
757 * Should be called with compressed device lock held.
759 int snd_compr_stop_error(struct snd_compr_stream *stream,
760 snd_pcm_state_t state)
762 if (stream->runtime->state == state)
765 stream->runtime->state = state;
767 pr_debug("Changing state to: %d\n", state);
769 queue_delayed_work(system_power_efficient_wq, &stream->error_work, 0);
773 EXPORT_SYMBOL_GPL(snd_compr_stop_error);
775 static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
780 * We are called with lock held. So drop the lock while we wait for
781 * drain complete notification from the driver
783 * It is expected that driver will notify the drain completion and then
784 * stream will be moved to SETUP state, even if draining resulted in an
785 * error. We can trigger next track after this.
787 stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
788 mutex_unlock(&stream->device->lock);
790 /* we wait for drain to complete here, drain can return when
791 * interruption occurred, wait returned error or success.
792 * For the first two cases we don't do anything different here and
793 * return after waking up
796 ret = wait_event_interruptible(stream->runtime->sleep,
797 (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
798 if (ret == -ERESTARTSYS)
799 pr_debug("wait aborted by a signal\n");
801 pr_debug("wait for drain failed with %d\n", ret);
804 wake_up(&stream->runtime->sleep);
805 mutex_lock(&stream->device->lock);
810 static int snd_compr_drain(struct snd_compr_stream *stream)
814 switch (stream->runtime->state) {
815 case SNDRV_PCM_STATE_OPEN:
816 case SNDRV_PCM_STATE_SETUP:
817 case SNDRV_PCM_STATE_PREPARED:
818 case SNDRV_PCM_STATE_PAUSED:
820 case SNDRV_PCM_STATE_XRUN:
826 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
828 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
829 wake_up(&stream->runtime->sleep);
833 return snd_compress_wait_for_drain(stream);
836 static int snd_compr_next_track(struct snd_compr_stream *stream)
840 /* only a running stream can transition to next track */
841 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
844 /* next track doesn't have any meaning for capture streams */
845 if (stream->direction == SND_COMPRESS_CAPTURE)
848 /* you can signal next track if this is intended to be a gapless stream
849 * and current track metadata is set
851 if (stream->metadata_set == false)
854 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
857 stream->metadata_set = false;
858 stream->next_track = true;
862 static int snd_compr_partial_drain(struct snd_compr_stream *stream)
866 switch (stream->runtime->state) {
867 case SNDRV_PCM_STATE_OPEN:
868 case SNDRV_PCM_STATE_SETUP:
869 case SNDRV_PCM_STATE_PREPARED:
870 case SNDRV_PCM_STATE_PAUSED:
872 case SNDRV_PCM_STATE_XRUN:
878 /* partial drain doesn't have any meaning for capture streams */
879 if (stream->direction == SND_COMPRESS_CAPTURE)
882 /* stream can be drained only when next track has been signalled */
883 if (stream->next_track == false)
886 stream->partial_drain = true;
887 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
889 pr_debug("Partial drain returned failure\n");
890 wake_up(&stream->runtime->sleep);
894 stream->next_track = false;
895 return snd_compress_wait_for_drain(stream);
898 static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
900 struct snd_compr_file *data = f->private_data;
901 struct snd_compr_stream *stream;
902 int retval = -ENOTTY;
904 if (snd_BUG_ON(!data))
907 stream = &data->stream;
909 mutex_lock(&stream->device->lock);
910 switch (_IOC_NR(cmd)) {
911 case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
912 retval = put_user(SNDRV_COMPRESS_VERSION,
913 (int __user *)arg) ? -EFAULT : 0;
915 case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
916 retval = snd_compr_get_caps(stream, arg);
918 #ifndef COMPR_CODEC_CAPS_OVERFLOW
919 case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
920 retval = snd_compr_get_codec_caps(stream, arg);
923 case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
924 retval = snd_compr_set_params(stream, arg);
926 case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
927 retval = snd_compr_get_params(stream, arg);
929 case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
930 retval = snd_compr_set_metadata(stream, arg);
932 case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
933 retval = snd_compr_get_metadata(stream, arg);
935 case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
936 retval = snd_compr_tstamp(stream, arg);
938 case _IOC_NR(SNDRV_COMPRESS_AVAIL):
939 retval = snd_compr_ioctl_avail(stream, arg);
941 case _IOC_NR(SNDRV_COMPRESS_PAUSE):
942 retval = snd_compr_pause(stream);
944 case _IOC_NR(SNDRV_COMPRESS_RESUME):
945 retval = snd_compr_resume(stream);
947 case _IOC_NR(SNDRV_COMPRESS_START):
948 retval = snd_compr_start(stream);
950 case _IOC_NR(SNDRV_COMPRESS_STOP):
951 retval = snd_compr_stop(stream);
953 case _IOC_NR(SNDRV_COMPRESS_DRAIN):
954 retval = snd_compr_drain(stream);
956 case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
957 retval = snd_compr_partial_drain(stream);
959 case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
960 retval = snd_compr_next_track(stream);
964 mutex_unlock(&stream->device->lock);
968 /* support of 32bit userspace on 64bit platforms */
970 static long snd_compr_ioctl_compat(struct file *file, unsigned int cmd,
973 return snd_compr_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
977 static const struct file_operations snd_compr_file_ops = {
978 .owner = THIS_MODULE,
979 .open = snd_compr_open,
980 .release = snd_compr_free,
981 .write = snd_compr_write,
982 .read = snd_compr_read,
983 .unlocked_ioctl = snd_compr_ioctl,
985 .compat_ioctl = snd_compr_ioctl_compat,
987 .mmap = snd_compr_mmap,
988 .poll = snd_compr_poll,
991 static int snd_compress_dev_register(struct snd_device *device)
994 struct snd_compr *compr;
996 if (snd_BUG_ON(!device || !device->device_data))
998 compr = device->device_data;
1000 pr_debug("reg device %s, direction %d\n", compr->name,
1002 /* register compressed device */
1003 ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS,
1004 compr->card, compr->device,
1005 &snd_compr_file_ops, compr, &compr->dev);
1007 pr_err("snd_register_device failed %d\n", ret);
1014 static int snd_compress_dev_disconnect(struct snd_device *device)
1016 struct snd_compr *compr;
1018 compr = device->device_data;
1019 snd_unregister_device(&compr->dev);
1023 #ifdef CONFIG_SND_VERBOSE_PROCFS
1024 static void snd_compress_proc_info_read(struct snd_info_entry *entry,
1025 struct snd_info_buffer *buffer)
1027 struct snd_compr *compr = (struct snd_compr *)entry->private_data;
1029 snd_iprintf(buffer, "card: %d\n", compr->card->number);
1030 snd_iprintf(buffer, "device: %d\n", compr->device);
1031 snd_iprintf(buffer, "stream: %s\n",
1032 compr->direction == SND_COMPRESS_PLAYBACK
1033 ? "PLAYBACK" : "CAPTURE");
1034 snd_iprintf(buffer, "id: %s\n", compr->id);
1037 static int snd_compress_proc_init(struct snd_compr *compr)
1039 struct snd_info_entry *entry;
1042 sprintf(name, "compr%i", compr->device);
1043 entry = snd_info_create_card_entry(compr->card, name,
1044 compr->card->proc_root);
1047 entry->mode = S_IFDIR | 0555;
1048 if (snd_info_register(entry) < 0) {
1049 snd_info_free_entry(entry);
1052 compr->proc_root = entry;
1054 entry = snd_info_create_card_entry(compr->card, "info",
1057 snd_info_set_text_ops(entry, compr,
1058 snd_compress_proc_info_read);
1059 if (snd_info_register(entry) < 0) {
1060 snd_info_free_entry(entry);
1064 compr->proc_info_entry = entry;
1069 static void snd_compress_proc_done(struct snd_compr *compr)
1071 snd_info_free_entry(compr->proc_info_entry);
1072 compr->proc_info_entry = NULL;
1073 snd_info_free_entry(compr->proc_root);
1074 compr->proc_root = NULL;
1077 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1079 strlcpy(compr->id, id, sizeof(compr->id));
1082 static inline int snd_compress_proc_init(struct snd_compr *compr)
1087 static inline void snd_compress_proc_done(struct snd_compr *compr)
1091 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1096 static int snd_compress_dev_free(struct snd_device *device)
1098 struct snd_compr *compr;
1100 compr = device->device_data;
1101 snd_compress_proc_done(compr);
1102 put_device(&compr->dev);
1107 * snd_compress_new: create new compress device
1108 * @card: sound card pointer
1109 * @device: device number
1110 * @dirn: device direction, should be of type enum snd_compr_direction
1111 * @compr: compress device pointer
1113 int snd_compress_new(struct snd_card *card, int device,
1114 int dirn, const char *id, struct snd_compr *compr)
1116 static struct snd_device_ops ops = {
1117 .dev_free = snd_compress_dev_free,
1118 .dev_register = snd_compress_dev_register,
1119 .dev_disconnect = snd_compress_dev_disconnect,
1124 compr->device = device;
1125 compr->direction = dirn;
1127 snd_compress_set_id(compr, id);
1129 snd_device_initialize(&compr->dev, card);
1130 dev_set_name(&compr->dev, "comprC%iD%i", card->number, device);
1132 ret = snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
1134 snd_compress_proc_init(compr);
1138 EXPORT_SYMBOL_GPL(snd_compress_new);
1140 static int snd_compress_add_device(struct snd_compr *device)
1147 /* register the card */
1148 ret = snd_card_register(device->card);
1154 pr_err("failed with %d\n", ret);
1159 static int snd_compress_remove_device(struct snd_compr *device)
1161 return snd_card_free(device->card);
1165 * snd_compress_register - register compressed device
1167 * @device: compressed device to register
1169 int snd_compress_register(struct snd_compr *device)
1173 if (device->name == NULL || device->ops == NULL)
1176 pr_debug("Registering compressed device %s\n", device->name);
1177 if (snd_BUG_ON(!device->ops->open))
1179 if (snd_BUG_ON(!device->ops->free))
1181 if (snd_BUG_ON(!device->ops->set_params))
1183 if (snd_BUG_ON(!device->ops->trigger))
1186 mutex_init(&device->lock);
1188 /* register a compressed card */
1189 mutex_lock(&device_mutex);
1190 retval = snd_compress_add_device(device);
1191 mutex_unlock(&device_mutex);
1194 EXPORT_SYMBOL_GPL(snd_compress_register);
1196 int snd_compress_deregister(struct snd_compr *device)
1198 pr_debug("Removing compressed device %s\n", device->name);
1199 mutex_lock(&device_mutex);
1200 snd_compress_remove_device(device);
1201 mutex_unlock(&device_mutex);
1204 EXPORT_SYMBOL_GPL(snd_compress_deregister);
1206 MODULE_DESCRIPTION("ALSA Compressed offload framework");
1207 MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
1208 MODULE_LICENSE("GPL v2");