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