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->status->state != SNDRV_PCM_STATE_DISCONNECTED)
599 substream->runtime->status->state = 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 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
689 #define is_oss_stream(substream) ((substream)->oss.oss)
691 #define is_oss_stream(substream) false
694 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
695 struct snd_pcm_hw_params *params)
697 struct snd_pcm_runtime *runtime;
700 snd_pcm_uframes_t frames;
702 if (PCM_RUNTIME_CHECK(substream))
704 runtime = substream->runtime;
705 mutex_lock(&runtime->buffer_mutex);
706 snd_pcm_stream_lock_irq(substream);
707 switch (runtime->status->state) {
708 case SNDRV_PCM_STATE_OPEN:
709 case SNDRV_PCM_STATE_SETUP:
710 case SNDRV_PCM_STATE_PREPARED:
711 if (!is_oss_stream(substream) &&
712 atomic_read(&substream->mmap_count))
719 snd_pcm_stream_unlock_irq(substream);
723 snd_pcm_sync_stop(substream, true);
726 err = snd_pcm_hw_refine(substream, params);
730 err = snd_pcm_hw_params_choose(substream, params);
734 err = fixup_unreferenced_params(substream, params);
738 if (substream->managed_buffer_alloc) {
739 err = snd_pcm_lib_malloc_pages(substream,
740 params_buffer_bytes(params));
743 runtime->buffer_changed = err > 0;
746 if (substream->ops->hw_params != NULL) {
747 err = substream->ops->hw_params(substream, params);
752 runtime->access = params_access(params);
753 runtime->format = params_format(params);
754 runtime->subformat = params_subformat(params);
755 runtime->channels = params_channels(params);
756 runtime->rate = params_rate(params);
757 runtime->period_size = params_period_size(params);
758 runtime->periods = params_periods(params);
759 runtime->buffer_size = params_buffer_size(params);
760 runtime->info = params->info;
761 runtime->rate_num = params->rate_num;
762 runtime->rate_den = params->rate_den;
763 runtime->no_period_wakeup =
764 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
765 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
767 bits = snd_pcm_format_physical_width(runtime->format);
768 runtime->sample_bits = bits;
769 bits *= runtime->channels;
770 runtime->frame_bits = bits;
772 while (bits % 8 != 0) {
776 runtime->byte_align = bits / 8;
777 runtime->min_align = frames;
779 /* Default sw params */
780 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
781 runtime->period_step = 1;
782 runtime->control->avail_min = runtime->period_size;
783 runtime->start_threshold = 1;
784 runtime->stop_threshold = runtime->buffer_size;
785 runtime->silence_threshold = 0;
786 runtime->silence_size = 0;
787 runtime->boundary = runtime->buffer_size;
788 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
789 runtime->boundary *= 2;
791 /* clear the buffer for avoiding possible kernel info leaks */
792 if (runtime->dma_area && !substream->ops->copy_user) {
793 size_t size = runtime->dma_bytes;
795 if (runtime->info & SNDRV_PCM_INFO_MMAP)
796 size = PAGE_ALIGN(size);
797 memset(runtime->dma_area, 0, size);
800 snd_pcm_timer_resolution_change(substream);
801 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
803 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
804 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
805 usecs = period_to_usecs(runtime);
807 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
812 /* hardware might be unusable from this time,
813 * so we force application to retry to set
814 * the correct hardware parameter settings
816 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
817 if (substream->ops->hw_free != NULL)
818 substream->ops->hw_free(substream);
819 if (substream->managed_buffer_alloc)
820 snd_pcm_lib_free_pages(substream);
823 mutex_unlock(&runtime->buffer_mutex);
827 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
828 struct snd_pcm_hw_params __user * _params)
830 struct snd_pcm_hw_params *params;
833 params = memdup_user(_params, sizeof(*params));
835 return PTR_ERR(params);
837 err = snd_pcm_hw_params(substream, params);
841 if (copy_to_user(_params, params, sizeof(*params)))
848 static int do_hw_free(struct snd_pcm_substream *substream)
852 snd_pcm_sync_stop(substream, true);
853 if (substream->ops->hw_free)
854 result = substream->ops->hw_free(substream);
855 if (substream->managed_buffer_alloc)
856 snd_pcm_lib_free_pages(substream);
860 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
862 struct snd_pcm_runtime *runtime;
865 if (PCM_RUNTIME_CHECK(substream))
867 runtime = substream->runtime;
868 mutex_lock(&runtime->buffer_mutex);
869 snd_pcm_stream_lock_irq(substream);
870 switch (runtime->status->state) {
871 case SNDRV_PCM_STATE_SETUP:
872 case SNDRV_PCM_STATE_PREPARED:
873 if (atomic_read(&substream->mmap_count))
880 snd_pcm_stream_unlock_irq(substream);
883 result = do_hw_free(substream);
884 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
885 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
887 mutex_unlock(&runtime->buffer_mutex);
891 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
892 struct snd_pcm_sw_params *params)
894 struct snd_pcm_runtime *runtime;
897 if (PCM_RUNTIME_CHECK(substream))
899 runtime = substream->runtime;
900 snd_pcm_stream_lock_irq(substream);
901 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
902 snd_pcm_stream_unlock_irq(substream);
905 snd_pcm_stream_unlock_irq(substream);
907 if (params->tstamp_mode < 0 ||
908 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
910 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
911 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
913 if (params->avail_min == 0)
915 if (params->silence_size >= runtime->boundary) {
916 if (params->silence_threshold != 0)
919 if (params->silence_size > params->silence_threshold)
921 if (params->silence_threshold > runtime->buffer_size)
925 snd_pcm_stream_lock_irq(substream);
926 runtime->tstamp_mode = params->tstamp_mode;
927 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
928 runtime->tstamp_type = params->tstamp_type;
929 runtime->period_step = params->period_step;
930 runtime->control->avail_min = params->avail_min;
931 runtime->start_threshold = params->start_threshold;
932 runtime->stop_threshold = params->stop_threshold;
933 runtime->silence_threshold = params->silence_threshold;
934 runtime->silence_size = params->silence_size;
935 params->boundary = runtime->boundary;
936 if (snd_pcm_running(substream)) {
937 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
938 runtime->silence_size > 0)
939 snd_pcm_playback_silence(substream, ULONG_MAX);
940 err = snd_pcm_update_state(substream, runtime);
942 snd_pcm_stream_unlock_irq(substream);
946 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
947 struct snd_pcm_sw_params __user * _params)
949 struct snd_pcm_sw_params params;
951 if (copy_from_user(¶ms, _params, sizeof(params)))
953 err = snd_pcm_sw_params(substream, ¶ms);
954 if (copy_to_user(_params, ¶ms, sizeof(params)))
959 static inline snd_pcm_uframes_t
960 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
962 snd_pcm_uframes_t delay;
964 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
965 delay = snd_pcm_playback_hw_avail(substream->runtime);
967 delay = snd_pcm_capture_avail(substream->runtime);
968 return delay + substream->runtime->delay;
971 int snd_pcm_status64(struct snd_pcm_substream *substream,
972 struct snd_pcm_status64 *status)
974 struct snd_pcm_runtime *runtime = substream->runtime;
976 snd_pcm_stream_lock_irq(substream);
978 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
979 &runtime->audio_tstamp_config);
981 /* backwards compatible behavior */
982 if (runtime->audio_tstamp_config.type_requested ==
983 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
984 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
985 runtime->audio_tstamp_config.type_requested =
986 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
988 runtime->audio_tstamp_config.type_requested =
989 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
990 runtime->audio_tstamp_report.valid = 0;
992 runtime->audio_tstamp_report.valid = 1;
994 status->state = runtime->status->state;
995 status->suspended_state = runtime->status->suspended_state;
996 if (status->state == SNDRV_PCM_STATE_OPEN)
998 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
999 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
1000 if (snd_pcm_running(substream)) {
1001 snd_pcm_update_hw_ptr(substream);
1002 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1003 status->tstamp_sec = runtime->status->tstamp.tv_sec;
1004 status->tstamp_nsec =
1005 runtime->status->tstamp.tv_nsec;
1006 status->driver_tstamp_sec =
1007 runtime->driver_tstamp.tv_sec;
1008 status->driver_tstamp_nsec =
1009 runtime->driver_tstamp.tv_nsec;
1010 status->audio_tstamp_sec =
1011 runtime->status->audio_tstamp.tv_sec;
1012 status->audio_tstamp_nsec =
1013 runtime->status->audio_tstamp.tv_nsec;
1014 if (runtime->audio_tstamp_report.valid == 1)
1015 /* backwards compatibility, no report provided in COMPAT mode */
1016 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
1017 &status->audio_tstamp_accuracy,
1018 &runtime->audio_tstamp_report);
1023 /* get tstamp only in fallback mode and only if enabled */
1024 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
1025 struct timespec64 tstamp;
1027 snd_pcm_gettime(runtime, &tstamp);
1028 status->tstamp_sec = tstamp.tv_sec;
1029 status->tstamp_nsec = tstamp.tv_nsec;
1033 status->appl_ptr = runtime->control->appl_ptr;
1034 status->hw_ptr = runtime->status->hw_ptr;
1035 status->avail = snd_pcm_avail(substream);
1036 status->delay = snd_pcm_running(substream) ?
1037 snd_pcm_calc_delay(substream) : 0;
1038 status->avail_max = runtime->avail_max;
1039 status->overrange = runtime->overrange;
1040 runtime->avail_max = 0;
1041 runtime->overrange = 0;
1043 snd_pcm_stream_unlock_irq(substream);
1047 static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1048 struct snd_pcm_status64 __user * _status,
1051 struct snd_pcm_status64 status;
1054 memset(&status, 0, sizeof(status));
1056 * with extension, parameters are read/write,
1057 * get audio_tstamp_data from user,
1058 * ignore rest of status structure
1060 if (ext && get_user(status.audio_tstamp_data,
1061 (u32 __user *)(&_status->audio_tstamp_data)))
1063 res = snd_pcm_status64(substream, &status);
1066 if (copy_to_user(_status, &status, sizeof(status)))
1071 static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1072 struct snd_pcm_status32 __user * _status,
1075 struct snd_pcm_status64 status64;
1076 struct snd_pcm_status32 status32;
1079 memset(&status64, 0, sizeof(status64));
1080 memset(&status32, 0, sizeof(status32));
1082 * with extension, parameters are read/write,
1083 * get audio_tstamp_data from user,
1084 * ignore rest of status structure
1086 if (ext && get_user(status64.audio_tstamp_data,
1087 (u32 __user *)(&_status->audio_tstamp_data)))
1089 res = snd_pcm_status64(substream, &status64);
1093 status32 = (struct snd_pcm_status32) {
1094 .state = status64.state,
1095 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1096 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1097 .tstamp_sec = status64.tstamp_sec,
1098 .tstamp_nsec = status64.tstamp_nsec,
1099 .appl_ptr = status64.appl_ptr,
1100 .hw_ptr = status64.hw_ptr,
1101 .delay = status64.delay,
1102 .avail = status64.avail,
1103 .avail_max = status64.avail_max,
1104 .overrange = status64.overrange,
1105 .suspended_state = status64.suspended_state,
1106 .audio_tstamp_data = status64.audio_tstamp_data,
1107 .audio_tstamp_sec = status64.audio_tstamp_sec,
1108 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1109 .driver_tstamp_sec = status64.audio_tstamp_sec,
1110 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1111 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1114 if (copy_to_user(_status, &status32, sizeof(status32)))
1120 static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1121 struct snd_pcm_channel_info * info)
1123 struct snd_pcm_runtime *runtime;
1124 unsigned int channel;
1126 channel = info->channel;
1127 runtime = substream->runtime;
1128 snd_pcm_stream_lock_irq(substream);
1129 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
1130 snd_pcm_stream_unlock_irq(substream);
1133 snd_pcm_stream_unlock_irq(substream);
1134 if (channel >= runtime->channels)
1136 memset(info, 0, sizeof(*info));
1137 info->channel = channel;
1138 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1141 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1142 struct snd_pcm_channel_info __user * _info)
1144 struct snd_pcm_channel_info info;
1147 if (copy_from_user(&info, _info, sizeof(info)))
1149 res = snd_pcm_channel_info(substream, &info);
1152 if (copy_to_user(_info, &info, sizeof(info)))
1157 static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1159 struct snd_pcm_runtime *runtime = substream->runtime;
1160 if (runtime->trigger_master == NULL)
1162 if (runtime->trigger_master == substream) {
1163 if (!runtime->trigger_tstamp_latched)
1164 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1166 snd_pcm_trigger_tstamp(runtime->trigger_master);
1167 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1169 runtime->trigger_master = NULL;
1172 #define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1175 int (*pre_action)(struct snd_pcm_substream *substream,
1176 snd_pcm_state_t state);
1177 int (*do_action)(struct snd_pcm_substream *substream,
1178 snd_pcm_state_t state);
1179 void (*undo_action)(struct snd_pcm_substream *substream,
1180 snd_pcm_state_t state);
1181 void (*post_action)(struct snd_pcm_substream *substream,
1182 snd_pcm_state_t state);
1186 * this functions is core for handling of linked stream
1187 * Note: the stream state might be changed also on failure
1188 * Note2: call with calling stream lock + link lock
1190 static int snd_pcm_action_group(const struct action_ops *ops,
1191 struct snd_pcm_substream *substream,
1192 snd_pcm_state_t state,
1195 struct snd_pcm_substream *s = NULL;
1196 struct snd_pcm_substream *s1;
1197 int res = 0, depth = 1;
1199 snd_pcm_group_for_each_entry(s, substream) {
1200 if (s != substream) {
1202 mutex_lock_nested(&s->runtime->buffer_mutex, depth);
1203 else if (s->pcm->nonatomic)
1204 mutex_lock_nested(&s->self_group.mutex, depth);
1206 spin_lock_nested(&s->self_group.lock, depth);
1209 res = ops->pre_action(s, state);
1213 snd_pcm_group_for_each_entry(s, substream) {
1214 res = ops->do_action(s, state);
1216 if (ops->undo_action) {
1217 snd_pcm_group_for_each_entry(s1, substream) {
1218 if (s1 == s) /* failed stream */
1220 ops->undo_action(s1, state);
1223 s = NULL; /* unlock all */
1227 snd_pcm_group_for_each_entry(s, substream) {
1228 ops->post_action(s, state);
1231 /* unlock streams */
1232 snd_pcm_group_for_each_entry(s1, substream) {
1233 if (s1 != substream) {
1235 mutex_unlock(&s1->runtime->buffer_mutex);
1236 else if (s1->pcm->nonatomic)
1237 mutex_unlock(&s1->self_group.mutex);
1239 spin_unlock(&s1->self_group.lock);
1241 if (s1 == s) /* end */
1248 * Note: call with stream lock
1250 static int snd_pcm_action_single(const struct action_ops *ops,
1251 struct snd_pcm_substream *substream,
1252 snd_pcm_state_t state)
1256 res = ops->pre_action(substream, state);
1259 res = ops->do_action(substream, state);
1261 ops->post_action(substream, state);
1262 else if (ops->undo_action)
1263 ops->undo_action(substream, state);
1267 static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1268 struct snd_pcm_group *new_group)
1270 substream->group = new_group;
1271 list_move(&substream->link_list, &new_group->substreams);
1275 * Unref and unlock the group, but keep the stream lock;
1276 * when the group becomes empty and no longer referred, destroy itself
1278 static void snd_pcm_group_unref(struct snd_pcm_group *group,
1279 struct snd_pcm_substream *substream)
1285 do_free = refcount_dec_and_test(&group->refs);
1286 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1292 * Lock the group inside a stream lock and reference it;
1293 * return the locked group object, or NULL if not linked
1295 static struct snd_pcm_group *
1296 snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1298 bool nonatomic = substream->pcm->nonatomic;
1299 struct snd_pcm_group *group;
1303 if (!snd_pcm_stream_linked(substream))
1305 group = substream->group;
1306 /* block freeing the group object */
1307 refcount_inc(&group->refs);
1309 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1310 spin_trylock(&group->lock);
1314 /* re-lock for avoiding ABBA deadlock */
1315 snd_pcm_stream_unlock(substream);
1316 snd_pcm_group_lock(group, nonatomic);
1317 snd_pcm_stream_lock(substream);
1319 /* check the group again; the above opens a small race window */
1320 if (substream->group == group)
1322 /* group changed, try again */
1323 snd_pcm_group_unref(group, substream);
1329 * Note: call with stream lock
1331 static int snd_pcm_action(const struct action_ops *ops,
1332 struct snd_pcm_substream *substream,
1333 snd_pcm_state_t state)
1335 struct snd_pcm_group *group;
1338 group = snd_pcm_stream_group_ref(substream);
1340 res = snd_pcm_action_group(ops, substream, state, true);
1342 res = snd_pcm_action_single(ops, substream, state);
1343 snd_pcm_group_unref(group, substream);
1348 * Note: don't use any locks before
1350 static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1351 struct snd_pcm_substream *substream,
1352 snd_pcm_state_t state)
1356 snd_pcm_stream_lock_irq(substream);
1357 res = snd_pcm_action(ops, substream, state);
1358 snd_pcm_stream_unlock_irq(substream);
1364 static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1365 struct snd_pcm_substream *substream,
1366 snd_pcm_state_t state)
1370 /* Guarantee the group members won't change during non-atomic action */
1371 down_read(&snd_pcm_link_rwsem);
1372 mutex_lock(&substream->runtime->buffer_mutex);
1373 if (snd_pcm_stream_linked(substream))
1374 res = snd_pcm_action_group(ops, substream, state, false);
1376 res = snd_pcm_action_single(ops, substream, state);
1377 mutex_unlock(&substream->runtime->buffer_mutex);
1378 up_read(&snd_pcm_link_rwsem);
1385 static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1386 snd_pcm_state_t state)
1388 struct snd_pcm_runtime *runtime = substream->runtime;
1389 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1391 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1392 !snd_pcm_playback_data(substream))
1394 runtime->trigger_tstamp_latched = false;
1395 runtime->trigger_master = substream;
1399 static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1400 snd_pcm_state_t state)
1402 if (substream->runtime->trigger_master != substream)
1404 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1407 static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1408 snd_pcm_state_t state)
1410 if (substream->runtime->trigger_master == substream)
1411 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1414 static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1415 snd_pcm_state_t state)
1417 struct snd_pcm_runtime *runtime = substream->runtime;
1418 snd_pcm_trigger_tstamp(substream);
1419 runtime->hw_ptr_jiffies = jiffies;
1420 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1422 runtime->status->state = state;
1423 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1424 runtime->silence_size > 0)
1425 snd_pcm_playback_silence(substream, ULONG_MAX);
1426 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1429 static const struct action_ops snd_pcm_action_start = {
1430 .pre_action = snd_pcm_pre_start,
1431 .do_action = snd_pcm_do_start,
1432 .undo_action = snd_pcm_undo_start,
1433 .post_action = snd_pcm_post_start
1437 * snd_pcm_start - start all linked streams
1438 * @substream: the PCM substream instance
1440 * Return: Zero if successful, or a negative error code.
1441 * The stream lock must be acquired before calling this function.
1443 int snd_pcm_start(struct snd_pcm_substream *substream)
1445 return snd_pcm_action(&snd_pcm_action_start, substream,
1446 SNDRV_PCM_STATE_RUNNING);
1449 /* take the stream lock and start the streams */
1450 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1452 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1453 SNDRV_PCM_STATE_RUNNING);
1459 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1460 snd_pcm_state_t state)
1462 struct snd_pcm_runtime *runtime = substream->runtime;
1463 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1465 runtime->trigger_master = substream;
1469 static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1470 snd_pcm_state_t state)
1472 if (substream->runtime->trigger_master == substream &&
1473 snd_pcm_running(substream)) {
1474 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1475 substream->runtime->stop_operating = true;
1477 return 0; /* unconditionally stop all substreams */
1480 static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1481 snd_pcm_state_t state)
1483 struct snd_pcm_runtime *runtime = substream->runtime;
1484 if (runtime->status->state != state) {
1485 snd_pcm_trigger_tstamp(substream);
1486 runtime->status->state = state;
1487 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1489 wake_up(&runtime->sleep);
1490 wake_up(&runtime->tsleep);
1493 static const struct action_ops snd_pcm_action_stop = {
1494 .pre_action = snd_pcm_pre_stop,
1495 .do_action = snd_pcm_do_stop,
1496 .post_action = snd_pcm_post_stop
1500 * snd_pcm_stop - try to stop all running streams in the substream group
1501 * @substream: the PCM substream instance
1502 * @state: PCM state after stopping the stream
1504 * The state of each stream is then changed to the given state unconditionally.
1506 * Return: Zero if successful, or a negative error code.
1508 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1510 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1512 EXPORT_SYMBOL(snd_pcm_stop);
1515 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1516 * @substream: the PCM substream
1518 * After stopping, the state is changed to SETUP.
1519 * Unlike snd_pcm_stop(), this affects only the given stream.
1521 * Return: Zero if successful, or a negative error code.
1523 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1525 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1526 SNDRV_PCM_STATE_SETUP);
1530 * snd_pcm_stop_xrun - stop the running streams as XRUN
1531 * @substream: the PCM substream instance
1533 * This stops the given running substream (and all linked substreams) as XRUN.
1534 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1536 * Return: Zero if successful, or a negative error code.
1538 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1540 unsigned long flags;
1542 snd_pcm_stream_lock_irqsave(substream, flags);
1543 if (substream->runtime && snd_pcm_running(substream))
1544 __snd_pcm_xrun(substream);
1545 snd_pcm_stream_unlock_irqrestore(substream, flags);
1548 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1551 * pause callbacks: pass boolean (to start pause or resume) as state argument
1553 #define pause_pushed(state) (__force bool)(state)
1555 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1556 snd_pcm_state_t state)
1558 struct snd_pcm_runtime *runtime = substream->runtime;
1559 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1561 if (pause_pushed(state)) {
1562 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1564 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1566 runtime->trigger_master = substream;
1570 static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1571 snd_pcm_state_t state)
1573 if (substream->runtime->trigger_master != substream)
1575 /* some drivers might use hw_ptr to recover from the pause -
1576 update the hw_ptr now */
1577 if (pause_pushed(state))
1578 snd_pcm_update_hw_ptr(substream);
1579 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1580 * a delta between the current jiffies, this gives a large enough
1581 * delta, effectively to skip the check once.
1583 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1584 return substream->ops->trigger(substream,
1585 pause_pushed(state) ?
1586 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1587 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1590 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1591 snd_pcm_state_t state)
1593 if (substream->runtime->trigger_master == substream)
1594 substream->ops->trigger(substream,
1595 pause_pushed(state) ?
1596 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1597 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1600 static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1601 snd_pcm_state_t state)
1603 struct snd_pcm_runtime *runtime = substream->runtime;
1604 snd_pcm_trigger_tstamp(substream);
1605 if (pause_pushed(state)) {
1606 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
1607 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1608 wake_up(&runtime->sleep);
1609 wake_up(&runtime->tsleep);
1611 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
1612 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1616 static const struct action_ops snd_pcm_action_pause = {
1617 .pre_action = snd_pcm_pre_pause,
1618 .do_action = snd_pcm_do_pause,
1619 .undo_action = snd_pcm_undo_pause,
1620 .post_action = snd_pcm_post_pause
1624 * Push/release the pause for all linked streams.
1626 static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1628 return snd_pcm_action(&snd_pcm_action_pause, substream,
1629 (__force snd_pcm_state_t)push);
1632 static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1635 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1636 (__force snd_pcm_state_t)push);
1640 /* suspend callback: state argument ignored */
1642 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1643 snd_pcm_state_t state)
1645 struct snd_pcm_runtime *runtime = substream->runtime;
1646 switch (runtime->status->state) {
1647 case SNDRV_PCM_STATE_SUSPENDED:
1649 /* unresumable PCM state; return -EBUSY for skipping suspend */
1650 case SNDRV_PCM_STATE_OPEN:
1651 case SNDRV_PCM_STATE_SETUP:
1652 case SNDRV_PCM_STATE_DISCONNECTED:
1655 runtime->trigger_master = substream;
1659 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1660 snd_pcm_state_t state)
1662 struct snd_pcm_runtime *runtime = substream->runtime;
1663 if (runtime->trigger_master != substream)
1665 if (! snd_pcm_running(substream))
1667 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1668 runtime->stop_operating = true;
1669 return 0; /* suspend unconditionally */
1672 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1673 snd_pcm_state_t state)
1675 struct snd_pcm_runtime *runtime = substream->runtime;
1676 snd_pcm_trigger_tstamp(substream);
1677 runtime->status->suspended_state = runtime->status->state;
1678 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
1679 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1680 wake_up(&runtime->sleep);
1681 wake_up(&runtime->tsleep);
1684 static const struct action_ops snd_pcm_action_suspend = {
1685 .pre_action = snd_pcm_pre_suspend,
1686 .do_action = snd_pcm_do_suspend,
1687 .post_action = snd_pcm_post_suspend
1691 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1692 * @substream: the PCM substream
1694 * After this call, all streams are changed to SUSPENDED state.
1696 * Return: Zero if successful, or a negative error code.
1698 static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1701 unsigned long flags;
1703 snd_pcm_stream_lock_irqsave(substream, flags);
1704 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1706 snd_pcm_stream_unlock_irqrestore(substream, flags);
1711 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1712 * @pcm: the PCM instance
1714 * After this call, all streams are changed to SUSPENDED state.
1716 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1718 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1720 struct snd_pcm_substream *substream;
1721 int stream, err = 0;
1726 for_each_pcm_substream(pcm, stream, substream) {
1727 /* FIXME: the open/close code should lock this as well */
1728 if (!substream->runtime)
1732 * Skip BE dai link PCM's that are internal and may
1733 * not have their substream ops set.
1735 if (!substream->ops)
1738 err = snd_pcm_suspend(substream);
1739 if (err < 0 && err != -EBUSY)
1743 for_each_pcm_substream(pcm, stream, substream)
1744 snd_pcm_sync_stop(substream, false);
1748 EXPORT_SYMBOL(snd_pcm_suspend_all);
1750 /* resume callbacks: state argument ignored */
1752 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1753 snd_pcm_state_t state)
1755 struct snd_pcm_runtime *runtime = substream->runtime;
1756 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1758 runtime->trigger_master = substream;
1762 static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1763 snd_pcm_state_t state)
1765 struct snd_pcm_runtime *runtime = substream->runtime;
1766 if (runtime->trigger_master != substream)
1768 /* DMA not running previously? */
1769 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1770 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1771 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1773 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1776 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1777 snd_pcm_state_t state)
1779 if (substream->runtime->trigger_master == substream &&
1780 snd_pcm_running(substream))
1781 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1784 static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1785 snd_pcm_state_t state)
1787 struct snd_pcm_runtime *runtime = substream->runtime;
1788 snd_pcm_trigger_tstamp(substream);
1789 runtime->status->state = runtime->status->suspended_state;
1790 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1793 static const struct action_ops snd_pcm_action_resume = {
1794 .pre_action = snd_pcm_pre_resume,
1795 .do_action = snd_pcm_do_resume,
1796 .undo_action = snd_pcm_undo_resume,
1797 .post_action = snd_pcm_post_resume
1800 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1802 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1808 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1813 #endif /* CONFIG_PM */
1818 * Change the RUNNING stream(s) to XRUN state.
1820 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1822 struct snd_pcm_runtime *runtime = substream->runtime;
1825 snd_pcm_stream_lock_irq(substream);
1826 switch (runtime->status->state) {
1827 case SNDRV_PCM_STATE_XRUN:
1828 result = 0; /* already there */
1830 case SNDRV_PCM_STATE_RUNNING:
1831 __snd_pcm_xrun(substream);
1837 snd_pcm_stream_unlock_irq(substream);
1844 /* reset callbacks: state argument ignored */
1845 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1846 snd_pcm_state_t state)
1848 struct snd_pcm_runtime *runtime = substream->runtime;
1849 switch (runtime->status->state) {
1850 case SNDRV_PCM_STATE_RUNNING:
1851 case SNDRV_PCM_STATE_PREPARED:
1852 case SNDRV_PCM_STATE_PAUSED:
1853 case SNDRV_PCM_STATE_SUSPENDED:
1860 static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1861 snd_pcm_state_t state)
1863 struct snd_pcm_runtime *runtime = substream->runtime;
1864 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1867 snd_pcm_stream_lock_irq(substream);
1868 runtime->hw_ptr_base = 0;
1869 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1870 runtime->status->hw_ptr % runtime->period_size;
1871 runtime->silence_start = runtime->status->hw_ptr;
1872 runtime->silence_filled = 0;
1873 snd_pcm_stream_unlock_irq(substream);
1877 static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1878 snd_pcm_state_t state)
1880 struct snd_pcm_runtime *runtime = substream->runtime;
1881 snd_pcm_stream_lock_irq(substream);
1882 runtime->control->appl_ptr = runtime->status->hw_ptr;
1883 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1884 runtime->silence_size > 0)
1885 snd_pcm_playback_silence(substream, ULONG_MAX);
1886 snd_pcm_stream_unlock_irq(substream);
1889 static const struct action_ops snd_pcm_action_reset = {
1890 .pre_action = snd_pcm_pre_reset,
1891 .do_action = snd_pcm_do_reset,
1892 .post_action = snd_pcm_post_reset
1895 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1897 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1904 /* pass f_flags as state argument */
1905 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1906 snd_pcm_state_t state)
1908 struct snd_pcm_runtime *runtime = substream->runtime;
1909 int f_flags = (__force int)state;
1911 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1912 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1914 if (snd_pcm_running(substream))
1916 substream->f_flags = f_flags;
1920 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1921 snd_pcm_state_t state)
1924 snd_pcm_sync_stop(substream, true);
1925 err = substream->ops->prepare(substream);
1928 return snd_pcm_do_reset(substream, state);
1931 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1932 snd_pcm_state_t state)
1934 struct snd_pcm_runtime *runtime = substream->runtime;
1935 runtime->control->appl_ptr = runtime->status->hw_ptr;
1936 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1939 static const struct action_ops snd_pcm_action_prepare = {
1940 .pre_action = snd_pcm_pre_prepare,
1941 .do_action = snd_pcm_do_prepare,
1942 .post_action = snd_pcm_post_prepare
1946 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1947 * @substream: the PCM substream instance
1948 * @file: file to refer f_flags
1950 * Return: Zero if successful, or a negative error code.
1952 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1958 f_flags = file->f_flags;
1960 f_flags = substream->f_flags;
1962 snd_pcm_stream_lock_irq(substream);
1963 switch (substream->runtime->status->state) {
1964 case SNDRV_PCM_STATE_PAUSED:
1965 snd_pcm_pause(substream, false);
1967 case SNDRV_PCM_STATE_SUSPENDED:
1968 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1971 snd_pcm_stream_unlock_irq(substream);
1973 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
1975 (__force snd_pcm_state_t)f_flags);
1982 /* drain init callbacks: state argument ignored */
1983 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
1984 snd_pcm_state_t state)
1986 struct snd_pcm_runtime *runtime = substream->runtime;
1987 switch (runtime->status->state) {
1988 case SNDRV_PCM_STATE_OPEN:
1989 case SNDRV_PCM_STATE_DISCONNECTED:
1990 case SNDRV_PCM_STATE_SUSPENDED:
1993 runtime->trigger_master = substream;
1997 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
1998 snd_pcm_state_t state)
2000 struct snd_pcm_runtime *runtime = substream->runtime;
2001 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
2002 switch (runtime->status->state) {
2003 case SNDRV_PCM_STATE_PREPARED:
2004 /* start playback stream if possible */
2005 if (! snd_pcm_playback_empty(substream)) {
2006 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
2007 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
2009 runtime->status->state = SNDRV_PCM_STATE_SETUP;
2012 case SNDRV_PCM_STATE_RUNNING:
2013 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
2015 case SNDRV_PCM_STATE_XRUN:
2016 runtime->status->state = SNDRV_PCM_STATE_SETUP;
2022 /* stop running stream */
2023 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
2024 snd_pcm_state_t new_state;
2026 new_state = snd_pcm_capture_avail(runtime) > 0 ?
2027 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
2028 snd_pcm_do_stop(substream, new_state);
2029 snd_pcm_post_stop(substream, new_state);
2033 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
2034 runtime->trigger_master == substream &&
2035 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
2036 return substream->ops->trigger(substream,
2037 SNDRV_PCM_TRIGGER_DRAIN);
2042 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
2043 snd_pcm_state_t state)
2047 static const struct action_ops snd_pcm_action_drain_init = {
2048 .pre_action = snd_pcm_pre_drain_init,
2049 .do_action = snd_pcm_do_drain_init,
2050 .post_action = snd_pcm_post_drain_init
2054 * Drain the stream(s).
2055 * When the substream is linked, sync until the draining of all playback streams
2057 * After this call, all streams are supposed to be either SETUP or DRAINING
2058 * (capture only) state.
2060 static int snd_pcm_drain(struct snd_pcm_substream *substream,
2063 struct snd_card *card;
2064 struct snd_pcm_runtime *runtime;
2065 struct snd_pcm_substream *s;
2066 struct snd_pcm_group *group;
2067 wait_queue_entry_t wait;
2071 card = substream->pcm->card;
2072 runtime = substream->runtime;
2074 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2078 if (file->f_flags & O_NONBLOCK)
2080 } else if (substream->f_flags & O_NONBLOCK)
2083 snd_pcm_stream_lock_irq(substream);
2085 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
2086 snd_pcm_pause(substream, false);
2088 /* pre-start/stop - all running streams are changed to DRAINING state */
2089 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2093 /* in non-blocking, we don't wait in ioctl but let caller poll */
2101 struct snd_pcm_runtime *to_check;
2102 if (signal_pending(current)) {
2103 result = -ERESTARTSYS;
2106 /* find a substream to drain */
2108 group = snd_pcm_stream_group_ref(substream);
2109 snd_pcm_group_for_each_entry(s, substream) {
2110 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2112 runtime = s->runtime;
2113 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
2118 snd_pcm_group_unref(group, substream);
2120 break; /* all drained */
2121 init_waitqueue_entry(&wait, current);
2122 set_current_state(TASK_INTERRUPTIBLE);
2123 add_wait_queue(&to_check->sleep, &wait);
2124 snd_pcm_stream_unlock_irq(substream);
2125 if (runtime->no_period_wakeup)
2126 tout = MAX_SCHEDULE_TIMEOUT;
2129 if (runtime->rate) {
2130 long t = runtime->period_size * 2 / runtime->rate;
2131 tout = max(t, tout);
2133 tout = msecs_to_jiffies(tout * 1000);
2135 tout = schedule_timeout(tout);
2137 snd_pcm_stream_lock_irq(substream);
2138 group = snd_pcm_stream_group_ref(substream);
2139 snd_pcm_group_for_each_entry(s, substream) {
2140 if (s->runtime == to_check) {
2141 remove_wait_queue(&to_check->sleep, &wait);
2145 snd_pcm_group_unref(group, substream);
2147 if (card->shutdown) {
2152 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
2155 dev_dbg(substream->pcm->card->dev,
2156 "playback drain error (DMA or IRQ trouble?)\n");
2157 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2165 snd_pcm_stream_unlock_irq(substream);
2173 * Immediately put all linked substreams into SETUP state.
2175 static int snd_pcm_drop(struct snd_pcm_substream *substream)
2177 struct snd_pcm_runtime *runtime;
2180 if (PCM_RUNTIME_CHECK(substream))
2182 runtime = substream->runtime;
2184 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2185 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
2188 snd_pcm_stream_lock_irq(substream);
2190 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
2191 snd_pcm_pause(substream, false);
2193 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2194 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2195 snd_pcm_stream_unlock_irq(substream);
2201 static bool is_pcm_file(struct file *file)
2203 struct inode *inode = file_inode(file);
2204 struct snd_pcm *pcm;
2207 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2209 minor = iminor(inode);
2210 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2212 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2215 snd_card_unref(pcm->card);
2222 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
2225 struct snd_pcm_file *pcm_file;
2226 struct snd_pcm_substream *substream1;
2227 struct snd_pcm_group *group, *target_group;
2228 bool nonatomic = substream->pcm->nonatomic;
2229 struct fd f = fdget(fd);
2233 if (!is_pcm_file(f.file)) {
2237 pcm_file = f.file->private_data;
2238 substream1 = pcm_file->substream;
2240 if (substream == substream1) {
2245 group = kzalloc(sizeof(*group), GFP_KERNEL);
2250 snd_pcm_group_init(group);
2252 down_write(&snd_pcm_link_rwsem);
2253 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2254 substream->runtime->status->state != substream1->runtime->status->state ||
2255 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2259 if (snd_pcm_stream_linked(substream1)) {
2264 snd_pcm_stream_lock_irq(substream);
2265 if (!snd_pcm_stream_linked(substream)) {
2266 snd_pcm_group_assign(substream, group);
2267 group = NULL; /* assigned, don't free this one below */
2269 target_group = substream->group;
2270 snd_pcm_stream_unlock_irq(substream);
2272 snd_pcm_group_lock_irq(target_group, nonatomic);
2273 snd_pcm_stream_lock_nested(substream1);
2274 snd_pcm_group_assign(substream1, target_group);
2275 refcount_inc(&target_group->refs);
2276 snd_pcm_stream_unlock(substream1);
2277 snd_pcm_group_unlock_irq(target_group, nonatomic);
2279 up_write(&snd_pcm_link_rwsem);
2287 static void relink_to_local(struct snd_pcm_substream *substream)
2289 snd_pcm_stream_lock_nested(substream);
2290 snd_pcm_group_assign(substream, &substream->self_group);
2291 snd_pcm_stream_unlock(substream);
2294 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2296 struct snd_pcm_group *group;
2297 bool nonatomic = substream->pcm->nonatomic;
2298 bool do_free = false;
2301 down_write(&snd_pcm_link_rwsem);
2303 if (!snd_pcm_stream_linked(substream)) {
2308 group = substream->group;
2309 snd_pcm_group_lock_irq(group, nonatomic);
2311 relink_to_local(substream);
2312 refcount_dec(&group->refs);
2314 /* detach the last stream, too */
2315 if (list_is_singular(&group->substreams)) {
2316 relink_to_local(list_first_entry(&group->substreams,
2317 struct snd_pcm_substream,
2319 do_free = refcount_dec_and_test(&group->refs);
2322 snd_pcm_group_unlock_irq(group, nonatomic);
2327 up_write(&snd_pcm_link_rwsem);
2334 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2335 struct snd_pcm_hw_rule *rule)
2337 struct snd_interval t;
2338 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2339 hw_param_interval_c(params, rule->deps[1]), &t);
2340 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2343 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2344 struct snd_pcm_hw_rule *rule)
2346 struct snd_interval t;
2347 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2348 hw_param_interval_c(params, rule->deps[1]), &t);
2349 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2352 static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2353 struct snd_pcm_hw_rule *rule)
2355 struct snd_interval t;
2356 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2357 hw_param_interval_c(params, rule->deps[1]),
2358 (unsigned long) rule->private, &t);
2359 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2362 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2363 struct snd_pcm_hw_rule *rule)
2365 struct snd_interval t;
2366 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2367 (unsigned long) rule->private,
2368 hw_param_interval_c(params, rule->deps[1]), &t);
2369 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2372 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2373 struct snd_pcm_hw_rule *rule)
2376 const struct snd_interval *i =
2377 hw_param_interval_c(params, rule->deps[0]);
2379 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2381 pcm_for_each_format(k) {
2383 if (!snd_mask_test_format(mask, k))
2385 bits = snd_pcm_format_physical_width(k);
2387 continue; /* ignore invalid formats */
2388 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2389 snd_mask_reset(&m, (__force unsigned)k);
2391 return snd_mask_refine(mask, &m);
2394 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2395 struct snd_pcm_hw_rule *rule)
2397 struct snd_interval t;
2404 pcm_for_each_format(k) {
2406 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2408 bits = snd_pcm_format_physical_width(k);
2410 continue; /* ignore invalid formats */
2411 if (t.min > (unsigned)bits)
2413 if (t.max < (unsigned)bits)
2417 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2420 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2421 #error "Change this table"
2424 static const unsigned int rates[] = {
2425 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2426 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2429 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2430 .count = ARRAY_SIZE(rates),
2434 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2435 struct snd_pcm_hw_rule *rule)
2437 struct snd_pcm_hardware *hw = rule->private;
2438 return snd_interval_list(hw_param_interval(params, rule->var),
2439 snd_pcm_known_rates.count,
2440 snd_pcm_known_rates.list, hw->rates);
2443 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2444 struct snd_pcm_hw_rule *rule)
2446 struct snd_interval t;
2447 struct snd_pcm_substream *substream = rule->private;
2449 t.max = substream->buffer_bytes_max;
2453 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2456 static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2458 struct snd_pcm_runtime *runtime = substream->runtime;
2459 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2462 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2463 snd_mask_any(constrs_mask(constrs, k));
2466 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2467 snd_interval_any(constrs_interval(constrs, k));
2470 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2471 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2472 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2473 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2474 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2476 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2477 snd_pcm_hw_rule_format, NULL,
2478 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2481 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2482 snd_pcm_hw_rule_sample_bits, NULL,
2483 SNDRV_PCM_HW_PARAM_FORMAT,
2484 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2487 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2488 snd_pcm_hw_rule_div, NULL,
2489 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2492 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2493 snd_pcm_hw_rule_mul, NULL,
2494 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2497 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2498 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2499 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2502 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2503 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2504 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2507 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2508 snd_pcm_hw_rule_div, NULL,
2509 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2512 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2513 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2514 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2517 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2518 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2519 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2522 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2523 snd_pcm_hw_rule_div, NULL,
2524 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2527 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2528 snd_pcm_hw_rule_div, NULL,
2529 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2532 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2533 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2534 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2537 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2538 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2539 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2542 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2543 snd_pcm_hw_rule_mul, NULL,
2544 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2547 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2548 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2549 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2552 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2553 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2554 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2557 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2558 snd_pcm_hw_rule_muldivk, (void*) 8,
2559 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2562 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2563 snd_pcm_hw_rule_muldivk, (void*) 8,
2564 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2567 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2568 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2569 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2572 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2573 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2574 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2580 static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2582 struct snd_pcm_runtime *runtime = substream->runtime;
2583 struct snd_pcm_hardware *hw = &runtime->hw;
2585 unsigned int mask = 0;
2587 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2588 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
2589 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2590 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
2591 if (hw_support_mmap(substream)) {
2592 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2593 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
2594 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2595 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
2596 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2597 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
2599 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2603 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2607 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2608 PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
2612 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2613 hw->channels_min, hw->channels_max);
2617 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2618 hw->rate_min, hw->rate_max);
2622 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2623 hw->period_bytes_min, hw->period_bytes_max);
2627 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2628 hw->periods_min, hw->periods_max);
2632 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2633 hw->period_bytes_min, hw->buffer_bytes_max);
2637 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2638 snd_pcm_hw_rule_buffer_bytes_max, substream,
2639 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2644 if (runtime->dma_bytes) {
2645 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2650 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2651 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2652 snd_pcm_hw_rule_rate, hw,
2653 SNDRV_PCM_HW_PARAM_RATE, -1);
2658 /* FIXME: this belong to lowlevel */
2659 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2664 static void pcm_release_private(struct snd_pcm_substream *substream)
2666 if (snd_pcm_stream_linked(substream))
2667 snd_pcm_unlink(substream);
2670 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2672 substream->ref_count--;
2673 if (substream->ref_count > 0)
2676 snd_pcm_drop(substream);
2677 if (substream->hw_opened) {
2678 if (substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2679 do_hw_free(substream);
2680 substream->ops->close(substream);
2681 substream->hw_opened = 0;
2683 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2684 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
2685 if (substream->pcm_release) {
2686 substream->pcm_release(substream);
2687 substream->pcm_release = NULL;
2689 snd_pcm_detach_substream(substream);
2691 EXPORT_SYMBOL(snd_pcm_release_substream);
2693 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2695 struct snd_pcm_substream **rsubstream)
2697 struct snd_pcm_substream *substream;
2700 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2703 if (substream->ref_count > 1) {
2704 *rsubstream = substream;
2708 err = snd_pcm_hw_constraints_init(substream);
2710 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2714 err = substream->ops->open(substream);
2718 substream->hw_opened = 1;
2720 err = snd_pcm_hw_constraints_complete(substream);
2722 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2726 /* automatically set EXPLICIT_SYNC flag in the managed mode whenever
2727 * the DMA buffer requires it
2729 if (substream->managed_buffer_alloc &&
2730 substream->dma_buffer.dev.need_sync)
2731 substream->runtime->hw.info |= SNDRV_PCM_INFO_EXPLICIT_SYNC;
2733 *rsubstream = substream;
2737 snd_pcm_release_substream(substream);
2740 EXPORT_SYMBOL(snd_pcm_open_substream);
2742 static int snd_pcm_open_file(struct file *file,
2743 struct snd_pcm *pcm,
2746 struct snd_pcm_file *pcm_file;
2747 struct snd_pcm_substream *substream;
2750 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2754 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2755 if (pcm_file == NULL) {
2756 snd_pcm_release_substream(substream);
2759 pcm_file->substream = substream;
2760 if (substream->ref_count == 1)
2761 substream->pcm_release = pcm_release_private;
2762 file->private_data = pcm_file;
2767 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2769 struct snd_pcm *pcm;
2770 int err = nonseekable_open(inode, file);
2773 pcm = snd_lookup_minor_data(iminor(inode),
2774 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2775 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2777 snd_card_unref(pcm->card);
2781 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2783 struct snd_pcm *pcm;
2784 int err = nonseekable_open(inode, file);
2787 pcm = snd_lookup_minor_data(iminor(inode),
2788 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2789 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2791 snd_card_unref(pcm->card);
2795 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2798 wait_queue_entry_t wait;
2804 err = snd_card_file_add(pcm->card, file);
2807 if (!try_module_get(pcm->card->module)) {
2811 init_waitqueue_entry(&wait, current);
2812 add_wait_queue(&pcm->open_wait, &wait);
2813 mutex_lock(&pcm->open_mutex);
2815 err = snd_pcm_open_file(file, pcm, stream);
2818 if (err == -EAGAIN) {
2819 if (file->f_flags & O_NONBLOCK) {
2825 set_current_state(TASK_INTERRUPTIBLE);
2826 mutex_unlock(&pcm->open_mutex);
2828 mutex_lock(&pcm->open_mutex);
2829 if (pcm->card->shutdown) {
2833 if (signal_pending(current)) {
2838 remove_wait_queue(&pcm->open_wait, &wait);
2839 mutex_unlock(&pcm->open_mutex);
2845 module_put(pcm->card->module);
2847 snd_card_file_remove(pcm->card, file);
2852 static int snd_pcm_release(struct inode *inode, struct file *file)
2854 struct snd_pcm *pcm;
2855 struct snd_pcm_substream *substream;
2856 struct snd_pcm_file *pcm_file;
2858 pcm_file = file->private_data;
2859 substream = pcm_file->substream;
2860 if (snd_BUG_ON(!substream))
2862 pcm = substream->pcm;
2864 /* block until the device gets woken up as it may touch the hardware */
2865 snd_power_wait(pcm->card);
2867 mutex_lock(&pcm->open_mutex);
2868 snd_pcm_release_substream(substream);
2870 mutex_unlock(&pcm->open_mutex);
2871 wake_up(&pcm->open_wait);
2872 module_put(pcm->card->module);
2873 snd_card_file_remove(pcm->card, file);
2877 /* check and update PCM state; return 0 or a negative error
2878 * call this inside PCM lock
2880 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2882 switch (substream->runtime->status->state) {
2883 case SNDRV_PCM_STATE_DRAINING:
2884 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2887 case SNDRV_PCM_STATE_RUNNING:
2888 return snd_pcm_update_hw_ptr(substream);
2889 case SNDRV_PCM_STATE_PREPARED:
2890 case SNDRV_PCM_STATE_PAUSED:
2892 case SNDRV_PCM_STATE_SUSPENDED:
2894 case SNDRV_PCM_STATE_XRUN:
2901 /* increase the appl_ptr; returns the processed frames or a negative error */
2902 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2903 snd_pcm_uframes_t frames,
2904 snd_pcm_sframes_t avail)
2906 struct snd_pcm_runtime *runtime = substream->runtime;
2907 snd_pcm_sframes_t appl_ptr;
2912 if (frames > (snd_pcm_uframes_t)avail)
2914 appl_ptr = runtime->control->appl_ptr + frames;
2915 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2916 appl_ptr -= runtime->boundary;
2917 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2918 return ret < 0 ? ret : frames;
2921 /* decrease the appl_ptr; returns the processed frames or zero for error */
2922 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2923 snd_pcm_uframes_t frames,
2924 snd_pcm_sframes_t avail)
2926 struct snd_pcm_runtime *runtime = substream->runtime;
2927 snd_pcm_sframes_t appl_ptr;
2932 if (frames > (snd_pcm_uframes_t)avail)
2934 appl_ptr = runtime->control->appl_ptr - frames;
2936 appl_ptr += runtime->boundary;
2937 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2938 /* NOTE: we return zero for errors because PulseAudio gets depressed
2939 * upon receiving an error from rewind ioctl and stops processing
2940 * any longer. Returning zero means that no rewind is done, so
2941 * it's not absolutely wrong to answer like that.
2943 return ret < 0 ? 0 : frames;
2946 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2947 snd_pcm_uframes_t frames)
2949 snd_pcm_sframes_t ret;
2954 snd_pcm_stream_lock_irq(substream);
2955 ret = do_pcm_hwsync(substream);
2957 ret = rewind_appl_ptr(substream, frames,
2958 snd_pcm_hw_avail(substream));
2959 snd_pcm_stream_unlock_irq(substream);
2961 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2965 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2966 snd_pcm_uframes_t frames)
2968 snd_pcm_sframes_t ret;
2973 snd_pcm_stream_lock_irq(substream);
2974 ret = do_pcm_hwsync(substream);
2976 ret = forward_appl_ptr(substream, frames,
2977 snd_pcm_avail(substream));
2978 snd_pcm_stream_unlock_irq(substream);
2980 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2984 static int snd_pcm_delay(struct snd_pcm_substream *substream,
2985 snd_pcm_sframes_t *delay)
2989 snd_pcm_stream_lock_irq(substream);
2990 err = do_pcm_hwsync(substream);
2992 *delay = snd_pcm_calc_delay(substream);
2993 snd_pcm_stream_unlock_irq(substream);
2994 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
2999 static inline int snd_pcm_hwsync(struct snd_pcm_substream *substream)
3001 return snd_pcm_delay(substream, NULL);
3004 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
3005 struct snd_pcm_sync_ptr __user *_sync_ptr)
3007 struct snd_pcm_runtime *runtime = substream->runtime;
3008 struct snd_pcm_sync_ptr sync_ptr;
3009 volatile struct snd_pcm_mmap_status *status;
3010 volatile struct snd_pcm_mmap_control *control;
3013 memset(&sync_ptr, 0, sizeof(sync_ptr));
3014 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
3016 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
3018 status = runtime->status;
3019 control = runtime->control;
3020 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3021 err = snd_pcm_hwsync(substream);
3025 snd_pcm_stream_lock_irq(substream);
3026 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
3027 err = pcm_lib_apply_appl_ptr(substream,
3028 sync_ptr.c.control.appl_ptr);
3030 snd_pcm_stream_unlock_irq(substream);
3034 sync_ptr.c.control.appl_ptr = control->appl_ptr;
3036 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3037 control->avail_min = sync_ptr.c.control.avail_min;
3039 sync_ptr.c.control.avail_min = control->avail_min;
3040 sync_ptr.s.status.state = status->state;
3041 sync_ptr.s.status.hw_ptr = status->hw_ptr;
3042 sync_ptr.s.status.tstamp = status->tstamp;
3043 sync_ptr.s.status.suspended_state = status->suspended_state;
3044 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
3045 snd_pcm_stream_unlock_irq(substream);
3046 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL))
3047 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3048 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
3053 struct snd_pcm_mmap_status32 {
3054 snd_pcm_state_t state;
3059 snd_pcm_state_t suspended_state;
3060 s32 audio_tstamp_sec;
3061 s32 audio_tstamp_nsec;
3062 } __attribute__((packed));
3064 struct snd_pcm_mmap_control32 {
3069 struct snd_pcm_sync_ptr32 {
3072 struct snd_pcm_mmap_status32 status;
3073 unsigned char reserved[64];
3076 struct snd_pcm_mmap_control32 control;
3077 unsigned char reserved[64];
3079 } __attribute__((packed));
3081 /* recalcuate the boundary within 32bit */
3082 static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3084 snd_pcm_uframes_t boundary;
3086 if (! runtime->buffer_size)
3088 boundary = runtime->buffer_size;
3089 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3094 static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3095 struct snd_pcm_sync_ptr32 __user *src)
3097 struct snd_pcm_runtime *runtime = substream->runtime;
3098 volatile struct snd_pcm_mmap_status *status;
3099 volatile struct snd_pcm_mmap_control *control;
3101 struct snd_pcm_mmap_control scontrol;
3102 struct snd_pcm_mmap_status sstatus;
3103 snd_pcm_uframes_t boundary;
3106 if (snd_BUG_ON(!runtime))
3109 if (get_user(sflags, &src->flags) ||
3110 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3111 get_user(scontrol.avail_min, &src->c.control.avail_min))
3113 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3114 err = snd_pcm_hwsync(substream);
3118 status = runtime->status;
3119 control = runtime->control;
3120 boundary = recalculate_boundary(runtime);
3122 boundary = 0x7fffffff;
3123 snd_pcm_stream_lock_irq(substream);
3124 /* FIXME: we should consider the boundary for the sync from app */
3125 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL)) {
3126 err = pcm_lib_apply_appl_ptr(substream,
3129 snd_pcm_stream_unlock_irq(substream);
3133 scontrol.appl_ptr = control->appl_ptr % boundary;
3134 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3135 control->avail_min = scontrol.avail_min;
3137 scontrol.avail_min = control->avail_min;
3138 sstatus.state = status->state;
3139 sstatus.hw_ptr = status->hw_ptr % boundary;
3140 sstatus.tstamp = status->tstamp;
3141 sstatus.suspended_state = status->suspended_state;
3142 sstatus.audio_tstamp = status->audio_tstamp;
3143 snd_pcm_stream_unlock_irq(substream);
3144 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3145 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3146 if (put_user(sstatus.state, &src->s.status.state) ||
3147 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
3148 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3149 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
3150 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
3151 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3152 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
3153 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3154 put_user(scontrol.avail_min, &src->c.control.avail_min))
3159 #define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
3161 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3163 struct snd_pcm_runtime *runtime = substream->runtime;
3166 if (get_user(arg, _arg))
3168 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3170 runtime->tstamp_type = arg;
3174 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3175 struct snd_xferi __user *_xferi)
3177 struct snd_xferi xferi;
3178 struct snd_pcm_runtime *runtime = substream->runtime;
3179 snd_pcm_sframes_t result;
3181 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3183 if (put_user(0, &_xferi->result))
3185 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3187 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3188 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3190 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
3191 if (put_user(result, &_xferi->result))
3193 return result < 0 ? result : 0;
3196 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3197 struct snd_xfern __user *_xfern)
3199 struct snd_xfern xfern;
3200 struct snd_pcm_runtime *runtime = substream->runtime;
3202 snd_pcm_sframes_t result;
3204 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3206 if (runtime->channels > 128)
3208 if (put_user(0, &_xfern->result))
3210 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3213 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3215 return PTR_ERR(bufs);
3216 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3217 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3219 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3221 if (put_user(result, &_xfern->result))
3223 return result < 0 ? result : 0;
3226 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3227 snd_pcm_uframes_t __user *_frames)
3229 snd_pcm_uframes_t frames;
3230 snd_pcm_sframes_t result;
3232 if (get_user(frames, _frames))
3234 if (put_user(0, _frames))
3236 result = snd_pcm_rewind(substream, frames);
3237 if (put_user(result, _frames))
3239 return result < 0 ? result : 0;
3242 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3243 snd_pcm_uframes_t __user *_frames)
3245 snd_pcm_uframes_t frames;
3246 snd_pcm_sframes_t result;
3248 if (get_user(frames, _frames))
3250 if (put_user(0, _frames))
3252 result = snd_pcm_forward(substream, frames);
3253 if (put_user(result, _frames))
3255 return result < 0 ? result : 0;
3258 static int snd_pcm_common_ioctl(struct file *file,
3259 struct snd_pcm_substream *substream,
3260 unsigned int cmd, void __user *arg)
3262 struct snd_pcm_file *pcm_file = file->private_data;
3265 if (PCM_RUNTIME_CHECK(substream))
3268 if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3271 res = snd_power_wait(substream->pcm->card);
3276 case SNDRV_PCM_IOCTL_PVERSION:
3277 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3278 case SNDRV_PCM_IOCTL_INFO:
3279 return snd_pcm_info_user(substream, arg);
3280 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3282 case SNDRV_PCM_IOCTL_TTSTAMP:
3283 return snd_pcm_tstamp(substream, arg);
3284 case SNDRV_PCM_IOCTL_USER_PVERSION:
3285 if (get_user(pcm_file->user_pversion,
3286 (unsigned int __user *)arg))
3289 case SNDRV_PCM_IOCTL_HW_REFINE:
3290 return snd_pcm_hw_refine_user(substream, arg);
3291 case SNDRV_PCM_IOCTL_HW_PARAMS:
3292 return snd_pcm_hw_params_user(substream, arg);
3293 case SNDRV_PCM_IOCTL_HW_FREE:
3294 return snd_pcm_hw_free(substream);
3295 case SNDRV_PCM_IOCTL_SW_PARAMS:
3296 return snd_pcm_sw_params_user(substream, arg);
3297 case SNDRV_PCM_IOCTL_STATUS32:
3298 return snd_pcm_status_user32(substream, arg, false);
3299 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3300 return snd_pcm_status_user32(substream, arg, true);
3301 case SNDRV_PCM_IOCTL_STATUS64:
3302 return snd_pcm_status_user64(substream, arg, false);
3303 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3304 return snd_pcm_status_user64(substream, arg, true);
3305 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3306 return snd_pcm_channel_info_user(substream, arg);
3307 case SNDRV_PCM_IOCTL_PREPARE:
3308 return snd_pcm_prepare(substream, file);
3309 case SNDRV_PCM_IOCTL_RESET:
3310 return snd_pcm_reset(substream);
3311 case SNDRV_PCM_IOCTL_START:
3312 return snd_pcm_start_lock_irq(substream);
3313 case SNDRV_PCM_IOCTL_LINK:
3314 return snd_pcm_link(substream, (int)(unsigned long) arg);
3315 case SNDRV_PCM_IOCTL_UNLINK:
3316 return snd_pcm_unlink(substream);
3317 case SNDRV_PCM_IOCTL_RESUME:
3318 return snd_pcm_resume(substream);
3319 case SNDRV_PCM_IOCTL_XRUN:
3320 return snd_pcm_xrun(substream);
3321 case SNDRV_PCM_IOCTL_HWSYNC:
3322 return snd_pcm_hwsync(substream);
3323 case SNDRV_PCM_IOCTL_DELAY:
3325 snd_pcm_sframes_t delay = 0;
3326 snd_pcm_sframes_t __user *res = arg;
3329 err = snd_pcm_delay(substream, &delay);
3332 if (put_user(delay, res))
3336 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3337 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3338 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
3339 return snd_pcm_sync_ptr(substream, arg);
3340 #ifdef CONFIG_SND_SUPPORT_OLD_API
3341 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3342 return snd_pcm_hw_refine_old_user(substream, arg);
3343 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3344 return snd_pcm_hw_params_old_user(substream, arg);
3346 case SNDRV_PCM_IOCTL_DRAIN:
3347 return snd_pcm_drain(substream, file);
3348 case SNDRV_PCM_IOCTL_DROP:
3349 return snd_pcm_drop(substream);
3350 case SNDRV_PCM_IOCTL_PAUSE:
3351 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
3352 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3353 case SNDRV_PCM_IOCTL_READI_FRAMES:
3354 return snd_pcm_xferi_frames_ioctl(substream, arg);
3355 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3356 case SNDRV_PCM_IOCTL_READN_FRAMES:
3357 return snd_pcm_xfern_frames_ioctl(substream, arg);
3358 case SNDRV_PCM_IOCTL_REWIND:
3359 return snd_pcm_rewind_ioctl(substream, arg);
3360 case SNDRV_PCM_IOCTL_FORWARD:
3361 return snd_pcm_forward_ioctl(substream, arg);
3363 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3367 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3370 struct snd_pcm_file *pcm_file;
3372 pcm_file = file->private_data;
3374 if (((cmd >> 8) & 0xff) != 'A')
3377 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3378 (void __user *)arg);
3382 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3383 * @substream: PCM substream
3385 * @arg: IOCTL argument
3387 * The function is provided primarily for OSS layer and USB gadget drivers,
3388 * and it allows only the limited set of ioctls (hw_params, sw_params,
3389 * prepare, start, drain, drop, forward).
3391 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3392 unsigned int cmd, void *arg)
3394 snd_pcm_uframes_t *frames = arg;
3395 snd_pcm_sframes_t result;
3397 if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3401 case SNDRV_PCM_IOCTL_FORWARD:
3403 /* provided only for OSS; capture-only and no value returned */
3404 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3406 result = snd_pcm_forward(substream, *frames);
3407 return result < 0 ? result : 0;
3409 case SNDRV_PCM_IOCTL_HW_PARAMS:
3410 return snd_pcm_hw_params(substream, arg);
3411 case SNDRV_PCM_IOCTL_SW_PARAMS:
3412 return snd_pcm_sw_params(substream, arg);
3413 case SNDRV_PCM_IOCTL_PREPARE:
3414 return snd_pcm_prepare(substream, NULL);
3415 case SNDRV_PCM_IOCTL_START:
3416 return snd_pcm_start_lock_irq(substream);
3417 case SNDRV_PCM_IOCTL_DRAIN:
3418 return snd_pcm_drain(substream, NULL);
3419 case SNDRV_PCM_IOCTL_DROP:
3420 return snd_pcm_drop(substream);
3421 case SNDRV_PCM_IOCTL_DELAY:
3422 return snd_pcm_delay(substream, frames);
3427 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3429 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3432 struct snd_pcm_file *pcm_file;
3433 struct snd_pcm_substream *substream;
3434 struct snd_pcm_runtime *runtime;
3435 snd_pcm_sframes_t result;
3437 pcm_file = file->private_data;
3438 substream = pcm_file->substream;
3439 if (PCM_RUNTIME_CHECK(substream))
3441 runtime = substream->runtime;
3442 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3443 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3445 if (!frame_aligned(runtime, count))
3447 count = bytes_to_frames(runtime, count);
3448 result = snd_pcm_lib_read(substream, buf, count);
3450 result = frames_to_bytes(runtime, result);
3454 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3455 size_t count, loff_t * offset)
3457 struct snd_pcm_file *pcm_file;
3458 struct snd_pcm_substream *substream;
3459 struct snd_pcm_runtime *runtime;
3460 snd_pcm_sframes_t result;
3462 pcm_file = file->private_data;
3463 substream = pcm_file->substream;
3464 if (PCM_RUNTIME_CHECK(substream))
3466 runtime = substream->runtime;
3467 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3468 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3470 if (!frame_aligned(runtime, count))
3472 count = bytes_to_frames(runtime, count);
3473 result = snd_pcm_lib_write(substream, buf, count);
3475 result = frames_to_bytes(runtime, result);
3479 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3481 struct snd_pcm_file *pcm_file;
3482 struct snd_pcm_substream *substream;
3483 struct snd_pcm_runtime *runtime;
3484 snd_pcm_sframes_t result;
3487 snd_pcm_uframes_t frames;
3489 pcm_file = iocb->ki_filp->private_data;
3490 substream = pcm_file->substream;
3491 if (PCM_RUNTIME_CHECK(substream))
3493 runtime = substream->runtime;
3494 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3495 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3497 if (!iter_is_iovec(to))
3499 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3501 if (!frame_aligned(runtime, to->iov->iov_len))
3503 frames = bytes_to_samples(runtime, to->iov->iov_len);
3504 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3507 for (i = 0; i < to->nr_segs; ++i)
3508 bufs[i] = to->iov[i].iov_base;
3509 result = snd_pcm_lib_readv(substream, bufs, frames);
3511 result = frames_to_bytes(runtime, result);
3516 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3518 struct snd_pcm_file *pcm_file;
3519 struct snd_pcm_substream *substream;
3520 struct snd_pcm_runtime *runtime;
3521 snd_pcm_sframes_t result;
3524 snd_pcm_uframes_t frames;
3526 pcm_file = iocb->ki_filp->private_data;
3527 substream = pcm_file->substream;
3528 if (PCM_RUNTIME_CHECK(substream))
3530 runtime = substream->runtime;
3531 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3532 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3534 if (!iter_is_iovec(from))
3536 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3537 !frame_aligned(runtime, from->iov->iov_len))
3539 frames = bytes_to_samples(runtime, from->iov->iov_len);
3540 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3543 for (i = 0; i < from->nr_segs; ++i)
3544 bufs[i] = from->iov[i].iov_base;
3545 result = snd_pcm_lib_writev(substream, bufs, frames);
3547 result = frames_to_bytes(runtime, result);
3552 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3554 struct snd_pcm_file *pcm_file;
3555 struct snd_pcm_substream *substream;
3556 struct snd_pcm_runtime *runtime;
3558 snd_pcm_uframes_t avail;
3560 pcm_file = file->private_data;
3562 substream = pcm_file->substream;
3563 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3564 ok = EPOLLOUT | EPOLLWRNORM;
3566 ok = EPOLLIN | EPOLLRDNORM;
3567 if (PCM_RUNTIME_CHECK(substream))
3568 return ok | EPOLLERR;
3570 runtime = substream->runtime;
3571 if (runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3572 return ok | EPOLLERR;
3574 poll_wait(file, &runtime->sleep, wait);
3577 snd_pcm_stream_lock_irq(substream);
3578 avail = snd_pcm_avail(substream);
3579 switch (runtime->status->state) {
3580 case SNDRV_PCM_STATE_RUNNING:
3581 case SNDRV_PCM_STATE_PREPARED:
3582 case SNDRV_PCM_STATE_PAUSED:
3583 if (avail >= runtime->control->avail_min)
3586 case SNDRV_PCM_STATE_DRAINING:
3587 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3594 mask = ok | EPOLLERR;
3597 snd_pcm_stream_unlock_irq(substream);
3606 * Only on coherent architectures, we can mmap the status and the control records
3607 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3609 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3611 * mmap status record
3613 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3615 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3616 struct snd_pcm_runtime *runtime;
3618 if (substream == NULL)
3619 return VM_FAULT_SIGBUS;
3620 runtime = substream->runtime;
3621 vmf->page = virt_to_page(runtime->status);
3622 get_page(vmf->page);
3626 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3628 .fault = snd_pcm_mmap_status_fault,
3631 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3632 struct vm_area_struct *area)
3635 if (!(area->vm_flags & VM_READ))
3637 size = area->vm_end - area->vm_start;
3638 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3640 area->vm_ops = &snd_pcm_vm_ops_status;
3641 area->vm_private_data = substream;
3642 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3647 * mmap control record
3649 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3651 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3652 struct snd_pcm_runtime *runtime;
3654 if (substream == NULL)
3655 return VM_FAULT_SIGBUS;
3656 runtime = substream->runtime;
3657 vmf->page = virt_to_page(runtime->control);
3658 get_page(vmf->page);
3662 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3664 .fault = snd_pcm_mmap_control_fault,
3667 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3668 struct vm_area_struct *area)
3671 if (!(area->vm_flags & VM_READ))
3673 size = area->vm_end - area->vm_start;
3674 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3676 area->vm_ops = &snd_pcm_vm_ops_control;
3677 area->vm_private_data = substream;
3678 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3682 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3684 /* If drivers require the explicit sync (typically for non-coherent
3685 * pages), we have to disable the mmap of status and control data
3686 * to enforce the control via SYNC_PTR ioctl.
3688 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3690 /* See pcm_control_mmap_allowed() below.
3691 * Since older alsa-lib requires both status and control mmaps to be
3692 * coupled, we have to disable the status mmap for old alsa-lib, too.
3694 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3695 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3700 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3702 if (pcm_file->no_compat_mmap)
3705 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3707 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3708 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3709 * thus it effectively assures the manual update of appl_ptr.
3711 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3716 #else /* ! coherent mmap */
3718 * don't support mmap for status and control records.
3720 #define pcm_status_mmap_allowed(pcm_file) false
3721 #define pcm_control_mmap_allowed(pcm_file) false
3723 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3724 struct vm_area_struct *area)
3728 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3729 struct vm_area_struct *area)
3733 #endif /* coherent mmap */
3736 * fault callback for mmapping a RAM page
3738 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3740 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3741 struct snd_pcm_runtime *runtime;
3742 unsigned long offset;
3746 if (substream == NULL)
3747 return VM_FAULT_SIGBUS;
3748 runtime = substream->runtime;
3749 offset = vmf->pgoff << PAGE_SHIFT;
3750 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3751 if (offset > dma_bytes - PAGE_SIZE)
3752 return VM_FAULT_SIGBUS;
3753 if (substream->ops->page)
3754 page = substream->ops->page(substream, offset);
3755 else if (!snd_pcm_get_dma_buf(substream))
3756 page = virt_to_page(runtime->dma_area + offset);
3758 page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
3760 return VM_FAULT_SIGBUS;
3766 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3767 .open = snd_pcm_mmap_data_open,
3768 .close = snd_pcm_mmap_data_close,
3771 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3772 .open = snd_pcm_mmap_data_open,
3773 .close = snd_pcm_mmap_data_close,
3774 .fault = snd_pcm_mmap_data_fault,
3778 * mmap the DMA buffer on RAM
3782 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3783 * @substream: PCM substream
3786 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3787 * this function is invoked implicitly.
3789 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3790 struct vm_area_struct *area)
3792 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3793 if (!substream->ops->page &&
3794 !snd_dma_buffer_mmap(snd_pcm_get_dma_buf(substream), area))
3796 /* mmap with fault handler */
3797 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3800 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3803 * mmap the DMA buffer on I/O memory area
3805 #if SNDRV_PCM_INFO_MMAP_IOMEM
3807 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3808 * @substream: PCM substream
3811 * When your hardware uses the iomapped pages as the hardware buffer and
3812 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3813 * is supposed to work only on limited architectures.
3815 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3816 struct vm_area_struct *area)
3818 struct snd_pcm_runtime *runtime = substream->runtime;
3820 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3821 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3823 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3824 #endif /* SNDRV_PCM_INFO_MMAP */
3829 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3830 struct vm_area_struct *area)
3832 struct snd_pcm_runtime *runtime;
3834 unsigned long offset;
3838 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3839 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3842 if (!(area->vm_flags & VM_READ))
3845 runtime = substream->runtime;
3846 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3848 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3850 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3851 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3853 size = area->vm_end - area->vm_start;
3854 offset = area->vm_pgoff << PAGE_SHIFT;
3855 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3856 if ((size_t)size > dma_bytes)
3858 if (offset > dma_bytes - size)
3861 area->vm_ops = &snd_pcm_vm_ops_data;
3862 area->vm_private_data = substream;
3863 if (substream->ops->mmap)
3864 err = substream->ops->mmap(substream, area);
3866 err = snd_pcm_lib_default_mmap(substream, area);
3868 atomic_inc(&substream->mmap_count);
3871 EXPORT_SYMBOL(snd_pcm_mmap_data);
3873 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3875 struct snd_pcm_file * pcm_file;
3876 struct snd_pcm_substream *substream;
3877 unsigned long offset;
3879 pcm_file = file->private_data;
3880 substream = pcm_file->substream;
3881 if (PCM_RUNTIME_CHECK(substream))
3883 if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3886 offset = area->vm_pgoff << PAGE_SHIFT;
3888 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3889 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3892 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
3893 if (!pcm_status_mmap_allowed(pcm_file))
3895 return snd_pcm_mmap_status(substream, file, area);
3896 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3897 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3900 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
3901 if (!pcm_control_mmap_allowed(pcm_file))
3903 return snd_pcm_mmap_control(substream, file, area);
3905 return snd_pcm_mmap_data(substream, file, area);
3910 static int snd_pcm_fasync(int fd, struct file * file, int on)
3912 struct snd_pcm_file * pcm_file;
3913 struct snd_pcm_substream *substream;
3914 struct snd_pcm_runtime *runtime;
3916 pcm_file = file->private_data;
3917 substream = pcm_file->substream;
3918 if (PCM_RUNTIME_CHECK(substream))
3920 runtime = substream->runtime;
3921 if (runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3923 return fasync_helper(fd, file, on, &runtime->fasync);
3929 #ifdef CONFIG_COMPAT
3930 #include "pcm_compat.c"
3932 #define snd_pcm_ioctl_compat NULL
3936 * To be removed helpers to keep binary compatibility
3939 #ifdef CONFIG_SND_SUPPORT_OLD_API
3940 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3941 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3943 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3944 struct snd_pcm_hw_params_old *oparams)
3948 memset(params, 0, sizeof(*params));
3949 params->flags = oparams->flags;
3950 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3951 params->masks[i].bits[0] = oparams->masks[i];
3952 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3953 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3954 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3955 params->info = oparams->info;
3956 params->msbits = oparams->msbits;
3957 params->rate_num = oparams->rate_num;
3958 params->rate_den = oparams->rate_den;
3959 params->fifo_size = oparams->fifo_size;
3962 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3963 struct snd_pcm_hw_params *params)
3967 memset(oparams, 0, sizeof(*oparams));
3968 oparams->flags = params->flags;
3969 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3970 oparams->masks[i] = params->masks[i].bits[0];
3971 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3972 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3973 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3974 oparams->info = params->info;
3975 oparams->msbits = params->msbits;
3976 oparams->rate_num = params->rate_num;
3977 oparams->rate_den = params->rate_den;
3978 oparams->fifo_size = params->fifo_size;
3981 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3982 struct snd_pcm_hw_params_old __user * _oparams)
3984 struct snd_pcm_hw_params *params;
3985 struct snd_pcm_hw_params_old *oparams = NULL;
3988 params = kmalloc(sizeof(*params), GFP_KERNEL);
3992 oparams = memdup_user(_oparams, sizeof(*oparams));
3993 if (IS_ERR(oparams)) {
3994 err = PTR_ERR(oparams);
3997 snd_pcm_hw_convert_from_old_params(params, oparams);
3998 err = snd_pcm_hw_refine(substream, params);
4002 err = fixup_unreferenced_params(substream, params);
4006 snd_pcm_hw_convert_to_old_params(oparams, params);
4007 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4016 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
4017 struct snd_pcm_hw_params_old __user * _oparams)
4019 struct snd_pcm_hw_params *params;
4020 struct snd_pcm_hw_params_old *oparams = NULL;
4023 params = kmalloc(sizeof(*params), GFP_KERNEL);
4027 oparams = memdup_user(_oparams, sizeof(*oparams));
4028 if (IS_ERR(oparams)) {
4029 err = PTR_ERR(oparams);
4033 snd_pcm_hw_convert_from_old_params(params, oparams);
4034 err = snd_pcm_hw_params(substream, params);
4038 snd_pcm_hw_convert_to_old_params(oparams, params);
4039 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4047 #endif /* CONFIG_SND_SUPPORT_OLD_API */
4050 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
4053 unsigned long pgoff,
4054 unsigned long flags)
4056 struct snd_pcm_file *pcm_file = file->private_data;
4057 struct snd_pcm_substream *substream = pcm_file->substream;
4058 struct snd_pcm_runtime *runtime = substream->runtime;
4059 unsigned long offset = pgoff << PAGE_SHIFT;
4062 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
4063 return (unsigned long)runtime->status;
4064 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
4065 return (unsigned long)runtime->control;
4067 return (unsigned long)runtime->dma_area + offset;
4071 # define snd_pcm_get_unmapped_area NULL
4078 const struct file_operations snd_pcm_f_ops[2] = {
4080 .owner = THIS_MODULE,
4081 .write = snd_pcm_write,
4082 .write_iter = snd_pcm_writev,
4083 .open = snd_pcm_playback_open,
4084 .release = snd_pcm_release,
4085 .llseek = no_llseek,
4086 .poll = snd_pcm_poll,
4087 .unlocked_ioctl = snd_pcm_ioctl,
4088 .compat_ioctl = snd_pcm_ioctl_compat,
4089 .mmap = snd_pcm_mmap,
4090 .fasync = snd_pcm_fasync,
4091 .get_unmapped_area = snd_pcm_get_unmapped_area,
4094 .owner = THIS_MODULE,
4095 .read = snd_pcm_read,
4096 .read_iter = snd_pcm_readv,
4097 .open = snd_pcm_capture_open,
4098 .release = snd_pcm_release,
4099 .llseek = no_llseek,
4100 .poll = snd_pcm_poll,
4101 .unlocked_ioctl = snd_pcm_ioctl,
4102 .compat_ioctl = snd_pcm_ioctl_compat,
4103 .mmap = snd_pcm_mmap,
4104 .fasync = snd_pcm_fasync,
4105 .get_unmapped_area = snd_pcm_get_unmapped_area,