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 <linux/poll.h>
30 #include <linux/bitops.h>
32 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
33 #define snd_pcm_chip(pcm) ((pcm)->private_data)
35 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
40 * Hardware (lowlevel) section
43 struct snd_pcm_hardware {
44 unsigned int info; /* SNDRV_PCM_INFO_* */
45 u64 formats; /* SNDRV_PCM_FMTBIT_* */
46 unsigned int rates; /* SNDRV_PCM_RATE_* */
47 unsigned int rate_min; /* min rate */
48 unsigned int rate_max; /* max rate */
49 unsigned int channels_min; /* min channels */
50 unsigned int channels_max; /* max channels */
51 size_t buffer_bytes_max; /* max buffer size */
52 size_t period_bytes_min; /* min period size */
53 size_t period_bytes_max; /* max period size */
54 unsigned int periods_min; /* min # of periods */
55 unsigned int periods_max; /* max # of periods */
56 size_t fifo_size; /* fifo size in bytes */
59 struct snd_pcm_substream;
62 int (*open)(struct snd_pcm_substream *substream);
63 int (*close)(struct snd_pcm_substream *substream);
64 int (*ioctl)(struct snd_pcm_substream * substream,
65 unsigned int cmd, void *arg);
66 int (*hw_params)(struct snd_pcm_substream *substream,
67 struct snd_pcm_hw_params *params);
68 int (*hw_free)(struct snd_pcm_substream *substream);
69 int (*prepare)(struct snd_pcm_substream *substream);
70 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
71 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
72 int (*copy)(struct snd_pcm_substream *substream, int channel,
73 snd_pcm_uframes_t pos,
74 void __user *buf, snd_pcm_uframes_t count);
75 int (*silence)(struct snd_pcm_substream *substream, int channel,
76 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
77 struct page *(*page)(struct snd_pcm_substream *substream,
78 unsigned long offset);
79 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
80 int (*ack)(struct snd_pcm_substream *substream);
87 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
88 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
90 #define SNDRV_PCM_IOCTL1_RESET 0
91 #define SNDRV_PCM_IOCTL1_INFO 1
92 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
93 #define SNDRV_PCM_IOCTL1_GSTATE 3
95 #define SNDRV_PCM_TRIGGER_STOP 0
96 #define SNDRV_PCM_TRIGGER_START 1
97 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
98 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
99 #define SNDRV_PCM_TRIGGER_SUSPEND 5
100 #define SNDRV_PCM_TRIGGER_RESUME 6
102 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
104 /* If you change this don't forget to change rates[] table in pcm_native.c */
105 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
106 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
107 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
108 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
109 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
110 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
111 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
112 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
113 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
114 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
115 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
116 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
117 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
119 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
120 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
122 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
123 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
124 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
125 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
126 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
127 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
128 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
129 SNDRV_PCM_RATE_192000)
130 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
131 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
132 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
133 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
134 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
135 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
136 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
137 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
138 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
139 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
140 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
141 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
142 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
143 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
144 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
145 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
146 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
147 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
148 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
149 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
150 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
151 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
152 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
153 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
154 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
155 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
156 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
157 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
158 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
159 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
160 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
161 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
162 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
163 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
164 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
165 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
166 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
167 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
169 #ifdef SNDRV_LITTLE_ENDIAN
170 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
171 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
172 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
173 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
174 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
175 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
176 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
177 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
178 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
180 #ifdef SNDRV_BIG_ENDIAN
181 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
182 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
183 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
184 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
185 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
186 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
187 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
188 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
189 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
192 struct snd_pcm_file {
193 struct snd_pcm_substream *substream;
197 struct snd_pcm_hw_rule;
198 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
199 struct snd_pcm_hw_rule *rule);
201 struct snd_pcm_hw_rule {
203 snd_pcm_hw_rule_func_t func;
209 struct snd_pcm_hw_constraints {
210 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
211 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
212 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
213 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
214 unsigned int rules_num;
215 unsigned int rules_all;
216 struct snd_pcm_hw_rule *rules;
219 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
220 snd_pcm_hw_param_t var)
222 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
225 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
226 snd_pcm_hw_param_t var)
228 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
233 unsigned int den_min, den_max, den_step;
237 unsigned int num_min, num_max, num_step;
241 struct snd_pcm_hw_constraint_ratnums {
243 struct snd_ratnum *rats;
246 struct snd_pcm_hw_constraint_ratdens {
248 struct snd_ratden *rats;
251 struct snd_pcm_hw_constraint_list {
257 struct snd_pcm_runtime {
259 struct snd_pcm_substream *trigger_master;
260 struct timespec trigger_tstamp; /* trigger timestamp */
262 snd_pcm_uframes_t avail_max;
263 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
264 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
266 /* -- HW params -- */
267 snd_pcm_access_t access; /* access mode */
268 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
269 snd_pcm_subformat_t subformat; /* subformat */
270 unsigned int rate; /* rate in Hz */
271 unsigned int channels; /* channels */
272 snd_pcm_uframes_t period_size; /* period size */
273 unsigned int periods; /* periods */
274 snd_pcm_uframes_t buffer_size; /* buffer size */
275 snd_pcm_uframes_t min_align; /* Min alignment for the format */
277 unsigned int frame_bits;
278 unsigned int sample_bits;
280 unsigned int rate_num;
281 unsigned int rate_den;
283 /* -- SW params -- */
284 int tstamp_mode; /* mmap timestamp is updated */
285 unsigned int period_step;
286 snd_pcm_uframes_t start_threshold;
287 snd_pcm_uframes_t stop_threshold;
288 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
289 noise is nearest than this */
290 snd_pcm_uframes_t silence_size; /* Silence filling size */
291 snd_pcm_uframes_t boundary; /* pointers wrap point */
293 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
294 snd_pcm_uframes_t silence_filled; /* size filled with silence */
296 union snd_pcm_sync_id sync; /* hardware synchronization ID */
299 struct snd_pcm_mmap_status *status;
300 struct snd_pcm_mmap_control *control;
302 /* -- locking / scheduling -- */
303 wait_queue_head_t sleep;
304 struct fasync_struct *fasync;
306 /* -- private section -- */
308 void (*private_free)(struct snd_pcm_runtime *runtime);
310 /* -- hardware description -- */
311 struct snd_pcm_hardware hw;
312 struct snd_pcm_hw_constraints hw_constraints;
314 /* -- interrupt callbacks -- */
315 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
316 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
319 unsigned int timer_resolution; /* timer resolution */
320 int tstamp_type; /* timestamp type */
323 unsigned char *dma_area; /* DMA area */
324 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
325 size_t dma_bytes; /* size of DMA area */
327 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
329 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
330 /* -- OSS things -- */
331 struct snd_pcm_oss_runtime oss;
335 struct snd_pcm_group { /* keep linked substreams */
337 struct list_head substreams;
341 struct snd_pcm_substream {
343 struct snd_pcm_str *pstr;
344 void *private_data; /* copied from pcm->private_data */
346 char name[32]; /* substream name */
347 int stream; /* stream (direction) */
348 char latency_id[20]; /* latency identifier */
349 size_t buffer_bytes_max; /* limit ring buffer size */
350 struct snd_dma_buffer dma_buffer;
351 unsigned int dma_buf_id;
353 /* -- hardware operations -- */
354 struct snd_pcm_ops *ops;
355 /* -- runtime information -- */
356 struct snd_pcm_runtime *runtime;
357 /* -- timer section -- */
358 struct snd_timer *timer; /* timer */
359 unsigned timer_running: 1; /* time is running */
360 spinlock_t timer_lock;
361 /* -- next substream -- */
362 struct snd_pcm_substream *next;
363 /* -- linked substreams -- */
364 struct list_head link_list; /* linked list member */
365 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
366 struct snd_pcm_group *group; /* pointer to current group */
367 /* -- assigned files -- */
371 unsigned int f_flags;
372 void (*pcm_release)(struct snd_pcm_substream *);
373 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
374 /* -- OSS things -- */
375 struct snd_pcm_oss_substream oss;
377 #ifdef CONFIG_SND_VERBOSE_PROCFS
378 struct snd_info_entry *proc_root;
379 struct snd_info_entry *proc_info_entry;
380 struct snd_info_entry *proc_hw_params_entry;
381 struct snd_info_entry *proc_sw_params_entry;
382 struct snd_info_entry *proc_status_entry;
383 struct snd_info_entry *proc_prealloc_entry;
384 struct snd_info_entry *proc_prealloc_max_entry;
387 unsigned int hw_opened: 1;
390 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
394 int stream; /* stream (direction) */
396 /* -- substreams -- */
397 unsigned int substream_count;
398 unsigned int substream_opened;
399 struct snd_pcm_substream *substream;
400 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
401 /* -- OSS things -- */
402 struct snd_pcm_oss_stream oss;
404 #ifdef CONFIG_SND_VERBOSE_PROCFS
405 struct snd_info_entry *proc_root;
406 struct snd_info_entry *proc_info_entry;
407 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
408 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
409 struct snd_info_entry *proc_xrun_debug_entry;
415 struct snd_card *card;
416 struct list_head list;
417 int device; /* device number */
418 unsigned int info_flags;
419 unsigned short dev_class;
420 unsigned short dev_subclass;
423 struct snd_pcm_str streams[2];
424 struct mutex open_mutex;
425 wait_queue_head_t open_wait;
427 void (*private_free) (struct snd_pcm *pcm);
428 struct device *dev; /* actual hw device this belongs to */
429 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
430 struct snd_pcm_oss oss;
434 struct snd_pcm_notify {
435 int (*n_register) (struct snd_pcm * pcm);
436 int (*n_disconnect) (struct snd_pcm * pcm);
437 int (*n_unregister) (struct snd_pcm * pcm);
438 struct list_head list;
445 extern const struct file_operations snd_pcm_f_ops[2];
447 int snd_pcm_new(struct snd_card *card, char *id, int device,
448 int playback_count, int capture_count,
449 struct snd_pcm **rpcm);
450 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
452 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
458 extern rwlock_t snd_pcm_link_rwlock;
460 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
461 int snd_pcm_info_user(struct snd_pcm_substream *substream,
462 struct snd_pcm_info __user *info);
463 int snd_pcm_status(struct snd_pcm_substream *substream,
464 struct snd_pcm_status *status);
465 int snd_pcm_start(struct snd_pcm_substream *substream);
466 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
467 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
469 int snd_pcm_suspend(struct snd_pcm_substream *substream);
470 int snd_pcm_suspend_all(struct snd_pcm *pcm);
472 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
473 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
474 struct snd_pcm_substream **rsubstream);
475 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
476 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
477 struct snd_pcm_substream **rsubstream);
478 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
479 void snd_pcm_vma_notify_data(void *client, void *data);
480 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
482 #if BITS_PER_LONG >= 64
484 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
492 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
495 low = *n & 0xffffffff;
498 u_int32_t high1 = high % div;
500 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
501 *n = (u_int64_t)high << 32 | low;
509 static inline void divl(u_int32_t high, u_int32_t low,
511 u_int32_t *q, u_int32_t *r)
513 u_int64_t n = (u_int64_t)high << 32 | low;
514 u_int64_t d = (u_int64_t)div << 31;
517 while (n > 0xffffffffU) {
529 *q = q1 | (low / div);
538 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
541 low = *n & 0xffffffff;
544 u_int32_t high1 = high % div;
545 u_int32_t low1 = low;
547 divl(high1, low1, div, &low, rem);
548 *n = (u_int64_t)high << 32 | low;
560 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
562 return substream->group != &substream->self_group;
565 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
567 read_lock(&snd_pcm_link_rwlock);
568 spin_lock(&substream->self_group.lock);
571 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
573 spin_unlock(&substream->self_group.lock);
574 read_unlock(&snd_pcm_link_rwlock);
577 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
579 read_lock_irq(&snd_pcm_link_rwlock);
580 spin_lock(&substream->self_group.lock);
583 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
585 spin_unlock(&substream->self_group.lock);
586 read_unlock_irq(&snd_pcm_link_rwlock);
589 #define snd_pcm_stream_lock_irqsave(substream, flags) \
591 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
592 spin_lock(&substream->self_group.lock); \
595 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
597 spin_unlock(&substream->self_group.lock); \
598 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
601 #define snd_pcm_group_for_each_entry(s, substream) \
602 list_for_each_entry(s, &substream->group->substreams, link_list)
604 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
606 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
607 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
608 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
611 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
613 return size * 8 / runtime->sample_bits;
616 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
618 return size * 8 / runtime->frame_bits;
621 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
623 return size * runtime->sample_bits / 8;
626 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
628 return size * runtime->frame_bits / 8;
631 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
633 return bytes % runtime->byte_align == 0;
636 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
638 struct snd_pcm_runtime *runtime = substream->runtime;
639 return frames_to_bytes(runtime, runtime->buffer_size);
642 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
644 struct snd_pcm_runtime *runtime = substream->runtime;
645 return frames_to_bytes(runtime, runtime->period_size);
649 * result is: 0 ... (boundary - 1)
651 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
653 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
655 avail += runtime->boundary;
656 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
657 avail -= runtime->boundary;
662 * result is: 0 ... (boundary - 1)
664 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
666 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
668 avail += runtime->boundary;
672 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
674 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
677 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
679 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
683 * snd_pcm_playback_ready - check whether the playback buffer is available
684 * @substream: the pcm substream instance
686 * Checks whether enough free space is available on the playback buffer.
688 * Returns non-zero if available, or zero if not.
690 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
692 struct snd_pcm_runtime *runtime = substream->runtime;
693 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
697 * snd_pcm_capture_ready - check whether the capture buffer is available
698 * @substream: the pcm substream instance
700 * Checks whether enough capture data is available on the capture buffer.
702 * Returns non-zero if available, or zero if not.
704 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
706 struct snd_pcm_runtime *runtime = substream->runtime;
707 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
711 * snd_pcm_playback_data - check whether any data exists on the playback buffer
712 * @substream: the pcm substream instance
714 * Checks whether any data exists on the playback buffer. If stop_threshold
715 * is bigger or equal to boundary, then this function returns always non-zero.
717 * Returns non-zero if exists, or zero if not.
719 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
721 struct snd_pcm_runtime *runtime = substream->runtime;
723 if (runtime->stop_threshold >= runtime->boundary)
725 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
729 * snd_pcm_playback_empty - check whether the playback buffer is empty
730 * @substream: the pcm substream instance
732 * Checks whether the playback buffer is empty.
734 * Returns non-zero if empty, or zero if not.
736 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
738 struct snd_pcm_runtime *runtime = substream->runtime;
739 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
743 * snd_pcm_capture_empty - check whether the capture buffer is empty
744 * @substream: the pcm substream instance
746 * Checks whether the capture buffer is empty.
748 * Returns non-zero if empty, or zero if not.
750 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
752 struct snd_pcm_runtime *runtime = substream->runtime;
753 return snd_pcm_capture_avail(runtime) == 0;
756 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
757 struct snd_pcm_substream *master)
759 substream->runtime->trigger_master = master;
762 static inline int hw_is_mask(int var)
764 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
765 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
768 static inline int hw_is_interval(int var)
770 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
771 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
774 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
775 snd_pcm_hw_param_t var)
777 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
780 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
781 snd_pcm_hw_param_t var)
783 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
786 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
787 snd_pcm_hw_param_t var)
789 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
792 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
793 snd_pcm_hw_param_t var)
795 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
798 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
799 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
800 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
801 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
802 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
803 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
804 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
805 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
806 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
807 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
810 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
811 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
812 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
813 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
814 unsigned int k, struct snd_interval *c);
815 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
816 const struct snd_interval *b, struct snd_interval *c);
817 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
818 int snd_interval_ratnum(struct snd_interval *i,
819 unsigned int rats_count, struct snd_ratnum *rats,
820 unsigned int *nump, unsigned int *denp);
822 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
823 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
824 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
826 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
828 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
829 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
831 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
833 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
835 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
836 unsigned int min, unsigned int max);
837 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
838 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
840 snd_pcm_hw_param_t var,
841 struct snd_pcm_hw_constraint_list *l);
842 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
844 snd_pcm_hw_param_t var,
845 struct snd_pcm_hw_constraint_ratnums *r);
846 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
848 snd_pcm_hw_param_t var,
849 struct snd_pcm_hw_constraint_ratdens *r);
850 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
853 unsigned int msbits);
854 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
856 snd_pcm_hw_param_t var,
858 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
860 snd_pcm_hw_param_t var);
861 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
864 snd_pcm_hw_rule_func_t func, void *private,
867 int snd_pcm_format_signed(snd_pcm_format_t format);
868 int snd_pcm_format_unsigned(snd_pcm_format_t format);
869 int snd_pcm_format_linear(snd_pcm_format_t format);
870 int snd_pcm_format_little_endian(snd_pcm_format_t format);
871 int snd_pcm_format_big_endian(snd_pcm_format_t format);
872 #if 0 /* just for DocBook */
874 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
875 * @format: the format to check
877 * Returns 1 if the given PCM format is CPU-endian, 0 if
878 * opposite, or a negative error code if endian not specified.
880 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
882 #ifdef SNDRV_LITTLE_ENDIAN
883 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
885 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
887 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
888 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
889 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
890 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
891 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
892 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
894 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
895 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
896 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
897 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
898 unsigned int cmd, void *arg);
899 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
900 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
901 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
902 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
903 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
904 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
905 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
906 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
907 const void __user *buf,
908 snd_pcm_uframes_t frames);
909 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
910 void __user *buf, snd_pcm_uframes_t frames);
911 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
912 void __user **bufs, snd_pcm_uframes_t frames);
913 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
914 void __user **bufs, snd_pcm_uframes_t frames);
916 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
918 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
919 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
921 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
922 struct snd_dma_buffer *bufp)
924 struct snd_pcm_runtime *runtime = substream->runtime;
926 runtime->dma_buffer_p = bufp;
927 runtime->dma_area = bufp->area;
928 runtime->dma_addr = bufp->addr;
929 runtime->dma_bytes = bufp->bytes;
931 runtime->dma_buffer_p = NULL;
932 runtime->dma_area = NULL;
933 runtime->dma_addr = 0;
934 runtime->dma_bytes = 0;
942 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
943 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
944 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
946 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
949 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
950 do_posix_clock_monotonic_gettime(tv);
959 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
960 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
961 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
962 int type, struct device *data,
963 size_t size, size_t max);
964 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
965 int type, void *data,
966 size_t size, size_t max);
967 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
968 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
970 #define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
971 #define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
972 #define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
973 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
975 /* handle mmap counter - PCM mmap callback should handle this counter properly */
976 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
978 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
979 atomic_inc(&substream->mmap_count);
982 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
984 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
985 atomic_dec(&substream->mmap_count);
988 /* mmap for io-memory area */
989 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
990 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
991 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
993 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
994 #define snd_pcm_lib_mmap_iomem NULL
997 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
999 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1006 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1007 (IEC958_AES1_CON_ORIGINAL<<8)|\
1008 (IEC958_AES1_CON_PCM_CODER<<8)|\
1009 (IEC958_AES3_CON_FS_48000<<24))
1011 #endif /* __SOUND_PCM_H */