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