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