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
 408         /* -- private section -- */
 409         void *private_data;
 410         void (*private_free)(struct snd_pcm_runtime *runtime);
 411
 412         /* -- hardware description -- */
 413         struct snd_pcm_hardware hw;
 414         struct snd_pcm_hw_constraints hw_constraints;
 415
 416         /* -- timer -- */
 417         unsigned int timer_resolution;  /* timer resolution */
 418         int tstamp_type;                /* timestamp type */
 419
 420         /* -- DMA -- */
 421         unsigned char *dma_area;        /* DMA area */
 422         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 423         size_t dma_bytes;               /* size of DMA area */
 424
 425         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 426
 427         /* -- audio timestamp config -- */
 428         struct snd_pcm_audio_tstamp_config audio_tstamp_config;
 429         struct snd_pcm_audio_tstamp_report audio_tstamp_report;
 430         struct timespec driver_tstamp;
 431
 432 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 433         /* -- OSS things -- */
 434         struct snd_pcm_oss_runtime oss;
 435 #endif
 436 };
 437
 438 struct snd_pcm_group {          /* keep linked substreams */
 439         spinlock_t lock;
 440         struct mutex mutex;
 441         struct list_head substreams;
 442         int count;
 443 };
 444
 445 struct pid;
 446
 447 struct snd_pcm_substream {
 448         struct snd_pcm *pcm;
 449         struct snd_pcm_str *pstr;
 450         void *private_data;             /* copied from pcm->private_data */
 451         int number;
 452         char name[32];                  /* substream name */
 453         int stream;                     /* stream (direction) */
 454         struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
 455         size_t buffer_bytes_max;        /* limit ring buffer size */
 456         struct snd_dma_buffer dma_buffer;
 457         size_t dma_max;
 458         /* -- hardware operations -- */
 459         const struct snd_pcm_ops *ops;
 460         /* -- runtime information -- */
 461         struct snd_pcm_runtime *runtime;
 462         /* -- timer section -- */
 463         struct snd_timer *timer;                /* timer */
 464         unsigned timer_running: 1;      /* time is running */
 465         long wait_time; /* time in ms for R/W to wait for avail */
 466         /* -- next substream -- */
 467         struct snd_pcm_substream *next;
 468         /* -- linked substreams -- */
 469         struct list_head link_list;     /* linked list member */
 470         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 471         struct snd_pcm_group *group;            /* pointer to current group */
 472         /* -- assigned files -- */
 473         int ref_count;
 474         atomic_t mmap_count;
 475         unsigned int f_flags;
 476         void (*pcm_release)(struct snd_pcm_substream *);
 477         struct pid *pid;
 478 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 479         /* -- OSS things -- */
 480         struct snd_pcm_oss_substream oss;
 481 #endif
 482 #ifdef CONFIG_SND_VERBOSE_PROCFS
 483         struct snd_info_entry *proc_root;
 484 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 485         /* misc flags */
 486         unsigned int hw_opened: 1;
 487 };
 488
 489 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 490
 491
 492 struct snd_pcm_str {
 493         int stream;                             /* stream (direction) */
 494         struct snd_pcm *pcm;
 495         /* -- substreams -- */
 496         unsigned int substream_count;
 497         unsigned int substream_opened;
 498         struct snd_pcm_substream *substream;
 499 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 500         /* -- OSS things -- */
 501         struct snd_pcm_oss_stream oss;
 502 #endif
 503 #ifdef CONFIG_SND_VERBOSE_PROCFS
 504         struct snd_info_entry *proc_root;
 505 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 506         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 507 #endif
 508 #endif
 509         struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
 510         struct device dev;
 511 };
 512
 513 struct snd_pcm {
 514         struct snd_card *card;
 515         struct list_head list;
 516         int device; /* device number */
 517         unsigned int info_flags;
 518         unsigned short dev_class;
 519         unsigned short dev_subclass;
 520         char id[64];
 521         char name[80];
 522         struct snd_pcm_str streams[2];
 523         struct mutex open_mutex;
 524         wait_queue_head_t open_wait;
 525         void *private_data;
 526         void (*private_free) (struct snd_pcm *pcm);
 527         bool internal; /* pcm is for internal use only */
 528         bool nonatomic; /* whole PCM operations are in non-atomic context */
 529         bool no_device_suspend; /* don't invoke device PM suspend */
 530 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 531         struct snd_pcm_oss oss;
 532 #endif
 533 };
 534
 535 /*
 536  *  Registering
 537  */
 538
 539 extern const struct file_operations snd_pcm_f_ops[2];
 540
 541 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 542                 int playback_count, int capture_count,
 543                 struct snd_pcm **rpcm);
 544 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
 545                 int playback_count, int capture_count,
 546                 struct snd_pcm **rpcm);
 547 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 548
 549 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
 550 struct snd_pcm_notify {
 551         int (*n_register) (struct snd_pcm * pcm);
 552         int (*n_disconnect) (struct snd_pcm * pcm);
 553         int (*n_unregister) (struct snd_pcm * pcm);
 554         struct list_head list;
 555 };
 556 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 557 #endif
 558
 559 /*
 560  *  Native I/O
 561  */
 562
 563 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 564 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 565                       struct snd_pcm_info __user *info);
 566 int snd_pcm_status(struct snd_pcm_substream *substream,
 567                    struct snd_pcm_status *status);
 568 int snd_pcm_start(struct snd_pcm_substream *substream);
 569 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
 570 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 571 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
 572 #ifdef CONFIG_PM
 573 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 574 #else
 575 static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
 576 {
 577         return 0;
 578 }
 579 #endif
 580 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 581 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 582                            struct snd_pcm_substream **rsubstream);
 583 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 584 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 585                              struct snd_pcm_substream **rsubstream);
 586 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 587 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 588
 589
 590 #ifdef CONFIG_SND_DEBUG
 591 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
 592                            char *name, size_t len);
 593 #else
 594 static inline void
 595 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
 596 {
 597         *buf = 0;
 598 }
 599 #endif
 600
 601 /*
 602  *  PCM library
 603  */
 604
 605 /**
 606  * snd_pcm_stream_linked - Check whether the substream is linked with others
 607  * @substream: substream to check
 608  *
 609  * Returns true if the given substream is being linked with others.
 610  */
 611 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 612 {
 613         return substream->group != &substream->self_group;
 614 }
 615
 616 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
 617 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
 618 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
 619 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
 620 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
 621
 622 /**
 623  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
 624  * @substream: PCM substream
 625  * @flags: irq flags
 626  *
 627  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
 628  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
 629  * as snd_pcm_stream_lock().
 630  */
 631 #define snd_pcm_stream_lock_irqsave(substream, flags)            \
 632         do {                                                     \
 633                 typecheck(unsigned long, flags);                 \
 634                 flags = _snd_pcm_stream_lock_irqsave(substream); \
 635         } while (0)
 636 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
 637                                       unsigned long flags);
 638
 639 /**
 640  * snd_pcm_group_for_each_entry - iterate over the linked substreams
 641  * @s: the iterator
 642  * @substream: the substream
 643  *
 644  * Iterate over the all linked substreams to the given @substream.
 645  * When @substream isn't linked with any others, this gives returns @substream
 646  * itself once.
 647  */
 648 #define snd_pcm_group_for_each_entry(s, substream) \
 649         list_for_each_entry(s, &substream->group->substreams, link_list)
 650
 651 /**
 652  * snd_pcm_running - Check whether the substream is in a running state
 653  * @substream: substream to check
 654  *
 655  * Returns true if the given substream is in the state RUNNING, or in the
 656  * state DRAINING for playback.
 657  */
 658 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 659 {
 660         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 661                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 662                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 663 }
 664
 665 /**
 666  * bytes_to_samples - Unit conversion of the size from bytes to samples
 667  * @runtime: PCM runtime instance
 668  * @size: size in bytes
 669  */
 670 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 671 {
 672         return size * 8 / runtime->sample_bits;
 673 }
 674
 675 /**
 676  * bytes_to_frames - Unit conversion of the size from bytes to frames
 677  * @runtime: PCM runtime instance
 678  * @size: size in bytes
 679  */
 680 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 681 {
 682         return size * 8 / runtime->frame_bits;
 683 }
 684
 685 /**
 686  * samples_to_bytes - Unit conversion of the size from samples to bytes
 687  * @runtime: PCM runtime instance
 688  * @size: size in samples
 689  */
 690 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 691 {
 692         return size * runtime->sample_bits / 8;
 693 }
 694
 695 /**
 696  * frames_to_bytes - Unit conversion of the size from frames to bytes
 697  * @runtime: PCM runtime instance
 698  * @size: size in frames
 699  */
 700 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 701 {
 702         return size * runtime->frame_bits / 8;
 703 }
 704
 705 /**
 706  * frame_aligned - Check whether the byte size is aligned to frames
 707  * @runtime: PCM runtime instance
 708  * @bytes: size in bytes
 709  */
 710 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 711 {
 712         return bytes % runtime->byte_align == 0;
 713 }
 714
 715 /**
 716  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
 717  * @substream: PCM substream
 718  */
 719 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 720 {
 721         struct snd_pcm_runtime *runtime = substream->runtime;
 722         return frames_to_bytes(runtime, runtime->buffer_size);
 723 }
 724
 725 /**
 726  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
 727  * @substream: PCM substream
 728  */
 729 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 730 {
 731         struct snd_pcm_runtime *runtime = substream->runtime;
 732         return frames_to_bytes(runtime, runtime->period_size);
 733 }
 734
 735 /**
 736  * snd_pcm_playback_avail - Get the available (writable) space for playback
 737  * @runtime: PCM runtime instance
 738  *
 739  * Result is between 0 ... (boundary - 1)
 740  */
 741 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 742 {
 743         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 744         if (avail < 0)
 745                 avail += runtime->boundary;
 746         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 747                 avail -= runtime->boundary;
 748         return avail;
 749 }
 750
 751 /**
 752  * snd_pcm_playback_avail - Get the available (readable) space for capture
 753  * @runtime: PCM runtime instance
 754  *
 755  * Result is between 0 ... (boundary - 1)
 756  */
 757 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 758 {
 759         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 760         if (avail < 0)
 761                 avail += runtime->boundary;
 762         return avail;
 763 }
 764
 765 /**
 766  * snd_pcm_playback_hw_avail - Get the queued space for playback
 767  * @runtime: PCM runtime instance
 768  */
 769 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 770 {
 771         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 772 }
 773
 774 /**
 775  * snd_pcm_capture_hw_avail - Get the free space for capture
 776  * @runtime: PCM runtime instance
 777  */
 778 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 779 {
 780         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 781 }
 782
 783 /**
 784  * snd_pcm_playback_ready - check whether the playback buffer is available
 785  * @substream: the pcm substream instance
 786  *
 787  * Checks whether enough free space is available on the playback buffer.
 788  *
 789  * Return: Non-zero if available, or zero if not.
 790  */
 791 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 792 {
 793         struct snd_pcm_runtime *runtime = substream->runtime;
 794         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 795 }
 796
 797 /**
 798  * snd_pcm_capture_ready - check whether the capture buffer is available
 799  * @substream: the pcm substream instance
 800  *
 801  * Checks whether enough capture data is available on the capture buffer.
 802  *
 803  * Return: Non-zero if available, or zero if not.
 804  */
 805 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 806 {
 807         struct snd_pcm_runtime *runtime = substream->runtime;
 808         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 809 }
 810
 811 /**
 812  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 813  * @substream: the pcm substream instance
 814  *
 815  * Checks whether any data exists on the playback buffer.
 816  *
 817  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
 818  * is bigger or equal to boundary, then this function returns always non-zero.
 819  */
 820 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 821 {
 822         struct snd_pcm_runtime *runtime = substream->runtime;
 823
 824         if (runtime->stop_threshold >= runtime->boundary)
 825                 return 1;
 826         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 827 }
 828
 829 /**
 830  * snd_pcm_playback_empty - check whether the playback buffer is empty
 831  * @substream: the pcm substream instance
 832  *
 833  * Checks whether the playback buffer is empty.
 834  *
 835  * Return: Non-zero if empty, or zero if not.
 836  */
 837 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 838 {
 839         struct snd_pcm_runtime *runtime = substream->runtime;
 840         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 841 }
 842
 843 /**
 844  * snd_pcm_capture_empty - check whether the capture buffer is empty
 845  * @substream: the pcm substream instance
 846  *
 847  * Checks whether the capture buffer is empty.
 848  *
 849  * Return: Non-zero if empty, or zero if not.
 850  */
 851 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 852 {
 853         struct snd_pcm_runtime *runtime = substream->runtime;
 854         return snd_pcm_capture_avail(runtime) == 0;
 855 }
 856
 857 /**
 858  * snd_pcm_trigger_done - Mark the master substream
 859  * @substream: the pcm substream instance
 860  * @master: the linked master substream
 861  *
 862  * When multiple substreams of the same card are linked and the hardware
 863  * supports the single-shot operation, the driver calls this in the loop
 864  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
 865  * Then most of trigger operations are performed only to the given master
 866  * substream.
 867  *
 868  * The trigger_master mark is cleared at timestamp updates at the end
 869  * of trigger operations.
 870  */
 871 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 872                                         struct snd_pcm_substream *master)
 873 {
 874         substream->runtime->trigger_master = master;
 875 }
 876
 877 static inline int hw_is_mask(int var)
 878 {
 879         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 880                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 881 }
 882
 883 static inline int hw_is_interval(int var)
 884 {
 885         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 886                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 887 }
 888
 889 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 890                                      snd_pcm_hw_param_t var)
 891 {
 892         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 893 }
 894
 895 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 896                                              snd_pcm_hw_param_t var)
 897 {
 898         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 899 }
 900
 901 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 902                                              snd_pcm_hw_param_t var)
 903 {
 904         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 905 }
 906
 907 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 908                                                      snd_pcm_hw_param_t var)
 909 {
 910         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 911 }
 912
 913 /**
 914  * params_channels - Get the number of channels from the hw params
 915  * @p: hw params
 916  */
 917 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
 918 {
 919         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
 920 }
 921
 922 /**
 923  * params_rate - Get the sample rate from the hw params
 924  * @p: hw params
 925  */
 926 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
 927 {
 928         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
 929 }
 930
 931 /**
 932  * params_period_size - Get the period size (in frames) from the hw params
 933  * @p: hw params
 934  */
 935 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
 936 {
 937         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
 938 }
 939
 940 /**
 941  * params_periods - Get the number of periods from the hw params
 942  * @p: hw params
 943  */
 944 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
 945 {
 946         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
 947 }
 948
 949 /**
 950  * params_buffer_size - Get the buffer size (in frames) from the hw params
 951  * @p: hw params
 952  */
 953 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
 954 {
 955         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
 956 }
 957
 958 /**
 959  * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
 960  * @p: hw params
 961  */
 962 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
 963 {
 964         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
 965 }
 966
 967 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 968 int snd_interval_list(struct snd_interval *i, unsigned int count,
 969                       const unsigned int *list, unsigned int mask);
 970 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
 971                         const struct snd_interval *list, unsigned int mask);
 972 int snd_interval_ratnum(struct snd_interval *i,
 973                         unsigned int rats_count, const struct snd_ratnum *rats,
 974                         unsigned int *nump, unsigned int *denp);
 975
 976 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 977 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 978
 979 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 980
 981 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 982                                  u_int64_t mask);
 983 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 984                                  unsigned int min, unsigned int max);
 985 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
 986 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
 987                                unsigned int cond,
 988                                snd_pcm_hw_param_t var,
 989                                const struct snd_pcm_hw_constraint_list *l);
 990 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
 991                                  unsigned int cond,
 992                                  snd_pcm_hw_param_t var,
 993                                  const struct snd_pcm_hw_constraint_ranges *r);
 994 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
 995                                   unsigned int cond,
 996                                   snd_pcm_hw_param_t var,
 997                                   const struct snd_pcm_hw_constraint_ratnums *r);
 998 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
 999                                   unsigned int cond,
1000                                   snd_pcm_hw_param_t var,
1001                                   const struct snd_pcm_hw_constraint_ratdens *r);
1002 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1003                                  unsigned int cond,
1004                                  unsigned int width,
1005                                  unsigned int msbits);
1006 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1007                                unsigned int cond,
1008                                snd_pcm_hw_param_t var,
1009                                unsigned long step);
1010 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1011                                unsigned int cond,
1012                                snd_pcm_hw_param_t var);
1013 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1014                                unsigned int base_rate);
1015 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1016                         unsigned int cond,
1017                         int var,
1018                         snd_pcm_hw_rule_func_t func, void *private,
1019                         int dep, ...);
1020
1021 /**
1022  * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1023  * @runtime: PCM runtime instance
1024  * @var: The hw_params variable to constrain
1025  * @val: The value to constrain to
1026  *
1027  * Return: Positive if the value is changed, zero if it's not changed, or a
1028  * negative error code.
1029  */
1030 static inline int snd_pcm_hw_constraint_single(
1031         struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1032         unsigned int val)
1033 {
1034         return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1035 }
1036
1037 int snd_pcm_format_signed(snd_pcm_format_t format);
1038 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1039 int snd_pcm_format_linear(snd_pcm_format_t format);
1040 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1041 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1042 #if 0 /* just for kernel-doc */
1043 /**
1044  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1045  * @format: the format to check
1046  *
1047  * Return: 1 if the given PCM format is CPU-endian, 0 if
1048  * opposite, or a negative error code if endian not specified.
1049  */
1050 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1051 #endif /* DocBook */
1052 #ifdef SNDRV_LITTLE_ENDIAN
1053 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1054 #else
1055 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1056 #endif
1057 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
1058 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
1059 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1060 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1061 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1062
1063 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1064                      const struct snd_pcm_ops *ops);
1065 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1066 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1067                       unsigned int cmd, void *arg);
1068 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1069 snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1070                                      void *buf, bool interleaved,
1071                                      snd_pcm_uframes_t frames, bool in_kernel);
1072
1073 static inline snd_pcm_sframes_t
1074 snd_pcm_lib_write(struct snd_pcm_substream *substream,
1075                   const void __user *buf, snd_pcm_uframes_t frames)
1076 {
1077         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1078 }
1079
1080 static inline snd_pcm_sframes_t
1081 snd_pcm_lib_read(struct snd_pcm_substream *substream,
1082                  void __user *buf, snd_pcm_uframes_t frames)
1083 {
1084         return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1085 }
1086
1087 static inline snd_pcm_sframes_t
1088 snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1089                    void __user **bufs, snd_pcm_uframes_t frames)
1090 {
1091         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1092 }
1093
1094 static inline snd_pcm_sframes_t
1095 snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1096                   void __user **bufs, snd_pcm_uframes_t frames)
1097 {
1098         return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1099 }
1100
1101 static inline snd_pcm_sframes_t
1102 snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1103                      const void *buf, snd_pcm_uframes_t frames)
1104 {
1105         return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1106 }
1107
1108 static inline snd_pcm_sframes_t
1109 snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1110                     void *buf, snd_pcm_uframes_t frames)
1111 {
1112         return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1113 }
1114
1115 static inline snd_pcm_sframes_t
1116 snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1117                       void **bufs, snd_pcm_uframes_t frames)
1118 {
1119         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1120 }
1121
1122 static inline snd_pcm_sframes_t
1123 snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1124                      void **bufs, snd_pcm_uframes_t frames)
1125 {
1126         return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1127 }
1128
1129 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1130 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1131 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1132 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1133                                          unsigned int rates_b);
1134 unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1135                                         unsigned int rate_max);
1136
1137 /**
1138  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1139  * @substream: PCM substream to set
1140  * @bufp: the buffer information, NULL to clear
1141  *
1142  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1143  * Otherwise it clears the current buffer information.
1144  */
1145 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1146                                               struct snd_dma_buffer *bufp)
1147 {
1148         struct snd_pcm_runtime *runtime = substream->runtime;
1149         if (bufp) {
1150                 runtime->dma_buffer_p = bufp;
1151                 runtime->dma_area = bufp->area;
1152                 runtime->dma_addr = bufp->addr;
1153                 runtime->dma_bytes = bufp->bytes;
1154         } else {
1155                 runtime->dma_buffer_p = NULL;
1156                 runtime->dma_area = NULL;
1157                 runtime->dma_addr = 0;
1158                 runtime->dma_bytes = 0;
1159         }
1160 }
1161
1162 /**
1163  * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1164  * @runtime: PCM runtime instance
1165  * @tv: timespec to fill
1166  */
1167 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1168                                    struct timespec *tv)
1169 {
1170         switch (runtime->tstamp_type) {
1171         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1172                 ktime_get_ts(tv);
1173                 break;
1174         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1175                 getrawmonotonic(tv);
1176                 break;
1177         default:
1178                 getnstimeofday(tv);
1179                 break;
1180         }
1181 }
1182
1183 /*
1184  *  Memory
1185  */
1186
1187 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1188 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1189 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1190                                   int type, struct device *data,
1191                                   size_t size, size_t max);
1192 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1193                                           int type, void *data,
1194                                           size_t size, size_t max);
1195 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1196 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1197
1198 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1199                                       size_t size, gfp_t gfp_flags);
1200 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1201 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1202                                           unsigned long offset);
1203 /**
1204  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1205  * @substream: the substream to allocate the buffer to
1206  * @size: the requested buffer size, in bytes
1207  *
1208  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1209  * contiguous in kernel virtual space, but not in physical memory.  Use this
1210  * if the buffer is accessed by kernel code but not by device DMA.
1211  *
1212  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1213  * code.
1214  */
1215 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1216                         (struct snd_pcm_substream *substream, size_t size)
1217 {
1218         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1219                                                  GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1220 }
1221
1222 /**
1223  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1224  * @substream: the substream to allocate the buffer to
1225  * @size: the requested buffer size, in bytes
1226  *
1227  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1228  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
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_32_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_DMA32 | __GFP_ZERO);
1238 }
1239
1240 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1241
1242 #ifdef CONFIG_SND_DMA_SGBUF
1243 /*
1244  * SG-buffer handling
1245  */
1246 #define snd_pcm_substream_sgbuf(substream) \
1247         snd_pcm_get_dma_buf(substream)->private_data
1248
1249 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1250                                     unsigned long offset);
1251 #else /* !SND_DMA_SGBUF */
1252 /*
1253  * fake using a continuous buffer
1254  */
1255 #define snd_pcm_sgbuf_ops_page  NULL
1256 #endif /* SND_DMA_SGBUF */
1257
1258 /**
1259  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1260  * @substream: PCM substream
1261  * @ofs: byte offset
1262  */
1263 static inline dma_addr_t
1264 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1265 {
1266         return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1267 }
1268
1269 /**
1270  * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1271  * @substream: PCM substream
1272  * @ofs: byte offset
1273  */
1274 static inline void *
1275 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1276 {
1277         return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1278 }
1279
1280 /**
1281  * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1282  * page from the given size
1283  * @substream: PCM substream
1284  * @ofs: byte offset
1285  * @size: byte size to examine
1286  */
1287 static inline unsigned int
1288 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1289                              unsigned int ofs, unsigned int size)
1290 {
1291         return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1292 }
1293
1294 /**
1295  * snd_pcm_mmap_data_open - increase the mmap counter
1296  * @area: VMA
1297  *
1298  * PCM mmap callback should handle this counter properly
1299  */
1300 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1301 {
1302         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1303         atomic_inc(&substream->mmap_count);
1304 }
1305
1306 /**
1307  * snd_pcm_mmap_data_close - decrease the mmap counter
1308  * @area: VMA
1309  *
1310  * PCM mmap callback should handle this counter properly
1311  */
1312 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1313 {
1314         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1315         atomic_dec(&substream->mmap_count);
1316 }
1317
1318 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1319                              struct vm_area_struct *area);
1320 /* mmap for io-memory area */
1321 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1322 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1323 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1324 #else
1325 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1326 #define snd_pcm_lib_mmap_iomem  NULL
1327 #endif
1328
1329 /**
1330  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1331  * @dma: DMA number
1332  * @max: pointer to store the max size
1333  */
1334 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1335 {
1336         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1337 }
1338
1339 /*
1340  *  Misc
1341  */
1342
1343 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1344                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1345                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1346                                          (IEC958_AES3_CON_FS_48000<<24))
1347
1348 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1349
1350 const char *snd_pcm_format_name(snd_pcm_format_t format);
1351
1352 /**
1353  * snd_pcm_stream_str - Get a string naming the direction of a stream
1354  * @substream: the pcm substream instance
1355  *
1356  * Return: A string naming the direction of the stream.
1357  */
1358 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1359 {
1360         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1361                 return "Playback";
1362         else
1363                 return "Capture";
1364 }
1365
1366 /*
1367  * PCM channel-mapping control API
1368  */
1369 /* array element of channel maps */
1370 struct snd_pcm_chmap_elem {
1371         unsigned char channels;
1372         unsigned char map[15];
1373 };
1374
1375 /* channel map information; retrieved via snd_kcontrol_chip() */
1376 struct snd_pcm_chmap {
1377         struct snd_pcm *pcm;    /* assigned PCM instance */
1378         int stream;             /* PLAYBACK or CAPTURE */
1379         struct snd_kcontrol *kctl;
1380         const struct snd_pcm_chmap_elem *chmap;
1381         unsigned int max_channels;
1382         unsigned int channel_mask;      /* optional: active channels bitmask */
1383         void *private_data;     /* optional: private data pointer */
1384 };
1385
1386 /**
1387  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1388  * @info: chmap information
1389  * @idx: the substream number index
1390  */
1391 static inline struct snd_pcm_substream *
1392 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1393 {
1394         struct snd_pcm_substream *s;
1395         for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1396                 if (s->number == idx)
1397                         return s;
1398         return NULL;
1399 }
1400
1401 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1402 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1403 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1404 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1405
1406 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1407 #define SND_PCM_CHMAP_MASK_24   ((1U << 2) | (1U << 4))
1408 #define SND_PCM_CHMAP_MASK_246  (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1409 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1410
1411 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1412                            const struct snd_pcm_chmap_elem *chmap,
1413                            int max_channels,
1414                            unsigned long private_value,
1415                            struct snd_pcm_chmap **info_ret);
1416
1417 /**
1418  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1419  * @pcm_format: PCM format
1420  */
1421 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1422 {
1423         return 1ULL << (__force int) pcm_format;
1424 }
1425
1426 /* printk helpers */
1427 #define pcm_err(pcm, fmt, args...) \
1428         dev_err((pcm)->card->dev, fmt, ##args)
1429 #define pcm_warn(pcm, fmt, args...) \
1430         dev_warn((pcm)->card->dev, fmt, ##args)
1431 #define pcm_dbg(pcm, fmt, args...) \
1432         dev_dbg((pcm)->card->dev, fmt, ##args)
1433
1434 #endif /* __SOUND_PCM_H */