1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
7 #include <linux/compat.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>
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>
28 #include "pcm_local.h"
30 #ifdef CONFIG_SND_DEBUG
31 #define CREATE_TRACE_POINTS
32 #include "pcm_param_trace.h"
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)
44 struct snd_pcm_hw_params_old {
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];
54 unsigned int rate_num;
55 unsigned int rate_den;
56 snd_pcm_uframes_t fifo_size;
57 unsigned char reserved[64];
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)
64 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params_old __user * _oparams);
66 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params_old __user * _oparams);
69 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
75 static DECLARE_RWSEM(snd_pcm_link_rwsem);
77 void snd_pcm_group_init(struct snd_pcm_group *group)
79 spin_lock_init(&group->lock);
80 mutex_init(&group->mutex);
81 INIT_LIST_HEAD(&group->substreams);
82 refcount_set(&group->refs, 1);
85 /* define group lock helpers */
86 #define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
87 static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
90 mutex_ ## mutex_action(&group->mutex); \
92 spin_ ## action(&group->lock); \
95 DEFINE_PCM_GROUP_LOCK(lock, lock);
96 DEFINE_PCM_GROUP_LOCK(unlock, unlock);
97 DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
98 DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
101 * snd_pcm_stream_lock - Lock the PCM stream
102 * @substream: PCM substream
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.
108 void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
110 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
112 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
115 * snd_pcm_stream_unlock - Unlock the PCM stream
116 * @substream: PCM substream
118 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
120 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
122 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
124 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
127 * snd_pcm_stream_lock_irq - Lock the PCM stream
128 * @substream: PCM substream
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().
134 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
136 snd_pcm_group_lock_irq(&substream->self_group,
137 substream->pcm->nonatomic);
139 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
141 static void snd_pcm_stream_lock_nested(struct snd_pcm_substream *substream)
143 struct snd_pcm_group *group = &substream->self_group;
145 if (substream->pcm->nonatomic)
146 mutex_lock_nested(&group->mutex, SINGLE_DEPTH_NESTING);
148 spin_lock_nested(&group->lock, SINGLE_DEPTH_NESTING);
152 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
153 * @substream: PCM substream
155 * This is a counter-part of snd_pcm_stream_lock_irq().
157 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
159 snd_pcm_group_unlock_irq(&substream->self_group,
160 substream->pcm->nonatomic);
162 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
164 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
166 unsigned long flags = 0;
167 if (substream->pcm->nonatomic)
168 mutex_lock(&substream->self_group.mutex);
170 spin_lock_irqsave(&substream->self_group.lock, flags);
173 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
175 unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream)
177 unsigned long flags = 0;
178 if (substream->pcm->nonatomic)
179 mutex_lock_nested(&substream->self_group.mutex,
180 SINGLE_DEPTH_NESTING);
182 spin_lock_irqsave_nested(&substream->self_group.lock, flags,
183 SINGLE_DEPTH_NESTING);
186 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave_nested);
189 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
190 * @substream: PCM substream
193 * This is a counter-part of snd_pcm_stream_lock_irqsave().
195 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
198 if (substream->pcm->nonatomic)
199 mutex_unlock(&substream->self_group.mutex);
201 spin_unlock_irqrestore(&substream->self_group.lock, flags);
203 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
205 /* Run PCM ioctl ops */
206 static int snd_pcm_ops_ioctl(struct snd_pcm_substream *substream,
207 unsigned cmd, void *arg)
209 if (substream->ops->ioctl)
210 return substream->ops->ioctl(substream, cmd, arg);
212 return snd_pcm_lib_ioctl(substream, cmd, arg);
215 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
217 struct snd_pcm *pcm = substream->pcm;
218 struct snd_pcm_str *pstr = substream->pstr;
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));
236 int snd_pcm_info_user(struct snd_pcm_substream *substream,
237 struct snd_pcm_info __user * _info)
239 struct snd_pcm_info *info;
242 info = kmalloc(sizeof(*info), GFP_KERNEL);
245 err = snd_pcm_info(substream, info);
247 if (copy_to_user(_info, info, sizeof(*info)))
254 /* macro for simplified cast */
255 #define PARAM_MASK_BIT(b) (1U << (__force int)(b))
257 static bool hw_support_mmap(struct snd_pcm_substream *substream)
259 struct snd_dma_buffer *dmabuf;
261 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
264 if (substream->ops->mmap || substream->ops->page)
267 dmabuf = snd_pcm_get_dma_buf(substream);
269 dmabuf = &substream->dma_buffer;
270 switch (dmabuf->dev.type) {
271 case SNDRV_DMA_TYPE_UNKNOWN:
272 /* we can't know the device, so just assume that the driver does
276 case SNDRV_DMA_TYPE_CONTINUOUS:
277 case SNDRV_DMA_TYPE_VMALLOC:
280 return dma_can_mmap(dmabuf->dev.dev);
284 static int constrain_mask_params(struct snd_pcm_substream *substream,
285 struct snd_pcm_hw_params *params)
287 struct snd_pcm_hw_constraints *constrs =
288 &substream->runtime->hw_constraints;
291 struct snd_mask old_mask __maybe_unused;
294 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
295 m = hw_param_mask(params, k);
296 if (snd_mask_empty(m))
299 /* This parameter is not requested to change by a caller. */
300 if (!(params->rmask & PARAM_MASK_BIT(k)))
303 if (trace_hw_mask_param_enabled())
306 changed = snd_mask_refine(m, constrs_mask(constrs, k));
312 /* Set corresponding flag so that the caller gets it. */
313 trace_hw_mask_param(substream, k, 0, &old_mask, m);
314 params->cmask |= PARAM_MASK_BIT(k);
320 static int constrain_interval_params(struct snd_pcm_substream *substream,
321 struct snd_pcm_hw_params *params)
323 struct snd_pcm_hw_constraints *constrs =
324 &substream->runtime->hw_constraints;
325 struct snd_interval *i;
327 struct snd_interval old_interval __maybe_unused;
330 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
331 i = hw_param_interval(params, k);
332 if (snd_interval_empty(i))
335 /* This parameter is not requested to change by a caller. */
336 if (!(params->rmask & PARAM_MASK_BIT(k)))
339 if (trace_hw_interval_param_enabled())
342 changed = snd_interval_refine(i, constrs_interval(constrs, k));
348 /* Set corresponding flag so that the caller gets it. */
349 trace_hw_interval_param(substream, k, 0, &old_interval, i);
350 params->cmask |= PARAM_MASK_BIT(k);
356 static int constrain_params_by_rules(struct snd_pcm_substream *substream,
357 struct snd_pcm_hw_params *params)
359 struct snd_pcm_hw_constraints *constrs =
360 &substream->runtime->hw_constraints;
362 unsigned int *rstamps;
363 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
365 struct snd_pcm_hw_rule *r;
367 struct snd_mask old_mask __maybe_unused;
368 struct snd_interval old_interval __maybe_unused;
370 int changed, err = 0;
373 * Each application of rule has own sequence number.
375 * Each member of 'rstamps' array represents the sequence number of
376 * recent application of corresponding rule.
378 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
383 * Each member of 'vstamps' array represents the sequence number of
384 * recent application of rule in which corresponding parameters were
387 * In initial state, elements corresponding to parameters requested by
388 * a caller is 1. For unrequested parameters, corresponding members
389 * have 0 so that the parameters are never changed anymore.
391 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
392 vstamps[k] = (params->rmask & PARAM_MASK_BIT(k)) ? 1 : 0;
394 /* Due to the above design, actual sequence number starts at 2. */
397 /* Apply all rules in order. */
399 for (k = 0; k < constrs->rules_num; k++) {
400 r = &constrs->rules[k];
403 * Check condition bits of this rule. When the rule has
404 * some condition bits, parameter without the bits is
405 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
406 * is an example of the condition bits.
408 if (r->cond && !(r->cond & params->flags))
412 * The 'deps' array includes maximum four dependencies
413 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fifth
414 * member of this array is a sentinel and should be
417 * This rule should be processed in this time when dependent
418 * parameters were changed at former applications of the other
421 for (d = 0; r->deps[d] >= 0; d++) {
422 if (vstamps[r->deps[d]] > rstamps[k])
428 if (trace_hw_mask_param_enabled()) {
429 if (hw_is_mask(r->var))
430 old_mask = *hw_param_mask(params, r->var);
432 if (trace_hw_interval_param_enabled()) {
433 if (hw_is_interval(r->var))
434 old_interval = *hw_param_interval(params, r->var);
437 changed = r->func(params, r);
444 * When the parameter is changed, notify it to the caller
445 * by corresponding returned bit, then preparing for next
448 if (changed && r->var >= 0) {
449 if (hw_is_mask(r->var)) {
450 trace_hw_mask_param(substream, r->var,
452 hw_param_mask(params, r->var));
454 if (hw_is_interval(r->var)) {
455 trace_hw_interval_param(substream, r->var,
456 k + 1, &old_interval,
457 hw_param_interval(params, r->var));
460 params->cmask |= PARAM_MASK_BIT(r->var);
461 vstamps[r->var] = stamp;
465 rstamps[k] = stamp++;
468 /* Iterate to evaluate all rules till no parameters are changed. */
477 static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
478 struct snd_pcm_hw_params *params)
480 const struct snd_interval *i;
481 const struct snd_mask *m;
482 struct snd_mask *m_rw;
485 if (!params->msbits) {
486 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
487 if (snd_interval_single(i))
488 params->msbits = snd_interval_value(i);
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);
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);
500 (__force unsigned)SNDRV_PCM_SUBFORMAT_MSBITS_MAX);
501 if (snd_mask_empty(m_rw))
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;
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,
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);
539 int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
540 struct snd_pcm_hw_params *params)
545 params->fifo_size = 0;
546 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
548 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
549 params->rate_num = 0;
550 params->rate_den = 0;
553 err = constrain_mask_params(substream, params);
557 err = constrain_interval_params(substream, params);
561 err = constrain_params_by_rules(substream, params);
569 EXPORT_SYMBOL(snd_pcm_hw_refine);
571 static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
572 struct snd_pcm_hw_params __user * _params)
574 struct snd_pcm_hw_params *params;
577 params = memdup_user(_params, sizeof(*params));
579 return PTR_ERR(params);
581 err = snd_pcm_hw_refine(substream, params);
585 err = fixup_unreferenced_params(substream, params);
589 if (copy_to_user(_params, params, sizeof(*params)))
596 static int period_to_usecs(struct snd_pcm_runtime *runtime)
601 return -1; /* invalid */
603 /* take 75% of period time as the deadline */
604 usecs = (750000 / runtime->rate) * runtime->period_size;
605 usecs += ((750000 % runtime->rate) * runtime->period_size) /
611 static void snd_pcm_set_state(struct snd_pcm_substream *substream,
612 snd_pcm_state_t state)
614 snd_pcm_stream_lock_irq(substream);
615 if (substream->runtime->state != SNDRV_PCM_STATE_DISCONNECTED)
616 __snd_pcm_set_state(substream->runtime, state);
617 snd_pcm_stream_unlock_irq(substream);
620 static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
623 #ifdef CONFIG_SND_PCM_TIMER
624 if (substream->timer)
625 snd_timer_notify(substream->timer, event,
626 &substream->runtime->trigger_tstamp);
630 void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
632 if (substream->runtime && substream->runtime->stop_operating) {
633 substream->runtime->stop_operating = false;
634 if (substream->ops && substream->ops->sync_stop)
635 substream->ops->sync_stop(substream);
636 else if (sync_irq && substream->pcm->card->sync_irq > 0)
637 synchronize_irq(substream->pcm->card->sync_irq);
642 * snd_pcm_hw_params_choose - choose a configuration defined by @params
644 * @params: the hw_params instance
646 * Choose one configuration from configuration space defined by @params.
647 * The configuration chosen is that obtained fixing in this order:
648 * first access, first format, first subformat, min channels,
649 * min rate, min period time, max buffer size, min tick time
651 * Return: Zero if successful, or a negative error code on failure.
653 static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
654 struct snd_pcm_hw_params *params)
656 static const int vars[] = {
657 SNDRV_PCM_HW_PARAM_ACCESS,
658 SNDRV_PCM_HW_PARAM_FORMAT,
659 SNDRV_PCM_HW_PARAM_SUBFORMAT,
660 SNDRV_PCM_HW_PARAM_CHANNELS,
661 SNDRV_PCM_HW_PARAM_RATE,
662 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
663 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
664 SNDRV_PCM_HW_PARAM_TICK_TIME,
668 struct snd_mask old_mask __maybe_unused;
669 struct snd_interval old_interval __maybe_unused;
672 for (v = vars; *v != -1; v++) {
673 /* Keep old parameter to trace. */
674 if (trace_hw_mask_param_enabled()) {
676 old_mask = *hw_param_mask(params, *v);
678 if (trace_hw_interval_param_enabled()) {
679 if (hw_is_interval(*v))
680 old_interval = *hw_param_interval(params, *v);
682 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
683 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
685 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
691 /* Trace the changed parameter. */
692 if (hw_is_mask(*v)) {
693 trace_hw_mask_param(pcm, *v, 0, &old_mask,
694 hw_param_mask(params, *v));
696 if (hw_is_interval(*v)) {
697 trace_hw_interval_param(pcm, *v, 0, &old_interval,
698 hw_param_interval(params, *v));
705 /* acquire buffer_mutex; if it's in r/w operation, return -EBUSY, otherwise
706 * block the further r/w operations
708 static int snd_pcm_buffer_access_lock(struct snd_pcm_runtime *runtime)
710 if (!atomic_dec_unless_positive(&runtime->buffer_accessing))
712 mutex_lock(&runtime->buffer_mutex);
713 return 0; /* keep buffer_mutex, unlocked by below */
716 /* release buffer_mutex and clear r/w access flag */
717 static void snd_pcm_buffer_access_unlock(struct snd_pcm_runtime *runtime)
719 mutex_unlock(&runtime->buffer_mutex);
720 atomic_inc(&runtime->buffer_accessing);
723 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
724 #define is_oss_stream(substream) ((substream)->oss.oss)
726 #define is_oss_stream(substream) false
729 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
730 struct snd_pcm_hw_params *params)
732 struct snd_pcm_runtime *runtime;
735 snd_pcm_uframes_t frames;
737 if (PCM_RUNTIME_CHECK(substream))
739 runtime = substream->runtime;
740 err = snd_pcm_buffer_access_lock(runtime);
743 snd_pcm_stream_lock_irq(substream);
744 switch (runtime->state) {
745 case SNDRV_PCM_STATE_OPEN:
746 case SNDRV_PCM_STATE_SETUP:
747 case SNDRV_PCM_STATE_PREPARED:
748 if (!is_oss_stream(substream) &&
749 atomic_read(&substream->mmap_count))
756 snd_pcm_stream_unlock_irq(substream);
760 snd_pcm_sync_stop(substream, true);
763 err = snd_pcm_hw_refine(substream, params);
767 err = snd_pcm_hw_params_choose(substream, params);
771 err = fixup_unreferenced_params(substream, params);
775 if (substream->managed_buffer_alloc) {
776 err = snd_pcm_lib_malloc_pages(substream,
777 params_buffer_bytes(params));
780 runtime->buffer_changed = err > 0;
783 if (substream->ops->hw_params != NULL) {
784 err = substream->ops->hw_params(substream, params);
789 runtime->access = params_access(params);
790 runtime->format = params_format(params);
791 runtime->subformat = params_subformat(params);
792 runtime->channels = params_channels(params);
793 runtime->rate = params_rate(params);
794 runtime->period_size = params_period_size(params);
795 runtime->periods = params_periods(params);
796 runtime->buffer_size = params_buffer_size(params);
797 runtime->info = params->info;
798 runtime->rate_num = params->rate_num;
799 runtime->rate_den = params->rate_den;
800 runtime->no_period_wakeup =
801 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
802 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
804 bits = snd_pcm_format_physical_width(runtime->format);
805 runtime->sample_bits = bits;
806 bits *= runtime->channels;
807 runtime->frame_bits = bits;
809 while (bits % 8 != 0) {
813 runtime->byte_align = bits / 8;
814 runtime->min_align = frames;
816 /* Default sw params */
817 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
818 runtime->period_step = 1;
819 runtime->control->avail_min = runtime->period_size;
820 runtime->start_threshold = 1;
821 runtime->stop_threshold = runtime->buffer_size;
822 runtime->silence_threshold = 0;
823 runtime->silence_size = 0;
824 runtime->boundary = runtime->buffer_size;
825 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
826 runtime->boundary *= 2;
828 /* clear the buffer for avoiding possible kernel info leaks */
829 if (runtime->dma_area && !substream->ops->copy) {
830 size_t size = runtime->dma_bytes;
832 if (runtime->info & SNDRV_PCM_INFO_MMAP)
833 size = PAGE_ALIGN(size);
834 memset(runtime->dma_area, 0, size);
837 snd_pcm_timer_resolution_change(substream);
838 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
840 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
841 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
842 usecs = period_to_usecs(runtime);
844 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
849 /* hardware might be unusable from this time,
850 * so we force application to retry to set
851 * the correct hardware parameter settings
853 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
854 if (substream->ops->hw_free != NULL)
855 substream->ops->hw_free(substream);
856 if (substream->managed_buffer_alloc)
857 snd_pcm_lib_free_pages(substream);
860 snd_pcm_buffer_access_unlock(runtime);
864 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
865 struct snd_pcm_hw_params __user * _params)
867 struct snd_pcm_hw_params *params;
870 params = memdup_user(_params, sizeof(*params));
872 return PTR_ERR(params);
874 err = snd_pcm_hw_params(substream, params);
878 if (copy_to_user(_params, params, sizeof(*params)))
885 static int do_hw_free(struct snd_pcm_substream *substream)
889 snd_pcm_sync_stop(substream, true);
890 if (substream->ops->hw_free)
891 result = substream->ops->hw_free(substream);
892 if (substream->managed_buffer_alloc)
893 snd_pcm_lib_free_pages(substream);
897 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
899 struct snd_pcm_runtime *runtime;
902 if (PCM_RUNTIME_CHECK(substream))
904 runtime = substream->runtime;
905 result = snd_pcm_buffer_access_lock(runtime);
908 snd_pcm_stream_lock_irq(substream);
909 switch (runtime->state) {
910 case SNDRV_PCM_STATE_SETUP:
911 case SNDRV_PCM_STATE_PREPARED:
912 if (atomic_read(&substream->mmap_count))
919 snd_pcm_stream_unlock_irq(substream);
922 result = do_hw_free(substream);
923 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
924 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
926 snd_pcm_buffer_access_unlock(runtime);
930 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
931 struct snd_pcm_sw_params *params)
933 struct snd_pcm_runtime *runtime;
936 if (PCM_RUNTIME_CHECK(substream))
938 runtime = substream->runtime;
939 snd_pcm_stream_lock_irq(substream);
940 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
941 snd_pcm_stream_unlock_irq(substream);
944 snd_pcm_stream_unlock_irq(substream);
946 if (params->tstamp_mode < 0 ||
947 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
949 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
950 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
952 if (params->avail_min == 0)
954 if (params->silence_size >= runtime->boundary) {
955 if (params->silence_threshold != 0)
958 if (params->silence_size > params->silence_threshold)
960 if (params->silence_threshold > runtime->buffer_size)
964 snd_pcm_stream_lock_irq(substream);
965 runtime->tstamp_mode = params->tstamp_mode;
966 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
967 runtime->tstamp_type = params->tstamp_type;
968 runtime->period_step = params->period_step;
969 runtime->control->avail_min = params->avail_min;
970 runtime->start_threshold = params->start_threshold;
971 runtime->stop_threshold = params->stop_threshold;
972 runtime->silence_threshold = params->silence_threshold;
973 runtime->silence_size = params->silence_size;
974 params->boundary = runtime->boundary;
975 if (snd_pcm_running(substream)) {
976 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
977 runtime->silence_size > 0)
978 snd_pcm_playback_silence(substream, ULONG_MAX);
979 err = snd_pcm_update_state(substream, runtime);
981 snd_pcm_stream_unlock_irq(substream);
985 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
986 struct snd_pcm_sw_params __user * _params)
988 struct snd_pcm_sw_params params;
990 if (copy_from_user(¶ms, _params, sizeof(params)))
992 err = snd_pcm_sw_params(substream, ¶ms);
993 if (copy_to_user(_params, ¶ms, sizeof(params)))
998 static inline snd_pcm_uframes_t
999 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
1001 snd_pcm_uframes_t delay;
1003 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1004 delay = snd_pcm_playback_hw_avail(substream->runtime);
1006 delay = snd_pcm_capture_avail(substream->runtime);
1007 return delay + substream->runtime->delay;
1010 int snd_pcm_status64(struct snd_pcm_substream *substream,
1011 struct snd_pcm_status64 *status)
1013 struct snd_pcm_runtime *runtime = substream->runtime;
1015 snd_pcm_stream_lock_irq(substream);
1017 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
1018 &runtime->audio_tstamp_config);
1020 /* backwards compatible behavior */
1021 if (runtime->audio_tstamp_config.type_requested ==
1022 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
1023 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
1024 runtime->audio_tstamp_config.type_requested =
1025 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
1027 runtime->audio_tstamp_config.type_requested =
1028 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
1029 runtime->audio_tstamp_report.valid = 0;
1031 runtime->audio_tstamp_report.valid = 1;
1033 status->state = runtime->state;
1034 status->suspended_state = runtime->suspended_state;
1035 if (status->state == SNDRV_PCM_STATE_OPEN)
1037 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
1038 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
1039 if (snd_pcm_running(substream)) {
1040 snd_pcm_update_hw_ptr(substream);
1041 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1042 status->tstamp_sec = runtime->status->tstamp.tv_sec;
1043 status->tstamp_nsec =
1044 runtime->status->tstamp.tv_nsec;
1045 status->driver_tstamp_sec =
1046 runtime->driver_tstamp.tv_sec;
1047 status->driver_tstamp_nsec =
1048 runtime->driver_tstamp.tv_nsec;
1049 status->audio_tstamp_sec =
1050 runtime->status->audio_tstamp.tv_sec;
1051 status->audio_tstamp_nsec =
1052 runtime->status->audio_tstamp.tv_nsec;
1053 if (runtime->audio_tstamp_report.valid == 1)
1054 /* backwards compatibility, no report provided in COMPAT mode */
1055 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
1056 &status->audio_tstamp_accuracy,
1057 &runtime->audio_tstamp_report);
1062 /* get tstamp only in fallback mode and only if enabled */
1063 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1064 struct timespec64 tstamp;
1066 snd_pcm_gettime(runtime, &tstamp);
1067 status->tstamp_sec = tstamp.tv_sec;
1068 status->tstamp_nsec = tstamp.tv_nsec;
1072 status->appl_ptr = runtime->control->appl_ptr;
1073 status->hw_ptr = runtime->status->hw_ptr;
1074 status->avail = snd_pcm_avail(substream);
1075 status->delay = snd_pcm_running(substream) ?
1076 snd_pcm_calc_delay(substream) : 0;
1077 status->avail_max = runtime->avail_max;
1078 status->overrange = runtime->overrange;
1079 runtime->avail_max = 0;
1080 runtime->overrange = 0;
1082 snd_pcm_stream_unlock_irq(substream);
1086 static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1087 struct snd_pcm_status64 __user * _status,
1090 struct snd_pcm_status64 status;
1093 memset(&status, 0, sizeof(status));
1095 * with extension, parameters are read/write,
1096 * get audio_tstamp_data from user,
1097 * ignore rest of status structure
1099 if (ext && get_user(status.audio_tstamp_data,
1100 (u32 __user *)(&_status->audio_tstamp_data)))
1102 res = snd_pcm_status64(substream, &status);
1105 if (copy_to_user(_status, &status, sizeof(status)))
1110 static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1111 struct snd_pcm_status32 __user * _status,
1114 struct snd_pcm_status64 status64;
1115 struct snd_pcm_status32 status32;
1118 memset(&status64, 0, sizeof(status64));
1119 memset(&status32, 0, sizeof(status32));
1121 * with extension, parameters are read/write,
1122 * get audio_tstamp_data from user,
1123 * ignore rest of status structure
1125 if (ext && get_user(status64.audio_tstamp_data,
1126 (u32 __user *)(&_status->audio_tstamp_data)))
1128 res = snd_pcm_status64(substream, &status64);
1132 status32 = (struct snd_pcm_status32) {
1133 .state = status64.state,
1134 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1135 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1136 .tstamp_sec = status64.tstamp_sec,
1137 .tstamp_nsec = status64.tstamp_nsec,
1138 .appl_ptr = status64.appl_ptr,
1139 .hw_ptr = status64.hw_ptr,
1140 .delay = status64.delay,
1141 .avail = status64.avail,
1142 .avail_max = status64.avail_max,
1143 .overrange = status64.overrange,
1144 .suspended_state = status64.suspended_state,
1145 .audio_tstamp_data = status64.audio_tstamp_data,
1146 .audio_tstamp_sec = status64.audio_tstamp_sec,
1147 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1148 .driver_tstamp_sec = status64.audio_tstamp_sec,
1149 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1150 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1153 if (copy_to_user(_status, &status32, sizeof(status32)))
1159 static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1160 struct snd_pcm_channel_info * info)
1162 struct snd_pcm_runtime *runtime;
1163 unsigned int channel;
1165 channel = info->channel;
1166 runtime = substream->runtime;
1167 snd_pcm_stream_lock_irq(substream);
1168 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
1169 snd_pcm_stream_unlock_irq(substream);
1172 snd_pcm_stream_unlock_irq(substream);
1173 if (channel >= runtime->channels)
1175 memset(info, 0, sizeof(*info));
1176 info->channel = channel;
1177 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1180 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1181 struct snd_pcm_channel_info __user * _info)
1183 struct snd_pcm_channel_info info;
1186 if (copy_from_user(&info, _info, sizeof(info)))
1188 res = snd_pcm_channel_info(substream, &info);
1191 if (copy_to_user(_info, &info, sizeof(info)))
1196 static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1198 struct snd_pcm_runtime *runtime = substream->runtime;
1199 if (runtime->trigger_master == NULL)
1201 if (runtime->trigger_master == substream) {
1202 if (!runtime->trigger_tstamp_latched)
1203 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1205 snd_pcm_trigger_tstamp(runtime->trigger_master);
1206 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1208 runtime->trigger_master = NULL;
1211 #define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1214 int (*pre_action)(struct snd_pcm_substream *substream,
1215 snd_pcm_state_t state);
1216 int (*do_action)(struct snd_pcm_substream *substream,
1217 snd_pcm_state_t state);
1218 void (*undo_action)(struct snd_pcm_substream *substream,
1219 snd_pcm_state_t state);
1220 void (*post_action)(struct snd_pcm_substream *substream,
1221 snd_pcm_state_t state);
1225 * this functions is core for handling of linked stream
1226 * Note: the stream state might be changed also on failure
1227 * Note2: call with calling stream lock + link lock
1229 static int snd_pcm_action_group(const struct action_ops *ops,
1230 struct snd_pcm_substream *substream,
1231 snd_pcm_state_t state,
1234 struct snd_pcm_substream *s = NULL;
1235 struct snd_pcm_substream *s1;
1236 int res = 0, depth = 1;
1238 snd_pcm_group_for_each_entry(s, substream) {
1239 if (s != substream) {
1241 mutex_lock_nested(&s->runtime->buffer_mutex, depth);
1242 else if (s->pcm->nonatomic)
1243 mutex_lock_nested(&s->self_group.mutex, depth);
1245 spin_lock_nested(&s->self_group.lock, depth);
1248 res = ops->pre_action(s, state);
1252 snd_pcm_group_for_each_entry(s, substream) {
1253 res = ops->do_action(s, state);
1255 if (ops->undo_action) {
1256 snd_pcm_group_for_each_entry(s1, substream) {
1257 if (s1 == s) /* failed stream */
1259 ops->undo_action(s1, state);
1262 s = NULL; /* unlock all */
1266 snd_pcm_group_for_each_entry(s, substream) {
1267 ops->post_action(s, state);
1270 /* unlock streams */
1271 snd_pcm_group_for_each_entry(s1, substream) {
1272 if (s1 != substream) {
1274 mutex_unlock(&s1->runtime->buffer_mutex);
1275 else if (s1->pcm->nonatomic)
1276 mutex_unlock(&s1->self_group.mutex);
1278 spin_unlock(&s1->self_group.lock);
1280 if (s1 == s) /* end */
1287 * Note: call with stream lock
1289 static int snd_pcm_action_single(const struct action_ops *ops,
1290 struct snd_pcm_substream *substream,
1291 snd_pcm_state_t state)
1295 res = ops->pre_action(substream, state);
1298 res = ops->do_action(substream, state);
1300 ops->post_action(substream, state);
1301 else if (ops->undo_action)
1302 ops->undo_action(substream, state);
1306 static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1307 struct snd_pcm_group *new_group)
1309 substream->group = new_group;
1310 list_move(&substream->link_list, &new_group->substreams);
1314 * Unref and unlock the group, but keep the stream lock;
1315 * when the group becomes empty and no longer referred, destroy itself
1317 static void snd_pcm_group_unref(struct snd_pcm_group *group,
1318 struct snd_pcm_substream *substream)
1324 do_free = refcount_dec_and_test(&group->refs);
1325 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1331 * Lock the group inside a stream lock and reference it;
1332 * return the locked group object, or NULL if not linked
1334 static struct snd_pcm_group *
1335 snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1337 bool nonatomic = substream->pcm->nonatomic;
1338 struct snd_pcm_group *group;
1342 if (!snd_pcm_stream_linked(substream))
1344 group = substream->group;
1345 /* block freeing the group object */
1346 refcount_inc(&group->refs);
1348 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1349 spin_trylock(&group->lock);
1353 /* re-lock for avoiding ABBA deadlock */
1354 snd_pcm_stream_unlock(substream);
1355 snd_pcm_group_lock(group, nonatomic);
1356 snd_pcm_stream_lock(substream);
1358 /* check the group again; the above opens a small race window */
1359 if (substream->group == group)
1361 /* group changed, try again */
1362 snd_pcm_group_unref(group, substream);
1368 * Note: call with stream lock
1370 static int snd_pcm_action(const struct action_ops *ops,
1371 struct snd_pcm_substream *substream,
1372 snd_pcm_state_t state)
1374 struct snd_pcm_group *group;
1377 group = snd_pcm_stream_group_ref(substream);
1379 res = snd_pcm_action_group(ops, substream, state, true);
1381 res = snd_pcm_action_single(ops, substream, state);
1382 snd_pcm_group_unref(group, substream);
1387 * Note: don't use any locks before
1389 static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1390 struct snd_pcm_substream *substream,
1391 snd_pcm_state_t state)
1395 snd_pcm_stream_lock_irq(substream);
1396 res = snd_pcm_action(ops, substream, state);
1397 snd_pcm_stream_unlock_irq(substream);
1403 static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1404 struct snd_pcm_substream *substream,
1405 snd_pcm_state_t state)
1409 /* Guarantee the group members won't change during non-atomic action */
1410 down_read(&snd_pcm_link_rwsem);
1411 res = snd_pcm_buffer_access_lock(substream->runtime);
1414 if (snd_pcm_stream_linked(substream))
1415 res = snd_pcm_action_group(ops, substream, state, false);
1417 res = snd_pcm_action_single(ops, substream, state);
1418 snd_pcm_buffer_access_unlock(substream->runtime);
1420 up_read(&snd_pcm_link_rwsem);
1427 static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1428 snd_pcm_state_t state)
1430 struct snd_pcm_runtime *runtime = substream->runtime;
1431 if (runtime->state != SNDRV_PCM_STATE_PREPARED)
1433 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1434 !snd_pcm_playback_data(substream))
1436 runtime->trigger_tstamp_latched = false;
1437 runtime->trigger_master = substream;
1441 static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1442 snd_pcm_state_t state)
1446 if (substream->runtime->trigger_master != substream)
1448 err = substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1449 /* XRUN happened during the start */
1451 __snd_pcm_set_state(substream->runtime, SNDRV_PCM_STATE_XRUN);
1455 static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1456 snd_pcm_state_t state)
1458 if (substream->runtime->trigger_master == substream) {
1459 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1460 substream->runtime->stop_operating = true;
1464 static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1465 snd_pcm_state_t state)
1467 struct snd_pcm_runtime *runtime = substream->runtime;
1468 snd_pcm_trigger_tstamp(substream);
1469 runtime->hw_ptr_jiffies = jiffies;
1470 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1472 __snd_pcm_set_state(runtime, state);
1473 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1474 runtime->silence_size > 0)
1475 snd_pcm_playback_silence(substream, ULONG_MAX);
1476 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1479 static const struct action_ops snd_pcm_action_start = {
1480 .pre_action = snd_pcm_pre_start,
1481 .do_action = snd_pcm_do_start,
1482 .undo_action = snd_pcm_undo_start,
1483 .post_action = snd_pcm_post_start
1487 * snd_pcm_start - start all linked streams
1488 * @substream: the PCM substream instance
1490 * Return: Zero if successful, or a negative error code.
1491 * The stream lock must be acquired before calling this function.
1493 int snd_pcm_start(struct snd_pcm_substream *substream)
1495 return snd_pcm_action(&snd_pcm_action_start, substream,
1496 SNDRV_PCM_STATE_RUNNING);
1499 /* take the stream lock and start the streams */
1500 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1502 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1503 SNDRV_PCM_STATE_RUNNING);
1509 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1510 snd_pcm_state_t state)
1512 struct snd_pcm_runtime *runtime = substream->runtime;
1513 if (runtime->state == SNDRV_PCM_STATE_OPEN)
1515 runtime->trigger_master = substream;
1519 static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1520 snd_pcm_state_t state)
1522 if (substream->runtime->trigger_master == substream &&
1523 snd_pcm_running(substream)) {
1524 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1525 substream->runtime->stop_operating = true;
1527 return 0; /* unconditionally stop all substreams */
1530 static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1531 snd_pcm_state_t state)
1533 struct snd_pcm_runtime *runtime = substream->runtime;
1534 if (runtime->state != state) {
1535 snd_pcm_trigger_tstamp(substream);
1536 __snd_pcm_set_state(runtime, state);
1537 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1539 wake_up(&runtime->sleep);
1540 wake_up(&runtime->tsleep);
1543 static const struct action_ops snd_pcm_action_stop = {
1544 .pre_action = snd_pcm_pre_stop,
1545 .do_action = snd_pcm_do_stop,
1546 .post_action = snd_pcm_post_stop
1550 * snd_pcm_stop - try to stop all running streams in the substream group
1551 * @substream: the PCM substream instance
1552 * @state: PCM state after stopping the stream
1554 * The state of each stream is then changed to the given state unconditionally.
1556 * Return: Zero if successful, or a negative error code.
1558 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1560 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1562 EXPORT_SYMBOL(snd_pcm_stop);
1565 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1566 * @substream: the PCM substream
1568 * After stopping, the state is changed to SETUP.
1569 * Unlike snd_pcm_stop(), this affects only the given stream.
1571 * Return: Zero if successful, or a negative error code.
1573 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1575 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1576 SNDRV_PCM_STATE_SETUP);
1580 * snd_pcm_stop_xrun - stop the running streams as XRUN
1581 * @substream: the PCM substream instance
1583 * This stops the given running substream (and all linked substreams) as XRUN.
1584 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1586 * Return: Zero if successful, or a negative error code.
1588 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1590 unsigned long flags;
1592 snd_pcm_stream_lock_irqsave(substream, flags);
1593 if (substream->runtime && snd_pcm_running(substream))
1594 __snd_pcm_xrun(substream);
1595 snd_pcm_stream_unlock_irqrestore(substream, flags);
1598 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1601 * pause callbacks: pass boolean (to start pause or resume) as state argument
1603 #define pause_pushed(state) (__force bool)(state)
1605 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1606 snd_pcm_state_t state)
1608 struct snd_pcm_runtime *runtime = substream->runtime;
1609 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1611 if (pause_pushed(state)) {
1612 if (runtime->state != SNDRV_PCM_STATE_RUNNING)
1614 } else if (runtime->state != SNDRV_PCM_STATE_PAUSED)
1616 runtime->trigger_master = substream;
1620 static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1621 snd_pcm_state_t state)
1623 if (substream->runtime->trigger_master != substream)
1625 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1626 * a delta between the current jiffies, this gives a large enough
1627 * delta, effectively to skip the check once.
1629 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1630 return substream->ops->trigger(substream,
1631 pause_pushed(state) ?
1632 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1633 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1636 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1637 snd_pcm_state_t state)
1639 if (substream->runtime->trigger_master == substream)
1640 substream->ops->trigger(substream,
1641 pause_pushed(state) ?
1642 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1643 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1646 static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1647 snd_pcm_state_t state)
1649 struct snd_pcm_runtime *runtime = substream->runtime;
1650 snd_pcm_trigger_tstamp(substream);
1651 if (pause_pushed(state)) {
1652 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_PAUSED);
1653 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1654 wake_up(&runtime->sleep);
1655 wake_up(&runtime->tsleep);
1657 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_RUNNING);
1658 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1662 static const struct action_ops snd_pcm_action_pause = {
1663 .pre_action = snd_pcm_pre_pause,
1664 .do_action = snd_pcm_do_pause,
1665 .undo_action = snd_pcm_undo_pause,
1666 .post_action = snd_pcm_post_pause
1670 * Push/release the pause for all linked streams.
1672 static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1674 return snd_pcm_action(&snd_pcm_action_pause, substream,
1675 (__force snd_pcm_state_t)push);
1678 static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1681 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1682 (__force snd_pcm_state_t)push);
1686 /* suspend callback: state argument ignored */
1688 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1689 snd_pcm_state_t state)
1691 struct snd_pcm_runtime *runtime = substream->runtime;
1692 switch (runtime->state) {
1693 case SNDRV_PCM_STATE_SUSPENDED:
1695 /* unresumable PCM state; return -EBUSY for skipping suspend */
1696 case SNDRV_PCM_STATE_OPEN:
1697 case SNDRV_PCM_STATE_SETUP:
1698 case SNDRV_PCM_STATE_DISCONNECTED:
1701 runtime->trigger_master = substream;
1705 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1706 snd_pcm_state_t state)
1708 struct snd_pcm_runtime *runtime = substream->runtime;
1709 if (runtime->trigger_master != substream)
1711 if (! snd_pcm_running(substream))
1713 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1714 runtime->stop_operating = true;
1715 return 0; /* suspend unconditionally */
1718 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1719 snd_pcm_state_t state)
1721 struct snd_pcm_runtime *runtime = substream->runtime;
1722 snd_pcm_trigger_tstamp(substream);
1723 runtime->suspended_state = runtime->state;
1724 runtime->status->suspended_state = runtime->suspended_state;
1725 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SUSPENDED);
1726 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1727 wake_up(&runtime->sleep);
1728 wake_up(&runtime->tsleep);
1731 static const struct action_ops snd_pcm_action_suspend = {
1732 .pre_action = snd_pcm_pre_suspend,
1733 .do_action = snd_pcm_do_suspend,
1734 .post_action = snd_pcm_post_suspend
1738 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1739 * @substream: the PCM substream
1741 * After this call, all streams are changed to SUSPENDED state.
1743 * Return: Zero if successful, or a negative error code.
1745 static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1748 unsigned long flags;
1750 snd_pcm_stream_lock_irqsave(substream, flags);
1751 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1753 snd_pcm_stream_unlock_irqrestore(substream, flags);
1758 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1759 * @pcm: the PCM instance
1761 * After this call, all streams are changed to SUSPENDED state.
1763 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1765 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1767 struct snd_pcm_substream *substream;
1768 int stream, err = 0;
1773 for_each_pcm_substream(pcm, stream, substream) {
1774 /* FIXME: the open/close code should lock this as well */
1775 if (!substream->runtime)
1779 * Skip BE dai link PCM's that are internal and may
1780 * not have their substream ops set.
1782 if (!substream->ops)
1785 err = snd_pcm_suspend(substream);
1786 if (err < 0 && err != -EBUSY)
1790 for_each_pcm_substream(pcm, stream, substream)
1791 snd_pcm_sync_stop(substream, false);
1795 EXPORT_SYMBOL(snd_pcm_suspend_all);
1797 /* resume callbacks: state argument ignored */
1799 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1800 snd_pcm_state_t state)
1802 struct snd_pcm_runtime *runtime = substream->runtime;
1803 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1805 runtime->trigger_master = substream;
1809 static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1810 snd_pcm_state_t state)
1812 struct snd_pcm_runtime *runtime = substream->runtime;
1813 if (runtime->trigger_master != substream)
1815 /* DMA not running previously? */
1816 if (runtime->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1817 (runtime->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1818 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1820 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1823 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1824 snd_pcm_state_t state)
1826 if (substream->runtime->trigger_master == substream &&
1827 snd_pcm_running(substream))
1828 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1831 static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1832 snd_pcm_state_t state)
1834 struct snd_pcm_runtime *runtime = substream->runtime;
1835 snd_pcm_trigger_tstamp(substream);
1836 __snd_pcm_set_state(runtime, runtime->suspended_state);
1837 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1840 static const struct action_ops snd_pcm_action_resume = {
1841 .pre_action = snd_pcm_pre_resume,
1842 .do_action = snd_pcm_do_resume,
1843 .undo_action = snd_pcm_undo_resume,
1844 .post_action = snd_pcm_post_resume
1847 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1849 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1855 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1860 #endif /* CONFIG_PM */
1865 * Change the RUNNING stream(s) to XRUN state.
1867 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1869 struct snd_pcm_runtime *runtime = substream->runtime;
1872 snd_pcm_stream_lock_irq(substream);
1873 switch (runtime->state) {
1874 case SNDRV_PCM_STATE_XRUN:
1875 result = 0; /* already there */
1877 case SNDRV_PCM_STATE_RUNNING:
1878 __snd_pcm_xrun(substream);
1884 snd_pcm_stream_unlock_irq(substream);
1891 /* reset callbacks: state argument ignored */
1892 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1893 snd_pcm_state_t state)
1895 struct snd_pcm_runtime *runtime = substream->runtime;
1896 switch (runtime->state) {
1897 case SNDRV_PCM_STATE_RUNNING:
1898 case SNDRV_PCM_STATE_PREPARED:
1899 case SNDRV_PCM_STATE_PAUSED:
1900 case SNDRV_PCM_STATE_SUSPENDED:
1907 static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1908 snd_pcm_state_t state)
1910 struct snd_pcm_runtime *runtime = substream->runtime;
1911 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1914 snd_pcm_stream_lock_irq(substream);
1915 runtime->hw_ptr_base = 0;
1916 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1917 runtime->status->hw_ptr % runtime->period_size;
1918 runtime->silence_start = runtime->status->hw_ptr;
1919 runtime->silence_filled = 0;
1920 snd_pcm_stream_unlock_irq(substream);
1924 static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1925 snd_pcm_state_t state)
1927 struct snd_pcm_runtime *runtime = substream->runtime;
1928 snd_pcm_stream_lock_irq(substream);
1929 runtime->control->appl_ptr = runtime->status->hw_ptr;
1930 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1931 runtime->silence_size > 0)
1932 snd_pcm_playback_silence(substream, ULONG_MAX);
1933 snd_pcm_stream_unlock_irq(substream);
1936 static const struct action_ops snd_pcm_action_reset = {
1937 .pre_action = snd_pcm_pre_reset,
1938 .do_action = snd_pcm_do_reset,
1939 .post_action = snd_pcm_post_reset
1942 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1944 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1951 /* pass f_flags as state argument */
1952 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1953 snd_pcm_state_t state)
1955 struct snd_pcm_runtime *runtime = substream->runtime;
1956 int f_flags = (__force int)state;
1958 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
1959 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
1961 if (snd_pcm_running(substream))
1963 substream->f_flags = f_flags;
1967 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1968 snd_pcm_state_t state)
1971 snd_pcm_sync_stop(substream, true);
1972 err = substream->ops->prepare(substream);
1975 return snd_pcm_do_reset(substream, state);
1978 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1979 snd_pcm_state_t state)
1981 struct snd_pcm_runtime *runtime = substream->runtime;
1982 runtime->control->appl_ptr = runtime->status->hw_ptr;
1983 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1986 static const struct action_ops snd_pcm_action_prepare = {
1987 .pre_action = snd_pcm_pre_prepare,
1988 .do_action = snd_pcm_do_prepare,
1989 .post_action = snd_pcm_post_prepare
1993 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1994 * @substream: the PCM substream instance
1995 * @file: file to refer f_flags
1997 * Return: Zero if successful, or a negative error code.
1999 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
2005 f_flags = file->f_flags;
2007 f_flags = substream->f_flags;
2009 snd_pcm_stream_lock_irq(substream);
2010 switch (substream->runtime->state) {
2011 case SNDRV_PCM_STATE_PAUSED:
2012 snd_pcm_pause(substream, false);
2014 case SNDRV_PCM_STATE_SUSPENDED:
2015 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2018 snd_pcm_stream_unlock_irq(substream);
2020 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
2022 (__force snd_pcm_state_t)f_flags);
2029 /* drain init callbacks: state argument ignored */
2030 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
2031 snd_pcm_state_t state)
2033 struct snd_pcm_runtime *runtime = substream->runtime;
2034 switch (runtime->state) {
2035 case SNDRV_PCM_STATE_OPEN:
2036 case SNDRV_PCM_STATE_DISCONNECTED:
2037 case SNDRV_PCM_STATE_SUSPENDED:
2040 runtime->trigger_master = substream;
2044 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
2045 snd_pcm_state_t state)
2047 struct snd_pcm_runtime *runtime = substream->runtime;
2048 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
2049 switch (runtime->state) {
2050 case SNDRV_PCM_STATE_PREPARED:
2051 /* start playback stream if possible */
2052 if (! snd_pcm_playback_empty(substream)) {
2053 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
2054 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
2056 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2059 case SNDRV_PCM_STATE_RUNNING:
2060 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_DRAINING);
2062 case SNDRV_PCM_STATE_XRUN:
2063 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2069 /* stop running stream */
2070 if (runtime->state == SNDRV_PCM_STATE_RUNNING) {
2071 snd_pcm_state_t new_state;
2073 new_state = snd_pcm_capture_avail(runtime) > 0 ?
2074 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
2075 snd_pcm_do_stop(substream, new_state);
2076 snd_pcm_post_stop(substream, new_state);
2080 if (runtime->state == SNDRV_PCM_STATE_DRAINING &&
2081 runtime->trigger_master == substream &&
2082 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
2083 return substream->ops->trigger(substream,
2084 SNDRV_PCM_TRIGGER_DRAIN);
2089 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
2090 snd_pcm_state_t state)
2094 static const struct action_ops snd_pcm_action_drain_init = {
2095 .pre_action = snd_pcm_pre_drain_init,
2096 .do_action = snd_pcm_do_drain_init,
2097 .post_action = snd_pcm_post_drain_init
2101 * Drain the stream(s).
2102 * When the substream is linked, sync until the draining of all playback streams
2104 * After this call, all streams are supposed to be either SETUP or DRAINING
2105 * (capture only) state.
2107 static int snd_pcm_drain(struct snd_pcm_substream *substream,
2110 struct snd_card *card;
2111 struct snd_pcm_runtime *runtime;
2112 struct snd_pcm_substream *s;
2113 struct snd_pcm_group *group;
2114 wait_queue_entry_t wait;
2118 card = substream->pcm->card;
2119 runtime = substream->runtime;
2121 if (runtime->state == SNDRV_PCM_STATE_OPEN)
2125 if (file->f_flags & O_NONBLOCK)
2127 } else if (substream->f_flags & O_NONBLOCK)
2130 snd_pcm_stream_lock_irq(substream);
2132 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2133 snd_pcm_pause(substream, false);
2135 /* pre-start/stop - all running streams are changed to DRAINING state */
2136 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2140 /* in non-blocking, we don't wait in ioctl but let caller poll */
2148 struct snd_pcm_runtime *to_check;
2149 if (signal_pending(current)) {
2150 result = -ERESTARTSYS;
2153 /* find a substream to drain */
2155 group = snd_pcm_stream_group_ref(substream);
2156 snd_pcm_group_for_each_entry(s, substream) {
2157 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2159 runtime = s->runtime;
2160 if (runtime->state == SNDRV_PCM_STATE_DRAINING) {
2165 snd_pcm_group_unref(group, substream);
2167 break; /* all drained */
2168 init_waitqueue_entry(&wait, current);
2169 set_current_state(TASK_INTERRUPTIBLE);
2170 add_wait_queue(&to_check->sleep, &wait);
2171 snd_pcm_stream_unlock_irq(substream);
2172 if (runtime->no_period_wakeup)
2173 tout = MAX_SCHEDULE_TIMEOUT;
2176 if (runtime->rate) {
2177 long t = runtime->buffer_size * 1100 / runtime->rate;
2178 tout = max(t, tout);
2180 tout = msecs_to_jiffies(tout);
2182 tout = schedule_timeout(tout);
2184 snd_pcm_stream_lock_irq(substream);
2185 group = snd_pcm_stream_group_ref(substream);
2186 snd_pcm_group_for_each_entry(s, substream) {
2187 if (s->runtime == to_check) {
2188 remove_wait_queue(&to_check->sleep, &wait);
2192 snd_pcm_group_unref(group, substream);
2194 if (card->shutdown) {
2199 if (substream->runtime->state == SNDRV_PCM_STATE_SUSPENDED)
2202 dev_dbg(substream->pcm->card->dev,
2203 "playback drain timeout (DMA or IRQ trouble?)\n");
2204 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2212 snd_pcm_stream_unlock_irq(substream);
2220 * Immediately put all linked substreams into SETUP state.
2222 static int snd_pcm_drop(struct snd_pcm_substream *substream)
2224 struct snd_pcm_runtime *runtime;
2227 if (PCM_RUNTIME_CHECK(substream))
2229 runtime = substream->runtime;
2231 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
2232 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
2235 snd_pcm_stream_lock_irq(substream);
2237 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2238 snd_pcm_pause(substream, false);
2240 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2241 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2242 snd_pcm_stream_unlock_irq(substream);
2248 static bool is_pcm_file(struct file *file)
2250 struct inode *inode = file_inode(file);
2251 struct snd_pcm *pcm;
2254 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2256 minor = iminor(inode);
2257 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2259 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2262 snd_card_unref(pcm->card);
2269 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
2272 struct snd_pcm_file *pcm_file;
2273 struct snd_pcm_substream *substream1;
2274 struct snd_pcm_group *group, *target_group;
2275 bool nonatomic = substream->pcm->nonatomic;
2276 struct fd f = fdget(fd);
2280 if (!is_pcm_file(f.file)) {
2284 pcm_file = f.file->private_data;
2285 substream1 = pcm_file->substream;
2287 if (substream == substream1) {
2292 group = kzalloc(sizeof(*group), GFP_KERNEL);
2297 snd_pcm_group_init(group);
2299 down_write(&snd_pcm_link_rwsem);
2300 if (substream->runtime->state == SNDRV_PCM_STATE_OPEN ||
2301 substream->runtime->state != substream1->runtime->state ||
2302 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2306 if (snd_pcm_stream_linked(substream1)) {
2311 snd_pcm_stream_lock_irq(substream);
2312 if (!snd_pcm_stream_linked(substream)) {
2313 snd_pcm_group_assign(substream, group);
2314 group = NULL; /* assigned, don't free this one below */
2316 target_group = substream->group;
2317 snd_pcm_stream_unlock_irq(substream);
2319 snd_pcm_group_lock_irq(target_group, nonatomic);
2320 snd_pcm_stream_lock_nested(substream1);
2321 snd_pcm_group_assign(substream1, target_group);
2322 refcount_inc(&target_group->refs);
2323 snd_pcm_stream_unlock(substream1);
2324 snd_pcm_group_unlock_irq(target_group, nonatomic);
2326 up_write(&snd_pcm_link_rwsem);
2334 static void relink_to_local(struct snd_pcm_substream *substream)
2336 snd_pcm_stream_lock_nested(substream);
2337 snd_pcm_group_assign(substream, &substream->self_group);
2338 snd_pcm_stream_unlock(substream);
2341 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2343 struct snd_pcm_group *group;
2344 bool nonatomic = substream->pcm->nonatomic;
2345 bool do_free = false;
2348 down_write(&snd_pcm_link_rwsem);
2350 if (!snd_pcm_stream_linked(substream)) {
2355 group = substream->group;
2356 snd_pcm_group_lock_irq(group, nonatomic);
2358 relink_to_local(substream);
2359 refcount_dec(&group->refs);
2361 /* detach the last stream, too */
2362 if (list_is_singular(&group->substreams)) {
2363 relink_to_local(list_first_entry(&group->substreams,
2364 struct snd_pcm_substream,
2366 do_free = refcount_dec_and_test(&group->refs);
2369 snd_pcm_group_unlock_irq(group, nonatomic);
2374 up_write(&snd_pcm_link_rwsem);
2381 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2382 struct snd_pcm_hw_rule *rule)
2384 struct snd_interval t;
2385 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2386 hw_param_interval_c(params, rule->deps[1]), &t);
2387 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2390 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2391 struct snd_pcm_hw_rule *rule)
2393 struct snd_interval t;
2394 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2395 hw_param_interval_c(params, rule->deps[1]), &t);
2396 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2399 static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2400 struct snd_pcm_hw_rule *rule)
2402 struct snd_interval t;
2403 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2404 hw_param_interval_c(params, rule->deps[1]),
2405 (unsigned long) rule->private, &t);
2406 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2409 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2410 struct snd_pcm_hw_rule *rule)
2412 struct snd_interval t;
2413 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2414 (unsigned long) rule->private,
2415 hw_param_interval_c(params, rule->deps[1]), &t);
2416 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2419 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2420 struct snd_pcm_hw_rule *rule)
2423 const struct snd_interval *i =
2424 hw_param_interval_c(params, rule->deps[0]);
2426 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2428 pcm_for_each_format(k) {
2430 if (!snd_mask_test_format(mask, k))
2432 bits = snd_pcm_format_physical_width(k);
2434 continue; /* ignore invalid formats */
2435 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2436 snd_mask_reset(&m, (__force unsigned)k);
2438 return snd_mask_refine(mask, &m);
2441 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2442 struct snd_pcm_hw_rule *rule)
2444 struct snd_interval t;
2451 pcm_for_each_format(k) {
2453 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2455 bits = snd_pcm_format_physical_width(k);
2457 continue; /* ignore invalid formats */
2458 if (t.min > (unsigned)bits)
2460 if (t.max < (unsigned)bits)
2464 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2467 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2468 #error "Change this table"
2471 static const unsigned int rates[] = {
2472 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2473 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2476 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2477 .count = ARRAY_SIZE(rates),
2481 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2482 struct snd_pcm_hw_rule *rule)
2484 struct snd_pcm_hardware *hw = rule->private;
2485 return snd_interval_list(hw_param_interval(params, rule->var),
2486 snd_pcm_known_rates.count,
2487 snd_pcm_known_rates.list, hw->rates);
2490 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2491 struct snd_pcm_hw_rule *rule)
2493 struct snd_interval t;
2494 struct snd_pcm_substream *substream = rule->private;
2496 t.max = substream->buffer_bytes_max;
2500 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2503 static int snd_pcm_hw_rule_subformats(struct snd_pcm_hw_params *params,
2504 struct snd_pcm_hw_rule *rule)
2506 struct snd_mask *sfmask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_SUBFORMAT);
2507 struct snd_mask *fmask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2508 u32 *subformats = rule->private;
2513 /* All PCMs support at least the default STD subformat. */
2514 snd_mask_set(&m, (__force unsigned)SNDRV_PCM_SUBFORMAT_STD);
2516 pcm_for_each_format(f) {
2517 if (!snd_mask_test(fmask, (__force unsigned)f))
2520 if (f == SNDRV_PCM_FORMAT_S32_LE && *subformats)
2521 m.bits[0] |= *subformats;
2522 else if (snd_pcm_format_linear(f))
2523 snd_mask_set(&m, (__force unsigned)SNDRV_PCM_SUBFORMAT_MSBITS_MAX);
2526 return snd_mask_refine(sfmask, &m);
2529 static int snd_pcm_hw_constraint_subformats(struct snd_pcm_runtime *runtime,
2530 unsigned int cond, u32 *subformats)
2532 return snd_pcm_hw_rule_add(runtime, cond, -1,
2533 snd_pcm_hw_rule_subformats, (void *)subformats,
2534 SNDRV_PCM_HW_PARAM_SUBFORMAT,
2535 SNDRV_PCM_HW_PARAM_FORMAT, -1);
2538 static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2540 struct snd_pcm_runtime *runtime = substream->runtime;
2541 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2544 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2545 snd_mask_any(constrs_mask(constrs, k));
2548 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2549 snd_interval_any(constrs_interval(constrs, k));
2552 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2553 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2554 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2555 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2556 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2558 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2559 snd_pcm_hw_rule_format, NULL,
2560 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2563 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2564 snd_pcm_hw_rule_sample_bits, NULL,
2565 SNDRV_PCM_HW_PARAM_FORMAT,
2566 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2569 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2570 snd_pcm_hw_rule_div, NULL,
2571 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2574 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2575 snd_pcm_hw_rule_mul, NULL,
2576 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2579 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2580 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2581 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2584 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2585 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2586 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2589 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2590 snd_pcm_hw_rule_div, NULL,
2591 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2594 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2595 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2596 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2599 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2600 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2601 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2604 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2605 snd_pcm_hw_rule_div, NULL,
2606 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2609 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2610 snd_pcm_hw_rule_div, NULL,
2611 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2614 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2615 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2616 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2619 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2620 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2621 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2624 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2625 snd_pcm_hw_rule_mul, NULL,
2626 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2629 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2630 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2631 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2634 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2635 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2636 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2639 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2640 snd_pcm_hw_rule_muldivk, (void*) 8,
2641 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2644 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2645 snd_pcm_hw_rule_muldivk, (void*) 8,
2646 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2649 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2650 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2651 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2654 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2655 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2656 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2662 static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2664 struct snd_pcm_runtime *runtime = substream->runtime;
2665 struct snd_pcm_hardware *hw = &runtime->hw;
2667 unsigned int mask = 0;
2669 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2670 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
2671 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2672 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
2673 if (hw_support_mmap(substream)) {
2674 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2675 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
2676 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2677 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
2678 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2679 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
2681 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2685 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2689 err = snd_pcm_hw_constraint_subformats(runtime, 0, &hw->subformats);
2693 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2694 hw->channels_min, hw->channels_max);
2698 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2699 hw->rate_min, hw->rate_max);
2703 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2704 hw->period_bytes_min, hw->period_bytes_max);
2708 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2709 hw->periods_min, hw->periods_max);
2713 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2714 hw->period_bytes_min, hw->buffer_bytes_max);
2718 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2719 snd_pcm_hw_rule_buffer_bytes_max, substream,
2720 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2725 if (runtime->dma_bytes) {
2726 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2731 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2732 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2733 snd_pcm_hw_rule_rate, hw,
2734 SNDRV_PCM_HW_PARAM_RATE, -1);
2739 /* FIXME: this belong to lowlevel */
2740 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2745 static void pcm_release_private(struct snd_pcm_substream *substream)
2747 if (snd_pcm_stream_linked(substream))
2748 snd_pcm_unlink(substream);
2751 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2753 substream->ref_count--;
2754 if (substream->ref_count > 0)
2757 snd_pcm_drop(substream);
2758 if (substream->hw_opened) {
2759 if (substream->runtime->state != SNDRV_PCM_STATE_OPEN)
2760 do_hw_free(substream);
2761 substream->ops->close(substream);
2762 substream->hw_opened = 0;
2764 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2765 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
2766 if (substream->pcm_release) {
2767 substream->pcm_release(substream);
2768 substream->pcm_release = NULL;
2770 snd_pcm_detach_substream(substream);
2772 EXPORT_SYMBOL(snd_pcm_release_substream);
2774 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2776 struct snd_pcm_substream **rsubstream)
2778 struct snd_pcm_substream *substream;
2781 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2784 if (substream->ref_count > 1) {
2785 *rsubstream = substream;
2789 err = snd_pcm_hw_constraints_init(substream);
2791 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2795 err = substream->ops->open(substream);
2799 substream->hw_opened = 1;
2801 err = snd_pcm_hw_constraints_complete(substream);
2803 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2807 /* automatically set EXPLICIT_SYNC flag in the managed mode whenever
2808 * the DMA buffer requires it
2810 if (substream->managed_buffer_alloc &&
2811 substream->dma_buffer.dev.need_sync)
2812 substream->runtime->hw.info |= SNDRV_PCM_INFO_EXPLICIT_SYNC;
2814 *rsubstream = substream;
2818 snd_pcm_release_substream(substream);
2821 EXPORT_SYMBOL(snd_pcm_open_substream);
2823 static int snd_pcm_open_file(struct file *file,
2824 struct snd_pcm *pcm,
2827 struct snd_pcm_file *pcm_file;
2828 struct snd_pcm_substream *substream;
2831 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2835 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2836 if (pcm_file == NULL) {
2837 snd_pcm_release_substream(substream);
2840 pcm_file->substream = substream;
2841 if (substream->ref_count == 1)
2842 substream->pcm_release = pcm_release_private;
2843 file->private_data = pcm_file;
2848 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2850 struct snd_pcm *pcm;
2851 int err = nonseekable_open(inode, file);
2854 pcm = snd_lookup_minor_data(iminor(inode),
2855 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2856 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2858 snd_card_unref(pcm->card);
2862 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2864 struct snd_pcm *pcm;
2865 int err = nonseekable_open(inode, file);
2868 pcm = snd_lookup_minor_data(iminor(inode),
2869 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2870 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2872 snd_card_unref(pcm->card);
2876 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2879 wait_queue_entry_t wait;
2885 err = snd_card_file_add(pcm->card, file);
2888 if (!try_module_get(pcm->card->module)) {
2892 init_waitqueue_entry(&wait, current);
2893 add_wait_queue(&pcm->open_wait, &wait);
2894 mutex_lock(&pcm->open_mutex);
2896 err = snd_pcm_open_file(file, pcm, stream);
2899 if (err == -EAGAIN) {
2900 if (file->f_flags & O_NONBLOCK) {
2906 set_current_state(TASK_INTERRUPTIBLE);
2907 mutex_unlock(&pcm->open_mutex);
2909 mutex_lock(&pcm->open_mutex);
2910 if (pcm->card->shutdown) {
2914 if (signal_pending(current)) {
2919 remove_wait_queue(&pcm->open_wait, &wait);
2920 mutex_unlock(&pcm->open_mutex);
2926 module_put(pcm->card->module);
2928 snd_card_file_remove(pcm->card, file);
2933 static int snd_pcm_release(struct inode *inode, struct file *file)
2935 struct snd_pcm *pcm;
2936 struct snd_pcm_substream *substream;
2937 struct snd_pcm_file *pcm_file;
2939 pcm_file = file->private_data;
2940 substream = pcm_file->substream;
2941 if (snd_BUG_ON(!substream))
2943 pcm = substream->pcm;
2945 /* block until the device gets woken up as it may touch the hardware */
2946 snd_power_wait(pcm->card);
2948 mutex_lock(&pcm->open_mutex);
2949 snd_pcm_release_substream(substream);
2951 mutex_unlock(&pcm->open_mutex);
2952 wake_up(&pcm->open_wait);
2953 module_put(pcm->card->module);
2954 snd_card_file_remove(pcm->card, file);
2958 /* check and update PCM state; return 0 or a negative error
2959 * call this inside PCM lock
2961 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2963 switch (substream->runtime->state) {
2964 case SNDRV_PCM_STATE_DRAINING:
2965 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2968 case SNDRV_PCM_STATE_RUNNING:
2969 return snd_pcm_update_hw_ptr(substream);
2970 case SNDRV_PCM_STATE_PREPARED:
2971 case SNDRV_PCM_STATE_PAUSED:
2973 case SNDRV_PCM_STATE_SUSPENDED:
2975 case SNDRV_PCM_STATE_XRUN:
2982 /* increase the appl_ptr; returns the processed frames or a negative error */
2983 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2984 snd_pcm_uframes_t frames,
2985 snd_pcm_sframes_t avail)
2987 struct snd_pcm_runtime *runtime = substream->runtime;
2988 snd_pcm_sframes_t appl_ptr;
2993 if (frames > (snd_pcm_uframes_t)avail)
2995 appl_ptr = runtime->control->appl_ptr + frames;
2996 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2997 appl_ptr -= runtime->boundary;
2998 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2999 return ret < 0 ? ret : frames;
3002 /* decrease the appl_ptr; returns the processed frames or zero for error */
3003 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
3004 snd_pcm_uframes_t frames,
3005 snd_pcm_sframes_t avail)
3007 struct snd_pcm_runtime *runtime = substream->runtime;
3008 snd_pcm_sframes_t appl_ptr;
3013 if (frames > (snd_pcm_uframes_t)avail)
3015 appl_ptr = runtime->control->appl_ptr - frames;
3017 appl_ptr += runtime->boundary;
3018 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
3019 /* NOTE: we return zero for errors because PulseAudio gets depressed
3020 * upon receiving an error from rewind ioctl and stops processing
3021 * any longer. Returning zero means that no rewind is done, so
3022 * it's not absolutely wrong to answer like that.
3024 return ret < 0 ? 0 : frames;
3027 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
3028 snd_pcm_uframes_t frames)
3030 snd_pcm_sframes_t ret;
3035 snd_pcm_stream_lock_irq(substream);
3036 ret = do_pcm_hwsync(substream);
3038 ret = rewind_appl_ptr(substream, frames,
3039 snd_pcm_hw_avail(substream));
3040 snd_pcm_stream_unlock_irq(substream);
3042 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3046 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
3047 snd_pcm_uframes_t frames)
3049 snd_pcm_sframes_t ret;
3054 snd_pcm_stream_lock_irq(substream);
3055 ret = do_pcm_hwsync(substream);
3057 ret = forward_appl_ptr(substream, frames,
3058 snd_pcm_avail(substream));
3059 snd_pcm_stream_unlock_irq(substream);
3061 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3065 static int snd_pcm_delay(struct snd_pcm_substream *substream,
3066 snd_pcm_sframes_t *delay)
3070 snd_pcm_stream_lock_irq(substream);
3071 err = do_pcm_hwsync(substream);
3073 *delay = snd_pcm_calc_delay(substream);
3074 snd_pcm_stream_unlock_irq(substream);
3075 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
3080 static inline int snd_pcm_hwsync(struct snd_pcm_substream *substream)
3082 return snd_pcm_delay(substream, NULL);
3085 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
3086 struct snd_pcm_sync_ptr __user *_sync_ptr)
3088 struct snd_pcm_runtime *runtime = substream->runtime;
3089 struct snd_pcm_sync_ptr sync_ptr;
3090 volatile struct snd_pcm_mmap_status *status;
3091 volatile struct snd_pcm_mmap_control *control;
3094 memset(&sync_ptr, 0, sizeof(sync_ptr));
3095 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
3097 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
3099 status = runtime->status;
3100 control = runtime->control;
3101 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3102 err = snd_pcm_hwsync(substream);
3106 snd_pcm_stream_lock_irq(substream);
3107 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
3108 err = pcm_lib_apply_appl_ptr(substream,
3109 sync_ptr.c.control.appl_ptr);
3111 snd_pcm_stream_unlock_irq(substream);
3115 sync_ptr.c.control.appl_ptr = control->appl_ptr;
3117 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3118 control->avail_min = sync_ptr.c.control.avail_min;
3120 sync_ptr.c.control.avail_min = control->avail_min;
3121 sync_ptr.s.status.state = status->state;
3122 sync_ptr.s.status.hw_ptr = status->hw_ptr;
3123 sync_ptr.s.status.tstamp = status->tstamp;
3124 sync_ptr.s.status.suspended_state = status->suspended_state;
3125 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
3126 snd_pcm_stream_unlock_irq(substream);
3127 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL))
3128 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3129 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
3134 struct snd_pcm_mmap_status32 {
3135 snd_pcm_state_t state;
3140 snd_pcm_state_t suspended_state;
3141 s32 audio_tstamp_sec;
3142 s32 audio_tstamp_nsec;
3145 struct snd_pcm_mmap_control32 {
3150 struct snd_pcm_sync_ptr32 {
3153 struct snd_pcm_mmap_status32 status;
3154 unsigned char reserved[64];
3157 struct snd_pcm_mmap_control32 control;
3158 unsigned char reserved[64];
3162 /* recalcuate the boundary within 32bit */
3163 static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3165 snd_pcm_uframes_t boundary;
3167 if (! runtime->buffer_size)
3169 boundary = runtime->buffer_size;
3170 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3175 static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3176 struct snd_pcm_sync_ptr32 __user *src)
3178 struct snd_pcm_runtime *runtime = substream->runtime;
3179 volatile struct snd_pcm_mmap_status *status;
3180 volatile struct snd_pcm_mmap_control *control;
3182 struct snd_pcm_mmap_control scontrol;
3183 struct snd_pcm_mmap_status sstatus;
3184 snd_pcm_uframes_t boundary;
3187 if (snd_BUG_ON(!runtime))
3190 if (get_user(sflags, &src->flags) ||
3191 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3192 get_user(scontrol.avail_min, &src->c.control.avail_min))
3194 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3195 err = snd_pcm_hwsync(substream);
3199 status = runtime->status;
3200 control = runtime->control;
3201 boundary = recalculate_boundary(runtime);
3203 boundary = 0x7fffffff;
3204 snd_pcm_stream_lock_irq(substream);
3205 /* FIXME: we should consider the boundary for the sync from app */
3206 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL)) {
3207 err = pcm_lib_apply_appl_ptr(substream,
3210 snd_pcm_stream_unlock_irq(substream);
3214 scontrol.appl_ptr = control->appl_ptr % boundary;
3215 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3216 control->avail_min = scontrol.avail_min;
3218 scontrol.avail_min = control->avail_min;
3219 sstatus.state = status->state;
3220 sstatus.hw_ptr = status->hw_ptr % boundary;
3221 sstatus.tstamp = status->tstamp;
3222 sstatus.suspended_state = status->suspended_state;
3223 sstatus.audio_tstamp = status->audio_tstamp;
3224 snd_pcm_stream_unlock_irq(substream);
3225 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3226 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3227 if (put_user(sstatus.state, &src->s.status.state) ||
3228 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
3229 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3230 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
3231 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
3232 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3233 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
3234 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3235 put_user(scontrol.avail_min, &src->c.control.avail_min))
3240 #define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
3242 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3244 struct snd_pcm_runtime *runtime = substream->runtime;
3247 if (get_user(arg, _arg))
3249 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3251 runtime->tstamp_type = arg;
3255 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3256 struct snd_xferi __user *_xferi)
3258 struct snd_xferi xferi;
3259 struct snd_pcm_runtime *runtime = substream->runtime;
3260 snd_pcm_sframes_t result;
3262 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3264 if (put_user(0, &_xferi->result))
3266 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3268 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3269 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3271 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
3272 if (put_user(result, &_xferi->result))
3274 return result < 0 ? result : 0;
3277 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3278 struct snd_xfern __user *_xfern)
3280 struct snd_xfern xfern;
3281 struct snd_pcm_runtime *runtime = substream->runtime;
3283 snd_pcm_sframes_t result;
3285 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3287 if (runtime->channels > 128)
3289 if (put_user(0, &_xfern->result))
3291 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3294 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3296 return PTR_ERR(bufs);
3297 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3298 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3300 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3302 if (put_user(result, &_xfern->result))
3304 return result < 0 ? result : 0;
3307 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3308 snd_pcm_uframes_t __user *_frames)
3310 snd_pcm_uframes_t frames;
3311 snd_pcm_sframes_t result;
3313 if (get_user(frames, _frames))
3315 if (put_user(0, _frames))
3317 result = snd_pcm_rewind(substream, frames);
3318 if (put_user(result, _frames))
3320 return result < 0 ? result : 0;
3323 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3324 snd_pcm_uframes_t __user *_frames)
3326 snd_pcm_uframes_t frames;
3327 snd_pcm_sframes_t result;
3329 if (get_user(frames, _frames))
3331 if (put_user(0, _frames))
3333 result = snd_pcm_forward(substream, frames);
3334 if (put_user(result, _frames))
3336 return result < 0 ? result : 0;
3339 static int snd_pcm_common_ioctl(struct file *file,
3340 struct snd_pcm_substream *substream,
3341 unsigned int cmd, void __user *arg)
3343 struct snd_pcm_file *pcm_file = file->private_data;
3346 if (PCM_RUNTIME_CHECK(substream))
3349 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3352 res = snd_power_wait(substream->pcm->card);
3357 case SNDRV_PCM_IOCTL_PVERSION:
3358 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3359 case SNDRV_PCM_IOCTL_INFO:
3360 return snd_pcm_info_user(substream, arg);
3361 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3363 case SNDRV_PCM_IOCTL_TTSTAMP:
3364 return snd_pcm_tstamp(substream, arg);
3365 case SNDRV_PCM_IOCTL_USER_PVERSION:
3366 if (get_user(pcm_file->user_pversion,
3367 (unsigned int __user *)arg))
3370 case SNDRV_PCM_IOCTL_HW_REFINE:
3371 return snd_pcm_hw_refine_user(substream, arg);
3372 case SNDRV_PCM_IOCTL_HW_PARAMS:
3373 return snd_pcm_hw_params_user(substream, arg);
3374 case SNDRV_PCM_IOCTL_HW_FREE:
3375 return snd_pcm_hw_free(substream);
3376 case SNDRV_PCM_IOCTL_SW_PARAMS:
3377 return snd_pcm_sw_params_user(substream, arg);
3378 case SNDRV_PCM_IOCTL_STATUS32:
3379 return snd_pcm_status_user32(substream, arg, false);
3380 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3381 return snd_pcm_status_user32(substream, arg, true);
3382 case SNDRV_PCM_IOCTL_STATUS64:
3383 return snd_pcm_status_user64(substream, arg, false);
3384 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3385 return snd_pcm_status_user64(substream, arg, true);
3386 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3387 return snd_pcm_channel_info_user(substream, arg);
3388 case SNDRV_PCM_IOCTL_PREPARE:
3389 return snd_pcm_prepare(substream, file);
3390 case SNDRV_PCM_IOCTL_RESET:
3391 return snd_pcm_reset(substream);
3392 case SNDRV_PCM_IOCTL_START:
3393 return snd_pcm_start_lock_irq(substream);
3394 case SNDRV_PCM_IOCTL_LINK:
3395 return snd_pcm_link(substream, (int)(unsigned long) arg);
3396 case SNDRV_PCM_IOCTL_UNLINK:
3397 return snd_pcm_unlink(substream);
3398 case SNDRV_PCM_IOCTL_RESUME:
3399 return snd_pcm_resume(substream);
3400 case SNDRV_PCM_IOCTL_XRUN:
3401 return snd_pcm_xrun(substream);
3402 case SNDRV_PCM_IOCTL_HWSYNC:
3403 return snd_pcm_hwsync(substream);
3404 case SNDRV_PCM_IOCTL_DELAY:
3406 snd_pcm_sframes_t delay = 0;
3407 snd_pcm_sframes_t __user *res = arg;
3410 err = snd_pcm_delay(substream, &delay);
3413 if (put_user(delay, res))
3417 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3418 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3419 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
3420 return snd_pcm_sync_ptr(substream, arg);
3421 #ifdef CONFIG_SND_SUPPORT_OLD_API
3422 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3423 return snd_pcm_hw_refine_old_user(substream, arg);
3424 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3425 return snd_pcm_hw_params_old_user(substream, arg);
3427 case SNDRV_PCM_IOCTL_DRAIN:
3428 return snd_pcm_drain(substream, file);
3429 case SNDRV_PCM_IOCTL_DROP:
3430 return snd_pcm_drop(substream);
3431 case SNDRV_PCM_IOCTL_PAUSE:
3432 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
3433 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3434 case SNDRV_PCM_IOCTL_READI_FRAMES:
3435 return snd_pcm_xferi_frames_ioctl(substream, arg);
3436 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3437 case SNDRV_PCM_IOCTL_READN_FRAMES:
3438 return snd_pcm_xfern_frames_ioctl(substream, arg);
3439 case SNDRV_PCM_IOCTL_REWIND:
3440 return snd_pcm_rewind_ioctl(substream, arg);
3441 case SNDRV_PCM_IOCTL_FORWARD:
3442 return snd_pcm_forward_ioctl(substream, arg);
3444 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3448 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3451 struct snd_pcm_file *pcm_file;
3453 pcm_file = file->private_data;
3455 if (((cmd >> 8) & 0xff) != 'A')
3458 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3459 (void __user *)arg);
3463 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3464 * @substream: PCM substream
3466 * @arg: IOCTL argument
3468 * The function is provided primarily for OSS layer and USB gadget drivers,
3469 * and it allows only the limited set of ioctls (hw_params, sw_params,
3470 * prepare, start, drain, drop, forward).
3472 * Return: zero if successful, or a negative error code
3474 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3475 unsigned int cmd, void *arg)
3477 snd_pcm_uframes_t *frames = arg;
3478 snd_pcm_sframes_t result;
3480 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3484 case SNDRV_PCM_IOCTL_FORWARD:
3486 /* provided only for OSS; capture-only and no value returned */
3487 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3489 result = snd_pcm_forward(substream, *frames);
3490 return result < 0 ? result : 0;
3492 case SNDRV_PCM_IOCTL_HW_PARAMS:
3493 return snd_pcm_hw_params(substream, arg);
3494 case SNDRV_PCM_IOCTL_SW_PARAMS:
3495 return snd_pcm_sw_params(substream, arg);
3496 case SNDRV_PCM_IOCTL_PREPARE:
3497 return snd_pcm_prepare(substream, NULL);
3498 case SNDRV_PCM_IOCTL_START:
3499 return snd_pcm_start_lock_irq(substream);
3500 case SNDRV_PCM_IOCTL_DRAIN:
3501 return snd_pcm_drain(substream, NULL);
3502 case SNDRV_PCM_IOCTL_DROP:
3503 return snd_pcm_drop(substream);
3504 case SNDRV_PCM_IOCTL_DELAY:
3505 return snd_pcm_delay(substream, frames);
3510 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3512 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3515 struct snd_pcm_file *pcm_file;
3516 struct snd_pcm_substream *substream;
3517 struct snd_pcm_runtime *runtime;
3518 snd_pcm_sframes_t result;
3520 pcm_file = file->private_data;
3521 substream = pcm_file->substream;
3522 if (PCM_RUNTIME_CHECK(substream))
3524 runtime = substream->runtime;
3525 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3526 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3528 if (!frame_aligned(runtime, count))
3530 count = bytes_to_frames(runtime, count);
3531 result = snd_pcm_lib_read(substream, buf, count);
3533 result = frames_to_bytes(runtime, result);
3537 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3538 size_t count, loff_t * offset)
3540 struct snd_pcm_file *pcm_file;
3541 struct snd_pcm_substream *substream;
3542 struct snd_pcm_runtime *runtime;
3543 snd_pcm_sframes_t result;
3545 pcm_file = file->private_data;
3546 substream = pcm_file->substream;
3547 if (PCM_RUNTIME_CHECK(substream))
3549 runtime = substream->runtime;
3550 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3551 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3553 if (!frame_aligned(runtime, count))
3555 count = bytes_to_frames(runtime, count);
3556 result = snd_pcm_lib_write(substream, buf, count);
3558 result = frames_to_bytes(runtime, result);
3562 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3564 struct snd_pcm_file *pcm_file;
3565 struct snd_pcm_substream *substream;
3566 struct snd_pcm_runtime *runtime;
3567 snd_pcm_sframes_t result;
3570 snd_pcm_uframes_t frames;
3571 const struct iovec *iov = iter_iov(to);
3573 pcm_file = iocb->ki_filp->private_data;
3574 substream = pcm_file->substream;
3575 if (PCM_RUNTIME_CHECK(substream))
3577 runtime = substream->runtime;
3578 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3579 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3581 if (!user_backed_iter(to))
3583 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3585 if (!frame_aligned(runtime, iov->iov_len))
3587 frames = bytes_to_samples(runtime, iov->iov_len);
3588 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3591 for (i = 0; i < to->nr_segs; ++i) {
3592 bufs[i] = iov->iov_base;
3595 result = snd_pcm_lib_readv(substream, bufs, frames);
3597 result = frames_to_bytes(runtime, result);
3602 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3604 struct snd_pcm_file *pcm_file;
3605 struct snd_pcm_substream *substream;
3606 struct snd_pcm_runtime *runtime;
3607 snd_pcm_sframes_t result;
3610 snd_pcm_uframes_t frames;
3611 const struct iovec *iov = iter_iov(from);
3613 pcm_file = iocb->ki_filp->private_data;
3614 substream = pcm_file->substream;
3615 if (PCM_RUNTIME_CHECK(substream))
3617 runtime = substream->runtime;
3618 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3619 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3621 if (!user_backed_iter(from))
3623 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3624 !frame_aligned(runtime, iov->iov_len))
3626 frames = bytes_to_samples(runtime, iov->iov_len);
3627 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3630 for (i = 0; i < from->nr_segs; ++i) {
3631 bufs[i] = iov->iov_base;
3634 result = snd_pcm_lib_writev(substream, bufs, frames);
3636 result = frames_to_bytes(runtime, result);
3641 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3643 struct snd_pcm_file *pcm_file;
3644 struct snd_pcm_substream *substream;
3645 struct snd_pcm_runtime *runtime;
3647 snd_pcm_uframes_t avail;
3649 pcm_file = file->private_data;
3651 substream = pcm_file->substream;
3652 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3653 ok = EPOLLOUT | EPOLLWRNORM;
3655 ok = EPOLLIN | EPOLLRDNORM;
3656 if (PCM_RUNTIME_CHECK(substream))
3657 return ok | EPOLLERR;
3659 runtime = substream->runtime;
3660 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3661 return ok | EPOLLERR;
3663 poll_wait(file, &runtime->sleep, wait);
3666 snd_pcm_stream_lock_irq(substream);
3667 avail = snd_pcm_avail(substream);
3668 switch (runtime->state) {
3669 case SNDRV_PCM_STATE_RUNNING:
3670 case SNDRV_PCM_STATE_PREPARED:
3671 case SNDRV_PCM_STATE_PAUSED:
3672 if (avail >= runtime->control->avail_min)
3675 case SNDRV_PCM_STATE_DRAINING:
3676 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3683 mask = ok | EPOLLERR;
3686 snd_pcm_stream_unlock_irq(substream);
3695 * Only on coherent architectures, we can mmap the status and the control records
3696 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3698 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3700 * mmap status record
3702 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3704 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3705 struct snd_pcm_runtime *runtime;
3707 if (substream == NULL)
3708 return VM_FAULT_SIGBUS;
3709 runtime = substream->runtime;
3710 vmf->page = virt_to_page(runtime->status);
3711 get_page(vmf->page);
3715 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3717 .fault = snd_pcm_mmap_status_fault,
3720 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3721 struct vm_area_struct *area)
3724 if (!(area->vm_flags & VM_READ))
3726 size = area->vm_end - area->vm_start;
3727 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3729 area->vm_ops = &snd_pcm_vm_ops_status;
3730 area->vm_private_data = substream;
3731 vm_flags_mod(area, VM_DONTEXPAND | VM_DONTDUMP,
3732 VM_WRITE | VM_MAYWRITE);
3738 * mmap control record
3740 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3742 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3743 struct snd_pcm_runtime *runtime;
3745 if (substream == NULL)
3746 return VM_FAULT_SIGBUS;
3747 runtime = substream->runtime;
3748 vmf->page = virt_to_page(runtime->control);
3749 get_page(vmf->page);
3753 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3755 .fault = snd_pcm_mmap_control_fault,
3758 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3759 struct vm_area_struct *area)
3762 if (!(area->vm_flags & VM_READ))
3764 size = area->vm_end - area->vm_start;
3765 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3767 area->vm_ops = &snd_pcm_vm_ops_control;
3768 area->vm_private_data = substream;
3769 vm_flags_set(area, VM_DONTEXPAND | VM_DONTDUMP);
3773 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3775 /* If drivers require the explicit sync (typically for non-coherent
3776 * pages), we have to disable the mmap of status and control data
3777 * to enforce the control via SYNC_PTR ioctl.
3779 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3781 /* See pcm_control_mmap_allowed() below.
3782 * Since older alsa-lib requires both status and control mmaps to be
3783 * coupled, we have to disable the status mmap for old alsa-lib, too.
3785 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3786 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3791 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3793 if (pcm_file->no_compat_mmap)
3796 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3798 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3799 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3800 * thus it effectively assures the manual update of appl_ptr.
3802 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3807 #else /* ! coherent mmap */
3809 * don't support mmap for status and control records.
3811 #define pcm_status_mmap_allowed(pcm_file) false
3812 #define pcm_control_mmap_allowed(pcm_file) false
3814 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3815 struct vm_area_struct *area)
3819 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3820 struct vm_area_struct *area)
3824 #endif /* coherent mmap */
3827 * fault callback for mmapping a RAM page
3829 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3831 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3832 struct snd_pcm_runtime *runtime;
3833 unsigned long offset;
3837 if (substream == NULL)
3838 return VM_FAULT_SIGBUS;
3839 runtime = substream->runtime;
3840 offset = vmf->pgoff << PAGE_SHIFT;
3841 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3842 if (offset > dma_bytes - PAGE_SIZE)
3843 return VM_FAULT_SIGBUS;
3844 if (substream->ops->page)
3845 page = substream->ops->page(substream, offset);
3846 else if (!snd_pcm_get_dma_buf(substream))
3847 page = virt_to_page(runtime->dma_area + offset);
3849 page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
3851 return VM_FAULT_SIGBUS;
3857 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3858 .open = snd_pcm_mmap_data_open,
3859 .close = snd_pcm_mmap_data_close,
3862 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3863 .open = snd_pcm_mmap_data_open,
3864 .close = snd_pcm_mmap_data_close,
3865 .fault = snd_pcm_mmap_data_fault,
3869 * mmap the DMA buffer on RAM
3873 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3874 * @substream: PCM substream
3877 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3878 * this function is invoked implicitly.
3880 * Return: zero if successful, or a negative error code
3882 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3883 struct vm_area_struct *area)
3885 vm_flags_set(area, VM_DONTEXPAND | VM_DONTDUMP);
3886 if (!substream->ops->page &&
3887 !snd_dma_buffer_mmap(snd_pcm_get_dma_buf(substream), area))
3889 /* mmap with fault handler */
3890 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3893 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3896 * mmap the DMA buffer on I/O memory area
3898 #if SNDRV_PCM_INFO_MMAP_IOMEM
3900 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3901 * @substream: PCM substream
3904 * When your hardware uses the iomapped pages as the hardware buffer and
3905 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3906 * is supposed to work only on limited architectures.
3908 * Return: zero if successful, or a negative error code
3910 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3911 struct vm_area_struct *area)
3913 struct snd_pcm_runtime *runtime = substream->runtime;
3915 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3916 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3918 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3919 #endif /* SNDRV_PCM_INFO_MMAP */
3924 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3925 struct vm_area_struct *area)
3927 struct snd_pcm_runtime *runtime;
3929 unsigned long offset;
3933 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3934 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3937 if (!(area->vm_flags & VM_READ))
3940 runtime = substream->runtime;
3941 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3943 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3945 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3946 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3948 size = area->vm_end - area->vm_start;
3949 offset = area->vm_pgoff << PAGE_SHIFT;
3950 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3951 if ((size_t)size > dma_bytes)
3953 if (offset > dma_bytes - size)
3956 area->vm_ops = &snd_pcm_vm_ops_data;
3957 area->vm_private_data = substream;
3958 if (substream->ops->mmap)
3959 err = substream->ops->mmap(substream, area);
3961 err = snd_pcm_lib_default_mmap(substream, area);
3963 atomic_inc(&substream->mmap_count);
3966 EXPORT_SYMBOL(snd_pcm_mmap_data);
3968 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3970 struct snd_pcm_file * pcm_file;
3971 struct snd_pcm_substream *substream;
3972 unsigned long offset;
3974 pcm_file = file->private_data;
3975 substream = pcm_file->substream;
3976 if (PCM_RUNTIME_CHECK(substream))
3978 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3981 offset = area->vm_pgoff << PAGE_SHIFT;
3983 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3984 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3987 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
3988 if (!pcm_status_mmap_allowed(pcm_file))
3990 return snd_pcm_mmap_status(substream, file, area);
3991 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3992 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3995 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
3996 if (!pcm_control_mmap_allowed(pcm_file))
3998 return snd_pcm_mmap_control(substream, file, area);
4000 return snd_pcm_mmap_data(substream, file, area);
4005 static int snd_pcm_fasync(int fd, struct file * file, int on)
4007 struct snd_pcm_file * pcm_file;
4008 struct snd_pcm_substream *substream;
4009 struct snd_pcm_runtime *runtime;
4011 pcm_file = file->private_data;
4012 substream = pcm_file->substream;
4013 if (PCM_RUNTIME_CHECK(substream))
4015 runtime = substream->runtime;
4016 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
4018 return snd_fasync_helper(fd, file, on, &runtime->fasync);
4024 #ifdef CONFIG_COMPAT
4025 #include "pcm_compat.c"
4027 #define snd_pcm_ioctl_compat NULL
4031 * To be removed helpers to keep binary compatibility
4034 #ifdef CONFIG_SND_SUPPORT_OLD_API
4035 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
4036 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
4038 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
4039 struct snd_pcm_hw_params_old *oparams)
4043 memset(params, 0, sizeof(*params));
4044 params->flags = oparams->flags;
4045 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
4046 params->masks[i].bits[0] = oparams->masks[i];
4047 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
4048 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
4049 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
4050 params->info = oparams->info;
4051 params->msbits = oparams->msbits;
4052 params->rate_num = oparams->rate_num;
4053 params->rate_den = oparams->rate_den;
4054 params->fifo_size = oparams->fifo_size;
4057 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
4058 struct snd_pcm_hw_params *params)
4062 memset(oparams, 0, sizeof(*oparams));
4063 oparams->flags = params->flags;
4064 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
4065 oparams->masks[i] = params->masks[i].bits[0];
4066 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
4067 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
4068 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
4069 oparams->info = params->info;
4070 oparams->msbits = params->msbits;
4071 oparams->rate_num = params->rate_num;
4072 oparams->rate_den = params->rate_den;
4073 oparams->fifo_size = params->fifo_size;
4076 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
4077 struct snd_pcm_hw_params_old __user * _oparams)
4079 struct snd_pcm_hw_params *params;
4080 struct snd_pcm_hw_params_old *oparams = NULL;
4083 params = kmalloc(sizeof(*params), GFP_KERNEL);
4087 oparams = memdup_user(_oparams, sizeof(*oparams));
4088 if (IS_ERR(oparams)) {
4089 err = PTR_ERR(oparams);
4092 snd_pcm_hw_convert_from_old_params(params, oparams);
4093 err = snd_pcm_hw_refine(substream, params);
4097 err = fixup_unreferenced_params(substream, params);
4101 snd_pcm_hw_convert_to_old_params(oparams, params);
4102 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4111 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
4112 struct snd_pcm_hw_params_old __user * _oparams)
4114 struct snd_pcm_hw_params *params;
4115 struct snd_pcm_hw_params_old *oparams = NULL;
4118 params = kmalloc(sizeof(*params), GFP_KERNEL);
4122 oparams = memdup_user(_oparams, sizeof(*oparams));
4123 if (IS_ERR(oparams)) {
4124 err = PTR_ERR(oparams);
4128 snd_pcm_hw_convert_from_old_params(params, oparams);
4129 err = snd_pcm_hw_params(substream, params);
4133 snd_pcm_hw_convert_to_old_params(oparams, params);
4134 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4142 #endif /* CONFIG_SND_SUPPORT_OLD_API */
4145 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
4148 unsigned long pgoff,
4149 unsigned long flags)
4151 struct snd_pcm_file *pcm_file = file->private_data;
4152 struct snd_pcm_substream *substream = pcm_file->substream;
4153 struct snd_pcm_runtime *runtime = substream->runtime;
4154 unsigned long offset = pgoff << PAGE_SHIFT;
4157 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
4158 return (unsigned long)runtime->status;
4159 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
4160 return (unsigned long)runtime->control;
4162 return (unsigned long)runtime->dma_area + offset;
4166 # define snd_pcm_get_unmapped_area NULL
4173 const struct file_operations snd_pcm_f_ops[2] = {
4175 .owner = THIS_MODULE,
4176 .write = snd_pcm_write,
4177 .write_iter = snd_pcm_writev,
4178 .open = snd_pcm_playback_open,
4179 .release = snd_pcm_release,
4180 .llseek = no_llseek,
4181 .poll = snd_pcm_poll,
4182 .unlocked_ioctl = snd_pcm_ioctl,
4183 .compat_ioctl = snd_pcm_ioctl_compat,
4184 .mmap = snd_pcm_mmap,
4185 .fasync = snd_pcm_fasync,
4186 .get_unmapped_area = snd_pcm_get_unmapped_area,
4189 .owner = THIS_MODULE,
4190 .read = snd_pcm_read,
4191 .read_iter = snd_pcm_readv,
4192 .open = snd_pcm_capture_open,
4193 .release = snd_pcm_release,
4194 .llseek = no_llseek,
4195 .poll = snd_pcm_poll,
4196 .unlocked_ioctl = snd_pcm_ioctl,
4197 .compat_ioctl = snd_pcm_ioctl_compat,
4198 .mmap = snd_pcm_mmap,
4199 .fasync = snd_pcm_fasync,
4200 .get_unmapped_area = snd_pcm_get_unmapped_area,