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