1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
8 #include <linux/module.h>
9 #include <linux/file.h>
10 #include <linux/slab.h>
11 #include <linux/sched/signal.h>
12 #include <linux/time.h>
13 #include <linux/pm_qos.h>
15 #include <linux/dma-mapping.h>
16 #include <sound/core.h>
17 #include <sound/control.h>
18 #include <sound/info.h>
19 #include <sound/pcm.h>
20 #include <sound/pcm_params.h>
21 #include <sound/timer.h>
22 #include <sound/minors.h>
23 #include <linux/uio.h>
24 #include <linux/delay.h>
26 #include "pcm_local.h"
28 #ifdef CONFIG_SND_DEBUG
29 #define CREATE_TRACE_POINTS
30 #include "pcm_param_trace.h"
32 #define trace_hw_mask_param_enabled() 0
33 #define trace_hw_interval_param_enabled() 0
34 #define trace_hw_mask_param(substream, type, index, prev, curr)
35 #define trace_hw_interval_param(substream, type, index, prev, curr)
42 struct snd_pcm_hw_params_old {
44 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
45 SNDRV_PCM_HW_PARAM_ACCESS + 1];
46 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
47 SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
52 unsigned int rate_num;
53 unsigned int rate_den;
54 snd_pcm_uframes_t fifo_size;
55 unsigned char reserved[64];
58 #ifdef CONFIG_SND_SUPPORT_OLD_API
59 #define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
60 #define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
62 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
63 struct snd_pcm_hw_params_old __user * _oparams);
64 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params_old __user * _oparams);
67 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
73 static DECLARE_RWSEM(snd_pcm_link_rwsem);
75 void snd_pcm_group_init(struct snd_pcm_group *group)
77 spin_lock_init(&group->lock);
78 mutex_init(&group->mutex);
79 INIT_LIST_HEAD(&group->substreams);
80 refcount_set(&group->refs, 1);
83 /* define group lock helpers */
84 #define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
85 static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
88 mutex_ ## mutex_action(&group->mutex); \
90 spin_ ## action(&group->lock); \
93 DEFINE_PCM_GROUP_LOCK(lock, lock);
94 DEFINE_PCM_GROUP_LOCK(unlock, unlock);
95 DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
96 DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
99 * snd_pcm_stream_lock - Lock the PCM stream
100 * @substream: PCM substream
102 * This locks the PCM stream's spinlock or mutex depending on the nonatomic
103 * flag of the given substream. This also takes the global link rw lock
104 * (or rw sem), too, for avoiding the race with linked streams.
106 void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
108 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
110 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
113 * snd_pcm_stream_lock - Unlock the PCM stream
114 * @substream: PCM substream
116 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
118 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
120 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
122 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
125 * snd_pcm_stream_lock_irq - Lock the PCM stream
126 * @substream: PCM substream
128 * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
129 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
130 * as snd_pcm_stream_lock().
132 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
134 snd_pcm_group_lock_irq(&substream->self_group,
135 substream->pcm->nonatomic);
137 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
140 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
141 * @substream: PCM substream
143 * This is a counter-part of snd_pcm_stream_lock_irq().
145 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
147 snd_pcm_group_unlock_irq(&substream->self_group,
148 substream->pcm->nonatomic);
150 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
152 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
154 unsigned long flags = 0;
155 if (substream->pcm->nonatomic)
156 mutex_lock(&substream->self_group.mutex);
158 spin_lock_irqsave(&substream->self_group.lock, flags);
161 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
164 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
165 * @substream: PCM substream
168 * This is a counter-part of snd_pcm_stream_lock_irqsave().
170 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
173 if (substream->pcm->nonatomic)
174 mutex_unlock(&substream->self_group.mutex);
176 spin_unlock_irqrestore(&substream->self_group.lock, flags);
178 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
180 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
182 struct snd_pcm *pcm = substream->pcm;
183 struct snd_pcm_str *pstr = substream->pstr;
185 memset(info, 0, sizeof(*info));
186 info->card = pcm->card->number;
187 info->device = pcm->device;
188 info->stream = substream->stream;
189 info->subdevice = substream->number;
190 strlcpy(info->id, pcm->id, sizeof(info->id));
191 strlcpy(info->name, pcm->name, sizeof(info->name));
192 info->dev_class = pcm->dev_class;
193 info->dev_subclass = pcm->dev_subclass;
194 info->subdevices_count = pstr->substream_count;
195 info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
196 strlcpy(info->subname, substream->name, sizeof(info->subname));
201 int snd_pcm_info_user(struct snd_pcm_substream *substream,
202 struct snd_pcm_info __user * _info)
204 struct snd_pcm_info *info;
207 info = kmalloc(sizeof(*info), GFP_KERNEL);
210 err = snd_pcm_info(substream, info);
212 if (copy_to_user(_info, info, sizeof(*info)))
219 static bool hw_support_mmap(struct snd_pcm_substream *substream)
221 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
224 if (substream->ops->mmap ||
225 substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV)
228 return dma_can_mmap(substream->dma_buffer.dev.dev);
231 static int constrain_mask_params(struct snd_pcm_substream *substream,
232 struct snd_pcm_hw_params *params)
234 struct snd_pcm_hw_constraints *constrs =
235 &substream->runtime->hw_constraints;
238 struct snd_mask old_mask;
241 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
242 m = hw_param_mask(params, k);
243 if (snd_mask_empty(m))
246 /* This parameter is not requested to change by a caller. */
247 if (!(params->rmask & (1 << k)))
250 if (trace_hw_mask_param_enabled())
253 changed = snd_mask_refine(m, constrs_mask(constrs, k));
259 /* Set corresponding flag so that the caller gets it. */
260 trace_hw_mask_param(substream, k, 0, &old_mask, m);
261 params->cmask |= 1 << k;
267 static int constrain_interval_params(struct snd_pcm_substream *substream,
268 struct snd_pcm_hw_params *params)
270 struct snd_pcm_hw_constraints *constrs =
271 &substream->runtime->hw_constraints;
272 struct snd_interval *i;
274 struct snd_interval old_interval;
277 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
278 i = hw_param_interval(params, k);
279 if (snd_interval_empty(i))
282 /* This parameter is not requested to change by a caller. */
283 if (!(params->rmask & (1 << k)))
286 if (trace_hw_interval_param_enabled())
289 changed = snd_interval_refine(i, constrs_interval(constrs, k));
295 /* Set corresponding flag so that the caller gets it. */
296 trace_hw_interval_param(substream, k, 0, &old_interval, i);
297 params->cmask |= 1 << k;
303 static int constrain_params_by_rules(struct snd_pcm_substream *substream,
304 struct snd_pcm_hw_params *params)
306 struct snd_pcm_hw_constraints *constrs =
307 &substream->runtime->hw_constraints;
309 unsigned int *rstamps;
310 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
312 struct snd_pcm_hw_rule *r;
314 struct snd_mask old_mask;
315 struct snd_interval old_interval;
317 int changed, err = 0;
320 * Each application of rule has own sequence number.
322 * Each member of 'rstamps' array represents the sequence number of
323 * recent application of corresponding rule.
325 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
330 * Each member of 'vstamps' array represents the sequence number of
331 * recent application of rule in which corresponding parameters were
334 * In initial state, elements corresponding to parameters requested by
335 * a caller is 1. For unrequested parameters, corresponding members
336 * have 0 so that the parameters are never changed anymore.
338 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
339 vstamps[k] = (params->rmask & (1 << k)) ? 1 : 0;
341 /* Due to the above design, actual sequence number starts at 2. */
344 /* Apply all rules in order. */
346 for (k = 0; k < constrs->rules_num; k++) {
347 r = &constrs->rules[k];
350 * Check condition bits of this rule. When the rule has
351 * some condition bits, parameter without the bits is
352 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
353 * is an example of the condition bits.
355 if (r->cond && !(r->cond & params->flags))
359 * The 'deps' array includes maximum three dependencies
360 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fourth
361 * member of this array is a sentinel and should be
364 * This rule should be processed in this time when dependent
365 * parameters were changed at former applications of the other
368 for (d = 0; r->deps[d] >= 0; d++) {
369 if (vstamps[r->deps[d]] > rstamps[k])
375 if (trace_hw_mask_param_enabled()) {
376 if (hw_is_mask(r->var))
377 old_mask = *hw_param_mask(params, r->var);
379 if (trace_hw_interval_param_enabled()) {
380 if (hw_is_interval(r->var))
381 old_interval = *hw_param_interval(params, r->var);
384 changed = r->func(params, r);
391 * When the parameter is changed, notify it to the caller
392 * by corresponding returned bit, then preparing for next
395 if (changed && r->var >= 0) {
396 if (hw_is_mask(r->var)) {
397 trace_hw_mask_param(substream, r->var,
399 hw_param_mask(params, r->var));
401 if (hw_is_interval(r->var)) {
402 trace_hw_interval_param(substream, r->var,
403 k + 1, &old_interval,
404 hw_param_interval(params, r->var));
407 params->cmask |= (1 << r->var);
408 vstamps[r->var] = stamp;
412 rstamps[k] = stamp++;
415 /* Iterate to evaluate all rules till no parameters are changed. */
424 static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
425 struct snd_pcm_hw_params *params)
427 const struct snd_interval *i;
428 const struct snd_mask *m;
431 if (!params->msbits) {
432 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
433 if (snd_interval_single(i))
434 params->msbits = snd_interval_value(i);
437 if (!params->rate_den) {
438 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
439 if (snd_interval_single(i)) {
440 params->rate_num = snd_interval_value(i);
441 params->rate_den = 1;
445 if (!params->fifo_size) {
446 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
447 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
448 if (snd_mask_single(m) && snd_interval_single(i)) {
449 err = substream->ops->ioctl(substream,
450 SNDRV_PCM_IOCTL1_FIFO_SIZE, params);
457 params->info = substream->runtime->hw.info;
458 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
459 SNDRV_PCM_INFO_DRAIN_TRIGGER);
460 if (!hw_support_mmap(substream))
461 params->info &= ~(SNDRV_PCM_INFO_MMAP |
462 SNDRV_PCM_INFO_MMAP_VALID);
468 int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
469 struct snd_pcm_hw_params *params)
474 params->fifo_size = 0;
475 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
477 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_RATE)) {
478 params->rate_num = 0;
479 params->rate_den = 0;
482 err = constrain_mask_params(substream, params);
486 err = constrain_interval_params(substream, params);
490 err = constrain_params_by_rules(substream, params);
498 EXPORT_SYMBOL(snd_pcm_hw_refine);
500 static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
501 struct snd_pcm_hw_params __user * _params)
503 struct snd_pcm_hw_params *params;
506 params = memdup_user(_params, sizeof(*params));
508 return PTR_ERR(params);
510 err = snd_pcm_hw_refine(substream, params);
514 err = fixup_unreferenced_params(substream, params);
518 if (copy_to_user(_params, params, sizeof(*params)))
525 static int period_to_usecs(struct snd_pcm_runtime *runtime)
530 return -1; /* invalid */
532 /* take 75% of period time as the deadline */
533 usecs = (750000 / runtime->rate) * runtime->period_size;
534 usecs += ((750000 % runtime->rate) * runtime->period_size) /
540 static void snd_pcm_set_state(struct snd_pcm_substream *substream, int state)
542 snd_pcm_stream_lock_irq(substream);
543 if (substream->runtime->status->state != SNDRV_PCM_STATE_DISCONNECTED)
544 substream->runtime->status->state = state;
545 snd_pcm_stream_unlock_irq(substream);
548 static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
551 #ifdef CONFIG_SND_PCM_TIMER
552 if (substream->timer)
553 snd_timer_notify(substream->timer, event,
554 &substream->runtime->trigger_tstamp);
559 * snd_pcm_hw_param_choose - choose a configuration defined by @params
561 * @params: the hw_params instance
563 * Choose one configuration from configuration space defined by @params.
564 * The configuration chosen is that obtained fixing in this order:
565 * first access, first format, first subformat, min channels,
566 * min rate, min period time, max buffer size, min tick time
568 * Return: Zero if successful, or a negative error code on failure.
570 static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
571 struct snd_pcm_hw_params *params)
573 static const int vars[] = {
574 SNDRV_PCM_HW_PARAM_ACCESS,
575 SNDRV_PCM_HW_PARAM_FORMAT,
576 SNDRV_PCM_HW_PARAM_SUBFORMAT,
577 SNDRV_PCM_HW_PARAM_CHANNELS,
578 SNDRV_PCM_HW_PARAM_RATE,
579 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
580 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
581 SNDRV_PCM_HW_PARAM_TICK_TIME,
585 struct snd_mask old_mask;
586 struct snd_interval old_interval;
589 for (v = vars; *v != -1; v++) {
590 /* Keep old parameter to trace. */
591 if (trace_hw_mask_param_enabled()) {
593 old_mask = *hw_param_mask(params, *v);
595 if (trace_hw_interval_param_enabled()) {
596 if (hw_is_interval(*v))
597 old_interval = *hw_param_interval(params, *v);
599 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
600 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
602 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
608 /* Trace the changed parameter. */
609 if (hw_is_mask(*v)) {
610 trace_hw_mask_param(pcm, *v, 0, &old_mask,
611 hw_param_mask(params, *v));
613 if (hw_is_interval(*v)) {
614 trace_hw_interval_param(pcm, *v, 0, &old_interval,
615 hw_param_interval(params, *v));
622 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
623 struct snd_pcm_hw_params *params)
625 struct snd_pcm_runtime *runtime;
628 snd_pcm_uframes_t frames;
630 if (PCM_RUNTIME_CHECK(substream))
632 runtime = substream->runtime;
633 snd_pcm_stream_lock_irq(substream);
634 switch (runtime->status->state) {
635 case SNDRV_PCM_STATE_OPEN:
636 case SNDRV_PCM_STATE_SETUP:
637 case SNDRV_PCM_STATE_PREPARED:
640 snd_pcm_stream_unlock_irq(substream);
643 snd_pcm_stream_unlock_irq(substream);
644 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
645 if (!substream->oss.oss)
647 if (atomic_read(&substream->mmap_count))
651 err = snd_pcm_hw_refine(substream, params);
655 err = snd_pcm_hw_params_choose(substream, params);
659 err = fixup_unreferenced_params(substream, params);
663 if (substream->ops->hw_params != NULL) {
664 err = substream->ops->hw_params(substream, params);
669 runtime->access = params_access(params);
670 runtime->format = params_format(params);
671 runtime->subformat = params_subformat(params);
672 runtime->channels = params_channels(params);
673 runtime->rate = params_rate(params);
674 runtime->period_size = params_period_size(params);
675 runtime->periods = params_periods(params);
676 runtime->buffer_size = params_buffer_size(params);
677 runtime->info = params->info;
678 runtime->rate_num = params->rate_num;
679 runtime->rate_den = params->rate_den;
680 runtime->no_period_wakeup =
681 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
682 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
684 bits = snd_pcm_format_physical_width(runtime->format);
685 runtime->sample_bits = bits;
686 bits *= runtime->channels;
687 runtime->frame_bits = bits;
689 while (bits % 8 != 0) {
693 runtime->byte_align = bits / 8;
694 runtime->min_align = frames;
696 /* Default sw params */
697 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
698 runtime->period_step = 1;
699 runtime->control->avail_min = runtime->period_size;
700 runtime->start_threshold = 1;
701 runtime->stop_threshold = runtime->buffer_size;
702 runtime->silence_threshold = 0;
703 runtime->silence_size = 0;
704 runtime->boundary = runtime->buffer_size;
705 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
706 runtime->boundary *= 2;
708 snd_pcm_timer_resolution_change(substream);
709 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
711 if (pm_qos_request_active(&substream->latency_pm_qos_req))
712 pm_qos_remove_request(&substream->latency_pm_qos_req);
713 if ((usecs = period_to_usecs(runtime)) >= 0)
714 pm_qos_add_request(&substream->latency_pm_qos_req,
715 PM_QOS_CPU_DMA_LATENCY, usecs);
718 /* hardware might be unusable from this time,
719 so we force application to retry to set
720 the correct hardware parameter settings */
721 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
722 if (substream->ops->hw_free != NULL)
723 substream->ops->hw_free(substream);
727 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
728 struct snd_pcm_hw_params __user * _params)
730 struct snd_pcm_hw_params *params;
733 params = memdup_user(_params, sizeof(*params));
735 return PTR_ERR(params);
737 err = snd_pcm_hw_params(substream, params);
741 if (copy_to_user(_params, params, sizeof(*params)))
748 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
750 struct snd_pcm_runtime *runtime;
753 if (PCM_RUNTIME_CHECK(substream))
755 runtime = substream->runtime;
756 snd_pcm_stream_lock_irq(substream);
757 switch (runtime->status->state) {
758 case SNDRV_PCM_STATE_SETUP:
759 case SNDRV_PCM_STATE_PREPARED:
762 snd_pcm_stream_unlock_irq(substream);
765 snd_pcm_stream_unlock_irq(substream);
766 if (atomic_read(&substream->mmap_count))
768 if (substream->ops->hw_free)
769 result = substream->ops->hw_free(substream);
770 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
771 pm_qos_remove_request(&substream->latency_pm_qos_req);
775 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
776 struct snd_pcm_sw_params *params)
778 struct snd_pcm_runtime *runtime;
781 if (PCM_RUNTIME_CHECK(substream))
783 runtime = substream->runtime;
784 snd_pcm_stream_lock_irq(substream);
785 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
786 snd_pcm_stream_unlock_irq(substream);
789 snd_pcm_stream_unlock_irq(substream);
791 if (params->tstamp_mode < 0 ||
792 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
794 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
795 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
797 if (params->avail_min == 0)
799 if (params->silence_size >= runtime->boundary) {
800 if (params->silence_threshold != 0)
803 if (params->silence_size > params->silence_threshold)
805 if (params->silence_threshold > runtime->buffer_size)
809 snd_pcm_stream_lock_irq(substream);
810 runtime->tstamp_mode = params->tstamp_mode;
811 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
812 runtime->tstamp_type = params->tstamp_type;
813 runtime->period_step = params->period_step;
814 runtime->control->avail_min = params->avail_min;
815 runtime->start_threshold = params->start_threshold;
816 runtime->stop_threshold = params->stop_threshold;
817 runtime->silence_threshold = params->silence_threshold;
818 runtime->silence_size = params->silence_size;
819 params->boundary = runtime->boundary;
820 if (snd_pcm_running(substream)) {
821 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
822 runtime->silence_size > 0)
823 snd_pcm_playback_silence(substream, ULONG_MAX);
824 err = snd_pcm_update_state(substream, runtime);
826 snd_pcm_stream_unlock_irq(substream);
830 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
831 struct snd_pcm_sw_params __user * _params)
833 struct snd_pcm_sw_params params;
835 if (copy_from_user(¶ms, _params, sizeof(params)))
837 err = snd_pcm_sw_params(substream, ¶ms);
838 if (copy_to_user(_params, ¶ms, sizeof(params)))
843 static inline snd_pcm_uframes_t
844 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
846 snd_pcm_uframes_t delay;
848 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
849 delay = snd_pcm_playback_hw_avail(substream->runtime);
851 delay = snd_pcm_capture_avail(substream->runtime);
852 return delay + substream->runtime->delay;
855 int snd_pcm_status(struct snd_pcm_substream *substream,
856 struct snd_pcm_status *status)
858 struct snd_pcm_runtime *runtime = substream->runtime;
860 snd_pcm_stream_lock_irq(substream);
862 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
863 &runtime->audio_tstamp_config);
865 /* backwards compatible behavior */
866 if (runtime->audio_tstamp_config.type_requested ==
867 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
868 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
869 runtime->audio_tstamp_config.type_requested =
870 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
872 runtime->audio_tstamp_config.type_requested =
873 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
874 runtime->audio_tstamp_report.valid = 0;
876 runtime->audio_tstamp_report.valid = 1;
878 status->state = runtime->status->state;
879 status->suspended_state = runtime->status->suspended_state;
880 if (status->state == SNDRV_PCM_STATE_OPEN)
882 status->trigger_tstamp = runtime->trigger_tstamp;
883 if (snd_pcm_running(substream)) {
884 snd_pcm_update_hw_ptr(substream);
885 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
886 status->tstamp = runtime->status->tstamp;
887 status->driver_tstamp = runtime->driver_tstamp;
888 status->audio_tstamp =
889 runtime->status->audio_tstamp;
890 if (runtime->audio_tstamp_report.valid == 1)
891 /* backwards compatibility, no report provided in COMPAT mode */
892 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
893 &status->audio_tstamp_accuracy,
894 &runtime->audio_tstamp_report);
899 /* get tstamp only in fallback mode and only if enabled */
900 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
901 snd_pcm_gettime(runtime, &status->tstamp);
904 status->appl_ptr = runtime->control->appl_ptr;
905 status->hw_ptr = runtime->status->hw_ptr;
906 status->avail = snd_pcm_avail(substream);
907 status->delay = snd_pcm_running(substream) ?
908 snd_pcm_calc_delay(substream) : 0;
909 status->avail_max = runtime->avail_max;
910 status->overrange = runtime->overrange;
911 runtime->avail_max = 0;
912 runtime->overrange = 0;
914 snd_pcm_stream_unlock_irq(substream);
918 static int snd_pcm_status_user(struct snd_pcm_substream *substream,
919 struct snd_pcm_status __user * _status,
922 struct snd_pcm_status status;
925 memset(&status, 0, sizeof(status));
927 * with extension, parameters are read/write,
928 * get audio_tstamp_data from user,
929 * ignore rest of status structure
931 if (ext && get_user(status.audio_tstamp_data,
932 (u32 __user *)(&_status->audio_tstamp_data)))
934 res = snd_pcm_status(substream, &status);
937 if (copy_to_user(_status, &status, sizeof(status)))
942 static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
943 struct snd_pcm_channel_info * info)
945 struct snd_pcm_runtime *runtime;
946 unsigned int channel;
948 channel = info->channel;
949 runtime = substream->runtime;
950 snd_pcm_stream_lock_irq(substream);
951 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
952 snd_pcm_stream_unlock_irq(substream);
955 snd_pcm_stream_unlock_irq(substream);
956 if (channel >= runtime->channels)
958 memset(info, 0, sizeof(*info));
959 info->channel = channel;
960 return substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
963 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
964 struct snd_pcm_channel_info __user * _info)
966 struct snd_pcm_channel_info info;
969 if (copy_from_user(&info, _info, sizeof(info)))
971 res = snd_pcm_channel_info(substream, &info);
974 if (copy_to_user(_info, &info, sizeof(info)))
979 static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
981 struct snd_pcm_runtime *runtime = substream->runtime;
982 if (runtime->trigger_master == NULL)
984 if (runtime->trigger_master == substream) {
985 if (!runtime->trigger_tstamp_latched)
986 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
988 snd_pcm_trigger_tstamp(runtime->trigger_master);
989 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
991 runtime->trigger_master = NULL;
995 int (*pre_action)(struct snd_pcm_substream *substream, int state);
996 int (*do_action)(struct snd_pcm_substream *substream, int state);
997 void (*undo_action)(struct snd_pcm_substream *substream, int state);
998 void (*post_action)(struct snd_pcm_substream *substream, int state);
1002 * this functions is core for handling of linked stream
1003 * Note: the stream state might be changed also on failure
1004 * Note2: call with calling stream lock + link lock
1006 static int snd_pcm_action_group(const struct action_ops *ops,
1007 struct snd_pcm_substream *substream,
1008 int state, int do_lock)
1010 struct snd_pcm_substream *s = NULL;
1011 struct snd_pcm_substream *s1;
1012 int res = 0, depth = 1;
1014 snd_pcm_group_for_each_entry(s, substream) {
1015 if (do_lock && s != substream) {
1016 if (s->pcm->nonatomic)
1017 mutex_lock_nested(&s->self_group.mutex, depth);
1019 spin_lock_nested(&s->self_group.lock, depth);
1022 res = ops->pre_action(s, state);
1026 snd_pcm_group_for_each_entry(s, substream) {
1027 res = ops->do_action(s, state);
1029 if (ops->undo_action) {
1030 snd_pcm_group_for_each_entry(s1, substream) {
1031 if (s1 == s) /* failed stream */
1033 ops->undo_action(s1, state);
1036 s = NULL; /* unlock all */
1040 snd_pcm_group_for_each_entry(s, substream) {
1041 ops->post_action(s, state);
1045 /* unlock streams */
1046 snd_pcm_group_for_each_entry(s1, substream) {
1047 if (s1 != substream) {
1048 if (s1->pcm->nonatomic)
1049 mutex_unlock(&s1->self_group.mutex);
1051 spin_unlock(&s1->self_group.lock);
1053 if (s1 == s) /* end */
1061 * Note: call with stream lock
1063 static int snd_pcm_action_single(const struct action_ops *ops,
1064 struct snd_pcm_substream *substream,
1069 res = ops->pre_action(substream, state);
1072 res = ops->do_action(substream, state);
1074 ops->post_action(substream, state);
1075 else if (ops->undo_action)
1076 ops->undo_action(substream, state);
1080 static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1081 struct snd_pcm_group *new_group)
1083 substream->group = new_group;
1084 list_move(&substream->link_list, &new_group->substreams);
1088 * Unref and unlock the group, but keep the stream lock;
1089 * when the group becomes empty and no longer referred, destroy itself
1091 static void snd_pcm_group_unref(struct snd_pcm_group *group,
1092 struct snd_pcm_substream *substream)
1098 do_free = refcount_dec_and_test(&group->refs);
1099 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1105 * Lock the group inside a stream lock and reference it;
1106 * return the locked group object, or NULL if not linked
1108 static struct snd_pcm_group *
1109 snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1111 bool nonatomic = substream->pcm->nonatomic;
1112 struct snd_pcm_group *group;
1116 if (!snd_pcm_stream_linked(substream))
1118 group = substream->group;
1119 /* block freeing the group object */
1120 refcount_inc(&group->refs);
1122 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1123 spin_trylock(&group->lock);
1127 /* re-lock for avoiding ABBA deadlock */
1128 snd_pcm_stream_unlock(substream);
1129 snd_pcm_group_lock(group, nonatomic);
1130 snd_pcm_stream_lock(substream);
1132 /* check the group again; the above opens a small race window */
1133 if (substream->group == group)
1135 /* group changed, try again */
1136 snd_pcm_group_unref(group, substream);
1142 * Note: call with stream lock
1144 static int snd_pcm_action(const struct action_ops *ops,
1145 struct snd_pcm_substream *substream,
1148 struct snd_pcm_group *group;
1151 group = snd_pcm_stream_group_ref(substream);
1153 res = snd_pcm_action_group(ops, substream, state, 1);
1155 res = snd_pcm_action_single(ops, substream, state);
1156 snd_pcm_group_unref(group, substream);
1161 * Note: don't use any locks before
1163 static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1164 struct snd_pcm_substream *substream,
1169 snd_pcm_stream_lock_irq(substream);
1170 res = snd_pcm_action(ops, substream, state);
1171 snd_pcm_stream_unlock_irq(substream);
1177 static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1178 struct snd_pcm_substream *substream,
1183 /* Guarantee the group members won't change during non-atomic action */
1184 down_read(&snd_pcm_link_rwsem);
1185 if (snd_pcm_stream_linked(substream))
1186 res = snd_pcm_action_group(ops, substream, state, 0);
1188 res = snd_pcm_action_single(ops, substream, state);
1189 up_read(&snd_pcm_link_rwsem);
1196 static int snd_pcm_pre_start(struct snd_pcm_substream *substream, int state)
1198 struct snd_pcm_runtime *runtime = substream->runtime;
1199 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1201 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1202 !snd_pcm_playback_data(substream))
1204 runtime->trigger_tstamp_latched = false;
1205 runtime->trigger_master = substream;
1209 static int snd_pcm_do_start(struct snd_pcm_substream *substream, int state)
1211 if (substream->runtime->trigger_master != substream)
1213 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1216 static void snd_pcm_undo_start(struct snd_pcm_substream *substream, int state)
1218 if (substream->runtime->trigger_master == substream)
1219 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1222 static void snd_pcm_post_start(struct snd_pcm_substream *substream, int state)
1224 struct snd_pcm_runtime *runtime = substream->runtime;
1225 snd_pcm_trigger_tstamp(substream);
1226 runtime->hw_ptr_jiffies = jiffies;
1227 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1229 runtime->status->state = state;
1230 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1231 runtime->silence_size > 0)
1232 snd_pcm_playback_silence(substream, ULONG_MAX);
1233 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1236 static const struct action_ops snd_pcm_action_start = {
1237 .pre_action = snd_pcm_pre_start,
1238 .do_action = snd_pcm_do_start,
1239 .undo_action = snd_pcm_undo_start,
1240 .post_action = snd_pcm_post_start
1244 * snd_pcm_start - start all linked streams
1245 * @substream: the PCM substream instance
1247 * Return: Zero if successful, or a negative error code.
1248 * The stream lock must be acquired before calling this function.
1250 int snd_pcm_start(struct snd_pcm_substream *substream)
1252 return snd_pcm_action(&snd_pcm_action_start, substream,
1253 SNDRV_PCM_STATE_RUNNING);
1256 /* take the stream lock and start the streams */
1257 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1259 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1260 SNDRV_PCM_STATE_RUNNING);
1266 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream, int state)
1268 struct snd_pcm_runtime *runtime = substream->runtime;
1269 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1271 runtime->trigger_master = substream;
1275 static int snd_pcm_do_stop(struct snd_pcm_substream *substream, int state)
1277 if (substream->runtime->trigger_master == substream &&
1278 snd_pcm_running(substream))
1279 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1280 return 0; /* unconditonally stop all substreams */
1283 static void snd_pcm_post_stop(struct snd_pcm_substream *substream, int state)
1285 struct snd_pcm_runtime *runtime = substream->runtime;
1286 if (runtime->status->state != state) {
1287 snd_pcm_trigger_tstamp(substream);
1288 runtime->status->state = state;
1289 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1291 wake_up(&runtime->sleep);
1292 wake_up(&runtime->tsleep);
1295 static const struct action_ops snd_pcm_action_stop = {
1296 .pre_action = snd_pcm_pre_stop,
1297 .do_action = snd_pcm_do_stop,
1298 .post_action = snd_pcm_post_stop
1302 * snd_pcm_stop - try to stop all running streams in the substream group
1303 * @substream: the PCM substream instance
1304 * @state: PCM state after stopping the stream
1306 * The state of each stream is then changed to the given state unconditionally.
1308 * Return: Zero if successful, or a negative error code.
1310 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1312 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1314 EXPORT_SYMBOL(snd_pcm_stop);
1317 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1318 * @substream: the PCM substream
1320 * After stopping, the state is changed to SETUP.
1321 * Unlike snd_pcm_stop(), this affects only the given stream.
1323 * Return: Zero if succesful, or a negative error code.
1325 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1327 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1328 SNDRV_PCM_STATE_SETUP);
1332 * snd_pcm_stop_xrun - stop the running streams as XRUN
1333 * @substream: the PCM substream instance
1335 * This stops the given running substream (and all linked substreams) as XRUN.
1336 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1338 * Return: Zero if successful, or a negative error code.
1340 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1342 unsigned long flags;
1344 snd_pcm_stream_lock_irqsave(substream, flags);
1345 if (substream->runtime && snd_pcm_running(substream))
1346 __snd_pcm_xrun(substream);
1347 snd_pcm_stream_unlock_irqrestore(substream, flags);
1350 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1355 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream, int push)
1357 struct snd_pcm_runtime *runtime = substream->runtime;
1358 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1361 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1363 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1365 runtime->trigger_master = substream;
1369 static int snd_pcm_do_pause(struct snd_pcm_substream *substream, int push)
1371 if (substream->runtime->trigger_master != substream)
1373 /* some drivers might use hw_ptr to recover from the pause -
1374 update the hw_ptr now */
1376 snd_pcm_update_hw_ptr(substream);
1377 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1378 * a delta between the current jiffies, this gives a large enough
1379 * delta, effectively to skip the check once.
1381 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1382 return substream->ops->trigger(substream,
1383 push ? SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1384 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1387 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream, int push)
1389 if (substream->runtime->trigger_master == substream)
1390 substream->ops->trigger(substream,
1391 push ? SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1392 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1395 static void snd_pcm_post_pause(struct snd_pcm_substream *substream, int push)
1397 struct snd_pcm_runtime *runtime = substream->runtime;
1398 snd_pcm_trigger_tstamp(substream);
1400 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
1401 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1402 wake_up(&runtime->sleep);
1403 wake_up(&runtime->tsleep);
1405 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
1406 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1410 static const struct action_ops snd_pcm_action_pause = {
1411 .pre_action = snd_pcm_pre_pause,
1412 .do_action = snd_pcm_do_pause,
1413 .undo_action = snd_pcm_undo_pause,
1414 .post_action = snd_pcm_post_pause
1418 * Push/release the pause for all linked streams.
1420 static int snd_pcm_pause(struct snd_pcm_substream *substream, int push)
1422 return snd_pcm_action(&snd_pcm_action_pause, substream, push);
1428 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream, int state)
1430 struct snd_pcm_runtime *runtime = substream->runtime;
1431 switch (runtime->status->state) {
1432 case SNDRV_PCM_STATE_SUSPENDED:
1434 /* unresumable PCM state; return -EBUSY for skipping suspend */
1435 case SNDRV_PCM_STATE_OPEN:
1436 case SNDRV_PCM_STATE_SETUP:
1437 case SNDRV_PCM_STATE_DISCONNECTED:
1440 runtime->trigger_master = substream;
1444 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream, int state)
1446 struct snd_pcm_runtime *runtime = substream->runtime;
1447 if (runtime->trigger_master != substream)
1449 if (! snd_pcm_running(substream))
1451 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1452 return 0; /* suspend unconditionally */
1455 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream, int state)
1457 struct snd_pcm_runtime *runtime = substream->runtime;
1458 snd_pcm_trigger_tstamp(substream);
1459 runtime->status->suspended_state = runtime->status->state;
1460 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
1461 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1462 wake_up(&runtime->sleep);
1463 wake_up(&runtime->tsleep);
1466 static const struct action_ops snd_pcm_action_suspend = {
1467 .pre_action = snd_pcm_pre_suspend,
1468 .do_action = snd_pcm_do_suspend,
1469 .post_action = snd_pcm_post_suspend
1473 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1474 * @substream: the PCM substream
1476 * After this call, all streams are changed to SUSPENDED state.
1478 * Return: Zero if successful, or a negative error code.
1480 static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1483 unsigned long flags;
1485 snd_pcm_stream_lock_irqsave(substream, flags);
1486 err = snd_pcm_action(&snd_pcm_action_suspend, substream, 0);
1487 snd_pcm_stream_unlock_irqrestore(substream, flags);
1492 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1493 * @pcm: the PCM instance
1495 * After this call, all streams are changed to SUSPENDED state.
1497 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1499 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1501 struct snd_pcm_substream *substream;
1502 int stream, err = 0;
1507 for (stream = 0; stream < 2; stream++) {
1508 for (substream = pcm->streams[stream].substream;
1509 substream; substream = substream->next) {
1510 /* FIXME: the open/close code should lock this as well */
1511 if (substream->runtime == NULL)
1515 * Skip BE dai link PCM's that are internal and may
1516 * not have their substream ops set.
1518 if (!substream->ops)
1521 err = snd_pcm_suspend(substream);
1522 if (err < 0 && err != -EBUSY)
1528 EXPORT_SYMBOL(snd_pcm_suspend_all);
1532 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream, int state)
1534 struct snd_pcm_runtime *runtime = substream->runtime;
1535 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1537 runtime->trigger_master = substream;
1541 static int snd_pcm_do_resume(struct snd_pcm_substream *substream, int state)
1543 struct snd_pcm_runtime *runtime = substream->runtime;
1544 if (runtime->trigger_master != substream)
1546 /* DMA not running previously? */
1547 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1548 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1549 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1551 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1554 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream, int state)
1556 if (substream->runtime->trigger_master == substream &&
1557 snd_pcm_running(substream))
1558 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1561 static void snd_pcm_post_resume(struct snd_pcm_substream *substream, int state)
1563 struct snd_pcm_runtime *runtime = substream->runtime;
1564 snd_pcm_trigger_tstamp(substream);
1565 runtime->status->state = runtime->status->suspended_state;
1566 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1569 static const struct action_ops snd_pcm_action_resume = {
1570 .pre_action = snd_pcm_pre_resume,
1571 .do_action = snd_pcm_do_resume,
1572 .undo_action = snd_pcm_undo_resume,
1573 .post_action = snd_pcm_post_resume
1576 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1578 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream, 0);
1583 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1588 #endif /* CONFIG_PM */
1593 * Change the RUNNING stream(s) to XRUN state.
1595 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1597 struct snd_pcm_runtime *runtime = substream->runtime;
1600 snd_pcm_stream_lock_irq(substream);
1601 switch (runtime->status->state) {
1602 case SNDRV_PCM_STATE_XRUN:
1603 result = 0; /* already there */
1605 case SNDRV_PCM_STATE_RUNNING:
1606 __snd_pcm_xrun(substream);
1612 snd_pcm_stream_unlock_irq(substream);
1619 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream, int state)
1621 struct snd_pcm_runtime *runtime = substream->runtime;
1622 switch (runtime->status->state) {
1623 case SNDRV_PCM_STATE_RUNNING:
1624 case SNDRV_PCM_STATE_PREPARED:
1625 case SNDRV_PCM_STATE_PAUSED:
1626 case SNDRV_PCM_STATE_SUSPENDED:
1633 static int snd_pcm_do_reset(struct snd_pcm_substream *substream, int state)
1635 struct snd_pcm_runtime *runtime = substream->runtime;
1636 int err = substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1639 runtime->hw_ptr_base = 0;
1640 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1641 runtime->status->hw_ptr % runtime->period_size;
1642 runtime->silence_start = runtime->status->hw_ptr;
1643 runtime->silence_filled = 0;
1647 static void snd_pcm_post_reset(struct snd_pcm_substream *substream, int state)
1649 struct snd_pcm_runtime *runtime = substream->runtime;
1650 runtime->control->appl_ptr = runtime->status->hw_ptr;
1651 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1652 runtime->silence_size > 0)
1653 snd_pcm_playback_silence(substream, ULONG_MAX);
1656 static const struct action_ops snd_pcm_action_reset = {
1657 .pre_action = snd_pcm_pre_reset,
1658 .do_action = snd_pcm_do_reset,
1659 .post_action = snd_pcm_post_reset
1662 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1664 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream, 0);
1670 /* we use the second argument for updating f_flags */
1671 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1674 struct snd_pcm_runtime *runtime = substream->runtime;
1675 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1676 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1678 if (snd_pcm_running(substream))
1680 substream->f_flags = f_flags;
1684 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream, int state)
1687 err = substream->ops->prepare(substream);
1690 return snd_pcm_do_reset(substream, 0);
1693 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream, int state)
1695 struct snd_pcm_runtime *runtime = substream->runtime;
1696 runtime->control->appl_ptr = runtime->status->hw_ptr;
1697 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1700 static const struct action_ops snd_pcm_action_prepare = {
1701 .pre_action = snd_pcm_pre_prepare,
1702 .do_action = snd_pcm_do_prepare,
1703 .post_action = snd_pcm_post_prepare
1707 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1708 * @substream: the PCM substream instance
1709 * @file: file to refer f_flags
1711 * Return: Zero if successful, or a negative error code.
1713 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1719 f_flags = file->f_flags;
1721 f_flags = substream->f_flags;
1723 snd_pcm_stream_lock_irq(substream);
1724 switch (substream->runtime->status->state) {
1725 case SNDRV_PCM_STATE_PAUSED:
1726 snd_pcm_pause(substream, 0);
1728 case SNDRV_PCM_STATE_SUSPENDED:
1729 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1732 snd_pcm_stream_unlock_irq(substream);
1734 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
1735 substream, f_flags);
1742 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream, int state)
1744 struct snd_pcm_runtime *runtime = substream->runtime;
1745 switch (runtime->status->state) {
1746 case SNDRV_PCM_STATE_OPEN:
1747 case SNDRV_PCM_STATE_DISCONNECTED:
1748 case SNDRV_PCM_STATE_SUSPENDED:
1751 runtime->trigger_master = substream;
1755 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream, int state)
1757 struct snd_pcm_runtime *runtime = substream->runtime;
1758 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1759 switch (runtime->status->state) {
1760 case SNDRV_PCM_STATE_PREPARED:
1761 /* start playback stream if possible */
1762 if (! snd_pcm_playback_empty(substream)) {
1763 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
1764 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
1766 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1769 case SNDRV_PCM_STATE_RUNNING:
1770 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
1772 case SNDRV_PCM_STATE_XRUN:
1773 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1779 /* stop running stream */
1780 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
1781 int new_state = snd_pcm_capture_avail(runtime) > 0 ?
1782 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
1783 snd_pcm_do_stop(substream, new_state);
1784 snd_pcm_post_stop(substream, new_state);
1788 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
1789 runtime->trigger_master == substream &&
1790 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
1791 return substream->ops->trigger(substream,
1792 SNDRV_PCM_TRIGGER_DRAIN);
1797 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream, int state)
1801 static const struct action_ops snd_pcm_action_drain_init = {
1802 .pre_action = snd_pcm_pre_drain_init,
1803 .do_action = snd_pcm_do_drain_init,
1804 .post_action = snd_pcm_post_drain_init
1808 * Drain the stream(s).
1809 * When the substream is linked, sync until the draining of all playback streams
1811 * After this call, all streams are supposed to be either SETUP or DRAINING
1812 * (capture only) state.
1814 static int snd_pcm_drain(struct snd_pcm_substream *substream,
1817 struct snd_card *card;
1818 struct snd_pcm_runtime *runtime;
1819 struct snd_pcm_substream *s;
1820 struct snd_pcm_group *group;
1821 wait_queue_entry_t wait;
1825 card = substream->pcm->card;
1826 runtime = substream->runtime;
1828 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1832 if (file->f_flags & O_NONBLOCK)
1834 } else if (substream->f_flags & O_NONBLOCK)
1837 snd_pcm_stream_lock_irq(substream);
1839 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1840 snd_pcm_pause(substream, 0);
1842 /* pre-start/stop - all running streams are changed to DRAINING state */
1843 result = snd_pcm_action(&snd_pcm_action_drain_init, substream, 0);
1846 /* in non-blocking, we don't wait in ioctl but let caller poll */
1854 struct snd_pcm_runtime *to_check;
1855 if (signal_pending(current)) {
1856 result = -ERESTARTSYS;
1859 /* find a substream to drain */
1861 group = snd_pcm_stream_group_ref(substream);
1862 snd_pcm_group_for_each_entry(s, substream) {
1863 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
1865 runtime = s->runtime;
1866 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
1871 snd_pcm_group_unref(group, substream);
1873 break; /* all drained */
1874 init_waitqueue_entry(&wait, current);
1875 set_current_state(TASK_INTERRUPTIBLE);
1876 add_wait_queue(&to_check->sleep, &wait);
1877 snd_pcm_stream_unlock_irq(substream);
1878 if (runtime->no_period_wakeup)
1879 tout = MAX_SCHEDULE_TIMEOUT;
1882 if (runtime->rate) {
1883 long t = runtime->period_size * 2 / runtime->rate;
1884 tout = max(t, tout);
1886 tout = msecs_to_jiffies(tout * 1000);
1888 tout = schedule_timeout(tout);
1890 snd_pcm_stream_lock_irq(substream);
1891 group = snd_pcm_stream_group_ref(substream);
1892 snd_pcm_group_for_each_entry(s, substream) {
1893 if (s->runtime == to_check) {
1894 remove_wait_queue(&to_check->sleep, &wait);
1898 snd_pcm_group_unref(group, substream);
1900 if (card->shutdown) {
1905 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
1908 dev_dbg(substream->pcm->card->dev,
1909 "playback drain error (DMA or IRQ trouble?)\n");
1910 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1918 snd_pcm_stream_unlock_irq(substream);
1926 * Immediately put all linked substreams into SETUP state.
1928 static int snd_pcm_drop(struct snd_pcm_substream *substream)
1930 struct snd_pcm_runtime *runtime;
1933 if (PCM_RUNTIME_CHECK(substream))
1935 runtime = substream->runtime;
1937 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1938 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1941 snd_pcm_stream_lock_irq(substream);
1943 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1944 snd_pcm_pause(substream, 0);
1946 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1947 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
1948 snd_pcm_stream_unlock_irq(substream);
1954 static bool is_pcm_file(struct file *file)
1956 struct inode *inode = file_inode(file);
1957 struct snd_pcm *pcm;
1960 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
1962 minor = iminor(inode);
1963 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
1965 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
1968 snd_card_unref(pcm->card);
1975 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
1978 struct snd_pcm_file *pcm_file;
1979 struct snd_pcm_substream *substream1;
1980 struct snd_pcm_group *group, *target_group;
1981 bool nonatomic = substream->pcm->nonatomic;
1982 struct fd f = fdget(fd);
1986 if (!is_pcm_file(f.file)) {
1990 pcm_file = f.file->private_data;
1991 substream1 = pcm_file->substream;
1992 group = kzalloc(sizeof(*group), GFP_KERNEL);
1997 snd_pcm_group_init(group);
1999 down_write(&snd_pcm_link_rwsem);
2000 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2001 substream->runtime->status->state != substream1->runtime->status->state ||
2002 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2006 if (snd_pcm_stream_linked(substream1)) {
2011 snd_pcm_stream_lock_irq(substream);
2012 if (!snd_pcm_stream_linked(substream)) {
2013 snd_pcm_group_assign(substream, group);
2014 group = NULL; /* assigned, don't free this one below */
2016 target_group = substream->group;
2017 snd_pcm_stream_unlock_irq(substream);
2019 snd_pcm_group_lock_irq(target_group, nonatomic);
2020 snd_pcm_stream_lock(substream1);
2021 snd_pcm_group_assign(substream1, target_group);
2022 refcount_inc(&target_group->refs);
2023 snd_pcm_stream_unlock(substream1);
2024 snd_pcm_group_unlock_irq(target_group, nonatomic);
2026 up_write(&snd_pcm_link_rwsem);
2034 static void relink_to_local(struct snd_pcm_substream *substream)
2036 snd_pcm_stream_lock(substream);
2037 snd_pcm_group_assign(substream, &substream->self_group);
2038 snd_pcm_stream_unlock(substream);
2041 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2043 struct snd_pcm_group *group;
2044 bool nonatomic = substream->pcm->nonatomic;
2045 bool do_free = false;
2048 down_write(&snd_pcm_link_rwsem);
2050 if (!snd_pcm_stream_linked(substream)) {
2055 group = substream->group;
2056 snd_pcm_group_lock_irq(group, nonatomic);
2058 relink_to_local(substream);
2059 refcount_dec(&group->refs);
2061 /* detach the last stream, too */
2062 if (list_is_singular(&group->substreams)) {
2063 relink_to_local(list_first_entry(&group->substreams,
2064 struct snd_pcm_substream,
2066 do_free = refcount_dec_and_test(&group->refs);
2069 snd_pcm_group_unlock_irq(group, nonatomic);
2074 up_write(&snd_pcm_link_rwsem);
2081 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2082 struct snd_pcm_hw_rule *rule)
2084 struct snd_interval t;
2085 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2086 hw_param_interval_c(params, rule->deps[1]), &t);
2087 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2090 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2091 struct snd_pcm_hw_rule *rule)
2093 struct snd_interval t;
2094 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2095 hw_param_interval_c(params, rule->deps[1]), &t);
2096 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2099 static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2100 struct snd_pcm_hw_rule *rule)
2102 struct snd_interval t;
2103 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2104 hw_param_interval_c(params, rule->deps[1]),
2105 (unsigned long) rule->private, &t);
2106 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2109 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2110 struct snd_pcm_hw_rule *rule)
2112 struct snd_interval t;
2113 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2114 (unsigned long) rule->private,
2115 hw_param_interval_c(params, rule->deps[1]), &t);
2116 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2119 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2120 struct snd_pcm_hw_rule *rule)
2123 const struct snd_interval *i =
2124 hw_param_interval_c(params, rule->deps[0]);
2126 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2128 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2130 if (! snd_mask_test(mask, k))
2132 bits = snd_pcm_format_physical_width(k);
2134 continue; /* ignore invalid formats */
2135 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2136 snd_mask_reset(&m, k);
2138 return snd_mask_refine(mask, &m);
2141 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2142 struct snd_pcm_hw_rule *rule)
2144 struct snd_interval t;
2150 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2152 if (! snd_mask_test(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2154 bits = snd_pcm_format_physical_width(k);
2156 continue; /* ignore invalid formats */
2157 if (t.min > (unsigned)bits)
2159 if (t.max < (unsigned)bits)
2163 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2166 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2167 #error "Change this table"
2170 static const unsigned int rates[] = {
2171 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2172 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2175 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2176 .count = ARRAY_SIZE(rates),
2180 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2181 struct snd_pcm_hw_rule *rule)
2183 struct snd_pcm_hardware *hw = rule->private;
2184 return snd_interval_list(hw_param_interval(params, rule->var),
2185 snd_pcm_known_rates.count,
2186 snd_pcm_known_rates.list, hw->rates);
2189 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2190 struct snd_pcm_hw_rule *rule)
2192 struct snd_interval t;
2193 struct snd_pcm_substream *substream = rule->private;
2195 t.max = substream->buffer_bytes_max;
2199 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2202 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2204 struct snd_pcm_runtime *runtime = substream->runtime;
2205 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2208 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2209 snd_mask_any(constrs_mask(constrs, k));
2212 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2213 snd_interval_any(constrs_interval(constrs, k));
2216 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2217 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2218 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2219 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2220 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2222 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2223 snd_pcm_hw_rule_format, NULL,
2224 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2227 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2228 snd_pcm_hw_rule_sample_bits, NULL,
2229 SNDRV_PCM_HW_PARAM_FORMAT,
2230 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2233 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2234 snd_pcm_hw_rule_div, NULL,
2235 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2238 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2239 snd_pcm_hw_rule_mul, NULL,
2240 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2243 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2244 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2245 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2248 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2249 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2250 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2253 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2254 snd_pcm_hw_rule_div, NULL,
2255 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2258 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2259 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2260 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2263 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2264 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2265 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2268 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2269 snd_pcm_hw_rule_div, NULL,
2270 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2273 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2274 snd_pcm_hw_rule_div, NULL,
2275 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2278 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2279 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2280 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2283 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2284 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2285 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2288 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2289 snd_pcm_hw_rule_mul, NULL,
2290 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2293 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2294 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2295 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2298 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2299 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2300 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2303 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2304 snd_pcm_hw_rule_muldivk, (void*) 8,
2305 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2308 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2309 snd_pcm_hw_rule_muldivk, (void*) 8,
2310 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2313 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2314 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2315 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2318 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2319 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2320 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2326 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2328 struct snd_pcm_runtime *runtime = substream->runtime;
2329 struct snd_pcm_hardware *hw = &runtime->hw;
2331 unsigned int mask = 0;
2333 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2334 mask |= 1 << SNDRV_PCM_ACCESS_RW_INTERLEAVED;
2335 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2336 mask |= 1 << SNDRV_PCM_ACCESS_RW_NONINTERLEAVED;
2337 if (hw_support_mmap(substream)) {
2338 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2339 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_INTERLEAVED;
2340 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2341 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED;
2342 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2343 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_COMPLEX;
2345 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2349 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2353 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT, 1 << SNDRV_PCM_SUBFORMAT_STD);
2357 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2358 hw->channels_min, hw->channels_max);
2362 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2363 hw->rate_min, hw->rate_max);
2367 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2368 hw->period_bytes_min, hw->period_bytes_max);
2372 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2373 hw->periods_min, hw->periods_max);
2377 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2378 hw->period_bytes_min, hw->buffer_bytes_max);
2382 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2383 snd_pcm_hw_rule_buffer_bytes_max, substream,
2384 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2389 if (runtime->dma_bytes) {
2390 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2395 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2396 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2397 snd_pcm_hw_rule_rate, hw,
2398 SNDRV_PCM_HW_PARAM_RATE, -1);
2403 /* FIXME: this belong to lowlevel */
2404 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2409 static void pcm_release_private(struct snd_pcm_substream *substream)
2411 if (snd_pcm_stream_linked(substream))
2412 snd_pcm_unlink(substream);
2415 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2417 substream->ref_count--;
2418 if (substream->ref_count > 0)
2421 snd_pcm_drop(substream);
2422 if (substream->hw_opened) {
2423 if (substream->ops->hw_free &&
2424 substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2425 substream->ops->hw_free(substream);
2426 substream->ops->close(substream);
2427 substream->hw_opened = 0;
2429 if (pm_qos_request_active(&substream->latency_pm_qos_req))
2430 pm_qos_remove_request(&substream->latency_pm_qos_req);
2431 if (substream->pcm_release) {
2432 substream->pcm_release(substream);
2433 substream->pcm_release = NULL;
2435 snd_pcm_detach_substream(substream);
2437 EXPORT_SYMBOL(snd_pcm_release_substream);
2439 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2441 struct snd_pcm_substream **rsubstream)
2443 struct snd_pcm_substream *substream;
2446 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2449 if (substream->ref_count > 1) {
2450 *rsubstream = substream;
2454 err = snd_pcm_hw_constraints_init(substream);
2456 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2460 if ((err = substream->ops->open(substream)) < 0)
2463 substream->hw_opened = 1;
2465 err = snd_pcm_hw_constraints_complete(substream);
2467 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2471 *rsubstream = substream;
2475 snd_pcm_release_substream(substream);
2478 EXPORT_SYMBOL(snd_pcm_open_substream);
2480 static int snd_pcm_open_file(struct file *file,
2481 struct snd_pcm *pcm,
2484 struct snd_pcm_file *pcm_file;
2485 struct snd_pcm_substream *substream;
2488 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2492 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2493 if (pcm_file == NULL) {
2494 snd_pcm_release_substream(substream);
2497 pcm_file->substream = substream;
2498 if (substream->ref_count == 1)
2499 substream->pcm_release = pcm_release_private;
2500 file->private_data = pcm_file;
2505 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2507 struct snd_pcm *pcm;
2508 int err = nonseekable_open(inode, file);
2511 pcm = snd_lookup_minor_data(iminor(inode),
2512 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2513 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2515 snd_card_unref(pcm->card);
2519 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2521 struct snd_pcm *pcm;
2522 int err = nonseekable_open(inode, file);
2525 pcm = snd_lookup_minor_data(iminor(inode),
2526 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2527 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2529 snd_card_unref(pcm->card);
2533 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2536 wait_queue_entry_t wait;
2542 err = snd_card_file_add(pcm->card, file);
2545 if (!try_module_get(pcm->card->module)) {
2549 init_waitqueue_entry(&wait, current);
2550 add_wait_queue(&pcm->open_wait, &wait);
2551 mutex_lock(&pcm->open_mutex);
2553 err = snd_pcm_open_file(file, pcm, stream);
2556 if (err == -EAGAIN) {
2557 if (file->f_flags & O_NONBLOCK) {
2563 set_current_state(TASK_INTERRUPTIBLE);
2564 mutex_unlock(&pcm->open_mutex);
2566 mutex_lock(&pcm->open_mutex);
2567 if (pcm->card->shutdown) {
2571 if (signal_pending(current)) {
2576 remove_wait_queue(&pcm->open_wait, &wait);
2577 mutex_unlock(&pcm->open_mutex);
2583 module_put(pcm->card->module);
2585 snd_card_file_remove(pcm->card, file);
2590 static int snd_pcm_release(struct inode *inode, struct file *file)
2592 struct snd_pcm *pcm;
2593 struct snd_pcm_substream *substream;
2594 struct snd_pcm_file *pcm_file;
2596 pcm_file = file->private_data;
2597 substream = pcm_file->substream;
2598 if (snd_BUG_ON(!substream))
2600 pcm = substream->pcm;
2601 mutex_lock(&pcm->open_mutex);
2602 snd_pcm_release_substream(substream);
2604 mutex_unlock(&pcm->open_mutex);
2605 wake_up(&pcm->open_wait);
2606 module_put(pcm->card->module);
2607 snd_card_file_remove(pcm->card, file);
2611 /* check and update PCM state; return 0 or a negative error
2612 * call this inside PCM lock
2614 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2616 switch (substream->runtime->status->state) {
2617 case SNDRV_PCM_STATE_DRAINING:
2618 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2621 case SNDRV_PCM_STATE_RUNNING:
2622 return snd_pcm_update_hw_ptr(substream);
2623 case SNDRV_PCM_STATE_PREPARED:
2624 case SNDRV_PCM_STATE_PAUSED:
2626 case SNDRV_PCM_STATE_SUSPENDED:
2628 case SNDRV_PCM_STATE_XRUN:
2635 /* increase the appl_ptr; returns the processed frames or a negative error */
2636 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2637 snd_pcm_uframes_t frames,
2638 snd_pcm_sframes_t avail)
2640 struct snd_pcm_runtime *runtime = substream->runtime;
2641 snd_pcm_sframes_t appl_ptr;
2646 if (frames > (snd_pcm_uframes_t)avail)
2648 appl_ptr = runtime->control->appl_ptr + frames;
2649 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2650 appl_ptr -= runtime->boundary;
2651 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2652 return ret < 0 ? ret : frames;
2655 /* decrease the appl_ptr; returns the processed frames or zero for error */
2656 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2657 snd_pcm_uframes_t frames,
2658 snd_pcm_sframes_t avail)
2660 struct snd_pcm_runtime *runtime = substream->runtime;
2661 snd_pcm_sframes_t appl_ptr;
2666 if (frames > (snd_pcm_uframes_t)avail)
2668 appl_ptr = runtime->control->appl_ptr - frames;
2670 appl_ptr += runtime->boundary;
2671 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2672 /* NOTE: we return zero for errors because PulseAudio gets depressed
2673 * upon receiving an error from rewind ioctl and stops processing
2674 * any longer. Returning zero means that no rewind is done, so
2675 * it's not absolutely wrong to answer like that.
2677 return ret < 0 ? 0 : frames;
2680 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2681 snd_pcm_uframes_t frames)
2683 snd_pcm_sframes_t ret;
2688 snd_pcm_stream_lock_irq(substream);
2689 ret = do_pcm_hwsync(substream);
2691 ret = rewind_appl_ptr(substream, frames,
2692 snd_pcm_hw_avail(substream));
2693 snd_pcm_stream_unlock_irq(substream);
2697 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2698 snd_pcm_uframes_t frames)
2700 snd_pcm_sframes_t ret;
2705 snd_pcm_stream_lock_irq(substream);
2706 ret = do_pcm_hwsync(substream);
2708 ret = forward_appl_ptr(substream, frames,
2709 snd_pcm_avail(substream));
2710 snd_pcm_stream_unlock_irq(substream);
2714 static int snd_pcm_hwsync(struct snd_pcm_substream *substream)
2718 snd_pcm_stream_lock_irq(substream);
2719 err = do_pcm_hwsync(substream);
2720 snd_pcm_stream_unlock_irq(substream);
2724 static int snd_pcm_delay(struct snd_pcm_substream *substream,
2725 snd_pcm_sframes_t *delay)
2728 snd_pcm_sframes_t n = 0;
2730 snd_pcm_stream_lock_irq(substream);
2731 err = do_pcm_hwsync(substream);
2733 n = snd_pcm_calc_delay(substream);
2734 snd_pcm_stream_unlock_irq(substream);
2740 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
2741 struct snd_pcm_sync_ptr __user *_sync_ptr)
2743 struct snd_pcm_runtime *runtime = substream->runtime;
2744 struct snd_pcm_sync_ptr sync_ptr;
2745 volatile struct snd_pcm_mmap_status *status;
2746 volatile struct snd_pcm_mmap_control *control;
2749 memset(&sync_ptr, 0, sizeof(sync_ptr));
2750 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
2752 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
2754 status = runtime->status;
2755 control = runtime->control;
2756 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
2757 err = snd_pcm_hwsync(substream);
2761 snd_pcm_stream_lock_irq(substream);
2762 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
2763 err = pcm_lib_apply_appl_ptr(substream,
2764 sync_ptr.c.control.appl_ptr);
2766 snd_pcm_stream_unlock_irq(substream);
2770 sync_ptr.c.control.appl_ptr = control->appl_ptr;
2772 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
2773 control->avail_min = sync_ptr.c.control.avail_min;
2775 sync_ptr.c.control.avail_min = control->avail_min;
2776 sync_ptr.s.status.state = status->state;
2777 sync_ptr.s.status.hw_ptr = status->hw_ptr;
2778 sync_ptr.s.status.tstamp = status->tstamp;
2779 sync_ptr.s.status.suspended_state = status->suspended_state;
2780 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
2781 snd_pcm_stream_unlock_irq(substream);
2782 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
2787 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
2789 struct snd_pcm_runtime *runtime = substream->runtime;
2792 if (get_user(arg, _arg))
2794 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
2796 runtime->tstamp_type = arg;
2800 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
2801 struct snd_xferi __user *_xferi)
2803 struct snd_xferi xferi;
2804 struct snd_pcm_runtime *runtime = substream->runtime;
2805 snd_pcm_sframes_t result;
2807 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2809 if (put_user(0, &_xferi->result))
2811 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
2813 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2814 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
2816 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
2817 __put_user(result, &_xferi->result);
2818 return result < 0 ? result : 0;
2821 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
2822 struct snd_xfern __user *_xfern)
2824 struct snd_xfern xfern;
2825 struct snd_pcm_runtime *runtime = substream->runtime;
2827 snd_pcm_sframes_t result;
2829 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2831 if (runtime->channels > 128)
2833 if (put_user(0, &_xfern->result))
2835 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
2838 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
2840 return PTR_ERR(bufs);
2841 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2842 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
2844 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
2846 __put_user(result, &_xfern->result);
2847 return result < 0 ? result : 0;
2850 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
2851 snd_pcm_uframes_t __user *_frames)
2853 snd_pcm_uframes_t frames;
2854 snd_pcm_sframes_t result;
2856 if (get_user(frames, _frames))
2858 if (put_user(0, _frames))
2860 result = snd_pcm_rewind(substream, frames);
2861 __put_user(result, _frames);
2862 return result < 0 ? result : 0;
2865 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
2866 snd_pcm_uframes_t __user *_frames)
2868 snd_pcm_uframes_t frames;
2869 snd_pcm_sframes_t result;
2871 if (get_user(frames, _frames))
2873 if (put_user(0, _frames))
2875 result = snd_pcm_forward(substream, frames);
2876 __put_user(result, _frames);
2877 return result < 0 ? result : 0;
2880 static int snd_pcm_common_ioctl(struct file *file,
2881 struct snd_pcm_substream *substream,
2882 unsigned int cmd, void __user *arg)
2884 struct snd_pcm_file *pcm_file = file->private_data;
2887 if (PCM_RUNTIME_CHECK(substream))
2890 res = snd_power_wait(substream->pcm->card, SNDRV_CTL_POWER_D0);
2895 case SNDRV_PCM_IOCTL_PVERSION:
2896 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
2897 case SNDRV_PCM_IOCTL_INFO:
2898 return snd_pcm_info_user(substream, arg);
2899 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
2901 case SNDRV_PCM_IOCTL_TTSTAMP:
2902 return snd_pcm_tstamp(substream, arg);
2903 case SNDRV_PCM_IOCTL_USER_PVERSION:
2904 if (get_user(pcm_file->user_pversion,
2905 (unsigned int __user *)arg))
2908 case SNDRV_PCM_IOCTL_HW_REFINE:
2909 return snd_pcm_hw_refine_user(substream, arg);
2910 case SNDRV_PCM_IOCTL_HW_PARAMS:
2911 return snd_pcm_hw_params_user(substream, arg);
2912 case SNDRV_PCM_IOCTL_HW_FREE:
2913 return snd_pcm_hw_free(substream);
2914 case SNDRV_PCM_IOCTL_SW_PARAMS:
2915 return snd_pcm_sw_params_user(substream, arg);
2916 case SNDRV_PCM_IOCTL_STATUS:
2917 return snd_pcm_status_user(substream, arg, false);
2918 case SNDRV_PCM_IOCTL_STATUS_EXT:
2919 return snd_pcm_status_user(substream, arg, true);
2920 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
2921 return snd_pcm_channel_info_user(substream, arg);
2922 case SNDRV_PCM_IOCTL_PREPARE:
2923 return snd_pcm_prepare(substream, file);
2924 case SNDRV_PCM_IOCTL_RESET:
2925 return snd_pcm_reset(substream);
2926 case SNDRV_PCM_IOCTL_START:
2927 return snd_pcm_start_lock_irq(substream);
2928 case SNDRV_PCM_IOCTL_LINK:
2929 return snd_pcm_link(substream, (int)(unsigned long) arg);
2930 case SNDRV_PCM_IOCTL_UNLINK:
2931 return snd_pcm_unlink(substream);
2932 case SNDRV_PCM_IOCTL_RESUME:
2933 return snd_pcm_resume(substream);
2934 case SNDRV_PCM_IOCTL_XRUN:
2935 return snd_pcm_xrun(substream);
2936 case SNDRV_PCM_IOCTL_HWSYNC:
2937 return snd_pcm_hwsync(substream);
2938 case SNDRV_PCM_IOCTL_DELAY:
2940 snd_pcm_sframes_t delay;
2941 snd_pcm_sframes_t __user *res = arg;
2944 err = snd_pcm_delay(substream, &delay);
2947 if (put_user(delay, res))
2951 case SNDRV_PCM_IOCTL_SYNC_PTR:
2952 return snd_pcm_sync_ptr(substream, arg);
2953 #ifdef CONFIG_SND_SUPPORT_OLD_API
2954 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
2955 return snd_pcm_hw_refine_old_user(substream, arg);
2956 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
2957 return snd_pcm_hw_params_old_user(substream, arg);
2959 case SNDRV_PCM_IOCTL_DRAIN:
2960 return snd_pcm_drain(substream, file);
2961 case SNDRV_PCM_IOCTL_DROP:
2962 return snd_pcm_drop(substream);
2963 case SNDRV_PCM_IOCTL_PAUSE:
2964 return snd_pcm_action_lock_irq(&snd_pcm_action_pause,
2966 (int)(unsigned long)arg);
2967 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
2968 case SNDRV_PCM_IOCTL_READI_FRAMES:
2969 return snd_pcm_xferi_frames_ioctl(substream, arg);
2970 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
2971 case SNDRV_PCM_IOCTL_READN_FRAMES:
2972 return snd_pcm_xfern_frames_ioctl(substream, arg);
2973 case SNDRV_PCM_IOCTL_REWIND:
2974 return snd_pcm_rewind_ioctl(substream, arg);
2975 case SNDRV_PCM_IOCTL_FORWARD:
2976 return snd_pcm_forward_ioctl(substream, arg);
2978 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
2982 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
2985 struct snd_pcm_file *pcm_file;
2987 pcm_file = file->private_data;
2989 if (((cmd >> 8) & 0xff) != 'A')
2992 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
2993 (void __user *)arg);
2997 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
2998 * @substream: PCM substream
3000 * @arg: IOCTL argument
3002 * The function is provided primarily for OSS layer and USB gadget drivers,
3003 * and it allows only the limited set of ioctls (hw_params, sw_params,
3004 * prepare, start, drain, drop, forward).
3006 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3007 unsigned int cmd, void *arg)
3009 snd_pcm_uframes_t *frames = arg;
3010 snd_pcm_sframes_t result;
3013 case SNDRV_PCM_IOCTL_FORWARD:
3015 /* provided only for OSS; capture-only and no value returned */
3016 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3018 result = snd_pcm_forward(substream, *frames);
3019 return result < 0 ? result : 0;
3021 case SNDRV_PCM_IOCTL_HW_PARAMS:
3022 return snd_pcm_hw_params(substream, arg);
3023 case SNDRV_PCM_IOCTL_SW_PARAMS:
3024 return snd_pcm_sw_params(substream, arg);
3025 case SNDRV_PCM_IOCTL_PREPARE:
3026 return snd_pcm_prepare(substream, NULL);
3027 case SNDRV_PCM_IOCTL_START:
3028 return snd_pcm_start_lock_irq(substream);
3029 case SNDRV_PCM_IOCTL_DRAIN:
3030 return snd_pcm_drain(substream, NULL);
3031 case SNDRV_PCM_IOCTL_DROP:
3032 return snd_pcm_drop(substream);
3033 case SNDRV_PCM_IOCTL_DELAY:
3034 return snd_pcm_delay(substream, frames);
3039 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3041 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3044 struct snd_pcm_file *pcm_file;
3045 struct snd_pcm_substream *substream;
3046 struct snd_pcm_runtime *runtime;
3047 snd_pcm_sframes_t result;
3049 pcm_file = file->private_data;
3050 substream = pcm_file->substream;
3051 if (PCM_RUNTIME_CHECK(substream))
3053 runtime = substream->runtime;
3054 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3056 if (!frame_aligned(runtime, count))
3058 count = bytes_to_frames(runtime, count);
3059 result = snd_pcm_lib_read(substream, buf, count);
3061 result = frames_to_bytes(runtime, result);
3065 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3066 size_t count, loff_t * offset)
3068 struct snd_pcm_file *pcm_file;
3069 struct snd_pcm_substream *substream;
3070 struct snd_pcm_runtime *runtime;
3071 snd_pcm_sframes_t result;
3073 pcm_file = file->private_data;
3074 substream = pcm_file->substream;
3075 if (PCM_RUNTIME_CHECK(substream))
3077 runtime = substream->runtime;
3078 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3080 if (!frame_aligned(runtime, count))
3082 count = bytes_to_frames(runtime, count);
3083 result = snd_pcm_lib_write(substream, buf, count);
3085 result = frames_to_bytes(runtime, result);
3089 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3091 struct snd_pcm_file *pcm_file;
3092 struct snd_pcm_substream *substream;
3093 struct snd_pcm_runtime *runtime;
3094 snd_pcm_sframes_t result;
3097 snd_pcm_uframes_t frames;
3099 pcm_file = iocb->ki_filp->private_data;
3100 substream = pcm_file->substream;
3101 if (PCM_RUNTIME_CHECK(substream))
3103 runtime = substream->runtime;
3104 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3106 if (!iter_is_iovec(to))
3108 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3110 if (!frame_aligned(runtime, to->iov->iov_len))
3112 frames = bytes_to_samples(runtime, to->iov->iov_len);
3113 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3116 for (i = 0; i < to->nr_segs; ++i)
3117 bufs[i] = to->iov[i].iov_base;
3118 result = snd_pcm_lib_readv(substream, bufs, frames);
3120 result = frames_to_bytes(runtime, result);
3125 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3127 struct snd_pcm_file *pcm_file;
3128 struct snd_pcm_substream *substream;
3129 struct snd_pcm_runtime *runtime;
3130 snd_pcm_sframes_t result;
3133 snd_pcm_uframes_t frames;
3135 pcm_file = iocb->ki_filp->private_data;
3136 substream = pcm_file->substream;
3137 if (PCM_RUNTIME_CHECK(substream))
3139 runtime = substream->runtime;
3140 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3142 if (!iter_is_iovec(from))
3144 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3145 !frame_aligned(runtime, from->iov->iov_len))
3147 frames = bytes_to_samples(runtime, from->iov->iov_len);
3148 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3151 for (i = 0; i < from->nr_segs; ++i)
3152 bufs[i] = from->iov[i].iov_base;
3153 result = snd_pcm_lib_writev(substream, bufs, frames);
3155 result = frames_to_bytes(runtime, result);
3160 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3162 struct snd_pcm_file *pcm_file;
3163 struct snd_pcm_substream *substream;
3164 struct snd_pcm_runtime *runtime;
3166 snd_pcm_uframes_t avail;
3168 pcm_file = file->private_data;
3170 substream = pcm_file->substream;
3171 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3172 ok = EPOLLOUT | EPOLLWRNORM;
3174 ok = EPOLLIN | EPOLLRDNORM;
3175 if (PCM_RUNTIME_CHECK(substream))
3176 return ok | EPOLLERR;
3178 runtime = substream->runtime;
3179 poll_wait(file, &runtime->sleep, wait);
3182 snd_pcm_stream_lock_irq(substream);
3183 avail = snd_pcm_avail(substream);
3184 switch (runtime->status->state) {
3185 case SNDRV_PCM_STATE_RUNNING:
3186 case SNDRV_PCM_STATE_PREPARED:
3187 case SNDRV_PCM_STATE_PAUSED:
3188 if (avail >= runtime->control->avail_min)
3191 case SNDRV_PCM_STATE_DRAINING:
3192 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3199 mask = ok | EPOLLERR;
3202 snd_pcm_stream_unlock_irq(substream);
3211 * Only on coherent architectures, we can mmap the status and the control records
3212 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3214 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3216 * mmap status record
3218 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3220 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3221 struct snd_pcm_runtime *runtime;
3223 if (substream == NULL)
3224 return VM_FAULT_SIGBUS;
3225 runtime = substream->runtime;
3226 vmf->page = virt_to_page(runtime->status);
3227 get_page(vmf->page);
3231 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3233 .fault = snd_pcm_mmap_status_fault,
3236 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3237 struct vm_area_struct *area)
3240 if (!(area->vm_flags & VM_READ))
3242 size = area->vm_end - area->vm_start;
3243 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3245 area->vm_ops = &snd_pcm_vm_ops_status;
3246 area->vm_private_data = substream;
3247 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3252 * mmap control record
3254 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3256 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3257 struct snd_pcm_runtime *runtime;
3259 if (substream == NULL)
3260 return VM_FAULT_SIGBUS;
3261 runtime = substream->runtime;
3262 vmf->page = virt_to_page(runtime->control);
3263 get_page(vmf->page);
3267 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3269 .fault = snd_pcm_mmap_control_fault,
3272 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3273 struct vm_area_struct *area)
3276 if (!(area->vm_flags & VM_READ))
3278 size = area->vm_end - area->vm_start;
3279 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3281 area->vm_ops = &snd_pcm_vm_ops_control;
3282 area->vm_private_data = substream;
3283 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3287 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3289 if (pcm_file->no_compat_mmap)
3291 /* See pcm_control_mmap_allowed() below.
3292 * Since older alsa-lib requires both status and control mmaps to be
3293 * coupled, we have to disable the status mmap for old alsa-lib, too.
3295 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3296 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3301 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3303 if (pcm_file->no_compat_mmap)
3305 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3306 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3307 * thus it effectively assures the manual update of appl_ptr.
3309 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3314 #else /* ! coherent mmap */
3316 * don't support mmap for status and control records.
3318 #define pcm_status_mmap_allowed(pcm_file) false
3319 #define pcm_control_mmap_allowed(pcm_file) false
3321 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3322 struct vm_area_struct *area)
3326 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3327 struct vm_area_struct *area)
3331 #endif /* coherent mmap */
3333 static inline struct page *
3334 snd_pcm_default_page_ops(struct snd_pcm_substream *substream, unsigned long ofs)
3336 void *vaddr = substream->runtime->dma_area + ofs;
3337 return virt_to_page(vaddr);
3341 * fault callback for mmapping a RAM page
3343 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3345 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3346 struct snd_pcm_runtime *runtime;
3347 unsigned long offset;
3351 if (substream == NULL)
3352 return VM_FAULT_SIGBUS;
3353 runtime = substream->runtime;
3354 offset = vmf->pgoff << PAGE_SHIFT;
3355 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3356 if (offset > dma_bytes - PAGE_SIZE)
3357 return VM_FAULT_SIGBUS;
3358 if (substream->ops->page)
3359 page = substream->ops->page(substream, offset);
3361 page = snd_pcm_default_page_ops(substream, offset);
3363 return VM_FAULT_SIGBUS;
3369 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3370 .open = snd_pcm_mmap_data_open,
3371 .close = snd_pcm_mmap_data_close,
3374 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3375 .open = snd_pcm_mmap_data_open,
3376 .close = snd_pcm_mmap_data_close,
3377 .fault = snd_pcm_mmap_data_fault,
3381 * mmap the DMA buffer on RAM
3385 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3386 * @substream: PCM substream
3389 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3390 * this function is invoked implicitly.
3392 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3393 struct vm_area_struct *area)
3395 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3396 #ifdef CONFIG_GENERIC_ALLOCATOR
3397 if (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_IRAM) {
3398 area->vm_page_prot = pgprot_writecombine(area->vm_page_prot);
3399 return remap_pfn_range(area, area->vm_start,
3400 substream->dma_buffer.addr >> PAGE_SHIFT,
3401 area->vm_end - area->vm_start, area->vm_page_prot);
3403 #endif /* CONFIG_GENERIC_ALLOCATOR */
3404 #ifndef CONFIG_X86 /* for avoiding warnings arch/x86/mm/pat.c */
3405 if (IS_ENABLED(CONFIG_HAS_DMA) && !substream->ops->page &&
3406 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV)
3407 return dma_mmap_coherent(substream->dma_buffer.dev.dev,
3409 substream->runtime->dma_area,
3410 substream->runtime->dma_addr,
3411 substream->runtime->dma_bytes);
3412 #endif /* CONFIG_X86 */
3413 /* mmap with fault handler */
3414 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3417 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3420 * mmap the DMA buffer on I/O memory area
3422 #if SNDRV_PCM_INFO_MMAP_IOMEM
3424 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3425 * @substream: PCM substream
3428 * When your hardware uses the iomapped pages as the hardware buffer and
3429 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3430 * is supposed to work only on limited architectures.
3432 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3433 struct vm_area_struct *area)
3435 struct snd_pcm_runtime *runtime = substream->runtime;
3437 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3438 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3440 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3441 #endif /* SNDRV_PCM_INFO_MMAP */
3446 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3447 struct vm_area_struct *area)
3449 struct snd_pcm_runtime *runtime;
3451 unsigned long offset;
3455 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3456 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3459 if (!(area->vm_flags & VM_READ))
3462 runtime = substream->runtime;
3463 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3465 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3467 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3468 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3470 size = area->vm_end - area->vm_start;
3471 offset = area->vm_pgoff << PAGE_SHIFT;
3472 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3473 if ((size_t)size > dma_bytes)
3475 if (offset > dma_bytes - size)
3478 area->vm_ops = &snd_pcm_vm_ops_data;
3479 area->vm_private_data = substream;
3480 if (substream->ops->mmap)
3481 err = substream->ops->mmap(substream, area);
3483 err = snd_pcm_lib_default_mmap(substream, area);
3485 atomic_inc(&substream->mmap_count);
3488 EXPORT_SYMBOL(snd_pcm_mmap_data);
3490 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3492 struct snd_pcm_file * pcm_file;
3493 struct snd_pcm_substream *substream;
3494 unsigned long offset;
3496 pcm_file = file->private_data;
3497 substream = pcm_file->substream;
3498 if (PCM_RUNTIME_CHECK(substream))
3501 offset = area->vm_pgoff << PAGE_SHIFT;
3503 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3504 if (!pcm_status_mmap_allowed(pcm_file))
3506 return snd_pcm_mmap_status(substream, file, area);
3507 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3508 if (!pcm_control_mmap_allowed(pcm_file))
3510 return snd_pcm_mmap_control(substream, file, area);
3512 return snd_pcm_mmap_data(substream, file, area);
3517 static int snd_pcm_fasync(int fd, struct file * file, int on)
3519 struct snd_pcm_file * pcm_file;
3520 struct snd_pcm_substream *substream;
3521 struct snd_pcm_runtime *runtime;
3523 pcm_file = file->private_data;
3524 substream = pcm_file->substream;
3525 if (PCM_RUNTIME_CHECK(substream))
3527 runtime = substream->runtime;
3528 return fasync_helper(fd, file, on, &runtime->fasync);
3534 #ifdef CONFIG_COMPAT
3535 #include "pcm_compat.c"
3537 #define snd_pcm_ioctl_compat NULL
3541 * To be removed helpers to keep binary compatibility
3544 #ifdef CONFIG_SND_SUPPORT_OLD_API
3545 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3546 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3548 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3549 struct snd_pcm_hw_params_old *oparams)
3553 memset(params, 0, sizeof(*params));
3554 params->flags = oparams->flags;
3555 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3556 params->masks[i].bits[0] = oparams->masks[i];
3557 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3558 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3559 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3560 params->info = oparams->info;
3561 params->msbits = oparams->msbits;
3562 params->rate_num = oparams->rate_num;
3563 params->rate_den = oparams->rate_den;
3564 params->fifo_size = oparams->fifo_size;
3567 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3568 struct snd_pcm_hw_params *params)
3572 memset(oparams, 0, sizeof(*oparams));
3573 oparams->flags = params->flags;
3574 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3575 oparams->masks[i] = params->masks[i].bits[0];
3576 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3577 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3578 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3579 oparams->info = params->info;
3580 oparams->msbits = params->msbits;
3581 oparams->rate_num = params->rate_num;
3582 oparams->rate_den = params->rate_den;
3583 oparams->fifo_size = params->fifo_size;
3586 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3587 struct snd_pcm_hw_params_old __user * _oparams)
3589 struct snd_pcm_hw_params *params;
3590 struct snd_pcm_hw_params_old *oparams = NULL;
3593 params = kmalloc(sizeof(*params), GFP_KERNEL);
3597 oparams = memdup_user(_oparams, sizeof(*oparams));
3598 if (IS_ERR(oparams)) {
3599 err = PTR_ERR(oparams);
3602 snd_pcm_hw_convert_from_old_params(params, oparams);
3603 err = snd_pcm_hw_refine(substream, params);
3607 err = fixup_unreferenced_params(substream, params);
3611 snd_pcm_hw_convert_to_old_params(oparams, params);
3612 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3621 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
3622 struct snd_pcm_hw_params_old __user * _oparams)
3624 struct snd_pcm_hw_params *params;
3625 struct snd_pcm_hw_params_old *oparams = NULL;
3628 params = kmalloc(sizeof(*params), GFP_KERNEL);
3632 oparams = memdup_user(_oparams, sizeof(*oparams));
3633 if (IS_ERR(oparams)) {
3634 err = PTR_ERR(oparams);
3638 snd_pcm_hw_convert_from_old_params(params, oparams);
3639 err = snd_pcm_hw_params(substream, params);
3643 snd_pcm_hw_convert_to_old_params(oparams, params);
3644 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3652 #endif /* CONFIG_SND_SUPPORT_OLD_API */
3655 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
3658 unsigned long pgoff,
3659 unsigned long flags)
3661 struct snd_pcm_file *pcm_file = file->private_data;
3662 struct snd_pcm_substream *substream = pcm_file->substream;
3663 struct snd_pcm_runtime *runtime = substream->runtime;
3664 unsigned long offset = pgoff << PAGE_SHIFT;
3667 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3668 return (unsigned long)runtime->status;
3669 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3670 return (unsigned long)runtime->control;
3672 return (unsigned long)runtime->dma_area + offset;
3676 # define snd_pcm_get_unmapped_area NULL
3683 const struct file_operations snd_pcm_f_ops[2] = {
3685 .owner = THIS_MODULE,
3686 .write = snd_pcm_write,
3687 .write_iter = snd_pcm_writev,
3688 .open = snd_pcm_playback_open,
3689 .release = snd_pcm_release,
3690 .llseek = no_llseek,
3691 .poll = snd_pcm_poll,
3692 .unlocked_ioctl = snd_pcm_ioctl,
3693 .compat_ioctl = snd_pcm_ioctl_compat,
3694 .mmap = snd_pcm_mmap,
3695 .fasync = snd_pcm_fasync,
3696 .get_unmapped_area = snd_pcm_get_unmapped_area,
3699 .owner = THIS_MODULE,
3700 .read = snd_pcm_read,
3701 .read_iter = snd_pcm_readv,
3702 .open = snd_pcm_capture_open,
3703 .release = snd_pcm_release,
3704 .llseek = no_llseek,
3705 .poll = snd_pcm_poll,
3706 .unlocked_ioctl = snd_pcm_ioctl,
3707 .compat_ioctl = snd_pcm_ioctl_compat,
3708 .mmap = snd_pcm_mmap,
3709 .fasync = snd_pcm_fasync,
3710 .get_unmapped_area = snd_pcm_get_unmapped_area,