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.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 <sound/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 (*wall_clock)(struct snd_pcm_substream *substream,
  75                           struct timespec *audio_ts);
  76         int (*copy)(struct snd_pcm_substream *substream, int channel,
  77                     snd_pcm_uframes_t pos,
  78                     void __user *buf, snd_pcm_uframes_t count);
  79         int (*silence)(struct snd_pcm_substream *substream, int channel,
  80                        snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
  81         struct page *(*page)(struct snd_pcm_substream *substream,
  82                              unsigned long offset);
  83         int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
  84         int (*ack)(struct snd_pcm_substream *substream);
  85 };
  86
  87 /*
  88  *
  89  */
  90
  91 #if defined(CONFIG_SND_DYNAMIC_MINORS)
  92 #define SNDRV_PCM_DEVICES       (SNDRV_OS_MINORS-2)
  93 #else
  94 #define SNDRV_PCM_DEVICES       8
  95 #endif
  96
  97 #define SNDRV_PCM_IOCTL1_FALSE          ((void *)0)
  98 #define SNDRV_PCM_IOCTL1_TRUE           ((void *)1)
  99
 100 #define SNDRV_PCM_IOCTL1_RESET          0
 101 #define SNDRV_PCM_IOCTL1_INFO           1
 102 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO   2
 103 #define SNDRV_PCM_IOCTL1_GSTATE         3
 104 #define SNDRV_PCM_IOCTL1_FIFO_SIZE      4
 105
 106 #define SNDRV_PCM_TRIGGER_STOP          0
 107 #define SNDRV_PCM_TRIGGER_START         1
 108 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH    3
 109 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
 110 #define SNDRV_PCM_TRIGGER_SUSPEND       5
 111 #define SNDRV_PCM_TRIGGER_RESUME        6
 112
 113 #define SNDRV_PCM_POS_XRUN              ((snd_pcm_uframes_t)-1)
 114
 115 /* If you change this don't forget to change rates[] table in pcm_native.c */
 116 #define SNDRV_PCM_RATE_5512             (1<<0)          /* 5512Hz */
 117 #define SNDRV_PCM_RATE_8000             (1<<1)          /* 8000Hz */
 118 #define SNDRV_PCM_RATE_11025            (1<<2)          /* 11025Hz */
 119 #define SNDRV_PCM_RATE_16000            (1<<3)          /* 16000Hz */
 120 #define SNDRV_PCM_RATE_22050            (1<<4)          /* 22050Hz */
 121 #define SNDRV_PCM_RATE_32000            (1<<5)          /* 32000Hz */
 122 #define SNDRV_PCM_RATE_44100            (1<<6)          /* 44100Hz */
 123 #define SNDRV_PCM_RATE_48000            (1<<7)          /* 48000Hz */
 124 #define SNDRV_PCM_RATE_64000            (1<<8)          /* 64000Hz */
 125 #define SNDRV_PCM_RATE_88200            (1<<9)          /* 88200Hz */
 126 #define SNDRV_PCM_RATE_96000            (1<<10)         /* 96000Hz */
 127 #define SNDRV_PCM_RATE_176400           (1<<11)         /* 176400Hz */
 128 #define SNDRV_PCM_RATE_192000           (1<<12)         /* 192000Hz */
 129
 130 #define SNDRV_PCM_RATE_CONTINUOUS       (1<<30)         /* continuous range */
 131 #define SNDRV_PCM_RATE_KNOT             (1<<31)         /* supports more non-continuos rates */
 132
 133 #define SNDRV_PCM_RATE_8000_44100       (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
 134                                          SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
 135                                          SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
 136 #define SNDRV_PCM_RATE_8000_48000       (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
 137 #define SNDRV_PCM_RATE_8000_96000       (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
 138                                          SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
 139 #define SNDRV_PCM_RATE_8000_192000      (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
 140                                          SNDRV_PCM_RATE_192000)
 141 #define _SNDRV_PCM_FMTBIT(fmt)          (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
 142 #define SNDRV_PCM_FMTBIT_S8             _SNDRV_PCM_FMTBIT(S8)
 143 #define SNDRV_PCM_FMTBIT_U8             _SNDRV_PCM_FMTBIT(U8)
 144 #define SNDRV_PCM_FMTBIT_S16_LE         _SNDRV_PCM_FMTBIT(S16_LE)
 145 #define SNDRV_PCM_FMTBIT_S16_BE         _SNDRV_PCM_FMTBIT(S16_BE)
 146 #define SNDRV_PCM_FMTBIT_U16_LE         _SNDRV_PCM_FMTBIT(U16_LE)
 147 #define SNDRV_PCM_FMTBIT_U16_BE         _SNDRV_PCM_FMTBIT(U16_BE)
 148 #define SNDRV_PCM_FMTBIT_S24_LE         _SNDRV_PCM_FMTBIT(S24_LE)
 149 #define SNDRV_PCM_FMTBIT_S24_BE         _SNDRV_PCM_FMTBIT(S24_BE)
 150 #define SNDRV_PCM_FMTBIT_U24_LE         _SNDRV_PCM_FMTBIT(U24_LE)
 151 #define SNDRV_PCM_FMTBIT_U24_BE         _SNDRV_PCM_FMTBIT(U24_BE)
 152 #define SNDRV_PCM_FMTBIT_S32_LE         _SNDRV_PCM_FMTBIT(S32_LE)
 153 #define SNDRV_PCM_FMTBIT_S32_BE         _SNDRV_PCM_FMTBIT(S32_BE)
 154 #define SNDRV_PCM_FMTBIT_U32_LE         _SNDRV_PCM_FMTBIT(U32_LE)
 155 #define SNDRV_PCM_FMTBIT_U32_BE         _SNDRV_PCM_FMTBIT(U32_BE)
 156 #define SNDRV_PCM_FMTBIT_FLOAT_LE       _SNDRV_PCM_FMTBIT(FLOAT_LE)
 157 #define SNDRV_PCM_FMTBIT_FLOAT_BE       _SNDRV_PCM_FMTBIT(FLOAT_BE)
 158 #define SNDRV_PCM_FMTBIT_FLOAT64_LE     _SNDRV_PCM_FMTBIT(FLOAT64_LE)
 159 #define SNDRV_PCM_FMTBIT_FLOAT64_BE     _SNDRV_PCM_FMTBIT(FLOAT64_BE)
 160 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
 161 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
 162 #define SNDRV_PCM_FMTBIT_MU_LAW         _SNDRV_PCM_FMTBIT(MU_LAW)
 163 #define SNDRV_PCM_FMTBIT_A_LAW          _SNDRV_PCM_FMTBIT(A_LAW)
 164 #define SNDRV_PCM_FMTBIT_IMA_ADPCM      _SNDRV_PCM_FMTBIT(IMA_ADPCM)
 165 #define SNDRV_PCM_FMTBIT_MPEG           _SNDRV_PCM_FMTBIT(MPEG)
 166 #define SNDRV_PCM_FMTBIT_GSM            _SNDRV_PCM_FMTBIT(GSM)
 167 #define SNDRV_PCM_FMTBIT_SPECIAL        _SNDRV_PCM_FMTBIT(SPECIAL)
 168 #define SNDRV_PCM_FMTBIT_S24_3LE        _SNDRV_PCM_FMTBIT(S24_3LE)
 169 #define SNDRV_PCM_FMTBIT_U24_3LE        _SNDRV_PCM_FMTBIT(U24_3LE)
 170 #define SNDRV_PCM_FMTBIT_S24_3BE        _SNDRV_PCM_FMTBIT(S24_3BE)
 171 #define SNDRV_PCM_FMTBIT_U24_3BE        _SNDRV_PCM_FMTBIT(U24_3BE)
 172 #define SNDRV_PCM_FMTBIT_S20_3LE        _SNDRV_PCM_FMTBIT(S20_3LE)
 173 #define SNDRV_PCM_FMTBIT_U20_3LE        _SNDRV_PCM_FMTBIT(U20_3LE)
 174 #define SNDRV_PCM_FMTBIT_S20_3BE        _SNDRV_PCM_FMTBIT(S20_3BE)
 175 #define SNDRV_PCM_FMTBIT_U20_3BE        _SNDRV_PCM_FMTBIT(U20_3BE)
 176 #define SNDRV_PCM_FMTBIT_S18_3LE        _SNDRV_PCM_FMTBIT(S18_3LE)
 177 #define SNDRV_PCM_FMTBIT_U18_3LE        _SNDRV_PCM_FMTBIT(U18_3LE)
 178 #define SNDRV_PCM_FMTBIT_S18_3BE        _SNDRV_PCM_FMTBIT(S18_3BE)
 179 #define SNDRV_PCM_FMTBIT_U18_3BE        _SNDRV_PCM_FMTBIT(U18_3BE)
 180 #define SNDRV_PCM_FMTBIT_G723_24        _SNDRV_PCM_FMTBIT(G723_24)
 181 #define SNDRV_PCM_FMTBIT_G723_24_1B     _SNDRV_PCM_FMTBIT(G723_24_1B)
 182 #define SNDRV_PCM_FMTBIT_G723_40        _SNDRV_PCM_FMTBIT(G723_40)
 183 #define SNDRV_PCM_FMTBIT_G723_40_1B     _SNDRV_PCM_FMTBIT(G723_40_1B)
 184 #define SNDRV_PCM_FMTBIT_DSD_U8         _SNDRV_PCM_FMTBIT(DSD_U8)
 185 #define SNDRV_PCM_FMTBIT_DSD_U16_LE     _SNDRV_PCM_FMTBIT(DSD_U16_LE)
 186 #define SNDRV_PCM_FMTBIT_DSD_U32_LE     _SNDRV_PCM_FMTBIT(DSD_U32_LE)
 187
 188 #ifdef SNDRV_LITTLE_ENDIAN
 189 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_LE
 190 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_LE
 191 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_LE
 192 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_LE
 193 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_LE
 194 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_LE
 195 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_LE
 196 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_LE
 197 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
 198 #endif
 199 #ifdef SNDRV_BIG_ENDIAN
 200 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_BE
 201 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_BE
 202 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_BE
 203 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_BE
 204 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_BE
 205 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_BE
 206 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_BE
 207 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_BE
 208 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
 209 #endif
 210
 211 struct snd_pcm_file {
 212         struct snd_pcm_substream *substream;
 213         int no_compat_mmap;
 214 };
 215
 216 struct snd_pcm_hw_rule;
 217 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
 218                                       struct snd_pcm_hw_rule *rule);
 219
 220 struct snd_pcm_hw_rule {
 221         unsigned int cond;
 222         snd_pcm_hw_rule_func_t func;
 223         int var;
 224         int deps[4];
 225         void *private;
 226 };
 227
 228 struct snd_pcm_hw_constraints {
 229         struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
 230                          SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
 231         struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
 232                              SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
 233         unsigned int rules_num;
 234         unsigned int rules_all;
 235         struct snd_pcm_hw_rule *rules;
 236 };
 237
 238 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
 239                                             snd_pcm_hw_param_t var)
 240 {
 241         return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 242 }
 243
 244 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
 245                                                     snd_pcm_hw_param_t var)
 246 {
 247         return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 248 }
 249
 250 struct snd_ratnum {
 251         unsigned int num;
 252         unsigned int den_min, den_max, den_step;
 253 };
 254
 255 struct snd_ratden {
 256         unsigned int num_min, num_max, num_step;
 257         unsigned int den;
 258 };
 259
 260 struct snd_pcm_hw_constraint_ratnums {
 261         int nrats;
 262         struct snd_ratnum *rats;
 263 };
 264
 265 struct snd_pcm_hw_constraint_ratdens {
 266         int nrats;
 267         struct snd_ratden *rats;
 268 };
 269
 270 struct snd_pcm_hw_constraint_list {
 271         unsigned int count;
 272         const unsigned int *list;
 273         unsigned int mask;
 274 };
 275
 276 struct snd_pcm_hwptr_log;
 277
 278 struct snd_pcm_runtime {
 279         /* -- Status -- */
 280         struct snd_pcm_substream *trigger_master;
 281         struct timespec trigger_tstamp; /* trigger timestamp */
 282         int overrange;
 283         snd_pcm_uframes_t avail_max;
 284         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
 285         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
 286         unsigned long hw_ptr_jiffies;   /* Time when hw_ptr is updated */
 287         unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
 288         snd_pcm_sframes_t delay;        /* extra delay; typically FIFO size */
 289         u64 hw_ptr_wrap;                /* offset for hw_ptr due to boundary wrap-around */
 290
 291         /* -- HW params -- */
 292         snd_pcm_access_t access;        /* access mode */
 293         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
 294         snd_pcm_subformat_t subformat;  /* subformat */
 295         unsigned int rate;              /* rate in Hz */
 296         unsigned int channels;          /* channels */
 297         snd_pcm_uframes_t period_size;  /* period size */
 298         unsigned int periods;           /* periods */
 299         snd_pcm_uframes_t buffer_size;  /* buffer size */
 300         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
 301         size_t byte_align;
 302         unsigned int frame_bits;
 303         unsigned int sample_bits;
 304         unsigned int info;
 305         unsigned int rate_num;
 306         unsigned int rate_den;
 307         unsigned int no_period_wakeup: 1;
 308
 309         /* -- SW params -- */
 310         int tstamp_mode;                /* mmap timestamp is updated */
 311         unsigned int period_step;
 312         snd_pcm_uframes_t start_threshold;
 313         snd_pcm_uframes_t stop_threshold;
 314         snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
 315                                                 noise is nearest than this */
 316         snd_pcm_uframes_t silence_size; /* Silence filling size */
 317         snd_pcm_uframes_t boundary;     /* pointers wrap point */
 318
 319         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
 320         snd_pcm_uframes_t silence_filled; /* size filled with silence */
 321
 322         union snd_pcm_sync_id sync;     /* hardware synchronization ID */
 323
 324         /* -- mmap -- */
 325         struct snd_pcm_mmap_status *status;
 326         struct snd_pcm_mmap_control *control;
 327
 328         /* -- locking / scheduling -- */
 329         snd_pcm_uframes_t twake;        /* do transfer (!poll) wakeup if non-zero */
 330         wait_queue_head_t sleep;        /* poll sleep */
 331         wait_queue_head_t tsleep;       /* transfer sleep */
 332         struct fasync_struct *fasync;
 333
 334         /* -- private section -- */
 335         void *private_data;
 336         void (*private_free)(struct snd_pcm_runtime *runtime);
 337
 338         /* -- hardware description -- */
 339         struct snd_pcm_hardware hw;
 340         struct snd_pcm_hw_constraints hw_constraints;
 341
 342         /* -- interrupt callbacks -- */
 343         void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
 344         void (*transfer_ack_end)(struct snd_pcm_substream *substream);
 345
 346         /* -- timer -- */
 347         unsigned int timer_resolution;  /* timer resolution */
 348         int tstamp_type;                /* timestamp type */
 349
 350         /* -- DMA -- */
 351         unsigned char *dma_area;        /* DMA area */
 352         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
 353         size_t dma_bytes;               /* size of DMA area */
 354
 355         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
 356
 357 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 358         /* -- OSS things -- */
 359         struct snd_pcm_oss_runtime oss;
 360 #endif
 361
 362 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 363         struct snd_pcm_hwptr_log *hwptr_log;
 364 #endif
 365 };
 366
 367 struct snd_pcm_group {          /* keep linked substreams */
 368         spinlock_t lock;
 369         struct mutex mutex;
 370         struct list_head substreams;
 371         int count;
 372 };
 373
 374 struct pid;
 375
 376 struct snd_pcm_substream {
 377         struct snd_pcm *pcm;
 378         struct snd_pcm_str *pstr;
 379         void *private_data;             /* copied from pcm->private_data */
 380         int number;
 381         char name[32];                  /* substream name */
 382         int stream;                     /* stream (direction) */
 383         struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
 384         size_t buffer_bytes_max;        /* limit ring buffer size */
 385         struct snd_dma_buffer dma_buffer;
 386         size_t dma_max;
 387         /* -- hardware operations -- */
 388         const struct snd_pcm_ops *ops;
 389         /* -- runtime information -- */
 390         struct snd_pcm_runtime *runtime;
 391         /* -- timer section -- */
 392         struct snd_timer *timer;                /* timer */
 393         unsigned timer_running: 1;      /* time is running */
 394         /* -- next substream -- */
 395         struct snd_pcm_substream *next;
 396         /* -- linked substreams -- */
 397         struct list_head link_list;     /* linked list member */
 398         struct snd_pcm_group self_group;        /* fake group for non linked substream (with substream lock inside) */
 399         struct snd_pcm_group *group;            /* pointer to current group */
 400         /* -- assigned files -- */
 401         void *file;
 402         int ref_count;
 403         atomic_t mmap_count;
 404         unsigned int f_flags;
 405         void (*pcm_release)(struct snd_pcm_substream *);
 406         struct pid *pid;
 407 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 408         /* -- OSS things -- */
 409         struct snd_pcm_oss_substream oss;
 410 #endif
 411 #ifdef CONFIG_SND_VERBOSE_PROCFS
 412         struct snd_info_entry *proc_root;
 413         struct snd_info_entry *proc_info_entry;
 414         struct snd_info_entry *proc_hw_params_entry;
 415         struct snd_info_entry *proc_sw_params_entry;
 416         struct snd_info_entry *proc_status_entry;
 417         struct snd_info_entry *proc_prealloc_entry;
 418         struct snd_info_entry *proc_prealloc_max_entry;
 419 #endif
 420         /* misc flags */
 421         unsigned int hw_opened: 1;
 422 };
 423
 424 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
 425
 426
 427 struct snd_pcm_str {
 428         int stream;                             /* stream (direction) */
 429         struct snd_pcm *pcm;
 430         /* -- substreams -- */
 431         unsigned int substream_count;
 432         unsigned int substream_opened;
 433         struct snd_pcm_substream *substream;
 434 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 435         /* -- OSS things -- */
 436         struct snd_pcm_oss_stream oss;
 437 #endif
 438 #ifdef CONFIG_SND_VERBOSE_PROCFS
 439         struct snd_info_entry *proc_root;
 440         struct snd_info_entry *proc_info_entry;
 441 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
 442         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
 443         struct snd_info_entry *proc_xrun_debug_entry;
 444 #endif
 445 #endif
 446         struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
 447 };
 448
 449 struct snd_pcm {
 450         struct snd_card *card;
 451         struct list_head list;
 452         int device; /* device number */
 453         unsigned int info_flags;
 454         unsigned short dev_class;
 455         unsigned short dev_subclass;
 456         char id[64];
 457         char name[80];
 458         struct snd_pcm_str streams[2];
 459         struct mutex open_mutex;
 460         wait_queue_head_t open_wait;
 461         void *private_data;
 462         void (*private_free) (struct snd_pcm *pcm);
 463         struct device *dev; /* actual hw device this belongs to */
 464         bool internal; /* pcm is for internal use only */
 465         bool nonatomic; /* whole PCM operations are in non-atomic context */
 466 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
 467         struct snd_pcm_oss oss;
 468 #endif
 469 };
 470
 471 struct snd_pcm_notify {
 472         int (*n_register) (struct snd_pcm * pcm);
 473         int (*n_disconnect) (struct snd_pcm * pcm);
 474         int (*n_unregister) (struct snd_pcm * pcm);
 475         struct list_head list;
 476 };
 477
 478 /*
 479  *  Registering
 480  */
 481
 482 extern const struct file_operations snd_pcm_f_ops[2];
 483
 484 int snd_pcm_new(struct snd_card *card, const char *id, int device,
 485                 int playback_count, int capture_count,
 486                 struct snd_pcm **rpcm);
 487 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
 488                 int playback_count, int capture_count,
 489                 struct snd_pcm **rpcm);
 490 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
 491
 492 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
 493
 494 /*
 495  *  Native I/O
 496  */
 497
 498 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
 499 int snd_pcm_info_user(struct snd_pcm_substream *substream,
 500                       struct snd_pcm_info __user *info);
 501 int snd_pcm_status(struct snd_pcm_substream *substream,
 502                    struct snd_pcm_status *status);
 503 int snd_pcm_start(struct snd_pcm_substream *substream);
 504 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
 505 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
 506 #ifdef CONFIG_PM
 507 int snd_pcm_suspend(struct snd_pcm_substream *substream);
 508 int snd_pcm_suspend_all(struct snd_pcm *pcm);
 509 #endif
 510 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
 511 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
 512                            struct snd_pcm_substream **rsubstream);
 513 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
 514 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
 515                              struct snd_pcm_substream **rsubstream);
 516 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
 517 void snd_pcm_vma_notify_data(void *client, void *data);
 518 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
 519
 520
 521 #ifdef CONFIG_SND_DEBUG
 522 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
 523                            char *name, size_t len);
 524 #else
 525 static inline void
 526 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
 527 {
 528         *buf = 0;
 529 }
 530 #endif
 531
 532 /*
 533  *  PCM library
 534  */
 535
 536 /**
 537  * snd_pcm_stream_linked - Check whether the substream is linked with others
 538  * @substream: substream to check
 539  *
 540  * Returns true if the given substream is being linked with others.
 541  */
 542 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
 543 {
 544         return substream->group != &substream->self_group;
 545 }
 546
 547 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
 548 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
 549 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
 550 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
 551 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
 552
 553 /**
 554  * snd_pcm_stream_lock_irqsave - Lock the PCM stream
 555  * @substream: PCM substream
 556  * @flags: irq flags
 557  *
 558  * This locks the PCM stream like snd_pcm_stream_lock() but with the local
 559  * IRQ (only when nonatomic is false).  In nonatomic case, this is identical
 560  * as snd_pcm_stream_lock().
 561  */
 562 #define snd_pcm_stream_lock_irqsave(substream, flags)            \
 563         do {                                                     \
 564                 typecheck(unsigned long, flags);                 \
 565                 flags = _snd_pcm_stream_lock_irqsave(substream); \
 566         } while (0)
 567 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
 568                                       unsigned long flags);
 569
 570 /**
 571  * snd_pcm_group_for_each_entry - iterate over the linked substreams
 572  * @s: the iterator
 573  * @substream: the substream
 574  *
 575  * Iterate over the all linked substreams to the given @substream.
 576  * When @substream isn't linked with any others, this gives returns @substream
 577  * itself once.
 578  */
 579 #define snd_pcm_group_for_each_entry(s, substream) \
 580         list_for_each_entry(s, &substream->group->substreams, link_list)
 581
 582 /**
 583  * snd_pcm_running - Check whether the substream is in a running state
 584  * @substream: substream to check
 585  *
 586  * Returns true if the given substream is in the state RUNNING, or in the
 587  * state DRAINING for playback.
 588  */
 589 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
 590 {
 591         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
 592                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
 593                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
 594 }
 595
 596 /**
 597  * bytes_to_samples - Unit conversion of the size from bytes to samples
 598  * @runtime: PCM runtime instance
 599  * @size: size in bytes
 600  */
 601 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
 602 {
 603         return size * 8 / runtime->sample_bits;
 604 }
 605
 606 /**
 607  * bytes_to_frames - Unit conversion of the size from bytes to frames
 608  * @runtime: PCM runtime instance
 609  * @size: size in bytes
 610  */
 611 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
 612 {
 613         return size * 8 / runtime->frame_bits;
 614 }
 615
 616 /**
 617  * samples_to_bytes - Unit conversion of the size from samples to bytes
 618  * @runtime: PCM runtime instance
 619  * @size: size in samples
 620  */
 621 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
 622 {
 623         return size * runtime->sample_bits / 8;
 624 }
 625
 626 /**
 627  * frames_to_bytes - Unit conversion of the size from frames to bytes
 628  * @runtime: PCM runtime instance
 629  * @size: size in frames
 630  */
 631 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
 632 {
 633         return size * runtime->frame_bits / 8;
 634 }
 635
 636 /**
 637  * frame_aligned - Check whether the byte size is aligned to frames
 638  * @runtime: PCM runtime instance
 639  * @bytes: size in bytes
 640  */
 641 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
 642 {
 643         return bytes % runtime->byte_align == 0;
 644 }
 645
 646 /**
 647  * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
 648  * @substream: PCM substream
 649  */
 650 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
 651 {
 652         struct snd_pcm_runtime *runtime = substream->runtime;
 653         return frames_to_bytes(runtime, runtime->buffer_size);
 654 }
 655
 656 /**
 657  * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
 658  * @substream: PCM substream
 659  */
 660 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
 661 {
 662         struct snd_pcm_runtime *runtime = substream->runtime;
 663         return frames_to_bytes(runtime, runtime->period_size);
 664 }
 665
 666 /**
 667  * snd_pcm_playback_avail - Get the available (writable) space for playback
 668  * @runtime: PCM runtime instance
 669  *
 670  * Result is between 0 ... (boundary - 1)
 671  */
 672 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
 673 {
 674         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
 675         if (avail < 0)
 676                 avail += runtime->boundary;
 677         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
 678                 avail -= runtime->boundary;
 679         return avail;
 680 }
 681
 682 /**
 683  * snd_pcm_playback_avail - Get the available (readable) space for capture
 684  * @runtime: PCM runtime instance
 685  *
 686  * Result is between 0 ... (boundary - 1)
 687  */
 688 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
 689 {
 690         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
 691         if (avail < 0)
 692                 avail += runtime->boundary;
 693         return avail;
 694 }
 695
 696 /**
 697  * snd_pcm_playback_hw_avail - Get the queued space for playback
 698  * @runtime: PCM runtime instance
 699  */
 700 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
 701 {
 702         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
 703 }
 704
 705 /**
 706  * snd_pcm_capture_hw_avail - Get the free space for capture
 707  * @runtime: PCM runtime instance
 708  */
 709 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
 710 {
 711         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
 712 }
 713
 714 /**
 715  * snd_pcm_playback_ready - check whether the playback buffer is available
 716  * @substream: the pcm substream instance
 717  *
 718  * Checks whether enough free space is available on the playback buffer.
 719  *
 720  * Return: Non-zero if available, or zero if not.
 721  */
 722 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
 723 {
 724         struct snd_pcm_runtime *runtime = substream->runtime;
 725         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
 726 }
 727
 728 /**
 729  * snd_pcm_capture_ready - check whether the capture buffer is available
 730  * @substream: the pcm substream instance
 731  *
 732  * Checks whether enough capture data is available on the capture buffer.
 733  *
 734  * Return: Non-zero if available, or zero if not.
 735  */
 736 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
 737 {
 738         struct snd_pcm_runtime *runtime = substream->runtime;
 739         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
 740 }
 741
 742 /**
 743  * snd_pcm_playback_data - check whether any data exists on the playback buffer
 744  * @substream: the pcm substream instance
 745  *
 746  * Checks whether any data exists on the playback buffer.
 747  *
 748  * Return: Non-zero if any data exists, or zero if not. If stop_threshold
 749  * is bigger or equal to boundary, then this function returns always non-zero.
 750  */
 751 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
 752 {
 753         struct snd_pcm_runtime *runtime = substream->runtime;
 754
 755         if (runtime->stop_threshold >= runtime->boundary)
 756                 return 1;
 757         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
 758 }
 759
 760 /**
 761  * snd_pcm_playback_empty - check whether the playback buffer is empty
 762  * @substream: the pcm substream instance
 763  *
 764  * Checks whether the playback buffer is empty.
 765  *
 766  * Return: Non-zero if empty, or zero if not.
 767  */
 768 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
 769 {
 770         struct snd_pcm_runtime *runtime = substream->runtime;
 771         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
 772 }
 773
 774 /**
 775  * snd_pcm_capture_empty - check whether the capture buffer is empty
 776  * @substream: the pcm substream instance
 777  *
 778  * Checks whether the capture buffer is empty.
 779  *
 780  * Return: Non-zero if empty, or zero if not.
 781  */
 782 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
 783 {
 784         struct snd_pcm_runtime *runtime = substream->runtime;
 785         return snd_pcm_capture_avail(runtime) == 0;
 786 }
 787
 788 /**
 789  * snd_pcm_trigger_done - Mark the master substream
 790  * @substream: the pcm substream instance
 791  * @master: the linked master substream
 792  *
 793  * When multiple substreams of the same card are linked and the hardware
 794  * supports the single-shot operation, the driver calls this in the loop
 795  * in snd_pcm_group_for_each_entry() for marking the substream as "done".
 796  * Then most of trigger operations are performed only to the given master
 797  * substream.
 798  *
 799  * The trigger_master mark is cleared at timestamp updates at the end
 800  * of trigger operations.
 801  */
 802 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
 803                                         struct snd_pcm_substream *master)
 804 {
 805         substream->runtime->trigger_master = master;
 806 }
 807
 808 static inline int hw_is_mask(int var)
 809 {
 810         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
 811                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
 812 }
 813
 814 static inline int hw_is_interval(int var)
 815 {
 816         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
 817                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
 818 }
 819
 820 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
 821                                      snd_pcm_hw_param_t var)
 822 {
 823         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 824 }
 825
 826 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
 827                                              snd_pcm_hw_param_t var)
 828 {
 829         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 830 }
 831
 832 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
 833                                              snd_pcm_hw_param_t var)
 834 {
 835         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
 836 }
 837
 838 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
 839                                                      snd_pcm_hw_param_t var)
 840 {
 841         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
 842 }
 843
 844 /**
 845  * params_channels - Get the number of channels from the hw params
 846  * @p: hw params
 847  */
 848 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
 849 {
 850         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
 851 }
 852
 853 /**
 854  * params_channels - Get the sample rate from the hw params
 855  * @p: hw params
 856  */
 857 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
 858 {
 859         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
 860 }
 861
 862 /**
 863  * params_channels - Get the period size (in frames) from the hw params
 864  * @p: hw params
 865  */
 866 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
 867 {
 868         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
 869 }
 870
 871 /**
 872  * params_channels - Get the number of periods from the hw params
 873  * @p: hw params
 874  */
 875 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
 876 {
 877         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
 878 }
 879
 880 /**
 881  * params_channels - Get the buffer size (in frames) from the hw params
 882  * @p: hw params
 883  */
 884 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
 885 {
 886         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
 887 }
 888
 889 /**
 890  * params_channels - Get the buffer size (in bytes) from the hw params
 891  * @p: hw params
 892  */
 893 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
 894 {
 895         return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
 896 }
 897
 898 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
 899 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 900 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
 901 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
 902                           unsigned int k, struct snd_interval *c);
 903 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
 904                           const struct snd_interval *b, struct snd_interval *c);
 905 int snd_interval_list(struct snd_interval *i, unsigned int count,
 906                       const unsigned int *list, unsigned int mask);
 907 int snd_interval_ratnum(struct snd_interval *i,
 908                         unsigned int rats_count, struct snd_ratnum *rats,
 909                         unsigned int *nump, unsigned int *denp);
 910
 911 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
 912 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
 913 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 914
 915 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
 916
 917 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
 918 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
 919
 920 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 921                                u_int32_t mask);
 922 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 923                                  u_int64_t mask);
 924 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
 925                                  unsigned int min, unsigned int max);
 926 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
 927 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
 928                                unsigned int cond,
 929                                snd_pcm_hw_param_t var,
 930                                const struct snd_pcm_hw_constraint_list *l);
 931 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
 932                                   unsigned int cond,
 933                                   snd_pcm_hw_param_t var,
 934                                   struct snd_pcm_hw_constraint_ratnums *r);
 935 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
 936                                   unsigned int cond,
 937                                   snd_pcm_hw_param_t var,
 938                                   struct snd_pcm_hw_constraint_ratdens *r);
 939 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
 940                                  unsigned int cond,
 941                                  unsigned int width,
 942                                  unsigned int msbits);
 943 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
 944                                unsigned int cond,
 945                                snd_pcm_hw_param_t var,
 946                                unsigned long step);
 947 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
 948                                unsigned int cond,
 949                                snd_pcm_hw_param_t var);
 950 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
 951                                unsigned int base_rate);
 952 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
 953                         unsigned int cond,
 954                         int var,
 955                         snd_pcm_hw_rule_func_t func, void *private,
 956                         int dep, ...);
 957
 958 int snd_pcm_format_signed(snd_pcm_format_t format);
 959 int snd_pcm_format_unsigned(snd_pcm_format_t format);
 960 int snd_pcm_format_linear(snd_pcm_format_t format);
 961 int snd_pcm_format_little_endian(snd_pcm_format_t format);
 962 int snd_pcm_format_big_endian(snd_pcm_format_t format);
 963 #if 0 /* just for DocBook */
 964 /**
 965  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
 966  * @format: the format to check
 967  *
 968  * Return: 1 if the given PCM format is CPU-endian, 0 if
 969  * opposite, or a negative error code if endian not specified.
 970  */
 971 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
 972 #endif /* DocBook */
 973 #ifdef SNDRV_LITTLE_ENDIAN
 974 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
 975 #else
 976 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
 977 #endif
 978 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
 979 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
 980 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
 981 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
 982 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
 983 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian);
 984
 985 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
 986                      const struct snd_pcm_ops *ops);
 987 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
 988 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
 989 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
 990                       unsigned int cmd, void *arg);
 991 int snd_pcm_update_state(struct snd_pcm_substream *substream,
 992                          struct snd_pcm_runtime *runtime);
 993 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
 994 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
 995 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
 996 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
 997 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
 998 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
 999 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1000 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
1001                                     const void __user *buf,
1002                                     snd_pcm_uframes_t frames);
1003 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
1004                                    void __user *buf, snd_pcm_uframes_t frames);
1005 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1006                                      void __user **bufs, snd_pcm_uframes_t frames);
1007 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1008                                     void __user **bufs, snd_pcm_uframes_t frames);
1009
1010 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
1011
1012 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1013 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1014 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1015 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1016                                          unsigned int rates_b);
1017
1018 /**
1019  * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1020  * @substream: PCM substream to set
1021  * @bufp: the buffer information, NULL to clear
1022  *
1023  * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1024  * Otherwise it clears the current buffer information.
1025  */
1026 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1027                                               struct snd_dma_buffer *bufp)
1028 {
1029         struct snd_pcm_runtime *runtime = substream->runtime;
1030         if (bufp) {
1031                 runtime->dma_buffer_p = bufp;
1032                 runtime->dma_area = bufp->area;
1033                 runtime->dma_addr = bufp->addr;
1034                 runtime->dma_bytes = bufp->bytes;
1035         } else {
1036                 runtime->dma_buffer_p = NULL;
1037                 runtime->dma_area = NULL;
1038                 runtime->dma_addr = 0;
1039                 runtime->dma_bytes = 0;
1040         }
1041 }
1042
1043 /*
1044  *  Timer interface
1045  */
1046
1047 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
1048 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
1049 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
1050
1051 /**
1052  * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1053  * @runtime: PCM runtime instance
1054  * @tv: timespec to fill
1055  */
1056 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1057                                    struct timespec *tv)
1058 {
1059         switch (runtime->tstamp_type) {
1060         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1061                 ktime_get_ts(tv);
1062                 break;
1063         case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1064                 getrawmonotonic(tv);
1065                 break;
1066         default:
1067                 getnstimeofday(tv);
1068                 break;
1069         }
1070 }
1071
1072 /*
1073  *  Memory
1074  */
1075
1076 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1077 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1078 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1079                                   int type, struct device *data,
1080                                   size_t size, size_t max);
1081 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1082                                           int type, void *data,
1083                                           size_t size, size_t max);
1084 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1085 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1086
1087 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1088                                       size_t size, gfp_t gfp_flags);
1089 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1090 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1091                                           unsigned long offset);
1092 /**
1093  * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1094  * @substream: the substream to allocate the buffer to
1095  * @size: the requested buffer size, in bytes
1096  *
1097  * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1098  * contiguous in kernel virtual space, but not in physical memory.  Use this
1099  * if the buffer is accessed by kernel code but not by device DMA.
1100  *
1101  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1102  * code.
1103  */
1104 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1105                         (struct snd_pcm_substream *substream, size_t size)
1106 {
1107         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1108                                                  GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1109 }
1110
1111 /**
1112  * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1113  * @substream: the substream to allocate the buffer to
1114  * @size: the requested buffer size, in bytes
1115  *
1116  * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1117  * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1118  *
1119  * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1120  * code.
1121  */
1122 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1123                         (struct snd_pcm_substream *substream, size_t size)
1124 {
1125         return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1126                                                  GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1127 }
1128
1129 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1130
1131 #ifdef CONFIG_SND_DMA_SGBUF
1132 /*
1133  * SG-buffer handling
1134  */
1135 #define snd_pcm_substream_sgbuf(substream) \
1136         snd_pcm_get_dma_buf(substream)->private_data
1137
1138 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1139                                     unsigned long offset);
1140 #else /* !SND_DMA_SGBUF */
1141 /*
1142  * fake using a continuous buffer
1143  */
1144 #define snd_pcm_sgbuf_ops_page  NULL
1145 #endif /* SND_DMA_SGBUF */
1146
1147 /**
1148  * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1149  * @substream: PCM substream
1150  * @ofs: byte offset
1151  */
1152 static inline dma_addr_t
1153 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1154 {
1155         return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1156 }
1157
1158 /**
1159  * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1160  * @substream: PCM substream
1161  * @ofs: byte offset
1162  */
1163 static inline void *
1164 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1165 {
1166         return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1167 }
1168
1169 /**
1170  * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1171  * page from the given size
1172  * @substream: PCM substream
1173  * @ofs: byte offset
1174  * @size: byte size to examine
1175  */
1176 static inline unsigned int
1177 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1178                              unsigned int ofs, unsigned int size)
1179 {
1180         return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1181 }
1182
1183 /**
1184  * snd_pcm_mmap_data_open - increase the mmap counter
1185  * @area: VMA
1186  *
1187  * PCM mmap callback should handle this counter properly
1188  */
1189 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1190 {
1191         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1192         atomic_inc(&substream->mmap_count);
1193 }
1194
1195 /**
1196  * snd_pcm_mmap_data_close - decrease the mmap counter
1197  * @area: VMA
1198  *
1199  * PCM mmap callback should handle this counter properly
1200  */
1201 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1202 {
1203         struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1204         atomic_dec(&substream->mmap_count);
1205 }
1206
1207 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1208                              struct vm_area_struct *area);
1209 /* mmap for io-memory area */
1210 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1211 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1212 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1213 #else
1214 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1215 #define snd_pcm_lib_mmap_iomem  NULL
1216 #endif
1217
1218 #define snd_pcm_lib_mmap_vmalloc NULL
1219
1220 /**
1221  * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1222  * @dma: DMA number
1223  * @max: pointer to store the max size
1224  */
1225 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1226 {
1227         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1228 }
1229
1230 /*
1231  *  Misc
1232  */
1233
1234 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1235                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1236                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1237                                          (IEC958_AES3_CON_FS_48000<<24))
1238
1239 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1240
1241 const char *snd_pcm_format_name(snd_pcm_format_t format);
1242
1243 /**
1244  * snd_pcm_stream_str - Get a string naming the direction of a stream
1245  * @substream: the pcm substream instance
1246  *
1247  * Return: A string naming the direction of the stream.
1248  */
1249 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1250 {
1251         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1252                 return "Playback";
1253         else
1254                 return "Capture";
1255 }
1256
1257 /*
1258  * PCM channel-mapping control API
1259  */
1260 /* array element of channel maps */
1261 struct snd_pcm_chmap_elem {
1262         unsigned char channels;
1263         unsigned char map[15];
1264 };
1265
1266 /* channel map information; retrieved via snd_kcontrol_chip() */
1267 struct snd_pcm_chmap {
1268         struct snd_pcm *pcm;    /* assigned PCM instance */
1269         int stream;             /* PLAYBACK or CAPTURE */
1270         struct snd_kcontrol *kctl;
1271         const struct snd_pcm_chmap_elem *chmap;
1272         unsigned int max_channels;
1273         unsigned int channel_mask;      /* optional: active channels bitmask */
1274         void *private_data;     /* optional: private data pointer */
1275 };
1276
1277 /**
1278  * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1279  * @info: chmap information
1280  * @idx: the substream number index
1281  */
1282 static inline struct snd_pcm_substream *
1283 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1284 {
1285         struct snd_pcm_substream *s;
1286         for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1287                 if (s->number == idx)
1288                         return s;
1289         return NULL;
1290 }
1291
1292 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1293 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1294 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1295 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1296
1297 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1298 #define SND_PCM_CHMAP_MASK_24   ((1U << 2) | (1U << 4))
1299 #define SND_PCM_CHMAP_MASK_246  (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1300 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1301
1302 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1303                            const struct snd_pcm_chmap_elem *chmap,
1304                            int max_channels,
1305                            unsigned long private_value,
1306                            struct snd_pcm_chmap **info_ret);
1307
1308 /**
1309  * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1310  * @pcm_format: PCM format
1311  */
1312 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1313 {
1314         return 1ULL << (__force int) pcm_format;
1315 }
1316
1317 /* printk helpers */
1318 #define pcm_err(pcm, fmt, args...) \
1319         dev_err((pcm)->card->dev, fmt, ##args)
1320 #define pcm_warn(pcm, fmt, args...) \
1321         dev_warn((pcm)->card->dev, fmt, ##args)
1322 #define pcm_dbg(pcm, fmt, args...) \
1323         dev_dbg((pcm)->card->dev, fmt, ##args)
1324
1325 #endif /* __SOUND_PCM_H */