2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4 * Abramo Bagnara <abramo@alsa-project.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/slab.h>
24 #include <linux/sched/signal.h>
25 #include <linux/time.h>
26 #include <linux/math64.h>
27 #include <linux/export.h>
28 #include <sound/core.h>
29 #include <sound/control.h>
30 #include <sound/tlv.h>
31 #include <sound/info.h>
32 #include <sound/pcm.h>
33 #include <sound/pcm_params.h>
34 #include <sound/timer.h>
36 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
37 #define CREATE_TRACE_POINTS
38 #include "pcm_trace.h"
40 #define trace_hwptr(substream, pos, in_interrupt)
41 #define trace_xrun(substream)
42 #define trace_hw_ptr_error(substream, reason)
46 * fill ring buffer with silence
47 * runtime->silence_start: starting pointer to silence area
48 * runtime->silence_filled: size filled with silence
49 * runtime->silence_threshold: threshold from application
50 * runtime->silence_size: maximal size from application
52 * when runtime->silence_size >= runtime->boundary - fill processed area with silence immediately
54 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
56 struct snd_pcm_runtime *runtime = substream->runtime;
57 snd_pcm_uframes_t frames, ofs, transfer;
59 if (runtime->silence_size < runtime->boundary) {
60 snd_pcm_sframes_t noise_dist, n;
61 if (runtime->silence_start != runtime->control->appl_ptr) {
62 n = runtime->control->appl_ptr - runtime->silence_start;
64 n += runtime->boundary;
65 if ((snd_pcm_uframes_t)n < runtime->silence_filled)
66 runtime->silence_filled -= n;
68 runtime->silence_filled = 0;
69 runtime->silence_start = runtime->control->appl_ptr;
71 if (runtime->silence_filled >= runtime->buffer_size)
73 noise_dist = snd_pcm_playback_hw_avail(runtime) + runtime->silence_filled;
74 if (noise_dist >= (snd_pcm_sframes_t) runtime->silence_threshold)
76 frames = runtime->silence_threshold - noise_dist;
77 if (frames > runtime->silence_size)
78 frames = runtime->silence_size;
80 if (new_hw_ptr == ULONG_MAX) { /* initialization */
81 snd_pcm_sframes_t avail = snd_pcm_playback_hw_avail(runtime);
82 if (avail > runtime->buffer_size)
83 avail = runtime->buffer_size;
84 runtime->silence_filled = avail > 0 ? avail : 0;
85 runtime->silence_start = (runtime->status->hw_ptr +
86 runtime->silence_filled) %
89 ofs = runtime->status->hw_ptr;
90 frames = new_hw_ptr - ofs;
91 if ((snd_pcm_sframes_t)frames < 0)
92 frames += runtime->boundary;
93 runtime->silence_filled -= frames;
94 if ((snd_pcm_sframes_t)runtime->silence_filled < 0) {
95 runtime->silence_filled = 0;
96 runtime->silence_start = new_hw_ptr;
98 runtime->silence_start = ofs;
101 frames = runtime->buffer_size - runtime->silence_filled;
103 if (snd_BUG_ON(frames > runtime->buffer_size))
107 ofs = runtime->silence_start % runtime->buffer_size;
109 transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
110 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
111 runtime->access == SNDRV_PCM_ACCESS_MMAP_INTERLEAVED) {
112 if (substream->ops->silence) {
114 err = substream->ops->silence(substream, -1, ofs, transfer);
117 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, ofs);
118 snd_pcm_format_set_silence(runtime->format, hwbuf, transfer * runtime->channels);
122 unsigned int channels = runtime->channels;
123 if (substream->ops->silence) {
124 for (c = 0; c < channels; ++c) {
126 err = substream->ops->silence(substream, c, ofs, transfer);
130 size_t dma_csize = runtime->dma_bytes / channels;
131 for (c = 0; c < channels; ++c) {
132 char *hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, ofs);
133 snd_pcm_format_set_silence(runtime->format, hwbuf, transfer);
137 runtime->silence_filled += transfer;
143 #ifdef CONFIG_SND_DEBUG
144 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
145 char *name, size_t len)
147 snprintf(name, len, "pcmC%dD%d%c:%d",
148 substream->pcm->card->number,
149 substream->pcm->device,
150 substream->stream ? 'c' : 'p',
153 EXPORT_SYMBOL(snd_pcm_debug_name);
156 #define XRUN_DEBUG_BASIC (1<<0)
157 #define XRUN_DEBUG_STACK (1<<1) /* dump also stack */
158 #define XRUN_DEBUG_JIFFIESCHECK (1<<2) /* do jiffies check */
160 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
162 #define xrun_debug(substream, mask) \
163 ((substream)->pstr->xrun_debug & (mask))
165 #define xrun_debug(substream, mask) 0
168 #define dump_stack_on_xrun(substream) do { \
169 if (xrun_debug(substream, XRUN_DEBUG_STACK)) \
173 static void xrun(struct snd_pcm_substream *substream)
175 struct snd_pcm_runtime *runtime = substream->runtime;
177 trace_xrun(substream);
178 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
179 snd_pcm_gettime(runtime, (struct timespec *)&runtime->status->tstamp);
180 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
181 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
183 snd_pcm_debug_name(substream, name, sizeof(name));
184 pcm_warn(substream->pcm, "XRUN: %s\n", name);
185 dump_stack_on_xrun(substream);
189 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
190 #define hw_ptr_error(substream, in_interrupt, reason, fmt, args...) \
192 trace_hw_ptr_error(substream, reason); \
193 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) { \
194 pr_err_ratelimited("ALSA: PCM: [%c] " reason ": " fmt, \
195 (in_interrupt) ? 'Q' : 'P', ##args); \
196 dump_stack_on_xrun(substream); \
200 #else /* ! CONFIG_SND_PCM_XRUN_DEBUG */
202 #define hw_ptr_error(substream, fmt, args...) do { } while (0)
206 int snd_pcm_update_state(struct snd_pcm_substream *substream,
207 struct snd_pcm_runtime *runtime)
209 snd_pcm_uframes_t avail;
211 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
212 avail = snd_pcm_playback_avail(runtime);
214 avail = snd_pcm_capture_avail(runtime);
215 if (avail > runtime->avail_max)
216 runtime->avail_max = avail;
217 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
218 if (avail >= runtime->buffer_size) {
219 snd_pcm_drain_done(substream);
223 if (avail >= runtime->stop_threshold) {
228 if (runtime->twake) {
229 if (avail >= runtime->twake)
230 wake_up(&runtime->tsleep);
231 } else if (avail >= runtime->control->avail_min)
232 wake_up(&runtime->sleep);
236 static void update_audio_tstamp(struct snd_pcm_substream *substream,
237 struct timespec *curr_tstamp,
238 struct timespec *audio_tstamp)
240 struct snd_pcm_runtime *runtime = substream->runtime;
241 u64 audio_frames, audio_nsecs;
242 struct timespec driver_tstamp;
244 if (runtime->tstamp_mode != SNDRV_PCM_TSTAMP_ENABLE)
247 if (!(substream->ops->get_time_info) ||
248 (runtime->audio_tstamp_report.actual_type ==
249 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
252 * provide audio timestamp derived from pointer position
253 * add delay only if requested
256 audio_frames = runtime->hw_ptr_wrap + runtime->status->hw_ptr;
258 if (runtime->audio_tstamp_config.report_delay) {
259 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
260 audio_frames -= runtime->delay;
262 audio_frames += runtime->delay;
264 audio_nsecs = div_u64(audio_frames * 1000000000LL,
266 *audio_tstamp = ns_to_timespec(audio_nsecs);
268 runtime->status->audio_tstamp = *audio_tstamp;
269 runtime->status->tstamp = *curr_tstamp;
272 * re-take a driver timestamp to let apps detect if the reference tstamp
273 * read by low-level hardware was provided with a delay
275 snd_pcm_gettime(substream->runtime, (struct timespec *)&driver_tstamp);
276 runtime->driver_tstamp = driver_tstamp;
279 static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
280 unsigned int in_interrupt)
282 struct snd_pcm_runtime *runtime = substream->runtime;
283 snd_pcm_uframes_t pos;
284 snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
285 snd_pcm_sframes_t hdelta, delta;
286 unsigned long jdelta;
287 unsigned long curr_jiffies;
288 struct timespec curr_tstamp;
289 struct timespec audio_tstamp;
290 int crossed_boundary = 0;
292 old_hw_ptr = runtime->status->hw_ptr;
295 * group pointer, time and jiffies reads to allow for more
296 * accurate correlations/corrections.
297 * The values are stored at the end of this routine after
298 * corrections for hw_ptr position
300 pos = substream->ops->pointer(substream);
301 curr_jiffies = jiffies;
302 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
303 if ((substream->ops->get_time_info) &&
304 (runtime->audio_tstamp_config.type_requested != SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
305 substream->ops->get_time_info(substream, &curr_tstamp,
307 &runtime->audio_tstamp_config,
308 &runtime->audio_tstamp_report);
310 /* re-test in case tstamp type is not supported in hardware and was demoted to DEFAULT */
311 if (runtime->audio_tstamp_report.actual_type == SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)
312 snd_pcm_gettime(runtime, (struct timespec *)&curr_tstamp);
314 snd_pcm_gettime(runtime, (struct timespec *)&curr_tstamp);
317 if (pos == SNDRV_PCM_POS_XRUN) {
321 if (pos >= runtime->buffer_size) {
322 if (printk_ratelimit()) {
324 snd_pcm_debug_name(substream, name, sizeof(name));
325 pcm_err(substream->pcm,
326 "invalid position: %s, pos = %ld, buffer size = %ld, period size = %ld\n",
327 name, pos, runtime->buffer_size,
328 runtime->period_size);
332 pos -= pos % runtime->min_align;
333 trace_hwptr(substream, pos, in_interrupt);
334 hw_base = runtime->hw_ptr_base;
335 new_hw_ptr = hw_base + pos;
337 /* we know that one period was processed */
338 /* delta = "expected next hw_ptr" for in_interrupt != 0 */
339 delta = runtime->hw_ptr_interrupt + runtime->period_size;
340 if (delta > new_hw_ptr) {
341 /* check for double acknowledged interrupts */
342 hdelta = curr_jiffies - runtime->hw_ptr_jiffies;
343 if (hdelta > runtime->hw_ptr_buffer_jiffies/2 + 1) {
344 hw_base += runtime->buffer_size;
345 if (hw_base >= runtime->boundary) {
349 new_hw_ptr = hw_base + pos;
354 /* new_hw_ptr might be lower than old_hw_ptr in case when */
355 /* pointer crosses the end of the ring buffer */
356 if (new_hw_ptr < old_hw_ptr) {
357 hw_base += runtime->buffer_size;
358 if (hw_base >= runtime->boundary) {
362 new_hw_ptr = hw_base + pos;
365 delta = new_hw_ptr - old_hw_ptr;
367 delta += runtime->boundary;
369 if (runtime->no_period_wakeup) {
370 snd_pcm_sframes_t xrun_threshold;
372 * Without regular period interrupts, we have to check
373 * the elapsed time to detect xruns.
375 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
376 if (jdelta < runtime->hw_ptr_buffer_jiffies / 2)
378 hdelta = jdelta - delta * HZ / runtime->rate;
379 xrun_threshold = runtime->hw_ptr_buffer_jiffies / 2 + 1;
380 while (hdelta > xrun_threshold) {
381 delta += runtime->buffer_size;
382 hw_base += runtime->buffer_size;
383 if (hw_base >= runtime->boundary) {
387 new_hw_ptr = hw_base + pos;
388 hdelta -= runtime->hw_ptr_buffer_jiffies;
393 /* something must be really wrong */
394 if (delta >= runtime->buffer_size + runtime->period_size) {
395 hw_ptr_error(substream, in_interrupt, "Unexpected hw_ptr",
396 "(stream=%i, pos=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
397 substream->stream, (long)pos,
398 (long)new_hw_ptr, (long)old_hw_ptr);
402 /* Do jiffies check only in xrun_debug mode */
403 if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
404 goto no_jiffies_check;
406 /* Skip the jiffies check for hardwares with BATCH flag.
407 * Such hardware usually just increases the position at each IRQ,
408 * thus it can't give any strange position.
410 if (runtime->hw.info & SNDRV_PCM_INFO_BATCH)
411 goto no_jiffies_check;
413 if (hdelta < runtime->delay)
414 goto no_jiffies_check;
415 hdelta -= runtime->delay;
416 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
417 if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
419 (((runtime->period_size * HZ) / runtime->rate)
421 /* move new_hw_ptr according jiffies not pos variable */
422 new_hw_ptr = old_hw_ptr;
424 /* use loop to avoid checks for delta overflows */
425 /* the delta value is small or zero in most cases */
427 new_hw_ptr += runtime->period_size;
428 if (new_hw_ptr >= runtime->boundary) {
429 new_hw_ptr -= runtime->boundary;
434 /* align hw_base to buffer_size */
435 hw_ptr_error(substream, in_interrupt, "hw_ptr skipping",
436 "(pos=%ld, delta=%ld, period=%ld, jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
437 (long)pos, (long)hdelta,
438 (long)runtime->period_size, jdelta,
439 ((hdelta * HZ) / runtime->rate), hw_base,
440 (unsigned long)old_hw_ptr,
441 (unsigned long)new_hw_ptr);
442 /* reset values to proper state */
444 hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
447 if (delta > runtime->period_size + runtime->period_size / 2) {
448 hw_ptr_error(substream, in_interrupt,
450 "(stream=%i, delta=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
451 substream->stream, (long)delta,
457 if (runtime->status->hw_ptr == new_hw_ptr) {
458 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
462 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
463 runtime->silence_size > 0)
464 snd_pcm_playback_silence(substream, new_hw_ptr);
467 delta = new_hw_ptr - runtime->hw_ptr_interrupt;
469 delta += runtime->boundary;
470 delta -= (snd_pcm_uframes_t)delta % runtime->period_size;
471 runtime->hw_ptr_interrupt += delta;
472 if (runtime->hw_ptr_interrupt >= runtime->boundary)
473 runtime->hw_ptr_interrupt -= runtime->boundary;
475 runtime->hw_ptr_base = hw_base;
476 runtime->status->hw_ptr = new_hw_ptr;
477 runtime->hw_ptr_jiffies = curr_jiffies;
478 if (crossed_boundary) {
479 snd_BUG_ON(crossed_boundary != 1);
480 runtime->hw_ptr_wrap += runtime->boundary;
483 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
485 return snd_pcm_update_state(substream, runtime);
488 /* CAUTION: call it with irq disabled */
489 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
491 return snd_pcm_update_hw_ptr0(substream, 0);
495 * snd_pcm_set_ops - set the PCM operators
496 * @pcm: the pcm instance
497 * @direction: stream direction, SNDRV_PCM_STREAM_XXX
498 * @ops: the operator table
500 * Sets the given PCM operators to the pcm instance.
502 void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
503 const struct snd_pcm_ops *ops)
505 struct snd_pcm_str *stream = &pcm->streams[direction];
506 struct snd_pcm_substream *substream;
508 for (substream = stream->substream; substream != NULL; substream = substream->next)
509 substream->ops = ops;
512 EXPORT_SYMBOL(snd_pcm_set_ops);
515 * snd_pcm_sync - set the PCM sync id
516 * @substream: the pcm substream
518 * Sets the PCM sync identifier for the card.
520 void snd_pcm_set_sync(struct snd_pcm_substream *substream)
522 struct snd_pcm_runtime *runtime = substream->runtime;
524 runtime->sync.id32[0] = substream->pcm->card->number;
525 runtime->sync.id32[1] = -1;
526 runtime->sync.id32[2] = -1;
527 runtime->sync.id32[3] = -1;
530 EXPORT_SYMBOL(snd_pcm_set_sync);
533 * Standard ioctl routine
536 static inline unsigned int div32(unsigned int a, unsigned int b,
547 static inline unsigned int div_down(unsigned int a, unsigned int b)
554 static inline unsigned int div_up(unsigned int a, unsigned int b)
566 static inline unsigned int mul(unsigned int a, unsigned int b)
570 if (div_down(UINT_MAX, a) < b)
575 static inline unsigned int muldiv32(unsigned int a, unsigned int b,
576 unsigned int c, unsigned int *r)
578 u_int64_t n = (u_int64_t) a * b;
584 n = div_u64_rem(n, c, r);
593 * snd_interval_refine - refine the interval value of configurator
594 * @i: the interval value to refine
595 * @v: the interval value to refer to
597 * Refines the interval value with the reference value.
598 * The interval is changed to the range satisfying both intervals.
599 * The interval status (min, max, integer, etc.) are evaluated.
601 * Return: Positive if the value is changed, zero if it's not changed, or a
602 * negative error code.
604 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
607 if (snd_BUG_ON(snd_interval_empty(i)))
609 if (i->min < v->min) {
611 i->openmin = v->openmin;
613 } else if (i->min == v->min && !i->openmin && v->openmin) {
617 if (i->max > v->max) {
619 i->openmax = v->openmax;
621 } else if (i->max == v->max && !i->openmax && v->openmax) {
625 if (!i->integer && v->integer) {
638 } else if (!i->openmin && !i->openmax && i->min == i->max)
640 if (snd_interval_checkempty(i)) {
641 snd_interval_none(i);
647 EXPORT_SYMBOL(snd_interval_refine);
649 static int snd_interval_refine_first(struct snd_interval *i)
651 if (snd_BUG_ON(snd_interval_empty(i)))
653 if (snd_interval_single(i))
656 i->openmax = i->openmin;
662 static int snd_interval_refine_last(struct snd_interval *i)
664 if (snd_BUG_ON(snd_interval_empty(i)))
666 if (snd_interval_single(i))
669 i->openmin = i->openmax;
675 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
677 if (a->empty || b->empty) {
678 snd_interval_none(c);
682 c->min = mul(a->min, b->min);
683 c->openmin = (a->openmin || b->openmin);
684 c->max = mul(a->max, b->max);
685 c->openmax = (a->openmax || b->openmax);
686 c->integer = (a->integer && b->integer);
690 * snd_interval_div - refine the interval value with division
697 * Returns non-zero if the value is changed, zero if not changed.
699 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
702 if (a->empty || b->empty) {
703 snd_interval_none(c);
707 c->min = div32(a->min, b->max, &r);
708 c->openmin = (r || a->openmin || b->openmax);
710 c->max = div32(a->max, b->min, &r);
715 c->openmax = (a->openmax || b->openmin);
724 * snd_interval_muldivk - refine the interval value
727 * @k: divisor (as integer)
732 * Returns non-zero if the value is changed, zero if not changed.
734 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
735 unsigned int k, struct snd_interval *c)
738 if (a->empty || b->empty) {
739 snd_interval_none(c);
743 c->min = muldiv32(a->min, b->min, k, &r);
744 c->openmin = (r || a->openmin || b->openmin);
745 c->max = muldiv32(a->max, b->max, k, &r);
750 c->openmax = (a->openmax || b->openmax);
755 * snd_interval_mulkdiv - refine the interval value
757 * @k: dividend 2 (as integer)
763 * Returns non-zero if the value is changed, zero if not changed.
765 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
766 const struct snd_interval *b, struct snd_interval *c)
769 if (a->empty || b->empty) {
770 snd_interval_none(c);
774 c->min = muldiv32(a->min, k, b->max, &r);
775 c->openmin = (r || a->openmin || b->openmax);
777 c->max = muldiv32(a->max, k, b->min, &r);
782 c->openmax = (a->openmax || b->openmin);
794 * snd_interval_ratnum - refine the interval value
795 * @i: interval to refine
796 * @rats_count: number of ratnum_t
797 * @rats: ratnum_t array
798 * @nump: pointer to store the resultant numerator
799 * @denp: pointer to store the resultant denominator
801 * Return: Positive if the value is changed, zero if it's not changed, or a
802 * negative error code.
804 int snd_interval_ratnum(struct snd_interval *i,
805 unsigned int rats_count, const struct snd_ratnum *rats,
806 unsigned int *nump, unsigned int *denp)
808 unsigned int best_num, best_den;
811 struct snd_interval t;
813 unsigned int result_num, result_den;
816 best_num = best_den = best_diff = 0;
817 for (k = 0; k < rats_count; ++k) {
818 unsigned int num = rats[k].num;
820 unsigned int q = i->min;
824 den = div_up(num, q);
825 if (den < rats[k].den_min)
827 if (den > rats[k].den_max)
828 den = rats[k].den_max;
831 r = (den - rats[k].den_min) % rats[k].den_step;
835 diff = num - q * den;
839 diff * best_den < best_diff * den) {
849 t.min = div_down(best_num, best_den);
850 t.openmin = !!(best_num % best_den);
852 result_num = best_num;
853 result_diff = best_diff;
854 result_den = best_den;
855 best_num = best_den = best_diff = 0;
856 for (k = 0; k < rats_count; ++k) {
857 unsigned int num = rats[k].num;
859 unsigned int q = i->max;
865 den = div_down(num, q);
866 if (den > rats[k].den_max)
868 if (den < rats[k].den_min)
869 den = rats[k].den_min;
872 r = (den - rats[k].den_min) % rats[k].den_step;
874 den += rats[k].den_step - r;
876 diff = q * den - num;
880 diff * best_den < best_diff * den) {
890 t.max = div_up(best_num, best_den);
891 t.openmax = !!(best_num % best_den);
893 err = snd_interval_refine(i, &t);
897 if (snd_interval_single(i)) {
898 if (best_diff * result_den < result_diff * best_den) {
899 result_num = best_num;
900 result_den = best_den;
910 EXPORT_SYMBOL(snd_interval_ratnum);
913 * snd_interval_ratden - refine the interval value
914 * @i: interval to refine
915 * @rats_count: number of struct ratden
916 * @rats: struct ratden array
917 * @nump: pointer to store the resultant numerator
918 * @denp: pointer to store the resultant denominator
920 * Return: Positive if the value is changed, zero if it's not changed, or a
921 * negative error code.
923 static int snd_interval_ratden(struct snd_interval *i,
924 unsigned int rats_count,
925 const struct snd_ratden *rats,
926 unsigned int *nump, unsigned int *denp)
928 unsigned int best_num, best_diff, best_den;
930 struct snd_interval t;
933 best_num = best_den = best_diff = 0;
934 for (k = 0; k < rats_count; ++k) {
936 unsigned int den = rats[k].den;
937 unsigned int q = i->min;
940 if (num > rats[k].num_max)
942 if (num < rats[k].num_min)
943 num = rats[k].num_max;
946 r = (num - rats[k].num_min) % rats[k].num_step;
948 num += rats[k].num_step - r;
950 diff = num - q * den;
952 diff * best_den < best_diff * den) {
962 t.min = div_down(best_num, best_den);
963 t.openmin = !!(best_num % best_den);
965 best_num = best_den = best_diff = 0;
966 for (k = 0; k < rats_count; ++k) {
968 unsigned int den = rats[k].den;
969 unsigned int q = i->max;
972 if (num < rats[k].num_min)
974 if (num > rats[k].num_max)
975 num = rats[k].num_max;
978 r = (num - rats[k].num_min) % rats[k].num_step;
982 diff = q * den - num;
984 diff * best_den < best_diff * den) {
994 t.max = div_up(best_num, best_den);
995 t.openmax = !!(best_num % best_den);
997 err = snd_interval_refine(i, &t);
1001 if (snd_interval_single(i)) {
1011 * snd_interval_list - refine the interval value from the list
1012 * @i: the interval value to refine
1013 * @count: the number of elements in the list
1014 * @list: the value list
1015 * @mask: the bit-mask to evaluate
1017 * Refines the interval value from the list.
1018 * When mask is non-zero, only the elements corresponding to bit 1 are
1021 * Return: Positive if the value is changed, zero if it's not changed, or a
1022 * negative error code.
1024 int snd_interval_list(struct snd_interval *i, unsigned int count,
1025 const unsigned int *list, unsigned int mask)
1028 struct snd_interval list_range;
1034 snd_interval_any(&list_range);
1035 list_range.min = UINT_MAX;
1037 for (k = 0; k < count; k++) {
1038 if (mask && !(mask & (1 << k)))
1040 if (!snd_interval_test(i, list[k]))
1042 list_range.min = min(list_range.min, list[k]);
1043 list_range.max = max(list_range.max, list[k]);
1045 return snd_interval_refine(i, &list_range);
1048 EXPORT_SYMBOL(snd_interval_list);
1051 * snd_interval_ranges - refine the interval value from the list of ranges
1052 * @i: the interval value to refine
1053 * @count: the number of elements in the list of ranges
1054 * @ranges: the ranges list
1055 * @mask: the bit-mask to evaluate
1057 * Refines the interval value from the list of ranges.
1058 * When mask is non-zero, only the elements corresponding to bit 1 are
1061 * Return: Positive if the value is changed, zero if it's not changed, or a
1062 * negative error code.
1064 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
1065 const struct snd_interval *ranges, unsigned int mask)
1068 struct snd_interval range_union;
1069 struct snd_interval range;
1072 snd_interval_none(i);
1075 snd_interval_any(&range_union);
1076 range_union.min = UINT_MAX;
1077 range_union.max = 0;
1078 for (k = 0; k < count; k++) {
1079 if (mask && !(mask & (1 << k)))
1081 snd_interval_copy(&range, &ranges[k]);
1082 if (snd_interval_refine(&range, i) < 0)
1084 if (snd_interval_empty(&range))
1087 if (range.min < range_union.min) {
1088 range_union.min = range.min;
1089 range_union.openmin = 1;
1091 if (range.min == range_union.min && !range.openmin)
1092 range_union.openmin = 0;
1093 if (range.max > range_union.max) {
1094 range_union.max = range.max;
1095 range_union.openmax = 1;
1097 if (range.max == range_union.max && !range.openmax)
1098 range_union.openmax = 0;
1100 return snd_interval_refine(i, &range_union);
1102 EXPORT_SYMBOL(snd_interval_ranges);
1104 static int snd_interval_step(struct snd_interval *i, unsigned int step)
1109 if (n != 0 || i->openmin) {
1115 if (n != 0 || i->openmax) {
1120 if (snd_interval_checkempty(i)) {
1127 /* Info constraints helpers */
1130 * snd_pcm_hw_rule_add - add the hw-constraint rule
1131 * @runtime: the pcm runtime instance
1132 * @cond: condition bits
1133 * @var: the variable to evaluate
1134 * @func: the evaluation function
1135 * @private: the private data pointer passed to function
1136 * @dep: the dependent variables
1138 * Return: Zero if successful, or a negative error code on failure.
1140 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, unsigned int cond,
1142 snd_pcm_hw_rule_func_t func, void *private,
1145 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1146 struct snd_pcm_hw_rule *c;
1149 va_start(args, dep);
1150 if (constrs->rules_num >= constrs->rules_all) {
1151 struct snd_pcm_hw_rule *new;
1152 unsigned int new_rules = constrs->rules_all + 16;
1153 new = kcalloc(new_rules, sizeof(*c), GFP_KERNEL);
1158 if (constrs->rules) {
1159 memcpy(new, constrs->rules,
1160 constrs->rules_num * sizeof(*c));
1161 kfree(constrs->rules);
1163 constrs->rules = new;
1164 constrs->rules_all = new_rules;
1166 c = &constrs->rules[constrs->rules_num];
1170 c->private = private;
1173 if (snd_BUG_ON(k >= ARRAY_SIZE(c->deps))) {
1180 dep = va_arg(args, int);
1182 constrs->rules_num++;
1187 EXPORT_SYMBOL(snd_pcm_hw_rule_add);
1190 * snd_pcm_hw_constraint_mask - apply the given bitmap mask constraint
1191 * @runtime: PCM runtime instance
1192 * @var: hw_params variable to apply the mask
1193 * @mask: the bitmap mask
1195 * Apply the constraint of the given bitmap mask to a 32-bit mask parameter.
1197 * Return: Zero if successful, or a negative error code on failure.
1199 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1202 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1203 struct snd_mask *maskp = constrs_mask(constrs, var);
1204 *maskp->bits &= mask;
1205 memset(maskp->bits + 1, 0, (SNDRV_MASK_MAX-32) / 8); /* clear rest */
1206 if (*maskp->bits == 0)
1212 * snd_pcm_hw_constraint_mask64 - apply the given bitmap mask constraint
1213 * @runtime: PCM runtime instance
1214 * @var: hw_params variable to apply the mask
1215 * @mask: the 64bit bitmap mask
1217 * Apply the constraint of the given bitmap mask to a 64-bit mask parameter.
1219 * Return: Zero if successful, or a negative error code on failure.
1221 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1224 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1225 struct snd_mask *maskp = constrs_mask(constrs, var);
1226 maskp->bits[0] &= (u_int32_t)mask;
1227 maskp->bits[1] &= (u_int32_t)(mask >> 32);
1228 memset(maskp->bits + 2, 0, (SNDRV_MASK_MAX-64) / 8); /* clear rest */
1229 if (! maskp->bits[0] && ! maskp->bits[1])
1233 EXPORT_SYMBOL(snd_pcm_hw_constraint_mask64);
1236 * snd_pcm_hw_constraint_integer - apply an integer constraint to an interval
1237 * @runtime: PCM runtime instance
1238 * @var: hw_params variable to apply the integer constraint
1240 * Apply the constraint of integer to an interval parameter.
1242 * Return: Positive if the value is changed, zero if it's not changed, or a
1243 * negative error code.
1245 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var)
1247 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1248 return snd_interval_setinteger(constrs_interval(constrs, var));
1251 EXPORT_SYMBOL(snd_pcm_hw_constraint_integer);
1254 * snd_pcm_hw_constraint_minmax - apply a min/max range constraint to an interval
1255 * @runtime: PCM runtime instance
1256 * @var: hw_params variable to apply the range
1257 * @min: the minimal value
1258 * @max: the maximal value
1260 * Apply the min/max range constraint to an interval parameter.
1262 * Return: Positive if the value is changed, zero if it's not changed, or a
1263 * negative error code.
1265 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1266 unsigned int min, unsigned int max)
1268 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1269 struct snd_interval t;
1272 t.openmin = t.openmax = 0;
1274 return snd_interval_refine(constrs_interval(constrs, var), &t);
1277 EXPORT_SYMBOL(snd_pcm_hw_constraint_minmax);
1279 static int snd_pcm_hw_rule_list(struct snd_pcm_hw_params *params,
1280 struct snd_pcm_hw_rule *rule)
1282 struct snd_pcm_hw_constraint_list *list = rule->private;
1283 return snd_interval_list(hw_param_interval(params, rule->var), list->count, list->list, list->mask);
1288 * snd_pcm_hw_constraint_list - apply a list of constraints to a parameter
1289 * @runtime: PCM runtime instance
1290 * @cond: condition bits
1291 * @var: hw_params variable to apply the list constraint
1294 * Apply the list of constraints to an interval parameter.
1296 * Return: Zero if successful, or a negative error code on failure.
1298 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1300 snd_pcm_hw_param_t var,
1301 const struct snd_pcm_hw_constraint_list *l)
1303 return snd_pcm_hw_rule_add(runtime, cond, var,
1304 snd_pcm_hw_rule_list, (void *)l,
1308 EXPORT_SYMBOL(snd_pcm_hw_constraint_list);
1310 static int snd_pcm_hw_rule_ranges(struct snd_pcm_hw_params *params,
1311 struct snd_pcm_hw_rule *rule)
1313 struct snd_pcm_hw_constraint_ranges *r = rule->private;
1314 return snd_interval_ranges(hw_param_interval(params, rule->var),
1315 r->count, r->ranges, r->mask);
1320 * snd_pcm_hw_constraint_ranges - apply list of range constraints to a parameter
1321 * @runtime: PCM runtime instance
1322 * @cond: condition bits
1323 * @var: hw_params variable to apply the list of range constraints
1326 * Apply the list of range constraints to an interval parameter.
1328 * Return: Zero if successful, or a negative error code on failure.
1330 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1332 snd_pcm_hw_param_t var,
1333 const struct snd_pcm_hw_constraint_ranges *r)
1335 return snd_pcm_hw_rule_add(runtime, cond, var,
1336 snd_pcm_hw_rule_ranges, (void *)r,
1339 EXPORT_SYMBOL(snd_pcm_hw_constraint_ranges);
1341 static int snd_pcm_hw_rule_ratnums(struct snd_pcm_hw_params *params,
1342 struct snd_pcm_hw_rule *rule)
1344 const struct snd_pcm_hw_constraint_ratnums *r = rule->private;
1345 unsigned int num = 0, den = 0;
1347 err = snd_interval_ratnum(hw_param_interval(params, rule->var),
1348 r->nrats, r->rats, &num, &den);
1349 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1350 params->rate_num = num;
1351 params->rate_den = den;
1357 * snd_pcm_hw_constraint_ratnums - apply ratnums constraint to a parameter
1358 * @runtime: PCM runtime instance
1359 * @cond: condition bits
1360 * @var: hw_params variable to apply the ratnums constraint
1361 * @r: struct snd_ratnums constriants
1363 * Return: Zero if successful, or a negative error code on failure.
1365 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1367 snd_pcm_hw_param_t var,
1368 const struct snd_pcm_hw_constraint_ratnums *r)
1370 return snd_pcm_hw_rule_add(runtime, cond, var,
1371 snd_pcm_hw_rule_ratnums, (void *)r,
1375 EXPORT_SYMBOL(snd_pcm_hw_constraint_ratnums);
1377 static int snd_pcm_hw_rule_ratdens(struct snd_pcm_hw_params *params,
1378 struct snd_pcm_hw_rule *rule)
1380 const struct snd_pcm_hw_constraint_ratdens *r = rule->private;
1381 unsigned int num = 0, den = 0;
1382 int err = snd_interval_ratden(hw_param_interval(params, rule->var),
1383 r->nrats, r->rats, &num, &den);
1384 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1385 params->rate_num = num;
1386 params->rate_den = den;
1392 * snd_pcm_hw_constraint_ratdens - apply ratdens constraint to a parameter
1393 * @runtime: PCM runtime instance
1394 * @cond: condition bits
1395 * @var: hw_params variable to apply the ratdens constraint
1396 * @r: struct snd_ratdens constriants
1398 * Return: Zero if successful, or a negative error code on failure.
1400 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1402 snd_pcm_hw_param_t var,
1403 const struct snd_pcm_hw_constraint_ratdens *r)
1405 return snd_pcm_hw_rule_add(runtime, cond, var,
1406 snd_pcm_hw_rule_ratdens, (void *)r,
1410 EXPORT_SYMBOL(snd_pcm_hw_constraint_ratdens);
1412 static int snd_pcm_hw_rule_msbits(struct snd_pcm_hw_params *params,
1413 struct snd_pcm_hw_rule *rule)
1415 unsigned int l = (unsigned long) rule->private;
1416 int width = l & 0xffff;
1417 unsigned int msbits = l >> 16;
1418 struct snd_interval *i = hw_param_interval(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
1420 if (!snd_interval_single(i))
1423 if ((snd_interval_value(i) == width) ||
1424 (width == 0 && snd_interval_value(i) > msbits))
1425 params->msbits = min_not_zero(params->msbits, msbits);
1431 * snd_pcm_hw_constraint_msbits - add a hw constraint msbits rule
1432 * @runtime: PCM runtime instance
1433 * @cond: condition bits
1434 * @width: sample bits width
1435 * @msbits: msbits width
1437 * This constraint will set the number of most significant bits (msbits) if a
1438 * sample format with the specified width has been select. If width is set to 0
1439 * the msbits will be set for any sample format with a width larger than the
1442 * Return: Zero if successful, or a negative error code on failure.
1444 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1447 unsigned int msbits)
1449 unsigned long l = (msbits << 16) | width;
1450 return snd_pcm_hw_rule_add(runtime, cond, -1,
1451 snd_pcm_hw_rule_msbits,
1453 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
1456 EXPORT_SYMBOL(snd_pcm_hw_constraint_msbits);
1458 static int snd_pcm_hw_rule_step(struct snd_pcm_hw_params *params,
1459 struct snd_pcm_hw_rule *rule)
1461 unsigned long step = (unsigned long) rule->private;
1462 return snd_interval_step(hw_param_interval(params, rule->var), step);
1466 * snd_pcm_hw_constraint_step - add a hw constraint step rule
1467 * @runtime: PCM runtime instance
1468 * @cond: condition bits
1469 * @var: hw_params variable to apply the step constraint
1472 * Return: Zero if successful, or a negative error code on failure.
1474 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1476 snd_pcm_hw_param_t var,
1479 return snd_pcm_hw_rule_add(runtime, cond, var,
1480 snd_pcm_hw_rule_step, (void *) step,
1484 EXPORT_SYMBOL(snd_pcm_hw_constraint_step);
1486 static int snd_pcm_hw_rule_pow2(struct snd_pcm_hw_params *params, struct snd_pcm_hw_rule *rule)
1488 static unsigned int pow2_sizes[] = {
1489 1<<0, 1<<1, 1<<2, 1<<3, 1<<4, 1<<5, 1<<6, 1<<7,
1490 1<<8, 1<<9, 1<<10, 1<<11, 1<<12, 1<<13, 1<<14, 1<<15,
1491 1<<16, 1<<17, 1<<18, 1<<19, 1<<20, 1<<21, 1<<22, 1<<23,
1492 1<<24, 1<<25, 1<<26, 1<<27, 1<<28, 1<<29, 1<<30
1494 return snd_interval_list(hw_param_interval(params, rule->var),
1495 ARRAY_SIZE(pow2_sizes), pow2_sizes, 0);
1499 * snd_pcm_hw_constraint_pow2 - add a hw constraint power-of-2 rule
1500 * @runtime: PCM runtime instance
1501 * @cond: condition bits
1502 * @var: hw_params variable to apply the power-of-2 constraint
1504 * Return: Zero if successful, or a negative error code on failure.
1506 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1508 snd_pcm_hw_param_t var)
1510 return snd_pcm_hw_rule_add(runtime, cond, var,
1511 snd_pcm_hw_rule_pow2, NULL,
1515 EXPORT_SYMBOL(snd_pcm_hw_constraint_pow2);
1517 static int snd_pcm_hw_rule_noresample_func(struct snd_pcm_hw_params *params,
1518 struct snd_pcm_hw_rule *rule)
1520 unsigned int base_rate = (unsigned int)(uintptr_t)rule->private;
1521 struct snd_interval *rate;
1523 rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1524 return snd_interval_list(rate, 1, &base_rate, 0);
1528 * snd_pcm_hw_rule_noresample - add a rule to allow disabling hw resampling
1529 * @runtime: PCM runtime instance
1530 * @base_rate: the rate at which the hardware does not resample
1532 * Return: Zero if successful, or a negative error code on failure.
1534 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1535 unsigned int base_rate)
1537 return snd_pcm_hw_rule_add(runtime, SNDRV_PCM_HW_PARAMS_NORESAMPLE,
1538 SNDRV_PCM_HW_PARAM_RATE,
1539 snd_pcm_hw_rule_noresample_func,
1540 (void *)(uintptr_t)base_rate,
1541 SNDRV_PCM_HW_PARAM_RATE, -1);
1543 EXPORT_SYMBOL(snd_pcm_hw_rule_noresample);
1545 static void _snd_pcm_hw_param_any(struct snd_pcm_hw_params *params,
1546 snd_pcm_hw_param_t var)
1548 if (hw_is_mask(var)) {
1549 snd_mask_any(hw_param_mask(params, var));
1550 params->cmask |= 1 << var;
1551 params->rmask |= 1 << var;
1554 if (hw_is_interval(var)) {
1555 snd_interval_any(hw_param_interval(params, var));
1556 params->cmask |= 1 << var;
1557 params->rmask |= 1 << var;
1563 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params)
1566 memset(params, 0, sizeof(*params));
1567 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++)
1568 _snd_pcm_hw_param_any(params, k);
1569 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
1570 _snd_pcm_hw_param_any(params, k);
1574 EXPORT_SYMBOL(_snd_pcm_hw_params_any);
1577 * snd_pcm_hw_param_value - return @params field @var value
1578 * @params: the hw_params instance
1579 * @var: parameter to retrieve
1580 * @dir: pointer to the direction (-1,0,1) or %NULL
1582 * Return: The value for field @var if it's fixed in configuration space
1583 * defined by @params. -%EINVAL otherwise.
1585 int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
1586 snd_pcm_hw_param_t var, int *dir)
1588 if (hw_is_mask(var)) {
1589 const struct snd_mask *mask = hw_param_mask_c(params, var);
1590 if (!snd_mask_single(mask))
1594 return snd_mask_value(mask);
1596 if (hw_is_interval(var)) {
1597 const struct snd_interval *i = hw_param_interval_c(params, var);
1598 if (!snd_interval_single(i))
1602 return snd_interval_value(i);
1607 EXPORT_SYMBOL(snd_pcm_hw_param_value);
1609 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params,
1610 snd_pcm_hw_param_t var)
1612 if (hw_is_mask(var)) {
1613 snd_mask_none(hw_param_mask(params, var));
1614 params->cmask |= 1 << var;
1615 params->rmask |= 1 << var;
1616 } else if (hw_is_interval(var)) {
1617 snd_interval_none(hw_param_interval(params, var));
1618 params->cmask |= 1 << var;
1619 params->rmask |= 1 << var;
1625 EXPORT_SYMBOL(_snd_pcm_hw_param_setempty);
1627 static int _snd_pcm_hw_param_first(struct snd_pcm_hw_params *params,
1628 snd_pcm_hw_param_t var)
1631 if (hw_is_mask(var))
1632 changed = snd_mask_refine_first(hw_param_mask(params, var));
1633 else if (hw_is_interval(var))
1634 changed = snd_interval_refine_first(hw_param_interval(params, var));
1638 params->cmask |= 1 << var;
1639 params->rmask |= 1 << var;
1646 * snd_pcm_hw_param_first - refine config space and return minimum value
1647 * @pcm: PCM instance
1648 * @params: the hw_params instance
1649 * @var: parameter to retrieve
1650 * @dir: pointer to the direction (-1,0,1) or %NULL
1652 * Inside configuration space defined by @params remove from @var all
1653 * values > minimum. Reduce configuration space accordingly.
1655 * Return: The minimum, or a negative error code on failure.
1657 int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
1658 struct snd_pcm_hw_params *params,
1659 snd_pcm_hw_param_t var, int *dir)
1661 int changed = _snd_pcm_hw_param_first(params, var);
1664 if (params->rmask) {
1665 int err = snd_pcm_hw_refine(pcm, params);
1666 if (snd_BUG_ON(err < 0))
1669 return snd_pcm_hw_param_value(params, var, dir);
1672 EXPORT_SYMBOL(snd_pcm_hw_param_first);
1674 static int _snd_pcm_hw_param_last(struct snd_pcm_hw_params *params,
1675 snd_pcm_hw_param_t var)
1678 if (hw_is_mask(var))
1679 changed = snd_mask_refine_last(hw_param_mask(params, var));
1680 else if (hw_is_interval(var))
1681 changed = snd_interval_refine_last(hw_param_interval(params, var));
1685 params->cmask |= 1 << var;
1686 params->rmask |= 1 << var;
1693 * snd_pcm_hw_param_last - refine config space and return maximum value
1694 * @pcm: PCM instance
1695 * @params: the hw_params instance
1696 * @var: parameter to retrieve
1697 * @dir: pointer to the direction (-1,0,1) or %NULL
1699 * Inside configuration space defined by @params remove from @var all
1700 * values < maximum. Reduce configuration space accordingly.
1702 * Return: The maximum, or a negative error code on failure.
1704 int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
1705 struct snd_pcm_hw_params *params,
1706 snd_pcm_hw_param_t var, int *dir)
1708 int changed = _snd_pcm_hw_param_last(params, var);
1711 if (params->rmask) {
1712 int err = snd_pcm_hw_refine(pcm, params);
1713 if (snd_BUG_ON(err < 0))
1716 return snd_pcm_hw_param_value(params, var, dir);
1719 EXPORT_SYMBOL(snd_pcm_hw_param_last);
1722 * snd_pcm_hw_param_choose - choose a configuration defined by @params
1723 * @pcm: PCM instance
1724 * @params: the hw_params instance
1726 * Choose one configuration from configuration space defined by @params.
1727 * The configuration chosen is that obtained fixing in this order:
1728 * first access, first format, first subformat, min channels,
1729 * min rate, min period time, max buffer size, min tick time
1731 * Return: Zero if successful, or a negative error code on failure.
1733 int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
1734 struct snd_pcm_hw_params *params)
1736 static int vars[] = {
1737 SNDRV_PCM_HW_PARAM_ACCESS,
1738 SNDRV_PCM_HW_PARAM_FORMAT,
1739 SNDRV_PCM_HW_PARAM_SUBFORMAT,
1740 SNDRV_PCM_HW_PARAM_CHANNELS,
1741 SNDRV_PCM_HW_PARAM_RATE,
1742 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1743 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
1744 SNDRV_PCM_HW_PARAM_TICK_TIME,
1749 for (v = vars; *v != -1; v++) {
1750 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
1751 err = snd_pcm_hw_param_first(pcm, params, *v, NULL);
1753 err = snd_pcm_hw_param_last(pcm, params, *v, NULL);
1754 if (snd_BUG_ON(err < 0))
1760 static int snd_pcm_lib_ioctl_reset(struct snd_pcm_substream *substream,
1763 struct snd_pcm_runtime *runtime = substream->runtime;
1764 unsigned long flags;
1765 snd_pcm_stream_lock_irqsave(substream, flags);
1766 if (snd_pcm_running(substream) &&
1767 snd_pcm_update_hw_ptr(substream) >= 0)
1768 runtime->status->hw_ptr %= runtime->buffer_size;
1770 runtime->status->hw_ptr = 0;
1771 runtime->hw_ptr_wrap = 0;
1773 snd_pcm_stream_unlock_irqrestore(substream, flags);
1777 static int snd_pcm_lib_ioctl_channel_info(struct snd_pcm_substream *substream,
1780 struct snd_pcm_channel_info *info = arg;
1781 struct snd_pcm_runtime *runtime = substream->runtime;
1783 if (!(runtime->info & SNDRV_PCM_INFO_MMAP)) {
1787 width = snd_pcm_format_physical_width(runtime->format);
1791 switch (runtime->access) {
1792 case SNDRV_PCM_ACCESS_MMAP_INTERLEAVED:
1793 case SNDRV_PCM_ACCESS_RW_INTERLEAVED:
1794 info->first = info->channel * width;
1795 info->step = runtime->channels * width;
1797 case SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED:
1798 case SNDRV_PCM_ACCESS_RW_NONINTERLEAVED:
1800 size_t size = runtime->dma_bytes / runtime->channels;
1801 info->first = info->channel * size * 8;
1812 static int snd_pcm_lib_ioctl_fifo_size(struct snd_pcm_substream *substream,
1815 struct snd_pcm_hw_params *params = arg;
1816 snd_pcm_format_t format;
1820 params->fifo_size = substream->runtime->hw.fifo_size;
1821 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_FIFO_IN_FRAMES)) {
1822 format = params_format(params);
1823 channels = params_channels(params);
1824 frame_size = snd_pcm_format_size(format, channels);
1826 params->fifo_size /= (unsigned)frame_size;
1832 * snd_pcm_lib_ioctl - a generic PCM ioctl callback
1833 * @substream: the pcm substream instance
1834 * @cmd: ioctl command
1835 * @arg: ioctl argument
1837 * Processes the generic ioctl commands for PCM.
1838 * Can be passed as the ioctl callback for PCM ops.
1840 * Return: Zero if successful, or a negative error code on failure.
1842 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1843 unsigned int cmd, void *arg)
1846 case SNDRV_PCM_IOCTL1_INFO:
1848 case SNDRV_PCM_IOCTL1_RESET:
1849 return snd_pcm_lib_ioctl_reset(substream, arg);
1850 case SNDRV_PCM_IOCTL1_CHANNEL_INFO:
1851 return snd_pcm_lib_ioctl_channel_info(substream, arg);
1852 case SNDRV_PCM_IOCTL1_FIFO_SIZE:
1853 return snd_pcm_lib_ioctl_fifo_size(substream, arg);
1858 EXPORT_SYMBOL(snd_pcm_lib_ioctl);
1861 * snd_pcm_period_elapsed - update the pcm status for the next period
1862 * @substream: the pcm substream instance
1864 * This function is called from the interrupt handler when the
1865 * PCM has processed the period size. It will update the current
1866 * pointer, wake up sleepers, etc.
1868 * Even if more than one periods have elapsed since the last call, you
1869 * have to call this only once.
1871 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream)
1873 struct snd_pcm_runtime *runtime;
1874 unsigned long flags;
1876 if (PCM_RUNTIME_CHECK(substream))
1878 runtime = substream->runtime;
1880 snd_pcm_stream_lock_irqsave(substream, flags);
1881 if (!snd_pcm_running(substream) ||
1882 snd_pcm_update_hw_ptr0(substream, 1) < 0)
1885 #ifdef CONFIG_SND_PCM_TIMER
1886 if (substream->timer_running)
1887 snd_timer_interrupt(substream->timer, 1);
1890 kill_fasync(&runtime->fasync, SIGIO, POLL_IN);
1891 snd_pcm_stream_unlock_irqrestore(substream, flags);
1894 EXPORT_SYMBOL(snd_pcm_period_elapsed);
1897 * Wait until avail_min data becomes available
1898 * Returns a negative error code if any error occurs during operation.
1899 * The available space is stored on availp. When err = 0 and avail = 0
1900 * on the capture stream, it indicates the stream is in DRAINING state.
1902 static int wait_for_avail(struct snd_pcm_substream *substream,
1903 snd_pcm_uframes_t *availp)
1905 struct snd_pcm_runtime *runtime = substream->runtime;
1906 int is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
1909 snd_pcm_uframes_t avail = 0;
1910 long wait_time, tout;
1912 init_waitqueue_entry(&wait, current);
1913 set_current_state(TASK_INTERRUPTIBLE);
1914 add_wait_queue(&runtime->tsleep, &wait);
1916 if (runtime->no_period_wakeup)
1917 wait_time = MAX_SCHEDULE_TIMEOUT;
1920 if (runtime->rate) {
1921 long t = runtime->period_size * 2 / runtime->rate;
1922 wait_time = max(t, wait_time);
1924 wait_time = msecs_to_jiffies(wait_time * 1000);
1928 if (signal_pending(current)) {
1934 * We need to check if space became available already
1935 * (and thus the wakeup happened already) first to close
1936 * the race of space already having become available.
1937 * This check must happen after been added to the waitqueue
1938 * and having current state be INTERRUPTIBLE.
1941 avail = snd_pcm_playback_avail(runtime);
1943 avail = snd_pcm_capture_avail(runtime);
1944 if (avail >= runtime->twake)
1946 snd_pcm_stream_unlock_irq(substream);
1948 tout = schedule_timeout(wait_time);
1950 snd_pcm_stream_lock_irq(substream);
1951 set_current_state(TASK_INTERRUPTIBLE);
1952 switch (runtime->status->state) {
1953 case SNDRV_PCM_STATE_SUSPENDED:
1956 case SNDRV_PCM_STATE_XRUN:
1959 case SNDRV_PCM_STATE_DRAINING:
1963 avail = 0; /* indicate draining */
1965 case SNDRV_PCM_STATE_OPEN:
1966 case SNDRV_PCM_STATE_SETUP:
1967 case SNDRV_PCM_STATE_DISCONNECTED:
1970 case SNDRV_PCM_STATE_PAUSED:
1974 pcm_dbg(substream->pcm,
1975 "%s write error (DMA or IRQ trouble?)\n",
1976 is_playback ? "playback" : "capture");
1982 set_current_state(TASK_RUNNING);
1983 remove_wait_queue(&runtime->tsleep, &wait);
1988 static int snd_pcm_lib_write_transfer(struct snd_pcm_substream *substream,
1990 unsigned long data, unsigned int off,
1991 snd_pcm_uframes_t frames)
1993 struct snd_pcm_runtime *runtime = substream->runtime;
1995 char __user *buf = (char __user *) data + frames_to_bytes(runtime, off);
1996 if (substream->ops->copy) {
1997 if ((err = substream->ops->copy(substream, -1, hwoff, buf, frames)) < 0)
2000 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, hwoff);
2001 if (copy_from_user(hwbuf, buf, frames_to_bytes(runtime, frames)))
2007 typedef int (*transfer_f)(struct snd_pcm_substream *substream, unsigned int hwoff,
2008 unsigned long data, unsigned int off,
2009 snd_pcm_uframes_t size);
2011 static snd_pcm_sframes_t snd_pcm_lib_write1(struct snd_pcm_substream *substream,
2013 snd_pcm_uframes_t size,
2015 transfer_f transfer)
2017 struct snd_pcm_runtime *runtime = substream->runtime;
2018 snd_pcm_uframes_t xfer = 0;
2019 snd_pcm_uframes_t offset = 0;
2020 snd_pcm_uframes_t avail;
2026 snd_pcm_stream_lock_irq(substream);
2027 switch (runtime->status->state) {
2028 case SNDRV_PCM_STATE_PREPARED:
2029 case SNDRV_PCM_STATE_RUNNING:
2030 case SNDRV_PCM_STATE_PAUSED:
2032 case SNDRV_PCM_STATE_XRUN:
2035 case SNDRV_PCM_STATE_SUSPENDED:
2043 runtime->twake = runtime->control->avail_min ? : 1;
2044 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING)
2045 snd_pcm_update_hw_ptr(substream);
2046 avail = snd_pcm_playback_avail(runtime);
2048 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
2049 snd_pcm_uframes_t cont;
2055 runtime->twake = min_t(snd_pcm_uframes_t, size,
2056 runtime->control->avail_min ? : 1);
2057 err = wait_for_avail(substream, &avail);
2061 frames = size > avail ? avail : size;
2062 cont = runtime->buffer_size - runtime->control->appl_ptr % runtime->buffer_size;
2065 if (snd_BUG_ON(!frames)) {
2067 snd_pcm_stream_unlock_irq(substream);
2070 appl_ptr = runtime->control->appl_ptr;
2071 appl_ofs = appl_ptr % runtime->buffer_size;
2072 snd_pcm_stream_unlock_irq(substream);
2073 err = transfer(substream, appl_ofs, data, offset, frames);
2074 snd_pcm_stream_lock_irq(substream);
2077 switch (runtime->status->state) {
2078 case SNDRV_PCM_STATE_XRUN:
2081 case SNDRV_PCM_STATE_SUSPENDED:
2088 if (appl_ptr >= runtime->boundary)
2089 appl_ptr -= runtime->boundary;
2090 runtime->control->appl_ptr = appl_ptr;
2091 if (substream->ops->ack)
2092 substream->ops->ack(substream);
2098 if (runtime->status->state == SNDRV_PCM_STATE_PREPARED &&
2099 snd_pcm_playback_hw_avail(runtime) >= (snd_pcm_sframes_t)runtime->start_threshold) {
2100 err = snd_pcm_start(substream);
2107 if (xfer > 0 && err >= 0)
2108 snd_pcm_update_state(substream, runtime);
2109 snd_pcm_stream_unlock_irq(substream);
2110 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2113 /* sanity-check for read/write methods */
2114 static int pcm_sanity_check(struct snd_pcm_substream *substream)
2116 struct snd_pcm_runtime *runtime;
2117 if (PCM_RUNTIME_CHECK(substream))
2119 runtime = substream->runtime;
2120 if (snd_BUG_ON(!substream->ops->copy && !runtime->dma_area))
2122 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2127 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream, const void __user *buf, snd_pcm_uframes_t size)
2129 struct snd_pcm_runtime *runtime;
2133 err = pcm_sanity_check(substream);
2136 runtime = substream->runtime;
2137 nonblock = !!(substream->f_flags & O_NONBLOCK);
2139 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
2140 runtime->channels > 1)
2142 return snd_pcm_lib_write1(substream, (unsigned long)buf, size, nonblock,
2143 snd_pcm_lib_write_transfer);
2146 EXPORT_SYMBOL(snd_pcm_lib_write);
2148 static int snd_pcm_lib_writev_transfer(struct snd_pcm_substream *substream,
2150 unsigned long data, unsigned int off,
2151 snd_pcm_uframes_t frames)
2153 struct snd_pcm_runtime *runtime = substream->runtime;
2155 void __user **bufs = (void __user **)data;
2156 int channels = runtime->channels;
2158 if (substream->ops->copy) {
2159 if (snd_BUG_ON(!substream->ops->silence))
2161 for (c = 0; c < channels; ++c, ++bufs) {
2162 if (*bufs == NULL) {
2163 if ((err = substream->ops->silence(substream, c, hwoff, frames)) < 0)
2166 char __user *buf = *bufs + samples_to_bytes(runtime, off);
2167 if ((err = substream->ops->copy(substream, c, hwoff, buf, frames)) < 0)
2172 /* default transfer behaviour */
2173 size_t dma_csize = runtime->dma_bytes / channels;
2174 for (c = 0; c < channels; ++c, ++bufs) {
2175 char *hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, hwoff);
2176 if (*bufs == NULL) {
2177 snd_pcm_format_set_silence(runtime->format, hwbuf, frames);
2179 char __user *buf = *bufs + samples_to_bytes(runtime, off);
2180 if (copy_from_user(hwbuf, buf, samples_to_bytes(runtime, frames)))
2188 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
2190 snd_pcm_uframes_t frames)
2192 struct snd_pcm_runtime *runtime;
2196 err = pcm_sanity_check(substream);
2199 runtime = substream->runtime;
2200 nonblock = !!(substream->f_flags & O_NONBLOCK);
2202 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2204 return snd_pcm_lib_write1(substream, (unsigned long)bufs, frames,
2205 nonblock, snd_pcm_lib_writev_transfer);
2208 EXPORT_SYMBOL(snd_pcm_lib_writev);
2210 static int snd_pcm_lib_read_transfer(struct snd_pcm_substream *substream,
2212 unsigned long data, unsigned int off,
2213 snd_pcm_uframes_t frames)
2215 struct snd_pcm_runtime *runtime = substream->runtime;
2217 char __user *buf = (char __user *) data + frames_to_bytes(runtime, off);
2218 if (substream->ops->copy) {
2219 if ((err = substream->ops->copy(substream, -1, hwoff, buf, frames)) < 0)
2222 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, hwoff);
2223 if (copy_to_user(buf, hwbuf, frames_to_bytes(runtime, frames)))
2229 static snd_pcm_sframes_t snd_pcm_lib_read1(struct snd_pcm_substream *substream,
2231 snd_pcm_uframes_t size,
2233 transfer_f transfer)
2235 struct snd_pcm_runtime *runtime = substream->runtime;
2236 snd_pcm_uframes_t xfer = 0;
2237 snd_pcm_uframes_t offset = 0;
2238 snd_pcm_uframes_t avail;
2244 snd_pcm_stream_lock_irq(substream);
2245 switch (runtime->status->state) {
2246 case SNDRV_PCM_STATE_PREPARED:
2247 if (size >= runtime->start_threshold) {
2248 err = snd_pcm_start(substream);
2253 case SNDRV_PCM_STATE_DRAINING:
2254 case SNDRV_PCM_STATE_RUNNING:
2255 case SNDRV_PCM_STATE_PAUSED:
2257 case SNDRV_PCM_STATE_XRUN:
2260 case SNDRV_PCM_STATE_SUSPENDED:
2268 runtime->twake = runtime->control->avail_min ? : 1;
2269 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING)
2270 snd_pcm_update_hw_ptr(substream);
2271 avail = snd_pcm_capture_avail(runtime);
2273 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
2274 snd_pcm_uframes_t cont;
2276 if (runtime->status->state ==
2277 SNDRV_PCM_STATE_DRAINING) {
2278 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2285 runtime->twake = min_t(snd_pcm_uframes_t, size,
2286 runtime->control->avail_min ? : 1);
2287 err = wait_for_avail(substream, &avail);
2291 continue; /* draining */
2293 frames = size > avail ? avail : size;
2294 cont = runtime->buffer_size - runtime->control->appl_ptr % runtime->buffer_size;
2297 if (snd_BUG_ON(!frames)) {
2299 snd_pcm_stream_unlock_irq(substream);
2302 appl_ptr = runtime->control->appl_ptr;
2303 appl_ofs = appl_ptr % runtime->buffer_size;
2304 snd_pcm_stream_unlock_irq(substream);
2305 err = transfer(substream, appl_ofs, data, offset, frames);
2306 snd_pcm_stream_lock_irq(substream);
2309 switch (runtime->status->state) {
2310 case SNDRV_PCM_STATE_XRUN:
2313 case SNDRV_PCM_STATE_SUSPENDED:
2320 if (appl_ptr >= runtime->boundary)
2321 appl_ptr -= runtime->boundary;
2322 runtime->control->appl_ptr = appl_ptr;
2323 if (substream->ops->ack)
2324 substream->ops->ack(substream);
2333 if (xfer > 0 && err >= 0)
2334 snd_pcm_update_state(substream, runtime);
2335 snd_pcm_stream_unlock_irq(substream);
2336 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2339 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream, void __user *buf, snd_pcm_uframes_t size)
2341 struct snd_pcm_runtime *runtime;
2345 err = pcm_sanity_check(substream);
2348 runtime = substream->runtime;
2349 nonblock = !!(substream->f_flags & O_NONBLOCK);
2350 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED)
2352 return snd_pcm_lib_read1(substream, (unsigned long)buf, size, nonblock, snd_pcm_lib_read_transfer);
2355 EXPORT_SYMBOL(snd_pcm_lib_read);
2357 static int snd_pcm_lib_readv_transfer(struct snd_pcm_substream *substream,
2359 unsigned long data, unsigned int off,
2360 snd_pcm_uframes_t frames)
2362 struct snd_pcm_runtime *runtime = substream->runtime;
2364 void __user **bufs = (void __user **)data;
2365 int channels = runtime->channels;
2367 if (substream->ops->copy) {
2368 for (c = 0; c < channels; ++c, ++bufs) {
2372 buf = *bufs + samples_to_bytes(runtime, off);
2373 if ((err = substream->ops->copy(substream, c, hwoff, buf, frames)) < 0)
2377 snd_pcm_uframes_t dma_csize = runtime->dma_bytes / channels;
2378 for (c = 0; c < channels; ++c, ++bufs) {
2384 hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, hwoff);
2385 buf = *bufs + samples_to_bytes(runtime, off);
2386 if (copy_to_user(buf, hwbuf, samples_to_bytes(runtime, frames)))
2393 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
2395 snd_pcm_uframes_t frames)
2397 struct snd_pcm_runtime *runtime;
2401 err = pcm_sanity_check(substream);
2404 runtime = substream->runtime;
2405 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2408 nonblock = !!(substream->f_flags & O_NONBLOCK);
2409 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2411 return snd_pcm_lib_read1(substream, (unsigned long)bufs, frames, nonblock, snd_pcm_lib_readv_transfer);
2414 EXPORT_SYMBOL(snd_pcm_lib_readv);
2417 * standard channel mapping helpers
2420 /* default channel maps for multi-channel playbacks, up to 8 channels */
2421 const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[] = {
2423 .map = { SNDRV_CHMAP_MONO } },
2425 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2427 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2428 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2430 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2431 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2432 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE } },
2434 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2435 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2436 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2437 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2440 EXPORT_SYMBOL_GPL(snd_pcm_std_chmaps);
2442 /* alternative channel maps with CLFE <-> surround swapped for 6/8 channels */
2443 const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[] = {
2445 .map = { SNDRV_CHMAP_MONO } },
2447 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2449 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2450 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2452 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2453 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2454 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2456 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2457 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2458 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2459 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2462 EXPORT_SYMBOL_GPL(snd_pcm_alt_chmaps);
2464 static bool valid_chmap_channels(const struct snd_pcm_chmap *info, int ch)
2466 if (ch > info->max_channels)
2468 return !info->channel_mask || (info->channel_mask & (1U << ch));
2471 static int pcm_chmap_ctl_info(struct snd_kcontrol *kcontrol,
2472 struct snd_ctl_elem_info *uinfo)
2474 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2476 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
2478 uinfo->count = info->max_channels;
2479 uinfo->value.integer.min = 0;
2480 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
2484 /* get callback for channel map ctl element
2485 * stores the channel position firstly matching with the current channels
2487 static int pcm_chmap_ctl_get(struct snd_kcontrol *kcontrol,
2488 struct snd_ctl_elem_value *ucontrol)
2490 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2491 unsigned int idx = snd_ctl_get_ioffidx(kcontrol, &ucontrol->id);
2492 struct snd_pcm_substream *substream;
2493 const struct snd_pcm_chmap_elem *map;
2495 if (snd_BUG_ON(!info->chmap))
2497 substream = snd_pcm_chmap_substream(info, idx);
2500 memset(ucontrol->value.integer.value, 0,
2501 sizeof(ucontrol->value.integer.value));
2502 if (!substream->runtime)
2503 return 0; /* no channels set */
2504 for (map = info->chmap; map->channels; map++) {
2506 if (map->channels == substream->runtime->channels &&
2507 valid_chmap_channels(info, map->channels)) {
2508 for (i = 0; i < map->channels; i++)
2509 ucontrol->value.integer.value[i] = map->map[i];
2516 /* tlv callback for channel map ctl element
2517 * expands the pre-defined channel maps in a form of TLV
2519 static int pcm_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
2520 unsigned int size, unsigned int __user *tlv)
2522 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2523 const struct snd_pcm_chmap_elem *map;
2524 unsigned int __user *dst;
2527 if (snd_BUG_ON(!info->chmap))
2531 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
2535 for (map = info->chmap; map->channels; map++) {
2536 int chs_bytes = map->channels * 4;
2537 if (!valid_chmap_channels(info, map->channels))
2541 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
2542 put_user(chs_bytes, dst + 1))
2547 if (size < chs_bytes)
2551 for (c = 0; c < map->channels; c++) {
2552 if (put_user(map->map[c], dst))
2557 if (put_user(count, tlv + 1))
2562 static void pcm_chmap_ctl_private_free(struct snd_kcontrol *kcontrol)
2564 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2565 info->pcm->streams[info->stream].chmap_kctl = NULL;
2570 * snd_pcm_add_chmap_ctls - create channel-mapping control elements
2571 * @pcm: the assigned PCM instance
2572 * @stream: stream direction
2573 * @chmap: channel map elements (for query)
2574 * @max_channels: the max number of channels for the stream
2575 * @private_value: the value passed to each kcontrol's private_value field
2576 * @info_ret: store struct snd_pcm_chmap instance if non-NULL
2578 * Create channel-mapping control elements assigned to the given PCM stream(s).
2579 * Return: Zero if successful, or a negative error value.
2581 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
2582 const struct snd_pcm_chmap_elem *chmap,
2584 unsigned long private_value,
2585 struct snd_pcm_chmap **info_ret)
2587 struct snd_pcm_chmap *info;
2588 struct snd_kcontrol_new knew = {
2589 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
2590 .access = SNDRV_CTL_ELEM_ACCESS_READ |
2591 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
2592 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,
2593 .info = pcm_chmap_ctl_info,
2594 .get = pcm_chmap_ctl_get,
2595 .tlv.c = pcm_chmap_ctl_tlv,
2599 if (WARN_ON(pcm->streams[stream].chmap_kctl))
2601 info = kzalloc(sizeof(*info), GFP_KERNEL);
2605 info->stream = stream;
2606 info->chmap = chmap;
2607 info->max_channels = max_channels;
2608 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2609 knew.name = "Playback Channel Map";
2611 knew.name = "Capture Channel Map";
2612 knew.device = pcm->device;
2613 knew.count = pcm->streams[stream].substream_count;
2614 knew.private_value = private_value;
2615 info->kctl = snd_ctl_new1(&knew, info);
2620 info->kctl->private_free = pcm_chmap_ctl_private_free;
2621 err = snd_ctl_add(pcm->card, info->kctl);
2624 pcm->streams[stream].chmap_kctl = info->kctl;
2629 EXPORT_SYMBOL_GPL(snd_pcm_add_chmap_ctls);