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