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