Initial commit
[wrt350n-kernel.git] / include / sound / pcm.h
blob51d58ccda2d82d7158cbca22fb338bafa393c0e0
1 #ifndef __SOUND_PCM_H
2 #define __SOUND_PCM_H
4 /*
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>
29 #include <linux/mm.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)
36 #include "pcm_oss.h"
37 #endif
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;
61 struct snd_pcm_ops {
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_DEVICES 8
89 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
90 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
92 #define SNDRV_PCM_IOCTL1_RESET 0
93 #define SNDRV_PCM_IOCTL1_INFO 1
94 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
95 #define SNDRV_PCM_IOCTL1_GSTATE 3
97 #define SNDRV_PCM_TRIGGER_STOP 0
98 #define SNDRV_PCM_TRIGGER_START 1
99 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
100 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
101 #define SNDRV_PCM_TRIGGER_SUSPEND 5
102 #define SNDRV_PCM_TRIGGER_RESUME 6
104 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
106 /* If you change this don't forget to change rates[] table in pcm_native.c */
107 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
108 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
109 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
110 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
111 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
112 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
113 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
114 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
115 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
116 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
117 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
118 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
119 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
121 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
122 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
124 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
125 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
126 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
127 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
128 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
129 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
130 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
131 SNDRV_PCM_RATE_192000)
132 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
133 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
134 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
135 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
136 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
137 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
138 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
139 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
140 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
141 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
142 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
143 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
144 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
145 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
146 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
147 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
148 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
149 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
150 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
151 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
152 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
153 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
154 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
155 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
156 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
157 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
158 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
159 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
160 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
161 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
162 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
163 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
164 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
165 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
166 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
167 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
168 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
169 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
171 #ifdef SNDRV_LITTLE_ENDIAN
172 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
173 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
174 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
175 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
176 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
177 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
178 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
179 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
180 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
181 #endif
182 #ifdef SNDRV_BIG_ENDIAN
183 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
184 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
185 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
186 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
187 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
188 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
189 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
190 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
191 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
192 #endif
194 struct snd_pcm_file {
195 struct snd_pcm_substream *substream;
196 int no_compat_mmap;
199 struct snd_pcm_hw_rule;
200 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
201 struct snd_pcm_hw_rule *rule);
203 struct snd_pcm_hw_rule {
204 unsigned int cond;
205 snd_pcm_hw_rule_func_t func;
206 int var;
207 int deps[4];
208 void *private;
211 struct snd_pcm_hw_constraints {
212 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
213 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
214 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
215 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
216 unsigned int rules_num;
217 unsigned int rules_all;
218 struct snd_pcm_hw_rule *rules;
221 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
222 snd_pcm_hw_param_t var)
224 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
227 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
228 snd_pcm_hw_param_t var)
230 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
233 struct snd_ratnum {
234 unsigned int num;
235 unsigned int den_min, den_max, den_step;
238 struct snd_ratden {
239 unsigned int num_min, num_max, num_step;
240 unsigned int den;
243 struct snd_pcm_hw_constraint_ratnums {
244 int nrats;
245 struct snd_ratnum *rats;
248 struct snd_pcm_hw_constraint_ratdens {
249 int nrats;
250 struct snd_ratden *rats;
253 struct snd_pcm_hw_constraint_list {
254 unsigned int count;
255 unsigned int *list;
256 unsigned int mask;
259 struct snd_pcm_runtime {
260 /* -- Status -- */
261 struct snd_pcm_substream *trigger_master;
262 struct timespec trigger_tstamp; /* trigger timestamp */
263 int overrange;
264 snd_pcm_uframes_t avail_max;
265 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
266 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
268 /* -- HW params -- */
269 snd_pcm_access_t access; /* access mode */
270 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
271 snd_pcm_subformat_t subformat; /* subformat */
272 unsigned int rate; /* rate in Hz */
273 unsigned int channels; /* channels */
274 snd_pcm_uframes_t period_size; /* period size */
275 unsigned int periods; /* periods */
276 snd_pcm_uframes_t buffer_size; /* buffer size */
277 snd_pcm_uframes_t min_align; /* Min alignment for the format */
278 size_t byte_align;
279 unsigned int frame_bits;
280 unsigned int sample_bits;
281 unsigned int info;
282 unsigned int rate_num;
283 unsigned int rate_den;
285 /* -- SW params -- */
286 int tstamp_mode; /* mmap timestamp is updated */
287 unsigned int period_step;
288 snd_pcm_uframes_t start_threshold;
289 snd_pcm_uframes_t stop_threshold;
290 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
291 noise is nearest than this */
292 snd_pcm_uframes_t silence_size; /* Silence filling size */
293 snd_pcm_uframes_t boundary; /* pointers wrap point */
295 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
296 snd_pcm_uframes_t silence_filled; /* size filled with silence */
298 union snd_pcm_sync_id sync; /* hardware synchronization ID */
300 /* -- mmap -- */
301 struct snd_pcm_mmap_status *status;
302 struct snd_pcm_mmap_control *control;
304 /* -- locking / scheduling -- */
305 wait_queue_head_t sleep;
306 struct fasync_struct *fasync;
308 /* -- private section -- */
309 void *private_data;
310 void (*private_free)(struct snd_pcm_runtime *runtime);
312 /* -- hardware description -- */
313 struct snd_pcm_hardware hw;
314 struct snd_pcm_hw_constraints hw_constraints;
316 /* -- interrupt callbacks -- */
317 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
318 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
320 /* -- timer -- */
321 unsigned int timer_resolution; /* timer resolution */
322 int tstamp_type; /* timestamp type */
324 /* -- DMA -- */
325 unsigned char *dma_area; /* DMA area */
326 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
327 size_t dma_bytes; /* size of DMA area */
329 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
331 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
332 /* -- OSS things -- */
333 struct snd_pcm_oss_runtime oss;
334 #endif
337 struct snd_pcm_group { /* keep linked substreams */
338 spinlock_t lock;
339 struct list_head substreams;
340 int count;
343 struct snd_pcm_substream {
344 struct snd_pcm *pcm;
345 struct snd_pcm_str *pstr;
346 void *private_data; /* copied from pcm->private_data */
347 int number;
348 char name[32]; /* substream name */
349 int stream; /* stream (direction) */
350 char latency_id[20]; /* latency identifier */
351 size_t buffer_bytes_max; /* limit ring buffer size */
352 struct snd_dma_buffer dma_buffer;
353 unsigned int dma_buf_id;
354 size_t dma_max;
355 /* -- hardware operations -- */
356 struct snd_pcm_ops *ops;
357 /* -- runtime information -- */
358 struct snd_pcm_runtime *runtime;
359 /* -- timer section -- */
360 struct snd_timer *timer; /* timer */
361 unsigned timer_running: 1; /* time is running */
362 spinlock_t timer_lock;
363 /* -- next substream -- */
364 struct snd_pcm_substream *next;
365 /* -- linked substreams -- */
366 struct list_head link_list; /* linked list member */
367 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
368 struct snd_pcm_group *group; /* pointer to current group */
369 /* -- assigned files -- */
370 void *file;
371 int ref_count;
372 atomic_t mmap_count;
373 unsigned int f_flags;
374 void (*pcm_release)(struct snd_pcm_substream *);
375 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
376 /* -- OSS things -- */
377 struct snd_pcm_oss_substream oss;
378 #endif
379 #ifdef CONFIG_SND_VERBOSE_PROCFS
380 struct snd_info_entry *proc_root;
381 struct snd_info_entry *proc_info_entry;
382 struct snd_info_entry *proc_hw_params_entry;
383 struct snd_info_entry *proc_sw_params_entry;
384 struct snd_info_entry *proc_status_entry;
385 struct snd_info_entry *proc_prealloc_entry;
386 struct snd_info_entry *proc_prealloc_max_entry;
387 #endif
388 /* misc flags */
389 unsigned int hw_opened: 1;
392 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
395 struct snd_pcm_str {
396 int stream; /* stream (direction) */
397 struct snd_pcm *pcm;
398 /* -- substreams -- */
399 unsigned int substream_count;
400 unsigned int substream_opened;
401 struct snd_pcm_substream *substream;
402 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
403 /* -- OSS things -- */
404 struct snd_pcm_oss_stream oss;
405 #endif
406 #ifdef CONFIG_SND_VERBOSE_PROCFS
407 struct snd_info_entry *proc_root;
408 struct snd_info_entry *proc_info_entry;
409 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
410 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
411 struct snd_info_entry *proc_xrun_debug_entry;
412 #endif
413 #endif
416 struct snd_pcm {
417 struct snd_card *card;
418 struct list_head list;
419 unsigned int device; /* device number */
420 unsigned int info_flags;
421 unsigned short dev_class;
422 unsigned short dev_subclass;
423 char id[64];
424 char name[80];
425 struct snd_pcm_str streams[2];
426 struct mutex open_mutex;
427 wait_queue_head_t open_wait;
428 void *private_data;
429 void (*private_free) (struct snd_pcm *pcm);
430 struct device *dev; /* actual hw device this belongs to */
431 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
432 struct snd_pcm_oss oss;
433 #endif
436 struct snd_pcm_notify {
437 int (*n_register) (struct snd_pcm * pcm);
438 int (*n_disconnect) (struct snd_pcm * pcm);
439 int (*n_unregister) (struct snd_pcm * pcm);
440 struct list_head list;
444 * Registering
447 extern const struct file_operations snd_pcm_f_ops[2];
449 int snd_pcm_new(struct snd_card *card, char *id, int device,
450 int playback_count, int capture_count,
451 struct snd_pcm **rpcm);
452 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
454 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
457 * Native I/O
460 extern rwlock_t snd_pcm_link_rwlock;
462 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
463 int snd_pcm_info_user(struct snd_pcm_substream *substream,
464 struct snd_pcm_info __user *info);
465 int snd_pcm_status(struct snd_pcm_substream *substream,
466 struct snd_pcm_status *status);
467 int snd_pcm_start(struct snd_pcm_substream *substream);
468 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
469 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
470 #ifdef CONFIG_PM
471 int snd_pcm_suspend(struct snd_pcm_substream *substream);
472 int snd_pcm_suspend_all(struct snd_pcm *pcm);
473 #endif
474 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
475 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
476 struct snd_pcm_substream **rsubstream);
477 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
478 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
479 struct snd_pcm_substream **rsubstream);
480 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
481 void snd_pcm_vma_notify_data(void *client, void *data);
482 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
484 #if BITS_PER_LONG >= 64
486 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
488 *rem = *n % div;
489 *n /= div;
492 #elif defined(i386)
494 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
496 u_int32_t low, high;
497 low = *n & 0xffffffff;
498 high = *n >> 32;
499 if (high) {
500 u_int32_t high1 = high % div;
501 high /= div;
502 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
503 *n = (u_int64_t)high << 32 | low;
504 } else {
505 *n = low / div;
506 *rem = low % div;
509 #else
511 static inline void divl(u_int32_t high, u_int32_t low,
512 u_int32_t div,
513 u_int32_t *q, u_int32_t *r)
515 u_int64_t n = (u_int64_t)high << 32 | low;
516 u_int64_t d = (u_int64_t)div << 31;
517 u_int32_t q1 = 0;
518 int c = 32;
519 while (n > 0xffffffffU) {
520 q1 <<= 1;
521 if (n >= d) {
522 n -= d;
523 q1 |= 1;
525 d >>= 1;
526 c--;
528 q1 <<= c;
529 if (n) {
530 low = n;
531 *q = q1 | (low / div);
532 *r = low % div;
533 } else {
534 *r = 0;
535 *q = q1;
537 return;
540 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
542 u_int32_t low, high;
543 low = *n & 0xffffffff;
544 high = *n >> 32;
545 if (high) {
546 u_int32_t high1 = high % div;
547 u_int32_t low1 = low;
548 high /= div;
549 divl(high1, low1, div, &low, rem);
550 *n = (u_int64_t)high << 32 | low;
551 } else {
552 *n = low / div;
553 *rem = low % div;
556 #endif
559 * PCM library
562 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
564 return substream->group != &substream->self_group;
567 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
569 read_lock(&snd_pcm_link_rwlock);
570 spin_lock(&substream->self_group.lock);
573 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
575 spin_unlock(&substream->self_group.lock);
576 read_unlock(&snd_pcm_link_rwlock);
579 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
581 read_lock_irq(&snd_pcm_link_rwlock);
582 spin_lock(&substream->self_group.lock);
585 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
587 spin_unlock(&substream->self_group.lock);
588 read_unlock_irq(&snd_pcm_link_rwlock);
591 #define snd_pcm_stream_lock_irqsave(substream, flags) \
592 do { \
593 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
594 spin_lock(&substream->self_group.lock); \
595 } while (0)
597 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
598 do { \
599 spin_unlock(&substream->self_group.lock); \
600 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
601 } while (0)
603 #define snd_pcm_group_for_each_entry(s, substream) \
604 list_for_each_entry(s, &substream->group->substreams, link_list)
606 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
608 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
609 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
610 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
613 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
615 return size * 8 / runtime->sample_bits;
618 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
620 return size * 8 / runtime->frame_bits;
623 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
625 return size * runtime->sample_bits / 8;
628 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
630 return size * runtime->frame_bits / 8;
633 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
635 return bytes % runtime->byte_align == 0;
638 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
640 struct snd_pcm_runtime *runtime = substream->runtime;
641 return frames_to_bytes(runtime, runtime->buffer_size);
644 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
646 struct snd_pcm_runtime *runtime = substream->runtime;
647 return frames_to_bytes(runtime, runtime->period_size);
651 * result is: 0 ... (boundary - 1)
653 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
655 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
656 if (avail < 0)
657 avail += runtime->boundary;
658 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
659 avail -= runtime->boundary;
660 return avail;
664 * result is: 0 ... (boundary - 1)
666 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
668 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
669 if (avail < 0)
670 avail += runtime->boundary;
671 return avail;
674 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
676 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
679 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
681 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
685 * snd_pcm_playback_ready - check whether the playback buffer is available
686 * @substream: the pcm substream instance
688 * Checks whether enough free space is available on the playback buffer.
690 * Returns non-zero if available, or zero if not.
692 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
694 struct snd_pcm_runtime *runtime = substream->runtime;
695 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
699 * snd_pcm_capture_ready - check whether the capture buffer is available
700 * @substream: the pcm substream instance
702 * Checks whether enough capture data is available on the capture buffer.
704 * Returns non-zero if available, or zero if not.
706 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
708 struct snd_pcm_runtime *runtime = substream->runtime;
709 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
713 * snd_pcm_playback_data - check whether any data exists on the playback buffer
714 * @substream: the pcm substream instance
716 * Checks whether any data exists on the playback buffer. If stop_threshold
717 * is bigger or equal to boundary, then this function returns always non-zero.
719 * Returns non-zero if exists, or zero if not.
721 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
723 struct snd_pcm_runtime *runtime = substream->runtime;
725 if (runtime->stop_threshold >= runtime->boundary)
726 return 1;
727 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
731 * snd_pcm_playback_empty - check whether the playback buffer is empty
732 * @substream: the pcm substream instance
734 * Checks whether the playback buffer is empty.
736 * Returns non-zero if empty, or zero if not.
738 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
740 struct snd_pcm_runtime *runtime = substream->runtime;
741 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
745 * snd_pcm_capture_empty - check whether the capture buffer is empty
746 * @substream: the pcm substream instance
748 * Checks whether the capture buffer is empty.
750 * Returns non-zero if empty, or zero if not.
752 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
754 struct snd_pcm_runtime *runtime = substream->runtime;
755 return snd_pcm_capture_avail(runtime) == 0;
758 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
759 struct snd_pcm_substream *master)
761 substream->runtime->trigger_master = master;
764 static inline int hw_is_mask(int var)
766 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
767 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
770 static inline int hw_is_interval(int var)
772 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
773 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
776 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
777 snd_pcm_hw_param_t var)
779 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
782 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
783 snd_pcm_hw_param_t var)
785 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
788 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
789 snd_pcm_hw_param_t var)
791 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
794 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
795 snd_pcm_hw_param_t var)
797 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
800 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
801 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
802 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
803 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
804 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
805 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
806 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
807 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
808 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
809 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
812 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
813 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
814 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
815 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
816 unsigned int k, struct snd_interval *c);
817 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
818 const struct snd_interval *b, struct snd_interval *c);
819 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
820 int snd_interval_ratnum(struct snd_interval *i,
821 unsigned int rats_count, struct snd_ratnum *rats,
822 unsigned int *nump, unsigned int *denp);
824 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
825 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
826 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
828 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
830 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
831 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
833 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
834 u_int32_t mask);
835 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
836 u_int64_t mask);
837 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
838 unsigned int min, unsigned int max);
839 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
840 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
841 unsigned int cond,
842 snd_pcm_hw_param_t var,
843 struct snd_pcm_hw_constraint_list *l);
844 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
845 unsigned int cond,
846 snd_pcm_hw_param_t var,
847 struct snd_pcm_hw_constraint_ratnums *r);
848 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
849 unsigned int cond,
850 snd_pcm_hw_param_t var,
851 struct snd_pcm_hw_constraint_ratdens *r);
852 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
853 unsigned int cond,
854 unsigned int width,
855 unsigned int msbits);
856 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
857 unsigned int cond,
858 snd_pcm_hw_param_t var,
859 unsigned long step);
860 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
861 unsigned int cond,
862 snd_pcm_hw_param_t var);
863 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
864 unsigned int cond,
865 int var,
866 snd_pcm_hw_rule_func_t func, void *private,
867 int dep, ...);
869 int snd_pcm_format_signed(snd_pcm_format_t format);
870 int snd_pcm_format_unsigned(snd_pcm_format_t format);
871 int snd_pcm_format_linear(snd_pcm_format_t format);
872 int snd_pcm_format_little_endian(snd_pcm_format_t format);
873 int snd_pcm_format_big_endian(snd_pcm_format_t format);
874 #if 0 /* just for DocBook */
876 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
877 * @format: the format to check
879 * Returns 1 if the given PCM format is CPU-endian, 0 if
880 * opposite, or a negative error code if endian not specified.
882 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
883 #endif /* DocBook */
884 #ifdef SNDRV_LITTLE_ENDIAN
885 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
886 #else
887 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
888 #endif
889 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
890 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
891 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
892 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
893 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
894 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
896 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
897 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
898 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
899 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
900 unsigned int cmd, void *arg);
901 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
902 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
903 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
904 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
905 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
906 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
907 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
908 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
909 const void __user *buf,
910 snd_pcm_uframes_t frames);
911 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
912 void __user *buf, snd_pcm_uframes_t frames);
913 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
914 void __user **bufs, snd_pcm_uframes_t frames);
915 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
916 void __user **bufs, snd_pcm_uframes_t frames);
918 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
920 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
921 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
923 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
924 struct snd_dma_buffer *bufp)
926 struct snd_pcm_runtime *runtime = substream->runtime;
927 if (bufp) {
928 runtime->dma_buffer_p = bufp;
929 runtime->dma_area = bufp->area;
930 runtime->dma_addr = bufp->addr;
931 runtime->dma_bytes = bufp->bytes;
932 } else {
933 runtime->dma_buffer_p = NULL;
934 runtime->dma_area = NULL;
935 runtime->dma_addr = 0;
936 runtime->dma_bytes = 0;
941 * Timer interface
944 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
945 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
946 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
948 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
949 struct timespec *tv)
951 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
952 do_posix_clock_monotonic_gettime(tv);
953 else
954 getnstimeofday(tv);
958 * Memory
961 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
962 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
963 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
964 int type, struct device *data,
965 size_t size, size_t max);
966 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
967 int type, void *data,
968 size_t size, size_t max);
969 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
970 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
972 #define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
973 #define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
974 #define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
975 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream, unsigned long offset);
977 /* handle mmap counter - PCM mmap callback should handle this counter properly */
978 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
980 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
981 atomic_inc(&substream->mmap_count);
984 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
986 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
987 atomic_dec(&substream->mmap_count);
990 /* mmap for io-memory area */
991 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
992 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
993 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
994 #else
995 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
996 #define snd_pcm_lib_mmap_iomem NULL
997 #endif
999 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1001 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1005 * Misc
1008 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
1009 (IEC958_AES1_CON_ORIGINAL<<8)|\
1010 (IEC958_AES1_CON_PCM_CODER<<8)|\
1011 (IEC958_AES3_CON_FS_48000<<24))
1013 #endif /* __SOUND_PCM_H */