pagemap: document KPF_KSM and show it in page-types
[linux-2.6/mini2440.git] / include / sound / pcm.h
blobde6d981de5d60170e522815482be939343c05f33
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 <sound/minors.h>
29 #include <linux/poll.h>
30 #include <linux/mm.h>
31 #include <linux/bitops.h>
33 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
34 #define snd_pcm_chip(pcm) ((pcm)->private_data)
36 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
37 #include "pcm_oss.h"
38 #endif
41 * Hardware (lowlevel) section
44 struct snd_pcm_hardware {
45 unsigned int info; /* SNDRV_PCM_INFO_* */
46 u64 formats; /* SNDRV_PCM_FMTBIT_* */
47 unsigned int rates; /* SNDRV_PCM_RATE_* */
48 unsigned int rate_min; /* min rate */
49 unsigned int rate_max; /* max rate */
50 unsigned int channels_min; /* min channels */
51 unsigned int channels_max; /* max channels */
52 size_t buffer_bytes_max; /* max buffer size */
53 size_t period_bytes_min; /* min period size */
54 size_t period_bytes_max; /* max period size */
55 unsigned int periods_min; /* min # of periods */
56 unsigned int periods_max; /* max # of periods */
57 size_t fifo_size; /* fifo size in bytes */
60 struct snd_pcm_substream;
62 struct snd_pcm_ops {
63 int (*open)(struct snd_pcm_substream *substream);
64 int (*close)(struct snd_pcm_substream *substream);
65 int (*ioctl)(struct snd_pcm_substream * substream,
66 unsigned int cmd, void *arg);
67 int (*hw_params)(struct snd_pcm_substream *substream,
68 struct snd_pcm_hw_params *params);
69 int (*hw_free)(struct snd_pcm_substream *substream);
70 int (*prepare)(struct snd_pcm_substream *substream);
71 int (*trigger)(struct snd_pcm_substream *substream, int cmd);
72 snd_pcm_uframes_t (*pointer)(struct snd_pcm_substream *substream);
73 int (*copy)(struct snd_pcm_substream *substream, int channel,
74 snd_pcm_uframes_t pos,
75 void __user *buf, snd_pcm_uframes_t count);
76 int (*silence)(struct snd_pcm_substream *substream, int channel,
77 snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
78 struct page *(*page)(struct snd_pcm_substream *substream,
79 unsigned long offset);
80 int (*mmap)(struct snd_pcm_substream *substream, struct vm_area_struct *vma);
81 int (*ack)(struct snd_pcm_substream *substream);
88 #if defined(CONFIG_SND_DYNAMIC_MINORS)
89 #define SNDRV_PCM_DEVICES (SNDRV_OS_MINORS-2)
90 #else
91 #define SNDRV_PCM_DEVICES 8
92 #endif
94 #define SNDRV_PCM_IOCTL1_FALSE ((void *)0)
95 #define SNDRV_PCM_IOCTL1_TRUE ((void *)1)
97 #define SNDRV_PCM_IOCTL1_RESET 0
98 #define SNDRV_PCM_IOCTL1_INFO 1
99 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO 2
100 #define SNDRV_PCM_IOCTL1_GSTATE 3
101 #define SNDRV_PCM_IOCTL1_FIFO_SIZE 4
103 #define SNDRV_PCM_TRIGGER_STOP 0
104 #define SNDRV_PCM_TRIGGER_START 1
105 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH 3
106 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
107 #define SNDRV_PCM_TRIGGER_SUSPEND 5
108 #define SNDRV_PCM_TRIGGER_RESUME 6
110 #define SNDRV_PCM_POS_XRUN ((snd_pcm_uframes_t)-1)
112 /* If you change this don't forget to change rates[] table in pcm_native.c */
113 #define SNDRV_PCM_RATE_5512 (1<<0) /* 5512Hz */
114 #define SNDRV_PCM_RATE_8000 (1<<1) /* 8000Hz */
115 #define SNDRV_PCM_RATE_11025 (1<<2) /* 11025Hz */
116 #define SNDRV_PCM_RATE_16000 (1<<3) /* 16000Hz */
117 #define SNDRV_PCM_RATE_22050 (1<<4) /* 22050Hz */
118 #define SNDRV_PCM_RATE_32000 (1<<5) /* 32000Hz */
119 #define SNDRV_PCM_RATE_44100 (1<<6) /* 44100Hz */
120 #define SNDRV_PCM_RATE_48000 (1<<7) /* 48000Hz */
121 #define SNDRV_PCM_RATE_64000 (1<<8) /* 64000Hz */
122 #define SNDRV_PCM_RATE_88200 (1<<9) /* 88200Hz */
123 #define SNDRV_PCM_RATE_96000 (1<<10) /* 96000Hz */
124 #define SNDRV_PCM_RATE_176400 (1<<11) /* 176400Hz */
125 #define SNDRV_PCM_RATE_192000 (1<<12) /* 192000Hz */
127 #define SNDRV_PCM_RATE_CONTINUOUS (1<<30) /* continuous range */
128 #define SNDRV_PCM_RATE_KNOT (1<<31) /* supports more non-continuos rates */
130 #define SNDRV_PCM_RATE_8000_44100 (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
131 SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
132 SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
133 #define SNDRV_PCM_RATE_8000_48000 (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
134 #define SNDRV_PCM_RATE_8000_96000 (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
135 SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
136 #define SNDRV_PCM_RATE_8000_192000 (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
137 SNDRV_PCM_RATE_192000)
138 #define SNDRV_PCM_FMTBIT_S8 (1ULL << SNDRV_PCM_FORMAT_S8)
139 #define SNDRV_PCM_FMTBIT_U8 (1ULL << SNDRV_PCM_FORMAT_U8)
140 #define SNDRV_PCM_FMTBIT_S16_LE (1ULL << SNDRV_PCM_FORMAT_S16_LE)
141 #define SNDRV_PCM_FMTBIT_S16_BE (1ULL << SNDRV_PCM_FORMAT_S16_BE)
142 #define SNDRV_PCM_FMTBIT_U16_LE (1ULL << SNDRV_PCM_FORMAT_U16_LE)
143 #define SNDRV_PCM_FMTBIT_U16_BE (1ULL << SNDRV_PCM_FORMAT_U16_BE)
144 #define SNDRV_PCM_FMTBIT_S24_LE (1ULL << SNDRV_PCM_FORMAT_S24_LE)
145 #define SNDRV_PCM_FMTBIT_S24_BE (1ULL << SNDRV_PCM_FORMAT_S24_BE)
146 #define SNDRV_PCM_FMTBIT_U24_LE (1ULL << SNDRV_PCM_FORMAT_U24_LE)
147 #define SNDRV_PCM_FMTBIT_U24_BE (1ULL << SNDRV_PCM_FORMAT_U24_BE)
148 #define SNDRV_PCM_FMTBIT_S32_LE (1ULL << SNDRV_PCM_FORMAT_S32_LE)
149 #define SNDRV_PCM_FMTBIT_S32_BE (1ULL << SNDRV_PCM_FORMAT_S32_BE)
150 #define SNDRV_PCM_FMTBIT_U32_LE (1ULL << SNDRV_PCM_FORMAT_U32_LE)
151 #define SNDRV_PCM_FMTBIT_U32_BE (1ULL << SNDRV_PCM_FORMAT_U32_BE)
152 #define SNDRV_PCM_FMTBIT_FLOAT_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
153 #define SNDRV_PCM_FMTBIT_FLOAT_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
154 #define SNDRV_PCM_FMTBIT_FLOAT64_LE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
155 #define SNDRV_PCM_FMTBIT_FLOAT64_BE (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
156 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
157 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
158 #define SNDRV_PCM_FMTBIT_MU_LAW (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
159 #define SNDRV_PCM_FMTBIT_A_LAW (1ULL << SNDRV_PCM_FORMAT_A_LAW)
160 #define SNDRV_PCM_FMTBIT_IMA_ADPCM (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
161 #define SNDRV_PCM_FMTBIT_MPEG (1ULL << SNDRV_PCM_FORMAT_MPEG)
162 #define SNDRV_PCM_FMTBIT_GSM (1ULL << SNDRV_PCM_FORMAT_GSM)
163 #define SNDRV_PCM_FMTBIT_SPECIAL (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
164 #define SNDRV_PCM_FMTBIT_S24_3LE (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
165 #define SNDRV_PCM_FMTBIT_U24_3LE (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
166 #define SNDRV_PCM_FMTBIT_S24_3BE (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
167 #define SNDRV_PCM_FMTBIT_U24_3BE (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
168 #define SNDRV_PCM_FMTBIT_S20_3LE (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
169 #define SNDRV_PCM_FMTBIT_U20_3LE (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
170 #define SNDRV_PCM_FMTBIT_S20_3BE (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
171 #define SNDRV_PCM_FMTBIT_U20_3BE (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
172 #define SNDRV_PCM_FMTBIT_S18_3LE (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
173 #define SNDRV_PCM_FMTBIT_U18_3LE (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
174 #define SNDRV_PCM_FMTBIT_S18_3BE (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
175 #define SNDRV_PCM_FMTBIT_U18_3BE (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
177 #ifdef SNDRV_LITTLE_ENDIAN
178 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_LE
179 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_LE
180 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_LE
181 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_LE
182 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_LE
183 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_LE
184 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_LE
185 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_LE
186 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
187 #endif
188 #ifdef SNDRV_BIG_ENDIAN
189 #define SNDRV_PCM_FMTBIT_S16 SNDRV_PCM_FMTBIT_S16_BE
190 #define SNDRV_PCM_FMTBIT_U16 SNDRV_PCM_FMTBIT_U16_BE
191 #define SNDRV_PCM_FMTBIT_S24 SNDRV_PCM_FMTBIT_S24_BE
192 #define SNDRV_PCM_FMTBIT_U24 SNDRV_PCM_FMTBIT_U24_BE
193 #define SNDRV_PCM_FMTBIT_S32 SNDRV_PCM_FMTBIT_S32_BE
194 #define SNDRV_PCM_FMTBIT_U32 SNDRV_PCM_FMTBIT_U32_BE
195 #define SNDRV_PCM_FMTBIT_FLOAT SNDRV_PCM_FMTBIT_FLOAT_BE
196 #define SNDRV_PCM_FMTBIT_FLOAT64 SNDRV_PCM_FMTBIT_FLOAT64_BE
197 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
198 #endif
200 struct snd_pcm_file {
201 struct snd_pcm_substream *substream;
202 int no_compat_mmap;
205 struct snd_pcm_hw_rule;
206 typedef int (*snd_pcm_hw_rule_func_t)(struct snd_pcm_hw_params *params,
207 struct snd_pcm_hw_rule *rule);
209 struct snd_pcm_hw_rule {
210 unsigned int cond;
211 snd_pcm_hw_rule_func_t func;
212 int var;
213 int deps[4];
214 void *private;
217 struct snd_pcm_hw_constraints {
218 struct snd_mask masks[SNDRV_PCM_HW_PARAM_LAST_MASK -
219 SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
220 struct snd_interval intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
221 SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
222 unsigned int rules_num;
223 unsigned int rules_all;
224 struct snd_pcm_hw_rule *rules;
227 static inline struct snd_mask *constrs_mask(struct snd_pcm_hw_constraints *constrs,
228 snd_pcm_hw_param_t var)
230 return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
233 static inline struct snd_interval *constrs_interval(struct snd_pcm_hw_constraints *constrs,
234 snd_pcm_hw_param_t var)
236 return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
239 struct snd_ratnum {
240 unsigned int num;
241 unsigned int den_min, den_max, den_step;
244 struct snd_ratden {
245 unsigned int num_min, num_max, num_step;
246 unsigned int den;
249 struct snd_pcm_hw_constraint_ratnums {
250 int nrats;
251 struct snd_ratnum *rats;
254 struct snd_pcm_hw_constraint_ratdens {
255 int nrats;
256 struct snd_ratden *rats;
259 struct snd_pcm_hw_constraint_list {
260 unsigned int count;
261 unsigned int *list;
262 unsigned int mask;
265 struct snd_pcm_runtime {
266 /* -- Status -- */
267 struct snd_pcm_substream *trigger_master;
268 struct timespec trigger_tstamp; /* trigger timestamp */
269 int overrange;
270 snd_pcm_uframes_t avail_max;
271 snd_pcm_uframes_t hw_ptr_base; /* Position at buffer restart */
272 snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time */
273 unsigned long hw_ptr_jiffies; /* Time when hw_ptr is updated */
274 snd_pcm_sframes_t delay; /* extra delay; typically FIFO size */
276 /* -- HW params -- */
277 snd_pcm_access_t access; /* access mode */
278 snd_pcm_format_t format; /* SNDRV_PCM_FORMAT_* */
279 snd_pcm_subformat_t subformat; /* subformat */
280 unsigned int rate; /* rate in Hz */
281 unsigned int channels; /* channels */
282 snd_pcm_uframes_t period_size; /* period size */
283 unsigned int periods; /* periods */
284 snd_pcm_uframes_t buffer_size; /* buffer size */
285 snd_pcm_uframes_t min_align; /* Min alignment for the format */
286 size_t byte_align;
287 unsigned int frame_bits;
288 unsigned int sample_bits;
289 unsigned int info;
290 unsigned int rate_num;
291 unsigned int rate_den;
293 /* -- SW params -- */
294 int tstamp_mode; /* mmap timestamp is updated */
295 unsigned int period_step;
296 snd_pcm_uframes_t start_threshold;
297 snd_pcm_uframes_t stop_threshold;
298 snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
299 noise is nearest than this */
300 snd_pcm_uframes_t silence_size; /* Silence filling size */
301 snd_pcm_uframes_t boundary; /* pointers wrap point */
303 snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
304 snd_pcm_uframes_t silence_filled; /* size filled with silence */
306 union snd_pcm_sync_id sync; /* hardware synchronization ID */
308 /* -- mmap -- */
309 struct snd_pcm_mmap_status *status;
310 struct snd_pcm_mmap_control *control;
312 /* -- locking / scheduling -- */
313 wait_queue_head_t sleep;
314 struct fasync_struct *fasync;
316 /* -- private section -- */
317 void *private_data;
318 void (*private_free)(struct snd_pcm_runtime *runtime);
320 /* -- hardware description -- */
321 struct snd_pcm_hardware hw;
322 struct snd_pcm_hw_constraints hw_constraints;
324 /* -- interrupt callbacks -- */
325 void (*transfer_ack_begin)(struct snd_pcm_substream *substream);
326 void (*transfer_ack_end)(struct snd_pcm_substream *substream);
328 /* -- timer -- */
329 unsigned int timer_resolution; /* timer resolution */
330 int tstamp_type; /* timestamp type */
332 /* -- DMA -- */
333 unsigned char *dma_area; /* DMA area */
334 dma_addr_t dma_addr; /* physical bus address (not accessible from main CPU) */
335 size_t dma_bytes; /* size of DMA area */
337 struct snd_dma_buffer *dma_buffer_p; /* allocated buffer */
339 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
340 /* -- OSS things -- */
341 struct snd_pcm_oss_runtime oss;
342 #endif
345 struct snd_pcm_group { /* keep linked substreams */
346 spinlock_t lock;
347 struct list_head substreams;
348 int count;
351 struct snd_pcm_substream {
352 struct snd_pcm *pcm;
353 struct snd_pcm_str *pstr;
354 void *private_data; /* copied from pcm->private_data */
355 int number;
356 char name[32]; /* substream name */
357 int stream; /* stream (direction) */
358 char latency_id[20]; /* latency identifier */
359 size_t buffer_bytes_max; /* limit ring buffer size */
360 struct snd_dma_buffer dma_buffer;
361 unsigned int dma_buf_id;
362 size_t dma_max;
363 /* -- hardware operations -- */
364 struct snd_pcm_ops *ops;
365 /* -- runtime information -- */
366 struct snd_pcm_runtime *runtime;
367 /* -- timer section -- */
368 struct snd_timer *timer; /* timer */
369 unsigned timer_running: 1; /* time is running */
370 /* -- next substream -- */
371 struct snd_pcm_substream *next;
372 /* -- linked substreams -- */
373 struct list_head link_list; /* linked list member */
374 struct snd_pcm_group self_group; /* fake group for non linked substream (with substream lock inside) */
375 struct snd_pcm_group *group; /* pointer to current group */
376 /* -- assigned files -- */
377 void *file;
378 int ref_count;
379 atomic_t mmap_count;
380 unsigned int f_flags;
381 void (*pcm_release)(struct snd_pcm_substream *);
382 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
383 /* -- OSS things -- */
384 struct snd_pcm_oss_substream oss;
385 #endif
386 #ifdef CONFIG_SND_VERBOSE_PROCFS
387 struct snd_info_entry *proc_root;
388 struct snd_info_entry *proc_info_entry;
389 struct snd_info_entry *proc_hw_params_entry;
390 struct snd_info_entry *proc_sw_params_entry;
391 struct snd_info_entry *proc_status_entry;
392 struct snd_info_entry *proc_prealloc_entry;
393 struct snd_info_entry *proc_prealloc_max_entry;
394 #endif
395 /* misc flags */
396 unsigned int hw_opened: 1;
399 #define SUBSTREAM_BUSY(substream) ((substream)->ref_count > 0)
402 struct snd_pcm_str {
403 int stream; /* stream (direction) */
404 struct snd_pcm *pcm;
405 /* -- substreams -- */
406 unsigned int substream_count;
407 unsigned int substream_opened;
408 struct snd_pcm_substream *substream;
409 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
410 /* -- OSS things -- */
411 struct snd_pcm_oss_stream oss;
412 #endif
413 #ifdef CONFIG_SND_VERBOSE_PROCFS
414 struct snd_info_entry *proc_root;
415 struct snd_info_entry *proc_info_entry;
416 #ifdef CONFIG_SND_PCM_XRUN_DEBUG
417 unsigned int xrun_debug; /* 0 = disabled, 1 = verbose, 2 = stacktrace */
418 struct snd_info_entry *proc_xrun_debug_entry;
419 #endif
420 #endif
423 struct snd_pcm {
424 struct snd_card *card;
425 struct list_head list;
426 int device; /* device number */
427 unsigned int info_flags;
428 unsigned short dev_class;
429 unsigned short dev_subclass;
430 char id[64];
431 char name[80];
432 struct snd_pcm_str streams[2];
433 struct mutex open_mutex;
434 wait_queue_head_t open_wait;
435 void *private_data;
436 void (*private_free) (struct snd_pcm *pcm);
437 struct device *dev; /* actual hw device this belongs to */
438 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
439 struct snd_pcm_oss oss;
440 #endif
443 struct snd_pcm_notify {
444 int (*n_register) (struct snd_pcm * pcm);
445 int (*n_disconnect) (struct snd_pcm * pcm);
446 int (*n_unregister) (struct snd_pcm * pcm);
447 struct list_head list;
451 * Registering
454 extern const struct file_operations snd_pcm_f_ops[2];
456 int snd_pcm_new(struct snd_card *card, const char *id, int device,
457 int playback_count, int capture_count,
458 struct snd_pcm **rpcm);
459 int snd_pcm_new_stream(struct snd_pcm *pcm, int stream, int substream_count);
461 int snd_pcm_notify(struct snd_pcm_notify *notify, int nfree);
464 * Native I/O
467 extern rwlock_t snd_pcm_link_rwlock;
469 int snd_pcm_info(struct snd_pcm_substream *substream, struct snd_pcm_info *info);
470 int snd_pcm_info_user(struct snd_pcm_substream *substream,
471 struct snd_pcm_info __user *info);
472 int snd_pcm_status(struct snd_pcm_substream *substream,
473 struct snd_pcm_status *status);
474 int snd_pcm_start(struct snd_pcm_substream *substream);
475 int snd_pcm_stop(struct snd_pcm_substream *substream, int status);
476 int snd_pcm_drain_done(struct snd_pcm_substream *substream);
477 #ifdef CONFIG_PM
478 int snd_pcm_suspend(struct snd_pcm_substream *substream);
479 int snd_pcm_suspend_all(struct snd_pcm *pcm);
480 #endif
481 int snd_pcm_kernel_ioctl(struct snd_pcm_substream *substream, unsigned int cmd, void *arg);
482 int snd_pcm_open_substream(struct snd_pcm *pcm, int stream, struct file *file,
483 struct snd_pcm_substream **rsubstream);
484 void snd_pcm_release_substream(struct snd_pcm_substream *substream);
485 int snd_pcm_attach_substream(struct snd_pcm *pcm, int stream, struct file *file,
486 struct snd_pcm_substream **rsubstream);
487 void snd_pcm_detach_substream(struct snd_pcm_substream *substream);
488 void snd_pcm_vma_notify_data(void *client, void *data);
489 int snd_pcm_mmap_data(struct snd_pcm_substream *substream, struct file *file, struct vm_area_struct *area);
492 * PCM library
495 static inline int snd_pcm_stream_linked(struct snd_pcm_substream *substream)
497 return substream->group != &substream->self_group;
500 static inline void snd_pcm_stream_lock(struct snd_pcm_substream *substream)
502 read_lock(&snd_pcm_link_rwlock);
503 spin_lock(&substream->self_group.lock);
506 static inline void snd_pcm_stream_unlock(struct snd_pcm_substream *substream)
508 spin_unlock(&substream->self_group.lock);
509 read_unlock(&snd_pcm_link_rwlock);
512 static inline void snd_pcm_stream_lock_irq(struct snd_pcm_substream *substream)
514 read_lock_irq(&snd_pcm_link_rwlock);
515 spin_lock(&substream->self_group.lock);
518 static inline void snd_pcm_stream_unlock_irq(struct snd_pcm_substream *substream)
520 spin_unlock(&substream->self_group.lock);
521 read_unlock_irq(&snd_pcm_link_rwlock);
524 #define snd_pcm_stream_lock_irqsave(substream, flags) \
525 do { \
526 read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
527 spin_lock(&substream->self_group.lock); \
528 } while (0)
530 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
531 do { \
532 spin_unlock(&substream->self_group.lock); \
533 read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
534 } while (0)
536 #define snd_pcm_group_for_each_entry(s, substream) \
537 list_for_each_entry(s, &substream->group->substreams, link_list)
539 static inline int snd_pcm_running(struct snd_pcm_substream *substream)
541 return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
542 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
543 substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
546 static inline ssize_t bytes_to_samples(struct snd_pcm_runtime *runtime, ssize_t size)
548 return size * 8 / runtime->sample_bits;
551 static inline snd_pcm_sframes_t bytes_to_frames(struct snd_pcm_runtime *runtime, ssize_t size)
553 return size * 8 / runtime->frame_bits;
556 static inline ssize_t samples_to_bytes(struct snd_pcm_runtime *runtime, ssize_t size)
558 return size * runtime->sample_bits / 8;
561 static inline ssize_t frames_to_bytes(struct snd_pcm_runtime *runtime, snd_pcm_sframes_t size)
563 return size * runtime->frame_bits / 8;
566 static inline int frame_aligned(struct snd_pcm_runtime *runtime, ssize_t bytes)
568 return bytes % runtime->byte_align == 0;
571 static inline size_t snd_pcm_lib_buffer_bytes(struct snd_pcm_substream *substream)
573 struct snd_pcm_runtime *runtime = substream->runtime;
574 return frames_to_bytes(runtime, runtime->buffer_size);
577 static inline size_t snd_pcm_lib_period_bytes(struct snd_pcm_substream *substream)
579 struct snd_pcm_runtime *runtime = substream->runtime;
580 return frames_to_bytes(runtime, runtime->period_size);
584 * result is: 0 ... (boundary - 1)
586 static inline snd_pcm_uframes_t snd_pcm_playback_avail(struct snd_pcm_runtime *runtime)
588 snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
589 if (avail < 0)
590 avail += runtime->boundary;
591 else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
592 avail -= runtime->boundary;
593 return avail;
597 * result is: 0 ... (boundary - 1)
599 static inline snd_pcm_uframes_t snd_pcm_capture_avail(struct snd_pcm_runtime *runtime)
601 snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
602 if (avail < 0)
603 avail += runtime->boundary;
604 return avail;
607 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(struct snd_pcm_runtime *runtime)
609 return runtime->buffer_size - snd_pcm_playback_avail(runtime);
612 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(struct snd_pcm_runtime *runtime)
614 return runtime->buffer_size - snd_pcm_capture_avail(runtime);
618 * snd_pcm_playback_ready - check whether the playback buffer is available
619 * @substream: the pcm substream instance
621 * Checks whether enough free space is available on the playback buffer.
623 * Returns non-zero if available, or zero if not.
625 static inline int snd_pcm_playback_ready(struct snd_pcm_substream *substream)
627 struct snd_pcm_runtime *runtime = substream->runtime;
628 return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
632 * snd_pcm_capture_ready - check whether the capture buffer is available
633 * @substream: the pcm substream instance
635 * Checks whether enough capture data is available on the capture buffer.
637 * Returns non-zero if available, or zero if not.
639 static inline int snd_pcm_capture_ready(struct snd_pcm_substream *substream)
641 struct snd_pcm_runtime *runtime = substream->runtime;
642 return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
646 * snd_pcm_playback_data - check whether any data exists on the playback buffer
647 * @substream: the pcm substream instance
649 * Checks whether any data exists on the playback buffer. If stop_threshold
650 * is bigger or equal to boundary, then this function returns always non-zero.
652 * Returns non-zero if exists, or zero if not.
654 static inline int snd_pcm_playback_data(struct snd_pcm_substream *substream)
656 struct snd_pcm_runtime *runtime = substream->runtime;
658 if (runtime->stop_threshold >= runtime->boundary)
659 return 1;
660 return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
664 * snd_pcm_playback_empty - check whether the playback buffer is empty
665 * @substream: the pcm substream instance
667 * Checks whether the playback buffer is empty.
669 * Returns non-zero if empty, or zero if not.
671 static inline int snd_pcm_playback_empty(struct snd_pcm_substream *substream)
673 struct snd_pcm_runtime *runtime = substream->runtime;
674 return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
678 * snd_pcm_capture_empty - check whether the capture buffer is empty
679 * @substream: the pcm substream instance
681 * Checks whether the capture buffer is empty.
683 * Returns non-zero if empty, or zero if not.
685 static inline int snd_pcm_capture_empty(struct snd_pcm_substream *substream)
687 struct snd_pcm_runtime *runtime = substream->runtime;
688 return snd_pcm_capture_avail(runtime) == 0;
691 static inline void snd_pcm_trigger_done(struct snd_pcm_substream *substream,
692 struct snd_pcm_substream *master)
694 substream->runtime->trigger_master = master;
697 static inline int hw_is_mask(int var)
699 return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
700 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
703 static inline int hw_is_interval(int var)
705 return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
706 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
709 static inline struct snd_mask *hw_param_mask(struct snd_pcm_hw_params *params,
710 snd_pcm_hw_param_t var)
712 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
715 static inline struct snd_interval *hw_param_interval(struct snd_pcm_hw_params *params,
716 snd_pcm_hw_param_t var)
718 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
721 static inline const struct snd_mask *hw_param_mask_c(const struct snd_pcm_hw_params *params,
722 snd_pcm_hw_param_t var)
724 return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
727 static inline const struct snd_interval *hw_param_interval_c(const struct snd_pcm_hw_params *params,
728 snd_pcm_hw_param_t var)
730 return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
733 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
734 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
735 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
736 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
737 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
738 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
739 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
740 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
741 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
742 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
745 int snd_interval_refine(struct snd_interval *i, const struct snd_interval *v);
746 void snd_interval_mul(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
747 void snd_interval_div(const struct snd_interval *a, const struct snd_interval *b, struct snd_interval *c);
748 void snd_interval_muldivk(const struct snd_interval *a, const struct snd_interval *b,
749 unsigned int k, struct snd_interval *c);
750 void snd_interval_mulkdiv(const struct snd_interval *a, unsigned int k,
751 const struct snd_interval *b, struct snd_interval *c);
752 int snd_interval_list(struct snd_interval *i, unsigned int count, unsigned int *list, unsigned int mask);
753 int snd_interval_ratnum(struct snd_interval *i,
754 unsigned int rats_count, struct snd_ratnum *rats,
755 unsigned int *nump, unsigned int *denp);
757 void _snd_pcm_hw_params_any(struct snd_pcm_hw_params *params);
758 void _snd_pcm_hw_param_setempty(struct snd_pcm_hw_params *params, snd_pcm_hw_param_t var);
759 int snd_pcm_hw_params_choose(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
761 int snd_pcm_hw_refine(struct snd_pcm_substream *substream, struct snd_pcm_hw_params *params);
763 int snd_pcm_hw_constraints_init(struct snd_pcm_substream *substream);
764 int snd_pcm_hw_constraints_complete(struct snd_pcm_substream *substream);
766 int snd_pcm_hw_constraint_mask(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
767 u_int32_t mask);
768 int snd_pcm_hw_constraint_mask64(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
769 u_int64_t mask);
770 int snd_pcm_hw_constraint_minmax(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var,
771 unsigned int min, unsigned int max);
772 int snd_pcm_hw_constraint_integer(struct snd_pcm_runtime *runtime, snd_pcm_hw_param_t var);
773 int snd_pcm_hw_constraint_list(struct snd_pcm_runtime *runtime,
774 unsigned int cond,
775 snd_pcm_hw_param_t var,
776 struct snd_pcm_hw_constraint_list *l);
777 int snd_pcm_hw_constraint_ratnums(struct snd_pcm_runtime *runtime,
778 unsigned int cond,
779 snd_pcm_hw_param_t var,
780 struct snd_pcm_hw_constraint_ratnums *r);
781 int snd_pcm_hw_constraint_ratdens(struct snd_pcm_runtime *runtime,
782 unsigned int cond,
783 snd_pcm_hw_param_t var,
784 struct snd_pcm_hw_constraint_ratdens *r);
785 int snd_pcm_hw_constraint_msbits(struct snd_pcm_runtime *runtime,
786 unsigned int cond,
787 unsigned int width,
788 unsigned int msbits);
789 int snd_pcm_hw_constraint_step(struct snd_pcm_runtime *runtime,
790 unsigned int cond,
791 snd_pcm_hw_param_t var,
792 unsigned long step);
793 int snd_pcm_hw_constraint_pow2(struct snd_pcm_runtime *runtime,
794 unsigned int cond,
795 snd_pcm_hw_param_t var);
796 int snd_pcm_hw_rule_add(struct snd_pcm_runtime *runtime,
797 unsigned int cond,
798 int var,
799 snd_pcm_hw_rule_func_t func, void *private,
800 int dep, ...);
802 int snd_pcm_format_signed(snd_pcm_format_t format);
803 int snd_pcm_format_unsigned(snd_pcm_format_t format);
804 int snd_pcm_format_linear(snd_pcm_format_t format);
805 int snd_pcm_format_little_endian(snd_pcm_format_t format);
806 int snd_pcm_format_big_endian(snd_pcm_format_t format);
807 #if 0 /* just for DocBook */
809 * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
810 * @format: the format to check
812 * Returns 1 if the given PCM format is CPU-endian, 0 if
813 * opposite, or a negative error code if endian not specified.
815 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
816 #endif /* DocBook */
817 #ifdef SNDRV_LITTLE_ENDIAN
818 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
819 #else
820 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
821 #endif
822 int snd_pcm_format_width(snd_pcm_format_t format); /* in bits */
823 int snd_pcm_format_physical_width(snd_pcm_format_t format); /* in bits */
824 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
825 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
826 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
827 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
829 void snd_pcm_set_ops(struct snd_pcm * pcm, int direction, struct snd_pcm_ops *ops);
830 void snd_pcm_set_sync(struct snd_pcm_substream *substream);
831 int snd_pcm_lib_interleave_len(struct snd_pcm_substream *substream);
832 int snd_pcm_lib_ioctl(struct snd_pcm_substream *substream,
833 unsigned int cmd, void *arg);
834 int snd_pcm_update_hw_ptr(struct snd_pcm_substream *substream);
835 int snd_pcm_playback_xrun_check(struct snd_pcm_substream *substream);
836 int snd_pcm_capture_xrun_check(struct snd_pcm_substream *substream);
837 int snd_pcm_playback_xrun_asap(struct snd_pcm_substream *substream);
838 int snd_pcm_capture_xrun_asap(struct snd_pcm_substream *substream);
839 void snd_pcm_playback_silence(struct snd_pcm_substream *substream, snd_pcm_uframes_t new_hw_ptr);
840 void snd_pcm_period_elapsed(struct snd_pcm_substream *substream);
841 snd_pcm_sframes_t snd_pcm_lib_write(struct snd_pcm_substream *substream,
842 const void __user *buf,
843 snd_pcm_uframes_t frames);
844 snd_pcm_sframes_t snd_pcm_lib_read(struct snd_pcm_substream *substream,
845 void __user *buf, snd_pcm_uframes_t frames);
846 snd_pcm_sframes_t snd_pcm_lib_writev(struct snd_pcm_substream *substream,
847 void __user **bufs, snd_pcm_uframes_t frames);
848 snd_pcm_sframes_t snd_pcm_lib_readv(struct snd_pcm_substream *substream,
849 void __user **bufs, snd_pcm_uframes_t frames);
851 extern const struct snd_pcm_hw_constraint_list snd_pcm_known_rates;
853 int snd_pcm_limit_hw_rates(struct snd_pcm_runtime *runtime);
854 unsigned int snd_pcm_rate_to_rate_bit(unsigned int rate);
856 static inline void snd_pcm_set_runtime_buffer(struct snd_pcm_substream *substream,
857 struct snd_dma_buffer *bufp)
859 struct snd_pcm_runtime *runtime = substream->runtime;
860 if (bufp) {
861 runtime->dma_buffer_p = bufp;
862 runtime->dma_area = bufp->area;
863 runtime->dma_addr = bufp->addr;
864 runtime->dma_bytes = bufp->bytes;
865 } else {
866 runtime->dma_buffer_p = NULL;
867 runtime->dma_area = NULL;
868 runtime->dma_addr = 0;
869 runtime->dma_bytes = 0;
874 * Timer interface
877 void snd_pcm_timer_resolution_change(struct snd_pcm_substream *substream);
878 void snd_pcm_timer_init(struct snd_pcm_substream *substream);
879 void snd_pcm_timer_done(struct snd_pcm_substream *substream);
881 static inline void snd_pcm_gettime(struct snd_pcm_runtime *runtime,
882 struct timespec *tv)
884 if (runtime->tstamp_type == SNDRV_PCM_TSTAMP_TYPE_MONOTONIC)
885 do_posix_clock_monotonic_gettime(tv);
886 else
887 getnstimeofday(tv);
891 * Memory
894 int snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream);
895 int snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm);
896 int snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
897 int type, struct device *data,
898 size_t size, size_t max);
899 int snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
900 int type, void *data,
901 size_t size, size_t max);
902 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size);
903 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream);
905 #ifdef CONFIG_SND_DMA_SGBUF
907 * SG-buffer handling
909 #define snd_pcm_substream_sgbuf(substream) \
910 ((substream)->runtime->dma_buffer_p->private_data)
912 static inline dma_addr_t
913 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
915 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
916 return snd_sgbuf_get_addr(sg, ofs);
919 static inline void *
920 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
922 struct snd_sg_buf *sg = snd_pcm_substream_sgbuf(substream);
923 return snd_sgbuf_get_ptr(sg, ofs);
926 struct page *snd_pcm_sgbuf_ops_page(struct snd_pcm_substream *substream,
927 unsigned long offset);
928 unsigned int snd_pcm_sgbuf_get_chunk_size(struct snd_pcm_substream *substream,
929 unsigned int ofs, unsigned int size);
931 #else /* !SND_DMA_SGBUF */
933 * fake using a continuous buffer
935 static inline dma_addr_t
936 snd_pcm_sgbuf_get_addr(struct snd_pcm_substream *substream, unsigned int ofs)
938 return substream->runtime->dma_addr + ofs;
941 static inline void *
942 snd_pcm_sgbuf_get_ptr(struct snd_pcm_substream *substream, unsigned int ofs)
944 return substream->runtime->dma_area + ofs;
947 #define snd_pcm_sgbuf_ops_page NULL
949 #define snd_pcm_sgbuf_get_chunk_size(subs, ofs, size) (size)
951 #endif /* SND_DMA_SGBUF */
953 /* handle mmap counter - PCM mmap callback should handle this counter properly */
954 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
956 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
957 atomic_inc(&substream->mmap_count);
960 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
962 struct snd_pcm_substream *substream = (struct snd_pcm_substream *)area->vm_private_data;
963 atomic_dec(&substream->mmap_count);
966 /* mmap for io-memory area */
967 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
968 #define SNDRV_PCM_INFO_MMAP_IOMEM SNDRV_PCM_INFO_MMAP
969 int snd_pcm_lib_mmap_iomem(struct snd_pcm_substream *substream, struct vm_area_struct *area);
970 #else
971 #define SNDRV_PCM_INFO_MMAP_IOMEM 0
972 #define snd_pcm_lib_mmap_iomem NULL
973 #endif
975 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
977 *max = dma < 4 ? 64 * 1024 : 128 * 1024;
981 * Misc
984 #define SNDRV_PCM_DEFAULT_CON_SPDIF (IEC958_AES0_CON_EMPHASIS_NONE|\
985 (IEC958_AES1_CON_ORIGINAL<<8)|\
986 (IEC958_AES1_CON_PCM_CODER<<8)|\
987 (IEC958_AES3_CON_FS_48000<<24))
989 #define PCM_RUNTIME_CHECK(sub) snd_BUG_ON(!(sub) || !(sub)->runtime)
991 const char *snd_pcm_format_name(snd_pcm_format_t format);
993 #endif /* __SOUND_PCM_H */