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