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
  33 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
  34 #define snd_pcm_chip(pcm) ((pcm)->private_data)
  35
  36 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
  37 #include "pcm_oss.h"
  38 #endif
  39
  40 /*
  41  *  Hardware (lowlevel) section
  42  */
  43
  44 struct snd_pcm_hardware {
  45         unsigned int info;              /* SNDRV_PCM_INFO_* */
  46         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
  47         unsigned int rates;             /* SNDRV_PCM_RATE_* */
  48         unsigned int rate_min;          /* min rate */
  49         unsigned int rate_max;          /* max rate */
  50         unsigned int channels_min;      /* min channels */
  51         unsigned int channels_max;      /* max channels */
  52         size_t buffer_bytes_max;        /* max buffer size */
  53         size_t period_bytes_min;        /* min period size */
  54         size_t period_bytes_max;        /* max period size */
  55         unsigned int periods_min;       /* min # of periods */
  56         unsigned int periods_max;       /* max # of periods */
  57         size_t fifo_size;               /* fifo size in bytes */
  58 };
  59
  60 struct snd_pcm_substream;
  61
  62 struct snd_pcm_ops {
  63         int (*open)(struct snd_pcm_substream *substream);
  64         int (*close)(struct snd_pcm_substream *substream);
  65         int (*ioctl)(struct snd_pcm_substream * substream,
  66                      unsigned int cmd, void *arg);
  67         int (*hw_params)(struct snd_pcm_substream *substream,
  68                          struct snd_pcm_hw_params *params);
  69         int (*hw_free)(struct snd_pcm_substream *substream);
  70         int (*prepare)(struct snd_pcm_substream *substream);
  71         int (*trigger)(struct snd_pcm_substream *substream, int cmd);
  72         snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
  73         int (*copy)(struct snd_pcm_substream *substream, int channel,
  74                     snd_pcm_uframes_t pos,
  75                     void __user *buf, snd_pcm_uframes_t count);
  76         int (*silence)(struct snd_pcm_substream *substream, int channel,
  77                        snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
  78         struct page *(*page)(struct snd_pcm_substream *substream,
  79                              unsigned long offset);
  80         int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
  81         int (*ack)(struct snd_pcm_substream *substream);
  82 };
  83
  84 /*
  85  *
  86  */
  87
  88 #if defined(CONFIG_SND_DYNAMIC_MINORS)
  89 #define SNDRV_PCM_DEVICES       (SNDRV_OS_MINORS-2)
  90 #else
  91 #define SNDRV_PCM_DEVICES       8
  92 #endif
  93
  94 #define SNDRV_PCM_IOCTL1_FALSE          ((void *)0)
  95 #define SNDRV_PCM_IOCTL1_TRUE           ((void *)1)
  96
  97 #define SNDRV_PCM_IOCTL1_RESET          0
  98 #define SNDRV_PCM_IOCTL1_INFO           1
  99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO   2
 100 #define SNDRV_PCM_IOCTL1_GSTATE         3
 101 #define SNDRV_PCM_IOCTL1_FIFO_SIZE      4
 102
 103 #define SNDRV_PCM_TRIGGER_STOP          0
 104 #define SNDRV_PCM_TRIGGER_START         1
 105 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH    3
 106 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
 107 #define SNDRV_PCM_TRIGGER_SUSPEND       5
 108 #define SNDRV_PCM_TRIGGER_RESUME        6
 109
 110 #define SNDRV_PCM_POS_XRUN              ((snd_pcm_uframes_t)-1)
 111
 112 /* If you change this don't forget to change rates[] table in pcm_native.c */
 113 #define SNDRV_PCM_RATE_5512             (1<<0)          /* 5512Hz */
 114 #define SNDRV_PCM_RATE_8000             (1<<1)          /* 8000Hz */
 115 #define SNDRV_PCM_RATE_11025            (1<<2)          /* 11025Hz */
 116 #define SNDRV_PCM_RATE_16000            (1<<3)          /* 16000Hz */
 117 #define SNDRV_PCM_RATE_22050            (1<<4)          /* 22050Hz */
 118 #define SNDRV_PCM_RATE_32000            (1<<5)          /* 32000Hz */
 119 #define SNDRV_PCM_RATE_44100            (1<<6)          /* 44100Hz */
 120 #define SNDRV_PCM_RATE_48000            (1<<7)          /* 48000Hz */
 121 #define SNDRV_PCM_RATE_64000            (1<<8)          /* 64000Hz */
 122 #define SNDRV_PCM_RATE_88200            (1<<9)          /* 88200Hz */
 123 #define SNDRV_PCM_RATE_96000            (1<<10)         /* 96000Hz */
 124 #define SNDRV_PCM_RATE_176400           (1<<11)         /* 176400Hz */
 125 #define SNDRV_PCM_RATE_192000           (1<<12)         /* 192000Hz */
 126
 127 #define SNDRV_PCM_RATE_CONTINUOUS       (1<<30)         /* continuous range */
 128 #define SNDRV_PCM_RATE_KNOT             (1<<31)         /* supports more non-continuos rates */
 129
 130 #define SNDRV_PCM_RATE_8000_44100       (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
 131                                          SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
 132                                          SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
 133 #define SNDRV_PCM_RATE_8000_48000       (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
 134 #define SNDRV_PCM_RATE_8000_96000       (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
 135                                          SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
 136 #define SNDRV_PCM_RATE_8000_192000      (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
 137                                          SNDRV_PCM_RATE_192000)
 138 #define SNDRV_PCM_FMTBIT_S8             (1ULL << SNDRV_PCM_FORMAT_S8)
 139 #define SNDRV_PCM_FMTBIT_U8             (1ULL << SNDRV_PCM_FORMAT_U8)
 140 #define SNDRV_PCM_FMTBIT_S16_LE         (1ULL << SNDRV_PCM_FORMAT_S16_LE)
 141 #define SNDRV_PCM_FMTBIT_S16_BE         (1ULL << SNDRV_PCM_FORMAT_S16_BE)
 142 #define SNDRV_PCM_FMTBIT_U16_LE         (1ULL << SNDRV_PCM_FORMAT_U16_LE)
 143 #define SNDRV_PCM_FMTBIT_U16_BE         (1ULL << SNDRV_PCM_FORMAT_U16_BE)
 144 #define SNDRV_PCM_FMTBIT_S24_LE         (1ULL << SNDRV_PCM_FORMAT_S24_LE)
 145 #define SNDRV_PCM_FMTBIT_S24_BE         (1ULL << SNDRV_PCM_FORMAT_S24_BE)
 146 #define SNDRV_PCM_FMTBIT_U24_LE         (1ULL << SNDRV_PCM_FORMAT_U24_LE)
 147 #define SNDRV_PCM_FMTBIT_U24_BE         (1ULL << SNDRV_PCM_FORMAT_U24_BE)
 148 #define SNDRV_PCM_FMTBIT_S32_LE         (1ULL << SNDRV_PCM_FORMAT_S32_LE)
 149 #define SNDRV_PCM_FMTBIT_S32_BE         (1ULL << SNDRV_PCM_FORMAT_S32_BE)
 150 #define SNDRV_PCM_FMTBIT_U32_LE         (1ULL << SNDRV_PCM_FORMAT_U32_LE)
 151 #define SNDRV_PCM_FMTBIT_U32_BE         (1ULL << SNDRV_PCM_FORMAT_U32_BE)
 152 #define SNDRV_PCM_FMTBIT_FLOAT_LE       (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
 153 #define SNDRV_PCM_FMTBIT_FLOAT_BE       (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
 154 #define SNDRV_PCM_FMTBIT_FLOAT64_LE     (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
 155 #define SNDRV_PCM_FMTBIT_FLOAT64_BE     (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
 156 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
 157 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
 158 #define SNDRV_PCM_FMTBIT_MU_LAW         (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
 159 #define SNDRV_PCM_FMTBIT_A_LAW          (1ULL << SNDRV_PCM_FORMAT_A_LAW)
 160 #define SNDRV_PCM_FMTBIT_IMA_ADPCM      (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
 161 #define SNDRV_PCM_FMTBIT_MPEG           (1ULL << SNDRV_PCM_FORMAT_MPEG)
 162 #define SNDRV_PCM_FMTBIT_GSM            (1ULL << SNDRV_PCM_FORMAT_GSM)
 163 #define SNDRV_PCM_FMTBIT_SPECIAL        (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
 164 #define SNDRV_PCM_FMTBIT_S24_3LE        (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
 165 #define SNDRV_PCM_FMTBIT_U24_3LE        (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
 166 #define SNDRV_PCM_FMTBIT_S24_3BE        (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
 167 #define SNDRV_PCM_FMTBIT_U24_3BE        (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
 168 #define SNDRV_PCM_FMTBIT_S20_3LE        (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
 169 #define SNDRV_PCM_FMTBIT_U20_3LE        (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
 170 #define SNDRV_PCM_FMTBIT_S20_3BE        (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
 171 #define SNDRV_PCM_FMTBIT_U20_3BE        (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
 172 #define SNDRV_PCM_FMTBIT_S18_3LE        (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
 173 #define SNDRV_PCM_FMTBIT_U18_3LE        (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
 174 #define SNDRV_PCM_FMTBIT_S18_3BE        (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
 175 #define SNDRV_PCM_FMTBIT_U18_3BE        (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
 176
 177 #ifdef SNDRV_LITTLE_ENDIAN
 178 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_LE
 179 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_LE
 180 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_LE
 181 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_LE
 182 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_LE
 183 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_LE
 184 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_LE
 185 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_LE
 186 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
 187 #endif
 188 #ifdef SNDRV_BIG_ENDIAN
 189 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_BE
 190 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_BE
 191 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_BE
 192 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_BE
 193 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_BE
 194 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_BE
 195 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_BE
 196 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_BE
 197 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
 198 #endif
 199
 200 struct snd_pcm_file {
 201         struct snd_pcm_substream *substream;
 202         int no_compat_mmap;
 203 };
 204
 205 struct snd_pcm_hw_rule;
 206 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
 207                                       struct snd_pcm_hw_rule *rule);
 208
 209 struct snd_pcm_hw_rule {
 210         unsigned int cond;
 211         snd_pcm_hw_rule_func_t func;
 212         int var;
 213         int deps[4];
 214         void *private;
 215 };
 216
 217 struct snd_pcm_hw_constraints {
 218         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
 219                          SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
 220         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
 221                              SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
 222         unsigned int rules_num;
 223         unsigned int rules_all;
 224         struct snd_pcm_hw_rule *rules;
 225 };
 226
 227 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
 228                                             snd_pcm_hw_param_t var)
 229 {
 230         return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 231 }
 232
 233 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
 234                                                     snd_pcm_hw_param_t var)
 235 {
 236         return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 237 }
 238
 239 struct snd_ratnum {
 240         unsigned int num;
 241         unsigned int den_min, den_max, den_step;
 242 };
 243
 244 struct snd_ratden {
 245         unsigned int num_min, num_max, num_step;
 246         unsigned int den;
 247 };
 248
 249 struct snd_pcm_hw_constraint_ratnums {
 250         int nrats;
 251         struct snd_ratnum *rats;
 252 };
 253
 254 struct snd_pcm_hw_constraint_ratdens {
 255         int nrats;
 256         struct snd_ratden *rats;
 257 };
 258
 259 struct snd_pcm_hw_constraint_list {
 260         unsigned int count;
 261         unsigned int *list;
 262         unsigned int mask;
 263 };
 264
 265 struct snd_pcm_runtime {
 266         /* -- Status -- */
 267         struct snd_pcm_substream *trigger_master;
 268         struct timespec trigger_tstamp; /* trigger timestamp */
 269         int overrange;
 270         snd_pcm_uframes_t avail_max;
 271         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
 272         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
 273         unsigned long hw_ptr_jiffies;   /* Time when hw_ptr is updated */
 274         snd_pcm_sframes_t delay;        /* extra delay; typically FIFO size */
 275
 276         /* -- HW params -- */
 277         snd_pcm_access_t access;        /* access mode */
 278         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
 279         snd_pcm_subformat_t subformat;  /* subformat */
 280         unsigned int rate;              /* rate in Hz */
 281         unsigned int channels;          /* channels */
 282         snd_pcm_uframes_t period_size;  /* period size */
 283         unsigned int periods;           /* periods */
 284         snd_pcm_uframes_t buffer_size;  /* buffer size */
 285         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
 286         size_t byte_align;
 287         unsigned int frame_bits;
 288         unsigned int sample_bits;
 289         unsigned int info;
 290         unsigned int rate_num;
 291         unsigned int rate_den;
 292
 293         /* -- SW params -- */
 294         int tstamp_mode;                /* mmap timestamp is updated */
 295         unsigned int period_step;
 296         snd_pcm_uframes_t start_threshold;
 297         snd_pcm_uframes_t stop_threshold;
 298         snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
 299                                                 noise is nearest than this */
 300         snd_pcm_uframes_t silence_size; /* Silence filling size */
 301         snd_pcm_uframes_t boundary;     /* pointers wrap point */
 302
 303         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
 304         snd_pcm_uframes_t silence_filled; /* size filled with silence */
 305
 306         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 307
 308         /* -- mmap -- */
 309         struct snd_pcm_mmap_status *status;
 310         struct snd_pcm_mmap_control *control;
 311
 312         /* -- locking / scheduling -- */
 313         wait_queue_head_t sleep;
 314         struct fasync_struct *fasync;
 315
 316         /* -- private section -- */
 317         void *private_data;
 318         void (*private_free)(struct snd_pcm_runtime *runtime);
 319
 320         /* -- hardware description -- */
 321         struct snd_pcm_hardware hw;
 322         struct snd_pcm_hw_constraints hw_constraints;
 323
 324         /* -- interrupt callbacks -- */
 325         void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
 326         void (*transfer_ack_end)(struct snd_pcm_substream *substream);
 327
 328         /* -- timer -- */
 329         unsigned int timer_resolution;  /* timer resolution */
 330         int tstamp_type;                /* timestamp type */
 331
 332         /* -- DMA -- */
 333         unsigned char *dma_area;        /* DMA area */
 334         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 335         size_t dma_bytes;               /* size of DMA area */
 336
 337         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 338
 339 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 340         /* -- OSS things -- */
 341         struct snd_pcm_oss_runtime oss;
 342 #endif
 343 };
 344
 345 struct snd_pcm_group {          /* keep linked substreams */
 346         spinlock_t lock;
 347         struct list_head substreams;
 348         int count;
 349 };
 350
 351 struct pid;
 352
 353 struct snd_pcm_substream {
 354         struct snd_pcm *pcm;
 355         struct snd_pcm_str *pstr;
 356         void *private_data;             /* copied from pcm->private_data */
 357         int number;
 358         char name[32];                  /* substream name */
 359         int stream;                     /* stream (direction) */
 360         char latency_id[20];            /* latency identifier */
 361         size_t buffer_bytes_max;        /* limit ring buffer size */
 362         struct snd_dma_buffer dma_buffer;
 363         unsigned int dma_buf_id;
 364         size_t dma_max;
 365         /* -- hardware operations -- */
 366         struct snd_pcm_ops *ops;
 367         /* -- runtime information -- */
 368         struct snd_pcm_runtime *runtime;
 369         /* -- timer section -- */
 370         struct snd_timer *timer;                /* timer */
 371         unsigned timer_running: 1;      /* time is running */
 372         /* -- next substream -- */
 373         struct snd_pcm_substream *next;
 374         /* -- linked substreams -- */
 375         struct list_head link_list;     /* linked list member */
 376         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 377         struct snd_pcm_group *group;            /* pointer to current group */
 378         /* -- assigned files -- */
 379         void *file;
 380         int ref_count;
 381         atomic_t mmap_count;
 382         unsigned int f_flags;
 383         void (*pcm_release)(struct snd_pcm_substream *);
 384         struct pid *pid;
 385 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 386         /* -- OSS things -- */
 387         struct snd_pcm_oss_substream oss;
 388 #endif
 389 #ifdef CONFIG_SND_VERBOSE_PROCFS
 390         struct snd_info_entry *proc_root;
 391         struct snd_info_entry *proc_info_entry;
 392         struct snd_info_entry *proc_hw_params_entry;
 393         struct snd_info_entry *proc_sw_params_entry;
 394         struct snd_info_entry *proc_status_entry;
 395         struct snd_info_entry *proc_prealloc_entry;
 396         struct snd_info_entry *proc_prealloc_max_entry;
 397 #endif
 398         /* misc flags */
 399         unsigned int hw_opened: 1;
 400 };
 401
 402 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 403
 404
 405 struct snd_pcm_str {
 406         int stream;                             /* stream (direction) */
 407         struct snd_pcm *pcm;
 408         /* -- substreams -- */
 409         unsigned int substream_count;
 410         unsigned int substream_opened;
 411         struct snd_pcm_substream *substream;
 412 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 413         /* -- OSS things -- */
 414         struct snd_pcm_oss_stream oss;
 415 #endif
 416 #ifdef CONFIG_SND_VERBOSE_PROCFS
 417         struct snd_info_entry *proc_root;
 418         struct snd_info_entry *proc_info_entry;
 419 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 420         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 421         struct snd_info_entry *proc_xrun_debug_entry;
 422 #endif
 423 #endif
 424 };
 425
 426 struct snd_pcm {
 427         struct snd_card *card;
 428         struct list_head list;
 429         int device; /* device number */
 430         unsigned int info_flags;
 431         unsigned short dev_class;
 432         unsigned short dev_subclass;
 433         char id[64];
 434         char name[80];
 435         struct snd_pcm_str streams[2];
 436         struct mutex open_mutex;
 437         wait_queue_head_t open_wait;
 438         void *private_data;
 439         void (*private_free) (struct snd_pcm *pcm);
 440         struct device *dev; /* actual hw device this belongs to */
 441 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 442         struct snd_pcm_oss oss;
 443 #endif
 444 };
 445
 446 struct snd_pcm_notify {
 447         int (*n_register) (struct snd_pcm * pcm);
 448         int (*n_disconnect) (struct snd_pcm * pcm);
 449         int (*n_unregister) (struct snd_pcm * pcm);
 450         struct list_head list;
 451 };
 452
 453 /*
 454  *  Registering
 455  */
 456
 457 extern const struct file_operations snd_pcm_f_ops[2];
 458
 459 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 460                 int playback_count, int capture_count,
 461                 struct snd_pcm **rpcm);
 462 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 463
 464 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 465
 466 /*
 467  *  Native I/O
 468  */
 469
 470 extern rwlock_t snd_pcm_link_rwlock;
 471
 472 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 473 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 474                       struct snd_pcm_info __user *info);
 475 int snd_pcm_status(struct snd_pcm_substream *substream,
 476                    struct snd_pcm_status *status);
 477 int snd_pcm_start(struct snd_pcm_substream *substream);
 478 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
 479 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 480 #ifdef CONFIG_PM
 481 int snd_pcm_suspend(struct snd_pcm_substream *substream);
 482 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 483 #endif
 484 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 485 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 486                            struct snd_pcm_substream **rsubstream);
 487 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 488 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 489                              struct snd_pcm_substream **rsubstream);
 490 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 491 void snd_pcm_vma_notify_data(void *client, void *data);
 492 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 493
 494 /*
 495  *  PCM library
 496  */
 497
 498 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 499 {
 500         return substream->group != &substream->self_group;
 501 }
 502
 503 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
 504 {
 505         read_lock(&snd_pcm_link_rwlock);
 506         spin_lock(&substream->self_group.lock);
 507 }
 508
 509 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
 510 {
 511         spin_unlock(&substream->self_group.lock);
 512         read_unlock(&snd_pcm_link_rwlock);
 513 }
 514
 515 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
 516 {
 517         read_lock_irq(&snd_pcm_link_rwlock);
 518         spin_lock(&substream->self_group.lock);
 519 }
 520
 521 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
 522 {
 523         spin_unlock(&substream->self_group.lock);
 524         read_unlock_irq(&snd_pcm_link_rwlock);
 525 }
 526
 527 #define snd_pcm_stream_lock_irqsave(substream, flags) \
 528 do { \
 529         read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
 530         spin_lock(&substream->self_group.lock); \
 531 } while (0)
 532
 533 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
 534 do { \
 535         spin_unlock(&substream->self_group.lock); \
 536         read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
 537 } while (0)
 538
 539 #define snd_pcm_group_for_each_entry(s, substream) \
 540         list_for_each_entry(s, &substream->group->substreams, link_list)
 541
 542 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 543 {
 544         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 545                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 546                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 547 }
 548
 549 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 550 {
 551         return size * 8 / runtime->sample_bits;
 552 }
 553
 554 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 555 {
 556         return size * 8 / runtime->frame_bits;
 557 }
 558
 559 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 560 {
 561         return size * runtime->sample_bits / 8;
 562 }
 563
 564 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 565 {
 566         return size * runtime->frame_bits / 8;
 567 }
 568
 569 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 570 {
 571         return bytes % runtime->byte_align == 0;
 572 }
 573
 574 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 575 {
 576         struct snd_pcm_runtime *runtime = substream->runtime;
 577         return frames_to_bytes(runtime, runtime->buffer_size);
 578 }
 579
 580 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 581 {
 582         struct snd_pcm_runtime *runtime = substream->runtime;
 583         return frames_to_bytes(runtime, runtime->period_size);
 584 }
 585
 586 /*
 587  *  result is: 0 ... (boundary - 1)
 588  */
 589 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 590 {
 591         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 592         if (avail < 0)
 593                 avail += runtime->boundary;
 594         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 595                 avail -= runtime->boundary;
 596         return avail;
 597 }
 598
 599 /*
 600  *  result is: 0 ... (boundary - 1)
 601  */
 602 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 603 {
 604         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 605         if (avail < 0)
 606                 avail += runtime->boundary;
 607         return avail;
 608 }
 609
 610 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 611 {
 612         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 613 }
 614
 615 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 616 {
 617         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 618 }
 619
 620 /**
 621  * snd_pcm_playback_ready - check whether the playback buffer is available
 622  * @substream: the pcm substream instance
 623  *
 624  * Checks whether enough free space is available on the playback buffer.
 625  *
 626  * Returns non-zero if available, or zero if not.
 627  */
 628 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 629 {
 630         struct snd_pcm_runtime *runtime = substream->runtime;
 631         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 632 }
 633
 634 /**
 635  * snd_pcm_capture_ready - check whether the capture buffer is available
 636  * @substream: the pcm substream instance
 637  *
 638  * Checks whether enough capture data is available on the capture buffer.
 639  *
 640  * Returns non-zero if available, or zero if not.
 641  */
 642 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 643 {
 644         struct snd_pcm_runtime *runtime = substream->runtime;
 645         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 646 }
 647
 648 /**
 649  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 650  * @substream: the pcm substream instance
 651  *
 652  * Checks whether any data exists on the playback buffer. If stop_threshold
 653  * is bigger or equal to boundary, then this function returns always non-zero.
 654  *
 655  * Returns non-zero if exists, or zero if not.
 656  */
 657 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 658 {
 659         struct snd_pcm_runtime *runtime = substream->runtime;
 660
 661         if (runtime->stop_threshold >= runtime->boundary)
 662                 return 1;
 663         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 664 }
 665
 666 /**
 667  * snd_pcm_playback_empty - check whether the playback buffer is empty
 668  * @substream: the pcm substream instance
 669  *
 670  * Checks whether the playback buffer is empty.
 671  *
 672  * Returns non-zero if empty, or zero if not.
 673  */
 674 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 675 {
 676         struct snd_pcm_runtime *runtime = substream->runtime;
 677         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 678 }
 679
 680 /**
 681  * snd_pcm_capture_empty - check whether the capture buffer is empty
 682  * @substream: the pcm substream instance
 683  *
 684  * Checks whether the capture buffer is empty.
 685  *
 686  * Returns non-zero if empty, or zero if not.
 687  */
 688 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 689 {
 690         struct snd_pcm_runtime *runtime = substream->runtime;
 691         return snd_pcm_capture_avail(runtime) == 0;
 692 }
 693
 694 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 695                                         struct snd_pcm_substream *master)
 696 {
 697         substream->runtime->trigger_master = master;
 698 }
 699
 700 static inline int hw_is_mask(int var)
 701 {
 702         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 703                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 704 }
 705
 706 static inline int hw_is_interval(int var)
 707 {
 708         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 709                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 710 }
 711
 712 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 713                                      snd_pcm_hw_param_t var)
 714 {
 715         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 716 }
 717
 718 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 719                                              snd_pcm_hw_param_t var)
 720 {
 721         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 722 }
 723
 724 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 725                                              snd_pcm_hw_param_t var)
 726 {
 727         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 728 }
 729
 730 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 731                                                      snd_pcm_hw_param_t var)
 732 {
 733         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 734 }
 735
 736 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
 737 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
 738 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
 739 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
 740 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
 741 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
 742 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
 743 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
 744 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
 745 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
 746
 747
 748 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 749 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 750 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 751 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
 752                           unsigned int k, struct snd_interval *c);
 753 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
 754                           const struct snd_interval *b, struct snd_interval *c);
 755 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
 756 int snd_interval_ratnum(struct snd_interval *i,
 757                         unsigned int rats_count, struct snd_ratnum *rats,
 758                         unsigned int *nump, unsigned int *denp);
 759
 760 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 761 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 762 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 763
 764 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 765
 766 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
 767 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
 768
 769 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 770                                u_int32_t mask);
 771 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 772                                  u_int64_t mask);
 773 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 774                                  unsigned int min, unsigned int max);
 775 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
 776 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
 777                                unsigned int cond,
 778                                snd_pcm_hw_param_t var,
 779                                struct snd_pcm_hw_constraint_list *l);
 780 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
 781                                   unsigned int cond,
 782                                   snd_pcm_hw_param_t var,
 783                                   struct snd_pcm_hw_constraint_ratnums *r);
 784 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
 785                                   unsigned int cond,
 786                                   snd_pcm_hw_param_t var,
 787                                   struct snd_pcm_hw_constraint_ratdens *r);
 788 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
 789                                  unsigned int cond,
 790                                  unsigned int width,
 791                                  unsigned int msbits);
 792 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
 793                                unsigned int cond,
 794                                snd_pcm_hw_param_t var,
 795                                unsigned long step);
 796 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
 797                                unsigned int cond,
 798                                snd_pcm_hw_param_t var);
 799 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
 800                         unsigned int cond,
 801                         int var,
 802                         snd_pcm_hw_rule_func_t func, void *private,
 803                         int dep, ...);
 804
 805 int snd_pcm_format_signed(snd_pcm_format_t format);
 806 int snd_pcm_format_unsigned(snd_pcm_format_t format);
 807 int snd_pcm_format_linear(snd_pcm_format_t format);
 808 int snd_pcm_format_little_endian(snd_pcm_format_t format);
 809 int snd_pcm_format_big_endian(snd_pcm_format_t format);
 810 #if 0 /* just for DocBook */
 811 /**
 812  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
 813  * @format: the format to check
 814  *
 815  * Returns 1 if the given PCM format is CPU-endian, 0 if
 816  * opposite, or a negative error code if endian not specified.
 817  */
 818 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
 819 #endif /* DocBook */
 820 #ifdef SNDRV_LITTLE_ENDIAN
 821 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
 822 #else
 823 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
 824 #endif
 825 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
 826 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
 827 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
 828 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
 829 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
 830 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
 831
 832 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
 833 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
 834 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
 835 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
 836                       unsigned int cmd, void *arg);
 837 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
 838 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
 839 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
 840 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
 841 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
 842 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
 843 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
 844 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
 845                                     const void __user *buf,
 846                                     snd_pcm_uframes_t frames);
 847 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
 848                                    void __user *buf, snd_pcm_uframes_t frames);
 849 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
 850                                      void __user **bufs, snd_pcm_uframes_t frames);
 851 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
 852                                     void __user **bufs, snd_pcm_uframes_t frames);
 853
 854 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
 855
 856 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
 857 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
 858
 859 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
 860                                               struct snd_dma_buffer *bufp)
 861 {
 862         struct snd_pcm_runtime *runtime = substream->runtime;
 863         if (bufp) {
 864                 runtime->dma_buffer_p = bufp;
 865                 runtime->dma_area = bufp->area;
 866                 runtime->dma_addr = bufp->addr;
 867                 runtime->dma_bytes = bufp->bytes;
 868         } else {
 869                 runtime->dma_buffer_p = NULL;
 870                 runtime->dma_area = NULL;
 871                 runtime->dma_addr = 0;
 872                 runtime->dma_bytes = 0;
 873         }
 874 }
 875
 876 /*
 877  *  Timer interface
 878  */
 879
 880 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
 881 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
 882 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
 883
 884 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
 885                                    struct timespec *tv)
 886 {
 887         if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
 888                 do_posix_clock_monotonic_gettime(tv);
 889         else
 890                 getnstimeofday(tv);
 891 }
 892
 893 /*
 894  *  Memory
 895  */
 896
 897 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
 898 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
 899 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
 900                                   int type, struct device *data,
 901                                   size_t size, size_t max);
 902 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
 903                                           int type, void *data,
 904                                           size_t size, size_t max);
 905 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
 906 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
 907
 908 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
 909                                       size_t size, gfp_t gfp_flags);
 910 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
 911 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
 912                                           unsigned long offset);
 913 #if 0 /* for kernel-doc */
 914 /**
 915  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
 916  * @substream: the substream to allocate the buffer to
 917  * @size: the requested buffer size, in bytes
 918  *
 919  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
 920  * contiguous in kernel virtual space, but not in physical memory.  Use this
 921  * if the buffer is accessed by kernel code but not by device DMA.
 922  *
 923  * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
 924  * code.
 925  */
 926 static int snd_pcm_lib_alloc_vmalloc_buffer
 927                         (struct snd_pcm_substream *substream, size_t size);
 928 /**
 929  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
 930  * @substream: the substream to allocate the buffer to
 931  * @size: the requested buffer size, in bytes
 932  *
 933  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
 934  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
 935  */
 936 static int snd_pcm_lib_alloc_vmalloc_32_buffer
 937                         (struct snd_pcm_substream *substream, size_t size);
 938 #endif
 939 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
 940         _snd_pcm_lib_alloc_vmalloc_buffer \
 941                         (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
 942 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
 943         _snd_pcm_lib_alloc_vmalloc_buffer \
 944                         (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
 945
 946 #ifdef CONFIG_SND_DMA_SGBUF
 947 /*
 948  * SG-buffer handling
 949  */
 950 #define snd_pcm_substream_sgbuf(substream) \
 951         ((substream)->runtime->dma_buffer_p->private_data)
 952
 953 static inline dma_addr_t
 954 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
 955 {
 956         struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
 957         return snd_sgbuf_get_addr(sg, ofs);
 958 }
 959
 960 static inline void *
 961 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
 962 {
 963         struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
 964         return snd_sgbuf_get_ptr(sg, ofs);
 965 }
 966
 967 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
 968                                     unsigned long offset);
 969 unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
 970                                           unsigned int ofs, unsigned int size);
 971
 972 #else /* !SND_DMA_SGBUF */
 973 /*
 974  * fake using a continuous buffer
 975  */
 976 static inline dma_addr_t
 977 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
 978 {
 979         return substream->runtime->dma_addr + ofs;
 980 }
 981
 982 static inline void *
 983 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
 984 {
 985         return substream->runtime->dma_area + ofs;
 986 }
 987
 988 #define snd_pcm_sgbuf_ops_page  NULL
 989
 990 #define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size)   (size)
 991
 992 #endif /* SND_DMA_SGBUF */
 993
 994 /* handle mmap counter - PCM mmap callback should handle this counter properly */
 995 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
 996 {
 997         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
 998         atomic_inc(&substream->mmap_count);
 999 }
1000
1001 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1002 {
1003         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1004         atomic_dec(&substream->mmap_count);
1005 }
1006
1007 /* mmap for io-memory area */
1008 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1009 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1010 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1011 #else
1012 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1013 #define snd_pcm_lib_mmap_iomem  NULL
1014 #endif
1015
1016 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1017 {
1018         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1019 }
1020
1021 /*
1022  *  Misc
1023  */
1024
1025 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1026                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1027                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1028                                          (IEC958_AES3_CON_FS_48000<<24))
1029
1030 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1031
1032 const char *snd_pcm_format_name(snd_pcm_format_t format);
1033
1034 #endif /* __SOUND_PCM_H */