Loading...
1/*
2 * Digital Audio (PCM) abstract layer
3 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4 * Abramo Bagnara <abramo@alsa-project.org>
5 *
6 *
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.
11 *
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.
16 *
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
20 *
21 */
22
23#include <linux/slab.h>
24#include <linux/time.h>
25#include <linux/math64.h>
26#include <linux/export.h>
27#include <sound/core.h>
28#include <sound/control.h>
29#include <sound/tlv.h>
30#include <sound/info.h>
31#include <sound/pcm.h>
32#include <sound/pcm_params.h>
33#include <sound/timer.h>
34
35/*
36 * fill ring buffer with silence
37 * runtime->silence_start: starting pointer to silence area
38 * runtime->silence_filled: size filled with silence
39 * runtime->silence_threshold: threshold from application
40 * runtime->silence_size: maximal size from application
41 *
42 * when runtime->silence_size >= runtime->boundary - fill processed area with silence immediately
43 */
44void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
45{
46 struct snd_pcm_runtime *runtime = substream->runtime;
47 snd_pcm_uframes_t frames, ofs, transfer;
48
49 if (runtime->silence_size < runtime->boundary) {
50 snd_pcm_sframes_t noise_dist, n;
51 if (runtime->silence_start != runtime->control->appl_ptr) {
52 n = runtime->control->appl_ptr - runtime->silence_start;
53 if (n < 0)
54 n += runtime->boundary;
55 if ((snd_pcm_uframes_t)n < runtime->silence_filled)
56 runtime->silence_filled -= n;
57 else
58 runtime->silence_filled = 0;
59 runtime->silence_start = runtime->control->appl_ptr;
60 }
61 if (runtime->silence_filled >= runtime->buffer_size)
62 return;
63 noise_dist = snd_pcm_playback_hw_avail(runtime) + runtime->silence_filled;
64 if (noise_dist >= (snd_pcm_sframes_t) runtime->silence_threshold)
65 return;
66 frames = runtime->silence_threshold - noise_dist;
67 if (frames > runtime->silence_size)
68 frames = runtime->silence_size;
69 } else {
70 if (new_hw_ptr == ULONG_MAX) { /* initialization */
71 snd_pcm_sframes_t avail = snd_pcm_playback_hw_avail(runtime);
72 if (avail > runtime->buffer_size)
73 avail = runtime->buffer_size;
74 runtime->silence_filled = avail > 0 ? avail : 0;
75 runtime->silence_start = (runtime->status->hw_ptr +
76 runtime->silence_filled) %
77 runtime->boundary;
78 } else {
79 ofs = runtime->status->hw_ptr;
80 frames = new_hw_ptr - ofs;
81 if ((snd_pcm_sframes_t)frames < 0)
82 frames += runtime->boundary;
83 runtime->silence_filled -= frames;
84 if ((snd_pcm_sframes_t)runtime->silence_filled < 0) {
85 runtime->silence_filled = 0;
86 runtime->silence_start = new_hw_ptr;
87 } else {
88 runtime->silence_start = ofs;
89 }
90 }
91 frames = runtime->buffer_size - runtime->silence_filled;
92 }
93 if (snd_BUG_ON(frames > runtime->buffer_size))
94 return;
95 if (frames == 0)
96 return;
97 ofs = runtime->silence_start % runtime->buffer_size;
98 while (frames > 0) {
99 transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
100 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
101 runtime->access == SNDRV_PCM_ACCESS_MMAP_INTERLEAVED) {
102 if (substream->ops->silence) {
103 int err;
104 err = substream->ops->silence(substream, -1, ofs, transfer);
105 snd_BUG_ON(err < 0);
106 } else {
107 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, ofs);
108 snd_pcm_format_set_silence(runtime->format, hwbuf, transfer * runtime->channels);
109 }
110 } else {
111 unsigned int c;
112 unsigned int channels = runtime->channels;
113 if (substream->ops->silence) {
114 for (c = 0; c < channels; ++c) {
115 int err;
116 err = substream->ops->silence(substream, c, ofs, transfer);
117 snd_BUG_ON(err < 0);
118 }
119 } else {
120 size_t dma_csize = runtime->dma_bytes / channels;
121 for (c = 0; c < channels; ++c) {
122 char *hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, ofs);
123 snd_pcm_format_set_silence(runtime->format, hwbuf, transfer);
124 }
125 }
126 }
127 runtime->silence_filled += transfer;
128 frames -= transfer;
129 ofs = 0;
130 }
131}
132
133#ifdef CONFIG_SND_DEBUG
134void snd_pcm_debug_name(struct snd_pcm_substream *substream,
135 char *name, size_t len)
136{
137 snprintf(name, len, "pcmC%dD%d%c:%d",
138 substream->pcm->card->number,
139 substream->pcm->device,
140 substream->stream ? 'c' : 'p',
141 substream->number);
142}
143EXPORT_SYMBOL(snd_pcm_debug_name);
144#endif
145
146#define XRUN_DEBUG_BASIC (1<<0)
147#define XRUN_DEBUG_STACK (1<<1) /* dump also stack */
148#define XRUN_DEBUG_JIFFIESCHECK (1<<2) /* do jiffies check */
149#define XRUN_DEBUG_PERIODUPDATE (1<<3) /* full period update info */
150#define XRUN_DEBUG_HWPTRUPDATE (1<<4) /* full hwptr update info */
151#define XRUN_DEBUG_LOG (1<<5) /* show last 10 positions on err */
152#define XRUN_DEBUG_LOGONCE (1<<6) /* do above only once */
153
154#ifdef CONFIG_SND_PCM_XRUN_DEBUG
155
156#define xrun_debug(substream, mask) \
157 ((substream)->pstr->xrun_debug & (mask))
158#else
159#define xrun_debug(substream, mask) 0
160#endif
161
162#define dump_stack_on_xrun(substream) do { \
163 if (xrun_debug(substream, XRUN_DEBUG_STACK)) \
164 dump_stack(); \
165 } while (0)
166
167static void xrun(struct snd_pcm_substream *substream)
168{
169 struct snd_pcm_runtime *runtime = substream->runtime;
170
171 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
172 snd_pcm_gettime(runtime, (struct timespec *)&runtime->status->tstamp);
173 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
174 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
175 char name[16];
176 snd_pcm_debug_name(substream, name, sizeof(name));
177 pcm_warn(substream->pcm, "XRUN: %s\n", name);
178 dump_stack_on_xrun(substream);
179 }
180}
181
182#ifdef CONFIG_SND_PCM_XRUN_DEBUG
183#define hw_ptr_error(substream, fmt, args...) \
184 do { \
185 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) { \
186 xrun_log_show(substream); \
187 pr_err_ratelimited("ALSA: PCM: " fmt, ##args); \
188 dump_stack_on_xrun(substream); \
189 } \
190 } while (0)
191
192#define XRUN_LOG_CNT 10
193
194struct hwptr_log_entry {
195 unsigned int in_interrupt;
196 unsigned long jiffies;
197 snd_pcm_uframes_t pos;
198 snd_pcm_uframes_t period_size;
199 snd_pcm_uframes_t buffer_size;
200 snd_pcm_uframes_t old_hw_ptr;
201 snd_pcm_uframes_t hw_ptr_base;
202};
203
204struct snd_pcm_hwptr_log {
205 unsigned int idx;
206 unsigned int hit: 1;
207 struct hwptr_log_entry entries[XRUN_LOG_CNT];
208};
209
210static void xrun_log(struct snd_pcm_substream *substream,
211 snd_pcm_uframes_t pos, int in_interrupt)
212{
213 struct snd_pcm_runtime *runtime = substream->runtime;
214 struct snd_pcm_hwptr_log *log = runtime->hwptr_log;
215 struct hwptr_log_entry *entry;
216
217 if (log == NULL) {
218 log = kzalloc(sizeof(*log), GFP_ATOMIC);
219 if (log == NULL)
220 return;
221 runtime->hwptr_log = log;
222 } else {
223 if (xrun_debug(substream, XRUN_DEBUG_LOGONCE) && log->hit)
224 return;
225 }
226 entry = &log->entries[log->idx];
227 entry->in_interrupt = in_interrupt;
228 entry->jiffies = jiffies;
229 entry->pos = pos;
230 entry->period_size = runtime->period_size;
231 entry->buffer_size = runtime->buffer_size;
232 entry->old_hw_ptr = runtime->status->hw_ptr;
233 entry->hw_ptr_base = runtime->hw_ptr_base;
234 log->idx = (log->idx + 1) % XRUN_LOG_CNT;
235}
236
237static void xrun_log_show(struct snd_pcm_substream *substream)
238{
239 struct snd_pcm_hwptr_log *log = substream->runtime->hwptr_log;
240 struct hwptr_log_entry *entry;
241 char name[16];
242 unsigned int idx;
243 int cnt;
244
245 if (log == NULL)
246 return;
247 if (xrun_debug(substream, XRUN_DEBUG_LOGONCE) && log->hit)
248 return;
249 snd_pcm_debug_name(substream, name, sizeof(name));
250 for (cnt = 0, idx = log->idx; cnt < XRUN_LOG_CNT; cnt++) {
251 entry = &log->entries[idx];
252 if (entry->period_size == 0)
253 break;
254 pr_info("hwptr log: %s: %sj=%lu, pos=%ld/%ld/%ld, "
255 "hwptr=%ld/%ld\n",
256 name, entry->in_interrupt ? "[Q] " : "",
257 entry->jiffies,
258 (unsigned long)entry->pos,
259 (unsigned long)entry->period_size,
260 (unsigned long)entry->buffer_size,
261 (unsigned long)entry->old_hw_ptr,
262 (unsigned long)entry->hw_ptr_base);
263 idx++;
264 idx %= XRUN_LOG_CNT;
265 }
266 log->hit = 1;
267}
268
269#else /* ! CONFIG_SND_PCM_XRUN_DEBUG */
270
271#define hw_ptr_error(substream, fmt, args...) do { } while (0)
272#define xrun_log(substream, pos, in_interrupt) do { } while (0)
273#define xrun_log_show(substream) do { } while (0)
274
275#endif
276
277int snd_pcm_update_state(struct snd_pcm_substream *substream,
278 struct snd_pcm_runtime *runtime)
279{
280 snd_pcm_uframes_t avail;
281
282 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
283 avail = snd_pcm_playback_avail(runtime);
284 else
285 avail = snd_pcm_capture_avail(runtime);
286 if (avail > runtime->avail_max)
287 runtime->avail_max = avail;
288 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
289 if (avail >= runtime->buffer_size) {
290 snd_pcm_drain_done(substream);
291 return -EPIPE;
292 }
293 } else {
294 if (avail >= runtime->stop_threshold) {
295 xrun(substream);
296 return -EPIPE;
297 }
298 }
299 if (runtime->twake) {
300 if (avail >= runtime->twake)
301 wake_up(&runtime->tsleep);
302 } else if (avail >= runtime->control->avail_min)
303 wake_up(&runtime->sleep);
304 return 0;
305}
306
307static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
308 unsigned int in_interrupt)
309{
310 struct snd_pcm_runtime *runtime = substream->runtime;
311 snd_pcm_uframes_t pos;
312 snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
313 snd_pcm_sframes_t hdelta, delta;
314 unsigned long jdelta;
315 unsigned long curr_jiffies;
316 struct timespec curr_tstamp;
317 struct timespec audio_tstamp;
318 int crossed_boundary = 0;
319
320 old_hw_ptr = runtime->status->hw_ptr;
321
322 /*
323 * group pointer, time and jiffies reads to allow for more
324 * accurate correlations/corrections.
325 * The values are stored at the end of this routine after
326 * corrections for hw_ptr position
327 */
328 pos = substream->ops->pointer(substream);
329 curr_jiffies = jiffies;
330 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
331 snd_pcm_gettime(runtime, (struct timespec *)&curr_tstamp);
332
333 if ((runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK) &&
334 (substream->ops->wall_clock))
335 substream->ops->wall_clock(substream, &audio_tstamp);
336 }
337
338 if (pos == SNDRV_PCM_POS_XRUN) {
339 xrun(substream);
340 return -EPIPE;
341 }
342 if (pos >= runtime->buffer_size) {
343 if (printk_ratelimit()) {
344 char name[16];
345 snd_pcm_debug_name(substream, name, sizeof(name));
346 xrun_log_show(substream);
347 pcm_err(substream->pcm,
348 "BUG: %s, pos = %ld, buffer size = %ld, period size = %ld\n",
349 name, pos, runtime->buffer_size,
350 runtime->period_size);
351 }
352 pos = 0;
353 }
354 pos -= pos % runtime->min_align;
355 if (xrun_debug(substream, XRUN_DEBUG_LOG))
356 xrun_log(substream, pos, in_interrupt);
357 hw_base = runtime->hw_ptr_base;
358 new_hw_ptr = hw_base + pos;
359 if (in_interrupt) {
360 /* we know that one period was processed */
361 /* delta = "expected next hw_ptr" for in_interrupt != 0 */
362 delta = runtime->hw_ptr_interrupt + runtime->period_size;
363 if (delta > new_hw_ptr) {
364 /* check for double acknowledged interrupts */
365 hdelta = curr_jiffies - runtime->hw_ptr_jiffies;
366 if (hdelta > runtime->hw_ptr_buffer_jiffies/2) {
367 hw_base += runtime->buffer_size;
368 if (hw_base >= runtime->boundary) {
369 hw_base = 0;
370 crossed_boundary++;
371 }
372 new_hw_ptr = hw_base + pos;
373 goto __delta;
374 }
375 }
376 }
377 /* new_hw_ptr might be lower than old_hw_ptr in case when */
378 /* pointer crosses the end of the ring buffer */
379 if (new_hw_ptr < old_hw_ptr) {
380 hw_base += runtime->buffer_size;
381 if (hw_base >= runtime->boundary) {
382 hw_base = 0;
383 crossed_boundary++;
384 }
385 new_hw_ptr = hw_base + pos;
386 }
387 __delta:
388 delta = new_hw_ptr - old_hw_ptr;
389 if (delta < 0)
390 delta += runtime->boundary;
391 if (xrun_debug(substream, in_interrupt ?
392 XRUN_DEBUG_PERIODUPDATE : XRUN_DEBUG_HWPTRUPDATE)) {
393 char name[16];
394 snd_pcm_debug_name(substream, name, sizeof(name));
395 pcm_dbg(substream->pcm,
396 "%s_update: %s: pos=%u/%u/%u, hwptr=%ld/%ld/%ld/%ld\n",
397 in_interrupt ? "period" : "hwptr",
398 name,
399 (unsigned int)pos,
400 (unsigned int)runtime->period_size,
401 (unsigned int)runtime->buffer_size,
402 (unsigned long)delta,
403 (unsigned long)old_hw_ptr,
404 (unsigned long)new_hw_ptr,
405 (unsigned long)runtime->hw_ptr_base);
406 }
407
408 if (runtime->no_period_wakeup) {
409 snd_pcm_sframes_t xrun_threshold;
410 /*
411 * Without regular period interrupts, we have to check
412 * the elapsed time to detect xruns.
413 */
414 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
415 if (jdelta < runtime->hw_ptr_buffer_jiffies / 2)
416 goto no_delta_check;
417 hdelta = jdelta - delta * HZ / runtime->rate;
418 xrun_threshold = runtime->hw_ptr_buffer_jiffies / 2 + 1;
419 while (hdelta > xrun_threshold) {
420 delta += runtime->buffer_size;
421 hw_base += runtime->buffer_size;
422 if (hw_base >= runtime->boundary) {
423 hw_base = 0;
424 crossed_boundary++;
425 }
426 new_hw_ptr = hw_base + pos;
427 hdelta -= runtime->hw_ptr_buffer_jiffies;
428 }
429 goto no_delta_check;
430 }
431
432 /* something must be really wrong */
433 if (delta >= runtime->buffer_size + runtime->period_size) {
434 hw_ptr_error(substream,
435 "Unexpected hw_pointer value %s"
436 "(stream=%i, pos=%ld, new_hw_ptr=%ld, "
437 "old_hw_ptr=%ld)\n",
438 in_interrupt ? "[Q] " : "[P]",
439 substream->stream, (long)pos,
440 (long)new_hw_ptr, (long)old_hw_ptr);
441 return 0;
442 }
443
444 /* Do jiffies check only in xrun_debug mode */
445 if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
446 goto no_jiffies_check;
447
448 /* Skip the jiffies check for hardwares with BATCH flag.
449 * Such hardware usually just increases the position at each IRQ,
450 * thus it can't give any strange position.
451 */
452 if (runtime->hw.info & SNDRV_PCM_INFO_BATCH)
453 goto no_jiffies_check;
454 hdelta = delta;
455 if (hdelta < runtime->delay)
456 goto no_jiffies_check;
457 hdelta -= runtime->delay;
458 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
459 if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
460 delta = jdelta /
461 (((runtime->period_size * HZ) / runtime->rate)
462 + HZ/100);
463 /* move new_hw_ptr according jiffies not pos variable */
464 new_hw_ptr = old_hw_ptr;
465 hw_base = delta;
466 /* use loop to avoid checks for delta overflows */
467 /* the delta value is small or zero in most cases */
468 while (delta > 0) {
469 new_hw_ptr += runtime->period_size;
470 if (new_hw_ptr >= runtime->boundary) {
471 new_hw_ptr -= runtime->boundary;
472 crossed_boundary--;
473 }
474 delta--;
475 }
476 /* align hw_base to buffer_size */
477 hw_ptr_error(substream,
478 "hw_ptr skipping! %s"
479 "(pos=%ld, delta=%ld, period=%ld, "
480 "jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
481 in_interrupt ? "[Q] " : "",
482 (long)pos, (long)hdelta,
483 (long)runtime->period_size, jdelta,
484 ((hdelta * HZ) / runtime->rate), hw_base,
485 (unsigned long)old_hw_ptr,
486 (unsigned long)new_hw_ptr);
487 /* reset values to proper state */
488 delta = 0;
489 hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
490 }
491 no_jiffies_check:
492 if (delta > runtime->period_size + runtime->period_size / 2) {
493 hw_ptr_error(substream,
494 "Lost interrupts? %s"
495 "(stream=%i, delta=%ld, new_hw_ptr=%ld, "
496 "old_hw_ptr=%ld)\n",
497 in_interrupt ? "[Q] " : "",
498 substream->stream, (long)delta,
499 (long)new_hw_ptr,
500 (long)old_hw_ptr);
501 }
502
503 no_delta_check:
504 if (runtime->status->hw_ptr == new_hw_ptr)
505 return 0;
506
507 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
508 runtime->silence_size > 0)
509 snd_pcm_playback_silence(substream, new_hw_ptr);
510
511 if (in_interrupt) {
512 delta = new_hw_ptr - runtime->hw_ptr_interrupt;
513 if (delta < 0)
514 delta += runtime->boundary;
515 delta -= (snd_pcm_uframes_t)delta % runtime->period_size;
516 runtime->hw_ptr_interrupt += delta;
517 if (runtime->hw_ptr_interrupt >= runtime->boundary)
518 runtime->hw_ptr_interrupt -= runtime->boundary;
519 }
520 runtime->hw_ptr_base = hw_base;
521 runtime->status->hw_ptr = new_hw_ptr;
522 runtime->hw_ptr_jiffies = curr_jiffies;
523 if (crossed_boundary) {
524 snd_BUG_ON(crossed_boundary != 1);
525 runtime->hw_ptr_wrap += runtime->boundary;
526 }
527 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
528 runtime->status->tstamp = curr_tstamp;
529
530 if (!(runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)) {
531 /*
532 * no wall clock available, provide audio timestamp
533 * derived from pointer position+delay
534 */
535 u64 audio_frames, audio_nsecs;
536
537 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
538 audio_frames = runtime->hw_ptr_wrap
539 + runtime->status->hw_ptr
540 - runtime->delay;
541 else
542 audio_frames = runtime->hw_ptr_wrap
543 + runtime->status->hw_ptr
544 + runtime->delay;
545 audio_nsecs = div_u64(audio_frames * 1000000000LL,
546 runtime->rate);
547 audio_tstamp = ns_to_timespec(audio_nsecs);
548 }
549 runtime->status->audio_tstamp = audio_tstamp;
550 }
551
552 return snd_pcm_update_state(substream, runtime);
553}
554
555/* CAUTION: call it with irq disabled */
556int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
557{
558 return snd_pcm_update_hw_ptr0(substream, 0);
559}
560
561/**
562 * snd_pcm_set_ops - set the PCM operators
563 * @pcm: the pcm instance
564 * @direction: stream direction, SNDRV_PCM_STREAM_XXX
565 * @ops: the operator table
566 *
567 * Sets the given PCM operators to the pcm instance.
568 */
569void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
570 const struct snd_pcm_ops *ops)
571{
572 struct snd_pcm_str *stream = &pcm->streams[direction];
573 struct snd_pcm_substream *substream;
574
575 for (substream = stream->substream; substream != NULL; substream = substream->next)
576 substream->ops = ops;
577}
578
579EXPORT_SYMBOL(snd_pcm_set_ops);
580
581/**
582 * snd_pcm_sync - set the PCM sync id
583 * @substream: the pcm substream
584 *
585 * Sets the PCM sync identifier for the card.
586 */
587void snd_pcm_set_sync(struct snd_pcm_substream *substream)
588{
589 struct snd_pcm_runtime *runtime = substream->runtime;
590
591 runtime->sync.id32[0] = substream->pcm->card->number;
592 runtime->sync.id32[1] = -1;
593 runtime->sync.id32[2] = -1;
594 runtime->sync.id32[3] = -1;
595}
596
597EXPORT_SYMBOL(snd_pcm_set_sync);
598
599/*
600 * Standard ioctl routine
601 */
602
603static inline unsigned int div32(unsigned int a, unsigned int b,
604 unsigned int *r)
605{
606 if (b == 0) {
607 *r = 0;
608 return UINT_MAX;
609 }
610 *r = a % b;
611 return a / b;
612}
613
614static inline unsigned int div_down(unsigned int a, unsigned int b)
615{
616 if (b == 0)
617 return UINT_MAX;
618 return a / b;
619}
620
621static inline unsigned int div_up(unsigned int a, unsigned int b)
622{
623 unsigned int r;
624 unsigned int q;
625 if (b == 0)
626 return UINT_MAX;
627 q = div32(a, b, &r);
628 if (r)
629 ++q;
630 return q;
631}
632
633static inline unsigned int mul(unsigned int a, unsigned int b)
634{
635 if (a == 0)
636 return 0;
637 if (div_down(UINT_MAX, a) < b)
638 return UINT_MAX;
639 return a * b;
640}
641
642static inline unsigned int muldiv32(unsigned int a, unsigned int b,
643 unsigned int c, unsigned int *r)
644{
645 u_int64_t n = (u_int64_t) a * b;
646 if (c == 0) {
647 snd_BUG_ON(!n);
648 *r = 0;
649 return UINT_MAX;
650 }
651 n = div_u64_rem(n, c, r);
652 if (n >= UINT_MAX) {
653 *r = 0;
654 return UINT_MAX;
655 }
656 return n;
657}
658
659/**
660 * snd_interval_refine - refine the interval value of configurator
661 * @i: the interval value to refine
662 * @v: the interval value to refer to
663 *
664 * Refines the interval value with the reference value.
665 * The interval is changed to the range satisfying both intervals.
666 * The interval status (min, max, integer, etc.) are evaluated.
667 *
668 * Return: Positive if the value is changed, zero if it's not changed, or a
669 * negative error code.
670 */
671int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
672{
673 int changed = 0;
674 if (snd_BUG_ON(snd_interval_empty(i)))
675 return -EINVAL;
676 if (i->min < v->min) {
677 i->min = v->min;
678 i->openmin = v->openmin;
679 changed = 1;
680 } else if (i->min == v->min && !i->openmin && v->openmin) {
681 i->openmin = 1;
682 changed = 1;
683 }
684 if (i->max > v->max) {
685 i->max = v->max;
686 i->openmax = v->openmax;
687 changed = 1;
688 } else if (i->max == v->max && !i->openmax && v->openmax) {
689 i->openmax = 1;
690 changed = 1;
691 }
692 if (!i->integer && v->integer) {
693 i->integer = 1;
694 changed = 1;
695 }
696 if (i->integer) {
697 if (i->openmin) {
698 i->min++;
699 i->openmin = 0;
700 }
701 if (i->openmax) {
702 i->max--;
703 i->openmax = 0;
704 }
705 } else if (!i->openmin && !i->openmax && i->min == i->max)
706 i->integer = 1;
707 if (snd_interval_checkempty(i)) {
708 snd_interval_none(i);
709 return -EINVAL;
710 }
711 return changed;
712}
713
714EXPORT_SYMBOL(snd_interval_refine);
715
716static int snd_interval_refine_first(struct snd_interval *i)
717{
718 if (snd_BUG_ON(snd_interval_empty(i)))
719 return -EINVAL;
720 if (snd_interval_single(i))
721 return 0;
722 i->max = i->min;
723 i->openmax = i->openmin;
724 if (i->openmax)
725 i->max++;
726 return 1;
727}
728
729static int snd_interval_refine_last(struct snd_interval *i)
730{
731 if (snd_BUG_ON(snd_interval_empty(i)))
732 return -EINVAL;
733 if (snd_interval_single(i))
734 return 0;
735 i->min = i->max;
736 i->openmin = i->openmax;
737 if (i->openmin)
738 i->min--;
739 return 1;
740}
741
742void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
743{
744 if (a->empty || b->empty) {
745 snd_interval_none(c);
746 return;
747 }
748 c->empty = 0;
749 c->min = mul(a->min, b->min);
750 c->openmin = (a->openmin || b->openmin);
751 c->max = mul(a->max, b->max);
752 c->openmax = (a->openmax || b->openmax);
753 c->integer = (a->integer && b->integer);
754}
755
756/**
757 * snd_interval_div - refine the interval value with division
758 * @a: dividend
759 * @b: divisor
760 * @c: quotient
761 *
762 * c = a / b
763 *
764 * Returns non-zero if the value is changed, zero if not changed.
765 */
766void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
767{
768 unsigned int r;
769 if (a->empty || b->empty) {
770 snd_interval_none(c);
771 return;
772 }
773 c->empty = 0;
774 c->min = div32(a->min, b->max, &r);
775 c->openmin = (r || a->openmin || b->openmax);
776 if (b->min > 0) {
777 c->max = div32(a->max, b->min, &r);
778 if (r) {
779 c->max++;
780 c->openmax = 1;
781 } else
782 c->openmax = (a->openmax || b->openmin);
783 } else {
784 c->max = UINT_MAX;
785 c->openmax = 0;
786 }
787 c->integer = 0;
788}
789
790/**
791 * snd_interval_muldivk - refine the interval value
792 * @a: dividend 1
793 * @b: dividend 2
794 * @k: divisor (as integer)
795 * @c: result
796 *
797 * c = a * b / k
798 *
799 * Returns non-zero if the value is changed, zero if not changed.
800 */
801void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
802 unsigned int k, struct snd_interval *c)
803{
804 unsigned int r;
805 if (a->empty || b->empty) {
806 snd_interval_none(c);
807 return;
808 }
809 c->empty = 0;
810 c->min = muldiv32(a->min, b->min, k, &r);
811 c->openmin = (r || a->openmin || b->openmin);
812 c->max = muldiv32(a->max, b->max, k, &r);
813 if (r) {
814 c->max++;
815 c->openmax = 1;
816 } else
817 c->openmax = (a->openmax || b->openmax);
818 c->integer = 0;
819}
820
821/**
822 * snd_interval_mulkdiv - refine the interval value
823 * @a: dividend 1
824 * @k: dividend 2 (as integer)
825 * @b: divisor
826 * @c: result
827 *
828 * c = a * k / b
829 *
830 * Returns non-zero if the value is changed, zero if not changed.
831 */
832void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
833 const struct snd_interval *b, struct snd_interval *c)
834{
835 unsigned int r;
836 if (a->empty || b->empty) {
837 snd_interval_none(c);
838 return;
839 }
840 c->empty = 0;
841 c->min = muldiv32(a->min, k, b->max, &r);
842 c->openmin = (r || a->openmin || b->openmax);
843 if (b->min > 0) {
844 c->max = muldiv32(a->max, k, b->min, &r);
845 if (r) {
846 c->max++;
847 c->openmax = 1;
848 } else
849 c->openmax = (a->openmax || b->openmin);
850 } else {
851 c->max = UINT_MAX;
852 c->openmax = 0;
853 }
854 c->integer = 0;
855}
856
857/* ---- */
858
859
860/**
861 * snd_interval_ratnum - refine the interval value
862 * @i: interval to refine
863 * @rats_count: number of ratnum_t
864 * @rats: ratnum_t array
865 * @nump: pointer to store the resultant numerator
866 * @denp: pointer to store the resultant denominator
867 *
868 * Return: Positive if the value is changed, zero if it's not changed, or a
869 * negative error code.
870 */
871int snd_interval_ratnum(struct snd_interval *i,
872 unsigned int rats_count, struct snd_ratnum *rats,
873 unsigned int *nump, unsigned int *denp)
874{
875 unsigned int best_num, best_den;
876 int best_diff;
877 unsigned int k;
878 struct snd_interval t;
879 int err;
880 unsigned int result_num, result_den;
881 int result_diff;
882
883 best_num = best_den = best_diff = 0;
884 for (k = 0; k < rats_count; ++k) {
885 unsigned int num = rats[k].num;
886 unsigned int den;
887 unsigned int q = i->min;
888 int diff;
889 if (q == 0)
890 q = 1;
891 den = div_up(num, q);
892 if (den < rats[k].den_min)
893 continue;
894 if (den > rats[k].den_max)
895 den = rats[k].den_max;
896 else {
897 unsigned int r;
898 r = (den - rats[k].den_min) % rats[k].den_step;
899 if (r != 0)
900 den -= r;
901 }
902 diff = num - q * den;
903 if (diff < 0)
904 diff = -diff;
905 if (best_num == 0 ||
906 diff * best_den < best_diff * den) {
907 best_diff = diff;
908 best_den = den;
909 best_num = num;
910 }
911 }
912 if (best_den == 0) {
913 i->empty = 1;
914 return -EINVAL;
915 }
916 t.min = div_down(best_num, best_den);
917 t.openmin = !!(best_num % best_den);
918
919 result_num = best_num;
920 result_diff = best_diff;
921 result_den = best_den;
922 best_num = best_den = best_diff = 0;
923 for (k = 0; k < rats_count; ++k) {
924 unsigned int num = rats[k].num;
925 unsigned int den;
926 unsigned int q = i->max;
927 int diff;
928 if (q == 0) {
929 i->empty = 1;
930 return -EINVAL;
931 }
932 den = div_down(num, q);
933 if (den > rats[k].den_max)
934 continue;
935 if (den < rats[k].den_min)
936 den = rats[k].den_min;
937 else {
938 unsigned int r;
939 r = (den - rats[k].den_min) % rats[k].den_step;
940 if (r != 0)
941 den += rats[k].den_step - r;
942 }
943 diff = q * den - num;
944 if (diff < 0)
945 diff = -diff;
946 if (best_num == 0 ||
947 diff * best_den < best_diff * den) {
948 best_diff = diff;
949 best_den = den;
950 best_num = num;
951 }
952 }
953 if (best_den == 0) {
954 i->empty = 1;
955 return -EINVAL;
956 }
957 t.max = div_up(best_num, best_den);
958 t.openmax = !!(best_num % best_den);
959 t.integer = 0;
960 err = snd_interval_refine(i, &t);
961 if (err < 0)
962 return err;
963
964 if (snd_interval_single(i)) {
965 if (best_diff * result_den < result_diff * best_den) {
966 result_num = best_num;
967 result_den = best_den;
968 }
969 if (nump)
970 *nump = result_num;
971 if (denp)
972 *denp = result_den;
973 }
974 return err;
975}
976
977EXPORT_SYMBOL(snd_interval_ratnum);
978
979/**
980 * snd_interval_ratden - refine the interval value
981 * @i: interval to refine
982 * @rats_count: number of struct ratden
983 * @rats: struct ratden array
984 * @nump: pointer to store the resultant numerator
985 * @denp: pointer to store the resultant denominator
986 *
987 * Return: Positive if the value is changed, zero if it's not changed, or a
988 * negative error code.
989 */
990static int snd_interval_ratden(struct snd_interval *i,
991 unsigned int rats_count, struct snd_ratden *rats,
992 unsigned int *nump, unsigned int *denp)
993{
994 unsigned int best_num, best_diff, best_den;
995 unsigned int k;
996 struct snd_interval t;
997 int err;
998
999 best_num = best_den = best_diff = 0;
1000 for (k = 0; k < rats_count; ++k) {
1001 unsigned int num;
1002 unsigned int den = rats[k].den;
1003 unsigned int q = i->min;
1004 int diff;
1005 num = mul(q, den);
1006 if (num > rats[k].num_max)
1007 continue;
1008 if (num < rats[k].num_min)
1009 num = rats[k].num_max;
1010 else {
1011 unsigned int r;
1012 r = (num - rats[k].num_min) % rats[k].num_step;
1013 if (r != 0)
1014 num += rats[k].num_step - r;
1015 }
1016 diff = num - q * den;
1017 if (best_num == 0 ||
1018 diff * best_den < best_diff * den) {
1019 best_diff = diff;
1020 best_den = den;
1021 best_num = num;
1022 }
1023 }
1024 if (best_den == 0) {
1025 i->empty = 1;
1026 return -EINVAL;
1027 }
1028 t.min = div_down(best_num, best_den);
1029 t.openmin = !!(best_num % best_den);
1030
1031 best_num = best_den = best_diff = 0;
1032 for (k = 0; k < rats_count; ++k) {
1033 unsigned int num;
1034 unsigned int den = rats[k].den;
1035 unsigned int q = i->max;
1036 int diff;
1037 num = mul(q, den);
1038 if (num < rats[k].num_min)
1039 continue;
1040 if (num > rats[k].num_max)
1041 num = rats[k].num_max;
1042 else {
1043 unsigned int r;
1044 r = (num - rats[k].num_min) % rats[k].num_step;
1045 if (r != 0)
1046 num -= r;
1047 }
1048 diff = q * den - num;
1049 if (best_num == 0 ||
1050 diff * best_den < best_diff * den) {
1051 best_diff = diff;
1052 best_den = den;
1053 best_num = num;
1054 }
1055 }
1056 if (best_den == 0) {
1057 i->empty = 1;
1058 return -EINVAL;
1059 }
1060 t.max = div_up(best_num, best_den);
1061 t.openmax = !!(best_num % best_den);
1062 t.integer = 0;
1063 err = snd_interval_refine(i, &t);
1064 if (err < 0)
1065 return err;
1066
1067 if (snd_interval_single(i)) {
1068 if (nump)
1069 *nump = best_num;
1070 if (denp)
1071 *denp = best_den;
1072 }
1073 return err;
1074}
1075
1076/**
1077 * snd_interval_list - refine the interval value from the list
1078 * @i: the interval value to refine
1079 * @count: the number of elements in the list
1080 * @list: the value list
1081 * @mask: the bit-mask to evaluate
1082 *
1083 * Refines the interval value from the list.
1084 * When mask is non-zero, only the elements corresponding to bit 1 are
1085 * evaluated.
1086 *
1087 * Return: Positive if the value is changed, zero if it's not changed, or a
1088 * negative error code.
1089 */
1090int snd_interval_list(struct snd_interval *i, unsigned int count,
1091 const unsigned int *list, unsigned int mask)
1092{
1093 unsigned int k;
1094 struct snd_interval list_range;
1095
1096 if (!count) {
1097 i->empty = 1;
1098 return -EINVAL;
1099 }
1100 snd_interval_any(&list_range);
1101 list_range.min = UINT_MAX;
1102 list_range.max = 0;
1103 for (k = 0; k < count; k++) {
1104 if (mask && !(mask & (1 << k)))
1105 continue;
1106 if (!snd_interval_test(i, list[k]))
1107 continue;
1108 list_range.min = min(list_range.min, list[k]);
1109 list_range.max = max(list_range.max, list[k]);
1110 }
1111 return snd_interval_refine(i, &list_range);
1112}
1113
1114EXPORT_SYMBOL(snd_interval_list);
1115
1116static int snd_interval_step(struct snd_interval *i, unsigned int min, unsigned int step)
1117{
1118 unsigned int n;
1119 int changed = 0;
1120 n = (i->min - min) % step;
1121 if (n != 0 || i->openmin) {
1122 i->min += step - n;
1123 changed = 1;
1124 }
1125 n = (i->max - min) % step;
1126 if (n != 0 || i->openmax) {
1127 i->max -= n;
1128 changed = 1;
1129 }
1130 if (snd_interval_checkempty(i)) {
1131 i->empty = 1;
1132 return -EINVAL;
1133 }
1134 return changed;
1135}
1136
1137/* Info constraints helpers */
1138
1139/**
1140 * snd_pcm_hw_rule_add - add the hw-constraint rule
1141 * @runtime: the pcm runtime instance
1142 * @cond: condition bits
1143 * @var: the variable to evaluate
1144 * @func: the evaluation function
1145 * @private: the private data pointer passed to function
1146 * @dep: the dependent variables
1147 *
1148 * Return: Zero if successful, or a negative error code on failure.
1149 */
1150int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, unsigned int cond,
1151 int var,
1152 snd_pcm_hw_rule_func_t func, void *private,
1153 int dep, ...)
1154{
1155 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1156 struct snd_pcm_hw_rule *c;
1157 unsigned int k;
1158 va_list args;
1159 va_start(args, dep);
1160 if (constrs->rules_num >= constrs->rules_all) {
1161 struct snd_pcm_hw_rule *new;
1162 unsigned int new_rules = constrs->rules_all + 16;
1163 new = kcalloc(new_rules, sizeof(*c), GFP_KERNEL);
1164 if (!new) {
1165 va_end(args);
1166 return -ENOMEM;
1167 }
1168 if (constrs->rules) {
1169 memcpy(new, constrs->rules,
1170 constrs->rules_num * sizeof(*c));
1171 kfree(constrs->rules);
1172 }
1173 constrs->rules = new;
1174 constrs->rules_all = new_rules;
1175 }
1176 c = &constrs->rules[constrs->rules_num];
1177 c->cond = cond;
1178 c->func = func;
1179 c->var = var;
1180 c->private = private;
1181 k = 0;
1182 while (1) {
1183 if (snd_BUG_ON(k >= ARRAY_SIZE(c->deps))) {
1184 va_end(args);
1185 return -EINVAL;
1186 }
1187 c->deps[k++] = dep;
1188 if (dep < 0)
1189 break;
1190 dep = va_arg(args, int);
1191 }
1192 constrs->rules_num++;
1193 va_end(args);
1194 return 0;
1195}
1196
1197EXPORT_SYMBOL(snd_pcm_hw_rule_add);
1198
1199/**
1200 * snd_pcm_hw_constraint_mask - apply the given bitmap mask constraint
1201 * @runtime: PCM runtime instance
1202 * @var: hw_params variable to apply the mask
1203 * @mask: the bitmap mask
1204 *
1205 * Apply the constraint of the given bitmap mask to a 32-bit mask parameter.
1206 *
1207 * Return: Zero if successful, or a negative error code on failure.
1208 */
1209int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1210 u_int32_t mask)
1211{
1212 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1213 struct snd_mask *maskp = constrs_mask(constrs, var);
1214 *maskp->bits &= mask;
1215 memset(maskp->bits + 1, 0, (SNDRV_MASK_MAX-32) / 8); /* clear rest */
1216 if (*maskp->bits == 0)
1217 return -EINVAL;
1218 return 0;
1219}
1220
1221/**
1222 * snd_pcm_hw_constraint_mask64 - apply the given bitmap mask constraint
1223 * @runtime: PCM runtime instance
1224 * @var: hw_params variable to apply the mask
1225 * @mask: the 64bit bitmap mask
1226 *
1227 * Apply the constraint of the given bitmap mask to a 64-bit mask parameter.
1228 *
1229 * Return: Zero if successful, or a negative error code on failure.
1230 */
1231int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1232 u_int64_t mask)
1233{
1234 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1235 struct snd_mask *maskp = constrs_mask(constrs, var);
1236 maskp->bits[0] &= (u_int32_t)mask;
1237 maskp->bits[1] &= (u_int32_t)(mask >> 32);
1238 memset(maskp->bits + 2, 0, (SNDRV_MASK_MAX-64) / 8); /* clear rest */
1239 if (! maskp->bits[0] && ! maskp->bits[1])
1240 return -EINVAL;
1241 return 0;
1242}
1243EXPORT_SYMBOL(snd_pcm_hw_constraint_mask64);
1244
1245/**
1246 * snd_pcm_hw_constraint_integer - apply an integer constraint to an interval
1247 * @runtime: PCM runtime instance
1248 * @var: hw_params variable to apply the integer constraint
1249 *
1250 * Apply the constraint of integer to an interval parameter.
1251 *
1252 * Return: Positive if the value is changed, zero if it's not changed, or a
1253 * negative error code.
1254 */
1255int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var)
1256{
1257 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1258 return snd_interval_setinteger(constrs_interval(constrs, var));
1259}
1260
1261EXPORT_SYMBOL(snd_pcm_hw_constraint_integer);
1262
1263/**
1264 * snd_pcm_hw_constraint_minmax - apply a min/max range constraint to an interval
1265 * @runtime: PCM runtime instance
1266 * @var: hw_params variable to apply the range
1267 * @min: the minimal value
1268 * @max: the maximal value
1269 *
1270 * Apply the min/max range constraint to an interval parameter.
1271 *
1272 * Return: Positive if the value is changed, zero if it's not changed, or a
1273 * negative error code.
1274 */
1275int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1276 unsigned int min, unsigned int max)
1277{
1278 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1279 struct snd_interval t;
1280 t.min = min;
1281 t.max = max;
1282 t.openmin = t.openmax = 0;
1283 t.integer = 0;
1284 return snd_interval_refine(constrs_interval(constrs, var), &t);
1285}
1286
1287EXPORT_SYMBOL(snd_pcm_hw_constraint_minmax);
1288
1289static int snd_pcm_hw_rule_list(struct snd_pcm_hw_params *params,
1290 struct snd_pcm_hw_rule *rule)
1291{
1292 struct snd_pcm_hw_constraint_list *list = rule->private;
1293 return snd_interval_list(hw_param_interval(params, rule->var), list->count, list->list, list->mask);
1294}
1295
1296
1297/**
1298 * snd_pcm_hw_constraint_list - apply a list of constraints to a parameter
1299 * @runtime: PCM runtime instance
1300 * @cond: condition bits
1301 * @var: hw_params variable to apply the list constraint
1302 * @l: list
1303 *
1304 * Apply the list of constraints to an interval parameter.
1305 *
1306 * Return: Zero if successful, or a negative error code on failure.
1307 */
1308int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1309 unsigned int cond,
1310 snd_pcm_hw_param_t var,
1311 const struct snd_pcm_hw_constraint_list *l)
1312{
1313 return snd_pcm_hw_rule_add(runtime, cond, var,
1314 snd_pcm_hw_rule_list, (void *)l,
1315 var, -1);
1316}
1317
1318EXPORT_SYMBOL(snd_pcm_hw_constraint_list);
1319
1320static int snd_pcm_hw_rule_ratnums(struct snd_pcm_hw_params *params,
1321 struct snd_pcm_hw_rule *rule)
1322{
1323 struct snd_pcm_hw_constraint_ratnums *r = rule->private;
1324 unsigned int num = 0, den = 0;
1325 int err;
1326 err = snd_interval_ratnum(hw_param_interval(params, rule->var),
1327 r->nrats, r->rats, &num, &den);
1328 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1329 params->rate_num = num;
1330 params->rate_den = den;
1331 }
1332 return err;
1333}
1334
1335/**
1336 * snd_pcm_hw_constraint_ratnums - apply ratnums constraint to a parameter
1337 * @runtime: PCM runtime instance
1338 * @cond: condition bits
1339 * @var: hw_params variable to apply the ratnums constraint
1340 * @r: struct snd_ratnums constriants
1341 *
1342 * Return: Zero if successful, or a negative error code on failure.
1343 */
1344int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1345 unsigned int cond,
1346 snd_pcm_hw_param_t var,
1347 struct snd_pcm_hw_constraint_ratnums *r)
1348{
1349 return snd_pcm_hw_rule_add(runtime, cond, var,
1350 snd_pcm_hw_rule_ratnums, r,
1351 var, -1);
1352}
1353
1354EXPORT_SYMBOL(snd_pcm_hw_constraint_ratnums);
1355
1356static int snd_pcm_hw_rule_ratdens(struct snd_pcm_hw_params *params,
1357 struct snd_pcm_hw_rule *rule)
1358{
1359 struct snd_pcm_hw_constraint_ratdens *r = rule->private;
1360 unsigned int num = 0, den = 0;
1361 int err = snd_interval_ratden(hw_param_interval(params, rule->var),
1362 r->nrats, r->rats, &num, &den);
1363 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1364 params->rate_num = num;
1365 params->rate_den = den;
1366 }
1367 return err;
1368}
1369
1370/**
1371 * snd_pcm_hw_constraint_ratdens - apply ratdens constraint to a parameter
1372 * @runtime: PCM runtime instance
1373 * @cond: condition bits
1374 * @var: hw_params variable to apply the ratdens constraint
1375 * @r: struct snd_ratdens constriants
1376 *
1377 * Return: Zero if successful, or a negative error code on failure.
1378 */
1379int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1380 unsigned int cond,
1381 snd_pcm_hw_param_t var,
1382 struct snd_pcm_hw_constraint_ratdens *r)
1383{
1384 return snd_pcm_hw_rule_add(runtime, cond, var,
1385 snd_pcm_hw_rule_ratdens, r,
1386 var, -1);
1387}
1388
1389EXPORT_SYMBOL(snd_pcm_hw_constraint_ratdens);
1390
1391static int snd_pcm_hw_rule_msbits(struct snd_pcm_hw_params *params,
1392 struct snd_pcm_hw_rule *rule)
1393{
1394 unsigned int l = (unsigned long) rule->private;
1395 int width = l & 0xffff;
1396 unsigned int msbits = l >> 16;
1397 struct snd_interval *i = hw_param_interval(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
1398 if (snd_interval_single(i) && snd_interval_value(i) == width)
1399 params->msbits = msbits;
1400 return 0;
1401}
1402
1403/**
1404 * snd_pcm_hw_constraint_msbits - add a hw constraint msbits rule
1405 * @runtime: PCM runtime instance
1406 * @cond: condition bits
1407 * @width: sample bits width
1408 * @msbits: msbits width
1409 *
1410 * Return: Zero if successful, or a negative error code on failure.
1411 */
1412int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1413 unsigned int cond,
1414 unsigned int width,
1415 unsigned int msbits)
1416{
1417 unsigned long l = (msbits << 16) | width;
1418 return snd_pcm_hw_rule_add(runtime, cond, -1,
1419 snd_pcm_hw_rule_msbits,
1420 (void*) l,
1421 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
1422}
1423
1424EXPORT_SYMBOL(snd_pcm_hw_constraint_msbits);
1425
1426static int snd_pcm_hw_rule_step(struct snd_pcm_hw_params *params,
1427 struct snd_pcm_hw_rule *rule)
1428{
1429 unsigned long step = (unsigned long) rule->private;
1430 return snd_interval_step(hw_param_interval(params, rule->var), 0, step);
1431}
1432
1433/**
1434 * snd_pcm_hw_constraint_step - add a hw constraint step rule
1435 * @runtime: PCM runtime instance
1436 * @cond: condition bits
1437 * @var: hw_params variable to apply the step constraint
1438 * @step: step size
1439 *
1440 * Return: Zero if successful, or a negative error code on failure.
1441 */
1442int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1443 unsigned int cond,
1444 snd_pcm_hw_param_t var,
1445 unsigned long step)
1446{
1447 return snd_pcm_hw_rule_add(runtime, cond, var,
1448 snd_pcm_hw_rule_step, (void *) step,
1449 var, -1);
1450}
1451
1452EXPORT_SYMBOL(snd_pcm_hw_constraint_step);
1453
1454static int snd_pcm_hw_rule_pow2(struct snd_pcm_hw_params *params, struct snd_pcm_hw_rule *rule)
1455{
1456 static unsigned int pow2_sizes[] = {
1457 1<<0, 1<<1, 1<<2, 1<<3, 1<<4, 1<<5, 1<<6, 1<<7,
1458 1<<8, 1<<9, 1<<10, 1<<11, 1<<12, 1<<13, 1<<14, 1<<15,
1459 1<<16, 1<<17, 1<<18, 1<<19, 1<<20, 1<<21, 1<<22, 1<<23,
1460 1<<24, 1<<25, 1<<26, 1<<27, 1<<28, 1<<29, 1<<30
1461 };
1462 return snd_interval_list(hw_param_interval(params, rule->var),
1463 ARRAY_SIZE(pow2_sizes), pow2_sizes, 0);
1464}
1465
1466/**
1467 * snd_pcm_hw_constraint_pow2 - add a hw constraint power-of-2 rule
1468 * @runtime: PCM runtime instance
1469 * @cond: condition bits
1470 * @var: hw_params variable to apply the power-of-2 constraint
1471 *
1472 * Return: Zero if successful, or a negative error code on failure.
1473 */
1474int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1475 unsigned int cond,
1476 snd_pcm_hw_param_t var)
1477{
1478 return snd_pcm_hw_rule_add(runtime, cond, var,
1479 snd_pcm_hw_rule_pow2, NULL,
1480 var, -1);
1481}
1482
1483EXPORT_SYMBOL(snd_pcm_hw_constraint_pow2);
1484
1485static int snd_pcm_hw_rule_noresample_func(struct snd_pcm_hw_params *params,
1486 struct snd_pcm_hw_rule *rule)
1487{
1488 unsigned int base_rate = (unsigned int)(uintptr_t)rule->private;
1489 struct snd_interval *rate;
1490
1491 rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1492 return snd_interval_list(rate, 1, &base_rate, 0);
1493}
1494
1495/**
1496 * snd_pcm_hw_rule_noresample - add a rule to allow disabling hw resampling
1497 * @runtime: PCM runtime instance
1498 * @base_rate: the rate at which the hardware does not resample
1499 *
1500 * Return: Zero if successful, or a negative error code on failure.
1501 */
1502int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1503 unsigned int base_rate)
1504{
1505 return snd_pcm_hw_rule_add(runtime, SNDRV_PCM_HW_PARAMS_NORESAMPLE,
1506 SNDRV_PCM_HW_PARAM_RATE,
1507 snd_pcm_hw_rule_noresample_func,
1508 (void *)(uintptr_t)base_rate,
1509 SNDRV_PCM_HW_PARAM_RATE, -1);
1510}
1511EXPORT_SYMBOL(snd_pcm_hw_rule_noresample);
1512
1513static void _snd_pcm_hw_param_any(struct snd_pcm_hw_params *params,
1514 snd_pcm_hw_param_t var)
1515{
1516 if (hw_is_mask(var)) {
1517 snd_mask_any(hw_param_mask(params, var));
1518 params->cmask |= 1 << var;
1519 params->rmask |= 1 << var;
1520 return;
1521 }
1522 if (hw_is_interval(var)) {
1523 snd_interval_any(hw_param_interval(params, var));
1524 params->cmask |= 1 << var;
1525 params->rmask |= 1 << var;
1526 return;
1527 }
1528 snd_BUG();
1529}
1530
1531void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params)
1532{
1533 unsigned int k;
1534 memset(params, 0, sizeof(*params));
1535 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++)
1536 _snd_pcm_hw_param_any(params, k);
1537 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
1538 _snd_pcm_hw_param_any(params, k);
1539 params->info = ~0U;
1540}
1541
1542EXPORT_SYMBOL(_snd_pcm_hw_params_any);
1543
1544/**
1545 * snd_pcm_hw_param_value - return @params field @var value
1546 * @params: the hw_params instance
1547 * @var: parameter to retrieve
1548 * @dir: pointer to the direction (-1,0,1) or %NULL
1549 *
1550 * Return: The value for field @var if it's fixed in configuration space
1551 * defined by @params. -%EINVAL otherwise.
1552 */
1553int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
1554 snd_pcm_hw_param_t var, int *dir)
1555{
1556 if (hw_is_mask(var)) {
1557 const struct snd_mask *mask = hw_param_mask_c(params, var);
1558 if (!snd_mask_single(mask))
1559 return -EINVAL;
1560 if (dir)
1561 *dir = 0;
1562 return snd_mask_value(mask);
1563 }
1564 if (hw_is_interval(var)) {
1565 const struct snd_interval *i = hw_param_interval_c(params, var);
1566 if (!snd_interval_single(i))
1567 return -EINVAL;
1568 if (dir)
1569 *dir = i->openmin;
1570 return snd_interval_value(i);
1571 }
1572 return -EINVAL;
1573}
1574
1575EXPORT_SYMBOL(snd_pcm_hw_param_value);
1576
1577void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params,
1578 snd_pcm_hw_param_t var)
1579{
1580 if (hw_is_mask(var)) {
1581 snd_mask_none(hw_param_mask(params, var));
1582 params->cmask |= 1 << var;
1583 params->rmask |= 1 << var;
1584 } else if (hw_is_interval(var)) {
1585 snd_interval_none(hw_param_interval(params, var));
1586 params->cmask |= 1 << var;
1587 params->rmask |= 1 << var;
1588 } else {
1589 snd_BUG();
1590 }
1591}
1592
1593EXPORT_SYMBOL(_snd_pcm_hw_param_setempty);
1594
1595static int _snd_pcm_hw_param_first(struct snd_pcm_hw_params *params,
1596 snd_pcm_hw_param_t var)
1597{
1598 int changed;
1599 if (hw_is_mask(var))
1600 changed = snd_mask_refine_first(hw_param_mask(params, var));
1601 else if (hw_is_interval(var))
1602 changed = snd_interval_refine_first(hw_param_interval(params, var));
1603 else
1604 return -EINVAL;
1605 if (changed) {
1606 params->cmask |= 1 << var;
1607 params->rmask |= 1 << var;
1608 }
1609 return changed;
1610}
1611
1612
1613/**
1614 * snd_pcm_hw_param_first - refine config space and return minimum value
1615 * @pcm: PCM instance
1616 * @params: the hw_params instance
1617 * @var: parameter to retrieve
1618 * @dir: pointer to the direction (-1,0,1) or %NULL
1619 *
1620 * Inside configuration space defined by @params remove from @var all
1621 * values > minimum. Reduce configuration space accordingly.
1622 *
1623 * Return: The minimum, or a negative error code on failure.
1624 */
1625int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
1626 struct snd_pcm_hw_params *params,
1627 snd_pcm_hw_param_t var, int *dir)
1628{
1629 int changed = _snd_pcm_hw_param_first(params, var);
1630 if (changed < 0)
1631 return changed;
1632 if (params->rmask) {
1633 int err = snd_pcm_hw_refine(pcm, params);
1634 if (snd_BUG_ON(err < 0))
1635 return err;
1636 }
1637 return snd_pcm_hw_param_value(params, var, dir);
1638}
1639
1640EXPORT_SYMBOL(snd_pcm_hw_param_first);
1641
1642static int _snd_pcm_hw_param_last(struct snd_pcm_hw_params *params,
1643 snd_pcm_hw_param_t var)
1644{
1645 int changed;
1646 if (hw_is_mask(var))
1647 changed = snd_mask_refine_last(hw_param_mask(params, var));
1648 else if (hw_is_interval(var))
1649 changed = snd_interval_refine_last(hw_param_interval(params, var));
1650 else
1651 return -EINVAL;
1652 if (changed) {
1653 params->cmask |= 1 << var;
1654 params->rmask |= 1 << var;
1655 }
1656 return changed;
1657}
1658
1659
1660/**
1661 * snd_pcm_hw_param_last - refine config space and return maximum value
1662 * @pcm: PCM instance
1663 * @params: the hw_params instance
1664 * @var: parameter to retrieve
1665 * @dir: pointer to the direction (-1,0,1) or %NULL
1666 *
1667 * Inside configuration space defined by @params remove from @var all
1668 * values < maximum. Reduce configuration space accordingly.
1669 *
1670 * Return: The maximum, or a negative error code on failure.
1671 */
1672int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
1673 struct snd_pcm_hw_params *params,
1674 snd_pcm_hw_param_t var, int *dir)
1675{
1676 int changed = _snd_pcm_hw_param_last(params, var);
1677 if (changed < 0)
1678 return changed;
1679 if (params->rmask) {
1680 int err = snd_pcm_hw_refine(pcm, params);
1681 if (snd_BUG_ON(err < 0))
1682 return err;
1683 }
1684 return snd_pcm_hw_param_value(params, var, dir);
1685}
1686
1687EXPORT_SYMBOL(snd_pcm_hw_param_last);
1688
1689/**
1690 * snd_pcm_hw_param_choose - choose a configuration defined by @params
1691 * @pcm: PCM instance
1692 * @params: the hw_params instance
1693 *
1694 * Choose one configuration from configuration space defined by @params.
1695 * The configuration chosen is that obtained fixing in this order:
1696 * first access, first format, first subformat, min channels,
1697 * min rate, min period time, max buffer size, min tick time
1698 *
1699 * Return: Zero if successful, or a negative error code on failure.
1700 */
1701int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
1702 struct snd_pcm_hw_params *params)
1703{
1704 static int vars[] = {
1705 SNDRV_PCM_HW_PARAM_ACCESS,
1706 SNDRV_PCM_HW_PARAM_FORMAT,
1707 SNDRV_PCM_HW_PARAM_SUBFORMAT,
1708 SNDRV_PCM_HW_PARAM_CHANNELS,
1709 SNDRV_PCM_HW_PARAM_RATE,
1710 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
1711 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
1712 SNDRV_PCM_HW_PARAM_TICK_TIME,
1713 -1
1714 };
1715 int err, *v;
1716
1717 for (v = vars; *v != -1; v++) {
1718 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
1719 err = snd_pcm_hw_param_first(pcm, params, *v, NULL);
1720 else
1721 err = snd_pcm_hw_param_last(pcm, params, *v, NULL);
1722 if (snd_BUG_ON(err < 0))
1723 return err;
1724 }
1725 return 0;
1726}
1727
1728static int snd_pcm_lib_ioctl_reset(struct snd_pcm_substream *substream,
1729 void *arg)
1730{
1731 struct snd_pcm_runtime *runtime = substream->runtime;
1732 unsigned long flags;
1733 snd_pcm_stream_lock_irqsave(substream, flags);
1734 if (snd_pcm_running(substream) &&
1735 snd_pcm_update_hw_ptr(substream) >= 0)
1736 runtime->status->hw_ptr %= runtime->buffer_size;
1737 else {
1738 runtime->status->hw_ptr = 0;
1739 runtime->hw_ptr_wrap = 0;
1740 }
1741 snd_pcm_stream_unlock_irqrestore(substream, flags);
1742 return 0;
1743}
1744
1745static int snd_pcm_lib_ioctl_channel_info(struct snd_pcm_substream *substream,
1746 void *arg)
1747{
1748 struct snd_pcm_channel_info *info = arg;
1749 struct snd_pcm_runtime *runtime = substream->runtime;
1750 int width;
1751 if (!(runtime->info & SNDRV_PCM_INFO_MMAP)) {
1752 info->offset = -1;
1753 return 0;
1754 }
1755 width = snd_pcm_format_physical_width(runtime->format);
1756 if (width < 0)
1757 return width;
1758 info->offset = 0;
1759 switch (runtime->access) {
1760 case SNDRV_PCM_ACCESS_MMAP_INTERLEAVED:
1761 case SNDRV_PCM_ACCESS_RW_INTERLEAVED:
1762 info->first = info->channel * width;
1763 info->step = runtime->channels * width;
1764 break;
1765 case SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED:
1766 case SNDRV_PCM_ACCESS_RW_NONINTERLEAVED:
1767 {
1768 size_t size = runtime->dma_bytes / runtime->channels;
1769 info->first = info->channel * size * 8;
1770 info->step = width;
1771 break;
1772 }
1773 default:
1774 snd_BUG();
1775 break;
1776 }
1777 return 0;
1778}
1779
1780static int snd_pcm_lib_ioctl_fifo_size(struct snd_pcm_substream *substream,
1781 void *arg)
1782{
1783 struct snd_pcm_hw_params *params = arg;
1784 snd_pcm_format_t format;
1785 int channels, width;
1786
1787 params->fifo_size = substream->runtime->hw.fifo_size;
1788 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_FIFO_IN_FRAMES)) {
1789 format = params_format(params);
1790 channels = params_channels(params);
1791 width = snd_pcm_format_physical_width(format);
1792 params->fifo_size /= width * channels;
1793 }
1794 return 0;
1795}
1796
1797/**
1798 * snd_pcm_lib_ioctl - a generic PCM ioctl callback
1799 * @substream: the pcm substream instance
1800 * @cmd: ioctl command
1801 * @arg: ioctl argument
1802 *
1803 * Processes the generic ioctl commands for PCM.
1804 * Can be passed as the ioctl callback for PCM ops.
1805 *
1806 * Return: Zero if successful, or a negative error code on failure.
1807 */
1808int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1809 unsigned int cmd, void *arg)
1810{
1811 switch (cmd) {
1812 case SNDRV_PCM_IOCTL1_INFO:
1813 return 0;
1814 case SNDRV_PCM_IOCTL1_RESET:
1815 return snd_pcm_lib_ioctl_reset(substream, arg);
1816 case SNDRV_PCM_IOCTL1_CHANNEL_INFO:
1817 return snd_pcm_lib_ioctl_channel_info(substream, arg);
1818 case SNDRV_PCM_IOCTL1_FIFO_SIZE:
1819 return snd_pcm_lib_ioctl_fifo_size(substream, arg);
1820 }
1821 return -ENXIO;
1822}
1823
1824EXPORT_SYMBOL(snd_pcm_lib_ioctl);
1825
1826/**
1827 * snd_pcm_period_elapsed - update the pcm status for the next period
1828 * @substream: the pcm substream instance
1829 *
1830 * This function is called from the interrupt handler when the
1831 * PCM has processed the period size. It will update the current
1832 * pointer, wake up sleepers, etc.
1833 *
1834 * Even if more than one periods have elapsed since the last call, you
1835 * have to call this only once.
1836 */
1837void snd_pcm_period_elapsed(struct snd_pcm_substream *substream)
1838{
1839 struct snd_pcm_runtime *runtime;
1840 unsigned long flags;
1841
1842 if (PCM_RUNTIME_CHECK(substream))
1843 return;
1844 runtime = substream->runtime;
1845
1846 if (runtime->transfer_ack_begin)
1847 runtime->transfer_ack_begin(substream);
1848
1849 snd_pcm_stream_lock_irqsave(substream, flags);
1850 if (!snd_pcm_running(substream) ||
1851 snd_pcm_update_hw_ptr0(substream, 1) < 0)
1852 goto _end;
1853
1854 if (substream->timer_running)
1855 snd_timer_interrupt(substream->timer, 1);
1856 _end:
1857 snd_pcm_stream_unlock_irqrestore(substream, flags);
1858 if (runtime->transfer_ack_end)
1859 runtime->transfer_ack_end(substream);
1860 kill_fasync(&runtime->fasync, SIGIO, POLL_IN);
1861}
1862
1863EXPORT_SYMBOL(snd_pcm_period_elapsed);
1864
1865/*
1866 * Wait until avail_min data becomes available
1867 * Returns a negative error code if any error occurs during operation.
1868 * The available space is stored on availp. When err = 0 and avail = 0
1869 * on the capture stream, it indicates the stream is in DRAINING state.
1870 */
1871static int wait_for_avail(struct snd_pcm_substream *substream,
1872 snd_pcm_uframes_t *availp)
1873{
1874 struct snd_pcm_runtime *runtime = substream->runtime;
1875 int is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
1876 wait_queue_t wait;
1877 int err = 0;
1878 snd_pcm_uframes_t avail = 0;
1879 long wait_time, tout;
1880
1881 init_waitqueue_entry(&wait, current);
1882 set_current_state(TASK_INTERRUPTIBLE);
1883 add_wait_queue(&runtime->tsleep, &wait);
1884
1885 if (runtime->no_period_wakeup)
1886 wait_time = MAX_SCHEDULE_TIMEOUT;
1887 else {
1888 wait_time = 10;
1889 if (runtime->rate) {
1890 long t = runtime->period_size * 2 / runtime->rate;
1891 wait_time = max(t, wait_time);
1892 }
1893 wait_time = msecs_to_jiffies(wait_time * 1000);
1894 }
1895
1896 for (;;) {
1897 if (signal_pending(current)) {
1898 err = -ERESTARTSYS;
1899 break;
1900 }
1901
1902 /*
1903 * We need to check if space became available already
1904 * (and thus the wakeup happened already) first to close
1905 * the race of space already having become available.
1906 * This check must happen after been added to the waitqueue
1907 * and having current state be INTERRUPTIBLE.
1908 */
1909 if (is_playback)
1910 avail = snd_pcm_playback_avail(runtime);
1911 else
1912 avail = snd_pcm_capture_avail(runtime);
1913 if (avail >= runtime->twake)
1914 break;
1915 snd_pcm_stream_unlock_irq(substream);
1916
1917 tout = schedule_timeout(wait_time);
1918
1919 snd_pcm_stream_lock_irq(substream);
1920 set_current_state(TASK_INTERRUPTIBLE);
1921 switch (runtime->status->state) {
1922 case SNDRV_PCM_STATE_SUSPENDED:
1923 err = -ESTRPIPE;
1924 goto _endloop;
1925 case SNDRV_PCM_STATE_XRUN:
1926 err = -EPIPE;
1927 goto _endloop;
1928 case SNDRV_PCM_STATE_DRAINING:
1929 if (is_playback)
1930 err = -EPIPE;
1931 else
1932 avail = 0; /* indicate draining */
1933 goto _endloop;
1934 case SNDRV_PCM_STATE_OPEN:
1935 case SNDRV_PCM_STATE_SETUP:
1936 case SNDRV_PCM_STATE_DISCONNECTED:
1937 err = -EBADFD;
1938 goto _endloop;
1939 case SNDRV_PCM_STATE_PAUSED:
1940 continue;
1941 }
1942 if (!tout) {
1943 pcm_dbg(substream->pcm,
1944 "%s write error (DMA or IRQ trouble?)\n",
1945 is_playback ? "playback" : "capture");
1946 err = -EIO;
1947 break;
1948 }
1949 }
1950 _endloop:
1951 set_current_state(TASK_RUNNING);
1952 remove_wait_queue(&runtime->tsleep, &wait);
1953 *availp = avail;
1954 return err;
1955}
1956
1957static int snd_pcm_lib_write_transfer(struct snd_pcm_substream *substream,
1958 unsigned int hwoff,
1959 unsigned long data, unsigned int off,
1960 snd_pcm_uframes_t frames)
1961{
1962 struct snd_pcm_runtime *runtime = substream->runtime;
1963 int err;
1964 char __user *buf = (char __user *) data + frames_to_bytes(runtime, off);
1965 if (substream->ops->copy) {
1966 if ((err = substream->ops->copy(substream, -1, hwoff, buf, frames)) < 0)
1967 return err;
1968 } else {
1969 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, hwoff);
1970 if (copy_from_user(hwbuf, buf, frames_to_bytes(runtime, frames)))
1971 return -EFAULT;
1972 }
1973 return 0;
1974}
1975
1976typedef int (*transfer_f)(struct snd_pcm_substream *substream, unsigned int hwoff,
1977 unsigned long data, unsigned int off,
1978 snd_pcm_uframes_t size);
1979
1980static snd_pcm_sframes_t snd_pcm_lib_write1(struct snd_pcm_substream *substream,
1981 unsigned long data,
1982 snd_pcm_uframes_t size,
1983 int nonblock,
1984 transfer_f transfer)
1985{
1986 struct snd_pcm_runtime *runtime = substream->runtime;
1987 snd_pcm_uframes_t xfer = 0;
1988 snd_pcm_uframes_t offset = 0;
1989 snd_pcm_uframes_t avail;
1990 int err = 0;
1991
1992 if (size == 0)
1993 return 0;
1994
1995 snd_pcm_stream_lock_irq(substream);
1996 switch (runtime->status->state) {
1997 case SNDRV_PCM_STATE_PREPARED:
1998 case SNDRV_PCM_STATE_RUNNING:
1999 case SNDRV_PCM_STATE_PAUSED:
2000 break;
2001 case SNDRV_PCM_STATE_XRUN:
2002 err = -EPIPE;
2003 goto _end_unlock;
2004 case SNDRV_PCM_STATE_SUSPENDED:
2005 err = -ESTRPIPE;
2006 goto _end_unlock;
2007 default:
2008 err = -EBADFD;
2009 goto _end_unlock;
2010 }
2011
2012 runtime->twake = runtime->control->avail_min ? : 1;
2013 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING)
2014 snd_pcm_update_hw_ptr(substream);
2015 avail = snd_pcm_playback_avail(runtime);
2016 while (size > 0) {
2017 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
2018 snd_pcm_uframes_t cont;
2019 if (!avail) {
2020 if (nonblock) {
2021 err = -EAGAIN;
2022 goto _end_unlock;
2023 }
2024 runtime->twake = min_t(snd_pcm_uframes_t, size,
2025 runtime->control->avail_min ? : 1);
2026 err = wait_for_avail(substream, &avail);
2027 if (err < 0)
2028 goto _end_unlock;
2029 }
2030 frames = size > avail ? avail : size;
2031 cont = runtime->buffer_size - runtime->control->appl_ptr % runtime->buffer_size;
2032 if (frames > cont)
2033 frames = cont;
2034 if (snd_BUG_ON(!frames)) {
2035 runtime->twake = 0;
2036 snd_pcm_stream_unlock_irq(substream);
2037 return -EINVAL;
2038 }
2039 appl_ptr = runtime->control->appl_ptr;
2040 appl_ofs = appl_ptr % runtime->buffer_size;
2041 snd_pcm_stream_unlock_irq(substream);
2042 err = transfer(substream, appl_ofs, data, offset, frames);
2043 snd_pcm_stream_lock_irq(substream);
2044 if (err < 0)
2045 goto _end_unlock;
2046 switch (runtime->status->state) {
2047 case SNDRV_PCM_STATE_XRUN:
2048 err = -EPIPE;
2049 goto _end_unlock;
2050 case SNDRV_PCM_STATE_SUSPENDED:
2051 err = -ESTRPIPE;
2052 goto _end_unlock;
2053 default:
2054 break;
2055 }
2056 appl_ptr += frames;
2057 if (appl_ptr >= runtime->boundary)
2058 appl_ptr -= runtime->boundary;
2059 runtime->control->appl_ptr = appl_ptr;
2060 if (substream->ops->ack)
2061 substream->ops->ack(substream);
2062
2063 offset += frames;
2064 size -= frames;
2065 xfer += frames;
2066 avail -= frames;
2067 if (runtime->status->state == SNDRV_PCM_STATE_PREPARED &&
2068 snd_pcm_playback_hw_avail(runtime) >= (snd_pcm_sframes_t)runtime->start_threshold) {
2069 err = snd_pcm_start(substream);
2070 if (err < 0)
2071 goto _end_unlock;
2072 }
2073 }
2074 _end_unlock:
2075 runtime->twake = 0;
2076 if (xfer > 0 && err >= 0)
2077 snd_pcm_update_state(substream, runtime);
2078 snd_pcm_stream_unlock_irq(substream);
2079 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2080}
2081
2082/* sanity-check for read/write methods */
2083static int pcm_sanity_check(struct snd_pcm_substream *substream)
2084{
2085 struct snd_pcm_runtime *runtime;
2086 if (PCM_RUNTIME_CHECK(substream))
2087 return -ENXIO;
2088 runtime = substream->runtime;
2089 if (snd_BUG_ON(!substream->ops->copy && !runtime->dma_area))
2090 return -EINVAL;
2091 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2092 return -EBADFD;
2093 return 0;
2094}
2095
2096snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream, const void __user *buf, snd_pcm_uframes_t size)
2097{
2098 struct snd_pcm_runtime *runtime;
2099 int nonblock;
2100 int err;
2101
2102 err = pcm_sanity_check(substream);
2103 if (err < 0)
2104 return err;
2105 runtime = substream->runtime;
2106 nonblock = !!(substream->f_flags & O_NONBLOCK);
2107
2108 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
2109 runtime->channels > 1)
2110 return -EINVAL;
2111 return snd_pcm_lib_write1(substream, (unsigned long)buf, size, nonblock,
2112 snd_pcm_lib_write_transfer);
2113}
2114
2115EXPORT_SYMBOL(snd_pcm_lib_write);
2116
2117static int snd_pcm_lib_writev_transfer(struct snd_pcm_substream *substream,
2118 unsigned int hwoff,
2119 unsigned long data, unsigned int off,
2120 snd_pcm_uframes_t frames)
2121{
2122 struct snd_pcm_runtime *runtime = substream->runtime;
2123 int err;
2124 void __user **bufs = (void __user **)data;
2125 int channels = runtime->channels;
2126 int c;
2127 if (substream->ops->copy) {
2128 if (snd_BUG_ON(!substream->ops->silence))
2129 return -EINVAL;
2130 for (c = 0; c < channels; ++c, ++bufs) {
2131 if (*bufs == NULL) {
2132 if ((err = substream->ops->silence(substream, c, hwoff, frames)) < 0)
2133 return err;
2134 } else {
2135 char __user *buf = *bufs + samples_to_bytes(runtime, off);
2136 if ((err = substream->ops->copy(substream, c, hwoff, buf, frames)) < 0)
2137 return err;
2138 }
2139 }
2140 } else {
2141 /* default transfer behaviour */
2142 size_t dma_csize = runtime->dma_bytes / channels;
2143 for (c = 0; c < channels; ++c, ++bufs) {
2144 char *hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, hwoff);
2145 if (*bufs == NULL) {
2146 snd_pcm_format_set_silence(runtime->format, hwbuf, frames);
2147 } else {
2148 char __user *buf = *bufs + samples_to_bytes(runtime, off);
2149 if (copy_from_user(hwbuf, buf, samples_to_bytes(runtime, frames)))
2150 return -EFAULT;
2151 }
2152 }
2153 }
2154 return 0;
2155}
2156
2157snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
2158 void __user **bufs,
2159 snd_pcm_uframes_t frames)
2160{
2161 struct snd_pcm_runtime *runtime;
2162 int nonblock;
2163 int err;
2164
2165 err = pcm_sanity_check(substream);
2166 if (err < 0)
2167 return err;
2168 runtime = substream->runtime;
2169 nonblock = !!(substream->f_flags & O_NONBLOCK);
2170
2171 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2172 return -EINVAL;
2173 return snd_pcm_lib_write1(substream, (unsigned long)bufs, frames,
2174 nonblock, snd_pcm_lib_writev_transfer);
2175}
2176
2177EXPORT_SYMBOL(snd_pcm_lib_writev);
2178
2179static int snd_pcm_lib_read_transfer(struct snd_pcm_substream *substream,
2180 unsigned int hwoff,
2181 unsigned long data, unsigned int off,
2182 snd_pcm_uframes_t frames)
2183{
2184 struct snd_pcm_runtime *runtime = substream->runtime;
2185 int err;
2186 char __user *buf = (char __user *) data + frames_to_bytes(runtime, off);
2187 if (substream->ops->copy) {
2188 if ((err = substream->ops->copy(substream, -1, hwoff, buf, frames)) < 0)
2189 return err;
2190 } else {
2191 char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, hwoff);
2192 if (copy_to_user(buf, hwbuf, frames_to_bytes(runtime, frames)))
2193 return -EFAULT;
2194 }
2195 return 0;
2196}
2197
2198static snd_pcm_sframes_t snd_pcm_lib_read1(struct snd_pcm_substream *substream,
2199 unsigned long data,
2200 snd_pcm_uframes_t size,
2201 int nonblock,
2202 transfer_f transfer)
2203{
2204 struct snd_pcm_runtime *runtime = substream->runtime;
2205 snd_pcm_uframes_t xfer = 0;
2206 snd_pcm_uframes_t offset = 0;
2207 snd_pcm_uframes_t avail;
2208 int err = 0;
2209
2210 if (size == 0)
2211 return 0;
2212
2213 snd_pcm_stream_lock_irq(substream);
2214 switch (runtime->status->state) {
2215 case SNDRV_PCM_STATE_PREPARED:
2216 if (size >= runtime->start_threshold) {
2217 err = snd_pcm_start(substream);
2218 if (err < 0)
2219 goto _end_unlock;
2220 }
2221 break;
2222 case SNDRV_PCM_STATE_DRAINING:
2223 case SNDRV_PCM_STATE_RUNNING:
2224 case SNDRV_PCM_STATE_PAUSED:
2225 break;
2226 case SNDRV_PCM_STATE_XRUN:
2227 err = -EPIPE;
2228 goto _end_unlock;
2229 case SNDRV_PCM_STATE_SUSPENDED:
2230 err = -ESTRPIPE;
2231 goto _end_unlock;
2232 default:
2233 err = -EBADFD;
2234 goto _end_unlock;
2235 }
2236
2237 runtime->twake = runtime->control->avail_min ? : 1;
2238 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING)
2239 snd_pcm_update_hw_ptr(substream);
2240 avail = snd_pcm_capture_avail(runtime);
2241 while (size > 0) {
2242 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
2243 snd_pcm_uframes_t cont;
2244 if (!avail) {
2245 if (runtime->status->state ==
2246 SNDRV_PCM_STATE_DRAINING) {
2247 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2248 goto _end_unlock;
2249 }
2250 if (nonblock) {
2251 err = -EAGAIN;
2252 goto _end_unlock;
2253 }
2254 runtime->twake = min_t(snd_pcm_uframes_t, size,
2255 runtime->control->avail_min ? : 1);
2256 err = wait_for_avail(substream, &avail);
2257 if (err < 0)
2258 goto _end_unlock;
2259 if (!avail)
2260 continue; /* draining */
2261 }
2262 frames = size > avail ? avail : size;
2263 cont = runtime->buffer_size - runtime->control->appl_ptr % runtime->buffer_size;
2264 if (frames > cont)
2265 frames = cont;
2266 if (snd_BUG_ON(!frames)) {
2267 runtime->twake = 0;
2268 snd_pcm_stream_unlock_irq(substream);
2269 return -EINVAL;
2270 }
2271 appl_ptr = runtime->control->appl_ptr;
2272 appl_ofs = appl_ptr % runtime->buffer_size;
2273 snd_pcm_stream_unlock_irq(substream);
2274 err = transfer(substream, appl_ofs, data, offset, frames);
2275 snd_pcm_stream_lock_irq(substream);
2276 if (err < 0)
2277 goto _end_unlock;
2278 switch (runtime->status->state) {
2279 case SNDRV_PCM_STATE_XRUN:
2280 err = -EPIPE;
2281 goto _end_unlock;
2282 case SNDRV_PCM_STATE_SUSPENDED:
2283 err = -ESTRPIPE;
2284 goto _end_unlock;
2285 default:
2286 break;
2287 }
2288 appl_ptr += frames;
2289 if (appl_ptr >= runtime->boundary)
2290 appl_ptr -= runtime->boundary;
2291 runtime->control->appl_ptr = appl_ptr;
2292 if (substream->ops->ack)
2293 substream->ops->ack(substream);
2294
2295 offset += frames;
2296 size -= frames;
2297 xfer += frames;
2298 avail -= frames;
2299 }
2300 _end_unlock:
2301 runtime->twake = 0;
2302 if (xfer > 0 && err >= 0)
2303 snd_pcm_update_state(substream, runtime);
2304 snd_pcm_stream_unlock_irq(substream);
2305 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2306}
2307
2308snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream, void __user *buf, snd_pcm_uframes_t size)
2309{
2310 struct snd_pcm_runtime *runtime;
2311 int nonblock;
2312 int err;
2313
2314 err = pcm_sanity_check(substream);
2315 if (err < 0)
2316 return err;
2317 runtime = substream->runtime;
2318 nonblock = !!(substream->f_flags & O_NONBLOCK);
2319 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED)
2320 return -EINVAL;
2321 return snd_pcm_lib_read1(substream, (unsigned long)buf, size, nonblock, snd_pcm_lib_read_transfer);
2322}
2323
2324EXPORT_SYMBOL(snd_pcm_lib_read);
2325
2326static int snd_pcm_lib_readv_transfer(struct snd_pcm_substream *substream,
2327 unsigned int hwoff,
2328 unsigned long data, unsigned int off,
2329 snd_pcm_uframes_t frames)
2330{
2331 struct snd_pcm_runtime *runtime = substream->runtime;
2332 int err;
2333 void __user **bufs = (void __user **)data;
2334 int channels = runtime->channels;
2335 int c;
2336 if (substream->ops->copy) {
2337 for (c = 0; c < channels; ++c, ++bufs) {
2338 char __user *buf;
2339 if (*bufs == NULL)
2340 continue;
2341 buf = *bufs + samples_to_bytes(runtime, off);
2342 if ((err = substream->ops->copy(substream, c, hwoff, buf, frames)) < 0)
2343 return err;
2344 }
2345 } else {
2346 snd_pcm_uframes_t dma_csize = runtime->dma_bytes / channels;
2347 for (c = 0; c < channels; ++c, ++bufs) {
2348 char *hwbuf;
2349 char __user *buf;
2350 if (*bufs == NULL)
2351 continue;
2352
2353 hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, hwoff);
2354 buf = *bufs + samples_to_bytes(runtime, off);
2355 if (copy_to_user(buf, hwbuf, samples_to_bytes(runtime, frames)))
2356 return -EFAULT;
2357 }
2358 }
2359 return 0;
2360}
2361
2362snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
2363 void __user **bufs,
2364 snd_pcm_uframes_t frames)
2365{
2366 struct snd_pcm_runtime *runtime;
2367 int nonblock;
2368 int err;
2369
2370 err = pcm_sanity_check(substream);
2371 if (err < 0)
2372 return err;
2373 runtime = substream->runtime;
2374 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2375 return -EBADFD;
2376
2377 nonblock = !!(substream->f_flags & O_NONBLOCK);
2378 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2379 return -EINVAL;
2380 return snd_pcm_lib_read1(substream, (unsigned long)bufs, frames, nonblock, snd_pcm_lib_readv_transfer);
2381}
2382
2383EXPORT_SYMBOL(snd_pcm_lib_readv);
2384
2385/*
2386 * standard channel mapping helpers
2387 */
2388
2389/* default channel maps for multi-channel playbacks, up to 8 channels */
2390const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[] = {
2391 { .channels = 1,
2392 .map = { SNDRV_CHMAP_MONO } },
2393 { .channels = 2,
2394 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2395 { .channels = 4,
2396 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2397 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2398 { .channels = 6,
2399 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2400 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2401 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE } },
2402 { .channels = 8,
2403 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2404 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2405 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2406 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2407 { }
2408};
2409EXPORT_SYMBOL_GPL(snd_pcm_std_chmaps);
2410
2411/* alternative channel maps with CLFE <-> surround swapped for 6/8 channels */
2412const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[] = {
2413 { .channels = 1,
2414 .map = { SNDRV_CHMAP_MONO } },
2415 { .channels = 2,
2416 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2417 { .channels = 4,
2418 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2419 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2420 { .channels = 6,
2421 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2422 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2423 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2424 { .channels = 8,
2425 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2426 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2427 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2428 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2429 { }
2430};
2431EXPORT_SYMBOL_GPL(snd_pcm_alt_chmaps);
2432
2433static bool valid_chmap_channels(const struct snd_pcm_chmap *info, int ch)
2434{
2435 if (ch > info->max_channels)
2436 return false;
2437 return !info->channel_mask || (info->channel_mask & (1U << ch));
2438}
2439
2440static int pcm_chmap_ctl_info(struct snd_kcontrol *kcontrol,
2441 struct snd_ctl_elem_info *uinfo)
2442{
2443 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2444
2445 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
2446 uinfo->count = 0;
2447 uinfo->count = info->max_channels;
2448 uinfo->value.integer.min = 0;
2449 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
2450 return 0;
2451}
2452
2453/* get callback for channel map ctl element
2454 * stores the channel position firstly matching with the current channels
2455 */
2456static int pcm_chmap_ctl_get(struct snd_kcontrol *kcontrol,
2457 struct snd_ctl_elem_value *ucontrol)
2458{
2459 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2460 unsigned int idx = snd_ctl_get_ioffidx(kcontrol, &ucontrol->id);
2461 struct snd_pcm_substream *substream;
2462 const struct snd_pcm_chmap_elem *map;
2463
2464 if (snd_BUG_ON(!info->chmap))
2465 return -EINVAL;
2466 substream = snd_pcm_chmap_substream(info, idx);
2467 if (!substream)
2468 return -ENODEV;
2469 memset(ucontrol->value.integer.value, 0,
2470 sizeof(ucontrol->value.integer.value));
2471 if (!substream->runtime)
2472 return 0; /* no channels set */
2473 for (map = info->chmap; map->channels; map++) {
2474 int i;
2475 if (map->channels == substream->runtime->channels &&
2476 valid_chmap_channels(info, map->channels)) {
2477 for (i = 0; i < map->channels; i++)
2478 ucontrol->value.integer.value[i] = map->map[i];
2479 return 0;
2480 }
2481 }
2482 return -EINVAL;
2483}
2484
2485/* tlv callback for channel map ctl element
2486 * expands the pre-defined channel maps in a form of TLV
2487 */
2488static int pcm_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
2489 unsigned int size, unsigned int __user *tlv)
2490{
2491 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2492 const struct snd_pcm_chmap_elem *map;
2493 unsigned int __user *dst;
2494 int c, count = 0;
2495
2496 if (snd_BUG_ON(!info->chmap))
2497 return -EINVAL;
2498 if (size < 8)
2499 return -ENOMEM;
2500 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
2501 return -EFAULT;
2502 size -= 8;
2503 dst = tlv + 2;
2504 for (map = info->chmap; map->channels; map++) {
2505 int chs_bytes = map->channels * 4;
2506 if (!valid_chmap_channels(info, map->channels))
2507 continue;
2508 if (size < 8)
2509 return -ENOMEM;
2510 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
2511 put_user(chs_bytes, dst + 1))
2512 return -EFAULT;
2513 dst += 2;
2514 size -= 8;
2515 count += 8;
2516 if (size < chs_bytes)
2517 return -ENOMEM;
2518 size -= chs_bytes;
2519 count += chs_bytes;
2520 for (c = 0; c < map->channels; c++) {
2521 if (put_user(map->map[c], dst))
2522 return -EFAULT;
2523 dst++;
2524 }
2525 }
2526 if (put_user(count, tlv + 1))
2527 return -EFAULT;
2528 return 0;
2529}
2530
2531static void pcm_chmap_ctl_private_free(struct snd_kcontrol *kcontrol)
2532{
2533 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2534 info->pcm->streams[info->stream].chmap_kctl = NULL;
2535 kfree(info);
2536}
2537
2538/**
2539 * snd_pcm_add_chmap_ctls - create channel-mapping control elements
2540 * @pcm: the assigned PCM instance
2541 * @stream: stream direction
2542 * @chmap: channel map elements (for query)
2543 * @max_channels: the max number of channels for the stream
2544 * @private_value: the value passed to each kcontrol's private_value field
2545 * @info_ret: store struct snd_pcm_chmap instance if non-NULL
2546 *
2547 * Create channel-mapping control elements assigned to the given PCM stream(s).
2548 * Return: Zero if successful, or a negative error value.
2549 */
2550int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
2551 const struct snd_pcm_chmap_elem *chmap,
2552 int max_channels,
2553 unsigned long private_value,
2554 struct snd_pcm_chmap **info_ret)
2555{
2556 struct snd_pcm_chmap *info;
2557 struct snd_kcontrol_new knew = {
2558 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
2559 .access = SNDRV_CTL_ELEM_ACCESS_READ |
2560 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
2561 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,
2562 .info = pcm_chmap_ctl_info,
2563 .get = pcm_chmap_ctl_get,
2564 .tlv.c = pcm_chmap_ctl_tlv,
2565 };
2566 int err;
2567
2568 info = kzalloc(sizeof(*info), GFP_KERNEL);
2569 if (!info)
2570 return -ENOMEM;
2571 info->pcm = pcm;
2572 info->stream = stream;
2573 info->chmap = chmap;
2574 info->max_channels = max_channels;
2575 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2576 knew.name = "Playback Channel Map";
2577 else
2578 knew.name = "Capture Channel Map";
2579 knew.device = pcm->device;
2580 knew.count = pcm->streams[stream].substream_count;
2581 knew.private_value = private_value;
2582 info->kctl = snd_ctl_new1(&knew, info);
2583 if (!info->kctl) {
2584 kfree(info);
2585 return -ENOMEM;
2586 }
2587 info->kctl->private_free = pcm_chmap_ctl_private_free;
2588 err = snd_ctl_add(pcm->card, info->kctl);
2589 if (err < 0)
2590 return err;
2591 pcm->streams[stream].chmap_kctl = info->kctl;
2592 if (info_ret)
2593 *info_ret = info;
2594 return 0;
2595}
2596EXPORT_SYMBOL_GPL(snd_pcm_add_chmap_ctls);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Digital Audio (PCM) abstract layer
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5 * Abramo Bagnara <abramo@alsa-project.org>
6 */
7
8#include <linux/slab.h>
9#include <linux/sched/signal.h>
10#include <linux/time.h>
11#include <linux/math64.h>
12#include <linux/export.h>
13#include <sound/core.h>
14#include <sound/control.h>
15#include <sound/tlv.h>
16#include <sound/info.h>
17#include <sound/pcm.h>
18#include <sound/pcm_params.h>
19#include <sound/timer.h>
20
21#include "pcm_local.h"
22
23#ifdef CONFIG_SND_PCM_XRUN_DEBUG
24#define CREATE_TRACE_POINTS
25#include "pcm_trace.h"
26#else
27#define trace_hwptr(substream, pos, in_interrupt)
28#define trace_xrun(substream)
29#define trace_hw_ptr_error(substream, reason)
30#define trace_applptr(substream, prev, curr)
31#endif
32
33static int fill_silence_frames(struct snd_pcm_substream *substream,
34 snd_pcm_uframes_t off, snd_pcm_uframes_t frames);
35
36
37static inline void update_silence_vars(struct snd_pcm_runtime *runtime,
38 snd_pcm_uframes_t ptr,
39 snd_pcm_uframes_t new_ptr)
40{
41 snd_pcm_sframes_t delta;
42
43 delta = new_ptr - ptr;
44 if (delta == 0)
45 return;
46 if (delta < 0)
47 delta += runtime->boundary;
48 if ((snd_pcm_uframes_t)delta < runtime->silence_filled)
49 runtime->silence_filled -= delta;
50 else
51 runtime->silence_filled = 0;
52 runtime->silence_start = new_ptr;
53}
54
55/*
56 * fill ring buffer with silence
57 * runtime->silence_start: starting pointer to silence area
58 * runtime->silence_filled: size filled with silence
59 * runtime->silence_threshold: threshold from application
60 * runtime->silence_size: maximal size from application
61 *
62 * when runtime->silence_size >= runtime->boundary - fill processed area with silence immediately
63 */
64void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
65{
66 struct snd_pcm_runtime *runtime = substream->runtime;
67 snd_pcm_uframes_t frames, ofs, transfer;
68 int err;
69
70 if (runtime->silence_size < runtime->boundary) {
71 snd_pcm_sframes_t noise_dist;
72 snd_pcm_uframes_t appl_ptr = READ_ONCE(runtime->control->appl_ptr);
73 update_silence_vars(runtime, runtime->silence_start, appl_ptr);
74 /* initialization outside pointer updates */
75 if (new_hw_ptr == ULONG_MAX)
76 new_hw_ptr = runtime->status->hw_ptr;
77 /* get hw_avail with the boundary crossing */
78 noise_dist = appl_ptr - new_hw_ptr;
79 if (noise_dist < 0)
80 noise_dist += runtime->boundary;
81 /* total noise distance */
82 noise_dist += runtime->silence_filled;
83 if (noise_dist >= (snd_pcm_sframes_t) runtime->silence_threshold)
84 return;
85 frames = runtime->silence_threshold - noise_dist;
86 if (frames > runtime->silence_size)
87 frames = runtime->silence_size;
88 } else {
89 /*
90 * This filling mode aims at free-running mode (used for example by dmix),
91 * which doesn't update the application pointer.
92 */
93 snd_pcm_uframes_t hw_ptr = runtime->status->hw_ptr;
94 if (new_hw_ptr == ULONG_MAX) {
95 /*
96 * Initialization, fill the whole unused buffer with silence.
97 *
98 * Usually, this is entered while stopped, before data is queued,
99 * so both pointers are expected to be zero.
100 */
101 snd_pcm_sframes_t avail = runtime->control->appl_ptr - hw_ptr;
102 if (avail < 0)
103 avail += runtime->boundary;
104 /*
105 * In free-running mode, appl_ptr will be zero even while running,
106 * so we end up with a huge number. There is no useful way to
107 * handle this, so we just clear the whole buffer.
108 */
109 runtime->silence_filled = avail > runtime->buffer_size ? 0 : avail;
110 runtime->silence_start = hw_ptr;
111 } else {
112 /* Silence the just played area immediately */
113 update_silence_vars(runtime, hw_ptr, new_hw_ptr);
114 }
115 /*
116 * In this mode, silence_filled actually includes the valid
117 * sample data from the user.
118 */
119 frames = runtime->buffer_size - runtime->silence_filled;
120 }
121 if (snd_BUG_ON(frames > runtime->buffer_size))
122 return;
123 if (frames == 0)
124 return;
125 ofs = (runtime->silence_start + runtime->silence_filled) % runtime->buffer_size;
126 do {
127 transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
128 err = fill_silence_frames(substream, ofs, transfer);
129 snd_BUG_ON(err < 0);
130 runtime->silence_filled += transfer;
131 frames -= transfer;
132 ofs = 0;
133 } while (frames > 0);
134 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
135}
136
137#ifdef CONFIG_SND_DEBUG
138void snd_pcm_debug_name(struct snd_pcm_substream *substream,
139 char *name, size_t len)
140{
141 snprintf(name, len, "pcmC%dD%d%c:%d",
142 substream->pcm->card->number,
143 substream->pcm->device,
144 substream->stream ? 'c' : 'p',
145 substream->number);
146}
147EXPORT_SYMBOL(snd_pcm_debug_name);
148#endif
149
150#define XRUN_DEBUG_BASIC (1<<0)
151#define XRUN_DEBUG_STACK (1<<1) /* dump also stack */
152#define XRUN_DEBUG_JIFFIESCHECK (1<<2) /* do jiffies check */
153
154#ifdef CONFIG_SND_PCM_XRUN_DEBUG
155
156#define xrun_debug(substream, mask) \
157 ((substream)->pstr->xrun_debug & (mask))
158#else
159#define xrun_debug(substream, mask) 0
160#endif
161
162#define dump_stack_on_xrun(substream) do { \
163 if (xrun_debug(substream, XRUN_DEBUG_STACK)) \
164 dump_stack(); \
165 } while (0)
166
167/* call with stream lock held */
168void __snd_pcm_xrun(struct snd_pcm_substream *substream)
169{
170 struct snd_pcm_runtime *runtime = substream->runtime;
171
172 trace_xrun(substream);
173 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
174 struct timespec64 tstamp;
175
176 snd_pcm_gettime(runtime, &tstamp);
177 runtime->status->tstamp.tv_sec = tstamp.tv_sec;
178 runtime->status->tstamp.tv_nsec = tstamp.tv_nsec;
179 }
180 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
181 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
182 char name[16];
183 snd_pcm_debug_name(substream, name, sizeof(name));
184 pcm_warn(substream->pcm, "XRUN: %s\n", name);
185 dump_stack_on_xrun(substream);
186 }
187#ifdef CONFIG_SND_PCM_XRUN_DEBUG
188 substream->xrun_counter++;
189#endif
190}
191
192#ifdef CONFIG_SND_PCM_XRUN_DEBUG
193#define hw_ptr_error(substream, in_interrupt, reason, fmt, args...) \
194 do { \
195 trace_hw_ptr_error(substream, reason); \
196 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) { \
197 pr_err_ratelimited("ALSA: PCM: [%c] " reason ": " fmt, \
198 (in_interrupt) ? 'Q' : 'P', ##args); \
199 dump_stack_on_xrun(substream); \
200 } \
201 } while (0)
202
203#else /* ! CONFIG_SND_PCM_XRUN_DEBUG */
204
205#define hw_ptr_error(substream, fmt, args...) do { } while (0)
206
207#endif
208
209int snd_pcm_update_state(struct snd_pcm_substream *substream,
210 struct snd_pcm_runtime *runtime)
211{
212 snd_pcm_uframes_t avail;
213
214 avail = snd_pcm_avail(substream);
215 if (avail > runtime->avail_max)
216 runtime->avail_max = avail;
217 if (runtime->state == SNDRV_PCM_STATE_DRAINING) {
218 if (avail >= runtime->buffer_size) {
219 snd_pcm_drain_done(substream);
220 return -EPIPE;
221 }
222 } else {
223 if (avail >= runtime->stop_threshold) {
224 __snd_pcm_xrun(substream);
225 return -EPIPE;
226 }
227 }
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);
233 return 0;
234}
235
236static void update_audio_tstamp(struct snd_pcm_substream *substream,
237 struct timespec64 *curr_tstamp,
238 struct timespec64 *audio_tstamp)
239{
240 struct snd_pcm_runtime *runtime = substream->runtime;
241 u64 audio_frames, audio_nsecs;
242 struct timespec64 driver_tstamp;
243
244 if (runtime->tstamp_mode != SNDRV_PCM_TSTAMP_ENABLE)
245 return;
246
247 if (!(substream->ops->get_time_info) ||
248 (runtime->audio_tstamp_report.actual_type ==
249 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
250
251 /*
252 * provide audio timestamp derived from pointer position
253 * add delay only if requested
254 */
255
256 audio_frames = runtime->hw_ptr_wrap + runtime->status->hw_ptr;
257
258 if (runtime->audio_tstamp_config.report_delay) {
259 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
260 audio_frames -= runtime->delay;
261 else
262 audio_frames += runtime->delay;
263 }
264 audio_nsecs = div_u64(audio_frames * 1000000000LL,
265 runtime->rate);
266 *audio_tstamp = ns_to_timespec64(audio_nsecs);
267 }
268
269 if (runtime->status->audio_tstamp.tv_sec != audio_tstamp->tv_sec ||
270 runtime->status->audio_tstamp.tv_nsec != audio_tstamp->tv_nsec) {
271 runtime->status->audio_tstamp.tv_sec = audio_tstamp->tv_sec;
272 runtime->status->audio_tstamp.tv_nsec = audio_tstamp->tv_nsec;
273 runtime->status->tstamp.tv_sec = curr_tstamp->tv_sec;
274 runtime->status->tstamp.tv_nsec = curr_tstamp->tv_nsec;
275 }
276
277
278 /*
279 * re-take a driver timestamp to let apps detect if the reference tstamp
280 * read by low-level hardware was provided with a delay
281 */
282 snd_pcm_gettime(substream->runtime, &driver_tstamp);
283 runtime->driver_tstamp = driver_tstamp;
284}
285
286static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
287 unsigned int in_interrupt)
288{
289 struct snd_pcm_runtime *runtime = substream->runtime;
290 snd_pcm_uframes_t pos;
291 snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
292 snd_pcm_sframes_t hdelta, delta;
293 unsigned long jdelta;
294 unsigned long curr_jiffies;
295 struct timespec64 curr_tstamp;
296 struct timespec64 audio_tstamp;
297 int crossed_boundary = 0;
298
299 old_hw_ptr = runtime->status->hw_ptr;
300
301 /*
302 * group pointer, time and jiffies reads to allow for more
303 * accurate correlations/corrections.
304 * The values are stored at the end of this routine after
305 * corrections for hw_ptr position
306 */
307 pos = substream->ops->pointer(substream);
308 curr_jiffies = jiffies;
309 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
310 if ((substream->ops->get_time_info) &&
311 (runtime->audio_tstamp_config.type_requested != SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
312 substream->ops->get_time_info(substream, &curr_tstamp,
313 &audio_tstamp,
314 &runtime->audio_tstamp_config,
315 &runtime->audio_tstamp_report);
316
317 /* re-test in case tstamp type is not supported in hardware and was demoted to DEFAULT */
318 if (runtime->audio_tstamp_report.actual_type == SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)
319 snd_pcm_gettime(runtime, &curr_tstamp);
320 } else
321 snd_pcm_gettime(runtime, &curr_tstamp);
322 }
323
324 if (pos == SNDRV_PCM_POS_XRUN) {
325 __snd_pcm_xrun(substream);
326 return -EPIPE;
327 }
328 if (pos >= runtime->buffer_size) {
329 if (printk_ratelimit()) {
330 char name[16];
331 snd_pcm_debug_name(substream, name, sizeof(name));
332 pcm_err(substream->pcm,
333 "invalid position: %s, pos = %ld, buffer size = %ld, period size = %ld\n",
334 name, pos, runtime->buffer_size,
335 runtime->period_size);
336 }
337 pos = 0;
338 }
339 pos -= pos % runtime->min_align;
340 trace_hwptr(substream, pos, in_interrupt);
341 hw_base = runtime->hw_ptr_base;
342 new_hw_ptr = hw_base + pos;
343 if (in_interrupt) {
344 /* we know that one period was processed */
345 /* delta = "expected next hw_ptr" for in_interrupt != 0 */
346 delta = runtime->hw_ptr_interrupt + runtime->period_size;
347 if (delta > new_hw_ptr) {
348 /* check for double acknowledged interrupts */
349 hdelta = curr_jiffies - runtime->hw_ptr_jiffies;
350 if (hdelta > runtime->hw_ptr_buffer_jiffies/2 + 1) {
351 hw_base += runtime->buffer_size;
352 if (hw_base >= runtime->boundary) {
353 hw_base = 0;
354 crossed_boundary++;
355 }
356 new_hw_ptr = hw_base + pos;
357 goto __delta;
358 }
359 }
360 }
361 /* new_hw_ptr might be lower than old_hw_ptr in case when */
362 /* pointer crosses the end of the ring buffer */
363 if (new_hw_ptr < old_hw_ptr) {
364 hw_base += runtime->buffer_size;
365 if (hw_base >= runtime->boundary) {
366 hw_base = 0;
367 crossed_boundary++;
368 }
369 new_hw_ptr = hw_base + pos;
370 }
371 __delta:
372 delta = new_hw_ptr - old_hw_ptr;
373 if (delta < 0)
374 delta += runtime->boundary;
375
376 if (runtime->no_period_wakeup) {
377 snd_pcm_sframes_t xrun_threshold;
378 /*
379 * Without regular period interrupts, we have to check
380 * the elapsed time to detect xruns.
381 */
382 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
383 if (jdelta < runtime->hw_ptr_buffer_jiffies / 2)
384 goto no_delta_check;
385 hdelta = jdelta - delta * HZ / runtime->rate;
386 xrun_threshold = runtime->hw_ptr_buffer_jiffies / 2 + 1;
387 while (hdelta > xrun_threshold) {
388 delta += runtime->buffer_size;
389 hw_base += runtime->buffer_size;
390 if (hw_base >= runtime->boundary) {
391 hw_base = 0;
392 crossed_boundary++;
393 }
394 new_hw_ptr = hw_base + pos;
395 hdelta -= runtime->hw_ptr_buffer_jiffies;
396 }
397 goto no_delta_check;
398 }
399
400 /* something must be really wrong */
401 if (delta >= runtime->buffer_size + runtime->period_size) {
402 hw_ptr_error(substream, in_interrupt, "Unexpected hw_ptr",
403 "(stream=%i, pos=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
404 substream->stream, (long)pos,
405 (long)new_hw_ptr, (long)old_hw_ptr);
406 return 0;
407 }
408
409 /* Do jiffies check only in xrun_debug mode */
410 if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
411 goto no_jiffies_check;
412
413 /* Skip the jiffies check for hardwares with BATCH flag.
414 * Such hardware usually just increases the position at each IRQ,
415 * thus it can't give any strange position.
416 */
417 if (runtime->hw.info & SNDRV_PCM_INFO_BATCH)
418 goto no_jiffies_check;
419 hdelta = delta;
420 if (hdelta < runtime->delay)
421 goto no_jiffies_check;
422 hdelta -= runtime->delay;
423 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
424 if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
425 delta = jdelta /
426 (((runtime->period_size * HZ) / runtime->rate)
427 + HZ/100);
428 /* move new_hw_ptr according jiffies not pos variable */
429 new_hw_ptr = old_hw_ptr;
430 hw_base = delta;
431 /* use loop to avoid checks for delta overflows */
432 /* the delta value is small or zero in most cases */
433 while (delta > 0) {
434 new_hw_ptr += runtime->period_size;
435 if (new_hw_ptr >= runtime->boundary) {
436 new_hw_ptr -= runtime->boundary;
437 crossed_boundary--;
438 }
439 delta--;
440 }
441 /* align hw_base to buffer_size */
442 hw_ptr_error(substream, in_interrupt, "hw_ptr skipping",
443 "(pos=%ld, delta=%ld, period=%ld, jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
444 (long)pos, (long)hdelta,
445 (long)runtime->period_size, jdelta,
446 ((hdelta * HZ) / runtime->rate), hw_base,
447 (unsigned long)old_hw_ptr,
448 (unsigned long)new_hw_ptr);
449 /* reset values to proper state */
450 delta = 0;
451 hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
452 }
453 no_jiffies_check:
454 if (delta > runtime->period_size + runtime->period_size / 2) {
455 hw_ptr_error(substream, in_interrupt,
456 "Lost interrupts?",
457 "(stream=%i, delta=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
458 substream->stream, (long)delta,
459 (long)new_hw_ptr,
460 (long)old_hw_ptr);
461 }
462
463 no_delta_check:
464 if (runtime->status->hw_ptr == new_hw_ptr) {
465 runtime->hw_ptr_jiffies = curr_jiffies;
466 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
467 return 0;
468 }
469
470 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
471 runtime->silence_size > 0)
472 snd_pcm_playback_silence(substream, new_hw_ptr);
473
474 if (in_interrupt) {
475 delta = new_hw_ptr - runtime->hw_ptr_interrupt;
476 if (delta < 0)
477 delta += runtime->boundary;
478 delta -= (snd_pcm_uframes_t)delta % runtime->period_size;
479 runtime->hw_ptr_interrupt += delta;
480 if (runtime->hw_ptr_interrupt >= runtime->boundary)
481 runtime->hw_ptr_interrupt -= runtime->boundary;
482 }
483 runtime->hw_ptr_base = hw_base;
484 runtime->status->hw_ptr = new_hw_ptr;
485 runtime->hw_ptr_jiffies = curr_jiffies;
486 if (crossed_boundary) {
487 snd_BUG_ON(crossed_boundary != 1);
488 runtime->hw_ptr_wrap += runtime->boundary;
489 }
490
491 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
492
493 return snd_pcm_update_state(substream, runtime);
494}
495
496/* CAUTION: call it with irq disabled */
497int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
498{
499 return snd_pcm_update_hw_ptr0(substream, 0);
500}
501
502/**
503 * snd_pcm_set_ops - set the PCM operators
504 * @pcm: the pcm instance
505 * @direction: stream direction, SNDRV_PCM_STREAM_XXX
506 * @ops: the operator table
507 *
508 * Sets the given PCM operators to the pcm instance.
509 */
510void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
511 const struct snd_pcm_ops *ops)
512{
513 struct snd_pcm_str *stream = &pcm->streams[direction];
514 struct snd_pcm_substream *substream;
515
516 for (substream = stream->substream; substream != NULL; substream = substream->next)
517 substream->ops = ops;
518}
519EXPORT_SYMBOL(snd_pcm_set_ops);
520
521/**
522 * snd_pcm_set_sync_per_card - set the PCM sync id with card number
523 * @substream: the pcm substream
524 * @params: modified hardware parameters
525 * @id: identifier (max 12 bytes)
526 * @len: identifier length (max 12 bytes)
527 *
528 * Sets the PCM sync identifier for the card with zero padding.
529 *
530 * User space or any user should use this 16-byte identifier for a comparison only
531 * to check if two IDs are similar or different. Special case is the identifier
532 * containing only zeros. Interpretation for this combination is - empty (not set).
533 * The contents of the identifier should not be interpreted in any other way.
534 *
535 * The synchronization ID must be unique per clock source (usually one sound card,
536 * but multiple soundcard may use one PCM word clock source which means that they
537 * are fully synchronized).
538 *
539 * This routine composes this ID using card number in first four bytes and
540 * 12-byte additional ID. When other ID composition is used (e.g. for multiple
541 * sound cards), make sure that the composition does not clash with this
542 * composition scheme.
543 */
544void snd_pcm_set_sync_per_card(struct snd_pcm_substream *substream,
545 struct snd_pcm_hw_params *params,
546 const unsigned char *id, unsigned int len)
547{
548 *(__u32 *)params->sync = cpu_to_le32(substream->pcm->card->number);
549 len = min(12, len);
550 memcpy(params->sync + 4, id, len);
551 memset(params->sync + 4 + len, 0, 12 - len);
552}
553EXPORT_SYMBOL_GPL(snd_pcm_set_sync_per_card);
554
555/*
556 * Standard ioctl routine
557 */
558
559static inline unsigned int div32(unsigned int a, unsigned int b,
560 unsigned int *r)
561{
562 if (b == 0) {
563 *r = 0;
564 return UINT_MAX;
565 }
566 *r = a % b;
567 return a / b;
568}
569
570static inline unsigned int div_down(unsigned int a, unsigned int b)
571{
572 if (b == 0)
573 return UINT_MAX;
574 return a / b;
575}
576
577static inline unsigned int div_up(unsigned int a, unsigned int b)
578{
579 unsigned int r;
580 unsigned int q;
581 if (b == 0)
582 return UINT_MAX;
583 q = div32(a, b, &r);
584 if (r)
585 ++q;
586 return q;
587}
588
589static inline unsigned int mul(unsigned int a, unsigned int b)
590{
591 if (a == 0)
592 return 0;
593 if (div_down(UINT_MAX, a) < b)
594 return UINT_MAX;
595 return a * b;
596}
597
598static inline unsigned int muldiv32(unsigned int a, unsigned int b,
599 unsigned int c, unsigned int *r)
600{
601 u_int64_t n = (u_int64_t) a * b;
602 if (c == 0) {
603 *r = 0;
604 return UINT_MAX;
605 }
606 n = div_u64_rem(n, c, r);
607 if (n >= UINT_MAX) {
608 *r = 0;
609 return UINT_MAX;
610 }
611 return n;
612}
613
614/**
615 * snd_interval_refine - refine the interval value of configurator
616 * @i: the interval value to refine
617 * @v: the interval value to refer to
618 *
619 * Refines the interval value with the reference value.
620 * The interval is changed to the range satisfying both intervals.
621 * The interval status (min, max, integer, etc.) are evaluated.
622 *
623 * Return: Positive if the value is changed, zero if it's not changed, or a
624 * negative error code.
625 */
626int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
627{
628 int changed = 0;
629 if (snd_BUG_ON(snd_interval_empty(i)))
630 return -EINVAL;
631 if (i->min < v->min) {
632 i->min = v->min;
633 i->openmin = v->openmin;
634 changed = 1;
635 } else if (i->min == v->min && !i->openmin && v->openmin) {
636 i->openmin = 1;
637 changed = 1;
638 }
639 if (i->max > v->max) {
640 i->max = v->max;
641 i->openmax = v->openmax;
642 changed = 1;
643 } else if (i->max == v->max && !i->openmax && v->openmax) {
644 i->openmax = 1;
645 changed = 1;
646 }
647 if (!i->integer && v->integer) {
648 i->integer = 1;
649 changed = 1;
650 }
651 if (i->integer) {
652 if (i->openmin) {
653 i->min++;
654 i->openmin = 0;
655 }
656 if (i->openmax) {
657 i->max--;
658 i->openmax = 0;
659 }
660 } else if (!i->openmin && !i->openmax && i->min == i->max)
661 i->integer = 1;
662 if (snd_interval_checkempty(i)) {
663 snd_interval_none(i);
664 return -EINVAL;
665 }
666 return changed;
667}
668EXPORT_SYMBOL(snd_interval_refine);
669
670static int snd_interval_refine_first(struct snd_interval *i)
671{
672 const unsigned int last_max = i->max;
673
674 if (snd_BUG_ON(snd_interval_empty(i)))
675 return -EINVAL;
676 if (snd_interval_single(i))
677 return 0;
678 i->max = i->min;
679 if (i->openmin)
680 i->max++;
681 /* only exclude max value if also excluded before refine */
682 i->openmax = (i->openmax && i->max >= last_max);
683 return 1;
684}
685
686static int snd_interval_refine_last(struct snd_interval *i)
687{
688 const unsigned int last_min = i->min;
689
690 if (snd_BUG_ON(snd_interval_empty(i)))
691 return -EINVAL;
692 if (snd_interval_single(i))
693 return 0;
694 i->min = i->max;
695 if (i->openmax)
696 i->min--;
697 /* only exclude min value if also excluded before refine */
698 i->openmin = (i->openmin && i->min <= last_min);
699 return 1;
700}
701
702void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
703{
704 if (a->empty || b->empty) {
705 snd_interval_none(c);
706 return;
707 }
708 c->empty = 0;
709 c->min = mul(a->min, b->min);
710 c->openmin = (a->openmin || b->openmin);
711 c->max = mul(a->max, b->max);
712 c->openmax = (a->openmax || b->openmax);
713 c->integer = (a->integer && b->integer);
714}
715
716/**
717 * snd_interval_div - refine the interval value with division
718 * @a: dividend
719 * @b: divisor
720 * @c: quotient
721 *
722 * c = a / b
723 *
724 * Returns non-zero if the value is changed, zero if not changed.
725 */
726void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
727{
728 unsigned int r;
729 if (a->empty || b->empty) {
730 snd_interval_none(c);
731 return;
732 }
733 c->empty = 0;
734 c->min = div32(a->min, b->max, &r);
735 c->openmin = (r || a->openmin || b->openmax);
736 if (b->min > 0) {
737 c->max = div32(a->max, b->min, &r);
738 if (r) {
739 c->max++;
740 c->openmax = 1;
741 } else
742 c->openmax = (a->openmax || b->openmin);
743 } else {
744 c->max = UINT_MAX;
745 c->openmax = 0;
746 }
747 c->integer = 0;
748}
749
750/**
751 * snd_interval_muldivk - refine the interval value
752 * @a: dividend 1
753 * @b: dividend 2
754 * @k: divisor (as integer)
755 * @c: result
756 *
757 * c = a * b / k
758 *
759 * Returns non-zero if the value is changed, zero if not changed.
760 */
761void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
762 unsigned int k, struct snd_interval *c)
763{
764 unsigned int r;
765 if (a->empty || b->empty) {
766 snd_interval_none(c);
767 return;
768 }
769 c->empty = 0;
770 c->min = muldiv32(a->min, b->min, k, &r);
771 c->openmin = (r || a->openmin || b->openmin);
772 c->max = muldiv32(a->max, b->max, k, &r);
773 if (r) {
774 c->max++;
775 c->openmax = 1;
776 } else
777 c->openmax = (a->openmax || b->openmax);
778 c->integer = 0;
779}
780
781/**
782 * snd_interval_mulkdiv - refine the interval value
783 * @a: dividend 1
784 * @k: dividend 2 (as integer)
785 * @b: divisor
786 * @c: result
787 *
788 * c = a * k / b
789 *
790 * Returns non-zero if the value is changed, zero if not changed.
791 */
792void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
793 const struct snd_interval *b, struct snd_interval *c)
794{
795 unsigned int r;
796 if (a->empty || b->empty) {
797 snd_interval_none(c);
798 return;
799 }
800 c->empty = 0;
801 c->min = muldiv32(a->min, k, b->max, &r);
802 c->openmin = (r || a->openmin || b->openmax);
803 if (b->min > 0) {
804 c->max = muldiv32(a->max, k, b->min, &r);
805 if (r) {
806 c->max++;
807 c->openmax = 1;
808 } else
809 c->openmax = (a->openmax || b->openmin);
810 } else {
811 c->max = UINT_MAX;
812 c->openmax = 0;
813 }
814 c->integer = 0;
815}
816
817/* ---- */
818
819
820/**
821 * snd_interval_ratnum - refine the interval value
822 * @i: interval to refine
823 * @rats_count: number of ratnum_t
824 * @rats: ratnum_t array
825 * @nump: pointer to store the resultant numerator
826 * @denp: pointer to store the resultant denominator
827 *
828 * Return: Positive if the value is changed, zero if it's not changed, or a
829 * negative error code.
830 */
831int snd_interval_ratnum(struct snd_interval *i,
832 unsigned int rats_count, const struct snd_ratnum *rats,
833 unsigned int *nump, unsigned int *denp)
834{
835 unsigned int best_num, best_den;
836 int best_diff;
837 unsigned int k;
838 struct snd_interval t;
839 int err;
840 unsigned int result_num, result_den;
841 int result_diff;
842
843 best_num = best_den = best_diff = 0;
844 for (k = 0; k < rats_count; ++k) {
845 unsigned int num = rats[k].num;
846 unsigned int den;
847 unsigned int q = i->min;
848 int diff;
849 if (q == 0)
850 q = 1;
851 den = div_up(num, q);
852 if (den < rats[k].den_min)
853 continue;
854 if (den > rats[k].den_max)
855 den = rats[k].den_max;
856 else {
857 unsigned int r;
858 r = (den - rats[k].den_min) % rats[k].den_step;
859 if (r != 0)
860 den -= r;
861 }
862 diff = num - q * den;
863 if (diff < 0)
864 diff = -diff;
865 if (best_num == 0 ||
866 diff * best_den < best_diff * den) {
867 best_diff = diff;
868 best_den = den;
869 best_num = num;
870 }
871 }
872 if (best_den == 0) {
873 i->empty = 1;
874 return -EINVAL;
875 }
876 t.min = div_down(best_num, best_den);
877 t.openmin = !!(best_num % best_den);
878
879 result_num = best_num;
880 result_diff = best_diff;
881 result_den = best_den;
882 best_num = best_den = best_diff = 0;
883 for (k = 0; k < rats_count; ++k) {
884 unsigned int num = rats[k].num;
885 unsigned int den;
886 unsigned int q = i->max;
887 int diff;
888 if (q == 0) {
889 i->empty = 1;
890 return -EINVAL;
891 }
892 den = div_down(num, q);
893 if (den > rats[k].den_max)
894 continue;
895 if (den < rats[k].den_min)
896 den = rats[k].den_min;
897 else {
898 unsigned int r;
899 r = (den - rats[k].den_min) % rats[k].den_step;
900 if (r != 0)
901 den += rats[k].den_step - r;
902 }
903 diff = q * den - num;
904 if (diff < 0)
905 diff = -diff;
906 if (best_num == 0 ||
907 diff * best_den < best_diff * den) {
908 best_diff = diff;
909 best_den = den;
910 best_num = num;
911 }
912 }
913 if (best_den == 0) {
914 i->empty = 1;
915 return -EINVAL;
916 }
917 t.max = div_up(best_num, best_den);
918 t.openmax = !!(best_num % best_den);
919 t.integer = 0;
920 err = snd_interval_refine(i, &t);
921 if (err < 0)
922 return err;
923
924 if (snd_interval_single(i)) {
925 if (best_diff * result_den < result_diff * best_den) {
926 result_num = best_num;
927 result_den = best_den;
928 }
929 if (nump)
930 *nump = result_num;
931 if (denp)
932 *denp = result_den;
933 }
934 return err;
935}
936EXPORT_SYMBOL(snd_interval_ratnum);
937
938/**
939 * snd_interval_ratden - refine the interval value
940 * @i: interval to refine
941 * @rats_count: number of struct ratden
942 * @rats: struct ratden array
943 * @nump: pointer to store the resultant numerator
944 * @denp: pointer to store the resultant denominator
945 *
946 * Return: Positive if the value is changed, zero if it's not changed, or a
947 * negative error code.
948 */
949static int snd_interval_ratden(struct snd_interval *i,
950 unsigned int rats_count,
951 const struct snd_ratden *rats,
952 unsigned int *nump, unsigned int *denp)
953{
954 unsigned int best_num, best_diff, best_den;
955 unsigned int k;
956 struct snd_interval t;
957 int err;
958
959 best_num = best_den = best_diff = 0;
960 for (k = 0; k < rats_count; ++k) {
961 unsigned int num;
962 unsigned int den = rats[k].den;
963 unsigned int q = i->min;
964 int diff;
965 num = mul(q, den);
966 if (num > rats[k].num_max)
967 continue;
968 if (num < rats[k].num_min)
969 num = rats[k].num_max;
970 else {
971 unsigned int r;
972 r = (num - rats[k].num_min) % rats[k].num_step;
973 if (r != 0)
974 num += rats[k].num_step - r;
975 }
976 diff = num - q * den;
977 if (best_num == 0 ||
978 diff * best_den < best_diff * den) {
979 best_diff = diff;
980 best_den = den;
981 best_num = num;
982 }
983 }
984 if (best_den == 0) {
985 i->empty = 1;
986 return -EINVAL;
987 }
988 t.min = div_down(best_num, best_den);
989 t.openmin = !!(best_num % best_den);
990
991 best_num = best_den = best_diff = 0;
992 for (k = 0; k < rats_count; ++k) {
993 unsigned int num;
994 unsigned int den = rats[k].den;
995 unsigned int q = i->max;
996 int diff;
997 num = mul(q, den);
998 if (num < rats[k].num_min)
999 continue;
1000 if (num > rats[k].num_max)
1001 num = rats[k].num_max;
1002 else {
1003 unsigned int r;
1004 r = (num - rats[k].num_min) % rats[k].num_step;
1005 if (r != 0)
1006 num -= r;
1007 }
1008 diff = q * den - num;
1009 if (best_num == 0 ||
1010 diff * best_den < best_diff * den) {
1011 best_diff = diff;
1012 best_den = den;
1013 best_num = num;
1014 }
1015 }
1016 if (best_den == 0) {
1017 i->empty = 1;
1018 return -EINVAL;
1019 }
1020 t.max = div_up(best_num, best_den);
1021 t.openmax = !!(best_num % best_den);
1022 t.integer = 0;
1023 err = snd_interval_refine(i, &t);
1024 if (err < 0)
1025 return err;
1026
1027 if (snd_interval_single(i)) {
1028 if (nump)
1029 *nump = best_num;
1030 if (denp)
1031 *denp = best_den;
1032 }
1033 return err;
1034}
1035
1036/**
1037 * snd_interval_list - refine the interval value from the list
1038 * @i: the interval value to refine
1039 * @count: the number of elements in the list
1040 * @list: the value list
1041 * @mask: the bit-mask to evaluate
1042 *
1043 * Refines the interval value from the list.
1044 * When mask is non-zero, only the elements corresponding to bit 1 are
1045 * evaluated.
1046 *
1047 * Return: Positive if the value is changed, zero if it's not changed, or a
1048 * negative error code.
1049 */
1050int snd_interval_list(struct snd_interval *i, unsigned int count,
1051 const unsigned int *list, unsigned int mask)
1052{
1053 unsigned int k;
1054 struct snd_interval list_range;
1055
1056 if (!count) {
1057 i->empty = 1;
1058 return -EINVAL;
1059 }
1060 snd_interval_any(&list_range);
1061 list_range.min = UINT_MAX;
1062 list_range.max = 0;
1063 for (k = 0; k < count; k++) {
1064 if (mask && !(mask & (1 << k)))
1065 continue;
1066 if (!snd_interval_test(i, list[k]))
1067 continue;
1068 list_range.min = min(list_range.min, list[k]);
1069 list_range.max = max(list_range.max, list[k]);
1070 }
1071 return snd_interval_refine(i, &list_range);
1072}
1073EXPORT_SYMBOL(snd_interval_list);
1074
1075/**
1076 * snd_interval_ranges - refine the interval value from the list of ranges
1077 * @i: the interval value to refine
1078 * @count: the number of elements in the list of ranges
1079 * @ranges: the ranges list
1080 * @mask: the bit-mask to evaluate
1081 *
1082 * Refines the interval value from the list of ranges.
1083 * When mask is non-zero, only the elements corresponding to bit 1 are
1084 * evaluated.
1085 *
1086 * Return: Positive if the value is changed, zero if it's not changed, or a
1087 * negative error code.
1088 */
1089int snd_interval_ranges(struct snd_interval *i, unsigned int count,
1090 const struct snd_interval *ranges, unsigned int mask)
1091{
1092 unsigned int k;
1093 struct snd_interval range_union;
1094 struct snd_interval range;
1095
1096 if (!count) {
1097 snd_interval_none(i);
1098 return -EINVAL;
1099 }
1100 snd_interval_any(&range_union);
1101 range_union.min = UINT_MAX;
1102 range_union.max = 0;
1103 for (k = 0; k < count; k++) {
1104 if (mask && !(mask & (1 << k)))
1105 continue;
1106 snd_interval_copy(&range, &ranges[k]);
1107 if (snd_interval_refine(&range, i) < 0)
1108 continue;
1109 if (snd_interval_empty(&range))
1110 continue;
1111
1112 if (range.min < range_union.min) {
1113 range_union.min = range.min;
1114 range_union.openmin = 1;
1115 }
1116 if (range.min == range_union.min && !range.openmin)
1117 range_union.openmin = 0;
1118 if (range.max > range_union.max) {
1119 range_union.max = range.max;
1120 range_union.openmax = 1;
1121 }
1122 if (range.max == range_union.max && !range.openmax)
1123 range_union.openmax = 0;
1124 }
1125 return snd_interval_refine(i, &range_union);
1126}
1127EXPORT_SYMBOL(snd_interval_ranges);
1128
1129static int snd_interval_step(struct snd_interval *i, unsigned int step)
1130{
1131 unsigned int n;
1132 int changed = 0;
1133 n = i->min % step;
1134 if (n != 0 || i->openmin) {
1135 i->min += step - n;
1136 i->openmin = 0;
1137 changed = 1;
1138 }
1139 n = i->max % step;
1140 if (n != 0 || i->openmax) {
1141 i->max -= n;
1142 i->openmax = 0;
1143 changed = 1;
1144 }
1145 if (snd_interval_checkempty(i)) {
1146 i->empty = 1;
1147 return -EINVAL;
1148 }
1149 return changed;
1150}
1151
1152/* Info constraints helpers */
1153
1154/**
1155 * snd_pcm_hw_rule_add - add the hw-constraint rule
1156 * @runtime: the pcm runtime instance
1157 * @cond: condition bits
1158 * @var: the variable to evaluate
1159 * @func: the evaluation function
1160 * @private: the private data pointer passed to function
1161 * @dep: the dependent variables
1162 *
1163 * Return: Zero if successful, or a negative error code on failure.
1164 */
1165int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, unsigned int cond,
1166 int var,
1167 snd_pcm_hw_rule_func_t func, void *private,
1168 int dep, ...)
1169{
1170 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1171 struct snd_pcm_hw_rule *c;
1172 unsigned int k;
1173 va_list args;
1174 va_start(args, dep);
1175 if (constrs->rules_num >= constrs->rules_all) {
1176 struct snd_pcm_hw_rule *new;
1177 unsigned int new_rules = constrs->rules_all + 16;
1178 new = krealloc_array(constrs->rules, new_rules,
1179 sizeof(*c), GFP_KERNEL);
1180 if (!new) {
1181 va_end(args);
1182 return -ENOMEM;
1183 }
1184 constrs->rules = new;
1185 constrs->rules_all = new_rules;
1186 }
1187 c = &constrs->rules[constrs->rules_num];
1188 c->cond = cond;
1189 c->func = func;
1190 c->var = var;
1191 c->private = private;
1192 k = 0;
1193 while (1) {
1194 if (snd_BUG_ON(k >= ARRAY_SIZE(c->deps))) {
1195 va_end(args);
1196 return -EINVAL;
1197 }
1198 c->deps[k++] = dep;
1199 if (dep < 0)
1200 break;
1201 dep = va_arg(args, int);
1202 }
1203 constrs->rules_num++;
1204 va_end(args);
1205 return 0;
1206}
1207EXPORT_SYMBOL(snd_pcm_hw_rule_add);
1208
1209/**
1210 * snd_pcm_hw_constraint_mask - apply the given bitmap mask constraint
1211 * @runtime: PCM runtime instance
1212 * @var: hw_params variable to apply the mask
1213 * @mask: the bitmap mask
1214 *
1215 * Apply the constraint of the given bitmap mask to a 32-bit mask parameter.
1216 *
1217 * Return: Zero if successful, or a negative error code on failure.
1218 */
1219int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1220 u_int32_t mask)
1221{
1222 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1223 struct snd_mask *maskp = constrs_mask(constrs, var);
1224 *maskp->bits &= mask;
1225 memset(maskp->bits + 1, 0, (SNDRV_MASK_MAX-32) / 8); /* clear rest */
1226 if (*maskp->bits == 0)
1227 return -EINVAL;
1228 return 0;
1229}
1230
1231/**
1232 * snd_pcm_hw_constraint_mask64 - apply the given bitmap mask constraint
1233 * @runtime: PCM runtime instance
1234 * @var: hw_params variable to apply the mask
1235 * @mask: the 64bit bitmap mask
1236 *
1237 * Apply the constraint of the given bitmap mask to a 64-bit mask parameter.
1238 *
1239 * Return: Zero if successful, or a negative error code on failure.
1240 */
1241int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1242 u_int64_t mask)
1243{
1244 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1245 struct snd_mask *maskp = constrs_mask(constrs, var);
1246 maskp->bits[0] &= (u_int32_t)mask;
1247 maskp->bits[1] &= (u_int32_t)(mask >> 32);
1248 memset(maskp->bits + 2, 0, (SNDRV_MASK_MAX-64) / 8); /* clear rest */
1249 if (! maskp->bits[0] && ! maskp->bits[1])
1250 return -EINVAL;
1251 return 0;
1252}
1253EXPORT_SYMBOL(snd_pcm_hw_constraint_mask64);
1254
1255/**
1256 * snd_pcm_hw_constraint_integer - apply an integer constraint to an interval
1257 * @runtime: PCM runtime instance
1258 * @var: hw_params variable to apply the integer constraint
1259 *
1260 * Apply the constraint of integer to an interval parameter.
1261 *
1262 * Return: Positive if the value is changed, zero if it's not changed, or a
1263 * negative error code.
1264 */
1265int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var)
1266{
1267 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1268 return snd_interval_setinteger(constrs_interval(constrs, var));
1269}
1270EXPORT_SYMBOL(snd_pcm_hw_constraint_integer);
1271
1272/**
1273 * snd_pcm_hw_constraint_minmax - apply a min/max range constraint to an interval
1274 * @runtime: PCM runtime instance
1275 * @var: hw_params variable to apply the range
1276 * @min: the minimal value
1277 * @max: the maximal value
1278 *
1279 * Apply the min/max range constraint to an interval parameter.
1280 *
1281 * Return: Positive if the value is changed, zero if it's not changed, or a
1282 * negative error code.
1283 */
1284int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1285 unsigned int min, unsigned int max)
1286{
1287 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1288 struct snd_interval t;
1289 t.min = min;
1290 t.max = max;
1291 t.openmin = t.openmax = 0;
1292 t.integer = 0;
1293 return snd_interval_refine(constrs_interval(constrs, var), &t);
1294}
1295EXPORT_SYMBOL(snd_pcm_hw_constraint_minmax);
1296
1297static int snd_pcm_hw_rule_list(struct snd_pcm_hw_params *params,
1298 struct snd_pcm_hw_rule *rule)
1299{
1300 struct snd_pcm_hw_constraint_list *list = rule->private;
1301 return snd_interval_list(hw_param_interval(params, rule->var), list->count, list->list, list->mask);
1302}
1303
1304
1305/**
1306 * snd_pcm_hw_constraint_list - apply a list of constraints to a parameter
1307 * @runtime: PCM runtime instance
1308 * @cond: condition bits
1309 * @var: hw_params variable to apply the list constraint
1310 * @l: list
1311 *
1312 * Apply the list of constraints to an interval parameter.
1313 *
1314 * Return: Zero if successful, or a negative error code on failure.
1315 */
1316int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1317 unsigned int cond,
1318 snd_pcm_hw_param_t var,
1319 const struct snd_pcm_hw_constraint_list *l)
1320{
1321 return snd_pcm_hw_rule_add(runtime, cond, var,
1322 snd_pcm_hw_rule_list, (void *)l,
1323 var, -1);
1324}
1325EXPORT_SYMBOL(snd_pcm_hw_constraint_list);
1326
1327static int snd_pcm_hw_rule_ranges(struct snd_pcm_hw_params *params,
1328 struct snd_pcm_hw_rule *rule)
1329{
1330 struct snd_pcm_hw_constraint_ranges *r = rule->private;
1331 return snd_interval_ranges(hw_param_interval(params, rule->var),
1332 r->count, r->ranges, r->mask);
1333}
1334
1335
1336/**
1337 * snd_pcm_hw_constraint_ranges - apply list of range constraints to a parameter
1338 * @runtime: PCM runtime instance
1339 * @cond: condition bits
1340 * @var: hw_params variable to apply the list of range constraints
1341 * @r: ranges
1342 *
1343 * Apply the list of range constraints to an interval parameter.
1344 *
1345 * Return: Zero if successful, or a negative error code on failure.
1346 */
1347int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1348 unsigned int cond,
1349 snd_pcm_hw_param_t var,
1350 const struct snd_pcm_hw_constraint_ranges *r)
1351{
1352 return snd_pcm_hw_rule_add(runtime, cond, var,
1353 snd_pcm_hw_rule_ranges, (void *)r,
1354 var, -1);
1355}
1356EXPORT_SYMBOL(snd_pcm_hw_constraint_ranges);
1357
1358static int snd_pcm_hw_rule_ratnums(struct snd_pcm_hw_params *params,
1359 struct snd_pcm_hw_rule *rule)
1360{
1361 const struct snd_pcm_hw_constraint_ratnums *r = rule->private;
1362 unsigned int num = 0, den = 0;
1363 int err;
1364 err = snd_interval_ratnum(hw_param_interval(params, rule->var),
1365 r->nrats, r->rats, &num, &den);
1366 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1367 params->rate_num = num;
1368 params->rate_den = den;
1369 }
1370 return err;
1371}
1372
1373/**
1374 * snd_pcm_hw_constraint_ratnums - apply ratnums constraint to a parameter
1375 * @runtime: PCM runtime instance
1376 * @cond: condition bits
1377 * @var: hw_params variable to apply the ratnums constraint
1378 * @r: struct snd_ratnums constriants
1379 *
1380 * Return: Zero if successful, or a negative error code on failure.
1381 */
1382int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1383 unsigned int cond,
1384 snd_pcm_hw_param_t var,
1385 const struct snd_pcm_hw_constraint_ratnums *r)
1386{
1387 return snd_pcm_hw_rule_add(runtime, cond, var,
1388 snd_pcm_hw_rule_ratnums, (void *)r,
1389 var, -1);
1390}
1391EXPORT_SYMBOL(snd_pcm_hw_constraint_ratnums);
1392
1393static int snd_pcm_hw_rule_ratdens(struct snd_pcm_hw_params *params,
1394 struct snd_pcm_hw_rule *rule)
1395{
1396 const struct snd_pcm_hw_constraint_ratdens *r = rule->private;
1397 unsigned int num = 0, den = 0;
1398 int err = snd_interval_ratden(hw_param_interval(params, rule->var),
1399 r->nrats, r->rats, &num, &den);
1400 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1401 params->rate_num = num;
1402 params->rate_den = den;
1403 }
1404 return err;
1405}
1406
1407/**
1408 * snd_pcm_hw_constraint_ratdens - apply ratdens constraint to a parameter
1409 * @runtime: PCM runtime instance
1410 * @cond: condition bits
1411 * @var: hw_params variable to apply the ratdens constraint
1412 * @r: struct snd_ratdens constriants
1413 *
1414 * Return: Zero if successful, or a negative error code on failure.
1415 */
1416int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1417 unsigned int cond,
1418 snd_pcm_hw_param_t var,
1419 const struct snd_pcm_hw_constraint_ratdens *r)
1420{
1421 return snd_pcm_hw_rule_add(runtime, cond, var,
1422 snd_pcm_hw_rule_ratdens, (void *)r,
1423 var, -1);
1424}
1425EXPORT_SYMBOL(snd_pcm_hw_constraint_ratdens);
1426
1427static int snd_pcm_hw_rule_msbits(struct snd_pcm_hw_params *params,
1428 struct snd_pcm_hw_rule *rule)
1429{
1430 unsigned int l = (unsigned long) rule->private;
1431 int width = l & 0xffff;
1432 unsigned int msbits = l >> 16;
1433 const struct snd_interval *i =
1434 hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
1435
1436 if (!snd_interval_single(i))
1437 return 0;
1438
1439 if ((snd_interval_value(i) == width) ||
1440 (width == 0 && snd_interval_value(i) > msbits))
1441 params->msbits = min_not_zero(params->msbits, msbits);
1442
1443 return 0;
1444}
1445
1446/**
1447 * snd_pcm_hw_constraint_msbits - add a hw constraint msbits rule
1448 * @runtime: PCM runtime instance
1449 * @cond: condition bits
1450 * @width: sample bits width
1451 * @msbits: msbits width
1452 *
1453 * This constraint will set the number of most significant bits (msbits) if a
1454 * sample format with the specified width has been select. If width is set to 0
1455 * the msbits will be set for any sample format with a width larger than the
1456 * specified msbits.
1457 *
1458 * Return: Zero if successful, or a negative error code on failure.
1459 */
1460int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1461 unsigned int cond,
1462 unsigned int width,
1463 unsigned int msbits)
1464{
1465 unsigned long l = (msbits << 16) | width;
1466 return snd_pcm_hw_rule_add(runtime, cond, -1,
1467 snd_pcm_hw_rule_msbits,
1468 (void*) l,
1469 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
1470}
1471EXPORT_SYMBOL(snd_pcm_hw_constraint_msbits);
1472
1473static int snd_pcm_hw_rule_step(struct snd_pcm_hw_params *params,
1474 struct snd_pcm_hw_rule *rule)
1475{
1476 unsigned long step = (unsigned long) rule->private;
1477 return snd_interval_step(hw_param_interval(params, rule->var), step);
1478}
1479
1480/**
1481 * snd_pcm_hw_constraint_step - add a hw constraint step rule
1482 * @runtime: PCM runtime instance
1483 * @cond: condition bits
1484 * @var: hw_params variable to apply the step constraint
1485 * @step: step size
1486 *
1487 * Return: Zero if successful, or a negative error code on failure.
1488 */
1489int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1490 unsigned int cond,
1491 snd_pcm_hw_param_t var,
1492 unsigned long step)
1493{
1494 return snd_pcm_hw_rule_add(runtime, cond, var,
1495 snd_pcm_hw_rule_step, (void *) step,
1496 var, -1);
1497}
1498EXPORT_SYMBOL(snd_pcm_hw_constraint_step);
1499
1500static int snd_pcm_hw_rule_pow2(struct snd_pcm_hw_params *params, struct snd_pcm_hw_rule *rule)
1501{
1502 static const unsigned int pow2_sizes[] = {
1503 1<<0, 1<<1, 1<<2, 1<<3, 1<<4, 1<<5, 1<<6, 1<<7,
1504 1<<8, 1<<9, 1<<10, 1<<11, 1<<12, 1<<13, 1<<14, 1<<15,
1505 1<<16, 1<<17, 1<<18, 1<<19, 1<<20, 1<<21, 1<<22, 1<<23,
1506 1<<24, 1<<25, 1<<26, 1<<27, 1<<28, 1<<29, 1<<30
1507 };
1508 return snd_interval_list(hw_param_interval(params, rule->var),
1509 ARRAY_SIZE(pow2_sizes), pow2_sizes, 0);
1510}
1511
1512/**
1513 * snd_pcm_hw_constraint_pow2 - add a hw constraint power-of-2 rule
1514 * @runtime: PCM runtime instance
1515 * @cond: condition bits
1516 * @var: hw_params variable to apply the power-of-2 constraint
1517 *
1518 * Return: Zero if successful, or a negative error code on failure.
1519 */
1520int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1521 unsigned int cond,
1522 snd_pcm_hw_param_t var)
1523{
1524 return snd_pcm_hw_rule_add(runtime, cond, var,
1525 snd_pcm_hw_rule_pow2, NULL,
1526 var, -1);
1527}
1528EXPORT_SYMBOL(snd_pcm_hw_constraint_pow2);
1529
1530static int snd_pcm_hw_rule_noresample_func(struct snd_pcm_hw_params *params,
1531 struct snd_pcm_hw_rule *rule)
1532{
1533 unsigned int base_rate = (unsigned int)(uintptr_t)rule->private;
1534 struct snd_interval *rate;
1535
1536 rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1537 return snd_interval_list(rate, 1, &base_rate, 0);
1538}
1539
1540/**
1541 * snd_pcm_hw_rule_noresample - add a rule to allow disabling hw resampling
1542 * @runtime: PCM runtime instance
1543 * @base_rate: the rate at which the hardware does not resample
1544 *
1545 * Return: Zero if successful, or a negative error code on failure.
1546 */
1547int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1548 unsigned int base_rate)
1549{
1550 return snd_pcm_hw_rule_add(runtime, SNDRV_PCM_HW_PARAMS_NORESAMPLE,
1551 SNDRV_PCM_HW_PARAM_RATE,
1552 snd_pcm_hw_rule_noresample_func,
1553 (void *)(uintptr_t)base_rate,
1554 SNDRV_PCM_HW_PARAM_RATE, -1);
1555}
1556EXPORT_SYMBOL(snd_pcm_hw_rule_noresample);
1557
1558static void _snd_pcm_hw_param_any(struct snd_pcm_hw_params *params,
1559 snd_pcm_hw_param_t var)
1560{
1561 if (hw_is_mask(var)) {
1562 snd_mask_any(hw_param_mask(params, var));
1563 params->cmask |= 1 << var;
1564 params->rmask |= 1 << var;
1565 return;
1566 }
1567 if (hw_is_interval(var)) {
1568 snd_interval_any(hw_param_interval(params, var));
1569 params->cmask |= 1 << var;
1570 params->rmask |= 1 << var;
1571 return;
1572 }
1573 snd_BUG();
1574}
1575
1576void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params)
1577{
1578 unsigned int k;
1579 memset(params, 0, sizeof(*params));
1580 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++)
1581 _snd_pcm_hw_param_any(params, k);
1582 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
1583 _snd_pcm_hw_param_any(params, k);
1584 params->info = ~0U;
1585}
1586EXPORT_SYMBOL(_snd_pcm_hw_params_any);
1587
1588/**
1589 * snd_pcm_hw_param_value - return @params field @var value
1590 * @params: the hw_params instance
1591 * @var: parameter to retrieve
1592 * @dir: pointer to the direction (-1,0,1) or %NULL
1593 *
1594 * Return: The value for field @var if it's fixed in configuration space
1595 * defined by @params. -%EINVAL otherwise.
1596 */
1597int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
1598 snd_pcm_hw_param_t var, int *dir)
1599{
1600 if (hw_is_mask(var)) {
1601 const struct snd_mask *mask = hw_param_mask_c(params, var);
1602 if (!snd_mask_single(mask))
1603 return -EINVAL;
1604 if (dir)
1605 *dir = 0;
1606 return snd_mask_value(mask);
1607 }
1608 if (hw_is_interval(var)) {
1609 const struct snd_interval *i = hw_param_interval_c(params, var);
1610 if (!snd_interval_single(i))
1611 return -EINVAL;
1612 if (dir)
1613 *dir = i->openmin;
1614 return snd_interval_value(i);
1615 }
1616 return -EINVAL;
1617}
1618EXPORT_SYMBOL(snd_pcm_hw_param_value);
1619
1620void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params,
1621 snd_pcm_hw_param_t var)
1622{
1623 if (hw_is_mask(var)) {
1624 snd_mask_none(hw_param_mask(params, var));
1625 params->cmask |= 1 << var;
1626 params->rmask |= 1 << var;
1627 } else if (hw_is_interval(var)) {
1628 snd_interval_none(hw_param_interval(params, var));
1629 params->cmask |= 1 << var;
1630 params->rmask |= 1 << var;
1631 } else {
1632 snd_BUG();
1633 }
1634}
1635EXPORT_SYMBOL(_snd_pcm_hw_param_setempty);
1636
1637static int _snd_pcm_hw_param_first(struct snd_pcm_hw_params *params,
1638 snd_pcm_hw_param_t var)
1639{
1640 int changed;
1641 if (hw_is_mask(var))
1642 changed = snd_mask_refine_first(hw_param_mask(params, var));
1643 else if (hw_is_interval(var))
1644 changed = snd_interval_refine_first(hw_param_interval(params, var));
1645 else
1646 return -EINVAL;
1647 if (changed > 0) {
1648 params->cmask |= 1 << var;
1649 params->rmask |= 1 << var;
1650 }
1651 return changed;
1652}
1653
1654
1655/**
1656 * snd_pcm_hw_param_first - refine config space and return minimum value
1657 * @pcm: PCM instance
1658 * @params: the hw_params instance
1659 * @var: parameter to retrieve
1660 * @dir: pointer to the direction (-1,0,1) or %NULL
1661 *
1662 * Inside configuration space defined by @params remove from @var all
1663 * values > minimum. Reduce configuration space accordingly.
1664 *
1665 * Return: The minimum, or a negative error code on failure.
1666 */
1667int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
1668 struct snd_pcm_hw_params *params,
1669 snd_pcm_hw_param_t var, int *dir)
1670{
1671 int changed = _snd_pcm_hw_param_first(params, var);
1672 if (changed < 0)
1673 return changed;
1674 if (params->rmask) {
1675 int err = snd_pcm_hw_refine(pcm, params);
1676 if (err < 0)
1677 return err;
1678 }
1679 return snd_pcm_hw_param_value(params, var, dir);
1680}
1681EXPORT_SYMBOL(snd_pcm_hw_param_first);
1682
1683static int _snd_pcm_hw_param_last(struct snd_pcm_hw_params *params,
1684 snd_pcm_hw_param_t var)
1685{
1686 int changed;
1687 if (hw_is_mask(var))
1688 changed = snd_mask_refine_last(hw_param_mask(params, var));
1689 else if (hw_is_interval(var))
1690 changed = snd_interval_refine_last(hw_param_interval(params, var));
1691 else
1692 return -EINVAL;
1693 if (changed > 0) {
1694 params->cmask |= 1 << var;
1695 params->rmask |= 1 << var;
1696 }
1697 return changed;
1698}
1699
1700
1701/**
1702 * snd_pcm_hw_param_last - refine config space and return maximum value
1703 * @pcm: PCM instance
1704 * @params: the hw_params instance
1705 * @var: parameter to retrieve
1706 * @dir: pointer to the direction (-1,0,1) or %NULL
1707 *
1708 * Inside configuration space defined by @params remove from @var all
1709 * values < maximum. Reduce configuration space accordingly.
1710 *
1711 * Return: The maximum, or a negative error code on failure.
1712 */
1713int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
1714 struct snd_pcm_hw_params *params,
1715 snd_pcm_hw_param_t var, int *dir)
1716{
1717 int changed = _snd_pcm_hw_param_last(params, var);
1718 if (changed < 0)
1719 return changed;
1720 if (params->rmask) {
1721 int err = snd_pcm_hw_refine(pcm, params);
1722 if (err < 0)
1723 return err;
1724 }
1725 return snd_pcm_hw_param_value(params, var, dir);
1726}
1727EXPORT_SYMBOL(snd_pcm_hw_param_last);
1728
1729/**
1730 * snd_pcm_hw_params_bits - Get the number of bits per the sample.
1731 * @p: hardware parameters
1732 *
1733 * Return: The number of bits per sample based on the format,
1734 * subformat and msbits the specified hw params has.
1735 */
1736int snd_pcm_hw_params_bits(const struct snd_pcm_hw_params *p)
1737{
1738 snd_pcm_subformat_t subformat = params_subformat(p);
1739 snd_pcm_format_t format = params_format(p);
1740
1741 switch (format) {
1742 case SNDRV_PCM_FORMAT_S32_LE:
1743 case SNDRV_PCM_FORMAT_U32_LE:
1744 case SNDRV_PCM_FORMAT_S32_BE:
1745 case SNDRV_PCM_FORMAT_U32_BE:
1746 switch (subformat) {
1747 case SNDRV_PCM_SUBFORMAT_MSBITS_20:
1748 return 20;
1749 case SNDRV_PCM_SUBFORMAT_MSBITS_24:
1750 return 24;
1751 case SNDRV_PCM_SUBFORMAT_MSBITS_MAX:
1752 case SNDRV_PCM_SUBFORMAT_STD:
1753 default:
1754 break;
1755 }
1756 fallthrough;
1757 default:
1758 return snd_pcm_format_width(format);
1759 }
1760}
1761EXPORT_SYMBOL(snd_pcm_hw_params_bits);
1762
1763static int snd_pcm_lib_ioctl_reset(struct snd_pcm_substream *substream,
1764 void *arg)
1765{
1766 struct snd_pcm_runtime *runtime = substream->runtime;
1767
1768 guard(pcm_stream_lock_irqsave)(substream);
1769 if (snd_pcm_running(substream) &&
1770 snd_pcm_update_hw_ptr(substream) >= 0)
1771 runtime->status->hw_ptr %= runtime->buffer_size;
1772 else {
1773 runtime->status->hw_ptr = 0;
1774 runtime->hw_ptr_wrap = 0;
1775 }
1776 return 0;
1777}
1778
1779static int snd_pcm_lib_ioctl_channel_info(struct snd_pcm_substream *substream,
1780 void *arg)
1781{
1782 struct snd_pcm_channel_info *info = arg;
1783 struct snd_pcm_runtime *runtime = substream->runtime;
1784 int width;
1785 if (!(runtime->info & SNDRV_PCM_INFO_MMAP)) {
1786 info->offset = -1;
1787 return 0;
1788 }
1789 width = snd_pcm_format_physical_width(runtime->format);
1790 if (width < 0)
1791 return width;
1792 info->offset = 0;
1793 switch (runtime->access) {
1794 case SNDRV_PCM_ACCESS_MMAP_INTERLEAVED:
1795 case SNDRV_PCM_ACCESS_RW_INTERLEAVED:
1796 info->first = info->channel * width;
1797 info->step = runtime->channels * width;
1798 break;
1799 case SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED:
1800 case SNDRV_PCM_ACCESS_RW_NONINTERLEAVED:
1801 {
1802 size_t size = runtime->dma_bytes / runtime->channels;
1803 info->first = info->channel * size * 8;
1804 info->step = width;
1805 break;
1806 }
1807 default:
1808 snd_BUG();
1809 break;
1810 }
1811 return 0;
1812}
1813
1814static int snd_pcm_lib_ioctl_fifo_size(struct snd_pcm_substream *substream,
1815 void *arg)
1816{
1817 struct snd_pcm_hw_params *params = arg;
1818 snd_pcm_format_t format;
1819 int channels;
1820 ssize_t frame_size;
1821
1822 params->fifo_size = substream->runtime->hw.fifo_size;
1823 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_FIFO_IN_FRAMES)) {
1824 format = params_format(params);
1825 channels = params_channels(params);
1826 frame_size = snd_pcm_format_size(format, channels);
1827 if (frame_size > 0)
1828 params->fifo_size /= frame_size;
1829 }
1830 return 0;
1831}
1832
1833static int snd_pcm_lib_ioctl_sync_id(struct snd_pcm_substream *substream,
1834 void *arg)
1835{
1836 static const unsigned char id[12] = { 0xff, 0xff, 0xff, 0xff,
1837 0xff, 0xff, 0xff, 0xff,
1838 0xff, 0xff, 0xff, 0xff };
1839
1840 if (substream->runtime->std_sync_id)
1841 snd_pcm_set_sync_per_card(substream, arg, id, sizeof(id));
1842 return 0;
1843}
1844
1845/**
1846 * snd_pcm_lib_ioctl - a generic PCM ioctl callback
1847 * @substream: the pcm substream instance
1848 * @cmd: ioctl command
1849 * @arg: ioctl argument
1850 *
1851 * Processes the generic ioctl commands for PCM.
1852 * Can be passed as the ioctl callback for PCM ops.
1853 *
1854 * Return: Zero if successful, or a negative error code on failure.
1855 */
1856int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1857 unsigned int cmd, void *arg)
1858{
1859 switch (cmd) {
1860 case SNDRV_PCM_IOCTL1_RESET:
1861 return snd_pcm_lib_ioctl_reset(substream, arg);
1862 case SNDRV_PCM_IOCTL1_CHANNEL_INFO:
1863 return snd_pcm_lib_ioctl_channel_info(substream, arg);
1864 case SNDRV_PCM_IOCTL1_FIFO_SIZE:
1865 return snd_pcm_lib_ioctl_fifo_size(substream, arg);
1866 case SNDRV_PCM_IOCTL1_SYNC_ID:
1867 return snd_pcm_lib_ioctl_sync_id(substream, arg);
1868 }
1869 return -ENXIO;
1870}
1871EXPORT_SYMBOL(snd_pcm_lib_ioctl);
1872
1873/**
1874 * snd_pcm_period_elapsed_under_stream_lock() - update the status of runtime for the next period
1875 * under acquired lock of PCM substream.
1876 * @substream: the instance of pcm substream.
1877 *
1878 * This function is called when the batch of audio data frames as the same size as the period of
1879 * buffer is already processed in audio data transmission.
1880 *
1881 * The call of function updates the status of runtime with the latest position of audio data
1882 * transmission, checks overrun and underrun over buffer, awaken user processes from waiting for
1883 * available audio data frames, sampling audio timestamp, and performs stop or drain the PCM
1884 * substream according to configured threshold.
1885 *
1886 * The function is intended to use for the case that PCM driver operates audio data frames under
1887 * acquired lock of PCM substream; e.g. in callback of any operation of &snd_pcm_ops in process
1888 * context. In any interrupt context, it's preferrable to use ``snd_pcm_period_elapsed()`` instead
1889 * since lock of PCM substream should be acquired in advance.
1890 *
1891 * Developer should pay enough attention that some callbacks in &snd_pcm_ops are done by the call of
1892 * function:
1893 *
1894 * - .pointer - to retrieve current position of audio data transmission by frame count or XRUN state.
1895 * - .trigger - with SNDRV_PCM_TRIGGER_STOP at XRUN or DRAINING state.
1896 * - .get_time_info - to retrieve audio time stamp if needed.
1897 *
1898 * Even if more than one periods have elapsed since the last call, you have to call this only once.
1899 */
1900void snd_pcm_period_elapsed_under_stream_lock(struct snd_pcm_substream *substream)
1901{
1902 struct snd_pcm_runtime *runtime;
1903
1904 if (PCM_RUNTIME_CHECK(substream))
1905 return;
1906 runtime = substream->runtime;
1907
1908 if (!snd_pcm_running(substream) ||
1909 snd_pcm_update_hw_ptr0(substream, 1) < 0)
1910 goto _end;
1911
1912#ifdef CONFIG_SND_PCM_TIMER
1913 if (substream->timer_running)
1914 snd_timer_interrupt(substream->timer, 1);
1915#endif
1916 _end:
1917 snd_kill_fasync(runtime->fasync, SIGIO, POLL_IN);
1918}
1919EXPORT_SYMBOL(snd_pcm_period_elapsed_under_stream_lock);
1920
1921/**
1922 * snd_pcm_period_elapsed() - update the status of runtime for the next period by acquiring lock of
1923 * PCM substream.
1924 * @substream: the instance of PCM substream.
1925 *
1926 * This function is mostly similar to ``snd_pcm_period_elapsed_under_stream_lock()`` except for
1927 * acquiring lock of PCM substream voluntarily.
1928 *
1929 * It's typically called by any type of IRQ handler when hardware IRQ occurs to notify event that
1930 * the batch of audio data frames as the same size as the period of buffer is already processed in
1931 * audio data transmission.
1932 */
1933void snd_pcm_period_elapsed(struct snd_pcm_substream *substream)
1934{
1935 if (snd_BUG_ON(!substream))
1936 return;
1937
1938 guard(pcm_stream_lock_irqsave)(substream);
1939 snd_pcm_period_elapsed_under_stream_lock(substream);
1940}
1941EXPORT_SYMBOL(snd_pcm_period_elapsed);
1942
1943/*
1944 * Wait until avail_min data becomes available
1945 * Returns a negative error code if any error occurs during operation.
1946 * The available space is stored on availp. When err = 0 and avail = 0
1947 * on the capture stream, it indicates the stream is in DRAINING state.
1948 */
1949static int wait_for_avail(struct snd_pcm_substream *substream,
1950 snd_pcm_uframes_t *availp)
1951{
1952 struct snd_pcm_runtime *runtime = substream->runtime;
1953 int is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
1954 wait_queue_entry_t wait;
1955 int err = 0;
1956 snd_pcm_uframes_t avail = 0;
1957 long wait_time, tout;
1958
1959 init_waitqueue_entry(&wait, current);
1960 set_current_state(TASK_INTERRUPTIBLE);
1961 add_wait_queue(&runtime->tsleep, &wait);
1962
1963 if (runtime->no_period_wakeup)
1964 wait_time = MAX_SCHEDULE_TIMEOUT;
1965 else {
1966 /* use wait time from substream if available */
1967 if (substream->wait_time) {
1968 wait_time = substream->wait_time;
1969 } else {
1970 wait_time = 100;
1971
1972 if (runtime->rate) {
1973 long t = runtime->buffer_size * 1100 / runtime->rate;
1974 wait_time = max(t, wait_time);
1975 }
1976 }
1977 wait_time = msecs_to_jiffies(wait_time);
1978 }
1979
1980 for (;;) {
1981 if (signal_pending(current)) {
1982 err = -ERESTARTSYS;
1983 break;
1984 }
1985
1986 /*
1987 * We need to check if space became available already
1988 * (and thus the wakeup happened already) first to close
1989 * the race of space already having become available.
1990 * This check must happen after been added to the waitqueue
1991 * and having current state be INTERRUPTIBLE.
1992 */
1993 avail = snd_pcm_avail(substream);
1994 if (avail >= runtime->twake)
1995 break;
1996 snd_pcm_stream_unlock_irq(substream);
1997
1998 tout = schedule_timeout(wait_time);
1999
2000 snd_pcm_stream_lock_irq(substream);
2001 set_current_state(TASK_INTERRUPTIBLE);
2002 switch (runtime->state) {
2003 case SNDRV_PCM_STATE_SUSPENDED:
2004 err = -ESTRPIPE;
2005 goto _endloop;
2006 case SNDRV_PCM_STATE_XRUN:
2007 err = -EPIPE;
2008 goto _endloop;
2009 case SNDRV_PCM_STATE_DRAINING:
2010 if (is_playback)
2011 err = -EPIPE;
2012 else
2013 avail = 0; /* indicate draining */
2014 goto _endloop;
2015 case SNDRV_PCM_STATE_OPEN:
2016 case SNDRV_PCM_STATE_SETUP:
2017 case SNDRV_PCM_STATE_DISCONNECTED:
2018 err = -EBADFD;
2019 goto _endloop;
2020 case SNDRV_PCM_STATE_PAUSED:
2021 continue;
2022 }
2023 if (!tout) {
2024 pcm_dbg(substream->pcm,
2025 "%s timeout (DMA or IRQ trouble?)\n",
2026 is_playback ? "playback write" : "capture read");
2027 err = -EIO;
2028 break;
2029 }
2030 }
2031 _endloop:
2032 set_current_state(TASK_RUNNING);
2033 remove_wait_queue(&runtime->tsleep, &wait);
2034 *availp = avail;
2035 return err;
2036}
2037
2038typedef int (*pcm_transfer_f)(struct snd_pcm_substream *substream,
2039 int channel, unsigned long hwoff,
2040 struct iov_iter *iter, unsigned long bytes);
2041
2042typedef int (*pcm_copy_f)(struct snd_pcm_substream *, snd_pcm_uframes_t, void *,
2043 snd_pcm_uframes_t, snd_pcm_uframes_t, pcm_transfer_f,
2044 bool);
2045
2046/* calculate the target DMA-buffer position to be written/read */
2047static void *get_dma_ptr(struct snd_pcm_runtime *runtime,
2048 int channel, unsigned long hwoff)
2049{
2050 return runtime->dma_area + hwoff +
2051 channel * (runtime->dma_bytes / runtime->channels);
2052}
2053
2054/* default copy ops for write; used for both interleaved and non- modes */
2055static int default_write_copy(struct snd_pcm_substream *substream,
2056 int channel, unsigned long hwoff,
2057 struct iov_iter *iter, unsigned long bytes)
2058{
2059 if (copy_from_iter(get_dma_ptr(substream->runtime, channel, hwoff),
2060 bytes, iter) != bytes)
2061 return -EFAULT;
2062 return 0;
2063}
2064
2065/* fill silence instead of copy data; called as a transfer helper
2066 * from __snd_pcm_lib_write() or directly from noninterleaved_copy() when
2067 * a NULL buffer is passed
2068 */
2069static int fill_silence(struct snd_pcm_substream *substream, int channel,
2070 unsigned long hwoff, struct iov_iter *iter,
2071 unsigned long bytes)
2072{
2073 struct snd_pcm_runtime *runtime = substream->runtime;
2074
2075 if (substream->stream != SNDRV_PCM_STREAM_PLAYBACK)
2076 return 0;
2077 if (substream->ops->fill_silence)
2078 return substream->ops->fill_silence(substream, channel,
2079 hwoff, bytes);
2080
2081 snd_pcm_format_set_silence(runtime->format,
2082 get_dma_ptr(runtime, channel, hwoff),
2083 bytes_to_samples(runtime, bytes));
2084 return 0;
2085}
2086
2087/* default copy ops for read; used for both interleaved and non- modes */
2088static int default_read_copy(struct snd_pcm_substream *substream,
2089 int channel, unsigned long hwoff,
2090 struct iov_iter *iter, unsigned long bytes)
2091{
2092 if (copy_to_iter(get_dma_ptr(substream->runtime, channel, hwoff),
2093 bytes, iter) != bytes)
2094 return -EFAULT;
2095 return 0;
2096}
2097
2098/* call transfer with the filled iov_iter */
2099static int do_transfer(struct snd_pcm_substream *substream, int c,
2100 unsigned long hwoff, void *data, unsigned long bytes,
2101 pcm_transfer_f transfer, bool in_kernel)
2102{
2103 struct iov_iter iter;
2104 int err, type;
2105
2106 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
2107 type = ITER_SOURCE;
2108 else
2109 type = ITER_DEST;
2110
2111 if (in_kernel) {
2112 struct kvec kvec = { data, bytes };
2113
2114 iov_iter_kvec(&iter, type, &kvec, 1, bytes);
2115 return transfer(substream, c, hwoff, &iter, bytes);
2116 }
2117
2118 err = import_ubuf(type, (__force void __user *)data, bytes, &iter);
2119 if (err)
2120 return err;
2121 return transfer(substream, c, hwoff, &iter, bytes);
2122}
2123
2124/* call transfer function with the converted pointers and sizes;
2125 * for interleaved mode, it's one shot for all samples
2126 */
2127static int interleaved_copy(struct snd_pcm_substream *substream,
2128 snd_pcm_uframes_t hwoff, void *data,
2129 snd_pcm_uframes_t off,
2130 snd_pcm_uframes_t frames,
2131 pcm_transfer_f transfer,
2132 bool in_kernel)
2133{
2134 struct snd_pcm_runtime *runtime = substream->runtime;
2135
2136 /* convert to bytes */
2137 hwoff = frames_to_bytes(runtime, hwoff);
2138 off = frames_to_bytes(runtime, off);
2139 frames = frames_to_bytes(runtime, frames);
2140
2141 return do_transfer(substream, 0, hwoff, data + off, frames, transfer,
2142 in_kernel);
2143}
2144
2145/* call transfer function with the converted pointers and sizes for each
2146 * non-interleaved channel; when buffer is NULL, silencing instead of copying
2147 */
2148static int noninterleaved_copy(struct snd_pcm_substream *substream,
2149 snd_pcm_uframes_t hwoff, void *data,
2150 snd_pcm_uframes_t off,
2151 snd_pcm_uframes_t frames,
2152 pcm_transfer_f transfer,
2153 bool in_kernel)
2154{
2155 struct snd_pcm_runtime *runtime = substream->runtime;
2156 int channels = runtime->channels;
2157 void **bufs = data;
2158 int c, err;
2159
2160 /* convert to bytes; note that it's not frames_to_bytes() here.
2161 * in non-interleaved mode, we copy for each channel, thus
2162 * each copy is n_samples bytes x channels = whole frames.
2163 */
2164 off = samples_to_bytes(runtime, off);
2165 frames = samples_to_bytes(runtime, frames);
2166 hwoff = samples_to_bytes(runtime, hwoff);
2167 for (c = 0; c < channels; ++c, ++bufs) {
2168 if (!data || !*bufs)
2169 err = fill_silence(substream, c, hwoff, NULL, frames);
2170 else
2171 err = do_transfer(substream, c, hwoff, *bufs + off,
2172 frames, transfer, in_kernel);
2173 if (err < 0)
2174 return err;
2175 }
2176 return 0;
2177}
2178
2179/* fill silence on the given buffer position;
2180 * called from snd_pcm_playback_silence()
2181 */
2182static int fill_silence_frames(struct snd_pcm_substream *substream,
2183 snd_pcm_uframes_t off, snd_pcm_uframes_t frames)
2184{
2185 if (substream->runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
2186 substream->runtime->access == SNDRV_PCM_ACCESS_MMAP_INTERLEAVED)
2187 return interleaved_copy(substream, off, NULL, 0, frames,
2188 fill_silence, true);
2189 else
2190 return noninterleaved_copy(substream, off, NULL, 0, frames,
2191 fill_silence, true);
2192}
2193
2194/* sanity-check for read/write methods */
2195static int pcm_sanity_check(struct snd_pcm_substream *substream)
2196{
2197 struct snd_pcm_runtime *runtime;
2198 if (PCM_RUNTIME_CHECK(substream))
2199 return -ENXIO;
2200 runtime = substream->runtime;
2201 if (snd_BUG_ON(!substream->ops->copy && !runtime->dma_area))
2202 return -EINVAL;
2203 if (runtime->state == SNDRV_PCM_STATE_OPEN)
2204 return -EBADFD;
2205 return 0;
2206}
2207
2208static int pcm_accessible_state(struct snd_pcm_runtime *runtime)
2209{
2210 switch (runtime->state) {
2211 case SNDRV_PCM_STATE_PREPARED:
2212 case SNDRV_PCM_STATE_RUNNING:
2213 case SNDRV_PCM_STATE_PAUSED:
2214 return 0;
2215 case SNDRV_PCM_STATE_XRUN:
2216 return -EPIPE;
2217 case SNDRV_PCM_STATE_SUSPENDED:
2218 return -ESTRPIPE;
2219 default:
2220 return -EBADFD;
2221 }
2222}
2223
2224/* update to the given appl_ptr and call ack callback if needed;
2225 * when an error is returned, take back to the original value
2226 */
2227int pcm_lib_apply_appl_ptr(struct snd_pcm_substream *substream,
2228 snd_pcm_uframes_t appl_ptr)
2229{
2230 struct snd_pcm_runtime *runtime = substream->runtime;
2231 snd_pcm_uframes_t old_appl_ptr = runtime->control->appl_ptr;
2232 snd_pcm_sframes_t diff;
2233 int ret;
2234
2235 if (old_appl_ptr == appl_ptr)
2236 return 0;
2237
2238 if (appl_ptr >= runtime->boundary)
2239 return -EINVAL;
2240 /*
2241 * check if a rewind is requested by the application
2242 */
2243 if (substream->runtime->info & SNDRV_PCM_INFO_NO_REWINDS) {
2244 diff = appl_ptr - old_appl_ptr;
2245 if (diff >= 0) {
2246 if (diff > runtime->buffer_size)
2247 return -EINVAL;
2248 } else {
2249 if (runtime->boundary + diff > runtime->buffer_size)
2250 return -EINVAL;
2251 }
2252 }
2253
2254 runtime->control->appl_ptr = appl_ptr;
2255 if (substream->ops->ack) {
2256 ret = substream->ops->ack(substream);
2257 if (ret < 0) {
2258 runtime->control->appl_ptr = old_appl_ptr;
2259 if (ret == -EPIPE)
2260 __snd_pcm_xrun(substream);
2261 return ret;
2262 }
2263 }
2264
2265 trace_applptr(substream, old_appl_ptr, appl_ptr);
2266
2267 return 0;
2268}
2269
2270/* the common loop for read/write data */
2271snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
2272 void *data, bool interleaved,
2273 snd_pcm_uframes_t size, bool in_kernel)
2274{
2275 struct snd_pcm_runtime *runtime = substream->runtime;
2276 snd_pcm_uframes_t xfer = 0;
2277 snd_pcm_uframes_t offset = 0;
2278 snd_pcm_uframes_t avail;
2279 pcm_copy_f writer;
2280 pcm_transfer_f transfer;
2281 bool nonblock;
2282 bool is_playback;
2283 int err;
2284
2285 err = pcm_sanity_check(substream);
2286 if (err < 0)
2287 return err;
2288
2289 is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
2290 if (interleaved) {
2291 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
2292 runtime->channels > 1)
2293 return -EINVAL;
2294 writer = interleaved_copy;
2295 } else {
2296 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2297 return -EINVAL;
2298 writer = noninterleaved_copy;
2299 }
2300
2301 if (!data) {
2302 if (is_playback)
2303 transfer = fill_silence;
2304 else
2305 return -EINVAL;
2306 } else {
2307 if (substream->ops->copy)
2308 transfer = substream->ops->copy;
2309 else
2310 transfer = is_playback ?
2311 default_write_copy : default_read_copy;
2312 }
2313
2314 if (size == 0)
2315 return 0;
2316
2317 nonblock = !!(substream->f_flags & O_NONBLOCK);
2318
2319 snd_pcm_stream_lock_irq(substream);
2320 err = pcm_accessible_state(runtime);
2321 if (err < 0)
2322 goto _end_unlock;
2323
2324 runtime->twake = runtime->control->avail_min ? : 1;
2325 if (runtime->state == SNDRV_PCM_STATE_RUNNING)
2326 snd_pcm_update_hw_ptr(substream);
2327
2328 /*
2329 * If size < start_threshold, wait indefinitely. Another
2330 * thread may start capture
2331 */
2332 if (!is_playback &&
2333 runtime->state == SNDRV_PCM_STATE_PREPARED &&
2334 size >= runtime->start_threshold) {
2335 err = snd_pcm_start(substream);
2336 if (err < 0)
2337 goto _end_unlock;
2338 }
2339
2340 avail = snd_pcm_avail(substream);
2341
2342 while (size > 0) {
2343 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
2344 snd_pcm_uframes_t cont;
2345 if (!avail) {
2346 if (!is_playback &&
2347 runtime->state == SNDRV_PCM_STATE_DRAINING) {
2348 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2349 goto _end_unlock;
2350 }
2351 if (nonblock) {
2352 err = -EAGAIN;
2353 goto _end_unlock;
2354 }
2355 runtime->twake = min_t(snd_pcm_uframes_t, size,
2356 runtime->control->avail_min ? : 1);
2357 err = wait_for_avail(substream, &avail);
2358 if (err < 0)
2359 goto _end_unlock;
2360 if (!avail)
2361 continue; /* draining */
2362 }
2363 frames = size > avail ? avail : size;
2364 appl_ptr = READ_ONCE(runtime->control->appl_ptr);
2365 appl_ofs = appl_ptr % runtime->buffer_size;
2366 cont = runtime->buffer_size - appl_ofs;
2367 if (frames > cont)
2368 frames = cont;
2369 if (snd_BUG_ON(!frames)) {
2370 err = -EINVAL;
2371 goto _end_unlock;
2372 }
2373 if (!atomic_inc_unless_negative(&runtime->buffer_accessing)) {
2374 err = -EBUSY;
2375 goto _end_unlock;
2376 }
2377 snd_pcm_stream_unlock_irq(substream);
2378 if (!is_playback)
2379 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
2380 err = writer(substream, appl_ofs, data, offset, frames,
2381 transfer, in_kernel);
2382 if (is_playback)
2383 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2384 snd_pcm_stream_lock_irq(substream);
2385 atomic_dec(&runtime->buffer_accessing);
2386 if (err < 0)
2387 goto _end_unlock;
2388 err = pcm_accessible_state(runtime);
2389 if (err < 0)
2390 goto _end_unlock;
2391 appl_ptr += frames;
2392 if (appl_ptr >= runtime->boundary)
2393 appl_ptr -= runtime->boundary;
2394 err = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2395 if (err < 0)
2396 goto _end_unlock;
2397
2398 offset += frames;
2399 size -= frames;
2400 xfer += frames;
2401 avail -= frames;
2402 if (is_playback &&
2403 runtime->state == SNDRV_PCM_STATE_PREPARED &&
2404 snd_pcm_playback_hw_avail(runtime) >= (snd_pcm_sframes_t)runtime->start_threshold) {
2405 err = snd_pcm_start(substream);
2406 if (err < 0)
2407 goto _end_unlock;
2408 }
2409 }
2410 _end_unlock:
2411 runtime->twake = 0;
2412 if (xfer > 0 && err >= 0)
2413 snd_pcm_update_state(substream, runtime);
2414 snd_pcm_stream_unlock_irq(substream);
2415 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2416}
2417EXPORT_SYMBOL(__snd_pcm_lib_xfer);
2418
2419/*
2420 * standard channel mapping helpers
2421 */
2422
2423/* default channel maps for multi-channel playbacks, up to 8 channels */
2424const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[] = {
2425 { .channels = 1,
2426 .map = { SNDRV_CHMAP_MONO } },
2427 { .channels = 2,
2428 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2429 { .channels = 4,
2430 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2431 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2432 { .channels = 6,
2433 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2434 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2435 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE } },
2436 { .channels = 8,
2437 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2438 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2439 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2440 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2441 { }
2442};
2443EXPORT_SYMBOL_GPL(snd_pcm_std_chmaps);
2444
2445/* alternative channel maps with CLFE <-> surround swapped for 6/8 channels */
2446const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[] = {
2447 { .channels = 1,
2448 .map = { SNDRV_CHMAP_MONO } },
2449 { .channels = 2,
2450 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2451 { .channels = 4,
2452 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2453 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2454 { .channels = 6,
2455 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2456 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2457 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2458 { .channels = 8,
2459 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2460 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2461 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2462 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2463 { }
2464};
2465EXPORT_SYMBOL_GPL(snd_pcm_alt_chmaps);
2466
2467static bool valid_chmap_channels(const struct snd_pcm_chmap *info, int ch)
2468{
2469 if (ch > info->max_channels)
2470 return false;
2471 return !info->channel_mask || (info->channel_mask & (1U << ch));
2472}
2473
2474static int pcm_chmap_ctl_info(struct snd_kcontrol *kcontrol,
2475 struct snd_ctl_elem_info *uinfo)
2476{
2477 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2478
2479 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
2480 uinfo->count = info->max_channels;
2481 uinfo->value.integer.min = 0;
2482 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
2483 return 0;
2484}
2485
2486/* get callback for channel map ctl element
2487 * stores the channel position firstly matching with the current channels
2488 */
2489static int pcm_chmap_ctl_get(struct snd_kcontrol *kcontrol,
2490 struct snd_ctl_elem_value *ucontrol)
2491{
2492 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2493 unsigned int idx = snd_ctl_get_ioffidx(kcontrol, &ucontrol->id);
2494 struct snd_pcm_substream *substream;
2495 const struct snd_pcm_chmap_elem *map;
2496
2497 if (!info->chmap)
2498 return -EINVAL;
2499 substream = snd_pcm_chmap_substream(info, idx);
2500 if (!substream)
2501 return -ENODEV;
2502 memset(ucontrol->value.integer.value, 0,
2503 sizeof(long) * info->max_channels);
2504 if (!substream->runtime)
2505 return 0; /* no channels set */
2506 for (map = info->chmap; map->channels; map++) {
2507 int i;
2508 if (map->channels == substream->runtime->channels &&
2509 valid_chmap_channels(info, map->channels)) {
2510 for (i = 0; i < map->channels; i++)
2511 ucontrol->value.integer.value[i] = map->map[i];
2512 return 0;
2513 }
2514 }
2515 return -EINVAL;
2516}
2517
2518/* tlv callback for channel map ctl element
2519 * expands the pre-defined channel maps in a form of TLV
2520 */
2521static int pcm_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
2522 unsigned int size, unsigned int __user *tlv)
2523{
2524 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2525 const struct snd_pcm_chmap_elem *map;
2526 unsigned int __user *dst;
2527 int c, count = 0;
2528
2529 if (!info->chmap)
2530 return -EINVAL;
2531 if (size < 8)
2532 return -ENOMEM;
2533 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
2534 return -EFAULT;
2535 size -= 8;
2536 dst = tlv + 2;
2537 for (map = info->chmap; map->channels; map++) {
2538 int chs_bytes = map->channels * 4;
2539 if (!valid_chmap_channels(info, map->channels))
2540 continue;
2541 if (size < 8)
2542 return -ENOMEM;
2543 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
2544 put_user(chs_bytes, dst + 1))
2545 return -EFAULT;
2546 dst += 2;
2547 size -= 8;
2548 count += 8;
2549 if (size < chs_bytes)
2550 return -ENOMEM;
2551 size -= chs_bytes;
2552 count += chs_bytes;
2553 for (c = 0; c < map->channels; c++) {
2554 if (put_user(map->map[c], dst))
2555 return -EFAULT;
2556 dst++;
2557 }
2558 }
2559 if (put_user(count, tlv + 1))
2560 return -EFAULT;
2561 return 0;
2562}
2563
2564static void pcm_chmap_ctl_private_free(struct snd_kcontrol *kcontrol)
2565{
2566 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2567 info->pcm->streams[info->stream].chmap_kctl = NULL;
2568 kfree(info);
2569}
2570
2571/**
2572 * snd_pcm_add_chmap_ctls - create channel-mapping control elements
2573 * @pcm: the assigned PCM instance
2574 * @stream: stream direction
2575 * @chmap: channel map elements (for query)
2576 * @max_channels: the max number of channels for the stream
2577 * @private_value: the value passed to each kcontrol's private_value field
2578 * @info_ret: store struct snd_pcm_chmap instance if non-NULL
2579 *
2580 * Create channel-mapping control elements assigned to the given PCM stream(s).
2581 * Return: Zero if successful, or a negative error value.
2582 */
2583int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
2584 const struct snd_pcm_chmap_elem *chmap,
2585 int max_channels,
2586 unsigned long private_value,
2587 struct snd_pcm_chmap **info_ret)
2588{
2589 struct snd_pcm_chmap *info;
2590 struct snd_kcontrol_new knew = {
2591 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
2592 .access = SNDRV_CTL_ELEM_ACCESS_READ |
2593 SNDRV_CTL_ELEM_ACCESS_VOLATILE |
2594 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
2595 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,
2596 .info = pcm_chmap_ctl_info,
2597 .get = pcm_chmap_ctl_get,
2598 .tlv.c = pcm_chmap_ctl_tlv,
2599 };
2600 int err;
2601
2602 if (WARN_ON(pcm->streams[stream].chmap_kctl))
2603 return -EBUSY;
2604 info = kzalloc(sizeof(*info), GFP_KERNEL);
2605 if (!info)
2606 return -ENOMEM;
2607 info->pcm = pcm;
2608 info->stream = stream;
2609 info->chmap = chmap;
2610 info->max_channels = max_channels;
2611 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2612 knew.name = "Playback Channel Map";
2613 else
2614 knew.name = "Capture Channel Map";
2615 knew.device = pcm->device;
2616 knew.count = pcm->streams[stream].substream_count;
2617 knew.private_value = private_value;
2618 info->kctl = snd_ctl_new1(&knew, info);
2619 if (!info->kctl) {
2620 kfree(info);
2621 return -ENOMEM;
2622 }
2623 info->kctl->private_free = pcm_chmap_ctl_private_free;
2624 err = snd_ctl_add(pcm->card, info->kctl);
2625 if (err < 0)
2626 return err;
2627 pcm->streams[stream].chmap_kctl = info->kctl;
2628 if (info_ret)
2629 *info_ret = info;
2630 return 0;
2631}
2632EXPORT_SYMBOL_GPL(snd_pcm_add_chmap_ctls);