[ALSA] Another fix for DocBook
[linux-2.6.git] / include / sound / pcm.h
1 #ifndef __SOUND_PCM_H
2 #define __SOUND_PCM_H
3
4 /*
5  *  Digital Audio (PCM) abstract layer
6  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
7  *                   Abramo Bagnara <abramo@alsa-project.org>
8  *
9  *
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.
14  *
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.
19  *
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
23  *
24  */
25
26 #include <sound/asound.h>
27 #include <sound/memalloc.h>
28 #include <linux/poll.h>
29 #include <linux/bitops.h>
30
31 typedef sndrv_pcm_uframes_t snd_pcm_uframes_t;
32 typedef sndrv_pcm_sframes_t snd_pcm_sframes_t;
33 typedef enum sndrv_pcm_class snd_pcm_class_t;
34 typedef enum sndrv_pcm_subclass snd_pcm_subclass_t;
35 typedef enum sndrv_pcm_stream snd_pcm_stream_t;
36 typedef enum sndrv_pcm_access snd_pcm_access_t;
37 typedef enum sndrv_pcm_format snd_pcm_format_t;
38 typedef enum sndrv_pcm_subformat snd_pcm_subformat_t;
39 typedef enum sndrv_pcm_state snd_pcm_state_t;
40 typedef union sndrv_pcm_sync_id snd_pcm_sync_id_t;
41 typedef struct sndrv_pcm_info snd_pcm_info_t;
42 typedef enum sndrv_pcm_hw_param snd_pcm_hw_param_t;
43 typedef struct sndrv_pcm_hw_params snd_pcm_hw_params_t;
44 typedef enum sndrv_pcm_start snd_pcm_start_t;
45 typedef enum sndrv_pcm_xrun snd_pcm_xrun_t;
46 typedef enum sndrv_pcm_tstamp snd_pcm_tstamp_t;
47 typedef struct sndrv_pcm_sw_params snd_pcm_sw_params_t;
48 typedef struct sndrv_pcm_channel_info snd_pcm_channel_info_t;
49 typedef struct sndrv_pcm_status snd_pcm_status_t;
50 typedef struct sndrv_pcm_mmap_status snd_pcm_mmap_status_t;
51 typedef struct sndrv_pcm_mmap_control snd_pcm_mmap_control_t;
52 typedef struct sndrv_mask snd_mask_t;
53 typedef struct snd_sg_buf snd_pcm_sgbuf_t;
54
55 #define snd_pcm_substream_chip(substream) ((substream)->private_data)
56 #define snd_pcm_chip(pcm) ((pcm)->private_data)
57
58 typedef struct _snd_pcm_file snd_pcm_file_t;
59 typedef struct _snd_pcm_runtime snd_pcm_runtime_t;
60
61 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
62 #include "pcm_oss.h"
63 #endif
64
65 /*
66  *  Hardware (lowlevel) section
67  */
68
69 typedef struct _snd_pcm_hardware {
70         unsigned int info;              /* SNDRV_PCM_INFO_* */
71         u64 formats;                    /* SNDRV_PCM_FMTBIT_* */
72         unsigned int rates;             /* SNDRV_PCM_RATE_* */
73         unsigned int rate_min;          /* min rate */
74         unsigned int rate_max;          /* max rate */
75         unsigned int channels_min;      /* min channels */
76         unsigned int channels_max;      /* max channels */
77         size_t buffer_bytes_max;        /* max buffer size */
78         size_t period_bytes_min;        /* min period size */
79         size_t period_bytes_max;        /* max period size */
80         unsigned int periods_min;       /* min # of periods */
81         unsigned int periods_max;       /* max # of periods */
82         size_t fifo_size;               /* fifo size in bytes */
83 } snd_pcm_hardware_t;
84
85 typedef struct _snd_pcm_ops {
86         int (*open)(snd_pcm_substream_t *substream);
87         int (*close)(snd_pcm_substream_t *substream);
88         int (*ioctl)(snd_pcm_substream_t * substream,
89                      unsigned int cmd, void *arg);
90         int (*hw_params)(snd_pcm_substream_t * substream, snd_pcm_hw_params_t * params);
91         int (*hw_free)(snd_pcm_substream_t *substream);
92         int (*prepare)(snd_pcm_substream_t * substream);
93         int (*trigger)(snd_pcm_substream_t * substream, int cmd);
94         snd_pcm_uframes_t (*pointer)(snd_pcm_substream_t * substream);
95         int (*copy)(snd_pcm_substream_t *substream, int channel, snd_pcm_uframes_t pos,
96                     void __user *buf, snd_pcm_uframes_t count);
97         int (*silence)(snd_pcm_substream_t *substream, int channel, 
98                        snd_pcm_uframes_t pos, snd_pcm_uframes_t count);
99         struct page *(*page)(snd_pcm_substream_t *substream, unsigned long offset);
100         int (*mmap)(snd_pcm_substream_t *substream, struct vm_area_struct *vma);
101         int (*ack)(snd_pcm_substream_t *substream);
102 } snd_pcm_ops_t;
103
104 /*
105  *
106  */
107
108 #define SNDRV_PCM_DEVICES               8
109
110 #define SNDRV_PCM_IOCTL1_FALSE          ((void *)0)
111 #define SNDRV_PCM_IOCTL1_TRUE           ((void *)1)
112
113 #define SNDRV_PCM_IOCTL1_RESET          0
114 #define SNDRV_PCM_IOCTL1_INFO           1
115 #define SNDRV_PCM_IOCTL1_CHANNEL_INFO   2
116 #define SNDRV_PCM_IOCTL1_GSTATE         3
117
118 #define SNDRV_PCM_TRIGGER_STOP          0
119 #define SNDRV_PCM_TRIGGER_START         1
120 #define SNDRV_PCM_TRIGGER_PAUSE_PUSH    3
121 #define SNDRV_PCM_TRIGGER_PAUSE_RELEASE 4
122 #define SNDRV_PCM_TRIGGER_SUSPEND       5
123 #define SNDRV_PCM_TRIGGER_RESUME        6
124
125 #define SNDRV_PCM_POS_XRUN              ((snd_pcm_uframes_t)-1)
126
127 /* If you change this don't forget to change rates[] table in pcm_native.c */
128 #define SNDRV_PCM_RATE_5512             (1<<0)          /* 5512Hz */
129 #define SNDRV_PCM_RATE_8000             (1<<1)          /* 8000Hz */
130 #define SNDRV_PCM_RATE_11025            (1<<2)          /* 11025Hz */
131 #define SNDRV_PCM_RATE_16000            (1<<3)          /* 16000Hz */
132 #define SNDRV_PCM_RATE_22050            (1<<4)          /* 22050Hz */
133 #define SNDRV_PCM_RATE_32000            (1<<5)          /* 32000Hz */
134 #define SNDRV_PCM_RATE_44100            (1<<6)          /* 44100Hz */
135 #define SNDRV_PCM_RATE_48000            (1<<7)          /* 48000Hz */
136 #define SNDRV_PCM_RATE_64000            (1<<8)          /* 64000Hz */
137 #define SNDRV_PCM_RATE_88200            (1<<9)          /* 88200Hz */
138 #define SNDRV_PCM_RATE_96000            (1<<10)         /* 96000Hz */
139 #define SNDRV_PCM_RATE_176400           (1<<11)         /* 176400Hz */
140 #define SNDRV_PCM_RATE_192000           (1<<12)         /* 192000Hz */
141
142 #define SNDRV_PCM_RATE_CONTINUOUS       (1<<30)         /* continuous range */
143 #define SNDRV_PCM_RATE_KNOT             (1<<31)         /* supports more non-continuos rates */
144
145 #define SNDRV_PCM_RATE_8000_44100       (SNDRV_PCM_RATE_8000|SNDRV_PCM_RATE_11025|\
146                                          SNDRV_PCM_RATE_16000|SNDRV_PCM_RATE_22050|\
147                                          SNDRV_PCM_RATE_32000|SNDRV_PCM_RATE_44100)
148 #define SNDRV_PCM_RATE_8000_48000       (SNDRV_PCM_RATE_8000_44100|SNDRV_PCM_RATE_48000)
149 #define SNDRV_PCM_RATE_8000_96000       (SNDRV_PCM_RATE_8000_48000|SNDRV_PCM_RATE_64000|\
150                                          SNDRV_PCM_RATE_88200|SNDRV_PCM_RATE_96000)
151 #define SNDRV_PCM_RATE_8000_192000      (SNDRV_PCM_RATE_8000_96000|SNDRV_PCM_RATE_176400|\
152                                          SNDRV_PCM_RATE_192000)
153 #define SNDRV_PCM_FMTBIT_S8             (1ULL << SNDRV_PCM_FORMAT_S8)
154 #define SNDRV_PCM_FMTBIT_U8             (1ULL << SNDRV_PCM_FORMAT_U8)
155 #define SNDRV_PCM_FMTBIT_S16_LE         (1ULL << SNDRV_PCM_FORMAT_S16_LE)
156 #define SNDRV_PCM_FMTBIT_S16_BE         (1ULL << SNDRV_PCM_FORMAT_S16_BE)
157 #define SNDRV_PCM_FMTBIT_U16_LE         (1ULL << SNDRV_PCM_FORMAT_U16_LE)
158 #define SNDRV_PCM_FMTBIT_U16_BE         (1ULL << SNDRV_PCM_FORMAT_U16_BE)
159 #define SNDRV_PCM_FMTBIT_S24_LE         (1ULL << SNDRV_PCM_FORMAT_S24_LE)
160 #define SNDRV_PCM_FMTBIT_S24_BE         (1ULL << SNDRV_PCM_FORMAT_S24_BE)
161 #define SNDRV_PCM_FMTBIT_U24_LE         (1ULL << SNDRV_PCM_FORMAT_U24_LE)
162 #define SNDRV_PCM_FMTBIT_U24_BE         (1ULL << SNDRV_PCM_FORMAT_U24_BE)
163 #define SNDRV_PCM_FMTBIT_S32_LE         (1ULL << SNDRV_PCM_FORMAT_S32_LE)
164 #define SNDRV_PCM_FMTBIT_S32_BE         (1ULL << SNDRV_PCM_FORMAT_S32_BE)
165 #define SNDRV_PCM_FMTBIT_U32_LE         (1ULL << SNDRV_PCM_FORMAT_U32_LE)
166 #define SNDRV_PCM_FMTBIT_U32_BE         (1ULL << SNDRV_PCM_FORMAT_U32_BE)
167 #define SNDRV_PCM_FMTBIT_FLOAT_LE       (1ULL << SNDRV_PCM_FORMAT_FLOAT_LE)
168 #define SNDRV_PCM_FMTBIT_FLOAT_BE       (1ULL << SNDRV_PCM_FORMAT_FLOAT_BE)
169 #define SNDRV_PCM_FMTBIT_FLOAT64_LE     (1ULL << SNDRV_PCM_FORMAT_FLOAT64_LE)
170 #define SNDRV_PCM_FMTBIT_FLOAT64_BE     (1ULL << SNDRV_PCM_FORMAT_FLOAT64_BE)
171 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_LE)
172 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE (1ULL << SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE)
173 #define SNDRV_PCM_FMTBIT_MU_LAW         (1ULL << SNDRV_PCM_FORMAT_MU_LAW)
174 #define SNDRV_PCM_FMTBIT_A_LAW          (1ULL << SNDRV_PCM_FORMAT_A_LAW)
175 #define SNDRV_PCM_FMTBIT_IMA_ADPCM      (1ULL << SNDRV_PCM_FORMAT_IMA_ADPCM)
176 #define SNDRV_PCM_FMTBIT_MPEG           (1ULL << SNDRV_PCM_FORMAT_MPEG)
177 #define SNDRV_PCM_FMTBIT_GSM            (1ULL << SNDRV_PCM_FORMAT_GSM)
178 #define SNDRV_PCM_FMTBIT_SPECIAL        (1ULL << SNDRV_PCM_FORMAT_SPECIAL)
179 #define SNDRV_PCM_FMTBIT_S24_3LE        (1ULL << SNDRV_PCM_FORMAT_S24_3LE)
180 #define SNDRV_PCM_FMTBIT_U24_3LE        (1ULL << SNDRV_PCM_FORMAT_U24_3LE)
181 #define SNDRV_PCM_FMTBIT_S24_3BE        (1ULL << SNDRV_PCM_FORMAT_S24_3BE)
182 #define SNDRV_PCM_FMTBIT_U24_3BE        (1ULL << SNDRV_PCM_FORMAT_U24_3BE)
183 #define SNDRV_PCM_FMTBIT_S20_3LE        (1ULL << SNDRV_PCM_FORMAT_S20_3LE)
184 #define SNDRV_PCM_FMTBIT_U20_3LE        (1ULL << SNDRV_PCM_FORMAT_U20_3LE)
185 #define SNDRV_PCM_FMTBIT_S20_3BE        (1ULL << SNDRV_PCM_FORMAT_S20_3BE)
186 #define SNDRV_PCM_FMTBIT_U20_3BE        (1ULL << SNDRV_PCM_FORMAT_U20_3BE)
187 #define SNDRV_PCM_FMTBIT_S18_3LE        (1ULL << SNDRV_PCM_FORMAT_S18_3LE)
188 #define SNDRV_PCM_FMTBIT_U18_3LE        (1ULL << SNDRV_PCM_FORMAT_U18_3LE)
189 #define SNDRV_PCM_FMTBIT_S18_3BE        (1ULL << SNDRV_PCM_FORMAT_S18_3BE)
190 #define SNDRV_PCM_FMTBIT_U18_3BE        (1ULL << SNDRV_PCM_FORMAT_U18_3BE)
191
192 #ifdef SNDRV_LITTLE_ENDIAN
193 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_LE
194 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_LE
195 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_LE
196 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_LE
197 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_LE
198 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_LE
199 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_LE
200 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_LE
201 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
202 #endif
203 #ifdef SNDRV_BIG_ENDIAN
204 #define SNDRV_PCM_FMTBIT_S16            SNDRV_PCM_FMTBIT_S16_BE
205 #define SNDRV_PCM_FMTBIT_U16            SNDRV_PCM_FMTBIT_U16_BE
206 #define SNDRV_PCM_FMTBIT_S24            SNDRV_PCM_FMTBIT_S24_BE
207 #define SNDRV_PCM_FMTBIT_U24            SNDRV_PCM_FMTBIT_U24_BE
208 #define SNDRV_PCM_FMTBIT_S32            SNDRV_PCM_FMTBIT_S32_BE
209 #define SNDRV_PCM_FMTBIT_U32            SNDRV_PCM_FMTBIT_U32_BE
210 #define SNDRV_PCM_FMTBIT_FLOAT          SNDRV_PCM_FMTBIT_FLOAT_BE
211 #define SNDRV_PCM_FMTBIT_FLOAT64        SNDRV_PCM_FMTBIT_FLOAT64_BE
212 #define SNDRV_PCM_FMTBIT_IEC958_SUBFRAME SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE
213 #endif
214
215 struct _snd_pcm_file {
216         snd_pcm_substream_t * substream;
217         struct _snd_pcm_file * next;
218 };
219
220 typedef struct _snd_pcm_hw_rule snd_pcm_hw_rule_t;
221
222 typedef int (*snd_pcm_hw_rule_func_t)(snd_pcm_hw_params_t *params,
223                                       snd_pcm_hw_rule_t *rule);
224
225 struct _snd_pcm_hw_rule {
226         unsigned int cond;
227         snd_pcm_hw_rule_func_t func;
228         int var;
229         int deps[4];
230         void *private;
231 };
232
233 typedef struct _snd_pcm_hw_constraints {
234         snd_mask_t masks[SNDRV_PCM_HW_PARAM_LAST_MASK - 
235                          SNDRV_PCM_HW_PARAM_FIRST_MASK + 1];
236         snd_interval_t intervals[SNDRV_PCM_HW_PARAM_LAST_INTERVAL -
237                              SNDRV_PCM_HW_PARAM_FIRST_INTERVAL + 1];
238         unsigned int rules_num;
239         unsigned int rules_all;
240         snd_pcm_hw_rule_t *rules;
241 } snd_pcm_hw_constraints_t;
242
243 static inline snd_mask_t *constrs_mask(snd_pcm_hw_constraints_t *constrs,
244                                        snd_pcm_hw_param_t var)
245 {
246         return &constrs->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
247 }
248
249 static inline snd_interval_t *constrs_interval(snd_pcm_hw_constraints_t *constrs,
250                                           snd_pcm_hw_param_t var)
251 {
252         return &constrs->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
253 }
254
255 typedef struct {
256         unsigned int num;
257         unsigned int den_min, den_max, den_step;
258 } ratnum_t;
259
260 typedef struct {
261         unsigned int num_min, num_max, num_step;
262         unsigned int den;
263 } ratden_t;
264
265 typedef struct {
266         int nrats;
267         ratnum_t *rats;
268 } snd_pcm_hw_constraint_ratnums_t;
269
270 typedef struct {
271         int nrats;
272         ratden_t *rats;
273 } snd_pcm_hw_constraint_ratdens_t;
274
275 typedef struct {
276         unsigned int count;
277         unsigned int *list;
278         unsigned int mask;
279 } snd_pcm_hw_constraint_list_t;
280
281 struct _snd_pcm_runtime {
282         /* -- Status -- */
283         snd_pcm_substream_t *trigger_master;
284         snd_timestamp_t trigger_tstamp; /* trigger timestamp */
285         int overrange;
286         snd_pcm_uframes_t avail_max;
287         snd_pcm_uframes_t hw_ptr_base;  /* Position at buffer restart */
288         snd_pcm_uframes_t hw_ptr_interrupt; /* Position at interrupt time*/
289
290         /* -- HW params -- */
291         snd_pcm_access_t access;        /* access mode */
292         snd_pcm_format_t format;        /* SNDRV_PCM_FORMAT_* */
293         snd_pcm_subformat_t subformat;  /* subformat */
294         unsigned int rate;              /* rate in Hz */
295         unsigned int channels;          /* channels */
296         snd_pcm_uframes_t period_size;  /* period size */
297         unsigned int periods;           /* periods */
298         snd_pcm_uframes_t buffer_size;  /* buffer size */
299         unsigned int tick_time;         /* tick time */
300         snd_pcm_uframes_t min_align;    /* Min alignment for the format */
301         size_t byte_align;
302         unsigned int frame_bits;
303         unsigned int sample_bits;
304         unsigned int info;
305         unsigned int rate_num;
306         unsigned int rate_den;
307
308         /* -- SW params -- */
309         int tstamp_timespec;            /* use timeval (0) or timespec (1) */
310         snd_pcm_tstamp_t tstamp_mode;   /* mmap timestamp is updated */
311         unsigned int period_step;
312         unsigned int sleep_min;         /* min ticks to sleep */
313         snd_pcm_uframes_t xfer_align;   /* xfer size need to be a multiple */
314         snd_pcm_uframes_t start_threshold;
315         snd_pcm_uframes_t stop_threshold;
316         snd_pcm_uframes_t silence_threshold; /* Silence filling happens when
317                                                 noise is nearest than this */
318         snd_pcm_uframes_t silence_size; /* Silence filling size */
319         snd_pcm_uframes_t boundary;     /* pointers wrap point */
320
321         snd_pcm_uframes_t silence_start; /* starting pointer to silence area */
322         snd_pcm_uframes_t silence_filled; /* size filled with silence */
323
324         snd_pcm_sync_id_t sync;         /* hardware synchronization ID */
325
326         /* -- mmap -- */
327         volatile snd_pcm_mmap_status_t *status;
328         volatile snd_pcm_mmap_control_t *control;
329         atomic_t mmap_count;
330
331         /* -- locking / scheduling -- */
332         wait_queue_head_t sleep;
333         struct timer_list tick_timer;
334         struct fasync_struct *fasync;
335
336         /* -- private section -- */
337         void *private_data;
338         void (*private_free)(snd_pcm_runtime_t *runtime);
339
340         /* -- hardware description -- */
341         snd_pcm_hardware_t hw;
342         snd_pcm_hw_constraints_t hw_constraints;
343
344         /* -- interrupt callbacks -- */
345         void (*transfer_ack_begin)(snd_pcm_substream_t *substream);
346         void (*transfer_ack_end)(snd_pcm_substream_t *substream);
347
348         /* -- timer -- */
349         unsigned int timer_resolution;  /* timer resolution */
350
351         /* -- DMA -- */           
352         unsigned char *dma_area;        /* DMA area */
353         dma_addr_t dma_addr;            /* physical bus address (not accessible from main CPU) */
354         size_t dma_bytes;               /* size of DMA area */
355
356         struct snd_dma_buffer *dma_buffer_p;    /* allocated buffer */
357
358 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
359         /* -- OSS things -- */
360         snd_pcm_oss_runtime_t oss;
361 #endif
362 };
363
364 typedef struct _snd_pcm_group {         /* keep linked substreams */
365         spinlock_t lock;
366         struct list_head substreams;
367         int count;
368 } snd_pcm_group_t;
369
370 struct _snd_pcm_substream {
371         snd_pcm_t *pcm;
372         snd_pcm_str_t *pstr;
373         void *private_data;             /* copied from pcm->private_data */
374         int number;
375         char name[32];                  /* substream name */
376         int stream;                     /* stream (direction) */
377         size_t buffer_bytes_max;        /* limit ring buffer size */
378         struct snd_dma_buffer dma_buffer;
379         unsigned int dma_buf_id;
380         size_t dma_max;
381         /* -- hardware operations -- */
382         snd_pcm_ops_t *ops;
383         /* -- runtime information -- */
384         snd_pcm_runtime_t *runtime;
385         /* -- timer section -- */
386         snd_timer_t *timer;             /* timer */
387         unsigned timer_running: 1;      /* time is running */
388         spinlock_t timer_lock;
389         /* -- next substream -- */
390         snd_pcm_substream_t *next;
391         /* -- linked substreams -- */
392         struct list_head link_list;     /* linked list member */
393         snd_pcm_group_t self_group;     /* fake group for non linked substream (with substream lock inside) */
394         snd_pcm_group_t *group;         /* pointer to current group */
395         /* -- assigned files -- */
396         snd_pcm_file_t *file;
397         struct file *ffile;
398 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
399         /* -- OSS things -- */
400         snd_pcm_oss_substream_t oss;
401 #endif
402         snd_info_entry_t *proc_root;
403         snd_info_entry_t *proc_info_entry;
404         snd_info_entry_t *proc_hw_params_entry;
405         snd_info_entry_t *proc_sw_params_entry;
406         snd_info_entry_t *proc_status_entry;
407         snd_info_entry_t *proc_prealloc_entry;
408         /* misc flags */
409         unsigned int no_mmap_ctrl: 1;
410 };
411
412 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
413 #define SUBSTREAM_BUSY(substream) ((substream)->file != NULL || ((substream)->oss.file != NULL))
414 #else
415 #define SUBSTREAM_BUSY(substream) ((substream)->file != NULL)
416 #endif
417
418
419 struct _snd_pcm_str {
420         int stream;                             /* stream (direction) */
421         snd_pcm_t *pcm;
422         /* -- substreams -- */
423         unsigned int substream_count;
424         unsigned int substream_opened;
425         snd_pcm_substream_t *substream;
426 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
427         /* -- OSS things -- */
428         snd_pcm_oss_stream_t oss;
429 #endif
430         snd_pcm_file_t *files;
431         snd_minor_t *reg;
432         snd_info_entry_t *proc_root;
433         snd_info_entry_t *proc_info_entry;
434 #ifdef CONFIG_SND_DEBUG
435         unsigned int xrun_debug;        /* 0 = disabled, 1 = verbose, 2 = stacktrace */
436         snd_info_entry_t *proc_xrun_debug_entry;
437 #endif
438 };
439
440 struct _snd_pcm {
441         snd_card_t *card;
442         unsigned int device;    /* device number */
443         unsigned int info_flags;
444         unsigned short dev_class;
445         unsigned short dev_subclass;
446         char id[64];
447         char name[80];
448         snd_pcm_str_t streams[2];
449         struct semaphore open_mutex;
450         wait_queue_head_t open_wait;
451         void *private_data;
452         void (*private_free) (snd_pcm_t *pcm);
453 #if defined(CONFIG_SND_PCM_OSS) || defined(CONFIG_SND_PCM_OSS_MODULE)
454         snd_pcm_oss_t oss;
455 #endif
456 };
457
458 typedef struct _snd_pcm_notify {
459         int (*n_register) (snd_pcm_t * pcm);
460         int (*n_disconnect) (snd_pcm_t * pcm);
461         int (*n_unregister) (snd_pcm_t * pcm);
462         struct list_head list;
463 } snd_pcm_notify_t;
464
465 /*
466  *  Registering
467  */
468
469 extern snd_pcm_t *snd_pcm_devices[];
470 extern snd_minor_t snd_pcm_reg[2];
471
472 int snd_pcm_new(snd_card_t * card, char *id, int device,
473                 int playback_count, int capture_count,
474                 snd_pcm_t **rpcm);
475 int snd_pcm_new_stream(snd_pcm_t *pcm, int stream, int substream_count);
476
477 int snd_pcm_notify(snd_pcm_notify_t *notify, int nfree);
478
479 /*
480  *  Native I/O
481  */
482
483 extern rwlock_t snd_pcm_link_rwlock;
484
485 int snd_pcm_info(snd_pcm_substream_t * substream, snd_pcm_info_t *info);
486 int snd_pcm_info_user(snd_pcm_substream_t * substream, snd_pcm_info_t __user *info);
487 int snd_pcm_status(snd_pcm_substream_t * substream, snd_pcm_status_t *status);
488 int snd_pcm_prepare(snd_pcm_substream_t *substream);
489 int snd_pcm_start(snd_pcm_substream_t *substream);
490 int snd_pcm_stop(snd_pcm_substream_t *substream, int status);
491 int snd_pcm_drain_done(snd_pcm_substream_t *substream);
492 #ifdef CONFIG_PM
493 int snd_pcm_suspend(snd_pcm_substream_t *substream);
494 int snd_pcm_suspend_all(snd_pcm_t *pcm);
495 #endif
496 int snd_pcm_kernel_playback_ioctl(snd_pcm_substream_t *substream, unsigned int cmd, void *arg);
497 int snd_pcm_kernel_capture_ioctl(snd_pcm_substream_t *substream, unsigned int cmd, void *arg);
498 int snd_pcm_kernel_ioctl(snd_pcm_substream_t *substream, unsigned int cmd, void *arg);
499 int snd_pcm_open_substream(snd_pcm_t *pcm, int stream, snd_pcm_substream_t **rsubstream);
500 void snd_pcm_release_substream(snd_pcm_substream_t *substream);
501 void snd_pcm_vma_notify_data(void *client, void *data);
502 int snd_pcm_mmap_data(snd_pcm_substream_t *substream, struct file *file, struct vm_area_struct *area);
503
504 #if BITS_PER_LONG >= 64
505
506 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
507 {
508         *rem = *n % div;
509         *n /= div;
510 }
511
512 #elif defined(i386)
513
514 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
515 {
516         u_int32_t low, high;
517         low = *n & 0xffffffff;
518         high = *n >> 32;
519         if (high) {
520                 u_int32_t high1 = high % div;
521                 high /= div;
522                 asm("divl %2":"=a" (low), "=d" (*rem):"rm" (div), "a" (low), "d" (high1));
523                 *n = (u_int64_t)high << 32 | low;
524         } else {
525                 *n = low / div;
526                 *rem = low % div;
527         }
528 }
529 #else
530
531 static inline void divl(u_int32_t high, u_int32_t low,
532                         u_int32_t div,
533                         u_int32_t *q, u_int32_t *r)
534 {
535         u_int64_t n = (u_int64_t)high << 32 | low;
536         u_int64_t d = (u_int64_t)div << 31;
537         u_int32_t q1 = 0;
538         int c = 32;
539         while (n > 0xffffffffU) {
540                 q1 <<= 1;
541                 if (n >= d) {
542                         n -= d;
543                         q1 |= 1;
544                 }
545                 d >>= 1;
546                 c--;
547         }
548         q1 <<= c;
549         if (n) {
550                 low = n;
551                 *q = q1 | (low / div);
552                 *r = low % div;
553         } else {
554                 *r = 0;
555                 *q = q1;
556         }
557         return;
558 }
559
560 static inline void div64_32(u_int64_t *n, u_int32_t div, u_int32_t *rem)
561 {
562         u_int32_t low, high;
563         low = *n & 0xffffffff;
564         high = *n >> 32;
565         if (high) {
566                 u_int32_t high1 = high % div;
567                 u_int32_t low1 = low;
568                 high /= div;
569                 divl(high1, low1, div, &low, rem);
570                 *n = (u_int64_t)high << 32 | low;
571         } else {
572                 *n = low / div;
573                 *rem = low % div;
574         }
575 }
576 #endif
577
578 /*
579  *  PCM library
580  */
581
582 static inline int snd_pcm_stream_linked(snd_pcm_substream_t *substream)
583 {
584         return substream->group != &substream->self_group;
585 }
586
587 static inline void snd_pcm_stream_lock(snd_pcm_substream_t *substream)
588 {
589         read_lock(&snd_pcm_link_rwlock);
590         spin_lock(&substream->self_group.lock);
591 }
592
593 static inline void snd_pcm_stream_unlock(snd_pcm_substream_t *substream)
594 {
595         spin_unlock(&substream->self_group.lock);
596         read_unlock(&snd_pcm_link_rwlock);
597 }
598
599 static inline void snd_pcm_stream_lock_irq(snd_pcm_substream_t *substream)
600 {
601         read_lock_irq(&snd_pcm_link_rwlock);
602         spin_lock(&substream->self_group.lock);
603 }
604
605 static inline void snd_pcm_stream_unlock_irq(snd_pcm_substream_t *substream)
606 {
607         spin_unlock(&substream->self_group.lock);
608         read_unlock_irq(&snd_pcm_link_rwlock);
609 }
610
611 #define snd_pcm_stream_lock_irqsave(substream, flags) \
612 do { \
613         read_lock_irqsave(&snd_pcm_link_rwlock, (flags)); \
614         spin_lock(&substream->self_group.lock); \
615 } while (0)
616
617 #define snd_pcm_stream_unlock_irqrestore(substream, flags) \
618 do { \
619         spin_unlock(&substream->self_group.lock); \
620         read_unlock_irqrestore(&snd_pcm_link_rwlock, (flags)); \
621 } while (0)
622
623 #define snd_pcm_group_for_each(pos, substream) \
624         list_for_each(pos, &substream->group->substreams)
625
626 #define snd_pcm_group_substream_entry(pos) \
627         list_entry(pos, snd_pcm_substream_t, link_list)
628
629 static inline int snd_pcm_running(snd_pcm_substream_t *substream)
630 {
631         return (substream->runtime->status->state == SNDRV_PCM_STATE_RUNNING ||
632                 (substream->runtime->status->state == SNDRV_PCM_STATE_DRAINING &&
633                  substream->stream == SNDRV_PCM_STREAM_PLAYBACK));
634 }
635
636 static inline ssize_t bytes_to_samples(snd_pcm_runtime_t *runtime, ssize_t size)
637 {
638         return size * 8 / runtime->sample_bits;
639 }
640
641 static inline snd_pcm_sframes_t bytes_to_frames(snd_pcm_runtime_t *runtime, ssize_t size)
642 {
643         return size * 8 / runtime->frame_bits;
644 }
645
646 static inline ssize_t samples_to_bytes(snd_pcm_runtime_t *runtime, ssize_t size)
647 {
648         return size * runtime->sample_bits / 8;
649 }
650
651 static inline ssize_t frames_to_bytes(snd_pcm_runtime_t *runtime, snd_pcm_sframes_t size)
652 {
653         return size * runtime->frame_bits / 8;
654 }
655
656 static inline int frame_aligned(snd_pcm_runtime_t *runtime, ssize_t bytes)
657 {
658         return bytes % runtime->byte_align == 0;
659 }
660
661 static inline size_t snd_pcm_lib_buffer_bytes(snd_pcm_substream_t *substream)
662 {
663         snd_pcm_runtime_t *runtime = substream->runtime;
664         return frames_to_bytes(runtime, runtime->buffer_size);
665 }
666
667 static inline size_t snd_pcm_lib_period_bytes(snd_pcm_substream_t *substream)
668 {
669         snd_pcm_runtime_t *runtime = substream->runtime;
670         return frames_to_bytes(runtime, runtime->period_size);
671 }
672
673 /*
674  *  result is: 0 ... (boundary - 1)
675  */
676 static inline snd_pcm_uframes_t snd_pcm_playback_avail(snd_pcm_runtime_t *runtime)
677 {
678         snd_pcm_sframes_t avail = runtime->status->hw_ptr + runtime->buffer_size - runtime->control->appl_ptr;
679         if (avail < 0)
680                 avail += runtime->boundary;
681         else if ((snd_pcm_uframes_t) avail >= runtime->boundary)
682                 avail -= runtime->boundary;
683         return avail;
684 }
685
686 /*
687  *  result is: 0 ... (boundary - 1)
688  */
689 static inline snd_pcm_uframes_t snd_pcm_capture_avail(snd_pcm_runtime_t *runtime)
690 {
691         snd_pcm_sframes_t avail = runtime->status->hw_ptr - runtime->control->appl_ptr;
692         if (avail < 0)
693                 avail += runtime->boundary;
694         return avail;
695 }
696
697 static inline snd_pcm_sframes_t snd_pcm_playback_hw_avail(snd_pcm_runtime_t *runtime)
698 {
699         return runtime->buffer_size - snd_pcm_playback_avail(runtime);
700 }
701
702 static inline snd_pcm_sframes_t snd_pcm_capture_hw_avail(snd_pcm_runtime_t *runtime)
703 {
704         return runtime->buffer_size - snd_pcm_capture_avail(runtime);
705 }
706
707 /**
708  * snd_pcm_playback_ready - check whether the playback buffer is available
709  * @substream: the pcm substream instance
710  *
711  * Checks whether enough free space is available on the playback buffer.
712  *
713  * Returns non-zero if available, or zero if not.
714  */
715 static inline int snd_pcm_playback_ready(snd_pcm_substream_t *substream)
716 {
717         snd_pcm_runtime_t *runtime = substream->runtime;
718         return snd_pcm_playback_avail(runtime) >= runtime->control->avail_min;
719 }
720
721 /**
722  * snd_pcm_capture_ready - check whether the capture buffer is available
723  * @substream: the pcm substream instance
724  *
725  * Checks whether enough capture data is available on the capture buffer.
726  *
727  * Returns non-zero if available, or zero if not.
728  */
729 static inline int snd_pcm_capture_ready(snd_pcm_substream_t *substream)
730 {
731         snd_pcm_runtime_t *runtime = substream->runtime;
732         return snd_pcm_capture_avail(runtime) >= runtime->control->avail_min;
733 }
734
735 /**
736  * snd_pcm_playback_data - check whether any data exists on the playback buffer
737  * @substream: the pcm substream instance
738  *
739  * Checks whether any data exists on the playback buffer. If stop_threshold
740  * is bigger or equal to boundary, then this function returns always non-zero.
741  *
742  * Returns non-zero if exists, or zero if not.
743  */
744 static inline int snd_pcm_playback_data(snd_pcm_substream_t *substream)
745 {
746         snd_pcm_runtime_t *runtime = substream->runtime;
747         
748         if (runtime->stop_threshold >= runtime->boundary)
749                 return 1;
750         return snd_pcm_playback_avail(runtime) < runtime->buffer_size;
751 }
752
753 /**
754  * snd_pcm_playback_empty - check whether the playback buffer is empty
755  * @substream: the pcm substream instance
756  *
757  * Checks whether the playback buffer is empty.
758  *
759  * Returns non-zero if empty, or zero if not.
760  */
761 static inline int snd_pcm_playback_empty(snd_pcm_substream_t *substream)
762 {
763         snd_pcm_runtime_t *runtime = substream->runtime;
764         return snd_pcm_playback_avail(runtime) >= runtime->buffer_size;
765 }
766
767 /**
768  * snd_pcm_capture_empty - check whether the capture buffer is empty
769  * @substream: the pcm substream instance
770  *
771  * Checks whether the capture buffer is empty.
772  *
773  * Returns non-zero if empty, or zero if not.
774  */
775 static inline int snd_pcm_capture_empty(snd_pcm_substream_t *substream)
776 {
777         snd_pcm_runtime_t *runtime = substream->runtime;
778         return snd_pcm_capture_avail(runtime) == 0;
779 }
780
781 static inline void snd_pcm_trigger_done(snd_pcm_substream_t *substream, 
782                                         snd_pcm_substream_t *master)
783 {
784         substream->runtime->trigger_master = master;
785 }
786
787 static inline int hw_is_mask(int var)
788 {
789         return var >= SNDRV_PCM_HW_PARAM_FIRST_MASK &&
790                 var <= SNDRV_PCM_HW_PARAM_LAST_MASK;
791 }
792
793 static inline int hw_is_interval(int var)
794 {
795         return var >= SNDRV_PCM_HW_PARAM_FIRST_INTERVAL &&
796                 var <= SNDRV_PCM_HW_PARAM_LAST_INTERVAL;
797 }
798
799 static inline snd_mask_t *hw_param_mask(snd_pcm_hw_params_t *params,
800                                      snd_pcm_hw_param_t var)
801 {
802         return &params->masks[var - SNDRV_PCM_HW_PARAM_FIRST_MASK];
803 }
804
805 static inline snd_interval_t *hw_param_interval(snd_pcm_hw_params_t *params,
806                                              snd_pcm_hw_param_t var)
807 {
808         return &params->intervals[var - SNDRV_PCM_HW_PARAM_FIRST_INTERVAL];
809 }
810
811 static inline const snd_mask_t *hw_param_mask_c(const snd_pcm_hw_params_t *params,
812                                              snd_pcm_hw_param_t var)
813 {
814         return (const snd_mask_t *)hw_param_mask((snd_pcm_hw_params_t*) params, var);
815 }
816
817 static inline const snd_interval_t *hw_param_interval_c(const snd_pcm_hw_params_t *params,
818                                                      snd_pcm_hw_param_t var)
819 {
820         return (const snd_interval_t *)hw_param_interval((snd_pcm_hw_params_t*) params, var);
821 }
822
823 #define params_access(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_ACCESS))
824 #define params_format(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_FORMAT))
825 #define params_subformat(p) snd_mask_min(hw_param_mask((p), SNDRV_PCM_HW_PARAM_SUBFORMAT))
826 #define params_channels(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_CHANNELS)->min
827 #define params_rate(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_RATE)->min
828 #define params_period_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIOD_SIZE)->min
829 #define params_period_bytes(p) ((params_period_size(p)*snd_pcm_format_physical_width(params_format(p))*params_channels(p))/8)
830 #define params_periods(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_PERIODS)->min
831 #define params_buffer_size(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_SIZE)->min
832 #define params_buffer_bytes(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_BUFFER_BYTES)->min
833 #define params_tick_time(p) hw_param_interval((p), SNDRV_PCM_HW_PARAM_TICK_TIME)->min
834
835
836 int snd_interval_refine(snd_interval_t *i, const snd_interval_t *v);
837 void snd_interval_mul(const snd_interval_t *a, const snd_interval_t *b, snd_interval_t *c);
838 void snd_interval_div(const snd_interval_t *a, const snd_interval_t *b, snd_interval_t *c);
839 void snd_interval_muldivk(const snd_interval_t *a, const snd_interval_t *b, 
840                           unsigned int k, snd_interval_t *c);
841 void snd_interval_mulkdiv(const snd_interval_t *a, unsigned int k,
842                           const snd_interval_t *b, snd_interval_t *c);
843 int snd_interval_list(snd_interval_t *i, unsigned int count, unsigned int *list, unsigned int mask);
844 int snd_interval_ratnum(snd_interval_t *i,
845                         unsigned int rats_count, ratnum_t *rats,
846                         unsigned int *nump, unsigned int *denp);
847
848 void _snd_pcm_hw_params_any(snd_pcm_hw_params_t *params);
849 void _snd_pcm_hw_param_setempty(snd_pcm_hw_params_t *params, snd_pcm_hw_param_t var);
850 int snd_pcm_hw_param_near(snd_pcm_substream_t *substream, 
851                           snd_pcm_hw_params_t *params,
852                           snd_pcm_hw_param_t var, 
853                           unsigned int val, int *dir);
854 int snd_pcm_hw_param_set(snd_pcm_substream_t *pcm,
855                          snd_pcm_hw_params_t *params,
856                          snd_pcm_hw_param_t var,
857                          unsigned int val, int dir);
858 int snd_pcm_hw_params_choose(snd_pcm_substream_t *substream, snd_pcm_hw_params_t *params);
859
860 int snd_pcm_hw_refine(snd_pcm_substream_t *substream, snd_pcm_hw_params_t *params);
861
862 int snd_pcm_hw_constraints_init(snd_pcm_substream_t *substream);
863 int snd_pcm_hw_constraints_complete(snd_pcm_substream_t *substream);
864
865 int snd_pcm_hw_constraint_mask(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
866                                u_int32_t mask);
867 int snd_pcm_hw_constraint_mask64(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
868                                  u_int64_t mask);
869 int snd_pcm_hw_constraint_minmax(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
870                                  unsigned int min, unsigned int max);
871 int snd_pcm_hw_constraint_integer(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var);
872 int snd_pcm_hw_constraint_list(snd_pcm_runtime_t *runtime, 
873                                unsigned int cond,
874                                snd_pcm_hw_param_t var,
875                                snd_pcm_hw_constraint_list_t *l);
876 int snd_pcm_hw_constraint_ratnums(snd_pcm_runtime_t *runtime, 
877                                   unsigned int cond,
878                                   snd_pcm_hw_param_t var,
879                                   snd_pcm_hw_constraint_ratnums_t *r);
880 int snd_pcm_hw_constraint_ratdens(snd_pcm_runtime_t *runtime, 
881                                   unsigned int cond,
882                                   snd_pcm_hw_param_t var,
883                                   snd_pcm_hw_constraint_ratdens_t *r);
884 int snd_pcm_hw_constraint_msbits(snd_pcm_runtime_t *runtime, 
885                                  unsigned int cond,
886                                  unsigned int width,
887                                  unsigned int msbits);
888 int snd_pcm_hw_constraint_step(snd_pcm_runtime_t *runtime,
889                                unsigned int cond,
890                                snd_pcm_hw_param_t var,
891                                unsigned long step);
892 int snd_pcm_hw_constraint_pow2(snd_pcm_runtime_t *runtime,
893                                unsigned int cond,
894                                snd_pcm_hw_param_t var);
895 int snd_pcm_hw_rule_add(snd_pcm_runtime_t *runtime,
896                         unsigned int cond,
897                         int var,
898                         snd_pcm_hw_rule_func_t func, void *private,
899                         int dep, ...);
900
901 int snd_pcm_format_signed(snd_pcm_format_t format);
902 int snd_pcm_format_unsigned(snd_pcm_format_t format);
903 int snd_pcm_format_linear(snd_pcm_format_t format);
904 int snd_pcm_format_little_endian(snd_pcm_format_t format);
905 int snd_pcm_format_big_endian(snd_pcm_format_t format);
906 #if 0 /* just for DocBook */
907 /**
908  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
909  * @format: the format to check
910  *
911  * Returns 1 if the given PCM format is CPU-endian, 0 if
912  * opposite, or a negative error code if endian not specified.
913  */
914 int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
915 #endif /* DocBook */
916 #ifdef SNDRV_LITTLE_ENDIAN
917 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_little_endian(format)
918 #else
919 #define snd_pcm_format_cpu_endian(format) snd_pcm_format_big_endian(format)
920 #endif
921 int snd_pcm_format_width(snd_pcm_format_t format);                      /* in bits */
922 int snd_pcm_format_physical_width(snd_pcm_format_t format);             /* in bits */
923 ssize_t snd_pcm_format_size(snd_pcm_format_t format, size_t samples);
924 const unsigned char *snd_pcm_format_silence_64(snd_pcm_format_t format);
925 int snd_pcm_format_set_silence(snd_pcm_format_t format, void *buf, unsigned int frames);
926 snd_pcm_format_t snd_pcm_build_linear_format(int width, int unsignd, int big_endian);
927 const char *snd_pcm_format_name(snd_pcm_format_t format);
928
929 void snd_pcm_set_ops(snd_pcm_t * pcm, int direction, snd_pcm_ops_t *ops);
930 void snd_pcm_set_sync(snd_pcm_substream_t * substream);
931 int snd_pcm_lib_interleave_len(snd_pcm_substream_t *substream);
932 int snd_pcm_lib_ioctl(snd_pcm_substream_t *substream,
933                       unsigned int cmd, void *arg);                      
934 int snd_pcm_update_hw_ptr(snd_pcm_substream_t *substream);
935 int snd_pcm_playback_xrun_check(snd_pcm_substream_t *substream);
936 int snd_pcm_capture_xrun_check(snd_pcm_substream_t *substream);
937 int snd_pcm_playback_xrun_asap(snd_pcm_substream_t *substream);
938 int snd_pcm_capture_xrun_asap(snd_pcm_substream_t *substream);
939 void snd_pcm_playback_silence(snd_pcm_substream_t *substream, snd_pcm_uframes_t new_hw_ptr);
940 void snd_pcm_tick_prepare(snd_pcm_substream_t *substream);
941 void snd_pcm_tick_set(snd_pcm_substream_t *substream, unsigned long ticks);
942 void snd_pcm_tick_elapsed(snd_pcm_substream_t *substream);
943 void snd_pcm_period_elapsed(snd_pcm_substream_t *substream);
944 snd_pcm_sframes_t snd_pcm_lib_write(snd_pcm_substream_t *substream,
945                                     const void __user *buf,
946                                     snd_pcm_uframes_t frames);
947 snd_pcm_sframes_t snd_pcm_lib_read(snd_pcm_substream_t *substream,
948                                    void __user *buf, snd_pcm_uframes_t frames);
949 snd_pcm_sframes_t snd_pcm_lib_writev(snd_pcm_substream_t *substream,
950                                      void __user **bufs, snd_pcm_uframes_t frames);
951 snd_pcm_sframes_t snd_pcm_lib_readv(snd_pcm_substream_t *substream,
952                                     void __user **bufs, snd_pcm_uframes_t frames);
953
954 int snd_pcm_limit_hw_rates(snd_pcm_runtime_t *runtime);
955
956 static inline void snd_pcm_set_runtime_buffer(snd_pcm_substream_t *substream,
957                                               struct snd_dma_buffer *bufp)
958 {
959         snd_pcm_runtime_t *runtime = substream->runtime;
960         if (bufp) {
961                 runtime->dma_buffer_p = bufp;
962                 runtime->dma_area = bufp->area;
963                 runtime->dma_addr = bufp->addr;
964                 runtime->dma_bytes = bufp->bytes;
965         } else {
966                 runtime->dma_buffer_p = NULL;
967                 runtime->dma_area = NULL;
968                 runtime->dma_addr = 0;
969                 runtime->dma_bytes = 0;
970         }
971 }
972
973 /*
974  *  Timer interface
975  */
976
977 void snd_pcm_timer_resolution_change(snd_pcm_substream_t *substream);
978 void snd_pcm_timer_init(snd_pcm_substream_t * substream);
979 void snd_pcm_timer_done(snd_pcm_substream_t * substream);
980
981 /*
982  *  Memory
983  */
984
985 int snd_pcm_lib_preallocate_free(snd_pcm_substream_t *substream);
986 int snd_pcm_lib_preallocate_free_for_all(snd_pcm_t *pcm);
987 int snd_pcm_lib_preallocate_pages(snd_pcm_substream_t *substream,
988                                   int type, struct device *data,
989                                   size_t size, size_t max);
990 int snd_pcm_lib_preallocate_pages_for_all(snd_pcm_t *pcm,
991                                           int type, void *data,
992                                           size_t size, size_t max);
993 int snd_pcm_lib_malloc_pages(snd_pcm_substream_t *substream, size_t size);
994 int snd_pcm_lib_free_pages(snd_pcm_substream_t *substream);
995
996 #define snd_pcm_substream_sgbuf(substream) ((substream)->runtime->dma_buffer_p->private_data)
997 #define snd_pcm_sgbuf_pages(size) snd_sgbuf_aligned_pages(size)
998 #define snd_pcm_sgbuf_get_addr(sgbuf,ofs) snd_sgbuf_get_addr(sgbuf,ofs)
999 struct page *snd_pcm_sgbuf_ops_page(snd_pcm_substream_t *substream, unsigned long offset);
1000
1001 /* handle mmap counter - PCM mmap callback should handle this counter properly */
1002 static inline void snd_pcm_mmap_data_open(struct vm_area_struct *area)
1003 {
1004         snd_pcm_substream_t *substream = (snd_pcm_substream_t *)area->vm_private_data;
1005         atomic_inc(&substream->runtime->mmap_count);
1006 }
1007
1008 static inline void snd_pcm_mmap_data_close(struct vm_area_struct *area)
1009 {
1010         snd_pcm_substream_t *substream = (snd_pcm_substream_t *)area->vm_private_data;
1011         atomic_dec(&substream->runtime->mmap_count);
1012 }
1013
1014 /* mmap for io-memory area */
1015 #if defined(CONFIG_X86) || defined(CONFIG_PPC) || defined(CONFIG_ALPHA)
1016 #define SNDRV_PCM_INFO_MMAP_IOMEM       SNDRV_PCM_INFO_MMAP
1017 int snd_pcm_lib_mmap_iomem(snd_pcm_substream_t *substream, struct vm_area_struct *area);
1018 #else
1019 #define SNDRV_PCM_INFO_MMAP_IOMEM       0
1020 #define snd_pcm_lib_mmap_iomem  NULL
1021 #endif
1022
1023 static inline void snd_pcm_limit_isa_dma_size(int dma, size_t *max)
1024 {
1025         *max = dma < 4 ? 64 * 1024 : 128 * 1024;
1026 }
1027
1028 /*
1029  *  Misc
1030  */
1031
1032 #define SNDRV_PCM_DEFAULT_CON_SPDIF     (IEC958_AES0_CON_EMPHASIS_NONE|\
1033                                          (IEC958_AES1_CON_ORIGINAL<<8)|\
1034                                          (IEC958_AES1_CON_PCM_CODER<<8)|\
1035                                          (IEC958_AES3_CON_FS_48000<<24))
1036
1037 #endif /* __SOUND_PCM_H */