blob: 0cb7f3f5df7b9fca12f7233503f55f6b181470a7 [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
Pierre-Louis Bossart229d0432015-02-13 15:14:03 -060063struct snd_pcm_audio_tstamp_config; /* definitions further down */
64struct snd_pcm_audio_tstamp_report;
65
Takashi Iwai877211f2005-11-17 13:59:38 +010066struct snd_pcm_ops {
67 int (*open)(struct snd_pcm_substream *substream);
68 int (*close)(struct snd_pcm_substream *substream);
69 int (*ioctl)(struct snd_pcm_substream * substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 unsigned int cmd, void *arg);
Takashi Iwai877211f2005-11-17 13:59:38 +010071 int (*hw_params)(struct snd_pcm_substream *substream,
72 struct snd_pcm_hw_params *params);
73 int (*hw_free)(struct snd_pcm_substream *substream);
74 int (*prepare)(struct snd_pcm_substream *substream);
75 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
76 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
Pierre-Louis Bossart3179f622015-02-13 15:14:06 -060077 int (*get_time_info)(struct snd_pcm_substream *substream,
78 struct timespec *system_ts, struct timespec *audio_ts,
79 struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
80 struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
Takashi Iwai877211f2005-11-17 13:59:38 +010081 int (*copy)(struct snd_pcm_substream *substream, int channel,
82 snd_pcm_uframes_t pos,
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 void __user *buf, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010084 int (*silence)(struct snd_pcm_substream *substream, int channel,
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
Takashi Iwai877211f2005-11-17 13:59:38 +010086 struct page *(*page)(struct snd_pcm_substream *substream,
87 unsigned long offset);
88 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
89 int (*ack)(struct snd_pcm_substream *substream);
90};
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
92/*
93 *
94 */
95
Pawel MOLLf90c06a2008-07-30 12:46:40 +010096#if defined(CONFIG_SND_DYNAMIC_MINORS)
97#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
98#else
99#define SNDRV_PCM_DEVICES 8
100#endif
Jaroslav Kysela896e6cc2008-08-01 13:36:04 +0200101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#define SNDRV_PCM_IOCTL1_RESET 0
103#define SNDRV_PCM_IOCTL1_INFO 1
104#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
105#define SNDRV_PCM_IOCTL1_GSTATE 3
Jaroslav Kysela8bea8692009-04-27 09:44:40 +0200106#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108#define SNDRV_PCM_TRIGGER_STOP 0
109#define SNDRV_PCM_TRIGGER_START 1
110#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
111#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
112#define SNDRV_PCM_TRIGGER_SUSPEND 5
113#define SNDRV_PCM_TRIGGER_RESUME 6
Libin Yang48d88292014-12-31 22:09:54 +0800114#define SNDRV_PCM_TRIGGER_DRAIN 7
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115
116#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
117
118/* If you change this don't forget to change rates[] table in pcm_native.c */
119#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
120#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
121#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
122#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
123#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
124#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
125#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
126#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
127#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
128#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
129#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
130#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
131#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
132
133#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
134#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
135
136#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
137 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
138 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
139#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
140#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
141 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
142#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
143 SNDRV_PCM_RATE_192000)
Clemens Ladischfea952e2011-02-14 11:00:47 +0100144#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
145#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
146#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
147#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
148#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
149#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
150#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
151#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
152#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
153#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
154#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
155#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
156#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
157#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
158#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
159#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
160#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
161#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
162#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
163#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
164#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
165#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
166#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
167#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
168#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
169#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
170#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
171#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
172#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
173#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
174#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
175#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
176#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
177#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
178#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
179#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
180#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
181#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
182#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
183#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
184#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
185#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
186#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
Daniel Mackef7a4f92013-04-17 00:01:36 +0800187#define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
188#define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
Jurgen Kramerd4288d32014-09-05 10:47:56 +0200189#define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
Jussi Laakod42472e2014-11-21 16:04:46 +0200190#define SNDRV_PCM_FMTBIT_DSD_U16_BE _SNDRV_PCM_FMTBIT(DSD_U16_BE)
191#define SNDRV_PCM_FMTBIT_DSD_U32_BE _SNDRV_PCM_FMTBIT(DSD_U32_BE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193#ifdef SNDRV_LITTLE_ENDIAN
194#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
195#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
196#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
197#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
198#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
199#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
200#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
201#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
202#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
203#endif
204#ifdef SNDRV_BIG_ENDIAN
205#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
206#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
207#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
208#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
209#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
210#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
211#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
212#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
213#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
214#endif
215
Takashi Iwai877211f2005-11-17 13:59:38 +0100216struct snd_pcm_file {
217 struct snd_pcm_substream *substream;
Takashi Iwai548a6482006-07-31 16:51:51 +0200218 int no_compat_mmap;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219};
220
Takashi Iwai877211f2005-11-17 13:59:38 +0100221struct snd_pcm_hw_rule;
222typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
223 struct snd_pcm_hw_rule *rule);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Takashi Iwai877211f2005-11-17 13:59:38 +0100225struct snd_pcm_hw_rule {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 unsigned int cond;
227 snd_pcm_hw_rule_func_t func;
228 int var;
229 int deps[4];
230 void *private;
231};
232
Takashi Iwai877211f2005-11-17 13:59:38 +0100233struct snd_pcm_hw_constraints {
234 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
Takashi Iwai877211f2005-11-17 13:59:38 +0100236 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
238 unsigned int rules_num;
239 unsigned int rules_all;
Takashi Iwai877211f2005-11-17 13:59:38 +0100240 struct snd_pcm_hw_rule *rules;
241};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Takashi Iwai877211f2005-11-17 13:59:38 +0100243static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
244 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
247}
248
Takashi Iwai877211f2005-11-17 13:59:38 +0100249static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
250 snd_pcm_hw_param_t var)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
253}
254
Takashi Iwai877211f2005-11-17 13:59:38 +0100255struct snd_ratnum {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 unsigned int num;
257 unsigned int den_min, den_max, den_step;
Takashi Iwai877211f2005-11-17 13:59:38 +0100258};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259
Takashi Iwai877211f2005-11-17 13:59:38 +0100260struct snd_ratden {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 unsigned int num_min, num_max, num_step;
262 unsigned int den;
Takashi Iwai877211f2005-11-17 13:59:38 +0100263};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Takashi Iwai877211f2005-11-17 13:59:38 +0100265struct snd_pcm_hw_constraint_ratnums {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100267 struct snd_ratnum *rats;
268};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269
Takashi Iwai877211f2005-11-17 13:59:38 +0100270struct snd_pcm_hw_constraint_ratdens {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 int nrats;
Takashi Iwai877211f2005-11-17 13:59:38 +0100272 struct snd_ratden *rats;
273};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Takashi Iwai877211f2005-11-17 13:59:38 +0100275struct snd_pcm_hw_constraint_list {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 unsigned int count;
Mark Brown4af87a92012-03-14 19:48:43 +0000277 const unsigned int *list;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 unsigned int mask;
Takashi Iwai877211f2005-11-17 13:59:38 +0100279};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Peter Rosinf66f8982015-01-28 15:16:06 +0100281struct snd_pcm_hw_constraint_ranges {
282 unsigned int count;
283 const struct snd_interval *ranges;
284 unsigned int mask;
285};
286
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100287struct snd_pcm_hwptr_log;
288
Pierre-Louis Bossart229d0432015-02-13 15:14:03 -0600289/*
290 * userspace-provided audio timestamp config to kernel,
291 * structure is for internal use only and filled with dedicated unpack routine
292 */
293struct snd_pcm_audio_tstamp_config {
294 /* 5 of max 16 bits used */
295 u32 type_requested:4;
296 u32 report_delay:1; /* add total delay to A/D or D/A */
297};
298
299static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
300 struct snd_pcm_audio_tstamp_config *config)
301{
302 config->type_requested = data & 0xF;
303 config->report_delay = (data >> 4) & 1;
304}
305
306/*
307 * kernel-provided audio timestamp report to user-space
308 * structure is for internal use only and read by dedicated pack routine
309 */
310struct snd_pcm_audio_tstamp_report {
311 /* 6 of max 16 bits used for bit-fields */
312
313 /* for backwards compatibility */
314 u32 valid:1;
315
316 /* actual type if hardware could not support requested timestamp */
317 u32 actual_type:4;
318
319 /* accuracy represented in ns units */
320 u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
321 u32 accuracy; /* up to 4.29s, will be packed in separate field */
322};
323
324static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
325 const struct snd_pcm_audio_tstamp_report *report)
326{
327 u32 tmp;
328
329 tmp = report->accuracy_report;
330 tmp <<= 4;
331 tmp |= report->actual_type;
332 tmp <<= 1;
333 tmp |= report->valid;
334
335 *data &= 0xffff; /* zero-clear MSBs */
336 *data |= (tmp << 16);
337 *accuracy = report->accuracy;
338}
339
340
Takashi Iwai877211f2005-11-17 13:59:38 +0100341struct snd_pcm_runtime {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 /* -- Status -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100343 struct snd_pcm_substream *trigger_master;
Takashi Iwai07799e72005-10-10 11:49:49 +0200344 struct timespec trigger_tstamp; /* trigger timestamp */
Pierre-Louis Bossart2b79d7a2015-02-06 15:55:51 -0600345 bool trigger_tstamp_latched; /* trigger timestamp latched in low-level driver/hardware */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 int overrange;
347 snd_pcm_uframes_t avail_max;
348 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
Jaroslav Kyselae7636922010-01-26 17:08:24 +0100349 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
Jaroslav Kyselabbf6ad12009-04-10 12:28:58 +0200350 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
Jaroslav Kyselabd76af02010-08-18 14:16:54 +0200351 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
Takashi Iwai4bbe1dd2008-10-13 03:07:14 +0200352 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
Pierre-Louis Bossart0e8014d2012-10-22 16:42:14 -0500353 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
355 /* -- HW params -- */
356 snd_pcm_access_t access; /* access mode */
357 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
358 snd_pcm_subformat_t subformat; /* subformat */
359 unsigned int rate; /* rate in Hz */
360 unsigned int channels; /* channels */
361 snd_pcm_uframes_t period_size; /* period size */
362 unsigned int periods; /* periods */
363 snd_pcm_uframes_t buffer_size; /* buffer size */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 snd_pcm_uframes_t min_align; /* Min alignment for the format */
365 size_t byte_align;
366 unsigned int frame_bits;
367 unsigned int sample_bits;
368 unsigned int info;
369 unsigned int rate_num;
370 unsigned int rate_den;
Clemens Ladischab69a492010-11-15 10:46:23 +0100371 unsigned int no_period_wakeup: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372
373 /* -- SW params -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100374 int tstamp_mode; /* mmap timestamp is updated */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 unsigned int period_step;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 snd_pcm_uframes_t start_threshold;
377 snd_pcm_uframes_t stop_threshold;
378 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
379 noise is nearest than this */
380 snd_pcm_uframes_t silence_size; /* Silence filling size */
381 snd_pcm_uframes_t boundary; /* pointers wrap point */
382
383 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
384 snd_pcm_uframes_t silence_filled; /* size filled with silence */
385
Takashi Iwai877211f2005-11-17 13:59:38 +0100386 union snd_pcm_sync_id sync; /* hardware synchronization ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388 /* -- mmap -- */
Takashi Iwai503fc852007-09-11 00:35:06 +0200389 struct snd_pcm_mmap_status *status;
390 struct snd_pcm_mmap_control *control;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /* -- locking / scheduling -- */
David Dillow5daeba32010-06-27 00:13:20 +0200393 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
Jaroslav Kyselac91a9882010-01-21 10:32:15 +0100394 wait_queue_head_t sleep; /* poll sleep */
395 wait_queue_head_t tsleep; /* transfer sleep */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 struct fasync_struct *fasync;
397
398 /* -- private section -- */
399 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100400 void (*private_free)(struct snd_pcm_runtime *runtime);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402 /* -- hardware description -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100403 struct snd_pcm_hardware hw;
404 struct snd_pcm_hw_constraints hw_constraints;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 /* -- interrupt callbacks -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100407 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
408 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
410 /* -- timer -- */
411 unsigned int timer_resolution; /* timer resolution */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +0100412 int tstamp_type; /* timestamp type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
414 /* -- DMA -- */
415 unsigned char *dma_area; /* DMA area */
416 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
417 size_t dma_bytes; /* size of DMA area */
418
419 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
420
Pierre-Louis Bossart229d0432015-02-13 15:14:03 -0600421 /* -- audio timestamp config -- */
422 struct snd_pcm_audio_tstamp_config audio_tstamp_config;
423 struct snd_pcm_audio_tstamp_report audio_tstamp_report;
424 struct timespec driver_tstamp;
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
427 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100428 struct snd_pcm_oss_runtime oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429#endif
Jaroslav Kysela4d96eb22009-12-20 11:47:57 +0100430
431#ifdef CONFIG_SND_PCM_XRUN_DEBUG
432 struct snd_pcm_hwptr_log *hwptr_log;
433#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
435
Takashi Iwai877211f2005-11-17 13:59:38 +0100436struct snd_pcm_group { /* keep linked substreams */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 spinlock_t lock;
Takashi Iwai257f8cc2014-08-29 15:32:29 +0200438 struct mutex mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 struct list_head substreams;
440 int count;
Takashi Iwai877211f2005-11-17 13:59:38 +0100441};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Clemens Ladische7373b72009-11-10 10:13:30 +0100443struct pid;
444
Takashi Iwai877211f2005-11-17 13:59:38 +0100445struct snd_pcm_substream {
446 struct snd_pcm *pcm;
447 struct snd_pcm_str *pstr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 void *private_data; /* copied from pcm->private_data */
449 int number;
450 char name[32]; /* substream name */
451 int stream; /* stream (direction) */
Jean Pihetcc749982011-08-25 15:35:12 +0200452 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 size_t buffer_bytes_max; /* limit ring buffer size */
454 struct snd_dma_buffer dma_buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 size_t dma_max;
456 /* -- hardware operations -- */
Lars-Peter Clausene6c2e7e2013-05-24 15:18:10 +0200457 const struct snd_pcm_ops *ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 /* -- runtime information -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100459 struct snd_pcm_runtime *runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 /* -- timer section -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100461 struct snd_timer *timer; /* timer */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 unsigned timer_running: 1; /* time is running */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 /* -- next substream -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100464 struct snd_pcm_substream *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 /* -- linked substreams -- */
466 struct list_head link_list; /* linked list member */
Takashi Iwai877211f2005-11-17 13:59:38 +0100467 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
468 struct snd_pcm_group *group; /* pointer to current group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 /* -- assigned files -- */
Takashi Iwai15762742006-04-06 19:47:42 +0200470 void *file;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200471 int ref_count;
Takashi Iwai9c323fc2006-04-28 15:13:41 +0200472 atomic_t mmap_count;
Takashi Iwai0df63e42006-04-28 15:13:41 +0200473 unsigned int f_flags;
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200474 void (*pcm_release)(struct snd_pcm_substream *);
Clemens Ladische7373b72009-11-10 10:13:30 +0100475 struct pid *pid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
477 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100478 struct snd_pcm_oss_substream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200480#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100481 struct snd_info_entry *proc_root;
482 struct snd_info_entry *proc_info_entry;
483 struct snd_info_entry *proc_hw_params_entry;
484 struct snd_info_entry *proc_sw_params_entry;
485 struct snd_info_entry *proc_status_entry;
486 struct snd_info_entry *proc_prealloc_entry;
Jaroslav Kyselac7132ae2006-10-06 15:12:29 +0200487 struct snd_info_entry *proc_prealloc_max_entry;
Takashi Iwai2b30d412014-11-04 14:02:40 +0100488#ifdef CONFIG_SND_PCM_XRUN_DEBUG
489 struct snd_info_entry *proc_xrun_injection_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200490#endif
Takashi Iwai2b30d412014-11-04 14:02:40 +0100491#endif /* CONFIG_SND_VERBOSE_PROCFS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 /* misc flags */
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200493 unsigned int hw_opened: 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494};
495
Takashi Iwai0df63e42006-04-28 15:13:41 +0200496#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498
Takashi Iwai877211f2005-11-17 13:59:38 +0100499struct snd_pcm_str {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 int stream; /* stream (direction) */
Takashi Iwai877211f2005-11-17 13:59:38 +0100501 struct snd_pcm *pcm;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 /* -- substreams -- */
503 unsigned int substream_count;
504 unsigned int substream_opened;
Takashi Iwai877211f2005-11-17 13:59:38 +0100505 struct snd_pcm_substream *substream;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
507 /* -- OSS things -- */
Takashi Iwai877211f2005-11-17 13:59:38 +0100508 struct snd_pcm_oss_stream oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200510#ifdef CONFIG_SND_VERBOSE_PROCFS
Takashi Iwai877211f2005-11-17 13:59:38 +0100511 struct snd_info_entry *proc_root;
512 struct snd_info_entry *proc_info_entry;
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200513#ifdef CONFIG_SND_PCM_XRUN_DEBUG
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
Takashi Iwai877211f2005-11-17 13:59:38 +0100515 struct snd_info_entry *proc_xrun_debug_entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516#endif
Takashi Iwaib7d90a32006-04-25 12:56:04 +0200517#endif
Takashi Iwai2d3391e2012-07-27 18:27:00 +0200518 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
Takashi Iwaief46c7a2015-01-29 17:32:26 +0100519 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520};
521
Takashi Iwai877211f2005-11-17 13:59:38 +0100522struct snd_pcm {
523 struct snd_card *card;
Clemens Ladischf87135f2005-11-20 14:06:59 +0100524 struct list_head list;
Pawel MOLLf90c06a2008-07-30 12:46:40 +0100525 int device; /* device number */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 unsigned int info_flags;
527 unsigned short dev_class;
528 unsigned short dev_subclass;
529 char id[64];
530 char name[80];
Takashi Iwai877211f2005-11-17 13:59:38 +0100531 struct snd_pcm_str streams[2];
Ingo Molnar1a60d4c2006-01-16 16:29:08 +0100532 struct mutex open_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 wait_queue_head_t open_wait;
534 void *private_data;
Takashi Iwai877211f2005-11-17 13:59:38 +0100535 void (*private_free) (struct snd_pcm *pcm);
Liam Girdwood945e5032012-02-08 20:33:31 +0000536 bool internal; /* pcm is for internal use only */
Takashi Iwai257f8cc2014-08-29 15:32:29 +0200537 bool nonatomic; /* whole PCM operations are in non-atomic context */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538#if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
Takashi Iwai877211f2005-11-17 13:59:38 +0100539 struct snd_pcm_oss oss;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540#endif
541};
542
Takashi Iwai877211f2005-11-17 13:59:38 +0100543struct snd_pcm_notify {
544 int (*n_register) (struct snd_pcm * pcm);
545 int (*n_disconnect) (struct snd_pcm * pcm);
546 int (*n_unregister) (struct snd_pcm * pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 struct list_head list;
Takashi Iwai877211f2005-11-17 13:59:38 +0100548};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550/*
551 * Registering
552 */
553
Arjan van de Ven54047322007-02-12 00:55:28 -0800554extern const struct file_operations snd_pcm_f_ops[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Tim Blechmanne6161652009-02-05 13:01:54 +0100556int snd_pcm_new(struct snd_card *card, const char *id, int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 int playback_count, int capture_count,
Takashi Iwai877211f2005-11-17 13:59:38 +0100558 struct snd_pcm **rpcm);
Liam Girdwood945e5032012-02-08 20:33:31 +0000559int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
560 int playback_count, int capture_count,
561 struct snd_pcm **rpcm);
Takashi Iwai877211f2005-11-17 13:59:38 +0100562int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Takashi Iwai877211f2005-11-17 13:59:38 +0100564int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566/*
567 * Native I/O
568 */
569
Takashi Iwai877211f2005-11-17 13:59:38 +0100570int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
571int snd_pcm_info_user(struct snd_pcm_substream *substream,
572 struct snd_pcm_info __user *info);
573int snd_pcm_status(struct snd_pcm_substream *substream,
574 struct snd_pcm_status *status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100575int snd_pcm_start(struct snd_pcm_substream *substream);
Clemens Ladischfea952e2011-02-14 11:00:47 +0100576int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
Takashi Iwai877211f2005-11-17 13:59:38 +0100577int snd_pcm_drain_done(struct snd_pcm_substream *substream);
Takashi Iwai1fb85102014-11-07 17:08:28 +0100578int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579#ifdef CONFIG_PM
Takashi Iwai877211f2005-11-17 13:59:38 +0100580int snd_pcm_suspend(struct snd_pcm_substream *substream);
581int snd_pcm_suspend_all(struct snd_pcm *pcm);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582#endif
Takashi Iwai877211f2005-11-17 13:59:38 +0100583int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200584int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
585 struct snd_pcm_substream **rsubstream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100586void snd_pcm_release_substream(struct snd_pcm_substream *substream);
Takashi Iwai3bf75f92006-03-27 16:40:49 +0200587int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
588 struct snd_pcm_substream **rsubstream);
589void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
Takashi Iwai877211f2005-11-17 13:59:38 +0100590int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Eliot Blennerhassettacb03d42011-07-23 12:36:25 +1200592
593#ifdef CONFIG_SND_DEBUG
594void snd_pcm_debug_name(struct snd_pcm_substream *substream,
595 char *name, size_t len);
596#else
597static inline void
598snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
599{
600 *buf = 0;
601}
602#endif
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604/*
605 * PCM library
606 */
607
Takashi Iwai30b771c2014-10-30 15:02:50 +0100608/**
609 * snd_pcm_stream_linked - Check whether the substream is linked with others
610 * @substream: substream to check
611 *
612 * Returns true if the given substream is being linked with others.
613 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100614static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615{
616 return substream->group != &substream->self_group;
617}
618
Takashi Iwai7af142f2014-09-01 11:19:37 +0200619void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
620void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
621void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
622void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
623unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
Takashi Iwai30b771c2014-10-30 15:02:50 +0100624
625/**
626 * snd_pcm_stream_lock_irqsave - Lock the PCM stream
627 * @substream: PCM substream
628 * @flags: irq flags
629 *
630 * This locks the PCM stream like snd_pcm_stream_lock() but with the local
631 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
632 * as snd_pcm_stream_lock().
633 */
Takashi Iwai7af142f2014-09-01 11:19:37 +0200634#define snd_pcm_stream_lock_irqsave(substream, flags) \
635 do { \
636 typecheck(unsigned long, flags); \
637 flags = _snd_pcm_stream_lock_irqsave(substream); \
638 } while (0)
639void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
640 unsigned long flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Takashi Iwai30b771c2014-10-30 15:02:50 +0100642/**
643 * snd_pcm_group_for_each_entry - iterate over the linked substreams
644 * @s: the iterator
645 * @substream: the substream
646 *
647 * Iterate over the all linked substreams to the given @substream.
648 * When @substream isn't linked with any others, this gives returns @substream
649 * itself once.
650 */
Takashi Iwaief991b92007-02-22 12:52:53 +0100651#define snd_pcm_group_for_each_entry(s, substream) \
652 list_for_each_entry(s, &substream->group->substreams, link_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Takashi Iwai30b771c2014-10-30 15:02:50 +0100654/**
655 * snd_pcm_running - Check whether the substream is in a running state
656 * @substream: substream to check
657 *
658 * Returns true if the given substream is in the state RUNNING, or in the
659 * state DRAINING for playback.
660 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100661static inline int snd_pcm_running(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662{
663 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
664 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
665 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
666}
667
Takashi Iwai30b771c2014-10-30 15:02:50 +0100668/**
669 * bytes_to_samples - Unit conversion of the size from bytes to samples
670 * @runtime: PCM runtime instance
671 * @size: size in bytes
672 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100673static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
675 return size * 8 / runtime->sample_bits;
676}
677
Takashi Iwai30b771c2014-10-30 15:02:50 +0100678/**
679 * bytes_to_frames - Unit conversion of the size from bytes to frames
680 * @runtime: PCM runtime instance
681 * @size: size in bytes
682 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100683static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684{
685 return size * 8 / runtime->frame_bits;
686}
687
Takashi Iwai30b771c2014-10-30 15:02:50 +0100688/**
689 * samples_to_bytes - Unit conversion of the size from samples to bytes
690 * @runtime: PCM runtime instance
691 * @size: size in samples
692 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100693static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694{
695 return size * runtime->sample_bits / 8;
696}
697
Takashi Iwai30b771c2014-10-30 15:02:50 +0100698/**
699 * frames_to_bytes - Unit conversion of the size from frames to bytes
700 * @runtime: PCM runtime instance
701 * @size: size in frames
702 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100703static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
705 return size * runtime->frame_bits / 8;
706}
707
Takashi Iwai30b771c2014-10-30 15:02:50 +0100708/**
709 * frame_aligned - Check whether the byte size is aligned to frames
710 * @runtime: PCM runtime instance
711 * @bytes: size in bytes
712 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100713static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
715 return bytes % runtime->byte_align == 0;
716}
717
Takashi Iwai30b771c2014-10-30 15:02:50 +0100718/**
719 * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
720 * @substream: PCM substream
721 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100722static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723{
Takashi Iwai877211f2005-11-17 13:59:38 +0100724 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 return frames_to_bytes(runtime, runtime->buffer_size);
726}
727
Takashi Iwai30b771c2014-10-30 15:02:50 +0100728/**
729 * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
730 * @substream: PCM substream
731 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100732static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
Takashi Iwai877211f2005-11-17 13:59:38 +0100734 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 return frames_to_bytes(runtime, runtime->period_size);
736}
737
Takashi Iwai30b771c2014-10-30 15:02:50 +0100738/**
739 * snd_pcm_playback_avail - Get the available (writable) space for playback
740 * @runtime: PCM runtime instance
741 *
742 * Result is between 0 ... (boundary - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100744static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745{
746 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
747 if (avail < 0)
748 avail += runtime->boundary;
749 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
750 avail -= runtime->boundary;
751 return avail;
752}
753
Takashi Iwai30b771c2014-10-30 15:02:50 +0100754/**
755 * snd_pcm_playback_avail - Get the available (readable) space for capture
756 * @runtime: PCM runtime instance
757 *
758 * Result is between 0 ... (boundary - 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100760static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761{
762 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
763 if (avail < 0)
764 avail += runtime->boundary;
765 return avail;
766}
767
Takashi Iwai30b771c2014-10-30 15:02:50 +0100768/**
769 * snd_pcm_playback_hw_avail - Get the queued space for playback
770 * @runtime: PCM runtime instance
771 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100772static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773{
774 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
775}
776
Takashi Iwai30b771c2014-10-30 15:02:50 +0100777/**
778 * snd_pcm_capture_hw_avail - Get the free space for capture
779 * @runtime: PCM runtime instance
780 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100781static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782{
783 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
784}
785
786/**
787 * snd_pcm_playback_ready - check whether the playback buffer is available
788 * @substream: the pcm substream instance
789 *
790 * Checks whether enough free space is available on the playback buffer.
791 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100792 * Return: Non-zero if available, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100794static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795{
Takashi Iwai877211f2005-11-17 13:59:38 +0100796 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
798}
799
800/**
801 * snd_pcm_capture_ready - check whether the capture buffer is available
802 * @substream: the pcm substream instance
803 *
804 * Checks whether enough capture data is available on the capture buffer.
805 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100806 * Return: Non-zero if available, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100808static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809{
Takashi Iwai877211f2005-11-17 13:59:38 +0100810 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
812}
813
814/**
815 * snd_pcm_playback_data - check whether any data exists on the playback buffer
816 * @substream: the pcm substream instance
817 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100818 * Checks whether any data exists on the playback buffer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100820 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
821 * is bigger or equal to boundary, then this function returns always non-zero.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100823static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824{
Takashi Iwai877211f2005-11-17 13:59:38 +0100825 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 if (runtime->stop_threshold >= runtime->boundary)
828 return 1;
829 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
830}
831
832/**
833 * snd_pcm_playback_empty - check whether the playback buffer is empty
834 * @substream: the pcm substream instance
835 *
836 * Checks whether the playback buffer is empty.
837 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100838 * Return: Non-zero if empty, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100840static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841{
Takashi Iwai877211f2005-11-17 13:59:38 +0100842 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
844}
845
846/**
847 * snd_pcm_capture_empty - check whether the capture buffer is empty
848 * @substream: the pcm substream instance
849 *
850 * Checks whether the capture buffer is empty.
851 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +0100852 * Return: Non-zero if empty, or zero if not.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100854static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855{
Takashi Iwai877211f2005-11-17 13:59:38 +0100856 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 return snd_pcm_capture_avail(runtime) == 0;
858}
859
Takashi Iwai30b771c2014-10-30 15:02:50 +0100860/**
861 * snd_pcm_trigger_done - Mark the master substream
862 * @substream: the pcm substream instance
863 * @master: the linked master substream
864 *
865 * When multiple substreams of the same card are linked and the hardware
866 * supports the single-shot operation, the driver calls this in the loop
867 * in snd_pcm_group_for_each_entry() for marking the substream as "done".
868 * Then most of trigger operations are performed only to the given master
869 * substream.
870 *
871 * The trigger_master mark is cleared at timestamp updates at the end
872 * of trigger operations.
873 */
Takashi Iwai877211f2005-11-17 13:59:38 +0100874static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
875 struct snd_pcm_substream *master)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876{
877 substream->runtime->trigger_master = master;
878}
879
880static inline int hw_is_mask(int var)
881{
882 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
883 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
884}
885
886static inline int hw_is_interval(int var)
887{
888 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
889 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
890}
891
Takashi Iwai877211f2005-11-17 13:59:38 +0100892static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 snd_pcm_hw_param_t var)
894{
895 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
896}
897
Takashi Iwai877211f2005-11-17 13:59:38 +0100898static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 snd_pcm_hw_param_t var)
900{
901 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
902}
903
Takashi Iwai877211f2005-11-17 13:59:38 +0100904static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 snd_pcm_hw_param_t var)
906{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200907 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908}
909
Takashi Iwai877211f2005-11-17 13:59:38 +0100910static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 snd_pcm_hw_param_t var)
912{
Takashi Iwaib9f09a42007-09-11 00:33:48 +0200913 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
915
Takashi Iwai85926e02014-10-30 15:06:13 +0100916/**
917 * params_channels - Get the number of channels from the hw params
918 * @p: hw params
919 */
920static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
921{
922 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
923}
924
925/**
Lars-Peter Clausen62f64a82014-12-29 19:41:40 +0100926 * params_rate - Get the sample rate from the hw params
Takashi Iwai85926e02014-10-30 15:06:13 +0100927 * @p: hw params
928 */
929static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
930{
931 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
932}
933
934/**
Lars-Peter Clausen62f64a82014-12-29 19:41:40 +0100935 * params_period_size - Get the period size (in frames) from the hw params
Takashi Iwai85926e02014-10-30 15:06:13 +0100936 * @p: hw params
937 */
938static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
939{
940 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
941}
942
943/**
Lars-Peter Clausen62f64a82014-12-29 19:41:40 +0100944 * params_periods - Get the number of periods from the hw params
Takashi Iwai85926e02014-10-30 15:06:13 +0100945 * @p: hw params
946 */
947static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
948{
949 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
950}
951
952/**
Lars-Peter Clausen62f64a82014-12-29 19:41:40 +0100953 * params_buffer_size - Get the buffer size (in frames) from the hw params
Takashi Iwai85926e02014-10-30 15:06:13 +0100954 * @p: hw params
955 */
956static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
957{
958 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
959}
960
961/**
Lars-Peter Clausen62f64a82014-12-29 19:41:40 +0100962 * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
Takashi Iwai85926e02014-10-30 15:06:13 +0100963 * @p: hw params
964 */
965static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
966{
967 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
968}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969
Takashi Iwai877211f2005-11-17 13:59:38 +0100970int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
971void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
972void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
973void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
974 unsigned int k, struct snd_interval *c);
975void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
976 const struct snd_interval *b, struct snd_interval *c);
Mark Brown4af87a92012-03-14 19:48:43 +0000977int snd_interval_list(struct snd_interval *i, unsigned int count,
978 const unsigned int *list, unsigned int mask);
Peter Rosinf66f8982015-01-28 15:16:06 +0100979int snd_interval_ranges(struct snd_interval *i, unsigned int count,
980 const struct snd_interval *list, unsigned int mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100981int snd_interval_ratnum(struct snd_interval *i,
982 unsigned int rats_count, struct snd_ratnum *rats,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 unsigned int *nump, unsigned int *denp);
984
Takashi Iwai877211f2005-11-17 13:59:38 +0100985void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
986void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
Takashi Iwai877211f2005-11-17 13:59:38 +0100987int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Takashi Iwai877211f2005-11-17 13:59:38 +0100989int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990
Takashi Iwai877211f2005-11-17 13:59:38 +0100991int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
992int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Takashi Iwai877211f2005-11-17 13:59:38 +0100994int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995 u_int32_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100996int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 u_int64_t mask);
Takashi Iwai877211f2005-11-17 13:59:38 +0100998int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 unsigned int min, unsigned int max);
Takashi Iwai877211f2005-11-17 13:59:38 +01001000int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
1001int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 unsigned int cond,
1003 snd_pcm_hw_param_t var,
Mark Brown14641892012-07-05 12:15:01 +01001004 const struct snd_pcm_hw_constraint_list *l);
Peter Rosinf66f8982015-01-28 15:16:06 +01001005int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
1006 unsigned int cond,
1007 snd_pcm_hw_param_t var,
1008 const struct snd_pcm_hw_constraint_ranges *r);
Takashi Iwai877211f2005-11-17 13:59:38 +01001009int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 unsigned int cond,
1011 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +01001012 struct snd_pcm_hw_constraint_ratnums *r);
1013int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 unsigned int cond,
1015 snd_pcm_hw_param_t var,
Takashi Iwai877211f2005-11-17 13:59:38 +01001016 struct snd_pcm_hw_constraint_ratdens *r);
1017int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 unsigned int cond,
1019 unsigned int width,
1020 unsigned int msbits);
Takashi Iwai877211f2005-11-17 13:59:38 +01001021int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 unsigned int cond,
1023 snd_pcm_hw_param_t var,
1024 unsigned long step);
Takashi Iwai877211f2005-11-17 13:59:38 +01001025int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 unsigned int cond,
1027 snd_pcm_hw_param_t var);
Clemens Ladischd5b702a2011-09-16 23:03:02 +02001028int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1029 unsigned int base_rate);
Takashi Iwai877211f2005-11-17 13:59:38 +01001030int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 unsigned int cond,
1032 int var,
1033 snd_pcm_hw_rule_func_t func, void *private,
1034 int dep, ...);
1035
1036int snd_pcm_format_signed(snd_pcm_format_t format);
1037int snd_pcm_format_unsigned(snd_pcm_format_t format);
1038int snd_pcm_format_linear(snd_pcm_format_t format);
1039int snd_pcm_format_little_endian(snd_pcm_format_t format);
1040int snd_pcm_format_big_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +02001041#if 0 /* just for DocBook */
1042/**
Takashi Iwai9502dca2005-05-18 16:25:46 +02001043 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1044 * @format: the format to check
1045 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001046 * Return: 1 if the given PCM format is CPU-endian, 0 if
Takashi Iwai9502dca2005-05-18 16:25:46 +02001047 * opposite, or a negative error code if endian not specified.
1048 */
Takashi Iwai8cdfd252005-09-07 14:08:11 +02001049int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
Takashi Iwai1b44c282005-09-09 15:05:33 +02001050#endif /* DocBook */
Takashi Iwai9502dca2005-05-18 16:25:46 +02001051#ifdef SNDRV_LITTLE_ENDIAN
Martin Waitz9d01a822005-09-09 13:10:17 -07001052#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +02001053#else
Martin Waitz9d01a822005-09-09 13:10:17 -07001054#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
Takashi Iwai9502dca2005-05-18 16:25:46 +02001055#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1057int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
Takashi Iwai9502dca2005-05-18 16:25:46 +02001058ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1060int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
Lars-Peter Clausene6c2e7e2013-05-24 15:18:10 +02001062void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1063 const struct snd_pcm_ops *ops);
Takashi Iwai877211f2005-11-17 13:59:38 +01001064void snd_pcm_set_sync(struct snd_pcm_substream *substream);
Takashi Iwai877211f2005-11-17 13:59:38 +01001065int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 unsigned int cmd, void *arg);
Jaroslav Kysela12509322010-01-07 15:36:31 +01001067int snd_pcm_update_state(struct snd_pcm_substream *substream,
1068 struct snd_pcm_runtime *runtime);
Takashi Iwai877211f2005-11-17 13:59:38 +01001069int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
Takashi Iwai877211f2005-11-17 13:59:38 +01001070void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
Takashi Iwai877211f2005-11-17 13:59:38 +01001071void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1072snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 const void __user *buf,
1074 snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +01001075snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 void __user *buf, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +01001077snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 void __user **bufs, snd_pcm_uframes_t frames);
Takashi Iwai877211f2005-11-17 13:59:38 +01001079snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 void __user **bufs, snd_pcm_uframes_t frames);
1081
Clemens Ladisch7653d552007-08-13 17:38:54 +02001082extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
1083
Takashi Iwai877211f2005-11-17 13:59:38 +01001084int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
Clemens Ladisch918f3a02007-08-13 17:40:54 +02001085unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
Dimitris Papastamos4be77a52012-06-15 16:35:28 +01001086unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
Lars-Peter Clausene3a92692014-01-11 10:24:43 +01001087unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1088 unsigned int rates_b);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
Takashi Iwai30b771c2014-10-30 15:02:50 +01001090/**
1091 * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1092 * @substream: PCM substream to set
1093 * @bufp: the buffer information, NULL to clear
1094 *
1095 * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1096 * Otherwise it clears the current buffer information.
1097 */
Takashi Iwai877211f2005-11-17 13:59:38 +01001098static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 struct snd_dma_buffer *bufp)
1100{
Takashi Iwai877211f2005-11-17 13:59:38 +01001101 struct snd_pcm_runtime *runtime = substream->runtime;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 if (bufp) {
1103 runtime->dma_buffer_p = bufp;
1104 runtime->dma_area = bufp->area;
1105 runtime->dma_addr = bufp->addr;
1106 runtime->dma_bytes = bufp->bytes;
1107 } else {
1108 runtime->dma_buffer_p = NULL;
1109 runtime->dma_area = NULL;
1110 runtime->dma_addr = 0;
1111 runtime->dma_bytes = 0;
1112 }
1113}
1114
1115/*
1116 * Timer interface
1117 */
1118
Takashi Iwai877211f2005-11-17 13:59:38 +01001119void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
1120void snd_pcm_timer_init(struct snd_pcm_substream *substream);
1121void snd_pcm_timer_done(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122
Takashi Iwai30b771c2014-10-30 15:02:50 +01001123/**
1124 * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1125 * @runtime: PCM runtime instance
1126 * @tv: timespec to fill
1127 */
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01001128static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1129 struct timespec *tv)
1130{
Mark Brown0ac8a522014-07-08 16:51:49 +02001131 switch (runtime->tstamp_type) {
1132 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
Thomas Gleixner26204e02014-06-11 23:59:14 +00001133 ktime_get_ts(tv);
Mark Brown0ac8a522014-07-08 16:51:49 +02001134 break;
1135 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1136 getrawmonotonic(tv);
1137 break;
1138 default:
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01001139 getnstimeofday(tv);
Mark Brown0ac8a522014-07-08 16:51:49 +02001140 break;
1141 }
Jaroslav Kyselab751eef2007-12-13 10:19:42 +01001142}
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144/*
1145 * Memory
1146 */
1147
Takashi Iwai877211f2005-11-17 13:59:38 +01001148int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1149int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1150int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 int type, struct device *data,
1152 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +01001153int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 int type, void *data,
1155 size_t size, size_t max);
Takashi Iwai877211f2005-11-17 13:59:38 +01001156int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1157int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001159int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1160 size_t size, gfp_t gfp_flags);
1161int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1162struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1163 unsigned long offset);
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001164/**
1165 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1166 * @substream: the substream to allocate the buffer to
1167 * @size: the requested buffer size, in bytes
1168 *
1169 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1170 * contiguous in kernel virtual space, but not in physical memory. Use this
1171 * if the buffer is accessed by kernel code but not by device DMA.
1172 *
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001173 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001174 * code.
1175 */
Takashi Iwaif213d8f2014-10-30 13:45:58 +01001176static inline int snd_pcm_lib_alloc_vmalloc_buffer
1177 (struct snd_pcm_substream *substream, size_t size)
1178{
1179 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1180 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1181}
1182
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001183/**
1184 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1185 * @substream: the substream to allocate the buffer to
1186 * @size: the requested buffer size, in bytes
1187 *
1188 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1189 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001190 *
1191 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1192 * code.
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001193 */
Takashi Iwaif213d8f2014-10-30 13:45:58 +01001194static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1195 (struct snd_pcm_substream *substream, size_t size)
1196{
1197 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1198 GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1199}
Clemens Ladisch681b84e2009-12-18 09:29:00 +01001200
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001201#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1202
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001203#ifdef CONFIG_SND_DMA_SGBUF
Takashi Iwai77a23f22008-08-21 13:00:13 +02001204/*
1205 * SG-buffer handling
1206 */
1207#define snd_pcm_substream_sgbuf(substream) \
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001208 snd_pcm_get_dma_buf(substream)->private_data
Takashi Iwai77a23f22008-08-21 13:00:13 +02001209
1210struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1211 unsigned long offset);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001212#else /* !SND_DMA_SGBUF */
1213/*
1214 * fake using a continuous buffer
1215 */
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001216#define snd_pcm_sgbuf_ops_page NULL
1217#endif /* SND_DMA_SGBUF */
1218
Takashi Iwai30b771c2014-10-30 15:02:50 +01001219/**
1220 * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1221 * @substream: PCM substream
1222 * @ofs: byte offset
1223 */
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001224static inline dma_addr_t
1225snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1226{
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001227 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001228}
1229
Takashi Iwai30b771c2014-10-30 15:02:50 +01001230/**
1231 * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1232 * @substream: PCM substream
1233 * @ofs: byte offset
1234 */
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001235static inline void *
1236snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1237{
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001238 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001239}
1240
Takashi Iwai30b771c2014-10-30 15:02:50 +01001241/**
1242 * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1243 * page from the given size
1244 * @substream: PCM substream
1245 * @ofs: byte offset
1246 * @size: byte size to examine
1247 */
Takashi Iwai9d069dc2012-09-20 20:29:12 -07001248static inline unsigned int
1249snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1250 unsigned int ofs, unsigned int size)
1251{
1252 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1253}
Takashi Iwaicc6a8ac2008-06-17 16:39:06 +02001254
Takashi Iwai30b771c2014-10-30 15:02:50 +01001255/**
1256 * snd_pcm_mmap_data_open - increase the mmap counter
1257 * @area: VMA
1258 *
1259 * PCM mmap callback should handle this counter properly
1260 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1262{
Takashi Iwai877211f2005-11-17 13:59:38 +01001263 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001264 atomic_inc(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265}
1266
Takashi Iwai30b771c2014-10-30 15:02:50 +01001267/**
1268 * snd_pcm_mmap_data_close - decrease the mmap counter
1269 * @area: VMA
1270 *
1271 * PCM mmap callback should handle this counter properly
1272 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1274{
Takashi Iwai877211f2005-11-17 13:59:38 +01001275 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
Takashi Iwai9c323fc2006-04-28 15:13:41 +02001276 atomic_dec(&substream->mmap_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277}
1278
Takashi Iwai18a2b962011-09-28 17:12:59 +02001279int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1280 struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281/* mmap for io-memory area */
1282#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1283#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
Takashi Iwai877211f2005-11-17 13:59:38 +01001284int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285#else
1286#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1287#define snd_pcm_lib_mmap_iomem NULL
1288#endif
1289
Benjamin Herrenschmidt3674f192011-03-25 17:51:54 +11001290#define snd_pcm_lib_mmap_vmalloc NULL
Takashi Iwaic32d9772010-01-18 14:58:57 +01001291
Takashi Iwai30b771c2014-10-30 15:02:50 +01001292/**
1293 * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1294 * @dma: DMA number
1295 * @max: pointer to store the max size
1296 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1298{
1299 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1300}
1301
1302/*
1303 * Misc
1304 */
1305
1306#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1307 (IEC958_AES1_CON_ORIGINAL<<8)|\
1308 (IEC958_AES1_CON_PCM_CODER<<8)|\
1309 (IEC958_AES3_CON_FS_48000<<24))
1310
Takashi Iwai7eaa9432008-08-08 17:09:09 +02001311#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1312
Takashi Iwai6e5265e2009-09-08 14:26:51 +02001313const char *snd_pcm_format_name(snd_pcm_format_t format);
1314
Ola Lilja1aad7792012-05-24 15:26:03 +02001315/**
Randy Dunlap85139152012-08-18 17:43:05 -07001316 * snd_pcm_stream_str - Get a string naming the direction of a stream
1317 * @substream: the pcm substream instance
Yacine Belkadieb7c06e2013-03-11 22:05:14 +01001318 *
1319 * Return: A string naming the direction of the stream.
Ola Lilja1aad7792012-05-24 15:26:03 +02001320 */
1321static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1322{
1323 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1324 return "Playback";
1325 else
1326 return "Capture";
1327}
1328
Takashi Iwai2d3391e2012-07-27 18:27:00 +02001329/*
1330 * PCM channel-mapping control API
1331 */
1332/* array element of channel maps */
1333struct snd_pcm_chmap_elem {
1334 unsigned char channels;
1335 unsigned char map[15];
1336};
1337
1338/* channel map information; retrieved via snd_kcontrol_chip() */
1339struct snd_pcm_chmap {
1340 struct snd_pcm *pcm; /* assigned PCM instance */
1341 int stream; /* PLAYBACK or CAPTURE */
1342 struct snd_kcontrol *kctl;
1343 const struct snd_pcm_chmap_elem *chmap;
1344 unsigned int max_channels;
1345 unsigned int channel_mask; /* optional: active channels bitmask */
1346 void *private_data; /* optional: private data pointer */
1347};
1348
Takashi Iwai30b771c2014-10-30 15:02:50 +01001349/**
1350 * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1351 * @info: chmap information
1352 * @idx: the substream number index
1353 */
Takashi Iwai2d3391e2012-07-27 18:27:00 +02001354static inline struct snd_pcm_substream *
1355snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1356{
1357 struct snd_pcm_substream *s;
1358 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1359 if (s->number == idx)
1360 return s;
1361 return NULL;
1362}
1363
1364/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1365extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1366/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1367extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1368
1369/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1370#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1371#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1372#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1373
1374int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1375 const struct snd_pcm_chmap_elem *chmap,
1376 int max_channels,
1377 unsigned long private_value,
1378 struct snd_pcm_chmap **info_ret);
1379
Takashi Iwai30b771c2014-10-30 15:02:50 +01001380/**
1381 * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1382 * @pcm_format: PCM format
1383 */
Eldad Zack74c34ca2013-04-23 01:00:41 +02001384static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1385{
1386 return 1ULL << (__force int) pcm_format;
1387}
1388
Takashi Iwai09e56df2014-02-04 18:19:48 +01001389/* printk helpers */
1390#define pcm_err(pcm, fmt, args...) \
1391 dev_err((pcm)->card->dev, fmt, ##args)
1392#define pcm_warn(pcm, fmt, args...) \
1393 dev_warn((pcm)->card->dev, fmt, ##args)
1394#define pcm_dbg(pcm, fmt, args...) \
1395 dev_dbg((pcm)->card->dev, fmt, ##args)
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397#endif /* __SOUND_PCM_H */