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