blob: ec006ed8cd59100c6c0710a9ec7cb19061837d24 [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>
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
Takashi Iwai877211f2005-11-17 13:59:38 +010059struct snd_pcm_ops {
60 int (*open)(struct snd_pcm_substream *substream);
61 int (*close)(struct snd_pcm_substream *substream);
62 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010064 int (*hw_params)(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params *params);
66 int (*hw_free)(struct snd_pcm_substream *substream);
67 int (*prepare)(struct snd_pcm_substream *substream);
68 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
69 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
70 int (*copy)(struct snd_pcm_substream *substream, int channel,
71 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010073 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010075 struct page *(*page)(struct snd_pcm_substream *substream,
76 unsigned long offset);
77 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
78 int (*ack)(struct snd_pcm_substream *substream);
79};
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/*
82 *
83 */
84
85#define SNDRV_PCM_DEVICES 8
86
87#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
88#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
89
90#define SNDRV_PCM_IOCTL1_RESET 0
91#define SNDRV_PCM_IOCTL1_INFO 1
92#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
93#define SNDRV_PCM_IOCTL1_GSTATE 3
94
95#define SNDRV_PCM_TRIGGER_STOP 0
96#define SNDRV_PCM_TRIGGER_START 1
97#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
98#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
99#define SNDRV_PCM_TRIGGER_SUSPEND 5
100#define SNDRV_PCM_TRIGGER_RESUME 6
101
102#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
103
104/* If you change this don't forget to change rates[] table in pcm_native.c */
105#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
106#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
107#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
108#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
109#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
110#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
111#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
112#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
113#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
114#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
115#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
116#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
117#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
118
119#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
120#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
121
122#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
123 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
124 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
125#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
126#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
127 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
128#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
129 SNDRV_PCM_RATE_192000)
130#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
131#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
132#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
133#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
134#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
135#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
136#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
137#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
138#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
139#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
140#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
141#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
142#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
143#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
144#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
145#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
146#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
147#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
148#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
149#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
150#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
151#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
152#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
153#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
154#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
155#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
156#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
157#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
158#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
159#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
160#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
161#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
162#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
163#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
164#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
165#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
166#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
167#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
168
169#ifdef SNDRV_LITTLE_ENDIAN
170#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
171#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
172#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
173#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
174#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
175#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
176#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
177#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
178#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
179#endif
180#ifdef SNDRV_BIG_ENDIAN
181#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
182#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
183#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
184#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
185#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
186#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
187#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
188#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
189#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
190#endif
191
Takashi Iwai877211f2005-11-17 13:59:38 +0100192struct snd_pcm_file {
193 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200194 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195};
196
Takashi Iwai877211f2005-11-17 13:59:38 +0100197struct snd_pcm_hw_rule;
198typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
199 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwai877211f2005-11-17 13:59:38 +0100201struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 unsigned int cond;
203 snd_pcm_hw_rule_func_t func;
204 int var;
205 int deps[4];
206 void *private;
207};
208
Takashi Iwai877211f2005-11-17 13:59:38 +0100209struct snd_pcm_hw_constraints {
210 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100212 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
214 unsigned int rules_num;
215 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100216 struct snd_pcm_hw_rule *rules;
217};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Takashi Iwai877211f2005-11-17 13:59:38 +0100219static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
220 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221{
222 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
223}
224
Takashi Iwai877211f2005-11-17 13:59:38 +0100225static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
226 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
228 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
229}
230
Takashi Iwai877211f2005-11-17 13:59:38 +0100231struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 unsigned int num;
233 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100234};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Takashi Iwai877211f2005-11-17 13:59:38 +0100236struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 unsigned int num_min, num_max, num_step;
238 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100239};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240
Takashi Iwai877211f2005-11-17 13:59:38 +0100241struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100243 struct snd_ratnum *rats;
244};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Takashi Iwai877211f2005-11-17 13:59:38 +0100246struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100248 struct snd_ratden *rats;
249};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Takashi Iwai877211f2005-11-17 13:59:38 +0100251struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 unsigned int count;
253 unsigned int *list;
254 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100255};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Takashi Iwai877211f2005-11-17 13:59:38 +0100257struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100259 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200260 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 int overrange;
262 snd_pcm_uframes_t avail_max;
263 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
264 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
265
266 /* -- HW params -- */
267 snd_pcm_access_t access; /* access mode */
268 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
269 snd_pcm_subformat_t subformat; /* subformat */
270 unsigned int rate; /* rate in Hz */
271 unsigned int channels; /* channels */
272 snd_pcm_uframes_t period_size; /* period size */
273 unsigned int periods; /* periods */
274 snd_pcm_uframes_t buffer_size; /* buffer size */
275 unsigned int tick_time; /* tick time */
276 snd_pcm_uframes_t min_align; /* Min alignment for the format */
277 size_t byte_align;
278 unsigned int frame_bits;
279 unsigned int sample_bits;
280 unsigned int info;
281 unsigned int rate_num;
282 unsigned int rate_den;
283
284 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100285 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 unsigned int period_step;
287 unsigned int sleep_min; /* min ticks to sleep */
288 snd_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
289 snd_pcm_uframes_t start_threshold;
290 snd_pcm_uframes_t stop_threshold;
291 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
292 noise is nearest than this */
293 snd_pcm_uframes_t silence_size; /* Silence filling size */
294 snd_pcm_uframes_t boundary; /* pointers wrap point */
295
296 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
297 snd_pcm_uframes_t silence_filled; /* size filled with silence */
298
Takashi Iwai877211f2005-11-17 13:59:38 +0100299 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301 /* -- mmap -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100302 volatile struct snd_pcm_mmap_status *status;
303 volatile struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
305 /* -- locking / scheduling -- */
306 wait_queue_head_t sleep;
307 struct timer_list tick_timer;
308 struct fasync_struct *fasync;
309
310 /* -- private section -- */
311 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100312 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100315 struct snd_pcm_hardware hw;
316 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100319 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
320 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 /* -- timer -- */
323 unsigned int timer_resolution; /* timer resolution */
324
325 /* -- DMA -- */
326 unsigned char *dma_area; /* DMA area */
327 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
328 size_t dma_bytes; /* size of DMA area */
329
330 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
331
332#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
333 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100334 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335#endif
336};
337
Takashi Iwai877211f2005-11-17 13:59:38 +0100338struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 spinlock_t lock;
340 struct list_head substreams;
341 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100342};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Takashi Iwai877211f2005-11-17 13:59:38 +0100344struct snd_pcm_substream {
345 struct snd_pcm *pcm;
346 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 void *private_data; /* copied from pcm->private_data */
348 int number;
349 char name[32]; /* substream name */
350 int stream; /* stream (direction) */
Takashi Iwai9442e692006-09-30 23:27:19 -0700351 char latency_id[20]; /* latency identifier */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 size_t buffer_bytes_max; /* limit ring buffer size */
353 struct snd_dma_buffer dma_buffer;
354 unsigned int dma_buf_id;
355 size_t dma_max;
356 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100357 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100359 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100361 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 unsigned timer_running: 1; /* time is running */
363 spinlock_t timer_lock;
364 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100365 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 /* -- linked substreams -- */
367 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100368 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
369 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200371 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200372 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200373 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200374 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200375 void (*pcm_release)(struct snd_pcm_substream *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
377 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100378 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200380#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100381 struct snd_info_entry *proc_root;
382 struct snd_info_entry *proc_info_entry;
383 struct snd_info_entry *proc_hw_params_entry;
384 struct snd_info_entry *proc_sw_params_entry;
385 struct snd_info_entry *proc_status_entry;
386 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200387 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200388#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200390 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391};
392
Takashi Iwai0df63e42006-04-28 15:13:41 +0200393#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394
395
Takashi Iwai877211f2005-11-17 13:59:38 +0100396struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100398 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /* -- substreams -- */
400 unsigned int substream_count;
401 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100402 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
404 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100405 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200407#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100408 struct snd_info_entry *proc_root;
409 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200410#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100412 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200414#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415};
416
Takashi Iwai877211f2005-11-17 13:59:38 +0100417struct snd_pcm {
418 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100419 struct list_head list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 unsigned int device; /* device number */
421 unsigned int info_flags;
422 unsigned short dev_class;
423 unsigned short dev_subclass;
424 char id[64];
425 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100426 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100427 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 wait_queue_head_t open_wait;
429 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100430 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200431 struct device *dev; /* actual hw device this belongs to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100433 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434#endif
435};
436
Takashi Iwai877211f2005-11-17 13:59:38 +0100437struct snd_pcm_notify {
438 int (*n_register) (struct snd_pcm * pcm);
439 int (*n_disconnect) (struct snd_pcm * pcm);
440 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100442};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
444/*
445 * Registering
446 */
447
Clemens Ladisch2af677f2005-11-20 14:03:48 +0100448extern struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Takashi Iwai877211f2005-11-17 13:59:38 +0100450int snd_pcm_new(struct snd_card *card, char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100452 struct snd_pcm **rpcm);
453int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Takashi Iwai877211f2005-11-17 13:59:38 +0100455int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456
457/*
458 * Native I/O
459 */
460
461extern rwlock_t snd_pcm_link_rwlock;
462
Takashi Iwai877211f2005-11-17 13:59:38 +0100463int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
464int snd_pcm_info_user(struct snd_pcm_substream *substream,
465 struct snd_pcm_info __user *info);
466int snd_pcm_status(struct snd_pcm_substream *substream,
467 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100468int snd_pcm_start(struct snd_pcm_substream *substream);
469int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
470int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100472int snd_pcm_suspend(struct snd_pcm_substream *substream);
473int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100475int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200476int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
477 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100478void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200479int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
480 struct snd_pcm_substream **rsubstream);
481void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100483int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484
485#if BITS_PER_LONG >= 64
486
487static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
488{
489 *rem = *n % div;
490 *n /= div;
491}
492
493#elif defined(i386)
494
495static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
496{
497 u_int32_t low, high;
498 low = *n & 0xffffffff;
499 high = *n >> 32;
500 if (high) {
501 u_int32_t high1 = high % div;
502 high /= div;
503 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
504 *n = (u_int64_t)high << 32 | low;
505 } else {
506 *n = low / div;
507 *rem = low % div;
508 }
509}
510#else
511
512static inline void divl(u_int32_t high, u_int32_t low,
513 u_int32_t div,
514 u_int32_t *q, u_int32_t *r)
515{
516 u_int64_t n = (u_int64_t)high << 32 | low;
517 u_int64_t d = (u_int64_t)div << 31;
518 u_int32_t q1 = 0;
519 int c = 32;
520 while (n > 0xffffffffU) {
521 q1 <<= 1;
522 if (n >= d) {
523 n -= d;
524 q1 |= 1;
525 }
526 d >>= 1;
527 c--;
528 }
529 q1 <<= c;
530 if (n) {
531 low = n;
532 *q = q1 | (low / div);
533 *r = low % div;
534 } else {
535 *r = 0;
536 *q = q1;
537 }
538 return;
539}
540
541static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
542{
543 u_int32_t low, high;
544 low = *n & 0xffffffff;
545 high = *n >> 32;
546 if (high) {
547 u_int32_t high1 = high % div;
548 u_int32_t low1 = low;
549 high /= div;
550 divl(high1, low1, div, &low, rem);
551 *n = (u_int64_t)high << 32 | low;
552 } else {
553 *n = low / div;
554 *rem = low % div;
555 }
556}
557#endif
558
559/*
560 * PCM library
561 */
562
Takashi Iwai877211f2005-11-17 13:59:38 +0100563static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
565 return substream->group != &substream->self_group;
566}
567
Takashi Iwai877211f2005-11-17 13:59:38 +0100568static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
570 read_lock(&snd_pcm_link_rwlock);
571 spin_lock(&substream->self_group.lock);
572}
573
Takashi Iwai877211f2005-11-17 13:59:38 +0100574static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 spin_unlock(&substream->self_group.lock);
577 read_unlock(&snd_pcm_link_rwlock);
578}
579
Takashi Iwai877211f2005-11-17 13:59:38 +0100580static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
582 read_lock_irq(&snd_pcm_link_rwlock);
583 spin_lock(&substream->self_group.lock);
584}
585
Takashi Iwai877211f2005-11-17 13:59:38 +0100586static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
588 spin_unlock(&substream->self_group.lock);
589 read_unlock_irq(&snd_pcm_link_rwlock);
590}
591
592#define snd_pcm_stream_lock_irqsave(substream, flags) \
593do { \
594 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
595 spin_lock(&substream->self_group.lock); \
596} while (0)
597
598#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
599do { \
600 spin_unlock(&substream->self_group.lock); \
601 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
602} while (0)
603
604#define snd_pcm_group_for_each(pos, substream) \
605 list_for_each(pos, &substream->group->substreams)
606
607#define snd_pcm_group_substream_entry(pos) \
Takashi Iwai877211f2005-11-17 13:59:38 +0100608 list_entry(pos, struct snd_pcm_substream, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
Takashi Iwai877211f2005-11-17 13:59:38 +0100610static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
613 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
614 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
615}
616
Takashi Iwai877211f2005-11-17 13:59:38 +0100617static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
619 return size * 8 / runtime->sample_bits;
620}
621
Takashi Iwai877211f2005-11-17 13:59:38 +0100622static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623{
624 return size * 8 / runtime->frame_bits;
625}
626
Takashi Iwai877211f2005-11-17 13:59:38 +0100627static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 return size * runtime->sample_bits / 8;
630}
631
Takashi Iwai877211f2005-11-17 13:59:38 +0100632static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 return size * runtime->frame_bits / 8;
635}
636
Takashi Iwai877211f2005-11-17 13:59:38 +0100637static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
639 return bytes % runtime->byte_align == 0;
640}
641
Takashi Iwai877211f2005-11-17 13:59:38 +0100642static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
Takashi Iwai877211f2005-11-17 13:59:38 +0100644 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return frames_to_bytes(runtime, runtime->buffer_size);
646}
647
Takashi Iwai877211f2005-11-17 13:59:38 +0100648static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
Takashi Iwai877211f2005-11-17 13:59:38 +0100650 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 return frames_to_bytes(runtime, runtime->period_size);
652}
653
654/*
655 * result is: 0 ... (boundary - 1)
656 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100657static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
659 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
660 if (avail < 0)
661 avail += runtime->boundary;
662 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
663 avail -= runtime->boundary;
664 return avail;
665}
666
667/*
668 * result is: 0 ... (boundary - 1)
669 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100670static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
672 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
673 if (avail < 0)
674 avail += runtime->boundary;
675 return avail;
676}
677
Takashi Iwai877211f2005-11-17 13:59:38 +0100678static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679{
680 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
681}
682
Takashi Iwai877211f2005-11-17 13:59:38 +0100683static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684{
685 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
686}
687
688/**
689 * snd_pcm_playback_ready - check whether the playback buffer is available
690 * @substream: the pcm substream instance
691 *
692 * Checks whether enough free space is available on the playback buffer.
693 *
694 * Returns non-zero if available, or zero if not.
695 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100696static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697{
Takashi Iwai877211f2005-11-17 13:59:38 +0100698 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
700}
701
702/**
703 * snd_pcm_capture_ready - check whether the capture buffer is available
704 * @substream: the pcm substream instance
705 *
706 * Checks whether enough capture data is available on the capture buffer.
707 *
708 * Returns non-zero if available, or zero if not.
709 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100710static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711{
Takashi Iwai877211f2005-11-17 13:59:38 +0100712 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
714}
715
716/**
717 * snd_pcm_playback_data - check whether any data exists on the playback buffer
718 * @substream: the pcm substream instance
719 *
720 * Checks whether any data exists on the playback buffer. If stop_threshold
721 * is bigger or equal to boundary, then this function returns always non-zero.
722 *
723 * Returns non-zero if exists, or zero if not.
724 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100725static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
Takashi Iwai877211f2005-11-17 13:59:38 +0100727 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 if (runtime->stop_threshold >= runtime->boundary)
730 return 1;
731 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
732}
733
734/**
735 * snd_pcm_playback_empty - check whether the playback buffer is empty
736 * @substream: the pcm substream instance
737 *
738 * Checks whether the playback buffer is empty.
739 *
740 * Returns non-zero if empty, or zero if not.
741 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100742static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
Takashi Iwai877211f2005-11-17 13:59:38 +0100744 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
746}
747
748/**
749 * snd_pcm_capture_empty - check whether the capture buffer is empty
750 * @substream: the pcm substream instance
751 *
752 * Checks whether the capture buffer is empty.
753 *
754 * Returns non-zero if empty, or zero if not.
755 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100756static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757{
Takashi Iwai877211f2005-11-17 13:59:38 +0100758 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 return snd_pcm_capture_avail(runtime) == 0;
760}
761
Takashi Iwai877211f2005-11-17 13:59:38 +0100762static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
763 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764{
765 substream->runtime->trigger_master = master;
766}
767
768static inline int hw_is_mask(int var)
769{
770 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
771 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
772}
773
774static inline int hw_is_interval(int var)
775{
776 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
777 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
778}
779
Takashi Iwai877211f2005-11-17 13:59:38 +0100780static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 snd_pcm_hw_param_t var)
782{
783 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
784}
785
Takashi Iwai877211f2005-11-17 13:59:38 +0100786static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 snd_pcm_hw_param_t var)
788{
789 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
790}
791
Takashi Iwai877211f2005-11-17 13:59:38 +0100792static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 snd_pcm_hw_param_t var)
794{
Takashi Iwai877211f2005-11-17 13:59:38 +0100795 return (const struct snd_mask *)hw_param_mask((struct snd_pcm_hw_params*) params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
797
Takashi Iwai877211f2005-11-17 13:59:38 +0100798static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 snd_pcm_hw_param_t var)
800{
Takashi Iwai877211f2005-11-17 13:59:38 +0100801 return (const struct snd_interval *)hw_param_interval((struct snd_pcm_hw_params*) params, var);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802}
803
804#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
805#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
806#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
807#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
808#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
809#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
810#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
811#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
812#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
813#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
814#define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
815
816
Takashi Iwai877211f2005-11-17 13:59:38 +0100817int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
818void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
819void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
820void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
821 unsigned int k, struct snd_interval *c);
822void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
823 const struct snd_interval *b, struct snd_interval *c);
824int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
825int snd_interval_ratnum(struct snd_interval *i,
826 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 unsigned int *nump, unsigned int *denp);
828
Takashi Iwai877211f2005-11-17 13:59:38 +0100829void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
830void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100831int snd_pcm_hw_params_choose(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_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Takashi Iwai877211f2005-11-17 13:59:38 +0100835int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
836int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Takashi Iwai877211f2005-11-17 13:59:38 +0100838int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100840int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100842int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100844int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
845int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 unsigned int cond,
847 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100848 struct snd_pcm_hw_constraint_list *l);
849int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 unsigned int cond,
851 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100852 struct snd_pcm_hw_constraint_ratnums *r);
853int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 unsigned int cond,
855 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100856 struct snd_pcm_hw_constraint_ratdens *r);
857int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 unsigned int cond,
859 unsigned int width,
860 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100861int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 unsigned int cond,
863 snd_pcm_hw_param_t var,
864 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100865int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 unsigned int cond,
867 snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100868int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 unsigned int cond,
870 int var,
871 snd_pcm_hw_rule_func_t func, void *private,
872 int dep, ...);
873
874int snd_pcm_format_signed(snd_pcm_format_t format);
875int snd_pcm_format_unsigned(snd_pcm_format_t format);
876int snd_pcm_format_linear(snd_pcm_format_t format);
877int snd_pcm_format_little_endian(snd_pcm_format_t format);
878int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200879#if 0 /* just for DocBook */
880/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200881 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
882 * @format: the format to check
883 *
884 * Returns 1 if the given PCM format is CPU-endian, 0 if
885 * opposite, or a negative error code if endian not specified.
886 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200887int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200888#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200889#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700890#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200891#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700892#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200893#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
895int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200896ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
898int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
899snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900
Takashi Iwai877211f2005-11-17 13:59:38 +0100901void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
902void snd_pcm_set_sync(struct snd_pcm_substream *substream);
903int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
904int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +0100906int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
907int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
908int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
909int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
910int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
911void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
912void snd_pcm_tick_prepare(struct snd_pcm_substream *substream);
913void snd_pcm_tick_set(struct snd_pcm_substream *substream, unsigned long ticks);
914void snd_pcm_tick_elapsed(struct snd_pcm_substream *substream);
915void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
916snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 const void __user *buf,
918 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100919snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100921snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100923snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 void __user **bufs, snd_pcm_uframes_t frames);
925
Takashi Iwai877211f2005-11-17 13:59:38 +0100926int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Takashi Iwai877211f2005-11-17 13:59:38 +0100928static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 struct snd_dma_buffer *bufp)
930{
Takashi Iwai877211f2005-11-17 13:59:38 +0100931 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 if (bufp) {
933 runtime->dma_buffer_p = bufp;
934 runtime->dma_area = bufp->area;
935 runtime->dma_addr = bufp->addr;
936 runtime->dma_bytes = bufp->bytes;
937 } else {
938 runtime->dma_buffer_p = NULL;
939 runtime->dma_area = NULL;
940 runtime->dma_addr = 0;
941 runtime->dma_bytes = 0;
942 }
943}
944
945/*
946 * Timer interface
947 */
948
Takashi Iwai877211f2005-11-17 13:59:38 +0100949void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
950void snd_pcm_timer_init(struct snd_pcm_substream *substream);
951void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953/*
954 * Memory
955 */
956
Takashi Iwai877211f2005-11-17 13:59:38 +0100957int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
958int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
959int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 int type, struct device *data,
961 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100962int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 int type, void *data,
964 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100965int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
966int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
968#define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
969#define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
970#define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
Takashi Iwai877211f2005-11-17 13:59:38 +0100971struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
973/* handle mmap counter - PCM mmap callback should handle this counter properly */
974static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
975{
Takashi Iwai877211f2005-11-17 13:59:38 +0100976 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200977 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978}
979
980static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
981{
Takashi Iwai877211f2005-11-17 13:59:38 +0100982 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200983 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984}
985
986/* mmap for io-memory area */
987#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
988#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +0100989int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990#else
991#define SNDRV_PCM_INFO_MMAP_IOMEM 0
992#define snd_pcm_lib_mmap_iomem NULL
993#endif
994
995static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
996{
997 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
998}
999
1000/*
1001 * Misc
1002 */
1003
1004#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1005 (IEC958_AES1_CON_ORIGINAL<<8)|\
1006 (IEC958_AES1_CON_PCM_CODER<<8)|\
1007 (IEC958_AES3_CON_FS_48000<<24))
1008
1009#endif /* __SOUND_PCM_H */