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