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