blob: 31243033a9b6aab4e339629c142f8d93de7893d4 [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);
Santosh Mardic4fac022012-10-09 10:32:42 +053083 int (*restart)(struct snd_pcm_substream *substream);
Takashi Iwai877211f2005-11-17 13:59:38 +010084};
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86/*
87 *
88 */
89
Pawel MOLLf90c06a2008-07-30 12:46:40 +010090#if defined(CONFIG_SND_DYNAMIC_MINORS)
91#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
92#else
93#define SNDRV_PCM_DEVICES 8
94#endif
Jaroslav Kysela896e6cc2008-08-01 13:36:04 +020095
Linus Torvalds1da177e2005-04-16 15:20:36 -070096#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
97#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
98
99#define SNDRV_PCM_IOCTL1_RESET 0
100#define SNDRV_PCM_IOCTL1_INFO 1
101#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
102#define SNDRV_PCM_IOCTL1_GSTATE 3
Jaroslav Kysela8bea8692009-04-27 09:44:40 +0200103#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105#define SNDRV_PCM_TRIGGER_STOP 0
106#define SNDRV_PCM_TRIGGER_START 1
107#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
108#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
109#define SNDRV_PCM_TRIGGER_SUSPEND 5
110#define SNDRV_PCM_TRIGGER_RESUME 6
111
112#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
113
Santosh Mardic4fac022012-10-09 10:32:42 +0530114#define SNDRV_DMA_MODE (0)
115#define SNDRV_NON_DMA_MODE (1 << 0)
116#define SNDRV_RENDER_STOPPED (1 << 1)
117#define SNDRV_RENDER_RUNNING (1 << 2)
118
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120/* If you change this don't forget to change rates[] table in pcm_native.c */
121#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
122#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
123#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
124#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
125#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
126#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
127#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
128#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
129#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
130#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
131#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
132#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
133#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
134
135#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
136#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
137
138#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
139 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
140 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
141#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
142#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
143 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
144#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
145 SNDRV_PCM_RATE_192000)
Clemens Ladischfea952e2011-02-14 11:00:47 +0100146#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
147#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
148#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
149#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
150#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
151#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
152#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
153#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
154#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
155#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
156#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
157#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
158#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
159#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
160#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
161#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
162#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
163#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
164#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
165#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
166#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
167#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
168#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
169#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
170#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
171#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
172#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
173#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
174#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
175#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
176#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
177#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
178#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
179#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
180#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
181#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
182#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
183#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
184#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
185#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
186#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
187#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
188#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190#ifdef SNDRV_LITTLE_ENDIAN
191#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
192#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
193#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
194#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
195#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
196#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
197#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
198#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
199#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
200#endif
201#ifdef SNDRV_BIG_ENDIAN
202#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
203#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
204#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
205#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
206#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
207#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
208#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
209#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
210#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
211#endif
212
Takashi Iwai877211f2005-11-17 13:59:38 +0100213struct snd_pcm_file {
214 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200215 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216};
217
Takashi Iwai877211f2005-11-17 13:59:38 +0100218struct snd_pcm_hw_rule;
219typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
220 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwai877211f2005-11-17 13:59:38 +0100222struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 unsigned int cond;
224 snd_pcm_hw_rule_func_t func;
225 int var;
226 int deps[4];
227 void *private;
228};
229
Takashi Iwai877211f2005-11-17 13:59:38 +0100230struct snd_pcm_hw_constraints {
231 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100233 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
235 unsigned int rules_num;
236 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100237 struct snd_pcm_hw_rule *rules;
238};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Takashi Iwai877211f2005-11-17 13:59:38 +0100240static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
241 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242{
243 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
244}
245
Takashi Iwai877211f2005-11-17 13:59:38 +0100246static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
247 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
249 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
250}
251
Takashi Iwai877211f2005-11-17 13:59:38 +0100252struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 unsigned int num;
254 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100255};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
Takashi Iwai877211f2005-11-17 13:59:38 +0100257struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 unsigned int num_min, num_max, num_step;
259 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100260};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Takashi Iwai877211f2005-11-17 13:59:38 +0100262struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100264 struct snd_ratnum *rats;
265};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Takashi Iwai877211f2005-11-17 13:59:38 +0100267struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100269 struct snd_ratden *rats;
270};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Takashi Iwai877211f2005-11-17 13:59:38 +0100272struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 unsigned int count;
274 unsigned int *list;
275 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100276};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100278struct snd_pcm_hwptr_log;
279
Takashi Iwai877211f2005-11-17 13:59:38 +0100280struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100282 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200283 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 int overrange;
285 snd_pcm_uframes_t avail_max;
286 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100287 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200288 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200289 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
Takashi Iwai4bbe1dd2008-10-13 03:07:14 +0200290 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 /* -- HW params -- */
293 snd_pcm_access_t access; /* access mode */
294 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
295 snd_pcm_subformat_t subformat; /* subformat */
296 unsigned int rate; /* rate in Hz */
297 unsigned int channels; /* channels */
298 snd_pcm_uframes_t period_size; /* period size */
299 unsigned int periods; /* periods */
300 snd_pcm_uframes_t buffer_size; /* buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 snd_pcm_uframes_t min_align; /* Min alignment for the format */
302 size_t byte_align;
303 unsigned int frame_bits;
304 unsigned int sample_bits;
305 unsigned int info;
306 unsigned int rate_num;
307 unsigned int rate_den;
Clemens Ladischab69a492010-11-15 10:46:23 +0100308 unsigned int no_period_wakeup: 1;
Santosh Mardic4fac022012-10-09 10:32:42 +0530309 unsigned int render_flag;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100312 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 unsigned int period_step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 snd_pcm_uframes_t start_threshold;
315 snd_pcm_uframes_t stop_threshold;
316 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
317 noise is nearest than this */
318 snd_pcm_uframes_t silence_size; /* Silence filling size */
319 snd_pcm_uframes_t boundary; /* pointers wrap point */
320
321 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
322 snd_pcm_uframes_t silence_filled; /* size filled with silence */
323
Takashi Iwai877211f2005-11-17 13:59:38 +0100324 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 /* -- mmap -- */
Takashi Iwai503fc852007-09-11 00:35:06 +0200327 struct snd_pcm_mmap_status *status;
328 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329
330 /* -- locking / scheduling -- */
David Dillow5daeba32010-06-27 00:13:20 +0200331 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
Jaroslav Kyselac91a9882010-01-21 10:32:15 +0100332 wait_queue_head_t sleep; /* poll sleep */
333 wait_queue_head_t tsleep; /* transfer sleep */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 struct fasync_struct *fasync;
335
336 /* -- private section -- */
337 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100338 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
340 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100341 struct snd_pcm_hardware hw;
342 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
344 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100345 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
346 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 /* -- timer -- */
349 unsigned int timer_resolution; /* timer resolution */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100350 int tstamp_type; /* timestamp type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
352 /* -- DMA -- */
353 unsigned char *dma_area; /* DMA area */
354 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
355 size_t dma_bytes; /* size of DMA area */
356
357 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
358
359#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
360 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100361 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362#endif
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100363
364#ifdef CONFIG_SND_PCM_XRUN_DEBUG
365 struct snd_pcm_hwptr_log *hwptr_log;
366#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367};
368
Takashi Iwai877211f2005-11-17 13:59:38 +0100369struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 spinlock_t lock;
371 struct list_head substreams;
372 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100373};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Clemens Ladische7373b72009-11-10 10:13:30 +0100375struct pid;
376
Takashi Iwai877211f2005-11-17 13:59:38 +0100377struct snd_pcm_substream {
378 struct snd_pcm *pcm;
379 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 void *private_data; /* copied from pcm->private_data */
381 int number;
382 char name[32]; /* substream name */
383 int stream; /* stream (direction) */
Jean Pihetcc749982011-08-25 15:35:12 +0200384 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 size_t buffer_bytes_max; /* limit ring buffer size */
386 struct snd_dma_buffer dma_buffer;
387 unsigned int dma_buf_id;
388 size_t dma_max;
389 /* -- hardware operations -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100390 struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100392 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100394 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 unsigned timer_running: 1; /* time is running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100397 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 /* -- linked substreams -- */
399 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100400 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
401 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200403 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200404 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200405 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200406 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200407 void (*pcm_release)(struct snd_pcm_substream *);
Clemens Ladische7373b72009-11-10 10:13:30 +0100408 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
410 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100411 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200413#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100414 struct snd_info_entry *proc_root;
415 struct snd_info_entry *proc_info_entry;
416 struct snd_info_entry *proc_hw_params_entry;
417 struct snd_info_entry *proc_sw_params_entry;
418 struct snd_info_entry *proc_status_entry;
419 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200420 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200421#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200423 unsigned int hw_opened: 1;
Liam Girdwoodad2581e2011-02-01 21:31:31 +0000424 unsigned int hw_no_buffer: 1; /* substream may not have a buffer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425};
426
Takashi Iwai0df63e42006-04-28 15:13:41 +0200427#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428
429
Takashi Iwai877211f2005-11-17 13:59:38 +0100430struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100432 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 /* -- substreams -- */
434 unsigned int substream_count;
435 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100436 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
438 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100439 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200441#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100442 struct snd_info_entry *proc_root;
443 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200444#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100446 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200448#endif
Subhash Chandra Bose Naripeddyff1e6252012-10-18 15:44:12 -0700449 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
Subhash Chandra Bose Naripeddy58f7b952013-04-25 19:32:52 -0700450 struct snd_kcontrol *vol_kctl; /* volume controls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451};
452
Takashi Iwai877211f2005-11-17 13:59:38 +0100453struct snd_pcm {
454 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100455 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100456 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 unsigned int info_flags;
458 unsigned short dev_class;
459 unsigned short dev_subclass;
460 char id[64];
461 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100462 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100463 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 wait_queue_head_t open_wait;
465 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100466 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200467 struct device *dev; /* actual hw device this belongs to */
Liam Girdwood414b0312012-02-08 20:33:31 +0000468 bool internal; /* pcm is for internal use only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100470 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471#endif
472};
473
Takashi Iwai877211f2005-11-17 13:59:38 +0100474struct snd_pcm_notify {
475 int (*n_register) (struct snd_pcm * pcm);
476 int (*n_disconnect) (struct snd_pcm * pcm);
477 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100479};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
481/*
482 * Registering
483 */
484
Arjan van de Ven54047322007-02-12 00:55:28 -0800485extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
Tim Blechmanne6161652009-02-05 13:01:54 +0100487int snd_pcm_new(struct snd_card *card, const char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100489 struct snd_pcm **rpcm);
Steve Mucklef132c6c2012-06-06 18:30:57 -0700490int snd_pcm_new_soc_be(struct snd_card *card, const char *id, int device,
Liam Girdwood945e5032012-02-08 20:33:31 +0000491 int playback_count, int capture_count,
Steve Mucklef132c6c2012-06-06 18:30:57 -0700492 struct snd_pcm ** rpcm);
Liam Girdwood414b0312012-02-08 20:33:31 +0000493int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
494 int playback_count, int capture_count,
495 struct snd_pcm **rpcm);
Takashi Iwai877211f2005-11-17 13:59:38 +0100496int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Takashi Iwai877211f2005-11-17 13:59:38 +0100498int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499
500/*
501 * Native I/O
502 */
503
504extern rwlock_t snd_pcm_link_rwlock;
505
Takashi Iwai877211f2005-11-17 13:59:38 +0100506int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
507int snd_pcm_info_user(struct snd_pcm_substream *substream,
508 struct snd_pcm_info __user *info);
509int snd_pcm_status(struct snd_pcm_substream *substream,
510 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100511int snd_pcm_start(struct snd_pcm_substream *substream);
Clemens Ladischfea952e2011-02-14 11:00:47 +0100512int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100513int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100515int snd_pcm_suspend(struct snd_pcm_substream *substream);
516int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100518int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200519int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
520 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100521void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200522int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
523 struct snd_pcm_substream **rsubstream);
524void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100526int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200528
529#ifdef CONFIG_SND_DEBUG
530void snd_pcm_debug_name(struct snd_pcm_substream *substream,
531 char *name, size_t len);
532#else
533static inline void
534snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
535{
536 *buf = 0;
537}
538#endif
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540/*
541 * PCM library
542 */
543
Takashi Iwai877211f2005-11-17 13:59:38 +0100544static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
546 return substream->group != &substream->self_group;
547}
548
Takashi Iwai877211f2005-11-17 13:59:38 +0100549static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550{
551 read_lock(&snd_pcm_link_rwlock);
552 spin_lock(&substream->self_group.lock);
553}
554
Takashi Iwai877211f2005-11-17 13:59:38 +0100555static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 spin_unlock(&substream->self_group.lock);
558 read_unlock(&snd_pcm_link_rwlock);
559}
560
Takashi Iwai877211f2005-11-17 13:59:38 +0100561static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
563 read_lock_irq(&snd_pcm_link_rwlock);
564 spin_lock(&substream->self_group.lock);
565}
566
Takashi Iwai877211f2005-11-17 13:59:38 +0100567static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568{
569 spin_unlock(&substream->self_group.lock);
570 read_unlock_irq(&snd_pcm_link_rwlock);
571}
572
573#define snd_pcm_stream_lock_irqsave(substream, flags) \
574do { \
575 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
576 spin_lock(&substream->self_group.lock); \
577} while (0)
578
579#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
580do { \
581 spin_unlock(&substream->self_group.lock); \
582 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
583} while (0)
584
Takashi Iwaief991b92007-02-22 12:52:53 +0100585#define snd_pcm_group_for_each_entry(s, substream) \
586 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
Takashi Iwai877211f2005-11-17 13:59:38 +0100588static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
591 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
592 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
593}
594
Takashi Iwai877211f2005-11-17 13:59:38 +0100595static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596{
597 return size * 8 / runtime->sample_bits;
598}
599
Takashi Iwai877211f2005-11-17 13:59:38 +0100600static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601{
602 return size * 8 / runtime->frame_bits;
603}
604
Takashi Iwai877211f2005-11-17 13:59:38 +0100605static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606{
607 return size * runtime->sample_bits / 8;
608}
609
Takashi Iwai877211f2005-11-17 13:59:38 +0100610static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
612 return size * runtime->frame_bits / 8;
613}
614
Takashi Iwai877211f2005-11-17 13:59:38 +0100615static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
617 return bytes % runtime->byte_align == 0;
618}
619
Takashi Iwai877211f2005-11-17 13:59:38 +0100620static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Takashi Iwai877211f2005-11-17 13:59:38 +0100622 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 return frames_to_bytes(runtime, runtime->buffer_size);
624}
625
Takashi Iwai877211f2005-11-17 13:59:38 +0100626static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627{
Takashi Iwai877211f2005-11-17 13:59:38 +0100628 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 return frames_to_bytes(runtime, runtime->period_size);
630}
631
632/*
633 * result is: 0 ... (boundary - 1)
634 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100635static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636{
637 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
638 if (avail < 0)
639 avail += runtime->boundary;
640 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
641 avail -= runtime->boundary;
642 return avail;
643}
644
645/*
646 * result is: 0 ... (boundary - 1)
647 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100648static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
650 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
651 if (avail < 0)
652 avail += runtime->boundary;
653 return avail;
654}
655
Takashi Iwai877211f2005-11-17 13:59:38 +0100656static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657{
658 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
659}
660
Takashi Iwai877211f2005-11-17 13:59:38 +0100661static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662{
663 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
664}
665
666/**
667 * snd_pcm_playback_ready - check whether the playback buffer is available
668 * @substream: the pcm substream instance
669 *
670 * Checks whether enough free space is available on the playback 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_playback_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_playback_avail(runtime) >= runtime->control->avail_min;
678}
679
680/**
681 * snd_pcm_capture_ready - check whether the capture buffer is available
682 * @substream: the pcm substream instance
683 *
684 * Checks whether enough capture data is available on the capture buffer.
685 *
686 * Returns non-zero if available, or zero if not.
687 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100688static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689{
Takashi Iwai877211f2005-11-17 13:59:38 +0100690 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
692}
693
694/**
695 * snd_pcm_playback_data - check whether any data exists on the playback buffer
696 * @substream: the pcm substream instance
697 *
698 * Checks whether any data exists on the playback buffer. If stop_threshold
699 * is bigger or equal to boundary, then this function returns always non-zero.
700 *
701 * Returns non-zero if exists, or zero if not.
702 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100703static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Takashi Iwai877211f2005-11-17 13:59:38 +0100705 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
707 if (runtime->stop_threshold >= runtime->boundary)
708 return 1;
709 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
710}
711
712/**
713 * snd_pcm_playback_empty - check whether the playback buffer is empty
714 * @substream: the pcm substream instance
715 *
716 * Checks whether the playback 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_playback_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_playback_avail(runtime) >= runtime->buffer_size;
724}
725
726/**
727 * snd_pcm_capture_empty - check whether the capture buffer is empty
728 * @substream: the pcm substream instance
729 *
730 * Checks whether the capture buffer is empty.
731 *
732 * Returns non-zero if empty, or zero if not.
733 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100734static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735{
Takashi Iwai877211f2005-11-17 13:59:38 +0100736 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 return snd_pcm_capture_avail(runtime) == 0;
738}
739
Takashi Iwai877211f2005-11-17 13:59:38 +0100740static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
741 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742{
743 substream->runtime->trigger_master = master;
744}
745
746static inline int hw_is_mask(int var)
747{
748 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
749 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
750}
751
752static inline int hw_is_interval(int var)
753{
754 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
755 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
756}
757
Takashi Iwai877211f2005-11-17 13:59:38 +0100758static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 snd_pcm_hw_param_t var)
760{
761 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
762}
763
Takashi Iwai877211f2005-11-17 13:59:38 +0100764static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765 snd_pcm_hw_param_t var)
766{
767 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
768}
769
Takashi Iwai877211f2005-11-17 13:59:38 +0100770static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 snd_pcm_hw_param_t var)
772{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200773 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774}
775
Takashi Iwai877211f2005-11-17 13:59:38 +0100776static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 snd_pcm_hw_param_t var)
778{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200779 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780}
781
Takashi Iwaib51beb72011-07-26 12:02:56 +0200782#define params_channels(p) \
783 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
784#define params_rate(p) \
785 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
786#define params_period_size(p) \
787 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
788#define params_periods(p) \
789 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
790#define params_buffer_size(p) \
791 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
792#define params_buffer_bytes(p) \
793 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Takashi Iwai877211f2005-11-17 13:59:38 +0100795int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
796void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
797void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
798void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
799 unsigned int k, struct snd_interval *c);
800void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
801 const struct snd_interval *b, struct snd_interval *c);
802int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
803int snd_interval_ratnum(struct snd_interval *i,
804 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 unsigned int *nump, unsigned int *denp);
806
Takashi Iwai877211f2005-11-17 13:59:38 +0100807void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
808void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100809int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Takashi Iwai877211f2005-11-17 13:59:38 +0100811int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812
Takashi Iwai877211f2005-11-17 13:59:38 +0100813int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
814int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
Takashi Iwai877211f2005-11-17 13:59:38 +0100816int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100818int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100820int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100822int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
823int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 unsigned int cond,
825 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100826 struct snd_pcm_hw_constraint_list *l);
827int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 unsigned int cond,
829 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100830 struct snd_pcm_hw_constraint_ratnums *r);
831int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 unsigned int cond,
833 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100834 struct snd_pcm_hw_constraint_ratdens *r);
835int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 unsigned int cond,
837 unsigned int width,
838 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100839int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 unsigned int cond,
841 snd_pcm_hw_param_t var,
842 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100843int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 unsigned int cond,
845 snd_pcm_hw_param_t var);
Clemens Ladischd5b702a2011-09-16 23:03:02 +0200846int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
847 unsigned int base_rate);
Takashi Iwai877211f2005-11-17 13:59:38 +0100848int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 unsigned int cond,
850 int var,
851 snd_pcm_hw_rule_func_t func, void *private,
852 int dep, ...);
853
854int snd_pcm_format_signed(snd_pcm_format_t format);
855int snd_pcm_format_unsigned(snd_pcm_format_t format);
856int snd_pcm_format_linear(snd_pcm_format_t format);
857int snd_pcm_format_little_endian(snd_pcm_format_t format);
858int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200859#if 0 /* just for DocBook */
860/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200861 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
862 * @format: the format to check
863 *
864 * Returns 1 if the given PCM format is CPU-endian, 0 if
865 * opposite, or a negative error code if endian not specified.
866 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200867int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200868#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200869#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700870#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200871#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700872#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200873#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
875int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200876ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
878int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
879snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880
Takashi Iwai877211f2005-11-17 13:59:38 +0100881void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
882void snd_pcm_set_sync(struct snd_pcm_substream *substream);
883int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
884int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 unsigned int cmd, void *arg);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100886int snd_pcm_update_state(struct snd_pcm_substream *substream,
887 struct snd_pcm_runtime *runtime);
Takashi Iwai877211f2005-11-17 13:59:38 +0100888int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
889int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
890int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
891int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
892int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
893void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
Takashi Iwai877211f2005-11-17 13:59:38 +0100894void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
895snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 const void __user *buf,
897 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100898snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100900snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100902snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 void __user **bufs, snd_pcm_uframes_t frames);
904
Clemens Ladisch7653d552007-08-13 17:38:54 +0200905extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
906
Takashi Iwai877211f2005-11-17 13:59:38 +0100907int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200908unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Takashi Iwai877211f2005-11-17 13:59:38 +0100910static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 struct snd_dma_buffer *bufp)
912{
Takashi Iwai877211f2005-11-17 13:59:38 +0100913 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 if (bufp) {
915 runtime->dma_buffer_p = bufp;
916 runtime->dma_area = bufp->area;
917 runtime->dma_addr = bufp->addr;
918 runtime->dma_bytes = bufp->bytes;
919 } else {
920 runtime->dma_buffer_p = NULL;
921 runtime->dma_area = NULL;
922 runtime->dma_addr = 0;
923 runtime->dma_bytes = 0;
924 }
925}
926
927/*
928 * Timer interface
929 */
930
Takashi Iwai877211f2005-11-17 13:59:38 +0100931void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
932void snd_pcm_timer_init(struct snd_pcm_substream *substream);
933void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100935static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
936 struct timespec *tv)
937{
938 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
939 do_posix_clock_monotonic_gettime(tv);
940 else
941 getnstimeofday(tv);
942}
943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944/*
945 * Memory
946 */
947
Takashi Iwai877211f2005-11-17 13:59:38 +0100948int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
949int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
950int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 int type, struct device *data,
952 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100953int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 int type, void *data,
955 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100956int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
957int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100959int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
960 size_t size, gfp_t gfp_flags);
961int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
962struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
963 unsigned long offset);
964#if 0 /* for kernel-doc */
965/**
966 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
967 * @substream: the substream to allocate the buffer to
968 * @size: the requested buffer size, in bytes
969 *
970 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
971 * contiguous in kernel virtual space, but not in physical memory. Use this
972 * if the buffer is accessed by kernel code but not by device DMA.
973 *
974 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
975 * code.
976 */
977static int snd_pcm_lib_alloc_vmalloc_buffer
978 (struct snd_pcm_substream *substream, size_t size);
979/**
980 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
981 * @substream: the substream to allocate the buffer to
982 * @size: the requested buffer size, in bytes
983 *
984 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
985 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
986 */
987static int snd_pcm_lib_alloc_vmalloc_32_buffer
988 (struct snd_pcm_substream *substream, size_t size);
989#endif
990#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
991 _snd_pcm_lib_alloc_vmalloc_buffer \
992 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
993#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
994 _snd_pcm_lib_alloc_vmalloc_buffer \
995 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
996
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +0200997#ifdef CONFIG_SND_DMA_SGBUF
Takashi Iwai77a23f22008-08-21 13:00:13 +0200998/*
999 * SG-buffer handling
1000 */
1001#define snd_pcm_substream_sgbuf(substream) \
1002 ((substream)->runtime->dma_buffer_p->private_data)
1003
1004static inline dma_addr_t
1005snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1006{
1007 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
1008 return snd_sgbuf_get_addr(sg, ofs);
1009}
1010
1011static inline void *
1012snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1013{
1014 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
1015 return snd_sgbuf_get_ptr(sg, ofs);
1016}
1017
1018struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1019 unsigned long offset);
Takashi Iwai51e9f2e2008-07-30 15:13:33 +02001020unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1021 unsigned int ofs, unsigned int size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001023#else /* !SND_DMA_SGBUF */
1024/*
1025 * fake using a continuous buffer
1026 */
1027static inline dma_addr_t
1028snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1029{
1030 return substream->runtime->dma_addr + ofs;
1031}
1032
1033static inline void *
1034snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1035{
1036 return substream->runtime->dma_area + ofs;
1037}
1038
1039#define snd_pcm_sgbuf_ops_page NULL
1040
1041#define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
1042
1043#endif /* SND_DMA_SGBUF */
1044
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045/* handle mmap counter - PCM mmap callback should handle this counter properly */
1046static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1047{
Takashi Iwai877211f2005-11-17 13:59:38 +01001048 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001049 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050}
1051
1052static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1053{
Takashi Iwai877211f2005-11-17 13:59:38 +01001054 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001055 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056}
1057
Takashi Iwai18a2b962011-09-28 17:12:59 +02001058int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1059 struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060/* mmap for io-memory area */
1061#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1062#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001063int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064#else
1065#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1066#define snd_pcm_lib_mmap_iomem NULL
1067#endif
1068
Benjamin Herrenschmidt3674f192011-03-25 17:51:54 +11001069#define snd_pcm_lib_mmap_vmalloc NULL
Takashi Iwaic32d9772010-01-18 14:58:57 +01001070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1072{
1073 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1074}
1075
1076/*
1077 * Misc
1078 */
1079
1080#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1081 (IEC958_AES1_CON_ORIGINAL<<8)|\
1082 (IEC958_AES1_CON_PCM_CODER<<8)|\
1083 (IEC958_AES3_CON_FS_48000<<24))
1084
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001085#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1086
Takashi Iwai6e5265e2009-09-08 14:26:51 +02001087const char *snd_pcm_format_name(snd_pcm_format_t format);
1088
Subhash Chandra Bose Naripeddyff1e6252012-10-18 15:44:12 -07001089/*
1090 * PCM channel-mapping control API
1091 */
1092/* array element of channel maps */
1093struct snd_pcm_chmap_elem {
1094 unsigned char channels;
1095 unsigned char map[15];
1096};
1097
1098/* channel map information; retrieved via snd_kcontrol_chip() */
1099struct snd_pcm_chmap {
1100 struct snd_pcm *pcm; /* assigned PCM instance */
1101 int stream; /* PLAYBACK or CAPTURE */
1102 struct snd_kcontrol *kctl;
1103 const struct snd_pcm_chmap_elem *chmap;
1104 unsigned int max_channels;
1105 unsigned int channel_mask; /* optional: active channels bitmask */
1106 void *private_data; /* optional: private data pointer */
1107};
1108
1109/* get the PCM substream assigned to the given chmap info */
1110static inline struct snd_pcm_substream *
1111snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1112{
1113 struct snd_pcm_substream *s;
1114 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1115 if (s->number == idx)
1116 return s;
1117 return NULL;
1118}
1119
1120/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1121extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1122/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1123extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1124
1125/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1126#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1127#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1128#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1129
1130int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1131 const struct snd_pcm_chmap_elem *chmap,
1132 int max_channels,
1133 unsigned long private_value,
1134 struct snd_pcm_chmap **info_ret);
1135
Subhash Chandra Bose Naripeddy58f7b952013-04-25 19:32:52 -07001136/*
1137 * PCM Volume control API
1138 */
1139/* array element of volume */
1140struct snd_pcm_volume_elem {
1141 int volume;
1142};
1143
1144/* pp information; retrieved via snd_kcontrol_chip() */
1145struct snd_pcm_volume {
1146 struct snd_pcm *pcm; /* assigned PCM instance */
1147 int stream; /* PLAYBACK or CAPTURE */
1148 struct snd_kcontrol *kctl;
1149 const struct snd_pcm_volume_elem *volume;
1150 int max_length;
1151 void *private_data; /* optional: private data pointer */
1152};
1153
1154int snd_pcm_add_volume_ctls(struct snd_pcm *pcm, int stream,
1155 const struct snd_pcm_volume_elem *volume,
1156 int max_length,
1157 unsigned long private_value,
1158 struct snd_pcm_volume **info_ret);
1159
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160#endif /* __SOUND_PCM_H */