pcm_lib.c 59 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1
2
/*
 *  Digital Audio (PCM) abstract layer
3
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds's avatar
Linus Torvalds committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *                   Abramo Bagnara <abramo@alsa-project.org>
 *
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 *
 */

#include <linux/slab.h>
#include <linux/time.h>
25
#include <linux/math64.h>
Linus Torvalds's avatar
Linus Torvalds committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#include <sound/core.h>
#include <sound/control.h>
#include <sound/info.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/timer.h>

/*
 * fill ring buffer with silence
 * runtime->silence_start: starting pointer to silence area
 * runtime->silence_filled: size filled with silence
 * runtime->silence_threshold: threshold from application
 * runtime->silence_size: maximal size from application
 *
 * when runtime->silence_size >= runtime->boundary - fill processed area with silence immediately
 */
42
void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
Linus Torvalds's avatar
Linus Torvalds committed
43
{
44
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
45
46
47
48
49
50
51
52
53
54
55
56
57
58
	snd_pcm_uframes_t frames, ofs, transfer;

	if (runtime->silence_size < runtime->boundary) {
		snd_pcm_sframes_t noise_dist, n;
		if (runtime->silence_start != runtime->control->appl_ptr) {
			n = runtime->control->appl_ptr - runtime->silence_start;
			if (n < 0)
				n += runtime->boundary;
			if ((snd_pcm_uframes_t)n < runtime->silence_filled)
				runtime->silence_filled -= n;
			else
				runtime->silence_filled = 0;
			runtime->silence_start = runtime->control->appl_ptr;
		}
Takashi Iwai's avatar
Takashi Iwai committed
59
		if (runtime->silence_filled >= runtime->buffer_size)
Linus Torvalds's avatar
Linus Torvalds committed
60
61
62
63
64
65
66
67
68
69
			return;
		noise_dist = snd_pcm_playback_hw_avail(runtime) + runtime->silence_filled;
		if (noise_dist >= (snd_pcm_sframes_t) runtime->silence_threshold)
			return;
		frames = runtime->silence_threshold - noise_dist;
		if (frames > runtime->silence_size)
			frames = runtime->silence_size;
	} else {
		if (new_hw_ptr == ULONG_MAX) {	/* initialization */
			snd_pcm_sframes_t avail = snd_pcm_playback_hw_avail(runtime);
70
71
			if (avail > runtime->buffer_size)
				avail = runtime->buffer_size;
Linus Torvalds's avatar
Linus Torvalds committed
72
73
74
75
76
77
78
79
80
81
82
83
			runtime->silence_filled = avail > 0 ? avail : 0;
			runtime->silence_start = (runtime->status->hw_ptr +
						  runtime->silence_filled) %
						 runtime->boundary;
		} else {
			ofs = runtime->status->hw_ptr;
			frames = new_hw_ptr - ofs;
			if ((snd_pcm_sframes_t)frames < 0)
				frames += runtime->boundary;
			runtime->silence_filled -= frames;
			if ((snd_pcm_sframes_t)runtime->silence_filled < 0) {
				runtime->silence_filled = 0;
84
				runtime->silence_start = new_hw_ptr;
Linus Torvalds's avatar
Linus Torvalds committed
85
			} else {
86
				runtime->silence_start = ofs;
Linus Torvalds's avatar
Linus Torvalds committed
87
88
89
90
			}
		}
		frames = runtime->buffer_size - runtime->silence_filled;
	}
91
92
	if (snd_BUG_ON(frames > runtime->buffer_size))
		return;
Linus Torvalds's avatar
Linus Torvalds committed
93
94
	if (frames == 0)
		return;
95
	ofs = runtime->silence_start % runtime->buffer_size;
Linus Torvalds's avatar
Linus Torvalds committed
96
97
98
99
100
101
102
	while (frames > 0) {
		transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
		if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
		    runtime->access == SNDRV_PCM_ACCESS_MMAP_INTERLEAVED) {
			if (substream->ops->silence) {
				int err;
				err = substream->ops->silence(substream, -1, ofs, transfer);
103
				snd_BUG_ON(err < 0);
Linus Torvalds's avatar
Linus Torvalds committed
104
105
106
107
108
109
110
111
112
113
114
			} else {
				char *hwbuf = runtime->dma_area + frames_to_bytes(runtime, ofs);
				snd_pcm_format_set_silence(runtime->format, hwbuf, transfer * runtime->channels);
			}
		} else {
			unsigned int c;
			unsigned int channels = runtime->channels;
			if (substream->ops->silence) {
				for (c = 0; c < channels; ++c) {
					int err;
					err = substream->ops->silence(substream, c, ofs, transfer);
115
					snd_BUG_ON(err < 0);
Linus Torvalds's avatar
Linus Torvalds committed
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
				}
			} else {
				size_t dma_csize = runtime->dma_bytes / channels;
				for (c = 0; c < channels; ++c) {
					char *hwbuf = runtime->dma_area + (c * dma_csize) + samples_to_bytes(runtime, ofs);
					snd_pcm_format_set_silence(runtime->format, hwbuf, transfer);
				}
			}
		}
		runtime->silence_filled += transfer;
		frames -= transfer;
		ofs = 0;
	}
}

131
132
133
134
135
136
137
138
139
140
static void pcm_debug_name(struct snd_pcm_substream *substream,
			   char *name, size_t len)
{
	snprintf(name, len, "pcmC%dD%d%c:%d",
		 substream->pcm->card->number,
		 substream->pcm->device,
		 substream->stream ? 'c' : 'p',
		 substream->number);
}

141
142
143
144
145
#define XRUN_DEBUG_BASIC	(1<<0)
#define XRUN_DEBUG_STACK	(1<<1)	/* dump also stack */
#define XRUN_DEBUG_JIFFIESCHECK	(1<<2)	/* do jiffies check */
#define XRUN_DEBUG_PERIODUPDATE	(1<<3)	/* full period update info */
#define XRUN_DEBUG_HWPTRUPDATE	(1<<4)	/* full hwptr update info */
146
147
#define XRUN_DEBUG_LOG		(1<<5)	/* show last 10 positions on err */
#define XRUN_DEBUG_LOGONCE	(1<<6)	/* do above only once */
148

Takashi Iwai's avatar
Takashi Iwai committed
149
#ifdef CONFIG_SND_PCM_XRUN_DEBUG
150

151
152
#define xrun_debug(substream, mask) \
			((substream)->pstr->xrun_debug & (mask))
153
154
155
#else
#define xrun_debug(substream, mask)	0
#endif
Takashi Iwai's avatar
Takashi Iwai committed
156

157
158
159
#define dump_stack_on_xrun(substream) do {			\
		if (xrun_debug(substream, XRUN_DEBUG_STACK))	\
			dump_stack();				\
Takashi Iwai's avatar
Takashi Iwai committed
160
161
	} while (0)

162
static void xrun(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
163
{
164
165
166
167
	struct snd_pcm_runtime *runtime = substream->runtime;

	if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
		snd_pcm_gettime(runtime, (struct timespec *)&runtime->status->tstamp);
Linus Torvalds's avatar
Linus Torvalds committed
168
	snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
169
	if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
170
171
172
		char name[16];
		pcm_debug_name(substream, name, sizeof(name));
		snd_printd(KERN_DEBUG "XRUN: %s\n", name);
Takashi Iwai's avatar
Takashi Iwai committed
173
		dump_stack_on_xrun(substream);
Linus Torvalds's avatar
Linus Torvalds committed
174
175
176
	}
}

177
#ifdef CONFIG_SND_PCM_XRUN_DEBUG
178
179
180
#define hw_ptr_error(substream, fmt, args...)				\
	do {								\
		if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {		\
181
			xrun_log_show(substream);			\
182
183
184
185
186
187
188
189
190
191
192
			if (printk_ratelimit()) {			\
				snd_printd("PCM: " fmt, ##args);	\
			}						\
			dump_stack_on_xrun(substream);			\
		}							\
	} while (0)

#define XRUN_LOG_CNT	10

struct hwptr_log_entry {
	unsigned long jiffies;
Linus Torvalds's avatar
Linus Torvalds committed
193
	snd_pcm_uframes_t pos;
194
195
196
197
198
	snd_pcm_uframes_t period_size;
	snd_pcm_uframes_t buffer_size;
	snd_pcm_uframes_t old_hw_ptr;
	snd_pcm_uframes_t hw_ptr_base;
};
Linus Torvalds's avatar
Linus Torvalds committed
199

200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
struct snd_pcm_hwptr_log {
	unsigned int idx;
	unsigned int hit: 1;
	struct hwptr_log_entry entries[XRUN_LOG_CNT];
};

static void xrun_log(struct snd_pcm_substream *substream,
		     snd_pcm_uframes_t pos)
{
	struct snd_pcm_runtime *runtime = substream->runtime;
	struct snd_pcm_hwptr_log *log = runtime->hwptr_log;
	struct hwptr_log_entry *entry;

	if (log == NULL) {
		log = kzalloc(sizeof(*log), GFP_ATOMIC);
		if (log == NULL)
			return;
		runtime->hwptr_log = log;
	} else {
		if (xrun_debug(substream, XRUN_DEBUG_LOGONCE) && log->hit)
			return;
221
	}
222
223
224
225
	entry = &log->entries[log->idx];
	entry->jiffies = jiffies;
	entry->pos = pos;
	entry->period_size = runtime->period_size;
226
	entry->buffer_size = runtime->buffer_size;
227
228
229
	entry->old_hw_ptr = runtime->status->hw_ptr;
	entry->hw_ptr_base = runtime->hw_ptr_base;
	log->idx = (log->idx + 1) % XRUN_LOG_CNT;
Linus Torvalds's avatar
Linus Torvalds committed
230
231
}

232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
static void xrun_log_show(struct snd_pcm_substream *substream)
{
	struct snd_pcm_hwptr_log *log = substream->runtime->hwptr_log;
	struct hwptr_log_entry *entry;
	char name[16];
	unsigned int idx;
	int cnt;

	if (log == NULL)
		return;
	if (xrun_debug(substream, XRUN_DEBUG_LOGONCE) && log->hit)
		return;
	pcm_debug_name(substream, name, sizeof(name));
	for (cnt = 0, idx = log->idx; cnt < XRUN_LOG_CNT; cnt++) {
		entry = &log->entries[idx];
		if (entry->period_size == 0)
			break;
249
250
		snd_printd("hwptr log: %s: j=%lu, pos=%ld/%ld/%ld, "
			   "hwptr=%ld/%ld\n",
251
252
253
254
			   name, entry->jiffies, (unsigned long)entry->pos,
			   (unsigned long)entry->period_size,
			   (unsigned long)entry->buffer_size,
			   (unsigned long)entry->old_hw_ptr,
255
			   (unsigned long)entry->hw_ptr_base);
256
257
258
259
260
261
262
263
264
265
266
267
268
269
		idx++;
		idx %= XRUN_LOG_CNT;
	}
	log->hit = 1;
}

#else /* ! CONFIG_SND_PCM_XRUN_DEBUG */

#define hw_ptr_error(substream, fmt, args...) do { } while (0)
#define xrun_log(substream, pos)	do { } while (0)
#define xrun_log_show(substream)	do { } while (0)

#endif

270
271
int snd_pcm_update_state(struct snd_pcm_substream *substream,
			 struct snd_pcm_runtime *runtime)
Linus Torvalds's avatar
Linus Torvalds committed
272
273
274
275
276
277
278
279
280
{
	snd_pcm_uframes_t avail;

	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
		avail = snd_pcm_playback_avail(runtime);
	else
		avail = snd_pcm_capture_avail(runtime);
	if (avail > runtime->avail_max)
		runtime->avail_max = avail;
281
282
	if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
		if (avail >= runtime->buffer_size) {
Linus Torvalds's avatar
Linus Torvalds committed
283
			snd_pcm_drain_done(substream);
284
285
286
287
			return -EPIPE;
		}
	} else {
		if (avail >= runtime->stop_threshold) {
Linus Torvalds's avatar
Linus Torvalds committed
288
			xrun(substream);
289
290
			return -EPIPE;
		}
Linus Torvalds's avatar
Linus Torvalds committed
291
	}
292
293
294
295
296
	if (runtime->twake) {
		if (avail >= runtime->twake)
			wake_up(&runtime->tsleep);
	} else if (avail >= runtime->control->avail_min)
		wake_up(&runtime->sleep);
Linus Torvalds's avatar
Linus Torvalds committed
297
298
299
	return 0;
}

300
301
static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
				  unsigned int in_interrupt)
Linus Torvalds's avatar
Linus Torvalds committed
302
{
303
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
304
	snd_pcm_uframes_t pos;
305
	snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
306
307
	snd_pcm_sframes_t hdelta, delta;
	unsigned long jdelta;
Linus Torvalds's avatar
Linus Torvalds committed
308

309
	old_hw_ptr = runtime->status->hw_ptr;
310
	pos = substream->ops->pointer(substream);
Linus Torvalds's avatar
Linus Torvalds committed
311
312
313
314
	if (pos == SNDRV_PCM_POS_XRUN) {
		xrun(substream);
		return -EPIPE;
	}
315
316
317
318
319
320
321
322
323
324
325
	if (pos >= runtime->buffer_size) {
		if (printk_ratelimit()) {
			char name[16];
			pcm_debug_name(substream, name, sizeof(name));
			xrun_log_show(substream);
			snd_printd(KERN_ERR  "BUG: %s, pos = %ld, "
				   "buffer size = %ld, period size = %ld\n",
				   name, pos, runtime->buffer_size,
				   runtime->period_size);
		}
		pos = 0;
326
	}
327
328
329
	pos -= pos % runtime->min_align;
	if (xrun_debug(substream, XRUN_DEBUG_LOG))
		xrun_log(substream, pos);
Takashi Iwai's avatar
Takashi Iwai committed
330
331
	hw_base = runtime->hw_ptr_base;
	new_hw_ptr = hw_base + pos;
332
333
334
	if (in_interrupt) {
		/* we know that one period was processed */
		/* delta = "expected next hw_ptr" for in_interrupt != 0 */
335
		delta = runtime->hw_ptr_interrupt + runtime->period_size;
336
		if (delta > new_hw_ptr) {
337
338
339
340
341
342
343
344
345
			/* check for double acknowledged interrupts */
			hdelta = jiffies - runtime->hw_ptr_jiffies;
			if (hdelta > runtime->hw_ptr_buffer_jiffies/2) {
				hw_base += runtime->buffer_size;
				if (hw_base >= runtime->boundary)
					hw_base = 0;
				new_hw_ptr = hw_base + pos;
				goto __delta;
			}
Linus Torvalds's avatar
Linus Torvalds committed
346
347
		}
	}
348
349
350
351
352
353
354
355
356
	/* new_hw_ptr might be lower than old_hw_ptr in case when */
	/* pointer crosses the end of the ring buffer */
	if (new_hw_ptr < old_hw_ptr) {
		hw_base += runtime->buffer_size;
		if (hw_base >= runtime->boundary)
			hw_base = 0;
		new_hw_ptr = hw_base + pos;
	}
      __delta:
357
358
359
	delta = new_hw_ptr - old_hw_ptr;
	if (delta < 0)
		delta += runtime->boundary;
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
	if (xrun_debug(substream, in_interrupt ?
			XRUN_DEBUG_PERIODUPDATE : XRUN_DEBUG_HWPTRUPDATE)) {
		char name[16];
		pcm_debug_name(substream, name, sizeof(name));
		snd_printd("%s_update: %s: pos=%u/%u/%u, "
			   "hwptr=%ld/%ld/%ld/%ld\n",
			   in_interrupt ? "period" : "hwptr",
			   name,
			   (unsigned int)pos,
			   (unsigned int)runtime->period_size,
			   (unsigned int)runtime->buffer_size,
			   (unsigned long)delta,
			   (unsigned long)old_hw_ptr,
			   (unsigned long)new_hw_ptr,
			   (unsigned long)runtime->hw_ptr_base);
	}
376
377
378
379
380

	/* without period interrupts, there are no regular pointer updates */
	if (runtime->no_period_wakeup)
		goto no_delta_check;

381
	/* something must be really wrong */
382
	if (delta >= runtime->buffer_size + runtime->period_size) {
383
384
385
386
387
388
389
390
391
		hw_ptr_error(substream,
			       "Unexpected hw_pointer value %s"
			       "(stream=%i, pos=%ld, new_hw_ptr=%ld, "
			       "old_hw_ptr=%ld)\n",
				     in_interrupt ? "[Q] " : "[P]",
				     substream->stream, (long)pos,
				     (long)new_hw_ptr, (long)old_hw_ptr);
		return 0;
	}
392
393

	/* Do jiffies check only in xrun_debug mode */
394
	if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
395
396
		goto no_jiffies_check;

397
398
399
400
401
402
	/* Skip the jiffies check for hardwares with BATCH flag.
	 * Such hardware usually just increases the position at each IRQ,
	 * thus it can't give any strange position.
	 */
	if (runtime->hw.info & SNDRV_PCM_INFO_BATCH)
		goto no_jiffies_check;
403
	hdelta = delta;
404
405
406
	if (hdelta < runtime->delay)
		goto no_jiffies_check;
	hdelta -= runtime->delay;
407
408
409
410
411
	jdelta = jiffies - runtime->hw_ptr_jiffies;
	if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
		delta = jdelta /
			(((runtime->period_size * HZ) / runtime->rate)
								+ HZ/100);
412
413
		/* move new_hw_ptr according jiffies not pos variable */
		new_hw_ptr = old_hw_ptr;
414
		hw_base = delta;
415
416
417
418
419
420
421
422
423
		/* use loop to avoid checks for delta overflows */
		/* the delta value is small or zero in most cases */
		while (delta > 0) {
			new_hw_ptr += runtime->period_size;
			if (new_hw_ptr >= runtime->boundary)
				new_hw_ptr -= runtime->boundary;
			delta--;
		}
		/* align hw_base to buffer_size */
424
		hw_ptr_error(substream,
425
			     "hw_ptr skipping! %s"
426
			     "(pos=%ld, delta=%ld, period=%ld, "
427
428
			     "jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
			     in_interrupt ? "[Q] " : "",
429
430
			     (long)pos, (long)hdelta,
			     (long)runtime->period_size, jdelta,
431
			     ((hdelta * HZ) / runtime->rate), hw_base,
432
433
			     (unsigned long)old_hw_ptr,
			     (unsigned long)new_hw_ptr);
434
435
436
		/* reset values to proper state */
		delta = 0;
		hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
437
	}
438
 no_jiffies_check:
439
	if (delta > runtime->period_size + runtime->period_size / 2) {
Takashi Iwai's avatar
Takashi Iwai committed
440
		hw_ptr_error(substream,
441
442
443
444
			     "Lost interrupts? %s"
			     "(stream=%i, delta=%ld, new_hw_ptr=%ld, "
			     "old_hw_ptr=%ld)\n",
			     in_interrupt ? "[Q] " : "",
Takashi Iwai's avatar
Takashi Iwai committed
445
			     substream->stream, (long)delta,
446
447
			     (long)new_hw_ptr,
			     (long)old_hw_ptr);
Takashi Iwai's avatar
Takashi Iwai committed
448
	}
449

450
 no_delta_check:
451
452
	if (runtime->status->hw_ptr == new_hw_ptr)
		return 0;
453

Linus Torvalds's avatar
Linus Torvalds committed
454
455
456
457
	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
	    runtime->silence_size > 0)
		snd_pcm_playback_silence(substream, new_hw_ptr);

458
	if (in_interrupt) {
459
460
461
462
463
464
465
		delta = new_hw_ptr - runtime->hw_ptr_interrupt;
		if (delta < 0)
			delta += runtime->boundary;
		delta -= (snd_pcm_uframes_t)delta % runtime->period_size;
		runtime->hw_ptr_interrupt += delta;
		if (runtime->hw_ptr_interrupt >= runtime->boundary)
			runtime->hw_ptr_interrupt -= runtime->boundary;
466
	}
Takashi Iwai's avatar
Takashi Iwai committed
467
	runtime->hw_ptr_base = hw_base;
Linus Torvalds's avatar
Linus Torvalds committed
468
	runtime->status->hw_ptr = new_hw_ptr;
469
	runtime->hw_ptr_jiffies = jiffies;
470
471
	if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE)
		snd_pcm_gettime(runtime, (struct timespec *)&runtime->status->tstamp);
Linus Torvalds's avatar
Linus Torvalds committed
472

473
	return snd_pcm_update_state(substream, runtime);
Linus Torvalds's avatar
Linus Torvalds committed
474
475
476
}

/* CAUTION: call it with irq disabled */
477
int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
478
{
479
	return snd_pcm_update_hw_ptr0(substream, 0);
Linus Torvalds's avatar
Linus Torvalds committed
480
481
482
483
484
485
486
487
488
489
}

/**
 * snd_pcm_set_ops - set the PCM operators
 * @pcm: the pcm instance
 * @direction: stream direction, SNDRV_PCM_STREAM_XXX
 * @ops: the operator table
 *
 * Sets the given PCM operators to the pcm instance.
 */
490
void snd_pcm_set_ops(struct snd_pcm *pcm, int direction, struct snd_pcm_ops *ops)
Linus Torvalds's avatar
Linus Torvalds committed
491
{
492
493
	struct snd_pcm_str *stream = &pcm->streams[direction];
	struct snd_pcm_substream *substream;
Linus Torvalds's avatar
Linus Torvalds committed
494
495
496
497
498
	
	for (substream = stream->substream; substream != NULL; substream = substream->next)
		substream->ops = ops;
}

499
EXPORT_SYMBOL(snd_pcm_set_ops);
Linus Torvalds's avatar
Linus Torvalds committed
500
501
502
503
504
505
506

/**
 * snd_pcm_sync - set the PCM sync id
 * @substream: the pcm substream
 *
 * Sets the PCM sync identifier for the card.
 */
507
void snd_pcm_set_sync(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
508
{
509
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
510
511
512
513
514
515
516
	
	runtime->sync.id32[0] = substream->pcm->card->number;
	runtime->sync.id32[1] = -1;
	runtime->sync.id32[2] = -1;
	runtime->sync.id32[3] = -1;
}

517
518
EXPORT_SYMBOL(snd_pcm_set_sync);

Linus Torvalds's avatar
Linus Torvalds committed
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
/*
 *  Standard ioctl routine
 */

static inline unsigned int div32(unsigned int a, unsigned int b, 
				 unsigned int *r)
{
	if (b == 0) {
		*r = 0;
		return UINT_MAX;
	}
	*r = a % b;
	return a / b;
}

static inline unsigned int div_down(unsigned int a, unsigned int b)
{
	if (b == 0)
		return UINT_MAX;
	return a / b;
}

static inline unsigned int div_up(unsigned int a, unsigned int b)
{
	unsigned int r;
	unsigned int q;
	if (b == 0)
		return UINT_MAX;
	q = div32(a, b, &r);
	if (r)
		++q;
	return q;
}

static inline unsigned int mul(unsigned int a, unsigned int b)
{
	if (a == 0)
		return 0;
	if (div_down(UINT_MAX, a) < b)
		return UINT_MAX;
	return a * b;
}

static inline unsigned int muldiv32(unsigned int a, unsigned int b,
				    unsigned int c, unsigned int *r)
{
	u_int64_t n = (u_int64_t) a * b;
	if (c == 0) {
567
		snd_BUG_ON(!n);
Linus Torvalds's avatar
Linus Torvalds committed
568
569
570
		*r = 0;
		return UINT_MAX;
	}
571
	n = div_u64_rem(n, c, r);
Linus Torvalds's avatar
Linus Torvalds committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
	if (n >= UINT_MAX) {
		*r = 0;
		return UINT_MAX;
	}
	return n;
}

/**
 * snd_interval_refine - refine the interval value of configurator
 * @i: the interval value to refine
 * @v: the interval value to refer to
 *
 * Refines the interval value with the reference value.
 * The interval is changed to the range satisfying both intervals.
 * The interval status (min, max, integer, etc.) are evaluated.
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
590
int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
Linus Torvalds's avatar
Linus Torvalds committed
591
592
{
	int changed = 0;
593
594
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
	if (i->min < v->min) {
		i->min = v->min;
		i->openmin = v->openmin;
		changed = 1;
	} else if (i->min == v->min && !i->openmin && v->openmin) {
		i->openmin = 1;
		changed = 1;
	}
	if (i->max > v->max) {
		i->max = v->max;
		i->openmax = v->openmax;
		changed = 1;
	} else if (i->max == v->max && !i->openmax && v->openmax) {
		i->openmax = 1;
		changed = 1;
	}
	if (!i->integer && v->integer) {
		i->integer = 1;
		changed = 1;
	}
	if (i->integer) {
		if (i->openmin) {
			i->min++;
			i->openmin = 0;
		}
		if (i->openmax) {
			i->max--;
			i->openmax = 0;
		}
	} else if (!i->openmin && !i->openmax && i->min == i->max)
		i->integer = 1;
	if (snd_interval_checkempty(i)) {
		snd_interval_none(i);
		return -EINVAL;
	}
	return changed;
}

633
634
EXPORT_SYMBOL(snd_interval_refine);

635
static int snd_interval_refine_first(struct snd_interval *i)
Linus Torvalds's avatar
Linus Torvalds committed
636
{
637
638
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
639
640
641
642
643
644
645
646
647
	if (snd_interval_single(i))
		return 0;
	i->max = i->min;
	i->openmax = i->openmin;
	if (i->openmax)
		i->max++;
	return 1;
}

648
static int snd_interval_refine_last(struct snd_interval *i)
Linus Torvalds's avatar
Linus Torvalds committed
649
{
650
651
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
652
653
654
655
656
657
658
659
660
	if (snd_interval_single(i))
		return 0;
	i->min = i->max;
	i->openmin = i->openmax;
	if (i->openmin)
		i->min--;
	return 1;
}

661
void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds's avatar
Linus Torvalds committed
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
{
	if (a->empty || b->empty) {
		snd_interval_none(c);
		return;
	}
	c->empty = 0;
	c->min = mul(a->min, b->min);
	c->openmin = (a->openmin || b->openmin);
	c->max = mul(a->max,  b->max);
	c->openmax = (a->openmax || b->openmax);
	c->integer = (a->integer && b->integer);
}

/**
 * snd_interval_div - refine the interval value with division
Takashi Iwai's avatar
Takashi Iwai committed
677
678
679
 * @a: dividend
 * @b: divisor
 * @c: quotient
Linus Torvalds's avatar
Linus Torvalds committed
680
681
682
683
684
 *
 * c = a / b
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
685
void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds's avatar
Linus Torvalds committed
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
{
	unsigned int r;
	if (a->empty || b->empty) {
		snd_interval_none(c);
		return;
	}
	c->empty = 0;
	c->min = div32(a->min, b->max, &r);
	c->openmin = (r || a->openmin || b->openmax);
	if (b->min > 0) {
		c->max = div32(a->max, b->min, &r);
		if (r) {
			c->max++;
			c->openmax = 1;
		} else
			c->openmax = (a->openmax || b->openmin);
	} else {
		c->max = UINT_MAX;
		c->openmax = 0;
	}
	c->integer = 0;
}

/**
 * snd_interval_muldivk - refine the interval value
Takashi Iwai's avatar
Takashi Iwai committed
711
712
713
714
715
 * @a: dividend 1
 * @b: dividend 2
 * @k: divisor (as integer)
 * @c: result
  *
Linus Torvalds's avatar
Linus Torvalds committed
716
717
718
719
 * c = a * b / k
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
720
721
void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
		      unsigned int k, struct snd_interval *c)
Linus Torvalds's avatar
Linus Torvalds committed
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
{
	unsigned int r;
	if (a->empty || b->empty) {
		snd_interval_none(c);
		return;
	}
	c->empty = 0;
	c->min = muldiv32(a->min, b->min, k, &r);
	c->openmin = (r || a->openmin || b->openmin);
	c->max = muldiv32(a->max, b->max, k, &r);
	if (r) {
		c->max++;
		c->openmax = 1;
	} else
		c->openmax = (a->openmax || b->openmax);
	c->integer = 0;
}

/**
 * snd_interval_mulkdiv - refine the interval value
Takashi Iwai's avatar
Takashi Iwai committed
742
743
744
745
 * @a: dividend 1
 * @k: dividend 2 (as integer)
 * @b: divisor
 * @c: result
Linus Torvalds's avatar
Linus Torvalds committed
746
747
748
749
750
 *
 * c = a * k / b
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
751
752
void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
		      const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds's avatar
Linus Torvalds committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
{
	unsigned int r;
	if (a->empty || b->empty) {
		snd_interval_none(c);
		return;
	}
	c->empty = 0;
	c->min = muldiv32(a->min, k, b->max, &r);
	c->openmin = (r || a->openmin || b->openmax);
	if (b->min > 0) {
		c->max = muldiv32(a->max, k, b->min, &r);
		if (r) {
			c->max++;
			c->openmax = 1;
		} else
			c->openmax = (a->openmax || b->openmin);
	} else {
		c->max = UINT_MAX;
		c->openmax = 0;
	}
	c->integer = 0;
}

/* ---- */


/**
 * snd_interval_ratnum - refine the interval value
Takashi Iwai's avatar
Takashi Iwai committed
781
782
783
784
785
 * @i: interval to refine
 * @rats_count: number of ratnum_t 
 * @rats: ratnum_t array
 * @nump: pointer to store the resultant numerator
 * @denp: pointer to store the resultant denominator
Linus Torvalds's avatar
Linus Torvalds committed
786
787
788
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
789
790
791
int snd_interval_ratnum(struct snd_interval *i,
			unsigned int rats_count, struct snd_ratnum *rats,
			unsigned int *nump, unsigned int *denp)
Linus Torvalds's avatar
Linus Torvalds committed
792
{
793
794
	unsigned int best_num, best_den;
	int best_diff;
Linus Torvalds's avatar
Linus Torvalds committed
795
	unsigned int k;
796
	struct snd_interval t;
Linus Torvalds's avatar
Linus Torvalds committed
797
	int err;
798
799
	unsigned int result_num, result_den;
	int result_diff;
Linus Torvalds's avatar
Linus Torvalds committed
800
801
802
803
804
805
806
807
808

	best_num = best_den = best_diff = 0;
	for (k = 0; k < rats_count; ++k) {
		unsigned int num = rats[k].num;
		unsigned int den;
		unsigned int q = i->min;
		int diff;
		if (q == 0)
			q = 1;
809
		den = div_up(num, q);
Linus Torvalds's avatar
Linus Torvalds committed
810
811
812
813
814
815
816
817
818
819
820
		if (den < rats[k].den_min)
			continue;
		if (den > rats[k].den_max)
			den = rats[k].den_max;
		else {
			unsigned int r;
			r = (den - rats[k].den_min) % rats[k].den_step;
			if (r != 0)
				den -= r;
		}
		diff = num - q * den;
821
822
		if (diff < 0)
			diff = -diff;
Linus Torvalds's avatar
Linus Torvalds committed
823
824
825
826
827
828
829
830
831
832
833
834
835
836
		if (best_num == 0 ||
		    diff * best_den < best_diff * den) {
			best_diff = diff;
			best_den = den;
			best_num = num;
		}
	}
	if (best_den == 0) {
		i->empty = 1;
		return -EINVAL;
	}
	t.min = div_down(best_num, best_den);
	t.openmin = !!(best_num % best_den);
	
837
838
839
	result_num = best_num;
	result_diff = best_diff;
	result_den = best_den;
Linus Torvalds's avatar
Linus Torvalds committed
840
841
842
843
844
845
846
847
848
849
	best_num = best_den = best_diff = 0;
	for (k = 0; k < rats_count; ++k) {
		unsigned int num = rats[k].num;
		unsigned int den;
		unsigned int q = i->max;
		int diff;
		if (q == 0) {
			i->empty = 1;
			return -EINVAL;
		}
850
		den = div_down(num, q);
Linus Torvalds's avatar
Linus Torvalds committed
851
852
853
854
855
856
857
858
859
860
861
		if (den > rats[k].den_max)
			continue;
		if (den < rats[k].den_min)
			den = rats[k].den_min;
		else {
			unsigned int r;
			r = (den - rats[k].den_min) % rats[k].den_step;
			if (r != 0)
				den += rats[k].den_step - r;
		}
		diff = q * den - num;
862
863
		if (diff < 0)
			diff = -diff;
Linus Torvalds's avatar
Linus Torvalds committed
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
		if (best_num == 0 ||
		    diff * best_den < best_diff * den) {
			best_diff = diff;
			best_den = den;
			best_num = num;
		}
	}
	if (best_den == 0) {
		i->empty = 1;
		return -EINVAL;
	}
	t.max = div_up(best_num, best_den);
	t.openmax = !!(best_num % best_den);
	t.integer = 0;
	err = snd_interval_refine(i, &t);
	if (err < 0)
		return err;

	if (snd_interval_single(i)) {
883
884
885
886
		if (best_diff * result_den < result_diff * best_den) {
			result_num = best_num;
			result_den = best_den;
		}
Linus Torvalds's avatar
Linus Torvalds committed
887
		if (nump)
888
			*nump = result_num;
Linus Torvalds's avatar
Linus Torvalds committed
889
		if (denp)
890
			*denp = result_den;
Linus Torvalds's avatar
Linus Torvalds committed
891
892
893
894
	}
	return err;
}

895
896
EXPORT_SYMBOL(snd_interval_ratnum);

Linus Torvalds's avatar
Linus Torvalds committed
897
898
/**
 * snd_interval_ratden - refine the interval value
Takashi Iwai's avatar
Takashi Iwai committed
899
 * @i: interval to refine
900
901
 * @rats_count: number of struct ratden
 * @rats: struct ratden array
Takashi Iwai's avatar
Takashi Iwai committed
902
903
 * @nump: pointer to store the resultant numerator
 * @denp: pointer to store the resultant denominator
Linus Torvalds's avatar
Linus Torvalds committed
904
905
906
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
907
908
static int snd_interval_ratden(struct snd_interval *i,
			       unsigned int rats_count, struct snd_ratden *rats,
Linus Torvalds's avatar
Linus Torvalds committed
909
910
911
912
			       unsigned int *nump, unsigned int *denp)
{
	unsigned int best_num, best_diff, best_den;
	unsigned int k;
913
	struct snd_interval t;
Linus Torvalds's avatar
Linus Torvalds committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
	int err;

	best_num = best_den = best_diff = 0;
	for (k = 0; k < rats_count; ++k) {
		unsigned int num;
		unsigned int den = rats[k].den;
		unsigned int q = i->min;
		int diff;
		num = mul(q, den);
		if (num > rats[k].num_max)
			continue;
		if (num < rats[k].num_min)
			num = rats[k].num_max;
		else {
			unsigned int r;
			r = (num - rats[k].num_min) % rats[k].num_step;
			if (r != 0)
				num += rats[k].num_step - r;
		}
		diff = num - q * den;
		if (best_num == 0 ||
		    diff * best_den < best_diff * den) {
			best_diff = diff;
			best_den = den;
			best_num = num;
		}
	}
	if (best_den == 0) {
		i->empty = 1;
		return -EINVAL;
	}
	t.min = div_down(best_num, best_den);
	t.openmin = !!(best_num % best_den);
	
	best_num = best_den = best_diff = 0;
	for (k = 0; k < rats_count; ++k) {
		unsigned int num;
		unsigned int den = rats[k].den;
		unsigned int q = i->max;
		int diff;
		num = mul(q, den);
		if (num < rats[k].num_min)
			continue;
		if (num > rats[k].num_max)
			num = rats[k].num_max;
		else {
			unsigned int r;
			r = (num - rats[k].num_min) % rats[k].num_step;
			if (r != 0)
				num -= r;
		}
		diff = q * den - num;
		if (best_num == 0 ||
		    diff * best_den < best_diff * den) {
			best_diff = diff;
			best_den = den;
			best_num = num;
		}
	}
	if (best_den == 0) {
		i->empty = 1;
		return -EINVAL;
	}
	t.max = div_up(best_num, best_den);
	t.openmax = !!(best_num % best_den);
	t.integer = 0;
	err = snd_interval_refine(i, &t);
	if (err < 0)
		return err;

	if (snd_interval_single(i)) {
		if (nump)
			*nump = best_num;
		if (denp)
			*denp = best_den;
	}
	return err;
}

/**
 * snd_interval_list - refine the interval value from the list
 * @i: the interval value to refine
 * @count: the number of elements in the list
 * @list: the value list
 * @mask: the bit-mask to evaluate
 *
 * Refines the interval value from the list.