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_hwptr_log;
 266
 267 struct snd_pcm_runtime {
 268         /* -- Status -- */
 269         struct snd_pcm_substream *trigger_master;
 270         struct timespec trigger_tstamp; /* trigger timestamp */
 271         int overrange;
 272         snd_pcm_uframes_t avail_max;
 273         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
 274         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
 275         unsigned long hw_ptr_jiffies;   /* Time when hw_ptr is updated */
 276         snd_pcm_sframes_t delay;        /* extra delay; typically FIFO size */
 277
 278         /* -- HW params -- */
 279         snd_pcm_access_t access;        /* access mode */
 280         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
 281         snd_pcm_subformat_t subformat;  /* subformat */
 282         unsigned int rate;              /* rate in Hz */
 283         unsigned int channels;          /* channels */
 284         snd_pcm_uframes_t period_size;  /* period size */
 285         unsigned int periods;           /* periods */
 286         snd_pcm_uframes_t buffer_size;  /* buffer size */
 287         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
 288         size_t byte_align;
 289         unsigned int frame_bits;
 290         unsigned int sample_bits;
 291         unsigned int info;
 292         unsigned int rate_num;
 293         unsigned int rate_den;
 294
 295         /* -- SW params -- */
 296         int tstamp_mode;                /* mmap timestamp is updated */
 297         unsigned int period_step;
 298         snd_pcm_uframes_t start_threshold;
 299         snd_pcm_uframes_t stop_threshold;
 300         snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
 301                                                 noise is nearest than this */
 302         snd_pcm_uframes_t silence_size; /* Silence filling size */
 303         snd_pcm_uframes_t boundary;     /* pointers wrap point */
 304
 305         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
 306         snd_pcm_uframes_t silence_filled; /* size filled with silence */
 307
 308         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 309
 310         /* -- mmap -- */
 311         struct snd_pcm_mmap_status *status;
 312         struct snd_pcm_mmap_control *control;
 313
 314         /* -- locking / scheduling -- */
 315         unsigned int twake: 1;          /* do transfer (!poll) wakeup */
 316         wait_queue_head_t sleep;        /* poll sleep */
 317         wait_queue_head_t tsleep;       /* transfer sleep */
 318         struct fasync_struct *fasync;
 319
 320         /* -- private section -- */
 321         void *private_data;
 322         void (*private_free)(struct snd_pcm_runtime *runtime);
 323
 324         /* -- hardware description -- */
 325         struct snd_pcm_hardware hw;
 326         struct snd_pcm_hw_constraints hw_constraints;
 327
 328         /* -- interrupt callbacks -- */
 329         void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
 330         void (*transfer_ack_end)(struct snd_pcm_substream *substream);
 331
 332         /* -- timer -- */
 333         unsigned int timer_resolution;  /* timer resolution */
 334         int tstamp_type;                /* timestamp type */
 335
 336         /* -- DMA -- */
 337         unsigned char *dma_area;        /* DMA area */
 338         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 339         size_t dma_bytes;               /* size of DMA area */
 340
 341         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 342
 343 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 344         /* -- OSS things -- */
 345         struct snd_pcm_oss_runtime oss;
 346 #endif
 347
 348 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 349         struct snd_pcm_hwptr_log *hwptr_log;
 350 #endif
 351 };
 352
 353 struct snd_pcm_group {          /* keep linked substreams */
 354         spinlock_t lock;
 355         struct list_head substreams;
 356         int count;
 357 };
 358
 359 struct pid;
 360
 361 struct snd_pcm_substream {
 362         struct snd_pcm *pcm;
 363         struct snd_pcm_str *pstr;
 364         void *private_data;             /* copied from pcm->private_data */
 365         int number;
 366         char name[32];                  /* substream name */
 367         int stream;                     /* stream (direction) */
 368         char latency_id[20];            /* latency identifier */
 369         size_t buffer_bytes_max;        /* limit ring buffer size */
 370         struct snd_dma_buffer dma_buffer;
 371         unsigned int dma_buf_id;
 372         size_t dma_max;
 373         /* -- hardware operations -- */
 374         struct snd_pcm_ops *ops;
 375         /* -- runtime information -- */
 376         struct snd_pcm_runtime *runtime;
 377         /* -- timer section -- */
 378         struct snd_timer *timer;                /* timer */
 379         unsigned timer_running: 1;      /* time is running */
 380         /* -- next substream -- */
 381         struct snd_pcm_substream *next;
 382         /* -- linked substreams -- */
 383         struct list_head link_list;     /* linked list member */
 384         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 385         struct snd_pcm_group *group;            /* pointer to current group */
 386         /* -- assigned files -- */
 387         void *file;
 388         int ref_count;
 389         atomic_t mmap_count;
 390         unsigned int f_flags;
 391         void (*pcm_release)(struct snd_pcm_substream *);
 392         struct pid *pid;
 393 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 394         /* -- OSS things -- */
 395         struct snd_pcm_oss_substream oss;
 396 #endif
 397 #ifdef CONFIG_SND_VERBOSE_PROCFS
 398         struct snd_info_entry *proc_root;
 399         struct snd_info_entry *proc_info_entry;
 400         struct snd_info_entry *proc_hw_params_entry;
 401         struct snd_info_entry *proc_sw_params_entry;
 402         struct snd_info_entry *proc_status_entry;
 403         struct snd_info_entry *proc_prealloc_entry;
 404         struct snd_info_entry *proc_prealloc_max_entry;
 405 #endif
 406         /* misc flags */
 407         unsigned int hw_opened: 1;
 408 };
 409
 410 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 411
 412
 413 struct snd_pcm_str {
 414         int stream;                             /* stream (direction) */
 415         struct snd_pcm *pcm;
 416         /* -- substreams -- */
 417         unsigned int substream_count;
 418         unsigned int substream_opened;
 419         struct snd_pcm_substream *substream;
 420 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 421         /* -- OSS things -- */
 422         struct snd_pcm_oss_stream oss;
 423 #endif
 424 #ifdef CONFIG_SND_VERBOSE_PROCFS
 425         struct snd_info_entry *proc_root;
 426         struct snd_info_entry *proc_info_entry;
 427 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 428         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 429         struct snd_info_entry *proc_xrun_debug_entry;
 430 #endif
 431 #endif
 432 };
 433
 434 struct snd_pcm {
 435         struct snd_card *card;
 436         struct list_head list;
 437         int device; /* device number */
 438         unsigned int info_flags;
 439         unsigned short dev_class;
 440         unsigned short dev_subclass;
 441         char id[64];
 442         char name[80];
 443         struct snd_pcm_str streams[2];
 444         struct mutex open_mutex;
 445         wait_queue_head_t open_wait;
 446         void *private_data;
 447         void (*private_free) (struct snd_pcm *pcm);
 448         struct device *dev; /* actual hw device this belongs to */
 449 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 450         struct snd_pcm_oss oss;
 451 #endif
 452 };
 453
 454 struct snd_pcm_notify {
 455         int (*n_register) (struct snd_pcm * pcm);
 456         int (*n_disconnect) (struct snd_pcm * pcm);
 457         int (*n_unregister) (struct snd_pcm * pcm);
 458         struct list_head list;
 459 };
 460
 461 /*
 462  *  Registering
 463  */
 464
 465 extern const struct file_operations snd_pcm_f_ops[2];
 466
 467 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 468                 int playback_count, int capture_count,
 469                 struct snd_pcm **rpcm);
 470 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 471
 472 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 473
 474 /*
 475  *  Native I/O
 476  */
 477
 478 extern rwlock_t snd_pcm_link_rwlock;
 479
 480 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 481 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 482                       struct snd_pcm_info __user *info);
 483 int snd_pcm_status(struct snd_pcm_substream *substream,
 484                    struct snd_pcm_status *status);
 485 int snd_pcm_start(struct snd_pcm_substream *substream);
 486 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
 487 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 488 #ifdef CONFIG_PM
 489 int snd_pcm_suspend(struct snd_pcm_substream *substream);
 490 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 491 #endif
 492 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 493 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 494                            struct snd_pcm_substream **rsubstream);
 495 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 496 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 497                              struct snd_pcm_substream **rsubstream);
 498 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 499 void snd_pcm_vma_notify_data(void *client, void *data);
 500 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 501
 502 /*
 503  *  PCM library
 504  */
 505
 506 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 507 {
 508         return substream->group != &substream->self_group;
 509 }
 510
 511 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
 512 {
 513         read_lock(&snd_pcm_link_rwlock);
 514         spin_lock(&substream->self_group.lock);
 515 }
 516
 517 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
 518 {
 519         spin_unlock(&substream->self_group.lock);
 520         read_unlock(&snd_pcm_link_rwlock);
 521 }
 522
 523 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
 524 {
 525         read_lock_irq(&snd_pcm_link_rwlock);
 526         spin_lock(&substream->self_group.lock);
 527 }
 528
 529 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
 530 {
 531         spin_unlock(&substream->self_group.lock);
 532         read_unlock_irq(&snd_pcm_link_rwlock);
 533 }
 534
 535 #define snd_pcm_stream_lock_irqsave(substream, flags) \
 536 do { \
 537         read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
 538         spin_lock(&substream->self_group.lock); \
 539 } while (0)
 540
 541 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
 542 do { \
 543         spin_unlock(&substream->self_group.lock); \
 544         read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
 545 } while (0)
 546
 547 #define snd_pcm_group_for_each_entry(s, substream) \
 548         list_for_each_entry(s, &substream->group->substreams, link_list)
 549
 550 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 551 {
 552         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 553                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 554                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 555 }
 556
 557 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 558 {
 559         return size * 8 / runtime->sample_bits;
 560 }
 561
 562 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 563 {
 564         return size * 8 / runtime->frame_bits;
 565 }
 566
 567 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 568 {
 569         return size * runtime->sample_bits / 8;
 570 }
 571
 572 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 573 {
 574         return size * runtime->frame_bits / 8;
 575 }
 576
 577 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 578 {
 579         return bytes % runtime->byte_align == 0;
 580 }
 581
 582 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 583 {
 584         struct snd_pcm_runtime *runtime = substream->runtime;
 585         return frames_to_bytes(runtime, runtime->buffer_size);
 586 }
 587
 588 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 589 {
 590         struct snd_pcm_runtime *runtime = substream->runtime;
 591         return frames_to_bytes(runtime, runtime->period_size);
 592 }
 593
 594 /*
 595  *  result is: 0 ... (boundary - 1)
 596  */
 597 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 598 {
 599         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 600         if (avail < 0)
 601                 avail += runtime->boundary;
 602         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 603                 avail -= runtime->boundary;
 604         return avail;
 605 }
 606
 607 /*
 608  *  result is: 0 ... (boundary - 1)
 609  */
 610 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 611 {
 612         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 613         if (avail < 0)
 614                 avail += runtime->boundary;
 615         return avail;
 616 }
 617
 618 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 619 {
 620         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 621 }
 622
 623 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 624 {
 625         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 626 }
 627
 628 /**
 629  * snd_pcm_playback_ready - check whether the playback buffer is available
 630  * @substream: the pcm substream instance
 631  *
 632  * Checks whether enough free space is available on the playback buffer.
 633  *
 634  * Returns non-zero if available, or zero if not.
 635  */
 636 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 637 {
 638         struct snd_pcm_runtime *runtime = substream->runtime;
 639         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 640 }
 641
 642 /**
 643  * snd_pcm_capture_ready - check whether the capture buffer is available
 644  * @substream: the pcm substream instance
 645  *
 646  * Checks whether enough capture data is available on the capture buffer.
 647  *
 648  * Returns non-zero if available, or zero if not.
 649  */
 650 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 651 {
 652         struct snd_pcm_runtime *runtime = substream->runtime;
 653         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 654 }
 655
 656 /**
 657  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 658  * @substream: the pcm substream instance
 659  *
 660  * Checks whether any data exists on the playback buffer. If stop_threshold
 661  * is bigger or equal to boundary, then this function returns always non-zero.
 662  *
 663  * Returns non-zero if exists, or zero if not.
 664  */
 665 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 666 {
 667         struct snd_pcm_runtime *runtime = substream->runtime;
 668
 669         if (runtime->stop_threshold >= runtime->boundary)
 670                 return 1;
 671         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 672 }
 673
 674 /**
 675  * snd_pcm_playback_empty - check whether the playback buffer is empty
 676  * @substream: the pcm substream instance
 677  *
 678  * Checks whether the playback buffer is empty.
 679  *
 680  * Returns non-zero if empty, or zero if not.
 681  */
 682 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 683 {
 684         struct snd_pcm_runtime *runtime = substream->runtime;
 685         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 686 }
 687
 688 /**
 689  * snd_pcm_capture_empty - check whether the capture buffer is empty
 690  * @substream: the pcm substream instance
 691  *
 692  * Checks whether the capture buffer is empty.
 693  *
 694  * Returns non-zero if empty, or zero if not.
 695  */
 696 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 697 {
 698         struct snd_pcm_runtime *runtime = substream->runtime;
 699         return snd_pcm_capture_avail(runtime) == 0;
 700 }
 701
 702 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 703                                         struct snd_pcm_substream *master)
 704 {
 705         substream->runtime->trigger_master = master;
 706 }
 707
 708 static inline int hw_is_mask(int var)
 709 {
 710         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 711                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 712 }
 713
 714 static inline int hw_is_interval(int var)
 715 {
 716         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 717                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 718 }
 719
 720 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 721                                      snd_pcm_hw_param_t var)
 722 {
 723         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 724 }
 725
 726 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 727                                              snd_pcm_hw_param_t var)
 728 {
 729         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 730 }
 731
 732 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 733                                              snd_pcm_hw_param_t var)
 734 {
 735         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 736 }
 737
 738 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 739                                                      snd_pcm_hw_param_t var)
 740 {
 741         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 742 }
 743
 744 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
 745 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
 746 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
 747 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
 748 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
 749 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
 750 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
 751 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
 752 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
 753 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
 754
 755
 756 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 757 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 758 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 759 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
 760                           unsigned int k, struct snd_interval *c);
 761 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
 762                           const struct snd_interval *b, struct snd_interval *c);
 763 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
 764 int snd_interval_ratnum(struct snd_interval *i,
 765                         unsigned int rats_count, struct snd_ratnum *rats,
 766                         unsigned int *nump, unsigned int *denp);
 767
 768 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 769 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 770 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 771
 772 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 773
 774 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
 775 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
 776
 777 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 778                                u_int32_t mask);
 779 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 780                                  u_int64_t mask);
 781 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 782                                  unsigned int min, unsigned int max);
 783 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
 784 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
 785                                unsigned int cond,
 786                                snd_pcm_hw_param_t var,
 787                                struct snd_pcm_hw_constraint_list *l);
 788 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
 789                                   unsigned int cond,
 790                                   snd_pcm_hw_param_t var,
 791                                   struct snd_pcm_hw_constraint_ratnums *r);
 792 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
 793                                   unsigned int cond,
 794                                   snd_pcm_hw_param_t var,
 795                                   struct snd_pcm_hw_constraint_ratdens *r);
 796 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
 797                                  unsigned int cond,
 798                                  unsigned int width,
 799                                  unsigned int msbits);
 800 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
 801                                unsigned int cond,
 802                                snd_pcm_hw_param_t var,
 803                                unsigned long step);
 804 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
 805                                unsigned int cond,
 806                                snd_pcm_hw_param_t var);
 807 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
 808                         unsigned int cond,
 809                         int var,
 810                         snd_pcm_hw_rule_func_t func, void *private,
 811                         int dep, ...);
 812
 813 int snd_pcm_format_signed(snd_pcm_format_t format);
 814 int snd_pcm_format_unsigned(snd_pcm_format_t format);
 815 int snd_pcm_format_linear(snd_pcm_format_t format);
 816 int snd_pcm_format_little_endian(snd_pcm_format_t format);
 817 int snd_pcm_format_big_endian(snd_pcm_format_t format);
 818 #if 0 /* just for DocBook */
 819 /**
 820  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
 821  * @format: the format to check
 822  *
 823  * Returns 1 if the given PCM format is CPU-endian, 0 if
 824  * opposite, or a negative error code if endian not specified.
 825  */
 826 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
 827 #endif /* DocBook */
 828 #ifdef SNDRV_LITTLE_ENDIAN
 829 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
 830 #else
 831 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
 832 #endif
 833 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
 834 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
 835 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
 836 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
 837 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
 838 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
 839
 840 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
 841 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
 842 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
 843 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
 844                       unsigned int cmd, void *arg);
 845 int snd_pcm_update_state(struct snd_pcm_substream *substream,
 846                          struct snd_pcm_runtime *runtime);
 847 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
 848 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
 849 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
 850 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
 851 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
 852 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
 853 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
 854 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
 855                                     const void __user *buf,
 856                                     snd_pcm_uframes_t frames);
 857 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
 858                                    void __user *buf, snd_pcm_uframes_t frames);
 859 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
 860                                      void __user **bufs, snd_pcm_uframes_t frames);
 861 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
 862                                     void __user **bufs, snd_pcm_uframes_t frames);
 863
 864 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
 865
 866 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
 867 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
 868
 869 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
 870                                               struct snd_dma_buffer *bufp)
 871 {
 872         struct snd_pcm_runtime *runtime = substream->runtime;
 873         if (bufp) {
 874                 runtime->dma_buffer_p = bufp;
 875                 runtime->dma_area = bufp->area;
 876                 runtime->dma_addr = bufp->addr;
 877                 runtime->dma_bytes = bufp->bytes;
 878         } else {
 879                 runtime->dma_buffer_p = NULL;
 880                 runtime->dma_area = NULL;
 881                 runtime->dma_addr = 0;
 882                 runtime->dma_bytes = 0;
 883         }
 884 }
 885
 886 /*
 887  *  Timer interface
 888  */
 889
 890 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
 891 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
 892 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
 893
 894 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
 895                                    struct timespec *tv)
 896 {
 897         if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
 898                 do_posix_clock_monotonic_gettime(tv);
 899         else
 900                 getnstimeofday(tv);
 901 }
 902
 903 /*
 904  *  Memory
 905  */
 906
 907 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
 908 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
 909 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
 910                                   int type, struct device *data,
 911                                   size_t size, size_t max);
 912 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
 913                                           int type, void *data,
 914                                           size_t size, size_t max);
 915 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
 916 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
 917
 918 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
 919                                       size_t size, gfp_t gfp_flags);
 920 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
 921 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
 922                                           unsigned long offset);
 923 #if 0 /* for kernel-doc */
 924 /**
 925  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
 926  * @substream: the substream to allocate the buffer to
 927  * @size: the requested buffer size, in bytes
 928  *
 929  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
 930  * contiguous in kernel virtual space, but not in physical memory.  Use this
 931  * if the buffer is accessed by kernel code but not by device DMA.
 932  *
 933  * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
 934  * code.
 935  */
 936 static int snd_pcm_lib_alloc_vmalloc_buffer
 937                         (struct snd_pcm_substream *substream, size_t size);
 938 /**
 939  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
 940  * @substream: the substream to allocate the buffer to
 941  * @size: the requested buffer size, in bytes
 942  *
 943  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
 944  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
 945  */
 946 static int snd_pcm_lib_alloc_vmalloc_32_buffer
 947                         (struct snd_pcm_substream *substream, size_t size);
 948 #endif
 949 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
 950         _snd_pcm_lib_alloc_vmalloc_buffer \
 951                         (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
 952 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
 953         _snd_pcm_lib_alloc_vmalloc_buffer \
 954                         (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
 955
 956 #ifdef CONFIG_SND_DMA_SGBUF
 957 /*
 958  * SG-buffer handling
 959  */
 960 #define snd_pcm_substream_sgbuf(substream) \
 961         ((substream)->runtime->dma_buffer_p->private_data)
 962
 963 static inline dma_addr_t
 964 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
 965 {
 966         struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
 967         return snd_sgbuf_get_addr(sg, ofs);
 968 }
 969
 970 static inline void *
 971 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
 972 {
 973         struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
 974         return snd_sgbuf_get_ptr(sg, ofs);
 975 }
 976
 977 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
 978                                     unsigned long offset);
 979 unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
 980                                           unsigned int ofs, unsigned int size);
 981
 982 #else /* !SND_DMA_SGBUF */
 983 /*
 984  * fake using a continuous buffer
 985  */
 986 static inline dma_addr_t
 987 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
 988 {
 989         return substream->runtime->dma_addr + ofs;
 990 }
 991
 992 static inline void *
 993 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
 994 {
 995         return substream->runtime->dma_area + ofs;
 996 }
 997
 998 #define snd_pcm_sgbuf_ops_page  NULL
 999
1000 #define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size)   (size)
1001
1002 #endif /* SND_DMA_SGBUF */
1003
1004 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1005 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1006 {
1007         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1008         atomic_inc(&substream->mmap_count);
1009 }
1010
1011 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1012 {
1013         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1014         atomic_dec(&substream->mmap_count);
1015 }
1016
1017 /* mmap for io-memory area */
1018 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1019 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1020 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1021 #else
1022 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1023 #define snd_pcm_lib_mmap_iomem  NULL
1024 #endif
1025
1026 int snd_pcm_lib_mmap_noncached(struct snd_pcm_substream *substream,
1027                                struct vm_area_struct *area);
1028 #define snd_pcm_lib_mmap_vmalloc        snd_pcm_lib_mmap_noncached
1029
1030 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1031 {
1032         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1033 }
1034
1035 /*
1036  *  Misc
1037  */
1038
1039 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1040                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1041                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1042                                          (IEC958_AES3_CON_FS_48000<<24))
1043
1044 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1045
1046 const char *snd_pcm_format_name(snd_pcm_format_t format);
1047
1048 #endif /* __SOUND_PCM_H */