include/sound/pcm.h

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