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