include/sound/pcm.h

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