blob: e91e6047ca6f6ec2d3635821da43a95837af443e [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>
Jean Pihete8db0be2011-08-25 15:35:03 +020032#include <linux/pm_qos.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#define snd_pcm_substream_chip(substream) ((substream)->private_data)
35#define snd_pcm_chip(pcm) ((pcm)->private_data)
36
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
38#include "pcm_oss.h"
39#endif
40
41/*
42 * Hardware (lowlevel) section
43 */
44
Takashi Iwai877211f2005-11-17 13:59:38 +010045struct snd_pcm_hardware {
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 unsigned int info; /* SNDRV_PCM_INFO_* */
47 u64 formats; /* SNDRV_PCM_FMTBIT_* */
48 unsigned int rates; /* SNDRV_PCM_RATE_* */
49 unsigned int rate_min; /* min rate */
50 unsigned int rate_max; /* max rate */
51 unsigned int channels_min; /* min channels */
52 unsigned int channels_max; /* max channels */
53 size_t buffer_bytes_max; /* max buffer size */
54 size_t period_bytes_min; /* min period size */
55 size_t period_bytes_max; /* max period size */
56 unsigned int periods_min; /* min # of periods */
57 unsigned int periods_max; /* max # of periods */
58 size_t fifo_size; /* fifo size in bytes */
Takashi Iwai877211f2005-11-17 13:59:38 +010059};
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Randy Dunlape0e6ce02006-12-07 08:22:50 +010061struct snd_pcm_substream;
62
Takashi Iwai877211f2005-11-17 13:59:38 +010063struct snd_pcm_ops {
64 int (*open)(struct snd_pcm_substream *substream);
65 int (*close)(struct snd_pcm_substream *substream);
66 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010068 int (*hw_params)(struct snd_pcm_substream *substream,
69 struct snd_pcm_hw_params *params);
70 int (*hw_free)(struct snd_pcm_substream *substream);
71 int (*prepare)(struct snd_pcm_substream *substream);
72 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
73 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
74 int (*copy)(struct snd_pcm_substream *substream, int channel,
75 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010077 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010079 struct page *(*page)(struct snd_pcm_substream *substream,
80 unsigned long offset);
81 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
82 int (*ack)(struct snd_pcm_substream *substream);
83};
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85/*
86 *
87 */
88
Pawel MOLLf90c06a2008-07-30 12:46:40 +010089#if defined(CONFIG_SND_DYNAMIC_MINORS)
90#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
91#else
92#define SNDRV_PCM_DEVICES 8
93#endif
Jaroslav Kysela896e6cc2008-08-01 13:36:04 +020094
Linus Torvalds1da177e2005-04-16 15:20:36 -070095#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
96#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97
98#define SNDRV_PCM_IOCTL1_RESET 0
99#define SNDRV_PCM_IOCTL1_INFO 1
100#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
101#define SNDRV_PCM_IOCTL1_GSTATE 3
Jaroslav Kysela8bea8692009-04-27 09:44:40 +0200102#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103
104#define SNDRV_PCM_TRIGGER_STOP 0
105#define SNDRV_PCM_TRIGGER_START 1
106#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
107#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
108#define SNDRV_PCM_TRIGGER_SUSPEND 5
109#define SNDRV_PCM_TRIGGER_RESUME 6
110
111#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
112
113/* If you change this don't forget to change rates[] table in pcm_native.c */
114#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
115#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
116#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
117#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
118#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
119#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
120#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
121#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
122#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
123#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
124#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
125#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
126#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
127
128#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
129#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
130
131#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
132 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
133 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
134#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
135#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
136 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
137#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
138 SNDRV_PCM_RATE_192000)
Clemens Ladischfea952e2011-02-14 11:00:47 +0100139#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
140#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
141#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
142#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
143#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
144#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
145#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
146#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
147#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
148#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
149#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
150#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
151#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
152#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
153#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
154#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
155#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
156#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
157#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
158#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
159#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
160#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
161#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
162#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
163#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
164#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
165#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
166#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
167#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
168#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
169#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
170#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
171#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
172#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
173#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
174#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
175#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
176#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
177#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
178#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
179#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
180#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
181#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183#ifdef SNDRV_LITTLE_ENDIAN
184#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
185#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
186#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
187#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
188#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
189#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
190#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
191#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
192#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
193#endif
194#ifdef SNDRV_BIG_ENDIAN
195#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
196#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
197#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
198#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
199#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
200#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
201#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
202#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
203#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
204#endif
205
Takashi Iwai877211f2005-11-17 13:59:38 +0100206struct snd_pcm_file {
207 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200208 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209};
210
Takashi Iwai877211f2005-11-17 13:59:38 +0100211struct snd_pcm_hw_rule;
212typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
213 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Takashi Iwai877211f2005-11-17 13:59:38 +0100215struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 unsigned int cond;
217 snd_pcm_hw_rule_func_t func;
218 int var;
219 int deps[4];
220 void *private;
221};
222
Takashi Iwai877211f2005-11-17 13:59:38 +0100223struct snd_pcm_hw_constraints {
224 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100226 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
228 unsigned int rules_num;
229 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100230 struct snd_pcm_hw_rule *rules;
231};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
Takashi Iwai877211f2005-11-17 13:59:38 +0100233static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
236 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
237}
238
Takashi Iwai877211f2005-11-17 13:59:38 +0100239static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
240 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241{
242 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
243}
244
Takashi Iwai877211f2005-11-17 13:59:38 +0100245struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 unsigned int num;
247 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100248};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Takashi Iwai877211f2005-11-17 13:59:38 +0100250struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 unsigned int num_min, num_max, num_step;
252 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100253};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Takashi Iwai877211f2005-11-17 13:59:38 +0100255struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100257 struct snd_ratnum *rats;
258};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Takashi Iwai877211f2005-11-17 13:59:38 +0100260struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100262 struct snd_ratden *rats;
263};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Takashi Iwai877211f2005-11-17 13:59:38 +0100265struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 unsigned int count;
Mark Brown4af87a92012-03-14 19:48:43 +0000267 const unsigned int *list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100269};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100271struct snd_pcm_hwptr_log;
272
Takashi Iwai877211f2005-11-17 13:59:38 +0100273struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100275 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200276 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 int overrange;
278 snd_pcm_uframes_t avail_max;
279 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100280 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200281 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200282 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
Takashi Iwai4bbe1dd2008-10-13 03:07:14 +0200283 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285 /* -- HW params -- */
286 snd_pcm_access_t access; /* access mode */
287 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
288 snd_pcm_subformat_t subformat; /* subformat */
289 unsigned int rate; /* rate in Hz */
290 unsigned int channels; /* channels */
291 snd_pcm_uframes_t period_size; /* period size */
292 unsigned int periods; /* periods */
293 snd_pcm_uframes_t buffer_size; /* buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 snd_pcm_uframes_t min_align; /* Min alignment for the format */
295 size_t byte_align;
296 unsigned int frame_bits;
297 unsigned int sample_bits;
298 unsigned int info;
299 unsigned int rate_num;
300 unsigned int rate_den;
Clemens Ladischab69a492010-11-15 10:46:23 +0100301 unsigned int no_period_wakeup: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
303 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100304 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 unsigned int period_step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 snd_pcm_uframes_t start_threshold;
307 snd_pcm_uframes_t stop_threshold;
308 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
309 noise is nearest than this */
310 snd_pcm_uframes_t silence_size; /* Silence filling size */
311 snd_pcm_uframes_t boundary; /* pointers wrap point */
312
313 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
314 snd_pcm_uframes_t silence_filled; /* size filled with silence */
315
Takashi Iwai877211f2005-11-17 13:59:38 +0100316 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318 /* -- mmap -- */
Takashi Iwai503fc85a2007-09-11 00:35:06 +0200319 struct snd_pcm_mmap_status *status;
320 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 /* -- locking / scheduling -- */
David Dillow5daeba32010-06-27 00:13:20 +0200323 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
Jaroslav Kyselac91a9882010-01-21 10:32:15 +0100324 wait_queue_head_t sleep; /* poll sleep */
325 wait_queue_head_t tsleep; /* transfer sleep */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 struct fasync_struct *fasync;
327
328 /* -- private section -- */
329 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100330 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100333 struct snd_pcm_hardware hw;
334 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100337 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
338 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 /* -- timer -- */
341 unsigned int timer_resolution; /* timer resolution */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100342 int tstamp_type; /* timestamp type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 /* -- DMA -- */
345 unsigned char *dma_area; /* DMA area */
346 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
347 size_t dma_bytes; /* size of DMA area */
348
349 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
350
351#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
352 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100353 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354#endif
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100355
356#ifdef CONFIG_SND_PCM_XRUN_DEBUG
357 struct snd_pcm_hwptr_log *hwptr_log;
358#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359};
360
Takashi Iwai877211f2005-11-17 13:59:38 +0100361struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 spinlock_t lock;
363 struct list_head substreams;
364 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100365};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Clemens Ladische7373b72009-11-10 10:13:30 +0100367struct pid;
368
Takashi Iwai877211f2005-11-17 13:59:38 +0100369struct snd_pcm_substream {
370 struct snd_pcm *pcm;
371 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 void *private_data; /* copied from pcm->private_data */
373 int number;
374 char name[32]; /* substream name */
375 int stream; /* stream (direction) */
Jean Pihetcc749982011-08-25 15:35:12 +0200376 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 size_t buffer_bytes_max; /* limit ring buffer size */
378 struct snd_dma_buffer dma_buffer;
379 unsigned int dma_buf_id;
380 size_t dma_max;
381 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100382 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100384 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100386 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 unsigned timer_running: 1; /* time is running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100389 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 /* -- linked substreams -- */
391 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100392 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
393 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200395 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200396 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200397 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200398 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200399 void (*pcm_release)(struct snd_pcm_substream *);
Clemens Ladische7373b72009-11-10 10:13:30 +0100400 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
402 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100403 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200405#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100406 struct snd_info_entry *proc_root;
407 struct snd_info_entry *proc_info_entry;
408 struct snd_info_entry *proc_hw_params_entry;
409 struct snd_info_entry *proc_sw_params_entry;
410 struct snd_info_entry *proc_status_entry;
411 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200412 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200413#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200415 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416};
417
Takashi Iwai0df63e42006-04-28 15:13:41 +0200418#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
420
Takashi Iwai877211f2005-11-17 13:59:38 +0100421struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100423 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 /* -- substreams -- */
425 unsigned int substream_count;
426 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100427 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
429 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100430 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200432#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100433 struct snd_info_entry *proc_root;
434 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200435#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100437 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200439#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440};
441
Takashi Iwai877211f2005-11-17 13:59:38 +0100442struct snd_pcm {
443 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100444 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100445 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 unsigned int info_flags;
447 unsigned short dev_class;
448 unsigned short dev_subclass;
449 char id[64];
450 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100451 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100452 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 wait_queue_head_t open_wait;
454 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100455 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200456 struct device *dev; /* actual hw device this belongs to */
Liam Girdwood945e5032012-02-08 20:33:31 +0000457 bool internal; /* pcm is for internal use only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100459 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460#endif
461};
462
Takashi Iwai877211f2005-11-17 13:59:38 +0100463struct snd_pcm_notify {
464 int (*n_register) (struct snd_pcm * pcm);
465 int (*n_disconnect) (struct snd_pcm * pcm);
466 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100468};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470/*
471 * Registering
472 */
473
Arjan van de Ven54047322007-02-12 00:55:28 -0800474extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
Tim Blechmanne6161652009-02-05 13:01:54 +0100476int snd_pcm_new(struct snd_card *card, const char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100478 struct snd_pcm **rpcm);
Liam Girdwood945e5032012-02-08 20:33:31 +0000479int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
480 int playback_count, int capture_count,
481 struct snd_pcm **rpcm);
Takashi Iwai877211f2005-11-17 13:59:38 +0100482int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Takashi Iwai877211f2005-11-17 13:59:38 +0100484int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486/*
487 * Native I/O
488 */
489
490extern rwlock_t snd_pcm_link_rwlock;
491
Takashi Iwai877211f2005-11-17 13:59:38 +0100492int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
493int snd_pcm_info_user(struct snd_pcm_substream *substream,
494 struct snd_pcm_info __user *info);
495int snd_pcm_status(struct snd_pcm_substream *substream,
496 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100497int snd_pcm_start(struct snd_pcm_substream *substream);
Clemens Ladischfea952e2011-02-14 11:00:47 +0100498int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100499int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100501int snd_pcm_suspend(struct snd_pcm_substream *substream);
502int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100504int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200505int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
506 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100507void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200508int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
509 struct snd_pcm_substream **rsubstream);
510void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100512int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200514
515#ifdef CONFIG_SND_DEBUG
516void snd_pcm_debug_name(struct snd_pcm_substream *substream,
517 char *name, size_t len);
518#else
519static inline void
520snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
521{
522 *buf = 0;
523}
524#endif
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526/*
527 * PCM library
528 */
529
Takashi Iwai877211f2005-11-17 13:59:38 +0100530static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
532 return substream->group != &substream->self_group;
533}
534
Takashi Iwai877211f2005-11-17 13:59:38 +0100535static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 read_lock(&snd_pcm_link_rwlock);
538 spin_lock(&substream->self_group.lock);
539}
540
Takashi Iwai877211f2005-11-17 13:59:38 +0100541static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 spin_unlock(&substream->self_group.lock);
544 read_unlock(&snd_pcm_link_rwlock);
545}
546
Takashi Iwai877211f2005-11-17 13:59:38 +0100547static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 read_lock_irq(&snd_pcm_link_rwlock);
550 spin_lock(&substream->self_group.lock);
551}
552
Takashi Iwai877211f2005-11-17 13:59:38 +0100553static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554{
555 spin_unlock(&substream->self_group.lock);
556 read_unlock_irq(&snd_pcm_link_rwlock);
557}
558
559#define snd_pcm_stream_lock_irqsave(substream, flags) \
560do { \
561 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
562 spin_lock(&substream->self_group.lock); \
563} while (0)
564
565#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
566do { \
567 spin_unlock(&substream->self_group.lock); \
568 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
569} while (0)
570
Takashi Iwaief991b92007-02-22 12:52:53 +0100571#define snd_pcm_group_for_each_entry(s, substream) \
572 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Takashi Iwai877211f2005-11-17 13:59:38 +0100574static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
577 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
578 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
579}
580
Takashi Iwai877211f2005-11-17 13:59:38 +0100581static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 return size * 8 / runtime->sample_bits;
584}
585
Takashi Iwai877211f2005-11-17 13:59:38 +0100586static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
588 return size * 8 / runtime->frame_bits;
589}
590
Takashi Iwai877211f2005-11-17 13:59:38 +0100591static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592{
593 return size * runtime->sample_bits / 8;
594}
595
Takashi Iwai877211f2005-11-17 13:59:38 +0100596static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
598 return size * runtime->frame_bits / 8;
599}
600
Takashi Iwai877211f2005-11-17 13:59:38 +0100601static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602{
603 return bytes % runtime->byte_align == 0;
604}
605
Takashi Iwai877211f2005-11-17 13:59:38 +0100606static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
Takashi Iwai877211f2005-11-17 13:59:38 +0100608 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 return frames_to_bytes(runtime, runtime->buffer_size);
610}
611
Takashi Iwai877211f2005-11-17 13:59:38 +0100612static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Takashi Iwai877211f2005-11-17 13:59:38 +0100614 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 return frames_to_bytes(runtime, runtime->period_size);
616}
617
618/*
619 * result is: 0 ... (boundary - 1)
620 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100621static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622{
623 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
624 if (avail < 0)
625 avail += runtime->boundary;
626 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
627 avail -= runtime->boundary;
628 return avail;
629}
630
631/*
632 * result is: 0 ... (boundary - 1)
633 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100634static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
636 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
637 if (avail < 0)
638 avail += runtime->boundary;
639 return avail;
640}
641
Takashi Iwai877211f2005-11-17 13:59:38 +0100642static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643{
644 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
645}
646
Takashi Iwai877211f2005-11-17 13:59:38 +0100647static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
649 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
650}
651
652/**
653 * snd_pcm_playback_ready - check whether the playback buffer is available
654 * @substream: the pcm substream instance
655 *
656 * Checks whether enough free space is available on the playback buffer.
657 *
658 * Returns non-zero if available, or zero if not.
659 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100660static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Takashi Iwai877211f2005-11-17 13:59:38 +0100662 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
664}
665
666/**
667 * snd_pcm_capture_ready - check whether the capture buffer is available
668 * @substream: the pcm substream instance
669 *
670 * Checks whether enough capture data is available on the capture buffer.
671 *
672 * Returns non-zero if available, or zero if not.
673 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100674static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675{
Takashi Iwai877211f2005-11-17 13:59:38 +0100676 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
678}
679
680/**
681 * snd_pcm_playback_data - check whether any data exists on the playback buffer
682 * @substream: the pcm substream instance
683 *
684 * Checks whether any data exists on the playback buffer. If stop_threshold
685 * is bigger or equal to boundary, then this function returns always non-zero.
686 *
687 * Returns non-zero if exists, or zero if not.
688 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100689static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690{
Takashi Iwai877211f2005-11-17 13:59:38 +0100691 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692
693 if (runtime->stop_threshold >= runtime->boundary)
694 return 1;
695 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
696}
697
698/**
699 * snd_pcm_playback_empty - check whether the playback buffer is empty
700 * @substream: the pcm substream instance
701 *
702 * Checks whether the playback buffer is empty.
703 *
704 * Returns non-zero if empty, or zero if not.
705 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100706static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707{
Takashi Iwai877211f2005-11-17 13:59:38 +0100708 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
710}
711
712/**
713 * snd_pcm_capture_empty - check whether the capture buffer is empty
714 * @substream: the pcm substream instance
715 *
716 * Checks whether the capture buffer is empty.
717 *
718 * Returns non-zero if empty, or zero if not.
719 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100720static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721{
Takashi Iwai877211f2005-11-17 13:59:38 +0100722 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 return snd_pcm_capture_avail(runtime) == 0;
724}
725
Takashi Iwai877211f2005-11-17 13:59:38 +0100726static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
727 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
729 substream->runtime->trigger_master = master;
730}
731
732static inline int hw_is_mask(int var)
733{
734 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
735 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
736}
737
738static inline int hw_is_interval(int var)
739{
740 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
741 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
742}
743
Takashi Iwai877211f2005-11-17 13:59:38 +0100744static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 snd_pcm_hw_param_t var)
746{
747 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
748}
749
Takashi Iwai877211f2005-11-17 13:59:38 +0100750static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 snd_pcm_hw_param_t var)
752{
753 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
754}
755
Takashi Iwai877211f2005-11-17 13:59:38 +0100756static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 snd_pcm_hw_param_t var)
758{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200759 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
Takashi Iwai877211f2005-11-17 13:59:38 +0100762static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 snd_pcm_hw_param_t var)
764{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200765 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766}
767
Takashi Iwaib51beb72011-07-26 12:02:56 +0200768#define params_channels(p) \
769 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
770#define params_rate(p) \
771 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
772#define params_period_size(p) \
773 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
774#define params_periods(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
776#define params_buffer_size(p) \
777 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
778#define params_buffer_bytes(p) \
779 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Takashi Iwai877211f2005-11-17 13:59:38 +0100781int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
782void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
783void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
784void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
785 unsigned int k, struct snd_interval *c);
786void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
787 const struct snd_interval *b, struct snd_interval *c);
Mark Brown4af87a92012-03-14 19:48:43 +0000788int snd_interval_list(struct snd_interval *i, unsigned int count,
789 const unsigned int *list, unsigned int mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100790int snd_interval_ratnum(struct snd_interval *i,
791 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 unsigned int *nump, unsigned int *denp);
793
Takashi Iwai877211f2005-11-17 13:59:38 +0100794void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
795void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100796int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Takashi Iwai877211f2005-11-17 13:59:38 +0100798int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Takashi Iwai877211f2005-11-17 13:59:38 +0100800int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
801int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Takashi Iwai877211f2005-11-17 13:59:38 +0100803int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100805int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100807int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100809int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
810int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 unsigned int cond,
812 snd_pcm_hw_param_t var,
Mark Brown14641892012-07-05 12:15:01 +0100813 const struct snd_pcm_hw_constraint_list *l);
Takashi Iwai877211f2005-11-17 13:59:38 +0100814int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 unsigned int cond,
816 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100817 struct snd_pcm_hw_constraint_ratnums *r);
818int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 unsigned int cond,
820 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100821 struct snd_pcm_hw_constraint_ratdens *r);
822int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 unsigned int cond,
824 unsigned int width,
825 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100826int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 unsigned int cond,
828 snd_pcm_hw_param_t var,
829 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100830int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 unsigned int cond,
832 snd_pcm_hw_param_t var);
Clemens Ladischd5b702a2011-09-16 23:03:02 +0200833int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
834 unsigned int base_rate);
Takashi Iwai877211f2005-11-17 13:59:38 +0100835int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 unsigned int cond,
837 int var,
838 snd_pcm_hw_rule_func_t func, void *private,
839 int dep, ...);
840
841int snd_pcm_format_signed(snd_pcm_format_t format);
842int snd_pcm_format_unsigned(snd_pcm_format_t format);
843int snd_pcm_format_linear(snd_pcm_format_t format);
844int snd_pcm_format_little_endian(snd_pcm_format_t format);
845int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200846#if 0 /* just for DocBook */
847/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200848 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
849 * @format: the format to check
850 *
851 * Returns 1 if the given PCM format is CPU-endian, 0 if
852 * opposite, or a negative error code if endian not specified.
853 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200854int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200855#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200856#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700857#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200858#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700859#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200860#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
862int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200863ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
865int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
866snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Takashi Iwai877211f2005-11-17 13:59:38 +0100868void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
869void snd_pcm_set_sync(struct snd_pcm_substream *substream);
870int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
871int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 unsigned int cmd, void *arg);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100873int snd_pcm_update_state(struct snd_pcm_substream *substream,
874 struct snd_pcm_runtime *runtime);
Takashi Iwai877211f2005-11-17 13:59:38 +0100875int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
876int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
877int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
878int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
879int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
880void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
Takashi Iwai877211f2005-11-17 13:59:38 +0100881void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
882snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 const void __user *buf,
884 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100885snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100887snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100889snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 void __user **bufs, snd_pcm_uframes_t frames);
891
Clemens Ladisch7653d552007-08-13 17:38:54 +0200892extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
893
Takashi Iwai877211f2005-11-17 13:59:38 +0100894int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200895unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Dimitris Papastamos4be77a52012-06-15 16:35:28 +0100896unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897
Takashi Iwai877211f2005-11-17 13:59:38 +0100898static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 struct snd_dma_buffer *bufp)
900{
Takashi Iwai877211f2005-11-17 13:59:38 +0100901 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 if (bufp) {
903 runtime->dma_buffer_p = bufp;
904 runtime->dma_area = bufp->area;
905 runtime->dma_addr = bufp->addr;
906 runtime->dma_bytes = bufp->bytes;
907 } else {
908 runtime->dma_buffer_p = NULL;
909 runtime->dma_area = NULL;
910 runtime->dma_addr = 0;
911 runtime->dma_bytes = 0;
912 }
913}
914
915/*
916 * Timer interface
917 */
918
Takashi Iwai877211f2005-11-17 13:59:38 +0100919void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
920void snd_pcm_timer_init(struct snd_pcm_substream *substream);
921void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100923static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
924 struct timespec *tv)
925{
926 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
927 do_posix_clock_monotonic_gettime(tv);
928 else
929 getnstimeofday(tv);
930}
931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932/*
933 * Memory
934 */
935
Takashi Iwai877211f2005-11-17 13:59:38 +0100936int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
937int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
938int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 int type, struct device *data,
940 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100941int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 int type, void *data,
943 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100944int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
945int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100947int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
948 size_t size, gfp_t gfp_flags);
949int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
950struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
951 unsigned long offset);
952#if 0 /* for kernel-doc */
953/**
954 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
955 * @substream: the substream to allocate the buffer to
956 * @size: the requested buffer size, in bytes
957 *
958 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
959 * contiguous in kernel virtual space, but not in physical memory. Use this
960 * if the buffer is accessed by kernel code but not by device DMA.
961 *
962 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
963 * code.
964 */
965static int snd_pcm_lib_alloc_vmalloc_buffer
966 (struct snd_pcm_substream *substream, size_t size);
967/**
968 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
969 * @substream: the substream to allocate the buffer to
970 * @size: the requested buffer size, in bytes
971 *
972 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
973 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
974 */
975static int snd_pcm_lib_alloc_vmalloc_32_buffer
976 (struct snd_pcm_substream *substream, size_t size);
977#endif
978#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
979 _snd_pcm_lib_alloc_vmalloc_buffer \
980 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
981#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
982 _snd_pcm_lib_alloc_vmalloc_buffer \
983 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
984
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +0200985#ifdef CONFIG_SND_DMA_SGBUF
Takashi Iwai77a23f22008-08-21 13:00:13 +0200986/*
987 * SG-buffer handling
988 */
989#define snd_pcm_substream_sgbuf(substream) \
990 ((substream)->runtime->dma_buffer_p->private_data)
991
992static inline dma_addr_t
993snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
994{
995 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
996 return snd_sgbuf_get_addr(sg, ofs);
997}
998
999static inline void *
1000snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1001{
1002 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
1003 return snd_sgbuf_get_ptr(sg, ofs);
1004}
1005
1006struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1007 unsigned long offset);
Takashi Iwai51e9f2e2008-07-30 15:13:33 +02001008unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1009 unsigned int ofs, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001011#else /* !SND_DMA_SGBUF */
1012/*
1013 * fake using a continuous buffer
1014 */
1015static inline dma_addr_t
1016snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1017{
1018 return substream->runtime->dma_addr + ofs;
1019}
1020
1021static inline void *
1022snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1023{
1024 return substream->runtime->dma_area + ofs;
1025}
1026
1027#define snd_pcm_sgbuf_ops_page NULL
1028
1029#define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
1030
1031#endif /* SND_DMA_SGBUF */
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033/* handle mmap counter - PCM mmap callback should handle this counter properly */
1034static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1035{
Takashi Iwai877211f2005-11-17 13:59:38 +01001036 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001037 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038}
1039
1040static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1041{
Takashi Iwai877211f2005-11-17 13:59:38 +01001042 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001043 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044}
1045
Takashi Iwai18a2b962011-09-28 17:12:59 +02001046int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1047 struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048/* mmap for io-memory area */
1049#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1050#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001051int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052#else
1053#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1054#define snd_pcm_lib_mmap_iomem NULL
1055#endif
1056
Benjamin Herrenschmidt3674f192011-03-25 17:51:54 +11001057#define snd_pcm_lib_mmap_vmalloc NULL
Takashi Iwaic32d9772010-01-18 14:58:57 +01001058
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1060{
1061 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1062}
1063
1064/*
1065 * Misc
1066 */
1067
1068#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1069 (IEC958_AES1_CON_ORIGINAL<<8)|\
1070 (IEC958_AES1_CON_PCM_CODER<<8)|\
1071 (IEC958_AES3_CON_FS_48000<<24))
1072
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001073#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1074
Takashi Iwai6e5265e2009-09-08 14:26:51 +02001075const char *snd_pcm_format_name(snd_pcm_format_t format);
1076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077#endif /* __SOUND_PCM_H */