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