5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * Abramo Bagnara <abramo@alsa-project.org>
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.
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.
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
26 #include <sound/asound.h>
27 #include <sound/memalloc.h>
28 #include <sound/minors.h>
29 #include <linux/poll.h>
31 #include <linux/bitops.h>
32 #include <linux/pm_qos.h>
34 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
35 #define snd_pcm_chip(pcm) ((pcm)->private_data)
37 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
38 #include <sound/pcm_oss.h>
42 * Hardware (lowlevel) section
45 struct 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 */
61 struct snd_pcm_substream;
64 int (*open)(struct snd_pcm_substream *substream);
65 int (*close)(struct snd_pcm_substream *substream);
66 int (*ioctl)(struct snd_pcm_substream * substream,
67 unsigned int cmd, void *arg);
68 int (*hw_params)(struct snd_pcm_substream *substream,
69 struct snd_pcm_hw_params *params);
70 int (*hw_free)(struct snd_pcm_substream *substream);
71 int (*prepare)(struct snd_pcm_substream *substream);
72 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
73 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
74 int (*copy)(struct snd_pcm_substream *substream, int channel,
75 snd_pcm_uframes_t pos,
76 void __user *buf, snd_pcm_uframes_t count);
77 int (*silence)(struct snd_pcm_substream *substream, int channel,
78 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
79 struct page *(*page)(struct snd_pcm_substream *substream,
80 unsigned long offset);
81 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
82 int (*ack)(struct snd_pcm_substream *substream);
89 #if defined(CONFIG_SND_DYNAMIC_MINORS)
90 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
92 #define SNDRV_PCM_DEVICES 8
95 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
96 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
98 #define SNDRV_PCM_IOCTL1_RESET 0
99 #define SNDRV_PCM_IOCTL1_INFO 1
100 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
101 #define SNDRV_PCM_IOCTL1_GSTATE 3
102 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
104 #define SNDRV_PCM_TRIGGER_STOP 0
105 #define SNDRV_PCM_TRIGGER_START 1
106 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
107 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
108 #define SNDRV_PCM_TRIGGER_SUSPEND 5
109 #define SNDRV_PCM_TRIGGER_RESUME 6
111 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
113 /* If you change this don't forget to change rates[] table in pcm_native.c */
114 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
115 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
116 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
117 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
118 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
119 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
120 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
121 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
122 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
123 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
124 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
125 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
126 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
128 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
129 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
131 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
132 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
133 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
134 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
135 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
136 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
137 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
138 SNDRV_PCM_RATE_192000)
139 #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
140 #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
141 #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
142 #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
143 #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
144 #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
145 #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
146 #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
147 #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
148 #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
149 #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
150 #define SNDRV_PCM_FMTBIT_S32_LE _SNDRV_PCM_FMTBIT(S32_LE)
151 #define SNDRV_PCM_FMTBIT_S32_BE _SNDRV_PCM_FMTBIT(S32_BE)
152 #define SNDRV_PCM_FMTBIT_U32_LE _SNDRV_PCM_FMTBIT(U32_LE)
153 #define SNDRV_PCM_FMTBIT_U32_BE _SNDRV_PCM_FMTBIT(U32_BE)
154 #define SNDRV_PCM_FMTBIT_FLOAT_LE _SNDRV_PCM_FMTBIT(FLOAT_LE)
155 #define SNDRV_PCM_FMTBIT_FLOAT_BE _SNDRV_PCM_FMTBIT(FLOAT_BE)
156 #define SNDRV_PCM_FMTBIT_FLOAT64_LE _SNDRV_PCM_FMTBIT(FLOAT64_LE)
157 #define SNDRV_PCM_FMTBIT_FLOAT64_BE _SNDRV_PCM_FMTBIT(FLOAT64_BE)
158 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_LE)
159 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE _SNDRV_PCM_FMTBIT(IEC958_SUBFRAME_BE)
160 #define SNDRV_PCM_FMTBIT_MU_LAW _SNDRV_PCM_FMTBIT(MU_LAW)
161 #define SNDRV_PCM_FMTBIT_A_LAW _SNDRV_PCM_FMTBIT(A_LAW)
162 #define SNDRV_PCM_FMTBIT_IMA_ADPCM _SNDRV_PCM_FMTBIT(IMA_ADPCM)
163 #define SNDRV_PCM_FMTBIT_MPEG _SNDRV_PCM_FMTBIT(MPEG)
164 #define SNDRV_PCM_FMTBIT_GSM _SNDRV_PCM_FMTBIT(GSM)
165 #define SNDRV_PCM_FMTBIT_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
166 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
167 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
168 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
169 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
170 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
171 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
172 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
173 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
174 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
175 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
176 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
177 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
178 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
179 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
180 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
181 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
183 #ifdef SNDRV_LITTLE_ENDIAN
184 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
185 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
186 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
187 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
188 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
189 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
190 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
191 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
192 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
194 #ifdef SNDRV_BIG_ENDIAN
195 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
196 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
197 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
198 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
199 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
200 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
201 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
202 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
203 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
206 struct snd_pcm_file {
207 struct snd_pcm_substream *substream;
211 struct snd_pcm_hw_rule;
212 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
213 struct snd_pcm_hw_rule *rule);
215 struct snd_pcm_hw_rule {
217 snd_pcm_hw_rule_func_t func;
223 struct snd_pcm_hw_constraints {
224 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
225 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
226 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
227 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
228 unsigned int rules_num;
229 unsigned int rules_all;
230 struct snd_pcm_hw_rule *rules;
233 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
236 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
239 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
240 snd_pcm_hw_param_t var)
242 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
247 unsigned int den_min, den_max, den_step;
251 unsigned int num_min, num_max, num_step;
255 struct snd_pcm_hw_constraint_ratnums {
257 struct snd_ratnum *rats;
260 struct snd_pcm_hw_constraint_ratdens {
262 struct snd_ratden *rats;
265 struct snd_pcm_hw_constraint_list {
267 const unsigned int *list;
271 struct snd_pcm_hwptr_log;
273 struct snd_pcm_runtime {
275 struct snd_pcm_substream *trigger_master;
276 struct timespec trigger_tstamp; /* trigger timestamp */
278 snd_pcm_uframes_t avail_max;
279 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
280 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
281 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
282 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
283 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
284 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
286 /* -- HW params -- */
287 snd_pcm_access_t access; /* access mode */
288 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
289 snd_pcm_subformat_t subformat; /* subformat */
290 unsigned int rate; /* rate in Hz */
291 unsigned int channels; /* channels */
292 snd_pcm_uframes_t period_size; /* period size */
293 unsigned int periods; /* periods */
294 snd_pcm_uframes_t buffer_size; /* buffer size */
295 snd_pcm_uframes_t min_align; /* Min alignment for the format */
297 unsigned int frame_bits;
298 unsigned int sample_bits;
300 unsigned int rate_num;
301 unsigned int rate_den;
302 unsigned int no_period_wakeup: 1;
304 /* -- SW params -- */
305 int tstamp_mode; /* mmap timestamp is updated */
306 unsigned int period_step;
307 snd_pcm_uframes_t start_threshold;
308 snd_pcm_uframes_t stop_threshold;
309 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
310 noise is nearest than this */
311 snd_pcm_uframes_t silence_size; /* Silence filling size */
312 snd_pcm_uframes_t boundary; /* pointers wrap point */
314 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
315 snd_pcm_uframes_t silence_filled; /* size filled with silence */
317 union snd_pcm_sync_id sync; /* hardware synchronization ID */
320 struct snd_pcm_mmap_status *status;
321 struct snd_pcm_mmap_control *control;
323 /* -- locking / scheduling -- */
324 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
325 wait_queue_head_t sleep; /* poll sleep */
326 wait_queue_head_t tsleep; /* transfer sleep */
327 struct fasync_struct *fasync;
329 /* -- private section -- */
331 void (*private_free)(struct snd_pcm_runtime *runtime);
333 /* -- hardware description -- */
334 struct snd_pcm_hardware hw;
335 struct snd_pcm_hw_constraints hw_constraints;
337 /* -- interrupt callbacks -- */
338 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
339 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
342 unsigned int timer_resolution; /* timer resolution */
343 int tstamp_type; /* timestamp type */
346 unsigned char *dma_area; /* DMA area */
347 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
348 size_t dma_bytes; /* size of DMA area */
350 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
352 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
353 /* -- OSS things -- */
354 struct snd_pcm_oss_runtime oss;
357 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
358 struct snd_pcm_hwptr_log *hwptr_log;
362 struct snd_pcm_group { /* keep linked substreams */
364 struct list_head substreams;
370 struct snd_pcm_substream {
372 struct snd_pcm_str *pstr;
373 void *private_data; /* copied from pcm->private_data */
375 char name[32]; /* substream name */
376 int stream; /* stream (direction) */
377 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
378 size_t buffer_bytes_max; /* limit ring buffer size */
379 struct snd_dma_buffer dma_buffer;
380 unsigned int dma_buf_id;
382 /* -- hardware operations -- */
383 struct snd_pcm_ops *ops;
384 /* -- runtime information -- */
385 struct snd_pcm_runtime *runtime;
386 /* -- timer section -- */
387 struct snd_timer *timer; /* timer */
388 unsigned timer_running: 1; /* time is running */
389 /* -- next substream -- */
390 struct snd_pcm_substream *next;
391 /* -- linked substreams -- */
392 struct list_head link_list; /* linked list member */
393 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
394 struct snd_pcm_group *group; /* pointer to current group */
395 /* -- assigned files -- */
399 unsigned int f_flags;
400 void (*pcm_release)(struct snd_pcm_substream *);
402 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
403 /* -- OSS things -- */
404 struct snd_pcm_oss_substream oss;
406 #ifdef CONFIG_SND_VERBOSE_PROCFS
407 struct snd_info_entry *proc_root;
408 struct snd_info_entry *proc_info_entry;
409 struct snd_info_entry *proc_hw_params_entry;
410 struct snd_info_entry *proc_sw_params_entry;
411 struct snd_info_entry *proc_status_entry;
412 struct snd_info_entry *proc_prealloc_entry;
413 struct snd_info_entry *proc_prealloc_max_entry;
416 unsigned int hw_opened: 1;
419 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
423 int stream; /* stream (direction) */
425 /* -- substreams -- */
426 unsigned int substream_count;
427 unsigned int substream_opened;
428 struct snd_pcm_substream *substream;
429 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
430 /* -- OSS things -- */
431 struct snd_pcm_oss_stream oss;
433 #ifdef CONFIG_SND_VERBOSE_PROCFS
434 struct snd_info_entry *proc_root;
435 struct snd_info_entry *proc_info_entry;
436 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
437 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
438 struct snd_info_entry *proc_xrun_debug_entry;
441 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
445 struct snd_card *card;
446 struct list_head list;
447 int device; /* device number */
448 unsigned int info_flags;
449 unsigned short dev_class;
450 unsigned short dev_subclass;
453 struct snd_pcm_str streams[2];
454 struct mutex open_mutex;
455 wait_queue_head_t open_wait;
457 void (*private_free) (struct snd_pcm *pcm);
458 struct device *dev; /* actual hw device this belongs to */
459 bool internal; /* pcm is for internal use only */
460 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
461 struct snd_pcm_oss oss;
465 struct snd_pcm_notify {
466 int (*n_register) (struct snd_pcm * pcm);
467 int (*n_disconnect) (struct snd_pcm * pcm);
468 int (*n_unregister) (struct snd_pcm * pcm);
469 struct list_head list;
476 extern const struct file_operations snd_pcm_f_ops[2];
478 int snd_pcm_new(struct snd_card *card, const char *id, int device,
479 int playback_count, int capture_count,
480 struct snd_pcm **rpcm);
481 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
482 int playback_count, int capture_count,
483 struct snd_pcm **rpcm);
484 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
486 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
492 extern rwlock_t snd_pcm_link_rwlock;
494 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
495 int snd_pcm_info_user(struct snd_pcm_substream *substream,
496 struct snd_pcm_info __user *info);
497 int snd_pcm_status(struct snd_pcm_substream *substream,
498 struct snd_pcm_status *status);
499 int snd_pcm_start(struct snd_pcm_substream *substream);
500 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
501 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
503 int snd_pcm_suspend(struct snd_pcm_substream *substream);
504 int snd_pcm_suspend_all(struct snd_pcm *pcm);
506 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
507 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
508 struct snd_pcm_substream **rsubstream);
509 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
510 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
511 struct snd_pcm_substream **rsubstream);
512 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
513 void snd_pcm_vma_notify_data(void *client, void *data);
514 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
517 #ifdef CONFIG_SND_DEBUG
518 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
519 char *name, size_t len);
522 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
532 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
534 return substream->group != &substream->self_group;
537 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
539 read_lock(&snd_pcm_link_rwlock);
540 spin_lock(&substream->self_group.lock);
543 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
545 spin_unlock(&substream->self_group.lock);
546 read_unlock(&snd_pcm_link_rwlock);
549 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
551 read_lock_irq(&snd_pcm_link_rwlock);
552 spin_lock(&substream->self_group.lock);
555 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
557 spin_unlock(&substream->self_group.lock);
558 read_unlock_irq(&snd_pcm_link_rwlock);
561 #define snd_pcm_stream_lock_irqsave(substream, flags) \
563 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
564 spin_lock(&substream->self_group.lock); \
567 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
569 spin_unlock(&substream->self_group.lock); \
570 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
573 #define snd_pcm_group_for_each_entry(s, substream) \
574 list_for_each_entry(s, &substream->group->substreams, link_list)
576 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
578 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
579 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
580 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
583 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
585 return size * 8 / runtime->sample_bits;
588 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
590 return size * 8 / runtime->frame_bits;
593 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
595 return size * runtime->sample_bits / 8;
598 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
600 return size * runtime->frame_bits / 8;
603 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
605 return bytes % runtime->byte_align == 0;
608 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
610 struct snd_pcm_runtime *runtime = substream->runtime;
611 return frames_to_bytes(runtime, runtime->buffer_size);
614 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
616 struct snd_pcm_runtime *runtime = substream->runtime;
617 return frames_to_bytes(runtime, runtime->period_size);
621 * result is: 0 ... (boundary - 1)
623 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
625 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
627 avail += runtime->boundary;
628 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
629 avail -= runtime->boundary;
634 * result is: 0 ... (boundary - 1)
636 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
638 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
640 avail += runtime->boundary;
644 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
646 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
649 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
651 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
655 * snd_pcm_playback_ready - check whether the playback buffer is available
656 * @substream: the pcm substream instance
658 * Checks whether enough free space is available on the playback buffer.
660 * Returns non-zero if available, or zero if not.
662 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
664 struct snd_pcm_runtime *runtime = substream->runtime;
665 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
669 * snd_pcm_capture_ready - check whether the capture buffer is available
670 * @substream: the pcm substream instance
672 * Checks whether enough capture data is available on the capture buffer.
674 * Returns non-zero if available, or zero if not.
676 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
678 struct snd_pcm_runtime *runtime = substream->runtime;
679 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
683 * snd_pcm_playback_data - check whether any data exists on the playback buffer
684 * @substream: the pcm substream instance
686 * Checks whether any data exists on the playback buffer. If stop_threshold
687 * is bigger or equal to boundary, then this function returns always non-zero.
689 * Returns non-zero if exists, or zero if not.
691 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
693 struct snd_pcm_runtime *runtime = substream->runtime;
695 if (runtime->stop_threshold >= runtime->boundary)
697 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
701 * snd_pcm_playback_empty - check whether the playback buffer is empty
702 * @substream: the pcm substream instance
704 * Checks whether the playback buffer is empty.
706 * Returns non-zero if empty, or zero if not.
708 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
710 struct snd_pcm_runtime *runtime = substream->runtime;
711 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
715 * snd_pcm_capture_empty - check whether the capture buffer is empty
716 * @substream: the pcm substream instance
718 * Checks whether the capture buffer is empty.
720 * Returns non-zero if empty, or zero if not.
722 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
724 struct snd_pcm_runtime *runtime = substream->runtime;
725 return snd_pcm_capture_avail(runtime) == 0;
728 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
729 struct snd_pcm_substream *master)
731 substream->runtime->trigger_master = master;
734 static inline int hw_is_mask(int var)
736 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
737 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
740 static inline int hw_is_interval(int var)
742 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
743 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
746 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
747 snd_pcm_hw_param_t var)
749 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
752 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
753 snd_pcm_hw_param_t var)
755 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
758 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
759 snd_pcm_hw_param_t var)
761 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
764 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
765 snd_pcm_hw_param_t var)
767 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
770 #define params_channels(p) \
771 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
772 #define params_rate(p) \
773 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
774 #define params_period_size(p) \
775 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
776 #define params_periods(p) \
777 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
778 #define params_buffer_size(p) \
779 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
780 #define params_buffer_bytes(p) \
781 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
783 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
784 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
785 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
786 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
787 unsigned int k, struct snd_interval *c);
788 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
789 const struct snd_interval *b, struct snd_interval *c);
790 int snd_interval_list(struct snd_interval *i, unsigned int count,
791 const unsigned int *list, unsigned int mask);
792 int snd_interval_ratnum(struct snd_interval *i,
793 unsigned int rats_count, struct snd_ratnum *rats,
794 unsigned int *nump, unsigned int *denp);
796 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
797 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
798 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
800 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
802 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
803 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
805 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
807 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
809 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
810 unsigned int min, unsigned int max);
811 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
812 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
814 snd_pcm_hw_param_t var,
815 const struct snd_pcm_hw_constraint_list *l);
816 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
818 snd_pcm_hw_param_t var,
819 struct snd_pcm_hw_constraint_ratnums *r);
820 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
822 snd_pcm_hw_param_t var,
823 struct snd_pcm_hw_constraint_ratdens *r);
824 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
827 unsigned int msbits);
828 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
830 snd_pcm_hw_param_t var,
832 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
834 snd_pcm_hw_param_t var);
835 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
836 unsigned int base_rate);
837 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
840 snd_pcm_hw_rule_func_t func, void *private,
843 int snd_pcm_format_signed(snd_pcm_format_t format);
844 int snd_pcm_format_unsigned(snd_pcm_format_t format);
845 int snd_pcm_format_linear(snd_pcm_format_t format);
846 int snd_pcm_format_little_endian(snd_pcm_format_t format);
847 int snd_pcm_format_big_endian(snd_pcm_format_t format);
848 #if 0 /* just for DocBook */
850 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
851 * @format: the format to check
853 * Returns 1 if the given PCM format is CPU-endian, 0 if
854 * opposite, or a negative error code if endian not specified.
856 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
858 #ifdef SNDRV_LITTLE_ENDIAN
859 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
861 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
863 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
864 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
865 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
866 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
867 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
868 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
870 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
871 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
872 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
873 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
874 unsigned int cmd, void *arg);
875 int snd_pcm_update_state(struct snd_pcm_substream *substream,
876 struct snd_pcm_runtime *runtime);
877 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
878 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
879 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
880 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
881 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
882 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
883 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
884 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
885 const void __user *buf,
886 snd_pcm_uframes_t frames);
887 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
888 void __user *buf, snd_pcm_uframes_t frames);
889 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
890 void __user **bufs, snd_pcm_uframes_t frames);
891 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
892 void __user **bufs, snd_pcm_uframes_t frames);
894 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
896 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
897 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
898 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
900 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
901 struct snd_dma_buffer *bufp)
903 struct snd_pcm_runtime *runtime = substream->runtime;
905 runtime->dma_buffer_p = bufp;
906 runtime->dma_area = bufp->area;
907 runtime->dma_addr = bufp->addr;
908 runtime->dma_bytes = bufp->bytes;
910 runtime->dma_buffer_p = NULL;
911 runtime->dma_area = NULL;
912 runtime->dma_addr = 0;
913 runtime->dma_bytes = 0;
921 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
922 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
923 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
925 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
928 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
929 do_posix_clock_monotonic_gettime(tv);
938 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
939 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
940 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
941 int type, struct device *data,
942 size_t size, size_t max);
943 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
944 int type, void *data,
945 size_t size, size_t max);
946 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
947 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
949 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
950 size_t size, gfp_t gfp_flags);
951 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
952 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
953 unsigned long offset);
954 #if 0 /* for kernel-doc */
956 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
957 * @substream: the substream to allocate the buffer to
958 * @size: the requested buffer size, in bytes
960 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
961 * contiguous in kernel virtual space, but not in physical memory. Use this
962 * if the buffer is accessed by kernel code but not by device DMA.
964 * Returns 1 if the buffer was changed, 0 if not changed, or a negative error
967 static int snd_pcm_lib_alloc_vmalloc_buffer
968 (struct snd_pcm_substream *substream, size_t size);
970 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
971 * @substream: the substream to allocate the buffer to
972 * @size: the requested buffer size, in bytes
974 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
975 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
977 static int snd_pcm_lib_alloc_vmalloc_32_buffer
978 (struct snd_pcm_substream *substream, size_t size);
980 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
981 _snd_pcm_lib_alloc_vmalloc_buffer \
982 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
983 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
984 _snd_pcm_lib_alloc_vmalloc_buffer \
985 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
987 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
989 #ifdef CONFIG_SND_DMA_SGBUF
993 #define snd_pcm_substream_sgbuf(substream) \
994 snd_pcm_get_dma_buf(substream)->private_data
996 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
997 unsigned long offset);
998 #else /* !SND_DMA_SGBUF */
1000 * fake using a continuous buffer
1002 #define snd_pcm_sgbuf_ops_page NULL
1003 #endif /* SND_DMA_SGBUF */
1005 static inline dma_addr_t
1006 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1008 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1011 static inline void *
1012 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1014 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1017 static inline unsigned int
1018 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1019 unsigned int ofs, unsigned int size)
1021 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1024 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1025 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1027 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1028 atomic_inc(&substream->mmap_count);
1031 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1033 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1034 atomic_dec(&substream->mmap_count);
1037 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1038 struct vm_area_struct *area);
1039 /* mmap for io-memory area */
1040 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1041 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1042 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1044 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1045 #define snd_pcm_lib_mmap_iomem NULL
1048 #define snd_pcm_lib_mmap_vmalloc NULL
1050 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1052 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1059 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1060 (IEC958_AES1_CON_ORIGINAL<<8)|\
1061 (IEC958_AES1_CON_PCM_CODER<<8)|\
1062 (IEC958_AES3_CON_FS_48000<<24))
1064 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1066 const char *snd_pcm_format_name(snd_pcm_format_t format);
1069 * snd_pcm_stream_str - Get a string naming the direction of a stream
1070 * @substream: the pcm substream instance
1072 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1074 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1081 * PCM channel-mapping control API
1083 /* array element of channel maps */
1084 struct snd_pcm_chmap_elem {
1085 unsigned char channels;
1086 unsigned char map[15];
1089 /* channel map information; retrieved via snd_kcontrol_chip() */
1090 struct snd_pcm_chmap {
1091 struct snd_pcm *pcm; /* assigned PCM instance */
1092 int stream; /* PLAYBACK or CAPTURE */
1093 struct snd_kcontrol *kctl;
1094 const struct snd_pcm_chmap_elem *chmap;
1095 unsigned int max_channels;
1096 unsigned int channel_mask; /* optional: active channels bitmask */
1097 void *private_data; /* optional: private data pointer */
1100 /* get the PCM substream assigned to the given chmap info */
1101 static inline struct snd_pcm_substream *
1102 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1104 struct snd_pcm_substream *s;
1105 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1106 if (s->number == idx)
1111 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1112 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1113 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1114 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1116 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1117 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1118 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1119 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1121 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1122 const struct snd_pcm_chmap_elem *chmap,
1124 unsigned long private_value,
1125 struct snd_pcm_chmap **info_ret);
1127 #endif /* __SOUND_PCM_H */