blob: c172968916170b3e3c4e42aa1793b729f21e3670 [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>
Pawel MOLLf90c06a2008-07-30 12:46:40 +010028#include <sound/minors.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/poll.h>
Al Virof23f6e02006-10-20 15:17:02 -040030#include <linux/mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/bitops.h>
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#define snd_pcm_substream_chip(substream) ((substream)->private_data)
34#define snd_pcm_chip(pcm) ((pcm)->private_data)
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
37#include "pcm_oss.h"
38#endif
39
40/*
41 * Hardware (lowlevel) section
42 */
43
Takashi Iwai877211f2005-11-17 13:59:38 +010044struct snd_pcm_hardware {
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 unsigned int info; /* SNDRV_PCM_INFO_* */
46 u64 formats; /* SNDRV_PCM_FMTBIT_* */
47 unsigned int rates; /* SNDRV_PCM_RATE_* */
48 unsigned int rate_min; /* min rate */
49 unsigned int rate_max; /* max rate */
50 unsigned int channels_min; /* min channels */
51 unsigned int channels_max; /* max channels */
52 size_t buffer_bytes_max; /* max buffer size */
53 size_t period_bytes_min; /* min period size */
54 size_t period_bytes_max; /* max period size */
55 unsigned int periods_min; /* min # of periods */
56 unsigned int periods_max; /* max # of periods */
57 size_t fifo_size; /* fifo size in bytes */
Takashi Iwai877211f2005-11-17 13:59:38 +010058};
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Randy Dunlape0e6ce02006-12-07 08:22:50 +010060struct snd_pcm_substream;
61
Takashi Iwai877211f2005-11-17 13:59:38 +010062struct snd_pcm_ops {
63 int (*open)(struct snd_pcm_substream *substream);
64 int (*close)(struct snd_pcm_substream *substream);
65 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010067 int (*hw_params)(struct snd_pcm_substream *substream,
68 struct snd_pcm_hw_params *params);
69 int (*hw_free)(struct snd_pcm_substream *substream);
70 int (*prepare)(struct snd_pcm_substream *substream);
71 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
72 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
73 int (*copy)(struct snd_pcm_substream *substream, int channel,
74 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010076 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010078 struct page *(*page)(struct snd_pcm_substream *substream,
79 unsigned long offset);
80 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
81 int (*ack)(struct snd_pcm_substream *substream);
82};
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84/*
85 *
86 */
87
Pawel MOLLf90c06a2008-07-30 12:46:40 +010088#if defined(CONFIG_SND_DYNAMIC_MINORS)
89#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
90#else
91#define SNDRV_PCM_DEVICES 8
92#endif
Jaroslav Kysela896e6cc2008-08-01 13:36:04 +020093
Linus Torvalds1da177e2005-04-16 15:20:36 -070094#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
95#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
96
97#define SNDRV_PCM_IOCTL1_RESET 0
98#define SNDRV_PCM_IOCTL1_INFO 1
99#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
100#define SNDRV_PCM_IOCTL1_GSTATE 3
101
102#define SNDRV_PCM_TRIGGER_STOP 0
103#define SNDRV_PCM_TRIGGER_START 1
104#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
105#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
106#define SNDRV_PCM_TRIGGER_SUSPEND 5
107#define SNDRV_PCM_TRIGGER_RESUME 6
108
109#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
110
111/* If you change this don't forget to change rates[] table in pcm_native.c */
112#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
113#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
114#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
115#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
116#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
117#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
118#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
119#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
120#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
121#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
122#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
123#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
124#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
125
126#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
127#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
128
129#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
130 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
131 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
132#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
133#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
134 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
135#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
136 SNDRV_PCM_RATE_192000)
137#define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
138#define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
139#define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
140#define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
141#define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
142#define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
143#define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
144#define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
145#define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
146#define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
147#define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
148#define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
149#define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
150#define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
151#define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
152#define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
153#define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
154#define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
155#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
156#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
157#define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
158#define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
159#define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
160#define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
161#define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
162#define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
163#define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
164#define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
165#define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
166#define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
167#define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
168#define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
169#define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
170#define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
171#define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
172#define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
173#define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
174#define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
175
176#ifdef SNDRV_LITTLE_ENDIAN
177#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
178#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
179#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
180#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
181#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
182#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
183#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
184#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
185#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
186#endif
187#ifdef SNDRV_BIG_ENDIAN
188#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
189#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
190#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
191#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
192#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
193#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
194#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
195#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
196#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
197#endif
198
Takashi Iwai877211f2005-11-17 13:59:38 +0100199struct snd_pcm_file {
200 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200201 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202};
203
Takashi Iwai877211f2005-11-17 13:59:38 +0100204struct snd_pcm_hw_rule;
205typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
206 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
Takashi Iwai877211f2005-11-17 13:59:38 +0100208struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 unsigned int cond;
210 snd_pcm_hw_rule_func_t func;
211 int var;
212 int deps[4];
213 void *private;
214};
215
Takashi Iwai877211f2005-11-17 13:59:38 +0100216struct snd_pcm_hw_constraints {
217 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100219 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
221 unsigned int rules_num;
222 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100223 struct snd_pcm_hw_rule *rules;
224};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Takashi Iwai877211f2005-11-17 13:59:38 +0100226static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
227 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
229 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
230}
231
Takashi Iwai877211f2005-11-17 13:59:38 +0100232static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
233 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234{
235 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
236}
237
Takashi Iwai877211f2005-11-17 13:59:38 +0100238struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 unsigned int num;
240 unsigned int den_min, den_max, den_step;
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_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 unsigned int num_min, num_max, num_step;
245 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100246};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Takashi Iwai877211f2005-11-17 13:59:38 +0100248struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100250 struct snd_ratnum *rats;
251};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252
Takashi Iwai877211f2005-11-17 13:59:38 +0100253struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100255 struct snd_ratden *rats;
256};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Takashi Iwai877211f2005-11-17 13:59:38 +0100258struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 unsigned int count;
260 unsigned int *list;
261 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100262};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Takashi Iwai877211f2005-11-17 13:59:38 +0100264struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100266 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200267 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 int overrange;
269 snd_pcm_uframes_t avail_max;
270 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200271 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
272 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
274 /* -- HW params -- */
275 snd_pcm_access_t access; /* access mode */
276 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
277 snd_pcm_subformat_t subformat; /* subformat */
278 unsigned int rate; /* rate in Hz */
279 unsigned int channels; /* channels */
280 snd_pcm_uframes_t period_size; /* period size */
281 unsigned int periods; /* periods */
282 snd_pcm_uframes_t buffer_size; /* buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 snd_pcm_uframes_t min_align; /* Min alignment for the format */
284 size_t byte_align;
285 unsigned int frame_bits;
286 unsigned int sample_bits;
287 unsigned int info;
288 unsigned int rate_num;
289 unsigned int rate_den;
290
291 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100292 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 unsigned int period_step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 snd_pcm_uframes_t start_threshold;
295 snd_pcm_uframes_t stop_threshold;
296 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
297 noise is nearest than this */
298 snd_pcm_uframes_t silence_size; /* Silence filling size */
299 snd_pcm_uframes_t boundary; /* pointers wrap point */
300
301 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
302 snd_pcm_uframes_t silence_filled; /* size filled with silence */
303
Takashi Iwai877211f2005-11-17 13:59:38 +0100304 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305
306 /* -- mmap -- */
Takashi Iwai503fc852007-09-11 00:35:06 +0200307 struct snd_pcm_mmap_status *status;
308 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
310 /* -- locking / scheduling -- */
311 wait_queue_head_t sleep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 struct fasync_struct *fasync;
313
314 /* -- private section -- */
315 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100316 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100319 struct snd_pcm_hardware hw;
320 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100323 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
324 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 /* -- timer -- */
327 unsigned int timer_resolution; /* timer resolution */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100328 int tstamp_type; /* timestamp type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 /* -- DMA -- */
331 unsigned char *dma_area; /* DMA area */
332 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
333 size_t dma_bytes; /* size of DMA area */
334
335 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
336
337#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
338 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100339 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340#endif
341};
342
Takashi Iwai877211f2005-11-17 13:59:38 +0100343struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 spinlock_t lock;
345 struct list_head substreams;
346 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100347};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Takashi Iwai877211f2005-11-17 13:59:38 +0100349struct snd_pcm_substream {
350 struct snd_pcm *pcm;
351 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 void *private_data; /* copied from pcm->private_data */
353 int number;
354 char name[32]; /* substream name */
355 int stream; /* stream (direction) */
Takashi Iwai9442e692006-09-30 23:27:19 -0700356 char latency_id[20]; /* latency identifier */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 size_t buffer_bytes_max; /* limit ring buffer size */
358 struct snd_dma_buffer dma_buffer;
359 unsigned int dma_buf_id;
360 size_t dma_max;
361 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100362 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100364 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100366 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 unsigned timer_running: 1; /* time is running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100369 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 /* -- linked substreams -- */
371 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100372 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
373 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200375 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200376 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200377 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200378 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200379 void (*pcm_release)(struct snd_pcm_substream *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
381 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100382 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200384#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100385 struct snd_info_entry *proc_root;
386 struct snd_info_entry *proc_info_entry;
387 struct snd_info_entry *proc_hw_params_entry;
388 struct snd_info_entry *proc_sw_params_entry;
389 struct snd_info_entry *proc_status_entry;
390 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200391 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200392#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200394 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395};
396
Takashi Iwai0df63e42006-04-28 15:13:41 +0200397#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399
Takashi Iwai877211f2005-11-17 13:59:38 +0100400struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100402 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 /* -- substreams -- */
404 unsigned int substream_count;
405 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100406 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
408 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100409 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200411#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100412 struct snd_info_entry *proc_root;
413 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200414#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100416 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200418#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419};
420
Takashi Iwai877211f2005-11-17 13:59:38 +0100421struct snd_pcm {
422 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100423 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100424 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 unsigned int info_flags;
426 unsigned short dev_class;
427 unsigned short dev_subclass;
428 char id[64];
429 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100430 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100431 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 wait_queue_head_t open_wait;
433 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100434 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200435 struct device *dev; /* actual hw device this belongs to */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100437 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438#endif
439};
440
Takashi Iwai877211f2005-11-17 13:59:38 +0100441struct snd_pcm_notify {
442 int (*n_register) (struct snd_pcm * pcm);
443 int (*n_disconnect) (struct snd_pcm * pcm);
444 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100446};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448/*
449 * Registering
450 */
451
Arjan van de Ven54047322007-02-12 00:55:28 -0800452extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Tim Blechmanne6161652009-02-05 13:01:54 +0100454int snd_pcm_new(struct snd_card *card, const char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100456 struct snd_pcm **rpcm);
457int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Takashi Iwai877211f2005-11-17 13:59:38 +0100459int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460
461/*
462 * Native I/O
463 */
464
465extern rwlock_t snd_pcm_link_rwlock;
466
Takashi Iwai877211f2005-11-17 13:59:38 +0100467int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
468int snd_pcm_info_user(struct snd_pcm_substream *substream,
469 struct snd_pcm_info __user *info);
470int snd_pcm_status(struct snd_pcm_substream *substream,
471 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100472int snd_pcm_start(struct snd_pcm_substream *substream);
473int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
474int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100476int snd_pcm_suspend(struct snd_pcm_substream *substream);
477int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100479int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200480int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
481 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100482void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200483int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
484 struct snd_pcm_substream **rsubstream);
485void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100487int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
489#if BITS_PER_LONG >= 64
490
491static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
492{
493 *rem = *n % div;
494 *n /= div;
495}
496
497#elif defined(i386)
498
499static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
500{
501 u_int32_t low, high;
502 low = *n & 0xffffffff;
503 high = *n >> 32;
504 if (high) {
505 u_int32_t high1 = high % div;
506 high /= div;
507 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
508 *n = (u_int64_t)high << 32 | low;
509 } else {
510 *n = low / div;
511 *rem = low % div;
512 }
513}
514#else
515
516static inline void divl(u_int32_t high, u_int32_t low,
517 u_int32_t div,
518 u_int32_t *q, u_int32_t *r)
519{
520 u_int64_t n = (u_int64_t)high << 32 | low;
521 u_int64_t d = (u_int64_t)div << 31;
522 u_int32_t q1 = 0;
523 int c = 32;
524 while (n > 0xffffffffU) {
525 q1 <<= 1;
526 if (n >= d) {
527 n -= d;
528 q1 |= 1;
529 }
530 d >>= 1;
531 c--;
532 }
533 q1 <<= c;
534 if (n) {
535 low = n;
536 *q = q1 | (low / div);
537 *r = low % div;
538 } else {
539 *r = 0;
540 *q = q1;
541 }
542 return;
543}
544
545static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
546{
547 u_int32_t low, high;
548 low = *n & 0xffffffff;
549 high = *n >> 32;
550 if (high) {
551 u_int32_t high1 = high % div;
552 u_int32_t low1 = low;
553 high /= div;
554 divl(high1, low1, div, &low, rem);
555 *n = (u_int64_t)high << 32 | low;
556 } else {
557 *n = low / div;
558 *rem = low % div;
559 }
560}
561#endif
562
563/*
564 * PCM library
565 */
566
Takashi Iwai877211f2005-11-17 13:59:38 +0100567static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568{
569 return substream->group != &substream->self_group;
570}
571
Takashi Iwai877211f2005-11-17 13:59:38 +0100572static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
574 read_lock(&snd_pcm_link_rwlock);
575 spin_lock(&substream->self_group.lock);
576}
577
Takashi Iwai877211f2005-11-17 13:59:38 +0100578static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
580 spin_unlock(&substream->self_group.lock);
581 read_unlock(&snd_pcm_link_rwlock);
582}
583
Takashi Iwai877211f2005-11-17 13:59:38 +0100584static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
586 read_lock_irq(&snd_pcm_link_rwlock);
587 spin_lock(&substream->self_group.lock);
588}
589
Takashi Iwai877211f2005-11-17 13:59:38 +0100590static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591{
592 spin_unlock(&substream->self_group.lock);
593 read_unlock_irq(&snd_pcm_link_rwlock);
594}
595
596#define snd_pcm_stream_lock_irqsave(substream, flags) \
597do { \
598 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
599 spin_lock(&substream->self_group.lock); \
600} while (0)
601
602#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
603do { \
604 spin_unlock(&substream->self_group.lock); \
605 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
606} while (0)
607
Takashi Iwaief991b92007-02-22 12:52:53 +0100608#define snd_pcm_group_for_each_entry(s, substream) \
609 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Takashi Iwai877211f2005-11-17 13:59:38 +0100611static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
613 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
614 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
615 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
616}
617
Takashi Iwai877211f2005-11-17 13:59:38 +0100618static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
620 return size * 8 / runtime->sample_bits;
621}
622
Takashi Iwai877211f2005-11-17 13:59:38 +0100623static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624{
625 return size * 8 / runtime->frame_bits;
626}
627
Takashi Iwai877211f2005-11-17 13:59:38 +0100628static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
630 return size * runtime->sample_bits / 8;
631}
632
Takashi Iwai877211f2005-11-17 13:59:38 +0100633static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
635 return size * runtime->frame_bits / 8;
636}
637
Takashi Iwai877211f2005-11-17 13:59:38 +0100638static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639{
640 return bytes % runtime->byte_align == 0;
641}
642
Takashi Iwai877211f2005-11-17 13:59:38 +0100643static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
Takashi Iwai877211f2005-11-17 13:59:38 +0100645 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646 return frames_to_bytes(runtime, runtime->buffer_size);
647}
648
Takashi Iwai877211f2005-11-17 13:59:38 +0100649static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Takashi Iwai877211f2005-11-17 13:59:38 +0100651 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 return frames_to_bytes(runtime, runtime->period_size);
653}
654
655/*
656 * result is: 0 ... (boundary - 1)
657 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100658static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659{
660 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
661 if (avail < 0)
662 avail += runtime->boundary;
663 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
664 avail -= runtime->boundary;
665 return avail;
666}
667
668/*
669 * result is: 0 ... (boundary - 1)
670 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100671static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
673 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
674 if (avail < 0)
675 avail += runtime->boundary;
676 return avail;
677}
678
Takashi Iwai877211f2005-11-17 13:59:38 +0100679static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680{
681 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
682}
683
Takashi Iwai877211f2005-11-17 13:59:38 +0100684static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
686 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
687}
688
689/**
690 * snd_pcm_playback_ready - check whether the playback buffer is available
691 * @substream: the pcm substream instance
692 *
693 * Checks whether enough free space is available on the playback buffer.
694 *
695 * Returns non-zero if available, or zero if not.
696 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100697static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698{
Takashi Iwai877211f2005-11-17 13:59:38 +0100699 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
701}
702
703/**
704 * snd_pcm_capture_ready - check whether the capture buffer is available
705 * @substream: the pcm substream instance
706 *
707 * Checks whether enough capture data is available on the capture buffer.
708 *
709 * Returns non-zero if available, or zero if not.
710 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100711static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712{
Takashi Iwai877211f2005-11-17 13:59:38 +0100713 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
715}
716
717/**
718 * snd_pcm_playback_data - check whether any data exists on the playback buffer
719 * @substream: the pcm substream instance
720 *
721 * Checks whether any data exists on the playback buffer. If stop_threshold
722 * is bigger or equal to boundary, then this function returns always non-zero.
723 *
724 * Returns non-zero if exists, or zero if not.
725 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100726static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
Takashi Iwai877211f2005-11-17 13:59:38 +0100728 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 if (runtime->stop_threshold >= runtime->boundary)
731 return 1;
732 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
733}
734
735/**
736 * snd_pcm_playback_empty - check whether the playback buffer is empty
737 * @substream: the pcm substream instance
738 *
739 * Checks whether the playback buffer is empty.
740 *
741 * Returns non-zero if empty, or zero if not.
742 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100743static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
Takashi Iwai877211f2005-11-17 13:59:38 +0100745 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
747}
748
749/**
750 * snd_pcm_capture_empty - check whether the capture buffer is empty
751 * @substream: the pcm substream instance
752 *
753 * Checks whether the capture buffer is empty.
754 *
755 * Returns non-zero if empty, or zero if not.
756 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100757static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758{
Takashi Iwai877211f2005-11-17 13:59:38 +0100759 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 return snd_pcm_capture_avail(runtime) == 0;
761}
762
Takashi Iwai877211f2005-11-17 13:59:38 +0100763static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
764 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
766 substream->runtime->trigger_master = master;
767}
768
769static inline int hw_is_mask(int var)
770{
771 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
772 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
773}
774
775static inline int hw_is_interval(int var)
776{
777 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
778 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
779}
780
Takashi Iwai877211f2005-11-17 13:59:38 +0100781static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 snd_pcm_hw_param_t var)
783{
784 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
785}
786
Takashi Iwai877211f2005-11-17 13:59:38 +0100787static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 snd_pcm_hw_param_t var)
789{
790 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
791}
792
Takashi Iwai877211f2005-11-17 13:59:38 +0100793static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 snd_pcm_hw_param_t var)
795{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200796 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797}
798
Takashi Iwai877211f2005-11-17 13:59:38 +0100799static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 snd_pcm_hw_param_t var)
801{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200802 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
805#define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
806#define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
807#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
808#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
809#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
810#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
811#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
812#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
813#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
814#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
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);
Takashi Iwai877211f2005-11-17 13:59:38 +0100912void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
913snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 const void __user *buf,
915 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100916snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100918snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100920snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 void __user **bufs, snd_pcm_uframes_t frames);
922
Clemens Ladisch7653d552007-08-13 17:38:54 +0200923extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
924
Takashi Iwai877211f2005-11-17 13:59:38 +0100925int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200926unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
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
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100953static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
954 struct timespec *tv)
955{
956 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
957 do_posix_clock_monotonic_gettime(tv);
958 else
959 getnstimeofday(tv);
960}
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962/*
963 * Memory
964 */
965
Takashi Iwai877211f2005-11-17 13:59:38 +0100966int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
967int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
968int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 int type, struct device *data,
970 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100971int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 int type, void *data,
973 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100974int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
975int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Takashi Iwai77a23f22008-08-21 13:00:13 +0200977/*
978 * SG-buffer handling
979 */
980#define snd_pcm_substream_sgbuf(substream) \
981 ((substream)->runtime->dma_buffer_p->private_data)
982
983static inline dma_addr_t
984snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
985{
986 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
987 return snd_sgbuf_get_addr(sg, ofs);
988}
989
990static inline void *
991snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
992{
993 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
994 return snd_sgbuf_get_ptr(sg, ofs);
995}
996
997struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
998 unsigned long offset);
Takashi Iwai51e9f2e2008-07-30 15:13:33 +0200999unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1000 unsigned int ofs, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001
1002/* handle mmap counter - PCM mmap callback should handle this counter properly */
1003static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1004{
Takashi Iwai877211f2005-11-17 13:59:38 +01001005 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001006 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007}
1008
1009static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1010{
Takashi Iwai877211f2005-11-17 13:59:38 +01001011 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001012 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013}
1014
1015/* mmap for io-memory area */
1016#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1017#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001018int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019#else
1020#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1021#define snd_pcm_lib_mmap_iomem NULL
1022#endif
1023
1024static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1025{
1026 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1027}
1028
1029/*
1030 * Misc
1031 */
1032
1033#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1034 (IEC958_AES1_CON_ORIGINAL<<8)|\
1035 (IEC958_AES1_CON_PCM_CODER<<8)|\
1036 (IEC958_AES3_CON_FS_48000<<24))
1037
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001038#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040#endif /* __SOUND_PCM_H */