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 (*wall_clock)(struct snd_pcm_substream *substream,
75 struct timespec *audio_ts);
76 int (*copy)(struct snd_pcm_substream *substream, int channel,
77 snd_pcm_uframes_t pos,
78 void __user *buf, snd_pcm_uframes_t count);
79 int (*silence)(struct snd_pcm_substream *substream, int channel,
80 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
81 struct page *(*page)(struct snd_pcm_substream *substream,
82 unsigned long offset);
83 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
84 int (*ack)(struct snd_pcm_substream *substream);
91 #if defined(CONFIG_SND_DYNAMIC_MINORS)
92 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
94 #define SNDRV_PCM_DEVICES 8
97 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
98 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
100 #define SNDRV_PCM_IOCTL1_RESET 0
101 #define SNDRV_PCM_IOCTL1_INFO 1
102 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
103 #define SNDRV_PCM_IOCTL1_GSTATE 3
104 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
106 #define SNDRV_PCM_TRIGGER_STOP 0
107 #define SNDRV_PCM_TRIGGER_START 1
108 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
109 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
110 #define SNDRV_PCM_TRIGGER_SUSPEND 5
111 #define SNDRV_PCM_TRIGGER_RESUME 6
113 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
115 /* If you change this don't forget to change rates[] table in pcm_native.c */
116 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
117 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
118 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
119 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
120 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
121 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
122 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
123 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
124 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
125 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
126 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
127 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
128 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
130 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
131 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
133 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
134 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
135 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
136 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
137 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
138 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
139 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
140 SNDRV_PCM_RATE_192000)
141 #define _SNDRV_PCM_FMTBIT(fmt) (1ULL << (__force int)SNDRV_PCM_FORMAT_##fmt)
142 #define SNDRV_PCM_FMTBIT_S8 _SNDRV_PCM_FMTBIT(S8)
143 #define SNDRV_PCM_FMTBIT_U8 _SNDRV_PCM_FMTBIT(U8)
144 #define SNDRV_PCM_FMTBIT_S16_LE _SNDRV_PCM_FMTBIT(S16_LE)
145 #define SNDRV_PCM_FMTBIT_S16_BE _SNDRV_PCM_FMTBIT(S16_BE)
146 #define SNDRV_PCM_FMTBIT_U16_LE _SNDRV_PCM_FMTBIT(U16_LE)
147 #define SNDRV_PCM_FMTBIT_U16_BE _SNDRV_PCM_FMTBIT(U16_BE)
148 #define SNDRV_PCM_FMTBIT_S24_LE _SNDRV_PCM_FMTBIT(S24_LE)
149 #define SNDRV_PCM_FMTBIT_S24_BE _SNDRV_PCM_FMTBIT(S24_BE)
150 #define SNDRV_PCM_FMTBIT_U24_LE _SNDRV_PCM_FMTBIT(U24_LE)
151 #define SNDRV_PCM_FMTBIT_U24_BE _SNDRV_PCM_FMTBIT(U24_BE)
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_SPECIAL _SNDRV_PCM_FMTBIT(SPECIAL)
168 #define SNDRV_PCM_FMTBIT_S24_3LE _SNDRV_PCM_FMTBIT(S24_3LE)
169 #define SNDRV_PCM_FMTBIT_U24_3LE _SNDRV_PCM_FMTBIT(U24_3LE)
170 #define SNDRV_PCM_FMTBIT_S24_3BE _SNDRV_PCM_FMTBIT(S24_3BE)
171 #define SNDRV_PCM_FMTBIT_U24_3BE _SNDRV_PCM_FMTBIT(U24_3BE)
172 #define SNDRV_PCM_FMTBIT_S20_3LE _SNDRV_PCM_FMTBIT(S20_3LE)
173 #define SNDRV_PCM_FMTBIT_U20_3LE _SNDRV_PCM_FMTBIT(U20_3LE)
174 #define SNDRV_PCM_FMTBIT_S20_3BE _SNDRV_PCM_FMTBIT(S20_3BE)
175 #define SNDRV_PCM_FMTBIT_U20_3BE _SNDRV_PCM_FMTBIT(U20_3BE)
176 #define SNDRV_PCM_FMTBIT_S18_3LE _SNDRV_PCM_FMTBIT(S18_3LE)
177 #define SNDRV_PCM_FMTBIT_U18_3LE _SNDRV_PCM_FMTBIT(U18_3LE)
178 #define SNDRV_PCM_FMTBIT_S18_3BE _SNDRV_PCM_FMTBIT(S18_3BE)
179 #define SNDRV_PCM_FMTBIT_U18_3BE _SNDRV_PCM_FMTBIT(U18_3BE)
180 #define SNDRV_PCM_FMTBIT_G723_24 _SNDRV_PCM_FMTBIT(G723_24)
181 #define SNDRV_PCM_FMTBIT_G723_24_1B _SNDRV_PCM_FMTBIT(G723_24_1B)
182 #define SNDRV_PCM_FMTBIT_G723_40 _SNDRV_PCM_FMTBIT(G723_40)
183 #define SNDRV_PCM_FMTBIT_G723_40_1B _SNDRV_PCM_FMTBIT(G723_40_1B)
184 #define SNDRV_PCM_FMTBIT_DSD_U8 _SNDRV_PCM_FMTBIT(DSD_U8)
185 #define SNDRV_PCM_FMTBIT_DSD_U16_LE _SNDRV_PCM_FMTBIT(DSD_U16_LE)
187 #ifdef SNDRV_LITTLE_ENDIAN
188 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
189 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
190 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
191 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
192 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
193 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
194 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
195 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
196 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
198 #ifdef SNDRV_BIG_ENDIAN
199 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
200 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
201 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
202 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
203 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
204 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
205 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
206 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
207 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
210 struct snd_pcm_file {
211 struct snd_pcm_substream *substream;
215 struct snd_pcm_hw_rule;
216 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
217 struct snd_pcm_hw_rule *rule);
219 struct snd_pcm_hw_rule {
221 snd_pcm_hw_rule_func_t func;
227 struct snd_pcm_hw_constraints {
228 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
229 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
230 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
231 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
232 unsigned int rules_num;
233 unsigned int rules_all;
234 struct snd_pcm_hw_rule *rules;
237 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
238 snd_pcm_hw_param_t var)
240 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
243 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
244 snd_pcm_hw_param_t var)
246 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
251 unsigned int den_min, den_max, den_step;
255 unsigned int num_min, num_max, num_step;
259 struct snd_pcm_hw_constraint_ratnums {
261 struct snd_ratnum *rats;
264 struct snd_pcm_hw_constraint_ratdens {
266 struct snd_ratden *rats;
269 struct snd_pcm_hw_constraint_list {
271 const unsigned int *list;
275 struct snd_pcm_hwptr_log;
277 struct snd_pcm_runtime {
279 struct snd_pcm_substream *trigger_master;
280 struct timespec trigger_tstamp; /* trigger timestamp */
282 snd_pcm_uframes_t avail_max;
283 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
284 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
285 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
286 unsigned long hw_ptr_buffer_jiffies; /* buffer time in jiffies */
287 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
288 u64 hw_ptr_wrap; /* offset for hw_ptr due to boundary wrap-around */
290 /* -- HW params -- */
291 snd_pcm_access_t access; /* access mode */
292 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
293 snd_pcm_subformat_t subformat; /* subformat */
294 unsigned int rate; /* rate in Hz */
295 unsigned int channels; /* channels */
296 snd_pcm_uframes_t period_size; /* period size */
297 unsigned int periods; /* periods */
298 snd_pcm_uframes_t buffer_size; /* buffer size */
299 snd_pcm_uframes_t min_align; /* Min alignment for the format */
301 unsigned int frame_bits;
302 unsigned int sample_bits;
304 unsigned int rate_num;
305 unsigned int rate_den;
306 unsigned int no_period_wakeup: 1;
308 /* -- SW params -- */
309 int tstamp_mode; /* mmap timestamp is updated */
310 unsigned int period_step;
311 snd_pcm_uframes_t start_threshold;
312 snd_pcm_uframes_t stop_threshold;
313 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
314 noise is nearest than this */
315 snd_pcm_uframes_t silence_size; /* Silence filling size */
316 snd_pcm_uframes_t boundary; /* pointers wrap point */
318 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
319 snd_pcm_uframes_t silence_filled; /* size filled with silence */
321 union snd_pcm_sync_id sync; /* hardware synchronization ID */
324 struct snd_pcm_mmap_status *status;
325 struct snd_pcm_mmap_control *control;
327 /* -- locking / scheduling -- */
328 snd_pcm_uframes_t twake; /* do transfer (!poll) wakeup if non-zero */
329 wait_queue_head_t sleep; /* poll sleep */
330 wait_queue_head_t tsleep; /* transfer sleep */
331 struct fasync_struct *fasync;
333 /* -- private section -- */
335 void (*private_free)(struct snd_pcm_runtime *runtime);
337 /* -- hardware description -- */
338 struct snd_pcm_hardware hw;
339 struct snd_pcm_hw_constraints hw_constraints;
341 /* -- interrupt callbacks -- */
342 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
343 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
346 unsigned int timer_resolution; /* timer resolution */
347 int tstamp_type; /* timestamp type */
350 unsigned char *dma_area; /* DMA area */
351 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
352 size_t dma_bytes; /* size of DMA area */
354 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
356 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
357 /* -- OSS things -- */
358 struct snd_pcm_oss_runtime oss;
361 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
362 struct snd_pcm_hwptr_log *hwptr_log;
366 struct snd_pcm_group { /* keep linked substreams */
369 struct list_head substreams;
375 struct snd_pcm_substream {
377 struct snd_pcm_str *pstr;
378 void *private_data; /* copied from pcm->private_data */
380 char name[32]; /* substream name */
381 int stream; /* stream (direction) */
382 struct pm_qos_request latency_pm_qos_req; /* pm_qos request */
383 size_t buffer_bytes_max; /* limit ring buffer size */
384 struct snd_dma_buffer dma_buffer;
386 /* -- hardware operations -- */
387 const struct snd_pcm_ops *ops;
388 /* -- runtime information -- */
389 struct snd_pcm_runtime *runtime;
390 /* -- timer section -- */
391 struct snd_timer *timer; /* timer */
392 unsigned timer_running: 1; /* time is running */
393 /* -- next substream -- */
394 struct snd_pcm_substream *next;
395 /* -- linked substreams -- */
396 struct list_head link_list; /* linked list member */
397 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
398 struct snd_pcm_group *group; /* pointer to current group */
399 /* -- assigned files -- */
403 unsigned int f_flags;
404 void (*pcm_release)(struct snd_pcm_substream *);
406 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
407 /* -- OSS things -- */
408 struct snd_pcm_oss_substream oss;
410 #ifdef CONFIG_SND_VERBOSE_PROCFS
411 struct snd_info_entry *proc_root;
412 struct snd_info_entry *proc_info_entry;
413 struct snd_info_entry *proc_hw_params_entry;
414 struct snd_info_entry *proc_sw_params_entry;
415 struct snd_info_entry *proc_status_entry;
416 struct snd_info_entry *proc_prealloc_entry;
417 struct snd_info_entry *proc_prealloc_max_entry;
420 unsigned int hw_opened: 1;
423 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
427 int stream; /* stream (direction) */
429 /* -- substreams -- */
430 unsigned int substream_count;
431 unsigned int substream_opened;
432 struct snd_pcm_substream *substream;
433 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
434 /* -- OSS things -- */
435 struct snd_pcm_oss_stream oss;
437 #ifdef CONFIG_SND_VERBOSE_PROCFS
438 struct snd_info_entry *proc_root;
439 struct snd_info_entry *proc_info_entry;
440 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
441 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
442 struct snd_info_entry *proc_xrun_debug_entry;
445 struct snd_kcontrol *chmap_kctl; /* channel-mapping controls */
449 struct snd_card *card;
450 struct list_head list;
451 int device; /* device number */
452 unsigned int info_flags;
453 unsigned short dev_class;
454 unsigned short dev_subclass;
457 struct snd_pcm_str streams[2];
458 struct mutex open_mutex;
459 wait_queue_head_t open_wait;
461 void (*private_free) (struct snd_pcm *pcm);
462 struct device *dev; /* actual hw device this belongs to */
463 bool internal; /* pcm is for internal use only */
464 bool nonatomic; /* whole PCM operations are in non-atomic context */
465 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
466 struct snd_pcm_oss oss;
470 struct snd_pcm_notify {
471 int (*n_register) (struct snd_pcm * pcm);
472 int (*n_disconnect) (struct snd_pcm * pcm);
473 int (*n_unregister) (struct snd_pcm * pcm);
474 struct list_head list;
481 extern const struct file_operations snd_pcm_f_ops[2];
483 int snd_pcm_new(struct snd_card *card, const char *id, int device,
484 int playback_count, int capture_count,
485 struct snd_pcm **rpcm);
486 int snd_pcm_new_internal(struct snd_card *card, const char *id, int device,
487 int playback_count, int capture_count,
488 struct snd_pcm **rpcm);
489 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
491 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
497 extern rwlock_t snd_pcm_link_rwlock;
498 extern struct rw_semaphore snd_pcm_link_rwsem;
500 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
501 int snd_pcm_info_user(struct snd_pcm_substream *substream,
502 struct snd_pcm_info __user *info);
503 int snd_pcm_status(struct snd_pcm_substream *substream,
504 struct snd_pcm_status *status);
505 int snd_pcm_start(struct snd_pcm_substream *substream);
506 int snd_pcm_stop(struct snd_pcm_substream *substream, snd_pcm_state_t status);
507 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
509 int snd_pcm_suspend(struct snd_pcm_substream *substream);
510 int snd_pcm_suspend_all(struct snd_pcm *pcm);
512 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
513 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
514 struct snd_pcm_substream **rsubstream);
515 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
516 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
517 struct snd_pcm_substream **rsubstream);
518 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
519 void snd_pcm_vma_notify_data(void *client, void *data);
520 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
523 #ifdef CONFIG_SND_DEBUG
524 void snd_pcm_debug_name(struct snd_pcm_substream *substream,
525 char *name, size_t len);
528 snd_pcm_debug_name(struct snd_pcm_substream *substream, char *buf, size_t size)
538 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
540 return substream->group != &substream->self_group;
543 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
545 if (substream->pcm->nonatomic) {
546 down_read(&snd_pcm_link_rwsem);
547 mutex_lock(&substream->self_group.mutex);
549 read_lock(&snd_pcm_link_rwlock);
550 spin_lock(&substream->self_group.lock);
554 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
556 if (substream->pcm->nonatomic) {
557 mutex_unlock(&substream->self_group.mutex);
558 up_read(&snd_pcm_link_rwsem);
560 spin_unlock(&substream->self_group.lock);
561 read_unlock(&snd_pcm_link_rwlock);
565 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
567 if (substream->pcm->nonatomic) {
568 down_read(&snd_pcm_link_rwsem);
569 mutex_lock(&substream->self_group.mutex);
571 read_lock_irq(&snd_pcm_link_rwlock);
572 spin_lock(&substream->self_group.lock);
576 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
578 if (substream->pcm->nonatomic) {
579 mutex_unlock(&substream->self_group.mutex);
580 up_read(&snd_pcm_link_rwsem);
582 spin_unlock(&substream->self_group.lock);
583 read_unlock_irq(&snd_pcm_link_rwlock);
587 #define snd_pcm_stream_lock_irqsave(substream, flags) \
589 if ((substream)->pcm->nonatomic) { \
590 (flags) = 0; /* XXX for avoid warning */ \
591 down_read(&snd_pcm_link_rwsem); \
592 mutex_lock(&(substream)->self_group.mutex); \
594 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
595 spin_lock(&(substream)->self_group.lock); \
599 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
601 if ((substream)->pcm->nonatomic) { \
602 mutex_unlock(&(substream)->self_group.mutex); \
603 up_read(&snd_pcm_link_rwsem); \
605 spin_unlock(&(substream)->self_group.lock); \
606 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
610 #define snd_pcm_group_for_each_entry(s, substream) \
611 list_for_each_entry(s, &substream->group->substreams, link_list)
613 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
615 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
616 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
617 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
620 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
622 return size * 8 / runtime->sample_bits;
625 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
627 return size * 8 / runtime->frame_bits;
630 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
632 return size * runtime->sample_bits / 8;
635 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
637 return size * runtime->frame_bits / 8;
640 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
642 return bytes % runtime->byte_align == 0;
645 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
647 struct snd_pcm_runtime *runtime = substream->runtime;
648 return frames_to_bytes(runtime, runtime->buffer_size);
651 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
653 struct snd_pcm_runtime *runtime = substream->runtime;
654 return frames_to_bytes(runtime, runtime->period_size);
658 * result is: 0 ... (boundary - 1)
660 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
662 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
664 avail += runtime->boundary;
665 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
666 avail -= runtime->boundary;
671 * result is: 0 ... (boundary - 1)
673 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
675 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
677 avail += runtime->boundary;
681 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
683 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
686 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
688 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
692 * snd_pcm_playback_ready - check whether the playback buffer is available
693 * @substream: the pcm substream instance
695 * Checks whether enough free space is available on the playback buffer.
697 * Return: Non-zero if available, or zero if not.
699 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
701 struct snd_pcm_runtime *runtime = substream->runtime;
702 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
706 * snd_pcm_capture_ready - check whether the capture buffer is available
707 * @substream: the pcm substream instance
709 * Checks whether enough capture data is available on the capture buffer.
711 * Return: Non-zero if available, or zero if not.
713 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
715 struct snd_pcm_runtime *runtime = substream->runtime;
716 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
720 * snd_pcm_playback_data - check whether any data exists on the playback buffer
721 * @substream: the pcm substream instance
723 * Checks whether any data exists on the playback buffer.
725 * Return: Non-zero if any data exists, or zero if not. If stop_threshold
726 * is bigger or equal to boundary, then this function returns always non-zero.
728 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
730 struct snd_pcm_runtime *runtime = substream->runtime;
732 if (runtime->stop_threshold >= runtime->boundary)
734 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
738 * snd_pcm_playback_empty - check whether the playback buffer is empty
739 * @substream: the pcm substream instance
741 * Checks whether the playback buffer is empty.
743 * Return: Non-zero if empty, or zero if not.
745 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
747 struct snd_pcm_runtime *runtime = substream->runtime;
748 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
752 * snd_pcm_capture_empty - check whether the capture buffer is empty
753 * @substream: the pcm substream instance
755 * Checks whether the capture buffer is empty.
757 * Return: Non-zero if empty, or zero if not.
759 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
761 struct snd_pcm_runtime *runtime = substream->runtime;
762 return snd_pcm_capture_avail(runtime) == 0;
765 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
766 struct snd_pcm_substream *master)
768 substream->runtime->trigger_master = master;
771 static inline int hw_is_mask(int var)
773 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
774 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
777 static inline int hw_is_interval(int var)
779 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
780 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
783 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
784 snd_pcm_hw_param_t var)
786 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
789 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
790 snd_pcm_hw_param_t var)
792 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
795 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
796 snd_pcm_hw_param_t var)
798 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
801 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
802 snd_pcm_hw_param_t var)
804 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
807 #define params_channels(p) \
808 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min)
809 #define params_rate(p) \
810 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_RATE)->min)
811 #define params_period_size(p) \
812 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min)
813 #define params_periods(p) \
814 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_PERIODS)->min)
815 #define params_buffer_size(p) \
816 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min)
817 #define params_buffer_bytes(p) \
818 (hw_param_interval_c((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min)
820 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
821 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
822 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
823 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
824 unsigned int k, struct snd_interval *c);
825 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
826 const struct snd_interval *b, struct snd_interval *c);
827 int snd_interval_list(struct snd_interval *i, unsigned int count,
828 const unsigned int *list, unsigned int mask);
829 int snd_interval_ratnum(struct snd_interval *i,
830 unsigned int rats_count, struct snd_ratnum *rats,
831 unsigned int *nump, unsigned int *denp);
833 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
834 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
835 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
837 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
839 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
840 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
842 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
844 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
846 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
847 unsigned int min, unsigned int max);
848 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
849 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
851 snd_pcm_hw_param_t var,
852 const struct snd_pcm_hw_constraint_list *l);
853 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
855 snd_pcm_hw_param_t var,
856 struct snd_pcm_hw_constraint_ratnums *r);
857 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
859 snd_pcm_hw_param_t var,
860 struct snd_pcm_hw_constraint_ratdens *r);
861 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
864 unsigned int msbits);
865 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
867 snd_pcm_hw_param_t var,
869 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
871 snd_pcm_hw_param_t var);
872 int snd_pcm_hw_rule_noresample(struct snd_pcm_runtime *runtime,
873 unsigned int base_rate);
874 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
877 snd_pcm_hw_rule_func_t func, void *private,
880 int snd_pcm_format_signed(snd_pcm_format_t format);
881 int snd_pcm_format_unsigned(snd_pcm_format_t format);
882 int snd_pcm_format_linear(snd_pcm_format_t format);
883 int snd_pcm_format_little_endian(snd_pcm_format_t format);
884 int snd_pcm_format_big_endian(snd_pcm_format_t format);
885 #if 0 /* just for DocBook */
887 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
888 * @format: the format to check
890 * Return: 1 if the given PCM format is CPU-endian, 0 if
891 * opposite, or a negative error code if endian not specified.
893 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
895 #ifdef SNDRV_LITTLE_ENDIAN
896 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
898 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
900 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
901 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
902 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
903 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
904 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
905 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsigned, int big_endian);
907 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction,
908 const struct snd_pcm_ops *ops);
909 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
910 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
911 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
912 unsigned int cmd, void *arg);
913 int snd_pcm_update_state(struct snd_pcm_substream *substream,
914 struct snd_pcm_runtime *runtime);
915 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
916 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
917 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
918 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
919 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
920 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
921 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
922 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
923 const void __user *buf,
924 snd_pcm_uframes_t frames);
925 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
926 void __user *buf, snd_pcm_uframes_t frames);
927 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
928 void __user **bufs, snd_pcm_uframes_t frames);
929 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
930 void __user **bufs, snd_pcm_uframes_t frames);
932 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
934 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
935 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
936 unsigned int snd_pcm_rate_bit_to_rate(unsigned int rate_bit);
937 unsigned int snd_pcm_rate_mask_intersect(unsigned int rates_a,
938 unsigned int rates_b);
940 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
941 struct snd_dma_buffer *bufp)
943 struct snd_pcm_runtime *runtime = substream->runtime;
945 runtime->dma_buffer_p = bufp;
946 runtime->dma_area = bufp->area;
947 runtime->dma_addr = bufp->addr;
948 runtime->dma_bytes = bufp->bytes;
950 runtime->dma_buffer_p = NULL;
951 runtime->dma_area = NULL;
952 runtime->dma_addr = 0;
953 runtime->dma_bytes = 0;
961 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
962 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
963 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
965 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
968 switch (runtime->tstamp_type) {
969 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC:
972 case SNDRV_PCM_TSTAMP_TYPE_MONOTONIC_RAW:
985 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
986 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
987 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
988 int type, struct device *data,
989 size_t size, size_t max);
990 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
991 int type, void *data,
992 size_t size, size_t max);
993 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
994 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
996 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
997 size_t size, gfp_t gfp_flags);
998 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream);
999 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
1000 unsigned long offset);
1001 #if 0 /* for kernel-doc */
1003 * snd_pcm_lib_alloc_vmalloc_buffer - allocate virtual DMA buffer
1004 * @substream: the substream to allocate the buffer to
1005 * @size: the requested buffer size, in bytes
1007 * Allocates the PCM substream buffer using vmalloc(), i.e., the memory is
1008 * contiguous in kernel virtual space, but not in physical memory. Use this
1009 * if the buffer is accessed by kernel code but not by device DMA.
1011 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1014 static int snd_pcm_lib_alloc_vmalloc_buffer
1015 (struct snd_pcm_substream *substream, size_t size);
1017 * snd_pcm_lib_alloc_vmalloc_32_buffer - allocate 32-bit-addressable buffer
1018 * @substream: the substream to allocate the buffer to
1019 * @size: the requested buffer size, in bytes
1021 * This function works like snd_pcm_lib_alloc_vmalloc_buffer(), but uses
1022 * vmalloc_32(), i.e., the pages are allocated from 32-bit-addressable memory.
1024 * Return: 1 if the buffer was changed, 0 if not changed, or a negative error
1027 static int snd_pcm_lib_alloc_vmalloc_32_buffer
1028 (struct snd_pcm_substream *substream, size_t size);
1030 #define snd_pcm_lib_alloc_vmalloc_buffer(subs, size) \
1031 _snd_pcm_lib_alloc_vmalloc_buffer \
1032 (subs, size, GFP_KERNEL | __GFP_HIGHMEM | __GFP_ZERO)
1033 #define snd_pcm_lib_alloc_vmalloc_32_buffer(subs, size) \
1034 _snd_pcm_lib_alloc_vmalloc_buffer \
1035 (subs, size, GFP_KERNEL | GFP_DMA32 | __GFP_ZERO)
1037 #define snd_pcm_get_dma_buf(substream) ((substream)->runtime->dma_buffer_p)
1039 #ifdef CONFIG_SND_DMA_SGBUF
1041 * SG-buffer handling
1043 #define snd_pcm_substream_sgbuf(substream) \
1044 snd_pcm_get_dma_buf(substream)->private_data
1046 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
1047 unsigned long offset);
1048 #else /* !SND_DMA_SGBUF */
1050 * fake using a continuous buffer
1052 #define snd_pcm_sgbuf_ops_page NULL
1053 #endif /* SND_DMA_SGBUF */
1055 static inline dma_addr_t
1056 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
1058 return snd_sgbuf_get_addr(snd_pcm_get_dma_buf(substream), ofs);
1061 static inline void *
1062 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
1064 return snd_sgbuf_get_ptr(snd_pcm_get_dma_buf(substream), ofs);
1067 static inline unsigned int
1068 snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
1069 unsigned int ofs, unsigned int size)
1071 return snd_sgbuf_get_chunk_size(snd_pcm_get_dma_buf(substream), ofs, size);
1074 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1075 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1077 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1078 atomic_inc(&substream->mmap_count);
1081 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1083 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
1084 atomic_dec(&substream->mmap_count);
1087 int snd_pcm_lib_default_mmap(struct snd_pcm_substream *substream,
1088 struct vm_area_struct *area);
1089 /* mmap for io-memory area */
1090 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1091 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
1092 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
1094 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
1095 #define snd_pcm_lib_mmap_iomem NULL
1098 #define snd_pcm_lib_mmap_vmalloc NULL
1100 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1102 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1109 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1110 (IEC958_AES1_CON_ORIGINAL<<8)|\
1111 (IEC958_AES1_CON_PCM_CODER<<8)|\
1112 (IEC958_AES3_CON_FS_48000<<24))
1114 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
1116 const char *snd_pcm_format_name(snd_pcm_format_t format);
1119 * snd_pcm_stream_str - Get a string naming the direction of a stream
1120 * @substream: the pcm substream instance
1122 * Return: A string naming the direction of the stream.
1124 static inline const char *snd_pcm_stream_str(struct snd_pcm_substream *substream)
1126 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
1133 * PCM channel-mapping control API
1135 /* array element of channel maps */
1136 struct snd_pcm_chmap_elem {
1137 unsigned char channels;
1138 unsigned char map[15];
1141 /* channel map information; retrieved via snd_kcontrol_chip() */
1142 struct snd_pcm_chmap {
1143 struct snd_pcm *pcm; /* assigned PCM instance */
1144 int stream; /* PLAYBACK or CAPTURE */
1145 struct snd_kcontrol *kctl;
1146 const struct snd_pcm_chmap_elem *chmap;
1147 unsigned int max_channels;
1148 unsigned int channel_mask; /* optional: active channels bitmask */
1149 void *private_data; /* optional: private data pointer */
1152 /* get the PCM substream assigned to the given chmap info */
1153 static inline struct snd_pcm_substream *
1154 snd_pcm_chmap_substream(struct snd_pcm_chmap *info, unsigned int idx)
1156 struct snd_pcm_substream *s;
1157 for (s = info->pcm->streams[info->stream].substream; s; s = s->next)
1158 if (s->number == idx)
1163 /* ALSA-standard channel maps (RL/RR prior to C/LFE) */
1164 extern const struct snd_pcm_chmap_elem snd_pcm_std_chmaps[];
1165 /* Other world's standard channel maps (C/LFE prior to RL/RR) */
1166 extern const struct snd_pcm_chmap_elem snd_pcm_alt_chmaps[];
1168 /* bit masks to be passed to snd_pcm_chmap.channel_mask field */
1169 #define SND_PCM_CHMAP_MASK_24 ((1U << 2) | (1U << 4))
1170 #define SND_PCM_CHMAP_MASK_246 (SND_PCM_CHMAP_MASK_24 | (1U << 6))
1171 #define SND_PCM_CHMAP_MASK_2468 (SND_PCM_CHMAP_MASK_246 | (1U << 8))
1173 int snd_pcm_add_chmap_ctls(struct snd_pcm *pcm, int stream,
1174 const struct snd_pcm_chmap_elem *chmap,
1176 unsigned long private_value,
1177 struct snd_pcm_chmap **info_ret);
1179 /* Strong-typed conversion of pcm_format to bitwise */
1180 static inline u64 pcm_format_to_bits(snd_pcm_format_t pcm_format)
1182 return 1ULL << (__force int) pcm_format;
1185 /* printk helpers */
1186 #define pcm_err(pcm, fmt, args...) \
1187 dev_err((pcm)->card->dev, fmt, ##args)
1188 #define pcm_warn(pcm, fmt, args...) \
1189 dev_warn((pcm)->card->dev, fmt, ##args)
1190 #define pcm_dbg(pcm, fmt, args...) \
1191 dev_dbg((pcm)->card->dev, fmt, ##args)
1193 #endif /* __SOUND_PCM_H */