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