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