Back to home page

OSCL-LXR

 
 

    


0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  Digital Audio (PCM) abstract layer
0004  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
0005  */
0006 
0007 #include <linux/compat.h>
0008 #include <linux/mm.h>
0009 #include <linux/module.h>
0010 #include <linux/file.h>
0011 #include <linux/slab.h>
0012 #include <linux/sched/signal.h>
0013 #include <linux/time.h>
0014 #include <linux/pm_qos.h>
0015 #include <linux/io.h>
0016 #include <linux/dma-mapping.h>
0017 #include <linux/vmalloc.h>
0018 #include <sound/core.h>
0019 #include <sound/control.h>
0020 #include <sound/info.h>
0021 #include <sound/pcm.h>
0022 #include <sound/pcm_params.h>
0023 #include <sound/timer.h>
0024 #include <sound/minors.h>
0025 #include <linux/uio.h>
0026 #include <linux/delay.h>
0027 
0028 #include "pcm_local.h"
0029 
0030 #ifdef CONFIG_SND_DEBUG
0031 #define CREATE_TRACE_POINTS
0032 #include "pcm_param_trace.h"
0033 #else
0034 #define trace_hw_mask_param_enabled()       0
0035 #define trace_hw_interval_param_enabled()   0
0036 #define trace_hw_mask_param(substream, type, index, prev, curr)
0037 #define trace_hw_interval_param(substream, type, index, prev, curr)
0038 #endif
0039 
0040 /*
0041  *  Compatibility
0042  */
0043 
0044 struct snd_pcm_hw_params_old {
0045     unsigned int flags;
0046     unsigned int masks[SNDRV_PCM_HW_PARAM_SUBFORMAT -
0047                SNDRV_PCM_HW_PARAM_ACCESS + 1];
0048     struct snd_interval intervals[SNDRV_PCM_HW_PARAM_TICK_TIME -
0049                     SNDRV_PCM_HW_PARAM_SAMPLE_BITS + 1];
0050     unsigned int rmask;
0051     unsigned int cmask;
0052     unsigned int info;
0053     unsigned int msbits;
0054     unsigned int rate_num;
0055     unsigned int rate_den;
0056     snd_pcm_uframes_t fifo_size;
0057     unsigned char reserved[64];
0058 };
0059 
0060 #ifdef CONFIG_SND_SUPPORT_OLD_API
0061 #define SNDRV_PCM_IOCTL_HW_REFINE_OLD _IOWR('A', 0x10, struct snd_pcm_hw_params_old)
0062 #define SNDRV_PCM_IOCTL_HW_PARAMS_OLD _IOWR('A', 0x11, struct snd_pcm_hw_params_old)
0063 
0064 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
0065                       struct snd_pcm_hw_params_old __user * _oparams);
0066 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
0067                       struct snd_pcm_hw_params_old __user * _oparams);
0068 #endif
0069 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream);
0070 
0071 /*
0072  *
0073  */
0074 
0075 static DECLARE_RWSEM(snd_pcm_link_rwsem);
0076 
0077 void snd_pcm_group_init(struct snd_pcm_group *group)
0078 {
0079     spin_lock_init(&group->lock);
0080     mutex_init(&group->mutex);
0081     INIT_LIST_HEAD(&group->substreams);
0082     refcount_set(&group->refs, 1);
0083 }
0084 
0085 /* define group lock helpers */
0086 #define DEFINE_PCM_GROUP_LOCK(action, mutex_action) \
0087 static void snd_pcm_group_ ## action(struct snd_pcm_group *group, bool nonatomic) \
0088 { \
0089     if (nonatomic) \
0090         mutex_ ## mutex_action(&group->mutex); \
0091     else \
0092         spin_ ## action(&group->lock); \
0093 }
0094 
0095 DEFINE_PCM_GROUP_LOCK(lock, lock);
0096 DEFINE_PCM_GROUP_LOCK(unlock, unlock);
0097 DEFINE_PCM_GROUP_LOCK(lock_irq, lock);
0098 DEFINE_PCM_GROUP_LOCK(unlock_irq, unlock);
0099 
0100 /**
0101  * snd_pcm_stream_lock - Lock the PCM stream
0102  * @substream: PCM substream
0103  *
0104  * This locks the PCM stream's spinlock or mutex depending on the nonatomic
0105  * flag of the given substream.  This also takes the global link rw lock
0106  * (or rw sem), too, for avoiding the race with linked streams.
0107  */
0108 void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
0109 {
0110     snd_pcm_group_lock(&substream->self_group, substream->pcm->nonatomic);
0111 }
0112 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock);
0113 
0114 /**
0115  * snd_pcm_stream_unlock - Unlock the PCM stream
0116  * @substream: PCM substream
0117  *
0118  * This unlocks the PCM stream that has been locked via snd_pcm_stream_lock().
0119  */
0120 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
0121 {
0122     snd_pcm_group_unlock(&substream->self_group, substream->pcm->nonatomic);
0123 }
0124 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock);
0125 
0126 /**
0127  * snd_pcm_stream_lock_irq - Lock the PCM stream
0128  * @substream: PCM substream
0129  *
0130  * This locks the PCM stream like snd_pcm_stream_lock() and disables the local
0131  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
0132  * as snd_pcm_stream_lock().
0133  */
0134 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
0135 {
0136     snd_pcm_group_lock_irq(&substream->self_group,
0137                    substream->pcm->nonatomic);
0138 }
0139 EXPORT_SYMBOL_GPL(snd_pcm_stream_lock_irq);
0140 
0141 static void snd_pcm_stream_lock_nested(struct snd_pcm_substream *substream)
0142 {
0143     struct snd_pcm_group *group = &substream->self_group;
0144 
0145     if (substream->pcm->nonatomic)
0146         mutex_lock_nested(&group->mutex, SINGLE_DEPTH_NESTING);
0147     else
0148         spin_lock_nested(&group->lock, SINGLE_DEPTH_NESTING);
0149 }
0150 
0151 /**
0152  * snd_pcm_stream_unlock_irq - Unlock the PCM stream
0153  * @substream: PCM substream
0154  *
0155  * This is a counter-part of snd_pcm_stream_lock_irq().
0156  */
0157 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
0158 {
0159     snd_pcm_group_unlock_irq(&substream->self_group,
0160                  substream->pcm->nonatomic);
0161 }
0162 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irq);
0163 
0164 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream)
0165 {
0166     unsigned long flags = 0;
0167     if (substream->pcm->nonatomic)
0168         mutex_lock(&substream->self_group.mutex);
0169     else
0170         spin_lock_irqsave(&substream->self_group.lock, flags);
0171     return flags;
0172 }
0173 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave);
0174 
0175 unsigned long _snd_pcm_stream_lock_irqsave_nested(struct snd_pcm_substream *substream)
0176 {
0177     unsigned long flags = 0;
0178     if (substream->pcm->nonatomic)
0179         mutex_lock_nested(&substream->self_group.mutex,
0180                   SINGLE_DEPTH_NESTING);
0181     else
0182         spin_lock_irqsave_nested(&substream->self_group.lock, flags,
0183                      SINGLE_DEPTH_NESTING);
0184     return flags;
0185 }
0186 EXPORT_SYMBOL_GPL(_snd_pcm_stream_lock_irqsave_nested);
0187 
0188 /**
0189  * snd_pcm_stream_unlock_irqrestore - Unlock the PCM stream
0190  * @substream: PCM substream
0191  * @flags: irq flags
0192  *
0193  * This is a counter-part of snd_pcm_stream_lock_irqsave().
0194  */
0195 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
0196                       unsigned long flags)
0197 {
0198     if (substream->pcm->nonatomic)
0199         mutex_unlock(&substream->self_group.mutex);
0200     else
0201         spin_unlock_irqrestore(&substream->self_group.lock, flags);
0202 }
0203 EXPORT_SYMBOL_GPL(snd_pcm_stream_unlock_irqrestore);
0204 
0205 /* Run PCM ioctl ops */
0206 static int snd_pcm_ops_ioctl(struct snd_pcm_substream *substream,
0207                  unsigned cmd, void *arg)
0208 {
0209     if (substream->ops->ioctl)
0210         return substream->ops->ioctl(substream, cmd, arg);
0211     else
0212         return snd_pcm_lib_ioctl(substream, cmd, arg);
0213 }
0214 
0215 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info)
0216 {
0217     struct snd_pcm *pcm = substream->pcm;
0218     struct snd_pcm_str *pstr = substream->pstr;
0219 
0220     memset(info, 0, sizeof(*info));
0221     info->card = pcm->card->number;
0222     info->device = pcm->device;
0223     info->stream = substream->stream;
0224     info->subdevice = substream->number;
0225     strscpy(info->id, pcm->id, sizeof(info->id));
0226     strscpy(info->name, pcm->name, sizeof(info->name));
0227     info->dev_class = pcm->dev_class;
0228     info->dev_subclass = pcm->dev_subclass;
0229     info->subdevices_count = pstr->substream_count;
0230     info->subdevices_avail = pstr->substream_count - pstr->substream_opened;
0231     strscpy(info->subname, substream->name, sizeof(info->subname));
0232 
0233     return 0;
0234 }
0235 
0236 int snd_pcm_info_user(struct snd_pcm_substream *substream,
0237               struct snd_pcm_info __user * _info)
0238 {
0239     struct snd_pcm_info *info;
0240     int err;
0241 
0242     info = kmalloc(sizeof(*info), GFP_KERNEL);
0243     if (! info)
0244         return -ENOMEM;
0245     err = snd_pcm_info(substream, info);
0246     if (err >= 0) {
0247         if (copy_to_user(_info, info, sizeof(*info)))
0248             err = -EFAULT;
0249     }
0250     kfree(info);
0251     return err;
0252 }
0253 
0254 /* macro for simplified cast */
0255 #define PARAM_MASK_BIT(b)   (1U << (__force int)(b))
0256 
0257 static bool hw_support_mmap(struct snd_pcm_substream *substream)
0258 {
0259     struct snd_dma_buffer *dmabuf;
0260 
0261     if (!(substream->runtime->hw.info & SNDRV_PCM_INFO_MMAP))
0262         return false;
0263 
0264     if (substream->ops->mmap || substream->ops->page)
0265         return true;
0266 
0267     dmabuf = snd_pcm_get_dma_buf(substream);
0268     if (!dmabuf)
0269         dmabuf = &substream->dma_buffer;
0270     switch (dmabuf->dev.type) {
0271     case SNDRV_DMA_TYPE_UNKNOWN:
0272         /* we can't know the device, so just assume that the driver does
0273          * everything right
0274          */
0275         return true;
0276     case SNDRV_DMA_TYPE_CONTINUOUS:
0277     case SNDRV_DMA_TYPE_VMALLOC:
0278         return true;
0279     default:
0280         return dma_can_mmap(dmabuf->dev.dev);
0281     }
0282 }
0283 
0284 static int constrain_mask_params(struct snd_pcm_substream *substream,
0285                  struct snd_pcm_hw_params *params)
0286 {
0287     struct snd_pcm_hw_constraints *constrs =
0288                     &substream->runtime->hw_constraints;
0289     struct snd_mask *m;
0290     unsigned int k;
0291     struct snd_mask old_mask;
0292     int changed;
0293 
0294     for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
0295         m = hw_param_mask(params, k);
0296         if (snd_mask_empty(m))
0297             return -EINVAL;
0298 
0299         /* This parameter is not requested to change by a caller. */
0300         if (!(params->rmask & PARAM_MASK_BIT(k)))
0301             continue;
0302 
0303         if (trace_hw_mask_param_enabled())
0304             old_mask = *m;
0305 
0306         changed = snd_mask_refine(m, constrs_mask(constrs, k));
0307         if (changed < 0)
0308             return changed;
0309         if (changed == 0)
0310             continue;
0311 
0312         /* Set corresponding flag so that the caller gets it. */
0313         trace_hw_mask_param(substream, k, 0, &old_mask, m);
0314         params->cmask |= PARAM_MASK_BIT(k);
0315     }
0316 
0317     return 0;
0318 }
0319 
0320 static int constrain_interval_params(struct snd_pcm_substream *substream,
0321                      struct snd_pcm_hw_params *params)
0322 {
0323     struct snd_pcm_hw_constraints *constrs =
0324                     &substream->runtime->hw_constraints;
0325     struct snd_interval *i;
0326     unsigned int k;
0327     struct snd_interval old_interval;
0328     int changed;
0329 
0330     for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
0331         i = hw_param_interval(params, k);
0332         if (snd_interval_empty(i))
0333             return -EINVAL;
0334 
0335         /* This parameter is not requested to change by a caller. */
0336         if (!(params->rmask & PARAM_MASK_BIT(k)))
0337             continue;
0338 
0339         if (trace_hw_interval_param_enabled())
0340             old_interval = *i;
0341 
0342         changed = snd_interval_refine(i, constrs_interval(constrs, k));
0343         if (changed < 0)
0344             return changed;
0345         if (changed == 0)
0346             continue;
0347 
0348         /* Set corresponding flag so that the caller gets it. */
0349         trace_hw_interval_param(substream, k, 0, &old_interval, i);
0350         params->cmask |= PARAM_MASK_BIT(k);
0351     }
0352 
0353     return 0;
0354 }
0355 
0356 static int constrain_params_by_rules(struct snd_pcm_substream *substream,
0357                      struct snd_pcm_hw_params *params)
0358 {
0359     struct snd_pcm_hw_constraints *constrs =
0360                     &substream->runtime->hw_constraints;
0361     unsigned int k;
0362     unsigned int *rstamps;
0363     unsigned int vstamps[SNDRV_PCM_HW_PARAM_LAST_INTERVAL + 1];
0364     unsigned int stamp;
0365     struct snd_pcm_hw_rule *r;
0366     unsigned int d;
0367     struct snd_mask old_mask;
0368     struct snd_interval old_interval;
0369     bool again;
0370     int changed, err = 0;
0371 
0372     /*
0373      * Each application of rule has own sequence number.
0374      *
0375      * Each member of 'rstamps' array represents the sequence number of
0376      * recent application of corresponding rule.
0377      */
0378     rstamps = kcalloc(constrs->rules_num, sizeof(unsigned int), GFP_KERNEL);
0379     if (!rstamps)
0380         return -ENOMEM;
0381 
0382     /*
0383      * Each member of 'vstamps' array represents the sequence number of
0384      * recent application of rule in which corresponding parameters were
0385      * changed.
0386      *
0387      * In initial state, elements corresponding to parameters requested by
0388      * a caller is 1. For unrequested parameters, corresponding members
0389      * have 0 so that the parameters are never changed anymore.
0390      */
0391     for (k = 0; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++)
0392         vstamps[k] = (params->rmask & PARAM_MASK_BIT(k)) ? 1 : 0;
0393 
0394     /* Due to the above design, actual sequence number starts at 2. */
0395     stamp = 2;
0396 retry:
0397     /* Apply all rules in order. */
0398     again = false;
0399     for (k = 0; k < constrs->rules_num; k++) {
0400         r = &constrs->rules[k];
0401 
0402         /*
0403          * Check condition bits of this rule. When the rule has
0404          * some condition bits, parameter without the bits is
0405          * never processed. SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP
0406          * is an example of the condition bits.
0407          */
0408         if (r->cond && !(r->cond & params->flags))
0409             continue;
0410 
0411         /*
0412          * The 'deps' array includes maximum four dependencies
0413          * to SNDRV_PCM_HW_PARAM_XXXs for this rule. The fifth
0414          * member of this array is a sentinel and should be
0415          * negative value.
0416          *
0417          * This rule should be processed in this time when dependent
0418          * parameters were changed at former applications of the other
0419          * rules.
0420          */
0421         for (d = 0; r->deps[d] >= 0; d++) {
0422             if (vstamps[r->deps[d]] > rstamps[k])
0423                 break;
0424         }
0425         if (r->deps[d] < 0)
0426             continue;
0427 
0428         if (trace_hw_mask_param_enabled()) {
0429             if (hw_is_mask(r->var))
0430                 old_mask = *hw_param_mask(params, r->var);
0431         }
0432         if (trace_hw_interval_param_enabled()) {
0433             if (hw_is_interval(r->var))
0434                 old_interval = *hw_param_interval(params, r->var);
0435         }
0436 
0437         changed = r->func(params, r);
0438         if (changed < 0) {
0439             err = changed;
0440             goto out;
0441         }
0442 
0443         /*
0444          * When the parameter is changed, notify it to the caller
0445          * by corresponding returned bit, then preparing for next
0446          * iteration.
0447          */
0448         if (changed && r->var >= 0) {
0449             if (hw_is_mask(r->var)) {
0450                 trace_hw_mask_param(substream, r->var,
0451                     k + 1, &old_mask,
0452                     hw_param_mask(params, r->var));
0453             }
0454             if (hw_is_interval(r->var)) {
0455                 trace_hw_interval_param(substream, r->var,
0456                     k + 1, &old_interval,
0457                     hw_param_interval(params, r->var));
0458             }
0459 
0460             params->cmask |= PARAM_MASK_BIT(r->var);
0461             vstamps[r->var] = stamp;
0462             again = true;
0463         }
0464 
0465         rstamps[k] = stamp++;
0466     }
0467 
0468     /* Iterate to evaluate all rules till no parameters are changed. */
0469     if (again)
0470         goto retry;
0471 
0472  out:
0473     kfree(rstamps);
0474     return err;
0475 }
0476 
0477 static int fixup_unreferenced_params(struct snd_pcm_substream *substream,
0478                      struct snd_pcm_hw_params *params)
0479 {
0480     const struct snd_interval *i;
0481     const struct snd_mask *m;
0482     int err;
0483 
0484     if (!params->msbits) {
0485         i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_SAMPLE_BITS);
0486         if (snd_interval_single(i))
0487             params->msbits = snd_interval_value(i);
0488     }
0489 
0490     if (!params->rate_den) {
0491         i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_RATE);
0492         if (snd_interval_single(i)) {
0493             params->rate_num = snd_interval_value(i);
0494             params->rate_den = 1;
0495         }
0496     }
0497 
0498     if (!params->fifo_size) {
0499         m = hw_param_mask_c(params, SNDRV_PCM_HW_PARAM_FORMAT);
0500         i = hw_param_interval_c(params, SNDRV_PCM_HW_PARAM_CHANNELS);
0501         if (snd_mask_single(m) && snd_interval_single(i)) {
0502             err = snd_pcm_ops_ioctl(substream,
0503                         SNDRV_PCM_IOCTL1_FIFO_SIZE,
0504                         params);
0505             if (err < 0)
0506                 return err;
0507         }
0508     }
0509 
0510     if (!params->info) {
0511         params->info = substream->runtime->hw.info;
0512         params->info &= ~(SNDRV_PCM_INFO_FIFO_IN_FRAMES |
0513                   SNDRV_PCM_INFO_DRAIN_TRIGGER);
0514         if (!hw_support_mmap(substream))
0515             params->info &= ~(SNDRV_PCM_INFO_MMAP |
0516                       SNDRV_PCM_INFO_MMAP_VALID);
0517     }
0518 
0519     return 0;
0520 }
0521 
0522 int snd_pcm_hw_refine(struct snd_pcm_substream *substream,
0523               struct snd_pcm_hw_params *params)
0524 {
0525     int err;
0526 
0527     params->info = 0;
0528     params->fifo_size = 0;
0529     if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_SAMPLE_BITS))
0530         params->msbits = 0;
0531     if (params->rmask & PARAM_MASK_BIT(SNDRV_PCM_HW_PARAM_RATE)) {
0532         params->rate_num = 0;
0533         params->rate_den = 0;
0534     }
0535 
0536     err = constrain_mask_params(substream, params);
0537     if (err < 0)
0538         return err;
0539 
0540     err = constrain_interval_params(substream, params);
0541     if (err < 0)
0542         return err;
0543 
0544     err = constrain_params_by_rules(substream, params);
0545     if (err < 0)
0546         return err;
0547 
0548     params->rmask = 0;
0549 
0550     return 0;
0551 }
0552 EXPORT_SYMBOL(snd_pcm_hw_refine);
0553 
0554 static int snd_pcm_hw_refine_user(struct snd_pcm_substream *substream,
0555                   struct snd_pcm_hw_params __user * _params)
0556 {
0557     struct snd_pcm_hw_params *params;
0558     int err;
0559 
0560     params = memdup_user(_params, sizeof(*params));
0561     if (IS_ERR(params))
0562         return PTR_ERR(params);
0563 
0564     err = snd_pcm_hw_refine(substream, params);
0565     if (err < 0)
0566         goto end;
0567 
0568     err = fixup_unreferenced_params(substream, params);
0569     if (err < 0)
0570         goto end;
0571 
0572     if (copy_to_user(_params, params, sizeof(*params)))
0573         err = -EFAULT;
0574 end:
0575     kfree(params);
0576     return err;
0577 }
0578 
0579 static int period_to_usecs(struct snd_pcm_runtime *runtime)
0580 {
0581     int usecs;
0582 
0583     if (! runtime->rate)
0584         return -1; /* invalid */
0585 
0586     /* take 75% of period time as the deadline */
0587     usecs = (750000 / runtime->rate) * runtime->period_size;
0588     usecs += ((750000 % runtime->rate) * runtime->period_size) /
0589         runtime->rate;
0590 
0591     return usecs;
0592 }
0593 
0594 static void snd_pcm_set_state(struct snd_pcm_substream *substream,
0595                   snd_pcm_state_t state)
0596 {
0597     snd_pcm_stream_lock_irq(substream);
0598     if (substream->runtime->status->state != SNDRV_PCM_STATE_DISCONNECTED)
0599         substream->runtime->status->state = state;
0600     snd_pcm_stream_unlock_irq(substream);
0601 }
0602 
0603 static inline void snd_pcm_timer_notify(struct snd_pcm_substream *substream,
0604                     int event)
0605 {
0606 #ifdef CONFIG_SND_PCM_TIMER
0607     if (substream->timer)
0608         snd_timer_notify(substream->timer, event,
0609                     &substream->runtime->trigger_tstamp);
0610 #endif
0611 }
0612 
0613 void snd_pcm_sync_stop(struct snd_pcm_substream *substream, bool sync_irq)
0614 {
0615     if (substream->runtime && substream->runtime->stop_operating) {
0616         substream->runtime->stop_operating = false;
0617         if (substream->ops && substream->ops->sync_stop)
0618             substream->ops->sync_stop(substream);
0619         else if (sync_irq && substream->pcm->card->sync_irq > 0)
0620             synchronize_irq(substream->pcm->card->sync_irq);
0621     }
0622 }
0623 
0624 /**
0625  * snd_pcm_hw_params_choose - choose a configuration defined by @params
0626  * @pcm: PCM instance
0627  * @params: the hw_params instance
0628  *
0629  * Choose one configuration from configuration space defined by @params.
0630  * The configuration chosen is that obtained fixing in this order:
0631  * first access, first format, first subformat, min channels,
0632  * min rate, min period time, max buffer size, min tick time
0633  *
0634  * Return: Zero if successful, or a negative error code on failure.
0635  */
0636 static int snd_pcm_hw_params_choose(struct snd_pcm_substream *pcm,
0637                     struct snd_pcm_hw_params *params)
0638 {
0639     static const int vars[] = {
0640         SNDRV_PCM_HW_PARAM_ACCESS,
0641         SNDRV_PCM_HW_PARAM_FORMAT,
0642         SNDRV_PCM_HW_PARAM_SUBFORMAT,
0643         SNDRV_PCM_HW_PARAM_CHANNELS,
0644         SNDRV_PCM_HW_PARAM_RATE,
0645         SNDRV_PCM_HW_PARAM_PERIOD_TIME,
0646         SNDRV_PCM_HW_PARAM_BUFFER_SIZE,
0647         SNDRV_PCM_HW_PARAM_TICK_TIME,
0648         -1
0649     };
0650     const int *v;
0651     struct snd_mask old_mask;
0652     struct snd_interval old_interval;
0653     int changed;
0654 
0655     for (v = vars; *v != -1; v++) {
0656         /* Keep old parameter to trace. */
0657         if (trace_hw_mask_param_enabled()) {
0658             if (hw_is_mask(*v))
0659                 old_mask = *hw_param_mask(params, *v);
0660         }
0661         if (trace_hw_interval_param_enabled()) {
0662             if (hw_is_interval(*v))
0663                 old_interval = *hw_param_interval(params, *v);
0664         }
0665         if (*v != SNDRV_PCM_HW_PARAM_BUFFER_SIZE)
0666             changed = snd_pcm_hw_param_first(pcm, params, *v, NULL);
0667         else
0668             changed = snd_pcm_hw_param_last(pcm, params, *v, NULL);
0669         if (changed < 0)
0670             return changed;
0671         if (changed == 0)
0672             continue;
0673 
0674         /* Trace the changed parameter. */
0675         if (hw_is_mask(*v)) {
0676             trace_hw_mask_param(pcm, *v, 0, &old_mask,
0677                         hw_param_mask(params, *v));
0678         }
0679         if (hw_is_interval(*v)) {
0680             trace_hw_interval_param(pcm, *v, 0, &old_interval,
0681                         hw_param_interval(params, *v));
0682         }
0683     }
0684 
0685     return 0;
0686 }
0687 
0688 /* acquire buffer_mutex; if it's in r/w operation, return -EBUSY, otherwise
0689  * block the further r/w operations
0690  */
0691 static int snd_pcm_buffer_access_lock(struct snd_pcm_runtime *runtime)
0692 {
0693     if (!atomic_dec_unless_positive(&runtime->buffer_accessing))
0694         return -EBUSY;
0695     mutex_lock(&runtime->buffer_mutex);
0696     return 0; /* keep buffer_mutex, unlocked by below */
0697 }
0698 
0699 /* release buffer_mutex and clear r/w access flag */
0700 static void snd_pcm_buffer_access_unlock(struct snd_pcm_runtime *runtime)
0701 {
0702     mutex_unlock(&runtime->buffer_mutex);
0703     atomic_inc(&runtime->buffer_accessing);
0704 }
0705 
0706 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
0707 #define is_oss_stream(substream)    ((substream)->oss.oss)
0708 #else
0709 #define is_oss_stream(substream)    false
0710 #endif
0711 
0712 static int snd_pcm_hw_params(struct snd_pcm_substream *substream,
0713                  struct snd_pcm_hw_params *params)
0714 {
0715     struct snd_pcm_runtime *runtime;
0716     int err, usecs;
0717     unsigned int bits;
0718     snd_pcm_uframes_t frames;
0719 
0720     if (PCM_RUNTIME_CHECK(substream))
0721         return -ENXIO;
0722     runtime = substream->runtime;
0723     err = snd_pcm_buffer_access_lock(runtime);
0724     if (err < 0)
0725         return err;
0726     snd_pcm_stream_lock_irq(substream);
0727     switch (runtime->status->state) {
0728     case SNDRV_PCM_STATE_OPEN:
0729     case SNDRV_PCM_STATE_SETUP:
0730     case SNDRV_PCM_STATE_PREPARED:
0731         if (!is_oss_stream(substream) &&
0732             atomic_read(&substream->mmap_count))
0733             err = -EBADFD;
0734         break;
0735     default:
0736         err = -EBADFD;
0737         break;
0738     }
0739     snd_pcm_stream_unlock_irq(substream);
0740     if (err)
0741         goto unlock;
0742 
0743     snd_pcm_sync_stop(substream, true);
0744 
0745     params->rmask = ~0U;
0746     err = snd_pcm_hw_refine(substream, params);
0747     if (err < 0)
0748         goto _error;
0749 
0750     err = snd_pcm_hw_params_choose(substream, params);
0751     if (err < 0)
0752         goto _error;
0753 
0754     err = fixup_unreferenced_params(substream, params);
0755     if (err < 0)
0756         goto _error;
0757 
0758     if (substream->managed_buffer_alloc) {
0759         err = snd_pcm_lib_malloc_pages(substream,
0760                            params_buffer_bytes(params));
0761         if (err < 0)
0762             goto _error;
0763         runtime->buffer_changed = err > 0;
0764     }
0765 
0766     if (substream->ops->hw_params != NULL) {
0767         err = substream->ops->hw_params(substream, params);
0768         if (err < 0)
0769             goto _error;
0770     }
0771 
0772     runtime->access = params_access(params);
0773     runtime->format = params_format(params);
0774     runtime->subformat = params_subformat(params);
0775     runtime->channels = params_channels(params);
0776     runtime->rate = params_rate(params);
0777     runtime->period_size = params_period_size(params);
0778     runtime->periods = params_periods(params);
0779     runtime->buffer_size = params_buffer_size(params);
0780     runtime->info = params->info;
0781     runtime->rate_num = params->rate_num;
0782     runtime->rate_den = params->rate_den;
0783     runtime->no_period_wakeup =
0784             (params->info & SNDRV_PCM_INFO_NO_PERIOD_WAKEUP) &&
0785             (params->flags & SNDRV_PCM_HW_PARAMS_NO_PERIOD_WAKEUP);
0786 
0787     bits = snd_pcm_format_physical_width(runtime->format);
0788     runtime->sample_bits = bits;
0789     bits *= runtime->channels;
0790     runtime->frame_bits = bits;
0791     frames = 1;
0792     while (bits % 8 != 0) {
0793         bits *= 2;
0794         frames *= 2;
0795     }
0796     runtime->byte_align = bits / 8;
0797     runtime->min_align = frames;
0798 
0799     /* Default sw params */
0800     runtime->tstamp_mode = SNDRV_PCM_TSTAMP_NONE;
0801     runtime->period_step = 1;
0802     runtime->control->avail_min = runtime->period_size;
0803     runtime->start_threshold = 1;
0804     runtime->stop_threshold = runtime->buffer_size;
0805     runtime->silence_threshold = 0;
0806     runtime->silence_size = 0;
0807     runtime->boundary = runtime->buffer_size;
0808     while (runtime->boundary * 2 <= LONG_MAX - runtime->buffer_size)
0809         runtime->boundary *= 2;
0810 
0811     /* clear the buffer for avoiding possible kernel info leaks */
0812     if (runtime->dma_area && !substream->ops->copy_user) {
0813         size_t size = runtime->dma_bytes;
0814 
0815         if (runtime->info & SNDRV_PCM_INFO_MMAP)
0816             size = PAGE_ALIGN(size);
0817         memset(runtime->dma_area, 0, size);
0818     }
0819 
0820     snd_pcm_timer_resolution_change(substream);
0821     snd_pcm_set_state(substream, SNDRV_PCM_STATE_SETUP);
0822 
0823     if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
0824         cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
0825     usecs = period_to_usecs(runtime);
0826     if (usecs >= 0)
0827         cpu_latency_qos_add_request(&substream->latency_pm_qos_req,
0828                         usecs);
0829     err = 0;
0830  _error:
0831     if (err) {
0832         /* hardware might be unusable from this time,
0833          * so we force application to retry to set
0834          * the correct hardware parameter settings
0835          */
0836         snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
0837         if (substream->ops->hw_free != NULL)
0838             substream->ops->hw_free(substream);
0839         if (substream->managed_buffer_alloc)
0840             snd_pcm_lib_free_pages(substream);
0841     }
0842  unlock:
0843     snd_pcm_buffer_access_unlock(runtime);
0844     return err;
0845 }
0846 
0847 static int snd_pcm_hw_params_user(struct snd_pcm_substream *substream,
0848                   struct snd_pcm_hw_params __user * _params)
0849 {
0850     struct snd_pcm_hw_params *params;
0851     int err;
0852 
0853     params = memdup_user(_params, sizeof(*params));
0854     if (IS_ERR(params))
0855         return PTR_ERR(params);
0856 
0857     err = snd_pcm_hw_params(substream, params);
0858     if (err < 0)
0859         goto end;
0860 
0861     if (copy_to_user(_params, params, sizeof(*params)))
0862         err = -EFAULT;
0863 end:
0864     kfree(params);
0865     return err;
0866 }
0867 
0868 static int do_hw_free(struct snd_pcm_substream *substream)
0869 {
0870     int result = 0;
0871 
0872     snd_pcm_sync_stop(substream, true);
0873     if (substream->ops->hw_free)
0874         result = substream->ops->hw_free(substream);
0875     if (substream->managed_buffer_alloc)
0876         snd_pcm_lib_free_pages(substream);
0877     return result;
0878 }
0879 
0880 static int snd_pcm_hw_free(struct snd_pcm_substream *substream)
0881 {
0882     struct snd_pcm_runtime *runtime;
0883     int result = 0;
0884 
0885     if (PCM_RUNTIME_CHECK(substream))
0886         return -ENXIO;
0887     runtime = substream->runtime;
0888     result = snd_pcm_buffer_access_lock(runtime);
0889     if (result < 0)
0890         return result;
0891     snd_pcm_stream_lock_irq(substream);
0892     switch (runtime->status->state) {
0893     case SNDRV_PCM_STATE_SETUP:
0894     case SNDRV_PCM_STATE_PREPARED:
0895         if (atomic_read(&substream->mmap_count))
0896             result = -EBADFD;
0897         break;
0898     default:
0899         result = -EBADFD;
0900         break;
0901     }
0902     snd_pcm_stream_unlock_irq(substream);
0903     if (result)
0904         goto unlock;
0905     result = do_hw_free(substream);
0906     snd_pcm_set_state(substream, SNDRV_PCM_STATE_OPEN);
0907     cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
0908  unlock:
0909     snd_pcm_buffer_access_unlock(runtime);
0910     return result;
0911 }
0912 
0913 static int snd_pcm_sw_params(struct snd_pcm_substream *substream,
0914                  struct snd_pcm_sw_params *params)
0915 {
0916     struct snd_pcm_runtime *runtime;
0917     int err;
0918 
0919     if (PCM_RUNTIME_CHECK(substream))
0920         return -ENXIO;
0921     runtime = substream->runtime;
0922     snd_pcm_stream_lock_irq(substream);
0923     if (runtime->status->state == SNDRV_PCM_STATE_OPEN) {
0924         snd_pcm_stream_unlock_irq(substream);
0925         return -EBADFD;
0926     }
0927     snd_pcm_stream_unlock_irq(substream);
0928 
0929     if (params->tstamp_mode < 0 ||
0930         params->tstamp_mode > SNDRV_PCM_TSTAMP_LAST)
0931         return -EINVAL;
0932     if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12) &&
0933         params->tstamp_type > SNDRV_PCM_TSTAMP_TYPE_LAST)
0934         return -EINVAL;
0935     if (params->avail_min == 0)
0936         return -EINVAL;
0937     if (params->silence_size >= runtime->boundary) {
0938         if (params->silence_threshold != 0)
0939             return -EINVAL;
0940     } else {
0941         if (params->silence_size > params->silence_threshold)
0942             return -EINVAL;
0943         if (params->silence_threshold > runtime->buffer_size)
0944             return -EINVAL;
0945     }
0946     err = 0;
0947     snd_pcm_stream_lock_irq(substream);
0948     runtime->tstamp_mode = params->tstamp_mode;
0949     if (params->proto >= SNDRV_PROTOCOL_VERSION(2, 0, 12))
0950         runtime->tstamp_type = params->tstamp_type;
0951     runtime->period_step = params->period_step;
0952     runtime->control->avail_min = params->avail_min;
0953     runtime->start_threshold = params->start_threshold;
0954     runtime->stop_threshold = params->stop_threshold;
0955     runtime->silence_threshold = params->silence_threshold;
0956     runtime->silence_size = params->silence_size;
0957         params->boundary = runtime->boundary;
0958     if (snd_pcm_running(substream)) {
0959         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
0960             runtime->silence_size > 0)
0961             snd_pcm_playback_silence(substream, ULONG_MAX);
0962         err = snd_pcm_update_state(substream, runtime);
0963     }
0964     snd_pcm_stream_unlock_irq(substream);
0965     return err;
0966 }
0967 
0968 static int snd_pcm_sw_params_user(struct snd_pcm_substream *substream,
0969                   struct snd_pcm_sw_params __user * _params)
0970 {
0971     struct snd_pcm_sw_params params;
0972     int err;
0973     if (copy_from_user(&params, _params, sizeof(params)))
0974         return -EFAULT;
0975     err = snd_pcm_sw_params(substream, &params);
0976     if (copy_to_user(_params, &params, sizeof(params)))
0977         return -EFAULT;
0978     return err;
0979 }
0980 
0981 static inline snd_pcm_uframes_t
0982 snd_pcm_calc_delay(struct snd_pcm_substream *substream)
0983 {
0984     snd_pcm_uframes_t delay;
0985 
0986     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
0987         delay = snd_pcm_playback_hw_avail(substream->runtime);
0988     else
0989         delay = snd_pcm_capture_avail(substream->runtime);
0990     return delay + substream->runtime->delay;
0991 }
0992 
0993 int snd_pcm_status64(struct snd_pcm_substream *substream,
0994              struct snd_pcm_status64 *status)
0995 {
0996     struct snd_pcm_runtime *runtime = substream->runtime;
0997 
0998     snd_pcm_stream_lock_irq(substream);
0999 
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->status->state;
1017     status->suspended_state = runtime->status->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->status->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->status->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     if (substream->runtime->trigger_master != substream)
1428         return 0;
1429     return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_START);
1430 }
1431 
1432 static void snd_pcm_undo_start(struct snd_pcm_substream *substream,
1433                    snd_pcm_state_t state)
1434 {
1435     if (substream->runtime->trigger_master == substream)
1436         substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1437 }
1438 
1439 static void snd_pcm_post_start(struct snd_pcm_substream *substream,
1440                    snd_pcm_state_t state)
1441 {
1442     struct snd_pcm_runtime *runtime = substream->runtime;
1443     snd_pcm_trigger_tstamp(substream);
1444     runtime->hw_ptr_jiffies = jiffies;
1445     runtime->hw_ptr_buffer_jiffies = (runtime->buffer_size * HZ) / 
1446                                 runtime->rate;
1447     runtime->status->state = state;
1448     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1449         runtime->silence_size > 0)
1450         snd_pcm_playback_silence(substream, ULONG_MAX);
1451     snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTART);
1452 }
1453 
1454 static const struct action_ops snd_pcm_action_start = {
1455     .pre_action = snd_pcm_pre_start,
1456     .do_action = snd_pcm_do_start,
1457     .undo_action = snd_pcm_undo_start,
1458     .post_action = snd_pcm_post_start
1459 };
1460 
1461 /**
1462  * snd_pcm_start - start all linked streams
1463  * @substream: the PCM substream instance
1464  *
1465  * Return: Zero if successful, or a negative error code.
1466  * The stream lock must be acquired before calling this function.
1467  */
1468 int snd_pcm_start(struct snd_pcm_substream *substream)
1469 {
1470     return snd_pcm_action(&snd_pcm_action_start, substream,
1471                   SNDRV_PCM_STATE_RUNNING);
1472 }
1473 
1474 /* take the stream lock and start the streams */
1475 static int snd_pcm_start_lock_irq(struct snd_pcm_substream *substream)
1476 {
1477     return snd_pcm_action_lock_irq(&snd_pcm_action_start, substream,
1478                        SNDRV_PCM_STATE_RUNNING);
1479 }
1480 
1481 /*
1482  * stop callbacks
1483  */
1484 static int snd_pcm_pre_stop(struct snd_pcm_substream *substream,
1485                 snd_pcm_state_t state)
1486 {
1487     struct snd_pcm_runtime *runtime = substream->runtime;
1488     if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
1489         return -EBADFD;
1490     runtime->trigger_master = substream;
1491     return 0;
1492 }
1493 
1494 static int snd_pcm_do_stop(struct snd_pcm_substream *substream,
1495                snd_pcm_state_t state)
1496 {
1497     if (substream->runtime->trigger_master == substream &&
1498         snd_pcm_running(substream)) {
1499         substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_STOP);
1500         substream->runtime->stop_operating = true;
1501     }
1502     return 0; /* unconditionally stop all substreams */
1503 }
1504 
1505 static void snd_pcm_post_stop(struct snd_pcm_substream *substream,
1506                   snd_pcm_state_t state)
1507 {
1508     struct snd_pcm_runtime *runtime = substream->runtime;
1509     if (runtime->status->state != state) {
1510         snd_pcm_trigger_tstamp(substream);
1511         runtime->status->state = state;
1512         snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSTOP);
1513     }
1514     wake_up(&runtime->sleep);
1515     wake_up(&runtime->tsleep);
1516 }
1517 
1518 static const struct action_ops snd_pcm_action_stop = {
1519     .pre_action = snd_pcm_pre_stop,
1520     .do_action = snd_pcm_do_stop,
1521     .post_action = snd_pcm_post_stop
1522 };
1523 
1524 /**
1525  * snd_pcm_stop - try to stop all running streams in the substream group
1526  * @substream: the PCM substream instance
1527  * @state: PCM state after stopping the stream
1528  *
1529  * The state of each stream is then changed to the given state unconditionally.
1530  *
1531  * Return: Zero if successful, or a negative error code.
1532  */
1533 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t state)
1534 {
1535     return snd_pcm_action(&snd_pcm_action_stop, substream, state);
1536 }
1537 EXPORT_SYMBOL(snd_pcm_stop);
1538 
1539 /**
1540  * snd_pcm_drain_done - stop the DMA only when the given stream is playback
1541  * @substream: the PCM substream
1542  *
1543  * After stopping, the state is changed to SETUP.
1544  * Unlike snd_pcm_stop(), this affects only the given stream.
1545  *
1546  * Return: Zero if successful, or a negative error code.
1547  */
1548 int snd_pcm_drain_done(struct snd_pcm_substream *substream)
1549 {
1550     return snd_pcm_action_single(&snd_pcm_action_stop, substream,
1551                      SNDRV_PCM_STATE_SETUP);
1552 }
1553 
1554 /**
1555  * snd_pcm_stop_xrun - stop the running streams as XRUN
1556  * @substream: the PCM substream instance
1557  *
1558  * This stops the given running substream (and all linked substreams) as XRUN.
1559  * Unlike snd_pcm_stop(), this function takes the substream lock by itself.
1560  *
1561  * Return: Zero if successful, or a negative error code.
1562  */
1563 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream)
1564 {
1565     unsigned long flags;
1566 
1567     snd_pcm_stream_lock_irqsave(substream, flags);
1568     if (substream->runtime && snd_pcm_running(substream))
1569         __snd_pcm_xrun(substream);
1570     snd_pcm_stream_unlock_irqrestore(substream, flags);
1571     return 0;
1572 }
1573 EXPORT_SYMBOL_GPL(snd_pcm_stop_xrun);
1574 
1575 /*
1576  * pause callbacks: pass boolean (to start pause or resume) as state argument
1577  */
1578 #define pause_pushed(state) (__force bool)(state)
1579 
1580 static int snd_pcm_pre_pause(struct snd_pcm_substream *substream,
1581                  snd_pcm_state_t state)
1582 {
1583     struct snd_pcm_runtime *runtime = substream->runtime;
1584     if (!(runtime->info & SNDRV_PCM_INFO_PAUSE))
1585         return -ENOSYS;
1586     if (pause_pushed(state)) {
1587         if (runtime->status->state != SNDRV_PCM_STATE_RUNNING)
1588             return -EBADFD;
1589     } else if (runtime->status->state != SNDRV_PCM_STATE_PAUSED)
1590         return -EBADFD;
1591     runtime->trigger_master = substream;
1592     return 0;
1593 }
1594 
1595 static int snd_pcm_do_pause(struct snd_pcm_substream *substream,
1596                 snd_pcm_state_t state)
1597 {
1598     if (substream->runtime->trigger_master != substream)
1599         return 0;
1600     /* some drivers might use hw_ptr to recover from the pause -
1601        update the hw_ptr now */
1602     if (pause_pushed(state))
1603         snd_pcm_update_hw_ptr(substream);
1604     /* The jiffies check in snd_pcm_update_hw_ptr*() is done by
1605      * a delta between the current jiffies, this gives a large enough
1606      * delta, effectively to skip the check once.
1607      */
1608     substream->runtime->hw_ptr_jiffies = jiffies - HZ * 1000;
1609     return substream->ops->trigger(substream,
1610                        pause_pushed(state) ?
1611                        SNDRV_PCM_TRIGGER_PAUSE_PUSH :
1612                        SNDRV_PCM_TRIGGER_PAUSE_RELEASE);
1613 }
1614 
1615 static void snd_pcm_undo_pause(struct snd_pcm_substream *substream,
1616                    snd_pcm_state_t state)
1617 {
1618     if (substream->runtime->trigger_master == substream)
1619         substream->ops->trigger(substream,
1620                     pause_pushed(state) ?
1621                     SNDRV_PCM_TRIGGER_PAUSE_RELEASE :
1622                     SNDRV_PCM_TRIGGER_PAUSE_PUSH);
1623 }
1624 
1625 static void snd_pcm_post_pause(struct snd_pcm_substream *substream,
1626                    snd_pcm_state_t state)
1627 {
1628     struct snd_pcm_runtime *runtime = substream->runtime;
1629     snd_pcm_trigger_tstamp(substream);
1630     if (pause_pushed(state)) {
1631         runtime->status->state = SNDRV_PCM_STATE_PAUSED;
1632         snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MPAUSE);
1633         wake_up(&runtime->sleep);
1634         wake_up(&runtime->tsleep);
1635     } else {
1636         runtime->status->state = SNDRV_PCM_STATE_RUNNING;
1637         snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MCONTINUE);
1638     }
1639 }
1640 
1641 static const struct action_ops snd_pcm_action_pause = {
1642     .pre_action = snd_pcm_pre_pause,
1643     .do_action = snd_pcm_do_pause,
1644     .undo_action = snd_pcm_undo_pause,
1645     .post_action = snd_pcm_post_pause
1646 };
1647 
1648 /*
1649  * Push/release the pause for all linked streams.
1650  */
1651 static int snd_pcm_pause(struct snd_pcm_substream *substream, bool push)
1652 {
1653     return snd_pcm_action(&snd_pcm_action_pause, substream,
1654                   (__force snd_pcm_state_t)push);
1655 }
1656 
1657 static int snd_pcm_pause_lock_irq(struct snd_pcm_substream *substream,
1658                   bool push)
1659 {
1660     return snd_pcm_action_lock_irq(&snd_pcm_action_pause, substream,
1661                        (__force snd_pcm_state_t)push);
1662 }
1663 
1664 #ifdef CONFIG_PM
1665 /* suspend callback: state argument ignored */
1666 
1667 static int snd_pcm_pre_suspend(struct snd_pcm_substream *substream,
1668                    snd_pcm_state_t state)
1669 {
1670     struct snd_pcm_runtime *runtime = substream->runtime;
1671     switch (runtime->status->state) {
1672     case SNDRV_PCM_STATE_SUSPENDED:
1673         return -EBUSY;
1674     /* unresumable PCM state; return -EBUSY for skipping suspend */
1675     case SNDRV_PCM_STATE_OPEN:
1676     case SNDRV_PCM_STATE_SETUP:
1677     case SNDRV_PCM_STATE_DISCONNECTED:
1678         return -EBUSY;
1679     }
1680     runtime->trigger_master = substream;
1681     return 0;
1682 }
1683 
1684 static int snd_pcm_do_suspend(struct snd_pcm_substream *substream,
1685                   snd_pcm_state_t state)
1686 {
1687     struct snd_pcm_runtime *runtime = substream->runtime;
1688     if (runtime->trigger_master != substream)
1689         return 0;
1690     if (! snd_pcm_running(substream))
1691         return 0;
1692     substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1693     runtime->stop_operating = true;
1694     return 0; /* suspend unconditionally */
1695 }
1696 
1697 static void snd_pcm_post_suspend(struct snd_pcm_substream *substream,
1698                  snd_pcm_state_t state)
1699 {
1700     struct snd_pcm_runtime *runtime = substream->runtime;
1701     snd_pcm_trigger_tstamp(substream);
1702     runtime->status->suspended_state = runtime->status->state;
1703     runtime->status->state = SNDRV_PCM_STATE_SUSPENDED;
1704     snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MSUSPEND);
1705     wake_up(&runtime->sleep);
1706     wake_up(&runtime->tsleep);
1707 }
1708 
1709 static const struct action_ops snd_pcm_action_suspend = {
1710     .pre_action = snd_pcm_pre_suspend,
1711     .do_action = snd_pcm_do_suspend,
1712     .post_action = snd_pcm_post_suspend
1713 };
1714 
1715 /*
1716  * snd_pcm_suspend - trigger SUSPEND to all linked streams
1717  * @substream: the PCM substream
1718  *
1719  * After this call, all streams are changed to SUSPENDED state.
1720  *
1721  * Return: Zero if successful, or a negative error code.
1722  */
1723 static int snd_pcm_suspend(struct snd_pcm_substream *substream)
1724 {
1725     int err;
1726     unsigned long flags;
1727 
1728     snd_pcm_stream_lock_irqsave(substream, flags);
1729     err = snd_pcm_action(&snd_pcm_action_suspend, substream,
1730                  ACTION_ARG_IGNORE);
1731     snd_pcm_stream_unlock_irqrestore(substream, flags);
1732     return err;
1733 }
1734 
1735 /**
1736  * snd_pcm_suspend_all - trigger SUSPEND to all substreams in the given pcm
1737  * @pcm: the PCM instance
1738  *
1739  * After this call, all streams are changed to SUSPENDED state.
1740  *
1741  * Return: Zero if successful (or @pcm is %NULL), or a negative error code.
1742  */
1743 int snd_pcm_suspend_all(struct snd_pcm *pcm)
1744 {
1745     struct snd_pcm_substream *substream;
1746     int stream, err = 0;
1747 
1748     if (! pcm)
1749         return 0;
1750 
1751     for_each_pcm_substream(pcm, stream, substream) {
1752         /* FIXME: the open/close code should lock this as well */
1753         if (!substream->runtime)
1754             continue;
1755 
1756         /*
1757          * Skip BE dai link PCM's that are internal and may
1758          * not have their substream ops set.
1759          */
1760         if (!substream->ops)
1761             continue;
1762 
1763         err = snd_pcm_suspend(substream);
1764         if (err < 0 && err != -EBUSY)
1765             return err;
1766     }
1767 
1768     for_each_pcm_substream(pcm, stream, substream)
1769         snd_pcm_sync_stop(substream, false);
1770 
1771     return 0;
1772 }
1773 EXPORT_SYMBOL(snd_pcm_suspend_all);
1774 
1775 /* resume callbacks: state argument ignored */
1776 
1777 static int snd_pcm_pre_resume(struct snd_pcm_substream *substream,
1778                   snd_pcm_state_t state)
1779 {
1780     struct snd_pcm_runtime *runtime = substream->runtime;
1781     if (!(runtime->info & SNDRV_PCM_INFO_RESUME))
1782         return -ENOSYS;
1783     runtime->trigger_master = substream;
1784     return 0;
1785 }
1786 
1787 static int snd_pcm_do_resume(struct snd_pcm_substream *substream,
1788                  snd_pcm_state_t state)
1789 {
1790     struct snd_pcm_runtime *runtime = substream->runtime;
1791     if (runtime->trigger_master != substream)
1792         return 0;
1793     /* DMA not running previously? */
1794     if (runtime->status->suspended_state != SNDRV_PCM_STATE_RUNNING &&
1795         (runtime->status->suspended_state != SNDRV_PCM_STATE_DRAINING ||
1796          substream->stream != SNDRV_PCM_STREAM_PLAYBACK))
1797         return 0;
1798     return substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_RESUME);
1799 }
1800 
1801 static void snd_pcm_undo_resume(struct snd_pcm_substream *substream,
1802                 snd_pcm_state_t state)
1803 {
1804     if (substream->runtime->trigger_master == substream &&
1805         snd_pcm_running(substream))
1806         substream->ops->trigger(substream, SNDRV_PCM_TRIGGER_SUSPEND);
1807 }
1808 
1809 static void snd_pcm_post_resume(struct snd_pcm_substream *substream,
1810                 snd_pcm_state_t state)
1811 {
1812     struct snd_pcm_runtime *runtime = substream->runtime;
1813     snd_pcm_trigger_tstamp(substream);
1814     runtime->status->state = runtime->status->suspended_state;
1815     snd_pcm_timer_notify(substream, SNDRV_TIMER_EVENT_MRESUME);
1816 }
1817 
1818 static const struct action_ops snd_pcm_action_resume = {
1819     .pre_action = snd_pcm_pre_resume,
1820     .do_action = snd_pcm_do_resume,
1821     .undo_action = snd_pcm_undo_resume,
1822     .post_action = snd_pcm_post_resume
1823 };
1824 
1825 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1826 {
1827     return snd_pcm_action_lock_irq(&snd_pcm_action_resume, substream,
1828                        ACTION_ARG_IGNORE);
1829 }
1830 
1831 #else
1832 
1833 static int snd_pcm_resume(struct snd_pcm_substream *substream)
1834 {
1835     return -ENOSYS;
1836 }
1837 
1838 #endif /* CONFIG_PM */
1839 
1840 /*
1841  * xrun ioctl
1842  *
1843  * Change the RUNNING stream(s) to XRUN state.
1844  */
1845 static int snd_pcm_xrun(struct snd_pcm_substream *substream)
1846 {
1847     struct snd_pcm_runtime *runtime = substream->runtime;
1848     int result;
1849 
1850     snd_pcm_stream_lock_irq(substream);
1851     switch (runtime->status->state) {
1852     case SNDRV_PCM_STATE_XRUN:
1853         result = 0; /* already there */
1854         break;
1855     case SNDRV_PCM_STATE_RUNNING:
1856         __snd_pcm_xrun(substream);
1857         result = 0;
1858         break;
1859     default:
1860         result = -EBADFD;
1861     }
1862     snd_pcm_stream_unlock_irq(substream);
1863     return result;
1864 }
1865 
1866 /*
1867  * reset ioctl
1868  */
1869 /* reset callbacks:  state argument ignored */
1870 static int snd_pcm_pre_reset(struct snd_pcm_substream *substream,
1871                  snd_pcm_state_t state)
1872 {
1873     struct snd_pcm_runtime *runtime = substream->runtime;
1874     switch (runtime->status->state) {
1875     case SNDRV_PCM_STATE_RUNNING:
1876     case SNDRV_PCM_STATE_PREPARED:
1877     case SNDRV_PCM_STATE_PAUSED:
1878     case SNDRV_PCM_STATE_SUSPENDED:
1879         return 0;
1880     default:
1881         return -EBADFD;
1882     }
1883 }
1884 
1885 static int snd_pcm_do_reset(struct snd_pcm_substream *substream,
1886                 snd_pcm_state_t state)
1887 {
1888     struct snd_pcm_runtime *runtime = substream->runtime;
1889     int err = snd_pcm_ops_ioctl(substream, SNDRV_PCM_IOCTL1_RESET, NULL);
1890     if (err < 0)
1891         return err;
1892     snd_pcm_stream_lock_irq(substream);
1893     runtime->hw_ptr_base = 0;
1894     runtime->hw_ptr_interrupt = runtime->status->hw_ptr -
1895         runtime->status->hw_ptr % runtime->period_size;
1896     runtime->silence_start = runtime->status->hw_ptr;
1897     runtime->silence_filled = 0;
1898     snd_pcm_stream_unlock_irq(substream);
1899     return 0;
1900 }
1901 
1902 static void snd_pcm_post_reset(struct snd_pcm_substream *substream,
1903                    snd_pcm_state_t state)
1904 {
1905     struct snd_pcm_runtime *runtime = substream->runtime;
1906     snd_pcm_stream_lock_irq(substream);
1907     runtime->control->appl_ptr = runtime->status->hw_ptr;
1908     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK &&
1909         runtime->silence_size > 0)
1910         snd_pcm_playback_silence(substream, ULONG_MAX);
1911     snd_pcm_stream_unlock_irq(substream);
1912 }
1913 
1914 static const struct action_ops snd_pcm_action_reset = {
1915     .pre_action = snd_pcm_pre_reset,
1916     .do_action = snd_pcm_do_reset,
1917     .post_action = snd_pcm_post_reset
1918 };
1919 
1920 static int snd_pcm_reset(struct snd_pcm_substream *substream)
1921 {
1922     return snd_pcm_action_nonatomic(&snd_pcm_action_reset, substream,
1923                     ACTION_ARG_IGNORE);
1924 }
1925 
1926 /*
1927  * prepare ioctl
1928  */
1929 /* pass f_flags as state argument */
1930 static int snd_pcm_pre_prepare(struct snd_pcm_substream *substream,
1931                    snd_pcm_state_t state)
1932 {
1933     struct snd_pcm_runtime *runtime = substream->runtime;
1934     int f_flags = (__force int)state;
1935 
1936     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
1937         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
1938         return -EBADFD;
1939     if (snd_pcm_running(substream))
1940         return -EBUSY;
1941     substream->f_flags = f_flags;
1942     return 0;
1943 }
1944 
1945 static int snd_pcm_do_prepare(struct snd_pcm_substream *substream,
1946                   snd_pcm_state_t state)
1947 {
1948     int err;
1949     snd_pcm_sync_stop(substream, true);
1950     err = substream->ops->prepare(substream);
1951     if (err < 0)
1952         return err;
1953     return snd_pcm_do_reset(substream, state);
1954 }
1955 
1956 static void snd_pcm_post_prepare(struct snd_pcm_substream *substream,
1957                  snd_pcm_state_t state)
1958 {
1959     struct snd_pcm_runtime *runtime = substream->runtime;
1960     runtime->control->appl_ptr = runtime->status->hw_ptr;
1961     snd_pcm_set_state(substream, SNDRV_PCM_STATE_PREPARED);
1962 }
1963 
1964 static const struct action_ops snd_pcm_action_prepare = {
1965     .pre_action = snd_pcm_pre_prepare,
1966     .do_action = snd_pcm_do_prepare,
1967     .post_action = snd_pcm_post_prepare
1968 };
1969 
1970 /**
1971  * snd_pcm_prepare - prepare the PCM substream to be triggerable
1972  * @substream: the PCM substream instance
1973  * @file: file to refer f_flags
1974  *
1975  * Return: Zero if successful, or a negative error code.
1976  */
1977 static int snd_pcm_prepare(struct snd_pcm_substream *substream,
1978                struct file *file)
1979 {
1980     int f_flags;
1981 
1982     if (file)
1983         f_flags = file->f_flags;
1984     else
1985         f_flags = substream->f_flags;
1986 
1987     snd_pcm_stream_lock_irq(substream);
1988     switch (substream->runtime->status->state) {
1989     case SNDRV_PCM_STATE_PAUSED:
1990         snd_pcm_pause(substream, false);
1991         fallthrough;
1992     case SNDRV_PCM_STATE_SUSPENDED:
1993         snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
1994         break;
1995     }
1996     snd_pcm_stream_unlock_irq(substream);
1997 
1998     return snd_pcm_action_nonatomic(&snd_pcm_action_prepare,
1999                     substream,
2000                     (__force snd_pcm_state_t)f_flags);
2001 }
2002 
2003 /*
2004  * drain ioctl
2005  */
2006 
2007 /* drain init callbacks: state argument ignored */
2008 static int snd_pcm_pre_drain_init(struct snd_pcm_substream *substream,
2009                   snd_pcm_state_t state)
2010 {
2011     struct snd_pcm_runtime *runtime = substream->runtime;
2012     switch (runtime->status->state) {
2013     case SNDRV_PCM_STATE_OPEN:
2014     case SNDRV_PCM_STATE_DISCONNECTED:
2015     case SNDRV_PCM_STATE_SUSPENDED:
2016         return -EBADFD;
2017     }
2018     runtime->trigger_master = substream;
2019     return 0;
2020 }
2021 
2022 static int snd_pcm_do_drain_init(struct snd_pcm_substream *substream,
2023                  snd_pcm_state_t state)
2024 {
2025     struct snd_pcm_runtime *runtime = substream->runtime;
2026     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
2027         switch (runtime->status->state) {
2028         case SNDRV_PCM_STATE_PREPARED:
2029             /* start playback stream if possible */
2030             if (! snd_pcm_playback_empty(substream)) {
2031                 snd_pcm_do_start(substream, SNDRV_PCM_STATE_DRAINING);
2032                 snd_pcm_post_start(substream, SNDRV_PCM_STATE_DRAINING);
2033             } else {
2034                 runtime->status->state = SNDRV_PCM_STATE_SETUP;
2035             }
2036             break;
2037         case SNDRV_PCM_STATE_RUNNING:
2038             runtime->status->state = SNDRV_PCM_STATE_DRAINING;
2039             break;
2040         case SNDRV_PCM_STATE_XRUN:
2041             runtime->status->state = SNDRV_PCM_STATE_SETUP;
2042             break;
2043         default:
2044             break;
2045         }
2046     } else {
2047         /* stop running stream */
2048         if (runtime->status->state == SNDRV_PCM_STATE_RUNNING) {
2049             snd_pcm_state_t new_state;
2050 
2051             new_state = snd_pcm_capture_avail(runtime) > 0 ?
2052                 SNDRV_PCM_STATE_DRAINING : SNDRV_PCM_STATE_SETUP;
2053             snd_pcm_do_stop(substream, new_state);
2054             snd_pcm_post_stop(substream, new_state);
2055         }
2056     }
2057 
2058     if (runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
2059         runtime->trigger_master == substream &&
2060         (runtime->hw.info & SNDRV_PCM_INFO_DRAIN_TRIGGER))
2061         return substream->ops->trigger(substream,
2062                            SNDRV_PCM_TRIGGER_DRAIN);
2063 
2064     return 0;
2065 }
2066 
2067 static void snd_pcm_post_drain_init(struct snd_pcm_substream *substream,
2068                     snd_pcm_state_t state)
2069 {
2070 }
2071 
2072 static const struct action_ops snd_pcm_action_drain_init = {
2073     .pre_action = snd_pcm_pre_drain_init,
2074     .do_action = snd_pcm_do_drain_init,
2075     .post_action = snd_pcm_post_drain_init
2076 };
2077 
2078 /*
2079  * Drain the stream(s).
2080  * When the substream is linked, sync until the draining of all playback streams
2081  * is finished.
2082  * After this call, all streams are supposed to be either SETUP or DRAINING
2083  * (capture only) state.
2084  */
2085 static int snd_pcm_drain(struct snd_pcm_substream *substream,
2086              struct file *file)
2087 {
2088     struct snd_card *card;
2089     struct snd_pcm_runtime *runtime;
2090     struct snd_pcm_substream *s;
2091     struct snd_pcm_group *group;
2092     wait_queue_entry_t wait;
2093     int result = 0;
2094     int nonblock = 0;
2095 
2096     card = substream->pcm->card;
2097     runtime = substream->runtime;
2098 
2099     if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
2100         return -EBADFD;
2101 
2102     if (file) {
2103         if (file->f_flags & O_NONBLOCK)
2104             nonblock = 1;
2105     } else if (substream->f_flags & O_NONBLOCK)
2106         nonblock = 1;
2107 
2108     snd_pcm_stream_lock_irq(substream);
2109     /* resume pause */
2110     if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
2111         snd_pcm_pause(substream, false);
2112 
2113     /* pre-start/stop - all running streams are changed to DRAINING state */
2114     result = snd_pcm_action(&snd_pcm_action_drain_init, substream,
2115                 ACTION_ARG_IGNORE);
2116     if (result < 0)
2117         goto unlock;
2118     /* in non-blocking, we don't wait in ioctl but let caller poll */
2119     if (nonblock) {
2120         result = -EAGAIN;
2121         goto unlock;
2122     }
2123 
2124     for (;;) {
2125         long tout;
2126         struct snd_pcm_runtime *to_check;
2127         if (signal_pending(current)) {
2128             result = -ERESTARTSYS;
2129             break;
2130         }
2131         /* find a substream to drain */
2132         to_check = NULL;
2133         group = snd_pcm_stream_group_ref(substream);
2134         snd_pcm_group_for_each_entry(s, substream) {
2135             if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
2136                 continue;
2137             runtime = s->runtime;
2138             if (runtime->status->state == SNDRV_PCM_STATE_DRAINING) {
2139                 to_check = runtime;
2140                 break;
2141             }
2142         }
2143         snd_pcm_group_unref(group, substream);
2144         if (!to_check)
2145             break; /* all drained */
2146         init_waitqueue_entry(&wait, current);
2147         set_current_state(TASK_INTERRUPTIBLE);
2148         add_wait_queue(&to_check->sleep, &wait);
2149         snd_pcm_stream_unlock_irq(substream);
2150         if (runtime->no_period_wakeup)
2151             tout = MAX_SCHEDULE_TIMEOUT;
2152         else {
2153             tout = 10;
2154             if (runtime->rate) {
2155                 long t = runtime->period_size * 2 / runtime->rate;
2156                 tout = max(t, tout);
2157             }
2158             tout = msecs_to_jiffies(tout * 1000);
2159         }
2160         tout = schedule_timeout(tout);
2161 
2162         snd_pcm_stream_lock_irq(substream);
2163         group = snd_pcm_stream_group_ref(substream);
2164         snd_pcm_group_for_each_entry(s, substream) {
2165             if (s->runtime == to_check) {
2166                 remove_wait_queue(&to_check->sleep, &wait);
2167                 break;
2168             }
2169         }
2170         snd_pcm_group_unref(group, substream);
2171 
2172         if (card->shutdown) {
2173             result = -ENODEV;
2174             break;
2175         }
2176         if (tout == 0) {
2177             if (substream->runtime->status->state == SNDRV_PCM_STATE_SUSPENDED)
2178                 result = -ESTRPIPE;
2179             else {
2180                 dev_dbg(substream->pcm->card->dev,
2181                     "playback drain error (DMA or IRQ trouble?)\n");
2182                 snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2183                 result = -EIO;
2184             }
2185             break;
2186         }
2187     }
2188 
2189  unlock:
2190     snd_pcm_stream_unlock_irq(substream);
2191 
2192     return result;
2193 }
2194 
2195 /*
2196  * drop ioctl
2197  *
2198  * Immediately put all linked substreams into SETUP state.
2199  */
2200 static int snd_pcm_drop(struct snd_pcm_substream *substream)
2201 {
2202     struct snd_pcm_runtime *runtime;
2203     int result = 0;
2204     
2205     if (PCM_RUNTIME_CHECK(substream))
2206         return -ENXIO;
2207     runtime = substream->runtime;
2208 
2209     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2210         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
2211         return -EBADFD;
2212 
2213     snd_pcm_stream_lock_irq(substream);
2214     /* resume pause */
2215     if (runtime->status->state == SNDRV_PCM_STATE_PAUSED)
2216         snd_pcm_pause(substream, false);
2217 
2218     snd_pcm_stop(substream, SNDRV_PCM_STATE_SETUP);
2219     /* runtime->control->appl_ptr = runtime->status->hw_ptr; */
2220     snd_pcm_stream_unlock_irq(substream);
2221 
2222     return result;
2223 }
2224 
2225 
2226 static bool is_pcm_file(struct file *file)
2227 {
2228     struct inode *inode = file_inode(file);
2229     struct snd_pcm *pcm;
2230     unsigned int minor;
2231 
2232     if (!S_ISCHR(inode->i_mode) || imajor(inode) != snd_major)
2233         return false;
2234     minor = iminor(inode);
2235     pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2236     if (!pcm)
2237         pcm = snd_lookup_minor_data(minor, SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2238     if (!pcm)
2239         return false;
2240     snd_card_unref(pcm->card);
2241     return true;
2242 }
2243 
2244 /*
2245  * PCM link handling
2246  */
2247 static int snd_pcm_link(struct snd_pcm_substream *substream, int fd)
2248 {
2249     int res = 0;
2250     struct snd_pcm_file *pcm_file;
2251     struct snd_pcm_substream *substream1;
2252     struct snd_pcm_group *group, *target_group;
2253     bool nonatomic = substream->pcm->nonatomic;
2254     struct fd f = fdget(fd);
2255 
2256     if (!f.file)
2257         return -EBADFD;
2258     if (!is_pcm_file(f.file)) {
2259         res = -EBADFD;
2260         goto _badf;
2261     }
2262     pcm_file = f.file->private_data;
2263     substream1 = pcm_file->substream;
2264 
2265     if (substream == substream1) {
2266         res = -EINVAL;
2267         goto _badf;
2268     }
2269 
2270     group = kzalloc(sizeof(*group), GFP_KERNEL);
2271     if (!group) {
2272         res = -ENOMEM;
2273         goto _nolock;
2274     }
2275     snd_pcm_group_init(group);
2276 
2277     down_write(&snd_pcm_link_rwsem);
2278     if (substream->runtime->status->state == SNDRV_PCM_STATE_OPEN ||
2279         substream->runtime->status->state != substream1->runtime->status->state ||
2280         substream->pcm->nonatomic != substream1->pcm->nonatomic) {
2281         res = -EBADFD;
2282         goto _end;
2283     }
2284     if (snd_pcm_stream_linked(substream1)) {
2285         res = -EALREADY;
2286         goto _end;
2287     }
2288 
2289     snd_pcm_stream_lock_irq(substream);
2290     if (!snd_pcm_stream_linked(substream)) {
2291         snd_pcm_group_assign(substream, group);
2292         group = NULL; /* assigned, don't free this one below */
2293     }
2294     target_group = substream->group;
2295     snd_pcm_stream_unlock_irq(substream);
2296 
2297     snd_pcm_group_lock_irq(target_group, nonatomic);
2298     snd_pcm_stream_lock_nested(substream1);
2299     snd_pcm_group_assign(substream1, target_group);
2300     refcount_inc(&target_group->refs);
2301     snd_pcm_stream_unlock(substream1);
2302     snd_pcm_group_unlock_irq(target_group, nonatomic);
2303  _end:
2304     up_write(&snd_pcm_link_rwsem);
2305  _nolock:
2306     kfree(group);
2307  _badf:
2308     fdput(f);
2309     return res;
2310 }
2311 
2312 static void relink_to_local(struct snd_pcm_substream *substream)
2313 {
2314     snd_pcm_stream_lock_nested(substream);
2315     snd_pcm_group_assign(substream, &substream->self_group);
2316     snd_pcm_stream_unlock(substream);
2317 }
2318 
2319 static int snd_pcm_unlink(struct snd_pcm_substream *substream)
2320 {
2321     struct snd_pcm_group *group;
2322     bool nonatomic = substream->pcm->nonatomic;
2323     bool do_free = false;
2324     int res = 0;
2325 
2326     down_write(&snd_pcm_link_rwsem);
2327 
2328     if (!snd_pcm_stream_linked(substream)) {
2329         res = -EALREADY;
2330         goto _end;
2331     }
2332 
2333     group = substream->group;
2334     snd_pcm_group_lock_irq(group, nonatomic);
2335 
2336     relink_to_local(substream);
2337     refcount_dec(&group->refs);
2338 
2339     /* detach the last stream, too */
2340     if (list_is_singular(&group->substreams)) {
2341         relink_to_local(list_first_entry(&group->substreams,
2342                          struct snd_pcm_substream,
2343                          link_list));
2344         do_free = refcount_dec_and_test(&group->refs);
2345     }
2346 
2347     snd_pcm_group_unlock_irq(group, nonatomic);
2348     if (do_free)
2349         kfree(group);
2350 
2351        _end:
2352     up_write(&snd_pcm_link_rwsem);
2353     return res;
2354 }
2355 
2356 /*
2357  * hw configurator
2358  */
2359 static int snd_pcm_hw_rule_mul(struct snd_pcm_hw_params *params,
2360                    struct snd_pcm_hw_rule *rule)
2361 {
2362     struct snd_interval t;
2363     snd_interval_mul(hw_param_interval_c(params, rule->deps[0]),
2364              hw_param_interval_c(params, rule->deps[1]), &t);
2365     return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2366 }
2367 
2368 static int snd_pcm_hw_rule_div(struct snd_pcm_hw_params *params,
2369                    struct snd_pcm_hw_rule *rule)
2370 {
2371     struct snd_interval t;
2372     snd_interval_div(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_muldivk(struct snd_pcm_hw_params *params,
2378                    struct snd_pcm_hw_rule *rule)
2379 {
2380     struct snd_interval t;
2381     snd_interval_muldivk(hw_param_interval_c(params, rule->deps[0]),
2382              hw_param_interval_c(params, rule->deps[1]),
2383              (unsigned long) rule->private, &t);
2384     return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2385 }
2386 
2387 static int snd_pcm_hw_rule_mulkdiv(struct snd_pcm_hw_params *params,
2388                    struct snd_pcm_hw_rule *rule)
2389 {
2390     struct snd_interval t;
2391     snd_interval_mulkdiv(hw_param_interval_c(params, rule->deps[0]),
2392              (unsigned long) rule->private,
2393              hw_param_interval_c(params, rule->deps[1]), &t);
2394     return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2395 }
2396 
2397 static int snd_pcm_hw_rule_format(struct snd_pcm_hw_params *params,
2398                   struct snd_pcm_hw_rule *rule)
2399 {
2400     snd_pcm_format_t k;
2401     const struct snd_interval *i =
2402                 hw_param_interval_c(params, rule->deps[0]);
2403     struct snd_mask m;
2404     struct snd_mask *mask = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
2405     snd_mask_any(&m);
2406     pcm_for_each_format(k) {
2407         int bits;
2408         if (!snd_mask_test_format(mask, k))
2409             continue;
2410         bits = snd_pcm_format_physical_width(k);
2411         if (bits <= 0)
2412             continue; /* ignore invalid formats */
2413         if ((unsigned)bits < i->min || (unsigned)bits > i->max)
2414             snd_mask_reset(&m, (__force unsigned)k);
2415     }
2416     return snd_mask_refine(mask, &m);
2417 }
2418 
2419 static int snd_pcm_hw_rule_sample_bits(struct snd_pcm_hw_params *params,
2420                        struct snd_pcm_hw_rule *rule)
2421 {
2422     struct snd_interval t;
2423     snd_pcm_format_t k;
2424 
2425     t.min = UINT_MAX;
2426     t.max = 0;
2427     t.openmin = 0;
2428     t.openmax = 0;
2429     pcm_for_each_format(k) {
2430         int bits;
2431         if (!snd_mask_test_format(hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT), k))
2432             continue;
2433         bits = snd_pcm_format_physical_width(k);
2434         if (bits <= 0)
2435             continue; /* ignore invalid formats */
2436         if (t.min > (unsigned)bits)
2437             t.min = bits;
2438         if (t.max < (unsigned)bits)
2439             t.max = bits;
2440     }
2441     t.integer = 1;
2442     return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2443 }
2444 
2445 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
2446 #error "Change this table"
2447 #endif
2448 
2449 static const unsigned int rates[] = {
2450     5512, 8000, 11025, 16000, 22050, 32000, 44100,
2451     48000, 64000, 88200, 96000, 176400, 192000, 352800, 384000
2452 };
2453 
2454 const struct snd_pcm_hw_constraint_list snd_pcm_known_rates = {
2455     .count = ARRAY_SIZE(rates),
2456     .list = rates,
2457 };
2458 
2459 static int snd_pcm_hw_rule_rate(struct snd_pcm_hw_params *params,
2460                 struct snd_pcm_hw_rule *rule)
2461 {
2462     struct snd_pcm_hardware *hw = rule->private;
2463     return snd_interval_list(hw_param_interval(params, rule->var),
2464                  snd_pcm_known_rates.count,
2465                  snd_pcm_known_rates.list, hw->rates);
2466 }       
2467 
2468 static int snd_pcm_hw_rule_buffer_bytes_max(struct snd_pcm_hw_params *params,
2469                         struct snd_pcm_hw_rule *rule)
2470 {
2471     struct snd_interval t;
2472     struct snd_pcm_substream *substream = rule->private;
2473     t.min = 0;
2474     t.max = substream->buffer_bytes_max;
2475     t.openmin = 0;
2476     t.openmax = 0;
2477     t.integer = 1;
2478     return snd_interval_refine(hw_param_interval(params, rule->var), &t);
2479 }       
2480 
2481 static int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream)
2482 {
2483     struct snd_pcm_runtime *runtime = substream->runtime;
2484     struct snd_pcm_hw_constraints *constrs = &runtime->hw_constraints;
2485     int k, err;
2486 
2487     for (k = SNDRV_PCM_HW_PARAM_FIRST_MASK; k <= SNDRV_PCM_HW_PARAM_LAST_MASK; k++) {
2488         snd_mask_any(constrs_mask(constrs, k));
2489     }
2490 
2491     for (k = SNDRV_PCM_HW_PARAM_FIRST_INTERVAL; k <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL; k++) {
2492         snd_interval_any(constrs_interval(constrs, k));
2493     }
2494 
2495     snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_CHANNELS));
2496     snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_SIZE));
2497     snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_BUFFER_BYTES));
2498     snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_SAMPLE_BITS));
2499     snd_interval_setinteger(constrs_interval(constrs, SNDRV_PCM_HW_PARAM_FRAME_BITS));
2500 
2501     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FORMAT,
2502                    snd_pcm_hw_rule_format, NULL,
2503                    SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2504     if (err < 0)
2505         return err;
2506     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, 
2507                   snd_pcm_hw_rule_sample_bits, NULL,
2508                   SNDRV_PCM_HW_PARAM_FORMAT, 
2509                   SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2510     if (err < 0)
2511         return err;
2512     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, 
2513                   snd_pcm_hw_rule_div, NULL,
2514                   SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2515     if (err < 0)
2516         return err;
2517     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS, 
2518                   snd_pcm_hw_rule_mul, NULL,
2519                   SNDRV_PCM_HW_PARAM_SAMPLE_BITS, SNDRV_PCM_HW_PARAM_CHANNELS, -1);
2520     if (err < 0)
2521         return err;
2522     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS, 
2523                   snd_pcm_hw_rule_mulkdiv, (void*) 8,
2524                   SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2525     if (err < 0)
2526         return err;
2527     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_FRAME_BITS, 
2528                   snd_pcm_hw_rule_mulkdiv, (void*) 8,
2529                   SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, -1);
2530     if (err < 0)
2531         return err;
2532     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_CHANNELS, 
2533                   snd_pcm_hw_rule_div, NULL,
2534                   SNDRV_PCM_HW_PARAM_FRAME_BITS, SNDRV_PCM_HW_PARAM_SAMPLE_BITS, -1);
2535     if (err < 0)
2536         return err;
2537     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, 
2538                   snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2539                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_TIME, -1);
2540     if (err < 0)
2541         return err;
2542     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, 
2543                   snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2544                   SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_BUFFER_TIME, -1);
2545     if (err < 0)
2546         return err;
2547     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIODS, 
2548                   snd_pcm_hw_rule_div, NULL,
2549                   SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, -1);
2550     if (err < 0)
2551         return err;
2552     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, 
2553                   snd_pcm_hw_rule_div, NULL,
2554                   SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2555     if (err < 0)
2556         return err;
2557     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, 
2558                   snd_pcm_hw_rule_mulkdiv, (void*) 8,
2559                   SNDRV_PCM_HW_PARAM_PERIOD_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2560     if (err < 0)
2561         return err;
2562     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_SIZE, 
2563                   snd_pcm_hw_rule_muldivk, (void*) 1000000,
2564                   SNDRV_PCM_HW_PARAM_PERIOD_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2565     if (err < 0)
2566         return err;
2567     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, 
2568                   snd_pcm_hw_rule_mul, NULL,
2569                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_PERIODS, -1);
2570     if (err < 0)
2571         return err;
2572     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, 
2573                   snd_pcm_hw_rule_mulkdiv, (void*) 8,
2574                   SNDRV_PCM_HW_PARAM_BUFFER_BYTES, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2575     if (err < 0)
2576         return err;
2577     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_SIZE, 
2578                   snd_pcm_hw_rule_muldivk, (void*) 1000000,
2579                   SNDRV_PCM_HW_PARAM_BUFFER_TIME, SNDRV_PCM_HW_PARAM_RATE, -1);
2580     if (err < 0)
2581         return err;
2582     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_BYTES, 
2583                   snd_pcm_hw_rule_muldivk, (void*) 8,
2584                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2585     if (err < 0)
2586         return err;
2587     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 
2588                   snd_pcm_hw_rule_muldivk, (void*) 8,
2589                   SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_FRAME_BITS, -1);
2590     if (err < 0)
2591         return err;
2592     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_PERIOD_TIME, 
2593                   snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2594                   SNDRV_PCM_HW_PARAM_PERIOD_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2595     if (err < 0)
2596         return err;
2597     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_TIME, 
2598                   snd_pcm_hw_rule_mulkdiv, (void*) 1000000,
2599                   SNDRV_PCM_HW_PARAM_BUFFER_SIZE, SNDRV_PCM_HW_PARAM_RATE, -1);
2600     if (err < 0)
2601         return err;
2602     return 0;
2603 }
2604 
2605 static int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream)
2606 {
2607     struct snd_pcm_runtime *runtime = substream->runtime;
2608     struct snd_pcm_hardware *hw = &runtime->hw;
2609     int err;
2610     unsigned int mask = 0;
2611 
2612         if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2613         mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_INTERLEAVED);
2614         if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2615         mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_RW_NONINTERLEAVED);
2616     if (hw_support_mmap(substream)) {
2617         if (hw->info & SNDRV_PCM_INFO_INTERLEAVED)
2618             mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_INTERLEAVED);
2619         if (hw->info & SNDRV_PCM_INFO_NONINTERLEAVED)
2620             mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_NONINTERLEAVED);
2621         if (hw->info & SNDRV_PCM_INFO_COMPLEX)
2622             mask |= PARAM_MASK_BIT(SNDRV_PCM_ACCESS_MMAP_COMPLEX);
2623     }
2624     err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_ACCESS, mask);
2625     if (err < 0)
2626         return err;
2627 
2628     err = snd_pcm_hw_constraint_mask64(runtime, SNDRV_PCM_HW_PARAM_FORMAT, hw->formats);
2629     if (err < 0)
2630         return err;
2631 
2632     err = snd_pcm_hw_constraint_mask(runtime, SNDRV_PCM_HW_PARAM_SUBFORMAT,
2633                      PARAM_MASK_BIT(SNDRV_PCM_SUBFORMAT_STD));
2634     if (err < 0)
2635         return err;
2636 
2637     err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_CHANNELS,
2638                        hw->channels_min, hw->channels_max);
2639     if (err < 0)
2640         return err;
2641 
2642     err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_RATE,
2643                        hw->rate_min, hw->rate_max);
2644     if (err < 0)
2645         return err;
2646 
2647     err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIOD_BYTES,
2648                        hw->period_bytes_min, hw->period_bytes_max);
2649     if (err < 0)
2650         return err;
2651 
2652     err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_PERIODS,
2653                        hw->periods_min, hw->periods_max);
2654     if (err < 0)
2655         return err;
2656 
2657     err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES,
2658                        hw->period_bytes_min, hw->buffer_bytes_max);
2659     if (err < 0)
2660         return err;
2661 
2662     err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 
2663                   snd_pcm_hw_rule_buffer_bytes_max, substream,
2664                   SNDRV_PCM_HW_PARAM_BUFFER_BYTES, -1);
2665     if (err < 0)
2666         return err;
2667 
2668     /* FIXME: remove */
2669     if (runtime->dma_bytes) {
2670         err = snd_pcm_hw_constraint_minmax(runtime, SNDRV_PCM_HW_PARAM_BUFFER_BYTES, 0, runtime->dma_bytes);
2671         if (err < 0)
2672             return err;
2673     }
2674 
2675     if (!(hw->rates & (SNDRV_PCM_RATE_KNOT | SNDRV_PCM_RATE_CONTINUOUS))) {
2676         err = snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, 
2677                       snd_pcm_hw_rule_rate, hw,
2678                       SNDRV_PCM_HW_PARAM_RATE, -1);
2679         if (err < 0)
2680             return err;
2681     }
2682 
2683     /* FIXME: this belong to lowlevel */
2684     snd_pcm_hw_constraint_integer(runtime, SNDRV_PCM_HW_PARAM_PERIOD_SIZE);
2685 
2686     return 0;
2687 }
2688 
2689 static void pcm_release_private(struct snd_pcm_substream *substream)
2690 {
2691     if (snd_pcm_stream_linked(substream))
2692         snd_pcm_unlink(substream);
2693 }
2694 
2695 void snd_pcm_release_substream(struct snd_pcm_substream *substream)
2696 {
2697     substream->ref_count--;
2698     if (substream->ref_count > 0)
2699         return;
2700 
2701     snd_pcm_drop(substream);
2702     if (substream->hw_opened) {
2703         if (substream->runtime->status->state != SNDRV_PCM_STATE_OPEN)
2704             do_hw_free(substream);
2705         substream->ops->close(substream);
2706         substream->hw_opened = 0;
2707     }
2708     if (cpu_latency_qos_request_active(&substream->latency_pm_qos_req))
2709         cpu_latency_qos_remove_request(&substream->latency_pm_qos_req);
2710     if (substream->pcm_release) {
2711         substream->pcm_release(substream);
2712         substream->pcm_release = NULL;
2713     }
2714     snd_pcm_detach_substream(substream);
2715 }
2716 EXPORT_SYMBOL(snd_pcm_release_substream);
2717 
2718 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream,
2719                struct file *file,
2720                struct snd_pcm_substream **rsubstream)
2721 {
2722     struct snd_pcm_substream *substream;
2723     int err;
2724 
2725     err = snd_pcm_attach_substream(pcm, stream, file, &substream);
2726     if (err < 0)
2727         return err;
2728     if (substream->ref_count > 1) {
2729         *rsubstream = substream;
2730         return 0;
2731     }
2732 
2733     err = snd_pcm_hw_constraints_init(substream);
2734     if (err < 0) {
2735         pcm_dbg(pcm, "snd_pcm_hw_constraints_init failed\n");
2736         goto error;
2737     }
2738 
2739     err = substream->ops->open(substream);
2740     if (err < 0)
2741         goto error;
2742 
2743     substream->hw_opened = 1;
2744 
2745     err = snd_pcm_hw_constraints_complete(substream);
2746     if (err < 0) {
2747         pcm_dbg(pcm, "snd_pcm_hw_constraints_complete failed\n");
2748         goto error;
2749     }
2750 
2751     /* automatically set EXPLICIT_SYNC flag in the managed mode whenever
2752      * the DMA buffer requires it
2753      */
2754     if (substream->managed_buffer_alloc &&
2755         substream->dma_buffer.dev.need_sync)
2756         substream->runtime->hw.info |= SNDRV_PCM_INFO_EXPLICIT_SYNC;
2757 
2758     *rsubstream = substream;
2759     return 0;
2760 
2761  error:
2762     snd_pcm_release_substream(substream);
2763     return err;
2764 }
2765 EXPORT_SYMBOL(snd_pcm_open_substream);
2766 
2767 static int snd_pcm_open_file(struct file *file,
2768                  struct snd_pcm *pcm,
2769                  int stream)
2770 {
2771     struct snd_pcm_file *pcm_file;
2772     struct snd_pcm_substream *substream;
2773     int err;
2774 
2775     err = snd_pcm_open_substream(pcm, stream, file, &substream);
2776     if (err < 0)
2777         return err;
2778 
2779     pcm_file = kzalloc(sizeof(*pcm_file), GFP_KERNEL);
2780     if (pcm_file == NULL) {
2781         snd_pcm_release_substream(substream);
2782         return -ENOMEM;
2783     }
2784     pcm_file->substream = substream;
2785     if (substream->ref_count == 1)
2786         substream->pcm_release = pcm_release_private;
2787     file->private_data = pcm_file;
2788 
2789     return 0;
2790 }
2791 
2792 static int snd_pcm_playback_open(struct inode *inode, struct file *file)
2793 {
2794     struct snd_pcm *pcm;
2795     int err = nonseekable_open(inode, file);
2796     if (err < 0)
2797         return err;
2798     pcm = snd_lookup_minor_data(iminor(inode),
2799                     SNDRV_DEVICE_TYPE_PCM_PLAYBACK);
2800     err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_PLAYBACK);
2801     if (pcm)
2802         snd_card_unref(pcm->card);
2803     return err;
2804 }
2805 
2806 static int snd_pcm_capture_open(struct inode *inode, struct file *file)
2807 {
2808     struct snd_pcm *pcm;
2809     int err = nonseekable_open(inode, file);
2810     if (err < 0)
2811         return err;
2812     pcm = snd_lookup_minor_data(iminor(inode),
2813                     SNDRV_DEVICE_TYPE_PCM_CAPTURE);
2814     err = snd_pcm_open(file, pcm, SNDRV_PCM_STREAM_CAPTURE);
2815     if (pcm)
2816         snd_card_unref(pcm->card);
2817     return err;
2818 }
2819 
2820 static int snd_pcm_open(struct file *file, struct snd_pcm *pcm, int stream)
2821 {
2822     int err;
2823     wait_queue_entry_t wait;
2824 
2825     if (pcm == NULL) {
2826         err = -ENODEV;
2827         goto __error1;
2828     }
2829     err = snd_card_file_add(pcm->card, file);
2830     if (err < 0)
2831         goto __error1;
2832     if (!try_module_get(pcm->card->module)) {
2833         err = -EFAULT;
2834         goto __error2;
2835     }
2836     init_waitqueue_entry(&wait, current);
2837     add_wait_queue(&pcm->open_wait, &wait);
2838     mutex_lock(&pcm->open_mutex);
2839     while (1) {
2840         err = snd_pcm_open_file(file, pcm, stream);
2841         if (err >= 0)
2842             break;
2843         if (err == -EAGAIN) {
2844             if (file->f_flags & O_NONBLOCK) {
2845                 err = -EBUSY;
2846                 break;
2847             }
2848         } else
2849             break;
2850         set_current_state(TASK_INTERRUPTIBLE);
2851         mutex_unlock(&pcm->open_mutex);
2852         schedule();
2853         mutex_lock(&pcm->open_mutex);
2854         if (pcm->card->shutdown) {
2855             err = -ENODEV;
2856             break;
2857         }
2858         if (signal_pending(current)) {
2859             err = -ERESTARTSYS;
2860             break;
2861         }
2862     }
2863     remove_wait_queue(&pcm->open_wait, &wait);
2864     mutex_unlock(&pcm->open_mutex);
2865     if (err < 0)
2866         goto __error;
2867     return err;
2868 
2869       __error:
2870     module_put(pcm->card->module);
2871       __error2:
2872         snd_card_file_remove(pcm->card, file);
2873       __error1:
2874         return err;
2875 }
2876 
2877 static int snd_pcm_release(struct inode *inode, struct file *file)
2878 {
2879     struct snd_pcm *pcm;
2880     struct snd_pcm_substream *substream;
2881     struct snd_pcm_file *pcm_file;
2882 
2883     pcm_file = file->private_data;
2884     substream = pcm_file->substream;
2885     if (snd_BUG_ON(!substream))
2886         return -ENXIO;
2887     pcm = substream->pcm;
2888 
2889     /* block until the device gets woken up as it may touch the hardware */
2890     snd_power_wait(pcm->card);
2891 
2892     mutex_lock(&pcm->open_mutex);
2893     snd_pcm_release_substream(substream);
2894     kfree(pcm_file);
2895     mutex_unlock(&pcm->open_mutex);
2896     wake_up(&pcm->open_wait);
2897     module_put(pcm->card->module);
2898     snd_card_file_remove(pcm->card, file);
2899     return 0;
2900 }
2901 
2902 /* check and update PCM state; return 0 or a negative error
2903  * call this inside PCM lock
2904  */
2905 static int do_pcm_hwsync(struct snd_pcm_substream *substream)
2906 {
2907     switch (substream->runtime->status->state) {
2908     case SNDRV_PCM_STATE_DRAINING:
2909         if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
2910             return -EBADFD;
2911         fallthrough;
2912     case SNDRV_PCM_STATE_RUNNING:
2913         return snd_pcm_update_hw_ptr(substream);
2914     case SNDRV_PCM_STATE_PREPARED:
2915     case SNDRV_PCM_STATE_PAUSED:
2916         return 0;
2917     case SNDRV_PCM_STATE_SUSPENDED:
2918         return -ESTRPIPE;
2919     case SNDRV_PCM_STATE_XRUN:
2920         return -EPIPE;
2921     default:
2922         return -EBADFD;
2923     }
2924 }
2925 
2926 /* increase the appl_ptr; returns the processed frames or a negative error */
2927 static snd_pcm_sframes_t forward_appl_ptr(struct snd_pcm_substream *substream,
2928                       snd_pcm_uframes_t frames,
2929                        snd_pcm_sframes_t avail)
2930 {
2931     struct snd_pcm_runtime *runtime = substream->runtime;
2932     snd_pcm_sframes_t appl_ptr;
2933     int ret;
2934 
2935     if (avail <= 0)
2936         return 0;
2937     if (frames > (snd_pcm_uframes_t)avail)
2938         frames = avail;
2939     appl_ptr = runtime->control->appl_ptr + frames;
2940     if (appl_ptr >= (snd_pcm_sframes_t)runtime->boundary)
2941         appl_ptr -= runtime->boundary;
2942     ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2943     return ret < 0 ? ret : frames;
2944 }
2945 
2946 /* decrease the appl_ptr; returns the processed frames or zero for error */
2947 static snd_pcm_sframes_t rewind_appl_ptr(struct snd_pcm_substream *substream,
2948                      snd_pcm_uframes_t frames,
2949                      snd_pcm_sframes_t avail)
2950 {
2951     struct snd_pcm_runtime *runtime = substream->runtime;
2952     snd_pcm_sframes_t appl_ptr;
2953     int ret;
2954 
2955     if (avail <= 0)
2956         return 0;
2957     if (frames > (snd_pcm_uframes_t)avail)
2958         frames = avail;
2959     appl_ptr = runtime->control->appl_ptr - frames;
2960     if (appl_ptr < 0)
2961         appl_ptr += runtime->boundary;
2962     ret = pcm_lib_apply_appl_ptr(substream, appl_ptr);
2963     /* NOTE: we return zero for errors because PulseAudio gets depressed
2964      * upon receiving an error from rewind ioctl and stops processing
2965      * any longer.  Returning zero means that no rewind is done, so
2966      * it's not absolutely wrong to answer like that.
2967      */
2968     return ret < 0 ? 0 : frames;
2969 }
2970 
2971 static snd_pcm_sframes_t snd_pcm_rewind(struct snd_pcm_substream *substream,
2972                     snd_pcm_uframes_t frames)
2973 {
2974     snd_pcm_sframes_t ret;
2975 
2976     if (frames == 0)
2977         return 0;
2978 
2979     snd_pcm_stream_lock_irq(substream);
2980     ret = do_pcm_hwsync(substream);
2981     if (!ret)
2982         ret = rewind_appl_ptr(substream, frames,
2983                       snd_pcm_hw_avail(substream));
2984     snd_pcm_stream_unlock_irq(substream);
2985     if (ret >= 0)
2986         snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
2987     return ret;
2988 }
2989 
2990 static snd_pcm_sframes_t snd_pcm_forward(struct snd_pcm_substream *substream,
2991                      snd_pcm_uframes_t frames)
2992 {
2993     snd_pcm_sframes_t ret;
2994 
2995     if (frames == 0)
2996         return 0;
2997 
2998     snd_pcm_stream_lock_irq(substream);
2999     ret = do_pcm_hwsync(substream);
3000     if (!ret)
3001         ret = forward_appl_ptr(substream, frames,
3002                        snd_pcm_avail(substream));
3003     snd_pcm_stream_unlock_irq(substream);
3004     if (ret >= 0)
3005         snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3006     return ret;
3007 }
3008 
3009 static int snd_pcm_delay(struct snd_pcm_substream *substream,
3010              snd_pcm_sframes_t *delay)
3011 {
3012     int err;
3013 
3014     snd_pcm_stream_lock_irq(substream);
3015     err = do_pcm_hwsync(substream);
3016     if (delay && !err)
3017         *delay = snd_pcm_calc_delay(substream);
3018     snd_pcm_stream_unlock_irq(substream);
3019     snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_CPU);
3020 
3021     return err;
3022 }
3023         
3024 static inline int snd_pcm_hwsync(struct snd_pcm_substream *substream)
3025 {
3026     return snd_pcm_delay(substream, NULL);
3027 }
3028 
3029 static int snd_pcm_sync_ptr(struct snd_pcm_substream *substream,
3030                 struct snd_pcm_sync_ptr __user *_sync_ptr)
3031 {
3032     struct snd_pcm_runtime *runtime = substream->runtime;
3033     struct snd_pcm_sync_ptr sync_ptr;
3034     volatile struct snd_pcm_mmap_status *status;
3035     volatile struct snd_pcm_mmap_control *control;
3036     int err;
3037 
3038     memset(&sync_ptr, 0, sizeof(sync_ptr));
3039     if (get_user(sync_ptr.flags, (unsigned __user *)&(_sync_ptr->flags)))
3040         return -EFAULT;
3041     if (copy_from_user(&sync_ptr.c.control, &(_sync_ptr->c.control), sizeof(struct snd_pcm_mmap_control)))
3042         return -EFAULT; 
3043     status = runtime->status;
3044     control = runtime->control;
3045     if (sync_ptr.flags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3046         err = snd_pcm_hwsync(substream);
3047         if (err < 0)
3048             return err;
3049     }
3050     snd_pcm_stream_lock_irq(substream);
3051     if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL)) {
3052         err = pcm_lib_apply_appl_ptr(substream,
3053                          sync_ptr.c.control.appl_ptr);
3054         if (err < 0) {
3055             snd_pcm_stream_unlock_irq(substream);
3056             return err;
3057         }
3058     } else {
3059         sync_ptr.c.control.appl_ptr = control->appl_ptr;
3060     }
3061     if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3062         control->avail_min = sync_ptr.c.control.avail_min;
3063     else
3064         sync_ptr.c.control.avail_min = control->avail_min;
3065     sync_ptr.s.status.state = status->state;
3066     sync_ptr.s.status.hw_ptr = status->hw_ptr;
3067     sync_ptr.s.status.tstamp = status->tstamp;
3068     sync_ptr.s.status.suspended_state = status->suspended_state;
3069     sync_ptr.s.status.audio_tstamp = status->audio_tstamp;
3070     snd_pcm_stream_unlock_irq(substream);
3071     if (!(sync_ptr.flags & SNDRV_PCM_SYNC_PTR_APPL))
3072         snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3073     if (copy_to_user(_sync_ptr, &sync_ptr, sizeof(sync_ptr)))
3074         return -EFAULT;
3075     return 0;
3076 }
3077 
3078 struct snd_pcm_mmap_status32 {
3079     snd_pcm_state_t state;
3080     s32 pad1;
3081     u32 hw_ptr;
3082     s32 tstamp_sec;
3083     s32 tstamp_nsec;
3084     snd_pcm_state_t suspended_state;
3085     s32 audio_tstamp_sec;
3086     s32 audio_tstamp_nsec;
3087 } __attribute__((packed));
3088 
3089 struct snd_pcm_mmap_control32 {
3090     u32 appl_ptr;
3091     u32 avail_min;
3092 };
3093 
3094 struct snd_pcm_sync_ptr32 {
3095     u32 flags;
3096     union {
3097         struct snd_pcm_mmap_status32 status;
3098         unsigned char reserved[64];
3099     } s;
3100     union {
3101         struct snd_pcm_mmap_control32 control;
3102         unsigned char reserved[64];
3103     } c;
3104 } __attribute__((packed));
3105 
3106 /* recalcuate the boundary within 32bit */
3107 static snd_pcm_uframes_t recalculate_boundary(struct snd_pcm_runtime *runtime)
3108 {
3109     snd_pcm_uframes_t boundary;
3110 
3111     if (! runtime->buffer_size)
3112         return 0;
3113     boundary = runtime->buffer_size;
3114     while (boundary * 2 <= 0x7fffffffUL - runtime->buffer_size)
3115         boundary *= 2;
3116     return boundary;
3117 }
3118 
3119 static int snd_pcm_ioctl_sync_ptr_compat(struct snd_pcm_substream *substream,
3120                      struct snd_pcm_sync_ptr32 __user *src)
3121 {
3122     struct snd_pcm_runtime *runtime = substream->runtime;
3123     volatile struct snd_pcm_mmap_status *status;
3124     volatile struct snd_pcm_mmap_control *control;
3125     u32 sflags;
3126     struct snd_pcm_mmap_control scontrol;
3127     struct snd_pcm_mmap_status sstatus;
3128     snd_pcm_uframes_t boundary;
3129     int err;
3130 
3131     if (snd_BUG_ON(!runtime))
3132         return -EINVAL;
3133 
3134     if (get_user(sflags, &src->flags) ||
3135         get_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3136         get_user(scontrol.avail_min, &src->c.control.avail_min))
3137         return -EFAULT;
3138     if (sflags & SNDRV_PCM_SYNC_PTR_HWSYNC) {
3139         err = snd_pcm_hwsync(substream);
3140         if (err < 0)
3141             return err;
3142     }
3143     status = runtime->status;
3144     control = runtime->control;
3145     boundary = recalculate_boundary(runtime);
3146     if (! boundary)
3147         boundary = 0x7fffffff;
3148     snd_pcm_stream_lock_irq(substream);
3149     /* FIXME: we should consider the boundary for the sync from app */
3150     if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL)) {
3151         err = pcm_lib_apply_appl_ptr(substream,
3152                 scontrol.appl_ptr);
3153         if (err < 0) {
3154             snd_pcm_stream_unlock_irq(substream);
3155             return err;
3156         }
3157     } else
3158         scontrol.appl_ptr = control->appl_ptr % boundary;
3159     if (!(sflags & SNDRV_PCM_SYNC_PTR_AVAIL_MIN))
3160         control->avail_min = scontrol.avail_min;
3161     else
3162         scontrol.avail_min = control->avail_min;
3163     sstatus.state = status->state;
3164     sstatus.hw_ptr = status->hw_ptr % boundary;
3165     sstatus.tstamp = status->tstamp;
3166     sstatus.suspended_state = status->suspended_state;
3167     sstatus.audio_tstamp = status->audio_tstamp;
3168     snd_pcm_stream_unlock_irq(substream);
3169     if (!(sflags & SNDRV_PCM_SYNC_PTR_APPL))
3170         snd_pcm_dma_buffer_sync(substream, SNDRV_DMA_SYNC_DEVICE);
3171     if (put_user(sstatus.state, &src->s.status.state) ||
3172         put_user(sstatus.hw_ptr, &src->s.status.hw_ptr) ||
3173         put_user(sstatus.tstamp.tv_sec, &src->s.status.tstamp_sec) ||
3174         put_user(sstatus.tstamp.tv_nsec, &src->s.status.tstamp_nsec) ||
3175         put_user(sstatus.suspended_state, &src->s.status.suspended_state) ||
3176         put_user(sstatus.audio_tstamp.tv_sec, &src->s.status.audio_tstamp_sec) ||
3177         put_user(sstatus.audio_tstamp.tv_nsec, &src->s.status.audio_tstamp_nsec) ||
3178         put_user(scontrol.appl_ptr, &src->c.control.appl_ptr) ||
3179         put_user(scontrol.avail_min, &src->c.control.avail_min))
3180         return -EFAULT;
3181 
3182     return 0;
3183 }
3184 #define __SNDRV_PCM_IOCTL_SYNC_PTR32 _IOWR('A', 0x23, struct snd_pcm_sync_ptr32)
3185 
3186 static int snd_pcm_tstamp(struct snd_pcm_substream *substream, int __user *_arg)
3187 {
3188     struct snd_pcm_runtime *runtime = substream->runtime;
3189     int arg;
3190     
3191     if (get_user(arg, _arg))
3192         return -EFAULT;
3193     if (arg < 0 || arg > SNDRV_PCM_TSTAMP_TYPE_LAST)
3194         return -EINVAL;
3195     runtime->tstamp_type = arg;
3196     return 0;
3197 }
3198 
3199 static int snd_pcm_xferi_frames_ioctl(struct snd_pcm_substream *substream,
3200                       struct snd_xferi __user *_xferi)
3201 {
3202     struct snd_xferi xferi;
3203     struct snd_pcm_runtime *runtime = substream->runtime;
3204     snd_pcm_sframes_t result;
3205 
3206     if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3207         return -EBADFD;
3208     if (put_user(0, &_xferi->result))
3209         return -EFAULT;
3210     if (copy_from_user(&xferi, _xferi, sizeof(xferi)))
3211         return -EFAULT;
3212     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3213         result = snd_pcm_lib_write(substream, xferi.buf, xferi.frames);
3214     else
3215         result = snd_pcm_lib_read(substream, xferi.buf, xferi.frames);
3216     if (put_user(result, &_xferi->result))
3217         return -EFAULT;
3218     return result < 0 ? result : 0;
3219 }
3220 
3221 static int snd_pcm_xfern_frames_ioctl(struct snd_pcm_substream *substream,
3222                       struct snd_xfern __user *_xfern)
3223 {
3224     struct snd_xfern xfern;
3225     struct snd_pcm_runtime *runtime = substream->runtime;
3226     void *bufs;
3227     snd_pcm_sframes_t result;
3228 
3229     if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3230         return -EBADFD;
3231     if (runtime->channels > 128)
3232         return -EINVAL;
3233     if (put_user(0, &_xfern->result))
3234         return -EFAULT;
3235     if (copy_from_user(&xfern, _xfern, sizeof(xfern)))
3236         return -EFAULT;
3237 
3238     bufs = memdup_user(xfern.bufs, sizeof(void *) * runtime->channels);
3239     if (IS_ERR(bufs))
3240         return PTR_ERR(bufs);
3241     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3242         result = snd_pcm_lib_writev(substream, bufs, xfern.frames);
3243     else
3244         result = snd_pcm_lib_readv(substream, bufs, xfern.frames);
3245     kfree(bufs);
3246     if (put_user(result, &_xfern->result))
3247         return -EFAULT;
3248     return result < 0 ? result : 0;
3249 }
3250 
3251 static int snd_pcm_rewind_ioctl(struct snd_pcm_substream *substream,
3252                 snd_pcm_uframes_t __user *_frames)
3253 {
3254     snd_pcm_uframes_t frames;
3255     snd_pcm_sframes_t result;
3256 
3257     if (get_user(frames, _frames))
3258         return -EFAULT;
3259     if (put_user(0, _frames))
3260         return -EFAULT;
3261     result = snd_pcm_rewind(substream, frames);
3262     if (put_user(result, _frames))
3263         return -EFAULT;
3264     return result < 0 ? result : 0;
3265 }
3266 
3267 static int snd_pcm_forward_ioctl(struct snd_pcm_substream *substream,
3268                  snd_pcm_uframes_t __user *_frames)
3269 {
3270     snd_pcm_uframes_t frames;
3271     snd_pcm_sframes_t result;
3272 
3273     if (get_user(frames, _frames))
3274         return -EFAULT;
3275     if (put_user(0, _frames))
3276         return -EFAULT;
3277     result = snd_pcm_forward(substream, frames);
3278     if (put_user(result, _frames))
3279         return -EFAULT;
3280     return result < 0 ? result : 0;
3281 }
3282 
3283 static int snd_pcm_common_ioctl(struct file *file,
3284                  struct snd_pcm_substream *substream,
3285                  unsigned int cmd, void __user *arg)
3286 {
3287     struct snd_pcm_file *pcm_file = file->private_data;
3288     int res;
3289 
3290     if (PCM_RUNTIME_CHECK(substream))
3291         return -ENXIO;
3292 
3293     if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3294         return -EBADFD;
3295 
3296     res = snd_power_wait(substream->pcm->card);
3297     if (res < 0)
3298         return res;
3299 
3300     switch (cmd) {
3301     case SNDRV_PCM_IOCTL_PVERSION:
3302         return put_user(SNDRV_PCM_VERSION, (int __user *)arg) ? -EFAULT : 0;
3303     case SNDRV_PCM_IOCTL_INFO:
3304         return snd_pcm_info_user(substream, arg);
3305     case SNDRV_PCM_IOCTL_TSTAMP:    /* just for compatibility */
3306         return 0;
3307     case SNDRV_PCM_IOCTL_TTSTAMP:
3308         return snd_pcm_tstamp(substream, arg);
3309     case SNDRV_PCM_IOCTL_USER_PVERSION:
3310         if (get_user(pcm_file->user_pversion,
3311                  (unsigned int __user *)arg))
3312             return -EFAULT;
3313         return 0;
3314     case SNDRV_PCM_IOCTL_HW_REFINE:
3315         return snd_pcm_hw_refine_user(substream, arg);
3316     case SNDRV_PCM_IOCTL_HW_PARAMS:
3317         return snd_pcm_hw_params_user(substream, arg);
3318     case SNDRV_PCM_IOCTL_HW_FREE:
3319         return snd_pcm_hw_free(substream);
3320     case SNDRV_PCM_IOCTL_SW_PARAMS:
3321         return snd_pcm_sw_params_user(substream, arg);
3322     case SNDRV_PCM_IOCTL_STATUS32:
3323         return snd_pcm_status_user32(substream, arg, false);
3324     case SNDRV_PCM_IOCTL_STATUS_EXT32:
3325         return snd_pcm_status_user32(substream, arg, true);
3326     case SNDRV_PCM_IOCTL_STATUS64:
3327         return snd_pcm_status_user64(substream, arg, false);
3328     case SNDRV_PCM_IOCTL_STATUS_EXT64:
3329         return snd_pcm_status_user64(substream, arg, true);
3330     case SNDRV_PCM_IOCTL_CHANNEL_INFO:
3331         return snd_pcm_channel_info_user(substream, arg);
3332     case SNDRV_PCM_IOCTL_PREPARE:
3333         return snd_pcm_prepare(substream, file);
3334     case SNDRV_PCM_IOCTL_RESET:
3335         return snd_pcm_reset(substream);
3336     case SNDRV_PCM_IOCTL_START:
3337         return snd_pcm_start_lock_irq(substream);
3338     case SNDRV_PCM_IOCTL_LINK:
3339         return snd_pcm_link(substream, (int)(unsigned long) arg);
3340     case SNDRV_PCM_IOCTL_UNLINK:
3341         return snd_pcm_unlink(substream);
3342     case SNDRV_PCM_IOCTL_RESUME:
3343         return snd_pcm_resume(substream);
3344     case SNDRV_PCM_IOCTL_XRUN:
3345         return snd_pcm_xrun(substream);
3346     case SNDRV_PCM_IOCTL_HWSYNC:
3347         return snd_pcm_hwsync(substream);
3348     case SNDRV_PCM_IOCTL_DELAY:
3349     {
3350         snd_pcm_sframes_t delay = 0;
3351         snd_pcm_sframes_t __user *res = arg;
3352         int err;
3353 
3354         err = snd_pcm_delay(substream, &delay);
3355         if (err)
3356             return err;
3357         if (put_user(delay, res))
3358             return -EFAULT;
3359         return 0;
3360     }
3361     case __SNDRV_PCM_IOCTL_SYNC_PTR32:
3362         return snd_pcm_ioctl_sync_ptr_compat(substream, arg);
3363     case __SNDRV_PCM_IOCTL_SYNC_PTR64:
3364         return snd_pcm_sync_ptr(substream, arg);
3365 #ifdef CONFIG_SND_SUPPORT_OLD_API
3366     case SNDRV_PCM_IOCTL_HW_REFINE_OLD:
3367         return snd_pcm_hw_refine_old_user(substream, arg);
3368     case SNDRV_PCM_IOCTL_HW_PARAMS_OLD:
3369         return snd_pcm_hw_params_old_user(substream, arg);
3370 #endif
3371     case SNDRV_PCM_IOCTL_DRAIN:
3372         return snd_pcm_drain(substream, file);
3373     case SNDRV_PCM_IOCTL_DROP:
3374         return snd_pcm_drop(substream);
3375     case SNDRV_PCM_IOCTL_PAUSE:
3376         return snd_pcm_pause_lock_irq(substream, (unsigned long)arg);
3377     case SNDRV_PCM_IOCTL_WRITEI_FRAMES:
3378     case SNDRV_PCM_IOCTL_READI_FRAMES:
3379         return snd_pcm_xferi_frames_ioctl(substream, arg);
3380     case SNDRV_PCM_IOCTL_WRITEN_FRAMES:
3381     case SNDRV_PCM_IOCTL_READN_FRAMES:
3382         return snd_pcm_xfern_frames_ioctl(substream, arg);
3383     case SNDRV_PCM_IOCTL_REWIND:
3384         return snd_pcm_rewind_ioctl(substream, arg);
3385     case SNDRV_PCM_IOCTL_FORWARD:
3386         return snd_pcm_forward_ioctl(substream, arg);
3387     }
3388     pcm_dbg(substream->pcm, "unknown ioctl = 0x%x\n", cmd);
3389     return -ENOTTY;
3390 }
3391 
3392 static long snd_pcm_ioctl(struct file *file, unsigned int cmd,
3393               unsigned long arg)
3394 {
3395     struct snd_pcm_file *pcm_file;
3396 
3397     pcm_file = file->private_data;
3398 
3399     if (((cmd >> 8) & 0xff) != 'A')
3400         return -ENOTTY;
3401 
3402     return snd_pcm_common_ioctl(file, pcm_file->substream, cmd,
3403                      (void __user *)arg);
3404 }
3405 
3406 /**
3407  * snd_pcm_kernel_ioctl - Execute PCM ioctl in the kernel-space
3408  * @substream: PCM substream
3409  * @cmd: IOCTL cmd
3410  * @arg: IOCTL argument
3411  *
3412  * The function is provided primarily for OSS layer and USB gadget drivers,
3413  * and it allows only the limited set of ioctls (hw_params, sw_params,
3414  * prepare, start, drain, drop, forward).
3415  *
3416  * Return: zero if successful, or a negative error code
3417  */
3418 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream,
3419              unsigned int cmd, void *arg)
3420 {
3421     snd_pcm_uframes_t *frames = arg;
3422     snd_pcm_sframes_t result;
3423     
3424     if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3425         return -EBADFD;
3426 
3427     switch (cmd) {
3428     case SNDRV_PCM_IOCTL_FORWARD:
3429     {
3430         /* provided only for OSS; capture-only and no value returned */
3431         if (substream->stream != SNDRV_PCM_STREAM_CAPTURE)
3432             return -EINVAL;
3433         result = snd_pcm_forward(substream, *frames);
3434         return result < 0 ? result : 0;
3435     }
3436     case SNDRV_PCM_IOCTL_HW_PARAMS:
3437         return snd_pcm_hw_params(substream, arg);
3438     case SNDRV_PCM_IOCTL_SW_PARAMS:
3439         return snd_pcm_sw_params(substream, arg);
3440     case SNDRV_PCM_IOCTL_PREPARE:
3441         return snd_pcm_prepare(substream, NULL);
3442     case SNDRV_PCM_IOCTL_START:
3443         return snd_pcm_start_lock_irq(substream);
3444     case SNDRV_PCM_IOCTL_DRAIN:
3445         return snd_pcm_drain(substream, NULL);
3446     case SNDRV_PCM_IOCTL_DROP:
3447         return snd_pcm_drop(substream);
3448     case SNDRV_PCM_IOCTL_DELAY:
3449         return snd_pcm_delay(substream, frames);
3450     default:
3451         return -EINVAL;
3452     }
3453 }
3454 EXPORT_SYMBOL(snd_pcm_kernel_ioctl);
3455 
3456 static ssize_t snd_pcm_read(struct file *file, char __user *buf, size_t count,
3457                 loff_t * offset)
3458 {
3459     struct snd_pcm_file *pcm_file;
3460     struct snd_pcm_substream *substream;
3461     struct snd_pcm_runtime *runtime;
3462     snd_pcm_sframes_t result;
3463 
3464     pcm_file = file->private_data;
3465     substream = pcm_file->substream;
3466     if (PCM_RUNTIME_CHECK(substream))
3467         return -ENXIO;
3468     runtime = substream->runtime;
3469     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3470         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3471         return -EBADFD;
3472     if (!frame_aligned(runtime, count))
3473         return -EINVAL;
3474     count = bytes_to_frames(runtime, count);
3475     result = snd_pcm_lib_read(substream, buf, count);
3476     if (result > 0)
3477         result = frames_to_bytes(runtime, result);
3478     return result;
3479 }
3480 
3481 static ssize_t snd_pcm_write(struct file *file, const char __user *buf,
3482                  size_t count, loff_t * offset)
3483 {
3484     struct snd_pcm_file *pcm_file;
3485     struct snd_pcm_substream *substream;
3486     struct snd_pcm_runtime *runtime;
3487     snd_pcm_sframes_t result;
3488 
3489     pcm_file = file->private_data;
3490     substream = pcm_file->substream;
3491     if (PCM_RUNTIME_CHECK(substream))
3492         return -ENXIO;
3493     runtime = substream->runtime;
3494     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3495         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3496         return -EBADFD;
3497     if (!frame_aligned(runtime, count))
3498         return -EINVAL;
3499     count = bytes_to_frames(runtime, count);
3500     result = snd_pcm_lib_write(substream, buf, count);
3501     if (result > 0)
3502         result = frames_to_bytes(runtime, result);
3503     return result;
3504 }
3505 
3506 static ssize_t snd_pcm_readv(struct kiocb *iocb, struct iov_iter *to)
3507 {
3508     struct snd_pcm_file *pcm_file;
3509     struct snd_pcm_substream *substream;
3510     struct snd_pcm_runtime *runtime;
3511     snd_pcm_sframes_t result;
3512     unsigned long i;
3513     void __user **bufs;
3514     snd_pcm_uframes_t frames;
3515 
3516     pcm_file = iocb->ki_filp->private_data;
3517     substream = pcm_file->substream;
3518     if (PCM_RUNTIME_CHECK(substream))
3519         return -ENXIO;
3520     runtime = substream->runtime;
3521     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3522         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3523         return -EBADFD;
3524     if (!iter_is_iovec(to))
3525         return -EINVAL;
3526     if (to->nr_segs > 1024 || to->nr_segs != runtime->channels)
3527         return -EINVAL;
3528     if (!frame_aligned(runtime, to->iov->iov_len))
3529         return -EINVAL;
3530     frames = bytes_to_samples(runtime, to->iov->iov_len);
3531     bufs = kmalloc_array(to->nr_segs, sizeof(void *), GFP_KERNEL);
3532     if (bufs == NULL)
3533         return -ENOMEM;
3534     for (i = 0; i < to->nr_segs; ++i)
3535         bufs[i] = to->iov[i].iov_base;
3536     result = snd_pcm_lib_readv(substream, bufs, frames);
3537     if (result > 0)
3538         result = frames_to_bytes(runtime, result);
3539     kfree(bufs);
3540     return result;
3541 }
3542 
3543 static ssize_t snd_pcm_writev(struct kiocb *iocb, struct iov_iter *from)
3544 {
3545     struct snd_pcm_file *pcm_file;
3546     struct snd_pcm_substream *substream;
3547     struct snd_pcm_runtime *runtime;
3548     snd_pcm_sframes_t result;
3549     unsigned long i;
3550     void __user **bufs;
3551     snd_pcm_uframes_t frames;
3552 
3553     pcm_file = iocb->ki_filp->private_data;
3554     substream = pcm_file->substream;
3555     if (PCM_RUNTIME_CHECK(substream))
3556         return -ENXIO;
3557     runtime = substream->runtime;
3558     if (runtime->status->state == SNDRV_PCM_STATE_OPEN ||
3559         runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3560         return -EBADFD;
3561     if (!iter_is_iovec(from))
3562         return -EINVAL;
3563     if (from->nr_segs > 128 || from->nr_segs != runtime->channels ||
3564         !frame_aligned(runtime, from->iov->iov_len))
3565         return -EINVAL;
3566     frames = bytes_to_samples(runtime, from->iov->iov_len);
3567     bufs = kmalloc_array(from->nr_segs, sizeof(void *), GFP_KERNEL);
3568     if (bufs == NULL)
3569         return -ENOMEM;
3570     for (i = 0; i < from->nr_segs; ++i)
3571         bufs[i] = from->iov[i].iov_base;
3572     result = snd_pcm_lib_writev(substream, bufs, frames);
3573     if (result > 0)
3574         result = frames_to_bytes(runtime, result);
3575     kfree(bufs);
3576     return result;
3577 }
3578 
3579 static __poll_t snd_pcm_poll(struct file *file, poll_table *wait)
3580 {
3581     struct snd_pcm_file *pcm_file;
3582     struct snd_pcm_substream *substream;
3583     struct snd_pcm_runtime *runtime;
3584     __poll_t mask, ok;
3585     snd_pcm_uframes_t avail;
3586 
3587     pcm_file = file->private_data;
3588 
3589     substream = pcm_file->substream;
3590     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
3591         ok = EPOLLOUT | EPOLLWRNORM;
3592     else
3593         ok = EPOLLIN | EPOLLRDNORM;
3594     if (PCM_RUNTIME_CHECK(substream))
3595         return ok | EPOLLERR;
3596 
3597     runtime = substream->runtime;
3598     if (runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3599         return ok | EPOLLERR;
3600 
3601     poll_wait(file, &runtime->sleep, wait);
3602 
3603     mask = 0;
3604     snd_pcm_stream_lock_irq(substream);
3605     avail = snd_pcm_avail(substream);
3606     switch (runtime->status->state) {
3607     case SNDRV_PCM_STATE_RUNNING:
3608     case SNDRV_PCM_STATE_PREPARED:
3609     case SNDRV_PCM_STATE_PAUSED:
3610         if (avail >= runtime->control->avail_min)
3611             mask = ok;
3612         break;
3613     case SNDRV_PCM_STATE_DRAINING:
3614         if (substream->stream == SNDRV_PCM_STREAM_CAPTURE) {
3615             mask = ok;
3616             if (!avail)
3617                 mask |= EPOLLERR;
3618         }
3619         break;
3620     default:
3621         mask = ok | EPOLLERR;
3622         break;
3623     }
3624     snd_pcm_stream_unlock_irq(substream);
3625     return mask;
3626 }
3627 
3628 /*
3629  * mmap support
3630  */
3631 
3632 /*
3633  * Only on coherent architectures, we can mmap the status and the control records
3634  * for effcient data transfer.  On others, we have to use HWSYNC ioctl...
3635  */
3636 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
3637 /*
3638  * mmap status record
3639  */
3640 static vm_fault_t snd_pcm_mmap_status_fault(struct vm_fault *vmf)
3641 {
3642     struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3643     struct snd_pcm_runtime *runtime;
3644     
3645     if (substream == NULL)
3646         return VM_FAULT_SIGBUS;
3647     runtime = substream->runtime;
3648     vmf->page = virt_to_page(runtime->status);
3649     get_page(vmf->page);
3650     return 0;
3651 }
3652 
3653 static const struct vm_operations_struct snd_pcm_vm_ops_status =
3654 {
3655     .fault =    snd_pcm_mmap_status_fault,
3656 };
3657 
3658 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3659                    struct vm_area_struct *area)
3660 {
3661     long size;
3662     if (!(area->vm_flags & VM_READ))
3663         return -EINVAL;
3664     size = area->vm_end - area->vm_start;
3665     if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_status)))
3666         return -EINVAL;
3667     area->vm_ops = &snd_pcm_vm_ops_status;
3668     area->vm_private_data = substream;
3669     area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3670     return 0;
3671 }
3672 
3673 /*
3674  * mmap control record
3675  */
3676 static vm_fault_t snd_pcm_mmap_control_fault(struct vm_fault *vmf)
3677 {
3678     struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3679     struct snd_pcm_runtime *runtime;
3680     
3681     if (substream == NULL)
3682         return VM_FAULT_SIGBUS;
3683     runtime = substream->runtime;
3684     vmf->page = virt_to_page(runtime->control);
3685     get_page(vmf->page);
3686     return 0;
3687 }
3688 
3689 static const struct vm_operations_struct snd_pcm_vm_ops_control =
3690 {
3691     .fault =    snd_pcm_mmap_control_fault,
3692 };
3693 
3694 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3695                 struct vm_area_struct *area)
3696 {
3697     long size;
3698     if (!(area->vm_flags & VM_READ))
3699         return -EINVAL;
3700     size = area->vm_end - area->vm_start;
3701     if (size != PAGE_ALIGN(sizeof(struct snd_pcm_mmap_control)))
3702         return -EINVAL;
3703     area->vm_ops = &snd_pcm_vm_ops_control;
3704     area->vm_private_data = substream;
3705     area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3706     return 0;
3707 }
3708 
3709 static bool pcm_status_mmap_allowed(struct snd_pcm_file *pcm_file)
3710 {
3711     /* If drivers require the explicit sync (typically for non-coherent
3712      * pages), we have to disable the mmap of status and control data
3713      * to enforce the control via SYNC_PTR ioctl.
3714      */
3715     if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3716         return false;
3717     /* See pcm_control_mmap_allowed() below.
3718      * Since older alsa-lib requires both status and control mmaps to be
3719      * coupled, we have to disable the status mmap for old alsa-lib, too.
3720      */
3721     if (pcm_file->user_pversion < SNDRV_PROTOCOL_VERSION(2, 0, 14) &&
3722         (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR))
3723         return false;
3724     return true;
3725 }
3726 
3727 static bool pcm_control_mmap_allowed(struct snd_pcm_file *pcm_file)
3728 {
3729     if (pcm_file->no_compat_mmap)
3730         return false;
3731     /* see above */
3732     if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_EXPLICIT_SYNC)
3733         return false;
3734     /* Disallow the control mmap when SYNC_APPLPTR flag is set;
3735      * it enforces the user-space to fall back to snd_pcm_sync_ptr(),
3736      * thus it effectively assures the manual update of appl_ptr.
3737      */
3738     if (pcm_file->substream->runtime->hw.info & SNDRV_PCM_INFO_SYNC_APPLPTR)
3739         return false;
3740     return true;
3741 }
3742 
3743 #else /* ! coherent mmap */
3744 /*
3745  * don't support mmap for status and control records.
3746  */
3747 #define pcm_status_mmap_allowed(pcm_file)   false
3748 #define pcm_control_mmap_allowed(pcm_file)  false
3749 
3750 static int snd_pcm_mmap_status(struct snd_pcm_substream *substream, struct file *file,
3751                    struct vm_area_struct *area)
3752 {
3753     return -ENXIO;
3754 }
3755 static int snd_pcm_mmap_control(struct snd_pcm_substream *substream, struct file *file,
3756                 struct vm_area_struct *area)
3757 {
3758     return -ENXIO;
3759 }
3760 #endif /* coherent mmap */
3761 
3762 /*
3763  * fault callback for mmapping a RAM page
3764  */
3765 static vm_fault_t snd_pcm_mmap_data_fault(struct vm_fault *vmf)
3766 {
3767     struct snd_pcm_substream *substream = vmf->vma->vm_private_data;
3768     struct snd_pcm_runtime *runtime;
3769     unsigned long offset;
3770     struct page * page;
3771     size_t dma_bytes;
3772     
3773     if (substream == NULL)
3774         return VM_FAULT_SIGBUS;
3775     runtime = substream->runtime;
3776     offset = vmf->pgoff << PAGE_SHIFT;
3777     dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3778     if (offset > dma_bytes - PAGE_SIZE)
3779         return VM_FAULT_SIGBUS;
3780     if (substream->ops->page)
3781         page = substream->ops->page(substream, offset);
3782     else if (!snd_pcm_get_dma_buf(substream))
3783         page = virt_to_page(runtime->dma_area + offset);
3784     else
3785         page = snd_sgbuf_get_page(snd_pcm_get_dma_buf(substream), offset);
3786     if (!page)
3787         return VM_FAULT_SIGBUS;
3788     get_page(page);
3789     vmf->page = page;
3790     return 0;
3791 }
3792 
3793 static const struct vm_operations_struct snd_pcm_vm_ops_data = {
3794     .open =     snd_pcm_mmap_data_open,
3795     .close =    snd_pcm_mmap_data_close,
3796 };
3797 
3798 static const struct vm_operations_struct snd_pcm_vm_ops_data_fault = {
3799     .open =     snd_pcm_mmap_data_open,
3800     .close =    snd_pcm_mmap_data_close,
3801     .fault =    snd_pcm_mmap_data_fault,
3802 };
3803 
3804 /*
3805  * mmap the DMA buffer on RAM
3806  */
3807 
3808 /**
3809  * snd_pcm_lib_default_mmap - Default PCM data mmap function
3810  * @substream: PCM substream
3811  * @area: VMA
3812  *
3813  * This is the default mmap handler for PCM data.  When mmap pcm_ops is NULL,
3814  * this function is invoked implicitly.
3815  *
3816  * Return: zero if successful, or a negative error code
3817  */
3818 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
3819                  struct vm_area_struct *area)
3820 {
3821     area->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP;
3822     if (!substream->ops->page &&
3823         !snd_dma_buffer_mmap(snd_pcm_get_dma_buf(substream), area))
3824         return 0;
3825     /* mmap with fault handler */
3826     area->vm_ops = &snd_pcm_vm_ops_data_fault;
3827     return 0;
3828 }
3829 EXPORT_SYMBOL_GPL(snd_pcm_lib_default_mmap);
3830 
3831 /*
3832  * mmap the DMA buffer on I/O memory area
3833  */
3834 #if SNDRV_PCM_INFO_MMAP_IOMEM
3835 /**
3836  * snd_pcm_lib_mmap_iomem - Default PCM data mmap function for I/O mem
3837  * @substream: PCM substream
3838  * @area: VMA
3839  *
3840  * When your hardware uses the iomapped pages as the hardware buffer and
3841  * wants to mmap it, pass this function as mmap pcm_ops.  Note that this
3842  * is supposed to work only on limited architectures.
3843  *
3844  * Return: zero if successful, or a negative error code
3845  */
3846 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream,
3847                struct vm_area_struct *area)
3848 {
3849     struct snd_pcm_runtime *runtime = substream->runtime;
3850 
3851     area->vm_page_prot = pgprot_noncached(area->vm_page_prot);
3852     return vm_iomap_memory(area, runtime->dma_addr, runtime->dma_bytes);
3853 }
3854 EXPORT_SYMBOL(snd_pcm_lib_mmap_iomem);
3855 #endif /* SNDRV_PCM_INFO_MMAP */
3856 
3857 /*
3858  * mmap DMA buffer
3859  */
3860 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file,
3861               struct vm_area_struct *area)
3862 {
3863     struct snd_pcm_runtime *runtime;
3864     long size;
3865     unsigned long offset;
3866     size_t dma_bytes;
3867     int err;
3868 
3869     if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
3870         if (!(area->vm_flags & (VM_WRITE|VM_READ)))
3871             return -EINVAL;
3872     } else {
3873         if (!(area->vm_flags & VM_READ))
3874             return -EINVAL;
3875     }
3876     runtime = substream->runtime;
3877     if (runtime->status->state == SNDRV_PCM_STATE_OPEN)
3878         return -EBADFD;
3879     if (!(runtime->info & SNDRV_PCM_INFO_MMAP))
3880         return -ENXIO;
3881     if (runtime->access == SNDRV_PCM_ACCESS_RW_INTERLEAVED ||
3882         runtime->access == SNDRV_PCM_ACCESS_RW_NONINTERLEAVED)
3883         return -EINVAL;
3884     size = area->vm_end - area->vm_start;
3885     offset = area->vm_pgoff << PAGE_SHIFT;
3886     dma_bytes = PAGE_ALIGN(runtime->dma_bytes);
3887     if ((size_t)size > dma_bytes)
3888         return -EINVAL;
3889     if (offset > dma_bytes - size)
3890         return -EINVAL;
3891 
3892     area->vm_ops = &snd_pcm_vm_ops_data;
3893     area->vm_private_data = substream;
3894     if (substream->ops->mmap)
3895         err = substream->ops->mmap(substream, area);
3896     else
3897         err = snd_pcm_lib_default_mmap(substream, area);
3898     if (!err)
3899         atomic_inc(&substream->mmap_count);
3900     return err;
3901 }
3902 EXPORT_SYMBOL(snd_pcm_mmap_data);
3903 
3904 static int snd_pcm_mmap(struct file *file, struct vm_area_struct *area)
3905 {
3906     struct snd_pcm_file * pcm_file;
3907     struct snd_pcm_substream *substream;    
3908     unsigned long offset;
3909     
3910     pcm_file = file->private_data;
3911     substream = pcm_file->substream;
3912     if (PCM_RUNTIME_CHECK(substream))
3913         return -ENXIO;
3914     if (substream->runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3915         return -EBADFD;
3916 
3917     offset = area->vm_pgoff << PAGE_SHIFT;
3918     switch (offset) {
3919     case SNDRV_PCM_MMAP_OFFSET_STATUS_OLD:
3920         if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3921             return -ENXIO;
3922         fallthrough;
3923     case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
3924         if (!pcm_status_mmap_allowed(pcm_file))
3925             return -ENXIO;
3926         return snd_pcm_mmap_status(substream, file, area);
3927     case SNDRV_PCM_MMAP_OFFSET_CONTROL_OLD:
3928         if (pcm_file->no_compat_mmap || !IS_ENABLED(CONFIG_64BIT))
3929             return -ENXIO;
3930         fallthrough;
3931     case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
3932         if (!pcm_control_mmap_allowed(pcm_file))
3933             return -ENXIO;
3934         return snd_pcm_mmap_control(substream, file, area);
3935     default:
3936         return snd_pcm_mmap_data(substream, file, area);
3937     }
3938     return 0;
3939 }
3940 
3941 static int snd_pcm_fasync(int fd, struct file * file, int on)
3942 {
3943     struct snd_pcm_file * pcm_file;
3944     struct snd_pcm_substream *substream;
3945     struct snd_pcm_runtime *runtime;
3946 
3947     pcm_file = file->private_data;
3948     substream = pcm_file->substream;
3949     if (PCM_RUNTIME_CHECK(substream))
3950         return -ENXIO;
3951     runtime = substream->runtime;
3952     if (runtime->status->state == SNDRV_PCM_STATE_DISCONNECTED)
3953         return -EBADFD;
3954     return snd_fasync_helper(fd, file, on, &runtime->fasync);
3955 }
3956 
3957 /*
3958  * ioctl32 compat
3959  */
3960 #ifdef CONFIG_COMPAT
3961 #include "pcm_compat.c"
3962 #else
3963 #define snd_pcm_ioctl_compat    NULL
3964 #endif
3965 
3966 /*
3967  *  To be removed helpers to keep binary compatibility
3968  */
3969 
3970 #ifdef CONFIG_SND_SUPPORT_OLD_API
3971 #define __OLD_TO_NEW_MASK(x) ((x&7)|((x&0x07fffff8)<<5))
3972 #define __NEW_TO_OLD_MASK(x) ((x&7)|((x&0xffffff00)>>5))
3973 
3974 static void snd_pcm_hw_convert_from_old_params(struct snd_pcm_hw_params *params,
3975                            struct snd_pcm_hw_params_old *oparams)
3976 {
3977     unsigned int i;
3978 
3979     memset(params, 0, sizeof(*params));
3980     params->flags = oparams->flags;
3981     for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
3982         params->masks[i].bits[0] = oparams->masks[i];
3983     memcpy(params->intervals, oparams->intervals, sizeof(oparams->intervals));
3984     params->rmask = __OLD_TO_NEW_MASK(oparams->rmask);
3985     params->cmask = __OLD_TO_NEW_MASK(oparams->cmask);
3986     params->info = oparams->info;
3987     params->msbits = oparams->msbits;
3988     params->rate_num = oparams->rate_num;
3989     params->rate_den = oparams->rate_den;
3990     params->fifo_size = oparams->fifo_size;
3991 }
3992 
3993 static void snd_pcm_hw_convert_to_old_params(struct snd_pcm_hw_params_old *oparams,
3994                          struct snd_pcm_hw_params *params)
3995 {
3996     unsigned int i;
3997 
3998     memset(oparams, 0, sizeof(*oparams));
3999     oparams->flags = params->flags;
4000     for (i = 0; i < ARRAY_SIZE(oparams->masks); i++)
4001         oparams->masks[i] = params->masks[i].bits[0];
4002     memcpy(oparams->intervals, params->intervals, sizeof(oparams->intervals));
4003     oparams->rmask = __NEW_TO_OLD_MASK(params->rmask);
4004     oparams->cmask = __NEW_TO_OLD_MASK(params->cmask);
4005     oparams->info = params->info;
4006     oparams->msbits = params->msbits;
4007     oparams->rate_num = params->rate_num;
4008     oparams->rate_den = params->rate_den;
4009     oparams->fifo_size = params->fifo_size;
4010 }
4011 
4012 static int snd_pcm_hw_refine_old_user(struct snd_pcm_substream *substream,
4013                       struct snd_pcm_hw_params_old __user * _oparams)
4014 {
4015     struct snd_pcm_hw_params *params;
4016     struct snd_pcm_hw_params_old *oparams = NULL;
4017     int err;
4018 
4019     params = kmalloc(sizeof(*params), GFP_KERNEL);
4020     if (!params)
4021         return -ENOMEM;
4022 
4023     oparams = memdup_user(_oparams, sizeof(*oparams));
4024     if (IS_ERR(oparams)) {
4025         err = PTR_ERR(oparams);
4026         goto out;
4027     }
4028     snd_pcm_hw_convert_from_old_params(params, oparams);
4029     err = snd_pcm_hw_refine(substream, params);
4030     if (err < 0)
4031         goto out_old;
4032 
4033     err = fixup_unreferenced_params(substream, params);
4034     if (err < 0)
4035         goto out_old;
4036 
4037     snd_pcm_hw_convert_to_old_params(oparams, params);
4038     if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4039         err = -EFAULT;
4040 out_old:
4041     kfree(oparams);
4042 out:
4043     kfree(params);
4044     return err;
4045 }
4046 
4047 static int snd_pcm_hw_params_old_user(struct snd_pcm_substream *substream,
4048                       struct snd_pcm_hw_params_old __user * _oparams)
4049 {
4050     struct snd_pcm_hw_params *params;
4051     struct snd_pcm_hw_params_old *oparams = NULL;
4052     int err;
4053 
4054     params = kmalloc(sizeof(*params), GFP_KERNEL);
4055     if (!params)
4056         return -ENOMEM;
4057 
4058     oparams = memdup_user(_oparams, sizeof(*oparams));
4059     if (IS_ERR(oparams)) {
4060         err = PTR_ERR(oparams);
4061         goto out;
4062     }
4063 
4064     snd_pcm_hw_convert_from_old_params(params, oparams);
4065     err = snd_pcm_hw_params(substream, params);
4066     if (err < 0)
4067         goto out_old;
4068 
4069     snd_pcm_hw_convert_to_old_params(oparams, params);
4070     if (copy_to_user(_oparams, oparams, sizeof(*oparams)))
4071         err = -EFAULT;
4072 out_old:
4073     kfree(oparams);
4074 out:
4075     kfree(params);
4076     return err;
4077 }
4078 #endif /* CONFIG_SND_SUPPORT_OLD_API */
4079 
4080 #ifndef CONFIG_MMU
4081 static unsigned long snd_pcm_get_unmapped_area(struct file *file,
4082                            unsigned long addr,
4083                            unsigned long len,
4084                            unsigned long pgoff,
4085                            unsigned long flags)
4086 {
4087     struct snd_pcm_file *pcm_file = file->private_data;
4088     struct snd_pcm_substream *substream = pcm_file->substream;
4089     struct snd_pcm_runtime *runtime = substream->runtime;
4090     unsigned long offset = pgoff << PAGE_SHIFT;
4091 
4092     switch (offset) {
4093     case SNDRV_PCM_MMAP_OFFSET_STATUS_NEW:
4094         return (unsigned long)runtime->status;
4095     case SNDRV_PCM_MMAP_OFFSET_CONTROL_NEW:
4096         return (unsigned long)runtime->control;
4097     default:
4098         return (unsigned long)runtime->dma_area + offset;
4099     }
4100 }
4101 #else
4102 # define snd_pcm_get_unmapped_area NULL
4103 #endif
4104 
4105 /*
4106  *  Register section
4107  */
4108 
4109 const struct file_operations snd_pcm_f_ops[2] = {
4110     {
4111         .owner =        THIS_MODULE,
4112         .write =        snd_pcm_write,
4113         .write_iter =       snd_pcm_writev,
4114         .open =         snd_pcm_playback_open,
4115         .release =      snd_pcm_release,
4116         .llseek =       no_llseek,
4117         .poll =         snd_pcm_poll,
4118         .unlocked_ioctl =   snd_pcm_ioctl,
4119         .compat_ioctl =     snd_pcm_ioctl_compat,
4120         .mmap =         snd_pcm_mmap,
4121         .fasync =       snd_pcm_fasync,
4122         .get_unmapped_area =    snd_pcm_get_unmapped_area,
4123     },
4124     {
4125         .owner =        THIS_MODULE,
4126         .read =         snd_pcm_read,
4127         .read_iter =        snd_pcm_readv,
4128         .open =         snd_pcm_capture_open,
4129         .release =      snd_pcm_release,
4130         .llseek =       no_llseek,
4131         .poll =         snd_pcm_poll,
4132         .unlocked_ioctl =   snd_pcm_ioctl,
4133         .compat_ioctl =     snd_pcm_ioctl_compat,
4134         .mmap =         snd_pcm_mmap,
4135         .fasync =       snd_pcm_fasync,
4136         .get_unmapped_area =    snd_pcm_get_unmapped_area,
4137     }
4138 };