blob: 8dbe86cf2e4f5b810d496ad0533595c95b71a492 [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 */
6
Arnd Bergmann09d94172018-04-24 20:06:14 +08007#include <linux/compat.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008#include <linux/mm.h>
Paul Gortmakerda155d52011-07-15 12:38:28 -04009#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/file.h>
11#include <linux/slab.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010012#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/time.h>
Jean Pihete8db0be2011-08-25 15:35:03 +020014#include <linux/pm_qos.h>
Takashi Iwai6cbbfe12015-01-28 16:49:33 +010015#include <linux/io.h>
Takashi Iwai657b1982009-11-26 12:40:21 +010016#include <linux/dma-mapping.h>
Takashi Iwai7e8edae2019-11-05 09:01:37 +010017#include <linux/vmalloc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <sound/core.h>
19#include <sound/control.h>
20#include <sound/info.h>
21#include <sound/pcm.h>
22#include <sound/pcm_params.h>
23#include <sound/timer.h>
24#include <sound/minors.h>
Christoph Hellwige2e40f22015-02-22 08:58:50 -080025#include <linux/uio.h>
Chanho Minb888a5f72018-11-26 14:36:37 +090026#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Takashi Sakamoto2c4842d2017-05-26 09:30:46 +090028#include "pcm_local.h"
29
Takashi Sakamoto37567c52017-06-07 08:46:44 +090030#ifdef CONFIG_SND_DEBUG
Takashi Sakamotobe4e31d2017-06-07 08:46:43 +090031#define CREATE_TRACE_POINTS
32#include "pcm_param_trace.h"
Takashi Sakamoto37567c52017-06-07 08:46:44 +090033#else
34#define trace_hw_mask_param_enabled() 0
35#define trace_hw_interval_param_enabled() 0
36#define trace_hw_mask_param(substream, type, index, prev, curr)
37#define trace_hw_interval_param(substream, type, index, prev, curr)
38#endif
Takashi Sakamotobe4e31d2017-06-07 08:46:43 +090039
Linus Torvalds1da177e2005-04-16 15:20:36 -070040/*
41 * Compatibility
42 */
43
Takashi Iwai877211f2005-11-17 13:59:38 +010044struct snd_pcm_hw_params_old {
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 unsigned int flags;
46 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
47 SNDRV_PCM_HW_PARAM_ACCESS + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +010048 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
50 unsigned int rmask;
51 unsigned int cmask;
52 unsigned int info;
53 unsigned int msbits;
54 unsigned int rate_num;
55 unsigned int rate_den;
Takashi Iwai877211f2005-11-17 13:59:38 +010056 snd_pcm_uframes_t fifo_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 unsigned char reserved[64];
58};
59
Takashi Iwai59d48582005-12-01 10:51:58 +010060#ifdef CONFIG_SND_SUPPORT_OLD_API
Takashi Iwai877211f2005-11-17 13:59:38 +010061#define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
62#define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Takashi Iwai877211f2005-11-17 13:59:38 +010064static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params_old __user * _oparams);
66static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params_old __user * _oparams);
Takashi Iwai59d48582005-12-01 10:51:58 +010068#endif
Clemens Ladischf87135f2005-11-20 14:06:59 +010069static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
Linus Torvalds1da177e2005-04-16 15:20:36 -070070
71/*
72 *
73 */
74
Takashi Iwai7af142f2014-09-01 11:19:37 +020075static DECLARE_RWSEM(snd_pcm_link_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Takashi Iwai73365cb2019-01-13 09:35:17 +010077void snd_pcm_group_init(struct snd_pcm_group *group)
Takashi Iwai67ec10722016-02-17 14:30:26 +010078{
Takashi Iwai73365cb2019-01-13 09:35:17 +010079 spin_lock_init(&group->lock);
80 mutex_init(&group->mutex);
81 INIT_LIST_HEAD(&group->substreams);
Takashi Iwai0e279dc2019-07-19 10:55:05 +020082 refcount_set(&group->refs, 1);
Takashi Iwai67ec10722016-02-17 14:30:26 +010083}
84
Takashi Iwaif57f3df2019-01-13 09:50:33 +010085/* define group lock helpers */
86#define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
87static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
88{ \
89 if (nonatomic) \
90 mutex_ ## mutex_action(&group->mutex); \
91 else \
92 spin_ ## action(&group->lock); \
Anna-Maria Gleixner10aa7ca2018-05-04 17:28:10 +020093}
94
Takashi Iwaif57f3df2019-01-13 09:50:33 +010095DEFINE_PCM_GROUP_LOCK(lock, lock);
96DEFINE_PCM_GROUP_LOCK(unlock, unlock);
97DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
98DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
Anna-Maria Gleixner10aa7ca2018-05-04 17:28:10 +020099
Takashi Iwai30b771c2014-10-30 15:02:50 +0100100/**
101 * snd_pcm_stream_lock - Lock the PCM stream
102 * @substream: PCM substream
103 *
104 * This locks the PCM stream's spinlock or mutex depending on the nonatomic
105 * flag of the given substream. This also takes the global link rw lock
106 * (or rw sem), too, for avoiding the race with linked streams.
107 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200108void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
109{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100110 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
Takashi Iwai7af142f2014-09-01 11:19:37 +0200111}
112EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
113
Takashi Iwai30b771c2014-10-30 15:02:50 +0100114/**
Mauro Carvalho Chehabf7b66032020-10-23 18:33:35 +0200115 * snd_pcm_stream_unlock - Unlock the PCM stream
Takashi Iwai30b771c2014-10-30 15:02:50 +0100116 * @substream: PCM substream
117 *
118 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
119 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200120void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
121{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100122 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
Takashi Iwai7af142f2014-09-01 11:19:37 +0200123}
124EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
125
Takashi Iwai30b771c2014-10-30 15:02:50 +0100126/**
127 * snd_pcm_stream_lock_irq - Lock the PCM stream
128 * @substream: PCM substream
129 *
130 * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
131 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
132 * as snd_pcm_stream_lock().
133 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200134void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
135{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100136 snd_pcm_group_lock_irq(&substream->self_group,
137 substream->pcm->nonatomic);
Takashi Iwai7af142f2014-09-01 11:19:37 +0200138}
139EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
140
Michał Mirosławe18035c2020-06-08 12:06:32 +0200141static void snd_pcm_stream_lock_nested(struct snd_pcm_substream *substream)
142{
143 struct snd_pcm_group *group = &substream->self_group;
144
145 if (substream->pcm->nonatomic)
146 mutex_lock_nested(&group->mutex, SINGLE_DEPTH_NESTING);
147 else
148 spin_lock_nested(&group->lock, SINGLE_DEPTH_NESTING);
149}
150
Takashi Iwai30b771c2014-10-30 15:02:50 +0100151/**
152 * snd_pcm_stream_unlock_irq - Unlock the PCM stream
153 * @substream: PCM substream
154 *
155 * This is a counter-part of snd_pcm_stream_lock_irq().
156 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200157void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
158{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100159 snd_pcm_group_unlock_irq(&substream->self_group,
160 substream->pcm->nonatomic);
Takashi Iwai7af142f2014-09-01 11:19:37 +0200161}
162EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
163
164unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
165{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100166 unsigned long flags = 0;
167 if (substream->pcm->nonatomic)
168 mutex_lock(&substream->self_group.mutex);
169 else
170 spin_lock_irqsave(&substream->self_group.lock, flags);
171 return flags;
Takashi Iwai7af142f2014-09-01 11:19:37 +0200172}
173EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
174
Takashi Iwai30b771c2014-10-30 15:02:50 +0100175/**
176 * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
177 * @substream: PCM substream
178 * @flags: irq flags
179 *
180 * This is a counter-part of snd_pcm_stream_lock_irqsave().
181 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200182void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
183 unsigned long flags)
184{
Takashi Iwaief2056b2019-01-13 10:15:03 +0100185 if (substream->pcm->nonatomic)
186 mutex_unlock(&substream->self_group.mutex);
187 else
188 spin_unlock_irqrestore(&substream->self_group.lock, flags);
Takashi Iwai7af142f2014-09-01 11:19:37 +0200189}
190EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Takashi Iwaifc033cb2019-11-17 09:53:03 +0100192/* Run PCM ioctl ops */
193static int snd_pcm_ops_ioctl(struct snd_pcm_substream *substream,
194 unsigned cmd, void *arg)
195{
196 if (substream->ops->ioctl)
197 return substream->ops->ioctl(substream, cmd, arg);
198 else
199 return snd_pcm_lib_ioctl(substream, cmd, arg);
200}
201
Takashi Iwai877211f2005-11-17 13:59:38 +0100202int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203{
Takashi Iwai877211f2005-11-17 13:59:38 +0100204 struct snd_pcm *pcm = substream->pcm;
205 struct snd_pcm_str *pstr = substream->pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 memset(info, 0, sizeof(*info));
208 info->card = pcm->card->number;
209 info->device = pcm->device;
210 info->stream = substream->stream;
211 info->subdevice = substream->number;
Joe Perches75b1a8f2021-01-04 09:17:34 -0800212 strscpy(info->id, pcm->id, sizeof(info->id));
213 strscpy(info->name, pcm->name, sizeof(info->name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 info->dev_class = pcm->dev_class;
215 info->dev_subclass = pcm->dev_subclass;
216 info->subdevices_count = pstr->substream_count;
217 info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
Joe Perches75b1a8f2021-01-04 09:17:34 -0800218 strscpy(info->subname, substream->name, sizeof(info->subname));
Takashi Sakamotoe11f0f92017-06-14 19:30:03 +0900219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 return 0;
221}
222
Takashi Iwai877211f2005-11-17 13:59:38 +0100223int snd_pcm_info_user(struct snd_pcm_substream *substream,
224 struct snd_pcm_info __user * _info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Takashi Iwai877211f2005-11-17 13:59:38 +0100226 struct snd_pcm_info *info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 int err;
228
229 info = kmalloc(sizeof(*info), GFP_KERNEL);
230 if (! info)
231 return -ENOMEM;
232 err = snd_pcm_info(substream, info);
233 if (err >= 0) {
234 if (copy_to_user(_info, info, sizeof(*info)))
235 err = -EFAULT;
236 }
237 kfree(info);
238 return err;
239}
240
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100241/* macro for simplified cast */
242#define PARAM_MASK_BIT(b) (1U << (__force int)(b))
243
Takashi Iwai63825f32014-10-22 12:04:46 +0200244static bool hw_support_mmap(struct snd_pcm_substream *substream)
245{
246 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
247 return false;
Christoph Hellwig425da152019-08-03 13:31:59 +0300248
249 if (substream->ops->mmap ||
Takashi Iwai6111fd22019-11-04 11:11:15 +0100250 (substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV &&
251 substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV_UC))
Christoph Hellwig425da152019-08-03 13:31:59 +0300252 return true;
253
254 return dma_can_mmap(substream->dma_buffer.dev.dev);
Takashi Iwai63825f32014-10-22 12:04:46 +0200255}
256
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900257static int constrain_mask_params(struct snd_pcm_substream *substream,
258 struct snd_pcm_hw_params *params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900260 struct snd_pcm_hw_constraints *constrs =
261 &substream->runtime->hw_constraints;
262 struct snd_mask *m;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 unsigned int k;
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900264 struct snd_mask old_mask;
265 int changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
267 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
268 m = hw_param_mask(params, k);
269 if (snd_mask_empty(m))
270 return -EINVAL;
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900271
272 /* This parameter is not requested to change by a caller. */
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100273 if (!(params->rmask & PARAM_MASK_BIT(k)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 continue;
Takashi Sakamotobe4e31d2017-06-07 08:46:43 +0900275
276 if (trace_hw_mask_param_enabled())
277 old_mask = *m;
Takashi Sakamotoc6706de2017-06-07 08:46:45 +0900278
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 changed = snd_mask_refine(m, constrs_mask(constrs, k));
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900280 if (changed < 0)
281 return changed;
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900282 if (changed == 0)
283 continue;
Takashi Sakamotobe4e31d2017-06-07 08:46:43 +0900284
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900285 /* Set corresponding flag so that the caller gets it. */
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900286 trace_hw_mask_param(substream, k, 0, &old_mask, m);
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100287 params->cmask |= PARAM_MASK_BIT(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 }
289
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900290 return 0;
291}
292
Takashi Sakamoto3432fa02017-06-09 06:37:00 +0900293static int constrain_interval_params(struct snd_pcm_substream *substream,
294 struct snd_pcm_hw_params *params)
295{
296 struct snd_pcm_hw_constraints *constrs =
297 &substream->runtime->hw_constraints;
298 struct snd_interval *i;
299 unsigned int k;
300 struct snd_interval old_interval;
301 int changed;
302
303 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
304 i = hw_param_interval(params, k);
305 if (snd_interval_empty(i))
306 return -EINVAL;
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900307
308 /* This parameter is not requested to change by a caller. */
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100309 if (!(params->rmask & PARAM_MASK_BIT(k)))
Takashi Sakamoto3432fa02017-06-09 06:37:00 +0900310 continue;
311
312 if (trace_hw_interval_param_enabled())
313 old_interval = *i;
314
315 changed = snd_interval_refine(i, constrs_interval(constrs, k));
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900316 if (changed < 0)
317 return changed;
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900318 if (changed == 0)
319 continue;
Takashi Sakamoto3432fa02017-06-09 06:37:00 +0900320
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900321 /* Set corresponding flag so that the caller gets it. */
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900322 trace_hw_interval_param(substream, k, 0, &old_interval, i);
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100323 params->cmask |= PARAM_MASK_BIT(k);
Takashi Sakamoto3432fa02017-06-09 06:37:00 +0900324 }
325
326 return 0;
327}
328
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900329static int constrain_params_by_rules(struct snd_pcm_substream *substream,
330 struct snd_pcm_hw_params *params)
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900331{
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900332 struct snd_pcm_hw_constraints *constrs =
333 &substream->runtime->hw_constraints;
Takashi Sakamoto561e1ca2017-06-09 06:36:59 +0900334 unsigned int k;
Takashi Iwai5730f9f2018-03-13 11:18:57 +0100335 unsigned int *rstamps;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900337 unsigned int stamp;
Takashi Sakamotoa1c06e32017-06-09 06:37:04 +0900338 struct snd_pcm_hw_rule *r;
339 unsigned int d;
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900340 struct snd_mask old_mask;
341 struct snd_interval old_interval;
Takashi Sakamotoa1c06e32017-06-09 06:37:04 +0900342 bool again;
Takashi Iwai5730f9f2018-03-13 11:18:57 +0100343 int changed, err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900345 /*
346 * Each application of rule has own sequence number.
347 *
348 * Each member of 'rstamps' array represents the sequence number of
349 * recent application of corresponding rule.
350 */
Takashi Iwai5730f9f2018-03-13 11:18:57 +0100351 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
352 if (!rstamps)
353 return -ENOMEM;
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900354
355 /*
356 * Each member of 'vstamps' array represents the sequence number of
357 * recent application of rule in which corresponding parameters were
358 * changed.
359 *
360 * In initial state, elements corresponding to parameters requested by
361 * a caller is 1. For unrequested parameters, corresponding members
362 * have 0 so that the parameters are never changed anymore.
363 */
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900364 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100365 vstamps[k] = (params->rmask & PARAM_MASK_BIT(k)) ? 1 : 0;
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900366
367 /* Due to the above design, actual sequence number starts at 2. */
368 stamp = 2;
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900369retry:
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900370 /* Apply all rules in order. */
Takashi Sakamotoa1c06e32017-06-09 06:37:04 +0900371 again = false;
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900372 for (k = 0; k < constrs->rules_num; k++) {
Takashi Sakamotoa1c06e32017-06-09 06:37:04 +0900373 r = &constrs->rules[k];
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900374
375 /*
376 * Check condition bits of this rule. When the rule has
377 * some condition bits, parameter without the bits is
378 * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
379 * is an example of the condition bits.
380 */
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900381 if (r->cond && !(r->cond & params->flags))
382 continue;
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900383
384 /*
Takashi Iwai23b53d42021-01-23 16:57:30 +0100385 * The 'deps' array includes maximum four dependencies
386 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fifth
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900387 * member of this array is a sentinel and should be
388 * negative value.
389 *
390 * This rule should be processed in this time when dependent
391 * parameters were changed at former applications of the other
392 * rules.
393 */
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900394 for (d = 0; r->deps[d] >= 0; d++) {
Takashi Sakamotod656b4a2017-06-09 06:37:03 +0900395 if (vstamps[r->deps[d]] > rstamps[k])
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900396 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 }
Takashi Sakamotod656b4a2017-06-09 06:37:03 +0900398 if (r->deps[d] < 0)
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900399 continue;
400
401 if (trace_hw_mask_param_enabled()) {
402 if (hw_is_mask(r->var))
403 old_mask = *hw_param_mask(params, r->var);
404 }
405 if (trace_hw_interval_param_enabled()) {
406 if (hw_is_interval(r->var))
407 old_interval = *hw_param_interval(params, r->var);
408 }
409
410 changed = r->func(params, r);
Takashi Iwai5730f9f2018-03-13 11:18:57 +0100411 if (changed < 0) {
412 err = changed;
413 goto out;
414 }
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900415
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900416 /*
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900417 * When the parameter is changed, notify it to the caller
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900418 * by corresponding returned bit, then preparing for next
419 * iteration.
420 */
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900421 if (changed && r->var >= 0) {
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900422 if (hw_is_mask(r->var)) {
423 trace_hw_mask_param(substream, r->var,
424 k + 1, &old_mask,
425 hw_param_mask(params, r->var));
426 }
427 if (hw_is_interval(r->var)) {
428 trace_hw_interval_param(substream, r->var,
429 k + 1, &old_interval,
430 hw_param_interval(params, r->var));
431 }
432
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100433 params->cmask |= PARAM_MASK_BIT(r->var);
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900434 vstamps[r->var] = stamp;
Takashi Sakamotoa1c06e32017-06-09 06:37:04 +0900435 again = true;
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900436 }
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900437
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900438 rstamps[k] = stamp++;
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900439 }
440
Takashi Sakamotod81052f2017-06-09 06:37:06 +0900441 /* Iterate to evaluate all rules till no parameters are changed. */
Takashi Sakamoto0d4e3992017-06-09 06:37:02 +0900442 if (again)
443 goto retry;
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900444
Takashi Iwai5730f9f2018-03-13 11:18:57 +0100445 out:
446 kfree(rstamps);
447 return err;
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900448}
449
Takashi Sakamotof9a076b2017-06-09 09:34:39 +0900450static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
451 struct snd_pcm_hw_params *params)
452{
453 const struct snd_interval *i;
454 const struct snd_mask *m;
455 int err;
456
457 if (!params->msbits) {
458 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
459 if (snd_interval_single(i))
460 params->msbits = snd_interval_value(i);
461 }
462
463 if (!params->rate_den) {
464 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
465 if (snd_interval_single(i)) {
466 params->rate_num = snd_interval_value(i);
467 params->rate_den = 1;
468 }
469 }
470
471 if (!params->fifo_size) {
472 m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
473 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
474 if (snd_mask_single(m) && snd_interval_single(i)) {
Takashi Iwaifc033cb2019-11-17 09:53:03 +0100475 err = snd_pcm_ops_ioctl(substream,
476 SNDRV_PCM_IOCTL1_FIFO_SIZE,
477 params);
Takashi Sakamotof9a076b2017-06-09 09:34:39 +0900478 if (err < 0)
479 return err;
480 }
481 }
482
Takashi Sakamoto7802fb52017-06-09 09:34:40 +0900483 if (!params->info) {
484 params->info = substream->runtime->hw.info;
485 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
486 SNDRV_PCM_INFO_DRAIN_TRIGGER);
487 if (!hw_support_mmap(substream))
488 params->info &= ~(SNDRV_PCM_INFO_MMAP |
489 SNDRV_PCM_INFO_MMAP_VALID);
490 }
491
Takashi Sakamotof9a076b2017-06-09 09:34:39 +0900492 return 0;
493}
494
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900495int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
496 struct snd_pcm_hw_params *params)
497{
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900498 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500 params->info = 0;
501 params->fifo_size = 0;
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100502 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 params->msbits = 0;
Takashi Iwaif9b0c052020-02-06 17:39:43 +0100504 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 params->rate_num = 0;
506 params->rate_den = 0;
507 }
508
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900509 err = constrain_mask_params(substream, params);
510 if (err < 0)
511 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900513 err = constrain_interval_params(substream, params);
514 if (err < 0)
515 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Takashi Sakamoto9cc07f52017-06-09 06:37:01 +0900517 err = constrain_params_by_rules(substream, params);
518 if (err < 0)
519 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 params->rmask = 0;
Takashi Sakamoto7802fb52017-06-09 09:34:40 +0900522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 return 0;
524}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +0200525EXPORT_SYMBOL(snd_pcm_hw_refine);
526
Takashi Iwai877211f2005-11-17 13:59:38 +0100527static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
528 struct snd_pcm_hw_params __user * _params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529{
Takashi Iwai877211f2005-11-17 13:59:38 +0100530 struct snd_pcm_hw_params *params;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 int err;
532
Li Zefanef44a1e2009-04-10 09:43:08 +0800533 params = memdup_user(_params, sizeof(*params));
534 if (IS_ERR(params))
535 return PTR_ERR(params);
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 err = snd_pcm_hw_refine(substream, params);
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900538 if (err < 0)
539 goto end;
Li Zefanef44a1e2009-04-10 09:43:08 +0800540
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900541 err = fixup_unreferenced_params(substream, params);
542 if (err < 0)
543 goto end;
544
545 if (copy_to_user(_params, params, sizeof(*params)))
546 err = -EFAULT;
547end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 kfree(params);
549 return err;
550}
551
Takashi Iwai9442e692006-09-30 23:27:19 -0700552static int period_to_usecs(struct snd_pcm_runtime *runtime)
553{
554 int usecs;
555
556 if (! runtime->rate)
557 return -1; /* invalid */
558
559 /* take 75% of period time as the deadline */
560 usecs = (750000 / runtime->rate) * runtime->period_size;
561 usecs += ((750000 % runtime->rate) * runtime->period_size) /
562 runtime->rate;
563
564 return usecs;
565}
566
Takashi Iwaicb639a42020-01-31 16:22:14 +0100567static void snd_pcm_set_state(struct snd_pcm_substream *substream,
568 snd_pcm_state_t state)
Takashi Iwai9b0573c02012-10-12 15:07:34 +0200569{
570 snd_pcm_stream_lock_irq(substream);
571 if (substream->runtime->status->state != SNDRV_PCM_STATE_DISCONNECTED)
572 substream->runtime->status->state = state;
573 snd_pcm_stream_unlock_irq(substream);
574}
575
Jie Yang90bbaf62015-10-16 17:57:46 +0800576static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
577 int event)
578{
579#ifdef CONFIG_SND_PCM_TIMER
580 if (substream->timer)
581 snd_timer_notify(substream->timer, event,
582 &substream->runtime->trigger_tstamp);
583#endif
584}
585
Takashi Iwai29bb2742021-02-06 21:36:53 +0100586void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
Takashi Iwai1e850be2019-11-17 09:53:06 +0100587{
Takashi Iwai29bb2742021-02-06 21:36:53 +0100588 if (substream->runtime && substream->runtime->stop_operating) {
Takashi Iwai1e850be2019-11-17 09:53:06 +0100589 substream->runtime->stop_operating = false;
Takashi Iwai29bb2742021-02-06 21:36:53 +0100590 if (substream->ops && substream->ops->sync_stop)
Takashi Iwai1e850be2019-11-17 09:53:06 +0100591 substream->ops->sync_stop(substream);
Takashi Iwai29bb2742021-02-06 21:36:53 +0100592 else if (sync_irq && substream->pcm->card->sync_irq > 0)
Takashi Iwaifabb26d2019-11-17 09:53:07 +0100593 synchronize_irq(substream->pcm->card->sync_irq);
Takashi Iwai1e850be2019-11-17 09:53:06 +0100594 }
595}
596
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900597/**
Mauro Carvalho Chehabf7b66032020-10-23 18:33:35 +0200598 * snd_pcm_hw_params_choose - choose a configuration defined by @params
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900599 * @pcm: PCM instance
600 * @params: the hw_params instance
601 *
602 * Choose one configuration from configuration space defined by @params.
603 * The configuration chosen is that obtained fixing in this order:
604 * first access, first format, first subformat, min channels,
605 * min rate, min period time, max buffer size, min tick time
606 *
607 * Return: Zero if successful, or a negative error code on failure.
608 */
609static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
610 struct snd_pcm_hw_params *params)
611{
612 static const int vars[] = {
613 SNDRV_PCM_HW_PARAM_ACCESS,
614 SNDRV_PCM_HW_PARAM_FORMAT,
615 SNDRV_PCM_HW_PARAM_SUBFORMAT,
616 SNDRV_PCM_HW_PARAM_CHANNELS,
617 SNDRV_PCM_HW_PARAM_RATE,
618 SNDRV_PCM_HW_PARAM_PERIOD_TIME,
619 SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
620 SNDRV_PCM_HW_PARAM_TICK_TIME,
621 -1
622 };
623 const int *v;
Takashi Sakamoto7b8a54a2017-06-09 21:46:49 +0900624 struct snd_mask old_mask;
625 struct snd_interval old_interval;
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900626 int changed;
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900627
628 for (v = vars; *v != -1; v++) {
Takashi Sakamoto7b8a54a2017-06-09 21:46:49 +0900629 /* Keep old parameter to trace. */
630 if (trace_hw_mask_param_enabled()) {
631 if (hw_is_mask(*v))
632 old_mask = *hw_param_mask(params, *v);
633 }
634 if (trace_hw_interval_param_enabled()) {
635 if (hw_is_interval(*v))
636 old_interval = *hw_param_interval(params, *v);
637 }
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900638 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900639 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900640 else
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900641 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
Takashi Iwaie1a3a982018-04-09 17:12:16 +0200642 if (changed < 0)
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900643 return changed;
644 if (changed == 0)
645 continue;
Takashi Sakamoto7b8a54a2017-06-09 21:46:49 +0900646
Takashi Sakamoto82e7d502017-06-11 23:56:13 +0900647 /* Trace the changed parameter. */
Takashi Sakamoto7b8a54a2017-06-09 21:46:49 +0900648 if (hw_is_mask(*v)) {
649 trace_hw_mask_param(pcm, *v, 0, &old_mask,
650 hw_param_mask(params, *v));
651 }
652 if (hw_is_interval(*v)) {
653 trace_hw_interval_param(pcm, *v, 0, &old_interval,
654 hw_param_interval(params, *v));
655 }
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900656 }
Takashi Sakamoto7b8a54a2017-06-09 21:46:49 +0900657
Takashi Sakamoto60f96aa2017-06-09 21:46:48 +0900658 return 0;
659}
660
Takashi Iwai877211f2005-11-17 13:59:38 +0100661static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
662 struct snd_pcm_hw_params *params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
Takashi Iwai877211f2005-11-17 13:59:38 +0100664 struct snd_pcm_runtime *runtime;
Takashi Iwai9442e692006-09-30 23:27:19 -0700665 int err, usecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 unsigned int bits;
667 snd_pcm_uframes_t frames;
668
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200669 if (PCM_RUNTIME_CHECK(substream))
670 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 snd_pcm_stream_lock_irq(substream);
673 switch (runtime->status->state) {
674 case SNDRV_PCM_STATE_OPEN:
675 case SNDRV_PCM_STATE_SETUP:
676 case SNDRV_PCM_STATE_PREPARED:
677 break;
678 default:
679 snd_pcm_stream_unlock_irq(substream);
680 return -EBADFD;
681 }
682 snd_pcm_stream_unlock_irq(substream);
Takashi Iwai8eeaa2f2014-02-10 09:48:47 +0100683#if IS_ENABLED(CONFIG_SND_PCM_OSS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 if (!substream->oss.oss)
685#endif
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200686 if (atomic_read(&substream->mmap_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 return -EBADFD;
688
Takashi Iwai29bb2742021-02-06 21:36:53 +0100689 snd_pcm_sync_stop(substream, true);
Takashi Iwai1e850be2019-11-17 09:53:06 +0100690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 params->rmask = ~0U;
692 err = snd_pcm_hw_refine(substream, params);
693 if (err < 0)
694 goto _error;
695
696 err = snd_pcm_hw_params_choose(substream, params);
697 if (err < 0)
698 goto _error;
699
Takashi Sakamotof9a076b2017-06-09 09:34:39 +0900700 err = fixup_unreferenced_params(substream, params);
701 if (err < 0)
702 goto _error;
703
Takashi Iwai0dba8082019-11-17 09:53:01 +0100704 if (substream->managed_buffer_alloc) {
705 err = snd_pcm_lib_malloc_pages(substream,
706 params_buffer_bytes(params));
707 if (err < 0)
708 goto _error;
709 runtime->buffer_changed = err > 0;
710 }
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 if (substream->ops->hw_params != NULL) {
713 err = substream->ops->hw_params(substream, params);
714 if (err < 0)
715 goto _error;
716 }
717
718 runtime->access = params_access(params);
719 runtime->format = params_format(params);
720 runtime->subformat = params_subformat(params);
721 runtime->channels = params_channels(params);
722 runtime->rate = params_rate(params);
723 runtime->period_size = params_period_size(params);
724 runtime->periods = params_periods(params);
725 runtime->buffer_size = params_buffer_size(params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 runtime->info = params->info;
727 runtime->rate_num = params->rate_num;
728 runtime->rate_den = params->rate_den;
Clemens Ladischab69a492010-11-15 10:46:23 +0100729 runtime->no_period_wakeup =
730 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
731 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732
733 bits = snd_pcm_format_physical_width(runtime->format);
734 runtime->sample_bits = bits;
735 bits *= runtime->channels;
736 runtime->frame_bits = bits;
737 frames = 1;
738 while (bits % 8 != 0) {
739 bits *= 2;
740 frames *= 2;
741 }
742 runtime->byte_align = bits / 8;
743 runtime->min_align = frames;
744
745 /* Default sw params */
746 runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
747 runtime->period_step = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 runtime->control->avail_min = runtime->period_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 runtime->start_threshold = 1;
750 runtime->stop_threshold = runtime->buffer_size;
751 runtime->silence_threshold = 0;
752 runtime->silence_size = 0;
Clemens Ladischead40462010-05-21 09:15:59 +0200753 runtime->boundary = runtime->buffer_size;
754 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
755 runtime->boundary *= 2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
Takashi Iwaiadd9d562019-12-11 16:57:42 +0100757 /* clear the buffer for avoiding possible kernel info leaks */
Takashi Iwai618de0f2020-12-18 15:56:25 +0100758 if (runtime->dma_area && !substream->ops->copy_user) {
759 size_t size = runtime->dma_bytes;
760
761 if (runtime->info & SNDRV_PCM_INFO_MMAP)
762 size = PAGE_ALIGN(size);
763 memset(runtime->dma_area, 0, size);
764 }
Takashi Iwaiadd9d562019-12-11 16:57:42 +0100765
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 snd_pcm_timer_resolution_change(substream);
Takashi Iwai9b0573c02012-10-12 15:07:34 +0200767 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
Takashi Iwai9442e692006-09-30 23:27:19 -0700768
Rafael J. Wysocki5371a792020-02-12 00:34:15 +0100769 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
770 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
Takashi Iwai9442e692006-09-30 23:27:19 -0700771 if ((usecs = period_to_usecs(runtime)) >= 0)
Rafael J. Wysocki5371a792020-02-12 00:34:15 +0100772 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
773 usecs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 return 0;
775 _error:
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300776 /* hardware might be unusable from this time,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 so we force application to retry to set
778 the correct hardware parameter settings */
Takashi Iwai9b0573c02012-10-12 15:07:34 +0200779 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 if (substream->ops->hw_free != NULL)
781 substream->ops->hw_free(substream);
Takashi Iwai0dba8082019-11-17 09:53:01 +0100782 if (substream->managed_buffer_alloc)
783 snd_pcm_lib_free_pages(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 return err;
785}
786
Takashi Iwai877211f2005-11-17 13:59:38 +0100787static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
788 struct snd_pcm_hw_params __user * _params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
Takashi Iwai877211f2005-11-17 13:59:38 +0100790 struct snd_pcm_hw_params *params;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 int err;
792
Li Zefanef44a1e2009-04-10 09:43:08 +0800793 params = memdup_user(_params, sizeof(*params));
794 if (IS_ERR(params))
795 return PTR_ERR(params);
796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 err = snd_pcm_hw_params(substream, params);
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900798 if (err < 0)
799 goto end;
Li Zefanef44a1e2009-04-10 09:43:08 +0800800
Takashi Sakamotof74ae152017-06-11 23:56:12 +0900801 if (copy_to_user(_params, params, sizeof(*params)))
802 err = -EFAULT;
803end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 kfree(params);
805 return err;
806}
807
Takashi Iwai66f2d192020-01-29 20:59:07 +0100808static int do_hw_free(struct snd_pcm_substream *substream)
809{
810 int result = 0;
811
Takashi Iwai29bb2742021-02-06 21:36:53 +0100812 snd_pcm_sync_stop(substream, true);
Takashi Iwai66f2d192020-01-29 20:59:07 +0100813 if (substream->ops->hw_free)
814 result = substream->ops->hw_free(substream);
815 if (substream->managed_buffer_alloc)
816 snd_pcm_lib_free_pages(substream);
817 return result;
818}
819
Takashi Iwai877211f2005-11-17 13:59:38 +0100820static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821{
Takashi Iwai877211f2005-11-17 13:59:38 +0100822 struct snd_pcm_runtime *runtime;
Takashi Iwai66f2d192020-01-29 20:59:07 +0100823 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200825 if (PCM_RUNTIME_CHECK(substream))
826 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 snd_pcm_stream_lock_irq(substream);
829 switch (runtime->status->state) {
830 case SNDRV_PCM_STATE_SETUP:
831 case SNDRV_PCM_STATE_PREPARED:
832 break;
833 default:
834 snd_pcm_stream_unlock_irq(substream);
835 return -EBADFD;
836 }
837 snd_pcm_stream_unlock_irq(substream);
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200838 if (atomic_read(&substream->mmap_count))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 return -EBADFD;
Takashi Iwai66f2d192020-01-29 20:59:07 +0100840 result = do_hw_free(substream);
Takashi Iwai9b0573c02012-10-12 15:07:34 +0200841 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
Rafael J. Wysocki5371a792020-02-12 00:34:15 +0100842 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 return result;
844}
845
Takashi Iwai877211f2005-11-17 13:59:38 +0100846static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
847 struct snd_pcm_sw_params *params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Takashi Iwai877211f2005-11-17 13:59:38 +0100849 struct snd_pcm_runtime *runtime;
Jaroslav Kysela12509322010-01-07 15:36:31 +0100850 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
Takashi Iwai7eaa9432008-08-08 17:09:09 +0200852 if (PCM_RUNTIME_CHECK(substream))
853 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 snd_pcm_stream_lock_irq(substream);
856 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
857 snd_pcm_stream_unlock_irq(substream);
858 return -EBADFD;
859 }
860 snd_pcm_stream_unlock_irq(substream);
861
Dan Carpenter145d92e2015-09-23 12:42:28 +0300862 if (params->tstamp_mode < 0 ||
863 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 return -EINVAL;
Takashi Iwai589008102014-07-16 17:45:27 +0200865 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
866 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
Takashi Iwai5646eda2014-07-10 09:50:19 +0200867 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 if (params->avail_min == 0)
869 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 if (params->silence_size >= runtime->boundary) {
871 if (params->silence_threshold != 0)
872 return -EINVAL;
873 } else {
874 if (params->silence_size > params->silence_threshold)
875 return -EINVAL;
876 if (params->silence_threshold > runtime->buffer_size)
877 return -EINVAL;
878 }
Jaroslav Kysela12509322010-01-07 15:36:31 +0100879 err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 snd_pcm_stream_lock_irq(substream);
881 runtime->tstamp_mode = params->tstamp_mode;
Takashi Iwai589008102014-07-16 17:45:27 +0200882 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
883 runtime->tstamp_type = params->tstamp_type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 runtime->period_step = params->period_step;
885 runtime->control->avail_min = params->avail_min;
886 runtime->start_threshold = params->start_threshold;
887 runtime->stop_threshold = params->stop_threshold;
888 runtime->silence_threshold = params->silence_threshold;
889 runtime->silence_size = params->silence_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 params->boundary = runtime->boundary;
891 if (snd_pcm_running(substream)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
893 runtime->silence_size > 0)
894 snd_pcm_playback_silence(substream, ULONG_MAX);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100895 err = snd_pcm_update_state(substream, runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 }
897 snd_pcm_stream_unlock_irq(substream);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100898 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899}
900
Takashi Iwai877211f2005-11-17 13:59:38 +0100901static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
902 struct snd_pcm_sw_params __user * _params)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903{
Takashi Iwai877211f2005-11-17 13:59:38 +0100904 struct snd_pcm_sw_params params;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 int err;
906 if (copy_from_user(&params, _params, sizeof(params)))
907 return -EFAULT;
908 err = snd_pcm_sw_params(substream, &params);
909 if (copy_to_user(_params, &params, sizeof(params)))
910 return -EFAULT;
911 return err;
912}
913
Takashi Iwaic99c5a32018-04-11 18:07:27 +0200914static inline snd_pcm_uframes_t
915snd_pcm_calc_delay(struct snd_pcm_substream *substream)
916{
917 snd_pcm_uframes_t delay;
918
919 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
920 delay = snd_pcm_playback_hw_avail(substream->runtime);
921 else
922 delay = snd_pcm_capture_avail(substream->runtime);
923 return delay + substream->runtime->delay;
924}
925
Baolin Wang3ddee7f2018-04-24 20:06:11 +0800926int snd_pcm_status64(struct snd_pcm_substream *substream,
927 struct snd_pcm_status64 *status)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928{
Takashi Iwai877211f2005-11-17 13:59:38 +0100929 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
931 snd_pcm_stream_lock_irq(substream);
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600932
933 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
934 &runtime->audio_tstamp_config);
935
936 /* backwards compatible behavior */
937 if (runtime->audio_tstamp_config.type_requested ==
938 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
939 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
940 runtime->audio_tstamp_config.type_requested =
941 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
942 else
943 runtime->audio_tstamp_config.type_requested =
944 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
945 runtime->audio_tstamp_report.valid = 0;
946 } else
947 runtime->audio_tstamp_report.valid = 1;
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 status->state = runtime->status->state;
950 status->suspended_state = runtime->status->suspended_state;
951 if (status->state == SNDRV_PCM_STATE_OPEN)
952 goto _end;
Baolin Wang3ddee7f2018-04-24 20:06:11 +0800953 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
954 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
Jaroslav Kysela8c121582008-01-11 08:45:08 +0100955 if (snd_pcm_running(substream)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956 snd_pcm_update_hw_ptr(substream);
Jaroslav Kysela8c121582008-01-11 08:45:08 +0100957 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
Baolin Wang3ddee7f2018-04-24 20:06:11 +0800958 status->tstamp_sec = runtime->status->tstamp.tv_sec;
959 status->tstamp_nsec =
960 runtime->status->tstamp.tv_nsec;
961 status->driver_tstamp_sec =
962 runtime->driver_tstamp.tv_sec;
963 status->driver_tstamp_nsec =
964 runtime->driver_tstamp.tv_nsec;
965 status->audio_tstamp_sec =
966 runtime->status->audio_tstamp.tv_sec;
967 status->audio_tstamp_nsec =
968 runtime->status->audio_tstamp.tv_nsec;
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -0600969 if (runtime->audio_tstamp_report.valid == 1)
970 /* backwards compatibility, no report provided in COMPAT mode */
971 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
972 &status->audio_tstamp_accuracy,
973 &runtime->audio_tstamp_report);
974
Jaroslav Kysela8c121582008-01-11 08:45:08 +0100975 goto _tstamp_end;
976 }
Pierre-Louis Bossart0d59b812015-02-06 15:55:50 -0600977 } else {
978 /* get tstamp only in fallback mode and only if enabled */
Baolin Wangfcae40c2018-04-24 20:06:08 +0800979 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
980 struct timespec64 tstamp;
981
982 snd_pcm_gettime(runtime, &tstamp);
Baolin Wang3ddee7f2018-04-24 20:06:11 +0800983 status->tstamp_sec = tstamp.tv_sec;
984 status->tstamp_nsec = tstamp.tv_nsec;
Baolin Wangfcae40c2018-04-24 20:06:08 +0800985 }
Jaroslav Kysela8c121582008-01-11 08:45:08 +0100986 }
Jaroslav Kysela8c121582008-01-11 08:45:08 +0100987 _tstamp_end:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 status->appl_ptr = runtime->control->appl_ptr;
989 status->hw_ptr = runtime->status->hw_ptr;
Takashi Iwai763e5062018-04-11 17:56:52 +0200990 status->avail = snd_pcm_avail(substream);
Takashi Iwaic99c5a32018-04-11 18:07:27 +0200991 status->delay = snd_pcm_running(substream) ?
992 snd_pcm_calc_delay(substream) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 status->avail_max = runtime->avail_max;
994 status->overrange = runtime->overrange;
995 runtime->avail_max = 0;
996 runtime->overrange = 0;
997 _end:
998 snd_pcm_stream_unlock_irq(substream);
999 return 0;
1000}
1001
Baolin Wang3ddee7f2018-04-24 20:06:11 +08001002static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1003 struct snd_pcm_status64 __user * _status,
1004 bool ext)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005{
Baolin Wang3ddee7f2018-04-24 20:06:11 +08001006 struct snd_pcm_status64 status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 int res;
Pierre-Louis Bossart38ca2a42015-02-13 15:14:04 -06001008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 memset(&status, 0, sizeof(status));
Pierre-Louis Bossart38ca2a42015-02-13 15:14:04 -06001010 /*
1011 * with extension, parameters are read/write,
1012 * get audio_tstamp_data from user,
1013 * ignore rest of status structure
1014 */
1015 if (ext && get_user(status.audio_tstamp_data,
1016 (u32 __user *)(&_status->audio_tstamp_data)))
1017 return -EFAULT;
Baolin Wang3ddee7f2018-04-24 20:06:11 +08001018 res = snd_pcm_status64(substream, &status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 if (res < 0)
1020 return res;
1021 if (copy_to_user(_status, &status, sizeof(status)))
1022 return -EFAULT;
1023 return 0;
1024}
1025
Baolin Wang3ddee7f2018-04-24 20:06:11 +08001026static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1027 struct snd_pcm_status32 __user * _status,
1028 bool ext)
1029{
1030 struct snd_pcm_status64 status64;
1031 struct snd_pcm_status32 status32;
1032 int res;
1033
1034 memset(&status64, 0, sizeof(status64));
1035 memset(&status32, 0, sizeof(status32));
1036 /*
1037 * with extension, parameters are read/write,
1038 * get audio_tstamp_data from user,
1039 * ignore rest of status structure
1040 */
1041 if (ext && get_user(status64.audio_tstamp_data,
1042 (u32 __user *)(&_status->audio_tstamp_data)))
1043 return -EFAULT;
1044 res = snd_pcm_status64(substream, &status64);
1045 if (res < 0)
1046 return res;
1047
1048 status32 = (struct snd_pcm_status32) {
1049 .state = status64.state,
1050 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1051 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1052 .tstamp_sec = status64.tstamp_sec,
1053 .tstamp_nsec = status64.tstamp_nsec,
1054 .appl_ptr = status64.appl_ptr,
1055 .hw_ptr = status64.hw_ptr,
1056 .delay = status64.delay,
1057 .avail = status64.avail,
1058 .avail_max = status64.avail_max,
1059 .overrange = status64.overrange,
1060 .suspended_state = status64.suspended_state,
1061 .audio_tstamp_data = status64.audio_tstamp_data,
1062 .audio_tstamp_sec = status64.audio_tstamp_sec,
1063 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1064 .driver_tstamp_sec = status64.audio_tstamp_sec,
1065 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1066 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1067 };
1068
1069 if (copy_to_user(_status, &status32, sizeof(status32)))
1070 return -EFAULT;
1071
1072 return 0;
1073}
1074
Takashi Iwai877211f2005-11-17 13:59:38 +01001075static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1076 struct snd_pcm_channel_info * info)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077{
Takashi Iwai877211f2005-11-17 13:59:38 +01001078 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 unsigned int channel;
1080
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 channel = info->channel;
1082 runtime = substream->runtime;
1083 snd_pcm_stream_lock_irq(substream);
1084 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
1085 snd_pcm_stream_unlock_irq(substream);
1086 return -EBADFD;
1087 }
1088 snd_pcm_stream_unlock_irq(substream);
1089 if (channel >= runtime->channels)
1090 return -EINVAL;
1091 memset(info, 0, sizeof(*info));
1092 info->channel = channel;
Takashi Iwaifc033cb2019-11-17 09:53:03 +01001093 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094}
1095
Takashi Iwai877211f2005-11-17 13:59:38 +01001096static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1097 struct snd_pcm_channel_info __user * _info)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098{
Takashi Iwai877211f2005-11-17 13:59:38 +01001099 struct snd_pcm_channel_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 int res;
1101
1102 if (copy_from_user(&info, _info, sizeof(info)))
1103 return -EFAULT;
1104 res = snd_pcm_channel_info(substream, &info);
1105 if (res < 0)
1106 return res;
1107 if (copy_to_user(_info, &info, sizeof(info)))
1108 return -EFAULT;
1109 return 0;
1110}
1111
Takashi Iwai877211f2005-11-17 13:59:38 +01001112static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113{
Takashi Iwai877211f2005-11-17 13:59:38 +01001114 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 if (runtime->trigger_master == NULL)
1116 return;
1117 if (runtime->trigger_master == substream) {
Pierre-Louis Bossart2b79d7a2015-02-06 15:55:51 -06001118 if (!runtime->trigger_tstamp_latched)
1119 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 } else {
1121 snd_pcm_trigger_tstamp(runtime->trigger_master);
1122 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1123 }
1124 runtime->trigger_master = NULL;
1125}
1126
Takashi Iwaicb639a42020-01-31 16:22:14 +01001127#define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129struct action_ops {
Takashi Iwaicb639a42020-01-31 16:22:14 +01001130 int (*pre_action)(struct snd_pcm_substream *substream,
1131 snd_pcm_state_t state);
1132 int (*do_action)(struct snd_pcm_substream *substream,
1133 snd_pcm_state_t state);
1134 void (*undo_action)(struct snd_pcm_substream *substream,
1135 snd_pcm_state_t state);
1136 void (*post_action)(struct snd_pcm_substream *substream,
1137 snd_pcm_state_t state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138};
1139
1140/*
1141 * this functions is core for handling of linked stream
1142 * Note: the stream state might be changed also on failure
1143 * Note2: call with calling stream lock + link lock
1144 */
Julia Lawallb17154c2015-11-29 16:36:40 +01001145static int snd_pcm_action_group(const struct action_ops *ops,
Takashi Iwai877211f2005-11-17 13:59:38 +01001146 struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001147 snd_pcm_state_t state,
1148 bool do_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149{
Takashi Iwai877211f2005-11-17 13:59:38 +01001150 struct snd_pcm_substream *s = NULL;
1151 struct snd_pcm_substream *s1;
Takashi Iwaidde1c652014-10-21 15:32:13 +02001152 int res = 0, depth = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
Takashi Iwaief991b92007-02-22 12:52:53 +01001154 snd_pcm_group_for_each_entry(s, substream) {
Takashi Iwai257f8cc2014-08-29 15:32:29 +02001155 if (do_lock && s != substream) {
1156 if (s->pcm->nonatomic)
Takashi Iwaidde1c652014-10-21 15:32:13 +02001157 mutex_lock_nested(&s->self_group.mutex, depth);
Takashi Iwai257f8cc2014-08-29 15:32:29 +02001158 else
Takashi Iwaidde1c652014-10-21 15:32:13 +02001159 spin_lock_nested(&s->self_group.lock, depth);
1160 depth++;
Takashi Iwai257f8cc2014-08-29 15:32:29 +02001161 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 res = ops->pre_action(s, state);
1163 if (res < 0)
1164 goto _unlock;
1165 }
Takashi Iwaief991b92007-02-22 12:52:53 +01001166 snd_pcm_group_for_each_entry(s, substream) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 res = ops->do_action(s, state);
1168 if (res < 0) {
1169 if (ops->undo_action) {
Takashi Iwaief991b92007-02-22 12:52:53 +01001170 snd_pcm_group_for_each_entry(s1, substream) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171 if (s1 == s) /* failed stream */
1172 break;
1173 ops->undo_action(s1, state);
1174 }
1175 }
1176 s = NULL; /* unlock all */
1177 goto _unlock;
1178 }
1179 }
Takashi Iwaief991b92007-02-22 12:52:53 +01001180 snd_pcm_group_for_each_entry(s, substream) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 ops->post_action(s, state);
1182 }
1183 _unlock:
1184 if (do_lock) {
1185 /* unlock streams */
Takashi Iwaief991b92007-02-22 12:52:53 +01001186 snd_pcm_group_for_each_entry(s1, substream) {
Takashi Iwai257f8cc2014-08-29 15:32:29 +02001187 if (s1 != substream) {
Takashi Iwai811deed2014-10-13 23:14:46 +02001188 if (s1->pcm->nonatomic)
Takashi Iwai257f8cc2014-08-29 15:32:29 +02001189 mutex_unlock(&s1->self_group.mutex);
1190 else
1191 spin_unlock(&s1->self_group.lock);
1192 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 if (s1 == s) /* end */
1194 break;
1195 }
1196 }
1197 return res;
1198}
1199
1200/*
1201 * Note: call with stream lock
1202 */
Julia Lawallb17154c2015-11-29 16:36:40 +01001203static int snd_pcm_action_single(const struct action_ops *ops,
Takashi Iwai877211f2005-11-17 13:59:38 +01001204 struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001205 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206{
1207 int res;
1208
1209 res = ops->pre_action(substream, state);
1210 if (res < 0)
1211 return res;
1212 res = ops->do_action(substream, state);
1213 if (res == 0)
1214 ops->post_action(substream, state);
1215 else if (ops->undo_action)
1216 ops->undo_action(substream, state);
1217 return res;
1218}
1219
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01001220static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1221 struct snd_pcm_group *new_group)
1222{
1223 substream->group = new_group;
1224 list_move(&substream->link_list, &new_group->substreams);
1225}
1226
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227/*
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001228 * Unref and unlock the group, but keep the stream lock;
1229 * when the group becomes empty and no longer referred, destroy itself
1230 */
1231static void snd_pcm_group_unref(struct snd_pcm_group *group,
1232 struct snd_pcm_substream *substream)
1233{
1234 bool do_free;
1235
1236 if (!group)
1237 return;
Takashi Iwai0e279dc2019-07-19 10:55:05 +02001238 do_free = refcount_dec_and_test(&group->refs);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001239 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1240 if (do_free)
1241 kfree(group);
1242}
1243
1244/*
1245 * Lock the group inside a stream lock and reference it;
1246 * return the locked group object, or NULL if not linked
1247 */
1248static struct snd_pcm_group *
1249snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1250{
1251 bool nonatomic = substream->pcm->nonatomic;
1252 struct snd_pcm_group *group;
1253 bool trylock;
1254
1255 for (;;) {
1256 if (!snd_pcm_stream_linked(substream))
1257 return NULL;
1258 group = substream->group;
1259 /* block freeing the group object */
1260 refcount_inc(&group->refs);
1261
1262 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1263 spin_trylock(&group->lock);
1264 if (trylock)
1265 break; /* OK */
1266
1267 /* re-lock for avoiding ABBA deadlock */
1268 snd_pcm_stream_unlock(substream);
1269 snd_pcm_group_lock(group, nonatomic);
1270 snd_pcm_stream_lock(substream);
1271
1272 /* check the group again; the above opens a small race window */
1273 if (substream->group == group)
1274 break; /* OK */
1275 /* group changed, try again */
1276 snd_pcm_group_unref(group, substream);
1277 }
1278 return group;
1279}
1280
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/*
1282 * Note: call with stream lock
1283 */
Julia Lawallb17154c2015-11-29 16:36:40 +01001284static int snd_pcm_action(const struct action_ops *ops,
Takashi Iwai877211f2005-11-17 13:59:38 +01001285 struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001286 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287{
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001288 struct snd_pcm_group *group;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 int res;
1290
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001291 group = snd_pcm_stream_group_ref(substream);
1292 if (group)
Takashi Iwaicb639a42020-01-31 16:22:14 +01001293 res = snd_pcm_action_group(ops, substream, state, true);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001294 else
1295 res = snd_pcm_action_single(ops, substream, state);
1296 snd_pcm_group_unref(group, substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 return res;
1298}
1299
1300/*
1301 * Note: don't use any locks before
1302 */
Julia Lawallb17154c2015-11-29 16:36:40 +01001303static int snd_pcm_action_lock_irq(const struct action_ops *ops,
Takashi Iwai877211f2005-11-17 13:59:38 +01001304 struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001305 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
1307 int res;
1308
Takashi Iwaie3a4bd52014-10-31 14:45:04 +01001309 snd_pcm_stream_lock_irq(substream);
1310 res = snd_pcm_action(ops, substream, state);
1311 snd_pcm_stream_unlock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 return res;
1313}
1314
1315/*
1316 */
Julia Lawallb17154c2015-11-29 16:36:40 +01001317static int snd_pcm_action_nonatomic(const struct action_ops *ops,
Takashi Iwai877211f2005-11-17 13:59:38 +01001318 struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001319 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320{
1321 int res;
1322
Takashi Iwaif57f3df2019-01-13 09:50:33 +01001323 /* Guarantee the group members won't change during non-atomic action */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 down_read(&snd_pcm_link_rwsem);
1325 if (snd_pcm_stream_linked(substream))
Takashi Iwaicb639a42020-01-31 16:22:14 +01001326 res = snd_pcm_action_group(ops, substream, state, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 else
1328 res = snd_pcm_action_single(ops, substream, state);
1329 up_read(&snd_pcm_link_rwsem);
1330 return res;
1331}
1332
1333/*
1334 * start callbacks
1335 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001336static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1337 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338{
Takashi Iwai877211f2005-11-17 13:59:38 +01001339 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1341 return -EBADFD;
1342 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1343 !snd_pcm_playback_data(substream))
1344 return -EPIPE;
Pierre-Louis Bossart2b79d7a2015-02-06 15:55:51 -06001345 runtime->trigger_tstamp_latched = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 runtime->trigger_master = substream;
1347 return 0;
1348}
1349
Takashi Iwaicb639a42020-01-31 16:22:14 +01001350static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1351 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352{
1353 if (substream->runtime->trigger_master != substream)
1354 return 0;
1355 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1356}
1357
Takashi Iwaicb639a42020-01-31 16:22:14 +01001358static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1359 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
1361 if (substream->runtime->trigger_master == substream)
1362 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1363}
1364
Takashi Iwaicb639a42020-01-31 16:22:14 +01001365static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1366 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367{
Takashi Iwai877211f2005-11-17 13:59:38 +01001368 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 snd_pcm_trigger_tstamp(substream);
Takashi Iwai6af3fb72009-05-27 10:49:26 +02001370 runtime->hw_ptr_jiffies = jiffies;
Jaroslav Kyselabd76af02010-08-18 14:16:54 +02001371 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1372 runtime->rate;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 runtime->status->state = state;
1374 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1375 runtime->silence_size > 0)
1376 snd_pcm_playback_silence(substream, ULONG_MAX);
Jie Yang90bbaf62015-10-16 17:57:46 +08001377 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378}
1379
Julia Lawallb17154c2015-11-29 16:36:40 +01001380static const struct action_ops snd_pcm_action_start = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 .pre_action = snd_pcm_pre_start,
1382 .do_action = snd_pcm_do_start,
1383 .undo_action = snd_pcm_undo_start,
1384 .post_action = snd_pcm_post_start
1385};
1386
1387/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001388 * snd_pcm_start - start all linked streams
Takashi Iwaidf8db932005-09-07 13:38:19 +02001389 * @substream: the PCM substream instance
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001390 *
1391 * Return: Zero if successful, or a negative error code.
Takashi Iwaic2c86a92017-05-10 14:33:44 +02001392 * The stream lock must be acquired before calling this function.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001394int snd_pcm_start(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
Takashi Iwai877211f2005-11-17 13:59:38 +01001396 return snd_pcm_action(&snd_pcm_action_start, substream,
1397 SNDRV_PCM_STATE_RUNNING);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398}
1399
Takashi Iwaic2c86a92017-05-10 14:33:44 +02001400/* take the stream lock and start the streams */
1401static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1402{
1403 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1404 SNDRV_PCM_STATE_RUNNING);
1405}
1406
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407/*
1408 * stop callbacks
1409 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001410static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1411 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412{
Takashi Iwai877211f2005-11-17 13:59:38 +01001413 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1415 return -EBADFD;
1416 runtime->trigger_master = substream;
1417 return 0;
1418}
1419
Takashi Iwaicb639a42020-01-31 16:22:14 +01001420static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1421 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422{
1423 if (substream->runtime->trigger_master == substream &&
Takashi Iwai700cb702021-02-06 21:36:55 +01001424 snd_pcm_running(substream)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
Takashi Iwai700cb702021-02-06 21:36:55 +01001426 substream->runtime->stop_operating = true;
1427 }
Bhaskar Chowdhury583770e2021-03-26 12:12:11 +05301428 return 0; /* unconditionally stop all substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429}
1430
Takashi Iwaicb639a42020-01-31 16:22:14 +01001431static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1432 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433{
Takashi Iwai877211f2005-11-17 13:59:38 +01001434 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435 if (runtime->status->state != state) {
1436 snd_pcm_trigger_tstamp(substream);
Takashi Iwai9bc889b2014-11-06 12:15:25 +01001437 runtime->status->state = state;
Jie Yang90bbaf62015-10-16 17:57:46 +08001438 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 }
1440 wake_up(&runtime->sleep);
Jaroslav Kyselac91a9882010-01-21 10:32:15 +01001441 wake_up(&runtime->tsleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442}
1443
Julia Lawallb17154c2015-11-29 16:36:40 +01001444static const struct action_ops snd_pcm_action_stop = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001445 .pre_action = snd_pcm_pre_stop,
1446 .do_action = snd_pcm_do_stop,
1447 .post_action = snd_pcm_post_stop
1448};
1449
1450/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001451 * snd_pcm_stop - try to stop all running streams in the substream group
Takashi Iwaidf8db932005-09-07 13:38:19 +02001452 * @substream: the PCM substream instance
1453 * @state: PCM state after stopping the stream
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001455 * The state of each stream is then changed to the given state unconditionally.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001456 *
Masanari Iida0a114582014-02-09 00:47:36 +09001457 * Return: Zero if successful, or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 */
Clemens Ladischfea952e2011-02-14 11:00:47 +01001459int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
1461 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1462}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001463EXPORT_SYMBOL(snd_pcm_stop);
1464
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001466 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
Takashi Iwaidf8db932005-09-07 13:38:19 +02001467 * @substream: the PCM substream
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468 *
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001469 * After stopping, the state is changed to SETUP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 * Unlike snd_pcm_stop(), this affects only the given stream.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001471 *
Bhaskar Chowdhury583770e2021-03-26 12:12:11 +05301472 * Return: Zero if successful, or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001474int snd_pcm_drain_done(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475{
Takashi Iwai877211f2005-11-17 13:59:38 +01001476 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1477 SNDRV_PCM_STATE_SETUP);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478}
1479
Takashi Iwai1fb85102014-11-07 17:08:28 +01001480/**
1481 * snd_pcm_stop_xrun - stop the running streams as XRUN
1482 * @substream: the PCM substream instance
Takashi Iwai1fb85102014-11-07 17:08:28 +01001483 *
1484 * This stops the given running substream (and all linked substreams) as XRUN.
1485 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1486 *
1487 * Return: Zero if successful, or a negative error code.
1488 */
1489int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1490{
1491 unsigned long flags;
Takashi Iwai1fb85102014-11-07 17:08:28 +01001492
1493 snd_pcm_stream_lock_irqsave(substream, flags);
Takashi Iwaie647f5a52018-07-04 15:08:05 +02001494 if (substream->runtime && snd_pcm_running(substream))
Takashi Iwai9cd641e2018-07-04 14:46:27 +02001495 __snd_pcm_xrun(substream);
Takashi Iwai1fb85102014-11-07 17:08:28 +01001496 snd_pcm_stream_unlock_irqrestore(substream, flags);
Takashi Iwai9cd641e2018-07-04 14:46:27 +02001497 return 0;
Takashi Iwai1fb85102014-11-07 17:08:28 +01001498}
1499EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1500
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501/*
Takashi Iwaicb639a42020-01-31 16:22:14 +01001502 * pause callbacks: pass boolean (to start pause or resume) as state argument
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001504#define pause_pushed(state) (__force bool)(state)
1505
1506static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1507 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Takashi Iwai877211f2005-11-17 13:59:38 +01001509 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1511 return -ENOSYS;
Takashi Iwaicb639a42020-01-31 16:22:14 +01001512 if (pause_pushed(state)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1514 return -EBADFD;
1515 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1516 return -EBADFD;
1517 runtime->trigger_master = substream;
1518 return 0;
1519}
1520
Takashi Iwaicb639a42020-01-31 16:22:14 +01001521static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1522 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523{
1524 if (substream->runtime->trigger_master != substream)
1525 return 0;
Jaroslav Kysela56385a12010-08-18 14:08:17 +02001526 /* some drivers might use hw_ptr to recover from the pause -
1527 update the hw_ptr now */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001528 if (pause_pushed(state))
Jaroslav Kysela56385a12010-08-18 14:08:17 +02001529 snd_pcm_update_hw_ptr(substream);
Takashi Iwai6af3fb72009-05-27 10:49:26 +02001530 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
Uwe Kleine-Königb5950762010-11-01 15:38:34 -04001531 * a delta between the current jiffies, this gives a large enough
Takashi Iwai6af3fb72009-05-27 10:49:26 +02001532 * delta, effectively to skip the check once.
1533 */
1534 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 return substream->ops->trigger(substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001536 pause_pushed(state) ?
1537 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1538 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539}
1540
Takashi Iwaicb639a42020-01-31 16:22:14 +01001541static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1542 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543{
1544 if (substream->runtime->trigger_master == substream)
1545 substream->ops->trigger(substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001546 pause_pushed(state) ?
1547 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1549}
1550
Takashi Iwaicb639a42020-01-31 16:22:14 +01001551static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1552 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553{
Takashi Iwai877211f2005-11-17 13:59:38 +01001554 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 snd_pcm_trigger_tstamp(substream);
Takashi Iwaicb639a42020-01-31 16:22:14 +01001556 if (pause_pushed(state)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
Jie Yang90bbaf62015-10-16 17:57:46 +08001558 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 wake_up(&runtime->sleep);
Jaroslav Kyselac91a9882010-01-21 10:32:15 +01001560 wake_up(&runtime->tsleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 } else {
1562 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
Jie Yang90bbaf62015-10-16 17:57:46 +08001563 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 }
1565}
1566
Julia Lawallb17154c2015-11-29 16:36:40 +01001567static const struct action_ops snd_pcm_action_pause = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 .pre_action = snd_pcm_pre_pause,
1569 .do_action = snd_pcm_do_pause,
1570 .undo_action = snd_pcm_undo_pause,
1571 .post_action = snd_pcm_post_pause
1572};
1573
1574/*
1575 * Push/release the pause for all linked streams.
1576 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001577static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578{
Takashi Iwaicb639a42020-01-31 16:22:14 +01001579 return snd_pcm_action(&snd_pcm_action_pause, substream,
1580 (__force snd_pcm_state_t)push);
1581}
1582
1583static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1584 bool push)
1585{
1586 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1587 (__force snd_pcm_state_t)push);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588}
1589
1590#ifdef CONFIG_PM
Takashi Iwaicb639a42020-01-31 16:22:14 +01001591/* suspend callback: state argument ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592
Takashi Iwaicb639a42020-01-31 16:22:14 +01001593static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1594 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595{
Takashi Iwai877211f2005-11-17 13:59:38 +01001596 struct snd_pcm_runtime *runtime = substream->runtime;
Takashi Iwai113ce082019-03-25 10:38:58 +01001597 switch (runtime->status->state) {
1598 case SNDRV_PCM_STATE_SUSPENDED:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 return -EBUSY;
Takashi Iwai113ce082019-03-25 10:38:58 +01001600 /* unresumable PCM state; return -EBUSY for skipping suspend */
1601 case SNDRV_PCM_STATE_OPEN:
1602 case SNDRV_PCM_STATE_SETUP:
1603 case SNDRV_PCM_STATE_DISCONNECTED:
1604 return -EBUSY;
1605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 runtime->trigger_master = substream;
1607 return 0;
1608}
1609
Takashi Iwaicb639a42020-01-31 16:22:14 +01001610static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1611 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612{
Takashi Iwai877211f2005-11-17 13:59:38 +01001613 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 if (runtime->trigger_master != substream)
1615 return 0;
1616 if (! snd_pcm_running(substream))
1617 return 0;
1618 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
Takashi Iwai2c87c1a2021-02-06 21:36:54 +01001619 runtime->stop_operating = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 return 0; /* suspend unconditionally */
1621}
1622
Takashi Iwaicb639a42020-01-31 16:22:14 +01001623static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1624 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625{
Takashi Iwai877211f2005-11-17 13:59:38 +01001626 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 snd_pcm_trigger_tstamp(substream);
Takashi Iwai9bc889b2014-11-06 12:15:25 +01001628 runtime->status->suspended_state = runtime->status->state;
1629 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
Jie Yang90bbaf62015-10-16 17:57:46 +08001630 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 wake_up(&runtime->sleep);
Jaroslav Kyselac91a9882010-01-21 10:32:15 +01001632 wake_up(&runtime->tsleep);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633}
1634
Julia Lawallb17154c2015-11-29 16:36:40 +01001635static const struct action_ops snd_pcm_action_suspend = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 .pre_action = snd_pcm_pre_suspend,
1637 .do_action = snd_pcm_do_suspend,
1638 .post_action = snd_pcm_post_suspend
1639};
1640
Takashi Iwaice7f93e22019-01-15 10:54:02 +01001641/*
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001642 * snd_pcm_suspend - trigger SUSPEND to all linked streams
Takashi Iwaidf8db932005-09-07 13:38:19 +02001643 * @substream: the PCM substream
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 * After this call, all streams are changed to SUSPENDED state.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001646 *
Takashi Iwaice7f93e22019-01-15 10:54:02 +01001647 * Return: Zero if successful, or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 */
Takashi Iwaice7f93e22019-01-15 10:54:02 +01001649static int snd_pcm_suspend(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650{
1651 int err;
1652 unsigned long flags;
1653
1654 snd_pcm_stream_lock_irqsave(substream, flags);
Takashi Iwaicb639a42020-01-31 16:22:14 +01001655 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1656 ACTION_ARG_IGNORE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 snd_pcm_stream_unlock_irqrestore(substream, flags);
1658 return err;
1659}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001660
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001662 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
Takashi Iwaidf8db932005-09-07 13:38:19 +02001663 * @pcm: the PCM instance
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665 * After this call, all streams are changed to SUSPENDED state.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001666 *
1667 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001669int snd_pcm_suspend_all(struct snd_pcm *pcm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670{
Takashi Iwai877211f2005-11-17 13:59:38 +01001671 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 int stream, err = 0;
1673
Takashi Iwai603bf522005-11-17 15:59:14 +01001674 if (! pcm)
1675 return 0;
1676
Takashi Iwai8d19b4e2021-02-06 21:36:56 +01001677 for_each_pcm_substream(pcm, stream, substream) {
1678 /* FIXME: the open/close code should lock this as well */
1679 if (!substream->runtime)
1680 continue;
Ranjani Sridharand9c0b2a2019-02-08 17:29:53 -06001681
Takashi Iwai8d19b4e2021-02-06 21:36:56 +01001682 /*
1683 * Skip BE dai link PCM's that are internal and may
1684 * not have their substream ops set.
1685 */
1686 if (!substream->ops)
1687 continue;
Ranjani Sridharand9c0b2a2019-02-08 17:29:53 -06001688
Takashi Iwai8d19b4e2021-02-06 21:36:56 +01001689 err = snd_pcm_suspend(substream);
1690 if (err < 0 && err != -EBUSY)
1691 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692 }
Takashi Iwai2c87c1a2021-02-06 21:36:54 +01001693
Takashi Iwai8d19b4e2021-02-06 21:36:56 +01001694 for_each_pcm_substream(pcm, stream, substream)
1695 snd_pcm_sync_stop(substream, false);
Takashi Iwai2c87c1a2021-02-06 21:36:54 +01001696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 return 0;
1698}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02001699EXPORT_SYMBOL(snd_pcm_suspend_all);
1700
Takashi Iwaicb639a42020-01-31 16:22:14 +01001701/* resume callbacks: state argument ignored */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702
Takashi Iwaicb639a42020-01-31 16:22:14 +01001703static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1704 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705{
Takashi Iwai877211f2005-11-17 13:59:38 +01001706 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1708 return -ENOSYS;
1709 runtime->trigger_master = substream;
1710 return 0;
1711}
1712
Takashi Iwaicb639a42020-01-31 16:22:14 +01001713static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1714 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715{
Takashi Iwai877211f2005-11-17 13:59:38 +01001716 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717 if (runtime->trigger_master != substream)
1718 return 0;
1719 /* DMA not running previously? */
1720 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1721 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1722 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1723 return 0;
1724 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1725}
1726
Takashi Iwaicb639a42020-01-31 16:22:14 +01001727static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1728 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729{
1730 if (substream->runtime->trigger_master == substream &&
1731 snd_pcm_running(substream))
1732 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1733}
1734
Takashi Iwaicb639a42020-01-31 16:22:14 +01001735static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1736 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737{
Takashi Iwai877211f2005-11-17 13:59:38 +01001738 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 snd_pcm_trigger_tstamp(substream);
Takashi Iwai9bc889b2014-11-06 12:15:25 +01001740 runtime->status->state = runtime->status->suspended_state;
Jie Yang90bbaf62015-10-16 17:57:46 +08001741 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742}
1743
Julia Lawallb17154c2015-11-29 16:36:40 +01001744static const struct action_ops snd_pcm_action_resume = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 .pre_action = snd_pcm_pre_resume,
1746 .do_action = snd_pcm_do_resume,
1747 .undo_action = snd_pcm_undo_resume,
1748 .post_action = snd_pcm_post_resume
1749};
1750
Takashi Iwai877211f2005-11-17 13:59:38 +01001751static int snd_pcm_resume(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752{
Takashi Iwaicb639a42020-01-31 16:22:14 +01001753 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1754 ACTION_ARG_IGNORE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
1757#else
1758
Takashi Iwai877211f2005-11-17 13:59:38 +01001759static int snd_pcm_resume(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760{
1761 return -ENOSYS;
1762}
1763
1764#endif /* CONFIG_PM */
1765
1766/*
1767 * xrun ioctl
1768 *
1769 * Change the RUNNING stream(s) to XRUN state.
1770 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001771static int snd_pcm_xrun(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772{
Takashi Iwai877211f2005-11-17 13:59:38 +01001773 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 int result;
1775
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 snd_pcm_stream_lock_irq(substream);
1777 switch (runtime->status->state) {
1778 case SNDRV_PCM_STATE_XRUN:
1779 result = 0; /* already there */
1780 break;
1781 case SNDRV_PCM_STATE_RUNNING:
Takashi Iwai9cd641e2018-07-04 14:46:27 +02001782 __snd_pcm_xrun(substream);
1783 result = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 break;
1785 default:
1786 result = -EBADFD;
1787 }
1788 snd_pcm_stream_unlock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 return result;
1790}
1791
1792/*
1793 * reset ioctl
1794 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001795/* reset callbacks: state argument ignored */
1796static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1797 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798{
Takashi Iwai877211f2005-11-17 13:59:38 +01001799 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001800 switch (runtime->status->state) {
1801 case SNDRV_PCM_STATE_RUNNING:
1802 case SNDRV_PCM_STATE_PREPARED:
1803 case SNDRV_PCM_STATE_PAUSED:
1804 case SNDRV_PCM_STATE_SUSPENDED:
1805 return 0;
1806 default:
1807 return -EBADFD;
1808 }
1809}
1810
Takashi Iwaicb639a42020-01-31 16:22:14 +01001811static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1812 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813{
Takashi Iwai877211f2005-11-17 13:59:38 +01001814 struct snd_pcm_runtime *runtime = substream->runtime;
Takashi Iwaifc033cb2019-11-17 09:53:03 +01001815 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 if (err < 0)
1817 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 runtime->hw_ptr_base = 0;
Jaroslav Kyselae7636922010-01-26 17:08:24 +01001819 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1820 runtime->status->hw_ptr % runtime->period_size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 runtime->silence_start = runtime->status->hw_ptr;
1822 runtime->silence_filled = 0;
1823 return 0;
1824}
1825
Takashi Iwaicb639a42020-01-31 16:22:14 +01001826static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1827 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828{
Takashi Iwai877211f2005-11-17 13:59:38 +01001829 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 runtime->control->appl_ptr = runtime->status->hw_ptr;
1831 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1832 runtime->silence_size > 0)
1833 snd_pcm_playback_silence(substream, ULONG_MAX);
1834}
1835
Julia Lawallb17154c2015-11-29 16:36:40 +01001836static const struct action_ops snd_pcm_action_reset = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 .pre_action = snd_pcm_pre_reset,
1838 .do_action = snd_pcm_do_reset,
1839 .post_action = snd_pcm_post_reset
1840};
1841
Takashi Iwai877211f2005-11-17 13:59:38 +01001842static int snd_pcm_reset(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843{
Takashi Iwaicb639a42020-01-31 16:22:14 +01001844 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1845 ACTION_ARG_IGNORE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846}
1847
1848/*
1849 * prepare ioctl
1850 */
Takashi Iwaicb639a42020-01-31 16:22:14 +01001851/* pass f_flags as state argument */
Takashi Iwai0df63e42006-04-28 15:13:41 +02001852static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001853 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854{
Takashi Iwai877211f2005-11-17 13:59:38 +01001855 struct snd_pcm_runtime *runtime = substream->runtime;
Takashi Iwaicb639a42020-01-31 16:22:14 +01001856 int f_flags = (__force int)state;
1857
Takashi Iwaide1b8b92006-11-08 15:41:29 +01001858 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1859 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 return -EBADFD;
1861 if (snd_pcm_running(substream))
1862 return -EBUSY;
Takashi Iwai0df63e42006-04-28 15:13:41 +02001863 substream->f_flags = f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 return 0;
1865}
1866
Takashi Iwaicb639a42020-01-31 16:22:14 +01001867static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1868 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869{
1870 int err;
Takashi Iwai29bb2742021-02-06 21:36:53 +01001871 snd_pcm_sync_stop(substream, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 err = substream->ops->prepare(substream);
1873 if (err < 0)
1874 return err;
Takashi Iwaicb639a42020-01-31 16:22:14 +01001875 return snd_pcm_do_reset(substream, state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876}
1877
Takashi Iwaicb639a42020-01-31 16:22:14 +01001878static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1879 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880{
Takashi Iwai877211f2005-11-17 13:59:38 +01001881 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 runtime->control->appl_ptr = runtime->status->hw_ptr;
Takashi Iwai9b0573c02012-10-12 15:07:34 +02001883 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884}
1885
Julia Lawallb17154c2015-11-29 16:36:40 +01001886static const struct action_ops snd_pcm_action_prepare = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 .pre_action = snd_pcm_pre_prepare,
1888 .do_action = snd_pcm_do_prepare,
1889 .post_action = snd_pcm_post_prepare
1890};
1891
1892/**
Randy Dunlap1c85cc62008-10-15 14:38:40 -07001893 * snd_pcm_prepare - prepare the PCM substream to be triggerable
Takashi Iwaidf8db932005-09-07 13:38:19 +02001894 * @substream: the PCM substream instance
Takashi Iwai0df63e42006-04-28 15:13:41 +02001895 * @file: file to refer f_flags
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001896 *
1897 * Return: Zero if successful, or a negative error code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 */
Takashi Iwai0df63e42006-04-28 15:13:41 +02001899static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1900 struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901{
Takashi Iwai0df63e42006-04-28 15:13:41 +02001902 int f_flags;
1903
1904 if (file)
1905 f_flags = file->f_flags;
1906 else
1907 f_flags = substream->f_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908
Takashi Iwai1b745cd2016-05-24 15:40:03 +02001909 snd_pcm_stream_lock_irq(substream);
1910 switch (substream->runtime->status->state) {
1911 case SNDRV_PCM_STATE_PAUSED:
Takashi Iwaicb639a42020-01-31 16:22:14 +01001912 snd_pcm_pause(substream, false);
Gustavo A. R. Silvac0dbbda2020-07-08 15:32:36 -05001913 fallthrough;
Takashi Iwai1b745cd2016-05-24 15:40:03 +02001914 case SNDRV_PCM_STATE_SUSPENDED:
1915 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1916 break;
1917 }
1918 snd_pcm_stream_unlock_irq(substream);
1919
Takashi Iwai68b4acd2016-05-24 15:07:39 +02001920 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
Takashi Iwaicb639a42020-01-31 16:22:14 +01001921 substream,
1922 (__force snd_pcm_state_t)f_flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923}
1924
1925/*
1926 * drain ioctl
1927 */
1928
Takashi Iwaicb639a42020-01-31 16:22:14 +01001929/* drain init callbacks: state argument ignored */
1930static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
1931 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932{
Takashi Iwai4f7c39d2012-05-21 11:59:57 +02001933 struct snd_pcm_runtime *runtime = substream->runtime;
1934 switch (runtime->status->state) {
1935 case SNDRV_PCM_STATE_OPEN:
1936 case SNDRV_PCM_STATE_DISCONNECTED:
1937 case SNDRV_PCM_STATE_SUSPENDED:
1938 return -EBADFD;
1939 }
1940 runtime->trigger_master = substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return 0;
1942}
1943
Takashi Iwaicb639a42020-01-31 16:22:14 +01001944static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
1945 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946{
Takashi Iwai877211f2005-11-17 13:59:38 +01001947 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1949 switch (runtime->status->state) {
1950 case SNDRV_PCM_STATE_PREPARED:
1951 /* start playback stream if possible */
1952 if (! snd_pcm_playback_empty(substream)) {
1953 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
1954 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
Takashi Iwai70372a72014-12-18 10:02:41 +01001955 } else {
1956 runtime->status->state = SNDRV_PCM_STATE_SETUP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 }
1958 break;
1959 case SNDRV_PCM_STATE_RUNNING:
1960 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
1961 break;
Takashi Iwai4f7c39d2012-05-21 11:59:57 +02001962 case SNDRV_PCM_STATE_XRUN:
1963 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1964 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 default:
1966 break;
1967 }
1968 } else {
1969 /* stop running stream */
1970 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
Takashi Iwaicb639a42020-01-31 16:22:14 +01001971 snd_pcm_state_t new_state;
1972
1973 new_state = snd_pcm_capture_avail(runtime) > 0 ?
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
Marcin Ślusarzb05e5782007-12-14 12:50:16 +01001975 snd_pcm_do_stop(substream, new_state);
1976 snd_pcm_post_stop(substream, new_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 }
1978 }
Libin Yang48d88292014-12-31 22:09:54 +08001979
1980 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
1981 runtime->trigger_master == substream &&
1982 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
1983 return substream->ops->trigger(substream,
1984 SNDRV_PCM_TRIGGER_DRAIN);
1985
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 return 0;
1987}
1988
Takashi Iwaicb639a42020-01-31 16:22:14 +01001989static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
1990 snd_pcm_state_t state)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991{
1992}
1993
Julia Lawallb17154c2015-11-29 16:36:40 +01001994static const struct action_ops snd_pcm_action_drain_init = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 .pre_action = snd_pcm_pre_drain_init,
1996 .do_action = snd_pcm_do_drain_init,
1997 .post_action = snd_pcm_post_drain_init
1998};
1999
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000/*
2001 * Drain the stream(s).
2002 * When the substream is linked, sync until the draining of all playback streams
2003 * is finished.
2004 * After this call, all streams are supposed to be either SETUP or DRAINING
2005 * (capture only) state.
2006 */
Takashi Iwai4cdc1152009-08-20 16:40:16 +02002007static int snd_pcm_drain(struct snd_pcm_substream *substream,
2008 struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009{
Takashi Iwai877211f2005-11-17 13:59:38 +01002010 struct snd_card *card;
2011 struct snd_pcm_runtime *runtime;
Takashi Iwaief991b92007-02-22 12:52:53 +01002012 struct snd_pcm_substream *s;
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002013 struct snd_pcm_group *group;
Ingo Molnarac6424b2017-06-20 12:06:13 +02002014 wait_queue_entry_t wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 int result = 0;
Takashi Iwai4cdc1152009-08-20 16:40:16 +02002016 int nonblock = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018 card = substream->pcm->card;
2019 runtime = substream->runtime;
2020
2021 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2022 return -EBADFD;
2023
Takashi Iwai4cdc1152009-08-20 16:40:16 +02002024 if (file) {
2025 if (file->f_flags & O_NONBLOCK)
2026 nonblock = 1;
2027 } else if (substream->f_flags & O_NONBLOCK)
2028 nonblock = 1;
2029
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002030 snd_pcm_stream_lock_irq(substream);
2031 /* resume pause */
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002032 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
Takashi Iwaicb639a42020-01-31 16:22:14 +01002033 snd_pcm_pause(substream, false);
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002034
2035 /* pre-start/stop - all running streams are changed to DRAINING state */
Takashi Iwaicb639a42020-01-31 16:22:14 +01002036 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2037 ACTION_ARG_IGNORE);
Takashi Iwai4cdc1152009-08-20 16:40:16 +02002038 if (result < 0)
2039 goto unlock;
2040 /* in non-blocking, we don't wait in ioctl but let caller poll */
2041 if (nonblock) {
2042 result = -EAGAIN;
2043 goto unlock;
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002044 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045
2046 for (;;) {
2047 long tout;
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002048 struct snd_pcm_runtime *to_check;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 if (signal_pending(current)) {
2050 result = -ERESTARTSYS;
2051 break;
2052 }
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002053 /* find a substream to drain */
2054 to_check = NULL;
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002055 group = snd_pcm_stream_group_ref(substream);
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002056 snd_pcm_group_for_each_entry(s, substream) {
2057 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2058 continue;
2059 runtime = s->runtime;
2060 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
2061 to_check = runtime;
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002062 break;
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002063 }
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002064 }
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002065 snd_pcm_group_unref(group, substream);
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002066 if (!to_check)
2067 break; /* all drained */
2068 init_waitqueue_entry(&wait, current);
Yuki Tsunashima37151a42019-07-29 17:10:36 +02002069 set_current_state(TASK_INTERRUPTIBLE);
Takashi Iwaid3a7dcf2009-09-17 18:46:26 +02002070 add_wait_queue(&to_check->sleep, &wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071 snd_pcm_stream_unlock_irq(substream);
Takashi Iwaif2b36142011-05-26 08:09:38 +02002072 if (runtime->no_period_wakeup)
2073 tout = MAX_SCHEDULE_TIMEOUT;
2074 else {
2075 tout = 10;
2076 if (runtime->rate) {
2077 long t = runtime->period_size * 2 / runtime->rate;
2078 tout = max(t, tout);
2079 }
2080 tout = msecs_to_jiffies(tout * 1000);
2081 }
Yuki Tsunashima37151a42019-07-29 17:10:36 +02002082 tout = schedule_timeout(tout);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002083
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 snd_pcm_stream_lock_irq(substream);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002085 group = snd_pcm_stream_group_ref(substream);
2086 snd_pcm_group_for_each_entry(s, substream) {
2087 if (s->runtime == to_check) {
2088 remove_wait_queue(&to_check->sleep, &wait);
2089 break;
2090 }
2091 }
2092 snd_pcm_group_unref(group, substream);
2093
Takashi Iwai0914f792012-10-16 16:43:39 +02002094 if (card->shutdown) {
2095 result = -ENODEV;
2096 break;
2097 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098 if (tout == 0) {
2099 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
2100 result = -ESTRPIPE;
2101 else {
Takashi Iwai09e56df2014-02-04 18:19:48 +01002102 dev_dbg(substream->pcm->card->dev,
2103 "playback drain error (DMA or IRQ trouble?)\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2105 result = -EIO;
2106 }
2107 break;
2108 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 }
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002110
Takashi Iwai4cdc1152009-08-20 16:40:16 +02002111 unlock:
Takashi Iwai21cb2a22005-05-31 14:35:31 +02002112 snd_pcm_stream_unlock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
2114 return result;
2115}
2116
2117/*
2118 * drop ioctl
2119 *
2120 * Immediately put all linked substreams into SETUP state.
2121 */
Takashi Iwai877211f2005-11-17 13:59:38 +01002122static int snd_pcm_drop(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123{
Takashi Iwai877211f2005-11-17 13:59:38 +01002124 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 int result = 0;
2126
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002127 if (PCM_RUNTIME_CHECK(substream))
2128 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
Takashi Iwaide1b8b92006-11-08 15:41:29 +01002131 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
Takashi Iwai4b95ff72016-05-24 15:08:31 +02002132 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 return -EBADFD;
2134
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 snd_pcm_stream_lock_irq(substream);
2136 /* resume pause */
2137 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
Takashi Iwaicb639a42020-01-31 16:22:14 +01002138 snd_pcm_pause(substream, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139
2140 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2141 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2142 snd_pcm_stream_unlock_irq(substream);
Takashi Iwai24e8fc42008-09-25 17:51:11 +02002143
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 return result;
2145}
2146
2147
Al Viro0888c322013-06-05 14:09:55 -04002148static bool is_pcm_file(struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149{
Al Viro0888c322013-06-05 14:09:55 -04002150 struct inode *inode = file_inode(file);
Takashi Iwaid819fb212019-01-13 09:25:42 +01002151 struct snd_pcm *pcm;
Clemens Ladischf87135f2005-11-20 14:06:59 +01002152 unsigned int minor;
2153
Al Viro0888c322013-06-05 14:09:55 -04002154 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2155 return false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 minor = iminor(inode);
Takashi Iwaid819fb212019-01-13 09:25:42 +01002157 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2158 if (!pcm)
2159 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2160 if (!pcm)
2161 return false;
2162 snd_card_unref(pcm->card);
2163 return true;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002164}
2165
2166/*
2167 * PCM link handling
2168 */
Takashi Iwai877211f2005-11-17 13:59:38 +01002169static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170{
2171 int res = 0;
Takashi Iwai877211f2005-11-17 13:59:38 +01002172 struct snd_pcm_file *pcm_file;
2173 struct snd_pcm_substream *substream1;
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002174 struct snd_pcm_group *group, *target_group;
2175 bool nonatomic = substream->pcm->nonatomic;
Al Viro0888c322013-06-05 14:09:55 -04002176 struct fd f = fdget(fd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177
Al Viro0888c322013-06-05 14:09:55 -04002178 if (!f.file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 return -EBADFD;
Al Viro0888c322013-06-05 14:09:55 -04002180 if (!is_pcm_file(f.file)) {
2181 res = -EBADFD;
2182 goto _badf;
2183 }
2184 pcm_file = f.file->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 substream1 = pcm_file->substream;
Michał Mirosław951e27362020-06-08 18:50:39 +02002186
2187 if (substream == substream1) {
2188 res = -EINVAL;
2189 goto _badf;
2190 }
2191
Takashi Iwai73365cb2019-01-13 09:35:17 +01002192 group = kzalloc(sizeof(*group), GFP_KERNEL);
Takashi Iwai16625912012-03-13 15:55:43 +01002193 if (!group) {
2194 res = -ENOMEM;
2195 goto _nolock;
2196 }
Takashi Iwai73365cb2019-01-13 09:35:17 +01002197 snd_pcm_group_init(group);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002198
Takashi Iwaiecb41f02019-01-22 14:29:51 +01002199 down_write(&snd_pcm_link_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
Takashi Iwai257f8cc2014-08-29 15:32:29 +02002201 substream->runtime->status->state != substream1->runtime->status->state ||
2202 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 res = -EBADFD;
2204 goto _end;
2205 }
2206 if (snd_pcm_stream_linked(substream1)) {
2207 res = -EALREADY;
2208 goto _end;
2209 }
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002210
2211 snd_pcm_stream_lock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 if (!snd_pcm_stream_linked(substream)) {
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002213 snd_pcm_group_assign(substream, group);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002214 group = NULL; /* assigned, don't free this one below */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 }
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002216 target_group = substream->group;
2217 snd_pcm_stream_unlock_irq(substream);
2218
2219 snd_pcm_group_lock_irq(target_group, nonatomic);
Michał Mirosławe18035c2020-06-08 12:06:32 +02002220 snd_pcm_stream_lock_nested(substream1);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002221 snd_pcm_group_assign(substream1, target_group);
Takashi Iwai0e279dc2019-07-19 10:55:05 +02002222 refcount_inc(&target_group->refs);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002223 snd_pcm_stream_unlock(substream1);
2224 snd_pcm_group_unlock_irq(target_group, nonatomic);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 _end:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 up_write(&snd_pcm_link_rwsem);
Takashi Iwai16625912012-03-13 15:55:43 +01002227 _nolock:
Al Virodd6c5cd2013-06-05 14:07:08 -04002228 kfree(group);
Al Viro0888c322013-06-05 14:09:55 -04002229 _badf:
2230 fdput(f);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 return res;
2232}
2233
Takashi Iwai877211f2005-11-17 13:59:38 +01002234static void relink_to_local(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235{
Michał Mirosławe18035c2020-06-08 12:06:32 +02002236 snd_pcm_stream_lock_nested(substream);
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002237 snd_pcm_group_assign(substream, &substream->self_group);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002238 snd_pcm_stream_unlock(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239}
2240
Takashi Iwai877211f2005-11-17 13:59:38 +01002241static int snd_pcm_unlink(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242{
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002243 struct snd_pcm_group *group;
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002244 bool nonatomic = substream->pcm->nonatomic;
2245 bool do_free = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246 int res = 0;
2247
Takashi Iwaiecb41f02019-01-22 14:29:51 +01002248 down_write(&snd_pcm_link_rwsem);
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002249
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 if (!snd_pcm_stream_linked(substream)) {
2251 res = -EALREADY;
2252 goto _end;
2253 }
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002254
2255 group = substream->group;
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002256 snd_pcm_group_lock_irq(group, nonatomic);
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002257
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 relink_to_local(substream);
Takashi Iwai0e279dc2019-07-19 10:55:05 +02002259 refcount_dec(&group->refs);
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002260
2261 /* detach the last stream, too */
2262 if (list_is_singular(&group->substreams)) {
Takashi Iwai7df5a5f2019-01-13 10:19:32 +01002263 relink_to_local(list_first_entry(&group->substreams,
2264 struct snd_pcm_substream,
2265 link_list));
Takashi Iwai0e279dc2019-07-19 10:55:05 +02002266 do_free = refcount_dec_and_test(&group->refs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 }
Takashi Iwaia41c4cb2019-01-13 09:40:21 +01002268
Takashi Iwaif57f3df2019-01-13 09:50:33 +01002269 snd_pcm_group_unlock_irq(group, nonatomic);
2270 if (do_free)
2271 kfree(group);
2272
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273 _end:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 up_write(&snd_pcm_link_rwsem);
2275 return res;
2276}
2277
2278/*
2279 * hw configurator
2280 */
Takashi Iwai877211f2005-11-17 13:59:38 +01002281static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2282 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283{
Takashi Iwai877211f2005-11-17 13:59:38 +01002284 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2286 hw_param_interval_c(params, rule->deps[1]), &t);
2287 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2288}
2289
Takashi Iwai877211f2005-11-17 13:59:38 +01002290static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2291 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292{
Takashi Iwai877211f2005-11-17 13:59:38 +01002293 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2295 hw_param_interval_c(params, rule->deps[1]), &t);
2296 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2297}
2298
Takashi Iwai877211f2005-11-17 13:59:38 +01002299static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2300 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301{
Takashi Iwai877211f2005-11-17 13:59:38 +01002302 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2304 hw_param_interval_c(params, rule->deps[1]),
2305 (unsigned long) rule->private, &t);
2306 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2307}
2308
Takashi Iwai877211f2005-11-17 13:59:38 +01002309static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2310 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311{
Takashi Iwai877211f2005-11-17 13:59:38 +01002312 struct snd_interval t;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2314 (unsigned long) rule->private,
2315 hw_param_interval_c(params, rule->deps[1]), &t);
2316 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2317}
2318
Takashi Iwai877211f2005-11-17 13:59:38 +01002319static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2320 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321{
Takashi Iwaiba71d222020-02-06 17:39:42 +01002322 snd_pcm_format_t k;
Takashi Sakamotob55f9fd2017-05-17 08:48:20 +09002323 const struct snd_interval *i =
2324 hw_param_interval_c(params, rule->deps[0]);
Takashi Iwai877211f2005-11-17 13:59:38 +01002325 struct snd_mask m;
2326 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 snd_mask_any(&m);
Takashi Iwaiba71d222020-02-06 17:39:42 +01002328 pcm_for_each_format(k) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329 int bits;
Takashi Iwaiba71d222020-02-06 17:39:42 +01002330 if (!snd_mask_test_format(mask, k))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002331 continue;
2332 bits = snd_pcm_format_physical_width(k);
2333 if (bits <= 0)
2334 continue; /* ignore invalid formats */
2335 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
Takashi Iwaiba71d222020-02-06 17:39:42 +01002336 snd_mask_reset(&m, (__force unsigned)k);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 }
2338 return snd_mask_refine(mask, &m);
2339}
2340
Takashi Iwai877211f2005-11-17 13:59:38 +01002341static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2342 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343{
Takashi Iwai877211f2005-11-17 13:59:38 +01002344 struct snd_interval t;
Takashi Iwaiba71d222020-02-06 17:39:42 +01002345 snd_pcm_format_t k;
2346
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 t.min = UINT_MAX;
2348 t.max = 0;
2349 t.openmin = 0;
2350 t.openmax = 0;
Takashi Iwaiba71d222020-02-06 17:39:42 +01002351 pcm_for_each_format(k) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002352 int bits;
Takashi Iwaiba71d222020-02-06 17:39:42 +01002353 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002354 continue;
2355 bits = snd_pcm_format_physical_width(k);
2356 if (bits <= 0)
2357 continue; /* ignore invalid formats */
2358 if (t.min > (unsigned)bits)
2359 t.min = bits;
2360 if (t.max < (unsigned)bits)
2361 t.max = bits;
2362 }
2363 t.integer = 1;
2364 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2365}
2366
2367#if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2368#error "Change this table"
2369#endif
2370
Takashi Sakamoto8b674302017-05-17 08:48:17 +09002371static const unsigned int rates[] = {
2372 5512, 8000, 11025, 16000, 22050, 32000, 44100,
Vidyakumar Athota4cc45312019-08-22 10:56:50 +01002373 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
Takashi Sakamoto8b674302017-05-17 08:48:17 +09002374};
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375
Clemens Ladisch7653d552007-08-13 17:38:54 +02002376const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2377 .count = ARRAY_SIZE(rates),
2378 .list = rates,
2379};
2380
Takashi Iwai877211f2005-11-17 13:59:38 +01002381static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2382 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002383{
Takashi Iwai877211f2005-11-17 13:59:38 +01002384 struct snd_pcm_hardware *hw = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002385 return snd_interval_list(hw_param_interval(params, rule->var),
Clemens Ladisch7653d552007-08-13 17:38:54 +02002386 snd_pcm_known_rates.count,
2387 snd_pcm_known_rates.list, hw->rates);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002388}
2389
Takashi Iwai877211f2005-11-17 13:59:38 +01002390static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2391 struct snd_pcm_hw_rule *rule)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002392{
Takashi Iwai877211f2005-11-17 13:59:38 +01002393 struct snd_interval t;
2394 struct snd_pcm_substream *substream = rule->private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002395 t.min = 0;
2396 t.max = substream->buffer_bytes_max;
2397 t.openmin = 0;
2398 t.openmax = 0;
2399 t.integer = 1;
2400 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2401}
2402
Takashi Iwaid6621172020-01-16 17:28:25 +01002403static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002404{
Takashi Iwai877211f2005-11-17 13:59:38 +01002405 struct snd_pcm_runtime *runtime = substream->runtime;
2406 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407 int k, err;
2408
2409 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2410 snd_mask_any(constrs_mask(constrs, k));
2411 }
2412
2413 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2414 snd_interval_any(constrs_interval(constrs, k));
2415 }
2416
2417 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2418 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2419 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2420 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2421 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2422
2423 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2424 snd_pcm_hw_rule_format, NULL,
2425 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2426 if (err < 0)
2427 return err;
2428 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2429 snd_pcm_hw_rule_sample_bits, NULL,
2430 SNDRV_PCM_HW_PARAM_FORMAT,
2431 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2432 if (err < 0)
2433 return err;
2434 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2435 snd_pcm_hw_rule_div, NULL,
2436 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2437 if (err < 0)
2438 return err;
2439 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2440 snd_pcm_hw_rule_mul, NULL,
2441 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2442 if (err < 0)
2443 return err;
2444 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2445 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2446 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2447 if (err < 0)
2448 return err;
2449 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2450 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2451 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2452 if (err < 0)
2453 return err;
2454 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2455 snd_pcm_hw_rule_div, NULL,
2456 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2457 if (err < 0)
2458 return err;
2459 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2460 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2461 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2462 if (err < 0)
2463 return err;
2464 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2465 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2466 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2467 if (err < 0)
2468 return err;
2469 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2470 snd_pcm_hw_rule_div, NULL,
2471 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2472 if (err < 0)
2473 return err;
2474 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2475 snd_pcm_hw_rule_div, NULL,
2476 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2477 if (err < 0)
2478 return err;
2479 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2480 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2481 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2482 if (err < 0)
2483 return err;
2484 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2485 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2486 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2487 if (err < 0)
2488 return err;
2489 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2490 snd_pcm_hw_rule_mul, NULL,
2491 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2492 if (err < 0)
2493 return err;
2494 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2495 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2496 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2497 if (err < 0)
2498 return err;
2499 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2500 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2501 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2502 if (err < 0)
2503 return err;
2504 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2505 snd_pcm_hw_rule_muldivk, (void*) 8,
2506 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2507 if (err < 0)
2508 return err;
2509 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2510 snd_pcm_hw_rule_muldivk, (void*) 8,
2511 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2512 if (err < 0)
2513 return err;
2514 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2515 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2516 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2517 if (err < 0)
2518 return err;
2519 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2520 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2521 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2522 if (err < 0)
2523 return err;
2524 return 0;
2525}
2526
Takashi Iwaid6621172020-01-16 17:28:25 +01002527static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528{
Takashi Iwai877211f2005-11-17 13:59:38 +01002529 struct snd_pcm_runtime *runtime = substream->runtime;
2530 struct snd_pcm_hardware *hw = &runtime->hw;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002531 int err;
2532 unsigned int mask = 0;
2533
2534 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002535 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002537 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
Takashi Iwai63825f32014-10-22 12:04:46 +02002538 if (hw_support_mmap(substream)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002540 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002542 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002544 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 }
2546 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002547 if (err < 0)
2548 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549
2550 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002551 if (err < 0)
2552 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553
Takashi Iwaif9b0c052020-02-06 17:39:43 +01002554 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2555 PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002556 if (err < 0)
2557 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558
2559 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2560 hw->channels_min, hw->channels_max);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002561 if (err < 0)
2562 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563
2564 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2565 hw->rate_min, hw->rate_max);
Guennadi Liakhovetski8b90ca02009-12-24 01:17:46 +01002566 if (err < 0)
2567 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568
2569 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2570 hw->period_bytes_min, hw->period_bytes_max);
Guennadi Liakhovetski8b90ca02009-12-24 01:17:46 +01002571 if (err < 0)
2572 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573
2574 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2575 hw->periods_min, hw->periods_max);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002576 if (err < 0)
2577 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002578
2579 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2580 hw->period_bytes_min, hw->buffer_bytes_max);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002581 if (err < 0)
2582 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002583
2584 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2585 snd_pcm_hw_rule_buffer_bytes_max, substream,
2586 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2587 if (err < 0)
2588 return err;
2589
2590 /* FIXME: remove */
2591 if (runtime->dma_bytes) {
2592 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002593 if (err < 0)
Sachin Kamat6cf95152012-11-21 14:36:55 +05302594 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002595 }
2596
2597 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2598 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2599 snd_pcm_hw_rule_rate, hw,
2600 SNDRV_PCM_HW_PARAM_RATE, -1);
2601 if (err < 0)
2602 return err;
2603 }
2604
2605 /* FIXME: this belong to lowlevel */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2607
2608 return 0;
2609}
2610
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002611static void pcm_release_private(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612{
Takashi Iwaib51abed2018-11-29 08:02:49 +01002613 if (snd_pcm_stream_linked(substream))
2614 snd_pcm_unlink(substream);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002615}
2616
2617void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2618{
Takashi Iwai0df63e42006-04-28 15:13:41 +02002619 substream->ref_count--;
2620 if (substream->ref_count > 0)
2621 return;
2622
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002623 snd_pcm_drop(substream);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002624 if (substream->hw_opened) {
Takashi Iwai0fbb0272020-02-13 07:03:49 +01002625 if (substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2626 do_hw_free(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627 substream->ops->close(substream);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002628 substream->hw_opened = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 }
Rafael J. Wysocki5371a792020-02-12 00:34:15 +01002630 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2631 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
Takashi Iwai15762742006-04-06 19:47:42 +02002632 if (substream->pcm_release) {
2633 substream->pcm_release(substream);
2634 substream->pcm_release = NULL;
2635 }
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002636 snd_pcm_detach_substream(substream);
2637}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02002638EXPORT_SYMBOL(snd_pcm_release_substream);
2639
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002640int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2641 struct file *file,
2642 struct snd_pcm_substream **rsubstream)
2643{
2644 struct snd_pcm_substream *substream;
2645 int err;
2646
2647 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2648 if (err < 0)
2649 return err;
Takashi Iwai0df63e42006-04-28 15:13:41 +02002650 if (substream->ref_count > 1) {
2651 *rsubstream = substream;
2652 return 0;
2653 }
2654
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002655 err = snd_pcm_hw_constraints_init(substream);
2656 if (err < 0) {
Takashi Iwai09e56df2014-02-04 18:19:48 +01002657 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002658 goto error;
2659 }
2660
2661 if ((err = substream->ops->open(substream)) < 0)
2662 goto error;
2663
2664 substream->hw_opened = 1;
2665
2666 err = snd_pcm_hw_constraints_complete(substream);
2667 if (err < 0) {
Takashi Iwai09e56df2014-02-04 18:19:48 +01002668 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002669 goto error;
2670 }
2671
2672 *rsubstream = substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002673 return 0;
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002674
2675 error:
2676 snd_pcm_release_substream(substream);
2677 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02002679EXPORT_SYMBOL(snd_pcm_open_substream);
2680
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681static int snd_pcm_open_file(struct file *file,
Takashi Iwai877211f2005-11-17 13:59:38 +01002682 struct snd_pcm *pcm,
Feng Tangffd3d5c62011-10-10 10:31:48 +08002683 int stream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684{
Takashi Iwai877211f2005-11-17 13:59:38 +01002685 struct snd_pcm_file *pcm_file;
2686 struct snd_pcm_substream *substream;
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002687 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002688
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002689 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2690 if (err < 0)
2691 return err;
2692
Takashi Iwai548a6482006-07-31 16:51:51 +02002693 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2694 if (pcm_file == NULL) {
2695 snd_pcm_release_substream(substream);
2696 return -ENOMEM;
2697 }
2698 pcm_file->substream = substream;
Takashi Iwaide897502019-01-23 12:47:34 +01002699 if (substream->ref_count == 1)
Takashi Iwai0df63e42006-04-28 15:13:41 +02002700 substream->pcm_release = pcm_release_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701 file->private_data = pcm_file;
Feng Tangffd3d5c62011-10-10 10:31:48 +08002702
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703 return 0;
2704}
2705
Clemens Ladischf87135f2005-11-20 14:06:59 +01002706static int snd_pcm_playback_open(struct inode *inode, struct file *file)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707{
Takashi Iwai877211f2005-11-17 13:59:38 +01002708 struct snd_pcm *pcm;
Takashi Iwai02f48652010-04-13 11:49:04 +02002709 int err = nonseekable_open(inode, file);
2710 if (err < 0)
2711 return err;
Clemens Ladischf87135f2005-11-20 14:06:59 +01002712 pcm = snd_lookup_minor_data(iminor(inode),
2713 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
Takashi Iwaia0830db2012-10-16 13:05:59 +02002714 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
Takashi Iwai8bb4d9c2012-11-08 14:36:18 +01002715 if (pcm)
2716 snd_card_unref(pcm->card);
Takashi Iwaia0830db2012-10-16 13:05:59 +02002717 return err;
Clemens Ladischf87135f2005-11-20 14:06:59 +01002718}
2719
2720static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2721{
2722 struct snd_pcm *pcm;
Takashi Iwai02f48652010-04-13 11:49:04 +02002723 int err = nonseekable_open(inode, file);
2724 if (err < 0)
2725 return err;
Clemens Ladischf87135f2005-11-20 14:06:59 +01002726 pcm = snd_lookup_minor_data(iminor(inode),
2727 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
Takashi Iwaia0830db2012-10-16 13:05:59 +02002728 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
Takashi Iwai8bb4d9c2012-11-08 14:36:18 +01002729 if (pcm)
2730 snd_card_unref(pcm->card);
Takashi Iwaia0830db2012-10-16 13:05:59 +02002731 return err;
Clemens Ladischf87135f2005-11-20 14:06:59 +01002732}
2733
2734static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2735{
2736 int err;
Ingo Molnarac6424b2017-06-20 12:06:13 +02002737 wait_queue_entry_t wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739 if (pcm == NULL) {
2740 err = -ENODEV;
2741 goto __error1;
2742 }
2743 err = snd_card_file_add(pcm->card, file);
2744 if (err < 0)
2745 goto __error1;
2746 if (!try_module_get(pcm->card->module)) {
2747 err = -EFAULT;
2748 goto __error2;
2749 }
2750 init_waitqueue_entry(&wait, current);
2751 add_wait_queue(&pcm->open_wait, &wait);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002752 mutex_lock(&pcm->open_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 while (1) {
Feng Tangffd3d5c62011-10-10 10:31:48 +08002754 err = snd_pcm_open_file(file, pcm, stream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 if (err >= 0)
2756 break;
2757 if (err == -EAGAIN) {
2758 if (file->f_flags & O_NONBLOCK) {
2759 err = -EBUSY;
2760 break;
2761 }
2762 } else
2763 break;
2764 set_current_state(TASK_INTERRUPTIBLE);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002765 mutex_unlock(&pcm->open_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 schedule();
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002767 mutex_lock(&pcm->open_mutex);
Takashi Iwai0914f792012-10-16 16:43:39 +02002768 if (pcm->card->shutdown) {
2769 err = -ENODEV;
2770 break;
2771 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 if (signal_pending(current)) {
2773 err = -ERESTARTSYS;
2774 break;
2775 }
2776 }
2777 remove_wait_queue(&pcm->open_wait, &wait);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002778 mutex_unlock(&pcm->open_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 if (err < 0)
2780 goto __error;
2781 return err;
2782
2783 __error:
2784 module_put(pcm->card->module);
2785 __error2:
2786 snd_card_file_remove(pcm->card, file);
2787 __error1:
2788 return err;
2789}
2790
2791static int snd_pcm_release(struct inode *inode, struct file *file)
2792{
Takashi Iwai877211f2005-11-17 13:59:38 +01002793 struct snd_pcm *pcm;
2794 struct snd_pcm_substream *substream;
2795 struct snd_pcm_file *pcm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796
2797 pcm_file = file->private_data;
2798 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02002799 if (snd_BUG_ON(!substream))
2800 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 pcm = substream->pcm;
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002802 mutex_lock(&pcm->open_mutex);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +02002803 snd_pcm_release_substream(substream);
Takashi Iwai548a6482006-07-31 16:51:51 +02002804 kfree(pcm_file);
Ingo Molnar1a60d4c2006-01-16 16:29:08 +01002805 mutex_unlock(&pcm->open_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 wake_up(&pcm->open_wait);
2807 module_put(pcm->card->module);
2808 snd_card_file_remove(pcm->card, file);
2809 return 0;
2810}
2811
Takashi Iwaif839cc12017-05-19 20:04:23 +02002812/* check and update PCM state; return 0 or a negative error
2813 * call this inside PCM lock
2814 */
2815static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2816{
2817 switch (substream->runtime->status->state) {
2818 case SNDRV_PCM_STATE_DRAINING:
2819 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2820 return -EBADFD;
Gustavo A. R. Silvac0dbbda2020-07-08 15:32:36 -05002821 fallthrough;
Takashi Iwaif839cc12017-05-19 20:04:23 +02002822 case SNDRV_PCM_STATE_RUNNING:
2823 return snd_pcm_update_hw_ptr(substream);
2824 case SNDRV_PCM_STATE_PREPARED:
2825 case SNDRV_PCM_STATE_PAUSED:
2826 return 0;
2827 case SNDRV_PCM_STATE_SUSPENDED:
2828 return -ESTRPIPE;
2829 case SNDRV_PCM_STATE_XRUN:
2830 return -EPIPE;
2831 default:
2832 return -EBADFD;
2833 }
2834}
2835
Takashi Iwai9027c462017-05-19 20:22:33 +02002836/* increase the appl_ptr; returns the processed frames or a negative error */
Takashi Iwaie0327a02017-05-19 20:16:44 +02002837static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2838 snd_pcm_uframes_t frames,
2839 snd_pcm_sframes_t avail)
2840{
2841 struct snd_pcm_runtime *runtime = substream->runtime;
2842 snd_pcm_sframes_t appl_ptr;
Takashi Iwai9027c462017-05-19 20:22:33 +02002843 int ret;
Takashi Iwaie0327a02017-05-19 20:16:44 +02002844
2845 if (avail <= 0)
2846 return 0;
2847 if (frames > (snd_pcm_uframes_t)avail)
2848 frames = avail;
2849 appl_ptr = runtime->control->appl_ptr + frames;
2850 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2851 appl_ptr -= runtime->boundary;
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002852 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
Takashi Iwai9027c462017-05-19 20:22:33 +02002853 return ret < 0 ? ret : frames;
Takashi Iwaie0327a02017-05-19 20:16:44 +02002854}
2855
Takashi Iwaifb51f1c2018-01-03 15:16:30 +01002856/* decrease the appl_ptr; returns the processed frames or zero for error */
Takashi Iwaie0327a02017-05-19 20:16:44 +02002857static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2858 snd_pcm_uframes_t frames,
2859 snd_pcm_sframes_t avail)
2860{
2861 struct snd_pcm_runtime *runtime = substream->runtime;
2862 snd_pcm_sframes_t appl_ptr;
Takashi Iwai9027c462017-05-19 20:22:33 +02002863 int ret;
Takashi Iwaie0327a02017-05-19 20:16:44 +02002864
2865 if (avail <= 0)
2866 return 0;
2867 if (frames > (snd_pcm_uframes_t)avail)
2868 frames = avail;
2869 appl_ptr = runtime->control->appl_ptr - frames;
2870 if (appl_ptr < 0)
2871 appl_ptr += runtime->boundary;
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002872 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
Takashi Iwaifb51f1c2018-01-03 15:16:30 +01002873 /* NOTE: we return zero for errors because PulseAudio gets depressed
2874 * upon receiving an error from rewind ioctl and stops processing
2875 * any longer. Returning zero means that no rewind is done, so
2876 * it's not absolutely wrong to answer like that.
2877 */
2878 return ret < 0 ? 0 : frames;
Takashi Iwaie0327a02017-05-19 20:16:44 +02002879}
2880
Takashi Iwai763e5062018-04-11 17:56:52 +02002881static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2882 snd_pcm_uframes_t frames)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002884 snd_pcm_sframes_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002885
2886 if (frames == 0)
2887 return 0;
2888
2889 snd_pcm_stream_lock_irq(substream);
Takashi Iwaif839cc12017-05-19 20:04:23 +02002890 ret = do_pcm_hwsync(substream);
Takashi Iwaie0327a02017-05-19 20:16:44 +02002891 if (!ret)
2892 ret = rewind_appl_ptr(substream, frames,
Takashi Iwai763e5062018-04-11 17:56:52 +02002893 snd_pcm_hw_avail(substream));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894 snd_pcm_stream_unlock_irq(substream);
2895 return ret;
2896}
2897
Takashi Iwai763e5062018-04-11 17:56:52 +02002898static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2899 snd_pcm_uframes_t frames)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002901 snd_pcm_sframes_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
2903 if (frames == 0)
2904 return 0;
2905
2906 snd_pcm_stream_lock_irq(substream);
Takashi Iwaif839cc12017-05-19 20:04:23 +02002907 ret = do_pcm_hwsync(substream);
Takashi Iwaie0327a02017-05-19 20:16:44 +02002908 if (!ret)
2909 ret = forward_appl_ptr(substream, frames,
Takashi Iwai763e5062018-04-11 17:56:52 +02002910 snd_pcm_avail(substream));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 snd_pcm_stream_unlock_irq(substream);
2912 return ret;
2913}
2914
Takashi Iwai877211f2005-11-17 13:59:38 +01002915static int snd_pcm_hwsync(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917 int err;
2918
2919 snd_pcm_stream_lock_irq(substream);
Takashi Iwaif839cc12017-05-19 20:04:23 +02002920 err = do_pcm_hwsync(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921 snd_pcm_stream_unlock_irq(substream);
2922 return err;
2923}
2924
Jeffery Miller912e4c32018-04-20 23:20:46 -05002925static int snd_pcm_delay(struct snd_pcm_substream *substream,
2926 snd_pcm_sframes_t *delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002927{
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928 int err;
2929 snd_pcm_sframes_t n = 0;
2930
2931 snd_pcm_stream_lock_irq(substream);
Takashi Iwaif839cc12017-05-19 20:04:23 +02002932 err = do_pcm_hwsync(substream);
Takashi Iwaic99c5a32018-04-11 18:07:27 +02002933 if (!err)
2934 n = snd_pcm_calc_delay(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 snd_pcm_stream_unlock_irq(substream);
Jeffery Miller912e4c32018-04-20 23:20:46 -05002936 if (!err)
2937 *delay = n;
2938 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939}
2940
Takashi Iwai877211f2005-11-17 13:59:38 +01002941static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
2942 struct snd_pcm_sync_ptr __user *_sync_ptr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943{
Takashi Iwai877211f2005-11-17 13:59:38 +01002944 struct snd_pcm_runtime *runtime = substream->runtime;
2945 struct snd_pcm_sync_ptr sync_ptr;
2946 volatile struct snd_pcm_mmap_status *status;
2947 volatile struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948 int err;
2949
2950 memset(&sync_ptr, 0, sizeof(sync_ptr));
2951 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
2952 return -EFAULT;
Takashi Iwai877211f2005-11-17 13:59:38 +01002953 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954 return -EFAULT;
2955 status = runtime->status;
2956 control = runtime->control;
2957 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
2958 err = snd_pcm_hwsync(substream);
2959 if (err < 0)
2960 return err;
2961 }
2962 snd_pcm_stream_lock_irq(substream);
Takashi Iwai9027c462017-05-19 20:22:33 +02002963 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
Takashi Sakamoto66e01a52017-06-12 09:41:44 +09002964 err = pcm_lib_apply_appl_ptr(substream,
2965 sync_ptr.c.control.appl_ptr);
Takashi Iwai9027c462017-05-19 20:22:33 +02002966 if (err < 0) {
2967 snd_pcm_stream_unlock_irq(substream);
2968 return err;
2969 }
2970 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971 sync_ptr.c.control.appl_ptr = control->appl_ptr;
Takashi Iwai9027c462017-05-19 20:22:33 +02002972 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
2974 control->avail_min = sync_ptr.c.control.avail_min;
2975 else
2976 sync_ptr.c.control.avail_min = control->avail_min;
2977 sync_ptr.s.status.state = status->state;
2978 sync_ptr.s.status.hw_ptr = status->hw_ptr;
2979 sync_ptr.s.status.tstamp = status->tstamp;
2980 sync_ptr.s.status.suspended_state = status->suspended_state;
David Henningssonf853dca2018-04-21 14:57:40 +02002981 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 snd_pcm_stream_unlock_irq(substream);
2983 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
2984 return -EFAULT;
2985 return 0;
2986}
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01002987
Arnd Bergmann09d94172018-04-24 20:06:14 +08002988struct snd_pcm_mmap_status32 {
Takashi Iwaicb639a42020-01-31 16:22:14 +01002989 snd_pcm_state_t state;
Arnd Bergmann09d94172018-04-24 20:06:14 +08002990 s32 pad1;
2991 u32 hw_ptr;
Arnd Bergmann80fe7432018-04-24 20:06:15 +08002992 s32 tstamp_sec;
2993 s32 tstamp_nsec;
Takashi Iwaicb639a42020-01-31 16:22:14 +01002994 snd_pcm_state_t suspended_state;
Arnd Bergmann80fe7432018-04-24 20:06:15 +08002995 s32 audio_tstamp_sec;
2996 s32 audio_tstamp_nsec;
Arnd Bergmann09d94172018-04-24 20:06:14 +08002997} __attribute__((packed));
2998
2999struct snd_pcm_mmap_control32 {
3000 u32 appl_ptr;
3001 u32 avail_min;
3002};
3003
3004struct snd_pcm_sync_ptr32 {
3005 u32 flags;
3006 union {
3007 struct snd_pcm_mmap_status32 status;
3008 unsigned char reserved[64];
3009 } s;
3010 union {
3011 struct snd_pcm_mmap_control32 control;
3012 unsigned char reserved[64];
3013 } c;
3014} __attribute__((packed));
3015
3016/* recalcuate the boundary within 32bit */
3017static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3018{
3019 snd_pcm_uframes_t boundary;
3020
3021 if (! runtime->buffer_size)
3022 return 0;
3023 boundary = runtime->buffer_size;
3024 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3025 boundary *= 2;
3026 return boundary;
3027}
3028
3029static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3030 struct snd_pcm_sync_ptr32 __user *src)
3031{
3032 struct snd_pcm_runtime *runtime = substream->runtime;
3033 volatile struct snd_pcm_mmap_status *status;
3034 volatile struct snd_pcm_mmap_control *control;
3035 u32 sflags;
3036 struct snd_pcm_mmap_control scontrol;
3037 struct snd_pcm_mmap_status sstatus;
3038 snd_pcm_uframes_t boundary;
3039 int err;
3040
3041 if (snd_BUG_ON(!runtime))
3042 return -EINVAL;
3043
3044 if (get_user(sflags, &src->flags) ||
3045 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3046 get_user(scontrol.avail_min, &src->c.control.avail_min))
3047 return -EFAULT;
3048 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3049 err = snd_pcm_hwsync(substream);
3050 if (err < 0)
3051 return err;
3052 }
3053 status = runtime->status;
3054 control = runtime->control;
3055 boundary = recalculate_boundary(runtime);
3056 if (! boundary)
3057 boundary = 0x7fffffff;
3058 snd_pcm_stream_lock_irq(substream);
3059 /* FIXME: we should consider the boundary for the sync from app */
3060 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3061 control->appl_ptr = scontrol.appl_ptr;
3062 else
3063 scontrol.appl_ptr = control->appl_ptr % boundary;
3064 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3065 control->avail_min = scontrol.avail_min;
3066 else
3067 scontrol.avail_min = control->avail_min;
3068 sstatus.state = status->state;
3069 sstatus.hw_ptr = status->hw_ptr % boundary;
3070 sstatus.tstamp = status->tstamp;
3071 sstatus.suspended_state = status->suspended_state;
3072 sstatus.audio_tstamp = status->audio_tstamp;
3073 snd_pcm_stream_unlock_irq(substream);
3074 if (put_user(sstatus.state, &src->s.status.state) ||
3075 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003076 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3077 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
Arnd Bergmann09d94172018-04-24 20:06:14 +08003078 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003079 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3080 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
Arnd Bergmann09d94172018-04-24 20:06:14 +08003081 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3082 put_user(scontrol.avail_min, &src->c.control.avail_min))
3083 return -EFAULT;
3084
3085 return 0;
3086}
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003087#define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
Arnd Bergmann09d94172018-04-24 20:06:14 +08003088
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01003089static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3090{
3091 struct snd_pcm_runtime *runtime = substream->runtime;
3092 int arg;
3093
3094 if (get_user(arg, _arg))
3095 return -EFAULT;
3096 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3097 return -EINVAL;
Takashi Iwai2408c212014-07-10 09:40:38 +02003098 runtime->tstamp_type = arg;
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01003099 return 0;
3100}
Takashi Iwai67616fe2017-08-30 15:39:32 +02003101
3102static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3103 struct snd_xferi __user *_xferi)
3104{
3105 struct snd_xferi xferi;
3106 struct snd_pcm_runtime *runtime = substream->runtime;
3107 snd_pcm_sframes_t result;
3108
3109 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3110 return -EBADFD;
3111 if (put_user(0, &_xferi->result))
3112 return -EFAULT;
3113 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3114 return -EFAULT;
3115 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3116 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3117 else
3118 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
Al Viroebe69762020-03-19 18:08:59 -04003119 if (put_user(result, &_xferi->result))
3120 return -EFAULT;
Takashi Iwai67616fe2017-08-30 15:39:32 +02003121 return result < 0 ? result : 0;
3122}
3123
3124static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3125 struct snd_xfern __user *_xfern)
3126{
3127 struct snd_xfern xfern;
3128 struct snd_pcm_runtime *runtime = substream->runtime;
3129 void *bufs;
3130 snd_pcm_sframes_t result;
3131
3132 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3133 return -EBADFD;
3134 if (runtime->channels > 128)
3135 return -EINVAL;
3136 if (put_user(0, &_xfern->result))
3137 return -EFAULT;
3138 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3139 return -EFAULT;
3140
3141 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3142 if (IS_ERR(bufs))
3143 return PTR_ERR(bufs);
3144 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3145 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3146 else
3147 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3148 kfree(bufs);
Al Viroebe69762020-03-19 18:08:59 -04003149 if (put_user(result, &_xfern->result))
3150 return -EFAULT;
Takashi Iwai67616fe2017-08-30 15:39:32 +02003151 return result < 0 ? result : 0;
3152}
3153
3154static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3155 snd_pcm_uframes_t __user *_frames)
3156{
3157 snd_pcm_uframes_t frames;
3158 snd_pcm_sframes_t result;
3159
3160 if (get_user(frames, _frames))
3161 return -EFAULT;
3162 if (put_user(0, _frames))
3163 return -EFAULT;
Takashi Iwai763e5062018-04-11 17:56:52 +02003164 result = snd_pcm_rewind(substream, frames);
Al Viroebe69762020-03-19 18:08:59 -04003165 if (put_user(result, _frames))
3166 return -EFAULT;
Takashi Iwai67616fe2017-08-30 15:39:32 +02003167 return result < 0 ? result : 0;
3168}
3169
3170static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3171 snd_pcm_uframes_t __user *_frames)
3172{
3173 snd_pcm_uframes_t frames;
3174 snd_pcm_sframes_t result;
3175
3176 if (get_user(frames, _frames))
3177 return -EFAULT;
3178 if (put_user(0, _frames))
3179 return -EFAULT;
Takashi Iwai763e5062018-04-11 17:56:52 +02003180 result = snd_pcm_forward(substream, frames);
Al Viroebe69762020-03-19 18:08:59 -04003181 if (put_user(result, _frames))
3182 return -EFAULT;
Takashi Iwai67616fe2017-08-30 15:39:32 +02003183 return result < 0 ? result : 0;
3184}
3185
3186static int snd_pcm_common_ioctl(struct file *file,
Takashi Iwai0df63e42006-04-28 15:13:41 +02003187 struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188 unsigned int cmd, void __user *arg)
3189{
Takashi Iwai4b671f52017-06-19 23:11:54 +02003190 struct snd_pcm_file *pcm_file = file->private_data;
Takashi Iwai7d8e8292017-08-30 16:13:25 +02003191 int res;
3192
Takashi Iwai67616fe2017-08-30 15:39:32 +02003193 if (PCM_RUNTIME_CHECK(substream))
3194 return -ENXIO;
3195
Takashi Iwai7d8e8292017-08-30 16:13:25 +02003196 res = snd_power_wait(substream->pcm->card, SNDRV_CTL_POWER_D0);
3197 if (res < 0)
3198 return res;
Takashi Iwai4b671f52017-06-19 23:11:54 +02003199
Linus Torvalds1da177e2005-04-16 15:20:36 -07003200 switch (cmd) {
3201 case SNDRV_PCM_IOCTL_PVERSION:
3202 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3203 case SNDRV_PCM_IOCTL_INFO:
3204 return snd_pcm_info_user(substream, arg);
Jaroslav Kysela28e9e472007-12-17 09:02:22 +01003205 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3206 return 0;
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01003207 case SNDRV_PCM_IOCTL_TTSTAMP:
3208 return snd_pcm_tstamp(substream, arg);
Takashi Iwai4b671f52017-06-19 23:11:54 +02003209 case SNDRV_PCM_IOCTL_USER_PVERSION:
3210 if (get_user(pcm_file->user_pversion,
3211 (unsigned int __user *)arg))
3212 return -EFAULT;
3213 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003214 case SNDRV_PCM_IOCTL_HW_REFINE:
3215 return snd_pcm_hw_refine_user(substream, arg);
3216 case SNDRV_PCM_IOCTL_HW_PARAMS:
3217 return snd_pcm_hw_params_user(substream, arg);
3218 case SNDRV_PCM_IOCTL_HW_FREE:
3219 return snd_pcm_hw_free(substream);
3220 case SNDRV_PCM_IOCTL_SW_PARAMS:
3221 return snd_pcm_sw_params_user(substream, arg);
Baolin Wang3ddee7f2018-04-24 20:06:11 +08003222 case SNDRV_PCM_IOCTL_STATUS32:
3223 return snd_pcm_status_user32(substream, arg, false);
3224 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3225 return snd_pcm_status_user32(substream, arg, true);
3226 case SNDRV_PCM_IOCTL_STATUS64:
3227 return snd_pcm_status_user64(substream, arg, false);
3228 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3229 return snd_pcm_status_user64(substream, arg, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3231 return snd_pcm_channel_info_user(substream, arg);
3232 case SNDRV_PCM_IOCTL_PREPARE:
Takashi Iwai0df63e42006-04-28 15:13:41 +02003233 return snd_pcm_prepare(substream, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003234 case SNDRV_PCM_IOCTL_RESET:
3235 return snd_pcm_reset(substream);
3236 case SNDRV_PCM_IOCTL_START:
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003237 return snd_pcm_start_lock_irq(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 case SNDRV_PCM_IOCTL_LINK:
3239 return snd_pcm_link(substream, (int)(unsigned long) arg);
3240 case SNDRV_PCM_IOCTL_UNLINK:
3241 return snd_pcm_unlink(substream);
3242 case SNDRV_PCM_IOCTL_RESUME:
3243 return snd_pcm_resume(substream);
3244 case SNDRV_PCM_IOCTL_XRUN:
3245 return snd_pcm_xrun(substream);
3246 case SNDRV_PCM_IOCTL_HWSYNC:
3247 return snd_pcm_hwsync(substream);
3248 case SNDRV_PCM_IOCTL_DELAY:
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003249 {
Jeffery Miller912e4c32018-04-20 23:20:46 -05003250 snd_pcm_sframes_t delay;
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003251 snd_pcm_sframes_t __user *res = arg;
Jeffery Miller912e4c32018-04-20 23:20:46 -05003252 int err;
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003253
Jeffery Miller912e4c32018-04-20 23:20:46 -05003254 err = snd_pcm_delay(substream, &delay);
3255 if (err)
3256 return err;
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003257 if (put_user(delay, res))
3258 return -EFAULT;
3259 return 0;
3260 }
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003261 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3262 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3263 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264 return snd_pcm_sync_ptr(substream, arg);
Takashi Iwai59d48582005-12-01 10:51:58 +01003265#ifdef CONFIG_SND_SUPPORT_OLD_API
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3267 return snd_pcm_hw_refine_old_user(substream, arg);
3268 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3269 return snd_pcm_hw_params_old_user(substream, arg);
Takashi Iwai59d48582005-12-01 10:51:58 +01003270#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271 case SNDRV_PCM_IOCTL_DRAIN:
Takashi Iwai4cdc1152009-08-20 16:40:16 +02003272 return snd_pcm_drain(substream, file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273 case SNDRV_PCM_IOCTL_DROP:
3274 return snd_pcm_drop(substream);
Takashi Iwaie661d0d2006-02-21 14:14:50 +01003275 case SNDRV_PCM_IOCTL_PAUSE:
Takashi Iwaicb639a42020-01-31 16:22:14 +01003276 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
Takashi Iwai67616fe2017-08-30 15:39:32 +02003277 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3278 case SNDRV_PCM_IOCTL_READI_FRAMES:
3279 return snd_pcm_xferi_frames_ioctl(substream, arg);
3280 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3281 case SNDRV_PCM_IOCTL_READN_FRAMES:
3282 return snd_pcm_xfern_frames_ioctl(substream, arg);
3283 case SNDRV_PCM_IOCTL_REWIND:
3284 return snd_pcm_rewind_ioctl(substream, arg);
3285 case SNDRV_PCM_IOCTL_FORWARD:
3286 return snd_pcm_forward_ioctl(substream, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003287 }
Takashi Iwai09e56df2014-02-04 18:19:48 +01003288 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 return -ENOTTY;
3290}
3291
Takashi Iwai67616fe2017-08-30 15:39:32 +02003292static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3293 unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294{
Takashi Iwai877211f2005-11-17 13:59:38 +01003295 struct snd_pcm_file *pcm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296
3297 pcm_file = file->private_data;
3298
3299 if (((cmd >> 8) & 0xff) != 'A')
3300 return -ENOTTY;
3301
Takashi Iwai67616fe2017-08-30 15:39:32 +02003302 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3303 (void __user *)arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003304}
3305
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003306/**
3307 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3308 * @substream: PCM substream
3309 * @cmd: IOCTL cmd
3310 * @arg: IOCTL argument
3311 *
3312 * The function is provided primarily for OSS layer and USB gadget drivers,
3313 * and it allows only the limited set of ioctls (hw_params, sw_params,
3314 * prepare, start, drain, drop, forward).
3315 */
Takashi Iwai877211f2005-11-17 13:59:38 +01003316int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003317 unsigned int cmd, void *arg)
3318{
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003319 snd_pcm_uframes_t *frames = arg;
3320 snd_pcm_sframes_t result;
Takashi Iwaibf1bbb52006-03-27 16:22:45 +02003321
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003322 switch (cmd) {
3323 case SNDRV_PCM_IOCTL_FORWARD:
3324 {
3325 /* provided only for OSS; capture-only and no value returned */
3326 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3327 return -EINVAL;
Takashi Iwai763e5062018-04-11 17:56:52 +02003328 result = snd_pcm_forward(substream, *frames);
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003329 return result < 0 ? result : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003330 }
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003331 case SNDRV_PCM_IOCTL_HW_PARAMS:
3332 return snd_pcm_hw_params(substream, arg);
3333 case SNDRV_PCM_IOCTL_SW_PARAMS:
3334 return snd_pcm_sw_params(substream, arg);
3335 case SNDRV_PCM_IOCTL_PREPARE:
3336 return snd_pcm_prepare(substream, NULL);
3337 case SNDRV_PCM_IOCTL_START:
3338 return snd_pcm_start_lock_irq(substream);
3339 case SNDRV_PCM_IOCTL_DRAIN:
Takashi Iwai7d8e8292017-08-30 16:13:25 +02003340 return snd_pcm_drain(substream, NULL);
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003341 case SNDRV_PCM_IOCTL_DROP:
3342 return snd_pcm_drop(substream);
3343 case SNDRV_PCM_IOCTL_DELAY:
Jeffery Miller912e4c32018-04-20 23:20:46 -05003344 return snd_pcm_delay(substream, frames);
Takashi Iwaic2c86a92017-05-10 14:33:44 +02003345 default:
3346 return -EINVAL;
3347 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003348}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02003349EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3350
Takashi Iwai877211f2005-11-17 13:59:38 +01003351static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3352 loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353{
Takashi Iwai877211f2005-11-17 13:59:38 +01003354 struct snd_pcm_file *pcm_file;
3355 struct snd_pcm_substream *substream;
3356 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357 snd_pcm_sframes_t result;
3358
3359 pcm_file = file->private_data;
3360 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003361 if (PCM_RUNTIME_CHECK(substream))
3362 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003363 runtime = substream->runtime;
3364 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3365 return -EBADFD;
3366 if (!frame_aligned(runtime, count))
3367 return -EINVAL;
3368 count = bytes_to_frames(runtime, count);
3369 result = snd_pcm_lib_read(substream, buf, count);
3370 if (result > 0)
3371 result = frames_to_bytes(runtime, result);
3372 return result;
3373}
3374
Takashi Iwai877211f2005-11-17 13:59:38 +01003375static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3376 size_t count, loff_t * offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003377{
Takashi Iwai877211f2005-11-17 13:59:38 +01003378 struct snd_pcm_file *pcm_file;
3379 struct snd_pcm_substream *substream;
3380 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003381 snd_pcm_sframes_t result;
3382
3383 pcm_file = file->private_data;
3384 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003385 if (PCM_RUNTIME_CHECK(substream))
3386 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387 runtime = substream->runtime;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003388 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3389 return -EBADFD;
3390 if (!frame_aligned(runtime, count))
3391 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392 count = bytes_to_frames(runtime, count);
3393 result = snd_pcm_lib_write(substream, buf, count);
3394 if (result > 0)
3395 result = frames_to_bytes(runtime, result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003396 return result;
3397}
3398
Al Viro1c65d982015-04-04 00:19:32 -04003399static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003400{
Takashi Iwai877211f2005-11-17 13:59:38 +01003401 struct snd_pcm_file *pcm_file;
3402 struct snd_pcm_substream *substream;
3403 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003404 snd_pcm_sframes_t result;
3405 unsigned long i;
3406 void __user **bufs;
3407 snd_pcm_uframes_t frames;
3408
Badari Pulavartyee0b3e62006-09-30 23:28:47 -07003409 pcm_file = iocb->ki_filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003410 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003411 if (PCM_RUNTIME_CHECK(substream))
3412 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003413 runtime = substream->runtime;
3414 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3415 return -EBADFD;
Al Viro1c65d982015-04-04 00:19:32 -04003416 if (!iter_is_iovec(to))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417 return -EINVAL;
Al Viro1c65d982015-04-04 00:19:32 -04003418 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419 return -EINVAL;
Al Viro1c65d982015-04-04 00:19:32 -04003420 if (!frame_aligned(runtime, to->iov->iov_len))
3421 return -EINVAL;
3422 frames = bytes_to_samples(runtime, to->iov->iov_len);
Kees Cook6da2ec52018-06-12 13:55:00 -07003423 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 if (bufs == NULL)
3425 return -ENOMEM;
Al Viro1c65d982015-04-04 00:19:32 -04003426 for (i = 0; i < to->nr_segs; ++i)
3427 bufs[i] = to->iov[i].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 result = snd_pcm_lib_readv(substream, bufs, frames);
3429 if (result > 0)
3430 result = frames_to_bytes(runtime, result);
3431 kfree(bufs);
3432 return result;
3433}
3434
Al Viro1c65d982015-04-04 00:19:32 -04003435static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436{
Takashi Iwai877211f2005-11-17 13:59:38 +01003437 struct snd_pcm_file *pcm_file;
3438 struct snd_pcm_substream *substream;
3439 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003440 snd_pcm_sframes_t result;
3441 unsigned long i;
3442 void __user **bufs;
3443 snd_pcm_uframes_t frames;
3444
Badari Pulavartyee0b3e62006-09-30 23:28:47 -07003445 pcm_file = iocb->ki_filp->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003446 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003447 if (PCM_RUNTIME_CHECK(substream))
3448 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003449 runtime = substream->runtime;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003450 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3451 return -EBADFD;
Al Viro1c65d982015-04-04 00:19:32 -04003452 if (!iter_is_iovec(from))
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003453 return -EINVAL;
Al Viro1c65d982015-04-04 00:19:32 -04003454 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3455 !frame_aligned(runtime, from->iov->iov_len))
3456 return -EINVAL;
3457 frames = bytes_to_samples(runtime, from->iov->iov_len);
Kees Cook6da2ec52018-06-12 13:55:00 -07003458 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003459 if (bufs == NULL)
3460 return -ENOMEM;
Al Viro1c65d982015-04-04 00:19:32 -04003461 for (i = 0; i < from->nr_segs; ++i)
3462 bufs[i] = from->iov[i].iov_base;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 result = snd_pcm_lib_writev(substream, bufs, frames);
3464 if (result > 0)
3465 result = frames_to_bytes(runtime, result);
3466 kfree(bufs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467 return result;
3468}
3469
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003470static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471{
Takashi Iwai877211f2005-11-17 13:59:38 +01003472 struct snd_pcm_file *pcm_file;
3473 struct snd_pcm_substream *substream;
3474 struct snd_pcm_runtime *runtime;
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003475 __poll_t mask, ok;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476 snd_pcm_uframes_t avail;
3477
3478 pcm_file = file->private_data;
3479
3480 substream = pcm_file->substream;
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003481 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3482 ok = EPOLLOUT | EPOLLWRNORM;
3483 else
3484 ok = EPOLLIN | EPOLLRDNORM;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003485 if (PCM_RUNTIME_CHECK(substream))
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003486 return ok | EPOLLERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003487
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003488 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489 poll_wait(file, &runtime->sleep, wait);
3490
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003491 mask = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492 snd_pcm_stream_lock_irq(substream);
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003493 avail = snd_pcm_avail(substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 switch (runtime->status->state) {
3495 case SNDRV_PCM_STATE_RUNNING:
3496 case SNDRV_PCM_STATE_PREPARED:
3497 case SNDRV_PCM_STATE_PAUSED:
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003498 if (avail >= runtime->control->avail_min)
3499 mask = ok;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500 break;
3501 case SNDRV_PCM_STATE_DRAINING:
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003502 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3503 mask = ok;
3504 if (!avail)
3505 mask |= EPOLLERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506 }
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003507 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003508 default:
Takashi Iwai6448fcb2018-04-11 18:05:00 +02003509 mask = ok | EPOLLERR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003510 break;
3511 }
3512 snd_pcm_stream_unlock_irq(substream);
3513 return mask;
3514}
3515
3516/*
3517 * mmap support
3518 */
3519
3520/*
3521 * Only on coherent architectures, we can mmap the status and the control records
3522 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3523 */
3524#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3525/*
3526 * mmap status record
3527 */
Souptick Joarder41412fe2018-04-25 09:50:29 +05303528static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003529{
Dave Jiang11bac802017-02-24 14:56:41 -08003530 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +01003531 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532
3533 if (substream == NULL)
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003534 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003535 runtime = substream->runtime;
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003536 vmf->page = virt_to_page(runtime->status);
3537 get_page(vmf->page);
3538 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539}
3540
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003541static const struct vm_operations_struct snd_pcm_vm_ops_status =
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542{
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003543 .fault = snd_pcm_mmap_status_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003544};
3545
Takashi Iwai877211f2005-11-17 13:59:38 +01003546static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547 struct vm_area_struct *area)
3548{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 long size;
3550 if (!(area->vm_flags & VM_READ))
3551 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003552 size = area->vm_end - area->vm_start;
Takashi Iwai877211f2005-11-17 13:59:38 +01003553 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003554 return -EINVAL;
3555 area->vm_ops = &snd_pcm_vm_ops_status;
3556 area->vm_private_data = substream;
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07003557 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003558 return 0;
3559}
3560
3561/*
3562 * mmap control record
3563 */
Souptick Joarder41412fe2018-04-25 09:50:29 +05303564static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003565{
Dave Jiang11bac802017-02-24 14:56:41 -08003566 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +01003567 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003568
3569 if (substream == NULL)
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003570 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003571 runtime = substream->runtime;
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003572 vmf->page = virt_to_page(runtime->control);
3573 get_page(vmf->page);
3574 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003575}
3576
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003577static const struct vm_operations_struct snd_pcm_vm_ops_control =
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578{
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003579 .fault = snd_pcm_mmap_control_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580};
3581
Takashi Iwai877211f2005-11-17 13:59:38 +01003582static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583 struct vm_area_struct *area)
3584{
Linus Torvalds1da177e2005-04-16 15:20:36 -07003585 long size;
3586 if (!(area->vm_flags & VM_READ))
3587 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588 size = area->vm_end - area->vm_start;
Takashi Iwai877211f2005-11-17 13:59:38 +01003589 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 return -EINVAL;
3591 area->vm_ops = &snd_pcm_vm_ops_control;
3592 area->vm_private_data = substream;
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07003593 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003594 return 0;
3595}
Takashi Iwai42f94592017-06-19 22:39:18 +02003596
3597static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3598{
Takashi Iwaib602aa82017-06-27 11:54:37 +02003599 /* See pcm_control_mmap_allowed() below.
3600 * Since older alsa-lib requires both status and control mmaps to be
3601 * coupled, we have to disable the status mmap for old alsa-lib, too.
3602 */
3603 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3604 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3605 return false;
3606 return true;
3607}
3608
3609static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3610{
3611 if (pcm_file->no_compat_mmap)
3612 return false;
3613 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
Takashi Iwai42f94592017-06-19 22:39:18 +02003614 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3615 * thus it effectively assures the manual update of appl_ptr.
Takashi Iwai42f94592017-06-19 22:39:18 +02003616 */
3617 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3618 return false;
3619 return true;
3620}
3621
Linus Torvalds1da177e2005-04-16 15:20:36 -07003622#else /* ! coherent mmap */
3623/*
3624 * don't support mmap for status and control records.
3625 */
Takashi Iwai42f94592017-06-19 22:39:18 +02003626#define pcm_status_mmap_allowed(pcm_file) false
Takashi Iwaib602aa82017-06-27 11:54:37 +02003627#define pcm_control_mmap_allowed(pcm_file) false
Takashi Iwai42f94592017-06-19 22:39:18 +02003628
Takashi Iwai877211f2005-11-17 13:59:38 +01003629static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003630 struct vm_area_struct *area)
3631{
3632 return -ENXIO;
3633}
Takashi Iwai877211f2005-11-17 13:59:38 +01003634static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003635 struct vm_area_struct *area)
3636{
3637 return -ENXIO;
3638}
3639#endif /* coherent mmap */
3640
Takashi Iwai9eb4a062009-11-26 12:43:39 +01003641static inline struct page *
3642snd_pcm_default_page_ops(struct snd_pcm_substream *substream, unsigned long ofs)
3643{
3644 void *vaddr = substream->runtime->dma_area + ofs;
Takashi Iwai7e8edae2019-11-05 09:01:37 +01003645
3646 switch (substream->dma_buffer.dev.type) {
3647#ifdef CONFIG_SND_DMA_SGBUF
3648 case SNDRV_DMA_TYPE_DEV_SG:
3649 case SNDRV_DMA_TYPE_DEV_UC_SG:
3650 return snd_pcm_sgbuf_ops_page(substream, ofs);
3651#endif /* CONFIG_SND_DMA_SGBUF */
3652 case SNDRV_DMA_TYPE_VMALLOC:
3653 return vmalloc_to_page(vaddr);
3654 default:
3655 return virt_to_page(vaddr);
3656 }
Takashi Iwai9eb4a062009-11-26 12:43:39 +01003657}
3658
Linus Torvalds1da177e2005-04-16 15:20:36 -07003659/*
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003660 * fault callback for mmapping a RAM page
Linus Torvalds1da177e2005-04-16 15:20:36 -07003661 */
Souptick Joarder41412fe2018-04-25 09:50:29 +05303662static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003663{
Dave Jiang11bac802017-02-24 14:56:41 -08003664 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +01003665 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003666 unsigned long offset;
3667 struct page * page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003668 size_t dma_bytes;
3669
3670 if (substream == NULL)
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003671 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003672 runtime = substream->runtime;
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003673 offset = vmf->pgoff << PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003674 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3675 if (offset > dma_bytes - PAGE_SIZE)
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003676 return VM_FAULT_SIGBUS;
Takashi Iwai9eb4a062009-11-26 12:43:39 +01003677 if (substream->ops->page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003678 page = substream->ops->page(substream, offset);
Takashi Iwai9eb4a062009-11-26 12:43:39 +01003679 else
3680 page = snd_pcm_default_page_ops(substream, offset);
3681 if (!page)
3682 return VM_FAULT_SIGBUS;
Nick Pigginb5810032005-10-29 18:16:12 -07003683 get_page(page);
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003684 vmf->page = page;
3685 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003686}
3687
Takashi Iwai657b1982009-11-26 12:40:21 +01003688static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3689 .open = snd_pcm_mmap_data_open,
3690 .close = snd_pcm_mmap_data_close,
3691};
3692
3693static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003694 .open = snd_pcm_mmap_data_open,
3695 .close = snd_pcm_mmap_data_close,
Nick Piggin3ad5afc2007-12-13 16:15:00 +01003696 .fault = snd_pcm_mmap_data_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003697};
3698
3699/*
3700 * mmap the DMA buffer on RAM
3701 */
Takashi Iwai30b771c2014-10-30 15:02:50 +01003702
3703/**
3704 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3705 * @substream: PCM substream
3706 * @area: VMA
3707 *
3708 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3709 * this function is invoked implicitly.
3710 */
Takashi Iwai18a2b962011-09-28 17:12:59 +02003711int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3712 struct vm_area_struct *area)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003713{
Konstantin Khlebnikov314e51b2012-10-08 16:29:02 -07003714 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
Takashi Iwaia5606f82013-10-24 14:25:32 +02003715#ifdef CONFIG_GENERIC_ALLOCATOR
Nicolin Chen05503212013-10-23 11:47:43 +08003716 if (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_IRAM) {
3717 area->vm_page_prot = pgprot_writecombine(area->vm_page_prot);
3718 return remap_pfn_range(area, area->vm_start,
3719 substream->dma_buffer.addr >> PAGE_SHIFT,
3720 area->vm_end - area->vm_start, area->vm_page_prot);
3721 }
Takashi Iwaia5606f82013-10-24 14:25:32 +02003722#endif /* CONFIG_GENERIC_ALLOCATOR */
Geert Uytterhoevenabe594c2017-07-09 21:31:02 +02003723 if (IS_ENABLED(CONFIG_HAS_DMA) && !substream->ops->page &&
Takashi Iwai2406ff92019-11-08 17:56:26 +01003724 (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV ||
3725 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_UC))
Takashi Iwai657b1982009-11-26 12:40:21 +01003726 return dma_mmap_coherent(substream->dma_buffer.dev.dev,
3727 area,
3728 substream->runtime->dma_area,
3729 substream->runtime->dma_addr,
Stefan Roese9066ae72018-03-26 16:10:21 +02003730 substream->runtime->dma_bytes);
Takashi Iwai657b1982009-11-26 12:40:21 +01003731 /* mmap with fault handler */
3732 area->vm_ops = &snd_pcm_vm_ops_data_fault;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003733 return 0;
3734}
Takashi Iwai18a2b962011-09-28 17:12:59 +02003735EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003736
3737/*
3738 * mmap the DMA buffer on I/O memory area
3739 */
3740#if SNDRV_PCM_INFO_MMAP_IOMEM
Takashi Iwai30b771c2014-10-30 15:02:50 +01003741/**
3742 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3743 * @substream: PCM substream
3744 * @area: VMA
3745 *
3746 * When your hardware uses the iomapped pages as the hardware buffer and
3747 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3748 * is supposed to work only on limited architectures.
3749 */
Takashi Iwai877211f2005-11-17 13:59:38 +01003750int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3751 struct vm_area_struct *area)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003752{
Luis de Bethencourt3c7f6912018-01-16 13:26:26 +00003753 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003754
Linus Torvalds1da177e2005-04-16 15:20:36 -07003755 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
Linus Torvalds0fe09a42013-04-19 10:01:04 -07003756 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003757}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02003758EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003759#endif /* SNDRV_PCM_INFO_MMAP */
3760
3761/*
3762 * mmap DMA buffer
3763 */
Takashi Iwai877211f2005-11-17 13:59:38 +01003764int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003765 struct vm_area_struct *area)
3766{
Takashi Iwai877211f2005-11-17 13:59:38 +01003767 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003768 long size;
3769 unsigned long offset;
3770 size_t dma_bytes;
Takashi Iwai657b1982009-11-26 12:40:21 +01003771 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003772
3773 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3774 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3775 return -EINVAL;
3776 } else {
3777 if (!(area->vm_flags & VM_READ))
3778 return -EINVAL;
3779 }
3780 runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003781 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3782 return -EBADFD;
3783 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3784 return -ENXIO;
3785 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3786 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3787 return -EINVAL;
3788 size = area->vm_end - area->vm_start;
3789 offset = area->vm_pgoff << PAGE_SHIFT;
3790 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3791 if ((size_t)size > dma_bytes)
3792 return -EINVAL;
3793 if (offset > dma_bytes - size)
3794 return -EINVAL;
3795
Takashi Iwai657b1982009-11-26 12:40:21 +01003796 area->vm_ops = &snd_pcm_vm_ops_data;
3797 area->vm_private_data = substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003798 if (substream->ops->mmap)
Takashi Iwai657b1982009-11-26 12:40:21 +01003799 err = substream->ops->mmap(substream, area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003800 else
Takashi Iwai18a2b962011-09-28 17:12:59 +02003801 err = snd_pcm_lib_default_mmap(substream, area);
Takashi Iwai657b1982009-11-26 12:40:21 +01003802 if (!err)
3803 atomic_inc(&substream->mmap_count);
3804 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003805}
Takashi Iwaie88e8ae62006-04-28 15:13:40 +02003806EXPORT_SYMBOL(snd_pcm_mmap_data);
3807
Linus Torvalds1da177e2005-04-16 15:20:36 -07003808static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3809{
Takashi Iwai877211f2005-11-17 13:59:38 +01003810 struct snd_pcm_file * pcm_file;
3811 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003812 unsigned long offset;
3813
3814 pcm_file = file->private_data;
3815 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003816 if (PCM_RUNTIME_CHECK(substream))
3817 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003818
3819 offset = area->vm_pgoff << PAGE_SHIFT;
3820 switch (offset) {
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003821 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3822 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3823 return -ENXIO;
Gustavo A. R. Silvac0dbbda2020-07-08 15:32:36 -05003824 fallthrough;
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003825 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
Takashi Iwai42f94592017-06-19 22:39:18 +02003826 if (!pcm_status_mmap_allowed(pcm_file))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003827 return -ENXIO;
3828 return snd_pcm_mmap_status(substream, file, area);
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003829 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3830 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3831 return -ENXIO;
Gustavo A. R. Silvac0dbbda2020-07-08 15:32:36 -05003832 fallthrough;
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003833 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
Takashi Iwaib602aa82017-06-27 11:54:37 +02003834 if (!pcm_control_mmap_allowed(pcm_file))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003835 return -ENXIO;
3836 return snd_pcm_mmap_control(substream, file, area);
3837 default:
3838 return snd_pcm_mmap_data(substream, file, area);
3839 }
3840 return 0;
3841}
3842
3843static int snd_pcm_fasync(int fd, struct file * file, int on)
3844{
Takashi Iwai877211f2005-11-17 13:59:38 +01003845 struct snd_pcm_file * pcm_file;
3846 struct snd_pcm_substream *substream;
3847 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003848
3849 pcm_file = file->private_data;
3850 substream = pcm_file->substream;
Takashi Iwai7eaa9432008-08-08 17:09:09 +02003851 if (PCM_RUNTIME_CHECK(substream))
Takashi Iwaid05468b2010-04-07 18:29:46 +02003852 return -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003853 runtime = substream->runtime;
Takashi Iwaid05468b2010-04-07 18:29:46 +02003854 return fasync_helper(fd, file, on, &runtime->fasync);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003855}
3856
3857/*
3858 * ioctl32 compat
3859 */
3860#ifdef CONFIG_COMPAT
3861#include "pcm_compat.c"
3862#else
3863#define snd_pcm_ioctl_compat NULL
3864#endif
3865
3866/*
3867 * To be removed helpers to keep binary compatibility
3868 */
3869
Takashi Iwai59d48582005-12-01 10:51:58 +01003870#ifdef CONFIG_SND_SUPPORT_OLD_API
Linus Torvalds1da177e2005-04-16 15:20:36 -07003871#define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3872#define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3873
Takashi Iwai877211f2005-11-17 13:59:38 +01003874static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3875 struct snd_pcm_hw_params_old *oparams)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003876{
3877 unsigned int i;
3878
3879 memset(params, 0, sizeof(*params));
3880 params->flags = oparams->flags;
3881 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3882 params->masks[i].bits[0] = oparams->masks[i];
3883 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3884 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3885 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3886 params->info = oparams->info;
3887 params->msbits = oparams->msbits;
3888 params->rate_num = oparams->rate_num;
3889 params->rate_den = oparams->rate_den;
3890 params->fifo_size = oparams->fifo_size;
3891}
3892
Takashi Iwai877211f2005-11-17 13:59:38 +01003893static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3894 struct snd_pcm_hw_params *params)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003895{
3896 unsigned int i;
3897
3898 memset(oparams, 0, sizeof(*oparams));
3899 oparams->flags = params->flags;
3900 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3901 oparams->masks[i] = params->masks[i].bits[0];
3902 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3903 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3904 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3905 oparams->info = params->info;
3906 oparams->msbits = params->msbits;
3907 oparams->rate_num = params->rate_num;
3908 oparams->rate_den = params->rate_den;
3909 oparams->fifo_size = params->fifo_size;
3910}
3911
Takashi Iwai877211f2005-11-17 13:59:38 +01003912static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3913 struct snd_pcm_hw_params_old __user * _oparams)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003914{
Takashi Iwai877211f2005-11-17 13:59:38 +01003915 struct snd_pcm_hw_params *params;
3916 struct snd_pcm_hw_params_old *oparams = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003917 int err;
3918
3919 params = kmalloc(sizeof(*params), GFP_KERNEL);
Li Zefanef44a1e2009-04-10 09:43:08 +08003920 if (!params)
3921 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003922
Li Zefanef44a1e2009-04-10 09:43:08 +08003923 oparams = memdup_user(_oparams, sizeof(*oparams));
3924 if (IS_ERR(oparams)) {
3925 err = PTR_ERR(oparams);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003926 goto out;
3927 }
3928 snd_pcm_hw_convert_from_old_params(params, oparams);
3929 err = snd_pcm_hw_refine(substream, params);
Takashi Sakamotof74ae152017-06-11 23:56:12 +09003930 if (err < 0)
3931 goto out_old;
Li Zefanef44a1e2009-04-10 09:43:08 +08003932
Takashi Sakamotof74ae152017-06-11 23:56:12 +09003933 err = fixup_unreferenced_params(substream, params);
3934 if (err < 0)
3935 goto out_old;
3936
3937 snd_pcm_hw_convert_to_old_params(oparams, params);
3938 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3939 err = -EFAULT;
3940out_old:
Li Zefanef44a1e2009-04-10 09:43:08 +08003941 kfree(oparams);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003942out:
3943 kfree(params);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003944 return err;
3945}
3946
Takashi Iwai877211f2005-11-17 13:59:38 +01003947static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
3948 struct snd_pcm_hw_params_old __user * _oparams)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003949{
Takashi Iwai877211f2005-11-17 13:59:38 +01003950 struct snd_pcm_hw_params *params;
3951 struct snd_pcm_hw_params_old *oparams = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003952 int err;
3953
3954 params = kmalloc(sizeof(*params), GFP_KERNEL);
Li Zefanef44a1e2009-04-10 09:43:08 +08003955 if (!params)
3956 return -ENOMEM;
3957
3958 oparams = memdup_user(_oparams, sizeof(*oparams));
3959 if (IS_ERR(oparams)) {
3960 err = PTR_ERR(oparams);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003961 goto out;
3962 }
Takashi Sakamotof74ae152017-06-11 23:56:12 +09003963
Linus Torvalds1da177e2005-04-16 15:20:36 -07003964 snd_pcm_hw_convert_from_old_params(params, oparams);
3965 err = snd_pcm_hw_params(substream, params);
Takashi Sakamotof74ae152017-06-11 23:56:12 +09003966 if (err < 0)
3967 goto out_old;
Li Zefanef44a1e2009-04-10 09:43:08 +08003968
Takashi Sakamotof74ae152017-06-11 23:56:12 +09003969 snd_pcm_hw_convert_to_old_params(oparams, params);
3970 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3971 err = -EFAULT;
3972out_old:
Li Zefanef44a1e2009-04-10 09:43:08 +08003973 kfree(oparams);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003974out:
3975 kfree(params);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003976 return err;
3977}
Takashi Iwai59d48582005-12-01 10:51:58 +01003978#endif /* CONFIG_SND_SUPPORT_OLD_API */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003979
Cliff Cai70036092008-09-03 10:54:36 +02003980#ifndef CONFIG_MMU
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05003981static unsigned long snd_pcm_get_unmapped_area(struct file *file,
3982 unsigned long addr,
3983 unsigned long len,
3984 unsigned long pgoff,
3985 unsigned long flags)
Cliff Cai70036092008-09-03 10:54:36 +02003986{
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05003987 struct snd_pcm_file *pcm_file = file->private_data;
3988 struct snd_pcm_substream *substream = pcm_file->substream;
3989 struct snd_pcm_runtime *runtime = substream->runtime;
3990 unsigned long offset = pgoff << PAGE_SHIFT;
3991
3992 switch (offset) {
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003993 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05003994 return (unsigned long)runtime->status;
Arnd Bergmann80fe7432018-04-24 20:06:15 +08003995 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05003996 return (unsigned long)runtime->control;
3997 default:
3998 return (unsigned long)runtime->dma_area + offset;
3999 }
Cliff Cai70036092008-09-03 10:54:36 +02004000}
4001#else
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05004002# define snd_pcm_get_unmapped_area NULL
Cliff Cai70036092008-09-03 10:54:36 +02004003#endif
4004
Linus Torvalds1da177e2005-04-16 15:20:36 -07004005/*
4006 * Register section
4007 */
4008
Arjan van de Ven9c2e08c2007-02-12 00:55:37 -08004009const struct file_operations snd_pcm_f_ops[2] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004010 {
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004011 .owner = THIS_MODULE,
4012 .write = snd_pcm_write,
Al Viro1c65d982015-04-04 00:19:32 -04004013 .write_iter = snd_pcm_writev,
Clemens Ladischf87135f2005-11-20 14:06:59 +01004014 .open = snd_pcm_playback_open,
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004015 .release = snd_pcm_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02004016 .llseek = no_llseek,
Takashi Iwai6448fcb2018-04-11 18:05:00 +02004017 .poll = snd_pcm_poll,
Takashi Iwai67616fe2017-08-30 15:39:32 +02004018 .unlocked_ioctl = snd_pcm_ioctl,
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004019 .compat_ioctl = snd_pcm_ioctl_compat,
4020 .mmap = snd_pcm_mmap,
4021 .fasync = snd_pcm_fasync,
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05004022 .get_unmapped_area = snd_pcm_get_unmapped_area,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004023 },
4024 {
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004025 .owner = THIS_MODULE,
4026 .read = snd_pcm_read,
Al Viro1c65d982015-04-04 00:19:32 -04004027 .read_iter = snd_pcm_readv,
Clemens Ladischf87135f2005-11-20 14:06:59 +01004028 .open = snd_pcm_capture_open,
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004029 .release = snd_pcm_release,
Takashi Iwai02f48652010-04-13 11:49:04 +02004030 .llseek = no_llseek,
Takashi Iwai6448fcb2018-04-11 18:05:00 +02004031 .poll = snd_pcm_poll,
Takashi Iwai67616fe2017-08-30 15:39:32 +02004032 .unlocked_ioctl = snd_pcm_ioctl,
Clemens Ladisch2af677f2005-11-20 14:03:48 +01004033 .compat_ioctl = snd_pcm_ioctl_compat,
4034 .mmap = snd_pcm_mmap,
4035 .fasync = snd_pcm_fasync,
Daniel Glöckner55c63bd2010-03-09 12:57:52 -05004036 .get_unmapped_area = snd_pcm_get_unmapped_area,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004037 }
4038};