blob: bf9041cb76a2f89f2bb8b5f2830d767211fc5771 [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>
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -07008 * Copyright (c) 2011, Code Aurora Forum. All rights reserved.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
Bryan Huntsman3f2bc4d2011-08-16 17:27:22 -070013 * the Free Software Foundation; only version 2 of the License.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 *
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>
Mark Grossed771342010-05-06 01:59:26 +020032#include <linux/pm_qos_params.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;
267 unsigned int *list;
268 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 Iwai503fc852007-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) */
James Bottomley82f68252010-07-05 22:53:06 +0200376 struct pm_qos_request_list 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;
Liam Girdwoodad2581e2011-02-01 21:31:31 +0000416 unsigned int hw_no_buffer: 1; /* substream may not have a buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417};
418
Takashi Iwai0df63e42006-04-28 15:13:41 +0200419#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421
Takashi Iwai877211f2005-11-17 13:59:38 +0100422struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100424 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /* -- substreams -- */
426 unsigned int substream_count;
427 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100428 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
430 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100431 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200433#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100434 struct snd_info_entry *proc_root;
435 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200436#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100438 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200440#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441};
442
Takashi Iwai877211f2005-11-17 13:59:38 +0100443struct snd_pcm {
444 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100445 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100446 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 unsigned int info_flags;
448 unsigned short dev_class;
449 unsigned short dev_subclass;
450 char id[64];
451 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100452 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100453 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 wait_queue_head_t open_wait;
455 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100456 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200457 struct device *dev; /* actual hw device this belongs to */
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);
479int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Takashi Iwai877211f2005-11-17 13:59:38 +0100481int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483/*
484 * Native I/O
485 */
486
487extern rwlock_t snd_pcm_link_rwlock;
488
Takashi Iwai877211f2005-11-17 13:59:38 +0100489int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
490int snd_pcm_info_user(struct snd_pcm_substream *substream,
491 struct snd_pcm_info __user *info);
492int snd_pcm_status(struct snd_pcm_substream *substream,
493 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100494int snd_pcm_start(struct snd_pcm_substream *substream);
Clemens Ladischfea952e2011-02-14 11:00:47 +0100495int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100496int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100498int snd_pcm_suspend(struct snd_pcm_substream *substream);
499int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100501int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200502int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
503 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100504void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200505int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
506 struct snd_pcm_substream **rsubstream);
507void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100509int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511/*
512 * PCM library
513 */
514
Takashi Iwai877211f2005-11-17 13:59:38 +0100515static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
517 return substream->group != &substream->self_group;
518}
519
Takashi Iwai877211f2005-11-17 13:59:38 +0100520static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 read_lock(&snd_pcm_link_rwlock);
523 spin_lock(&substream->self_group.lock);
524}
525
Takashi Iwai877211f2005-11-17 13:59:38 +0100526static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 spin_unlock(&substream->self_group.lock);
529 read_unlock(&snd_pcm_link_rwlock);
530}
531
Takashi Iwai877211f2005-11-17 13:59:38 +0100532static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
534 read_lock_irq(&snd_pcm_link_rwlock);
535 spin_lock(&substream->self_group.lock);
536}
537
Takashi Iwai877211f2005-11-17 13:59:38 +0100538static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
540 spin_unlock(&substream->self_group.lock);
541 read_unlock_irq(&snd_pcm_link_rwlock);
542}
543
544#define snd_pcm_stream_lock_irqsave(substream, flags) \
545do { \
546 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
547 spin_lock(&substream->self_group.lock); \
548} while (0)
549
550#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
551do { \
552 spin_unlock(&substream->self_group.lock); \
553 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
554} while (0)
555
Takashi Iwaief991b92007-02-22 12:52:53 +0100556#define snd_pcm_group_for_each_entry(s, substream) \
557 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Takashi Iwai877211f2005-11-17 13:59:38 +0100559static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
561 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
562 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
563 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
564}
565
Takashi Iwai877211f2005-11-17 13:59:38 +0100566static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567{
568 return size * 8 / runtime->sample_bits;
569}
570
Takashi Iwai877211f2005-11-17 13:59:38 +0100571static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
573 return size * 8 / runtime->frame_bits;
574}
575
Takashi Iwai877211f2005-11-17 13:59:38 +0100576static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577{
578 return size * runtime->sample_bits / 8;
579}
580
Takashi Iwai877211f2005-11-17 13:59:38 +0100581static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
583 return size * runtime->frame_bits / 8;
584}
585
Takashi Iwai877211f2005-11-17 13:59:38 +0100586static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587{
588 return bytes % runtime->byte_align == 0;
589}
590
Takashi Iwai877211f2005-11-17 13:59:38 +0100591static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592{
Takashi Iwai877211f2005-11-17 13:59:38 +0100593 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 return frames_to_bytes(runtime, runtime->buffer_size);
595}
596
Takashi Iwai877211f2005-11-17 13:59:38 +0100597static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Takashi Iwai877211f2005-11-17 13:59:38 +0100599 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return frames_to_bytes(runtime, runtime->period_size);
601}
602
603/*
604 * result is: 0 ... (boundary - 1)
605 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100606static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607{
608 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
609 if (avail < 0)
610 avail += runtime->boundary;
611 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
612 avail -= runtime->boundary;
613 return avail;
614}
615
616/*
617 * result is: 0 ... (boundary - 1)
618 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100619static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
621 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
622 if (avail < 0)
623 avail += runtime->boundary;
624 return avail;
625}
626
Takashi Iwai877211f2005-11-17 13:59:38 +0100627static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
630}
631
Takashi Iwai877211f2005-11-17 13:59:38 +0100632static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633{
634 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
635}
636
637/**
638 * snd_pcm_playback_ready - check whether the playback buffer is available
639 * @substream: the pcm substream instance
640 *
641 * Checks whether enough free space is available on the playback buffer.
642 *
643 * Returns non-zero if available, or zero if not.
644 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100645static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
Takashi Iwai877211f2005-11-17 13:59:38 +0100647 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
649}
650
651/**
652 * snd_pcm_capture_ready - check whether the capture buffer is available
653 * @substream: the pcm substream instance
654 *
655 * Checks whether enough capture data is available on the capture buffer.
656 *
657 * Returns non-zero if available, or zero if not.
658 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100659static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
Takashi Iwai877211f2005-11-17 13:59:38 +0100661 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
663}
664
665/**
666 * snd_pcm_playback_data - check whether any data exists on the playback buffer
667 * @substream: the pcm substream instance
668 *
669 * Checks whether any data exists on the playback buffer. If stop_threshold
670 * is bigger or equal to boundary, then this function returns always non-zero.
671 *
672 * Returns non-zero if exists, or zero if not.
673 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100674static inline int snd_pcm_playback_data(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
678 if (runtime->stop_threshold >= runtime->boundary)
679 return 1;
680 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
681}
682
683/**
684 * snd_pcm_playback_empty - check whether the playback buffer is empty
685 * @substream: the pcm substream instance
686 *
687 * Checks whether the playback buffer is empty.
688 *
689 * Returns non-zero if empty, or zero if not.
690 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100691static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700692{
Takashi Iwai877211f2005-11-17 13:59:38 +0100693 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
695}
696
697/**
698 * snd_pcm_capture_empty - check whether the capture buffer is empty
699 * @substream: the pcm substream instance
700 *
701 * Checks whether the capture buffer is empty.
702 *
703 * Returns non-zero if empty, or zero if not.
704 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100705static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Takashi Iwai877211f2005-11-17 13:59:38 +0100707 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 return snd_pcm_capture_avail(runtime) == 0;
709}
710
Takashi Iwai877211f2005-11-17 13:59:38 +0100711static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
712 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
714 substream->runtime->trigger_master = master;
715}
716
717static inline int hw_is_mask(int var)
718{
719 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
720 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
721}
722
723static inline int hw_is_interval(int var)
724{
725 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
726 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
727}
728
Takashi Iwai877211f2005-11-17 13:59:38 +0100729static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 snd_pcm_hw_param_t var)
731{
732 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
733}
734
Takashi Iwai877211f2005-11-17 13:59:38 +0100735static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 snd_pcm_hw_param_t var)
737{
738 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
739}
740
Takashi Iwai877211f2005-11-17 13:59:38 +0100741static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 snd_pcm_hw_param_t var)
743{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200744 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745}
746
Takashi Iwai877211f2005-11-17 13:59:38 +0100747static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 snd_pcm_hw_param_t var)
749{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200750 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751}
752
Clemens Ladischfea952e2011-02-14 11:00:47 +0100753#define params_access(p) ((__force snd_pcm_access_t)snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS)))
754#define params_format(p) ((__force snd_pcm_format_t)snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755#define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
756#define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
757#define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
758#define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
759#define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
760#define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
761#define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
762#define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
764
Takashi Iwai877211f2005-11-17 13:59:38 +0100765int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
766void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
767void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
768void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
769 unsigned int k, struct snd_interval *c);
770void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
771 const struct snd_interval *b, struct snd_interval *c);
772int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
773int snd_interval_ratnum(struct snd_interval *i,
774 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 unsigned int *nump, unsigned int *denp);
776
Takashi Iwai877211f2005-11-17 13:59:38 +0100777void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
778void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100779int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Takashi Iwai877211f2005-11-17 13:59:38 +0100781int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782
Takashi Iwai877211f2005-11-17 13:59:38 +0100783int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
784int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785
Takashi Iwai877211f2005-11-17 13:59:38 +0100786int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100788int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100790int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100792int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
793int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 unsigned int cond,
795 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100796 struct snd_pcm_hw_constraint_list *l);
797int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 unsigned int cond,
799 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100800 struct snd_pcm_hw_constraint_ratnums *r);
801int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 unsigned int cond,
803 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100804 struct snd_pcm_hw_constraint_ratdens *r);
805int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 unsigned int cond,
807 unsigned int width,
808 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100809int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 unsigned int cond,
811 snd_pcm_hw_param_t var,
812 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100813int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 unsigned int cond,
815 snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100816int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 unsigned int cond,
818 int var,
819 snd_pcm_hw_rule_func_t func, void *private,
820 int dep, ...);
821
822int snd_pcm_format_signed(snd_pcm_format_t format);
823int snd_pcm_format_unsigned(snd_pcm_format_t format);
824int snd_pcm_format_linear(snd_pcm_format_t format);
825int snd_pcm_format_little_endian(snd_pcm_format_t format);
826int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200827#if 0 /* just for DocBook */
828/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200829 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
830 * @format: the format to check
831 *
832 * Returns 1 if the given PCM format is CPU-endian, 0 if
833 * opposite, or a negative error code if endian not specified.
834 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200835int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200836#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200837#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700838#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200839#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700840#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200841#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
843int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200844ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
846int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
847snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848
Takashi Iwai877211f2005-11-17 13:59:38 +0100849void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
850void snd_pcm_set_sync(struct snd_pcm_substream *substream);
851int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
852int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 unsigned int cmd, void *arg);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100854int snd_pcm_update_state(struct snd_pcm_substream *substream,
855 struct snd_pcm_runtime *runtime);
Takashi Iwai877211f2005-11-17 13:59:38 +0100856int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
857int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
858int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
859int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
860int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
861void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
Takashi Iwai877211f2005-11-17 13:59:38 +0100862void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
863snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 const void __user *buf,
865 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100866snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100868snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100870snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 void __user **bufs, snd_pcm_uframes_t frames);
872
Clemens Ladisch7653d552007-08-13 17:38:54 +0200873extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
874
Takashi Iwai877211f2005-11-17 13:59:38 +0100875int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200876unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Takashi Iwai877211f2005-11-17 13:59:38 +0100878static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 struct snd_dma_buffer *bufp)
880{
Takashi Iwai877211f2005-11-17 13:59:38 +0100881 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 if (bufp) {
883 runtime->dma_buffer_p = bufp;
884 runtime->dma_area = bufp->area;
885 runtime->dma_addr = bufp->addr;
886 runtime->dma_bytes = bufp->bytes;
887 } else {
888 runtime->dma_buffer_p = NULL;
889 runtime->dma_area = NULL;
890 runtime->dma_addr = 0;
891 runtime->dma_bytes = 0;
892 }
893}
894
895/*
896 * Timer interface
897 */
898
Takashi Iwai877211f2005-11-17 13:59:38 +0100899void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
900void snd_pcm_timer_init(struct snd_pcm_substream *substream);
901void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100903static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
904 struct timespec *tv)
905{
906 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
907 do_posix_clock_monotonic_gettime(tv);
908 else
909 getnstimeofday(tv);
910}
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912/*
913 * Memory
914 */
915
Takashi Iwai877211f2005-11-17 13:59:38 +0100916int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
917int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
918int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 int type, struct device *data,
920 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100921int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 int type, void *data,
923 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100924int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
925int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100927int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
928 size_t size, gfp_t gfp_flags);
929int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
930struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
931 unsigned long offset);
932#if 0 /* for kernel-doc */
933/**
934 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
935 * @substream: the substream to allocate the buffer to
936 * @size: the requested buffer size, in bytes
937 *
938 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
939 * contiguous in kernel virtual space, but not in physical memory. Use this
940 * if the buffer is accessed by kernel code but not by device DMA.
941 *
942 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
943 * code.
944 */
945static int snd_pcm_lib_alloc_vmalloc_buffer
946 (struct snd_pcm_substream *substream, size_t size);
947/**
948 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
949 * @substream: the substream to allocate the buffer to
950 * @size: the requested buffer size, in bytes
951 *
952 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
953 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
954 */
955static int snd_pcm_lib_alloc_vmalloc_32_buffer
956 (struct snd_pcm_substream *substream, size_t size);
957#endif
958#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
959 _snd_pcm_lib_alloc_vmalloc_buffer \
960 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
961#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
962 _snd_pcm_lib_alloc_vmalloc_buffer \
963 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
964
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +0200965#ifdef CONFIG_SND_DMA_SGBUF
Takashi Iwai77a23f22008-08-21 13:00:13 +0200966/*
967 * SG-buffer handling
968 */
969#define snd_pcm_substream_sgbuf(substream) \
970 ((substream)->runtime->dma_buffer_p->private_data)
971
972static inline dma_addr_t
973snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
974{
975 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
976 return snd_sgbuf_get_addr(sg, ofs);
977}
978
979static inline void *
980snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
981{
982 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
983 return snd_sgbuf_get_ptr(sg, ofs);
984}
985
986struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
987 unsigned long offset);
Takashi Iwai51e9f2e2008-07-30 15:13:33 +0200988unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
989 unsigned int ofs, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +0200991#else /* !SND_DMA_SGBUF */
992/*
993 * fake using a continuous buffer
994 */
995static inline dma_addr_t
996snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
997{
998 return substream->runtime->dma_addr + ofs;
999}
1000
1001static inline void *
1002snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1003{
1004 return substream->runtime->dma_area + ofs;
1005}
1006
1007#define snd_pcm_sgbuf_ops_page NULL
1008
1009#define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
1010
1011#endif /* SND_DMA_SGBUF */
1012
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013/* handle mmap counter - PCM mmap callback should handle this counter properly */
1014static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1015{
Takashi Iwai877211f2005-11-17 13:59:38 +01001016 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001017 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018}
1019
1020static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1021{
Takashi Iwai877211f2005-11-17 13:59:38 +01001022 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001023 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
1025
1026/* mmap for io-memory area */
1027#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1028#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001029int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030#else
1031#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1032#define snd_pcm_lib_mmap_iomem NULL
1033#endif
1034
Benjamin Herrenschmidt3674f192011-03-25 17:51:54 +11001035#define snd_pcm_lib_mmap_vmalloc NULL
Takashi Iwaic32d9772010-01-18 14:58:57 +01001036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1038{
1039 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1040}
1041
1042/*
1043 * Misc
1044 */
1045
1046#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1047 (IEC958_AES1_CON_ORIGINAL<<8)|\
1048 (IEC958_AES1_CON_PCM_CODER<<8)|\
1049 (IEC958_AES3_CON_FS_48000<<24))
1050
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001051#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1052
Takashi Iwai6e5265e2009-09-08 14:26:51 +02001053const char *snd_pcm_format_name(snd_pcm_format_t format);
1054
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055#endif /* __SOUND_PCM_H */