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 if (!data->stream.runtime->dma_buffer_p)
175 kfree(data->stream.runtime->buffer);
176 kfree(data->stream.runtime);
181 static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
182 struct snd_compr_tstamp *tstamp)
184 if (!stream->ops->pointer)
186 stream->ops->pointer(stream, tstamp);
187 pr_debug("dsp consumed till %d total %d bytes\n",
188 tstamp->byte_offset, tstamp->copied_total);
189 if (stream->direction == SND_COMPRESS_PLAYBACK)
190 stream->runtime->total_bytes_transferred = tstamp->copied_total;
192 stream->runtime->total_bytes_available = tstamp->copied_total;
196 static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
197 struct snd_compr_avail *avail)
199 memset(avail, 0, sizeof(*avail));
200 snd_compr_update_tstamp(stream, &avail->tstamp);
201 /* Still need to return avail even if tstamp can't be filled in */
203 if (stream->runtime->total_bytes_available == 0 &&
204 stream->runtime->state == SNDRV_PCM_STATE_SETUP &&
205 stream->direction == SND_COMPRESS_PLAYBACK) {
206 pr_debug("detected init and someone forgot to do a write\n");
207 return stream->runtime->buffer_size;
209 pr_debug("app wrote %lld, DSP consumed %lld\n",
210 stream->runtime->total_bytes_available,
211 stream->runtime->total_bytes_transferred);
212 if (stream->runtime->total_bytes_available ==
213 stream->runtime->total_bytes_transferred) {
214 if (stream->direction == SND_COMPRESS_PLAYBACK) {
215 pr_debug("both pointers are same, returning full avail\n");
216 return stream->runtime->buffer_size;
218 pr_debug("both pointers are same, returning no avail\n");
223 avail->avail = stream->runtime->total_bytes_available -
224 stream->runtime->total_bytes_transferred;
225 if (stream->direction == SND_COMPRESS_PLAYBACK)
226 avail->avail = stream->runtime->buffer_size - avail->avail;
228 pr_debug("ret avail as %lld\n", avail->avail);
232 static inline size_t snd_compr_get_avail(struct snd_compr_stream *stream)
234 struct snd_compr_avail avail;
236 return snd_compr_calc_avail(stream, &avail);
240 snd_compr_ioctl_avail(struct snd_compr_stream *stream, unsigned long arg)
242 struct snd_compr_avail ioctl_avail;
245 avail = snd_compr_calc_avail(stream, &ioctl_avail);
246 ioctl_avail.avail = avail;
248 switch (stream->runtime->state) {
249 case SNDRV_PCM_STATE_OPEN:
251 case SNDRV_PCM_STATE_XRUN:
257 if (copy_to_user((__u64 __user *)arg,
258 &ioctl_avail, sizeof(ioctl_avail)))
263 static int snd_compr_write_data(struct snd_compr_stream *stream,
264 const char __user *buf, size_t count)
268 struct snd_compr_runtime *runtime = stream->runtime;
270 u64 app_pointer = div64_u64(runtime->total_bytes_available,
271 runtime->buffer_size);
272 app_pointer = runtime->total_bytes_available -
273 (app_pointer * runtime->buffer_size);
275 dstn = runtime->buffer + app_pointer;
276 pr_debug("copying %ld at %lld\n",
277 (unsigned long)count, app_pointer);
278 if (count < runtime->buffer_size - app_pointer) {
279 if (copy_from_user(dstn, buf, count))
282 copy = runtime->buffer_size - app_pointer;
283 if (copy_from_user(dstn, buf, copy))
285 if (copy_from_user(runtime->buffer, buf + copy, count - copy))
288 /* if DSP cares, let it know data has been written */
289 if (stream->ops->ack)
290 stream->ops->ack(stream, count);
294 static ssize_t snd_compr_write(struct file *f, const char __user *buf,
295 size_t count, loff_t *offset)
297 struct snd_compr_file *data = f->private_data;
298 struct snd_compr_stream *stream;
302 if (snd_BUG_ON(!data))
305 stream = &data->stream;
306 mutex_lock(&stream->device->lock);
307 /* write is allowed when stream is running or has been steup */
308 switch (stream->runtime->state) {
309 case SNDRV_PCM_STATE_SETUP:
310 case SNDRV_PCM_STATE_PREPARED:
311 case SNDRV_PCM_STATE_RUNNING:
314 mutex_unlock(&stream->device->lock);
318 avail = snd_compr_get_avail(stream);
319 pr_debug("avail returned %ld\n", (unsigned long)avail);
320 /* calculate how much we can write to buffer */
324 if (stream->ops->copy) {
325 char __user* cbuf = (char __user*)buf;
326 retval = stream->ops->copy(stream, cbuf, avail);
328 retval = snd_compr_write_data(stream, buf, avail);
331 stream->runtime->total_bytes_available += retval;
333 /* while initiating the stream, write should be called before START
334 * call, so in setup move state */
335 if (stream->runtime->state == SNDRV_PCM_STATE_SETUP) {
336 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
337 pr_debug("stream prepared, Houston we are good to go\n");
340 mutex_unlock(&stream->device->lock);
345 static ssize_t snd_compr_read(struct file *f, char __user *buf,
346 size_t count, loff_t *offset)
348 struct snd_compr_file *data = f->private_data;
349 struct snd_compr_stream *stream;
353 if (snd_BUG_ON(!data))
356 stream = &data->stream;
357 mutex_lock(&stream->device->lock);
359 /* read is allowed when stream is running, paused, draining and setup
360 * (yes setup is state which we transition to after stop, so if user
361 * wants to read data after stop we allow that)
363 switch (stream->runtime->state) {
364 case SNDRV_PCM_STATE_OPEN:
365 case SNDRV_PCM_STATE_PREPARED:
366 case SNDRV_PCM_STATE_SUSPENDED:
367 case SNDRV_PCM_STATE_DISCONNECTED:
370 case SNDRV_PCM_STATE_XRUN:
375 avail = snd_compr_get_avail(stream);
376 pr_debug("avail returned %ld\n", (unsigned long)avail);
377 /* calculate how much we can read from buffer */
381 if (stream->ops->copy) {
382 retval = stream->ops->copy(stream, buf, avail);
388 stream->runtime->total_bytes_transferred += retval;
391 mutex_unlock(&stream->device->lock);
395 static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
400 static __poll_t snd_compr_get_poll(struct snd_compr_stream *stream)
402 if (stream->direction == SND_COMPRESS_PLAYBACK)
403 return EPOLLOUT | EPOLLWRNORM;
405 return EPOLLIN | EPOLLRDNORM;
408 static __poll_t snd_compr_poll(struct file *f, poll_table *wait)
410 struct snd_compr_file *data = f->private_data;
411 struct snd_compr_stream *stream;
415 if (snd_BUG_ON(!data))
418 stream = &data->stream;
420 mutex_lock(&stream->device->lock);
422 switch (stream->runtime->state) {
423 case SNDRV_PCM_STATE_OPEN:
424 case SNDRV_PCM_STATE_XRUN:
425 retval = snd_compr_get_poll(stream) | EPOLLERR;
431 poll_wait(f, &stream->runtime->sleep, wait);
433 avail = snd_compr_get_avail(stream);
434 pr_debug("avail is %ld\n", (unsigned long)avail);
435 /* check if we have at least one fragment to fill */
436 switch (stream->runtime->state) {
437 case SNDRV_PCM_STATE_DRAINING:
438 /* stream has been woken up after drain is complete
439 * draining done so set stream state to stopped
441 retval = snd_compr_get_poll(stream);
442 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
444 case SNDRV_PCM_STATE_RUNNING:
445 case SNDRV_PCM_STATE_PREPARED:
446 case SNDRV_PCM_STATE_PAUSED:
447 if (avail >= stream->runtime->fragment_size)
448 retval = snd_compr_get_poll(stream);
451 retval = snd_compr_get_poll(stream) | EPOLLERR;
455 mutex_unlock(&stream->device->lock);
460 snd_compr_get_caps(struct snd_compr_stream *stream, unsigned long arg)
463 struct snd_compr_caps caps;
465 if (!stream->ops->get_caps)
468 memset(&caps, 0, sizeof(caps));
469 retval = stream->ops->get_caps(stream, &caps);
472 if (copy_to_user((void __user *)arg, &caps, sizeof(caps)))
478 #ifndef COMPR_CODEC_CAPS_OVERFLOW
480 snd_compr_get_codec_caps(struct snd_compr_stream *stream, unsigned long arg)
483 struct snd_compr_codec_caps *caps;
485 if (!stream->ops->get_codec_caps)
488 caps = kzalloc(sizeof(*caps), GFP_KERNEL);
492 retval = stream->ops->get_codec_caps(stream, caps);
495 if (copy_to_user((void __user *)arg, caps, sizeof(*caps)))
502 #endif /* !COMPR_CODEC_CAPS_OVERFLOW */
504 /* revisit this with snd_pcm_preallocate_xxx */
505 static int snd_compr_allocate_buffer(struct snd_compr_stream *stream,
506 struct snd_compr_params *params)
508 unsigned int buffer_size;
511 buffer_size = params->buffer.fragment_size * params->buffer.fragments;
512 if (stream->ops->copy) {
514 /* if copy is defined the driver will be required to copy
518 if (stream->runtime->dma_buffer_p) {
520 if (buffer_size > stream->runtime->dma_buffer_p->bytes)
521 dev_err(&stream->device->dev,
522 "Not enough DMA buffer");
524 buffer = stream->runtime->dma_buffer_p->area;
527 buffer = kmalloc(buffer_size, GFP_KERNEL);
533 stream->runtime->fragment_size = params->buffer.fragment_size;
534 stream->runtime->fragments = params->buffer.fragments;
535 stream->runtime->buffer = buffer;
536 stream->runtime->buffer_size = buffer_size;
540 static int snd_compress_check_input(struct snd_compr_params *params)
542 /* first let's check the buffer parameter's */
543 if (params->buffer.fragment_size == 0 ||
544 params->buffer.fragments > INT_MAX / params->buffer.fragment_size ||
545 params->buffer.fragments == 0)
548 /* now codec parameters */
549 if (params->codec.id == 0 || params->codec.id > SND_AUDIOCODEC_MAX)
552 if (params->codec.ch_in == 0 || params->codec.ch_out == 0)
559 snd_compr_set_params(struct snd_compr_stream *stream, unsigned long arg)
561 struct snd_compr_params *params;
564 if (stream->runtime->state == SNDRV_PCM_STATE_OPEN) {
566 * we should allow parameter change only when stream has been
567 * opened not in other cases
569 params = memdup_user((void __user *)arg, sizeof(*params));
571 return PTR_ERR(params);
573 retval = snd_compress_check_input(params);
577 retval = snd_compr_allocate_buffer(stream, params);
583 retval = stream->ops->set_params(stream, params);
587 stream->metadata_set = false;
588 stream->next_track = false;
590 if (stream->direction == SND_COMPRESS_PLAYBACK)
591 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
593 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
603 snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
605 struct snd_codec *params;
608 if (!stream->ops->get_params)
611 params = kzalloc(sizeof(*params), GFP_KERNEL);
614 retval = stream->ops->get_params(stream, params);
617 if (copy_to_user((char __user *)arg, params, sizeof(*params)))
626 snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
628 struct snd_compr_metadata metadata;
631 if (!stream->ops->get_metadata)
634 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
637 retval = stream->ops->get_metadata(stream, &metadata);
641 if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
648 snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
650 struct snd_compr_metadata metadata;
653 if (!stream->ops->set_metadata)
656 * we should allow parameter change only when stream has been
657 * opened not in other cases
659 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
662 retval = stream->ops->set_metadata(stream, &metadata);
663 stream->metadata_set = true;
669 snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
671 struct snd_compr_tstamp tstamp = {0};
674 ret = snd_compr_update_tstamp(stream, &tstamp);
676 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
677 &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
681 static int snd_compr_pause(struct snd_compr_stream *stream)
685 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
687 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
689 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
693 static int snd_compr_resume(struct snd_compr_stream *stream)
697 if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
699 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
701 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
705 static int snd_compr_start(struct snd_compr_stream *stream)
709 if (stream->runtime->state != SNDRV_PCM_STATE_PREPARED)
711 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
713 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
717 static int snd_compr_stop(struct snd_compr_stream *stream)
721 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
722 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
724 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
726 snd_compr_drain_notify(stream);
727 stream->runtime->total_bytes_available = 0;
728 stream->runtime->total_bytes_transferred = 0;
733 static void error_delayed_work(struct work_struct *work)
735 struct snd_compr_stream *stream;
737 stream = container_of(work, struct snd_compr_stream, error_work.work);
739 mutex_lock(&stream->device->lock);
741 stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
742 wake_up(&stream->runtime->sleep);
744 mutex_unlock(&stream->device->lock);
748 * snd_compr_stop_error: Report a fatal error on a stream
749 * @stream: pointer to stream
750 * @state: state to transition the stream to
752 * Stop the stream and set its state.
754 * Should be called with compressed device lock held.
756 int snd_compr_stop_error(struct snd_compr_stream *stream,
757 snd_pcm_state_t state)
759 if (stream->runtime->state == state)
762 stream->runtime->state = state;
764 pr_debug("Changing state to: %d\n", state);
766 queue_delayed_work(system_power_efficient_wq, &stream->error_work, 0);
770 EXPORT_SYMBOL_GPL(snd_compr_stop_error);
772 static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
777 * We are called with lock held. So drop the lock while we wait for
778 * drain complete notification from the driver
780 * It is expected that driver will notify the drain completion and then
781 * stream will be moved to SETUP state, even if draining resulted in an
782 * error. We can trigger next track after this.
784 stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
785 mutex_unlock(&stream->device->lock);
787 /* we wait for drain to complete here, drain can return when
788 * interruption occurred, wait returned error or success.
789 * For the first two cases we don't do anything different here and
790 * return after waking up
793 ret = wait_event_interruptible(stream->runtime->sleep,
794 (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
795 if (ret == -ERESTARTSYS)
796 pr_debug("wait aborted by a signal\n");
798 pr_debug("wait for drain failed with %d\n", ret);
801 wake_up(&stream->runtime->sleep);
802 mutex_lock(&stream->device->lock);
807 static int snd_compr_drain(struct snd_compr_stream *stream)
811 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
812 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
815 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
817 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
818 wake_up(&stream->runtime->sleep);
822 return snd_compress_wait_for_drain(stream);
825 static int snd_compr_next_track(struct snd_compr_stream *stream)
829 /* only a running stream can transition to next track */
830 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
833 /* you can signal next track if this is intended to be a gapless stream
834 * and current track metadata is set
836 if (stream->metadata_set == false)
839 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
842 stream->metadata_set = false;
843 stream->next_track = true;
847 static int snd_compr_partial_drain(struct snd_compr_stream *stream)
850 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
851 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
853 /* stream can be drained only when next track has been signalled */
854 if (stream->next_track == false)
857 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
859 pr_debug("Partial drain returned failure\n");
860 wake_up(&stream->runtime->sleep);
864 stream->next_track = false;
865 return snd_compress_wait_for_drain(stream);
868 static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
870 struct snd_compr_file *data = f->private_data;
871 struct snd_compr_stream *stream;
872 int retval = -ENOTTY;
874 if (snd_BUG_ON(!data))
877 stream = &data->stream;
879 mutex_lock(&stream->device->lock);
880 switch (_IOC_NR(cmd)) {
881 case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
882 retval = put_user(SNDRV_COMPRESS_VERSION,
883 (int __user *)arg) ? -EFAULT : 0;
885 case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
886 retval = snd_compr_get_caps(stream, arg);
888 #ifndef COMPR_CODEC_CAPS_OVERFLOW
889 case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
890 retval = snd_compr_get_codec_caps(stream, arg);
893 case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
894 retval = snd_compr_set_params(stream, arg);
896 case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
897 retval = snd_compr_get_params(stream, arg);
899 case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
900 retval = snd_compr_set_metadata(stream, arg);
902 case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
903 retval = snd_compr_get_metadata(stream, arg);
905 case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
906 retval = snd_compr_tstamp(stream, arg);
908 case _IOC_NR(SNDRV_COMPRESS_AVAIL):
909 retval = snd_compr_ioctl_avail(stream, arg);
911 case _IOC_NR(SNDRV_COMPRESS_PAUSE):
912 retval = snd_compr_pause(stream);
914 case _IOC_NR(SNDRV_COMPRESS_RESUME):
915 retval = snd_compr_resume(stream);
917 case _IOC_NR(SNDRV_COMPRESS_START):
918 retval = snd_compr_start(stream);
920 case _IOC_NR(SNDRV_COMPRESS_STOP):
921 retval = snd_compr_stop(stream);
923 case _IOC_NR(SNDRV_COMPRESS_DRAIN):
924 retval = snd_compr_drain(stream);
926 case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
927 retval = snd_compr_partial_drain(stream);
929 case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
930 retval = snd_compr_next_track(stream);
934 mutex_unlock(&stream->device->lock);
938 /* support of 32bit userspace on 64bit platforms */
940 static long snd_compr_ioctl_compat(struct file *file, unsigned int cmd,
943 return snd_compr_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
947 static const struct file_operations snd_compr_file_ops = {
948 .owner = THIS_MODULE,
949 .open = snd_compr_open,
950 .release = snd_compr_free,
951 .write = snd_compr_write,
952 .read = snd_compr_read,
953 .unlocked_ioctl = snd_compr_ioctl,
955 .compat_ioctl = snd_compr_ioctl_compat,
957 .mmap = snd_compr_mmap,
958 .poll = snd_compr_poll,
961 static int snd_compress_dev_register(struct snd_device *device)
964 struct snd_compr *compr;
966 if (snd_BUG_ON(!device || !device->device_data))
968 compr = device->device_data;
970 pr_debug("reg device %s, direction %d\n", compr->name,
972 /* register compressed device */
973 ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS,
974 compr->card, compr->device,
975 &snd_compr_file_ops, compr, &compr->dev);
977 pr_err("snd_register_device failed %d\n", ret);
984 static int snd_compress_dev_disconnect(struct snd_device *device)
986 struct snd_compr *compr;
988 compr = device->device_data;
989 snd_unregister_device(&compr->dev);
993 #ifdef CONFIG_SND_VERBOSE_PROCFS
994 static void snd_compress_proc_info_read(struct snd_info_entry *entry,
995 struct snd_info_buffer *buffer)
997 struct snd_compr *compr = (struct snd_compr *)entry->private_data;
999 snd_iprintf(buffer, "card: %d\n", compr->card->number);
1000 snd_iprintf(buffer, "device: %d\n", compr->device);
1001 snd_iprintf(buffer, "stream: %s\n",
1002 compr->direction == SND_COMPRESS_PLAYBACK
1003 ? "PLAYBACK" : "CAPTURE");
1004 snd_iprintf(buffer, "id: %s\n", compr->id);
1007 static int snd_compress_proc_init(struct snd_compr *compr)
1009 struct snd_info_entry *entry;
1012 sprintf(name, "compr%i", compr->device);
1013 entry = snd_info_create_card_entry(compr->card, name,
1014 compr->card->proc_root);
1017 entry->mode = S_IFDIR | 0555;
1018 if (snd_info_register(entry) < 0) {
1019 snd_info_free_entry(entry);
1022 compr->proc_root = entry;
1024 entry = snd_info_create_card_entry(compr->card, "info",
1027 snd_info_set_text_ops(entry, compr,
1028 snd_compress_proc_info_read);
1029 if (snd_info_register(entry) < 0) {
1030 snd_info_free_entry(entry);
1034 compr->proc_info_entry = entry;
1039 static void snd_compress_proc_done(struct snd_compr *compr)
1041 snd_info_free_entry(compr->proc_info_entry);
1042 compr->proc_info_entry = NULL;
1043 snd_info_free_entry(compr->proc_root);
1044 compr->proc_root = NULL;
1047 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1049 strlcpy(compr->id, id, sizeof(compr->id));
1052 static inline int snd_compress_proc_init(struct snd_compr *compr)
1057 static inline void snd_compress_proc_done(struct snd_compr *compr)
1061 static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1066 static int snd_compress_dev_free(struct snd_device *device)
1068 struct snd_compr *compr;
1070 compr = device->device_data;
1071 snd_compress_proc_done(compr);
1072 put_device(&compr->dev);
1077 * snd_compress_new: create new compress device
1078 * @card: sound card pointer
1079 * @device: device number
1080 * @dirn: device direction, should be of type enum snd_compr_direction
1081 * @compr: compress device pointer
1083 int snd_compress_new(struct snd_card *card, int device,
1084 int dirn, const char *id, struct snd_compr *compr)
1086 static struct snd_device_ops ops = {
1087 .dev_free = snd_compress_dev_free,
1088 .dev_register = snd_compress_dev_register,
1089 .dev_disconnect = snd_compress_dev_disconnect,
1094 compr->device = device;
1095 compr->direction = dirn;
1097 snd_compress_set_id(compr, id);
1099 snd_device_initialize(&compr->dev, card);
1100 dev_set_name(&compr->dev, "comprC%iD%i", card->number, device);
1102 ret = snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
1104 snd_compress_proc_init(compr);
1108 EXPORT_SYMBOL_GPL(snd_compress_new);
1110 static int snd_compress_add_device(struct snd_compr *device)
1117 /* register the card */
1118 ret = snd_card_register(device->card);
1124 pr_err("failed with %d\n", ret);
1129 static int snd_compress_remove_device(struct snd_compr *device)
1131 return snd_card_free(device->card);
1135 * snd_compress_register - register compressed device
1137 * @device: compressed device to register
1139 int snd_compress_register(struct snd_compr *device)
1143 if (device->name == NULL || device->ops == NULL)
1146 pr_debug("Registering compressed device %s\n", device->name);
1147 if (snd_BUG_ON(!device->ops->open))
1149 if (snd_BUG_ON(!device->ops->free))
1151 if (snd_BUG_ON(!device->ops->set_params))
1153 if (snd_BUG_ON(!device->ops->trigger))
1156 mutex_init(&device->lock);
1158 /* register a compressed card */
1159 mutex_lock(&device_mutex);
1160 retval = snd_compress_add_device(device);
1161 mutex_unlock(&device_mutex);
1164 EXPORT_SYMBOL_GPL(snd_compress_register);
1166 int snd_compress_deregister(struct snd_compr *device)
1168 pr_debug("Removing compressed device %s\n", device->name);
1169 mutex_lock(&device_mutex);
1170 snd_compress_remove_device(device);
1171 mutex_unlock(&device_mutex);
1174 EXPORT_SYMBOL_GPL(snd_compress_deregister);
1176 MODULE_DESCRIPTION("ALSA Compressed offload framework");
1177 MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
1178 MODULE_LICENSE("GPL v2");