1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
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;
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;
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;
368 struct snd_interval old_interval;
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;
484 if (!params->msbits) {
485 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
486 if (snd_interval_single(i))
487 params->msbits = snd_interval_value(i);
490 if (!params->rate_den) {
491 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
492 if (snd_interval_single(i)) {
493 params->rate_num = snd_interval_value(i);
494 params->rate_den = 1;
498 if (!params->fifo_size) {
499 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
500 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
501 if (snd_mask_single(m) && snd_interval_single(i)) {
502 err = snd_pcm_ops_ioctl(substream,
503 SNDRV_PCM_IOCTL1_FIFO_SIZE,
511 params->info = substream->runtime->hw.info;
512 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
513 SNDRV_PCM_INFO_DRAIN_TRIGGER);
514 if (!hw_support_mmap(substream))
515 params->info &= ~(SNDRV_PCM_INFO_MMAP |
516 SNDRV_PCM_INFO_MMAP_VALID);
522 int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
523 struct snd_pcm_hw_params *params)
528 params->fifo_size = 0;
529 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
531 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
532 params->rate_num = 0;
533 params->rate_den = 0;
536 err = constrain_mask_params(substream, params);
540 err = constrain_interval_params(substream, params);
544 err = constrain_params_by_rules(substream, params);
552 EXPORT_SYMBOL(snd_pcm_hw_refine);
554 static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
555 struct snd_pcm_hw_params __user * _params)
557 struct snd_pcm_hw_params *params;
560 params = memdup_user(_params, sizeof(*params));
562 return PTR_ERR(params);
564 err = snd_pcm_hw_refine(substream, params);
568 err = fixup_unreferenced_params(substream, params);
572 if (copy_to_user(_params, params, sizeof(*params)))
579 static int period_to_usecs(struct snd_pcm_runtime *runtime)
584 return -1; /* invalid */
586 /* take 75% of period time as the deadline */
587 usecs = (750000 / runtime->rate) * runtime->period_size;
588 usecs += ((750000 % runtime->rate) * runtime->period_size) /
594 static void snd_pcm_set_state(struct snd_pcm_substream *substream,
595 snd_pcm_state_t state)
597 snd_pcm_stream_lock_irq(substream);
598 if (substream->runtime->state != SNDRV_PCM_STATE_DISCONNECTED)
599 __snd_pcm_set_state(substream->runtime, state);
600 snd_pcm_stream_unlock_irq(substream);
603 static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
606 #ifdef CONFIG_SND_PCM_TIMER
607 if (substream->timer)
608 snd_timer_notify(substream->timer, event,
609 &substream->runtime->trigger_tstamp);
613 void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
615 if (substream->runtime && substream->runtime->stop_operating) {
616 substream->runtime->stop_operating = false;
617 if (substream->ops && substream->ops->sync_stop)
618 substream->ops->sync_stop(substream);
619 else if (sync_irq && substream->pcm->card->sync_irq > 0)
620 synchronize_irq(substream->pcm->card->sync_irq);
625 * snd_pcm_hw_params_choose - choose a configuration defined by @params
627 * @params: the hw_params instance
629 * Choose one configuration from configuration space defined by @params.
630 * The configuration chosen is that obtained fixing in this order:
631 * first access, first format, first subformat, min channels,
632 * min rate, min period time, max buffer size, min tick time
634 * Return: Zero if successful, or a negative error code on failure.
636 static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
637 struct snd_pcm_hw_params *params)
639 static const int vars[] = {
640 SNDRV_PCM_HW_PARAM_ACCESS,
641 SNDRV_PCM_HW_PARAM_FORMAT,
642 SNDRV_PCM_HW_PARAM_SUBFORMAT,
643 SNDRV_PCM_HW_PARAM_CHANNELS,
644 SNDRV_PCM_HW_PARAM_RATE,
645 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
646 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
647 SNDRV_PCM_HW_PARAM_TICK_TIME,
651 struct snd_mask old_mask;
652 struct snd_interval old_interval;
655 for (v = vars; *v != -1; v++) {
656 /* Keep old parameter to trace. */
657 if (trace_hw_mask_param_enabled()) {
659 old_mask = *hw_param_mask(params, *v);
661 if (trace_hw_interval_param_enabled()) {
662 if (hw_is_interval(*v))
663 old_interval = *hw_param_interval(params, *v);
665 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
666 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
668 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
674 /* Trace the changed parameter. */
675 if (hw_is_mask(*v)) {
676 trace_hw_mask_param(pcm, *v, 0, &old_mask,
677 hw_param_mask(params, *v));
679 if (hw_is_interval(*v)) {
680 trace_hw_interval_param(pcm, *v, 0, &old_interval,
681 hw_param_interval(params, *v));
688 /* acquire buffer_mutex; if it's in r/w operation, return -EBUSY, otherwise
689 * block the further r/w operations
691 static int snd_pcm_buffer_access_lock(struct snd_pcm_runtime *runtime)
693 if (!atomic_dec_unless_positive(&runtime->buffer_accessing))
695 mutex_lock(&runtime->buffer_mutex);
696 return 0; /* keep buffer_mutex, unlocked by below */
699 /* release buffer_mutex and clear r/w access flag */
700 static void snd_pcm_buffer_access_unlock(struct snd_pcm_runtime *runtime)
702 mutex_unlock(&runtime->buffer_mutex);
703 atomic_inc(&runtime->buffer_accessing);
706 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
707 #define is_oss_stream(substream) ((substream)->oss.oss)
709 #define is_oss_stream(substream) false
712 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
713 struct snd_pcm_hw_params *params)
715 struct snd_pcm_runtime *runtime;
718 snd_pcm_uframes_t frames;
720 if (PCM_RUNTIME_CHECK(substream))
722 runtime = substream->runtime;
723 err = snd_pcm_buffer_access_lock(runtime);
726 snd_pcm_stream_lock_irq(substream);
727 switch (runtime->state) {
728 case SNDRV_PCM_STATE_OPEN:
729 case SNDRV_PCM_STATE_SETUP:
730 case SNDRV_PCM_STATE_PREPARED:
731 if (!is_oss_stream(substream) &&
732 atomic_read(&substream->mmap_count))
739 snd_pcm_stream_unlock_irq(substream);
743 snd_pcm_sync_stop(substream, true);
746 err = snd_pcm_hw_refine(substream, params);
750 err = snd_pcm_hw_params_choose(substream, params);
754 err = fixup_unreferenced_params(substream, params);
758 if (substream->managed_buffer_alloc) {
759 err = snd_pcm_lib_malloc_pages(substream,
760 params_buffer_bytes(params));
763 runtime->buffer_changed = err > 0;
766 if (substream->ops->hw_params != NULL) {
767 err = substream->ops->hw_params(substream, params);
772 runtime->access = params_access(params);
773 runtime->format = params_format(params);
774 runtime->subformat = params_subformat(params);
775 runtime->channels = params_channels(params);
776 runtime->rate = params_rate(params);
777 runtime->period_size = params_period_size(params);
778 runtime->periods = params_periods(params);
779 runtime->buffer_size = params_buffer_size(params);
780 runtime->info = params->info;
781 runtime->rate_num = params->rate_num;
782 runtime->rate_den = params->rate_den;
783 runtime->no_period_wakeup =
784 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
785 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
787 bits = snd_pcm_format_physical_width(runtime->format);
788 runtime->sample_bits = bits;
789 bits *= runtime->channels;
790 runtime->frame_bits = bits;
792 while (bits % 8 != 0) {
796 runtime->byte_align = bits / 8;
797 runtime->min_align = frames;
799 /* Default sw params */
800 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
801 runtime->period_step = 1;
802 runtime->control->avail_min = runtime->period_size;
803 runtime->start_threshold = 1;
804 runtime->stop_threshold = runtime->buffer_size;
805 runtime->silence_threshold = 0;
806 runtime->silence_size = 0;
807 runtime->boundary = runtime->buffer_size;
808 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
809 runtime->boundary *= 2;
811 /* clear the buffer for avoiding possible kernel info leaks */
812 if (runtime->dma_area && !substream->ops->copy_user) {
813 size_t size = runtime->dma_bytes;
815 if (runtime->info & SNDRV_PCM_INFO_MMAP)
816 size = PAGE_ALIGN(size);
817 memset(runtime->dma_area, 0, size);
820 snd_pcm_timer_resolution_change(substream);
821 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
823 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
824 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
825 usecs = period_to_usecs(runtime);
827 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
832 /* hardware might be unusable from this time,
833 * so we force application to retry to set
834 * the correct hardware parameter settings
836 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
837 if (substream->ops->hw_free != NULL)
838 substream->ops->hw_free(substream);
839 if (substream->managed_buffer_alloc)
840 snd_pcm_lib_free_pages(substream);
843 snd_pcm_buffer_access_unlock(runtime);
847 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
848 struct snd_pcm_hw_params __user * _params)
850 struct snd_pcm_hw_params *params;
853 params = memdup_user(_params, sizeof(*params));
855 return PTR_ERR(params);
857 err = snd_pcm_hw_params(substream, params);
861 if (copy_to_user(_params, params, sizeof(*params)))
868 static int do_hw_free(struct snd_pcm_substream *substream)
872 snd_pcm_sync_stop(substream, true);
873 if (substream->ops->hw_free)
874 result = substream->ops->hw_free(substream);
875 if (substream->managed_buffer_alloc)
876 snd_pcm_lib_free_pages(substream);
880 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
882 struct snd_pcm_runtime *runtime;
885 if (PCM_RUNTIME_CHECK(substream))
887 runtime = substream->runtime;
888 result = snd_pcm_buffer_access_lock(runtime);
891 snd_pcm_stream_lock_irq(substream);
892 switch (runtime->state) {
893 case SNDRV_PCM_STATE_SETUP:
894 case SNDRV_PCM_STATE_PREPARED:
895 if (atomic_read(&substream->mmap_count))
902 snd_pcm_stream_unlock_irq(substream);
905 result = do_hw_free(substream);
906 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
907 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
909 snd_pcm_buffer_access_unlock(runtime);
913 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
914 struct snd_pcm_sw_params *params)
916 struct snd_pcm_runtime *runtime;
919 if (PCM_RUNTIME_CHECK(substream))
921 runtime = substream->runtime;
922 snd_pcm_stream_lock_irq(substream);
923 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
924 snd_pcm_stream_unlock_irq(substream);
927 snd_pcm_stream_unlock_irq(substream);
929 if (params->tstamp_mode < 0 ||
930 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
932 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
933 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
935 if (params->avail_min == 0)
937 if (params->silence_size >= runtime->boundary) {
938 if (params->silence_threshold != 0)
941 if (params->silence_size > params->silence_threshold)
943 if (params->silence_threshold > runtime->buffer_size)
947 snd_pcm_stream_lock_irq(substream);
948 runtime->tstamp_mode = params->tstamp_mode;
949 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
950 runtime->tstamp_type = params->tstamp_type;
951 runtime->period_step = params->period_step;
952 runtime->control->avail_min = params->avail_min;
953 runtime->start_threshold = params->start_threshold;
954 runtime->stop_threshold = params->stop_threshold;
955 runtime->silence_threshold = params->silence_threshold;
956 runtime->silence_size = params->silence_size;
957 params->boundary = runtime->boundary;
958 if (snd_pcm_running(substream)) {
959 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
960 runtime->silence_size > 0)
961 snd_pcm_playback_silence(substream, ULONG_MAX);
962 err = snd_pcm_update_state(substream, runtime);
964 snd_pcm_stream_unlock_irq(substream);
968 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
969 struct snd_pcm_sw_params __user * _params)
971 struct snd_pcm_sw_params params;
973 if (copy_from_user(¶ms, _params, sizeof(params)))
975 err = snd_pcm_sw_params(substream, ¶ms);
976 if (copy_to_user(_params, ¶ms, sizeof(params)))
981 static inline snd_pcm_uframes_t
982 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
984 snd_pcm_uframes_t delay;
986 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
987 delay = snd_pcm_playback_hw_avail(substream->runtime);
989 delay = snd_pcm_capture_avail(substream->runtime);
990 return delay + substream->runtime->delay;
993 int snd_pcm_status64(struct snd_pcm_substream *substream,
994 struct snd_pcm_status64 *status)
996 struct snd_pcm_runtime *runtime = substream->runtime;
998 snd_pcm_stream_lock_irq(substream);
1000 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
1001 &runtime->audio_tstamp_config);
1003 /* backwards compatible behavior */
1004 if (runtime->audio_tstamp_config.type_requested ==
1005 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
1006 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
1007 runtime->audio_tstamp_config.type_requested =
1008 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
1010 runtime->audio_tstamp_config.type_requested =
1011 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
1012 runtime->audio_tstamp_report.valid = 0;
1014 runtime->audio_tstamp_report.valid = 1;
1016 status->state = runtime->state;
1017 status->suspended_state = runtime->suspended_state;
1018 if (status->state == SNDRV_PCM_STATE_OPEN)
1020 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
1021 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
1022 if (snd_pcm_running(substream)) {
1023 snd_pcm_update_hw_ptr(substream);
1024 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1025 status->tstamp_sec = runtime->status->tstamp.tv_sec;
1026 status->tstamp_nsec =
1027 runtime->status->tstamp.tv_nsec;
1028 status->driver_tstamp_sec =
1029 runtime->driver_tstamp.tv_sec;
1030 status->driver_tstamp_nsec =
1031 runtime->driver_tstamp.tv_nsec;
1032 status->audio_tstamp_sec =
1033 runtime->status->audio_tstamp.tv_sec;
1034 status->audio_tstamp_nsec =
1035 runtime->status->audio_tstamp.tv_nsec;
1036 if (runtime->audio_tstamp_report.valid == 1)
1037 /* backwards compatibility, no report provided in COMPAT mode */
1038 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
1039 &status->audio_tstamp_accuracy,
1040 &runtime->audio_tstamp_report);
1045 /* get tstamp only in fallback mode and only if enabled */
1046 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1047 struct timespec64 tstamp;
1049 snd_pcm_gettime(runtime, &tstamp);
1050 status->tstamp_sec = tstamp.tv_sec;
1051 status->tstamp_nsec = tstamp.tv_nsec;
1055 status->appl_ptr = runtime->control->appl_ptr;
1056 status->hw_ptr = runtime->status->hw_ptr;
1057 status->avail = snd_pcm_avail(substream);
1058 status->delay = snd_pcm_running(substream) ?
1059 snd_pcm_calc_delay(substream) : 0;
1060 status->avail_max = runtime->avail_max;
1061 status->overrange = runtime->overrange;
1062 runtime->avail_max = 0;
1063 runtime->overrange = 0;
1065 snd_pcm_stream_unlock_irq(substream);
1069 static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1070 struct snd_pcm_status64 __user * _status,
1073 struct snd_pcm_status64 status;
1076 memset(&status, 0, sizeof(status));
1078 * with extension, parameters are read/write,
1079 * get audio_tstamp_data from user,
1080 * ignore rest of status structure
1082 if (ext && get_user(status.audio_tstamp_data,
1083 (u32 __user *)(&_status->audio_tstamp_data)))
1085 res = snd_pcm_status64(substream, &status);
1088 if (copy_to_user(_status, &status, sizeof(status)))
1093 static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1094 struct snd_pcm_status32 __user * _status,
1097 struct snd_pcm_status64 status64;
1098 struct snd_pcm_status32 status32;
1101 memset(&status64, 0, sizeof(status64));
1102 memset(&status32, 0, sizeof(status32));
1104 * with extension, parameters are read/write,
1105 * get audio_tstamp_data from user,
1106 * ignore rest of status structure
1108 if (ext && get_user(status64.audio_tstamp_data,
1109 (u32 __user *)(&_status->audio_tstamp_data)))
1111 res = snd_pcm_status64(substream, &status64);
1115 status32 = (struct snd_pcm_status32) {
1116 .state = status64.state,
1117 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1118 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1119 .tstamp_sec = status64.tstamp_sec,
1120 .tstamp_nsec = status64.tstamp_nsec,
1121 .appl_ptr = status64.appl_ptr,
1122 .hw_ptr = status64.hw_ptr,
1123 .delay = status64.delay,
1124 .avail = status64.avail,
1125 .avail_max = status64.avail_max,
1126 .overrange = status64.overrange,
1127 .suspended_state = status64.suspended_state,
1128 .audio_tstamp_data = status64.audio_tstamp_data,
1129 .audio_tstamp_sec = status64.audio_tstamp_sec,
1130 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1131 .driver_tstamp_sec = status64.audio_tstamp_sec,
1132 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1133 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1136 if (copy_to_user(_status, &status32, sizeof(status32)))
1142 static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1143 struct snd_pcm_channel_info * info)
1145 struct snd_pcm_runtime *runtime;
1146 unsigned int channel;
1148 channel = info->channel;
1149 runtime = substream->runtime;
1150 snd_pcm_stream_lock_irq(substream);
1151 if (runtime->state == SNDRV_PCM_STATE_OPEN) {
1152 snd_pcm_stream_unlock_irq(substream);
1155 snd_pcm_stream_unlock_irq(substream);
1156 if (channel >= runtime->channels)
1158 memset(info, 0, sizeof(*info));
1159 info->channel = channel;
1160 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1163 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1164 struct snd_pcm_channel_info __user * _info)
1166 struct snd_pcm_channel_info info;
1169 if (copy_from_user(&info, _info, sizeof(info)))
1171 res = snd_pcm_channel_info(substream, &info);
1174 if (copy_to_user(_info, &info, sizeof(info)))
1179 static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1181 struct snd_pcm_runtime *runtime = substream->runtime;
1182 if (runtime->trigger_master == NULL)
1184 if (runtime->trigger_master == substream) {
1185 if (!runtime->trigger_tstamp_latched)
1186 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1188 snd_pcm_trigger_tstamp(runtime->trigger_master);
1189 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1191 runtime->trigger_master = NULL;
1194 #define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1197 int (*pre_action)(struct snd_pcm_substream *substream,
1198 snd_pcm_state_t state);
1199 int (*do_action)(struct snd_pcm_substream *substream,
1200 snd_pcm_state_t state);
1201 void (*undo_action)(struct snd_pcm_substream *substream,
1202 snd_pcm_state_t state);
1203 void (*post_action)(struct snd_pcm_substream *substream,
1204 snd_pcm_state_t state);
1208 * this functions is core for handling of linked stream
1209 * Note: the stream state might be changed also on failure
1210 * Note2: call with calling stream lock + link lock
1212 static int snd_pcm_action_group(const struct action_ops *ops,
1213 struct snd_pcm_substream *substream,
1214 snd_pcm_state_t state,
1217 struct snd_pcm_substream *s = NULL;
1218 struct snd_pcm_substream *s1;
1219 int res = 0, depth = 1;
1221 snd_pcm_group_for_each_entry(s, substream) {
1222 if (s != substream) {
1224 mutex_lock_nested(&s->runtime->buffer_mutex, depth);
1225 else if (s->pcm->nonatomic)
1226 mutex_lock_nested(&s->self_group.mutex, depth);
1228 spin_lock_nested(&s->self_group.lock, depth);
1231 res = ops->pre_action(s, state);
1235 snd_pcm_group_for_each_entry(s, substream) {
1236 res = ops->do_action(s, state);
1238 if (ops->undo_action) {
1239 snd_pcm_group_for_each_entry(s1, substream) {
1240 if (s1 == s) /* failed stream */
1242 ops->undo_action(s1, state);
1245 s = NULL; /* unlock all */
1249 snd_pcm_group_for_each_entry(s, substream) {
1250 ops->post_action(s, state);
1253 /* unlock streams */
1254 snd_pcm_group_for_each_entry(s1, substream) {
1255 if (s1 != substream) {
1257 mutex_unlock(&s1->runtime->buffer_mutex);
1258 else if (s1->pcm->nonatomic)
1259 mutex_unlock(&s1->self_group.mutex);
1261 spin_unlock(&s1->self_group.lock);
1263 if (s1 == s) /* end */
1270 * Note: call with stream lock
1272 static int snd_pcm_action_single(const struct action_ops *ops,
1273 struct snd_pcm_substream *substream,
1274 snd_pcm_state_t state)
1278 res = ops->pre_action(substream, state);
1281 res = ops->do_action(substream, state);
1283 ops->post_action(substream, state);
1284 else if (ops->undo_action)
1285 ops->undo_action(substream, state);
1289 static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1290 struct snd_pcm_group *new_group)
1292 substream->group = new_group;
1293 list_move(&substream->link_list, &new_group->substreams);
1297 * Unref and unlock the group, but keep the stream lock;
1298 * when the group becomes empty and no longer referred, destroy itself
1300 static void snd_pcm_group_unref(struct snd_pcm_group *group,
1301 struct snd_pcm_substream *substream)
1307 do_free = refcount_dec_and_test(&group->refs);
1308 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1314 * Lock the group inside a stream lock and reference it;
1315 * return the locked group object, or NULL if not linked
1317 static struct snd_pcm_group *
1318 snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1320 bool nonatomic = substream->pcm->nonatomic;
1321 struct snd_pcm_group *group;
1325 if (!snd_pcm_stream_linked(substream))
1327 group = substream->group;
1328 /* block freeing the group object */
1329 refcount_inc(&group->refs);
1331 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1332 spin_trylock(&group->lock);
1336 /* re-lock for avoiding ABBA deadlock */
1337 snd_pcm_stream_unlock(substream);
1338 snd_pcm_group_lock(group, nonatomic);
1339 snd_pcm_stream_lock(substream);
1341 /* check the group again; the above opens a small race window */
1342 if (substream->group == group)
1344 /* group changed, try again */
1345 snd_pcm_group_unref(group, substream);
1351 * Note: call with stream lock
1353 static int snd_pcm_action(const struct action_ops *ops,
1354 struct snd_pcm_substream *substream,
1355 snd_pcm_state_t state)
1357 struct snd_pcm_group *group;
1360 group = snd_pcm_stream_group_ref(substream);
1362 res = snd_pcm_action_group(ops, substream, state, true);
1364 res = snd_pcm_action_single(ops, substream, state);
1365 snd_pcm_group_unref(group, substream);
1370 * Note: don't use any locks before
1372 static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1373 struct snd_pcm_substream *substream,
1374 snd_pcm_state_t state)
1378 snd_pcm_stream_lock_irq(substream);
1379 res = snd_pcm_action(ops, substream, state);
1380 snd_pcm_stream_unlock_irq(substream);
1386 static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1387 struct snd_pcm_substream *substream,
1388 snd_pcm_state_t state)
1392 /* Guarantee the group members won't change during non-atomic action */
1393 down_read(&snd_pcm_link_rwsem);
1394 res = snd_pcm_buffer_access_lock(substream->runtime);
1397 if (snd_pcm_stream_linked(substream))
1398 res = snd_pcm_action_group(ops, substream, state, false);
1400 res = snd_pcm_action_single(ops, substream, state);
1401 snd_pcm_buffer_access_unlock(substream->runtime);
1403 up_read(&snd_pcm_link_rwsem);
1410 static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1411 snd_pcm_state_t state)
1413 struct snd_pcm_runtime *runtime = substream->runtime;
1414 if (runtime->state != SNDRV_PCM_STATE_PREPARED)
1416 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1417 !snd_pcm_playback_data(substream))
1419 runtime->trigger_tstamp_latched = false;
1420 runtime->trigger_master = substream;
1424 static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1425 snd_pcm_state_t state)
1427 if (substream->runtime->trigger_master != substream)
1429 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1432 static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1433 snd_pcm_state_t state)
1435 if (substream->runtime->trigger_master == substream)
1436 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1439 static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1440 snd_pcm_state_t state)
1442 struct snd_pcm_runtime *runtime = substream->runtime;
1443 snd_pcm_trigger_tstamp(substream);
1444 runtime->hw_ptr_jiffies = jiffies;
1445 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1447 __snd_pcm_set_state(runtime, state);
1448 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1449 runtime->silence_size > 0)
1450 snd_pcm_playback_silence(substream, ULONG_MAX);
1451 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1454 static const struct action_ops snd_pcm_action_start = {
1455 .pre_action = snd_pcm_pre_start,
1456 .do_action = snd_pcm_do_start,
1457 .undo_action = snd_pcm_undo_start,
1458 .post_action = snd_pcm_post_start
1462 * snd_pcm_start - start all linked streams
1463 * @substream: the PCM substream instance
1465 * Return: Zero if successful, or a negative error code.
1466 * The stream lock must be acquired before calling this function.
1468 int snd_pcm_start(struct snd_pcm_substream *substream)
1470 return snd_pcm_action(&snd_pcm_action_start, substream,
1471 SNDRV_PCM_STATE_RUNNING);
1474 /* take the stream lock and start the streams */
1475 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1477 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1478 SNDRV_PCM_STATE_RUNNING);
1484 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1485 snd_pcm_state_t state)
1487 struct snd_pcm_runtime *runtime = substream->runtime;
1488 if (runtime->state == SNDRV_PCM_STATE_OPEN)
1490 runtime->trigger_master = substream;
1494 static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1495 snd_pcm_state_t state)
1497 if (substream->runtime->trigger_master == substream &&
1498 snd_pcm_running(substream)) {
1499 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1500 substream->runtime->stop_operating = true;
1502 return 0; /* unconditionally stop all substreams */
1505 static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1506 snd_pcm_state_t state)
1508 struct snd_pcm_runtime *runtime = substream->runtime;
1509 if (runtime->state != state) {
1510 snd_pcm_trigger_tstamp(substream);
1511 __snd_pcm_set_state(runtime, state);
1512 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1514 wake_up(&runtime->sleep);
1515 wake_up(&runtime->tsleep);
1518 static const struct action_ops snd_pcm_action_stop = {
1519 .pre_action = snd_pcm_pre_stop,
1520 .do_action = snd_pcm_do_stop,
1521 .post_action = snd_pcm_post_stop
1525 * snd_pcm_stop - try to stop all running streams in the substream group
1526 * @substream: the PCM substream instance
1527 * @state: PCM state after stopping the stream
1529 * The state of each stream is then changed to the given state unconditionally.
1531 * Return: Zero if successful, or a negative error code.
1533 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1535 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1537 EXPORT_SYMBOL(snd_pcm_stop);
1540 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1541 * @substream: the PCM substream
1543 * After stopping, the state is changed to SETUP.
1544 * Unlike snd_pcm_stop(), this affects only the given stream.
1546 * Return: Zero if successful, or a negative error code.
1548 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1550 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1551 SNDRV_PCM_STATE_SETUP);
1555 * snd_pcm_stop_xrun - stop the running streams as XRUN
1556 * @substream: the PCM substream instance
1558 * This stops the given running substream (and all linked substreams) as XRUN.
1559 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1561 * Return: Zero if successful, or a negative error code.
1563 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1565 unsigned long flags;
1567 snd_pcm_stream_lock_irqsave(substream, flags);
1568 if (substream->runtime && snd_pcm_running(substream))
1569 __snd_pcm_xrun(substream);
1570 snd_pcm_stream_unlock_irqrestore(substream, flags);
1573 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1576 * pause callbacks: pass boolean (to start pause or resume) as state argument
1578 #define pause_pushed(state) (__force bool)(state)
1580 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1581 snd_pcm_state_t state)
1583 struct snd_pcm_runtime *runtime = substream->runtime;
1584 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1586 if (pause_pushed(state)) {
1587 if (runtime->state != SNDRV_PCM_STATE_RUNNING)
1589 } else if (runtime->state != SNDRV_PCM_STATE_PAUSED)
1591 runtime->trigger_master = substream;
1595 static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1596 snd_pcm_state_t state)
1598 if (substream->runtime->trigger_master != substream)
1600 /* some drivers might use hw_ptr to recover from the pause -
1601 update the hw_ptr now */
1602 if (pause_pushed(state))
1603 snd_pcm_update_hw_ptr(substream);
1604 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1605 * a delta between the current jiffies, this gives a large enough
1606 * delta, effectively to skip the check once.
1608 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1609 return substream->ops->trigger(substream,
1610 pause_pushed(state) ?
1611 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1612 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1615 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1616 snd_pcm_state_t state)
1618 if (substream->runtime->trigger_master == substream)
1619 substream->ops->trigger(substream,
1620 pause_pushed(state) ?
1621 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1622 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1625 static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1626 snd_pcm_state_t state)
1628 struct snd_pcm_runtime *runtime = substream->runtime;
1629 snd_pcm_trigger_tstamp(substream);
1630 if (pause_pushed(state)) {
1631 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_PAUSED);
1632 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1633 wake_up(&runtime->sleep);
1634 wake_up(&runtime->tsleep);
1636 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_RUNNING);
1637 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1641 static const struct action_ops snd_pcm_action_pause = {
1642 .pre_action = snd_pcm_pre_pause,
1643 .do_action = snd_pcm_do_pause,
1644 .undo_action = snd_pcm_undo_pause,
1645 .post_action = snd_pcm_post_pause
1649 * Push/release the pause for all linked streams.
1651 static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1653 return snd_pcm_action(&snd_pcm_action_pause, substream,
1654 (__force snd_pcm_state_t)push);
1657 static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1660 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1661 (__force snd_pcm_state_t)push);
1665 /* suspend callback: state argument ignored */
1667 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1668 snd_pcm_state_t state)
1670 struct snd_pcm_runtime *runtime = substream->runtime;
1671 switch (runtime->state) {
1672 case SNDRV_PCM_STATE_SUSPENDED:
1674 /* unresumable PCM state; return -EBUSY for skipping suspend */
1675 case SNDRV_PCM_STATE_OPEN:
1676 case SNDRV_PCM_STATE_SETUP:
1677 case SNDRV_PCM_STATE_DISCONNECTED:
1680 runtime->trigger_master = substream;
1684 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1685 snd_pcm_state_t state)
1687 struct snd_pcm_runtime *runtime = substream->runtime;
1688 if (runtime->trigger_master != substream)
1690 if (! snd_pcm_running(substream))
1692 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1693 runtime->stop_operating = true;
1694 return 0; /* suspend unconditionally */
1697 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1698 snd_pcm_state_t state)
1700 struct snd_pcm_runtime *runtime = substream->runtime;
1701 snd_pcm_trigger_tstamp(substream);
1702 runtime->suspended_state = runtime->state;
1703 runtime->status->suspended_state = runtime->suspended_state;
1704 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SUSPENDED);
1705 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1706 wake_up(&runtime->sleep);
1707 wake_up(&runtime->tsleep);
1710 static const struct action_ops snd_pcm_action_suspend = {
1711 .pre_action = snd_pcm_pre_suspend,
1712 .do_action = snd_pcm_do_suspend,
1713 .post_action = snd_pcm_post_suspend
1717 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1718 * @substream: the PCM substream
1720 * After this call, all streams are changed to SUSPENDED state.
1722 * Return: Zero if successful, or a negative error code.
1724 static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1727 unsigned long flags;
1729 snd_pcm_stream_lock_irqsave(substream, flags);
1730 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1732 snd_pcm_stream_unlock_irqrestore(substream, flags);
1737 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1738 * @pcm: the PCM instance
1740 * After this call, all streams are changed to SUSPENDED state.
1742 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1744 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1746 struct snd_pcm_substream *substream;
1747 int stream, err = 0;
1752 for_each_pcm_substream(pcm, stream, substream) {
1753 /* FIXME: the open/close code should lock this as well */
1754 if (!substream->runtime)
1758 * Skip BE dai link PCM's that are internal and may
1759 * not have their substream ops set.
1761 if (!substream->ops)
1764 err = snd_pcm_suspend(substream);
1765 if (err < 0 && err != -EBUSY)
1769 for_each_pcm_substream(pcm, stream, substream)
1770 snd_pcm_sync_stop(substream, false);
1774 EXPORT_SYMBOL(snd_pcm_suspend_all);
1776 /* resume callbacks: state argument ignored */
1778 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1779 snd_pcm_state_t state)
1781 struct snd_pcm_runtime *runtime = substream->runtime;
1782 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1784 runtime->trigger_master = substream;
1788 static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1789 snd_pcm_state_t state)
1791 struct snd_pcm_runtime *runtime = substream->runtime;
1792 if (runtime->trigger_master != substream)
1794 /* DMA not running previously? */
1795 if (runtime->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1796 (runtime->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1797 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1799 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1802 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1803 snd_pcm_state_t state)
1805 if (substream->runtime->trigger_master == substream &&
1806 snd_pcm_running(substream))
1807 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1810 static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1811 snd_pcm_state_t state)
1813 struct snd_pcm_runtime *runtime = substream->runtime;
1814 snd_pcm_trigger_tstamp(substream);
1815 __snd_pcm_set_state(runtime, runtime->suspended_state);
1816 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1819 static const struct action_ops snd_pcm_action_resume = {
1820 .pre_action = snd_pcm_pre_resume,
1821 .do_action = snd_pcm_do_resume,
1822 .undo_action = snd_pcm_undo_resume,
1823 .post_action = snd_pcm_post_resume
1826 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1828 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1834 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1839 #endif /* CONFIG_PM */
1844 * Change the RUNNING stream(s) to XRUN state.
1846 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1848 struct snd_pcm_runtime *runtime = substream->runtime;
1851 snd_pcm_stream_lock_irq(substream);
1852 switch (runtime->state) {
1853 case SNDRV_PCM_STATE_XRUN:
1854 result = 0; /* already there */
1856 case SNDRV_PCM_STATE_RUNNING:
1857 __snd_pcm_xrun(substream);
1863 snd_pcm_stream_unlock_irq(substream);
1870 /* reset callbacks: state argument ignored */
1871 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1872 snd_pcm_state_t state)
1874 struct snd_pcm_runtime *runtime = substream->runtime;
1875 switch (runtime->state) {
1876 case SNDRV_PCM_STATE_RUNNING:
1877 case SNDRV_PCM_STATE_PREPARED:
1878 case SNDRV_PCM_STATE_PAUSED:
1879 case SNDRV_PCM_STATE_SUSPENDED:
1886 static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1887 snd_pcm_state_t state)
1889 struct snd_pcm_runtime *runtime = substream->runtime;
1890 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1893 snd_pcm_stream_lock_irq(substream);
1894 runtime->hw_ptr_base = 0;
1895 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1896 runtime->status->hw_ptr % runtime->period_size;
1897 runtime->silence_start = runtime->status->hw_ptr;
1898 runtime->silence_filled = 0;
1899 snd_pcm_stream_unlock_irq(substream);
1903 static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1904 snd_pcm_state_t state)
1906 struct snd_pcm_runtime *runtime = substream->runtime;
1907 snd_pcm_stream_lock_irq(substream);
1908 runtime->control->appl_ptr = runtime->status->hw_ptr;
1909 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1910 runtime->silence_size > 0)
1911 snd_pcm_playback_silence(substream, ULONG_MAX);
1912 snd_pcm_stream_unlock_irq(substream);
1915 static const struct action_ops snd_pcm_action_reset = {
1916 .pre_action = snd_pcm_pre_reset,
1917 .do_action = snd_pcm_do_reset,
1918 .post_action = snd_pcm_post_reset
1921 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1923 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1930 /* pass f_flags as state argument */
1931 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1932 snd_pcm_state_t state)
1934 struct snd_pcm_runtime *runtime = substream->runtime;
1935 int f_flags = (__force int)state;
1937 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
1938 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
1940 if (snd_pcm_running(substream))
1942 substream->f_flags = f_flags;
1946 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1947 snd_pcm_state_t state)
1950 snd_pcm_sync_stop(substream, true);
1951 err = substream->ops->prepare(substream);
1954 return snd_pcm_do_reset(substream, state);
1957 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1958 snd_pcm_state_t state)
1960 struct snd_pcm_runtime *runtime = substream->runtime;
1961 runtime->control->appl_ptr = runtime->status->hw_ptr;
1962 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1965 static const struct action_ops snd_pcm_action_prepare = {
1966 .pre_action = snd_pcm_pre_prepare,
1967 .do_action = snd_pcm_do_prepare,
1968 .post_action = snd_pcm_post_prepare
1972 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1973 * @substream: the PCM substream instance
1974 * @file: file to refer f_flags
1976 * Return: Zero if successful, or a negative error code.
1978 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1984 f_flags = file->f_flags;
1986 f_flags = substream->f_flags;
1988 snd_pcm_stream_lock_irq(substream);
1989 switch (substream->runtime->state) {
1990 case SNDRV_PCM_STATE_PAUSED:
1991 snd_pcm_pause(substream, false);
1993 case SNDRV_PCM_STATE_SUSPENDED:
1994 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1997 snd_pcm_stream_unlock_irq(substream);
1999 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
2001 (__force snd_pcm_state_t)f_flags);
2008 /* drain init callbacks: state argument ignored */
2009 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
2010 snd_pcm_state_t state)
2012 struct snd_pcm_runtime *runtime = substream->runtime;
2013 switch (runtime->state) {
2014 case SNDRV_PCM_STATE_OPEN:
2015 case SNDRV_PCM_STATE_DISCONNECTED:
2016 case SNDRV_PCM_STATE_SUSPENDED:
2019 runtime->trigger_master = substream;
2023 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
2024 snd_pcm_state_t state)
2026 struct snd_pcm_runtime *runtime = substream->runtime;
2027 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
2028 switch (runtime->state) {
2029 case SNDRV_PCM_STATE_PREPARED:
2030 /* start playback stream if possible */
2031 if (! snd_pcm_playback_empty(substream)) {
2032 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
2033 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
2035 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2038 case SNDRV_PCM_STATE_RUNNING:
2039 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_DRAINING);
2041 case SNDRV_PCM_STATE_XRUN:
2042 __snd_pcm_set_state(runtime, SNDRV_PCM_STATE_SETUP);
2048 /* stop running stream */
2049 if (runtime->state == SNDRV_PCM_STATE_RUNNING) {
2050 snd_pcm_state_t new_state;
2052 new_state = snd_pcm_capture_avail(runtime) > 0 ?
2053 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
2054 snd_pcm_do_stop(substream, new_state);
2055 snd_pcm_post_stop(substream, new_state);
2059 if (runtime->state == SNDRV_PCM_STATE_DRAINING &&
2060 runtime->trigger_master == substream &&
2061 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
2062 return substream->ops->trigger(substream,
2063 SNDRV_PCM_TRIGGER_DRAIN);
2068 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
2069 snd_pcm_state_t state)
2073 static const struct action_ops snd_pcm_action_drain_init = {
2074 .pre_action = snd_pcm_pre_drain_init,
2075 .do_action = snd_pcm_do_drain_init,
2076 .post_action = snd_pcm_post_drain_init
2080 * Drain the stream(s).
2081 * When the substream is linked, sync until the draining of all playback streams
2083 * After this call, all streams are supposed to be either SETUP or DRAINING
2084 * (capture only) state.
2086 static int snd_pcm_drain(struct snd_pcm_substream *substream,
2089 struct snd_card *card;
2090 struct snd_pcm_runtime *runtime;
2091 struct snd_pcm_substream *s;
2092 struct snd_pcm_group *group;
2093 wait_queue_entry_t wait;
2097 card = substream->pcm->card;
2098 runtime = substream->runtime;
2100 if (runtime->state == SNDRV_PCM_STATE_OPEN)
2104 if (file->f_flags & O_NONBLOCK)
2106 } else if (substream->f_flags & O_NONBLOCK)
2109 snd_pcm_stream_lock_irq(substream);
2111 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2112 snd_pcm_pause(substream, false);
2114 /* pre-start/stop - all running streams are changed to DRAINING state */
2115 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2119 /* in non-blocking, we don't wait in ioctl but let caller poll */
2127 struct snd_pcm_runtime *to_check;
2128 if (signal_pending(current)) {
2129 result = -ERESTARTSYS;
2132 /* find a substream to drain */
2134 group = snd_pcm_stream_group_ref(substream);
2135 snd_pcm_group_for_each_entry(s, substream) {
2136 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2138 runtime = s->runtime;
2139 if (runtime->state == SNDRV_PCM_STATE_DRAINING) {
2144 snd_pcm_group_unref(group, substream);
2146 break; /* all drained */
2147 init_waitqueue_entry(&wait, current);
2148 set_current_state(TASK_INTERRUPTIBLE);
2149 add_wait_queue(&to_check->sleep, &wait);
2150 snd_pcm_stream_unlock_irq(substream);
2151 if (runtime->no_period_wakeup)
2152 tout = MAX_SCHEDULE_TIMEOUT;
2155 if (runtime->rate) {
2156 long t = runtime->period_size * 2 / runtime->rate;
2157 tout = max(t, tout);
2159 tout = msecs_to_jiffies(tout * 1000);
2161 tout = schedule_timeout(tout);
2163 snd_pcm_stream_lock_irq(substream);
2164 group = snd_pcm_stream_group_ref(substream);
2165 snd_pcm_group_for_each_entry(s, substream) {
2166 if (s->runtime == to_check) {
2167 remove_wait_queue(&to_check->sleep, &wait);
2171 snd_pcm_group_unref(group, substream);
2173 if (card->shutdown) {
2178 if (substream->runtime->state == SNDRV_PCM_STATE_SUSPENDED)
2181 dev_dbg(substream->pcm->card->dev,
2182 "playback drain error (DMA or IRQ trouble?)\n");
2183 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2191 snd_pcm_stream_unlock_irq(substream);
2199 * Immediately put all linked substreams into SETUP state.
2201 static int snd_pcm_drop(struct snd_pcm_substream *substream)
2203 struct snd_pcm_runtime *runtime;
2206 if (PCM_RUNTIME_CHECK(substream))
2208 runtime = substream->runtime;
2210 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
2211 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
2214 snd_pcm_stream_lock_irq(substream);
2216 if (runtime->state == SNDRV_PCM_STATE_PAUSED)
2217 snd_pcm_pause(substream, false);
2219 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2220 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2221 snd_pcm_stream_unlock_irq(substream);
2227 static bool is_pcm_file(struct file *file)
2229 struct inode *inode = file_inode(file);
2230 struct snd_pcm *pcm;
2233 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2235 minor = iminor(inode);
2236 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2238 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2241 snd_card_unref(pcm->card);
2248 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
2251 struct snd_pcm_file *pcm_file;
2252 struct snd_pcm_substream *substream1;
2253 struct snd_pcm_group *group, *target_group;
2254 bool nonatomic = substream->pcm->nonatomic;
2255 struct fd f = fdget(fd);
2259 if (!is_pcm_file(f.file)) {
2263 pcm_file = f.file->private_data;
2264 substream1 = pcm_file->substream;
2266 if (substream == substream1) {
2271 group = kzalloc(sizeof(*group), GFP_KERNEL);
2276 snd_pcm_group_init(group);
2278 down_write(&snd_pcm_link_rwsem);
2279 if (substream->runtime->state == SNDRV_PCM_STATE_OPEN ||
2280 substream->runtime->state != substream1->runtime->state ||
2281 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2285 if (snd_pcm_stream_linked(substream1)) {
2290 snd_pcm_stream_lock_irq(substream);
2291 if (!snd_pcm_stream_linked(substream)) {
2292 snd_pcm_group_assign(substream, group);
2293 group = NULL; /* assigned, don't free this one below */
2295 target_group = substream->group;
2296 snd_pcm_stream_unlock_irq(substream);
2298 snd_pcm_group_lock_irq(target_group, nonatomic);
2299 snd_pcm_stream_lock_nested(substream1);
2300 snd_pcm_group_assign(substream1, target_group);
2301 refcount_inc(&target_group->refs);
2302 snd_pcm_stream_unlock(substream1);
2303 snd_pcm_group_unlock_irq(target_group, nonatomic);
2305 up_write(&snd_pcm_link_rwsem);
2313 static void relink_to_local(struct snd_pcm_substream *substream)
2315 snd_pcm_stream_lock_nested(substream);
2316 snd_pcm_group_assign(substream, &substream->self_group);
2317 snd_pcm_stream_unlock(substream);
2320 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2322 struct snd_pcm_group *group;
2323 bool nonatomic = substream->pcm->nonatomic;
2324 bool do_free = false;
2327 down_write(&snd_pcm_link_rwsem);
2329 if (!snd_pcm_stream_linked(substream)) {
2334 group = substream->group;
2335 snd_pcm_group_lock_irq(group, nonatomic);
2337 relink_to_local(substream);
2338 refcount_dec(&group->refs);
2340 /* detach the last stream, too */
2341 if (list_is_singular(&group->substreams)) {
2342 relink_to_local(list_first_entry(&group->substreams,
2343 struct snd_pcm_substream,
2345 do_free = refcount_dec_and_test(&group->refs);
2348 snd_pcm_group_unlock_irq(group, nonatomic);
2353 up_write(&snd_pcm_link_rwsem);
2360 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2361 struct snd_pcm_hw_rule *rule)
2363 struct snd_interval t;
2364 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2365 hw_param_interval_c(params, rule->deps[1]), &t);
2366 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2369 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2370 struct snd_pcm_hw_rule *rule)
2372 struct snd_interval t;
2373 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2374 hw_param_interval_c(params, rule->deps[1]), &t);
2375 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2378 static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2379 struct snd_pcm_hw_rule *rule)
2381 struct snd_interval t;
2382 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2383 hw_param_interval_c(params, rule->deps[1]),
2384 (unsigned long) rule->private, &t);
2385 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2388 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2389 struct snd_pcm_hw_rule *rule)
2391 struct snd_interval t;
2392 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2393 (unsigned long) rule->private,
2394 hw_param_interval_c(params, rule->deps[1]), &t);
2395 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2398 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2399 struct snd_pcm_hw_rule *rule)
2402 const struct snd_interval *i =
2403 hw_param_interval_c(params, rule->deps[0]);
2405 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2407 pcm_for_each_format(k) {
2409 if (!snd_mask_test_format(mask, k))
2411 bits = snd_pcm_format_physical_width(k);
2413 continue; /* ignore invalid formats */
2414 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2415 snd_mask_reset(&m, (__force unsigned)k);
2417 return snd_mask_refine(mask, &m);
2420 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2421 struct snd_pcm_hw_rule *rule)
2423 struct snd_interval t;
2430 pcm_for_each_format(k) {
2432 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2434 bits = snd_pcm_format_physical_width(k);
2436 continue; /* ignore invalid formats */
2437 if (t.min > (unsigned)bits)
2439 if (t.max < (unsigned)bits)
2443 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2446 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2447 #error "Change this table"
2450 static const unsigned int rates[] = {
2451 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2452 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2455 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2456 .count = ARRAY_SIZE(rates),
2460 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2461 struct snd_pcm_hw_rule *rule)
2463 struct snd_pcm_hardware *hw = rule->private;
2464 return snd_interval_list(hw_param_interval(params, rule->var),
2465 snd_pcm_known_rates.count,
2466 snd_pcm_known_rates.list, hw->rates);
2469 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2470 struct snd_pcm_hw_rule *rule)
2472 struct snd_interval t;
2473 struct snd_pcm_substream *substream = rule->private;
2475 t.max = substream->buffer_bytes_max;
2479 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2482 static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2484 struct snd_pcm_runtime *runtime = substream->runtime;
2485 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2488 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2489 snd_mask_any(constrs_mask(constrs, k));
2492 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2493 snd_interval_any(constrs_interval(constrs, k));
2496 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2497 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2498 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2499 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2500 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2502 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2503 snd_pcm_hw_rule_format, NULL,
2504 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2507 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2508 snd_pcm_hw_rule_sample_bits, NULL,
2509 SNDRV_PCM_HW_PARAM_FORMAT,
2510 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2513 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2514 snd_pcm_hw_rule_div, NULL,
2515 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2518 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2519 snd_pcm_hw_rule_mul, NULL,
2520 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2523 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2524 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2525 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2528 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2529 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2530 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2533 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2534 snd_pcm_hw_rule_div, NULL,
2535 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2538 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2539 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2540 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2543 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2544 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2545 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2548 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2549 snd_pcm_hw_rule_div, NULL,
2550 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2553 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2554 snd_pcm_hw_rule_div, NULL,
2555 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2558 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2559 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2560 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2563 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2564 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2565 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2568 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2569 snd_pcm_hw_rule_mul, NULL,
2570 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2573 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2574 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2575 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2578 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2579 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2580 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2583 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2584 snd_pcm_hw_rule_muldivk, (void*) 8,
2585 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2588 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2589 snd_pcm_hw_rule_muldivk, (void*) 8,
2590 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2593 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2594 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2595 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2598 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2599 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2600 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2606 static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2608 struct snd_pcm_runtime *runtime = substream->runtime;
2609 struct snd_pcm_hardware *hw = &runtime->hw;
2611 unsigned int mask = 0;
2613 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2614 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
2615 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2616 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
2617 if (hw_support_mmap(substream)) {
2618 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2619 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
2620 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2621 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
2622 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2623 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
2625 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2629 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2633 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2634 PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
2638 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2639 hw->channels_min, hw->channels_max);
2643 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2644 hw->rate_min, hw->rate_max);
2648 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2649 hw->period_bytes_min, hw->period_bytes_max);
2653 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2654 hw->periods_min, hw->periods_max);
2658 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2659 hw->period_bytes_min, hw->buffer_bytes_max);
2663 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2664 snd_pcm_hw_rule_buffer_bytes_max, substream,
2665 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2670 if (runtime->dma_bytes) {
2671 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2676 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2677 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2678 snd_pcm_hw_rule_rate, hw,
2679 SNDRV_PCM_HW_PARAM_RATE, -1);
2684 /* FIXME: this belong to lowlevel */
2685 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2690 static void pcm_release_private(struct snd_pcm_substream *substream)
2692 if (snd_pcm_stream_linked(substream))
2693 snd_pcm_unlink(substream);
2696 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2698 substream->ref_count--;
2699 if (substream->ref_count > 0)
2702 snd_pcm_drop(substream);
2703 if (substream->hw_opened) {
2704 if (substream->runtime->state != SNDRV_PCM_STATE_OPEN)
2705 do_hw_free(substream);
2706 substream->ops->close(substream);
2707 substream->hw_opened = 0;
2709 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2710 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
2711 if (substream->pcm_release) {
2712 substream->pcm_release(substream);
2713 substream->pcm_release = NULL;
2715 snd_pcm_detach_substream(substream);
2717 EXPORT_SYMBOL(snd_pcm_release_substream);
2719 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2721 struct snd_pcm_substream **rsubstream)
2723 struct snd_pcm_substream *substream;
2726 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2729 if (substream->ref_count > 1) {
2730 *rsubstream = substream;
2734 err = snd_pcm_hw_constraints_init(substream);
2736 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2740 err = substream->ops->open(substream);
2744 substream->hw_opened = 1;
2746 err = snd_pcm_hw_constraints_complete(substream);
2748 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2752 /* automatically set EXPLICIT_SYNC flag in the managed mode whenever
2753 * the DMA buffer requires it
2755 if (substream->managed_buffer_alloc &&
2756 substream->dma_buffer.dev.need_sync)
2757 substream->runtime->hw.info |= SNDRV_PCM_INFO_EXPLICIT_SYNC;
2759 *rsubstream = substream;
2763 snd_pcm_release_substream(substream);
2766 EXPORT_SYMBOL(snd_pcm_open_substream);
2768 static int snd_pcm_open_file(struct file *file,
2769 struct snd_pcm *pcm,
2772 struct snd_pcm_file *pcm_file;
2773 struct snd_pcm_substream *substream;
2776 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2780 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2781 if (pcm_file == NULL) {
2782 snd_pcm_release_substream(substream);
2785 pcm_file->substream = substream;
2786 if (substream->ref_count == 1)
2787 substream->pcm_release = pcm_release_private;
2788 file->private_data = pcm_file;
2793 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2795 struct snd_pcm *pcm;
2796 int err = nonseekable_open(inode, file);
2799 pcm = snd_lookup_minor_data(iminor(inode),
2800 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2801 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2803 snd_card_unref(pcm->card);
2807 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2809 struct snd_pcm *pcm;
2810 int err = nonseekable_open(inode, file);
2813 pcm = snd_lookup_minor_data(iminor(inode),
2814 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2815 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2817 snd_card_unref(pcm->card);
2821 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2824 wait_queue_entry_t wait;
2830 err = snd_card_file_add(pcm->card, file);
2833 if (!try_module_get(pcm->card->module)) {
2837 init_waitqueue_entry(&wait, current);
2838 add_wait_queue(&pcm->open_wait, &wait);
2839 mutex_lock(&pcm->open_mutex);
2841 err = snd_pcm_open_file(file, pcm, stream);
2844 if (err == -EAGAIN) {
2845 if (file->f_flags & O_NONBLOCK) {
2851 set_current_state(TASK_INTERRUPTIBLE);
2852 mutex_unlock(&pcm->open_mutex);
2854 mutex_lock(&pcm->open_mutex);
2855 if (pcm->card->shutdown) {
2859 if (signal_pending(current)) {
2864 remove_wait_queue(&pcm->open_wait, &wait);
2865 mutex_unlock(&pcm->open_mutex);
2871 module_put(pcm->card->module);
2873 snd_card_file_remove(pcm->card, file);
2878 static int snd_pcm_release(struct inode *inode, struct file *file)
2880 struct snd_pcm *pcm;
2881 struct snd_pcm_substream *substream;
2882 struct snd_pcm_file *pcm_file;
2884 pcm_file = file->private_data;
2885 substream = pcm_file->substream;
2886 if (snd_BUG_ON(!substream))
2888 pcm = substream->pcm;
2890 /* block until the device gets woken up as it may touch the hardware */
2891 snd_power_wait(pcm->card);
2893 mutex_lock(&pcm->open_mutex);
2894 snd_pcm_release_substream(substream);
2896 mutex_unlock(&pcm->open_mutex);
2897 wake_up(&pcm->open_wait);
2898 module_put(pcm->card->module);
2899 snd_card_file_remove(pcm->card, file);
2903 /* check and update PCM state; return 0 or a negative error
2904 * call this inside PCM lock
2906 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2908 switch (substream->runtime->state) {
2909 case SNDRV_PCM_STATE_DRAINING:
2910 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2913 case SNDRV_PCM_STATE_RUNNING:
2914 return snd_pcm_update_hw_ptr(substream);
2915 case SNDRV_PCM_STATE_PREPARED:
2916 case SNDRV_PCM_STATE_PAUSED:
2918 case SNDRV_PCM_STATE_SUSPENDED:
2920 case SNDRV_PCM_STATE_XRUN:
2927 /* increase the appl_ptr; returns the processed frames or a negative error */
2928 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2929 snd_pcm_uframes_t frames,
2930 snd_pcm_sframes_t avail)
2932 struct snd_pcm_runtime *runtime = substream->runtime;
2933 snd_pcm_sframes_t appl_ptr;
2938 if (frames > (snd_pcm_uframes_t)avail)
2940 appl_ptr = runtime->control->appl_ptr + frames;
2941 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2942 appl_ptr -= runtime->boundary;
2943 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2944 return ret < 0 ? ret : frames;
2947 /* decrease the appl_ptr; returns the processed frames or zero for error */
2948 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2949 snd_pcm_uframes_t frames,
2950 snd_pcm_sframes_t avail)
2952 struct snd_pcm_runtime *runtime = substream->runtime;
2953 snd_pcm_sframes_t appl_ptr;
2958 if (frames > (snd_pcm_uframes_t)avail)
2960 appl_ptr = runtime->control->appl_ptr - frames;
2962 appl_ptr += runtime->boundary;
2963 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2964 /* NOTE: we return zero for errors because PulseAudio gets depressed
2965 * upon receiving an error from rewind ioctl and stops processing
2966 * any longer. Returning zero means that no rewind is done, so
2967 * it's not absolutely wrong to answer like that.
2969 return ret < 0 ? 0 : frames;
2972 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2973 snd_pcm_uframes_t frames)
2975 snd_pcm_sframes_t ret;
2980 snd_pcm_stream_lock_irq(substream);
2981 ret = do_pcm_hwsync(substream);
2983 ret = rewind_appl_ptr(substream, frames,
2984 snd_pcm_hw_avail(substream));
2985 snd_pcm_stream_unlock_irq(substream);
2987 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2991 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2992 snd_pcm_uframes_t frames)
2994 snd_pcm_sframes_t ret;
2999 snd_pcm_stream_lock_irq(substream);
3000 ret = do_pcm_hwsync(substream);
3002 ret = forward_appl_ptr(substream, frames,
3003 snd_pcm_avail(substream));
3004 snd_pcm_stream_unlock_irq(substream);
3006 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3010 static int snd_pcm_delay(struct snd_pcm_substream *substream,
3011 snd_pcm_sframes_t *delay)
3015 snd_pcm_stream_lock_irq(substream);
3016 err = do_pcm_hwsync(substream);
3018 *delay = snd_pcm_calc_delay(substream);
3019 snd_pcm_stream_unlock_irq(substream);
3020 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
3025 static inline int snd_pcm_hwsync(struct snd_pcm_substream *substream)
3027 return snd_pcm_delay(substream, NULL);
3030 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
3031 struct snd_pcm_sync_ptr __user *_sync_ptr)
3033 struct snd_pcm_runtime *runtime = substream->runtime;
3034 struct snd_pcm_sync_ptr sync_ptr;
3035 volatile struct snd_pcm_mmap_status *status;
3036 volatile struct snd_pcm_mmap_control *control;
3039 memset(&sync_ptr, 0, sizeof(sync_ptr));
3040 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
3042 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
3044 status = runtime->status;
3045 control = runtime->control;
3046 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3047 err = snd_pcm_hwsync(substream);
3051 snd_pcm_stream_lock_irq(substream);
3052 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
3053 err = pcm_lib_apply_appl_ptr(substream,
3054 sync_ptr.c.control.appl_ptr);
3056 snd_pcm_stream_unlock_irq(substream);
3060 sync_ptr.c.control.appl_ptr = control->appl_ptr;
3062 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3063 control->avail_min = sync_ptr.c.control.avail_min;
3065 sync_ptr.c.control.avail_min = control->avail_min;
3066 sync_ptr.s.status.state = status->state;
3067 sync_ptr.s.status.hw_ptr = status->hw_ptr;
3068 sync_ptr.s.status.tstamp = status->tstamp;
3069 sync_ptr.s.status.suspended_state = status->suspended_state;
3070 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
3071 snd_pcm_stream_unlock_irq(substream);
3072 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL))
3073 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3074 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
3079 struct snd_pcm_mmap_status32 {
3080 snd_pcm_state_t state;
3085 snd_pcm_state_t suspended_state;
3086 s32 audio_tstamp_sec;
3087 s32 audio_tstamp_nsec;
3088 } __attribute__((packed));
3090 struct snd_pcm_mmap_control32 {
3095 struct snd_pcm_sync_ptr32 {
3098 struct snd_pcm_mmap_status32 status;
3099 unsigned char reserved[64];
3102 struct snd_pcm_mmap_control32 control;
3103 unsigned char reserved[64];
3105 } __attribute__((packed));
3107 /* recalcuate the boundary within 32bit */
3108 static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3110 snd_pcm_uframes_t boundary;
3112 if (! runtime->buffer_size)
3114 boundary = runtime->buffer_size;
3115 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3120 static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3121 struct snd_pcm_sync_ptr32 __user *src)
3123 struct snd_pcm_runtime *runtime = substream->runtime;
3124 volatile struct snd_pcm_mmap_status *status;
3125 volatile struct snd_pcm_mmap_control *control;
3127 struct snd_pcm_mmap_control scontrol;
3128 struct snd_pcm_mmap_status sstatus;
3129 snd_pcm_uframes_t boundary;
3132 if (snd_BUG_ON(!runtime))
3135 if (get_user(sflags, &src->flags) ||
3136 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3137 get_user(scontrol.avail_min, &src->c.control.avail_min))
3139 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3140 err = snd_pcm_hwsync(substream);
3144 status = runtime->status;
3145 control = runtime->control;
3146 boundary = recalculate_boundary(runtime);
3148 boundary = 0x7fffffff;
3149 snd_pcm_stream_lock_irq(substream);
3150 /* FIXME: we should consider the boundary for the sync from app */
3151 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL)) {
3152 err = pcm_lib_apply_appl_ptr(substream,
3155 snd_pcm_stream_unlock_irq(substream);
3159 scontrol.appl_ptr = control->appl_ptr % boundary;
3160 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3161 control->avail_min = scontrol.avail_min;
3163 scontrol.avail_min = control->avail_min;
3164 sstatus.state = status->state;
3165 sstatus.hw_ptr = status->hw_ptr % boundary;
3166 sstatus.tstamp = status->tstamp;
3167 sstatus.suspended_state = status->suspended_state;
3168 sstatus.audio_tstamp = status->audio_tstamp;
3169 snd_pcm_stream_unlock_irq(substream);
3170 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3171 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3172 if (put_user(sstatus.state, &src->s.status.state) ||
3173 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
3174 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3175 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
3176 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
3177 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3178 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
3179 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3180 put_user(scontrol.avail_min, &src->c.control.avail_min))
3185 #define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
3187 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3189 struct snd_pcm_runtime *runtime = substream->runtime;
3192 if (get_user(arg, _arg))
3194 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3196 runtime->tstamp_type = arg;
3200 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3201 struct snd_xferi __user *_xferi)
3203 struct snd_xferi xferi;
3204 struct snd_pcm_runtime *runtime = substream->runtime;
3205 snd_pcm_sframes_t result;
3207 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3209 if (put_user(0, &_xferi->result))
3211 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3213 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3214 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3216 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
3217 if (put_user(result, &_xferi->result))
3219 return result < 0 ? result : 0;
3222 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3223 struct snd_xfern __user *_xfern)
3225 struct snd_xfern xfern;
3226 struct snd_pcm_runtime *runtime = substream->runtime;
3228 snd_pcm_sframes_t result;
3230 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3232 if (runtime->channels > 128)
3234 if (put_user(0, &_xfern->result))
3236 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3239 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3241 return PTR_ERR(bufs);
3242 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3243 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3245 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3247 if (put_user(result, &_xfern->result))
3249 return result < 0 ? result : 0;
3252 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3253 snd_pcm_uframes_t __user *_frames)
3255 snd_pcm_uframes_t frames;
3256 snd_pcm_sframes_t result;
3258 if (get_user(frames, _frames))
3260 if (put_user(0, _frames))
3262 result = snd_pcm_rewind(substream, frames);
3263 if (put_user(result, _frames))
3265 return result < 0 ? result : 0;
3268 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3269 snd_pcm_uframes_t __user *_frames)
3271 snd_pcm_uframes_t frames;
3272 snd_pcm_sframes_t result;
3274 if (get_user(frames, _frames))
3276 if (put_user(0, _frames))
3278 result = snd_pcm_forward(substream, frames);
3279 if (put_user(result, _frames))
3281 return result < 0 ? result : 0;
3284 static int snd_pcm_common_ioctl(struct file *file,
3285 struct snd_pcm_substream *substream,
3286 unsigned int cmd, void __user *arg)
3288 struct snd_pcm_file *pcm_file = file->private_data;
3291 if (PCM_RUNTIME_CHECK(substream))
3294 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3297 res = snd_power_wait(substream->pcm->card);
3302 case SNDRV_PCM_IOCTL_PVERSION:
3303 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3304 case SNDRV_PCM_IOCTL_INFO:
3305 return snd_pcm_info_user(substream, arg);
3306 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3308 case SNDRV_PCM_IOCTL_TTSTAMP:
3309 return snd_pcm_tstamp(substream, arg);
3310 case SNDRV_PCM_IOCTL_USER_PVERSION:
3311 if (get_user(pcm_file->user_pversion,
3312 (unsigned int __user *)arg))
3315 case SNDRV_PCM_IOCTL_HW_REFINE:
3316 return snd_pcm_hw_refine_user(substream, arg);
3317 case SNDRV_PCM_IOCTL_HW_PARAMS:
3318 return snd_pcm_hw_params_user(substream, arg);
3319 case SNDRV_PCM_IOCTL_HW_FREE:
3320 return snd_pcm_hw_free(substream);
3321 case SNDRV_PCM_IOCTL_SW_PARAMS:
3322 return snd_pcm_sw_params_user(substream, arg);
3323 case SNDRV_PCM_IOCTL_STATUS32:
3324 return snd_pcm_status_user32(substream, arg, false);
3325 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3326 return snd_pcm_status_user32(substream, arg, true);
3327 case SNDRV_PCM_IOCTL_STATUS64:
3328 return snd_pcm_status_user64(substream, arg, false);
3329 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3330 return snd_pcm_status_user64(substream, arg, true);
3331 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3332 return snd_pcm_channel_info_user(substream, arg);
3333 case SNDRV_PCM_IOCTL_PREPARE:
3334 return snd_pcm_prepare(substream, file);
3335 case SNDRV_PCM_IOCTL_RESET:
3336 return snd_pcm_reset(substream);
3337 case SNDRV_PCM_IOCTL_START:
3338 return snd_pcm_start_lock_irq(substream);
3339 case SNDRV_PCM_IOCTL_LINK:
3340 return snd_pcm_link(substream, (int)(unsigned long) arg);
3341 case SNDRV_PCM_IOCTL_UNLINK:
3342 return snd_pcm_unlink(substream);
3343 case SNDRV_PCM_IOCTL_RESUME:
3344 return snd_pcm_resume(substream);
3345 case SNDRV_PCM_IOCTL_XRUN:
3346 return snd_pcm_xrun(substream);
3347 case SNDRV_PCM_IOCTL_HWSYNC:
3348 return snd_pcm_hwsync(substream);
3349 case SNDRV_PCM_IOCTL_DELAY:
3351 snd_pcm_sframes_t delay = 0;
3352 snd_pcm_sframes_t __user *res = arg;
3355 err = snd_pcm_delay(substream, &delay);
3358 if (put_user(delay, res))
3362 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3363 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3364 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
3365 return snd_pcm_sync_ptr(substream, arg);
3366 #ifdef CONFIG_SND_SUPPORT_OLD_API
3367 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3368 return snd_pcm_hw_refine_old_user(substream, arg);
3369 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3370 return snd_pcm_hw_params_old_user(substream, arg);
3372 case SNDRV_PCM_IOCTL_DRAIN:
3373 return snd_pcm_drain(substream, file);
3374 case SNDRV_PCM_IOCTL_DROP:
3375 return snd_pcm_drop(substream);
3376 case SNDRV_PCM_IOCTL_PAUSE:
3377 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
3378 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3379 case SNDRV_PCM_IOCTL_READI_FRAMES:
3380 return snd_pcm_xferi_frames_ioctl(substream, arg);
3381 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3382 case SNDRV_PCM_IOCTL_READN_FRAMES:
3383 return snd_pcm_xfern_frames_ioctl(substream, arg);
3384 case SNDRV_PCM_IOCTL_REWIND:
3385 return snd_pcm_rewind_ioctl(substream, arg);
3386 case SNDRV_PCM_IOCTL_FORWARD:
3387 return snd_pcm_forward_ioctl(substream, arg);
3389 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3393 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3396 struct snd_pcm_file *pcm_file;
3398 pcm_file = file->private_data;
3400 if (((cmd >> 8) & 0xff) != 'A')
3403 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3404 (void __user *)arg);
3408 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3409 * @substream: PCM substream
3411 * @arg: IOCTL argument
3413 * The function is provided primarily for OSS layer and USB gadget drivers,
3414 * and it allows only the limited set of ioctls (hw_params, sw_params,
3415 * prepare, start, drain, drop, forward).
3417 * Return: zero if successful, or a negative error code
3419 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3420 unsigned int cmd, void *arg)
3422 snd_pcm_uframes_t *frames = arg;
3423 snd_pcm_sframes_t result;
3425 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3429 case SNDRV_PCM_IOCTL_FORWARD:
3431 /* provided only for OSS; capture-only and no value returned */
3432 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3434 result = snd_pcm_forward(substream, *frames);
3435 return result < 0 ? result : 0;
3437 case SNDRV_PCM_IOCTL_HW_PARAMS:
3438 return snd_pcm_hw_params(substream, arg);
3439 case SNDRV_PCM_IOCTL_SW_PARAMS:
3440 return snd_pcm_sw_params(substream, arg);
3441 case SNDRV_PCM_IOCTL_PREPARE:
3442 return snd_pcm_prepare(substream, NULL);
3443 case SNDRV_PCM_IOCTL_START:
3444 return snd_pcm_start_lock_irq(substream);
3445 case SNDRV_PCM_IOCTL_DRAIN:
3446 return snd_pcm_drain(substream, NULL);
3447 case SNDRV_PCM_IOCTL_DROP:
3448 return snd_pcm_drop(substream);
3449 case SNDRV_PCM_IOCTL_DELAY:
3450 return snd_pcm_delay(substream, frames);
3455 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3457 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3460 struct snd_pcm_file *pcm_file;
3461 struct snd_pcm_substream *substream;
3462 struct snd_pcm_runtime *runtime;
3463 snd_pcm_sframes_t result;
3465 pcm_file = file->private_data;
3466 substream = pcm_file->substream;
3467 if (PCM_RUNTIME_CHECK(substream))
3469 runtime = substream->runtime;
3470 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3471 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3473 if (!frame_aligned(runtime, count))
3475 count = bytes_to_frames(runtime, count);
3476 result = snd_pcm_lib_read(substream, buf, count);
3478 result = frames_to_bytes(runtime, result);
3482 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3483 size_t count, loff_t * offset)
3485 struct snd_pcm_file *pcm_file;
3486 struct snd_pcm_substream *substream;
3487 struct snd_pcm_runtime *runtime;
3488 snd_pcm_sframes_t result;
3490 pcm_file = file->private_data;
3491 substream = pcm_file->substream;
3492 if (PCM_RUNTIME_CHECK(substream))
3494 runtime = substream->runtime;
3495 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3496 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3498 if (!frame_aligned(runtime, count))
3500 count = bytes_to_frames(runtime, count);
3501 result = snd_pcm_lib_write(substream, buf, count);
3503 result = frames_to_bytes(runtime, result);
3507 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3509 struct snd_pcm_file *pcm_file;
3510 struct snd_pcm_substream *substream;
3511 struct snd_pcm_runtime *runtime;
3512 snd_pcm_sframes_t result;
3515 snd_pcm_uframes_t frames;
3517 pcm_file = iocb->ki_filp->private_data;
3518 substream = pcm_file->substream;
3519 if (PCM_RUNTIME_CHECK(substream))
3521 runtime = substream->runtime;
3522 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3523 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3525 if (!iter_is_iovec(to))
3527 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3529 if (!frame_aligned(runtime, to->iov->iov_len))
3531 frames = bytes_to_samples(runtime, to->iov->iov_len);
3532 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3535 for (i = 0; i < to->nr_segs; ++i)
3536 bufs[i] = to->iov[i].iov_base;
3537 result = snd_pcm_lib_readv(substream, bufs, frames);
3539 result = frames_to_bytes(runtime, result);
3544 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3546 struct snd_pcm_file *pcm_file;
3547 struct snd_pcm_substream *substream;
3548 struct snd_pcm_runtime *runtime;
3549 snd_pcm_sframes_t result;
3552 snd_pcm_uframes_t frames;
3554 pcm_file = iocb->ki_filp->private_data;
3555 substream = pcm_file->substream;
3556 if (PCM_RUNTIME_CHECK(substream))
3558 runtime = substream->runtime;
3559 if (runtime->state == SNDRV_PCM_STATE_OPEN ||
3560 runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3562 if (!iter_is_iovec(from))
3564 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3565 !frame_aligned(runtime, from->iov->iov_len))
3567 frames = bytes_to_samples(runtime, from->iov->iov_len);
3568 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3571 for (i = 0; i < from->nr_segs; ++i)
3572 bufs[i] = from->iov[i].iov_base;
3573 result = snd_pcm_lib_writev(substream, bufs, frames);
3575 result = frames_to_bytes(runtime, result);
3580 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3582 struct snd_pcm_file *pcm_file;
3583 struct snd_pcm_substream *substream;
3584 struct snd_pcm_runtime *runtime;
3586 snd_pcm_uframes_t avail;
3588 pcm_file = file->private_data;
3590 substream = pcm_file->substream;
3591 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3592 ok = EPOLLOUT | EPOLLWRNORM;
3594 ok = EPOLLIN | EPOLLRDNORM;
3595 if (PCM_RUNTIME_CHECK(substream))
3596 return ok | EPOLLERR;
3598 runtime = substream->runtime;
3599 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3600 return ok | EPOLLERR;
3602 poll_wait(file, &runtime->sleep, wait);
3605 snd_pcm_stream_lock_irq(substream);
3606 avail = snd_pcm_avail(substream);
3607 switch (runtime->state) {
3608 case SNDRV_PCM_STATE_RUNNING:
3609 case SNDRV_PCM_STATE_PREPARED:
3610 case SNDRV_PCM_STATE_PAUSED:
3611 if (avail >= runtime->control->avail_min)
3614 case SNDRV_PCM_STATE_DRAINING:
3615 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3622 mask = ok | EPOLLERR;
3625 snd_pcm_stream_unlock_irq(substream);
3634 * Only on coherent architectures, we can mmap the status and the control records
3635 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3637 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3639 * mmap status record
3641 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3643 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3644 struct snd_pcm_runtime *runtime;
3646 if (substream == NULL)
3647 return VM_FAULT_SIGBUS;
3648 runtime = substream->runtime;
3649 vmf->page = virt_to_page(runtime->status);
3650 get_page(vmf->page);
3654 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3656 .fault = snd_pcm_mmap_status_fault,
3659 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3660 struct vm_area_struct *area)
3663 if (!(area->vm_flags & VM_READ))
3665 size = area->vm_end - area->vm_start;
3666 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3668 area->vm_ops = &snd_pcm_vm_ops_status;
3669 area->vm_private_data = substream;
3670 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3671 area->vm_flags &= ~(VM_WRITE | VM_MAYWRITE);
3676 * mmap control record
3678 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3680 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3681 struct snd_pcm_runtime *runtime;
3683 if (substream == NULL)
3684 return VM_FAULT_SIGBUS;
3685 runtime = substream->runtime;
3686 vmf->page = virt_to_page(runtime->control);
3687 get_page(vmf->page);
3691 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3693 .fault = snd_pcm_mmap_control_fault,
3696 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3697 struct vm_area_struct *area)
3700 if (!(area->vm_flags & VM_READ))
3702 size = area->vm_end - area->vm_start;
3703 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3705 area->vm_ops = &snd_pcm_vm_ops_control;
3706 area->vm_private_data = substream;
3707 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3711 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3713 /* If drivers require the explicit sync (typically for non-coherent
3714 * pages), we have to disable the mmap of status and control data
3715 * to enforce the control via SYNC_PTR ioctl.
3717 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3719 /* See pcm_control_mmap_allowed() below.
3720 * Since older alsa-lib requires both status and control mmaps to be
3721 * coupled, we have to disable the status mmap for old alsa-lib, too.
3723 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3724 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3729 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3731 if (pcm_file->no_compat_mmap)
3734 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3736 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3737 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3738 * thus it effectively assures the manual update of appl_ptr.
3740 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3745 #else /* ! coherent mmap */
3747 * don't support mmap for status and control records.
3749 #define pcm_status_mmap_allowed(pcm_file) false
3750 #define pcm_control_mmap_allowed(pcm_file) false
3752 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3753 struct vm_area_struct *area)
3757 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3758 struct vm_area_struct *area)
3762 #endif /* coherent mmap */
3765 * fault callback for mmapping a RAM page
3767 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3769 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3770 struct snd_pcm_runtime *runtime;
3771 unsigned long offset;
3775 if (substream == NULL)
3776 return VM_FAULT_SIGBUS;
3777 runtime = substream->runtime;
3778 offset = vmf->pgoff << PAGE_SHIFT;
3779 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3780 if (offset > dma_bytes - PAGE_SIZE)
3781 return VM_FAULT_SIGBUS;
3782 if (substream->ops->page)
3783 page = substream->ops->page(substream, offset);
3784 else if (!snd_pcm_get_dma_buf(substream))
3785 page = virt_to_page(runtime->dma_area + offset);
3787 page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
3789 return VM_FAULT_SIGBUS;
3795 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3796 .open = snd_pcm_mmap_data_open,
3797 .close = snd_pcm_mmap_data_close,
3800 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3801 .open = snd_pcm_mmap_data_open,
3802 .close = snd_pcm_mmap_data_close,
3803 .fault = snd_pcm_mmap_data_fault,
3807 * mmap the DMA buffer on RAM
3811 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3812 * @substream: PCM substream
3815 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3816 * this function is invoked implicitly.
3818 * Return: zero if successful, or a negative error code
3820 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3821 struct vm_area_struct *area)
3823 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3824 if (!substream->ops->page &&
3825 !snd_dma_buffer_mmap(snd_pcm_get_dma_buf(substream), area))
3827 /* mmap with fault handler */
3828 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3831 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3834 * mmap the DMA buffer on I/O memory area
3836 #if SNDRV_PCM_INFO_MMAP_IOMEM
3838 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3839 * @substream: PCM substream
3842 * When your hardware uses the iomapped pages as the hardware buffer and
3843 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3844 * is supposed to work only on limited architectures.
3846 * Return: zero if successful, or a negative error code
3848 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3849 struct vm_area_struct *area)
3851 struct snd_pcm_runtime *runtime = substream->runtime;
3853 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3854 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3856 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3857 #endif /* SNDRV_PCM_INFO_MMAP */
3862 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3863 struct vm_area_struct *area)
3865 struct snd_pcm_runtime *runtime;
3867 unsigned long offset;
3871 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3872 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3875 if (!(area->vm_flags & VM_READ))
3878 runtime = substream->runtime;
3879 if (runtime->state == SNDRV_PCM_STATE_OPEN)
3881 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3883 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3884 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3886 size = area->vm_end - area->vm_start;
3887 offset = area->vm_pgoff << PAGE_SHIFT;
3888 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3889 if ((size_t)size > dma_bytes)
3891 if (offset > dma_bytes - size)
3894 area->vm_ops = &snd_pcm_vm_ops_data;
3895 area->vm_private_data = substream;
3896 if (substream->ops->mmap)
3897 err = substream->ops->mmap(substream, area);
3899 err = snd_pcm_lib_default_mmap(substream, area);
3901 atomic_inc(&substream->mmap_count);
3904 EXPORT_SYMBOL(snd_pcm_mmap_data);
3906 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3908 struct snd_pcm_file * pcm_file;
3909 struct snd_pcm_substream *substream;
3910 unsigned long offset;
3912 pcm_file = file->private_data;
3913 substream = pcm_file->substream;
3914 if (PCM_RUNTIME_CHECK(substream))
3916 if (substream->runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3919 offset = area->vm_pgoff << PAGE_SHIFT;
3921 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3922 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3925 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
3926 if (!pcm_status_mmap_allowed(pcm_file))
3928 return snd_pcm_mmap_status(substream, file, area);
3929 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3930 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3933 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
3934 if (!pcm_control_mmap_allowed(pcm_file))
3936 return snd_pcm_mmap_control(substream, file, area);
3938 return snd_pcm_mmap_data(substream, file, area);
3943 static int snd_pcm_fasync(int fd, struct file * file, int on)
3945 struct snd_pcm_file * pcm_file;
3946 struct snd_pcm_substream *substream;
3947 struct snd_pcm_runtime *runtime;
3949 pcm_file = file->private_data;
3950 substream = pcm_file->substream;
3951 if (PCM_RUNTIME_CHECK(substream))
3953 runtime = substream->runtime;
3954 if (runtime->state == SNDRV_PCM_STATE_DISCONNECTED)
3956 return snd_fasync_helper(fd, file, on, &runtime->fasync);
3962 #ifdef CONFIG_COMPAT
3963 #include "pcm_compat.c"
3965 #define snd_pcm_ioctl_compat NULL
3969 * To be removed helpers to keep binary compatibility
3972 #ifdef CONFIG_SND_SUPPORT_OLD_API
3973 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3974 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3976 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3977 struct snd_pcm_hw_params_old *oparams)
3981 memset(params, 0, sizeof(*params));
3982 params->flags = oparams->flags;
3983 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3984 params->masks[i].bits[0] = oparams->masks[i];
3985 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3986 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3987 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3988 params->info = oparams->info;
3989 params->msbits = oparams->msbits;
3990 params->rate_num = oparams->rate_num;
3991 params->rate_den = oparams->rate_den;
3992 params->fifo_size = oparams->fifo_size;
3995 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3996 struct snd_pcm_hw_params *params)
4000 memset(oparams, 0, sizeof(*oparams));
4001 oparams->flags = params->flags;
4002 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
4003 oparams->masks[i] = params->masks[i].bits[0];
4004 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
4005 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
4006 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
4007 oparams->info = params->info;
4008 oparams->msbits = params->msbits;
4009 oparams->rate_num = params->rate_num;
4010 oparams->rate_den = params->rate_den;
4011 oparams->fifo_size = params->fifo_size;
4014 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
4015 struct snd_pcm_hw_params_old __user * _oparams)
4017 struct snd_pcm_hw_params *params;
4018 struct snd_pcm_hw_params_old *oparams = NULL;
4021 params = kmalloc(sizeof(*params), GFP_KERNEL);
4025 oparams = memdup_user(_oparams, sizeof(*oparams));
4026 if (IS_ERR(oparams)) {
4027 err = PTR_ERR(oparams);
4030 snd_pcm_hw_convert_from_old_params(params, oparams);
4031 err = snd_pcm_hw_refine(substream, params);
4035 err = fixup_unreferenced_params(substream, params);
4039 snd_pcm_hw_convert_to_old_params(oparams, params);
4040 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4049 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
4050 struct snd_pcm_hw_params_old __user * _oparams)
4052 struct snd_pcm_hw_params *params;
4053 struct snd_pcm_hw_params_old *oparams = NULL;
4056 params = kmalloc(sizeof(*params), GFP_KERNEL);
4060 oparams = memdup_user(_oparams, sizeof(*oparams));
4061 if (IS_ERR(oparams)) {
4062 err = PTR_ERR(oparams);
4066 snd_pcm_hw_convert_from_old_params(params, oparams);
4067 err = snd_pcm_hw_params(substream, params);
4071 snd_pcm_hw_convert_to_old_params(oparams, params);
4072 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4080 #endif /* CONFIG_SND_SUPPORT_OLD_API */
4083 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
4086 unsigned long pgoff,
4087 unsigned long flags)
4089 struct snd_pcm_file *pcm_file = file->private_data;
4090 struct snd_pcm_substream *substream = pcm_file->substream;
4091 struct snd_pcm_runtime *runtime = substream->runtime;
4092 unsigned long offset = pgoff << PAGE_SHIFT;
4095 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
4096 return (unsigned long)runtime->status;
4097 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
4098 return (unsigned long)runtime->control;
4100 return (unsigned long)runtime->dma_area + offset;
4104 # define snd_pcm_get_unmapped_area NULL
4111 const struct file_operations snd_pcm_f_ops[2] = {
4113 .owner = THIS_MODULE,
4114 .write = snd_pcm_write,
4115 .write_iter = snd_pcm_writev,
4116 .open = snd_pcm_playback_open,
4117 .release = snd_pcm_release,
4118 .llseek = no_llseek,
4119 .poll = snd_pcm_poll,
4120 .unlocked_ioctl = snd_pcm_ioctl,
4121 .compat_ioctl = snd_pcm_ioctl_compat,
4122 .mmap = snd_pcm_mmap,
4123 .fasync = snd_pcm_fasync,
4124 .get_unmapped_area = snd_pcm_get_unmapped_area,
4127 .owner = THIS_MODULE,
4128 .read = snd_pcm_read,
4129 .read_iter = snd_pcm_readv,
4130 .open = snd_pcm_capture_open,
4131 .release = snd_pcm_release,
4132 .llseek = no_llseek,
4133 .poll = snd_pcm_poll,
4134 .unlocked_ioctl = snd_pcm_ioctl,
4135 .compat_ioctl = snd_pcm_ioctl_compat,
4136 .mmap = snd_pcm_mmap,
4137 .fasync = snd_pcm_fasync,
4138 .get_unmapped_area = snd_pcm_get_unmapped_area,