projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
btrfs: don't assume compressed_bio sums to be 4 bytes
[linux-2.6-block.git] / sound / core / compress_offload.c
CommitLineData
873e65bc 1// SPDX-License-Identifier: GPL-2.0-only
b21c60a4
VK		 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 *
b21c60a4 10 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
b21c60a4
VK		 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>
f0283b58 18#include <linux/math64.h>
b21c60a4
VK		 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>
f0283b58 24#include <linux/types.h>
b21c60a4
VK		 25#include <linux/uio.h>
26#include <linux/uaccess.h>
27#include <linux/module.h>
c1036889 28#include <linux/compat.h>
b21c60a4
VK		 29#include <sound/core.h>
30#include <sound/initval.h>
31742724 31#include <sound/info.h>
b21c60a4
VK		 32#include <sound/compress_params.h>
33#include <sound/compress_offload.h>
34#include <sound/compress_driver.h>
35
462b3f16
TI		 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
b21c60a4
VK		 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
a4f2d87c
CK		 57static void error_delayed_work(struct work_struct *work);
58
b21c60a4
VK		 59/*
60 * a note on stream states used:
41eb94fd 61 * we use following states in the compressed core
b21c60a4
VK		 62 * SNDRV_PCM_STATE_OPEN: When stream has been opened.
63 * SNDRV_PCM_STATE_SETUP: When stream has been initialized. This is done by
41eb94fd 64 * calling SNDRV_COMPRESS_SET_PARAMS. Running streams will come to this
b21c60a4 65 * state at stop by calling SNDRV_COMPRESS_STOP, or at end of drain.
862bca5d
VK		 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.
b21c60a4
VK		 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
81cb3246 86 if ((f->f_flags & O_ACCMODE) == O_WRONLY)
b21c60a4 87 dirn = SND_COMPRESS_PLAYBACK;
81cb3246 88 else if ((f->f_flags & O_ACCMODE) == O_RDONLY)
b21c60a4 89 dirn = SND_COMPRESS_CAPTURE;
81cb3246 90 else
b21c60a4 91 return -EINVAL;
b21c60a4
VK		 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");
a0830dbd 106 snd_card_unref(compr->card);
b21c60a4
VK		 107 return -EINVAL;
108 }
109
110 data = kzalloc(sizeof(*data), GFP_KERNEL);
a0830dbd
TI		 111 if (!data) {
112 snd_card_unref(compr->card);
b21c60a4 113 return -ENOMEM;
a0830dbd 114 }
a4f2d87c
CK		 115
116 INIT_DELAYED_WORK(&data->stream.error_work, error_delayed_work);
117
b21c60a4
VK		 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);
a0830dbd 125 snd_card_unref(compr->card);
b21c60a4
VK		 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 }
a0830dbd 139 snd_card_unref(compr->card);
749d3223 140 return ret;
b21c60a4
VK		 141}
142
143static int snd_compr_free(struct inode *inode, struct file *f)
144{
145 struct snd_compr_file *data = f->private_data;
b26d19e4
LG		 146 struct snd_compr_runtime *runtime = data->stream.runtime;
147
a4f2d87c
CK		 148 cancel_delayed_work_sync(&data->stream.error_work);
149
b26d19e4
LG		 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
b21c60a4 160 data->stream.ops->free(&data->stream);
d00f749b
SK		 161 if (!data->stream.runtime->dma_buffer_p)
162 kfree(data->stream.runtime->buffer);
b21c60a4
VK		 163 kfree(data->stream.runtime);
164 kfree(data);
165 return 0;
166}
167
17ac8e5c 168static int snd_compr_update_tstamp(struct snd_compr_stream *stream,
b21c60a4
VK		 169 struct snd_compr_tstamp *tstamp)
170{
171 if (!stream->ops->pointer)
17ac8e5c 172 return -ENOTSUPP;
b21c60a4
VK		 173 stream->ops->pointer(stream, tstamp);
174 pr_debug("dsp consumed till %d total %d bytes\n",
175 tstamp->byte_offset, tstamp->copied_total);
5b1f79f7
CK		 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;
17ac8e5c 180 return 0;
b21c60a4
VK		 181}
182
183static size_t snd_compr_calc_avail(struct snd_compr_stream *stream,
184 struct snd_compr_avail *avail)
185{
17ac8e5c 186 memset(avail, 0, sizeof(*avail));
b21c60a4 187 snd_compr_update_tstamp(stream, &avail->tstamp);
17ac8e5c 188 /* Still need to return avail even if tstamp can't be filled in */
b21c60a4 189
b21c60a4 190 if (stream->runtime->total_bytes_available == 0 &&
5b1f79f7
CK		 191 stream->runtime->state == SNDRV_PCM_STATE_SETUP &&
192 stream->direction == SND_COMPRESS_PLAYBACK) {
b21c60a4
VK		 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) {
5b1f79f7
CK		 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 }
b21c60a4
VK		 208 }
209
5b1f79f7
CK		 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
4c28e32d
CK		 215 pr_debug("ret avail as %lld\n", avail->avail);
216 return avail->avail;
b21c60a4
VK		 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
a4f2d87c
CK		 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
b21c60a4
VK		 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;
f0283b58
CK		 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);
b21c60a4 261
f0283b58 262 dstn = runtime->buffer + app_pointer;
b21c60a4 263 pr_debug("copying %ld at %lld\n",
f0283b58
CK		 264 (unsigned long)count, app_pointer);
265 if (count < runtime->buffer_size - app_pointer) {
b21c60a4
VK		 266 if (copy_from_user(dstn, buf, count))
267 return -EFAULT;
b21c60a4 268 } else {
f0283b58 269 copy = runtime->buffer_size - app_pointer;
b21c60a4
VK		 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;
b21c60a4
VK		 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 */
875f6fff
CK		 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:
b21c60a4
VK		 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
4daf891c
CK		 311 if (stream->ops->copy) {
312 char __user* cbuf = (char __user*)buf;
313 retval = stream->ops->copy(stream, cbuf, avail);
314 } else {
b21c60a4 315 retval = snd_compr_write_data(stream, buf, avail);
4daf891c 316 }
b21c60a4
VK		 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{
49bb6402
CK		 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
75481347
VK		 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:
75481347
VK		 353 case SNDRV_PCM_STATE_SUSPENDED:
354 case SNDRV_PCM_STATE_DISCONNECTED:
49bb6402
CK		 355 retval = -EBADFD;
356 goto out;
a4f2d87c
CK		 357 case SNDRV_PCM_STATE_XRUN:
358 retval = -EPIPE;
359 goto out;
49bb6402
CK		 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;
b21c60a4
VK		 380}
381
382static int snd_compr_mmap(struct file *f, struct vm_area_struct *vma)
383{
384 return -ENXIO;
385}
386
680ef72a 387static __poll_t snd_compr_get_poll(struct snd_compr_stream *stream)
b21c60a4
VK		 388{
389 if (stream->direction == SND_COMPRESS_PLAYBACK)
a9a08845 390 return EPOLLOUT | EPOLLWRNORM;
b21c60a4 391 else
a9a08845 392 return EPOLLIN | EPOLLRDNORM;
b21c60a4
VK		 393}
394
680ef72a 395static __poll_t snd_compr_poll(struct file *f, poll_table *wait)
b21c60a4
VK		 396{
397 struct snd_compr_file *data = f->private_data;
398 struct snd_compr_stream *stream;
399 size_t avail;
680ef72a 400 __poll_t retval = 0;
b21c60a4
VK		 401
402 if (snd_BUG_ON(!data))
a9a08845 403 return EPOLLERR;
5bd05390 404
b21c60a4 405 stream = &data->stream;
b21c60a4
VK		 406
407 mutex_lock(&stream->device->lock);
a4f2d87c
CK		 408
409 switch (stream->runtime->state) {
410 case SNDRV_PCM_STATE_OPEN:
411 case SNDRV_PCM_STATE_XRUN:
a9a08845 412 retval = snd_compr_get_poll(stream) | EPOLLERR;
b21c60a4 413 goto out;
a4f2d87c
CK		 414 default:
415 break;
b21c60a4 416 }
a4f2d87c 417
b21c60a4
VK		 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:
a9a08845 438 retval = snd_compr_get_poll(stream) | EPOLLERR;
b21c60a4
VK		 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
1c62e9f2 455 memset(&caps, 0, sizeof(caps));
b21c60a4
VK		 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
462b3f16 465#ifndef COMPR_CODEC_CAPS_OVERFLOW
b21c60a4
VK		 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
47966e97 475 caps = kzalloc(sizeof(*caps), GFP_KERNEL);
b21c60a4
VK		 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}
462b3f16 489#endif /* !COMPR_CODEC_CAPS_OVERFLOW */
b21c60a4
VK		 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;
d00f749b 496 void *buffer = NULL;
b21c60a4
VK		 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 {
d00f749b
SK		 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
b21c60a4
VK		 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
4dc040a0
VK		 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 ||
678e2b44
DC		 531 params->buffer.fragments > INT_MAX / params->buffer.fragment_size ||
532 params->buffer.fragments == 0)
4dc040a0
VK		 533 return -EINVAL;
534
fb4a9779
VK		 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;
fb4a9779 541
4dc040a0
VK		 542 return 0;
543}
544
b21c60a4
VK		 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 */
c2f14ba7
ME		 556 params = memdup_user((void __user *)arg, sizeof(*params));
557 if (IS_ERR(params))
558 return PTR_ERR(params);
4dc040a0
VK		 559
560 retval = snd_compress_check_input(params);
561 if (retval)
562 goto out;
563
b21c60a4
VK		 564 retval = snd_compr_allocate_buffer(stream, params);
565 if (retval) {
769fab2a
JJ		 566 retval = -ENOMEM;
567 goto out;
b21c60a4 568 }
4dc040a0 569
b21c60a4
VK		 570 retval = stream->ops->set_params(stream, params);
571 if (retval)
572 goto out;
49bb6402 573
9727b490
JK		 574 stream->metadata_set = false;
575 stream->next_track = false;
49bb6402
CK		 576
577 if (stream->direction == SND_COMPRESS_PLAYBACK)
578 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
579 else
580 stream->runtime->state = SNDRV_PCM_STATE_PREPARED;
769fab2a 581 } else {
b21c60a4 582 return -EPERM;
769fab2a 583 }
b21c60a4
VK		 584out:
585 kfree(params);
586 return retval;
587}
588
589static int
590snd_compr_get_params(struct snd_compr_stream *stream, unsigned long arg)
591{
592 struct snd_codec *params;
593 int retval;
594
595 if (!stream->ops->get_params)
596 return -EBADFD;
597
47966e97 598 params = kzalloc(sizeof(*params), GFP_KERNEL);
b21c60a4
VK		 599 if (!params)
600 return -ENOMEM;
601 retval = stream->ops->get_params(stream, params);
602 if (retval)
603 goto out;
604 if (copy_to_user((char __user *)arg, params, sizeof(*params)))
605 retval = -EFAULT;
606
607out:
608 kfree(params);
609 return retval;
610}
611
9727b490
JK		 612static int
613snd_compr_get_metadata(struct snd_compr_stream *stream, unsigned long arg)
614{
615 struct snd_compr_metadata metadata;
616 int retval;
617
618 if (!stream->ops->get_metadata)
619 return -ENXIO;
620
621 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
622 return -EFAULT;
623
624 retval = stream->ops->get_metadata(stream, &metadata);
625 if (retval != 0)
626 return retval;
627
628 if (copy_to_user((void __user *)arg, &metadata, sizeof(metadata)))
629 return -EFAULT;
630
631 return 0;
632}
633
634static int
635snd_compr_set_metadata(struct snd_compr_stream *stream, unsigned long arg)
636{
637 struct snd_compr_metadata metadata;
638 int retval;
639
640 if (!stream->ops->set_metadata)
641 return -ENXIO;
642 /*
643 * we should allow parameter change only when stream has been
644 * opened not in other cases
645 */
646 if (copy_from_user(&metadata, (void __user *)arg, sizeof(metadata)))
647 return -EFAULT;
648
649 retval = stream->ops->set_metadata(stream, &metadata);
650 stream->metadata_set = true;
651
652 return retval;
653}
654
b21c60a4
VK		 655static inline int
656snd_compr_tstamp(struct snd_compr_stream *stream, unsigned long arg)
657{
17ac8e5c
RF		 658 struct snd_compr_tstamp tstamp = {0};
659 int ret;
b21c60a4 660
17ac8e5c
RF		 661 ret = snd_compr_update_tstamp(stream, &tstamp);
662 if (ret == 0)
663 ret = copy_to_user((struct snd_compr_tstamp __user *)arg,
664 &tstamp, sizeof(tstamp)) ? -EFAULT : 0;
665 return ret;
b21c60a4
VK		 666}
667
668static int snd_compr_pause(struct snd_compr_stream *stream)
669{
670 int retval;
671
672 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
673 return -EPERM;
674 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_PUSH);
6b18f793 675 if (!retval)
b21c60a4 676 stream->runtime->state = SNDRV_PCM_STATE_PAUSED;
b21c60a4
VK		 677 return retval;
678}
679
680static int snd_compr_resume(struct snd_compr_stream *stream)
681{
682 int retval;
683
684 if (stream->runtime->state != SNDRV_PCM_STATE_PAUSED)
685 return -EPERM;
686 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
687 if (!retval)
688 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
689 return retval;
690}
691
692static int snd_compr_start(struct snd_compr_stream *stream)
693{
694 int retval;
695
696 if (stream->runtime->state != SNDRV_PCM_STATE_PREPARED)
697 return -EPERM;
698 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_START);
699 if (!retval)
700 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
701 return retval;
702}
703
704static int snd_compr_stop(struct snd_compr_stream *stream)
705{
706 int retval;
707
708 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
709 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
710 return -EPERM;
711 retval = stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
712 if (!retval) {
917f4b5c 713 snd_compr_drain_notify(stream);
8b21460a
VK		 714 stream->runtime->total_bytes_available = 0;
715 stream->runtime->total_bytes_transferred = 0;
b21c60a4
VK		 716 }
717 return retval;
718}
719
a4f2d87c
CK		 720static void error_delayed_work(struct work_struct *work)
721{
722 struct snd_compr_stream *stream;
723
724 stream = container_of(work, struct snd_compr_stream, error_work.work);
725
726 mutex_lock(&stream->device->lock);
727
728 stream->ops->trigger(stream, SNDRV_PCM_TRIGGER_STOP);
729 wake_up(&stream->runtime->sleep);
730
731 mutex_unlock(&stream->device->lock);
732}
733
734/*
735 * snd_compr_stop_error: Report a fatal error on a stream
736 * @stream: pointer to stream
737 * @state: state to transition the stream to
738 *
739 * Stop the stream and set its state.
740 *
741 * Should be called with compressed device lock held.
742 */
743int snd_compr_stop_error(struct snd_compr_stream *stream,
744 snd_pcm_state_t state)
745{
746 if (stream->runtime->state == state)
747 return 0;
748
749 stream->runtime->state = state;
750
751 pr_debug("Changing state to: %d\n", state);
752
753 queue_delayed_work(system_power_efficient_wq, &stream->error_work, 0);
754
755 return 0;
756}
757EXPORT_SYMBOL_GPL(snd_compr_stop_error);
758
917f4b5c
VK		 759static int snd_compress_wait_for_drain(struct snd_compr_stream *stream)
760{
f44f2a54
VK		 761 int ret;
762
917f4b5c
VK		 763 /*
764 * We are called with lock held. So drop the lock while we wait for
cdb1ee3f 765 * drain complete notification from the driver
917f4b5c
VK		 766 *
767 * It is expected that driver will notify the drain completion and then
768 * stream will be moved to SETUP state, even if draining resulted in an
769 * error. We can trigger next track after this.
770 */
771 stream->runtime->state = SNDRV_PCM_STATE_DRAINING;
772 mutex_unlock(&stream->device->lock);
773
f44f2a54
VK		 774 /* we wait for drain to complete here, drain can return when
775 * interruption occurred, wait returned error or success.
776 * For the first two cases we don't do anything different here and
777 * return after waking up
778 */
779
780 ret = wait_event_interruptible(stream->runtime->sleep,
781 (stream->runtime->state != SNDRV_PCM_STATE_DRAINING));
782 if (ret == -ERESTARTSYS)
c5a905d3 783 pr_debug("wait aborted by a signal\n");
f44f2a54
VK		 784 else if (ret)
785 pr_debug("wait for drain failed with %d\n", ret);
786
917f4b5c
VK		 787
788 wake_up(&stream->runtime->sleep);
789 mutex_lock(&stream->device->lock);
790
f44f2a54 791 return ret;
917f4b5c
VK		 792}
793
b21c60a4
VK		 794static int snd_compr_drain(struct snd_compr_stream *stream)
795{
796 int retval;
797
798 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
799 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
800 return -EPERM;
917f4b5c 801
b21c60a4 802 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_DRAIN);
917f4b5c 803 if (retval) {
f44f2a54 804 pr_debug("SND_COMPR_TRIGGER_DRAIN failed %d\n", retval);
b21c60a4 805 wake_up(&stream->runtime->sleep);
917f4b5c 806 return retval;
b21c60a4 807 }
917f4b5c 808
f44f2a54 809 return snd_compress_wait_for_drain(stream);
b21c60a4
VK		 810}
811
9727b490
JK		 812static int snd_compr_next_track(struct snd_compr_stream *stream)
813{
814 int retval;
815
816 /* only a running stream can transition to next track */
817 if (stream->runtime->state != SNDRV_PCM_STATE_RUNNING)
818 return -EPERM;
819
cdb1ee3f 820 /* you can signal next track if this is intended to be a gapless stream
9727b490
JK		 821 * and current track metadata is set
822 */
823 if (stream->metadata_set == false)
824 return -EPERM;
825
826 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_NEXT_TRACK);
827 if (retval != 0)
828 return retval;
829 stream->metadata_set = false;
830 stream->next_track = true;
831 return 0;
832}
833
834static int snd_compr_partial_drain(struct snd_compr_stream *stream)
835{
836 int retval;
837 if (stream->runtime->state == SNDRV_PCM_STATE_PREPARED ||
838 stream->runtime->state == SNDRV_PCM_STATE_SETUP)
839 return -EPERM;
840 /* stream can be drained only when next track has been signalled */
841 if (stream->next_track == false)
842 return -EPERM;
843
844 retval = stream->ops->trigger(stream, SND_COMPR_TRIGGER_PARTIAL_DRAIN);
917f4b5c 845 if (retval) {
f44f2a54 846 pr_debug("Partial drain returned failure\n");
917f4b5c
VK		 847 wake_up(&stream->runtime->sleep);
848 return retval;
849 }
9727b490
JK		 850
851 stream->next_track = false;
917f4b5c 852 return snd_compress_wait_for_drain(stream);
9727b490
JK		 853}
854
b21c60a4
VK		 855static long snd_compr_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
856{
857 struct snd_compr_file *data = f->private_data;
858 struct snd_compr_stream *stream;
859 int retval = -ENOTTY;
860
861 if (snd_BUG_ON(!data))
862 return -EFAULT;
5bd05390 863
b21c60a4 864 stream = &data->stream;
5bd05390 865
b21c60a4
VK		 866 mutex_lock(&stream->device->lock);
867 switch (_IOC_NR(cmd)) {
868 case _IOC_NR(SNDRV_COMPRESS_IOCTL_VERSION):
a8d30608 869 retval = put_user(SNDRV_COMPRESS_VERSION,
b21c60a4
VK		 870 (int __user *)arg) ? -EFAULT : 0;
871 break;
872 case _IOC_NR(SNDRV_COMPRESS_GET_CAPS):
873 retval = snd_compr_get_caps(stream, arg);
874 break;
462b3f16 875#ifndef COMPR_CODEC_CAPS_OVERFLOW
b21c60a4
VK		 876 case _IOC_NR(SNDRV_COMPRESS_GET_CODEC_CAPS):
877 retval = snd_compr_get_codec_caps(stream, arg);
878 break;
462b3f16 879#endif
b21c60a4
VK		 880 case _IOC_NR(SNDRV_COMPRESS_SET_PARAMS):
881 retval = snd_compr_set_params(stream, arg);
882 break;
883 case _IOC_NR(SNDRV_COMPRESS_GET_PARAMS):
884 retval = snd_compr_get_params(stream, arg);
885 break;
9727b490
JK		 886 case _IOC_NR(SNDRV_COMPRESS_SET_METADATA):
887 retval = snd_compr_set_metadata(stream, arg);
888 break;
889 case _IOC_NR(SNDRV_COMPRESS_GET_METADATA):
890 retval = snd_compr_get_metadata(stream, arg);
891 break;
b21c60a4
VK		 892 case _IOC_NR(SNDRV_COMPRESS_TSTAMP):
893 retval = snd_compr_tstamp(stream, arg);
894 break;
895 case _IOC_NR(SNDRV_COMPRESS_AVAIL):
896 retval = snd_compr_ioctl_avail(stream, arg);
897 break;
898 case _IOC_NR(SNDRV_COMPRESS_PAUSE):
899 retval = snd_compr_pause(stream);
900 break;
901 case _IOC_NR(SNDRV_COMPRESS_RESUME):
902 retval = snd_compr_resume(stream);
903 break;
904 case _IOC_NR(SNDRV_COMPRESS_START):
905 retval = snd_compr_start(stream);
906 break;
907 case _IOC_NR(SNDRV_COMPRESS_STOP):
908 retval = snd_compr_stop(stream);
909 break;
910 case _IOC_NR(SNDRV_COMPRESS_DRAIN):
911 retval = snd_compr_drain(stream);
912 break;
9727b490
JK		 913 case _IOC_NR(SNDRV_COMPRESS_PARTIAL_DRAIN):
914 retval = snd_compr_partial_drain(stream);
915 break;
916 case _IOC_NR(SNDRV_COMPRESS_NEXT_TRACK):
917 retval = snd_compr_next_track(stream);
918 break;
919
b21c60a4
VK		 920 }
921 mutex_unlock(&stream->device->lock);
922 return retval;
923}
924
c1036889
RL		 925/* support of 32bit userspace on 64bit platforms */
926#ifdef CONFIG_COMPAT
927static long snd_compr_ioctl_compat(struct file *file, unsigned int cmd,
928 unsigned long arg)
929{
930 return snd_compr_ioctl(file, cmd, (unsigned long)compat_ptr(arg));
931}
932#endif
933
b21c60a4
VK		 934static const struct file_operations snd_compr_file_ops = {
935 .owner = THIS_MODULE,
936 .open = snd_compr_open,
937 .release = snd_compr_free,
938 .write = snd_compr_write,
939 .read = snd_compr_read,
940 .unlocked_ioctl = snd_compr_ioctl,
c1036889
RL		 941#ifdef CONFIG_COMPAT
942 .compat_ioctl = snd_compr_ioctl_compat,
943#endif
b21c60a4
VK		 944 .mmap = snd_compr_mmap,
945 .poll = snd_compr_poll,
946};
947
948static int snd_compress_dev_register(struct snd_device *device)
949{
950 int ret = -EINVAL;
b21c60a4
VK		 951 struct snd_compr *compr;
952
953 if (snd_BUG_ON(!device || !device->device_data))
954 return -EBADFD;
955 compr = device->device_data;
956
a931b9ce 957 pr_debug("reg device %s, direction %d\n", compr->name,
b21c60a4
VK		 958 compr->direction);
959 /* register compressed device */
40a4b263
TI		 960 ret = snd_register_device(SNDRV_DEVICE_TYPE_COMPRESS,
961 compr->card, compr->device,
962 &snd_compr_file_ops, compr, &compr->dev);
b21c60a4 963 if (ret < 0) {
c5a905d3 964 pr_err("snd_register_device failed %d\n", ret);
b21c60a4
VK		 965 return ret;
966 }
967 return ret;
968
969}
970
971static int snd_compress_dev_disconnect(struct snd_device *device)
972{
973 struct snd_compr *compr;
974
975 compr = device->device_data;
40a4b263 976 snd_unregister_device(&compr->dev);
b21c60a4
VK		 977 return 0;
978}
979
31742724
RF		 980#ifdef CONFIG_SND_VERBOSE_PROCFS
981static void snd_compress_proc_info_read(struct snd_info_entry *entry,
982 struct snd_info_buffer *buffer)
983{
984 struct snd_compr *compr = (struct snd_compr *)entry->private_data;
985
986 snd_iprintf(buffer, "card: %d\n", compr->card->number);
987 snd_iprintf(buffer, "device: %d\n", compr->device);
988 snd_iprintf(buffer, "stream: %s\n",
989 compr->direction == SND_COMPRESS_PLAYBACK
990 ? "PLAYBACK" : "CAPTURE");
991 snd_iprintf(buffer, "id: %s\n", compr->id);
992}
993
994static int snd_compress_proc_init(struct snd_compr *compr)
995{
996 struct snd_info_entry *entry;
997 char name[16];
998
999 sprintf(name, "compr%i", compr->device);
1000 entry = snd_info_create_card_entry(compr->card, name,
1001 compr->card->proc_root);
1002 if (!entry)
1003 return -ENOMEM;
6a73cf46 1004 entry->mode = S_IFDIR | 0555;
31742724
RF		 1005 compr->proc_root = entry;
1006
1007 entry = snd_info_create_card_entry(compr->card, "info",
1008 compr->proc_root);
4a471d7c 1009 if (entry)
31742724
RF		 1010 snd_info_set_text_ops(entry, compr,
1011 snd_compress_proc_info_read);
31742724
RF		 1012 compr->proc_info_entry = entry;
1013
1014 return 0;
1015}
1016
1017static void snd_compress_proc_done(struct snd_compr *compr)
1018{
1019 snd_info_free_entry(compr->proc_info_entry);
1020 compr->proc_info_entry = NULL;
1021 snd_info_free_entry(compr->proc_root);
1022 compr->proc_root = NULL;
1023}
e5241a8c
RF		 1024
1025static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1026{
1027 strlcpy(compr->id, id, sizeof(compr->id));
1028}
31742724
RF		 1029#else
1030static inline int snd_compress_proc_init(struct snd_compr *compr)
1031{
1032 return 0;
1033}
1034
1035static inline void snd_compress_proc_done(struct snd_compr *compr)
1036{
1037}
e5241a8c
RF		 1038
1039static inline void snd_compress_set_id(struct snd_compr *compr, const char *id)
1040{
1041}
31742724
RF		 1042#endif
1043
04c5d5a4
TI		 1044static int snd_compress_dev_free(struct snd_device *device)
1045{
1046 struct snd_compr *compr;
1047
1048 compr = device->device_data;
31742724 1049 snd_compress_proc_done(compr);
04c5d5a4
TI		 1050 put_device(&compr->dev);
1051 return 0;
1052}
1053
b21c60a4
VK		 1054/*
1055 * snd_compress_new: create new compress device
1056 * @card: sound card pointer
1057 * @device: device number
1058 * @dirn: device direction, should be of type enum snd_compr_direction
1059 * @compr: compress device pointer
1060 */
1061int snd_compress_new(struct snd_card *card, int device,
e5241a8c 1062 int dirn, const char *id, struct snd_compr *compr)
b21c60a4
VK		 1063{
1064 static struct snd_device_ops ops = {
04c5d5a4 1065 .dev_free = snd_compress_dev_free,
b21c60a4
VK		 1066 .dev_register = snd_compress_dev_register,
1067 .dev_disconnect = snd_compress_dev_disconnect,
1068 };
31742724 1069 int ret;
b21c60a4
VK		 1070
1071 compr->card = card;
1072 compr->device = device;
1073 compr->direction = dirn;
04c5d5a4 1074
e5241a8c
RF		 1075 snd_compress_set_id(compr, id);
1076
04c5d5a4
TI		 1077 snd_device_initialize(&compr->dev, card);
1078 dev_set_name(&compr->dev, "comprC%iD%i", card->number, device);
1079
31742724
RF		 1080 ret = snd_device_new(card, SNDRV_DEV_COMPRESS, compr, &ops);
1081 if (ret == 0)
1082 snd_compress_proc_init(compr);
1083
1084 return ret;
b21c60a4
VK		 1085}
1086EXPORT_SYMBOL_GPL(snd_compress_new);
1087
1088static int snd_compress_add_device(struct snd_compr *device)
1089{
1090 int ret;
1091
1092 if (!device->card)
1093 return -EINVAL;
1094
1095 /* register the card */
1096 ret = snd_card_register(device->card);
1097 if (ret)
1098 goto out;
1099 return 0;
1100
1101out:
1102 pr_err("failed with %d\n", ret);
1103 return ret;
1104
1105}
1106
1107static int snd_compress_remove_device(struct snd_compr *device)
1108{
1109 return snd_card_free(device->card);
1110}
1111
1112/**
1113 * snd_compress_register - register compressed device
1114 *
1115 * @device: compressed device to register
1116 */
1117int snd_compress_register(struct snd_compr *device)
1118{
1119 int retval;
1120
04c5d5a4 1121 if (device->name == NULL || device->ops == NULL)
b21c60a4
VK		 1122 return -EINVAL;
1123
1124 pr_debug("Registering compressed device %s\n", device->name);
1125 if (snd_BUG_ON(!device->ops->open))
1126 return -EINVAL;
1127 if (snd_BUG_ON(!device->ops->free))
1128 return -EINVAL;
1129 if (snd_BUG_ON(!device->ops->set_params))
1130 return -EINVAL;
1131 if (snd_BUG_ON(!device->ops->trigger))
1132 return -EINVAL;
1133
1134 mutex_init(&device->lock);
1135
1136 /* register a compressed card */
1137 mutex_lock(&device_mutex);
1138 retval = snd_compress_add_device(device);
1139 mutex_unlock(&device_mutex);
1140 return retval;
1141}
1142EXPORT_SYMBOL_GPL(snd_compress_register);
1143
1144int snd_compress_deregister(struct snd_compr *device)
1145{
1146 pr_debug("Removing compressed device %s\n", device->name);
1147 mutex_lock(&device_mutex);
1148 snd_compress_remove_device(device);
1149 mutex_unlock(&device_mutex);
1150 return 0;
1151}
1152EXPORT_SYMBOL_GPL(snd_compress_deregister);
1153
b21c60a4
VK		 1154MODULE_DESCRIPTION("ALSA Compressed offload framework");
1155MODULE_AUTHOR("Vinod Koul <vinod.koul@linux.intel.com>");
1156MODULE_LICENSE("GPL v2");
Linux 6.x block layer and io_uring tree(s)