2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/file.h>
25 #include <linux/slab.h>
26 #include <linux/sched/signal.h>
27 #include <linux/time.h>
28 #include <linux/pm_qos.h>
30 #include <linux/dma-mapping.h>
31 #include <sound/core.h>
32 #include <sound/control.h>
33 #include <sound/info.h>
34 #include <sound/pcm.h>
35 #include <sound/pcm_params.h>
36 #include <sound/timer.h>
37 #include <sound/minors.h>
38 #include <linux/uio.h>
39 #include <linux/delay.h>
41 #include "pcm_local.h"
43 #ifdef CONFIG_SND_DEBUG
44 #define CREATE_TRACE_POINTS
45 #include "pcm_param_trace.h"
47 #define trace_hw_mask_param_enabled() 0
48 #define trace_hw_interval_param_enabled() 0
49 #define trace_hw_mask_param(substream, type, index, prev, curr)
50 #define trace_hw_interval_param(substream, type, index, prev, curr)
57 struct snd_pcm_hw_params_old {
59 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
60 SNDRV_PCM_HW_PARAM_ACCESS + 1];
61 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
62 SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
67 unsigned int rate_num;
68 unsigned int rate_den;
69 snd_pcm_uframes_t fifo_size;
70 unsigned char reserved[64];
73 #ifdef CONFIG_SND_SUPPORT_OLD_API
74 #define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
75 #define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
77 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
78 struct snd_pcm_hw_params_old __user * _oparams);
79 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
80 struct snd_pcm_hw_params_old __user * _oparams);
82 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
88 static DEFINE_RWLOCK(snd_pcm_link_rwlock);
89 static DECLARE_RWSEM(snd_pcm_link_rwsem);
91 /* Writer in rwsem may block readers even during its waiting in queue,
92 * and this may lead to a deadlock when the code path takes read sem
93 * twice (e.g. one in snd_pcm_action_nonatomic() and another in
94 * snd_pcm_stream_lock()). As a (suboptimal) workaround, let writer to
95 * sleep until all the readers are completed without blocking by writer.
97 static inline void down_write_nonfifo(struct rw_semaphore *lock)
99 while (!down_write_trylock(lock))
103 #define PCM_LOCK_DEFAULT 0
104 #define PCM_LOCK_IRQ 1
105 #define PCM_LOCK_IRQSAVE 2
107 static unsigned long __snd_pcm_stream_lock_mode(struct snd_pcm_substream *substream,
110 unsigned long flags = 0;
111 if (substream->pcm->nonatomic) {
112 down_read_nested(&snd_pcm_link_rwsem, SINGLE_DEPTH_NESTING);
113 mutex_lock(&substream->self_group.mutex);
116 case PCM_LOCK_DEFAULT:
117 read_lock(&snd_pcm_link_rwlock);
120 read_lock_irq(&snd_pcm_link_rwlock);
122 case PCM_LOCK_IRQSAVE:
123 read_lock_irqsave(&snd_pcm_link_rwlock, flags);
126 spin_lock(&substream->self_group.lock);
131 static void __snd_pcm_stream_unlock_mode(struct snd_pcm_substream *substream,
132 unsigned int mode, unsigned long flags)
134 if (substream->pcm->nonatomic) {
135 mutex_unlock(&substream->self_group.mutex);
136 up_read(&snd_pcm_link_rwsem);
138 spin_unlock(&substream->self_group.lock);
141 case PCM_LOCK_DEFAULT:
142 read_unlock(&snd_pcm_link_rwlock);
145 read_unlock_irq(&snd_pcm_link_rwlock);
147 case PCM_LOCK_IRQSAVE:
148 read_unlock_irqrestore(&snd_pcm_link_rwlock, flags);
155 * snd_pcm_stream_lock - Lock the PCM stream
156 * @substream: PCM substream
158 * This locks the PCM stream's spinlock or mutex depending on the nonatomic
159 * flag of the given substream. This also takes the global link rw lock
160 * (or rw sem), too, for avoiding the race with linked streams.
162 void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
164 __snd_pcm_stream_lock_mode(substream, PCM_LOCK_DEFAULT);
166 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
169 * snd_pcm_stream_lock - Unlock the PCM stream
170 * @substream: PCM substream
172 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
174 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
176 __snd_pcm_stream_unlock_mode(substream, PCM_LOCK_DEFAULT, 0);
178 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
181 * snd_pcm_stream_lock_irq - Lock the PCM stream
182 * @substream: PCM substream
184 * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
185 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
186 * as snd_pcm_stream_lock().
188 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
190 __snd_pcm_stream_lock_mode(substream, PCM_LOCK_IRQ);
192 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
195 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
196 * @substream: PCM substream
198 * This is a counter-part of snd_pcm_stream_lock_irq().
200 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
202 __snd_pcm_stream_unlock_mode(substream, PCM_LOCK_IRQ, 0);
204 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
206 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
208 return __snd_pcm_stream_lock_mode(substream, PCM_LOCK_IRQSAVE);
210 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
213 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
214 * @substream: PCM substream
217 * This is a counter-part of snd_pcm_stream_lock_irqsave().
219 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
222 __snd_pcm_stream_unlock_mode(substream, PCM_LOCK_IRQSAVE, flags);
224 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
226 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
228 struct snd_pcm *pcm = substream->pcm;
229 struct snd_pcm_str *pstr = substream->pstr;
231 memset(info, 0, sizeof(*info));
232 info->card = pcm->card->number;
233 info->device = pcm->device;
234 info->stream = substream->stream;
235 info->subdevice = substream->number;
236 strlcpy(info->id, pcm->id, sizeof(info->id));
237 strlcpy(info->name, pcm->name, sizeof(info->name));
238 info->dev_class = pcm->dev_class;
239 info->dev_subclass = pcm->dev_subclass;
240 info->subdevices_count = pstr->substream_count;
241 info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
242 strlcpy(info->subname, substream->name, sizeof(info->subname));
247 int snd_pcm_info_user(struct snd_pcm_substream *substream,
248 struct snd_pcm_info __user * _info)
250 struct snd_pcm_info *info;
253 info = kmalloc(sizeof(*info), GFP_KERNEL);
256 err = snd_pcm_info(substream, info);
258 if (copy_to_user(_info, info, sizeof(*info)))
265 static bool hw_support_mmap(struct snd_pcm_substream *substream)
267 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
269 /* architecture supports dma_mmap_coherent()? */
270 #if defined(CONFIG_ARCH_NO_COHERENT_DMA_MMAP) || !defined(CONFIG_HAS_DMA)
271 if (!substream->ops->mmap &&
272 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV)
278 static int constrain_mask_params(struct snd_pcm_substream *substream,
279 struct snd_pcm_hw_params *params)
281 struct snd_pcm_hw_constraints *constrs =
282 &substream->runtime->hw_constraints;
285 struct snd_mask old_mask;
288 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
289 m = hw_param_mask(params, k);
290 if (snd_mask_empty(m))
293 /* This parameter is not requested to change by a caller. */
294 if (!(params->rmask & (1 << k)))
297 if (trace_hw_mask_param_enabled())
300 changed = snd_mask_refine(m, constrs_mask(constrs, k));
306 /* Set corresponding flag so that the caller gets it. */
307 trace_hw_mask_param(substream, k, 0, &old_mask, m);
308 params->cmask |= 1 << k;
314 static int constrain_interval_params(struct snd_pcm_substream *substream,
315 struct snd_pcm_hw_params *params)
317 struct snd_pcm_hw_constraints *constrs =
318 &substream->runtime->hw_constraints;
319 struct snd_interval *i;
321 struct snd_interval old_interval;
324 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
325 i = hw_param_interval(params, k);
326 if (snd_interval_empty(i))
329 /* This parameter is not requested to change by a caller. */
330 if (!(params->rmask & (1 << k)))
333 if (trace_hw_interval_param_enabled())
336 changed = snd_interval_refine(i, constrs_interval(constrs, k));
342 /* Set corresponding flag so that the caller gets it. */
343 trace_hw_interval_param(substream, k, 0, &old_interval, i);
344 params->cmask |= 1 << k;
350 static int constrain_params_by_rules(struct snd_pcm_substream *substream,
351 struct snd_pcm_hw_params *params)
353 struct snd_pcm_hw_constraints *constrs =
354 &substream->runtime->hw_constraints;
356 unsigned int *rstamps;
357 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
359 struct snd_pcm_hw_rule *r;
361 struct snd_mask old_mask;
362 struct snd_interval old_interval;
364 int changed, err = 0;
367 * Each application of rule has own sequence number.
369 * Each member of 'rstamps' array represents the sequence number of
370 * recent application of corresponding rule.
372 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
377 * Each member of 'vstamps' array represents the sequence number of
378 * recent application of rule in which corresponding parameters were
381 * In initial state, elements corresponding to parameters requested by
382 * a caller is 1. For unrequested parameters, corresponding members
383 * have 0 so that the parameters are never changed anymore.
385 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
386 vstamps[k] = (params->rmask & (1 << k)) ? 1 : 0;
388 /* Due to the above design, actual sequence number starts at 2. */
391 /* Apply all rules in order. */
393 for (k = 0; k < constrs->rules_num; k++) {
394 r = &constrs->rules[k];
397 * Check condition bits of this rule. When the rule has
398 * some condition bits, parameter without the bits is
399 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
400 * is an example of the condition bits.
402 if (r->cond && !(r->cond & params->flags))
406 * The 'deps' array includes maximum three dependencies
407 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fourth
408 * member of this array is a sentinel and should be
411 * This rule should be processed in this time when dependent
412 * parameters were changed at former applications of the other
415 for (d = 0; r->deps[d] >= 0; d++) {
416 if (vstamps[r->deps[d]] > rstamps[k])
422 if (trace_hw_mask_param_enabled()) {
423 if (hw_is_mask(r->var))
424 old_mask = *hw_param_mask(params, r->var);
426 if (trace_hw_interval_param_enabled()) {
427 if (hw_is_interval(r->var))
428 old_interval = *hw_param_interval(params, r->var);
431 changed = r->func(params, r);
438 * When the parameter is changed, notify it to the caller
439 * by corresponding returned bit, then preparing for next
442 if (changed && r->var >= 0) {
443 if (hw_is_mask(r->var)) {
444 trace_hw_mask_param(substream, r->var,
446 hw_param_mask(params, r->var));
448 if (hw_is_interval(r->var)) {
449 trace_hw_interval_param(substream, r->var,
450 k + 1, &old_interval,
451 hw_param_interval(params, r->var));
454 params->cmask |= (1 << r->var);
455 vstamps[r->var] = stamp;
459 rstamps[k] = stamp++;
462 /* Iterate to evaluate all rules till no parameters are changed. */
471 static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
472 struct snd_pcm_hw_params *params)
474 const struct snd_interval *i;
475 const struct snd_mask *m;
478 if (!params->msbits) {
479 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
480 if (snd_interval_single(i))
481 params->msbits = snd_interval_value(i);
484 if (!params->rate_den) {
485 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
486 if (snd_interval_single(i)) {
487 params->rate_num = snd_interval_value(i);
488 params->rate_den = 1;
492 if (!params->fifo_size) {
493 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
494 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
495 if (snd_mask_single(m) && snd_interval_single(i)) {
496 err = substream->ops->ioctl(substream,
497 SNDRV_PCM_IOCTL1_FIFO_SIZE, params);
504 params->info = substream->runtime->hw.info;
505 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
506 SNDRV_PCM_INFO_DRAIN_TRIGGER);
507 if (!hw_support_mmap(substream))
508 params->info &= ~(SNDRV_PCM_INFO_MMAP |
509 SNDRV_PCM_INFO_MMAP_VALID);
515 int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
516 struct snd_pcm_hw_params *params)
521 params->fifo_size = 0;
522 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
524 if (params->rmask & (1 << SNDRV_PCM_HW_PARAM_RATE)) {
525 params->rate_num = 0;
526 params->rate_den = 0;
529 err = constrain_mask_params(substream, params);
533 err = constrain_interval_params(substream, params);
537 err = constrain_params_by_rules(substream, params);
545 EXPORT_SYMBOL(snd_pcm_hw_refine);
547 static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
548 struct snd_pcm_hw_params __user * _params)
550 struct snd_pcm_hw_params *params;
553 params = memdup_user(_params, sizeof(*params));
555 return PTR_ERR(params);
557 err = snd_pcm_hw_refine(substream, params);
561 err = fixup_unreferenced_params(substream, params);
565 if (copy_to_user(_params, params, sizeof(*params)))
572 static int period_to_usecs(struct snd_pcm_runtime *runtime)
577 return -1; /* invalid */
579 /* take 75% of period time as the deadline */
580 usecs = (750000 / runtime->rate) * runtime->period_size;
581 usecs += ((750000 % runtime->rate) * runtime->period_size) /
587 static void snd_pcm_set_state(struct snd_pcm_substream *substream, int state)
589 snd_pcm_stream_lock_irq(substream);
590 if (substream->runtime->status->state != SNDRV_PCM_STATE_DISCONNECTED)
591 substream->runtime->status->state = state;
592 snd_pcm_stream_unlock_irq(substream);
595 static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
598 #ifdef CONFIG_SND_PCM_TIMER
599 if (substream->timer)
600 snd_timer_notify(substream->timer, event,
601 &substream->runtime->trigger_tstamp);
606 * snd_pcm_hw_param_choose - choose a configuration defined by @params
608 * @params: the hw_params instance
610 * Choose one configuration from configuration space defined by @params.
611 * The configuration chosen is that obtained fixing in this order:
612 * first access, first format, first subformat, min channels,
613 * min rate, min period time, max buffer size, min tick time
615 * Return: Zero if successful, or a negative error code on failure.
617 static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
618 struct snd_pcm_hw_params *params)
620 static const int vars[] = {
621 SNDRV_PCM_HW_PARAM_ACCESS,
622 SNDRV_PCM_HW_PARAM_FORMAT,
623 SNDRV_PCM_HW_PARAM_SUBFORMAT,
624 SNDRV_PCM_HW_PARAM_CHANNELS,
625 SNDRV_PCM_HW_PARAM_RATE,
626 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
627 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
628 SNDRV_PCM_HW_PARAM_TICK_TIME,
632 struct snd_mask old_mask;
633 struct snd_interval old_interval;
636 for (v = vars; *v != -1; v++) {
637 /* Keep old parameter to trace. */
638 if (trace_hw_mask_param_enabled()) {
640 old_mask = *hw_param_mask(params, *v);
642 if (trace_hw_interval_param_enabled()) {
643 if (hw_is_interval(*v))
644 old_interval = *hw_param_interval(params, *v);
646 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
647 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
649 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
655 /* Trace the changed parameter. */
656 if (hw_is_mask(*v)) {
657 trace_hw_mask_param(pcm, *v, 0, &old_mask,
658 hw_param_mask(params, *v));
660 if (hw_is_interval(*v)) {
661 trace_hw_interval_param(pcm, *v, 0, &old_interval,
662 hw_param_interval(params, *v));
669 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
670 struct snd_pcm_hw_params *params)
672 struct snd_pcm_runtime *runtime;
675 snd_pcm_uframes_t frames;
677 if (PCM_RUNTIME_CHECK(substream))
679 runtime = substream->runtime;
680 snd_pcm_stream_lock_irq(substream);
681 switch (runtime->status->state) {
682 case SNDRV_PCM_STATE_OPEN:
683 case SNDRV_PCM_STATE_SETUP:
684 case SNDRV_PCM_STATE_PREPARED:
687 snd_pcm_stream_unlock_irq(substream);
690 snd_pcm_stream_unlock_irq(substream);
691 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
692 if (!substream->oss.oss)
694 if (atomic_read(&substream->mmap_count))
698 err = snd_pcm_hw_refine(substream, params);
702 err = snd_pcm_hw_params_choose(substream, params);
706 err = fixup_unreferenced_params(substream, params);
710 if (substream->ops->hw_params != NULL) {
711 err = substream->ops->hw_params(substream, params);
716 runtime->access = params_access(params);
717 runtime->format = params_format(params);
718 runtime->subformat = params_subformat(params);
719 runtime->channels = params_channels(params);
720 runtime->rate = params_rate(params);
721 runtime->period_size = params_period_size(params);
722 runtime->periods = params_periods(params);
723 runtime->buffer_size = params_buffer_size(params);
724 runtime->info = params->info;
725 runtime->rate_num = params->rate_num;
726 runtime->rate_den = params->rate_den;
727 runtime->no_period_wakeup =
728 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
729 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
731 bits = snd_pcm_format_physical_width(runtime->format);
732 runtime->sample_bits = bits;
733 bits *= runtime->channels;
734 runtime->frame_bits = bits;
736 while (bits % 8 != 0) {
740 runtime->byte_align = bits / 8;
741 runtime->min_align = frames;
743 /* Default sw params */
744 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
745 runtime->period_step = 1;
746 runtime->control->avail_min = runtime->period_size;
747 runtime->start_threshold = 1;
748 runtime->stop_threshold = runtime->buffer_size;
749 runtime->silence_threshold = 0;
750 runtime->silence_size = 0;
751 runtime->boundary = runtime->buffer_size;
752 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
753 runtime->boundary *= 2;
755 snd_pcm_timer_resolution_change(substream);
756 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
758 if (pm_qos_request_active(&substream->latency_pm_qos_req))
759 pm_qos_remove_request(&substream->latency_pm_qos_req);
760 if ((usecs = period_to_usecs(runtime)) >= 0)
761 pm_qos_add_request(&substream->latency_pm_qos_req,
762 PM_QOS_CPU_DMA_LATENCY, usecs);
765 /* hardware might be unusable from this time,
766 so we force application to retry to set
767 the correct hardware parameter settings */
768 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
769 if (substream->ops->hw_free != NULL)
770 substream->ops->hw_free(substream);
774 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
775 struct snd_pcm_hw_params __user * _params)
777 struct snd_pcm_hw_params *params;
780 params = memdup_user(_params, sizeof(*params));
782 return PTR_ERR(params);
784 err = snd_pcm_hw_params(substream, params);
788 if (copy_to_user(_params, params, sizeof(*params)))
795 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
797 struct snd_pcm_runtime *runtime;
800 if (PCM_RUNTIME_CHECK(substream))
802 runtime = substream->runtime;
803 snd_pcm_stream_lock_irq(substream);
804 switch (runtime->status->state) {
805 case SNDRV_PCM_STATE_SETUP:
806 case SNDRV_PCM_STATE_PREPARED:
809 snd_pcm_stream_unlock_irq(substream);
812 snd_pcm_stream_unlock_irq(substream);
813 if (atomic_read(&substream->mmap_count))
815 if (substream->ops->hw_free)
816 result = substream->ops->hw_free(substream);
817 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
818 pm_qos_remove_request(&substream->latency_pm_qos_req);
822 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
823 struct snd_pcm_sw_params *params)
825 struct snd_pcm_runtime *runtime;
828 if (PCM_RUNTIME_CHECK(substream))
830 runtime = substream->runtime;
831 snd_pcm_stream_lock_irq(substream);
832 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
833 snd_pcm_stream_unlock_irq(substream);
836 snd_pcm_stream_unlock_irq(substream);
838 if (params->tstamp_mode < 0 ||
839 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
841 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
842 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
844 if (params->avail_min == 0)
846 if (params->silence_size >= runtime->boundary) {
847 if (params->silence_threshold != 0)
850 if (params->silence_size > params->silence_threshold)
852 if (params->silence_threshold > runtime->buffer_size)
856 snd_pcm_stream_lock_irq(substream);
857 runtime->tstamp_mode = params->tstamp_mode;
858 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
859 runtime->tstamp_type = params->tstamp_type;
860 runtime->period_step = params->period_step;
861 runtime->control->avail_min = params->avail_min;
862 runtime->start_threshold = params->start_threshold;
863 runtime->stop_threshold = params->stop_threshold;
864 runtime->silence_threshold = params->silence_threshold;
865 runtime->silence_size = params->silence_size;
866 params->boundary = runtime->boundary;
867 if (snd_pcm_running(substream)) {
868 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
869 runtime->silence_size > 0)
870 snd_pcm_playback_silence(substream, ULONG_MAX);
871 err = snd_pcm_update_state(substream, runtime);
873 snd_pcm_stream_unlock_irq(substream);
877 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
878 struct snd_pcm_sw_params __user * _params)
880 struct snd_pcm_sw_params params;
882 if (copy_from_user(¶ms, _params, sizeof(params)))
884 err = snd_pcm_sw_params(substream, ¶ms);
885 if (copy_to_user(_params, ¶ms, sizeof(params)))
890 static inline snd_pcm_uframes_t
891 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
893 snd_pcm_uframes_t delay;
895 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
896 delay = snd_pcm_playback_hw_avail(substream->runtime);
898 delay = snd_pcm_capture_avail(substream->runtime);
899 return delay + substream->runtime->delay;
902 int snd_pcm_status(struct snd_pcm_substream *substream,
903 struct snd_pcm_status *status)
905 struct snd_pcm_runtime *runtime = substream->runtime;
907 snd_pcm_stream_lock_irq(substream);
909 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
910 &runtime->audio_tstamp_config);
912 /* backwards compatible behavior */
913 if (runtime->audio_tstamp_config.type_requested ==
914 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
915 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
916 runtime->audio_tstamp_config.type_requested =
917 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
919 runtime->audio_tstamp_config.type_requested =
920 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
921 runtime->audio_tstamp_report.valid = 0;
923 runtime->audio_tstamp_report.valid = 1;
925 status->state = runtime->status->state;
926 status->suspended_state = runtime->status->suspended_state;
927 if (status->state == SNDRV_PCM_STATE_OPEN)
929 status->trigger_tstamp = runtime->trigger_tstamp;
930 if (snd_pcm_running(substream)) {
931 snd_pcm_update_hw_ptr(substream);
932 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
933 status->tstamp = runtime->status->tstamp;
934 status->driver_tstamp = runtime->driver_tstamp;
935 status->audio_tstamp =
936 runtime->status->audio_tstamp;
937 if (runtime->audio_tstamp_report.valid == 1)
938 /* backwards compatibility, no report provided in COMPAT mode */
939 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
940 &status->audio_tstamp_accuracy,
941 &runtime->audio_tstamp_report);
946 /* get tstamp only in fallback mode and only if enabled */
947 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
948 snd_pcm_gettime(runtime, &status->tstamp);
951 status->appl_ptr = runtime->control->appl_ptr;
952 status->hw_ptr = runtime->status->hw_ptr;
953 status->avail = snd_pcm_avail(substream);
954 status->delay = snd_pcm_running(substream) ?
955 snd_pcm_calc_delay(substream) : 0;
956 status->avail_max = runtime->avail_max;
957 status->overrange = runtime->overrange;
958 runtime->avail_max = 0;
959 runtime->overrange = 0;
961 snd_pcm_stream_unlock_irq(substream);
965 static int snd_pcm_status_user(struct snd_pcm_substream *substream,
966 struct snd_pcm_status __user * _status,
969 struct snd_pcm_status status;
972 memset(&status, 0, sizeof(status));
974 * with extension, parameters are read/write,
975 * get audio_tstamp_data from user,
976 * ignore rest of status structure
978 if (ext && get_user(status.audio_tstamp_data,
979 (u32 __user *)(&_status->audio_tstamp_data)))
981 res = snd_pcm_status(substream, &status);
984 if (copy_to_user(_status, &status, sizeof(status)))
989 static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
990 struct snd_pcm_channel_info * info)
992 struct snd_pcm_runtime *runtime;
993 unsigned int channel;
995 channel = info->channel;
996 runtime = substream->runtime;
997 snd_pcm_stream_lock_irq(substream);
998 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
999 snd_pcm_stream_unlock_irq(substream);
1002 snd_pcm_stream_unlock_irq(substream);
1003 if (channel >= runtime->channels)
1005 memset(info, 0, sizeof(*info));
1006 info->channel = channel;
1007 return substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1010 static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1011 struct snd_pcm_channel_info __user * _info)
1013 struct snd_pcm_channel_info info;
1016 if (copy_from_user(&info, _info, sizeof(info)))
1018 res = snd_pcm_channel_info(substream, &info);
1021 if (copy_to_user(_info, &info, sizeof(info)))
1026 static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1028 struct snd_pcm_runtime *runtime = substream->runtime;
1029 if (runtime->trigger_master == NULL)
1031 if (runtime->trigger_master == substream) {
1032 if (!runtime->trigger_tstamp_latched)
1033 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1035 snd_pcm_trigger_tstamp(runtime->trigger_master);
1036 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1038 runtime->trigger_master = NULL;
1042 int (*pre_action)(struct snd_pcm_substream *substream, int state);
1043 int (*do_action)(struct snd_pcm_substream *substream, int state);
1044 void (*undo_action)(struct snd_pcm_substream *substream, int state);
1045 void (*post_action)(struct snd_pcm_substream *substream, int state);
1049 * this functions is core for handling of linked stream
1050 * Note: the stream state might be changed also on failure
1051 * Note2: call with calling stream lock + link lock
1053 static int snd_pcm_action_group(const struct action_ops *ops,
1054 struct snd_pcm_substream *substream,
1055 int state, int do_lock)
1057 struct snd_pcm_substream *s = NULL;
1058 struct snd_pcm_substream *s1;
1059 int res = 0, depth = 1;
1061 snd_pcm_group_for_each_entry(s, substream) {
1062 if (do_lock && s != substream) {
1063 if (s->pcm->nonatomic)
1064 mutex_lock_nested(&s->self_group.mutex, depth);
1066 spin_lock_nested(&s->self_group.lock, depth);
1069 res = ops->pre_action(s, state);
1073 snd_pcm_group_for_each_entry(s, substream) {
1074 res = ops->do_action(s, state);
1076 if (ops->undo_action) {
1077 snd_pcm_group_for_each_entry(s1, substream) {
1078 if (s1 == s) /* failed stream */
1080 ops->undo_action(s1, state);
1083 s = NULL; /* unlock all */
1087 snd_pcm_group_for_each_entry(s, substream) {
1088 ops->post_action(s, state);
1092 /* unlock streams */
1093 snd_pcm_group_for_each_entry(s1, substream) {
1094 if (s1 != substream) {
1095 if (s1->pcm->nonatomic)
1096 mutex_unlock(&s1->self_group.mutex);
1098 spin_unlock(&s1->self_group.lock);
1100 if (s1 == s) /* end */
1108 * Note: call with stream lock
1110 static int snd_pcm_action_single(const struct action_ops *ops,
1111 struct snd_pcm_substream *substream,
1116 res = ops->pre_action(substream, state);
1119 res = ops->do_action(substream, state);
1121 ops->post_action(substream, state);
1122 else if (ops->undo_action)
1123 ops->undo_action(substream, state);
1128 * Note: call with stream lock
1130 static int snd_pcm_action(const struct action_ops *ops,
1131 struct snd_pcm_substream *substream,
1136 if (!snd_pcm_stream_linked(substream))
1137 return snd_pcm_action_single(ops, substream, state);
1139 if (substream->pcm->nonatomic) {
1140 if (!mutex_trylock(&substream->group->mutex)) {
1141 mutex_unlock(&substream->self_group.mutex);
1142 mutex_lock(&substream->group->mutex);
1143 mutex_lock(&substream->self_group.mutex);
1145 res = snd_pcm_action_group(ops, substream, state, 1);
1146 mutex_unlock(&substream->group->mutex);
1148 if (!spin_trylock(&substream->group->lock)) {
1149 spin_unlock(&substream->self_group.lock);
1150 spin_lock(&substream->group->lock);
1151 spin_lock(&substream->self_group.lock);
1153 res = snd_pcm_action_group(ops, substream, state, 1);
1154 spin_unlock(&substream->group->lock);
1160 * Note: don't use any locks before
1162 static int snd_pcm_action_lock_irq(const struct action_ops *ops,
1163 struct snd_pcm_substream *substream,
1168 snd_pcm_stream_lock_irq(substream);
1169 res = snd_pcm_action(ops, substream, state);
1170 snd_pcm_stream_unlock_irq(substream);
1176 static int snd_pcm_action_nonatomic(const struct action_ops *ops,
1177 struct snd_pcm_substream *substream,
1182 down_read(&snd_pcm_link_rwsem);
1183 if (snd_pcm_stream_linked(substream))
1184 res = snd_pcm_action_group(ops, substream, state, 0);
1186 res = snd_pcm_action_single(ops, substream, state);
1187 up_read(&snd_pcm_link_rwsem);
1194 static int snd_pcm_pre_start(struct snd_pcm_substream *substream, int state)
1196 struct snd_pcm_runtime *runtime = substream->runtime;
1197 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1199 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1200 !snd_pcm_playback_data(substream))
1202 runtime->trigger_tstamp_latched = false;
1203 runtime->trigger_master = substream;
1207 static int snd_pcm_do_start(struct snd_pcm_substream *substream, int state)
1209 if (substream->runtime->trigger_master != substream)
1211 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1214 static void snd_pcm_undo_start(struct snd_pcm_substream *substream, int state)
1216 if (substream->runtime->trigger_master == substream)
1217 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1220 static void snd_pcm_post_start(struct snd_pcm_substream *substream, int state)
1222 struct snd_pcm_runtime *runtime = substream->runtime;
1223 snd_pcm_trigger_tstamp(substream);
1224 runtime->hw_ptr_jiffies = jiffies;
1225 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1227 runtime->status->state = state;
1228 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1229 runtime->silence_size > 0)
1230 snd_pcm_playback_silence(substream, ULONG_MAX);
1231 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1234 static const struct action_ops snd_pcm_action_start = {
1235 .pre_action = snd_pcm_pre_start,
1236 .do_action = snd_pcm_do_start,
1237 .undo_action = snd_pcm_undo_start,
1238 .post_action = snd_pcm_post_start
1242 * snd_pcm_start - start all linked streams
1243 * @substream: the PCM substream instance
1245 * Return: Zero if successful, or a negative error code.
1246 * The stream lock must be acquired before calling this function.
1248 int snd_pcm_start(struct snd_pcm_substream *substream)
1250 return snd_pcm_action(&snd_pcm_action_start, substream,
1251 SNDRV_PCM_STATE_RUNNING);
1254 /* take the stream lock and start the streams */
1255 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1257 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1258 SNDRV_PCM_STATE_RUNNING);
1264 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream, int state)
1266 struct snd_pcm_runtime *runtime = substream->runtime;
1267 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1269 runtime->trigger_master = substream;
1273 static int snd_pcm_do_stop(struct snd_pcm_substream *substream, int state)
1275 if (substream->runtime->trigger_master == substream &&
1276 snd_pcm_running(substream))
1277 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1278 return 0; /* unconditonally stop all substreams */
1281 static void snd_pcm_post_stop(struct snd_pcm_substream *substream, int state)
1283 struct snd_pcm_runtime *runtime = substream->runtime;
1284 if (runtime->status->state != state) {
1285 snd_pcm_trigger_tstamp(substream);
1286 runtime->status->state = state;
1287 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1289 wake_up(&runtime->sleep);
1290 wake_up(&runtime->tsleep);
1293 static const struct action_ops snd_pcm_action_stop = {
1294 .pre_action = snd_pcm_pre_stop,
1295 .do_action = snd_pcm_do_stop,
1296 .post_action = snd_pcm_post_stop
1300 * snd_pcm_stop - try to stop all running streams in the substream group
1301 * @substream: the PCM substream instance
1302 * @state: PCM state after stopping the stream
1304 * The state of each stream is then changed to the given state unconditionally.
1306 * Return: Zero if successful, or a negative error code.
1308 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1310 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1312 EXPORT_SYMBOL(snd_pcm_stop);
1315 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1316 * @substream: the PCM substream
1318 * After stopping, the state is changed to SETUP.
1319 * Unlike snd_pcm_stop(), this affects only the given stream.
1321 * Return: Zero if succesful, or a negative error code.
1323 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1325 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1326 SNDRV_PCM_STATE_SETUP);
1330 * snd_pcm_stop_xrun - stop the running streams as XRUN
1331 * @substream: the PCM substream instance
1333 * This stops the given running substream (and all linked substreams) as XRUN.
1334 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1336 * Return: Zero if successful, or a negative error code.
1338 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1340 unsigned long flags;
1342 snd_pcm_stream_lock_irqsave(substream, flags);
1343 if (substream->runtime && snd_pcm_running(substream))
1344 __snd_pcm_xrun(substream);
1345 snd_pcm_stream_unlock_irqrestore(substream, flags);
1348 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1353 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream, int push)
1355 struct snd_pcm_runtime *runtime = substream->runtime;
1356 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1359 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1361 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1363 runtime->trigger_master = substream;
1367 static int snd_pcm_do_pause(struct snd_pcm_substream *substream, int push)
1369 if (substream->runtime->trigger_master != substream)
1371 /* some drivers might use hw_ptr to recover from the pause -
1372 update the hw_ptr now */
1374 snd_pcm_update_hw_ptr(substream);
1375 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1376 * a delta between the current jiffies, this gives a large enough
1377 * delta, effectively to skip the check once.
1379 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1380 return substream->ops->trigger(substream,
1381 push ? SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1382 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1385 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream, int push)
1387 if (substream->runtime->trigger_master == substream)
1388 substream->ops->trigger(substream,
1389 push ? SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1390 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1393 static void snd_pcm_post_pause(struct snd_pcm_substream *substream, int push)
1395 struct snd_pcm_runtime *runtime = substream->runtime;
1396 snd_pcm_trigger_tstamp(substream);
1398 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
1399 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1400 wake_up(&runtime->sleep);
1401 wake_up(&runtime->tsleep);
1403 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
1404 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1408 static const struct action_ops snd_pcm_action_pause = {
1409 .pre_action = snd_pcm_pre_pause,
1410 .do_action = snd_pcm_do_pause,
1411 .undo_action = snd_pcm_undo_pause,
1412 .post_action = snd_pcm_post_pause
1416 * Push/release the pause for all linked streams.
1418 static int snd_pcm_pause(struct snd_pcm_substream *substream, int push)
1420 return snd_pcm_action(&snd_pcm_action_pause, substream, push);
1426 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream, int state)
1428 struct snd_pcm_runtime *runtime = substream->runtime;
1429 if (runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
1431 runtime->trigger_master = substream;
1435 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream, int state)
1437 struct snd_pcm_runtime *runtime = substream->runtime;
1438 if (runtime->trigger_master != substream)
1440 if (! snd_pcm_running(substream))
1442 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1443 return 0; /* suspend unconditionally */
1446 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream, int state)
1448 struct snd_pcm_runtime *runtime = substream->runtime;
1449 snd_pcm_trigger_tstamp(substream);
1450 runtime->status->suspended_state = runtime->status->state;
1451 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
1452 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1453 wake_up(&runtime->sleep);
1454 wake_up(&runtime->tsleep);
1457 static const struct action_ops snd_pcm_action_suspend = {
1458 .pre_action = snd_pcm_pre_suspend,
1459 .do_action = snd_pcm_do_suspend,
1460 .post_action = snd_pcm_post_suspend
1464 * snd_pcm_suspend - trigger SUSPEND to all linked streams
1465 * @substream: the PCM substream
1467 * After this call, all streams are changed to SUSPENDED state.
1469 * Return: Zero if successful (or @substream is %NULL), or a negative error
1472 int snd_pcm_suspend(struct snd_pcm_substream *substream)
1475 unsigned long flags;
1480 snd_pcm_stream_lock_irqsave(substream, flags);
1481 err = snd_pcm_action(&snd_pcm_action_suspend, substream, 0);
1482 snd_pcm_stream_unlock_irqrestore(substream, flags);
1485 EXPORT_SYMBOL(snd_pcm_suspend);
1488 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1489 * @pcm: the PCM instance
1491 * After this call, all streams are changed to SUSPENDED state.
1493 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1495 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1497 struct snd_pcm_substream *substream;
1498 int stream, err = 0;
1503 for (stream = 0; stream < 2; stream++) {
1504 for (substream = pcm->streams[stream].substream;
1505 substream; substream = substream->next) {
1506 /* FIXME: the open/close code should lock this as well */
1507 if (substream->runtime == NULL)
1509 err = snd_pcm_suspend(substream);
1510 if (err < 0 && err != -EBUSY)
1516 EXPORT_SYMBOL(snd_pcm_suspend_all);
1520 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream, int state)
1522 struct snd_pcm_runtime *runtime = substream->runtime;
1523 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1525 runtime->trigger_master = substream;
1529 static int snd_pcm_do_resume(struct snd_pcm_substream *substream, int state)
1531 struct snd_pcm_runtime *runtime = substream->runtime;
1532 if (runtime->trigger_master != substream)
1534 /* DMA not running previously? */
1535 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1536 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1537 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1539 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1542 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream, int state)
1544 if (substream->runtime->trigger_master == substream &&
1545 snd_pcm_running(substream))
1546 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1549 static void snd_pcm_post_resume(struct snd_pcm_substream *substream, int state)
1551 struct snd_pcm_runtime *runtime = substream->runtime;
1552 snd_pcm_trigger_tstamp(substream);
1553 runtime->status->state = runtime->status->suspended_state;
1554 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1557 static const struct action_ops snd_pcm_action_resume = {
1558 .pre_action = snd_pcm_pre_resume,
1559 .do_action = snd_pcm_do_resume,
1560 .undo_action = snd_pcm_undo_resume,
1561 .post_action = snd_pcm_post_resume
1564 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1566 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream, 0);
1571 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1576 #endif /* CONFIG_PM */
1581 * Change the RUNNING stream(s) to XRUN state.
1583 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1585 struct snd_pcm_runtime *runtime = substream->runtime;
1588 snd_pcm_stream_lock_irq(substream);
1589 switch (runtime->status->state) {
1590 case SNDRV_PCM_STATE_XRUN:
1591 result = 0; /* already there */
1593 case SNDRV_PCM_STATE_RUNNING:
1594 __snd_pcm_xrun(substream);
1600 snd_pcm_stream_unlock_irq(substream);
1607 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream, int state)
1609 struct snd_pcm_runtime *runtime = substream->runtime;
1610 switch (runtime->status->state) {
1611 case SNDRV_PCM_STATE_RUNNING:
1612 case SNDRV_PCM_STATE_PREPARED:
1613 case SNDRV_PCM_STATE_PAUSED:
1614 case SNDRV_PCM_STATE_SUSPENDED:
1621 static int snd_pcm_do_reset(struct snd_pcm_substream *substream, int state)
1623 struct snd_pcm_runtime *runtime = substream->runtime;
1624 int err = substream->ops->ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1627 runtime->hw_ptr_base = 0;
1628 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1629 runtime->status->hw_ptr % runtime->period_size;
1630 runtime->silence_start = runtime->status->hw_ptr;
1631 runtime->silence_filled = 0;
1635 static void snd_pcm_post_reset(struct snd_pcm_substream *substream, int state)
1637 struct snd_pcm_runtime *runtime = substream->runtime;
1638 runtime->control->appl_ptr = runtime->status->hw_ptr;
1639 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1640 runtime->silence_size > 0)
1641 snd_pcm_playback_silence(substream, ULONG_MAX);
1644 static const struct action_ops snd_pcm_action_reset = {
1645 .pre_action = snd_pcm_pre_reset,
1646 .do_action = snd_pcm_do_reset,
1647 .post_action = snd_pcm_post_reset
1650 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1652 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream, 0);
1658 /* we use the second argument for updating f_flags */
1659 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1662 struct snd_pcm_runtime *runtime = substream->runtime;
1663 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1664 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1666 if (snd_pcm_running(substream))
1668 substream->f_flags = f_flags;
1672 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream, int state)
1675 err = substream->ops->prepare(substream);
1678 return snd_pcm_do_reset(substream, 0);
1681 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream, int state)
1683 struct snd_pcm_runtime *runtime = substream->runtime;
1684 runtime->control->appl_ptr = runtime->status->hw_ptr;
1685 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1688 static const struct action_ops snd_pcm_action_prepare = {
1689 .pre_action = snd_pcm_pre_prepare,
1690 .do_action = snd_pcm_do_prepare,
1691 .post_action = snd_pcm_post_prepare
1695 * snd_pcm_prepare - prepare the PCM substream to be triggerable
1696 * @substream: the PCM substream instance
1697 * @file: file to refer f_flags
1699 * Return: Zero if successful, or a negative error code.
1701 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1707 f_flags = file->f_flags;
1709 f_flags = substream->f_flags;
1711 snd_pcm_stream_lock_irq(substream);
1712 switch (substream->runtime->status->state) {
1713 case SNDRV_PCM_STATE_PAUSED:
1714 snd_pcm_pause(substream, 0);
1716 case SNDRV_PCM_STATE_SUSPENDED:
1717 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1720 snd_pcm_stream_unlock_irq(substream);
1722 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
1723 substream, f_flags);
1730 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream, int state)
1732 struct snd_pcm_runtime *runtime = substream->runtime;
1733 switch (runtime->status->state) {
1734 case SNDRV_PCM_STATE_OPEN:
1735 case SNDRV_PCM_STATE_DISCONNECTED:
1736 case SNDRV_PCM_STATE_SUSPENDED:
1739 runtime->trigger_master = substream;
1743 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream, int state)
1745 struct snd_pcm_runtime *runtime = substream->runtime;
1746 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1747 switch (runtime->status->state) {
1748 case SNDRV_PCM_STATE_PREPARED:
1749 /* start playback stream if possible */
1750 if (! snd_pcm_playback_empty(substream)) {
1751 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
1752 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
1754 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1757 case SNDRV_PCM_STATE_RUNNING:
1758 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
1760 case SNDRV_PCM_STATE_XRUN:
1761 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1767 /* stop running stream */
1768 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
1769 int new_state = snd_pcm_capture_avail(runtime) > 0 ?
1770 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
1771 snd_pcm_do_stop(substream, new_state);
1772 snd_pcm_post_stop(substream, new_state);
1776 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
1777 runtime->trigger_master == substream &&
1778 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
1779 return substream->ops->trigger(substream,
1780 SNDRV_PCM_TRIGGER_DRAIN);
1785 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream, int state)
1789 static const struct action_ops snd_pcm_action_drain_init = {
1790 .pre_action = snd_pcm_pre_drain_init,
1791 .do_action = snd_pcm_do_drain_init,
1792 .post_action = snd_pcm_post_drain_init
1795 static int snd_pcm_drop(struct snd_pcm_substream *substream);
1798 * Drain the stream(s).
1799 * When the substream is linked, sync until the draining of all playback streams
1801 * After this call, all streams are supposed to be either SETUP or DRAINING
1802 * (capture only) state.
1804 static int snd_pcm_drain(struct snd_pcm_substream *substream,
1807 struct snd_card *card;
1808 struct snd_pcm_runtime *runtime;
1809 struct snd_pcm_substream *s;
1810 wait_queue_entry_t wait;
1814 card = substream->pcm->card;
1815 runtime = substream->runtime;
1817 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1821 if (file->f_flags & O_NONBLOCK)
1823 } else if (substream->f_flags & O_NONBLOCK)
1826 down_read(&snd_pcm_link_rwsem);
1827 snd_pcm_stream_lock_irq(substream);
1829 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1830 snd_pcm_pause(substream, 0);
1832 /* pre-start/stop - all running streams are changed to DRAINING state */
1833 result = snd_pcm_action(&snd_pcm_action_drain_init, substream, 0);
1836 /* in non-blocking, we don't wait in ioctl but let caller poll */
1844 struct snd_pcm_runtime *to_check;
1845 if (signal_pending(current)) {
1846 result = -ERESTARTSYS;
1849 /* find a substream to drain */
1851 snd_pcm_group_for_each_entry(s, substream) {
1852 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
1854 runtime = s->runtime;
1855 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
1861 break; /* all drained */
1862 init_waitqueue_entry(&wait, current);
1863 add_wait_queue(&to_check->sleep, &wait);
1864 snd_pcm_stream_unlock_irq(substream);
1865 up_read(&snd_pcm_link_rwsem);
1866 if (runtime->no_period_wakeup)
1867 tout = MAX_SCHEDULE_TIMEOUT;
1870 if (runtime->rate) {
1871 long t = runtime->period_size * 2 / runtime->rate;
1872 tout = max(t, tout);
1874 tout = msecs_to_jiffies(tout * 1000);
1876 tout = schedule_timeout_interruptible(tout);
1877 down_read(&snd_pcm_link_rwsem);
1878 snd_pcm_stream_lock_irq(substream);
1879 remove_wait_queue(&to_check->sleep, &wait);
1880 if (card->shutdown) {
1885 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
1888 dev_dbg(substream->pcm->card->dev,
1889 "playback drain error (DMA or IRQ trouble?)\n");
1890 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1898 snd_pcm_stream_unlock_irq(substream);
1899 up_read(&snd_pcm_link_rwsem);
1907 * Immediately put all linked substreams into SETUP state.
1909 static int snd_pcm_drop(struct snd_pcm_substream *substream)
1911 struct snd_pcm_runtime *runtime;
1914 if (PCM_RUNTIME_CHECK(substream))
1916 runtime = substream->runtime;
1918 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1919 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1922 snd_pcm_stream_lock_irq(substream);
1924 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
1925 snd_pcm_pause(substream, 0);
1927 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1928 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
1929 snd_pcm_stream_unlock_irq(substream);
1935 static bool is_pcm_file(struct file *file)
1937 struct inode *inode = file_inode(file);
1938 struct snd_pcm *pcm;
1941 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
1943 minor = iminor(inode);
1944 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
1946 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
1949 snd_card_unref(pcm->card);
1956 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
1959 struct snd_pcm_file *pcm_file;
1960 struct snd_pcm_substream *substream1;
1961 struct snd_pcm_group *group;
1962 struct fd f = fdget(fd);
1966 if (!is_pcm_file(f.file)) {
1970 pcm_file = f.file->private_data;
1971 substream1 = pcm_file->substream;
1972 group = kmalloc(sizeof(*group), GFP_KERNEL);
1977 down_write_nonfifo(&snd_pcm_link_rwsem);
1978 write_lock_irq(&snd_pcm_link_rwlock);
1979 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1980 substream->runtime->status->state != substream1->runtime->status->state ||
1981 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
1985 if (snd_pcm_stream_linked(substream1)) {
1989 if (!snd_pcm_stream_linked(substream)) {
1990 substream->group = group;
1992 spin_lock_init(&substream->group->lock);
1993 mutex_init(&substream->group->mutex);
1994 INIT_LIST_HEAD(&substream->group->substreams);
1995 list_add_tail(&substream->link_list, &substream->group->substreams);
1996 substream->group->count = 1;
1998 list_add_tail(&substream1->link_list, &substream->group->substreams);
1999 substream->group->count++;
2000 substream1->group = substream->group;
2002 write_unlock_irq(&snd_pcm_link_rwlock);
2003 up_write(&snd_pcm_link_rwsem);
2011 static void relink_to_local(struct snd_pcm_substream *substream)
2013 substream->group = &substream->self_group;
2014 INIT_LIST_HEAD(&substream->self_group.substreams);
2015 list_add_tail(&substream->link_list, &substream->self_group.substreams);
2018 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2020 struct snd_pcm_substream *s;
2023 down_write_nonfifo(&snd_pcm_link_rwsem);
2024 write_lock_irq(&snd_pcm_link_rwlock);
2025 if (!snd_pcm_stream_linked(substream)) {
2029 list_del(&substream->link_list);
2030 substream->group->count--;
2031 if (substream->group->count == 1) { /* detach the last stream, too */
2032 snd_pcm_group_for_each_entry(s, substream) {
2036 kfree(substream->group);
2038 relink_to_local(substream);
2040 write_unlock_irq(&snd_pcm_link_rwlock);
2041 up_write(&snd_pcm_link_rwsem);
2048 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2049 struct snd_pcm_hw_rule *rule)
2051 struct snd_interval t;
2052 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2053 hw_param_interval_c(params, rule->deps[1]), &t);
2054 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2057 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2058 struct snd_pcm_hw_rule *rule)
2060 struct snd_interval t;
2061 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2062 hw_param_interval_c(params, rule->deps[1]), &t);
2063 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2066 static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2067 struct snd_pcm_hw_rule *rule)
2069 struct snd_interval t;
2070 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2071 hw_param_interval_c(params, rule->deps[1]),
2072 (unsigned long) rule->private, &t);
2073 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2076 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2077 struct snd_pcm_hw_rule *rule)
2079 struct snd_interval t;
2080 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2081 (unsigned long) rule->private,
2082 hw_param_interval_c(params, rule->deps[1]), &t);
2083 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2086 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2087 struct snd_pcm_hw_rule *rule)
2090 const struct snd_interval *i =
2091 hw_param_interval_c(params, rule->deps[0]);
2093 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2095 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2097 if (! snd_mask_test(mask, k))
2099 bits = snd_pcm_format_physical_width(k);
2101 continue; /* ignore invalid formats */
2102 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2103 snd_mask_reset(&m, k);
2105 return snd_mask_refine(mask, &m);
2108 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2109 struct snd_pcm_hw_rule *rule)
2111 struct snd_interval t;
2117 for (k = 0; k <= SNDRV_PCM_FORMAT_LAST; ++k) {
2119 if (! snd_mask_test(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2121 bits = snd_pcm_format_physical_width(k);
2123 continue; /* ignore invalid formats */
2124 if (t.min > (unsigned)bits)
2126 if (t.max < (unsigned)bits)
2130 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2133 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2134 #error "Change this table"
2137 static const unsigned int rates[] = {
2138 5512, 8000, 11025, 16000, 22050, 32000, 44100,
2139 48000, 64000, 88200, 96000, 176400, 192000
2142 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2143 .count = ARRAY_SIZE(rates),
2147 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2148 struct snd_pcm_hw_rule *rule)
2150 struct snd_pcm_hardware *hw = rule->private;
2151 return snd_interval_list(hw_param_interval(params, rule->var),
2152 snd_pcm_known_rates.count,
2153 snd_pcm_known_rates.list, hw->rates);
2156 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2157 struct snd_pcm_hw_rule *rule)
2159 struct snd_interval t;
2160 struct snd_pcm_substream *substream = rule->private;
2162 t.max = substream->buffer_bytes_max;
2166 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2169 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2171 struct snd_pcm_runtime *runtime = substream->runtime;
2172 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2175 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2176 snd_mask_any(constrs_mask(constrs, k));
2179 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2180 snd_interval_any(constrs_interval(constrs, k));
2183 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2184 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2185 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2186 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2187 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2189 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2190 snd_pcm_hw_rule_format, NULL,
2191 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2194 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2195 snd_pcm_hw_rule_sample_bits, NULL,
2196 SNDRV_PCM_HW_PARAM_FORMAT,
2197 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2200 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2201 snd_pcm_hw_rule_div, NULL,
2202 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2205 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2206 snd_pcm_hw_rule_mul, NULL,
2207 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2210 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2211 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2212 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2215 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2216 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2217 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2220 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2221 snd_pcm_hw_rule_div, NULL,
2222 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2225 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2226 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2227 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2230 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2231 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2232 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2235 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2236 snd_pcm_hw_rule_div, NULL,
2237 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2240 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2241 snd_pcm_hw_rule_div, NULL,
2242 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2245 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2246 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2247 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2250 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2251 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2252 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2255 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2256 snd_pcm_hw_rule_mul, NULL,
2257 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2260 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2261 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2262 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2265 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2266 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2267 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2270 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2271 snd_pcm_hw_rule_muldivk, (void*) 8,
2272 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2275 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2276 snd_pcm_hw_rule_muldivk, (void*) 8,
2277 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2280 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2281 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2282 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2285 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2286 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2287 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2293 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2295 struct snd_pcm_runtime *runtime = substream->runtime;
2296 struct snd_pcm_hardware *hw = &runtime->hw;
2298 unsigned int mask = 0;
2300 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2301 mask |= 1 << SNDRV_PCM_ACCESS_RW_INTERLEAVED;
2302 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2303 mask |= 1 << SNDRV_PCM_ACCESS_RW_NONINTERLEAVED;
2304 if (hw_support_mmap(substream)) {
2305 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2306 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_INTERLEAVED;
2307 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2308 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED;
2309 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2310 mask |= 1 << SNDRV_PCM_ACCESS_MMAP_COMPLEX;
2312 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2316 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2320 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT, 1 << SNDRV_PCM_SUBFORMAT_STD);
2324 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2325 hw->channels_min, hw->channels_max);
2329 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2330 hw->rate_min, hw->rate_max);
2334 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2335 hw->period_bytes_min, hw->period_bytes_max);
2339 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2340 hw->periods_min, hw->periods_max);
2344 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2345 hw->period_bytes_min, hw->buffer_bytes_max);
2349 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2350 snd_pcm_hw_rule_buffer_bytes_max, substream,
2351 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2356 if (runtime->dma_bytes) {
2357 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2362 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2363 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2364 snd_pcm_hw_rule_rate, hw,
2365 SNDRV_PCM_HW_PARAM_RATE, -1);
2370 /* FIXME: this belong to lowlevel */
2371 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2376 static void pcm_release_private(struct snd_pcm_substream *substream)
2378 if (snd_pcm_stream_linked(substream))
2379 snd_pcm_unlink(substream);
2382 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2384 substream->ref_count--;
2385 if (substream->ref_count > 0)
2388 snd_pcm_drop(substream);
2389 if (substream->hw_opened) {
2390 if (substream->ops->hw_free &&
2391 substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2392 substream->ops->hw_free(substream);
2393 substream->ops->close(substream);
2394 substream->hw_opened = 0;
2396 if (pm_qos_request_active(&substream->latency_pm_qos_req))
2397 pm_qos_remove_request(&substream->latency_pm_qos_req);
2398 if (substream->pcm_release) {
2399 substream->pcm_release(substream);
2400 substream->pcm_release = NULL;
2402 snd_pcm_detach_substream(substream);
2404 EXPORT_SYMBOL(snd_pcm_release_substream);
2406 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2408 struct snd_pcm_substream **rsubstream)
2410 struct snd_pcm_substream *substream;
2413 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2416 if (substream->ref_count > 1) {
2417 *rsubstream = substream;
2421 err = snd_pcm_hw_constraints_init(substream);
2423 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2427 if ((err = substream->ops->open(substream)) < 0)
2430 substream->hw_opened = 1;
2432 err = snd_pcm_hw_constraints_complete(substream);
2434 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2438 *rsubstream = substream;
2442 snd_pcm_release_substream(substream);
2445 EXPORT_SYMBOL(snd_pcm_open_substream);
2447 static int snd_pcm_open_file(struct file *file,
2448 struct snd_pcm *pcm,
2451 struct snd_pcm_file *pcm_file;
2452 struct snd_pcm_substream *substream;
2455 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2459 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2460 if (pcm_file == NULL) {
2461 snd_pcm_release_substream(substream);
2464 pcm_file->substream = substream;
2465 if (substream->ref_count == 1) {
2466 substream->file = pcm_file;
2467 substream->pcm_release = pcm_release_private;
2469 file->private_data = pcm_file;
2474 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2476 struct snd_pcm *pcm;
2477 int err = nonseekable_open(inode, file);
2480 pcm = snd_lookup_minor_data(iminor(inode),
2481 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2482 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2484 snd_card_unref(pcm->card);
2488 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2490 struct snd_pcm *pcm;
2491 int err = nonseekable_open(inode, file);
2494 pcm = snd_lookup_minor_data(iminor(inode),
2495 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2496 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2498 snd_card_unref(pcm->card);
2502 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2505 wait_queue_entry_t wait;
2511 err = snd_card_file_add(pcm->card, file);
2514 if (!try_module_get(pcm->card->module)) {
2518 init_waitqueue_entry(&wait, current);
2519 add_wait_queue(&pcm->open_wait, &wait);
2520 mutex_lock(&pcm->open_mutex);
2522 err = snd_pcm_open_file(file, pcm, stream);
2525 if (err == -EAGAIN) {
2526 if (file->f_flags & O_NONBLOCK) {
2532 set_current_state(TASK_INTERRUPTIBLE);
2533 mutex_unlock(&pcm->open_mutex);
2535 mutex_lock(&pcm->open_mutex);
2536 if (pcm->card->shutdown) {
2540 if (signal_pending(current)) {
2545 remove_wait_queue(&pcm->open_wait, &wait);
2546 mutex_unlock(&pcm->open_mutex);
2552 module_put(pcm->card->module);
2554 snd_card_file_remove(pcm->card, file);
2559 static int snd_pcm_release(struct inode *inode, struct file *file)
2561 struct snd_pcm *pcm;
2562 struct snd_pcm_substream *substream;
2563 struct snd_pcm_file *pcm_file;
2565 pcm_file = file->private_data;
2566 substream = pcm_file->substream;
2567 if (snd_BUG_ON(!substream))
2569 pcm = substream->pcm;
2570 mutex_lock(&pcm->open_mutex);
2571 snd_pcm_release_substream(substream);
2573 mutex_unlock(&pcm->open_mutex);
2574 wake_up(&pcm->open_wait);
2575 module_put(pcm->card->module);
2576 snd_card_file_remove(pcm->card, file);
2580 /* check and update PCM state; return 0 or a negative error
2581 * call this inside PCM lock
2583 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2585 switch (substream->runtime->status->state) {
2586 case SNDRV_PCM_STATE_DRAINING:
2587 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2590 case SNDRV_PCM_STATE_RUNNING:
2591 return snd_pcm_update_hw_ptr(substream);
2592 case SNDRV_PCM_STATE_PREPARED:
2593 case SNDRV_PCM_STATE_PAUSED:
2595 case SNDRV_PCM_STATE_SUSPENDED:
2597 case SNDRV_PCM_STATE_XRUN:
2604 /* increase the appl_ptr; returns the processed frames or a negative error */
2605 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2606 snd_pcm_uframes_t frames,
2607 snd_pcm_sframes_t avail)
2609 struct snd_pcm_runtime *runtime = substream->runtime;
2610 snd_pcm_sframes_t appl_ptr;
2615 if (frames > (snd_pcm_uframes_t)avail)
2617 appl_ptr = runtime->control->appl_ptr + frames;
2618 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2619 appl_ptr -= runtime->boundary;
2620 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2621 return ret < 0 ? ret : frames;
2624 /* decrease the appl_ptr; returns the processed frames or zero for error */
2625 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2626 snd_pcm_uframes_t frames,
2627 snd_pcm_sframes_t avail)
2629 struct snd_pcm_runtime *runtime = substream->runtime;
2630 snd_pcm_sframes_t appl_ptr;
2635 if (frames > (snd_pcm_uframes_t)avail)
2637 appl_ptr = runtime->control->appl_ptr - frames;
2639 appl_ptr += runtime->boundary;
2640 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2641 /* NOTE: we return zero for errors because PulseAudio gets depressed
2642 * upon receiving an error from rewind ioctl and stops processing
2643 * any longer. Returning zero means that no rewind is done, so
2644 * it's not absolutely wrong to answer like that.
2646 return ret < 0 ? 0 : frames;
2649 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2650 snd_pcm_uframes_t frames)
2652 snd_pcm_sframes_t ret;
2657 snd_pcm_stream_lock_irq(substream);
2658 ret = do_pcm_hwsync(substream);
2660 ret = rewind_appl_ptr(substream, frames,
2661 snd_pcm_hw_avail(substream));
2662 snd_pcm_stream_unlock_irq(substream);
2666 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2667 snd_pcm_uframes_t frames)
2669 snd_pcm_sframes_t ret;
2674 snd_pcm_stream_lock_irq(substream);
2675 ret = do_pcm_hwsync(substream);
2677 ret = forward_appl_ptr(substream, frames,
2678 snd_pcm_avail(substream));
2679 snd_pcm_stream_unlock_irq(substream);
2683 static int snd_pcm_hwsync(struct snd_pcm_substream *substream)
2687 snd_pcm_stream_lock_irq(substream);
2688 err = do_pcm_hwsync(substream);
2689 snd_pcm_stream_unlock_irq(substream);
2693 static int snd_pcm_delay(struct snd_pcm_substream *substream,
2694 snd_pcm_sframes_t *delay)
2697 snd_pcm_sframes_t n = 0;
2699 snd_pcm_stream_lock_irq(substream);
2700 err = do_pcm_hwsync(substream);
2702 n = snd_pcm_calc_delay(substream);
2703 snd_pcm_stream_unlock_irq(substream);
2709 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
2710 struct snd_pcm_sync_ptr __user *_sync_ptr)
2712 struct snd_pcm_runtime *runtime = substream->runtime;
2713 struct snd_pcm_sync_ptr sync_ptr;
2714 volatile struct snd_pcm_mmap_status *status;
2715 volatile struct snd_pcm_mmap_control *control;
2718 memset(&sync_ptr, 0, sizeof(sync_ptr));
2719 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
2721 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
2723 status = runtime->status;
2724 control = runtime->control;
2725 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
2726 err = snd_pcm_hwsync(substream);
2730 snd_pcm_stream_lock_irq(substream);
2731 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
2732 err = pcm_lib_apply_appl_ptr(substream,
2733 sync_ptr.c.control.appl_ptr);
2735 snd_pcm_stream_unlock_irq(substream);
2739 sync_ptr.c.control.appl_ptr = control->appl_ptr;
2741 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
2742 control->avail_min = sync_ptr.c.control.avail_min;
2744 sync_ptr.c.control.avail_min = control->avail_min;
2745 sync_ptr.s.status.state = status->state;
2746 sync_ptr.s.status.hw_ptr = status->hw_ptr;
2747 sync_ptr.s.status.tstamp = status->tstamp;
2748 sync_ptr.s.status.suspended_state = status->suspended_state;
2749 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
2750 snd_pcm_stream_unlock_irq(substream);
2751 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
2756 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
2758 struct snd_pcm_runtime *runtime = substream->runtime;
2761 if (get_user(arg, _arg))
2763 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
2765 runtime->tstamp_type = arg;
2769 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
2770 struct snd_xferi __user *_xferi)
2772 struct snd_xferi xferi;
2773 struct snd_pcm_runtime *runtime = substream->runtime;
2774 snd_pcm_sframes_t result;
2776 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2778 if (put_user(0, &_xferi->result))
2780 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
2782 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2783 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
2785 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
2786 __put_user(result, &_xferi->result);
2787 return result < 0 ? result : 0;
2790 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
2791 struct snd_xfern __user *_xfern)
2793 struct snd_xfern xfern;
2794 struct snd_pcm_runtime *runtime = substream->runtime;
2796 snd_pcm_sframes_t result;
2798 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2800 if (runtime->channels > 128)
2802 if (put_user(0, &_xfern->result))
2804 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
2807 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
2809 return PTR_ERR(bufs);
2810 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2811 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
2813 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
2815 __put_user(result, &_xfern->result);
2816 return result < 0 ? result : 0;
2819 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
2820 snd_pcm_uframes_t __user *_frames)
2822 snd_pcm_uframes_t frames;
2823 snd_pcm_sframes_t result;
2825 if (get_user(frames, _frames))
2827 if (put_user(0, _frames))
2829 result = snd_pcm_rewind(substream, frames);
2830 __put_user(result, _frames);
2831 return result < 0 ? result : 0;
2834 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
2835 snd_pcm_uframes_t __user *_frames)
2837 snd_pcm_uframes_t frames;
2838 snd_pcm_sframes_t result;
2840 if (get_user(frames, _frames))
2842 if (put_user(0, _frames))
2844 result = snd_pcm_forward(substream, frames);
2845 __put_user(result, _frames);
2846 return result < 0 ? result : 0;
2849 static int snd_pcm_common_ioctl(struct file *file,
2850 struct snd_pcm_substream *substream,
2851 unsigned int cmd, void __user *arg)
2853 struct snd_pcm_file *pcm_file = file->private_data;
2856 if (PCM_RUNTIME_CHECK(substream))
2859 res = snd_power_wait(substream->pcm->card, SNDRV_CTL_POWER_D0);
2864 case SNDRV_PCM_IOCTL_PVERSION:
2865 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
2866 case SNDRV_PCM_IOCTL_INFO:
2867 return snd_pcm_info_user(substream, arg);
2868 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
2870 case SNDRV_PCM_IOCTL_TTSTAMP:
2871 return snd_pcm_tstamp(substream, arg);
2872 case SNDRV_PCM_IOCTL_USER_PVERSION:
2873 if (get_user(pcm_file->user_pversion,
2874 (unsigned int __user *)arg))
2877 case SNDRV_PCM_IOCTL_HW_REFINE:
2878 return snd_pcm_hw_refine_user(substream, arg);
2879 case SNDRV_PCM_IOCTL_HW_PARAMS:
2880 return snd_pcm_hw_params_user(substream, arg);
2881 case SNDRV_PCM_IOCTL_HW_FREE:
2882 return snd_pcm_hw_free(substream);
2883 case SNDRV_PCM_IOCTL_SW_PARAMS:
2884 return snd_pcm_sw_params_user(substream, arg);
2885 case SNDRV_PCM_IOCTL_STATUS:
2886 return snd_pcm_status_user(substream, arg, false);
2887 case SNDRV_PCM_IOCTL_STATUS_EXT:
2888 return snd_pcm_status_user(substream, arg, true);
2889 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
2890 return snd_pcm_channel_info_user(substream, arg);
2891 case SNDRV_PCM_IOCTL_PREPARE:
2892 return snd_pcm_prepare(substream, file);
2893 case SNDRV_PCM_IOCTL_RESET:
2894 return snd_pcm_reset(substream);
2895 case SNDRV_PCM_IOCTL_START:
2896 return snd_pcm_start_lock_irq(substream);
2897 case SNDRV_PCM_IOCTL_LINK:
2898 return snd_pcm_link(substream, (int)(unsigned long) arg);
2899 case SNDRV_PCM_IOCTL_UNLINK:
2900 return snd_pcm_unlink(substream);
2901 case SNDRV_PCM_IOCTL_RESUME:
2902 return snd_pcm_resume(substream);
2903 case SNDRV_PCM_IOCTL_XRUN:
2904 return snd_pcm_xrun(substream);
2905 case SNDRV_PCM_IOCTL_HWSYNC:
2906 return snd_pcm_hwsync(substream);
2907 case SNDRV_PCM_IOCTL_DELAY:
2909 snd_pcm_sframes_t delay;
2910 snd_pcm_sframes_t __user *res = arg;
2913 err = snd_pcm_delay(substream, &delay);
2916 if (put_user(delay, res))
2920 case SNDRV_PCM_IOCTL_SYNC_PTR:
2921 return snd_pcm_sync_ptr(substream, arg);
2922 #ifdef CONFIG_SND_SUPPORT_OLD_API
2923 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
2924 return snd_pcm_hw_refine_old_user(substream, arg);
2925 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
2926 return snd_pcm_hw_params_old_user(substream, arg);
2928 case SNDRV_PCM_IOCTL_DRAIN:
2929 return snd_pcm_drain(substream, file);
2930 case SNDRV_PCM_IOCTL_DROP:
2931 return snd_pcm_drop(substream);
2932 case SNDRV_PCM_IOCTL_PAUSE:
2933 return snd_pcm_action_lock_irq(&snd_pcm_action_pause,
2935 (int)(unsigned long)arg);
2936 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
2937 case SNDRV_PCM_IOCTL_READI_FRAMES:
2938 return snd_pcm_xferi_frames_ioctl(substream, arg);
2939 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
2940 case SNDRV_PCM_IOCTL_READN_FRAMES:
2941 return snd_pcm_xfern_frames_ioctl(substream, arg);
2942 case SNDRV_PCM_IOCTL_REWIND:
2943 return snd_pcm_rewind_ioctl(substream, arg);
2944 case SNDRV_PCM_IOCTL_FORWARD:
2945 return snd_pcm_forward_ioctl(substream, arg);
2947 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
2951 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
2954 struct snd_pcm_file *pcm_file;
2956 pcm_file = file->private_data;
2958 if (((cmd >> 8) & 0xff) != 'A')
2961 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
2962 (void __user *)arg);
2966 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
2967 * @substream: PCM substream
2969 * @arg: IOCTL argument
2971 * The function is provided primarily for OSS layer and USB gadget drivers,
2972 * and it allows only the limited set of ioctls (hw_params, sw_params,
2973 * prepare, start, drain, drop, forward).
2975 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
2976 unsigned int cmd, void *arg)
2978 snd_pcm_uframes_t *frames = arg;
2979 snd_pcm_sframes_t result;
2982 case SNDRV_PCM_IOCTL_FORWARD:
2984 /* provided only for OSS; capture-only and no value returned */
2985 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
2987 result = snd_pcm_forward(substream, *frames);
2988 return result < 0 ? result : 0;
2990 case SNDRV_PCM_IOCTL_HW_PARAMS:
2991 return snd_pcm_hw_params(substream, arg);
2992 case SNDRV_PCM_IOCTL_SW_PARAMS:
2993 return snd_pcm_sw_params(substream, arg);
2994 case SNDRV_PCM_IOCTL_PREPARE:
2995 return snd_pcm_prepare(substream, NULL);
2996 case SNDRV_PCM_IOCTL_START:
2997 return snd_pcm_start_lock_irq(substream);
2998 case SNDRV_PCM_IOCTL_DRAIN:
2999 return snd_pcm_drain(substream, NULL);
3000 case SNDRV_PCM_IOCTL_DROP:
3001 return snd_pcm_drop(substream);
3002 case SNDRV_PCM_IOCTL_DELAY:
3003 return snd_pcm_delay(substream, frames);
3008 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3010 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3013 struct snd_pcm_file *pcm_file;
3014 struct snd_pcm_substream *substream;
3015 struct snd_pcm_runtime *runtime;
3016 snd_pcm_sframes_t result;
3018 pcm_file = file->private_data;
3019 substream = pcm_file->substream;
3020 if (PCM_RUNTIME_CHECK(substream))
3022 runtime = substream->runtime;
3023 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3025 if (!frame_aligned(runtime, count))
3027 count = bytes_to_frames(runtime, count);
3028 result = snd_pcm_lib_read(substream, buf, count);
3030 result = frames_to_bytes(runtime, result);
3034 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3035 size_t count, loff_t * offset)
3037 struct snd_pcm_file *pcm_file;
3038 struct snd_pcm_substream *substream;
3039 struct snd_pcm_runtime *runtime;
3040 snd_pcm_sframes_t result;
3042 pcm_file = file->private_data;
3043 substream = pcm_file->substream;
3044 if (PCM_RUNTIME_CHECK(substream))
3046 runtime = substream->runtime;
3047 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3049 if (!frame_aligned(runtime, count))
3051 count = bytes_to_frames(runtime, count);
3052 result = snd_pcm_lib_write(substream, buf, count);
3054 result = frames_to_bytes(runtime, result);
3058 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3060 struct snd_pcm_file *pcm_file;
3061 struct snd_pcm_substream *substream;
3062 struct snd_pcm_runtime *runtime;
3063 snd_pcm_sframes_t result;
3066 snd_pcm_uframes_t frames;
3068 pcm_file = iocb->ki_filp->private_data;
3069 substream = pcm_file->substream;
3070 if (PCM_RUNTIME_CHECK(substream))
3072 runtime = substream->runtime;
3073 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3075 if (!iter_is_iovec(to))
3077 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3079 if (!frame_aligned(runtime, to->iov->iov_len))
3081 frames = bytes_to_samples(runtime, to->iov->iov_len);
3082 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3085 for (i = 0; i < to->nr_segs; ++i)
3086 bufs[i] = to->iov[i].iov_base;
3087 result = snd_pcm_lib_readv(substream, bufs, frames);
3089 result = frames_to_bytes(runtime, result);
3094 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3096 struct snd_pcm_file *pcm_file;
3097 struct snd_pcm_substream *substream;
3098 struct snd_pcm_runtime *runtime;
3099 snd_pcm_sframes_t result;
3102 snd_pcm_uframes_t frames;
3104 pcm_file = iocb->ki_filp->private_data;
3105 substream = pcm_file->substream;
3106 if (PCM_RUNTIME_CHECK(substream))
3108 runtime = substream->runtime;
3109 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3111 if (!iter_is_iovec(from))
3113 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3114 !frame_aligned(runtime, from->iov->iov_len))
3116 frames = bytes_to_samples(runtime, from->iov->iov_len);
3117 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3120 for (i = 0; i < from->nr_segs; ++i)
3121 bufs[i] = from->iov[i].iov_base;
3122 result = snd_pcm_lib_writev(substream, bufs, frames);
3124 result = frames_to_bytes(runtime, result);
3129 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3131 struct snd_pcm_file *pcm_file;
3132 struct snd_pcm_substream *substream;
3133 struct snd_pcm_runtime *runtime;
3135 snd_pcm_uframes_t avail;
3137 pcm_file = file->private_data;
3139 substream = pcm_file->substream;
3140 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3141 ok = EPOLLOUT | EPOLLWRNORM;
3143 ok = EPOLLIN | EPOLLRDNORM;
3144 if (PCM_RUNTIME_CHECK(substream))
3145 return ok | EPOLLERR;
3147 runtime = substream->runtime;
3148 poll_wait(file, &runtime->sleep, wait);
3151 snd_pcm_stream_lock_irq(substream);
3152 avail = snd_pcm_avail(substream);
3153 switch (runtime->status->state) {
3154 case SNDRV_PCM_STATE_RUNNING:
3155 case SNDRV_PCM_STATE_PREPARED:
3156 case SNDRV_PCM_STATE_PAUSED:
3157 if (avail >= runtime->control->avail_min)
3160 case SNDRV_PCM_STATE_DRAINING:
3161 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3168 mask = ok | EPOLLERR;
3171 snd_pcm_stream_unlock_irq(substream);
3180 * Only on coherent architectures, we can mmap the status and the control records
3181 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3183 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3185 * mmap status record
3187 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3189 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3190 struct snd_pcm_runtime *runtime;
3192 if (substream == NULL)
3193 return VM_FAULT_SIGBUS;
3194 runtime = substream->runtime;
3195 vmf->page = virt_to_page(runtime->status);
3196 get_page(vmf->page);
3200 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3202 .fault = snd_pcm_mmap_status_fault,
3205 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3206 struct vm_area_struct *area)
3209 if (!(area->vm_flags & VM_READ))
3211 size = area->vm_end - area->vm_start;
3212 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3214 area->vm_ops = &snd_pcm_vm_ops_status;
3215 area->vm_private_data = substream;
3216 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3221 * mmap control record
3223 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3225 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3226 struct snd_pcm_runtime *runtime;
3228 if (substream == NULL)
3229 return VM_FAULT_SIGBUS;
3230 runtime = substream->runtime;
3231 vmf->page = virt_to_page(runtime->control);
3232 get_page(vmf->page);
3236 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3238 .fault = snd_pcm_mmap_control_fault,
3241 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3242 struct vm_area_struct *area)
3245 if (!(area->vm_flags & VM_READ))
3247 size = area->vm_end - area->vm_start;
3248 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3250 area->vm_ops = &snd_pcm_vm_ops_control;
3251 area->vm_private_data = substream;
3252 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3256 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3258 if (pcm_file->no_compat_mmap)
3260 /* See pcm_control_mmap_allowed() below.
3261 * Since older alsa-lib requires both status and control mmaps to be
3262 * coupled, we have to disable the status mmap for old alsa-lib, too.
3264 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3265 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3270 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3272 if (pcm_file->no_compat_mmap)
3274 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3275 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3276 * thus it effectively assures the manual update of appl_ptr.
3278 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3283 #else /* ! coherent mmap */
3285 * don't support mmap for status and control records.
3287 #define pcm_status_mmap_allowed(pcm_file) false
3288 #define pcm_control_mmap_allowed(pcm_file) false
3290 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3291 struct vm_area_struct *area)
3295 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3296 struct vm_area_struct *area)
3300 #endif /* coherent mmap */
3302 static inline struct page *
3303 snd_pcm_default_page_ops(struct snd_pcm_substream *substream, unsigned long ofs)
3305 void *vaddr = substream->runtime->dma_area + ofs;
3306 return virt_to_page(vaddr);
3310 * fault callback for mmapping a RAM page
3312 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3314 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3315 struct snd_pcm_runtime *runtime;
3316 unsigned long offset;
3320 if (substream == NULL)
3321 return VM_FAULT_SIGBUS;
3322 runtime = substream->runtime;
3323 offset = vmf->pgoff << PAGE_SHIFT;
3324 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3325 if (offset > dma_bytes - PAGE_SIZE)
3326 return VM_FAULT_SIGBUS;
3327 if (substream->ops->page)
3328 page = substream->ops->page(substream, offset);
3330 page = snd_pcm_default_page_ops(substream, offset);
3332 return VM_FAULT_SIGBUS;
3338 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3339 .open = snd_pcm_mmap_data_open,
3340 .close = snd_pcm_mmap_data_close,
3343 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3344 .open = snd_pcm_mmap_data_open,
3345 .close = snd_pcm_mmap_data_close,
3346 .fault = snd_pcm_mmap_data_fault,
3350 * mmap the DMA buffer on RAM
3354 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3355 * @substream: PCM substream
3358 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3359 * this function is invoked implicitly.
3361 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3362 struct vm_area_struct *area)
3364 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3365 #ifdef CONFIG_GENERIC_ALLOCATOR
3366 if (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_IRAM) {
3367 area->vm_page_prot = pgprot_writecombine(area->vm_page_prot);
3368 return remap_pfn_range(area, area->vm_start,
3369 substream->dma_buffer.addr >> PAGE_SHIFT,
3370 area->vm_end - area->vm_start, area->vm_page_prot);
3372 #endif /* CONFIG_GENERIC_ALLOCATOR */
3373 #ifndef CONFIG_X86 /* for avoiding warnings arch/x86/mm/pat.c */
3374 if (IS_ENABLED(CONFIG_HAS_DMA) && !substream->ops->page &&
3375 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV)
3376 return dma_mmap_coherent(substream->dma_buffer.dev.dev,
3378 substream->runtime->dma_area,
3379 substream->runtime->dma_addr,
3380 substream->runtime->dma_bytes);
3381 #endif /* CONFIG_X86 */
3382 /* mmap with fault handler */
3383 area->vm_ops = &snd_pcm_vm_ops_data_fault;
3386 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3389 * mmap the DMA buffer on I/O memory area
3391 #if SNDRV_PCM_INFO_MMAP_IOMEM
3393 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3394 * @substream: PCM substream
3397 * When your hardware uses the iomapped pages as the hardware buffer and
3398 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3399 * is supposed to work only on limited architectures.
3401 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3402 struct vm_area_struct *area)
3404 struct snd_pcm_runtime *runtime = substream->runtime;
3406 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3407 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3409 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3410 #endif /* SNDRV_PCM_INFO_MMAP */
3415 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3416 struct vm_area_struct *area)
3418 struct snd_pcm_runtime *runtime;
3420 unsigned long offset;
3424 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3425 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3428 if (!(area->vm_flags & VM_READ))
3431 runtime = substream->runtime;
3432 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3434 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3436 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3437 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3439 size = area->vm_end - area->vm_start;
3440 offset = area->vm_pgoff << PAGE_SHIFT;
3441 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3442 if ((size_t)size > dma_bytes)
3444 if (offset > dma_bytes - size)
3447 area->vm_ops = &snd_pcm_vm_ops_data;
3448 area->vm_private_data = substream;
3449 if (substream->ops->mmap)
3450 err = substream->ops->mmap(substream, area);
3452 err = snd_pcm_lib_default_mmap(substream, area);
3454 atomic_inc(&substream->mmap_count);
3457 EXPORT_SYMBOL(snd_pcm_mmap_data);
3459 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3461 struct snd_pcm_file * pcm_file;
3462 struct snd_pcm_substream *substream;
3463 unsigned long offset;
3465 pcm_file = file->private_data;
3466 substream = pcm_file->substream;
3467 if (PCM_RUNTIME_CHECK(substream))
3470 offset = area->vm_pgoff << PAGE_SHIFT;
3472 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3473 if (!pcm_status_mmap_allowed(pcm_file))
3475 return snd_pcm_mmap_status(substream, file, area);
3476 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3477 if (!pcm_control_mmap_allowed(pcm_file))
3479 return snd_pcm_mmap_control(substream, file, area);
3481 return snd_pcm_mmap_data(substream, file, area);
3486 static int snd_pcm_fasync(int fd, struct file * file, int on)
3488 struct snd_pcm_file * pcm_file;
3489 struct snd_pcm_substream *substream;
3490 struct snd_pcm_runtime *runtime;
3492 pcm_file = file->private_data;
3493 substream = pcm_file->substream;
3494 if (PCM_RUNTIME_CHECK(substream))
3496 runtime = substream->runtime;
3497 return fasync_helper(fd, file, on, &runtime->fasync);
3503 #ifdef CONFIG_COMPAT
3504 #include "pcm_compat.c"
3506 #define snd_pcm_ioctl_compat NULL
3510 * To be removed helpers to keep binary compatibility
3513 #ifdef CONFIG_SND_SUPPORT_OLD_API
3514 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3515 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3517 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3518 struct snd_pcm_hw_params_old *oparams)
3522 memset(params, 0, sizeof(*params));
3523 params->flags = oparams->flags;
3524 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3525 params->masks[i].bits[0] = oparams->masks[i];
3526 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3527 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3528 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3529 params->info = oparams->info;
3530 params->msbits = oparams->msbits;
3531 params->rate_num = oparams->rate_num;
3532 params->rate_den = oparams->rate_den;
3533 params->fifo_size = oparams->fifo_size;
3536 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3537 struct snd_pcm_hw_params *params)
3541 memset(oparams, 0, sizeof(*oparams));
3542 oparams->flags = params->flags;
3543 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3544 oparams->masks[i] = params->masks[i].bits[0];
3545 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3546 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3547 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3548 oparams->info = params->info;
3549 oparams->msbits = params->msbits;
3550 oparams->rate_num = params->rate_num;
3551 oparams->rate_den = params->rate_den;
3552 oparams->fifo_size = params->fifo_size;
3555 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3556 struct snd_pcm_hw_params_old __user * _oparams)
3558 struct snd_pcm_hw_params *params;
3559 struct snd_pcm_hw_params_old *oparams = NULL;
3562 params = kmalloc(sizeof(*params), GFP_KERNEL);
3566 oparams = memdup_user(_oparams, sizeof(*oparams));
3567 if (IS_ERR(oparams)) {
3568 err = PTR_ERR(oparams);
3571 snd_pcm_hw_convert_from_old_params(params, oparams);
3572 err = snd_pcm_hw_refine(substream, params);
3576 err = fixup_unreferenced_params(substream, params);
3580 snd_pcm_hw_convert_to_old_params(oparams, params);
3581 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3590 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
3591 struct snd_pcm_hw_params_old __user * _oparams)
3593 struct snd_pcm_hw_params *params;
3594 struct snd_pcm_hw_params_old *oparams = NULL;
3597 params = kmalloc(sizeof(*params), GFP_KERNEL);
3601 oparams = memdup_user(_oparams, sizeof(*oparams));
3602 if (IS_ERR(oparams)) {
3603 err = PTR_ERR(oparams);
3607 snd_pcm_hw_convert_from_old_params(params, oparams);
3608 err = snd_pcm_hw_params(substream, params);
3612 snd_pcm_hw_convert_to_old_params(oparams, params);
3613 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3621 #endif /* CONFIG_SND_SUPPORT_OLD_API */
3624 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
3627 unsigned long pgoff,
3628 unsigned long flags)
3630 struct snd_pcm_file *pcm_file = file->private_data;
3631 struct snd_pcm_substream *substream = pcm_file->substream;
3632 struct snd_pcm_runtime *runtime = substream->runtime;
3633 unsigned long offset = pgoff << PAGE_SHIFT;
3636 case SNDRV_PCM_MMAP_OFFSET_STATUS:
3637 return (unsigned long)runtime->status;
3638 case SNDRV_PCM_MMAP_OFFSET_CONTROL:
3639 return (unsigned long)runtime->control;
3641 return (unsigned long)runtime->dma_area + offset;
3645 # define snd_pcm_get_unmapped_area NULL
3652 const struct file_operations snd_pcm_f_ops[2] = {
3654 .owner = THIS_MODULE,
3655 .write = snd_pcm_write,
3656 .write_iter = snd_pcm_writev,
3657 .open = snd_pcm_playback_open,
3658 .release = snd_pcm_release,
3659 .llseek = no_llseek,
3660 .poll = snd_pcm_poll,
3661 .unlocked_ioctl = snd_pcm_ioctl,
3662 .compat_ioctl = snd_pcm_ioctl_compat,
3663 .mmap = snd_pcm_mmap,
3664 .fasync = snd_pcm_fasync,
3665 .get_unmapped_area = snd_pcm_get_unmapped_area,
3668 .owner = THIS_MODULE,
3669 .read = snd_pcm_read,
3670 .read_iter = snd_pcm_readv,
3671 .open = snd_pcm_capture_open,
3672 .release = snd_pcm_release,
3673 .llseek = no_llseek,
3674 .poll = snd_pcm_poll,
3675 .unlocked_ioctl = snd_pcm_ioctl,
3676 .compat_ioctl = snd_pcm_ioctl_compat,
3677 .mmap = snd_pcm_mmap,
3678 .fasync = snd_pcm_fasync,
3679 .get_unmapped_area = snd_pcm_get_unmapped_area,