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