include/sound/pcm.h

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