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