5 * Digital Audio (PCM) abstract layer
6 * Copyright (c) by Jaroslav Kysela <perex@suse.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 */
60 int (*open)(struct snd_pcm_substream *substream);
61 int (*close)(struct snd_pcm_substream *substream);
62 int (*ioctl)(struct snd_pcm_substream * substream,
63 unsigned int cmd, void *arg);
64 int (*hw_params)(struct snd_pcm_substream *substream,
65 struct snd_pcm_hw_params *params);
66 int (*hw_free)(struct snd_pcm_substream *substream);
67 int (*prepare)(struct snd_pcm_substream *substream);
68 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
69 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
70 int (*copy)(struct snd_pcm_substream *substream, int channel,
71 snd_pcm_uframes_t pos,
72 void __user *buf, snd_pcm_uframes_t count);
73 int (*silence)(struct snd_pcm_substream *substream, int channel,
74 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
75 struct page *(*page)(struct snd_pcm_substream *substream,
76 unsigned long offset);
77 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
78 int (*ack)(struct snd_pcm_substream *substream);
85 #define SNDRV_PCM_DEVICES 8
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 unsigned int tick_time; /* tick time */
276 snd_pcm_uframes_t min_align; /* Min alignment for the format */
278 unsigned int frame_bits;
279 unsigned int sample_bits;
281 unsigned int rate_num;
282 unsigned int rate_den;
284 /* -- SW params -- */
285 int tstamp_mode; /* mmap timestamp is updated */
286 unsigned int period_step;
287 unsigned int sleep_min; /* min ticks to sleep */
288 snd_pcm_uframes_t xfer_align; /* xfer size need to be a multiple */
289 snd_pcm_uframes_t start_threshold;
290 snd_pcm_uframes_t stop_threshold;
291 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
292 noise is nearest than this */
293 snd_pcm_uframes_t silence_size; /* Silence filling size */
294 snd_pcm_uframes_t boundary; /* pointers wrap point */
296 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
297 snd_pcm_uframes_t silence_filled; /* size filled with silence */
299 union snd_pcm_sync_id sync; /* hardware synchronization ID */
302 volatile struct snd_pcm_mmap_status *status;
303 volatile struct snd_pcm_mmap_control *control;
305 /* -- locking / scheduling -- */
306 wait_queue_head_t sleep;
307 struct timer_list tick_timer;
308 struct fasync_struct *fasync;
310 /* -- private section -- */
312 void (*private_free)(struct snd_pcm_runtime *runtime);
314 /* -- hardware description -- */
315 struct snd_pcm_hardware hw;
316 struct snd_pcm_hw_constraints hw_constraints;
318 /* -- interrupt callbacks -- */
319 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
320 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
323 unsigned int timer_resolution; /* timer resolution */
326 unsigned char *dma_area; /* DMA area */
327 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
328 size_t dma_bytes; /* size of DMA area */
330 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
332 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
333 /* -- OSS things -- */
334 struct snd_pcm_oss_runtime oss;
338 struct snd_pcm_group { /* keep linked substreams */
340 struct list_head substreams;
344 struct snd_pcm_substream {
346 struct snd_pcm_str *pstr;
347 void *private_data; /* copied from pcm->private_data */
349 char name[32]; /* substream name */
350 int stream; /* stream (direction) */
351 char latency_id[20]; /* latency identifier */
352 size_t buffer_bytes_max; /* limit ring buffer size */
353 struct snd_dma_buffer dma_buffer;
354 unsigned int dma_buf_id;
356 /* -- hardware operations -- */
357 struct snd_pcm_ops *ops;
358 /* -- runtime information -- */
359 struct snd_pcm_runtime *runtime;
360 /* -- timer section -- */
361 struct snd_timer *timer; /* timer */
362 unsigned timer_running: 1; /* time is running */
363 spinlock_t timer_lock;
364 /* -- next substream -- */
365 struct snd_pcm_substream *next;
366 /* -- linked substreams -- */
367 struct list_head link_list; /* linked list member */
368 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
369 struct snd_pcm_group *group; /* pointer to current group */
370 /* -- assigned files -- */
374 unsigned int f_flags;
375 void (*pcm_release)(struct snd_pcm_substream *);
376 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
377 /* -- OSS things -- */
378 struct snd_pcm_oss_substream oss;
380 #ifdef CONFIG_SND_VERBOSE_PROCFS
381 struct snd_info_entry *proc_root;
382 struct snd_info_entry *proc_info_entry;
383 struct snd_info_entry *proc_hw_params_entry;
384 struct snd_info_entry *proc_sw_params_entry;
385 struct snd_info_entry *proc_status_entry;
386 struct snd_info_entry *proc_prealloc_entry;
387 struct snd_info_entry *proc_prealloc_max_entry;
390 unsigned int hw_opened: 1;
393 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
397 int stream; /* stream (direction) */
399 /* -- substreams -- */
400 unsigned int substream_count;
401 unsigned int substream_opened;
402 struct snd_pcm_substream *substream;
403 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
404 /* -- OSS things -- */
405 struct snd_pcm_oss_stream oss;
407 #ifdef CONFIG_SND_VERBOSE_PROCFS
408 struct snd_info_entry *proc_root;
409 struct snd_info_entry *proc_info_entry;
410 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
411 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
412 struct snd_info_entry *proc_xrun_debug_entry;
418 struct snd_card *card;
419 struct list_head list;
420 unsigned int device; /* device number */
421 unsigned int info_flags;
422 unsigned short dev_class;
423 unsigned short dev_subclass;
426 struct snd_pcm_str streams[2];
427 struct mutex open_mutex;
428 wait_queue_head_t open_wait;
430 void (*private_free) (struct snd_pcm *pcm);
431 struct device *dev; /* actual hw device this belongs to */
432 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
433 struct snd_pcm_oss oss;
437 struct snd_pcm_notify {
438 int (*n_register) (struct snd_pcm * pcm);
439 int (*n_disconnect) (struct snd_pcm * pcm);
440 int (*n_unregister) (struct snd_pcm * pcm);
441 struct list_head list;
448 extern struct file_operations snd_pcm_f_ops[2];
450 int snd_pcm_new(struct snd_card *card, char *id, int device,
451 int playback_count, int capture_count,
452 struct snd_pcm **rpcm);
453 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
455 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
461 extern rwlock_t snd_pcm_link_rwlock;
463 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
464 int snd_pcm_info_user(struct snd_pcm_substream *substream,
465 struct snd_pcm_info __user *info);
466 int snd_pcm_status(struct snd_pcm_substream *substream,
467 struct snd_pcm_status *status);
468 int snd_pcm_start(struct snd_pcm_substream *substream);
469 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
470 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
472 int snd_pcm_suspend(struct snd_pcm_substream *substream);
473 int snd_pcm_suspend_all(struct snd_pcm *pcm);
475 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
476 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
477 struct snd_pcm_substream **rsubstream);
478 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
479 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
480 struct snd_pcm_substream **rsubstream);
481 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
482 void snd_pcm_vma_notify_data(void *client, void *data);
483 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
485 #if BITS_PER_LONG >= 64
487 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
495 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
498 low = *n & 0xffffffff;
501 u_int32_t high1 = high % div;
503 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
504 *n = (u_int64_t)high << 32 | low;
512 static inline void divl(u_int32_t high, u_int32_t low,
514 u_int32_t *q, u_int32_t *r)
516 u_int64_t n = (u_int64_t)high << 32 | low;
517 u_int64_t d = (u_int64_t)div << 31;
520 while (n > 0xffffffffU) {
532 *q = q1 | (low / div);
541 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
544 low = *n & 0xffffffff;
547 u_int32_t high1 = high % div;
548 u_int32_t low1 = low;
550 divl(high1, low1, div, &low, rem);
551 *n = (u_int64_t)high << 32 | low;
563 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
565 return substream->group != &substream->self_group;
568 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
570 read_lock(&snd_pcm_link_rwlock);
571 spin_lock(&substream->self_group.lock);
574 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
576 spin_unlock(&substream->self_group.lock);
577 read_unlock(&snd_pcm_link_rwlock);
580 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
582 read_lock_irq(&snd_pcm_link_rwlock);
583 spin_lock(&substream->self_group.lock);
586 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
588 spin_unlock(&substream->self_group.lock);
589 read_unlock_irq(&snd_pcm_link_rwlock);
592 #define snd_pcm_stream_lock_irqsave(substream, flags) \
594 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
595 spin_lock(&substream->self_group.lock); \
598 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
600 spin_unlock(&substream->self_group.lock); \
601 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
604 #define snd_pcm_group_for_each(pos, substream) \
605 list_for_each(pos, &substream->group->substreams)
607 #define snd_pcm_group_substream_entry(pos) \
608 list_entry(pos, struct snd_pcm_substream, link_list)
610 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
612 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
613 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
614 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
617 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
619 return size * 8 / runtime->sample_bits;
622 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
624 return size * 8 / runtime->frame_bits;
627 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
629 return size * runtime->sample_bits / 8;
632 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
634 return size * runtime->frame_bits / 8;
637 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
639 return bytes % runtime->byte_align == 0;
642 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
644 struct snd_pcm_runtime *runtime = substream->runtime;
645 return frames_to_bytes(runtime, runtime->buffer_size);
648 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
650 struct snd_pcm_runtime *runtime = substream->runtime;
651 return frames_to_bytes(runtime, runtime->period_size);
655 * result is: 0 ... (boundary - 1)
657 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
659 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
661 avail += runtime->boundary;
662 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
663 avail -= runtime->boundary;
668 * result is: 0 ... (boundary - 1)
670 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
672 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
674 avail += runtime->boundary;
678 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
680 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
683 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
685 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
689 * snd_pcm_playback_ready - check whether the playback buffer is available
690 * @substream: the pcm substream instance
692 * Checks whether enough free space is available on the playback buffer.
694 * Returns non-zero if available, or zero if not.
696 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
698 struct snd_pcm_runtime *runtime = substream->runtime;
699 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
703 * snd_pcm_capture_ready - check whether the capture buffer is available
704 * @substream: the pcm substream instance
706 * Checks whether enough capture data is available on the capture buffer.
708 * Returns non-zero if available, or zero if not.
710 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
712 struct snd_pcm_runtime *runtime = substream->runtime;
713 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
717 * snd_pcm_playback_data - check whether any data exists on the playback buffer
718 * @substream: the pcm substream instance
720 * Checks whether any data exists on the playback buffer. If stop_threshold
721 * is bigger or equal to boundary, then this function returns always non-zero.
723 * Returns non-zero if exists, or zero if not.
725 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
727 struct snd_pcm_runtime *runtime = substream->runtime;
729 if (runtime->stop_threshold >= runtime->boundary)
731 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
735 * snd_pcm_playback_empty - check whether the playback buffer is empty
736 * @substream: the pcm substream instance
738 * Checks whether the playback buffer is empty.
740 * Returns non-zero if empty, or zero if not.
742 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
744 struct snd_pcm_runtime *runtime = substream->runtime;
745 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
749 * snd_pcm_capture_empty - check whether the capture buffer is empty
750 * @substream: the pcm substream instance
752 * Checks whether the capture buffer is empty.
754 * Returns non-zero if empty, or zero if not.
756 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
758 struct snd_pcm_runtime *runtime = substream->runtime;
759 return snd_pcm_capture_avail(runtime) == 0;
762 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
763 struct snd_pcm_substream *master)
765 substream->runtime->trigger_master = master;
768 static inline int hw_is_mask(int var)
770 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
771 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
774 static inline int hw_is_interval(int var)
776 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
777 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
780 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
781 snd_pcm_hw_param_t var)
783 return ¶ms->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
786 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
787 snd_pcm_hw_param_t var)
789 return ¶ms->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
792 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
793 snd_pcm_hw_param_t var)
795 return (const struct snd_mask *)hw_param_mask((struct snd_pcm_hw_params*) params, var);
798 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
799 snd_pcm_hw_param_t var)
801 return (const struct snd_interval *)hw_param_interval((struct snd_pcm_hw_params*) params, var);
804 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
805 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
806 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
807 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
808 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
809 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
810 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
811 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
812 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
813 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
814 #define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
817 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
818 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
819 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
820 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
821 unsigned int k, struct snd_interval *c);
822 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
823 const struct snd_interval *b, struct snd_interval *c);
824 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
825 int snd_interval_ratnum(struct snd_interval *i,
826 unsigned int rats_count, struct snd_ratnum *rats,
827 unsigned int *nump, unsigned int *denp);
829 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
830 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
831 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
833 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
835 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
836 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
838 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
840 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
842 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
843 unsigned int min, unsigned int max);
844 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
845 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
847 snd_pcm_hw_param_t var,
848 struct snd_pcm_hw_constraint_list *l);
849 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
851 snd_pcm_hw_param_t var,
852 struct snd_pcm_hw_constraint_ratnums *r);
853 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
855 snd_pcm_hw_param_t var,
856 struct snd_pcm_hw_constraint_ratdens *r);
857 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
860 unsigned int msbits);
861 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
863 snd_pcm_hw_param_t var,
865 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
867 snd_pcm_hw_param_t var);
868 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
871 snd_pcm_hw_rule_func_t func, void *private,
874 int snd_pcm_format_signed(snd_pcm_format_t format);
875 int snd_pcm_format_unsigned(snd_pcm_format_t format);
876 int snd_pcm_format_linear(snd_pcm_format_t format);
877 int snd_pcm_format_little_endian(snd_pcm_format_t format);
878 int snd_pcm_format_big_endian(snd_pcm_format_t format);
879 #if 0 /* just for DocBook */
881 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
882 * @format: the format to check
884 * Returns 1 if the given PCM format is CPU-endian, 0 if
885 * opposite, or a negative error code if endian not specified.
887 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
889 #ifdef SNDRV_LITTLE_ENDIAN
890 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
892 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
894 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
895 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
896 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
897 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
898 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
899 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
901 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
902 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
903 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
904 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
905 unsigned int cmd, void *arg);
906 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
907 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
908 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
909 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
910 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
911 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
912 void snd_pcm_tick_prepare(struct snd_pcm_substream *substream);
913 void snd_pcm_tick_set(struct snd_pcm_substream *substream, unsigned long ticks);
914 void snd_pcm_tick_elapsed(struct snd_pcm_substream *substream);
915 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
916 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
917 const void __user *buf,
918 snd_pcm_uframes_t frames);
919 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
920 void __user *buf, snd_pcm_uframes_t frames);
921 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
922 void __user **bufs, snd_pcm_uframes_t frames);
923 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
924 void __user **bufs, snd_pcm_uframes_t frames);
926 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
928 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
929 struct snd_dma_buffer *bufp)
931 struct snd_pcm_runtime *runtime = substream->runtime;
933 runtime->dma_buffer_p = bufp;
934 runtime->dma_area = bufp->area;
935 runtime->dma_addr = bufp->addr;
936 runtime->dma_bytes = bufp->bytes;
938 runtime->dma_buffer_p = NULL;
939 runtime->dma_area = NULL;
940 runtime->dma_addr = 0;
941 runtime->dma_bytes = 0;
949 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
950 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
951 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
957 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
958 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
959 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
960 int type, struct device *data,
961 size_t size, size_t max);
962 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
963 int type, void *data,
964 size_t size, size_t max);
965 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
966 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
968 #define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
969 #define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
970 #define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
971 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
973 /* handle mmap counter - PCM mmap callback should handle this counter properly */
974 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
976 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
977 atomic_inc(&substream->mmap_count);
980 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
982 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
983 atomic_dec(&substream->mmap_count);
986 /* mmap for io-memory area */
987 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
988 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
989 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
991 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
992 #define snd_pcm_lib_mmap_iomem NULL
995 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
997 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1004 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1005 (IEC958_AES1_CON_ORIGINAL<<8)|\
1006 (IEC958_AES1_CON_PCM_CODER<<8)|\
1007 (IEC958_AES3_CON_FS_48000<<24))
1009 #endif /* __SOUND_PCM_H */