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