]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - sound/core/pcm_native.c
ALSA: core: Abstract memory alloc helpers
[mirror_ubuntu-jammy-kernel.git] / sound / core / pcm_native.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4
LT
2/*
3 * Digital Audio (PCM) abstract layer
c1017a4c 4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT
5 */
6
09d94175 7#include <linux/compat.h>
1da177e4 8#include <linux/mm.h>
da155d5b 9#include <linux/module.h>
1da177e4
LT
10#include <linux/file.h>
11#include <linux/slab.h>
174cd4b1 12#include <linux/sched/signal.h>
1da177e4 13#include <linux/time.h>
e8db0be1 14#include <linux/pm_qos.h>
6cbbfe1c 15#include <linux/io.h>
657b1989 16#include <linux/dma-mapping.h>
7e8edae3 17#include <linux/vmalloc.h>
1da177e4
LT
18#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>
e2e40f2c 25#include <linux/uio.h>
b888a5f7 26#include <linux/delay.h>
1da177e4 27
2c4842d3
TS
28#include "pcm_local.h"
29
37567c55 30#ifdef CONFIG_SND_DEBUG
be4e31da
TS
31#define CREATE_TRACE_POINTS
32#include "pcm_param_trace.h"
37567c55
TS
33#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
be4e31da 39
1da177e4
LT
40/*
41 * Compatibility
42 */
43
877211f5 44struct snd_pcm_hw_params_old {
1da177e4
LT
45 unsigned int flags;
46 unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
47 SNDRV_PCM_HW_PARAM_ACCESS + 1];
877211f5 48 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
1da177e4
LT
49 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;
877211f5 56 snd_pcm_uframes_t fifo_size;
1da177e4
LT
57 unsigned char reserved[64];
58};
59
59d48582 60#ifdef CONFIG_SND_SUPPORT_OLD_API
877211f5
TI
61#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)
1da177e4 63
877211f5
TI
64static 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);
59d48582 68#endif
f87135f5 69static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
1da177e4
LT
70
71/*
72 *
73 */
74
7af142f7 75static DECLARE_RWSEM(snd_pcm_link_rwsem);
1da177e4 76
73365cb1 77void snd_pcm_group_init(struct snd_pcm_group *group)
67ec1072 78{
73365cb1
TI
79 spin_lock_init(&group->lock);
80 mutex_init(&group->mutex);
81 INIT_LIST_HEAD(&group->substreams);
0e279dce 82 refcount_set(&group->refs, 1);
67ec1072
TI
83}
84
f57f3df0
TI
85/* 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); \
10aa7cad
AMG
93}
94
f57f3df0
TI
95DEFINE_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);
10aa7cad 99
30b771cf
TI
100/**
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 */
7af142f7
TI
108void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
109{
ef2056b8 110 snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
7af142f7
TI
111}
112EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
113
30b771cf 114/**
f7b6603c 115 * snd_pcm_stream_unlock - Unlock the PCM stream
30b771cf
TI
116 * @substream: PCM substream
117 *
118 * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
119 */
7af142f7
TI
120void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
121{
ef2056b8 122 snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
7af142f7
TI
123}
124EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
125
30b771cf
TI
126/**
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 */
7af142f7
TI
134void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
135{
ef2056b8
TI
136 snd_pcm_group_lock_irq(&substream->self_group,
137 substream->pcm->nonatomic);
7af142f7
TI
138}
139EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
140
e18035cf
MM
141static 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
30b771cf
TI
151/**
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 */
7af142f7
TI
157void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
158{
ef2056b8
TI
159 snd_pcm_group_unlock_irq(&substream->self_group,
160 substream->pcm->nonatomic);
7af142f7
TI
161}
162EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
163
164unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
165{
ef2056b8
TI
166 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;
7af142f7
TI
172}
173EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
174
30b771cf
TI
175/**
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 */
7af142f7
TI
182void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
183 unsigned long flags)
184{
ef2056b8
TI
185 if (substream->pcm->nonatomic)
186 mutex_unlock(&substream->self_group.mutex);
187 else
188 spin_unlock_irqrestore(&substream->self_group.lock, flags);
7af142f7
TI
189}
190EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
1da177e4 191
fc033cbf
TI
192/* 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
877211f5 202int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
1da177e4 203{
877211f5
TI
204 struct snd_pcm *pcm = substream->pcm;
205 struct snd_pcm_str *pstr = substream->pstr;
1da177e4 206
1da177e4
LT
207 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;
75b1a8f9
JP
212 strscpy(info->id, pcm->id, sizeof(info->id));
213 strscpy(info->name, pcm->name, sizeof(info->name));
1da177e4
LT
214 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;
75b1a8f9 218 strscpy(info->subname, substream->name, sizeof(info->subname));
e11f0f90 219
1da177e4
LT
220 return 0;
221}
222
877211f5
TI
223int snd_pcm_info_user(struct snd_pcm_substream *substream,
224 struct snd_pcm_info __user * _info)
1da177e4 225{
877211f5 226 struct snd_pcm_info *info;
1da177e4
LT
227 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
f9b0c053
TI
241/* macro for simplified cast */
242#define PARAM_MASK_BIT(b) (1U << (__force int)(b))
243
63825f3a
TI
244static bool hw_support_mmap(struct snd_pcm_substream *substream)
245{
246 if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
247 return false;
425da159
CH
248
249 if (substream->ops->mmap ||
6111fd23
TI
250 (substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV &&
251 substream->dma_buffer.dev.type != SNDRV_DMA_TYPE_DEV_UC))
425da159
CH
252 return true;
253
254 return dma_can_mmap(substream->dma_buffer.dev.dev);
63825f3a
TI
255}
256
561e1cad
TS
257static int constrain_mask_params(struct snd_pcm_substream *substream,
258 struct snd_pcm_hw_params *params)
1da177e4 259{
561e1cad
TS
260 struct snd_pcm_hw_constraints *constrs =
261 &substream->runtime->hw_constraints;
262 struct snd_mask *m;
1da177e4 263 unsigned int k;
561e1cad
TS
264 struct snd_mask old_mask;
265 int changed;
1da177e4
LT
266
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;
d81052f9
TS
271
272 /* This parameter is not requested to change by a caller. */
f9b0c053 273 if (!(params->rmask & PARAM_MASK_BIT(k)))
1da177e4 274 continue;
561e1cad
TS
275
276 if (trace_hw_mask_param_enabled())
277 old_mask = *m;
278
1da177e4 279 changed = snd_mask_refine(m, constrs_mask(constrs, k));
1da177e4
LT
280 if (changed < 0)
281 return changed;
82e7d501
TS
282 if (changed == 0)
283 continue;
561e1cad 284
d81052f9 285 /* Set corresponding flag so that the caller gets it. */
82e7d501 286 trace_hw_mask_param(substream, k, 0, &old_mask, m);
f9b0c053 287 params->cmask |= PARAM_MASK_BIT(k);
1da177e4
LT
288 }
289
561e1cad
TS
290 return 0;
291}
292
3432fa04
TS
293static 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
1da177e4
LT
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;
d81052f9
TS
307
308 /* This parameter is not requested to change by a caller. */
f9b0c053 309 if (!(params->rmask & PARAM_MASK_BIT(k)))
1da177e4 310 continue;
3432fa04
TS
311
312 if (trace_hw_interval_param_enabled())
313 old_interval = *i;
314
1da177e4 315 changed = snd_interval_refine(i, constrs_interval(constrs, k));
1da177e4
LT
316 if (changed < 0)
317 return changed;
82e7d501
TS
318 if (changed == 0)
319 continue;
3432fa04 320
d81052f9 321 /* Set corresponding flag so that the caller gets it. */
82e7d501 322 trace_hw_interval_param(substream, k, 0, &old_interval, i);
f9b0c053 323 params->cmask |= PARAM_MASK_BIT(k);
1da177e4
LT
324 }
325
3432fa04
TS
326 return 0;
327}
328
9cc07f55
TS
329static int constrain_params_by_rules(struct snd_pcm_substream *substream,
330 struct snd_pcm_hw_params *params)
1da177e4 331{
9cc07f55
TS
332 struct snd_pcm_hw_constraints *constrs =
333 &substream->runtime->hw_constraints;
1da177e4 334 unsigned int k;
5730f9f7 335 unsigned int *rstamps;
1da177e4 336 unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
d81052f9 337 unsigned int stamp;
a1c06e39
TS
338 struct snd_pcm_hw_rule *r;
339 unsigned int d;
9cc07f55
TS
340 struct snd_mask old_mask;
341 struct snd_interval old_interval;
a1c06e39 342 bool again;
5730f9f7 343 int changed, err = 0;
1da177e4 344
d81052f9
TS
345 /*
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 */
5730f9f7
TI
351 rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
352 if (!rstamps)
353 return -ENOMEM;
d81052f9
TS
354
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 */
9cc07f55 364 for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
f9b0c053 365 vstamps[k] = (params->rmask & PARAM_MASK_BIT(k)) ? 1 : 0;
d81052f9
TS
366
367 /* Due to the above design, actual sequence number starts at 2. */
368 stamp = 2;
0d4e3999 369retry:
d81052f9 370 /* Apply all rules in order. */
a1c06e39 371 again = false;
0d4e3999 372 for (k = 0; k < constrs->rules_num; k++) {
a1c06e39 373 r = &constrs->rules[k];
d81052f9
TS
374
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 */
0d4e3999
TS
381 if (r->cond && !(r->cond & params->flags))
382 continue;
d81052f9
TS
383
384 /*
23b53d44
TI
385 * The 'deps' array includes maximum four dependencies
386 * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fifth
d81052f9
TS
387 * 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 */
0d4e3999 394 for (d = 0; r->deps[d] >= 0; d++) {
d656b4a6 395 if (vstamps[r->deps[d]] > rstamps[k])
0d4e3999 396 break;
0d4e3999 397 }
d656b4a6 398 if (r->deps[d] < 0)
0d4e3999 399 continue;
be4e31da 400
0d4e3999
TS
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 }
c6706de0 409
0d4e3999 410 changed = r->func(params, r);
5730f9f7
TI
411 if (changed < 0) {
412 err = changed;
413 goto out;
414 }
c6706de0 415
d81052f9 416 /*
82e7d501 417 * When the parameter is changed, notify it to the caller
d81052f9
TS
418 * by corresponding returned bit, then preparing for next
419 * iteration.
420 */
0d4e3999 421 if (changed && r->var >= 0) {
82e7d501
TS
422 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));
1da177e4 426 }
82e7d501
TS
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));
1da177e4 431 }
82e7d501 432
f9b0c053 433 params->cmask |= PARAM_MASK_BIT(r->var);
0d4e3999 434 vstamps[r->var] = stamp;
a1c06e39 435 again = true;
1da177e4 436 }
f74ae15f 437
82e7d501 438 rstamps[k] = stamp++;
0d4e3999
TS
439 }
440
d81052f9 441 /* Iterate to evaluate all rules till no parameters are changed. */
0d4e3999
TS
442 if (again)
443 goto retry;
9cc07f55 444
5730f9f7
TI
445 out:
446 kfree(rstamps);
447 return err;
9cc07f55
TS
448}
449
f9a076bf
TS
450static 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
1da177e4 457 if (!params->msbits) {
f9a076bf 458 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
1da177e4
LT
459 if (snd_interval_single(i))
460 params->msbits = snd_interval_value(i);
461 }
462
463 if (!params->rate_den) {
f9a076bf 464 i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
1da177e4
LT
465 if (snd_interval_single(i)) {
466 params->rate_num = snd_interval_value(i);
467 params->rate_den = 1;
468 }
469 }
470
f9a076bf
TS
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)) {
fc033cbf
TI
475 err = snd_pcm_ops_ioctl(substream,
476 SNDRV_PCM_IOCTL1_FIFO_SIZE,
477 params);
f9a076bf
TS
478 if (err < 0)
479 return err;
480 }
481 }
482
63825f3a 483 if (!params->info) {
7802fb52
TS
484 params->info = substream->runtime->hw.info;
485 params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
486 SNDRV_PCM_INFO_DRAIN_TRIGGER);
63825f3a
TI
487 if (!hw_support_mmap(substream))
488 params->info &= ~(SNDRV_PCM_INFO_MMAP |
489 SNDRV_PCM_INFO_MMAP_VALID);
490 }
7802fb52 491
f9a076bf
TS
492 return 0;
493}
494
9cc07f55
TS
495int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
496 struct snd_pcm_hw_params *params)
497{
9cc07f55
TS
498 int err;
499
500 params->info = 0;
501 params->fifo_size = 0;
f9b0c053 502 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
9cc07f55 503 params->msbits = 0;
f9b0c053 504 if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
9cc07f55
TS
505 params->rate_num = 0;
506 params->rate_den = 0;
8bea869c 507 }
9cc07f55
TS
508
509 err = constrain_mask_params(substream, params);
510 if (err < 0)
511 return err;
512
513 err = constrain_interval_params(substream, params);
514 if (err < 0)
515 return err;
516
517 err = constrain_params_by_rules(substream, params);
518 if (err < 0)
519 return err;
520
1da177e4 521 params->rmask = 0;
7802fb52 522
1da177e4
LT
523 return 0;
524}
e88e8ae6
TI
525EXPORT_SYMBOL(snd_pcm_hw_refine);
526
877211f5
TI
527static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
528 struct snd_pcm_hw_params __user * _params)
1da177e4 529{
877211f5 530 struct snd_pcm_hw_params *params;
1da177e4
LT
531 int err;
532
ef44a1ec
LZ
533 params = memdup_user(_params, sizeof(*params));
534 if (IS_ERR(params))
535 return PTR_ERR(params);
536
1da177e4 537 err = snd_pcm_hw_refine(substream, params);
f74ae15f
TS
538 if (err < 0)
539 goto end;
ef44a1ec 540
f74ae15f
TS
541 err = fixup_unreferenced_params(substream, params);
542 if (err < 0)
543 goto end;
ef44a1ec 544
f74ae15f
TS
545 if (copy_to_user(_params, params, sizeof(*params)))
546 err = -EFAULT;
547end:
1da177e4
LT
548 kfree(params);
549 return err;
550}
551
9442e691
TI
552static 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
cb639a42
TI
567static void snd_pcm_set_state(struct snd_pcm_substream *substream,
568 snd_pcm_state_t state)
9b0573c0
TI
569{
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
90bbaf66
JY
576static 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
29bb274e 586void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
1e850bee 587{
29bb274e 588 if (substream->runtime && substream->runtime->stop_operating) {
1e850bee 589 substream->runtime->stop_operating = false;
29bb274e 590 if (substream->ops && substream->ops->sync_stop)
1e850bee 591 substream->ops->sync_stop(substream);
29bb274e 592 else if (sync_irq && substream->pcm->card->sync_irq > 0)
fabb26dc 593 synchronize_irq(substream->pcm->card->sync_irq);
1e850bee
TI
594 }
595}
596
60f96aae 597/**
f7b6603c 598 * snd_pcm_hw_params_choose - choose a configuration defined by @params
60f96aae
TS
599 * @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;
7b8a54af
TS
624 struct snd_mask old_mask;
625 struct snd_interval old_interval;
82e7d501 626 int changed;
60f96aae
TS
627
628 for (v = vars; *v != -1; v++) {
7b8a54af
TS
629 /* 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 }
60f96aae 638 if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
82e7d501 639 changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
60f96aae 640 else
82e7d501 641 changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
e1a3a981 642 if (changed < 0)
82e7d501
TS
643 return changed;
644 if (changed == 0)
645 continue;
7b8a54af 646
82e7d501 647 /* Trace the changed parameter. */
7b8a54af
TS
648 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 }
60f96aae 656 }
7b8a54af 657
60f96aae
TS
658 return 0;
659}
660
877211f5
TI
661static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
662 struct snd_pcm_hw_params *params)
1da177e4 663{
877211f5 664 struct snd_pcm_runtime *runtime;
9442e691 665 int err, usecs;
1da177e4
LT
666 unsigned int bits;
667 snd_pcm_uframes_t frames;
668
7eaa943c
TI
669 if (PCM_RUNTIME_CHECK(substream))
670 return -ENXIO;
1da177e4 671 runtime = substream->runtime;
1da177e4
LT
672 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);
8eeaa2f9 683#if IS_ENABLED(CONFIG_SND_PCM_OSS)
1da177e4
LT
684 if (!substream->oss.oss)
685#endif
9c323fcb 686 if (atomic_read(&substream->mmap_count))
1da177e4
LT
687 return -EBADFD;
688
29bb274e 689 snd_pcm_sync_stop(substream, true);
1e850bee 690
1da177e4
LT
691 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
f9a076bf
TS
700 err = fixup_unreferenced_params(substream, params);
701 if (err < 0)
702 goto _error;
703
0dba808e
TI
704 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
1da177e4
LT
712 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);
1da177e4
LT
726 runtime->info = params->info;
727 runtime->rate_num = params->rate_num;
728 runtime->rate_den = params->rate_den;
ab69a490
CL
729 runtime->no_period_wakeup =
730 (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
731 (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
1da177e4
LT
732
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;
1da177e4 748 runtime->control->avail_min = runtime->period_size;
1da177e4
LT
749 runtime->start_threshold = 1;
750 runtime->stop_threshold = runtime->buffer_size;
751 runtime->silence_threshold = 0;
752 runtime->silence_size = 0;
ead4046b
CL
753 runtime->boundary = runtime->buffer_size;
754 while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
755 runtime->boundary *= 2;
1da177e4 756
add9d56d 757 /* clear the buffer for avoiding possible kernel info leaks */
618de0f4
TI
758 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 }
add9d56d 765
1da177e4 766 snd_pcm_timer_resolution_change(substream);
9b0573c0 767 snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
9442e691 768
5371a79b
RW
769 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
770 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
137c171c
TI
771 usecs = period_to_usecs(runtime);
772 if (usecs >= 0)
5371a79b
RW
773 cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
774 usecs);
1da177e4
LT
775 return 0;
776 _error:
25985edc 777 /* hardware might be unusable from this time,
1da177e4
LT
778 so we force application to retry to set
779 the correct hardware parameter settings */
9b0573c0 780 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
1da177e4
LT
781 if (substream->ops->hw_free != NULL)
782 substream->ops->hw_free(substream);
0dba808e
TI
783 if (substream->managed_buffer_alloc)
784 snd_pcm_lib_free_pages(substream);
1da177e4
LT
785 return err;
786}
787
877211f5
TI
788static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
789 struct snd_pcm_hw_params __user * _params)
1da177e4 790{
877211f5 791 struct snd_pcm_hw_params *params;
1da177e4
LT
792 int err;
793
ef44a1ec
LZ
794 params = memdup_user(_params, sizeof(*params));
795 if (IS_ERR(params))
796 return PTR_ERR(params);
797
1da177e4 798 err = snd_pcm_hw_params(substream, params);
f74ae15f
TS
799 if (err < 0)
800 goto end;
ef44a1ec 801
f74ae15f
TS
802 if (copy_to_user(_params, params, sizeof(*params)))
803 err = -EFAULT;
804end:
1da177e4
LT
805 kfree(params);
806 return err;
807}
808
66f2d19f
TI
809static int do_hw_free(struct snd_pcm_substream *substream)
810{
811 int result = 0;
812
29bb274e 813 snd_pcm_sync_stop(substream, true);
66f2d19f
TI
814 if (substream->ops->hw_free)
815 result = substream->ops->hw_free(substream);
816 if (substream->managed_buffer_alloc)
817 snd_pcm_lib_free_pages(substream);
818 return result;
819}
820
877211f5 821static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
1da177e4 822{
877211f5 823 struct snd_pcm_runtime *runtime;
66f2d19f 824 int result;
1da177e4 825
7eaa943c
TI
826 if (PCM_RUNTIME_CHECK(substream))
827 return -ENXIO;
1da177e4 828 runtime = substream->runtime;
1da177e4
LT
829 snd_pcm_stream_lock_irq(substream);
830 switch (runtime->status->state) {
831 case SNDRV_PCM_STATE_SETUP:
832 case SNDRV_PCM_STATE_PREPARED:
833 break;
834 default:
835 snd_pcm_stream_unlock_irq(substream);
836 return -EBADFD;
837 }
838 snd_pcm_stream_unlock_irq(substream);
9c323fcb 839 if (atomic_read(&substream->mmap_count))
1da177e4 840 return -EBADFD;
66f2d19f 841 result = do_hw_free(substream);
9b0573c0 842 snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
5371a79b 843 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
1da177e4
LT
844 return result;
845}
846
877211f5
TI
847static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
848 struct snd_pcm_sw_params *params)
1da177e4 849{
877211f5 850 struct snd_pcm_runtime *runtime;
1250932e 851 int err;
1da177e4 852
7eaa943c
TI
853 if (PCM_RUNTIME_CHECK(substream))
854 return -ENXIO;
1da177e4 855 runtime = substream->runtime;
1da177e4
LT
856 snd_pcm_stream_lock_irq(substream);
857 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
858 snd_pcm_stream_unlock_irq(substream);
859 return -EBADFD;
860 }
861 snd_pcm_stream_unlock_irq(substream);
862
145d92e7
DC
863 if (params->tstamp_mode < 0 ||
864 params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
1da177e4 865 return -EINVAL;
58900810
TI
866 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
867 params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
5646eda5 868 return -EINVAL;
1da177e4
LT
869 if (params->avail_min == 0)
870 return -EINVAL;
1da177e4
LT
871 if (params->silence_size >= runtime->boundary) {
872 if (params->silence_threshold != 0)
873 return -EINVAL;
874 } else {
875 if (params->silence_size > params->silence_threshold)
876 return -EINVAL;
877 if (params->silence_threshold > runtime->buffer_size)
878 return -EINVAL;
879 }
1250932e 880 err = 0;
1da177e4
LT
881 snd_pcm_stream_lock_irq(substream);
882 runtime->tstamp_mode = params->tstamp_mode;
58900810
TI
883 if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
884 runtime->tstamp_type = params->tstamp_type;
1da177e4
LT
885 runtime->period_step = params->period_step;
886 runtime->control->avail_min = params->avail_min;
887 runtime->start_threshold = params->start_threshold;
888 runtime->stop_threshold = params->stop_threshold;
889 runtime->silence_threshold = params->silence_threshold;
890 runtime->silence_size = params->silence_size;
1da177e4
LT
891 params->boundary = runtime->boundary;
892 if (snd_pcm_running(substream)) {
1da177e4
LT
893 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
894 runtime->silence_size > 0)
895 snd_pcm_playback_silence(substream, ULONG_MAX);
1250932e 896 err = snd_pcm_update_state(substream, runtime);
1da177e4
LT
897 }
898 snd_pcm_stream_unlock_irq(substream);
1250932e 899 return err;
1da177e4
LT
900}
901
877211f5
TI
902static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
903 struct snd_pcm_sw_params __user * _params)
1da177e4 904{
877211f5 905 struct snd_pcm_sw_params params;
1da177e4
LT
906 int err;
907 if (copy_from_user(&params, _params, sizeof(params)))
908 return -EFAULT;
909 err = snd_pcm_sw_params(substream, &params);
910 if (copy_to_user(_params, &params, sizeof(params)))
911 return -EFAULT;
912 return err;
913}
914
c99c5a3b
TI
915static inline snd_pcm_uframes_t
916snd_pcm_calc_delay(struct snd_pcm_substream *substream)
917{
918 snd_pcm_uframes_t delay;
919
920 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
921 delay = snd_pcm_playback_hw_avail(substream->runtime);
922 else
923 delay = snd_pcm_capture_avail(substream->runtime);
924 return delay + substream->runtime->delay;
925}
926
3ddee7f8
BW
927int snd_pcm_status64(struct snd_pcm_substream *substream,
928 struct snd_pcm_status64 *status)
1da177e4 929{
877211f5 930 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
931
932 snd_pcm_stream_lock_irq(substream);
3179f620
PLB
933
934 snd_pcm_unpack_audio_tstamp_config(status->audio_tstamp_data,
935 &runtime->audio_tstamp_config);
936
937 /* backwards compatible behavior */
938 if (runtime->audio_tstamp_config.type_requested ==
939 SNDRV_PCM_AUDIO_TSTAMP_TYPE_COMPAT) {
940 if (runtime->hw.info & SNDRV_PCM_INFO_HAS_WALL_CLOCK)
941 runtime->audio_tstamp_config.type_requested =
942 SNDRV_PCM_AUDIO_TSTAMP_TYPE_LINK;
943 else
944 runtime->audio_tstamp_config.type_requested =
945 SNDRV_PCM_AUDIO_TSTAMP_TYPE_DEFAULT;
946 runtime->audio_tstamp_report.valid = 0;
947 } else
948 runtime->audio_tstamp_report.valid = 1;
949
1da177e4
LT
950 status->state = runtime->status->state;
951 status->suspended_state = runtime->status->suspended_state;
952 if (status->state == SNDRV_PCM_STATE_OPEN)
953 goto _end;
3ddee7f8
BW
954 status->trigger_tstamp_sec = runtime->trigger_tstamp.tv_sec;
955 status->trigger_tstamp_nsec = runtime->trigger_tstamp.tv_nsec;
8c121586 956 if (snd_pcm_running(substream)) {
1da177e4 957 snd_pcm_update_hw_ptr(substream);
8c121586 958 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
3ddee7f8
BW
959 status->tstamp_sec = runtime->status->tstamp.tv_sec;
960 status->tstamp_nsec =
961 runtime->status->tstamp.tv_nsec;
962 status->driver_tstamp_sec =
963 runtime->driver_tstamp.tv_sec;
964 status->driver_tstamp_nsec =
965 runtime->driver_tstamp.tv_nsec;
966 status->audio_tstamp_sec =
967 runtime->status->audio_tstamp.tv_sec;
968 status->audio_tstamp_nsec =
969 runtime->status->audio_tstamp.tv_nsec;
3179f620
PLB
970 if (runtime->audio_tstamp_report.valid == 1)
971 /* backwards compatibility, no report provided in COMPAT mode */
972 snd_pcm_pack_audio_tstamp_report(&status->audio_tstamp_data,
973 &status->audio_tstamp_accuracy,
974 &runtime->audio_tstamp_report);
975
8c121586
JK
976 goto _tstamp_end;
977 }
0d59b814
PLB
978 } else {
979 /* get tstamp only in fallback mode and only if enabled */
fcae40c9
BW
980 if (runtime->tstamp_mode == SNDRV_PCM_TSTAMP_ENABLE) {
981 struct timespec64 tstamp;
982
983 snd_pcm_gettime(runtime, &tstamp);
3ddee7f8
BW
984 status->tstamp_sec = tstamp.tv_sec;
985 status->tstamp_nsec = tstamp.tv_nsec;
fcae40c9 986 }
8c121586 987 }
8c121586 988 _tstamp_end:
1da177e4
LT
989 status->appl_ptr = runtime->control->appl_ptr;
990 status->hw_ptr = runtime->status->hw_ptr;
763e5067 991 status->avail = snd_pcm_avail(substream);
c99c5a3b
TI
992 status->delay = snd_pcm_running(substream) ?
993 snd_pcm_calc_delay(substream) : 0;
1da177e4
LT
994 status->avail_max = runtime->avail_max;
995 status->overrange = runtime->overrange;
996 runtime->avail_max = 0;
997 runtime->overrange = 0;
998 _end:
999 snd_pcm_stream_unlock_irq(substream);
1000 return 0;
1001}
1002
3ddee7f8
BW
1003static int snd_pcm_status_user64(struct snd_pcm_substream *substream,
1004 struct snd_pcm_status64 __user * _status,
1005 bool ext)
1da177e4 1006{
3ddee7f8 1007 struct snd_pcm_status64 status;
1da177e4 1008 int res;
38ca2a4d 1009
1da177e4 1010 memset(&status, 0, sizeof(status));
38ca2a4d
PLB
1011 /*
1012 * with extension, parameters are read/write,
1013 * get audio_tstamp_data from user,
1014 * ignore rest of status structure
1015 */
1016 if (ext && get_user(status.audio_tstamp_data,
1017 (u32 __user *)(&_status->audio_tstamp_data)))
1018 return -EFAULT;
3ddee7f8 1019 res = snd_pcm_status64(substream, &status);
1da177e4
LT
1020 if (res < 0)
1021 return res;
1022 if (copy_to_user(_status, &status, sizeof(status)))
1023 return -EFAULT;
1024 return 0;
1025}
1026
3ddee7f8
BW
1027static int snd_pcm_status_user32(struct snd_pcm_substream *substream,
1028 struct snd_pcm_status32 __user * _status,
1029 bool ext)
1030{
1031 struct snd_pcm_status64 status64;
1032 struct snd_pcm_status32 status32;
1033 int res;
1034
1035 memset(&status64, 0, sizeof(status64));
1036 memset(&status32, 0, sizeof(status32));
1037 /*
1038 * with extension, parameters are read/write,
1039 * get audio_tstamp_data from user,
1040 * ignore rest of status structure
1041 */
1042 if (ext && get_user(status64.audio_tstamp_data,
1043 (u32 __user *)(&_status->audio_tstamp_data)))
1044 return -EFAULT;
1045 res = snd_pcm_status64(substream, &status64);
1046 if (res < 0)
1047 return res;
1048
1049 status32 = (struct snd_pcm_status32) {
1050 .state = status64.state,
1051 .trigger_tstamp_sec = status64.trigger_tstamp_sec,
1052 .trigger_tstamp_nsec = status64.trigger_tstamp_nsec,
1053 .tstamp_sec = status64.tstamp_sec,
1054 .tstamp_nsec = status64.tstamp_nsec,
1055 .appl_ptr = status64.appl_ptr,
1056 .hw_ptr = status64.hw_ptr,
1057 .delay = status64.delay,
1058 .avail = status64.avail,
1059 .avail_max = status64.avail_max,
1060 .overrange = status64.overrange,
1061 .suspended_state = status64.suspended_state,
1062 .audio_tstamp_data = status64.audio_tstamp_data,
1063 .audio_tstamp_sec = status64.audio_tstamp_sec,
1064 .audio_tstamp_nsec = status64.audio_tstamp_nsec,
1065 .driver_tstamp_sec = status64.audio_tstamp_sec,
1066 .driver_tstamp_nsec = status64.audio_tstamp_nsec,
1067 .audio_tstamp_accuracy = status64.audio_tstamp_accuracy,
1068 };
1069
1070 if (copy_to_user(_status, &status32, sizeof(status32)))
1071 return -EFAULT;
1072
1073 return 0;
1074}
1075
877211f5
TI
1076static int snd_pcm_channel_info(struct snd_pcm_substream *substream,
1077 struct snd_pcm_channel_info * info)
1da177e4 1078{
877211f5 1079 struct snd_pcm_runtime *runtime;
1da177e4
LT
1080 unsigned int channel;
1081
1da177e4
LT
1082 channel = info->channel;
1083 runtime = substream->runtime;
1084 snd_pcm_stream_lock_irq(substream);
1085 if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
1086 snd_pcm_stream_unlock_irq(substream);
1087 return -EBADFD;
1088 }
1089 snd_pcm_stream_unlock_irq(substream);
1090 if (channel >= runtime->channels)
1091 return -EINVAL;
1092 memset(info, 0, sizeof(*info));
1093 info->channel = channel;
fc033cbf 1094 return snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_CHANNEL_INFO, info);
1da177e4
LT
1095}
1096
877211f5
TI
1097static int snd_pcm_channel_info_user(struct snd_pcm_substream *substream,
1098 struct snd_pcm_channel_info __user * _info)
1da177e4 1099{
877211f5 1100 struct snd_pcm_channel_info info;
1da177e4
LT
1101 int res;
1102
1103 if (copy_from_user(&info, _info, sizeof(info)))
1104 return -EFAULT;
1105 res = snd_pcm_channel_info(substream, &info);
1106 if (res < 0)
1107 return res;
1108 if (copy_to_user(_info, &info, sizeof(info)))
1109 return -EFAULT;
1110 return 0;
1111}
1112
877211f5 1113static void snd_pcm_trigger_tstamp(struct snd_pcm_substream *substream)
1da177e4 1114{
877211f5 1115 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1116 if (runtime->trigger_master == NULL)
1117 return;
1118 if (runtime->trigger_master == substream) {
2b79d7a6
PLB
1119 if (!runtime->trigger_tstamp_latched)
1120 snd_pcm_gettime(runtime, &runtime->trigger_tstamp);
1da177e4
LT
1121 } else {
1122 snd_pcm_trigger_tstamp(runtime->trigger_master);
1123 runtime->trigger_tstamp = runtime->trigger_master->runtime->trigger_tstamp;
1124 }
1125 runtime->trigger_master = NULL;
1126}
1127
cb639a42
TI
1128#define ACTION_ARG_IGNORE (__force snd_pcm_state_t)0
1129
1da177e4 1130struct action_ops {
cb639a42
TI
1131 int (*pre_action)(struct snd_pcm_substream *substream,
1132 snd_pcm_state_t state);
1133 int (*do_action)(struct snd_pcm_substream *substream,
1134 snd_pcm_state_t state);
1135 void (*undo_action)(struct snd_pcm_substream *substream,
1136 snd_pcm_state_t state);
1137 void (*post_action)(struct snd_pcm_substream *substream,
1138 snd_pcm_state_t state);
1da177e4
LT
1139};
1140
1141/*
1142 * this functions is core for handling of linked stream
1143 * Note: the stream state might be changed also on failure
1144 * Note2: call with calling stream lock + link lock
1145 */
b17154cf 1146static int snd_pcm_action_group(const struct action_ops *ops,
877211f5 1147 struct snd_pcm_substream *substream,
cb639a42
TI
1148 snd_pcm_state_t state,
1149 bool do_lock)
1da177e4 1150{
877211f5
TI
1151 struct snd_pcm_substream *s = NULL;
1152 struct snd_pcm_substream *s1;
dde1c652 1153 int res = 0, depth = 1;
1da177e4 1154
ef991b95 1155 snd_pcm_group_for_each_entry(s, substream) {
257f8cce
TI
1156 if (do_lock && s != substream) {
1157 if (s->pcm->nonatomic)
dde1c652 1158 mutex_lock_nested(&s->self_group.mutex, depth);
257f8cce 1159 else
dde1c652
TI
1160 spin_lock_nested(&s->self_group.lock, depth);
1161 depth++;
257f8cce 1162 }
1da177e4
LT
1163 res = ops->pre_action(s, state);
1164 if (res < 0)
1165 goto _unlock;
1166 }
ef991b95 1167 snd_pcm_group_for_each_entry(s, substream) {
1da177e4
LT
1168 res = ops->do_action(s, state);
1169 if (res < 0) {
1170 if (ops->undo_action) {
ef991b95 1171 snd_pcm_group_for_each_entry(s1, substream) {
1da177e4
LT
1172 if (s1 == s) /* failed stream */
1173 break;
1174 ops->undo_action(s1, state);
1175 }
1176 }
1177 s = NULL; /* unlock all */
1178 goto _unlock;
1179 }
1180 }
ef991b95 1181 snd_pcm_group_for_each_entry(s, substream) {
1da177e4
LT
1182 ops->post_action(s, state);
1183 }
1184 _unlock:
1185 if (do_lock) {
1186 /* unlock streams */
ef991b95 1187 snd_pcm_group_for_each_entry(s1, substream) {
257f8cce 1188 if (s1 != substream) {
811deede 1189 if (s1->pcm->nonatomic)
257f8cce
TI
1190 mutex_unlock(&s1->self_group.mutex);
1191 else
1192 spin_unlock(&s1->self_group.lock);
1193 }
1da177e4
LT
1194 if (s1 == s) /* end */
1195 break;
1196 }
1197 }
1198 return res;
1199}
1200
1201/*
1202 * Note: call with stream lock
1203 */
b17154cf 1204static int snd_pcm_action_single(const struct action_ops *ops,
877211f5 1205 struct snd_pcm_substream *substream,
cb639a42 1206 snd_pcm_state_t state)
1da177e4
LT
1207{
1208 int res;
1209
1210 res = ops->pre_action(substream, state);
1211 if (res < 0)
1212 return res;
1213 res = ops->do_action(substream, state);
1214 if (res == 0)
1215 ops->post_action(substream, state);
1216 else if (ops->undo_action)
1217 ops->undo_action(substream, state);
1218 return res;
1219}
1220
a41c4cb9
TI
1221static void snd_pcm_group_assign(struct snd_pcm_substream *substream,
1222 struct snd_pcm_group *new_group)
1223{
1224 substream->group = new_group;
1225 list_move(&substream->link_list, &new_group->substreams);
1226}
1227
f57f3df0
TI
1228/*
1229 * Unref and unlock the group, but keep the stream lock;
1230 * when the group becomes empty and no longer referred, destroy itself
1231 */
1232static void snd_pcm_group_unref(struct snd_pcm_group *group,
1233 struct snd_pcm_substream *substream)
1234{
1235 bool do_free;
1236
1237 if (!group)
1238 return;
0e279dce 1239 do_free = refcount_dec_and_test(&group->refs);
f57f3df0
TI
1240 snd_pcm_group_unlock(group, substream->pcm->nonatomic);
1241 if (do_free)
1242 kfree(group);
1243}
1244
1245/*
1246 * Lock the group inside a stream lock and reference it;
1247 * return the locked group object, or NULL if not linked
1248 */
1249static struct snd_pcm_group *
1250snd_pcm_stream_group_ref(struct snd_pcm_substream *substream)
1251{
1252 bool nonatomic = substream->pcm->nonatomic;
1253 struct snd_pcm_group *group;
1254 bool trylock;
1255
1256 for (;;) {
1257 if (!snd_pcm_stream_linked(substream))
1258 return NULL;
1259 group = substream->group;
1260 /* block freeing the group object */
1261 refcount_inc(&group->refs);
1262
1263 trylock = nonatomic ? mutex_trylock(&group->mutex) :
1264 spin_trylock(&group->lock);
1265 if (trylock)
1266 break; /* OK */
1267
1268 /* re-lock for avoiding ABBA deadlock */
1269 snd_pcm_stream_unlock(substream);
1270 snd_pcm_group_lock(group, nonatomic);
1271 snd_pcm_stream_lock(substream);
1272
1273 /* check the group again; the above opens a small race window */
1274 if (substream->group == group)
1275 break; /* OK */
1276 /* group changed, try again */
1277 snd_pcm_group_unref(group, substream);
1278 }
1279 return group;
1280}
1281
aa8edd8c
TI
1282/*
1283 * Note: call with stream lock
1284 */
b17154cf 1285static int snd_pcm_action(const struct action_ops *ops,
aa8edd8c 1286 struct snd_pcm_substream *substream,
cb639a42 1287 snd_pcm_state_t state)
257f8cce 1288{
f57f3df0 1289 struct snd_pcm_group *group;
257f8cce
TI
1290 int res;
1291
f57f3df0
TI
1292 group = snd_pcm_stream_group_ref(substream);
1293 if (group)
cb639a42 1294 res = snd_pcm_action_group(ops, substream, state, true);
f57f3df0
TI
1295 else
1296 res = snd_pcm_action_single(ops, substream, state);
1297 snd_pcm_group_unref(group, substream);
1da177e4
LT
1298 return res;
1299}
1300
1301/*
1302 * Note: don't use any locks before
1303 */
b17154cf 1304static int snd_pcm_action_lock_irq(const struct action_ops *ops,
877211f5 1305 struct snd_pcm_substream *substream,
cb639a42 1306 snd_pcm_state_t state)
1da177e4
LT
1307{
1308 int res;
1309
e3a4bd5e
TI
1310 snd_pcm_stream_lock_irq(substream);
1311 res = snd_pcm_action(ops, substream, state);
1312 snd_pcm_stream_unlock_irq(substream);
1da177e4
LT
1313 return res;
1314}
1315
1316/*
1317 */
b17154cf 1318static int snd_pcm_action_nonatomic(const struct action_ops *ops,
877211f5 1319 struct snd_pcm_substream *substream,
cb639a42 1320 snd_pcm_state_t state)
1da177e4
LT
1321{
1322 int res;
1323
f57f3df0 1324 /* Guarantee the group members won't change during non-atomic action */
1da177e4
LT
1325 down_read(&snd_pcm_link_rwsem);
1326 if (snd_pcm_stream_linked(substream))
cb639a42 1327 res = snd_pcm_action_group(ops, substream, state, false);
1da177e4
LT
1328 else
1329 res = snd_pcm_action_single(ops, substream, state);
1330 up_read(&snd_pcm_link_rwsem);
1331 return res;
1332}
1333
1334/*
1335 * start callbacks
1336 */
cb639a42
TI
1337static int snd_pcm_pre_start(struct snd_pcm_substream *substream,
1338 snd_pcm_state_t state)
1da177e4 1339{
877211f5 1340 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1341 if (runtime->status->state != SNDRV_PCM_STATE_PREPARED)
1342 return -EBADFD;
1343 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1344 !snd_pcm_playback_data(substream))
1345 return -EPIPE;
2b79d7a6 1346 runtime->trigger_tstamp_latched = false;
1da177e4
LT
1347 runtime->trigger_master = substream;
1348 return 0;
1349}
1350
cb639a42
TI
1351static int snd_pcm_do_start(struct snd_pcm_substream *substream,
1352 snd_pcm_state_t state)
1da177e4
LT
1353{
1354 if (substream->runtime->trigger_master != substream)
1355 return 0;
1356 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1357}
1358
cb639a42
TI
1359static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1360 snd_pcm_state_t state)
1da177e4
LT
1361{
1362 if (substream->runtime->trigger_master == substream)
1363 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1364}
1365
cb639a42
TI
1366static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1367 snd_pcm_state_t state)
1da177e4 1368{
877211f5 1369 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 1370 snd_pcm_trigger_tstamp(substream);
6af3fb72 1371 runtime->hw_ptr_jiffies = jiffies;
bd76af0f
JK
1372 runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) /
1373 runtime->rate;
1da177e4
LT
1374 runtime->status->state = state;
1375 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1376 runtime->silence_size > 0)
1377 snd_pcm_playback_silence(substream, ULONG_MAX);
90bbaf66 1378 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1da177e4
LT
1379}
1380
b17154cf 1381static const struct action_ops snd_pcm_action_start = {
1da177e4
LT
1382 .pre_action = snd_pcm_pre_start,
1383 .do_action = snd_pcm_do_start,
1384 .undo_action = snd_pcm_undo_start,
1385 .post_action = snd_pcm_post_start
1386};
1387
1388/**
1c85cc64 1389 * snd_pcm_start - start all linked streams
df8db936 1390 * @substream: the PCM substream instance
eb7c06e8
YB
1391 *
1392 * Return: Zero if successful, or a negative error code.
c2c86a97 1393 * The stream lock must be acquired before calling this function.
1da177e4 1394 */
877211f5 1395int snd_pcm_start(struct snd_pcm_substream *substream)
1da177e4 1396{
877211f5
TI
1397 return snd_pcm_action(&snd_pcm_action_start, substream,
1398 SNDRV_PCM_STATE_RUNNING);
1da177e4
LT
1399}
1400
c2c86a97
TI
1401/* take the stream lock and start the streams */
1402static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1403{
1404 return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1405 SNDRV_PCM_STATE_RUNNING);
1406}
1407
1da177e4
LT
1408/*
1409 * stop callbacks
1410 */
cb639a42
TI
1411static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1412 snd_pcm_state_t state)
1da177e4 1413{
877211f5 1414 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1415 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1416 return -EBADFD;
1417 runtime->trigger_master = substream;
1418 return 0;
1419}
1420
cb639a42
TI
1421static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1422 snd_pcm_state_t state)
1da177e4
LT
1423{
1424 if (substream->runtime->trigger_master == substream &&
700cb707 1425 snd_pcm_running(substream)) {
1da177e4 1426 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
700cb707
TI
1427 substream->runtime->stop_operating = true;
1428 }
583770e8 1429 return 0; /* unconditionally stop all substreams */
1da177e4
LT
1430}
1431
cb639a42
TI
1432static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1433 snd_pcm_state_t state)
1da177e4 1434{
877211f5 1435 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1436 if (runtime->status->state != state) {
1437 snd_pcm_trigger_tstamp(substream);
9bc889b4 1438 runtime->status->state = state;
90bbaf66 1439 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1da177e4
LT
1440 }
1441 wake_up(&runtime->sleep);
c91a988d 1442 wake_up(&runtime->tsleep);
1da177e4
LT
1443}
1444
b17154cf 1445static const struct action_ops snd_pcm_action_stop = {
1da177e4
LT
1446 .pre_action = snd_pcm_pre_stop,
1447 .do_action = snd_pcm_do_stop,
1448 .post_action = snd_pcm_post_stop
1449};
1450
1451/**
1c85cc64 1452 * snd_pcm_stop - try to stop all running streams in the substream group
df8db936
TI
1453 * @substream: the PCM substream instance
1454 * @state: PCM state after stopping the stream
1da177e4 1455 *
1c85cc64 1456 * The state of each stream is then changed to the given state unconditionally.
eb7c06e8 1457 *
0a11458c 1458 * Return: Zero if successful, or a negative error code.
1da177e4 1459 */
fea952e5 1460int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1da177e4
LT
1461{
1462 return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1463}
e88e8ae6
TI
1464EXPORT_SYMBOL(snd_pcm_stop);
1465
1da177e4 1466/**
1c85cc64 1467 * snd_pcm_drain_done - stop the DMA only when the given stream is playback
df8db936 1468 * @substream: the PCM substream
1da177e4 1469 *
1c85cc64 1470 * After stopping, the state is changed to SETUP.
1da177e4 1471 * Unlike snd_pcm_stop(), this affects only the given stream.
eb7c06e8 1472 *
583770e8 1473 * Return: Zero if successful, or a negative error code.
1da177e4 1474 */
877211f5 1475int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1da177e4 1476{
877211f5
TI
1477 return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1478 SNDRV_PCM_STATE_SETUP);
1da177e4
LT
1479}
1480
1fb8510c
TI
1481/**
1482 * snd_pcm_stop_xrun - stop the running streams as XRUN
1483 * @substream: the PCM substream instance
1fb8510c
TI
1484 *
1485 * This stops the given running substream (and all linked substreams) as XRUN.
1486 * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1487 *
1488 * Return: Zero if successful, or a negative error code.
1489 */
1490int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1491{
1492 unsigned long flags;
1fb8510c
TI
1493
1494 snd_pcm_stream_lock_irqsave(substream, flags);
e647f5a5 1495 if (substream->runtime && snd_pcm_running(substream))
9cd641ed 1496 __snd_pcm_xrun(substream);
1fb8510c 1497 snd_pcm_stream_unlock_irqrestore(substream, flags);
9cd641ed 1498 return 0;
1fb8510c
TI
1499}
1500EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1501
1da177e4 1502/*
cb639a42 1503 * pause callbacks: pass boolean (to start pause or resume) as state argument
1da177e4 1504 */
cb639a42
TI
1505#define pause_pushed(state) (__force bool)(state)
1506
1507static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1508 snd_pcm_state_t state)
1da177e4 1509{
877211f5 1510 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1511 if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1512 return -ENOSYS;
cb639a42 1513 if (pause_pushed(state)) {
1da177e4
LT
1514 if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1515 return -EBADFD;
1516 } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1517 return -EBADFD;
1518 runtime->trigger_master = substream;
1519 return 0;
1520}
1521
cb639a42
TI
1522static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1523 snd_pcm_state_t state)
1da177e4
LT
1524{
1525 if (substream->runtime->trigger_master != substream)
1526 return 0;
56385a12
JK
1527 /* some drivers might use hw_ptr to recover from the pause -
1528 update the hw_ptr now */
cb639a42 1529 if (pause_pushed(state))
56385a12 1530 snd_pcm_update_hw_ptr(substream);
6af3fb72 1531 /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
b595076a 1532 * a delta between the current jiffies, this gives a large enough
6af3fb72
TI
1533 * delta, effectively to skip the check once.
1534 */
1535 substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1da177e4 1536 return substream->ops->trigger(substream,
cb639a42
TI
1537 pause_pushed(state) ?
1538 SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1539 SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1da177e4
LT
1540}
1541
cb639a42
TI
1542static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1543 snd_pcm_state_t state)
1da177e4
LT
1544{
1545 if (substream->runtime->trigger_master == substream)
1546 substream->ops->trigger(substream,
cb639a42
TI
1547 pause_pushed(state) ?
1548 SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1da177e4
LT
1549 SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1550}
1551
cb639a42
TI
1552static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1553 snd_pcm_state_t state)
1da177e4 1554{
877211f5 1555 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 1556 snd_pcm_trigger_tstamp(substream);
cb639a42 1557 if (pause_pushed(state)) {
1da177e4 1558 runtime->status->state = SNDRV_PCM_STATE_PAUSED;
90bbaf66 1559 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1da177e4 1560 wake_up(&runtime->sleep);
c91a988d 1561 wake_up(&runtime->tsleep);
1da177e4
LT
1562 } else {
1563 runtime->status->state = SNDRV_PCM_STATE_RUNNING;
90bbaf66 1564 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1da177e4
LT
1565 }
1566}
1567
b17154cf 1568static const struct action_ops snd_pcm_action_pause = {
1da177e4
LT
1569 .pre_action = snd_pcm_pre_pause,
1570 .do_action = snd_pcm_do_pause,
1571 .undo_action = snd_pcm_undo_pause,
1572 .post_action = snd_pcm_post_pause
1573};
1574
1575/*
1576 * Push/release the pause for all linked streams.
1577 */
cb639a42 1578static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1da177e4 1579{
cb639a42
TI
1580 return snd_pcm_action(&snd_pcm_action_pause, substream,
1581 (__force snd_pcm_state_t)push);
1582}
1583
1584static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1585 bool push)
1586{
1587 return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1588 (__force snd_pcm_state_t)push);
1da177e4
LT
1589}
1590
1591#ifdef CONFIG_PM
cb639a42 1592/* suspend callback: state argument ignored */
1da177e4 1593
cb639a42
TI
1594static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1595 snd_pcm_state_t state)
1da177e4 1596{
877211f5 1597 struct snd_pcm_runtime *runtime = substream->runtime;
113ce081
TI
1598 switch (runtime->status->state) {
1599 case SNDRV_PCM_STATE_SUSPENDED:
1da177e4 1600 return -EBUSY;
113ce081
TI
1601 /* unresumable PCM state; return -EBUSY for skipping suspend */
1602 case SNDRV_PCM_STATE_OPEN:
1603 case SNDRV_PCM_STATE_SETUP:
1604 case SNDRV_PCM_STATE_DISCONNECTED:
1605 return -EBUSY;
1606 }
1da177e4
LT
1607 runtime->trigger_master = substream;
1608 return 0;
1609}
1610
cb639a42
TI
1611static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1612 snd_pcm_state_t state)
1da177e4 1613{
877211f5 1614 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1615 if (runtime->trigger_master != substream)
1616 return 0;
1617 if (! snd_pcm_running(substream))
1618 return 0;
1619 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
2c87c1a4 1620 runtime->stop_operating = true;
1da177e4
LT
1621 return 0; /* suspend unconditionally */
1622}
1623
cb639a42
TI
1624static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1625 snd_pcm_state_t state)
1da177e4 1626{
877211f5 1627 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 1628 snd_pcm_trigger_tstamp(substream);
9bc889b4
TI
1629 runtime->status->suspended_state = runtime->status->state;
1630 runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
90bbaf66 1631 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1da177e4 1632 wake_up(&runtime->sleep);
c91a988d 1633 wake_up(&runtime->tsleep);
1da177e4
LT
1634}
1635
b17154cf 1636static const struct action_ops snd_pcm_action_suspend = {
1da177e4
LT
1637 .pre_action = snd_pcm_pre_suspend,
1638 .do_action = snd_pcm_do_suspend,
1639 .post_action = snd_pcm_post_suspend
1640};
1641
ce7f93e2 1642/*
1c85cc64 1643 * snd_pcm_suspend - trigger SUSPEND to all linked streams
df8db936 1644 * @substream: the PCM substream
1da177e4 1645 *
1da177e4 1646 * After this call, all streams are changed to SUSPENDED state.
eb7c06e8 1647 *
ce7f93e2 1648 * Return: Zero if successful, or a negative error code.
1da177e4 1649 */
ce7f93e2 1650static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1da177e4
LT
1651{
1652 int err;
1653 unsigned long flags;
1654
1655 snd_pcm_stream_lock_irqsave(substream, flags);
cb639a42
TI
1656 err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1657 ACTION_ARG_IGNORE);
1da177e4
LT
1658 snd_pcm_stream_unlock_irqrestore(substream, flags);
1659 return err;
1660}
e88e8ae6 1661
1da177e4 1662/**
1c85cc64 1663 * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
df8db936 1664 * @pcm: the PCM instance
1da177e4 1665 *
1da177e4 1666 * After this call, all streams are changed to SUSPENDED state.
eb7c06e8
YB
1667 *
1668 * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1da177e4 1669 */
877211f5 1670int snd_pcm_suspend_all(struct snd_pcm *pcm)
1da177e4 1671{
877211f5 1672 struct snd_pcm_substream *substream;
1da177e4
LT
1673 int stream, err = 0;
1674
603bf524
TI
1675 if (! pcm)
1676 return 0;
1677
8d19b4e0
TI
1678 for_each_pcm_substream(pcm, stream, substream) {
1679 /* FIXME: the open/close code should lock this as well */
1680 if (!substream->runtime)
1681 continue;
1682
1683 /*
1684 * Skip BE dai link PCM's that are internal and may
1685 * not have their substream ops set.
1686 */
1687 if (!substream->ops)
1688 continue;
1689
1690 err = snd_pcm_suspend(substream);
1691 if (err < 0 && err != -EBUSY)
1692 return err;
1da177e4 1693 }
2c87c1a4 1694
8d19b4e0
TI
1695 for_each_pcm_substream(pcm, stream, substream)
1696 snd_pcm_sync_stop(substream, false);
2c87c1a4 1697
1da177e4
LT
1698 return 0;
1699}
e88e8ae6
TI
1700EXPORT_SYMBOL(snd_pcm_suspend_all);
1701
cb639a42 1702/* resume callbacks: state argument ignored */
1da177e4 1703
cb639a42
TI
1704static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1705 snd_pcm_state_t state)
1da177e4 1706{
877211f5 1707 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1708 if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1709 return -ENOSYS;
1710 runtime->trigger_master = substream;
1711 return 0;
1712}
1713
cb639a42
TI
1714static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1715 snd_pcm_state_t state)
1da177e4 1716{
877211f5 1717 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1718 if (runtime->trigger_master != substream)
1719 return 0;
1720 /* DMA not running previously? */
1721 if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1722 (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1723 substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1724 return 0;
1725 return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1726}
1727
cb639a42
TI
1728static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1729 snd_pcm_state_t state)
1da177e4
LT
1730{
1731 if (substream->runtime->trigger_master == substream &&
1732 snd_pcm_running(substream))
1733 substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1734}
1735
cb639a42
TI
1736static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1737 snd_pcm_state_t state)
1da177e4 1738{
877211f5 1739 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 1740 snd_pcm_trigger_tstamp(substream);
9bc889b4 1741 runtime->status->state = runtime->status->suspended_state;
90bbaf66 1742 snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1da177e4
LT
1743}
1744
b17154cf 1745static const struct action_ops snd_pcm_action_resume = {
1da177e4
LT
1746 .pre_action = snd_pcm_pre_resume,
1747 .do_action = snd_pcm_do_resume,
1748 .undo_action = snd_pcm_undo_resume,
1749 .post_action = snd_pcm_post_resume
1750};
1751
877211f5 1752static int snd_pcm_resume(struct snd_pcm_substream *substream)
1da177e4 1753{
cb639a42
TI
1754 return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1755 ACTION_ARG_IGNORE);
1da177e4
LT
1756}
1757
1758#else
1759
877211f5 1760static int snd_pcm_resume(struct snd_pcm_substream *substream)
1da177e4
LT
1761{
1762 return -ENOSYS;
1763}
1764
1765#endif /* CONFIG_PM */
1766
1767/*
1768 * xrun ioctl
1769 *
1770 * Change the RUNNING stream(s) to XRUN state.
1771 */
877211f5 1772static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1da177e4 1773{
877211f5 1774 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1775 int result;
1776
1da177e4
LT
1777 snd_pcm_stream_lock_irq(substream);
1778 switch (runtime->status->state) {
1779 case SNDRV_PCM_STATE_XRUN:
1780 result = 0; /* already there */
1781 break;
1782 case SNDRV_PCM_STATE_RUNNING:
9cd641ed
TI
1783 __snd_pcm_xrun(substream);
1784 result = 0;
1da177e4
LT
1785 break;
1786 default:
1787 result = -EBADFD;
1788 }
1789 snd_pcm_stream_unlock_irq(substream);
1da177e4
LT
1790 return result;
1791}
1792
1793/*
1794 * reset ioctl
1795 */
cb639a42
TI
1796/* reset callbacks: state argument ignored */
1797static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1798 snd_pcm_state_t state)
1da177e4 1799{
877211f5 1800 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1801 switch (runtime->status->state) {
1802 case SNDRV_PCM_STATE_RUNNING:
1803 case SNDRV_PCM_STATE_PREPARED:
1804 case SNDRV_PCM_STATE_PAUSED:
1805 case SNDRV_PCM_STATE_SUSPENDED:
1806 return 0;
1807 default:
1808 return -EBADFD;
1809 }
1810}
1811
cb639a42
TI
1812static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1813 snd_pcm_state_t state)
1da177e4 1814{
877211f5 1815 struct snd_pcm_runtime *runtime = substream->runtime;
fc033cbf 1816 int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1da177e4
LT
1817 if (err < 0)
1818 return err;
1da177e4 1819 runtime->hw_ptr_base = 0;
e7636925
JK
1820 runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1821 runtime->status->hw_ptr % runtime->period_size;
1da177e4
LT
1822 runtime->silence_start = runtime->status->hw_ptr;
1823 runtime->silence_filled = 0;
1824 return 0;
1825}
1826
cb639a42
TI
1827static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1828 snd_pcm_state_t state)
1da177e4 1829{
877211f5 1830 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1831 runtime->control->appl_ptr = runtime->status->hw_ptr;
1832 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1833 runtime->silence_size > 0)
1834 snd_pcm_playback_silence(substream, ULONG_MAX);
1835}
1836
b17154cf 1837static const struct action_ops snd_pcm_action_reset = {
1da177e4
LT
1838 .pre_action = snd_pcm_pre_reset,
1839 .do_action = snd_pcm_do_reset,
1840 .post_action = snd_pcm_post_reset
1841};
1842
877211f5 1843static int snd_pcm_reset(struct snd_pcm_substream *substream)
1da177e4 1844{
cb639a42
TI
1845 return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1846 ACTION_ARG_IGNORE);
1da177e4
LT
1847}
1848
1849/*
1850 * prepare ioctl
1851 */
cb639a42 1852/* pass f_flags as state argument */
0df63e44 1853static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
cb639a42 1854 snd_pcm_state_t state)
1da177e4 1855{
877211f5 1856 struct snd_pcm_runtime *runtime = substream->runtime;
cb639a42
TI
1857 int f_flags = (__force int)state;
1858
de1b8b93
TI
1859 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1860 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1da177e4
LT
1861 return -EBADFD;
1862 if (snd_pcm_running(substream))
1863 return -EBUSY;
0df63e44 1864 substream->f_flags = f_flags;
1da177e4
LT
1865 return 0;
1866}
1867
cb639a42
TI
1868static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1869 snd_pcm_state_t state)
1da177e4
LT
1870{
1871 int err;
29bb274e 1872 snd_pcm_sync_stop(substream, true);
1da177e4
LT
1873 err = substream->ops->prepare(substream);
1874 if (err < 0)
1875 return err;
cb639a42 1876 return snd_pcm_do_reset(substream, state);
1da177e4
LT
1877}
1878
cb639a42
TI
1879static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1880 snd_pcm_state_t state)
1da177e4 1881{
877211f5 1882 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 1883 runtime->control->appl_ptr = runtime->status->hw_ptr;
9b0573c0 1884 snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1da177e4
LT
1885}
1886
b17154cf 1887static const struct action_ops snd_pcm_action_prepare = {
1da177e4
LT
1888 .pre_action = snd_pcm_pre_prepare,
1889 .do_action = snd_pcm_do_prepare,
1890 .post_action = snd_pcm_post_prepare
1891};
1892
1893/**
1c85cc64 1894 * snd_pcm_prepare - prepare the PCM substream to be triggerable
df8db936 1895 * @substream: the PCM substream instance
0df63e44 1896 * @file: file to refer f_flags
eb7c06e8
YB
1897 *
1898 * Return: Zero if successful, or a negative error code.
1da177e4 1899 */
0df63e44
TI
1900static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1901 struct file *file)
1da177e4 1902{
0df63e44
TI
1903 int f_flags;
1904
1905 if (file)
1906 f_flags = file->f_flags;
1907 else
1908 f_flags = substream->f_flags;
1da177e4 1909
1b745cd9
TI
1910 snd_pcm_stream_lock_irq(substream);
1911 switch (substream->runtime->status->state) {
1912 case SNDRV_PCM_STATE_PAUSED:
cb639a42 1913 snd_pcm_pause(substream, false);
c0dbbdad 1914 fallthrough;
1b745cd9
TI
1915 case SNDRV_PCM_STATE_SUSPENDED:
1916 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1917 break;
1918 }
1919 snd_pcm_stream_unlock_irq(substream);
1920
68b4acd3 1921 return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
cb639a42
TI
1922 substream,
1923 (__force snd_pcm_state_t)f_flags);
1da177e4
LT
1924}
1925
1926/*
1927 * drain ioctl
1928 */
1929
cb639a42
TI
1930/* drain init callbacks: state argument ignored */
1931static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
1932 snd_pcm_state_t state)
1da177e4 1933{
4f7c39dc
TI
1934 struct snd_pcm_runtime *runtime = substream->runtime;
1935 switch (runtime->status->state) {
1936 case SNDRV_PCM_STATE_OPEN:
1937 case SNDRV_PCM_STATE_DISCONNECTED:
1938 case SNDRV_PCM_STATE_SUSPENDED:
1939 return -EBADFD;
1940 }
1941 runtime->trigger_master = substream;
1da177e4
LT
1942 return 0;
1943}
1944
cb639a42
TI
1945static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
1946 snd_pcm_state_t state)
1da177e4 1947{
877211f5 1948 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1949 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1950 switch (runtime->status->state) {
1951 case SNDRV_PCM_STATE_PREPARED:
1952 /* start playback stream if possible */
1953 if (! snd_pcm_playback_empty(substream)) {
1954 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
1955 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
70372a75
TI
1956 } else {
1957 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1da177e4
LT
1958 }
1959 break;
1960 case SNDRV_PCM_STATE_RUNNING:
1961 runtime->status->state = SNDRV_PCM_STATE_DRAINING;
1962 break;
4f7c39dc
TI
1963 case SNDRV_PCM_STATE_XRUN:
1964 runtime->status->state = SNDRV_PCM_STATE_SETUP;
1965 break;
1da177e4
LT
1966 default:
1967 break;
1968 }
1969 } else {
1970 /* stop running stream */
1971 if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
cb639a42
TI
1972 snd_pcm_state_t new_state;
1973
1974 new_state = snd_pcm_capture_avail(runtime) > 0 ?
1da177e4 1975 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
b05e5787
1976 snd_pcm_do_stop(substream, new_state);
1977 snd_pcm_post_stop(substream, new_state);
1da177e4
LT
1978 }
1979 }
48d88297
LY
1980
1981 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
1982 runtime->trigger_master == substream &&
1983 (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
1984 return substream->ops->trigger(substream,
1985 SNDRV_PCM_TRIGGER_DRAIN);
1986
1da177e4
LT
1987 return 0;
1988}
1989
cb639a42
TI
1990static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
1991 snd_pcm_state_t state)
1da177e4
LT
1992{
1993}
1994
b17154cf 1995static const struct action_ops snd_pcm_action_drain_init = {
1da177e4
LT
1996 .pre_action = snd_pcm_pre_drain_init,
1997 .do_action = snd_pcm_do_drain_init,
1998 .post_action = snd_pcm_post_drain_init
1999};
2000
1da177e4
LT
2001/*
2002 * Drain the stream(s).
2003 * When the substream is linked, sync until the draining of all playback streams
2004 * is finished.
2005 * After this call, all streams are supposed to be either SETUP or DRAINING
2006 * (capture only) state.
2007 */
4cdc115f
TI
2008static int snd_pcm_drain(struct snd_pcm_substream *substream,
2009 struct file *file)
1da177e4 2010{
877211f5
TI
2011 struct snd_card *card;
2012 struct snd_pcm_runtime *runtime;
ef991b95 2013 struct snd_pcm_substream *s;
f57f3df0 2014 struct snd_pcm_group *group;
ac6424b9 2015 wait_queue_entry_t wait;
1da177e4 2016 int result = 0;
4cdc115f 2017 int nonblock = 0;
1da177e4 2018
1da177e4
LT
2019 card = substream->pcm->card;
2020 runtime = substream->runtime;
2021
2022 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2023 return -EBADFD;
2024
4cdc115f
TI
2025 if (file) {
2026 if (file->f_flags & O_NONBLOCK)
2027 nonblock = 1;
2028 } else if (substream->f_flags & O_NONBLOCK)
2029 nonblock = 1;
2030
21cb2a2e
TI
2031 snd_pcm_stream_lock_irq(substream);
2032 /* resume pause */
d3a7dcfe 2033 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
cb639a42 2034 snd_pcm_pause(substream, false);
21cb2a2e
TI
2035
2036 /* pre-start/stop - all running streams are changed to DRAINING state */
cb639a42
TI
2037 result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2038 ACTION_ARG_IGNORE);
4cdc115f
TI
2039 if (result < 0)
2040 goto unlock;
2041 /* in non-blocking, we don't wait in ioctl but let caller poll */
2042 if (nonblock) {
2043 result = -EAGAIN;
2044 goto unlock;
21cb2a2e 2045 }
1da177e4
LT
2046
2047 for (;;) {
2048 long tout;
d3a7dcfe 2049 struct snd_pcm_runtime *to_check;
1da177e4
LT
2050 if (signal_pending(current)) {
2051 result = -ERESTARTSYS;
2052 break;
2053 }
d3a7dcfe
TI
2054 /* find a substream to drain */
2055 to_check = NULL;
f57f3df0 2056 group = snd_pcm_stream_group_ref(substream);
d3a7dcfe
TI
2057 snd_pcm_group_for_each_entry(s, substream) {
2058 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2059 continue;
2060 runtime = s->runtime;
2061 if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
2062 to_check = runtime;
21cb2a2e 2063 break;
d3a7dcfe 2064 }
21cb2a2e 2065 }
f57f3df0 2066 snd_pcm_group_unref(group, substream);
d3a7dcfe
TI
2067 if (!to_check)
2068 break; /* all drained */
2069 init_waitqueue_entry(&wait, current);
37151a41 2070 set_current_state(TASK_INTERRUPTIBLE);
d3a7dcfe 2071 add_wait_queue(&to_check->sleep, &wait);
1da177e4 2072 snd_pcm_stream_unlock_irq(substream);
f2b3614c
TI
2073 if (runtime->no_period_wakeup)
2074 tout = MAX_SCHEDULE_TIMEOUT;
2075 else {
2076 tout = 10;
2077 if (runtime->rate) {
2078 long t = runtime->period_size * 2 / runtime->rate;
2079 tout = max(t, tout);
2080 }
2081 tout = msecs_to_jiffies(tout * 1000);
2082 }
37151a41 2083 tout = schedule_timeout(tout);
f57f3df0 2084
1da177e4 2085 snd_pcm_stream_lock_irq(substream);
f57f3df0
TI
2086 group = snd_pcm_stream_group_ref(substream);
2087 snd_pcm_group_for_each_entry(s, substream) {
2088 if (s->runtime == to_check) {
2089 remove_wait_queue(&to_check->sleep, &wait);
2090 break;
2091 }
2092 }
2093 snd_pcm_group_unref(group, substream);
2094
0914f796
TI
2095 if (card->shutdown) {
2096 result = -ENODEV;
2097 break;
2098 }
1da177e4
LT
2099 if (tout == 0) {
2100 if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
2101 result = -ESTRPIPE;
2102 else {
09e56df8
TI
2103 dev_dbg(substream->pcm->card->dev,
2104 "playback drain error (DMA or IRQ trouble?)\n");
1da177e4
LT
2105 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2106 result = -EIO;
2107 }
2108 break;
2109 }
1da177e4 2110 }
21cb2a2e 2111
4cdc115f 2112 unlock:
21cb2a2e 2113 snd_pcm_stream_unlock_irq(substream);
1da177e4
LT
2114
2115 return result;
2116}
2117
2118/*
2119 * drop ioctl
2120 *
2121 * Immediately put all linked substreams into SETUP state.
2122 */
877211f5 2123static int snd_pcm_drop(struct snd_pcm_substream *substream)
1da177e4 2124{
877211f5 2125 struct snd_pcm_runtime *runtime;
1da177e4
LT
2126 int result = 0;
2127
7eaa943c
TI
2128 if (PCM_RUNTIME_CHECK(substream))
2129 return -ENXIO;
1da177e4 2130 runtime = substream->runtime;
1da177e4 2131
de1b8b93 2132 if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
4b95ff78 2133 runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1da177e4
LT
2134 return -EBADFD;
2135
1da177e4
LT
2136 snd_pcm_stream_lock_irq(substream);
2137 /* resume pause */
2138 if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
cb639a42 2139 snd_pcm_pause(substream, false);
1da177e4
LT
2140
2141 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2142 /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2143 snd_pcm_stream_unlock_irq(substream);
24e8fc49 2144
1da177e4
LT
2145 return result;
2146}
2147
2148
0888c321 2149static bool is_pcm_file(struct file *file)
1da177e4 2150{
0888c321 2151 struct inode *inode = file_inode(file);
d819fb21 2152 struct snd_pcm *pcm;
f87135f5
CL
2153 unsigned int minor;
2154
0888c321
AV
2155 if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2156 return false;
1da177e4 2157 minor = iminor(inode);
d819fb21
TI
2158 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2159 if (!pcm)
2160 pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2161 if (!pcm)
2162 return false;
2163 snd_card_unref(pcm->card);
2164 return true;
1da177e4
LT
2165}
2166
2167/*
2168 * PCM link handling
2169 */
877211f5 2170static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
1da177e4
LT
2171{
2172 int res = 0;
877211f5
TI
2173 struct snd_pcm_file *pcm_file;
2174 struct snd_pcm_substream *substream1;
f57f3df0
TI
2175 struct snd_pcm_group *group, *target_group;
2176 bool nonatomic = substream->pcm->nonatomic;
0888c321 2177 struct fd f = fdget(fd);
1da177e4 2178
0888c321 2179 if (!f.file)
1da177e4 2180 return -EBADFD;
0888c321
AV
2181 if (!is_pcm_file(f.file)) {
2182 res = -EBADFD;
2183 goto _badf;
2184 }
2185 pcm_file = f.file->private_data;
1da177e4 2186 substream1 = pcm_file->substream;
951e2736
MM
2187
2188 if (substream == substream1) {
2189 res = -EINVAL;
2190 goto _badf;
2191 }
2192
73365cb1 2193 group = kzalloc(sizeof(*group), GFP_KERNEL);
1662591b
TI
2194 if (!group) {
2195 res = -ENOMEM;
2196 goto _nolock;
2197 }
73365cb1 2198 snd_pcm_group_init(group);
f57f3df0 2199
ecb41f0f 2200 down_write(&snd_pcm_link_rwsem);
1da177e4 2201 if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
257f8cce
TI
2202 substream->runtime->status->state != substream1->runtime->status->state ||
2203 substream->pcm->nonatomic != substream1->pcm->nonatomic) {
1da177e4
LT
2204 res = -EBADFD;
2205 goto _end;
2206 }
2207 if (snd_pcm_stream_linked(substream1)) {
2208 res = -EALREADY;
2209 goto _end;
2210 }
f57f3df0
TI
2211
2212 snd_pcm_stream_lock_irq(substream);
1da177e4 2213 if (!snd_pcm_stream_linked(substream)) {
a41c4cb9 2214 snd_pcm_group_assign(substream, group);
f57f3df0 2215 group = NULL; /* assigned, don't free this one below */
1da177e4 2216 }
f57f3df0
TI
2217 target_group = substream->group;
2218 snd_pcm_stream_unlock_irq(substream);
2219
2220 snd_pcm_group_lock_irq(target_group, nonatomic);
e18035cf 2221 snd_pcm_stream_lock_nested(substream1);
f57f3df0 2222 snd_pcm_group_assign(substream1, target_group);
0e279dce 2223 refcount_inc(&target_group->refs);
f57f3df0
TI
2224 snd_pcm_stream_unlock(substream1);
2225 snd_pcm_group_unlock_irq(target_group, nonatomic);
1da177e4 2226 _end:
1da177e4 2227 up_write(&snd_pcm_link_rwsem);
1662591b 2228 _nolock:
dd6c5cd8 2229 kfree(group);
0888c321
AV
2230 _badf:
2231 fdput(f);
1da177e4
LT
2232 return res;
2233}
2234
877211f5 2235static void relink_to_local(struct snd_pcm_substream *substream)
1da177e4 2236{
e18035cf 2237 snd_pcm_stream_lock_nested(substream);
a41c4cb9 2238 snd_pcm_group_assign(substream, &substream->self_group);
f57f3df0 2239 snd_pcm_stream_unlock(substream);
1da177e4
LT
2240}
2241
877211f5 2242static int snd_pcm_unlink(struct snd_pcm_substream *substream)
1da177e4 2243{
a41c4cb9 2244 struct snd_pcm_group *group;
f57f3df0
TI
2245 bool nonatomic = substream->pcm->nonatomic;
2246 bool do_free = false;
1da177e4
LT
2247 int res = 0;
2248
ecb41f0f 2249 down_write(&snd_pcm_link_rwsem);
f57f3df0 2250
1da177e4
LT
2251 if (!snd_pcm_stream_linked(substream)) {
2252 res = -EALREADY;
2253 goto _end;
2254 }
a41c4cb9
TI
2255
2256 group = substream->group;
f57f3df0 2257 snd_pcm_group_lock_irq(group, nonatomic);
a41c4cb9 2258
1da177e4 2259 relink_to_local(substream);
0e279dce 2260 refcount_dec(&group->refs);
a41c4cb9
TI
2261
2262 /* detach the last stream, too */
2263 if (list_is_singular(&group->substreams)) {
7df5a5f6
TI
2264 relink_to_local(list_first_entry(&group->substreams,
2265 struct snd_pcm_substream,
2266 link_list));
0e279dce 2267 do_free = refcount_dec_and_test(&group->refs);
1da177e4 2268 }
a41c4cb9 2269
f57f3df0
TI
2270 snd_pcm_group_unlock_irq(group, nonatomic);
2271 if (do_free)
2272 kfree(group);
2273
1da177e4 2274 _end:
1da177e4
LT
2275 up_write(&snd_pcm_link_rwsem);
2276 return res;
2277}
2278
2279/*
2280 * hw configurator
2281 */
877211f5
TI
2282static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2283 struct snd_pcm_hw_rule *rule)
1da177e4 2284{
877211f5 2285 struct snd_interval t;
1da177e4
LT
2286 snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2287 hw_param_interval_c(params, rule->deps[1]), &t);
2288 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2289}
2290
877211f5
TI
2291static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2292 struct snd_pcm_hw_rule *rule)
1da177e4 2293{
877211f5 2294 struct snd_interval t;
1da177e4
LT
2295 snd_interval_div(hw_param_interval_c(params, rule->deps[0]),
2296 hw_param_interval_c(params, rule->deps[1]), &t);
2297 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2298}
2299
877211f5
TI
2300static int snd_pcm_hw_rule_muldivk(struct snd_pcm_hw_params *params,
2301 struct snd_pcm_hw_rule *rule)
1da177e4 2302{
877211f5 2303 struct snd_interval t;
1da177e4
LT
2304 snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2305 hw_param_interval_c(params, rule->deps[1]),
2306 (unsigned long) rule->private, &t);
2307 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2308}
2309
877211f5
TI
2310static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2311 struct snd_pcm_hw_rule *rule)
1da177e4 2312{
877211f5 2313 struct snd_interval t;
1da177e4
LT
2314 snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2315 (unsigned long) rule->private,
2316 hw_param_interval_c(params, rule->deps[1]), &t);
2317 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2318}
2319
877211f5
TI
2320static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2321 struct snd_pcm_hw_rule *rule)
1da177e4 2322{
ba71d227 2323 snd_pcm_format_t k;
b55f9fdc
TS
2324 const struct snd_interval *i =
2325 hw_param_interval_c(params, rule->deps[0]);
877211f5
TI
2326 struct snd_mask m;
2327 struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
1da177e4 2328 snd_mask_any(&m);
ba71d227 2329 pcm_for_each_format(k) {
1da177e4 2330 int bits;
ba71d227 2331 if (!snd_mask_test_format(mask, k))
1da177e4
LT
2332 continue;
2333 bits = snd_pcm_format_physical_width(k);
2334 if (bits <= 0)
2335 continue; /* ignore invalid formats */
2336 if ((unsigned)bits < i->min || (unsigned)bits > i->max)
ba71d227 2337 snd_mask_reset(&m, (__force unsigned)k);
1da177e4
LT
2338 }
2339 return snd_mask_refine(mask, &m);
2340}
2341
877211f5
TI
2342static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2343 struct snd_pcm_hw_rule *rule)
1da177e4 2344{
877211f5 2345 struct snd_interval t;
ba71d227
TI
2346 snd_pcm_format_t k;
2347
1da177e4
LT
2348 t.min = UINT_MAX;
2349 t.max = 0;
2350 t.openmin = 0;
2351 t.openmax = 0;
ba71d227 2352 pcm_for_each_format(k) {
1da177e4 2353 int bits;
ba71d227 2354 if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
1da177e4
LT
2355 continue;
2356 bits = snd_pcm_format_physical_width(k);
2357 if (bits <= 0)
2358 continue; /* ignore invalid formats */
2359 if (t.min > (unsigned)bits)
2360 t.min = bits;
2361 if (t.max < (unsigned)bits)
2362 t.max = bits;
2363 }
2364 t.integer = 1;
2365 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2366}
2367
2368#if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2369#error "Change this table"
2370#endif
2371
8b674308
TS
2372static const unsigned int rates[] = {
2373 5512, 8000, 11025, 16000, 22050, 32000, 44100,
4cc4531c 2374 48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
8b674308 2375};
1da177e4 2376
7653d557
CL
2377const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2378 .count = ARRAY_SIZE(rates),
2379 .list = rates,
2380};
2381
877211f5
TI
2382static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2383 struct snd_pcm_hw_rule *rule)
1da177e4 2384{
877211f5 2385 struct snd_pcm_hardware *hw = rule->private;
1da177e4 2386 return snd_interval_list(hw_param_interval(params, rule->var),
7653d557
CL
2387 snd_pcm_known_rates.count,
2388 snd_pcm_known_rates.list, hw->rates);
1da177e4
LT
2389}
2390
877211f5
TI
2391static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2392 struct snd_pcm_hw_rule *rule)
1da177e4 2393{
877211f5
TI
2394 struct snd_interval t;
2395 struct snd_pcm_substream *substream = rule->private;
1da177e4
LT
2396 t.min = 0;
2397 t.max = substream->buffer_bytes_max;
2398 t.openmin = 0;
2399 t.openmax = 0;
2400 t.integer = 1;
2401 return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2402}
2403
d662117c 2404static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
1da177e4 2405{
877211f5
TI
2406 struct snd_pcm_runtime *runtime = substream->runtime;
2407 struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
1da177e4
LT
2408 int k, err;
2409
2410 for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2411 snd_mask_any(constrs_mask(constrs, k));
2412 }
2413
2414 for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2415 snd_interval_any(constrs_interval(constrs, k));
2416 }
2417
2418 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2419 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2420 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2421 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2422 snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2423
2424 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2425 snd_pcm_hw_rule_format, NULL,
2426 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2427 if (err < 0)
2428 return err;
2429 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2430 snd_pcm_hw_rule_sample_bits, NULL,
2431 SNDRV_PCM_HW_PARAM_FORMAT,
2432 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2433 if (err < 0)
2434 return err;
2435 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
2436 snd_pcm_hw_rule_div, NULL,
2437 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2438 if (err < 0)
2439 return err;
2440 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2441 snd_pcm_hw_rule_mul, NULL,
2442 SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2443 if (err < 0)
2444 return err;
2445 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2446 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2447 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2448 if (err < 0)
2449 return err;
2450 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS,
2451 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2452 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2453 if (err < 0)
2454 return err;
2455 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
2456 snd_pcm_hw_rule_div, NULL,
2457 SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2458 if (err < 0)
2459 return err;
2460 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2461 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2462 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2463 if (err < 0)
2464 return err;
2465 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2466 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2467 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2468 if (err < 0)
2469 return err;
2470 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS,
2471 snd_pcm_hw_rule_div, NULL,
2472 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2473 if (err < 0)
2474 return err;
2475 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2476 snd_pcm_hw_rule_div, NULL,
2477 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2478 if (err < 0)
2479 return err;
2480 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2481 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2482 SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2483 if (err < 0)
2484 return err;
2485 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE,
2486 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2487 SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2488 if (err < 0)
2489 return err;
2490 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2491 snd_pcm_hw_rule_mul, NULL,
2492 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2493 if (err < 0)
2494 return err;
2495 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2496 snd_pcm_hw_rule_mulkdiv, (void*) 8,
2497 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2498 if (err < 0)
2499 return err;
2500 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
2501 snd_pcm_hw_rule_muldivk, (void*) 1000000,
2502 SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2503 if (err < 0)
2504 return err;
2505 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2506 snd_pcm_hw_rule_muldivk, (void*) 8,
2507 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2508 if (err < 0)
2509 return err;
2510 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2511 snd_pcm_hw_rule_muldivk, (void*) 8,
2512 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2513 if (err < 0)
2514 return err;
2515 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME,
2516 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2517 SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2518 if (err < 0)
2519 return err;
2520 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME,
2521 snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2522 SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2523 if (err < 0)
2524 return err;
2525 return 0;
2526}
2527
d662117c 2528static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
1da177e4 2529{
877211f5
TI
2530 struct snd_pcm_runtime *runtime = substream->runtime;
2531 struct snd_pcm_hardware *hw = &runtime->hw;
1da177e4
LT
2532 int err;
2533 unsigned int mask = 0;
2534
2535 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
f9b0c053 2536 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
1da177e4 2537 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
f9b0c053 2538 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
63825f3a 2539 if (hw_support_mmap(substream)) {
1da177e4 2540 if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
f9b0c053 2541 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
1da177e4 2542 if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
f9b0c053 2543 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
1da177e4 2544 if (hw->info & SNDRV_PCM_INFO_COMPLEX)
f9b0c053 2545 mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
1da177e4
LT
2546 }
2547 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
7eaa943c
TI
2548 if (err < 0)
2549 return err;
1da177e4
LT
2550
2551 err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
7eaa943c
TI
2552 if (err < 0)
2553 return err;
1da177e4 2554
f9b0c053
TI
2555 err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2556 PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
7eaa943c
TI
2557 if (err < 0)
2558 return err;
1da177e4
LT
2559
2560 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2561 hw->channels_min, hw->channels_max);
7eaa943c
TI
2562 if (err < 0)
2563 return err;
1da177e4
LT
2564
2565 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2566 hw->rate_min, hw->rate_max);
8b90ca08
GL
2567 if (err < 0)
2568 return err;
1da177e4
LT
2569
2570 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2571 hw->period_bytes_min, hw->period_bytes_max);
8b90ca08
GL
2572 if (err < 0)
2573 return err;
1da177e4
LT
2574
2575 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2576 hw->periods_min, hw->periods_max);
7eaa943c
TI
2577 if (err < 0)
2578 return err;
1da177e4
LT
2579
2580 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2581 hw->period_bytes_min, hw->buffer_bytes_max);
7eaa943c
TI
2582 if (err < 0)
2583 return err;
1da177e4
LT
2584
2585 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2586 snd_pcm_hw_rule_buffer_bytes_max, substream,
2587 SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2588 if (err < 0)
2589 return err;
2590
2591 /* FIXME: remove */
2592 if (runtime->dma_bytes) {
2593 err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
7eaa943c 2594 if (err < 0)
6cf95152 2595 return err;
1da177e4
LT
2596 }
2597
2598 if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2599 err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
2600 snd_pcm_hw_rule_rate, hw,
2601 SNDRV_PCM_HW_PARAM_RATE, -1);
2602 if (err < 0)
2603 return err;
2604 }
2605
2606 /* FIXME: this belong to lowlevel */
1da177e4
LT
2607 snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2608
2609 return 0;
2610}
2611
3bf75f9b 2612static void pcm_release_private(struct snd_pcm_substream *substream)
1da177e4 2613{
b51abed8
TI
2614 if (snd_pcm_stream_linked(substream))
2615 snd_pcm_unlink(substream);
3bf75f9b
TI
2616}
2617
2618void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2619{
0df63e44
TI
2620 substream->ref_count--;
2621 if (substream->ref_count > 0)
2622 return;
2623
3bf75f9b 2624 snd_pcm_drop(substream);
3bf75f9b 2625 if (substream->hw_opened) {
0fbb027b
TI
2626 if (substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2627 do_hw_free(substream);
1da177e4 2628 substream->ops->close(substream);
3bf75f9b 2629 substream->hw_opened = 0;
1da177e4 2630 }
5371a79b
RW
2631 if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2632 cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
1576274d
TI
2633 if (substream->pcm_release) {
2634 substream->pcm_release(substream);
2635 substream->pcm_release = NULL;
2636 }
3bf75f9b
TI
2637 snd_pcm_detach_substream(substream);
2638}
e88e8ae6
TI
2639EXPORT_SYMBOL(snd_pcm_release_substream);
2640
3bf75f9b
TI
2641int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2642 struct file *file,
2643 struct snd_pcm_substream **rsubstream)
2644{
2645 struct snd_pcm_substream *substream;
2646 int err;
2647
2648 err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2649 if (err < 0)
2650 return err;
0df63e44
TI
2651 if (substream->ref_count > 1) {
2652 *rsubstream = substream;
2653 return 0;
2654 }
2655
3bf75f9b
TI
2656 err = snd_pcm_hw_constraints_init(substream);
2657 if (err < 0) {
09e56df8 2658 pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
3bf75f9b
TI
2659 goto error;
2660 }
2661
137c171c
TI
2662 err = substream->ops->open(substream);
2663 if (err < 0)
3bf75f9b
TI
2664 goto error;
2665
2666 substream->hw_opened = 1;
2667
2668 err = snd_pcm_hw_constraints_complete(substream);
2669 if (err < 0) {
09e56df8 2670 pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
3bf75f9b
TI
2671 goto error;
2672 }
2673
2674 *rsubstream = substream;
1da177e4 2675 return 0;
3bf75f9b
TI
2676
2677 error:
2678 snd_pcm_release_substream(substream);
2679 return err;
1da177e4 2680}
e88e8ae6
TI
2681EXPORT_SYMBOL(snd_pcm_open_substream);
2682
1da177e4 2683static int snd_pcm_open_file(struct file *file,
877211f5 2684 struct snd_pcm *pcm,
ffd3d5c6 2685 int stream)
1da177e4 2686{
877211f5
TI
2687 struct snd_pcm_file *pcm_file;
2688 struct snd_pcm_substream *substream;
3bf75f9b 2689 int err;
1da177e4 2690
3bf75f9b
TI
2691 err = snd_pcm_open_substream(pcm, stream, file, &substream);
2692 if (err < 0)
2693 return err;
2694
548a648b
TI
2695 pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2696 if (pcm_file == NULL) {
2697 snd_pcm_release_substream(substream);
2698 return -ENOMEM;
2699 }
2700 pcm_file->substream = substream;
de89750c 2701 if (substream->ref_count == 1)
0df63e44 2702 substream->pcm_release = pcm_release_private;
1da177e4 2703 file->private_data = pcm_file;
ffd3d5c6 2704
1da177e4
LT
2705 return 0;
2706}
2707
f87135f5
CL
2708static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2709{
2710 struct snd_pcm *pcm;
02f4865f
TI
2711 int err = nonseekable_open(inode, file);
2712 if (err < 0)
2713 return err;
f87135f5
CL
2714 pcm = snd_lookup_minor_data(iminor(inode),
2715 SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
a0830dbd 2716 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
8bb4d9ce
TI
2717 if (pcm)
2718 snd_card_unref(pcm->card);
a0830dbd 2719 return err;
f87135f5
CL
2720}
2721
2722static int snd_pcm_capture_open(struct inode *inode, struct file *file)
1da177e4 2723{
877211f5 2724 struct snd_pcm *pcm;
02f4865f
TI
2725 int err = nonseekable_open(inode, file);
2726 if (err < 0)
2727 return err;
f87135f5
CL
2728 pcm = snd_lookup_minor_data(iminor(inode),
2729 SNDRV_DEVICE_TYPE_PCM_CAPTURE);
a0830dbd 2730 err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
8bb4d9ce
TI
2731 if (pcm)
2732 snd_card_unref(pcm->card);
a0830dbd 2733 return err;
f87135f5
CL
2734}
2735
2736static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2737{
2738 int err;
ac6424b9 2739 wait_queue_entry_t wait;
1da177e4 2740
1da177e4
LT
2741 if (pcm == NULL) {
2742 err = -ENODEV;
2743 goto __error1;
2744 }
2745 err = snd_card_file_add(pcm->card, file);
2746 if (err < 0)
2747 goto __error1;
2748 if (!try_module_get(pcm->card->module)) {
2749 err = -EFAULT;
2750 goto __error2;
2751 }
2752 init_waitqueue_entry(&wait, current);
2753 add_wait_queue(&pcm->open_wait, &wait);
1a60d4c5 2754 mutex_lock(&pcm->open_mutex);
1da177e4 2755 while (1) {
ffd3d5c6 2756 err = snd_pcm_open_file(file, pcm, stream);
1da177e4
LT
2757 if (err >= 0)
2758 break;
2759 if (err == -EAGAIN) {
2760 if (file->f_flags & O_NONBLOCK) {
2761 err = -EBUSY;
2762 break;
2763 }
2764 } else
2765 break;
2766 set_current_state(TASK_INTERRUPTIBLE);
1a60d4c5 2767 mutex_unlock(&pcm->open_mutex);
1da177e4 2768 schedule();
1a60d4c5 2769 mutex_lock(&pcm->open_mutex);
0914f796
TI
2770 if (pcm->card->shutdown) {
2771 err = -ENODEV;
2772 break;
2773 }
1da177e4
LT
2774 if (signal_pending(current)) {
2775 err = -ERESTARTSYS;
2776 break;
2777 }
2778 }
2779 remove_wait_queue(&pcm->open_wait, &wait);
1a60d4c5 2780 mutex_unlock(&pcm->open_mutex);
1da177e4
LT
2781 if (err < 0)
2782 goto __error;
2783 return err;
2784
2785 __error:
2786 module_put(pcm->card->module);
2787 __error2:
2788 snd_card_file_remove(pcm->card, file);
2789 __error1:
2790 return err;
2791}
2792
2793static int snd_pcm_release(struct inode *inode, struct file *file)
2794{
877211f5
TI
2795 struct snd_pcm *pcm;
2796 struct snd_pcm_substream *substream;
2797 struct snd_pcm_file *pcm_file;
1da177e4
LT
2798
2799 pcm_file = file->private_data;
2800 substream = pcm_file->substream;
7eaa943c
TI
2801 if (snd_BUG_ON(!substream))
2802 return -ENXIO;
1da177e4 2803 pcm = substream->pcm;
534a427b
TI
2804
2805 /* block until the device gets woken up as it may touch the hardware */
2806 snd_power_wait(pcm->card);
2807
1a60d4c5 2808 mutex_lock(&pcm->open_mutex);
3bf75f9b 2809 snd_pcm_release_substream(substream);
548a648b 2810 kfree(pcm_file);
1a60d4c5 2811 mutex_unlock(&pcm->open_mutex);
1da177e4
LT
2812 wake_up(&pcm->open_wait);
2813 module_put(pcm->card->module);
2814 snd_card_file_remove(pcm->card, file);
2815 return 0;
2816}
2817
f839cc1c
TI
2818/* check and update PCM state; return 0 or a negative error
2819 * call this inside PCM lock
2820 */
2821static int do_pcm_hwsync(struct snd_pcm_substream *substream)
1da177e4 2822{
f839cc1c 2823 switch (substream->runtime->status->state) {
1da177e4 2824 case SNDRV_PCM_STATE_DRAINING:
f839cc1c
TI
2825 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2826 return -EBADFD;
c0dbbdad 2827 fallthrough;
f839cc1c
TI
2828 case SNDRV_PCM_STATE_RUNNING:
2829 return snd_pcm_update_hw_ptr(substream);
2830 case SNDRV_PCM_STATE_PREPARED:
2831 case SNDRV_PCM_STATE_PAUSED:
2832 return 0;
51840409 2833 case SNDRV_PCM_STATE_SUSPENDED:
f839cc1c
TI
2834 return -ESTRPIPE;
2835 case SNDRV_PCM_STATE_XRUN:
2836 return -EPIPE;
1da177e4 2837 default:
f839cc1c 2838 return -EBADFD;
1da177e4 2839 }
f839cc1c 2840}
1da177e4 2841
9027c463 2842/* increase the appl_ptr; returns the processed frames or a negative error */
e0327a0f
TI
2843static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2844 snd_pcm_uframes_t frames,
2845 snd_pcm_sframes_t avail)
2846{
2847 struct snd_pcm_runtime *runtime = substream->runtime;
2848 snd_pcm_sframes_t appl_ptr;
9027c463 2849 int ret;
e0327a0f
TI
2850
2851 if (avail <= 0)
2852 return 0;
2853 if (frames > (snd_pcm_uframes_t)avail)
2854 frames = avail;
2855 appl_ptr = runtime->control->appl_ptr + frames;
2856 if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2857 appl_ptr -= runtime->boundary;
66e01a5c 2858 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
9027c463 2859 return ret < 0 ? ret : frames;
e0327a0f
TI
2860}
2861
fb51f1cd 2862/* decrease the appl_ptr; returns the processed frames or zero for error */
e0327a0f
TI
2863static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2864 snd_pcm_uframes_t frames,
2865 snd_pcm_sframes_t avail)
2866{
2867 struct snd_pcm_runtime *runtime = substream->runtime;
2868 snd_pcm_sframes_t appl_ptr;
9027c463 2869 int ret;
e0327a0f
TI
2870
2871 if (avail <= 0)
2872 return 0;
2873 if (frames > (snd_pcm_uframes_t)avail)
2874 frames = avail;
1da177e4
LT
2875 appl_ptr = runtime->control->appl_ptr - frames;
2876 if (appl_ptr < 0)
2877 appl_ptr += runtime->boundary;
66e01a5c 2878 ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
fb51f1cd
TI
2879 /* NOTE: we return zero for errors because PulseAudio gets depressed
2880 * upon receiving an error from rewind ioctl and stops processing
2881 * any longer. Returning zero means that no rewind is done, so
2882 * it's not absolutely wrong to answer like that.
2883 */
2884 return ret < 0 ? 0 : frames;
e0327a0f
TI
2885}
2886
763e5067
TI
2887static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2888 snd_pcm_uframes_t frames)
1da177e4 2889{
1da177e4 2890 snd_pcm_sframes_t ret;
1da177e4
LT
2891
2892 if (frames == 0)
2893 return 0;
2894
2895 snd_pcm_stream_lock_irq(substream);
f839cc1c 2896 ret = do_pcm_hwsync(substream);
e0327a0f
TI
2897 if (!ret)
2898 ret = rewind_appl_ptr(substream, frames,
763e5067 2899 snd_pcm_hw_avail(substream));
1da177e4
LT
2900 snd_pcm_stream_unlock_irq(substream);
2901 return ret;
2902}
2903
763e5067
TI
2904static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2905 snd_pcm_uframes_t frames)
1da177e4 2906{
1da177e4 2907 snd_pcm_sframes_t ret;
1da177e4
LT
2908
2909 if (frames == 0)
2910 return 0;
2911
2912 snd_pcm_stream_lock_irq(substream);
f839cc1c 2913 ret = do_pcm_hwsync(substream);
e0327a0f
TI
2914 if (!ret)
2915 ret = forward_appl_ptr(substream, frames,
763e5067 2916 snd_pcm_avail(substream));
1da177e4
LT
2917 snd_pcm_stream_unlock_irq(substream);
2918 return ret;
2919}
2920
877211f5 2921static int snd_pcm_hwsync(struct snd_pcm_substream *substream)
1da177e4 2922{
1da177e4
LT
2923 int err;
2924
2925 snd_pcm_stream_lock_irq(substream);
f839cc1c 2926 err = do_pcm_hwsync(substream);
1da177e4
LT
2927 snd_pcm_stream_unlock_irq(substream);
2928 return err;
2929}
2930
912e4c33
JM
2931static int snd_pcm_delay(struct snd_pcm_substream *substream,
2932 snd_pcm_sframes_t *delay)
1da177e4 2933{
1da177e4
LT
2934 int err;
2935 snd_pcm_sframes_t n = 0;
2936
2937 snd_pcm_stream_lock_irq(substream);
f839cc1c 2938 err = do_pcm_hwsync(substream);
c99c5a3b
TI
2939 if (!err)
2940 n = snd_pcm_calc_delay(substream);
1da177e4 2941 snd_pcm_stream_unlock_irq(substream);
912e4c33
JM
2942 if (!err)
2943 *delay = n;
2944 return err;
1da177e4
LT
2945}
2946
877211f5
TI
2947static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
2948 struct snd_pcm_sync_ptr __user *_sync_ptr)
1da177e4 2949{
877211f5
TI
2950 struct snd_pcm_runtime *runtime = substream->runtime;
2951 struct snd_pcm_sync_ptr sync_ptr;
2952 volatile struct snd_pcm_mmap_status *status;
2953 volatile struct snd_pcm_mmap_control *control;
1da177e4
LT
2954 int err;
2955
2956 memset(&sync_ptr, 0, sizeof(sync_ptr));
2957 if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
2958 return -EFAULT;
877211f5 2959 if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
1da177e4
LT
2960 return -EFAULT;
2961 status = runtime->status;
2962 control = runtime->control;
2963 if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
2964 err = snd_pcm_hwsync(substream);
2965 if (err < 0)
2966 return err;
2967 }
2968 snd_pcm_stream_lock_irq(substream);
9027c463 2969 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
66e01a5c
TS
2970 err = pcm_lib_apply_appl_ptr(substream,
2971 sync_ptr.c.control.appl_ptr);
9027c463
TI
2972 if (err < 0) {
2973 snd_pcm_stream_unlock_irq(substream);
2974 return err;
2975 }
2976 } else {
1da177e4 2977 sync_ptr.c.control.appl_ptr = control->appl_ptr;
9027c463 2978 }
1da177e4
LT
2979 if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
2980 control->avail_min = sync_ptr.c.control.avail_min;
2981 else
2982 sync_ptr.c.control.avail_min = control->avail_min;
2983 sync_ptr.s.status.state = status->state;
2984 sync_ptr.s.status.hw_ptr = status->hw_ptr;
2985 sync_ptr.s.status.tstamp = status->tstamp;
2986 sync_ptr.s.status.suspended_state = status->suspended_state;
f853dcaa 2987 sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
1da177e4
LT
2988 snd_pcm_stream_unlock_irq(substream);
2989 if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
2990 return -EFAULT;
2991 return 0;
2992}
b751eef1 2993
09d94175 2994struct snd_pcm_mmap_status32 {
cb639a42 2995 snd_pcm_state_t state;
09d94175
AB
2996 s32 pad1;
2997 u32 hw_ptr;
80fe7430
AB
2998 s32 tstamp_sec;
2999 s32 tstamp_nsec;
cb639a42 3000 snd_pcm_state_t suspended_state;
80fe7430
AB
3001 s32 audio_tstamp_sec;
3002 s32 audio_tstamp_nsec;
09d94175
AB
3003} __attribute__((packed));
3004
3005struct snd_pcm_mmap_control32 {
3006 u32 appl_ptr;
3007 u32 avail_min;
3008};
3009
3010struct snd_pcm_sync_ptr32 {
3011 u32 flags;
3012 union {
3013 struct snd_pcm_mmap_status32 status;
3014 unsigned char reserved[64];
3015 } s;
3016 union {
3017 struct snd_pcm_mmap_control32 control;
3018 unsigned char reserved[64];
3019 } c;
3020} __attribute__((packed));
3021
3022/* recalcuate the boundary within 32bit */
3023static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3024{
3025 snd_pcm_uframes_t boundary;
3026
3027 if (! runtime->buffer_size)
3028 return 0;
3029 boundary = runtime->buffer_size;
3030 while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3031 boundary *= 2;
3032 return boundary;
3033}
3034
3035static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3036 struct snd_pcm_sync_ptr32 __user *src)
3037{
3038 struct snd_pcm_runtime *runtime = substream->runtime;
3039 volatile struct snd_pcm_mmap_status *status;
3040 volatile struct snd_pcm_mmap_control *control;
3041 u32 sflags;
3042 struct snd_pcm_mmap_control scontrol;
3043 struct snd_pcm_mmap_status sstatus;
3044 snd_pcm_uframes_t boundary;
3045 int err;
3046
3047 if (snd_BUG_ON(!runtime))
3048 return -EINVAL;
3049
3050 if (get_user(sflags, &src->flags) ||
3051 get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3052 get_user(scontrol.avail_min, &src->c.control.avail_min))
3053 return -EFAULT;
3054 if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3055 err = snd_pcm_hwsync(substream);
3056 if (err < 0)
3057 return err;
3058 }
3059 status = runtime->status;
3060 control = runtime->control;
3061 boundary = recalculate_boundary(runtime);
3062 if (! boundary)
3063 boundary = 0x7fffffff;
3064 snd_pcm_stream_lock_irq(substream);
3065 /* FIXME: we should consider the boundary for the sync from app */
3066 if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3067 control->appl_ptr = scontrol.appl_ptr;
3068 else
3069 scontrol.appl_ptr = control->appl_ptr % boundary;
3070 if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3071 control->avail_min = scontrol.avail_min;
3072 else
3073 scontrol.avail_min = control->avail_min;
3074 sstatus.state = status->state;
3075 sstatus.hw_ptr = status->hw_ptr % boundary;
3076 sstatus.tstamp = status->tstamp;
3077 sstatus.suspended_state = status->suspended_state;
3078 sstatus.audio_tstamp = status->audio_tstamp;
3079 snd_pcm_stream_unlock_irq(substream);
3080 if (put_user(sstatus.state, &src->s.status.state) ||
3081 put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
80fe7430
AB
3082 put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3083 put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
09d94175 3084 put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
80fe7430
AB
3085 put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3086 put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
09d94175
AB
3087 put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3088 put_user(scontrol.avail_min, &src->c.control.avail_min))
3089 return -EFAULT;
3090
3091 return 0;
3092}
80fe7430 3093#define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
09d94175 3094
b751eef1
JK
3095static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3096{
3097 struct snd_pcm_runtime *runtime = substream->runtime;
3098 int arg;
3099
3100 if (get_user(arg, _arg))
3101 return -EFAULT;
3102 if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3103 return -EINVAL;
2408c219 3104 runtime->tstamp_type = arg;
b751eef1
JK
3105 return 0;
3106}
67616fed
TI
3107
3108static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3109 struct snd_xferi __user *_xferi)
3110{
3111 struct snd_xferi xferi;
3112 struct snd_pcm_runtime *runtime = substream->runtime;
3113 snd_pcm_sframes_t result;
3114
3115 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3116 return -EBADFD;
3117 if (put_user(0, &_xferi->result))
3118 return -EFAULT;
3119 if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3120 return -EFAULT;
3121 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3122 result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3123 else
3124 result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
ebe6976d
AV
3125 if (put_user(result, &_xferi->result))
3126 return -EFAULT;
67616fed
TI
3127 return result < 0 ? result : 0;
3128}
3129
3130static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3131 struct snd_xfern __user *_xfern)
3132{
3133 struct snd_xfern xfern;
3134 struct snd_pcm_runtime *runtime = substream->runtime;
3135 void *bufs;
3136 snd_pcm_sframes_t result;
3137
3138 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3139 return -EBADFD;
3140 if (runtime->channels > 128)
3141 return -EINVAL;
3142 if (put_user(0, &_xfern->result))
3143 return -EFAULT;
3144 if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3145 return -EFAULT;
3146
3147 bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3148 if (IS_ERR(bufs))
3149 return PTR_ERR(bufs);
3150 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3151 result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3152 else
3153 result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3154 kfree(bufs);
ebe6976d
AV
3155 if (put_user(result, &_xfern->result))
3156 return -EFAULT;
67616fed
TI
3157 return result < 0 ? result : 0;
3158}
3159
3160static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3161 snd_pcm_uframes_t __user *_frames)
3162{
3163 snd_pcm_uframes_t frames;
3164 snd_pcm_sframes_t result;
3165
3166 if (get_user(frames, _frames))
3167 return -EFAULT;
3168 if (put_user(0, _frames))
3169 return -EFAULT;
763e5067 3170 result = snd_pcm_rewind(substream, frames);
ebe6976d
AV
3171 if (put_user(result, _frames))
3172 return -EFAULT;
67616fed
TI
3173 return result < 0 ? result : 0;
3174}
3175
3176static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3177 snd_pcm_uframes_t __user *_frames)
3178{
3179 snd_pcm_uframes_t frames;
3180 snd_pcm_sframes_t result;
3181
3182 if (get_user(frames, _frames))
3183 return -EFAULT;
3184 if (put_user(0, _frames))
3185 return -EFAULT;
763e5067 3186 result = snd_pcm_forward(substream, frames);
ebe6976d
AV
3187 if (put_user(result, _frames))
3188 return -EFAULT;
67616fed
TI
3189 return result < 0 ? result : 0;
3190}
3191
3192static int snd_pcm_common_ioctl(struct file *file,
0df63e44 3193 struct snd_pcm_substream *substream,
1da177e4
LT
3194 unsigned int cmd, void __user *arg)
3195{
4b671f57 3196 struct snd_pcm_file *pcm_file = file->private_data;
7d8e8292
TI
3197 int res;
3198
67616fed
TI
3199 if (PCM_RUNTIME_CHECK(substream))
3200 return -ENXIO;
3201
b6cc78da 3202 res = snd_power_wait(substream->pcm->card);
7d8e8292
TI
3203 if (res < 0)
3204 return res;
4b671f57 3205
1da177e4
LT
3206 switch (cmd) {
3207 case SNDRV_PCM_IOCTL_PVERSION:
3208 return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3209 case SNDRV_PCM_IOCTL_INFO:
3210 return snd_pcm_info_user(substream, arg);
28e9e473
JK
3211 case SNDRV_PCM_IOCTL_TSTAMP: /* just for compatibility */
3212 return 0;
b751eef1
JK
3213 case SNDRV_PCM_IOCTL_TTSTAMP:
3214 return snd_pcm_tstamp(substream, arg);
4b671f57
TI
3215 case SNDRV_PCM_IOCTL_USER_PVERSION:
3216 if (get_user(pcm_file->user_pversion,
3217 (unsigned int __user *)arg))
3218 return -EFAULT;
3219 return 0;
1da177e4
LT
3220 case SNDRV_PCM_IOCTL_HW_REFINE:
3221 return snd_pcm_hw_refine_user(substream, arg);
3222 case SNDRV_PCM_IOCTL_HW_PARAMS:
3223 return snd_pcm_hw_params_user(substream, arg);
3224 case SNDRV_PCM_IOCTL_HW_FREE:
3225 return snd_pcm_hw_free(substream);
3226 case SNDRV_PCM_IOCTL_SW_PARAMS:
3227 return snd_pcm_sw_params_user(substream, arg);
3ddee7f8
BW
3228 case SNDRV_PCM_IOCTL_STATUS32:
3229 return snd_pcm_status_user32(substream, arg, false);
3230 case SNDRV_PCM_IOCTL_STATUS_EXT32:
3231 return snd_pcm_status_user32(substream, arg, true);
3232 case SNDRV_PCM_IOCTL_STATUS64:
3233 return snd_pcm_status_user64(substream, arg, false);
3234 case SNDRV_PCM_IOCTL_STATUS_EXT64:
3235 return snd_pcm_status_user64(substream, arg, true);
1da177e4
LT
3236 case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3237 return snd_pcm_channel_info_user(substream, arg);
3238 case SNDRV_PCM_IOCTL_PREPARE:
0df63e44 3239 return snd_pcm_prepare(substream, file);
1da177e4
LT
3240 case SNDRV_PCM_IOCTL_RESET:
3241 return snd_pcm_reset(substream);
3242 case SNDRV_PCM_IOCTL_START:
c2c86a97 3243 return snd_pcm_start_lock_irq(substream);
1da177e4
LT
3244 case SNDRV_PCM_IOCTL_LINK:
3245 return snd_pcm_link(substream, (int)(unsigned long) arg);
3246 case SNDRV_PCM_IOCTL_UNLINK:
3247 return snd_pcm_unlink(substream);
3248 case SNDRV_PCM_IOCTL_RESUME:
3249 return snd_pcm_resume(substream);
3250 case SNDRV_PCM_IOCTL_XRUN:
3251 return snd_pcm_xrun(substream);
3252 case SNDRV_PCM_IOCTL_HWSYNC:
3253 return snd_pcm_hwsync(substream);
3254 case SNDRV_PCM_IOCTL_DELAY:
c2c86a97 3255 {
912e4c33 3256 snd_pcm_sframes_t delay;
c2c86a97 3257 snd_pcm_sframes_t __user *res = arg;
912e4c33 3258 int err;
c2c86a97 3259
912e4c33
JM
3260 err = snd_pcm_delay(substream, &delay);
3261 if (err)
3262 return err;
c2c86a97
TI
3263 if (put_user(delay, res))
3264 return -EFAULT;
3265 return 0;
3266 }
80fe7430
AB
3267 case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3268 return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3269 case __SNDRV_PCM_IOCTL_SYNC_PTR64:
1da177e4 3270 return snd_pcm_sync_ptr(substream, arg);
59d48582 3271#ifdef CONFIG_SND_SUPPORT_OLD_API
1da177e4
LT
3272 case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3273 return snd_pcm_hw_refine_old_user(substream, arg);
3274 case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3275 return snd_pcm_hw_params_old_user(substream, arg);
59d48582 3276#endif
1da177e4 3277 case SNDRV_PCM_IOCTL_DRAIN:
4cdc115f 3278 return snd_pcm_drain(substream, file);
1da177e4
LT
3279 case SNDRV_PCM_IOCTL_DROP:
3280 return snd_pcm_drop(substream);
e661d0dd 3281 case SNDRV_PCM_IOCTL_PAUSE:
cb639a42 3282 return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
1da177e4 3283 case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
1da177e4 3284 case SNDRV_PCM_IOCTL_READI_FRAMES:
67616fed
TI
3285 return snd_pcm_xferi_frames_ioctl(substream, arg);
3286 case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
1da177e4 3287 case SNDRV_PCM_IOCTL_READN_FRAMES:
67616fed 3288 return snd_pcm_xfern_frames_ioctl(substream, arg);
1da177e4 3289 case SNDRV_PCM_IOCTL_REWIND:
67616fed 3290 return snd_pcm_rewind_ioctl(substream, arg);
1da177e4 3291 case SNDRV_PCM_IOCTL_FORWARD:
67616fed 3292 return snd_pcm_forward_ioctl(substream, arg);
1da177e4 3293 }
67616fed
TI
3294 pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3295 return -ENOTTY;
1da177e4
LT
3296}
3297
67616fed
TI
3298static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3299 unsigned long arg)
1da177e4 3300{
877211f5 3301 struct snd_pcm_file *pcm_file;
1da177e4
LT
3302
3303 pcm_file = file->private_data;
3304
3305 if (((cmd >> 8) & 0xff) != 'A')
3306 return -ENOTTY;
3307
67616fed
TI
3308 return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3309 (void __user *)arg);
1da177e4
LT
3310}
3311
c2c86a97
TI
3312/**
3313 * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3314 * @substream: PCM substream
3315 * @cmd: IOCTL cmd
3316 * @arg: IOCTL argument
3317 *
3318 * The function is provided primarily for OSS layer and USB gadget drivers,
3319 * and it allows only the limited set of ioctls (hw_params, sw_params,
3320 * prepare, start, drain, drop, forward).
3321 */
bf1bbb5a
TI
3322int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3323 unsigned int cmd, void *arg)
1da177e4 3324{
c2c86a97
TI
3325 snd_pcm_uframes_t *frames = arg;
3326 snd_pcm_sframes_t result;
1da177e4 3327
c2c86a97
TI
3328 switch (cmd) {
3329 case SNDRV_PCM_IOCTL_FORWARD:
3330 {
3331 /* provided only for OSS; capture-only and no value returned */
3332 if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3333 return -EINVAL;
763e5067 3334 result = snd_pcm_forward(substream, *frames);
c2c86a97
TI
3335 return result < 0 ? result : 0;
3336 }
3337 case SNDRV_PCM_IOCTL_HW_PARAMS:
3338 return snd_pcm_hw_params(substream, arg);
3339 case SNDRV_PCM_IOCTL_SW_PARAMS:
3340 return snd_pcm_sw_params(substream, arg);
3341 case SNDRV_PCM_IOCTL_PREPARE:
3342 return snd_pcm_prepare(substream, NULL);
3343 case SNDRV_PCM_IOCTL_START:
3344 return snd_pcm_start_lock_irq(substream);
3345 case SNDRV_PCM_IOCTL_DRAIN:
7d8e8292 3346 return snd_pcm_drain(substream, NULL);
c2c86a97
TI
3347 case SNDRV_PCM_IOCTL_DROP:
3348 return snd_pcm_drop(substream);
3349 case SNDRV_PCM_IOCTL_DELAY:
912e4c33 3350 return snd_pcm_delay(substream, frames);
1da177e4 3351 default:
c2c86a97 3352 return -EINVAL;
1da177e4
LT
3353 }
3354}
e88e8ae6
TI
3355EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3356
877211f5
TI
3357static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3358 loff_t * offset)
1da177e4 3359{
877211f5
TI
3360 struct snd_pcm_file *pcm_file;
3361 struct snd_pcm_substream *substream;
3362 struct snd_pcm_runtime *runtime;
1da177e4
LT
3363 snd_pcm_sframes_t result;
3364
3365 pcm_file = file->private_data;
3366 substream = pcm_file->substream;
7eaa943c
TI
3367 if (PCM_RUNTIME_CHECK(substream))
3368 return -ENXIO;
1da177e4
LT
3369 runtime = substream->runtime;
3370 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3371 return -EBADFD;
3372 if (!frame_aligned(runtime, count))
3373 return -EINVAL;
3374 count = bytes_to_frames(runtime, count);
3375 result = snd_pcm_lib_read(substream, buf, count);
3376 if (result > 0)
3377 result = frames_to_bytes(runtime, result);
3378 return result;
3379}
3380
877211f5
TI
3381static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3382 size_t count, loff_t * offset)
1da177e4 3383{
877211f5
TI
3384 struct snd_pcm_file *pcm_file;
3385 struct snd_pcm_substream *substream;
3386 struct snd_pcm_runtime *runtime;
1da177e4
LT
3387 snd_pcm_sframes_t result;
3388
3389 pcm_file = file->private_data;
3390 substream = pcm_file->substream;
7eaa943c
TI
3391 if (PCM_RUNTIME_CHECK(substream))
3392 return -ENXIO;
1da177e4 3393 runtime = substream->runtime;
7eaa943c
TI
3394 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3395 return -EBADFD;
3396 if (!frame_aligned(runtime, count))
3397 return -EINVAL;
1da177e4
LT
3398 count = bytes_to_frames(runtime, count);
3399 result = snd_pcm_lib_write(substream, buf, count);
3400 if (result > 0)
3401 result = frames_to_bytes(runtime, result);
1da177e4
LT
3402 return result;
3403}
3404
1c65d986 3405static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
1da177e4 3406{
877211f5
TI
3407 struct snd_pcm_file *pcm_file;
3408 struct snd_pcm_substream *substream;
3409 struct snd_pcm_runtime *runtime;
1da177e4
LT
3410 snd_pcm_sframes_t result;
3411 unsigned long i;
3412 void __user **bufs;
3413 snd_pcm_uframes_t frames;
3414
ee0b3e67 3415 pcm_file = iocb->ki_filp->private_data;
1da177e4 3416 substream = pcm_file->substream;
7eaa943c
TI
3417 if (PCM_RUNTIME_CHECK(substream))
3418 return -ENXIO;
1da177e4
LT
3419 runtime = substream->runtime;
3420 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3421 return -EBADFD;
1c65d986
AV
3422 if (!iter_is_iovec(to))
3423 return -EINVAL;
3424 if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
1da177e4 3425 return -EINVAL;
1c65d986 3426 if (!frame_aligned(runtime, to->iov->iov_len))
1da177e4 3427 return -EINVAL;
1c65d986 3428 frames = bytes_to_samples(runtime, to->iov->iov_len);
6da2ec56 3429 bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
1da177e4
LT
3430 if (bufs == NULL)
3431 return -ENOMEM;
1c65d986
AV
3432 for (i = 0; i < to->nr_segs; ++i)
3433 bufs[i] = to->iov[i].iov_base;
1da177e4
LT
3434 result = snd_pcm_lib_readv(substream, bufs, frames);
3435 if (result > 0)
3436 result = frames_to_bytes(runtime, result);
3437 kfree(bufs);
3438 return result;
3439}
3440
1c65d986 3441static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
1da177e4 3442{
877211f5
TI
3443 struct snd_pcm_file *pcm_file;
3444 struct snd_pcm_substream *substream;
3445 struct snd_pcm_runtime *runtime;
1da177e4
LT
3446 snd_pcm_sframes_t result;
3447 unsigned long i;
3448 void __user **bufs;
3449 snd_pcm_uframes_t frames;
3450
ee0b3e67 3451 pcm_file = iocb->ki_filp->private_data;
1da177e4 3452 substream = pcm_file->substream;
7eaa943c
TI
3453 if (PCM_RUNTIME_CHECK(substream))
3454 return -ENXIO;
1da177e4 3455 runtime = substream->runtime;
7eaa943c
TI
3456 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3457 return -EBADFD;
1c65d986
AV
3458 if (!iter_is_iovec(from))
3459 return -EINVAL;
3460 if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3461 !frame_aligned(runtime, from->iov->iov_len))
7eaa943c 3462 return -EINVAL;
1c65d986 3463 frames = bytes_to_samples(runtime, from->iov->iov_len);
6da2ec56 3464 bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
1da177e4
LT
3465 if (bufs == NULL)
3466 return -ENOMEM;
1c65d986
AV
3467 for (i = 0; i < from->nr_segs; ++i)
3468 bufs[i] = from->iov[i].iov_base;
1da177e4
LT
3469 result = snd_pcm_lib_writev(substream, bufs, frames);
3470 if (result > 0)
3471 result = frames_to_bytes(runtime, result);
3472 kfree(bufs);
1da177e4
LT
3473 return result;
3474}
3475
6448fcba 3476static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
1da177e4 3477{
877211f5
TI
3478 struct snd_pcm_file *pcm_file;
3479 struct snd_pcm_substream *substream;
3480 struct snd_pcm_runtime *runtime;
6448fcba 3481 __poll_t mask, ok;
1da177e4
LT
3482 snd_pcm_uframes_t avail;
3483
3484 pcm_file = file->private_data;
3485
3486 substream = pcm_file->substream;
6448fcba
TI
3487 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3488 ok = EPOLLOUT | EPOLLWRNORM;
3489 else
3490 ok = EPOLLIN | EPOLLRDNORM;
7eaa943c 3491 if (PCM_RUNTIME_CHECK(substream))
6448fcba 3492 return ok | EPOLLERR;
1da177e4 3493
1da177e4 3494 runtime = substream->runtime;
1da177e4
LT
3495 poll_wait(file, &runtime->sleep, wait);
3496
6448fcba 3497 mask = 0;
1da177e4 3498 snd_pcm_stream_lock_irq(substream);
6448fcba 3499 avail = snd_pcm_avail(substream);
1da177e4
LT
3500 switch (runtime->status->state) {
3501 case SNDRV_PCM_STATE_RUNNING:
3502 case SNDRV_PCM_STATE_PREPARED:
3503 case SNDRV_PCM_STATE_PAUSED:
6448fcba
TI
3504 if (avail >= runtime->control->avail_min)
3505 mask = ok;
1da177e4
LT
3506 break;
3507 case SNDRV_PCM_STATE_DRAINING:
6448fcba
TI
3508 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3509 mask = ok;
3510 if (!avail)
3511 mask |= EPOLLERR;
1da177e4 3512 }
6448fcba 3513 break;
1da177e4 3514 default:
6448fcba 3515 mask = ok | EPOLLERR;
1da177e4
LT
3516 break;
3517 }
3518 snd_pcm_stream_unlock_irq(substream);
3519 return mask;
3520}
3521
3522/*
3523 * mmap support
3524 */
3525
3526/*
3527 * Only on coherent architectures, we can mmap the status and the control records
3528 * for effcient data transfer. On others, we have to use HWSYNC ioctl...
3529 */
3530#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3531/*
3532 * mmap status record
3533 */
41412fe9 3534static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
1da177e4 3535{
11bac800 3536 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
877211f5 3537 struct snd_pcm_runtime *runtime;
1da177e4
LT
3538
3539 if (substream == NULL)
3ad5afcd 3540 return VM_FAULT_SIGBUS;
1da177e4 3541 runtime = substream->runtime;
3ad5afcd
NP
3542 vmf->page = virt_to_page(runtime->status);
3543 get_page(vmf->page);
3544 return 0;
1da177e4
LT
3545}
3546
f0f37e2f 3547static const struct vm_operations_struct snd_pcm_vm_ops_status =
1da177e4 3548{
3ad5afcd 3549 .fault = snd_pcm_mmap_status_fault,
1da177e4
LT
3550};
3551
877211f5 3552static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
1da177e4
LT
3553 struct vm_area_struct *area)
3554{
1da177e4
LT
3555 long size;
3556 if (!(area->vm_flags & VM_READ))
3557 return -EINVAL;
1da177e4 3558 size = area->vm_end - area->vm_start;
877211f5 3559 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
1da177e4
LT
3560 return -EINVAL;
3561 area->vm_ops = &snd_pcm_vm_ops_status;
3562 area->vm_private_data = substream;
314e51b9 3563 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
1da177e4
LT
3564 return 0;
3565}
3566
3567/*
3568 * mmap control record
3569 */
41412fe9 3570static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
1da177e4 3571{
11bac800 3572 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
877211f5 3573 struct snd_pcm_runtime *runtime;
1da177e4
LT
3574
3575 if (substream == NULL)
3ad5afcd 3576 return VM_FAULT_SIGBUS;
1da177e4 3577 runtime = substream->runtime;
3ad5afcd
NP
3578 vmf->page = virt_to_page(runtime->control);
3579 get_page(vmf->page);
3580 return 0;
1da177e4
LT
3581}
3582
f0f37e2f 3583static const struct vm_operations_struct snd_pcm_vm_ops_control =
1da177e4 3584{
3ad5afcd 3585 .fault = snd_pcm_mmap_control_fault,
1da177e4
LT
3586};
3587
877211f5 3588static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
1da177e4
LT
3589 struct vm_area_struct *area)
3590{
1da177e4
LT
3591 long size;
3592 if (!(area->vm_flags & VM_READ))
3593 return -EINVAL;
1da177e4 3594 size = area->vm_end - area->vm_start;
877211f5 3595 if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
1da177e4
LT
3596 return -EINVAL;
3597 area->vm_ops = &snd_pcm_vm_ops_control;
3598 area->vm_private_data = substream;
314e51b9 3599 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
1da177e4
LT
3600 return 0;
3601}
42f94597
TI
3602
3603static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3604{
b602aa8e
TI
3605 /* See pcm_control_mmap_allowed() below.
3606 * Since older alsa-lib requires both status and control mmaps to be
3607 * coupled, we have to disable the status mmap for old alsa-lib, too.
3608 */
3609 if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3610 (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3611 return false;
3612 return true;
3613}
3614
3615static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3616{
3617 if (pcm_file->no_compat_mmap)
3618 return false;
3619 /* Disallow the control mmap when SYNC_APPLPTR flag is set;
42f94597
TI
3620 * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3621 * thus it effectively assures the manual update of appl_ptr.
42f94597
TI
3622 */
3623 if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3624 return false;
3625 return true;
3626}
3627
1da177e4
LT
3628#else /* ! coherent mmap */
3629/*
3630 * don't support mmap for status and control records.
3631 */
42f94597 3632#define pcm_status_mmap_allowed(pcm_file) false
b602aa8e 3633#define pcm_control_mmap_allowed(pcm_file) false
42f94597 3634
877211f5 3635static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
1da177e4
LT
3636 struct vm_area_struct *area)
3637{
3638 return -ENXIO;
3639}
877211f5 3640static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
1da177e4
LT
3641 struct vm_area_struct *area)
3642{
3643 return -ENXIO;
3644}
3645#endif /* coherent mmap */
3646
3647/*
3ad5afcd 3648 * fault callback for mmapping a RAM page
1da177e4 3649 */
41412fe9 3650static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
1da177e4 3651{
11bac800 3652 struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
877211f5 3653 struct snd_pcm_runtime *runtime;
1da177e4
LT
3654 unsigned long offset;
3655 struct page * page;
1da177e4
LT
3656 size_t dma_bytes;
3657
3658 if (substream == NULL)
3ad5afcd 3659 return VM_FAULT_SIGBUS;
1da177e4 3660 runtime = substream->runtime;
3ad5afcd 3661 offset = vmf->pgoff << PAGE_SHIFT;
1da177e4
LT
3662 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3663 if (offset > dma_bytes - PAGE_SIZE)
3ad5afcd 3664 return VM_FAULT_SIGBUS;
9eb4a067 3665 if (substream->ops->page)
1da177e4 3666 page = substream->ops->page(substream, offset);
9eb4a067 3667 else
37af81c5 3668 page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
9eb4a067
TI
3669 if (!page)
3670 return VM_FAULT_SIGBUS;
b5810039 3671 get_page(page);
3ad5afcd
NP
3672 vmf->page = page;
3673 return 0;
1da177e4
LT
3674}
3675
657b1989
TI
3676static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3677 .open = snd_pcm_mmap_data_open,
3678 .close = snd_pcm_mmap_data_close,
3679};
3680
3681static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
1da177e4
LT
3682 .open = snd_pcm_mmap_data_open,
3683 .close = snd_pcm_mmap_data_close,
3ad5afcd 3684 .fault = snd_pcm_mmap_data_fault,
1da177e4
LT
3685};
3686
3687/*
3688 * mmap the DMA buffer on RAM
3689 */
30b771cf
TI
3690
3691/**
3692 * snd_pcm_lib_default_mmap - Default PCM data mmap function
3693 * @substream: PCM substream
3694 * @area: VMA
3695 *
3696 * This is the default mmap handler for PCM data. When mmap pcm_ops is NULL,
3697 * this function is invoked implicitly.
3698 */
18a2b962
TI
3699int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3700 struct vm_area_struct *area)
1da177e4 3701{
314e51b9 3702 area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
a5606f85 3703#ifdef CONFIG_GENERIC_ALLOCATOR
05503214
NC
3704 if (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_IRAM) {
3705 area->vm_page_prot = pgprot_writecombine(area->vm_page_prot);
3706 return remap_pfn_range(area, area->vm_start,
3707 substream->dma_buffer.addr >> PAGE_SHIFT,
3708 area->vm_end - area->vm_start, area->vm_page_prot);
3709 }
a5606f85 3710#endif /* CONFIG_GENERIC_ALLOCATOR */
abe594c2 3711 if (IS_ENABLED(CONFIG_HAS_DMA) && !substream->ops->page &&
2406ff9b
TI
3712 (substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV ||
3713 substream->dma_buffer.dev.type == SNDRV_DMA_TYPE_DEV_UC))
657b1989
TI
3714 return dma_mmap_coherent(substream->dma_buffer.dev.dev,
3715 area,
3716 substream->runtime->dma_area,
3717 substream->runtime->dma_addr,
9066ae7f 3718 substream->runtime->dma_bytes);
657b1989
TI
3719 /* mmap with fault handler */
3720 area->vm_ops = &snd_pcm_vm_ops_data_fault;
1da177e4
LT
3721 return 0;
3722}
18a2b962 3723EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
1da177e4
LT
3724
3725/*
3726 * mmap the DMA buffer on I/O memory area
3727 */
3728#if SNDRV_PCM_INFO_MMAP_IOMEM
30b771cf
TI
3729/**
3730 * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3731 * @substream: PCM substream
3732 * @area: VMA
3733 *
3734 * When your hardware uses the iomapped pages as the hardware buffer and
3735 * wants to mmap it, pass this function as mmap pcm_ops. Note that this
3736 * is supposed to work only on limited architectures.
3737 */
877211f5
TI
3738int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3739 struct vm_area_struct *area)
1da177e4 3740{
3c7f6919 3741 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4 3742
1da177e4 3743 area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
0fe09a45 3744 return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
1da177e4 3745}
e88e8ae6 3746EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
1da177e4
LT
3747#endif /* SNDRV_PCM_INFO_MMAP */
3748
3749/*
3750 * mmap DMA buffer
3751 */
877211f5 3752int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
1da177e4
LT
3753 struct vm_area_struct *area)
3754{
877211f5 3755 struct snd_pcm_runtime *runtime;
1da177e4
LT
3756 long size;
3757 unsigned long offset;
3758 size_t dma_bytes;
657b1989 3759 int err;
1da177e4
LT
3760
3761 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3762 if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3763 return -EINVAL;
3764 } else {
3765 if (!(area->vm_flags & VM_READ))
3766 return -EINVAL;
3767 }
3768 runtime = substream->runtime;
1da177e4
LT
3769 if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3770 return -EBADFD;
3771 if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3772 return -ENXIO;
3773 if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3774 runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3775 return -EINVAL;
3776 size = area->vm_end - area->vm_start;
3777 offset = area->vm_pgoff << PAGE_SHIFT;
3778 dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3779 if ((size_t)size > dma_bytes)
3780 return -EINVAL;
3781 if (offset > dma_bytes - size)
3782 return -EINVAL;
3783
657b1989
TI
3784 area->vm_ops = &snd_pcm_vm_ops_data;
3785 area->vm_private_data = substream;
1da177e4 3786 if (substream->ops->mmap)
657b1989 3787 err = substream->ops->mmap(substream, area);
1da177e4 3788 else
18a2b962 3789 err = snd_pcm_lib_default_mmap(substream, area);
657b1989
TI
3790 if (!err)
3791 atomic_inc(&substream->mmap_count);
3792 return err;
1da177e4 3793}
e88e8ae6
TI
3794EXPORT_SYMBOL(snd_pcm_mmap_data);
3795
1da177e4
LT
3796static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3797{
877211f5
TI
3798 struct snd_pcm_file * pcm_file;
3799 struct snd_pcm_substream *substream;
1da177e4
LT
3800 unsigned long offset;
3801
3802 pcm_file = file->private_data;
3803 substream = pcm_file->substream;
7eaa943c
TI
3804 if (PCM_RUNTIME_CHECK(substream))
3805 return -ENXIO;
1da177e4
LT
3806
3807 offset = area->vm_pgoff << PAGE_SHIFT;
3808 switch (offset) {
80fe7430
AB
3809 case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3810 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3811 return -ENXIO;
c0dbbdad 3812 fallthrough;
80fe7430 3813 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
42f94597 3814 if (!pcm_status_mmap_allowed(pcm_file))
1da177e4
LT
3815 return -ENXIO;
3816 return snd_pcm_mmap_status(substream, file, area);
80fe7430
AB
3817 case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3818 if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3819 return -ENXIO;
c0dbbdad 3820 fallthrough;
80fe7430 3821 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
b602aa8e 3822 if (!pcm_control_mmap_allowed(pcm_file))
1da177e4
LT
3823 return -ENXIO;
3824 return snd_pcm_mmap_control(substream, file, area);
3825 default:
3826 return snd_pcm_mmap_data(substream, file, area);
3827 }
3828 return 0;
3829}
3830
3831static int snd_pcm_fasync(int fd, struct file * file, int on)
3832{
877211f5
TI
3833 struct snd_pcm_file * pcm_file;
3834 struct snd_pcm_substream *substream;
3835 struct snd_pcm_runtime *runtime;
1da177e4
LT
3836
3837 pcm_file = file->private_data;
3838 substream = pcm_file->substream;
7eaa943c 3839 if (PCM_RUNTIME_CHECK(substream))
d05468b7 3840 return -ENXIO;
1da177e4 3841 runtime = substream->runtime;
d05468b7 3842 return fasync_helper(fd, file, on, &runtime->fasync);
1da177e4
LT
3843}
3844
3845/*
3846 * ioctl32 compat
3847 */
3848#ifdef CONFIG_COMPAT
3849#include "pcm_compat.c"
3850#else
3851#define snd_pcm_ioctl_compat NULL
3852#endif
3853
3854/*
3855 * To be removed helpers to keep binary compatibility
3856 */
3857
59d48582 3858#ifdef CONFIG_SND_SUPPORT_OLD_API
1da177e4
LT
3859#define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3860#define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3861
877211f5
TI
3862static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3863 struct snd_pcm_hw_params_old *oparams)
1da177e4
LT
3864{
3865 unsigned int i;
3866
3867 memset(params, 0, sizeof(*params));
3868 params->flags = oparams->flags;
3869 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3870 params->masks[i].bits[0] = oparams->masks[i];
3871 memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3872 params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3873 params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3874 params->info = oparams->info;
3875 params->msbits = oparams->msbits;
3876 params->rate_num = oparams->rate_num;
3877 params->rate_den = oparams->rate_den;
3878 params->fifo_size = oparams->fifo_size;
3879}
3880
877211f5
TI
3881static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3882 struct snd_pcm_hw_params *params)
1da177e4
LT
3883{
3884 unsigned int i;
3885
3886 memset(oparams, 0, sizeof(*oparams));
3887 oparams->flags = params->flags;
3888 for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3889 oparams->masks[i] = params->masks[i].bits[0];
3890 memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
3891 oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
3892 oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
3893 oparams->info = params->info;
3894 oparams->msbits = params->msbits;
3895 oparams->rate_num = params->rate_num;
3896 oparams->rate_den = params->rate_den;
3897 oparams->fifo_size = params->fifo_size;
3898}
3899
877211f5
TI
3900static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
3901 struct snd_pcm_hw_params_old __user * _oparams)
1da177e4 3902{
877211f5
TI
3903 struct snd_pcm_hw_params *params;
3904 struct snd_pcm_hw_params_old *oparams = NULL;
1da177e4
LT
3905 int err;
3906
3907 params = kmalloc(sizeof(*params), GFP_KERNEL);
ef44a1ec
LZ
3908 if (!params)
3909 return -ENOMEM;
1da177e4 3910
ef44a1ec
LZ
3911 oparams = memdup_user(_oparams, sizeof(*oparams));
3912 if (IS_ERR(oparams)) {
3913 err = PTR_ERR(oparams);
1da177e4
LT
3914 goto out;
3915 }
3916 snd_pcm_hw_convert_from_old_params(params, oparams);
3917 err = snd_pcm_hw_refine(substream, params);
f74ae15f
TS
3918 if (err < 0)
3919 goto out_old;
ef44a1ec 3920
f74ae15f
TS
3921 err = fixup_unreferenced_params(substream, params);
3922 if (err < 0)
3923 goto out_old;
ef44a1ec 3924
f74ae15f
TS
3925 snd_pcm_hw_convert_to_old_params(oparams, params);
3926 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3927 err = -EFAULT;
3928out_old:
ef44a1ec 3929 kfree(oparams);
1da177e4
LT
3930out:
3931 kfree(params);
1da177e4
LT
3932 return err;
3933}
3934
877211f5
TI
3935static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
3936 struct snd_pcm_hw_params_old __user * _oparams)
1da177e4 3937{
877211f5
TI
3938 struct snd_pcm_hw_params *params;
3939 struct snd_pcm_hw_params_old *oparams = NULL;
1da177e4
LT
3940 int err;
3941
3942 params = kmalloc(sizeof(*params), GFP_KERNEL);
ef44a1ec
LZ
3943 if (!params)
3944 return -ENOMEM;
3945
3946 oparams = memdup_user(_oparams, sizeof(*oparams));
3947 if (IS_ERR(oparams)) {
3948 err = PTR_ERR(oparams);
1da177e4
LT
3949 goto out;
3950 }
f74ae15f 3951
1da177e4
LT
3952 snd_pcm_hw_convert_from_old_params(params, oparams);
3953 err = snd_pcm_hw_params(substream, params);
f74ae15f
TS
3954 if (err < 0)
3955 goto out_old;
ef44a1ec 3956
f74ae15f
TS
3957 snd_pcm_hw_convert_to_old_params(oparams, params);
3958 if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
3959 err = -EFAULT;
3960out_old:
ef44a1ec 3961 kfree(oparams);
1da177e4
LT
3962out:
3963 kfree(params);
1da177e4
LT
3964 return err;
3965}
59d48582 3966#endif /* CONFIG_SND_SUPPORT_OLD_API */
1da177e4 3967
7003609b 3968#ifndef CONFIG_MMU
55c63bd2
DG
3969static unsigned long snd_pcm_get_unmapped_area(struct file *file,
3970 unsigned long addr,
3971 unsigned long len,
3972 unsigned long pgoff,
3973 unsigned long flags)
3974{
3975 struct snd_pcm_file *pcm_file = file->private_data;
3976 struct snd_pcm_substream *substream = pcm_file->substream;
3977 struct snd_pcm_runtime *runtime = substream->runtime;
3978 unsigned long offset = pgoff << PAGE_SHIFT;
3979
3980 switch (offset) {
80fe7430 3981 case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
55c63bd2 3982 return (unsigned long)runtime->status;
80fe7430 3983 case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
55c63bd2
DG
3984 return (unsigned long)runtime->control;
3985 default:
3986 return (unsigned long)runtime->dma_area + offset;
3987 }
7003609b
CC
3988}
3989#else
55c63bd2 3990# define snd_pcm_get_unmapped_area NULL
7003609b
CC
3991#endif
3992
1da177e4
LT
3993/*
3994 * Register section
3995 */
3996
9c2e08c5 3997const struct file_operations snd_pcm_f_ops[2] = {
1da177e4 3998 {
2af677fc
CL
3999 .owner = THIS_MODULE,
4000 .write = snd_pcm_write,
1c65d986 4001 .write_iter = snd_pcm_writev,
f87135f5 4002 .open = snd_pcm_playback_open,
2af677fc 4003 .release = snd_pcm_release,
02f4865f 4004 .llseek = no_llseek,
6448fcba 4005 .poll = snd_pcm_poll,
67616fed 4006 .unlocked_ioctl = snd_pcm_ioctl,
2af677fc
CL
4007 .compat_ioctl = snd_pcm_ioctl_compat,
4008 .mmap = snd_pcm_mmap,
4009 .fasync = snd_pcm_fasync,
55c63bd2 4010 .get_unmapped_area = snd_pcm_get_unmapped_area,
1da177e4
LT
4011 },
4012 {
2af677fc
CL
4013 .owner = THIS_MODULE,
4014 .read = snd_pcm_read,
1c65d986 4015 .read_iter = snd_pcm_readv,
f87135f5 4016 .open = snd_pcm_capture_open,
2af677fc 4017 .release = snd_pcm_release,
02f4865f 4018 .llseek = no_llseek,
6448fcba 4019 .poll = snd_pcm_poll,
67616fed 4020 .unlocked_ioctl = snd_pcm_ioctl,
2af677fc
CL
4021 .compat_ioctl = snd_pcm_ioctl_compat,
4022 .mmap = snd_pcm_mmap,
4023 .fasync = snd_pcm_fasync,
55c63bd2 4024 .get_unmapped_area = snd_pcm_get_unmapped_area,
1da177e4
LT
4025 }
4026};