blob: 9c121a921b04a6f31930bae6520b81bdefdb62b3 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * Digital Audio (PCM) abstract layer
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02004 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Abramo Bagnara <abramo@alsa-project.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 */
7
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/slab.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +01009#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/time.h>
Takashi Iwai3f7440a2009-06-05 17:40:04 +020011#include <linux/math64.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040012#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <sound/core.h>
14#include <sound/control.h>
Takashi Iwai2d3391e2012-07-27 18:27:00 +020015#include <sound/tlv.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <sound/info.h>
17#include <sound/pcm.h>
18#include <sound/pcm_params.h>
19#include <sound/timer.h>
20
Takashi Sakamoto2c4842d2017-05-26 09:30:46 +090021#include "pcm_local.h"
22
Takashi Iwaif5914902014-11-04 12:45:59 +010023#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)
Takashi Sakamotofccf5382017-06-12 09:41:45 +090030#define trace_applptr(substream, prev, curr)
Takashi Iwaif5914902014-11-04 12:45:59 +010031#endif
32
Takashi Iwaia9cd29e2017-05-24 18:18:15 +020033static int fill_silence_frames(struct snd_pcm_substream *substream,
34 snd_pcm_uframes_t off, snd_pcm_uframes_t frames);
35
Jaroslav Kysela6d8d56d2023-05-05 17:52:42 +020036
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
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 */
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +020064void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
Takashi Iwai877211f2005-11-17 13:59:38 +010066 struct snd_pcm_runtime *runtime = substream->runtime;
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +020067 snd_pcm_uframes_t frames, ofs, transfer;
Takashi Iwai29d1a872017-05-10 20:02:35 +020068 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 if (runtime->silence_size < runtime->boundary) {
Jaroslav Kysela6d8d56d2023-05-05 17:52:42 +020071 snd_pcm_sframes_t noise_dist;
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +020072 snd_pcm_uframes_t appl_ptr = READ_ONCE(runtime->control->appl_ptr);
Jaroslav Kysela6d8d56d2023-05-05 17:52:42 +020073 update_silence_vars(runtime, runtime->silence_start, appl_ptr);
Jaroslav Kysela2fbaa442023-05-05 17:52:39 +020074 /* 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;
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +020083 if (noise_dist >= (snd_pcm_sframes_t) runtime->silence_threshold)
84 return;
85 frames = runtime->silence_threshold - noise_dist;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 if (frames > runtime->silence_size)
87 frames = runtime->silence_size;
88 } else {
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +020089 /*
90 * This filling mode aims at free-running mode (used for example by dmix),
91 * which doesn't update the application pointer.
92 */
Oswald Buddenhagen6ffa6f32023-05-05 17:52:43 +020093 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;
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +0200111 } else {
Oswald Buddenhagen6ffa6f32023-05-05 17:52:43 +0200112 /* Silence the just played area immediately */
113 update_silence_vars(runtime, hw_ptr, new_hw_ptr);
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +0200114 }
Oswald Buddenhagen6ffa6f32023-05-05 17:52:43 +0200115 /*
116 * In this mode, silence_filled actually includes the valid
117 * sample data from the user.
118 */
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +0200119 frames = runtime->buffer_size - runtime->silence_filled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 }
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200121 if (snd_BUG_ON(frames > runtime->buffer_size))
122 return;
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +0200123 if (frames == 0)
124 return;
Jaroslav Kysela781b4da2023-05-05 17:52:40 +0200125 ofs = (runtime->silence_start + runtime->silence_filled) % runtime->buffer_size;
Oswald Buddenhagenee2dd702023-05-05 17:52:44 +0200126 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 transfer = ofs + frames > runtime->buffer_size ? runtime->buffer_size - ofs : frames;
Takashi Iwaia9cd29e2017-05-24 18:18:15 +0200128 err = fill_silence_frames(substream, ofs, transfer);
129 snd_BUG_ON(err < 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 runtime->silence_filled += transfer;
131 frames -= transfer;
132 ofs = 0;
Oswald Buddenhagenee2dd702023-05-05 17:52:44 +0200133 } while (frames > 0);
Takashi Iwaia25684a2021-10-17 09:48:57 +0200134 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135}
136
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200137#ifdef CONFIG_SND_DEBUG
138void snd_pcm_debug_name(struct snd_pcm_substream *substream,
Takashi Iwaic00701102009-06-08 15:58:48 +0200139 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}
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200147EXPORT_SYMBOL(snd_pcm_debug_name);
148#endif
Takashi Iwaic00701102009-06-08 15:58:48 +0200149
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100150#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 */
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100153
154#ifdef CONFIG_SND_PCM_XRUN_DEBUG
155
156#define xrun_debug(substream, mask) \
157 ((substream)->pstr->xrun_debug & (mask))
Jarkko Nikula0f170142010-03-26 16:07:25 +0200158#else
159#define xrun_debug(substream, mask) 0
160#endif
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100161
162#define dump_stack_on_xrun(substream) do { \
163 if (xrun_debug(substream, XRUN_DEBUG_STACK)) \
164 dump_stack(); \
165 } while (0)
166
Takashi Iwai9cd641e2018-07-04 14:46:27 +0200167/* call with stream lock held */
168void __snd_pcm_xrun(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169{
Jaroslav Kysela13f040f2009-05-28 11:31:20 +0200170 struct snd_pcm_runtime *runtime = substream->runtime;
171
Takashi Iwaif5914902014-11-04 12:45:59 +0100172 trace_xrun(substream);
Baolin Wangfcae40c2018-04-24 20:06:08 +0800173 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
174 struct timespec64 tstamp;
175
176 snd_pcm_gettime(runtime, &tstamp);
Arnd Bergmann80fe7432018-04-24 20:06:15 +0800177 runtime->status->tstamp.tv_sec = tstamp.tv_sec;
178 runtime->status->tstamp.tv_nsec = tstamp.tv_nsec;
Baolin Wangfcae40c2018-04-24 20:06:08 +0800179 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 snd_pcm_stop(substream, SNDRV_PCM_STATE_XRUN);
Jaroslav Kysela741b20c2009-12-17 17:34:39 +0100181 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) {
Takashi Iwaic00701102009-06-08 15:58:48 +0200182 char name[16];
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200183 snd_pcm_debug_name(substream, name, sizeof(name));
Takashi Iwai09e56df2014-02-04 18:19:48 +0100184 pcm_warn(substream->pcm, "XRUN: %s\n", name);
Takashi Iwaied3da3d2009-03-03 17:00:15 +0100185 dump_stack_on_xrun(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187}
188
Jarkko Nikula0f170142010-03-26 16:07:25 +0200189#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Takashi Iwaif5914902014-11-04 12:45:59 +0100190#define hw_ptr_error(substream, in_interrupt, reason, fmt, args...) \
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100191 do { \
Takashi Iwaif5914902014-11-04 12:45:59 +0100192 trace_hw_ptr_error(substream, reason); \
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100193 if (xrun_debug(substream, XRUN_DEBUG_BASIC)) { \
Takashi Iwaif5914902014-11-04 12:45:59 +0100194 pr_err_ratelimited("ALSA: PCM: [%c] " reason ": " fmt, \
195 (in_interrupt) ? 'Q' : 'P', ##args); \
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100196 dump_stack_on_xrun(substream); \
197 } \
198 } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100200#else /* ! CONFIG_SND_PCM_XRUN_DEBUG */
201
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100202#define hw_ptr_error(substream, fmt, args...) do { } while (0)
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100203
204#endif
205
Jaroslav Kysela12509322010-01-07 15:36:31 +0100206int snd_pcm_update_state(struct snd_pcm_substream *substream,
207 struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 snd_pcm_uframes_t avail;
210
Takashi Iwai763e5062018-04-11 17:56:52 +0200211 avail = snd_pcm_avail(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 if (avail > runtime->avail_max)
213 runtime->avail_max = avail;
Takashi Iwaif0061c12022-09-26 15:55:48 +0200214 if (runtime->state == SNDRV_PCM_STATE_DRAINING) {
Takashi Iwai4cdc1152009-08-20 16:40:16 +0200215 if (avail >= runtime->buffer_size) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 snd_pcm_drain_done(substream);
Takashi Iwai4cdc1152009-08-20 16:40:16 +0200217 return -EPIPE;
218 }
219 } else {
220 if (avail >= runtime->stop_threshold) {
Takashi Iwai9cd641e2018-07-04 14:46:27 +0200221 __snd_pcm_xrun(substream);
Takashi Iwai4cdc1152009-08-20 16:40:16 +0200222 return -EPIPE;
223 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 }
David Dillow5daeba32010-06-27 00:13:20 +0200225 if (runtime->twake) {
226 if (avail >= runtime->twake)
227 wake_up(&runtime->tsleep);
228 } else if (avail >= runtime->control->avail_min)
229 wake_up(&runtime->sleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 return 0;
231}
232
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600233static void update_audio_tstamp(struct snd_pcm_substream *substream,
Baolin Wangfcae40c2018-04-24 20:06:08 +0800234 struct timespec64 *curr_tstamp,
235 struct timespec64 *audio_tstamp)
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600236{
237 struct snd_pcm_runtime *runtime = substream->runtime;
238 u64 audio_frames, audio_nsecs;
Baolin Wangfcae40c2018-04-24 20:06:08 +0800239 struct timespec64 driver_tstamp;
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600240
241 if (runtime->tstamp_mode != SNDRV_PCM_TSTAMP_ENABLE)
242 return;
243
244 if (!(substream->ops->get_time_info) ||
245 (runtime->audio_tstamp_report.actual_type ==
246 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
247
248 /*
249 * provide audio timestamp derived from pointer position
250 * add delay only if requested
251 */
252
253 audio_frames = runtime->hw_ptr_wrap + runtime->status->hw_ptr;
254
255 if (runtime->audio_tstamp_config.report_delay) {
256 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
257 audio_frames -= runtime->delay;
258 else
259 audio_frames += runtime->delay;
260 }
261 audio_nsecs = div_u64(audio_frames * 1000000000LL,
262 runtime->rate);
Baolin Wangfcae40c2018-04-24 20:06:08 +0800263 *audio_tstamp = ns_to_timespec64(audio_nsecs);
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600264 }
Baolin Wangfcae40c2018-04-24 20:06:08 +0800265
266 if (runtime->status->audio_tstamp.tv_sec != audio_tstamp->tv_sec ||
267 runtime->status->audio_tstamp.tv_nsec != audio_tstamp->tv_nsec) {
Arnd Bergmann80fe7432018-04-24 20:06:15 +0800268 runtime->status->audio_tstamp.tv_sec = audio_tstamp->tv_sec;
269 runtime->status->audio_tstamp.tv_nsec = audio_tstamp->tv_nsec;
270 runtime->status->tstamp.tv_sec = curr_tstamp->tv_sec;
271 runtime->status->tstamp.tv_nsec = curr_tstamp->tv_nsec;
Henrik Eriksson20e3f982017-11-21 09:29:28 +0100272 }
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600273
Baolin Wangfcae40c2018-04-24 20:06:08 +0800274
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600275 /*
276 * re-take a driver timestamp to let apps detect if the reference tstamp
277 * read by low-level hardware was provided with a delay
278 */
Baolin Wangfcae40c2018-04-24 20:06:08 +0800279 snd_pcm_gettime(substream->runtime, &driver_tstamp);
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600280 runtime->driver_tstamp = driver_tstamp;
281}
282
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100283static int snd_pcm_update_hw_ptr0(struct snd_pcm_substream *substream,
284 unsigned int in_interrupt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Takashi Iwai877211f2005-11-17 13:59:38 +0100286 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 snd_pcm_uframes_t pos;
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100288 snd_pcm_uframes_t old_hw_ptr, new_hw_ptr, hw_base;
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200289 snd_pcm_sframes_t hdelta, delta;
290 unsigned long jdelta;
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500291 unsigned long curr_jiffies;
Baolin Wangfcae40c2018-04-24 20:06:08 +0800292 struct timespec64 curr_tstamp;
293 struct timespec64 audio_tstamp;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500294 int crossed_boundary = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200296 old_hw_ptr = runtime->status->hw_ptr;
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500297
298 /*
299 * group pointer, time and jiffies reads to allow for more
300 * accurate correlations/corrections.
301 * The values are stored at the end of this routine after
302 * corrections for hw_ptr position
303 */
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100304 pos = substream->ops->pointer(substream);
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500305 curr_jiffies = jiffies;
Pierre-Louis Bossart4eeaaea2012-10-22 16:42:15 -0500306 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600307 if ((substream->ops->get_time_info) &&
308 (runtime->audio_tstamp_config.type_requested != SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)) {
309 substream->ops->get_time_info(substream, &curr_tstamp,
310 &audio_tstamp,
311 &runtime->audio_tstamp_config,
312 &runtime->audio_tstamp_report);
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500313
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600314 /* re-test in case tstamp type is not supported in hardware and was demoted to DEFAULT */
315 if (runtime->audio_tstamp_report.actual_type == SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT)
Baolin Wangfcae40c2018-04-24 20:06:08 +0800316 snd_pcm_gettime(runtime, &curr_tstamp);
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600317 } else
Baolin Wangfcae40c2018-04-24 20:06:08 +0800318 snd_pcm_gettime(runtime, &curr_tstamp);
Pierre-Louis Bossart4eeaaea2012-10-22 16:42:15 -0500319 }
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 if (pos == SNDRV_PCM_POS_XRUN) {
Takashi Iwai9cd641e2018-07-04 14:46:27 +0200322 __snd_pcm_xrun(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 return -EPIPE;
324 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100325 if (pos >= runtime->buffer_size) {
Takashi Iwai09e56df2014-02-04 18:19:48 +0100326 if (printk_ratelimit()) {
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100327 char name[16];
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200328 snd_pcm_debug_name(substream, name, sizeof(name));
Takashi Iwai09e56df2014-02-04 18:19:48 +0100329 pcm_err(substream->pcm,
Takashi Iwai0ab1ace2016-03-10 20:56:20 +0100330 "invalid position: %s, pos = %ld, buffer size = %ld, period size = %ld\n",
Takashi Iwai09e56df2014-02-04 18:19:48 +0100331 name, pos, runtime->buffer_size,
332 runtime->period_size);
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100333 }
334 pos = 0;
Takashi Iwaicedb8112009-07-23 11:04:13 +0200335 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100336 pos -= pos % runtime->min_align;
Takashi Iwaif5914902014-11-04 12:45:59 +0100337 trace_hwptr(substream, pos, in_interrupt);
Takashi Iwaied3da3d2009-03-03 17:00:15 +0100338 hw_base = runtime->hw_ptr_base;
339 new_hw_ptr = hw_base + pos;
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100340 if (in_interrupt) {
341 /* we know that one period was processed */
342 /* delta = "expected next hw_ptr" for in_interrupt != 0 */
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100343 delta = runtime->hw_ptr_interrupt + runtime->period_size;
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100344 if (delta > new_hw_ptr) {
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200345 /* check for double acknowledged interrupts */
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500346 hdelta = curr_jiffies - runtime->hw_ptr_jiffies;
Koro Chen13a98832015-05-13 22:39:03 +0800347 if (hdelta > runtime->hw_ptr_buffer_jiffies/2 + 1) {
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200348 hw_base += runtime->buffer_size;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500349 if (hw_base >= runtime->boundary) {
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200350 hw_base = 0;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500351 crossed_boundary++;
352 }
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200353 new_hw_ptr = hw_base + pos;
354 goto __delta;
355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100358 /* new_hw_ptr might be lower than old_hw_ptr in case when */
359 /* pointer crosses the end of the ring buffer */
360 if (new_hw_ptr < old_hw_ptr) {
361 hw_base += runtime->buffer_size;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500362 if (hw_base >= runtime->boundary) {
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100363 hw_base = 0;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500364 crossed_boundary++;
365 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100366 new_hw_ptr = hw_base + pos;
367 }
368 __delta:
Clemens Ladischb406e612010-05-25 09:01:46 +0200369 delta = new_hw_ptr - old_hw_ptr;
370 if (delta < 0)
371 delta += runtime->boundary;
Clemens Ladischab69a492010-11-15 10:46:23 +0100372
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100373 if (runtime->no_period_wakeup) {
Kelly Anderson12ff4142011-04-01 11:58:25 +0200374 snd_pcm_sframes_t xrun_threshold;
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100375 /*
376 * Without regular period interrupts, we have to check
377 * the elapsed time to detect xruns.
378 */
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500379 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
Clemens Ladisch47228e42010-11-18 09:53:07 +0100380 if (jdelta < runtime->hw_ptr_buffer_jiffies / 2)
381 goto no_delta_check;
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100382 hdelta = jdelta - delta * HZ / runtime->rate;
Kelly Anderson12ff4142011-04-01 11:58:25 +0200383 xrun_threshold = runtime->hw_ptr_buffer_jiffies / 2 + 1;
384 while (hdelta > xrun_threshold) {
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100385 delta += runtime->buffer_size;
386 hw_base += runtime->buffer_size;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500387 if (hw_base >= runtime->boundary) {
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100388 hw_base = 0;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500389 crossed_boundary++;
390 }
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100391 new_hw_ptr = hw_base + pos;
392 hdelta -= runtime->hw_ptr_buffer_jiffies;
393 }
Clemens Ladischab69a492010-11-15 10:46:23 +0100394 goto no_delta_check;
Clemens Ladisch59ff8782010-11-18 09:43:52 +0100395 }
Clemens Ladischab69a492010-11-15 10:46:23 +0100396
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100397 /* something must be really wrong */
Jaroslav Kysela7b3a1772010-01-08 08:43:01 +0100398 if (delta >= runtime->buffer_size + runtime->period_size) {
Takashi Iwaif5914902014-11-04 12:45:59 +0100399 hw_ptr_error(substream, in_interrupt, "Unexpected hw_ptr",
400 "(stream=%i, pos=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
401 substream->stream, (long)pos,
402 (long)new_hw_ptr, (long)old_hw_ptr);
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100403 return 0;
404 }
Takashi Iwaic87d9732009-05-27 10:53:33 +0200405
406 /* Do jiffies check only in xrun_debug mode */
Jaroslav Kysela741b20c2009-12-17 17:34:39 +0100407 if (!xrun_debug(substream, XRUN_DEBUG_JIFFIESCHECK))
Takashi Iwaic87d9732009-05-27 10:53:33 +0200408 goto no_jiffies_check;
409
Takashi Iwai3e5b5012009-04-28 12:07:08 +0200410 /* Skip the jiffies check for hardwares with BATCH flag.
411 * Such hardware usually just increases the position at each IRQ,
412 * thus it can't give any strange position.
413 */
414 if (runtime->hw.info & SNDRV_PCM_INFO_BATCH)
415 goto no_jiffies_check;
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100416 hdelta = delta;
Jaroslav Kyselaa4444da2009-05-28 12:31:56 +0200417 if (hdelta < runtime->delay)
418 goto no_jiffies_check;
419 hdelta -= runtime->delay;
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500420 jdelta = curr_jiffies - runtime->hw_ptr_jiffies;
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200421 if (((hdelta * HZ) / runtime->rate) > jdelta + HZ/100) {
422 delta = jdelta /
423 (((runtime->period_size * HZ) / runtime->rate)
424 + HZ/100);
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100425 /* move new_hw_ptr according jiffies not pos variable */
426 new_hw_ptr = old_hw_ptr;
Jaroslav Kyselaed69c6a2010-01-13 08:12:31 +0100427 hw_base = delta;
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100428 /* use loop to avoid checks for delta overflows */
429 /* the delta value is small or zero in most cases */
430 while (delta > 0) {
431 new_hw_ptr += runtime->period_size;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500432 if (new_hw_ptr >= runtime->boundary) {
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100433 new_hw_ptr -= runtime->boundary;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500434 crossed_boundary--;
435 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100436 delta--;
437 }
438 /* align hw_base to buffer_size */
Takashi Iwaif5914902014-11-04 12:45:59 +0100439 hw_ptr_error(substream, in_interrupt, "hw_ptr skipping",
440 "(pos=%ld, delta=%ld, period=%ld, jdelta=%lu/%lu/%lu, hw_ptr=%ld/%ld)\n",
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200441 (long)pos, (long)hdelta,
442 (long)runtime->period_size, jdelta,
Jaroslav Kyselaed69c6a2010-01-13 08:12:31 +0100443 ((hdelta * HZ) / runtime->rate), hw_base,
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100444 (unsigned long)old_hw_ptr,
445 (unsigned long)new_hw_ptr);
Jaroslav Kyselaed69c6a2010-01-13 08:12:31 +0100446 /* reset values to proper state */
447 delta = 0;
448 hw_base = new_hw_ptr - (new_hw_ptr % runtime->buffer_size);
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200449 }
Takashi Iwai3e5b5012009-04-28 12:07:08 +0200450 no_jiffies_check:
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200451 if (delta > runtime->period_size + runtime->period_size / 2) {
Takashi Iwaif5914902014-11-04 12:45:59 +0100452 hw_ptr_error(substream, in_interrupt,
453 "Lost interrupts?",
454 "(stream=%i, delta=%ld, new_hw_ptr=%ld, old_hw_ptr=%ld)\n",
Takashi Iwaied3da3d2009-03-03 17:00:15 +0100455 substream->stream, (long)delta,
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100456 (long)new_hw_ptr,
457 (long)old_hw_ptr);
Takashi Iwaied3da3d2009-03-03 17:00:15 +0100458 }
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100459
Clemens Ladischab69a492010-11-15 10:46:23 +0100460 no_delta_check:
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600461 if (runtime->status->hw_ptr == new_hw_ptr) {
Brent Lue7513c52020-05-18 12:30:38 +0800462 runtime->hw_ptr_jiffies = curr_jiffies;
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600463 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100464 return 0;
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600465 }
Takashi Iwaiab1863f2009-06-07 12:09:17 +0200466
Jaroslav Kyselad7f5dd972023-05-05 17:52:38 +0200467 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
468 runtime->silence_size > 0)
469 snd_pcm_playback_silence(substream, new_hw_ptr);
470
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100471 if (in_interrupt) {
Clemens Ladischead40462010-05-21 09:15:59 +0200472 delta = new_hw_ptr - runtime->hw_ptr_interrupt;
473 if (delta < 0)
474 delta += runtime->boundary;
475 delta -= (snd_pcm_uframes_t)delta % runtime->period_size;
476 runtime->hw_ptr_interrupt += delta;
477 if (runtime->hw_ptr_interrupt >= runtime->boundary)
478 runtime->hw_ptr_interrupt -= runtime->boundary;
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100479 }
Takashi Iwaied3da3d2009-03-03 17:00:15 +0100480 runtime->hw_ptr_base = hw_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 runtime->status->hw_ptr = new_hw_ptr;
Pierre-Louis Bossart3509a032012-05-22 14:54:02 -0500482 runtime->hw_ptr_jiffies = curr_jiffies;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500483 if (crossed_boundary) {
484 snd_BUG_ON(crossed_boundary != 1);
485 runtime->hw_ptr_wrap += runtime->boundary;
486 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600488 update_audio_tstamp(substream, &curr_tstamp, &audio_tstamp);
Pierre-Louis Bossart4eeaaea2012-10-22 16:42:15 -0500489
Jaroslav Kysela12509322010-01-07 15:36:31 +0100490 return snd_pcm_update_state(substream, runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491}
492
493/* CAUTION: call it with irq disabled */
Takashi Iwai877211f2005-11-17 13:59:38 +0100494int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Jaroslav Kyselaf2404062010-01-05 17:19:34 +0100496 return snd_pcm_update_hw_ptr0(substream, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
499/**
500 * snd_pcm_set_ops - set the PCM operators
501 * @pcm: the pcm instance
502 * @direction: stream direction, SNDRV_PCM_STREAM_XXX
503 * @ops: the operator table
504 *
505 * Sets the given PCM operators to the pcm instance.
506 */
Lars-Peter Clausene6c2e7e2013-05-24 15:18:10 +0200507void snd_pcm_set_ops(struct snd_pcm *pcm, int direction,
508 const struct snd_pcm_ops *ops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Takashi Iwai877211f2005-11-17 13:59:38 +0100510 struct snd_pcm_str *stream = &pcm->streams[direction];
511 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
513 for (substream = stream->substream; substream != NULL; substream = substream->next)
514 substream->ops = ops;
515}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +0200516EXPORT_SYMBOL(snd_pcm_set_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518/**
Mauro Carvalho Chehabf7b66032020-10-23 18:33:35 +0200519 * snd_pcm_set_sync - set the PCM sync id
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 * @substream: the pcm substream
521 *
522 * Sets the PCM sync identifier for the card.
523 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100524void snd_pcm_set_sync(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525{
Takashi Iwai877211f2005-11-17 13:59:38 +0100526 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
528 runtime->sync.id32[0] = substream->pcm->card->number;
529 runtime->sync.id32[1] = -1;
530 runtime->sync.id32[2] = -1;
531 runtime->sync.id32[3] = -1;
532}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +0200533EXPORT_SYMBOL(snd_pcm_set_sync);
534
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535/*
536 * Standard ioctl routine
537 */
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539static inline unsigned int div32(unsigned int a, unsigned int b,
540 unsigned int *r)
541{
542 if (b == 0) {
543 *r = 0;
544 return UINT_MAX;
545 }
546 *r = a % b;
547 return a / b;
548}
549
550static inline unsigned int div_down(unsigned int a, unsigned int b)
551{
552 if (b == 0)
553 return UINT_MAX;
554 return a / b;
555}
556
557static inline unsigned int div_up(unsigned int a, unsigned int b)
558{
559 unsigned int r;
560 unsigned int q;
561 if (b == 0)
562 return UINT_MAX;
563 q = div32(a, b, &r);
564 if (r)
565 ++q;
566 return q;
567}
568
569static inline unsigned int mul(unsigned int a, unsigned int b)
570{
571 if (a == 0)
572 return 0;
573 if (div_down(UINT_MAX, a) < b)
574 return UINT_MAX;
575 return a * b;
576}
577
578static inline unsigned int muldiv32(unsigned int a, unsigned int b,
579 unsigned int c, unsigned int *r)
580{
581 u_int64_t n = (u_int64_t) a * b;
582 if (c == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 *r = 0;
584 return UINT_MAX;
585 }
Takashi Iwai3f7440a2009-06-05 17:40:04 +0200586 n = div_u64_rem(n, c, r);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 if (n >= UINT_MAX) {
588 *r = 0;
589 return UINT_MAX;
590 }
591 return n;
592}
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594/**
595 * snd_interval_refine - refine the interval value of configurator
596 * @i: the interval value to refine
597 * @v: the interval value to refer to
598 *
599 * Refines the interval value with the reference value.
600 * The interval is changed to the range satisfying both intervals.
601 * The interval status (min, max, integer, etc.) are evaluated.
602 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100603 * Return: Positive if the value is changed, zero if it's not changed, or a
604 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100606int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 int changed = 0;
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200609 if (snd_BUG_ON(snd_interval_empty(i)))
610 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 if (i->min < v->min) {
612 i->min = v->min;
613 i->openmin = v->openmin;
614 changed = 1;
615 } else if (i->min == v->min && !i->openmin && v->openmin) {
616 i->openmin = 1;
617 changed = 1;
618 }
619 if (i->max > v->max) {
620 i->max = v->max;
621 i->openmax = v->openmax;
622 changed = 1;
623 } else if (i->max == v->max && !i->openmax && v->openmax) {
624 i->openmax = 1;
625 changed = 1;
626 }
627 if (!i->integer && v->integer) {
628 i->integer = 1;
629 changed = 1;
630 }
631 if (i->integer) {
632 if (i->openmin) {
633 i->min++;
634 i->openmin = 0;
635 }
636 if (i->openmax) {
637 i->max--;
638 i->openmax = 0;
639 }
640 } else if (!i->openmin && !i->openmax && i->min == i->max)
641 i->integer = 1;
642 if (snd_interval_checkempty(i)) {
643 snd_interval_none(i);
644 return -EINVAL;
645 }
646 return changed;
647}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +0200648EXPORT_SYMBOL(snd_interval_refine);
649
Takashi Iwai877211f2005-11-17 13:59:38 +0100650static int snd_interval_refine_first(struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651{
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200652 const unsigned int last_max = i->max;
653
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200654 if (snd_BUG_ON(snd_interval_empty(i)))
655 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (snd_interval_single(i))
657 return 0;
658 i->max = i->min;
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200659 if (i->openmin)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 i->max++;
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200661 /* only exclude max value if also excluded before refine */
662 i->openmax = (i->openmax && i->max >= last_max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return 1;
664}
665
Takashi Iwai877211f2005-11-17 13:59:38 +0100666static int snd_interval_refine_last(struct snd_interval *i)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200668 const unsigned int last_min = i->min;
669
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200670 if (snd_BUG_ON(snd_interval_empty(i)))
671 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 if (snd_interval_single(i))
673 return 0;
674 i->min = i->max;
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200675 if (i->openmax)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 i->min--;
Timo Wischerff2d6ac2018-07-10 17:28:45 +0200677 /* only exclude min value if also excluded before refine */
678 i->openmin = (i->openmin && i->min <= last_min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 return 1;
680}
681
Takashi Iwai877211f2005-11-17 13:59:38 +0100682void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
684 if (a->empty || b->empty) {
685 snd_interval_none(c);
686 return;
687 }
688 c->empty = 0;
689 c->min = mul(a->min, b->min);
690 c->openmin = (a->openmin || b->openmin);
691 c->max = mul(a->max, b->max);
692 c->openmax = (a->openmax || b->openmax);
693 c->integer = (a->integer && b->integer);
694}
695
696/**
697 * snd_interval_div - refine the interval value with division
Takashi Iwaidf8db932005-09-07 13:38:19 +0200698 * @a: dividend
699 * @b: divisor
700 * @c: quotient
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 *
702 * c = a / b
703 *
704 * Returns non-zero if the value is changed, zero if not changed.
705 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100706void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
708 unsigned int r;
709 if (a->empty || b->empty) {
710 snd_interval_none(c);
711 return;
712 }
713 c->empty = 0;
714 c->min = div32(a->min, b->max, &r);
715 c->openmin = (r || a->openmin || b->openmax);
716 if (b->min > 0) {
717 c->max = div32(a->max, b->min, &r);
718 if (r) {
719 c->max++;
720 c->openmax = 1;
721 } else
722 c->openmax = (a->openmax || b->openmin);
723 } else {
724 c->max = UINT_MAX;
725 c->openmax = 0;
726 }
727 c->integer = 0;
728}
729
730/**
731 * snd_interval_muldivk - refine the interval value
Takashi Iwaidf8db932005-09-07 13:38:19 +0200732 * @a: dividend 1
733 * @b: dividend 2
734 * @k: divisor (as integer)
735 * @c: result
736 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 * c = a * b / k
738 *
739 * Returns non-zero if the value is changed, zero if not changed.
740 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100741void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
742 unsigned int k, struct snd_interval *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
744 unsigned int r;
745 if (a->empty || b->empty) {
746 snd_interval_none(c);
747 return;
748 }
749 c->empty = 0;
750 c->min = muldiv32(a->min, b->min, k, &r);
751 c->openmin = (r || a->openmin || b->openmin);
752 c->max = muldiv32(a->max, b->max, k, &r);
753 if (r) {
754 c->max++;
755 c->openmax = 1;
756 } else
757 c->openmax = (a->openmax || b->openmax);
758 c->integer = 0;
759}
760
761/**
762 * snd_interval_mulkdiv - refine the interval value
Takashi Iwaidf8db932005-09-07 13:38:19 +0200763 * @a: dividend 1
764 * @k: dividend 2 (as integer)
765 * @b: divisor
766 * @c: result
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 *
768 * c = a * k / b
769 *
770 * Returns non-zero if the value is changed, zero if not changed.
771 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100772void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
773 const struct snd_interval *b, struct snd_interval *c)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774{
775 unsigned int r;
776 if (a->empty || b->empty) {
777 snd_interval_none(c);
778 return;
779 }
780 c->empty = 0;
781 c->min = muldiv32(a->min, k, b->max, &r);
782 c->openmin = (r || a->openmin || b->openmax);
783 if (b->min > 0) {
784 c->max = muldiv32(a->max, k, b->min, &r);
785 if (r) {
786 c->max++;
787 c->openmax = 1;
788 } else
789 c->openmax = (a->openmax || b->openmin);
790 } else {
791 c->max = UINT_MAX;
792 c->openmax = 0;
793 }
794 c->integer = 0;
795}
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797/* ---- */
798
799
800/**
801 * snd_interval_ratnum - refine the interval value
Takashi Iwaidf8db932005-09-07 13:38:19 +0200802 * @i: interval to refine
803 * @rats_count: number of ratnum_t
804 * @rats: ratnum_t array
805 * @nump: pointer to store the resultant numerator
806 * @denp: pointer to store the resultant denominator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100808 * Return: Positive if the value is changed, zero if it's not changed, or a
809 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100811int snd_interval_ratnum(struct snd_interval *i,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +0100812 unsigned int rats_count, const struct snd_ratnum *rats,
Takashi Iwai877211f2005-11-17 13:59:38 +0100813 unsigned int *nump, unsigned int *denp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814{
Krzysztof Helt8374e242009-12-21 17:07:08 +0100815 unsigned int best_num, best_den;
816 int best_diff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 unsigned int k;
Takashi Iwai877211f2005-11-17 13:59:38 +0100818 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 int err;
Krzysztof Helt8374e242009-12-21 17:07:08 +0100820 unsigned int result_num, result_den;
821 int result_diff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 best_num = best_den = best_diff = 0;
824 for (k = 0; k < rats_count; ++k) {
825 unsigned int num = rats[k].num;
826 unsigned int den;
827 unsigned int q = i->min;
828 int diff;
829 if (q == 0)
830 q = 1;
Krzysztof Helt40962d72009-12-19 18:31:04 +0100831 den = div_up(num, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 if (den < rats[k].den_min)
833 continue;
834 if (den > rats[k].den_max)
835 den = rats[k].den_max;
836 else {
837 unsigned int r;
838 r = (den - rats[k].den_min) % rats[k].den_step;
839 if (r != 0)
840 den -= r;
841 }
842 diff = num - q * den;
Krzysztof Helt8374e242009-12-21 17:07:08 +0100843 if (diff < 0)
844 diff = -diff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 if (best_num == 0 ||
846 diff * best_den < best_diff * den) {
847 best_diff = diff;
848 best_den = den;
849 best_num = num;
850 }
851 }
852 if (best_den == 0) {
853 i->empty = 1;
854 return -EINVAL;
855 }
856 t.min = div_down(best_num, best_den);
857 t.openmin = !!(best_num % best_den);
858
Krzysztof Helt8374e242009-12-21 17:07:08 +0100859 result_num = best_num;
860 result_diff = best_diff;
861 result_den = best_den;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 best_num = best_den = best_diff = 0;
863 for (k = 0; k < rats_count; ++k) {
864 unsigned int num = rats[k].num;
865 unsigned int den;
866 unsigned int q = i->max;
867 int diff;
868 if (q == 0) {
869 i->empty = 1;
870 return -EINVAL;
871 }
Krzysztof Helt40962d72009-12-19 18:31:04 +0100872 den = div_down(num, q);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 if (den > rats[k].den_max)
874 continue;
875 if (den < rats[k].den_min)
876 den = rats[k].den_min;
877 else {
878 unsigned int r;
879 r = (den - rats[k].den_min) % rats[k].den_step;
880 if (r != 0)
881 den += rats[k].den_step - r;
882 }
883 diff = q * den - num;
Krzysztof Helt8374e242009-12-21 17:07:08 +0100884 if (diff < 0)
885 diff = -diff;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 if (best_num == 0 ||
887 diff * best_den < best_diff * den) {
888 best_diff = diff;
889 best_den = den;
890 best_num = num;
891 }
892 }
893 if (best_den == 0) {
894 i->empty = 1;
895 return -EINVAL;
896 }
897 t.max = div_up(best_num, best_den);
898 t.openmax = !!(best_num % best_den);
899 t.integer = 0;
900 err = snd_interval_refine(i, &t);
901 if (err < 0)
902 return err;
903
904 if (snd_interval_single(i)) {
Krzysztof Helt8374e242009-12-21 17:07:08 +0100905 if (best_diff * result_den < result_diff * best_den) {
906 result_num = best_num;
907 result_den = best_den;
908 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 if (nump)
Krzysztof Helt8374e242009-12-21 17:07:08 +0100910 *nump = result_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 if (denp)
Krzysztof Helt8374e242009-12-21 17:07:08 +0100912 *denp = result_den;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913 }
914 return err;
915}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +0200916EXPORT_SYMBOL(snd_interval_ratnum);
917
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918/**
919 * snd_interval_ratden - refine the interval value
Takashi Iwaidf8db932005-09-07 13:38:19 +0200920 * @i: interval to refine
Takashi Iwai877211f2005-11-17 13:59:38 +0100921 * @rats_count: number of struct ratden
922 * @rats: struct ratden array
Takashi Iwaidf8db932005-09-07 13:38:19 +0200923 * @nump: pointer to store the resultant numerator
924 * @denp: pointer to store the resultant denominator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100926 * Return: Positive if the value is changed, zero if it's not changed, or a
927 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100929static int snd_interval_ratden(struct snd_interval *i,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +0100930 unsigned int rats_count,
931 const struct snd_ratden *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 unsigned int *nump, unsigned int *denp)
933{
934 unsigned int best_num, best_diff, best_den;
935 unsigned int k;
Takashi Iwai877211f2005-11-17 13:59:38 +0100936 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 int err;
938
939 best_num = best_den = best_diff = 0;
940 for (k = 0; k < rats_count; ++k) {
941 unsigned int num;
942 unsigned int den = rats[k].den;
943 unsigned int q = i->min;
944 int diff;
945 num = mul(q, den);
946 if (num > rats[k].num_max)
947 continue;
948 if (num < rats[k].num_min)
949 num = rats[k].num_max;
950 else {
951 unsigned int r;
952 r = (num - rats[k].num_min) % rats[k].num_step;
953 if (r != 0)
954 num += rats[k].num_step - r;
955 }
956 diff = num - q * den;
957 if (best_num == 0 ||
958 diff * best_den < best_diff * den) {
959 best_diff = diff;
960 best_den = den;
961 best_num = num;
962 }
963 }
964 if (best_den == 0) {
965 i->empty = 1;
966 return -EINVAL;
967 }
968 t.min = div_down(best_num, best_den);
969 t.openmin = !!(best_num % best_den);
970
971 best_num = best_den = best_diff = 0;
972 for (k = 0; k < rats_count; ++k) {
973 unsigned int num;
974 unsigned int den = rats[k].den;
975 unsigned int q = i->max;
976 int diff;
977 num = mul(q, den);
978 if (num < rats[k].num_min)
979 continue;
980 if (num > rats[k].num_max)
981 num = rats[k].num_max;
982 else {
983 unsigned int r;
984 r = (num - rats[k].num_min) % rats[k].num_step;
985 if (r != 0)
986 num -= r;
987 }
988 diff = q * den - num;
989 if (best_num == 0 ||
990 diff * best_den < best_diff * den) {
991 best_diff = diff;
992 best_den = den;
993 best_num = num;
994 }
995 }
996 if (best_den == 0) {
997 i->empty = 1;
998 return -EINVAL;
999 }
1000 t.max = div_up(best_num, best_den);
1001 t.openmax = !!(best_num % best_den);
1002 t.integer = 0;
1003 err = snd_interval_refine(i, &t);
1004 if (err < 0)
1005 return err;
1006
1007 if (snd_interval_single(i)) {
1008 if (nump)
1009 *nump = best_num;
1010 if (denp)
1011 *denp = best_den;
1012 }
1013 return err;
1014}
1015
1016/**
1017 * snd_interval_list - refine the interval value from the list
1018 * @i: the interval value to refine
1019 * @count: the number of elements in the list
1020 * @list: the value list
1021 * @mask: the bit-mask to evaluate
1022 *
1023 * Refines the interval value from the list.
1024 * When mask is non-zero, only the elements corresponding to bit 1 are
1025 * evaluated.
1026 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001027 * Return: Positive if the value is changed, zero if it's not changed, or a
1028 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029 */
Mark Brown4af87a92012-03-14 19:48:43 +00001030int snd_interval_list(struct snd_interval *i, unsigned int count,
1031 const unsigned int *list, unsigned int mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032{
1033 unsigned int k;
Clemens Ladischb1ddaf62009-08-25 08:15:41 +02001034 struct snd_interval list_range;
Takashi Iwai0981a262007-02-01 14:53:49 +01001035
1036 if (!count) {
1037 i->empty = 1;
1038 return -EINVAL;
1039 }
Clemens Ladischb1ddaf62009-08-25 08:15:41 +02001040 snd_interval_any(&list_range);
1041 list_range.min = UINT_MAX;
1042 list_range.max = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043 for (k = 0; k < count; k++) {
1044 if (mask && !(mask & (1 << k)))
1045 continue;
Clemens Ladischb1ddaf62009-08-25 08:15:41 +02001046 if (!snd_interval_test(i, list[k]))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 continue;
Clemens Ladischb1ddaf62009-08-25 08:15:41 +02001048 list_range.min = min(list_range.min, list[k]);
1049 list_range.max = max(list_range.max, list[k]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 }
Clemens Ladischb1ddaf62009-08-25 08:15:41 +02001051 return snd_interval_refine(i, &list_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001053EXPORT_SYMBOL(snd_interval_list);
1054
Peter Rosinf66f8982015-01-28 15:16:06 +01001055/**
1056 * snd_interval_ranges - refine the interval value from the list of ranges
1057 * @i: the interval value to refine
1058 * @count: the number of elements in the list of ranges
1059 * @ranges: the ranges list
1060 * @mask: the bit-mask to evaluate
1061 *
1062 * Refines the interval value from the list of ranges.
1063 * When mask is non-zero, only the elements corresponding to bit 1 are
1064 * evaluated.
1065 *
1066 * Return: Positive if the value is changed, zero if it's not changed, or a
1067 * negative error code.
1068 */
1069int snd_interval_ranges(struct snd_interval *i, unsigned int count,
1070 const struct snd_interval *ranges, unsigned int mask)
1071{
1072 unsigned int k;
1073 struct snd_interval range_union;
1074 struct snd_interval range;
1075
1076 if (!count) {
1077 snd_interval_none(i);
1078 return -EINVAL;
1079 }
1080 snd_interval_any(&range_union);
1081 range_union.min = UINT_MAX;
1082 range_union.max = 0;
1083 for (k = 0; k < count; k++) {
1084 if (mask && !(mask & (1 << k)))
1085 continue;
1086 snd_interval_copy(&range, &ranges[k]);
1087 if (snd_interval_refine(&range, i) < 0)
1088 continue;
1089 if (snd_interval_empty(&range))
1090 continue;
1091
1092 if (range.min < range_union.min) {
1093 range_union.min = range.min;
1094 range_union.openmin = 1;
1095 }
1096 if (range.min == range_union.min && !range.openmin)
1097 range_union.openmin = 0;
1098 if (range.max > range_union.max) {
1099 range_union.max = range.max;
1100 range_union.openmax = 1;
1101 }
1102 if (range.max == range_union.max && !range.openmax)
1103 range_union.openmax = 0;
1104 }
1105 return snd_interval_refine(i, &range_union);
1106}
1107EXPORT_SYMBOL(snd_interval_ranges);
1108
Clemens Ladisch0f519b62014-09-07 21:43:07 +02001109static int snd_interval_step(struct snd_interval *i, unsigned int step)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110{
1111 unsigned int n;
1112 int changed = 0;
Clemens Ladisch0f519b62014-09-07 21:43:07 +02001113 n = i->min % step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 if (n != 0 || i->openmin) {
1115 i->min += step - n;
Clemens Ladischdf1e4712014-09-07 21:43:41 +02001116 i->openmin = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 changed = 1;
1118 }
Clemens Ladisch0f519b62014-09-07 21:43:07 +02001119 n = i->max % step;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 if (n != 0 || i->openmax) {
1121 i->max -= n;
Clemens Ladischdf1e4712014-09-07 21:43:41 +02001122 i->openmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 changed = 1;
1124 }
1125 if (snd_interval_checkempty(i)) {
1126 i->empty = 1;
1127 return -EINVAL;
1128 }
1129 return changed;
1130}
1131
1132/* Info constraints helpers */
1133
1134/**
1135 * snd_pcm_hw_rule_add - add the hw-constraint rule
1136 * @runtime: the pcm runtime instance
1137 * @cond: condition bits
1138 * @var: the variable to evaluate
1139 * @func: the evaluation function
1140 * @private: the private data pointer passed to function
1141 * @dep: the dependent variables
1142 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001143 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001145int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime, unsigned int cond,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 int var,
1147 snd_pcm_hw_rule_func_t func, void *private,
1148 int dep, ...)
1149{
Takashi Iwai877211f2005-11-17 13:59:38 +01001150 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1151 struct snd_pcm_hw_rule *c;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 unsigned int k;
1153 va_list args;
1154 va_start(args, dep);
1155 if (constrs->rules_num >= constrs->rules_all) {
Takashi Iwai877211f2005-11-17 13:59:38 +01001156 struct snd_pcm_hw_rule *new;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 unsigned int new_rules = constrs->rules_all + 16;
Bartosz Golaszewski64f0bd12020-12-14 19:03:59 -08001158 new = krealloc_array(constrs->rules, new_rules,
1159 sizeof(*c), GFP_KERNEL);
Jesper Juhl87a1c8a2010-12-21 00:03:17 +01001160 if (!new) {
1161 va_end(args);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 return -ENOMEM;
Jesper Juhl87a1c8a2010-12-21 00:03:17 +01001163 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 constrs->rules = new;
1165 constrs->rules_all = new_rules;
1166 }
1167 c = &constrs->rules[constrs->rules_num];
1168 c->cond = cond;
1169 c->func = func;
1170 c->var = var;
1171 c->private = private;
1172 k = 0;
1173 while (1) {
Jesper Juhl87a1c8a2010-12-21 00:03:17 +01001174 if (snd_BUG_ON(k >= ARRAY_SIZE(c->deps))) {
1175 va_end(args);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001176 return -EINVAL;
Jesper Juhl87a1c8a2010-12-21 00:03:17 +01001177 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 c->deps[k++] = dep;
1179 if (dep < 0)
1180 break;
1181 dep = va_arg(args, int);
1182 }
1183 constrs->rules_num++;
1184 va_end(args);
1185 return 0;
Jesper Juhl87a1c8a2010-12-21 00:03:17 +01001186}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001187EXPORT_SYMBOL(snd_pcm_hw_rule_add);
1188
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001190 * snd_pcm_hw_constraint_mask - apply the given bitmap mask constraint
Takashi Iwaidf8db932005-09-07 13:38:19 +02001191 * @runtime: PCM runtime instance
1192 * @var: hw_params variable to apply the mask
1193 * @mask: the bitmap mask
1194 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001195 * Apply the constraint of the given bitmap mask to a 32-bit mask parameter.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001196 *
1197 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001199int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200 u_int32_t mask)
1201{
Takashi Iwai877211f2005-11-17 13:59:38 +01001202 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1203 struct snd_mask *maskp = constrs_mask(constrs, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 *maskp->bits &= mask;
1205 memset(maskp->bits + 1, 0, (SNDRV_MASK_MAX-32) / 8); /* clear rest */
1206 if (*maskp->bits == 0)
1207 return -EINVAL;
1208 return 0;
1209}
1210
1211/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001212 * snd_pcm_hw_constraint_mask64 - apply the given bitmap mask constraint
Takashi Iwaidf8db932005-09-07 13:38:19 +02001213 * @runtime: PCM runtime instance
1214 * @var: hw_params variable to apply the mask
1215 * @mask: the 64bit bitmap mask
1216 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001217 * Apply the constraint of the given bitmap mask to a 64-bit mask parameter.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001218 *
1219 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001221int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222 u_int64_t mask)
1223{
Takashi Iwai877211f2005-11-17 13:59:38 +01001224 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1225 struct snd_mask *maskp = constrs_mask(constrs, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 maskp->bits[0] &= (u_int32_t)mask;
1227 maskp->bits[1] &= (u_int32_t)(mask >> 32);
1228 memset(maskp->bits + 2, 0, (SNDRV_MASK_MAX-64) / 8); /* clear rest */
1229 if (! maskp->bits[0] && ! maskp->bits[1])
1230 return -EINVAL;
1231 return 0;
1232}
Mark Brown63a5d4c2014-02-20 12:13:52 +09001233EXPORT_SYMBOL(snd_pcm_hw_constraint_mask64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234
1235/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001236 * snd_pcm_hw_constraint_integer - apply an integer constraint to an interval
Takashi Iwaidf8db932005-09-07 13:38:19 +02001237 * @runtime: PCM runtime instance
1238 * @var: hw_params variable to apply the integer constraint
1239 *
1240 * Apply the constraint of integer to an interval parameter.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001241 *
1242 * Return: Positive if the value is changed, zero if it's not changed, or a
1243 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001245int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246{
Takashi Iwai877211f2005-11-17 13:59:38 +01001247 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 return snd_interval_setinteger(constrs_interval(constrs, var));
1249}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001250EXPORT_SYMBOL(snd_pcm_hw_constraint_integer);
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001253 * snd_pcm_hw_constraint_minmax - apply a min/max range constraint to an interval
Takashi Iwaidf8db932005-09-07 13:38:19 +02001254 * @runtime: PCM runtime instance
1255 * @var: hw_params variable to apply the range
1256 * @min: the minimal value
1257 * @max: the maximal value
1258 *
1259 * Apply the min/max range constraint to an interval parameter.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001260 *
1261 * Return: Positive if the value is changed, zero if it's not changed, or a
1262 * negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001264int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 unsigned int min, unsigned int max)
1266{
Takashi Iwai877211f2005-11-17 13:59:38 +01001267 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1268 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 t.min = min;
1270 t.max = max;
1271 t.openmin = t.openmax = 0;
1272 t.integer = 0;
1273 return snd_interval_refine(constrs_interval(constrs, var), &t);
1274}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001275EXPORT_SYMBOL(snd_pcm_hw_constraint_minmax);
1276
Takashi Iwai877211f2005-11-17 13:59:38 +01001277static int snd_pcm_hw_rule_list(struct snd_pcm_hw_params *params,
1278 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279{
Takashi Iwai877211f2005-11-17 13:59:38 +01001280 struct snd_pcm_hw_constraint_list *list = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 return snd_interval_list(hw_param_interval(params, rule->var), list->count, list->list, list->mask);
1282}
1283
1284
1285/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001286 * snd_pcm_hw_constraint_list - apply a list of constraints to a parameter
Takashi Iwaidf8db932005-09-07 13:38:19 +02001287 * @runtime: PCM runtime instance
1288 * @cond: condition bits
1289 * @var: hw_params variable to apply the list constraint
1290 * @l: list
1291 *
1292 * Apply the list of constraints to an interval parameter.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001293 *
1294 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001296int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 unsigned int cond,
1298 snd_pcm_hw_param_t var,
Mark Brown14641892012-07-05 12:15:01 +01001299 const struct snd_pcm_hw_constraint_list *l)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300{
1301 return snd_pcm_hw_rule_add(runtime, cond, var,
Mark Brown14641892012-07-05 12:15:01 +01001302 snd_pcm_hw_rule_list, (void *)l,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 var, -1);
1304}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001305EXPORT_SYMBOL(snd_pcm_hw_constraint_list);
1306
Peter Rosinf66f8982015-01-28 15:16:06 +01001307static int snd_pcm_hw_rule_ranges(struct snd_pcm_hw_params *params,
1308 struct snd_pcm_hw_rule *rule)
1309{
1310 struct snd_pcm_hw_constraint_ranges *r = rule->private;
1311 return snd_interval_ranges(hw_param_interval(params, rule->var),
1312 r->count, r->ranges, r->mask);
1313}
1314
1315
1316/**
1317 * snd_pcm_hw_constraint_ranges - apply list of range constraints to a parameter
1318 * @runtime: PCM runtime instance
1319 * @cond: condition bits
1320 * @var: hw_params variable to apply the list of range constraints
1321 * @r: ranges
1322 *
1323 * Apply the list of range constraints to an interval parameter.
1324 *
1325 * Return: Zero if successful, or a negative error code on failure.
1326 */
1327int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1328 unsigned int cond,
1329 snd_pcm_hw_param_t var,
1330 const struct snd_pcm_hw_constraint_ranges *r)
1331{
1332 return snd_pcm_hw_rule_add(runtime, cond, var,
1333 snd_pcm_hw_rule_ranges, (void *)r,
1334 var, -1);
1335}
1336EXPORT_SYMBOL(snd_pcm_hw_constraint_ranges);
1337
Takashi Iwai877211f2005-11-17 13:59:38 +01001338static int snd_pcm_hw_rule_ratnums(struct snd_pcm_hw_params *params,
1339 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340{
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001341 const struct snd_pcm_hw_constraint_ratnums *r = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 unsigned int num = 0, den = 0;
1343 int err;
1344 err = snd_interval_ratnum(hw_param_interval(params, rule->var),
1345 r->nrats, r->rats, &num, &den);
1346 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1347 params->rate_num = num;
1348 params->rate_den = den;
1349 }
1350 return err;
1351}
1352
1353/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001354 * snd_pcm_hw_constraint_ratnums - apply ratnums constraint to a parameter
Takashi Iwaidf8db932005-09-07 13:38:19 +02001355 * @runtime: PCM runtime instance
1356 * @cond: condition bits
1357 * @var: hw_params variable to apply the ratnums constraint
Takashi Iwai877211f2005-11-17 13:59:38 +01001358 * @r: struct snd_ratnums constriants
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001359 *
1360 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001362int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 unsigned int cond,
1364 snd_pcm_hw_param_t var,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001365 const struct snd_pcm_hw_constraint_ratnums *r)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366{
1367 return snd_pcm_hw_rule_add(runtime, cond, var,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001368 snd_pcm_hw_rule_ratnums, (void *)r,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 var, -1);
1370}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001371EXPORT_SYMBOL(snd_pcm_hw_constraint_ratnums);
1372
Takashi Iwai877211f2005-11-17 13:59:38 +01001373static int snd_pcm_hw_rule_ratdens(struct snd_pcm_hw_params *params,
1374 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375{
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001376 const struct snd_pcm_hw_constraint_ratdens *r = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 unsigned int num = 0, den = 0;
1378 int err = snd_interval_ratden(hw_param_interval(params, rule->var),
1379 r->nrats, r->rats, &num, &den);
1380 if (err >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
1381 params->rate_num = num;
1382 params->rate_den = den;
1383 }
1384 return err;
1385}
1386
1387/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001388 * snd_pcm_hw_constraint_ratdens - apply ratdens constraint to a parameter
Takashi Iwaidf8db932005-09-07 13:38:19 +02001389 * @runtime: PCM runtime instance
1390 * @cond: condition bits
1391 * @var: hw_params variable to apply the ratdens constraint
Takashi Iwai877211f2005-11-17 13:59:38 +01001392 * @r: struct snd_ratdens constriants
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001393 *
1394 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001396int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 unsigned int cond,
1398 snd_pcm_hw_param_t var,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001399 const struct snd_pcm_hw_constraint_ratdens *r)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400{
1401 return snd_pcm_hw_rule_add(runtime, cond, var,
Lars-Peter Clausene5e113c2015-10-28 11:37:53 +01001402 snd_pcm_hw_rule_ratdens, (void *)r,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 var, -1);
1404}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001405EXPORT_SYMBOL(snd_pcm_hw_constraint_ratdens);
1406
Takashi Iwai877211f2005-11-17 13:59:38 +01001407static int snd_pcm_hw_rule_msbits(struct snd_pcm_hw_params *params,
1408 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409{
1410 unsigned int l = (unsigned long) rule->private;
1411 int width = l & 0xffff;
1412 unsigned int msbits = l >> 16;
Takashi Sakamotob55f9fd2017-05-17 08:48:20 +09001413 const struct snd_interval *i =
1414 hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
Lars-Peter Clausen8ef9df52014-12-29 18:43:37 +01001415
1416 if (!snd_interval_single(i))
1417 return 0;
1418
1419 if ((snd_interval_value(i) == width) ||
1420 (width == 0 && snd_interval_value(i) > msbits))
Lars-Peter Clausen19f52fa2014-12-29 18:43:36 +01001421 params->msbits = min_not_zero(params->msbits, msbits);
Lars-Peter Clausen8ef9df52014-12-29 18:43:37 +01001422
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 return 0;
1424}
1425
1426/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001427 * snd_pcm_hw_constraint_msbits - add a hw constraint msbits rule
Takashi Iwaidf8db932005-09-07 13:38:19 +02001428 * @runtime: PCM runtime instance
1429 * @cond: condition bits
1430 * @width: sample bits width
1431 * @msbits: msbits width
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001432 *
Lars-Peter Clausen8ef9df52014-12-29 18:43:37 +01001433 * This constraint will set the number of most significant bits (msbits) if a
1434 * sample format with the specified width has been select. If width is set to 0
1435 * the msbits will be set for any sample format with a width larger than the
1436 * specified msbits.
1437 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001438 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001440int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 unsigned int cond,
1442 unsigned int width,
1443 unsigned int msbits)
1444{
1445 unsigned long l = (msbits << 16) | width;
1446 return snd_pcm_hw_rule_add(runtime, cond, -1,
1447 snd_pcm_hw_rule_msbits,
1448 (void*) l,
1449 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
1450}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001451EXPORT_SYMBOL(snd_pcm_hw_constraint_msbits);
1452
Takashi Iwai877211f2005-11-17 13:59:38 +01001453static int snd_pcm_hw_rule_step(struct snd_pcm_hw_params *params,
1454 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455{
1456 unsigned long step = (unsigned long) rule->private;
Clemens Ladisch0f519b62014-09-07 21:43:07 +02001457 return snd_interval_step(hw_param_interval(params, rule->var), step);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458}
1459
1460/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001461 * snd_pcm_hw_constraint_step - add a hw constraint step rule
Takashi Iwaidf8db932005-09-07 13:38:19 +02001462 * @runtime: PCM runtime instance
1463 * @cond: condition bits
1464 * @var: hw_params variable to apply the step constraint
1465 * @step: step size
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001466 *
1467 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001469int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 unsigned int cond,
1471 snd_pcm_hw_param_t var,
1472 unsigned long step)
1473{
1474 return snd_pcm_hw_rule_add(runtime, cond, var,
1475 snd_pcm_hw_rule_step, (void *) step,
1476 var, -1);
1477}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001478EXPORT_SYMBOL(snd_pcm_hw_constraint_step);
1479
Takashi Iwai877211f2005-11-17 13:59:38 +01001480static int snd_pcm_hw_rule_pow2(struct snd_pcm_hw_params *params, struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
Takashi Iwaid03af9b2020-01-05 15:47:20 +01001482 static const unsigned int pow2_sizes[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483 1<<0, 1<<1, 1<<2, 1<<3, 1<<4, 1<<5, 1<<6, 1<<7,
1484 1<<8, 1<<9, 1<<10, 1<<11, 1<<12, 1<<13, 1<<14, 1<<15,
1485 1<<16, 1<<17, 1<<18, 1<<19, 1<<20, 1<<21, 1<<22, 1<<23,
1486 1<<24, 1<<25, 1<<26, 1<<27, 1<<28, 1<<29, 1<<30
1487 };
1488 return snd_interval_list(hw_param_interval(params, rule->var),
1489 ARRAY_SIZE(pow2_sizes), pow2_sizes, 0);
1490}
1491
1492/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001493 * snd_pcm_hw_constraint_pow2 - add a hw constraint power-of-2 rule
Takashi Iwaidf8db932005-09-07 13:38:19 +02001494 * @runtime: PCM runtime instance
1495 * @cond: condition bits
1496 * @var: hw_params variable to apply the power-of-2 constraint
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001497 *
1498 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001500int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 unsigned int cond,
1502 snd_pcm_hw_param_t var)
1503{
1504 return snd_pcm_hw_rule_add(runtime, cond, var,
1505 snd_pcm_hw_rule_pow2, NULL,
1506 var, -1);
1507}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001508EXPORT_SYMBOL(snd_pcm_hw_constraint_pow2);
1509
Clemens Ladischd5b702a2011-09-16 23:03:02 +02001510static int snd_pcm_hw_rule_noresample_func(struct snd_pcm_hw_params *params,
1511 struct snd_pcm_hw_rule *rule)
1512{
1513 unsigned int base_rate = (unsigned int)(uintptr_t)rule->private;
1514 struct snd_interval *rate;
1515
1516 rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
1517 return snd_interval_list(rate, 1, &base_rate, 0);
1518}
1519
1520/**
1521 * snd_pcm_hw_rule_noresample - add a rule to allow disabling hw resampling
1522 * @runtime: PCM runtime instance
1523 * @base_rate: the rate at which the hardware does not resample
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001524 *
1525 * Return: Zero if successful, or a negative error code on failure.
Clemens Ladischd5b702a2011-09-16 23:03:02 +02001526 */
1527int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1528 unsigned int base_rate)
1529{
1530 return snd_pcm_hw_rule_add(runtime, SNDRV_PCM_HW_PARAMS_NORESAMPLE,
1531 SNDRV_PCM_HW_PARAM_RATE,
1532 snd_pcm_hw_rule_noresample_func,
1533 (void *)(uintptr_t)base_rate,
1534 SNDRV_PCM_HW_PARAM_RATE, -1);
1535}
1536EXPORT_SYMBOL(snd_pcm_hw_rule_noresample);
1537
Takashi Iwai877211f2005-11-17 13:59:38 +01001538static void _snd_pcm_hw_param_any(struct snd_pcm_hw_params *params,
Adrian Bunk123992f2005-05-18 18:02:04 +02001539 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
1541 if (hw_is_mask(var)) {
1542 snd_mask_any(hw_param_mask(params, var));
1543 params->cmask |= 1 << var;
1544 params->rmask |= 1 << var;
1545 return;
1546 }
1547 if (hw_is_interval(var)) {
1548 snd_interval_any(hw_param_interval(params, var));
1549 params->cmask |= 1 << var;
1550 params->rmask |= 1 << var;
1551 return;
1552 }
1553 snd_BUG();
1554}
1555
Takashi Iwai877211f2005-11-17 13:59:38 +01001556void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
1558 unsigned int k;
1559 memset(params, 0, sizeof(*params));
1560 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++)
1561 _snd_pcm_hw_param_any(params, k);
1562 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
1563 _snd_pcm_hw_param_any(params, k);
1564 params->info = ~0U;
1565}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001566EXPORT_SYMBOL(_snd_pcm_hw_params_any);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001569 * snd_pcm_hw_param_value - return @params field @var value
Takashi Iwaidf8db932005-09-07 13:38:19 +02001570 * @params: the hw_params instance
1571 * @var: parameter to retrieve
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001572 * @dir: pointer to the direction (-1,0,1) or %NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001574 * Return: The value for field @var if it's fixed in configuration space
1575 * defined by @params. -%EINVAL otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 */
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001577int snd_pcm_hw_param_value(const struct snd_pcm_hw_params *params,
1578 snd_pcm_hw_param_t var, int *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579{
1580 if (hw_is_mask(var)) {
Takashi Iwai877211f2005-11-17 13:59:38 +01001581 const struct snd_mask *mask = hw_param_mask_c(params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 if (!snd_mask_single(mask))
1583 return -EINVAL;
1584 if (dir)
1585 *dir = 0;
1586 return snd_mask_value(mask);
1587 }
1588 if (hw_is_interval(var)) {
Takashi Iwai877211f2005-11-17 13:59:38 +01001589 const struct snd_interval *i = hw_param_interval_c(params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 if (!snd_interval_single(i))
1591 return -EINVAL;
1592 if (dir)
1593 *dir = i->openmin;
1594 return snd_interval_value(i);
1595 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 return -EINVAL;
1597}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001598EXPORT_SYMBOL(snd_pcm_hw_param_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Takashi Iwai877211f2005-11-17 13:59:38 +01001600void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 snd_pcm_hw_param_t var)
1602{
1603 if (hw_is_mask(var)) {
1604 snd_mask_none(hw_param_mask(params, var));
1605 params->cmask |= 1 << var;
1606 params->rmask |= 1 << var;
1607 } else if (hw_is_interval(var)) {
1608 snd_interval_none(hw_param_interval(params, var));
1609 params->cmask |= 1 << var;
1610 params->rmask |= 1 << var;
1611 } else {
1612 snd_BUG();
1613 }
1614}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001615EXPORT_SYMBOL(_snd_pcm_hw_param_setempty);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001616
Takashi Iwai877211f2005-11-17 13:59:38 +01001617static int _snd_pcm_hw_param_first(struct snd_pcm_hw_params *params,
Adrian Bunk123992f2005-05-18 18:02:04 +02001618 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
1620 int changed;
1621 if (hw_is_mask(var))
1622 changed = snd_mask_refine_first(hw_param_mask(params, var));
1623 else if (hw_is_interval(var))
1624 changed = snd_interval_refine_first(hw_param_interval(params, var));
Takashi Iwai2f4ca8e2006-04-28 15:13:40 +02001625 else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 return -EINVAL;
Takashi Iwai7a0a8712018-01-02 11:00:57 +01001627 if (changed > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 params->cmask |= 1 << var;
1629 params->rmask |= 1 << var;
1630 }
1631 return changed;
1632}
1633
1634
1635/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001636 * snd_pcm_hw_param_first - refine config space and return minimum value
Takashi Iwaidf8db932005-09-07 13:38:19 +02001637 * @pcm: PCM instance
1638 * @params: the hw_params instance
1639 * @var: parameter to retrieve
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001640 * @dir: pointer to the direction (-1,0,1) or %NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001642 * Inside configuration space defined by @params remove from @var all
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 * values > minimum. Reduce configuration space accordingly.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001644 *
1645 * Return: The minimum, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 */
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001647int snd_pcm_hw_param_first(struct snd_pcm_substream *pcm,
1648 struct snd_pcm_hw_params *params,
1649 snd_pcm_hw_param_t var, int *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
1651 int changed = _snd_pcm_hw_param_first(params, var);
1652 if (changed < 0)
1653 return changed;
1654 if (params->rmask) {
1655 int err = snd_pcm_hw_refine(pcm, params);
Takashi Iwaife08f342018-01-01 09:50:50 +01001656 if (err < 0)
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001657 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 }
1659 return snd_pcm_hw_param_value(params, var, dir);
1660}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001661EXPORT_SYMBOL(snd_pcm_hw_param_first);
1662
Takashi Iwai877211f2005-11-17 13:59:38 +01001663static int _snd_pcm_hw_param_last(struct snd_pcm_hw_params *params,
Adrian Bunk123992f2005-05-18 18:02:04 +02001664 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665{
1666 int changed;
1667 if (hw_is_mask(var))
1668 changed = snd_mask_refine_last(hw_param_mask(params, var));
1669 else if (hw_is_interval(var))
1670 changed = snd_interval_refine_last(hw_param_interval(params, var));
Takashi Iwai2f4ca8e2006-04-28 15:13:40 +02001671 else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 return -EINVAL;
Takashi Iwai7a0a8712018-01-02 11:00:57 +01001673 if (changed > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 params->cmask |= 1 << var;
1675 params->rmask |= 1 << var;
1676 }
1677 return changed;
1678}
1679
1680
1681/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001682 * snd_pcm_hw_param_last - refine config space and return maximum value
Takashi Iwaidf8db932005-09-07 13:38:19 +02001683 * @pcm: PCM instance
1684 * @params: the hw_params instance
1685 * @var: parameter to retrieve
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001686 * @dir: pointer to the direction (-1,0,1) or %NULL
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001688 * Inside configuration space defined by @params remove from @var all
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 * values < maximum. Reduce configuration space accordingly.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001690 *
1691 * Return: The maximum, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 */
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001693int snd_pcm_hw_param_last(struct snd_pcm_substream *pcm,
1694 struct snd_pcm_hw_params *params,
1695 snd_pcm_hw_param_t var, int *dir)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696{
1697 int changed = _snd_pcm_hw_param_last(params, var);
1698 if (changed < 0)
1699 return changed;
1700 if (params->rmask) {
1701 int err = snd_pcm_hw_refine(pcm, params);
Takashi Iwaife08f342018-01-01 09:50:50 +01001702 if (err < 0)
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001703 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704 }
1705 return snd_pcm_hw_param_value(params, var, dir);
1706}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001707EXPORT_SYMBOL(snd_pcm_hw_param_last);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
Takashi Iwai877211f2005-11-17 13:59:38 +01001709static int snd_pcm_lib_ioctl_reset(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 void *arg)
1711{
Takashi Iwai877211f2005-11-17 13:59:38 +01001712 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 unsigned long flags;
1714 snd_pcm_stream_lock_irqsave(substream, flags);
1715 if (snd_pcm_running(substream) &&
1716 snd_pcm_update_hw_ptr(substream) >= 0)
1717 runtime->status->hw_ptr %= runtime->buffer_size;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -05001718 else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 runtime->status->hw_ptr = 0;
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -05001720 runtime->hw_ptr_wrap = 0;
1721 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 snd_pcm_stream_unlock_irqrestore(substream, flags);
1723 return 0;
1724}
1725
Takashi Iwai877211f2005-11-17 13:59:38 +01001726static int snd_pcm_lib_ioctl_channel_info(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 void *arg)
1728{
Takashi Iwai877211f2005-11-17 13:59:38 +01001729 struct snd_pcm_channel_info *info = arg;
1730 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 int width;
1732 if (!(runtime->info & SNDRV_PCM_INFO_MMAP)) {
1733 info->offset = -1;
1734 return 0;
1735 }
1736 width = snd_pcm_format_physical_width(runtime->format);
1737 if (width < 0)
1738 return width;
1739 info->offset = 0;
1740 switch (runtime->access) {
1741 case SNDRV_PCM_ACCESS_MMAP_INTERLEAVED:
1742 case SNDRV_PCM_ACCESS_RW_INTERLEAVED:
1743 info->first = info->channel * width;
1744 info->step = runtime->channels * width;
1745 break;
1746 case SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED:
1747 case SNDRV_PCM_ACCESS_RW_NONINTERLEAVED:
1748 {
1749 size_t size = runtime->dma_bytes / runtime->channels;
1750 info->first = info->channel * size * 8;
1751 info->step = width;
1752 break;
1753 }
1754 default:
1755 snd_BUG();
1756 break;
1757 }
1758 return 0;
1759}
1760
Jaroslav Kysela8bea8692009-04-27 09:44:40 +02001761static int snd_pcm_lib_ioctl_fifo_size(struct snd_pcm_substream *substream,
1762 void *arg)
1763{
1764 struct snd_pcm_hw_params *params = arg;
1765 snd_pcm_format_t format;
Clemens Ladischa9960e62014-09-21 22:50:57 +02001766 int channels;
1767 ssize_t frame_size;
Jaroslav Kysela8bea8692009-04-27 09:44:40 +02001768
1769 params->fifo_size = substream->runtime->hw.fifo_size;
1770 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_FIFO_IN_FRAMES)) {
1771 format = params_format(params);
1772 channels = params_channels(params);
Clemens Ladischa9960e62014-09-21 22:50:57 +02001773 frame_size = snd_pcm_format_size(format, channels);
1774 if (frame_size > 0)
Zubin Mithraf3eef462021-08-27 08:37:35 -07001775 params->fifo_size /= frame_size;
Jaroslav Kysela8bea8692009-04-27 09:44:40 +02001776 }
1777 return 0;
1778}
1779
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780/**
1781 * snd_pcm_lib_ioctl - a generic PCM ioctl callback
1782 * @substream: the pcm substream instance
1783 * @cmd: ioctl command
1784 * @arg: ioctl argument
1785 *
1786 * Processes the generic ioctl commands for PCM.
1787 * Can be passed as the ioctl callback for PCM ops.
1788 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001789 * Return: Zero if successful, or a negative error code on failure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001791int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 unsigned int cmd, void *arg)
1793{
1794 switch (cmd) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 case SNDRV_PCM_IOCTL1_RESET:
1796 return snd_pcm_lib_ioctl_reset(substream, arg);
1797 case SNDRV_PCM_IOCTL1_CHANNEL_INFO:
1798 return snd_pcm_lib_ioctl_channel_info(substream, arg);
Jaroslav Kysela8bea8692009-04-27 09:44:40 +02001799 case SNDRV_PCM_IOCTL1_FIFO_SIZE:
1800 return snd_pcm_lib_ioctl_fifo_size(substream, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
1802 return -ENXIO;
1803}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001804EXPORT_SYMBOL(snd_pcm_lib_ioctl);
1805
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806/**
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001807 * snd_pcm_period_elapsed_under_stream_lock() - update the status of runtime for the next period
1808 * under acquired lock of PCM substream.
1809 * @substream: the instance of pcm substream.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 *
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001811 * This function is called when the batch of audio data frames as the same size as the period of
1812 * buffer is already processed in audio data transmission.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 *
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001814 * The call of function updates the status of runtime with the latest position of audio data
1815 * transmission, checks overrun and underrun over buffer, awaken user processes from waiting for
1816 * available audio data frames, sampling audio timestamp, and performs stop or drain the PCM
1817 * substream according to configured threshold.
1818 *
1819 * The function is intended to use for the case that PCM driver operates audio data frames under
1820 * acquired lock of PCM substream; e.g. in callback of any operation of &snd_pcm_ops in process
1821 * context. In any interrupt context, it's preferrable to use ``snd_pcm_period_elapsed()`` instead
1822 * since lock of PCM substream should be acquired in advance.
1823 *
1824 * Developer should pay enough attention that some callbacks in &snd_pcm_ops are done by the call of
1825 * function:
1826 *
1827 * - .pointer - to retrieve current position of audio data transmission by frame count or XRUN state.
1828 * - .trigger - with SNDRV_PCM_TRIGGER_STOP at XRUN or DRAINING state.
1829 * - .get_time_info - to retrieve audio time stamp if needed.
1830 *
1831 * Even if more than one periods have elapsed since the last call, you have to call this only once.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832 */
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001833void snd_pcm_period_elapsed_under_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834{
Takashi Iwai877211f2005-11-17 13:59:38 +01001835 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836
paulhsiaf5cdc9d2019-11-13 01:17:14 +08001837 if (PCM_RUNTIME_CHECK(substream))
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001838 return;
paulhsiaf5cdc9d2019-11-13 01:17:14 +08001839 runtime = substream->runtime;
1840
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 if (!snd_pcm_running(substream) ||
Jaroslav Kyselaf2404062010-01-05 17:19:34 +01001842 snd_pcm_update_hw_ptr0(substream, 1) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 goto _end;
1844
Jie Yang90bbaf62015-10-16 17:57:46 +08001845#ifdef CONFIG_SND_PCM_TIMER
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846 if (substream->timer_running)
1847 snd_timer_interrupt(substream->timer, 1);
Jie Yang90bbaf62015-10-16 17:57:46 +08001848#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 _end:
Takashi Iwai96b09702022-07-28 14:59:44 +02001850 snd_kill_fasync(runtime->fasync, SIGIO, POLL_IN);
Takashi Sakamoto47271b12021-06-10 12:17:31 +09001851}
1852EXPORT_SYMBOL(snd_pcm_period_elapsed_under_stream_lock);
1853
1854/**
1855 * snd_pcm_period_elapsed() - update the status of runtime for the next period by acquiring lock of
1856 * PCM substream.
1857 * @substream: the instance of PCM substream.
1858 *
1859 * This function is mostly similar to ``snd_pcm_period_elapsed_under_stream_lock()`` except for
1860 * acquiring lock of PCM substream voluntarily.
1861 *
1862 * It's typically called by any type of IRQ handler when hardware IRQ occurs to notify event that
1863 * the batch of audio data frames as the same size as the period of buffer is already processed in
1864 * audio data transmission.
1865 */
1866void snd_pcm_period_elapsed(struct snd_pcm_substream *substream)
1867{
1868 unsigned long flags;
1869
1870 if (snd_BUG_ON(!substream))
1871 return;
1872
1873 snd_pcm_stream_lock_irqsave(substream, flags);
1874 snd_pcm_period_elapsed_under_stream_lock(substream);
Takashi Iwai3aa02cb2016-04-14 18:02:37 +02001875 snd_pcm_stream_unlock_irqrestore(substream, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001877EXPORT_SYMBOL(snd_pcm_period_elapsed);
1878
Takashi Iwai13075512008-01-08 18:08:14 +01001879/*
1880 * Wait until avail_min data becomes available
1881 * Returns a negative error code if any error occurs during operation.
1882 * The available space is stored on availp. When err = 0 and avail = 0
1883 * on the capture stream, it indicates the stream is in DRAINING state.
1884 */
David Dillow5daeba32010-06-27 00:13:20 +02001885static int wait_for_avail(struct snd_pcm_substream *substream,
Takashi Iwai13075512008-01-08 18:08:14 +01001886 snd_pcm_uframes_t *availp)
1887{
1888 struct snd_pcm_runtime *runtime = substream->runtime;
1889 int is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001890 wait_queue_entry_t wait;
Takashi Iwai13075512008-01-08 18:08:14 +01001891 int err = 0;
1892 snd_pcm_uframes_t avail = 0;
Takashi Iwaif2b36142011-05-26 08:09:38 +02001893 long wait_time, tout;
Takashi Iwai13075512008-01-08 18:08:14 +01001894
Arjan van de Ven763437a2011-09-15 08:49:25 +02001895 init_waitqueue_entry(&wait, current);
1896 set_current_state(TASK_INTERRUPTIBLE);
1897 add_wait_queue(&runtime->tsleep, &wait);
1898
Takashi Iwaif2b36142011-05-26 08:09:38 +02001899 if (runtime->no_period_wakeup)
1900 wait_time = MAX_SCHEDULE_TIMEOUT;
1901 else {
Liam Girdwoodd64c5cf2018-07-06 13:50:36 +01001902 /* use wait time from substream if available */
1903 if (substream->wait_time) {
1904 wait_time = substream->wait_time;
1905 } else {
Oswald Buddenhagen3ed2b542023-04-05 22:12:19 +02001906 wait_time = 100;
Liam Girdwoodd64c5cf2018-07-06 13:50:36 +01001907
1908 if (runtime->rate) {
Oswald Buddenhagen3ed2b542023-04-05 22:12:19 +02001909 long t = runtime->buffer_size * 1100 / runtime->rate;
Liam Girdwoodd64c5cf2018-07-06 13:50:36 +01001910 wait_time = max(t, wait_time);
1911 }
Takashi Iwaif2b36142011-05-26 08:09:38 +02001912 }
Oswald Buddenhagen3ed2b542023-04-05 22:12:19 +02001913 wait_time = msecs_to_jiffies(wait_time);
Takashi Iwaif2b36142011-05-26 08:09:38 +02001914 }
Arjan van de Ven763437a2011-09-15 08:49:25 +02001915
Takashi Iwai13075512008-01-08 18:08:14 +01001916 for (;;) {
1917 if (signal_pending(current)) {
1918 err = -ERESTARTSYS;
1919 break;
1920 }
Arjan van de Ven763437a2011-09-15 08:49:25 +02001921
1922 /*
1923 * We need to check if space became available already
1924 * (and thus the wakeup happened already) first to close
1925 * the race of space already having become available.
1926 * This check must happen after been added to the waitqueue
1927 * and having current state be INTERRUPTIBLE.
1928 */
Takashi Iwai763e5062018-04-11 17:56:52 +02001929 avail = snd_pcm_avail(substream);
Arjan van de Ven763437a2011-09-15 08:49:25 +02001930 if (avail >= runtime->twake)
1931 break;
Takashi Iwai13075512008-01-08 18:08:14 +01001932 snd_pcm_stream_unlock_irq(substream);
Arjan van de Ven763437a2011-09-15 08:49:25 +02001933
1934 tout = schedule_timeout(wait_time);
1935
Takashi Iwai13075512008-01-08 18:08:14 +01001936 snd_pcm_stream_lock_irq(substream);
Arjan van de Ven763437a2011-09-15 08:49:25 +02001937 set_current_state(TASK_INTERRUPTIBLE);
Takashi Iwaif0061c12022-09-26 15:55:48 +02001938 switch (runtime->state) {
Takashi Iwai13075512008-01-08 18:08:14 +01001939 case SNDRV_PCM_STATE_SUSPENDED:
1940 err = -ESTRPIPE;
1941 goto _endloop;
1942 case SNDRV_PCM_STATE_XRUN:
1943 err = -EPIPE;
1944 goto _endloop;
1945 case SNDRV_PCM_STATE_DRAINING:
1946 if (is_playback)
1947 err = -EPIPE;
1948 else
1949 avail = 0; /* indicate draining */
1950 goto _endloop;
1951 case SNDRV_PCM_STATE_OPEN:
1952 case SNDRV_PCM_STATE_SETUP:
1953 case SNDRV_PCM_STATE_DISCONNECTED:
1954 err = -EBADFD;
1955 goto _endloop;
JongHo Kimed697e12013-12-17 23:02:24 +09001956 case SNDRV_PCM_STATE_PAUSED:
1957 continue;
Takashi Iwai13075512008-01-08 18:08:14 +01001958 }
1959 if (!tout) {
Takashi Iwai09e56df2014-02-04 18:19:48 +01001960 pcm_dbg(substream->pcm,
Oswald Buddenhagen3ed2b542023-04-05 22:12:19 +02001961 "%s timeout (DMA or IRQ trouble?)\n",
1962 is_playback ? "playback write" : "capture read");
Takashi Iwai13075512008-01-08 18:08:14 +01001963 err = -EIO;
1964 break;
1965 }
Takashi Iwai13075512008-01-08 18:08:14 +01001966 }
1967 _endloop:
Arjan van de Ven763437a2011-09-15 08:49:25 +02001968 set_current_state(TASK_RUNNING);
Jaroslav Kyselac91a9882010-01-21 10:32:15 +01001969 remove_wait_queue(&runtime->tsleep, &wait);
Takashi Iwai13075512008-01-08 18:08:14 +01001970 *availp = avail;
1971 return err;
1972}
1973
Takashi Iwai9f600632017-05-24 18:15:26 +02001974typedef int (*pcm_transfer_f)(struct snd_pcm_substream *substream,
1975 int channel, unsigned long hwoff,
1976 void *buf, unsigned long bytes);
Takashi Iwaibdc4acf2017-05-24 17:59:17 +02001977
Takashi Iwai9f600632017-05-24 18:15:26 +02001978typedef int (*pcm_copy_f)(struct snd_pcm_substream *, snd_pcm_uframes_t, void *,
1979 snd_pcm_uframes_t, snd_pcm_uframes_t, pcm_transfer_f);
1980
1981/* calculate the target DMA-buffer position to be written/read */
1982static void *get_dma_ptr(struct snd_pcm_runtime *runtime,
1983 int channel, unsigned long hwoff)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984{
Takashi Iwai9f600632017-05-24 18:15:26 +02001985 return runtime->dma_area + hwoff +
1986 channel * (runtime->dma_bytes / runtime->channels);
1987}
1988
Takashi Iwai5c7264c2017-05-24 22:36:23 +02001989/* default copy_user ops for write; used for both interleaved and non- modes */
1990static int default_write_copy(struct snd_pcm_substream *substream,
1991 int channel, unsigned long hwoff,
1992 void *buf, unsigned long bytes)
Takashi Iwai9f600632017-05-24 18:15:26 +02001993{
1994 if (copy_from_user(get_dma_ptr(substream->runtime, channel, hwoff),
Takashi Iwai5c7264c2017-05-24 22:36:23 +02001995 (void __user *)buf, bytes))
Takashi Iwai9f600632017-05-24 18:15:26 +02001996 return -EFAULT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 return 0;
1998}
Takashi Iwai9f600632017-05-24 18:15:26 +02001999
Takashi Iwai68541212017-05-24 18:23:20 +02002000/* default copy_kernel ops for write */
2001static int default_write_copy_kernel(struct snd_pcm_substream *substream,
2002 int channel, unsigned long hwoff,
2003 void *buf, unsigned long bytes)
2004{
2005 memcpy(get_dma_ptr(substream->runtime, channel, hwoff), buf, bytes);
2006 return 0;
2007}
2008
Takashi Iwai9f600632017-05-24 18:15:26 +02002009/* fill silence instead of copy data; called as a transfer helper
2010 * from __snd_pcm_lib_write() or directly from noninterleaved_copy() when
2011 * a NULL buffer is passed
2012 */
2013static int fill_silence(struct snd_pcm_substream *substream, int channel,
2014 unsigned long hwoff, void *buf, unsigned long bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015{
2016 struct snd_pcm_runtime *runtime = substream->runtime;
Takashi Iwaibdc4acf2017-05-24 17:59:17 +02002017
Takashi Iwai9f600632017-05-24 18:15:26 +02002018 if (substream->stream != SNDRV_PCM_STREAM_PLAYBACK)
2019 return 0;
2020 if (substream->ops->fill_silence)
2021 return substream->ops->fill_silence(substream, channel,
2022 hwoff, bytes);
2023
2024 snd_pcm_format_set_silence(runtime->format,
2025 get_dma_ptr(runtime, channel, hwoff),
2026 bytes_to_samples(runtime, bytes));
2027 return 0;
2028}
2029
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002030/* default copy_user ops for read; used for both interleaved and non- modes */
2031static int default_read_copy(struct snd_pcm_substream *substream,
2032 int channel, unsigned long hwoff,
2033 void *buf, unsigned long bytes)
2034{
2035 if (copy_to_user((void __user *)buf,
2036 get_dma_ptr(substream->runtime, channel, hwoff),
2037 bytes))
2038 return -EFAULT;
2039 return 0;
2040}
2041
Takashi Iwai68541212017-05-24 18:23:20 +02002042/* default copy_kernel ops for read */
2043static int default_read_copy_kernel(struct snd_pcm_substream *substream,
2044 int channel, unsigned long hwoff,
2045 void *buf, unsigned long bytes)
2046{
2047 memcpy(buf, get_dma_ptr(substream->runtime, channel, hwoff), bytes);
2048 return 0;
2049}
2050
Takashi Iwai9f600632017-05-24 18:15:26 +02002051/* call transfer function with the converted pointers and sizes;
2052 * for interleaved mode, it's one shot for all samples
2053 */
2054static int interleaved_copy(struct snd_pcm_substream *substream,
2055 snd_pcm_uframes_t hwoff, void *data,
2056 snd_pcm_uframes_t off,
2057 snd_pcm_uframes_t frames,
2058 pcm_transfer_f transfer)
2059{
2060 struct snd_pcm_runtime *runtime = substream->runtime;
2061
2062 /* convert to bytes */
2063 hwoff = frames_to_bytes(runtime, hwoff);
2064 off = frames_to_bytes(runtime, off);
2065 frames = frames_to_bytes(runtime, frames);
2066 return transfer(substream, 0, hwoff, data + off, frames);
2067}
2068
2069/* call transfer function with the converted pointers and sizes for each
2070 * non-interleaved channel; when buffer is NULL, silencing instead of copying
2071 */
2072static int noninterleaved_copy(struct snd_pcm_substream *substream,
2073 snd_pcm_uframes_t hwoff, void *data,
2074 snd_pcm_uframes_t off,
2075 snd_pcm_uframes_t frames,
2076 pcm_transfer_f transfer)
2077{
2078 struct snd_pcm_runtime *runtime = substream->runtime;
2079 int channels = runtime->channels;
2080 void **bufs = data;
2081 int c, err;
2082
2083 /* convert to bytes; note that it's not frames_to_bytes() here.
2084 * in non-interleaved mode, we copy for each channel, thus
2085 * each copy is n_samples bytes x channels = whole frames.
2086 */
2087 off = samples_to_bytes(runtime, off);
2088 frames = samples_to_bytes(runtime, frames);
2089 hwoff = samples_to_bytes(runtime, hwoff);
2090 for (c = 0; c < channels; ++c, ++bufs) {
2091 if (!data || !*bufs)
2092 err = fill_silence(substream, c, hwoff, NULL, frames);
2093 else
2094 err = transfer(substream, c, hwoff, *bufs + off,
2095 frames);
2096 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 }
2099 return 0;
2100}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
Takashi Iwaia9cd29e2017-05-24 18:18:15 +02002102/* fill silence on the given buffer position;
2103 * called from snd_pcm_playback_silence()
2104 */
2105static int fill_silence_frames(struct snd_pcm_substream *substream,
2106 snd_pcm_uframes_t off, snd_pcm_uframes_t frames)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107{
Takashi Iwaia9cd29e2017-05-24 18:18:15 +02002108 if (substream->runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
2109 substream->runtime->access == SNDRV_PCM_ACCESS_MMAP_INTERLEAVED)
2110 return interleaved_copy(substream, off, NULL, 0, frames,
2111 fill_silence);
2112 else
2113 return noninterleaved_copy(substream, off, NULL, 0, frames,
2114 fill_silence);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115}
2116
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002117/* sanity-check for read/write methods */
2118static int pcm_sanity_check(struct snd_pcm_substream *substream)
2119{
2120 struct snd_pcm_runtime *runtime;
2121 if (PCM_RUNTIME_CHECK(substream))
2122 return -ENXIO;
2123 runtime = substream->runtime;
Takashi Iwaibdc4acf2017-05-24 17:59:17 +02002124 if (snd_BUG_ON(!substream->ops->copy_user && !runtime->dma_area))
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002125 return -EINVAL;
Takashi Iwaif0061c12022-09-26 15:55:48 +02002126 if (runtime->state == SNDRV_PCM_STATE_OPEN)
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002127 return -EBADFD;
2128 return 0;
2129}
2130
Takashi Iwai6ba63922017-05-24 17:51:30 +02002131static int pcm_accessible_state(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132{
Takashi Iwaif0061c12022-09-26 15:55:48 +02002133 switch (runtime->state) {
Takashi Iwai6ba63922017-05-24 17:51:30 +02002134 case SNDRV_PCM_STATE_PREPARED:
2135 case SNDRV_PCM_STATE_RUNNING:
2136 case SNDRV_PCM_STATE_PAUSED:
2137 return 0;
2138 case SNDRV_PCM_STATE_XRUN:
2139 return -EPIPE;
2140 case SNDRV_PCM_STATE_SUSPENDED:
2141 return -ESTRPIPE;
2142 default:
2143 return -EBADFD;
2144 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145}
2146
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002147/* update to the given appl_ptr and call ack callback if needed;
2148 * when an error is returned, take back to the original value
2149 */
2150int pcm_lib_apply_appl_ptr(struct snd_pcm_substream *substream,
2151 snd_pcm_uframes_t appl_ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152{
Takashi Iwai877211f2005-11-17 13:59:38 +01002153 struct snd_pcm_runtime *runtime = substream->runtime;
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002154 snd_pcm_uframes_t old_appl_ptr = runtime->control->appl_ptr;
Pierre-Louis Bossartb456abe2021-11-19 17:08:50 -06002155 snd_pcm_sframes_t diff;
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002156 int ret;
2157
Takashi Iwaif8ff2f22017-06-13 15:57:28 +02002158 if (old_appl_ptr == appl_ptr)
2159 return 0;
2160
Pierre-Louis Bossart0e888a72021-11-19 17:08:49 -06002161 if (appl_ptr >= runtime->boundary)
2162 return -EINVAL;
Pierre-Louis Bossartb456abe2021-11-19 17:08:50 -06002163 /*
2164 * check if a rewind is requested by the application
2165 */
2166 if (substream->runtime->info & SNDRV_PCM_INFO_NO_REWINDS) {
2167 diff = appl_ptr - old_appl_ptr;
2168 if (diff >= 0) {
2169 if (diff > runtime->buffer_size)
2170 return -EINVAL;
2171 } else {
2172 if (runtime->boundary + diff > runtime->buffer_size)
2173 return -EINVAL;
2174 }
2175 }
Pierre-Louis Bossart0e888a72021-11-19 17:08:49 -06002176
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002177 runtime->control->appl_ptr = appl_ptr;
2178 if (substream->ops->ack) {
2179 ret = substream->ops->ack(substream);
2180 if (ret < 0) {
2181 runtime->control->appl_ptr = old_appl_ptr;
Takashi Iwai8c721c52023-03-20 15:28:38 +01002182 if (ret == -EPIPE)
2183 __snd_pcm_xrun(substream);
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002184 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 }
2186 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187
Takashi Sakamotofccf5382017-06-12 09:41:45 +09002188 trace_applptr(substream, old_appl_ptr, appl_ptr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 return 0;
2191}
2192
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002193/* the common loop for read/write data */
2194snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
2195 void *data, bool interleaved,
Takashi Iwai68541212017-05-24 18:23:20 +02002196 snd_pcm_uframes_t size, bool in_kernel)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197{
Takashi Iwai877211f2005-11-17 13:59:38 +01002198 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199 snd_pcm_uframes_t xfer = 0;
2200 snd_pcm_uframes_t offset = 0;
Takashi Iwai0910c212012-05-11 17:50:49 +02002201 snd_pcm_uframes_t avail;
Takashi Iwai9f600632017-05-24 18:15:26 +02002202 pcm_copy_f writer;
2203 pcm_transfer_f transfer;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002204 bool nonblock;
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002205 bool is_playback;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002206 int err;
2207
2208 err = pcm_sanity_check(substream);
2209 if (err < 0)
2210 return err;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002211
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002212 is_playback = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002213 if (interleaved) {
2214 if (runtime->access != SNDRV_PCM_ACCESS_RW_INTERLEAVED &&
2215 runtime->channels > 1)
2216 return -EINVAL;
Takashi Iwai9f600632017-05-24 18:15:26 +02002217 writer = interleaved_copy;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002218 } else {
2219 if (runtime->access != SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
2220 return -EINVAL;
Takashi Iwai9f600632017-05-24 18:15:26 +02002221 writer = noninterleaved_copy;
2222 }
2223
2224 if (!data) {
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002225 if (is_playback)
2226 transfer = fill_silence;
2227 else
2228 return -EINVAL;
Takashi Iwai68541212017-05-24 18:23:20 +02002229 } else if (in_kernel) {
2230 if (substream->ops->copy_kernel)
2231 transfer = substream->ops->copy_kernel;
2232 else
2233 transfer = is_playback ?
2234 default_write_copy_kernel : default_read_copy_kernel;
Takashi Iwai9f600632017-05-24 18:15:26 +02002235 } else {
2236 if (substream->ops->copy_user)
2237 transfer = (pcm_transfer_f)substream->ops->copy_user;
2238 else
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002239 transfer = is_playback ?
2240 default_write_copy : default_read_copy;
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002241 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242
2243 if (size == 0)
2244 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
Takashi Iwaic48f12ee2017-05-21 09:35:21 +02002246 nonblock = !!(substream->f_flags & O_NONBLOCK);
2247
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 snd_pcm_stream_lock_irq(substream);
Takashi Iwai6ba63922017-05-24 17:51:30 +02002249 err = pcm_accessible_state(runtime);
2250 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 goto _end_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252
Ricardo Biehl Pasquali64b6acf2018-09-07 16:58:54 -03002253 runtime->twake = runtime->control->avail_min ? : 1;
Takashi Iwaif0061c12022-09-26 15:55:48 +02002254 if (runtime->state == SNDRV_PCM_STATE_RUNNING)
Ricardo Biehl Pasquali64b6acf2018-09-07 16:58:54 -03002255 snd_pcm_update_hw_ptr(substream);
2256
Ricardo Biehl Pasquali932a8152019-02-13 00:57:51 -02002257 /*
2258 * If size < start_threshold, wait indefinitely. Another
2259 * thread may start capture
2260 */
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002261 if (!is_playback &&
Takashi Iwaif0061c12022-09-26 15:55:48 +02002262 runtime->state == SNDRV_PCM_STATE_PREPARED &&
Takashi Iwai00a399c2019-02-06 07:30:44 +01002263 size >= runtime->start_threshold) {
2264 err = snd_pcm_start(substream);
2265 if (err < 0)
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002266 goto _end_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 }
2268
Takashi Iwai763e5062018-04-11 17:56:52 +02002269 avail = snd_pcm_avail(substream);
Ricardo Biehl Pasquali64b6acf2018-09-07 16:58:54 -03002270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271 while (size > 0) {
2272 snd_pcm_uframes_t frames, appl_ptr, appl_ofs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 snd_pcm_uframes_t cont;
Takashi Iwai13075512008-01-08 18:08:14 +01002274 if (!avail) {
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002275 if (!is_playback &&
Takashi Iwaif0061c12022-09-26 15:55:48 +02002276 runtime->state == SNDRV_PCM_STATE_DRAINING) {
Takashi Iwai13075512008-01-08 18:08:14 +01002277 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 goto _end_unlock;
2279 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 if (nonblock) {
2281 err = -EAGAIN;
2282 goto _end_unlock;
2283 }
David Dillow5daeba32010-06-27 00:13:20 +02002284 runtime->twake = min_t(snd_pcm_uframes_t, size,
2285 runtime->control->avail_min ? : 1);
2286 err = wait_for_avail(substream, &avail);
Takashi Iwai13075512008-01-08 18:08:14 +01002287 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002288 goto _end_unlock;
Takashi Iwai13075512008-01-08 18:08:14 +01002289 if (!avail)
2290 continue; /* draining */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 frames = size > avail ? avail : size;
Takashi Iwaiaa30db02017-06-16 22:29:55 +02002293 appl_ptr = READ_ONCE(runtime->control->appl_ptr);
2294 appl_ofs = appl_ptr % runtime->buffer_size;
2295 cont = runtime->buffer_size - appl_ofs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 if (frames > cont)
2297 frames = cont;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002298 if (snd_BUG_ON(!frames)) {
Takashi Iwai315d9f12019-01-25 17:31:59 +01002299 err = -EINVAL;
2300 goto _end_unlock;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002301 }
Takashi Iwaibc55cfd2022-03-30 14:09:03 +02002302 if (!atomic_inc_unless_negative(&runtime->buffer_accessing)) {
2303 err = -EBUSY;
2304 goto _end_unlock;
2305 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 snd_pcm_stream_unlock_irq(substream);
Takashi Iwaia25684a2021-10-17 09:48:57 +02002307 if (!is_playback)
2308 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
Takashi Iwai9f600632017-05-24 18:15:26 +02002309 err = writer(substream, appl_ofs, data, offset, frames,
2310 transfer);
Takashi Iwaia25684a2021-10-17 09:48:57 +02002311 if (is_playback)
2312 snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 snd_pcm_stream_lock_irq(substream);
Takashi Iwaibc55cfd2022-03-30 14:09:03 +02002314 atomic_dec(&runtime->buffer_accessing);
Jaroslav Kysela12509322010-01-07 15:36:31 +01002315 if (err < 0)
2316 goto _end_unlock;
Takashi Iwai6ba63922017-05-24 17:51:30 +02002317 err = pcm_accessible_state(runtime);
2318 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319 goto _end_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 appl_ptr += frames;
2321 if (appl_ptr >= runtime->boundary)
2322 appl_ptr -= runtime->boundary;
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002323 err = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2324 if (err < 0)
2325 goto _end_unlock;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002326
2327 offset += frames;
2328 size -= frames;
2329 xfer += frames;
Takashi Iwai0910c212012-05-11 17:50:49 +02002330 avail -= frames;
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002331 if (is_playback &&
Takashi Iwaif0061c12022-09-26 15:55:48 +02002332 runtime->state == SNDRV_PCM_STATE_PREPARED &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002333 snd_pcm_playback_hw_avail(runtime) >= (snd_pcm_sframes_t)runtime->start_threshold) {
2334 err = snd_pcm_start(substream);
2335 if (err < 0)
2336 goto _end_unlock;
2337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 }
2339 _end_unlock:
Jaroslav Kyselac91a9882010-01-21 10:32:15 +01002340 runtime->twake = 0;
Jaroslav Kysela12509322010-01-07 15:36:31 +01002341 if (xfer > 0 && err >= 0)
2342 snd_pcm_update_state(substream, runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 snd_pcm_stream_unlock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 return xfer > 0 ? (snd_pcm_sframes_t)xfer : err;
2345}
Takashi Iwai5c7264c2017-05-24 22:36:23 +02002346EXPORT_SYMBOL(__snd_pcm_lib_xfer);
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002347
2348/*
2349 * standard channel mapping helpers
2350 */
2351
2352/* default channel maps for multi-channel playbacks, up to 8 channels */
2353const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[] = {
2354 { .channels = 1,
Takashi Iwai5efbc262012-09-13 14:48:46 +02002355 .map = { SNDRV_CHMAP_MONO } },
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002356 { .channels = 2,
2357 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2358 { .channels = 4,
2359 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2360 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2361 { .channels = 6,
2362 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2363 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2364 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE } },
2365 { .channels = 8,
2366 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2367 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2368 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2369 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2370 { }
2371};
2372EXPORT_SYMBOL_GPL(snd_pcm_std_chmaps);
2373
2374/* alternative channel maps with CLFE <-> surround swapped for 6/8 channels */
2375const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[] = {
2376 { .channels = 1,
Takashi Iwai5efbc262012-09-13 14:48:46 +02002377 .map = { SNDRV_CHMAP_MONO } },
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002378 { .channels = 2,
2379 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR } },
2380 { .channels = 4,
2381 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2382 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2383 { .channels = 6,
2384 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2385 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2386 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR } },
2387 { .channels = 8,
2388 .map = { SNDRV_CHMAP_FL, SNDRV_CHMAP_FR,
2389 SNDRV_CHMAP_FC, SNDRV_CHMAP_LFE,
2390 SNDRV_CHMAP_RL, SNDRV_CHMAP_RR,
2391 SNDRV_CHMAP_SL, SNDRV_CHMAP_SR } },
2392 { }
2393};
2394EXPORT_SYMBOL_GPL(snd_pcm_alt_chmaps);
2395
2396static bool valid_chmap_channels(const struct snd_pcm_chmap *info, int ch)
2397{
2398 if (ch > info->max_channels)
2399 return false;
2400 return !info->channel_mask || (info->channel_mask & (1U << ch));
2401}
2402
2403static int pcm_chmap_ctl_info(struct snd_kcontrol *kcontrol,
2404 struct snd_ctl_elem_info *uinfo)
2405{
2406 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2407
2408 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002409 uinfo->count = info->max_channels;
2410 uinfo->value.integer.min = 0;
2411 uinfo->value.integer.max = SNDRV_CHMAP_LAST;
2412 return 0;
2413}
2414
2415/* get callback for channel map ctl element
2416 * stores the channel position firstly matching with the current channels
2417 */
2418static int pcm_chmap_ctl_get(struct snd_kcontrol *kcontrol,
2419 struct snd_ctl_elem_value *ucontrol)
2420{
2421 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2422 unsigned int idx = snd_ctl_get_ioffidx(kcontrol, &ucontrol->id);
2423 struct snd_pcm_substream *substream;
2424 const struct snd_pcm_chmap_elem *map;
2425
Takashi Iwai2deaeaf2017-06-14 16:20:32 +02002426 if (!info->chmap)
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002427 return -EINVAL;
2428 substream = snd_pcm_chmap_substream(info, idx);
2429 if (!substream)
2430 return -ENODEV;
2431 memset(ucontrol->value.integer.value, 0,
Takashi Iwaifbd3eb72020-01-04 09:35:56 +01002432 sizeof(long) * info->max_channels);
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002433 if (!substream->runtime)
2434 return 0; /* no channels set */
2435 for (map = info->chmap; map->channels; map++) {
2436 int i;
2437 if (map->channels == substream->runtime->channels &&
2438 valid_chmap_channels(info, map->channels)) {
2439 for (i = 0; i < map->channels; i++)
2440 ucontrol->value.integer.value[i] = map->map[i];
2441 return 0;
2442 }
2443 }
2444 return -EINVAL;
2445}
2446
2447/* tlv callback for channel map ctl element
2448 * expands the pre-defined channel maps in a form of TLV
2449 */
2450static int pcm_chmap_ctl_tlv(struct snd_kcontrol *kcontrol, int op_flag,
2451 unsigned int size, unsigned int __user *tlv)
2452{
2453 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2454 const struct snd_pcm_chmap_elem *map;
2455 unsigned int __user *dst;
2456 int c, count = 0;
2457
Takashi Iwai2deaeaf2017-06-14 16:20:32 +02002458 if (!info->chmap)
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002459 return -EINVAL;
2460 if (size < 8)
2461 return -ENOMEM;
2462 if (put_user(SNDRV_CTL_TLVT_CONTAINER, tlv))
2463 return -EFAULT;
2464 size -= 8;
2465 dst = tlv + 2;
2466 for (map = info->chmap; map->channels; map++) {
2467 int chs_bytes = map->channels * 4;
2468 if (!valid_chmap_channels(info, map->channels))
2469 continue;
2470 if (size < 8)
2471 return -ENOMEM;
2472 if (put_user(SNDRV_CTL_TLVT_CHMAP_FIXED, dst) ||
2473 put_user(chs_bytes, dst + 1))
2474 return -EFAULT;
2475 dst += 2;
2476 size -= 8;
2477 count += 8;
2478 if (size < chs_bytes)
2479 return -ENOMEM;
2480 size -= chs_bytes;
2481 count += chs_bytes;
2482 for (c = 0; c < map->channels; c++) {
2483 if (put_user(map->map[c], dst))
2484 return -EFAULT;
2485 dst++;
2486 }
2487 }
2488 if (put_user(count, tlv + 1))
2489 return -EFAULT;
2490 return 0;
2491}
2492
2493static void pcm_chmap_ctl_private_free(struct snd_kcontrol *kcontrol)
2494{
2495 struct snd_pcm_chmap *info = snd_kcontrol_chip(kcontrol);
2496 info->pcm->streams[info->stream].chmap_kctl = NULL;
2497 kfree(info);
2498}
2499
2500/**
2501 * snd_pcm_add_chmap_ctls - create channel-mapping control elements
2502 * @pcm: the assigned PCM instance
2503 * @stream: stream direction
2504 * @chmap: channel map elements (for query)
2505 * @max_channels: the max number of channels for the stream
2506 * @private_value: the value passed to each kcontrol's private_value field
2507 * @info_ret: store struct snd_pcm_chmap instance if non-NULL
2508 *
2509 * Create channel-mapping control elements assigned to the given PCM stream(s).
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01002510 * Return: Zero if successful, or a negative error value.
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002511 */
2512int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
2513 const struct snd_pcm_chmap_elem *chmap,
2514 int max_channels,
2515 unsigned long private_value,
2516 struct snd_pcm_chmap **info_ret)
2517{
2518 struct snd_pcm_chmap *info;
2519 struct snd_kcontrol_new knew = {
2520 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
2521 .access = SNDRV_CTL_ELEM_ACCESS_READ |
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002522 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
2523 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK,
2524 .info = pcm_chmap_ctl_info,
2525 .get = pcm_chmap_ctl_get,
2526 .tlv.c = pcm_chmap_ctl_tlv,
2527 };
2528 int err;
2529
Takashi Iwai8d879be2016-05-10 16:07:40 +02002530 if (WARN_ON(pcm->streams[stream].chmap_kctl))
2531 return -EBUSY;
Takashi Iwai2d3391e2012-07-27 18:27:00 +02002532 info = kzalloc(sizeof(*info), GFP_KERNEL);
2533 if (!info)
2534 return -ENOMEM;
2535 info->pcm = pcm;
2536 info->stream = stream;
2537 info->chmap = chmap;
2538 info->max_channels = max_channels;
2539 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
2540 knew.name = "Playback Channel Map";
2541 else
2542 knew.name = "Capture Channel Map";
2543 knew.device = pcm->device;
2544 knew.count = pcm->streams[stream].substream_count;
2545 knew.private_value = private_value;
2546 info->kctl = snd_ctl_new1(&knew, info);
2547 if (!info->kctl) {
2548 kfree(info);
2549 return -ENOMEM;
2550 }
2551 info->kctl->private_free = pcm_chmap_ctl_private_free;
2552 err = snd_ctl_add(pcm->card, info->kctl);
2553 if (err < 0)
2554 return err;
2555 pcm->streams[stream].chmap_kctl = info->kctl;
2556 if (info_ret)
2557 *info_ret = info;
2558 return 0;
2559}
2560EXPORT_SYMBOL_GPL(snd_pcm_add_chmap_ctls);