ALSA: pcm: Simplify snd_pcm_playback_silence()
[linux-2.6-block.git] / include / sound / pcm.h
CommitLineData
1da177e4
LT
1#ifndef __SOUND_PCM_H
2#define __SOUND_PCM_H
3
4/*
5 * Digital Audio (PCM) abstract layer
c1017a4c 6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
1da177e4
LT
7 * 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>
f90c06a2 28#include <sound/minors.h>
1da177e4 29#include <linux/poll.h>
f23f6e08 30#include <linux/mm.h>
1da177e4 31#include <linux/bitops.h>
e8db0be1 32#include <linux/pm_qos.h>
1da177e4 33
1da177e4
LT
34#define snd_pcm_substream_chip(substream) ((substream)->private_data)
35#define snd_pcm_chip(pcm) ((pcm)->private_data)
36
6d2412b8 37#if IS_ENABLED(CONFIG_SND_PCM_OSS)
a1ce3928 38#include <sound/pcm_oss.h>
1da177e4
LT
39#endif
40
41/*
42 * Hardware (lowlevel) section
43 */
44
877211f5 45struct snd_pcm_hardware {
1da177e4
LT
46 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 */
877211f5 59};
1da177e4 60
e0e6ce03
RD
61struct snd_pcm_substream;
62
229d0430
PLB
63struct snd_pcm_audio_tstamp_config; /* definitions further down */
64struct snd_pcm_audio_tstamp_report;
65
877211f5
TI
66struct 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,
1da177e4 70 unsigned int cmd, void *arg);
877211f5
TI
71 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);
3179f620
PLB
77 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);
29d1a873
TI
81 int (*fill_silence)(struct snd_pcm_substream *substream, int channel,
82 unsigned long pos, unsigned long bytes);
83 int (*copy_user)(struct snd_pcm_substream *substream, int channel,
84 unsigned long pos, void __user *buf,
85 unsigned long bytes);
86 int (*copy_kernel)(struct snd_pcm_substream *substream, int channel,
87 unsigned long pos, void *buf, unsigned long bytes);
877211f5
TI
88 struct page *(*page)(struct snd_pcm_substream *substream,
89 unsigned long offset);
90 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
91 int (*ack)(struct snd_pcm_substream *substream);
92};
1da177e4
LT
93
94/*
95 *
96 */
97
f90c06a2
PM
98#if defined(CONFIG_SND_DYNAMIC_MINORS)
99#define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
100#else
101#define SNDRV_PCM_DEVICES 8
102#endif
896e6cc2 103
1da177e4
LT
104#define SNDRV_PCM_IOCTL1_RESET 0
105#define SNDRV_PCM_IOCTL1_INFO 1
106#define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
107#define SNDRV_PCM_IOCTL1_GSTATE 3
8bea869c 108#define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
1da177e4
LT
109
110#define SNDRV_PCM_TRIGGER_STOP 0
111#define SNDRV_PCM_TRIGGER_START 1
112#define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
113#define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
114#define SNDRV_PCM_TRIGGER_SUSPEND 5
115#define SNDRV_PCM_TRIGGER_RESUME 6
48d88297 116#define SNDRV_PCM_TRIGGER_DRAIN 7
1da177e4
LT
117
118#define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
119
120/* If you change this don't forget to change rates[] table in pcm_native.c */
121#define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
122#define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
123#define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
124#define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
125#define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
126#define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
127#define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
128#define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
129#define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
130#define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
131#define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
132#define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
133#define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
134
135#define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
136#define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
137
138#define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
139 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
140 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
141#define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
142#define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
143 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
144#define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
145 SNDRV_PCM_RATE_192000)
fea952e5
CL
146#define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
147#define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
148#define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
149#define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
150#define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
151#define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
152#define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
153#define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
154#define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
155#define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
156#define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
157#define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
158#define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
159#define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
160#define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
161#define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
162#define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
163#define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
164#define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
165#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
166#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
167#define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
168#define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
169#define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
170#define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
171#define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
172#define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
173#define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
174#define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
175#define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
176#define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
177#define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
178#define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
179#define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
180#define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
181#define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
182#define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
183#define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
184#define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
185#define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
186#define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
187#define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
188#define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
ef7a4f97
DM
189#define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
190#define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
d4288d3f 191#define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
d42472ec
JL
192#define SNDRV_PCM_FMTBIT_DSD_U16_BE _SNDRV_PCM_FMTBIT(DSD_U16_BE)
193#define SNDRV_PCM_FMTBIT_DSD_U32_BE _SNDRV_PCM_FMTBIT(DSD_U32_BE)
1da177e4
LT
194
195#ifdef SNDRV_LITTLE_ENDIAN
196#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
197#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
198#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
199#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
200#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
201#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
202#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
203#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
204#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
205#endif
206#ifdef SNDRV_BIG_ENDIAN
207#define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
208#define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
209#define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
210#define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
211#define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
212#define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
213#define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
214#define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
215#define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
216#endif
217
877211f5
TI
218struct snd_pcm_file {
219 struct snd_pcm_substream *substream;
548a648b 220 int no_compat_mmap;
1da177e4
LT
221};
222
877211f5
TI
223struct snd_pcm_hw_rule;
224typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
225 struct snd_pcm_hw_rule *rule);
1da177e4 226
877211f5 227struct snd_pcm_hw_rule {
1da177e4 228 unsigned int cond;
1da177e4
LT
229 int var;
230 int deps[4];
d16efa06
LPC
231
232 snd_pcm_hw_rule_func_t func;
1da177e4
LT
233 void *private;
234};
235
877211f5
TI
236struct snd_pcm_hw_constraints {
237 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
1da177e4 238 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
877211f5 239 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
1da177e4
LT
240 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
241 unsigned int rules_num;
242 unsigned int rules_all;
877211f5
TI
243 struct snd_pcm_hw_rule *rules;
244};
1da177e4 245
877211f5
TI
246static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
247 snd_pcm_hw_param_t var)
1da177e4
LT
248{
249 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
250}
251
877211f5
TI
252static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
253 snd_pcm_hw_param_t var)
1da177e4
LT
254{
255 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
256}
257
877211f5 258struct snd_ratnum {
1da177e4
LT
259 unsigned int num;
260 unsigned int den_min, den_max, den_step;
877211f5 261};
1da177e4 262
877211f5 263struct snd_ratden {
1da177e4
LT
264 unsigned int num_min, num_max, num_step;
265 unsigned int den;
877211f5 266};
1da177e4 267
877211f5 268struct snd_pcm_hw_constraint_ratnums {
1da177e4 269 int nrats;
e5e113cf 270 const struct snd_ratnum *rats;
877211f5 271};
1da177e4 272
877211f5 273struct snd_pcm_hw_constraint_ratdens {
1da177e4 274 int nrats;
e5e113cf 275 const struct snd_ratden *rats;
877211f5 276};
1da177e4 277
877211f5 278struct snd_pcm_hw_constraint_list {
4af87a93 279 const unsigned int *list;
782e50e0 280 unsigned int count;
1da177e4 281 unsigned int mask;
877211f5 282};
1da177e4 283
f66f898e
PR
284struct snd_pcm_hw_constraint_ranges {
285 unsigned int count;
286 const struct snd_interval *ranges;
287 unsigned int mask;
288};
289
229d0430
PLB
290/*
291 * userspace-provided audio timestamp config to kernel,
292 * structure is for internal use only and filled with dedicated unpack routine
293 */
294struct snd_pcm_audio_tstamp_config {
295 /* 5 of max 16 bits used */
296 u32 type_requested:4;
297 u32 report_delay:1; /* add total delay to A/D or D/A */
298};
299
300static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
301 struct snd_pcm_audio_tstamp_config *config)
302{
303 config->type_requested = data & 0xF;
304 config->report_delay = (data >> 4) & 1;
305}
306
307/*
308 * kernel-provided audio timestamp report to user-space
309 * structure is for internal use only and read by dedicated pack routine
310 */
311struct snd_pcm_audio_tstamp_report {
312 /* 6 of max 16 bits used for bit-fields */
313
314 /* for backwards compatibility */
315 u32 valid:1;
316
317 /* actual type if hardware could not support requested timestamp */
318 u32 actual_type:4;
319
320 /* accuracy represented in ns units */
321 u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
322 u32 accuracy; /* up to 4.29s, will be packed in separate field */
323};
324
325static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
326 const struct snd_pcm_audio_tstamp_report *report)
327{
328 u32 tmp;
329
330 tmp = report->accuracy_report;
331 tmp <<= 4;
332 tmp |= report->actual_type;
333 tmp <<= 1;
334 tmp |= report->valid;
335
336 *data &= 0xffff; /* zero-clear MSBs */
337 *data |= (tmp << 16);
338 *accuracy = report->accuracy;
339}
340
341
877211f5 342struct snd_pcm_runtime {
1da177e4 343 /* -- Status -- */
877211f5 344 struct snd_pcm_substream *trigger_master;
07799e75 345 struct timespec trigger_tstamp; /* trigger timestamp */
2b79d7a6 346 bool trigger_tstamp_latched; /* trigger timestamp latched in low-level driver/hardware */
1da177e4
LT
347 int overrange;
348 snd_pcm_uframes_t avail_max;
349 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
e7636925 350 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
bbf6ad13 351 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
bd76af0f 352 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
4bbe1ddf 353 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
0e8014d7 354 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
1da177e4
LT
355
356 /* -- HW params -- */
357 snd_pcm_access_t access; /* access mode */
358 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
359 snd_pcm_subformat_t subformat; /* subformat */
360 unsigned int rate; /* rate in Hz */
361 unsigned int channels; /* channels */
362 snd_pcm_uframes_t period_size; /* period size */
363 unsigned int periods; /* periods */
364 snd_pcm_uframes_t buffer_size; /* buffer size */
1da177e4
LT
365 snd_pcm_uframes_t min_align; /* Min alignment for the format */
366 size_t byte_align;
367 unsigned int frame_bits;
368 unsigned int sample_bits;
369 unsigned int info;
370 unsigned int rate_num;
371 unsigned int rate_den;
ab69a490 372 unsigned int no_period_wakeup: 1;
1da177e4
LT
373
374 /* -- SW params -- */
877211f5 375 int tstamp_mode; /* mmap timestamp is updated */
1da177e4 376 unsigned int period_step;
1da177e4
LT
377 snd_pcm_uframes_t start_threshold;
378 snd_pcm_uframes_t stop_threshold;
379 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
380 noise is nearest than this */
381 snd_pcm_uframes_t silence_size; /* Silence filling size */
382 snd_pcm_uframes_t boundary; /* pointers wrap point */
383
384 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
385 snd_pcm_uframes_t silence_filled; /* size filled with silence */
386
877211f5 387 union snd_pcm_sync_id sync; /* hardware synchronization ID */
1da177e4
LT
388
389 /* -- mmap -- */
503fc85a
TI
390 struct snd_pcm_mmap_status *status;
391 struct snd_pcm_mmap_control *control;
1da177e4
LT
392
393 /* -- locking / scheduling -- */
5daeba34 394 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
c91a988d
JK
395 wait_queue_head_t sleep; /* poll sleep */
396 wait_queue_head_t tsleep; /* transfer sleep */
1da177e4
LT
397 struct fasync_struct *fasync;
398
399 /* -- private section -- */
400 void *private_data;
877211f5 401 void (*private_free)(struct snd_pcm_runtime *runtime);
1da177e4
LT
402
403 /* -- hardware description -- */
877211f5
TI
404 struct snd_pcm_hardware hw;
405 struct snd_pcm_hw_constraints hw_constraints;
1da177e4 406
1da177e4
LT
407 /* -- timer -- */
408 unsigned int timer_resolution; /* timer resolution */
b751eef1 409 int tstamp_type; /* timestamp type */
1da177e4
LT
410
411 /* -- DMA -- */
412 unsigned char *dma_area; /* DMA area */
413 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
414 size_t dma_bytes; /* size of DMA area */
415
416 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
417
229d0430
PLB
418 /* -- audio timestamp config -- */
419 struct snd_pcm_audio_tstamp_config audio_tstamp_config;
420 struct snd_pcm_audio_tstamp_report audio_tstamp_report;
421 struct timespec driver_tstamp;
422
6d2412b8 423#if IS_ENABLED(CONFIG_SND_PCM_OSS)
1da177e4 424 /* -- OSS things -- */
877211f5 425 struct snd_pcm_oss_runtime oss;
1da177e4
LT
426#endif
427};
428
877211f5 429struct snd_pcm_group { /* keep linked substreams */
1da177e4 430 spinlock_t lock;
257f8cce 431 struct mutex mutex;
1da177e4
LT
432 struct list_head substreams;
433 int count;
877211f5 434};
1da177e4 435
e7373b70
CL
436struct pid;
437
877211f5
TI
438struct snd_pcm_substream {
439 struct snd_pcm *pcm;
440 struct snd_pcm_str *pstr;
1da177e4
LT
441 void *private_data; /* copied from pcm->private_data */
442 int number;
443 char name[32]; /* substream name */
444 int stream; /* stream (direction) */
cc749986 445 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
1da177e4
LT
446 size_t buffer_bytes_max; /* limit ring buffer size */
447 struct snd_dma_buffer dma_buffer;
1da177e4
LT
448 size_t dma_max;
449 /* -- hardware operations -- */
e6c2e7eb 450 const struct snd_pcm_ops *ops;
1da177e4 451 /* -- runtime information -- */
877211f5 452 struct snd_pcm_runtime *runtime;
1da177e4 453 /* -- timer section -- */
877211f5 454 struct snd_timer *timer; /* timer */
1da177e4 455 unsigned timer_running: 1; /* time is running */
1da177e4 456 /* -- next substream -- */
877211f5 457 struct snd_pcm_substream *next;
1da177e4
LT
458 /* -- linked substreams -- */
459 struct list_head link_list; /* linked list member */
877211f5
TI
460 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
461 struct snd_pcm_group *group; /* pointer to current group */
1da177e4 462 /* -- assigned files -- */
1576274d 463 void *file;
0df63e44 464 int ref_count;
9c323fcb 465 atomic_t mmap_count;
0df63e44 466 unsigned int f_flags;
3bf75f9b 467 void (*pcm_release)(struct snd_pcm_substream *);
e7373b70 468 struct pid *pid;
6d2412b8 469#if IS_ENABLED(CONFIG_SND_PCM_OSS)
1da177e4 470 /* -- OSS things -- */
877211f5 471 struct snd_pcm_oss_substream oss;
1da177e4 472#endif
b7d90a35 473#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI
474 struct snd_info_entry *proc_root;
475 struct snd_info_entry *proc_info_entry;
476 struct snd_info_entry *proc_hw_params_entry;
477 struct snd_info_entry *proc_sw_params_entry;
478 struct snd_info_entry *proc_status_entry;
479 struct snd_info_entry *proc_prealloc_entry;
c7132aeb 480 struct snd_info_entry *proc_prealloc_max_entry;
2b30d411
TI
481#ifdef CONFIG_SND_PCM_XRUN_DEBUG
482 struct snd_info_entry *proc_xrun_injection_entry;
b7d90a35 483#endif
2b30d411 484#endif /* CONFIG_SND_VERBOSE_PROCFS */
1da177e4 485 /* misc flags */
3bf75f9b 486 unsigned int hw_opened: 1;
1da177e4
LT
487};
488
0df63e44 489#define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
1da177e4
LT
490
491
877211f5 492struct snd_pcm_str {
1da177e4 493 int stream; /* stream (direction) */
877211f5 494 struct snd_pcm *pcm;
1da177e4
LT
495 /* -- substreams -- */
496 unsigned int substream_count;
497 unsigned int substream_opened;
877211f5 498 struct snd_pcm_substream *substream;
6d2412b8 499#if IS_ENABLED(CONFIG_SND_PCM_OSS)
1da177e4 500 /* -- OSS things -- */
877211f5 501 struct snd_pcm_oss_stream oss;
1da177e4 502#endif
b7d90a35 503#ifdef CONFIG_SND_VERBOSE_PROCFS
877211f5
TI
504 struct snd_info_entry *proc_root;
505 struct snd_info_entry *proc_info_entry;
b7d90a35 506#ifdef CONFIG_SND_PCM_XRUN_DEBUG
1da177e4 507 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
877211f5 508 struct snd_info_entry *proc_xrun_debug_entry;
1da177e4 509#endif
b7d90a35 510#endif
2d3391ec 511 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
ef46c7af 512 struct device dev;
1da177e4
LT
513};
514
877211f5
TI
515struct snd_pcm {
516 struct snd_card *card;
f87135f5 517 struct list_head list;
f90c06a2 518 int device; /* device number */
1da177e4
LT
519 unsigned int info_flags;
520 unsigned short dev_class;
521 unsigned short dev_subclass;
522 char id[64];
523 char name[80];
877211f5 524 struct snd_pcm_str streams[2];
1a60d4c5 525 struct mutex open_mutex;
1da177e4
LT
526 wait_queue_head_t open_wait;
527 void *private_data;
877211f5 528 void (*private_free) (struct snd_pcm *pcm);
945e5038 529 bool internal; /* pcm is for internal use only */
257f8cce 530 bool nonatomic; /* whole PCM operations are in non-atomic context */
6d2412b8 531#if IS_ENABLED(CONFIG_SND_PCM_OSS)
877211f5 532 struct snd_pcm_oss oss;
1da177e4
LT
533#endif
534};
535
1da177e4
LT
536/*
537 * Registering
538 */
539
54047320 540extern const struct file_operations snd_pcm_f_ops[2];
1da177e4 541
e6161653 542int snd_pcm_new(struct snd_card *card, const char *id, int device,
1da177e4 543 int playback_count, int capture_count,
877211f5 544 struct snd_pcm **rpcm);
945e5038
LG
545int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
546 int playback_count, int capture_count,
547 struct snd_pcm **rpcm);
877211f5 548int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
1da177e4 549
58f30d65
TI
550#if IS_ENABLED(CONFIG_SND_PCM_OSS)
551struct snd_pcm_notify {
552 int (*n_register) (struct snd_pcm * pcm);
553 int (*n_disconnect) (struct snd_pcm * pcm);
554 int (*n_unregister) (struct snd_pcm * pcm);
555 struct list_head list;
556};
877211f5 557int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
58f30d65 558#endif
1da177e4
LT
559
560/*
561 * Native I/O
562 */
563
877211f5
TI
564int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
565int snd_pcm_info_user(struct snd_pcm_substream *substream,
566 struct snd_pcm_info __user *info);
567int snd_pcm_status(struct snd_pcm_substream *substream,
568 struct snd_pcm_status *status);
877211f5 569int snd_pcm_start(struct snd_pcm_substream *substream);
fea952e5 570int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
877211f5 571int snd_pcm_drain_done(struct snd_pcm_substream *substream);
1fb8510c 572int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
1da177e4 573#ifdef CONFIG_PM
877211f5
TI
574int snd_pcm_suspend(struct snd_pcm_substream *substream);
575int snd_pcm_suspend_all(struct snd_pcm *pcm);
1cf05ba2
TI
576#else
577static inline int snd_pcm_suspend(struct snd_pcm_substream *substream)
578{
579 return 0;
580}
581static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
582{
583 return 0;
584}
1da177e4 585#endif
877211f5 586int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
3bf75f9b
TI
587int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
588 struct snd_pcm_substream **rsubstream);
877211f5 589void snd_pcm_release_substream(struct snd_pcm_substream *substream);
3bf75f9b
TI
590int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
591 struct snd_pcm_substream **rsubstream);
592void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
877211f5 593int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
1da177e4 594
acb03d44
EB
595
596#ifdef CONFIG_SND_DEBUG
597void snd_pcm_debug_name(struct snd_pcm_substream *substream,
598 char *name, size_t len);
599#else
600static inline void
601snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
602{
603 *buf = 0;
604}
605#endif
606
1da177e4
LT
607/*
608 * PCM library
609 */
610
30b771cf
TI
611/**
612 * snd_pcm_stream_linked - Check whether the substream is linked with others
613 * @substream: substream to check
614 *
615 * Returns true if the given substream is being linked with others.
616 */
877211f5 617static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
1da177e4
LT
618{
619 return substream->group != &substream->self_group;
620}
621
7af142f7
TI
622void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
623void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
624void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
625void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
626unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
30b771cf
TI
627
628/**
629 * snd_pcm_stream_lock_irqsave - Lock the PCM stream
630 * @substream: PCM substream
631 * @flags: irq flags
632 *
633 * This locks the PCM stream like snd_pcm_stream_lock() but with the local
634 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
635 * as snd_pcm_stream_lock().
636 */
7af142f7
TI
637#define snd_pcm_stream_lock_irqsave(substream, flags) \
638 do { \
639 typecheck(unsigned long, flags); \
640 flags = _snd_pcm_stream_lock_irqsave(substream); \
641 } while (0)
642void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
643 unsigned long flags);
1da177e4 644
30b771cf
TI
645/**
646 * snd_pcm_group_for_each_entry - iterate over the linked substreams
647 * @s: the iterator
648 * @substream: the substream
649 *
650 * Iterate over the all linked substreams to the given @substream.
651 * When @substream isn't linked with any others, this gives returns @substream
652 * itself once.
653 */
ef991b95
TI
654#define snd_pcm_group_for_each_entry(s, substream) \
655 list_for_each_entry(s, &substream->group->substreams, link_list)
1da177e4 656
30b771cf
TI
657/**
658 * snd_pcm_running - Check whether the substream is in a running state
659 * @substream: substream to check
660 *
661 * Returns true if the given substream is in the state RUNNING, or in the
662 * state DRAINING for playback.
663 */
877211f5 664static inline int snd_pcm_running(struct snd_pcm_substream *substream)
1da177e4
LT
665{
666 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
667 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
668 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
669}
670
30b771cf
TI
671/**
672 * bytes_to_samples - Unit conversion of the size from bytes to samples
673 * @runtime: PCM runtime instance
674 * @size: size in bytes
675 */
877211f5 676static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
677{
678 return size * 8 / runtime->sample_bits;
679}
680
30b771cf
TI
681/**
682 * bytes_to_frames - Unit conversion of the size from bytes to frames
683 * @runtime: PCM runtime instance
684 * @size: size in bytes
685 */
877211f5 686static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
687{
688 return size * 8 / runtime->frame_bits;
689}
690
30b771cf
TI
691/**
692 * samples_to_bytes - Unit conversion of the size from samples to bytes
693 * @runtime: PCM runtime instance
694 * @size: size in samples
695 */
877211f5 696static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
1da177e4
LT
697{
698 return size * runtime->sample_bits / 8;
699}
700
30b771cf
TI
701/**
702 * frames_to_bytes - Unit conversion of the size from frames to bytes
703 * @runtime: PCM runtime instance
704 * @size: size in frames
705 */
877211f5 706static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
1da177e4
LT
707{
708 return size * runtime->frame_bits / 8;
709}
710
30b771cf
TI
711/**
712 * frame_aligned - Check whether the byte size is aligned to frames
713 * @runtime: PCM runtime instance
714 * @bytes: size in bytes
715 */
877211f5 716static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
1da177e4
LT
717{
718 return bytes % runtime->byte_align == 0;
719}
720
30b771cf
TI
721/**
722 * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
723 * @substream: PCM substream
724 */
877211f5 725static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
1da177e4 726{
877211f5 727 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
728 return frames_to_bytes(runtime, runtime->buffer_size);
729}
730
30b771cf
TI
731/**
732 * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
733 * @substream: PCM substream
734 */
877211f5 735static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
1da177e4 736{
877211f5 737 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
738 return frames_to_bytes(runtime, runtime->period_size);
739}
740
30b771cf
TI
741/**
742 * snd_pcm_playback_avail - Get the available (writable) space for playback
743 * @runtime: PCM runtime instance
744 *
745 * Result is between 0 ... (boundary - 1)
1da177e4 746 */
877211f5 747static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
748{
749 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
750 if (avail < 0)
751 avail += runtime->boundary;
752 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
753 avail -= runtime->boundary;
754 return avail;
755}
756
30b771cf
TI
757/**
758 * snd_pcm_playback_avail - Get the available (readable) space for capture
759 * @runtime: PCM runtime instance
760 *
761 * Result is between 0 ... (boundary - 1)
1da177e4 762 */
877211f5 763static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
764{
765 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
766 if (avail < 0)
767 avail += runtime->boundary;
768 return avail;
769}
770
30b771cf
TI
771/**
772 * snd_pcm_playback_hw_avail - Get the queued space for playback
773 * @runtime: PCM runtime instance
774 */
877211f5 775static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
776{
777 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
778}
779
30b771cf
TI
780/**
781 * snd_pcm_capture_hw_avail - Get the free space for capture
782 * @runtime: PCM runtime instance
783 */
877211f5 784static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
1da177e4
LT
785{
786 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
787}
788
789/**
790 * snd_pcm_playback_ready - check whether the playback buffer is available
791 * @substream: the pcm substream instance
792 *
793 * Checks whether enough free space is available on the playback buffer.
794 *
eb7c06e8 795 * Return: Non-zero if available, or zero if not.
1da177e4 796 */
877211f5 797static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
1da177e4 798{
877211f5 799 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
800 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
801}
802
803/**
804 * snd_pcm_capture_ready - check whether the capture buffer is available
805 * @substream: the pcm substream instance
806 *
807 * Checks whether enough capture data is available on the capture buffer.
808 *
eb7c06e8 809 * Return: Non-zero if available, or zero if not.
1da177e4 810 */
877211f5 811static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
1da177e4 812{
877211f5 813 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
814 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
815}
816
817/**
818 * snd_pcm_playback_data - check whether any data exists on the playback buffer
819 * @substream: the pcm substream instance
820 *
eb7c06e8 821 * Checks whether any data exists on the playback buffer.
1da177e4 822 *
eb7c06e8
YB
823 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
824 * is bigger or equal to boundary, then this function returns always non-zero.
1da177e4 825 */
877211f5 826static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
1da177e4 827{
877211f5 828 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
829
830 if (runtime->stop_threshold >= runtime->boundary)
831 return 1;
832 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
833}
834
835/**
836 * snd_pcm_playback_empty - check whether the playback buffer is empty
837 * @substream: the pcm substream instance
838 *
839 * Checks whether the playback buffer is empty.
840 *
eb7c06e8 841 * Return: Non-zero if empty, or zero if not.
1da177e4 842 */
877211f5 843static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
1da177e4 844{
877211f5 845 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
846 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
847}
848
849/**
850 * snd_pcm_capture_empty - check whether the capture buffer is empty
851 * @substream: the pcm substream instance
852 *
853 * Checks whether the capture buffer is empty.
854 *
eb7c06e8 855 * Return: Non-zero if empty, or zero if not.
1da177e4 856 */
877211f5 857static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
1da177e4 858{
877211f5 859 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
860 return snd_pcm_capture_avail(runtime) == 0;
861}
862
30b771cf
TI
863/**
864 * snd_pcm_trigger_done - Mark the master substream
865 * @substream: the pcm substream instance
866 * @master: the linked master substream
867 *
868 * When multiple substreams of the same card are linked and the hardware
869 * supports the single-shot operation, the driver calls this in the loop
870 * in snd_pcm_group_for_each_entry() for marking the substream as "done".
871 * Then most of trigger operations are performed only to the given master
872 * substream.
873 *
874 * The trigger_master mark is cleared at timestamp updates at the end
875 * of trigger operations.
876 */
877211f5
TI
877static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
878 struct snd_pcm_substream *master)
1da177e4
LT
879{
880 substream->runtime->trigger_master = master;
881}
882
883static inline int hw_is_mask(int var)
884{
885 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
886 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
887}
888
889static inline int hw_is_interval(int var)
890{
891 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
892 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
893}
894
877211f5 895static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
1da177e4
LT
896 snd_pcm_hw_param_t var)
897{
898 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
899}
900
877211f5 901static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
1da177e4
LT
902 snd_pcm_hw_param_t var)
903{
904 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
905}
906
877211f5 907static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
1da177e4
LT
908 snd_pcm_hw_param_t var)
909{
b9f09a48 910 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
1da177e4
LT
911}
912
877211f5 913static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
1da177e4
LT
914 snd_pcm_hw_param_t var)
915{
b9f09a48 916 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
1da177e4
LT
917}
918
85926e0f
TI
919/**
920 * params_channels - Get the number of channels from the hw params
921 * @p: hw params
922 */
923static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
924{
925 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
926}
927
928/**
62f64a88 929 * params_rate - Get the sample rate from the hw params
85926e0f
TI
930 * @p: hw params
931 */
932static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
933{
934 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
935}
936
937/**
62f64a88 938 * params_period_size - Get the period size (in frames) from the hw params
85926e0f
TI
939 * @p: hw params
940 */
941static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
942{
943 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
944}
945
946/**
62f64a88 947 * params_periods - Get the number of periods from the hw params
85926e0f
TI
948 * @p: hw params
949 */
950static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
951{
952 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
953}
954
955/**
62f64a88 956 * params_buffer_size - Get the buffer size (in frames) from the hw params
85926e0f
TI
957 * @p: hw params
958 */
959static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
960{
961 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
962}
963
964/**
62f64a88 965 * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
85926e0f
TI
966 * @p: hw params
967 */
968static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
969{
970 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
971}
1da177e4 972
877211f5 973int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
4af87a93
MB
974int snd_interval_list(struct snd_interval *i, unsigned int count,
975 const unsigned int *list, unsigned int mask);
f66f898e
PR
976int snd_interval_ranges(struct snd_interval *i, unsigned int count,
977 const struct snd_interval *list, unsigned int mask);
877211f5 978int snd_interval_ratnum(struct snd_interval *i,
e5e113cf 979 unsigned int rats_count, const struct snd_ratnum *rats,
1da177e4
LT
980 unsigned int *nump, unsigned int *denp);
981
877211f5
TI
982void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
983void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
1da177e4 984
877211f5 985int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
1da177e4 986
877211f5 987int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 988 u_int64_t mask);
877211f5 989int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1da177e4 990 unsigned int min, unsigned int max);
877211f5
TI
991int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
992int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
1da177e4
LT
993 unsigned int cond,
994 snd_pcm_hw_param_t var,
1464189f 995 const struct snd_pcm_hw_constraint_list *l);
f66f898e
PR
996int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
997 unsigned int cond,
998 snd_pcm_hw_param_t var,
999 const struct snd_pcm_hw_constraint_ranges *r);
877211f5 1000int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
1da177e4
LT
1001 unsigned int cond,
1002 snd_pcm_hw_param_t var,
e5e113cf 1003 const struct snd_pcm_hw_constraint_ratnums *r);
877211f5 1004int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
1da177e4
LT
1005 unsigned int cond,
1006 snd_pcm_hw_param_t var,
e5e113cf 1007 const struct snd_pcm_hw_constraint_ratdens *r);
877211f5 1008int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1da177e4
LT
1009 unsigned int cond,
1010 unsigned int width,
1011 unsigned int msbits);
877211f5 1012int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1da177e4
LT
1013 unsigned int cond,
1014 snd_pcm_hw_param_t var,
1015 unsigned long step);
877211f5 1016int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1da177e4
LT
1017 unsigned int cond,
1018 snd_pcm_hw_param_t var);
d5b702a6
CL
1019int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1020 unsigned int base_rate);
877211f5 1021int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1da177e4
LT
1022 unsigned int cond,
1023 int var,
1024 snd_pcm_hw_rule_func_t func, void *private,
1025 int dep, ...);
1026
bc1043cd
LPC
1027/**
1028 * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1029 * @runtime: PCM runtime instance
1030 * @var: The hw_params variable to constrain
1031 * @val: The value to constrain to
1032 *
1033 * Return: Positive if the value is changed, zero if it's not changed, or a
1034 * negative error code.
1035 */
1036static inline int snd_pcm_hw_constraint_single(
1037 struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1038 unsigned int val)
1039{
1040 return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1041}
1042
1da177e4
LT
1043int snd_pcm_format_signed(snd_pcm_format_t format);
1044int snd_pcm_format_unsigned(snd_pcm_format_t format);
1045int snd_pcm_format_linear(snd_pcm_format_t format);
1046int snd_pcm_format_little_endian(snd_pcm_format_t format);
1047int snd_pcm_format_big_endian(snd_pcm_format_t format);
52204718 1048#if 0 /* just for kernel-doc */
1b44c28d 1049/**
9502dcad
TI
1050 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1051 * @format: the format to check
1052 *
eb7c06e8 1053 * Return: 1 if the given PCM format is CPU-endian, 0 if
9502dcad
TI
1054 * opposite, or a negative error code if endian not specified.
1055 */
8cdfd251 1056int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1b44c28d 1057#endif /* DocBook */
9502dcad 1058#ifdef SNDRV_LITTLE_ENDIAN
9d01a82e 1059#define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
9502dcad 1060#else
9d01a82e 1061#define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
9502dcad 1062#endif
1da177e4
LT
1063int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1064int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
9502dcad 1065ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1da177e4
LT
1066const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1067int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1da177e4 1068
e6c2e7eb
LPC
1069void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1070 const struct snd_pcm_ops *ops);
877211f5 1071void snd_pcm_set_sync(struct snd_pcm_substream *substream);
877211f5 1072int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1da177e4 1073 unsigned int cmd, void *arg);
877211f5 1074void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
5c7264cf 1075snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
c48f12ee
TI
1076 void *buf, bool interleaved,
1077 snd_pcm_uframes_t frames);
1078
1079static inline snd_pcm_sframes_t
1080snd_pcm_lib_write(struct snd_pcm_substream *substream,
1081 const void __user *buf, snd_pcm_uframes_t frames)
1082{
5c7264cf 1083 return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames);
c48f12ee
TI
1084}
1085
1086static inline snd_pcm_sframes_t
1087snd_pcm_lib_read(struct snd_pcm_substream *substream,
1088 void __user *buf, snd_pcm_uframes_t frames)
1089{
5c7264cf 1090 return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames);
c48f12ee
TI
1091}
1092
1093static inline snd_pcm_sframes_t
1094snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1095 void __user **bufs, snd_pcm_uframes_t frames)
1096{
5c7264cf 1097 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames);
c48f12ee
TI
1098}
1099
1100static inline snd_pcm_sframes_t
1101snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1102 void __user **bufs, snd_pcm_uframes_t frames)
1103{
5c7264cf 1104 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames);
c48f12ee 1105}
1da177e4 1106
877211f5 1107int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
918f3a0e 1108unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
4be77a53 1109unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
e3a9269f
LPC
1110unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1111 unsigned int rates_b);
3bdff244
ML
1112unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1113 unsigned int rate_max);
1da177e4 1114
30b771cf
TI
1115/**
1116 * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1117 * @substream: PCM substream to set
1118 * @bufp: the buffer information, NULL to clear
1119 *
1120 * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1121 * Otherwise it clears the current buffer information.
1122 */
877211f5 1123static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1da177e4
LT
1124 struct snd_dma_buffer *bufp)
1125{
877211f5 1126 struct snd_pcm_runtime *runtime = substream->runtime;
1da177e4
LT
1127 if (bufp) {
1128 runtime->dma_buffer_p = bufp;
1129 runtime->dma_area = bufp->area;
1130 runtime->dma_addr = bufp->addr;
1131 runtime->dma_bytes = bufp->bytes;
1132 } else {
1133 runtime->dma_buffer_p = NULL;
1134 runtime->dma_area = NULL;
1135 runtime->dma_addr = 0;
1136 runtime->dma_bytes = 0;
1137 }
1138}
1139
30b771cf
TI
1140/**
1141 * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1142 * @runtime: PCM runtime instance
1143 * @tv: timespec to fill
1144 */
b751eef1
JK
1145static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1146 struct timespec *tv)
1147{
0ac8a52d
MB
1148 switch (runtime->tstamp_type) {
1149 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
26204e04 1150 ktime_get_ts(tv);
0ac8a52d
MB
1151 break;
1152 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1153 getrawmonotonic(tv);
1154 break;
1155 default:
b751eef1 1156 getnstimeofday(tv);
0ac8a52d
MB
1157 break;
1158 }
b751eef1
JK
1159}
1160
1da177e4
LT
1161/*
1162 * Memory
1163 */
1164
877211f5
TI
1165int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1166int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1167int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1da177e4
LT
1168 int type, struct device *data,
1169 size_t size, size_t max);
877211f5 1170int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1da177e4
LT
1171 int type, void *data,
1172 size_t size, size_t max);
877211f5
TI
1173int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1174int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1da177e4 1175
681b84e1
CL
1176int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1177 size_t size, gfp_t gfp_flags);
1178int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1179struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1180 unsigned long offset);
681b84e1
CL
1181/**
1182 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1183 * @substream: the substream to allocate the buffer to
1184 * @size: the requested buffer size, in bytes
1185 *
1186 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1187 * contiguous in kernel virtual space, but not in physical memory. Use this
1188 * if the buffer is accessed by kernel code but not by device DMA.
1189 *
eb7c06e8 1190 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
681b84e1
CL
1191 * code.
1192 */
f213d8f7
TI
1193static inline int snd_pcm_lib_alloc_vmalloc_buffer
1194 (struct snd_pcm_substream *substream, size_t size)
1195{
1196 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1197 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1198}
1199
681b84e1
CL
1200/**
1201 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1202 * @substream: the substream to allocate the buffer to
1203 * @size: the requested buffer size, in bytes
1204 *
1205 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1206 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
eb7c06e8
YB
1207 *
1208 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1209 * code.
681b84e1 1210 */
f213d8f7
TI
1211static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1212 (struct snd_pcm_substream *substream, size_t size)
1213{
1214 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1215 GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1216}
681b84e1 1217
9d069dc0
TI
1218#define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1219
cc6a8acd 1220#ifdef CONFIG_SND_DMA_SGBUF
77a23f26
TI
1221/*
1222 * SG-buffer handling
1223 */
1224#define snd_pcm_substream_sgbuf(substream) \
9d069dc0 1225 snd_pcm_get_dma_buf(substream)->private_data
77a23f26
TI
1226
1227struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1228 unsigned long offset);
cc6a8acd
TI
1229#else /* !SND_DMA_SGBUF */
1230/*
1231 * fake using a continuous buffer
1232 */
9d069dc0
TI
1233#define snd_pcm_sgbuf_ops_page NULL
1234#endif /* SND_DMA_SGBUF */
1235
30b771cf
TI
1236/**
1237 * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1238 * @substream: PCM substream
1239 * @ofs: byte offset
1240 */
cc6a8acd
TI
1241static inline dma_addr_t
1242snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1243{
9d069dc0 1244 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI
1245}
1246
30b771cf
TI
1247/**
1248 * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1249 * @substream: PCM substream
1250 * @ofs: byte offset
1251 */
cc6a8acd
TI
1252static inline void *
1253snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1254{
9d069dc0 1255 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
cc6a8acd
TI
1256}
1257
30b771cf
TI
1258/**
1259 * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1260 * page from the given size
1261 * @substream: PCM substream
1262 * @ofs: byte offset
1263 * @size: byte size to examine
1264 */
9d069dc0
TI
1265static inline unsigned int
1266snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1267 unsigned int ofs, unsigned int size)
1268{
1269 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1270}
cc6a8acd 1271
30b771cf
TI
1272/**
1273 * snd_pcm_mmap_data_open - increase the mmap counter
1274 * @area: VMA
1275 *
1276 * PCM mmap callback should handle this counter properly
1277 */
1da177e4
LT
1278static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1279{
877211f5 1280 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1281 atomic_inc(&substream->mmap_count);
1da177e4
LT
1282}
1283
30b771cf
TI
1284/**
1285 * snd_pcm_mmap_data_close - decrease the mmap counter
1286 * @area: VMA
1287 *
1288 * PCM mmap callback should handle this counter properly
1289 */
1da177e4
LT
1290static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1291{
877211f5 1292 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
9c323fcb 1293 atomic_dec(&substream->mmap_count);
1da177e4
LT
1294}
1295
18a2b962
TI
1296int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1297 struct vm_area_struct *area);
1da177e4
LT
1298/* mmap for io-memory area */
1299#if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1300#define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
877211f5 1301int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1da177e4
LT
1302#else
1303#define SNDRV_PCM_INFO_MMAP_IOMEM 0
1304#define snd_pcm_lib_mmap_iomem NULL
1305#endif
1306
3674f19d 1307#define snd_pcm_lib_mmap_vmalloc NULL
c32d977b 1308
30b771cf
TI
1309/**
1310 * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1311 * @dma: DMA number
1312 * @max: pointer to store the max size
1313 */
1da177e4
LT
1314static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1315{
1316 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1317}
1318
1319/*
1320 * Misc
1321 */
1322
1323#define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1324 (IEC958_AES1_CON_ORIGINAL<<8)|\
1325 (IEC958_AES1_CON_PCM_CODER<<8)|\
1326 (IEC958_AES3_CON_FS_48000<<24))
1327
7eaa943c
TI
1328#define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1329
6e5265ec
TI
1330const char *snd_pcm_format_name(snd_pcm_format_t format);
1331
1aad779f 1332/**
8513915a
RD
1333 * snd_pcm_stream_str - Get a string naming the direction of a stream
1334 * @substream: the pcm substream instance
eb7c06e8
YB
1335 *
1336 * Return: A string naming the direction of the stream.
1aad779f
OL
1337 */
1338static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1339{
1340 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1341 return "Playback";
1342 else
1343 return "Capture";
1344}
1345
2d3391ec
TI
1346/*
1347 * PCM channel-mapping control API
1348 */
1349/* array element of channel maps */
1350struct snd_pcm_chmap_elem {
1351 unsigned char channels;
1352 unsigned char map[15];
1353};
1354
1355/* channel map information; retrieved via snd_kcontrol_chip() */
1356struct snd_pcm_chmap {
1357 struct snd_pcm *pcm; /* assigned PCM instance */
1358 int stream; /* PLAYBACK or CAPTURE */
1359 struct snd_kcontrol *kctl;
1360 const struct snd_pcm_chmap_elem *chmap;
1361 unsigned int max_channels;
1362 unsigned int channel_mask; /* optional: active channels bitmask */
1363 void *private_data; /* optional: private data pointer */
1364};
1365
30b771cf
TI
1366/**
1367 * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1368 * @info: chmap information
1369 * @idx: the substream number index
1370 */
2d3391ec
TI
1371static inline struct snd_pcm_substream *
1372snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1373{
1374 struct snd_pcm_substream *s;
1375 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1376 if (s->number == idx)
1377 return s;
1378 return NULL;
1379}
1380
1381/* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1382extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1383/* Other world's standard channel maps (C/LFE prior to RL/RR) */
1384extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1385
1386/* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1387#define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1388#define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1389#define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1390
1391int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1392 const struct snd_pcm_chmap_elem *chmap,
1393 int max_channels,
1394 unsigned long private_value,
1395 struct snd_pcm_chmap **info_ret);
1396
30b771cf
TI
1397/**
1398 * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1399 * @pcm_format: PCM format
1400 */
74c34ca1
EZ
1401static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1402{
1403 return 1ULL << (__force int) pcm_format;
1404}
1405
09e56df8
TI
1406/* printk helpers */
1407#define pcm_err(pcm, fmt, args...) \
1408 dev_err((pcm)->card->dev, fmt, ##args)
1409#define pcm_warn(pcm, fmt, args...) \
1410 dev_warn((pcm)->card->dev, fmt, ##args)
1411#define pcm_dbg(pcm, fmt, args...) \
1412 dev_dbg((pcm)->card->dev, fmt, ##args)
1413
1da177e4 1414#endif /* __SOUND_PCM_H */