include/sound/pcm.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 #ifndef __SOUND_PCM_H
   3 #define __SOUND_PCM_H
   4
   5 /*
   6  *  Digital Audio (PCM) abstract layer
   7  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   8  *                   Abramo Bagnara <abramo@alsa-project.org>
   9  */
  10
  11 #include <sound/asound.h>
  12 #include <sound/memalloc.h>
  13 #include <sound/minors.h>
  14 #include <linux/poll.h>
  15 #include <linux/mm.h>
  16 #include <linux/bitops.h>
  17 #include <linux/pm_qos.h>
  18 #include <linux/refcount.h>
  19
  20 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
  21 #define snd_pcm_chip(pcm) ((pcm)->private_data)
  22
  23 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
  24 #include <sound/pcm_oss.h>
  25 #endif
  26
  27 /*
  28  *  Hardware (lowlevel) section
  29  */
  30
  31 struct snd_pcm_hardware {
  32         unsigned int info;              /* SNDRV_PCM_INFO_* */
  33         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
  34         unsigned int rates;             /* SNDRV_PCM_RATE_* */
  35         unsigned int rate_min;          /* min rate */
  36         unsigned int rate_max;          /* max rate */
  37         unsigned int channels_min;      /* min channels */
  38         unsigned int channels_max;      /* max channels */
  39         size_t buffer_bytes_max;        /* max buffer size */
  40         size_t period_bytes_min;        /* min period size */
  41         size_t period_bytes_max;        /* max period size */
  42         unsigned int periods_min;       /* min # of periods */
  43         unsigned int periods_max;       /* max # of periods */
  44         size_t fifo_size;               /* fifo size in bytes */
  45 };
  46
  47 struct snd_pcm_substream;
  48
  49 struct snd_pcm_audio_tstamp_config; /* definitions further down */
  50 struct snd_pcm_audio_tstamp_report;
  51
  52 struct snd_pcm_ops {
  53         int (*open)(struct snd_pcm_substream *substream);
  54         int (*close)(struct snd_pcm_substream *substream);
  55         int (*ioctl)(struct snd_pcm_substream * substream,
  56                      unsigned int cmd, void *arg);
  57         int (*hw_params)(struct snd_pcm_substream *substream,
  58                          struct snd_pcm_hw_params *params);
  59         int (*hw_free)(struct snd_pcm_substream *substream);
  60         int (*prepare)(struct snd_pcm_substream *substream);
  61         int (*trigger)(struct snd_pcm_substream *substream, int cmd);
  62         snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
  63         int (*get_time_info)(struct snd_pcm_substream *substream,
  64                         struct timespec *system_ts, struct timespec *audio_ts,
  65                         struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
  66                         struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
  67         int (*fill_silence)(struct snd_pcm_substream *substream, int channel,
  68                             unsigned long pos, unsigned long bytes);
  69         int (*copy_user)(struct snd_pcm_substream *substream, int channel,
  70                          unsigned long pos, void __user *buf,
  71                          unsigned long bytes);
  72         int (*copy_kernel)(struct snd_pcm_substream *substream, int channel,
  73                            unsigned long pos, void *buf, unsigned long bytes);
  74         struct page *(*page)(struct snd_pcm_substream *substream,
  75                              unsigned long offset);
  76         int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
  77         int (*ack)(struct snd_pcm_substream *substream);
  78 };
  79
  80 /*
  81  *
  82  */
  83
  84 #if defined(CONFIG_SND_DYNAMIC_MINORS)
  85 #define SNDRV_PCM_DEVICES       (SNDRV_OS_MINORS-2)
  86 #else
  87 #define SNDRV_PCM_DEVICES       8
  88 #endif
  89
  90 #define SNDRV_PCM_IOCTL1_RESET          0
  91 /* 1 is absent slot. */
  92 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO   2
  93 /* 3 is absent slot. */
  94 #define SNDRV_PCM_IOCTL1_FIFO_SIZE      4
  95
  96 #define SNDRV_PCM_TRIGGER_STOP          0
  97 #define SNDRV_PCM_TRIGGER_START         1
  98 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH    3
  99 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
 100 #define SNDRV_PCM_TRIGGER_SUSPEND       5
 101 #define SNDRV_PCM_TRIGGER_RESUME        6
 102 #define SNDRV_PCM_TRIGGER_DRAIN         7
 103
 104 #define SNDRV_PCM_POS_XRUN              ((snd_pcm_uframes_t)-1)
 105
 106 /* If you change this don't forget to change rates[] table in pcm_native.c */
 107 #define SNDRV_PCM_RATE_5512             (1<<0)          /* 5512Hz */
 108 #define SNDRV_PCM_RATE_8000             (1<<1)          /* 8000Hz */
 109 #define SNDRV_PCM_RATE_11025            (1<<2)          /* 11025Hz */
 110 #define SNDRV_PCM_RATE_16000            (1<<3)          /* 16000Hz */
 111 #define SNDRV_PCM_RATE_22050            (1<<4)          /* 22050Hz */
 112 #define SNDRV_PCM_RATE_32000            (1<<5)          /* 32000Hz */
 113 #define SNDRV_PCM_RATE_44100            (1<<6)          /* 44100Hz */
 114 #define SNDRV_PCM_RATE_48000            (1<<7)          /* 48000Hz */
 115 #define SNDRV_PCM_RATE_64000            (1<<8)          /* 64000Hz */
 116 #define SNDRV_PCM_RATE_88200            (1<<9)          /* 88200Hz */
 117 #define SNDRV_PCM_RATE_96000            (1<<10)         /* 96000Hz */
 118 #define SNDRV_PCM_RATE_176400           (1<<11)         /* 176400Hz */
 119 #define SNDRV_PCM_RATE_192000           (1<<12)         /* 192000Hz */
 120
 121 #define SNDRV_PCM_RATE_CONTINUOUS       (1<<30)         /* continuous range */
 122 #define SNDRV_PCM_RATE_KNOT             (1<<31)         /* supports more non-continuos rates */
 123
 124 #define SNDRV_PCM_RATE_8000_44100       (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
 125                                          SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
 126                                          SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
 127 #define SNDRV_PCM_RATE_8000_48000       (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
 128 #define SNDRV_PCM_RATE_8000_96000       (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
 129                                          SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
 130 #define SNDRV_PCM_RATE_8000_192000      (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
 131                                          SNDRV_PCM_RATE_192000)
 132 #define _SNDRV_PCM_FMTBIT(fmt)          (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
 133 #define SNDRV_PCM_FMTBIT_S8             _SNDRV_PCM_FMTBIT(S8)
 134 #define SNDRV_PCM_FMTBIT_U8             _SNDRV_PCM_FMTBIT(U8)
 135 #define SNDRV_PCM_FMTBIT_S16_LE         _SNDRV_PCM_FMTBIT(S16_LE)
 136 #define SNDRV_PCM_FMTBIT_S16_BE         _SNDRV_PCM_FMTBIT(S16_BE)
 137 #define SNDRV_PCM_FMTBIT_U16_LE         _SNDRV_PCM_FMTBIT(U16_LE)
 138 #define SNDRV_PCM_FMTBIT_U16_BE         _SNDRV_PCM_FMTBIT(U16_BE)
 139 #define SNDRV_PCM_FMTBIT_S24_LE         _SNDRV_PCM_FMTBIT(S24_LE)
 140 #define SNDRV_PCM_FMTBIT_S24_BE         _SNDRV_PCM_FMTBIT(S24_BE)
 141 #define SNDRV_PCM_FMTBIT_U24_LE         _SNDRV_PCM_FMTBIT(U24_LE)
 142 #define SNDRV_PCM_FMTBIT_U24_BE         _SNDRV_PCM_FMTBIT(U24_BE)
 143 #define SNDRV_PCM_FMTBIT_S32_LE         _SNDRV_PCM_FMTBIT(S32_LE)
 144 #define SNDRV_PCM_FMTBIT_S32_BE         _SNDRV_PCM_FMTBIT(S32_BE)
 145 #define SNDRV_PCM_FMTBIT_U32_LE         _SNDRV_PCM_FMTBIT(U32_LE)
 146 #define SNDRV_PCM_FMTBIT_U32_BE         _SNDRV_PCM_FMTBIT(U32_BE)
 147 #define SNDRV_PCM_FMTBIT_FLOAT_LE       _SNDRV_PCM_FMTBIT(FLOAT_LE)
 148 #define SNDRV_PCM_FMTBIT_FLOAT_BE       _SNDRV_PCM_FMTBIT(FLOAT_BE)
 149 #define SNDRV_PCM_FMTBIT_FLOAT64_LE     _SNDRV_PCM_FMTBIT(FLOAT64_LE)
 150 #define SNDRV_PCM_FMTBIT_FLOAT64_BE     _SNDRV_PCM_FMTBIT(FLOAT64_BE)
 151 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
 152 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
 153 #define SNDRV_PCM_FMTBIT_MU_LAW         _SNDRV_PCM_FMTBIT(MU_LAW)
 154 #define SNDRV_PCM_FMTBIT_A_LAW          _SNDRV_PCM_FMTBIT(A_LAW)
 155 #define SNDRV_PCM_FMTBIT_IMA_ADPCM      _SNDRV_PCM_FMTBIT(IMA_ADPCM)
 156 #define SNDRV_PCM_FMTBIT_MPEG           _SNDRV_PCM_FMTBIT(MPEG)
 157 #define SNDRV_PCM_FMTBIT_GSM            _SNDRV_PCM_FMTBIT(GSM)
 158 #define SNDRV_PCM_FMTBIT_S20_LE _SNDRV_PCM_FMTBIT(S20_LE)
 159 #define SNDRV_PCM_FMTBIT_U20_LE _SNDRV_PCM_FMTBIT(U20_LE)
 160 #define SNDRV_PCM_FMTBIT_S20_BE _SNDRV_PCM_FMTBIT(S20_BE)
 161 #define SNDRV_PCM_FMTBIT_U20_BE _SNDRV_PCM_FMTBIT(U20_BE)
 162 #define SNDRV_PCM_FMTBIT_SPECIAL        _SNDRV_PCM_FMTBIT(SPECIAL)
 163 #define SNDRV_PCM_FMTBIT_S24_3LE        _SNDRV_PCM_FMTBIT(S24_3LE)
 164 #define SNDRV_PCM_FMTBIT_U24_3LE        _SNDRV_PCM_FMTBIT(U24_3LE)
 165 #define SNDRV_PCM_FMTBIT_S24_3BE        _SNDRV_PCM_FMTBIT(S24_3BE)
 166 #define SNDRV_PCM_FMTBIT_U24_3BE        _SNDRV_PCM_FMTBIT(U24_3BE)
 167 #define SNDRV_PCM_FMTBIT_S20_3LE        _SNDRV_PCM_FMTBIT(S20_3LE)
 168 #define SNDRV_PCM_FMTBIT_U20_3LE        _SNDRV_PCM_FMTBIT(U20_3LE)
 169 #define SNDRV_PCM_FMTBIT_S20_3BE        _SNDRV_PCM_FMTBIT(S20_3BE)
 170 #define SNDRV_PCM_FMTBIT_U20_3BE        _SNDRV_PCM_FMTBIT(U20_3BE)
 171 #define SNDRV_PCM_FMTBIT_S18_3LE        _SNDRV_PCM_FMTBIT(S18_3LE)
 172 #define SNDRV_PCM_FMTBIT_U18_3LE        _SNDRV_PCM_FMTBIT(U18_3LE)
 173 #define SNDRV_PCM_FMTBIT_S18_3BE        _SNDRV_PCM_FMTBIT(S18_3BE)
 174 #define SNDRV_PCM_FMTBIT_U18_3BE        _SNDRV_PCM_FMTBIT(U18_3BE)
 175 #define SNDRV_PCM_FMTBIT_G723_24        _SNDRV_PCM_FMTBIT(G723_24)
 176 #define SNDRV_PCM_FMTBIT_G723_24_1B     _SNDRV_PCM_FMTBIT(G723_24_1B)
 177 #define SNDRV_PCM_FMTBIT_G723_40        _SNDRV_PCM_FMTBIT(G723_40)
 178 #define SNDRV_PCM_FMTBIT_G723_40_1B     _SNDRV_PCM_FMTBIT(G723_40_1B)
 179 #define SNDRV_PCM_FMTBIT_DSD_U8         _SNDRV_PCM_FMTBIT(DSD_U8)
 180 #define SNDRV_PCM_FMTBIT_DSD_U16_LE     _SNDRV_PCM_FMTBIT(DSD_U16_LE)
 181 #define SNDRV_PCM_FMTBIT_DSD_U32_LE     _SNDRV_PCM_FMTBIT(DSD_U32_LE)
 182 #define SNDRV_PCM_FMTBIT_DSD_U16_BE     _SNDRV_PCM_FMTBIT(DSD_U16_BE)
 183 #define SNDRV_PCM_FMTBIT_DSD_U32_BE     _SNDRV_PCM_FMTBIT(DSD_U32_BE)
 184
 185 #ifdef SNDRV_LITTLE_ENDIAN
 186 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_LE
 187 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_LE
 188 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_LE
 189 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_LE
 190 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_LE
 191 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_LE
 192 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_LE
 193 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_LE
 194 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
 195 #define SNDRV_PCM_FMTBIT_S20            SNDRV_PCM_FMTBIT_S20_LE
 196 #define SNDRV_PCM_FMTBIT_U20            SNDRV_PCM_FMTBIT_U20_LE
 197 #endif
 198 #ifdef SNDRV_BIG_ENDIAN
 199 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_BE
 200 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_BE
 201 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_BE
 202 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_BE
 203 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_BE
 204 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_BE
 205 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_BE
 206 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_BE
 207 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
 208 #define SNDRV_PCM_FMTBIT_S20            SNDRV_PCM_FMTBIT_S20_BE
 209 #define SNDRV_PCM_FMTBIT_U20            SNDRV_PCM_FMTBIT_U20_BE
 210 #endif
 211
 212 struct snd_pcm_file {
 213         struct snd_pcm_substream *substream;
 214         int no_compat_mmap;
 215         unsigned int user_pversion;     /* supported protocol version */
 216 };
 217
 218 struct snd_pcm_hw_rule;
 219 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
 220                                       struct snd_pcm_hw_rule *rule);
 221
 222 struct snd_pcm_hw_rule {
 223         unsigned int cond;
 224         int var;
 225         int deps[4];
 226
 227         snd_pcm_hw_rule_func_t func;
 228         void *private;
 229 };
 230
 231 struct snd_pcm_hw_constraints {
 232         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
 233                          SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
 234         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
 235                              SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
 236         unsigned int rules_num;
 237         unsigned int rules_all;
 238         struct snd_pcm_hw_rule *rules;
 239 };
 240
 241 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
 242                                             snd_pcm_hw_param_t var)
 243 {
 244         return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 245 }
 246
 247 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
 248                                                     snd_pcm_hw_param_t var)
 249 {
 250         return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 251 }
 252
 253 struct snd_ratnum {
 254         unsigned int num;
 255         unsigned int den_min, den_max, den_step;
 256 };
 257
 258 struct snd_ratden {
 259         unsigned int num_min, num_max, num_step;
 260         unsigned int den;
 261 };
 262
 263 struct snd_pcm_hw_constraint_ratnums {
 264         int nrats;
 265         const struct snd_ratnum *rats;
 266 };
 267
 268 struct snd_pcm_hw_constraint_ratdens {
 269         int nrats;
 270         const struct snd_ratden *rats;
 271 };
 272
 273 struct snd_pcm_hw_constraint_list {
 274         const unsigned int *list;
 275         unsigned int count;
 276         unsigned int mask;
 277 };
 278
 279 struct snd_pcm_hw_constraint_ranges {
 280         unsigned int count;
 281         const struct snd_interval *ranges;
 282         unsigned int mask;
 283 };
 284
 285 /*
 286  * userspace-provided audio timestamp config to kernel,
 287  * structure is for internal use only and filled with dedicated unpack routine
 288  */
 289 struct snd_pcm_audio_tstamp_config {
 290         /* 5 of max 16 bits used */
 291         u32 type_requested:4;
 292         u32 report_delay:1; /* add total delay to A/D or D/A */
 293 };
 294
 295 static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
 296                                                 struct snd_pcm_audio_tstamp_config *config)
 297 {
 298         config->type_requested = data & 0xF;
 299         config->report_delay = (data >> 4) & 1;
 300 }
 301
 302 /*
 303  * kernel-provided audio timestamp report to user-space
 304  * structure is for internal use only and read by dedicated pack routine
 305  */
 306 struct snd_pcm_audio_tstamp_report {
 307         /* 6 of max 16 bits used for bit-fields */
 308
 309         /* for backwards compatibility */
 310         u32 valid:1;
 311
 312         /* actual type if hardware could not support requested timestamp */
 313         u32 actual_type:4;
 314
 315         /* accuracy represented in ns units */
 316         u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
 317         u32 accuracy; /* up to 4.29s, will be packed in separate field  */
 318 };
 319
 320 static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
 321                                                 const struct snd_pcm_audio_tstamp_report *report)
 322 {
 323         u32 tmp;
 324
 325         tmp = report->accuracy_report;
 326         tmp <<= 4;
 327         tmp |= report->actual_type;
 328         tmp <<= 1;
 329         tmp |= report->valid;
 330
 331         *data &= 0xffff; /* zero-clear MSBs */
 332         *data |= (tmp << 16);
 333         *accuracy = report->accuracy;
 334 }
 335
 336
 337 struct snd_pcm_runtime {
 338         /* -- Status -- */
 339         struct snd_pcm_substream *trigger_master;
 340         struct timespec trigger_tstamp; /* trigger timestamp */
 341         bool trigger_tstamp_latched;     /* trigger timestamp latched in low-level driver/hardware */
 342         int overrange;
 343         snd_pcm_uframes_t avail_max;
 344         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
 345         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
 346         unsigned long hw_ptr_jiffies;   /* Time when hw_ptr is updated */
 347         unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
 348         snd_pcm_sframes_t delay;        /* extra delay; typically FIFO size */
 349         u64 hw_ptr_wrap;                /* offset for hw_ptr due to boundary wrap-around */
 350
 351         /* -- HW params -- */
 352         snd_pcm_access_t access;        /* access mode */
 353         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
 354         snd_pcm_subformat_t subformat;  /* subformat */
 355         unsigned int rate;              /* rate in Hz */
 356         unsigned int channels;          /* channels */
 357         snd_pcm_uframes_t period_size;  /* period size */
 358         unsigned int periods;           /* periods */
 359         snd_pcm_uframes_t buffer_size;  /* buffer size */
 360         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
 361         size_t byte_align;
 362         unsigned int frame_bits;
 363         unsigned int sample_bits;
 364         unsigned int info;
 365         unsigned int rate_num;
 366         unsigned int rate_den;
 367         unsigned int no_period_wakeup: 1;
 368
 369         /* -- SW params -- */
 370         int tstamp_mode;                /* mmap timestamp is updated */
 371         unsigned int period_step;
 372         snd_pcm_uframes_t start_threshold;
 373         snd_pcm_uframes_t stop_threshold;
 374         snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
 375                                                 noise is nearest than this */
 376         snd_pcm_uframes_t silence_size; /* Silence filling size */
 377         snd_pcm_uframes_t boundary;     /* pointers wrap point */
 378
 379         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
 380         snd_pcm_uframes_t silence_filled; /* size filled with silence */
 381
 382         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 383
 384         /* -- mmap -- */
 385         struct snd_pcm_mmap_status *status;
 386         struct snd_pcm_mmap_control *control;
 387
 388         /* -- locking / scheduling -- */
 389         snd_pcm_uframes_t twake;        /* do transfer (!poll) wakeup if non-zero */
 390         wait_queue_head_t sleep;        /* poll sleep */
 391         wait_queue_head_t tsleep;       /* transfer sleep */
 392         struct fasync_struct *fasync;
 393
 394         /* -- private section -- */
 395         void *private_data;
 396         void (*private_free)(struct snd_pcm_runtime *runtime);
 397
 398         /* -- hardware description -- */
 399         struct snd_pcm_hardware hw;
 400         struct snd_pcm_hw_constraints hw_constraints;
 401
 402         /* -- timer -- */
 403         unsigned int timer_resolution;  /* timer resolution */
 404         int tstamp_type;                /* timestamp type */
 405
 406         /* -- DMA -- */
 407         unsigned char *dma_area;        /* DMA area */
 408         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 409         size_t dma_bytes;               /* size of DMA area */
 410
 411         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 412
 413         /* -- audio timestamp config -- */
 414         struct snd_pcm_audio_tstamp_config audio_tstamp_config;
 415         struct snd_pcm_audio_tstamp_report audio_tstamp_report;
 416         struct timespec driver_tstamp;
 417
 418 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 419         /* -- OSS things -- */
 420         struct snd_pcm_oss_runtime oss;
 421 #endif
 422 };
 423
 424 struct snd_pcm_group {          /* keep linked substreams */
 425         spinlock_t lock;
 426         struct mutex mutex;
 427         struct list_head substreams;
 428         refcount_t refs;
 429 };
 430
 431 struct pid;
 432
 433 struct snd_pcm_substream {
 434         struct snd_pcm *pcm;
 435         struct snd_pcm_str *pstr;
 436         void *private_data;             /* copied from pcm->private_data */
 437         int number;
 438         char name[32];                  /* substream name */
 439         int stream;                     /* stream (direction) */
 440         struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
 441         size_t buffer_bytes_max;        /* limit ring buffer size */
 442         struct snd_dma_buffer dma_buffer;
 443         size_t dma_max;
 444         /* -- hardware operations -- */
 445         const struct snd_pcm_ops *ops;
 446         /* -- runtime information -- */
 447         struct snd_pcm_runtime *runtime;
 448         /* -- timer section -- */
 449         struct snd_timer *timer;                /* timer */
 450         unsigned timer_running: 1;      /* time is running */
 451         long wait_time; /* time in ms for R/W to wait for avail */
 452         /* -- next substream -- */
 453         struct snd_pcm_substream *next;
 454         /* -- linked substreams -- */
 455         struct list_head link_list;     /* linked list member */
 456         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 457         struct snd_pcm_group *group;            /* pointer to current group */
 458         /* -- assigned files -- */
 459         int ref_count;
 460         atomic_t mmap_count;
 461         unsigned int f_flags;
 462         void (*pcm_release)(struct snd_pcm_substream *);
 463         struct pid *pid;
 464 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 465         /* -- OSS things -- */
 466         struct snd_pcm_oss_substream oss;
 467 #endif
 468 #ifdef CONFIG_SND_VERBOSE_PROCFS
 469         struct snd_info_entry *proc_root;
 470 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 471         /* misc flags */
 472         unsigned int hw_opened: 1;
 473 };
 474
 475 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 476
 477
 478 struct snd_pcm_str {
 479         int stream;                             /* stream (direction) */
 480         struct snd_pcm *pcm;
 481         /* -- substreams -- */
 482         unsigned int substream_count;
 483         unsigned int substream_opened;
 484         struct snd_pcm_substream *substream;
 485 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 486         /* -- OSS things -- */
 487         struct snd_pcm_oss_stream oss;
 488 #endif
 489 #ifdef CONFIG_SND_VERBOSE_PROCFS
 490         struct snd_info_entry *proc_root;
 491 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 492         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 493 #endif
 494 #endif
 495         struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
 496         struct device dev;
 497 };
 498
 499 struct snd_pcm {
 500         struct snd_card *card;
 501         struct list_head list;
 502         int device; /* device number */
 503         unsigned int info_flags;
 504         unsigned short dev_class;
 505         unsigned short dev_subclass;
 506         char id[64];
 507         char name[80];
 508         struct snd_pcm_str streams[2];
 509         struct mutex open_mutex;
 510         wait_queue_head_t open_wait;
 511         void *private_data;
 512         void (*private_free) (struct snd_pcm *pcm);
 513         bool internal; /* pcm is for internal use only */
 514         bool nonatomic; /* whole PCM operations are in non-atomic context */
 515         bool no_device_suspend; /* don't invoke device PM suspend */
 516 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 517         struct snd_pcm_oss oss;
 518 #endif
 519 };
 520
 521 /*
 522  *  Registering
 523  */
 524
 525 extern const struct file_operations snd_pcm_f_ops[2];
 526
 527 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 528                 int playback_count, int capture_count,
 529                 struct snd_pcm **rpcm);
 530 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
 531                 int playback_count, int capture_count,
 532                 struct snd_pcm **rpcm);
 533 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 534
 535 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 536 struct snd_pcm_notify {
 537         int (*n_register) (struct snd_pcm * pcm);
 538         int (*n_disconnect) (struct snd_pcm * pcm);
 539         int (*n_unregister) (struct snd_pcm * pcm);
 540         struct list_head list;
 541 };
 542 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 543 #endif
 544
 545 /*
 546  *  Native I/O
 547  */
 548
 549 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 550 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 551                       struct snd_pcm_info __user *info);
 552 int snd_pcm_status(struct snd_pcm_substream *substream,
 553                    struct snd_pcm_status *status);
 554 int snd_pcm_start(struct snd_pcm_substream *substream);
 555 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
 556 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 557 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
 558 #ifdef CONFIG_PM
 559 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 560 #else
 561 static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
 562 {
 563         return 0;
 564 }
 565 #endif
 566 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 567 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 568                            struct snd_pcm_substream **rsubstream);
 569 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 570 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 571                              struct snd_pcm_substream **rsubstream);
 572 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 573 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 574
 575
 576 #ifdef CONFIG_SND_DEBUG
 577 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
 578                            char *name, size_t len);
 579 #else
 580 static inline void
 581 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
 582 {
 583         *buf = 0;
 584 }
 585 #endif
 586
 587 /*
 588  *  PCM library
 589  */
 590
 591 /**
 592  * snd_pcm_stream_linked - Check whether the substream is linked with others
 593  * @substream: substream to check
 594  *
 595  * Returns true if the given substream is being linked with others.
 596  */
 597 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 598 {
 599         return substream->group != &substream->self_group;
 600 }
 601
 602 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
 603 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
 604 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
 605 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
 606 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
 607
 608 /**
 609  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
 610  * @substream: PCM substream
 611  * @flags: irq flags
 612  *
 613  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
 614  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
 615  * as snd_pcm_stream_lock().
 616  */
 617 #define snd_pcm_stream_lock_irqsave(substream, flags)            \
 618         do {                                                     \
 619                 typecheck(unsigned long, flags);                 \
 620                 flags = _snd_pcm_stream_lock_irqsave(substream); \
 621         } while (0)
 622 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
 623                                       unsigned long flags);
 624
 625 /**
 626  * snd_pcm_group_for_each_entry - iterate over the linked substreams
 627  * @s: the iterator
 628  * @substream: the substream
 629  *
 630  * Iterate over the all linked substreams to the given @substream.
 631  * When @substream isn't linked with any others, this gives returns @substream
 632  * itself once.
 633  */
 634 #define snd_pcm_group_for_each_entry(s, substream) \
 635         list_for_each_entry(s, &substream->group->substreams, link_list)
 636
 637 /**
 638  * snd_pcm_running - Check whether the substream is in a running state
 639  * @substream: substream to check
 640  *
 641  * Returns true if the given substream is in the state RUNNING, or in the
 642  * state DRAINING for playback.
 643  */
 644 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 645 {
 646         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 647                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 648                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 649 }
 650
 651 /**
 652  * bytes_to_samples - Unit conversion of the size from bytes to samples
 653  * @runtime: PCM runtime instance
 654  * @size: size in bytes
 655  */
 656 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 657 {
 658         return size * 8 / runtime->sample_bits;
 659 }
 660
 661 /**
 662  * bytes_to_frames - Unit conversion of the size from bytes to frames
 663  * @runtime: PCM runtime instance
 664  * @size: size in bytes
 665  */
 666 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 667 {
 668         return size * 8 / runtime->frame_bits;
 669 }
 670
 671 /**
 672  * samples_to_bytes - Unit conversion of the size from samples to bytes
 673  * @runtime: PCM runtime instance
 674  * @size: size in samples
 675  */
 676 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 677 {
 678         return size * runtime->sample_bits / 8;
 679 }
 680
 681 /**
 682  * frames_to_bytes - Unit conversion of the size from frames to bytes
 683  * @runtime: PCM runtime instance
 684  * @size: size in frames
 685  */
 686 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 687 {
 688         return size * runtime->frame_bits / 8;
 689 }
 690
 691 /**
 692  * frame_aligned - Check whether the byte size is aligned to frames
 693  * @runtime: PCM runtime instance
 694  * @bytes: size in bytes
 695  */
 696 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 697 {
 698         return bytes % runtime->byte_align == 0;
 699 }
 700
 701 /**
 702  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
 703  * @substream: PCM substream
 704  */
 705 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 706 {
 707         struct snd_pcm_runtime *runtime = substream->runtime;
 708         return frames_to_bytes(runtime, runtime->buffer_size);
 709 }
 710
 711 /**
 712  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
 713  * @substream: PCM substream
 714  */
 715 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 716 {
 717         struct snd_pcm_runtime *runtime = substream->runtime;
 718         return frames_to_bytes(runtime, runtime->period_size);
 719 }
 720
 721 /**
 722  * snd_pcm_playback_avail - Get the available (writable) space for playback
 723  * @runtime: PCM runtime instance
 724  *
 725  * Result is between 0 ... (boundary - 1)
 726  */
 727 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 728 {
 729         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 730         if (avail < 0)
 731                 avail += runtime->boundary;
 732         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 733                 avail -= runtime->boundary;
 734         return avail;
 735 }
 736
 737 /**
 738  * snd_pcm_capture_avail - Get the available (readable) space for capture
 739  * @runtime: PCM runtime instance
 740  *
 741  * Result is between 0 ... (boundary - 1)
 742  */
 743 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 744 {
 745         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 746         if (avail < 0)
 747                 avail += runtime->boundary;
 748         return avail;
 749 }
 750
 751 /**
 752  * snd_pcm_playback_hw_avail - Get the queued space for playback
 753  * @runtime: PCM runtime instance
 754  */
 755 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 756 {
 757         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 758 }
 759
 760 /**
 761  * snd_pcm_capture_hw_avail - Get the free space for capture
 762  * @runtime: PCM runtime instance
 763  */
 764 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 765 {
 766         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 767 }
 768
 769 /**
 770  * snd_pcm_playback_ready - check whether the playback buffer is available
 771  * @substream: the pcm substream instance
 772  *
 773  * Checks whether enough free space is available on the playback buffer.
 774  *
 775  * Return: Non-zero if available, or zero if not.
 776  */
 777 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 778 {
 779         struct snd_pcm_runtime *runtime = substream->runtime;
 780         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 781 }
 782
 783 /**
 784  * snd_pcm_capture_ready - check whether the capture buffer is available
 785  * @substream: the pcm substream instance
 786  *
 787  * Checks whether enough capture data is available on the capture buffer.
 788  *
 789  * Return: Non-zero if available, or zero if not.
 790  */
 791 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 792 {
 793         struct snd_pcm_runtime *runtime = substream->runtime;
 794         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 795 }
 796
 797 /**
 798  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 799  * @substream: the pcm substream instance
 800  *
 801  * Checks whether any data exists on the playback buffer.
 802  *
 803  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
 804  * is bigger or equal to boundary, then this function returns always non-zero.
 805  */
 806 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 807 {
 808         struct snd_pcm_runtime *runtime = substream->runtime;
 809
 810         if (runtime->stop_threshold >= runtime->boundary)
 811                 return 1;
 812         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 813 }
 814
 815 /**
 816  * snd_pcm_playback_empty - check whether the playback buffer is empty
 817  * @substream: the pcm substream instance
 818  *
 819  * Checks whether the playback buffer is empty.
 820  *
 821  * Return: Non-zero if empty, or zero if not.
 822  */
 823 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 824 {
 825         struct snd_pcm_runtime *runtime = substream->runtime;
 826         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 827 }
 828
 829 /**
 830  * snd_pcm_capture_empty - check whether the capture buffer is empty
 831  * @substream: the pcm substream instance
 832  *
 833  * Checks whether the capture buffer is empty.
 834  *
 835  * Return: Non-zero if empty, or zero if not.
 836  */
 837 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 838 {
 839         struct snd_pcm_runtime *runtime = substream->runtime;
 840         return snd_pcm_capture_avail(runtime) == 0;
 841 }
 842
 843 /**
 844  * snd_pcm_trigger_done - Mark the master substream
 845  * @substream: the pcm substream instance
 846  * @master: the linked master substream
 847  *
 848  * When multiple substreams of the same card are linked and the hardware
 849  * supports the single-shot operation, the driver calls this in the loop
 850  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
 851  * Then most of trigger operations are performed only to the given master
 852  * substream.
 853  *
 854  * The trigger_master mark is cleared at timestamp updates at the end
 855  * of trigger operations.
 856  */
 857 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 858                                         struct snd_pcm_substream *master)
 859 {
 860         substream->runtime->trigger_master = master;
 861 }
 862
 863 static inline int hw_is_mask(int var)
 864 {
 865         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 866                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 867 }
 868
 869 static inline int hw_is_interval(int var)
 870 {
 871         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 872                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 873 }
 874
 875 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 876                                      snd_pcm_hw_param_t var)
 877 {
 878         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 879 }
 880
 881 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 882                                              snd_pcm_hw_param_t var)
 883 {
 884         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 885 }
 886
 887 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 888                                              snd_pcm_hw_param_t var)
 889 {
 890         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 891 }
 892
 893 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 894                                                      snd_pcm_hw_param_t var)
 895 {
 896         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 897 }
 898
 899 /**
 900  * params_channels - Get the number of channels from the hw params
 901  * @p: hw params
 902  */
 903 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
 904 {
 905         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
 906 }
 907
 908 /**
 909  * params_rate - Get the sample rate from the hw params
 910  * @p: hw params
 911  */
 912 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
 913 {
 914         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
 915 }
 916
 917 /**
 918  * params_period_size - Get the period size (in frames) from the hw params
 919  * @p: hw params
 920  */
 921 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
 922 {
 923         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
 924 }
 925
 926 /**
 927  * params_periods - Get the number of periods from the hw params
 928  * @p: hw params
 929  */
 930 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
 931 {
 932         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
 933 }
 934
 935 /**
 936  * params_buffer_size - Get the buffer size (in frames) from the hw params
 937  * @p: hw params
 938  */
 939 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
 940 {
 941         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
 942 }
 943
 944 /**
 945  * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
 946  * @p: hw params
 947  */
 948 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
 949 {
 950         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
 951 }
 952
 953 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 954 int snd_interval_list(struct snd_interval *i, unsigned int count,
 955                       const unsigned int *list, unsigned int mask);
 956 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
 957                         const struct snd_interval *list, unsigned int mask);
 958 int snd_interval_ratnum(struct snd_interval *i,
 959                         unsigned int rats_count, const struct snd_ratnum *rats,
 960                         unsigned int *nump, unsigned int *denp);
 961
 962 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 963 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 964
 965 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 966
 967 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 968                                  u_int64_t mask);
 969 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 970                                  unsigned int min, unsigned int max);
 971 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
 972 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
 973                                unsigned int cond,
 974                                snd_pcm_hw_param_t var,
 975                                const struct snd_pcm_hw_constraint_list *l);
 976 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
 977                                  unsigned int cond,
 978                                  snd_pcm_hw_param_t var,
 979                                  const struct snd_pcm_hw_constraint_ranges *r);
 980 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
 981                                   unsigned int cond,
 982                                   snd_pcm_hw_param_t var,
 983                                   const struct snd_pcm_hw_constraint_ratnums *r);
 984 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
 985                                   unsigned int cond,
 986                                   snd_pcm_hw_param_t var,
 987                                   const struct snd_pcm_hw_constraint_ratdens *r);
 988 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
 989                                  unsigned int cond,
 990                                  unsigned int width,
 991                                  unsigned int msbits);
 992 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
 993                                unsigned int cond,
 994                                snd_pcm_hw_param_t var,
 995                                unsigned long step);
 996 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
 997                                unsigned int cond,
 998                                snd_pcm_hw_param_t var);
 999 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1000                                unsigned int base_rate);
1001 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1002                         unsigned int cond,
1003                         int var,
1004                         snd_pcm_hw_rule_func_t func, void *private,
1005                         int dep, ...);
1006
1007 /**
1008  * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1009  * @runtime: PCM runtime instance
1010  * @var: The hw_params variable to constrain
1011  * @val: The value to constrain to
1012  *
1013  * Return: Positive if the value is changed, zero if it's not changed, or a
1014  * negative error code.
1015  */
1016 static inline int snd_pcm_hw_constraint_single(
1017         struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1018         unsigned int val)
1019 {
1020         return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1021 }
1022
1023 int snd_pcm_format_signed(snd_pcm_format_t format);
1024 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1025 int snd_pcm_format_linear(snd_pcm_format_t format);
1026 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1027 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1028 #if 0 /* just for kernel-doc */
1029 /**
1030  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1031  * @format: the format to check
1032  *
1033  * Return: 1 if the given PCM format is CPU-endian, 0 if
1034  * opposite, or a negative error code if endian not specified.
1035  */
1036 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1037 #endif /* DocBook */
1038 #ifdef SNDRV_LITTLE_ENDIAN
1039 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1040 #else
1041 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1042 #endif
1043 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
1044 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
1045 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1046 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1047 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1048
1049 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1050                      const struct snd_pcm_ops *ops);
1051 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1052 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1053                       unsigned int cmd, void *arg);
1054 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1055 snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1056                                      void *buf, bool interleaved,
1057                                      snd_pcm_uframes_t frames, bool in_kernel);
1058
1059 static inline snd_pcm_sframes_t
1060 snd_pcm_lib_write(struct snd_pcm_substream *substream,
1061                   const void __user *buf, snd_pcm_uframes_t frames)
1062 {
1063         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1064 }
1065
1066 static inline snd_pcm_sframes_t
1067 snd_pcm_lib_read(struct snd_pcm_substream *substream,
1068                  void __user *buf, snd_pcm_uframes_t frames)
1069 {
1070         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1071 }
1072
1073 static inline snd_pcm_sframes_t
1074 snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1075                    void __user **bufs, snd_pcm_uframes_t frames)
1076 {
1077         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1078 }
1079
1080 static inline snd_pcm_sframes_t
1081 snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1082                   void __user **bufs, snd_pcm_uframes_t frames)
1083 {
1084         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1085 }
1086
1087 static inline snd_pcm_sframes_t
1088 snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1089                      const void *buf, snd_pcm_uframes_t frames)
1090 {
1091         return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1092 }
1093
1094 static inline snd_pcm_sframes_t
1095 snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1096                     void *buf, snd_pcm_uframes_t frames)
1097 {
1098         return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1099 }
1100
1101 static inline snd_pcm_sframes_t
1102 snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1103                       void **bufs, snd_pcm_uframes_t frames)
1104 {
1105         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1106 }
1107
1108 static inline snd_pcm_sframes_t
1109 snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1110                      void **bufs, snd_pcm_uframes_t frames)
1111 {
1112         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1113 }
1114
1115 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1116 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1117 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1118 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1119                                          unsigned int rates_b);
1120 unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1121                                         unsigned int rate_max);
1122
1123 /**
1124  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1125  * @substream: PCM substream to set
1126  * @bufp: the buffer information, NULL to clear
1127  *
1128  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1129  * Otherwise it clears the current buffer information.
1130  */
1131 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1132                                               struct snd_dma_buffer *bufp)
1133 {
1134         struct snd_pcm_runtime *runtime = substream->runtime;
1135         if (bufp) {
1136                 runtime->dma_buffer_p = bufp;
1137                 runtime->dma_area = bufp->area;
1138                 runtime->dma_addr = bufp->addr;
1139                 runtime->dma_bytes = bufp->bytes;
1140         } else {
1141                 runtime->dma_buffer_p = NULL;
1142                 runtime->dma_area = NULL;
1143                 runtime->dma_addr = 0;
1144                 runtime->dma_bytes = 0;
1145         }
1146 }
1147
1148 /**
1149  * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1150  * @runtime: PCM runtime instance
1151  * @tv: timespec to fill
1152  */
1153 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1154                                    struct timespec *tv)
1155 {
1156         switch (runtime->tstamp_type) {
1157         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1158                 ktime_get_ts(tv);
1159                 break;
1160         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1161                 getrawmonotonic(tv);
1162                 break;
1163         default:
1164                 getnstimeofday(tv);
1165                 break;
1166         }
1167 }
1168
1169 /*
1170  *  Memory
1171  */
1172
1173 void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1174 void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1175 void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1176                                   int type, struct device *data,
1177                                   size_t size, size_t max);
1178 void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1179                                           int type, void *data,
1180                                           size_t size, size_t max);
1181 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1182 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1183
1184 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1185                                       size_t size, gfp_t gfp_flags);
1186 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1187 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1188                                           unsigned long offset);
1189 /**
1190  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1191  * @substream: the substream to allocate the buffer to
1192  * @size: the requested buffer size, in bytes
1193  *
1194  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1195  * contiguous in kernel virtual space, but not in physical memory.  Use this
1196  * if the buffer is accessed by kernel code but not by device DMA.
1197  *
1198  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1199  * code.
1200  */
1201 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1202                         (struct snd_pcm_substream *substream, size_t size)
1203 {
1204         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1205                                                  GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1206 }
1207
1208 /**
1209  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1210  * @substream: the substream to allocate the buffer to
1211  * @size: the requested buffer size, in bytes
1212  *
1213  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1214  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1215  *
1216  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1217  * code.
1218  */
1219 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1220                         (struct snd_pcm_substream *substream, size_t size)
1221 {
1222         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1223                                                  GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1224 }
1225
1226 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1227
1228 #ifdef CONFIG_SND_DMA_SGBUF
1229 /*
1230  * SG-buffer handling
1231  */
1232 #define snd_pcm_substream_sgbuf(substream) \
1233         snd_pcm_get_dma_buf(substream)->private_data
1234
1235 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1236                                     unsigned long offset);
1237 #else /* !SND_DMA_SGBUF */
1238 /*
1239  * fake using a continuous buffer
1240  */
1241 #define snd_pcm_sgbuf_ops_page  NULL
1242 #endif /* SND_DMA_SGBUF */
1243
1244 /**
1245  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1246  * @substream: PCM substream
1247  * @ofs: byte offset
1248  */
1249 static inline dma_addr_t
1250 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1251 {
1252         return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1253 }
1254
1255 /**
1256  * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1257  * @substream: PCM substream
1258  * @ofs: byte offset
1259  */
1260 static inline void *
1261 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1262 {
1263         return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1264 }
1265
1266 /**
1267  * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1268  * page from the given size
1269  * @substream: PCM substream
1270  * @ofs: byte offset
1271  * @size: byte size to examine
1272  */
1273 static inline unsigned int
1274 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1275                              unsigned int ofs, unsigned int size)
1276 {
1277         return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1278 }
1279
1280 /**
1281  * snd_pcm_mmap_data_open - increase the mmap counter
1282  * @area: VMA
1283  *
1284  * PCM mmap callback should handle this counter properly
1285  */
1286 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1287 {
1288         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1289         atomic_inc(&substream->mmap_count);
1290 }
1291
1292 /**
1293  * snd_pcm_mmap_data_close - decrease the mmap counter
1294  * @area: VMA
1295  *
1296  * PCM mmap callback should handle this counter properly
1297  */
1298 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1299 {
1300         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1301         atomic_dec(&substream->mmap_count);
1302 }
1303
1304 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1305                              struct vm_area_struct *area);
1306 /* mmap for io-memory area */
1307 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1308 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1309 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1310 #else
1311 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1312 #define snd_pcm_lib_mmap_iomem  NULL
1313 #endif
1314
1315 /**
1316  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1317  * @dma: DMA number
1318  * @max: pointer to store the max size
1319  */
1320 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1321 {
1322         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1323 }
1324
1325 /*
1326  *  Misc
1327  */
1328
1329 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1330                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1331                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1332                                          (IEC958_AES3_CON_FS_48000<<24))
1333
1334 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1335
1336 const char *snd_pcm_format_name(snd_pcm_format_t format);
1337
1338 /**
1339  * snd_pcm_stream_str - Get a string naming the direction of a stream
1340  * @substream: the pcm substream instance
1341  *
1342  * Return: A string naming the direction of the stream.
1343  */
1344 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1345 {
1346         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1347                 return "Playback";
1348         else
1349                 return "Capture";
1350 }
1351
1352 /*
1353  * PCM channel-mapping control API
1354  */
1355 /* array element of channel maps */
1356 struct snd_pcm_chmap_elem {
1357         unsigned char channels;
1358         unsigned char map[15];
1359 };
1360
1361 /* channel map information; retrieved via snd_kcontrol_chip() */
1362 struct snd_pcm_chmap {
1363         struct snd_pcm *pcm;    /* assigned PCM instance */
1364         int stream;             /* PLAYBACK or CAPTURE */
1365         struct snd_kcontrol *kctl;
1366         const struct snd_pcm_chmap_elem *chmap;
1367         unsigned int max_channels;
1368         unsigned int channel_mask;      /* optional: active channels bitmask */
1369         void *private_data;     /* optional: private data pointer */
1370 };
1371
1372 /**
1373  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1374  * @info: chmap information
1375  * @idx: the substream number index
1376  */
1377 static inline struct snd_pcm_substream *
1378 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1379 {
1380         struct snd_pcm_substream *s;
1381         for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1382                 if (s->number == idx)
1383                         return s;
1384         return NULL;
1385 }
1386
1387 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1388 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1389 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1390 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1391
1392 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1393 #define SND_PCM_CHMAP_MASK_24   ((1U << 2) | (1U << 4))
1394 #define SND_PCM_CHMAP_MASK_246  (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1395 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1396
1397 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1398                            const struct snd_pcm_chmap_elem *chmap,
1399                            int max_channels,
1400                            unsigned long private_value,
1401                            struct snd_pcm_chmap **info_ret);
1402
1403 /**
1404  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1405  * @pcm_format: PCM format
1406  */
1407 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1408 {
1409         return 1ULL << (__force int) pcm_format;
1410 }
1411
1412 /* printk helpers */
1413 #define pcm_err(pcm, fmt, args...) \
1414         dev_err((pcm)->card->dev, fmt, ##args)
1415 #define pcm_warn(pcm, fmt, args...) \
1416         dev_warn((pcm)->card->dev, fmt, ##args)
1417 #define pcm_dbg(pcm, fmt, args...) \
1418         dev_dbg((pcm)->card->dev, fmt, ##args)
1419
1420 #endif /* __SOUND_PCM_H */