1 /* SPDX-License-Identifier: GPL-2.0-or-later */
6 * Digital Audio (PCM) abstract layer
7 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
8 * Abramo Bagnara <abramo@alsa-project.org>
11 #include <sound/asound.h>
12 #include <sound/memalloc.h>
13 #include <sound/minors.h>
14 #include <linux/poll.h>
16 #include <linux/bitops.h>
17 #include <linux/pm_qos.h>
18 #include <linux/refcount.h>
20 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
21 #define snd_pcm_chip(pcm) ((pcm)->private_data)
23 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
24 #include <sound/pcm_oss.h>
28 * Hardware (lowlevel) section
31 struct snd_pcm_hardware {
32 unsigned int info; /* SNDRV_PCM_INFO_* */
33 u64 formats; /* SNDRV_PCM_FMTBIT_* */
34 unsigned int rates; /* SNDRV_PCM_RATE_* */
35 unsigned int rate_min; /* min rate */
36 unsigned int rate_max; /* max rate */
37 unsigned int channels_min; /* min channels */
38 unsigned int channels_max; /* max channels */
39 size_t buffer_bytes_max; /* max buffer size */
40 size_t period_bytes_min; /* min period size */
41 size_t period_bytes_max; /* max period size */
42 unsigned int periods_min; /* min # of periods */
43 unsigned int periods_max; /* max # of periods */
44 size_t fifo_size; /* fifo size in bytes */
47 struct snd_pcm_substream;
49 struct snd_pcm_audio_tstamp_config; /* definitions further down */
50 struct snd_pcm_audio_tstamp_report;
53 int (*open)(struct snd_pcm_substream *substream);
54 int (*close)(struct snd_pcm_substream *substream);
55 int (*ioctl)(struct snd_pcm_substream * substream,
56 unsigned int cmd, void *arg);
57 int (*hw_params)(struct snd_pcm_substream *substream,
58 struct snd_pcm_hw_params *params);
59 int (*hw_free)(struct snd_pcm_substream *substream);
60 int (*prepare)(struct snd_pcm_substream *substream);
61 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
62 int (*sync_stop)(struct snd_pcm_substream *substream);
63 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
64 int (*get_time_info)(struct snd_pcm_substream *substream,
65 struct timespec *system_ts, struct timespec *audio_ts,
66 struct snd_pcm_audio_tstamp_config *audio_tstamp_config,
67 struct snd_pcm_audio_tstamp_report *audio_tstamp_report);
68 int (*fill_silence)(struct snd_pcm_substream *substream, int channel,
69 unsigned long pos, unsigned long bytes);
70 int (*copy_user)(struct snd_pcm_substream *substream, int channel,
71 unsigned long pos, void __user *buf,
73 int (*copy_kernel)(struct snd_pcm_substream *substream, int channel,
74 unsigned long pos, void *buf, 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);
85 #if defined(CONFIG_SND_DYNAMIC_MINORS)
86 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
88 #define SNDRV_PCM_DEVICES 8
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
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
105 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
107 /* If you change this don't forget to change rates[] table in pcm_native.c */
108 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
109 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
110 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
111 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
112 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
113 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
114 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
115 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
116 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
117 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
118 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
119 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
120 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
121 #define SNDRV_PCM_RATE_352800 (1<<13) /* 352800Hz */
122 #define SNDRV_PCM_RATE_384000 (1<<14) /* 384000Hz */
124 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
125 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
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 #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
150 #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
151 #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
152 #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
153 #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
154 #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
155 #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
156 #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
157 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
158 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
159 #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
160 #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
161 #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
162 #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
163 #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
164 #define SNDRV_PCM_FMTBIT_S20_LE _SNDRV_PCM_FMTBIT(S20_LE)
165 #define SNDRV_PCM_FMTBIT_U20_LE _SNDRV_PCM_FMTBIT(U20_LE)
166 #define SNDRV_PCM_FMTBIT_S20_BE _SNDRV_PCM_FMTBIT(S20_BE)
167 #define SNDRV_PCM_FMTBIT_U20_BE _SNDRV_PCM_FMTBIT(U20_BE)
168 #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
169 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
170 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
171 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
172 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
173 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
174 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
175 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
176 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
177 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
178 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
179 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
180 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
181 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
182 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
183 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
184 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
185 #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
186 #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
187 #define SNDRV_PCM_FMTBIT_DSD_U32_LE _SNDRV_PCM_FMTBIT(DSD_U32_LE)
188 #define SNDRV_PCM_FMTBIT_DSD_U16_BE _SNDRV_PCM_FMTBIT(DSD_U16_BE)
189 #define SNDRV_PCM_FMTBIT_DSD_U32_BE _SNDRV_PCM_FMTBIT(DSD_U32_BE)
191 #ifdef SNDRV_LITTLE_ENDIAN
192 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
193 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
194 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
195 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
196 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
197 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
198 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
199 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
200 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
201 #define SNDRV_PCM_FMTBIT_S20 SNDRV_PCM_FMTBIT_S20_LE
202 #define SNDRV_PCM_FMTBIT_U20 SNDRV_PCM_FMTBIT_U20_LE
204 #ifdef SNDRV_BIG_ENDIAN
205 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
206 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
207 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
208 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
209 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
210 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
211 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
212 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
213 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
214 #define SNDRV_PCM_FMTBIT_S20 SNDRV_PCM_FMTBIT_S20_BE
215 #define SNDRV_PCM_FMTBIT_U20 SNDRV_PCM_FMTBIT_U20_BE
218 struct snd_pcm_file {
219 struct snd_pcm_substream *substream;
221 unsigned int user_pversion; /* supported protocol version */
224 struct snd_pcm_hw_rule;
225 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
226 struct snd_pcm_hw_rule *rule);
228 struct snd_pcm_hw_rule {
233 snd_pcm_hw_rule_func_t func;
237 struct snd_pcm_hw_constraints {
238 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
239 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
240 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
241 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
242 unsigned int rules_num;
243 unsigned int rules_all;
244 struct snd_pcm_hw_rule *rules;
247 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
248 snd_pcm_hw_param_t var)
250 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
253 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
254 snd_pcm_hw_param_t var)
256 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
261 unsigned int den_min, den_max, den_step;
265 unsigned int num_min, num_max, num_step;
269 struct snd_pcm_hw_constraint_ratnums {
271 const struct snd_ratnum *rats;
274 struct snd_pcm_hw_constraint_ratdens {
276 const struct snd_ratden *rats;
279 struct snd_pcm_hw_constraint_list {
280 const unsigned int *list;
285 struct snd_pcm_hw_constraint_ranges {
287 const struct snd_interval *ranges;
292 * userspace-provided audio timestamp config to kernel,
293 * structure is for internal use only and filled with dedicated unpack routine
295 struct snd_pcm_audio_tstamp_config {
296 /* 5 of max 16 bits used */
297 u32 type_requested:4;
298 u32 report_delay:1; /* add total delay to A/D or D/A */
301 static inline void snd_pcm_unpack_audio_tstamp_config(__u32 data,
302 struct snd_pcm_audio_tstamp_config *config)
304 config->type_requested = data & 0xF;
305 config->report_delay = (data >> 4) & 1;
309 * kernel-provided audio timestamp report to user-space
310 * structure is for internal use only and read by dedicated pack routine
312 struct snd_pcm_audio_tstamp_report {
313 /* 6 of max 16 bits used for bit-fields */
315 /* for backwards compatibility */
318 /* actual type if hardware could not support requested timestamp */
321 /* accuracy represented in ns units */
322 u32 accuracy_report:1; /* 0 if accuracy unknown, 1 if accuracy field is valid */
323 u32 accuracy; /* up to 4.29s, will be packed in separate field */
326 static inline void snd_pcm_pack_audio_tstamp_report(__u32 *data, __u32 *accuracy,
327 const struct snd_pcm_audio_tstamp_report *report)
331 tmp = report->accuracy_report;
333 tmp |= report->actual_type;
335 tmp |= report->valid;
337 *data &= 0xffff; /* zero-clear MSBs */
338 *data |= (tmp << 16);
339 *accuracy = report->accuracy;
343 struct snd_pcm_runtime {
345 struct snd_pcm_substream *trigger_master;
346 struct timespec trigger_tstamp; /* trigger timestamp */
347 bool trigger_tstamp_latched; /* trigger timestamp latched in low-level driver/hardware */
349 snd_pcm_uframes_t avail_max;
350 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
351 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
352 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
353 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
354 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
355 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
357 /* -- HW params -- */
358 snd_pcm_access_t access; /* access mode */
359 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
360 snd_pcm_subformat_t subformat; /* subformat */
361 unsigned int rate; /* rate in Hz */
362 unsigned int channels; /* channels */
363 snd_pcm_uframes_t period_size; /* period size */
364 unsigned int periods; /* periods */
365 snd_pcm_uframes_t buffer_size; /* buffer size */
366 snd_pcm_uframes_t min_align; /* Min alignment for the format */
368 unsigned int frame_bits;
369 unsigned int sample_bits;
371 unsigned int rate_num;
372 unsigned int rate_den;
373 unsigned int no_period_wakeup: 1;
375 /* -- SW params -- */
376 int tstamp_mode; /* mmap timestamp is updated */
377 unsigned int period_step;
378 snd_pcm_uframes_t start_threshold;
379 snd_pcm_uframes_t stop_threshold;
380 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
381 noise is nearest than this */
382 snd_pcm_uframes_t silence_size; /* Silence filling size */
383 snd_pcm_uframes_t boundary; /* pointers wrap point */
385 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
386 snd_pcm_uframes_t silence_filled; /* size filled with silence */
388 union snd_pcm_sync_id sync; /* hardware synchronization ID */
391 struct snd_pcm_mmap_status *status;
392 struct snd_pcm_mmap_control *control;
394 /* -- locking / scheduling -- */
395 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
396 wait_queue_head_t sleep; /* poll sleep */
397 wait_queue_head_t tsleep; /* transfer sleep */
398 struct fasync_struct *fasync;
399 bool stop_operating; /* sync_stop will be called */
401 /* -- private section -- */
403 void (*private_free)(struct snd_pcm_runtime *runtime);
405 /* -- hardware description -- */
406 struct snd_pcm_hardware hw;
407 struct snd_pcm_hw_constraints hw_constraints;
410 unsigned int timer_resolution; /* timer resolution */
411 int tstamp_type; /* timestamp type */
414 unsigned char *dma_area; /* DMA area */
415 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
416 size_t dma_bytes; /* size of DMA area */
418 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
419 unsigned int buffer_changed:1; /* buffer allocation changed; set only in managed mode */
421 /* -- audio timestamp config -- */
422 struct snd_pcm_audio_tstamp_config audio_tstamp_config;
423 struct snd_pcm_audio_tstamp_report audio_tstamp_report;
424 struct timespec driver_tstamp;
426 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
427 /* -- OSS things -- */
428 struct snd_pcm_oss_runtime oss;
432 struct snd_pcm_group { /* keep linked substreams */
435 struct list_head substreams;
441 struct snd_pcm_substream {
443 struct snd_pcm_str *pstr;
444 void *private_data; /* copied from pcm->private_data */
446 char name[32]; /* substream name */
447 int stream; /* stream (direction) */
448 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
449 size_t buffer_bytes_max; /* limit ring buffer size */
450 struct snd_dma_buffer dma_buffer;
452 /* -- hardware operations -- */
453 const struct snd_pcm_ops *ops;
454 /* -- runtime information -- */
455 struct snd_pcm_runtime *runtime;
456 /* -- timer section -- */
457 struct snd_timer *timer; /* timer */
458 unsigned timer_running: 1; /* time is running */
459 long wait_time; /* time in ms for R/W to wait for avail */
460 /* -- next substream -- */
461 struct snd_pcm_substream *next;
462 /* -- linked substreams -- */
463 struct list_head link_list; /* linked list member */
464 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
465 struct snd_pcm_group *group; /* pointer to current group */
466 /* -- assigned files -- */
469 unsigned int f_flags;
470 void (*pcm_release)(struct snd_pcm_substream *);
472 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
473 /* -- OSS things -- */
474 struct snd_pcm_oss_substream oss;
476 #ifdef CONFIG_SND_VERBOSE_PROCFS
477 struct snd_info_entry *proc_root;
478 #endif /* CONFIG_SND_VERBOSE_PROCFS */
480 unsigned int hw_opened: 1;
481 unsigned int managed_buffer_alloc:1;
484 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
488 int stream; /* stream (direction) */
490 /* -- substreams -- */
491 unsigned int substream_count;
492 unsigned int substream_opened;
493 struct snd_pcm_substream *substream;
494 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
495 /* -- OSS things -- */
496 struct snd_pcm_oss_stream oss;
498 #ifdef CONFIG_SND_VERBOSE_PROCFS
499 struct snd_info_entry *proc_root;
500 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
501 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
504 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
509 struct snd_card *card;
510 struct list_head list;
511 int device; /* device number */
512 unsigned int info_flags;
513 unsigned short dev_class;
514 unsigned short dev_subclass;
517 struct snd_pcm_str streams[2];
518 struct mutex open_mutex;
519 wait_queue_head_t open_wait;
521 void (*private_free) (struct snd_pcm *pcm);
522 bool internal; /* pcm is for internal use only */
523 bool nonatomic; /* whole PCM operations are in non-atomic context */
524 bool no_device_suspend; /* don't invoke device PM suspend */
525 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
526 struct snd_pcm_oss oss;
534 extern const struct file_operations snd_pcm_f_ops[2];
536 int snd_pcm_new(struct snd_card *card, const char *id, int device,
537 int playback_count, int capture_count,
538 struct snd_pcm **rpcm);
539 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
540 int playback_count, int capture_count,
541 struct snd_pcm **rpcm);
542 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
544 #if IS_ENABLED(CONFIG_SND_PCM_OSS)
545 struct snd_pcm_notify {
546 int (*n_register) (struct snd_pcm * pcm);
547 int (*n_disconnect) (struct snd_pcm * pcm);
548 int (*n_unregister) (struct snd_pcm * pcm);
549 struct list_head list;
551 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
558 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
559 int snd_pcm_info_user(struct snd_pcm_substream *substream,
560 struct snd_pcm_info __user *info);
561 int snd_pcm_status(struct snd_pcm_substream *substream,
562 struct snd_pcm_status *status);
563 int snd_pcm_start(struct snd_pcm_substream *substream);
564 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
565 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
566 int snd_pcm_stop_xrun(struct snd_pcm_substream *substream);
568 int snd_pcm_suspend_all(struct snd_pcm *pcm);
570 static inline int snd_pcm_suspend_all(struct snd_pcm *pcm)
575 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
576 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
577 struct snd_pcm_substream **rsubstream);
578 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
579 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
580 struct snd_pcm_substream **rsubstream);
581 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
582 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
585 #ifdef CONFIG_SND_DEBUG
586 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
587 char *name, size_t len);
590 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
601 * snd_pcm_stream_linked - Check whether the substream is linked with others
602 * @substream: substream to check
604 * Returns true if the given substream is being linked with others.
606 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
608 return substream->group != &substream->self_group;
611 void snd_pcm_stream_lock(struct snd_pcm_substream *substream);
612 void snd_pcm_stream_unlock(struct snd_pcm_substream *substream);
613 void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream);
614 void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream);
615 unsigned long _snd_pcm_stream_lock_irqsave(struct snd_pcm_substream *substream);
618 * snd_pcm_stream_lock_irqsave - Lock the PCM stream
619 * @substream: PCM substream
622 * This locks the PCM stream like snd_pcm_stream_lock() but with the local
623 * IRQ (only when nonatomic is false). In nonatomic case, this is identical
624 * as snd_pcm_stream_lock().
626 #define snd_pcm_stream_lock_irqsave(substream, flags) \
628 typecheck(unsigned long, flags); \
629 flags = _snd_pcm_stream_lock_irqsave(substream); \
631 void snd_pcm_stream_unlock_irqrestore(struct snd_pcm_substream *substream,
632 unsigned long flags);
635 * snd_pcm_group_for_each_entry - iterate over the linked substreams
637 * @substream: the substream
639 * Iterate over the all linked substreams to the given @substream.
640 * When @substream isn't linked with any others, this gives returns @substream
643 #define snd_pcm_group_for_each_entry(s, substream) \
644 list_for_each_entry(s, &substream->group->substreams, link_list)
647 * snd_pcm_running - Check whether the substream is in a running state
648 * @substream: substream to check
650 * Returns true if the given substream is in the state RUNNING, or in the
651 * state DRAINING for playback.
653 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
655 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
656 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
657 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
661 * bytes_to_samples - Unit conversion of the size from bytes to samples
662 * @runtime: PCM runtime instance
663 * @size: size in bytes
665 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
667 return size * 8 / runtime->sample_bits;
671 * bytes_to_frames - Unit conversion of the size from bytes to frames
672 * @runtime: PCM runtime instance
673 * @size: size in bytes
675 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
677 return size * 8 / runtime->frame_bits;
681 * samples_to_bytes - Unit conversion of the size from samples to bytes
682 * @runtime: PCM runtime instance
683 * @size: size in samples
685 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
687 return size * runtime->sample_bits / 8;
691 * frames_to_bytes - Unit conversion of the size from frames to bytes
692 * @runtime: PCM runtime instance
693 * @size: size in frames
695 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
697 return size * runtime->frame_bits / 8;
701 * frame_aligned - Check whether the byte size is aligned to frames
702 * @runtime: PCM runtime instance
703 * @bytes: size in bytes
705 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
707 return bytes % runtime->byte_align == 0;
711 * snd_pcm_lib_buffer_bytes - Get the buffer size of the current PCM in bytes
712 * @substream: PCM substream
714 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
716 struct snd_pcm_runtime *runtime = substream->runtime;
717 return frames_to_bytes(runtime, runtime->buffer_size);
721 * snd_pcm_lib_period_bytes - Get the period size of the current PCM in bytes
722 * @substream: PCM substream
724 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
726 struct snd_pcm_runtime *runtime = substream->runtime;
727 return frames_to_bytes(runtime, runtime->period_size);
731 * snd_pcm_playback_avail - Get the available (writable) space for playback
732 * @runtime: PCM runtime instance
734 * Result is between 0 ... (boundary - 1)
736 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
738 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
740 avail += runtime->boundary;
741 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
742 avail -= runtime->boundary;
747 * snd_pcm_capture_avail - Get the available (readable) space for capture
748 * @runtime: PCM runtime instance
750 * Result is between 0 ... (boundary - 1)
752 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
754 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
756 avail += runtime->boundary;
761 * snd_pcm_playback_hw_avail - Get the queued space for playback
762 * @runtime: PCM runtime instance
764 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
766 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
770 * snd_pcm_capture_hw_avail - Get the free space for capture
771 * @runtime: PCM runtime instance
773 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
775 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
779 * snd_pcm_playback_ready - check whether the playback buffer is available
780 * @substream: the pcm substream instance
782 * Checks whether enough free space is available on the playback buffer.
784 * Return: Non-zero if available, or zero if not.
786 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
788 struct snd_pcm_runtime *runtime = substream->runtime;
789 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
793 * snd_pcm_capture_ready - check whether the capture buffer is available
794 * @substream: the pcm substream instance
796 * Checks whether enough capture data is available on the capture buffer.
798 * Return: Non-zero if available, or zero if not.
800 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
802 struct snd_pcm_runtime *runtime = substream->runtime;
803 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
807 * snd_pcm_playback_data - check whether any data exists on the playback buffer
808 * @substream: the pcm substream instance
810 * Checks whether any data exists on the playback buffer.
812 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
813 * is bigger or equal to boundary, then this function returns always non-zero.
815 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
817 struct snd_pcm_runtime *runtime = substream->runtime;
819 if (runtime->stop_threshold >= runtime->boundary)
821 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
825 * snd_pcm_playback_empty - check whether the playback buffer is empty
826 * @substream: the pcm substream instance
828 * Checks whether the playback buffer is empty.
830 * Return: Non-zero if empty, or zero if not.
832 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
834 struct snd_pcm_runtime *runtime = substream->runtime;
835 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
839 * snd_pcm_capture_empty - check whether the capture buffer is empty
840 * @substream: the pcm substream instance
842 * Checks whether the capture buffer is empty.
844 * Return: Non-zero if empty, or zero if not.
846 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
848 struct snd_pcm_runtime *runtime = substream->runtime;
849 return snd_pcm_capture_avail(runtime) == 0;
853 * snd_pcm_trigger_done - Mark the master substream
854 * @substream: the pcm substream instance
855 * @master: the linked master substream
857 * When multiple substreams of the same card are linked and the hardware
858 * supports the single-shot operation, the driver calls this in the loop
859 * in snd_pcm_group_for_each_entry() for marking the substream as "done".
860 * Then most of trigger operations are performed only to the given master
863 * The trigger_master mark is cleared at timestamp updates at the end
864 * of trigger operations.
866 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
867 struct snd_pcm_substream *master)
869 substream->runtime->trigger_master = master;
872 static inline int hw_is_mask(int var)
874 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
875 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
878 static inline int hw_is_interval(int var)
880 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
881 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
884 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
885 snd_pcm_hw_param_t var)
887 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
890 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
891 snd_pcm_hw_param_t var)
893 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
896 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
897 snd_pcm_hw_param_t var)
899 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
902 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
903 snd_pcm_hw_param_t var)
905 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
909 * params_channels - Get the number of channels from the hw params
912 static inline unsigned int params_channels(const struct snd_pcm_hw_params *p)
914 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_CHANNELS)->min;
918 * params_rate - Get the sample rate from the hw params
921 static inline unsigned int params_rate(const struct snd_pcm_hw_params *p)
923 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_RATE)->min;
927 * params_period_size - Get the period size (in frames) from the hw params
930 static inline unsigned int params_period_size(const struct snd_pcm_hw_params *p)
932 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min;
936 * params_periods - Get the number of periods from the hw params
939 static inline unsigned int params_periods(const struct snd_pcm_hw_params *p)
941 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_PERIODS)->min;
945 * params_buffer_size - Get the buffer size (in frames) from the hw params
948 static inline unsigned int params_buffer_size(const struct snd_pcm_hw_params *p)
950 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min;
954 * params_buffer_bytes - Get the buffer size (in bytes) from the hw params
957 static inline unsigned int params_buffer_bytes(const struct snd_pcm_hw_params *p)
959 return hw_param_interval_c(p, SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min;
962 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
963 int snd_interval_list(struct snd_interval *i, unsigned int count,
964 const unsigned int *list, unsigned int mask);
965 int snd_interval_ranges(struct snd_interval *i, unsigned int count,
966 const struct snd_interval *list, unsigned int mask);
967 int snd_interval_ratnum(struct snd_interval *i,
968 unsigned int rats_count, const struct snd_ratnum *rats,
969 unsigned int *nump, unsigned int *denp);
971 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
972 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
974 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
976 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
978 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
979 unsigned int min, unsigned int max);
980 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
981 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
983 snd_pcm_hw_param_t var,
984 const struct snd_pcm_hw_constraint_list *l);
985 int snd_pcm_hw_constraint_ranges(struct snd_pcm_runtime *runtime,
987 snd_pcm_hw_param_t var,
988 const struct snd_pcm_hw_constraint_ranges *r);
989 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
991 snd_pcm_hw_param_t var,
992 const struct snd_pcm_hw_constraint_ratnums *r);
993 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
995 snd_pcm_hw_param_t var,
996 const struct snd_pcm_hw_constraint_ratdens *r);
997 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
1000 unsigned int msbits);
1001 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
1003 snd_pcm_hw_param_t var,
1004 unsigned long step);
1005 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
1007 snd_pcm_hw_param_t var);
1008 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
1009 unsigned int base_rate);
1010 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
1013 snd_pcm_hw_rule_func_t func, void *private,
1017 * snd_pcm_hw_constraint_single() - Constrain parameter to a single value
1018 * @runtime: PCM runtime instance
1019 * @var: The hw_params variable to constrain
1020 * @val: The value to constrain to
1022 * Return: Positive if the value is changed, zero if it's not changed, or a
1023 * negative error code.
1025 static inline int snd_pcm_hw_constraint_single(
1026 struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
1029 return snd_pcm_hw_constraint_minmax(runtime, var, val, val);
1032 int snd_pcm_format_signed(snd_pcm_format_t format);
1033 int snd_pcm_format_unsigned(snd_pcm_format_t format);
1034 int snd_pcm_format_linear(snd_pcm_format_t format);
1035 int snd_pcm_format_little_endian(snd_pcm_format_t format);
1036 int snd_pcm_format_big_endian(snd_pcm_format_t format);
1037 #if 0 /* just for kernel-doc */
1039 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
1040 * @format: the format to check
1042 * Return: 1 if the given PCM format is CPU-endian, 0 if
1043 * opposite, or a negative error code if endian not specified.
1045 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
1046 #endif /* DocBook */
1047 #ifdef SNDRV_LITTLE_ENDIAN
1048 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
1050 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
1052 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
1053 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
1054 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
1055 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
1056 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
1058 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
1059 const struct snd_pcm_ops *ops);
1060 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
1061 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
1062 unsigned int cmd, void *arg);
1063 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
1064 snd_pcm_sframes_t __snd_pcm_lib_xfer(struct snd_pcm_substream *substream,
1065 void *buf, bool interleaved,
1066 snd_pcm_uframes_t frames, bool in_kernel);
1068 static inline snd_pcm_sframes_t
1069 snd_pcm_lib_write(struct snd_pcm_substream *substream,
1070 const void __user *buf, snd_pcm_uframes_t frames)
1072 return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1075 static inline snd_pcm_sframes_t
1076 snd_pcm_lib_read(struct snd_pcm_substream *substream,
1077 void __user *buf, snd_pcm_uframes_t frames)
1079 return __snd_pcm_lib_xfer(substream, (void __force *)buf, true, frames, false);
1082 static inline snd_pcm_sframes_t
1083 snd_pcm_lib_writev(struct snd_pcm_substream *substream,
1084 void __user **bufs, snd_pcm_uframes_t frames)
1086 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1089 static inline snd_pcm_sframes_t
1090 snd_pcm_lib_readv(struct snd_pcm_substream *substream,
1091 void __user **bufs, snd_pcm_uframes_t frames)
1093 return __snd_pcm_lib_xfer(substream, (void *)bufs, false, frames, false);
1096 static inline snd_pcm_sframes_t
1097 snd_pcm_kernel_write(struct snd_pcm_substream *substream,
1098 const void *buf, snd_pcm_uframes_t frames)
1100 return __snd_pcm_lib_xfer(substream, (void *)buf, true, frames, true);
1103 static inline snd_pcm_sframes_t
1104 snd_pcm_kernel_read(struct snd_pcm_substream *substream,
1105 void *buf, snd_pcm_uframes_t frames)
1107 return __snd_pcm_lib_xfer(substream, buf, true, frames, true);
1110 static inline snd_pcm_sframes_t
1111 snd_pcm_kernel_writev(struct snd_pcm_substream *substream,
1112 void **bufs, snd_pcm_uframes_t frames)
1114 return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1117 static inline snd_pcm_sframes_t
1118 snd_pcm_kernel_readv(struct snd_pcm_substream *substream,
1119 void **bufs, snd_pcm_uframes_t frames)
1121 return __snd_pcm_lib_xfer(substream, bufs, false, frames, true);
1124 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
1125 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
1126 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
1127 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
1128 unsigned int rates_b);
1129 unsigned int snd_pcm_rate_range_to_bits(unsigned int rate_min,
1130 unsigned int rate_max);
1133 * snd_pcm_set_runtime_buffer - Set the PCM runtime buffer
1134 * @substream: PCM substream to set
1135 * @bufp: the buffer information, NULL to clear
1137 * Copy the buffer information to runtime->dma_buffer when @bufp is non-NULL.
1138 * Otherwise it clears the current buffer information.
1140 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
1141 struct snd_dma_buffer *bufp)
1143 struct snd_pcm_runtime *runtime = substream->runtime;
1145 runtime->dma_buffer_p = bufp;
1146 runtime->dma_area = bufp->area;
1147 runtime->dma_addr = bufp->addr;
1148 runtime->dma_bytes = bufp->bytes;
1150 runtime->dma_buffer_p = NULL;
1151 runtime->dma_area = NULL;
1152 runtime->dma_addr = 0;
1153 runtime->dma_bytes = 0;
1158 * snd_pcm_gettime - Fill the timespec depending on the timestamp mode
1159 * @runtime: PCM runtime instance
1160 * @tv: timespec to fill
1162 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
1163 struct timespec *tv)
1165 switch (runtime->tstamp_type) {
1166 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
1169 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
1170 getrawmonotonic(tv);
1182 void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
1183 void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
1184 void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
1185 int type, struct device *data,
1186 size_t size, size_t max);
1187 void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
1188 int type, void *data,
1189 size_t size, size_t max);
1190 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
1191 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
1193 void snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
1194 struct device *data, size_t size, size_t max);
1195 void snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
1196 struct device *data,
1197 size_t size, size_t max);
1199 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
1200 size_t size, gfp_t gfp_flags);
1201 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
1202 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1203 unsigned long offset);
1205 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1206 * @substream: the substream to allocate the buffer to
1207 * @size: the requested buffer size, in bytes
1209 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1210 * contiguous in kernel virtual space, but not in physical memory. Use this
1211 * if the buffer is accessed by kernel code but not by device DMA.
1213 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1216 static inline int snd_pcm_lib_alloc_vmalloc_buffer
1217 (struct snd_pcm_substream *substream, size_t size)
1219 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1220 GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO);
1224 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1225 * @substream: the substream to allocate the buffer to
1226 * @size: the requested buffer size, in bytes
1228 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1229 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1231 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1234 static inline int snd_pcm_lib_alloc_vmalloc_32_buffer
1235 (struct snd_pcm_substream *substream, size_t size)
1237 return _snd_pcm_lib_alloc_vmalloc_buffer(substream, size,
1238 GFP_KERNEL | GFP_DMA32 | __GFP_ZERO);
1241 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1243 #ifdef CONFIG_SND_DMA_SGBUF
1245 * SG-buffer handling
1247 #define snd_pcm_substream_sgbuf(substream) \
1248 snd_pcm_get_dma_buf(substream)->private_data
1249 #endif /* SND_DMA_SGBUF */
1252 * snd_pcm_sgbuf_get_addr - Get the DMA address at the corresponding offset
1253 * @substream: PCM substream
1256 static inline dma_addr_t
1257 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1259 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1263 * snd_pcm_sgbuf_get_ptr - Get the virtual address at the corresponding offset
1264 * @substream: PCM substream
1267 static inline void *
1268 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1270 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1274 * snd_pcm_sgbuf_chunk_size - Compute the max size that fits within the contig.
1275 * page from the given size
1276 * @substream: PCM substream
1278 * @size: byte size to examine
1280 static inline unsigned int
1281 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1282 unsigned int ofs, unsigned int size)
1284 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1288 * snd_pcm_mmap_data_open - increase the mmap counter
1291 * PCM mmap callback should handle this counter properly
1293 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1295 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1296 atomic_inc(&substream->mmap_count);
1300 * snd_pcm_mmap_data_close - decrease the mmap counter
1303 * PCM mmap callback should handle this counter properly
1305 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1307 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1308 atomic_dec(&substream->mmap_count);
1311 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1312 struct vm_area_struct *area);
1313 /* mmap for io-memory area */
1314 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1315 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1316 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1318 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1319 #define snd_pcm_lib_mmap_iomem NULL
1323 * snd_pcm_limit_isa_dma_size - Get the max size fitting with ISA DMA transfer
1325 * @max: pointer to store the max size
1327 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1329 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1336 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1337 (IEC958_AES1_CON_ORIGINAL<<8)|\
1338 (IEC958_AES1_CON_PCM_CODER<<8)|\
1339 (IEC958_AES3_CON_FS_48000<<24))
1341 const char *snd_pcm_format_name(snd_pcm_format_t format);
1344 * snd_pcm_stream_str - Get a string naming the direction of a stream
1345 * @substream: the pcm substream instance
1347 * Return: A string naming the direction of the stream.
1349 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1351 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1358 * PCM channel-mapping control API
1360 /* array element of channel maps */
1361 struct snd_pcm_chmap_elem {
1362 unsigned char channels;
1363 unsigned char map[15];
1366 /* channel map information; retrieved via snd_kcontrol_chip() */
1367 struct snd_pcm_chmap {
1368 struct snd_pcm *pcm; /* assigned PCM instance */
1369 int stream; /* PLAYBACK or CAPTURE */
1370 struct snd_kcontrol *kctl;
1371 const struct snd_pcm_chmap_elem *chmap;
1372 unsigned int max_channels;
1373 unsigned int channel_mask; /* optional: active channels bitmask */
1374 void *private_data; /* optional: private data pointer */
1378 * snd_pcm_chmap_substream - get the PCM substream assigned to the given chmap info
1379 * @info: chmap information
1380 * @idx: the substream number index
1382 static inline struct snd_pcm_substream *
1383 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1385 struct snd_pcm_substream *s;
1386 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1387 if (s->number == idx)
1392 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1393 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1394 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1395 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1397 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1398 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1399 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1400 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1402 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1403 const struct snd_pcm_chmap_elem *chmap,
1405 unsigned long private_value,
1406 struct snd_pcm_chmap **info_ret);
1409 * pcm_format_to_bits - Strong-typed conversion of pcm_format to bitwise
1410 * @pcm_format: PCM format
1412 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1414 return 1ULL << (__force int) pcm_format;
1417 /* printk helpers */
1418 #define pcm_err(pcm, fmt, args...) \
1419 dev_err((pcm)->card->dev, fmt, ##args)
1420 #define pcm_warn(pcm, fmt, args...) \
1421 dev_warn((pcm)->card->dev, fmt, ##args)
1422 #define pcm_dbg(pcm, fmt, args...) \
1423 dev_dbg((pcm)->card->dev, fmt, ##args)
1425 #endif /* __SOUND_PCM_H */