Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 */
6
7#include <linux/mm.h>
8#include <linux/module.h>
9#include <linux/file.h>
10#include <linux/slab.h>
11#include <linux/sched/signal.h>
12#include <linux/time.h>
13#include <linux/pm_qos.h>
14#include <linux/io.h>
15#include <linux/dma-mapping.h>
16#include <sound/core.h>
17#include <sound/control.h>
18#include <sound/info.h>
19#include <sound/pcm.h>
20#include <sound/pcm_params.h>
21#include <sound/timer.h>
22#include <sound/minors.h>
23#include <linux/uio.h>
24#include <linux/delay.h>
25
26#include "pcm_local.h"
27
28#ifdef CONFIG_SND_DEBUG
29#define CREATE_TRACE_POINTS
30#include "pcm_param_trace.h"
31#else
32#define trace_hw_mask_param_enabled() 0
33#define trace_hw_interval_param_enabled() 0
34#define trace_hw_mask_param(substream, type, index, prev, curr)
35#define trace_hw_interval_param(substream, type, index, prev, curr)
36#endif
37
38/*
39 * Compatibility
40 */
41
42struct snd_pcm_hw_params_old {
43 unsigned int flags;
44 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
45 SNDRV_PCM_HW_PARAM_ACCESS + 1];
46 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
47 SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
48 unsigned int rmask;
49 unsigned int cmask;
50 unsigned int info;
51 unsigned int msbits;
52 unsigned int rate_num;
53 unsigned int rate_den;
54 snd_pcm_uframes_t fifo_size;
55 unsigned char reserved[64];
56};
57
58#ifdef CONFIG_SND_SUPPORT_OLD_API
59#define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
60#define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
61
62static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
63 struct snd_pcm_hw_params_old __user * _oparams);
64static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params_old __user * _oparams);
66#endif
67static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
68
69/*
70 *
71 */
72
73static DECLARE_RWSEM(snd_pcm_link_rwsem);
74
75void snd_pcm_group_init(struct snd_pcm_group *group)
76{
77 spin_lock_init(&group->lock);
78 mutex_init(&group->mutex);
79 INIT_LIST_HEAD(&group->substreams);
80 refcount_set(&group->refs, 1);
81}
82
83/* define group lock helpers */
84#define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
85static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
86{ \
87 if (nonatomic) \
88 mutex_ ## mutex_action(&group->mutex); \
89 else \
90 spin_ ## action(&group->lock); \
91}
92
93DEFINE_PCM_GROUP_LOCK(lock, lock);
94DEFINE_PCM_GROUP_LOCK(unlock, unlock);
95DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
96DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
97
98/**
99 * snd_pcm_stream_lock - Lock the PCM stream
100 * @substream: PCM substream
101 *
102 * This locks the PCM stream's spinlock or mutex depending on the nonatomic
103 * flag of the given substream. This also takes the global link rw lock
104 * (or rw sem), too, for avoiding the race with linked streams.
105 */
106void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
107{
108 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
109}
110EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
111
112/**
113 * snd_pcm_stream_lock - Unlock the PCM stream
114 * @substream: PCM substream
115 *
116 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
117 */
118void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
119{
120 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
121}
122EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
123
124/**
125 * snd_pcm_stream_lock_irq - Lock the PCM stream
126 * @substream: PCM substream
127 *
128 * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
129 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
130 * as snd_pcm_stream_lock().
131 */
132void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
133{
134 snd_pcm_group_lock_irq(&substream->self_group,
135 substream->pcm->nonatomic);
136}
137EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
138
139/**
140 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
141 * @substream: PCM substream
142 *
143 * This is a counter-part of snd_pcm_stream_lock_irq().
144 */
145void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
146{
147 snd_pcm_group_unlock_irq(&substream->self_group,
148 substream->pcm->nonatomic);
149}
150EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
151
152unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
153{
154 unsigned long flags = 0;
155 if (substream->pcm->nonatomic)
156 mutex_lock(&substream->self_group.mutex);
157 else
158 spin_lock_irqsave(&substream->self_group.lock, flags);
159 return flags;
160}
161EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
162
163/**
164 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
165 * @substream: PCM substream
166 * @flags: irq flags
167 *
168 * This is a counter-part of snd_pcm_stream_lock_irqsave().
169 */
170void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
171 unsigned long flags)
172{
173 if (substream->pcm->nonatomic)
174 mutex_unlock(&substream->self_group.mutex);
175 else
176 spin_unlock_irqrestore(&substream->self_group.lock, flags);
177}
178EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
179
180int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
181{
182 struct snd_pcm *pcm = substream->pcm;
183 struct snd_pcm_str *pstr = substream->pstr;
184
185 memset(info, 0, sizeof(*info));
186 info->card = pcm->card->number;
187 info->device = pcm->device;
188 info->stream = substream->stream;
189 info->subdevice = substream->number;
190 strlcpy(info->id, pcm->id, sizeof(info->id));
191 strlcpy(info->name, pcm->name, sizeof(info->name));
192 info->dev_class = pcm->dev_class;
193 info->dev_subclass = pcm->dev_subclass;
194 info->subdevices_count = pstr->substream_count;
195 info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
196 strlcpy(info->subname, substream->name, sizeof(info->subname));
197
198 return 0;
199}
200
201int snd_pcm_info_user(struct snd_pcm_substream *substream,
202 struct snd_pcm_info __user * _info)
203{
204 struct snd_pcm_info *info;
205 int err;
206
207 info = kmalloc(sizeof(*info), GFP_KERNEL);
208 if (! info)
209 return -ENOMEM;
210 err = snd_pcm_info(substream, info);
211 if (err >= 0) {
212 if (copy_to_user(_info, info, sizeof(*info)))
213 err = -EFAULT;
214 }
215 kfree(info);
216 return err;
217}
218
219static bool hw_support_mmap(struct snd_pcm_substream *substream)
220{
221 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
222 return false;
223
224 if (substream->ops->mmap ||
225 substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV)
226 return true;
227
228 return dma_can_mmap(substream->dma_buffer.dev.dev);
229}
230
231static int constrain_mask_params(struct snd_pcm_substream *substream,
232 struct snd_pcm_hw_params *params)
233{
234 struct snd_pcm_hw_constraints *constrs =
235 &substream->runtime->hw_constraints;
236 struct snd_mask *m;
237 unsigned int k;
238 struct snd_mask old_mask;
239 int changed;
240
241 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
242 m = hw_param_mask(params, k);
243 if (snd_mask_empty(m))
244 return -EINVAL;
245
246 /* This parameter is not requested to change by a caller. */
247 if (!(params->rmask & (1 << k)))
248 continue;
249
250 if (trace_hw_mask_param_enabled())
251 old_mask = *m;
252
253 changed = snd_mask_refine(m, constrs_mask(constrs, k));
254 if (changed < 0)
255 return changed;
256 if (changed == 0)
257 continue;
258
259 /* Set corresponding flag so that the caller gets it. */
260 trace_hw_mask_param(substream, k, 0, &old_mask, m);
261 params->cmask |= 1 << k;
262 }
263
264 return 0;
265}
266
267static int constrain_interval_params(struct snd_pcm_substream *substream,
268 struct snd_pcm_hw_params *params)
269{
270 struct snd_pcm_hw_constraints *constrs =
271 &substream->runtime->hw_constraints;
272 struct snd_interval *i;
273 unsigned int k;
274 struct snd_interval old_interval;
275 int changed;
276
277 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
278 i = hw_param_interval(params, k);
279 if (snd_interval_empty(i))
280 return -EINVAL;
281
282 /* This parameter is not requested to change by a caller. */
283 if (!(params->rmask & (1 << k)))
284 continue;
285
286 if (trace_hw_interval_param_enabled())
287 old_interval = *i;
288
289 changed = snd_interval_refine(i, constrs_interval(constrs, k));
290 if (changed < 0)
291 return changed;
292 if (changed == 0)
293 continue;
294
295 /* Set corresponding flag so that the caller gets it. */
296 trace_hw_interval_param(substream, k, 0, &old_interval, i);
297 params->cmask |= 1 << k;
298 }
299
300 return 0;
301}
302
303static int constrain_params_by_rules(struct snd_pcm_substream *substream,
304 struct snd_pcm_hw_params *params)
305{
306 struct snd_pcm_hw_constraints *constrs =
307 &substream->runtime->hw_constraints;
308 unsigned int k;
309 unsigned int *rstamps;
310 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
311 unsigned int stamp;
312 struct snd_pcm_hw_rule *r;
313 unsigned int d;
314 struct snd_mask old_mask;
315 struct snd_interval old_interval;
316 bool again;
317 int changed, err = 0;
318
319 /*
320 * Each application of rule has own sequence number.
321 *
322 * Each member of 'rstamps' array represents the sequence number of
323 * recent application of corresponding rule.
324 */
325 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
326 if (!rstamps)
327 return -ENOMEM;
328
329 /*
330 * Each member of 'vstamps' array represents the sequence number of
331 * recent application of rule in which corresponding parameters were
332 * changed.
333 *
334 * In initial state, elements corresponding to parameters requested by
335 * a caller is 1. For unrequested parameters, corresponding members
336 * have 0 so that the parameters are never changed anymore.
337 */
338 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
339 vstamps[k] = (params->rmask & (1 << k)) ? 1 : 0;
340
341 /* Due to the above design, actual sequence number starts at 2. */
342 stamp = 2;
343retry:
344 /* Apply all rules in order. */
345 again = false;
346 for (k = 0; k < constrs->rules_num; k++) {
347 r = &constrs->rules[k];
348
349 /*
350 * Check condition bits of this rule. When the rule has
351 * some condition bits, parameter without the bits is
352 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
353 * is an example of the condition bits.
354 */
355 if (r->cond && !(r->cond & params->flags))
356 continue;
357
358 /*
359 * The 'deps' array includes maximum three dependencies
360 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fourth
361 * member of this array is a sentinel and should be
362 * negative value.
363 *
364 * This rule should be processed in this time when dependent
365 * parameters were changed at former applications of the other
366 * rules.
367 */
368 for (d = 0; r->deps[d] >= 0; d++) {
369 if (vstamps[r->deps[d]] > rstamps[k])
370 break;
371 }
372 if (r->deps[d] < 0)
373 continue;
374
375 if (trace_hw_mask_param_enabled()) {
376 if (hw_is_mask(r->var))
377 old_mask = *hw_param_mask(params, r->var);
378 }
379 if (trace_hw_interval_param_enabled()) {
380 if (hw_is_interval(r->var))
381 old_interval = *hw_param_interval(params, r->var);
382 }
383
384 changed = r->func(params, r);
385 if (changed < 0) {
386 err = changed;
387 goto out;
388 }
389
390 /*
391 * When the parameter is changed, notify it to the caller
392 * by corresponding returned bit, then preparing for next
393 * iteration.
394 */
395 if (changed && r->var >= 0) {
396 if (hw_is_mask(r->var)) {
397 trace_hw_mask_param(substream, r->var,
398 k + 1, &old_mask,
399 hw_param_mask(params, r->var));
400 }
401 if (hw_is_interval(r->var)) {
402 trace_hw_interval_param(substream, r->var,
403 k + 1, &old_interval,
404 hw_param_interval(params, r->var));
405 }
406
407 params->cmask |= (1 << r->var);
408 vstamps[r->var] = stamp;
409 again = true;
410 }
411
412 rstamps[k] = stamp++;
413 }
414
415 /* Iterate to evaluate all rules till no parameters are changed. */
416 if (again)
417 goto retry;
418
419 out:
420 kfree(rstamps);
421 return err;
422}
423
424static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
425 struct snd_pcm_hw_params *params)
426{
427 const struct snd_interval *i;
428 const struct snd_mask *m;
429 int err;
430
431 if (!params->msbits) {
432 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
433 if (snd_interval_single(i))
434 params->msbits = snd_interval_value(i);
435 }
436
437 if (!params->rate_den) {
438 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
439 if (snd_interval_single(i)) {
440 params->rate_num = snd_interval_value(i);
441 params->rate_den = 1;
442 }
443 }
444
445 if (!params->fifo_size) {
446 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
447 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
448 if (snd_mask_single(m) && snd_interval_single(i)) {
449 err = substream->ops->ioctl(substream,
450 SNDRV_PCM_IOCTL1_FIFO_SIZE, params);
451 if (err < 0)
452 return err;
453 }
454 }
455
456 if (!params->info) {
457 params->info = substream->runtime->hw.info;
458 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
459 SNDRV_PCM_INFO_DRAIN_TRIGGER);
460 if (!hw_support_mmap(substream))
461 params->info &= ~(SNDRV_PCM_INFO_MMAP |
462 SNDRV_PCM_INFO_MMAP_VALID);
463 }
464
465 return 0;
466}
467
468int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
469 struct snd_pcm_hw_params *params)
470{
471 int err;
472
473 params->info = 0;
474 params->fifo_size = 0;
475 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
476 params->msbits = 0;
477 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_RATE)) {
478 params->rate_num = 0;
479 params->rate_den = 0;
480 }
481
482 err = constrain_mask_params(substream, params);
483 if (err < 0)
484 return err;
485
486 err = constrain_interval_params(substream, params);
487 if (err < 0)
488 return err;
489
490 err = constrain_params_by_rules(substream, params);
491 if (err < 0)
492 return err;
493
494 params->rmask = 0;
495
496 return 0;
497}
498EXPORT_SYMBOL(snd_pcm_hw_refine);
499
500static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
501 struct snd_pcm_hw_params __user * _params)
502{
503 struct snd_pcm_hw_params *params;
504 int err;
505
506 params = memdup_user(_params, sizeof(*params));
507 if (IS_ERR(params))
508 return PTR_ERR(params);
509
510 err = snd_pcm_hw_refine(substream, params);
511 if (err < 0)
512 goto end;
513
514 err = fixup_unreferenced_params(substream, params);
515 if (err < 0)
516 goto end;
517
518 if (copy_to_user(_params, params, sizeof(*params)))
519 err = -EFAULT;
520end:
521 kfree(params);
522 return err;
523}
524
525static int period_to_usecs(struct snd_pcm_runtime *runtime)
526{
527 int usecs;
528
529 if (! runtime->rate)
530 return -1; /* invalid */
531
532 /* take 75% of period time as the deadline */
533 usecs = (750000 / runtime->rate) * runtime->period_size;
534 usecs += ((750000 % runtime->rate) * runtime->period_size) /
535 runtime->rate;
536
537 return usecs;
538}
539
540static void snd_pcm_set_state(struct snd_pcm_substream *substream, int state)
541{
542 snd_pcm_stream_lock_irq(substream);
543 if (substream->runtime->status->state != SNDRV_PCM_STATE_DISCONNECTED)
544 substream->runtime->status->state = state;
545 snd_pcm_stream_unlock_irq(substream);
546}
547
548static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
549 int event)
550{
551#ifdef CONFIG_SND_PCM_TIMER
552 if (substream->timer)
553 snd_timer_notify(substream->timer, event,
554 &substream->runtime->trigger_tstamp);
555#endif
556}
557
558/**
559 * snd_pcm_hw_param_choose - choose a configuration defined by @params
560 * @pcm: PCM instance
561 * @params: the hw_params instance
562 *
563 * Choose one configuration from configuration space defined by @params.
564 * The configuration chosen is that obtained fixing in this order:
565 * first access, first format, first subformat, min channels,
566 * min rate, min period time, max buffer size, min tick time
567 *
568 * Return: Zero if successful, or a negative error code on failure.
569 */
570static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
571 struct snd_pcm_hw_params *params)
572{
573 static const int vars[] = {
574 SNDRV_PCM_HW_PARAM_ACCESS,
575 SNDRV_PCM_HW_PARAM_FORMAT,
576 SNDRV_PCM_HW_PARAM_SUBFORMAT,
577 SNDRV_PCM_HW_PARAM_CHANNELS,
578 SNDRV_PCM_HW_PARAM_RATE,
579 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
580 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
581 SNDRV_PCM_HW_PARAM_TICK_TIME,
582 -1
583 };
584 const int *v;
585 struct snd_mask old_mask;
586 struct snd_interval old_interval;
587 int changed;
588
589 for (v = vars; *v != -1; v++) {
590 /* Keep old parameter to trace. */
591 if (trace_hw_mask_param_enabled()) {
592 if (hw_is_mask(*v))
593 old_mask = *hw_param_mask(params, *v);
594 }
595 if (trace_hw_interval_param_enabled()) {
596 if (hw_is_interval(*v))
597 old_interval = *hw_param_interval(params, *v);
598 }
599 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
600 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
601 else
602 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
603 if (changed < 0)
604 return changed;
605 if (changed == 0)
606 continue;
607
608 /* Trace the changed parameter. */
609 if (hw_is_mask(*v)) {
610 trace_hw_mask_param(pcm, *v, 0, &old_mask,
611 hw_param_mask(params, *v));
612 }
613 if (hw_is_interval(*v)) {
614 trace_hw_interval_param(pcm, *v, 0, &old_interval,
615 hw_param_interval(params, *v));
616 }
617 }
618
619 return 0;
620}
621
622static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
623 struct snd_pcm_hw_params *params)
624{
625 struct snd_pcm_runtime *runtime;
626 int err, usecs;
627 unsigned int bits;
628 snd_pcm_uframes_t frames;
629
630 if (PCM_RUNTIME_CHECK(substream))
631 return -ENXIO;
632 runtime = substream->runtime;
633 snd_pcm_stream_lock_irq(substream);
634 switch (runtime->status->state) {
635 case SNDRV_PCM_STATE_OPEN:
636 case SNDRV_PCM_STATE_SETUP:
637 case SNDRV_PCM_STATE_PREPARED:
638 break;
639 default:
640 snd_pcm_stream_unlock_irq(substream);
641 return -EBADFD;
642 }
643 snd_pcm_stream_unlock_irq(substream);
644#if IS_ENABLED(CONFIG_SND_PCM_OSS)
645 if (!substream->oss.oss)
646#endif
647 if (atomic_read(&substream->mmap_count))
648 return -EBADFD;
649
650 params->rmask = ~0U;
651 err = snd_pcm_hw_refine(substream, params);
652 if (err < 0)
653 goto _error;
654
655 err = snd_pcm_hw_params_choose(substream, params);
656 if (err < 0)
657 goto _error;
658
659 err = fixup_unreferenced_params(substream, params);
660 if (err < 0)
661 goto _error;
662
663 if (substream->ops->hw_params != NULL) {
664 err = substream->ops->hw_params(substream, params);
665 if (err < 0)
666 goto _error;
667 }
668
669 runtime->access = params_access(params);
670 runtime->format = params_format(params);
671 runtime->subformat = params_subformat(params);
672 runtime->channels = params_channels(params);
673 runtime->rate = params_rate(params);
674 runtime->period_size = params_period_size(params);
675 runtime->periods = params_periods(params);
676 runtime->buffer_size = params_buffer_size(params);
677 runtime->info = params->info;
678 runtime->rate_num = params->rate_num;
679 runtime->rate_den = params->rate_den;
680 runtime->no_period_wakeup =
681 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
682 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
683
684 bits = snd_pcm_format_physical_width(runtime->format);
685 runtime->sample_bits = bits;
686 bits *= runtime->channels;
687 runtime->frame_bits = bits;
688 frames = 1;
689 while (bits % 8 != 0) {
690 bits *= 2;
691 frames *= 2;
692 }
693 runtime->byte_align = bits / 8;
694 runtime->min_align = frames;
695
696 /* Default sw params */
697 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
698 runtime->period_step = 1;
699 runtime->control->avail_min = runtime->period_size;
700 runtime->start_threshold = 1;
701 runtime->stop_threshold = runtime->buffer_size;
702 runtime->silence_threshold = 0;
703 runtime->silence_size = 0;
704 runtime->boundary = runtime->buffer_size;
705 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
706 runtime->boundary *= 2;
707
708 snd_pcm_timer_resolution_change(substream);
709 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
710
711 if (pm_qos_request_active(&substream->latency_pm_qos_req))
712 pm_qos_remove_request(&substream->latency_pm_qos_req);
713 if ((usecs = period_to_usecs(runtime)) >= 0)
714 pm_qos_add_request(&substream->latency_pm_qos_req,
715 PM_QOS_CPU_DMA_LATENCY, usecs);
716 return 0;
717 _error:
718 /* hardware might be unusable from this time,
719 so we force application to retry to set
720 the correct hardware parameter settings */
721 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
722 if (substream->ops->hw_free != NULL)
723 substream->ops->hw_free(substream);
724 return err;
725}
726
727static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
728 struct snd_pcm_hw_params __user * _params)
729{
730 struct snd_pcm_hw_params *params;
731 int err;
732
733 params = memdup_user(_params, sizeof(*params));
734 if (IS_ERR(params))
735 return PTR_ERR(params);
736
737 err = snd_pcm_hw_params(substream, params);
738 if (err < 0)
739 goto end;
740
741 if (copy_to_user(_params, params, sizeof(*params)))
742 err = -EFAULT;
743end:
744 kfree(params);
745 return err;
746}
747
748static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
749{
750 struct snd_pcm_runtime *runtime;
751 int result = 0;
752
753 if (PCM_RUNTIME_CHECK(substream))
754 return -ENXIO;
755 runtime = substream->runtime;
756 snd_pcm_stream_lock_irq(substream);
757 switch (runtime->status->state) {
758 case SNDRV_PCM_STATE_SETUP:
759 case SNDRV_PCM_STATE_PREPARED:
760 break;
761 default:
762 snd_pcm_stream_unlock_irq(substream);
763 return -EBADFD;
764 }
765 snd_pcm_stream_unlock_irq(substream);
766 if (atomic_read(&substream->mmap_count))
767 return -EBADFD;
768 if (substream->ops->hw_free)
769 result = substream->ops->hw_free(substream);
770 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
771 pm_qos_remove_request(&substream->latency_pm_qos_req);
772 return result;
773}
774
775static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
776 struct snd_pcm_sw_params *params)
777{
778 struct snd_pcm_runtime *runtime;
779 int err;
780
781 if (PCM_RUNTIME_CHECK(substream))
782 return -ENXIO;
783 runtime = substream->runtime;
784 snd_pcm_stream_lock_irq(substream);
785 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
786 snd_pcm_stream_unlock_irq(substream);
787 return -EBADFD;
788 }
789 snd_pcm_stream_unlock_irq(substream);
790
791 if (params->tstamp_mode < 0 ||
792 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
793 return -EINVAL;
794 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
795 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
796 return -EINVAL;
797 if (params->avail_min == 0)
798 return -EINVAL;
799 if (params->silence_size >= runtime->boundary) {
800 if (params->silence_threshold != 0)
801 return -EINVAL;
802 } else {
803 if (params->silence_size > params->silence_threshold)
804 return -EINVAL;
805 if (params->silence_threshold > runtime->buffer_size)
806 return -EINVAL;
807 }
808 err = 0;
809 snd_pcm_stream_lock_irq(substream);
810 runtime->tstamp_mode = params->tstamp_mode;
811 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
812 runtime->tstamp_type = params->tstamp_type;
813 runtime->period_step = params->period_step;
814 runtime->control->avail_min = params->avail_min;
815 runtime->start_threshold = params->start_threshold;
816 runtime->stop_threshold = params->stop_threshold;
817 runtime->silence_threshold = params->silence_threshold;
818 runtime->silence_size = params->silence_size;
819 params->boundary = runtime->boundary;
820 if (snd_pcm_running(substream)) {
821 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
822 runtime->silence_size > 0)
823 snd_pcm_playback_silence(substream, ULONG_MAX);
824 err = snd_pcm_update_state(substream, runtime);
825 }
826 snd_pcm_stream_unlock_irq(substream);
827 return err;
828}
829
830static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
831 struct snd_pcm_sw_params __user * _params)
832{
833 struct snd_pcm_sw_params params;
834 int err;
835 if (copy_from_user(¶ms, _params, sizeof(params)))
836 return -EFAULT;
837 err = snd_pcm_sw_params(substream, ¶ms);
838 if (copy_to_user(_params, ¶ms, sizeof(params)))
839 return -EFAULT;
840 return err;
841}
842
843static inline snd_pcm_uframes_t
844snd_pcm_calc_delay(struct snd_pcm_substream *substream)
845{
846 snd_pcm_uframes_t delay;
847
848 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
849 delay = snd_pcm_playback_hw_avail(substream->runtime);
850 else
851 delay = snd_pcm_capture_avail(substream->runtime);
852 return delay + substream->runtime->delay;
853}
854
855int snd_pcm_status(struct snd_pcm_substream *substream,
856 struct snd_pcm_status *status)
857{
858 struct snd_pcm_runtime *runtime = substream->runtime;
859
860 snd_pcm_stream_lock_irq(substream);
861
862 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
863 &runtime->audio_tstamp_config);
864
865 /* backwards compatible behavior */
866 if (runtime->audio_tstamp_config.type_requested ==
867 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
868 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
869 runtime->audio_tstamp_config.type_requested =
870 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
871 else
872 runtime->audio_tstamp_config.type_requested =
873 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
874 runtime->audio_tstamp_report.valid = 0;
875 } else
876 runtime->audio_tstamp_report.valid = 1;
877
878 status->state = runtime->status->state;
879 status->suspended_state = runtime->status->suspended_state;
880 if (status->state == SNDRV_PCM_STATE_OPEN)
881 goto _end;
882 status->trigger_tstamp = runtime->trigger_tstamp;
883 if (snd_pcm_running(substream)) {
884 snd_pcm_update_hw_ptr(substream);
885 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
886 status->tstamp = runtime->status->tstamp;
887 status->driver_tstamp = runtime->driver_tstamp;
888 status->audio_tstamp =
889 runtime->status->audio_tstamp;
890 if (runtime->audio_tstamp_report.valid == 1)
891 /* backwards compatibility, no report provided in COMPAT mode */
892 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
893 &status->audio_tstamp_accuracy,
894 &runtime->audio_tstamp_report);
895
896 goto _tstamp_end;
897 }
898 } else {
899 /* get tstamp only in fallback mode and only if enabled */
900 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
901 snd_pcm_gettime(runtime, &status->tstamp);
902 }
903 _tstamp_end:
904 status->appl_ptr = runtime->control->appl_ptr;
905 status->hw_ptr = runtime->status->hw_ptr;
906 status->avail = snd_pcm_avail(substream);
907 status->delay = snd_pcm_running(substream) ?
908 snd_pcm_calc_delay(substream) : 0;
909 status->avail_max = runtime->avail_max;
910 status->overrange = runtime->overrange;
911 runtime->avail_max = 0;
912 runtime->overrange = 0;
913 _end:
914 snd_pcm_stream_unlock_irq(substream);
915 return 0;
916}
917
918static int snd_pcm_status_user(struct snd_pcm_substream *substream,
919 struct snd_pcm_status __user * _status,
920 bool ext)
921{
922 struct snd_pcm_status status;
923 int res;
924
925 memset(&status, 0, sizeof(status));
926 /*
927 * with extension, parameters are read/write,
928 * get audio_tstamp_data from user,
929 * ignore rest of status structure
930 */
931 if (ext && get_user(status.audio_tstamp_data,
932 (u32 __user *)(&_status->audio_tstamp_data)))
933 return -EFAULT;
934 res = snd_pcm_status(substream, &status);
935 if (res < 0)
936 return res;
937 if (copy_to_user(_status, &status, sizeof(status)))
938 return -EFAULT;
939 return 0;
940}
941
942static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
943 struct snd_pcm_channel_info * info)
944{
945 struct snd_pcm_runtime *runtime;
946 unsigned int channel;
947
948 channel = info->channel;
949 runtime = substream->runtime;
950 snd_pcm_stream_lock_irq(substream);
951 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
952 snd_pcm_stream_unlock_irq(substream);
953 return -EBADFD;
954 }
955 snd_pcm_stream_unlock_irq(substream);
956 if (channel >= runtime->channels)
957 return -EINVAL;
958 memset(info, 0, sizeof(*info));
959 info->channel = channel;
960 return substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
961}
962
963static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
964 struct snd_pcm_channel_info __user * _info)
965{
966 struct snd_pcm_channel_info info;
967 int res;
968
969 if (copy_from_user(&info, _info, sizeof(info)))
970 return -EFAULT;
971 res = snd_pcm_channel_info(substream, &info);
972 if (res < 0)
973 return res;
974 if (copy_to_user(_info, &info, sizeof(info)))
975 return -EFAULT;
976 return 0;
977}
978
979static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
980{
981 struct snd_pcm_runtime *runtime = substream->runtime;
982 if (runtime->trigger_master == NULL)
983 return;
984 if (runtime->trigger_master == substream) {
985 if (!runtime->trigger_tstamp_latched)
986 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
987 } else {
988 snd_pcm_trigger_tstamp(runtime->trigger_master);
989 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
990 }
991 runtime->trigger_master = NULL;
992}
993
994struct action_ops {
995 int (*pre_action)(struct snd_pcm_substream *substream, int state);
996 int (*do_action)(struct snd_pcm_substream *substream, int state);
997 void (*undo_action)(struct snd_pcm_substream *substream, int state);
998 void (*post_action)(struct snd_pcm_substream *substream, int state);
999};
1000
1001/*
1002 * this functions is core for handling of linked stream
1003 * Note: the stream state might be changed also on failure
1004 * Note2: call with calling stream lock + link lock
1005 */
1006static int snd_pcm_action_group(const struct action_ops *ops,
1007 struct snd_pcm_substream *substream,
1008 int state, int do_lock)
1009{
1010 struct snd_pcm_substream *s = NULL;
1011 struct snd_pcm_substream *s1;
1012 int res = 0, depth = 1;
1013
1014 snd_pcm_group_for_each_entry(s, substream) {
1015 if (do_lock && s != substream) {
1016 if (s->pcm->nonatomic)
1017 mutex_lock_nested(&s->self_group.mutex, depth);
1018 else
1019 spin_lock_nested(&s->self_group.lock, depth);
1020 depth++;
1021 }
1022 res = ops->pre_action(s, state);
1023 if (res < 0)
1024 goto _unlock;
1025 }
1026 snd_pcm_group_for_each_entry(s, substream) {
1027 res = ops->do_action(s, state);
1028 if (res < 0) {
1029 if (ops->undo_action) {
1030 snd_pcm_group_for_each_entry(s1, substream) {
1031 if (s1 == s) /* failed stream */
1032 break;
1033 ops->undo_action(s1, state);
1034 }
1035 }
1036 s = NULL; /* unlock all */
1037 goto _unlock;
1038 }
1039 }
1040 snd_pcm_group_for_each_entry(s, substream) {
1041 ops->post_action(s, state);
1042 }
1043 _unlock:
1044 if (do_lock) {
1045 /* unlock streams */
1046 snd_pcm_group_for_each_entry(s1, substream) {
1047 if (s1 != substream) {
1048 if (s1->pcm->nonatomic)
1049 mutex_unlock(&s1->self_group.mutex);
1050 else
1051 spin_unlock(&s1->self_group.lock);
1052 }
1053 if (s1 == s) /* end */
1054 break;
1055 }
1056 }
1057 return res;
1058}
1059
1060/*
1061 * Note: call with stream lock
1062 */
1063static int snd_pcm_action_single(const struct action_ops *ops,
1064 struct snd_pcm_substream *substream,
1065 int state)
1066{
1067 int res;
1068
1069 res = ops->pre_action(substream, state);
1070 if (res < 0)
1071 return res;
1072 res = ops->do_action(substream, state);
1073 if (res == 0)
1074 ops->post_action(substream, state);
1075 else if (ops->undo_action)
1076 ops->undo_action(substream, state);
1077 return res;
1078}
1079
1080static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1081 struct snd_pcm_group *new_group)
1082{
1083 substream->group = new_group;
1084 list_move(&substream->link_list, &new_group->substreams);
1085}
1086
1087/*
1088 * Unref and unlock the group, but keep the stream lock;
1089 * when the group becomes empty and no longer referred, destroy itself
1090 */
1091static void snd_pcm_group_unref(struct snd_pcm_group *group,
1092 struct snd_pcm_substream *substream)
1093{
1094 bool do_free;
1095
1096 if (!group)
1097 return;
1098 do_free = refcount_dec_and_test(&group->refs);
1099 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1100 if (do_free)
1101 kfree(group);
1102}
1103
1104/*
1105 * Lock the group inside a stream lock and reference it;
1106 * return the locked group object, or NULL if not linked
1107 */
1108static struct snd_pcm_group *
1109snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1110{
1111 bool nonatomic = substream->pcm->nonatomic;
1112 struct snd_pcm_group *group;
1113 bool trylock;
1114
1115 for (;;) {
1116 if (!snd_pcm_stream_linked(substream))
1117 return NULL;
1118 group = substream->group;
1119 /* block freeing the group object */
1120 refcount_inc(&group->refs);
1121
1122 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1123 spin_trylock(&group->lock);
1124 if (trylock)
1125 break; /* OK */
1126
1127 /* re-lock for avoiding ABBA deadlock */
1128 snd_pcm_stream_unlock(substream);
1129 snd_pcm_group_lock(group, nonatomic);
1130 snd_pcm_stream_lock(substream);
1131
1132 /* check the group again; the above opens a small race window */
1133 if (substream->group == group)
1134 break; /* OK */
1135 /* group changed, try again */
1136 snd_pcm_group_unref(group, substream);
1137 }
1138 return group;
1139}
1140
1141/*
1142 * Note: call with stream lock
1143 */
1144static int snd_pcm_action(const struct action_ops *ops,
1145 struct snd_pcm_substream *substream,
1146 int state)
1147{
1148 struct snd_pcm_group *group;
1149 int res;
1150
1151 group = snd_pcm_stream_group_ref(substream);
1152 if (group)
1153 res = snd_pcm_action_group(ops, substream, state, 1);
1154 else
1155 res = snd_pcm_action_single(ops, substream, state);
1156 snd_pcm_group_unref(group, substream);
1157 return res;
1158}
1159
1160/*
1161 * Note: don't use any locks before
1162 */
1163static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1164 struct snd_pcm_substream *substream,
1165 int state)
1166{
1167 int res;
1168
1169 snd_pcm_stream_lock_irq(substream);
1170 res = snd_pcm_action(ops, substream, state);
1171 snd_pcm_stream_unlock_irq(substream);
1172 return res;
1173}
1174
1175/*
1176 */
1177static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1178 struct snd_pcm_substream *substream,
1179 int state)
1180{
1181 int res;
1182
1183 /* Guarantee the group members won't change during non-atomic action */
1184 down_read(&snd_pcm_link_rwsem);
1185 if (snd_pcm_stream_linked(substream))
1186 res = snd_pcm_action_group(ops, substream, state, 0);
1187 else
1188 res = snd_pcm_action_single(ops, substream, state);
1189 up_read(&snd_pcm_link_rwsem);
1190 return res;
1191}
1192
1193/*
1194 * start callbacks
1195 */
1196static int snd_pcm_pre_start(struct snd_pcm_substream *substream, int state)
1197{
1198 struct snd_pcm_runtime *runtime = substream->runtime;
1199 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1200 return -EBADFD;
1201 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1202 !snd_pcm_playback_data(substream))
1203 return -EPIPE;
1204 runtime->trigger_tstamp_latched = false;
1205 runtime->trigger_master = substream;
1206 return 0;
1207}
1208
1209static int snd_pcm_do_start(struct snd_pcm_substream *substream, int state)
1210{
1211 if (substream->runtime->trigger_master != substream)
1212 return 0;
1213 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1214}
1215
1216static void snd_pcm_undo_start(struct snd_pcm_substream *substream, int state)
1217{
1218 if (substream->runtime->trigger_master == substream)
1219 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1220}
1221
1222static void snd_pcm_post_start(struct snd_pcm_substream *substream, int state)
1223{
1224 struct snd_pcm_runtime *runtime = substream->runtime;
1225 snd_pcm_trigger_tstamp(substream);
1226 runtime->hw_ptr_jiffies = jiffies;
1227 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1228 runtime->rate;
1229 runtime->status->state = state;
1230 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1231 runtime->silence_size > 0)
1232 snd_pcm_playback_silence(substream, ULONG_MAX);
1233 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1234}
1235
1236static const struct action_ops snd_pcm_action_start = {
1237 .pre_action = snd_pcm_pre_start,
1238 .do_action = snd_pcm_do_start,
1239 .undo_action = snd_pcm_undo_start,
1240 .post_action = snd_pcm_post_start
1241};
1242
1243/**
1244 * snd_pcm_start - start all linked streams
1245 * @substream: the PCM substream instance
1246 *
1247 * Return: Zero if successful, or a negative error code.
1248 * The stream lock must be acquired before calling this function.
1249 */
1250int snd_pcm_start(struct snd_pcm_substream *substream)
1251{
1252 return snd_pcm_action(&snd_pcm_action_start, substream,
1253 SNDRV_PCM_STATE_RUNNING);
1254}
1255
1256/* take the stream lock and start the streams */
1257static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1258{
1259 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1260 SNDRV_PCM_STATE_RUNNING);
1261}
1262
1263/*
1264 * stop callbacks
1265 */
1266static int snd_pcm_pre_stop(struct snd_pcm_substream *substream, int state)
1267{
1268 struct snd_pcm_runtime *runtime = substream->runtime;
1269 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1270 return -EBADFD;
1271 runtime->trigger_master = substream;
1272 return 0;
1273}
1274
1275static int snd_pcm_do_stop(struct snd_pcm_substream *substream, int state)
1276{
1277 if (substream->runtime->trigger_master == substream &&
1278 snd_pcm_running(substream))
1279 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1280 return 0; /* unconditonally stop all substreams */
1281}
1282
1283static void snd_pcm_post_stop(struct snd_pcm_substream *substream, int state)
1284{
1285 struct snd_pcm_runtime *runtime = substream->runtime;
1286 if (runtime->status->state != state) {
1287 snd_pcm_trigger_tstamp(substream);
1288 runtime->status->state = state;
1289 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1290 }
1291 wake_up(&runtime->sleep);
1292 wake_up(&runtime->tsleep);
1293}
1294
1295static const struct action_ops snd_pcm_action_stop = {
1296 .pre_action = snd_pcm_pre_stop,
1297 .do_action = snd_pcm_do_stop,
1298 .post_action = snd_pcm_post_stop
1299};
1300
1301/**
1302 * snd_pcm_stop - try to stop all running streams in the substream group
1303 * @substream: the PCM substream instance
1304 * @state: PCM state after stopping the stream
1305 *
1306 * The state of each stream is then changed to the given state unconditionally.
1307 *
1308 * Return: Zero if successful, or a negative error code.
1309 */
1310int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1311{
1312 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1313}
1314EXPORT_SYMBOL(snd_pcm_stop);
1315
1316/**
1317 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1318 * @substream: the PCM substream
1319 *
1320 * After stopping, the state is changed to SETUP.
1321 * Unlike snd_pcm_stop(), this affects only the given stream.
1322 *
1323 * Return: Zero if succesful, or a negative error code.
1324 */
1325int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1326{
1327 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1328 SNDRV_PCM_STATE_SETUP);
1329}
1330
1331/**
1332 * snd_pcm_stop_xrun - stop the running streams as XRUN
1333 * @substream: the PCM substream instance
1334 *
1335 * This stops the given running substream (and all linked substreams) as XRUN.
1336 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1337 *
1338 * Return: Zero if successful, or a negative error code.
1339 */
1340int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1341{
1342 unsigned long flags;
1343
1344 snd_pcm_stream_lock_irqsave(substream, flags);
1345 if (substream->runtime && snd_pcm_running(substream))
1346 __snd_pcm_xrun(substream);
1347 snd_pcm_stream_unlock_irqrestore(substream, flags);
1348 return 0;
1349}
1350EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1351
1352/*
1353 * pause callbacks
1354 */
1355static int snd_pcm_pre_pause(struct snd_pcm_substream *substream, int push)
1356{
1357 struct snd_pcm_runtime *runtime = substream->runtime;
1358 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1359 return -ENOSYS;
1360 if (push) {
1361 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1362 return -EBADFD;
1363 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1364 return -EBADFD;
1365 runtime->trigger_master = substream;
1366 return 0;
1367}
1368
1369static int snd_pcm_do_pause(struct snd_pcm_substream *substream, int push)
1370{
1371 if (substream->runtime->trigger_master != substream)
1372 return 0;
1373 /* some drivers might use hw_ptr to recover from the pause -
1374 update the hw_ptr now */
1375 if (push)
1376 snd_pcm_update_hw_ptr(substream);
1377 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1378 * a delta between the current jiffies, this gives a large enough
1379 * delta, effectively to skip the check once.
1380 */
1381 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1382 return substream->ops->trigger(substream,
1383 push ? SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1384 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1385}
1386
1387static void snd_pcm_undo_pause(struct snd_pcm_substream *substream, int push)
1388{
1389 if (substream->runtime->trigger_master == substream)
1390 substream->ops->trigger(substream,
1391 push ? SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1392 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1393}
1394
1395static void snd_pcm_post_pause(struct snd_pcm_substream *substream, int push)
1396{
1397 struct snd_pcm_runtime *runtime = substream->runtime;
1398 snd_pcm_trigger_tstamp(substream);
1399 if (push) {
1400 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
1401 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1402 wake_up(&runtime->sleep);
1403 wake_up(&runtime->tsleep);
1404 } else {
1405 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
1406 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1407 }
1408}
1409
1410static const struct action_ops snd_pcm_action_pause = {
1411 .pre_action = snd_pcm_pre_pause,
1412 .do_action = snd_pcm_do_pause,
1413 .undo_action = snd_pcm_undo_pause,
1414 .post_action = snd_pcm_post_pause
1415};
1416
1417/*
1418 * Push/release the pause for all linked streams.
1419 */
1420static int snd_pcm_pause(struct snd_pcm_substream *substream, int push)
1421{
1422 return snd_pcm_action(&snd_pcm_action_pause, substream, push);
1423}
1424
1425#ifdef CONFIG_PM
1426/* suspend */
1427
1428static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream, int state)
1429{
1430 struct snd_pcm_runtime *runtime = substream->runtime;
1431 switch (runtime->status->state) {
1432 case SNDRV_PCM_STATE_SUSPENDED:
1433 return -EBUSY;
1434 /* unresumable PCM state; return -EBUSY for skipping suspend */
1435 case SNDRV_PCM_STATE_OPEN:
1436 case SNDRV_PCM_STATE_SETUP:
1437 case SNDRV_PCM_STATE_DISCONNECTED:
1438 return -EBUSY;
1439 }
1440 runtime->trigger_master = substream;
1441 return 0;
1442}
1443
1444static int snd_pcm_do_suspend(struct snd_pcm_substream *substream, int state)
1445{
1446 struct snd_pcm_runtime *runtime = substream->runtime;
1447 if (runtime->trigger_master != substream)
1448 return 0;
1449 if (! snd_pcm_running(substream))
1450 return 0;
1451 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1452 return 0; /* suspend unconditionally */
1453}
1454
1455static void snd_pcm_post_suspend(struct snd_pcm_substream *substream, int state)
1456{
1457 struct snd_pcm_runtime *runtime = substream->runtime;
1458 snd_pcm_trigger_tstamp(substream);
1459 runtime->status->suspended_state = runtime->status->state;
1460 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
1461 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1462 wake_up(&runtime->sleep);
1463 wake_up(&runtime->tsleep);
1464}
1465
1466static const struct action_ops snd_pcm_action_suspend = {
1467 .pre_action = snd_pcm_pre_suspend,
1468 .do_action = snd_pcm_do_suspend,
1469 .post_action = snd_pcm_post_suspend
1470};
1471
1472/*
1473 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1474 * @substream: the PCM substream
1475 *
1476 * After this call, all streams are changed to SUSPENDED state.
1477 *
1478 * Return: Zero if successful, or a negative error code.
1479 */
1480static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1481{
1482 int err;
1483 unsigned long flags;
1484
1485 snd_pcm_stream_lock_irqsave(substream, flags);
1486 err = snd_pcm_action(&snd_pcm_action_suspend, substream, 0);
1487 snd_pcm_stream_unlock_irqrestore(substream, flags);
1488 return err;
1489}
1490
1491/**
1492 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1493 * @pcm: the PCM instance
1494 *
1495 * After this call, all streams are changed to SUSPENDED state.
1496 *
1497 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1498 */
1499int snd_pcm_suspend_all(struct snd_pcm *pcm)
1500{
1501 struct snd_pcm_substream *substream;
1502 int stream, err = 0;
1503
1504 if (! pcm)
1505 return 0;
1506
1507 for (stream = 0; stream < 2; stream++) {
1508 for (substream = pcm->streams[stream].substream;
1509 substream; substream = substream->next) {
1510 /* FIXME: the open/close code should lock this as well */
1511 if (substream->runtime == NULL)
1512 continue;
1513
1514 /*
1515 * Skip BE dai link PCM's that are internal and may
1516 * not have their substream ops set.
1517 */
1518 if (!substream->ops)
1519 continue;
1520
1521 err = snd_pcm_suspend(substream);
1522 if (err < 0 && err != -EBUSY)
1523 return err;
1524 }
1525 }
1526 return 0;
1527}
1528EXPORT_SYMBOL(snd_pcm_suspend_all);
1529
1530/* resume */
1531
1532static int snd_pcm_pre_resume(struct snd_pcm_substream *substream, int state)
1533{
1534 struct snd_pcm_runtime *runtime = substream->runtime;
1535 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1536 return -ENOSYS;
1537 runtime->trigger_master = substream;
1538 return 0;
1539}
1540
1541static int snd_pcm_do_resume(struct snd_pcm_substream *substream, int state)
1542{
1543 struct snd_pcm_runtime *runtime = substream->runtime;
1544 if (runtime->trigger_master != substream)
1545 return 0;
1546 /* DMA not running previously? */
1547 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1548 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1549 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1550 return 0;
1551 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1552}
1553
1554static void snd_pcm_undo_resume(struct snd_pcm_substream *substream, int state)
1555{
1556 if (substream->runtime->trigger_master == substream &&
1557 snd_pcm_running(substream))
1558 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1559}
1560
1561static void snd_pcm_post_resume(struct snd_pcm_substream *substream, int state)
1562{
1563 struct snd_pcm_runtime *runtime = substream->runtime;
1564 snd_pcm_trigger_tstamp(substream);
1565 runtime->status->state = runtime->status->suspended_state;
1566 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1567}
1568
1569static const struct action_ops snd_pcm_action_resume = {
1570 .pre_action = snd_pcm_pre_resume,
1571 .do_action = snd_pcm_do_resume,
1572 .undo_action = snd_pcm_undo_resume,
1573 .post_action = snd_pcm_post_resume
1574};
1575
1576static int snd_pcm_resume(struct snd_pcm_substream *substream)
1577{
1578 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream, 0);
1579}
1580
1581#else
1582
1583static int snd_pcm_resume(struct snd_pcm_substream *substream)
1584{
1585 return -ENOSYS;
1586}
1587
1588#endif /* CONFIG_PM */
1589
1590/*
1591 * xrun ioctl
1592 *
1593 * Change the RUNNING stream(s) to XRUN state.
1594 */
1595static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1596{
1597 struct snd_pcm_runtime *runtime = substream->runtime;
1598 int result;
1599
1600 snd_pcm_stream_lock_irq(substream);
1601 switch (runtime->status->state) {
1602 case SNDRV_PCM_STATE_XRUN:
1603 result = 0; /* already there */
1604 break;
1605 case SNDRV_PCM_STATE_RUNNING:
1606 __snd_pcm_xrun(substream);
1607 result = 0;
1608 break;
1609 default:
1610 result = -EBADFD;
1611 }
1612 snd_pcm_stream_unlock_irq(substream);
1613 return result;
1614}
1615
1616/*
1617 * reset ioctl
1618 */
1619static int snd_pcm_pre_reset(struct snd_pcm_substream *substream, int state)
1620{
1621 struct snd_pcm_runtime *runtime = substream->runtime;
1622 switch (runtime->status->state) {
1623 case SNDRV_PCM_STATE_RUNNING:
1624 case SNDRV_PCM_STATE_PREPARED:
1625 case SNDRV_PCM_STATE_PAUSED:
1626 case SNDRV_PCM_STATE_SUSPENDED:
1627 return 0;
1628 default:
1629 return -EBADFD;
1630 }
1631}
1632
1633static int snd_pcm_do_reset(struct snd_pcm_substream *substream, int state)
1634{
1635 struct snd_pcm_runtime *runtime = substream->runtime;
1636 int err = substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1637 if (err < 0)
1638 return err;
1639 runtime->hw_ptr_base = 0;
1640 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1641 runtime->status->hw_ptr % runtime->period_size;
1642 runtime->silence_start = runtime->status->hw_ptr;
1643 runtime->silence_filled = 0;
1644 return 0;
1645}
1646
1647static void snd_pcm_post_reset(struct snd_pcm_substream *substream, int state)
1648{
1649 struct snd_pcm_runtime *runtime = substream->runtime;
1650 runtime->control->appl_ptr = runtime->status->hw_ptr;
1651 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1652 runtime->silence_size > 0)
1653 snd_pcm_playback_silence(substream, ULONG_MAX);
1654}
1655
1656static const struct action_ops snd_pcm_action_reset = {
1657 .pre_action = snd_pcm_pre_reset,
1658 .do_action = snd_pcm_do_reset,
1659 .post_action = snd_pcm_post_reset
1660};
1661
1662static int snd_pcm_reset(struct snd_pcm_substream *substream)
1663{
1664 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream, 0);
1665}
1666
1667/*
1668 * prepare ioctl
1669 */
1670/* we use the second argument for updating f_flags */
1671static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1672 int f_flags)
1673{
1674 struct snd_pcm_runtime *runtime = substream->runtime;
1675 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1676 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1677 return -EBADFD;
1678 if (snd_pcm_running(substream))
1679 return -EBUSY;
1680 substream->f_flags = f_flags;
1681 return 0;
1682}
1683
1684static int snd_pcm_do_prepare(struct snd_pcm_substream *substream, int state)
1685{
1686 int err;
1687 err = substream->ops->prepare(substream);
1688 if (err < 0)
1689 return err;
1690 return snd_pcm_do_reset(substream, 0);
1691}
1692
1693static void snd_pcm_post_prepare(struct snd_pcm_substream *substream, int state)
1694{
1695 struct snd_pcm_runtime *runtime = substream->runtime;
1696 runtime->control->appl_ptr = runtime->status->hw_ptr;
1697 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1698}
1699
1700static const struct action_ops snd_pcm_action_prepare = {
1701 .pre_action = snd_pcm_pre_prepare,
1702 .do_action = snd_pcm_do_prepare,
1703 .post_action = snd_pcm_post_prepare
1704};
1705
1706/**
1707 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1708 * @substream: the PCM substream instance
1709 * @file: file to refer f_flags
1710 *
1711 * Return: Zero if successful, or a negative error code.
1712 */
1713static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1714 struct file *file)
1715{
1716 int f_flags;
1717
1718 if (file)
1719 f_flags = file->f_flags;
1720 else
1721 f_flags = substream->f_flags;
1722
1723 snd_pcm_stream_lock_irq(substream);
1724 switch (substream->runtime->status->state) {
1725 case SNDRV_PCM_STATE_PAUSED:
1726 snd_pcm_pause(substream, 0);
1727 /* fallthru */
1728 case SNDRV_PCM_STATE_SUSPENDED:
1729 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1730 break;
1731 }
1732 snd_pcm_stream_unlock_irq(substream);
1733
1734 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
1735 substream, f_flags);
1736}
1737
1738/*
1739 * drain ioctl
1740 */
1741
1742static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream, int state)
1743{
1744 struct snd_pcm_runtime *runtime = substream->runtime;
1745 switch (runtime->status->state) {
1746 case SNDRV_PCM_STATE_OPEN:
1747 case SNDRV_PCM_STATE_DISCONNECTED:
1748 case SNDRV_PCM_STATE_SUSPENDED:
1749 return -EBADFD;
1750 }
1751 runtime->trigger_master = substream;
1752 return 0;
1753}
1754
1755static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream, int state)
1756{
1757 struct snd_pcm_runtime *runtime = substream->runtime;
1758 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1759 switch (runtime->status->state) {
1760 case SNDRV_PCM_STATE_PREPARED:
1761 /* start playback stream if possible */
1762 if (! snd_pcm_playback_empty(substream)) {
1763 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
1764 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
1765 } else {
1766 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1767 }
1768 break;
1769 case SNDRV_PCM_STATE_RUNNING:
1770 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
1771 break;
1772 case SNDRV_PCM_STATE_XRUN:
1773 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1774 break;
1775 default:
1776 break;
1777 }
1778 } else {
1779 /* stop running stream */
1780 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
1781 int new_state = snd_pcm_capture_avail(runtime) > 0 ?
1782 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
1783 snd_pcm_do_stop(substream, new_state);
1784 snd_pcm_post_stop(substream, new_state);
1785 }
1786 }
1787
1788 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
1789 runtime->trigger_master == substream &&
1790 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
1791 return substream->ops->trigger(substream,
1792 SNDRV_PCM_TRIGGER_DRAIN);
1793
1794 return 0;
1795}
1796
1797static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream, int state)
1798{
1799}
1800
1801static const struct action_ops snd_pcm_action_drain_init = {
1802 .pre_action = snd_pcm_pre_drain_init,
1803 .do_action = snd_pcm_do_drain_init,
1804 .post_action = snd_pcm_post_drain_init
1805};
1806
1807/*
1808 * Drain the stream(s).
1809 * When the substream is linked, sync until the draining of all playback streams
1810 * is finished.
1811 * After this call, all streams are supposed to be either SETUP or DRAINING
1812 * (capture only) state.
1813 */
1814static int snd_pcm_drain(struct snd_pcm_substream *substream,
1815 struct file *file)
1816{
1817 struct snd_card *card;
1818 struct snd_pcm_runtime *runtime;
1819 struct snd_pcm_substream *s;
1820 struct snd_pcm_group *group;
1821 wait_queue_entry_t wait;
1822 int result = 0;
1823 int nonblock = 0;
1824
1825 card = substream->pcm->card;
1826 runtime = substream->runtime;
1827
1828 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1829 return -EBADFD;
1830
1831 if (file) {
1832 if (file->f_flags & O_NONBLOCK)
1833 nonblock = 1;
1834 } else if (substream->f_flags & O_NONBLOCK)
1835 nonblock = 1;
1836
1837 snd_pcm_stream_lock_irq(substream);
1838 /* resume pause */
1839 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1840 snd_pcm_pause(substream, 0);
1841
1842 /* pre-start/stop - all running streams are changed to DRAINING state */
1843 result = snd_pcm_action(&snd_pcm_action_drain_init, substream, 0);
1844 if (result < 0)
1845 goto unlock;
1846 /* in non-blocking, we don't wait in ioctl but let caller poll */
1847 if (nonblock) {
1848 result = -EAGAIN;
1849 goto unlock;
1850 }
1851
1852 for (;;) {
1853 long tout;
1854 struct snd_pcm_runtime *to_check;
1855 if (signal_pending(current)) {
1856 result = -ERESTARTSYS;
1857 break;
1858 }
1859 /* find a substream to drain */
1860 to_check = NULL;
1861 group = snd_pcm_stream_group_ref(substream);
1862 snd_pcm_group_for_each_entry(s, substream) {
1863 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
1864 continue;
1865 runtime = s->runtime;
1866 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
1867 to_check = runtime;
1868 break;
1869 }
1870 }
1871 snd_pcm_group_unref(group, substream);
1872 if (!to_check)
1873 break; /* all drained */
1874 init_waitqueue_entry(&wait, current);
1875 set_current_state(TASK_INTERRUPTIBLE);
1876 add_wait_queue(&to_check->sleep, &wait);
1877 snd_pcm_stream_unlock_irq(substream);
1878 if (runtime->no_period_wakeup)
1879 tout = MAX_SCHEDULE_TIMEOUT;
1880 else {
1881 tout = 10;
1882 if (runtime->rate) {
1883 long t = runtime->period_size * 2 / runtime->rate;
1884 tout = max(t, tout);
1885 }
1886 tout = msecs_to_jiffies(tout * 1000);
1887 }
1888 tout = schedule_timeout(tout);
1889
1890 snd_pcm_stream_lock_irq(substream);
1891 group = snd_pcm_stream_group_ref(substream);
1892 snd_pcm_group_for_each_entry(s, substream) {
1893 if (s->runtime == to_check) {
1894 remove_wait_queue(&to_check->sleep, &wait);
1895 break;
1896 }
1897 }
1898 snd_pcm_group_unref(group, substream);
1899
1900 if (card->shutdown) {
1901 result = -ENODEV;
1902 break;
1903 }
1904 if (tout == 0) {
1905 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
1906 result = -ESTRPIPE;
1907 else {
1908 dev_dbg(substream->pcm->card->dev,
1909 "playback drain error (DMA or IRQ trouble?)\n");
1910 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1911 result = -EIO;
1912 }
1913 break;
1914 }
1915 }
1916
1917 unlock:
1918 snd_pcm_stream_unlock_irq(substream);
1919
1920 return result;
1921}
1922
1923/*
1924 * drop ioctl
1925 *
1926 * Immediately put all linked substreams into SETUP state.
1927 */
1928static int snd_pcm_drop(struct snd_pcm_substream *substream)
1929{
1930 struct snd_pcm_runtime *runtime;
1931 int result = 0;
1932
1933 if (PCM_RUNTIME_CHECK(substream))
1934 return -ENXIO;
1935 runtime = substream->runtime;
1936
1937 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1938 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1939 return -EBADFD;
1940
1941 snd_pcm_stream_lock_irq(substream);
1942 /* resume pause */
1943 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1944 snd_pcm_pause(substream, 0);
1945
1946 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1947 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
1948 snd_pcm_stream_unlock_irq(substream);
1949
1950 return result;
1951}
1952
1953
1954static bool is_pcm_file(struct file *file)
1955{
1956 struct inode *inode = file_inode(file);
1957 struct snd_pcm *pcm;
1958 unsigned int minor;
1959
1960 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
1961 return false;
1962 minor = iminor(inode);
1963 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
1964 if (!pcm)
1965 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
1966 if (!pcm)
1967 return false;
1968 snd_card_unref(pcm->card);
1969 return true;
1970}
1971
1972/*
1973 * PCM link handling
1974 */
1975static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
1976{
1977 int res = 0;
1978 struct snd_pcm_file *pcm_file;
1979 struct snd_pcm_substream *substream1;
1980 struct snd_pcm_group *group, *target_group;
1981 bool nonatomic = substream->pcm->nonatomic;
1982 struct fd f = fdget(fd);
1983
1984 if (!f.file)
1985 return -EBADFD;
1986 if (!is_pcm_file(f.file)) {
1987 res = -EBADFD;
1988 goto _badf;
1989 }
1990 pcm_file = f.file->private_data;
1991 substream1 = pcm_file->substream;
1992 group = kzalloc(sizeof(*group), GFP_KERNEL);
1993 if (!group) {
1994 res = -ENOMEM;
1995 goto _nolock;
1996 }
1997 snd_pcm_group_init(group);
1998
1999 down_write(&snd_pcm_link_rwsem);
2000 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2001 substream->runtime->status->state != substream1->runtime->status->state ||
2002 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2003 res = -EBADFD;
2004 goto _end;
2005 }
2006 if (snd_pcm_stream_linked(substream1)) {
2007 res = -EALREADY;
2008 goto _end;
2009 }
2010
2011 snd_pcm_stream_lock_irq(substream);
2012 if (!snd_pcm_stream_linked(substream)) {
2013 snd_pcm_group_assign(substream, group);
2014 group = NULL; /* assigned, don't free this one below */
2015 }
2016 target_group = substream->group;
2017 snd_pcm_stream_unlock_irq(substream);
2018
2019 snd_pcm_group_lock_irq(target_group, nonatomic);
2020 snd_pcm_stream_lock(substream1);
2021 snd_pcm_group_assign(substream1, target_group);
2022 refcount_inc(&target_group->refs);
2023 snd_pcm_stream_unlock(substream1);
2024 snd_pcm_group_unlock_irq(target_group, nonatomic);
2025 _end:
2026 up_write(&snd_pcm_link_rwsem);
2027 _nolock:
2028 kfree(group);
2029 _badf:
2030 fdput(f);
2031 return res;
2032}
2033
2034static void relink_to_local(struct snd_pcm_substream *substream)
2035{
2036 snd_pcm_stream_lock(substream);
2037 snd_pcm_group_assign(substream, &substream->self_group);
2038 snd_pcm_stream_unlock(substream);
2039}
2040
2041static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2042{
2043 struct snd_pcm_group *group;
2044 bool nonatomic = substream->pcm->nonatomic;
2045 bool do_free = false;
2046 int res = 0;
2047
2048 down_write(&snd_pcm_link_rwsem);
2049
2050 if (!snd_pcm_stream_linked(substream)) {
2051 res = -EALREADY;
2052 goto _end;
2053 }
2054
2055 group = substream->group;
2056 snd_pcm_group_lock_irq(group, nonatomic);
2057
2058 relink_to_local(substream);
2059 refcount_dec(&group->refs);
2060
2061 /* detach the last stream, too */
2062 if (list_is_singular(&group->substreams)) {
2063 relink_to_local(list_first_entry(&group->substreams,
2064 struct snd_pcm_substream,
2065 link_list));
2066 do_free = refcount_dec_and_test(&group->refs);
2067 }
2068
2069 snd_pcm_group_unlock_irq(group, nonatomic);
2070 if (do_free)
2071 kfree(group);
2072
2073 _end:
2074 up_write(&snd_pcm_link_rwsem);
2075 return res;
2076}
2077
2078/*
2079 * hw configurator
2080 */
2081static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2082 struct snd_pcm_hw_rule *rule)
2083{
2084 struct snd_interval t;
2085 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2086 hw_param_interval_c(params, rule->deps[1]), &t);
2087 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2088}
2089
2090static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2091 struct snd_pcm_hw_rule *rule)
2092{
2093 struct snd_interval t;
2094 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2095 hw_param_interval_c(params, rule->deps[1]), &t);
2096 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2097}
2098
2099static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2100 struct snd_pcm_hw_rule *rule)
2101{
2102 struct snd_interval t;
2103 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2104 hw_param_interval_c(params, rule->deps[1]),
2105 (unsigned long) rule->private, &t);
2106 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2107}
2108
2109static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2110 struct snd_pcm_hw_rule *rule)
2111{
2112 struct snd_interval t;
2113 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2114 (unsigned long) rule->private,
2115 hw_param_interval_c(params, rule->deps[1]), &t);
2116 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2117}
2118
2119static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2120 struct snd_pcm_hw_rule *rule)
2121{
2122 unsigned int k;
2123 const struct snd_interval *i =
2124 hw_param_interval_c(params, rule->deps[0]);
2125 struct snd_mask m;
2126 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2127 snd_mask_any(&m);
2128 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2129 int bits;
2130 if (! snd_mask_test(mask, k))
2131 continue;
2132 bits = snd_pcm_format_physical_width(k);
2133 if (bits <= 0)
2134 continue; /* ignore invalid formats */
2135 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2136 snd_mask_reset(&m, k);
2137 }
2138 return snd_mask_refine(mask, &m);
2139}
2140
2141static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2142 struct snd_pcm_hw_rule *rule)
2143{
2144 struct snd_interval t;
2145 unsigned int k;
2146 t.min = UINT_MAX;
2147 t.max = 0;
2148 t.openmin = 0;
2149 t.openmax = 0;
2150 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2151 int bits;
2152 if (! snd_mask_test(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2153 continue;
2154 bits = snd_pcm_format_physical_width(k);
2155 if (bits <= 0)
2156 continue; /* ignore invalid formats */
2157 if (t.min > (unsigned)bits)
2158 t.min = bits;
2159 if (t.max < (unsigned)bits)
2160 t.max = bits;
2161 }
2162 t.integer = 1;
2163 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2164}
2165
2166#if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2167#error "Change this table"
2168#endif
2169
2170static const unsigned int rates[] = {
2171 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2172 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2173};
2174
2175const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2176 .count = ARRAY_SIZE(rates),
2177 .list = rates,
2178};
2179
2180static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2181 struct snd_pcm_hw_rule *rule)
2182{
2183 struct snd_pcm_hardware *hw = rule->private;
2184 return snd_interval_list(hw_param_interval(params, rule->var),
2185 snd_pcm_known_rates.count,
2186 snd_pcm_known_rates.list, hw->rates);
2187}
2188
2189static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2190 struct snd_pcm_hw_rule *rule)
2191{
2192 struct snd_interval t;
2193 struct snd_pcm_substream *substream = rule->private;
2194 t.min = 0;
2195 t.max = substream->buffer_bytes_max;
2196 t.openmin = 0;
2197 t.openmax = 0;
2198 t.integer = 1;
2199 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2200}
2201
2202int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2203{
2204 struct snd_pcm_runtime *runtime = substream->runtime;
2205 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2206 int k, err;
2207
2208 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2209 snd_mask_any(constrs_mask(constrs, k));
2210 }
2211
2212 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2213 snd_interval_any(constrs_interval(constrs, k));
2214 }
2215
2216 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2217 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2218 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2219 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2220 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2221
2222 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2223 snd_pcm_hw_rule_format, NULL,
2224 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2225 if (err < 0)
2226 return err;
2227 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2228 snd_pcm_hw_rule_sample_bits, NULL,
2229 SNDRV_PCM_HW_PARAM_FORMAT,
2230 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2231 if (err < 0)
2232 return err;
2233 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2234 snd_pcm_hw_rule_div, NULL,
2235 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2236 if (err < 0)
2237 return err;
2238 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2239 snd_pcm_hw_rule_mul, NULL,
2240 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2241 if (err < 0)
2242 return err;
2243 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2244 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2245 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2246 if (err < 0)
2247 return err;
2248 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2249 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2250 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2251 if (err < 0)
2252 return err;
2253 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2254 snd_pcm_hw_rule_div, NULL,
2255 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2256 if (err < 0)
2257 return err;
2258 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2259 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2260 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2261 if (err < 0)
2262 return err;
2263 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2264 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2265 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2266 if (err < 0)
2267 return err;
2268 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2269 snd_pcm_hw_rule_div, NULL,
2270 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2271 if (err < 0)
2272 return err;
2273 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2274 snd_pcm_hw_rule_div, NULL,
2275 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2276 if (err < 0)
2277 return err;
2278 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2279 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2280 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2281 if (err < 0)
2282 return err;
2283 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2284 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2285 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2286 if (err < 0)
2287 return err;
2288 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2289 snd_pcm_hw_rule_mul, NULL,
2290 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2291 if (err < 0)
2292 return err;
2293 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2294 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2295 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2296 if (err < 0)
2297 return err;
2298 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2299 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2300 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2301 if (err < 0)
2302 return err;
2303 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2304 snd_pcm_hw_rule_muldivk, (void*) 8,
2305 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2306 if (err < 0)
2307 return err;
2308 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2309 snd_pcm_hw_rule_muldivk, (void*) 8,
2310 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2311 if (err < 0)
2312 return err;
2313 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2314 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2315 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2316 if (err < 0)
2317 return err;
2318 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2319 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2320 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2321 if (err < 0)
2322 return err;
2323 return 0;
2324}
2325
2326int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2327{
2328 struct snd_pcm_runtime *runtime = substream->runtime;
2329 struct snd_pcm_hardware *hw = &runtime->hw;
2330 int err;
2331 unsigned int mask = 0;
2332
2333 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2334 mask |= 1 << SNDRV_PCM_ACCESS_RW_INTERLEAVED;
2335 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2336 mask |= 1 << SNDRV_PCM_ACCESS_RW_NONINTERLEAVED;
2337 if (hw_support_mmap(substream)) {
2338 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2339 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_INTERLEAVED;
2340 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2341 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED;
2342 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2343 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_COMPLEX;
2344 }
2345 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2346 if (err < 0)
2347 return err;
2348
2349 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2350 if (err < 0)
2351 return err;
2352
2353 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT, 1 << SNDRV_PCM_SUBFORMAT_STD);
2354 if (err < 0)
2355 return err;
2356
2357 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2358 hw->channels_min, hw->channels_max);
2359 if (err < 0)
2360 return err;
2361
2362 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2363 hw->rate_min, hw->rate_max);
2364 if (err < 0)
2365 return err;
2366
2367 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2368 hw->period_bytes_min, hw->period_bytes_max);
2369 if (err < 0)
2370 return err;
2371
2372 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2373 hw->periods_min, hw->periods_max);
2374 if (err < 0)
2375 return err;
2376
2377 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2378 hw->period_bytes_min, hw->buffer_bytes_max);
2379 if (err < 0)
2380 return err;
2381
2382 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2383 snd_pcm_hw_rule_buffer_bytes_max, substream,
2384 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2385 if (err < 0)
2386 return err;
2387
2388 /* FIXME: remove */
2389 if (runtime->dma_bytes) {
2390 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2391 if (err < 0)
2392 return err;
2393 }
2394
2395 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2396 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2397 snd_pcm_hw_rule_rate, hw,
2398 SNDRV_PCM_HW_PARAM_RATE, -1);
2399 if (err < 0)
2400 return err;
2401 }
2402
2403 /* FIXME: this belong to lowlevel */
2404 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2405
2406 return 0;
2407}
2408
2409static void pcm_release_private(struct snd_pcm_substream *substream)
2410{
2411 if (snd_pcm_stream_linked(substream))
2412 snd_pcm_unlink(substream);
2413}
2414
2415void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2416{
2417 substream->ref_count--;
2418 if (substream->ref_count > 0)
2419 return;
2420
2421 snd_pcm_drop(substream);
2422 if (substream->hw_opened) {
2423 if (substream->ops->hw_free &&
2424 substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2425 substream->ops->hw_free(substream);
2426 substream->ops->close(substream);
2427 substream->hw_opened = 0;
2428 }
2429 if (pm_qos_request_active(&substream->latency_pm_qos_req))
2430 pm_qos_remove_request(&substream->latency_pm_qos_req);
2431 if (substream->pcm_release) {
2432 substream->pcm_release(substream);
2433 substream->pcm_release = NULL;
2434 }
2435 snd_pcm_detach_substream(substream);
2436}
2437EXPORT_SYMBOL(snd_pcm_release_substream);
2438
2439int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2440 struct file *file,
2441 struct snd_pcm_substream **rsubstream)
2442{
2443 struct snd_pcm_substream *substream;
2444 int err;
2445
2446 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2447 if (err < 0)
2448 return err;
2449 if (substream->ref_count > 1) {
2450 *rsubstream = substream;
2451 return 0;
2452 }
2453
2454 err = snd_pcm_hw_constraints_init(substream);
2455 if (err < 0) {
2456 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2457 goto error;
2458 }
2459
2460 if ((err = substream->ops->open(substream)) < 0)
2461 goto error;
2462
2463 substream->hw_opened = 1;
2464
2465 err = snd_pcm_hw_constraints_complete(substream);
2466 if (err < 0) {
2467 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2468 goto error;
2469 }
2470
2471 *rsubstream = substream;
2472 return 0;
2473
2474 error:
2475 snd_pcm_release_substream(substream);
2476 return err;
2477}
2478EXPORT_SYMBOL(snd_pcm_open_substream);
2479
2480static int snd_pcm_open_file(struct file *file,
2481 struct snd_pcm *pcm,
2482 int stream)
2483{
2484 struct snd_pcm_file *pcm_file;
2485 struct snd_pcm_substream *substream;
2486 int err;
2487
2488 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2489 if (err < 0)
2490 return err;
2491
2492 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2493 if (pcm_file == NULL) {
2494 snd_pcm_release_substream(substream);
2495 return -ENOMEM;
2496 }
2497 pcm_file->substream = substream;
2498 if (substream->ref_count == 1)
2499 substream->pcm_release = pcm_release_private;
2500 file->private_data = pcm_file;
2501
2502 return 0;
2503}
2504
2505static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2506{
2507 struct snd_pcm *pcm;
2508 int err = nonseekable_open(inode, file);
2509 if (err < 0)
2510 return err;
2511 pcm = snd_lookup_minor_data(iminor(inode),
2512 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2513 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2514 if (pcm)
2515 snd_card_unref(pcm->card);
2516 return err;
2517}
2518
2519static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2520{
2521 struct snd_pcm *pcm;
2522 int err = nonseekable_open(inode, file);
2523 if (err < 0)
2524 return err;
2525 pcm = snd_lookup_minor_data(iminor(inode),
2526 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2527 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2528 if (pcm)
2529 snd_card_unref(pcm->card);
2530 return err;
2531}
2532
2533static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2534{
2535 int err;
2536 wait_queue_entry_t wait;
2537
2538 if (pcm == NULL) {
2539 err = -ENODEV;
2540 goto __error1;
2541 }
2542 err = snd_card_file_add(pcm->card, file);
2543 if (err < 0)
2544 goto __error1;
2545 if (!try_module_get(pcm->card->module)) {
2546 err = -EFAULT;
2547 goto __error2;
2548 }
2549 init_waitqueue_entry(&wait, current);
2550 add_wait_queue(&pcm->open_wait, &wait);
2551 mutex_lock(&pcm->open_mutex);
2552 while (1) {
2553 err = snd_pcm_open_file(file, pcm, stream);
2554 if (err >= 0)
2555 break;
2556 if (err == -EAGAIN) {
2557 if (file->f_flags & O_NONBLOCK) {
2558 err = -EBUSY;
2559 break;
2560 }
2561 } else
2562 break;
2563 set_current_state(TASK_INTERRUPTIBLE);
2564 mutex_unlock(&pcm->open_mutex);
2565 schedule();
2566 mutex_lock(&pcm->open_mutex);
2567 if (pcm->card->shutdown) {
2568 err = -ENODEV;
2569 break;
2570 }
2571 if (signal_pending(current)) {
2572 err = -ERESTARTSYS;
2573 break;
2574 }
2575 }
2576 remove_wait_queue(&pcm->open_wait, &wait);
2577 mutex_unlock(&pcm->open_mutex);
2578 if (err < 0)
2579 goto __error;
2580 return err;
2581
2582 __error:
2583 module_put(pcm->card->module);
2584 __error2:
2585 snd_card_file_remove(pcm->card, file);
2586 __error1:
2587 return err;
2588}
2589
2590static int snd_pcm_release(struct inode *inode, struct file *file)
2591{
2592 struct snd_pcm *pcm;
2593 struct snd_pcm_substream *substream;
2594 struct snd_pcm_file *pcm_file;
2595
2596 pcm_file = file->private_data;
2597 substream = pcm_file->substream;
2598 if (snd_BUG_ON(!substream))
2599 return -ENXIO;
2600 pcm = substream->pcm;
2601 mutex_lock(&pcm->open_mutex);
2602 snd_pcm_release_substream(substream);
2603 kfree(pcm_file);
2604 mutex_unlock(&pcm->open_mutex);
2605 wake_up(&pcm->open_wait);
2606 module_put(pcm->card->module);
2607 snd_card_file_remove(pcm->card, file);
2608 return 0;
2609}
2610
2611/* check and update PCM state; return 0 or a negative error
2612 * call this inside PCM lock
2613 */
2614static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2615{
2616 switch (substream->runtime->status->state) {
2617 case SNDRV_PCM_STATE_DRAINING:
2618 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2619 return -EBADFD;
2620 /* Fall through */
2621 case SNDRV_PCM_STATE_RUNNING:
2622 return snd_pcm_update_hw_ptr(substream);
2623 case SNDRV_PCM_STATE_PREPARED:
2624 case SNDRV_PCM_STATE_PAUSED:
2625 return 0;
2626 case SNDRV_PCM_STATE_SUSPENDED:
2627 return -ESTRPIPE;
2628 case SNDRV_PCM_STATE_XRUN:
2629 return -EPIPE;
2630 default:
2631 return -EBADFD;
2632 }
2633}
2634
2635/* increase the appl_ptr; returns the processed frames or a negative error */
2636static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2637 snd_pcm_uframes_t frames,
2638 snd_pcm_sframes_t avail)
2639{
2640 struct snd_pcm_runtime *runtime = substream->runtime;
2641 snd_pcm_sframes_t appl_ptr;
2642 int ret;
2643
2644 if (avail <= 0)
2645 return 0;
2646 if (frames > (snd_pcm_uframes_t)avail)
2647 frames = avail;
2648 appl_ptr = runtime->control->appl_ptr + frames;
2649 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2650 appl_ptr -= runtime->boundary;
2651 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2652 return ret < 0 ? ret : frames;
2653}
2654
2655/* decrease the appl_ptr; returns the processed frames or zero for error */
2656static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2657 snd_pcm_uframes_t frames,
2658 snd_pcm_sframes_t avail)
2659{
2660 struct snd_pcm_runtime *runtime = substream->runtime;
2661 snd_pcm_sframes_t appl_ptr;
2662 int ret;
2663
2664 if (avail <= 0)
2665 return 0;
2666 if (frames > (snd_pcm_uframes_t)avail)
2667 frames = avail;
2668 appl_ptr = runtime->control->appl_ptr - frames;
2669 if (appl_ptr < 0)
2670 appl_ptr += runtime->boundary;
2671 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2672 /* NOTE: we return zero for errors because PulseAudio gets depressed
2673 * upon receiving an error from rewind ioctl and stops processing
2674 * any longer. Returning zero means that no rewind is done, so
2675 * it's not absolutely wrong to answer like that.
2676 */
2677 return ret < 0 ? 0 : frames;
2678}
2679
2680static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2681 snd_pcm_uframes_t frames)
2682{
2683 snd_pcm_sframes_t ret;
2684
2685 if (frames == 0)
2686 return 0;
2687
2688 snd_pcm_stream_lock_irq(substream);
2689 ret = do_pcm_hwsync(substream);
2690 if (!ret)
2691 ret = rewind_appl_ptr(substream, frames,
2692 snd_pcm_hw_avail(substream));
2693 snd_pcm_stream_unlock_irq(substream);
2694 return ret;
2695}
2696
2697static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2698 snd_pcm_uframes_t frames)
2699{
2700 snd_pcm_sframes_t ret;
2701
2702 if (frames == 0)
2703 return 0;
2704
2705 snd_pcm_stream_lock_irq(substream);
2706 ret = do_pcm_hwsync(substream);
2707 if (!ret)
2708 ret = forward_appl_ptr(substream, frames,
2709 snd_pcm_avail(substream));
2710 snd_pcm_stream_unlock_irq(substream);
2711 return ret;
2712}
2713
2714static int snd_pcm_hwsync(struct snd_pcm_substream *substream)
2715{
2716 int err;
2717
2718 snd_pcm_stream_lock_irq(substream);
2719 err = do_pcm_hwsync(substream);
2720 snd_pcm_stream_unlock_irq(substream);
2721 return err;
2722}
2723
2724static int snd_pcm_delay(struct snd_pcm_substream *substream,
2725 snd_pcm_sframes_t *delay)
2726{
2727 int err;
2728 snd_pcm_sframes_t n = 0;
2729
2730 snd_pcm_stream_lock_irq(substream);
2731 err = do_pcm_hwsync(substream);
2732 if (!err)
2733 n = snd_pcm_calc_delay(substream);
2734 snd_pcm_stream_unlock_irq(substream);
2735 if (!err)
2736 *delay = n;
2737 return err;
2738}
2739
2740static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
2741 struct snd_pcm_sync_ptr __user *_sync_ptr)
2742{
2743 struct snd_pcm_runtime *runtime = substream->runtime;
2744 struct snd_pcm_sync_ptr sync_ptr;
2745 volatile struct snd_pcm_mmap_status *status;
2746 volatile struct snd_pcm_mmap_control *control;
2747 int err;
2748
2749 memset(&sync_ptr, 0, sizeof(sync_ptr));
2750 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
2751 return -EFAULT;
2752 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
2753 return -EFAULT;
2754 status = runtime->status;
2755 control = runtime->control;
2756 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
2757 err = snd_pcm_hwsync(substream);
2758 if (err < 0)
2759 return err;
2760 }
2761 snd_pcm_stream_lock_irq(substream);
2762 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
2763 err = pcm_lib_apply_appl_ptr(substream,
2764 sync_ptr.c.control.appl_ptr);
2765 if (err < 0) {
2766 snd_pcm_stream_unlock_irq(substream);
2767 return err;
2768 }
2769 } else {
2770 sync_ptr.c.control.appl_ptr = control->appl_ptr;
2771 }
2772 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
2773 control->avail_min = sync_ptr.c.control.avail_min;
2774 else
2775 sync_ptr.c.control.avail_min = control->avail_min;
2776 sync_ptr.s.status.state = status->state;
2777 sync_ptr.s.status.hw_ptr = status->hw_ptr;
2778 sync_ptr.s.status.tstamp = status->tstamp;
2779 sync_ptr.s.status.suspended_state = status->suspended_state;
2780 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
2781 snd_pcm_stream_unlock_irq(substream);
2782 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
2783 return -EFAULT;
2784 return 0;
2785}
2786
2787static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
2788{
2789 struct snd_pcm_runtime *runtime = substream->runtime;
2790 int arg;
2791
2792 if (get_user(arg, _arg))
2793 return -EFAULT;
2794 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
2795 return -EINVAL;
2796 runtime->tstamp_type = arg;
2797 return 0;
2798}
2799
2800static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
2801 struct snd_xferi __user *_xferi)
2802{
2803 struct snd_xferi xferi;
2804 struct snd_pcm_runtime *runtime = substream->runtime;
2805 snd_pcm_sframes_t result;
2806
2807 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2808 return -EBADFD;
2809 if (put_user(0, &_xferi->result))
2810 return -EFAULT;
2811 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
2812 return -EFAULT;
2813 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2814 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
2815 else
2816 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
2817 __put_user(result, &_xferi->result);
2818 return result < 0 ? result : 0;
2819}
2820
2821static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
2822 struct snd_xfern __user *_xfern)
2823{
2824 struct snd_xfern xfern;
2825 struct snd_pcm_runtime *runtime = substream->runtime;
2826 void *bufs;
2827 snd_pcm_sframes_t result;
2828
2829 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2830 return -EBADFD;
2831 if (runtime->channels > 128)
2832 return -EINVAL;
2833 if (put_user(0, &_xfern->result))
2834 return -EFAULT;
2835 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
2836 return -EFAULT;
2837
2838 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
2839 if (IS_ERR(bufs))
2840 return PTR_ERR(bufs);
2841 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2842 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
2843 else
2844 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
2845 kfree(bufs);
2846 __put_user(result, &_xfern->result);
2847 return result < 0 ? result : 0;
2848}
2849
2850static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
2851 snd_pcm_uframes_t __user *_frames)
2852{
2853 snd_pcm_uframes_t frames;
2854 snd_pcm_sframes_t result;
2855
2856 if (get_user(frames, _frames))
2857 return -EFAULT;
2858 if (put_user(0, _frames))
2859 return -EFAULT;
2860 result = snd_pcm_rewind(substream, frames);
2861 __put_user(result, _frames);
2862 return result < 0 ? result : 0;
2863}
2864
2865static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
2866 snd_pcm_uframes_t __user *_frames)
2867{
2868 snd_pcm_uframes_t frames;
2869 snd_pcm_sframes_t result;
2870
2871 if (get_user(frames, _frames))
2872 return -EFAULT;
2873 if (put_user(0, _frames))
2874 return -EFAULT;
2875 result = snd_pcm_forward(substream, frames);
2876 __put_user(result, _frames);
2877 return result < 0 ? result : 0;
2878}
2879
2880static int snd_pcm_common_ioctl(struct file *file,
2881 struct snd_pcm_substream *substream,
2882 unsigned int cmd, void __user *arg)
2883{
2884 struct snd_pcm_file *pcm_file = file->private_data;
2885 int res;
2886
2887 if (PCM_RUNTIME_CHECK(substream))
2888 return -ENXIO;
2889
2890 res = snd_power_wait(substream->pcm->card, SNDRV_CTL_POWER_D0);
2891 if (res < 0)
2892 return res;
2893
2894 switch (cmd) {
2895 case SNDRV_PCM_IOCTL_PVERSION:
2896 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
2897 case SNDRV_PCM_IOCTL_INFO:
2898 return snd_pcm_info_user(substream, arg);
2899 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
2900 return 0;
2901 case SNDRV_PCM_IOCTL_TTSTAMP:
2902 return snd_pcm_tstamp(substream, arg);
2903 case SNDRV_PCM_IOCTL_USER_PVERSION:
2904 if (get_user(pcm_file->user_pversion,
2905 (unsigned int __user *)arg))
2906 return -EFAULT;
2907 return 0;
2908 case SNDRV_PCM_IOCTL_HW_REFINE:
2909 return snd_pcm_hw_refine_user(substream, arg);
2910 case SNDRV_PCM_IOCTL_HW_PARAMS:
2911 return snd_pcm_hw_params_user(substream, arg);
2912 case SNDRV_PCM_IOCTL_HW_FREE:
2913 return snd_pcm_hw_free(substream);
2914 case SNDRV_PCM_IOCTL_SW_PARAMS:
2915 return snd_pcm_sw_params_user(substream, arg);
2916 case SNDRV_PCM_IOCTL_STATUS:
2917 return snd_pcm_status_user(substream, arg, false);
2918 case SNDRV_PCM_IOCTL_STATUS_EXT:
2919 return snd_pcm_status_user(substream, arg, true);
2920 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
2921 return snd_pcm_channel_info_user(substream, arg);
2922 case SNDRV_PCM_IOCTL_PREPARE:
2923 return snd_pcm_prepare(substream, file);
2924 case SNDRV_PCM_IOCTL_RESET:
2925 return snd_pcm_reset(substream);
2926 case SNDRV_PCM_IOCTL_START:
2927 return snd_pcm_start_lock_irq(substream);
2928 case SNDRV_PCM_IOCTL_LINK:
2929 return snd_pcm_link(substream, (int)(unsigned long) arg);
2930 case SNDRV_PCM_IOCTL_UNLINK:
2931 return snd_pcm_unlink(substream);
2932 case SNDRV_PCM_IOCTL_RESUME:
2933 return snd_pcm_resume(substream);
2934 case SNDRV_PCM_IOCTL_XRUN:
2935 return snd_pcm_xrun(substream);
2936 case SNDRV_PCM_IOCTL_HWSYNC:
2937 return snd_pcm_hwsync(substream);
2938 case SNDRV_PCM_IOCTL_DELAY:
2939 {
2940 snd_pcm_sframes_t delay;
2941 snd_pcm_sframes_t __user *res = arg;
2942 int err;
2943
2944 err = snd_pcm_delay(substream, &delay);
2945 if (err)
2946 return err;
2947 if (put_user(delay, res))
2948 return -EFAULT;
2949 return 0;
2950 }
2951 case SNDRV_PCM_IOCTL_SYNC_PTR:
2952 return snd_pcm_sync_ptr(substream, arg);
2953#ifdef CONFIG_SND_SUPPORT_OLD_API
2954 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
2955 return snd_pcm_hw_refine_old_user(substream, arg);
2956 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
2957 return snd_pcm_hw_params_old_user(substream, arg);
2958#endif
2959 case SNDRV_PCM_IOCTL_DRAIN:
2960 return snd_pcm_drain(substream, file);
2961 case SNDRV_PCM_IOCTL_DROP:
2962 return snd_pcm_drop(substream);
2963 case SNDRV_PCM_IOCTL_PAUSE:
2964 return snd_pcm_action_lock_irq(&snd_pcm_action_pause,
2965 substream,
2966 (int)(unsigned long)arg);
2967 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
2968 case SNDRV_PCM_IOCTL_READI_FRAMES:
2969 return snd_pcm_xferi_frames_ioctl(substream, arg);
2970 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
2971 case SNDRV_PCM_IOCTL_READN_FRAMES:
2972 return snd_pcm_xfern_frames_ioctl(substream, arg);
2973 case SNDRV_PCM_IOCTL_REWIND:
2974 return snd_pcm_rewind_ioctl(substream, arg);
2975 case SNDRV_PCM_IOCTL_FORWARD:
2976 return snd_pcm_forward_ioctl(substream, arg);
2977 }
2978 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
2979 return -ENOTTY;
2980}
2981
2982static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
2983 unsigned long arg)
2984{
2985 struct snd_pcm_file *pcm_file;
2986
2987 pcm_file = file->private_data;
2988
2989 if (((cmd >> 8) & 0xff) != 'A')
2990 return -ENOTTY;
2991
2992 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
2993 (void __user *)arg);
2994}
2995
2996/**
2997 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
2998 * @substream: PCM substream
2999 * @cmd: IOCTL cmd
3000 * @arg: IOCTL argument
3001 *
3002 * The function is provided primarily for OSS layer and USB gadget drivers,
3003 * and it allows only the limited set of ioctls (hw_params, sw_params,
3004 * prepare, start, drain, drop, forward).
3005 */
3006int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3007 unsigned int cmd, void *arg)
3008{
3009 snd_pcm_uframes_t *frames = arg;
3010 snd_pcm_sframes_t result;
3011
3012 switch (cmd) {
3013 case SNDRV_PCM_IOCTL_FORWARD:
3014 {
3015 /* provided only for OSS; capture-only and no value returned */
3016 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3017 return -EINVAL;
3018 result = snd_pcm_forward(substream, *frames);
3019 return result < 0 ? result : 0;
3020 }
3021 case SNDRV_PCM_IOCTL_HW_PARAMS:
3022 return snd_pcm_hw_params(substream, arg);
3023 case SNDRV_PCM_IOCTL_SW_PARAMS:
3024 return snd_pcm_sw_params(substream, arg);
3025 case SNDRV_PCM_IOCTL_PREPARE:
3026 return snd_pcm_prepare(substream, NULL);
3027 case SNDRV_PCM_IOCTL_START:
3028 return snd_pcm_start_lock_irq(substream);
3029 case SNDRV_PCM_IOCTL_DRAIN:
3030 return snd_pcm_drain(substream, NULL);
3031 case SNDRV_PCM_IOCTL_DROP:
3032 return snd_pcm_drop(substream);
3033 case SNDRV_PCM_IOCTL_DELAY:
3034 return snd_pcm_delay(substream, frames);
3035 default:
3036 return -EINVAL;
3037 }
3038}
3039EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3040
3041static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3042 loff_t * offset)
3043{
3044 struct snd_pcm_file *pcm_file;
3045 struct snd_pcm_substream *substream;
3046 struct snd_pcm_runtime *runtime;
3047 snd_pcm_sframes_t result;
3048
3049 pcm_file = file->private_data;
3050 substream = pcm_file->substream;
3051 if (PCM_RUNTIME_CHECK(substream))
3052 return -ENXIO;
3053 runtime = substream->runtime;
3054 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3055 return -EBADFD;
3056 if (!frame_aligned(runtime, count))
3057 return -EINVAL;
3058 count = bytes_to_frames(runtime, count);
3059 result = snd_pcm_lib_read(substream, buf, count);
3060 if (result > 0)
3061 result = frames_to_bytes(runtime, result);
3062 return result;
3063}
3064
3065static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3066 size_t count, loff_t * offset)
3067{
3068 struct snd_pcm_file *pcm_file;
3069 struct snd_pcm_substream *substream;
3070 struct snd_pcm_runtime *runtime;
3071 snd_pcm_sframes_t result;
3072
3073 pcm_file = file->private_data;
3074 substream = pcm_file->substream;
3075 if (PCM_RUNTIME_CHECK(substream))
3076 return -ENXIO;
3077 runtime = substream->runtime;
3078 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3079 return -EBADFD;
3080 if (!frame_aligned(runtime, count))
3081 return -EINVAL;
3082 count = bytes_to_frames(runtime, count);
3083 result = snd_pcm_lib_write(substream, buf, count);
3084 if (result > 0)
3085 result = frames_to_bytes(runtime, result);
3086 return result;
3087}
3088
3089static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3090{
3091 struct snd_pcm_file *pcm_file;
3092 struct snd_pcm_substream *substream;
3093 struct snd_pcm_runtime *runtime;
3094 snd_pcm_sframes_t result;
3095 unsigned long i;
3096 void __user **bufs;
3097 snd_pcm_uframes_t frames;
3098
3099 pcm_file = iocb->ki_filp->private_data;
3100 substream = pcm_file->substream;
3101 if (PCM_RUNTIME_CHECK(substream))
3102 return -ENXIO;
3103 runtime = substream->runtime;
3104 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3105 return -EBADFD;
3106 if (!iter_is_iovec(to))
3107 return -EINVAL;
3108 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3109 return -EINVAL;
3110 if (!frame_aligned(runtime, to->iov->iov_len))
3111 return -EINVAL;
3112 frames = bytes_to_samples(runtime, to->iov->iov_len);
3113 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3114 if (bufs == NULL)
3115 return -ENOMEM;
3116 for (i = 0; i < to->nr_segs; ++i)
3117 bufs[i] = to->iov[i].iov_base;
3118 result = snd_pcm_lib_readv(substream, bufs, frames);
3119 if (result > 0)
3120 result = frames_to_bytes(runtime, result);
3121 kfree(bufs);
3122 return result;
3123}
3124
3125static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3126{
3127 struct snd_pcm_file *pcm_file;
3128 struct snd_pcm_substream *substream;
3129 struct snd_pcm_runtime *runtime;
3130 snd_pcm_sframes_t result;
3131 unsigned long i;
3132 void __user **bufs;
3133 snd_pcm_uframes_t frames;
3134
3135 pcm_file = iocb->ki_filp->private_data;
3136 substream = pcm_file->substream;
3137 if (PCM_RUNTIME_CHECK(substream))
3138 return -ENXIO;
3139 runtime = substream->runtime;
3140 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3141 return -EBADFD;
3142 if (!iter_is_iovec(from))
3143 return -EINVAL;
3144 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3145 !frame_aligned(runtime, from->iov->iov_len))
3146 return -EINVAL;
3147 frames = bytes_to_samples(runtime, from->iov->iov_len);
3148 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3149 if (bufs == NULL)
3150 return -ENOMEM;
3151 for (i = 0; i < from->nr_segs; ++i)
3152 bufs[i] = from->iov[i].iov_base;
3153 result = snd_pcm_lib_writev(substream, bufs, frames);
3154 if (result > 0)
3155 result = frames_to_bytes(runtime, result);
3156 kfree(bufs);
3157 return result;
3158}
3159
3160static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3161{
3162 struct snd_pcm_file *pcm_file;
3163 struct snd_pcm_substream *substream;
3164 struct snd_pcm_runtime *runtime;
3165 __poll_t mask, ok;
3166 snd_pcm_uframes_t avail;
3167
3168 pcm_file = file->private_data;
3169
3170 substream = pcm_file->substream;
3171 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3172 ok = EPOLLOUT | EPOLLWRNORM;
3173 else
3174 ok = EPOLLIN | EPOLLRDNORM;
3175 if (PCM_RUNTIME_CHECK(substream))
3176 return ok | EPOLLERR;
3177
3178 runtime = substream->runtime;
3179 poll_wait(file, &runtime->sleep, wait);
3180
3181 mask = 0;
3182 snd_pcm_stream_lock_irq(substream);
3183 avail = snd_pcm_avail(substream);
3184 switch (runtime->status->state) {
3185 case SNDRV_PCM_STATE_RUNNING:
3186 case SNDRV_PCM_STATE_PREPARED:
3187 case SNDRV_PCM_STATE_PAUSED:
3188 if (avail >= runtime->control->avail_min)
3189 mask = ok;
3190 break;
3191 case SNDRV_PCM_STATE_DRAINING:
3192 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3193 mask = ok;
3194 if (!avail)
3195 mask |= EPOLLERR;
3196 }
3197 break;
3198 default:
3199 mask = ok | EPOLLERR;
3200 break;
3201 }
3202 snd_pcm_stream_unlock_irq(substream);
3203 return mask;
3204}
3205
3206/*
3207 * mmap support
3208 */
3209
3210/*
3211 * Only on coherent architectures, we can mmap the status and the control records
3212 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3213 */
3214#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3215/*
3216 * mmap status record
3217 */
3218static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3219{
3220 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3221 struct snd_pcm_runtime *runtime;
3222
3223 if (substream == NULL)
3224 return VM_FAULT_SIGBUS;
3225 runtime = substream->runtime;
3226 vmf->page = virt_to_page(runtime->status);
3227 get_page(vmf->page);
3228 return 0;
3229}
3230
3231static const struct vm_operations_struct snd_pcm_vm_ops_status =
3232{
3233 .fault = snd_pcm_mmap_status_fault,
3234};
3235
3236static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3237 struct vm_area_struct *area)
3238{
3239 long size;
3240 if (!(area->vm_flags & VM_READ))
3241 return -EINVAL;
3242 size = area->vm_end - area->vm_start;
3243 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3244 return -EINVAL;
3245 area->vm_ops = &snd_pcm_vm_ops_status;
3246 area->vm_private_data = substream;
3247 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3248 return 0;
3249}
3250
3251/*
3252 * mmap control record
3253 */
3254static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3255{
3256 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3257 struct snd_pcm_runtime *runtime;
3258
3259 if (substream == NULL)
3260 return VM_FAULT_SIGBUS;
3261 runtime = substream->runtime;
3262 vmf->page = virt_to_page(runtime->control);
3263 get_page(vmf->page);
3264 return 0;
3265}
3266
3267static const struct vm_operations_struct snd_pcm_vm_ops_control =
3268{
3269 .fault = snd_pcm_mmap_control_fault,
3270};
3271
3272static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3273 struct vm_area_struct *area)
3274{
3275 long size;
3276 if (!(area->vm_flags & VM_READ))
3277 return -EINVAL;
3278 size = area->vm_end - area->vm_start;
3279 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3280 return -EINVAL;
3281 area->vm_ops = &snd_pcm_vm_ops_control;
3282 area->vm_private_data = substream;
3283 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3284 return 0;
3285}
3286
3287static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3288{
3289 if (pcm_file->no_compat_mmap)
3290 return false;
3291 /* See pcm_control_mmap_allowed() below.
3292 * Since older alsa-lib requires both status and control mmaps to be
3293 * coupled, we have to disable the status mmap for old alsa-lib, too.
3294 */
3295 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3296 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3297 return false;
3298 return true;
3299}
3300
3301static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3302{
3303 if (pcm_file->no_compat_mmap)
3304 return false;
3305 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3306 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3307 * thus it effectively assures the manual update of appl_ptr.
3308 */
3309 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3310 return false;
3311 return true;
3312}
3313
3314#else /* ! coherent mmap */
3315/*
3316 * don't support mmap for status and control records.
3317 */
3318#define pcm_status_mmap_allowed(pcm_file) false
3319#define pcm_control_mmap_allowed(pcm_file) false
3320
3321static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3322 struct vm_area_struct *area)
3323{
3324 return -ENXIO;
3325}
3326static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3327 struct vm_area_struct *area)
3328{
3329 return -ENXIO;
3330}
3331#endif /* coherent mmap */
3332
3333static inline struct page *
3334snd_pcm_default_page_ops(struct snd_pcm_substream *substream, unsigned long ofs)
3335{
3336 void *vaddr = substream->runtime->dma_area + ofs;
3337 return virt_to_page(vaddr);
3338}
3339
3340/*
3341 * fault callback for mmapping a RAM page
3342 */
3343static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3344{
3345 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3346 struct snd_pcm_runtime *runtime;
3347 unsigned long offset;
3348 struct page * page;
3349 size_t dma_bytes;
3350
3351 if (substream == NULL)
3352 return VM_FAULT_SIGBUS;
3353 runtime = substream->runtime;
3354 offset = vmf->pgoff << PAGE_SHIFT;
3355 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3356 if (offset > dma_bytes - PAGE_SIZE)
3357 return VM_FAULT_SIGBUS;
3358 if (substream->ops->page)
3359 page = substream->ops->page(substream, offset);
3360 else
3361 page = snd_pcm_default_page_ops(substream, offset);
3362 if (!page)
3363 return VM_FAULT_SIGBUS;
3364 get_page(page);
3365 vmf->page = page;
3366 return 0;
3367}
3368
3369static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3370 .open = snd_pcm_mmap_data_open,
3371 .close = snd_pcm_mmap_data_close,
3372};
3373
3374static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3375 .open = snd_pcm_mmap_data_open,
3376 .close = snd_pcm_mmap_data_close,
3377 .fault = snd_pcm_mmap_data_fault,
3378};
3379
3380/*
3381 * mmap the DMA buffer on RAM
3382 */
3383
3384/**
3385 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3386 * @substream: PCM substream
3387 * @area: VMA
3388 *
3389 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3390 * this function is invoked implicitly.
3391 */
3392int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3393 struct vm_area_struct *area)
3394{
3395 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3396#ifdef CONFIG_GENERIC_ALLOCATOR
3397 if (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_IRAM) {
3398 area->vm_page_prot = pgprot_writecombine(area->vm_page_prot);
3399 return remap_pfn_range(area, area->vm_start,
3400 substream->dma_buffer.addr >> PAGE_SHIFT,
3401 area->vm_end - area->vm_start, area->vm_page_prot);
3402 }
3403#endif /* CONFIG_GENERIC_ALLOCATOR */
3404#ifndef CONFIG_X86 /* for avoiding warnings arch/x86/mm/pat.c */
3405 if (IS_ENABLED(CONFIG_HAS_DMA) && !substream->ops->page &&
3406 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV)
3407 return dma_mmap_coherent(substream->dma_buffer.dev.dev,
3408 area,
3409 substream->runtime->dma_area,
3410 substream->runtime->dma_addr,
3411 substream->runtime->dma_bytes);
3412#endif /* CONFIG_X86 */
3413 /* mmap with fault handler */
3414 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3415 return 0;
3416}
3417EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3418
3419/*
3420 * mmap the DMA buffer on I/O memory area
3421 */
3422#if SNDRV_PCM_INFO_MMAP_IOMEM
3423/**
3424 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3425 * @substream: PCM substream
3426 * @area: VMA
3427 *
3428 * When your hardware uses the iomapped pages as the hardware buffer and
3429 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3430 * is supposed to work only on limited architectures.
3431 */
3432int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3433 struct vm_area_struct *area)
3434{
3435 struct snd_pcm_runtime *runtime = substream->runtime;
3436
3437 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3438 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3439}
3440EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3441#endif /* SNDRV_PCM_INFO_MMAP */
3442
3443/*
3444 * mmap DMA buffer
3445 */
3446int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3447 struct vm_area_struct *area)
3448{
3449 struct snd_pcm_runtime *runtime;
3450 long size;
3451 unsigned long offset;
3452 size_t dma_bytes;
3453 int err;
3454
3455 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3456 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3457 return -EINVAL;
3458 } else {
3459 if (!(area->vm_flags & VM_READ))
3460 return -EINVAL;
3461 }
3462 runtime = substream->runtime;
3463 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3464 return -EBADFD;
3465 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3466 return -ENXIO;
3467 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3468 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3469 return -EINVAL;
3470 size = area->vm_end - area->vm_start;
3471 offset = area->vm_pgoff << PAGE_SHIFT;
3472 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3473 if ((size_t)size > dma_bytes)
3474 return -EINVAL;
3475 if (offset > dma_bytes - size)
3476 return -EINVAL;
3477
3478 area->vm_ops = &snd_pcm_vm_ops_data;
3479 area->vm_private_data = substream;
3480 if (substream->ops->mmap)
3481 err = substream->ops->mmap(substream, area);
3482 else
3483 err = snd_pcm_lib_default_mmap(substream, area);
3484 if (!err)
3485 atomic_inc(&substream->mmap_count);
3486 return err;
3487}
3488EXPORT_SYMBOL(snd_pcm_mmap_data);
3489
3490static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3491{
3492 struct snd_pcm_file * pcm_file;
3493 struct snd_pcm_substream *substream;
3494 unsigned long offset;
3495
3496 pcm_file = file->private_data;
3497 substream = pcm_file->substream;
3498 if (PCM_RUNTIME_CHECK(substream))
3499 return -ENXIO;
3500
3501 offset = area->vm_pgoff << PAGE_SHIFT;
3502 switch (offset) {
3503 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3504 if (!pcm_status_mmap_allowed(pcm_file))
3505 return -ENXIO;
3506 return snd_pcm_mmap_status(substream, file, area);
3507 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3508 if (!pcm_control_mmap_allowed(pcm_file))
3509 return -ENXIO;
3510 return snd_pcm_mmap_control(substream, file, area);
3511 default:
3512 return snd_pcm_mmap_data(substream, file, area);
3513 }
3514 return 0;
3515}
3516
3517static int snd_pcm_fasync(int fd, struct file * file, int on)
3518{
3519 struct snd_pcm_file * pcm_file;
3520 struct snd_pcm_substream *substream;
3521 struct snd_pcm_runtime *runtime;
3522
3523 pcm_file = file->private_data;
3524 substream = pcm_file->substream;
3525 if (PCM_RUNTIME_CHECK(substream))
3526 return -ENXIO;
3527 runtime = substream->runtime;
3528 return fasync_helper(fd, file, on, &runtime->fasync);
3529}
3530
3531/*
3532 * ioctl32 compat
3533 */
3534#ifdef CONFIG_COMPAT
3535#include "pcm_compat.c"
3536#else
3537#define snd_pcm_ioctl_compat NULL
3538#endif
3539
3540/*
3541 * To be removed helpers to keep binary compatibility
3542 */
3543
3544#ifdef CONFIG_SND_SUPPORT_OLD_API
3545#define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3546#define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3547
3548static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3549 struct snd_pcm_hw_params_old *oparams)
3550{
3551 unsigned int i;
3552
3553 memset(params, 0, sizeof(*params));
3554 params->flags = oparams->flags;
3555 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3556 params->masks[i].bits[0] = oparams->masks[i];
3557 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3558 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3559 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3560 params->info = oparams->info;
3561 params->msbits = oparams->msbits;
3562 params->rate_num = oparams->rate_num;
3563 params->rate_den = oparams->rate_den;
3564 params->fifo_size = oparams->fifo_size;
3565}
3566
3567static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3568 struct snd_pcm_hw_params *params)
3569{
3570 unsigned int i;
3571
3572 memset(oparams, 0, sizeof(*oparams));
3573 oparams->flags = params->flags;
3574 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3575 oparams->masks[i] = params->masks[i].bits[0];
3576 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3577 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3578 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3579 oparams->info = params->info;
3580 oparams->msbits = params->msbits;
3581 oparams->rate_num = params->rate_num;
3582 oparams->rate_den = params->rate_den;
3583 oparams->fifo_size = params->fifo_size;
3584}
3585
3586static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3587 struct snd_pcm_hw_params_old __user * _oparams)
3588{
3589 struct snd_pcm_hw_params *params;
3590 struct snd_pcm_hw_params_old *oparams = NULL;
3591 int err;
3592
3593 params = kmalloc(sizeof(*params), GFP_KERNEL);
3594 if (!params)
3595 return -ENOMEM;
3596
3597 oparams = memdup_user(_oparams, sizeof(*oparams));
3598 if (IS_ERR(oparams)) {
3599 err = PTR_ERR(oparams);
3600 goto out;
3601 }
3602 snd_pcm_hw_convert_from_old_params(params, oparams);
3603 err = snd_pcm_hw_refine(substream, params);
3604 if (err < 0)
3605 goto out_old;
3606
3607 err = fixup_unreferenced_params(substream, params);
3608 if (err < 0)
3609 goto out_old;
3610
3611 snd_pcm_hw_convert_to_old_params(oparams, params);
3612 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3613 err = -EFAULT;
3614out_old:
3615 kfree(oparams);
3616out:
3617 kfree(params);
3618 return err;
3619}
3620
3621static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
3622 struct snd_pcm_hw_params_old __user * _oparams)
3623{
3624 struct snd_pcm_hw_params *params;
3625 struct snd_pcm_hw_params_old *oparams = NULL;
3626 int err;
3627
3628 params = kmalloc(sizeof(*params), GFP_KERNEL);
3629 if (!params)
3630 return -ENOMEM;
3631
3632 oparams = memdup_user(_oparams, sizeof(*oparams));
3633 if (IS_ERR(oparams)) {
3634 err = PTR_ERR(oparams);
3635 goto out;
3636 }
3637
3638 snd_pcm_hw_convert_from_old_params(params, oparams);
3639 err = snd_pcm_hw_params(substream, params);
3640 if (err < 0)
3641 goto out_old;
3642
3643 snd_pcm_hw_convert_to_old_params(oparams, params);
3644 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3645 err = -EFAULT;
3646out_old:
3647 kfree(oparams);
3648out:
3649 kfree(params);
3650 return err;
3651}
3652#endif /* CONFIG_SND_SUPPORT_OLD_API */
3653
3654#ifndef CONFIG_MMU
3655static unsigned long snd_pcm_get_unmapped_area(struct file *file,
3656 unsigned long addr,
3657 unsigned long len,
3658 unsigned long pgoff,
3659 unsigned long flags)
3660{
3661 struct snd_pcm_file *pcm_file = file->private_data;
3662 struct snd_pcm_substream *substream = pcm_file->substream;
3663 struct snd_pcm_runtime *runtime = substream->runtime;
3664 unsigned long offset = pgoff << PAGE_SHIFT;
3665
3666 switch (offset) {
3667 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3668 return (unsigned long)runtime->status;
3669 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3670 return (unsigned long)runtime->control;
3671 default:
3672 return (unsigned long)runtime->dma_area + offset;
3673 }
3674}
3675#else
3676# define snd_pcm_get_unmapped_area NULL
3677#endif
3678
3679/*
3680 * Register section
3681 */
3682
3683const struct file_operations snd_pcm_f_ops[2] = {
3684 {
3685 .owner = THIS_MODULE,
3686 .write = snd_pcm_write,
3687 .write_iter = snd_pcm_writev,
3688 .open = snd_pcm_playback_open,
3689 .release = snd_pcm_release,
3690 .llseek = no_llseek,
3691 .poll = snd_pcm_poll,
3692 .unlocked_ioctl = snd_pcm_ioctl,
3693 .compat_ioctl = snd_pcm_ioctl_compat,
3694 .mmap = snd_pcm_mmap,
3695 .fasync = snd_pcm_fasync,
3696 .get_unmapped_area = snd_pcm_get_unmapped_area,
3697 },
3698 {
3699 .owner = THIS_MODULE,
3700 .read = snd_pcm_read,
3701 .read_iter = snd_pcm_readv,
3702 .open = snd_pcm_capture_open,
3703 .release = snd_pcm_release,
3704 .llseek = no_llseek,
3705 .poll = snd_pcm_poll,
3706 .unlocked_ioctl = snd_pcm_ioctl,
3707 .compat_ioctl = snd_pcm_ioctl_compat,
3708 .mmap = snd_pcm_mmap,
3709 .fasync = snd_pcm_fasync,
3710 .get_unmapped_area = snd_pcm_get_unmapped_area,
3711 }
3712};
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 */
6
7#include <linux/compat.h>
8#include <linux/mm.h>
9#include <linux/module.h>
10#include <linux/file.h>
11#include <linux/slab.h>
12#include <linux/sched/signal.h>
13#include <linux/time.h>
14#include <linux/pm_qos.h>
15#include <linux/io.h>
16#include <linux/dma-mapping.h>
17#include <linux/vmalloc.h>
18#include <sound/core.h>
19#include <sound/control.h>
20#include <sound/info.h>
21#include <sound/pcm.h>
22#include <sound/pcm_params.h>
23#include <sound/timer.h>
24#include <sound/minors.h>
25#include <linux/uio.h>
26#include <linux/delay.h>
27
28#include "pcm_local.h"
29
30#ifdef CONFIG_SND_DEBUG
31#define CREATE_TRACE_POINTS
32#include "pcm_param_trace.h"
33#else
34#define trace_hw_mask_param_enabled() 0
35#define trace_hw_interval_param_enabled() 0
36#define trace_hw_mask_param(substream, type, index, prev, curr)
37#define trace_hw_interval_param(substream, type, index, prev, curr)
38#endif
39
40/*
41 * Compatibility
42 */
43
44struct snd_pcm_hw_params_old {
45 unsigned int flags;
46 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
47 SNDRV_PCM_HW_PARAM_ACCESS + 1];
48 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
49 SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
50 unsigned int rmask;
51 unsigned int cmask;
52 unsigned int info;
53 unsigned int msbits;
54 unsigned int rate_num;
55 unsigned int rate_den;
56 snd_pcm_uframes_t fifo_size;
57 unsigned char reserved[64];
58};
59
60#ifdef CONFIG_SND_SUPPORT_OLD_API
61#define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
62#define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
63
64static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params_old __user * _oparams);
66static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params_old __user * _oparams);
68#endif
69static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
70
71/*
72 *
73 */
74
75static DECLARE_RWSEM(snd_pcm_link_rwsem);
76
77void snd_pcm_group_init(struct snd_pcm_group *group)
78{
79 spin_lock_init(&group->lock);
80 mutex_init(&group->mutex);
81 INIT_LIST_HEAD(&group->substreams);
82 refcount_set(&group->refs, 1);
83}
84
85/* define group lock helpers */
86#define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
87static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
88{ \
89 if (nonatomic) \
90 mutex_ ## mutex_action(&group->mutex); \
91 else \
92 spin_ ## action(&group->lock); \
93}
94
95DEFINE_PCM_GROUP_LOCK(lock, lock);
96DEFINE_PCM_GROUP_LOCK(unlock, unlock);
97DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
98DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
99
100/**
101 * snd_pcm_stream_lock - Lock the PCM stream
102 * @substream: PCM substream
103 *
104 * This locks the PCM stream's spinlock or mutex depending on the nonatomic
105 * flag of the given substream. This also takes the global link rw lock
106 * (or rw sem), too, for avoiding the race with linked streams.
107 */
108void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
109{
110 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
111}
112EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
113
114/**
115 * snd_pcm_stream_unlock - Unlock the PCM stream
116 * @substream: PCM substream
117 *
118 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
119 */
120void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
121{
122 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
123}
124EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
125
126/**
127 * snd_pcm_stream_lock_irq - Lock the PCM stream
128 * @substream: PCM substream
129 *
130 * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
131 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
132 * as snd_pcm_stream_lock().
133 */
134void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
135{
136 snd_pcm_group_lock_irq(&substream->self_group,
137 substream->pcm->nonatomic);
138}
139EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
140
141static void snd_pcm_stream_lock_nested(struct snd_pcm_substream *substream)
142{
143 struct snd_pcm_group *group = &substream->self_group;
144
145 if (substream->pcm->nonatomic)
146 mutex_lock_nested(&group->mutex, SINGLE_DEPTH_NESTING);
147 else
148 spin_lock_nested(&group->lock, SINGLE_DEPTH_NESTING);
149}
150
151/**
152 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
153 * @substream: PCM substream
154 *
155 * This is a counter-part of snd_pcm_stream_lock_irq().
156 */
157void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
158{
159 snd_pcm_group_unlock_irq(&substream->self_group,
160 substream->pcm->nonatomic);
161}
162EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
163
164unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
165{
166 unsigned long flags = 0;
167 if (substream->pcm->nonatomic)
168 mutex_lock(&substream->self_group.mutex);
169 else
170 spin_lock_irqsave(&substream->self_group.lock, flags);
171 return flags;
172}
173EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
174
175unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream)
176{
177 unsigned long flags = 0;
178 if (substream->pcm->nonatomic)
179 mutex_lock_nested(&substream->self_group.mutex,
180 SINGLE_DEPTH_NESTING);
181 else
182 spin_lock_irqsave_nested(&substream->self_group.lock, flags,
183 SINGLE_DEPTH_NESTING);
184 return flags;
185}
186EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave_nested);
187
188/**
189 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
190 * @substream: PCM substream
191 * @flags: irq flags
192 *
193 * This is a counter-part of snd_pcm_stream_lock_irqsave().
194 */
195void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
196 unsigned long flags)
197{
198 if (substream->pcm->nonatomic)
199 mutex_unlock(&substream->self_group.mutex);
200 else
201 spin_unlock_irqrestore(&substream->self_group.lock, flags);
202}
203EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
204
205/* Run PCM ioctl ops */
206static int snd_pcm_ops_ioctl(struct snd_pcm_substream *substream,
207 unsigned cmd, void *arg)
208{
209 if (substream->ops->ioctl)
210 return substream->ops->ioctl(substream, cmd, arg);
211 else
212 return snd_pcm_lib_ioctl(substream, cmd, arg);
213}
214
215int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
216{
217 struct snd_pcm *pcm = substream->pcm;
218 struct snd_pcm_str *pstr = substream->pstr;
219
220 memset(info, 0, sizeof(*info));
221 info->card = pcm->card->number;
222 info->device = pcm->device;
223 info->stream = substream->stream;
224 info->subdevice = substream->number;
225 strscpy(info->id, pcm->id, sizeof(info->id));
226 strscpy(info->name, pcm->name, sizeof(info->name));
227 info->dev_class = pcm->dev_class;
228 info->dev_subclass = pcm->dev_subclass;
229 info->subdevices_count = pstr->substream_count;
230 info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
231 strscpy(info->subname, substream->name, sizeof(info->subname));
232
233 return 0;
234}
235
236int snd_pcm_info_user(struct snd_pcm_substream *substream,
237 struct snd_pcm_info __user * _info)
238{
239 struct snd_pcm_info *info;
240 int err;
241
242 info = kmalloc(sizeof(*info), GFP_KERNEL);
243 if (! info)
244 return -ENOMEM;
245 err = snd_pcm_info(substream, info);
246 if (err >= 0) {
247 if (copy_to_user(_info, info, sizeof(*info)))
248 err = -EFAULT;
249 }
250 kfree(info);
251 return err;
252}
253
254/* macro for simplified cast */
255#define PARAM_MASK_BIT(b) (1U << (__force int)(b))
256
257static bool hw_support_mmap(struct snd_pcm_substream *substream)
258{
259 struct snd_dma_buffer *dmabuf;
260
261 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
262 return false;
263
264 if (substream->ops->mmap || substream->ops->page)
265 return true;
266
267 dmabuf = snd_pcm_get_dma_buf(substream);
268 if (!dmabuf)
269 dmabuf = &substream->dma_buffer;
270 switch (dmabuf->dev.type) {
271 case SNDRV_DMA_TYPE_UNKNOWN:
272 /* we can't know the device, so just assume that the driver does
273 * everything right
274 */
275 return true;
276 case SNDRV_DMA_TYPE_CONTINUOUS:
277 case SNDRV_DMA_TYPE_VMALLOC:
278 return true;
279 default:
280 return dma_can_mmap(dmabuf->dev.dev);
281 }
282}
283
284static int constrain_mask_params(struct snd_pcm_substream *substream,
285 struct snd_pcm_hw_params *params)
286{
287 struct snd_pcm_hw_constraints *constrs =
288 &substream->runtime->hw_constraints;
289 struct snd_mask *m;
290 unsigned int k;
291 struct snd_mask old_mask __maybe_unused;
292 int changed;
293
294 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
295 m = hw_param_mask(params, k);
296 if (snd_mask_empty(m))
297 return -EINVAL;
298
299 /* This parameter is not requested to change by a caller. */
300 if (!(params->rmask & PARAM_MASK_BIT(k)))
301 continue;
302
303 if (trace_hw_mask_param_enabled())
304 old_mask = *m;
305
306 changed = snd_mask_refine(m, constrs_mask(constrs, k));
307 if (changed < 0)
308 return changed;
309 if (changed == 0)
310 continue;
311
312 /* Set corresponding flag so that the caller gets it. */
313 trace_hw_mask_param(substream, k, 0, &old_mask, m);
314 params->cmask |= PARAM_MASK_BIT(k);
315 }
316
317 return 0;
318}
319
320static int constrain_interval_params(struct snd_pcm_substream *substream,
321 struct snd_pcm_hw_params *params)
322{
323 struct snd_pcm_hw_constraints *constrs =
324 &substream->runtime->hw_constraints;
325 struct snd_interval *i;
326 unsigned int k;
327 struct snd_interval old_interval __maybe_unused;
328 int changed;
329
330 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
331 i = hw_param_interval(params, k);
332 if (snd_interval_empty(i))
333 return -EINVAL;
334
335 /* This parameter is not requested to change by a caller. */
336 if (!(params->rmask & PARAM_MASK_BIT(k)))
337 continue;
338
339 if (trace_hw_interval_param_enabled())
340 old_interval = *i;
341
342 changed = snd_interval_refine(i, constrs_interval(constrs, k));
343 if (changed < 0)
344 return changed;
345 if (changed == 0)
346 continue;
347
348 /* Set corresponding flag so that the caller gets it. */
349 trace_hw_interval_param(substream, k, 0, &old_interval, i);
350 params->cmask |= PARAM_MASK_BIT(k);
351 }
352
353 return 0;
354}
355
356static int constrain_params_by_rules(struct snd_pcm_substream *substream,
357 struct snd_pcm_hw_params *params)
358{
359 struct snd_pcm_hw_constraints *constrs =
360 &substream->runtime->hw_constraints;
361 unsigned int k;
362 unsigned int *rstamps;
363 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
364 unsigned int stamp;
365 struct snd_pcm_hw_rule *r;
366 unsigned int d;
367 struct snd_mask old_mask __maybe_unused;
368 struct snd_interval old_interval __maybe_unused;
369 bool again;
370 int changed, err = 0;
371
372 /*
373 * Each application of rule has own sequence number.
374 *
375 * Each member of 'rstamps' array represents the sequence number of
376 * recent application of corresponding rule.
377 */
378 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
379 if (!rstamps)
380 return -ENOMEM;
381
382 /*
383 * Each member of 'vstamps' array represents the sequence number of
384 * recent application of rule in which corresponding parameters were
385 * changed.
386 *
387 * In initial state, elements corresponding to parameters requested by
388 * a caller is 1. For unrequested parameters, corresponding members
389 * have 0 so that the parameters are never changed anymore.
390 */
391 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
392 vstamps[k] = (params->rmask & PARAM_MASK_BIT(k)) ? 1 : 0;
393
394 /* Due to the above design, actual sequence number starts at 2. */
395 stamp = 2;
396retry:
397 /* Apply all rules in order. */
398 again = false;
399 for (k = 0; k < constrs->rules_num; k++) {
400 r = &constrs->rules[k];
401
402 /*
403 * Check condition bits of this rule. When the rule has
404 * some condition bits, parameter without the bits is
405 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
406 * is an example of the condition bits.
407 */
408 if (r->cond && !(r->cond & params->flags))
409 continue;
410
411 /*
412 * The 'deps' array includes maximum four dependencies
413 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fifth
414 * member of this array is a sentinel and should be
415 * negative value.
416 *
417 * This rule should be processed in this time when dependent
418 * parameters were changed at former applications of the other
419 * rules.
420 */
421 for (d = 0; r->deps[d] >= 0; d++) {
422 if (vstamps[r->deps[d]] > rstamps[k])
423 break;
424 }
425 if (r->deps[d] < 0)
426 continue;
427
428 if (trace_hw_mask_param_enabled()) {
429 if (hw_is_mask(r->var))
430 old_mask = *hw_param_mask(params, r->var);
431 }
432 if (trace_hw_interval_param_enabled()) {
433 if (hw_is_interval(r->var))
434 old_interval = *hw_param_interval(params, r->var);
435 }
436
437 changed = r->func(params, r);
438 if (changed < 0) {
439 err = changed;
440 goto out;
441 }
442
443 /*
444 * When the parameter is changed, notify it to the caller
445 * by corresponding returned bit, then preparing for next
446 * iteration.
447 */
448 if (changed && r->var >= 0) {
449 if (hw_is_mask(r->var)) {
450 trace_hw_mask_param(substream, r->var,
451 k + 1, &old_mask,
452 hw_param_mask(params, r->var));
453 }
454 if (hw_is_interval(r->var)) {
455 trace_hw_interval_param(substream, r->var,
456 k + 1, &old_interval,
457 hw_param_interval(params, r->var));
458 }
459
460 params->cmask |= PARAM_MASK_BIT(r->var);
461 vstamps[r->var] = stamp;
462 again = true;
463 }
464
465 rstamps[k] = stamp++;
466 }
467
468 /* Iterate to evaluate all rules till no parameters are changed. */
469 if (again)
470 goto retry;
471
472 out:
473 kfree(rstamps);
474 return err;
475}
476
477static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
478 struct snd_pcm_hw_params *params)
479{
480 const struct snd_interval *i;
481 const struct snd_mask *m;
482 int err;
483
484 if (!params->msbits) {
485 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
486 if (snd_interval_single(i))
487 params->msbits = snd_interval_value(i);
488 }
489
490 if (!params->rate_den) {
491 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
492 if (snd_interval_single(i)) {
493 params->rate_num = snd_interval_value(i);
494 params->rate_den = 1;
495 }
496 }
497
498 if (!params->fifo_size) {
499 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
500 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
501 if (snd_mask_single(m) && snd_interval_single(i)) {
502 err = snd_pcm_ops_ioctl(substream,
503 SNDRV_PCM_IOCTL1_FIFO_SIZE,
504 params);
505 if (err < 0)
506 return err;
507 }
508 }
509
510 if (!params->info) {
511 params->info = substream->runtime->hw.info;
512 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
513 SNDRV_PCM_INFO_DRAIN_TRIGGER);
514 if (!hw_support_mmap(substream))
515 params->info &= ~(SNDRV_PCM_INFO_MMAP |
516 SNDRV_PCM_INFO_MMAP_VALID);
517 }
518
519 return 0;
520}
521
522int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
523 struct snd_pcm_hw_params *params)
524{
525 int err;
526
527 params->info = 0;
528 params->fifo_size = 0;
529 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
530 params->msbits = 0;
531 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
532 params->rate_num = 0;
533 params->rate_den = 0;
534 }
535
536 err = constrain_mask_params(substream, params);
537 if (err < 0)
538 return err;
539
540 err = constrain_interval_params(substream, params);
541 if (err < 0)
542 return err;
543
544 err = constrain_params_by_rules(substream, params);
545 if (err < 0)
546 return err;
547
548 params->rmask = 0;
549
550 return 0;
551}
552EXPORT_SYMBOL(snd_pcm_hw_refine);
553
554static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
555 struct snd_pcm_hw_params __user * _params)
556{
557 struct snd_pcm_hw_params *params;
558 int err;
559
560 params = memdup_user(_params, sizeof(*params));
561 if (IS_ERR(params))
562 return PTR_ERR(params);
563
564 err = snd_pcm_hw_refine(substream, params);
565 if (err < 0)
566 goto end;
567
568 err = fixup_unreferenced_params(substream, params);
569 if (err < 0)
570 goto end;
571
572 if (copy_to_user(_params, params, sizeof(*params)))
573 err = -EFAULT;
574end:
575 kfree(params);
576 return err;
577}
578
579static int period_to_usecs(struct snd_pcm_runtime *runtime)
580{
581 int usecs;
582
583 if (! runtime->rate)
584 return -1; /* invalid */
585
586 /* take 75% of period time as the deadline */
587 usecs = (750000 / runtime->rate) * runtime->period_size;
588 usecs += ((750000 % runtime->rate) * runtime->period_size) /
589 runtime->rate;
590
591 return usecs;
592}
593
594static void snd_pcm_set_state(struct snd_pcm_substream *substream,
595 snd_pcm_state_t state)
596{
597 snd_pcm_stream_lock_irq(substream);
598 if (substream->runtime->state != SNDRV_PCM_STATE_DISCONNECTED)
599 __snd_pcm_set_state(substream->runtime, state);
600 snd_pcm_stream_unlock_irq(substream);
601}
602
603static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
604 int event)
605{
606#ifdef CONFIG_SND_PCM_TIMER
607 if (substream->timer)
608 snd_timer_notify(substream->timer, event,
609 &substream->runtime->trigger_tstamp);
610#endif
611}
612
613void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
614{
615 if (substream->runtime && substream->runtime->stop_operating) {
616 substream->runtime->stop_operating = false;
617 if (substream->ops && substream->ops->sync_stop)
618 substream->ops->sync_stop(substream);
619 else if (sync_irq && substream->pcm->card->sync_irq > 0)
620 synchronize_irq(substream->pcm->card->sync_irq);
621 }
622}
623
624/**
625 * snd_pcm_hw_params_choose - choose a configuration defined by @params
626 * @pcm: PCM instance
627 * @params: the hw_params instance
628 *
629 * Choose one configuration from configuration space defined by @params.
630 * The configuration chosen is that obtained fixing in this order:
631 * first access, first format, first subformat, min channels,
632 * min rate, min period time, max buffer size, min tick time
633 *
634 * Return: Zero if successful, or a negative error code on failure.
635 */
636static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
637 struct snd_pcm_hw_params *params)
638{
639 static const int vars[] = {
640 SNDRV_PCM_HW_PARAM_ACCESS,
641 SNDRV_PCM_HW_PARAM_FORMAT,
642 SNDRV_PCM_HW_PARAM_SUBFORMAT,
643 SNDRV_PCM_HW_PARAM_CHANNELS,
644 SNDRV_PCM_HW_PARAM_RATE,
645 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
646 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
647 SNDRV_PCM_HW_PARAM_TICK_TIME,
648 -1
649 };
650 const int *v;
651 struct snd_mask old_mask __maybe_unused;
652 struct snd_interval old_interval __maybe_unused;
653 int changed;
654
655 for (v = vars; *v != -1; v++) {
656 /* Keep old parameter to trace. */
657 if (trace_hw_mask_param_enabled()) {
658 if (hw_is_mask(*v))
659 old_mask = *hw_param_mask(params, *v);
660 }
661 if (trace_hw_interval_param_enabled()) {
662 if (hw_is_interval(*v))
663 old_interval = *hw_param_interval(params, *v);
664 }
665 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
666 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
667 else
668 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
669 if (changed < 0)
670 return changed;
671 if (changed == 0)
672 continue;
673
674 /* Trace the changed parameter. */
675 if (hw_is_mask(*v)) {
676 trace_hw_mask_param(pcm, *v, 0, &old_mask,
677 hw_param_mask(params, *v));
678 }
679 if (hw_is_interval(*v)) {
680 trace_hw_interval_param(pcm, *v, 0, &old_interval,
681 hw_param_interval(params, *v));
682 }
683 }
684
685 return 0;
686}
687
688/* acquire buffer_mutex; if it's in r/w operation, return -EBUSY, otherwise
689 * block the further r/w operations
690 */
691static int snd_pcm_buffer_access_lock(struct snd_pcm_runtime *runtime)
692{
693 if (!atomic_dec_unless_positive(&runtime->buffer_accessing))
694 return -EBUSY;
695 mutex_lock(&runtime->buffer_mutex);
696 return 0; /* keep buffer_mutex, unlocked by below */
697}
698
699/* release buffer_mutex and clear r/w access flag */
700static void snd_pcm_buffer_access_unlock(struct snd_pcm_runtime *runtime)
701{
702 mutex_unlock(&runtime->buffer_mutex);
703 atomic_inc(&runtime->buffer_accessing);
704}
705
706#if IS_ENABLED(CONFIG_SND_PCM_OSS)
707#define is_oss_stream(substream) ((substream)->oss.oss)
708#else
709#define is_oss_stream(substream) false
710#endif
711
712static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
713 struct snd_pcm_hw_params *params)
714{
715 struct snd_pcm_runtime *runtime;
716 int err, usecs;
717 unsigned int bits;
718 snd_pcm_uframes_t frames;
719
720 if (PCM_RUNTIME_CHECK(substream))
721 return -ENXIO;
722 runtime = substream->runtime;
723 err = snd_pcm_buffer_access_lock(runtime);
724 if (err < 0)
725 return err;
726 snd_pcm_stream_lock_irq(substream);
727 switch (runtime->state) {
728 case SNDRV_PCM_STATE_OPEN:
729 case SNDRV_PCM_STATE_SETUP:
730 case SNDRV_PCM_STATE_PREPARED:
731 if (!is_oss_stream(substream) &&
732 atomic_read(&substream->mmap_count))
733 err = -EBADFD;
734 break;
735 default:
736 err = -EBADFD;
737 break;
738 }
739 snd_pcm_stream_unlock_irq(substream);
740 if (err)
741 goto unlock;
742
743 snd_pcm_sync_stop(substream, true);
744
745 params->rmask = ~0U;
746 err = snd_pcm_hw_refine(substream, params);
747 if (err < 0)
748 goto _error;
749
750 err = snd_pcm_hw_params_choose(substream, params);
751 if (err < 0)
752 goto _error;
753
754 err = fixup_unreferenced_params(substream, params);
755 if (err < 0)
756 goto _error;
757
758 if (substream->managed_buffer_alloc) {
759 err = snd_pcm_lib_malloc_pages(substream,
760 params_buffer_bytes(params));
761 if (err < 0)
762 goto _error;
763 runtime->buffer_changed = err > 0;
764 }
765
766 if (substream->ops->hw_params != NULL) {
767 err = substream->ops->hw_params(substream, params);
768 if (err < 0)
769 goto _error;
770 }
771
772 runtime->access = params_access(params);
773 runtime->format = params_format(params);
774 runtime->subformat = params_subformat(params);
775 runtime->channels = params_channels(params);
776 runtime->rate = params_rate(params);
777 runtime->period_size = params_period_size(params);
778 runtime->periods = params_periods(params);
779 runtime->buffer_size = params_buffer_size(params);
780 runtime->info = params->info;
781 runtime->rate_num = params->rate_num;
782 runtime->rate_den = params->rate_den;
783 runtime->no_period_wakeup =
784 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
785 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
786
787 bits = snd_pcm_format_physical_width(runtime->format);
788 runtime->sample_bits = bits;
789 bits *= runtime->channels;
790 runtime->frame_bits = bits;
791 frames = 1;
792 while (bits % 8 != 0) {
793 bits *= 2;
794 frames *= 2;
795 }
796 runtime->byte_align = bits / 8;
797 runtime->min_align = frames;
798
799 /* Default sw params */
800 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
801 runtime->period_step = 1;
802 runtime->control->avail_min = runtime->period_size;
803 runtime->start_threshold = 1;
804 runtime->stop_threshold = runtime->buffer_size;
805 runtime->silence_threshold = 0;
806 runtime->silence_size = 0;
807 runtime->boundary = runtime->buffer_size;
808 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
809 runtime->boundary *= 2;
810
811 /* clear the buffer for avoiding possible kernel info leaks */
812 if (runtime->dma_area && !substream->ops->copy_user) {
813 size_t size = runtime->dma_bytes;
814
815 if (runtime->info & SNDRV_PCM_INFO_MMAP)
816 size = PAGE_ALIGN(size);
817 memset(runtime->dma_area, 0, size);
818 }
819
820 snd_pcm_timer_resolution_change(substream);
821 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
822
823 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
824 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
825 usecs = period_to_usecs(runtime);
826 if (usecs >= 0)
827 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
828 usecs);
829 err = 0;
830 _error:
831 if (err) {
832 /* hardware might be unusable from this time,
833 * so we force application to retry to set
834 * the correct hardware parameter settings
835 */
836 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
837 if (substream->ops->hw_free != NULL)
838 substream->ops->hw_free(substream);
839 if (substream->managed_buffer_alloc)
840 snd_pcm_lib_free_pages(substream);
841 }
842 unlock:
843 snd_pcm_buffer_access_unlock(runtime);
844 return err;
845}
846
847static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
848 struct snd_pcm_hw_params __user * _params)
849{
850 struct snd_pcm_hw_params *params;
851 int err;
852
853 params = memdup_user(_params, sizeof(*params));
854 if (IS_ERR(params))
855 return PTR_ERR(params);
856
857 err = snd_pcm_hw_params(substream, params);
858 if (err < 0)
859 goto end;
860
861 if (copy_to_user(_params, params, sizeof(*params)))
862 err = -EFAULT;
863end:
864 kfree(params);
865 return err;
866}
867
868static int do_hw_free(struct snd_pcm_substream *substream)
869{
870 int result = 0;
871
872 snd_pcm_sync_stop(substream, true);
873 if (substream->ops->hw_free)
874 result = substream->ops->hw_free(substream);
875 if (substream->managed_buffer_alloc)
876 snd_pcm_lib_free_pages(substream);
877 return result;
878}
879
880static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
881{
882 struct snd_pcm_runtime *runtime;
883 int result = 0;
884
885 if (PCM_RUNTIME_CHECK(substream))
886 return -ENXIO;
887 runtime = substream->runtime;
888 result = snd_pcm_buffer_access_lock(runtime);
889 if (result < 0)
890 return result;
891 snd_pcm_stream_lock_irq(substream);
892 switch (runtime->state) {
893 case SNDRV_PCM_STATE_SETUP:
894 case SNDRV_PCM_STATE_PREPARED:
895 if (atomic_read(&substream->mmap_count))
896 result = -EBADFD;
897 break;
898 default:
899 result = -EBADFD;
900 break;
901 }
902 snd_pcm_stream_unlock_irq(substream);
903 if (result)
904 goto unlock;
905 result = do_hw_free(substream);
906 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
907 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
908 unlock:
909 snd_pcm_buffer_access_unlock(runtime);
910 return result;
911}
912
913static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
914 struct snd_pcm_sw_params *params)
915{
916 struct snd_pcm_runtime *runtime;
917 int err;
918
919 if (PCM_RUNTIME_CHECK(substream))
920 return -ENXIO;
921 runtime = substream->runtime;
922 snd_pcm_stream_lock_irq(substream);
923 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
924 snd_pcm_stream_unlock_irq(substream);
925 return -EBADFD;
926 }
927 snd_pcm_stream_unlock_irq(substream);
928
929 if (params->tstamp_mode < 0 ||
930 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
931 return -EINVAL;
932 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
933 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
934 return -EINVAL;
935 if (params->avail_min == 0)
936 return -EINVAL;
937 if (params->silence_size >= runtime->boundary) {
938 if (params->silence_threshold != 0)
939 return -EINVAL;
940 } else {
941 if (params->silence_size > params->silence_threshold)
942 return -EINVAL;
943 if (params->silence_threshold > runtime->buffer_size)
944 return -EINVAL;
945 }
946 err = 0;
947 snd_pcm_stream_lock_irq(substream);
948 runtime->tstamp_mode = params->tstamp_mode;
949 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
950 runtime->tstamp_type = params->tstamp_type;
951 runtime->period_step = params->period_step;
952 runtime->control->avail_min = params->avail_min;
953 runtime->start_threshold = params->start_threshold;
954 runtime->stop_threshold = params->stop_threshold;
955 runtime->silence_threshold = params->silence_threshold;
956 runtime->silence_size = params->silence_size;
957 params->boundary = runtime->boundary;
958 if (snd_pcm_running(substream)) {
959 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
960 runtime->silence_size > 0)
961 snd_pcm_playback_silence(substream, ULONG_MAX);
962 err = snd_pcm_update_state(substream, runtime);
963 }
964 snd_pcm_stream_unlock_irq(substream);
965 return err;
966}
967
968static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
969 struct snd_pcm_sw_params __user * _params)
970{
971 struct snd_pcm_sw_params params;
972 int err;
973 if (copy_from_user(¶ms, _params, sizeof(params)))
974 return -EFAULT;
975 err = snd_pcm_sw_params(substream, ¶ms);
976 if (copy_to_user(_params, ¶ms, sizeof(params)))
977 return -EFAULT;
978 return err;
979}
980
981static inline snd_pcm_uframes_t
982snd_pcm_calc_delay(struct snd_pcm_substream *substream)
983{
984 snd_pcm_uframes_t delay;
985
986 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
987 delay = snd_pcm_playback_hw_avail(substream->runtime);
988 else
989 delay = snd_pcm_capture_avail(substream->runtime);
990 return delay + substream->runtime->delay;
991}
992
993int snd_pcm_status64(struct snd_pcm_substream *substream,
994 struct snd_pcm_status64 *status)
995{
996 struct snd_pcm_runtime *runtime = substream->runtime;
997
998 snd_pcm_stream_lock_irq(substream);
999
1000 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
1001 &runtime->audio_tstamp_config);
1002
1003 /* backwards compatible behavior */
1004 if (runtime->audio_tstamp_config.type_requested ==
1005 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
1006 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
1007 runtime->audio_tstamp_config.type_requested =
1008 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
1009 else
1010 runtime->audio_tstamp_config.type_requested =
1011 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
1012 runtime->audio_tstamp_report.valid = 0;
1013 } else
1014 runtime->audio_tstamp_report.valid = 1;
1015
1016 status->state = runtime->state;
1017 status->suspended_state = runtime->suspended_state;
1018 if (status->state == SNDRV_PCM_STATE_OPEN)
1019 goto _end;
1020 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
1021 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
1022 if (snd_pcm_running(substream)) {
1023 snd_pcm_update_hw_ptr(substream);
1024 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1025 status->tstamp_sec = runtime->status->tstamp.tv_sec;
1026 status->tstamp_nsec =
1027 runtime->status->tstamp.tv_nsec;
1028 status->driver_tstamp_sec =
1029 runtime->driver_tstamp.tv_sec;
1030 status->driver_tstamp_nsec =
1031 runtime->driver_tstamp.tv_nsec;
1032 status->audio_tstamp_sec =
1033 runtime->status->audio_tstamp.tv_sec;
1034 status->audio_tstamp_nsec =
1035 runtime->status->audio_tstamp.tv_nsec;
1036 if (runtime->audio_tstamp_report.valid == 1)
1037 /* backwards compatibility, no report provided in COMPAT mode */
1038 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
1039 &status->audio_tstamp_accuracy,
1040 &runtime->audio_tstamp_report);
1041
1042 goto _tstamp_end;
1043 }
1044 } else {
1045 /* get tstamp only in fallback mode and only if enabled */
1046 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1047 struct timespec64 tstamp;
1048
1049 snd_pcm_gettime(runtime, &tstamp);
1050 status->tstamp_sec = tstamp.tv_sec;
1051 status->tstamp_nsec = tstamp.tv_nsec;
1052 }
1053 }
1054 _tstamp_end:
1055 status->appl_ptr = runtime->control->appl_ptr;
1056 status->hw_ptr = runtime->status->hw_ptr;
1057 status->avail = snd_pcm_avail(substream);
1058 status->delay = snd_pcm_running(substream) ?
1059 snd_pcm_calc_delay(substream) : 0;
1060 status->avail_max = runtime->avail_max;
1061 status->overrange = runtime->overrange;
1062 runtime->avail_max = 0;
1063 runtime->overrange = 0;
1064 _end:
1065 snd_pcm_stream_unlock_irq(substream);
1066 return 0;
1067}
1068
1069static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1070 struct snd_pcm_status64 __user * _status,
1071 bool ext)
1072{
1073 struct snd_pcm_status64 status;
1074 int res;
1075
1076 memset(&status, 0, sizeof(status));
1077 /*
1078 * with extension, parameters are read/write,
1079 * get audio_tstamp_data from user,
1080 * ignore rest of status structure
1081 */
1082 if (ext && get_user(status.audio_tstamp_data,
1083 (u32 __user *)(&_status->audio_tstamp_data)))
1084 return -EFAULT;
1085 res = snd_pcm_status64(substream, &status);
1086 if (res < 0)
1087 return res;
1088 if (copy_to_user(_status, &status, sizeof(status)))
1089 return -EFAULT;
1090 return 0;
1091}
1092
1093static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1094 struct snd_pcm_status32 __user * _status,
1095 bool ext)
1096{
1097 struct snd_pcm_status64 status64;
1098 struct snd_pcm_status32 status32;
1099 int res;
1100
1101 memset(&status64, 0, sizeof(status64));
1102 memset(&status32, 0, sizeof(status32));
1103 /*
1104 * with extension, parameters are read/write,
1105 * get audio_tstamp_data from user,
1106 * ignore rest of status structure
1107 */
1108 if (ext && get_user(status64.audio_tstamp_data,
1109 (u32 __user *)(&_status->audio_tstamp_data)))
1110 return -EFAULT;
1111 res = snd_pcm_status64(substream, &status64);
1112 if (res < 0)
1113 return res;
1114
1115 status32 = (struct snd_pcm_status32) {
1116 .state = status64.state,
1117 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1118 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1119 .tstamp_sec = status64.tstamp_sec,
1120 .tstamp_nsec = status64.tstamp_nsec,
1121 .appl_ptr = status64.appl_ptr,
1122 .hw_ptr = status64.hw_ptr,
1123 .delay = status64.delay,
1124 .avail = status64.avail,
1125 .avail_max = status64.avail_max,
1126 .overrange = status64.overrange,
1127 .suspended_state = status64.suspended_state,
1128 .audio_tstamp_data = status64.audio_tstamp_data,
1129 .audio_tstamp_sec = status64.audio_tstamp_sec,
1130 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1131 .driver_tstamp_sec = status64.audio_tstamp_sec,
1132 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1133 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1134 };
1135
1136 if (copy_to_user(_status, &status32, sizeof(status32)))
1137 return -EFAULT;
1138
1139 return 0;
1140}
1141
1142static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1143 struct snd_pcm_channel_info * info)
1144{
1145 struct snd_pcm_runtime *runtime;
1146 unsigned int channel;
1147
1148 channel = info->channel;
1149 runtime = substream->runtime;
1150 snd_pcm_stream_lock_irq(substream);
1151 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
1152 snd_pcm_stream_unlock_irq(substream);
1153 return -EBADFD;
1154 }
1155 snd_pcm_stream_unlock_irq(substream);
1156 if (channel >= runtime->channels)
1157 return -EINVAL;
1158 memset(info, 0, sizeof(*info));
1159 info->channel = channel;
1160 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1161}
1162
1163static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1164 struct snd_pcm_channel_info __user * _info)
1165{
1166 struct snd_pcm_channel_info info;
1167 int res;
1168
1169 if (copy_from_user(&info, _info, sizeof(info)))
1170 return -EFAULT;
1171 res = snd_pcm_channel_info(substream, &info);
1172 if (res < 0)
1173 return res;
1174 if (copy_to_user(_info, &info, sizeof(info)))
1175 return -EFAULT;
1176 return 0;
1177}
1178
1179static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1180{
1181 struct snd_pcm_runtime *runtime = substream->runtime;
1182 if (runtime->trigger_master == NULL)
1183 return;
1184 if (runtime->trigger_master == substream) {
1185 if (!runtime->trigger_tstamp_latched)
1186 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1187 } else {
1188 snd_pcm_trigger_tstamp(runtime->trigger_master);
1189 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1190 }
1191 runtime->trigger_master = NULL;
1192}
1193
1194#define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1195
1196struct action_ops {
1197 int (*pre_action)(struct snd_pcm_substream *substream,
1198 snd_pcm_state_t state);
1199 int (*do_action)(struct snd_pcm_substream *substream,
1200 snd_pcm_state_t state);
1201 void (*undo_action)(struct snd_pcm_substream *substream,
1202 snd_pcm_state_t state);
1203 void (*post_action)(struct snd_pcm_substream *substream,
1204 snd_pcm_state_t state);
1205};
1206
1207/*
1208 * this functions is core for handling of linked stream
1209 * Note: the stream state might be changed also on failure
1210 * Note2: call with calling stream lock + link lock
1211 */
1212static int snd_pcm_action_group(const struct action_ops *ops,
1213 struct snd_pcm_substream *substream,
1214 snd_pcm_state_t state,
1215 bool stream_lock)
1216{
1217 struct snd_pcm_substream *s = NULL;
1218 struct snd_pcm_substream *s1;
1219 int res = 0, depth = 1;
1220
1221 snd_pcm_group_for_each_entry(s, substream) {
1222 if (s != substream) {
1223 if (!stream_lock)
1224 mutex_lock_nested(&s->runtime->buffer_mutex, depth);
1225 else if (s->pcm->nonatomic)
1226 mutex_lock_nested(&s->self_group.mutex, depth);
1227 else
1228 spin_lock_nested(&s->self_group.lock, depth);
1229 depth++;
1230 }
1231 res = ops->pre_action(s, state);
1232 if (res < 0)
1233 goto _unlock;
1234 }
1235 snd_pcm_group_for_each_entry(s, substream) {
1236 res = ops->do_action(s, state);
1237 if (res < 0) {
1238 if (ops->undo_action) {
1239 snd_pcm_group_for_each_entry(s1, substream) {
1240 if (s1 == s) /* failed stream */
1241 break;
1242 ops->undo_action(s1, state);
1243 }
1244 }
1245 s = NULL; /* unlock all */
1246 goto _unlock;
1247 }
1248 }
1249 snd_pcm_group_for_each_entry(s, substream) {
1250 ops->post_action(s, state);
1251 }
1252 _unlock:
1253 /* unlock streams */
1254 snd_pcm_group_for_each_entry(s1, substream) {
1255 if (s1 != substream) {
1256 if (!stream_lock)
1257 mutex_unlock(&s1->runtime->buffer_mutex);
1258 else if (s1->pcm->nonatomic)
1259 mutex_unlock(&s1->self_group.mutex);
1260 else
1261 spin_unlock(&s1->self_group.lock);
1262 }
1263 if (s1 == s) /* end */
1264 break;
1265 }
1266 return res;
1267}
1268
1269/*
1270 * Note: call with stream lock
1271 */
1272static int snd_pcm_action_single(const struct action_ops *ops,
1273 struct snd_pcm_substream *substream,
1274 snd_pcm_state_t state)
1275{
1276 int res;
1277
1278 res = ops->pre_action(substream, state);
1279 if (res < 0)
1280 return res;
1281 res = ops->do_action(substream, state);
1282 if (res == 0)
1283 ops->post_action(substream, state);
1284 else if (ops->undo_action)
1285 ops->undo_action(substream, state);
1286 return res;
1287}
1288
1289static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1290 struct snd_pcm_group *new_group)
1291{
1292 substream->group = new_group;
1293 list_move(&substream->link_list, &new_group->substreams);
1294}
1295
1296/*
1297 * Unref and unlock the group, but keep the stream lock;
1298 * when the group becomes empty and no longer referred, destroy itself
1299 */
1300static void snd_pcm_group_unref(struct snd_pcm_group *group,
1301 struct snd_pcm_substream *substream)
1302{
1303 bool do_free;
1304
1305 if (!group)
1306 return;
1307 do_free = refcount_dec_and_test(&group->refs);
1308 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1309 if (do_free)
1310 kfree(group);
1311}
1312
1313/*
1314 * Lock the group inside a stream lock and reference it;
1315 * return the locked group object, or NULL if not linked
1316 */
1317static struct snd_pcm_group *
1318snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1319{
1320 bool nonatomic = substream->pcm->nonatomic;
1321 struct snd_pcm_group *group;
1322 bool trylock;
1323
1324 for (;;) {
1325 if (!snd_pcm_stream_linked(substream))
1326 return NULL;
1327 group = substream->group;
1328 /* block freeing the group object */
1329 refcount_inc(&group->refs);
1330
1331 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1332 spin_trylock(&group->lock);
1333 if (trylock)
1334 break; /* OK */
1335
1336 /* re-lock for avoiding ABBA deadlock */
1337 snd_pcm_stream_unlock(substream);
1338 snd_pcm_group_lock(group, nonatomic);
1339 snd_pcm_stream_lock(substream);
1340
1341 /* check the group again; the above opens a small race window */
1342 if (substream->group == group)
1343 break; /* OK */
1344 /* group changed, try again */
1345 snd_pcm_group_unref(group, substream);
1346 }
1347 return group;
1348}
1349
1350/*
1351 * Note: call with stream lock
1352 */
1353static int snd_pcm_action(const struct action_ops *ops,
1354 struct snd_pcm_substream *substream,
1355 snd_pcm_state_t state)
1356{
1357 struct snd_pcm_group *group;
1358 int res;
1359
1360 group = snd_pcm_stream_group_ref(substream);
1361 if (group)
1362 res = snd_pcm_action_group(ops, substream, state, true);
1363 else
1364 res = snd_pcm_action_single(ops, substream, state);
1365 snd_pcm_group_unref(group, substream);
1366 return res;
1367}
1368
1369/*
1370 * Note: don't use any locks before
1371 */
1372static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1373 struct snd_pcm_substream *substream,
1374 snd_pcm_state_t state)
1375{
1376 int res;
1377
1378 snd_pcm_stream_lock_irq(substream);
1379 res = snd_pcm_action(ops, substream, state);
1380 snd_pcm_stream_unlock_irq(substream);
1381 return res;
1382}
1383
1384/*
1385 */
1386static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1387 struct snd_pcm_substream *substream,
1388 snd_pcm_state_t state)
1389{
1390 int res;
1391
1392 /* Guarantee the group members won't change during non-atomic action */
1393 down_read(&snd_pcm_link_rwsem);
1394 res = snd_pcm_buffer_access_lock(substream->runtime);
1395 if (res < 0)
1396 goto unlock;
1397 if (snd_pcm_stream_linked(substream))
1398 res = snd_pcm_action_group(ops, substream, state, false);
1399 else
1400 res = snd_pcm_action_single(ops, substream, state);
1401 snd_pcm_buffer_access_unlock(substream->runtime);
1402 unlock:
1403 up_read(&snd_pcm_link_rwsem);
1404 return res;
1405}
1406
1407/*
1408 * start callbacks
1409 */
1410static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1411 snd_pcm_state_t state)
1412{
1413 struct snd_pcm_runtime *runtime = substream->runtime;
1414 if (runtime->state != SNDRV_PCM_STATE_PREPARED)
1415 return -EBADFD;
1416 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1417 !snd_pcm_playback_data(substream))
1418 return -EPIPE;
1419 runtime->trigger_tstamp_latched = false;
1420 runtime->trigger_master = substream;
1421 return 0;
1422}
1423
1424static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1425 snd_pcm_state_t state)
1426{
1427 int err;
1428
1429 if (substream->runtime->trigger_master != substream)
1430 return 0;
1431 err = substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1432 /* XRUN happened during the start */
1433 if (err == -EPIPE)
1434 __snd_pcm_set_state(substream->runtime, SNDRV_PCM_STATE_XRUN);
1435 return err;
1436}
1437
1438static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1439 snd_pcm_state_t state)
1440{
1441 if (substream->runtime->trigger_master == substream) {
1442 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1443 substream->runtime->stop_operating = true;
1444 }
1445}
1446
1447static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1448 snd_pcm_state_t state)
1449{
1450 struct snd_pcm_runtime *runtime = substream->runtime;
1451 snd_pcm_trigger_tstamp(substream);
1452 runtime->hw_ptr_jiffies = jiffies;
1453 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1454 runtime->rate;
1455 __snd_pcm_set_state(runtime, state);
1456 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1457 runtime->silence_size > 0)
1458 snd_pcm_playback_silence(substream, ULONG_MAX);
1459 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1460}
1461
1462static const struct action_ops snd_pcm_action_start = {
1463 .pre_action = snd_pcm_pre_start,
1464 .do_action = snd_pcm_do_start,
1465 .undo_action = snd_pcm_undo_start,
1466 .post_action = snd_pcm_post_start
1467};
1468
1469/**
1470 * snd_pcm_start - start all linked streams
1471 * @substream: the PCM substream instance
1472 *
1473 * Return: Zero if successful, or a negative error code.
1474 * The stream lock must be acquired before calling this function.
1475 */
1476int snd_pcm_start(struct snd_pcm_substream *substream)
1477{
1478 return snd_pcm_action(&snd_pcm_action_start, substream,
1479 SNDRV_PCM_STATE_RUNNING);
1480}
1481
1482/* take the stream lock and start the streams */
1483static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1484{
1485 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1486 SNDRV_PCM_STATE_RUNNING);
1487}
1488
1489/*
1490 * stop callbacks
1491 */
1492static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1493 snd_pcm_state_t state)
1494{
1495 struct snd_pcm_runtime *runtime = substream->runtime;
1496 if (runtime->state == SNDRV_PCM_STATE_OPEN)
1497 return -EBADFD;
1498 runtime->trigger_master = substream;
1499 return 0;
1500}
1501
1502static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1503 snd_pcm_state_t state)
1504{
1505 if (substream->runtime->trigger_master == substream &&
1506 snd_pcm_running(substream)) {
1507 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1508 substream->runtime->stop_operating = true;
1509 }
1510 return 0; /* unconditionally stop all substreams */
1511}
1512
1513static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1514 snd_pcm_state_t state)
1515{
1516 struct snd_pcm_runtime *runtime = substream->runtime;
1517 if (runtime->state != state) {
1518 snd_pcm_trigger_tstamp(substream);
1519 __snd_pcm_set_state(runtime, state);
1520 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1521 }
1522 wake_up(&runtime->sleep);
1523 wake_up(&runtime->tsleep);
1524}
1525
1526static const struct action_ops snd_pcm_action_stop = {
1527 .pre_action = snd_pcm_pre_stop,
1528 .do_action = snd_pcm_do_stop,
1529 .post_action = snd_pcm_post_stop
1530};
1531
1532/**
1533 * snd_pcm_stop - try to stop all running streams in the substream group
1534 * @substream: the PCM substream instance
1535 * @state: PCM state after stopping the stream
1536 *
1537 * The state of each stream is then changed to the given state unconditionally.
1538 *
1539 * Return: Zero if successful, or a negative error code.
1540 */
1541int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1542{
1543 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1544}
1545EXPORT_SYMBOL(snd_pcm_stop);
1546
1547/**
1548 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1549 * @substream: the PCM substream
1550 *
1551 * After stopping, the state is changed to SETUP.
1552 * Unlike snd_pcm_stop(), this affects only the given stream.
1553 *
1554 * Return: Zero if successful, or a negative error code.
1555 */
1556int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1557{
1558 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1559 SNDRV_PCM_STATE_SETUP);
1560}
1561
1562/**
1563 * snd_pcm_stop_xrun - stop the running streams as XRUN
1564 * @substream: the PCM substream instance
1565 *
1566 * This stops the given running substream (and all linked substreams) as XRUN.
1567 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1568 *
1569 * Return: Zero if successful, or a negative error code.
1570 */
1571int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1572{
1573 unsigned long flags;
1574
1575 snd_pcm_stream_lock_irqsave(substream, flags);
1576 if (substream->runtime && snd_pcm_running(substream))
1577 __snd_pcm_xrun(substream);
1578 snd_pcm_stream_unlock_irqrestore(substream, flags);
1579 return 0;
1580}
1581EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1582
1583/*
1584 * pause callbacks: pass boolean (to start pause or resume) as state argument
1585 */
1586#define pause_pushed(state) (__force bool)(state)
1587
1588static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1589 snd_pcm_state_t state)
1590{
1591 struct snd_pcm_runtime *runtime = substream->runtime;
1592 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1593 return -ENOSYS;
1594 if (pause_pushed(state)) {
1595 if (runtime->state != SNDRV_PCM_STATE_RUNNING)
1596 return -EBADFD;
1597 } else if (runtime->state != SNDRV_PCM_STATE_PAUSED)
1598 return -EBADFD;
1599 runtime->trigger_master = substream;
1600 return 0;
1601}
1602
1603static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1604 snd_pcm_state_t state)
1605{
1606 if (substream->runtime->trigger_master != substream)
1607 return 0;
1608 /* some drivers might use hw_ptr to recover from the pause -
1609 update the hw_ptr now */
1610 if (pause_pushed(state))
1611 snd_pcm_update_hw_ptr(substream);
1612 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1613 * a delta between the current jiffies, this gives a large enough
1614 * delta, effectively to skip the check once.
1615 */
1616 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1617 return substream->ops->trigger(substream,
1618 pause_pushed(state) ?
1619 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1620 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1621}
1622
1623static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1624 snd_pcm_state_t state)
1625{
1626 if (substream->runtime->trigger_master == substream)
1627 substream->ops->trigger(substream,
1628 pause_pushed(state) ?
1629 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1630 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1631}
1632
1633static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1634 snd_pcm_state_t state)
1635{
1636 struct snd_pcm_runtime *runtime = substream->runtime;
1637 snd_pcm_trigger_tstamp(substream);
1638 if (pause_pushed(state)) {
1639 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_PAUSED);
1640 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1641 wake_up(&runtime->sleep);
1642 wake_up(&runtime->tsleep);
1643 } else {
1644 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_RUNNING);
1645 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1646 }
1647}
1648
1649static const struct action_ops snd_pcm_action_pause = {
1650 .pre_action = snd_pcm_pre_pause,
1651 .do_action = snd_pcm_do_pause,
1652 .undo_action = snd_pcm_undo_pause,
1653 .post_action = snd_pcm_post_pause
1654};
1655
1656/*
1657 * Push/release the pause for all linked streams.
1658 */
1659static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1660{
1661 return snd_pcm_action(&snd_pcm_action_pause, substream,
1662 (__force snd_pcm_state_t)push);
1663}
1664
1665static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1666 bool push)
1667{
1668 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1669 (__force snd_pcm_state_t)push);
1670}
1671
1672#ifdef CONFIG_PM
1673/* suspend callback: state argument ignored */
1674
1675static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1676 snd_pcm_state_t state)
1677{
1678 struct snd_pcm_runtime *runtime = substream->runtime;
1679 switch (runtime->state) {
1680 case SNDRV_PCM_STATE_SUSPENDED:
1681 return -EBUSY;
1682 /* unresumable PCM state; return -EBUSY for skipping suspend */
1683 case SNDRV_PCM_STATE_OPEN:
1684 case SNDRV_PCM_STATE_SETUP:
1685 case SNDRV_PCM_STATE_DISCONNECTED:
1686 return -EBUSY;
1687 }
1688 runtime->trigger_master = substream;
1689 return 0;
1690}
1691
1692static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1693 snd_pcm_state_t state)
1694{
1695 struct snd_pcm_runtime *runtime = substream->runtime;
1696 if (runtime->trigger_master != substream)
1697 return 0;
1698 if (! snd_pcm_running(substream))
1699 return 0;
1700 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1701 runtime->stop_operating = true;
1702 return 0; /* suspend unconditionally */
1703}
1704
1705static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1706 snd_pcm_state_t state)
1707{
1708 struct snd_pcm_runtime *runtime = substream->runtime;
1709 snd_pcm_trigger_tstamp(substream);
1710 runtime->suspended_state = runtime->state;
1711 runtime->status->suspended_state = runtime->suspended_state;
1712 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SUSPENDED);
1713 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1714 wake_up(&runtime->sleep);
1715 wake_up(&runtime->tsleep);
1716}
1717
1718static const struct action_ops snd_pcm_action_suspend = {
1719 .pre_action = snd_pcm_pre_suspend,
1720 .do_action = snd_pcm_do_suspend,
1721 .post_action = snd_pcm_post_suspend
1722};
1723
1724/*
1725 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1726 * @substream: the PCM substream
1727 *
1728 * After this call, all streams are changed to SUSPENDED state.
1729 *
1730 * Return: Zero if successful, or a negative error code.
1731 */
1732static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1733{
1734 int err;
1735 unsigned long flags;
1736
1737 snd_pcm_stream_lock_irqsave(substream, flags);
1738 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1739 ACTION_ARG_IGNORE);
1740 snd_pcm_stream_unlock_irqrestore(substream, flags);
1741 return err;
1742}
1743
1744/**
1745 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1746 * @pcm: the PCM instance
1747 *
1748 * After this call, all streams are changed to SUSPENDED state.
1749 *
1750 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1751 */
1752int snd_pcm_suspend_all(struct snd_pcm *pcm)
1753{
1754 struct snd_pcm_substream *substream;
1755 int stream, err = 0;
1756
1757 if (! pcm)
1758 return 0;
1759
1760 for_each_pcm_substream(pcm, stream, substream) {
1761 /* FIXME: the open/close code should lock this as well */
1762 if (!substream->runtime)
1763 continue;
1764
1765 /*
1766 * Skip BE dai link PCM's that are internal and may
1767 * not have their substream ops set.
1768 */
1769 if (!substream->ops)
1770 continue;
1771
1772 err = snd_pcm_suspend(substream);
1773 if (err < 0 && err != -EBUSY)
1774 return err;
1775 }
1776
1777 for_each_pcm_substream(pcm, stream, substream)
1778 snd_pcm_sync_stop(substream, false);
1779
1780 return 0;
1781}
1782EXPORT_SYMBOL(snd_pcm_suspend_all);
1783
1784/* resume callbacks: state argument ignored */
1785
1786static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1787 snd_pcm_state_t state)
1788{
1789 struct snd_pcm_runtime *runtime = substream->runtime;
1790 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1791 return -ENOSYS;
1792 runtime->trigger_master = substream;
1793 return 0;
1794}
1795
1796static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1797 snd_pcm_state_t state)
1798{
1799 struct snd_pcm_runtime *runtime = substream->runtime;
1800 if (runtime->trigger_master != substream)
1801 return 0;
1802 /* DMA not running previously? */
1803 if (runtime->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1804 (runtime->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1805 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1806 return 0;
1807 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1808}
1809
1810static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1811 snd_pcm_state_t state)
1812{
1813 if (substream->runtime->trigger_master == substream &&
1814 snd_pcm_running(substream))
1815 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1816}
1817
1818static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1819 snd_pcm_state_t state)
1820{
1821 struct snd_pcm_runtime *runtime = substream->runtime;
1822 snd_pcm_trigger_tstamp(substream);
1823 __snd_pcm_set_state(runtime, runtime->suspended_state);
1824 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1825}
1826
1827static const struct action_ops snd_pcm_action_resume = {
1828 .pre_action = snd_pcm_pre_resume,
1829 .do_action = snd_pcm_do_resume,
1830 .undo_action = snd_pcm_undo_resume,
1831 .post_action = snd_pcm_post_resume
1832};
1833
1834static int snd_pcm_resume(struct snd_pcm_substream *substream)
1835{
1836 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1837 ACTION_ARG_IGNORE);
1838}
1839
1840#else
1841
1842static int snd_pcm_resume(struct snd_pcm_substream *substream)
1843{
1844 return -ENOSYS;
1845}
1846
1847#endif /* CONFIG_PM */
1848
1849/*
1850 * xrun ioctl
1851 *
1852 * Change the RUNNING stream(s) to XRUN state.
1853 */
1854static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1855{
1856 struct snd_pcm_runtime *runtime = substream->runtime;
1857 int result;
1858
1859 snd_pcm_stream_lock_irq(substream);
1860 switch (runtime->state) {
1861 case SNDRV_PCM_STATE_XRUN:
1862 result = 0; /* already there */
1863 break;
1864 case SNDRV_PCM_STATE_RUNNING:
1865 __snd_pcm_xrun(substream);
1866 result = 0;
1867 break;
1868 default:
1869 result = -EBADFD;
1870 }
1871 snd_pcm_stream_unlock_irq(substream);
1872 return result;
1873}
1874
1875/*
1876 * reset ioctl
1877 */
1878/* reset callbacks: state argument ignored */
1879static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1880 snd_pcm_state_t state)
1881{
1882 struct snd_pcm_runtime *runtime = substream->runtime;
1883 switch (runtime->state) {
1884 case SNDRV_PCM_STATE_RUNNING:
1885 case SNDRV_PCM_STATE_PREPARED:
1886 case SNDRV_PCM_STATE_PAUSED:
1887 case SNDRV_PCM_STATE_SUSPENDED:
1888 return 0;
1889 default:
1890 return -EBADFD;
1891 }
1892}
1893
1894static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1895 snd_pcm_state_t state)
1896{
1897 struct snd_pcm_runtime *runtime = substream->runtime;
1898 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1899 if (err < 0)
1900 return err;
1901 snd_pcm_stream_lock_irq(substream);
1902 runtime->hw_ptr_base = 0;
1903 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1904 runtime->status->hw_ptr % runtime->period_size;
1905 runtime->silence_start = runtime->status->hw_ptr;
1906 runtime->silence_filled = 0;
1907 snd_pcm_stream_unlock_irq(substream);
1908 return 0;
1909}
1910
1911static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1912 snd_pcm_state_t state)
1913{
1914 struct snd_pcm_runtime *runtime = substream->runtime;
1915 snd_pcm_stream_lock_irq(substream);
1916 runtime->control->appl_ptr = runtime->status->hw_ptr;
1917 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1918 runtime->silence_size > 0)
1919 snd_pcm_playback_silence(substream, ULONG_MAX);
1920 snd_pcm_stream_unlock_irq(substream);
1921}
1922
1923static const struct action_ops snd_pcm_action_reset = {
1924 .pre_action = snd_pcm_pre_reset,
1925 .do_action = snd_pcm_do_reset,
1926 .post_action = snd_pcm_post_reset
1927};
1928
1929static int snd_pcm_reset(struct snd_pcm_substream *substream)
1930{
1931 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1932 ACTION_ARG_IGNORE);
1933}
1934
1935/*
1936 * prepare ioctl
1937 */
1938/* pass f_flags as state argument */
1939static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1940 snd_pcm_state_t state)
1941{
1942 struct snd_pcm_runtime *runtime = substream->runtime;
1943 int f_flags = (__force int)state;
1944
1945 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
1946 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
1947 return -EBADFD;
1948 if (snd_pcm_running(substream))
1949 return -EBUSY;
1950 substream->f_flags = f_flags;
1951 return 0;
1952}
1953
1954static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1955 snd_pcm_state_t state)
1956{
1957 int err;
1958 snd_pcm_sync_stop(substream, true);
1959 err = substream->ops->prepare(substream);
1960 if (err < 0)
1961 return err;
1962 return snd_pcm_do_reset(substream, state);
1963}
1964
1965static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1966 snd_pcm_state_t state)
1967{
1968 struct snd_pcm_runtime *runtime = substream->runtime;
1969 runtime->control->appl_ptr = runtime->status->hw_ptr;
1970 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1971}
1972
1973static const struct action_ops snd_pcm_action_prepare = {
1974 .pre_action = snd_pcm_pre_prepare,
1975 .do_action = snd_pcm_do_prepare,
1976 .post_action = snd_pcm_post_prepare
1977};
1978
1979/**
1980 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1981 * @substream: the PCM substream instance
1982 * @file: file to refer f_flags
1983 *
1984 * Return: Zero if successful, or a negative error code.
1985 */
1986static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1987 struct file *file)
1988{
1989 int f_flags;
1990
1991 if (file)
1992 f_flags = file->f_flags;
1993 else
1994 f_flags = substream->f_flags;
1995
1996 snd_pcm_stream_lock_irq(substream);
1997 switch (substream->runtime->state) {
1998 case SNDRV_PCM_STATE_PAUSED:
1999 snd_pcm_pause(substream, false);
2000 fallthrough;
2001 case SNDRV_PCM_STATE_SUSPENDED:
2002 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2003 break;
2004 }
2005 snd_pcm_stream_unlock_irq(substream);
2006
2007 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
2008 substream,
2009 (__force snd_pcm_state_t)f_flags);
2010}
2011
2012/*
2013 * drain ioctl
2014 */
2015
2016/* drain init callbacks: state argument ignored */
2017static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
2018 snd_pcm_state_t state)
2019{
2020 struct snd_pcm_runtime *runtime = substream->runtime;
2021 switch (runtime->state) {
2022 case SNDRV_PCM_STATE_OPEN:
2023 case SNDRV_PCM_STATE_DISCONNECTED:
2024 case SNDRV_PCM_STATE_SUSPENDED:
2025 return -EBADFD;
2026 }
2027 runtime->trigger_master = substream;
2028 return 0;
2029}
2030
2031static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
2032 snd_pcm_state_t state)
2033{
2034 struct snd_pcm_runtime *runtime = substream->runtime;
2035 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
2036 switch (runtime->state) {
2037 case SNDRV_PCM_STATE_PREPARED:
2038 /* start playback stream if possible */
2039 if (! snd_pcm_playback_empty(substream)) {
2040 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
2041 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
2042 } else {
2043 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2044 }
2045 break;
2046 case SNDRV_PCM_STATE_RUNNING:
2047 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_DRAINING);
2048 break;
2049 case SNDRV_PCM_STATE_XRUN:
2050 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2051 break;
2052 default:
2053 break;
2054 }
2055 } else {
2056 /* stop running stream */
2057 if (runtime->state == SNDRV_PCM_STATE_RUNNING) {
2058 snd_pcm_state_t new_state;
2059
2060 new_state = snd_pcm_capture_avail(runtime) > 0 ?
2061 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
2062 snd_pcm_do_stop(substream, new_state);
2063 snd_pcm_post_stop(substream, new_state);
2064 }
2065 }
2066
2067 if (runtime->state == SNDRV_PCM_STATE_DRAINING &&
2068 runtime->trigger_master == substream &&
2069 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
2070 return substream->ops->trigger(substream,
2071 SNDRV_PCM_TRIGGER_DRAIN);
2072
2073 return 0;
2074}
2075
2076static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
2077 snd_pcm_state_t state)
2078{
2079}
2080
2081static const struct action_ops snd_pcm_action_drain_init = {
2082 .pre_action = snd_pcm_pre_drain_init,
2083 .do_action = snd_pcm_do_drain_init,
2084 .post_action = snd_pcm_post_drain_init
2085};
2086
2087/*
2088 * Drain the stream(s).
2089 * When the substream is linked, sync until the draining of all playback streams
2090 * is finished.
2091 * After this call, all streams are supposed to be either SETUP or DRAINING
2092 * (capture only) state.
2093 */
2094static int snd_pcm_drain(struct snd_pcm_substream *substream,
2095 struct file *file)
2096{
2097 struct snd_card *card;
2098 struct snd_pcm_runtime *runtime;
2099 struct snd_pcm_substream *s;
2100 struct snd_pcm_group *group;
2101 wait_queue_entry_t wait;
2102 int result = 0;
2103 int nonblock = 0;
2104
2105 card = substream->pcm->card;
2106 runtime = substream->runtime;
2107
2108 if (runtime->state == SNDRV_PCM_STATE_OPEN)
2109 return -EBADFD;
2110
2111 if (file) {
2112 if (file->f_flags & O_NONBLOCK)
2113 nonblock = 1;
2114 } else if (substream->f_flags & O_NONBLOCK)
2115 nonblock = 1;
2116
2117 snd_pcm_stream_lock_irq(substream);
2118 /* resume pause */
2119 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2120 snd_pcm_pause(substream, false);
2121
2122 /* pre-start/stop - all running streams are changed to DRAINING state */
2123 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2124 ACTION_ARG_IGNORE);
2125 if (result < 0)
2126 goto unlock;
2127 /* in non-blocking, we don't wait in ioctl but let caller poll */
2128 if (nonblock) {
2129 result = -EAGAIN;
2130 goto unlock;
2131 }
2132
2133 for (;;) {
2134 long tout;
2135 struct snd_pcm_runtime *to_check;
2136 if (signal_pending(current)) {
2137 result = -ERESTARTSYS;
2138 break;
2139 }
2140 /* find a substream to drain */
2141 to_check = NULL;
2142 group = snd_pcm_stream_group_ref(substream);
2143 snd_pcm_group_for_each_entry(s, substream) {
2144 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2145 continue;
2146 runtime = s->runtime;
2147 if (runtime->state == SNDRV_PCM_STATE_DRAINING) {
2148 to_check = runtime;
2149 break;
2150 }
2151 }
2152 snd_pcm_group_unref(group, substream);
2153 if (!to_check)
2154 break; /* all drained */
2155 init_waitqueue_entry(&wait, current);
2156 set_current_state(TASK_INTERRUPTIBLE);
2157 add_wait_queue(&to_check->sleep, &wait);
2158 snd_pcm_stream_unlock_irq(substream);
2159 if (runtime->no_period_wakeup)
2160 tout = MAX_SCHEDULE_TIMEOUT;
2161 else {
2162 tout = 10;
2163 if (runtime->rate) {
2164 long t = runtime->period_size * 2 / runtime->rate;
2165 tout = max(t, tout);
2166 }
2167 tout = msecs_to_jiffies(tout * 1000);
2168 }
2169 tout = schedule_timeout(tout);
2170
2171 snd_pcm_stream_lock_irq(substream);
2172 group = snd_pcm_stream_group_ref(substream);
2173 snd_pcm_group_for_each_entry(s, substream) {
2174 if (s->runtime == to_check) {
2175 remove_wait_queue(&to_check->sleep, &wait);
2176 break;
2177 }
2178 }
2179 snd_pcm_group_unref(group, substream);
2180
2181 if (card->shutdown) {
2182 result = -ENODEV;
2183 break;
2184 }
2185 if (tout == 0) {
2186 if (substream->runtime->state == SNDRV_PCM_STATE_SUSPENDED)
2187 result = -ESTRPIPE;
2188 else {
2189 dev_dbg(substream->pcm->card->dev,
2190 "playback drain error (DMA or IRQ trouble?)\n");
2191 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2192 result = -EIO;
2193 }
2194 break;
2195 }
2196 }
2197
2198 unlock:
2199 snd_pcm_stream_unlock_irq(substream);
2200
2201 return result;
2202}
2203
2204/*
2205 * drop ioctl
2206 *
2207 * Immediately put all linked substreams into SETUP state.
2208 */
2209static int snd_pcm_drop(struct snd_pcm_substream *substream)
2210{
2211 struct snd_pcm_runtime *runtime;
2212 int result = 0;
2213
2214 if (PCM_RUNTIME_CHECK(substream))
2215 return -ENXIO;
2216 runtime = substream->runtime;
2217
2218 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
2219 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
2220 return -EBADFD;
2221
2222 snd_pcm_stream_lock_irq(substream);
2223 /* resume pause */
2224 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2225 snd_pcm_pause(substream, false);
2226
2227 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2228 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2229 snd_pcm_stream_unlock_irq(substream);
2230
2231 return result;
2232}
2233
2234
2235static bool is_pcm_file(struct file *file)
2236{
2237 struct inode *inode = file_inode(file);
2238 struct snd_pcm *pcm;
2239 unsigned int minor;
2240
2241 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2242 return false;
2243 minor = iminor(inode);
2244 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2245 if (!pcm)
2246 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2247 if (!pcm)
2248 return false;
2249 snd_card_unref(pcm->card);
2250 return true;
2251}
2252
2253/*
2254 * PCM link handling
2255 */
2256static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
2257{
2258 int res = 0;
2259 struct snd_pcm_file *pcm_file;
2260 struct snd_pcm_substream *substream1;
2261 struct snd_pcm_group *group, *target_group;
2262 bool nonatomic = substream->pcm->nonatomic;
2263 struct fd f = fdget(fd);
2264
2265 if (!f.file)
2266 return -EBADFD;
2267 if (!is_pcm_file(f.file)) {
2268 res = -EBADFD;
2269 goto _badf;
2270 }
2271 pcm_file = f.file->private_data;
2272 substream1 = pcm_file->substream;
2273
2274 if (substream == substream1) {
2275 res = -EINVAL;
2276 goto _badf;
2277 }
2278
2279 group = kzalloc(sizeof(*group), GFP_KERNEL);
2280 if (!group) {
2281 res = -ENOMEM;
2282 goto _nolock;
2283 }
2284 snd_pcm_group_init(group);
2285
2286 down_write(&snd_pcm_link_rwsem);
2287 if (substream->runtime->state == SNDRV_PCM_STATE_OPEN ||
2288 substream->runtime->state != substream1->runtime->state ||
2289 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2290 res = -EBADFD;
2291 goto _end;
2292 }
2293 if (snd_pcm_stream_linked(substream1)) {
2294 res = -EALREADY;
2295 goto _end;
2296 }
2297
2298 snd_pcm_stream_lock_irq(substream);
2299 if (!snd_pcm_stream_linked(substream)) {
2300 snd_pcm_group_assign(substream, group);
2301 group = NULL; /* assigned, don't free this one below */
2302 }
2303 target_group = substream->group;
2304 snd_pcm_stream_unlock_irq(substream);
2305
2306 snd_pcm_group_lock_irq(target_group, nonatomic);
2307 snd_pcm_stream_lock_nested(substream1);
2308 snd_pcm_group_assign(substream1, target_group);
2309 refcount_inc(&target_group->refs);
2310 snd_pcm_stream_unlock(substream1);
2311 snd_pcm_group_unlock_irq(target_group, nonatomic);
2312 _end:
2313 up_write(&snd_pcm_link_rwsem);
2314 _nolock:
2315 kfree(group);
2316 _badf:
2317 fdput(f);
2318 return res;
2319}
2320
2321static void relink_to_local(struct snd_pcm_substream *substream)
2322{
2323 snd_pcm_stream_lock_nested(substream);
2324 snd_pcm_group_assign(substream, &substream->self_group);
2325 snd_pcm_stream_unlock(substream);
2326}
2327
2328static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2329{
2330 struct snd_pcm_group *group;
2331 bool nonatomic = substream->pcm->nonatomic;
2332 bool do_free = false;
2333 int res = 0;
2334
2335 down_write(&snd_pcm_link_rwsem);
2336
2337 if (!snd_pcm_stream_linked(substream)) {
2338 res = -EALREADY;
2339 goto _end;
2340 }
2341
2342 group = substream->group;
2343 snd_pcm_group_lock_irq(group, nonatomic);
2344
2345 relink_to_local(substream);
2346 refcount_dec(&group->refs);
2347
2348 /* detach the last stream, too */
2349 if (list_is_singular(&group->substreams)) {
2350 relink_to_local(list_first_entry(&group->substreams,
2351 struct snd_pcm_substream,
2352 link_list));
2353 do_free = refcount_dec_and_test(&group->refs);
2354 }
2355
2356 snd_pcm_group_unlock_irq(group, nonatomic);
2357 if (do_free)
2358 kfree(group);
2359
2360 _end:
2361 up_write(&snd_pcm_link_rwsem);
2362 return res;
2363}
2364
2365/*
2366 * hw configurator
2367 */
2368static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2369 struct snd_pcm_hw_rule *rule)
2370{
2371 struct snd_interval t;
2372 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2373 hw_param_interval_c(params, rule->deps[1]), &t);
2374 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2375}
2376
2377static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2378 struct snd_pcm_hw_rule *rule)
2379{
2380 struct snd_interval t;
2381 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2382 hw_param_interval_c(params, rule->deps[1]), &t);
2383 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2384}
2385
2386static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2387 struct snd_pcm_hw_rule *rule)
2388{
2389 struct snd_interval t;
2390 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2391 hw_param_interval_c(params, rule->deps[1]),
2392 (unsigned long) rule->private, &t);
2393 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2394}
2395
2396static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2397 struct snd_pcm_hw_rule *rule)
2398{
2399 struct snd_interval t;
2400 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2401 (unsigned long) rule->private,
2402 hw_param_interval_c(params, rule->deps[1]), &t);
2403 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2404}
2405
2406static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2407 struct snd_pcm_hw_rule *rule)
2408{
2409 snd_pcm_format_t k;
2410 const struct snd_interval *i =
2411 hw_param_interval_c(params, rule->deps[0]);
2412 struct snd_mask m;
2413 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2414 snd_mask_any(&m);
2415 pcm_for_each_format(k) {
2416 int bits;
2417 if (!snd_mask_test_format(mask, k))
2418 continue;
2419 bits = snd_pcm_format_physical_width(k);
2420 if (bits <= 0)
2421 continue; /* ignore invalid formats */
2422 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2423 snd_mask_reset(&m, (__force unsigned)k);
2424 }
2425 return snd_mask_refine(mask, &m);
2426}
2427
2428static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2429 struct snd_pcm_hw_rule *rule)
2430{
2431 struct snd_interval t;
2432 snd_pcm_format_t k;
2433
2434 t.min = UINT_MAX;
2435 t.max = 0;
2436 t.openmin = 0;
2437 t.openmax = 0;
2438 pcm_for_each_format(k) {
2439 int bits;
2440 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2441 continue;
2442 bits = snd_pcm_format_physical_width(k);
2443 if (bits <= 0)
2444 continue; /* ignore invalid formats */
2445 if (t.min > (unsigned)bits)
2446 t.min = bits;
2447 if (t.max < (unsigned)bits)
2448 t.max = bits;
2449 }
2450 t.integer = 1;
2451 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2452}
2453
2454#if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2455#error "Change this table"
2456#endif
2457
2458static const unsigned int rates[] = {
2459 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2460 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2461};
2462
2463const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2464 .count = ARRAY_SIZE(rates),
2465 .list = rates,
2466};
2467
2468static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2469 struct snd_pcm_hw_rule *rule)
2470{
2471 struct snd_pcm_hardware *hw = rule->private;
2472 return snd_interval_list(hw_param_interval(params, rule->var),
2473 snd_pcm_known_rates.count,
2474 snd_pcm_known_rates.list, hw->rates);
2475}
2476
2477static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2478 struct snd_pcm_hw_rule *rule)
2479{
2480 struct snd_interval t;
2481 struct snd_pcm_substream *substream = rule->private;
2482 t.min = 0;
2483 t.max = substream->buffer_bytes_max;
2484 t.openmin = 0;
2485 t.openmax = 0;
2486 t.integer = 1;
2487 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2488}
2489
2490static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2491{
2492 struct snd_pcm_runtime *runtime = substream->runtime;
2493 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2494 int k, err;
2495
2496 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2497 snd_mask_any(constrs_mask(constrs, k));
2498 }
2499
2500 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2501 snd_interval_any(constrs_interval(constrs, k));
2502 }
2503
2504 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2505 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2506 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2507 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2508 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2509
2510 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2511 snd_pcm_hw_rule_format, NULL,
2512 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2513 if (err < 0)
2514 return err;
2515 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2516 snd_pcm_hw_rule_sample_bits, NULL,
2517 SNDRV_PCM_HW_PARAM_FORMAT,
2518 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2519 if (err < 0)
2520 return err;
2521 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2522 snd_pcm_hw_rule_div, NULL,
2523 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2524 if (err < 0)
2525 return err;
2526 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2527 snd_pcm_hw_rule_mul, NULL,
2528 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2529 if (err < 0)
2530 return err;
2531 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2532 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2533 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2534 if (err < 0)
2535 return err;
2536 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2537 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2538 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2539 if (err < 0)
2540 return err;
2541 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2542 snd_pcm_hw_rule_div, NULL,
2543 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2544 if (err < 0)
2545 return err;
2546 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2547 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2548 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2549 if (err < 0)
2550 return err;
2551 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2552 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2553 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2554 if (err < 0)
2555 return err;
2556 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2557 snd_pcm_hw_rule_div, NULL,
2558 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2559 if (err < 0)
2560 return err;
2561 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2562 snd_pcm_hw_rule_div, NULL,
2563 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2564 if (err < 0)
2565 return err;
2566 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2567 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2568 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2569 if (err < 0)
2570 return err;
2571 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2572 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2573 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2574 if (err < 0)
2575 return err;
2576 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2577 snd_pcm_hw_rule_mul, NULL,
2578 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2579 if (err < 0)
2580 return err;
2581 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2582 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2583 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2584 if (err < 0)
2585 return err;
2586 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2587 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2588 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2589 if (err < 0)
2590 return err;
2591 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2592 snd_pcm_hw_rule_muldivk, (void*) 8,
2593 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2594 if (err < 0)
2595 return err;
2596 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2597 snd_pcm_hw_rule_muldivk, (void*) 8,
2598 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2599 if (err < 0)
2600 return err;
2601 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2602 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2603 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2604 if (err < 0)
2605 return err;
2606 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2607 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2608 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2609 if (err < 0)
2610 return err;
2611 return 0;
2612}
2613
2614static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2615{
2616 struct snd_pcm_runtime *runtime = substream->runtime;
2617 struct snd_pcm_hardware *hw = &runtime->hw;
2618 int err;
2619 unsigned int mask = 0;
2620
2621 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2622 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
2623 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2624 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
2625 if (hw_support_mmap(substream)) {
2626 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2627 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
2628 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2629 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
2630 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2631 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
2632 }
2633 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2634 if (err < 0)
2635 return err;
2636
2637 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2638 if (err < 0)
2639 return err;
2640
2641 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2642 PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
2643 if (err < 0)
2644 return err;
2645
2646 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2647 hw->channels_min, hw->channels_max);
2648 if (err < 0)
2649 return err;
2650
2651 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2652 hw->rate_min, hw->rate_max);
2653 if (err < 0)
2654 return err;
2655
2656 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2657 hw->period_bytes_min, hw->period_bytes_max);
2658 if (err < 0)
2659 return err;
2660
2661 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2662 hw->periods_min, hw->periods_max);
2663 if (err < 0)
2664 return err;
2665
2666 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2667 hw->period_bytes_min, hw->buffer_bytes_max);
2668 if (err < 0)
2669 return err;
2670
2671 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2672 snd_pcm_hw_rule_buffer_bytes_max, substream,
2673 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2674 if (err < 0)
2675 return err;
2676
2677 /* FIXME: remove */
2678 if (runtime->dma_bytes) {
2679 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2680 if (err < 0)
2681 return err;
2682 }
2683
2684 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2685 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2686 snd_pcm_hw_rule_rate, hw,
2687 SNDRV_PCM_HW_PARAM_RATE, -1);
2688 if (err < 0)
2689 return err;
2690 }
2691
2692 /* FIXME: this belong to lowlevel */
2693 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2694
2695 return 0;
2696}
2697
2698static void pcm_release_private(struct snd_pcm_substream *substream)
2699{
2700 if (snd_pcm_stream_linked(substream))
2701 snd_pcm_unlink(substream);
2702}
2703
2704void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2705{
2706 substream->ref_count--;
2707 if (substream->ref_count > 0)
2708 return;
2709
2710 snd_pcm_drop(substream);
2711 if (substream->hw_opened) {
2712 if (substream->runtime->state != SNDRV_PCM_STATE_OPEN)
2713 do_hw_free(substream);
2714 substream->ops->close(substream);
2715 substream->hw_opened = 0;
2716 }
2717 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2718 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
2719 if (substream->pcm_release) {
2720 substream->pcm_release(substream);
2721 substream->pcm_release = NULL;
2722 }
2723 snd_pcm_detach_substream(substream);
2724}
2725EXPORT_SYMBOL(snd_pcm_release_substream);
2726
2727int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2728 struct file *file,
2729 struct snd_pcm_substream **rsubstream)
2730{
2731 struct snd_pcm_substream *substream;
2732 int err;
2733
2734 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2735 if (err < 0)
2736 return err;
2737 if (substream->ref_count > 1) {
2738 *rsubstream = substream;
2739 return 0;
2740 }
2741
2742 err = snd_pcm_hw_constraints_init(substream);
2743 if (err < 0) {
2744 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2745 goto error;
2746 }
2747
2748 err = substream->ops->open(substream);
2749 if (err < 0)
2750 goto error;
2751
2752 substream->hw_opened = 1;
2753
2754 err = snd_pcm_hw_constraints_complete(substream);
2755 if (err < 0) {
2756 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2757 goto error;
2758 }
2759
2760 /* automatically set EXPLICIT_SYNC flag in the managed mode whenever
2761 * the DMA buffer requires it
2762 */
2763 if (substream->managed_buffer_alloc &&
2764 substream->dma_buffer.dev.need_sync)
2765 substream->runtime->hw.info |= SNDRV_PCM_INFO_EXPLICIT_SYNC;
2766
2767 *rsubstream = substream;
2768 return 0;
2769
2770 error:
2771 snd_pcm_release_substream(substream);
2772 return err;
2773}
2774EXPORT_SYMBOL(snd_pcm_open_substream);
2775
2776static int snd_pcm_open_file(struct file *file,
2777 struct snd_pcm *pcm,
2778 int stream)
2779{
2780 struct snd_pcm_file *pcm_file;
2781 struct snd_pcm_substream *substream;
2782 int err;
2783
2784 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2785 if (err < 0)
2786 return err;
2787
2788 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2789 if (pcm_file == NULL) {
2790 snd_pcm_release_substream(substream);
2791 return -ENOMEM;
2792 }
2793 pcm_file->substream = substream;
2794 if (substream->ref_count == 1)
2795 substream->pcm_release = pcm_release_private;
2796 file->private_data = pcm_file;
2797
2798 return 0;
2799}
2800
2801static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2802{
2803 struct snd_pcm *pcm;
2804 int err = nonseekable_open(inode, file);
2805 if (err < 0)
2806 return err;
2807 pcm = snd_lookup_minor_data(iminor(inode),
2808 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2809 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2810 if (pcm)
2811 snd_card_unref(pcm->card);
2812 return err;
2813}
2814
2815static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2816{
2817 struct snd_pcm *pcm;
2818 int err = nonseekable_open(inode, file);
2819 if (err < 0)
2820 return err;
2821 pcm = snd_lookup_minor_data(iminor(inode),
2822 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2823 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2824 if (pcm)
2825 snd_card_unref(pcm->card);
2826 return err;
2827}
2828
2829static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2830{
2831 int err;
2832 wait_queue_entry_t wait;
2833
2834 if (pcm == NULL) {
2835 err = -ENODEV;
2836 goto __error1;
2837 }
2838 err = snd_card_file_add(pcm->card, file);
2839 if (err < 0)
2840 goto __error1;
2841 if (!try_module_get(pcm->card->module)) {
2842 err = -EFAULT;
2843 goto __error2;
2844 }
2845 init_waitqueue_entry(&wait, current);
2846 add_wait_queue(&pcm->open_wait, &wait);
2847 mutex_lock(&pcm->open_mutex);
2848 while (1) {
2849 err = snd_pcm_open_file(file, pcm, stream);
2850 if (err >= 0)
2851 break;
2852 if (err == -EAGAIN) {
2853 if (file->f_flags & O_NONBLOCK) {
2854 err = -EBUSY;
2855 break;
2856 }
2857 } else
2858 break;
2859 set_current_state(TASK_INTERRUPTIBLE);
2860 mutex_unlock(&pcm->open_mutex);
2861 schedule();
2862 mutex_lock(&pcm->open_mutex);
2863 if (pcm->card->shutdown) {
2864 err = -ENODEV;
2865 break;
2866 }
2867 if (signal_pending(current)) {
2868 err = -ERESTARTSYS;
2869 break;
2870 }
2871 }
2872 remove_wait_queue(&pcm->open_wait, &wait);
2873 mutex_unlock(&pcm->open_mutex);
2874 if (err < 0)
2875 goto __error;
2876 return err;
2877
2878 __error:
2879 module_put(pcm->card->module);
2880 __error2:
2881 snd_card_file_remove(pcm->card, file);
2882 __error1:
2883 return err;
2884}
2885
2886static int snd_pcm_release(struct inode *inode, struct file *file)
2887{
2888 struct snd_pcm *pcm;
2889 struct snd_pcm_substream *substream;
2890 struct snd_pcm_file *pcm_file;
2891
2892 pcm_file = file->private_data;
2893 substream = pcm_file->substream;
2894 if (snd_BUG_ON(!substream))
2895 return -ENXIO;
2896 pcm = substream->pcm;
2897
2898 /* block until the device gets woken up as it may touch the hardware */
2899 snd_power_wait(pcm->card);
2900
2901 mutex_lock(&pcm->open_mutex);
2902 snd_pcm_release_substream(substream);
2903 kfree(pcm_file);
2904 mutex_unlock(&pcm->open_mutex);
2905 wake_up(&pcm->open_wait);
2906 module_put(pcm->card->module);
2907 snd_card_file_remove(pcm->card, file);
2908 return 0;
2909}
2910
2911/* check and update PCM state; return 0 or a negative error
2912 * call this inside PCM lock
2913 */
2914static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2915{
2916 switch (substream->runtime->state) {
2917 case SNDRV_PCM_STATE_DRAINING:
2918 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2919 return -EBADFD;
2920 fallthrough;
2921 case SNDRV_PCM_STATE_RUNNING:
2922 return snd_pcm_update_hw_ptr(substream);
2923 case SNDRV_PCM_STATE_PREPARED:
2924 case SNDRV_PCM_STATE_PAUSED:
2925 return 0;
2926 case SNDRV_PCM_STATE_SUSPENDED:
2927 return -ESTRPIPE;
2928 case SNDRV_PCM_STATE_XRUN:
2929 return -EPIPE;
2930 default:
2931 return -EBADFD;
2932 }
2933}
2934
2935/* increase the appl_ptr; returns the processed frames or a negative error */
2936static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2937 snd_pcm_uframes_t frames,
2938 snd_pcm_sframes_t avail)
2939{
2940 struct snd_pcm_runtime *runtime = substream->runtime;
2941 snd_pcm_sframes_t appl_ptr;
2942 int ret;
2943
2944 if (avail <= 0)
2945 return 0;
2946 if (frames > (snd_pcm_uframes_t)avail)
2947 frames = avail;
2948 appl_ptr = runtime->control->appl_ptr + frames;
2949 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2950 appl_ptr -= runtime->boundary;
2951 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2952 return ret < 0 ? ret : frames;
2953}
2954
2955/* decrease the appl_ptr; returns the processed frames or zero for error */
2956static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2957 snd_pcm_uframes_t frames,
2958 snd_pcm_sframes_t avail)
2959{
2960 struct snd_pcm_runtime *runtime = substream->runtime;
2961 snd_pcm_sframes_t appl_ptr;
2962 int ret;
2963
2964 if (avail <= 0)
2965 return 0;
2966 if (frames > (snd_pcm_uframes_t)avail)
2967 frames = avail;
2968 appl_ptr = runtime->control->appl_ptr - frames;
2969 if (appl_ptr < 0)
2970 appl_ptr += runtime->boundary;
2971 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2972 /* NOTE: we return zero for errors because PulseAudio gets depressed
2973 * upon receiving an error from rewind ioctl and stops processing
2974 * any longer. Returning zero means that no rewind is done, so
2975 * it's not absolutely wrong to answer like that.
2976 */
2977 return ret < 0 ? 0 : frames;
2978}
2979
2980static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2981 snd_pcm_uframes_t frames)
2982{
2983 snd_pcm_sframes_t ret;
2984
2985 if (frames == 0)
2986 return 0;
2987
2988 snd_pcm_stream_lock_irq(substream);
2989 ret = do_pcm_hwsync(substream);
2990 if (!ret)
2991 ret = rewind_appl_ptr(substream, frames,
2992 snd_pcm_hw_avail(substream));
2993 snd_pcm_stream_unlock_irq(substream);
2994 if (ret >= 0)
2995 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2996 return ret;
2997}
2998
2999static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
3000 snd_pcm_uframes_t frames)
3001{
3002 snd_pcm_sframes_t ret;
3003
3004 if (frames == 0)
3005 return 0;
3006
3007 snd_pcm_stream_lock_irq(substream);
3008 ret = do_pcm_hwsync(substream);
3009 if (!ret)
3010 ret = forward_appl_ptr(substream, frames,
3011 snd_pcm_avail(substream));
3012 snd_pcm_stream_unlock_irq(substream);
3013 if (ret >= 0)
3014 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3015 return ret;
3016}
3017
3018static int snd_pcm_delay(struct snd_pcm_substream *substream,
3019 snd_pcm_sframes_t *delay)
3020{
3021 int err;
3022
3023 snd_pcm_stream_lock_irq(substream);
3024 err = do_pcm_hwsync(substream);
3025 if (delay && !err)
3026 *delay = snd_pcm_calc_delay(substream);
3027 snd_pcm_stream_unlock_irq(substream);
3028 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
3029
3030 return err;
3031}
3032
3033static inline int snd_pcm_hwsync(struct snd_pcm_substream *substream)
3034{
3035 return snd_pcm_delay(substream, NULL);
3036}
3037
3038static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
3039 struct snd_pcm_sync_ptr __user *_sync_ptr)
3040{
3041 struct snd_pcm_runtime *runtime = substream->runtime;
3042 struct snd_pcm_sync_ptr sync_ptr;
3043 volatile struct snd_pcm_mmap_status *status;
3044 volatile struct snd_pcm_mmap_control *control;
3045 int err;
3046
3047 memset(&sync_ptr, 0, sizeof(sync_ptr));
3048 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
3049 return -EFAULT;
3050 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
3051 return -EFAULT;
3052 status = runtime->status;
3053 control = runtime->control;
3054 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3055 err = snd_pcm_hwsync(substream);
3056 if (err < 0)
3057 return err;
3058 }
3059 snd_pcm_stream_lock_irq(substream);
3060 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
3061 err = pcm_lib_apply_appl_ptr(substream,
3062 sync_ptr.c.control.appl_ptr);
3063 if (err < 0) {
3064 snd_pcm_stream_unlock_irq(substream);
3065 return err;
3066 }
3067 } else {
3068 sync_ptr.c.control.appl_ptr = control->appl_ptr;
3069 }
3070 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3071 control->avail_min = sync_ptr.c.control.avail_min;
3072 else
3073 sync_ptr.c.control.avail_min = control->avail_min;
3074 sync_ptr.s.status.state = status->state;
3075 sync_ptr.s.status.hw_ptr = status->hw_ptr;
3076 sync_ptr.s.status.tstamp = status->tstamp;
3077 sync_ptr.s.status.suspended_state = status->suspended_state;
3078 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
3079 snd_pcm_stream_unlock_irq(substream);
3080 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL))
3081 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3082 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
3083 return -EFAULT;
3084 return 0;
3085}
3086
3087struct snd_pcm_mmap_status32 {
3088 snd_pcm_state_t state;
3089 s32 pad1;
3090 u32 hw_ptr;
3091 s32 tstamp_sec;
3092 s32 tstamp_nsec;
3093 snd_pcm_state_t suspended_state;
3094 s32 audio_tstamp_sec;
3095 s32 audio_tstamp_nsec;
3096} __attribute__((packed));
3097
3098struct snd_pcm_mmap_control32 {
3099 u32 appl_ptr;
3100 u32 avail_min;
3101};
3102
3103struct snd_pcm_sync_ptr32 {
3104 u32 flags;
3105 union {
3106 struct snd_pcm_mmap_status32 status;
3107 unsigned char reserved[64];
3108 } s;
3109 union {
3110 struct snd_pcm_mmap_control32 control;
3111 unsigned char reserved[64];
3112 } c;
3113} __attribute__((packed));
3114
3115/* recalcuate the boundary within 32bit */
3116static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3117{
3118 snd_pcm_uframes_t boundary;
3119
3120 if (! runtime->buffer_size)
3121 return 0;
3122 boundary = runtime->buffer_size;
3123 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3124 boundary *= 2;
3125 return boundary;
3126}
3127
3128static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3129 struct snd_pcm_sync_ptr32 __user *src)
3130{
3131 struct snd_pcm_runtime *runtime = substream->runtime;
3132 volatile struct snd_pcm_mmap_status *status;
3133 volatile struct snd_pcm_mmap_control *control;
3134 u32 sflags;
3135 struct snd_pcm_mmap_control scontrol;
3136 struct snd_pcm_mmap_status sstatus;
3137 snd_pcm_uframes_t boundary;
3138 int err;
3139
3140 if (snd_BUG_ON(!runtime))
3141 return -EINVAL;
3142
3143 if (get_user(sflags, &src->flags) ||
3144 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3145 get_user(scontrol.avail_min, &src->c.control.avail_min))
3146 return -EFAULT;
3147 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3148 err = snd_pcm_hwsync(substream);
3149 if (err < 0)
3150 return err;
3151 }
3152 status = runtime->status;
3153 control = runtime->control;
3154 boundary = recalculate_boundary(runtime);
3155 if (! boundary)
3156 boundary = 0x7fffffff;
3157 snd_pcm_stream_lock_irq(substream);
3158 /* FIXME: we should consider the boundary for the sync from app */
3159 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL)) {
3160 err = pcm_lib_apply_appl_ptr(substream,
3161 scontrol.appl_ptr);
3162 if (err < 0) {
3163 snd_pcm_stream_unlock_irq(substream);
3164 return err;
3165 }
3166 } else
3167 scontrol.appl_ptr = control->appl_ptr % boundary;
3168 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3169 control->avail_min = scontrol.avail_min;
3170 else
3171 scontrol.avail_min = control->avail_min;
3172 sstatus.state = status->state;
3173 sstatus.hw_ptr = status->hw_ptr % boundary;
3174 sstatus.tstamp = status->tstamp;
3175 sstatus.suspended_state = status->suspended_state;
3176 sstatus.audio_tstamp = status->audio_tstamp;
3177 snd_pcm_stream_unlock_irq(substream);
3178 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3179 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3180 if (put_user(sstatus.state, &src->s.status.state) ||
3181 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
3182 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3183 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
3184 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
3185 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3186 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
3187 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3188 put_user(scontrol.avail_min, &src->c.control.avail_min))
3189 return -EFAULT;
3190
3191 return 0;
3192}
3193#define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
3194
3195static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3196{
3197 struct snd_pcm_runtime *runtime = substream->runtime;
3198 int arg;
3199
3200 if (get_user(arg, _arg))
3201 return -EFAULT;
3202 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3203 return -EINVAL;
3204 runtime->tstamp_type = arg;
3205 return 0;
3206}
3207
3208static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3209 struct snd_xferi __user *_xferi)
3210{
3211 struct snd_xferi xferi;
3212 struct snd_pcm_runtime *runtime = substream->runtime;
3213 snd_pcm_sframes_t result;
3214
3215 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3216 return -EBADFD;
3217 if (put_user(0, &_xferi->result))
3218 return -EFAULT;
3219 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3220 return -EFAULT;
3221 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3222 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3223 else
3224 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
3225 if (put_user(result, &_xferi->result))
3226 return -EFAULT;
3227 return result < 0 ? result : 0;
3228}
3229
3230static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3231 struct snd_xfern __user *_xfern)
3232{
3233 struct snd_xfern xfern;
3234 struct snd_pcm_runtime *runtime = substream->runtime;
3235 void *bufs;
3236 snd_pcm_sframes_t result;
3237
3238 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3239 return -EBADFD;
3240 if (runtime->channels > 128)
3241 return -EINVAL;
3242 if (put_user(0, &_xfern->result))
3243 return -EFAULT;
3244 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3245 return -EFAULT;
3246
3247 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3248 if (IS_ERR(bufs))
3249 return PTR_ERR(bufs);
3250 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3251 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3252 else
3253 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3254 kfree(bufs);
3255 if (put_user(result, &_xfern->result))
3256 return -EFAULT;
3257 return result < 0 ? result : 0;
3258}
3259
3260static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3261 snd_pcm_uframes_t __user *_frames)
3262{
3263 snd_pcm_uframes_t frames;
3264 snd_pcm_sframes_t result;
3265
3266 if (get_user(frames, _frames))
3267 return -EFAULT;
3268 if (put_user(0, _frames))
3269 return -EFAULT;
3270 result = snd_pcm_rewind(substream, frames);
3271 if (put_user(result, _frames))
3272 return -EFAULT;
3273 return result < 0 ? result : 0;
3274}
3275
3276static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3277 snd_pcm_uframes_t __user *_frames)
3278{
3279 snd_pcm_uframes_t frames;
3280 snd_pcm_sframes_t result;
3281
3282 if (get_user(frames, _frames))
3283 return -EFAULT;
3284 if (put_user(0, _frames))
3285 return -EFAULT;
3286 result = snd_pcm_forward(substream, frames);
3287 if (put_user(result, _frames))
3288 return -EFAULT;
3289 return result < 0 ? result : 0;
3290}
3291
3292static int snd_pcm_common_ioctl(struct file *file,
3293 struct snd_pcm_substream *substream,
3294 unsigned int cmd, void __user *arg)
3295{
3296 struct snd_pcm_file *pcm_file = file->private_data;
3297 int res;
3298
3299 if (PCM_RUNTIME_CHECK(substream))
3300 return -ENXIO;
3301
3302 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3303 return -EBADFD;
3304
3305 res = snd_power_wait(substream->pcm->card);
3306 if (res < 0)
3307 return res;
3308
3309 switch (cmd) {
3310 case SNDRV_PCM_IOCTL_PVERSION:
3311 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3312 case SNDRV_PCM_IOCTL_INFO:
3313 return snd_pcm_info_user(substream, arg);
3314 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3315 return 0;
3316 case SNDRV_PCM_IOCTL_TTSTAMP:
3317 return snd_pcm_tstamp(substream, arg);
3318 case SNDRV_PCM_IOCTL_USER_PVERSION:
3319 if (get_user(pcm_file->user_pversion,
3320 (unsigned int __user *)arg))
3321 return -EFAULT;
3322 return 0;
3323 case SNDRV_PCM_IOCTL_HW_REFINE:
3324 return snd_pcm_hw_refine_user(substream, arg);
3325 case SNDRV_PCM_IOCTL_HW_PARAMS:
3326 return snd_pcm_hw_params_user(substream, arg);
3327 case SNDRV_PCM_IOCTL_HW_FREE:
3328 return snd_pcm_hw_free(substream);
3329 case SNDRV_PCM_IOCTL_SW_PARAMS:
3330 return snd_pcm_sw_params_user(substream, arg);
3331 case SNDRV_PCM_IOCTL_STATUS32:
3332 return snd_pcm_status_user32(substream, arg, false);
3333 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3334 return snd_pcm_status_user32(substream, arg, true);
3335 case SNDRV_PCM_IOCTL_STATUS64:
3336 return snd_pcm_status_user64(substream, arg, false);
3337 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3338 return snd_pcm_status_user64(substream, arg, true);
3339 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3340 return snd_pcm_channel_info_user(substream, arg);
3341 case SNDRV_PCM_IOCTL_PREPARE:
3342 return snd_pcm_prepare(substream, file);
3343 case SNDRV_PCM_IOCTL_RESET:
3344 return snd_pcm_reset(substream);
3345 case SNDRV_PCM_IOCTL_START:
3346 return snd_pcm_start_lock_irq(substream);
3347 case SNDRV_PCM_IOCTL_LINK:
3348 return snd_pcm_link(substream, (int)(unsigned long) arg);
3349 case SNDRV_PCM_IOCTL_UNLINK:
3350 return snd_pcm_unlink(substream);
3351 case SNDRV_PCM_IOCTL_RESUME:
3352 return snd_pcm_resume(substream);
3353 case SNDRV_PCM_IOCTL_XRUN:
3354 return snd_pcm_xrun(substream);
3355 case SNDRV_PCM_IOCTL_HWSYNC:
3356 return snd_pcm_hwsync(substream);
3357 case SNDRV_PCM_IOCTL_DELAY:
3358 {
3359 snd_pcm_sframes_t delay = 0;
3360 snd_pcm_sframes_t __user *res = arg;
3361 int err;
3362
3363 err = snd_pcm_delay(substream, &delay);
3364 if (err)
3365 return err;
3366 if (put_user(delay, res))
3367 return -EFAULT;
3368 return 0;
3369 }
3370 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3371 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3372 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
3373 return snd_pcm_sync_ptr(substream, arg);
3374#ifdef CONFIG_SND_SUPPORT_OLD_API
3375 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3376 return snd_pcm_hw_refine_old_user(substream, arg);
3377 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3378 return snd_pcm_hw_params_old_user(substream, arg);
3379#endif
3380 case SNDRV_PCM_IOCTL_DRAIN:
3381 return snd_pcm_drain(substream, file);
3382 case SNDRV_PCM_IOCTL_DROP:
3383 return snd_pcm_drop(substream);
3384 case SNDRV_PCM_IOCTL_PAUSE:
3385 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
3386 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3387 case SNDRV_PCM_IOCTL_READI_FRAMES:
3388 return snd_pcm_xferi_frames_ioctl(substream, arg);
3389 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3390 case SNDRV_PCM_IOCTL_READN_FRAMES:
3391 return snd_pcm_xfern_frames_ioctl(substream, arg);
3392 case SNDRV_PCM_IOCTL_REWIND:
3393 return snd_pcm_rewind_ioctl(substream, arg);
3394 case SNDRV_PCM_IOCTL_FORWARD:
3395 return snd_pcm_forward_ioctl(substream, arg);
3396 }
3397 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3398 return -ENOTTY;
3399}
3400
3401static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3402 unsigned long arg)
3403{
3404 struct snd_pcm_file *pcm_file;
3405
3406 pcm_file = file->private_data;
3407
3408 if (((cmd >> 8) & 0xff) != 'A')
3409 return -ENOTTY;
3410
3411 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3412 (void __user *)arg);
3413}
3414
3415/**
3416 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3417 * @substream: PCM substream
3418 * @cmd: IOCTL cmd
3419 * @arg: IOCTL argument
3420 *
3421 * The function is provided primarily for OSS layer and USB gadget drivers,
3422 * and it allows only the limited set of ioctls (hw_params, sw_params,
3423 * prepare, start, drain, drop, forward).
3424 *
3425 * Return: zero if successful, or a negative error code
3426 */
3427int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3428 unsigned int cmd, void *arg)
3429{
3430 snd_pcm_uframes_t *frames = arg;
3431 snd_pcm_sframes_t result;
3432
3433 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3434 return -EBADFD;
3435
3436 switch (cmd) {
3437 case SNDRV_PCM_IOCTL_FORWARD:
3438 {
3439 /* provided only for OSS; capture-only and no value returned */
3440 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3441 return -EINVAL;
3442 result = snd_pcm_forward(substream, *frames);
3443 return result < 0 ? result : 0;
3444 }
3445 case SNDRV_PCM_IOCTL_HW_PARAMS:
3446 return snd_pcm_hw_params(substream, arg);
3447 case SNDRV_PCM_IOCTL_SW_PARAMS:
3448 return snd_pcm_sw_params(substream, arg);
3449 case SNDRV_PCM_IOCTL_PREPARE:
3450 return snd_pcm_prepare(substream, NULL);
3451 case SNDRV_PCM_IOCTL_START:
3452 return snd_pcm_start_lock_irq(substream);
3453 case SNDRV_PCM_IOCTL_DRAIN:
3454 return snd_pcm_drain(substream, NULL);
3455 case SNDRV_PCM_IOCTL_DROP:
3456 return snd_pcm_drop(substream);
3457 case SNDRV_PCM_IOCTL_DELAY:
3458 return snd_pcm_delay(substream, frames);
3459 default:
3460 return -EINVAL;
3461 }
3462}
3463EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3464
3465static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3466 loff_t * offset)
3467{
3468 struct snd_pcm_file *pcm_file;
3469 struct snd_pcm_substream *substream;
3470 struct snd_pcm_runtime *runtime;
3471 snd_pcm_sframes_t result;
3472
3473 pcm_file = file->private_data;
3474 substream = pcm_file->substream;
3475 if (PCM_RUNTIME_CHECK(substream))
3476 return -ENXIO;
3477 runtime = substream->runtime;
3478 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3479 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3480 return -EBADFD;
3481 if (!frame_aligned(runtime, count))
3482 return -EINVAL;
3483 count = bytes_to_frames(runtime, count);
3484 result = snd_pcm_lib_read(substream, buf, count);
3485 if (result > 0)
3486 result = frames_to_bytes(runtime, result);
3487 return result;
3488}
3489
3490static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3491 size_t count, loff_t * offset)
3492{
3493 struct snd_pcm_file *pcm_file;
3494 struct snd_pcm_substream *substream;
3495 struct snd_pcm_runtime *runtime;
3496 snd_pcm_sframes_t result;
3497
3498 pcm_file = file->private_data;
3499 substream = pcm_file->substream;
3500 if (PCM_RUNTIME_CHECK(substream))
3501 return -ENXIO;
3502 runtime = substream->runtime;
3503 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3504 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3505 return -EBADFD;
3506 if (!frame_aligned(runtime, count))
3507 return -EINVAL;
3508 count = bytes_to_frames(runtime, count);
3509 result = snd_pcm_lib_write(substream, buf, count);
3510 if (result > 0)
3511 result = frames_to_bytes(runtime, result);
3512 return result;
3513}
3514
3515static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3516{
3517 struct snd_pcm_file *pcm_file;
3518 struct snd_pcm_substream *substream;
3519 struct snd_pcm_runtime *runtime;
3520 snd_pcm_sframes_t result;
3521 unsigned long i;
3522 void __user **bufs;
3523 snd_pcm_uframes_t frames;
3524
3525 pcm_file = iocb->ki_filp->private_data;
3526 substream = pcm_file->substream;
3527 if (PCM_RUNTIME_CHECK(substream))
3528 return -ENXIO;
3529 runtime = substream->runtime;
3530 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3531 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3532 return -EBADFD;
3533 if (!iter_is_iovec(to))
3534 return -EINVAL;
3535 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3536 return -EINVAL;
3537 if (!frame_aligned(runtime, to->iov->iov_len))
3538 return -EINVAL;
3539 frames = bytes_to_samples(runtime, to->iov->iov_len);
3540 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3541 if (bufs == NULL)
3542 return -ENOMEM;
3543 for (i = 0; i < to->nr_segs; ++i)
3544 bufs[i] = to->iov[i].iov_base;
3545 result = snd_pcm_lib_readv(substream, bufs, frames);
3546 if (result > 0)
3547 result = frames_to_bytes(runtime, result);
3548 kfree(bufs);
3549 return result;
3550}
3551
3552static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3553{
3554 struct snd_pcm_file *pcm_file;
3555 struct snd_pcm_substream *substream;
3556 struct snd_pcm_runtime *runtime;
3557 snd_pcm_sframes_t result;
3558 unsigned long i;
3559 void __user **bufs;
3560 snd_pcm_uframes_t frames;
3561
3562 pcm_file = iocb->ki_filp->private_data;
3563 substream = pcm_file->substream;
3564 if (PCM_RUNTIME_CHECK(substream))
3565 return -ENXIO;
3566 runtime = substream->runtime;
3567 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3568 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3569 return -EBADFD;
3570 if (!iter_is_iovec(from))
3571 return -EINVAL;
3572 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3573 !frame_aligned(runtime, from->iov->iov_len))
3574 return -EINVAL;
3575 frames = bytes_to_samples(runtime, from->iov->iov_len);
3576 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3577 if (bufs == NULL)
3578 return -ENOMEM;
3579 for (i = 0; i < from->nr_segs; ++i)
3580 bufs[i] = from->iov[i].iov_base;
3581 result = snd_pcm_lib_writev(substream, bufs, frames);
3582 if (result > 0)
3583 result = frames_to_bytes(runtime, result);
3584 kfree(bufs);
3585 return result;
3586}
3587
3588static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3589{
3590 struct snd_pcm_file *pcm_file;
3591 struct snd_pcm_substream *substream;
3592 struct snd_pcm_runtime *runtime;
3593 __poll_t mask, ok;
3594 snd_pcm_uframes_t avail;
3595
3596 pcm_file = file->private_data;
3597
3598 substream = pcm_file->substream;
3599 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3600 ok = EPOLLOUT | EPOLLWRNORM;
3601 else
3602 ok = EPOLLIN | EPOLLRDNORM;
3603 if (PCM_RUNTIME_CHECK(substream))
3604 return ok | EPOLLERR;
3605
3606 runtime = substream->runtime;
3607 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3608 return ok | EPOLLERR;
3609
3610 poll_wait(file, &runtime->sleep, wait);
3611
3612 mask = 0;
3613 snd_pcm_stream_lock_irq(substream);
3614 avail = snd_pcm_avail(substream);
3615 switch (runtime->state) {
3616 case SNDRV_PCM_STATE_RUNNING:
3617 case SNDRV_PCM_STATE_PREPARED:
3618 case SNDRV_PCM_STATE_PAUSED:
3619 if (avail >= runtime->control->avail_min)
3620 mask = ok;
3621 break;
3622 case SNDRV_PCM_STATE_DRAINING:
3623 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3624 mask = ok;
3625 if (!avail)
3626 mask |= EPOLLERR;
3627 }
3628 break;
3629 default:
3630 mask = ok | EPOLLERR;
3631 break;
3632 }
3633 snd_pcm_stream_unlock_irq(substream);
3634 return mask;
3635}
3636
3637/*
3638 * mmap support
3639 */
3640
3641/*
3642 * Only on coherent architectures, we can mmap the status and the control records
3643 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3644 */
3645#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3646/*
3647 * mmap status record
3648 */
3649static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3650{
3651 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3652 struct snd_pcm_runtime *runtime;
3653
3654 if (substream == NULL)
3655 return VM_FAULT_SIGBUS;
3656 runtime = substream->runtime;
3657 vmf->page = virt_to_page(runtime->status);
3658 get_page(vmf->page);
3659 return 0;
3660}
3661
3662static const struct vm_operations_struct snd_pcm_vm_ops_status =
3663{
3664 .fault = snd_pcm_mmap_status_fault,
3665};
3666
3667static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3668 struct vm_area_struct *area)
3669{
3670 long size;
3671 if (!(area->vm_flags & VM_READ))
3672 return -EINVAL;
3673 size = area->vm_end - area->vm_start;
3674 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3675 return -EINVAL;
3676 area->vm_ops = &snd_pcm_vm_ops_status;
3677 area->vm_private_data = substream;
3678 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3679 area->vm_flags &= ~(VM_WRITE | VM_MAYWRITE);
3680 return 0;
3681}
3682
3683/*
3684 * mmap control record
3685 */
3686static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3687{
3688 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3689 struct snd_pcm_runtime *runtime;
3690
3691 if (substream == NULL)
3692 return VM_FAULT_SIGBUS;
3693 runtime = substream->runtime;
3694 vmf->page = virt_to_page(runtime->control);
3695 get_page(vmf->page);
3696 return 0;
3697}
3698
3699static const struct vm_operations_struct snd_pcm_vm_ops_control =
3700{
3701 .fault = snd_pcm_mmap_control_fault,
3702};
3703
3704static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3705 struct vm_area_struct *area)
3706{
3707 long size;
3708 if (!(area->vm_flags & VM_READ))
3709 return -EINVAL;
3710 size = area->vm_end - area->vm_start;
3711 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3712 return -EINVAL;
3713 area->vm_ops = &snd_pcm_vm_ops_control;
3714 area->vm_private_data = substream;
3715 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3716 return 0;
3717}
3718
3719static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3720{
3721 /* If drivers require the explicit sync (typically for non-coherent
3722 * pages), we have to disable the mmap of status and control data
3723 * to enforce the control via SYNC_PTR ioctl.
3724 */
3725 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3726 return false;
3727 /* See pcm_control_mmap_allowed() below.
3728 * Since older alsa-lib requires both status and control mmaps to be
3729 * coupled, we have to disable the status mmap for old alsa-lib, too.
3730 */
3731 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3732 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3733 return false;
3734 return true;
3735}
3736
3737static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3738{
3739 if (pcm_file->no_compat_mmap)
3740 return false;
3741 /* see above */
3742 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3743 return false;
3744 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3745 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3746 * thus it effectively assures the manual update of appl_ptr.
3747 */
3748 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3749 return false;
3750 return true;
3751}
3752
3753#else /* ! coherent mmap */
3754/*
3755 * don't support mmap for status and control records.
3756 */
3757#define pcm_status_mmap_allowed(pcm_file) false
3758#define pcm_control_mmap_allowed(pcm_file) false
3759
3760static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3761 struct vm_area_struct *area)
3762{
3763 return -ENXIO;
3764}
3765static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3766 struct vm_area_struct *area)
3767{
3768 return -ENXIO;
3769}
3770#endif /* coherent mmap */
3771
3772/*
3773 * fault callback for mmapping a RAM page
3774 */
3775static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3776{
3777 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3778 struct snd_pcm_runtime *runtime;
3779 unsigned long offset;
3780 struct page * page;
3781 size_t dma_bytes;
3782
3783 if (substream == NULL)
3784 return VM_FAULT_SIGBUS;
3785 runtime = substream->runtime;
3786 offset = vmf->pgoff << PAGE_SHIFT;
3787 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3788 if (offset > dma_bytes - PAGE_SIZE)
3789 return VM_FAULT_SIGBUS;
3790 if (substream->ops->page)
3791 page = substream->ops->page(substream, offset);
3792 else if (!snd_pcm_get_dma_buf(substream))
3793 page = virt_to_page(runtime->dma_area + offset);
3794 else
3795 page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
3796 if (!page)
3797 return VM_FAULT_SIGBUS;
3798 get_page(page);
3799 vmf->page = page;
3800 return 0;
3801}
3802
3803static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3804 .open = snd_pcm_mmap_data_open,
3805 .close = snd_pcm_mmap_data_close,
3806};
3807
3808static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3809 .open = snd_pcm_mmap_data_open,
3810 .close = snd_pcm_mmap_data_close,
3811 .fault = snd_pcm_mmap_data_fault,
3812};
3813
3814/*
3815 * mmap the DMA buffer on RAM
3816 */
3817
3818/**
3819 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3820 * @substream: PCM substream
3821 * @area: VMA
3822 *
3823 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3824 * this function is invoked implicitly.
3825 *
3826 * Return: zero if successful, or a negative error code
3827 */
3828int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3829 struct vm_area_struct *area)
3830{
3831 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3832 if (!substream->ops->page &&
3833 !snd_dma_buffer_mmap(snd_pcm_get_dma_buf(substream), area))
3834 return 0;
3835 /* mmap with fault handler */
3836 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3837 return 0;
3838}
3839EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3840
3841/*
3842 * mmap the DMA buffer on I/O memory area
3843 */
3844#if SNDRV_PCM_INFO_MMAP_IOMEM
3845/**
3846 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3847 * @substream: PCM substream
3848 * @area: VMA
3849 *
3850 * When your hardware uses the iomapped pages as the hardware buffer and
3851 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3852 * is supposed to work only on limited architectures.
3853 *
3854 * Return: zero if successful, or a negative error code
3855 */
3856int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3857 struct vm_area_struct *area)
3858{
3859 struct snd_pcm_runtime *runtime = substream->runtime;
3860
3861 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3862 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3863}
3864EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3865#endif /* SNDRV_PCM_INFO_MMAP */
3866
3867/*
3868 * mmap DMA buffer
3869 */
3870int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3871 struct vm_area_struct *area)
3872{
3873 struct snd_pcm_runtime *runtime;
3874 long size;
3875 unsigned long offset;
3876 size_t dma_bytes;
3877 int err;
3878
3879 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3880 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3881 return -EINVAL;
3882 } else {
3883 if (!(area->vm_flags & VM_READ))
3884 return -EINVAL;
3885 }
3886 runtime = substream->runtime;
3887 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3888 return -EBADFD;
3889 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3890 return -ENXIO;
3891 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3892 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3893 return -EINVAL;
3894 size = area->vm_end - area->vm_start;
3895 offset = area->vm_pgoff << PAGE_SHIFT;
3896 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3897 if ((size_t)size > dma_bytes)
3898 return -EINVAL;
3899 if (offset > dma_bytes - size)
3900 return -EINVAL;
3901
3902 area->vm_ops = &snd_pcm_vm_ops_data;
3903 area->vm_private_data = substream;
3904 if (substream->ops->mmap)
3905 err = substream->ops->mmap(substream, area);
3906 else
3907 err = snd_pcm_lib_default_mmap(substream, area);
3908 if (!err)
3909 atomic_inc(&substream->mmap_count);
3910 return err;
3911}
3912EXPORT_SYMBOL(snd_pcm_mmap_data);
3913
3914static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3915{
3916 struct snd_pcm_file * pcm_file;
3917 struct snd_pcm_substream *substream;
3918 unsigned long offset;
3919
3920 pcm_file = file->private_data;
3921 substream = pcm_file->substream;
3922 if (PCM_RUNTIME_CHECK(substream))
3923 return -ENXIO;
3924 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3925 return -EBADFD;
3926
3927 offset = area->vm_pgoff << PAGE_SHIFT;
3928 switch (offset) {
3929 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3930 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3931 return -ENXIO;
3932 fallthrough;
3933 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
3934 if (!pcm_status_mmap_allowed(pcm_file))
3935 return -ENXIO;
3936 return snd_pcm_mmap_status(substream, file, area);
3937 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3938 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3939 return -ENXIO;
3940 fallthrough;
3941 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
3942 if (!pcm_control_mmap_allowed(pcm_file))
3943 return -ENXIO;
3944 return snd_pcm_mmap_control(substream, file, area);
3945 default:
3946 return snd_pcm_mmap_data(substream, file, area);
3947 }
3948 return 0;
3949}
3950
3951static int snd_pcm_fasync(int fd, struct file * file, int on)
3952{
3953 struct snd_pcm_file * pcm_file;
3954 struct snd_pcm_substream *substream;
3955 struct snd_pcm_runtime *runtime;
3956
3957 pcm_file = file->private_data;
3958 substream = pcm_file->substream;
3959 if (PCM_RUNTIME_CHECK(substream))
3960 return -ENXIO;
3961 runtime = substream->runtime;
3962 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3963 return -EBADFD;
3964 return snd_fasync_helper(fd, file, on, &runtime->fasync);
3965}
3966
3967/*
3968 * ioctl32 compat
3969 */
3970#ifdef CONFIG_COMPAT
3971#include "pcm_compat.c"
3972#else
3973#define snd_pcm_ioctl_compat NULL
3974#endif
3975
3976/*
3977 * To be removed helpers to keep binary compatibility
3978 */
3979
3980#ifdef CONFIG_SND_SUPPORT_OLD_API
3981#define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3982#define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3983
3984static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3985 struct snd_pcm_hw_params_old *oparams)
3986{
3987 unsigned int i;
3988
3989 memset(params, 0, sizeof(*params));
3990 params->flags = oparams->flags;
3991 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3992 params->masks[i].bits[0] = oparams->masks[i];
3993 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3994 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3995 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3996 params->info = oparams->info;
3997 params->msbits = oparams->msbits;
3998 params->rate_num = oparams->rate_num;
3999 params->rate_den = oparams->rate_den;
4000 params->fifo_size = oparams->fifo_size;
4001}
4002
4003static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
4004 struct snd_pcm_hw_params *params)
4005{
4006 unsigned int i;
4007
4008 memset(oparams, 0, sizeof(*oparams));
4009 oparams->flags = params->flags;
4010 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
4011 oparams->masks[i] = params->masks[i].bits[0];
4012 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
4013 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
4014 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
4015 oparams->info = params->info;
4016 oparams->msbits = params->msbits;
4017 oparams->rate_num = params->rate_num;
4018 oparams->rate_den = params->rate_den;
4019 oparams->fifo_size = params->fifo_size;
4020}
4021
4022static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
4023 struct snd_pcm_hw_params_old __user * _oparams)
4024{
4025 struct snd_pcm_hw_params *params;
4026 struct snd_pcm_hw_params_old *oparams = NULL;
4027 int err;
4028
4029 params = kmalloc(sizeof(*params), GFP_KERNEL);
4030 if (!params)
4031 return -ENOMEM;
4032
4033 oparams = memdup_user(_oparams, sizeof(*oparams));
4034 if (IS_ERR(oparams)) {
4035 err = PTR_ERR(oparams);
4036 goto out;
4037 }
4038 snd_pcm_hw_convert_from_old_params(params, oparams);
4039 err = snd_pcm_hw_refine(substream, params);
4040 if (err < 0)
4041 goto out_old;
4042
4043 err = fixup_unreferenced_params(substream, params);
4044 if (err < 0)
4045 goto out_old;
4046
4047 snd_pcm_hw_convert_to_old_params(oparams, params);
4048 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4049 err = -EFAULT;
4050out_old:
4051 kfree(oparams);
4052out:
4053 kfree(params);
4054 return err;
4055}
4056
4057static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
4058 struct snd_pcm_hw_params_old __user * _oparams)
4059{
4060 struct snd_pcm_hw_params *params;
4061 struct snd_pcm_hw_params_old *oparams = NULL;
4062 int err;
4063
4064 params = kmalloc(sizeof(*params), GFP_KERNEL);
4065 if (!params)
4066 return -ENOMEM;
4067
4068 oparams = memdup_user(_oparams, sizeof(*oparams));
4069 if (IS_ERR(oparams)) {
4070 err = PTR_ERR(oparams);
4071 goto out;
4072 }
4073
4074 snd_pcm_hw_convert_from_old_params(params, oparams);
4075 err = snd_pcm_hw_params(substream, params);
4076 if (err < 0)
4077 goto out_old;
4078
4079 snd_pcm_hw_convert_to_old_params(oparams, params);
4080 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4081 err = -EFAULT;
4082out_old:
4083 kfree(oparams);
4084out:
4085 kfree(params);
4086 return err;
4087}
4088#endif /* CONFIG_SND_SUPPORT_OLD_API */
4089
4090#ifndef CONFIG_MMU
4091static unsigned long snd_pcm_get_unmapped_area(struct file *file,
4092 unsigned long addr,
4093 unsigned long len,
4094 unsigned long pgoff,
4095 unsigned long flags)
4096{
4097 struct snd_pcm_file *pcm_file = file->private_data;
4098 struct snd_pcm_substream *substream = pcm_file->substream;
4099 struct snd_pcm_runtime *runtime = substream->runtime;
4100 unsigned long offset = pgoff << PAGE_SHIFT;
4101
4102 switch (offset) {
4103 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
4104 return (unsigned long)runtime->status;
4105 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
4106 return (unsigned long)runtime->control;
4107 default:
4108 return (unsigned long)runtime->dma_area + offset;
4109 }
4110}
4111#else
4112# define snd_pcm_get_unmapped_area NULL
4113#endif
4114
4115/*
4116 * Register section
4117 */
4118
4119const struct file_operations snd_pcm_f_ops[2] = {
4120 {
4121 .owner = THIS_MODULE,
4122 .write = snd_pcm_write,
4123 .write_iter = snd_pcm_writev,
4124 .open = snd_pcm_playback_open,
4125 .release = snd_pcm_release,
4126 .llseek = no_llseek,
4127 .poll = snd_pcm_poll,
4128 .unlocked_ioctl = snd_pcm_ioctl,
4129 .compat_ioctl = snd_pcm_ioctl_compat,
4130 .mmap = snd_pcm_mmap,
4131 .fasync = snd_pcm_fasync,
4132 .get_unmapped_area = snd_pcm_get_unmapped_area,
4133 },
4134 {
4135 .owner = THIS_MODULE,
4136 .read = snd_pcm_read,
4137 .read_iter = snd_pcm_readv,
4138 .open = snd_pcm_capture_open,
4139 .release = snd_pcm_release,
4140 .llseek = no_llseek,
4141 .poll = snd_pcm_poll,
4142 .unlocked_ioctl = snd_pcm_ioctl,
4143 .compat_ioctl = snd_pcm_ioctl_compat,
4144 .mmap = snd_pcm_mmap,
4145 .fasync = snd_pcm_fasync,
4146 .get_unmapped_area = snd_pcm_get_unmapped_area,
4147 }
4148};