blob: 84b10f9a28324951a2a56d1cc89df9d50e0623bb [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)
David Howellsa1ce3922012-10-02 18:01:25 +010038#include <sound/pcm_oss.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#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);
Pierre-Louis Bossart4eeaaea2012-10-22 16:42:15 -050074 int (*wall_clock)(struct snd_pcm_substream *substream,
75 struct timespec *audio_ts);
Takashi Iwai877211f2005-11-17 13:59:38 +010076 int (*copy)(struct snd_pcm_substream *substream, int channel,
77 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010079 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010081 struct page *(*page)(struct snd_pcm_substream *substream,
82 unsigned long offset);
83 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
84 int (*ack)(struct snd_pcm_substream *substream);
85};
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87/*
88 *
89 */
90
Pawel MOLLf90c06a2008-07-30 12:46:40 +010091#if defined(CONFIG_SND_DYNAMIC_MINORS)
92#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
93#else
94#define SNDRV_PCM_DEVICES 8
95#endif
Jaroslav Kysela896e6cc2008-08-01 13:36:04 +020096
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
98#define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
99
100#define SNDRV_PCM_IOCTL1_RESET 0
101#define SNDRV_PCM_IOCTL1_INFO 1
102#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
103#define SNDRV_PCM_IOCTL1_GSTATE 3
Jaroslav Kysela8bea8692009-04-27 09:44:40 +0200104#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106#define SNDRV_PCM_TRIGGER_STOP 0
107#define SNDRV_PCM_TRIGGER_START 1
108#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
109#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
110#define SNDRV_PCM_TRIGGER_SUSPEND 5
111#define SNDRV_PCM_TRIGGER_RESUME 6
112
113#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
114
115/* If you change this don't forget to change rates[] table in pcm_native.c */
116#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
117#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
118#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
119#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
120#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
121#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
122#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
123#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
124#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
125#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
126#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
127#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
128#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
129
130#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
131#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
132
133#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
134 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
135 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
136#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
137#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
138 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
139#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
140 SNDRV_PCM_RATE_192000)
Clemens Ladischfea952e2011-02-14 11:00:47 +0100141#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
142#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
143#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
144#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
145#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
146#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
147#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
148#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
149#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
150#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
151#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
152#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
153#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
154#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
155#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
156#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
157#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
158#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
159#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
160#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
161#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
162#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
163#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
164#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
165#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
166#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
167#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
168#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
169#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
170#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
171#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
172#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
173#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
174#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
175#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
176#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
177#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
178#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
179#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
180#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
181#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
182#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
183#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
Daniel Mackef7a4f92013-04-17 00:01:36 +0800184#define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
185#define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187#ifdef SNDRV_LITTLE_ENDIAN
188#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
189#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
190#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
191#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
192#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
193#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
194#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
195#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
196#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
197#endif
198#ifdef SNDRV_BIG_ENDIAN
199#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
200#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
201#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
202#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
203#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
204#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
205#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
206#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
207#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
208#endif
209
Takashi Iwai877211f2005-11-17 13:59:38 +0100210struct snd_pcm_file {
211 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200212 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214
Takashi Iwai877211f2005-11-17 13:59:38 +0100215struct snd_pcm_hw_rule;
216typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
217 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Takashi Iwai877211f2005-11-17 13:59:38 +0100219struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 unsigned int cond;
221 snd_pcm_hw_rule_func_t func;
222 int var;
223 int deps[4];
224 void *private;
225};
226
Takashi Iwai877211f2005-11-17 13:59:38 +0100227struct snd_pcm_hw_constraints {
228 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100230 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
232 unsigned int rules_num;
233 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100234 struct snd_pcm_hw_rule *rules;
235};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Takashi Iwai877211f2005-11-17 13:59:38 +0100237static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
238 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
240 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
241}
242
Takashi Iwai877211f2005-11-17 13:59:38 +0100243static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
244 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
247}
248
Takashi Iwai877211f2005-11-17 13:59:38 +0100249struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 unsigned int num;
251 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100252};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Takashi Iwai877211f2005-11-17 13:59:38 +0100254struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 unsigned int num_min, num_max, num_step;
256 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100257};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Takashi Iwai877211f2005-11-17 13:59:38 +0100259struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100261 struct snd_ratnum *rats;
262};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Takashi Iwai877211f2005-11-17 13:59:38 +0100264struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100266 struct snd_ratden *rats;
267};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Takashi Iwai877211f2005-11-17 13:59:38 +0100269struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 unsigned int count;
Mark Brown4af87a92012-03-14 19:48:43 +0000271 const unsigned int *list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100273};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100275struct snd_pcm_hwptr_log;
276
Takashi Iwai877211f2005-11-17 13:59:38 +0100277struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100279 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200280 struct timespec trigger_tstamp; /* trigger timestamp */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 int overrange;
282 snd_pcm_uframes_t avail_max;
283 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100284 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200285 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200286 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
Takashi Iwai4bbe1dd2008-10-13 03:07:14 +0200287 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500288 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
290 /* -- HW params -- */
291 snd_pcm_access_t access; /* access mode */
292 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
293 snd_pcm_subformat_t subformat; /* subformat */
294 unsigned int rate; /* rate in Hz */
295 unsigned int channels; /* channels */
296 snd_pcm_uframes_t period_size; /* period size */
297 unsigned int periods; /* periods */
298 snd_pcm_uframes_t buffer_size; /* buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 snd_pcm_uframes_t min_align; /* Min alignment for the format */
300 size_t byte_align;
301 unsigned int frame_bits;
302 unsigned int sample_bits;
303 unsigned int info;
304 unsigned int rate_num;
305 unsigned int rate_den;
Clemens Ladischab69a492010-11-15 10:46:23 +0100306 unsigned int no_period_wakeup: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
308 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100309 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 unsigned int period_step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 snd_pcm_uframes_t start_threshold;
312 snd_pcm_uframes_t stop_threshold;
313 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
314 noise is nearest than this */
315 snd_pcm_uframes_t silence_size; /* Silence filling size */
316 snd_pcm_uframes_t boundary; /* pointers wrap point */
317
318 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
319 snd_pcm_uframes_t silence_filled; /* size filled with silence */
320
Takashi Iwai877211f2005-11-17 13:59:38 +0100321 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323 /* -- mmap -- */
Takashi Iwai503fc852007-09-11 00:35:06 +0200324 struct snd_pcm_mmap_status *status;
325 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326
327 /* -- locking / scheduling -- */
David Dillow5daeba32010-06-27 00:13:20 +0200328 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
Jaroslav Kyselac91a9882010-01-21 10:32:15 +0100329 wait_queue_head_t sleep; /* poll sleep */
330 wait_queue_head_t tsleep; /* transfer sleep */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 struct fasync_struct *fasync;
332
333 /* -- private section -- */
334 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100335 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
337 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100338 struct snd_pcm_hardware hw;
339 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100342 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
343 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
345 /* -- timer -- */
346 unsigned int timer_resolution; /* timer resolution */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100347 int tstamp_type; /* timestamp type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 /* -- DMA -- */
350 unsigned char *dma_area; /* DMA area */
351 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
352 size_t dma_bytes; /* size of DMA area */
353
354 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
355
356#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
357 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100358 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359#endif
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100360
361#ifdef CONFIG_SND_PCM_XRUN_DEBUG
362 struct snd_pcm_hwptr_log *hwptr_log;
363#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364};
365
Takashi Iwai877211f2005-11-17 13:59:38 +0100366struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 spinlock_t lock;
368 struct list_head substreams;
369 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100370};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Clemens Ladische7373b72009-11-10 10:13:30 +0100372struct pid;
373
Takashi Iwai877211f2005-11-17 13:59:38 +0100374struct snd_pcm_substream {
375 struct snd_pcm *pcm;
376 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 void *private_data; /* copied from pcm->private_data */
378 int number;
379 char name[32]; /* substream name */
380 int stream; /* stream (direction) */
Jean Pihetcc749982011-08-25 15:35:12 +0200381 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 size_t buffer_bytes_max; /* limit ring buffer size */
383 struct snd_dma_buffer dma_buffer;
384 unsigned int dma_buf_id;
385 size_t dma_max;
386 /* -- hardware operations -- */
Lars-Peter Clausene6c2e7e2013-05-24 15:18:10 +0200387 const struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100389 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100391 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 unsigned timer_running: 1; /* time is running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100394 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 /* -- linked substreams -- */
396 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100397 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
398 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200400 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200401 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200402 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200403 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200404 void (*pcm_release)(struct snd_pcm_substream *);
Clemens Ladische7373b72009-11-10 10:13:30 +0100405 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
407 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100408 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200410#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100411 struct snd_info_entry *proc_root;
412 struct snd_info_entry *proc_info_entry;
413 struct snd_info_entry *proc_hw_params_entry;
414 struct snd_info_entry *proc_sw_params_entry;
415 struct snd_info_entry *proc_status_entry;
416 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200417 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200418#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200420 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421};
422
Takashi Iwai0df63e42006-04-28 15:13:41 +0200423#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
425
Takashi Iwai877211f2005-11-17 13:59:38 +0100426struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100428 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 /* -- substreams -- */
430 unsigned int substream_count;
431 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100432 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
434 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100435 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200437#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100438 struct snd_info_entry *proc_root;
439 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200440#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100442 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200444#endif
Takashi Iwai2d3391e2012-07-27 18:27:00 +0200445 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446};
447
Takashi Iwai877211f2005-11-17 13:59:38 +0100448struct snd_pcm {
449 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100450 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100451 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 unsigned int info_flags;
453 unsigned short dev_class;
454 unsigned short dev_subclass;
455 char id[64];
456 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100457 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100458 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 wait_queue_head_t open_wait;
460 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100461 void (*private_free) (struct snd_pcm *pcm);
Johannes Bergc78085f2006-10-05 15:06:34 +0200462 struct device *dev; /* actual hw device this belongs to */
Liam Girdwood945e5032012-02-08 20:33:31 +0000463 bool internal; /* pcm is for internal use only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100465 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466#endif
467};
468
Takashi Iwai877211f2005-11-17 13:59:38 +0100469struct snd_pcm_notify {
470 int (*n_register) (struct snd_pcm * pcm);
471 int (*n_disconnect) (struct snd_pcm * pcm);
472 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100474};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476/*
477 * Registering
478 */
479
Arjan van de Ven54047322007-02-12 00:55:28 -0800480extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
Tim Blechmanne6161652009-02-05 13:01:54 +0100482int snd_pcm_new(struct snd_card *card, const char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100484 struct snd_pcm **rpcm);
Liam Girdwood945e5032012-02-08 20:33:31 +0000485int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
486 int playback_count, int capture_count,
487 struct snd_pcm **rpcm);
Takashi Iwai877211f2005-11-17 13:59:38 +0100488int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Takashi Iwai877211f2005-11-17 13:59:38 +0100490int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492/*
493 * Native I/O
494 */
495
496extern rwlock_t snd_pcm_link_rwlock;
497
Takashi Iwai877211f2005-11-17 13:59:38 +0100498int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
499int snd_pcm_info_user(struct snd_pcm_substream *substream,
500 struct snd_pcm_info __user *info);
501int snd_pcm_status(struct snd_pcm_substream *substream,
502 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100503int snd_pcm_start(struct snd_pcm_substream *substream);
Clemens Ladischfea952e2011-02-14 11:00:47 +0100504int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100505int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100507int snd_pcm_suspend(struct snd_pcm_substream *substream);
508int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100510int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200511int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
512 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100513void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200514int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
515 struct snd_pcm_substream **rsubstream);
516void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517void snd_pcm_vma_notify_data(void *client, void *data);
Takashi Iwai877211f2005-11-17 13:59:38 +0100518int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200520
521#ifdef CONFIG_SND_DEBUG
522void snd_pcm_debug_name(struct snd_pcm_substream *substream,
523 char *name, size_t len);
524#else
525static inline void
526snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
527{
528 *buf = 0;
529}
530#endif
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532/*
533 * PCM library
534 */
535
Takashi Iwai877211f2005-11-17 13:59:38 +0100536static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537{
538 return substream->group != &substream->self_group;
539}
540
Takashi Iwai877211f2005-11-17 13:59:38 +0100541static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 read_lock(&snd_pcm_link_rwlock);
544 spin_lock(&substream->self_group.lock);
545}
546
Takashi Iwai877211f2005-11-17 13:59:38 +0100547static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548{
549 spin_unlock(&substream->self_group.lock);
550 read_unlock(&snd_pcm_link_rwlock);
551}
552
Takashi Iwai877211f2005-11-17 13:59:38 +0100553static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554{
555 read_lock_irq(&snd_pcm_link_rwlock);
556 spin_lock(&substream->self_group.lock);
557}
558
Takashi Iwai877211f2005-11-17 13:59:38 +0100559static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
561 spin_unlock(&substream->self_group.lock);
562 read_unlock_irq(&snd_pcm_link_rwlock);
563}
564
565#define snd_pcm_stream_lock_irqsave(substream, flags) \
566do { \
567 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
568 spin_lock(&substream->self_group.lock); \
569} while (0)
570
571#define snd_pcm_stream_unlock_irqrestore(substream, flags) \
572do { \
573 spin_unlock(&substream->self_group.lock); \
574 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
575} while (0)
576
Takashi Iwaief991b92007-02-22 12:52:53 +0100577#define snd_pcm_group_for_each_entry(s, substream) \
578 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Takashi Iwai877211f2005-11-17 13:59:38 +0100580static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581{
582 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
583 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
584 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
585}
586
Takashi Iwai877211f2005-11-17 13:59:38 +0100587static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588{
589 return size * 8 / runtime->sample_bits;
590}
591
Takashi Iwai877211f2005-11-17 13:59:38 +0100592static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{
594 return size * 8 / runtime->frame_bits;
595}
596
Takashi Iwai877211f2005-11-17 13:59:38 +0100597static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
599 return size * runtime->sample_bits / 8;
600}
601
Takashi Iwai877211f2005-11-17 13:59:38 +0100602static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
604 return size * runtime->frame_bits / 8;
605}
606
Takashi Iwai877211f2005-11-17 13:59:38 +0100607static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608{
609 return bytes % runtime->byte_align == 0;
610}
611
Takashi Iwai877211f2005-11-17 13:59:38 +0100612static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Takashi Iwai877211f2005-11-17 13:59:38 +0100614 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 return frames_to_bytes(runtime, runtime->buffer_size);
616}
617
Takashi Iwai877211f2005-11-17 13:59:38 +0100618static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
Takashi Iwai877211f2005-11-17 13:59:38 +0100620 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 return frames_to_bytes(runtime, runtime->period_size);
622}
623
624/*
625 * result is: 0 ... (boundary - 1)
626 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100627static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
629 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
630 if (avail < 0)
631 avail += runtime->boundary;
632 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
633 avail -= runtime->boundary;
634 return avail;
635}
636
637/*
638 * result is: 0 ... (boundary - 1)
639 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100640static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
642 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
643 if (avail < 0)
644 avail += runtime->boundary;
645 return avail;
646}
647
Takashi Iwai877211f2005-11-17 13:59:38 +0100648static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649{
650 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
651}
652
Takashi Iwai877211f2005-11-17 13:59:38 +0100653static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654{
655 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
656}
657
658/**
659 * snd_pcm_playback_ready - check whether the playback buffer is available
660 * @substream: the pcm substream instance
661 *
662 * Checks whether enough free space is available on the playback buffer.
663 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100664 * Return: Non-zero if available, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100666static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667{
Takashi Iwai877211f2005-11-17 13:59:38 +0100668 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
670}
671
672/**
673 * snd_pcm_capture_ready - check whether the capture buffer is available
674 * @substream: the pcm substream instance
675 *
676 * Checks whether enough capture data is available on the capture buffer.
677 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100678 * Return: Non-zero if available, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100680static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
Takashi Iwai877211f2005-11-17 13:59:38 +0100682 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
684}
685
686/**
687 * snd_pcm_playback_data - check whether any data exists on the playback buffer
688 * @substream: the pcm substream instance
689 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100690 * Checks whether any data exists on the playback buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100692 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
693 * is bigger or equal to boundary, then this function returns always non-zero.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100695static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696{
Takashi Iwai877211f2005-11-17 13:59:38 +0100697 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
699 if (runtime->stop_threshold >= runtime->boundary)
700 return 1;
701 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
702}
703
704/**
705 * snd_pcm_playback_empty - check whether the playback buffer is empty
706 * @substream: the pcm substream instance
707 *
708 * Checks whether the playback buffer is empty.
709 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100710 * Return: Non-zero if empty, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100712static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Takashi Iwai877211f2005-11-17 13:59:38 +0100714 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
716}
717
718/**
719 * snd_pcm_capture_empty - check whether the capture buffer is empty
720 * @substream: the pcm substream instance
721 *
722 * Checks whether the capture buffer is empty.
723 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100724 * Return: Non-zero if empty, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100726static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727{
Takashi Iwai877211f2005-11-17 13:59:38 +0100728 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 return snd_pcm_capture_avail(runtime) == 0;
730}
731
Takashi Iwai877211f2005-11-17 13:59:38 +0100732static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
733 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
735 substream->runtime->trigger_master = master;
736}
737
738static inline int hw_is_mask(int var)
739{
740 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
741 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
742}
743
744static inline int hw_is_interval(int var)
745{
746 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
747 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
748}
749
Takashi Iwai877211f2005-11-17 13:59:38 +0100750static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 snd_pcm_hw_param_t var)
752{
753 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
754}
755
Takashi Iwai877211f2005-11-17 13:59:38 +0100756static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 snd_pcm_hw_param_t var)
758{
759 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
760}
761
Takashi Iwai877211f2005-11-17 13:59:38 +0100762static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 snd_pcm_hw_param_t var)
764{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200765 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766}
767
Takashi Iwai877211f2005-11-17 13:59:38 +0100768static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 snd_pcm_hw_param_t var)
770{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200771 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772}
773
Takashi Iwaib51beb72011-07-26 12:02:56 +0200774#define params_channels(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
776#define params_rate(p) \
777 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
778#define params_period_size(p) \
779 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
780#define params_periods(p) \
781 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
782#define params_buffer_size(p) \
783 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
784#define params_buffer_bytes(p) \
785 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Takashi Iwai877211f2005-11-17 13:59:38 +0100787int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
788void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
789void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
790void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
791 unsigned int k, struct snd_interval *c);
792void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
793 const struct snd_interval *b, struct snd_interval *c);
Mark Brown4af87a92012-03-14 19:48:43 +0000794int snd_interval_list(struct snd_interval *i, unsigned int count,
795 const unsigned int *list, unsigned int mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100796int snd_interval_ratnum(struct snd_interval *i,
797 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 unsigned int *nump, unsigned int *denp);
799
Takashi Iwai877211f2005-11-17 13:59:38 +0100800void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
801void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100802int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Takashi Iwai877211f2005-11-17 13:59:38 +0100804int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Takashi Iwai877211f2005-11-17 13:59:38 +0100806int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
807int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Takashi Iwai877211f2005-11-17 13:59:38 +0100809int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100811int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100813int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100815int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
816int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 unsigned int cond,
818 snd_pcm_hw_param_t var,
Mark Brown14641892012-07-05 12:15:01 +0100819 const struct snd_pcm_hw_constraint_list *l);
Takashi Iwai877211f2005-11-17 13:59:38 +0100820int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 unsigned int cond,
822 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100823 struct snd_pcm_hw_constraint_ratnums *r);
824int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 unsigned int cond,
826 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +0100827 struct snd_pcm_hw_constraint_ratdens *r);
828int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 unsigned int cond,
830 unsigned int width,
831 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +0100832int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 unsigned int cond,
834 snd_pcm_hw_param_t var,
835 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +0100836int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 unsigned int cond,
838 snd_pcm_hw_param_t var);
Clemens Ladischd5b702a2011-09-16 23:03:02 +0200839int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
840 unsigned int base_rate);
Takashi Iwai877211f2005-11-17 13:59:38 +0100841int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 unsigned int cond,
843 int var,
844 snd_pcm_hw_rule_func_t func, void *private,
845 int dep, ...);
846
847int snd_pcm_format_signed(snd_pcm_format_t format);
848int snd_pcm_format_unsigned(snd_pcm_format_t format);
849int snd_pcm_format_linear(snd_pcm_format_t format);
850int snd_pcm_format_little_endian(snd_pcm_format_t format);
851int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200852#if 0 /* just for DocBook */
853/**
Takashi Iwai9502dca2005-05-18 16:25:46 +0200854 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
855 * @format: the format to check
856 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100857 * Return: 1 if the given PCM format is CPU-endian, 0 if
Takashi Iwai9502dca2005-05-18 16:25:46 +0200858 * opposite, or a negative error code if endian not specified.
859 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +0200860int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +0200861#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200862#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -0700863#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200864#else
Martin Waitz9d01a822005-09-09 13:10:17 -0700865#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +0200866#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
868int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +0200869ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
871int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
Masanari Iidab23f7a02013-04-18 00:12:55 +0900872snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Lars-Peter Clausene6c2e7e2013-05-24 15:18:10 +0200874void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
875 const struct snd_pcm_ops *ops);
Takashi Iwai877211f2005-11-17 13:59:38 +0100876void snd_pcm_set_sync(struct snd_pcm_substream *substream);
877int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
878int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 unsigned int cmd, void *arg);
Jaroslav Kysela12509322010-01-07 15:36:31 +0100880int snd_pcm_update_state(struct snd_pcm_substream *substream,
881 struct snd_pcm_runtime *runtime);
Takashi Iwai877211f2005-11-17 13:59:38 +0100882int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
883int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
884int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
885int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
886int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
887void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
Takashi Iwai877211f2005-11-17 13:59:38 +0100888void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
889snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 const void __user *buf,
891 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100892snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100894snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +0100896snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 void __user **bufs, snd_pcm_uframes_t frames);
898
Clemens Ladisch7653d552007-08-13 17:38:54 +0200899extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
900
Takashi Iwai877211f2005-11-17 13:59:38 +0100901int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +0200902unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Dimitris Papastamos4be77a52012-06-15 16:35:28 +0100903unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Takashi Iwai877211f2005-11-17 13:59:38 +0100905static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 struct snd_dma_buffer *bufp)
907{
Takashi Iwai877211f2005-11-17 13:59:38 +0100908 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 if (bufp) {
910 runtime->dma_buffer_p = bufp;
911 runtime->dma_area = bufp->area;
912 runtime->dma_addr = bufp->addr;
913 runtime->dma_bytes = bufp->bytes;
914 } else {
915 runtime->dma_buffer_p = NULL;
916 runtime->dma_area = NULL;
917 runtime->dma_addr = 0;
918 runtime->dma_bytes = 0;
919 }
920}
921
922/*
923 * Timer interface
924 */
925
Takashi Iwai877211f2005-11-17 13:59:38 +0100926void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
927void snd_pcm_timer_init(struct snd_pcm_substream *substream);
928void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100930static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
931 struct timespec *tv)
932{
933 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
934 do_posix_clock_monotonic_gettime(tv);
935 else
936 getnstimeofday(tv);
937}
938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939/*
940 * Memory
941 */
942
Takashi Iwai877211f2005-11-17 13:59:38 +0100943int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
944int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
945int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 int type, struct device *data,
947 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100948int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 int type, void *data,
950 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +0100951int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
952int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100954int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
955 size_t size, gfp_t gfp_flags);
956int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
957struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
958 unsigned long offset);
959#if 0 /* for kernel-doc */
960/**
961 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
962 * @substream: the substream to allocate the buffer to
963 * @size: the requested buffer size, in bytes
964 *
965 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
966 * contiguous in kernel virtual space, but not in physical memory. Use this
967 * if the buffer is accessed by kernel code but not by device DMA.
968 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100969 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100970 * code.
971 */
972static int snd_pcm_lib_alloc_vmalloc_buffer
973 (struct snd_pcm_substream *substream, size_t size);
974/**
975 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
976 * @substream: the substream to allocate the buffer to
977 * @size: the requested buffer size, in bytes
978 *
979 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
980 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100981 *
982 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
983 * code.
Clemens Ladisch681b84e2009-12-18 09:29:00 +0100984 */
985static int snd_pcm_lib_alloc_vmalloc_32_buffer
986 (struct snd_pcm_substream *substream, size_t size);
987#endif
988#define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
989 _snd_pcm_lib_alloc_vmalloc_buffer \
990 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
991#define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
992 _snd_pcm_lib_alloc_vmalloc_buffer \
993 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
994
Takashi Iwai9d069dc2012-09-20 20:29:12 -0700995#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
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) \
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001002 snd_pcm_get_dma_buf(substream)->private_data
Takashi Iwai77a23f22008-08-21 13:00:13 +02001003
1004struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1005 unsigned long offset);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001006#else /* !SND_DMA_SGBUF */
1007/*
1008 * fake using a continuous buffer
1009 */
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001010#define snd_pcm_sgbuf_ops_page NULL
1011#endif /* SND_DMA_SGBUF */
1012
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001013static inline dma_addr_t
1014snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1015{
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001016 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001017}
1018
1019static inline void *
1020snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1021{
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001022 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001023}
1024
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001025static inline unsigned int
1026snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1027 unsigned int ofs, unsigned int size)
1028{
1029 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1030}
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032/* handle mmap counter - PCM mmap callback should handle this counter properly */
1033static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1034{
Takashi Iwai877211f2005-11-17 13:59:38 +01001035 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001036 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037}
1038
1039static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1040{
Takashi Iwai877211f2005-11-17 13:59:38 +01001041 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001042 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043}
1044
Takashi Iwai18a2b962011-09-28 17:12:59 +02001045int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1046 struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047/* mmap for io-memory area */
1048#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1049#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001050int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051#else
1052#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1053#define snd_pcm_lib_mmap_iomem NULL
1054#endif
1055
Benjamin Herrenschmidt3674f192011-03-25 17:51:54 +11001056#define snd_pcm_lib_mmap_vmalloc NULL
Takashi Iwaic32d9772010-01-18 14:58:57 +01001057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1059{
1060 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1061}
1062
1063/*
1064 * Misc
1065 */
1066
1067#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1068 (IEC958_AES1_CON_ORIGINAL<<8)|\
1069 (IEC958_AES1_CON_PCM_CODER<<8)|\
1070 (IEC958_AES3_CON_FS_48000<<24))
1071
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001072#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1073
Takashi Iwai6e5265e2009-09-08 14:26:51 +02001074const char *snd_pcm_format_name(snd_pcm_format_t format);
1075
Ola Lilja1aad7792012-05-24 15:26:03 +02001076/**
Randy Dunlap85139152012-08-18 17:43:05 -07001077 * snd_pcm_stream_str - Get a string naming the direction of a stream
1078 * @substream: the pcm substream instance
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001079 *
1080 * Return: A string naming the direction of the stream.
Ola Lilja1aad7792012-05-24 15:26:03 +02001081 */
1082static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1083{
1084 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1085 return "Playback";
1086 else
1087 return "Capture";
1088}
1089
Takashi Iwai2d3391e2012-07-27 18:27:00 +02001090/*
1091 * PCM channel-mapping control API
1092 */
1093/* array element of channel maps */
1094struct snd_pcm_chmap_elem {
1095 unsigned char channels;
1096 unsigned char map[15];
1097};
1098
1099/* channel map information; retrieved via snd_kcontrol_chip() */
1100struct snd_pcm_chmap {
1101 struct snd_pcm *pcm; /* assigned PCM instance */
1102 int stream; /* PLAYBACK or CAPTURE */
1103 struct snd_kcontrol *kctl;
1104 const struct snd_pcm_chmap_elem *chmap;
1105 unsigned int max_channels;
1106 unsigned int channel_mask; /* optional: active channels bitmask */
1107 void *private_data; /* optional: private data pointer */
1108};
1109
1110/* get the PCM substream assigned to the given chmap info */
1111static inline struct snd_pcm_substream *
1112snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1113{
1114 struct snd_pcm_substream *s;
1115 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1116 if (s->number == idx)
1117 return s;
1118 return NULL;
1119}
1120
1121/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1122extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1123/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1124extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1125
1126/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1127#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1128#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1129#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1130
1131int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1132 const struct snd_pcm_chmap_elem *chmap,
1133 int max_channels,
1134 unsigned long private_value,
1135 struct snd_pcm_chmap **info_ret);
1136
Eldad Zack74c34ca2013-04-23 01:00:41 +02001137/* Strong-typed conversion of pcm_format to bitwise */
1138static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1139{
1140 return 1ULL << (__force int) pcm_format;
1141}
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143#endif /* __SOUND_PCM_H */