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>
33 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
34 #define snd_pcm_chip(pcm) ((pcm)->private_data)
36 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
41 * Hardware (lowlevel) section
44 struct snd_pcm_hardware {
45 unsigned int info; /* SNDRV_PCM_INFO_* */
46 u64 formats; /* SNDRV_PCM_FMTBIT_* */
47 unsigned int rates; /* SNDRV_PCM_RATE_* */
48 unsigned int rate_min; /* min rate */
49 unsigned int rate_max; /* max rate */
50 unsigned int channels_min; /* min channels */
51 unsigned int channels_max; /* max channels */
52 size_t buffer_bytes_max; /* max buffer size */
53 size_t period_bytes_min; /* min period size */
54 size_t period_bytes_max; /* max period size */
55 unsigned int periods_min; /* min # of periods */
56 unsigned int periods_max; /* max # of periods */
57 size_t fifo_size; /* fifo size in bytes */
60 struct snd_pcm_substream;
63 int (*open)(struct snd_pcm_substream *substream);
64 int (*close)(struct snd_pcm_substream *substream);
65 int (*ioctl)(struct snd_pcm_substream * substream,
66 unsigned int cmd, void *arg);
67 int (*hw_params)(struct snd_pcm_substream *substream,
68 struct snd_pcm_hw_params *params);
69 int (*hw_free)(struct snd_pcm_substream *substream);
70 int (*prepare)(struct snd_pcm_substream *substream);
71 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
72 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
73 int (*copy)(struct snd_pcm_substream *substream, int channel,
74 snd_pcm_uframes_t pos,
75 void __user *buf, snd_pcm_uframes_t count);
76 int (*silence)(struct snd_pcm_substream *substream, int channel,
77 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
78 struct page *(*page)(struct snd_pcm_substream *substream,
79 unsigned long offset);
80 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
81 int (*ack)(struct snd_pcm_substream *substream);
88 #if defined(CONFIG_SND_DYNAMIC_MINORS)
89 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
91 #define SNDRV_PCM_DEVICES 8
94 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
95 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97 #define SNDRV_PCM_IOCTL1_RESET 0
98 #define SNDRV_PCM_IOCTL1_INFO 1
99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
100 #define SNDRV_PCM_IOCTL1_GSTATE 3
102 #define SNDRV_PCM_TRIGGER_STOP 0
103 #define SNDRV_PCM_TRIGGER_START 1
104 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
105 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
106 #define SNDRV_PCM_TRIGGER_SUSPEND 5
107 #define SNDRV_PCM_TRIGGER_RESUME 6
109 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
111 /* If you change this don't forget to change rates[] table in pcm_native.c */
112 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
113 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
114 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
115 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
116 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
117 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
118 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
119 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
120 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
121 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
122 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
123 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
124 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
126 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
127 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
129 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
130 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
131 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
132 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
133 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
134 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
135 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
136 SNDRV_PCM_RATE_192000)
137 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
138 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
139 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
140 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
141 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
142 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
143 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
144 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
145 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
146 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
147 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
148 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
149 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
150 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
151 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
152 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
153 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
154 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
155 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
156 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
157 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
158 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
159 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
160 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
161 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
162 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
163 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
164 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
165 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
166 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
167 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
168 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
169 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
170 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
171 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
172 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
173 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
174 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
176 #ifdef SNDRV_LITTLE_ENDIAN
177 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
178 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
179 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
180 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
181 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
182 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
183 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
184 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
185 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
187 #ifdef SNDRV_BIG_ENDIAN
188 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
189 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
190 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
191 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
192 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
193 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
194 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
195 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
196 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
199 struct snd_pcm_file {
200 struct snd_pcm_substream *substream;
204 struct snd_pcm_hw_rule;
205 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
206 struct snd_pcm_hw_rule *rule);
208 struct snd_pcm_hw_rule {
210 snd_pcm_hw_rule_func_t func;
216 struct snd_pcm_hw_constraints {
217 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
218 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
219 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
220 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
221 unsigned int rules_num;
222 unsigned int rules_all;
223 struct snd_pcm_hw_rule *rules;
226 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
227 snd_pcm_hw_param_t var)
229 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
232 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
233 snd_pcm_hw_param_t var)
235 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
240 unsigned int den_min, den_max, den_step;
244 unsigned int num_min, num_max, num_step;
248 struct snd_pcm_hw_constraint_ratnums {
250 struct snd_ratnum *rats;
253 struct snd_pcm_hw_constraint_ratdens {
255 struct snd_ratden *rats;
258 struct snd_pcm_hw_constraint_list {
264 struct snd_pcm_runtime {
266 struct snd_pcm_substream *trigger_master;
267 struct timespec trigger_tstamp; /* trigger timestamp */
269 snd_pcm_uframes_t avail_max;
270 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
271 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
272 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
274 /* -- HW params -- */
275 snd_pcm_access_t access; /* access mode */
276 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
277 snd_pcm_subformat_t subformat; /* subformat */
278 unsigned int rate; /* rate in Hz */
279 unsigned int channels; /* channels */
280 snd_pcm_uframes_t period_size; /* period size */
281 unsigned int periods; /* periods */
282 snd_pcm_uframes_t buffer_size; /* buffer size */
283 snd_pcm_uframes_t min_align; /* Min alignment for the format */
285 unsigned int frame_bits;
286 unsigned int sample_bits;
288 unsigned int rate_num;
289 unsigned int rate_den;
291 /* -- SW params -- */
292 int tstamp_mode; /* mmap timestamp is updated */
293 unsigned int period_step;
294 snd_pcm_uframes_t start_threshold;
295 snd_pcm_uframes_t stop_threshold;
296 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
297 noise is nearest than this */
298 snd_pcm_uframes_t silence_size; /* Silence filling size */
299 snd_pcm_uframes_t boundary; /* pointers wrap point */
301 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
302 snd_pcm_uframes_t silence_filled; /* size filled with silence */
304 union snd_pcm_sync_id sync; /* hardware synchronization ID */
307 struct snd_pcm_mmap_status *status;
308 struct snd_pcm_mmap_control *control;
310 /* -- locking / scheduling -- */
311 wait_queue_head_t sleep;
312 struct fasync_struct *fasync;
314 /* -- private section -- */
316 void (*private_free)(struct snd_pcm_runtime *runtime);
318 /* -- hardware description -- */
319 struct snd_pcm_hardware hw;
320 struct snd_pcm_hw_constraints hw_constraints;
322 /* -- interrupt callbacks -- */
323 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
324 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
327 unsigned int timer_resolution; /* timer resolution */
328 int tstamp_type; /* timestamp type */
331 unsigned char *dma_area; /* DMA area */
332 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
333 size_t dma_bytes; /* size of DMA area */
335 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
337 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
338 /* -- OSS things -- */
339 struct snd_pcm_oss_runtime oss;
343 struct snd_pcm_group { /* keep linked substreams */
345 struct list_head substreams;
349 struct snd_pcm_substream {
351 struct snd_pcm_str *pstr;
352 void *private_data; /* copied from pcm->private_data */
354 char name[32]; /* substream name */
355 int stream; /* stream (direction) */
356 char latency_id[20]; /* latency identifier */
357 size_t buffer_bytes_max; /* limit ring buffer size */
358 struct snd_dma_buffer dma_buffer;
359 unsigned int dma_buf_id;
361 /* -- hardware operations -- */
362 struct snd_pcm_ops *ops;
363 /* -- runtime information -- */
364 struct snd_pcm_runtime *runtime;
365 /* -- timer section -- */
366 struct snd_timer *timer; /* timer */
367 unsigned timer_running: 1; /* time is running */
368 /* -- next substream -- */
369 struct snd_pcm_substream *next;
370 /* -- linked substreams -- */
371 struct list_head link_list; /* linked list member */
372 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
373 struct snd_pcm_group *group; /* pointer to current group */
374 /* -- assigned files -- */
378 unsigned int f_flags;
379 void (*pcm_release)(struct snd_pcm_substream *);
380 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
381 /* -- OSS things -- */
382 struct snd_pcm_oss_substream oss;
384 #ifdef CONFIG_SND_VERBOSE_PROCFS
385 struct snd_info_entry *proc_root;
386 struct snd_info_entry *proc_info_entry;
387 struct snd_info_entry *proc_hw_params_entry;
388 struct snd_info_entry *proc_sw_params_entry;
389 struct snd_info_entry *proc_status_entry;
390 struct snd_info_entry *proc_prealloc_entry;
391 struct snd_info_entry *proc_prealloc_max_entry;
394 unsigned int hw_opened: 1;
397 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
401 int stream; /* stream (direction) */
403 /* -- substreams -- */
404 unsigned int substream_count;
405 unsigned int substream_opened;
406 struct snd_pcm_substream *substream;
407 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
408 /* -- OSS things -- */
409 struct snd_pcm_oss_stream oss;
411 #ifdef CONFIG_SND_VERBOSE_PROCFS
412 struct snd_info_entry *proc_root;
413 struct snd_info_entry *proc_info_entry;
414 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
415 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
416 struct snd_info_entry *proc_xrun_debug_entry;
422 struct snd_card *card;
423 struct list_head list;
424 int device; /* device number */
425 unsigned int info_flags;
426 unsigned short dev_class;
427 unsigned short dev_subclass;
430 struct snd_pcm_str streams[2];
431 struct mutex open_mutex;
432 wait_queue_head_t open_wait;
434 void (*private_free) (struct snd_pcm *pcm);
435 struct device *dev; /* actual hw device this belongs to */
436 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
437 struct snd_pcm_oss oss;
441 struct snd_pcm_notify {
442 int (*n_register) (struct snd_pcm * pcm);
443 int (*n_disconnect) (struct snd_pcm * pcm);
444 int (*n_unregister) (struct snd_pcm * pcm);
445 struct list_head list;
452 extern const struct file_operations snd_pcm_f_ops[2];
454 int snd_pcm_new(struct snd_card *card, const char *id, int device,
455 int playback_count, int capture_count,
456 struct snd_pcm **rpcm);
457 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
459 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
465 extern rwlock_t snd_pcm_link_rwlock;
467 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
468 int snd_pcm_info_user(struct snd_pcm_substream *substream,
469 struct snd_pcm_info __user *info);
470 int snd_pcm_status(struct snd_pcm_substream *substream,
471 struct snd_pcm_status *status);
472 int snd_pcm_start(struct snd_pcm_substream *substream);
473 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
474 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
476 int snd_pcm_suspend(struct snd_pcm_substream *substream);
477 int snd_pcm_suspend_all(struct snd_pcm *pcm);
479 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
480 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
481 struct snd_pcm_substream **rsubstream);
482 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
483 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
484 struct snd_pcm_substream **rsubstream);
485 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
486 void snd_pcm_vma_notify_data(void *client, void *data);
487 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
493 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
495 return substream->group != &substream->self_group;
498 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
500 read_lock(&snd_pcm_link_rwlock);
501 spin_lock(&substream->self_group.lock);
504 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
506 spin_unlock(&substream->self_group.lock);
507 read_unlock(&snd_pcm_link_rwlock);
510 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
512 read_lock_irq(&snd_pcm_link_rwlock);
513 spin_lock(&substream->self_group.lock);
516 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
518 spin_unlock(&substream->self_group.lock);
519 read_unlock_irq(&snd_pcm_link_rwlock);
522 #define snd_pcm_stream_lock_irqsave(substream, flags) \
524 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
525 spin_lock(&substream->self_group.lock); \
528 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
530 spin_unlock(&substream->self_group.lock); \
531 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
534 #define snd_pcm_group_for_each_entry(s, substream) \
535 list_for_each_entry(s, &substream->group->substreams, link_list)
537 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
539 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
540 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
541 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
544 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
546 return size * 8 / runtime->sample_bits;
549 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
551 return size * 8 / runtime->frame_bits;
554 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
556 return size * runtime->sample_bits / 8;
559 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
561 return size * runtime->frame_bits / 8;
564 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
566 return bytes % runtime->byte_align == 0;
569 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
571 struct snd_pcm_runtime *runtime = substream->runtime;
572 return frames_to_bytes(runtime, runtime->buffer_size);
575 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
577 struct snd_pcm_runtime *runtime = substream->runtime;
578 return frames_to_bytes(runtime, runtime->period_size);
582 * result is: 0 ... (boundary - 1)
584 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
586 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
588 avail += runtime->boundary;
589 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
590 avail -= runtime->boundary;
595 * result is: 0 ... (boundary - 1)
597 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
599 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
601 avail += runtime->boundary;
605 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
607 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
610 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
612 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
616 * snd_pcm_playback_ready - check whether the playback buffer is available
617 * @substream: the pcm substream instance
619 * Checks whether enough free space is available on the playback buffer.
621 * Returns non-zero if available, or zero if not.
623 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
625 struct snd_pcm_runtime *runtime = substream->runtime;
626 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
630 * snd_pcm_capture_ready - check whether the capture buffer is available
631 * @substream: the pcm substream instance
633 * Checks whether enough capture data is available on the capture buffer.
635 * Returns non-zero if available, or zero if not.
637 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
639 struct snd_pcm_runtime *runtime = substream->runtime;
640 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
644 * snd_pcm_playback_data - check whether any data exists on the playback buffer
645 * @substream: the pcm substream instance
647 * Checks whether any data exists on the playback buffer. If stop_threshold
648 * is bigger or equal to boundary, then this function returns always non-zero.
650 * Returns non-zero if exists, or zero if not.
652 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
654 struct snd_pcm_runtime *runtime = substream->runtime;
656 if (runtime->stop_threshold >= runtime->boundary)
658 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
662 * snd_pcm_playback_empty - check whether the playback buffer is empty
663 * @substream: the pcm substream instance
665 * Checks whether the playback buffer is empty.
667 * Returns non-zero if empty, or zero if not.
669 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
671 struct snd_pcm_runtime *runtime = substream->runtime;
672 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
676 * snd_pcm_capture_empty - check whether the capture buffer is empty
677 * @substream: the pcm substream instance
679 * Checks whether the capture buffer is empty.
681 * Returns non-zero if empty, or zero if not.
683 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
685 struct snd_pcm_runtime *runtime = substream->runtime;
686 return snd_pcm_capture_avail(runtime) == 0;
689 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
690 struct snd_pcm_substream *master)
692 substream->runtime->trigger_master = master;
695 static inline int hw_is_mask(int var)
697 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
698 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
701 static inline int hw_is_interval(int var)
703 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
704 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
707 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
708 snd_pcm_hw_param_t var)
710 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
713 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
714 snd_pcm_hw_param_t var)
716 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
719 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
720 snd_pcm_hw_param_t var)
722 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
725 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
726 snd_pcm_hw_param_t var)
728 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
731 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
732 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
733 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
734 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
735 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
736 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
737 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
738 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
739 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
740 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
743 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
744 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
745 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
746 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
747 unsigned int k, struct snd_interval *c);
748 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
749 const struct snd_interval *b, struct snd_interval *c);
750 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
751 int snd_interval_ratnum(struct snd_interval *i,
752 unsigned int rats_count, struct snd_ratnum *rats,
753 unsigned int *nump, unsigned int *denp);
755 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
756 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
757 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
759 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
761 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
762 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
764 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
766 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
768 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
769 unsigned int min, unsigned int max);
770 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
771 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
773 snd_pcm_hw_param_t var,
774 struct snd_pcm_hw_constraint_list *l);
775 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
777 snd_pcm_hw_param_t var,
778 struct snd_pcm_hw_constraint_ratnums *r);
779 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
781 snd_pcm_hw_param_t var,
782 struct snd_pcm_hw_constraint_ratdens *r);
783 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
786 unsigned int msbits);
787 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
789 snd_pcm_hw_param_t var,
791 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
793 snd_pcm_hw_param_t var);
794 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
797 snd_pcm_hw_rule_func_t func, void *private,
800 int snd_pcm_format_signed(snd_pcm_format_t format);
801 int snd_pcm_format_unsigned(snd_pcm_format_t format);
802 int snd_pcm_format_linear(snd_pcm_format_t format);
803 int snd_pcm_format_little_endian(snd_pcm_format_t format);
804 int snd_pcm_format_big_endian(snd_pcm_format_t format);
805 #if 0 /* just for DocBook */
807 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
808 * @format: the format to check
810 * Returns 1 if the given PCM format is CPU-endian, 0 if
811 * opposite, or a negative error code if endian not specified.
813 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
815 #ifdef SNDRV_LITTLE_ENDIAN
816 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
818 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
820 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
821 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
822 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
823 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
824 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
825 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
827 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
828 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
829 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
830 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
831 unsigned int cmd, void *arg);
832 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
833 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
834 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
835 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
836 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
837 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
838 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
839 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
840 const void __user *buf,
841 snd_pcm_uframes_t frames);
842 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
843 void __user *buf, snd_pcm_uframes_t frames);
844 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
845 void __user **bufs, snd_pcm_uframes_t frames);
846 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
847 void __user **bufs, snd_pcm_uframes_t frames);
849 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
851 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
852 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
854 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
855 struct snd_dma_buffer *bufp)
857 struct snd_pcm_runtime *runtime = substream->runtime;
859 runtime->dma_buffer_p = bufp;
860 runtime->dma_area = bufp->area;
861 runtime->dma_addr = bufp->addr;
862 runtime->dma_bytes = bufp->bytes;
864 runtime->dma_buffer_p = NULL;
865 runtime->dma_area = NULL;
866 runtime->dma_addr = 0;
867 runtime->dma_bytes = 0;
875 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
876 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
877 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
879 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
882 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
883 do_posix_clock_monotonic_gettime(tv);
892 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
893 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
894 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
895 int type, struct device *data,
896 size_t size, size_t max);
897 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
898 int type, void *data,
899 size_t size, size_t max);
900 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
901 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
906 #define snd_pcm_substream_sgbuf(substream) \
907 ((substream)->runtime->dma_buffer_p->private_data)
909 static inline dma_addr_t
910 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
912 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
913 return snd_sgbuf_get_addr(sg, ofs);
917 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
919 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
920 return snd_sgbuf_get_ptr(sg, ofs);
923 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
924 unsigned long offset);
925 unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
926 unsigned int ofs, unsigned int size);
928 /* handle mmap counter - PCM mmap callback should handle this counter properly */
929 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
931 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
932 atomic_inc(&substream->mmap_count);
935 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
937 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
938 atomic_dec(&substream->mmap_count);
941 /* mmap for io-memory area */
942 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
943 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
944 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
946 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
947 #define snd_pcm_lib_mmap_iomem NULL
950 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
952 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
959 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
960 (IEC958_AES1_CON_ORIGINAL<<8)|\
961 (IEC958_AES1_CON_PCM_CODER<<8)|\
962 (IEC958_AES3_CON_FS_48000<<24))
964 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
966 #endif /* __SOUND_PCM_H */