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