pcm_lib.c 67.1 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds's avatar
Linus Torvalds committed
2
3
/*
 *  Digital Audio (PCM) abstract layer
4
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds's avatar
Linus Torvalds committed
5
6
7
8
 *                   Abramo Bagnara <abramo@alsa-project.org>
 */

#include <linux/slab.h>
9
#include <linux/sched/signal.h>
Linus Torvalds's avatar
Linus Torvalds committed
10
#include <linux/time.h>
11
#include <linux/math64.h>
12
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
13
14
#include <sound/core.h>
#include <sound/control.h>
15
#include <sound/tlv.h>
Linus Torvalds's avatar
Linus Torvalds committed
16
17
18
19
20
#include <sound/info.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/timer.h>

21
22
#include "pcm_local.h"

23
24
25
26
27
28
29
#ifdef CONFIG_SND_PCM_XRUN_DEBUG
#define CREATE_TRACE_POINTS
#include "pcm_trace.h"
#else
#define trace_hwptr(substream, pos, in_interrupt)
#define trace_xrun(substream)
#define trace_hw_ptr_error(substream, reason)
30
#define trace_applptr(substream, prev, curr)
31
32
#endif

33
34
35
static int fill_silence_frames(struct snd_pcm_substream *substream,
			       snd_pcm_uframes_t off, snd_pcm_uframes_t frames);

Linus Torvalds's avatar
Linus Torvalds committed
36
37
38
39
40
41
42
43
44
/*
 * 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
 */
45
void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
Linus Torvalds's avatar
Linus Torvalds committed
46
{
47
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
48
	snd_pcm_uframes_t frames, ofs, transfer;
49
	int err;
Linus Torvalds's avatar
Linus Torvalds committed
50
51
52

	if (runtime->silence_size < runtime->boundary) {
		snd_pcm_sframes_t noise_dist, n;
53
54
55
		snd_pcm_uframes_t appl_ptr = READ_ONCE(runtime->control->appl_ptr);
		if (runtime->silence_start != appl_ptr) {
			n = appl_ptr - runtime->silence_start;
Linus Torvalds's avatar
Linus Torvalds committed
56
57
58
59
60
61
			if (n < 0)
				n += runtime->boundary;
			if ((snd_pcm_uframes_t)n < runtime->silence_filled)
				runtime->silence_filled -= n;
			else
				runtime->silence_filled = 0;
62
			runtime->silence_start = appl_ptr;
Linus Torvalds's avatar
Linus Torvalds committed
63
		}
Takashi Iwai's avatar
Takashi Iwai committed
64
		if (runtime->silence_filled >= runtime->buffer_size)
Linus Torvalds's avatar
Linus Torvalds committed
65
66
67
68
69
70
71
72
73
74
			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);
75
76
			if (avail > runtime->buffer_size)
				avail = runtime->buffer_size;
Linus Torvalds's avatar
Linus Torvalds committed
77
78
79
80
81
82
83
84
85
86
87
88
			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;
89
				runtime->silence_start = new_hw_ptr;
Linus Torvalds's avatar
Linus Torvalds committed
90
			} else {
91
				runtime->silence_start = ofs;
Linus Torvalds's avatar
Linus Torvalds committed
92
93
94
95
			}
		}
		frames = runtime->buffer_size - runtime->silence_filled;
	}
96
97
	if (snd_BUG_ON(frames > runtime->buffer_size))
		return;
Linus Torvalds's avatar
Linus Torvalds committed
98
99
	if (frames == 0)
		return;
100
	ofs = runtime->silence_start % runtime->buffer_size;
Linus Torvalds's avatar
Linus Torvalds committed
101
102
	while (frames > 0) {
		transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
103
104
		err = fill_silence_frames(substream, ofs, transfer);
		snd_BUG_ON(err < 0);
Linus Torvalds's avatar
Linus Torvalds committed
105
106
107
108
109
110
		runtime->silence_filled += transfer;
		frames -= transfer;
		ofs = 0;
	}
}

111
112
#ifdef CONFIG_SND_DEBUG
void snd_pcm_debug_name(struct snd_pcm_substream *substream,
113
114
115
116
117
118
119
120
			   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);
}
121
122
EXPORT_SYMBOL(snd_pcm_debug_name);
#endif
123

124
125
126
127
#define XRUN_DEBUG_BASIC	(1<<0)
#define XRUN_DEBUG_STACK	(1<<1)	/* dump also stack */
#define XRUN_DEBUG_JIFFIESCHECK	(1<<2)	/* do jiffies check */

Takashi Iwai's avatar
Takashi Iwai committed
128
#ifdef CONFIG_SND_PCM_XRUN_DEBUG
129

130
131
#define xrun_debug(substream, mask) \
			((substream)->pstr->xrun_debug & (mask))
132
133
134
#else
#define xrun_debug(substream, mask)	0
#endif
Takashi Iwai's avatar
Takashi Iwai committed
135

136
137
138
#define dump_stack_on_xrun(substream) do {			\
		if (xrun_debug(substream, XRUN_DEBUG_STACK))	\
			dump_stack();				\
Takashi Iwai's avatar
Takashi Iwai committed
139
140
	} while (0)

141
142
/* call with stream lock held */
void __snd_pcm_xrun(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
143
{
144
145
	struct snd_pcm_runtime *runtime = substream->runtime;

146
	trace_xrun(substream);
147
148
149
150
151
152
	if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
		struct timespec64 tstamp;

		snd_pcm_gettime(runtime, &tstamp);
		runtime->status->tstamp = timespec64_to_timespec(tstamp);
	}
Linus Torvalds's avatar
Linus Torvalds committed
153
	snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
154
	if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
155
		char name[16];
156
		snd_pcm_debug_name(substream, name, sizeof(name));
157
		pcm_warn(substream->pcm, "XRUN: %s\n", name);
Takashi Iwai's avatar
Takashi Iwai committed
158
		dump_stack_on_xrun(substream);
Linus Torvalds's avatar
Linus Torvalds committed
159
160
161
	}
}

162
#ifdef CONFIG_SND_PCM_XRUN_DEBUG
163
#define hw_ptr_error(substream, in_interrupt, reason, fmt, args...)	\
164
	do {								\
165
		trace_hw_ptr_error(substream, reason);	\
166
		if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {		\
167
168
			pr_err_ratelimited("ALSA: PCM: [%c] " reason ": " fmt, \
					   (in_interrupt) ? 'Q' : 'P', ##args);	\
169
170
171
172
173
174
175
176
177
178
			dump_stack_on_xrun(substream);			\
		}							\
	} while (0)

#else /* ! CONFIG_SND_PCM_XRUN_DEBUG */

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

#endif

179
180
int snd_pcm_update_state(struct snd_pcm_substream *substream,
			 struct snd_pcm_runtime *runtime)
Linus Torvalds's avatar
Linus Torvalds committed
181
182
183
{
	snd_pcm_uframes_t avail;

184
	avail = snd_pcm_avail(substream);
Linus Torvalds's avatar
Linus Torvalds committed
185
186
	if (avail > runtime->avail_max)
		runtime->avail_max = avail;
187
188
	if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
		if (avail >= runtime->buffer_size) {
Linus Torvalds's avatar
Linus Torvalds committed
189
			snd_pcm_drain_done(substream);
190
191
192
193
			return -EPIPE;
		}
	} else {
		if (avail >= runtime->stop_threshold) {
194
			__snd_pcm_xrun(substream);
195
196
			return -EPIPE;
		}
Linus Torvalds's avatar
Linus Torvalds committed
197
	}
198
199
200
201
202
	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
203
204
205
	return 0;
}

206
static void update_audio_tstamp(struct snd_pcm_substream *substream,
207
208
				struct timespec64 *curr_tstamp,
				struct timespec64 *audio_tstamp)
209
210
211
{
	struct snd_pcm_runtime *runtime = substream->runtime;
	u64 audio_frames, audio_nsecs;
212
	struct timespec64 driver_tstamp;
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235

	if (runtime->tstamp_mode != SNDRV_PCM_TSTAMP_ENABLE)
		return;

	if (!(substream->ops->get_time_info) ||
		(runtime->audio_tstamp_report.actual_type ==
			SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {

		/*
		 * provide audio timestamp derived from pointer position
		 * add delay only if requested
		 */

		audio_frames = runtime->hw_ptr_wrap + runtime->status->hw_ptr;

		if (runtime->audio_tstamp_config.report_delay) {
			if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
				audio_frames -=  runtime->delay;
			else
				audio_frames +=  runtime->delay;
		}
		audio_nsecs = div_u64(audio_frames * 1000000000LL,
				runtime->rate);
236
		*audio_tstamp = ns_to_timespec64(audio_nsecs);
237
	}
238
239
240
241
242
243

	if (runtime->status->audio_tstamp.tv_sec != audio_tstamp->tv_sec ||
	    runtime->status->audio_tstamp.tv_nsec != audio_tstamp->tv_nsec) {
		runtime->status->audio_tstamp =
			timespec64_to_timespec(*audio_tstamp);
		runtime->status->tstamp = timespec64_to_timespec(*curr_tstamp);
244
	}
245

246

247
248
249
250
	/*
	 * re-take a driver timestamp to let apps detect if the reference tstamp
	 * read by low-level hardware was provided with a delay
	 */
251
	snd_pcm_gettime(substream->runtime, &driver_tstamp);
252
253
254
	runtime->driver_tstamp = driver_tstamp;
}

255
256
static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
				  unsigned int in_interrupt)
Linus Torvalds's avatar
Linus Torvalds committed
257
{
258
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
259
	snd_pcm_uframes_t pos;
260
	snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
261
262
	snd_pcm_sframes_t hdelta, delta;
	unsigned long jdelta;
263
	unsigned long curr_jiffies;
264
265
	struct timespec64 curr_tstamp;
	struct timespec64 audio_tstamp;
266
	int crossed_boundary = 0;
Linus Torvalds's avatar
Linus Torvalds committed
267

268
	old_hw_ptr = runtime->status->hw_ptr;
269
270
271
272
273
274
275

	/*
	 * group pointer, time and jiffies reads to allow for more
	 * accurate correlations/corrections.
	 * The values are stored at the end of this routine after
	 * corrections for hw_ptr position
	 */
276
	pos = substream->ops->pointer(substream);
277
	curr_jiffies = jiffies;
278
	if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
279
280
281
282
283
284
285
286
287
		if ((substream->ops->get_time_info) &&
			(runtime->audio_tstamp_config.type_requested != SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
			substream->ops->get_time_info(substream, &curr_tstamp,
						&audio_tstamp,
						&runtime->audio_tstamp_config,
						&runtime->audio_tstamp_report);

			/* re-test in case tstamp type is not supported in hardware and was demoted to DEFAULT */
			if (runtime->audio_tstamp_report.actual_type == SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)
288
				snd_pcm_gettime(runtime, &curr_tstamp);
289
		} else
290
			snd_pcm_gettime(runtime, &curr_tstamp);
291
292
	}

Linus Torvalds's avatar
Linus Torvalds committed
293
	if (pos == SNDRV_PCM_POS_XRUN) {
294
		__snd_pcm_xrun(substream);
Linus Torvalds's avatar
Linus Torvalds committed
295
296
		return -EPIPE;
	}
297
	if (pos >= runtime->buffer_size) {
298
		if (printk_ratelimit()) {
299
			char name[16];
300
			snd_pcm_debug_name(substream, name, sizeof(name));
301
			pcm_err(substream->pcm,
302
				"invalid position: %s, pos = %ld, buffer size = %ld, period size = %ld\n",
303
304
				name, pos, runtime->buffer_size,
				runtime->period_size);
305
306
		}
		pos = 0;
307
	}
308
	pos -= pos % runtime->min_align;
309
	trace_hwptr(substream, pos, in_interrupt);
Takashi Iwai's avatar
Takashi Iwai committed
310
311
	hw_base = runtime->hw_ptr_base;
	new_hw_ptr = hw_base + pos;
312
313
314
	if (in_interrupt) {
		/* we know that one period was processed */
		/* delta = "expected next hw_ptr" for in_interrupt != 0 */
315
		delta = runtime->hw_ptr_interrupt + runtime->period_size;
316
		if (delta > new_hw_ptr) {
317
			/* check for double acknowledged interrupts */
318
			hdelta = curr_jiffies - runtime->hw_ptr_jiffies;
319
			if (hdelta > runtime->hw_ptr_buffer_jiffies/2 + 1) {
320
				hw_base += runtime->buffer_size;
321
				if (hw_base >= runtime->boundary) {
322
					hw_base = 0;
323
324
					crossed_boundary++;
				}
325
326
327
				new_hw_ptr = hw_base + pos;
				goto __delta;
			}
Linus Torvalds's avatar
Linus Torvalds committed
328
329
		}
	}
330
331
332
333
	/* 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;
334
		if (hw_base >= runtime->boundary) {
335
			hw_base = 0;
336
337
			crossed_boundary++;
		}
338
339
340
		new_hw_ptr = hw_base + pos;
	}
      __delta:
341
342
343
	delta = new_hw_ptr - old_hw_ptr;
	if (delta < 0)
		delta += runtime->boundary;
344

345
	if (runtime->no_period_wakeup) {
346
		snd_pcm_sframes_t xrun_threshold;
347
348
349
350
		/*
		 * Without regular period interrupts, we have to check
		 * the elapsed time to detect xruns.
		 */
351
		jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
352
353
		if (jdelta < runtime->hw_ptr_buffer_jiffies / 2)
			goto no_delta_check;
354
		hdelta = jdelta - delta * HZ / runtime->rate;
355
356
		xrun_threshold = runtime->hw_ptr_buffer_jiffies / 2 + 1;
		while (hdelta > xrun_threshold) {
357
358
			delta += runtime->buffer_size;
			hw_base += runtime->buffer_size;
359
			if (hw_base >= runtime->boundary) {
360
				hw_base = 0;
361
362
				crossed_boundary++;
			}
363
364
365
			new_hw_ptr = hw_base + pos;
			hdelta -= runtime->hw_ptr_buffer_jiffies;
		}
366
		goto no_delta_check;
367
	}
368

369
	/* something must be really wrong */
370
	if (delta >= runtime->buffer_size + runtime->period_size) {
371
372
373
374
		hw_ptr_error(substream, in_interrupt, "Unexpected hw_ptr",
			     "(stream=%i, pos=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
			     substream->stream, (long)pos,
			     (long)new_hw_ptr, (long)old_hw_ptr);
375
376
		return 0;
	}
377
378

	/* Do jiffies check only in xrun_debug mode */
379
	if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
380
381
		goto no_jiffies_check;

382
383
384
385
386
387
	/* 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;
388
	hdelta = delta;
389
390
391
	if (hdelta < runtime->delay)
		goto no_jiffies_check;
	hdelta -= runtime->delay;
392
	jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
393
394
395
396
	if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
		delta = jdelta /
			(((runtime->period_size * HZ) / runtime->rate)
								+ HZ/100);
397
398
		/* move new_hw_ptr according jiffies not pos variable */
		new_hw_ptr = old_hw_ptr;
399
		hw_base = delta;
400
401
402
403
		/* 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;
404
			if (new_hw_ptr >= runtime->boundary) {
405
				new_hw_ptr -= runtime->boundary;
406
407
				crossed_boundary--;
			}
408
409
410
			delta--;
		}
		/* align hw_base to buffer_size */
411
412
		hw_ptr_error(substream, in_interrupt, "hw_ptr skipping",
			     "(pos=%ld, delta=%ld, period=%ld, jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
413
414
			     (long)pos, (long)hdelta,
			     (long)runtime->period_size, jdelta,
415
			     ((hdelta * HZ) / runtime->rate), hw_base,
416
417
			     (unsigned long)old_hw_ptr,
			     (unsigned long)new_hw_ptr);
418
419
420
		/* reset values to proper state */
		delta = 0;
		hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
421
	}
422
 no_jiffies_check:
423
	if (delta > runtime->period_size + runtime->period_size / 2) {
424
425
426
		hw_ptr_error(substream, in_interrupt,
			     "Lost interrupts?",
			     "(stream=%i, delta=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
Takashi Iwai's avatar
Takashi Iwai committed
427
			     substream->stream, (long)delta,
428
429
			     (long)new_hw_ptr,
			     (long)old_hw_ptr);
Takashi Iwai's avatar
Takashi Iwai committed
430
	}
431

432
 no_delta_check:
433
434
	if (runtime->status->hw_ptr == new_hw_ptr) {
		update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
435
		return 0;
436
	}
437

Linus Torvalds's avatar
Linus Torvalds committed
438
439
440
441
	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
	    runtime->silence_size > 0)
		snd_pcm_playback_silence(substream, new_hw_ptr);

442
	if (in_interrupt) {
443
444
445
446
447
448
449
		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;
450
	}
Takashi Iwai's avatar
Takashi Iwai committed
451
	runtime->hw_ptr_base = hw_base;
Linus Torvalds's avatar
Linus Torvalds committed
452
	runtime->status->hw_ptr = new_hw_ptr;
453
	runtime->hw_ptr_jiffies = curr_jiffies;
454
455
456
457
	if (crossed_boundary) {
		snd_BUG_ON(crossed_boundary != 1);
		runtime->hw_ptr_wrap += runtime->boundary;
	}
458

459
	update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
460

461
	return snd_pcm_update_state(substream, runtime);
Linus Torvalds's avatar
Linus Torvalds committed
462
463
464
}

/* CAUTION: call it with irq disabled */
465
int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
466
{
467
	return snd_pcm_update_hw_ptr0(substream, 0);
Linus Torvalds's avatar
Linus Torvalds committed
468
469
470
471
472
473
474
475
476
477
}

/**
 * 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.
 */
478
479
void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
		     const struct snd_pcm_ops *ops)
Linus Torvalds's avatar
Linus Torvalds committed
480
{
481
482
	struct snd_pcm_str *stream = &pcm->streams[direction];
	struct snd_pcm_substream *substream;
Linus Torvalds's avatar
Linus Torvalds committed
483
484
485
486
	
	for (substream = stream->substream; substream != NULL; substream = substream->next)
		substream->ops = ops;
}
487
EXPORT_SYMBOL(snd_pcm_set_ops);
Linus Torvalds's avatar
Linus Torvalds committed
488
489
490
491
492
493
494

/**
 * snd_pcm_sync - set the PCM sync id
 * @substream: the pcm substream
 *
 * Sets the PCM sync identifier for the card.
 */
495
void snd_pcm_set_sync(struct snd_pcm_substream *substream)
Linus Torvalds's avatar
Linus Torvalds committed
496
{
497
	struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds's avatar
Linus Torvalds committed
498
499
500
501
502
503
	
	runtime->sync.id32[0] = substream->pcm->card->number;
	runtime->sync.id32[1] = -1;
	runtime->sync.id32[2] = -1;
	runtime->sync.id32[3] = -1;
}
504
505
EXPORT_SYMBOL(snd_pcm_set_sync);

Linus Torvalds's avatar
Linus Torvalds committed
506
507
508
509
510
511
512
513
514
515
516
517
518
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
/*
 *  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) {
		*r = 0;
		return UINT_MAX;
	}
557
	n = div_u64_rem(n, c, r);
Linus Torvalds's avatar
Linus Torvalds committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
	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.
 *
574
575
 * Return: Positive if the value is changed, zero if it's not changed, or a
 * negative error code.
Linus Torvalds's avatar
Linus Torvalds committed
576
 */
577
int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
Linus Torvalds's avatar
Linus Torvalds committed
578
579
{
	int changed = 0;
580
581
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
	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;
}
619
620
EXPORT_SYMBOL(snd_interval_refine);

621
static int snd_interval_refine_first(struct snd_interval *i)
Linus Torvalds's avatar
Linus Torvalds committed
622
{
623
624
	const unsigned int last_max = i->max;

625
626
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
627
628
629
	if (snd_interval_single(i))
		return 0;
	i->max = i->min;
630
	if (i->openmin)
Linus Torvalds's avatar
Linus Torvalds committed
631
		i->max++;
632
633
	/* only exclude max value if also excluded before refine */
	i->openmax = (i->openmax && i->max >= last_max);
Linus Torvalds's avatar
Linus Torvalds committed
634
635
636
	return 1;
}

637
static int snd_interval_refine_last(struct snd_interval *i)
Linus Torvalds's avatar
Linus Torvalds committed
638
{
639
640
	const unsigned int last_min = i->min;

641
642
	if (snd_BUG_ON(snd_interval_empty(i)))
		return -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
643
644
645
	if (snd_interval_single(i))
		return 0;
	i->min = i->max;
646
	if (i->openmax)
Linus Torvalds's avatar
Linus Torvalds committed
647
		i->min--;
648
649
	/* only exclude min value if also excluded before refine */
	i->openmin = (i->openmin && i->min <= last_min);
Linus Torvalds's avatar
Linus Torvalds committed
650
651
652
	return 1;
}

653
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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
{
	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
669
670
671
 * @a: dividend
 * @b: divisor
 * @c: quotient
Linus Torvalds's avatar
Linus Torvalds committed
672
673
674
675
676
 *
 * c = a / b
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
677
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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
{
	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
703
704
705
706
707
 * @a: dividend 1
 * @b: dividend 2
 * @k: divisor (as integer)
 * @c: result
  *
Linus Torvalds's avatar
Linus Torvalds committed
708
709
710
711
 * c = a * b / k
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
712
713
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
{
	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
734
735
736
737
 * @a: dividend 1
 * @k: dividend 2 (as integer)
 * @b: divisor
 * @c: result
Linus Torvalds's avatar
Linus Torvalds committed
738
739
740
741
742
 *
 * c = a * k / b
 *
 * Returns non-zero if the value is changed, zero if not changed.
 */
743
744
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
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
{
	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
773
774
775
776
777
 * @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
778
 *
779
780
 * Return: Positive if the value is changed, zero if it's not changed, or a
 * negative error code.
Linus Torvalds's avatar
Linus Torvalds committed
781
 */
782
int snd_interval_ratnum(struct snd_interval *i,
783
			unsigned int rats_count, const struct snd_ratnum *rats,
784
			unsigned int *nump, unsigned int *denp)
Linus Torvalds's avatar
Linus Torvalds committed
785
{
786
787
	unsigned int best_num, best_den;
	int best_diff;
Linus Torvalds's avatar
Linus Torvalds committed
788
	unsigned int k;
789
	struct snd_interval t;
Linus Torvalds's avatar
Linus Torvalds committed
790
	int err;
791
792
	unsigned int result_num, result_den;
	int result_diff;
Linus Torvalds's avatar
Linus Torvalds committed
793
794
795
796
797
798
799
800
801

	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;
802
		den = div_up(num, q);
Linus Torvalds's avatar
Linus Torvalds committed
803
804
805
806
807
808
809
810
811
812
813
		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;
814
815
		if (diff < 0)
			diff = -diff;
Linus Torvalds's avatar
Linus Torvalds committed
816
817
818
819
820
821
822
823
824
825
826
827
828
829
		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);
	
830
831
832
	result_num = best_num;
	result_diff = best_diff;
	result_den = best_den;
Linus Torvalds's avatar
Linus Torvalds committed
833
834
835
836
837
838
839
840
841
842
	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;
		}
843
		den = div_down(num, q);
Linus Torvalds's avatar
Linus Torvalds committed
844
845
846
847
848
849
850
851
852
853
854
		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;
855
856
		if (diff < 0)
			diff = -diff;
Linus Torvalds's avatar
Linus Torvalds committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
		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)) {
876
877
878
879
		if (best_diff * result_den < result_diff * best_den) {
			result_num = best_num;
			result_den = best_den;
		}
Linus Torvalds's avatar
Linus Torvalds committed
880
		if (nump)
881
			*nump = result_num;
Linus Torvalds's avatar
Linus Torvalds committed
882
		if (denp)
883
			*denp = result_den;
Linus Torvalds's avatar
Linus Torvalds committed
884
885
886
	}
	return err;
}
887
888
EXPORT_SYMBOL(snd_interval_ratnum);

Linus Torvalds's avatar
Linus Torvalds committed
889
890
/**
 * snd_interval_ratden - refine the interval value
Takashi Iwai's avatar
Takashi Iwai committed
891
 * @i: interval to refine
892
893
 * @rats_count: number of struct ratden
 * @rats: struct ratden array
Takashi Iwai's avatar
Takashi Iwai committed
894
895
 * @nump: pointer to store the resultant numerator
 * @denp: pointer to store the resultant denominator
Linus Torvalds's avatar
Linus Torvalds committed
896
 *
897
898
 * Return: Positive if the value is changed, zero if it's not changed, or a
 * negative error code.
Linus Torvalds's avatar
Linus Torvalds committed
899
 */
900
static int snd_interval_ratden(struct snd_interval *i,
901
902
			       unsigned int rats_count,
			       const struct snd_ratden *rats,
Linus Torvalds's avatar
Linus Torvalds committed
903
904
905
906
			       unsigned int *nump, unsigned int *denp)
{
	unsigned int best_num, best_diff, best_den;
	unsigned int k;
907
	struct snd_interval t;
Linus Torvalds's avatar
Linus Torvalds committed
908
909
910
911
912
913
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
	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.
 * When mask is non-zero, only the elements corresponding to bit 1 are
 * evaluated.
 *
998
999
 * Return: Positive if the value is changed, zero if it's not changed, or a
 * negative error code.
Linus Torvalds's avatar
Linus Torvalds committed
1000
 */