blob: f84d84993a31e83cf9d603f3f3e88c12db9e0411 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __SOUND_PCM_H
2#define __SOUND_PCM_H
3
4/*
5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@suse.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 <linux/poll.h>
29#include <linux/bitops.h>
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#define snd_pcm_substream_chip(substream) ((substream)->private_data)
32#define snd_pcm_chip(pcm) ((pcm)->private_data)
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
35#include "pcm_oss.h"
36#endif
37
38/*
39 * Hardware (lowlevel) section
40 */
41
Takashi Iwai877211f2005-11-17 13:59:38 +010042struct snd_pcm_hardware {
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 unsigned int info; /* SNDRV_PCM_INFO_* */
44 u64 formats; /* SNDRV_PCM_FMTBIT_* */
45 unsigned int rates; /* SNDRV_PCM_RATE_* */
46 unsigned int rate_min; /* min rate */
47 unsigned int rate_max; /* max rate */
48 unsigned int channels_min; /* min channels */
49 unsigned int channels_max; /* max channels */
50 size_t buffer_bytes_max; /* max buffer size */
51 size_t period_bytes_min; /* min period size */
52 size_t period_bytes_max; /* max period size */
53 unsigned int periods_min; /* min # of periods */
54 unsigned int periods_max; /* max # of periods */
55 size_t fifo_size; /* fifo size in bytes */
Takashi Iwai877211f2005-11-17 13:59:38 +010056};
Linus Torvalds1da177e2005-04-16 15:20:36 -070057
Takashi Iwai877211f2005-11-17 13:59:38 +010058struct snd_pcm_ops {
59 int (*open)(struct snd_pcm_substream *substream);
60 int (*close)(struct snd_pcm_substream *substream);
61 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010063 int (*hw_params)(struct snd_pcm_substream *substream,
64 struct snd_pcm_hw_params *params);
65 int (*hw_free)(struct snd_pcm_substream *substream);
66 int (*prepare)(struct snd_pcm_substream *substream);
67 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
68 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
69 int (*copy)(struct snd_pcm_substream *substream, int channel,
70 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010072 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010074 struct page *(*page)(struct snd_pcm_substream *substream,
75 unsigned long offset);
76 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
77 int (*ack)(struct snd_pcm_substream *substream);
78};
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80/*
81 *
82 */
83
84#define SNDRV_PCM_DEVICES 8
85
86#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
87#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
88
89#define SNDRV_PCM_IOCTL1_RESET 0
90#define SNDRV_PCM_IOCTL1_INFO 1
91#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
92#define SNDRV_PCM_IOCTL1_GSTATE 3
93
94#define SNDRV_PCM_TRIGGER_STOP 0
95#define SNDRV_PCM_TRIGGER_START 1
96#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
97#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
98#define SNDRV_PCM_TRIGGER_SUSPEND 5
99#define SNDRV_PCM_TRIGGER_RESUME 6
100
101#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
102
103/* If you change this don't forget to change rates[] table in pcm_native.c */
104#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
105#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
106#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
107#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
108#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
109#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
110#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
111#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
112#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
113#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
114#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
115#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
116#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
117
118#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
119#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
120
121#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
122 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
123 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
124#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
125#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
126 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
127#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
128 SNDRV_PCM_RATE_192000)
129#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
130#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
131#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
132#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
133#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
134#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
135#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
136#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
137#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
138#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
139#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
140#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
141#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
142#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
143#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
144#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
145#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
146#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
147#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
148#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
149#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
150#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
151#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
152#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
153#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
154#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
155#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
156#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
157#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
158#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
159#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
160#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
161#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
162#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
163#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
164#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
165#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
166#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
167
168#ifdef SNDRV_LITTLE_ENDIAN
169#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
170#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
171#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
172#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
173#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
174#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
175#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
176#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
177#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
178#endif
179#ifdef SNDRV_BIG_ENDIAN
180#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
181#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
182#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
183#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
184#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
185#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
186#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
187#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
188#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
189#endif
190
Takashi Iwai877211f2005-11-17 13:59:38 +0100191struct snd_pcm_file {
192 struct snd_pcm_substream *substream;
193 struct snd_pcm_file *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194};
195
Takashi Iwai877211f2005-11-17 13:59:38 +0100196struct snd_pcm_hw_rule;
197typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
198 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Takashi Iwai877211f2005-11-17 13:59:38 +0100200struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 unsigned int cond;
202 snd_pcm_hw_rule_func_t func;
203 int var;
204 int deps[4];
205 void *private;
206};
207
Takashi Iwai877211f2005-11-17 13:59:38 +0100208struct snd_pcm_hw_constraints {
209 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100211 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
213 unsigned int rules_num;
214 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100215 struct snd_pcm_hw_rule *rules;
216};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
Takashi Iwai877211f2005-11-17 13:59:38 +0100218static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
219 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
221 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
222}
223
Takashi Iwai877211f2005-11-17 13:59:38 +0100224static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
225 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
228}
229
Takashi Iwai877211f2005-11-17 13:59:38 +0100230struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 unsigned int num;
232 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100233};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Takashi Iwai877211f2005-11-17 13:59:38 +0100235struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 unsigned int num_min, num_max, num_step;
237 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100238};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Takashi Iwai877211f2005-11-17 13:59:38 +0100240struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100242 struct snd_ratnum *rats;
243};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Takashi Iwai877211f2005-11-17 13:59:38 +0100245struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100247 struct snd_ratden *rats;
248};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Takashi Iwai877211f2005-11-17 13:59:38 +0100250struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 unsigned int count;
252 unsigned int *list;
253 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100254};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
Takashi Iwai877211f2005-11-17 13:59:38 +0100256struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100258 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200259 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 int overrange;
261 snd_pcm_uframes_t avail_max;
262 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
263 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
264
265 /* -- HW params -- */
266 snd_pcm_access_t access; /* access mode */
267 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
268 snd_pcm_subformat_t subformat; /* subformat */
269 unsigned int rate; /* rate in Hz */
270 unsigned int channels; /* channels */
271 snd_pcm_uframes_t period_size; /* period size */
272 unsigned int periods; /* periods */
273 snd_pcm_uframes_t buffer_size; /* buffer size */
274 unsigned int tick_time; /* tick time */
275 snd_pcm_uframes_t min_align; /* Min alignment for the format */
276 size_t byte_align;
277 unsigned int frame_bits;
278 unsigned int sample_bits;
279 unsigned int info;
280 unsigned int rate_num;
281 unsigned int rate_den;
282
283 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100284 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 unsigned int period_step;
286 unsigned int sleep_min; /* min ticks to sleep */
287 snd_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
288 snd_pcm_uframes_t start_threshold;
289 snd_pcm_uframes_t stop_threshold;
290 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
291 noise is nearest than this */
292 snd_pcm_uframes_t silence_size; /* Silence filling size */
293 snd_pcm_uframes_t boundary; /* pointers wrap point */
294
295 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
296 snd_pcm_uframes_t silence_filled; /* size filled with silence */
297
Takashi Iwai877211f2005-11-17 13:59:38 +0100298 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
300 /* -- mmap -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100301 volatile struct snd_pcm_mmap_status *status;
302 volatile struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303
304 /* -- locking / scheduling -- */
305 wait_queue_head_t sleep;
306 struct timer_list tick_timer;
307 struct fasync_struct *fasync;
308
309 /* -- private section -- */
310 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100311 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312
313 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100314 struct snd_pcm_hardware hw;
315 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
317 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100318 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
319 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
321 /* -- timer -- */
322 unsigned int timer_resolution; /* timer resolution */
323
324 /* -- DMA -- */
325 unsigned char *dma_area; /* DMA area */
326 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
327 size_t dma_bytes; /* size of DMA area */
328
329 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
330
331#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
332 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100333 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334#endif
335};
336
Takashi Iwai877211f2005-11-17 13:59:38 +0100337struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 spinlock_t lock;
339 struct list_head substreams;
340 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100341};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342
Takashi Iwai877211f2005-11-17 13:59:38 +0100343struct snd_pcm_substream {
344 struct snd_pcm *pcm;
345 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 void *private_data; /* copied from pcm->private_data */
347 int number;
348 char name[32]; /* substream name */
349 int stream; /* stream (direction) */
350 size_t buffer_bytes_max; /* limit ring buffer size */
351 struct snd_dma_buffer dma_buffer;
352 unsigned int dma_buf_id;
353 size_t dma_max;
354 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100355 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100357 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100359 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 unsigned timer_running: 1; /* time is running */
361 spinlock_t timer_lock;
362 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100363 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 /* -- linked substreams -- */
365 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100366 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
367 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200369 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200370 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200371 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200372 unsigned int f_flags;
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +0200373 void (*pcm_release)(struct snd_pcm_substream *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
375 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100376 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200378#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100379 struct snd_info_entry *proc_root;
380 struct snd_info_entry *proc_info_entry;
381 struct snd_info_entry *proc_hw_params_entry;
382 struct snd_info_entry *proc_sw_params_entry;
383 struct snd_info_entry *proc_status_entry;
384 struct snd_info_entry *proc_prealloc_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200385#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 /* misc flags */
387 unsigned int no_mmap_ctrl: 1;
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +0200388 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389};
390
Takashi Iwai0df63e42006-04-28 15:13:41 +0200391#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
393
Takashi Iwai877211f2005-11-17 13:59:38 +0100394struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100396 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 /* -- substreams -- */
398 unsigned int substream_count;
399 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100400 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
402 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100403 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100405 struct snd_pcm_file *files;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200406#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100407 struct snd_info_entry *proc_root;
408 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200409#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100411 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200413#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414};
415
Takashi Iwai877211f2005-11-17 13:59:38 +0100416struct snd_pcm {
417 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100418 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 unsigned int device; /* device number */
420 unsigned int info_flags;
421 unsigned short dev_class;
422 unsigned short dev_subclass;
423 char id[64];
424 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100425 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100426 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 wait_queue_head_t open_wait;
428 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100429 void (*private_free) (struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100431 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432#endif
433};
434
Takashi Iwai877211f2005-11-17 13:59:38 +0100435struct snd_pcm_notify {
436 int (*n_register) (struct snd_pcm * pcm);
437 int (*n_disconnect) (struct snd_pcm * pcm);
438 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100440};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441
442/*
443 * Registering
444 */
445
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100446extern struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Takashi Iwai877211f2005-11-17 13:59:38 +0100448int snd_pcm_new(struct snd_card *card, char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100450 struct snd_pcm **rpcm);
451int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452
Takashi Iwai877211f2005-11-17 13:59:38 +0100453int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455/*
456 * Native I/O
457 */
458
459extern rwlock_t snd_pcm_link_rwlock;
460
Takashi Iwai877211f2005-11-17 13:59:38 +0100461int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
462int snd_pcm_info_user(struct snd_pcm_substream *substream,
463 struct snd_pcm_info __user *info);
464int snd_pcm_status(struct snd_pcm_substream *substream,
465 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100466int snd_pcm_start(struct snd_pcm_substream *substream);
467int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
468int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100470int snd_pcm_suspend(struct snd_pcm_substream *substream);
471int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100473int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +0200474int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
475 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100476void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f9b2006-03-27 16:40:49 +0200477int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
478 struct snd_pcm_substream **rsubstream);
479void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100481int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483#if BITS_PER_LONG >= 64
484
485static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
486{
487 *rem = *n % div;
488 *n /= div;
489}
490
491#elif defined(i386)
492
493static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
494{
495 u_int32_t low, high;
496 low = *n & 0xffffffff;
497 high = *n >> 32;
498 if (high) {
499 u_int32_t high1 = high % div;
500 high /= div;
501 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
502 *n = (u_int64_t)high << 32 | low;
503 } else {
504 *n = low / div;
505 *rem = low % div;
506 }
507}
508#else
509
510static inline void divl(u_int32_t high, u_int32_t low,
511 u_int32_t div,
512 u_int32_t *q, u_int32_t *r)
513{
514 u_int64_t n = (u_int64_t)high << 32 | low;
515 u_int64_t d = (u_int64_t)div << 31;
516 u_int32_t q1 = 0;
517 int c = 32;
518 while (n > 0xffffffffU) {
519 q1 <<= 1;
520 if (n >= d) {
521 n -= d;
522 q1 |= 1;
523 }
524 d >>= 1;
525 c--;
526 }
527 q1 <<= c;
528 if (n) {
529 low = n;
530 *q = q1 | (low / div);
531 *r = low % div;
532 } else {
533 *r = 0;
534 *q = q1;
535 }
536 return;
537}
538
539static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
540{
541 u_int32_t low, high;
542 low = *n & 0xffffffff;
543 high = *n >> 32;
544 if (high) {
545 u_int32_t high1 = high % div;
546 u_int32_t low1 = low;
547 high /= div;
548 divl(high1, low1, div, &low, rem);
549 *n = (u_int64_t)high << 32 | low;
550 } else {
551 *n = low / div;
552 *rem = low % div;
553 }
554}
555#endif
556
557/*
558 * PCM library
559 */
560
Takashi Iwai877211f2005-11-17 13:59:38 +0100561static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
563 return substream->group != &substream->self_group;
564}
565
Takashi Iwai877211f2005-11-17 13:59:38 +0100566static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
568 read_lock(&snd_pcm_link_rwlock);
569 spin_lock(&substream->self_group.lock);
570}
571
Takashi Iwai877211f2005-11-17 13:59:38 +0100572static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
574 spin_unlock(&substream->self_group.lock);
575 read_unlock(&snd_pcm_link_rwlock);
576}
577
Takashi Iwai877211f2005-11-17 13:59:38 +0100578static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
580 read_lock_irq(&snd_pcm_link_rwlock);
581 spin_lock(&substream->self_group.lock);
582}
583
Takashi Iwai877211f2005-11-17 13:59:38 +0100584static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
586 spin_unlock(&substream->self_group.lock);
587 read_unlock_irq(&snd_pcm_link_rwlock);
588}
589
590#define snd_pcm_stream_lock_irqsave(substream, flags) \
591do { \
592 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
593 spin_lock(&substream->self_group.lock); \
594} while (0)
595
596#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
597do { \
598 spin_unlock(&substream->self_group.lock); \
599 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
600} while (0)
601
602#define snd_pcm_group_for_each(pos, substream) \
603 list_for_each(pos, &substream->group->substreams)
604
605#define snd_pcm_group_substream_entry(pos) \
Takashi Iwai877211f2005-11-17 13:59:38 +0100606 list_entry(pos, struct snd_pcm_substream, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Takashi Iwai877211f2005-11-17 13:59:38 +0100608static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609{
610 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
611 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
612 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
613}
614
Takashi Iwai877211f2005-11-17 13:59:38 +0100615static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
617 return size * 8 / runtime->sample_bits;
618}
619
Takashi Iwai877211f2005-11-17 13:59:38 +0100620static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
622 return size * 8 / runtime->frame_bits;
623}
624
Takashi Iwai877211f2005-11-17 13:59:38 +0100625static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
627 return size * runtime->sample_bits / 8;
628}
629
Takashi Iwai877211f2005-11-17 13:59:38 +0100630static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
632 return size * runtime->frame_bits / 8;
633}
634
Takashi Iwai877211f2005-11-17 13:59:38 +0100635static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
637 return bytes % runtime->byte_align == 0;
638}
639
Takashi Iwai877211f2005-11-17 13:59:38 +0100640static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Takashi Iwai877211f2005-11-17 13:59:38 +0100642 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 return frames_to_bytes(runtime, runtime->buffer_size);
644}
645
Takashi Iwai877211f2005-11-17 13:59:38 +0100646static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
Takashi Iwai877211f2005-11-17 13:59:38 +0100648 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 return frames_to_bytes(runtime, runtime->period_size);
650}
651
652/*
653 * result is: 0 ... (boundary - 1)
654 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100655static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
657 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
658 if (avail < 0)
659 avail += runtime->boundary;
660 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
661 avail -= runtime->boundary;
662 return avail;
663}
664
665/*
666 * result is: 0 ... (boundary - 1)
667 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100668static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669{
670 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
671 if (avail < 0)
672 avail += runtime->boundary;
673 return avail;
674}
675
Takashi Iwai877211f2005-11-17 13:59:38 +0100676static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677{
678 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
679}
680
Takashi Iwai877211f2005-11-17 13:59:38 +0100681static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
683 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
684}
685
686/**
687 * snd_pcm_playback_ready - check whether the playback buffer is available
688 * @substream: the pcm substream instance
689 *
690 * Checks whether enough free space is available on the playback buffer.
691 *
692 * Returns non-zero if available, or zero if not.
693 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100694static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695{
Takashi Iwai877211f2005-11-17 13:59:38 +0100696 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
698}
699
700/**
701 * snd_pcm_capture_ready - check whether the capture buffer is available
702 * @substream: the pcm substream instance
703 *
704 * Checks whether enough capture data is available on the capture buffer.
705 *
706 * Returns non-zero if available, or zero if not.
707 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100708static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709{
Takashi Iwai877211f2005-11-17 13:59:38 +0100710 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
712}
713
714/**
715 * snd_pcm_playback_data - check whether any data exists on the playback buffer
716 * @substream: the pcm substream instance
717 *
718 * Checks whether any data exists on the playback buffer. If stop_threshold
719 * is bigger or equal to boundary, then this function returns always non-zero.
720 *
721 * Returns non-zero if exists, or zero if not.
722 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100723static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Takashi Iwai877211f2005-11-17 13:59:38 +0100725 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 if (runtime->stop_threshold >= runtime->boundary)
728 return 1;
729 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
730}
731
732/**
733 * snd_pcm_playback_empty - check whether the playback buffer is empty
734 * @substream: the pcm substream instance
735 *
736 * Checks whether the playback buffer is empty.
737 *
738 * Returns non-zero if empty, or zero if not.
739 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100740static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
Takashi Iwai877211f2005-11-17 13:59:38 +0100742 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
744}
745
746/**
747 * snd_pcm_capture_empty - check whether the capture buffer is empty
748 * @substream: the pcm substream instance
749 *
750 * Checks whether the capture buffer is empty.
751 *
752 * Returns non-zero if empty, or zero if not.
753 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100754static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755{
Takashi Iwai877211f2005-11-17 13:59:38 +0100756 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 return snd_pcm_capture_avail(runtime) == 0;
758}
759
Takashi Iwai877211f2005-11-17 13:59:38 +0100760static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
761 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762{
763 substream->runtime->trigger_master = master;
764}
765
766static inline int hw_is_mask(int var)
767{
768 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
769 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
770}
771
772static inline int hw_is_interval(int var)
773{
774 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
775 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
776}
777
Takashi Iwai877211f2005-11-17 13:59:38 +0100778static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 snd_pcm_hw_param_t var)
780{
781 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
782}
783
Takashi Iwai877211f2005-11-17 13:59:38 +0100784static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 snd_pcm_hw_param_t var)
786{
787 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
788}
789
Takashi Iwai877211f2005-11-17 13:59:38 +0100790static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 snd_pcm_hw_param_t var)
792{
Takashi Iwai877211f2005-11-17 13:59:38 +0100793 return (const struct snd_mask *)hw_param_mask((struct snd_pcm_hw_params*) params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794}
795
Takashi Iwai877211f2005-11-17 13:59:38 +0100796static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 snd_pcm_hw_param_t var)
798{
Takashi Iwai877211f2005-11-17 13:59:38 +0100799 return (const struct snd_interval *)hw_param_interval((struct snd_pcm_hw_params*) params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
803#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
804#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
805#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
806#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
807#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
808#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
809#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
810#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
811#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
812#define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
813
814
Takashi Iwai877211f2005-11-17 13:59:38 +0100815int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
816void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
817void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
818void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
819 unsigned int k, struct snd_interval *c);
820void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
821 const struct snd_interval *b, struct snd_interval *c);
822int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
823int snd_interval_ratnum(struct snd_interval *i,
824 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 unsigned int *nump, unsigned int *denp);
826
Takashi Iwai877211f2005-11-17 13:59:38 +0100827void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
828void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100829int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830
Takashi Iwai877211f2005-11-17 13:59:38 +0100831int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832
Takashi Iwai877211f2005-11-17 13:59:38 +0100833int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
834int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
Takashi Iwai877211f2005-11-17 13:59:38 +0100836int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100838int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100840int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100842int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
843int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 unsigned int cond,
845 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100846 struct snd_pcm_hw_constraint_list *l);
847int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 unsigned int cond,
849 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100850 struct snd_pcm_hw_constraint_ratnums *r);
851int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 unsigned int cond,
853 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100854 struct snd_pcm_hw_constraint_ratdens *r);
855int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 unsigned int cond,
857 unsigned int width,
858 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100859int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 unsigned int cond,
861 snd_pcm_hw_param_t var,
862 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100863int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 unsigned int cond,
865 snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100866int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 unsigned int cond,
868 int var,
869 snd_pcm_hw_rule_func_t func, void *private,
870 int dep, ...);
871
872int snd_pcm_format_signed(snd_pcm_format_t format);
873int snd_pcm_format_unsigned(snd_pcm_format_t format);
874int snd_pcm_format_linear(snd_pcm_format_t format);
875int snd_pcm_format_little_endian(snd_pcm_format_t format);
876int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200877#if 0 /* just for DocBook */
878/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200879 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
880 * @format: the format to check
881 *
882 * Returns 1 if the given PCM format is CPU-endian, 0 if
883 * opposite, or a negative error code if endian not specified.
884 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200885int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200886#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200887#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700888#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200889#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700890#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200891#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
893int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200894ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
896int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
897snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
Takashi Iwai877211f2005-11-17 13:59:38 +0100899void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
900void snd_pcm_set_sync(struct snd_pcm_substream *substream);
901int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
902int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +0100904int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
905int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
906int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
907int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
908int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
909void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
910void snd_pcm_tick_prepare(struct snd_pcm_substream *substream);
911void snd_pcm_tick_set(struct snd_pcm_substream *substream, unsigned long ticks);
912void snd_pcm_tick_elapsed(struct snd_pcm_substream *substream);
913void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
914snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 const void __user *buf,
916 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100917snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100919snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100921snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 void __user **bufs, snd_pcm_uframes_t frames);
923
Takashi Iwai877211f2005-11-17 13:59:38 +0100924int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Takashi Iwai877211f2005-11-17 13:59:38 +0100926static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 struct snd_dma_buffer *bufp)
928{
Takashi Iwai877211f2005-11-17 13:59:38 +0100929 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 if (bufp) {
931 runtime->dma_buffer_p = bufp;
932 runtime->dma_area = bufp->area;
933 runtime->dma_addr = bufp->addr;
934 runtime->dma_bytes = bufp->bytes;
935 } else {
936 runtime->dma_buffer_p = NULL;
937 runtime->dma_area = NULL;
938 runtime->dma_addr = 0;
939 runtime->dma_bytes = 0;
940 }
941}
942
943/*
944 * Timer interface
945 */
946
Takashi Iwai877211f2005-11-17 13:59:38 +0100947void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
948void snd_pcm_timer_init(struct snd_pcm_substream *substream);
949void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
951/*
952 * Memory
953 */
954
Takashi Iwai877211f2005-11-17 13:59:38 +0100955int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
956int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
957int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 int type, struct device *data,
959 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100960int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 int type, void *data,
962 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100963int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
964int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966#define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
967#define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
968#define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
Takashi Iwai877211f2005-11-17 13:59:38 +0100969struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
971/* handle mmap counter - PCM mmap callback should handle this counter properly */
972static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
973{
Takashi Iwai877211f2005-11-17 13:59:38 +0100974 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200975 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976}
977
978static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
979{
Takashi Iwai877211f2005-11-17 13:59:38 +0100980 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200981 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982}
983
984/* mmap for io-memory area */
985#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
986#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +0100987int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988#else
989#define SNDRV_PCM_INFO_MMAP_IOMEM 0
990#define snd_pcm_lib_mmap_iomem NULL
991#endif
992
993static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
994{
995 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
996}
997
998/*
999 * Misc
1000 */
1001
1002#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1003 (IEC958_AES1_CON_ORIGINAL<<8)|\
1004 (IEC958_AES1_CON_PCM_CODER<<8)|\
1005 (IEC958_AES3_CON_FS_48000<<24))
1006
1007#endif /* __SOUND_PCM_H */