blob: 5e9cc460075efa5ee9726d0cb282218f67355100 [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
Jaroslav Kyselac1017a42007-10-15 09:50:19 +02006 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * 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>
Al Virof23f6e02006-10-20 15:17:02 -040029#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/bitops.h>
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define snd_pcm_substream_chip(substream) ((substream)->private_data)
33#define snd_pcm_chip(pcm) ((pcm)->private_data)
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
36#include "pcm_oss.h"
37#endif
38
39/*
40 * Hardware (lowlevel) section
41 */
42
Takashi Iwai877211f2005-11-17 13:59:38 +010043struct snd_pcm_hardware {
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 unsigned int info; /* SNDRV_PCM_INFO_* */
45 u64 formats; /* SNDRV_PCM_FMTBIT_* */
46 unsigned int rates; /* SNDRV_PCM_RATE_* */
47 unsigned int rate_min; /* min rate */
48 unsigned int rate_max; /* max rate */
49 unsigned int channels_min; /* min channels */
50 unsigned int channels_max; /* max channels */
51 size_t buffer_bytes_max; /* max buffer size */
52 size_t period_bytes_min; /* min period size */
53 size_t period_bytes_max; /* max period size */
54 unsigned int periods_min; /* min # of periods */
55 unsigned int periods_max; /* max # of periods */
56 size_t fifo_size; /* fifo size in bytes */
Takashi Iwai877211f2005-11-17 13:59:38 +010057};
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Randy Dunlape0e6ce02006-12-07 08:22:50 +010059struct snd_pcm_substream;
60
Takashi Iwai877211f2005-11-17 13:59:38 +010061struct snd_pcm_ops {
62 int (*open)(struct snd_pcm_substream *substream);
63 int (*close)(struct snd_pcm_substream *substream);
64 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010066 int (*hw_params)(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params *params);
68 int (*hw_free)(struct snd_pcm_substream *substream);
69 int (*prepare)(struct snd_pcm_substream *substream);
70 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
71 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
72 int (*copy)(struct snd_pcm_substream *substream, int channel,
73 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010075 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010077 struct page *(*page)(struct snd_pcm_substream *substream,
78 unsigned long offset);
79 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
80 int (*ack)(struct snd_pcm_substream *substream);
81};
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83/*
84 *
85 */
86
87#define SNDRV_PCM_DEVICES 8
88
89#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
90#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
91
92#define SNDRV_PCM_IOCTL1_RESET 0
93#define SNDRV_PCM_IOCTL1_INFO 1
94#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
95#define SNDRV_PCM_IOCTL1_GSTATE 3
96
97#define SNDRV_PCM_TRIGGER_STOP 0
98#define SNDRV_PCM_TRIGGER_START 1
99#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
100#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
101#define SNDRV_PCM_TRIGGER_SUSPEND 5
102#define SNDRV_PCM_TRIGGER_RESUME 6
103
104#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
105
106/* If you change this don't forget to change rates[] table in pcm_native.c */
107#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
108#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
109#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
110#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
111#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
112#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
113#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
114#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
115#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
116#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
117#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
118#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
119#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
120
121#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
122#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
123
124#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
125 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
126 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
127#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
128#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
129 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
130#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
131 SNDRV_PCM_RATE_192000)
132#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
133#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
134#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
135#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
136#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
137#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
138#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
139#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
140#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
141#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
142#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
143#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
144#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
145#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
146#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
147#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
148#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
149#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
150#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
151#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
152#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
153#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
154#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
155#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
156#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
157#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
158#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
159#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
160#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
161#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
162#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
163#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
164#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
165#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
166#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
167#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
168#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
169#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
170
171#ifdef SNDRV_LITTLE_ENDIAN
172#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
173#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
174#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
175#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
176#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
177#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
178#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
179#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
180#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
181#endif
182#ifdef SNDRV_BIG_ENDIAN
183#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
184#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
185#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
186#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
187#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
188#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
189#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
190#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
191#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
192#endif
193
Takashi Iwai877211f2005-11-17 13:59:38 +0100194struct snd_pcm_file {
195 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200196 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197};
198
Takashi Iwai877211f2005-11-17 13:59:38 +0100199struct snd_pcm_hw_rule;
200typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
201 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Takashi Iwai877211f2005-11-17 13:59:38 +0100203struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 unsigned int cond;
205 snd_pcm_hw_rule_func_t func;
206 int var;
207 int deps[4];
208 void *private;
209};
210
Takashi Iwai877211f2005-11-17 13:59:38 +0100211struct snd_pcm_hw_constraints {
212 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100214 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
216 unsigned int rules_num;
217 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100218 struct snd_pcm_hw_rule *rules;
219};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Takashi Iwai877211f2005-11-17 13:59:38 +0100221static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
222 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223{
224 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
225}
226
Takashi Iwai877211f2005-11-17 13:59:38 +0100227static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
228 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229{
230 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
231}
232
Takashi Iwai877211f2005-11-17 13:59:38 +0100233struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 unsigned int num;
235 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100236};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Takashi Iwai877211f2005-11-17 13:59:38 +0100238struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 unsigned int num_min, num_max, num_step;
240 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100241};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Takashi Iwai877211f2005-11-17 13:59:38 +0100243struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100245 struct snd_ratnum *rats;
246};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Takashi Iwai877211f2005-11-17 13:59:38 +0100248struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100250 struct snd_ratden *rats;
251};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Takashi Iwai877211f2005-11-17 13:59:38 +0100253struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 unsigned int count;
255 unsigned int *list;
256 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100257};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Takashi Iwai877211f2005-11-17 13:59:38 +0100259struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100261 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200262 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 int overrange;
264 snd_pcm_uframes_t avail_max;
265 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
266 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
267
268 /* -- HW params -- */
269 snd_pcm_access_t access; /* access mode */
270 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
271 snd_pcm_subformat_t subformat; /* subformat */
272 unsigned int rate; /* rate in Hz */
273 unsigned int channels; /* channels */
274 snd_pcm_uframes_t period_size; /* period size */
275 unsigned int periods; /* periods */
276 snd_pcm_uframes_t buffer_size; /* buffer size */
277 unsigned int tick_time; /* tick time */
278 snd_pcm_uframes_t min_align; /* Min alignment for the format */
279 size_t byte_align;
280 unsigned int frame_bits;
281 unsigned int sample_bits;
282 unsigned int info;
283 unsigned int rate_num;
284 unsigned int rate_den;
285
286 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100287 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 unsigned int period_step;
289 unsigned int sleep_min; /* min ticks to sleep */
290 snd_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
291 snd_pcm_uframes_t start_threshold;
292 snd_pcm_uframes_t stop_threshold;
293 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
294 noise is nearest than this */
295 snd_pcm_uframes_t silence_size; /* Silence filling size */
296 snd_pcm_uframes_t boundary; /* pointers wrap point */
297
298 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
299 snd_pcm_uframes_t silence_filled; /* size filled with silence */
300
Takashi Iwai877211f2005-11-17 13:59:38 +0100301 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303 /* -- mmap -- */
Takashi Iwai503fc852007-09-11 00:35:06 +0200304 struct snd_pcm_mmap_status *status;
305 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
307 /* -- locking / scheduling -- */
308 wait_queue_head_t sleep;
309 struct timer_list tick_timer;
310 struct fasync_struct *fasync;
311
312 /* -- private section -- */
313 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100314 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
316 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100317 struct snd_pcm_hardware hw;
318 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319
320 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100321 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
322 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
324 /* -- timer -- */
325 unsigned int timer_resolution; /* timer resolution */
326
327 /* -- DMA -- */
328 unsigned char *dma_area; /* DMA area */
329 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
330 size_t dma_bytes; /* size of DMA area */
331
332 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
333
334#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
335 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100336 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337#endif
338};
339
Takashi Iwai877211f2005-11-17 13:59:38 +0100340struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 spinlock_t lock;
342 struct list_head substreams;
343 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100344};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Takashi Iwai877211f2005-11-17 13:59:38 +0100346struct snd_pcm_substream {
347 struct snd_pcm *pcm;
348 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 void *private_data; /* copied from pcm->private_data */
350 int number;
351 char name[32]; /* substream name */
352 int stream; /* stream (direction) */
Takashi Iwai9442e692006-09-30 23:27:19 -0700353 char latency_id[20]; /* latency identifier */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 size_t buffer_bytes_max; /* limit ring buffer size */
355 struct snd_dma_buffer dma_buffer;
356 unsigned int dma_buf_id;
357 size_t dma_max;
358 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100359 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100361 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100363 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 unsigned timer_running: 1; /* time is running */
365 spinlock_t timer_lock;
366 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100367 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 /* -- linked substreams -- */
369 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100370 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
371 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200373 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200374 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200375 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200376 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200377 void (*pcm_release)(struct snd_pcm_substream *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
379 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100380 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200382#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100383 struct snd_info_entry *proc_root;
384 struct snd_info_entry *proc_info_entry;
385 struct snd_info_entry *proc_hw_params_entry;
386 struct snd_info_entry *proc_sw_params_entry;
387 struct snd_info_entry *proc_status_entry;
388 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200389 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200390#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200392 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393};
394
Takashi Iwai0df63e42006-04-28 15:13:41 +0200395#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396
397
Takashi Iwai877211f2005-11-17 13:59:38 +0100398struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100400 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 /* -- substreams -- */
402 unsigned int substream_count;
403 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100404 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
406 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100407 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200409#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100410 struct snd_info_entry *proc_root;
411 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200412#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100414 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200416#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417};
418
Takashi Iwai877211f2005-11-17 13:59:38 +0100419struct snd_pcm {
420 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100421 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 unsigned int device; /* device number */
423 unsigned int info_flags;
424 unsigned short dev_class;
425 unsigned short dev_subclass;
426 char id[64];
427 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100428 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100429 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 wait_queue_head_t open_wait;
431 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100432 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200433 struct device *dev; /* actual hw device this belongs to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100435 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436#endif
437};
438
Takashi Iwai877211f2005-11-17 13:59:38 +0100439struct snd_pcm_notify {
440 int (*n_register) (struct snd_pcm * pcm);
441 int (*n_disconnect) (struct snd_pcm * pcm);
442 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100444};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
446/*
447 * Registering
448 */
449
Arjan van de Ven54047322007-02-12 00:55:28 -0800450extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Takashi Iwai877211f2005-11-17 13:59:38 +0100452int snd_pcm_new(struct snd_card *card, char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100454 struct snd_pcm **rpcm);
455int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
Takashi Iwai877211f2005-11-17 13:59:38 +0100457int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
459/*
460 * Native I/O
461 */
462
463extern rwlock_t snd_pcm_link_rwlock;
464
Takashi Iwai877211f2005-11-17 13:59:38 +0100465int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
466int snd_pcm_info_user(struct snd_pcm_substream *substream,
467 struct snd_pcm_info __user *info);
468int snd_pcm_status(struct snd_pcm_substream *substream,
469 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100470int snd_pcm_start(struct snd_pcm_substream *substream);
471int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
472int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100474int snd_pcm_suspend(struct snd_pcm_substream *substream);
475int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100477int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200478int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
479 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100480void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200481int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
482 struct snd_pcm_substream **rsubstream);
483void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100485int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
487#if BITS_PER_LONG >= 64
488
489static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
490{
491 *rem = *n % div;
492 *n /= div;
493}
494
495#elif defined(i386)
496
497static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
498{
499 u_int32_t low, high;
500 low = *n & 0xffffffff;
501 high = *n >> 32;
502 if (high) {
503 u_int32_t high1 = high % div;
504 high /= div;
505 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
506 *n = (u_int64_t)high << 32 | low;
507 } else {
508 *n = low / div;
509 *rem = low % div;
510 }
511}
512#else
513
514static inline void divl(u_int32_t high, u_int32_t low,
515 u_int32_t div,
516 u_int32_t *q, u_int32_t *r)
517{
518 u_int64_t n = (u_int64_t)high << 32 | low;
519 u_int64_t d = (u_int64_t)div << 31;
520 u_int32_t q1 = 0;
521 int c = 32;
522 while (n > 0xffffffffU) {
523 q1 <<= 1;
524 if (n >= d) {
525 n -= d;
526 q1 |= 1;
527 }
528 d >>= 1;
529 c--;
530 }
531 q1 <<= c;
532 if (n) {
533 low = n;
534 *q = q1 | (low / div);
535 *r = low % div;
536 } else {
537 *r = 0;
538 *q = q1;
539 }
540 return;
541}
542
543static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
544{
545 u_int32_t low, high;
546 low = *n & 0xffffffff;
547 high = *n >> 32;
548 if (high) {
549 u_int32_t high1 = high % div;
550 u_int32_t low1 = low;
551 high /= div;
552 divl(high1, low1, div, &low, rem);
553 *n = (u_int64_t)high << 32 | low;
554 } else {
555 *n = low / div;
556 *rem = low % div;
557 }
558}
559#endif
560
561/*
562 * PCM library
563 */
564
Takashi Iwai877211f2005-11-17 13:59:38 +0100565static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566{
567 return substream->group != &substream->self_group;
568}
569
Takashi Iwai877211f2005-11-17 13:59:38 +0100570static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571{
572 read_lock(&snd_pcm_link_rwlock);
573 spin_lock(&substream->self_group.lock);
574}
575
Takashi Iwai877211f2005-11-17 13:59:38 +0100576static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577{
578 spin_unlock(&substream->self_group.lock);
579 read_unlock(&snd_pcm_link_rwlock);
580}
581
Takashi Iwai877211f2005-11-17 13:59:38 +0100582static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
584 read_lock_irq(&snd_pcm_link_rwlock);
585 spin_lock(&substream->self_group.lock);
586}
587
Takashi Iwai877211f2005-11-17 13:59:38 +0100588static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 spin_unlock(&substream->self_group.lock);
591 read_unlock_irq(&snd_pcm_link_rwlock);
592}
593
594#define snd_pcm_stream_lock_irqsave(substream, flags) \
595do { \
596 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
597 spin_lock(&substream->self_group.lock); \
598} while (0)
599
600#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
601do { \
602 spin_unlock(&substream->self_group.lock); \
603 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
604} while (0)
605
Takashi Iwaief991b92007-02-22 12:52:53 +0100606#define snd_pcm_group_for_each_entry(s, substream) \
607 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Takashi Iwai877211f2005-11-17 13:59:38 +0100609static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
611 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
612 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
613 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
614}
615
Takashi Iwai877211f2005-11-17 13:59:38 +0100616static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
618 return size * 8 / runtime->sample_bits;
619}
620
Takashi Iwai877211f2005-11-17 13:59:38 +0100621static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622{
623 return size * 8 / runtime->frame_bits;
624}
625
Takashi Iwai877211f2005-11-17 13:59:38 +0100626static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
628 return size * runtime->sample_bits / 8;
629}
630
Takashi Iwai877211f2005-11-17 13:59:38 +0100631static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
633 return size * runtime->frame_bits / 8;
634}
635
Takashi Iwai877211f2005-11-17 13:59:38 +0100636static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637{
638 return bytes % runtime->byte_align == 0;
639}
640
Takashi Iwai877211f2005-11-17 13:59:38 +0100641static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642{
Takashi Iwai877211f2005-11-17 13:59:38 +0100643 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 return frames_to_bytes(runtime, runtime->buffer_size);
645}
646
Takashi Iwai877211f2005-11-17 13:59:38 +0100647static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Takashi Iwai877211f2005-11-17 13:59:38 +0100649 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 return frames_to_bytes(runtime, runtime->period_size);
651}
652
653/*
654 * result is: 0 ... (boundary - 1)
655 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100656static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
658 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
659 if (avail < 0)
660 avail += runtime->boundary;
661 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
662 avail -= runtime->boundary;
663 return avail;
664}
665
666/*
667 * result is: 0 ... (boundary - 1)
668 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100669static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670{
671 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
672 if (avail < 0)
673 avail += runtime->boundary;
674 return avail;
675}
676
Takashi Iwai877211f2005-11-17 13:59:38 +0100677static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678{
679 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
680}
681
Takashi Iwai877211f2005-11-17 13:59:38 +0100682static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683{
684 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
685}
686
687/**
688 * snd_pcm_playback_ready - check whether the playback buffer is available
689 * @substream: the pcm substream instance
690 *
691 * Checks whether enough free space is available on the playback buffer.
692 *
693 * Returns non-zero if available, or zero if not.
694 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100695static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
Takashi Iwai877211f2005-11-17 13:59:38 +0100697 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
699}
700
701/**
702 * snd_pcm_capture_ready - check whether the capture buffer is available
703 * @substream: the pcm substream instance
704 *
705 * Checks whether enough capture data is available on the capture buffer.
706 *
707 * Returns non-zero if available, or zero if not.
708 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100709static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710{
Takashi Iwai877211f2005-11-17 13:59:38 +0100711 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
713}
714
715/**
716 * snd_pcm_playback_data - check whether any data exists on the playback buffer
717 * @substream: the pcm substream instance
718 *
719 * Checks whether any data exists on the playback buffer. If stop_threshold
720 * is bigger or equal to boundary, then this function returns always non-zero.
721 *
722 * Returns non-zero if exists, or zero if not.
723 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100724static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
Takashi Iwai877211f2005-11-17 13:59:38 +0100726 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728 if (runtime->stop_threshold >= runtime->boundary)
729 return 1;
730 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
731}
732
733/**
734 * snd_pcm_playback_empty - check whether the playback buffer is empty
735 * @substream: the pcm substream instance
736 *
737 * Checks whether the playback buffer is empty.
738 *
739 * Returns non-zero if empty, or zero if not.
740 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100741static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742{
Takashi Iwai877211f2005-11-17 13:59:38 +0100743 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
745}
746
747/**
748 * snd_pcm_capture_empty - check whether the capture buffer is empty
749 * @substream: the pcm substream instance
750 *
751 * Checks whether the capture buffer is empty.
752 *
753 * Returns non-zero if empty, or zero if not.
754 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100755static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756{
Takashi Iwai877211f2005-11-17 13:59:38 +0100757 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return snd_pcm_capture_avail(runtime) == 0;
759}
760
Takashi Iwai877211f2005-11-17 13:59:38 +0100761static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
762 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763{
764 substream->runtime->trigger_master = master;
765}
766
767static inline int hw_is_mask(int var)
768{
769 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
770 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
771}
772
773static inline int hw_is_interval(int var)
774{
775 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
776 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
777}
778
Takashi Iwai877211f2005-11-17 13:59:38 +0100779static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 snd_pcm_hw_param_t var)
781{
782 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
783}
784
Takashi Iwai877211f2005-11-17 13:59:38 +0100785static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 snd_pcm_hw_param_t var)
787{
788 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
789}
790
Takashi Iwai877211f2005-11-17 13:59:38 +0100791static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 snd_pcm_hw_param_t var)
793{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200794 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795}
796
Takashi Iwai877211f2005-11-17 13:59:38 +0100797static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 snd_pcm_hw_param_t var)
799{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200800 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
802
803#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
804#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
805#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
806#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
807#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
808#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
809#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
810#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
811#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
812#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
813#define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
814
815
Takashi Iwai877211f2005-11-17 13:59:38 +0100816int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
817void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
818void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
819void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
820 unsigned int k, struct snd_interval *c);
821void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
822 const struct snd_interval *b, struct snd_interval *c);
823int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
824int snd_interval_ratnum(struct snd_interval *i,
825 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 unsigned int *nump, unsigned int *denp);
827
Takashi Iwai877211f2005-11-17 13:59:38 +0100828void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
829void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100830int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
Takashi Iwai877211f2005-11-17 13:59:38 +0100832int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833
Takashi Iwai877211f2005-11-17 13:59:38 +0100834int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
835int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836
Takashi Iwai877211f2005-11-17 13:59:38 +0100837int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100839int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100841int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100843int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
844int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 unsigned int cond,
846 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100847 struct snd_pcm_hw_constraint_list *l);
848int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 unsigned int cond,
850 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100851 struct snd_pcm_hw_constraint_ratnums *r);
852int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 unsigned int cond,
854 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100855 struct snd_pcm_hw_constraint_ratdens *r);
856int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 unsigned int cond,
858 unsigned int width,
859 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100860int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 unsigned int cond,
862 snd_pcm_hw_param_t var,
863 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100864int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 unsigned int cond,
866 snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100867int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 unsigned int cond,
869 int var,
870 snd_pcm_hw_rule_func_t func, void *private,
871 int dep, ...);
872
873int snd_pcm_format_signed(snd_pcm_format_t format);
874int snd_pcm_format_unsigned(snd_pcm_format_t format);
875int snd_pcm_format_linear(snd_pcm_format_t format);
876int snd_pcm_format_little_endian(snd_pcm_format_t format);
877int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200878#if 0 /* just for DocBook */
879/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200880 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
881 * @format: the format to check
882 *
883 * Returns 1 if the given PCM format is CPU-endian, 0 if
884 * opposite, or a negative error code if endian not specified.
885 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200886int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200887#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200888#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700889#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200890#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700891#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200892#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
894int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200895ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
897int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
898snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899
Takashi Iwai877211f2005-11-17 13:59:38 +0100900void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
901void snd_pcm_set_sync(struct snd_pcm_substream *substream);
902int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
903int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +0100905int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
906int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
907int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
908int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
909int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
910void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
911void snd_pcm_tick_prepare(struct snd_pcm_substream *substream);
912void snd_pcm_tick_set(struct snd_pcm_substream *substream, unsigned long ticks);
913void snd_pcm_tick_elapsed(struct snd_pcm_substream *substream);
914void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
915snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 const void __user *buf,
917 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100918snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100920snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100922snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 void __user **bufs, snd_pcm_uframes_t frames);
924
Clemens Ladisch7653d552007-08-13 17:38:54 +0200925extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
926
Takashi Iwai877211f2005-11-17 13:59:38 +0100927int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200928unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Takashi Iwai877211f2005-11-17 13:59:38 +0100930static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 struct snd_dma_buffer *bufp)
932{
Takashi Iwai877211f2005-11-17 13:59:38 +0100933 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 if (bufp) {
935 runtime->dma_buffer_p = bufp;
936 runtime->dma_area = bufp->area;
937 runtime->dma_addr = bufp->addr;
938 runtime->dma_bytes = bufp->bytes;
939 } else {
940 runtime->dma_buffer_p = NULL;
941 runtime->dma_area = NULL;
942 runtime->dma_addr = 0;
943 runtime->dma_bytes = 0;
944 }
945}
946
947/*
948 * Timer interface
949 */
950
Takashi Iwai877211f2005-11-17 13:59:38 +0100951void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
952void snd_pcm_timer_init(struct snd_pcm_substream *substream);
953void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
955/*
956 * Memory
957 */
958
Takashi Iwai877211f2005-11-17 13:59:38 +0100959int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
960int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
961int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 int type, struct device *data,
963 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100964int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 int type, void *data,
966 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100967int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
968int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
970#define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
971#define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
972#define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
Takashi Iwai877211f2005-11-17 13:59:38 +0100973struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
975/* handle mmap counter - PCM mmap callback should handle this counter properly */
976static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
977{
Takashi Iwai877211f2005-11-17 13:59:38 +0100978 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200979 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980}
981
982static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
983{
Takashi Iwai877211f2005-11-17 13:59:38 +0100984 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200985 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986}
987
988/* mmap for io-memory area */
989#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
990#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +0100991int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992#else
993#define SNDRV_PCM_INFO_MMAP_IOMEM 0
994#define snd_pcm_lib_mmap_iomem NULL
995#endif
996
997static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
998{
999 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1000}
1001
1002/*
1003 * Misc
1004 */
1005
1006#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1007 (IEC958_AES1_CON_ORIGINAL<<8)|\
1008 (IEC958_AES1_CON_PCM_CODER<<8)|\
1009 (IEC958_AES3_CON_FS_48000<<24))
1010
1011#endif /* __SOUND_PCM_H */